summaryrefslogtreecommitdiff
path: root/src/experimentation/gnunet-daemon-experimentation_scheduler.c
blob: c13434e9be88c4bda8bffd31d7e7ad2602da39c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
/*
     This file is part of GNUnet.
     (C) 2009 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, or (at your
     option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file experimentation/gnunet-daemon-experimentation_scheduler.c
 * @brief experimentation daemon: execute experiments
 * @author Christian Grothoff
 * @author Matthias Wachs
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_core_service.h"
#include "gnunet_statistics_service.h"
#include "gnunet-daemon-experimentation.h"

/**
 * An experiment is added during startup as not running NOT_RUNNING
 *
 * The scheduler then decides to schedule it and sends a request to the
 * remote peer, if core cannot send since it is busy we wait for some time
 * and change state to BUSY, if we can send we change to REQUESTED and wait
 * for remote peers ACK.
 *
 * When we receive an ACK we change to STARTED and when scheduler decides that
 * the experiment is finished we change to STOPPED.
 */

enum ExperimentState
{
	/* Experiment is added and waiting to be executed */
	NOT_RUNNING,
	/* Cannot send request to remote peer, core is busy*/
	BUSY,
	/* We requested experiment and wait for remote peer to ACK */
	REQUESTED,
	/* Experiment is running */
	STARTED,
	/* Experiment is done */
	STOPPED
};

struct ScheduledExperiment {
	struct ScheduledExperiment *next;
	struct ScheduledExperiment *prev;

	struct Experiment *e;
	struct Node *n;
	int state;
	int outbound;
	GNUNET_SCHEDULER_TaskIdentifier task;
};

struct ScheduledExperiment *waiting_in_head;
struct ScheduledExperiment *waiting_in_tail;

struct ScheduledExperiment *running_in_head;
struct ScheduledExperiment *running_in_tail;

struct ScheduledExperiment *waiting_out_head;
struct ScheduledExperiment *waiting_out_tail;

struct ScheduledExperiment *running_out_head;
struct ScheduledExperiment *running_out_tail;


static unsigned int experiments_scheduled;
static unsigned int experiments_outbound_running;
static unsigned int experiments_inbound_running;
static unsigned int experiments_requested;


static struct ScheduledExperiment *
find_experiment (struct ScheduledExperiment *head, struct ScheduledExperiment *tail,
								 struct Node *n, struct Experiment *e, int outbound)
{
	struct ScheduledExperiment *cur;
	for (cur = head; NULL != cur; cur = cur->next)
	{
		if ((cur->n == n) && (cur->e == e) && (cur->outbound == outbound)) /* Node and experiment are equal */
			break;
	}
	return cur;
}

static void
request_timeout (void *cls,const struct GNUNET_SCHEDULER_TaskContext* tc)
{
	struct ScheduledExperiment *se = cls;
	se->task = GNUNET_SCHEDULER_NO_TASK;

	GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Peer `%s' did not respond to request for experiment `%s'\n"),
			GNUNET_i2s (&se->n->id), se->e->name);

	GNUNET_CONTAINER_DLL_remove (waiting_out_head, waiting_out_tail, se);
	GNUNET_free (se);

	/* Remove experiment */
	GNUNET_assert (experiments_requested > 0);
	experiments_requested --;
	GNUNET_STATISTICS_set (GED_stats, "# experiments requested", experiments_requested, GNUNET_NO);
}

static void run_experiment_inbound (void *cls,const struct GNUNET_SCHEDULER_TaskContext* tc)
{
	struct ScheduledExperiment *se = cls;
	struct GNUNET_TIME_Relative start;
	struct GNUNET_TIME_Relative end;

	se->task = GNUNET_SCHEDULER_NO_TASK;

	switch (se->state) {
		case NOT_RUNNING:
			/* Send START_ACK message */
			GED_nodes_send_start_ack (se->n, se->e);
			se->state = REQUESTED;
			/* Schedule to run */
			start = GNUNET_TIME_absolute_get_remaining(se->e->start);
			if (0 == start.rel_value_us)
					se->task = GNUNET_SCHEDULER_add_now (&run_experiment_inbound, se);
			else
					se->task = GNUNET_SCHEDULER_add_delayed (start, &run_experiment_inbound, se);
			break;
		case REQUESTED:
			experiments_inbound_running ++;
			GNUNET_STATISTICS_set (GED_stats, "# experiments inbound running", experiments_inbound_running, GNUNET_NO);
			GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting inbound experiment `%s' with peer `%s'\n"),
					se->e->name, GNUNET_i2s (&se->n->id));
			se->state = STARTED;
			se->task = GNUNET_SCHEDULER_add_now (&run_experiment_inbound, se);
			break;
		case STARTED:
			/* Experiment is running */
			GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Running %s experiment `%s' peer for `%s'\n",
					"inbound", GNUNET_i2s (&se->n->id), se->e->name);

			/* do work here */

			/* Reschedule */
			end = GNUNET_TIME_absolute_get_remaining(GNUNET_TIME_absolute_add (se->e->stop, se->e->frequency));
			if (0 == end.rel_value_us)
			{
				se->state = STOPPED;
				return;	/* End of experiment is reached */
			}
			/* Reschedule */
			se->task = GNUNET_SCHEDULER_add_delayed (se->e->frequency, &run_experiment_inbound, se);
			break;
		case STOPPED:
			/* Experiment expired */
			break;
		default:
			break;
	}

}

