WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/src/proc/thread.c

 #include <config.h>
 #include <arch/interrupt.h>
 #include <smp/ipi.h>
 #include <arch/faddr.h>
-char *thread_states[] = {"Invalid", "Running", "Sleeping", "Ready", "Entering", "Exiting"};
+char *thread_states[] = {"Invalid", "Running", "Sleeping", "Ready", "Entering", "Exiting"}; /**< Thread states */
 spinlock_t threads_lock;
 link_t threads_head;
 static spinlock_t tidlock;
 __u32 last_tid = 0;
+/** Thread wrapper
-/*
+ *
- * cushion() is provided to ensure that every thread
+ * This wrapper is provided to ensure that every thread
  * makes a call to thread_exit() when its implementing
  * function returns.
+ *
- * cpu_priority_high()'d
+ * cpu_priority_high() is assumed.
+ *
  */
 void cushion(void)
+{
     void (*f)(void *) = THREAD->thread_code;
     void *arg = THREAD->thread_arg;
     f(arg);
     thread_exit();
     /* not reached */
+}
+/** Initialize threads
+ *
+ * Initialize kernel threads support.
+ *
+ */
 void thread_init(void)
+{
     THREAD = NULL;
     nrdy = 0;
     spinlock_initialize(&threads_lock);
     list_initialize(&threads_head);
+}
+/** Make thread ready
+ *
+ * Switch thread t to the ready state.
+ *
+ * @param t Thread to make ready.
+ *
+ */
 void thread_ready(thread_t *t)
+{
     cpu_t *cpu;
     runq_t *r;
     pri_t pri;
     if (t->flags & X_WIRED) {
         cpu = t->cpu;
+    }
     spinlock_unlock(&t->lock);
-        /*
+    /*
      * Append t to respective ready queue on respective processor.
      */
     r = &cpu->rq[i];
     spinlock_lock(&r->lock);
     list_append(&t->rq_link, &r->rq_head);
     spinlock_unlock(&cpu->lock);
     cpu_priority_restore(pri);
+}
+/** Create new thread
+ *
+ * Create a new thread.
+ *
+ * @param func  Thread's implementing function.
+ * @param arg   Thread's implementing function argument.
+ * @param task  Task to which the thread belongs.
+ * @param flags Thread flags.
+ *
+ * @return New thread's structure on success, NULL on failure.
+ *
+ */
 thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags)
+{
     thread_t *t;
     __address frame_ks, frame_us = NULL;
+    }
     return t;
+}
+/** Make thread exiting
+ *
+ * End current thread execution and switch it to the exiting
+ * state. All pending timeouts are executed.
+ *
+ */
 void thread_exit(void)
+{
     pri_t pri;
 restart:
     THREAD->state = Exiting;
     spinlock_unlock(&THREAD->lock);
     scheduler();
+}
+/** Thread sleep
+ *
+ * Suspend execution of the current thread.
+ *
+ * @param sec Number of seconds to sleep.
+ *
+ */
 void thread_sleep(__u32 sec)
+{
         thread_usleep(sec*1000000);
+}
+/** Thread usleep
-/*
+ *
- * Suspend execution of current thread for usec microseconds.
+ * Suspend execution of the current thread.
+ *
+ * @param usec Number of microseconds to sleep.
+ *
  */
 void thread_usleep(__u32 usec)
+{
     waitq_t wq;
     waitq_initialize(&wq);
     (void) waitq_sleep_timeout(&wq, usec, SYNCH_NON_BLOCKING);
+}
+/** Register thread out-of-context invocation
+ *
+ * Register a function and its argument to be executed
+ * on next context switch to the current thread.
+ *
+ * @param call_me      Out-of-context function.
+ * @param call_me_with Out-of-context function argument.
+ *
+ */
 void thread_register_call_me(void (* call_me)(void *), void *call_me_with)
+{
     pri_t pri;
     pri = cpu_priority_high();

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/src/proc/thread.c @ 1766 – Rev 97 → 107