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