add missing DLL insert
[oweals/gnunet.git] / src / util / scheduler.c
1 /*
2       This file is part of GNUnet
3       Copyright (C) 2009-2017 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18       Boston, MA 02110-1301, USA.
19  */
20 /**
21  * @file util/scheduler.c
22  * @brief schedule computations using continuation passing style
23  * @author Christian Grothoff
24  */
25 #include "platform.h"
26 #include "gnunet_util_lib.h"
27 #include "disk.h"
28
29 #define LOG(kind,...) GNUNET_log_from (kind, "util-scheduler", __VA_ARGS__)
30
31 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util-scheduler", syscall)
32
33
34 #if HAVE_EXECINFO_H
35 #include "execinfo.h"
36
37 /**
38  * Use lsof to generate file descriptor reports on select error?
39  * (turn off for stable releases).
40  */
41 #define USE_LSOF GNUNET_NO
42
43 /**
44  * Obtain trace information for all scheduler calls that schedule tasks.
45  */
46 #define EXECINFO GNUNET_NO
47
48 /**
49  * Check each file descriptor before adding
50  */
51 #define DEBUG_FDS GNUNET_NO
52
53 /**
54  * Depth of the traces collected via EXECINFO.
55  */
56 #define MAX_TRACE_DEPTH 50
57 #endif
58
59 /**
60  * Should we figure out which tasks are delayed for a while
61  * before they are run? (Consider using in combination with EXECINFO).
62  */
63 #define PROFILE_DELAYS GNUNET_NO
64
65 /**
66  * Task that were in the queue for longer than this are reported if
67  * PROFILE_DELAYS is active.
68  */
69 #define DELAY_THRESHOLD GNUNET_TIME_UNIT_SECONDS
70
71
72 /**
73  * Argument to be passed from the driver to
74  * #GNUNET_SCHEDULER_run_from_driver().  Contains the
75  * scheduler's internal state.
76  */
77 struct GNUNET_SCHEDULER_Handle
78 {
79   /**
80    * Passed here to avoid constantly allocating/deallocating
81    * this element, but generally we want to get rid of this.
82    * @deprecated
83    */
84   struct GNUNET_NETWORK_FDSet *rs;
85
86   /**
87    * Passed here to avoid constantly allocating/deallocating
88    * this element, but generally we want to get rid of this.
89    * @deprecated
90    */
91   struct GNUNET_NETWORK_FDSet *ws;
92
93   /**
94    * Driver we used for the event loop.
95    */
96   const struct GNUNET_SCHEDULER_Driver *driver;
97
98 };
99
100
101 /**
102  * Entry in list of pending tasks.
103  */
104 struct GNUNET_SCHEDULER_Task
105 {
106   /**
107    * This is a linked list.
108    */
109   struct GNUNET_SCHEDULER_Task *next;
110
111   /**
112    * This is a linked list.
113    */
114   struct GNUNET_SCHEDULER_Task *prev;
115
116   /**
117    * Function to run when ready.
118    */
119   GNUNET_SCHEDULER_TaskCallback callback;
120
121   /**
122    * Closure for the @e callback.
123    */
124   void *callback_cls;
125
126   /**
127    * Handle to the scheduler's state.
128    */
129   const struct GNUNET_SCHEDULER_Handle *sh;
130
131   /**
132    * Set of file descriptors this task is waiting
133    * for for reading.  Once ready, this is updated
134    * to reflect the set of file descriptors ready
135    * for operation.
136    */
137   struct GNUNET_NETWORK_FDSet *read_set;
138
139   /**
140    * Set of file descriptors this task is waiting for for writing.
141    * Once ready, this is updated to reflect the set of file
142    * descriptors ready for operation.
143    */
144   struct GNUNET_NETWORK_FDSet *write_set;
145
146   /**
147    * Information about which FDs are ready for this task (and why).
148    */
149   const struct GNUNET_SCHEDULER_FdInfo *fds;
150
151   /**
152    * Storage location used for @e fds if we want to avoid
153    * a separate malloc() call in the common case that this
154    * task is only about a single FD.
155    */
156   struct GNUNET_SCHEDULER_FdInfo fdx;
157
158   /**
159    * Absolute timeout value for the task, or
160    * #GNUNET_TIME_UNIT_FOREVER_ABS for "no timeout".
161    */
162   struct GNUNET_TIME_Absolute timeout;
163
164 #if PROFILE_DELAYS
165   /**
166    * When was the task scheduled?
167    */
168   struct GNUNET_TIME_Absolute start_time;
169 #endif
170
171   /**
172    * Size of the @e fds array.
173    */
174   unsigned int fds_len;
175
176   /**
177    * Why is the task ready?  Set after task is added to ready queue.
178    * Initially set to zero.  All reasons that have already been
179    * satisfied (i.e.  read or write ready) will be set over time.
180    */
181   enum GNUNET_SCHEDULER_Reason reason;
182
183   /**
184    * Task priority.
185    */
186   enum GNUNET_SCHEDULER_Priority priority;
187
188   /**
189    * Set if we only wait for reading from a single FD, otherwise -1.
190    */
191   int read_fd;
192
193   /**
194    * Set if we only wait for writing to a single FD, otherwise -1.
195    */
196   int write_fd;
197
198   /**
199    * Should the existence of this task in the queue be counted as
200    * reason to not shutdown the scheduler?
201    */
202   int lifeness;
203
204   /**
205    * Is this task run on shutdown?
206    */
207   int on_shutdown;
208
209   /**
210    * Is this task in the ready list?
211    */
212   int in_ready_list;
213
214 #if EXECINFO
215   /**
216    * Array of strings which make up a backtrace from the point when this
217    * task was scheduled (essentially, who scheduled the task?)
218    */
219   char **backtrace_strings;
220
221   /**
222    * Size of the backtrace_strings array
223    */
224   int num_backtrace_strings;
225 #endif
226
227
228 };
229
230 /**
231  * The driver used for the event loop. Will be handed over to
232  * the scheduler in #GNUNET_SCHEDULER_run_from_driver(), peristed
233  * there in this variable for later use in functions like
234  * #GNUNET_SCHEDULER_add_select(), #add_without_sets() and
235  * #GNUNET_SCHEDULER_cancel().
236  */
237 static const struct GNUNET_SCHEDULER_Driver *scheduler_driver;
238
239 /**
240  * Head of list of tasks waiting for an event.
241  */
242 static struct GNUNET_SCHEDULER_Task *pending_head;
243
244 /**
245  * Tail of list of tasks waiting for an event.
246  */
247 static struct GNUNET_SCHEDULER_Task *pending_tail;
248
249 /**
250  * Head of list of tasks waiting for shutdown.
251  */
252 static struct GNUNET_SCHEDULER_Task *shutdown_head;
253
254 /**
255  * Tail of list of tasks waiting for shutdown.
256  */
257 static struct GNUNET_SCHEDULER_Task *shutdown_tail;
258
259 /**
260  * List of tasks waiting ONLY for a timeout event.
261  * Sorted by timeout (earliest first).  Used so that
262  * we do not traverse the list of these tasks when
263  * building select sets (we just look at the head
264  * to determine the respective timeout ONCE).
265  */
266 static struct GNUNET_SCHEDULER_Task *pending_timeout_head;
267
268 /**
269  * List of tasks waiting ONLY for a timeout event.
270  * Sorted by timeout (earliest first).  Used so that
271  * we do not traverse the list of these tasks when
272  * building select sets (we just look at the head
273  * to determine the respective timeout ONCE).
274  */
275 static struct GNUNET_SCHEDULER_Task *pending_timeout_tail;
276
277 /**
278  * Last inserted task waiting ONLY for a timeout event.
279  * Used to (heuristically) speed up insertion.
280  */
281 static struct GNUNET_SCHEDULER_Task *pending_timeout_last;
282
283 /**
284  * ID of the task that is running right now.
285  */
286 static struct GNUNET_SCHEDULER_Task *active_task;
287
288 /**
289  * Head of list of tasks ready to run right now, grouped by importance.
290  */
291 static struct GNUNET_SCHEDULER_Task *ready_head[GNUNET_SCHEDULER_PRIORITY_COUNT];
292
293 /**
294  * Tail of list of tasks ready to run right now, grouped by importance.
295  */
296 static struct GNUNET_SCHEDULER_Task *ready_tail[GNUNET_SCHEDULER_PRIORITY_COUNT];
297
298 /**
299  * Number of tasks on the ready list.
300  */
301 static unsigned int ready_count;
302
303 /**
304  * How many tasks have we run so far?
305  */
306 static unsigned long long tasks_run;
307
308 /**
309  * Priority of the task running right now.  Only
310  * valid while a task is running.
311  */
312 static enum GNUNET_SCHEDULER_Priority current_priority;
313
314 /**
315  * Priority of the highest task added in the current select
316  * iteration.
317  */
318 static enum GNUNET_SCHEDULER_Priority max_priority_added;
319
320 /**
321  * Value of the 'lifeness' flag for the current task.
322  */
323 static int current_lifeness;
324
325 /**
326  * Function to use as a select() in the scheduler.
327  * If NULL, we use GNUNET_NETWORK_socket_select().
328  */
329 static GNUNET_SCHEDULER_select scheduler_select;
330
331 /**
332  * Task context of the current task.
333  */
334 static struct GNUNET_SCHEDULER_TaskContext tc;
335
336 /**
337  * Closure for #scheduler_select.
338  */
339 static void *scheduler_select_cls;
340
341
342 /**
343  * Sets the select function to use in the scheduler (scheduler_select).
344  *
345  * @param new_select new select function to use
346  * @param new_select_cls closure for @a new_select
347  * @return previously used select function, NULL for default
348  */
349 void
350 GNUNET_SCHEDULER_set_select (GNUNET_SCHEDULER_select new_select,
351                              void *new_select_cls)
352 {
353   scheduler_select = new_select;
354   scheduler_select_cls = new_select_cls;
355 }
356
357
358 /**
359  * Check that the given priority is legal (and return it).
360  *
361  * @param p priority value to check
362  * @return p on success, 0 on error
363  */
364 static enum GNUNET_SCHEDULER_Priority
365 check_priority (enum GNUNET_SCHEDULER_Priority p)
366 {
367   if ((p >= 0) && (p < GNUNET_SCHEDULER_PRIORITY_COUNT))
368     return p;
369   GNUNET_assert (0);
370   return 0;                     /* make compiler happy */
371 }
372
373
374 /**
375  * Update all sets and timeout for select.
376  *
377  * @param rs read-set, set to all FDs we would like to read (updated)
378  * @param ws write-set, set to all FDs we would like to write (updated)
379  * @param timeout next timeout (updated)
380  */
381 void getNextPendingTimeout(struct GNUNET_TIME_Relative *timeout)
382 {
383
384   struct GNUNET_SCHEDULER_Task *pos;
385   struct GNUNET_TIME_Absolute now;
386   struct GNUNET_TIME_Relative to;
387
388   now = GNUNET_TIME_absolute_get ();
389   pos = pending_timeout_head;
390   if (NULL != pos)
391   {
392     to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
393     if (timeout->rel_value_us > to.rel_value_us)
394       *timeout = to;
395     if (0 != pos->reason)
396       *timeout = GNUNET_TIME_UNIT_ZERO;
397   }
398 }
399
400 static void
401 update_sets (struct GNUNET_NETWORK_FDSet *rs,
402              struct GNUNET_NETWORK_FDSet *ws,
403              struct GNUNET_TIME_Relative *timeout)
404 {
405   struct GNUNET_SCHEDULER_Task *pos;
406   struct GNUNET_TIME_Absolute now;
407   struct GNUNET_TIME_Relative to;
408
409   now = GNUNET_TIME_absolute_get ();
410
411   getNextPendingTimeout(timeout);
412   for (pos = pending_head; NULL != pos; pos = pos->next)
413   {
414     if (pos->timeout.abs_value_us != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
415     {
416       to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
417       if (timeout->rel_value_us > to.rel_value_us)
418         *timeout = to;
419     }
420     if (-1 != pos->read_fd)
421       GNUNET_NETWORK_fdset_set_native (rs, pos->read_fd);
422     if (-1 != pos->write_fd)
423       GNUNET_NETWORK_fdset_set_native (ws, pos->write_fd);
424     if (NULL != pos->read_set)
425       GNUNET_NETWORK_fdset_add (rs, pos->read_set);
426     if (NULL != pos->write_set)
427       GNUNET_NETWORK_fdset_add (ws, pos->write_set);
428     if (0 != pos->reason)
429       *timeout = GNUNET_TIME_UNIT_ZERO;
430   }
431 }
432
433
434 /**
435  * Check if the ready set overlaps with the set we want to have ready.
436  * If so, update the want set (set all FDs that are ready).  If not,
437  * return #GNUNET_NO.
438  *
439  * @param ready set that is ready
440  * @param want set that we want to be ready
441  * @return #GNUNET_YES if there was some overlap
442  */
443 static int
444 set_overlaps (const struct GNUNET_NETWORK_FDSet *ready,
445               struct GNUNET_NETWORK_FDSet *want)
446 {
447   if ((NULL == want) || (NULL == ready))
448     return GNUNET_NO;
449   if (GNUNET_NETWORK_fdset_overlap (ready, want))
450   {
451     /* copy all over (yes, there maybe unrelated bits,
452      * but this should not hurt well-written clients) */
453     GNUNET_NETWORK_fdset_copy (want, ready);
454     return GNUNET_YES;
455   }
456   return GNUNET_NO;
457 }
458
459
460 /**
461  * Check if the given task is eligible to run now.
462  * Also set the reason why it is eligible.
463  *
464  * @param task task to check if it is ready
465  * @param now the current time
466  * @param rs set of FDs ready for reading
467  * @param ws set of FDs ready for writing
468  * @return #GNUNET_YES if we can run it, #GNUNET_NO if not.
469  */
470 static int
471 is_ready (struct GNUNET_SCHEDULER_Task *task,
472           struct GNUNET_TIME_Absolute now,
473           const struct GNUNET_NETWORK_FDSet *rs,
474           const struct GNUNET_NETWORK_FDSet *ws)
475 {
476   enum GNUNET_SCHEDULER_Reason reason;
477
478   reason = task->reason;
479   if (now.abs_value_us >= task->timeout.abs_value_us)
480     reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
481   if ((0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
482       (((task->read_fd != -1) &&
483         (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (rs, task->read_fd))) ||
484        (set_overlaps (rs, task->read_set))))
485     reason |= GNUNET_SCHEDULER_REASON_READ_READY;
486   if ((0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
487       (((task->write_fd != -1) &&
488         (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (ws, task->write_fd)))
489        || (set_overlaps (ws, task->write_set))))
490     reason |= GNUNET_SCHEDULER_REASON_WRITE_READY;
491   if (0 == reason)
492     return GNUNET_NO;           /* not ready */
493   reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;
494   task->reason = reason;
495   return GNUNET_YES;
496 }
497
498
499 /**
500  * Put a task that is ready for execution into the ready queue.
501  *
502  * @param task task ready for execution
503  */
504 static void
505 queue_ready_task (struct GNUNET_SCHEDULER_Task *task)
506 {
507   enum GNUNET_SCHEDULER_Priority p = check_priority (task->priority);
508
509   GNUNET_CONTAINER_DLL_insert (ready_head[p],
510                                ready_tail[p],
511                                task);
512   task->in_ready_list = GNUNET_YES;
513   ready_count++;
514 }
515
516
517 /**
518  * Check which tasks are ready and move them
519  * to the respective ready queue.
520  *
521  * @param rs FDs ready for reading
522  * @param ws FDs ready for writing
523  */
524 static void
525 check_ready (const struct GNUNET_NETWORK_FDSet *rs,
526              const struct GNUNET_NETWORK_FDSet *ws)
527 {
528   struct GNUNET_SCHEDULER_Task *pos;
529   struct GNUNET_SCHEDULER_Task *next;
530   struct GNUNET_TIME_Absolute now;
531
532   now = GNUNET_TIME_absolute_get ();
533   while (NULL != (pos = pending_timeout_head))
534   {
535     if (now.abs_value_us >= pos->timeout.abs_value_us)
536       pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
537     if (0 == pos->reason)
538       break;
539     GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
540                                  pending_timeout_tail,
541                                  pos);
542     scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
543     if (pending_timeout_last == pos)
544       pending_timeout_last = NULL;
545     queue_ready_task (pos);
546   }
547   pos = pending_head;
548   while (NULL != pos)
549   {
550     next = pos->next;
551     if (GNUNET_YES == is_ready (pos, now, rs, ws))
552     {
553       GNUNET_CONTAINER_DLL_remove (pending_head,
554                                    pending_tail,
555                                    pos);
556       queue_ready_task (pos);
557     }
558     pos = next;
559   }
560 }
561
562
563 /**
564  * Request the shutdown of a scheduler.  Marks all tasks
565  * awaiting shutdown as ready. Note that tasks
566  * scheduled with #GNUNET_SCHEDULER_add_shutdown() AFTER this call
567  * will be delayed until the next shutdown signal.
568  */
569 void
570 GNUNET_SCHEDULER_shutdown ()
571 {
572   struct GNUNET_SCHEDULER_Task *pos;
573
574   while (NULL != (pos = shutdown_head))
575   {
576     GNUNET_CONTAINER_DLL_remove (shutdown_head,
577                                  shutdown_tail,
578                                  pos);
579     pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
580     queue_ready_task (pos);
581   }
582 }
583
584
585 /**
586  * Destroy a task (release associated resources)
587  *
588  * @param t task to destroy
589  */
590 static void
591 destroy_task (struct GNUNET_SCHEDULER_Task *t)
592 {
593   if (NULL != t->read_set)
594     GNUNET_NETWORK_fdset_destroy (t->read_set);
595   if (NULL != t->write_set)
596     GNUNET_NETWORK_fdset_destroy (t->write_set);
597 #if EXECINFO
598   GNUNET_free (t->backtrace_strings);
599 #endif
600   GNUNET_free (t);
601 }
602
603
604 /**
605  * Output stack trace of task @a t.
606  *
607  * @param t task to dump stack trace of
608  */
609 static void
610 dump_backtrace (struct GNUNET_SCHEDULER_Task *t)
611 {
612 #if EXECINFO
613   unsigned int i;
614
615   for (i = 0; i < t->num_backtrace_strings; i++)
616     LOG (GNUNET_ERROR_TYPE_DEBUG,
617    "Task %p trace %u: %s\n",
618    t,
619    i,
620    t->backtrace_strings[i]);
621 #endif
622 }
623
624
625 /**
626  * Run at least one task in the highest-priority queue that is not
627  * empty.  Keep running tasks until we are either no longer running
628  * "URGENT" tasks or until we have at least one "pending" task (which
629  * may become ready, hence we should select on it).  Naturally, if
630  * there are no more ready tasks, we also return.
631  *
632  * @param rs FDs ready for reading
633  * @param ws FDs ready for writing
634  */
635 static void
636 run_ready (struct GNUNET_NETWORK_FDSet *rs,
637            struct GNUNET_NETWORK_FDSet *ws)
638 {
639   enum GNUNET_SCHEDULER_Priority p;
640   struct GNUNET_SCHEDULER_Task *pos;
641
642   max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
643   do
644   {
645     if (0 == ready_count)
646       return;
647     GNUNET_assert (NULL == ready_head[GNUNET_SCHEDULER_PRIORITY_KEEP]);
648     /* yes, p>0 is correct, 0 is "KEEP" which should
649      * always be an empty queue (see assertion)! */
650     for (p = GNUNET_SCHEDULER_PRIORITY_COUNT - 1; p > 0; p--)
651     {
652       pos = ready_head[p];
653       if (NULL != pos)
654         break;
655     }
656     GNUNET_assert (NULL != pos);        /* ready_count wrong? */
657     GNUNET_CONTAINER_DLL_remove (ready_head[p],
658                                  ready_tail[p],
659                                  pos);
660     ready_count--;
661     current_priority = pos->priority;
662     current_lifeness = pos->lifeness;
663     active_task = pos;
664 #if PROFILE_DELAYS
665     if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
666         DELAY_THRESHOLD.rel_value_us)
667     {
668       LOG (GNUNET_ERROR_TYPE_DEBUG,
669      "Task %p took %s to be scheduled\n",
670            pos,
671            GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time),
672                                                    GNUNET_YES));
673     }
674 #endif
675     tc.reason = pos->reason;
676     tc.read_ready = (NULL == pos->read_set) ? rs : pos->read_set;
677     if ((-1 != pos->read_fd) &&
678         (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)))
679       GNUNET_NETWORK_fdset_set_native (rs, pos->read_fd);
680     tc.write_ready = (NULL == pos->write_set) ? ws : pos->write_set;
681     if ((-1 != pos->write_fd) &&
682         (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)))
683       GNUNET_NETWORK_fdset_set_native (ws, pos->write_fd);
684     if ((0 != (tc.reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
685         (-1 != pos->write_fd) &&
686         (!GNUNET_NETWORK_fdset_test_native (ws, pos->write_fd)))
687       GNUNET_assert (0);          // added to ready in previous select loop!
688     LOG (GNUNET_ERROR_TYPE_DEBUG,
689    "Running task: %p\n",
690          pos);
691     pos->callback (pos->callback_cls);
692     dump_backtrace (pos);
693     active_task = NULL;
694     destroy_task (pos);
695     tasks_run++;
696   }
697   while ((NULL == pending_head) || (p >= max_priority_added));
698 }
699
700
701 /**
702  * Pipe used to communicate shutdown via signal.
703  */
704 static struct GNUNET_DISK_PipeHandle *shutdown_pipe_handle;
705
706 /**
707  * Process ID of this process at the time we installed the various
708  * signal handlers.
709  */
710 static pid_t my_pid;
711
712 /**
713  * Signal handler called for SIGPIPE.
714  */
715 #ifndef MINGW
716 static void
717 sighandler_pipe ()
718 {
719   return;
720 }
721 #endif
722
723
724 /**
725  * Wait for a short time.
726  * Sleeps for @a ms ms (as that should be long enough for virtually all
727  * modern systems to context switch and allow another process to do
728  * some 'real' work).
729  *
730  * @param ms how many ms to wait
731  */
732 static void
733 short_wait (unsigned int ms)
734 {
735   struct GNUNET_TIME_Relative timeout;
736
737   timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, ms);
738   (void) GNUNET_NETWORK_socket_select (NULL, NULL, NULL, timeout);
739 }
740
741
742 /**
743  * Signal handler called for signals that should cause us to shutdown.
744  */
745 static void
746 sighandler_shutdown ()
747 {
748   static char c;
749   int old_errno = errno;        /* backup errno */
750
751   if (getpid () != my_pid)
752     exit (1);                   /* we have fork'ed since the signal handler was created,
753                                  * ignore the signal, see https://gnunet.org/vfork discussion */
754   GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
755                           (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_WRITE),
756                           &c, sizeof (c));
757   errno = old_errno;
758 }
759
760
761 /**
762  * Check if the system is still alive. Trigger shutdown if we
763  * have tasks, but none of them give us lifeness.
764  *
765  * @return #GNUNET_OK to continue the main loop,
766  *         #GNUNET_NO to exit
767  */
768 static int
769 check_lifeness ()
770 {
771   struct GNUNET_SCHEDULER_Task *t;
772
773   if (ready_count > 0)
774     return GNUNET_OK;
775   for (t = pending_head; NULL != t; t = t->next)
776     if (t->lifeness == GNUNET_YES)
777       return GNUNET_OK;
778   for (t = shutdown_head; NULL != t; t = t->next)
779     if (t->lifeness == GNUNET_YES)
780       return GNUNET_OK;
781   for (t = pending_timeout_head; NULL != t; t = t->next)
782     if (t->lifeness == GNUNET_YES)
783       return GNUNET_OK;
784   if (NULL != shutdown_head)
785   {
786     GNUNET_SCHEDULER_shutdown ();
787     return GNUNET_OK;
788   }
789   return GNUNET_NO;
790 }
791
792
793
794 int while_live(struct GNUNET_NETWORK_FDSet *rs, struct GNUNET_NETWORK_FDSet *ws)
795 {
796   int ret;
797   unsigned int busy_wait_warning;
798   unsigned long long last_tr;
799   const struct GNUNET_DISK_FileHandle *pr;
800   char c;
801   struct GNUNET_TIME_Relative timeout;
802
803   busy_wait_warning = 0;
804   pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
805                                 GNUNET_DISK_PIPE_END_READ);
806   GNUNET_assert (NULL != pr);
807   last_tr = 0;
808
809   while (GNUNET_OK == check_lifeness ())
810   {
811     GNUNET_NETWORK_fdset_zero (rs);
812     GNUNET_NETWORK_fdset_zero (ws);
813     timeout = GNUNET_TIME_UNIT_FOREVER_REL;
814     update_sets (rs, ws, &timeout);
815     GNUNET_NETWORK_fdset_handle_set (rs, pr);
816     if (ready_count > 0)
817     {
818       /* no blocking, more work already ready! */
819       timeout = GNUNET_TIME_UNIT_ZERO;
820     }
821     if (NULL == scheduler_select)
822       ret = GNUNET_NETWORK_socket_select (rs,
823                                           ws,
824                                           NULL,
825                                           timeout);
826     else
827       ret = scheduler_select (scheduler_select_cls,
828                               rs,
829                               ws,
830                               NULL,
831                               timeout);
832     if (ret == GNUNET_SYSERR)
833     {
834       if (errno == EINTR)
835         continue;
836
837       LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "select");
838 #ifndef MINGW
839 #if USE_LSOF
840       char lsof[512];
841
842       snprintf (lsof, sizeof (lsof), "lsof -p %d", getpid ());
843       (void) close (1);
844       (void) dup2 (2, 1);
845       if (0 != system (lsof))
846         LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
847                       "system");
848 #endif
849 #endif
850 #if DEBUG_FDS
851       struct GNUNET_SCHEDULER_Task *t;
852
853       for (t = pending_head; NULL != t; t = t->next)
854       {
855         if (-1 != t->read_fd)
856         {
857           int flags = fcntl (t->read_fd, F_GETFD);
858           if ((flags == -1) && (errno == EBADF))
859             {
860               LOG (GNUNET_ERROR_TYPE_ERROR,
861                    "Got invalid file descriptor %d!\n",
862                    t->read_fd);
863               dump_backtrace (t);
864             }
865         }
866         if (-1 != t->write_fd)
867           {
868             int flags = fcntl (t->write_fd, F_GETFD);
869             if ((flags == -1) && (errno == EBADF))
870               {
871                 LOG (GNUNET_ERROR_TYPE_ERROR,
872                      "Got invalid file descriptor %d!\n",
873                      t->write_fd);
874                 dump_backtrace (t);
875               }
876           }
877       }
878 #endif
879       GNUNET_assert (0);
880       break;
881     }
882
883     if ( (0 == ret) &&
884          (0 == timeout.rel_value_us) &&
885          (busy_wait_warning > 16) )
886     {
887       LOG (GNUNET_ERROR_TYPE_WARNING,
888            "Looks like we're busy waiting...\n");
889       short_wait (100);                /* mitigate */
890     }
891     check_ready (rs, ws);
892     run_ready (rs, ws);
893     if (GNUNET_NETWORK_fdset_handle_isset (rs, pr))
894     {
895       /* consume the signal */
896       GNUNET_DISK_file_read (pr, &c, sizeof (c));
897       /* mark all active tasks as ready due to shutdown */
898       GNUNET_SCHEDULER_shutdown ();
899     }
900     if (last_tr == tasks_run)
901     {
902       short_wait (1);
903       busy_wait_warning++;
904     }
905     else
906     {
907       last_tr = tasks_run;
908       busy_wait_warning = 0;
909     }
910   }
911   return ret;
912 }
913
914 /**
915  * Initialize and run scheduler.  This function will return when all
916  * tasks have completed.  On systems with signals, receiving a SIGTERM
917  * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown()
918  * to be run after the active task is complete.  As a result, SIGTERM
919  * causes all active tasks to be scheduled with reason
920  * #GNUNET_SCHEDULER_REASON_SHUTDOWN.  (However, tasks added
921  * afterwards will execute normally!). Note that any particular signal
922  * will only shut down one scheduler; applications should always only
923  * create a single scheduler.
924  *
925  * @param task task to run immediately
926  * @param task_cls closure of @a task
927  */
928 void
929 GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_TaskCallback task,
930                       void *task_cls)
931 {
932
933   GNUNET_SCHEDULER_run_with_driver(GNUNET_SCHEDULER_driver_select (), task, task_cls);
934
935 }
936
937
938 /**
939  * Obtain the task context, giving the reason why the current task was
940  * started.
941  *
942  * @return current tasks' scheduler context
943  */
944 const struct GNUNET_SCHEDULER_TaskContext *
945 GNUNET_SCHEDULER_get_task_context ()
946 {
947   GNUNET_assert (NULL != active_task);
948   return &tc;
949 }
950
951
952 /**
953  * Get information about the current load of this scheduler.  Use this
954  * function to determine if an elective task should be added or simply
955  * dropped (if the decision should be made based on the number of
956  * tasks ready to run).
957  *
958  * @param p priority level to look at
959  * @return number of tasks pending right now
960  */
961 unsigned int
962 GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p)
963 {
964   struct GNUNET_SCHEDULER_Task *pos;
965   unsigned int ret;
966
967   GNUNET_assert (NULL != active_task);
968   if (p == GNUNET_SCHEDULER_PRIORITY_COUNT)
969     return ready_count;
970   if (p == GNUNET_SCHEDULER_PRIORITY_KEEP)
971     p = current_priority;
972   ret = 0;
973   for (pos = ready_head[check_priority (p)]; NULL != pos; pos = pos->next)
974     ret++;
975   return ret;
976 }
977
978
979 void
980 initFdInfo(struct GNUNET_SCHEDULER_Task *t,
981            const struct GNUNET_NETWORK_Handle *read_nh,
982            const struct GNUNET_NETWORK_Handle *write_nh,
983            const struct GNUNET_DISK_FileHandle *read_fh,
984            const struct GNUNET_DISK_FileHandle *write_fh)
985 {
986   // either only network handles or only file handles are allowed
987   GNUNET_assert (!((NULL != read_nh || NULL != write_nh) && (NULL != read_fh || NULL != write_fh)));
988
989   if (NULL != read_nh && NULL != write_nh)
990   {
991     t->fds_len = 2;
992     t->fds = GNUNET_new_array (2, struct GNUNET_SCHEDULER_FdInfo);
993     const struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fd = read_nh, .et = GNUNET_SCHEDULER_ET_IN, .sock = GNUNET_NETWORK_get_fd (read_nh)};
994     const struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fd = write_nh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
995
996     const struct GNUNET_SCHEDULER_FdInfo array[2] = {read_fdi, write_fdi};
997     t->fds = array;
998   }
999   else if (NULL != read_fh && NULL != write_fh)
1000   {
1001     t->fds_len = 2;
1002     t->fds = GNUNET_new_array (2, struct GNUNET_SCHEDULER_FdInfo);
1003     const struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fh = read_fh, .et = GNUNET_SCHEDULER_ET_IN};
1004     const struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fh = write_fh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
1005     const struct GNUNET_SCHEDULER_FdInfo array[2] = {read_fdi, write_fdi};
1006     t->fds = array;
1007   }
1008   else if (NULL != read_nh)
1009   {
1010     struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fd = read_nh, .et = GNUNET_SCHEDULER_ET_IN, .sock = GNUNET_NETWORK_get_fd (read_nh)};
1011     t->fdx = read_fdi;
1012   }
1013   else if (NULL != write_nh)
1014   {
1015     struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fd = write_nh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
1016     t->fdx = write_fdi;
1017   }
1018   else if (NULL != read_fh)
1019   {
1020     struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fh = read_fh, .et = GNUNET_SCHEDULER_ET_IN, .sock = read_fh->fd};
1021     t->fdx = read_fdi;
1022   }
1023   else if (NULL != write_fh)
1024   {
1025     struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fh = write_fh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = write_fh->fd};
1026     t->fdx = write_fdi;
1027   }
1028 }
1029
1030
1031 int scheduler_multi_function_call(struct GNUNET_SCHEDULER_Task *t, int (*driver_func)())
1032 {
1033   if (t->fds_len > 1){
1034     int success = GNUNET_YES;
1035     for (int i = 0; i < t->fds_len;i++){
1036       success = driver_func(scheduler_driver->cls, t , t->fds+i) && success;
1037     }
1038     return success;
1039   }else{
1040     return driver_func(scheduler_driver->cls, t , t->fds);
1041   }
1042 }
1043
1044
1045 /**
1046  * Cancel the task with the specified identifier.
1047  * The task must not yet have run.
1048  *
1049  * @param task id of the task to cancel
1050  * @return original closure of the task
1051  */
1052 void *
1053 GNUNET_SCHEDULER_cancel (struct GNUNET_SCHEDULER_Task *task)
1054 {
1055   enum GNUNET_SCHEDULER_Priority p;
1056   void *ret;
1057
1058   GNUNET_assert ( (NULL != active_task) ||
1059       (GNUNET_NO == task->lifeness) );
1060   if (! task->in_ready_list)
1061   {
1062     if ( (-1 == task->read_fd) &&
1063          (-1 == task->write_fd) &&
1064          (NULL == task->read_set) &&
1065          (NULL == task->write_set) )
1066     {
1067       if (GNUNET_YES == task->on_shutdown)
1068   GNUNET_CONTAINER_DLL_remove (shutdown_head,
1069              shutdown_tail,
1070              task);
1071       else
1072   GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
1073              pending_timeout_tail,
1074              task);
1075       scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
1076       if (task == pending_timeout_last)
1077         pending_timeout_last = NULL;
1078     }
1079     else
1080     {
1081       GNUNET_CONTAINER_DLL_remove (pending_head,
1082                                    pending_tail,
1083                                    task);
1084       scheduler_multi_function_call(task, scheduler_driver->del);
1085     }
1086   }
1087   else
1088   {
1089     p = check_priority (task->priority);
1090     GNUNET_CONTAINER_DLL_remove (ready_head[p],
1091                                  ready_tail[p],
1092                                  task);
1093     ready_count--;
1094   }
1095   ret = task->callback_cls;
1096   LOG (GNUNET_ERROR_TYPE_DEBUG,
1097        "Canceling task %p\n",
1098        task);
1099   destroy_task (task);
1100   return ret;
1101 }
1102
1103
1104 /**
1105  * Initialize backtrace data for task @a t
1106  *
1107  * @param t task to initialize
1108  */
1109 static void
1110 init_backtrace (struct GNUNET_SCHEDULER_Task *t)
1111 {
1112 #if EXECINFO
1113   void *backtrace_array[MAX_TRACE_DEPTH];
1114
1115   t->num_backtrace_strings
1116     = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1117   t->backtrace_strings =
1118       backtrace_symbols (backtrace_array,
1119        t->num_backtrace_strings);
1120   dump_backtrace (t);
1121 #endif
1122 }
1123
1124
1125 /**
1126  * Continue the current execution with the given function.  This is
1127  * similar to the other "add" functions except that there is no delay
1128  * and the reason code can be specified.
1129  *
1130  * @param task main function of the task
1131  * @param task_cls closure for @a task
1132  * @param reason reason for task invocation
1133  * @param priority priority to use for the task
1134  */
1135 void
1136 GNUNET_SCHEDULER_add_with_reason_and_priority (GNUNET_SCHEDULER_TaskCallback task,
1137                                                void *task_cls,
1138                                                enum GNUNET_SCHEDULER_Reason reason,
1139                                                enum GNUNET_SCHEDULER_Priority priority)
1140 {
1141   struct GNUNET_SCHEDULER_Task *t;
1142
1143   GNUNET_assert (NULL != task);
1144   GNUNET_assert ((NULL != active_task) ||
1145                  (GNUNET_SCHEDULER_REASON_STARTUP == reason));
1146   t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1147   t->read_fd = -1;
1148   t->write_fd = -1;
1149   t->callback = task;
1150   t->callback_cls = task_cls;
1151 #if PROFILE_DELAYS
1152   t->start_time = GNUNET_TIME_absolute_get ();
1153 #endif
1154   t->reason = reason;
1155   t->priority = priority;
1156   t->lifeness = current_lifeness;
1157   LOG (GNUNET_ERROR_TYPE_DEBUG,
1158        "Adding continuation task %p\n",
1159        t);
1160   init_backtrace (t);
1161   queue_ready_task (t);
1162 }
1163
1164
1165 /**
1166  * Schedule a new task to be run at the specified time.  The task
1167  * will be scheduled for execution at time @a at.
1168  *
1169  * @param at time when the operation should run
1170  * @param priority priority to use for the task
1171  * @param task main function of the task
1172  * @param task_cls closure of @a task
1173  * @return unique task identifier for the job
1174  *         only valid until @a task is started!
1175  */
1176 struct GNUNET_SCHEDULER_Task *
1177 GNUNET_SCHEDULER_add_at_with_priority (struct GNUNET_TIME_Absolute at,
1178                                        enum GNUNET_SCHEDULER_Priority priority,
1179                                        GNUNET_SCHEDULER_TaskCallback task,
1180                                        void *task_cls)
1181 {
1182   struct GNUNET_SCHEDULER_Task *t;
1183   struct GNUNET_SCHEDULER_Task *pos;
1184   struct GNUNET_SCHEDULER_Task *prev;
1185
1186   GNUNET_assert (NULL != active_task);
1187   GNUNET_assert (NULL != task);
1188   t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1189   t->callback = task;
1190   t->callback_cls = task_cls;
1191   t->read_fd = -1;
1192   t->write_fd = -1;
1193 #if PROFILE_DELAYS
1194   t->start_time = GNUNET_TIME_absolute_get ();
1195 #endif
1196   t->timeout = at;
1197   t->priority = priority;
1198   t->lifeness = current_lifeness;
1199   /* try tail first (optimization in case we are
1200    * appending to a long list of tasks with timeouts) */
1201   if ( (NULL == pending_timeout_head) ||
1202        (at.abs_value_us < pending_timeout_head->timeout.abs_value_us) )
1203   {
1204     GNUNET_CONTAINER_DLL_insert (pending_timeout_head,
1205                                  pending_timeout_tail,
1206                                  t);
1207     scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
1208   }
1209   else
1210   {
1211     /* first move from heuristic start backwards to before start time */
1212     prev = pending_timeout_last;
1213     while ( (NULL != prev) &&
1214             (prev->timeout.abs_value_us > t->timeout.abs_value_us) )
1215       prev = prev->prev;
1216     /* now, move from heuristic start (or head of list) forward to insertion point */
1217     if (NULL == prev)
1218       pos = pending_timeout_head;
1219     else
1220       pos = prev->next;
1221     while ( (NULL != pos) &&
1222             ( (pos->timeout.abs_value_us <= t->timeout.abs_value_us) ||
1223               (0 != pos->reason) ) )
1224     {
1225       prev = pos;
1226       pos = pos->next;
1227     }
1228     GNUNET_CONTAINER_DLL_insert_after (pending_timeout_head,
1229                                        pending_timeout_tail,
1230                                        prev,
1231                                        t);
1232   }
1233   /* finally, update heuristic insertion point to last insertion... */
1234   pending_timeout_last = t;
1235
1236   LOG (GNUNET_ERROR_TYPE_DEBUG,
1237        "Adding task: %p\n",
1238        t);
1239   init_backtrace (t);
1240   return t;
1241 }
1242
1243
1244 /**
1245  * Schedule a new task to be run with a specified delay.  The task
1246  * will be scheduled for execution once the delay has expired.
1247  *
1248  * @param delay when should this operation time out?
1249  * @param priority priority to use for the task
1250  * @param task main function of the task
1251  * @param task_cls closure of @a task
1252  * @return unique task identifier for the job
1253  *         only valid until @a task is started!
1254  */
1255 struct GNUNET_SCHEDULER_Task *
1256 GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
1257               enum GNUNET_SCHEDULER_Priority priority,
1258               GNUNET_SCHEDULER_TaskCallback task,
1259                                             void *task_cls)
1260 {
1261   return GNUNET_SCHEDULER_add_at_with_priority (GNUNET_TIME_relative_to_absolute (delay),
1262                                                 priority,
1263                                                 task,
1264                                                 task_cls);
1265 }
1266
1267
1268 /**
1269  * Schedule a new task to be run with a specified priority.
1270  *
1271  * @param prio how important is the new task?
1272  * @param task main function of the task
1273  * @param task_cls closure of @a task
1274  * @return unique task identifier for the job
1275  *         only valid until @a task is started!
1276  */
1277 struct GNUNET_SCHEDULER_Task *
1278 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
1279                                     GNUNET_SCHEDULER_TaskCallback task,
1280                                     void *task_cls)
1281 {
1282   return GNUNET_SCHEDULER_add_delayed_with_priority (GNUNET_TIME_UNIT_ZERO,
1283                                                      prio,
1284                                                      task,
1285                                                      task_cls);
1286 }
1287
1288
1289 /**
1290  * Schedule a new task to be run at the specified time.  The task
1291  * will be scheduled for execution once specified time has been
1292  * reached. It will be run with the DEFAULT priority.
1293  *
1294  * @param at time at which this operation should run
1295  * @param task main function of the task
1296  * @param task_cls closure of @a task
1297  * @return unique task identifier for the job
1298  *         only valid until @a task is started!
1299  */
1300 struct GNUNET_SCHEDULER_Task *
1301 GNUNET_SCHEDULER_add_at (struct GNUNET_TIME_Absolute at,
1302                          GNUNET_SCHEDULER_TaskCallback task,
1303                          void *task_cls)
1304 {
1305   return GNUNET_SCHEDULER_add_at_with_priority (at,
1306                                                 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1307                                                 task,
1308                                                 task_cls);
1309 }
1310
1311
1312 /**
1313  * Schedule a new task to be run with a specified delay.  The task
1314  * will be scheduled for execution once the delay has expired. It
1315  * will be run with the DEFAULT priority.
1316  *
1317  * @param delay when should this operation time out?
1318  * @param task main function of the task
1319  * @param task_cls closure of @a task
1320  * @return unique task identifier for the job
1321  *         only valid until @a task is started!
1322  */
1323 struct GNUNET_SCHEDULER_Task *
1324 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
1325                               GNUNET_SCHEDULER_TaskCallback task,
1326             void *task_cls)
1327 {
1328   return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
1329                  GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1330                  task,
1331                                                      task_cls);
1332 }
1333
1334
1335 /**
1336  * Schedule a new task to be run as soon as possible.  Note that this
1337  * does not guarantee that this will be the next task that is being
1338  * run, as other tasks with higher priority (or that are already ready
1339  * to run) might get to run first.  Just as with delays, clients must
1340  * not rely on any particular order of execution between tasks
1341  * scheduled concurrently.
1342  *
1343  * The task will be run with the DEFAULT priority.
1344  *
1345  * @param task main function of the task
1346  * @param task_cls closure of @a task
1347  * @return unique task identifier for the job
1348  *         only valid until @a task is started!
1349  */
1350 struct GNUNET_SCHEDULER_Task *
1351 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_TaskCallback task,
1352         void *task_cls)
1353 {
1354   return GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_ZERO,
1355                task,
1356                task_cls);
1357 }
1358
1359
1360 /**
1361  * Schedule a new task to be run on shutdown, that is when a CTRL-C
1362  * signal is received, or when #GNUNET_SCHEDULER_shutdown() is being
1363  * invoked.
1364  *
1365  * @param task main function of the task
1366  * @param task_cls closure of @a task
1367  * @return unique task identifier for the job
1368  *         only valid until @a task is started!
1369  */
1370 struct GNUNET_SCHEDULER_Task *
1371 GNUNET_SCHEDULER_add_shutdown (GNUNET_SCHEDULER_TaskCallback task,
1372              void *task_cls)
1373 {
1374   struct GNUNET_SCHEDULER_Task *t;
1375
1376   GNUNET_assert (NULL != active_task);
1377   GNUNET_assert (NULL != task);
1378   t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1379   t->callback = task;
1380   t->callback_cls = task_cls;
1381   t->read_fd = -1;
1382   t->write_fd = -1;
1383 #if PROFILE_DELAYS
1384   t->start_time = GNUNET_TIME_absolute_get ();
1385 #endif
1386   t->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1387   t->priority = GNUNET_SCHEDULER_PRIORITY_SHUTDOWN;
1388   t->on_shutdown = GNUNET_YES;
1389   t->lifeness = GNUNET_YES;
1390   GNUNET_CONTAINER_DLL_insert (shutdown_head,
1391              shutdown_tail,
1392              t);
1393   LOG (GNUNET_ERROR_TYPE_DEBUG,
1394        "Adding task: %p\n",
1395        t);
1396   init_backtrace (t);
1397   return t;
1398 }
1399
1400
1401 /**
1402  * Schedule a new task to be run as soon as possible with the
1403  * (transitive) ignore-shutdown flag either explicitly set or
1404  * explicitly enabled.  This task (and all tasks created from it,
1405  * other than by another call to this function) will either count or
1406  * not count for the "lifeness" of the process.  This API is only
1407  * useful in a few special cases.
1408  *
1409  * @param lifeness #GNUNET_YES if the task counts for lifeness, #GNUNET_NO if not.
1410  * @param task main function of the task
1411  * @param task_cls closure of @a task
1412  * @return unique task identifier for the job
1413  *         only valid until @a task is started!
1414  */
1415 struct GNUNET_SCHEDULER_Task *
1416 GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
1417                                         GNUNET_SCHEDULER_TaskCallback task,
1418                                         void *task_cls)
1419 {
1420   struct GNUNET_SCHEDULER_Task *ret;
1421
1422   ret = GNUNET_SCHEDULER_add_now (task, task_cls);
1423   ret->lifeness = lifeness;
1424   return ret;
1425 }
1426
1427
1428 /**
1429  * Schedule a new task to be run with a specified delay or when any of
1430  * the specified file descriptor sets is ready.  The delay can be used
1431  * as a timeout on the socket(s) being ready.  The task will be
1432  * scheduled for execution once either the delay has expired or any of
1433  * the socket operations is ready.  This is the most general
1434  * function of the "add" family.  Note that the "prerequisite_task"
1435  * must be satisfied in addition to any of the other conditions.  In
1436  * other words, the task will be started when
1437  * <code>
1438  * (prerequisite-run)
1439  * && (delay-ready
1440  *     || any-rs-ready
1441  *     || any-ws-ready)
1442  * </code>
1443  *
1444  * @param delay how long should we wait?
1445  * @param priority priority to use
1446  * @param rfd file descriptor we want to read (can be -1)
1447  * @param wfd file descriptors we want to write (can be -1)
1448  * @param task main function of the task
1449  * @param task_cls closure of @a task
1450  * @return unique task identifier for the job
1451  *         only valid until @a task is started!
1452  */
1453 #ifndef MINGW
1454 static struct GNUNET_SCHEDULER_Task *
1455 add_without_sets (struct GNUNET_TIME_Relative delay,
1456                   enum GNUNET_SCHEDULER_Priority priority,
1457                   const struct GNUNET_NETWORK_Handle *read_nh,
1458                   const struct GNUNET_NETWORK_Handle *write_nh,
1459                   const struct GNUNET_DISK_FileHandle *read_fh,
1460                   const struct GNUNET_DISK_FileHandle *write_fh,
1461                   //int rfd,
1462                   //int wfd,
1463                   GNUNET_SCHEDULER_TaskCallback task,
1464                   void *task_cls)
1465 {
1466   struct GNUNET_SCHEDULER_Task *t;
1467
1468   GNUNET_assert (NULL != active_task);
1469   GNUNET_assert (NULL != task);
1470   t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1471   initFdInfo (t, read_nh, write_nh, read_fh, write_fh);
1472   t->callback = task;
1473   t->callback_cls = task_cls;
1474 #if DEBUG_FDS
1475   if (-1 != rfd)
1476   {
1477     int flags = fcntl (rfd, F_GETFD);
1478
1479     if ((flags == -1) && (errno == EBADF))
1480     {
1481       LOG (GNUNET_ERROR_TYPE_ERROR,
1482            "Got invalid file descriptor %d!\n",
1483            rfd);
1484       init_backtrace (t);
1485       GNUNET_assert (0);
1486     }
1487   }
1488   if (-1 != wfd)
1489   {
1490     int flags = fcntl (wfd, F_GETFD);
1491
1492     if (flags == -1 && errno == EBADF)
1493     {
1494       LOG (GNUNET_ERROR_TYPE_ERROR,
1495            "Got invalid file descriptor %d!\n",
1496            wfd);
1497       init_backtrace (t);
1498       GNUNET_assert (0);
1499     }
1500   }
1501 #endif
1502
1503 #if PROFILE_DELAYS
1504   t->start_time = GNUNET_TIME_absolute_get ();
1505 #endif
1506   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1507   t->priority = check_priority ((priority == GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority : priority);
1508   t->lifeness = current_lifeness;
1509   GNUNET_CONTAINER_DLL_insert (pending_head,
1510                                pending_tail,
1511                                t);
1512   scheduler_multi_function_call(t, scheduler_driver->add);
1513   max_priority_added = GNUNET_MAX (max_priority_added,
1514                                    t->priority);
1515   LOG (GNUNET_ERROR_TYPE_DEBUG,
1516        "Adding task %p\n",
1517        t);
1518   init_backtrace (t);
1519   return t;
1520 }
1521 #endif
1522
1523
1524 /**
1525  * Schedule a new task to be run with a specified delay or when the
1526  * specified file descriptor is ready for reading.  The delay can be
1527  * used as a timeout on the socket being ready.  The task will be
1528  * scheduled for execution once either the delay has expired or the
1529  * socket operation is ready.  It will be run with the DEFAULT priority.
1530  *
1531  * @param delay when should this operation time out?
1532  * @param rfd read file-descriptor
1533  * @param task main function of the task
1534  * @param task_cls closure of @a task
1535  * @return unique task identifier for the job
1536  *         only valid until @a task is started!
1537  */
1538 struct GNUNET_SCHEDULER_Task *
1539 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
1540                                struct GNUNET_NETWORK_Handle *rfd,
1541                                GNUNET_SCHEDULER_TaskCallback task,
1542                                void *task_cls)
1543 {
1544   return GNUNET_SCHEDULER_add_read_net_with_priority (delay,
1545                   GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1546                   rfd, task, task_cls);
1547 }
1548
1549
1550 /**
1551  * Schedule a new task to be run with a specified priority and to be
1552  * run after the specified delay or when the specified file descriptor
1553  * is ready for reading.  The delay can be used as a timeout on the
1554  * socket being ready.  The task will be scheduled for execution once
1555  * either the delay has expired or the socket operation is ready.  It
1556  * will be run with the DEFAULT priority.
1557  *
1558  * @param delay when should this operation time out?
1559  * @param priority priority to use for the task
1560  * @param rfd read file-descriptor
1561  * @param task main function of the task
1562  * @param task_cls closure of @a task
1563  * @return unique task identifier for the job
1564  *         only valid until @a task is started!
1565  */
1566 struct GNUNET_SCHEDULER_Task *
1567 GNUNET_SCHEDULER_add_read_net_with_priority (struct GNUNET_TIME_Relative delay,
1568                enum GNUNET_SCHEDULER_Priority priority,
1569                struct GNUNET_NETWORK_Handle *rfd,
1570                GNUNET_SCHEDULER_TaskCallback task,
1571                                              void *task_cls)
1572 {
1573   return GNUNET_SCHEDULER_add_net_with_priority (delay, priority,
1574                                                  rfd,
1575                                                  GNUNET_YES,
1576                                                  GNUNET_NO,
1577                                                  task, task_cls);
1578 }
1579
1580
1581 /**
1582  * Schedule a new task to be run with a specified delay or when the
1583  * specified file descriptor is ready for writing.  The delay can be
1584  * used as a timeout on the socket being ready.  The task will be
1585  * scheduled for execution once either the delay has expired or the
1586  * socket operation is ready.  It will be run with the priority of
1587  * the calling task.
1588  *
1589  * @param delay when should this operation time out?
1590  * @param wfd write file-descriptor
1591  * @param task main function of the task
1592  * @param task_cls closure of @a task
1593  * @return unique task identifier for the job
1594  *         only valid until @a task is started!
1595  */
1596 struct GNUNET_SCHEDULER_Task *
1597 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
1598                                 struct GNUNET_NETWORK_Handle *wfd,
1599                                 GNUNET_SCHEDULER_TaskCallback task,
1600                                 void *task_cls)
1601 {
1602   return GNUNET_SCHEDULER_add_net_with_priority (delay,
1603                                                  GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1604                                                  wfd,
1605                                                  GNUNET_NO, GNUNET_YES,
1606                                                  task, task_cls);
1607 }
1608
1609 /**
1610  * Schedule a new task to be run with a specified delay or when the
1611  * specified file descriptor is ready.  The delay can be
1612  * used as a timeout on the socket being ready.  The task will be
1613  * scheduled for execution once either the delay has expired or the
1614  * socket operation is ready.
1615  *
1616  * @param delay when should this operation time out?
1617  * @param priority priority of the task
1618  * @param fd file-descriptor
1619  * @param on_read whether to poll the file-descriptor for readability
1620  * @param on_write whether to poll the file-descriptor for writability
1621  * @param task main function of the task
1622  * @param task_cls closure of task
1623  * @return unique task identifier for the job
1624  *         only valid until "task" is started!
1625  */
1626 struct GNUNET_SCHEDULER_Task *
1627 GNUNET_SCHEDULER_add_net_with_priority  (struct GNUNET_TIME_Relative delay,
1628                                          enum GNUNET_SCHEDULER_Priority priority,
1629                                          struct GNUNET_NETWORK_Handle *fd,
1630                                          int on_read,
1631                                          int on_write,
1632                                          GNUNET_SCHEDULER_TaskCallback task,
1633                                          void *task_cls)
1634 {
1635 #if MINGW
1636   struct GNUNET_NETWORK_FDSet *s;
1637   struct GNUNET_SCHEDULER_Task * ret;
1638
1639   GNUNET_assert (NULL != fd);
1640   s = GNUNET_NETWORK_fdset_create ();
1641   GNUNET_NETWORK_fdset_set (s, fd);
1642   ret = GNUNET_SCHEDULER_add_select (
1643       priority, delay,
1644       on_read  ? s : NULL,
1645       on_write ? s : NULL,
1646       task, task_cls);
1647   GNUNET_NETWORK_fdset_destroy (s);
1648   return ret;
1649 #else
1650   GNUNET_assert (on_read || on_write);
1651   GNUNET_assert (GNUNET_NETWORK_get_fd (fd) >= 0);
1652   return add_without_sets (delay, priority,
1653                            on_read  ? fd : NULL,
1654                            on_write ? fd : NULL,
1655                            NULL,
1656                            NULL,
1657                            task, task_cls);
1658 #endif
1659 }
1660
1661
1662 /**
1663  * Schedule a new task to be run with a specified delay or when the
1664  * specified file descriptor is ready for reading.  The delay can be
1665  * used as a timeout on the socket being ready.  The task will be
1666  * scheduled for execution once either the delay has expired or the
1667  * socket operation is ready. It will be run with the DEFAULT priority.
1668  *
1669  * @param delay when should this operation time out?
1670  * @param rfd read file-descriptor
1671  * @param task main function of the task
1672  * @param task_cls closure of @a task
1673  * @return unique task identifier for the job
1674  *         only valid until @a task is started!
1675  */
1676 struct GNUNET_SCHEDULER_Task *
1677 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
1678                                 const struct GNUNET_DISK_FileHandle *rfd,
1679                                 GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
1680 {
1681   return GNUNET_SCHEDULER_add_file_with_priority (
1682       delay, GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1683       rfd, GNUNET_YES, GNUNET_NO,
1684       task, task_cls);
1685 }
1686
1687
1688 /**
1689  * Schedule a new task to be run with a specified delay or when the
1690  * specified file descriptor is ready for writing.  The delay can be
1691  * used as a timeout on the socket being ready.  The task will be
1692  * scheduled for execution once either the delay has expired or the
1693  * socket operation is ready. It will be run with the DEFAULT priority.
1694  *
1695  * @param delay when should this operation time out?
1696  * @param wfd write file-descriptor
1697  * @param task main function of the task
1698  * @param task_cls closure of @a task
1699  * @return unique task identifier for the job
1700  *         only valid until @a task is started!
1701  */
1702 struct GNUNET_SCHEDULER_Task *
1703 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
1704                                  const struct GNUNET_DISK_FileHandle *wfd,
1705                                  GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
1706 {
1707   return GNUNET_SCHEDULER_add_file_with_priority (
1708       delay, GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1709       wfd, GNUNET_NO, GNUNET_YES,
1710       task, task_cls);
1711 }
1712
1713
1714 /**
1715  * Schedule a new task to be run with a specified delay or when the
1716  * specified file descriptor is ready.  The delay can be
1717  * used as a timeout on the socket being ready.  The task will be
1718  * scheduled for execution once either the delay has expired or the
1719  * socket operation is ready.
1720  *
1721  * @param delay when should this operation time out?
1722  * @param priority priority of the task
1723  * @param fd file-descriptor
1724  * @param on_read whether to poll the file-descriptor for readability
1725  * @param on_write whether to poll the file-descriptor for writability
1726  * @param task main function of the task
1727  * @param task_cls closure of @a task
1728  * @return unique task identifier for the job
1729  *         only valid until @a task is started!
1730  */
1731 struct GNUNET_SCHEDULER_Task *
1732 GNUNET_SCHEDULER_add_file_with_priority (struct GNUNET_TIME_Relative delay,
1733                                          enum GNUNET_SCHEDULER_Priority priority,
1734                                          const struct GNUNET_DISK_FileHandle *fd,
1735                                          int on_read, int on_write,
1736                                          GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
1737 {
1738 #if MINGW
1739   struct GNUNET_NETWORK_FDSet *s;
1740   struct GNUNET_SCHEDULER_Task * ret;
1741
1742   GNUNET_assert (NULL != fd);
1743   s = GNUNET_NETWORK_fdset_create ();
1744   GNUNET_NETWORK_fdset_handle_set (s, fd);
1745   ret = GNUNET_SCHEDULER_add_select (
1746       priority, delay,
1747       on_read  ? s : NULL,
1748       on_write ? s : NULL,
1749       task, task_cls);
1750   GNUNET_NETWORK_fdset_destroy (s);
1751   return ret;
1752 #else
1753   GNUNET_assert (on_read || on_write);
1754   GNUNET_assert(fd->fd >= 0);
1755   return add_without_sets (delay, priority,
1756                            NULL,
1757                            NULL,
1758                            on_read ? fd : NULL,
1759                            on_write ? fd : NULL,
1760                            task, task_cls);
1761 #endif
1762 }
1763
1764
1765 /**
1766  * Schedule a new task to be run with a specified delay or when any of
1767  * the specified file descriptor sets is ready.  The delay can be used
1768  * as a timeout on the socket(s) being ready.  The task will be
1769  * scheduled for execution once either the delay has expired or any of
1770  * the socket operations is ready.  This is the most general
1771  * function of the "add" family.  Note that the "prerequisite_task"
1772  * must be satisfied in addition to any of the other conditions.  In
1773  * other words, the task will be started when
1774  * <code>
1775  * (prerequisite-run)
1776  * && (delay-ready
1777  *     || any-rs-ready
1778  *     || any-ws-ready) )
1779  * </code>
1780  *
1781  * @param prio how important is this task?
1782  * @param delay how long should we wait?
1783  * @param rs set of file descriptors we want to read (can be NULL)
1784  * @param ws set of file descriptors we want to write (can be NULL)
1785  * @param task main function of the task
1786  * @param task_cls closure of @a task
1787  * @return unique task identifier for the job
1788  *         only valid until @a task is started!
1789  */
1790 struct GNUNET_SCHEDULER_Task *
1791 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
1792                              struct GNUNET_TIME_Relative delay,
1793                              const struct GNUNET_NETWORK_FDSet *rs,
1794                              const struct GNUNET_NETWORK_FDSet *ws,
1795                              GNUNET_SCHEDULER_TaskCallback task,
1796                              void *task_cls)
1797 {
1798   struct GNUNET_SCHEDULER_Task *t;
1799
1800   if ( (NULL == rs) &&
1801        (NULL == ws) )
1802     return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
1803                                                        prio,
1804                                                        task,
1805                                                        task_cls);
1806   GNUNET_assert (NULL != active_task);
1807   GNUNET_assert (NULL != task);
1808   t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1809   t->callback = task;
1810   t->callback_cls = task_cls;
1811   t->read_fd = -1;
1812   t->write_fd = -1;
1813   if (NULL != rs)
1814   {
1815     t->read_set = GNUNET_NETWORK_fdset_create ();
1816     GNUNET_NETWORK_fdset_copy (t->read_set, rs);
1817   }
1818   if (NULL != ws)
1819   {
1820     t->write_set = GNUNET_NETWORK_fdset_create ();
1821     GNUNET_NETWORK_fdset_copy (t->write_set, ws);
1822   }
1823 #if PROFILE_DELAYS
1824   t->start_time = GNUNET_TIME_absolute_get ();
1825 #endif
1826   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1827   t->priority =
1828       check_priority ((prio ==
1829                        GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority :
1830                       prio);
1831   t->lifeness = current_lifeness;
1832   GNUNET_CONTAINER_DLL_insert (pending_head,
1833                                pending_tail,
1834                                t);
1835   scheduler_multi_function_call(t, scheduler_driver->add);
1836   max_priority_added = GNUNET_MAX (max_priority_added,
1837            t->priority);
1838   LOG (GNUNET_ERROR_TYPE_DEBUG,
1839        "Adding task %p\n",
1840        t);
1841   init_backtrace (t);
1842   return t;
1843 }
1844
1845
1846 /**
1847  * Function used by event-loop implementations to signal the scheduler
1848  * that a particular @a task is ready due to an event of type @a et.
1849  *
1850  * This function will then queue the task to notify the application
1851  * that the task is ready (with the respective priority).
1852  *
1853  * @param task the task that is ready, NULL for wake up calls
1854  * @param et information about why the task is ready
1855  */
1856 void
1857 GNUNET_SCHEDULER_task_ready (struct GNUNET_SCHEDULER_Task *task,
1858            enum GNUNET_SCHEDULER_EventType et)
1859 {
1860   enum GNUNET_SCHEDULER_Reason reason;
1861   struct GNUNET_TIME_Absolute now;
1862
1863   now = GNUNET_TIME_absolute_get ();
1864   reason = task->reason;
1865   if (now.abs_value_us >= task->timeout.abs_value_us)
1866     reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
1867   if ( (0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
1868        (0 != (GNUNET_SCHEDULER_ET_IN & et)) )
1869     reason |= GNUNET_SCHEDULER_REASON_READ_READY;
1870   if ( (0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
1871        (0 != (GNUNET_SCHEDULER_ET_OUT & et)) )
1872     reason |= GNUNET_SCHEDULER_REASON_WRITE_READY;
1873   reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;
1874   task->reason = reason;
1875   task->fds = &task->fdx;
1876   task->fdx.et = et;
1877   task->fds_len = 1;
1878   queue_ready_task (task);
1879 }
1880
1881
1882 /**
1883  * Function called by the driver to tell the scheduler to run some of
1884  * the tasks that are ready.  This function may return even though
1885  * there are tasks left to run just to give other tasks a chance as
1886  * well.  If we return #GNUNET_YES, the driver should call this
1887  * function again as soon as possible, while if we return #GNUNET_NO
1888  * it must block until the operating system has more work as the
1889  * scheduler has no more work to do right now.
1890  *
1891  * @param sh scheduler handle that was given to the `loop`
1892  * @return #GNUNET_OK if there are more tasks that are ready,
1893  *          and thus we would like to run more (yield to avoid
1894  *          blocking other activities for too long)
1895  *         #GNUNET_NO if we are done running tasks (yield to block)
1896  *         #GNUNET_SYSERR on error
1897  */
1898 int
1899 GNUNET_SCHEDULER_run_from_driver (struct GNUNET_SCHEDULER_Handle *sh)
1900 {
1901   enum GNUNET_SCHEDULER_Priority p;
1902   struct GNUNET_SCHEDULER_Task *pos;
1903   struct GNUNET_TIME_Absolute now;
1904
1905   /* check for tasks that reached the timeout! */
1906   now = GNUNET_TIME_absolute_get ();
1907   while (NULL != (pos = pending_timeout_head))
1908   {
1909     if (now.abs_value_us >= pos->timeout.abs_value_us)
1910       pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
1911     if (0 == pos->reason)
1912       break;
1913     GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
1914                                  pending_timeout_tail,
1915                                  pos);
1916     scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
1917     if (pending_timeout_last == pos)
1918       pending_timeout_last = NULL;
1919     queue_ready_task (pos);
1920   }
1921
1922   if (0 == ready_count)
1923     return GNUNET_NO;
1924
1925   /* find out which task priority level we are going to
1926      process this time */
1927   max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
1928   GNUNET_assert (NULL == ready_head[GNUNET_SCHEDULER_PRIORITY_KEEP]);
1929   /* yes, p>0 is correct, 0 is "KEEP" which should
1930    * always be an empty queue (see assertion)! */
1931   for (p = GNUNET_SCHEDULER_PRIORITY_COUNT - 1; p > 0; p--)
1932   {
1933     pos = ready_head[p];
1934     if (NULL != pos)
1935       break;
1936   }
1937   GNUNET_assert (NULL != pos);        /* ready_count wrong? */
1938
1939   /* process all tasks at this priority level, then yield */
1940   while (NULL != (pos = ready_head[p]))
1941   {
1942     GNUNET_CONTAINER_DLL_remove (ready_head[p],
1943          ready_tail[p],
1944          pos);
1945     ready_count--;
1946     current_priority = pos->priority;
1947     current_lifeness = pos->lifeness;
1948     active_task = pos;
1949 #if PROFILE_DELAYS
1950     if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
1951   DELAY_THRESHOLD.rel_value_us)
1952     {
1953       LOG (GNUNET_ERROR_TYPE_DEBUG,
1954      "Task %p took %s to be scheduled\n",
1955      pos,
1956      GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time),
1957                GNUNET_YES));
1958     }
1959 #endif
1960     tc.reason = pos->reason;
1961     GNUNET_NETWORK_fdset_zero (sh->rs);
1962     GNUNET_NETWORK_fdset_zero (sh->ws);
1963     tc.fds_len = pos->fds_len;
1964     tc.fds = pos->fds;
1965     tc.read_ready = (NULL == pos->read_set) ? sh->rs : pos->read_set;
1966     if ( (-1 != pos->read_fd) &&
1967    (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)) )
1968       GNUNET_NETWORK_fdset_set_native (sh->rs,
1969                pos->read_fd);
1970     tc.write_ready = (NULL == pos->write_set) ? sh->ws : pos->write_set;
1971     if ((-1 != pos->write_fd) &&
1972   (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)))
1973       GNUNET_NETWORK_fdset_set_native (sh->ws,
1974                pos->write_fd);
1975     LOG (GNUNET_ERROR_TYPE_DEBUG,
1976    "Running task: %p\n",
1977    pos);
1978     pos->callback (pos->callback_cls);
1979     active_task = NULL;
1980     dump_backtrace (pos);
1981     destroy_task (pos);
1982     tasks_run++;
1983   }
1984   if (0 == ready_count)
1985     return GNUNET_NO;
1986   return GNUNET_OK;
1987 }
1988
1989
1990 /**
1991  * Initialize and run scheduler.  This function will return when all
1992  * tasks have completed.  On systems with signals, receiving a SIGTERM
1993  * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown
1994  * to be run after the active task is complete.  As a result, SIGTERM
1995  * causes all shutdown tasks to be scheduled with reason
1996  * #GNUNET_SCHEDULER_REASON_SHUTDOWN.  (However, tasks added
1997  * afterwards will execute normally!).  Note that any particular
1998  * signal will only shut down one scheduler; applications should
1999  * always only create a single scheduler.
2000  *
2001  * @param driver drive to use for the event loop
2002  * @param task task to run first (and immediately)
2003  * @param task_cls closure of @a task
2004  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2005  */
2006 int
2007 GNUNET_SCHEDULER_run_with_driver (const struct GNUNET_SCHEDULER_Driver *driver,
2008           GNUNET_SCHEDULER_TaskCallback task,
2009           void *task_cls)
2010 {
2011   int ret;
2012   struct GNUNET_SCHEDULER_Handle sh;
2013   struct GNUNET_SIGNAL_Context *shc_int;
2014   struct GNUNET_SIGNAL_Context *shc_term;
2015 #if (SIGTERM != GNUNET_TERM_SIG)
2016   struct GNUNET_SIGNAL_Context *shc_gterm;
2017 #endif
2018 #ifndef MINGW
2019   struct GNUNET_SIGNAL_Context *shc_quit;
2020   struct GNUNET_SIGNAL_Context *shc_hup;
2021   struct GNUNET_SIGNAL_Context *shc_pipe;
2022 #endif
2023   struct GNUNET_SCHEDULER_Task tsk;
2024   const struct GNUNET_DISK_FileHandle *pr;
2025   scheduler_driver = driver;
2026
2027   /* general set-up */
2028   GNUNET_assert (NULL == active_task);
2029   GNUNET_assert (NULL == shutdown_pipe_handle);
2030   shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO,
2031                                            GNUNET_NO,
2032                                            GNUNET_NO,
2033                                            GNUNET_NO);
2034   GNUNET_assert (NULL != shutdown_pipe_handle);
2035   pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
2036                                 GNUNET_DISK_PIPE_END_READ);
2037   GNUNET_assert (NULL != pr);
2038   my_pid = getpid ();
2039
2040   /* install signal handlers */
2041   LOG (GNUNET_ERROR_TYPE_DEBUG,
2042        "Registering signal handlers\n");
2043   shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
2044              &sighandler_shutdown);
2045   shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
2046               &sighandler_shutdown);
2047 #if (SIGTERM != GNUNET_TERM_SIG)
2048   shc_gterm = GNUNET_SIGNAL_handler_install (GNUNET_TERM_SIG,
2049                &sighandler_shutdown);
2050 #endif
2051 #ifndef MINGW
2052   shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
2053               &sighandler_pipe);
2054   shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
2055               &sighandler_shutdown);
2056   shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
2057              &sighandler_shutdown);
2058 #endif
2059
2060   /* Setup initial tasks */
2061   current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
2062   current_lifeness = GNUNET_YES;
2063   memset (&tsk,
2064     0,
2065     sizeof (tsk));
2066   active_task = &tsk;
2067   tsk.sh = &sh;
2068   GNUNET_SCHEDULER_add_with_reason_and_priority (task,
2069                                                  task_cls,
2070                                                  GNUNET_SCHEDULER_REASON_STARTUP,
2071                                                  GNUNET_SCHEDULER_PRIORITY_DEFAULT);
2072   GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
2073                                           &GNUNET_OS_install_parent_control_handler,
2074                                           NULL);
2075   active_task = NULL;
2076   driver->set_wakeup (driver->cls,
2077           GNUNET_TIME_absolute_get ());
2078
2079   /* begin main event loop */
2080   sh.rs = GNUNET_NETWORK_fdset_create ();
2081   sh.ws = GNUNET_NETWORK_fdset_create ();
2082   GNUNET_NETWORK_fdset_handle_set (sh.rs, pr);
2083   sh.driver = driver;
2084   ret = driver->loop (driver->cls,
2085           &sh);
2086   GNUNET_NETWORK_fdset_destroy (sh.rs);
2087   GNUNET_NETWORK_fdset_destroy (sh.ws);
2088
2089   /* uninstall signal handlers */
2090   GNUNET_SIGNAL_handler_uninstall (shc_int);
2091   GNUNET_SIGNAL_handler_uninstall (shc_term);
2092 #if (SIGTERM != GNUNET_TERM_SIG)
2093   GNUNET_SIGNAL_handler_uninstall (shc_gterm);
2094 #endif
2095 #ifndef MINGW
2096   GNUNET_SIGNAL_handler_uninstall (shc_pipe);
2097   GNUNET_SIGNAL_handler_uninstall (shc_quit);
2098   GNUNET_SIGNAL_handler_uninstall (shc_hup);
2099 #endif
2100   GNUNET_DISK_pipe_close (shutdown_pipe_handle);
2101   shutdown_pipe_handle = NULL;
2102   return ret;
2103 }
2104
2105 int
2106 select_add(void *cls,
2107            struct GNUNET_SCHEDULER_Task *task,
2108            struct GNUNET_SCHEDULER_FdInfo *fdi)
2109 {
2110   return GNUNET_OK;
2111 }
2112
2113
2114 int
2115 select_del(void *cls,
2116            struct GNUNET_SCHEDULER_Task *task,
2117            struct GNUNET_SCHEDULER_FdInfo *fdi)
2118 {
2119   return GNUNET_OK;
2120 }
2121
2122
2123 int
2124 select_loop(void *cls,
2125             struct GNUNET_SCHEDULER_Handle *sh)
2126 {
2127   return while_live(sh->rs, sh->ws);
2128 }
2129
2130
2131 static void
2132 select_set_wakeup(void *cls,
2133                   struct GNUNET_TIME_Absolute dt)
2134 {
2135
2136 }
2137
2138
2139 /**
2140  * Obtain the driver for using select() as the event loop.
2141  *
2142  * @return NULL on error
2143  */
2144 const struct GNUNET_SCHEDULER_Driver *
2145 GNUNET_SCHEDULER_driver_select ()
2146 {
2147
2148   struct GNUNET_SCHEDULER_Driver *select_driver;
2149
2150   select_driver = GNUNET_new (struct GNUNET_SCHEDULER_Driver);
2151
2152   select_driver->loop = &select_loop;
2153   select_driver->add = &select_add;
2154   select_driver->del = &select_del;
2155   select_driver->set_wakeup = &select_set_wakeup;
2156
2157
2158   return select_driver;
2159 }
2160
2161
2162 /* end of scheduler.c */