source: mainline/kernel/generic/include/proc/thread.h@ 1871118

ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 1871118 was 1871118, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 2 years ago

Make thread_t reference counted

This simplifies interaction between various locks and thread
lifespan, which simplifies things. For example, threads_lock can
now simply be a mutex protecting the global it was made for, and
nothing more.
  • Property mode set to 100644
File size: 7.5 KB
Line 
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 kernel_generic_proc
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/spinlock.h>
43#include <adt/odict.h>
44#include <mm/slab.h>
45#include <arch/cpu.h>
46#include <mm/tlb.h>
47#include <abi/proc/uarg.h>
48#include <udebug/udebug.h>
49#include <abi/proc/thread.h>
50#include <abi/sysinfo.h>
51#include <arch.h>
52
53#define THREAD CURRENT->thread
54
55#define THREAD_NAME_BUFLEN 20
56
57extern const char *thread_states[];
58
59/* Thread flags */
60typedef enum {
61 THREAD_FLAG_NONE = 0,
62 /** Thread executes in user space. */
63 THREAD_FLAG_USPACE = (1 << 0),
64 /** Thread will be attached by the caller. */
65 THREAD_FLAG_NOATTACH = (1 << 1),
66 /** Thread accounting doesn't affect accumulated task accounting. */
67 THREAD_FLAG_UNCOUNTED = (1 << 2)
68} thread_flags_t;
69
70/** Thread structure. There is one per thread. */
71typedef struct thread {
72 atomic_refcount_t refcount;
73
74 link_t rq_link; /**< Run queue link. */
75 link_t wq_link; /**< Wait queue link. */
76 link_t th_link; /**< Links to threads within containing task. */
77
78 /** Link to @c threads ordered dictionary. */
79 odlink_t lthreads;
80
81 /**
82 * If true, the thread is terminating.
83 * It will not go to sleep in interruptible synchronization functions
84 * and will call thread_exit() before returning to userspace.
85 */
86 volatile bool interrupted;
87
88 /** Waitq for thread_join_timeout(). */
89 waitq_t join_wq;
90
91 /** Lock protecting thread structure.
92 *
93 * Protects the whole thread structure except fields listed above.
94 */
95 IRQ_SPINLOCK_DECLARE(lock);
96
97 char name[THREAD_NAME_BUFLEN];
98
99 /** Function implementing the thread. */
100 void (*thread_code)(void *);
101 /** Argument passed to thread_code() function. */
102 void *thread_arg;
103
104 /**
105 * From here, the stored context is restored
106 * when the thread is scheduled.
107 */
108 context_t saved_context;
109 ipl_t saved_ipl;
110
111 /**
112 * From here, the stored timeout context
113 * is restored when sleep times out.
114 */
115 context_t sleep_timeout_context;
116
117 /**
118 * From here, the stored interruption context
119 * is restored when sleep is interrupted.
120 */
121 context_t sleep_interruption_context;
122
123 /** If true, the thread can be interrupted from sleep. */
124 bool sleep_interruptible;
125
126 /**
127 * If true, and this thread's sleep returns without a wakeup
128 * (timed out or interrupted), waitq ignores the next wakeup.
129 * This is necessary for futex to be able to handle those conditions.
130 */
131 bool sleep_composable;
132
133 /** Wait queue in which this thread sleeps. */
134 waitq_t *sleep_queue;
135
136 /**
137 * True if this thread is executing copy_from_uspace().
138 * False otherwise.
139 */
140 bool in_copy_from_uspace;
141
142 /**
143 * True if this thread is executing copy_to_uspace().
144 * False otherwise.
145 */
146 bool in_copy_to_uspace;
147
148#ifdef CONFIG_FPU
149 fpu_context_t fpu_context;
150#endif
151 bool fpu_context_exists;
152
153 /*
154 * Defined only if thread doesn't run.
155 * It means that fpu context is in CPU that last time executes this
156 * thread. This disables migration.
157 */
158 bool fpu_context_engaged;
159
160 /* The thread will not be migrated if nomigrate is non-zero. */
161 unsigned int nomigrate;
162
163 /** Thread state. */
164 state_t state;
165
166 /** Thread CPU. */
167 cpu_t *cpu;
168 /** Containing task. */
169 task_t *task;
170 /** Thread is wired to CPU. */
171 bool wired;
172 /** Thread was migrated to another CPU and has not run yet. */
173 bool stolen;
174 /** Thread is executed in user space. */
175 bool uspace;
176
177 /** Thread accounting. */
178 uint64_t ucycles;
179 uint64_t kcycles;
180 /** Last sampled cycle. */
181 uint64_t last_cycle;
182 /** Thread doesn't affect accumulated accounting. */
183 bool uncounted;
184
185 /** Thread's priority. Implemented as index to CPU->rq */
186 int priority;
187 /** Thread ID. */
188 thread_id_t tid;
189
190 /** Architecture-specific data. */
191 thread_arch_t arch;
192
193 /** Thread's kernel stack. */
194 uint8_t *kstack;
195
196#ifdef CONFIG_UDEBUG
197 /**
198 * If true, the scheduler will print a stack trace
199 * to the kernel console upon scheduling this thread.
200 */
201 bool btrace;
202
203 /** Debugging stuff */
204 udebug_thread_t udebug;
205#endif /* CONFIG_UDEBUG */
206} thread_t;
207
208IRQ_SPINLOCK_EXTERN(threads_lock);
209extern odict_t threads;
210
211extern void thread_init(void);
212extern thread_t *thread_create(void (*)(void *), void *, task_t *,
213 thread_flags_t, const char *);
214extern void thread_wire(thread_t *, cpu_t *);
215extern void thread_attach(thread_t *, task_t *);
216extern void thread_ready(thread_t *);
217extern void thread_exit(void) __attribute__((noreturn));
218extern void thread_interrupt(thread_t *, bool);
219
220static inline thread_t *thread_ref(thread_t *thread)
221{
222 refcount_up(&thread->refcount);
223 return thread;
224}
225
226static inline thread_t *thread_try_ref(thread_t *thread)
227{
228 if (refcount_try_up(&thread->refcount))
229 return thread;
230 else
231 return NULL;
232}
233
234extern void thread_put(thread_t *);
235
236#ifndef thread_create_arch
237extern errno_t thread_create_arch(thread_t *, thread_flags_t);
238#endif
239
240#ifndef thr_constructor_arch
241extern void thr_constructor_arch(thread_t *);
242#endif
243
244#ifndef thr_destructor_arch
245extern void thr_destructor_arch(thread_t *);
246#endif
247
248extern void thread_sleep(uint32_t);
249extern void thread_usleep(uint32_t);
250
251extern errno_t thread_join(thread_t *);
252extern errno_t thread_join_timeout(thread_t *, uint32_t, unsigned int);
253
254extern void thread_print_list(bool);
255extern thread_t *thread_find_by_id(thread_id_t);
256extern size_t thread_count(void);
257extern thread_t *thread_first(void);
258extern thread_t *thread_next(thread_t *);
259extern void thread_update_accounting(bool);
260extern thread_t *thread_try_get(thread_t *);
261
262extern void thread_migration_disable(void);
263extern void thread_migration_enable(void);
264
265#ifdef CONFIG_UDEBUG
266extern void thread_stack_trace(thread_id_t);
267#endif
268
269/** Fpu context slab cache. */
270extern slab_cache_t *fpu_context_cache;
271
272/* Thread syscall prototypes. */
273extern sys_errno_t sys_thread_create(uspace_ptr_uspace_arg_t, uspace_ptr_char, size_t,
274 uspace_ptr_thread_id_t);
275extern sys_errno_t sys_thread_exit(int);
276extern sys_errno_t sys_thread_get_id(uspace_ptr_thread_id_t);
277extern sys_errno_t sys_thread_usleep(uint32_t);
278extern sys_errno_t sys_thread_udelay(uint32_t);
279
280#endif
281
282/** @}
283 */
Note: See TracBrowser for help on using the repository browser.