Home | History | Annotate | Line # | Download | only in libpuffs
puffs.h revision 1.56
      1 /*	$NetBSD: puffs.h,v 1.56 2007/05/15 13:44:47 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  * 3. The name of the company nor the name of the author may be used to
     19  *    endorse or promote products derived from this software without specific
     20  *    prior written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
     23  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     25  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32  * SUCH DAMAGE.
     33  */
     34 
     35 #ifndef _PUFFS_H_
     36 #define _PUFFS_H_
     37 
     38 #include <sys/param.h>
     39 #include <sys/types.h>
     40 #include <sys/mount.h>
     41 #include <sys/stat.h>
     42 #include <sys/statvfs.h>
     43 #include <sys/time.h>
     44 #include <sys/vnode.h>
     45 
     46 #include <fs/puffs/puffs_msgif.h>
     47 
     48 #include <mntopts.h>
     49 #include <string.h>
     50 
     51 /* forwards */
     52 struct puffs_cc;
     53 
     54 struct puffs_getreq;
     55 struct puffs_putreq;
     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_flag;
     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 
     94 
     95 struct puffs_usermount;
     96 
     97 /*
     98  * megaXXX: these are values from inside _KERNEL
     99  * need to work on the translation for ALL the necessary values.
    100  */
    101 #define PUFFS_VNOVAL (-1)
    102 #define PUFFS_IO_APPEND 0x20
    103 #define PUFFS_VEXEC	01
    104 #define PUFFS_VWRITE	02
    105 #define PUFFS_VREAD	04
    106 
    107 #define PUFFS_FSYNC_DATAONLY 0x0002
    108 #define PUFFS_FSYNC_CACHE    0x0100
    109 
    110 /*
    111  * Magic constants
    112  */
    113 #define PUFFS_CC_STACKSIZE_DEFAULT (1024*1024)
    114 
    115 struct puffs_cn {
    116 	struct puffs_kcn	*pcn_pkcnp;	/* kernel input */
    117 	struct puffs_pathobj	pcn_po_full;	/* PUFFS_FLAG_BUILDPATH */
    118 };
    119 #define pcn_nameiop	pcn_pkcnp->pkcn_nameiop
    120 #define pcn_flags	pcn_pkcnp->pkcn_flags
    121 #define pcn_pid		pcn_pkcnp->pkcn_pid
    122 #define pcn_cred	pcn_pkcnp->pkcn_cred
    123 #define pcn_name	pcn_pkcnp->pkcn_name
    124 #define pcn_namelen	pcn_pkcnp->pkcn_namelen
    125 
    126 /*
    127  * Puffs options to mount
    128  */
    129 /* kernel */
    130 #define	PUFFSMOPT_CACHE		{ "cache", 1, PUFFS_KFLAG_NOCACHE, 1 }
    131 #define PUFFSMOPT_ALLOPS	{ "allops", 0, PUFFS_KFLAG_ALLOPS, 1 }
    132 
    133 /* libpuffs */
    134 #define PUFFSMOPT_DUMP		{ "dump", 0, PUFFS_FLAG_OPDUMP, 1 }
    135 
    136 #define PUFFSMOPT_STD							\
    137 	PUFFSMOPT_CACHE,						\
    138 	PUFFSMOPT_ALLOPS,						\
    139 	PUFFSMOPT_DUMP
    140 
    141 extern const struct mntopt puffsmopts[]; /* puffs.c */
    142 
    143 /* callbacks for operations */
    144 struct puffs_ops {
    145 	int (*puffs_fs_unmount)(struct puffs_cc *, int, pid_t);
    146 	int (*puffs_fs_statvfs)(struct puffs_cc *,
    147 	    struct statvfs *, pid_t);
    148 	int (*puffs_fs_sync)(struct puffs_cc *, int,
    149 	    const struct puffs_cred *, pid_t);
    150 	int (*puffs_fs_fhtonode)(struct puffs_cc *, void *, size_t,
    151 	    void **, enum vtype *, voff_t *, dev_t *);
    152 	int (*puffs_fs_nodetofh)(struct puffs_cc *, void *cookie,
    153 	    void *, size_t *);
    154 	void (*puffs_fs_suspend)(struct puffs_cc *, int);
    155 
    156 	int (*puffs_node_lookup)(struct puffs_cc *,
    157 	    void *, void **, enum vtype *, voff_t *, dev_t *,
    158 	    const struct puffs_cn *);
    159 	int (*puffs_node_create)(struct puffs_cc *,
    160 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    161 	int (*puffs_node_mknod)(struct puffs_cc *,
    162 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    163 	int (*puffs_node_open)(struct puffs_cc *,
    164 	    void *, int, const struct puffs_cred *, pid_t);
    165 	int (*puffs_node_close)(struct puffs_cc *,
    166 	    void *, int, const struct puffs_cred *, pid_t);
    167 	int (*puffs_node_access)(struct puffs_cc *,
    168 	    void *, int, const struct puffs_cred *, pid_t);
    169 	int (*puffs_node_getattr)(struct puffs_cc *,
    170 	    void *, struct vattr *, const struct puffs_cred *, pid_t);
    171 	int (*puffs_node_setattr)(struct puffs_cc *,
    172 	    void *, const struct vattr *, const struct puffs_cred *, pid_t);
    173 	int (*puffs_node_poll)(struct puffs_cc *,
    174 	    void *, struct puffs_vnreq_poll *);
    175 	int (*puffs_node_mmap)(struct puffs_cc *,
    176 	    void *, int, const struct puffs_cred *, pid_t);
    177 	int (*puffs_node_fsync)(struct puffs_cc *,
    178 	    void *, const struct puffs_cred *, int, off_t, off_t, pid_t);
    179 	int (*puffs_node_seek)(struct puffs_cc *,
    180 	    void *, off_t, off_t, const struct puffs_cred *);
    181 	int (*puffs_node_remove)(struct puffs_cc *,
    182 	    void *, void *, const struct puffs_cn *);
    183 	int (*puffs_node_link)(struct puffs_cc *,
    184 	    void *, void *, const struct puffs_cn *);
    185 	int (*puffs_node_rename)(struct puffs_cc *,
    186 	    void *, void *, const struct puffs_cn *, void *, void *,
    187 	    const struct puffs_cn *);
    188 	int (*puffs_node_mkdir)(struct puffs_cc *,
    189 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    190 	int (*puffs_node_rmdir)(struct puffs_cc *,
    191 	    void *, void *, const struct puffs_cn *);
    192 	int (*puffs_node_symlink)(struct puffs_cc *,
    193 	    void *, void **, const struct puffs_cn *, const struct vattr *,
    194 	    const char *);
    195 	int (*puffs_node_readdir)(struct puffs_cc *,
    196 	    void *, struct dirent *, off_t *, size_t *,
    197 	    const struct puffs_cred *, int *, off_t *, size_t *);
    198 	int (*puffs_node_readlink)(struct puffs_cc *,
    199 	    void *, const struct puffs_cred *, char *, size_t *);
    200 	int (*puffs_node_reclaim)(struct puffs_cc *,
    201 	    void *, pid_t);
    202 	int (*puffs_node_inactive)(struct puffs_cc *,
    203 	    void *, pid_t, int *);
    204 	int (*puffs_node_print)(struct puffs_cc *,
    205 	    void *);
    206 	int (*puffs_node_pathconf)(struct puffs_cc *,
    207 	    void *, int, int *);
    208 	int (*puffs_node_advlock)(struct puffs_cc *,
    209 	    void *, void *, int, struct flock *, int);
    210 	int (*puffs_node_getextattr)(struct puffs_cc *,
    211 	    void *, struct puffs_vnreq_getextattr *);
    212 	int (*puffs_node_setextattr)(struct puffs_cc *,
    213 	    void *, struct puffs_vnreq_setextattr *);
    214 	int (*puffs_node_listextattr)(struct puffs_cc *,
    215 	    void *, struct puffs_vnreq_listextattr *);
    216 	int (*puffs_node_read)(struct puffs_cc *, void *,
    217 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    218 	int (*puffs_node_write)(struct puffs_cc *, void *,
    219 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    220 
    221 	int (*puffs_cache_write)(struct puffs_usermount *,
    222 		void *, size_t, struct puffs_cacherun *);
    223 };
    224 
    225 typedef	int (*pu_pathbuild_fn)(struct puffs_usermount *,
    226 			       const struct puffs_pathobj *,
    227 			       const struct puffs_pathobj *, size_t,
    228 			       struct puffs_pathobj *);
    229 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *,
    230 				   const struct puffs_pathobj *,
    231 				   const struct puffs_cn *,
    232 				   struct puffs_pathobj *);
    233 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *,
    234 			  struct puffs_pathobj *, size_t, int);
    235 typedef void (*pu_pathfree_fn)(struct puffs_usermount *,
    236 			       struct puffs_pathobj *);
    237 typedef int (*pu_namemod_fn)(struct puffs_usermount *,
    238 			     struct puffs_pathobj *, struct puffs_cn *);
    239 
    240 enum {
    241 	PUFFS_STATE_BEFOREMOUNT,
    242 	PUFFS_STATE_MOUNTING,		PUFFS_STATE_RUNNING,
    243 	PUFFS_STATE_UNMOUNTING,		PUFFS_STATE_UNMOUNTED
    244 };
    245 
    246 #define PUFFS_FLAG_BUILDPATH	0x80000000	/* node paths in pnode */
    247 #define PUFFS_FLAG_OPDUMP	0x40000000	/* dump all operations */
    248 #define PUFFS_FLAG_HASHPATH	0x20000000	/* speedup: hash paths */
    249 #define PUFFS_FLAG_MASK		0xe0000000
    250 
    251 #define PUFFS_FLAG_KERN(a)	((a) & PUFFS_KFLAG_MASK)
    252 #define PUFFS_FLAG_LIB(a)	((a) & PUFFS_FLAG_MASK)
    253 
    254 /* blocking mode argument */
    255 #define PUFFSDEV_BLOCK 0
    256 #define PUFFSDEV_NONBLOCK 1
    257 
    258 /* mainloop flags */
    259 #define PUFFSLOOP_NODAEMON 0x01
    260 
    261 #define		DENT_DOT	0
    262 #define		DENT_DOTDOT	1
    263 #define		DENT_ADJ(a)	((a)-2)	/* nth request means dir's n-2th */
    264 
    265 
    266 /*
    267  * protos
    268  */
    269 
    270 #define PUFFSOP_PROTOS(fsname)						\
    271 	int fsname##_fs_mount(struct puffs_usermount *, void **,	\
    272 	    struct statvfs *);						\
    273 	int fsname##_fs_unmount(struct puffs_cc *, int, pid_t);		\
    274 	int fsname##_fs_statvfs(struct puffs_cc *,			\
    275 	    struct statvfs *, pid_t);					\
    276 	int fsname##_fs_sync(struct puffs_cc *, int,			\
    277 	    const struct puffs_cred *cred, pid_t);			\
    278 	int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t,	\
    279 	    void **, enum vtype *, voff_t *, dev_t *);			\
    280 	int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie,	\
    281 	    void *, size_t *);						\
    282 	void fsname##_fs_suspend(struct puffs_cc *, int);		\
    283 									\
    284 	int fsname##_node_lookup(struct puffs_cc *,			\
    285 	    void *, void **, enum vtype *, voff_t *, dev_t *,		\
    286 	    const struct puffs_cn *);					\
    287 	int fsname##_node_create(struct puffs_cc *,			\
    288 	    void *, void **, const struct puffs_cn *,			\
    289 	    const struct vattr *);					\
    290 	int fsname##_node_mknod(struct puffs_cc *,			\
    291 	    void *, void **, const struct puffs_cn *,			\
    292 	    const struct vattr *);					\
    293 	int fsname##_node_open(struct puffs_cc *,			\
    294 	    void *, int, const struct puffs_cred *, pid_t);		\
    295 	int fsname##_node_close(struct puffs_cc *,			\
    296 	    void *, int, const struct puffs_cred *, pid_t);		\
    297 	int fsname##_node_access(struct puffs_cc *,			\
    298 	    void *, int, const struct puffs_cred *, pid_t);		\
    299 	int fsname##_node_getattr(struct puffs_cc *,			\
    300 	    void *, struct vattr *, const struct puffs_cred *, pid_t);	\
    301 	int fsname##_node_setattr(struct puffs_cc *,			\
    302 	    void *, const struct vattr *, const struct puffs_cred *,	\
    303 	    pid_t);							\
    304 	int fsname##_node_poll(struct puffs_cc *,			\
    305 	    void *, struct puffs_vnreq_poll *);				\
    306 	int fsname##_node_mmap(struct puffs_cc *,			\
    307 	    void *, int, const struct puffs_cred *, pid_t);		\
    308 	int fsname##_node_fsync(struct puffs_cc *,			\
    309 	    void *, const struct puffs_cred *, int, off_t, off_t,	\
    310 	    pid_t);							\
    311 	int fsname##_node_seek(struct puffs_cc *,			\
    312 	    void *, off_t, off_t, const struct puffs_cred *);		\
    313 	int fsname##_node_remove(struct puffs_cc *,			\
    314 	    void *, void *, const struct puffs_cn *);			\
    315 	int fsname##_node_link(struct puffs_cc *,			\
    316 	    void *, void *, const struct puffs_cn *);			\
    317 	int fsname##_node_rename(struct puffs_cc *,			\
    318 	    void *, void *, const struct puffs_cn *, void *, void *,	\
    319 	    const struct puffs_cn *);					\
    320 	int fsname##_node_mkdir(struct puffs_cc *,			\
    321 	    void *, void **, const struct puffs_cn *,			\
    322 	    const struct vattr *);					\
    323 	int fsname##_node_rmdir(struct puffs_cc *,			\
    324 	    void *, void *, const struct puffs_cn *);			\
    325 	int fsname##_node_symlink(struct puffs_cc *,			\
    326 	    void *, void **, const struct puffs_cn *,			\
    327 	    const struct vattr *, const char *);			\
    328 	int fsname##_node_readdir(struct puffs_cc *,			\
    329 	    void *, struct dirent *, off_t *, size_t *,			\
    330 	    const struct puffs_cred *, int *, off_t *, size_t *);	\
    331 	int fsname##_node_readlink(struct puffs_cc *,			\
    332 	    void *, const struct puffs_cred *, char *, size_t *);	\
    333 	int fsname##_node_reclaim(struct puffs_cc *,			\
    334 	    void *, pid_t);						\
    335 	int fsname##_node_inactive(struct puffs_cc *,			\
    336 	    void *, pid_t, int *);					\
    337 	int fsname##_node_print(struct puffs_cc *,			\
    338 	    void *);							\
    339 	int fsname##_node_pathconf(struct puffs_cc *,			\
    340 	    void *, int, int *);					\
    341 	int fsname##_node_advlock(struct puffs_cc *,			\
    342 	    void *, void *, int, struct flock *, int);			\
    343 	int fsname##_node_getextattr(struct puffs_cc *,			\
    344 	    void *, struct puffs_vnreq_getextattr *);			\
    345 	int fsname##_node_setextattr(struct puffs_cc *,			\
    346 	    void *, struct puffs_vnreq_setextattr *);			\
    347 	int fsname##_node_listextattr(struct puffs_cc *,		\
    348 	    void *, struct puffs_vnreq_listextattr *);			\
    349 	int fsname##_node_read(struct puffs_cc *, void *,		\
    350 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
    351 	int fsname##_node_write(struct puffs_cc *, void *,		\
    352 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
    353 									\
    354 	int fsname##_cache_write(struct puffs_usermount *, void *,	\
    355 	    size_t, struct puffs_cacheinfo *);
    356 
    357 #define PUFFSOP_INIT(ops)						\
    358     ops = malloc(sizeof(struct puffs_ops));				\
    359     memset(ops, 0, sizeof(struct puffs_ops))
    360 #define PUFFSOP_SET(ops, fsname, fsornode, opname)			\
    361     (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname
    362 #define PUFFSOP_SETFSNOP(ops, opname)					\
    363     (ops)->puffs_fs_##opname = puffs_fsnop_##opname
    364 
    365 #define PUFFS_DEVEL_LIBVERSION 17
    366 #define puffs_mount(a,b,c,d,e,f) \
    367     _puffs_mount(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e,f)
    368 #define puffs_init(a,b,c,d) \
    369     _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d)
    370 
    371 
    372 #define PNPATH(pnode)	((pnode)->pn_po.po_path)
    373 #define PNPLEN(pnode)	((pnode)->pn_po.po_len)
    374 #define PCNPATH(pcnode)	((pcnode)->pcn_po_full.po_path)
    375 #define PCNPLEN(pcnode)	((pcnode)->pcn_po_full.po_len)
    376 #define PCNISDOTDOT(pcnode) \
    377 	((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0)
    378 
    379 #define PUFFS_STORE_DCOOKIE(cp, ncp, off)				\
    380 if (cp)	{								\
    381 	*((cp)++) = off;						\
    382 	(*(ncp))++;							\
    383 }
    384 
    385 /* mainloop */
    386 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *);
    387 
    388 /* framebuf stuff */
    389 struct puffs_framebuf;
    390 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *,
    391 					   struct puffs_framebuf *,
    392 					   int, int *);
    393 typedef	int (*puffs_framev_writeframe_fn)(struct puffs_usermount *,
    394 					    struct puffs_framebuf *,
    395 					    int, int *);
    396 typedef int (*puffs_framev_respcmp_fn)(struct puffs_usermount *,
    397 					 struct puffs_framebuf *,
    398 					 struct puffs_framebuf *);
    399 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int);
    400 typedef void (*puffs_framev_cb)(struct puffs_usermount *,
    401 				struct puffs_framebuf *,
    402 				void *);
    403 #define PUFFS_FBGONE_READ	0x01
    404 #define PUFFS_FBGONE_WRITE	0x02
    405 #define PUFFS_FBGONE_BOTH(a)	((a)==(PUFFS_FBGONE_READ|PUFFS_FBGONE_WRITE))
    406 
    407 
    408 __BEGIN_DECLS
    409 
    410 struct puffs_usermount *_puffs_mount(int, struct puffs_ops *, const char *, int,
    411 				    const char *, void *, uint32_t);
    412 struct puffs_usermount *_puffs_init(int, struct puffs_ops *pops, const char *,
    413 				    void *, uint32_t);
    414 int		puffs_domount(struct puffs_usermount *, const char *, int);
    415 int		puffs_start(struct puffs_usermount *, void *, struct statvfs *);
    416 int		puffs_exit(struct puffs_usermount *, int);
    417 int		puffs_mainloop(struct puffs_usermount *, int);
    418 
    419 
    420 int	puffs_getselectable(struct puffs_usermount *);
    421 int	puffs_setblockingmode(struct puffs_usermount *, int);
    422 int	puffs_getstate(struct puffs_usermount *);
    423 void	puffs_setstacksize(struct puffs_usermount *, size_t);
    424 
    425 void	puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn);
    426 void	puffs_ml_settimeout(struct puffs_usermount *, struct timespec *);
    427 
    428 void			puffs_setroot(struct puffs_usermount *,
    429 				      struct puffs_node *);
    430 struct puffs_node 	*puffs_getroot(struct puffs_usermount *);
    431 void			*puffs_getspecific(struct puffs_usermount *);
    432 void			puffs_setmaxreqlen(struct puffs_usermount *, size_t);
    433 size_t			puffs_getmaxreqlen(struct puffs_usermount *);
    434 void			puffs_setfhsize(struct puffs_usermount *, size_t, int);
    435 
    436 void			puffs_setncookiehash(struct puffs_usermount *, int);
    437 
    438 struct puffs_pathobj	*puffs_getrootpathobj(struct puffs_usermount *);
    439 
    440 void			puffs_setback(struct puffs_cc *, int);
    441 
    442 struct puffs_node	*puffs_pn_new(struct puffs_usermount *, void *);
    443 void			puffs_pn_put(struct puffs_node *);
    444 
    445 void			*puffs_pn_getmntspecific(struct puffs_node *);
    446 
    447 typedef		void *	(*puffs_nodewalk_fn)(struct puffs_usermount *,
    448 					     struct puffs_node *, void *);
    449 void			*puffs_pn_nodewalk(struct puffs_usermount *,
    450 					   puffs_nodewalk_fn, void *);
    451 
    452 void			puffs_setvattr(struct vattr *, const struct vattr *);
    453 void			puffs_vattr_null(struct vattr *);
    454 
    455 /*
    456  * generic/dummy routines applicable for some file systems
    457  */
    458 int  puffs_fsnop_unmount(struct puffs_cc *, int, pid_t);
    459 int  puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, pid_t);
    460 void puffs_zerostatvfs(struct statvfs *);
    461 int  puffs_fsnop_sync(struct puffs_cc *, int waitfor,
    462 		      const struct puffs_cred *, pid_t);
    463 int  puffs_genfs_node_reclaim(struct puffs_cc *, void *, pid_t);
    464 
    465 /*
    466  * Subroutine stuff
    467  */
    468 
    469 int		puffs_gendotdent(struct dirent **, ino_t, int, size_t *);
    470 int		puffs_nextdent(struct dirent **, const char *, ino_t,
    471 			       uint8_t, size_t *);
    472 int		puffs_vtype2dt(enum vtype);
    473 enum vtype	puffs_mode2vt(mode_t);
    474 void		puffs_stat2vattr(struct vattr *va, const struct stat *);
    475 mode_t		puffs_addvtype2mode(mode_t, enum vtype);
    476 
    477 
    478 /*
    479  * credentials & permissions
    480  */
    481 
    482 /* Credential fetch */
    483 int	puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *);
    484 int	puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *);
    485 int	puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *);
    486 
    487 /* Credential check */
    488 int	puffs_cred_isuid(const struct puffs_cred *, uid_t);
    489 int	puffs_cred_hasgroup(const struct puffs_cred *, gid_t);
    490 int	puffs_cred_isregular(const struct puffs_cred *);
    491 int	puffs_cred_iskernel(const struct puffs_cred *);
    492 int	puffs_cred_isfs(const struct puffs_cred *);
    493 int	puffs_cred_isjuggernaut(const struct puffs_cred *);
    494 
    495 /* misc */
    496 int	puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t,
    497 		     const struct puffs_cred *);
    498 int	puffs_access_chown(uid_t, gid_t, uid_t, gid_t,
    499 			   const struct puffs_cred *);
    500 int	puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t,
    501 			   const struct puffs_cred *);
    502 int	puffs_access_times(uid_t, gid_t, mode_t, int,
    503 			   const struct puffs_cred *);
    504 
    505 
    506 /*
    507  * Requests
    508  */
    509 
    510 struct puffs_getreq	*puffs_req_makeget(struct puffs_usermount *,
    511 					   size_t, int);
    512 int			puffs_req_loadget(struct puffs_getreq *);
    513 struct puffs_req	*puffs_req_get(struct puffs_getreq *);
    514 int			puffs_req_remainingget(struct puffs_getreq *);
    515 void			puffs_req_setmaxget(struct puffs_getreq *, int);
    516 void			puffs_req_destroyget(struct puffs_getreq *);
    517 
    518 struct puffs_putreq	*puffs_req_makeput(struct puffs_usermount *);
    519 void			puffs_req_put(struct puffs_putreq *,struct puffs_req *);
    520 void			puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*);
    521 int			puffs_req_putput(struct puffs_putreq *);
    522 void			puffs_req_resetput(struct puffs_putreq *);
    523 void			puffs_req_destroyput(struct puffs_putreq *);
    524 
    525 int			puffs_req_handle(struct puffs_getreq *,
    526 					 struct puffs_putreq *, int);
    527 
    528 /*
    529  * Call Context interfaces relevant for user.
    530  */
    531 
    532 void			puffs_cc_yield(struct puffs_cc *);
    533 void			puffs_cc_continue(struct puffs_cc *);
    534 struct puffs_usermount	*puffs_cc_getusermount(struct puffs_cc *);
    535 void 			*puffs_cc_getspecific(struct puffs_cc *);
    536 struct puffs_cc 	*puffs_cc_create(struct puffs_usermount *);
    537 void			puffs_cc_destroy(struct puffs_cc *);
    538 
    539 /*
    540  * Execute or continue a request
    541  */
    542 
    543 int	puffs_dopreq(struct puffs_usermount *, struct puffs_req *,
    544 		     struct puffs_putreq *);
    545 void	puffs_docc(struct puffs_cc *, struct puffs_putreq *);
    546 
    547 /*
    548  * Flushing / invalidation routines
    549  */
    550 
    551 int	puffs_inval_namecache_dir(struct puffs_usermount *, void *);
    552 int	puffs_inval_namecache_all(struct puffs_usermount *);
    553 
    554 int	puffs_inval_pagecache_node(struct puffs_usermount *, void *);
    555 int	puffs_inval_pagecache_node_range(struct puffs_usermount *, void *,
    556 					 off_t, off_t);
    557 int	puffs_flush_pagecache_node(struct puffs_usermount *, void *);
    558 int	puffs_flush_pagecache_node_range(struct puffs_usermount *, void *,
    559 					 off_t, off_t);
    560 
    561 /*
    562  * Path constructicons
    563  */
    564 
    565 int	puffs_stdpath_buildpath(struct puffs_usermount *,
    566 			     const struct puffs_pathobj *,
    567 			     const struct puffs_pathobj *, size_t,
    568 			     struct puffs_pathobj *);
    569 int	puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *,
    570 			   struct puffs_pathobj *, size_t, int);
    571 void	puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *);
    572 
    573 void	*puffs_path_walkcmp(struct puffs_usermount *,
    574 			    struct puffs_node *, void *);
    575 void	*puffs_path_prefixadj(struct puffs_usermount *,
    576 			      struct puffs_node *, void *);
    577 int	puffs_path_pcnbuild(struct puffs_usermount *,
    578 			    struct puffs_cn *, void *);
    579 void	puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *);
    580 
    581 void	puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn);
    582 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 /*
    588  * Suspension
    589  */
    590 
    591 int	puffs_fs_suspend(struct puffs_usermount *);
    592 
    593 /*
    594  * Frame buffering
    595  */
    596 
    597 void	puffs_framev_init(struct puffs_usermount *,
    598 			  puffs_framev_readframe_fn,
    599 			  puffs_framev_writeframe_fn,
    600 			  puffs_framev_respcmp_fn,
    601 			  puffs_framev_fdnotify_fn);
    602 
    603 struct puffs_framebuf 	*puffs_framebuf_make(void);
    604 void			puffs_framebuf_destroy(struct puffs_framebuf *);
    605 void			puffs_framebuf_recycle(struct puffs_framebuf *);
    606 int			puffs_framebuf_reserve_space(struct puffs_framebuf *,
    607 						     size_t);
    608 
    609 int	puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t);
    610 int	puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t,
    611 				     const void *, size_t);
    612 int	puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t);
    613 int	puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t,
    614 				     void *, size_t);
    615 
    616 size_t	puffs_framebuf_telloff(struct puffs_framebuf *);
    617 size_t	puffs_framebuf_tellsize(struct puffs_framebuf *);
    618 size_t	puffs_framebuf_remaining(struct puffs_framebuf *);
    619 int	puffs_framebuf_seekset(struct puffs_framebuf *, size_t);
    620 int	puffs_framebuf_getwindow(struct puffs_framebuf *, size_t,
    621 				 void **, size_t *);
    622 
    623 int	puffs_framev_enqueue_cc(struct puffs_cc *, int,
    624 				struct puffs_framebuf *);
    625 int	puffs_framev_enqueue_cb(struct puffs_usermount *, int,
    626 				struct puffs_framebuf *,
    627 				puffs_framev_cb, void *);
    628 int	puffs_framev_enqueue_justsend(struct puffs_usermount *, int,
    629 				      struct puffs_framebuf *, int);
    630 
    631 int	puffs_framev_addfd(struct puffs_usermount *pu, int);
    632 int	puffs_framev_removefd(struct puffs_usermount *pu, int, int);
    633 void	puffs_framev_unmountonclose(struct puffs_usermount *pu, int, int);
    634 
    635 __END_DECLS
    636 
    637 #endif /* _PUFFS_H_ */
    638