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