puffs.h revision 1.77.4.2
1 /* $NetBSD: puffs.h,v 1.77.4.2 2007/07/27 08:28:17 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 *, vm_prot_t, const struct puffs_cred *, 193 const struct puffs_cid *); 194 int (*puffs_node_fsync)(struct puffs_cc *, 195 void *, const struct puffs_cred *, int, off_t, off_t, 196 const struct puffs_cid *); 197 int (*puffs_node_seek)(struct puffs_cc *, 198 void *, off_t, off_t, const struct puffs_cred *); 199 int (*puffs_node_remove)(struct puffs_cc *, 200 void *, void *, const struct puffs_cn *); 201 int (*puffs_node_link)(struct puffs_cc *, 202 void *, void *, const struct puffs_cn *); 203 int (*puffs_node_rename)(struct puffs_cc *, 204 void *, void *, const struct puffs_cn *, void *, void *, 205 const struct puffs_cn *); 206 int (*puffs_node_mkdir)(struct puffs_cc *, 207 void *, struct puffs_newinfo *, const struct puffs_cn *, 208 const struct vattr *); 209 int (*puffs_node_rmdir)(struct puffs_cc *, 210 void *, void *, const struct puffs_cn *); 211 int (*puffs_node_symlink)(struct puffs_cc *, 212 void *, struct puffs_newinfo *, const struct puffs_cn *, 213 const struct vattr *, 214 const char *); 215 int (*puffs_node_readdir)(struct puffs_cc *, 216 void *, struct dirent *, off_t *, size_t *, 217 const struct puffs_cred *, int *, off_t *, size_t *); 218 int (*puffs_node_readlink)(struct puffs_cc *, 219 void *, const struct puffs_cred *, char *, size_t *); 220 int (*puffs_node_reclaim)(struct puffs_cc *, 221 void *, const struct puffs_cid *); 222 int (*puffs_node_inactive)(struct puffs_cc *, 223 void *, const struct puffs_cid *); 224 int (*puffs_node_print)(struct puffs_cc *, 225 void *); 226 int (*puffs_node_pathconf)(struct puffs_cc *, 227 void *, int, int *); 228 int (*puffs_node_advlock)(struct puffs_cc *, 229 void *, void *, int, struct flock *, int); 230 int (*puffs_node_getextattr)(struct puffs_cc *, 231 void *, struct puffs_vnreq_getextattr *); 232 int (*puffs_node_setextattr)(struct puffs_cc *, 233 void *, struct puffs_vnreq_setextattr *); 234 int (*puffs_node_listextattr)(struct puffs_cc *, 235 void *, struct puffs_vnreq_listextattr *); 236 int (*puffs_node_read)(struct puffs_cc *, void *, 237 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 238 int (*puffs_node_write)(struct puffs_cc *, void *, 239 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 240 241 int (*puffs_cache_write)(struct puffs_usermount *, 242 void *, size_t, struct puffs_cacherun *); 243 }; 244 245 typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 246 const struct puffs_pathobj *, 247 const struct puffs_pathobj *, size_t, 248 struct puffs_pathobj *); 249 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 250 const struct puffs_pathobj *, 251 const struct puffs_cn *, 252 struct puffs_pathobj *); 253 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 254 struct puffs_pathobj *, size_t, int); 255 typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 256 struct puffs_pathobj *); 257 typedef int (*pu_namemod_fn)(struct puffs_usermount *, 258 struct puffs_pathobj *, struct puffs_cn *); 259 260 enum { 261 PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 262 PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 263 }; 264 265 #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 266 #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 267 #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 268 #define PUFFS_FLAG_MASK 0xe0000000 269 270 #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 271 #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 272 273 /* blocking mode argument */ 274 #define PUFFSDEV_BLOCK 0 275 #define PUFFSDEV_NONBLOCK 1 276 277 /* mainloop flags */ 278 #define PUFFSLOOP_NODAEMON 0x01 279 280 #define DENT_DOT 0 281 #define DENT_DOTDOT 1 282 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 283 284 285 /* 286 * protos 287 */ 288 289 #define PUFFSOP_PROTOS(fsname) \ 290 int fsname##_fs_unmount(struct puffs_cc *, int, \ 291 const struct puffs_cid *); \ 292 int fsname##_fs_statvfs(struct puffs_cc *, \ 293 struct statvfs *, const struct puffs_cid *); \ 294 int fsname##_fs_sync(struct puffs_cc *, int, \ 295 const struct puffs_cred *cred, const struct puffs_cid *); \ 296 int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t, \ 297 struct puffs_newinfo *); \ 298 int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie, \ 299 void *, size_t *); \ 300 void fsname##_fs_suspend(struct puffs_cc *, int); \ 301 \ 302 int fsname##_node_lookup(struct puffs_cc *, \ 303 void *, struct puffs_newinfo *, const struct puffs_cn *); \ 304 int fsname##_node_create(struct puffs_cc *, \ 305 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 306 const struct vattr *); \ 307 int fsname##_node_mknod(struct puffs_cc *, \ 308 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 309 const struct vattr *); \ 310 int fsname##_node_open(struct puffs_cc *, \ 311 void *, int, const struct puffs_cred *, \ 312 const struct puffs_cid *); \ 313 int fsname##_node_close(struct puffs_cc *, \ 314 void *, int, const struct puffs_cred *, \ 315 const struct puffs_cid *); \ 316 int fsname##_node_access(struct puffs_cc *, \ 317 void *, int, const struct puffs_cred *, \ 318 const struct puffs_cid *); \ 319 int fsname##_node_getattr(struct puffs_cc *, \ 320 void *, struct vattr *, const struct puffs_cred *, \ 321 const struct puffs_cid *); \ 322 int fsname##_node_setattr(struct puffs_cc *, \ 323 void *, const struct vattr *, const struct puffs_cred *, \ 324 const struct puffs_cid *); \ 325 int fsname##_node_poll(struct puffs_cc *, void *, int *, \ 326 const struct puffs_cid *); \ 327 int fsname##_node_mmap(struct puffs_cc *, \ 328 void *, vm_prot_t, const struct puffs_cred *, \ 329 const struct puffs_cid *); \ 330 int fsname##_node_fsync(struct puffs_cc *, \ 331 void *, const struct puffs_cred *, int, off_t, off_t, \ 332 const struct puffs_cid *); \ 333 int fsname##_node_seek(struct puffs_cc *, \ 334 void *, off_t, off_t, const struct puffs_cred *); \ 335 int fsname##_node_remove(struct puffs_cc *, \ 336 void *, void *, const struct puffs_cn *); \ 337 int fsname##_node_link(struct puffs_cc *, \ 338 void *, void *, const struct puffs_cn *); \ 339 int fsname##_node_rename(struct puffs_cc *, \ 340 void *, void *, const struct puffs_cn *, void *, void *, \ 341 const struct puffs_cn *); \ 342 int fsname##_node_mkdir(struct puffs_cc *, \ 343 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 344 const struct vattr *); \ 345 int fsname##_node_rmdir(struct puffs_cc *, \ 346 void *, void *, const struct puffs_cn *); \ 347 int fsname##_node_symlink(struct puffs_cc *, \ 348 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 349 const struct vattr *, const char *); \ 350 int fsname##_node_readdir(struct puffs_cc *, \ 351 void *, struct dirent *, off_t *, size_t *, \ 352 const struct puffs_cred *, int *, off_t *, size_t *); \ 353 int fsname##_node_readlink(struct puffs_cc *, \ 354 void *, const struct puffs_cred *, char *, size_t *); \ 355 int fsname##_node_reclaim(struct puffs_cc *, \ 356 void *, const struct puffs_cid *); \ 357 int fsname##_node_inactive(struct puffs_cc *, \ 358 void *, const struct puffs_cid *); \ 359 int fsname##_node_print(struct puffs_cc *, \ 360 void *); \ 361 int fsname##_node_pathconf(struct puffs_cc *, \ 362 void *, int, int *); \ 363 int fsname##_node_advlock(struct puffs_cc *, \ 364 void *, void *, int, struct flock *, int); \ 365 int fsname##_node_getextattr(struct puffs_cc *, \ 366 void *, struct puffs_vnreq_getextattr *); \ 367 int fsname##_node_setextattr(struct puffs_cc *, \ 368 void *, struct puffs_vnreq_setextattr *); \ 369 int fsname##_node_listextattr(struct puffs_cc *, \ 370 void *, struct puffs_vnreq_listextattr *); \ 371 int fsname##_node_read(struct puffs_cc *, void *, \ 372 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 373 int fsname##_node_write(struct puffs_cc *, void *, \ 374 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 375 \ 376 int fsname##_cache_write(struct puffs_usermount *, void *, \ 377 size_t, struct puffs_cacheinfo *); 378 379 #define PUFFSOP_INIT(ops) \ 380 ops = malloc(sizeof(struct puffs_ops)); \ 381 memset(ops, 0, sizeof(struct puffs_ops)) 382 #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 383 (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 384 #define PUFFSOP_SETFSNOP(ops, opname) \ 385 (ops)->puffs_fs_##opname = puffs_fsnop_##opname 386 387 PUFFSOP_PROTOS(puffs_null) /* XXX */ 388 389 #define PUFFS_DEVEL_LIBVERSION 25 390 #define puffs_init(a,b,c,d,e) \ 391 _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e) 392 393 394 #define PNPATH(pnode) ((pnode)->pn_po.po_path) 395 #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 396 #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 397 #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 398 #define PCNISDOTDOT(pcnode) \ 399 ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 400 401 #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 402 if (cp) { \ 403 *((cp)++) = off; \ 404 (*(ncp))++; \ 405 } 406 407 /* mainloop */ 408 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 409 410 /* framebuf stuff */ 411 struct puffs_framebuf; 412 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 413 struct puffs_framebuf *, 414 int, int *); 415 typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 416 struct puffs_framebuf *, 417 int, int *); 418 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 419 struct puffs_framebuf *, 420 struct puffs_framebuf *); 421 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 422 typedef void (*puffs_framev_cb)(struct puffs_usermount *, 423 struct puffs_framebuf *, 424 void *, int); 425 #define PUFFS_FBIO_READ 0x01 426 #define PUFFS_FBIO_WRITE 0x02 427 #define PUFFS_FBIO_ERROR 0x04 428 429 #define PUFFS_FBQUEUE_URGENT 0x01 430 431 432 __BEGIN_DECLS 433 434 struct puffs_usermount *_puffs_init(int, struct puffs_ops *, const char *, 435 const char *, void *, uint32_t); 436 int puffs_mount(struct puffs_usermount *, const char *, int, void*); 437 int puffs_exit(struct puffs_usermount *, int); 438 int puffs_mainloop(struct puffs_usermount *, int); 439 440 441 int puffs_getselectable(struct puffs_usermount *); 442 int puffs_setblockingmode(struct puffs_usermount *, int); 443 int puffs_getstate(struct puffs_usermount *); 444 void puffs_setstacksize(struct puffs_usermount *, size_t); 445 446 void puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn); 447 void puffs_ml_settimeout(struct puffs_usermount *, struct timespec *); 448 449 void puffs_setroot(struct puffs_usermount *, 450 struct puffs_node *); 451 struct puffs_node *puffs_getroot(struct puffs_usermount *); 452 void puffs_setrootinfo(struct puffs_usermount *, 453 enum vtype, vsize_t, dev_t); 454 455 void *puffs_getspecific(struct puffs_usermount *); 456 void puffs_setmaxreqlen(struct puffs_usermount *, size_t); 457 size_t puffs_getmaxreqlen(struct puffs_usermount *); 458 void puffs_setfhsize(struct puffs_usermount *, size_t, int); 459 460 void puffs_setncookiehash(struct puffs_usermount *, int); 461 462 struct puffs_pathobj *puffs_getrootpathobj(struct puffs_usermount *); 463 464 void puffs_setback(struct puffs_cc *, int); 465 466 struct puffs_node *puffs_pn_new(struct puffs_usermount *, void *); 467 void puffs_pn_remove(struct puffs_node *); 468 void puffs_pn_put(struct puffs_node *); 469 470 void puffs_newinfo_setcookie(struct puffs_newinfo *, void *); 471 void puffs_newinfo_setvtype(struct puffs_newinfo *, enum vtype); 472 void puffs_newinfo_setsize(struct puffs_newinfo *, voff_t); 473 void puffs_newinfo_setrdev(struct puffs_newinfo *, dev_t); 474 475 void *puffs_pn_getmntspecific(struct puffs_node *); 476 477 typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 478 struct puffs_node *, void *); 479 void *puffs_pn_nodewalk(struct puffs_usermount *, 480 puffs_nodewalk_fn, void *); 481 482 void puffs_setvattr(struct vattr *, const struct vattr *); 483 void puffs_vattr_null(struct vattr *); 484 485 void puffs_null_setops(struct puffs_ops *); 486 487 /* 488 * generic/dummy routines applicable for some file systems 489 */ 490 int puffs_fsnop_unmount(struct puffs_cc *, int, const struct puffs_cid *); 491 int puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, 492 const struct puffs_cid *); 493 void puffs_zerostatvfs(struct statvfs *); 494 int puffs_fsnop_sync(struct puffs_cc *, int waitfor, 495 const struct puffs_cred *, const struct puffs_cid *); 496 int puffs_genfs_node_reclaim(struct puffs_cc *, void *, 497 const struct puffs_cid *); 498 499 /* 500 * Subroutine stuff 501 */ 502 503 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 504 int puffs_nextdent(struct dirent **, const char *, ino_t, 505 uint8_t, size_t *); 506 int puffs_vtype2dt(enum vtype); 507 enum vtype puffs_mode2vt(mode_t); 508 void puffs_stat2vattr(struct vattr *va, const struct stat *); 509 mode_t puffs_addvtype2mode(mode_t, enum vtype); 510 511 512 /* 513 * credentials & permissions 514 */ 515 516 /* Credential fetch */ 517 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 518 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 519 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 520 521 /* Credential check */ 522 int puffs_cred_isuid(const struct puffs_cred *, uid_t); 523 int puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 524 int puffs_cred_isregular(const struct puffs_cred *); 525 int puffs_cred_iskernel(const struct puffs_cred *); 526 int puffs_cred_isfs(const struct puffs_cred *); 527 int puffs_cred_isjuggernaut(const struct puffs_cred *); 528 529 /* Caller ID */ 530 int puffs_cid_getpid(const struct puffs_cid *, pid_t *); 531 int puffs_cid_getlwpid(const struct puffs_cid *, lwpid_t *); 532 533 /* misc */ 534 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 535 const struct puffs_cred *); 536 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 537 const struct puffs_cred *); 538 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 539 const struct puffs_cred *); 540 int puffs_access_times(uid_t, gid_t, mode_t, int, 541 const struct puffs_cred *); 542 543 544 /* 545 * Requests 546 */ 547 548 struct puffs_getreq *puffs_req_makeget(struct puffs_usermount *, 549 size_t, int); 550 int puffs_req_loadget(struct puffs_getreq *); 551 struct puffs_req *puffs_req_get(struct puffs_getreq *); 552 int puffs_req_remainingget(struct puffs_getreq *); 553 void puffs_req_setmaxget(struct puffs_getreq *, int); 554 void puffs_req_destroyget(struct puffs_getreq *); 555 556 struct puffs_putreq *puffs_req_makeput(struct puffs_usermount *); 557 void puffs_req_put(struct puffs_putreq *,struct puffs_req *); 558 void puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*); 559 int puffs_req_putput(struct puffs_putreq *); 560 void puffs_req_resetput(struct puffs_putreq *); 561 void puffs_req_destroyput(struct puffs_putreq *); 562 563 int puffs_req_handle(struct puffs_getreq *, 564 struct puffs_putreq *, int); 565 566 /* 567 * Call Context interfaces relevant for user. 568 */ 569 570 void puffs_cc_yield(struct puffs_cc *); 571 void puffs_cc_continue(struct puffs_cc *); 572 struct puffs_usermount *puffs_cc_getusermount(struct puffs_cc *); 573 void *puffs_cc_getspecific(struct puffs_cc *); 574 struct puffs_cc *puffs_cc_create(struct puffs_usermount *); 575 void puffs_cc_destroy(struct puffs_cc *); 576 577 /* 578 * Execute or continue a request 579 */ 580 581 int puffs_dopreq(struct puffs_usermount *, struct puffs_req *, 582 struct puffs_putreq *); 583 void puffs_docc(struct puffs_cc *, struct puffs_putreq *); 584 585 /* 586 * Flushing / invalidation routines 587 */ 588 589 int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 590 int puffs_inval_namecache_all(struct puffs_usermount *); 591 592 int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 593 int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 594 off_t, off_t); 595 int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 596 int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 597 off_t, off_t); 598 599 /* 600 * Path constructicons 601 */ 602 603 int puffs_stdpath_buildpath(struct puffs_usermount *, 604 const struct puffs_pathobj *, 605 const struct puffs_pathobj *, size_t, 606 struct puffs_pathobj *); 607 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 608 struct puffs_pathobj *, size_t, int); 609 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 610 611 void *puffs_path_walkcmp(struct puffs_usermount *, 612 struct puffs_node *, void *); 613 void *puffs_path_prefixadj(struct puffs_usermount *, 614 struct puffs_node *, void *); 615 int puffs_path_pcnbuild(struct puffs_usermount *, 616 struct puffs_cn *, void *); 617 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 618 619 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 620 void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 621 void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 622 void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 623 void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 624 625 /* 626 * Suspension 627 */ 628 629 int puffs_fs_suspend(struct puffs_usermount *); 630 631 /* 632 * Frame buffering 633 */ 634 635 void puffs_framev_init(struct puffs_usermount *, 636 puffs_framev_readframe_fn, 637 puffs_framev_writeframe_fn, 638 puffs_framev_cmpframe_fn, 639 puffs_framev_fdnotify_fn); 640 641 struct puffs_framebuf *puffs_framebuf_make(void); 642 void puffs_framebuf_destroy(struct puffs_framebuf *); 643 void puffs_framebuf_recycle(struct puffs_framebuf *); 644 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 645 size_t); 646 647 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 648 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 649 const void *, size_t); 650 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 651 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 652 void *, size_t); 653 654 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 655 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 656 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 657 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 658 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 659 void **, size_t *); 660 661 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 662 struct puffs_framebuf *, int); 663 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 664 struct puffs_framebuf *, 665 puffs_framev_cb, void *, int); 666 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 667 struct puffs_framebuf *, int, int); 668 int puffs_framev_enqueue_directreceive(struct puffs_cc *, int, 669 struct puffs_framebuf *, int); 670 int puffs_framev_enqueue_directsend(struct puffs_cc *, int, 671 struct puffs_framebuf *, int); 672 int puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *); 673 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 674 struct puffs_cc *); 675 676 int puffs_framev_addfd(struct puffs_usermount *, int, int); 677 int puffs_framev_enablefd(struct puffs_usermount *, int, int); 678 int puffs_framev_disablefd(struct puffs_usermount *, int, int); 679 int puffs_framev_removefd(struct puffs_usermount *, int, int); 680 void puffs_framev_removeonclose(struct puffs_usermount *, int, int); 681 void puffs_framev_unmountonclose(struct puffs_usermount *, int, int); 682 683 __END_DECLS 684 685 #endif /* _PUFFS_H_ */ 686
Indexes created Wed Oct 22 13:09:56 GMT 2025