source: mainline/generic/include/proc/thread.h@ bf56fef

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export 0.2.0
Last change on this file since bf56fef was 48e7dd6, checked in by Jakub Jermar <jakub@…>, 20 years ago

Collect Undead threads while waiting to join uinit.
Rename ktaskkill to ktaskgc.
  • Property mode set to 100644
File size: 6.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#ifndef __THREAD_H__
30#define __THREAD_H__
31
32#include <arch/proc/thread.h>
33#include <synch/spinlock.h>
34#include <arch/context.h>
35#include <fpu_context.h>
36#include <arch/types.h>
37#include <typedefs.h>
38#include <time/timeout.h>
39#include <synch/rwlock.h>
40#include <synch/synch.h>
41#include <config.h>
42#include <adt/btree.h>
43#include <adt/list.h>
44#include <mm/slab.h>
45#include <proc/uarg.h>
46
47#define THREAD_STACK_SIZE STACK_SIZE
48
49/**< Thread states. */
50enum state {
51 Invalid, /**< It is an error, if thread is found in this state. */
52 Running, /**< State of a thread that is currently executing on some CPU. */
53 Sleeping, /**< Thread in this state is waiting for an event. */
54 Ready, /**< State of threads in a run queue. */
55 Entering, /**< Threads are in this state before they are first readied. */
56 Exiting, /**< After a thread calls thread_exit(), it is put into Exiting state. */
57 Undead /**< Threads that were not detached but exited are in the Undead state. */
58};
59
60extern char *thread_states[];
61
62/**< Join types. */
63typedef enum {
64 None,
65 TaskClnp, /**< The thread will be joined by ktaskclnp thread. */
66 TaskGC /**< The thread will be joined by ktaskgc thread. */
67} thread_join_type_t;
68
69#define X_WIRED (1<<0)
70#define X_STOLEN (1<<1)
71
72#define THREAD_NAME_BUFLEN 20
73
74/** Thread structure. There is one per thread. */
75struct 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 /** Lock protecting thread structure.
81 *
82 * Protects the whole thread structure except list links above.
83 */
84 SPINLOCK_DECLARE(lock);
85
86 char name[THREAD_NAME_BUFLEN];
87
88 void (* thread_code)(void *); /**< Function implementing the thread. */
89 void *thread_arg; /**< Argument passed to thread_code() function. */
90
91 /** From here, the stored context is restored when the thread is scheduled. */
92 context_t saved_context;
93 /** From here, the stored timeout context is restored when sleep times out. */
94 context_t sleep_timeout_context;
95 /** From here, the stored interruption context is restored when sleep is interrupted. */
96 context_t sleep_interruption_context;
97
98 bool sleep_interruptible; /**< If true, the thread can be interrupted from sleep. */
99 waitq_t *sleep_queue; /**< Wait queue in which this thread sleeps. */
100 timeout_t sleep_timeout; /**< Timeout used for timeoutable sleeping. */
101 volatile int timeout_pending; /**< Flag signalling sleep timeout in progress. */
102
103 /** True if this thread is executing copy_from_uspace(). False otherwise. */
104 bool in_copy_from_uspace;
105 /** True if this thread is executing copy_to_uspace(). False otherwise. */
106 bool in_copy_to_uspace;
107
108 /**
109 * If true, the thread will not go to sleep at all and will
110 * call thread_exit() before returning to userspace.
111 */
112 bool interrupted;
113
114 thread_join_type_t join_type; /**< Who joinins the thread. */
115 bool detached; /**< If true, thread_join_timeout() cannot be used on this thread. */
116 waitq_t join_wq; /**< Waitq for thread_join_timeout(). */
117
118 fpu_context_t *saved_fpu_context;
119 int fpu_context_exists;
120
121 /*
122 * Defined only if thread doesn't run.
123 * It means that fpu context is in CPU that last time executes this thread.
124 * This disables migration
125 */
126 int fpu_context_engaged;
127
128 rwlock_type_t rwlock_holder_type;
129
130 void (* call_me)(void *); /**< Funtion to be called in scheduler before the thread is put asleep. */
131 void *call_me_with; /**< Argument passed to call_me(). */
132
133 state_t state; /**< Thread's state. */
134 int flags; /**< Thread's flags. */
135
136 cpu_t *cpu; /**< Thread's CPU. */
137 task_t *task; /**< Containing task. */
138
139 __u64 ticks; /**< Ticks before preemption. */
140
141 int priority; /**< Thread's priority. Implemented as index to CPU->rq */
142 __u32 tid; /**< Thread ID. */
143
144 thread_arch_t arch; /**< Architecture-specific data. */
145
146 __u8 *kstack; /**< Thread's kernel stack. */
147};
148
149/** Thread list lock.
150 *
151 * This lock protects all link_t structures chained in threads_head.
152 * Must be acquired before T.lock for each T of type thread_t.
153 *
154 */
155extern spinlock_t threads_lock;
156
157extern btree_t threads_btree; /**< B+tree containing all threads. */
158
159extern void thread_init(void);
160extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
161extern void thread_ready(thread_t *t);
162extern void thread_exit(void) __attribute__((noreturn));
163
164#ifndef thread_create_arch
165extern void thread_create_arch(thread_t *t);
166#endif
167
168extern void thread_sleep(__u32 sec);
169extern void thread_usleep(__u32 usec);
170
171#define thread_join(t) thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
172extern int thread_join_timeout(thread_t *t, __u32 usec, int flags);
173extern void thread_detach(thread_t *t);
174
175extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
176extern void thread_print_list(void);
177extern void thread_destroy(thread_t *t);
178extern bool thread_exists(thread_t *t);
179
180/* Fpu context slab cache */
181extern slab_cache_t *fpu_context_slab;
182
183/** Thread syscall prototypes. */
184__native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
185__native sys_thread_exit(int uspace_status);
186
187#endif
Note: See TracBrowser for help on using the repository browser.