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