source: trunk/kernel/syscalls/syscalls.h @ 440

Last change on this file since 440 was 440, checked in by alain, 6 years ago

1/ Fix a bug in the Multithreaded "sort" applicationr:
The pthread_create() arguments must be declared as global variables.
2/ The exit syscall can be called by any thread of a process..
File size: 36.7 KB
RevLine 
[1]1/*
[407]2 * syscalls.h - Kernel side services for syscall handling.
[1]3 *
[23]4 * Author     Alain Greiner (2016,2017)
[1]5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
[16]24#ifndef _SYSCALLS_H_
25#define _SYSCALLS_H_
[1]26
[23]27#include <hal_types.h>
[407]28#include <shared_syscalls.h>
[23]29
[407]30/**   Forward declarations  *****/
[23]31
32struct thread_s;                  // defined in thread.h
33struct pthread_attr_s;            // defined in thread.h
34struct vfs_stat_s;                // defined in vfs.h
35struct vfs_dirent_s;              // defined in vfs.h
36struct mmap_attr_s;               // defined in vmm.h
37
[407]38/******************************************************************************************
39 * [0] This function terminates the execution of the calling user thread,
[23]40 * and makes the exit_value pointer available to any successful pthread_join() with the
41 * terminating thread.
[409]42 * It actually set the THREAD_SIG_EXIT signal, set the THREAD_BLOCKED_GLOBAL bit in the
43 * thread descriptor and deschedule.
44 * The thread will be detached from its process, and the memory allocated to the thread
45 * descriptor will be released later by the scheduler.
[407]46 ******************************************************************************************
[409]47 * @ exit_vallue  : pointer to be returned to joining thread if thread is attached.
48 * @ return 0 if success / return -1 if all locks not released or illegal argument.
[407]49 *****************************************************************************************/
[23]50int sys_thread_exit( void * exit_value );
[16]51
[407]52/******************************************************************************************
53 * [1] This function calls the scheduler for the core running the calling thread.
54 ******************************************************************************************
55 * @ x_size   : [out] number of clusters in a row.
56 * @ y_size   : [out] number of clusters in a column.
57 * @ ncores   : [out] number of cores per cluster.
58 * @ return always 0.
59 *****************************************************************************************/
60int sys_thread_yield();
[16]61
[407]62/******************************************************************************************
[23]63 * [2] This function creates a new user thread. The <user_attr> argument is a pointer
64 * on astructure containing the thread attributes, defined in thread.h file.
[407]65 ******************************************************************************************
[23]66 * @ new_thread  : [out] local pointer on created thread descriptor.
67 * @ user_attr   : [in]  pointer on thread attributes structure.
68 * @ start_func  : [in]  pointer on start function.
69 * @ start_args  : [in]  pointer on start function arguments.
70 * @ return 0 if success / return -1 if failure.
[407]71 *****************************************************************************************/
[23]72int sys_thread_create( struct thread_s        * new_thread,
73                       struct pthread_attr_s  * user_attr,
74                       void                   * start_func,
75                       void                   * start_args );
[16]76
[407]77/******************************************************************************************
[23]78 * [3] This blocking function suspend execution of the calling thread until completion
79 * of another target thread identified by the <trdid> argument.
[421]80 * The target thread must be joinable (running in ATTACHED mode), and must be different
81 * from the calling thread.
[23]82 * If the <exit_value> argument is not NULL, the value passed to pthread_exit() by the
83 * target thread is stored in the location referenced by exit_value.
[407]84 ******************************************************************************************
[23]85 * @ trdid     : [in]  target thread identifier.
86 * @ thread    : [out] buffer for exit_value returned by target thread.
87 * @ return 0 if success / return -1 if failure.
[407]88 *****************************************************************************************/
[23]89int sys_thread_join( trdid_t    trdid,
90                     void    ** exit_value );
[16]91
[407]92/******************************************************************************************
[23]93 * [4] This function detach a joinable thread.
[407]94 ******************************************************************************************
[409]95 * @ trdid   : thread identifier.
[23]96 * @ return 0 if success / return -1 if failure.
[407]97 *****************************************************************************************/
[23]98int sys_thread_detach( trdid_t  trdid );
[16]99
[407]100/******************************************************************************************
[409]101 * [5] This function requests a target thread identified by its <trdid> argument
[436]102 * to be cancelled. It calls the thread_kill() function to block the target thread
103 * on the THREAD_BLOCKED_GLOBAL condition, and to set the THREAD_FLAG_REQ_DELETE.
[409]104 * The thread will be detached from its process, and the memory allocated to the thread
[436]105 * descriptor will be released by the scheduler at the next scheduling point.
[409]106 ******************************************************************************************
107 * @ trdid   : thread identifier.
108 * @ return 0 if success / return -1 if illegal argument.
[407]109 *****************************************************************************************/
[409]110int sys_thread_cancel( trdid_t  trdid );
[16]111
[407]112/******************************************************************************************
[23]113 * [6] This function implement all operations on a POSIX unnamed semaphore,
114 * that can be shared by threads running in different clusters.
115 * The kernel structure representing a remote semaphore is in the remote_sem.h file,
116 * and the code implementing the operations is in the remore_sem.c file.
[407]117 ******************************************************************************************
[23]118 * @ vaddr     : semaphore virtual address in user space == identifier.
119 * @ operation : SEM_INIT / SEM_DESTROY / SEM_GETVALUE / SEM_POST / SEM_WAIT.
120 * @ value     : pointer on in/out argument in user space.
121 * @ return 0 if success / return -1 if failure.
[407]122 *****************************************************************************************/
[23]123int sys_sem( void       * vaddr,
124             uint32_t     operation,
125             uint32_t   * value );
[16]126
[407]127/******************************************************************************************
[23]128 * [7] This function implement all operations on a POSIX condition variable.
129 * The kernel structure representing a cond_var is defined in the remote_cv.h file,
130 * The code implementing the operations is defined in the remote_cv.c file.
[407]131 ******************************************************************************************
[23]132 * @ vaddr     : condvar virtual address in user space == identifier.
133 * @ operation : operation type (see below).
134 * @ attr      : mutex virtual address in user space == identifier.
135 * @ return 0 if success / return -1 if failure.
[407]136 *****************************************************************************************/
[23]137int sys_condvar( void     * condvar,
138                 uint32_t   operation,
139                 void     * mutex );
[16]140
[407]141/******************************************************************************************
[23]142 * [8] This function implement all operations on a POSIX barrier.
143 * The kernel structure representing a barrier is defined in the remote_barrier.h file.
144 * The code implementting the operations is defined in the remote_barrier.c file.
[407]145 ******************************************************************************************
[23]146 * @ vaddr     : barrier virtual address in user space == identifier.
147 * @ operation : BARRIER_INIT / BARRIER_DESTROY / BARRIER_WAIT.
148 * @ count     : number of expected threads (only used by BARRIER_INIT operation).
149 * @ return 0 if success / return -1 if failure.
[407]150 *****************************************************************************************/
[23]151int sys_barrier( void     * vaddr,
152                 uint32_t   operation,
153                 uint32_t   count );
[16]154
[407]155/******************************************************************************************
[23]156 * [9] This function implement all operations on a POSIX mutex.
157 * The kernel structure representing a barrier is defined in the remote_barrier.h file.
158 * The code implementting the operations is defined in the remote_barrier.c file.
[407]159 ******************************************************************************************
[23]160 * @ vaddr     : mutex virtual address in user space == identifier.
161 * @ operation : MUTEX_INIT / MUTEX_DESTROY / MUTEX_LOCK / MUTEX_UNLOCK
162 * @ attr      : mutex attributes (non supported yet => must be 0).
163 * @ return 0 if success / return -1 if failure.
[407]164 *****************************************************************************************/
[23]165int sys_mutex( void     * vaddr,
166               uint32_t   operation,
167               uint32_t   count );
[16]168
[407]169/******************************************************************************************
[408]170 * [10] This function implement the exit system call terminating a POSIX process.
[440]171 * It can be called by any thread running in any cluster.
172 * It uses both remote accesses to access the owner process descriptor, ans the
173 * RPC_PROCESS_SIGACTION to delete remote process and thread descriptors
[433]174 * In the present implementation, this function implements actually the _exit():
[440]175 * - it does not flush open output streams.
[433]176 * - it does not close open streams.
[407]177 ******************************************************************************************
[408]178 * @ status   : terminaison status (not used in present implementation).
[407]179 *****************************************************************************************/
[409]180int sys_exit( uint32_t status );
[16]181
[407]182/******************************************************************************************
[408]183 * [11] This function remove an existing mapping defined by the <addr> and <size>
[407]184 * arguments in user space.
185 ******************************************************************************************
186 * @ addr  : base address in user space.
187 * # size  : number of bytes.
[23]188 * @ return 0 if success / return -1 if failure.
[407]189 *****************************************************************************************/
190int sys_munmap( void     * addr,
191                uint32_t   size );
[16]192
[407]193/******************************************************************************************
194 * [12] This function open or create an open file descriptor.
195 ******************************************************************************************
[23]196 * @ pathname   : pathname (can be relative or absolute).
197 * @ flags      : bit vector attributes (see below).
198 * @ mode       : access rights.
199 * @ return file descriptor index in fd_array if success / return -1 if failure.
[407]200 *****************************************************************************************/
[23]201int sys_open( char    * pathname,
202              uint32_t  flags,
203              uint32_t  mode );
[16]204
[407]205/******************************************************************************************
206 * [13] This function map physical memory (or a file) in the calling thread virtual space.
207 * The <attr> argument is a pointer on a structure for arguments (see shared_syscalls.h).
208 ******************************************************************************************
209 * @ attr       : pointer on attributes structure.
210 * @ return 0 if success / return -1 if failure.
211 *****************************************************************************************/
212int sys_mmap( mmap_attr_t * attr );
[23]213
[407]214/******************************************************************************************
[23]215 * [14] This function read bytes from an open file identified by its file descriptor.
[407]216 * The file can be a regular file or character oriented device.
[408]217 * IRQs are enabled during this system call.
[407]218 ******************************************************************************************
[23]219 * @ file_id  : open file index in fd_array.
220 * @ buf      : buffer virtual address in user space.
221 * @ count    : number of bytes.
222 * @ return number of bytes actually read if success / returns -1 if failure.
[407]223 *****************************************************************************************/
[23]224int sys_read( uint32_t   file_id,
225              void     * buf,
226              uint32_t   count );
[16]227
[407]228/******************************************************************************************
[23]229 * [15] This function writes bytes to an open file identified by its file descriptor.
[407]230 * The file can be a regular file or character oriented device.
[408]231 * IRQs are enabled during this system call.
[407]232 ******************************************************************************************
[23]233 * @ file_id  : open file index in fd_array.
234 * @ buf      : buffer virtual address in user space.
235 * @ count    : number of bytes.
236 * @ return number of bytes actually written if success / returns -1 if failure.
[407]237 *****************************************************************************************/
[23]238int sys_write( uint32_t   file_id,
239               void     * buf,
240               uint32_t   count );
[16]241
[407]242/******************************************************************************************
243 * [16] This function repositions the offset of the file descriptor identified by <file_id>,
244 * according to the operation type defined by the <whence> argument.
245 ******************************************************************************************
[23]246 * @ file_id  : open file index in fd_array.
[407]247 * @ offset   : used to compute new offset value.
[23]248 * @ whence   : operation type (see below).
249 * @ return 0 if success / returns -1 if failure.
[407]250 *****************************************************************************************/
[23]251int sys_lseek( xptr_t    file_id,
252               uint32_t  offset,
253               uint32_t  whence );
[16]254
[407]255/******************************************************************************************
[23]256 * [17] This function release the memory allocated for the file descriptor identified by
257 * the <file_id> argument, and remove the fd array_entry in all copies of the process
258 * descriptor.
[407]259 ******************************************************************************************
[23]260  file_id   : file descriptor index in fd_array.
261 * @ return 0 if success / returns -1 if failure.
[407]262 *****************************************************************************************/
[23]263int sys_close( uint32_t file_id );
[16]264
[407]265/******************************************************************************************
266 * [18] This function removes a directory entry identified by the <pathname> from the
[23]267 * directory, and decrement the link count of the file referenced by the link.
268 * If the link count reduces to zero, and no process has the file open, then all resources
269 * associated with the file are reclaimed.  If one or more process have the file open when
270 * the last link is removed, the link is removed, but the removal of the file is delayed
271 * until all references to it have been closed.
[407]272 ******************************************************************************************
[23]273 * @ pathname   : pathname (can be relative or absolute).
274 * @ return 0 if success / returns -1 if failure.
[407]275 *****************************************************************************************/
[23]276int sys_unlink( char * pathname );
[16]277
[407]278/******************************************************************************************
[23]279 * [19] This function creates in the calling thread cluster an unnamed pipe, and two
280 * (read and write) file descriptors.
[407]281 * TODO not implemented yet...
282 ******************************************************************************************
[23]283 * @ file_id[0] : [out] read only file descriptor index.
284 * @ file_id[1] : [out] write only file descriptor index.
285 * @ return 0 if success / return -1 if failure.
[407]286 *****************************************************************************************/
[23]287int sys_pipe( uint32_t file_id[2] );
[16]288
[407]289/******************************************************************************************
[23]290 * [20] This function change the current working directory in reference process descriptor.
[407]291 ******************************************************************************************
[23]292 * @ pathname   : pathname (can be relative or absolute).
293 * @ return 0 if success / returns -1 if failure.
[407]294 *****************************************************************************************/
[23]295int sys_chdir( char * pathname );
[16]296
[407]297/******************************************************************************************
[23]298 * [21] This function creates a new directory in file system.
[407]299 ******************************************************************************************
[23]300 * @ pathname   : pathname (can be relative or absolute).
301 * @ mode       : access rights (as defined in chmod).
302 * @ return 0 if success / returns -1 if failure.
[407]303 *****************************************************************************************/
[279]304int sys_mkdir( char    * pathname,
[23]305               uint32_t  mode );
[16]306
[407]307/******************************************************************************************
[23]308 * [22] This function creates a named FIFO file in the calling thread cluster.
309 * The associated read and write file descriptors mut be be  explicitely created
[407]310 * using the sys_open() function.
311 ******************************************************************************************
[23]312 * @ pathname   : pathname (can be relative or absolute).
313 * @ mode       : access rights (as defined in chmod).
314 * @ return 0 if success / returns -1 if failure.
[407]315 *****************************************************************************************/
[23]316int sys_mkfifo( char     * pathname,
317                uint32_t   mode );
[16]318
[407]319/******************************************************************************************
320 * [23] This function open a directory, that must exist in the file system, returning
321 * a DIR pointer on the directory in user space.
322 ******************************************************************************************
[23]323 * @ pathname   : pathname (can be relative or absolute).
[407]324 * @ dirp       : [out] buffer for pointer on user directory (DIR).
[23]325 * @ return 0 if success / returns -1 if failure.
[407]326 *****************************************************************************************/
327int sys_opendir( char * pathname,
328                 DIR ** dirp );
[16]329
[407]330/******************************************************************************************
331 * [24] This function returns an user pointer on the dirent structure describing the
332 * next directory entry in the directory identified by the <dirp> argument.
333 ******************************************************************************************
334 * @ dirp     : user pointer identifying the searched directory.
335 * @ dentp    : [out] buffer for pointer on user direntory entry (dirent).
336 * @ return O if success / returns -1 if failure.
337 *****************************************************************************************/
338int sys_readdir( DIR            * dirp,
339                 struct dirent ** dentp );
340
341/******************************************************************************************
342 * [25] This function closes the directory identified by the <dirp> argument, and releases
343 * all structures associated with the <dirp> pointer.
344 ******************************************************************************************
345 * @ dirp     : user pointer identifying the directory.
[23]346 * @ return 0 if success / returns -1 if failure.
[407]347 *****************************************************************************************/
348int sys_closedir( DIR * dirp );
[16]349
[407]350/******************************************************************************************
[23]351 * [26] This function returns the pathname of the current working directory.
[407]352 ******************************************************************************************
[23]353 * buf     : buffer addres in user space.
354 * nbytes  : user buffer size in bytes.
355 * @ return 0 if success / returns -1 if failure.
[407]356 *****************************************************************************************/
[23]357int sys_getcwd( char     * buf,
358                uint32_t   nbytes );
[16]359
[407]360/******************************************************************************************
[437]361 * [27] This function tests whether a given file descriptor dentified by the <file_id>
362 * argument is an open file descriptor referring to a terminal.
363 ******************************************************************************************
364 * @ file_id   : file descriptor index
365 * @ return 1 if it is a TXT device / return 0 if it is not a TXT device.
[407]366 *****************************************************************************************/
[437]367int sys_isatty( uint32_t file_id );
[16]368
[407]369/******************************************************************************************
[23]370 * [28] This function forces the calling thread to sleep, for a fixed number of cycles.
[407]371 ******************************************************************************************
[23]372 * cycles   : number of cycles.
[407]373 *****************************************************************************************/
[23]374int sys_alarm( uint32_t cycles );
[16]375
[407]376/******************************************************************************************
377 * [29] This function removes a directory file whose name is given by <pathname>.
378 * The directory must not have any entries other than `.' and `..'.
379 ******************************************************************************************
[23]380 * @ pathname   : pathname (can be relative or absolute).
381 * @ return 0 if success / returns -1 if failure.
[407]382 *****************************************************************************************/
[23]383int sys_rmdir( char * pathname ); 
[16]384
[407]385/******************************************************************************************
[23]386 * [30] This function implement the operations related to User Thread Local Storage.
387 * It is actually implemented as an uint32_t variable in the thread descriptor.
[407]388 ******************************************************************************************
[23]389 * @ operation  : UTLS operation type as defined below.
390 * @ value      : argument value for the UTLS_SET operation.
391 * @ return value for the UTLS_GET and UTLS_GET_ERRNO / return -1 if failure.
[407]392 *****************************************************************************************/
[23]393int sys_utls( uint32_t operation,
394              uint32_t value );
[16]395
[407]396/******************************************************************************************
[23]397 * [31] This function change the acces rights for the file/dir identified by the
398 * pathname argument.
[407]399 ******************************************************************************************
[23]400 * @ pathname   : pathname (can be relative or absolute).
401 * @ rights     : acces rights.
402 * @ return 0 if success / returns -1 if failure.
[407]403 *****************************************************************************************/
[23]404int sys_chmod( char     * pathname,
405               uint32_t   rights );
[16]406
[407]407/******************************************************************************************
[23]408 * [32] This function associate a specific signal handler to a given signal type.
409 * Tee handlers for the SIGKILL and SIGSTOP signals cannot be redefined.
[407]410 ******************************************************************************************
[23]411 * @ sig_id    : index defining signal type (from 1 to 31).
412 * @ handler   : pointer on fonction implementing the specific handler.
413 * @ return 0 if success / returns -1 if failure.
[407]414 *****************************************************************************************/
[23]415int sys_signal( uint32_t   sig_id,
416                void     * handler );
[16]417
[407]418/******************************************************************************************
[23]419 * [33] This function returns in the structure <tv>, defined in the time.h file,
420 * the current time (in seconds & micro-seconds).
421 * It is computed from the calling core descriptor.
422 * The timezone is not supported.
[407]423 ******************************************************************************************
[23]424 * @ tv      : pointer on the timeval structure.
425 * @ tz      : pointer on the timezone structure : must be NULL.       
426 * @ return 0 if success / returns -1 if failure.
[407]427 *****************************************************************************************/
[50]428int sys_timeofday( struct timeval  * tv,
429                   struct timezone * tz );
[16]430
[407]431/******************************************************************************************
[433]432 * [34] This function implements the "kill" system call on the kernel side.
[23]433 * It register the signal defined by the <sig_id> argument in all thread descriptors
434 * of a target process identified by the <pid> argument. This is done in all clusters
435 * containing threads for the target process.
436 * It can be executed by any thread running in any cluster, as this function uses
[407]437 * remote access to traverse the list of process copies stored in the owner cluster,
[23]438 * and the RPC_SIGNAL_RISE to signal the remote threads.
[421]439 * This function does nothing for (sig_id == 0). This can be used to check process pid.
440 * TODO : This first implementation supports only SIGKILL / SIGSTOP / SIGCONT values.
[407]441 ******************************************************************************************
[16]442 * @ pid      : target process identifier.
[433]443 * @ sig_id   : index defining the signal type.
[23]444 * @ return 0 if success / returns -1 if failure.
[407]445 *****************************************************************************************/
[16]446int sys_kill( pid_t    pid,
[23]447              uint32_t sig_id );
[16]448
[407]449/******************************************************************************************
[433]450 * [35] This function implements the "getpid" system call on the kernel side.
[407]451 ******************************************************************************************
452 * @ returns the process PID for the calling thread.
453 *****************************************************************************************/
[1]454int sys_getpid();
455
[407]456/******************************************************************************************
[433]457 * [36] This function implement the "fork" system call on the kernel side.
458 * The calling process descriptor (parent process), and the associated thread descriptor
459 * are replicated in a - likely - remote cluster, that becomes the child process owner.
460 * The child process get a new PID, and is linked to the parent PID. The child process
461 * inherit from its parent the memory image, and all open files (including the TXT).
462 * The child process becomes the TXT terminal owner.
[1]463 * The target cluster depends on the "fork_user" flag and "fork_cxy" variable that can be
464 * stored in the calling thread descriptor by the specific fork_place() system call.
[433]465 * If not, the kernel function makes a query to the DQDT to select the target cluster.
[407]466 ******************************************************************************************
467 * @ if success, returns child process PID to parent, and return O to child.
468 * @ if failure, returns -1 to parent / no child process is created.
469 *****************************************************************************************/
[1]470int sys_fork();
471
[407]472/******************************************************************************************
[433]473 * [37] This function implement the "exec" system call on the kernel side.
474 * It creates, in the same cluster as the calling thread, a new process descriptor,
475 * and a new associated main thread descriptor, executing a new memory image defined
476 * by the <filename> argument. This new process inherit from the old process the PID
477 * and the PPID, as well as all open files (including the TXT).
478 * The old process descriptor, and all its threads are blocked, and marked for deletion.
479 * Therefore the exec syscall does not return to the calling thread in case of success.
480 * This function build an exec_info_t structure containing the new process arguments,
481 * as defined by the <arv> argument, and the new process environment variables,
482 * as defined by the <envp>  argument.
483 * TODO : the <argv> and <envp> arguments are not supported yet (both must be NULL).
[407]484 ******************************************************************************************
485 * @ filename : string pointer on .elf filename (pointer in user space)
486 * @ argv     : array of strings on process arguments (pointers in user space)
487 * @ envp     : array of strings on environment variables (pointers in user space)
[433]488 * @ does not return if success / returns -1 if failure.
[407]489 *****************************************************************************************/
[1]490int sys_exec( char  * filename,
491              char ** argv,
492              char ** envp );
493
[407]494/******************************************************************************************
495 * [38] This function  returns in the <stat> structure, defined in the "shared_syscalls.h"
496 * file, various informations on the file/directory identified by the <pathname> argument.
497 ******************************************************************************************
498 * @ pathname  : user pointer on file pathname.
499 * @ stat      : user pointer on the stat structure.
[23]500 * @ returns O if success / returns -1 if failure.
[407]501 *****************************************************************************************/
502int sys_stat( const char  * pathname,
503              struct stat * stat );
[1]504
[407]505/******************************************************************************************
[433]506 * [39] This blocking function waits a change of a child process state, that can be:
507 * - a termination of child following a process_make_exit().
508 * - a termination of child following a process_make_kill().
[421]509 * - a blocking of child following a SIGSTOP signal.
[433]510 * In case of a multi-thread process, this function must be called by the main thread
511 * runningin the reference cluster.
512 * When a change has been observed, it returns the PID of the child process, and stores
513 * in the <status> argument relevant information on the child state change.
[421]514 * The following macros can be used to extract information from status:
515 * - WIFEXITED(status)   : is true if the child process terminated with an exit().
[435]516 * - WIFSIGNALED(status) : is true if the child process killed by a signal.
[421]517 * - WIFSTOPPED(status)  : is true if the child process is stopped by a signal.
518 * - WEXITSTATUS(status) : returns the low-order 8 bits of the exit() argument.
519 * If a parent process terminates without waiting for all child processes to terminate,
520 * the remaining child processes are attached to the init process.
[433]521 * WARNING: negative values for the <pid> argument are not supported.
[421]522 ******************************************************************************************
[433]523 * @ searched_pid : searched child process identifier.
524 * @ status       : [out] child termination status.
525 * @ return child PID if success / return -1 if searched PID not found.
[407]526 *****************************************************************************************/
[421]527int sys_wait( uint32_t * status );
[1]528
[407]529/******************************************************************************************
530 * [40] This function returns the hardware platform parameters.
531 ******************************************************************************************
532 * @ x_size   : [out] number of clusters in a row.
533 * @ y_size   : [out] number of clusters in a column.
[421]534 * @ y_width  : [out] number of bits in Y field for CXY.
[407]535 * @ ncores   : [out] number of cores per cluster.
536 * @ return 0 if success / return -1 if illegal arguments
537 *****************************************************************************************/
538int sys_get_config( uint32_t * x_size,
539                    uint32_t * y_size,
[421]540                    uint32_t * y_width,
[407]541                    uint32_t * ncores );
[1]542
[407]543/******************************************************************************************
544 * [41] This function returns the calling core cluster and local index.
545 ******************************************************************************************
546 * @ cxy      : [out] cluster identifier (fixed format)
547 * @ lid      : [out] core local index in cluster.
548 * @ return 0 if success / return -1 if illegal arguments
549 *****************************************************************************************/
550int sys_get_core( uint32_t * cxy,
551                  uint32_t * lid );
[1]552
[407]553/******************************************************************************************
554 * [42] This function returns in a 64 bits user buffer the calling core cycles count.
555 * It uses both the hardware register and the core descriptor cycles count to take
556 * into account a possible harware register overflow  in 32 bits architectures.
557 ******************************************************************************************
558 * cycle    : [out] address of buffer in user space.
559 * @ return 0 if success / return -1 if illegal arguments
560 *****************************************************************************************/
561int sys_get_cycle( uint64_t * cycle );
562
563/******************************************************************************************
[421]564 * [43] This debug function displays on the kernel terminal TXT0 an user defined string,
565 * or the current state of a kernel structure, identified by the <type> argument.
[435]566 * The <arg0> and <arg1> arguments depends on the structure type:
567 * - DISPLAY_STRING          : an user defined string
568 * - DISPLAY_VMM             : VSL and GPT for a process identified by <pid>.
569 * - DISPLAY_SCHED           : all threads allocated to a scheduler <cxy> & <lid>.
570 * - DISPLAY_CLUSTER_PROCESS : all processes registered in a cluster identified by <cxy>. 
571 * - DISPLAY_TXT_PROCESS     : all processes registered in a cluster identified by <cxy>. 
572 * - DISPLAY_VFS             : all files registered in the VFS cache.
573 * - DISPLAY_CHDEV           : all registered channel devices.
[407]574 ******************************************************************************************
[435]575 * type      : [in] type of display
[421]576 * arg0      : [in] type dependant argument.
577 * arg1      : [in] type dependant argument.
[407]578 * @ return 0 if success / return -1 if illegal arguments
579 *****************************************************************************************/
[421]580int sys_display( reg_t  type,
581                 reg_t  arg0,
582                 reg_t  arg1 );
[407]583
584/******************************************************************************************
585 * [45] This function block the calling thread on the THREAD_BLOCKED_GLOBAL condition,
586 * and deschedule.
587 ******************************************************************************************
588 * @ return 0 if success / returns -1 if failure.
589 *****************************************************************************************/
590int sys_thread_sleep();
591
592/******************************************************************************************
593 * [46] This function unblock the thread identified by its <trdid> from the
594 * THREAD_BLOCKED_GLOBAL condition.
595 ******************************************************************************************
596 * @ trdid  : target thread identifier.
597 * @ return 0 if success / return -1 if failure.
598 *****************************************************************************************/
599int sys_thread_wakeup();
600
[421]601/******************************************************************************************
602 * [47] This non-standard function is used to activate / desactivate the trace for a thread
603 * identified by the <trdid> and <pid> arguments.
604 * It can be called by any other thread in the same process.
605 ******************************************************************************************
606 * @ operation  : operation type as defined below.
607 * @ pid        : process identifier.
608 * @ trdid      : thread identifier.
609 * @ returns O if success / returns -1 if failure.
610 *****************************************************************************************/
611int sys_trace( uint32_t operation,
612               pid_t    pid, 
613               uint32_t trdid );
[407]614
[421]615/******************************************************************************************
616 * [48] This function gives the process identified by the <pid> argument
617 * the exclusive ownership of its TXT_TX terminal (put it in foreground).
618 ******************************************************************************************
619 * @ pid    : process identifier.
620 * @ return 0 if success / return -1 if failure.
621 *****************************************************************************************/
622int sys_fg( pid_t   pid );
623
[440]624int sys_place( uint32_t cxy,
625               uint32_t lid );
[421]626
[16]627#endif  // _SYSCALLS_H_
Note: See TracBrowser for help on using the repository browser.