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

Last change on this file since 435 was 435, checked in by alain, 4 years ago

Fix a bad bug in scheduler...

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