2 * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file sched.c Paraslash's scheduling functions. */
21 * The possible states of a task.
23 * In addition to the states listed here, a task may also enter zombie state.
24 * This happens when its ->post_select function returns negative, the ->status
25 * field is then set to this return value. Such tasks are not scheduled any
26 * more (i.e. ->pre_select() and ->post_select() are no longer called), but
27 * they stay on the scheduler task list until \ref task_reap() or
28 * \ref sched_shutdown() is called.
31 /** Task has been reaped and may be removed from the task list. */
33 /** Task is active. */
38 /** A copy of the task name supplied when the task was registered. */
40 /** Copied during task_register(). */
41 struct task_info info;
42 /* TS_RUNNING, TS_DEAD, or zombie (negative value). */
44 /** Position of the task in the task list of the scheduler. */
45 struct list_head node;
46 /** If less than zero, the task was notified by another task. */
50 static struct timeval now_struct;
51 const struct timeval *now = &now_struct;
53 static void sched_preselect(struct sched *s)
57 list_for_each_entry_safe(t, tmp, &s->task_list, node) {
60 if (t->notification != 0)
62 if (t->info.pre_select)
63 t->info.pre_select(s, t->info.context);
67 static void unlink_and_free_task(struct task *t)
69 PARA_INFO_LOG("freeing task %s (%s)\n", t->name, t->status < 0?
70 para_strerror(-t->status) :
71 (t->status == TS_DEAD? "[dead]" : "[running]"));
78 //#define SCHED_DEBUG 1
79 static inline void call_post_select(struct sched *s, struct task *t)
84 ret = t->info.post_select(s, t->info.context);
86 struct timeval t1, t2, diff;
89 clock_get_realtime(&t1);
90 ret = t->info.post_select(s, t->info.context);
91 clock_get_realtime(&t2);
92 tv_diff(&t1, &t2, &diff);
95 PARA_WARNING_LOG("%s: post_select time: %lums\n",
98 t->status = ret < 0? ret : TS_RUNNING;
101 static unsigned sched_post_select(struct sched *s)
103 struct task *t, *tmp;
104 unsigned num_running_tasks = 0;
106 list_for_each_entry_safe(t, tmp, &s->task_list, node) {
107 if (t->status == TS_DEAD) /* task has been reaped */
108 unlink_and_free_task(t);
109 else if (t->status == TS_RUNNING) {
110 call_post_select(s, t); /* sets t->status */
112 if (t->status == TS_RUNNING)
116 return num_running_tasks;
120 * The core function of all paraslash programs.
122 * \param s Pointer to the scheduler struct.
124 * This function updates the global \a now pointer, calls all registered
125 * pre_select hooks which may set the timeout and add any file descriptors to
126 * the fd sets of \a s. Next, it calls para_select() and makes the result available
127 * to the registered tasks by calling their post_select hook.
129 * \return Zero if no more tasks are left in the task list, negative if the
130 * select function returned an error.
134 int schedule(struct sched *s)
137 unsigned num_running_tasks;
139 if (!s->select_function)
140 s->select_function = para_select;
144 s->select_timeout = s->default_timeout;
146 clock_get_realtime(&now_struct);
148 ret = s->select_function(s->max_fileno + 1, &s->rfds, &s->wfds,
154 * APUE: Be careful not to check the descriptor sets on return
155 * unless the return value is greater than zero. The return
156 * state of the descriptor sets is implementation dependent if
157 * either a signal is caught or the timer expires.
162 clock_get_realtime(&now_struct);
163 num_running_tasks = sched_post_select(s);
164 if (num_running_tasks == 0)
170 * Obtain the error status of a task and deallocate its resources.
172 * \param tptr Identifies the task to reap.
174 * This function is similar to wait(2) in that it returns information about a
175 * terminated task and allows to release the resources associated with the
176 * task. Until this function is called, the terminated task remains in a zombie
179 * \return If \a tptr is \p NULL, or \a *tptr is \p NULL, the function does
180 * nothing and returns zero. Otherwise, it is checked whether the task
181 * identified by \a tptr is still running. If it is, the function returns zero
182 * and again, no action is taken. Otherwise the (negative) error code of the
183 * terminated task is returned and \a *tptr is set to \p NULL. The task will
184 * then be removed removed from the scheduler task list.
186 * \sa \ref sched_shutdown(), wait(2).
188 int task_reap(struct task **tptr)
202 * With list_for_each_entry_safe() it is only safe to remove the
203 * _current_ list item. Since we are being called from the loop in
204 * schedule() via some task's ->post_select() function, freeing the
205 * given task here would result in use-after-free bugs in schedule().
206 * So we only set the task status to TS_DEAD which tells schedule() to
207 * free the task in the next iteration of its loop.
216 * Deallocate all resources of all tasks of a scheduler instance.
218 * \param s The scheduler instance.
220 * This should only be called after \ref schedule() has returned.
222 void sched_shutdown(struct sched *s)
224 struct task *t, *tmp;
226 list_for_each_entry_safe(t, tmp, &s->task_list, node) {
227 if (t->status == TS_RUNNING)
228 /* The task list should contain only terminated tasks. */
229 PARA_WARNING_LOG("shutting down running task %s\n",
231 unlink_and_free_task(t);
236 * Add a task to the scheduler task list.
238 * \param info Task information supplied by the caller.
239 * \param s The scheduler instance.
241 * \return A pointer to a newly allocated task structure. It will be
242 * freed by sched_shutdown().
244 struct task *task_register(struct task_info *info, struct sched *s)
246 struct task *t = para_malloc(sizeof(*t));
248 assert(info->post_select);
250 if (!s->task_list.next)
251 INIT_LIST_HEAD(&s->task_list);
254 t->name = para_strdup(info->name);
256 t->status = TS_RUNNING;
257 list_add_tail(&t->node, &s->task_list);
262 * Get the list of all registered tasks.
264 * \param s The scheduler instance to get the task list from.
266 * \return The task list.
268 * Each entry of the list contains an identifier which is simply a hex number.
269 * The result is dynamically allocated and must be freed by the caller.
271 char *get_task_list(struct sched *s)
273 struct task *t, *tmp;
276 list_for_each_entry_safe(t, tmp, &s->task_list, node) {
278 tmp_msg = make_message("%s%p\t%s\t%s\n", msg? msg : "", t,
279 t->status == TS_DEAD? "dead" :
280 (t->status == TS_RUNNING? "running" : "zombie"),
289 * Set the notification value of a task.
291 * \param t The task to notify.
292 * \param err A positive error code.
294 * Tasks which honor notifications are supposed to call \ref
295 * task_get_notification() in their post_select function and act on the
296 * returned notification value.
298 * If the scheduler detects during its pre_select loop that at least one task
299 * has been notified, the loop terminates, and the post_select methods of all
300 * taks are immediately called again.
302 * The notification for a task is reset after the call to its post_select
305 * \sa \ref task_get_notification().
307 void task_notify(struct task *t, int err)
310 if (t->notification == -err) /* ignore subsequent notifications */
312 PARA_INFO_LOG("notifying task %s: %s\n", t->name, para_strerror(err));
313 t->notification = -err;
317 * Return the notification value of a task.
319 * \param t The task to get the notification value from.
321 * \return The notification value. If this is negative, the task has been
322 * notified by another task. Tasks are supposed to check for notifications by
323 * calling this function from their post_select method.
325 * \sa \ref task_notify().
327 int task_get_notification(const struct task *t)
329 return t->notification;
333 * Return the status value of a task.
335 * \param t The task to get the status value from.
337 * \return Zero if task does not exist, one if task is running, negative error
338 * code if task has terminated.
340 int task_status(const struct task *t)
344 if (t->status == TS_DEAD) /* pretend dead tasks don't exist */
346 if (t->status == TS_RUNNING)
352 * Set the notification value of all tasks of a scheduler instance.
354 * \param s The scheduler instance whose tasks should be notified.
355 * \param err A positive error code.
357 * This simply iterates over all existing tasks of \a s and sets each
358 * task's notification value to \p -err.
360 void task_notify_all(struct sched *s, int err)
364 list_for_each_entry(t, &s->task_list, node)
369 * Set the select timeout to the minimal possible value.
371 * \param s Pointer to the scheduler struct.
373 * This causes the next select() call to return immediately.
375 void sched_min_delay(struct sched *s)
377 s->select_timeout.tv_sec = s->select_timeout.tv_usec = 0;
381 * Impose an upper bound for the timeout of the next select() call.
383 * \param to Maximal allowed timeout.
384 * \param s Pointer to the scheduler struct.
386 * If the current scheduler timeout is already smaller than \a to, this
387 * function does nothing. Otherwise the timeout for the next select() call is
388 * set to the given value.
390 * \sa \ref sched_request_timeout_ms().
392 void sched_request_timeout(struct timeval *to, struct sched *s)
394 if (tv_diff(&s->select_timeout, to, NULL) > 0)
395 s->select_timeout = *to;
399 * Force the next select() call to return before the given amount of milliseconds.
401 * \param ms The maximal allowed timeout in milliseconds.
402 * \param s Pointer to the scheduler struct.
404 * Like sched_request_timeout() this imposes an upper bound on the timeout
405 * value for the next select() call.
407 void sched_request_timeout_ms(long unsigned ms, struct sched *s)
411 sched_request_timeout(&tv, s);
415 * Force the next select() call to return before the given future time.
417 * \param barrier Absolute time before select() should return.
418 * \param s Pointer to the scheduler struct.
420 * \return If \a barrier is in the past, this function does nothing and returns
421 * zero. Otherwise it returns one.
423 * \sa \ref sched_request_barrier_or_min_delay().
425 int sched_request_barrier(struct timeval *barrier, struct sched *s)
429 if (tv_diff(now, barrier, &diff) > 0)
431 sched_request_timeout(&diff, s);
436 * Force the next select() call to return before the given time.
438 * \param barrier Absolute time before select() should return.
439 * \param s Pointer to the scheduler struct.
441 * \return If \a barrier is in the past, this function requests a minimal
442 * timeout and returns zero. Otherwise it returns one.
444 * \sa \ref sched_min_delay(), \ref sched_request_barrier().
446 int sched_request_barrier_or_min_delay(struct timeval *barrier, struct sched *s)
450 if (tv_diff(now, barrier, &diff) > 0) {
454 sched_request_timeout(&diff, s);