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 <config.h>
|
---|
41 | #include <adt/btree.h>
|
---|
42 | #include <adt/list.h>
|
---|
43 | #include <mm/slab.h>
|
---|
44 | #include <proc/uarg.h>
|
---|
45 |
|
---|
46 | #define THREAD_STACK_SIZE STACK_SIZE
|
---|
47 |
|
---|
48 | enum state {
|
---|
49 | Invalid, /**< It is an error, if thread is found in this state. */
|
---|
50 | Running, /**< State of a thread that is currently executing on some CPU. */
|
---|
51 | Sleeping, /**< Thread in this state is waiting for an event. */
|
---|
52 | Ready, /**< State of threads in a run queue. */
|
---|
53 | Entering, /**< Threads are in this state before they are first readied. */
|
---|
54 | Exiting /**< After a thread calls thread_exit(), it is put into Exiting state. */
|
---|
55 | };
|
---|
56 |
|
---|
57 | extern char *thread_states[];
|
---|
58 |
|
---|
59 | #define X_WIRED (1<<0)
|
---|
60 | #define X_STOLEN (1<<1)
|
---|
61 |
|
---|
62 | #define THREAD_NAME_BUFLEN 20
|
---|
63 |
|
---|
64 | /** Thread structure. There is one per thread. */
|
---|
65 | struct thread {
|
---|
66 | link_t rq_link; /**< Run queue link. */
|
---|
67 | link_t wq_link; /**< Wait queue link. */
|
---|
68 | link_t th_link; /**< Links to threads within containing task. */
|
---|
69 |
|
---|
70 | /** Lock protecting thread structure.
|
---|
71 | *
|
---|
72 | * Protects the whole thread structure except list links above.
|
---|
73 | * Must be acquired before T.lock for each T of type task_t.
|
---|
74 | *
|
---|
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 | fpu_context_t *saved_fpu_context;
|
---|
102 | int fpu_context_exists;
|
---|
103 |
|
---|
104 | /*
|
---|
105 | * Defined only if thread doesn't run.
|
---|
106 | * It means that fpu context is in CPU that last time executes this thread.
|
---|
107 | * This disables migration
|
---|
108 | */
|
---|
109 | int fpu_context_engaged;
|
---|
110 |
|
---|
111 | rwlock_type_t rwlock_holder_type;
|
---|
112 |
|
---|
113 | void (* call_me)(void *); /**< Funtion to be called in scheduler before the thread is put asleep. */
|
---|
114 | void *call_me_with; /**< Argument passed to call_me(). */
|
---|
115 |
|
---|
116 | state_t state; /**< Thread's state. */
|
---|
117 | int flags; /**< Thread's flags. */
|
---|
118 |
|
---|
119 | cpu_t *cpu; /**< Thread's CPU. */
|
---|
120 | task_t *task; /**< Containing task. */
|
---|
121 |
|
---|
122 | __u64 ticks; /**< Ticks before preemption. */
|
---|
123 |
|
---|
124 | int priority; /**< Thread's priority. Implemented as index to CPU->rq */
|
---|
125 | __u32 tid; /**< Thread ID. */
|
---|
126 |
|
---|
127 | thread_arch_t arch; /**< Architecture-specific data. */
|
---|
128 |
|
---|
129 | __u8 *kstack; /**< Thread's kernel stack. */
|
---|
130 | };
|
---|
131 |
|
---|
132 | /** Thread list lock.
|
---|
133 | *
|
---|
134 | * This lock protects all link_t structures chained in threads_head.
|
---|
135 | * Must be acquired before T.lock for each T of type thread_t.
|
---|
136 | *
|
---|
137 | */
|
---|
138 | extern spinlock_t threads_lock;
|
---|
139 |
|
---|
140 | extern btree_t threads_btree; /**< B+tree containing all threads. */
|
---|
141 |
|
---|
142 | extern void thread_init(void);
|
---|
143 | extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
|
---|
144 | extern void thread_ready(thread_t *t);
|
---|
145 | extern void thread_exit(void);
|
---|
146 |
|
---|
147 | #ifndef thread_create_arch
|
---|
148 | extern void thread_create_arch(thread_t *t);
|
---|
149 | #endif
|
---|
150 |
|
---|
151 | extern void thread_sleep(__u32 sec);
|
---|
152 | extern void thread_usleep(__u32 usec);
|
---|
153 |
|
---|
154 | extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
|
---|
155 | extern void thread_print_list(void);
|
---|
156 | extern void thread_destroy(thread_t *t);
|
---|
157 | extern bool thread_exists(thread_t *t);
|
---|
158 |
|
---|
159 | /* Fpu context slab cache */
|
---|
160 | extern slab_cache_t *fpu_context_slab;
|
---|
161 |
|
---|
162 | /** Thread syscall prototypes. */
|
---|
163 | __native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
|
---|
164 | __native sys_thread_exit(int uspace_status);
|
---|
165 |
|
---|
166 | #endif
|
---|