static void run_experiment_outbound (void *cls,const struct GNUNET_SCHEDULER_TaskContext* tc)
{
	struct ScheduledExperiment *se = cls;
	struct GNUNET_TIME_Relative end;

	se->task = GNUNET_SCHEDULER_NO_TASK;

	switch (se->state) {
		case NOT_RUNNING:
			/* Send START message */
			GED_nodes_send_start (se->n, se->e);
			se->state = REQUESTED;
			se->task = GNUNET_SCHEDULER_add_delayed (EXP_RESPONSE_TIMEOUT, &request_timeout, se);
			experiments_requested ++;
			GNUNET_STATISTICS_set (GED_stats, "# experiments requested", experiments_requested, GNUNET_NO);
			break;
		case REQUESTED:
			/* Expecting START_ACK */
			GNUNET_break (0);
			break;
		case STARTED:
			/* Experiment is running */
			GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Running %s experiment `%s' peer for `%s'\n",
					"outbound", GNUNET_i2s (&se->n->id), se->e->name);

			/* do work here */

			/* Reschedule */
			end = GNUNET_TIME_absolute_get_remaining(GNUNET_TIME_absolute_add (se->e->stop, se->e->frequency));
			if (0 == end.rel_value_us)
			{
				se->state = STOPPED;
				return;	/* End of experiment is reached */
			}
			/* Reschedule */
		se->task = GNUNET_SCHEDULER_add_delayed (se->e->frequency, &run_experiment_outbound, se);
			break;
		case STOPPED:
			/* Experiment expired */
			break;
		default:
			break;
	}
}


/**
 * Handle a START message from a remote node
 *
 * @param n the node
 * @param e the experiment
 */
void
GED_scheduler_handle_start (struct Node *n, struct Experiment *e)
{
  if ((NULL != find_experiment (waiting_in_head, waiting_in_tail, n, e, GNUNET_NO)) ||
      (NULL != find_experiment (running_in_head, running_in_tail, n, e, GNUNET_NO)))
  {
    GNUNET_break_op (0);
    return;
  }

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
	      "Received %s message from peer %s for experiment `%s'\n",
	      "START", GNUNET_i2s (&n->id), e->name);
  GED_scheduler_add (n, e, GNUNET_NO);
}


/**
 * Handle a START_ACK message from a remote node
 *
 * @param n the node
 * @param e the experiment
 */
void
GED_scheduler_handle_start_ack (struct Node *n, struct Experiment *e)
{
	struct ScheduledExperiment *se;

	if (NULL == (se = find_experiment (waiting_out_head, waiting_out_tail, n, e, GNUNET_YES)))
	{
		GNUNET_break (0);
		return;
	}

	GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received %s message from peer %s for requested experiment `%s'\n",
			"START_ACK", GNUNET_i2s (&n->id), e->name);

	if (GNUNET_SCHEDULER_NO_TASK != se->task)
	{
		GNUNET_SCHEDULER_cancel (se->task); /* *Canceling timeout task */
		se->task = GNUNET_SCHEDULER_NO_TASK;
	}

	/* Remove from waiting list, add to running list */
	GNUNET_CONTAINER_DLL_remove (waiting_out_head, waiting_out_tail, se);
	GNUNET_CONTAINER_DLL_insert (running_out_head, running_out_tail, se);

	/* Change state and schedule to run */
	experiments_outbound_running ++;
	GNUNET_STATISTICS_set (GED_stats, "# experiments outbound running", experiments_outbound_running, GNUNET_NO);
	GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting outbound experiment `%s' with peer `%s'\n"),
			e->name, GNUNET_i2s (&n->id));
	se->state = STARTED;
	se->task = GNUNET_SCHEDULER_add_now (&run_experiment_outbound, se);
}


/**
 * Handle a STOP message from a remote node
 *
 * @param n the node
 * @param e the experiment
 */
void
GED_scheduler_handle_stop (struct Node *n, struct Experiment *e)
{
	struct ScheduledExperiment *se;

	GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _("Received %s message from peer %s for experiment `%s'\n"),
			"STOP", GNUNET_i2s (&n->id), e->name);

	if (NULL != (se = find_experiment (waiting_in_head, waiting_in_tail, n, e, GNUNET_NO)))
	{
		GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received %s message from peer %s for waiting experiment `%s'\n",
				"STOP", GNUNET_i2s (&n->id), e->name);
	}

	if (NULL != (se = find_experiment (running_in_head, running_in_tail, n, e, GNUNET_NO)))
	{
		GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received %s message from peer %s for running experiment `%s'\n",
				"STOP", GNUNET_i2s (&n->id), e->name);
	}

}

