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