Subversion Repositories HelenOS

Rev

Rev 2268 | Rev 2446 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 2268 Rev 2440
1
/*
1
/*
2
 * Copyright (c) 2001-2004 Jakub Jermar
2
 * Copyright (c) 2001-2004 Jakub Jermar
3
 * All rights reserved.
3
 * All rights reserved.
4
 *
4
 *
5
 * Redistribution and use in source and binary forms, with or without
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
6
 * modification, are permitted provided that the following conditions
7
 * are met:
7
 * are met:
8
 *
8
 *
9
 * - Redistributions of source code must retain the above copyright
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
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
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.
15
 *   derived from this software without specific prior written permission.
16
 *
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
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
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
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
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
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
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.
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
27
 */
28
 
28
 
29
/** @addtogroup genericproc
29
/** @addtogroup genericproc
30
 * @{
30
 * @{
31
 */
31
 */
32
/** @file
32
/** @file
33
 */
33
 */
34
 
34
 
35
#ifndef KERN_THREAD_H_
35
#ifndef KERN_THREAD_H_
36
#define KERN_THREAD_H_
36
#define KERN_THREAD_H_
37
 
37
 
38
#include <synch/waitq.h>
38
#include <synch/waitq.h>
39
#include <proc/task.h>
39
#include <proc/task.h>
40
#include <time/timeout.h>
40
#include <time/timeout.h>
41
#include <cpu.h>
41
#include <cpu.h>
42
#include <synch/rwlock.h>
42
#include <synch/rwlock.h>
43
#include <adt/btree.h>
43
#include <adt/btree.h>
44
#include <mm/slab.h>
44
#include <mm/slab.h>
45
#include <arch/cpu.h>
45
#include <arch/cpu.h>
46
#include <mm/tlb.h>
46
#include <mm/tlb.h>
47
#include <proc/uarg.h>
47
#include <proc/uarg.h>
48
 
48
 
49
#define THREAD_STACK_SIZE   STACK_SIZE
49
#define THREAD_STACK_SIZE   STACK_SIZE
50
#define THREAD_NAME_BUFLEN  20
50
#define THREAD_NAME_BUFLEN  20
51
 
51
 
52
extern char *thread_states[];
52
extern char *thread_states[];
53
 
53
 
54
/* Thread flags */
54
/* Thread flags */
55
 
55
 
56
/** Thread cannot be migrated to another CPU.
56
/** Thread cannot be migrated to another CPU.
57
 *
57
 *
58
 * When using this flag, the caller must set cpu in the thread_t
58
 * When using this flag, the caller must set cpu in the thread_t
59
 * structure manually before calling thread_ready (even on uniprocessor).
59
 * structure manually before calling thread_ready (even on uniprocessor).
60
 */
60
 */
61
#define THREAD_FLAG_WIRED   (1 << 0)
61
#define THREAD_FLAG_WIRED   (1 << 0)
62
/** Thread was migrated to another CPU and has not run yet. */
62
/** Thread was migrated to another CPU and has not run yet. */
63
#define THREAD_FLAG_STOLEN  (1 << 1)
63
#define THREAD_FLAG_STOLEN  (1 << 1)
64
/** Thread executes in userspace. */
64
/** Thread executes in userspace. */
65
#define THREAD_FLAG_USPACE  (1 << 2)
65
#define THREAD_FLAG_USPACE  (1 << 2)
-
 
66
/** Thread will be attached by the caller. */
-
 
67
#define THREAD_FLAG_NOATTACH    (1 << 3)
66
 
68
 
