WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/proc/thread.h

 #define THREAD_NAME_BUFLEN  20
 extern char *thread_states[];
 /* Thread flags */
-#define THREAD_FLAG_WIRED   (1 << 0)    /**< Thread cannot be migrated to another CPU. */
+/** Thread cannot be migrated to another CPU. */
+#define THREAD_FLAG_WIRED   (1 << 0)
-#define THREAD_FLAG_STOLEN  (1 << 1)    /**< Thread was migrated to another CPU and has not run yet. */
+/** Thread was migrated to another CPU and has not run yet. */
+#define THREAD_FLAG_STOLEN  (1 << 1)
-#define THREAD_FLAG_USPACE  (1 << 2)    /**< Thread executes in userspace. */
+/** Thread executes in userspace. */
+#define THREAD_FLAG_USPACE  (1 << 2)
 /** Thread states. */
 typedef enum {
-    Invalid,    /**< It is an error, if thread is found in this state. */
+    /** It is an error, if thread is found in this state. */
+    Invalid,
-    Running,    /**< State of a thread that is currently executing on some CPU. */
+    /** State of a thread that is currently executing on some CPU. */
+    Running,
-    Sleeping,   /**< Thread in this state is waiting for an event. */
+    /** Thread in this state is waiting for an event. */
+    Sleeping,
-    Ready,      /**< State of threads in a run queue. */
+    /** State of threads in a run queue. */
+    Ready,
-    Entering,   /**< Threads are in this state before they are first readied. */
+    /** Threads are in this state before they are first readied. */
+    Entering,
-    Exiting,    /**< After a thread calls thread_exit(), it is put into Exiting state. */
+    /** After a thread calls thread_exit(), it is put into Exiting state. */
+    Exiting,
-    Undead      /**< Threads that were not detached but exited are in the Undead state. */
+    /** Threads that were not detached but exited are in the Undead state. */
+    Undead
 } state_t;
 /** Join types. */
 typedef enum {
     None,
     TaskGC      /**< The thread will be joined by ktaskgc thread. */
 } thread_join_type_t;
 /** Thread structure. There is one per thread. */
 typedef struct thread {
-    link_t rq_link;             /**< Run queue link. */
+    link_t rq_link;     /**< Run queue link. */
-    link_t wq_link;             /**< Wait queue link. */
+    link_t wq_link;     /**< Wait queue link. */
-    link_t th_link;             /**< Links to threads within containing task. */
+    link_t th_link;     /**< Links to threads within containing task. */
     /** Lock protecting thread structure.
+     *
      * Protects the whole thread structure except list links above.
      */
     SPINLOCK_DECLARE(lock);
     char name[THREAD_NAME_BUFLEN];
-    void (* thread_code)(void *);       /**< Function implementing the thread. */
+    /** Function implementing the thread. */
+    void (* thread_code)(void *);
-    void *thread_arg;           /**< Argument passed to thread_code() function. */
+    /** Argument passed to thread_code() function. */
+    void *thread_arg;
+    /**
-    /** From here, the stored context is restored when the thread is scheduled. */
+     * From here, the stored context is restored when the thread is
+     * scheduled.
+     */
     context_t saved_context;
+    /**
-    /** From here, the stored timeout context is restored when sleep times out. */
+     * From here, the stored timeout context is restored when sleep times
+     * out.
+     */
     context_t sleep_timeout_context;
+    /**
-    /** From here, the stored interruption context is restored when sleep is interrupted. */
+     * From here, the stored interruption context is restored when sleep is
+     * interrupted.
+     */
     context_t sleep_interruption_context;
-    bool sleep_interruptible;       /**< If true, the thread can be interrupted from sleep. */
+    /** If true, the thread can be interrupted from sleep. */
+    bool sleep_interruptible;
-    waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
+    /** Wait queue in which this thread sleeps. */
+    waitq_t *sleep_queue;
-    timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
+    /** Timeout used for timeoutable sleeping.  */
+    timeout_t sleep_timeout;
-    volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
+    /** Flag signalling sleep timeout in progress. */
+    volatile int timeout_pending;
+    /**
-    /** True if this thread is executing copy_from_uspace(). False otherwise. */
+     * True if this thread is executing copy_from_uspace().
+     * False otherwise.
+     */
     bool in_copy_from_uspace;
+    /**
-    /** True if this thread is executing copy_to_uspace(). False otherwise. */
+     * True if this thread is executing copy_to_uspace().
+     * False otherwise.
+     */
     bool in_copy_to_uspace;
     /**
-     * If true, the thread will not go to sleep at all and will
+     * If true, the thread will not go to sleep at all and will call
-     * call thread_exit() before returning to userspace.
+     * thread_exit() before returning to userspace.
      */
     bool interrupted;
-    thread_join_type_t  join_type;  /**< Who joinins the thread. */
+    /** Who joinins the thread. */
+    thread_join_type_t join_type;
-    bool detached;              /**< If true, thread_join_timeout() cannot be used on this thread. */
+    /** If true, thread_join_timeout() cannot be used on this thread. */
+    bool detached;
-    waitq_t join_wq;            /**< Waitq for thread_join_timeout(). */
+    /** Waitq for thread_join_timeout(). */
+    waitq_t join_wq;
     fpu_context_t *saved_fpu_context;
     int fpu_context_exists;
     /*
      * Defined only if thread doesn't run.
-     * It means that fpu context is in CPU that last time executes this thread.
+     * It means that fpu context is in CPU that last time executes this
-     * This disables migration.
+     * thread. This disables migration.
      */
     int fpu_context_engaged;
     rwlock_type_t rwlock_holder_type;
-    void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
+    /** Callback fired in scheduler before the thread is put asleep. */
+    void (* call_me)(void *);
-    void *call_me_with;         /**< Argument passed to call_me(). */
+    /** Argument passed to call_me(). */
+    void *call_me_with;
-    state_t state;              /**< Thread's state. */
+    /** Thread's state. */
+    state_t state;
-    int flags;              /**< Thread's flags. */
+    /** Thread's flags. */
+    int flags;
-    cpu_t *cpu;             /**< Thread's CPU. */
+    /** Thread's CPU. */
+    cpu_t *cpu;
-    task_t *task;               /**< Containing task. */
+    /** Containing task. */
+    task_t *task;
-    uint64_t ticks;             /**< Ticks before preemption. */
+    /** Ticks before preemption. */
+    uint64_t ticks;
-    uint64_t cycles;            /**< Thread accounting. */
+    /** Thread accounting. */
+    uint64_t cycles;
-    uint64_t last_cycle;        /**< Last sampled cycle. */
+    /** Last sampled cycle. */
+    uint64_t last_cycle;
-    bool uncounted;             /**< Thread doesn't affect accumulated accounting. */
+    /** Thread doesn't affect accumulated accounting. */
+    bool uncounted;
-    int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
+    /** Thread's priority. Implemented as index to CPU->rq */
+    int priority;
-    uint32_t tid;               /**< Thread ID. */
+    /** Thread ID. */
+    uint32_t tid;
-    thread_arch_t arch;         /**< Architecture-specific data. */
+    /** Architecture-specific data. */
+    thread_arch_t arch;
-    uint8_t *kstack;            /**< Thread's kernel stack. */
+    /** Thread's kernel stack. */
+    uint8_t *kstack;
 } thread_t;
 /** Thread list lock.
+ *
  * This lock protects all link_t structures chained in threads_head.
  * Must be acquired before T.lock for each T of type thread_t.
+ *
  */
 SPINLOCK_EXTERN(threads_lock);
