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