67
/** Thread states. */
69
/** Thread states. */
68
typedef enum {
70
typedef enum {
69
    /** It is an error, if thread is found in this state. */
71
    /** It is an error, if thread is found in this state. */
70
    Invalid,
72
    Invalid,
71
    /** State of a thread that is currently executing on some CPU. */
73
    /** State of a thread that is currently executing on some CPU. */
72
    Running,
74
    Running,
73
    /** Thread in this state is waiting for an event. */
75
    /** Thread in this state is waiting for an event. */
74
    Sleeping,
76
    Sleeping,
75
    /** State of threads in a run queue. */
77
    /** State of threads in a run queue. */
76
    Ready,
78
    Ready,
77
    /** Threads are in this state before they are first readied. */
79
    /** Threads are in this state before they are first readied. */
78
    Entering,
80
    Entering,
79
    /** After a thread calls thread_exit(), it is put into Exiting state. */
81
    /** After a thread calls thread_exit(), it is put into Exiting state. */
80
    Exiting,
82
    Exiting,
81
    /** Threads that were not detached but exited are in the Undead state. */
83
    /** Threads that were not detached but exited are in the Undead state. */
82
    Undead
84
    Undead
83
} state_t;
85
} state_t;
84
 
86
 
85
/** Join types. */
87
/** Join types. */
86
typedef enum {
88
typedef enum {
87
    None,
89
    None,
88
    TaskClnp,   /**< The thread will be joined by ktaskclnp thread. */
90
    TaskClnp,   /**< The thread will be joined by ktaskclnp thread. */
89
    TaskGC      /**< The thread will be joined by ktaskgc thread. */
91
    TaskGC      /**< The thread will be joined by ktaskgc thread. */
90
} thread_join_type_t;
92
} thread_join_type_t;
91
 
93
 
