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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 1ba37fa was 1ba37fa, checked in by Stanislav Kozina <stanislav.kozina@…>, 15 years ago

Removed useless cycles sum, using ucycles + kcycles instead.
  • Property mode set to 100644
File size: 7.0 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/rwlock.h>
43#include <synch/spinlock.h>
44#include <adt/avl.h>
45#include <mm/slab.h>
46#include <arch/cpu.h>
47#include <mm/tlb.h>
48#include <proc/uarg.h>
49#include <udebug/udebug.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#define THREAD_FLAG_WIRED (1 << 0)
64/** Thread was migrated to another CPU and has not run yet. */
65#define THREAD_FLAG_STOLEN (1 << 1)
66/** Thread executes in userspace. */
67#define THREAD_FLAG_USPACE (1 << 2)
68/** Thread will be attached by the caller. */
69#define THREAD_FLAG_NOATTACH (1 << 3)
70
71/* We need state_t enum definition */
72#include <ps/taskinfo.h>
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 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 when the thread is
98 * scheduled.
99 */
100 context_t saved_context;
101 /**
102 * From here, the stored timeout context is restored when sleep times
103 * out.
104 */
105 context_t sleep_timeout_context;
106 /**
107 * From here, the stored interruption context is restored when sleep is
108 * interrupted.
109 */
110 context_t sleep_interruption_context;
111
112 /** If true, the thread can be interrupted from sleep. */
113 bool sleep_interruptible;
114 /** Wait queue in which this thread sleeps. */
115 waitq_t *sleep_queue;
116 /** Timeout used for timeoutable sleeping. */
117 timeout_t sleep_timeout;
118 /** Flag signalling sleep timeout in progress. */
119 volatile int timeout_pending;
120
121 /**
122 * True if this thread is executing copy_from_uspace().
123 * False otherwise.
124 */
125 bool in_copy_from_uspace;
126 /**
127 * True if this thread is executing copy_to_uspace().
128 * False otherwise.
129 */
130 bool in_copy_to_uspace;
131
132 /**
133 * If true, the thread will not go to sleep at all and will call
134 * thread_exit() before returning to userspace.
135 */
136 bool interrupted;
137
138 /** If true, thread_join_timeout() cannot be used on this thread. */
139 bool detached;
140 /** Waitq for thread_join_timeout(). */
141 waitq_t join_wq;
142 /** Link used in the joiner_head list. */
143 link_t joiner_link;
144
145 fpu_context_t *saved_fpu_context;
146 int fpu_context_exists;
147
148 /*
149 * Defined only if thread doesn't run.
150 * It means that fpu context is in CPU that last time executes this
151 * thread. This disables migration.
152 */
153 int fpu_context_engaged;
154
155 rwlock_type_t rwlock_holder_type;
156
157 /** Callback fired in scheduler before the thread is put asleep. */
158 void (* call_me)(void *);
159 /** Argument passed to call_me(). */
160 void *call_me_with;
161
162 /** Thread's state. */
163 state_t state;
164 /** Thread's flags. */
165 int flags;
166
167 /** Thread's CPU. */
168 cpu_t *cpu;
169 /** Containing task. */
170 task_t *task;
171
172 /** Ticks before preemption. */
173 uint64_t ticks;
174
175 /** Thread accounting. */
176 uint64_t ucycles;
177 uint64_t kcycles;
178 /** Last sampled cycle. */
179 uint64_t last_cycle;
180 /** Thread doesn't affect accumulated accounting. */
181 bool uncounted;
182
183 /** Thread's priority. Implemented as index to CPU->rq */
184 int priority;
185 /** Thread ID. */
186 thread_id_t tid;
187
188 /** Architecture-specific data. */
189 thread_arch_t arch;
190
191 /** Thread's kernel stack. */
192 uint8_t *kstack;
193
194#ifdef CONFIG_UDEBUG
195 /** Debugging stuff */
196 udebug_thread_t udebug;
197#endif
198
199} thread_t;
200
201/** Thread list lock.
202 *
203 * This lock protects the threads_tree.
204 * Must be acquired before T.lock for each T of type thread_t.
205 *
206 */
207SPINLOCK_EXTERN(threads_lock);
208
209/** AVL tree containing all threads. */
210extern avltree_t threads_tree;
211
212extern void thread_init(void);
213extern thread_t *thread_create(void (*)(void *), void *, task_t *, int,
214 const char *, bool);
215extern void thread_attach(thread_t *, task_t *);
216extern void thread_ready(thread_t *);
217extern void thread_exit(void) __attribute__((noreturn));
218
219#ifndef thread_create_arch
220extern void thread_create_arch(thread_t *);
221#endif
222#ifndef thr_constructor_arch
223extern void thr_constructor_arch(thread_t *);
224#endif
225#ifndef thr_destructor_arch
226extern void thr_destructor_arch(thread_t *);
227#endif
228
229extern void thread_sleep(uint32_t);
230extern void thread_usleep(uint32_t);
231
232#define thread_join(t) \
233 thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
234extern int thread_join_timeout(thread_t *, uint32_t, int);
235extern void thread_detach(thread_t *);
236
237extern void thread_register_call_me(void (*)(void *), void *);
238extern void thread_print_list(void);
239extern void thread_destroy(thread_t *);
240extern void thread_update_accounting(bool);
241extern bool thread_exists(thread_t *);
242
243/** Fpu context slab cache. */
244extern slab_cache_t *fpu_context_slab;
245
246/* Thread syscall prototypes. */
247extern unative_t sys_thread_create(uspace_arg_t *, char *, size_t,
248 thread_id_t *);
249extern unative_t sys_thread_exit(int);
250extern unative_t sys_thread_get_id(thread_id_t *);
251extern unative_t sys_thread_usleep(uint32_t);
252
253#endif
254
255/** @}
256 */
Note: See TracBrowser for help on using the repository browser.