Subversion Repositories HelenOS

Rev

Rev 1787 | Rev 1839 | 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
 
1 jermar 35
#ifndef __THREAD_H__
36
#define __THREAD_H__
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
 
1661 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
 
1661 jermar 68
/**< Join types. */
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
 
1 jermar 75
#define X_WIRED     (1<<0)
76
#define X_STOLEN    (1<<1)
77
 
1066 jermar 78
#define THREAD_NAME_BUFLEN  20
79
 
1062 jermar 80
/** Thread structure. There is one per thread. */
1 jermar 81
struct thread {
410 jermar 82
    link_t rq_link;             /**< Run queue link. */
83
    link_t wq_link;             /**< Wait queue link. */
84
    link_t th_link;             /**< Links to threads within containing task. */
1 jermar 85
 
557 jermar 86
    /** Lock protecting thread structure.
87
     *
88
     * Protects the whole thread structure except list links above.
89
     */
623 jermar 90
    SPINLOCK_DECLARE(lock);
1 jermar 91
 
1066 jermar 92
    char name[THREAD_NAME_BUFLEN];
93
 
410 jermar 94
    void (* thread_code)(void *);       /**< Function implementing the thread. */
95
    void *thread_arg;           /**< Argument passed to thread_code() function. */
1 jermar 96
 
1156 jermar 97
    /** From here, the stored context is restored when the thread is scheduled. */
98
    context_t saved_context;
99
    /** From here, the stored timeout context is restored when sleep times out. */
100
    context_t sleep_timeout_context;
101
    /** From here, the stored interruption context is restored when sleep is interrupted. */
102
    context_t sleep_interruption_context;
410 jermar 103
 
1502 jermar 104
    bool sleep_interruptible;       /**< If true, the thread can be interrupted from sleep. */
410 jermar 105
    waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
106
    timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
107
    volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
108
 
1288 jermar 109
    /** True if this thread is executing copy_from_uspace(). False otherwise. */
110
    bool in_copy_from_uspace;
111
    /** True if this thread is executing copy_to_uspace(). False otherwise. */
112
    bool in_copy_to_uspace;
1579 jermar 113
 
114
    /**
115
     * If true, the thread will not go to sleep at all and will
116
     * call thread_exit() before returning to userspace.
117
     */
118
    bool interrupted;          
119
 
1661 jermar 120
    thread_join_type_t  join_type;  /**< Who joinins the thread. */
1571 jermar 121
    bool detached;              /**< If true, thread_join_timeout() cannot be used on this thread. */
122
    waitq_t join_wq;            /**< Waitq for thread_join_timeout(). */
1288 jermar 123
 
906 palkovsky 124
    fpu_context_t *saved_fpu_context;
125 jermar 125
    int fpu_context_exists;
126
 
127
    /*
128
     * Defined only if thread doesn't run.
129
     * It means that fpu context is in CPU that last time executes this thread.
130
     * This disables migration
131
     */
132
    int fpu_context_engaged;
133
 
1 jermar 134
    rwlock_type_t rwlock_holder_type;
135
 
410 jermar 136
    void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
137
    void *call_me_with;         /**< Argument passed to call_me(). */
138
 
139
    state_t state;              /**< Thread's state. */
140
    int flags;              /**< Thread's flags. */
1 jermar 141
 
410 jermar 142
    cpu_t *cpu;             /**< Thread's CPU. */
143
    task_t *task;               /**< Containing task. */
1 jermar 144
 
1780 jermar 145
    uint64_t ticks;             /**< Ticks before preemption. */
1 jermar 146
 
413 jermar 147
    int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
1780 jermar 148
    uint32_t tid;               /**< Thread ID. */
1820 decky 149
    context_id_t context;       /**< Thread security context */
1 jermar 150
 
1184 jermar 151
    thread_arch_t arch;         /**< Architecture-specific data. */
1 jermar 152
 
1780 jermar 153
    uint8_t *kstack;                /**< Thread's kernel stack. */
1 jermar 154
};
155
 
557 jermar 156
/** Thread list lock.
157
 *
158
 * This lock protects all link_t structures chained in threads_head.
159
 * Must be acquired before T.lock for each T of type thread_t.
160
 *
161
 */
162
extern spinlock_t threads_lock;
163
 
1158 jermar 164
extern btree_t threads_btree;           /**< B+tree containing all threads. */
1 jermar 165
 
166
extern void thread_init(void);
1062 jermar 167
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
1 jermar 168
extern void thread_ready(thread_t *t);
1595 palkovsky 169
extern void thread_exit(void) __attribute__((noreturn));
1 jermar 170
 
1171 jermar 171
#ifndef thread_create_arch
172
extern void thread_create_arch(thread_t *t);
173
#endif
174
 
1780 jermar 175
extern void thread_sleep(uint32_t sec);
176
extern void thread_usleep(uint32_t usec);
1 jermar 177
 
1576 jermar 178
#define thread_join(t)  thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
1780 jermar 179
extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
1571 jermar 180
extern void thread_detach(thread_t *t);
181
 
1 jermar 182
extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
777 palkovsky 183
extern void thread_print_list(void);
787 palkovsky 184
extern void thread_destroy(thread_t *t);
1158 jermar 185
extern bool thread_exists(thread_t *t);
1 jermar 186
 
906 palkovsky 187
/* Fpu context slab cache */
188
extern slab_cache_t *fpu_context_slab;
189
 
1066 jermar 190
/** Thread syscall prototypes. */
1780 jermar 191
unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
192
unative_t sys_thread_exit(int uspace_status);
1066 jermar 193
 
1 jermar 194
#endif
1702 cejka 195
 
1820 decky 196
/** @}
1702 cejka 197
 */