92
/** Thread structure. There is one per thread. */
94
/** Thread structure. There is one per thread. */
93
typedef struct thread {
95
typedef struct thread {
94
    link_t rq_link;     /**< Run queue link. */
96
    link_t rq_link;     /**< Run queue link. */
95
    link_t wq_link;     /**< Wait queue link. */
97
    link_t wq_link;     /**< Wait queue link. */
96
    link_t th_link;     /**< Links to threads within containing task. */
98
    link_t th_link;     /**< Links to threads within containing task. */
97
   
99
   
98
    /** Lock protecting thread structure.
100
    /** Lock protecting thread structure.
99
     *
101
     *
100
     * Protects the whole thread structure except list links above.
102
     * Protects the whole thread structure except list links above.
101
     */
103
     */
102
    SPINLOCK_DECLARE(lock);
104
    SPINLOCK_DECLARE(lock);
103
 
105
 
104
    char name[THREAD_NAME_BUFLEN];
106
    char name[THREAD_NAME_BUFLEN];
105
 
107
 
106
    /** Function implementing the thread. */
108
    /** Function implementing the thread. */
107
    void (* thread_code)(void *);
109
    void (* thread_code)(void *);
108
    /** Argument passed to thread_code() function. */
110
    /** Argument passed to thread_code() function. */
109
    void *thread_arg;
111
    void *thread_arg;
110
 
112
 
111
    /**
113
    /**
112
     * From here, the stored context is restored when the thread is
114
     * From here, the stored context is restored when the thread is
113
     * scheduled.
115
     * scheduled.
114
     */
116
     */
115
    context_t saved_context;
117
    context_t saved_context;
116
    /**
118
    /**
117
     * From here, the stored timeout context is restored when sleep times
119
     * From here, the stored timeout context is restored when sleep times
118
     * out.
120
     * out.
119
     */
121
     */
120
    context_t sleep_timeout_context;
122
    context_t sleep_timeout_context;
121
    /**
123
    /**
122
     * From here, the stored interruption context is restored when sleep is
124
     * From here, the stored interruption context is restored when sleep is
123
     * interrupted.
125
     * interrupted.
124
     */
126
     */
125
    context_t sleep_interruption_context;
127
    context_t sleep_interruption_context;
126
 
128
 
127
    /** If true, the thread can be interrupted from sleep. */
129
    /** If true, the thread can be interrupted from sleep. */
128
    bool sleep_interruptible;
130
    bool sleep_interruptible;
129
    /** Wait queue in which this thread sleeps. */
131
    /** Wait queue in which this thread sleeps. */
130
    waitq_t *sleep_queue;
132
    waitq_t *sleep_queue;
131
    /** Timeout used for timeoutable sleeping.  */
133
    /** Timeout used for timeoutable sleeping.  */
132
    timeout_t sleep_timeout;
134
    timeout_t sleep_timeout;
133
    /** Flag signalling sleep timeout in progress. */
135
    /** Flag signalling sleep timeout in progress. */
134
    volatile int timeout_pending;
136
    volatile int timeout_pending;
135
 
137
 
136
    /**
138
    /**
137
     * True if this thread is executing copy_from_uspace().
139
     * True if this thread is executing copy_from_uspace().
138
     * False otherwise.
140
     * False otherwise.
139
     */
141
     */
140
    bool in_copy_from_uspace;
142
    bool in_copy_from_uspace;
141
    /**
143
    /**
142
     * True if this thread is executing copy_to_uspace().
144
     * True if this thread is executing copy_to_uspace().
143
     * False otherwise.
145
     * False otherwise.
144
     */
146
     */
145
    bool in_copy_to_uspace;
147
    bool in_copy_to_uspace;
146
   
148
   
147
    /**
149
    /**
148
     * If true, the thread will not go to sleep at all and will call
150
     * If true, the thread will not go to sleep at all and will call
149
     * thread_exit() before returning to userspace.
151
     * thread_exit() before returning to userspace.
150
     */
152
     */
151
    bool interrupted;          
153
    bool interrupted;          
152
   
154
   
153
    /** Who joinins the thread. */
155
    /** Who joinins the thread. */
154
    thread_join_type_t join_type;
156
    thread_join_type_t join_type;
155
    /** If true, thread_join_timeout() cannot be used on this thread. */
157
    /** If true, thread_join_timeout() cannot be used on this thread. */
156
    bool detached;
158
    bool detached;
157
    /** Waitq for thread_join_timeout(). */
159
    /** Waitq for thread_join_timeout(). */
158
    waitq_t join_wq;
160
    waitq_t join_wq;
159
 
161
 
160
    fpu_context_t *saved_fpu_context;
162
    fpu_context_t *saved_fpu_context;
161
    int fpu_context_exists;
163
    int fpu_context_exists;
162
 
164
 
163
    /*
165
    /*
164
     * Defined only if thread doesn't run.
166
     * Defined only if thread doesn't run.
165
     * It means that fpu context is in CPU that last time executes this
167
     * It means that fpu context is in CPU that last time executes this
166
     * thread. This disables migration.
168
     * thread. This disables migration.
167
     */
169
     */
168
    int fpu_context_engaged;
170
    int fpu_context_engaged;
169
 
171
 
170
    rwlock_type_t rwlock_holder_type;
172
    rwlock_type_t rwlock_holder_type;
171
 
173
 
172
    /** Callback fired in scheduler before the thread is put asleep. */
174
    /** Callback fired in scheduler before the thread is put asleep. */
173
    void (* call_me)(void *);
175
    void (* call_me)(void *);
174
    /** Argument passed to call_me(). */
176
    /** Argument passed to call_me(). */
175
    void *call_me_with;
177
    void *call_me_with;
176
 
178
 
177
    /** Thread's state. */
179
    /** Thread's state. */
178
    state_t state;
180
    state_t state;
179
    /** Thread's flags. */
181
    /** Thread's flags. */
180
    int flags;
182
    int flags;
181
   
183
   
182
    /** Thread's CPU. */
184
    /** Thread's CPU. */
183
    cpu_t *cpu;
185
    cpu_t *cpu;
184
    /** Containing task. */
186
    /** Containing task. */
185
    task_t *task;
187
    task_t *task;
186
 
188
 
187
    /** Ticks before preemption. */
189
    /** Ticks before preemption. */
188
    uint64_t ticks;
190
    uint64_t ticks;
189
   
191
   
190
    /** Thread accounting. */
192
    /** Thread accounting. */
191
    uint64_t cycles;
193
    uint64_t cycles;
192
    /** Last sampled cycle. */
194
    /** Last sampled cycle. */
193
    uint64_t last_cycle;
195
    uint64_t last_cycle;
194
    /** Thread doesn't affect accumulated accounting. */   
196
    /** Thread doesn't affect accumulated accounting. */   
195
    bool uncounted;
197
    bool uncounted;
196
 
198
 
197
    /** Thread's priority. Implemented as index to CPU->rq */
199
    /** Thread's priority. Implemented as index to CPU->rq */
198
    int priority;
200
    int priority;
199
    /** Thread ID. */
201
    /** Thread ID. */
200
    thread_id_t tid;
202
    thread_id_t tid;
201
   
203
   
202
    /** Architecture-specific data. */
204
    /** Architecture-specific data. */
203
    thread_arch_t arch;
205
    thread_arch_t arch;
204
 
206
 
205
    /** Thread's kernel stack. */
207
    /** Thread's kernel stack. */
206
    uint8_t *kstack;
208
    uint8_t *kstack;
207
} thread_t;
209
} thread_t;
208
 
