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

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

move timeout_t to timeout.h
move other helper types to thread.h
  • Property mode set to 100644
File size: 7.2 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#define THREAD_FLAG_WIRED (1 << 0) /**< Thread cannot be migrated to another CPU. */
56#define THREAD_FLAG_STOLEN (1 << 1) /**< Thread was migrated to another CPU and has not run yet. */
57#define THREAD_FLAG_USPACE (1 << 2) /**< Thread executes in userspace. */
58
59/** Thread states. */
60typedef enum {
61 Invalid, /**< It is an error, if thread is found in this state. */
62 Running, /**< State of a thread that is currently executing on some CPU. */
63 Sleeping, /**< Thread in this state is waiting for an event. */
64 Ready, /**< State of threads in a run queue. */
65 Entering, /**< Threads are in this state before they are first readied. */
66 Exiting, /**< After a thread calls thread_exit(), it is put into Exiting state. */
67 Undead /**< Threads that were not detached but exited are in the Undead state. */
68} state_t;
69
70/** Join types. */
71typedef enum {
72 None,
73 TaskClnp, /**< The thread will be joined by ktaskclnp thread. */
74 TaskGC /**< The thread will be joined by ktaskgc thread. */
75} thread_join_type_t;
76
77/** Thread structure. There is one per thread. */
78typedef struct thread {
79 link_t rq_link; /**< Run queue link. */
80 link_t wq_link; /**< Wait queue link. */
81 link_t th_link; /**< Links to threads within containing task. */
82
83 /** Lock protecting thread structure.
84 *
85 * Protects the whole thread structure except list links above.
86 */
87 SPINLOCK_DECLARE(lock);
88
89 char name[THREAD_NAME_BUFLEN];
90
91 void (* thread_code)(void *); /**< Function implementing the thread. */
92 void *thread_arg; /**< Argument passed to thread_code() function. */
93
94 /** From here, the stored context is restored when the thread is scheduled. */
95 context_t saved_context;
96 /** From here, the stored timeout context is restored when sleep times out. */
97 context_t sleep_timeout_context;
98 /** From here, the stored interruption context is restored when sleep is interrupted. */
99 context_t sleep_interruption_context;
100
101 bool sleep_interruptible; /**< If true, the thread can be interrupted from sleep. */
102 waitq_t *sleep_queue; /**< Wait queue in which this thread sleeps. */
103 timeout_t sleep_timeout; /**< Timeout used for timeoutable sleeping. */
104 volatile int timeout_pending; /**< Flag signalling sleep timeout in progress. */
105
106 /** True if this thread is executing copy_from_uspace(). False otherwise. */
107 bool in_copy_from_uspace;
108 /** True if this thread is executing copy_to_uspace(). False otherwise. */
109 bool in_copy_to_uspace;
110
111 /**
112 * If true, the thread will not go to sleep at all and will
113 * call thread_exit() before returning to userspace.
114 */
115 bool interrupted;
116
117 thread_join_type_t join_type; /**< Who joinins the thread. */
118 bool detached; /**< If true, thread_join_timeout() cannot be used on this thread. */
119 waitq_t join_wq; /**< Waitq for thread_join_timeout(). */
120
121 fpu_context_t *saved_fpu_context;
122 int fpu_context_exists;
123
124 /*
125 * Defined only if thread doesn't run.
126 * It means that fpu context is in CPU that last time executes this thread.
127 * This disables migration.
128 */
129 int fpu_context_engaged;
130
131 rwlock_type_t rwlock_holder_type;
132
133 void (* call_me)(void *); /**< Funtion to be called in scheduler before the thread is put asleep. */
134 void *call_me_with; /**< Argument passed to call_me(). */
135
136 state_t state; /**< Thread's state. */
137 int flags; /**< Thread's flags. */
138
139 cpu_t *cpu; /**< Thread's CPU. */
140 task_t *task; /**< Containing task. */
141
142 uint64_t ticks; /**< Ticks before preemption. */
143
144 uint64_t cycles; /**< Thread accounting. */
145 uint64_t last_cycle; /**< Last sampled cycle. */
146 bool uncounted; /**< Thread doesn't affect accumulated accounting. */
147
148 int priority; /**< Thread's priority. Implemented as index to CPU->rq */
149 uint32_t tid; /**< Thread ID. */
150
151 thread_arch_t arch; /**< Architecture-specific data. */
152
153 uint8_t *kstack; /**< Thread's kernel stack. */
154} thread_t;
155
156/** Thread list lock.
157 *
158 * This lock protects all link_t structures chained in threads_head.
159 * Must be acquired before T.lock for each T of type thread_t.
160 *
161 */
162SPINLOCK_EXTERN(threads_lock);
163
164extern btree_t threads_btree; /**< B+tree containing all threads. */
165
166extern void thread_init(void);
167extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name, bool uncounted);
168extern void thread_ready(thread_t *t);
169extern void thread_exit(void) __attribute__((noreturn));
170
171#ifndef thread_create_arch
172extern void thread_create_arch(thread_t *t);
173#endif
174#ifndef thr_constructor_arch
175extern void thr_constructor_arch(thread_t *t);
176#endif
177#ifndef thr_destructor_arch
178extern void thr_destructor_arch(thread_t *t);
179#endif
180
181extern void thread_sleep(uint32_t sec);
182extern void thread_usleep(uint32_t usec);
183
184#define thread_join(t) thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
185extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
186extern void thread_detach(thread_t *t);
187
188extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
189extern void thread_print_list(void);
190extern void thread_destroy(thread_t *t);
191extern void thread_update_accounting(void);
192extern bool thread_exists(thread_t *t);
193extern void thread_interrupt_sleep(thread_t *t);
194
195/* Fpu context slab cache */
196extern slab_cache_t *fpu_context_slab;
197
198/** Thread syscall prototypes. */
199unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
200unative_t sys_thread_exit(int uspace_status);
201
202#endif
203
204/** @}
205 */
Note: See TracBrowser for help on using the repository browser.