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