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

Last change on this file since 23 was 23, checked in by alain, 5 years ago

Introduce syscalls.

File size: 27.9 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 an 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 
63typedef 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} 
69pthread_attr_t;
70
71typedef 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}
77pt_attributes_t;
78
79/***************************************************************************************
80 * This enum defines the thread types.
81 **************************************************************************************/
82
83typedef 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} 
92thread_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
103/***************************************************************************************
104 * This defines the masks associated to the thread signals.
105 **************************************************************************************/
106
107#define THREAD_SIG_KILL          0x0001  /*! This thread must be destroyed ASAP       */
108
109/***************************************************************************************
110 * This defines the masks associated to the blocking causes.
111 **************************************************************************************/
112
113#define THREAD_BLOCKED_GLOBAL    0x0001  /*! thread desactivated / wait activation    */ 
114#define THREAD_BLOCKED_IO        0x0002  /*! thread wait IO operation completion      */
115#define THREAD_BLOCKED_MAPPER    0x0004  /*! thread wait mapper                       */
116#define THREAD_BLOCKED_JOIN      0x0008  /*! thread blocked in join / wait exit       */
117#define THREAD_BLOCKED_EXIT      0x0010  /*! thread blocked in exit / wait join i     */
118#define THREAD_BLOCKED_KILL      0x0020  /*! thread received kill signal              */
119#define THREAD_BLOCKED_SEM       0x0040  /*! thread wait semaphore                    */
120#define THREAD_BLOCKED_PAGE      0x0080  /*! thread wait page access                  */
121#define THREAD_BLOCKED_USERSYNC  0x0100  /*! thread wait POSIX (cond/mutex/barrier)   */
122
123#define THREAD_BLOCKED_IDLE      0x1000  /*! thread RPC wait activation               */
124#define THREAD_BLOCKED_DEV_QUEUE 0x2000  /*! thread DEV wait queue                    */
125#define THREAD_BLOCKED_DEV_ISR   0x4000  /*! thread DEV wait ISR                      */
126
127/***************************************************************************************
128 * This structure defines thread instrumentation informations.
129 **************************************************************************************/
130
131typedef struct thread_info_s
132{
133        uint32_t              pgfault_nr;    /*! cumulated number of page fault           */
134        uint32_t              sched_nr;      /*! TODO ???  [AG]                           */
135        uint32_t              u_err_nr;      /*! TODO ???  [AG]                           */
136        uint32_t              m_err_nr;      /*! TODO ???  [AG]                           */
137        uint32_t              tm_tmp;        /*! temp date to compute execution duration  */
138        uint32_t              tm_exec;       /*! TODO ???  [AG]                           */
139        uint32_t              tm_create;     /*! date of the creation                     */
140        uint32_t              tm_born;       /*! date of the thread loading               */
141        uint32_t              tm_dead;       /*! date of the death                        */
142        cycle_t               tm_sleep;      /*! TODO ???  [AG]                           */
143        cycle_t               tm_wait;       /*! TODO ???  [AG]                           */
144        cycle_t               tm_usr;        /*! user execution duration                  */
145        cycle_t               tm_sys;        /*! system execution duration                */
146}
147thread_info_t;
148
149/***************************************************************************************
150 * This structure defines a thread descriptor.
151 * It is used for both the user threads and the kernel threads.
152 * In a process, an user thread is identified by a unique TRDID (thread identifier),
153 * that is returned by the kernel to the user:
154 * - The TRDID 16 LSB bits contain the LTID (Local Thread Index).
155 * - The TRDID 16 MSB bits contain the CXY of cluster containing the thread.
156 * - The LTID is used to index the th_tbl[] array in the local process descriptor.
157 * This TRDID is computed by the process_register_thread() function, when the user
158 * thread is registerd in the local copy of the process descriptor.
159 **************************************************************************************/
160
161#define THREAD_SIGNATURE    0xDEADBEEF
162
163typedef struct thread_s
164{
165    void              * cpu_uzone;       /*! used for exception/interrupt/syscall     */
166        void              * cpu_context;     /*! used for context switch                  */
167        void              * fpu_context;     /*! used for dynamic FPU allocation          */
168
169        uint32_t            trdid;           /*! thread index (cxy.ltid)                  */
170        thread_type_t       type;            /*! thread type                              */
171        uint32_t            quantum;         /*! number of clock ticks given to thread    */
172        uint32_t            ticks_nr;        /*! number of ticks used                     */
173        uint32_t            time_last_check; /*! last cpu_time_stamp                      */
174        core_t            * core;            /*! pointer to the owner core                */
175        process_t         * process;         /*! pointer on local process descriptor      */
176    xptr_t              parent;          /*! extended pointer on parent thread        */       
177
178    void              * exit_value;      /*! exit_value used in case of join          */
179   
180        uint32_t            local_locks;         /*! number of local locks owned by thread    */
181    list_entry_t        locks_root;      /*! root of local locks list                 */
182
183    remote_spinlock_t * flags_lock;      /*! lock protecting the flags                */
184
185        uint32_t            remote_locks;        /*! number of local locks owned by thread    */
186    xlist_entry_t       xlocks_root;     /*! root of remote locks list                */
187
188        intptr_t            u_stack_base;    /*! user stack base address                  */
189        uint32_t            u_stack_size;    /*! user stack size (bytes)                  */
190        intptr_t            k_stack_base;    /*! kernel stack base address                */
191        uint32_t            k_stack_size;    /*! kernel stack size (bytes)                */
192
193    void              * entry_func;      /*! pointer on entry function                */
194    void              * entry_args;      /*! pointer on entry function arguments      */
195
196    uint32_t            flags;           /*! bit vector of flags                      */
197    uint32_t            blocked;         /*! bit vector of blocking causes            */
198    uint32_t            signals;         /*! bit vector of signals                    */
199
200        error_t             errno;           /*! errno value set by last system call      */
201    uint32_t            utls;            /*! user thread local storage                */
202
203    bool_t              fork_user;       /*! user defined placement for next fork()   */
204    cxy_t               fork_cxy;        /*! target cluster  for next fork()          */
205
206        xlist_entry_t       children_root;   /*! root of list of attached children        */
207    uint32_t            children_nr;     /*! number of attached children threads      */
208    remote_spinlock_t * children_lock;   /*! lock protecting the children list        */
209
210    xlist_entry_t       brothers_list;   /*! member of threads with same parent       */
211
212        list_entry_t        sched_list;      /*! member of threads attached to same core  */
213
214    uint32_t            dev_channel;     /*! device channel for a DEV thread          */
215    union                                /*! embedded command for a DEV thread        */
216    {
217        ioc_command_t   ioc;             /*! IOC device generic command               */
218        txt_command_t   txt;             /*! TXT device generic command               */
219        nic_command_t   nic;             /*! NIC device generic command               */
220        mmc_command_t   mmc;             /*! MMC device generic command               */
221        dma_command_t   dma;             /*! DMA device generic command               */
222    } 
223    command;
224   
225        cxy_t               rpc_client_cxy;  /*! client cluster index (for a RPC thread)  */
226
227    xlist_entry_t       wait_list;       /*! member of threads blocked on same cond   */
228
229        thread_info_t       info;            /*! embedded thread_info_t                   */
230
231        uint32_t            signature;       /*! for kernel stack overflow detection      */
232} 
233thread_t;
234
235/***************************************************************************************
236 * This macro returns a pointer on the calling thread from the core hardware register.
237 **************************************************************************************/
238
239#define CURRENT_THREAD  (hal_get_current_thread())
240
241/***************************************************************************************
242 * This function returns a printable string for a thread type.
243 ***************************************************************************************
244 * @ type    : thread type.
245 * returns pointer on string.
246 **************************************************************************************/
247char * thread_type_str( uint32_t type );
248
249/***************************************************************************************
250 * This function allocates memory for an user thread descriptor in the local cluster,
251 * and initializes it from information contained in the arguments.
252 * It is used by the "pthread_create" system call.
253 * The CPU context is initialised from scratch, and the "loadable" field is set.
254 * The new thread is attached to the core specified in the <attr> argument.
255 * It is registered in the local process descriptor specified by the <pid> argument.
256 * The thread descriptor pointer is returned to allow the parent thread to register it
257 * in its children list.
258 * The THREAD_BLOCKED_GLOBAL bit is set => the thread must be activated to start.   
259 ***************************************************************************************
260 * @ pid          : process identifier.
261 * @ start_func   : pointer on entry function.
262 * @ start_args   : pointer on function argument (can be NULL).
263 * @ attr         : pointer on pthread attributes descriptor.
264 * @ new_thread   : [out] address of buffer for new thread descriptor pointer. 
265 * @ returns 0 if success / returns ENOMEM if error.
266 **************************************************************************************/
267error_t thread_user_create( pid_t             pid,
268                            void            * start_func,
269                            void            * start_arg,
270                            pthread_attr_t  * attr,
271                            thread_t       ** new_thread );
272
273/***************************************************************************************
274 * This function allocates memory for an user thread descriptor in the local cluster,
275 * and initialises it from informations contained in the calling thread descriptor.
276 * It is used by the fork() system call to create the child process main thread.
277 * The new thread is attached to the core with the lowest load.
278 * It is registered in the process descriptor defined by the "process" argument.
279 * This new thread inherits its execution context from the calling thread,
280 * and the "loadable" field is NOT set.
281 * The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.   
282 ***************************************************************************************
283 * @ process      : local pointer on owner process descriptor.
284 * @ new_thread   : [out] address of buffer for new thread descriptor pointer. 
285 * @ returns 0 if success / returns ENOMEM if error.
286 **************************************************************************************/
287error_t thread_user_fork( process_t * process,
288                          thread_t ** new_thread );
289
290/***************************************************************************************
291 * This function allocates memory for a kernel thread descriptor in the local cluster,
292 * and initialise it from arguments values, calling the thread_kernel_init() function,
293 * that also allocates and initializes the CPU context.
294 * The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.   
295 ***************************************************************************************
296 * @ new_thread   : address of buffer for new thread pointer.
297 * @ type         : kernel thread type.
298 * @ func         : pointer on function.
299 * @ args         : function arguments.
300 * @ core_lid     : local core index.
301 * @ returns 0 if success / returns ENOMEM if error
302 **************************************************************************************/
303error_t thread_kernel_create( thread_t     ** new_thread,
304                              thread_type_t   type,
305                              void          * func, 
306                              void          * args,
307                              lid_t           core_lid );
308
309/***************************************************************************************
310 * This function initialises an existing kernel thread descriptor from arguments values.
311 * The THREAD_BLOCKED_GLOBAL bit is set, and the thread must be activated to start.   
312 ***************************************************************************************
313 * @ thread   : pointer on existing thread descriptor.
314 * @ type     : kernel thread type.
315 * @ func     : pointer on function.
316 * @ args     : function arguments.
317 * @ core_lid : local core index.
318 * @ returns 0 if success / returns EINVAL if error
319 **************************************************************************************/
320error_t thread_kernel_init( thread_t      * thread,
321                            thread_type_t   type,
322                            void          * func, 
323                            void          * args,
324                            lid_t           core_lid );
325
326/***************************************************************************************
327 * This function releases the physical memory allocated for a thread descriptor
328 * in the local cluster. It can be used for both an user and a kernel thread.
329 * The physical memory dynamically allocated in the HEAP or MMAP zones by an user
330 * thread will be released when the process is killed, and the page table flushed.
331 ***************************************************************************************
332 * @ thread  : pointer on the thread descriptor to release. 
333 **************************************************************************************/
334void thread_destroy( thread_t * thread );
335
336/***************************************************************************************
337 * This function defines the code of the thread executed by all cores after kernel_init,
338 * or when no other thread is runnable for a given core.
339 *
340 * TODO: In the TSAR architecture, it enters an infinite loop, in wich it forces
341 * the core in sleep (low-power) mode. Any IRQ will force the core to exit this sleep
342 * mode, but no ISR is executed.
343 * TODO: We must analyse if we have the same behaviour for I86 architectures...
344 **************************************************************************************/
345void thread_idle_func();
346
347/***************************************************************************************
348 * This function registers a child thread in the global list of attached
349 * children threads of a parent thread.
350 * It does NOT take a lock, as this function is allways called by the parent thread.
351 ***************************************************************************************
352 * @ xp_parent : extended pointer on the parent thread descriptor.
353 * @ xp_child  : extended pointer on the child thread descriptor.
354 **************************************************************************************/
355void thread_child_parent_link( xptr_t  xp_parent,
356                               xptr_t  xp_child );
357
358/***************************************************************************************
359 * This function removes an user thread from the parent thread global list
360 * of attached children threads.
361 ***************************************************************************************
362 * @ xp_parent : extended pointer on the parent thread descriptor.
363 * @ xp_child  : extended pointer on the child thread descriptor.
364 **************************************************************************************/
365void thread_child_parent_unlink( xptr_t xp_parent,
366                                 xptr_t xp_child );
367
368/***************************************************************************************
369 * This function atomically set a signal in a thread descriptor.
370 ***************************************************************************************
371 * @ thread    : local pointer on target thread.
372 * @ mask      : mask on selected signal.
373 **************************************************************************************/
374inline void thread_set_signal( thread_t * thread,
375                               uint32_t   mask );
376
377/***************************************************************************************
378 * This function reset a signal in a thread descriptor.
379 ***************************************************************************************
380 * @ thread    : local pointer on target thread.
381 * @ mask      : mask on selected signal.
382 **************************************************************************************/
383inline void thread_reset_signal( thread_t * thread,
384                                 uint32_t   mask );
385
386/***************************************************************************************
387 * This function returns true if the calling thread is attached to its parent thread.
388 **************************************************************************************/
389inline bool_t thread_is_joinable();
390
391/***************************************************************************************
392 * This function returns true if the calling thread is not blocked.
393 **************************************************************************************/
394inline bool_t thread_is_runnable();
395
396/***************************************************************************************
397 * This function cheks if the calling thread can deschedule.
398 ***************************************************************************************
399 * @ returns true if no locks taken.
400 **************************************************************************************/
401inline bool_t thread_can_yield();
402
403/***************************************************************************************
404 * This function checks if the calling thread must be descheduled.
405 ***************************************************************************************
406 * @ returns true if no locks taken, and elapsed time.
407 **************************************************************************************/
408bool_t thread_check_sched();
409
410/***************************************************************************************
411 * This function can be used by the calling thread to suicide.
412 * All locks must be previouly released.
413 * The scenario depends on the attached/detached flag :
414 * - if detached, it set the SIG_KILL signal in the "signals" bit_vector, registers
415 *   the BLOCKED_EXIT bit in the "blocked" bit_vector, and deschedule.
416 * - if attached, it simply set the BLOCKED_EXIT bit in the "blocked" bit vector
417 *   and deschedule. The SIG_KILL signal will be set by the parent thread when
418 *   executing the pthread_join().
419 ***************************************************************************************
420 * @ returns 0 if success / returns EINVAL if locks_count is not zero.
421 **************************************************************************************/
422error_t thread_exit();
423
424/*************************************************************************************** 
425 * This function registers a blocking cause in the target thread "blocked" bit vector.
426 * Warning : this function does not deschedule the calling thread.
427 * The descheduling can be forced by a sched_yield().
428 ***************************************************************************************
429 * @ thread   : local pointer on target thread.
430 * @ cause    : mask defining the cause (one hot).
431 **************************************************************************************/
432void thread_block( thread_t * thread,
433                   uint32_t   cause );
434
435/*************************************************************************************** 
436 * This function reset the bit identified by the cause argument in the "blocked"
437 * bit vector of a remote thread descriptor.
438 * We need an extended pointer, because the client thread of an I/O operation on a
439 * given device is not in the same cluster as the associated device descriptor.
440 * Warning : this function does not reschedule the remote thread.
441 * The scheduling can be forced by sending an IPI to the core running the remote thread.
442 ***************************************************************************************
443 * @ thread   : extended pointer on the remote thread.
444 * @ cause    : mask defining the cause (one hot).
445 **************************************************************************************/
446void thread_unblock( xptr_t   thread,
447                     uint32_t cause );
448
449/*************************************************************************************** 
450 * This function kills a target thread, identified by its local pointer.
451 * It is generally called by the local process_destroy() function.
452 * - it forces the global blocked bit in target thread descriptor.
453 * - it set the SIG_KILL signal in target thread.
454 * - it send an IPI_SCHED_REQUEST to the target thread core.
455 ***************************************************************************************
456 * @ thread   : local pointer on the target thread.
457 * @ returns 0 if success / returns EINVAL if locks_count is not zero.
458 **************************************************************************************/
459void thread_kill( thread_t * thread );
460
461/***************************************************************************************
462 * This function updates the calling thread user_time counter, and reset the thread
463 * cycles counter.
464 * TODO This function is not implemented.
465 ***************************************************************************************
466 * @ thread   : local pointer on target thread.
467 **************************************************************************************/
468void thread_user_time_update( thread_t * thread );
469
470/**************************************************************************************n
471 * This function updates the calling thread kernel_time counter, and reset the thread
472 * cycles counter.
473 * TODO This function is not implemented.
474 ***************************************************************************************
475 * @ thread   : local pointer on target thread.
476 **************************************************************************************/
477void thread_kernel_time_update( thread_t * thread );
478
479/***************************************************************************************
480 * This function handle all pending signals for the thread identified by the <thread>
481 * argument. It is called each time the core exit the kernel, after handling an
482 * interrupt, exception or syscall.
483 * TODO This function is not implemented.
484 ***************************************************************************************
485 * @ thread   : local pointer on target thread.
486 **************************************************************************************/
487void thread_signals_handle( thread_t * thread );
488
489/***************************************************************************************
490 * This function returns the extended pointer on a thread descriptor identified
491 * by its thread identifier, and process identifier.
492 * It can be called by any thread running in any cluster.
493 ***************************************************************************************
494 * @ pid     : process identifier.
495 * @ trdid   : thread identifier.
496 * @ return the extended pointer if thread found / return XPTR_NULL if not found.
497 **************************************************************************************/
498xptr_t thread_get_xptr( pid_t    pid,
499                        trdid_t  trdid );
500
501
502#endif  /* _THREAD_H_ */
Note: See TracBrowser for help on using the repository browser.