Subversion Repositories HelenOS

Rev

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

  1. /*
  2.  * Copyright (c) 2001-2007 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 <synch/waitq.h>
  39. #include <proc/task.h>
  40. #include <time/timeout.h>
  41. #include <cpu.h>
  42. #include <synch/rwlock.h>
  43. #include <synch/spinlock.h>
  44. #include <adt/avl.h>
  45. #include <mm/slab.h>
  46. #include <arch/cpu.h>
  47. #include <mm/tlb.h>
  48. #include <proc/uarg.h>
  49.  
  50. #define THREAD_STACK_SIZE   STACK_SIZE
  51. #define THREAD_NAME_BUFLEN  20
  52.  
  53. extern char *thread_states[];
  54.  
  55. /* Thread flags */
  56.  
  57. /** Thread cannot be migrated to another CPU.
  58.  *
  59.  * When using this flag, the caller must set cpu in the thread_t
  60.  * structure manually before calling thread_ready (even on uniprocessor).
  61.  */
  62. #define THREAD_FLAG_WIRED   (1 << 0)
  63. /** Thread was migrated to another CPU and has not run yet. */
  64. #define THREAD_FLAG_STOLEN  (1 << 1)
  65. /** Thread executes in userspace. */
  66. #define THREAD_FLAG_USPACE  (1 << 2)
  67. /** Thread will be attached by the caller. */
  68. #define THREAD_FLAG_NOATTACH    (1 << 3)
  69.  
  70. /** Thread states. */
  71. typedef enum {
  72.     /** It is an error, if thread is found in this state. */
  73.     Invalid,
  74.     /** State of a thread that is currently executing on some CPU. */
  75.     Running,
  76.     /** Thread in this state is waiting for an event. */
  77.     Sleeping,
  78.     /** State of threads in a run queue. */
  79.     Ready,
  80.     /** Threads are in this state before they are first readied. */
  81.     Entering,
  82.     /** After a thread calls thread_exit(), it is put into Exiting state. */
  83.     Exiting,
  84.     /** Threads that were not detached but exited are Lingering. */
  85.     Lingering
  86. } state_t;
  87.  
  88. /** Thread structure. There is one per thread. */
  89. typedef struct thread {
  90.     link_t rq_link;     /**< Run queue link. */
  91.     link_t wq_link;     /**< Wait queue link. */
  92.     link_t th_link;     /**< Links to threads within containing task. */
  93.  
  94.     /** Threads linkage to the threads_tree. */
  95.     avltree_node_t threads_tree_node;
  96.    
  97.     /** Lock protecting thread structure.
  98.      *
  99.      * Protects the whole thread structure except list links above.
  100.      */
  101.     SPINLOCK_DECLARE(lock);
  102.  
  103.     char name[THREAD_NAME_BUFLEN];
  104.  
  105.     /** Function implementing the thread. */
  106.     void (* thread_code)(void *);
  107.     /** Argument passed to thread_code() function. */
  108.     void *thread_arg;
  109.  
  110.     /**
  111.      * From here, the stored context is restored when the thread is
  112.      * scheduled.
  113.      */
  114.     context_t saved_context;
  115.     /**
  116.      * From here, the stored timeout context is restored when sleep times
  117.      * out.
  118.      */
  119.     context_t sleep_timeout_context;
  120.     /**
  121.      * From here, the stored interruption context is restored when sleep is
  122.      * interrupted.
  123.      */
  124.     context_t sleep_interruption_context;
  125.  
  126.     /** If true, the thread can be interrupted from sleep. */
  127.     bool sleep_interruptible;
  128.     /** Wait queue in which this thread sleeps. */
  129.     waitq_t *sleep_queue;
  130.     /** Timeout used for timeoutable sleeping.  */
  131.     timeout_t sleep_timeout;
  132.     /** Flag signalling sleep timeout in progress. */
  133.     volatile int timeout_pending;
  134.  
  135.     /**
  136.      * True if this thread is executing copy_from_uspace().
  137.      * False otherwise.
  138.      */
  139.     bool in_copy_from_uspace;
  140.     /**
  141.      * True if this thread is executing copy_to_uspace().
  142.      * False otherwise.
  143.      */
  144.     bool in_copy_to_uspace;
  145.    
  146.     /**
  147.      * If true, the thread will not go to sleep at all and will call
  148.      * thread_exit() before returning to userspace.
  149.      */
  150.     bool interrupted;          
  151.    
  152.     /** If true, thread_join_timeout() cannot be used on this thread. */
  153.     bool detached;
  154.     /** Waitq for thread_join_timeout(). */
  155.     waitq_t join_wq;
  156.     /** Link used in the joiner_head list. */
  157.     link_t joiner_link;
  158.  
  159.     fpu_context_t *saved_fpu_context;
  160.     int fpu_context_exists;
  161.  
  162.     /*
  163.      * Defined only if thread doesn't run.
  164.      * It means that fpu context is in CPU that last time executes this
  165.      * thread. This disables migration.
  166.      */
  167.     int fpu_context_engaged;
  168.  
  169.     rwlock_type_t rwlock_holder_type;
  170.  
  171.     /** Callback fired in scheduler before the thread is put asleep. */
  172.     void (* call_me)(void *);
  173.     /** Argument passed to call_me(). */
  174.     void *call_me_with;
  175.  
  176.     /** Thread's state. */
  177.     state_t state;
  178.     /** Thread's flags. */
  179.     int flags;
  180.    
  181.     /** Thread's CPU. */
  182.     cpu_t *cpu;
  183.     /** Containing task. */
  184.     task_t *task;
  185.  
  186.     /** Ticks before preemption. */
  187.     uint64_t ticks;
  188.    
  189.     /** Thread accounting. */
  190.     uint64_t cycles;
  191.     /** Last sampled cycle. */
  192.     uint64_t last_cycle;
  193.     /** Thread doesn't affect accumulated accounting. */   
  194.     bool uncounted;
  195.  
  196.     /** Thread's priority. Implemented as index to CPU->rq */
  197.     int priority;
  198.     /** Thread ID. */
  199.     thread_id_t tid;
  200.    
  201.     /** Architecture-specific data. */
  202.     thread_arch_t arch;
  203.  
  204.     /** Thread's kernel stack. */
  205.     uint8_t *kstack;
  206. } thread_t;
  207.  
  208. /** Thread list lock.
  209.  *
  210.  * This lock protects the threads_tree.
  211.  * Must be acquired before T.lock for each T of type thread_t.
  212.  *
  213.  */
  214. SPINLOCK_EXTERN(threads_lock);
  215.  
  216. /** AVL tree containing all threads. */
  217. extern avltree_t threads_tree;
  218.  
  219. extern void thread_init(void);
  220. extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task,
  221.     int flags, char *name, bool uncounted);
  222. extern void thread_attach(thread_t *t, task_t *task);
  223. extern void thread_ready(thread_t *t);
  224. extern void thread_exit(void) __attribute__((noreturn));
  225.  
  226. #ifndef thread_create_arch
  227. extern void thread_create_arch(thread_t *t);
  228. #endif
  229. #ifndef thr_constructor_arch
  230. extern void thr_constructor_arch(thread_t *t);
  231. #endif
  232. #ifndef thr_destructor_arch
  233. extern void thr_destructor_arch(thread_t *t);
  234. #endif
  235.  
  236. extern void thread_sleep(uint32_t sec);
  237. extern void thread_usleep(uint32_t usec);
  238.  
  239. #define thread_join(t) \
  240.     thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
  241. extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
  242. extern void thread_detach(thread_t *t);
  243.  
  244. extern void thread_register_call_me(void (* call_me)(void *),
  245.     void *call_me_with);
  246. extern void thread_print_list(void);
  247. extern void thread_destroy(thread_t *t);
  248. extern void thread_update_accounting(void);
  249. extern bool thread_exists(thread_t *t);
  250.  
  251. extern thread_t *thread_create_program(void *program_addr, char *name);
  252.  
  253. /** Fpu context slab cache. */
  254. extern slab_cache_t *fpu_context_slab;
  255.  
  256. /* Thread syscall prototypes. */
  257. extern unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name, thread_id_t *uspace_thread_id);
  258. extern unative_t sys_thread_exit(int uspace_status);
  259. extern unative_t sys_thread_get_id(thread_id_t *uspace_thread_id);
  260.  
  261. #endif
  262.  
  263. /** @}
  264.  */
  265.