-extern btree_t threads_btree;           /**< B+tree containing all threads. */
+/** B+tree containing all threads. */
+extern btree_t threads_btree;
 extern void thread_init(void);
-extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name, bool uncounted);
+extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task,
+    int flags, char *name, bool uncounted);
 extern void thread_ready(thread_t *t);
 extern void thread_exit(void) __attribute__((noreturn));
 #ifndef thread_create_arch
 extern void thread_create_arch(thread_t *t);
 #endif
 extern void thread_sleep(uint32_t sec);
 extern void thread_usleep(uint32_t usec);
+#define thread_join(t) \
-#define thread_join(t)  thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
+    thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
 extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
 extern void thread_detach(thread_t *t);
-extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
+extern void thread_register_call_me(void (* call_me)(void *),
+    void *call_me_with);
 extern void thread_print_list(void);
 extern void thread_destroy(thread_t *t);
 extern void thread_update_accounting(void);
 extern bool thread_exists(thread_t *t);
 extern void thread_interrupt_sleep(thread_t *t);
-/* Fpu context slab cache */
+/** Fpu context slab cache. */
 extern slab_cache_t *fpu_context_slab;
-/** Thread syscall prototypes. */
+/* Thread syscall prototypes. */
 unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
 unative_t sys_thread_exit(int uspace_status);
 #endif

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/proc/thread.h – Rev 2103 → 2106