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