Rev 2283 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2283 | Rev 2292 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2001-2004 Jakub Jermar |
2 | * Copyright (c) 2001-2004 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
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 |
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. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
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 |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
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 |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
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 |
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. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup genericproc |
29 | /** @addtogroup genericproc |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | /** @file |
32 | /** @file |
33 | */ |
33 | */ |
34 | 34 | ||
35 | #ifndef KERN_THREAD_H_ |
35 | #ifndef KERN_THREAD_H_ |
36 | #define KERN_THREAD_H_ |
36 | #define KERN_THREAD_H_ |
37 | 37 | ||
38 | #include <synch/waitq.h> |
38 | #include <synch/waitq.h> |
39 | #include <proc/task.h> |
39 | #include <proc/task.h> |
40 | #include <time/timeout.h> |
40 | #include <time/timeout.h> |
41 | #include <cpu.h> |
41 | #include <cpu.h> |
42 | #include <synch/rwlock.h> |
42 | #include <synch/rwlock.h> |
43 | #include <adt/btree.h> |
43 | #include <adt/btree.h> |
44 | #include <mm/slab.h> |
44 | #include <mm/slab.h> |
45 | #include <arch/cpu.h> |
45 | #include <arch/cpu.h> |
46 | #include <mm/tlb.h> |
46 | #include <mm/tlb.h> |
47 | #include <proc/uarg.h> |
47 | #include <proc/uarg.h> |
48 | 48 | ||
49 | #define THREAD_STACK_SIZE STACK_SIZE |
49 | #define THREAD_STACK_SIZE STACK_SIZE |
50 | #define THREAD_NAME_BUFLEN 20 |
50 | #define THREAD_NAME_BUFLEN 20 |
51 | 51 | ||
52 | extern char *thread_states[]; |
52 | extern char *thread_states[]; |
53 | 53 | ||
54 | /* Thread flags */ |
54 | /* Thread flags */ |
55 | 55 | ||
56 | /** Thread cannot be migrated to another CPU. |
56 | /** Thread cannot be migrated to another CPU. */ |
57 | * When using this flag, the caller must set cpu in the thread_t |
- | |
58 | * structure manually before calling thread_ready (even on uniprocessor) |
- | |
59 | */ |
- | |
60 | #define THREAD_FLAG_WIRED (1 << 0) |
57 | #define THREAD_FLAG_WIRED (1 << 0) |
61 | /** Thread was migrated to another CPU and has not run yet. */ |
58 | /** Thread was migrated to another CPU and has not run yet. */ |
62 | #define THREAD_FLAG_STOLEN (1 << 1) |
59 | #define THREAD_FLAG_STOLEN (1 << 1) |
63 | /** Thread executes in userspace. */ |
60 | /** Thread executes in userspace. */ |
64 | #define THREAD_FLAG_USPACE (1 << 2) |
61 | #define THREAD_FLAG_USPACE (1 << 2) |
65 | 62 | ||
66 | /** Thread states. */ |
63 | /** Thread states. */ |
67 | typedef enum { |
64 | typedef enum { |
68 | /** It is an error, if thread is found in this state. */ |
65 | /** It is an error, if thread is found in this state. */ |
69 | Invalid, |
66 | Invalid, |
70 | /** State of a thread that is currently executing on some CPU. */ |
67 | /** State of a thread that is currently executing on some CPU. */ |
71 | Running, |
68 | Running, |
72 | /** Thread in this state is waiting for an event. */ |
69 | /** Thread in this state is waiting for an event. */ |
73 | Sleeping, |
70 | Sleeping, |
74 | /** State of threads in a run queue. */ |
71 | /** State of threads in a run queue. */ |
75 | Ready, |
72 | Ready, |
76 | /** Threads are in this state before they are first readied. */ |
73 | /** Threads are in this state before they are first readied. */ |
77 | Entering, |
74 | Entering, |
78 | /** After a thread calls thread_exit(), it is put into Exiting state. */ |
75 | /** After a thread calls thread_exit(), it is put into Exiting state. */ |
79 | Exiting, |
76 | Exiting, |
80 | /** Threads that were not detached but exited are in the Undead state. */ |
77 | /** Threads that were not detached but exited are in the Undead state. */ |
81 | Undead |
78 | Undead |
82 | } state_t; |
79 | } state_t; |
83 | 80 | ||
84 | /** Join types. */ |
81 | /** Join types. */ |
85 | typedef enum { |
82 | typedef enum { |
86 | None, |
83 | None, |
87 | TaskClnp, /**< The thread will be joined by ktaskclnp thread. */ |
84 | TaskClnp, /**< The thread will be joined by ktaskclnp thread. */ |
88 | TaskGC /**< The thread will be joined by ktaskgc thread. */ |
85 | TaskGC /**< The thread will be joined by ktaskgc thread. */ |
89 | } thread_join_type_t; |
86 | } thread_join_type_t; |
90 | 87 | ||
91 | /** Thread structure. There is one per thread. */ |
88 | /** Thread structure. There is one per thread. */ |
92 | typedef struct thread { |
89 | typedef struct thread { |
93 | link_t rq_link; /**< Run queue link. */ |
90 | link_t rq_link; /**< Run queue link. */ |
94 | link_t wq_link; /**< Wait queue link. */ |
91 | link_t wq_link; /**< Wait queue link. */ |
95 | link_t th_link; /**< Links to threads within containing task. */ |
92 | link_t th_link; /**< Links to threads within containing task. */ |
96 | 93 | ||
97 | /** Lock protecting thread structure. |
94 | /** Lock protecting thread structure. |
98 | * |
95 | * |
99 | * Protects the whole thread structure except list links above. |
96 | * Protects the whole thread structure except list links above. |
100 | */ |
97 | */ |
101 | SPINLOCK_DECLARE(lock); |
98 | SPINLOCK_DECLARE(lock); |
102 | 99 | ||
103 | char name[THREAD_NAME_BUFLEN]; |
100 | char name[THREAD_NAME_BUFLEN]; |
104 | 101 | ||
105 | /** Function implementing the thread. */ |
102 | /** Function implementing the thread. */ |
106 | void (* thread_code)(void *); |
103 | void (* thread_code)(void *); |
107 | /** Argument passed to thread_code() function. */ |
104 | /** Argument passed to thread_code() function. */ |
108 | void *thread_arg; |
105 | void *thread_arg; |
109 | 106 | ||
110 | /** |
107 | /** |
111 | * From here, the stored context is restored when the thread is |
108 | * From here, the stored context is restored when the thread is |
112 | * scheduled. |
109 | * scheduled. |
113 | */ |
110 | */ |
114 | context_t saved_context; |
111 | context_t saved_context; |
115 | /** |
112 | /** |
116 | * From here, the stored timeout context is restored when sleep times |
113 | * From here, the stored timeout context is restored when sleep times |
117 | * out. |
114 | * out. |
118 | */ |
115 | */ |
119 | context_t sleep_timeout_context; |
116 | context_t sleep_timeout_context; |
120 | /** |
117 | /** |
121 | * From here, the stored interruption context is restored when sleep is |
118 | * From here, the stored interruption context is restored when sleep is |
122 | * interrupted. |
119 | * interrupted. |
123 | */ |
120 | */ |
124 | context_t sleep_interruption_context; |
121 | context_t sleep_interruption_context; |
125 | 122 | ||
126 | /** If true, the thread can be interrupted from sleep. */ |
123 | /** If true, the thread can be interrupted from sleep. */ |
127 | bool sleep_interruptible; |
124 | bool sleep_interruptible; |
128 | /** Wait queue in which this thread sleeps. */ |
125 | /** Wait queue in which this thread sleeps. */ |
129 | waitq_t *sleep_queue; |
126 | waitq_t *sleep_queue; |
130 | /** Timeout used for timeoutable sleeping. */ |
127 | /** Timeout used for timeoutable sleeping. */ |
131 | timeout_t sleep_timeout; |
128 | timeout_t sleep_timeout; |
132 | /** Flag signalling sleep timeout in progress. */ |
129 | /** Flag signalling sleep timeout in progress. */ |
133 | volatile int timeout_pending; |
130 | volatile int timeout_pending; |
134 | 131 | ||
135 | /** |
132 | /** |
136 | * True if this thread is executing copy_from_uspace(). |
133 | * True if this thread is executing copy_from_uspace(). |
137 | * False otherwise. |
134 | * False otherwise. |
138 | */ |
135 | */ |
139 | bool in_copy_from_uspace; |
136 | bool in_copy_from_uspace; |
140 | /** |
137 | /** |
141 | * True if this thread is executing copy_to_uspace(). |
138 | * True if this thread is executing copy_to_uspace(). |
142 | * False otherwise. |
139 | * False otherwise. |
143 | */ |
140 | */ |
144 | bool in_copy_to_uspace; |
141 | bool in_copy_to_uspace; |
145 | 142 | ||
146 | /** |
143 | /** |
147 | * If true, the thread will not go to sleep at all and will call |
144 | * If true, the thread will not go to sleep at all and will call |
148 | * thread_exit() before returning to userspace. |
145 | * thread_exit() before returning to userspace. |
149 | */ |
146 | */ |
150 | bool interrupted; |
147 | bool interrupted; |
151 | 148 | ||
152 | /** Who joinins the thread. */ |
149 | /** Who joinins the thread. */ |
153 | thread_join_type_t join_type; |
150 | thread_join_type_t join_type; |
154 | /** If true, thread_join_timeout() cannot be used on this thread. */ |
151 | /** If true, thread_join_timeout() cannot be used on this thread. */ |
155 | bool detached; |
152 | bool detached; |
156 | /** Waitq for thread_join_timeout(). */ |
153 | /** Waitq for thread_join_timeout(). */ |
157 | waitq_t join_wq; |
154 | waitq_t join_wq; |
158 | 155 | ||
159 | fpu_context_t *saved_fpu_context; |
156 | fpu_context_t *saved_fpu_context; |
160 | int fpu_context_exists; |
157 | int fpu_context_exists; |
161 | 158 | ||
162 | /* |
159 | /* |
163 | * Defined only if thread doesn't run. |
160 | * Defined only if thread doesn't run. |
164 | * It means that fpu context is in CPU that last time executes this |
161 | * It means that fpu context is in CPU that last time executes this |
165 | * thread. This disables migration. |
162 | * thread. This disables migration. |
166 | */ |
163 | */ |
167 | int fpu_context_engaged; |
164 | int fpu_context_engaged; |
168 | 165 | ||
169 | rwlock_type_t rwlock_holder_type; |
166 | rwlock_type_t rwlock_holder_type; |
170 | 167 | ||
171 | /** Callback fired in scheduler before the thread is put asleep. */ |
168 | /** Callback fired in scheduler before the thread is put asleep. */ |
172 | void (* call_me)(void *); |
169 | void (* call_me)(void *); |
173 | /** Argument passed to call_me(). */ |
170 | /** Argument passed to call_me(). */ |
174 | void *call_me_with; |
171 | void *call_me_with; |
175 | 172 | ||
176 | /** Thread's state. */ |
173 | /** Thread's state. */ |
177 | state_t state; |
174 | state_t state; |
178 | /** Thread's flags. */ |
175 | /** Thread's flags. */ |
179 | int flags; |
176 | int flags; |
180 | 177 | ||
181 | /** Thread's CPU. */ |
178 | /** Thread's CPU. */ |
182 | cpu_t *cpu; |
179 | cpu_t *cpu; |
183 | /** Containing task. */ |
180 | /** Containing task. */ |
184 | task_t *task; |
181 | task_t *task; |
185 | 182 | ||
186 | /** Ticks before preemption. */ |
183 | /** Ticks before preemption. */ |
187 | uint64_t ticks; |
184 | uint64_t ticks; |
188 | 185 | ||
189 | /** Thread accounting. */ |
186 | /** Thread accounting. */ |
190 | uint64_t cycles; |
187 | uint64_t cycles; |
191 | /** Last sampled cycle. */ |
188 | /** Last sampled cycle. */ |
192 | uint64_t last_cycle; |
189 | uint64_t last_cycle; |
193 | /** Thread doesn't affect accumulated accounting. */ |
190 | /** Thread doesn't affect accumulated accounting. */ |
194 | bool uncounted; |
191 | bool uncounted; |
195 | 192 | ||
196 | /** Thread's priority. Implemented as index to CPU->rq */ |
193 | /** Thread's priority. Implemented as index to CPU->rq */ |
197 | int priority; |
194 | int priority; |
198 | /** Thread ID. */ |
195 | /** Thread ID. */ |
199 | uint32_t tid; |
196 | uint32_t tid; |
200 | 197 | ||
201 | /** Architecture-specific data. */ |
198 | /** Architecture-specific data. */ |
202 | thread_arch_t arch; |
199 | thread_arch_t arch; |
203 | 200 | ||
204 | /** Thread's kernel stack. */ |
201 | /** Thread's kernel stack. */ |
205 | uint8_t *kstack; |
202 | uint8_t *kstack; |
206 | } thread_t; |
203 | } thread_t; |
207 | 204 | ||
208 | /** Thread list lock. |
205 | /** Thread list lock. |
209 | * |
206 | * |
210 | * This lock protects all link_t structures chained in threads_head. |
207 | * This lock protects all link_t structures chained in threads_head. |
211 | * Must be acquired before T.lock for each T of type thread_t. |
208 | * Must be acquired before T.lock for each T of type thread_t. |
212 | * |
209 | * |
213 | */ |
210 | */ |
214 | SPINLOCK_EXTERN(threads_lock); |
211 | SPINLOCK_EXTERN(threads_lock); |
215 | 212 | ||
216 | /** B+tree containing all threads. */ |
213 | /** B+tree containing all threads. */ |
217 | extern btree_t threads_btree; |
214 | extern btree_t threads_btree; |
218 | 215 | ||
219 | extern void thread_init(void); |
216 | extern void thread_init(void); |
220 | extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, |
217 | extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, |
221 | int flags, char *name, bool uncounted); |
218 | int flags, char *name, bool uncounted); |
222 | extern void thread_ready(thread_t *t); |
219 | extern void thread_ready(thread_t *t); |
223 | extern void thread_exit(void) __attribute__((noreturn)); |
220 | extern void thread_exit(void) __attribute__((noreturn)); |
224 | 221 | ||
225 | #ifndef thread_create_arch |
222 | #ifndef thread_create_arch |
226 | extern void thread_create_arch(thread_t *t); |
223 | extern void thread_create_arch(thread_t *t); |
227 | #endif |
224 | #endif |
228 | #ifndef thr_constructor_arch |
225 | #ifndef thr_constructor_arch |
229 | extern void thr_constructor_arch(thread_t *t); |
226 | extern void thr_constructor_arch(thread_t *t); |
230 | #endif |
227 | #endif |
231 | #ifndef thr_destructor_arch |
228 | #ifndef thr_destructor_arch |
232 | extern void thr_destructor_arch(thread_t *t); |
229 | extern void thr_destructor_arch(thread_t *t); |
233 | #endif |
230 | #endif |
234 | 231 | ||
235 | extern void thread_sleep(uint32_t sec); |
232 | extern void thread_sleep(uint32_t sec); |
236 | extern void thread_usleep(uint32_t usec); |
233 | extern void thread_usleep(uint32_t usec); |
237 | 234 | ||
238 | #define thread_join(t) \ |
235 | #define thread_join(t) \ |
239 | thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE) |
236 | thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE) |
240 | extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags); |
237 | extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags); |
241 | extern void thread_detach(thread_t *t); |
238 | extern void thread_detach(thread_t *t); |
242 | 239 | ||
243 | extern void thread_register_call_me(void (* call_me)(void *), |
240 | extern void thread_register_call_me(void (* call_me)(void *), |
244 | void *call_me_with); |
241 | void *call_me_with); |
245 | extern void thread_print_list(void); |
242 | extern void thread_print_list(void); |
246 | extern void thread_destroy(thread_t *t); |
243 | extern void thread_destroy(thread_t *t); |
247 | extern void thread_update_accounting(void); |
244 | extern void thread_update_accounting(void); |
248 | extern bool thread_exists(thread_t *t); |
245 | extern bool thread_exists(thread_t *t); |
249 | 246 | ||
250 | /** Fpu context slab cache. */ |
247 | /** Fpu context slab cache. */ |
251 | extern slab_cache_t *fpu_context_slab; |
248 | extern slab_cache_t *fpu_context_slab; |
252 | 249 | ||
253 | /* Thread syscall prototypes. */ |
250 | /* Thread syscall prototypes. */ |
254 | unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name); |
251 | unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name); |
255 | unative_t sys_thread_exit(int uspace_status); |
252 | unative_t sys_thread_exit(int uspace_status); |
256 | 253 | ||
257 | #endif |
254 | #endif |
258 | 255 | ||
259 | /** @} |
256 | /** @} |
260 | */ |
257 | */ |
261 | 258 |