/**
 * Add a new experiment for a node
 *
 * @param n the node
 * @param e the experiment
 * @param outbound are we initiator (GNUNET_YES) or client (GNUNET_NO)?
 */
void
GED_scheduler_add (struct Node *n, struct Experiment *e, int outbound)
{
	struct ScheduledExperiment *se;
	struct GNUNET_TIME_Relative start;
	struct GNUNET_TIME_Relative end;

	GNUNET_assert ((GNUNET_YES == outbound) || (GNUNET_NO == outbound));

	start = GNUNET_TIME_absolute_get_remaining(e->start);
	end = GNUNET_TIME_absolute_get_remaining(e->stop);
	if (0 == end.rel_value_us)
			return;	/* End of experiment is reached */

	/* Add additional checks here if required */
	se = GNUNET_new (struct ScheduledExperiment);
	se->state = NOT_RUNNING;
	se->outbound = outbound;
	se->e = e;
	se->n = n;

	if (GNUNET_YES == outbound)
	{
	  if (0 == start.rel_value_us)
				se->task = GNUNET_SCHEDULER_add_now (&run_experiment_outbound, se);
		else
				se->task = GNUNET_SCHEDULER_add_delayed (start, &run_experiment_outbound, se);
		GNUNET_CONTAINER_DLL_insert (waiting_out_head, waiting_out_tail, se);
	}
	else
	{
		if (0 == start.rel_value_us)
				se->task = GNUNET_SCHEDULER_add_now (&run_experiment_inbound, se);
		else
				se->task = GNUNET_SCHEDULER_add_delayed (start, &run_experiment_inbound, se);
		GNUNET_CONTAINER_DLL_insert (waiting_in_head, waiting_in_tail, se);
	}

	GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added %s experiment `%s' for node to be scheduled\n",
			(GNUNET_YES == outbound) ? "outbound" : "inbound", e->name, GNUNET_i2s(&se->n->id));
	experiments_scheduled ++;
	GNUNET_STATISTICS_set (GED_stats, "# experiments scheduled", experiments_scheduled, GNUNET_NO);

}

/**
 * Start the scheduler component
 */
void
GED_scheduler_start ()
{
	experiments_requested = 0;
	experiments_scheduled = 0;
}


/**
 * Stop the scheduler component
 */
void
GED_scheduler_stop ()
{
	struct ScheduledExperiment *cur;
	struct ScheduledExperiment *next;

	next = waiting_in_head;
	while (NULL != (cur = next))
	{
			next = cur->next;
			GNUNET_CONTAINER_DLL_remove (waiting_in_head, waiting_in_tail, cur);
			if (GNUNET_SCHEDULER_NO_TASK != cur->task)
			{
					GNUNET_SCHEDULER_cancel (cur->task);
					cur->task = GNUNET_SCHEDULER_NO_TASK;
			}
			GNUNET_free (cur);
			GNUNET_assert (experiments_scheduled > 0);
			experiments_scheduled --;
			GNUNET_STATISTICS_set (GED_stats, "# experiments scheduled", experiments_scheduled, GNUNET_NO);
	}

	next = running_in_head;
	while (NULL != (cur = next))
	{
			next = cur->next;
			GNUNET_CONTAINER_DLL_remove (running_in_head, running_in_tail, cur);
			if (GNUNET_SCHEDULER_NO_TASK != cur->task)
			{
					GNUNET_SCHEDULER_cancel (cur->task);
					cur->task = GNUNET_SCHEDULER_NO_TASK;
			}
			GNUNET_free (cur);
			GNUNET_assert (experiments_outbound_running > 0);
			experiments_inbound_running --;
			GNUNET_STATISTICS_set (GED_stats, "# experiments inbound running", experiments_inbound_running, GNUNET_NO);
	}

	next = waiting_out_head;
	while (NULL != (cur = next))
	{
			next = cur->next;
			GNUNET_CONTAINER_DLL_remove (waiting_out_head, waiting_out_tail, cur);
			if (GNUNET_SCHEDULER_NO_TASK != cur->task)
			{
					GNUNET_SCHEDULER_cancel (cur->task);
					cur->task = GNUNET_SCHEDULER_NO_TASK;
			}
			GNUNET_free (cur);
			GNUNET_assert (experiments_scheduled > 0);
			experiments_scheduled --;
			GNUNET_STATISTICS_set (GED_stats, "# experiments scheduled", experiments_scheduled, GNUNET_NO);
	}

	next = running_out_head;
	while (NULL != (cur = next))
	{
			next = cur->next;
			GNUNET_CONTAINER_DLL_remove (running_out_head, running_out_tail, cur);
			if (GNUNET_SCHEDULER_NO_TASK != cur->task)
			{
					GNUNET_SCHEDULER_cancel (cur->task);
					cur->task = GNUNET_SCHEDULER_NO_TASK;
			}
			GNUNET_free (cur);
			GNUNET_assert (experiments_outbound_running > 0);
			experiments_outbound_running --;
			GNUNET_STATISTICS_set (GED_stats, "# experiments outbound running", experiments_outbound_running, GNUNET_NO);
	}
}

/* end of gnunet-daemon-experimentation_scheduler.c */