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