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