puffs.h revision 1.86
1 /* $NetBSD: puffs.h,v 1.86 2007/10/11 19:41:15 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2005, 2006, 2007 Antti Kantee. All Rights Reserved. 5 * 6 * Development of this software was supported by the 7 * Google Summer of Code program and the Ulla Tuominen Foundation. 8 * The Google SoC project was mentored by Bill Studenmund. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #ifndef _PUFFS_H_ 33 #define _PUFFS_H_ 34 35 #include <sys/param.h> 36 #include <sys/types.h> 37 #include <sys/mount.h> 38 #include <sys/namei.h> 39 #include <sys/stat.h> 40 #include <sys/statvfs.h> 41 #include <sys/time.h> 42 #include <sys/vnode.h> 43 44 #include <fs/puffs/puffs_msgif.h> 45 46 #include <mntopts.h> 47 #include <string.h> 48 49 /* forwards */ 50 struct puffs_cc; 51 52 struct puffs_getreq; 53 struct puffs_putreq; 54 struct puffs_cred; 55 struct puffs_cid; 56 struct puffs_newinfo; 57 58 /* paths */ 59 struct puffs_pathobj { 60 void *po_path; 61 size_t po_len; 62 uint32_t po_hash; 63 }; 64 65 /* for prefix rename */ 66 struct puffs_pathinfo { 67 struct puffs_pathobj *pi_old; 68 struct puffs_pathobj *pi_new; 69 }; 70 71 /* describes one segment cached in the kernel */ 72 struct puffs_kcache { 73 off_t pkc_start; 74 off_t pkc_end; 75 76 LIST_ENTRY(puffs_kcache) pkc_entries; 77 }; 78 79 /* XXX: might disappear from here into a private header */ 80 struct puffs_node { 81 off_t pn_size; 82 int pn_flags; 83 struct vattr pn_va; 84 85 void *pn_data; /* private data */ 86 87 struct puffs_pathobj pn_po; /* PUFFS_FLAG_BUILDPATH */ 88 89 struct puffs_usermount *pn_mnt; 90 LIST_ENTRY(puffs_node) pn_entries; 91 92 LIST_HEAD(,puffs_kcache)pn_cacheinfo; /* PUFFS_KFLAG_CACHE */ 93 }; 94 #define PUFFS_NODE_REMOVED 0x01 /* not on entry list */ 95 96 97 struct puffs_usermount; 98 99 /* 100 * megaXXX: these are values from inside _KERNEL 101 * need to work on the translation for ALL the necessary values. 102 */ 103 #define PUFFS_VNOVAL (-1) 104 105 #define PUFFS_IO_APPEND 0x020 106 #define PUFFS_IO_NDELAY 0x100 107 108 #define PUFFS_VEXEC 01 109 #define PUFFS_VWRITE 02 110 #define PUFFS_VREAD 04 111 112 #define PUFFS_FSYNC_DATAONLY 0x0002 113 #define PUFFS_FSYNC_CACHE 0x0100 114 115 /* 116 * Magic constants 117 */ 118 #define PUFFS_CC_STACKSIZE_DEFAULT (1024*1024) 119 120 struct puffs_cn { 121 struct puffs_kcn *pcn_pkcnp; /* kernel input */ 122 123 struct puffs_cred *pcn_cred; /* cred used for lookup */ 124 struct puffs_cid *pcn_cid; /* the who called */ 125 126 struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 127 }; 128 #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 129 #define pcn_flags pcn_pkcnp->pkcn_flags 130 #define pcn_pid pcn_pkcnp->pkcn_pid 131 #define pcn_name pcn_pkcnp->pkcn_name 132 #define pcn_namelen pcn_pkcnp->pkcn_namelen 133 #define pcn_consume pcn_pkcnp->pkcn_consume 134 135 /* 136 * Puffs options to mount 137 */ 138 /* kernel */ 139 #define PUFFSMOPT_NAMECACHE { "namecache", 1, PUFFS_KFLAG_NOCACHE_NAME, 1 } 140 #define PUFFSMOPT_PAGECACHE { "pagecache", 1, PUFFS_KFLAG_NOCACHE_PAGE, 1 } 141 #define PUFFSMOPT_CACHE { "cache", 1, PUFFS_KFLAG_NOCACHE, 1 } 142 #define PUFFSMOPT_ALLOPS { "allops", 0, PUFFS_KFLAG_ALLOPS, 1 } 143 144 /* libpuffs */ 145 #define PUFFSMOPT_DUMP { "dump", 0, PUFFS_FLAG_OPDUMP, 1 } 146 147 #define PUFFSMOPT_STD \ 148 PUFFSMOPT_NAMECACHE, \ 149 PUFFSMOPT_PAGECACHE, \ 150 PUFFSMOPT_CACHE, \ 151 PUFFSMOPT_ALLOPS, \ 152 PUFFSMOPT_DUMP 153 154 extern const struct mntopt puffsmopts[]; /* puffs.c */ 155 156 /* callbacks for operations */ 157 struct puffs_ops { 158 int (*puffs_fs_unmount)(struct puffs_cc *, int, 159 const struct puffs_cid *); 160 int (*puffs_fs_statvfs)(struct puffs_cc *, 161 struct statvfs *, const struct puffs_cid *); 162 int (*puffs_fs_sync)(struct puffs_cc *, int, 163 const struct puffs_cred *, const struct puffs_cid *); 164 int (*puffs_fs_fhtonode)(struct puffs_cc *, void *, size_t, 165 struct puffs_newinfo *); 166 int (*puffs_fs_nodetofh)(struct puffs_cc *, void *cookie, 167 void *, size_t *); 168 void (*puffs_fs_suspend)(struct puffs_cc *, int); 169 170 int (*puffs_node_lookup)(struct puffs_cc *, 171 void *, struct puffs_newinfo *, const struct puffs_cn *); 172 int (*puffs_node_create)(struct puffs_cc *, 173 void *, struct puffs_newinfo *, const struct puffs_cn *, 174 const struct vattr *); 175 int (*puffs_node_mknod)(struct puffs_cc *, 176 void *, struct puffs_newinfo *, const struct puffs_cn *, 177 const struct vattr *); 178 int (*puffs_node_open)(struct puffs_cc *, 179 void *, int, const struct puffs_cred *, const struct puffs_cid *); 180 int (*puffs_node_close)(struct puffs_cc *, 181 void *, int, const struct puffs_cred *, const struct puffs_cid *); 182 int (*puffs_node_access)(struct puffs_cc *, 183 void *, int, const struct puffs_cred *, const struct puffs_cid *); 184 int (*puffs_node_getattr)(struct puffs_cc *, 185 void *, struct vattr *, const struct puffs_cred *, 186 const struct puffs_cid *); 187 int (*puffs_node_setattr)(struct puffs_cc *, 188 void *, const struct vattr *, const struct puffs_cred *, 189 const struct puffs_cid *); 190 int (*puffs_node_poll)(struct puffs_cc *, void *, int *, 191 const struct puffs_cid *); 192 int (*puffs_node_mmap)(struct puffs_cc *, 193 void *, vm_prot_t, const struct puffs_cred *, 194 const struct puffs_cid *); 195 int (*puffs_node_fsync)(struct puffs_cc *, 196 void *, const struct puffs_cred *, int, off_t, off_t, 197 const struct puffs_cid *); 198 int (*puffs_node_seek)(struct puffs_cc *, 199 void *, off_t, off_t, const struct puffs_cred *); 200 int (*puffs_node_remove)(struct puffs_cc *, 201 void *, void *, const struct puffs_cn *); 202 int (*puffs_node_link)(struct puffs_cc *, 203 void *, void *, const struct puffs_cn *); 204 int (*puffs_node_rename)(struct puffs_cc *, 205 void *, void *, const struct puffs_cn *, void *, void *, 206 const struct puffs_cn *); 207 int (*puffs_node_mkdir)(struct puffs_cc *, 208 void *, struct puffs_newinfo *, const struct puffs_cn *, 209 const struct vattr *); 210 int (*puffs_node_rmdir)(struct puffs_cc *, 211 void *, void *, const struct puffs_cn *); 212 int (*puffs_node_symlink)(struct puffs_cc *, 213 void *, struct puffs_newinfo *, const struct puffs_cn *, 214 const struct vattr *, 215 const char *); 216 int (*puffs_node_readdir)(struct puffs_cc *, 217 void *, struct dirent *, off_t *, size_t *, 218 const struct puffs_cred *, int *, off_t *, size_t *); 219 int (*puffs_node_readlink)(struct puffs_cc *, 220 void *, const struct puffs_cred *, char *, size_t *); 221 int (*puffs_node_reclaim)(struct puffs_cc *, 222 void *, const struct puffs_cid *); 223 int (*puffs_node_inactive)(struct puffs_cc *, 224 void *, const struct puffs_cid *); 225 int (*puffs_node_print)(struct puffs_cc *, 226 void *); 227 int (*puffs_node_pathconf)(struct puffs_cc *, 228 void *, int, int *); 229 int (*puffs_node_advlock)(struct puffs_cc *, 230 void *, void *, int, struct flock *, int); 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 /* XXX: this shouldn't be here */ 237 void (*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 typedef void (*pu_errnotify_fn)(struct puffs_usermount *, 257 uint8_t, int, const char *, void *); 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 *, vm_prot_t, 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_read(struct puffs_cc *, void *, \ 365 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 366 int fsname##_node_write(struct puffs_cc *, void *, \ 367 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 368 \ 369 int fsname##_cache_write(struct puffs_usermount *, void *, \ 370 size_t, struct puffs_cacheinfo *); 371 372 #define PUFFSOP_INIT(ops) \ 373 ops = malloc(sizeof(struct puffs_ops)); \ 374 memset(ops, 0, sizeof(struct puffs_ops)) 375 #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 376 (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 377 #define PUFFSOP_SETFSNOP(ops, opname) \ 378 (ops)->puffs_fs_##opname = puffs_fsnop_##opname 379 380 PUFFSOP_PROTOS(puffs_null) /* XXX */ 381 382 #define PUFFS_DEVEL_LIBVERSION 28 383 #define puffs_init(a,b,c,d,e) \ 384 _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e) 385 386 387 #define PNPATH(pnode) ((pnode)->pn_po.po_path) 388 #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 389 #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 390 #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 391 #define PCNISDOTDOT(pcnode) \ 392 ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 393 394 #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 395 if (cp) { \ 396 *((cp)++) = off; \ 397 (*(ncp))++; \ 398 } 399 400 /* mainloop */ 401 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 402 403 /* framebuf stuff */ 404 struct puffs_framebuf; 405 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 406 struct puffs_framebuf *, 407 int, int *); 408 typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 409 struct puffs_framebuf *, 410 int, int *); 411 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 412 struct puffs_framebuf *, 413 struct puffs_framebuf *, 414 int *); 415 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 416 typedef void (*puffs_framev_gotframe_fn)(struct puffs_usermount *, 417 struct puffs_framebuf *); 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_FBIO_ERROR 0x04 424 425 #define PUFFS_FBQUEUE_URGENT 0x01 426 427 428 __BEGIN_DECLS 429 430 struct puffs_usermount *_puffs_init(int, struct puffs_ops *, const char *, 431 const char *, 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 struct vattr *puffs_pn_getvap(struct puffs_node *); 466 void * puffs_pn_getpriv(struct puffs_node *); 467 void puffs_pn_setpriv(struct puffs_node *, void *); 468 struct puffs_pathobj *puffs_pn_getpo(struct puffs_node *); 469 struct puffs_usermount *puffs_pn_getmnt(struct puffs_node *); 470 471 void puffs_newinfo_setcookie(struct puffs_newinfo *, void *); 472 void puffs_newinfo_setvtype(struct puffs_newinfo *, enum vtype); 473 void puffs_newinfo_setsize(struct puffs_newinfo *, voff_t); 474 void puffs_newinfo_setrdev(struct puffs_newinfo *, dev_t); 475 476 void *puffs_pn_getmntspecific(struct puffs_node *); 477 478 typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 479 struct puffs_node *, void *); 480 void *puffs_pn_nodewalk(struct puffs_usermount *, 481 puffs_nodewalk_fn, void *); 482 483 void puffs_setvattr(struct vattr *, const struct vattr *); 484 void puffs_vattr_null(struct vattr *); 485 486 void puffs_null_setops(struct puffs_ops *); 487 488 /* 489 * generic/dummy routines applicable for some file systems 490 */ 491 int puffs_fsnop_unmount(struct puffs_cc *, int, const struct puffs_cid *); 492 int puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, 493 const struct puffs_cid *); 494 void puffs_zerostatvfs(struct statvfs *); 495 int puffs_fsnop_sync(struct puffs_cc *, int waitfor, 496 const struct puffs_cred *, const struct puffs_cid *); 497 int puffs_genfs_node_reclaim(struct puffs_cc *, void *, 498 const struct puffs_cid *); 499 500 /* 501 * Subroutine stuff 502 */ 503 504 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 505 int puffs_nextdent(struct dirent **, const char *, ino_t, 506 uint8_t, size_t *); 507 int puffs_vtype2dt(enum vtype); 508 enum vtype puffs_mode2vt(mode_t); 509 void puffs_stat2vattr(struct vattr *va, const struct stat *); 510 mode_t puffs_addvtype2mode(mode_t, enum vtype); 511 512 513 /* 514 * credentials & permissions 515 */ 516 517 /* Credential fetch */ 518 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 519 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 520 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 521 522 /* Credential check */ 523 int puffs_cred_isuid(const struct puffs_cred *, uid_t); 524 int puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 525 int puffs_cred_isregular(const struct puffs_cred *); 526 int puffs_cred_iskernel(const struct puffs_cred *); 527 int puffs_cred_isfs(const struct puffs_cred *); 528 int puffs_cred_isjuggernaut(const struct puffs_cred *); 529 530 /* Caller ID */ 531 int puffs_cid_getpid(const struct puffs_cid *, pid_t *); 532 int puffs_cid_getlwpid(const struct puffs_cid *, lwpid_t *); 533 534 /* misc */ 535 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 536 const struct puffs_cred *); 537 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 538 const struct puffs_cred *); 539 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 540 const struct puffs_cred *); 541 int puffs_access_times(uid_t, gid_t, mode_t, int, 542 const struct puffs_cred *); 543 544 545 /* 546 * Requests 547 */ 548 549 struct puffs_getreq *puffs_req_makeget(struct puffs_usermount *, 550 size_t, int); 551 int puffs_req_loadget(struct puffs_getreq *); 552 struct puffs_req *puffs_req_get(struct puffs_getreq *); 553 int puffs_req_remainingget(struct puffs_getreq *); 554 void puffs_req_setmaxget(struct puffs_getreq *, int); 555 void puffs_req_destroyget(struct puffs_getreq *); 556 557 struct puffs_putreq *puffs_req_makeput(struct puffs_usermount *); 558 void puffs_req_put(struct puffs_putreq *,struct puffs_req *); 559 void puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*); 560 int puffs_req_putput(struct puffs_putreq *); 561 void puffs_req_resetput(struct puffs_putreq *); 562 void puffs_req_destroyput(struct puffs_putreq *); 563 564 int puffs_req_handle(struct puffs_getreq *, 565 struct puffs_putreq *, int); 566 567 /* 568 * Call Context interfaces relevant for user. 569 */ 570 571 void puffs_cc_yield(struct puffs_cc *); 572 void puffs_cc_continue(struct puffs_cc *); 573 struct puffs_usermount *puffs_cc_getusermount(struct puffs_cc *); 574 void *puffs_cc_getspecific(struct puffs_cc *); 575 576 /* 577 * Execute or continue a request 578 */ 579 580 int puffs_dopreq(struct puffs_usermount *, struct puffs_req *, 581 struct puffs_putreq *); 582 void puffs_docc(struct puffs_cc *, struct puffs_putreq *); 583 584 /* 585 * Flushing / invalidation routines 586 */ 587 588 int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 589 int puffs_inval_namecache_all(struct puffs_usermount *); 590 591 int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 592 int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 593 off_t, off_t); 594 int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 595 int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 596 off_t, off_t); 597 598 /* 599 * Path constructicons 600 */ 601 602 int puffs_stdpath_buildpath(struct puffs_usermount *, 603 const struct puffs_pathobj *, 604 const struct puffs_pathobj *, size_t, 605 struct puffs_pathobj *); 606 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 607 struct puffs_pathobj *, size_t, int); 608 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 609 610 void *puffs_path_walkcmp(struct puffs_usermount *, 611 struct puffs_node *, void *); 612 void *puffs_path_prefixadj(struct puffs_usermount *, 613 struct puffs_node *, void *); 614 int puffs_path_pcnbuild(struct puffs_usermount *, 615 struct puffs_cn *, void *); 616 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 617 618 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 619 void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 620 void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 621 void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 622 void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 623 624 void puffs_set_errnotify(struct puffs_usermount *, pu_errnotify_fn); 625 626 /* 627 * Suspension 628 */ 629 630 int puffs_fs_suspend(struct puffs_usermount *); 631 632 /* 633 * Frame buffering 634 */ 635 636 void puffs_framev_init(struct puffs_usermount *, 637 puffs_framev_readframe_fn, 638 puffs_framev_writeframe_fn, 639 puffs_framev_cmpframe_fn, 640 puffs_framev_gotframe_fn, 641 puffs_framev_fdnotify_fn); 642 643 struct puffs_framebuf *puffs_framebuf_make(void); 644 void puffs_framebuf_destroy(struct puffs_framebuf *); 645 void puffs_framebuf_recycle(struct puffs_framebuf *); 646 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 647 size_t); 648 649 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 650 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 651 const void *, size_t); 652 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 653 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 654 void *, size_t); 655 656 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 657 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 658 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 659 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 660 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 661 void **, size_t *); 662 663 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 664 struct puffs_framebuf *, int); 665 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 666 struct puffs_framebuf *, 667 puffs_framev_cb, void *, int); 668 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 669 struct puffs_framebuf *, int, int); 670 int puffs_framev_enqueue_directreceive(struct puffs_cc *, int, 671 struct puffs_framebuf *, int); 672 int puffs_framev_enqueue_directsend(struct puffs_cc *, int, 673 struct puffs_framebuf *, int); 674 int puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *); 675 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 676 struct puffs_cc *); 677 678 int puffs_framev_addfd(struct puffs_usermount *, int, int); 679 int puffs_framev_enablefd(struct puffs_usermount *, int, int); 680 int puffs_framev_disablefd(struct puffs_usermount *, int, int); 681 int puffs_framev_removefd(struct puffs_usermount *, int, int); 682 void puffs_framev_removeonclose(struct puffs_usermount *, int, int); 683 void puffs_framev_unmountonclose(struct puffs_usermount *, int, int); 684 685 __END_DECLS 686 687 #endif /* _PUFFS_H_ */ 688
Indexes created Mon Sep 29 21:09:56 GMT 2025