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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 4738d84 was ee42e43, checked in by Jakub Jermar <jakub@…>, 15 years ago

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