puffs.h revision 1.91
1 /* $NetBSD: puffs.h,v 1.91 2007/10/28 18:40:30 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 _PUFFS_H_ 33 #define _PUFFS_H_ 34 35 #include <sys/param.h> 36 #include <sys/types.h> 37 #include <sys/mount.h> 38 #include <sys/namei.h> 39 #include <sys/stat.h> 40 #include <sys/statvfs.h> 41 #include <sys/time.h> 42 #include <sys/vnode.h> 43 44 #include <fs/puffs/puffs_msgif.h> 45 46 #include <mntopts.h> 47 #include <stdbool.h> 48 #include <string.h> 49 50 /* forwards */ 51 struct puffs_cc; 52 53 struct puffs_getreq; 54 struct puffs_putreq; 55 struct puffs_cred; 56 struct puffs_cid; 57 struct puffs_newinfo; 58 59 /* paths */ 60 struct puffs_pathobj { 61 void *po_path; 62 size_t po_len; 63 uint32_t po_hash; 64 }; 65 66 /* for prefix rename */ 67 struct puffs_pathinfo { 68 struct puffs_pathobj *pi_old; 69 struct puffs_pathobj *pi_new; 70 }; 71 72 /* describes one segment cached in the kernel */ 73 struct puffs_kcache { 74 off_t pkc_start; 75 off_t pkc_end; 76 77 LIST_ENTRY(puffs_kcache) pkc_entries; 78 }; 79 80 /* XXX: might disappear from here into a private header */ 81 struct puffs_node { 82 off_t pn_size; 83 int pn_flags; 84 struct vattr pn_va; 85 86 void *pn_data; /* private data */ 87 88 struct puffs_pathobj pn_po; /* PUFFS_FLAG_BUILDPATH */ 89 90 struct puffs_usermount *pn_mnt; 91 LIST_ENTRY(puffs_node) pn_entries; 92 93 LIST_HEAD(,puffs_kcache)pn_cacheinfo; /* PUFFS_KFLAG_CACHE */ 94 }; 95 #define PUFFS_NODE_REMOVED 0x01 /* not on entry list */ 96 97 98 struct puffs_usermount; 99 100 /* 101 * megaXXX: these are values from inside _KERNEL 102 * need to work on the translation for ALL the necessary values. 103 */ 104 #define PUFFS_VNOVAL (-1) 105 106 #define PUFFS_IO_APPEND 0x020 107 #define PUFFS_IO_NDELAY 0x100 108 109 #define PUFFS_VEXEC 01 110 #define PUFFS_VWRITE 02 111 #define PUFFS_VREAD 04 112 113 #define PUFFS_FSYNC_DATAONLY 0x0002 114 #define PUFFS_FSYNC_CACHE 0x0100 115 116 /* 117 * Magic constants 118 */ 119 #define PUFFS_CC_STACKSHIFT_DEFAULT 18 120 121 struct puffs_cn { 122 struct puffs_kcn *pcn_pkcnp; /* kernel input */ 123 124 struct puffs_cred *pcn_cred; /* cred used for lookup */ 125 struct puffs_cid *pcn_cid; /* the who called */ 126 127 struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 128 }; 129 #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 130 #define pcn_flags pcn_pkcnp->pkcn_flags 131 #define pcn_pid pcn_pkcnp->pkcn_pid 132 #define pcn_name pcn_pkcnp->pkcn_name 133 #define pcn_namelen pcn_pkcnp->pkcn_namelen 134 #define pcn_consume pcn_pkcnp->pkcn_consume 135 136 /* 137 * Puffs options to mount 138 */ 139 /* kernel */ 140 #define PUFFSMOPT_NAMECACHE { "namecache", 1, PUFFS_KFLAG_NOCACHE_NAME, 1 } 141 #define PUFFSMOPT_PAGECACHE { "pagecache", 1, PUFFS_KFLAG_NOCACHE_PAGE, 1 } 142 #define PUFFSMOPT_CACHE { "cache", 1, PUFFS_KFLAG_NOCACHE, 1 } 143 #define PUFFSMOPT_ALLOPS { "allops", 0, PUFFS_KFLAG_ALLOPS, 1 } 144 145 /* libpuffs */ 146 #define PUFFSMOPT_DUMP { "dump", 0, PUFFS_FLAG_OPDUMP, 1 } 147 148 #define PUFFSMOPT_STD \ 149 PUFFSMOPT_NAMECACHE, \ 150 PUFFSMOPT_PAGECACHE, \ 151 PUFFSMOPT_CACHE, \ 152 PUFFSMOPT_ALLOPS, \ 153 PUFFSMOPT_DUMP 154 155 extern const struct mntopt puffsmopts[]; /* puffs.c */ 156 157 /* callbacks for operations */ 158 struct puffs_ops { 159 int (*puffs_fs_unmount)(struct puffs_cc *, int, 160 const struct puffs_cid *); 161 int (*puffs_fs_statvfs)(struct puffs_cc *, 162 struct statvfs *, const struct puffs_cid *); 163 int (*puffs_fs_sync)(struct puffs_cc *, int, 164 const struct puffs_cred *, const struct puffs_cid *); 165 int (*puffs_fs_fhtonode)(struct puffs_cc *, void *, size_t, 166 struct puffs_newinfo *); 167 int (*puffs_fs_nodetofh)(struct puffs_cc *, void *cookie, 168 void *, size_t *); 169 void (*puffs_fs_suspend)(struct puffs_cc *, int); 170 171 int (*puffs_node_lookup)(struct puffs_cc *, 172 void *, struct puffs_newinfo *, const struct puffs_cn *); 173 int (*puffs_node_create)(struct puffs_cc *, 174 void *, struct puffs_newinfo *, const struct puffs_cn *, 175 const struct vattr *); 176 int (*puffs_node_mknod)(struct puffs_cc *, 177 void *, struct puffs_newinfo *, const struct puffs_cn *, 178 const struct vattr *); 179 int (*puffs_node_open)(struct puffs_cc *, 180 void *, int, const struct puffs_cred *, const struct puffs_cid *); 181 int (*puffs_node_close)(struct puffs_cc *, 182 void *, int, const struct puffs_cred *, const struct puffs_cid *); 183 int (*puffs_node_access)(struct puffs_cc *, 184 void *, int, const struct puffs_cred *, const struct puffs_cid *); 185 int (*puffs_node_getattr)(struct puffs_cc *, 186 void *, struct vattr *, const struct puffs_cred *, 187 const struct puffs_cid *); 188 int (*puffs_node_setattr)(struct puffs_cc *, 189 void *, const struct vattr *, const struct puffs_cred *, 190 const struct puffs_cid *); 191 int (*puffs_node_poll)(struct puffs_cc *, void *, int *, 192 const struct puffs_cid *); 193 int (*puffs_node_mmap)(struct puffs_cc *, 194 void *, vm_prot_t, const struct puffs_cred *, 195 const struct puffs_cid *); 196 int (*puffs_node_fsync)(struct puffs_cc *, 197 void *, const struct puffs_cred *, int, off_t, off_t, 198 const struct puffs_cid *); 199 int (*puffs_node_seek)(struct puffs_cc *, 200 void *, off_t, off_t, const struct puffs_cred *); 201 int (*puffs_node_remove)(struct puffs_cc *, 202 void *, void *, const struct puffs_cn *); 203 int (*puffs_node_link)(struct puffs_cc *, 204 void *, void *, const struct puffs_cn *); 205 int (*puffs_node_rename)(struct puffs_cc *, 206 void *, void *, const struct puffs_cn *, void *, void *, 207 const struct puffs_cn *); 208 int (*puffs_node_mkdir)(struct puffs_cc *, 209 void *, struct puffs_newinfo *, const struct puffs_cn *, 210 const struct vattr *); 211 int (*puffs_node_rmdir)(struct puffs_cc *, 212 void *, void *, const struct puffs_cn *); 213 int (*puffs_node_symlink)(struct puffs_cc *, 214 void *, struct puffs_newinfo *, const struct puffs_cn *, 215 const struct vattr *, 216 const char *); 217 int (*puffs_node_readdir)(struct puffs_cc *, 218 void *, struct dirent *, off_t *, size_t *, 219 const struct puffs_cred *, int *, off_t *, size_t *); 220 int (*puffs_node_readlink)(struct puffs_cc *, 221 void *, const struct puffs_cred *, char *, size_t *); 222 int (*puffs_node_reclaim)(struct puffs_cc *, 223 void *, const struct puffs_cid *); 224 int (*puffs_node_inactive)(struct puffs_cc *, 225 void *, const struct puffs_cid *); 226 int (*puffs_node_print)(struct puffs_cc *, 227 void *); 228 int (*puffs_node_pathconf)(struct puffs_cc *, 229 void *, int, int *); 230 int (*puffs_node_advlock)(struct puffs_cc *, 231 void *, void *, int, struct flock *, int); 232 int (*puffs_node_read)(struct puffs_cc *, void *, 233 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 234 int (*puffs_node_write)(struct puffs_cc *, void *, 235 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 236 237 /* XXX: this shouldn't be here */ 238 void (*puffs_cache_write)(struct puffs_usermount *, 239 void *, size_t, struct puffs_cacherun *); 240 }; 241 242 typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 243 const struct puffs_pathobj *, 244 const struct puffs_pathobj *, size_t, 245 struct puffs_pathobj *); 246 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 247 const struct puffs_pathobj *, 248 const struct puffs_cn *, 249 struct puffs_pathobj *); 250 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 251 struct puffs_pathobj *, size_t, int); 252 typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 253 struct puffs_pathobj *); 254 typedef int (*pu_namemod_fn)(struct puffs_usermount *, 255 struct puffs_pathobj *, struct puffs_cn *); 256 257 typedef void (*pu_errnotify_fn)(struct puffs_usermount *, 258 uint8_t, int, const char *, void *); 259 260 typedef void (*pu_prepost_fn)(struct puffs_cc *); 261 262 enum { 263 PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 264 PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 265 }; 266 267 #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 268 #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 269 #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 270 #define PUFFS_FLAG_MASK 0xe0000000 271 272 #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 273 #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 274 275 /* blocking mode argument */ 276 #define PUFFSDEV_BLOCK 0 277 #define PUFFSDEV_NONBLOCK 1 278 279 /* mainloop flags */ 280 #define PUFFSLOOP_NODAEMON 0x01 281 282 #define DENT_DOT 0 283 #define DENT_DOTDOT 1 284 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 285 286 287 /* 288 * protos 289 */ 290 291 #define PUFFSOP_PROTOS(fsname) \ 292 int fsname##_fs_unmount(struct puffs_cc *, int, \ 293 const struct puffs_cid *); \ 294 int fsname##_fs_statvfs(struct puffs_cc *, \ 295 struct statvfs *, const struct puffs_cid *); \ 296 int fsname##_fs_sync(struct puffs_cc *, int, \ 297 const struct puffs_cred *cred, const struct puffs_cid *); \ 298 int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t, \ 299 struct puffs_newinfo *); \ 300 int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie, \ 301 void *, size_t *); \ 302 void fsname##_fs_suspend(struct puffs_cc *, int); \ 303 \ 304 int fsname##_node_lookup(struct puffs_cc *, \ 305 void *, struct puffs_newinfo *, const struct puffs_cn *); \ 306 int fsname##_node_create(struct puffs_cc *, \ 307 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 308 const struct vattr *); \ 309 int fsname##_node_mknod(struct puffs_cc *, \ 310 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 311 const struct vattr *); \ 312 int fsname##_node_open(struct puffs_cc *, \ 313 void *, int, const struct puffs_cred *, \ 314 const struct puffs_cid *); \ 315 int fsname##_node_close(struct puffs_cc *, \ 316 void *, int, const struct puffs_cred *, \ 317 const struct puffs_cid *); \ 318 int fsname##_node_access(struct puffs_cc *, \ 319 void *, int, const struct puffs_cred *, \ 320 const struct puffs_cid *); \ 321 int fsname##_node_getattr(struct puffs_cc *, \ 322 void *, struct vattr *, const struct puffs_cred *, \ 323 const struct puffs_cid *); \ 324 int fsname##_node_setattr(struct puffs_cc *, \ 325 void *, const struct vattr *, const struct puffs_cred *, \ 326 const struct puffs_cid *); \ 327 int fsname##_node_poll(struct puffs_cc *, void *, int *, \ 328 const struct puffs_cid *); \ 329 int fsname##_node_mmap(struct puffs_cc *, \ 330 void *, vm_prot_t, const struct puffs_cred *, \ 331 const struct puffs_cid *); \ 332 int fsname##_node_fsync(struct puffs_cc *, \ 333 void *, const struct puffs_cred *, int, off_t, off_t, \ 334 const struct puffs_cid *); \ 335 int fsname##_node_seek(struct puffs_cc *, \ 336 void *, off_t, off_t, const struct puffs_cred *); \ 337 int fsname##_node_remove(struct puffs_cc *, \ 338 void *, void *, const struct puffs_cn *); \ 339 int fsname##_node_link(struct puffs_cc *, \ 340 void *, void *, const struct puffs_cn *); \ 341 int fsname##_node_rename(struct puffs_cc *, \ 342 void *, void *, const struct puffs_cn *, void *, void *, \ 343 const struct puffs_cn *); \ 344 int fsname##_node_mkdir(struct puffs_cc *, \ 345 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 346 const struct vattr *); \ 347 int fsname##_node_rmdir(struct puffs_cc *, \ 348 void *, void *, const struct puffs_cn *); \ 349 int fsname##_node_symlink(struct puffs_cc *, \ 350 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 351 const struct vattr *, const char *); \ 352 int fsname##_node_readdir(struct puffs_cc *, \ 353 void *, struct dirent *, off_t *, size_t *, \ 354 const struct puffs_cred *, int *, off_t *, size_t *); \ 355 int fsname##_node_readlink(struct puffs_cc *, \ 356 void *, const struct puffs_cred *, char *, size_t *); \ 357 int fsname##_node_reclaim(struct puffs_cc *, \ 358 void *, const struct puffs_cid *); \ 359 int fsname##_node_inactive(struct puffs_cc *, \ 360 void *, const struct puffs_cid *); \ 361 int fsname##_node_print(struct puffs_cc *, \ 362 void *); \ 363 int fsname##_node_pathconf(struct puffs_cc *, \ 364 void *, int, int *); \ 365 int fsname##_node_advlock(struct puffs_cc *, \ 366 void *, void *, int, struct flock *, int); \ 367 int fsname##_node_read(struct puffs_cc *, void *, \ 368 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 369 int fsname##_node_write(struct puffs_cc *, void *, \ 370 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 371 \ 372 int fsname##_cache_write(struct puffs_usermount *, void *, \ 373 size_t, struct puffs_cacheinfo *); 374 375 #define PUFFSOP_INIT(ops) \ 376 ops = malloc(sizeof(struct puffs_ops)); \ 377 memset(ops, 0, sizeof(struct puffs_ops)) 378 #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 379 (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 380 #define PUFFSOP_SETFSNOP(ops, opname) \ 381 (ops)->puffs_fs_##opname = puffs_fsnop_##opname 382 383 PUFFSOP_PROTOS(puffs_null) /* XXX */ 384 385 #define PUFFS_DEVEL_LIBVERSION 28 386 #define puffs_init(a,b,c,d,e) \ 387 _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e) 388 389 390 #define PNPATH(pnode) ((pnode)->pn_po.po_path) 391 #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 392 #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 393 #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 394 #define PCNISDOTDOT(pcnode) \ 395 ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 396 397 #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 398 if (cp) { \ 399 *((cp)++) = off; \ 400 (*(ncp))++; \ 401 } 402 403 /* mainloop */ 404 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 405 406 /* framebuf stuff */ 407 struct puffs_framebuf; 408 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 409 struct puffs_framebuf *, 410 int, int *); 411 typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 412 struct puffs_framebuf *, 413 int, int *); 414 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 415 struct puffs_framebuf *, 416 struct puffs_framebuf *, 417 int *); 418 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 419 typedef void (*puffs_framev_gotframe_fn)(struct puffs_usermount *, 420 struct puffs_framebuf *); 421 typedef void (*puffs_framev_cb)(struct puffs_usermount *, 422 struct puffs_framebuf *, 423 void *, int); 424 #define PUFFS_FBIO_READ 0x01 425 #define PUFFS_FBIO_WRITE 0x02 426 #define PUFFS_FBIO_ERROR 0x04 427 428 #define PUFFS_FBQUEUE_URGENT 0x01 429 430 431 __BEGIN_DECLS 432 433 struct puffs_usermount *_puffs_init(int, struct puffs_ops *, const char *, 434 const char *, void *, uint32_t); 435 int puffs_mount(struct puffs_usermount *, const char *, int, void*); 436 int puffs_exit(struct puffs_usermount *, int); 437 int puffs_mainloop(struct puffs_usermount *, int); 438 439 440 int puffs_getselectable(struct puffs_usermount *); 441 int puffs_setblockingmode(struct puffs_usermount *, int); 442 int puffs_getstate(struct puffs_usermount *); 443 void puffs_setstacksize(struct puffs_usermount *, size_t); 444 445 void puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn); 446 void puffs_ml_settimeout(struct puffs_usermount *, struct timespec *); 447 448 void puffs_setroot(struct puffs_usermount *, 449 struct puffs_node *); 450 struct puffs_node *puffs_getroot(struct puffs_usermount *); 451 void puffs_setrootinfo(struct puffs_usermount *, 452 enum vtype, vsize_t, dev_t); 453 454 void *puffs_getspecific(struct puffs_usermount *); 455 void puffs_setmaxreqlen(struct puffs_usermount *, size_t); 456 size_t puffs_getmaxreqlen(struct puffs_usermount *); 457 void puffs_setfhsize(struct puffs_usermount *, size_t, int); 458 459 void puffs_setncookiehash(struct puffs_usermount *, int); 460 461 struct puffs_pathobj *puffs_getrootpathobj(struct puffs_usermount *); 462 463 void puffs_setback(struct puffs_cc *, int); 464 465 struct puffs_node *puffs_pn_new(struct puffs_usermount *, void *); 466 void puffs_pn_remove(struct puffs_node *); 467 void puffs_pn_put(struct puffs_node *); 468 struct vattr *puffs_pn_getvap(struct puffs_node *); 469 void * puffs_pn_getpriv(struct puffs_node *); 470 void puffs_pn_setpriv(struct puffs_node *, void *); 471 struct puffs_pathobj *puffs_pn_getpo(struct puffs_node *); 472 struct puffs_usermount *puffs_pn_getmnt(struct puffs_node *); 473 474 void puffs_newinfo_setcookie(struct puffs_newinfo *, void *); 475 void puffs_newinfo_setvtype(struct puffs_newinfo *, enum vtype); 476 void puffs_newinfo_setsize(struct puffs_newinfo *, voff_t); 477 void puffs_newinfo_setrdev(struct puffs_newinfo *, dev_t); 478 479 void *puffs_pn_getmntspecific(struct puffs_node *); 480 481 typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 482 struct puffs_node *, void *); 483 void *puffs_pn_nodewalk(struct puffs_usermount *, 484 puffs_nodewalk_fn, void *); 485 486 void puffs_setvattr(struct vattr *, const struct vattr *); 487 void puffs_vattr_null(struct vattr *); 488 489 void puffs_null_setops(struct puffs_ops *); 490 491 /* 492 * generic/dummy routines applicable for some file systems 493 */ 494 int puffs_fsnop_unmount(struct puffs_cc *, int, const struct puffs_cid *); 495 int puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, 496 const struct puffs_cid *); 497 void puffs_zerostatvfs(struct statvfs *); 498 int puffs_fsnop_sync(struct puffs_cc *, int waitfor, 499 const struct puffs_cred *, const struct puffs_cid *); 500 int puffs_genfs_node_reclaim(struct puffs_cc *, void *, 501 const struct puffs_cid *); 502 503 /* 504 * Subroutine stuff 505 */ 506 507 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 508 int puffs_nextdent(struct dirent **, const char *, ino_t, 509 uint8_t, size_t *); 510 int puffs_vtype2dt(enum vtype); 511 enum vtype puffs_mode2vt(mode_t); 512 void puffs_stat2vattr(struct vattr *va, const struct stat *); 513 mode_t puffs_addvtype2mode(mode_t, enum vtype); 514 515 516 /* 517 * credentials & permissions 518 */ 519 520 /* Credential fetch */ 521 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 522 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 523 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 524 525 /* Credential check */ 526 bool puffs_cred_isuid(const struct puffs_cred *, uid_t); 527 bool puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 528 bool puffs_cred_isregular(const struct puffs_cred *); 529 bool puffs_cred_iskernel(const struct puffs_cred *); 530 bool puffs_cred_isfs(const struct puffs_cred *); 531 bool puffs_cred_isjuggernaut(const struct puffs_cred *); 532 533 /* Caller ID */ 534 int puffs_cid_getpid(const struct puffs_cid *, pid_t *); 535 int puffs_cid_getlwpid(const struct puffs_cid *, lwpid_t *); 536 bool puffs_cid_isequal(const struct puffs_cid *, const struct puffs_cid *); 537 538 /* misc */ 539 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 540 const struct puffs_cred *); 541 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 542 const struct puffs_cred *); 543 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 544 const struct puffs_cred *); 545 int puffs_access_times(uid_t, gid_t, mode_t, int, 546 const struct puffs_cred *); 547 548 549 /* 550 * Requests 551 */ 552 553 struct puffs_getreq *puffs_req_makeget(struct puffs_usermount *, 554 size_t, int); 555 int puffs_req_loadget(struct puffs_getreq *); 556 struct puffs_req *puffs_req_get(struct puffs_getreq *); 557 int puffs_req_remainingget(struct puffs_getreq *); 558 void puffs_req_setmaxget(struct puffs_getreq *, int); 559 void puffs_req_destroyget(struct puffs_getreq *); 560 561 struct puffs_putreq *puffs_req_makeput(struct puffs_usermount *); 562 void puffs_req_put(struct puffs_putreq *,struct puffs_req *); 563 void puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*); 564 int puffs_req_putput(struct puffs_putreq *); 565 void puffs_req_resetput(struct puffs_putreq *); 566 void puffs_req_destroyput(struct puffs_putreq *); 567 568 int puffs_req_handle(struct puffs_getreq *, 569 struct puffs_putreq *, int); 570 571 /* 572 * Call Context interfaces relevant for user. 573 */ 574 575 void puffs_cc_yield(struct puffs_cc *); 576 void puffs_cc_continue(struct puffs_cc *); 577 void puffs_cc_schedule(struct puffs_cc *); 578 struct puffs_usermount *puffs_cc_getusermount(struct puffs_cc *); 579 void *puffs_cc_getspecific(struct puffs_cc *); 580 int puffs_cc_getcaller(struct puffs_cc *,pid_t *,lwpid_t *); 581 582 /* 583 * Execute or continue a request 584 */ 585 586 int puffs_dopreq(struct puffs_usermount *, struct puffs_req *, 587 struct puffs_putreq *); 588 void puffs_docc(struct puffs_cc *, struct puffs_putreq *); 589 590 /* 591 * Flushing / invalidation routines 592 */ 593 594 int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 595 int puffs_inval_namecache_all(struct puffs_usermount *); 596 597 int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 598 int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 599 off_t, off_t); 600 int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 601 int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 602 off_t, off_t); 603 604 /* 605 * Path constructicons 606 */ 607 608 int puffs_stdpath_buildpath(struct puffs_usermount *, 609 const struct puffs_pathobj *, 610 const struct puffs_pathobj *, size_t, 611 struct puffs_pathobj *); 612 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 613 struct puffs_pathobj *, size_t, int); 614 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 615 616 void *puffs_path_walkcmp(struct puffs_usermount *, 617 struct puffs_node *, void *); 618 void *puffs_path_prefixadj(struct puffs_usermount *, 619 struct puffs_node *, void *); 620 int puffs_path_pcnbuild(struct puffs_usermount *, 621 struct puffs_cn *, void *); 622 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 623 624 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 625 void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 626 void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 627 void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 628 void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 629 630 void puffs_set_errnotify(struct puffs_usermount *, pu_errnotify_fn); 631 void puffs_set_prepost(struct puffs_usermount *, 632 pu_prepost_fn, pu_prepost_fn); 633 634 /* 635 * Suspension 636 */ 637 638 int puffs_fs_suspend(struct puffs_usermount *); 639 640 /* 641 * Frame buffering 642 */ 643 644 void puffs_framev_init(struct puffs_usermount *, 645 puffs_framev_readframe_fn, 646 puffs_framev_writeframe_fn, 647 puffs_framev_cmpframe_fn, 648 puffs_framev_gotframe_fn, 649 puffs_framev_fdnotify_fn); 650 651 struct puffs_framebuf *puffs_framebuf_make(void); 652 void puffs_framebuf_destroy(struct puffs_framebuf *); 653 void puffs_framebuf_recycle(struct puffs_framebuf *); 654 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 655 size_t); 656 657 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 658 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 659 const void *, size_t); 660 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 661 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 662 void *, size_t); 663 664 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 665 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 666 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 667 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 668 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 669 void **, size_t *); 670 671 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 672 struct puffs_framebuf *, int); 673 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 674 struct puffs_framebuf *, 675 puffs_framev_cb, void *, int); 676 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 677 struct puffs_framebuf *, int, int); 678 int puffs_framev_enqueue_directreceive(struct puffs_cc *, int, 679 struct puffs_framebuf *, int); 680 int puffs_framev_enqueue_directsend(struct puffs_cc *, int, 681 struct puffs_framebuf *, int); 682 int puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *); 683 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 684 struct puffs_cc *); 685 686 int puffs_framev_addfd(struct puffs_usermount *, int, int); 687 int puffs_framev_enablefd(struct puffs_usermount *, int, int); 688 int puffs_framev_disablefd(struct puffs_usermount *, int, int); 689 int puffs_framev_removefd(struct puffs_usermount *, int, int); 690 void puffs_framev_removeonclose(struct puffs_usermount *, int, int); 691 void puffs_framev_unmountonclose(struct puffs_usermount *, int, int); 692 693 __END_DECLS 694 695 #endif /* _PUFFS_H_ */ 696
Indexes created Tue Sep 30 10:09:55 GMT 2025