2 This file is part of GNUnet
3 Copyright (C) 2009-2017 GNUnet e.V.
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.
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.
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.
21 * @file util/scheduler.c
22 * @brief schedule computations using continuation passing style
23 * @author Christian Grothoff
26 #include "gnunet_util_lib.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "util-scheduler", __VA_ARGS__)
31 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util-scheduler", syscall)
38 * Use lsof to generate file descriptor reports on select error?
39 * (turn off for stable releases).
41 #define USE_LSOF GNUNET_NO
44 * Obtain trace information for all scheduler calls that schedule tasks.
46 #define EXECINFO GNUNET_NO
49 * Check each file descriptor before adding
51 #define DEBUG_FDS GNUNET_NO
54 * Depth of the traces collected via EXECINFO.
56 #define MAX_TRACE_DEPTH 50
60 * Should we figure out which tasks are delayed for a while
61 * before they are run? (Consider using in combination with EXECINFO).
63 #define PROFILE_DELAYS GNUNET_NO
66 * Task that were in the queue for longer than this are reported if
67 * PROFILE_DELAYS is active.
69 #define DELAY_THRESHOLD GNUNET_TIME_UNIT_SECONDS
73 * Argument to be passed from the driver to
74 * #GNUNET_SCHEDULER_run_from_driver(). Contains the
75 * scheduler's internal state.
77 struct GNUNET_SCHEDULER_Handle
80 * Passed here to avoid constantly allocating/deallocating
81 * this element, but generally we want to get rid of this.
84 struct GNUNET_NETWORK_FDSet *rs;
87 * Passed here to avoid constantly allocating/deallocating
88 * this element, but generally we want to get rid of this.
91 struct GNUNET_NETWORK_FDSet *ws;
94 * Driver we used for the event loop.
96 const struct GNUNET_SCHEDULER_Driver *driver;
102 * Entry in list of pending tasks.
104 struct GNUNET_SCHEDULER_Task
107 * This is a linked list.
109 struct GNUNET_SCHEDULER_Task *next;
112 * This is a linked list.
114 struct GNUNET_SCHEDULER_Task *prev;
117 * Function to run when ready.
119 GNUNET_SCHEDULER_TaskCallback callback;
122 * Closure for the @e callback.
127 * Handle to the scheduler's state.
129 const struct GNUNET_SCHEDULER_Handle *sh;
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
137 struct GNUNET_NETWORK_FDSet *read_set;
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.
144 struct GNUNET_NETWORK_FDSet *write_set;
147 * Information about which FDs are ready for this task (and why).
149 const struct GNUNET_SCHEDULER_FdInfo *fds;
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.
156 struct GNUNET_SCHEDULER_FdInfo fdx;
159 * Absolute timeout value for the task, or
160 * #GNUNET_TIME_UNIT_FOREVER_ABS for "no timeout".
162 struct GNUNET_TIME_Absolute timeout;
166 * When was the task scheduled?
168 struct GNUNET_TIME_Absolute start_time;
172 * Size of the @e fds array.
174 unsigned int fds_len;
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.
181 enum GNUNET_SCHEDULER_Reason reason;
186 enum GNUNET_SCHEDULER_Priority priority;
189 * Set if we only wait for reading from a single FD, otherwise -1.
194 * Set if we only wait for writing to a single FD, otherwise -1.
199 * Should the existence of this task in the queue be counted as
200 * reason to not shutdown the scheduler?
205 * Is this task run on shutdown?
210 * Is this task in the ready list?
216 * Array of strings which make up a backtrace from the point when this
217 * task was scheduled (essentially, who scheduled the task?)
219 char **backtrace_strings;
222 * Size of the backtrace_strings array
224 int num_backtrace_strings;
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().
237 static const struct GNUNET_SCHEDULER_Driver *scheduler_driver;
240 * Head of list of tasks waiting for an event.
242 static struct GNUNET_SCHEDULER_Task *pending_head;
245 * Tail of list of tasks waiting for an event.
247 static struct GNUNET_SCHEDULER_Task *pending_tail;
250 * Head of list of tasks waiting for shutdown.
252 static struct GNUNET_SCHEDULER_Task *shutdown_head;
255 * Tail of list of tasks waiting for shutdown.
257 static struct GNUNET_SCHEDULER_Task *shutdown_tail;
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).
266 static struct GNUNET_SCHEDULER_Task *pending_timeout_head;
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).
275 static struct GNUNET_SCHEDULER_Task *pending_timeout_tail;
278 * Last inserted task waiting ONLY for a timeout event.
279 * Used to (heuristically) speed up insertion.
281 static struct GNUNET_SCHEDULER_Task *pending_timeout_last;
284 * ID of the task that is running right now.
286 static struct GNUNET_SCHEDULER_Task *active_task;
289 * Head of list of tasks ready to run right now, grouped by importance.
291 static struct GNUNET_SCHEDULER_Task *ready_head[GNUNET_SCHEDULER_PRIORITY_COUNT];
294 * Tail of list of tasks ready to run right now, grouped by importance.
296 static struct GNUNET_SCHEDULER_Task *ready_tail[GNUNET_SCHEDULER_PRIORITY_COUNT];
299 * Number of tasks on the ready list.
301 static unsigned int ready_count;
304 * How many tasks have we run so far?
306 static unsigned long long tasks_run;
309 * Priority of the task running right now. Only
310 * valid while a task is running.
312 static enum GNUNET_SCHEDULER_Priority current_priority;
315 * Priority of the highest task added in the current select
318 static enum GNUNET_SCHEDULER_Priority max_priority_added;
321 * Value of the 'lifeness' flag for the current task.
323 static int current_lifeness;
326 * Function to use as a select() in the scheduler.
327 * If NULL, we use GNUNET_NETWORK_socket_select().
329 static GNUNET_SCHEDULER_select scheduler_select;
332 * Task context of the current task.
334 static struct GNUNET_SCHEDULER_TaskContext tc;
337 * Closure for #scheduler_select.
339 static void *scheduler_select_cls;
343 * Sets the select function to use in the scheduler (scheduler_select).
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
350 GNUNET_SCHEDULER_set_select (GNUNET_SCHEDULER_select new_select,
351 void *new_select_cls)
353 scheduler_select = new_select;
354 scheduler_select_cls = new_select_cls;
359 * Check that the given priority is legal (and return it).
361 * @param p priority value to check
362 * @return p on success, 0 on error
364 static enum GNUNET_SCHEDULER_Priority
365 check_priority (enum GNUNET_SCHEDULER_Priority p)
367 if ((p >= 0) && (p < GNUNET_SCHEDULER_PRIORITY_COUNT))
370 return 0; /* make compiler happy */
375 * Update all sets and timeout for select.
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)
381 void getNextPendingTimeout(struct GNUNET_TIME_Relative *timeout)
384 struct GNUNET_SCHEDULER_Task *pos;
385 struct GNUNET_TIME_Absolute now;
386 struct GNUNET_TIME_Relative to;
388 now = GNUNET_TIME_absolute_get ();
389 pos = pending_timeout_head;
392 to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
393 if (timeout->rel_value_us > to.rel_value_us)
395 if (0 != pos->reason)
396 *timeout = GNUNET_TIME_UNIT_ZERO;
401 update_sets (struct GNUNET_NETWORK_FDSet *rs,
402 struct GNUNET_NETWORK_FDSet *ws,
403 struct GNUNET_TIME_Relative *timeout)
405 struct GNUNET_SCHEDULER_Task *pos;
406 struct GNUNET_TIME_Absolute now;
407 struct GNUNET_TIME_Relative to;
409 now = GNUNET_TIME_absolute_get ();
411 getNextPendingTimeout(timeout);
412 for (pos = pending_head; NULL != pos; pos = pos->next)
414 if (pos->timeout.abs_value_us != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
416 to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
417 if (timeout->rel_value_us > to.rel_value_us)
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;
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,
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
444 set_overlaps (const struct GNUNET_NETWORK_FDSet *ready,
445 struct GNUNET_NETWORK_FDSet *want)
447 if ((NULL == want) || (NULL == ready))
449 if (GNUNET_NETWORK_fdset_overlap (ready, want))
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);
461 * Check if the given task is eligible to run now.
462 * Also set the reason why it is eligible.
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.
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)
476 enum GNUNET_SCHEDULER_Reason reason;
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;
492 return GNUNET_NO; /* not ready */
493 reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;
494 task->reason = reason;
500 * Put a task that is ready for execution into the ready queue.
502 * @param task task ready for execution
505 queue_ready_task (struct GNUNET_SCHEDULER_Task *task)
507 enum GNUNET_SCHEDULER_Priority p = check_priority (task->priority);
509 GNUNET_CONTAINER_DLL_insert (ready_head[p],
512 task->in_ready_list = GNUNET_YES;
518 * Check which tasks are ready and move them
519 * to the respective ready queue.
521 * @param rs FDs ready for reading
522 * @param ws FDs ready for writing
525 check_ready (const struct GNUNET_NETWORK_FDSet *rs,
526 const struct GNUNET_NETWORK_FDSet *ws)
528 struct GNUNET_SCHEDULER_Task *pos;
529 struct GNUNET_SCHEDULER_Task *next;
530 struct GNUNET_TIME_Absolute now;
532 now = GNUNET_TIME_absolute_get ();
533 while (NULL != (pos = pending_timeout_head))
535 if (now.abs_value_us >= pos->timeout.abs_value_us)
536 pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
537 if (0 == pos->reason)
539 GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
540 pending_timeout_tail,
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);
551 if (GNUNET_YES == is_ready (pos, now, rs, ws))
553 GNUNET_CONTAINER_DLL_remove (pending_head,
556 queue_ready_task (pos);
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.
570 GNUNET_SCHEDULER_shutdown ()
572 struct GNUNET_SCHEDULER_Task *pos;
574 while (NULL != (pos = shutdown_head))
576 GNUNET_CONTAINER_DLL_remove (shutdown_head,
579 pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
580 queue_ready_task (pos);
586 * Destroy a task (release associated resources)
588 * @param t task to destroy
591 destroy_task (struct GNUNET_SCHEDULER_Task *t)
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);
598 GNUNET_free (t->backtrace_strings);
605 * Output stack trace of task @a t.
607 * @param t task to dump stack trace of
610 dump_backtrace (struct GNUNET_SCHEDULER_Task *t)
615 for (i = 0; i < t->num_backtrace_strings; i++)
616 LOG (GNUNET_ERROR_TYPE_DEBUG,
617 "Task %p trace %u: %s\n",
620 t->backtrace_strings[i]);
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.
632 * @param rs FDs ready for reading
633 * @param ws FDs ready for writing
636 run_ready (struct GNUNET_NETWORK_FDSet *rs,
637 struct GNUNET_NETWORK_FDSet *ws)
639 enum GNUNET_SCHEDULER_Priority p;
640 struct GNUNET_SCHEDULER_Task *pos;
642 max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
645 if (0 == ready_count)
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--)
656 GNUNET_assert (NULL != pos); /* ready_count wrong? */
657 GNUNET_CONTAINER_DLL_remove (ready_head[p],
661 current_priority = pos->priority;
662 current_lifeness = pos->lifeness;
665 if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
666 DELAY_THRESHOLD.rel_value_us)
668 LOG (GNUNET_ERROR_TYPE_DEBUG,
669 "Task %p took %s to be scheduled\n",
671 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time),
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",
691 pos->callback (pos->callback_cls);
692 dump_backtrace (pos);
697 while ((NULL == pending_head) || (p >= max_priority_added));
702 * Pipe used to communicate shutdown via signal.
704 static struct GNUNET_DISK_PipeHandle *shutdown_pipe_handle;
707 * Process ID of this process at the time we installed the various
713 * Signal handler called for SIGPIPE.
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
730 * @param ms how many ms to wait
733 short_wait (unsigned int ms)
735 struct GNUNET_TIME_Relative timeout;
737 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, ms);
738 (void) GNUNET_NETWORK_socket_select (NULL, NULL, NULL, timeout);
743 * Signal handler called for signals that should cause us to shutdown.
746 sighandler_shutdown ()
749 int old_errno = errno; /* backup errno */
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),
762 * Check if the system is still alive. Trigger shutdown if we
763 * have tasks, but none of them give us lifeness.
765 * @return #GNUNET_OK to continue the main loop,
771 struct GNUNET_SCHEDULER_Task *t;
775 for (t = pending_head; NULL != t; t = t->next)
776 if (t->lifeness == GNUNET_YES)
778 for (t = shutdown_head; NULL != t; t = t->next)
779 if (t->lifeness == GNUNET_YES)
781 for (t = pending_timeout_head; NULL != t; t = t->next)
782 if (t->lifeness == GNUNET_YES)
784 if (NULL != shutdown_head)
786 GNUNET_SCHEDULER_shutdown ();
794 void while_live(struct GNUNET_NETWORK_FDSet *rs, struct GNUNET_NETWORK_FDSet *ws)
797 unsigned int busy_wait_warning;
798 unsigned long long last_tr;
799 const struct GNUNET_DISK_FileHandle *pr;
801 struct GNUNET_TIME_Relative timeout;
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);
809 while (GNUNET_OK == check_lifeness ())
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);
818 /* no blocking, more work already ready! */
819 timeout = GNUNET_TIME_UNIT_ZERO;
821 if (NULL == scheduler_select)
822 ret = GNUNET_NETWORK_socket_select (rs,
827 ret = scheduler_select (scheduler_select_cls,
832 if (ret == GNUNET_SYSERR)
837 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "select");
842 snprintf (lsof, sizeof (lsof), "lsof -p %d", getpid ());
845 if (0 != system (lsof))
846 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
851 struct GNUNET_SCHEDULER_Task *t;
853 for (t = pending_head; NULL != t; t = t->next)
855 if (-1 != t->read_fd)
857 int flags = fcntl (t->read_fd, F_GETFD);
858 if ((flags == -1) && (errno == EBADF))
860 LOG (GNUNET_ERROR_TYPE_ERROR,
861 "Got invalid file descriptor %d!\n",
866 if (-1 != t->write_fd)
868 int flags = fcntl (t->write_fd, F_GETFD);
869 if ((flags == -1) && (errno == EBADF))
871 LOG (GNUNET_ERROR_TYPE_ERROR,
872 "Got invalid file descriptor %d!\n",
884 (0 == timeout.rel_value_us) &&
885 (busy_wait_warning > 16) )
887 LOG (GNUNET_ERROR_TYPE_WARNING,
888 "Looks like we're busy waiting...\n");
889 short_wait (100); /* mitigate */
891 check_ready (rs, ws);
893 if (GNUNET_NETWORK_fdset_handle_isset (rs, pr))
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 ();
900 if (last_tr == tasks_run)
908 busy_wait_warning = 0;
914 * Initialize and run scheduler. This function will return when all
915 * tasks have completed. On systems with signals, receiving a SIGTERM
916 * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown()
917 * to be run after the active task is complete. As a result, SIGTERM
918 * causes all active tasks to be scheduled with reason
919 * #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
920 * afterwards will execute normally!). Note that any particular signal
921 * will only shut down one scheduler; applications should always only
922 * create a single scheduler.
924 * @param task task to run immediately
925 * @param task_cls closure of @a task
928 GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_TaskCallback task,
931 struct GNUNET_NETWORK_FDSet *rs;
932 struct GNUNET_NETWORK_FDSet *ws;
935 struct GNUNET_SIGNAL_Context *shc_int;
936 struct GNUNET_SIGNAL_Context *shc_term;
937 #if (SIGTERM != GNUNET_TERM_SIG)
938 struct GNUNET_SIGNAL_Context *shc_gterm;
942 struct GNUNET_SIGNAL_Context *shc_quit;
943 struct GNUNET_SIGNAL_Context *shc_hup;
944 struct GNUNET_SIGNAL_Context *shc_pipe;
949 GNUNET_assert (NULL == active_task);
950 rs = GNUNET_NETWORK_fdset_create ();
951 ws = GNUNET_NETWORK_fdset_create ();
952 GNUNET_assert (NULL == shutdown_pipe_handle);
953 shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO,
957 GNUNET_assert (NULL != shutdown_pipe_handle);
960 LOG (GNUNET_ERROR_TYPE_DEBUG,
961 "Registering signal handlers\n");
962 shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
963 &sighandler_shutdown);
964 shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
965 &sighandler_shutdown);
966 #if (SIGTERM != GNUNET_TERM_SIG)
967 shc_gterm = GNUNET_SIGNAL_handler_install (GNUNET_TERM_SIG,
968 &sighandler_shutdown);
971 shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
973 shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
974 &sighandler_shutdown);
975 shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
976 &sighandler_shutdown);
978 current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
979 current_lifeness = GNUNET_YES;
980 GNUNET_SCHEDULER_add_with_reason_and_priority (task,
982 GNUNET_SCHEDULER_REASON_STARTUP,
983 GNUNET_SCHEDULER_PRIORITY_DEFAULT);
984 active_task = (void *) (long) -1; /* force passing of sanity check */
985 GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
986 &GNUNET_OS_install_parent_control_handler,
992 GNUNET_SIGNAL_handler_uninstall (shc_int);
993 GNUNET_SIGNAL_handler_uninstall (shc_term);
994 #if (SIGTERM != GNUNET_TERM_SIG)
995 GNUNET_SIGNAL_handler_uninstall (shc_gterm);
998 GNUNET_SIGNAL_handler_uninstall (shc_pipe);
999 GNUNET_SIGNAL_handler_uninstall (shc_quit);
1000 GNUNET_SIGNAL_handler_uninstall (shc_hup);
1002 GNUNET_DISK_pipe_close (shutdown_pipe_handle);
1003 shutdown_pipe_handle = NULL;
1004 GNUNET_NETWORK_fdset_destroy (rs);
1005 GNUNET_NETWORK_fdset_destroy (ws);
1010 * Obtain the task context, giving the reason why the current task was
1013 * @return current tasks' scheduler context
1015 const struct GNUNET_SCHEDULER_TaskContext *
1016 GNUNET_SCHEDULER_get_task_context ()
1018 GNUNET_assert (NULL != active_task);
1024 * Get information about the current load of this scheduler. Use this
1025 * function to determine if an elective task should be added or simply
1026 * dropped (if the decision should be made based on the number of
1027 * tasks ready to run).
1029 * @param p priority level to look at
1030 * @return number of tasks pending right now
1033 GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p)
1035 struct GNUNET_SCHEDULER_Task *pos;
1038 GNUNET_assert (NULL != active_task);
1039 if (p == GNUNET_SCHEDULER_PRIORITY_COUNT)
1041 if (p == GNUNET_SCHEDULER_PRIORITY_KEEP)
1042 p = current_priority;
1044 for (pos = ready_head[check_priority (p)]; NULL != pos; pos = pos->next)
1049 static struct GNUNET_SCHEDULER_Task*
1050 initFdInfo(const struct GNUNET_NETWORK_Handle *read_nh,
1051 const struct GNUNET_NETWORK_Handle *write_nh,
1052 const struct GNUNET_DISK_FileHandle *read_fh,
1053 const struct GNUNET_DISK_FileHandle *write_fh)
1057 struct GNUNET_SCHEDULER_Task *t;
1059 t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1061 // either only network handles or only file handles are allowed
1062 GNUNET_assert (!((NULL != read_nh || NULL != write_nh) && (NULL != read_fh || NULL != write_fh)));
1064 if (NULL != read_nh && NULL != write_nh)
1067 t->fds = GNUNET_new_array (2, struct GNUNET_SCHEDULER_FdInfo);
1068 const struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fd = read_nh, .et = GNUNET_SCHEDULER_ET_IN, .sock = GNUNET_NETWORK_get_fd (read_nh)};
1069 const struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fd = write_nh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
1071 const struct GNUNET_SCHEDULER_FdInfo array[2] = {read_fdi, write_fdi};
1074 else if (NULL != read_fh && NULL != write_fh)
1077 t->fds = GNUNET_new_array (2, struct GNUNET_SCHEDULER_FdInfo);
1078 const struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fh = read_fh, .et = GNUNET_SCHEDULER_ET_IN};
1079 const struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fh = write_fh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
1080 const struct GNUNET_SCHEDULER_FdInfo array[2] = {read_fdi, write_fdi};
1083 else if (NULL != read_nh)
1085 struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fd = read_nh, .et = GNUNET_SCHEDULER_ET_IN, .sock = GNUNET_NETWORK_get_fd (read_nh)};
1088 else if (NULL != write_nh)
1090 struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fd = write_nh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
1093 else if (NULL != read_fh)
1095 struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fh = read_fh, .et = GNUNET_SCHEDULER_ET_IN};
1098 else if (NULL != write_fh)
1100 struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fh = write_fh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
1106 * Cancel the task with the specified identifier.
1107 * The task must not yet have run.
1109 * @param task id of the task to cancel
1110 * @return original closure of the task
1113 GNUNET_SCHEDULER_cancel (struct GNUNET_SCHEDULER_Task *task)
1115 enum GNUNET_SCHEDULER_Priority p;
1118 GNUNET_assert ( (NULL != active_task) ||
1119 (GNUNET_NO == task->lifeness) );
1120 if (! task->in_ready_list)
1122 if ( (-1 == task->read_fd) &&
1123 (-1 == task->write_fd) &&
1124 (NULL == task->read_set) &&
1125 (NULL == task->write_set) )
1127 if (GNUNET_YES == task->on_shutdown)
1128 GNUNET_CONTAINER_DLL_remove (shutdown_head,
1132 GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
1133 pending_timeout_tail,
1135 scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
1136 if (task == pending_timeout_last)
1137 pending_timeout_last = NULL;
1141 scheduler_multi_function_call(task, scheduler_driver->del);
1146 p = check_priority (task->priority);
1147 GNUNET_CONTAINER_DLL_remove (ready_head[p],
1152 ret = task->callback_cls;
1153 LOG (GNUNET_ERROR_TYPE_DEBUG,
1154 "Canceling task %p\n",
1156 destroy_task (task);
1162 * Initialize backtrace data for task @a t
1164 * @param t task to initialize
1167 init_backtrace (struct GNUNET_SCHEDULER_Task *t)
1170 void *backtrace_array[MAX_TRACE_DEPTH];
1172 t->num_backtrace_strings
1173 = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1174 t->backtrace_strings =
1175 backtrace_symbols (backtrace_array,
1176 t->num_backtrace_strings);
1183 * Continue the current execution with the given function. This is
1184 * similar to the other "add" functions except that there is no delay
1185 * and the reason code can be specified.
1187 * @param task main function of the task
1188 * @param task_cls closure for @a task
1189 * @param reason reason for task invocation
1190 * @param priority priority to use for the task
1193 GNUNET_SCHEDULER_add_with_reason_and_priority (GNUNET_SCHEDULER_TaskCallback task,
1195 enum GNUNET_SCHEDULER_Reason reason,
1196 enum GNUNET_SCHEDULER_Priority priority)
1198 struct GNUNET_SCHEDULER_Task *t;
1200 GNUNET_assert (NULL != task);
1201 GNUNET_assert ((NULL != active_task) ||
1202 (GNUNET_SCHEDULER_REASON_STARTUP == reason));
1203 t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1207 t->callback_cls = task_cls;
1209 t->start_time = GNUNET_TIME_absolute_get ();
1212 t->priority = priority;
1213 t->lifeness = current_lifeness;
1214 LOG (GNUNET_ERROR_TYPE_DEBUG,
1215 "Adding continuation task %p\n",
1218 queue_ready_task (t);
1223 * Schedule a new task to be run at the specified time. The task
1224 * will be scheduled for execution at time @a at.
1226 * @param at time when the operation should run
1227 * @param priority priority to use for the task
1228 * @param task main function of the task
1229 * @param task_cls closure of @a task
1230 * @return unique task identifier for the job
1231 * only valid until @a task is started!
1233 struct GNUNET_SCHEDULER_Task *
1234 GNUNET_SCHEDULER_add_at_with_priority (struct GNUNET_TIME_Absolute at,
1235 enum GNUNET_SCHEDULER_Priority priority,
1236 GNUNET_SCHEDULER_TaskCallback task,
1239 struct GNUNET_SCHEDULER_Task *t;
1240 struct GNUNET_SCHEDULER_Task *pos;
1241 struct GNUNET_SCHEDULER_Task *prev;
1243 GNUNET_assert (NULL != active_task);
1244 GNUNET_assert (NULL != task);
1245 t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1247 t->callback_cls = task_cls;
1251 t->start_time = GNUNET_TIME_absolute_get ();
1254 t->priority = priority;
1255 t->lifeness = current_lifeness;
1256 /* try tail first (optimization in case we are
1257 * appending to a long list of tasks with timeouts) */
1258 if ( (NULL == pending_timeout_head) ||
1259 (at.abs_value_us < pending_timeout_head->timeout.abs_value_us) )
1261 GNUNET_CONTAINER_DLL_insert (pending_timeout_head,
1262 pending_timeout_tail,
1264 scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
1268 /* first move from heuristic start backwards to before start time */
1269 prev = pending_timeout_last;
1270 while ( (NULL != prev) &&
1271 (prev->timeout.abs_value_us > t->timeout.abs_value_us) )
1273 /* now, move from heuristic start (or head of list) forward to insertion point */
1275 pos = pending_timeout_head;
1278 while ( (NULL != pos) &&
1279 ( (pos->timeout.abs_value_us <= t->timeout.abs_value_us) ||
1280 (0 != pos->reason) ) )
1285 GNUNET_CONTAINER_DLL_insert_after (pending_timeout_head,
1286 pending_timeout_tail,
1290 /* finally, update heuristic insertion point to last insertion... */
1291 pending_timeout_last = t;
1293 LOG (GNUNET_ERROR_TYPE_DEBUG,
1294 "Adding task: %p\n",
1302 * Schedule a new task to be run with a specified delay. The task
1303 * will be scheduled for execution once the delay has expired.
1305 * @param delay when should this operation time out?
1306 * @param priority priority to use for the task
1307 * @param task main function of the task
1308 * @param task_cls closure of @a task
1309 * @return unique task identifier for the job
1310 * only valid until @a task is started!
1312 struct GNUNET_SCHEDULER_Task *
1313 GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
1314 enum GNUNET_SCHEDULER_Priority priority,
1315 GNUNET_SCHEDULER_TaskCallback task,
1318 return GNUNET_SCHEDULER_add_at_with_priority (GNUNET_TIME_relative_to_absolute (delay),
1326 * Schedule a new task to be run with a specified priority.
1328 * @param prio how important is the new task?
1329 * @param task main function of the task
1330 * @param task_cls closure of @a task
1331 * @return unique task identifier for the job
1332 * only valid until @a task is started!
1334 struct GNUNET_SCHEDULER_Task *
1335 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
1336 GNUNET_SCHEDULER_TaskCallback task,
1339 return GNUNET_SCHEDULER_add_delayed_with_priority (GNUNET_TIME_UNIT_ZERO,
1347 * Schedule a new task to be run at the specified time. The task
1348 * will be scheduled for execution once specified time has been
1349 * reached. It will be run with the DEFAULT priority.
1351 * @param at time at which this operation should run
1352 * @param task main function of the task
1353 * @param task_cls closure of @a task
1354 * @return unique task identifier for the job
1355 * only valid until @a task is started!
1357 struct GNUNET_SCHEDULER_Task *
1358 GNUNET_SCHEDULER_add_at (struct GNUNET_TIME_Absolute at,
1359 GNUNET_SCHEDULER_TaskCallback task,
1362 return GNUNET_SCHEDULER_add_at_with_priority (at,
1363 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1370 * Schedule a new task to be run with a specified delay. The task
1371 * will be scheduled for execution once the delay has expired. It
1372 * will be run with the DEFAULT priority.
1374 * @param delay when should this operation time out?
1375 * @param task main function of the task
1376 * @param task_cls closure of @a task
1377 * @return unique task identifier for the job
1378 * only valid until @a task is started!
1380 struct GNUNET_SCHEDULER_Task *
1381 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
1382 GNUNET_SCHEDULER_TaskCallback task,
1385 return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
1386 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1393 * Schedule a new task to be run as soon as possible. Note that this
1394 * does not guarantee that this will be the next task that is being
1395 * run, as other tasks with higher priority (or that are already ready
1396 * to run) might get to run first. Just as with delays, clients must
1397 * not rely on any particular order of execution between tasks
1398 * scheduled concurrently.
1400 * The task will be run with the DEFAULT priority.
1402 * @param task main function of the task
1403 * @param task_cls closure of @a task
1404 * @return unique task identifier for the job
1405 * only valid until @a task is started!
1407 struct GNUNET_SCHEDULER_Task *
1408 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_TaskCallback task,
1411 return GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_ZERO,
1418 * Schedule a new task to be run on shutdown, that is when a CTRL-C
1419 * signal is received, or when #GNUNET_SCHEDULER_shutdown() is being
1422 * @param task main function of the task
1423 * @param task_cls closure of @a task
1424 * @return unique task identifier for the job
1425 * only valid until @a task is started!
1427 struct GNUNET_SCHEDULER_Task *
1428 GNUNET_SCHEDULER_add_shutdown (GNUNET_SCHEDULER_TaskCallback task,
1431 struct GNUNET_SCHEDULER_Task *t;
1433 GNUNET_assert (NULL != active_task);
1434 GNUNET_assert (NULL != task);
1435 t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1437 t->callback_cls = task_cls;
1441 t->start_time = GNUNET_TIME_absolute_get ();
1443 t->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1444 t->priority = GNUNET_SCHEDULER_PRIORITY_SHUTDOWN;
1445 t->on_shutdown = GNUNET_YES;
1446 t->lifeness = GNUNET_YES;
1447 GNUNET_CONTAINER_DLL_insert (shutdown_head,
1450 LOG (GNUNET_ERROR_TYPE_DEBUG,
1451 "Adding task: %p\n",
1459 * Schedule a new task to be run as soon as possible with the
1460 * (transitive) ignore-shutdown flag either explicitly set or
1461 * explicitly enabled. This task (and all tasks created from it,
1462 * other than by another call to this function) will either count or
1463 * not count for the "lifeness" of the process. This API is only
1464 * useful in a few special cases.
1466 * @param lifeness #GNUNET_YES if the task counts for lifeness, #GNUNET_NO if not.
1467 * @param task main function of the task
1468 * @param task_cls closure of @a task
1469 * @return unique task identifier for the job
1470 * only valid until @a task is started!
1472 struct GNUNET_SCHEDULER_Task *
1473 GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
1474 GNUNET_SCHEDULER_TaskCallback task,
1477 struct GNUNET_SCHEDULER_Task *ret;
1479 ret = GNUNET_SCHEDULER_add_now (task, task_cls);
1480 ret->lifeness = lifeness;
1486 int scheduler_multi_function_call(struct GNUNET_SCHEDULER_Task *t, int (*driver_func)())
1488 if (t->fds_len > 1){
1489 int success = GNUNET_YES;
1490 for (int i = 0; i < t->fds_len;i++){
1491 success = driver_func(scheduler_driver->cls, t , t->fds+i) && success;
1495 return driver_func(scheduler_driver->cls, t , t->fds);
1500 * Schedule a new task to be run with a specified delay or when any of
1501 * the specified file descriptor sets is ready. The delay can be used
1502 * as a timeout on the socket(s) being ready. The task will be
1503 * scheduled for execution once either the delay has expired or any of
1504 * the socket operations is ready. This is the most general
1505 * function of the "add" family. Note that the "prerequisite_task"
1506 * must be satisfied in addition to any of the other conditions. In
1507 * other words, the task will be started when
1509 * (prerequisite-run)
1515 * @param delay how long should we wait?
1516 * @param priority priority to use
1517 * @param rfd file descriptor we want to read (can be -1)
1518 * @param wfd file descriptors we want to write (can be -1)
1519 * @param task main function of the task
1520 * @param task_cls closure of @a task
1521 * @return unique task identifier for the job
1522 * only valid until @a task is started!
1525 static struct GNUNET_SCHEDULER_Task *
1526 add_without_sets (struct GNUNET_TIME_Relative delay,
1527 enum GNUNET_SCHEDULER_Priority priority,
1528 const struct GNUNET_NETWORK_Handle *read_nh,
1529 const struct GNUNET_NETWORK_Handle *write_nh,
1530 const struct GNUNET_DISK_FileHandle *read_fh,
1531 const struct GNUNET_DISK_FileHandle *write_fh,
1534 GNUNET_SCHEDULER_TaskCallback task,
1537 struct GNUNET_SCHEDULER_Task *t;
1539 GNUNET_assert (NULL != active_task);
1540 GNUNET_assert (NULL != task);
1541 t= initFdInfo (read_nh, write_nh, read_fh, write_fh);
1544 t->callback_cls = task_cls;
1548 int flags = fcntl (rfd, F_GETFD);
1550 if ((flags == -1) && (errno == EBADF))
1552 LOG (GNUNET_ERROR_TYPE_ERROR,
1553 "Got invalid file descriptor %d!\n",
1561 int flags = fcntl (wfd, F_GETFD);
1563 if (flags == -1 && errno == EBADF)
1565 LOG (GNUNET_ERROR_TYPE_ERROR,
1566 "Got invalid file descriptor %d!\n",
1575 t->start_time = GNUNET_TIME_absolute_get ();
1577 t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1578 t->priority = check_priority ((priority == GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority : priority);
1579 t->lifeness = current_lifeness;
1583 scheduler_multi_function_call(t, scheduler_driver->add);
1585 max_priority_added = GNUNET_MAX (max_priority_added,
1587 LOG (GNUNET_ERROR_TYPE_DEBUG,
1597 * Schedule a new task to be run with a specified delay or when the
1598 * specified file descriptor is ready for reading. The delay can be
1599 * used as a timeout on the socket being ready. The task will be
1600 * scheduled for execution once either the delay has expired or the
1601 * socket operation is ready. It will be run with the DEFAULT priority.
1603 * @param delay when should this operation time out?
1604 * @param rfd read file-descriptor
1605 * @param task main function of the task
1606 * @param task_cls closure of @a task
1607 * @return unique task identifier for the job
1608 * only valid until @a task is started!
1610 struct GNUNET_SCHEDULER_Task *
1611 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
1612 struct GNUNET_NETWORK_Handle *rfd,
1613 GNUNET_SCHEDULER_TaskCallback task,
1616 return GNUNET_SCHEDULER_add_read_net_with_priority (delay,
1617 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1618 rfd, task, task_cls);
1623 * Schedule a new task to be run with a specified priority and to be
1624 * run after the specified delay or when the specified file descriptor
1625 * is ready for reading. The delay can be used as a timeout on the
1626 * socket being ready. The task will be scheduled for execution once
1627 * either the delay has expired or the socket operation is ready. It
1628 * will be run with the DEFAULT priority.
1630 * @param delay when should this operation time out?
1631 * @param priority priority to use for the task
1632 * @param rfd read file-descriptor
1633 * @param task main function of the task
1634 * @param task_cls closure of @a task
1635 * @return unique task identifier for the job
1636 * only valid until @a task is started!
1638 struct GNUNET_SCHEDULER_Task *
1639 GNUNET_SCHEDULER_add_read_net_with_priority (struct GNUNET_TIME_Relative delay,
1640 enum GNUNET_SCHEDULER_Priority priority,
1641 struct GNUNET_NETWORK_Handle *rfd,
1642 GNUNET_SCHEDULER_TaskCallback task,
1645 return GNUNET_SCHEDULER_add_net_with_priority (delay, priority,
1654 * Schedule a new task to be run with a specified delay or when the
1655 * specified file descriptor is ready for writing. The delay can be
1656 * used as a timeout on the socket being ready. The task will be
1657 * scheduled for execution once either the delay has expired or the
1658 * socket operation is ready. It will be run with the priority of
1661 * @param delay when should this operation time out?
1662 * @param wfd write file-descriptor
1663 * @param task main function of the task
1664 * @param task_cls closure of @a task
1665 * @return unique task identifier for the job
1666 * only valid until @a task is started!
1668 struct GNUNET_SCHEDULER_Task *
1669 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
1670 struct GNUNET_NETWORK_Handle *wfd,
1671 GNUNET_SCHEDULER_TaskCallback task,
1674 return GNUNET_SCHEDULER_add_net_with_priority (delay,
1675 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1677 GNUNET_NO, GNUNET_YES,
1682 * Schedule a new task to be run with a specified delay or when the
1683 * specified file descriptor is ready. The delay can be
1684 * used as a timeout on the socket being ready. The task will be
1685 * scheduled for execution once either the delay has expired or the
1686 * socket operation is ready.
1688 * @param delay when should this operation time out?
1689 * @param priority priority of the task
1690 * @param fd file-descriptor
1691 * @param on_read whether to poll the file-descriptor for readability
1692 * @param on_write whether to poll the file-descriptor for writability
1693 * @param task main function of the task
1694 * @param task_cls closure of task
1695 * @return unique task identifier for the job
1696 * only valid until "task" is started!
1698 struct GNUNET_SCHEDULER_Task *
1699 GNUNET_SCHEDULER_add_net_with_priority (struct GNUNET_TIME_Relative delay,
1700 enum GNUNET_SCHEDULER_Priority priority,
1701 struct GNUNET_NETWORK_Handle *fd,
1704 GNUNET_SCHEDULER_TaskCallback task,
1708 struct GNUNET_NETWORK_FDSet *s;
1709 struct GNUNET_SCHEDULER_Task * ret;
1711 GNUNET_assert (NULL != fd);
1712 s = GNUNET_NETWORK_fdset_create ();
1713 GNUNET_NETWORK_fdset_set (s, fd);
1714 ret = GNUNET_SCHEDULER_add_select (
1717 on_write ? s : NULL,
1719 GNUNET_NETWORK_fdset_destroy (s);
1722 GNUNET_assert (on_read || on_write);
1723 GNUNET_assert (GNUNET_NETWORK_get_fd (fd) >= 0);
1724 return add_without_sets (delay, priority,
1725 on_read ? fd : NULL,
1726 on_write ? fd : NULL,
1735 * Schedule a new task to be run with a specified delay or when the
1736 * specified file descriptor is ready for reading. The delay can be
1737 * used as a timeout on the socket being ready. The task will be
1738 * scheduled for execution once either the delay has expired or the
1739 * socket operation is ready. It will be run with the DEFAULT priority.
1741 * @param delay when should this operation time out?
1742 * @param rfd read file-descriptor
1743 * @param task main function of the task
1744 * @param task_cls closure of @a task
1745 * @return unique task identifier for the job
1746 * only valid until @a task is started!
1748 struct GNUNET_SCHEDULER_Task *
1749 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
1750 const struct GNUNET_DISK_FileHandle *rfd,
1751 GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
1753 return GNUNET_SCHEDULER_add_file_with_priority (
1754 delay, GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1755 rfd, GNUNET_YES, GNUNET_NO,
1761 * Schedule a new task to be run with a specified delay or when the
1762 * specified file descriptor is ready for writing. The delay can be
1763 * used as a timeout on the socket being ready. The task will be
1764 * scheduled for execution once either the delay has expired or the
1765 * socket operation is ready. It will be run with the DEFAULT priority.
1767 * @param delay when should this operation time out?
1768 * @param wfd write file-descriptor
1769 * @param task main function of the task
1770 * @param task_cls closure of @a task
1771 * @return unique task identifier for the job
1772 * only valid until @a task is started!
1774 struct GNUNET_SCHEDULER_Task *
1775 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
1776 const struct GNUNET_DISK_FileHandle *wfd,
1777 GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
1779 return GNUNET_SCHEDULER_add_file_with_priority (
1780 delay, GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1781 wfd, GNUNET_NO, GNUNET_YES,
1787 * Schedule a new task to be run with a specified delay or when the
1788 * specified file descriptor is ready. The delay can be
1789 * used as a timeout on the socket being ready. The task will be
1790 * scheduled for execution once either the delay has expired or the
1791 * socket operation is ready.
1793 * @param delay when should this operation time out?
1794 * @param priority priority of the task
1795 * @param fd file-descriptor
1796 * @param on_read whether to poll the file-descriptor for readability
1797 * @param on_write whether to poll the file-descriptor for writability
1798 * @param task main function of the task
1799 * @param task_cls closure of @a task
1800 * @return unique task identifier for the job
1801 * only valid until @a task is started!
1803 struct GNUNET_SCHEDULER_Task *
1804 GNUNET_SCHEDULER_add_file_with_priority (struct GNUNET_TIME_Relative delay,
1805 enum GNUNET_SCHEDULER_Priority priority,
1806 const struct GNUNET_DISK_FileHandle *fd,
1807 int on_read, int on_write,
1808 GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
1811 struct GNUNET_NETWORK_FDSet *s;
1812 struct GNUNET_SCHEDULER_Task * ret;
1814 GNUNET_assert (NULL != fd);
1815 s = GNUNET_NETWORK_fdset_create ();
1816 GNUNET_NETWORK_fdset_handle_set (s, fd);
1817 ret = GNUNET_SCHEDULER_add_select (
1820 on_write ? s : NULL,
1822 GNUNET_NETWORK_fdset_destroy (s);
1825 GNUNET_assert (on_read || on_write);
1826 GNUNET_assert(fd->fd >= 0);
1827 return add_without_sets (delay, priority,
1830 on_read ? fd : NULL,
1831 on_write ? fd : NULL,
1838 * Schedule a new task to be run with a specified delay or when any of
1839 * the specified file descriptor sets is ready. The delay can be used
1840 * as a timeout on the socket(s) being ready. The task will be
1841 * scheduled for execution once either the delay has expired or any of
1842 * the socket operations is ready. This is the most general
1843 * function of the "add" family. Note that the "prerequisite_task"
1844 * must be satisfied in addition to any of the other conditions. In
1845 * other words, the task will be started when
1847 * (prerequisite-run)
1850 * || any-ws-ready) )
1853 * @param prio how important is this task?
1854 * @param delay how long should we wait?
1855 * @param rs set of file descriptors we want to read (can be NULL)
1856 * @param ws set of file descriptors we want to write (can be NULL)
1857 * @param task main function of the task
1858 * @param task_cls closure of @a task
1859 * @return unique task identifier for the job
1860 * only valid until @a task is started!
1862 struct GNUNET_SCHEDULER_Task *
1863 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
1864 struct GNUNET_TIME_Relative delay,
1865 const struct GNUNET_NETWORK_FDSet *rs,
1866 const struct GNUNET_NETWORK_FDSet *ws,
1867 GNUNET_SCHEDULER_TaskCallback task,
1870 struct GNUNET_SCHEDULER_Task *t;
1872 if ( (NULL == rs) &&
1874 return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
1878 GNUNET_assert (NULL != active_task);
1879 GNUNET_assert (NULL != task);
1880 t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
1882 t->callback_cls = task_cls;
1887 t->read_set = GNUNET_NETWORK_fdset_create ();
1888 GNUNET_NETWORK_fdset_copy (t->read_set, rs);
1892 t->write_set = GNUNET_NETWORK_fdset_create ();
1893 GNUNET_NETWORK_fdset_copy (t->write_set, ws);
1896 t->start_time = GNUNET_TIME_absolute_get ();
1898 t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1900 check_priority ((prio ==
1901 GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority :
1903 t->lifeness = current_lifeness;
1905 scheduler_multi_function_call(t, scheduler_driver->add);
1907 max_priority_added = GNUNET_MAX (max_priority_added,
1909 LOG (GNUNET_ERROR_TYPE_DEBUG,
1918 * Function used by event-loop implementations to signal the scheduler
1919 * that a particular @a task is ready due to an event of type @a et.
1921 * This function will then queue the task to notify the application
1922 * that the task is ready (with the respective priority).
1924 * @param task the task that is ready, NULL for wake up calls
1925 * @param et information about why the task is ready
1928 GNUNET_SCHEDULER_task_ready (struct GNUNET_SCHEDULER_Task *task,
1929 enum GNUNET_SCHEDULER_EventType et)
1931 enum GNUNET_SCHEDULER_Reason reason;
1932 struct GNUNET_TIME_Absolute now;
1934 now = GNUNET_TIME_absolute_get ();
1935 reason = task->reason;
1936 if (now.abs_value_us >= task->timeout.abs_value_us)
1937 reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
1938 if ( (0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
1939 (0 != (GNUNET_SCHEDULER_ET_IN & et)) )
1940 reason |= GNUNET_SCHEDULER_REASON_READ_READY;
1941 if ( (0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
1942 (0 != (GNUNET_SCHEDULER_ET_OUT & et)) )
1943 reason |= GNUNET_SCHEDULER_REASON_WRITE_READY;
1944 reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;
1945 task->reason = reason;
1946 task->fds = &task->fdx;
1949 queue_ready_task (task);
1954 * Function called by the driver to tell the scheduler to run some of
1955 * the tasks that are ready. This function may return even though
1956 * there are tasks left to run just to give other tasks a chance as
1957 * well. If we return #GNUNET_YES, the driver should call this
1958 * function again as soon as possible, while if we return #GNUNET_NO
1959 * it must block until the operating system has more work as the
1960 * scheduler has no more work to do right now.
1962 * @param sh scheduler handle that was given to the `loop`
1963 * @return #GNUNET_OK if there are more tasks that are ready,
1964 * and thus we would like to run more (yield to avoid
1965 * blocking other activities for too long)
1966 * #GNUNET_NO if we are done running tasks (yield to block)
1967 * #GNUNET_SYSERR on error
1970 GNUNET_SCHEDULER_run_from_driver (struct GNUNET_SCHEDULER_Handle *sh)
1972 enum GNUNET_SCHEDULER_Priority p;
1973 struct GNUNET_SCHEDULER_Task *pos;
1974 struct GNUNET_TIME_Absolute now;
1976 /* check for tasks that reached the timeout! */
1977 now = GNUNET_TIME_absolute_get ();
1978 while (NULL != (pos = pending_timeout_head))
1980 if (now.abs_value_us >= pos->timeout.abs_value_us)
1981 pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
1982 if (0 == pos->reason)
1984 GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
1985 pending_timeout_tail,
1987 scheduler_driver->set_wakeup(scheduler_driver->cls,pending_timeout_head->timeout);
1988 if (pending_timeout_last == pos)
1989 pending_timeout_last = NULL;
1990 queue_ready_task (pos);
1993 if (0 == ready_count)
1996 /* find out which task priority level we are going to
1997 process this time */
1998 max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
1999 GNUNET_assert (NULL == ready_head[GNUNET_SCHEDULER_PRIORITY_KEEP]);
2000 /* yes, p>0 is correct, 0 is "KEEP" which should
2001 * always be an empty queue (see assertion)! */
2002 for (p = GNUNET_SCHEDULER_PRIORITY_COUNT - 1; p > 0; p--)
2004 pos = ready_head[p];
2008 GNUNET_assert (NULL != pos); /* ready_count wrong? */
2010 /* process all tasks at this priority level, then yield */
2011 while (NULL != (pos = ready_head[p]))
2013 GNUNET_CONTAINER_DLL_remove (ready_head[p],
2017 current_priority = pos->priority;
2018 current_lifeness = pos->lifeness;
2021 if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
2022 DELAY_THRESHOLD.rel_value_us)
2024 LOG (GNUNET_ERROR_TYPE_DEBUG,
2025 "Task %p took %s to be scheduled\n",
2027 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time),
2031 tc.reason = pos->reason;
2032 GNUNET_NETWORK_fdset_zero (sh->rs);
2033 GNUNET_NETWORK_fdset_zero (sh->ws);
2034 tc.fds_len = pos->fds_len;
2036 tc.read_ready = (NULL == pos->read_set) ? sh->rs : pos->read_set;
2037 if ( (-1 != pos->read_fd) &&
2038 (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)) )
2039 GNUNET_NETWORK_fdset_set_native (sh->rs,
2041 tc.write_ready = (NULL == pos->write_set) ? sh->ws : pos->write_set;
2042 if ((-1 != pos->write_fd) &&
2043 (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)))
2044 GNUNET_NETWORK_fdset_set_native (sh->ws,
2046 LOG (GNUNET_ERROR_TYPE_DEBUG,
2047 "Running task: %p\n",
2049 pos->callback (pos->callback_cls);
2051 dump_backtrace (pos);
2055 if (0 == ready_count)
2062 * Initialize and run scheduler. This function will return when all
2063 * tasks have completed. On systems with signals, receiving a SIGTERM
2064 * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown
2065 * to be run after the active task is complete. As a result, SIGTERM
2066 * causes all shutdown tasks to be scheduled with reason
2067 * #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
2068 * afterwards will execute normally!). Note that any particular
2069 * signal will only shut down one scheduler; applications should
2070 * always only create a single scheduler.
2072 * @param driver drive to use for the event loop
2073 * @param task task to run first (and immediately)
2074 * @param task_cls closure of @a task
2075 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2078 GNUNET_SCHEDULER_run_with_driver (const struct GNUNET_SCHEDULER_Driver *driver,
2079 GNUNET_SCHEDULER_TaskCallback task,
2083 struct GNUNET_SCHEDULER_Handle sh;
2084 struct GNUNET_SIGNAL_Context *shc_int;
2085 struct GNUNET_SIGNAL_Context *shc_term;
2086 #if (SIGTERM != GNUNET_TERM_SIG)
2087 struct GNUNET_SIGNAL_Context *shc_gterm;
2090 struct GNUNET_SIGNAL_Context *shc_quit;
2091 struct GNUNET_SIGNAL_Context *shc_hup;
2092 struct GNUNET_SIGNAL_Context *shc_pipe;
2094 struct GNUNET_SCHEDULER_Task tsk;
2095 const struct GNUNET_DISK_FileHandle *pr;
2096 scheduler_driver = driver;
2098 /* general set-up */
2099 GNUNET_assert (NULL == active_task);
2100 GNUNET_assert (NULL == shutdown_pipe_handle);
2101 shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO,
2105 GNUNET_assert (NULL != shutdown_pipe_handle);
2106 pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
2107 GNUNET_DISK_PIPE_END_READ);
2108 GNUNET_assert (NULL != pr);
2111 /* install signal handlers */
2112 LOG (GNUNET_ERROR_TYPE_DEBUG,
2113 "Registering signal handlers\n");
2114 shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
2115 &sighandler_shutdown);
2116 shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
2117 &sighandler_shutdown);
2118 #if (SIGTERM != GNUNET_TERM_SIG)
2119 shc_gterm = GNUNET_SIGNAL_handler_install (GNUNET_TERM_SIG,
2120 &sighandler_shutdown);
2123 shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
2125 shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
2126 &sighandler_shutdown);
2127 shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
2128 &sighandler_shutdown);
2131 /* Setup initial tasks */
2132 current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
2133 current_lifeness = GNUNET_YES;
2139 GNUNET_SCHEDULER_add_with_reason_and_priority (task,
2141 GNUNET_SCHEDULER_REASON_STARTUP,
2142 GNUNET_SCHEDULER_PRIORITY_DEFAULT);
2143 GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
2144 &GNUNET_OS_install_parent_control_handler,
2147 driver->set_wakeup (driver->cls,
2148 GNUNET_TIME_absolute_get ());
2150 /* begin main event loop */
2151 sh.rs = GNUNET_NETWORK_fdset_create ();
2152 sh.ws = GNUNET_NETWORK_fdset_create ();
2153 GNUNET_NETWORK_fdset_handle_set (sh.rs, pr);
2155 ret = driver->loop (driver->cls,
2157 GNUNET_NETWORK_fdset_destroy (sh.rs);
2158 GNUNET_NETWORK_fdset_destroy (sh.ws);
2160 /* uninstall signal handlers */
2161 GNUNET_SIGNAL_handler_uninstall (shc_int);
2162 GNUNET_SIGNAL_handler_uninstall (shc_term);
2163 #if (SIGTERM != GNUNET_TERM_SIG)
2164 GNUNET_SIGNAL_handler_uninstall (shc_gterm);
2167 GNUNET_SIGNAL_handler_uninstall (shc_pipe);
2168 GNUNET_SIGNAL_handler_uninstall (shc_quit);
2169 GNUNET_SIGNAL_handler_uninstall (shc_hup);
2171 GNUNET_DISK_pipe_close (shutdown_pipe_handle);
2172 shutdown_pipe_handle = NULL;
2177 select_add(void *cls,
2178 struct GNUNET_SCHEDULER_Task *task,
2179 struct GNUNET_SCHEDULER_FdInfo *fdi){
2181 GNUNET_CONTAINER_DLL_insert (pending_head,
2188 select_del(void *cls,
2189 struct GNUNET_SCHEDULER_Task *task,
2190 struct GNUNET_SCHEDULER_FdInfo *fdi){
2192 GNUNET_CONTAINER_DLL_remove (pending_head,
2200 select_loop(void *cls,
2201 struct GNUNET_SCHEDULER_Handle *sh){
2203 while_live(sh->rs, sh->ws);
2208 select_set_wakeup(void *cls,
2209 struct GNUNET_TIME_Absolute dt){
2217 * Obtain the driver for using select() as the event loop.
2219 * @return NULL on error
2221 const struct GNUNET_SCHEDULER_Driver *
2222 GNUNET_SCHEDULER_driver_select ()
2225 struct GNUNET_SCHEDULER_Driver *select_driver;
2227 select_driver = GNUNET_new (struct GNUNET_SCHEDULER_Driver);
2229 select_driver->loop = &select_loop;
2230 select_driver->add = &select_add;
2231 select_driver->del = &select_del;
2232 select_driver->set_wakeup = &select_set_wakeup;
2235 return select_driver;
2239 /* end of scheduler.c */