210
 
209
/** Thread list lock.
211
/** Thread list lock.
210
 *
212
 *
211
 * This lock protects all link_t structures chained in threads_head.
213
 * 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.
214
 * Must be acquired before T.lock for each T of type thread_t.
213
 *
215
 *
214
 */
216
 */
215
SPINLOCK_EXTERN(threads_lock);
217
SPINLOCK_EXTERN(threads_lock);
216
 
218
 
217
/** B+tree containing all threads. */
219
/** B+tree containing all threads. */
218
extern btree_t threads_btree;
220
extern btree_t threads_btree;
219
 
221
 
220
extern void thread_init(void);
222
extern void thread_init(void);
221
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task,
223
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task,
222
    int flags, char *name, bool uncounted);
224
    int flags, char *name, bool uncounted);
-
 
225
extern void thread_attach(thread_t *t, task_t *task);
223
extern void thread_ready(thread_t *t);
226
extern void thread_ready(thread_t *t);
224
extern void thread_exit(void) __attribute__((noreturn));
227
extern void thread_exit(void) __attribute__((noreturn));
225
 
228
 
226
#ifndef thread_create_arch
229
#ifndef thread_create_arch
227
extern void thread_create_arch(thread_t *t);
230
extern void thread_create_arch(thread_t *t);
228
#endif
231
#endif
229
#ifndef thr_constructor_arch
232
#ifndef thr_constructor_arch
230
extern void thr_constructor_arch(thread_t *t);
233
extern void thr_constructor_arch(thread_t *t);
231
#endif
234
#endif
232
#ifndef thr_destructor_arch
235
#ifndef thr_destructor_arch
233
extern void thr_destructor_arch(thread_t *t);
236
extern void thr_destructor_arch(thread_t *t);
234
#endif
237
#endif
235
 
238
 
236
extern void thread_sleep(uint32_t sec);
239
extern void thread_sleep(uint32_t sec);
237
extern void thread_usleep(uint32_t usec);
240
extern void thread_usleep(uint32_t usec);
238
 
241
 
239
#define thread_join(t) \
242
#define thread_join(t) \
240
    thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
243
    thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
241
extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
244
extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
242
extern void thread_detach(thread_t *t);
245
extern void thread_detach(thread_t *t);
243
 
246
 
244
extern void thread_register_call_me(void (* call_me)(void *),
247
extern void thread_register_call_me(void (* call_me)(void *),
245
    void *call_me_with);
248
    void *call_me_with);
246
extern void thread_print_list(void);
249
extern void thread_print_list(void);
247
extern void thread_destroy(thread_t *t);
250
extern void thread_destroy(thread_t *t);
248
extern void thread_update_accounting(void);
251
extern void thread_update_accounting(void);
249
extern bool thread_exists(thread_t *t);
252
extern bool thread_exists(thread_t *t);
250
 
253
 
251
/** Fpu context slab cache. */
254
/** Fpu context slab cache. */
252
extern slab_cache_t *fpu_context_slab;
255
extern slab_cache_t *fpu_context_slab;
253
 
256
 
254
/* Thread syscall prototypes. */
257
/* Thread syscall prototypes. */
255
extern unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name, thread_id_t *uspace_thread_id);
258
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);
259
extern unative_t sys_thread_exit(int uspace_status);
257
extern unative_t sys_thread_get_id(thread_id_t *uspace_thread_id);
260
extern unative_t sys_thread_get_id(thread_id_t *uspace_thread_id);
258
 
261
 
259
#endif
262
#endif
260
 
263
 
261
/** @}
264
/** @}
262
 */
265
 */
263
 
266