Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2001-2004 Jakub Jermar
1 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
 
2089 decky 38
#include <synch/waitq.h>
39
#include <proc/task.h>
2103 decky 40
#include <time/timeout.h>
2089 decky 41
#include <cpu.h>
1 jermar 42
#include <synch/rwlock.h>
1158 jermar 43
#include <adt/btree.h>
906 palkovsky 44
#include <mm/slab.h>
2089 decky 45
#include <arch/cpu.h>
46
#include <mm/tlb.h>
1078 jermar 47
#include <proc/uarg.h>
1 jermar 48
 
173 jermar 49
#define THREAD_STACK_SIZE   STACK_SIZE
2096 decky 50
#define THREAD_NAME_BUFLEN  20
1 jermar 51
 
52
extern char *thread_states[];
53
 
1854 jermar 54
/* Thread flags */
2089 decky 55
#define THREAD_FLAG_WIRED   (1 << 0)    /**< Thread cannot be migrated to another CPU. */
56
#define THREAD_FLAG_STOLEN  (1 << 1)    /**< Thread was migrated to another CPU and has not run yet. */
57
#define THREAD_FLAG_USPACE  (1 << 2)    /**< Thread executes in userspace. */
1 jermar 58
 
2103 decky 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
 
2096 decky 77
/** Thread structure. There is one per thread. */
78
typedef struct thread {
79
    link_t rq_link;             /**< Run queue link. */
80
    link_t wq_link;             /**< Wait queue link. */
81
    link_t th_link;             /**< Links to threads within containing task. */
82
 
83
    /** Lock protecting thread structure.
84
     *
85
     * Protects the whole thread structure except list links above.
86
     */
87
    SPINLOCK_DECLARE(lock);
88
 
89
    char name[THREAD_NAME_BUFLEN];
90
 
91
    void (* thread_code)(void *);       /**< Function implementing the thread. */
92
    void *thread_arg;           /**< Argument passed to thread_code() function. */
93
 
94
    /** From here, the stored context is restored when the thread is scheduled. */
95
    context_t saved_context;
96
    /** From here, the stored timeout context is restored when sleep times out. */
97
    context_t sleep_timeout_context;
98
    /** From here, the stored interruption context is restored when sleep is interrupted. */
99
    context_t sleep_interruption_context;
100
 
101
    bool sleep_interruptible;       /**< If true, the thread can be interrupted from sleep. */
102
    waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
103
    timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
104
    volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
105
 
106
    /** True if this thread is executing copy_from_uspace(). False otherwise. */
107
    bool in_copy_from_uspace;
108
    /** True if this thread is executing copy_to_uspace(). False otherwise. */
109
    bool in_copy_to_uspace;
110
 
111
    /**
112
     * If true, the thread will not go to sleep at all and will
113
     * call thread_exit() before returning to userspace.
114
     */
115
    bool interrupted;          
116
 
117
    thread_join_type_t  join_type;  /**< Who joinins the thread. */
118
    bool detached;              /**< If true, thread_join_timeout() cannot be used on this thread. */
119
    waitq_t join_wq;            /**< Waitq for thread_join_timeout(). */
120
 
121
    fpu_context_t *saved_fpu_context;
122
    int fpu_context_exists;
123
 
124
    /*
125
     * Defined only if thread doesn't run.
126
     * It means that fpu context is in CPU that last time executes this thread.
127
     * This disables migration.
128
     */
129
    int fpu_context_engaged;
130
 
131
    rwlock_type_t rwlock_holder_type;
132
 
133
    void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
134
    void *call_me_with;         /**< Argument passed to call_me(). */
135
 
136
    state_t state;              /**< Thread's state. */
137
    int flags;              /**< Thread's flags. */
138
 
139
    cpu_t *cpu;             /**< Thread's CPU. */
140
    task_t *task;               /**< Containing task. */
141
 
142
    uint64_t ticks;             /**< Ticks before preemption. */
143
 
144
    uint64_t cycles;            /**< Thread accounting. */
145
    uint64_t last_cycle;        /**< Last sampled cycle. */
146
    bool uncounted;             /**< Thread doesn't affect accumulated accounting. */
147
 
148
    int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
149
    uint32_t tid;               /**< Thread ID. */
150
 
151
    thread_arch_t arch;         /**< Architecture-specific data. */
152
 
153
    uint8_t *kstack;            /**< Thread's kernel stack. */
154
} thread_t;
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
 */
2093 decky 162
SPINLOCK_EXTERN(threads_lock);
557 jermar 163
 
1158 jermar 164
extern btree_t threads_btree;           /**< B+tree containing all threads. */
1 jermar 165
 
166
extern void thread_init(void);
2042 decky 167
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name, bool uncounted);
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
1854 jermar 174
#ifndef thr_constructor_arch
175
extern void thr_constructor_arch(thread_t *t);
176
#endif
177
#ifndef thr_destructor_arch
178
extern void thr_destructor_arch(thread_t *t);
179
#endif
1171 jermar 180
 
1780 jermar 181
extern void thread_sleep(uint32_t sec);
182
extern void thread_usleep(uint32_t usec);
1 jermar 183
 
1576 jermar 184
#define thread_join(t)  thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
1780 jermar 185
extern int thread_join_timeout(thread_t *t, uint32_t usec, int flags);
1571 jermar 186
extern void thread_detach(thread_t *t);
187
 
1 jermar 188
extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
777 palkovsky 189
extern void thread_print_list(void);
787 palkovsky 190
extern void thread_destroy(thread_t *t);
2030 decky 191
extern void thread_update_accounting(void);
1158 jermar 192
extern bool thread_exists(thread_t *t);
2089 decky 193
extern void thread_interrupt_sleep(thread_t *t);
1 jermar 194
 
906 palkovsky 195
/* Fpu context slab cache */
196
extern slab_cache_t *fpu_context_slab;
197
 
1066 jermar 198
/** Thread syscall prototypes. */
1780 jermar 199
unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
200
unative_t sys_thread_exit(int uspace_status);
1066 jermar 201
 
1 jermar 202
#endif
1702 cejka 203
 
1820 decky 204
/** @}
1702 cejka 205
 */