Rev 2031 | Rev 2071 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2031 | Rev 2042 | ||
---|---|---|---|
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 <arch/proc/thread.h> |
38 | #include <arch/proc/thread.h> |
39 | #include <synch/spinlock.h> |
39 | #include <synch/spinlock.h> |
40 | #include <arch/context.h> |
40 | #include <arch/context.h> |
41 | #include <fpu_context.h> |
41 | #include <fpu_context.h> |
42 | #include <arch/types.h> |
42 | #include <arch/types.h> |
43 | #include <typedefs.h> |
43 | #include <typedefs.h> |
44 | #include <time/timeout.h> |
44 | #include <time/timeout.h> |
45 | #include <synch/rwlock.h> |
45 | #include <synch/rwlock.h> |
46 | #include <synch/synch.h> |
46 | #include <synch/synch.h> |
47 | #include <config.h> |
47 | #include <config.h> |
48 | #include <adt/btree.h> |
48 | #include <adt/btree.h> |
49 | #include <adt/list.h> |
49 | #include <adt/list.h> |
50 | #include <mm/slab.h> |
50 | #include <mm/slab.h> |
51 | #include <proc/uarg.h> |
51 | #include <proc/uarg.h> |
52 | 52 | ||
53 | #define THREAD_STACK_SIZE STACK_SIZE |
53 | #define THREAD_STACK_SIZE STACK_SIZE |
54 | 54 | ||
55 | /** Thread states. */ |
55 | /** Thread states. */ |
56 | enum state { |
56 | enum state { |
57 | Invalid, /**< It is an error, if thread is found in this state. */ |
57 | Invalid, /**< It is an error, if thread is found in this state. */ |
58 | Running, /**< State of a thread that is currently executing on some CPU. */ |
58 | Running, /**< State of a thread that is currently executing on some CPU. */ |
59 | Sleeping, /**< Thread in this state is waiting for an event. */ |
59 | Sleeping, /**< Thread in this state is waiting for an event. */ |
60 | Ready, /**< State of threads in a run queue. */ |
60 | Ready, /**< State of threads in a run queue. */ |
61 | Entering, /**< Threads are in this state before they are first readied. */ |
61 | Entering, /**< Threads are in this state before they are first readied. */ |
62 | Exiting, /**< After a thread calls thread_exit(), it is put into Exiting state. */ |
62 | Exiting, /**< After a thread calls thread_exit(), it is put into Exiting state. */ |
63 | Undead /**< Threads that were not detached but exited are in the Undead state. */ |
63 | Undead /**< Threads that were not detached but exited are in the Undead state. */ |
64 | }; |
64 | }; |
65 | 65 | ||
66 | extern char *thread_states[]; |
66 | extern char *thread_states[]; |
67 | 67 | ||
68 | /** Join types. */ |
68 | /** Join types. */ |
69 | typedef enum { |
69 | typedef enum { |
70 | None, |
70 | None, |
71 | TaskClnp, /**< The thread will be joined by ktaskclnp thread. */ |
71 | TaskClnp, /**< The thread will be joined by ktaskclnp thread. */ |
72 | TaskGC /**< The thread will be joined by ktaskgc thread. */ |
72 | TaskGC /**< The thread will be joined by ktaskgc thread. */ |
73 | } thread_join_type_t; |
73 | } thread_join_type_t; |
74 | 74 | ||
75 | /* Thread flags */ |
75 | /* Thread flags */ |
76 | #define THREAD_FLAG_WIRED (1<<0) /**< Thread cannot be migrated to another CPU. */ |
76 | #define THREAD_FLAG_WIRED (1<<0) /**< Thread cannot be migrated to another CPU. */ |
77 | #define THREAD_FLAG_STOLEN (1<<1) /**< Thread was migrated to another CPU and has not run yet. */ |
77 | #define THREAD_FLAG_STOLEN (1<<1) /**< Thread was migrated to another CPU and has not run yet. */ |
78 | #define THREAD_FLAG_USPACE (1<<2) /**< Thread executes in userspace. */ |
78 | #define THREAD_FLAG_USPACE (1<<2) /**< Thread executes in userspace. */ |
79 | 79 | ||
80 | #define THREAD_NAME_BUFLEN 20 |
80 | #define THREAD_NAME_BUFLEN 20 |
81 | 81 | ||
82 | /** Thread structure. There is one per thread. */ |
82 | /** Thread structure. There is one per thread. */ |
83 | struct thread { |
83 | struct thread { |
84 | link_t rq_link; /**< Run queue link. */ |
84 | link_t rq_link; /**< Run queue link. */ |
85 | link_t wq_link; /**< Wait queue link. */ |
85 | link_t wq_link; /**< Wait queue link. */ |
86 | link_t th_link; /**< Links to threads within containing task. */ |
86 | link_t th_link; /**< Links to threads within containing task. */ |
87 | 87 | ||
88 | /** Lock protecting thread structure. |
88 | /** Lock protecting thread structure. |
89 | * |
89 | * |
90 | * Protects the whole thread structure except list links above. |
90 | * Protects the whole thread structure except list links above. |
91 | */ |
91 | */ |
92 | SPINLOCK_DECLARE(lock); |
92 | SPINLOCK_DECLARE(lock); |
93 | 93 | ||
94 | char name[THREAD_NAME_BUFLEN]; |
94 | char name[THREAD_NAME_BUFLEN]; |
95 | 95 | ||
96 | void (* thread_code)(void *); /**< Function implementing the thread. */ |
96 | void (* thread_code)(void *); /**< Function implementing the thread. */ |
97 | void *thread_arg; /**< Argument passed to thread_code() function. */ |
97 | void *thread_arg; /**< Argument passed to thread_code() function. */ |
98 | 98 | ||
99 | /** From here, the stored context is restored when the thread is scheduled. */ |
99 | /** From here, the stored context is restored when the thread is scheduled. */ |
100 | context_t saved_context; |
100 | context_t saved_context; |
101 | /** From here, the stored timeout context is restored when sleep times out. */ |
101 | /** From here, the stored timeout context is restored when sleep times out. */ |
102 | context_t sleep_timeout_context; |
102 | context_t sleep_timeout_context; |
103 | /** From here, the stored interruption context is restored when sleep is interrupted. */ |
103 | /** From here, the stored interruption context is restored when sleep is interrupted. */ |
104 | context_t sleep_interruption_context; |
104 | context_t sleep_interruption_context; |
105 | 105 | ||
106 | bool sleep_interruptible; /**< If true, the thread can be interrupted from sleep. */ |
106 | bool sleep_interruptible; /**< If true, the thread can be interrupted from sleep. */ |
107 | waitq_t *sleep_queue; /**< Wait queue in which this thread sleeps. */ |
107 | waitq_t *sleep_queue; /**< Wait queue in which this thread sleeps. */ |
108 | timeout_t sleep_timeout; /**< Timeout used for timeoutable sleeping. */ |
108 | timeout_t sleep_timeout; /**< Timeout used for timeoutable sleeping. */ |
109 | volatile int timeout_pending; /**< Flag signalling sleep timeout in progress. */ |
109 | volatile int timeout_pending; /**< Flag signalling sleep timeout in progress. */ |
110 | 110 | ||
111 | /** True if this thread is executing copy_from_uspace(). False otherwise. */ |
111 | /** True if this thread is executing copy_from_uspace(). False otherwise. */ |
112 | bool in_copy_from_uspace; |
112 | bool in_copy_from_uspace; |
113 | /** True if this thread is executing copy_to_uspace(). False otherwise. */ |
113 | /** True if this thread is executing copy_to_uspace(). False otherwise. */ |
114 | bool in_copy_to_uspace; |
114 | bool in_copy_to_uspace; |
115 | 115 | ||
116 | /** |
116 | /** |
117 | * If true, the thread will not go to sleep at all and will |
117 | * If true, the thread will not go to sleep at all and will |
118 | * call thread_exit() before returning to userspace. |
118 | * call thread_exit() before returning to userspace. |
119 | */ |
119 | */ |
120 | bool interrupted; |
120 | bool interrupted; |
121 | 121 | ||
122 | thread_join_type_t join_type; /**< Who joinins the thread. */ |
122 | thread_join_type_t join_type; /**< Who joinins the thread. */ |
123 | bool detached; /**< If true, thread_join_timeout() cannot be used on this thread. */ |
123 | bool detached; /**< If true, thread_join_timeout() cannot be used on this thread. */ |
124 | waitq_t join_wq; /**< Waitq for thread_join_timeout(). */ |
124 | waitq_t join_wq; /**< Waitq for thread_join_timeout(). */ |
125 | 125 | ||
126 | fpu_context_t *saved_fpu_context; |
126 | fpu_context_t *saved_fpu_context; |
127 | int fpu_context_exists; |
127 | int fpu_context_exists; |
128 | 128 | ||
129 | /* |
129 | /* |
130 | * Defined only if thread doesn't run. |
130 | * Defined only if thread doesn't run. |
131 | * It means that fpu context is in CPU that last time executes this thread. |
131 | * It means that fpu context is in CPU that last time executes this thread. |
132 | * This disables migration. |
132 | * This disables migration. |
133 | */ |
133 | */ |
134 | int fpu_context_engaged; |
134 | int fpu_context_engaged; |
135 | 135 | ||
136 | rwlock_type_t rwlock_holder_type; |
136 | rwlock_type_t rwlock_holder_type; |
137 | 137 | ||
138 | void (* call_me)(void *); /**< Funtion to be called in scheduler before the thread is put asleep. */ |
138 | void (* call_me)(void *); /**< Funtion to be called in scheduler before the thread is put asleep. */ |
139 | void *call_me_with; /**< Argument passed to call_me(). */ |
139 | void *call_me_with; /**< Argument passed to call_me(). */ |
140 | 140 | ||
141 | state_t state; /**< Thread's state. */ |
141 | state_t state; /**< Thread's state. */ |
142 | int flags; /**< Thread's flags. */ |
142 | int flags; /**< Thread's flags. */ |
143 | 143 | ||
144 | cpu_t *cpu; /**< Thread's CPU. */ |
144 | cpu_t *cpu; /**< Thread's CPU. */ |
145 | task_t *task; /**< Containing task. */ |
145 | task_t *task; /**< Containing task. */ |
146 | 146 | ||
147 | uint64_t ticks; /**< Ticks before preemption. */ |
147 | uint64_t ticks; /**< Ticks before preemption. */ |
148 | 148 | ||
149 | uint64_t cycles; /**< Thread accounting. */ |
149 | uint64_t cycles; /**< Thread accounting. */ |
150 | uint64_t last_cycle; /**< Last sampled cycle. */ |
150 | uint64_t last_cycle; /**< Last sampled cycle. */ |
- | 151 | bool uncounted; /**< Thread doesn't affect accumulated accounting. */ |
|
151 | 152 | ||
152 | int priority; /**< Thread's priority. Implemented as index to CPU->rq */ |
153 | int priority; /**< Thread's priority. Implemented as index to CPU->rq */ |
153 | uint32_t tid; /**< Thread ID. */ |
154 | uint32_t tid; /**< Thread ID. */ |
154 | 155 | ||
155 | thread_arch_t arch; /**< Architecture-specific data. */ |
156 | thread_arch_t arch; /**< Architecture-specific data. */ |
156 | 157 | ||
157 | uint8_t *kstack; /**< Thread's kernel stack. */ |
158 | uint8_t *kstack; /**< Thread's kernel stack. */ |
158 | }; |
159 | }; |
159 | 160 | ||
160 | /** Thread list lock. |
161 | /** Thread list lock. |
161 | * |
162 | * |
162 | * This lock protects all link_t structures chained in threads_head. |
163 | * This lock protects all link_t structures chained in threads_head. |
163 | * Must be acquired before T.lock for each T of type thread_t. |
164 | * Must be acquired before T.lock for each T of type thread_t. |
164 | * |
165 | * |
165 | */ |
166 | */ |
166 | extern spinlock_t threads_lock; |
167 | extern spinlock_t threads_lock; |
167 | 168 | ||
168 | extern btree_t threads_btree; /**< B+tree containing all threads. */ |
169 | extern btree_t threads_btree; /**< B+tree containing all threads. */ |
169 | 170 | ||
170 | extern void thread_init(void); |
171 | extern void thread_init(void); |
171 | extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name); |
172 | extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name, bool uncounted); |
172 | extern void thread_ready(thread_t *t); |
173 | extern void thread_ready(thread_t *t); |
173 | extern void thread_exit(void) __attribute__((noreturn)); |
174 | extern void thread_exit(void) __attribute__((noreturn)); |
174 | 175 | ||
175 | #ifndef thread_create_arch |
176 | #ifndef thread_create_arch |
176 | extern void thread_create_arch(thread_t *t); |
177 | extern void thread_create_arch(thread_t *t); |
177 | #endif |
178 | #endif |
178 | #ifndef thr_constructor_arch |
179 | #ifndef thr_constructor_arch |
179 | extern void thr_constructor_arch(thread_t *t); |
180 | extern void thr_constructor_arch(thread_t *t); |
180 | #endif |
181 | #endif |
181 | #ifndef thr_destructor_arch |
182 | #ifndef thr_destructor_arch |
182 | extern void thr_destructor_arch(thread_t *t); |
183 | extern void thr_destructor_arch(thread_t *t); |
183 | #endif |
184 | #endif |
184 | 185 | ||
185 | extern void thread_sleep(uint32_t sec); |
186 | extern void thread_sleep(uint32_t sec); |
186 | extern void thread_usleep(uint32_t usec); |
187 | extern void thread_usleep(uint32_t usec); |
187 | 188 | ||
188 | #define thread_join(t) thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE) |
189 | #define thread_join(t) thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE) |
189 | extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags); |
190 | extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags); |
190 | extern void thread_detach(thread_t *t); |
191 | extern void thread_detach(thread_t *t); |
191 | 192 | ||
192 | extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with); |
193 | extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with); |
193 | extern void thread_print_list(void); |
194 | extern void thread_print_list(void); |
194 | extern void thread_destroy(thread_t *t); |
195 | extern void thread_destroy(thread_t *t); |
195 | extern void thread_update_accounting(void); |
196 | extern void thread_update_accounting(void); |
196 | extern bool thread_exists(thread_t *t); |
197 | extern bool thread_exists(thread_t *t); |
197 | 198 | ||
198 | /* Fpu context slab cache */ |
199 | /* Fpu context slab cache */ |
199 | extern slab_cache_t *fpu_context_slab; |
200 | extern slab_cache_t *fpu_context_slab; |
200 | 201 | ||
201 | /** Thread syscall prototypes. */ |
202 | /** Thread syscall prototypes. */ |
202 | unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name); |
203 | unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name); |
203 | unative_t sys_thread_exit(int uspace_status); |
204 | unative_t sys_thread_exit(int uspace_status); |
204 | 205 | ||
205 | #endif |
206 | #endif |
206 | 207 | ||
207 | /** @} |
208 | /** @} |
208 | */ |
209 | */ |
209 | 210 |