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