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