WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/include/proc/thread.h


/*
 * Copyright (C) 2001-2004 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __THREAD_H__
#define __THREAD_H__
 
#include <arch/thread.h>
#include <synch/spinlock.h>
#include <arch/context.h>
#include <fpu_context.h>
#include <arch/types.h>
#include <typedefs.h>
#include <time/timeout.h>
#include <synch/rwlock.h>
#include <config.h>
#include <adt/list.h>
#include <mm/slab.h>
#include <proc/uarg.h>
 
#define THREAD_STACK_SIZE   STACK_SIZE
 
enum state {
    Invalid,    /**< It is an error, if thread is found in this state. */
    Running,    /**< State of a thread that is currently executing on some CPU. */
    Sleeping,   /**< Thread in this state is waiting for an event. */
    Ready,      /**< State of threads in a run queue. */
    Entering,   /**< Threads are in this state before they are first readied. */
    Exiting     /**< After a thread calls thread_exit(), it is put into Exiting state. */
};
 
extern char *thread_states[];
 
#define X_WIRED     (1<<0)
#define X_STOLEN    (1<<1)
 
#define THREAD_NAME_BUFLEN  20
 
/** Thread structure. There is one per thread. */
struct thread {
    link_t rq_link;             /**< Run queue link. */
    link_t wq_link;             /**< Wait queue link. */
    link_t th_link;             /**< Links to threads within containing task. */
    link_t threads_link;            /**< Link to the list of all threads. */
   
    /** Lock protecting thread structure.
     *
     * Protects the whole thread structure except list links above.
     * Must be acquired before T.lock for each T of type task_t.
     *
     */
    SPINLOCK_DECLARE(lock);
 
    char name[THREAD_NAME_BUFLEN];
 
    void (* thread_code)(void *);       /**< Function implementing the thread. */
    void *thread_arg;           /**< Argument passed to thread_code() function. */
 
    context_t saved_context;        /**< From here, the stored context is restored when the thread is scheduled. */
    context_t sleep_timeout_context;    /**< From here, the stored failover context is restored when sleep times out. */
 
    waitq_t *sleep_queue;           /**< Wait queue in which this thread sleeps. */
    timeout_t sleep_timeout;        /**< Timeout used for timeoutable sleeping.  */
    volatile int timeout_pending;       /**< Flag signalling sleep timeout in progress. */
 
    fpu_context_t *saved_fpu_context;
    int fpu_context_exists;
 
    /*
     * Defined only if thread doesn't run.
     * It means that fpu context is in CPU that last time executes this thread.
     * This disables migration
     */
    int fpu_context_engaged;
 
    rwlock_type_t rwlock_holder_type;
 
    void (* call_me)(void *);       /**< Funtion to be called in scheduler before the thread is put asleep. */
    void *call_me_with;         /**< Argument passed to call_me(). */
 
    state_t state;              /**< Thread's state. */
    int flags;              /**< Thread's flags. */
   
    cpu_t *cpu;             /**< Thread's CPU. */
    task_t *task;               /**< Containing task. */
 
    __u64 ticks;                /**< Ticks before preemption. */
 
    int priority;               /**< Thread's priority. Implemented as index to CPU->rq */
    __u32 tid;              /**< Thread ID. */
   
    ARCH_THREAD_DATA;           /**< Architecture-specific data. */
 
    __u8 *kstack;               /**< Thread's kernel stack. */
};
 
 
 
 
 
 
 
/** Thread list lock.
 *
 * This lock protects all link_t structures chained in threads_head.
 * Must be acquired before T.lock for each T of type thread_t.
 *
 */
extern spinlock_t threads_lock;
 
extern link_t threads_head;         /**< List of all threads in the system. */
 
extern void thread_init(void);
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
extern void thread_ready(thread_t *t);
extern void thread_exit(void);
 
extern void thread_sleep(__u32 sec);
extern void thread_usleep(__u32 usec);
 
extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
extern void thread_print_list(void);
extern void thread_destroy(thread_t *t);
 
/* Fpu context slab cache */
extern slab_cache_t *fpu_context_slab;
 
/** Thread syscall prototypes. */
__native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
__native sys_thread_exit(int uspace_status);
 
#endif
 

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/proc/thread.h – Rev 1066 → 1078

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