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

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

This version is a major evolution: The physical memory allocators,
defined in the kmem.c, ppm.c, and kcm.c files have been modified
to support remote accesses. The RPCs that were previously user
to allocate physical memory in a remote cluster have been removed.
This has been done to cure a dead-lock in case of concurrent page-faults.

This version 2.2 has been tested on a (4 clusters / 2 cores per cluster)
TSAR architecture, for both the "sort" and the "fft" applications.
File size: 36.9 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_UNDEFINED_0               = 0,   // RPC_PMEM_GET_PAGES       deprecated [AG]
63    RPC_UNDEFINED_1               = 1,   // RPC_PMEM_RELEASE_PAGES   deprecated [AG]
64    RPC_UNDEFINED_2               = 2,   // RPC_PMEM_DISPLAY         deprecated [AG]     
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_VFS_FS_UPDATE_DENTRY      = 8,
71    RPC_PROCESS_SIGACTION         = 9,
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_NEW_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_UNDEFINED_22              = 22,   // RPC_KCM_ALLOC           deprecated [AG]
87    RPC_UNDEFINED_23              = 23,   // RPC_KCM_FREE            deprecated [AG]
88    RPC_MAPPER_SYNC               = 24,
89    RPC_UNDEFUNED_25              = 25,   // RPC_MAPPER_HANDLE_MISS  deprecated [AG]
90    RPC_VMM_DELETE_VSEG           = 26,
91    RPC_VMM_CREATE_VSEG           = 27,
92    RPC_VMM_SET_COW               = 28,
93    RPC_UNDEFINED_29              = 29,   // RPC_VMM_DISPLAY         deprecated [AG]
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 (100 bytes on a 32bits core)
108 **********************************************************************************/
109
110typedef struct rpc_desc_s
111{
112        rpc_index_t         index;       /*! index of requested RPC service      ( 4) */
113        uint32_t          * rsp;         /*! local pointer ond responses counter ( 4) */
114    struct thread_s   * thread;      /*! local pointer on client thread      ( 4) */
115    uint32_t            lid;         /*! index of core running client thread ( 4) */ 
116    bool_t              blocking;    /*! simple RPC mode when true           ( 4) */
117    uint64_t            args[10];    /*! input/output arguments buffer       (80) */
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_server_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 *         deprecated [AG] may 2019
180 ***********************************************************************************
181 * @ cxy     : server cluster identifier
182 * @ order   : [in]  ln2( number of requested pages )
183 * @ page    : [out] local pointer on page descriptor / NULL if failure
184 **********************************************************************************/
185
186/*
187void rpc_pmem_get_pages_client( cxy_t             cxy,
188                                uint32_t          order,
189                                struct page_s  ** page );
190
191void rpc_pmem_get_pages_server( xptr_t xp );
192*/
193
194/***********************************************************************************
195 * [1] The RPC_PMEM_RELEASE_PAGES release one or several pages to a remote cluster.
196 *         deprecated [AG] may 2019
197 ***********************************************************************************
198 * @ cxy     : server cluster identifier
199 * @ page    : [in] local pointer on page descriptor to release.
200 **********************************************************************************/
201
202/*
203void rpc_pmem_release_pages_client( cxy_t            cxy,
204                                    struct page_s  * page );
205
206void rpc_pmem_release_pages_server( xptr_t xp );
207*/
208
209/***********************************************************************************
210 * [2] The RPC_PPM_DISPLAY allows any client thread to require any remote cluster
211 * identified by the <cxy> argumentto display the physical memory allocator state.
212 *         deprecated [AG] may 2019
213 **********************************************************************************/
214
215/*
216void rpc_ppm_display_client( cxy_t  cxy );
217
218void rpc_ppm_display_server( xptr_t xp );
219*/
220
221/***********************************************************************************
222 * [3] The RPC_PROCESS_MAKE_FORK creates a "child" process descriptor, and the
223 * associated "child" thread descriptor in a target remote cluster that can be
224 * any cluster.  The child process is initialized from informations found in the
225 * "parent" process descriptor (that must be the parent reference cluster),
226 * and from the "parent" thread descriptor that can be in any cluster.
227 ***********************************************************************************
228 * @ cxy              : server cluster identifier.
229 * @ ref_process_xp   : [in]  extended pointer on reference parent process.
230 * @ parent_thread_xp : [in]  extended pointer on parent thread.
231 * @ child_pid        : [out] child process identifier.
232 * @ child_thread_ptr : [out] local pointer on child thread.
233 * @ error            : [out]  error status (0 if success).
234 **********************************************************************************/
235void rpc_process_make_fork_client( cxy_t              cxy,
236                                   xptr_t             ref_process_xp,
237                                   xptr_t             parent_thread_xp,
238                                   pid_t            * child_pid,
239                                   struct thread_s ** child_thread_ptr,
240                                   error_t          * error );
241
242void rpc_process_make_fork_server( xptr_t xp );
243
244/***********************************************************************************
245 * [4] The RPC_USER_DIR_CREATE allows a client thread to create an user_dir_t
246 * structure and the associated array of dirents in a remote cluster containing
247 * the target directory <inode>. It creates an ANON vseg in the user reference
248 * process VMM identified by the <ref_xp>. This reference cluster cluster can be
249 * different from both the client and server clusters.
250 * It is called by the sys_opendir() function.
251 ***********************************************************************************
252 * @ cxy        : server cluster identifier.
253 * @ inode      : [in]   local pointer on inode in server cluster.
254 * @ ref_xp     : [in]   extended pointer on user reference process descriptor.
255 * @ dir        : [out]  local pointer on created user_dir structure.
256 **********************************************************************************/
257void rpc_user_dir_create_client( cxy_t                 cxy,
258                                 struct vfs_inode_s  * inode,
259                                 xptr_t                ref_xp,
260                                 struct user_dir_s  ** dir );
261
262void rpc_user_dir_create_server( xptr_t xp );
263
264/***********************************************************************************
265 * [5] The RPC_USER_DIR_DESTROY allows a client thread to delete an user_dir_t
266 * structure and the associated array of dirents in a remote cluster containing
267 * the target directory inode. It is called by the sys_closedir() function.
268 ***********************************************************************************
269 * @ cxy        : server cluster identifier.
270 * @ dir        : [in]  local pointer on created user_dir structure.
271 * @ ref_xp     : [in]   extended pointer on user reference process descriptor.
272 **********************************************************************************/
273void rpc_user_dir_destroy_client( cxy_t               cxy,
274                                  struct user_dir_s * dir,
275                                  xptr_t              ref_xp );
276
277void rpc_user_dir_destroy_server( xptr_t xp );
278
279/***********************************************************************************
280 * [6] The RPC_THREAD_USER_CREATE creates an user thread in the server cluster,
281 * as specified by the arguments. It returns an extended pointer on the new
282 * thread descriptor in server cluster, and an error code.
283 * It is called by the sys_thread_create() system call.
284 ***********************************************************************************
285 * @ cxy       : server cluster identifier.
286 * @ attr      : [in]  local pointer on pthread_attr_t in client cluster.
287 * @ thread_xp : [out] buffer for thread extended pointer.
288 * @ error     : [out] error status (0 if success).
289 **********************************************************************************/
290void rpc_thread_user_create_client( cxy_t                   cxy,
291                                    pid_t                   pid,
292                                    void                  * start_func,
293                                    void                  * start_arg,
294                                    pthread_attr_t        * attr,
295                                    xptr_t                * thread_xp,
296                                    error_t               * error );
297
298void rpc_thread_user_create_server( xptr_t xp );
299
300/***********************************************************************************
301 * [7] The RPC_THREAD_KERNEL_CREATE creates a kernel thread in the server cluster,
302 * as specified by the type, func and args arguments. It returns the local pointer
303 * on the thread descriptor in server cluster and an error code.
304 * It is used by the dev_init() function to create the device server thread.
305 ***********************************************************************************
306 * @ cxy       : server cluster identifier.
307 * @ type      : [in]  type of kernel thread.
308 * @ func      : [in]  local pointer on thread function.
309 * @ args      : [in]  local pointer on function arguments.
310 * @ thread_xp : [out] pointer on buffer for thread extended pointer.
311 * @ error     : [out] error status (0 if success).
312 **********************************************************************************/
313void rpc_thread_kernel_create_client( cxy_t     cxy,
314                                      uint32_t  type,
315                                      void    * func,
316                                      void    * args,
317                                      xptr_t  * thread_xp,
318                                      error_t * error );
319
320void rpc_thread_kernel_create_server( xptr_t xp );
321
322/***********************************************************************************
323 * [8] The RPC_VFS_FS_UPDATE_DENTRY allows a client thread to request a remote
324 * cluster to update the <size> field of a directory entry in the mapper of a
325 * remote directory inode, identified by the <inode> local pointer.
326 * The target entry name is identified by the <dentry> local pointer.
327 ***********************************************************************************
328 * @ cxy     : server cluster identifier.
329 * @ inode   : [in] local pointer on remote directory inode.
330 * @ dentry  : [in] local pointer on remote dentry.
331 * @ size    : [in] new size value.
332 * @ error   : [out] error status (0 if success).
333 **********************************************************************************/
334void rpc_vfs_fs_update_dentry_client( cxy_t                 cxy,
335                                      struct vfs_inode_s  * inode,
336                                      struct vfs_dentry_s * dentry,
337                                      uint32_t              size,
338                                      error_t             * error );
339
340void rpc_vfs_fs_update_dentry_server( xptr_t xp );
341
342/***********************************************************************************
343 * [9] The RPC_PROCESS_SIGACTION allows a client thread to request a remote cluster
344 * to execute a given sigaction, defined by the <action_type> for a given process,
345 * identified by the <pid> argument.
346 ***********************************************************************************
347 * @ cxy     : server cluster identifier.
348 * @ pid     : [in] target process identifier.
349 * @ action  : [in] sigaction index.
350 **********************************************************************************/
351void rpc_process_sigaction_client( cxy_t     cxy,
352                                   pid_t     pid,
353                                   uint32_t  action );
354                             
355void rpc_process_sigaction_server( xptr_t xp );
356
357/***********************************************************************************
358 * [10] The RPC_VFS_INODE_CREATE creates an inode and the associated mapper in a
359 * remote cluster. The parent dentry must have been previously created.
360 * It returns an extended pointer on the created inode.
361 ***********************************************************************************
362 * @ cxy        :  server cluster identifier.
363 * @ fs_type    : [in]  file system type.
364 * @ inode_type : [in]  file system type.
365 * @ attr       : [in]  inode attributes.
366 * @ rights     : [in]  access rights
367 * @ uid        : [in]  user ID
368 * @ gid        : [in]  group ID
369 * @ inode_xp   : [out] buffer for extended pointer on created inode.
370 * @ error      : [out] error status (0 if success).
371 **********************************************************************************/
372void rpc_vfs_inode_create_client( cxy_t      cxy,
373                                  uint32_t   fs_type,
374                                  uint32_t   attr,   
375                                  uint32_t   rights, 
376                                  uint32_t   uid,
377                                  uint32_t   gid,
378                                  xptr_t   * inode_xp,
379                                  error_t  * error );
380
381void rpc_vfs_inode_create_server( xptr_t xp );
382
383/***********************************************************************************
384 * [11] The RPC_VFS_INODE_DESTROY releases memory allocated for an inode descriptor
385 * and for the associated mapper in a remote cluster.
386 ***********************************************************************************
387 * @ cxy       :  server cluster identifier
388 * @ inode     : [in]  local pointer on inode.
389 **********************************************************************************/
390void rpc_vfs_inode_destroy_client( cxy_t                cxy,
391                                   struct vfs_inode_s * inode );
392
393void rpc_vfs_inode_destroy_server( xptr_t xp );
394
395/***********************************************************************************
396 * [12] The RPC_VFS_DENTRY_CREATE creates a dentry in a remote cluster.
397 * It returns an extended pointer on the created dentry.
398 ***********************************************************************************
399 * @ cxy        :  server cluster identifier
400 * @ type       : [in]  file system type.
401 * @ name       : [in]  directory entry name.
402 * @ dentry_xp  : [out] buffer for extended pointer on created dentry.
403 * @ error      : [out] error status (0 if success).
404 **********************************************************************************/
405void rpc_vfs_dentry_create_client( cxy_t                  cxy,
406                                   uint32_t               type,
407                                   char                 * name,   
408                                   xptr_t               * dentry_xp,
409                                   error_t              * error );
410
411void rpc_vfs_dentry_create_server( xptr_t xp );
412
413/***********************************************************************************
414 * [13] The RPC_VFS_DENTRY_DESTROY remove a denfry from the parent inode XHTAB,
415 * and releases memory allocated for the dentry descriptor in a remote cluster.
416 ***********************************************************************************
417 * @ cxy       :  server cluster identifier
418 * @ dentry     : [in]  local pointer on dentry.
419 **********************************************************************************/
420void rpc_vfs_dentry_destroy_client( cxy_t                 cxy,
421                                    struct vfs_dentry_s * dentry );
422
423void rpc_vfs_dentry_destroy_server( xptr_t xp );
424
425/***********************************************************************************
426 * [14] The RPC_VFS_FILE_CREATE creates a file descriptor in a remote cluster.
427 * It returns an extended pointer on the created file structure.
428 ***********************************************************************************
429 * @ cxy        :  server cluster identifier
430 * @ inode      : [in]  local pointer on parent inode.
431 * @ file_attr  : [in]  new file attributes.
432 * @ file_xp    : [out] buffer for extended pointer on created file.
433 * @ error      : [out] error status (0 if success).
434 **********************************************************************************/
435void rpc_vfs_file_create_client( cxy_t                  cxy,
436                                 struct vfs_inode_s   * inode,
437                                 uint32_t               file_attr,
438                                 xptr_t               * file_xp,
439                                 error_t              * error );
440
441void rpc_vfs_file_create_server( xptr_t xp );
442
443/***********************************************************************************
444 * [15] The RPC_VFS_FILE_DESTROY releases memory allocated for a file descriptor
445 * in a remote cluster.
446 ***********************************************************************************
447 * @ cxy       :  server cluster identifier
448 * @ file       : [in]  local pointer on file.
449 **********************************************************************************/
450void rpc_vfs_file_destroy_client( cxy_t               cxy,
451                                  struct vfs_file_s * file );
452
453void rpc_vfs_file_destroy_server( xptr_t xp );
454
455/***********************************************************************************
456 * [16] The RPC_VFS_FS_GET_DENTRY calls the vfs_fs_new_dentry()
457 * function in a remote cluster containing a parent inode directory to scan the
458 * associated mapper, find a directory entry identified by its name, and update
459 * both the - existing - child inode and dentry.
460 ***********************************************************************************
461 * @ cxy            : server cluster identifier
462 * @ parent_inode   : [in]  local pointer on parent inode.
463 * @ name           : [in]  local pointer on child name (in client cluster).
464 * @ child_inode_xp : [in]  extended pointer on child inode (in another cluster).
465 * @ error          : [out] error status (0 if success).
466 **********************************************************************************/
467void rpc_vfs_fs_new_dentry_client( cxy_t                cxy,
468                                   struct vfs_inode_s * parent_inode,
469                                   char               * name,
470                                   xptr_t               child_inode_xp,
471                                   error_t            * error );
472
473void rpc_vfs_fs_new_dentry_server( xptr_t xp );
474
475/***********************************************************************************
476 * [17] The RPC_VFS_FS_ADD_DENTRY calls the vfs_fs_add_dentry() function in a
477 * remote cluster containing a directory inode and mapper, to add a new dentry
478 * in the mapper of this directory.
479 ***********************************************************************************
480 * @ cxy            : server cluster identifier
481 * @ parent         : [in]  local pointer on directory inode.
482 * @ dentry         : [in]  local pointer on dentry.
483 * @ error          : [out] error status (0 if success).
484 **********************************************************************************/
485void rpc_vfs_fs_add_dentry_client( cxy_t,
486                                   struct vfs_inode_s  * parent,
487                                   struct vfs_dentry_s * dentry,
488                                   error_t             * error );
489
490void rpc_vfs_fs_add_dentry_server( xptr_t xp );
491
492/***********************************************************************************
493 * [18] The RPC_VFS_FS_REMOVE_DENTRY calls the vfs_fs_remove_dentry() function in a
494 * remote cluster containing a directory inode and mapper, to remove a dentry from
495 * the mapper of this directory.
496 ***********************************************************************************
497 * @ cxy            : server cluster identifier
498 * @ parent         : [in]  local pointer on directory inode.
499 * @ dentry         : [in]  local pointer on dentry.
500 * @ error          : [out] error status (0 if success).
501 **********************************************************************************/
502void rpc_vfs_fs_remove_dentry_client( cxy_t,
503                                      struct vfs_inode_s  * parent,
504                                      struct vfs_dentry_s * dentry,
505                                      error_t             * error );
506
507void rpc_vfs_fs_remove_dentry_server( xptr_t xp );
508
509/***********************************************************************************
510 * [19] The RPC_VFS_INODE_LOAD_ALL_PAGES calls the vfs_inode_load_all_pages()
511 * function a remote cluster containing an inode to load all pages in the
512 * associated mapper. 
513 ***********************************************************************************
514 * @ cxy     : server cluster identifier
515 * @ inode   : [in]  local pointer on inode in server cluster.
516 * @ error   : [out] error status (0 if success).
517 **********************************************************************************/
518void rpc_vfs_inode_load_all_pages_client( cxy_t                cxy,
519                                          struct vfs_inode_s * inode,
520                                          error_t            * error );
521
522void rpc_vfs_inode_load_all_pages_server( xptr_t xp );
523
524/***********************************************************************************
525 * [20] The RPC_VMM_GET_VSEG returns an extended pointer
526 * on the vseg containing a given virtual address in a given process.
527 * The server cluster is supposed to be the reference cluster.
528 * It returns a non zero error value if no vseg has been founded.
529 ***********************************************************************************
530 * @ cxy     : server cluster identifier.
531 * @ process : [in]   pointer on process descriptor in server cluster.
532 * @ vaddr   : [in]   virtual address to be searched.
533 * @ vseg_xp : [out]  buffer for extended pointer on vseg in client cluster.
534 * @ error   : [out] local pointer on buffer for error code (in client cluster).
535 **********************************************************************************/
536void rpc_vmm_get_vseg_client( cxy_t              cxy,
537                              struct process_s * process,
538                              intptr_t           vaddr,
539                              xptr_t           * vseg_xp,
540                              error_t          * error );
541
542void rpc_vmm_get_vseg_server( xptr_t xp );
543
544/***********************************************************************************
545 * [21] The RPC_VMM_GLOBAL_UPDATE_PTE can be used by a thread that is not running
546 * in reference cluster, to ask the reference cluster to update a specific entry,
547 * identified by the <vpn> argument in all GPT copies of a process identified by
548 * the <process> argument, using the values defined by <attr> and <ppn> arguments.
549 * The server cluster is supposed to be the reference cluster.
550 * It does not return any error code as the called function vmm_global_update_pte()
551 * cannot fail.
552 ***********************************************************************************
553 * @ cxy     : server cluster identifier.
554 * @ process : [in]  pointer on process descriptor in server cluster.
555 * @ vpn     : [in]  virtual address to be searched.
556 * @ attr    : [in]  PTE attributes.
557 * @ ppn     : [it]  PTE PPN.
558 **********************************************************************************/
559void rpc_vmm_global_update_pte_client( cxy_t              cxy,
560                                       struct process_s * process,
561                                       vpn_t              vpn,
562                                       uint32_t           attr,
563                                       ppn_t              ppn );
564
565void rpc_vmm_global_update_pte_server( xptr_t xp );
566
567/***********************************************************************************
568 * [22] The RPC_KCM_ALLOC allocates memory from a given KCM in a remote cluster,
569 * and returns an extended pointer on the allocated object.
570  It returns XPTR_NULL if physical memory cannot be allocated.
571 ***********************************************************************************
572 * @ cxy       : server cluster identifier.
573 * @ kmem_type : [in]  KCM object type (as defined in kmem.h).
574 * @ buf_xp    : [out] buffer for extended pointer on allocated buffer.
575 **********************************************************************************/
576
577/*
578void rpc_kcm_alloc_client( cxy_t      cxy,
579                           uint32_t   kmem_type,
580                           xptr_t   * buf_xp ); 
581
582void rpc_kcm_alloc_server( xptr_t xp );
583*/
584
585/***********************************************************************************
586 * [23] The RPC_KCM_FREE releases memory allocated for a KCM object of a given type,
587 * in a remote cluster.
588 ***********************************************************************************
589 * @ cxy       : server cluster identifier.
590 * @ buf       : [in] local pointer on allocated buffer.
591 * @ kmem_type : [in]  KCM object type (as defined in kmem.h).
592 **********************************************************************************/
593
594/*
595void rpc_kcm_free_client( cxy_t     cxy,
596                          void    * buf,
597                          uint32_t  kmem_type );
598
599void rpc_kcm_free_server( xptr_t xp );
600*/
601
602/***********************************************************************************
603 * [24] The RPC_MAPPER_SYNC allows a client thread to synchronize on disk
604 * all dirty pages of a remote mapper.
605 ***********************************************************************************
606 * @ cxy       : server cluster identifier.
607 * @ mapper    : [in] local pointer on mapper in server cluster.
608 * @ error       : [out] error status (0 if success).
609 **********************************************************************************/
610void rpc_mapper_sync_client( cxy_t             cxy,
611                             struct mapper_s * mapper,
612                             error_t         * error );
613
614void rpc_mapper_sync_server( xptr_t xp );
615
616/***********************************************************************************
617 * [25] The RPC__MAPPER_HANDLE_MISS allows a client thread to request a remote
618 * mapper to load a missing page from the IOC device.
619 * On the server side, this RPC call the mapper_handle_miss() function and return
620 * an extended pointer on the allocated page descriptor and an error status.
621 ***********************************************************************************
622 * @ cxy         : server cluster identifier.
623 * @ mapper      : [in]  local pointer on mapper.
624 * @ page_id     : [in]  missing page index in mapper
625 * @ buffer      : [in]  user space pointer / kernel extended pointer
626 * @ page_xp     : [out] pointer on buffer for extended pointer on page descriptor.
627 * @ error       : [out] error status (0 if success).
628 **********************************************************************************/
629/*
630void rpc_mapper_handle_miss_client( cxy_t             cxy,
631                                    struct mapper_s * mapper,
632                                    uint32_t          page_id,
633                                    xptr_t          * page_xp,
634                                    error_t         * error );
635 
636void rpc_mapper_handle_miss_server( xptr_t xp );
637*/
638/***********************************************************************************
639 * [26] The RPC_VMM_DELETE_VSEG allows any client thread  to request a remote
640 * cluster to delete from a given VMM, identified by the <pid> argument
641 * a given vseg, identified by the <vaddr> argument.
642 ***********************************************************************************
643 * @ cxy         : server cluster identifier.
644 * @ pid         : [in] target process identifier.
645 * @ vaddr       : [in] vseg base address.
646 **********************************************************************************/
647void rpc_vmm_delete_vseg_client( cxy_t       cxy,
648                                 pid_t       pid,
649                                 intptr_t    vaddr );
650 
651void rpc_vmm_delete_vseg_server( xptr_t xp );
652
653/***********************************************************************************
654 * [27] The RPC_VMM_CREATE_VSEG allows a client thread to request the remote
655 * reference cluster of a given process to allocate and register in the reference
656 * process VMM a new vseg descriptor.
657 * On the server side, this RPC uses the vmm_create_vseg() function, and returns
658 * to the client the local pointer on the created vseg descriptor.
659 ***********************************************************************************
660 * @ cxy         : server cluster identifier.
661 * @ process     : [in]  local pointer on process descriptor in server.
662 * @ type        : [in]  vseg type.
663 * @ base        : [in]  base address (unused for dynamically allocated vsegs).
664 * @ size        : [in]  number of bytes.
665 * @ file_offset : [in]  offset in file (for CODE, DATA, FILE types).
666 * @ file_size   : [in]  can be smaller than size for DATA type.
667 * @ mapper_xp   : [in]  extended pointer on mapper (for CODE, DATA, FILE types).
668 * @ vseg_cxy    : [in]  target cluster for mapping (if not data type).
669 * @ vseg        : [out] local pointer on vseg descriptor / NULL if failure.
670 **********************************************************************************/
671void rpc_vmm_create_vseg_client( cxy_t              cxy,
672                                 struct process_s * process,
673                                 vseg_type_t        type,
674                                 intptr_t           base,
675                                 uint32_t           size,
676                                 uint32_t           file_offset,
677                                 uint32_t           file_size,
678                                 xptr_t             mapper_xp,
679                                 cxy_t              vseg_cxy,
680                                 struct vseg_s   ** vseg );
681
682void rpc_vmm_create_vseg_server( xptr_t xp );
683
684/***********************************************************************************
685 * [28] The RPC_VMM_SET_COW allows a client thread to request the remote reference
686 * cluster to set the COW flag and reset the WRITABLE flag of all GPT entries for
687 * the DATA, MMAP and REMOTE vsegs of process identified by the <process> argument.
688
689 * of a remote scheduler, identified by the <lid> argument.
690 ***********************************************************************************
691 * @ cxy         : server cluster identifier.
692 * @ process     : [in]  local pointer on reference process descriptor.
693 **********************************************************************************/
694void rpc_vmm_set_cow_client( cxy_t              cxy,
695                             struct process_s * process );
696
697void rpc_vmm_set_cow_server( xptr_t xp );
698
699/***********************************************************************************
700 * [29] The RPC_VMM_DISPLAY allows any client thread to display the VMM state
701 * of a remote reference process identified by the <cxy> and <process> arguments.
702 * The type of display is defined by the <detailed> boolean argument.
703 ***********************************************************************************
704 * @ cxy         : server cluster identifier.
705 * @ process     : [in]  local pointer on reference process descriptor.
706 * @ detailed    : [in]  detailed display if true.
707 **********************************************************************************/
708
709/*
710void rpc_hal_vmm_display_client( cxy_t              cxy,
711                             struct process_s * process,
712                             bool_t             detailed );
713
714void rpc_hal_vmm_display_server( xptr_t xp );
715*/
716
717#endif
Note: See TracBrowser for help on using the repository browser.