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

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

First implementation of fork/exec.
File size: 32.2 KB
Line 
1/*
2 * syscalls.h - Kernel side services for syscall handling.
3 *
4 * Author     Alain Greiner (2016,2017)
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
24#ifndef _SYSCALLS_H_
25#define _SYSCALLS_H_
26
27#include <hal_types.h>
28#include <shared_syscalls.h>
29
30/**   Forward declarations  *****/
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
38/******************************************************************************************
39 * [0] This function terminates the execution of the calling user thread,
40 * and makes the exit_value pointer available to any successful pthread_join() with the
41 * terminating thread.
42 ******************************************************************************************
43 * @ exit_vallue  : pointer to be returned to parent thread if thead is attached.
44 * @ return 0 if success / return -1 if failure.
45 *****************************************************************************************/
46int sys_thread_exit( void * exit_value );
47
48/******************************************************************************************
49 * [1] This function calls the scheduler for the core running the calling thread.
50 ******************************************************************************************
51 * @ x_size   : [out] number of clusters in a row.
52 * @ y_size   : [out] number of clusters in a column.
53 * @ ncores   : [out] number of cores per cluster.
54 * @ return always 0.
55 *****************************************************************************************/
56int sys_thread_yield();
57
58/******************************************************************************************
59 * [2] This function creates a new user thread. The <user_attr> argument is a pointer
60 * on astructure containing the thread attributes, defined in thread.h file.
61 ******************************************************************************************
62 * @ new_thread  : [out] local pointer on created thread descriptor.
63 * @ user_attr   : [in]  pointer on thread attributes structure.
64 * @ start_func  : [in]  pointer on start function.
65 * @ start_args  : [in]  pointer on start function arguments.
66 * @ return 0 if success / return -1 if failure.
67 *****************************************************************************************/
68int sys_thread_create( struct thread_s        * new_thread,
69                       struct pthread_attr_s  * user_attr,
70                       void                   * start_func,
71                       void                   * start_args );
72
73/******************************************************************************************
74 * [3] This blocking function suspend execution of the calling thread until completion
75 * of another target thread identified by the <trdid> argument.
76 * If the <exit_value> argument is not NULL, the value passed to pthread_exit() by the
77 * target thread is stored in the location referenced by exit_value.
78 ******************************************************************************************
79 * @ trdid     : [in]  target thread identifier.
80 * @ thread    : [out] buffer for exit_value returned by target thread.
81 * @ return 0 if success / return -1 if failure.
82 *****************************************************************************************/
83int sys_thread_join( trdid_t    trdid,
84                     void    ** exit_value );
85
86/******************************************************************************************
87 * [4] This function detach a joinable thread.
88 ******************************************************************************************
89 * @ trdid   : thread identifier.i
90 * @ return 0 if success / return -1 if failure.
91 *****************************************************************************************/
92int sys_thread_detach( trdid_t  trdid );
93
94/******************************************************************************************
95 * [5] This slot is not used.
96 *****************************************************************************************/
97
98/******************************************************************************************
99 * [6] This function implement all operations on a POSIX unnamed semaphore,
100 * that can be shared by threads running in different clusters.
101 * The kernel structure representing a remote semaphore is in the remote_sem.h file,
102 * and the code implementing the operations is in the remore_sem.c file.
103 ******************************************************************************************
104 * @ vaddr     : semaphore virtual address in user space == identifier.
105 * @ operation : SEM_INIT / SEM_DESTROY / SEM_GETVALUE / SEM_POST / SEM_WAIT.
106 * @ value     : pointer on in/out argument in user space.
107 * @ return 0 if success / return -1 if failure.
108 *****************************************************************************************/
109int sys_sem( void       * vaddr,
110             uint32_t     operation,
111             uint32_t   * value );
112
113/******************************************************************************************
114 * [7] This function implement all operations on a POSIX condition variable.
115 * The kernel structure representing a cond_var is defined in the remote_cv.h file,
116 * The code implementing the operations is defined in the remote_cv.c file.
117 ******************************************************************************************
118 * @ vaddr     : condvar virtual address in user space == identifier.
119 * @ operation : operation type (see below).
120 * @ attr      : mutex virtual address in user space == identifier.
121 * @ return 0 if success / return -1 if failure.
122 *****************************************************************************************/
123int sys_condvar( void     * condvar,
124                 uint32_t   operation,
125                 void     * mutex );
126
127/******************************************************************************************
128 * [8] This function implement all operations on a POSIX barrier.
129 * The kernel structure representing a barrier is defined in the remote_barrier.h file.
130 * The code implementting the operations is defined in the remote_barrier.c file.
131 ******************************************************************************************
132 * @ vaddr     : barrier virtual address in user space == identifier.
133 * @ operation : BARRIER_INIT / BARRIER_DESTROY / BARRIER_WAIT.
134 * @ count     : number of expected threads (only used by BARRIER_INIT operation).
135 * @ return 0 if success / return -1 if failure.
136 *****************************************************************************************/
137int sys_barrier( void     * vaddr,
138                 uint32_t   operation,
139                 uint32_t   count );
140
141/******************************************************************************************
142 * [9] This function implement all operations on a POSIX mutex.
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.
145 ******************************************************************************************
146 * @ vaddr     : mutex virtual address in user space == identifier.
147 * @ operation : MUTEX_INIT / MUTEX_DESTROY / MUTEX_LOCK / MUTEX_UNLOCK
148 * @ attr      : mutex attributes (non supported yet => must be 0).
149 * @ return 0 if success / return -1 if failure.
150 *****************************************************************************************/
151int sys_mutex( void     * vaddr,
152               uint32_t   operation,
153               uint32_t   count );
154
155/******************************************************************************************
156 * [10] This slot not allocated yet
157 ******************************************************************************************
158 * @ return 0 if success / returns -1 if failure.
159 *****************************************************************************************/
160
161/******************************************************************************************
162 * [11] This function rmove an existing mapping defined by the <addr> and <size>
163 * arguments in user space.
164 ******************************************************************************************
165 * @ addr  : base address in user space.
166 * # size  : number of bytes.
167 * @ return 0 if success / return -1 if failure.
168 *****************************************************************************************/
169int sys_munmap( void     * addr,
170                uint32_t   size );
171
172/******************************************************************************************
173 * [12] This function open or create an open file descriptor.
174 ******************************************************************************************
175 * @ pathname   : pathname (can be relative or absolute).
176 * @ flags      : bit vector attributes (see below).
177 * @ mode       : access rights.
178 * @ return file descriptor index in fd_array if success / return -1 if failure.
179 *****************************************************************************************/
180int sys_open( char    * pathname,
181              uint32_t  flags,
182              uint32_t  mode );
183
184/******************************************************************************************
185 * [13] This function map physical memory (or a file) in the calling thread virtual space.
186 * The <attr> argument is a pointer on a structure for arguments (see shared_syscalls.h).
187 ******************************************************************************************
188 * @ attr       : pointer on attributes structure.
189 * @ return 0 if success / return -1 if failure.
190 *****************************************************************************************/
191int sys_mmap( mmap_attr_t * attr );
192
193/******************************************************************************************
194 * [14] This function read bytes from an open file identified by its file descriptor.
195 * The file can be a regular file or character oriented device.
196 ******************************************************************************************
197 * @ file_id  : open file index in fd_array.
198 * @ buf      : buffer virtual address in user space.
199 * @ count    : number of bytes.
200 * @ return number of bytes actually read if success / returns -1 if failure.
201 *****************************************************************************************/
202int sys_read( uint32_t   file_id,
203              void     * buf,
204              uint32_t   count );
205
206/******************************************************************************************
207 * [15] This function writes bytes to an open file identified by its file descriptor.
208 * The file can be a regular file or character oriented device.
209 ******************************************************************************************
210 * @ file_id  : open file index in fd_array.
211 * @ buf      : buffer virtual address in user space.
212 * @ count    : number of bytes.
213 * @ return number of bytes actually written if success / returns -1 if failure.
214 *****************************************************************************************/
215int sys_write( uint32_t   file_id,
216               void     * buf,
217               uint32_t   count );
218
219/******************************************************************************************
220 * [16] This function repositions the offset of the file descriptor identified by <file_id>,
221 * according to the operation type defined by the <whence> argument.
222 ******************************************************************************************
223 * @ file_id  : open file index in fd_array.
224 * @ offset   : used to compute new offset value.
225 * @ whence   : operation type (see below).
226 * @ return 0 if success / returns -1 if failure.
227 *****************************************************************************************/
228int sys_lseek( xptr_t    file_id,
229               uint32_t  offset,
230               uint32_t  whence );
231
232/******************************************************************************************
233 * [17] This function release the memory allocated for the file descriptor identified by
234 * the <file_id> argument, and remove the fd array_entry in all copies of the process
235 * descriptor.
236 ******************************************************************************************
237  file_id   : file descriptor index in fd_array.
238 * @ return 0 if success / returns -1 if failure.
239 *****************************************************************************************/
240int sys_close( uint32_t file_id );
241
242/******************************************************************************************
243 * [18] This function removes a directory entry identified by the <pathname> from the
244 * directory, and decrement the link count of the file referenced by the link.
245 * If the link count reduces to zero, and no process has the file open, then all resources
246 * associated with the file are reclaimed.  If one or more process have the file open when
247 * the last link is removed, the link is removed, but the removal of the file is delayed
248 * until all references to it have been closed.
249 ******************************************************************************************
250 * @ pathname   : pathname (can be relative or absolute).
251 * @ return 0 if success / returns -1 if failure.
252 *****************************************************************************************/
253int sys_unlink( char * pathname );
254
255/******************************************************************************************
256 * [19] This function creates in the calling thread cluster an unnamed pipe, and two
257 * (read and write) file descriptors.
258 * TODO not implemented yet...
259 ******************************************************************************************
260 * @ file_id[0] : [out] read only file descriptor index.
261 * @ file_id[1] : [out] write only file descriptor index.
262 * @ return 0 if success / return -1 if failure.
263 *****************************************************************************************/
264int sys_pipe( uint32_t file_id[2] );
265
266/******************************************************************************************
267 * [20] This function change the current working directory in reference process descriptor.
268 ******************************************************************************************
269 * @ pathname   : pathname (can be relative or absolute).
270 * @ return 0 if success / returns -1 if failure.
271 *****************************************************************************************/
272int sys_chdir( char * pathname );
273
274/******************************************************************************************
275 * [21] This function creates a new directory in file system.
276 ******************************************************************************************
277 * @ pathname   : pathname (can be relative or absolute).
278 * @ mode       : access rights (as defined in chmod).
279 * @ return 0 if success / returns -1 if failure.
280 *****************************************************************************************/
281int sys_mkdir( char    * pathname,
282               uint32_t  mode );
283
284/******************************************************************************************
285 * [22] This function creates a named FIFO file in the calling thread cluster.
286 * The associated read and write file descriptors mut be be  explicitely created
287 * using the sys_open() function.
288 ******************************************************************************************
289 * @ pathname   : pathname (can be relative or absolute).
290 * @ mode       : access rights (as defined in chmod).
291 * @ return 0 if success / returns -1 if failure.
292 *****************************************************************************************/
293int sys_mkfifo( char     * pathname,
294                uint32_t   mode );
295
296/******************************************************************************************
297 * [23] This function open a directory, that must exist in the file system, returning
298 * a DIR pointer on the directory in user space.
299 ******************************************************************************************
300 * @ pathname   : pathname (can be relative or absolute).
301 * @ dirp       : [out] buffer for pointer on user directory (DIR).
302 * @ return 0 if success / returns -1 if failure.
303 *****************************************************************************************/
304int sys_opendir( char * pathname,
305                 DIR ** dirp );
306
307/******************************************************************************************
308 * [24] This function returns an user pointer on the dirent structure describing the
309 * next directory entry in the directory identified by the <dirp> argument.
310 ******************************************************************************************
311 * @ dirp     : user pointer identifying the searched directory.
312 * @ dentp    : [out] buffer for pointer on user direntory entry (dirent).
313 * @ return O if success / returns -1 if failure.
314 *****************************************************************************************/
315int sys_readdir( DIR            * dirp,
316                 struct dirent ** dentp );
317
318/******************************************************************************************
319 * [25] This function closes the directory identified by the <dirp> argument, and releases
320 * all structures associated with the <dirp> pointer.
321 ******************************************************************************************
322 * @ dirp     : user pointer identifying the directory.
323 * @ return 0 if success / returns -1 if failure.
324 *****************************************************************************************/
325int sys_closedir( DIR * dirp );
326
327/******************************************************************************************
328 * [26] This function returns the pathname of the current working directory.
329 ******************************************************************************************
330 * buf     : buffer addres in user space.
331 * nbytes  : user buffer size in bytes.
332 * @ return 0 if success / returns -1 if failure.
333 *****************************************************************************************/
334int sys_getcwd( char     * buf,
335                uint32_t   nbytes );
336
337/******************************************************************************************
338 * [27] This slot is not used.
339 *****************************************************************************************/
340
341/******************************************************************************************
342 * [28] This function forces the calling thread to sleep, for a fixed number of cycles.
343 ******************************************************************************************
344 * cycles   : number of cycles.
345 *****************************************************************************************/
346int sys_alarm( uint32_t cycles );
347
348/******************************************************************************************
349 * [29] This function removes a directory file whose name is given by <pathname>.
350 * The directory must not have any entries other than `.' and `..'.
351 ******************************************************************************************
352 * @ pathname   : pathname (can be relative or absolute).
353 * @ return 0 if success / returns -1 if failure.
354 *****************************************************************************************/
355int sys_rmdir( char * pathname ); 
356
357/******************************************************************************************
358 * [30] This function implement the operations related to User Thread Local Storage.
359 * It is actually implemented as an uint32_t variable in the thread descriptor.
360 ******************************************************************************************
361 * @ operation  : UTLS operation type as defined below.
362 * @ value      : argument value for the UTLS_SET operation.
363 * @ return value for the UTLS_GET and UTLS_GET_ERRNO / return -1 if failure.
364 *****************************************************************************************/
365int sys_utls( uint32_t operation,
366              uint32_t value );
367
368/******************************************************************************************
369 * [31] This function change the acces rights for the file/dir identified by the
370 * pathname argument.
371 ******************************************************************************************
372 * @ pathname   : pathname (can be relative or absolute).
373 * @ rights     : acces rights.
374 * @ return 0 if success / returns -1 if failure.
375 *****************************************************************************************/
376int sys_chmod( char     * pathname,
377               uint32_t   rights );
378
379/******************************************************************************************
380 * [32] This function associate a specific signal handler to a given signal type.
381 * Tee handlers for the SIGKILL and SIGSTOP signals cannot be redefined.
382 ******************************************************************************************
383 * @ sig_id    : index defining signal type (from 1 to 31).
384 * @ handler   : pointer on fonction implementing the specific handler.
385 * @ return 0 if success / returns -1 if failure.
386 *****************************************************************************************/
387int sys_signal( uint32_t   sig_id,
388                void     * handler );
389
390/******************************************************************************************
391 * [33] This function returns in the structure <tv>, defined in the time.h file,
392 * the current time (in seconds & micro-seconds).
393 * It is computed from the calling core descriptor.
394 * The timezone is not supported.
395 ******************************************************************************************
396 * @ tv      : pointer on the timeval structure.
397 * @ tz      : pointer on the timezone structure : must be NULL.       
398 * @ return 0 if success / returns -1 if failure.
399 *****************************************************************************************/
400int sys_timeofday( struct timeval  * tv,
401                   struct timezone * tz );
402
403/******************************************************************************************
404 * [34] This function implements the "kill" system call.
405 * It register the signal defined by the <sig_id> argument in all thread descriptors
406 * of a target process identified by the <pid> argument. This is done in all clusters
407 * containing threads for the target process.
408 * It can be executed by any thread running in any cluster, as this function uses
409 * remote access to traverse the list of process copies stored in the owner cluster,
410 * and the RPC_SIGNAL_RISE to signal the remote threads.
411 ******************************************************************************************
412 * @ pid      : target process identifier.
413 * @ sig_id   : index defining the signal type (from 1 to 31).
414 * @ return 0 if success / returns -1 if failure.
415 *****************************************************************************************/
416int sys_kill( pid_t    pid,
417              uint32_t sig_id );
418
419/******************************************************************************************
420 * [35] This function implements the "getpid" system call.
421 ******************************************************************************************
422 * @ returns the process PID for the calling thread.
423 *****************************************************************************************/
424int sys_getpid();
425
426/******************************************************************************************
427 * [36] This function implement the "fork" system call.
428 * The calling process descriptor (parent process), and the associated thread descriptor are
429 * replicated in the same cluster as the calling thread, but the new process (child process)
430 * is registered in another target cluster, that is the new process owner.
431 * The child process and the associated main thread will be migrated to the target cluster
432 * later, when the child process makes an "exec" or any other system call... TODO [AG]
433 * The target cluster depends on the "fork_user" flag and "fork_cxy" variable that can be
434 * stored in the calling thread descriptor by the specific fork_place() system call.
435 * If not, the sys_fork() function makes a query to the DQDT to select the target cluster.
436 ******************************************************************************************
437 * @ if success, returns child process PID to parent, and return O to child.
438 * @ if failure, returns -1 to parent / no child process is created.
439 *****************************************************************************************/
440int sys_fork();
441
442/******************************************************************************************
443 * [37] This function implement the "exec" system call, that creates a new process
444 * descriptor.
445 * It is executed in the client cluster, but the new process descriptor and the main
446 * thread are created in a server cluster, that is generally another cluster.
447 * - if the server_cluster is the client cluster, it calls directly the process_make_exec()
448 *   function to create a new process, and launch a new thread in local cluster.
449 * - if the target_cluster is remote, it calls the rpc_process_exec_client() to execute
450 *   process_signedmake_exec() on the remote cluster.
451 * In both case this function build an exec_info_t structure containing all informations
452 * required to build the new process descriptor and the associated thread.
453 * Finally, the calling process and thread are deleted.
454 ******************************************************************************************
455 * @ filename : string pointer on .elf filename (pointer in user space)
456 * @ argv     : array of strings on process arguments (pointers in user space)
457 * @ envp     : array of strings on environment variables (pointers in user space)
458 * @ returns O if success / returns -1 if failure.
459 *****************************************************************************************/
460int sys_exec( char  * filename,
461              char ** argv,
462              char ** envp );
463
464/******************************************************************************************
465 * [38] This function  returns in the <stat> structure, defined in the "shared_syscalls.h"
466 * file, various informations on the file/directory identified by the <pathname> argument.
467 ******************************************************************************************
468 * @ pathname  : user pointer on file pathname.
469 * @ stat      : user pointer on the stat structure.
470 * @ returns O if success / returns -1 if failure.
471 *****************************************************************************************/
472int sys_stat( const char  * pathname,
473              struct stat * stat );
474
475/******************************************************************************************
476 * [39] This non-standard function is used to activate / desactivate the trace for a thread
477 * identified by the <trdid> and <pid> arguments.
478 * It can be called by any other thread in the same process.
479 ******************************************************************************************
480 * @ operation  : operation type as defined below.
481 * @ pid        : process identifier.
482 * @ trdid      : thread identifier.
483 * @ returns O if success / returns -1 if failure.
484 *****************************************************************************************/
485int sys_trace( uint32_t operation,
486               pid_t    pid, 
487               uint32_t trdid );
488
489/******************************************************************************************
490 * [40] This function returns the hardware platform parameters.
491 ******************************************************************************************
492 * @ x_size   : [out] number of clusters in a row.
493 * @ y_size   : [out] number of clusters in a column.
494 * @ ncores   : [out] number of cores per cluster.
495 * @ return 0 if success / return -1 if illegal arguments
496 *****************************************************************************************/
497int sys_get_config( uint32_t * x_size,
498                    uint32_t * y_size,
499                    uint32_t * ncores );
500
501/******************************************************************************************
502 * [41] This function returns the calling core cluster and local index.
503 ******************************************************************************************
504 * @ cxy      : [out] cluster identifier (fixed format)
505 * @ lid      : [out] core local index in cluster.
506 * @ return 0 if success / return -1 if illegal arguments
507 *****************************************************************************************/
508int sys_get_core( uint32_t * cxy,
509                  uint32_t * lid );
510
511/******************************************************************************************
512 * [42] This function returns in a 64 bits user buffer the calling core cycles count.
513 * It uses both the hardware register and the core descriptor cycles count to take
514 * into account a possible harware register overflow  in 32 bits architectures.
515 ******************************************************************************************
516 * cycle    : [out] address of buffer in user space.
517 * @ return 0 if success / return -1 if illegal arguments
518 *****************************************************************************************/
519int sys_get_cycle( uint64_t * cycle );
520
521/******************************************************************************************
522 * [43] This debug function displays on the kernel terminal the current state of a
523 * scheduler identified by the <cxy> and <lid> arguments.
524 ******************************************************************************************
525 * cxy      : [in] target cluster identifier.
526 * lid      : [in] target core local index.
527 * @ return 0 if success / return -1 if illegal arguments
528 *****************************************************************************************/
529int sys_get_sched( uint32_t  cxy,
530                   uint32_t  lid );
531
532/******************************************************************************************
533 * [44] This debug function requires the kernel to display on the kernel terminal a message
534 * containing the thread / process / core identifiers, and the cause of panic,
535 * as defined by the <string> argument.
536 ******************************************************************************************
537 * string   : [in] message to be displayed.
538 * @ return always 0.
539 *****************************************************************************************/
540int sys_panic( char * string );
541
542/******************************************************************************************
543 * [45] This function block the calling thread on the THREAD_BLOCKED_GLOBAL condition,
544 * and deschedule.
545 ******************************************************************************************
546 * @ return 0 if success / returns -1 if failure.
547 *****************************************************************************************/
548int sys_thread_sleep();
549
550/******************************************************************************************
551 * [46] This function unblock the thread identified by its <trdid> from the
552 * THREAD_BLOCKED_GLOBAL condition.
553 ******************************************************************************************
554 * @ trdid  : target thread identifier.
555 * @ return 0 if success / return -1 if failure.
556 *****************************************************************************************/
557int sys_thread_wakeup();
558
559
560#endif  // _SYSCALLS_H_
Note: See TracBrowser for help on using the repository browser.