puffs.h revision 1.115
1 /* $NetBSD: puffs.h,v 1.115 2010/05/21 10:50:52 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 void *pn_spare[4]; 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 struct puffs_cred *pcn_cred; /* cred used for lookup */ 124 125 struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 126 }; 127 #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 128 #define pcn_flags pcn_pkcnp->pkcn_flags 129 #define pcn_name pcn_pkcnp->pkcn_name 130 #define pcn_namelen pcn_pkcnp->pkcn_namelen 131 #define pcn_consume pcn_pkcnp->pkcn_consume 132 133 /* 134 * Puffs options to mount 135 */ 136 /* kernel */ 137 #define PUFFSMOPT_NAMECACHE { "namecache", 1, PUFFS_KFLAG_NOCACHE_NAME, 1 } 138 #define PUFFSMOPT_PAGECACHE { "pagecache", 1, PUFFS_KFLAG_NOCACHE_PAGE, 1 } 139 #define PUFFSMOPT_CACHE { "cache", 1, PUFFS_KFLAG_NOCACHE, 1 } 140 #define PUFFSMOPT_ALLOPS { "allops", 0, PUFFS_KFLAG_ALLOPS, 1 } 141 142 /* libpuffs */ 143 #define PUFFSMOPT_DUMP { "dump", 0, PUFFS_FLAG_OPDUMP, 1 } 144 145 #define PUFFSMOPT_STD \ 146 PUFFSMOPT_NAMECACHE, \ 147 PUFFSMOPT_PAGECACHE, \ 148 PUFFSMOPT_CACHE, \ 149 PUFFSMOPT_ALLOPS, \ 150 PUFFSMOPT_DUMP 151 152 extern const struct mntopt puffsmopts[]; /* puffs.c */ 153 154 /* callbacks for operations */ 155 struct puffs_ops { 156 int (*puffs_fs_unmount)(struct puffs_usermount *, int); 157 int (*puffs_fs_statvfs)(struct puffs_usermount *, struct statvfs *); 158 int (*puffs_fs_sync)(struct puffs_usermount *, int, 159 const struct puffs_cred *); 160 int (*puffs_fs_fhtonode)(struct puffs_usermount *, void *, size_t, 161 struct puffs_newinfo *); 162 int (*puffs_fs_nodetofh)(struct puffs_usermount *, puffs_cookie_t, 163 void *, size_t *); 164 int (*puffs_fs_extattrctl)(struct puffs_usermount *, int, 165 puffs_cookie_t, int, int, const char *); 166 167 int (*puffs_node_lookup)(struct puffs_usermount *, 168 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *); 169 int (*puffs_node_create)(struct puffs_usermount *, 170 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 171 const struct vattr *); 172 int (*puffs_node_mknod)(struct puffs_usermount *, 173 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 174 const struct vattr *); 175 int (*puffs_node_open)(struct puffs_usermount *, 176 puffs_cookie_t, int, const struct puffs_cred *); 177 int (*puffs_node_close)(struct puffs_usermount *, 178 puffs_cookie_t, int, const struct puffs_cred *); 179 int (*puffs_node_access)(struct puffs_usermount *, 180 puffs_cookie_t, int, const struct puffs_cred *); 181 int (*puffs_node_getattr)(struct puffs_usermount *, 182 puffs_cookie_t, struct vattr *, const struct puffs_cred *); 183 int (*puffs_node_setattr)(struct puffs_usermount *, 184 puffs_cookie_t, const struct vattr *, const struct puffs_cred *); 185 int (*puffs_node_poll)(struct puffs_usermount *, puffs_cookie_t, int *); 186 int (*puffs_node_mmap)(struct puffs_usermount *, 187 puffs_cookie_t, vm_prot_t, const struct puffs_cred *); 188 int (*puffs_node_fsync)(struct puffs_usermount *, 189 puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t); 190 int (*puffs_node_seek)(struct puffs_usermount *, 191 puffs_cookie_t, off_t, off_t, const struct puffs_cred *); 192 int (*puffs_node_remove)(struct puffs_usermount *, 193 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 194 int (*puffs_node_link)(struct puffs_usermount *, 195 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 196 int (*puffs_node_rename)(struct puffs_usermount *, 197 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *, 198 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 199 int (*puffs_node_mkdir)(struct puffs_usermount *, 200 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 201 const struct vattr *); 202 int (*puffs_node_rmdir)(struct puffs_usermount *, 203 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 204 int (*puffs_node_symlink)(struct puffs_usermount *, 205 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 206 const struct vattr *, 207 const char *); 208 int (*puffs_node_readdir)(struct puffs_usermount *, 209 puffs_cookie_t, struct dirent *, off_t *, size_t *, 210 const struct puffs_cred *, int *, off_t *, size_t *); 211 int (*puffs_node_readlink)(struct puffs_usermount *, 212 puffs_cookie_t, const struct puffs_cred *, char *, size_t *); 213 int (*puffs_node_reclaim)(struct puffs_usermount *, puffs_cookie_t); 214 int (*puffs_node_inactive)(struct puffs_usermount *, puffs_cookie_t); 215 int (*puffs_node_print)(struct puffs_usermount *, puffs_cookie_t); 216 int (*puffs_node_pathconf)(struct puffs_usermount *, 217 puffs_cookie_t, int, int *); 218 int (*puffs_node_advlock)(struct puffs_usermount *, 219 puffs_cookie_t, void *, int, struct flock *, int); 220 int (*puffs_node_read)(struct puffs_usermount *, puffs_cookie_t, 221 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 222 int (*puffs_node_write)(struct puffs_usermount *, puffs_cookie_t, 223 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 224 int (*puffs_node_abortop)(struct puffs_usermount *, puffs_cookie_t, 225 const struct puffs_cn *); 226 int (*puffs_node_getextattr)(struct puffs_usermount *, puffs_cookie_t, 227 int, const char *, size_t *, uint8_t *, size_t *, 228 const struct puffs_cred *); 229 int (*puffs_node_setextattr)(struct puffs_usermount *, puffs_cookie_t, 230 int, const char *, uint8_t *, size_t *, const struct puffs_cred *); 231 int (*puffs_node_listextattr)(struct puffs_usermount *, puffs_cookie_t, 232 int, size_t *, uint8_t *, size_t *, const struct puffs_cred *); 233 int (*puffs_node_deleteextattr)(struct puffs_usermount *, 234 puffs_cookie_t, int, const char *, const struct puffs_cred *); 235 236 void *puffs_ops_spare[32]; 237 }; 238 239 typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 240 const struct puffs_pathobj *, 241 const struct puffs_pathobj *, size_t, 242 struct puffs_pathobj *); 243 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 244 const struct puffs_pathobj *, 245 const struct puffs_cn *, 246 struct puffs_pathobj *); 247 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 248 struct puffs_pathobj *, size_t, int); 249 typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 250 struct puffs_pathobj *); 251 typedef int (*pu_namemod_fn)(struct puffs_usermount *, 252 struct puffs_pathobj *, struct puffs_cn *); 253 254 typedef void (*pu_errnotify_fn)(struct puffs_usermount *, 255 uint8_t, int, const char *, puffs_cookie_t); 256 257 typedef void (*pu_prepost_fn)(struct puffs_usermount *); 258 259 typedef struct puffs_node *(*pu_cmap_fn)(struct puffs_usermount *, 260 puffs_cookie_t); 261 262 enum { 263 PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 264 PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 265 }; 266 267 #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 268 #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 269 #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 270 #define PUFFS_FLAG_MASK 0xe0000000 271 272 #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 273 #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 274 275 /* blocking mode argument */ 276 #define PUFFSDEV_BLOCK 0 277 #define PUFFSDEV_NONBLOCK 1 278 279 #define PUFFS_STACKSIZE_DEFAULT (1<<PUFFS_CC_STACKSHIFT_DEFAULT) 280 #define PUFFS_STACKSIZE_MIN ((size_t)-1) 281 282 #define DENT_DOT 0 283 #define DENT_DOTDOT 1 284 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 285 286 287 /* 288 * protos 289 */ 290 291 #define PUFFSOP_PROTOS(fsname) \ 292 int fsname##_fs_unmount(struct puffs_usermount *, int); \ 293 int fsname##_fs_statvfs(struct puffs_usermount *, \ 294 struct statvfs *); \ 295 int fsname##_fs_sync(struct puffs_usermount *, int, \ 296 const struct puffs_cred *cred); \ 297 int fsname##_fs_fhtonode(struct puffs_usermount *, void *, \ 298 size_t, struct puffs_newinfo *); \ 299 int fsname##_fs_nodetofh(struct puffs_usermount *, \ 300 puffs_cookie_t, void *, size_t *); \ 301 int fsname##_fs_extattrctl(struct puffs_usermount *, int, \ 302 puffs_cookie_t, int, int, const char *); \ 303 \ 304 int fsname##_node_lookup(struct puffs_usermount *, \ 305 puffs_cookie_t, struct puffs_newinfo *, \ 306 const struct puffs_cn *); \ 307 int fsname##_node_create(struct puffs_usermount *, \ 308 puffs_cookie_t, struct puffs_newinfo *, \ 309 const struct puffs_cn *, const struct vattr *); \ 310 int fsname##_node_mknod(struct puffs_usermount *, \ 311 puffs_cookie_t, struct puffs_newinfo *, \ 312 const struct puffs_cn *, const struct vattr *); \ 313 int fsname##_node_open(struct puffs_usermount *, \ 314 puffs_cookie_t, int, const struct puffs_cred *); \ 315 int fsname##_node_close(struct puffs_usermount *, \ 316 puffs_cookie_t, int, const struct puffs_cred *); \ 317 int fsname##_node_access(struct puffs_usermount *, \ 318 puffs_cookie_t, int, const struct puffs_cred *); \ 319 int fsname##_node_getattr(struct puffs_usermount *, \ 320 puffs_cookie_t, struct vattr *, const struct puffs_cred *); \ 321 int fsname##_node_setattr(struct puffs_usermount *, \ 322 puffs_cookie_t, const struct vattr *, \ 323 const struct puffs_cred *); \ 324 int fsname##_node_poll(struct puffs_usermount *, \ 325 puffs_cookie_t, int *); \ 326 int fsname##_node_mmap(struct puffs_usermount *, \ 327 puffs_cookie_t, vm_prot_t, const struct puffs_cred *); \ 328 int fsname##_node_fsync(struct puffs_usermount *, \ 329 puffs_cookie_t, const struct puffs_cred *, int, \ 330 off_t, off_t); \ 331 int fsname##_node_seek(struct puffs_usermount *, \ 332 puffs_cookie_t, off_t, off_t, const struct puffs_cred *); \ 333 int fsname##_node_remove(struct puffs_usermount *, \ 334 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); \ 335 int fsname##_node_link(struct puffs_usermount *, \ 336 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); \ 337 int fsname##_node_rename(struct puffs_usermount *, \ 338 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *, \ 339 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); \ 340 int fsname##_node_mkdir(struct puffs_usermount *, \ 341 puffs_cookie_t, struct puffs_newinfo *, \ 342 const struct puffs_cn *, const struct vattr *); \ 343 int fsname##_node_rmdir(struct puffs_usermount *, \ 344 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); \ 345 int fsname##_node_symlink(struct puffs_usermount *, \ 346 puffs_cookie_t, struct puffs_newinfo *, \ 347 const struct puffs_cn *, const struct vattr *, \ 348 const char *); \ 349 int fsname##_node_readdir(struct puffs_usermount *, \ 350 puffs_cookie_t, struct dirent *, off_t *, size_t *, \ 351 const struct puffs_cred *, int *, off_t *, size_t *); \ 352 int fsname##_node_readlink(struct puffs_usermount *, \ 353 puffs_cookie_t, const struct puffs_cred *, char *, \ 354 size_t *); \ 355 int fsname##_node_reclaim(struct puffs_usermount *, \ 356 puffs_cookie_t); \ 357 int fsname##_node_inactive(struct puffs_usermount *, \ 358 puffs_cookie_t); \ 359 int fsname##_node_print(struct puffs_usermount *, \ 360 puffs_cookie_t); \ 361 int fsname##_node_pathconf(struct puffs_usermount *, \ 362 puffs_cookie_t, int, int *); \ 363 int fsname##_node_advlock(struct puffs_usermount *, \ 364 puffs_cookie_t, void *, int, struct flock *, int); \ 365 int fsname##_node_read(struct puffs_usermount *, puffs_cookie_t,\ 366 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 367 int fsname##_node_write(struct puffs_usermount *, \ 368 puffs_cookie_t, uint8_t *, off_t, size_t *, \ 369 const struct puffs_cred *, int); \ 370 int fsname##_node_abortop(struct puffs_usermount *, \ 371 puffs_cookie_t, const struct puffs_cn *); \ 372 int fsname##_node_getextattr(struct puffs_usermount *, \ 373 puffs_cookie_t, int, const char *, size_t *, uint8_t *, \ 374 size_t *, const struct puffs_cred *); \ 375 int fsname##_node_setextattr(struct puffs_usermount *, \ 376 puffs_cookie_t, int, const char *, uint8_t *, size_t *, \ 377 const struct puffs_cred *); \ 378 int fsname##_node_listextattr(struct puffs_usermount *, \ 379 puffs_cookie_t, int, size_t *, uint8_t *, size_t *, \ 380 const struct puffs_cred *); \ 381 int fsname##_node_deleteextattr(struct puffs_usermount *, \ 382 puffs_cookie_t, int, const char *, \ 383 const struct puffs_cred *); 384 385 #define PUFFSOP_INIT(ops) \ 386 ops = malloc(sizeof(struct puffs_ops)); \ 387 memset(ops, 0, sizeof(struct puffs_ops)) 388 #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 389 (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 390 #define PUFFSOP_SETFSNOP(ops, opname) \ 391 (ops)->puffs_fs_##opname = puffs_fsnop_##opname 392 393 PUFFSOP_PROTOS(puffs_null) /* XXX */ 394 395 #define PNPATH(pnode) ((pnode)->pn_po.po_path) 396 #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 397 #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 398 #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 399 #define PCNISDOTDOT(pcnode) \ 400 ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 401 402 #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 403 if (cp) { \ 404 *((cp)++) = off; \ 405 (*(ncp))++; \ 406 } 407 408 /* mainloop */ 409 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 410 411 /* framebuf stuff */ 412 struct puffs_framebuf; 413 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 414 struct puffs_framebuf *, 415 int, int *); 416 typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 417 struct puffs_framebuf *, 418 int, int *); 419 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 420 struct puffs_framebuf *, 421 struct puffs_framebuf *, 422 int *); 423 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 424 typedef void (*puffs_framev_gotframe_fn)(struct puffs_usermount *, 425 struct puffs_framebuf *); 426 typedef void (*puffs_framev_cb)(struct puffs_usermount *, 427 struct puffs_framebuf *, 428 void *, int); 429 #define PUFFS_FBIO_READ 0x01 430 #define PUFFS_FBIO_WRITE 0x02 431 #define PUFFS_FBIO_ERROR 0x04 432 433 #define PUFFS_FBQUEUE_URGENT 0x01 434 435 436 __BEGIN_DECLS 437 438 #define PUFFS_DEFER ((void *)-1) 439 struct puffs_usermount *puffs_init(struct puffs_ops *, const char *, 440 const char *, void *, uint32_t); 441 int puffs_mount(struct puffs_usermount *, const char *, int, void*); 442 int puffs_exit(struct puffs_usermount *, int); 443 void puffs_cancel(struct puffs_usermount *, int); 444 int puffs_mainloop(struct puffs_usermount *); 445 int puffs_daemon(struct puffs_usermount *, int, int); 446 447 int puffs_unmountonsignal(int, bool); 448 449 450 int puffs_getselectable(struct puffs_usermount *); 451 int puffs_setblockingmode(struct puffs_usermount *, int); 452 int puffs_getstate(struct puffs_usermount *); 453 void puffs_setstacksize(struct puffs_usermount *, size_t); 454 455 void puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn); 456 void puffs_ml_settimeout(struct puffs_usermount *, struct timespec *); 457 458 void puffs_setroot(struct puffs_usermount *, 459 struct puffs_node *); 460 struct puffs_node *puffs_getroot(struct puffs_usermount *); 461 void puffs_setrootinfo(struct puffs_usermount *, 462 enum vtype, vsize_t, dev_t); 463 464 void *puffs_getspecific(struct puffs_usermount *); 465 void puffs_setspecific(struct puffs_usermount *, void *); 466 void puffs_setmaxreqlen(struct puffs_usermount *, size_t); 467 size_t puffs_getmaxreqlen(struct puffs_usermount *); 468 void puffs_setfhsize(struct puffs_usermount *, size_t, int); 469 void puffs_setmntinfo(struct puffs_usermount *, 470 const char *, const char *); 471 472 void puffs_setncookiehash(struct puffs_usermount *, int); 473 474 struct puffs_pathobj *puffs_getrootpathobj(struct puffs_usermount *); 475 476 void puffs_setback(struct puffs_cc *, int); 477 478 struct puffs_node *puffs_pn_new(struct puffs_usermount *, void *); 479 void puffs_pn_remove(struct puffs_node *); 480 void puffs_pn_put(struct puffs_node *); 481 struct vattr *puffs_pn_getvap(struct puffs_node *); 482 void * puffs_pn_getpriv(struct puffs_node *); 483 void puffs_pn_setpriv(struct puffs_node *, void *); 484 struct puffs_pathobj *puffs_pn_getpo(struct puffs_node *); 485 struct puffs_usermount *puffs_pn_getmnt(struct puffs_node *); 486 487 void puffs_newinfo_setcookie(struct puffs_newinfo *, puffs_cookie_t); 488 void puffs_newinfo_setvtype(struct puffs_newinfo *, enum vtype); 489 void puffs_newinfo_setsize(struct puffs_newinfo *, voff_t); 490 void puffs_newinfo_setrdev(struct puffs_newinfo *, dev_t); 491 492 void *puffs_pn_getmntspecific(struct puffs_node *); 493 494 typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 495 struct puffs_node *, void *); 496 void *puffs_pn_nodewalk(struct puffs_usermount *, 497 puffs_nodewalk_fn, void *); 498 499 void puffs_setvattr(struct vattr *, const struct vattr *); 500 void puffs_vattr_null(struct vattr *); 501 502 void puffs_null_setops(struct puffs_ops *); 503 504 int puffs_dispatch_create(struct puffs_usermount *, 505 struct puffs_framebuf *, 506 struct puffs_cc **); 507 int puffs_dispatch_exec(struct puffs_cc *, 508 struct puffs_framebuf **); 509 510 /* 511 * generic/dummy routines applicable for some file systems 512 */ 513 int puffs_fsnop_unmount(struct puffs_usermount *, int); 514 int puffs_fsnop_statvfs(struct puffs_usermount *, struct statvfs *); 515 void puffs_zerostatvfs(struct statvfs *); 516 int puffs_fsnop_sync(struct puffs_usermount *, int waitfor, 517 const struct puffs_cred *); 518 519 int puffs_genfs_node_getattr(struct puffs_usermount *, puffs_cookie_t, 520 struct vattr *, const struct puffs_cred *); 521 int puffs_genfs_node_reclaim(struct puffs_usermount *, puffs_cookie_t); 522 523 /* 524 * Subroutine stuff 525 */ 526 527 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 528 int puffs_nextdent(struct dirent **, const char *, ino_t, 529 uint8_t, size_t *); 530 int puffs_vtype2dt(enum vtype); 531 enum vtype puffs_mode2vt(mode_t); 532 void puffs_stat2vattr(struct vattr *va, const struct stat *); 533 mode_t puffs_addvtype2mode(mode_t, enum vtype); 534 535 536 /* 537 * credentials & permissions 538 */ 539 540 /* Credential fetch */ 541 int puffs_cred_getuid(const struct puffs_cred *, uid_t *); 542 int puffs_cred_getgid(const struct puffs_cred *, gid_t *); 543 int puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *); 544 545 /* Credential check */ 546 bool puffs_cred_isuid(const struct puffs_cred *, uid_t); 547 bool puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 548 bool puffs_cred_isregular(const struct puffs_cred *); 549 bool puffs_cred_iskernel(const struct puffs_cred *); 550 bool puffs_cred_isfs(const struct puffs_cred *); 551 bool puffs_cred_isjuggernaut(const struct puffs_cred *); 552 553 /* misc */ 554 int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 555 const struct puffs_cred *); 556 int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 557 const struct puffs_cred *); 558 int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 559 const struct puffs_cred *); 560 int puffs_access_times(uid_t, gid_t, mode_t, int, 561 const struct puffs_cred *); 562 563 564 /* 565 * Call Context interfaces relevant for user. 566 */ 567 568 void puffs_cc_yield(struct puffs_cc *); 569 void puffs_cc_continue(struct puffs_cc *); 570 void puffs_cc_schedule(struct puffs_cc *); 571 int puffs_cc_getcaller(struct puffs_cc *,pid_t *,lwpid_t *); 572 struct puffs_cc *puffs_cc_getcc(struct puffs_usermount *); 573 574 /* 575 * Flushing / invalidation routines 576 */ 577 578 int puffs_inval_namecache_dir(struct puffs_usermount *, puffs_cookie_t); 579 int puffs_inval_namecache_all(struct puffs_usermount *); 580 581 int puffs_inval_pagecache_node(struct puffs_usermount *, puffs_cookie_t); 582 int puffs_inval_pagecache_node_range(struct puffs_usermount *, 583 puffs_cookie_t, off_t, off_t); 584 int puffs_flush_pagecache_node(struct puffs_usermount *, puffs_cookie_t); 585 int puffs_flush_pagecache_node_range(struct puffs_usermount *, 586 puffs_cookie_t, off_t, off_t); 587 588 /* 589 * Path constructicons 590 */ 591 592 int puffs_stdpath_buildpath(struct puffs_usermount *, 593 const struct puffs_pathobj *, 594 const struct puffs_pathobj *, size_t, 595 struct puffs_pathobj *); 596 int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 597 struct puffs_pathobj *, size_t, int); 598 void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 599 600 void *puffs_path_walkcmp(struct puffs_usermount *, 601 struct puffs_node *, void *); 602 void *puffs_path_prefixadj(struct puffs_usermount *, 603 struct puffs_node *, void *); 604 int puffs_path_pcnbuild(struct puffs_usermount *, 605 struct puffs_cn *, void *); 606 void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 607 void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 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 void puffs_set_errnotify(struct puffs_usermount *, pu_errnotify_fn); 613 void puffs_kernerr_log(struct puffs_usermount *, uint8_t, int, 614 const char *, puffs_cookie_t); 615 void puffs_kernerr_abort(struct puffs_usermount *, uint8_t, int, 616 const char *, puffs_cookie_t); 617 void puffs_set_prepost(struct puffs_usermount *, 618 pu_prepost_fn, pu_prepost_fn); 619 void puffs_set_cmap(struct puffs_usermount *, pu_cmap_fn); 620 621 /* 622 * Suspension 623 */ 624 625 int puffs_fs_suspend(struct puffs_usermount *); 626 627 /* 628 * Frame buffering 629 */ 630 631 void puffs_framev_init(struct puffs_usermount *, 632 puffs_framev_readframe_fn, 633 puffs_framev_writeframe_fn, 634 puffs_framev_cmpframe_fn, 635 puffs_framev_gotframe_fn, 636 puffs_framev_fdnotify_fn); 637 638 struct puffs_framebuf *puffs_framebuf_make(void); 639 void puffs_framebuf_destroy(struct puffs_framebuf *); 640 int puffs_framebuf_dup(struct puffs_framebuf *, 641 struct puffs_framebuf **); 642 void puffs_framebuf_recycle(struct puffs_framebuf *); 643 int puffs_framebuf_reserve_space(struct puffs_framebuf *, 644 size_t); 645 646 int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 647 int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 648 const void *, size_t); 649 int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 650 int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 651 void *, size_t); 652 653 size_t puffs_framebuf_telloff(struct puffs_framebuf *); 654 size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 655 size_t puffs_framebuf_remaining(struct puffs_framebuf *); 656 int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 657 int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 658 void **, size_t *); 659 660 int puffs_framev_enqueue_cc(struct puffs_cc *, int, 661 struct puffs_framebuf *, int); 662 int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 663 struct puffs_framebuf *, 664 puffs_framev_cb, void *, int); 665 int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 666 struct puffs_framebuf *, int, int); 667 int puffs_framev_enqueue_directreceive(struct puffs_cc *, int, 668 struct puffs_framebuf *, int); 669 int puffs_framev_enqueue_directsend(struct puffs_cc *, int, 670 struct puffs_framebuf *, int); 671 int puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *); 672 int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 673 struct puffs_cc *); 674 675 int puffs_framev_addfd(struct puffs_usermount *, int, int); 676 int puffs_framev_enablefd(struct puffs_usermount *, int, int); 677 int puffs_framev_disablefd(struct puffs_usermount *, int, int); 678 int puffs_framev_removefd(struct puffs_usermount *, int, int); 679 void puffs_framev_removeonclose(struct puffs_usermount *, int, int); 680 void puffs_framev_unmountonclose(struct puffs_usermount *, int, int); 681 682 __END_DECLS 683 684 #endif /* _PUFFS_H_ */ 685
Indexes created Mon Sep 29 21:09:56 GMT 2025