Changeset 814c4f5 in mainline for kernel/generic/src/proc/task.c

Timestamp:

2008-08-24T10:47:19Z (16 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

90a428a

Parents:

1c87d79

Message:

Improve comments in task.c

File:

• kernel/generic/src/proc/task.c (modified) (10 diffs)

kernel/generic/src/proc/task.c

@@ -72 +72 @@
 static task_id_t task_counter = 0;
 
-/** Initialize tasks
- *
- * Initialize kernel tasks support.
- *
- */
+/** Initialize kernel tasks support. */
 void task_init(void)
 {
@@ -84 +80 @@
 
 /*
- * The idea behind this walker is to remember a single task different from TASK.
+ * The idea behind this walker is to remember a single task different from
+ * TASK.
  */
 static bool task_done_walker(avltree_node_t *node, void *arg)
@@ -99 +96 @@
 }
 
-/** Kill all tasks except the current task.
- *
- */
+/** Kill all tasks except the current task. */
 void task_done(void)
 {
@@ -133 +128 @@
 }
 
-/** Create new task
- *
- * Create new task with no threads.
- *
- * @param as Task's address space.
- * @param name Symbolic name.
- *
- * @return New task's structure
+/** Create new task with no threads.
+ *
+ * @param as            Task's address space.
+ * @param name          Symbolic name.
+ *
+ * @return              New task's structure.
  *
  */
@@ -195 +188 @@
 /** Destroy task.
  *
- * @param t Task to be destroyed.
+ * @param t             Task to be destroyed.
  */
 void task_destroy(task_t *t)
@@ -228 +221 @@
 /** Syscall for reading task ID from userspace.
  *
- * @param uspace_task_id Userspace address of 8-byte buffer where to store
- * current task ID.
- *
- * @return 0 on success or an error code from @ref errno.h.
+ * @param               uspace_task_id userspace address of 8-byte buffer
+ *                      where to store current task ID.
+ *
+ * @return              Zero on success or an error code from @ref errno.h.
  */
 unative_t sys_task_get_id(task_id_t *uspace_task_id)
 {
         /*
-         * No need to acquire lock on TASK because taskid
-         * remains constant for the lifespan of the task.
+         * No need to acquire lock on TASK because taskid remains constant for
+         * the lifespan of the task.
          */
         return (unative_t) copy_to_uspace(uspace_task_id, &TASK->taskid,
@@ -245 +238 @@
 /** Find task structure corresponding to task ID.
  *
- * The tasks_lock must be already held by the caller of this function
- * and interrupts must be disabled.
- *
- * @param id Task ID.
- *
- * @return Task structure address or NULL if there is no such task ID.
- */
-task_t *task_find_by_id(task_id_t id)
-{
-        avltree_node_t *node;
+ * The tasks_lock must be already held by the caller of this function and
+ * interrupts must be disabled.
+ *
+ * @param id            Task ID.
+ *
+ * @return              Task structure address or NULL if there is no such task
+ *                      ID.
+ */
+task_t *task_find_by_id(task_id_t id) { avltree_node_t *node;
         
         node = avltree_search(&tasks_tree, (avltree_key_t) id);
@@ -265 +257 @@
 /** Get accounting data of given task.
  *
- * Note that task lock of 't' must be already held and
- * interrupts must be already disabled.
- *
- * @param t Pointer to thread.
- *
+ * Note that task lock of 't' must be already held and interrupts must be
+ * already disabled.
+ *
+ * @param t             Pointer to thread.
+ *
+ * @return              Number of cycles used by the task and all its threads
+ *                      so far.
  */
 uint64_t task_get_accounting(task_t *t)
@@ -301 +295 @@
  * It signals all the task's threads to bail it out.
  *
- * @param id ID of the task to be killed.
- *
- * @return 0 on success or an error code from errno.h
+ * @param id            ID of the task to be killed.
+ *
+ * @return              Zero on success or an error code from errno.h.
  */
 int task_kill(task_id_t id)
@@ -324 +318 @@
         
         /*
-         * Interrupt all threads except ktaskclnp.
+         * Interrupt all threads.
          */
         spinlock_lock(&ta->lock);