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

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

Fix the problem with sys_thread_create() by splitting the create and attach functionality of
thread_create(). Now it is possible to specify a flag that will cause thread_create() to only allocate and
initialize the thread structure. A call to thread_attach() will make the thread visible to the system.
This arrangement makes it easier to undo creation of a thread in case of a failure in sys_thread_create().
  • Property mode set to 100644
File size: 7.5 KB
Line 
1/*
2 * Copyright (c) 2001-2004 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/rwlock.h>
43#include <adt/btree.h>
44#include <mm/slab.h>
45#include <arch/cpu.h>
46#include <mm/tlb.h>
47#include <proc/uarg.h>
48
49#define THREAD_STACK_SIZE STACK_SIZE
50#define THREAD_NAME_BUFLEN 20
51
52extern char *thread_states[];
53
54/* Thread flags */
55
56/** Thread cannot be migrated to another CPU.
57 *
58 * When using this flag, the caller must set cpu in the thread_t
59 * structure manually before calling thread_ready (even on uniprocessor).
60 */
61#define THREAD_FLAG_WIRED (1 << 0)
62/** Thread was migrated to another CPU and has not run yet. */
63#define THREAD_FLAG_STOLEN (1 << 1)
64/** Thread executes in userspace. */
65#define THREAD_FLAG_USPACE (1 << 2)
66/** Thread will be attached by the caller. */
67#define THREAD_FLAG_NOATTACH (1 << 3)
68
69/** Thread states. */
70typedef enum {
71 /** It is an error, if thread is found in this state. */
72 Invalid,
73 /** State of a thread that is currently executing on some CPU. */
74 Running,
75 /** Thread in this state is waiting for an event. */
76 Sleeping,
77 /** State of threads in a run queue. */
78 Ready,
79 /** Threads are in this state before they are first readied. */
80 Entering,
81 /** After a thread calls thread_exit(), it is put into Exiting state. */
82 Exiting,
83 /** Threads that were not detached but exited are in the Undead state. */
84 Undead
85} state_t;
86
87/** Join types. */
88typedef enum {
89 None,
90 TaskClnp, /**< The thread will be joined by ktaskclnp thread. */
91 TaskGC /**< The thread will be joined by ktaskgc thread. */
92} thread_join_type_t;
93
94/** Thread structure. There is one per thread. */
95typedef struct thread {
96 link_t rq_link; /**< Run queue link. */
97 link_t wq_link; /**< Wait queue link. */
98 link_t th_link; /**< Links to threads within containing task. */
99
100 /** Lock protecting thread structure.
101 *
102 * Protects the whole thread structure except list links above.
103 */
104 SPINLOCK_DECLARE(lock);
105
106 char name[THREAD_NAME_BUFLEN];
107
108 /** Function implementing the thread. */
109 void (* thread_code)(void *);
110 /** Argument passed to thread_code() function. */
111 void *thread_arg;
112
113 /**
114 * From here, the stored context is restored when the thread is
115 * scheduled.
116 */
117 context_t saved_context;
118 /**
119 * From here, the stored timeout context is restored when sleep times
120 * out.
121 */
122 context_t sleep_timeout_context;
123 /**
124 * From here, the stored interruption context is restored when sleep is
125 * interrupted.
126 */
127 context_t sleep_interruption_context;
128
129 /** If true, the thread can be interrupted from sleep. */
130 bool sleep_interruptible;
131 /** Wait queue in which this thread sleeps. */
132 waitq_t *sleep_queue;
133 /** Timeout used for timeoutable sleeping. */
134 timeout_t sleep_timeout;
135 /** Flag signalling sleep timeout in progress. */
136 volatile int timeout_pending;
137
138 /**
139 * True if this thread is executing copy_from_uspace().
140 * False otherwise.
141 */
142 bool in_copy_from_uspace;
143 /**
144 * True if this thread is executing copy_to_uspace().
145 * False otherwise.
146 */
147 bool in_copy_to_uspace;
148
149 /**
150 * If true, the thread will not go to sleep at all and will call
151 * thread_exit() before returning to userspace.
152 */
153 bool interrupted;
154
155 /** Who joinins the thread. */
156 thread_join_type_t join_type;
157 /** If true, thread_join_timeout() cannot be used on this thread. */
158 bool detached;
159 /** Waitq for thread_join_timeout(). */
160 waitq_t join_wq;
161
162 fpu_context_t *saved_fpu_context;
163 int fpu_context_exists;
164
165 /*
166 * Defined only if thread doesn't run.
167 * It means that fpu context is in CPU that last time executes this
168 * thread. This disables migration.
169 */
170 int fpu_context_engaged;
171
172 rwlock_type_t rwlock_holder_type;
173
174 /** Callback fired in scheduler before the thread is put asleep. */
175 void (* call_me)(void *);
176 /** Argument passed to call_me(). */
177 void *call_me_with;
178
179 /** Thread's state. */
180 state_t state;
181 /** Thread's flags. */
182 int flags;
183
184 /** Thread's CPU. */
185 cpu_t *cpu;
186 /** Containing task. */
187 task_t *task;
188
189 /** Ticks before preemption. */
190 uint64_t ticks;
191
192 /** Thread accounting. */
193 uint64_t cycles;
194 /** Last sampled cycle. */
195 uint64_t last_cycle;
196 /** Thread doesn't affect accumulated accounting. */
197 bool uncounted;
198
199 /** Thread's priority. Implemented as index to CPU->rq */
200 int priority;
201 /** Thread ID. */
202 thread_id_t tid;
203
204 /** Architecture-specific data. */
205 thread_arch_t arch;
206
207 /** Thread's kernel stack. */
208 uint8_t *kstack;
209} thread_t;
210
211/** Thread list lock.
212 *
213 * This lock protects all link_t structures chained in threads_head.
214 * Must be acquired before T.lock for each T of type thread_t.
215 *
216 */
217SPINLOCK_EXTERN(threads_lock);
218
219/** B+tree containing all threads. */
220extern btree_t threads_btree;
221
222extern void thread_init(void);
223extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task,
224 int flags, char *name, bool uncounted);
225extern void thread_attach(thread_t *t, task_t *task);
226extern void thread_ready(thread_t *t);
227extern void thread_exit(void) __attribute__((noreturn));
228
229#ifndef thread_create_arch
230extern void thread_create_arch(thread_t *t);
231#endif
232#ifndef thr_constructor_arch
233extern void thr_constructor_arch(thread_t *t);
234#endif
235#ifndef thr_destructor_arch
236extern void thr_destructor_arch(thread_t *t);
237#endif
238
239extern void thread_sleep(uint32_t sec);
240extern void thread_usleep(uint32_t usec);
241
242#define thread_join(t) \
243 thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
244extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
245extern void thread_detach(thread_t *t);
246
247extern void thread_register_call_me(void (* call_me)(void *),
248 void *call_me_with);
249extern void thread_print_list(void);
250extern void thread_destroy(thread_t *t);
251extern void thread_update_accounting(void);
252extern bool thread_exists(thread_t *t);
253
254/** Fpu context slab cache. */
255extern slab_cache_t *fpu_context_slab;
256
257/* Thread syscall prototypes. */
258extern unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name, thread_id_t *uspace_thread_id);
259extern unative_t sys_thread_exit(int uspace_status);
260extern unative_t sys_thread_get_id(thread_id_t *uspace_thread_id);
261
262#endif
263
264/** @}
265 */
Note: See TracBrowser for help on using the repository browser.