Subversion Repositories HelenOS-historic

Rev

Rev 1579 | Rev 1661 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2001-2004 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. #ifndef __THREAD_H__
  30. #define __THREAD_H__
  31.  
  32. #include <arch/proc/thread.h>
  33. #include <synch/spinlock.h>
  34. #include <arch/context.h>
  35. #include <fpu_context.h>
  36. #include <arch/types.h>
  37. #include <typedefs.h>
  38. #include <time/timeout.h>
  39. #include <synch/rwlock.h>
  40. #include <synch/synch.h>
  41. #include <config.h>
  42. #include <adt/btree.h>
  43. #include <adt/list.h>
  44. #include <mm/slab.h>
  45. #include <proc/uarg.h>
  46.  
  47. #define THREAD_STACK_SIZE   STACK_SIZE
  48.  
  49. enum state {
  50.     Invalid,    /**< It is an error, if thread is found in this state. */
  51.     Running,    /**< State of a thread that is currently executing on some CPU. */
  52.     Sleeping,   /**< Thread in this state is waiting for an event. */
  53.     Ready,      /**< State of threads in a run queue. */
  54.     Entering,   /**< Threads are in this state before they are first readied. */
  55.     Exiting,    /**< After a thread calls thread_exit(), it is put into Exiting state. */
  56.     Undead      /**< Threads that were not detached but exited are in the Undead state. */
  57. };
  58.  
  59. extern char *thread_states[];
  60.  
  61. #define X_WIRED     (1<<0)
  62. #define X_STOLEN    (1<<1)
  63.  
  64. #define THREAD_NAME_BUFLEN  20
  65.  
  66. /** Thread structure. There is one per thread. */
  67. struct thread {
  68.     link_t rq_link;             /**< Run queue link. */
  69.     link_t wq_link;             /**< Wait queue link. */
  70.     link_t th_link;             /**< Links to threads within containing task. */
  71.    
  72.     /** Lock protecting thread structure.
  73.      *
  74.      * Protects the whole thread structure except list links above.
  75.      */
  76.     SPINLOCK_DECLARE(lock);
  77.  
  78.     char name[THREAD_NAME_BUFLEN];
  79.  
  80.     void (* thread_code)(void *);       /**< Function implementing the thread. */
  81.     void *thread_arg;           /**< Argument passed to thread_code() function. */
  82.  
  83.     /** From here, the stored context is restored when the thread is scheduled. */
  84.     context_t saved_context;
  85.     /** From here, the stored timeout context is restored when sleep times out. */
  86.     context_t sleep_timeout_context;
  87.     /** From here, the stored interruption context is restored when sleep is interrupted. */
  88.     context_t sleep_interruption_context;
  89.  
  90.     bool sleep_interruptible;       /**< If true, the thread can be interrupted from sleep. */
  91.     waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
  92.     timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
  93.     volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
  94.  
  95.     /** True if this thread is executing copy_from_uspace(). False otherwise. */
  96.     bool in_copy_from_uspace;
  97.     /** True if this thread is executing copy_to_uspace(). False otherwise. */
  98.     bool in_copy_to_uspace;
  99.    
  100.     /**
  101.      * If true, the thread will not go to sleep at all and will
  102.      * call thread_exit() before returning to userspace.
  103.      */
  104.     bool interrupted;          
  105.    
  106.     bool detached;              /**< If true, thread_join_timeout() cannot be used on this thread. */
  107.     waitq_t join_wq;            /**< Waitq for thread_join_timeout(). */
  108.  
  109.     fpu_context_t *saved_fpu_context;
  110.     int fpu_context_exists;
  111.  
  112.     /*
  113.      * Defined only if thread doesn't run.
  114.      * It means that fpu context is in CPU that last time executes this thread.
  115.      * This disables migration
  116.      */
  117.     int fpu_context_engaged;
  118.  
  119.     rwlock_type_t rwlock_holder_type;
  120.  
  121.     void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
  122.     void *call_me_with;         /**< Argument passed to call_me(). */
  123.  
  124.     state_t state;              /**< Thread's state. */
  125.     int flags;              /**< Thread's flags. */
  126.    
  127.     cpu_t *cpu;             /**< Thread's CPU. */
  128.     task_t *task;               /**< Containing task. */
  129.  
  130.     __u64 ticks;                /**< Ticks before preemption. */
  131.  
  132.     int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
  133.     __u32 tid;              /**< Thread ID. */
  134.    
  135.     thread_arch_t arch;         /**< Architecture-specific data. */
  136.  
  137.     __u8 *kstack;               /**< Thread's kernel stack. */
  138. };
  139.  
  140. /** Thread list lock.
  141.  *
  142.  * This lock protects all link_t structures chained in threads_head.
  143.  * Must be acquired before T.lock for each T of type thread_t.
  144.  *
  145.  */
  146. extern spinlock_t threads_lock;
  147.  
  148. extern btree_t threads_btree;           /**< B+tree containing all threads. */
  149.  
  150. extern void thread_init(void);
  151. extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
  152. extern void thread_ready(thread_t *t);
  153. extern void thread_exit(void) __attribute__((noreturn));
  154.  
  155. #ifndef thread_create_arch
  156. extern void thread_create_arch(thread_t *t);
  157. #endif
  158.  
  159. extern void thread_sleep(__u32 sec);
  160. extern void thread_usleep(__u32 usec);
  161.  
  162. #define thread_join(t)  thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
  163. extern int thread_join_timeout(thread_t *t, __u32 usec, int flags);
  164. extern void thread_detach(thread_t *t);
  165.  
  166. extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
  167. extern void thread_print_list(void);
  168. extern void thread_destroy(thread_t *t);
  169. extern bool thread_exists(thread_t *t);
  170.  
  171. /* Fpu context slab cache */
  172. extern slab_cache_t *fpu_context_slab;
  173.  
  174. /** Thread syscall prototypes. */
  175. __native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
  176. __native sys_thread_exit(int uspace_status);
  177.  
  178. #endif
  179.