-docu
[oweals/gnunet.git] / src / util / scheduler.c
1 /*
2       This file is part of GNUnet
3       (C) 2009-2013 Christian Grothoff (and other contributing authors)
4
5       GNUnet is free software; you can redistribute it and/or modify
6       it under the terms of the GNU General Public License as published
7       by the Free Software Foundation; either version 3, or (at your
8       option) any later version.
9
10       GNUnet is distributed in the hope that it will be useful, but
11       WITHOUT ANY WARRANTY; without even the implied warranty of
12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13       General Public License for more details.
14
15       You should have received a copy of the GNU General Public License
16       along with GNUnet; see the file COPYING.  If not, write to the
17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18       Boston, MA 02111-1307, USA.
19  */
20
21 /**
22  * @file util/scheduler.c
23  * @brief schedule computations using continuation passing style
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_common.h"
28 #include "gnunet_os_lib.h"
29 #include "gnunet_scheduler_lib.h"
30 #include "gnunet_signal_lib.h"
31 #include "gnunet_time_lib.h"
32 #include "disk.h"
33
34 #define LOG(kind,...) GNUNET_log_from (kind, "util-scheduler", __VA_ARGS__)
35
36 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util-scheduler", syscall)
37
38
39 #if HAVE_EXECINFO_H
40 #include "execinfo.h"
41
42 /**
43  * Use lsof to generate file descriptor reports on select error?
44  * (turn off for stable releases).
45  */
46 #define USE_LSOF GNUNET_NO
47
48 /**
49  * Obtain trace information for all scheduler calls that schedule tasks.
50  */
51 #define EXECINFO GNUNET_NO
52
53 /**
54  * Check each file descriptor before adding
55  */
56 #define DEBUG_FDS GNUNET_NO
57
58 /**
59  * Depth of the traces collected via EXECINFO.
60  */
61 #define MAX_TRACE_DEPTH 50
62 #endif
63
64 /**
65  * Should we figure out which tasks are delayed for a while
66  * before they are run? (Consider using in combination with EXECINFO).
67  */
68 #define PROFILE_DELAYS GNUNET_NO
69
70 /**
71  * Task that were in the queue for longer than this are reported if
72  * PROFILE_DELAYS is active.
73  */
74 #define DELAY_THRESHOLD GNUNET_TIME_UNIT_SECONDS
75
76
77 /**
78  * Linked list of pending tasks.
79  */
80 struct Task
81 {
82   /**
83    * This is a linked list.
84    */
85   struct Task *next;
86
87   /**
88    * Function to run when ready.
89    */
90   GNUNET_SCHEDULER_Task callback;
91
92   /**
93    * Closure for the callback.
94    */
95   void *callback_cls;
96
97   /**
98    * Set of file descriptors this task is waiting
99    * for for reading.  Once ready, this is updated
100    * to reflect the set of file descriptors ready
101    * for operation.
102    */
103   struct GNUNET_NETWORK_FDSet *read_set;
104
105   /**
106    * Set of file descriptors this task is waiting for for writing.
107    * Once ready, this is updated to reflect the set of file
108    * descriptors ready for operation.
109    */
110   struct GNUNET_NETWORK_FDSet *write_set;
111
112   /**
113    * Unique task identifier.
114    */
115   GNUNET_SCHEDULER_TaskIdentifier id;
116
117   /**
118    * Absolute timeout value for the task, or
119    * GNUNET_TIME_UNIT_FOREVER_ABS for "no timeout".
120    */
121   struct GNUNET_TIME_Absolute timeout;
122
123 #if PROFILE_DELAYS
124   /**
125    * When was the task scheduled?
126    */
127   struct GNUNET_TIME_Absolute start_time;
128 #endif
129
130   /**
131    * Why is the task ready?  Set after task is added to ready queue.
132    * Initially set to zero.  All reasons that have already been
133    * satisfied (i.e.  read or write ready) will be set over time.
134    */
135   enum GNUNET_SCHEDULER_Reason reason;
136
137   /**
138    * Task priority.
139    */
140   enum GNUNET_SCHEDULER_Priority priority;
141
142   /**
143    * Set if we only wait for reading from a single FD, otherwise -1.
144    */
145   int read_fd;
146
147   /**
148    * Set if we only wait for writing to a single FD, otherwise -1.
149    */
150   int write_fd;
151
152   /**
153    * Should the existence of this task in the queue be counted as
154    * reason to not shutdown the scheduler?
155    */
156   int lifeness;
157
158 #if EXECINFO
159   /**
160    * Array of strings which make up a backtrace from the point when this
161    * task was scheduled (essentially, who scheduled the task?)
162    */
163   char **backtrace_strings;
164
165   /**
166    * Size of the backtrace_strings array
167    */
168   int num_backtrace_strings;
169 #endif
170
171
172 };
173
174
175 /**
176  * List of tasks waiting for an event.
177  */
178 static struct Task *pending;
179
180 /**
181  * List of tasks waiting ONLY for a timeout event.
182  * Sorted by timeout (earliest first).  Used so that
183  * we do not traverse the list of these tasks when
184  * building select sets (we just look at the head
185  * to determine the respective timeout ONCE).
186  */
187 static struct Task *pending_timeout;
188
189 /**
190  * Last inserted task waiting ONLY for a timeout event.
191  * Used to (heuristically) speed up insertion.
192  */
193 static struct Task *pending_timeout_last;
194
195 /**
196  * ID of the task that is running right now.
197  */
198 static struct Task *active_task;
199
200 /**
201  * List of tasks ready to run right now,
202  * grouped by importance.
203  */
204 static struct Task *ready[GNUNET_SCHEDULER_PRIORITY_COUNT];
205
206 /**
207  * Identity of the last task queued.  Incremented for each task to
208  * generate a unique task ID (it is virtually impossible to start
209  * more than 2^64 tasks during the lifetime of a process).
210  */
211 static GNUNET_SCHEDULER_TaskIdentifier last_id;
212
213 /**
214  * Number of tasks on the ready list.
215  */
216 static unsigned int ready_count;
217
218 /**
219  * How many tasks have we run so far?
220  */
221 static unsigned long long tasks_run;
222
223 /**
224  * Priority of the task running right now.  Only
225  * valid while a task is running.
226  */
227 static enum GNUNET_SCHEDULER_Priority current_priority;
228
229 /**
230  * Priority of the highest task added in the current select
231  * iteration.
232  */
233 static enum GNUNET_SCHEDULER_Priority max_priority_added;
234
235 /**
236  * Value of the 'lifeness' flag for the current task.
237  */
238 static int current_lifeness;
239
240 /**
241  * Function to use as a select() in the scheduler.
242  * If NULL, we use GNUNET_NETWORK_socket_select ().
243  */
244 static GNUNET_SCHEDULER_select scheduler_select;
245
246 /**
247  * Closure for 'scheduler_select'.
248  */
249 static void *scheduler_select_cls;
250
251 /**
252  * Sets the select function to use in the scheduler (scheduler_select).
253  *
254  * @param new_select new select function to use
255  * @param new_select_cls closure for 'new_select'
256  * @return previously used select function, NULL for default
257  */
258 void
259 GNUNET_SCHEDULER_set_select (GNUNET_SCHEDULER_select new_select,
260                              void *new_select_cls)
261 {
262   scheduler_select = new_select;
263   scheduler_select_cls = new_select_cls;
264 }
265
266
267 /**
268  * Check that the given priority is legal (and return it).
269  *
270  * @param p priority value to check
271  * @return p on success, 0 on error
272  */
273 static enum GNUNET_SCHEDULER_Priority
274 check_priority (enum GNUNET_SCHEDULER_Priority p)
275 {
276   if ((p >= 0) && (p < GNUNET_SCHEDULER_PRIORITY_COUNT))
277     return p;
278   GNUNET_assert (0);
279   return 0;                     /* make compiler happy */
280 }
281
282
283 /**
284  * Update all sets and timeout for select.
285  *
286  * @param rs read-set, set to all FDs we would like to read (updated)
287  * @param ws write-set, set to all FDs we would like to write (updated)
288  * @param timeout next timeout (updated)
289  */
290 static void
291 update_sets (struct GNUNET_NETWORK_FDSet *rs, struct GNUNET_NETWORK_FDSet *ws,
292              struct GNUNET_TIME_Relative *timeout)
293 {
294   struct Task *pos;
295   struct GNUNET_TIME_Absolute now;
296   struct GNUNET_TIME_Relative to;
297
298   now = GNUNET_TIME_absolute_get ();
299   pos = pending_timeout;
300   if (pos != NULL)
301   {
302     to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
303     if (timeout->rel_value_us > to.rel_value_us)
304       *timeout = to;
305     if (pos->reason != 0)
306       *timeout = GNUNET_TIME_UNIT_ZERO;
307   }
308   pos = pending;
309   while (pos != NULL)
310   {
311     if (pos->timeout.abs_value_us != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
312     {
313       to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
314       if (timeout->rel_value_us > to.rel_value_us)
315         *timeout = to;
316     }
317     if (pos->read_fd != -1)
318       GNUNET_NETWORK_fdset_set_native (rs, pos->read_fd);
319     if (pos->write_fd != -1)
320       GNUNET_NETWORK_fdset_set_native (ws, pos->write_fd);
321     if (pos->read_set != NULL)
322       GNUNET_NETWORK_fdset_add (rs, pos->read_set);
323     if (pos->write_set != NULL)
324       GNUNET_NETWORK_fdset_add (ws, pos->write_set);
325     if (pos->reason != 0)
326       *timeout = GNUNET_TIME_UNIT_ZERO;
327     pos = pos->next;
328   }
329 }
330
331
332 /**
333  * Check if the ready set overlaps with the set we want to have ready.
334  * If so, update the want set (set all FDs that are ready).  If not,
335  * return GNUNET_NO.
336  *
337  * @param ready set that is ready
338  * @param want set that we want to be ready
339  * @return GNUNET_YES if there was some overlap
340  */
341 static int
342 set_overlaps (const struct GNUNET_NETWORK_FDSet *ready,
343               struct GNUNET_NETWORK_FDSet *want)
344 {
345   if ((NULL == want) || (NULL == ready))
346     return GNUNET_NO;
347   if (GNUNET_NETWORK_fdset_overlap (ready, want))
348   {
349     /* copy all over (yes, there maybe unrelated bits,
350      * but this should not hurt well-written clients) */
351     GNUNET_NETWORK_fdset_copy (want, ready);
352     return GNUNET_YES;
353   }
354   return GNUNET_NO;
355 }
356
357
358 /**
359  * Check if the given task is eligible to run now.
360  * Also set the reason why it is eligible.
361  *
362  * @param task task to check if it is ready
363  * @param now the current time
364  * @param rs set of FDs ready for reading
365  * @param ws set of FDs ready for writing
366  * @return GNUNET_YES if we can run it, GNUNET_NO if not.
367  */
368 static int
369 is_ready (struct Task *task, struct GNUNET_TIME_Absolute now,
370           const struct GNUNET_NETWORK_FDSet *rs,
371           const struct GNUNET_NETWORK_FDSet *ws)
372 {
373   enum GNUNET_SCHEDULER_Reason reason;
374
375   reason = task->reason;
376   if (now.abs_value_us >= task->timeout.abs_value_us)
377     reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
378   if ((0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
379       (((task->read_fd != -1) &&
380         (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (rs, task->read_fd))) ||
381        (set_overlaps (rs, task->read_set))))
382     reason |= GNUNET_SCHEDULER_REASON_READ_READY;
383   if ((0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
384       (((task->write_fd != -1) &&
385         (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (ws, task->write_fd)))
386        || (set_overlaps (ws, task->write_set))))
387     reason |= GNUNET_SCHEDULER_REASON_WRITE_READY;
388   if (reason == 0)
389     return GNUNET_NO;           /* not ready */
390   reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;  
391   task->reason = reason;
392   return GNUNET_YES;
393 }
394
395
396 /**
397  * Put a task that is ready for execution into the ready queue.
398  *
399  * @param task task ready for execution
400  */
401 static void
402 queue_ready_task (struct Task *task)
403 {
404   enum GNUNET_SCHEDULER_Priority p = task->priority;
405
406   if (0 != (task->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
407     p = GNUNET_SCHEDULER_PRIORITY_SHUTDOWN;
408   task->next = ready[check_priority (p)];
409   ready[check_priority (p)] = task;
410   ready_count++;
411 }
412
413
414 /**
415  * Check which tasks are ready and move them
416  * to the respective ready queue.
417  *
418  * @param rs FDs ready for reading
419  * @param ws FDs ready for writing
420  */
421 static void
422 check_ready (const struct GNUNET_NETWORK_FDSet *rs,
423              const struct GNUNET_NETWORK_FDSet *ws)
424 {
425   struct Task *pos;
426   struct Task *prev;
427   struct Task *next;
428   struct GNUNET_TIME_Absolute now;
429
430   now = GNUNET_TIME_absolute_get ();
431   prev = NULL;
432   pos = pending_timeout;
433   while (pos != NULL)
434   {
435     next = pos->next;
436     if (now.abs_value_us >= pos->timeout.abs_value_us)
437       pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
438     if (0 == pos->reason)
439       break;
440     pending_timeout = next;
441     if (pending_timeout_last == pos)
442       pending_timeout_last = NULL;
443     queue_ready_task (pos);
444     pos = next;
445   }
446   pos = pending;
447   while (pos != NULL)
448   {
449     LOG (GNUNET_ERROR_TYPE_DEBUG, 
450          "Checking readiness of task: %llu / %p\n",
451          pos->id, pos->callback_cls);
452     next = pos->next;
453     if (GNUNET_YES == is_ready (pos, now, rs, ws))
454     {
455       if (prev == NULL)
456         pending = next;
457       else
458         prev->next = next;
459       queue_ready_task (pos);
460       pos = next;
461       continue;
462     }
463     prev = pos;
464     pos = next;
465   }
466 }
467
468
469 /**
470  * Request the shutdown of a scheduler.  Marks all currently
471  * pending tasks as ready because of shutdown.  This will
472  * cause all tasks to run (as soon as possible, respecting
473  * priorities and prerequisite tasks).  Note that tasks
474  * scheduled AFTER this call may still be delayed arbitrarily.
475  */
476 void
477 GNUNET_SCHEDULER_shutdown ()
478 {
479   struct Task *pos;
480   int i;
481
482   pos = pending_timeout;
483   while (pos != NULL)
484   {
485     pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
486     /* we don't move the task into the ready queue yet; check_ready
487      * will do that later, possibly adding additional
488      * readiness-factors */
489     pos = pos->next;
490   }
491   pos = pending;
492   while (pos != NULL)
493   {
494     pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
495     /* we don't move the task into the ready queue yet; check_ready
496      * will do that later, possibly adding additional
497      * readiness-factors */
498     pos = pos->next;
499   }
500   for (i = 0; i < GNUNET_SCHEDULER_PRIORITY_COUNT; i++)
501   {
502     pos = ready[i];
503     while (pos != NULL)
504     {
505       pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
506       /* we don't move the task into the ready queue yet; check_ready
507        * will do that later, possibly adding additional
508        * readiness-factors */
509       pos = pos->next;
510     }
511   }
512 }
513
514
515 /**
516  * Destroy a task (release associated resources)
517  *
518  * @param t task to destroy
519  */
520 static void
521 destroy_task (struct Task *t)
522 {
523   if (NULL != t->read_set)
524     GNUNET_NETWORK_fdset_destroy (t->read_set);
525   if (NULL != t->write_set)
526     GNUNET_NETWORK_fdset_destroy (t->write_set);
527 #if EXECINFO
528   GNUNET_free (t->backtrace_strings);
529 #endif
530   GNUNET_free (t);
531 }
532
533
534 /**
535  * Run at least one task in the highest-priority queue that is not
536  * empty.  Keep running tasks until we are either no longer running
537  * "URGENT" tasks or until we have at least one "pending" task (which
538  * may become ready, hence we should select on it).  Naturally, if
539  * there are no more ready tasks, we also return.
540  *
541  * @param rs FDs ready for reading
542  * @param ws FDs ready for writing
543  */
544 static void
545 run_ready (struct GNUNET_NETWORK_FDSet *rs, struct GNUNET_NETWORK_FDSet *ws)
546 {
547   enum GNUNET_SCHEDULER_Priority p;
548   struct Task *pos;
549   struct GNUNET_SCHEDULER_TaskContext tc;
550
551   max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
552   do
553   {
554     if (ready_count == 0)
555       return;
556     GNUNET_assert (ready[GNUNET_SCHEDULER_PRIORITY_KEEP] == NULL);
557     /* yes, p>0 is correct, 0 is "KEEP" which should
558      * always be an empty queue (see assertion)! */
559     for (p = GNUNET_SCHEDULER_PRIORITY_COUNT - 1; p > 0; p--)
560     {
561       pos = ready[p];
562       if (pos != NULL)
563         break;
564     }
565     GNUNET_assert (pos != NULL);        /* ready_count wrong? */
566     ready[p] = pos->next;
567     ready_count--;
568     current_priority = pos->priority;
569     current_lifeness = pos->lifeness;
570     active_task = pos;
571 #if PROFILE_DELAYS
572     if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
573         DELAY_THRESHOLD.rel_value_us)
574     {
575       LOG (GNUNET_ERROR_TYPE_DEBUG, 
576            "Task %llu took %s to be scheduled\n",
577            (unsigned long long) pos->id,
578            GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time), GNUNET_YES));
579     }
580 #endif
581     tc.reason = pos->reason;
582     tc.read_ready = (pos->read_set == NULL) ? rs : pos->read_set;
583     if ((pos->read_fd != -1) &&
584         (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)))
585       GNUNET_NETWORK_fdset_set_native (rs, pos->read_fd);
586     tc.write_ready = (pos->write_set == NULL) ? ws : pos->write_set;
587     if ((pos->write_fd != -1) &&
588         (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)))
589       GNUNET_NETWORK_fdset_set_native (ws, pos->write_fd);
590     if (((tc.reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0) &&
591         (pos->write_fd != -1) &&
592         (!GNUNET_NETWORK_fdset_test_native (ws, pos->write_fd)))
593       GNUNET_abort ();          // added to ready in previous select loop!
594     LOG (GNUNET_ERROR_TYPE_DEBUG, 
595          "Running task: %llu / %p\n", pos->id,
596          pos->callback_cls);
597     pos->callback (pos->callback_cls, &tc);
598 #if EXECINFO
599     int i;
600
601     for (i = 0; i < pos->num_backtrace_strings; i++)
602       LOG (GNUNET_ERROR_TYPE_ERROR, "Task %llu trace %d: %s\n", pos->id, i,
603            pos->backtrace_strings[i]);
604 #endif
605     active_task = NULL;
606     destroy_task (pos);
607     tasks_run++;
608   }
609   while ((pending == NULL) || (p >= max_priority_added));
610 }
611
612 /**
613  * Pipe used to communicate shutdown via signal.
614  */
615 static struct GNUNET_DISK_PipeHandle *shutdown_pipe_handle;
616
617 /**
618  * Process ID of this process at the time we installed the various
619  * signal handlers.
620  */
621 static pid_t my_pid;
622
623 /**
624  * Signal handler called for SIGPIPE.
625  */
626 #ifndef MINGW
627 static void
628 sighandler_pipe ()
629 {
630   return;
631 }
632 #endif
633 /**
634  * Signal handler called for signals that should cause us to shutdown.
635  */
636 static void
637 sighandler_shutdown ()
638 {
639   static char c;
640   int old_errno = errno;        /* backup errno */
641
642   if (getpid () != my_pid)
643     exit (1);                   /* we have fork'ed since the signal handler was created,
644                                  * ignore the signal, see https://gnunet.org/vfork discussion */
645   GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
646                           (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_WRITE),
647                           &c, sizeof (c));
648   errno = old_errno;
649 }
650
651
652 /**
653  * Check if the system is still life. Trigger shutdown if we
654  * have tasks, but none of them give us lifeness.
655  *
656  * @return GNUNET_OK to continue the main loop,
657  *         GNUNET_NO to exit
658  */
659 static int
660 check_lifeness ()
661 {
662   struct Task *t;
663
664   if (ready_count > 0)
665     return GNUNET_OK;
666   for (t = pending; NULL != t; t = t->next)
667     if (t->lifeness == GNUNET_YES)
668       return GNUNET_OK;
669   for (t = pending_timeout; NULL != t; t = t->next)
670     if (t->lifeness == GNUNET_YES)
671       return GNUNET_OK;
672   if ((NULL != pending) || (NULL != pending_timeout))
673   {
674     GNUNET_SCHEDULER_shutdown ();
675     return GNUNET_OK;
676   }
677   return GNUNET_NO;
678 }
679
680
681 /**
682  * Initialize and run scheduler.  This function will return when all
683  * tasks have completed.  On systems with signals, receiving a SIGTERM
684  * (and other similar signals) will cause "GNUNET_SCHEDULER_shutdown"
685  * to be run after the active task is complete.  As a result, SIGTERM
686  * causes all active tasks to be scheduled with reason
687  * "GNUNET_SCHEDULER_REASON_SHUTDOWN".  (However, tasks added
688  * afterwards will execute normally!). Note that any particular signal
689  * will only shut down one scheduler; applications should always only
690  * create a single scheduler.
691  *
692  * @param task task to run immediately
693  * @param task_cls closure of task
694  */
695 void
696 GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_Task task, void *task_cls)
697 {
698   struct GNUNET_NETWORK_FDSet *rs;
699   struct GNUNET_NETWORK_FDSet *ws;
700   struct GNUNET_TIME_Relative timeout;
701   int ret;
702   struct GNUNET_SIGNAL_Context *shc_int;
703   struct GNUNET_SIGNAL_Context *shc_term;
704
705 #ifndef MINGW
706   struct GNUNET_SIGNAL_Context *shc_quit;
707   struct GNUNET_SIGNAL_Context *shc_hup;
708   struct GNUNET_SIGNAL_Context *shc_pipe;
709 #endif
710   unsigned long long last_tr;
711   unsigned int busy_wait_warning;
712   const struct GNUNET_DISK_FileHandle *pr;
713   char c;
714
715   GNUNET_assert (active_task == NULL);
716   rs = GNUNET_NETWORK_fdset_create ();
717   ws = GNUNET_NETWORK_fdset_create ();
718   GNUNET_assert (shutdown_pipe_handle == NULL);
719   shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_NO);
720   GNUNET_assert (shutdown_pipe_handle != NULL);
721   pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
722                                 GNUNET_DISK_PIPE_END_READ);
723   GNUNET_assert (pr != NULL);
724   my_pid = getpid ();
725   LOG (GNUNET_ERROR_TYPE_DEBUG, "Registering signal handlers\n");
726   shc_int = GNUNET_SIGNAL_handler_install (SIGINT, &sighandler_shutdown);
727   shc_term = GNUNET_SIGNAL_handler_install (SIGTERM, &sighandler_shutdown);
728 #ifndef MINGW
729   shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE, &sighandler_pipe);
730   shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT, &sighandler_shutdown);
731   shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP, &sighandler_shutdown);
732 #endif
733   current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
734   current_lifeness = GNUNET_YES;
735   GNUNET_SCHEDULER_add_continuation (task, task_cls,
736                                      GNUNET_SCHEDULER_REASON_STARTUP);
737   active_task = (void *) (long) -1;     /* force passing of sanity check */
738   GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
739                                           &GNUNET_OS_install_parent_control_handler,
740                                           NULL);
741   active_task = NULL;
742   last_tr = 0;
743   busy_wait_warning = 0;
744   while (GNUNET_OK == check_lifeness ())
745   {
746     GNUNET_NETWORK_fdset_zero (rs);
747     GNUNET_NETWORK_fdset_zero (ws);
748     timeout = GNUNET_TIME_UNIT_FOREVER_REL;
749     update_sets (rs, ws, &timeout);
750     GNUNET_NETWORK_fdset_handle_set (rs, pr);
751     if (ready_count > 0)
752     {
753       /* no blocking, more work already ready! */
754       timeout = GNUNET_TIME_UNIT_ZERO;
755     }
756     if (NULL == scheduler_select)
757       ret = GNUNET_NETWORK_socket_select (rs, ws, NULL, timeout);
758     else
759       ret = scheduler_select (scheduler_select_cls, rs, ws, NULL, timeout);
760     if (ret == GNUNET_SYSERR)
761     {
762       if (errno == EINTR)
763         continue;
764
765       LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "select");
766 #ifndef MINGW
767 #if USE_LSOF
768       char lsof[512];
769
770       snprintf (lsof, sizeof (lsof), "lsof -p %d", getpid ());
771       (void) close (1);
772       (void) dup2 (2, 1);
773       if (0 != system (lsof))
774         LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "system");
775 #endif
776 #endif
777       GNUNET_abort ();
778       break;
779     }
780     if ((0 == ret) && (0 == timeout.rel_value_us) && (busy_wait_warning > 16))
781     {
782       LOG (GNUNET_ERROR_TYPE_WARNING, _("Looks like we're busy waiting...\n"));
783       sleep (1);                /* mitigate */
784     }
785     check_ready (rs, ws);
786     run_ready (rs, ws);
787     if (GNUNET_NETWORK_fdset_handle_isset (rs, pr))
788     {
789       /* consume the signal */
790       GNUNET_DISK_file_read (pr, &c, sizeof (c));
791       /* mark all active tasks as ready due to shutdown */
792       GNUNET_SCHEDULER_shutdown ();
793     }
794     if (last_tr == tasks_run)
795     {
796       busy_wait_warning++;
797     }
798     else
799     {
800       last_tr = tasks_run;
801       busy_wait_warning = 0;
802     }
803   }
804   GNUNET_SIGNAL_handler_uninstall (shc_int);
805   GNUNET_SIGNAL_handler_uninstall (shc_term);
806 #ifndef MINGW
807   GNUNET_SIGNAL_handler_uninstall (shc_pipe);
808   GNUNET_SIGNAL_handler_uninstall (shc_quit);
809   GNUNET_SIGNAL_handler_uninstall (shc_hup);
810 #endif
811   GNUNET_DISK_pipe_close (shutdown_pipe_handle);
812   shutdown_pipe_handle = NULL;
813   GNUNET_NETWORK_fdset_destroy (rs);
814   GNUNET_NETWORK_fdset_destroy (ws);
815 }
816
817
818 /**
819  * Obtain the reason code for why the current task was
820  * started.  Will return the same value as
821  * the GNUNET_SCHEDULER_TaskContext's reason field.
822  *
823  * @return reason(s) why the current task is run
824  */
825 enum GNUNET_SCHEDULER_Reason
826 GNUNET_SCHEDULER_get_reason ()
827 {
828   GNUNET_assert (active_task != NULL);
829   return active_task->reason;
830 }
831
832
833 /**
834  * Get information about the current load of this scheduler.  Use this
835  * function to determine if an elective task should be added or simply
836  * dropped (if the decision should be made based on the number of
837  * tasks ready to run).
838  *
839  * @param p priority level to look at
840  * @return number of tasks pending right now
841  */
842 unsigned int
843 GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p)
844 {
845   struct Task *pos;
846   unsigned int ret;
847
848   GNUNET_assert (active_task != NULL);
849   if (p == GNUNET_SCHEDULER_PRIORITY_COUNT)
850     return ready_count;
851   if (p == GNUNET_SCHEDULER_PRIORITY_KEEP)
852     p = current_priority;
853   ret = 0;
854   pos = ready[check_priority (p)];
855   while (pos != NULL)
856   {
857     pos = pos->next;
858     ret++;
859   }
860   return ret;
861 }
862
863
864 /**
865  * Cancel the task with the specified identifier.
866  * The task must not yet have run.
867  *
868  * @param task id of the task to cancel
869  * @return original closure of the task
870  */
871 void *
872 GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task)
873 {
874   struct Task *t;
875   struct Task *prev;
876   enum GNUNET_SCHEDULER_Priority p;
877   int to;
878   void *ret;
879
880   GNUNET_assert (active_task != NULL);
881   to = 0;
882   prev = NULL;
883   t = pending;
884   while (t != NULL)
885   {
886     if (t->id == task)
887       break;
888     prev = t;
889     t = t->next;
890   }
891   if (t == NULL)
892   {
893     prev = NULL;
894     to = 1;
895     t = pending_timeout;
896     while (t != NULL)
897     {
898       if (t->id == task)
899         break;
900       prev = t;
901       t = t->next;
902     }
903     if (pending_timeout_last == t)
904       pending_timeout_last = NULL;
905   }
906   p = 0;
907   while (t == NULL)
908   {
909     p++;
910     if (p >= GNUNET_SCHEDULER_PRIORITY_COUNT)
911     {
912       LOG (GNUNET_ERROR_TYPE_ERROR, _("Attempt to cancel dead task %llu!\n"),
913            (unsigned long long) task);
914       GNUNET_assert (0);
915     }
916     prev = NULL;
917     t = ready[p];
918     while (t != NULL)
919     {
920       if (t->id == task)
921       {
922         ready_count--;
923         break;
924       }
925       prev = t;
926       t = t->next;
927     }
928   }
929   if (prev == NULL)
930   {
931     if (p == 0)
932     {
933       if (to == 0)
934       {
935         pending = t->next;
936       }
937       else
938       {
939         pending_timeout = t->next;
940       }
941     }
942     else
943     {
944       ready[p] = t->next;
945     }
946   }
947   else
948   {
949     prev->next = t->next;
950   }
951   ret = t->callback_cls;
952   LOG (GNUNET_ERROR_TYPE_DEBUG, "Canceling task: %llu / %p\n", task,
953        t->callback_cls);
954   destroy_task (t);
955   return ret;
956 }
957
958
959 /**
960  * Continue the current execution with the given function.  This is
961  * similar to the other "add" functions except that there is no delay
962  * and the reason code can be specified.
963  *
964  * @param task main function of the task
965  * @param task_cls closure for 'main'
966  * @param reason reason for task invocation
967  * @param priority priority to use for the task
968  */
969 void
970 GNUNET_SCHEDULER_add_continuation_with_priority (GNUNET_SCHEDULER_Task task, void *task_cls,
971                                                  enum GNUNET_SCHEDULER_Reason reason,
972                                                  enum GNUNET_SCHEDULER_Priority priority)
973 {
974   struct Task *t;
975
976 #if EXECINFO
977   void *backtrace_array[50];
978 #endif
979
980   GNUNET_assert (NULL != task);
981   GNUNET_assert ((active_task != NULL) ||
982                  (reason == GNUNET_SCHEDULER_REASON_STARTUP));
983   t = GNUNET_malloc (sizeof (struct Task));
984 #if EXECINFO
985   t->num_backtrace_strings = backtrace (backtrace_array, 50);
986   t->backtrace_strings =
987       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
988 #endif
989   t->read_fd = -1;
990   t->write_fd = -1;
991   t->callback = task;
992   t->callback_cls = task_cls;
993   t->id = ++last_id;
994 #if PROFILE_DELAYS
995   t->start_time = GNUNET_TIME_absolute_get ();
996 #endif
997   t->reason = reason;
998   t->priority = priority;
999   t->lifeness = current_lifeness;
1000   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding continuation task: %llu / %p\n", t->id,
1001        t->callback_cls);
1002   queue_ready_task (t);
1003 }
1004
1005
1006 /**
1007  * Continue the current execution with the given function.  This is
1008  * similar to the other "add" functions except that there is no delay
1009  * and the reason code can be specified.
1010  *
1011  * @param task main function of the task
1012  * @param task_cls closure for 'main'
1013  * @param reason reason for task invocation
1014  */
1015 void
1016 GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task, void *task_cls,
1017                                    enum GNUNET_SCHEDULER_Reason reason)
1018 {
1019   GNUNET_SCHEDULER_add_continuation_with_priority (task, task_cls,
1020                                                    reason,
1021                                                    GNUNET_SCHEDULER_PRIORITY_DEFAULT);
1022 }
1023
1024
1025 /**
1026  * Schedule a new task to be run with a specified priority.
1027  *
1028  * @param prio how important is the new task?
1029  * @param task main function of the task
1030  * @param task_cls closure of task
1031  * @return unique task identifier for the job
1032  *         only valid until "task" is started!
1033  */
1034 GNUNET_SCHEDULER_TaskIdentifier
1035 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
1036                                     GNUNET_SCHEDULER_Task task, void *task_cls)
1037 {
1038   return GNUNET_SCHEDULER_add_select (prio, 
1039                                       GNUNET_TIME_UNIT_ZERO, NULL, NULL, task,
1040                                       task_cls);
1041 }
1042
1043
1044
1045 /**
1046  * Schedule a new task to be run with a specified delay.  The task
1047  * will be scheduled for execution once the delay has expired.
1048  *
1049  * @param delay when should this operation time out? Use
1050  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1051  * @param priority priority to use for the task
1052  * @param task main function of the task
1053  * @param task_cls closure of task
1054  * @return unique task identifier for the job
1055  *         only valid until "task" is started!
1056  */
1057 GNUNET_SCHEDULER_TaskIdentifier
1058 GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
1059                                             enum GNUNET_SCHEDULER_Priority priority,
1060                                             GNUNET_SCHEDULER_Task task, void *task_cls)
1061 {
1062   struct Task *t;
1063   struct Task *pos;
1064   struct Task *prev;
1065
1066 #if EXECINFO
1067   void *backtrace_array[MAX_TRACE_DEPTH];
1068 #endif
1069
1070   GNUNET_assert (active_task != NULL);
1071   GNUNET_assert (NULL != task);
1072   t = GNUNET_malloc (sizeof (struct Task));
1073   t->callback = task;
1074   t->callback_cls = task_cls;
1075 #if EXECINFO
1076   t->num_backtrace_strings = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1077   t->backtrace_strings =
1078       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
1079 #endif
1080   t->read_fd = -1;
1081   t->write_fd = -1;
1082   t->id = ++last_id;
1083 #if PROFILE_DELAYS
1084   t->start_time = GNUNET_TIME_absolute_get ();
1085 #endif
1086   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1087   t->priority = priority;
1088   t->lifeness = current_lifeness;
1089   /* try tail first (optimization in case we are
1090    * appending to a long list of tasks with timeouts) */
1091   prev = pending_timeout_last;
1092   if (prev != NULL)
1093   {
1094     if (prev->timeout.abs_value_us > t->timeout.abs_value_us)
1095       prev = NULL;
1096     else
1097       pos = prev->next;         /* heuristic success! */
1098   }
1099   if (prev == NULL)
1100   {
1101     /* heuristic failed, do traversal of timeout list */
1102     pos = pending_timeout;
1103   }
1104   while ((pos != NULL) &&
1105          ((pos->timeout.abs_value_us <= t->timeout.abs_value_us) ||
1106           (0 != pos->reason)))
1107   {
1108     prev = pos;
1109     pos = pos->next;
1110   }
1111   if (prev == NULL)
1112     pending_timeout = t;
1113   else
1114     prev->next = t;
1115   t->next = pos;
1116   /* hyper-optimization... */
1117   pending_timeout_last = t;
1118
1119   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding task: %llu / %p\n", t->id,
1120        t->callback_cls);
1121 #if EXECINFO
1122   int i;
1123
1124   for (i = 0; i < t->num_backtrace_strings; i++)
1125     LOG (GNUNET_ERROR_TYPE_DEBUG, "Task %llu trace %d: %s\n", t->id, i,
1126          t->backtrace_strings[i]);
1127 #endif
1128   return t->id;
1129 }
1130
1131
1132 /**
1133  * Schedule a new task to be run with a specified delay.  The task
1134  * will be scheduled for execution once the delay has expired. It
1135  * will be run with the DEFAULT priority.
1136  *
1137  * @param delay when should this operation time out? Use
1138  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1139  * @param task main function of the task
1140  * @param task_cls closure of task
1141  * @return unique task identifier for the job
1142  *         only valid until "task" is started!
1143  */
1144 GNUNET_SCHEDULER_TaskIdentifier
1145 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
1146                               GNUNET_SCHEDULER_Task task, void *task_cls)
1147 {
1148   return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
1149                                                      GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1150                                                      task, task_cls);
1151 }
1152
1153
1154 /**
1155  * Schedule a new task to be run as soon as possible.  Note that this
1156  * does not guarantee that this will be the next task that is being
1157  * run, as other tasks with higher priority (or that are already ready
1158  * to run) might get to run first.  Just as with delays, clients must
1159  * not rely on any particular order of execution between tasks
1160  * scheduled concurrently.
1161  * 
1162  * The task will be run with the DEFAULT priority.
1163  *
1164  * @param task main function of the task
1165  * @param task_cls closure of @a task
1166  * @return unique task identifier for the job
1167  *         only valid until "task" is started!
1168  */
1169 GNUNET_SCHEDULER_TaskIdentifier
1170 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_Task task, void *task_cls)
1171 {
1172   return GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_ZERO, task, task_cls);
1173 }
1174
1175
1176 /**
1177  * Schedule a new task to be run as soon as possible with the
1178  * (transitive) ignore-shutdown flag either explicitly set or
1179  * explicitly enabled.  This task (and all tasks created from it,
1180  * other than by another call to this function) will either count or
1181  * not count for the 'lifeness' of the process.  This API is only
1182  * useful in a few special cases.
1183  *
1184  * @param lifeness GNUNET_YES if the task counts for lifeness, GNUNET_NO if not.
1185  * @param task main function of the task
1186  * @param task_cls closure of task
1187  * @return unique task identifier for the job
1188  *         only valid until "task" is started!
1189  */
1190 GNUNET_SCHEDULER_TaskIdentifier
1191 GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
1192                                         GNUNET_SCHEDULER_Task task,
1193                                         void *task_cls)
1194 {
1195   GNUNET_SCHEDULER_TaskIdentifier ret;
1196
1197   ret =
1198       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1199                                    GNUNET_TIME_UNIT_ZERO, NULL, NULL, task,
1200                                    task_cls);
1201   GNUNET_assert (pending->id == ret);
1202   pending->lifeness = lifeness;
1203   return ret;
1204 }
1205
1206
1207 /**
1208  * Schedule a new task to be run with a specified delay or when any of
1209  * the specified file descriptor sets is ready.  The delay can be used
1210  * as a timeout on the socket(s) being ready.  The task will be
1211  * scheduled for execution once either the delay has expired or any of
1212  * the socket operations is ready.  This is the most general
1213  * function of the "add" family.  Note that the "prerequisite_task"
1214  * must be satisfied in addition to any of the other conditions.  In
1215  * other words, the task will be started when
1216  * <code>
1217  * (prerequisite-run)
1218  * && (delay-ready
1219  *     || any-rs-ready
1220  *     || any-ws-ready
1221  *     || shutdown-active )
1222  * </code>
1223  *
1224  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1225  *        which means that the task will only be run after we receive SIGTERM
1226  * @param priority priority to use
1227  * @param rfd file descriptor we want to read (can be -1)
1228  * @param wfd file descriptors we want to write (can be -1)
1229  * @param task main function of the task
1230  * @param task_cls closure of task
1231  * @return unique task identifier for the job
1232  *         only valid until "task" is started!
1233  */
1234 #ifndef MINGW
1235 static GNUNET_SCHEDULER_TaskIdentifier
1236 add_without_sets (struct GNUNET_TIME_Relative delay, 
1237                   enum GNUNET_SCHEDULER_Priority priority,
1238                   int rfd, int wfd,
1239                   GNUNET_SCHEDULER_Task task, void *task_cls)
1240 {
1241   struct Task *t;
1242
1243 #if EXECINFO
1244   void *backtrace_array[MAX_TRACE_DEPTH];
1245 #endif
1246
1247   GNUNET_assert (active_task != NULL);
1248   GNUNET_assert (NULL != task);
1249   t = GNUNET_malloc (sizeof (struct Task));
1250   t->callback = task;
1251   t->callback_cls = task_cls;
1252 #if EXECINFO
1253   t->num_backtrace_strings = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1254   t->backtrace_strings =
1255       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
1256 #endif
1257 #if DEBUG_FDS
1258   if (-1 != rfd)
1259   {
1260     int flags = fcntl (rfd, F_GETFD);
1261
1262     if ((flags == -1) && (errno == EBADF))
1263     {
1264       LOG (GNUNET_ERROR_TYPE_ERROR, "Got invalid file descriptor %d!\n", rfd);
1265 #if EXECINFO
1266       int i;
1267
1268       for (i = 0; i < t->num_backtrace_strings; i++)
1269         LOG (GNUNET_ERROR_TYPE_DEBUG, "Trace: %s\n", t->backtrace_strings[i]);
1270 #endif
1271       GNUNET_assert (0);
1272     }
1273   }
1274   if (-1 != wfd)
1275   {
1276     int flags = fcntl (wfd, F_GETFD);
1277
1278     if (flags == -1 && errno == EBADF)
1279     {
1280       LOG (GNUNET_ERROR_TYPE_ERROR, "Got invalid file descriptor %d!\n", wfd);
1281 #if EXECINFO
1282       int i;
1283
1284       for (i = 0; i < t->num_backtrace_strings; i++)
1285         LOG (GNUNET_ERROR_TYPE_DEBUG, "Trace: %s\n", t->backtrace_strings[i]);
1286 #endif
1287       GNUNET_assert (0);
1288     }
1289   }
1290 #endif
1291   t->read_fd = rfd;
1292   GNUNET_assert (wfd >= -1);
1293   t->write_fd = wfd;
1294   t->id = ++last_id;
1295 #if PROFILE_DELAYS
1296   t->start_time = GNUNET_TIME_absolute_get ();
1297 #endif
1298   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1299   t->priority = check_priority ((priority == GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority : priority);
1300   t->lifeness = current_lifeness;
1301   t->next = pending;
1302   pending = t;
1303   max_priority_added = GNUNET_MAX (max_priority_added, t->priority);
1304   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding task: %llu / %p\n", t->id,
1305        t->callback_cls);
1306 #if EXECINFO
1307   int i;
1308
1309   for (i = 0; i < t->num_backtrace_strings; i++)
1310     LOG (GNUNET_ERROR_TYPE_DEBUG, "Task %llu trace %d: %s\n", t->id, i,
1311          t->backtrace_strings[i]);
1312 #endif
1313   return t->id;
1314 }
1315 #endif
1316
1317
1318
1319 /**
1320  * Schedule a new task to be run with a specified delay or when the
1321  * specified file descriptor is ready for reading.  The delay can be
1322  * used as a timeout on the socket being ready.  The task will be
1323  * scheduled for execution once either the delay has expired or the
1324  * socket operation is ready.  It will be run with the DEFAULT priority.
1325  *
1326  * @param delay when should this operation time out? Use
1327  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1328  * @param rfd read file-descriptor
1329  * @param task main function of the task
1330  * @param task_cls closure of task
1331  * @return unique task identifier for the job
1332  *         only valid until "task" is started!
1333  */
1334 GNUNET_SCHEDULER_TaskIdentifier
1335 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
1336                                struct GNUNET_NETWORK_Handle *rfd,
1337                                GNUNET_SCHEDULER_Task task, void *task_cls)
1338 {
1339   return GNUNET_SCHEDULER_add_read_net_with_priority (delay,
1340                                                       GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1341                                                       rfd, task, task_cls);
1342 }
1343
1344
1345 /**
1346  * Schedule a new task to be run with a specified priority and to be
1347  * run after the specified delay or when the specified file descriptor
1348  * is ready for reading.  The delay can be used as a timeout on the
1349  * socket being ready.  The task will be scheduled for execution once
1350  * either the delay has expired or the socket operation is ready.  It
1351  * will be run with the DEFAULT priority.
1352  *
1353  * @param delay when should this operation time out? Use
1354  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1355  * @param priority priority to use for the task
1356  * @param rfd read file-descriptor
1357  * @param task main function of the task
1358  * @param task_cls closure of task
1359  * @return unique task identifier for the job
1360  *         only valid until "task" is started!
1361  */
1362 GNUNET_SCHEDULER_TaskIdentifier
1363 GNUNET_SCHEDULER_add_read_net_with_priority (struct GNUNET_TIME_Relative delay,
1364                                              enum GNUNET_SCHEDULER_Priority priority,
1365                                              struct GNUNET_NETWORK_Handle *rfd,
1366                                              GNUNET_SCHEDULER_Task task, void *task_cls)
1367 {
1368 #if MINGW
1369   struct GNUNET_NETWORK_FDSet *rs;
1370   GNUNET_SCHEDULER_TaskIdentifier ret;
1371
1372   GNUNET_assert (rfd != NULL);
1373   rs = GNUNET_NETWORK_fdset_create ();
1374   GNUNET_NETWORK_fdset_set (rs, rfd);
1375   ret =
1376     GNUNET_SCHEDULER_add_select (priority,
1377                                  delay, rs, NULL,
1378                                  task, task_cls);
1379   GNUNET_NETWORK_fdset_destroy (rs);
1380   return ret;
1381 #else
1382   return add_without_sets (delay, 
1383                            priority,
1384                            GNUNET_NETWORK_get_fd (rfd), -1, task,
1385                            task_cls);
1386 #endif
1387 }
1388
1389
1390
1391 /**
1392  * Schedule a new task to be run with a specified delay or when the
1393  * specified file descriptor is ready for writing.  The delay can be
1394  * used as a timeout on the socket being ready.  The task will be
1395  * scheduled for execution once either the delay has expired or the
1396  * socket operation is ready.  It will be run with the priority of
1397  * the calling task.
1398  *
1399  * @param delay when should this operation time out? Use
1400  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1401  * @param wfd write file-descriptor
1402  * @param task main function of the task
1403  * @param task_cls closure of task
1404  * @return unique task identifier for the job
1405  *         only valid until "task" is started!
1406  */
1407 GNUNET_SCHEDULER_TaskIdentifier
1408 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
1409                                 struct GNUNET_NETWORK_Handle *wfd,
1410                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1411 {
1412 #if MINGW
1413   struct GNUNET_NETWORK_FDSet *ws;
1414   GNUNET_SCHEDULER_TaskIdentifier ret;
1415
1416   GNUNET_assert (wfd != NULL);
1417   ws = GNUNET_NETWORK_fdset_create ();
1418   GNUNET_NETWORK_fdset_set (ws, wfd);
1419   ret =
1420     GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1421                                  delay, NULL, ws,
1422                                    task, task_cls);
1423   GNUNET_NETWORK_fdset_destroy (ws);
1424   return ret;
1425 #else
1426   GNUNET_assert (GNUNET_NETWORK_get_fd (wfd) >= 0);
1427   return add_without_sets (delay, 
1428                            GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1429                            -1, GNUNET_NETWORK_get_fd (wfd), task,
1430                            task_cls);
1431 #endif
1432 }
1433
1434
1435 /**
1436  * Schedule a new task to be run with a specified delay or when the
1437  * specified file descriptor is ready for reading.  The delay can be
1438  * used as a timeout on the socket being ready.  The task will be
1439  * scheduled for execution once either the delay has expired or the
1440  * socket operation is ready. It will be run with the DEFAULT priority.
1441  *
1442  * @param delay when should this operation time out? Use
1443  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1444  * @param rfd read file-descriptor
1445  * @param task main function of the task
1446  * @param task_cls closure of task
1447  * @return unique task identifier for the job
1448  *         only valid until "task" is started!
1449  */
1450 GNUNET_SCHEDULER_TaskIdentifier
1451 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
1452                                 const struct GNUNET_DISK_FileHandle *rfd,
1453                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1454 {
1455 #if MINGW
1456   struct GNUNET_NETWORK_FDSet *rs;
1457   GNUNET_SCHEDULER_TaskIdentifier ret;
1458
1459   GNUNET_assert (rfd != NULL);
1460   rs = GNUNET_NETWORK_fdset_create ();
1461   GNUNET_NETWORK_fdset_handle_set (rs, rfd);
1462   ret =
1463       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1464                                    delay, rs, NULL,
1465                                    task, task_cls);
1466   GNUNET_NETWORK_fdset_destroy (rs);
1467   return ret;
1468 #else
1469   int fd;
1470
1471   GNUNET_DISK_internal_file_handle_ (rfd, &fd, sizeof (int));
1472   return add_without_sets (delay, 
1473                            GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1474                            fd, -1, task, task_cls);
1475
1476 #endif
1477 }
1478
1479
1480 /**
1481  * Schedule a new task to be run with a specified delay or when the
1482  * specified file descriptor is ready for writing.  The delay can be
1483  * used as a timeout on the socket being ready.  The task will be
1484  * scheduled for execution once either the delay has expired or the
1485  * socket operation is ready. It will be run with the DEFAULT priority.
1486  *
1487  * @param delay when should this operation time out? Use
1488  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1489  * @param wfd write file-descriptor
1490  * @param task main function of the task
1491  * @param task_cls closure of task
1492  * @return unique task identifier for the job
1493  *         only valid until "task" is started!
1494  */
1495 GNUNET_SCHEDULER_TaskIdentifier
1496 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
1497                                  const struct GNUNET_DISK_FileHandle *wfd,
1498                                  GNUNET_SCHEDULER_Task task, void *task_cls)
1499 {
1500 #if MINGW
1501   struct GNUNET_NETWORK_FDSet *ws;
1502   GNUNET_SCHEDULER_TaskIdentifier ret;
1503
1504   GNUNET_assert (wfd != NULL);
1505   ws = GNUNET_NETWORK_fdset_create ();
1506   GNUNET_NETWORK_fdset_handle_set (ws, wfd);
1507   ret =
1508       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1509                                    delay, NULL, ws,
1510                                    task, task_cls);
1511   GNUNET_NETWORK_fdset_destroy (ws);
1512   return ret;
1513 #else
1514   int fd;
1515
1516   GNUNET_DISK_internal_file_handle_ (wfd, &fd, sizeof (int));
1517   GNUNET_assert (fd >= 0);
1518   return add_without_sets (delay, 
1519                            GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1520                            -1, fd, task, task_cls);
1521
1522 #endif
1523 }
1524
1525
1526
1527 /**
1528  * Schedule a new task to be run with a specified delay or when any of
1529  * the specified file descriptor sets is ready.  The delay can be used
1530  * as a timeout on the socket(s) being ready.  The task will be
1531  * scheduled for execution once either the delay has expired or any of
1532  * the socket operations is ready.  This is the most general
1533  * function of the "add" family.  Note that the "prerequisite_task"
1534  * must be satisfied in addition to any of the other conditions.  In
1535  * other words, the task will be started when
1536  * <code>
1537  * (prerequisite-run)
1538  * && (delay-ready
1539  *     || any-rs-ready
1540  *     || any-ws-ready
1541  *     || (shutdown-active && run-on-shutdown) )
1542  * </code>
1543  *
1544  * @param prio how important is this task?
1545  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1546  *        which means that the task will only be run after we receive SIGTERM
1547  * @param rs set of file descriptors we want to read (can be NULL)
1548  * @param ws set of file descriptors we want to write (can be NULL)
1549  * @param task main function of the task
1550  * @param task_cls closure of task
1551  * @return unique task identifier for the job
1552  *         only valid until "task" is started!
1553  */
1554 GNUNET_SCHEDULER_TaskIdentifier
1555 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
1556                              struct GNUNET_TIME_Relative delay,
1557                              const struct GNUNET_NETWORK_FDSet *rs,
1558                              const struct GNUNET_NETWORK_FDSet *ws,
1559                              GNUNET_SCHEDULER_Task task, void *task_cls)
1560 {
1561   struct Task *t;
1562
1563 #if EXECINFO
1564   void *backtrace_array[MAX_TRACE_DEPTH];
1565 #endif
1566
1567   GNUNET_assert (NULL != active_task);
1568   GNUNET_assert (NULL != task);
1569   t = GNUNET_malloc (sizeof (struct Task));
1570   t->callback = task;
1571   t->callback_cls = task_cls;
1572 #if EXECINFO
1573   t->num_backtrace_strings = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1574   t->backtrace_strings =
1575       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
1576 #endif
1577   t->read_fd = -1;
1578   t->write_fd = -1;
1579   if (rs != NULL)
1580   {
1581     t->read_set = GNUNET_NETWORK_fdset_create ();
1582     GNUNET_NETWORK_fdset_copy (t->read_set, rs);
1583   }
1584   if (ws != NULL)
1585   {
1586     t->write_set = GNUNET_NETWORK_fdset_create ();
1587     GNUNET_NETWORK_fdset_copy (t->write_set, ws);
1588   }
1589   t->id = ++last_id;
1590 #if PROFILE_DELAYS
1591   t->start_time = GNUNET_TIME_absolute_get ();
1592 #endif
1593   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1594   t->priority =
1595       check_priority ((prio ==
1596                        GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority :
1597                       prio);
1598   t->lifeness = current_lifeness;
1599   t->next = pending;
1600   pending = t;
1601   max_priority_added = GNUNET_MAX (max_priority_added, t->priority);
1602   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding task: %llu / %p\n", t->id,
1603        t->callback_cls);
1604 #if EXECINFO
1605   int i;
1606
1607   for (i = 0; i < t->num_backtrace_strings; i++)
1608     LOG (GNUNET_ERROR_TYPE_DEBUG, "Task %llu trace %d: %s\n", t->id, i,
1609          t->backtrace_strings[i]);
1610 #endif
1611   return t->id;
1612 }
1613
1614 /* end of scheduler.c */