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