Subversion Repositories HelenOS

Rev

Rev 1158 | Rev 1184 | 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
 
29
#ifndef __THREAD_H__
30
#define __THREAD_H__
31
 
32
#include <arch/thread.h>
33
#include <synch/spinlock.h>
34
#include <arch/context.h>
56 vana 35
#include <fpu_context.h>
1 jermar 36
#include <arch/types.h>
37
#include <typedefs.h>
38
#include <time/timeout.h>
39
#include <synch/rwlock.h>
173 jermar 40
#include <config.h>
1158 jermar 41
#include <adt/btree.h>
788 jermar 42
#include <adt/list.h>
906 palkovsky 43
#include <mm/slab.h>
1078 jermar 44
#include <proc/uarg.h>
1 jermar 45
 
173 jermar 46
#define THREAD_STACK_SIZE   STACK_SIZE
1 jermar 47
 
48
enum state {
410 jermar 49
    Invalid,    /**< It is an error, if thread is found in this state. */
50
    Running,    /**< State of a thread that is currently executing on some CPU. */
51
    Sleeping,   /**< Thread in this state is waiting for an event. */
52
    Ready,      /**< State of threads in a run queue. */
53
    Entering,   /**< Threads are in this state before they are first readied. */
54
    Exiting     /**< After a thread calls thread_exit(), it is put into Exiting state. */
1 jermar 55
};
56
 
57
extern char *thread_states[];
58
 
59
#define X_WIRED     (1<<0)
60
#define X_STOLEN    (1<<1)
61
 
1066 jermar 62
#define THREAD_NAME_BUFLEN  20
63
 
1062 jermar 64
/** Thread structure. There is one per thread. */
1 jermar 65
struct thread {
410 jermar 66
    link_t rq_link;             /**< Run queue link. */
67
    link_t wq_link;             /**< Wait queue link. */
68
    link_t th_link;             /**< Links to threads within containing task. */
1 jermar 69
 
557 jermar 70
    /** Lock protecting thread structure.
71
     *
72
     * Protects the whole thread structure except list links above.
73
     * Must be acquired before T.lock for each T of type task_t.
74
     *
75
     */
623 jermar 76
    SPINLOCK_DECLARE(lock);
1 jermar 77
 
1066 jermar 78
    char name[THREAD_NAME_BUFLEN];
79
 
410 jermar 80
    void (* thread_code)(void *);       /**< Function implementing the thread. */
81
    void *thread_arg;           /**< Argument passed to thread_code() function. */
1 jermar 82
 
1156 jermar 83
    /** From here, the stored context is restored when the thread is scheduled. */
84
    context_t saved_context;
85
    /** From here, the stored timeout context is restored when sleep times out. */
86
    context_t sleep_timeout_context;
87
    /** From here, the stored interruption context is restored when sleep is interrupted. */
88
    context_t sleep_interruption_context;
410 jermar 89
 
90
    waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
91
    timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
92
    volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
93
 
906 palkovsky 94
    fpu_context_t *saved_fpu_context;
125 jermar 95
    int fpu_context_exists;
96
 
97
    /*
98
     * Defined only if thread doesn't run.
99
     * It means that fpu context is in CPU that last time executes this thread.
100
     * This disables migration
101
     */
102
    int fpu_context_engaged;
103
 
1 jermar 104
    rwlock_type_t rwlock_holder_type;
105
 
410 jermar 106
    void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
107
    void *call_me_with;         /**< Argument passed to call_me(). */
108
 
109
    state_t state;              /**< Thread's state. */
110
    int flags;              /**< Thread's flags. */
1 jermar 111
 
410 jermar 112
    cpu_t *cpu;             /**< Thread's CPU. */
113
    task_t *task;               /**< Containing task. */
1 jermar 114
 
410 jermar 115
    __u64 ticks;                /**< Ticks before preemption. */
1 jermar 116
 
413 jermar 117
    int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
410 jermar 118
    __u32 tid;              /**< Thread ID. */
1 jermar 119
 
410 jermar 120
    ARCH_THREAD_DATA;           /**< Architecture-specific data. */
1 jermar 121
 
410 jermar 122
    __u8 *kstack;               /**< Thread's kernel stack. */
1 jermar 123
};
124
 
557 jermar 125
/** Thread list lock.
126
 *
127
 * This lock protects all link_t structures chained in threads_head.
128
 * Must be acquired before T.lock for each T of type thread_t.
129
 *
130
 */
131
extern spinlock_t threads_lock;
132
 
1158 jermar 133
extern btree_t threads_btree;           /**< B+tree containing all threads. */
1 jermar 134
 
135
extern void thread_init(void);
1062 jermar 136
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
1 jermar 137
extern void thread_ready(thread_t *t);
138
extern void thread_exit(void);
139
 
1171 jermar 140
#ifndef thread_create_arch
141
extern void thread_create_arch(thread_t *t);
142
#endif
143
 
1 jermar 144
extern void thread_sleep(__u32 sec);
145
extern void thread_usleep(__u32 usec);
146
 
147
extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
777 palkovsky 148
extern void thread_print_list(void);
787 palkovsky 149
extern void thread_destroy(thread_t *t);
1158 jermar 150
extern bool thread_exists(thread_t *t);
1 jermar 151
 
906 palkovsky 152
/* Fpu context slab cache */
153
extern slab_cache_t *fpu_context_slab;
154
 
1066 jermar 155
/** Thread syscall prototypes. */
1078 jermar 156
__native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
157
__native sys_thread_exit(int uspace_status);
1066 jermar 158
 
1 jermar 159
#endif