Subversion Repositories HelenOS

Rev

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

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