Subversion Repositories HelenOS

Rev

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

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