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