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