Subversion Repositories HelenOS

Rev

Rev 2071 | Rev 2093 | 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. /** @addtogroup genericproc
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef KERN_THREAD_H_
  36. #define KERN_THREAD_H_
  37.  
  38. #include <arch/proc/thread.h>
  39. #include <synch/spinlock.h>
  40. #include <arch/context.h>
  41. #include <fpu_context.h>
  42. #include <arch/types.h>
  43. #include <typedefs.h>
  44. #include <time/timeout.h>
  45. #include <synch/rwlock.h>
  46. #include <synch/synch.h>
  47. #include <config.h>
  48. #include <adt/btree.h>
  49. #include <adt/list.h>
  50. #include <mm/slab.h>
  51. #include <proc/uarg.h>
  52.  
  53. #define THREAD_STACK_SIZE   STACK_SIZE
  54.  
  55. /** Thread states. */
  56. typedef enum {
  57.     Invalid,    /**< It is an error, if thread is found in this state. */
  58.     Running,    /**< State of a thread that is currently executing on some CPU. */
  59.     Sleeping,   /**< Thread in this state is waiting for an event. */
  60.     Ready,      /**< State of threads in a run queue. */
  61.     Entering,   /**< Threads are in this state before they are first readied. */
  62.     Exiting,    /**< After a thread calls thread_exit(), it is put into Exiting state. */
  63.     Undead      /**< Threads that were not detached but exited are in the Undead state. */
  64. } state_t;
  65.  
  66. extern char *thread_states[];
  67.  
  68. /** Join types. */
  69. typedef enum {
  70.     None,
  71.     TaskClnp,   /**< The thread will be joined by ktaskclnp thread. */
  72.     TaskGC      /**< The thread will be joined by ktaskgc thread. */
  73. } thread_join_type_t;
  74.  
  75. /* Thread flags */
  76. #define THREAD_FLAG_WIRED   (1<<0)  /**< Thread cannot be migrated to another CPU. */
  77. #define THREAD_FLAG_STOLEN  (1<<1)  /**< Thread was migrated to another CPU and has not run yet. */
  78. #define THREAD_FLAG_USPACE  (1<<2)  /**< Thread executes in userspace. */
  79.  
  80. #define THREAD_NAME_BUFLEN  20
  81.  
  82. /** Thread structure. There is one per thread. */
  83. struct thread {
  84.     link_t rq_link;             /**< Run queue link. */
  85.     link_t wq_link;             /**< Wait queue link. */
  86.     link_t th_link;             /**< Links to threads within containing task. */
  87.    
  88.     /** Lock protecting thread structure.
  89.      *
  90.      * Protects the whole thread structure except list links above.
  91.      */
  92.     SPINLOCK_DECLARE(lock);
  93.  
  94.     char name[THREAD_NAME_BUFLEN];
  95.  
  96.     void (* thread_code)(void *);       /**< Function implementing the thread. */
  97.     void *thread_arg;           /**< Argument passed to thread_code() function. */
  98.  
  99.     /** From here, the stored context is restored when the thread is scheduled. */
  100.     context_t saved_context;
  101.     /** From here, the stored timeout context is restored when sleep times out. */
  102.     context_t sleep_timeout_context;
  103.     /** From here, the stored interruption context is restored when sleep is interrupted. */
  104.     context_t sleep_interruption_context;
  105.  
  106.     bool sleep_interruptible;       /**< If true, the thread can be interrupted from sleep. */
  107.     waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
  108.     timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
  109.     volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
  110.  
  111.     /** True if this thread is executing copy_from_uspace(). False otherwise. */
  112.     bool in_copy_from_uspace;
  113.     /** True if this thread is executing copy_to_uspace(). False otherwise. */
  114.     bool in_copy_to_uspace;
  115.    
  116.     /**
  117.      * If true, the thread will not go to sleep at all and will
  118.      * call thread_exit() before returning to userspace.
  119.      */
  120.     bool interrupted;          
  121.    
  122.     thread_join_type_t  join_type;  /**< Who joinins the thread. */
  123.     bool detached;              /**< If true, thread_join_timeout() cannot be used on this thread. */
  124.     waitq_t join_wq;            /**< Waitq for thread_join_timeout(). */
  125.  
  126.     fpu_context_t *saved_fpu_context;
  127.     int fpu_context_exists;
  128.  
  129.     /*
  130.      * Defined only if thread doesn't run.
  131.      * It means that fpu context is in CPU that last time executes this thread.
  132.      * This disables migration.
  133.      */
  134.     int fpu_context_engaged;
  135.  
  136.     rwlock_type_t rwlock_holder_type;
  137.  
  138.     void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
  139.     void *call_me_with;         /**< Argument passed to call_me(). */
  140.  
  141.     state_t state;              /**< Thread's state. */
  142.     int flags;              /**< Thread's flags. */
  143.    
  144.     cpu_t *cpu;             /**< Thread's CPU. */
  145.     task_t *task;               /**< Containing task. */
  146.  
  147.     uint64_t ticks;             /**< Ticks before preemption. */
  148.    
  149.     uint64_t cycles;            /**< Thread accounting. */
  150.     uint64_t last_cycle;        /**< Last sampled cycle. */
  151.     bool uncounted;             /**< Thread doesn't affect accumulated accounting. */
  152.  
  153.     int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
  154.     uint32_t tid;               /**< Thread ID. */
  155.    
  156.     thread_arch_t arch;         /**< Architecture-specific data. */
  157.  
  158.     uint8_t *kstack;            /**< Thread's kernel stack. */
  159. };
  160.  
  161. /** Thread list lock.
  162.  *
  163.  * This lock protects all link_t structures chained in threads_head.
  164.  * Must be acquired before T.lock for each T of type thread_t.
  165.  *
  166.  */
  167. extern spinlock_t threads_lock;
  168.  
  169. extern btree_t threads_btree;           /**< B+tree containing all threads. */
  170.  
  171. extern void thread_init(void);
  172. extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name, bool uncounted);
  173. extern void thread_ready(thread_t *t);
  174. extern void thread_exit(void) __attribute__((noreturn));
  175.  
  176. #ifndef thread_create_arch
  177. extern void thread_create_arch(thread_t *t);
  178. #endif
  179. #ifndef thr_constructor_arch
  180. extern void thr_constructor_arch(thread_t *t);
  181. #endif
  182. #ifndef thr_destructor_arch
  183. extern void thr_destructor_arch(thread_t *t);
  184. #endif
  185.  
  186. extern void thread_sleep(uint32_t sec);
  187. extern void thread_usleep(uint32_t usec);
  188.  
  189. #define thread_join(t)  thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
  190. extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
  191. extern void thread_detach(thread_t *t);
  192.  
  193. extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
  194. extern void thread_print_list(void);
  195. extern void thread_destroy(thread_t *t);
  196. extern void thread_update_accounting(void);
  197. extern bool thread_exists(thread_t *t);
  198.  
  199. /* Fpu context slab cache */
  200. extern slab_cache_t *fpu_context_slab;
  201.  
  202. /** Thread syscall prototypes. */
  203. unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
  204. unative_t sys_thread_exit(int uspace_status);
  205.  
  206. #endif
  207.  
  208. /** @}
  209.  */
  210.