Rev 2839 | Rev 2898 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
1 | jermar | 1 | /* |
2446 | jermar | 2 | * Copyright (c) 2001-2007 Jakub Jermar |
1 | 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 | |||
1820 | decky | 29 | /** @addtogroup genericproc |
1702 | cejka | 30 | * @{ |
31 | */ |
||
32 | /** @file |
||
33 | */ |
||
34 | |||
1888 | jermar | 35 | #ifndef KERN_THREAD_H_ |
36 | #define KERN_THREAD_H_ |
||
1 | jermar | 37 | |
2089 | decky | 38 | #include <synch/waitq.h> |
39 | #include <proc/task.h> |
||
2103 | decky | 40 | #include <time/timeout.h> |
2089 | decky | 41 | #include <cpu.h> |
1 | jermar | 42 | #include <synch/rwlock.h> |
2446 | jermar | 43 | #include <synch/spinlock.h> |
2502 | jermar | 44 | #include <adt/avl.h> |
906 | palkovsky | 45 | #include <mm/slab.h> |
2089 | decky | 46 | #include <arch/cpu.h> |
47 | #include <mm/tlb.h> |
||
1078 | jermar | 48 | #include <proc/uarg.h> |
1 | jermar | 49 | |
173 | jermar | 50 | #define THREAD_STACK_SIZE STACK_SIZE |
2096 | decky | 51 | #define THREAD_NAME_BUFLEN 20 |
1 | jermar | 52 | |
53 | extern char *thread_states[]; |
||
54 | |||
1854 | jermar | 55 | /* Thread flags */ |
1 | jermar | 56 | |
2268 | jermar | 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 | */ |
||
2106 | jermar | 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) |
||
2440 | jermar | 67 | /** Thread will be attached by the caller. */ |
68 | #define THREAD_FLAG_NOATTACH (1 << 3) |
||
2106 | jermar | 69 | |
2103 | decky | 70 | /** Thread states. */ |
71 | typedef enum { |
||
2106 | jermar | 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, |
||
2451 | jermar | 84 | /** Threads that were not detached but exited are Lingering. */ |
85 | Lingering |
||
2103 | decky | 86 | } state_t; |
87 | |||
2096 | decky | 88 | /** Thread structure. There is one per thread. */ |
89 | typedef struct thread { |
||
2106 | jermar | 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. */ |
||
2502 | jermar | 93 | |
94 | /** Threads linkage to the threads_tree. */ |
||
95 | avltree_node_t threads_tree_node; |
||
2096 | decky | 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 | |||
2106 | jermar | 105 | /** Function implementing the thread. */ |
106 | void (* thread_code)(void *); |
||
107 | /** Argument passed to thread_code() function. */ |
||
108 | void *thread_arg; |
||
2096 | decky | 109 | |
2106 | jermar | 110 | /** |
111 | * From here, the stored context is restored when the thread is |
||
112 | * scheduled. |
||
113 | */ |
||
2096 | decky | 114 | context_t saved_context; |
2106 | jermar | 115 | /** |
116 | * From here, the stored timeout context is restored when sleep times |
||
117 | * out. |
||
118 | */ |
||
2096 | decky | 119 | context_t sleep_timeout_context; |
2106 | jermar | 120 | /** |
121 | * From here, the stored interruption context is restored when sleep is |
||
122 | * interrupted. |
||
123 | */ |
||
2096 | decky | 124 | context_t sleep_interruption_context; |
125 | |||
2106 | jermar | 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; |
||
2096 | decky | 134 | |
2106 | jermar | 135 | /** |
136 | * True if this thread is executing copy_from_uspace(). |
||
137 | * False otherwise. |
||
138 | */ |
||
2096 | decky | 139 | bool in_copy_from_uspace; |
2106 | jermar | 140 | /** |
141 | * True if this thread is executing copy_to_uspace(). |
||
142 | * False otherwise. |
||
143 | */ |
||
2096 | decky | 144 | bool in_copy_to_uspace; |
145 | |||
146 | /** |
||
2106 | jermar | 147 | * If true, the thread will not go to sleep at all and will call |
148 | * thread_exit() before returning to userspace. |
||
2096 | decky | 149 | */ |
150 | bool interrupted; |
||
151 | |||
2106 | jermar | 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; |
||
2446 | jermar | 156 | /** Link used in the joiner_head list. */ |
157 | link_t joiner_link; |
||
2096 | decky | 158 | |
159 | fpu_context_t *saved_fpu_context; |
||
160 | int fpu_context_exists; |
||
161 | |||
162 | /* |
||
163 | * Defined only if thread doesn't run. |
||
2106 | jermar | 164 | * It means that fpu context is in CPU that last time executes this |
165 | * thread. This disables migration. |
||
2096 | decky | 166 | */ |
167 | int fpu_context_engaged; |
||
168 | |||
169 | rwlock_type_t rwlock_holder_type; |
||
170 | |||
2106 | jermar | 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; |
||
2096 | decky | 175 | |
2106 | jermar | 176 | /** Thread's state. */ |
177 | state_t state; |
||
178 | /** Thread's flags. */ |
||
179 | int flags; |
||
2096 | decky | 180 | |
2106 | jermar | 181 | /** Thread's CPU. */ |
182 | cpu_t *cpu; |
||
183 | /** Containing task. */ |
||
184 | task_t *task; |
||
2096 | decky | 185 | |
2106 | jermar | 186 | /** Ticks before preemption. */ |
187 | uint64_t ticks; |
||
2096 | decky | 188 | |
2106 | jermar | 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; |
||
2096 | decky | 195 | |
2106 | jermar | 196 | /** Thread's priority. Implemented as index to CPU->rq */ |
197 | int priority; |
||
198 | /** Thread ID. */ |
||
2216 | decky | 199 | thread_id_t tid; |
2096 | decky | 200 | |
2106 | jermar | 201 | /** Architecture-specific data. */ |
202 | thread_arch_t arch; |
||
2096 | decky | 203 | |
2106 | jermar | 204 | /** Thread's kernel stack. */ |
205 | uint8_t *kstack; |
||
2801 | svoboda | 206 | |
207 | /** Debugging stuff */ |
||
2848 | svoboda | 208 | SPINLOCK_DECLARE(debug_lock); |
2801 | svoboda | 209 | waitq_t go_wq; |
2826 | svoboda | 210 | call_t *debug_go_call; |
2805 | svoboda | 211 | unative_t syscall_args[6]; |
2817 | svoboda | 212 | istate_t *uspace_state; |
2825 | svoboda | 213 | bool debug_stop; |
2827 | svoboda | 214 | bool debug_active; /**< In a debugging session */ |
2096 | decky | 215 | } thread_t; |
216 | |||
557 | jermar | 217 | /** Thread list lock. |
218 | * |
||
2502 | jermar | 219 | * This lock protects the threads_tree. |
557 | jermar | 220 | * Must be acquired before T.lock for each T of type thread_t. |
221 | * |
||
222 | */ |
||
2093 | decky | 223 | SPINLOCK_EXTERN(threads_lock); |
557 | jermar | 224 | |
2502 | jermar | 225 | /** AVL tree containing all threads. */ |
226 | extern avltree_t threads_tree; |
||
1 | jermar | 227 | |
228 | extern void thread_init(void); |
||
2106 | jermar | 229 | extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, |
230 | int flags, char *name, bool uncounted); |
||
2440 | jermar | 231 | extern void thread_attach(thread_t *t, task_t *task); |
2839 | svoboda | 232 | extern int thread_attach_by_id(thread_t *t, task_id_t taskid); |
1 | jermar | 233 | extern void thread_ready(thread_t *t); |
1595 | palkovsky | 234 | extern void thread_exit(void) __attribute__((noreturn)); |
1 | jermar | 235 | |
1171 | jermar | 236 | #ifndef thread_create_arch |
237 | extern void thread_create_arch(thread_t *t); |
||
238 | #endif |
||
1854 | jermar | 239 | #ifndef thr_constructor_arch |
240 | extern void thr_constructor_arch(thread_t *t); |
||
241 | #endif |
||
242 | #ifndef thr_destructor_arch |
||
243 | extern void thr_destructor_arch(thread_t *t); |
||
244 | #endif |
||
1171 | jermar | 245 | |
1780 | jermar | 246 | extern void thread_sleep(uint32_t sec); |
247 | extern void thread_usleep(uint32_t usec); |
||
1 | jermar | 248 | |
2106 | jermar | 249 | #define thread_join(t) \ |
250 | thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE) |
||
1780 | jermar | 251 | extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags); |
1571 | jermar | 252 | extern void thread_detach(thread_t *t); |
253 | |||
2106 | jermar | 254 | extern void thread_register_call_me(void (* call_me)(void *), |
255 | void *call_me_with); |
||
777 | palkovsky | 256 | extern void thread_print_list(void); |
787 | palkovsky | 257 | extern void thread_destroy(thread_t *t); |
2839 | svoboda | 258 | extern void thread_unattached_free(thread_t *t); |
2030 | decky | 259 | extern void thread_update_accounting(void); |
1158 | jermar | 260 | extern bool thread_exists(thread_t *t); |
1 | jermar | 261 | |
2106 | jermar | 262 | /** Fpu context slab cache. */ |
906 | palkovsky | 263 | extern slab_cache_t *fpu_context_slab; |
264 | |||
2106 | jermar | 265 | /* Thread syscall prototypes. */ |
2216 | decky | 266 | extern unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name, thread_id_t *uspace_thread_id); |
267 | extern unative_t sys_thread_exit(int uspace_status); |
||
268 | extern unative_t sys_thread_get_id(thread_id_t *uspace_thread_id); |
||
1066 | jermar | 269 | |
1 | jermar | 270 | #endif |
1702 | cejka | 271 | |
1820 | decky | 272 | /** @} |
1702 | cejka | 273 | */ |