/*
This file is part of GNUnet
- Copyright (C) 2009-2016 GNUnet e.V.
+ Copyright (C) 2009-2017 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
-
/**
* @file util/scheduler.c
* @brief schedule computations using continuation passing style
#define DELAY_THRESHOLD GNUNET_TIME_UNIT_SECONDS
+/**
+ * Argument to be passed from the driver to
+ * #GNUNET_SCHEDULER_run_from_driver(). Contains the
+ * scheduler's internal state.
+ */
+struct GNUNET_SCHEDULER_Handle
+{
+ /**
+ * Passed here to avoid constantly allocating/deallocating
+ * this element, but generally we want to get rid of this.
+ * @deprecated
+ */
+ struct GNUNET_NETWORK_FDSet *rs;
+
+ /**
+ * Passed here to avoid constantly allocating/deallocating
+ * this element, but generally we want to get rid of this.
+ * @deprecated
+ */
+ struct GNUNET_NETWORK_FDSet *ws;
+
+ /**
+ * Driver we used for the event loop.
+ */
+ const struct GNUNET_SCHEDULER_Driver *driver;
+
+};
+
+
/**
* Entry in list of pending tasks.
*/
*/
void *callback_cls;
+ /**
+ * Handle to the scheduler's state.
+ */
+ const struct GNUNET_SCHEDULER_Handle *sh;
+
/**
* Set of file descriptors this task is waiting
* for for reading. Once ready, this is updated
*/
struct GNUNET_NETWORK_FDSet *write_set;
+ /**
+ * Information about which FDs are ready for this task (and why).
+ */
+ const struct GNUNET_SCHEDULER_FdInfo *fds;
+
+ /**
+ * Storage location used for @e fds if we want to avoid
+ * a separate malloc() call in the common case that this
+ * task is only about a single FD.
+ */
+ struct GNUNET_SCHEDULER_FdInfo fdx;
+
/**
* Absolute timeout value for the task, or
* #GNUNET_TIME_UNIT_FOREVER_ABS for "no timeout".
struct GNUNET_TIME_Absolute start_time;
#endif
+ /**
+ * Size of the @e fds array.
+ */
+ unsigned int fds_len;
+
/**
* Why is the task ready? Set after task is added to ready queue.
* Initially set to zero. All reasons that have already been
* Is this task run on shutdown?
*/
int on_shutdown;
-
+
/**
* Is this task in the ready list?
*/
};
+/**
+ * The driver used for the event loop. Will be handed over to
+ * the scheduler in #GNUNET_SCHEDULER_run_from_driver(), peristed
+ * there in this variable for later use in functions like
+ * #GNUNET_SCHEDULER_add_select(), #add_without_sets() and
+ * #GNUNET_SCHEDULER_cancel().
+ */
+static const struct GNUNET_SCHEDULER_Driver *scheduler_driver;
/**
* Head of list of tasks waiting for an event.
* @param ws write-set, set to all FDs we would like to write (updated)
* @param timeout next timeout (updated)
*/
-static void
-update_sets (struct GNUNET_NETWORK_FDSet *rs,
- struct GNUNET_NETWORK_FDSet *ws,
- struct GNUNET_TIME_Relative *timeout)
+void getNextPendingTimeout(struct GNUNET_TIME_Relative *timeout)
{
+
struct GNUNET_SCHEDULER_Task *pos;
struct GNUNET_TIME_Absolute now;
struct GNUNET_TIME_Relative to;
if (0 != pos->reason)
*timeout = GNUNET_TIME_UNIT_ZERO;
}
+}
+
+static void
+update_sets (struct GNUNET_NETWORK_FDSet *rs,
+ struct GNUNET_NETWORK_FDSet *ws,
+ struct GNUNET_TIME_Relative *timeout)
+{
+ struct GNUNET_SCHEDULER_Task *pos;
+ struct GNUNET_TIME_Absolute now;
+ struct GNUNET_TIME_Relative to;
+
+ now = GNUNET_TIME_absolute_get ();
+
+ getNextPendingTimeout(timeout);
for (pos = pending_head; NULL != pos; pos = pos->next)
{
if (pos->timeout.abs_value_us != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
/**
- * Request the shutdown of a scheduler. Marks all tasks
+ * Request the shutdown of a scheduler. Marks all tasks
* awaiting shutdown as ready. Note that tasks
* scheduled with #GNUNET_SCHEDULER_add_shutdown() AFTER this call
* will be delayed until the next shutdown signal.
* Output stack trace of task @a t.
*
* @param t task to dump stack trace of
- */
+ */
static void
dump_backtrace (struct GNUNET_SCHEDULER_Task *t)
{
#if EXECINFO
unsigned int i;
-
+
for (i = 0; i < t->num_backtrace_strings; i++)
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Task %p trace %u: %s\n",
- t,
- i,
- t->backtrace_strings[i]);
+ "Task %p trace %u: %s\n",
+ t,
+ i,
+ t->backtrace_strings[i]);
#endif
}
DELAY_THRESHOLD.rel_value_us)
{
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Task %p took %s to be scheduled\n",
+ "Task %p took %s to be scheduled\n",
pos,
GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time),
GNUNET_YES));
(!GNUNET_NETWORK_fdset_test_native (ws, pos->write_fd)))
GNUNET_assert (0); // added to ready in previous select loop!
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Running task: %p\n",
+ "Running task: %p\n",
pos);
pos->callback (pos->callback_cls);
dump_backtrace (pos);
/**
- * Check if the system is still life. Trigger shutdown if we
+ * Check if the system is still alive. Trigger shutdown if we
* have tasks, but none of them give us lifeness.
*
* @return #GNUNET_OK to continue the main loop,
}
-/**
- * Initialize and run scheduler. This function will return when all
- * tasks have completed. On systems with signals, receiving a SIGTERM
- * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown()
- * to be run after the active task is complete. As a result, SIGTERM
- * causes all active tasks to be scheduled with reason
- * #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
- * afterwards will execute normally!). Note that any particular signal
- * will only shut down one scheduler; applications should always only
- * create a single scheduler.
- *
- * @param task task to run immediately
- * @param task_cls closure of @a task
- */
-void
-GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_TaskCallback task,
- void *task_cls)
+
+void while_live(struct GNUNET_NETWORK_FDSet *rs, struct GNUNET_NETWORK_FDSet *ws)
{
- struct GNUNET_NETWORK_FDSet *rs;
- struct GNUNET_NETWORK_FDSet *ws;
- struct GNUNET_TIME_Relative timeout;
int ret;
- struct GNUNET_SIGNAL_Context *shc_int;
- struct GNUNET_SIGNAL_Context *shc_term;
-#if (SIGTERM != GNUNET_TERM_SIG)
- struct GNUNET_SIGNAL_Context *shc_gterm;
-#endif
-
-#ifndef MINGW
- struct GNUNET_SIGNAL_Context *shc_quit;
- struct GNUNET_SIGNAL_Context *shc_hup;
- struct GNUNET_SIGNAL_Context *shc_pipe;
-#endif
- unsigned long long last_tr;
unsigned int busy_wait_warning;
+ unsigned long long last_tr;
const struct GNUNET_DISK_FileHandle *pr;
char c;
+ struct GNUNET_TIME_Relative timeout;
- GNUNET_assert (NULL == active_task);
- rs = GNUNET_NETWORK_fdset_create ();
- ws = GNUNET_NETWORK_fdset_create ();
- GNUNET_assert (NULL == shutdown_pipe_handle);
- shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO,
- GNUNET_NO,
- GNUNET_NO,
- GNUNET_NO);
- GNUNET_assert (NULL != shutdown_pipe_handle);
+ busy_wait_warning = 0;
pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
GNUNET_DISK_PIPE_END_READ);
GNUNET_assert (NULL != pr);
- my_pid = getpid ();
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Registering signal handlers\n");
- shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
- &sighandler_shutdown);
- shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
- &sighandler_shutdown);
-#if (SIGTERM != GNUNET_TERM_SIG)
- shc_gterm = GNUNET_SIGNAL_handler_install (GNUNET_TERM_SIG,
- &sighandler_shutdown);
-#endif
-#ifndef MINGW
- shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
- &sighandler_pipe);
- shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
- &sighandler_shutdown);
- shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
- &sighandler_shutdown);
-#endif
- current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
- current_lifeness = GNUNET_YES;
- GNUNET_SCHEDULER_add_with_reason_and_priority (task,
- task_cls,
- GNUNET_SCHEDULER_REASON_STARTUP,
- GNUNET_SCHEDULER_PRIORITY_DEFAULT);
- active_task = (void *) (long) -1; /* force passing of sanity check */
- GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
- &GNUNET_OS_install_parent_control_handler,
- NULL);
- active_task = NULL;
last_tr = 0;
- busy_wait_warning = 0;
+
while (GNUNET_OK == check_lifeness ())
{
GNUNET_NETWORK_fdset_zero (rs);
LOG (GNUNET_ERROR_TYPE_ERROR,
"Got invalid file descriptor %d!\n",
t->read_fd);
- dump_backtrace (t);
+ dump_backtrace (t);
}
}
if (-1 != t->write_fd)
LOG (GNUNET_ERROR_TYPE_ERROR,
"Got invalid file descriptor %d!\n",
t->write_fd);
- dump_backtrace (t);
+ dump_backtrace (t);
}
}
}
busy_wait_warning = 0;
}
}
+}
+
+/**
+ * Initialize and run scheduler. This function will return when all
+ * tasks have completed. On systems with signals, receiving a SIGTERM
+ * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown()
+ * to be run after the active task is complete. As a result, SIGTERM
+ * causes all active tasks to be scheduled with reason
+ * #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
+ * afterwards will execute normally!). Note that any particular signal
+ * will only shut down one scheduler; applications should always only
+ * create a single scheduler.
+ *
+ * @param task task to run immediately
+ * @param task_cls closure of @a task
+ */
+void
+GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls)
+{
+ struct GNUNET_NETWORK_FDSet *rs;
+ struct GNUNET_NETWORK_FDSet *ws;
+
+
+ struct GNUNET_SIGNAL_Context *shc_int;
+ struct GNUNET_SIGNAL_Context *shc_term;
+#if (SIGTERM != GNUNET_TERM_SIG)
+ struct GNUNET_SIGNAL_Context *shc_gterm;
+#endif
+
+#ifndef MINGW
+ struct GNUNET_SIGNAL_Context *shc_quit;
+ struct GNUNET_SIGNAL_Context *shc_hup;
+ struct GNUNET_SIGNAL_Context *shc_pipe;
+#endif
+
+
+
+ GNUNET_assert (NULL == active_task);
+ rs = GNUNET_NETWORK_fdset_create ();
+ ws = GNUNET_NETWORK_fdset_create ();
+ GNUNET_assert (NULL == shutdown_pipe_handle);
+ shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO,
+ GNUNET_NO,
+ GNUNET_NO,
+ GNUNET_NO);
+ GNUNET_assert (NULL != shutdown_pipe_handle);
+
+ my_pid = getpid ();
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Registering signal handlers\n");
+ shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
+ &sighandler_shutdown);
+ shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
+ &sighandler_shutdown);
+#if (SIGTERM != GNUNET_TERM_SIG)
+ shc_gterm = GNUNET_SIGNAL_handler_install (GNUNET_TERM_SIG,
+ &sighandler_shutdown);
+#endif
+#ifndef MINGW
+ shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
+ &sighandler_pipe);
+ shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
+ &sighandler_shutdown);
+ shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
+ &sighandler_shutdown);
+#endif
+ current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
+ current_lifeness = GNUNET_YES;
+ GNUNET_SCHEDULER_add_with_reason_and_priority (task,
+ task_cls,
+ GNUNET_SCHEDULER_REASON_STARTUP,
+ GNUNET_SCHEDULER_PRIORITY_DEFAULT);
+ active_task = (void *) (long) -1; /* force passing of sanity check */
+ GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
+ &GNUNET_OS_install_parent_control_handler,
+ NULL);
+ active_task = NULL;
+
+
+ while_live(rs, ws);
GNUNET_SIGNAL_handler_uninstall (shc_int);
GNUNET_SIGNAL_handler_uninstall (shc_term);
#if (SIGTERM != GNUNET_TERM_SIG)
return ret;
}
+static struct GNUNET_SCHEDULER_Task*
+initFdInfo(const struct GNUNET_NETWORK_Handle *read_nh,
+ const struct GNUNET_NETWORK_Handle *write_nh,
+ const struct GNUNET_DISK_FileHandle *read_fh,
+ const struct GNUNET_DISK_FileHandle *write_fh)
+{
+
+
+ struct GNUNET_SCHEDULER_Task *t;
+
+ t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
+
+ // either only network handles or only file handles are allowed
+ GNUNET_assert (!((NULL != read_nh || NULL != write_nh) && (NULL != read_fh || NULL != write_fh)));
+
+ if (NULL != read_nh && NULL != write_nh)
+ {
+ t->fds_len = 2;
+ t->fds = GNUNET_new_array (2, struct GNUNET_SCHEDULER_FdInfo);
+ const struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fd = read_nh, .et = GNUNET_SCHEDULER_ET_IN, .sock = GNUNET_NETWORK_get_fd (read_nh)};
+ const struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fd = write_nh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
+
+ const struct GNUNET_SCHEDULER_FdInfo array[2] = {read_fdi, write_fdi};
+ t->fds = array;
+ }
+ else if (NULL != read_fh && NULL != write_fh)
+ {
+ t->fds_len = 2;
+ t->fds = GNUNET_new_array (2, struct GNUNET_SCHEDULER_FdInfo);
+ const struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fh = read_fh, .et = GNUNET_SCHEDULER_ET_IN};
+ const struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fh = write_fh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
+ const struct GNUNET_SCHEDULER_FdInfo array[2] = {read_fdi, write_fdi};
+ t->fds = array;
+ }
+ else if (NULL != read_nh)
+ {
+ struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fd = read_nh, .et = GNUNET_SCHEDULER_ET_IN, .sock = GNUNET_NETWORK_get_fd (read_nh)};
+ t->fdx = read_fdi;
+ }
+ else if (NULL != write_nh)
+ {
+ struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fd = write_nh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
+ t->fdx = write_fdi;
+ }
+ else if (NULL != read_fh)
+ {
+ struct GNUNET_SCHEDULER_FdInfo read_fdi = { .fh = read_fh, .et = GNUNET_SCHEDULER_ET_IN};
+ t->fdx = read_fdi;
+ }
+ else if (NULL != write_fh)
+ {
+ struct GNUNET_SCHEDULER_FdInfo write_fdi = { .fh = write_fh, .et = GNUNET_SCHEDULER_ET_OUT, .sock = GNUNET_NETWORK_get_fd (write_nh)};
+ t->fdx = write_fdi;
+ }
+}
/**
* Cancel the task with the specified identifier.
void *ret;
GNUNET_assert ( (NULL != active_task) ||
- (GNUNET_NO == task->lifeness) );
+ (GNUNET_NO == task->lifeness) );
if (! task->in_ready_list)
{
if ( (-1 == task->read_fd) &&
(NULL == task->write_set) )
{
if (GNUNET_YES == task->on_shutdown)
- GNUNET_CONTAINER_DLL_remove (shutdown_head,
- shutdown_tail,
- task);
+ GNUNET_CONTAINER_DLL_remove (shutdown_head,
+ shutdown_tail,
+ task);
else
- GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
- pending_timeout_tail,
- task);
+ GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
+ pending_timeout_tail,
+ task);
if (task == pending_timeout_last)
pending_timeout_last = NULL;
}
else
{
- GNUNET_CONTAINER_DLL_remove (pending_head,
- pending_tail,
- task);
+ scheduler_multi_function_call(task, scheduler_driver->del);
}
}
else
= backtrace (backtrace_array, MAX_TRACE_DEPTH);
t->backtrace_strings =
backtrace_symbols (backtrace_array,
- t->num_backtrace_strings);
+ t->num_backtrace_strings);
dump_backtrace (t);
#endif
}
/**
- * Schedule a new task to be run with a specified delay. The task
- * will be scheduled for execution once the delay has expired.
+ * Schedule a new task to be run at the specified time. The task
+ * will be scheduled for execution at time @a at.
*
- * @param delay when should this operation time out?
+ * @param at time when the operation should run
* @param priority priority to use for the task
* @param task main function of the task
* @param task_cls closure of @a task
* only valid until @a task is started!
*/
struct GNUNET_SCHEDULER_Task *
-GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
- enum GNUNET_SCHEDULER_Priority priority,
- GNUNET_SCHEDULER_TaskCallback task,
- void *task_cls)
+GNUNET_SCHEDULER_add_at_with_priority (struct GNUNET_TIME_Absolute at,
+ enum GNUNET_SCHEDULER_Priority priority,
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls)
{
struct GNUNET_SCHEDULER_Task *t;
struct GNUNET_SCHEDULER_Task *pos;
#if PROFILE_DELAYS
t->start_time = GNUNET_TIME_absolute_get ();
#endif
- t->timeout = GNUNET_TIME_relative_to_absolute (delay);
+ t->timeout = at;
t->priority = priority;
t->lifeness = current_lifeness;
/* try tail first (optimization in case we are
* appending to a long list of tasks with timeouts) */
- if (0 == delay.rel_value_us)
+ if ( (NULL == pending_timeout_head) ||
+ (at.abs_value_us < pending_timeout_head->timeout.abs_value_us) )
{
GNUNET_CONTAINER_DLL_insert (pending_timeout_head,
pending_timeout_tail,
pending_timeout_tail,
prev,
t);
- /* finally, update heuristic insertion point to last insertion... */
- pending_timeout_last = t;
}
+ /* finally, update heuristic insertion point to last insertion... */
+ pending_timeout_last = t;
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Adding task: %p\n",
}
+/**
+ * Schedule a new task to be run with a specified delay. The task
+ * will be scheduled for execution once the delay has expired.
+ *
+ * @param delay when should this operation time out?
+ * @param priority priority to use for the task
+ * @param task main function of the task
+ * @param task_cls closure of @a task
+ * @return unique task identifier for the job
+ * only valid until @a task is started!
+ */
+struct GNUNET_SCHEDULER_Task *
+GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
+ enum GNUNET_SCHEDULER_Priority priority,
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls)
+{
+ return GNUNET_SCHEDULER_add_at_with_priority (GNUNET_TIME_relative_to_absolute (delay),
+ priority,
+ task,
+ task_cls);
+}
+
+
/**
* Schedule a new task to be run with a specified priority.
*
}
+/**
+ * Schedule a new task to be run at the specified time. The task
+ * will be scheduled for execution once specified time has been
+ * reached. It will be run with the DEFAULT priority.
+ *
+ * @param at time at which this operation should run
+ * @param task main function of the task
+ * @param task_cls closure of @a task
+ * @return unique task identifier for the job
+ * only valid until @a task is started!
+ */
+struct GNUNET_SCHEDULER_Task *
+GNUNET_SCHEDULER_add_at (struct GNUNET_TIME_Absolute at,
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls)
+{
+ return GNUNET_SCHEDULER_add_at_with_priority (at,
+ GNUNET_SCHEDULER_PRIORITY_DEFAULT,
+ task,
+ task_cls);
+}
+
+
/**
* Schedule a new task to be run with a specified delay. The task
* will be scheduled for execution once the delay has expired. It
struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
GNUNET_SCHEDULER_TaskCallback task,
- void *task_cls)
+ void *task_cls)
{
return GNUNET_SCHEDULER_add_delayed_with_priority (delay,
- GNUNET_SCHEDULER_PRIORITY_DEFAULT,
- task, task_cls);
+ GNUNET_SCHEDULER_PRIORITY_DEFAULT,
+ task,
+ task_cls);
}
*/
struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_TaskCallback task,
- void *task_cls)
+ void *task_cls)
{
return GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_ZERO,
- task,
- task_cls);
+ task,
+ task_cls);
}
*/
struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_shutdown (GNUNET_SCHEDULER_TaskCallback task,
- void *task_cls)
+ void *task_cls)
{
struct GNUNET_SCHEDULER_Task *t;
t->on_shutdown = GNUNET_YES;
t->lifeness = GNUNET_YES;
GNUNET_CONTAINER_DLL_insert (shutdown_head,
- shutdown_tail,
- t);
+ shutdown_tail,
+ t);
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Adding task: %p\n",
t);
}
+
+int scheduler_multi_function_call(struct GNUNET_SCHEDULER_Task *t, int (*driver_func)())
+{
+ if (t->fds_len > 1){
+ int success = GNUNET_YES;
+ for (int i = 0; i < t->fds_len;i++){
+ success = driver_func(scheduler_driver->cls, t , t->fds+i) && success;
+ }
+ return success;
+ }else{
+ return driver_func(scheduler_driver->cls, t , t->fds);
+ }
+}
+
/**
* Schedule a new task to be run with a specified delay or when any of
* the specified file descriptor sets is ready. The delay can be used
#ifndef MINGW
static struct GNUNET_SCHEDULER_Task *
add_without_sets (struct GNUNET_TIME_Relative delay,
- enum GNUNET_SCHEDULER_Priority priority,
- int rfd,
- int wfd,
+ enum GNUNET_SCHEDULER_Priority priority,
+ const struct GNUNET_NETWORK_Handle *read_nh,
+ const struct GNUNET_NETWORK_Handle *write_nh,
+ const struct GNUNET_DISK_FileHandle *read_fh,
+ const struct GNUNET_DISK_FileHandle *write_fh,
+ //int rfd,
+ //int wfd,
GNUNET_SCHEDULER_TaskCallback task,
void *task_cls)
{
GNUNET_assert (NULL != active_task);
GNUNET_assert (NULL != task);
- t = GNUNET_new (struct GNUNET_SCHEDULER_Task);
+ t= initFdInfo (read_nh, write_nh, read_fh, write_fh);
+
t->callback = task;
t->callback_cls = task_cls;
#if DEBUG_FDS
}
}
#endif
- t->read_fd = rfd;
- GNUNET_assert (wfd >= -1);
- t->write_fd = wfd;
+
#if PROFILE_DELAYS
t->start_time = GNUNET_TIME_absolute_get ();
#endif
t->timeout = GNUNET_TIME_relative_to_absolute (delay);
t->priority = check_priority ((priority == GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority : priority);
t->lifeness = current_lifeness;
- GNUNET_CONTAINER_DLL_insert (pending_head,
- pending_tail,
- t);
+
+
+
+ scheduler_multi_function_call(t, scheduler_driver->add);
+
max_priority_added = GNUNET_MAX (max_priority_added,
t->priority);
LOG (GNUNET_ERROR_TYPE_DEBUG,
* scheduled for execution once either the delay has expired or the
* socket operation is ready. It will be run with the DEFAULT priority.
*
- * @param delay when should this operation time out?
+ * @param delay when should this operation time out?
* @param rfd read file-descriptor
* @param task main function of the task
* @param task_cls closure of @a task
void *task_cls)
{
return GNUNET_SCHEDULER_add_read_net_with_priority (delay,
- GNUNET_SCHEDULER_PRIORITY_DEFAULT,
- rfd, task, task_cls);
+ GNUNET_SCHEDULER_PRIORITY_DEFAULT,
+ rfd, task, task_cls);
}
*/
struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_read_net_with_priority (struct GNUNET_TIME_Relative delay,
- enum GNUNET_SCHEDULER_Priority priority,
- struct GNUNET_NETWORK_Handle *rfd,
- GNUNET_SCHEDULER_TaskCallback task,
+ enum GNUNET_SCHEDULER_Priority priority,
+ struct GNUNET_NETWORK_Handle *rfd,
+ GNUNET_SCHEDULER_TaskCallback task,
void *task_cls)
{
return GNUNET_SCHEDULER_add_net_with_priority (delay, priority,
GNUNET_NETWORK_fdset_destroy (s);
return ret;
#else
+ GNUNET_assert (on_read || on_write);
GNUNET_assert (GNUNET_NETWORK_get_fd (fd) >= 0);
return add_without_sets (delay, priority,
- on_read ? GNUNET_NETWORK_get_fd (fd) : -1,
- on_write ? GNUNET_NETWORK_get_fd (fd) : -1,
+ on_read ? fd : NULL,
+ on_write ? fd : NULL,
+ NULL,
+ NULL,
task, task_cls);
#endif
}
GNUNET_NETWORK_fdset_destroy (s);
return ret;
#else
- int real_fd;
-
- GNUNET_DISK_internal_file_handle_ (fd, &real_fd, sizeof (int));
- GNUNET_assert (real_fd >= 0);
- return add_without_sets (
- delay, priority,
- on_read ? real_fd : -1,
- on_write ? real_fd : -1,
- task, task_cls);
+ GNUNET_assert (on_read || on_write);
+ GNUNET_assert(fd->fd >= 0);
+ return add_without_sets (delay, priority,
+ NULL,
+ NULL,
+ on_read ? fd : NULL,
+ on_write ? fd : NULL,
+ task, task_cls);
#endif
}
* </code>
*
* @param prio how important is this task?
- * @param delay how long should we wait?
+ * @param delay how long should we wait?
* @param rs set of file descriptors we want to read (can be NULL)
* @param ws set of file descriptors we want to write (can be NULL)
* @param task main function of the task
GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority :
prio);
t->lifeness = current_lifeness;
- GNUNET_CONTAINER_DLL_insert (pending_head,
- pending_tail,
- t);
- max_priority_added = GNUNET_MAX (max_priority_added, t->priority);
+
+ scheduler_multi_function_call(t, scheduler_driver->add);
+
+ max_priority_added = GNUNET_MAX (max_priority_added,
+ t->priority);
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Adding task %p\n",
t);
return t;
}
+
+/**
+ * Function used by event-loop implementations to signal the scheduler
+ * that a particular @a task is ready due to an event of type @a et.
+ *
+ * This function will then queue the task to notify the application
+ * that the task is ready (with the respective priority).
+ *
+ * @param task the task that is ready, NULL for wake up calls
+ * @param et information about why the task is ready
+ */
+void
+GNUNET_SCHEDULER_task_ready (struct GNUNET_SCHEDULER_Task *task,
+ enum GNUNET_SCHEDULER_EventType et)
+{
+ enum GNUNET_SCHEDULER_Reason reason;
+ struct GNUNET_TIME_Absolute now;
+
+ now = GNUNET_TIME_absolute_get ();
+ reason = task->reason;
+ if (now.abs_value_us >= task->timeout.abs_value_us)
+ reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
+ if ( (0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
+ (0 != (GNUNET_SCHEDULER_ET_IN & et)) )
+ reason |= GNUNET_SCHEDULER_REASON_READ_READY;
+ if ( (0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
+ (0 != (GNUNET_SCHEDULER_ET_OUT & et)) )
+ reason |= GNUNET_SCHEDULER_REASON_WRITE_READY;
+ reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;
+ task->reason = reason;
+ task->fds = &task->fdx;
+ task->fdx.et = et;
+ task->fds_len = 1;
+ queue_ready_task (task);
+}
+
+
+/**
+ * Function called by the driver to tell the scheduler to run some of
+ * the tasks that are ready. This function may return even though
+ * there are tasks left to run just to give other tasks a chance as
+ * well. If we return #GNUNET_YES, the driver should call this
+ * function again as soon as possible, while if we return #GNUNET_NO
+ * it must block until the operating system has more work as the
+ * scheduler has no more work to do right now.
+ *
+ * @param sh scheduler handle that was given to the `loop`
+ * @return #GNUNET_OK if there are more tasks that are ready,
+ * and thus we would like to run more (yield to avoid
+ * blocking other activities for too long)
+ * #GNUNET_NO if we are done running tasks (yield to block)
+ * #GNUNET_SYSERR on error
+ */
+int
+GNUNET_SCHEDULER_run_from_driver (struct GNUNET_SCHEDULER_Handle *sh)
+{
+ enum GNUNET_SCHEDULER_Priority p;
+ struct GNUNET_SCHEDULER_Task *pos;
+ struct GNUNET_TIME_Absolute now;
+
+ /* check for tasks that reached the timeout! */
+ now = GNUNET_TIME_absolute_get ();
+ while (NULL != (pos = pending_timeout_head))
+ {
+ if (now.abs_value_us >= pos->timeout.abs_value_us)
+ pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
+ if (0 == pos->reason)
+ break;
+ GNUNET_CONTAINER_DLL_remove (pending_timeout_head,
+ pending_timeout_tail,
+ pos);
+ if (pending_timeout_last == pos)
+ pending_timeout_last = NULL;
+ queue_ready_task (pos);
+ }
+
+ if (0 == ready_count)
+ return GNUNET_NO;
+
+ /* find out which task priority level we are going to
+ process this time */
+ max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
+ GNUNET_assert (NULL == ready_head[GNUNET_SCHEDULER_PRIORITY_KEEP]);
+ /* yes, p>0 is correct, 0 is "KEEP" which should
+ * always be an empty queue (see assertion)! */
+ for (p = GNUNET_SCHEDULER_PRIORITY_COUNT - 1; p > 0; p--)
+ {
+ pos = ready_head[p];
+ if (NULL != pos)
+ break;
+ }
+ GNUNET_assert (NULL != pos); /* ready_count wrong? */
+
+ /* process all tasks at this priority level, then yield */
+ while (NULL != (pos = ready_head[p]))
+ {
+ GNUNET_CONTAINER_DLL_remove (ready_head[p],
+ ready_tail[p],
+ pos);
+ ready_count--;
+ current_priority = pos->priority;
+ current_lifeness = pos->lifeness;
+ active_task = pos;
+#if PROFILE_DELAYS
+ if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
+ DELAY_THRESHOLD.rel_value_us)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Task %p took %s to be scheduled\n",
+ pos,
+ GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->start_time),
+ GNUNET_YES));
+ }
+#endif
+ tc.reason = pos->reason;
+ GNUNET_NETWORK_fdset_zero (sh->rs);
+ GNUNET_NETWORK_fdset_zero (sh->ws);
+ tc.fds_len = pos->fds_len;
+ tc.fds = pos->fds;
+ tc.read_ready = (NULL == pos->read_set) ? sh->rs : pos->read_set;
+ if ( (-1 != pos->read_fd) &&
+ (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)) )
+ GNUNET_NETWORK_fdset_set_native (sh->rs,
+ pos->read_fd);
+ tc.write_ready = (NULL == pos->write_set) ? sh->ws : pos->write_set;
+ if ((-1 != pos->write_fd) &&
+ (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)))
+ GNUNET_NETWORK_fdset_set_native (sh->ws,
+ pos->write_fd);
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Running task: %p\n",
+ pos);
+ pos->callback (pos->callback_cls);
+ active_task = NULL;
+ dump_backtrace (pos);
+ destroy_task (pos);
+ tasks_run++;
+ }
+ if (0 == ready_count)
+ return GNUNET_NO;
+ return GNUNET_OK;
+}
+
+
+/**
+ * Initialize and run scheduler. This function will return when all
+ * tasks have completed. On systems with signals, receiving a SIGTERM
+ * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown
+ * to be run after the active task is complete. As a result, SIGTERM
+ * causes all shutdown tasks to be scheduled with reason
+ * #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
+ * afterwards will execute normally!). Note that any particular
+ * signal will only shut down one scheduler; applications should
+ * always only create a single scheduler.
+ *
+ * @param driver drive to use for the event loop
+ * @param task task to run first (and immediately)
+ * @param task_cls closure of @a task
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
+ */
+int
+GNUNET_SCHEDULER_run_with_driver (const struct GNUNET_SCHEDULER_Driver *driver,
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls)
+{
+ int ret;
+ struct GNUNET_SCHEDULER_Handle sh;
+ struct GNUNET_SIGNAL_Context *shc_int;
+ struct GNUNET_SIGNAL_Context *shc_term;
+#if (SIGTERM != GNUNET_TERM_SIG)
+ struct GNUNET_SIGNAL_Context *shc_gterm;
+#endif
+#ifndef MINGW
+ struct GNUNET_SIGNAL_Context *shc_quit;
+ struct GNUNET_SIGNAL_Context *shc_hup;
+ struct GNUNET_SIGNAL_Context *shc_pipe;
+#endif
+ struct GNUNET_SCHEDULER_Task tsk;
+ const struct GNUNET_DISK_FileHandle *pr;
+ scheduler_driver = driver;
+
+ /* general set-up */
+ GNUNET_assert (NULL == active_task);
+ GNUNET_assert (NULL == shutdown_pipe_handle);
+ shutdown_pipe_handle = GNUNET_DISK_pipe (GNUNET_NO,
+ GNUNET_NO,
+ GNUNET_NO,
+ GNUNET_NO);
+ GNUNET_assert (NULL != shutdown_pipe_handle);
+ pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle,
+ GNUNET_DISK_PIPE_END_READ);
+ GNUNET_assert (NULL != pr);
+ my_pid = getpid ();
+
+ /* install signal handlers */
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Registering signal handlers\n");
+ shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
+ &sighandler_shutdown);
+ shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
+ &sighandler_shutdown);
+#if (SIGTERM != GNUNET_TERM_SIG)
+ shc_gterm = GNUNET_SIGNAL_handler_install (GNUNET_TERM_SIG,
+ &sighandler_shutdown);
+#endif
+#ifndef MINGW
+ shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
+ &sighandler_pipe);
+ shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
+ &sighandler_shutdown);
+ shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
+ &sighandler_shutdown);
+#endif
+
+ /* Setup initial tasks */
+ current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
+ current_lifeness = GNUNET_YES;
+ memset (&tsk,
+ 0,
+ sizeof (tsk));
+ active_task = &tsk;
+ tsk.sh = &sh;
+ GNUNET_SCHEDULER_add_with_reason_and_priority (task,
+ task_cls,
+ GNUNET_SCHEDULER_REASON_STARTUP,
+ GNUNET_SCHEDULER_PRIORITY_DEFAULT);
+ GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
+ &GNUNET_OS_install_parent_control_handler,
+ NULL);
+ active_task = NULL;
+ driver->set_wakeup (driver->cls,
+ GNUNET_TIME_absolute_get ());
+
+ /* begin main event loop */
+ sh.rs = GNUNET_NETWORK_fdset_create ();
+ sh.ws = GNUNET_NETWORK_fdset_create ();
+ GNUNET_NETWORK_fdset_handle_set (sh.rs, pr);
+ sh.driver = driver;
+ ret = driver->loop (driver->cls,
+ &sh);
+ GNUNET_NETWORK_fdset_destroy (sh.rs);
+ GNUNET_NETWORK_fdset_destroy (sh.ws);
+
+ /* uninstall signal handlers */
+ GNUNET_SIGNAL_handler_uninstall (shc_int);
+ GNUNET_SIGNAL_handler_uninstall (shc_term);
+#if (SIGTERM != GNUNET_TERM_SIG)
+ GNUNET_SIGNAL_handler_uninstall (shc_gterm);
+#endif
+#ifndef MINGW
+ GNUNET_SIGNAL_handler_uninstall (shc_pipe);
+ GNUNET_SIGNAL_handler_uninstall (shc_quit);
+ GNUNET_SIGNAL_handler_uninstall (shc_hup);
+#endif
+ GNUNET_DISK_pipe_close (shutdown_pipe_handle);
+ shutdown_pipe_handle = NULL;
+ return ret;
+}
+
+int
+select_add(void *cls,
+ struct GNUNET_SCHEDULER_Task *task,
+ struct GNUNET_SCHEDULER_FdInfo *fdi){
+
+ GNUNET_CONTAINER_DLL_insert (pending_head,
+ pending_tail,
+ task);
+
+}
+
+int
+select_del(void *cls,
+ struct GNUNET_SCHEDULER_Task *task,
+ struct GNUNET_SCHEDULER_FdInfo *fdi){
+
+ GNUNET_CONTAINER_DLL_remove (pending_head,
+ pending_tail,
+ task);
+
+}
+
+
+int
+select_loop(void *cls,
+ struct GNUNET_SCHEDULER_Handle *sh){
+
+ while_live(sh->rs, sh->ws);
+
+}
+
+static void
+select_set_wakeup(void *cls,
+ struct GNUNET_TIME_Absolute dt){
+
+
+
+}
+
+
+/**
+ * Obtain the driver for using select() as the event loop.
+ *
+ * @return NULL on error
+ */
+const struct GNUNET_SCHEDULER_Driver *
+GNUNET_SCHEDULER_driver_select ()
+{
+
+ struct GNUNET_SCHEDULER_Driver *select_driver;
+
+ select_driver = GNUNET_new (struct GNUNET_SCHEDULER_Driver);
+
+ select_driver->loop = &select_loop;
+ select_driver->add = &select_add;
+ select_driver->del = &select_del;
+ select_driver->set_wakeup = &select_set_wakeup;
+
+
+ return select_driver;
+}
+
+
/* end of scheduler.c */
projects / oweals / gnunet.git / blobdiff