source: mainline/kernel/generic/include/proc/thread.h@ 1004b37

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

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