puffs.h revision 1.107
1 /* $NetBSD: puffs.h,v 1.107 2008/01/29 10:07:29 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 <stdbool.h> 48 #include <string.h> 49 50 /* forwards */ 51 struct puffs_cc; 52 53 struct puffs_getreq; 54 struct puffs_cred; 55 struct puffs_newinfo; 56 57 /* paths */ 58 struct puffs_pathobj { 59 void *po_path; 60 size_t po_len; 61 uint32_t po_hash; 62 }; 63 64 /* for prefix rename */ 65 struct puffs_pathinfo { 66 struct puffs_pathobj *pi_old; 67 struct puffs_pathobj *pi_new; 68 }; 69 70 /* describes one segment cached in the kernel */ 71 struct puffs_kcache { 72 off_t pkc_start; 73 off_t pkc_end; 74 75 LIST_ENTRY(puffs_kcache) pkc_entries; 76 }; 77 78 /* XXX: might disappear from here into a private header */ 79 struct puffs_node { 80 off_t pn_size; 81 int pn_flags; 82 struct vattr pn_va; 83 84 void *pn_data; /* private data */ 85 86 struct puffs_pathobj pn_po; /* PUFFS_FLAG_BUILDPATH */ 87 88 struct puffs_usermount *pn_mnt; 89 LIST_ENTRY(puffs_node) pn_entries; 90 91 LIST_HEAD(,puffs_kcache)pn_cacheinfo; /* PUFFS_KFLAG_CACHE */ 92 }; 93 #define PUFFS_NODE_REMOVED 0x01 /* not on entry list */ 94 95 96 struct puffs_usermount; 97 98 /* 99 * megaXXX: these are values from inside _KERNEL 100 * need to work on the translation for ALL the necessary values. 101 */ 102 #define PUFFS_VNOVAL (-1) 103 104 #define PUFFS_IO_APPEND 0x020 105 #define PUFFS_IO_NDELAY 0x100 106 107 #define PUFFS_VEXEC 01 108 #define PUFFS_VWRITE 02 109 #define PUFFS_VREAD 04 110 111 #define PUFFS_FSYNC_DATAONLY 0x0002 112 #define PUFFS_FSYNC_CACHE 0x0100 113 114 /* 115 * Magic constants 116 */ 117 #define PUFFS_CC_STACKSHIFT_DEFAULT 18 118 119 struct puffs_cn { 120 struct puffs_kcn *pcn_pkcnp; /* kernel input */ 121 struct puffs_cred *pcn_cred; /* cred used for lookup */ 122 123 struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 124 }; 125 #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 126 #define pcn_flags pcn_pkcnp->pkcn_flags 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_usermount *, int); 155 int (*puffs_fs_statvfs)(struct puffs_usermount *, struct statvfs *); 156 int (*puffs_fs_sync)(struct puffs_usermount *, int, 157 const struct puffs_cred *); 158 int (*puffs_fs_fhtonode)(struct puffs_usermount *, void *, size_t, 159 struct puffs_newinfo *); 160 int (*puffs_fs_nodetofh)(struct puffs_usermount *, void *cookie, 161 void *, size_t *); 162 void (*puffs_fs_suspend)(struct puffs_usermount *, int); 163 164 int (*puffs_node_lookup)(struct puffs_usermount *, 165 void *, struct puffs_newinfo *, const struct puffs_cn *); 166 int (*puffs_node_create)(struct puffs_usermount *, 167 void *, struct puffs_newinfo *, const struct puffs_cn *, 168 const struct vattr *); 169 int (*puffs_node_mknod)(struct puffs_usermount *, 170 void *, struct puffs_newinfo *, const struct puffs_cn *, 171 const struct vattr *); 172 int (*puffs_node_open)(struct puffs_usermount *, 173 void *, int, const struct puffs_cred *); 174 int (*puffs_node_close)(struct puffs_usermount *, 175 void *, int, const struct puffs_cred *); 176 int (*puffs_node_access)(struct puffs_usermount *, 177 void *, int, const struct puffs_cred *); 178 int (*puffs_node_getattr)(struct puffs_usermount *, 179 void *, struct vattr *, const struct puffs_cred *); 180 int (*puffs_node_setattr)(struct puffs_usermount *, 181 void *, const struct vattr *, const struct puffs_cred *); 182 int (*puffs_node_poll)(struct puffs_usermount *, void *, int *); 183 int (*puffs_node_mmap)(struct puffs_usermount *, 184 void *, vm_prot_t, const struct puffs_cred *); 185 int (*puffs_node_fsync)(struct puffs_usermount *, 186 void *, const struct puffs_cred *, int, off_t, off_t); 187 int (*puffs_node_seek)(struct puffs_usermount *, 188 void *, off_t, off_t, const struct puffs_cred *); 189 int (*puffs_node_remove)(struct puffs_usermount *, 190 void *, void *, const struct puffs_cn *); 191 int (*puffs_node_link)(struct puffs_usermount *, 192 void *, void *, const struct puffs_cn *); 193 int (*puffs_node_rename)(struct puffs_usermount *, 194 void *, void *, const struct puffs_cn *, void *, void *, 195 const struct puffs_cn *); 196 int (*puffs_node_mkdir)(struct puffs_usermount *, 197 void *, struct puffs_newinfo *, const struct puffs_cn *, 198 const struct vattr *); 199 int (*puffs_node_rmdir)(struct puffs_usermount *, 200 void *, void *, const struct puffs_cn *); 201 int (*puffs_node_symlink)(struct puffs_usermount *, 202 void *, struct puffs_newinfo *, const struct puffs_cn *, 203 const struct vattr *, 204 const char *); 205 int (*puffs_node_readdir)(struct puffs_usermount *, 206 void *, struct dirent *, off_t *, size_t *, 207 const struct puffs_cred *, int *, off_t *, size_t *); 208 int (*puffs_node_readlink)(struct puffs_usermount *, 209 void *, const struct puffs_cred *, char *, size_t *); 210 int (*puffs_node_reclaim)(struct puffs_usermount *, void *); 211 int (*puffs_node_inactive)(struct puffs_usermount *, void *); 212 int (*puffs_node_print)(struct puffs_usermount *, void *); 213 int (*puffs_node_pathconf)(struct puffs_usermount *, 214 void *, int, int *); 215 int (*puffs_node_advlock)(struct puffs_usermount *, 216 void *, void *, int, struct flock *, int); 217 int (*puffs_node_read)(struct puffs_usermount *, void *, 218 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 219 int (*puffs_node_write)(struct puffs_usermount *, void *, 220 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 221 222 /* XXX: this shouldn't be here */ 223 void (*puffs_cache_write)(struct puffs_usermount *, 224 void *, size_t, struct puffs_cacherun *); 225 }; 226 227 typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 228 const struct puffs_pathobj *, 229 const struct puffs_pathobj *, size_t, 230 struct puffs_pathobj *); 231 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 232 const struct puffs_pathobj *, 233 const struct puffs_cn *, 234 struct puffs_pathobj *); 235 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 236 struct puffs_pathobj *, size_t, int); 237 typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 238 struct puffs_pathobj *); 239 typedef int (*pu_namemod_fn)(struct puffs_usermount *, 240 struct puffs_pathobj *, struct puffs_cn *); 241 242 typedef void (*pu_errnotify_fn)(struct puffs_usermount *, 243 uint8_t, int, const char *, void *); 244 245 typedef void (*pu_prepost_fn)(struct puffs_usermount *); 246 247 typedef struct puffs_node *(*pu_cmap_fn)(struct puffs_usermount *, void *); 248 249 enum { 250 PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 251 PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 252 }; 253 254 #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 255 #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 256 #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 257 #define PUFFS_FLAG_MASK 0xe0000000 258 259 #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 260 #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 261 262 /* blocking mode argument */ 263 #define PUFFSDEV_BLOCK 0 264 #define PUFFSDEV_NONBLOCK 1 265 266 #define PUFFS_STACKSIZE_DEFAULT (1<<PUFFS_CC_STACKSHIFT_DEFAULT) 267 #define PUFFS_STACKSIZE_MIN ((size_t)-1) 268 269 #define DENT_DOT 0 270 #define DENT_DOTDOT 1 271 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 272 273 274 /* 275 * protos 276 */ 277 278 #define PUFFSOP_PROTOS(fsname) \ 279 int fsname##_fs_unmount(struct puffs_usermount *, int); \ 280 int fsname##_fs_statvfs(struct puffs_usermount *, \ 281 struct statvfs *); \ 282 int fsname##_fs_sync(struct puffs_usermount *, int, \ 283 const struct puffs_cred *cred); \ 284 int fsname##_fs_fhtonode(struct puffs_usermount *, void *, \ 285 size_t, struct puffs_newinfo *); \ 286 int fsname##_fs_nodetofh(struct puffs_usermount *, void *cookie,\ 287 void *, size_t *); \ 288 void fsname##_fs_suspend(struct puffs_usermount *, int); \ 289 \ 290 int fsname##_node_lookup(struct puffs_usermount *, \ 291 void *, struct puffs_newinfo *, const struct puffs_cn *); \ 292 int fsname##_node_create(struct puffs_usermount *, \ 293 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 294 const struct vattr *); \ 295 int fsname##_node_mknod(struct puffs_usermount *, \ 296 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 297 const struct vattr *); \ 298 int fsname##_node_open(struct puffs_usermount *, \ 299 void *, int, const struct puffs_cred *); \ 300 int fsname##_node_close(struct puffs_usermount *, \ 301 void *, int, const struct puffs_cred *); \ 302 int fsname##_node_access(struct puffs_usermount *, \ 303 void *, int, const struct puffs_cred *); \ 304 int fsname##_node_getattr(struct puffs_usermount *, \ 305 void *, struct vattr *, const struct puffs_cred *); \ 306 int fsname##_node_setattr(struct puffs_usermount *, \ 307 void *, const struct vattr *, const struct puffs_cred *); \ 308 int fsname##_node_poll(struct puffs_usermount *, void *, int *);\ 309 int fsname##_node_mmap(struct puffs_usermount *, \ 310 void *, vm_prot_t, const struct puffs_cred *); \ 311 int fsname##_node_fsync(struct puffs_usermount *, \ 312 void *, const struct puffs_cred *, int, off_t, off_t); \ 313 int fsname##_node_seek(struct puffs_usermount *, \ 314 void *, off_t, off_t, const struct puffs_cred *); \ 315 int fsname##_node_remove(struct puffs_usermount *, \ 316 void *, void *, const struct puffs_cn *); \ 317 int fsname##_node_link(struct puffs_usermount *, \ 318 void *, void *, const struct puffs_cn *); \ 319 int fsname##_node_rename(struct puffs_usermount *, \ 320 void *, void *, const struct puffs_cn *, void *, void *, \ 321 const struct puffs_cn *); \ 322 int fsname##_node_mkdir(struct puffs_usermount *, \ 323 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 324 const struct vattr *); \ 325 int fsname##_node_rmdir(struct puffs_usermount *, \ 326 void *, void *, const struct puffs_cn *); \ 327 int fsname##_node_symlink(struct puffs_usermount *, \ 328 void *, struct puffs_newinfo *, const struct puffs_cn *, \ 329 const struct vattr *, const char *); \ 330 int fsname##_node_readdir(struct puffs_usermount *, \ 331 void *, struct dirent *, off_t *, size_t *, \ 332 const struct puffs_cred *, int *, off_t *, size_t *); \ 333 int fsname##_node_readlink(struct puffs_usermount *, \ 334 void *, const struct puffs_cred *, char *, size_t *); \ 335 int fsname##_node_reclaim(struct puffs_usermount *, void *); \ 336 int fsname##_node_inactive(struct puffs_usermount *, void *); \ 337 int fsname##_node_print(struct puffs_usermount *, \ 338 void *); \ 339 int fsname##_node_pathconf(struct puffs_usermount *, \ 340 void *, int, int *); \ 341 int fsname##_node_advlock(struct puffs_usermount *, \ 342 void *, void *, int, struct flock *, int); \ 343 int fsname##_node_read(struct puffs_usermount *, void *, \ 344 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 345 int fsname##_node_write(struct puffs_usermount *, void *, \ 346 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 347 \ 348 int fsname##_cache_write(struct puffs_usermount *, void *, \ 349 size_t, struct puffs_cacheinfo *); 350 351 #define PUFFSOP_INIT(ops) \ 352 ops = malloc(sizeof(struct puffs_ops)); \ 353 memset(ops, 0, sizeof(struct puffs_ops)) 354 #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 355 (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 356 #define PUFFSOP_SETFSNOP(ops, opname) \ 357 (ops)->puffs_fs_##opname = puffs_fsnop_##opname 358 359 PUFFSOP_PROTOS(puffs_null) /* XXX */ 360 361 #define PUFFS_DEVEL_LIBVERSION 34 362 #define puffs_init(a,b,c,d,e) \ 363 _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e) 364 365 366 #define PNPATH(pnode) ((pnode)->pn_po.po_path) 367 #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 368 #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 369 #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 370 #define PCNISDOTDOT(pcnode) \ 371 ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 372 373 #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 374 if (cp) { \ 375 *((cp)++) = off; \ 376 (*(ncp))++; \ 377 } 378 379 /* mainloop */ 380 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 381 382 /* framebuf stuff */ 383 struct puffs_framebuf; 384 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 385 struct puffs_framebuf *, 386 int, int *); 387 typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 388 struct puffs_framebuf *, 389 int, int *); 390 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 391 struct puffs_framebuf *, 392 struct puffs_framebuf *, 393 int *); 394 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 395 typedef void (*puffs_framev_gotframe_fn)(struct puffs_usermount *, 396 struct puffs_framebuf *); 397 typedef void (*puffs_framev_cb)(struct puffs_usermount *, 398 struct puffs_framebuf *, 399 void *, int); 400 #define PUFFS_FBIO_READ 0x01 401 #define PUFFS_FBIO_WRITE 0x02 402 #define PUFFS_FBIO_ERROR 0x04 403 404 #define PUFFS_FBQUEUE_URGENT 0x01 405 406 407 __BEGIN_DECLS 408 409 struct puffs_usermount *_puffs_init(int, struct puffs_ops *, const char *, 410 const char *, void *, uint32_t); 411 int puffs_mount(struct puffs_usermount *, const char *, int, void*); 412 int puffs_exit(struct puffs_usermount *, int); 413 int puffs_mainloop(struct puffs_usermount *); 414 int puffs_daemon(struct puffs_usermount *, int, int); 415 416 417 int puffs_getselectable(struct puffs_usermount *); 418 int puffs_setblockingmode(struct puffs_usermount *, int); 419 int puffs_getstate(struct puffs_usermount *); 420 void puffs_setstacksize(struct puffs_usermount *, size_t); 421 422 void puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn); 423 void puffs_ml_settimeout(struct puffs_usermount *, struct timespec *); 424 425 void puffs_setroot(struct puffs_usermount *, 426 struct puffs_node *); 427 struct puffs_node *puffs_getroot(struct puffs_usermount *); 428 void puffs_setrootinfo(struct puffs_usermount *, 429 enum vtype, vsize_t, dev_t); 430 431 void *puffs_getspecific(struct puffs_usermount *); 432 void puffs_setmaxreqlen(struct puffs_usermount *, size_t); 433 size_t puffs_getmaxreqlen(struct puffs_usermount *); 434 void puffs_setfhsize(struct puffs_usermount *, size_t, int); 435 436 void puffs_setncookiehash(struct puffs_usermount *, int); 437 438 struct puffs_pathobj *puffs_getrootpathobj(struct puffs_usermount *); 439 440 void puffs_setback(struct puffs_cc *, int); 441 442 struct puffs_node *puffs_pn_new(struct puffs_usermount *, void *); 443 void puffs_pn_remove(struct puffs_node *); 444 void puffs_pn_put(struct puffs_node *); 445 struct vattr *puffs_pn_getvap(struct puffs_node *); 446 void * puffs_pn_getpriv(struct puffs_node *); 447 void puffs_pn_setpriv(struct puffs_node *, void *); 448 struct puffs_pathobj *puffs_pn_getpo(struct puffs_node *); 449 struct puffs_usermount *puffs_pn_getmnt(struct puffs_node *); 450 451 void puffs_newinfo_setcookie(struct puffs_newinfo *, void *); 452 void puffs_newinfo_setvtype(struct puffs_newinfo *, enum vtype); 453 void puffs_newinfo_setsize(struct puffs_newinfo *, voff_t); 454 void puffs_newinfo_setrdev(struct puffs_newinfo *, dev_t); 455 456 void *puffs_pn_getmntspecific(struct puffs_node *); 457 458 typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 459 struct puffs_node *, void *); 460 void *puffs_pn_nodewalk(struct puffs_usermount *, 461 puffs_nodewalk_fn, void *); 462 463 void puffs_setvattr(struct vattr *, const struct vattr *); 464 void puffs_vattr_null(struct vattr *); 465 466 void puffs_null_setops(struct puffs_ops *); 467 468 int puffs_dispatch_create(struct puffs_usermount *, 469 struct puffs_framebuf *, 470 struct puffs_cc **); 471 int puffs_dispatch_exec(struct puffs_cc *, 472 struct puffs_framebuf **); 473 474 /* 475 * generic/dummy routines applicable for some file systems 476 */ 477 int puffs_fsnop_unmount(struct puffs_usermount *, int); 478 int puffs_fsnop_statvfs(struct puffs_usermount *, struct statvfs *); 479 void puffs_zerostatvfs(struct statvfs *); 480 int puffs_fsnop_sync(struct puffs_usermount *, int waitfor, 481 const struct puffs_cred *); 482 483 int puffs_genfs_node_getattr(struct puffs_usermount *, void *, 484 struct vattr *, const struct puffs_cred *); 485 int puffs_genfs_node_reclaim(struct puffs_usermount *, void *); 486 487 /* 488 * Subroutine stuff 489 */ 490 491 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 492 int puffs_nextdent(struct dirent **, const char *, ino_t, 493 uint8_t, size_t *); 494 int puffs_vtype2dt(enum vtype); 495 enum vtype puffs_mode2vt(mode_t); 496 void puffs_stat2vattr(struct vattr *va, const struct stat *); 497 mode_t puffs_addvtype2mode(mode_t, enum vtype); 498 499 500 /* 501 * credentials & permissions 502 */ 503 504 /* Credential fetch */ 505 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 506 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 507 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 508 509 /* Credential check */ 510 bool puffs_cred_isuid(const struct puffs_cred *, uid_t); 511 bool puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 512 bool puffs_cred_isregular(const struct puffs_cred *); 513 bool puffs_cred_iskernel(const struct puffs_cred *); 514 bool puffs_cred_isfs(const struct puffs_cred *); 515 bool puffs_cred_isjuggernaut(const struct puffs_cred *); 516 517 /* misc */ 518 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 519 const struct puffs_cred *); 520 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 521 const struct puffs_cred *); 522 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 523 const struct puffs_cred *); 524 int puffs_access_times(uid_t, gid_t, mode_t, int, 525 const struct puffs_cred *); 526 527 528 /* 529 * Call Context interfaces relevant for user. 530 */ 531 532 void puffs_cc_yield(struct puffs_cc *); 533 void puffs_cc_continue(struct puffs_cc *); 534 void puffs_cc_schedule(struct puffs_cc *); 535 int puffs_cc_getcaller(struct puffs_cc *,pid_t *,lwpid_t *); 536 struct puffs_cc *puffs_cc_getcc(struct puffs_usermount *); 537 538 /* 539 * Flushing / invalidation routines 540 */ 541 542 int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 543 int puffs_inval_namecache_all(struct puffs_usermount *); 544 545 int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 546 int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 547 off_t, off_t); 548 int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 549 int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 550 off_t, off_t); 551 552 /* 553 * Path constructicons 554 */ 555 556 int puffs_stdpath_buildpath(struct puffs_usermount *, 557 const struct puffs_pathobj *, 558 const struct puffs_pathobj *, size_t, 559 struct puffs_pathobj *); 560 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 561 struct puffs_pathobj *, size_t, int); 562 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 563 564 void *puffs_path_walkcmp(struct puffs_usermount *, 565 struct puffs_node *, void *); 566 void *puffs_path_prefixadj(struct puffs_usermount *, 567 struct puffs_node *, void *); 568 int puffs_path_pcnbuild(struct puffs_usermount *, 569 struct puffs_cn *, void *); 570 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 571 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 572 void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 573 void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 574 void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 575 576 void puffs_set_errnotify(struct puffs_usermount *, pu_errnotify_fn); 577 void puffs_set_prepost(struct puffs_usermount *, 578 pu_prepost_fn, pu_prepost_fn); 579 void puffs_set_cmap(struct puffs_usermount *, pu_cmap_fn); 580 581 /* 582 * Suspension 583 */ 584 585 int puffs_fs_suspend(struct puffs_usermount *); 586 587 /* 588 * Frame buffering 589 */ 590 591 void puffs_framev_init(struct puffs_usermount *, 592 puffs_framev_readframe_fn, 593 puffs_framev_writeframe_fn, 594 puffs_framev_cmpframe_fn, 595 puffs_framev_gotframe_fn, 596 puffs_framev_fdnotify_fn); 597 598 struct puffs_framebuf *puffs_framebuf_make(void); 599 void puffs_framebuf_destroy(struct puffs_framebuf *); 600 int puffs_framebuf_dup(struct puffs_framebuf *, 601 struct puffs_framebuf **); 602 void puffs_framebuf_recycle(struct puffs_framebuf *); 603 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 604 size_t); 605 606 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 607 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 608 const void *, size_t); 609 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 610 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 611 void *, size_t); 612 613 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 614 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 615 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 616 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 617 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 618 void **, size_t *); 619 620 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 621 struct puffs_framebuf *, int); 622 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 623 struct puffs_framebuf *, 624 puffs_framev_cb, void *, int); 625 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 626 struct puffs_framebuf *, int, int); 627 int puffs_framev_enqueue_directreceive(struct puffs_cc *, int, 628 struct puffs_framebuf *, int); 629 int puffs_framev_enqueue_directsend(struct puffs_cc *, int, 630 struct puffs_framebuf *, int); 631 int puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *); 632 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 633 struct puffs_cc *); 634 635 int puffs_framev_addfd(struct puffs_usermount *, int, int); 636 int puffs_framev_enablefd(struct puffs_usermount *, int, int); 637 int puffs_framev_disablefd(struct puffs_usermount *, int, int); 638 int puffs_framev_removefd(struct puffs_usermount *, int, int); 639 void puffs_framev_removeonclose(struct puffs_usermount *, int, int); 640 void puffs_framev_unmountonclose(struct puffs_usermount *, int, int); 641 642 __END_DECLS 643 644 #endif /* _PUFFS_H_ */ 645
Indexes created Fri Sep 26 20:09:58 GMT 2025