source: trunk/kernel/kern/rpc.h @ 612

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

Fix several bugs in vfs.c, fatfs.c, and devfs.c to support
the <.> and <..> directory entries.

File size: 35.5 KB
Line 
1/*
2 * rpc.h - RPC (Remote Procedure Call) operations definition.
3 *
4 * Author  Alain Greiner (2016,2017,2018)
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 _RPC_H_
25#define _RPC_H_
26
27#include <kernel_config.h>
28#include <hal_kernel_types.h>
29#include <hal_atomic.h>
30#include <bits.h>
31#include <vseg.h>
32#include <remote_fifo.h>
33
34/**** Forward declarations ****/
35
36struct process_s;
37struct page_s;
38struct vseg_s;
39struct exec_info_s;
40struct pthread_attr_s;
41struct remote_sem_s;
42struct user_dir_s;
43struct fragment_s;
44struct vfs_inode_s;
45struct vfs_dentry_s;
46struct vfs_file_s;
47struct thread_s;
48struct mapper_s;
49
50
51/**********************************************************************************/
52/**************  structures for Remote Procedure Calls ****************************/
53/**********************************************************************************/
54
55/***********************************************************************************
56 * This enum defines all RPC indexes.
57 * It must be consistent with the rpc_server[] arrays defined in in the rpc.c file.
58 **********************************************************************************/
59
60typedef enum
61{
62    RPC_PMEM_GET_PAGES            = 0,
63    RPC_PMEM_RELEASE_PAGES        = 1,
64    RPC_UNDEFINED_2               = 2,     
65    RPC_PROCESS_MAKE_FORK         = 3,
66    RPC_USER_DIR_CREATE           = 4,
67    RPC_USER_DIR_DESTROY          = 5,
68    RPC_THREAD_USER_CREATE        = 6,
69    RPC_THREAD_KERNEL_CREATE      = 7,
70    RPC_UNDEFINED_8               = 8,
71    RPC_PROCESS_SIGACTION         = 9,       // non blocking
72
73    RPC_VFS_INODE_CREATE          = 10,
74    RPC_VFS_INODE_DESTROY         = 11,
75    RPC_VFS_DENTRY_CREATE         = 12,
76    RPC_VFS_DENTRY_DESTROY        = 13,
77    RPC_VFS_FILE_CREATE           = 14,
78    RPC_VFS_FILE_DESTROY          = 15,
79    RPC_VFS_FS_GET_DENTRY         = 16,
80    RPC_VFS_FS_ADD_DENTRY         = 17,
81    RPC_VFS_FS_REMOVE_DENTRY      = 18,
82    RPC_VFS_INODE_LOAD_ALL_PAGES  = 19,
83
84    RPC_VMM_GET_VSEG              = 20,
85    RPC_VMM_GLOBAL_UPDATE_PTE     = 21,
86    RPC_KCM_ALLOC                 = 22,
87    RPC_KCM_FREE                  = 23,
88    RPC_UNDEFINED_24              = 24,
89    RPC_MAPPER_HANDLE_MISS        = 25,
90    RPC_VMM_DELETE_VSEG           = 26,      // non blocking
91    RPC_VMM_CREATE_VSEG           = 27,
92    RPC_VMM_SET_COW               = 28,
93    RPC_VMM_DISPLAY               = 29,
94
95    RPC_MAX_INDEX                 = 30,
96}
97rpc_index_t;
98
99/***********************************************************************************
100 * This defines the prototype of the rpc_server functions,
101 * defined by the rpc_server[] array in the rpc.c file.
102 **********************************************************************************/
103
104typedef  void (rpc_server_t) ( xptr_t xp );
105
106/***********************************************************************************
107 *  This structure defines the RPC descriptor
108 **********************************************************************************/
109
110typedef struct rpc_desc_s
111{
112        rpc_index_t         index;       /*! index of requested RPC service           */
113        volatile uint32_t   responses;   /*! number of expected responses             */
114    struct thread_s   * thread;      /*! local pointer on client thread           */
115    uint32_t            lid;         /*! index of core running the calling thread */ 
116    bool_t              blocking;    /*! blocking RPC when true                   */
117    uint64_t            args[10];    /*! input/output arguments buffer            */
118} 
119rpc_desc_t;
120
121/**********************************************************************************/
122/******* Generic functions supporting RPCs : client side **************************/
123/**********************************************************************************/
124
125/***********************************************************************************
126 * This function is executed by the client thread in the client cluster.
127 * It puts one RPC descriptor defined by the <desc> argument in the remote fifo
128 * defined by the <cxy> argument.  It sends an IPI to the server if fifo is empty.
129 * The RPC descriptor must be allocated in the caller's stack, and initialised by
130 * the caller. It exit with a Panic message if remote fifo is still full after
131 * (CONFIG_RPC_PUT_MAX_ITERATIONS) retries.
132 * - When the RPC <blocking> field is true, this function blocks and deschedule.
133 *   It returns only when the server acknowledges the RPC by writing in the RPC
134 *   "response" field, and unblocks the client.
135 * - When the <blocking> field is false, this function returns as soon as the RPC
136 *   has been registered in the FIFO, and the server thread must directly signal
137 *   completion to the client thread.
138 ***********************************************************************************
139 * @ cxy   : server cluster identifier
140 * @ desc  : local pointer on RPC descriptor in client cluster
141 **********************************************************************************/
142void rpc_send( cxy_t        cxy,   
143               rpc_desc_t * desc );
144
145
146
147/**********************************************************************************/
148/******* Generic functions supporting RPCs : server side **************************/
149/**********************************************************************************/
150
151/***********************************************************************************
152 * This function contains the infinite loop executed by a RPC server thread,
153 * to handle pending RPCs registered in the RPC fifo attached to a given core.
154 * In each iteration in this loop, it try to handle one RPC request:
155 * - it tries to take the RPC FIFO ownership,
156 * - it consumes one request when the FIFO is not empty,
157 * - it releases the FIFO ownership,
158 * - it execute the requested service,
159 * - it unblock and send an IPI to the client thread,
160 * - it suicides if the number of RPC threads for this core is to large,
161 * - it block on IDLE and deschedule otherwise. 
162 **********************************************************************************/
163void rpc_thread_func( void );
164
165/***********************************************************************************
166 * This function is executed in case of illegal RPC index.
167 **********************************************************************************/
168void __attribute__((noinline)) rpc_undefined( xptr_t xp __attribute__ ((unused)) );
169
170
171
172/**********************************************************************************/
173/******* Marshalling functions attached to the various RPCs ***********************/
174/**********************************************************************************/
175
176/***********************************************************************************
177 * [0] The RPC_PMEM_GET_PAGES allocates one or several pages in a remote cluster,
178 * and returns the local pointer on the page descriptor.
179 ***********************************************************************************
180 * @ cxy     : server cluster identifier
181 * @ order   : [in]  ln2( number of requested pages )
182 * @ page    : [out] local pointer on page descriptor / NULL if failure
183 **********************************************************************************/
184void rpc_pmem_get_pages_client( cxy_t             cxy,
185                                uint32_t          order,
186                                struct page_s  ** page );
187
188void rpc_pmem_get_pages_server( xptr_t xp );
189
190/***********************************************************************************
191 * [1] The RPC_PMEM_RELEASE_PAGES release one or several pages to a remote cluster.
192 ***********************************************************************************
193 * @ cxy     : server cluster identifier
194 * @ page    : [in] local pointer on page descriptor to release.
195 **********************************************************************************/
196void rpc_pmem_release_pages_client( cxy_t            cxy,
197                                    struct page_s  * page );
198
199void rpc_pmem_release_pages_server( xptr_t xp );
200
201/***********************************************************************************
202 * [2] undefined slot
203 **********************************************************************************/
204
205/***********************************************************************************
206 * [3] The RPC_PROCESS_MAKE_FORK creates a "child" process descriptor, and the
207 * associated "child" thread descriptor in a target remote cluster that can be
208 * any cluster.  The child process is initialized from informations found in the
209 * "parent" process descriptor (that must be the parent reference cluster),
210 * and from the "parent" thread descriptor that can be in any cluster.
211 ***********************************************************************************
212 * @ cxy              : server cluster identifier.
213 * @ ref_process_xp   : [in]  extended pointer on reference parent process.
214 * @ parent_thread_xp : [in]  extended pointer on parent thread.
215 * @ child_pid        : [out] child process identifier.
216 * @ child_thread_ptr : [out] local pointer on child thread.
217 * @ error            : [out]  error status (0 if success).
218 **********************************************************************************/
219void rpc_process_make_fork_client( cxy_t              cxy,
220                                   xptr_t             ref_process_xp,
221                                   xptr_t             parent_thread_xp,
222                                   pid_t            * child_pid,
223                                   struct thread_s ** child_thread_ptr,
224                                   error_t          * error );
225
226void rpc_process_make_fork_server( xptr_t xp );
227
228/***********************************************************************************
229 * [4] The RPC_USER_DIR_CREATE allows a client thread to create an user_dir_t
230 * structure and the associated array of dirents in a remote cluster containing
231 * the target directory inode. It is called by the sys_opendir() function.
232 ***********************************************************************************
233 * @ cxy        : server cluster identifier.
234 * @ inode      : [in]   local pointer on inode in server cluster.
235 * @ dir        : [out]  local pointer on created user_dir structure.
236 **********************************************************************************/
237void rpc_user_dir_create_client( cxy_t                 cxy,
238                                 struct vfs_inode_s  * inode,
239                                 struct user_dir_s  ** dir );
240
241void rpc_user_dir_create_server( xptr_t xp );
242
243/***********************************************************************************
244 * [5] The RPC_USER_DIR_DESTROY allows a client thread to delete an user_dir_t
245 * structure and the associated array of dirents in a remote cluster containing
246 * the target directory inode. It is called by the sys_closedir() function.
247 ***********************************************************************************
248 * @ cxy        : server cluster identifier.
249 * @ dir        : [in]  local pointer on created user_dir structure.
250 **********************************************************************************/
251void rpc_user_dir_destroy_client( cxy_t               cxy,
252                                  struct user_dir_s * dir );
253
254void rpc_user_dir_destroy_server( xptr_t xp );
255
256/***********************************************************************************
257 * [6] The RPC_THREAD_USER_CREATE creates an user thread in the server cluster,
258 * as specified by the arguments. It returns an extended pointer on the new
259 * thread descriptor in server cluster, and an error code.
260 * It is called by the sys_thread_create() system call.
261 ***********************************************************************************
262 * @ cxy       : server cluster identifier.
263 * @ attr      : [in]  local pointer on pthread_attr_t in client cluster.
264 * @ thread_xp : [out] buffer for thread extended pointer.
265 * @ error     : [out] error status (0 if success).
266 **********************************************************************************/
267void rpc_thread_user_create_client( cxy_t                   cxy,
268                                    pid_t                   pid,
269                                    void                  * start_func,
270                                    void                  * start_arg,
271                                    pthread_attr_t        * attr,
272                                    xptr_t                * thread_xp,
273                                    error_t               * error );
274
275void rpc_thread_user_create_server( xptr_t xp );
276
277/***********************************************************************************
278 * [7] The RPC_THREAD_KERNEL_CREATE creates a kernel thread in the server cluster,
279 * as specified by the type, func and args arguments. It returns the local pointer
280 * on the thread descriptor in server cluster and an error code.
281 * It is used by the dev_init() function to create the device server thread.
282 ***********************************************************************************
283 * @ cxy       : server cluster identifier.
284 * @ type      : [in]  type of kernel thread.
285 * @ func      : [in]  local pointer on thread function.
286 * @ args      : [in]  local pointer on function arguments.
287 * @ thread_xp : [out] pointer on buffer for thread extended pointer.
288 * @ error     : [out] error status (0 if success).
289 **********************************************************************************/
290void rpc_thread_kernel_create_client( cxy_t     cxy,
291                                      uint32_t  type,
292                                      void    * func,
293                                      void    * args,
294                                      xptr_t  * thread_xp,
295                                      error_t * error );
296
297void rpc_thread_kernel_create_server( xptr_t xp );
298
299/***********************************************************************************
300 * [8] undefined slot
301 **********************************************************************************/
302
303/***********************************************************************************
304 * [9] The non blocking RPC_PROCESS_SIGACTION allows any client thread running in
305 * any cluster to send parallel RPC requests to one or several servers (that can be
306 * local or remote), to execute a given sigaction, defined by the <action_type>
307 * argument[1], for a given process identified by the <pid> argument[0].
308 *
309 * WARNING : It is implemented as a NON BLOCKING RPC, that can be sent in parallel
310 * to several servers. The RPC descriptor, containing the <action_type> and <pid>
311 * arguments, as well as the RPC <index>, <blocked>, and <response> fields, must
312 * be allocated and initialised by the calling function itself.
313 * Each RPC server thread atomically decrements the <response> field in this
314 * shared RPC descriptor. The last server thread unblock the client thread,
315 * that blocked only after sending all parallel RPC requests to all servers.
316 ***********************************************************************************
317 * @ cxy     : server cluster identifier.
318 * @ rpc     : pointer on shared RPC descriptor initialized by the client thread.
319 **********************************************************************************/
320void rpc_process_sigaction_client( cxy_t               cxy,
321                                   struct rpc_desc_s * rpc );
322                             
323void rpc_process_sigaction_server( xptr_t xp );
324
325/***********************************************************************************
326 * [10] The RPC_VFS_INODE_CREATE creates an inode and the associated mapper in a
327 * remote cluster. The parent dentry must have been previously created.
328 * It returns an extended pointer on the created inode.
329 ***********************************************************************************
330 * @ cxy        :  server cluster identifier.
331 * @ fs_type    : [in]  file system type.
332 * @ inode_type : [in]  file system type.
333 * @ attr       : [in]  inode attributes.
334 * @ rights     : [in]  access rights
335 * @ uid        : [in]  user ID
336 * @ gid        : [in]  group ID
337 * @ inode_xp   : [out] buffer for extended pointer on created inode.
338 * @ error      : [out] error status (0 if success).
339 **********************************************************************************/
340void rpc_vfs_inode_create_client( cxy_t      cxy,
341                                  uint32_t   fs_type,
342                                  uint32_t   inode_type,
343                                  uint32_t   attr,   
344                                  uint32_t   rights, 
345                                  uint32_t   uid,
346                                  uint32_t   gid,
347                                  xptr_t   * inode_xp,
348                                  error_t  * error );
349
350void rpc_vfs_inode_create_server( xptr_t xp );
351
352/***********************************************************************************
353 * [11] The RPC_VFS_INODE_DESTROY releases memory allocated for an inode descriptor
354 * and for the associated mapper in a remote cluster.
355 ***********************************************************************************
356 * @ cxy       :  server cluster identifier
357 * @ inode     : [in]  local pointer on inode.
358 **********************************************************************************/
359void rpc_vfs_inode_destroy_client( cxy_t                cxy,
360                                   struct vfs_inode_s * inode );
361
362void rpc_vfs_inode_destroy_server( xptr_t xp );
363
364/***********************************************************************************
365 * [12] The RPC_VFS_DENTRY_CREATE creates a dentry in a remote cluster.
366 * It returns an extended pointer on the created dentry.
367 ***********************************************************************************
368 * @ cxy        :  server cluster identifier
369 * @ type       : [in]  file system type.
370 * @ name       : [in]  directory entry name.
371 * @ dentry_xp  : [out] buffer for extended pointer on created dentry.
372 * @ error      : [out] error status (0 if success).
373 **********************************************************************************/
374void rpc_vfs_dentry_create_client( cxy_t                  cxy,
375                                   uint32_t               type,
376                                   char                 * name,   
377                                   xptr_t               * dentry_xp,
378                                   error_t              * error );
379
380void rpc_vfs_dentry_create_server( xptr_t xp );
381
382/***********************************************************************************
383 * [13] The RPC_VFS_DENTRY_DESTROY remove a denfry from the parent inode XHTAB,
384 * and releases memory allocated for the dentry descriptor in a remote cluster.
385 ***********************************************************************************
386 * @ cxy       :  server cluster identifier
387 * @ dentry     : [in]  local pointer on dentry.
388 **********************************************************************************/
389void rpc_vfs_dentry_destroy_client( cxy_t                 cxy,
390                                    struct vfs_dentry_s * dentry );
391
392void rpc_vfs_dentry_destroy_server( xptr_t xp );
393
394/***********************************************************************************
395 * [14] The RPC_VFS_FILE_CREATE creates a file descriptor in a remote cluster.
396 * It returns an extended pointer on the created file structure.
397 ***********************************************************************************
398 * @ cxy        :  server cluster identifier
399 * @ inode      : [in]  local pointer on parent inode.
400 * @ file_attr  : [in]  new file attributes.
401 * @ file_xp    : [out] buffer for extended pointer on created file.
402 * @ error      : [out] error status (0 if success).
403 **********************************************************************************/
404void rpc_vfs_file_create_client( cxy_t                  cxy,
405                                 struct vfs_inode_s   * inode,
406                                 uint32_t               file_attr,
407                                 xptr_t               * file_xp,
408                                 error_t              * error );
409
410void rpc_vfs_file_create_server( xptr_t xp );
411
412/***********************************************************************************
413 * [15] The RPC_VFS_FILE_DESTROY releases memory allocated for a file descriptor
414 * in a remote cluster.
415 ***********************************************************************************
416 * @ cxy       :  server cluster identifier
417 * @ file       : [in]  local pointer on file.
418 **********************************************************************************/
419void rpc_vfs_file_destroy_client( cxy_t               cxy,
420                                  struct vfs_file_s * file );
421
422void rpc_vfs_file_destroy_server( xptr_t xp );
423
424/***********************************************************************************
425 * [16] The RPC_VFS_FS_GET_DENTRY calls the vfs_fs_get_dentry()
426 * function in a remote cluster containing a parent inode directory to scan the
427 * associated mapper, find a directory entry identified by its name, and update
428 * both the - existing - child inode and dentry.
429 ***********************************************************************************
430 * @ cxy            : server cluster identifier
431 * @ parent_inode   : [in]  local pointer on parent inode.
432 * @ name           : [in]  local pointer on child name (in client cluster).
433 * @ child_inode_xp : [in]  extended pointer on child inode (in another cluster).
434 * @ error          : [out] error status (0 if success).
435 **********************************************************************************/
436void rpc_vfs_fs_get_dentry_client( cxy_t                cxy,
437                                   struct vfs_inode_s * parent_inode,
438                                   char               * name,
439                                   xptr_t               child_inode_xp,
440                                   error_t            * error );
441
442void rpc_vfs_fs_get_dentry_server( xptr_t xp );
443
444/***********************************************************************************
445 * [17] The RPC_VFS_FS_ADD_DENTRY calls the vfs_fs_add_dentry() function in a
446 * remote cluster containing a directory inode and mapper, to add a new dentry
447 * in the mapper of this directory.
448 ***********************************************************************************
449 * @ cxy            : server cluster identifier
450 * @ parent         : [in]  local pointer on directory inode.
451 * @ dentry         : [in]  local pointer on dentry.
452 * @ error          : [out] error status (0 if success).
453 **********************************************************************************/
454void rpc_vfs_fs_add_dentry_client( cxy_t,
455                                   struct vfs_inode_s  * parent,
456                                   struct vfs_dentry_s * dentry,
457                                   error_t             * error );
458
459void rpc_vfs_fs_add_dentry_server( xptr_t xp );
460
461/***********************************************************************************
462 * [18] The RPC_VFS_FS_REMOVE_DENTRY calls the vfs_fs_remove_dentry() function in a
463 * remote cluster containing a directory inode and mapper, to remove a dentry from
464 * the mapper of this directory.
465 ***********************************************************************************
466 * @ cxy            : server cluster identifier
467 * @ parent         : [in]  local pointer on directory inode.
468 * @ dentry         : [in]  local pointer on dentry.
469 * @ error          : [out] error status (0 if success).
470 **********************************************************************************/
471void rpc_vfs_fs_remove_dentry_client( cxy_t,
472                                      struct vfs_inode_s  * parent,
473                                      struct vfs_dentry_s * dentry,
474                                      error_t             * error );
475
476void rpc_vfs_fs_remove_dentry_server( xptr_t xp );
477
478/***********************************************************************************
479 * [19] The RPC_VFS_INODE_LOAD_ALL_PAGES calls the vfs_inode_load_all_pages()
480 * function a remote cluster containing an inode to load all pages in the
481 * associated mapper. 
482 ***********************************************************************************
483 * @ cxy     : server cluster identifier
484 * @ inode   : [in]  local pointer on inode in server cluster.
485 * @ error   : [out] error status (0 if success).
486 **********************************************************************************/
487void rpc_vfs_inode_load_all_pages_client( cxy_t                cxy,
488                                          struct vfs_inode_s * inode,
489                                          error_t            * error );
490
491void rpc_vfs_inode_load_all_pages_server( xptr_t xp );
492
493/***********************************************************************************
494 * [20] The RPC_VMM_GET_VSEG returns an extended pointer
495 * on the vseg containing a given virtual address in a given process.
496 * The server cluster is supposed to be the reference cluster.
497 * It returns a non zero error value if no vseg has been founded.
498 ***********************************************************************************
499 * @ cxy     : server cluster identifier.
500 * @ process : [in]   pointer on process descriptor in server cluster.
501 * @ vaddr   : [in]   virtual address to be searched.
502 * @ vseg_xp : [out]  buffer for extended pointer on vseg in client cluster.
503 * @ error   : [out] local pointer on buffer for error code (in client cluster).
504 **********************************************************************************/
505void rpc_vmm_get_vseg_client( cxy_t              cxy,
506                              struct process_s * process,
507                              intptr_t           vaddr,
508                              xptr_t           * vseg_xp,
509                              error_t          * error );
510
511void rpc_vmm_get_vseg_server( xptr_t xp );
512
513/***********************************************************************************
514 * [21] The RPC_VMM_GLOBAL_UPDATE_PTE can be used by a thread that is not running
515 * in reference cluster, to ask the reference cluster to update a specific entry,
516 * identified by the <vpn> argument in all GPT copies of a process identified by
517 * the <process> argument, using the values defined by <attr> and <ppn> arguments.
518 * The server cluster is supposed to be the reference cluster.
519 * It does not return any error code as the called function vmm_global_update_pte()
520 * cannot fail.
521 ***********************************************************************************
522 * @ cxy     : server cluster identifier.
523 * @ process : [in]  pointer on process descriptor in server cluster.
524 * @ vpn     : [in]  virtual address to be searched.
525 * @ attr    : [in]  PTE attributes.
526 * @ ppn     : [it]  PTE PPN.
527 **********************************************************************************/
528void rpc_vmm_global_update_pte_client( cxy_t              cxy,
529                                       struct process_s * process,
530                                       vpn_t              vpn,
531                                       uint32_t           attr,
532                                       ppn_t              ppn );
533
534void rpc_vmm_global_update_pte_server( xptr_t xp );
535
536/***********************************************************************************
537 * [22] The RPC_KCM_ALLOC allocates memory from a given KCM in a remote cluster,
538 * and returns an extended pointer on the allocated object.
539  It returns XPTR_NULL if physical memory cannot be allocated.
540 ***********************************************************************************
541 * @ cxy       : server cluster identifier.
542 * @ kmem_type : [in]  KCM object type (as defined in kmem.h).
543 * @ buf_xp    : [out] buffer for extended pointer on allocated buffer.
544 **********************************************************************************/
545void rpc_kcm_alloc_client( cxy_t      cxy,
546                           uint32_t   kmem_type,
547                           xptr_t   * buf_xp ); 
548
549void rpc_kcm_alloc_server( xptr_t xp );
550
551/***********************************************************************************
552 * [23] The RPC_KCM_FREE releases memory allocated for a KCM object of a given type,
553 * in a remote cluster.
554 ***********************************************************************************
555 * @ cxy       : server cluster identifier.
556 * @ buf       : [in] local pointer on allocated buffer.
557 * @ kmem_type : [in]  KCM object type (as defined in kmem.h).
558 **********************************************************************************/
559void rpc_kcm_free_client( cxy_t     cxy,
560                          void    * buf,
561                          uint32_t  kmem_type );
562
563void rpc_kcm_free_server( xptr_t xp );
564
565/***********************************************************************************
566 * [24] undefined slot
567 **********************************************************************************/
568
569/***********************************************************************************
570 * [25] The RPC__MAPPER_HANDLE_MISS allows a client thread to request a remote
571 * mapper to load a missing page from the IOC device.
572 * On the server side, this RPC call the mapper_handle_miss() function and return
573 * an extended pointer on the allocated page descriptor and an error status.
574 ***********************************************************************************
575 * @ cxy         : server cluster identifier.
576 * @ mapper      : [in]  local pointer on mapper.
577 * @ page_id     : [in]  missing page index in mapper
578 * @ buffer      : [in]  user space pointer / kernel extended pointer
579 * @ page_xp     : [out] pointer on buffer for extended pointer on page descriptor.
580 * @ error       : [out] error status (0 if success).
581 **********************************************************************************/
582void rpc_mapper_handle_miss_client( cxy_t             cxy,
583                                    struct mapper_s * mapper,
584                                    uint32_t          page_id,
585                                    xptr_t          * page_xp,
586                                    error_t         * error );
587 
588void rpc_mapper_handle_miss_server( xptr_t xp );
589
590/***********************************************************************************
591 * [26] The non blocking RPC_VMM_DELETE_VSEG allows any client thread running in
592 * any cluster to send parallel RPC requests to one or several clusters (that can be
593 * local or remote), to delete from a given VMM, identified by the <pid> argument[0]
594 * a given vseg, identified by the <vaddr> argument[1].
595 *
596 * WARNING : It is implemented as a NON BLOCKING RPC, that can be sent in parallel
597 * to several servers. The RPC descriptor, containing the <pid> and <vaddr>
598 * arguments, as well as the RPC <index>, <blocked>, and <response> fields, must
599 * be allocated and initialised by the calling function itself.
600 * Each RPC server thread atomically decrements the the <response> field in this
601 * shared RPC descriptor. The last server thread unblock the client thread,
602 * that blocked only after sending all paralle RPC requests to all servers.
603 ***********************************************************************************
604 * @ cxy         : server cluster identifier.
605 * @ rpc     : pointer on shared RPC descriptor initialized by the client thread.
606 **********************************************************************************/
607void rpc_vmm_delete_vseg_client( cxy_t               cxy,
608                                 struct rpc_desc_s * rpc );
609 
610void rpc_vmm_delete_vseg_server( xptr_t xp );
611
612/***********************************************************************************
613 * [27] The RPC_VMM_CREATE_VSEG allows a client thread to request the remote
614 * reference cluster of a given process to allocate and register in the reference
615 * process VMM a new vseg descriptor.
616 * On the server side, this RPC uses the vmm_create_vseg() function, and returns
617 * to the client the local pointer on the created vseg descriptor.
618 ***********************************************************************************
619 * @ cxy         : server cluster identifier.
620 * @ process     : [in]  local pointer on process descriptor in server.
621 * @ type        : [in]  vseg type.
622 * @ base        : [in]  base address (unused for dynamically allocated vsegs).
623 * @ size        : [in]  number of bytes.
624 * @ file_offset : [in]  offset in file (for CODE, DATA, FILE types).
625 * @ file_size   : [in]  can be smaller than size for DATA type.
626 * @ mapper_xp   : [in]  extended pointer on mapper (for CODE, DATA, FILE types).
627 * @ vseg_cxy    : [in]  target cluster for mapping (if not data type).
628 * @ vseg        : [out] local pointer on vseg descriptor / NULL if failure.
629 **********************************************************************************/
630void rpc_vmm_create_vseg_client( cxy_t              cxy,
631                                 struct process_s * process,
632                                 vseg_type_t        type,
633                                 intptr_t           base,
634                                 uint32_t           size,
635                                 uint32_t           file_offset,
636                                 uint32_t           file_size,
637                                 xptr_t             mapper_xp,
638                                 cxy_t              vseg_cxy,
639                                 struct vseg_s   ** vseg );
640
641void rpc_vmm_create_vseg_server( xptr_t xp );
642
643/***********************************************************************************
644 * [28] The RPC_VMM_SET_COW allows a client thread to request the remote reference
645 * cluster to set the COW flag and reset the WRITABLE flag of all GPT entries for
646 * the DATA, MMAP and REMOTE vsegs of process identified by the <process> argument.
647
648 * of a remote scheduler, identified by the <lid> argument.
649 ***********************************************************************************
650 * @ cxy         : server cluster identifier.
651 * @ process     : [in]  local pointer on reference process descriptor.
652 **********************************************************************************/
653void rpc_vmm_set_cow_client( cxy_t              cxy,
654                             struct process_s * process );
655
656void rpc_vmm_set_cow_server( xptr_t xp );
657
658/***********************************************************************************
659 * [29] The RPC_VMM_DISPLAY allows any client thread to display the VMM state
660 * of a remote reference process identified by the <cxy> and <process> arguments.
661 * The type of display is defined by the <detailed> boolean argument.
662 ***********************************************************************************
663 * @ cxy         : server cluster identifier.
664 * @ process     : [in]  local pointer on reference process descriptor.
665 * @ detailed    : [in]  detailed display if true.
666 **********************************************************************************/
667void rpc_vmm_display_client( cxy_t              cxy,
668                             struct process_s * process,
669                             bool_t             detailed );
670
671void rpc_vmm_display_server( xptr_t xp );
672
673
674#endif
Note: See TracBrowser for help on using the repository browser.