Subversion Repositories HelenOS-historic

Rev

Rev 452 | Rev 534 | 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/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 <config.h>
  41. #include <list.h>
  42.  
  43. #define THREAD_STACK_SIZE   STACK_SIZE
  44.  
  45. #define THREAD_USER_STACK   1
  46.  
  47. enum state {
  48.     Invalid,    /**< It is an error, if thread is found in this state. */
  49.     Running,    /**< State of a thread that is currently executing on some CPU. */
  50.     Sleeping,   /**< Thread in this state is waiting for an event. */
  51.     Ready,      /**< State of threads in a run queue. */
  52.     Entering,   /**< Threads are in this state before they are first readied. */
  53.     Exiting     /**< After a thread calls thread_exit(), it is put into Exiting state. */
  54. };
  55.  
  56. extern char *thread_states[];
  57.  
  58. #define X_WIRED     (1<<0)
  59. #define X_STOLEN    (1<<1)
  60.  
  61. struct thread {
  62.     link_t rq_link;             /**< Run queue link. */
  63.     link_t wq_link;             /**< Wait queue link. */
  64.     link_t th_link;             /**< Links to threads within containing task. */
  65.     link_t threads_link;            /**< Link to the list of all threads. */
  66.    
  67.     /* items below are protected by lock */
  68.     spinlock_t lock;
  69.  
  70.     void (* thread_code)(void *);       /**< Function implementing the thread. */
  71.     void *thread_arg;           /**< Argument passed to thread_code() function. */
  72.  
  73.     context_t saved_context;        /**< From here, the stored context is restored when the thread is scheduled. */
  74.     context_t sleep_timeout_context;    /**< From here, the stored failover context is restored when sleep times out. */
  75.  
  76.     waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
  77.     timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
  78.     volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
  79.  
  80.     fpu_context_t saved_fpu_context;
  81.     int fpu_context_exists;
  82.  
  83.     /*
  84.      * Defined only if thread doesn't run.
  85.      * It means that fpu context is in CPU that last time executes this thread.
  86.      * This disables migration
  87.      */
  88.     int fpu_context_engaged;
  89.  
  90.     rwlock_type_t rwlock_holder_type;
  91.  
  92.     void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
  93.     void *call_me_with;         /**< Argument passed to call_me(). */
  94.  
  95.     state_t state;              /**< Thread's state. */
  96.     int flags;              /**< Thread's flags. */
  97.    
  98.     cpu_t *cpu;             /**< Thread's CPU. */
  99.     task_t *task;               /**< Containing task. */
  100.  
  101.     __u64 ticks;                /**< Ticks before preemption. */
  102.  
  103.     int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
  104.     __u32 tid;              /**< Thread ID. */
  105.    
  106.     ARCH_THREAD_DATA;           /**< Architecture-specific data. */
  107.  
  108.     __u8 *kstack;               /**< Thread's kernel stack. */
  109.     __u8 *ustack;               /**< Thread's user stack. */
  110. };
  111.  
  112. extern spinlock_t threads_lock;         /**< Lock protecting threads_head list. */
  113. extern link_t threads_head;         /**< List of all threads in the system. */
  114.  
  115. extern void thread_init(void);
  116. extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags);
  117. extern void thread_ready(thread_t *t);
  118. extern void thread_exit(void);
  119.  
  120. extern void thread_sleep(__u32 sec);
  121. extern void thread_usleep(__u32 usec);
  122.  
  123. extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
  124.  
  125. #endif
  126.