Subversion Repositories HelenOS

Rev

Rev 2096 | Rev 2106 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

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