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

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

Introduce sigificant modifs in VFS to support the <ls> command,
and the . and .. directories entries.
File size: 39.9 KB
RevLine 
[1]1/*
[407]2 * syscalls.h - Kernel side services for syscall handling.
[1]3 *
[457]4 * Author     Alain Greiner (2016,2017,2018)
[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
[457]27#include <hal_kernel_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 *****************************************************************************************/
[479]60int sys_thread_yield( void );
[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 ******************************************************************************************
[566]66 * @ trdid_ptr   : [out] pointer on buffer for created thread trdid.
[23]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 *****************************************************************************************/
[566]72int sys_thread_create( trdid_t               * trdid_ptr,
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 ******************************************************************************************
[457]118 * @ vaddr         : semaphore virtual address in user space == identifier.
119 * @ operation     : SEM_INIT / SEM_DESTROY / SEM_GETVALUE / SEM_POST / SEM_WAIT.
120 * @ init_value    : initial semaphore value.
121 * @ current_value : pointer on buffer for current semaphore value.
[23]122 * @ return 0 if success / return -1 if failure.
[407]123 *****************************************************************************************/
[23]124int sys_sem( void       * vaddr,
125             uint32_t     operation,
[457]126             uint32_t     init_value,
127             uint32_t   * current_value );
[16]128
[407]129/******************************************************************************************
[23]130 * [7] This function implement all operations on a POSIX condition variable.
[566]131 * The kernel structure representing a condvar is defined in the remote_condvar.h file,
132 * The code implementing the operations is defined in the remote_condvar.c file.
[407]133 ******************************************************************************************
[23]134 * @ vaddr     : condvar virtual address in user space == identifier.
135 * @ operation : operation type (see below).
136 * @ attr      : mutex virtual address in user space == identifier.
137 * @ return 0 if success / return -1 if failure.
[407]138 *****************************************************************************************/
[23]139int sys_condvar( void     * condvar,
140                 uint32_t   operation,
141                 void     * mutex );
[16]142
[407]143/******************************************************************************************
[23]144 * [8] This function implement all operations on a POSIX barrier.
145 * The kernel structure representing a barrier is defined in the remote_barrier.h file.
146 * The code implementting the operations is defined in the remote_barrier.c file.
[407]147 ******************************************************************************************
[23]148 * @ vaddr     : barrier virtual address in user space == identifier.
149 * @ operation : BARRIER_INIT / BARRIER_DESTROY / BARRIER_WAIT.
150 * @ count     : number of expected threads (only used by BARRIER_INIT operation).
151 * @ return 0 if success / return -1 if failure.
[407]152 *****************************************************************************************/
[23]153int sys_barrier( void     * vaddr,
154                 uint32_t   operation,
155                 uint32_t   count );
[16]156
[407]157/******************************************************************************************
[23]158 * [9] This function implement all operations on a POSIX mutex.
159 * The kernel structure representing a barrier is defined in the remote_barrier.h file.
160 * The code implementting the operations is defined in the remote_barrier.c file.
[407]161 ******************************************************************************************
[23]162 * @ vaddr     : mutex virtual address in user space == identifier.
163 * @ operation : MUTEX_INIT / MUTEX_DESTROY / MUTEX_LOCK / MUTEX_UNLOCK
164 * @ attr      : mutex attributes (non supported yet => must be 0).
165 * @ return 0 if success / return -1 if failure.
[407]166 *****************************************************************************************/
[23]167int sys_mutex( void     * vaddr,
168               uint32_t   operation,
169               uint32_t   count );
[16]170
[407]171/******************************************************************************************
[610]172 * [10] This function causes the file named <old> to be renamed as <new>.
173 * If new exists, it is first removed.  Both old and new must be of the same type (both
174 * must be either directories or non-directories) and must reside on the same file system.
175 * It guarantees that an instance of <new> will always exist, even if the system should
176 * crash in the middle of the operation.
[407]177 ******************************************************************************************
[610]178 * @ old      : old file name.
179 * @ new      : new file name.
180 * @ return 0 if success / return -1 if failure.
[407]181 *****************************************************************************************/
[610]182int sys_rename( char *old,
183                char *new );
[16]184
[407]185/******************************************************************************************
[408]186 * [11] This function remove an existing mapping defined by the <addr> and <size>
[407]187 * arguments in user space.
188 ******************************************************************************************
189 * @ addr  : base address in user space.
190 * # size  : number of bytes.
[23]191 * @ return 0 if success / return -1 if failure.
[407]192 *****************************************************************************************/
193int sys_munmap( void     * addr,
194                uint32_t   size );
[16]195
[407]196/******************************************************************************************
197 * [12] This function open or create an open file descriptor.
198 ******************************************************************************************
[23]199 * @ pathname   : pathname (can be relative or absolute).
[445]200 * @ flags      : bit vector attributes (see in shared_fcntl.h file)
[23]201 * @ mode       : access rights.
202 * @ return file descriptor index in fd_array if success / return -1 if failure.
[407]203 *****************************************************************************************/
[566]204int sys_open( char       * pathname,
[506]205              uint32_t     flags,
206              uint32_t     mode );
[16]207
[407]208/******************************************************************************************
209 * [13] This function map physical memory (or a file) in the calling thread virtual space.
210 * The <attr> argument is a pointer on a structure for arguments (see shared_syscalls.h).
[594]211 * The user defined virtual address (MAP_FIXED flag) is not supported.
212 * TODO : the access rights checking is not implemented yet [AG]
213 * TODO : the Copy on Write for MAP_PRIVATE is not implemented yet [AG]
[407]214 ******************************************************************************************
215 * @ attr       : pointer on attributes structure.
216 * @ return 0 if success / return -1 if failure.
217 *****************************************************************************************/
218int sys_mmap( mmap_attr_t * attr );
[23]219
[407]220/******************************************************************************************
[23]221 * [14] This function read bytes from an open file identified by its file descriptor.
[407]222 * The file can be a regular file or character oriented device.
[408]223 * IRQs are enabled during this system call.
[407]224 ******************************************************************************************
[23]225 * @ file_id  : open file index in fd_array.
226 * @ buf      : buffer virtual address in user space.
227 * @ count    : number of bytes.
228 * @ return number of bytes actually read if success / returns -1 if failure.
[407]229 *****************************************************************************************/
[23]230int sys_read( uint32_t   file_id,
231              void     * buf,
232              uint32_t   count );
[16]233
[407]234/******************************************************************************************
[23]235 * [15] This function writes bytes to an open file identified by its file descriptor.
[407]236 * The file can be a regular file or character oriented device.
[408]237 * IRQs are enabled during this system call.
[407]238 ******************************************************************************************
[23]239 * @ file_id  : open file index in fd_array.
240 * @ buf      : buffer virtual address in user space.
241 * @ count    : number of bytes.
242 * @ return number of bytes actually written if success / returns -1 if failure.
[407]243 *****************************************************************************************/
[23]244int sys_write( uint32_t   file_id,
245               void     * buf,
246               uint32_t   count );
[16]247
[407]248/******************************************************************************************
249 * [16] This function repositions the offset of the file descriptor identified by <file_id>,
250 * according to the operation type defined by the <whence> argument.
251 ******************************************************************************************
[23]252 * @ file_id  : open file index in fd_array.
[407]253 * @ offset   : used to compute new offset value.
[23]254 * @ whence   : operation type (see below).
255 * @ return 0 if success / returns -1 if failure.
[407]256 *****************************************************************************************/
[23]257int sys_lseek( xptr_t    file_id,
258               uint32_t  offset,
259               uint32_t  whence );
[16]260
[407]261/******************************************************************************************
[23]262 * [17] This function release the memory allocated for the file descriptor identified by
263 * the <file_id> argument, and remove the fd array_entry in all copies of the process
264 * descriptor.
[407]265 ******************************************************************************************
[23]266  file_id   : file descriptor index in fd_array.
267 * @ return 0 if success / returns -1 if failure.
[407]268 *****************************************************************************************/
[23]269int sys_close( uint32_t file_id );
[16]270
[407]271/******************************************************************************************
272 * [18] This function removes a directory entry identified by the <pathname> from the
[23]273 * directory, and decrement the link count of the file referenced by the link.
274 * If the link count reduces to zero, and no process has the file open, then all resources
275 * associated with the file are reclaimed.  If one or more process have the file open when
276 * the last link is removed, the link is removed, but the removal of the file is delayed
277 * until all references to it have been closed.
[407]278 ******************************************************************************************
[23]279 * @ pathname   : pathname (can be relative or absolute).
280 * @ return 0 if success / returns -1 if failure.
[407]281 *****************************************************************************************/
[566]282int sys_unlink( char * pathname );
[16]283
[407]284/******************************************************************************************
[23]285 * [19] This function creates in the calling thread cluster an unnamed pipe, and two
286 * (read and write) file descriptors.
[594]287 * TODO not implemented yet [AG]
[407]288 ******************************************************************************************
[23]289 * @ file_id[0] : [out] read only file descriptor index.
290 * @ file_id[1] : [out] write only file descriptor index.
291 * @ return 0 if success / return -1 if failure.
[407]292 *****************************************************************************************/
[23]293int sys_pipe( uint32_t file_id[2] );
[16]294
[407]295/******************************************************************************************
[23]296 * [20] This function change the current working directory in reference process descriptor.
[407]297 ******************************************************************************************
[23]298 * @ pathname   : pathname (can be relative or absolute).
299 * @ return 0 if success / returns -1 if failure.
[407]300 *****************************************************************************************/
[566]301int sys_chdir( char * pathname );
[16]302
[407]303/******************************************************************************************
[610]304 * [21] This function implements the "mkdir" system call, creating a new directory in
305 * the file system, as defined by the <pathname> argument, with the access permission
306 * defined by the <rights> argument. All nodes but the last in the pathname must exist.
307 * It can be called by any thread running in any cluster.
[407]308 ******************************************************************************************
[610]309 * @ pathname  : pathname defining the new directory location in file system.
310 * @ rights    : access rights (non used yet).
311 * @ return 0 if success / return -1 if failure.
[407]312 *****************************************************************************************/
[610]313int sys_mkdir( char     * pathname,
314               uint32_t   rights );
[16]315
[407]316/******************************************************************************************
[23]317 * [22] This function creates a named FIFO file in the calling thread cluster.
318 * The associated read and write file descriptors mut be be  explicitely created
[407]319 * using the sys_open() function.
320 ******************************************************************************************
[23]321 * @ pathname   : pathname (can be relative or absolute).
322 * @ mode       : access rights (as defined in chmod).
323 * @ return 0 if success / returns -1 if failure.
[407]324 *****************************************************************************************/
[23]325int sys_mkfifo( char     * pathname,
326                uint32_t   mode );
[16]327
[407]328/******************************************************************************************
329 * [23] This function open a directory, that must exist in the file system, returning
[611]330 * a DIR pointer on the dirent array in user space.
[407]331 ******************************************************************************************
[611]332 * @ pathname   : [in]  pathname (can be relative or absolute).
[407]333 * @ dirp       : [out] buffer for pointer on user directory (DIR).
[23]334 * @ return 0 if success / returns -1 if failure.
[407]335 *****************************************************************************************/
336int sys_opendir( char * pathname,
337                 DIR ** dirp );
[16]338
[407]339/******************************************************************************************
340 * [24] This function returns an user pointer on the dirent structure describing the
341 * next directory entry in the directory identified by the <dirp> argument.
342 ******************************************************************************************
[611]343 * @ dirp     : [in]  user pointer on dirent array identifying the open directory.
344 * @ buffer   : [out] pointer on user buffer for a pointer on dirent in user space.
[407]345 * @ return O if success / returns -1 if failure.
346 *****************************************************************************************/
347int sys_readdir( DIR            * dirp,
[611]348                 struct dirent ** buffer );
[407]349
350/******************************************************************************************
351 * [25] This function closes the directory identified by the <dirp> argument, and releases
352 * all structures associated with the <dirp> pointer.
353 ******************************************************************************************
[611]354 * @ dirp     : [in] user pointer on dirent array identifying the open directory.
[23]355 * @ return 0 if success / returns -1 if failure.
[407]356 *****************************************************************************************/
357int sys_closedir( DIR * dirp );
[16]358
[407]359/******************************************************************************************
[23]360 * [26] This function returns the pathname of the current working directory.
[407]361 ******************************************************************************************
[23]362 * buf     : buffer addres in user space.
363 * nbytes  : user buffer size in bytes.
364 * @ return 0 if success / returns -1 if failure.
[407]365 *****************************************************************************************/
[23]366int sys_getcwd( char     * buf,
367                uint32_t   nbytes );
[16]368
[407]369/******************************************************************************************
[437]370 * [27] This function tests whether a given file descriptor dentified by the <file_id>
371 * argument is an open file descriptor referring to a terminal.
372 ******************************************************************************************
373 * @ file_id   : file descriptor index
374 * @ return 1 if it is a TXT device / return 0 if it is not a TXT device.
[407]375 *****************************************************************************************/
[437]376int sys_isatty( uint32_t file_id );
[16]377
[407]378/******************************************************************************************
[23]379 * [28] This function forces the calling thread to sleep, for a fixed number of cycles.
[407]380 ******************************************************************************************
[23]381 * cycles   : number of cycles.
[407]382 *****************************************************************************************/
[23]383int sys_alarm( uint32_t cycles );
[16]384
[407]385/******************************************************************************************
386 * [29] This function removes a directory file whose name is given by <pathname>.
387 * The directory must not have any entries other than `.' and `..'.
388 ******************************************************************************************
[23]389 * @ pathname   : pathname (can be relative or absolute).
390 * @ return 0 if success / returns -1 if failure.
[407]391 *****************************************************************************************/
[566]392int sys_rmdir( char * pathname );
[16]393
[407]394/******************************************************************************************
[23]395 * [30] This function implement the operations related to User Thread Local Storage.
396 * It is actually implemented as an uint32_t variable in the thread descriptor.
[407]397 ******************************************************************************************
[23]398 * @ operation  : UTLS operation type as defined below.
399 * @ value      : argument value for the UTLS_SET operation.
400 * @ return value for the UTLS_GET and UTLS_GET_ERRNO / return -1 if failure.
[407]401 *****************************************************************************************/
[23]402int sys_utls( uint32_t operation,
403              uint32_t value );
[16]404
[407]405/******************************************************************************************
[23]406 * [31] This function change the acces rights for the file/dir identified by the
407 * pathname argument.
[407]408 ******************************************************************************************
[23]409 * @ pathname   : pathname (can be relative or absolute).
410 * @ rights     : acces rights.
411 * @ return 0 if success / returns -1 if failure.
[407]412 *****************************************************************************************/
[566]413int sys_chmod( char       * pathname,
[506]414               uint32_t     rights );
[16]415
[407]416/******************************************************************************************
[23]417 * [32] This function associate a specific signal handler to a given signal type.
[584]418 * The handlers for the SIGKILL and SIGSTOP signals cannot be redefined.
[407]419 ******************************************************************************************
[23]420 * @ sig_id    : index defining signal type (from 1 to 31).
421 * @ handler   : pointer on fonction implementing the specific handler.
422 * @ return 0 if success / returns -1 if failure.
[407]423 *****************************************************************************************/
[23]424int sys_signal( uint32_t   sig_id,
425                void     * handler );
[16]426
[407]427/******************************************************************************************
[23]428 * [33] This function returns in the structure <tv>, defined in the time.h file,
429 * the current time (in seconds & micro-seconds).
430 * It is computed from the calling core descriptor.
431 * The timezone is not supported.
[407]432 ******************************************************************************************
[23]433 * @ tv      : pointer on the timeval structure.
434 * @ tz      : pointer on the timezone structure : must be NULL.       
435 * @ return 0 if success / returns -1 if failure.
[407]436 *****************************************************************************************/
[50]437int sys_timeofday( struct timeval  * tv,
438                   struct timezone * tz );
[16]439
[407]440/******************************************************************************************
[433]441 * [34] This function implements the "kill" system call on the kernel side.
[23]442 * It register the signal defined by the <sig_id> argument in all thread descriptors
443 * of a target process identified by the <pid> argument. This is done in all clusters
444 * containing threads for the target process.
445 * It can be executed by any thread running in any cluster, as this function uses
[407]446 * remote access to traverse the list of process copies stored in the owner cluster,
[23]447 * and the RPC_SIGNAL_RISE to signal the remote threads.
[421]448 * This function does nothing for (sig_id == 0). This can be used to check process pid.
449 * TODO : This first implementation supports only SIGKILL / SIGSTOP / SIGCONT values.
[407]450 ******************************************************************************************
[16]451 * @ pid      : target process identifier.
[433]452 * @ sig_id   : index defining the signal type.
[23]453 * @ return 0 if success / returns -1 if failure.
[407]454 *****************************************************************************************/
[16]455int sys_kill( pid_t    pid,
[23]456              uint32_t sig_id );
[16]457
[407]458/******************************************************************************************
[433]459 * [35] This function implements the "getpid" system call on the kernel side.
[407]460 ******************************************************************************************
461 * @ returns the process PID for the calling thread.
462 *****************************************************************************************/
[479]463int sys_getpid( void );
[1]464
[407]465/******************************************************************************************
[433]466 * [36] This function implement the "fork" system call on the kernel side.
467 * The calling process descriptor (parent process), and the associated thread descriptor
468 * are replicated in a - likely - remote cluster, that becomes the child process owner.
469 * The child process get a new PID, and is linked to the parent PID. The child process
470 * inherit from its parent the memory image, and all open files (including the TXT).
471 * The child process becomes the TXT terminal owner.
[1]472 * The target cluster depends on the "fork_user" flag and "fork_cxy" variable that can be
473 * stored in the calling thread descriptor by the specific fork_place() system call.
[433]474 * If not, the kernel function makes a query to the DQDT to select the target cluster.
[407]475 ******************************************************************************************
476 * @ if success, returns child process PID to parent, and return O to child.
477 * @ if failure, returns -1 to parent / no child process is created.
478 *****************************************************************************************/
[479]479int sys_fork( void );
[1]480
[407]481/******************************************************************************************
[433]482 * [37] This function implement the "exec" system call on the kernel side.
483 * It creates, in the same cluster as the calling thread, a new process descriptor,
484 * and a new associated main thread descriptor, executing a new memory image defined
485 * by the <filename> argument. This new process inherit from the old process the PID
486 * and the PPID, as well as all open files (including the TXT).
487 * The old process descriptor, and all its threads are blocked, and marked for deletion.
488 * Therefore the exec syscall does not return to the calling thread in case of success.
489 * This function build an exec_info_t structure containing the new process arguments,
490 * as defined by the <arv> argument, and the new process environment variables,
491 * as defined by the <envp>  argument.
492 * TODO : the <argv> and <envp> arguments are not supported yet (both must be NULL).
[407]493 ******************************************************************************************
494 * @ filename : string pointer on .elf filename (pointer in user space)
495 * @ argv     : array of strings on process arguments (pointers in user space)
496 * @ envp     : array of strings on environment variables (pointers in user space)
[433]497 * @ does not return if success / returns -1 if failure.
[407]498 *****************************************************************************************/
[566]499int sys_exec( char  * filename,
500              char ** argv,
501              char ** envp );
[1]502
[407]503/******************************************************************************************
504 * [38] This function  returns in the <stat> structure, defined in the "shared_syscalls.h"
505 * file, various informations on the file/directory identified by the <pathname> argument.
[594]506 * TODO only the <st_ino>, <st_mode>,<st_uid>,<st_gid>,<st_size> are set.
[407]507 ******************************************************************************************
508 * @ pathname  : user pointer on file pathname.
509 * @ stat      : user pointer on the stat structure.
[23]510 * @ returns O if success / returns -1 if failure.
[407]511 *****************************************************************************************/
[566]512int sys_stat( char        * pathname,
[407]513              struct stat * stat );
[1]514
[407]515/******************************************************************************************
[433]516 * [39] This blocking function waits a change of a child process state, that can be:
517 * - a termination of child following a process_make_exit().
518 * - a termination of child following a process_make_kill().
[421]519 * - a blocking of child following a SIGSTOP signal.
[433]520 * In case of a multi-thread process, this function must be called by the main thread
521 * runningin the reference cluster.
522 * When a change has been observed, it returns the PID of the child process, and stores
523 * in the <status> argument relevant information on the child state change.
[421]524 * The following macros can be used to extract information from status:
525 * - WIFEXITED(status)   : is true if the child process terminated with an exit().
[435]526 * - WIFSIGNALED(status) : is true if the child process killed by a signal.
[421]527 * - WIFSTOPPED(status)  : is true if the child process is stopped by a signal.
528 * - WEXITSTATUS(status) : returns the low-order 8 bits of the exit() argument.
529 * If a parent process terminates without waiting for all child processes to terminate,
530 * the remaining child processes are attached to the init process.
[433]531 * WARNING: negative values for the <pid> argument are not supported.
[421]532 ******************************************************************************************
[433]533 * @ searched_pid : searched child process identifier.
534 * @ status       : [out] child termination status.
535 * @ return child PID if success / return -1 if searched PID not found.
[407]536 *****************************************************************************************/
[421]537int sys_wait( uint32_t * status );
[1]538
[407]539/******************************************************************************************
[584]540 * [40] This function implement the non-standard get_config() syscall.
541 * It returns in <x_size>, <y_size>, <ncores> the hardware platform parameters.
[407]542 ******************************************************************************************
543 * @ x_size   : [out] number of clusters in a row.
544 * @ y_size   : [out] number of clusters in a column.
545 * @ ncores   : [out] number of cores per cluster.
546 * @ return 0 if success / return -1 if illegal arguments
547 *****************************************************************************************/
548int sys_get_config( uint32_t * x_size,
549                    uint32_t * y_size,
550                    uint32_t * ncores );
[1]551
[407]552/******************************************************************************************
[584]553 * [41] This function implements the non-standard get_core() syscall.
554 * It returns in <cxy> and <lid> the calling core cluster and local index.
[407]555 ******************************************************************************************
556 * @ cxy      : [out] cluster identifier (fixed format)
557 * @ lid      : [out] core local index in cluster.
558 * @ return 0 if success / return -1 if illegal arguments
559 *****************************************************************************************/
560int sys_get_core( uint32_t * cxy,
561                  uint32_t * lid );
[1]562
[407]563/******************************************************************************************
[584]564 * [42] This function implements the non-standard get_cycle() syscall.
565 * It returns in a 64 bits user buffer the calling core cycles count.
[407]566 * It uses both the hardware register and the core descriptor cycles count to take
567 * into account a possible harware register overflow  in 32 bits architectures.
568 ******************************************************************************************
569 * cycle    : [out] address of buffer in user space.
570 * @ return 0 if success / return -1 if illegal arguments
571 *****************************************************************************************/
572int sys_get_cycle( uint64_t * cycle );
573
574/******************************************************************************************
[421]575 * [43] This debug function displays on the kernel terminal TXT0 an user defined string,
576 * or the current state of a kernel structure, identified by the <type> argument.
[611]577 * The <arg0>, <arg1>, and <arg2> arguments depends on the structure type:
[435]578 * - DISPLAY_STRING          : an user defined string
579 * - DISPLAY_VMM             : VSL and GPT for a process identified by <pid>.
580 * - DISPLAY_SCHED           : all threads allocated to a scheduler <cxy> & <lid>.
581 * - DISPLAY_CLUSTER_PROCESS : all processes registered in a cluster identified by <cxy>. 
582 * - DISPLAY_TXT_PROCESS     : all processes registered in a cluster identified by <cxy>. 
583 * - DISPLAY_VFS             : all files registered in the VFS cache.
584 * - DISPLAY_CHDEV           : all registered channel devices.
[611]585 * - DISPLAY_DQDT            : all DQDT nodes curren values.
586 * - DISPLAY_BUSYLOCKS       : all busylocks taken by one thread.
587 * - DISPLAY_MAPPER          : one page of a given mapper.
[407]588 ******************************************************************************************
[435]589 * type      : [in] type of display
[421]590 * arg0      : [in] type dependant argument.
591 * arg1      : [in] type dependant argument.
[611]592 * arg2      : [in] type dependant argument.
[407]593 * @ return 0 if success / return -1 if illegal arguments
594 *****************************************************************************************/
[421]595int sys_display( reg_t  type,
596                 reg_t  arg0,
[611]597                 reg_t  arg1,
598                 reg_t  arg2 );
[407]599
600/******************************************************************************************
[584]601 * [44] This function implements the non-standard place_fork() syscall.
602 * It can be used to specify the target cluster <cxy> for a new process created
603 * by a subsequent fork() syscall.
604 * WARNING: it must be called before each fork() syscall, as the placement specification
605 *          is reset by the fork syscall.
[457]606 ******************************************************************************************
607 * @ cxy    : cluster identifier.
608 * @ return 0 if success / return -1 if failure.
609 *****************************************************************************************/
[584]610int sys_place_fork( uint32_t cxy );
[457]611
612/******************************************************************************************
[407]613 * [45] This function block the calling thread on the THREAD_BLOCKED_GLOBAL condition,
614 * and deschedule.
615 ******************************************************************************************
616 * @ return 0 if success / returns -1 if failure.
617 *****************************************************************************************/
[479]618int sys_thread_sleep( void );
[407]619
620/******************************************************************************************
621 * [46] This function unblock the thread identified by its <trdid> from the
622 * THREAD_BLOCKED_GLOBAL condition.
623 ******************************************************************************************
624 * @ trdid  : target thread identifier.
625 * @ return 0 if success / return -1 if failure.
626 *****************************************************************************************/
[506]627int sys_thread_wakeup( trdid_t trdid );
[407]628
[421]629/******************************************************************************************
[443]630 * [47] This debug function is used to activate / desactivate the context switches trace
631 * for a core identified by the <cxy> and <lid> arguments.
[421]632 * It can be called by any other thread in the same process.
633 ******************************************************************************************
[443]634 * @ active     : activate trace if true / desactivate trace if false.
635 * @ cxy        : cluster identifier.
636 * @ lid        : core local index.
[421]637 * @ returns O if success / returns -1 if failure.
638 *****************************************************************************************/
[443]639int sys_trace( bool_t   active,
640               cxy_t    cxy, 
641               lid_t    lid );
[407]642
[421]643/******************************************************************************************
644 * [48] This function gives the process identified by the <pid> argument
645 * the exclusive ownership of its TXT_TX terminal (put it in foreground).
646 ******************************************************************************************
647 * @ pid    : process identifier.
648 * @ return 0 if success / return -1 if failure.
649 *****************************************************************************************/
650int sys_fg( pid_t   pid );
651
[445]652/******************************************************************************************
[457]653 * [49] This function returns a non-zero value in the <is_fg> buffer when the process
654 * identified by the <pid> argument is the current TXT owner.
[445]655 ******************************************************************************************
[457]656 * @ pid      : process identifier.
657 * @ is_fg    : pointer on buffer.
[445]658 * @ return 0 if success / return -1 if failure.
659 *****************************************************************************************/
[457]660int sys_is_fg( pid_t      pid,
661               uint32_t * is_fg );
[421]662
[610]663/******************************************************************************************
664 * [50] This function implements the exit system call terminating a POSIX process.
665 * It can be called by any thread running in any cluster.
666 * It uses both remote accesses to access the owner process descriptor, and the
667 * RPC_PROCESS_SIGACTION to delete remote process and thread descriptors.
668 * In the present implementation, this function implements actually the _exit():
669 * - it does not flush open output streams.
670 * - it does not close open streams.
671 ******************************************************************************************
672 * @ status   : terminaison status.
673 *****************************************************************************************/
674int sys_exit( uint32_t status );
675
[16]676#endif  // _SYSCALLS_H_
Note: See TracBrowser for help on using the repository browser.