- logging
[oweals/gnunet.git] / src / util / scheduler.c
1 /*
2       This file is part of GNUnet
3       (C) 2009, 2011 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 2, 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 > to.rel_value)
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 != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value)
312     {
313       to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
314       if (timeout->rel_value > to.rel_value)
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 >= task->timeout.abs_value)
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 >= pos->timeout.abs_value)
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 >
573         DELAY_THRESHOLD.rel_value)
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   LOG (GNUNET_ERROR_TYPE_DEBUG,
646        "Got signal %d from parent, writing to shutdown pipe\n");
647   GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
648                           (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_WRITE),
649                           &c, sizeof (c));
650   errno = old_errno;
651 }
652
653
654 /**
655  * Check if the system is still life. Trigger shutdown if we
656  * have tasks, but none of them give us lifeness.
657  *
658  * @return GNUNET_OK to continue the main loop,
659  *         GNUNET_NO to exit
660  */
661 static int
662 check_lifeness ()
663 {
664   struct Task *t;
665
666   if (ready_count > 0)
667     return GNUNET_OK;
668   for (t = pending; NULL != t; t = t->next)
669     if (t->lifeness == GNUNET_YES)
670       return GNUNET_OK;
671   for (t = pending_timeout; NULL != t; t = t->next)
672     if (t->lifeness == GNUNET_YES)
673       return GNUNET_OK;
674   if ((NULL != pending) || (NULL != pending_timeout))
675   {
676     GNUNET_SCHEDULER_shutdown ();
677     return GNUNET_OK;
678   }
679   return GNUNET_NO;
680 }
681
682
683 /**
684  * Initialize and run scheduler.  This function will return when all
685  * tasks have completed.  On systems with signals, receiving a SIGTERM
686  * (and other similar signals) will cause "GNUNET_SCHEDULER_shutdown"
687  * to be run after the active task is complete.  As a result, SIGTERM
688  * causes all active tasks to be scheduled with reason
689  * "GNUNET_SCHEDULER_REASON_SHUTDOWN".  (However, tasks added
690  * afterwards will execute normally!). Note that any particular signal
691  * will only shut down one scheduler; applications should always only
692  * create a single scheduler.
693  *
694  * @param task task to run immediately
695  * @param task_cls closure of task
696  */
697 void
698 GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_Task task, void *task_cls)
699 {
700   struct GNUNET_NETWORK_FDSet *rs;
701   struct GNUNET_NETWORK_FDSet *ws;
702   struct GNUNET_TIME_Relative timeout;
703   int ret;
704   struct GNUNET_SIGNAL_Context *shc_int;
705   struct GNUNET_SIGNAL_Context *shc_term;
706
707 #ifndef MINGW
708   struct GNUNET_SIGNAL_Context *shc_quit;
709   struct GNUNET_SIGNAL_Context *shc_hup;
710   struct GNUNET_SIGNAL_Context *shc_pipe;
711 #endif
712   unsigned long long last_tr;
713   unsigned int busy_wait_warning;
714   const struct GNUNET_DISK_FileHandle *pr;
715   char c;
716
717   GNUNET_assert (active_task == NULL);
718   rs = GNUNET_NETWORK_fdset_create ();
719   ws = GNUNET_NETWORK_fdset_create ();
720   GNUNET_assert (shutdown_pipe_handle == NULL);
721   shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_NO);
722   GNUNET_assert (shutdown_pipe_handle != NULL);
723   pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
724                                 GNUNET_DISK_PIPE_END_READ);
725   GNUNET_assert (pr != NULL);
726   my_pid = getpid ();
727   shc_int = GNUNET_SIGNAL_handler_install (SIGINT, &sighandler_shutdown);
728   shc_term = GNUNET_SIGNAL_handler_install (SIGTERM, &sighandler_shutdown);
729 #ifndef MINGW
730   shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE, &sighandler_pipe);
731   shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT, &sighandler_shutdown);
732   shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP, &sighandler_shutdown);
733 #endif
734   current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
735   current_lifeness = GNUNET_YES;
736   GNUNET_SCHEDULER_add_continuation (task, task_cls,
737                                      GNUNET_SCHEDULER_REASON_STARTUP);
738   active_task = (void *) (long) -1;     /* force passing of sanity check */
739   GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
740                                           &GNUNET_OS_install_parent_control_handler,
741                                           NULL);
742   active_task = NULL;
743   last_tr = 0;
744   busy_wait_warning = 0;
745   while (GNUNET_OK == check_lifeness ())
746   {
747     GNUNET_NETWORK_fdset_zero (rs);
748     GNUNET_NETWORK_fdset_zero (ws);
749     timeout = GNUNET_TIME_UNIT_FOREVER_REL;
750     update_sets (rs, ws, &timeout);
751     GNUNET_NETWORK_fdset_handle_set (rs, pr);
752     if (ready_count > 0)
753     {
754       /* no blocking, more work already ready! */
755       timeout = GNUNET_TIME_UNIT_ZERO;
756     }
757     if (NULL == scheduler_select)
758       ret = GNUNET_NETWORK_socket_select (rs, ws, NULL, timeout);
759     else
760       ret = scheduler_select (scheduler_select_cls, rs, ws, NULL, timeout);
761     if (ret == GNUNET_SYSERR)
762     {
763       if (errno == EINTR)
764         continue;
765
766       LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "select");
767 #ifndef MINGW
768 #if USE_LSOF
769       char lsof[512];
770
771       snprintf (lsof, sizeof (lsof), "lsof -p %d", getpid ());
772       (void) close (1);
773       (void) dup2 (2, 1);
774       if (0 != system (lsof))
775         LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "system");
776 #endif
777 #endif
778       GNUNET_abort ();
779       break;
780     }
781     if ((ret == 0) && (timeout.rel_value == 0) && (busy_wait_warning > 16))
782     {
783       LOG (GNUNET_ERROR_TYPE_WARNING, _("Looks like we're busy waiting...\n"));
784       sleep (1);                /* mitigate */
785     }
786     check_ready (rs, ws);
787     run_ready (rs, ws);
788     if (GNUNET_NETWORK_fdset_handle_isset (rs, pr))
789     {
790       /* consume the signal */
791       GNUNET_DISK_file_read (pr, &c, sizeof (c));
792       /* mark all active tasks as ready due to shutdown */
793       GNUNET_SCHEDULER_shutdown ();
794     }
795     if (last_tr == tasks_run)
796     {
797       busy_wait_warning++;
798     }
799     else
800     {
801       last_tr = tasks_run;
802       busy_wait_warning = 0;
803     }
804   }
805   GNUNET_SIGNAL_handler_uninstall (shc_int);
806   GNUNET_SIGNAL_handler_uninstall (shc_term);
807 #ifndef MINGW
808   GNUNET_SIGNAL_handler_uninstall (shc_pipe);
809   GNUNET_SIGNAL_handler_uninstall (shc_quit);
810   GNUNET_SIGNAL_handler_uninstall (shc_hup);
811 #endif
812   GNUNET_DISK_pipe_close (shutdown_pipe_handle);
813   shutdown_pipe_handle = NULL;
814   GNUNET_NETWORK_fdset_destroy (rs);
815   GNUNET_NETWORK_fdset_destroy (ws);
816 }
817
818
819 /**
820  * Obtain the reason code for why the current task was
821  * started.  Will return the same value as
822  * the GNUNET_SCHEDULER_TaskContext's reason field.
823  *
824  * @return reason(s) why the current task is run
825  */
826 enum GNUNET_SCHEDULER_Reason
827 GNUNET_SCHEDULER_get_reason ()
828 {
829   GNUNET_assert (active_task != NULL);
830   return active_task->reason;
831 }
832
833
834 /**
835  * Get information about the current load of this scheduler.  Use this
836  * function to determine if an elective task should be added or simply
837  * dropped (if the decision should be made based on the number of
838  * tasks ready to run).
839  *
840  * @param p priority level to look at
841  * @return number of tasks pending right now
842  */
843 unsigned int
844 GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p)
845 {
846   struct Task *pos;
847   unsigned int ret;
848
849   GNUNET_assert (active_task != NULL);
850   if (p == GNUNET_SCHEDULER_PRIORITY_COUNT)
851     return ready_count;
852   if (p == GNUNET_SCHEDULER_PRIORITY_KEEP)
853     p = current_priority;
854   ret = 0;
855   pos = ready[check_priority (p)];
856   while (pos != NULL)
857   {
858     pos = pos->next;
859     ret++;
860   }
861   return ret;
862 }
863
864
865 /**
866  * Cancel the task with the specified identifier.
867  * The task must not yet have run.
868  *
869  * @param task id of the task to cancel
870  * @return original closure of the task
871  */
872 void *
873 GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task)
874 {
875   struct Task *t;
876   struct Task *prev;
877   enum GNUNET_SCHEDULER_Priority p;
878   int to;
879   void *ret;
880
881   GNUNET_assert (active_task != NULL);
882   to = 0;
883   prev = NULL;
884   t = pending;
885   while (t != NULL)
886   {
887     if (t->id == task)
888       break;
889     prev = t;
890     t = t->next;
891   }
892   if (t == NULL)
893   {
894     prev = NULL;
895     to = 1;
896     t = pending_timeout;
897     while (t != NULL)
898     {
899       if (t->id == task)
900         break;
901       prev = t;
902       t = t->next;
903     }
904     if (pending_timeout_last == t)
905       pending_timeout_last = NULL;
906   }
907   p = 0;
908   while (t == NULL)
909   {
910     p++;
911     if (p >= GNUNET_SCHEDULER_PRIORITY_COUNT)
912     {
913       LOG (GNUNET_ERROR_TYPE_ERROR, _("Attempt to cancel dead task %llu!\n"),
914            (unsigned long long) task);
915       GNUNET_assert (0);
916     }
917     prev = NULL;
918     t = ready[p];
919     while (t != NULL)
920     {
921       if (t->id == task)
922       {
923         ready_count--;
924         break;
925       }
926       prev = t;
927       t = t->next;
928     }
929   }
930   if (prev == NULL)
931   {
932     if (p == 0)
933     {
934       if (to == 0)
935       {
936         pending = t->next;
937       }
938       else
939       {
940         pending_timeout = t->next;
941       }
942     }
943     else
944     {
945       ready[p] = t->next;
946     }
947   }
948   else
949   {
950     prev->next = t->next;
951   }
952   ret = t->callback_cls;
953   LOG (GNUNET_ERROR_TYPE_DEBUG, "Canceling task: %llu / %p\n", task,
954        t->callback_cls);
955   destroy_task (t);
956   return ret;
957 }
958
959
960 /**
961  * Continue the current execution with the given function.  This is
962  * similar to the other "add" functions except that there is no delay
963  * and the reason code can be specified.
964  *
965  * @param task main function of the task
966  * @param task_cls closure for 'main'
967  * @param reason reason for task invocation
968  * @param priority priority to use for the task
969  */
970 void
971 GNUNET_SCHEDULER_add_continuation_with_priority (GNUNET_SCHEDULER_Task task, void *task_cls,
972                                                  enum GNUNET_SCHEDULER_Reason reason,
973                                                  enum GNUNET_SCHEDULER_Priority priority)
974 {
975   struct Task *t;
976
977 #if EXECINFO
978   void *backtrace_array[50];
979 #endif
980
981   GNUNET_assert (NULL != task);
982   GNUNET_assert ((active_task != NULL) ||
983                  (reason == GNUNET_SCHEDULER_REASON_STARTUP));
984   t = GNUNET_malloc (sizeof (struct Task));
985 #if EXECINFO
986   t->num_backtrace_strings = backtrace (backtrace_array, 50);
987   t->backtrace_strings =
988       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
989 #endif
990   t->read_fd = -1;
991   t->write_fd = -1;
992   t->callback = task;
993   t->callback_cls = task_cls;
994   t->id = ++last_id;
995 #if PROFILE_DELAYS
996   t->start_time = GNUNET_TIME_absolute_get ();
997 #endif
998   t->reason = reason;
999   t->priority = priority;
1000   t->lifeness = current_lifeness;
1001   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding continuation task: %llu / %p\n", t->id,
1002        t->callback_cls);
1003   queue_ready_task (t);
1004 }
1005
1006
1007 /**
1008  * Continue the current execution with the given function.  This is
1009  * similar to the other "add" functions except that there is no delay
1010  * and the reason code can be specified.
1011  *
1012  * @param task main function of the task
1013  * @param task_cls closure for 'main'
1014  * @param reason reason for task invocation
1015  */
1016 void
1017 GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task, void *task_cls,
1018                                    enum GNUNET_SCHEDULER_Reason reason)
1019 {
1020   GNUNET_SCHEDULER_add_continuation_with_priority (task, task_cls,
1021                                                    reason,
1022                                                    GNUNET_SCHEDULER_PRIORITY_DEFAULT);
1023 }
1024
1025
1026 /**
1027  * Schedule a new task to be run with a specified priority.
1028  *
1029  * @param prio how important is the new task?
1030  * @param task main function of the task
1031  * @param task_cls closure of task
1032  * @return unique task identifier for the job
1033  *         only valid until "task" is started!
1034  */
1035 GNUNET_SCHEDULER_TaskIdentifier
1036 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
1037                                     GNUNET_SCHEDULER_Task task, void *task_cls)
1038 {
1039   return GNUNET_SCHEDULER_add_select (prio, 
1040                                       GNUNET_TIME_UNIT_ZERO, NULL, NULL, task,
1041                                       task_cls);
1042 }
1043
1044
1045
1046 /**
1047  * Schedule a new task to be run with a specified delay.  The task
1048  * will be scheduled for execution once the delay has expired.
1049  *
1050  * @param delay when should this operation time out? Use
1051  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1052  * @param priority priority to use for the task
1053  * @param task main function of the task
1054  * @param task_cls closure of task
1055  * @return unique task identifier for the job
1056  *         only valid until "task" is started!
1057  */
1058 GNUNET_SCHEDULER_TaskIdentifier
1059 GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
1060                                             enum GNUNET_SCHEDULER_Priority priority,
1061                                             GNUNET_SCHEDULER_Task task, void *task_cls)
1062 {
1063   struct Task *t;
1064   struct Task *pos;
1065   struct Task *prev;
1066
1067 #if EXECINFO
1068   void *backtrace_array[MAX_TRACE_DEPTH];
1069 #endif
1070
1071   GNUNET_assert (active_task != NULL);
1072   GNUNET_assert (NULL != task);
1073   t = GNUNET_malloc (sizeof (struct Task));
1074   t->callback = task;
1075   t->callback_cls = task_cls;
1076 #if EXECINFO
1077   t->num_backtrace_strings = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1078   t->backtrace_strings =
1079       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
1080 #endif
1081   t->read_fd = -1;
1082   t->write_fd = -1;
1083   t->id = ++last_id;
1084 #if PROFILE_DELAYS
1085   t->start_time = GNUNET_TIME_absolute_get ();
1086 #endif
1087   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1088   t->priority = priority;
1089   t->lifeness = current_lifeness;
1090   /* try tail first (optimization in case we are
1091    * appending to a long list of tasks with timeouts) */
1092   prev = pending_timeout_last;
1093   if (prev != NULL)
1094   {
1095     if (prev->timeout.abs_value > t->timeout.abs_value)
1096       prev = NULL;
1097     else
1098       pos = prev->next;         /* heuristic success! */
1099   }
1100   if (prev == NULL)
1101   {
1102     /* heuristic failed, do traversal of timeout list */
1103     pos = pending_timeout;
1104   }
1105   while ((pos != NULL) &&
1106          ((pos->timeout.abs_value <= t->timeout.abs_value) ||
1107           (pos->reason != 0)))
1108   {
1109     prev = pos;
1110     pos = pos->next;
1111   }
1112   if (prev == NULL)
1113     pending_timeout = t;
1114   else
1115     prev->next = t;
1116   t->next = pos;
1117   /* hyper-optimization... */
1118   pending_timeout_last = t;
1119
1120   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding task: %llu / %p\n", t->id,
1121        t->callback_cls);
1122 #if EXECINFO
1123   int i;
1124
1125   for (i = 0; i < t->num_backtrace_strings; i++)
1126     LOG (GNUNET_ERROR_TYPE_DEBUG, "Task %llu trace %d: %s\n", t->id, i,
1127          t->backtrace_strings[i]);
1128 #endif
1129   return t->id;
1130 }
1131
1132
1133 /**
1134  * Schedule a new task to be run with a specified delay.  The task
1135  * will be scheduled for execution once the delay has expired. It
1136  * will be run with the DEFAULT priority.
1137  *
1138  * @param delay when should this operation time out? Use
1139  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1140  * @param task main function of the task
1141  * @param task_cls closure of task
1142  * @return unique task identifier for the job
1143  *         only valid until "task" is started!
1144  */
1145 GNUNET_SCHEDULER_TaskIdentifier
1146 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
1147                               GNUNET_SCHEDULER_Task task, void *task_cls)
1148 {
1149   return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
1150                                                      GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1151                                                      task, task_cls);
1152 }
1153
1154
1155 /**
1156  * Schedule a new task to be run as soon as possible. The task
1157  * will be run with the DEFAULT priority.
1158  *
1159  * @param task main function of the task
1160  * @param task_cls closure of task
1161  * @return unique task identifier for the job
1162  *         only valid until "task" is started!
1163  */
1164 GNUNET_SCHEDULER_TaskIdentifier
1165 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_Task task, void *task_cls)
1166 {
1167   return GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_ZERO, task, task_cls);
1168 }
1169
1170
1171 /**
1172  * Schedule a new task to be run as soon as possible with the
1173  * (transitive) ignore-shutdown flag either explicitly set or
1174  * explicitly enabled.  This task (and all tasks created from it,
1175  * other than by another call to this function) will either count or
1176  * not count for the 'lifeness' of the process.  This API is only
1177  * useful in a few special cases.
1178  *
1179  * @param lifeness GNUNET_YES if the task counts for lifeness, GNUNET_NO if not.
1180  * @param task main function of the task
1181  * @param task_cls closure of task
1182  * @return unique task identifier for the job
1183  *         only valid until "task" is started!
1184  */
1185 GNUNET_SCHEDULER_TaskIdentifier
1186 GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
1187                                         GNUNET_SCHEDULER_Task task,
1188                                         void *task_cls)
1189 {
1190   GNUNET_SCHEDULER_TaskIdentifier ret;
1191
1192   ret =
1193       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1194                                    GNUNET_TIME_UNIT_ZERO, NULL, NULL, task,
1195                                    task_cls);
1196   GNUNET_assert (pending->id == ret);
1197   pending->lifeness = lifeness;
1198   return ret;
1199 }
1200
1201
1202 /**
1203  * Schedule a new task to be run with a specified delay or when any of
1204  * the specified file descriptor sets is ready.  The delay can be used
1205  * as a timeout on the socket(s) being ready.  The task will be
1206  * scheduled for execution once either the delay has expired or any of
1207  * the socket operations is ready.  This is the most general
1208  * function of the "add" family.  Note that the "prerequisite_task"
1209  * must be satisfied in addition to any of the other conditions.  In
1210  * other words, the task will be started when
1211  * <code>
1212  * (prerequisite-run)
1213  * && (delay-ready
1214  *     || any-rs-ready
1215  *     || any-ws-ready
1216  *     || shutdown-active )
1217  * </code>
1218  *
1219  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1220  *        which means that the task will only be run after we receive SIGTERM
1221  * @param priority priority to use
1222  * @param rfd file descriptor we want to read (can be -1)
1223  * @param wfd file descriptors we want to write (can be -1)
1224  * @param task main function of the task
1225  * @param task_cls closure of task
1226  * @return unique task identifier for the job
1227  *         only valid until "task" is started!
1228  */
1229 #ifndef MINGW
1230 static GNUNET_SCHEDULER_TaskIdentifier
1231 add_without_sets (struct GNUNET_TIME_Relative delay, 
1232                   enum GNUNET_SCHEDULER_Priority priority,
1233                   int rfd, int wfd,
1234                   GNUNET_SCHEDULER_Task task, void *task_cls)
1235 {
1236   struct Task *t;
1237
1238 #if EXECINFO
1239   void *backtrace_array[MAX_TRACE_DEPTH];
1240 #endif
1241
1242   GNUNET_assert (active_task != NULL);
1243   GNUNET_assert (NULL != task);
1244   t = GNUNET_malloc (sizeof (struct Task));
1245   t->callback = task;
1246   t->callback_cls = task_cls;
1247 #if EXECINFO
1248   t->num_backtrace_strings = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1249   t->backtrace_strings =
1250       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
1251 #endif
1252 #if DEBUG_FDS
1253   if (-1 != rfd)
1254   {
1255     int flags = fcntl (rfd, F_GETFD);
1256
1257     if ((flags == -1) && (errno == EBADF))
1258     {
1259       LOG (GNUNET_ERROR_TYPE_ERROR, "Got invalid file descriptor %d!\n", rfd);
1260 #if EXECINFO
1261       int i;
1262
1263       for (i = 0; i < t->num_backtrace_strings; i++)
1264         LOG (GNUNET_ERROR_TYPE_DEBUG, "Trace: %s\n", t->backtrace_strings[i]);
1265 #endif
1266       GNUNET_assert (0);
1267     }
1268   }
1269   if (-1 != wfd)
1270   {
1271     int flags = fcntl (wfd, F_GETFD);
1272
1273     if (flags == -1 && errno == EBADF)
1274     {
1275       LOG (GNUNET_ERROR_TYPE_ERROR, "Got invalid file descriptor %d!\n", wfd);
1276 #if EXECINFO
1277       int i;
1278
1279       for (i = 0; i < t->num_backtrace_strings; i++)
1280         LOG (GNUNET_ERROR_TYPE_DEBUG, "Trace: %s\n", t->backtrace_strings[i]);
1281 #endif
1282       GNUNET_assert (0);
1283     }
1284   }
1285 #endif
1286   t->read_fd = rfd;
1287   GNUNET_assert (wfd >= -1);
1288   t->write_fd = wfd;
1289   t->id = ++last_id;
1290 #if PROFILE_DELAYS
1291   t->start_time = GNUNET_TIME_absolute_get ();
1292 #endif
1293   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1294   t->priority = check_priority ((priority == GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority : priority);
1295   t->lifeness = current_lifeness;
1296   t->next = pending;
1297   pending = t;
1298   max_priority_added = GNUNET_MAX (max_priority_added, t->priority);
1299   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding task: %llu / %p\n", t->id,
1300        t->callback_cls);
1301 #if EXECINFO
1302   int i;
1303
1304   for (i = 0; i < t->num_backtrace_strings; i++)
1305     LOG (GNUNET_ERROR_TYPE_DEBUG, "Task %llu trace %d: %s\n", t->id, i,
1306          t->backtrace_strings[i]);
1307 #endif
1308   return t->id;
1309 }
1310 #endif
1311
1312
1313
1314 /**
1315  * Schedule a new task to be run with a specified delay or when the
1316  * specified file descriptor is ready for reading.  The delay can be
1317  * used as a timeout on the socket being ready.  The task will be
1318  * scheduled for execution once either the delay has expired or the
1319  * socket operation is ready.  It will be run with the DEFAULT priority.
1320  *
1321  * @param delay when should this operation time out? Use
1322  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1323  * @param rfd read file-descriptor
1324  * @param task main function of the task
1325  * @param task_cls closure of task
1326  * @return unique task identifier for the job
1327  *         only valid until "task" is started!
1328  */
1329 GNUNET_SCHEDULER_TaskIdentifier
1330 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
1331                                struct GNUNET_NETWORK_Handle *rfd,
1332                                GNUNET_SCHEDULER_Task task, void *task_cls)
1333 {
1334   return GNUNET_SCHEDULER_add_read_net_with_priority (delay,
1335                                                       GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1336                                                       rfd, task, task_cls);
1337 }
1338
1339
1340 /**
1341  * Schedule a new task to be run with a specified priority and to be
1342  * run after the specified delay or when the specified file descriptor
1343  * is ready for reading.  The delay can be used as a timeout on the
1344  * socket being ready.  The task will be scheduled for execution once
1345  * either the delay has expired or the socket operation is ready.  It
1346  * will be run with the DEFAULT priority.
1347  *
1348  * @param delay when should this operation time out? Use
1349  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1350  * @param priority priority to use for the task
1351  * @param rfd read file-descriptor
1352  * @param task main function of the task
1353  * @param task_cls closure of task
1354  * @return unique task identifier for the job
1355  *         only valid until "task" is started!
1356  */
1357 GNUNET_SCHEDULER_TaskIdentifier
1358 GNUNET_SCHEDULER_add_read_net_with_priority (struct GNUNET_TIME_Relative delay,
1359                                              enum GNUNET_SCHEDULER_Priority priority,
1360                                              struct GNUNET_NETWORK_Handle *rfd,
1361                                              GNUNET_SCHEDULER_Task task, void *task_cls)
1362 {
1363 #if MINGW
1364   struct GNUNET_NETWORK_FDSet *rs;
1365   GNUNET_SCHEDULER_TaskIdentifier ret;
1366
1367   GNUNET_assert (rfd != NULL);
1368   rs = GNUNET_NETWORK_fdset_create ();
1369   GNUNET_NETWORK_fdset_set (rs, rfd);
1370   ret =
1371     GNUNET_SCHEDULER_add_select (priority,
1372                                  delay, rs, NULL,
1373                                  task, task_cls);
1374   GNUNET_NETWORK_fdset_destroy (rs);
1375   return ret;
1376 #else
1377   return add_without_sets (delay, 
1378                            priority,
1379                            GNUNET_NETWORK_get_fd (rfd), -1, task,
1380                            task_cls);
1381 #endif
1382 }
1383
1384
1385
1386 /**
1387  * Schedule a new task to be run with a specified delay or when the
1388  * specified file descriptor is ready for writing.  The delay can be
1389  * used as a timeout on the socket being ready.  The task will be
1390  * scheduled for execution once either the delay has expired or the
1391  * socket operation is ready.  It will be run with the priority of
1392  * the calling task.
1393  *
1394  * @param delay when should this operation time out? Use
1395  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1396  * @param wfd write file-descriptor
1397  * @param task main function of the task
1398  * @param task_cls closure of task
1399  * @return unique task identifier for the job
1400  *         only valid until "task" is started!
1401  */
1402 GNUNET_SCHEDULER_TaskIdentifier
1403 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
1404                                 struct GNUNET_NETWORK_Handle *wfd,
1405                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1406 {
1407 #if MINGW
1408   struct GNUNET_NETWORK_FDSet *ws;
1409   GNUNET_SCHEDULER_TaskIdentifier ret;
1410
1411   GNUNET_assert (wfd != NULL);
1412   ws = GNUNET_NETWORK_fdset_create ();
1413   GNUNET_NETWORK_fdset_set (ws, wfd);
1414   ret =
1415     GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1416                                  delay, NULL, ws,
1417                                    task, task_cls);
1418   GNUNET_NETWORK_fdset_destroy (ws);
1419   return ret;
1420 #else
1421   GNUNET_assert (GNUNET_NETWORK_get_fd (wfd) >= 0);
1422   return add_without_sets (delay, 
1423                            GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1424                            -1, GNUNET_NETWORK_get_fd (wfd), task,
1425                            task_cls);
1426 #endif
1427 }
1428
1429
1430 /**
1431  * Schedule a new task to be run with a specified delay or when the
1432  * specified file descriptor is ready for reading.  The delay can be
1433  * used as a timeout on the socket being ready.  The task will be
1434  * scheduled for execution once either the delay has expired or the
1435  * socket operation is ready. It will be run with the DEFAULT priority.
1436  *
1437  * @param delay when should this operation time out? Use
1438  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1439  * @param rfd read file-descriptor
1440  * @param task main function of the task
1441  * @param task_cls closure of task
1442  * @return unique task identifier for the job
1443  *         only valid until "task" is started!
1444  */
1445 GNUNET_SCHEDULER_TaskIdentifier
1446 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
1447                                 const struct GNUNET_DISK_FileHandle *rfd,
1448                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1449 {
1450 #if MINGW
1451   struct GNUNET_NETWORK_FDSet *rs;
1452   GNUNET_SCHEDULER_TaskIdentifier ret;
1453
1454   GNUNET_assert (rfd != NULL);
1455   rs = GNUNET_NETWORK_fdset_create ();
1456   GNUNET_NETWORK_fdset_handle_set (rs, rfd);
1457   ret =
1458       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1459                                    delay, rs, NULL,
1460                                    task, task_cls);
1461   GNUNET_NETWORK_fdset_destroy (rs);
1462   return ret;
1463 #else
1464   int fd;
1465
1466   GNUNET_DISK_internal_file_handle_ (rfd, &fd, sizeof (int));
1467   return add_without_sets (delay, 
1468                            GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1469                            fd, -1, task, task_cls);
1470
1471 #endif
1472 }
1473
1474
1475 /**
1476  * Schedule a new task to be run with a specified delay or when the
1477  * specified file descriptor is ready for writing.  The delay can be
1478  * used as a timeout on the socket being ready.  The task will be
1479  * scheduled for execution once either the delay has expired or the
1480  * socket operation is ready. It will be run with the DEFAULT priority.
1481  *
1482  * @param delay when should this operation time out? Use
1483  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1484  * @param wfd write file-descriptor
1485  * @param task main function of the task
1486  * @param task_cls closure of task
1487  * @return unique task identifier for the job
1488  *         only valid until "task" is started!
1489  */
1490 GNUNET_SCHEDULER_TaskIdentifier
1491 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
1492                                  const struct GNUNET_DISK_FileHandle *wfd,
1493                                  GNUNET_SCHEDULER_Task task, void *task_cls)
1494 {
1495 #if MINGW
1496   struct GNUNET_NETWORK_FDSet *ws;
1497   GNUNET_SCHEDULER_TaskIdentifier ret;
1498
1499   GNUNET_assert (wfd != NULL);
1500   ws = GNUNET_NETWORK_fdset_create ();
1501   GNUNET_NETWORK_fdset_handle_set (ws, wfd);
1502   ret =
1503       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1504                                    delay, NULL, ws,
1505                                    task, task_cls);
1506   GNUNET_NETWORK_fdset_destroy (ws);
1507   return ret;
1508 #else
1509   int fd;
1510
1511   GNUNET_DISK_internal_file_handle_ (wfd, &fd, sizeof (int));
1512   GNUNET_assert (fd >= 0);
1513   return add_without_sets (delay, 
1514                            GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1515                            -1, fd, task, task_cls);
1516
1517 #endif
1518 }
1519
1520
1521
1522 /**
1523  * Schedule a new task to be run with a specified delay or when any of
1524  * the specified file descriptor sets is ready.  The delay can be used
1525  * as a timeout on the socket(s) being ready.  The task will be
1526  * scheduled for execution once either the delay has expired or any of
1527  * the socket operations is ready.  This is the most general
1528  * function of the "add" family.  Note that the "prerequisite_task"
1529  * must be satisfied in addition to any of the other conditions.  In
1530  * other words, the task will be started when
1531  * <code>
1532  * (prerequisite-run)
1533  * && (delay-ready
1534  *     || any-rs-ready
1535  *     || any-ws-ready
1536  *     || (shutdown-active && run-on-shutdown) )
1537  * </code>
1538  *
1539  * @param prio how important is this task?
1540  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1541  *        which means that the task will only be run after we receive SIGTERM
1542  * @param rs set of file descriptors we want to read (can be NULL)
1543  * @param ws set of file descriptors we want to write (can be NULL)
1544  * @param task main function of the task
1545  * @param task_cls closure of task
1546  * @return unique task identifier for the job
1547  *         only valid until "task" is started!
1548  */
1549 GNUNET_SCHEDULER_TaskIdentifier
1550 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
1551                              struct GNUNET_TIME_Relative delay,
1552                              const struct GNUNET_NETWORK_FDSet *rs,
1553                              const struct GNUNET_NETWORK_FDSet *ws,
1554                              GNUNET_SCHEDULER_Task task, void *task_cls)
1555 {
1556   struct Task *t;
1557
1558 #if EXECINFO
1559   void *backtrace_array[MAX_TRACE_DEPTH];
1560 #endif
1561
1562   GNUNET_assert (active_task != NULL);
1563   GNUNET_assert (NULL != task);
1564   t = GNUNET_malloc (sizeof (struct Task));
1565   t->callback = task;
1566   t->callback_cls = task_cls;
1567 #if EXECINFO
1568   t->num_backtrace_strings = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1569   t->backtrace_strings =
1570       backtrace_symbols (backtrace_array, t->num_backtrace_strings);
1571 #endif
1572   t->read_fd = -1;
1573   t->write_fd = -1;
1574   if (rs != NULL)
1575   {
1576     t->read_set = GNUNET_NETWORK_fdset_create ();
1577     GNUNET_NETWORK_fdset_copy (t->read_set, rs);
1578   }
1579   if (ws != NULL)
1580   {
1581     t->write_set = GNUNET_NETWORK_fdset_create ();
1582     GNUNET_NETWORK_fdset_copy (t->write_set, ws);
1583   }
1584   t->id = ++last_id;
1585 #if PROFILE_DELAYS
1586   t->start_time = GNUNET_TIME_absolute_get ();
1587 #endif
1588   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1589   t->priority =
1590       check_priority ((prio ==
1591                        GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority :
1592                       prio);
1593   t->lifeness = current_lifeness;
1594   t->next = pending;
1595   pending = t;
1596   max_priority_added = GNUNET_MAX (max_priority_added, t->priority);
1597   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding task: %llu / %p\n", t->id,
1598        t->callback_cls);
1599 #if EXECINFO
1600   int i;
1601
1602   for (i = 0; i < t->num_backtrace_strings; i++)
1603     LOG (GNUNET_ERROR_TYPE_DEBUG, "Task %llu trace %d: %s\n", t->id, i,
1604          t->backtrace_strings[i]);
1605 #endif
1606   return t->id;
1607 }
1608
1609 /* end of scheduler.c */