Context Navigation

source: trunk/kernel/kern/thread.h @ 396

Last change on this file since 396 was 367, checked in by alain, 7 years ago
Change Time unit from cycle to TICK (in millisecond). Fix several bugs in VFS.
File size: 27.8 KB

Line
1	/*
2	* thread.h - Thread and related operations definition.
3	*
4	* Author Ghassan Almaless (2008,2009,2010,2011,2012)
5	* Alain Greiner (2016)
6	*
7	* Copyright (c) UPMC Sorbonne Universites
8	*
9	* This file is part of ALMOS-MKH.
10	*
11	* ALMOS-MKH is free software; you can redistribute it and/or modify it
12	* under the terms of the GNU General Public License as published by
13	* the Free Software Foundation; version 2.0 of the License.
14	*
15	* ALMOS-MKH is distributed in the hope that it will be useful, but
16	* WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18	* General Public License for more details.
19	*
20	* You should have received a copy of the GNU General Public License
21	* along with ALMOS-MKH; if not, write to the Free Software Foundation,
22	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23	*/
24
25	#ifndef _THREAD_H_
26	#define _THREAD_H_
27
28	#include <hal_types.h>
29	#include <hal_special.h>
30	#include <xlist.h>
31	#include <list.h>
32	#include <hal_context.h>
33	#include <spinlock.h>
34	#include <core.h>
35	#include <cluster.h>
36	#include <process.h>
37	#include <dev_ioc.h>
38	#include <dev_nic.h>
39	#include <dev_txt.h>
40	#include <dev_mmc.h>
41	#include <dev_dma.h>
42
43	/***************************************************************************************
44	* These macros are used to compose or decompose global thread identifier (TRDID)
45	* to or from cluster identifier / local thread index (CXY , LTID)
46	**************************************************************************************/
47
48	#define LTID_FROM_TRDID( trdid ) (ltid_t)(trdid & 0x0000FFFF)
49	#define CXY_FROM_TRDID( trdid ) (cxy_t)(trdid >> 16)
50	#define TRDID( cxy , ltid ) (trdid_t)((cxy << 16) \| ltid )
51
52	/***************************************************************************************
53	* This defines the various pthread_attr_t attributes bit-vector.
54	**************************************************************************************/
55
56	/***************************************************************************************
57	* This opaque structure contains the user defined attributes for a user thread.
58	* It is passed as input argument to the thread_user_create() function.
59	* It is set by the user application itself, using the pthread_attr_***() functions.
60	* The currently supported attributes are defined below.
61	**************************************************************************************/
62
63	typedef struct pthread_attr_s
64	{
65	uint32_t attributes; /! user defined attributes bit vector /
66	cxy_t cxy; /! target cluster identifier /
67	lid_t lid; /! target core index /
68	}
69	pthread_attr_t;
70
71	typedef enum
72	{
73	PT_ATTR_DETACH = 0x0001, /! user defined not joinable /
74	PT_ATTR_CLUSTER_DEFINED = 0x0002, /! user defined target cluster /
75	PT_ATTR_CORE_DEFINED = 0x0004, /! user defined core index in cluster /
76	}
77	pt_attributes_t;
78
79	/***************************************************************************************
80	* This enum defines the thread types.
81	**************************************************************************************/
82
83	typedef enum
84	{
85	THREAD_USER = 0, /! user thread (pthread) /
86	THREAD_RPC = 1, /! kernel thread executing pending RPCs /
87	THREAD_DEV = 2, /! kernel thread executing I/O device commands /
88	THREAD_KERNEL = 3, /! other kernel thread /
89	THREAD_IDLE = 4, /! kernel idle thread /
90	THREAD_TYPES_NR
91	}
92	thread_type_t;
93
94	/***************************************************************************************
95	* This defines the thread flags bit-vector.
96	**************************************************************************************/
97
98	#define THREAD_FLAG_LOADABLE 0x0001 /! This thread has not been executed yet /
99	#define THREAD_FLAG_DETACHED 0x0002 /! This thread is detached from parent /
100	#define THREAD_FLAG_JOIN 0x0004 /! Parent thread made a join /
101	#define THREAD_FLAG_EXIT 0x0008 /! This thread made an exit /
102	#define THREAD_FLAG_SCHED 0x0010 /! Descheduling required for this thread /
103
104	/***************************************************************************************
105	* This defines the masks associated to the thread signals.
106	**************************************************************************************/
107
108	#define THREAD_SIG_KILL 0x0001 /! This thread must be destroyed ASAP /
109
110	/***************************************************************************************
111	* This defines the masks associated to the blocking causes.
112	**************************************************************************************/
113
114	#define THREAD_BLOCKED_GLOBAL 0x0001 /! thread deactivated / wait activation /
115	#define THREAD_BLOCKED_IO 0x0002 /! thread wait IO operation completion /
116	#define THREAD_BLOCKED_MAPPER 0x0004 /! thread wait mapper /
117	#define THREAD_BLOCKED_JOIN 0x0008 /! thread blocked in join / wait exit /
118	#define THREAD_BLOCKED_EXIT 0x0010 /! thread blocked in exit / wait join i /
119	#define THREAD_BLOCKED_KILL 0x0020 /! thread received kill signal /
120	#define THREAD_BLOCKED_SEM 0x0040 /! thread wait semaphore /
121	#define THREAD_BLOCKED_PAGE 0x0080 /! thread wait page access /
122	#define THREAD_BLOCKED_USERSYNC 0x0100 /! thread wait POSIX (cond/mutex/barrier) /
123
124	#define THREAD_BLOCKED_IDLE 0x1000 /! thread RPC wait activation /
125	#define THREAD_BLOCKED_DEV_QUEUE 0x2000 /! thread DEV wait queue /
126	#define THREAD_BLOCKED_DEV_ISR 0x4000 /! thread DEV wait ISR /
127
128	/***************************************************************************************
129	* This structure defines thread instrumentation informations.
130	**************************************************************************************/
131
132	typedef struct thread_info_s
133	{
134	uint32_t pgfault_nr; /! cumulated number of page fault /
135	uint32_t sched_nr; /! TODO ??? [AG] /
136	uint32_t u_err_nr; /! TODO ??? [AG] /
137	uint32_t m_err_nr; /! TODO ??? [AG] /
138	uint32_t tm_tmp; /! temp date to compute execution duration /
139	uint32_t tm_exec; /! TODO ??? [AG] /
140	uint32_t tm_create; /! date of the creation /
141	uint32_t tm_born; /! date of the thread loading /
142	uint32_t tm_dead; /! date of the death /
143	cycle_t tm_sleep; /! TODO ??? [AG] /
144	cycle_t tm_wait; /! TODO ??? [AG] /
145	cycle_t tm_usr; /! user execution duration /
146	cycle_t tm_sys; /! system execution duration /
147	}
148	thread_info_t;
149
150	/***************************************************************************************
151	* This structure defines a thread descriptor.
152	* It is used for both the user threads and the kernel threads.
153	* In a process, a user thread is identified by a unique TRDID (thread identifier),
154	* that is returned by the kernel to the user:
155	* - The TRDID 16 LSB bits contain the LTID (Local Thread Index).
156	* - The TRDID 16 MSB bits contain the CXY of cluster containing the thread.
157	* - The LTID is used to index the th_tbl[] array in the local process descriptor.
158	* This TRDID is computed by the process_register_thread() function, when the user
159	* thread is registered in the local copy of the process descriptor.
160	**************************************************************************************/
161
162	#define THREAD_SIGNATURE 0xDEADBEEF
163
164	typedef struct thread_s
165	{
166	void * cpu_uzone; /! used for exception/interrupt/syscall /
167	void * cpu_context; /! used for context switch /
168	void * fpu_context; /! used for dynamic FPU allocation /
169
170	uint32_t trdid; /! thread index (cxy.ltid) /
171	thread_type_t type; /! thread type /
172	uint32_t quantum; /! number of clock ticks given to thread /
173	uint32_t ticks_nr; /! number of ticks used /
174	uint32_t time_last_check; /! last cpu_time_stamp /
175	core_t * core; /! pointer to the owner core /
176	process_t * process; /! pointer on local process descriptor /
177	xptr_t parent; /! extended pointer on parent thread /
178
179	void * exit_value; /! exit_value used in case of join /
180
181	uint32_t local_locks; /! number of local locks owned by thread /
182	list_entry_t locks_root; /! root of local locks list /
183
184	remote_spinlock_t * flags_lock; /! lock protecting the flags /
185
186	uint32_t remote_locks; /! number of local locks owned by thread /
187	xlist_entry_t xlocks_root; /! root of remote locks list /
188
189	intptr_t u_stack_base; /! user stack base address /
190	uint32_t u_stack_size; /! user stack size (bytes) /
191	intptr_t k_stack_base; /! kernel stack base address /
192	uint32_t k_stack_size; /! kernel stack size (bytes) /
193
194	void * entry_func; /! pointer on entry function /
195	void * entry_args; /! pointer on entry function arguments /
196
197	uint32_t flags; /! bit vector of flags /
198	uint32_t blocked; /! bit vector of blocking causes /
199	uint32_t signals; /! bit vector of signals /
200
201	error_t errno; /! errno value set by last system call /
202	uint32_t utls; /! user thread local storage /
203
204	bool_t fork_user; /! user defined placement for next fork() /
205	cxy_t fork_cxy; /! target cluster for next fork() /
206
207	xlist_entry_t children_root; /! root of list of attached children /
208	uint32_t children_nr; /! number of attached children threads /
209	remote_spinlock_t * children_lock; /! lock protecting the children list /
210
211	xlist_entry_t brothers_list; /! member of threads with same parent /
212
213	list_entry_t sched_list; /! member of threads attached to same core /
214
215	uint32_t dev_channel; /! device channel for a DEV thread /
216
217	ioc_command_t ioc_cmd; /! IOC device generic command /
218	txt_command_t txt_cmd; /! TXT device generic command /
219	nic_command_t nic_cmd; /! NIC device generic command /
220	mmc_command_t mmc_cmd; /! MMC device generic command /
221	dma_command_t dma_cmd; /! DMA device generic command /
222
223	cxy_t rpc_client_cxy; /! client cluster index (for a RPC thread) /
224
225	xlist_entry_t wait_list; /! member of threads blocked on same cond /
226
227	thread_info_t info; /! embedded thread_info_t /
228
229	uint32_t signature; /! for kernel stack overflow detection /
230	}
231	thread_t;
232
233	/***************************************************************************************
234	* This macro returns a pointer on the calling thread from the core hardware register.
235	**************************************************************************************/
236
237	#define CURRENT_THREAD (hal_get_current_thread())
238
239	/***************************************************************************************
240	* This function returns a printable string for a thread type.
241	***************************************************************************************
242	* @ type : thread type.
243	* returns pointer on string.
244	**************************************************************************************/
245	char * thread_type_str( uint32_t type );
246
247	/***************************************************************************************
248	* This function allocates memory for a user thread descriptor in the local cluster,
249	* and initializes it from information contained in the arguments.
250	* It is used by the "pthread_create" system call.
251	* The CPU context is initialized from scratch, and the "loadable" field is set.
252	* The new thread is attached to the core specified in the <attr> argument.
253	* It is registered in the local process descriptor specified by the <pid> argument.
254	* The thread descriptor pointer is returned to allow the parent thread to register it
255	* in its children list.
256	* The THREAD_BLOCKED_GLOBAL bit is set => the thread must be activated to start.
257	***************************************************************************************
258	* @ pid : process identifier.
259	* @ start_func : pointer on entry function.
260	* @ start_args : pointer on function argument (can be NULL).
261	* @ attr : pointer on pthread attributes descriptor.
262	* @ new_thread : [out] address of buffer for new thread descriptor pointer.
263	* @ returns 0 if success / returns ENOMEM if error.
264	**************************************************************************************/
265	error_t thread_user_create( pid_t pid,
266	void * start_func,
267	void * start_arg,
268	pthread_attr_t * attr,
269	thread_t ** new_thread );
270
271	/***************************************************************************************
272	* This function allocates memory for an user thread descriptor in the local cluster,
273	* and initializes it from information contained in the calling thread descriptor.
274	* It is used by the fork() system call to create the child process main thread.
275	* The new thread is attached to the core with the lowest load.
276	* It is registered in the process descriptor defined by the "process" argument.
277	* This new thread inherits its execution context from the calling thread,
278	* and the "loadable" field is NOT set.
279	* The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.
280	***************************************************************************************
281	* @ process : local pointer on owner process descriptor.
282	* @ new_thread : [out] address of buffer for new thread descriptor pointer.
283	* @ returns 0 if success / returns ENOMEM if error.
284	**************************************************************************************/
285	error_t thread_user_fork( process_t * process,
286	thread_t ** new_thread );
287
288	/***************************************************************************************
289	* This function allocates memory for a kernel thread descriptor in the local cluster,
290	* and initializes it from arguments values, calling the thread_kernel_init() function,
291	* that also allocates and initializes the CPU context.
292	* The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.
293	***************************************************************************************
294	* @ new_thread : address of buffer for new thread pointer.
295	* @ type : kernel thread type.
296	* @ func : pointer on function.
297	* @ args : function arguments.
298	* @ core_lid : local core index.
299	* @ returns 0 if success / returns ENOMEM if error
300	**************************************************************************************/
301	error_t thread_kernel_create( thread_t ** new_thread,
302	thread_type_t type,
303	void * func,
304	void * args,
305	lid_t core_lid );
306
307	/***************************************************************************************
308	* This function initializes an existing kernel thread descriptor from arguments values.
309	* The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.
310	***************************************************************************************
311	* @ thread : pointer on existing thread descriptor.
312	* @ type : kernel thread type.
313	* @ func : pointer on function.
314	* @ args : function arguments.
315	* @ core_lid : local core index.
316	* @ returns 0 if success / returns EINVAL if error
317	**************************************************************************************/
318	error_t thread_kernel_init( thread_t * thread,
319	thread_type_t type,
320	void * func,
321	void * args,
322	lid_t core_lid );
323
324	/***************************************************************************************
325	* This function releases the physical memory allocated for a thread descriptor
326	* in the local cluster. It can be used for both an user and a kernel thread.
327	* The physical memory dynamically allocated in the HEAP or MMAP zones by an user
328	* thread will be released when the process is killed, and the page table flushed.
329	***************************************************************************************
330	* @ thread : pointer on the thread descriptor to release.
331	**************************************************************************************/
332	void thread_destroy( thread_t * thread );
333
334	/***************************************************************************************
335	* This function defines the code of the thread executed by all cores after kernel_init,
336	* or when no other thread is runnable for a given core.
337	*
338	* TODO: In the TSAR architecture, it enters an infinite loop, in wich it forces
339	* the core in sleep (low-power) mode. Any IRQ will force the core to exit this sleep
340	* mode, but no ISR is executed.
341	* TODO: We must analyse if we have the same behaviour for I86 architectures...
342	**************************************************************************************/
343	void thread_idle_func();
344
345	/***************************************************************************************
346	* This function registers a child thread in the global list of attached
347	* children threads of a parent thread.
348	* It does NOT take a lock, as this function is always called by the parent thread.
349	***************************************************************************************
350	* @ xp_parent : extended pointer on the parent thread descriptor.
351	* @ xp_child : extended pointer on the child thread descriptor.
352	**************************************************************************************/
353	void thread_child_parent_link( xptr_t xp_parent,
354	xptr_t xp_child );
355
356	/***************************************************************************************
357	* This function removes an user thread from the parent thread global list
358	* of attached children threads.
359	***************************************************************************************
360	* @ xp_parent : extended pointer on the parent thread descriptor.
361	* @ xp_child : extended pointer on the child thread descriptor.
362	**************************************************************************************/
363	void thread_child_parent_unlink( xptr_t xp_parent,
364	xptr_t xp_child );
365
366	/***************************************************************************************
367	* This function atomically sets a signal in a thread descriptor.
368	***************************************************************************************
369	* @ thread : local pointer on target thread.
370	*s released all locks @ mask : mask on selected signal.
371	**************************************************************************************/
372	inline void thread_set_signal( thread_t * thread,
373	uint32_t mask );
374
375	/***************************************************************************************
376	* This function resets a signal in a thread descriptor.
377	***************************************************************************************
378	* @ thread : local pointer on target thread.
379	* @ mask : mask on selected signal.
380	**************************************************************************************/
381	inline void thread_reset_signal( thread_t * thread,
382	uint32_t mask );
383
384	/***************************************************************************************
385	* This function returns true if the calling thread is attached to its parent thread.
386	**************************************************************************************/
387	inline bool_t thread_is_joinable();
388
389	/***************************************************************************************
390	* This function returns true if the calling thread is not blocked.
391	**************************************************************************************/
392	inline bool_t thread_is_runnable();
393
394	/***************************************************************************************
395	* This function checks if the calling thread can deschedule.
396	***************************************************************************************
397	* @ returns true if no locks taken.
398	**************************************************************************************/
399	inline bool_t thread_can_yield();
400
401	/***************************************************************************************
402	* This function implements the delayed descheduling machanism : It is called by
403	* all lock release functions, and calls the sched_yield() function when all locks
404	* have beeen released and the THREAD_FLAG_SCHED flag is set.
405	**************************************************************************************/
406	void thread_check_sched();
407
408	/***************************************************************************************
409	* This function can be used by the calling thread to suicide.
410	* All locks must be previously released.
411	* The scenario depends on the attached/detached flag :
412	* - if detached, it sets the SIG_KILL signal in the "signals" bit_vector, registers
413	* the BLOCKED_EXIT bit in the "blocked" bit_vector, and deschedule.
414	* - if attached, it simply sets the BLOCKED_EXIT bit in the "blocked" bit vector
415	* and deschedule. The SIG_KILL signal will be set by the parent thread when
416	* executing the pthread_join().
417	***************************************************************************************
418	* @ returns 0 if success / returns EINVAL if locks_count is not zero.
419	**************************************************************************************/
420	error_t thread_exit();
421
422	/***************************************************************************************
423	* This function registers a blocking cause in the target thread "blocked" bit vector.
424	* Warning : this function does not deschedule the calling thread.
425	* The descheduling can be forced by a sched_yield().
426	***************************************************************************************
427	* @ thread : local pointer on target thread.
428	* @ cause : mask defining the cause (one hot).
429	**************************************************************************************/
430	void thread_block( thread_t * thread,
431	uint32_t cause );
432
433	/***************************************************************************************
434	* This function resets the bit identified by the cause argument in the "blocked"
435	* bit vector of a remote thread descriptor.
436	* We need an extended pointer, because the client thread of an I/O operation on a
437	* given device is not in the same cluster as the associated device descriptor.
438	* Warning : this function does not reschedule the remote thread.
439	* The scheduling can be forced by sending an IPI to the core running the remote thread.
440	***************************************************************************************
441	* @ thread : extended pointer on the remote thread.
442	* @ cause : mask defining the cause (one hot).
443	**************************************************************************************/
444	void thread_unblock( xptr_t thread,
445	uint32_t cause );
446
447	/***************************************************************************************
448	* This function kills a target thread, identified by its local pointer.
449	* It is generally called by the local process_destroy() function.
450	* - it forces the global blocked bit in target thread descriptor.
451	* - it set the SIG_KILL signal in target thread.
452	* - it send an IPI_SCHED_REQUEST to the target thread core.
453	***************************************************************************************
454	* @ thread : local pointer on the target thread.
455	* @ returns 0 if success / returns EINVAL if locks_count is not zero.
456	**************************************************************************************/
457	void thread_kill( thread_t * thread );
458
459	/***************************************************************************************
460	* This function updates the calling thread user_time counter, and resets the thread
461	* cycles counter.
462	* TODO This function is not implemented.
463	***************************************************************************************
464	* @ thread : local pointer on target thread.
465	**************************************************************************************/
466	void thread_user_time_update( thread_t * thread );
467
468	/**************************************************************************************n
469	* This function updates the calling thread kernel_time counter, and resets the thread
470	* cycles counter.
471	* TODO This function is not implemented.
472	***************************************************************************************
473	* @ thread : local pointer on target thread.
474	**************************************************************************************/
475	void thread_kernel_time_update( thread_t * thread );
476
477	/***************************************************************************************
478	* This function handles all pending signals for the thread identified by the <thread>
479	* argument. It is called each time the core exits the kernel, after handling an
480	* interrupt, exception or syscall.
481	* TODO This function is not implemented.
482	***************************************************************************************
483	* @ thread : local pointer on target thread.
484	**************************************************************************************/
485	void thread_signals_handle( thread_t * thread );
486
487	/***************************************************************************************
488	* This function returns the extended pointer on a thread descriptor identified
489	* by its thread identifier, and process identifier.
490	* It can be called by any thread running in any cluster.
491	***************************************************************************************
492	* @ pid : process identifier.
493	* @ trdid : thread identifier.
494	* @ return the extended pointer if thread found / return XPTR_NULL if not found.
495	**************************************************************************************/
496	xptr_t thread_get_xptr( pid_t pid,
497	trdid_t trdid );
498
499
500	#endif /* _THREAD_H_ */

Note: See TracBrowser for help on using the repository browser.

Download in other formats: