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