Subversion Repositories HelenOS

Rev

Rev 2292 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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