source: trunk/kernel/kern/thread.h

Last change on this file was 669, checked in by alain, 2 weeks ago

1) Introduce up to 4 command lines arguments in the KSH "load" command.
These arguments are transfered to the user process through the
argc/argv mechanism, using the user space "args" vseg.

2) Introduce the named and anonymous "pipes", for inter-process communication
through the pipe() and mkfifo() syscalls.

3) Introduce the "chat" application to validate the two above mechanisms.

4) Improve printk() and assert() fonctions in printk.c.

File size: 27.1 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,2017,2018,2019,2020)
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_kernel_types.h>
29#include <shared_syscalls.h>
30#include <shared_almos.h>
31#include <hal_special.h>
32#include <hal_kentry.h>
33#include <xlist.h>
34#include <list.h>
35#include <hal_context.h>
36#include <remote_busylock.h>
37#include <core.h>
38#include <chdev.h>
39#include <alarm.h>
40#include <cluster.h>
41#include <process.h>
42#include <dev_ioc.h>
43#include <dev_nic.h>
44#include <dev_txt.h>
45#include <dev_mmc.h>
46#include <dev_dma.h>
47
48/***************************************************************************************
49 * These macros are used to compose or decompose the global thread identifier (TRDID)
50 * to or from cluster identifier / local thread index (CXY , LTID)
51 **************************************************************************************/
52
53#define LTID_FROM_TRDID( trdid )   (ltid_t)(trdid & 0x0000FFFF)
54#define CXY_FROM_TRDID( trdid )    (cxy_t)(trdid >> 16)
55#define TRDID( cxy , ltid )        (trdid_t)((cxy << 16) | ltid )
56
57/***************************************************************************************
58 * This enum defines the thread types.
59 **************************************************************************************/
60
61typedef enum
62{
63        THREAD_USER    = 0,          /*! user thread (pthread)                            */
64        THREAD_RPC     = 1,          /*! kernel thread executing pending RPCs             */
65        THREAD_DEV     = 2,          /*! kernel thread executing I/O device commands      */
66        THREAD_IDLE    = 3,          /*! kernel idle thread                               */
67}
68thread_type_t;
69
70/***************************************************************************************
71 * This defines the thread flags bit-vector.
72 **************************************************************************************/
73
74#define THREAD_FLAG_DETACHED     0x0001  /*! This thread is detached from parent      */
75#define THREAD_FLAG_JOIN_DONE    0x0002  /*! Parent thread made a join request        */
76#define THREAD_FLAG_KILL_DONE    0x0004  /*! This thread received a kill request      */
77#define THREAD_FLAG_REQ_ACK      0x0010  /*! Acknowledge required from scheduler      */
78#define THREAD_FLAG_REQ_DELETE   0x0020  /*! Destruction required from scheduler      */
79
80/***************************************************************************************
81 * This defines the thread blocking causes bit-vector.
82 **************************************************************************************/
83
84#define THREAD_BLOCKED_GLOBAL    0x0001  /*! ANY : deactivated / wait activation      */
85#define THREAD_BLOCKED_IO        0x0002  /*! USR : wait IO operation completion       */
86#define THREAD_BLOCKED_MAPPER    0x0004  /*! ??? : wait mapper                        */
87#define THREAD_BLOCKED_EXIT      0x0008  /*! USR : blocked in join / wait exit        */
88#define THREAD_BLOCKED_JOIN      0x0010  /*! USR : blocked in exit / wait join        */
89#define THREAD_BLOCKED_SEM       0x0020  /*! USR : wait semaphore                     */
90#define THREAD_BLOCKED_PAGE      0x0040  /*! ??? : wait page access                   */
91#define THREAD_BLOCKED_IDLE      0x0080  /*! RPC : wait RPC_FIFO non empty            */
92#define THREAD_BLOCKED_USERSYNC  0x0100  /*! USR : wait cond / mutex / barrier        */
93#define THREAD_BLOCKED_RPC       0x0200  /*! ANY : wait RPC completion                */
94#define THREAD_BLOCKED_ISR       0x0400  /*! DEV : wait hardware IRQ                  */
95#define THREAD_BLOCKED_WAIT      0x0800  /*! USR : wait child process termination     */
96#define THREAD_BLOCKED_LOCK      0x1000  /*! ANY : wait queuelock or rwlock           */
97#define THREAD_BLOCKED_CLIENT    0x2000  /*! DEV : wait clients queue non empty       */
98#define THREAD_BLOCKED_ALARM     0x4000  /*! ANY : wait a timer based alarm           */
99
100/***************************************************************************************
101 * This structure defines a thread descriptor.
102 * It is used for both the user threads and the kernel threads.
103 * In a process, a user thread is identified by a unique TRDID (thread identifier):
104 * - The TRDID 16 LSB bits contain the LTID (Local Thread Index).
105 * - The TRDID 16 MSB bits contain the CXY of cluster containing the thread.
106 * For the main thread the LTID value is always 0, in the owner cluster.
107 * The LTID is used to index the th_tbl[] array in the local process descriptor.
108 * This TRDID is computed by the process_register_thread() function, when the user
109 * thread is registered in the local copy of the process descriptor.
110 *
111 * Implementation notes:
112 *
113 * (1) Don't modify the first 4 fields order, as this order is used by the
114 *     hal_kentry assembly code for the TSAR architectures.
115 *
116 * (2) Most of the thread state is private and accessed only by this thread,
117 *     but some fields are shared, and can be modified by other threads.
118 *     - the "blocked" bit_vector can be modified by another thread
119 *       running in another cluster (using atomic instructions),
120 *       to change this thread scheduling status.
121 *     - the "flags" bit_vector can be modified by another thread
122 *       running in another cluster (using atomic instructions),
123 *       to register requests such as ACK or DELETE.
124 *     - the "join_xp" field can be modified by the joining thread,
125 *       and this rendez-vous is protected by the dedicated "join_lock".
126 *
127 * (3) When this thread is blocked on a shared resource (queuelock, condvar,
128 *     or chdev), it registers in the associated waiting queue, using the
129 *     "wait_list" (local list) or "wait_xlist" (trans-cluster list) fields.
130 *
131 * (4) The thread_info_t structure is defined in the shared_almos.h file in the
132 *     /kernel/syscall/shared_include directory.
133 **************************************************************************************/
134
135#define THREAD_SIGNATURE    0xDEADBEEF
136
137typedef struct thread_s
138{
139        void              * cpu_context;     /*! CPU context used by sched_yield          */
140        void              * fpu_context;     /*! FPU context used by sched_yield          */
141    void              * uzone_current;   /*! used by hal_do_syscall & hal_do_except   */
142    void              * uzone_previous;  /*! used by hal_do_syscall & hal_do_except   */
143
144        intptr_t            k_stack_base;    /*! kernel stack base address                */
145        uint32_t            k_stack_size;    /*! kernel stack size (bytes)                */
146
147        uint32_t            trdid;           /*! thread index (cxy.ltid)                  */
148        thread_type_t       type;            /*! thread type                              */
149        uint32_t            quantum;         /*! number of clock ticks given to thread    */
150        uint32_t            ticks_nr;        /*! number of ticks used                     */
151        uint32_t            time_last_check; /*! last cpu_time_stamp                      */
152        core_t            * core;            /*! pointer to the owner core                */
153        process_t         * process;         /*! pointer on local process descriptor      */
154    xptr_t              parent;          /*! extended pointer on parent thread        */
155
156    remote_busylock_t   join_lock;       /*! lock protecting the join/exit            */
157    xptr_t              join_xp;         /*! joining/killer thread extended pointer   */
158    void              * exit_status;     /*! status returned to joiniy thread        */
159
160    uint32_t          * ack_rsp_count;   /*! pointer on acknowledge response counter  */
161
162        vseg_t            * user_stack_vseg; /*! local pointer on user stack vseg         */
163
164    void              * entry_func;      /*! pointer on thread entry function         */
165    void              * entry_args;      /*! pthread     : pointer on arguments       */
166
167    uint32_t            flags;           /*! bit vector of flags                      */
168    uint32_t            blocked;         /*! bit vector of blocking causes            */
169
170        error_t             errno;           /*! errno value set by last system call      */
171    uint32_t            utls;            /*! user thread local storage                */
172
173    bool_t              fork_user;       /*! user defined placement for next fork()   */
174    cxy_t               fork_cxy;        /*! target cluster  for next fork()          */
175
176        list_entry_t        sched_list;      /*! member of threads attached to same core  */
177
178    chdev_t           * chdev;           /*! chdev pointer (for a DEV thread only)    */
179
180    alarm_t             alarm;           /*! embedded timer based alarm               */
181
182    reg_t               save_sr;         /*! used by sched_yield() function           */
183
184    ioc_command_t       ioc_cmd;         /*! IOC device generic command               */
185    txt_command_t       txt_cmd;         /*! TXT device generic command               */
186    nic_command_t       nic_cmd;         /*! NIC device generic command               */
187    mmc_command_t       mmc_cmd;         /*! MMC device generic command               */
188    dma_command_t       dma_cmd;         /*! DMA device generic command               */
189    fbf_command_t       fbf_cmd;         /*! FBF device generic command               */
190
191        xptr_t              rpc_client_xp;   /*! client thread (for a RPC thread only)    */
192
193    list_entry_t        wait_list;       /*! member of a local waiting queue          */
194    xlist_entry_t       wait_xlist;      /*! member of a trans-cluster waiting queue  */
195    xlist_entry_t       tmp_xlist;       /*! member of a trans-cluster kleenex queue  */
196
197        uint32_t            busylocks;       /*! number of taken busylocks                */
198
199#if DEBUG_BUSYLOCK_TYPE
200    xlist_entry_t       busylocks_root;  /*! root of xlist of taken busylocks         */
201#endif
202
203        thread_info_t       info;            /*! embedded thread_info_t                   */
204
205        uint32_t            signature;       /*! for kernel stack overflow detection      */
206}
207thread_t;
208
209/***************************************************************************************
210 * This macro returns a pointer on the calling thread from the core hardware register.
211 **************************************************************************************/
212
213#define CURRENT_THREAD  (hal_get_current_thread())
214
215/***************************************************************************************
216 * This function returns a printable string for a thread type.
217 ***************************************************************************************
218 * @ type    : thread type.
219 * returns pointer on string.
220 **************************************************************************************/
221const char * thread_type_str( thread_type_t type );
222
223/***************************************************************************************
224 * This function is used by the pthread_create() system call to create a "new" thread
225 * in an existing process. It allocates memory for an user thread descriptor in the
226 * local cluster, and initializes it from information contained in the arguments.
227 * The CPU context is initialized from scratch.
228 * It is registered in the local process descriptor specified by the <pid> argument.
229 * The THREAD_BLOCKED_GLOBAL bit is set => the thread must be activated by the caller
230 * to start at the next scheduling point.
231 ***************************************************************************************
232 * @ pid          : process identifier.
233 * @ start_func   : pointer on entry function.
234 * @ start_args   : pointer on function argument (can be NULL).
235 * @ attr         : pointer on pthread attributes descriptor.
236 * @ new_thread   : [out] address of buffer for new thread descriptor pointer.
237 * @ returns 0 if success / returns ENOMEM if error.
238 **************************************************************************************/
239error_t thread_user_create( pid_t             pid,
240                            void            * start_func,
241                            void            * start_arg,
242                            pthread_attr_t  * attr,
243                            thread_t       ** new_thread );
244
245/***************************************************************************************
246 * This function is used by the sys_fork() syscall to create the "child" main thread
247 * in the local cluster. It is called, generally through the RPC_PROCESS_MAKE_FORK,
248 * by the process_make_fork() function. It allocates memory from the local cluster
249 * for a "child" thread descriptor, and initializes it from the "parent" thread
250 * descriptor defined by the <parent_thread_xp> argument.
251 * The new thread is attached to the core that has the lowest load in local cluster.
252 * It is registered in the "child" process defined by the <child_process> argument.
253 * This new thread inherits its user stack from the parent thread, as it uses the
254 * Copy-On-Write mechanism to get a private stack when required.
255 * The content of the parent kernel stack is copied into the child kernel stack, as
256 * the Copy-On-Write mechanism cannot be used for kernel segments (because kernel
257 * uses physical addressing on some architectures).
258 * The CPU and FPU execution contexts are created and linked to the new thread.
259 * but the actual context copy is NOT done, and is done by the sys_fork() function.
260 * The THREAD_BLOCKED_GLOBAL bit is set => the thread must be activated to start.
261 ***************************************************************************************
262 * @ parent_thread_xp  : extended pointer on parent thread descriptor.
263 * @ child_process     : local pointer on child process descriptor.
264 * @ child_thread      : [out] address of buffer for child thread descriptor pointer.
265 * @ returns 0 if success / returns -1 if error.
266 **************************************************************************************/
267error_t thread_user_fork( xptr_t      parent_thread_xp,
268                          process_t * child_process,
269                          thread_t ** child_thread );
270
271/***************************************************************************************
272 * This function is called by the process_make_exec() function to re-initialise the
273 * calling thread descriptor, that will become the new process main thread, from
274 * the process descriptor, and from the <args_nr> & <args_base> arguments.
275 * - The calling thread TRDID is not modified.
276 * - The kernel stack (currently in use) is not modified. 
277 * - It calls the hal_cpu_context_init() to re-initialize the thread CPU context.
278 * - It calls the hal_do_cpu_restore() to force execution of the new user code.
279 ***************************************************************************************
280 * @ argc   : actual number of main thread arguments.
281 * @ argv   : user space pointer on array of pointers on arguments.
282 **************************************************************************************/
283void thread_user_exec( uint32_t  argc,
284                       intptr_t  argv );
285
286/***************************************************************************************
287 * This function allocates memory for a kernel thread descriptor in the local cluster,
288 * and initializes it from arguments values.
289 * It is called by kernel_init() to statically create all DEV server threads
290 * It is also called to dynamically create RPC threads when required.
291 * The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.
292 ***************************************************************************************
293 * @ new_thread   : address of buffer for new thread pointer.
294 * @ type         : kernel thread type.
295 * @ func         : pointer on function.
296 * @ args         : function arguments.
297 * @ core_lid     : local core index.
298 * @ returns 0 if success / returns ENOMEM if error
299 **************************************************************************************/
300error_t thread_kernel_create( thread_t     ** new_thread,
301                              thread_type_t   type,
302                              void          * func,
303                              void          * args,
304                              lid_t           core_lid );
305
306/***************************************************************************************
307 * This function is called by the kernel_init() function to initialize the IDLE thread
308 * descriptor from arguments values.
309 * The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.
310 * It returns a kernel panic if failure.
311 ***************************************************************************************
312 * @ thread   : pointer on existing thread descriptor.
313 * @ type     : kernel thread type.
314 * @ func     : pointer on function.
315 * @ args     : function arguments.
316 * @ core_lid : local core index.
317 **************************************************************************************/
318void thread_idle_init( thread_t      * thread,
319                       thread_type_t   type,
320                       void          * func,
321                       void          * args,
322                       lid_t           core_lid );
323
324/***************************************************************************************
325 * This low-level function is called by the sched_handle_signals() function when a
326 * thread is marked for delete. It removes the thread identified by the <thread>
327 * argument from the process th_tbl[], and releases all physical memory allocated for
328 * this. This includes the thread descriptor itself, the associated CPU and FPU context,
329 * and the physical memory allocated for an user thread stack.
330 * This function does not remove the thread from the scheduler, as this is done by
331 * the scheduler itself.
332 ***************************************************************************************
333 * @ thread  : pointer on the thread descriptor to release.
334 * @ return the number of threads registered in the process th_tbl[] before deletion.
335 **************************************************************************************/
336uint32_t thread_destroy( thread_t * thread );
337
338/***************************************************************************************
339 * This function defines the code of the thread executed by all cores after kernel_init,
340 * or when no other thread is runnable for a given core.
341 * It enter and infinite loop in wich:
342 * - it unmask the IRQs
343 * - it optionally calls the hal_core_sleep() function to reduce the power consumption
344 *   (this behavior is controlled by the CONFIG_THREAD_IDLE_MODE_SLEEP flag).
345 * - it call the sched_yield() function to find another runnable thread.
346 *
347 * TODO: In the TSAR architecture the hal_core_sleep() function forces the core to
348 * low-power mode. Any IRQ will force the core to exit this low-power mode, but no ISR
349 * is executed. We must analyse if we have the same behaviour for I86 architectures...
350 **************************************************************************************/
351void thread_idle_func( void );
352
353/***************************************************************************************
354 * This function is used by a "blocker" thread running in the same cluster as a "target"
355 * thread to request the scheduler of the target thread to acknowledge that the target
356 * thread is blocked and not running, at the next context switch.
357 * This function executes atomically the following actions :
358 * - it set the request_pending boolean in the target scheduler descriptor.
359 * - it set the REQ_ACK flag in the "flags" field of the target thread descriptor.
360 * - It registers the responses counter pointer in the target thread descriptor.
361 * The request_pending flag is handled as a set/reset flip-flop by the "blocker" thread
362 * and by the "target" scheduler.
363 ***************************************************************************************
364 * @ target        : local pointer on target thread.
365 * @ ack_rsp_count : local pointer on responses counter.
366 **************************************************************************************/
367void thread_set_req_ack( thread_t * target,
368                         uint32_t * ack_rsp_count );
369
370/***************************************************************************************
371 * This function is used by the sched_handle_signal() function executed by the
372 * scheduler of a "target" thread to reset a "blocked not running" acknowledge request
373 * in both the target thread descriptor, and in the target  thread scheduler.
374 ***************************************************************************************
375 * @ target    : local pointer on target thread.
376 **************************************************************************************/
377void thread_reset_req_ack( thread_t * target );
378
379/***************************************************************************************
380 * This function is used by the four sys_thread_cancel(), sys_thread_exit(),
381 * sys_kill() and sys_exit() system calls to mark for delete a given thread.
382 * It set the THREAD_BLOCKED_GLOBAL bit and set the THREAD_FLAG_REQ_DELETE bit in the
383 * thread descriptor identified by the <thread_xp> argument, to ask the scheduler
384 * to asynchronously delete the target thread, at the next scheduling point.
385 * The calling thread can run in any cluster, as it uses remote accesses.
386 * This function makes a kernel panic if the target thread is the main thread,
387 * because the main thread deletion will cause the process deletion, and a process
388 * must be deleted by the parent process, running the wait function.
389 * If the target thread is running in "attached" mode, and the <is_forced> argument
390 * is false, this function implements the required sychronisation with the joining
391 * thread, blocking the killer thread until the pthread_join() syscall is executed
392 * by the joining thread.
393 ***************************************************************************************
394 * @ thread_xp   : extended pointer on the target thread.
395 * @ is_forced   : the deletion does not depends on the attached mode.
396 **************************************************************************************/
397void thread_delete_request( xptr_t  thread_xp,
398                            bool_t  is_forced );
399
400/***************************************************************************************
401 * This function registers a blocking cause defined by the <cause> argument
402 * in a remote thread descriptor identified by the <thread_xp> argument.
403 * We need an extended pointer, because this function can be called by another thread
404 * than the target thread, executing the sys_kill() function.
405 * WARNING : this function does not deschedule the target thread, and the descheduling
406 * must be explicitely forced by a sched_yield().
407 ***************************************************************************************
408 * @ thread_xp   : extended pointer on remote thread descriptor.
409 * @ cause       : mask defining the cause (one hot).
410 **************************************************************************************/
411void thread_block( xptr_t   thread_xp,
412                   uint32_t cause );
413
414/***************************************************************************************
415 * This function resets the bit identified by the <cause> argument in a remote
416 * thread descriptor identified by the <thread_xp> argument.
417 * We need an extended pointer, because the client thread of an I/O operation on a
418 * given device is generally not in the same cluster as the associated server thread.
419 * WARNING : this function does not reschedule the remote thread.
420 * The scheduling can be forced by sending an IPI to the core running the remote thread.
421 ***************************************************************************************
422 * @ thread_xp   : extended pointer the remote thread.
423 * @ cause       : mask defining the cause (one hot).
424 * @ return non zero if the bit-vector was actually modified / return 0 otherwise
425 **************************************************************************************/
426uint32_t thread_unblock( xptr_t   thread_xp,
427                         uint32_t cause );
428
429/***************************************************************************************
430 * This function updates the calling thread user_time or kernel_time counters.
431 ***************************************************************************************
432 * @ thread   : local pointer on target thread.
433 * @ is_user  : update user time if true / update kernel time if false
434 **************************************************************************************/
435void thread_time_update( thread_t * thread,
436                         bool_t     is_user );
437
438/***************************************************************************************
439 * This function returns the extended pointer on a thread descriptor identified
440 * by its thread identifier, and process identifier.
441 * It can be called by any thread running in any cluster.
442 ***************************************************************************************
443 * @ pid     : process identifier.
444 * @ trdid   : thread identifier.
445 * @ return the extended pointer if thread found / return XPTR_NULL if not found.
446 **************************************************************************************/
447xptr_t thread_get_xptr( pid_t    pid,
448                        trdid_t  trdid );
449
450/***************************************************************************************
451 * This function checks that the thread identified by the <thread> argument does hold
452 * any busylock (local or remote).
453 * If the xlist of taken busylocks is not empty, it displays the set of taken locks,
454 * and makes a kernel panic. 
455 ***************************************************************************************
456 * @ thread    : local pointer on target thread.
457 * @ func_str  : faulty function name.
458 **************************************************************************************/
459void thread_assert_can_yield( thread_t    * thread,
460                              const char  * func_str );
461
462/***************************************************************************************
463 * This debug function display the list of busylocks (local or remote)
464 * currently owned by a the thread identified by the <thead_xp> argument.
465 * The <string> argument is printed in header (can be the calling function name).
466 * WARNING : the DEBUG_BUSYLOCK parameter must be set in the kernel_config.h file.
467 ***************************************************************************************
468 * @ thread_xp  : extended pointer on target thread.
469 * @ string     : defines the calling context.
470 **************************************************************************************/
471void thread_display_busylocks( xptr_t       thread_xp,
472                               const char * string );
473
474
475
476#endif  /* _THREAD_H_ */
Note: See TracBrowser for help on using the repository browser.