Add some more FEC source code documentation.

[paraslash.git] / sched.c

diff --git a/sched.c b/sched.c
index 869c94c..9e346df 100644 (file)
--- a/sched.c
+++ b/sched.c
@@ -1,10 +1,10 @@
 /*
 /*

- * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>

  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 

-/** \file sched.c paraslash's scheduling functions */
+/** \file sched.c Paraslash's scheduling functions. */

 
 #include <dirent.h> /* readdir() */
 #include <assert.h>
 
 #include <dirent.h> /* readdir() */
 #include <assert.h>


@@ -27,22 +27,22 @@ struct timeval *now = &now_struct;
 /**
  * Remove a task from the scheduler.
  *
 /**
  * Remove a task from the scheduler.
  *

- * \param t the task to remove
+ * \param t The task to remove.

  *
  * If the pre_select pointer of \a t is not \p NULL, it is removed from
  * the pre_select list of the scheduler. Same goes for \a post_select.
  */
  *
  * If the pre_select pointer of \a t is not \p NULL, it is removed from
  * the pre_select list of the scheduler. Same goes for \a post_select.
  */

-void unregister_task(struct task *t)
+static void unregister_task(struct task *t)

 {
        if (!initialized)
                return;
 {
        if (!initialized)
                return;

-       PARA_INFO_LOG("unregistering %s (%p)\n", t->status, t);
+       PARA_INFO_LOG("unregistering %s (%s)\n", t->status,
+               t->error <0? para_strerror(-t->error) : "shutdown");

        if (t->pre_select)
                list_del(&t->pre_select_node);
        if (t->post_select)
                list_del(&t->post_select_node);
        if (t->pre_select)
                list_del(&t->pre_select_node);
        if (t->post_select)
                list_del(&t->post_select_node);

-       if (t->error >= 0)
-               t->error = -E_TASK_KILLED;
+       t->error = -E_TASK_UNREGISTERED;

 };
 
 
 };
 
 


@@ -50,7 +50,8 @@ static void sched_preselect(struct sched *s)
 {
        struct task *t, *tmp;
        list_for_each_entry_safe(t, tmp, &pre_select_list, pre_select_node) {
 {
        struct task *t, *tmp;
        list_for_each_entry_safe(t, tmp, &pre_select_list, pre_select_node) {

-               t->pre_select(s, t);
+               if (t->error >= 0)
+                       t->pre_select(s, t);

 //             PARA_INFO_LOG("%s \n", t->status);
                if (t->error >= 0)
                        continue;
 //             PARA_INFO_LOG("%s \n", t->status);
                if (t->error >= 0)
                        continue;


@@ -71,7 +72,8 @@ static void sched_post_select(struct sched *s)
        struct task *t, *tmp;
 
        list_for_each_entry_safe(t, tmp, &post_select_list, post_select_node) {
        struct task *t, *tmp;
 
        list_for_each_entry_safe(t, tmp, &post_select_list, post_select_node) {

-               t->post_select(s, t);
+               if (t->error >= 0)
+                       t->post_select(s, t);

 //             PARA_INFO_LOG("%s: %d\n", t->status, t->ret);
                if (t->error >= 0)
                        continue;
 //             PARA_INFO_LOG("%s: %d\n", t->status, t->ret);
                if (t->error >= 0)
                        continue;


@@ -83,9 +85,9 @@ static void sched_post_select(struct sched *s)
 }
 
 /**
 }
 
 /**

- * the core function for all paraslash programs
+ * The core function for all paraslash programs.

  *
  *

- * \param s pointer to the scheduler struct
+ * \param s Pointer to the scheduler struct.

  *
  * This function updates the global \a now pointer, calls all registered
  * pre_select hooks which may set the timeout and add any file descriptors to
  *
  * This function updates the global \a now pointer, calls all registered
  * pre_select hooks which may set the timeout and add any file descriptors to


@@ -103,6 +105,8 @@ int schedule(struct sched *s)
 
        if (!initialized)
                return -E_NOT_INITIALIZED;
 
        if (!initialized)
                return -E_NOT_INITIALIZED;

+       if (!s->select_function)
+               s->select_function = para_select;

        gettimeofday(now, NULL);
 again:
        FD_ZERO(&s->rfds);
        gettimeofday(now, NULL);
 again:
        FD_ZERO(&s->rfds);


@@ -112,7 +116,7 @@ again:
        sched_preselect(s);
        if (list_empty(&pre_select_list) && list_empty(&post_select_list))
                return 0;
        sched_preselect(s);
        if (list_empty(&pre_select_list) && list_empty(&post_select_list))
                return 0;

-       ret = para_select(s->max_fileno + 1, &s->rfds, &s->wfds, &s->timeout);
+       ret = s->select_function(s->max_fileno + 1, &s->rfds, &s->wfds, &s->timeout);

        if (ret < 0)
                return ret;
        gettimeofday(now, NULL);
        if (ret < 0)
                return ret;
        gettimeofday(now, NULL);


@@ -123,7 +127,7 @@ again:
 }
 
 /**
 }
 
 /**

- * initialize the paraslash scheduler
+ * Initialize the paraslash scheduler.

  */
 static void init_sched(void)
 {
  */
 static void init_sched(void)
 {


@@ -134,7 +138,7 @@ static void init_sched(void)
 };
 
 /**
 };
 
 /**

- * add a task to the scheduler
+ * Add a task to the scheduler.

  *
  * \param t the task to add
  *
  *
  * \param t the task to add
  *


@@ -159,7 +163,7 @@ void register_task(struct task *t)
 }
 
 /**
 }
 
 /**

- * unregister all tasks
+ * Unregister all tasks.

  *
  * This will cause \a schedule() to return immediately because both the
  * \a pre_select_list and the \a post_select_list are empty.
  *
  * This will cause \a schedule() to return immediately because both the
  * \a pre_select_list and the \a post_select_list are empty.


@@ -172,16 +176,15 @@ void sched_shutdown(void)
                return;
        list_for_each_entry_safe(t, tmp, &pre_select_list, pre_select_node)
                unregister_task(t);
                return;
        list_for_each_entry_safe(t, tmp, &pre_select_list, pre_select_node)
                unregister_task(t);

-       /* remove tasks which do not have a pre_select hook */

        list_for_each_entry_safe(t, tmp, &post_select_list, post_select_node)
                unregister_task(t);
        initialized = 0;
 };
 
 /**
        list_for_each_entry_safe(t, tmp, &post_select_list, post_select_node)
                unregister_task(t);
        initialized = 0;
 };
 
 /**

- * get the list of all registered tasks.
+ * Get the list of all registered tasks.

  *
  *

- * \return the task list
+ * \return The task list.

  *
  * Each entry of the list contains an identifier which is simply a hex number
  * that may be used in \a kill_task() to terminate the task.
  *
  * Each entry of the list contains an identifier which is simply a hex number
  * that may be used in \a kill_task() to terminate the task.


@@ -213,9 +216,9 @@ char *get_task_list(void)
 }
 
 /**
 }
 
 /**

- * simulate an error for the given task
+ * Simulate an error for the given task.

  *
  *

- * \param id the task identifier
+ * \param id The task identifier.

  *
  * Find the task identified by \a id, set the tasks' error value to
  * \p -E_TASK_KILLED and unregister the task.
  *
  * Find the task identified by \a id, set the tasks' error value to
  * \p -E_TASK_KILLED and unregister the task.


@@ -235,7 +238,6 @@ int kill_task(char *id)
                if (strcmp(id, buf))
                        continue;
                t->error = -E_TASK_KILLED;
                if (strcmp(id, buf))
                        continue;
                t->error = -E_TASK_KILLED;

-               unregister_task(t);

                return 1;
        }
        list_for_each_entry_safe(t, tmp, &post_select_list, post_select_node) {
                return 1;
        }
        list_for_each_entry_safe(t, tmp, &post_select_list, post_select_node) {


@@ -243,7 +245,6 @@ int kill_task(char *id)
                if (strcmp(id, buf))
                        continue;
                t->error = -E_TASK_KILLED;
                if (strcmp(id, buf))
                        continue;
                t->error = -E_TASK_KILLED;

-               unregister_task(t);

                return 1;
        }
        return -E_NO_SUCH_TASK;
                return 1;
        }
        return -E_NO_SUCH_TASK;