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

Last change on this file since 580 was 580, checked in by alain, 3 years ago

1) Register the kernel process in the cluster manager local list.
2) Introduce a new service in idbg : display the set of busylocks taken by a given thread.

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