Home | History | Annotate | Line # | Download | only in libpuffs
puffs.h revision 1.48
      1 /*	$NetBSD: puffs.h,v 1.48 2007/04/22 18:02:44 pooka Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2005, 2006  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 };
     61 
     62 /* for prefix rename */
     63 struct puffs_pathinfo {
     64 	struct puffs_pathobj *pi_old;
     65 	struct puffs_pathobj *pi_new;
     66 };
     67 
     68 /* describes one segment cached in the kernel */
     69 struct puffs_kcache {
     70 	off_t	pkc_start;
     71 	off_t	pkc_end;
     72 
     73 	LIST_ENTRY(puffs_kcache) pkc_entries;
     74 };
     75 
     76 /* XXX: might disappear from here into a private header */
     77 struct puffs_node {
     78 	off_t			pn_size;
     79 	int			pn_flag;
     80 	struct vattr		pn_va;
     81 
     82 	void			*pn_data;	/* private data		*/
     83 
     84 	struct puffs_pathobj	pn_po;		/* PUFFS_FLAG_BUILDPATH */
     85 
     86 	struct puffs_usermount 	*pn_mnt;
     87 	LIST_ENTRY(puffs_node)	pn_entries;
     88 
     89 	LIST_HEAD(,puffs_kcache)pn_cacheinfo;	/* PUFFS_KFLAG_CACHE	*/
     90 };
     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 *,
    172 	    void *, struct puffs_vnreq_poll *);
    173 	int (*puffs_node_mmap)(struct puffs_cc *,
    174 	    void *, int, const struct puffs_cred *, pid_t);
    175 	int (*puffs_node_fsync)(struct puffs_cc *,
    176 	    void *, const struct puffs_cred *, int, off_t, off_t, pid_t);
    177 	int (*puffs_node_seek)(struct puffs_cc *,
    178 	    void *, off_t, off_t, const struct puffs_cred *);
    179 	int (*puffs_node_remove)(struct puffs_cc *,
    180 	    void *, void *, const struct puffs_cn *);
    181 	int (*puffs_node_link)(struct puffs_cc *,
    182 	    void *, void *, const struct puffs_cn *);
    183 	int (*puffs_node_rename)(struct puffs_cc *,
    184 	    void *, void *, const struct puffs_cn *, void *, void *,
    185 	    const struct puffs_cn *);
    186 	int (*puffs_node_mkdir)(struct puffs_cc *,
    187 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    188 	int (*puffs_node_rmdir)(struct puffs_cc *,
    189 	    void *, void *, const struct puffs_cn *);
    190 	int (*puffs_node_symlink)(struct puffs_cc *,
    191 	    void *, void **, const struct puffs_cn *, const struct vattr *,
    192 	    const char *);
    193 	int (*puffs_node_readdir)(struct puffs_cc *,
    194 	    void *, struct dirent *, off_t *, size_t *,
    195 	    const struct puffs_cred *, int *, off_t *, size_t *);
    196 	int (*puffs_node_readlink)(struct puffs_cc *,
    197 	    void *, const struct puffs_cred *, char *, size_t *);
    198 	int (*puffs_node_reclaim)(struct puffs_cc *,
    199 	    void *, pid_t);
    200 	int (*puffs_node_inactive)(struct puffs_cc *,
    201 	    void *, pid_t, int *);
    202 	int (*puffs_node_print)(struct puffs_cc *,
    203 	    void *);
    204 	int (*puffs_node_pathconf)(struct puffs_cc *,
    205 	    void *, int, int *);
    206 	int (*puffs_node_advlock)(struct puffs_cc *,
    207 	    void *, void *, int, struct flock *, int);
    208 	int (*puffs_node_getextattr)(struct puffs_cc *,
    209 	    void *, struct puffs_vnreq_getextattr *);
    210 	int (*puffs_node_setextattr)(struct puffs_cc *,
    211 	    void *, struct puffs_vnreq_setextattr *);
    212 	int (*puffs_node_listextattr)(struct puffs_cc *,
    213 	    void *, struct puffs_vnreq_listextattr *);
    214 	int (*puffs_node_read)(struct puffs_cc *, void *,
    215 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    216 	int (*puffs_node_write)(struct puffs_cc *, void *,
    217 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    218 
    219 	int (*puffs_cache_write)(struct puffs_usermount *,
    220 		void *, size_t, struct puffs_cacherun *);
    221 };
    222 
    223 typedef	int (*pu_pathbuild_fn)(struct puffs_usermount *,
    224 			       const struct puffs_pathobj *,
    225 			       const struct puffs_pathobj *, size_t,
    226 			       struct puffs_pathobj *);
    227 typedef int (*pu_pathtransform_fn)(struct puffs_usermount *,
    228 				   const struct puffs_pathobj *,
    229 				   const struct puffs_cn *,
    230 				   struct puffs_pathobj *);
    231 typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *,
    232 			  struct puffs_pathobj *, size_t, int);
    233 typedef void (*pu_pathfree_fn)(struct puffs_usermount *,
    234 			       struct puffs_pathobj *);
    235 typedef int (*pu_namemod_fn)(struct puffs_usermount *,
    236 			     struct puffs_pathobj *, struct puffs_cn *);
    237 
    238 enum {
    239 	PUFFS_STATE_BEFOREMOUNT,
    240 	PUFFS_STATE_MOUNTING,		PUFFS_STATE_RUNNING,
    241 	PUFFS_STATE_UNMOUNTING,		PUFFS_STATE_UNMOUNTED
    242 };
    243 
    244 #define PUFFS_FLAG_BUILDPATH	0x80000000	/* node paths in pnode */
    245 #define PUFFS_FLAG_OPDUMP	0x40000000	/* dump all operations */
    246 #define PUFFS_FLAG_MASK		0xc0000000
    247 
    248 #define PUFFS_FLAG_KERN(a)	((a) & PUFFS_KFLAG_MASK)
    249 #define PUFFS_FLAG_LIB(a)	((a) & PUFFS_FLAG_MASK)
    250 
    251 /* blocking mode argument */
    252 #define PUFFSDEV_BLOCK 0
    253 #define PUFFSDEV_NONBLOCK 1
    254 
    255 /* mainloop flags */
    256 #define PUFFSLOOP_NODAEMON 0x01
    257 
    258 #define		DENT_DOT	0
    259 #define		DENT_DOTDOT	1
    260 #define		DENT_ADJ(a)	((a)-2)	/* nth request means dir's n-2th */
    261 
    262 
    263 /*
    264  * protos
    265  */
    266 
    267 #define PUFFSOP_PROTOS(fsname)						\
    268 	int fsname##_fs_mount(struct puffs_usermount *, void **,	\
    269 	    struct statvfs *);						\
    270 	int fsname##_fs_unmount(struct puffs_cc *, int, pid_t);		\
    271 	int fsname##_fs_statvfs(struct puffs_cc *,			\
    272 	    struct statvfs *, pid_t);					\
    273 	int fsname##_fs_sync(struct puffs_cc *, int,			\
    274 	    const struct puffs_cred *cred, pid_t);			\
    275 	int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t,	\
    276 	    void **, enum vtype *, voff_t *, dev_t *);			\
    277 	int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie,	\
    278 	    void *, size_t *);						\
    279 	void fsname##_fs_suspend(struct puffs_cc *, int);		\
    280 									\
    281 	int fsname##_node_lookup(struct puffs_cc *,			\
    282 	    void *, void **, enum vtype *, voff_t *, dev_t *,		\
    283 	    const struct puffs_cn *);					\
    284 	int fsname##_node_create(struct puffs_cc *,			\
    285 	    void *, void **, const struct puffs_cn *,			\
    286 	    const struct vattr *);					\
    287 	int fsname##_node_mknod(struct puffs_cc *,			\
    288 	    void *, void **, const struct puffs_cn *,			\
    289 	    const struct vattr *);					\
    290 	int fsname##_node_open(struct puffs_cc *,			\
    291 	    void *, int, const struct puffs_cred *, pid_t);		\
    292 	int fsname##_node_close(struct puffs_cc *,			\
    293 	    void *, int, const struct puffs_cred *, pid_t);		\
    294 	int fsname##_node_access(struct puffs_cc *,			\
    295 	    void *, int, const struct puffs_cred *, pid_t);		\
    296 	int fsname##_node_getattr(struct puffs_cc *,			\
    297 	    void *, struct vattr *, const struct puffs_cred *, pid_t);	\
    298 	int fsname##_node_setattr(struct puffs_cc *,			\
    299 	    void *, const struct vattr *, const struct puffs_cred *,	\
    300 	    pid_t);							\
    301 	int fsname##_node_poll(struct puffs_cc *,			\
    302 	    void *, struct puffs_vnreq_poll *);				\
    303 	int fsname##_node_mmap(struct puffs_cc *,			\
    304 	    void *, int, const struct puffs_cred *, pid_t);		\
    305 	int fsname##_node_fsync(struct puffs_cc *,			\
    306 	    void *, const struct puffs_cred *, int, off_t, off_t,	\
    307 	    pid_t);							\
    308 	int fsname##_node_seek(struct puffs_cc *,			\
    309 	    void *, off_t, off_t, const struct puffs_cred *);		\
    310 	int fsname##_node_remove(struct puffs_cc *,			\
    311 	    void *, void *, const struct puffs_cn *);			\
    312 	int fsname##_node_link(struct puffs_cc *,			\
    313 	    void *, void *, const struct puffs_cn *);			\
    314 	int fsname##_node_rename(struct puffs_cc *,			\
    315 	    void *, void *, const struct puffs_cn *, void *, void *,	\
    316 	    const struct puffs_cn *);					\
    317 	int fsname##_node_mkdir(struct puffs_cc *,			\
    318 	    void *, void **, const struct puffs_cn *,			\
    319 	    const struct vattr *);					\
    320 	int fsname##_node_rmdir(struct puffs_cc *,			\
    321 	    void *, void *, const struct puffs_cn *);			\
    322 	int fsname##_node_symlink(struct puffs_cc *,			\
    323 	    void *, void **, const struct puffs_cn *,			\
    324 	    const struct vattr *, const char *);			\
    325 	int fsname##_node_readdir(struct puffs_cc *,			\
    326 	    void *, struct dirent *, off_t *, size_t *,			\
    327 	    const struct puffs_cred *, int *, off_t *, size_t *);	\
    328 	int fsname##_node_readlink(struct puffs_cc *,			\
    329 	    void *, const struct puffs_cred *, char *, size_t *);	\
    330 	int fsname##_node_reclaim(struct puffs_cc *,			\
    331 	    void *, pid_t);						\
    332 	int fsname##_node_inactive(struct puffs_cc *,			\
    333 	    void *, pid_t, int *);					\
    334 	int fsname##_node_print(struct puffs_cc *,			\
    335 	    void *);							\
    336 	int fsname##_node_pathconf(struct puffs_cc *,			\
    337 	    void *, int, int *);					\
    338 	int fsname##_node_advlock(struct puffs_cc *,			\
    339 	    void *, void *, int, struct flock *, int);			\
    340 	int fsname##_node_getextattr(struct puffs_cc *,			\
    341 	    void *, struct puffs_vnreq_getextattr *);			\
    342 	int fsname##_node_setextattr(struct puffs_cc *,			\
    343 	    void *, struct puffs_vnreq_setextattr *);			\
    344 	int fsname##_node_listextattr(struct puffs_cc *,		\
    345 	    void *, struct puffs_vnreq_listextattr *);			\
    346 	int fsname##_node_read(struct puffs_cc *, void *,		\
    347 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
    348 	int fsname##_node_write(struct puffs_cc *, void *,		\
    349 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
    350 									\
    351 	int fsname##_cache_write(struct puffs_usermount *, void *,	\
    352 	    size_t, struct puffs_cacheinfo *);
    353 
    354 #define PUFFSOP_INIT(ops)						\
    355     ops = malloc(sizeof(struct puffs_ops));				\
    356     memset(ops, 0, sizeof(struct puffs_ops))
    357 #define PUFFSOP_SET(ops, fsname, fsornode, opname)			\
    358     (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname
    359 #define PUFFSOP_SETFSNOP(ops, opname)					\
    360     (ops)->puffs_fs_##opname = puffs_fsnop_##opname
    361 
    362 #define PUFFS_DEVEL_LIBVERSION 13
    363 #define puffs_mount(a,b,c,d,e,f) \
    364     _puffs_mount(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e,f)
    365 #define puffs_init(a,b,c,d) \
    366     _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d)
    367 
    368 
    369 #define PNPATH(pnode)	((pnode)->pn_po.po_path)
    370 #define PNPLEN(pnode)	((pnode)->pn_po.po_len)
    371 #define PCNPATH(pcnode)	((pcnode)->pcn_po_full.po_path)
    372 #define PCNPLEN(pcnode)	((pcnode)->pcn_po_full.po_len)
    373 #define PCNISDOTDOT(pcnode) \
    374 	((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0)
    375 
    376 #define PUFFS_STORE_DCOOKIE(cp, ncp, off)				\
    377 if (cp)	{								\
    378 	*((cp)++) = off;						\
    379 	(*(ncp))++;							\
    380 }
    381 
    382 __BEGIN_DECLS
    383 
    384 struct puffs_usermount *_puffs_mount(int, struct puffs_ops *, const char *, int,
    385 				    const char *, void *, uint32_t);
    386 struct puffs_usermount *_puffs_init(int, struct puffs_ops *pops, const char *,
    387 				    void *, uint32_t);
    388 int		puffs_domount(struct puffs_usermount *, const char *, int);
    389 int		puffs_start(struct puffs_usermount *, void *, struct statvfs *);
    390 int		puffs_exit(struct puffs_usermount *, int);
    391 int		puffs_mainloop(struct puffs_usermount *, int);
    392 
    393 
    394 int	puffs_getselectable(struct puffs_usermount *);
    395 int	puffs_setblockingmode(struct puffs_usermount *, int);
    396 int	puffs_getstate(struct puffs_usermount *);
    397 void	puffs_setstacksize(struct puffs_usermount *, size_t);
    398 
    399 void			puffs_setroot(struct puffs_usermount *,
    400 				      struct puffs_node *);
    401 struct puffs_node 	*puffs_getroot(struct puffs_usermount *);
    402 void			*puffs_getspecific(struct puffs_usermount *);
    403 void			puffs_setmaxreqlen(struct puffs_usermount *, size_t);
    404 size_t			puffs_getmaxreqlen(struct puffs_usermount *);
    405 void			puffs_setfhsize(struct puffs_usermount *, size_t, int);
    406 
    407 void			puffs_setncookiehash(struct puffs_usermount *, int);
    408 
    409 struct puffs_pathobj	*puffs_getrootpathobj(struct puffs_usermount *);
    410 
    411 struct puffs_node	*puffs_pn_new(struct puffs_usermount *, void *);
    412 void			puffs_pn_put(struct puffs_node *);
    413 
    414 void			*puffs_pn_getmntspecific(struct puffs_node *);
    415 
    416 typedef		void *	(*puffs_nodewalk_fn)(struct puffs_usermount *,
    417 					     struct puffs_node *, void *);
    418 void			*puffs_pn_nodewalk(struct puffs_usermount *,
    419 					   puffs_nodewalk_fn, void *);
    420 
    421 void			puffs_setvattr(struct vattr *, const struct vattr *);
    422 void			puffs_vattr_null(struct vattr *);
    423 
    424 /*
    425  * generic/dummy routines applicable for some file systems
    426  */
    427 int  puffs_fsnop_unmount(struct puffs_cc *, int, pid_t);
    428 int  puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, pid_t);
    429 void puffs_zerostatvfs(struct statvfs *);
    430 int  puffs_fsnop_sync(struct puffs_cc *, int waitfor,
    431 		      const struct puffs_cred *, pid_t);
    432 int  puffs_genfs_node_reclaim(struct puffs_cc *, void *, pid_t);
    433 
    434 /*
    435  * Subroutine stuff
    436  */
    437 
    438 int		puffs_gendotdent(struct dirent **, ino_t, int, size_t *);
    439 int		puffs_nextdent(struct dirent **, const char *, ino_t,
    440 			       uint8_t, size_t *);
    441 int		puffs_vtype2dt(enum vtype);
    442 enum vtype	puffs_mode2vt(mode_t);
    443 void		puffs_stat2vattr(struct vattr *va, const struct stat *);
    444 mode_t		puffs_addvtype2mode(mode_t, enum vtype);
    445 
    446 
    447 /*
    448  * credentials & permissions
    449  */
    450 
    451 /* Credential fetch */
    452 int	puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *);
    453 int	puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *);
    454 int	puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *);
    455 
    456 /* Credential check */
    457 int	puffs_cred_isuid(const struct puffs_cred *, uid_t);
    458 int	puffs_cred_hasgroup(const struct puffs_cred *, gid_t);
    459 int	puffs_cred_isregular(const struct puffs_cred *);
    460 int	puffs_cred_iskernel(const struct puffs_cred *);
    461 int	puffs_cred_isfs(const struct puffs_cred *);
    462 int	puffs_cred_isjuggernaut(const struct puffs_cred *);
    463 
    464 /* misc */
    465 int	puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t,
    466 		     const struct puffs_cred *);
    467 int	puffs_access_chown(uid_t, gid_t, uid_t, gid_t,
    468 			   const struct puffs_cred *);
    469 int	puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t,
    470 			   const struct puffs_cred *);
    471 int	puffs_access_times(uid_t, gid_t, mode_t, int,
    472 			   const struct puffs_cred *);
    473 
    474 
    475 /*
    476  * Requests
    477  */
    478 
    479 struct puffs_getreq	*puffs_req_makeget(struct puffs_usermount *,
    480 					   size_t, int);
    481 int			puffs_req_loadget(struct puffs_getreq *);
    482 struct puffs_req	*puffs_req_get(struct puffs_getreq *);
    483 int			puffs_req_remainingget(struct puffs_getreq *);
    484 void			puffs_req_setmaxget(struct puffs_getreq *, int);
    485 void			puffs_req_destroyget(struct puffs_getreq *);
    486 
    487 struct puffs_putreq	*puffs_req_makeput(struct puffs_usermount *);
    488 void			puffs_req_put(struct puffs_putreq *,struct puffs_req *);
    489 void			puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*);
    490 int			puffs_req_putput(struct puffs_putreq *);
    491 void			puffs_req_resetput(struct puffs_putreq *);
    492 void			puffs_req_destroyput(struct puffs_putreq *);
    493 
    494 int			puffs_req_handle(struct puffs_usermount *,
    495 					 struct puffs_getreq *,
    496 					 struct puffs_putreq *, int);
    497 
    498 /*
    499  * Call Context interfaces relevant for user.
    500  */
    501 
    502 void			puffs_cc_yield(struct puffs_cc *);
    503 void			puffs_cc_continue(struct puffs_cc *);
    504 struct puffs_usermount	*puffs_cc_getusermount(struct puffs_cc *);
    505 void 			*puffs_cc_getspecific(struct puffs_cc *);
    506 struct puffs_cc 	*puffs_cc_create(struct puffs_usermount *);
    507 void			puffs_cc_destroy(struct puffs_cc *);
    508 
    509 /*
    510  * Execute or continue a request
    511  */
    512 
    513 int	puffs_dopreq(struct puffs_usermount *, struct puffs_req *,
    514 		     struct puffs_putreq *);
    515 int	puffs_docc(struct puffs_cc *, struct puffs_putreq *);
    516 
    517 /*
    518  * Flushing / invalidation routines
    519  */
    520 
    521 int	puffs_inval_namecache_dir(struct puffs_usermount *, void *);
    522 int	puffs_inval_namecache_all(struct puffs_usermount *);
    523 
    524 int	puffs_inval_pagecache_node(struct puffs_usermount *, void *);
    525 int	puffs_inval_pagecache_node_range(struct puffs_usermount *, void *,
    526 					 off_t, off_t);
    527 int	puffs_flush_pagecache_node(struct puffs_usermount *, void *);
    528 int	puffs_flush_pagecache_node_range(struct puffs_usermount *, void *,
    529 					 off_t, off_t);
    530 
    531 /*
    532  * Path constructicons
    533  */
    534 
    535 int	puffs_stdpath_buildpath(struct puffs_usermount *,
    536 			     const struct puffs_pathobj *,
    537 			     const struct puffs_pathobj *, size_t,
    538 			     struct puffs_pathobj *);
    539 int	puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *,
    540 			   struct puffs_pathobj *, size_t, int);
    541 void	puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *);
    542 
    543 void	*puffs_path_walkcmp(struct puffs_usermount *,
    544 			    struct puffs_node *, void *);
    545 void	*puffs_path_prefixadj(struct puffs_usermount *,
    546 			      struct puffs_node *, void *);
    547 int	puffs_path_pcnbuild(struct puffs_usermount *,
    548 			    struct puffs_cn *, void *);
    549 
    550 void	puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn);
    551 void	puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn);
    552 void	puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn);
    553 void	puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn);
    554 void	puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn);
    555 
    556 /*
    557  * Suspension
    558  */
    559 
    560 int	puffs_fs_suspend(struct puffs_usermount *);
    561 
    562 __END_DECLS
    563 
    564 #endif /* _PUFFS_H_ */
    565