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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ba2be23 was 6eef3c4, checked in by Martin Decky <martin@…>, 13 years ago

cleanup thread_create() and thread_t structure

  • remove 'flag' bitfield from thread_t, use individual boolean flags (can be optimized later on by adding : 1)
  • use an enum for call flags, add THREAD_FLAG_NONE
  • remove the 'uncounted' argument in favour of a call flag
  • introduce thread_wire() to setup wired threads
  • Property mode set to 100644
File size: 7.2 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 genericproc
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/avl.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/sysinfo.h>
50
51#define THREAD_NAME_BUFLEN 20
52
53extern const char *thread_states[];
54
55/* Thread flags */
56typedef enum {
57 THREAD_FLAG_NONE = 0,
58 /** Thread executes in user space. */
59 THREAD_FLAG_USPACE = (1 << 0),
60 /** Thread will be attached by the caller. */
61 THREAD_FLAG_NOATTACH = (1 << 1),
62 /** Thread accounting doesn't affect accumulated task accounting. */
63 THREAD_FLAG_UNCOUNTED = (1 << 2)
64} thread_flags_t;
65
66/** Thread structure. There is one per thread. */
67typedef struct thread {
68 link_t rq_link; /**< Run queue link. */
69 link_t wq_link; /**< Wait queue link. */
70 link_t th_link; /**< Links to threads within containing task. */
71
72 /** Threads linkage to the threads_tree. */
73 avltree_node_t threads_tree_node;
74
75 /** Lock protecting thread structure.
76 *
77 * Protects the whole thread structure except list links above.
78 */
79 IRQ_SPINLOCK_DECLARE(lock);
80
81 char name[THREAD_NAME_BUFLEN];
82
83 /** Function implementing the thread. */
84 void (*thread_code)(void *);
85 /** Argument passed to thread_code() function. */
86 void *thread_arg;
87
88 /**
89 * From here, the stored context is restored
90 * when the thread is scheduled.
91 */
92 context_t saved_context;
93
94 /**
95 * From here, the stored timeout context
96 * is restored when sleep times out.
97 */
98 context_t sleep_timeout_context;
99
100 /**
101 * From here, the stored interruption context
102 * is restored when sleep is interrupted.
103 */
104 context_t sleep_interruption_context;
105
106 /** If true, the thread can be interrupted from sleep. */
107 bool sleep_interruptible;
108 /** Wait queue in which this thread sleeps. */
109 waitq_t *sleep_queue;
110 /** Timeout used for timeoutable sleeping. */
111 timeout_t sleep_timeout;
112 /** Flag signalling sleep timeout in progress. */
113 volatile bool timeout_pending;
114
115 /**
116 * True if this thread is executing copy_from_uspace().
117 * False otherwise.
118 */
119 bool in_copy_from_uspace;
120
121 /**
122 * True if this thread is executing copy_to_uspace().
123 * False otherwise.
124 */
125 bool in_copy_to_uspace;
126
127 /**
128 * If true, the thread will not go to sleep at all and will call
129 * thread_exit() before returning to userspace.
130 */
131 bool interrupted;
132
133 /** If true, thread_join_timeout() cannot be used on this thread. */
134 bool detached;
135 /** Waitq for thread_join_timeout(). */
136 waitq_t join_wq;
137 /** Link used in the joiner_head list. */
138 link_t joiner_link;
139
140 fpu_context_t *saved_fpu_context;
141 bool fpu_context_exists;
142
143 /*
144 * Defined only if thread doesn't run.
145 * It means that fpu context is in CPU that last time executes this
146 * thread. This disables migration.
147 */
148 bool fpu_context_engaged;
149
150 /* The thread will not be migrated if nomigrate is non-zero. */
151 unsigned int nomigrate;
152
153 /** Thread state. */
154 state_t state;
155
156 /** Thread CPU. */
157 cpu_t *cpu;
158 /** Containing task. */
159 task_t *task;
160 /** Thread is wired to CPU. */
161 bool wired;
162 /** Thread was migrated to another CPU and has not run yet. */
163 bool stolen;
164 /** Thread is executed in user space. */
165 bool uspace;
166
167 /** Ticks before preemption. */
168 uint64_t ticks;
169
170 /** Thread accounting. */
171 uint64_t ucycles;
172 uint64_t kcycles;
173 /** Last sampled cycle. */
174 uint64_t last_cycle;
175 /** Thread doesn't affect accumulated accounting. */
176 bool uncounted;
177
178 /** Thread's priority. Implemented as index to CPU->rq */
179 int priority;
180 /** Thread ID. */
181 thread_id_t tid;
182
183 /** Architecture-specific data. */
184 thread_arch_t arch;
185
186 /** Thread's kernel stack. */
187 uint8_t *kstack;
188
189#ifdef CONFIG_UDEBUG
190 /**
191 * If true, the scheduler will print a stack trace
192 * to the kernel console upon scheduling this thread.
193 */
194 bool btrace;
195
196 /** Debugging stuff */
197 udebug_thread_t udebug;
198#endif /* CONFIG_UDEBUG */
199} thread_t;
200
201/** Thread list lock.
202 *
203 * This lock protects the threads_tree.
204 * Must be acquired before T.lock for each T of type thread_t.
205 *
206 */
207IRQ_SPINLOCK_EXTERN(threads_lock);
208
209/** AVL tree containing all threads. */
210extern avltree_t threads_tree;
211
212extern void thread_init(void);
213extern thread_t *thread_create(void (*)(void *), void *, task_t *,
214 thread_flags_t, const char *);
215extern void thread_wire(thread_t *, cpu_t *);
216extern void thread_attach(thread_t *, task_t *);
217extern void thread_ready(thread_t *);
218extern void thread_exit(void) __attribute__((noreturn));
219
220#ifndef thread_create_arch
221extern void thread_create_arch(thread_t *);
222#endif
223
224#ifndef thr_constructor_arch
225extern void thr_constructor_arch(thread_t *);
226#endif
227
228#ifndef thr_destructor_arch
229extern void thr_destructor_arch(thread_t *);
230#endif
231
232extern void thread_sleep(uint32_t);
233extern void thread_usleep(uint32_t);
234
235#define thread_join(t) \
236 thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
237
238extern int thread_join_timeout(thread_t *, uint32_t, unsigned int);
239extern void thread_detach(thread_t *);
240
241extern void thread_print_list(bool);
242extern void thread_destroy(thread_t *, bool);
243extern thread_t *thread_find_by_id(thread_id_t);
244extern void thread_update_accounting(bool);
245extern bool thread_exists(thread_t *);
246
247extern void thread_migration_disable(void);
248extern void thread_migration_enable(void);
249
250#ifdef CONFIG_UDEBUG
251extern void thread_stack_trace(thread_id_t);
252#endif
253
254/** Fpu context slab cache. */
255extern slab_cache_t *fpu_context_slab;
256
257/* Thread syscall prototypes. */
258extern sysarg_t sys_thread_create(uspace_arg_t *, char *, size_t,
259 thread_id_t *);
260extern sysarg_t sys_thread_exit(int);
261extern sysarg_t sys_thread_get_id(thread_id_t *);
262extern sysarg_t sys_thread_usleep(uint32_t);
263extern sysarg_t sys_thread_udelay(uint32_t);
264
265#endif
266
267/** @}
268 */
Note: See TracBrowser for help on using the repository browser.