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

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

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