puffs.h revision 1.97
1 /* $NetBSD: puffs.h,v 1.97 2007/11/30 19:02: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_putreq; 55 struct puffs_cred; 56 struct puffs_cid; 57 struct puffs_newinfo; 58 59 /* paths */ 60 struct puffs_pathobj { 61 void *po_path; 62 size_t po_len; 63 uint32_t po_hash; 64 }; 65 66 /* for prefix rename */ 67 struct puffs_pathinfo { 68 struct puffs_pathobj *pi_old; 69 struct puffs_pathobj *pi_new; 70 }; 71 72 /* describes one segment cached in the kernel */ 73 struct puffs_kcache { 74 off_t pkc_start; 75 off_t pkc_end; 76 77 LIST_ENTRY(puffs_kcache) pkc_entries; 78 }; 79 80 /* XXX: might disappear from here into a private header */ 81 struct puffs_node { 82 off_t pn_size; 83 int pn_flags; 84 struct vattr pn_va; 85 86 void *pn_data; /* private data */ 87 88 struct puffs_pathobj pn_po; /* PUFFS_FLAG_BUILDPATH */ 89 90 struct puffs_usermount *pn_mnt; 91 LIST_ENTRY(puffs_node) pn_entries; 92 93 LIST_HEAD(,puffs_kcache)pn_cacheinfo; /* PUFFS_KFLAG_CACHE */ 94 }; 95 #define PUFFS_NODE_REMOVED 0x01 /* not on entry list */ 96 97 98 struct puffs_usermount; 99 100 /* 101 * megaXXX: these are values from inside _KERNEL 102 * need to work on the translation for ALL the necessary values. 103 */ 104 #define PUFFS_VNOVAL (-1) 105 106 #define PUFFS_IO_APPEND 0x020 107 #define PUFFS_IO_NDELAY 0x100 108 109 #define PUFFS_VEXEC 01 110 #define PUFFS_VWRITE 02 111 #define PUFFS_VREAD 04 112 113 #define PUFFS_FSYNC_DATAONLY 0x0002 114 #define PUFFS_FSYNC_CACHE 0x0100 115 116 /* 117 * Magic constants 118 */ 119 #define PUFFS_CC_STACKSHIFT_DEFAULT 18 120 121 struct puffs_cn { 122 struct puffs_kcn *pcn_pkcnp; /* kernel input */ 123 124 struct puffs_cred *pcn_cred; /* cred used for lookup */ 125 struct puffs_cid *pcn_cid; /* the who called */ 126 127 struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 128 }; 129 #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 130 #define pcn_flags pcn_pkcnp->pkcn_flags 131 #define pcn_pid pcn_pkcnp->pkcn_pid 132 #define pcn_name pcn_pkcnp->pkcn_name 133 #define pcn_namelen pcn_pkcnp->pkcn_namelen 134 #define pcn_consume pcn_pkcnp->pkcn_consume 135 136 /* 137 * Puffs options to mount 138 */ 139 /* kernel */ 140 #define PUFFSMOPT_NAMECACHE { "namecache", 1, PUFFS_KFLAG_NOCACHE_NAME, 1 } 141 #define PUFFSMOPT_PAGECACHE { "pagecache", 1, PUFFS_KFLAG_NOCACHE_PAGE, 1 } 142 #define PUFFSMOPT_CACHE { "cache", 1, PUFFS_KFLAG_NOCACHE, 1 } 143 #define PUFFSMOPT_ALLOPS { "allops", 0, PUFFS_KFLAG_ALLOPS, 1 } 144 145 /* libpuffs */ 146 #define PUFFSMOPT_DUMP { "dump", 0, PUFFS_FLAG_OPDUMP, 1 } 147 148 #define PUFFSMOPT_STD \ 149 PUFFSMOPT_NAMECACHE, \ 150 PUFFSMOPT_PAGECACHE, \ 151 PUFFSMOPT_CACHE, \ 152 PUFFSMOPT_ALLOPS, \ 153 PUFFSMOPT_DUMP 154 155 extern const struct mntopt puffsmopts[]; /* puffs.c */ 156 157 /* callbacks for operations */ 158 struct puffs_ops { 159 int (*puffs_fs_unmount)(struct puffs_usermount *, int); 160 int (*puffs_fs_statvfs)(struct puffs_usermount *, struct statvfs *); 161 int (*puffs_fs_sync)(struct puffs_usermount *, int, 162 const struct puffs_cred *); 163 int (*puffs_fs_fhtonode)(struct puffs_usermount *, void *, size_t, 164 struct puffs_newinfo *); 165 int (*puffs_fs_nodetofh)(struct puffs_usermount *, void *cookie, 166 void *, size_t *); 167 void (*puffs_fs_suspend)(struct puffs_usermount *, int); 168 169 int (*puffs_node_lookup)(struct puffs_usermount *, 170 void *, struct puffs_newinfo *, const struct puffs_cn *); 171 int (*puffs_node_create)(struct puffs_usermount *, 172 void *, struct puffs_newinfo *, const struct puffs_cn *, 173 const struct vattr *); 174 int (*puffs_node_mknod)(struct puffs_usermount *, 175 void *, struct puffs_newinfo *, const struct puffs_cn *, 176 const struct vattr *); 177 int (*puffs_node_open)(struct puffs_usermount *, 178 void *, int, const struct puffs_cred *); 179 int (*puffs_node_close)(struct puffs_usermount *, 180 void *, int, const struct puffs_cred *); 181 int (*puffs_node_access)(struct puffs_usermount *, 182 void *, int, const struct puffs_cred *); 183 int (*puffs_node_getattr)(struct puffs_usermount *, 184 void *, struct vattr *, const struct puffs_cred *); 185 int (*puffs_node_setattr)(struct puffs_usermount *, 186 void *, const struct vattr *, const struct puffs_cred *); 187 int (*puffs_node_poll)(struct puffs_usermount *, void *, int *); 188 int (*puffs_node_mmap)(struct puffs_usermount *, 189 void *, vm_prot_t, const struct puffs_cred *); 190 int (*puffs_node_fsync)(struct puffs_usermount *, 191 void *, const struct puffs_cred *, int, off_t, off_t); 192 int (*puffs_node_seek)(struct puffs_usermount *, 193 void *, off_t, off_t, const struct puffs_cred *); 194 int (*puffs_node_remove)(struct puffs_usermount *, 195 void *, void *, const struct puffs_cn *); 196 int (*puffs_node_link)(struct puffs_usermount *, 197 void *, void *, const struct puffs_cn *); 198 int (*puffs_node_rename)(struct puffs_usermount *, 199 void *, void *, const struct puffs_cn *, void *, void *, 200 const struct puffs_cn *); 201 int (*puffs_node_mkdir)(struct puffs_usermount *, 202 void *, struct puffs_newinfo *, const struct puffs_cn *, 203 const struct vattr *); 204 int (*puffs_node_rmdir)(struct puffs_usermount *, 205 void *, void *, const struct puffs_cn *); 206 int (*puffs_node_symlink)(struct puffs_usermount *, 207 void *, struct puffs_newinfo *, const struct puffs_cn *, 208 const struct vattr *, 209 const char *); 210 int (*puffs_node_readdir)(struct puffs_usermount *, 211 void *, struct dirent *, off_t *, size_t *, 212 const struct puffs_cred *, int *, off_t *, size_t *); 213 int (*puffs_node_readlink)(struct puffs_usermount *, 214 void *, const struct puffs_cred *, char *, size_t *); 215 int (*puffs_node_reclaim)(struct puffs_usermount *, void *); 216 int (*puffs_node_inactive)(struct puffs_usermount *, void *); 217 int (*puffs_node_print)(struct puffs_usermount *, void *); 218 int (*puffs_node_pathconf)(struct puffs_usermount *, 219 void *, int, int *); 220 int (*puffs_node_advlock)(struct puffs_usermount *, 221 void *, void *, int, struct flock *, int); 222 int (*puffs_node_read)(struct puffs_usermount *, void *, 223 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 224 int (*puffs_node_write)(struct puffs_usermount *, void *, 225 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 226 227 /* XXX: this shouldn't be here */ 228 void (*puffs_cache_write)(struct puffs_usermount *, 229 void *, size_t, struct puffs_cacherun *); 230 }; 231 232 typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 233 const struct puffs_pathobj *, 234 const struct puffs_pathobj *, size_t, 235 struct puffs_pathobj *); 236 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 237 const struct puffs_pathobj *, 238 const struct puffs_cn *, 239 struct puffs_pathobj *); 240 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 241 struct puffs_pathobj *, size_t, int); 242 typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 243 struct puffs_pathobj *); 244 typedef int (*pu_namemod_fn)(struct puffs_usermount *, 245 struct puffs_pathobj *, struct puffs_cn *); 246 247 typedef void (*pu_errnotify_fn)(struct puffs_usermount *, 248 uint8_t, int, const char *, void *); 249 250 typedef void (*pu_prepost_fn)(struct puffs_usermount *); 251 252 enum { 253 PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 254 PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 255 }; 256 257 #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 258 #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 259 #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 260 #define PUFFS_FLAG_MASK 0xe0000000 261 262 #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 263 #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 264 265 /* blocking mode argument */ 266 #define PUFFSDEV_BLOCK 0 267 #define PUFFSDEV_NONBLOCK 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 31 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 /* 469 * generic/dummy routines applicable for some file systems 470 */ 471 int puffs_fsnop_unmount(struct puffs_usermount *, int); 472 int puffs_fsnop_statvfs(struct puffs_usermount *, struct statvfs *); 473 void puffs_zerostatvfs(struct statvfs *); 474 int puffs_fsnop_sync(struct puffs_usermount *, int waitfor, 475 const struct puffs_cred *); 476 int puffs_genfs_node_reclaim(struct puffs_usermount *, void *); 477 478 /* 479 * Subroutine stuff 480 */ 481 482 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 483 int puffs_nextdent(struct dirent **, const char *, ino_t, 484 uint8_t, size_t *); 485 int puffs_vtype2dt(enum vtype); 486 enum vtype puffs_mode2vt(mode_t); 487 void puffs_stat2vattr(struct vattr *va, const struct stat *); 488 mode_t puffs_addvtype2mode(mode_t, enum vtype); 489 490 491 /* 492 * credentials & permissions 493 */ 494 495 /* Credential fetch */ 496 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 497 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 498 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 499 500 /* Credential check */ 501 bool puffs_cred_isuid(const struct puffs_cred *, uid_t); 502 bool puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 503 bool puffs_cred_isregular(const struct puffs_cred *); 504 bool puffs_cred_iskernel(const struct puffs_cred *); 505 bool puffs_cred_isfs(const struct puffs_cred *); 506 bool puffs_cred_isjuggernaut(const struct puffs_cred *); 507 508 /* Caller ID */ 509 int puffs_cid_getpid(const struct puffs_cid *, pid_t *); 510 int puffs_cid_getlwpid(const struct puffs_cid *, lwpid_t *); 511 bool puffs_cid_isequal(const struct puffs_cid *, const struct puffs_cid *); 512 513 /* misc */ 514 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 515 const struct puffs_cred *); 516 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 517 const struct puffs_cred *); 518 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 519 const struct puffs_cred *); 520 int puffs_access_times(uid_t, gid_t, mode_t, int, 521 const struct puffs_cred *); 522 523 524 /* 525 * Requests 526 */ 527 528 struct puffs_getreq *puffs_req_makeget(struct puffs_usermount *, 529 size_t, int); 530 int puffs_req_loadget(struct puffs_getreq *); 531 struct puffs_req *puffs_req_get(struct puffs_getreq *); 532 int puffs_req_remainingget(struct puffs_getreq *); 533 void puffs_req_setmaxget(struct puffs_getreq *, int); 534 void puffs_req_destroyget(struct puffs_getreq *); 535 536 struct puffs_putreq *puffs_req_makeput(struct puffs_usermount *); 537 void puffs_req_put(struct puffs_putreq *,struct puffs_req *); 538 void puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*); 539 int puffs_req_putput(struct puffs_putreq *); 540 void puffs_req_resetput(struct puffs_putreq *); 541 void puffs_req_destroyput(struct puffs_putreq *); 542 543 int puffs_req_handle(struct puffs_getreq *, 544 struct puffs_putreq *, int); 545 546 /* 547 * Call Context interfaces relevant for user. 548 */ 549 550 void puffs_cc_yield(struct puffs_cc *); 551 void puffs_cc_continue(struct puffs_cc *); 552 void puffs_cc_schedule(struct puffs_cc *); 553 struct puffs_usermount *puffs_cc_getusermount(struct puffs_cc *); 554 void *puffs_cc_getspecific(struct puffs_cc *); 555 int puffs_cc_getcaller(struct puffs_cc *,pid_t *,lwpid_t *); 556 struct puffs_cc *puffs_cc_getcc(struct puffs_usermount *); 557 558 /* 559 * Execute or continue a request 560 */ 561 562 int puffs_dopreq(struct puffs_usermount *, struct puffs_req *, 563 struct puffs_putreq *); 564 void puffs_docc(struct puffs_cc *, struct puffs_putreq *); 565 566 /* 567 * Flushing / invalidation routines 568 */ 569 570 int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 571 int puffs_inval_namecache_all(struct puffs_usermount *); 572 573 int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 574 int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 575 off_t, off_t); 576 int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 577 int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 578 off_t, off_t); 579 580 /* 581 * Path constructicons 582 */ 583 584 int puffs_stdpath_buildpath(struct puffs_usermount *, 585 const struct puffs_pathobj *, 586 const struct puffs_pathobj *, size_t, 587 struct puffs_pathobj *); 588 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 589 struct puffs_pathobj *, size_t, int); 590 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 591 592 void *puffs_path_walkcmp(struct puffs_usermount *, 593 struct puffs_node *, void *); 594 void *puffs_path_prefixadj(struct puffs_usermount *, 595 struct puffs_node *, void *); 596 int puffs_path_pcnbuild(struct puffs_usermount *, 597 struct puffs_cn *, void *); 598 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 599 600 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 601 void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 602 void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 603 void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 604 void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 605 606 void puffs_set_errnotify(struct puffs_usermount *, pu_errnotify_fn); 607 void puffs_set_prepost(struct puffs_usermount *, 608 pu_prepost_fn, pu_prepost_fn); 609 610 /* 611 * Suspension 612 */ 613 614 int puffs_fs_suspend(struct puffs_usermount *); 615 616 /* 617 * Frame buffering 618 */ 619 620 void puffs_framev_init(struct puffs_usermount *, 621 puffs_framev_readframe_fn, 622 puffs_framev_writeframe_fn, 623 puffs_framev_cmpframe_fn, 624 puffs_framev_gotframe_fn, 625 puffs_framev_fdnotify_fn); 626 627 struct puffs_framebuf *puffs_framebuf_make(void); 628 void puffs_framebuf_destroy(struct puffs_framebuf *); 629 void puffs_framebuf_recycle(struct puffs_framebuf *); 630 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 631 size_t); 632 633 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 634 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 635 const void *, size_t); 636 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 637 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 638 void *, size_t); 639 640 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 641 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 642 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 643 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 644 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 645 void **, size_t *); 646 647 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 648 struct puffs_framebuf *, int); 649 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 650 struct puffs_framebuf *, 651 puffs_framev_cb, void *, int); 652 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 653 struct puffs_framebuf *, int, int); 654 int puffs_framev_enqueue_directreceive(struct puffs_cc *, int, 655 struct puffs_framebuf *, int); 656 int puffs_framev_enqueue_directsend(struct puffs_cc *, int, 657 struct puffs_framebuf *, int); 658 int puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *); 659 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 660 struct puffs_cc *); 661 662 int puffs_framev_addfd(struct puffs_usermount *, int, int); 663 int puffs_framev_enablefd(struct puffs_usermount *, int, int); 664 int puffs_framev_disablefd(struct puffs_usermount *, int, int); 665 int puffs_framev_removefd(struct puffs_usermount *, int, int); 666 void puffs_framev_removeonclose(struct puffs_usermount *, int, int); 667 void puffs_framev_unmountonclose(struct puffs_usermount *, int, int); 668 669 __END_DECLS 670 671 #endif /* _PUFFS_H_ */ 672
Indexes created Mon Sep 29 21:09:56 GMT 2025