puffs_msgif.h revision 1.64
1 /* $NetBSD: puffs_msgif.h,v 1.64 2007/12/08 19:57:03 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2005, 2006, 2007 Antti Kantee. All Rights Reserved. 5 * 6 * Development of this software was supported by the 7 * Google Summer of Code program and the Ulla Tuominen Foundation. 8 * The Google SoC project was mentored by Bill Studenmund. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #ifndef _FS_PUFFS_PUFFS_MSGIF_H_ 33 #define _FS_PUFFS_PUFFS_MSGIF_H_ 34 35 #include <sys/param.h> 36 #include <sys/time.h> 37 #include <sys/ioccom.h> 38 #include <sys/uio.h> 39 #include <sys/vnode.h> 40 #include <sys/ucred.h> 41 #include <sys/statvfs.h> 42 #include <sys/dirent.h> 43 #include <sys/fcntl.h> 44 45 #include <dev/putter/putter.h> 46 47 #include <uvm/uvm_prot.h> 48 49 #define PUFFSOP_VFS 0x01 /* kernel-> */ 50 #define PUFFSOP_VN 0x02 /* kernel-> */ 51 #define PUFFSOP_CACHE 0x03 /* only kernel-> */ 52 #define PUFFSOP_ERROR 0x04 /* only kernel-> */ 53 #define PUFFSOP_FLUSH 0x05 /* ->kernel */ 54 #define PUFFSOP_SUSPEND 0x06 /* ->kernel */ 55 56 #define PUFFSOPFLAG_FAF 0x10 /* fire-and-forget */ 57 #define PUFFSOPFLAG_ISRESPONSE 0x20 /* req is actually a resp */ 58 59 #define PUFFSOP_OPCMASK 0x07 60 #define PUFFSOP_OPCLASS(a) ((a) & PUFFSOP_OPCMASK) 61 #define PUFFSOP_WANTREPLY(a) (((a) & PUFFSOPFLAG_FAF) == 0) 62 63 /* XXX: we don't need everything */ 64 enum { 65 PUFFS_VFS_MOUNT, PUFFS_VFS_START, PUFFS_VFS_UNMOUNT, 66 PUFFS_VFS_ROOT, PUFFS_VFS_STATVFS, PUFFS_VFS_SYNC, 67 PUFFS_VFS_VGET, PUFFS_VFS_FHTOVP, PUFFS_VFS_VPTOFH, 68 PUFFS_VFS_INIT, PUFFS_VFS_DONE, PUFFS_VFS_SNAPSHOT, 69 PUFFS_VFS_EXTATTCTL, PUFFS_VFS_SUSPEND 70 }; 71 #define PUFFS_VFS_MAX PUFFS_VFS_EXTATTCTL 72 73 /* moreXXX: we don't need everything here either */ 74 enum { 75 PUFFS_VN_LOOKUP, PUFFS_VN_CREATE, PUFFS_VN_MKNOD, 76 PUFFS_VN_OPEN, PUFFS_VN_CLOSE, PUFFS_VN_ACCESS, 77 PUFFS_VN_GETATTR, PUFFS_VN_SETATTR, PUFFS_VN_READ, 78 PUFFS_VN_WRITE, PUFFS_VN_IOCTL, PUFFS_VN_FCNTL, 79 PUFFS_VN_POLL, PUFFS_VN_KQFILTER, PUFFS_VN_REVOKE, 80 PUFFS_VN_MMAP, PUFFS_VN_FSYNC, PUFFS_VN_SEEK, 81 PUFFS_VN_REMOVE, PUFFS_VN_LINK, PUFFS_VN_RENAME, 82 PUFFS_VN_MKDIR, PUFFS_VN_RMDIR, PUFFS_VN_SYMLINK, 83 PUFFS_VN_READDIR, PUFFS_VN_READLINK, PUFFS_VN_ABORTOP, 84 PUFFS_VN_INACTIVE, PUFFS_VN_RECLAIM, PUFFS_VN_LOCK, 85 PUFFS_VN_UNLOCK, PUFFS_VN_BMAP, PUFFS_VN_STRATEGY, 86 PUFFS_VN_PRINT, PUFFS_VN_ISLOCKED, PUFFS_VN_PATHCONF, 87 PUFFS_VN_ADVLOCK, PUFFS_VN_LEASE, PUFFS_VN_WHITEOUT, 88 PUFFS_VN_GETPAGES, PUFFS_VN_PUTPAGES, PUFFS_VN_GETEXTATTR, 89 PUFFS_VN_LISTEXTATTR, PUFFS_VN_OPENEXTATTR, PUFFS_VN_DELETEEXTATTR, 90 PUFFS_VN_SETEXTATTR 91 }; 92 #define PUFFS_VN_MAX PUFFS_VN_SETEXTATTR 93 94 /* 95 * These signal invalid parameters the file system returned. 96 */ 97 enum { 98 PUFFS_ERR_MAKENODE, PUFFS_ERR_LOOKUP, PUFFS_ERR_READDIR, 99 PUFFS_ERR_READLINK, PUFFS_ERR_READ, PUFFS_ERR_WRITE, 100 PUFFS_ERR_VPTOFH, PUFFS_ERR_ERROR 101 }; 102 #define PUFFS_ERR_MAX PUFFS_ERR_VPTOFH 103 104 #define PUFFSDEVELVERS 0x80000000 105 #define PUFFSVERSION 26 106 #define PUFFSNAMESIZE 32 107 108 #define PUFFS_TYPEPREFIX "puffs|" 109 110 #define PUFFS_TYPELEN (_VFS_NAMELEN - (sizeof(PUFFS_TYPEPREFIX)+1)) 111 #define PUFFS_NAMELEN (_VFS_MNAMELEN-1) 112 113 struct puffs_kargs { 114 unsigned int pa_vers; 115 int pa_fd; 116 117 uint32_t pa_flags; 118 119 size_t pa_maxmsglen; 120 int pa_nhashbuckets; 121 122 size_t pa_fhsize; 123 int pa_fhflags; 124 125 void *pa_root_cookie; 126 enum vtype pa_root_vtype; 127 voff_t pa_root_vsize; 128 dev_t pa_root_rdev; 129 130 struct statvfs pa_svfsb; 131 132 char pa_typename[_VFS_NAMELEN]; 133 char pa_mntfromname[_VFS_MNAMELEN]; 134 135 uint8_t pa_vnopmask[PUFFS_VN_MAX]; 136 }; 137 #define PUFFS_KFLAG_NOCACHE_NAME 0x01 /* don't use name cache */ 138 #define PUFFS_KFLAG_NOCACHE_PAGE 0x02 /* don't use page cache */ 139 #define PUFFS_KFLAG_NOCACHE 0x03 /* no cache whatsoever */ 140 #define PUFFS_KFLAG_ALLOPS 0x04 /* ignore pa_vnopmask */ 141 #define PUFFS_KFLAG_WTCACHE 0x08 /* write-through page cache */ 142 #define PUFFS_KFLAG_IAONDEMAND 0x10 /* inactive only on demand */ 143 #define PUFFS_KFLAG_LOOKUP_FULLPNBUF 0x20 /* full pnbuf in lookup */ 144 #define PUFFS_KFLAG_MASK 0x3f 145 146 #define PUFFS_FHFLAG_DYNAMIC 0x01 147 #define PUFFS_FHFLAG_NFSV2 0x02 148 #define PUFFS_FHFLAG_NFSV3 0x04 149 #define PUFFS_FHFLAG_PROTOMASK 0x06 150 #define PUFFS_FHFLAG_PASSTHROUGH 0x08 151 #define PUFFS_FHFLAG_MASK 0x0f 152 153 #define PUFFS_FHSIZE_MAX 1020 /* XXX: FHANDLE_SIZE_MAX - 4 */ 154 155 struct puffs_req { 156 struct putter_hdr preq_pth; 157 158 uint64_t preq_id; 159 void *preq_cookie; 160 161 uint16_t preq_opclass; 162 uint16_t preq_optype; 163 int preq_rv; 164 165 uint32_t preq_setbacks; 166 167 /* Who is making the call? Eventually host id is also needed. */ 168 pid_t preq_pid; 169 lwpid_t preq_lid; 170 171 /* 172 * the following helper pads the struct size to md alignment 173 * multiple (should size_t not cut it). it makes sure that 174 * whatever comes after this struct is aligned 175 */ 176 size_t preq_buflen; 177 uint8_t preq_buf[0] __aligned(ALIGNBYTES+1); 178 }; 179 180 #define PUFFS_SETBACK_INACT_N1 0x01 /* set VOP_INACTIVE for node 1 */ 181 #define PUFFS_SETBACK_INACT_N2 0x02 /* set VOP_INACTIVE for node 2 */ 182 #define PUFFS_SETBACK_NOREF_N1 0x04 /* set pn PN_NOREFS for node 1 */ 183 #define PUFFS_SETBACK_NOREF_N2 0x08 /* set pn PN_NOREFS for node 2 */ 184 #define PUFFS_SETBACK_MASK 0x0f 185 186 /* 187 * Flush operation. This can be used to invalidate: 188 * 1) name cache for one node 189 * 2) name cache for all children 190 * 3) name cache for the entire mount 191 * 4) page cache for a set of ranges in one node 192 * 5) page cache for one entire node 193 * 194 * It can be used to flush: 195 * 1) page cache for a set of ranges in one node 196 * 2) page cache for one entire node 197 */ 198 199 /* XXX: needs restructuring */ 200 struct puffs_flush { 201 struct puffs_req pf_req; 202 203 void *pf_cookie; 204 205 int pf_op; 206 off_t pf_start; 207 off_t pf_end; 208 }; 209 #define PUFFS_INVAL_NAMECACHE_NODE 0 210 #define PUFFS_INVAL_NAMECACHE_DIR 1 211 #define PUFFS_INVAL_NAMECACHE_ALL 2 212 #define PUFFS_INVAL_PAGECACHE_NODE_RANGE 3 213 #define PUFFS_FLUSH_PAGECACHE_NODE_RANGE 4 214 215 /* keep this for now */ 216 #define PUFFSREQSIZEOP _IOR ('p', 1, size_t) 217 218 /* 219 * Credentials for an operation. Can be either struct uucred for 220 * ops called from a credential context or NOCRED/FSCRED for ops 221 * called from within the kernel. It is up to the implementation 222 * if it makes a difference between these two and the super-user. 223 */ 224 struct puffs_kcred { 225 struct uucred pkcr_uuc; 226 uint8_t pkcr_type; 227 uint8_t pkcr_internal; 228 }; 229 #define PUFFCRED_TYPE_UUC 1 230 #define PUFFCRED_TYPE_INTERNAL 2 231 #define PUFFCRED_CRED_NOCRED 1 232 #define PUFFCRED_CRED_FSCRED 2 233 234 /* 235 * 2*MAXPHYS is the max size the system will attempt to copy, 236 * else treated as garbage 237 */ 238 #define PUFFS_MSG_MAXSIZE 2*MAXPHYS 239 #define PUFFS_MSGSTRUCT_MAX 4096 /* XXX: approxkludge */ 240 241 #define PUFFS_TOMOVE(a,b) (MIN((a), b->pmp_msg_maxsize - PUFFS_MSGSTRUCT_MAX)) 242 243 /* puffs struct componentname built by kernel */ 244 struct puffs_kcn { 245 /* args */ 246 uint32_t pkcn_nameiop; /* namei operation */ 247 uint32_t pkcn_flags; /* flags */ 248 249 char pkcn_name[MAXPATHLEN]; /* nulterminated path component */ 250 size_t pkcn_namelen; /* current component length */ 251 size_t pkcn_consume; /* IN: extra chars server ate */ 252 }; 253 254 255 /* 256 * Next come the individual requests. They are all subclassed from 257 * puffs_req and contain request-specific fields in addition. Note 258 * that there are some requests which have to handle arbitrary-length 259 * buffers. 260 * 261 * The division is the following: puffs_req is to be touched only 262 * by generic routines while the other stuff is supposed to be 263 * modified only by specific routines. 264 */ 265 266 /* 267 * aux structures for vfs operations. 268 */ 269 struct puffs_vfsmsg_unmount { 270 struct puffs_req pvfsr_pr; 271 272 int pvfsr_flags; 273 }; 274 275 struct puffs_vfsmsg_statvfs { 276 struct puffs_req pvfsr_pr; 277 278 struct statvfs pvfsr_sb; 279 }; 280 281 struct puffs_vfsmsg_sync { 282 struct puffs_req pvfsr_pr; 283 284 struct puffs_kcred pvfsr_cred; 285 int pvfsr_waitfor; 286 }; 287 288 struct puffs_vfsmsg_fhtonode { 289 struct puffs_req pvfsr_pr; 290 291 void *pvfsr_fhcookie; /* IN */ 292 enum vtype pvfsr_vtype; /* IN */ 293 voff_t pvfsr_size; /* IN */ 294 dev_t pvfsr_rdev; /* IN */ 295 296 size_t pvfsr_dsize; /* OUT */ 297 uint8_t pvfsr_data[0] /* OUT, XXX */ 298 __aligned(ALIGNBYTES+1); 299 }; 300 301 struct puffs_vfsmsg_nodetofh { 302 struct puffs_req pvfsr_pr; 303 304 void *pvfsr_fhcookie; /* OUT */ 305 306 size_t pvfsr_dsize; /* OUT/IN */ 307 uint8_t pvfsr_data[0] /* IN, XXX */ 308 __aligned(ALIGNBYTES+1); 309 }; 310 311 struct puffs_vfsmsg_suspend { 312 struct puffs_req pvfsr_pr; 313 314 int pvfsr_status; 315 }; 316 #define PUFFS_SUSPEND_START 0 317 #define PUFFS_SUSPEND_SUSPENDED 1 318 #define PUFFS_SUSPEND_RESUME 2 319 #define PUFFS_SUSPEND_ERROR 3 320 321 /* 322 * aux structures for vnode operations. 323 */ 324 325 struct puffs_vnmsg_lookup { 326 struct puffs_req pvn_pr; 327 328 struct puffs_kcn pvnr_cn; /* OUT */ 329 struct puffs_kcred pvnr_cn_cred; /* OUT */ 330 331 void *pvnr_newnode; /* IN */ 332 enum vtype pvnr_vtype; /* IN */ 333 voff_t pvnr_size; /* IN */ 334 dev_t pvnr_rdev; /* IN */ 335 }; 336 337 struct puffs_vnmsg_create { 338 struct puffs_req pvn_pr; 339 340 struct puffs_kcn pvnr_cn; /* OUT */ 341 struct puffs_kcred pvnr_cn_cred; /* OUT */ 342 343 struct vattr pvnr_va; /* OUT */ 344 void *pvnr_newnode; /* IN */ 345 }; 346 347 struct puffs_vnmsg_mknod { 348 struct puffs_req pvn_pr; 349 350 struct puffs_kcn pvnr_cn; /* OUT */ 351 struct puffs_kcred pvnr_cn_cred; /* OUT */ 352 353 struct vattr pvnr_va; /* OUT */ 354 void *pvnr_newnode; /* IN */ 355 }; 356 357 struct puffs_vnmsg_open { 358 struct puffs_req pvn_pr; 359 360 struct puffs_kcred pvnr_cred; /* OUT */ 361 int pvnr_mode; /* OUT */ 362 }; 363 364 struct puffs_vnmsg_close { 365 struct puffs_req pvn_pr; 366 367 struct puffs_kcred pvnr_cred; /* OUT */ 368 int pvnr_fflag; /* OUT */ 369 }; 370 371 struct puffs_vnmsg_access { 372 struct puffs_req pvn_pr; 373 374 struct puffs_kcred pvnr_cred; /* OUT */ 375 int pvnr_mode; /* OUT */ 376 }; 377 378 #define puffs_vnmsg_setattr puffs_vnmsg_setgetattr 379 #define puffs_vnmsg_getattr puffs_vnmsg_setgetattr 380 struct puffs_vnmsg_setgetattr { 381 struct puffs_req pvn_pr; 382 383 struct puffs_kcred pvnr_cred; /* OUT */ 384 struct vattr pvnr_va; /* IN/OUT (op depend) */ 385 }; 386 387 #define puffs_vnmsg_read puffs_vnmsg_rw 388 #define puffs_vnmsg_write puffs_vnmsg_rw 389 struct puffs_vnmsg_rw { 390 struct puffs_req pvn_pr; 391 392 struct puffs_kcred pvnr_cred; /* OUT */ 393 off_t pvnr_offset; /* OUT */ 394 size_t pvnr_resid; /* IN/OUT */ 395 int pvnr_ioflag; /* OUT */ 396 397 uint8_t pvnr_data[0]; /* IN/OUT (wr/rd) */ 398 }; 399 400 #define puffs_vnmsg_ioctl puffs_vnreq_fcnioctl 401 #define puffs_vnmsg_fcntl puffs_vnreq_fcnioctl 402 struct puffs_vnmsg_fcnioctl { 403 struct puffs_req pvn_pr; 404 405 struct puffs_kcred pvnr_cred; 406 u_long pvnr_command; 407 pid_t pvnr_pid; 408 int pvnr_fflag; 409 410 void *pvnr_data; 411 size_t pvnr_datalen; 412 int pvnr_copyback; 413 }; 414 415 struct puffs_vnmsg_poll { 416 struct puffs_req pvn_pr; 417 418 int pvnr_events; /* IN/OUT */ 419 }; 420 421 struct puffs_vnmsg_fsync { 422 struct puffs_req pvn_pr; 423 424 struct puffs_kcred pvnr_cred; /* OUT */ 425 off_t pvnr_offlo; /* OUT */ 426 off_t pvnr_offhi; /* OUT */ 427 int pvnr_flags; /* OUT */ 428 }; 429 430 struct puffs_vnmsg_seek { 431 struct puffs_req pvn_pr; 432 433 struct puffs_kcred pvnr_cred; /* OUT */ 434 off_t pvnr_oldoff; /* OUT */ 435 off_t pvnr_newoff; /* OUT */ 436 }; 437 438 struct puffs_vnmsg_remove { 439 struct puffs_req pvn_pr; 440 441 struct puffs_kcn pvnr_cn; /* OUT */ 442 struct puffs_kcred pvnr_cn_cred; /* OUT */ 443 444 void *pvnr_cookie_targ; /* OUT */ 445 }; 446 447 struct puffs_vnmsg_mkdir { 448 struct puffs_req pvn_pr; 449 450 struct puffs_kcn pvnr_cn; /* OUT */ 451 struct puffs_kcred pvnr_cn_cred; /* OUT */ 452 453 struct vattr pvnr_va; /* OUT */ 454 void *pvnr_newnode; /* IN */ 455 }; 456 457 struct puffs_vnmsg_rmdir { 458 struct puffs_req pvn_pr; 459 460 struct puffs_kcn pvnr_cn; /* OUT */ 461 struct puffs_kcred pvnr_cn_cred; /* OUT */ 462 463 void *pvnr_cookie_targ; /* OUT */ 464 }; 465 466 struct puffs_vnmsg_link { 467 struct puffs_req pvn_pr; 468 469 struct puffs_kcn pvnr_cn; /* OUT */ 470 struct puffs_kcred pvnr_cn_cred; /* OUT */ 471 472 void *pvnr_cookie_targ; /* OUT */ 473 }; 474 475 struct puffs_vnmsg_rename { 476 struct puffs_req pvn_pr; 477 478 struct puffs_kcn pvnr_cn_src; /* OUT */ 479 struct puffs_kcred pvnr_cn_src_cred; /* OUT */ 480 struct puffs_kcn pvnr_cn_targ; /* OUT */ 481 struct puffs_kcred pvnr_cn_targ_cred; /* OUT */ 482 483 void *pvnr_cookie_src; /* OUT */ 484 void *pvnr_cookie_targ; /* OUT */ 485 void *pvnr_cookie_targdir; /* OUT */ 486 }; 487 488 struct puffs_vnmsg_symlink { 489 struct puffs_req pvn_pr; 490 491 struct puffs_kcn pvnr_cn; /* OUT */ 492 struct puffs_kcred pvnr_cn_cred; /* OUT */ 493 494 struct vattr pvnr_va; /* OUT */ 495 void *pvnr_newnode; /* IN */ 496 char pvnr_link[MAXPATHLEN]; /* OUT */ 497 }; 498 499 struct puffs_vnmsg_readdir { 500 struct puffs_req pvn_pr; 501 502 struct puffs_kcred pvnr_cred; /* OUT */ 503 off_t pvnr_offset; /* IN/OUT */ 504 size_t pvnr_resid; /* IN/OUT */ 505 size_t pvnr_ncookies; /* IN/OUT */ 506 int pvnr_eofflag; /* IN */ 507 508 size_t pvnr_dentoff; /* OUT */ 509 uint8_t pvnr_data[0] /* IN */ 510 __aligned(ALIGNBYTES+1); 511 }; 512 513 struct puffs_vnmsg_readlink { 514 struct puffs_req pvn_pr; 515 516 struct puffs_kcred pvnr_cred; /* OUT */ 517 size_t pvnr_linklen; /* IN */ 518 char pvnr_link[MAXPATHLEN]; /* IN, XXX */ 519 }; 520 521 struct puffs_vnmsg_reclaim { 522 struct puffs_req pvn_pr; 523 }; 524 525 struct puffs_vnmsg_inactive { 526 struct puffs_req pvn_pr; 527 }; 528 529 struct puffs_vnmsg_print { 530 struct puffs_req pvn_pr; 531 532 /* empty */ 533 }; 534 535 struct puffs_vnmsg_pathconf { 536 struct puffs_req pvn_pr; 537 538 int pvnr_name; /* OUT */ 539 int pvnr_retval; /* IN */ 540 }; 541 542 struct puffs_vnmsg_advlock { 543 struct puffs_req pvn_pr; 544 545 struct flock pvnr_fl; /* OUT */ 546 void *pvnr_id; /* OUT */ 547 int pvnr_op; /* OUT */ 548 int pvnr_flags; /* OUT */ 549 }; 550 551 struct puffs_vnmsg_mmap { 552 struct puffs_req pvn_pr; 553 554 vm_prot_t pvnr_prot; /* OUT */ 555 struct puffs_kcred pvnr_cred; /* OUT */ 556 }; 557 558 559 /* 560 * For cache reports. Everything is always out-out-out, no replies 561 */ 562 563 struct puffs_cacherun { 564 off_t pcache_runstart; 565 off_t pcache_runend; 566 }; 567 568 /* cache info. old used for write now */ 569 struct puffs_cacheinfo { 570 struct puffs_req pcache_pr; 571 572 int pcache_type; 573 size_t pcache_nruns; 574 struct puffs_cacherun pcache_runs[0]; 575 }; 576 #define PCACHE_TYPE_READ 0 577 #define PCACHE_TYPE_WRITE 1 578 579 /* 580 * Error notification. Always outgoing, no response, no remorse. 581 */ 582 struct puffs_error { 583 struct puffs_req perr_pr; 584 585 int perr_error; 586 char perr_str[256]; 587 }; 588 589 #endif /* _FS_PUFFS_PUFFS_MSGIF_H_ */ 590
Indexes created Tue Sep 30 17:09:57 GMT 2025