Home | History | Annotate | Line # | Download | only in libpuffs
puffs.h revision 1.41
      1  1.41  pooka /*	$NetBSD: puffs.h,v 1.41 2007/04/11 21:04:52 pooka Exp $	*/
      2   1.1  pooka 
      3   1.1  pooka /*
      4   1.1  pooka  * Copyright (c) 2005, 2006  Antti Kantee.  All Rights Reserved.
      5   1.1  pooka  *
      6   1.1  pooka  * Development of this software was supported by the
      7   1.1  pooka  * Google Summer of Code program and the Ulla Tuominen Foundation.
      8   1.1  pooka  * The Google SoC project was mentored by Bill Studenmund.
      9   1.1  pooka  *
     10   1.1  pooka  * Redistribution and use in source and binary forms, with or without
     11   1.1  pooka  * modification, are permitted provided that the following conditions
     12   1.1  pooka  * are met:
     13   1.1  pooka  * 1. Redistributions of source code must retain the above copyright
     14   1.1  pooka  *    notice, this list of conditions and the following disclaimer.
     15   1.1  pooka  * 2. Redistributions in binary form must reproduce the above copyright
     16   1.1  pooka  *    notice, this list of conditions and the following disclaimer in the
     17   1.1  pooka  *    documentation and/or other materials provided with the distribution.
     18   1.1  pooka  * 3. The name of the company nor the name of the author may be used to
     19   1.1  pooka  *    endorse or promote products derived from this software without specific
     20   1.1  pooka  *    prior written permission.
     21   1.1  pooka  *
     22   1.1  pooka  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
     23   1.1  pooka  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     24   1.1  pooka  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     25   1.1  pooka  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     26   1.1  pooka  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27   1.1  pooka  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     28   1.1  pooka  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29   1.1  pooka  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30   1.1  pooka  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31   1.1  pooka  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32   1.1  pooka  * SUCH DAMAGE.
     33   1.1  pooka  */
     34   1.1  pooka 
     35  1.14  pooka #ifndef _PUFFS_H_
     36  1.14  pooka #define _PUFFS_H_
     37   1.1  pooka 
     38   1.1  pooka #include <sys/param.h>
     39  1.30  pooka #include <sys/types.h>
     40   1.1  pooka #include <sys/mount.h>
     41  1.23  pooka #include <sys/stat.h>
     42   1.1  pooka #include <sys/statvfs.h>
     43   1.1  pooka #include <sys/vnode.h>
     44   1.1  pooka 
     45   1.1  pooka #include <fs/puffs/puffs_msgif.h>
     46   1.1  pooka 
     47  1.19  pooka #include <mntopts.h>
     48  1.17  pooka #include <string.h>
     49  1.17  pooka 
     50  1.17  pooka /* forwards */
     51  1.17  pooka struct puffs_cc;
     52  1.17  pooka 
     53  1.17  pooka struct puffs_getreq;
     54  1.17  pooka struct puffs_putreq;
     55  1.17  pooka 
     56  1.25  pooka /* paths */
     57  1.25  pooka struct puffs_pathobj {
     58  1.25  pooka 	void 	*po_path;
     59  1.25  pooka 	size_t	po_len;
     60  1.25  pooka };
     61  1.25  pooka 
     62  1.25  pooka /* for prefix rename */
     63  1.25  pooka struct puffs_pathinfo {
     64  1.25  pooka 	struct puffs_pathobj *pi_old;
     65  1.25  pooka 	struct puffs_pathobj *pi_new;
     66  1.25  pooka };
     67  1.25  pooka 
     68  1.33  pooka /* describes one segment cached in the kernel */
     69  1.33  pooka struct puffs_kcache {
     70  1.33  pooka 	off_t	pkc_start;
     71  1.33  pooka 	off_t	pkc_end;
     72  1.33  pooka 
     73  1.33  pooka 	LIST_ENTRY(puffs_kcache) pkc_entries;
     74  1.33  pooka };
     75  1.33  pooka 
     76  1.25  pooka /* XXX: might disappear from here into a private header */
     77  1.17  pooka struct puffs_node {
     78  1.25  pooka 	off_t			pn_size;
     79  1.25  pooka 	int			pn_flag;
     80  1.25  pooka 	struct vattr		pn_va;
     81  1.17  pooka 
     82  1.25  pooka 	void			*pn_data;	/* private data		*/
     83  1.17  pooka 
     84  1.25  pooka 	struct puffs_pathobj	pn_po;		/* PUFFS_FLAG_BUILDPATH */
     85  1.17  pooka 
     86  1.25  pooka 	struct puffs_usermount 	*pn_mnt;
     87  1.25  pooka 	LIST_ENTRY(puffs_node)	pn_entries;
     88  1.33  pooka 
     89  1.33  pooka 	LIST_HEAD(,puffs_kcache)pn_cacheinfo;	/* PUFFS_KFLAG_CACHE	*/
     90  1.17  pooka };
     91  1.17  pooka 
     92  1.17  pooka 
     93  1.17  pooka struct puffs_usermount;
     94  1.17  pooka 
     95   1.1  pooka /*
     96   1.1  pooka  * megaXXX: these are values from inside _KERNEL
     97   1.1  pooka  * need to work on the translation for ALL the necessary values.
     98   1.1  pooka  */
     99   1.1  pooka #define PUFFS_VNOVAL (-1)
    100   1.1  pooka #define PUFFS_IO_APPEND 0x20
    101  1.34  pooka #define PUFFS_VEXEC	01
    102  1.34  pooka #define PUFFS_VWRITE	02
    103  1.34  pooka #define PUFFS_VREAD	04
    104   1.1  pooka 
    105  1.24  pooka #define PUFFS_FSYNC_DATAONLY 0x0002
    106  1.24  pooka #define PUFFS_FSYNC_CACHE    0x0100
    107  1.24  pooka 
    108   1.1  pooka /*
    109  1.17  pooka  * Magic constants
    110   1.1  pooka  */
    111  1.22  pooka #define PUFFS_CC_STACKSIZE_DEFAULT (1024*1024)
    112   1.1  pooka 
    113  1.17  pooka struct puffs_cn {
    114  1.17  pooka 	struct puffs_kcn	*pcn_pkcnp;	/* kernel input */
    115  1.25  pooka 	struct puffs_pathobj	pcn_po_full;	/* PUFFS_FLAG_BUILDPATH */
    116   1.1  pooka };
    117  1.17  pooka #define pcn_nameiop	pcn_pkcnp->pkcn_nameiop
    118  1.17  pooka #define pcn_flags	pcn_pkcnp->pkcn_flags
    119  1.17  pooka #define pcn_pid		pcn_pkcnp->pkcn_pid
    120  1.17  pooka #define pcn_cred	pcn_pkcnp->pkcn_cred
    121  1.17  pooka #define pcn_name	pcn_pkcnp->pkcn_name
    122  1.17  pooka #define pcn_namelen	pcn_pkcnp->pkcn_namelen
    123   1.1  pooka 
    124  1.19  pooka /*
    125  1.19  pooka  * Puffs options to mount
    126  1.19  pooka  */
    127  1.19  pooka /* kernel */
    128  1.19  pooka #define	PUFFSMOPT_CACHE		{ "cache", 1, PUFFS_KFLAG_NOCACHE, 1 }
    129  1.19  pooka #define PUFFSMOPT_ALLOPS	{ "allops", 0, PUFFS_KFLAG_ALLOPS, 1 }
    130  1.19  pooka 
    131  1.19  pooka /* libpuffs */
    132  1.19  pooka #define PUFFSMOPT_DUMP		{ "dump", 0, PUFFS_FLAG_OPDUMP, 1 }
    133  1.19  pooka 
    134  1.19  pooka #define PUFFSMOPT_STD							\
    135  1.19  pooka 	PUFFSMOPT_CACHE,						\
    136  1.19  pooka 	PUFFSMOPT_ALLOPS,						\
    137  1.19  pooka 	PUFFSMOPT_DUMP
    138  1.19  pooka 
    139  1.19  pooka extern const struct mntopt puffsmopts[]; /* puffs.c */
    140  1.19  pooka 
    141   1.1  pooka /* callbacks for operations */
    142  1.14  pooka struct puffs_ops {
    143  1.17  pooka 	int (*puffs_fs_unmount)(struct puffs_cc *, int, pid_t);
    144  1.17  pooka 	int (*puffs_fs_statvfs)(struct puffs_cc *,
    145   1.1  pooka 	    struct statvfs *, pid_t);
    146  1.17  pooka 	int (*puffs_fs_sync)(struct puffs_cc *, int,
    147   1.1  pooka 	    const struct puffs_cred *, pid_t);
    148  1.41  pooka 	int (*puffs_fs_fhtonode)(struct puffs_cc *, void *, size_t,
    149  1.41  pooka 	    void **, enum vtype *, voff_t *, dev_t *);
    150  1.41  pooka 	int (*puffs_fs_nodetofh)(struct puffs_cc *, void *cookie,
    151  1.41  pooka 	    void *, size_t *);
    152  1.29  pooka 	void (*puffs_fs_suspend)(struct puffs_cc *, int);
    153   1.1  pooka 
    154  1.17  pooka 	int (*puffs_node_lookup)(struct puffs_cc *,
    155   1.4  pooka 	    void *, void **, enum vtype *, voff_t *, dev_t *,
    156   1.3  pooka 	    const struct puffs_cn *);
    157  1.17  pooka 	int (*puffs_node_create)(struct puffs_cc *,
    158   1.1  pooka 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    159  1.17  pooka 	int (*puffs_node_mknod)(struct puffs_cc *,
    160   1.1  pooka 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    161  1.17  pooka 	int (*puffs_node_open)(struct puffs_cc *,
    162   1.1  pooka 	    void *, int, const struct puffs_cred *, pid_t);
    163  1.17  pooka 	int (*puffs_node_close)(struct puffs_cc *,
    164   1.1  pooka 	    void *, int, const struct puffs_cred *, pid_t);
    165  1.17  pooka 	int (*puffs_node_access)(struct puffs_cc *,
    166   1.1  pooka 	    void *, int, const struct puffs_cred *, pid_t);
    167  1.17  pooka 	int (*puffs_node_getattr)(struct puffs_cc *,
    168   1.1  pooka 	    void *, struct vattr *, const struct puffs_cred *, pid_t);
    169  1.17  pooka 	int (*puffs_node_setattr)(struct puffs_cc *,
    170   1.1  pooka 	    void *, const struct vattr *, const struct puffs_cred *, pid_t);
    171  1.17  pooka 	int (*puffs_node_poll)(struct puffs_cc *,
    172   1.1  pooka 	    void *, struct puffs_vnreq_poll *);
    173  1.17  pooka 	int (*puffs_node_mmap)(struct puffs_cc *,
    174  1.15  pooka 	    void *, int, const struct puffs_cred *, pid_t);
    175  1.17  pooka 	int (*puffs_node_fsync)(struct puffs_cc *,
    176   1.1  pooka 	    void *, const struct puffs_cred *, int, off_t, off_t, pid_t);
    177  1.17  pooka 	int (*puffs_node_seek)(struct puffs_cc *,
    178   1.1  pooka 	    void *, off_t, off_t, const struct puffs_cred *);
    179  1.17  pooka 	int (*puffs_node_remove)(struct puffs_cc *,
    180   1.1  pooka 	    void *, void *, const struct puffs_cn *);
    181  1.17  pooka 	int (*puffs_node_link)(struct puffs_cc *,
    182   1.1  pooka 	    void *, void *, const struct puffs_cn *);
    183  1.17  pooka 	int (*puffs_node_rename)(struct puffs_cc *,
    184   1.1  pooka 	    void *, void *, const struct puffs_cn *, void *, void *,
    185   1.1  pooka 	    const struct puffs_cn *);
    186  1.17  pooka 	int (*puffs_node_mkdir)(struct puffs_cc *,
    187   1.1  pooka 	    void *, void **, const struct puffs_cn *, const struct vattr *);
    188  1.17  pooka 	int (*puffs_node_rmdir)(struct puffs_cc *,
    189   1.1  pooka 	    void *, void *, const struct puffs_cn *);
    190  1.17  pooka 	int (*puffs_node_symlink)(struct puffs_cc *,
    191   1.1  pooka 	    void *, void **, const struct puffs_cn *, const struct vattr *,
    192   1.1  pooka 	    const char *);
    193  1.17  pooka 	int (*puffs_node_readdir)(struct puffs_cc *,
    194  1.41  pooka 	    void *, struct dirent *, off_t *, size_t *,
    195  1.41  pooka 	    const struct puffs_cred *, int *, off_t *, size_t *);
    196  1.17  pooka 	int (*puffs_node_readlink)(struct puffs_cc *,
    197   1.1  pooka 	    void *, const struct puffs_cred *, char *, size_t *);
    198  1.17  pooka 	int (*puffs_node_reclaim)(struct puffs_cc *,
    199   1.1  pooka 	    void *, pid_t);
    200  1.17  pooka 	int (*puffs_node_inactive)(struct puffs_cc *,
    201   1.2  pooka 	    void *, pid_t, int *);
    202  1.17  pooka 	int (*puffs_node_print)(struct puffs_cc *,
    203   1.1  pooka 	    void *);
    204  1.17  pooka 	int (*puffs_node_pathconf)(struct puffs_cc *,
    205   1.1  pooka 	    void *, int, int *);
    206  1.17  pooka 	int (*puffs_node_advlock)(struct puffs_cc *,
    207   1.1  pooka 	    void *, void *, int, struct flock *, int);
    208  1.17  pooka 	int (*puffs_node_getextattr)(struct puffs_cc *,
    209   1.1  pooka 	    void *, struct puffs_vnreq_getextattr *);
    210  1.17  pooka 	int (*puffs_node_setextattr)(struct puffs_cc *,
    211   1.1  pooka 	    void *, struct puffs_vnreq_setextattr *);
    212  1.17  pooka 	int (*puffs_node_listextattr)(struct puffs_cc *,
    213   1.1  pooka 	    void *, struct puffs_vnreq_listextattr *);
    214  1.17  pooka 	int (*puffs_node_read)(struct puffs_cc *, void *,
    215   1.1  pooka 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    216  1.17  pooka 	int (*puffs_node_write)(struct puffs_cc *, void *,
    217   1.1  pooka 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    218  1.33  pooka 
    219  1.33  pooka 	int (*puffs_cache_write)(struct puffs_usermount *,
    220  1.33  pooka 		void *, size_t, struct puffs_cacherun *);
    221   1.1  pooka };
    222   1.1  pooka 
    223  1.30  pooka typedef	int (*pu_pathbuild_fn)(struct puffs_usermount *,
    224  1.30  pooka 			       const struct puffs_pathobj *,
    225  1.30  pooka 			       const struct puffs_pathobj *, size_t,
    226  1.25  pooka 			       struct puffs_pathobj *);
    227  1.25  pooka typedef int (*pu_pathtransform_fn)(struct puffs_usermount *,
    228  1.30  pooka 				   const struct puffs_pathobj *,
    229  1.25  pooka 				   const struct puffs_cn *,
    230  1.25  pooka 				   struct puffs_pathobj *);
    231  1.25  pooka typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *,
    232  1.31  pooka 			  struct puffs_pathobj *, size_t, int);
    233  1.25  pooka typedef void (*pu_pathfree_fn)(struct puffs_usermount *,
    234  1.25  pooka 			       struct puffs_pathobj *);
    235  1.25  pooka typedef int (*pu_namemod_fn)(struct puffs_usermount *,
    236  1.25  pooka 			     struct puffs_pathobj *, struct puffs_cn *);
    237  1.25  pooka 
    238   1.1  pooka struct puffs_usermount {
    239  1.14  pooka 	struct puffs_ops	pu_ops;
    240   1.1  pooka 
    241   1.1  pooka 	int			pu_fd;
    242   1.1  pooka 	uint32_t		pu_flags;
    243   1.1  pooka 	size_t			pu_maxreqlen;
    244  1.17  pooka 	size_t			pu_cc_stacksize;
    245  1.17  pooka 
    246  1.17  pooka 	int			pu_state;
    247  1.17  pooka 
    248  1.17  pooka 	struct puffs_node	*pu_pn_root;
    249   1.1  pooka 
    250   1.1  pooka 	LIST_HEAD(, puffs_node)	pu_pnodelst;
    251   1.1  pooka 
    252  1.25  pooka 	struct puffs_node	*(*pu_cmap)(void *);
    253  1.25  pooka 
    254  1.25  pooka 	pu_pathbuild_fn		pu_pathbuild;
    255  1.25  pooka 	pu_pathtransform_fn	pu_pathtransform;
    256  1.25  pooka 	pu_pathcmp_fn		pu_pathcmp;
    257  1.25  pooka 	pu_pathfree_fn		pu_pathfree;
    258  1.25  pooka 	pu_namemod_fn		pu_namemod;
    259  1.25  pooka 
    260   1.1  pooka 	void	*pu_privdata;
    261   1.1  pooka };
    262   1.1  pooka 
    263  1.17  pooka enum {
    264  1.17  pooka 	PUFFS_STATE_MOUNTING,	PUFFS_STATE_RUNNING,
    265  1.17  pooka 	PUFFS_STATE_UNMOUNTING,	PUFFS_STATE_UNMOUNTED
    266  1.17  pooka };
    267  1.17  pooka 
    268  1.13  pooka #define PUFFS_FLAG_KERN(a)	((a) & 0x0000ffff)
    269  1.13  pooka #define PUFFS_FLAG_LIB(a)	((a) & 0xffff0000)
    270  1.12  pooka 
    271  1.19  pooka #define PUFFS_FLAG_BUILDPATH	0x80000000	/* node paths in pnode */
    272  1.19  pooka #define PUFFS_FLAG_OPDUMP	0x40000000	/* dump all operations */
    273   1.1  pooka 
    274  1.12  pooka /* blocking mode argument */
    275   1.5  pooka #define PUFFSDEV_BLOCK 0
    276   1.5  pooka #define PUFFSDEV_NONBLOCK 1
    277   1.5  pooka 
    278  1.12  pooka /* mainloop flags */
    279  1.12  pooka #define PUFFSLOOP_NODAEMON 0x01
    280  1.12  pooka 
    281   1.1  pooka #define		DENT_DOT	0
    282   1.1  pooka #define		DENT_DOTDOT	1
    283   1.1  pooka #define		DENT_ADJ(a)	((a)-2)	/* nth request means dir's n-2th */
    284   1.1  pooka 
    285   1.1  pooka 
    286   1.1  pooka /*
    287  1.17  pooka  * protos
    288  1.16  pooka  */
    289  1.16  pooka 
    290  1.14  pooka #define PUFFSOP_PROTOS(fsname)						\
    291  1.17  pooka 	int fsname##_fs_mount(struct puffs_usermount *, void **,	\
    292  1.17  pooka 	    struct statvfs *);						\
    293  1.17  pooka 	int fsname##_fs_unmount(struct puffs_cc *, int, pid_t);		\
    294  1.17  pooka 	int fsname##_fs_statvfs(struct puffs_cc *,			\
    295   1.1  pooka 	    struct statvfs *, pid_t);					\
    296  1.17  pooka 	int fsname##_fs_sync(struct puffs_cc *, int,			\
    297  1.14  pooka 	    const struct puffs_cred *cred, pid_t);			\
    298  1.41  pooka 	int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t,	\
    299  1.41  pooka 	    void **, enum vtype *, voff_t *, dev_t *);			\
    300  1.41  pooka 	int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie,	\
    301  1.41  pooka 	    void *, size_t *);						\
    302  1.29  pooka 	void fsname##_fs_suspend(struct puffs_cc *, int);		\
    303  1.14  pooka 									\
    304  1.17  pooka 	int fsname##_node_lookup(struct puffs_cc *,			\
    305   1.4  pooka 	    void *, void **, enum vtype *, voff_t *, dev_t *,		\
    306   1.3  pooka 	    const struct puffs_cn *);					\
    307  1.17  pooka 	int fsname##_node_create(struct puffs_cc *,			\
    308   1.1  pooka 	    void *, void **, const struct puffs_cn *,			\
    309   1.1  pooka 	    const struct vattr *);					\
    310  1.17  pooka 	int fsname##_node_mknod(struct puffs_cc *,			\
    311   1.1  pooka 	    void *, void **, const struct puffs_cn *,			\
    312   1.1  pooka 	    const struct vattr *);					\
    313  1.17  pooka 	int fsname##_node_open(struct puffs_cc *,			\
    314   1.1  pooka 	    void *, int, const struct puffs_cred *, pid_t);		\
    315  1.17  pooka 	int fsname##_node_close(struct puffs_cc *,			\
    316  1.11  pooka 	    void *, int, const struct puffs_cred *, pid_t);		\
    317  1.17  pooka 	int fsname##_node_access(struct puffs_cc *,			\
    318  1.11  pooka 	    void *, int, const struct puffs_cred *, pid_t);		\
    319  1.17  pooka 	int fsname##_node_getattr(struct puffs_cc *,			\
    320   1.1  pooka 	    void *, struct vattr *, const struct puffs_cred *, pid_t);	\
    321  1.17  pooka 	int fsname##_node_setattr(struct puffs_cc *,			\
    322   1.1  pooka 	    void *, const struct vattr *, const struct puffs_cred *,	\
    323   1.1  pooka 	    pid_t);							\
    324  1.17  pooka 	int fsname##_node_poll(struct puffs_cc *,			\
    325   1.1  pooka 	    void *, struct puffs_vnreq_poll *);				\
    326  1.17  pooka 	int fsname##_node_mmap(struct puffs_cc *,			\
    327  1.15  pooka 	    void *, int, const struct puffs_cred *, pid_t);		\
    328  1.17  pooka 	int fsname##_node_fsync(struct puffs_cc *,			\
    329   1.1  pooka 	    void *, const struct puffs_cred *, int, off_t, off_t,	\
    330   1.1  pooka 	    pid_t);							\
    331  1.17  pooka 	int fsname##_node_seek(struct puffs_cc *,			\
    332   1.1  pooka 	    void *, off_t, off_t, const struct puffs_cred *);		\
    333  1.17  pooka 	int fsname##_node_remove(struct puffs_cc *,			\
    334   1.1  pooka 	    void *, void *, const struct puffs_cn *);			\
    335  1.17  pooka 	int fsname##_node_link(struct puffs_cc *,			\
    336   1.1  pooka 	    void *, void *, const struct puffs_cn *);			\
    337  1.17  pooka 	int fsname##_node_rename(struct puffs_cc *,			\
    338   1.1  pooka 	    void *, void *, const struct puffs_cn *, void *, void *,	\
    339   1.1  pooka 	    const struct puffs_cn *);					\
    340  1.17  pooka 	int fsname##_node_mkdir(struct puffs_cc *,			\
    341   1.1  pooka 	    void *, void **, const struct puffs_cn *,			\
    342   1.1  pooka 	    const struct vattr *);					\
    343  1.17  pooka 	int fsname##_node_rmdir(struct puffs_cc *,			\
    344   1.1  pooka 	    void *, void *, const struct puffs_cn *);			\
    345  1.17  pooka 	int fsname##_node_symlink(struct puffs_cc *,			\
    346   1.1  pooka 	    void *, void **, const struct puffs_cn *,			\
    347   1.1  pooka 	    const struct vattr *, const char *);			\
    348  1.17  pooka 	int fsname##_node_readdir(struct puffs_cc *,			\
    349  1.41  pooka 	    void *, struct dirent *, off_t *, size_t *,			\
    350  1.41  pooka 	    const struct puffs_cred *, int *, off_t *, size_t *);	\
    351  1.17  pooka 	int fsname##_node_readlink(struct puffs_cc *,			\
    352   1.1  pooka 	    void *, const struct puffs_cred *, char *, size_t *);	\
    353  1.17  pooka 	int fsname##_node_reclaim(struct puffs_cc *,			\
    354   1.1  pooka 	    void *, pid_t);						\
    355  1.17  pooka 	int fsname##_node_inactive(struct puffs_cc *,			\
    356   1.2  pooka 	    void *, pid_t, int *);					\
    357  1.17  pooka 	int fsname##_node_print(struct puffs_cc *,			\
    358   1.1  pooka 	    void *);							\
    359  1.17  pooka 	int fsname##_node_pathconf(struct puffs_cc *,			\
    360   1.1  pooka 	    void *, int, int *);					\
    361  1.17  pooka 	int fsname##_node_advlock(struct puffs_cc *,			\
    362   1.1  pooka 	    void *, void *, int, struct flock *, int);			\
    363  1.17  pooka 	int fsname##_node_getextattr(struct puffs_cc *,			\
    364   1.1  pooka 	    void *, struct puffs_vnreq_getextattr *);			\
    365  1.17  pooka 	int fsname##_node_setextattr(struct puffs_cc *,			\
    366   1.1  pooka 	    void *, struct puffs_vnreq_setextattr *);			\
    367  1.17  pooka 	int fsname##_node_listextattr(struct puffs_cc *,		\
    368   1.1  pooka 	    void *, struct puffs_vnreq_listextattr *);			\
    369  1.17  pooka 	int fsname##_node_read(struct puffs_cc *, void *,		\
    370   1.1  pooka 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
    371  1.17  pooka 	int fsname##_node_write(struct puffs_cc *, void *,		\
    372  1.33  pooka 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
    373  1.33  pooka 									\
    374  1.33  pooka 	int fsname##_cache_write(struct puffs_usermount *, void *,	\
    375  1.33  pooka 	    size_t, struct puffs_cacheinfo *);
    376   1.1  pooka 
    377  1.14  pooka #define PUFFSOP_INIT(ops)						\
    378  1.17  pooka     ops = malloc(sizeof(struct puffs_ops));				\
    379  1.14  pooka     memset(ops, 0, sizeof(struct puffs_ops))
    380  1.14  pooka #define PUFFSOP_SET(ops, fsname, fsornode, opname)			\
    381  1.14  pooka     (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname
    382  1.14  pooka #define PUFFSOP_SETFSNOP(ops, opname)					\
    383  1.14  pooka     (ops)->puffs_fs_##opname = puffs_fsnop_##opname
    384  1.14  pooka 
    385  1.41  pooka #define PUFFS_DEVEL_LIBVERSION 11
    386  1.18  pooka #define puffs_mount(a,b,c,d,e,f,g) \
    387  1.18  pooka     _puffs_mount(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e,f,g)
    388  1.17  pooka 
    389  1.25  pooka 
    390  1.25  pooka #define PNPATH(pnode)	((pnode)->pn_po.po_path)
    391  1.25  pooka #define PNPLEN(pnode)	((pnode)->pn_po.po_len)
    392  1.25  pooka #define PCNPATH(pcnode)	((pcnode)->pcn_po_full.po_path)
    393  1.25  pooka #define PCNPLEN(pcnode)	((pcnode)->pcn_po_full.po_len)
    394  1.30  pooka #define PCNISDOTDOT(pcnode) \
    395  1.30  pooka 	((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0)
    396  1.25  pooka 
    397  1.17  pooka __BEGIN_DECLS
    398  1.17  pooka 
    399  1.18  pooka struct puffs_usermount *_puffs_mount(int, struct puffs_ops *, const char *, int,
    400  1.17  pooka 				    const char *, void *, uint32_t, size_t);
    401  1.19  pooka int		puffs_start(struct puffs_usermount *, void *, struct statvfs *);
    402  1.19  pooka int		puffs_exit(struct puffs_usermount *, int);
    403  1.17  pooka int		puffs_mainloop(struct puffs_usermount *, int);
    404  1.17  pooka 
    405  1.17  pooka 
    406  1.17  pooka int	puffs_getselectable(struct puffs_usermount *);
    407  1.17  pooka int	puffs_setblockingmode(struct puffs_usermount *, int);
    408  1.17  pooka int	puffs_getstate(struct puffs_usermount *);
    409  1.17  pooka void	puffs_setstacksize(struct puffs_usermount *, size_t);
    410  1.17  pooka 
    411  1.25  pooka struct puffs_pathobj	*puffs_getrootpathobj(struct puffs_usermount *);
    412  1.25  pooka 
    413  1.23  pooka struct puffs_node	*puffs_pn_new(struct puffs_usermount *, void *);
    414  1.17  pooka void			puffs_pn_put(struct puffs_node *);
    415  1.25  pooka 
    416  1.25  pooka typedef		void *	(*puffs_nodewalk_fn)(struct puffs_usermount *,
    417  1.25  pooka 					     struct puffs_node *, void *);
    418  1.25  pooka void			*puffs_pn_nodewalk(struct puffs_usermount *,
    419  1.25  pooka 					   puffs_nodewalk_fn, void *);
    420  1.23  pooka 
    421  1.17  pooka void			puffs_setvattr(struct vattr *, const struct vattr *);
    422  1.17  pooka void			puffs_vattr_null(struct vattr *);
    423  1.17  pooka 
    424  1.17  pooka /*
    425  1.30  pooka  * generic/dummy routines applicable for some file systems
    426  1.30  pooka  */
    427  1.30  pooka int  puffs_fsnop_unmount(struct puffs_cc *, int, pid_t);
    428  1.30  pooka int  puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, pid_t);
    429  1.30  pooka void puffs_zerostatvfs(struct statvfs *);
    430  1.30  pooka int  puffs_fsnop_sync(struct puffs_cc *, int waitfor,
    431  1.30  pooka 		      const struct puffs_cred *, pid_t);
    432  1.30  pooka int  puffs_genfs_node_reclaim(struct puffs_cc *, void *, pid_t);
    433  1.30  pooka 
    434  1.30  pooka /*
    435  1.23  pooka  * Subroutine stuff
    436  1.23  pooka  */
    437  1.23  pooka 
    438  1.23  pooka int		puffs_gendotdent(struct dirent **, ino_t, int, size_t *);
    439  1.23  pooka int		puffs_nextdent(struct dirent **, const char *, ino_t,
    440  1.23  pooka 			       uint8_t, size_t *);
    441  1.23  pooka int		puffs_vtype2dt(enum vtype);
    442  1.23  pooka enum vtype	puffs_mode2vt(mode_t);
    443  1.23  pooka void		puffs_stat2vattr(struct vattr *va, const struct stat *);
    444  1.32  pooka mode_t		puffs_addvtype2mode(mode_t, enum vtype);
    445  1.35  pooka 
    446  1.35  pooka 
    447  1.35  pooka /*
    448  1.35  pooka  * credentials & permissions
    449  1.35  pooka  */
    450  1.35  pooka 
    451  1.35  pooka /* Credential fetch */
    452  1.35  pooka int	puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *);
    453  1.35  pooka int	puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *);
    454  1.35  pooka int	puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *);
    455  1.35  pooka 
    456  1.35  pooka /* Credential check */
    457  1.36  pooka int	puffs_cred_isuid(const struct puffs_cred *, uid_t);
    458  1.36  pooka int	puffs_cred_hasgroup(const struct puffs_cred *, gid_t);
    459  1.37  pooka int	puffs_cred_isregular(const struct puffs_cred *);
    460  1.36  pooka int	puffs_cred_iskernel(const struct puffs_cred *);
    461  1.36  pooka int	puffs_cred_isfs(const struct puffs_cred *);
    462  1.36  pooka int	puffs_cred_isjuggernaut(const struct puffs_cred *);
    463  1.35  pooka 
    464  1.35  pooka /* misc */
    465  1.35  pooka int	puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t,
    466  1.35  pooka 		     const struct puffs_cred *);
    467  1.38  pooka int	puffs_access_chown(uid_t, gid_t, uid_t, gid_t,
    468  1.38  pooka 			   const struct puffs_cred *);
    469  1.38  pooka int	puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t,
    470  1.38  pooka 			   const struct puffs_cred *);
    471  1.38  pooka int	puffs_access_times(uid_t, gid_t, mode_t, int,
    472  1.38  pooka 			   const struct puffs_cred *);
    473  1.35  pooka 
    474  1.23  pooka 
    475  1.23  pooka /*
    476  1.17  pooka  * Requests
    477  1.17  pooka  */
    478  1.17  pooka 
    479  1.27  pooka struct puffs_getreq	*puffs_req_makeget(struct puffs_usermount *,
    480  1.27  pooka 					   size_t, int);
    481  1.27  pooka int			puffs_req_loadget(struct puffs_getreq *);
    482  1.27  pooka struct puffs_req	*puffs_req_get(struct puffs_getreq *);
    483  1.27  pooka int			puffs_req_remainingget(struct puffs_getreq *);
    484  1.27  pooka void			puffs_req_setmaxget(struct puffs_getreq *, int);
    485  1.27  pooka void			puffs_req_destroyget(struct puffs_getreq *);
    486  1.27  pooka 
    487  1.27  pooka struct puffs_putreq	*puffs_req_makeput(struct puffs_usermount *);
    488  1.27  pooka void			puffs_req_put(struct puffs_putreq *,struct puffs_req *);
    489  1.27  pooka void			puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*);
    490  1.27  pooka int			puffs_req_putput(struct puffs_putreq *);
    491  1.27  pooka void			puffs_req_resetput(struct puffs_putreq *);
    492  1.27  pooka void			puffs_req_destroyput(struct puffs_putreq *);
    493  1.27  pooka 
    494  1.27  pooka int			puffs_req_handle(struct puffs_usermount *,
    495  1.27  pooka 					 struct puffs_getreq *,
    496  1.27  pooka 					 struct puffs_putreq *, int);
    497  1.17  pooka 
    498  1.17  pooka /*
    499  1.17  pooka  * Call Context interfaces relevant for user.
    500  1.17  pooka  */
    501  1.17  pooka 
    502  1.17  pooka void			puffs_cc_yield(struct puffs_cc *);
    503  1.17  pooka void			puffs_cc_continue(struct puffs_cc *);
    504  1.17  pooka struct puffs_usermount	*puffs_cc_getusermount(struct puffs_cc *);
    505  1.19  pooka struct puffs_cc 	*puffs_cc_create(struct puffs_usermount *);
    506  1.19  pooka void			puffs_cc_destroy(struct puffs_cc *);
    507  1.17  pooka 
    508  1.17  pooka /*
    509  1.17  pooka  * Execute or continue a request
    510  1.17  pooka  */
    511  1.17  pooka 
    512  1.28  pooka int	puffs_dopreq(struct puffs_usermount *, struct puffs_req *,
    513  1.28  pooka 		     struct puffs_putreq *);
    514  1.28  pooka int	puffs_docc(struct puffs_cc *, struct puffs_putreq *);
    515  1.17  pooka 
    516  1.20  pooka /*
    517  1.20  pooka  * Flushing / invalidation routines
    518  1.20  pooka  */
    519  1.20  pooka 
    520  1.21  pooka int	puffs_inval_namecache_dir(struct puffs_usermount *, void *);
    521  1.21  pooka int	puffs_inval_namecache_all(struct puffs_usermount *);
    522  1.20  pooka 
    523  1.33  pooka int	puffs_inval_pagecache_node(struct puffs_usermount *, void *);
    524  1.39  pooka int	puffs_inval_pagecache_node_range(struct puffs_usermount *, void *,
    525  1.39  pooka 					 off_t, off_t);
    526  1.40  pooka int	puffs_flush_pagecache_node(struct puffs_usermount *, void *);
    527  1.40  pooka int	puffs_flush_pagecache_node_range(struct puffs_usermount *, void *,
    528  1.40  pooka 					 off_t, off_t);
    529  1.33  pooka 
    530  1.25  pooka /*
    531  1.25  pooka  * Path constructicons
    532  1.25  pooka  */
    533  1.25  pooka 
    534  1.31  pooka int	puffs_stdpath_buildpath(struct puffs_usermount *,
    535  1.30  pooka 			     const struct puffs_pathobj *,
    536  1.30  pooka 			     const struct puffs_pathobj *, size_t,
    537  1.25  pooka 			     struct puffs_pathobj *);
    538  1.31  pooka int	puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *,
    539  1.31  pooka 			   struct puffs_pathobj *, size_t, int);
    540  1.31  pooka void	puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *);
    541  1.25  pooka 
    542  1.31  pooka void	*puffs_path_walkcmp(struct puffs_usermount *,
    543  1.31  pooka 			    struct puffs_node *, void *);
    544  1.25  pooka void	*puffs_path_prefixadj(struct puffs_usermount *,
    545  1.25  pooka 			      struct puffs_node *, void *);
    546  1.25  pooka int	puffs_path_pcnbuild(struct puffs_usermount *,
    547  1.25  pooka 			    struct puffs_cn *, void *);
    548  1.25  pooka 
    549  1.25  pooka void	puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn);
    550  1.25  pooka void	puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn);
    551  1.25  pooka void	puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn);
    552  1.25  pooka void	puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn);
    553  1.25  pooka void	puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn);
    554  1.25  pooka 
    555  1.29  pooka /*
    556  1.29  pooka  * Suspension
    557  1.29  pooka  */
    558  1.29  pooka 
    559  1.29  pooka int	puffs_fs_suspend(struct puffs_usermount *);
    560  1.29  pooka 
    561  1.17  pooka __END_DECLS
    562  1.17  pooka 
    563  1.14  pooka #endif /* _PUFFS_H_ */
    564