lib/libpuffs/puffs.h

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