puffs.h revision 1.68
1 /* $NetBSD: puffs.h,v 1.68 2007/07/01 17:22:18 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2005, 2006, 2007 Antti Kantee. All Rights Reserved. 5 * 6 * Development of this software was supported by the 7 * Google Summer of Code program and the Ulla Tuominen Foundation. 8 * The Google SoC project was mentored by Bill Studenmund. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #ifndef _PUFFS_H_ 33 #define _PUFFS_H_ 34 35 #include <sys/param.h> 36 #include <sys/types.h> 37 #include <sys/mount.h> 38 #include <sys/stat.h> 39 #include <sys/statvfs.h> 40 #include <sys/time.h> 41 #include <sys/vnode.h> 42 43 #include <fs/puffs/puffs_msgif.h> 44 45 #include <mntopts.h> 46 #include <string.h> 47 48 /* forwards */ 49 struct puffs_cc; 50 51 struct puffs_getreq; 52 struct puffs_putreq; 53 struct puffs_cred; 54 struct puffs_cid; 55 56 /* paths */ 57 struct puffs_pathobj { 58 void *po_path; 59 size_t po_len; 60 uint32_t po_hash; 61 }; 62 63 /* for prefix rename */ 64 struct puffs_pathinfo { 65 struct puffs_pathobj *pi_old; 66 struct puffs_pathobj *pi_new; 67 }; 68 69 /* describes one segment cached in the kernel */ 70 struct puffs_kcache { 71 off_t pkc_start; 72 off_t pkc_end; 73 74 LIST_ENTRY(puffs_kcache) pkc_entries; 75 }; 76 77 /* XXX: might disappear from here into a private header */ 78 struct puffs_node { 79 off_t pn_size; 80 int pn_flags; 81 struct vattr pn_va; 82 83 void *pn_data; /* private data */ 84 85 struct puffs_pathobj pn_po; /* PUFFS_FLAG_BUILDPATH */ 86 87 struct puffs_usermount *pn_mnt; 88 LIST_ENTRY(puffs_node) pn_entries; 89 90 LIST_HEAD(,puffs_kcache)pn_cacheinfo; /* PUFFS_KFLAG_CACHE */ 91 }; 92 #define PUFFS_NODE_REMOVED 0x01 /* not on entry list */ 93 94 95 struct puffs_usermount; 96 97 /* 98 * megaXXX: these are values from inside _KERNEL 99 * need to work on the translation for ALL the necessary values. 100 */ 101 #define PUFFS_VNOVAL (-1) 102 #define PUFFS_IO_APPEND 0x20 103 #define PUFFS_VEXEC 01 104 #define PUFFS_VWRITE 02 105 #define PUFFS_VREAD 04 106 107 #define PUFFS_FSYNC_DATAONLY 0x0002 108 #define PUFFS_FSYNC_CACHE 0x0100 109 110 /* 111 * Magic constants 112 */ 113 #define PUFFS_CC_STACKSIZE_DEFAULT (1024*1024) 114 115 struct puffs_cn { 116 struct puffs_kcn *pcn_pkcnp; /* kernel input */ 117 118 struct puffs_cred *pcn_cred; /* cred used for lookup */ 119 struct puffs_cid *pcn_cid; /* the who called */ 120 121 struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 122 }; 123 #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 124 #define pcn_flags pcn_pkcnp->pkcn_flags 125 #define pcn_pid pcn_pkcnp->pkcn_pid 126 #define pcn_name pcn_pkcnp->pkcn_name 127 #define pcn_namelen pcn_pkcnp->pkcn_namelen 128 129 /* 130 * Puffs options to mount 131 */ 132 /* kernel */ 133 #define PUFFSMOPT_NAMECACHE { "namecache", 1, PUFFS_KFLAG_NOCACHE_NAME, 1 } 134 #define PUFFSMOPT_PAGECACHE { "pagecache", 1, PUFFS_KFLAG_NOCACHE_PAGE, 1 } 135 #define PUFFSMOPT_CACHE { "cache", 1, PUFFS_KFLAG_NOCACHE, 1 } 136 #define PUFFSMOPT_ALLOPS { "allops", 0, PUFFS_KFLAG_ALLOPS, 1 } 137 138 /* libpuffs */ 139 #define PUFFSMOPT_DUMP { "dump", 0, PUFFS_FLAG_OPDUMP, 1 } 140 141 #define PUFFSMOPT_STD \ 142 PUFFSMOPT_NAMECACHE, \ 143 PUFFSMOPT_PAGECACHE, \ 144 PUFFSMOPT_CACHE, \ 145 PUFFSMOPT_ALLOPS, \ 146 PUFFSMOPT_DUMP 147 148 extern const struct mntopt puffsmopts[]; /* puffs.c */ 149 150 /* callbacks for operations */ 151 struct puffs_ops { 152 int (*puffs_fs_unmount)(struct puffs_cc *, int, 153 const struct puffs_cid *); 154 int (*puffs_fs_statvfs)(struct puffs_cc *, 155 struct statvfs *, const struct puffs_cid *); 156 int (*puffs_fs_sync)(struct puffs_cc *, int, 157 const struct puffs_cred *, const struct puffs_cid *); 158 int (*puffs_fs_fhtonode)(struct puffs_cc *, void *, size_t, 159 void **, enum vtype *, voff_t *, dev_t *); 160 int (*puffs_fs_nodetofh)(struct puffs_cc *, void *cookie, 161 void *, size_t *); 162 void (*puffs_fs_suspend)(struct puffs_cc *, int); 163 164 int (*puffs_node_lookup)(struct puffs_cc *, 165 void *, void **, enum vtype *, voff_t *, dev_t *, 166 const struct puffs_cn *); 167 int (*puffs_node_create)(struct puffs_cc *, 168 void *, void **, const struct puffs_cn *, const struct vattr *); 169 int (*puffs_node_mknod)(struct puffs_cc *, 170 void *, void **, const struct puffs_cn *, const struct vattr *); 171 int (*puffs_node_open)(struct puffs_cc *, 172 void *, int, const struct puffs_cred *, const struct puffs_cid *); 173 int (*puffs_node_close)(struct puffs_cc *, 174 void *, int, const struct puffs_cred *, const struct puffs_cid *); 175 int (*puffs_node_access)(struct puffs_cc *, 176 void *, int, const struct puffs_cred *, const struct puffs_cid *); 177 int (*puffs_node_getattr)(struct puffs_cc *, 178 void *, struct vattr *, const struct puffs_cred *, 179 const struct puffs_cid *); 180 int (*puffs_node_setattr)(struct puffs_cc *, 181 void *, const struct vattr *, const struct puffs_cred *, 182 const struct puffs_cid *); 183 int (*puffs_node_poll)(struct puffs_cc *, void *, int *, 184 const struct puffs_cid *); 185 int (*puffs_node_mmap)(struct puffs_cc *, 186 void *, int, const struct puffs_cred *, const struct puffs_cid *); 187 int (*puffs_node_fsync)(struct puffs_cc *, 188 void *, const struct puffs_cred *, int, off_t, off_t, 189 const struct puffs_cid *); 190 int (*puffs_node_seek)(struct puffs_cc *, 191 void *, off_t, off_t, const struct puffs_cred *); 192 int (*puffs_node_remove)(struct puffs_cc *, 193 void *, void *, const struct puffs_cn *); 194 int (*puffs_node_link)(struct puffs_cc *, 195 void *, void *, const struct puffs_cn *); 196 int (*puffs_node_rename)(struct puffs_cc *, 197 void *, void *, const struct puffs_cn *, void *, void *, 198 const struct puffs_cn *); 199 int (*puffs_node_mkdir)(struct puffs_cc *, 200 void *, void **, const struct puffs_cn *, const struct vattr *); 201 int (*puffs_node_rmdir)(struct puffs_cc *, 202 void *, void *, const struct puffs_cn *); 203 int (*puffs_node_symlink)(struct puffs_cc *, 204 void *, void **, const struct puffs_cn *, const struct vattr *, 205 const char *); 206 int (*puffs_node_readdir)(struct puffs_cc *, 207 void *, struct dirent *, off_t *, size_t *, 208 const struct puffs_cred *, int *, off_t *, size_t *); 209 int (*puffs_node_readlink)(struct puffs_cc *, 210 void *, const struct puffs_cred *, char *, size_t *); 211 int (*puffs_node_reclaim)(struct puffs_cc *, 212 void *, const struct puffs_cid *); 213 int (*puffs_node_inactive)(struct puffs_cc *, 214 void *, const struct puffs_cid *, int *); 215 int (*puffs_node_print)(struct puffs_cc *, 216 void *); 217 int (*puffs_node_pathconf)(struct puffs_cc *, 218 void *, int, int *); 219 int (*puffs_node_advlock)(struct puffs_cc *, 220 void *, void *, int, struct flock *, int); 221 int (*puffs_node_getextattr)(struct puffs_cc *, 222 void *, struct puffs_vnreq_getextattr *); 223 int (*puffs_node_setextattr)(struct puffs_cc *, 224 void *, struct puffs_vnreq_setextattr *); 225 int (*puffs_node_listextattr)(struct puffs_cc *, 226 void *, struct puffs_vnreq_listextattr *); 227 int (*puffs_node_read)(struct puffs_cc *, void *, 228 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 229 int (*puffs_node_write)(struct puffs_cc *, void *, 230 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 231 232 int (*puffs_cache_write)(struct puffs_usermount *, 233 void *, size_t, struct puffs_cacherun *); 234 }; 235 236 typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 237 const struct puffs_pathobj *, 238 const struct puffs_pathobj *, size_t, 239 struct puffs_pathobj *); 240 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 241 const struct puffs_pathobj *, 242 const struct puffs_cn *, 243 struct puffs_pathobj *); 244 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 245 struct puffs_pathobj *, size_t, int); 246 typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 247 struct puffs_pathobj *); 248 typedef int (*pu_namemod_fn)(struct puffs_usermount *, 249 struct puffs_pathobj *, struct puffs_cn *); 250 251 enum { 252 PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 253 PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 254 }; 255 256 #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 257 #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 258 #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 259 #define PUFFS_FLAG_MASK 0xe0000000 260 261 #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 262 #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 263 264 /* blocking mode argument */ 265 #define PUFFSDEV_BLOCK 0 266 #define PUFFSDEV_NONBLOCK 1 267 268 /* mainloop flags */ 269 #define PUFFSLOOP_NODAEMON 0x01 270 271 #define DENT_DOT 0 272 #define DENT_DOTDOT 1 273 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 274 275 276 /* 277 * protos 278 */ 279 280 #define PUFFSOP_PROTOS(fsname) \ 281 int fsname##_fs_mount(struct puffs_usermount *, void **, \ 282 struct statvfs *); \ 283 int fsname##_fs_unmount(struct puffs_cc *, int, \ 284 const struct puffs_cid *); \ 285 int fsname##_fs_statvfs(struct puffs_cc *, \ 286 struct statvfs *, const struct puffs_cid *); \ 287 int fsname##_fs_sync(struct puffs_cc *, int, \ 288 const struct puffs_cred *cred, const struct puffs_cid *); \ 289 int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t, \ 290 void **, enum vtype *, voff_t *, dev_t *); \ 291 int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie, \ 292 void *, size_t *); \ 293 void fsname##_fs_suspend(struct puffs_cc *, int); \ 294 \ 295 int fsname##_node_lookup(struct puffs_cc *, \ 296 void *, void **, enum vtype *, voff_t *, dev_t *, \ 297 const struct puffs_cn *); \ 298 int fsname##_node_create(struct puffs_cc *, \ 299 void *, void **, const struct puffs_cn *, \ 300 const struct vattr *); \ 301 int fsname##_node_mknod(struct puffs_cc *, \ 302 void *, void **, const struct puffs_cn *, \ 303 const struct vattr *); \ 304 int fsname##_node_open(struct puffs_cc *, \ 305 void *, int, const struct puffs_cred *, \ 306 const struct puffs_cid *); \ 307 int fsname##_node_close(struct puffs_cc *, \ 308 void *, int, const struct puffs_cred *, \ 309 const struct puffs_cid *); \ 310 int fsname##_node_access(struct puffs_cc *, \ 311 void *, int, const struct puffs_cred *, \ 312 const struct puffs_cid *); \ 313 int fsname##_node_getattr(struct puffs_cc *, \ 314 void *, struct vattr *, const struct puffs_cred *, \ 315 const struct puffs_cid *); \ 316 int fsname##_node_setattr(struct puffs_cc *, \ 317 void *, const struct vattr *, const struct puffs_cred *, \ 318 const struct puffs_cid *); \ 319 int fsname##_node_poll(struct puffs_cc *, void *, int *, \ 320 const struct puffs_cid *); \ 321 int fsname##_node_mmap(struct puffs_cc *, \ 322 void *, int, const struct puffs_cred *, \ 323 const struct puffs_cid *); \ 324 int fsname##_node_fsync(struct puffs_cc *, \ 325 void *, const struct puffs_cred *, int, off_t, off_t, \ 326 const struct puffs_cid *); \ 327 int fsname##_node_seek(struct puffs_cc *, \ 328 void *, off_t, off_t, const struct puffs_cred *); \ 329 int fsname##_node_remove(struct puffs_cc *, \ 330 void *, void *, const struct puffs_cn *); \ 331 int fsname##_node_link(struct puffs_cc *, \ 332 void *, void *, const struct puffs_cn *); \ 333 int fsname##_node_rename(struct puffs_cc *, \ 334 void *, void *, const struct puffs_cn *, void *, void *, \ 335 const struct puffs_cn *); \ 336 int fsname##_node_mkdir(struct puffs_cc *, \ 337 void *, void **, const struct puffs_cn *, \ 338 const struct vattr *); \ 339 int fsname##_node_rmdir(struct puffs_cc *, \ 340 void *, void *, const struct puffs_cn *); \ 341 int fsname##_node_symlink(struct puffs_cc *, \ 342 void *, void **, const struct puffs_cn *, \ 343 const struct vattr *, const char *); \ 344 int fsname##_node_readdir(struct puffs_cc *, \ 345 void *, struct dirent *, off_t *, size_t *, \ 346 const struct puffs_cred *, int *, off_t *, size_t *); \ 347 int fsname##_node_readlink(struct puffs_cc *, \ 348 void *, const struct puffs_cred *, char *, size_t *); \ 349 int fsname##_node_reclaim(struct puffs_cc *, \ 350 void *, const struct puffs_cid *); \ 351 int fsname##_node_inactive(struct puffs_cc *, \ 352 void *, const struct puffs_cid *, int *); \ 353 int fsname##_node_print(struct puffs_cc *, \ 354 void *); \ 355 int fsname##_node_pathconf(struct puffs_cc *, \ 356 void *, int, int *); \ 357 int fsname##_node_advlock(struct puffs_cc *, \ 358 void *, void *, int, struct flock *, int); \ 359 int fsname##_node_getextattr(struct puffs_cc *, \ 360 void *, struct puffs_vnreq_getextattr *); \ 361 int fsname##_node_setextattr(struct puffs_cc *, \ 362 void *, struct puffs_vnreq_setextattr *); \ 363 int fsname##_node_listextattr(struct puffs_cc *, \ 364 void *, struct puffs_vnreq_listextattr *); \ 365 int fsname##_node_read(struct puffs_cc *, void *, \ 366 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 367 int fsname##_node_write(struct puffs_cc *, void *, \ 368 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 369 \ 370 int fsname##_cache_write(struct puffs_usermount *, void *, \ 371 size_t, struct puffs_cacheinfo *); 372 373 #define PUFFSOP_INIT(ops) \ 374 ops = malloc(sizeof(struct puffs_ops)); \ 375 memset(ops, 0, sizeof(struct puffs_ops)) 376 #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 377 (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 378 #define PUFFSOP_SETFSNOP(ops, opname) \ 379 (ops)->puffs_fs_##opname = puffs_fsnop_##opname 380 381 PUFFSOP_PROTOS(puffs_null) /* XXX */ 382 383 #define PUFFS_DEVEL_LIBVERSION 21 384 #define puffs_init(a,b,c,d) \ 385 _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d) 386 387 388 #define PNPATH(pnode) ((pnode)->pn_po.po_path) 389 #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 390 #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 391 #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 392 #define PCNISDOTDOT(pcnode) \ 393 ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 394 395 #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 396 if (cp) { \ 397 *((cp)++) = off; \ 398 (*(ncp))++; \ 399 } 400 401 /* mainloop */ 402 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 403 404 /* framebuf stuff */ 405 struct puffs_framebuf; 406 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 407 struct puffs_framebuf *, 408 int, int *); 409 typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 410 struct puffs_framebuf *, 411 int, int *); 412 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 413 struct puffs_framebuf *, 414 struct puffs_framebuf *); 415 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 416 typedef void (*puffs_framev_cb)(struct puffs_usermount *, 417 struct puffs_framebuf *, 418 void *, int); 419 #define PUFFS_FBGONE_READ 0x01 420 #define PUFFS_FBGONE_WRITE 0x02 421 #define PUFFS_FBGONE_BOTH(a) ((a)==(PUFFS_FBGONE_READ|PUFFS_FBGONE_WRITE)) 422 423 424 __BEGIN_DECLS 425 426 struct puffs_usermount *_puffs_init(int, struct puffs_ops *pops, const char *, 427 void *, uint32_t); 428 int puffs_mount(struct puffs_usermount *, const char *, int, void*); 429 int puffs_exit(struct puffs_usermount *, int); 430 int puffs_mainloop(struct puffs_usermount *, int); 431 432 433 int puffs_getselectable(struct puffs_usermount *); 434 int puffs_setblockingmode(struct puffs_usermount *, int); 435 int puffs_getstate(struct puffs_usermount *); 436 void puffs_setstacksize(struct puffs_usermount *, size_t); 437 438 void puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn); 439 void puffs_ml_settimeout(struct puffs_usermount *, struct timespec *); 440 441 void puffs_setroot(struct puffs_usermount *, 442 struct puffs_node *); 443 struct puffs_node *puffs_getroot(struct puffs_usermount *); 444 void puffs_setrootinfo(struct puffs_usermount *, 445 enum vtype, vsize_t, dev_t); 446 447 void *puffs_getspecific(struct puffs_usermount *); 448 void puffs_setmaxreqlen(struct puffs_usermount *, size_t); 449 size_t puffs_getmaxreqlen(struct puffs_usermount *); 450 void puffs_setfhsize(struct puffs_usermount *, size_t, int); 451 452 void puffs_setncookiehash(struct puffs_usermount *, int); 453 454 struct puffs_pathobj *puffs_getrootpathobj(struct puffs_usermount *); 455 456 void puffs_setback(struct puffs_cc *, int); 457 458 struct puffs_node *puffs_pn_new(struct puffs_usermount *, void *); 459 void puffs_pn_remove(struct puffs_node *); 460 void puffs_pn_put(struct puffs_node *); 461 462 void *puffs_pn_getmntspecific(struct puffs_node *); 463 464 typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 465 struct puffs_node *, void *); 466 void *puffs_pn_nodewalk(struct puffs_usermount *, 467 puffs_nodewalk_fn, void *); 468 469 void puffs_setvattr(struct vattr *, const struct vattr *); 470 void puffs_vattr_null(struct vattr *); 471 472 void puffs_null_setops(struct puffs_ops *); 473 474 /* 475 * generic/dummy routines applicable for some file systems 476 */ 477 int puffs_fsnop_unmount(struct puffs_cc *, int, const struct puffs_cid *); 478 int puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, 479 const struct puffs_cid *); 480 void puffs_zerostatvfs(struct statvfs *); 481 int puffs_fsnop_sync(struct puffs_cc *, int waitfor, 482 const struct puffs_cred *, const struct puffs_cid *); 483 int puffs_genfs_node_reclaim(struct puffs_cc *, void *, 484 const struct puffs_cid *); 485 486 /* 487 * Subroutine stuff 488 */ 489 490 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 491 int puffs_nextdent(struct dirent **, const char *, ino_t, 492 uint8_t, size_t *); 493 int puffs_vtype2dt(enum vtype); 494 enum vtype puffs_mode2vt(mode_t); 495 void puffs_stat2vattr(struct vattr *va, const struct stat *); 496 mode_t puffs_addvtype2mode(mode_t, enum vtype); 497 498 499 /* 500 * credentials & permissions 501 */ 502 503 /* Credential fetch */ 504 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 505 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 506 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 507 508 /* Credential check */ 509 int puffs_cred_isuid(const struct puffs_cred *, uid_t); 510 int puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 511 int puffs_cred_isregular(const struct puffs_cred *); 512 int puffs_cred_iskernel(const struct puffs_cred *); 513 int puffs_cred_isfs(const struct puffs_cred *); 514 int puffs_cred_isjuggernaut(const struct puffs_cred *); 515 516 /* Caller ID */ 517 int puffs_cid_getpid(const struct puffs_cid *, pid_t *); 518 int puffs_cid_getlwpid(const struct puffs_cid *, lwpid_t *); 519 520 /* misc */ 521 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 522 const struct puffs_cred *); 523 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 524 const struct puffs_cred *); 525 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 526 const struct puffs_cred *); 527 int puffs_access_times(uid_t, gid_t, mode_t, int, 528 const struct puffs_cred *); 529 530 531 /* 532 * Requests 533 */ 534 535 struct puffs_getreq *puffs_req_makeget(struct puffs_usermount *, 536 size_t, int); 537 int puffs_req_loadget(struct puffs_getreq *); 538 struct puffs_req *puffs_req_get(struct puffs_getreq *); 539 int puffs_req_remainingget(struct puffs_getreq *); 540 void puffs_req_setmaxget(struct puffs_getreq *, int); 541 void puffs_req_destroyget(struct puffs_getreq *); 542 543 struct puffs_putreq *puffs_req_makeput(struct puffs_usermount *); 544 void puffs_req_put(struct puffs_putreq *,struct puffs_req *); 545 void puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*); 546 int puffs_req_putput(struct puffs_putreq *); 547 void puffs_req_resetput(struct puffs_putreq *); 548 void puffs_req_destroyput(struct puffs_putreq *); 549 550 int puffs_req_handle(struct puffs_getreq *, 551 struct puffs_putreq *, int); 552 553 /* 554 * Call Context interfaces relevant for user. 555 */ 556 557 void puffs_cc_yield(struct puffs_cc *); 558 void puffs_cc_continue(struct puffs_cc *); 559 struct puffs_usermount *puffs_cc_getusermount(struct puffs_cc *); 560 void *puffs_cc_getspecific(struct puffs_cc *); 561 struct puffs_cc *puffs_cc_create(struct puffs_usermount *); 562 void puffs_cc_destroy(struct puffs_cc *); 563 564 /* 565 * Execute or continue a request 566 */ 567 568 int puffs_dopreq(struct puffs_usermount *, struct puffs_req *, 569 struct puffs_putreq *); 570 void puffs_docc(struct puffs_cc *, struct puffs_putreq *); 571 572 /* 573 * Flushing / invalidation routines 574 */ 575 576 int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 577 int puffs_inval_namecache_all(struct puffs_usermount *); 578 579 int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 580 int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 581 off_t, off_t); 582 int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 583 int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 584 off_t, off_t); 585 586 /* 587 * Path constructicons 588 */ 589 590 int puffs_stdpath_buildpath(struct puffs_usermount *, 591 const struct puffs_pathobj *, 592 const struct puffs_pathobj *, size_t, 593 struct puffs_pathobj *); 594 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 595 struct puffs_pathobj *, size_t, int); 596 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 597 598 void *puffs_path_walkcmp(struct puffs_usermount *, 599 struct puffs_node *, void *); 600 void *puffs_path_prefixadj(struct puffs_usermount *, 601 struct puffs_node *, void *); 602 int puffs_path_pcnbuild(struct puffs_usermount *, 603 struct puffs_cn *, void *); 604 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 605 606 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 607 void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 608 void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 609 void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 610 void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 611 612 /* 613 * Suspension 614 */ 615 616 int puffs_fs_suspend(struct puffs_usermount *); 617 618 /* 619 * Frame buffering 620 */ 621 622 void puffs_framev_init(struct puffs_usermount *, 623 puffs_framev_readframe_fn, 624 puffs_framev_writeframe_fn, 625 puffs_framev_cmpframe_fn, 626 puffs_framev_fdnotify_fn); 627 628 struct puffs_framebuf *puffs_framebuf_make(void); 629 void puffs_framebuf_destroy(struct puffs_framebuf *); 630 void puffs_framebuf_recycle(struct puffs_framebuf *); 631 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 632 size_t); 633 634 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 635 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 636 const void *, size_t); 637 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 638 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 639 void *, size_t); 640 641 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 642 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 643 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 644 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 645 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 646 void **, size_t *); 647 648 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 649 struct puffs_framebuf *); 650 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 651 struct puffs_framebuf *, 652 puffs_framev_cb, void *); 653 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 654 struct puffs_framebuf *, int); 655 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 656 struct puffs_cc *); 657 658 int puffs_framev_addfd(struct puffs_usermount *pu, int); 659 int puffs_framev_removefd(struct puffs_usermount *pu, int, int); 660 void puffs_framev_unmountonclose(struct puffs_usermount *pu, int, int); 661 662 __END_DECLS 663 664 #endif /* _PUFFS_H_ */ 665
Indexes created Sun Sep 28 16:09:52 GMT 2025