Home | History | Annotate | Line # | Download | only in puffs
puffs_msgif.h revision 1.29
      1  1.29  pooka /*	$NetBSD: puffs_msgif.h,v 1.29 2007/05/07 17:14:54 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.1  pooka #ifndef _PUFFS_MSGIF_H_
     36   1.1  pooka #define _PUFFS_MSGIF_H_
     37   1.1  pooka 
     38   1.1  pooka #include <sys/param.h>
     39   1.1  pooka #include <sys/time.h>
     40   1.1  pooka #include <sys/ioccom.h>
     41   1.1  pooka #include <sys/uio.h>
     42   1.1  pooka #include <sys/vnode.h>
     43   1.1  pooka #include <sys/ucred.h>
     44   1.1  pooka #include <sys/statvfs.h>
     45   1.1  pooka #include <sys/dirent.h>
     46   1.1  pooka #include <sys/fcntl.h>
     47   1.1  pooka 
     48   1.1  pooka #define PUFFSOP_VFS	1
     49   1.1  pooka #define PUFFSOP_VN	2
     50  1.20  pooka #define PUFFSOP_CACHE	3
     51   1.5  pooka #define PUFFSOPFLAG_FAF	0x10	/* fire-and-forget */
     52   1.5  pooka 
     53   1.5  pooka #define PUFFSOP_OPCMASK		0x03
     54   1.5  pooka #define PUFFSOP_OPCLASS(a)	((a) & PUFFSOP_OPCMASK)
     55   1.6  pooka #define PUFFSOP_WANTREPLY(a)	(((a) & PUFFSOPFLAG_FAF) == 0)
     56   1.1  pooka 
     57   1.9  pooka /* XXX: we don't need everything */
     58   1.1  pooka enum {
     59   1.1  pooka 	PUFFS_VFS_MOUNT,	PUFFS_VFS_START,	PUFFS_VFS_UNMOUNT,
     60   1.1  pooka 	PUFFS_VFS_ROOT,		PUFFS_VFS_STATVFS,	PUFFS_VFS_SYNC,
     61   1.1  pooka 	PUFFS_VFS_VGET,		PUFFS_VFS_FHTOVP,	PUFFS_VFS_VPTOFH,
     62   1.1  pooka 	PUFFS_VFS_INIT,		PUFFS_VFS_DONE,		PUFFS_VFS_SNAPSHOT,
     63  1.19  pooka 	PUFFS_VFS_EXTATTCTL,	PUFFS_VFS_SUSPEND
     64   1.1  pooka };
     65   1.1  pooka #define PUFFS_VFS_MAX PUFFS_VFS_EXTATTCTL
     66   1.1  pooka 
     67   1.9  pooka /* moreXXX: we don't need everything here either */
     68   1.1  pooka enum {
     69   1.1  pooka 	PUFFS_VN_LOOKUP,	PUFFS_VN_CREATE,	PUFFS_VN_MKNOD,
     70   1.1  pooka 	PUFFS_VN_OPEN,		PUFFS_VN_CLOSE,		PUFFS_VN_ACCESS,
     71   1.1  pooka 	PUFFS_VN_GETATTR,	PUFFS_VN_SETATTR,	PUFFS_VN_READ,
     72   1.1  pooka 	PUFFS_VN_WRITE,		PUFFS_VN_IOCTL,		PUFFS_VN_FCNTL,
     73   1.1  pooka 	PUFFS_VN_POLL,		PUFFS_VN_KQFILTER,	PUFFS_VN_REVOKE,
     74   1.1  pooka 	PUFFS_VN_MMAP,		PUFFS_VN_FSYNC,		PUFFS_VN_SEEK,
     75   1.1  pooka 	PUFFS_VN_REMOVE,	PUFFS_VN_LINK,		PUFFS_VN_RENAME,
     76   1.1  pooka 	PUFFS_VN_MKDIR,		PUFFS_VN_RMDIR,		PUFFS_VN_SYMLINK,
     77   1.1  pooka 	PUFFS_VN_READDIR,	PUFFS_VN_READLINK,	PUFFS_VN_ABORTOP,
     78   1.1  pooka 	PUFFS_VN_INACTIVE,	PUFFS_VN_RECLAIM,	PUFFS_VN_LOCK,
     79   1.1  pooka 	PUFFS_VN_UNLOCK,	PUFFS_VN_BMAP,		PUFFS_VN_STRATEGY,
     80   1.1  pooka 	PUFFS_VN_PRINT,		PUFFS_VN_ISLOCKED,	PUFFS_VN_PATHCONF,
     81   1.1  pooka 	PUFFS_VN_ADVLOCK,	PUFFS_VN_LEASE,		PUFFS_VN_WHITEOUT,
     82   1.1  pooka 	PUFFS_VN_GETPAGES,	PUFFS_VN_PUTPAGES,	PUFFS_VN_GETEXTATTR,
     83   1.1  pooka 	PUFFS_VN_LISTEXTATTR,	PUFFS_VN_OPENEXTATTR,	PUFFS_VN_DELETEEXTATTR,
     84   1.1  pooka 	PUFFS_VN_SETEXTATTR
     85   1.1  pooka };
     86   1.1  pooka #define PUFFS_VN_MAX PUFFS_VN_SETEXTATTR
     87   1.1  pooka 
     88  1.14  pooka #define PUFFSDEVELVERS	0x80000000
     89  1.29  pooka #define PUFFSVERSION	9
     90   1.1  pooka #define PUFFSNAMESIZE	32
     91  1.25  pooka struct puffs_kargs {
     92  1.14  pooka 	unsigned int	pa_vers;
     93   1.1  pooka 	int		pa_fd;
     94   1.9  pooka 	uint32_t	pa_flags;
     95  1.26  pooka 
     96   1.1  pooka 	size_t		pa_maxreqlen;
     97  1.27  pooka 	int		pa_nhashbuckets;
     98  1.27  pooka 
     99  1.26  pooka 	size_t		pa_fhsize;
    100  1.27  pooka 	int		pa_fhflags;
    101  1.26  pooka 
    102  1.14  pooka 	char		pa_name[PUFFSNAMESIZE+1];   /* name for puffs type */
    103   1.9  pooka 	uint8_t		pa_vnopmask[PUFFS_VN_MAX];
    104   1.1  pooka };
    105  1.10  pooka #define PUFFS_KFLAG_ALLOWCTL	0x01	/* ioctl/fcntl commands allowed */
    106  1.10  pooka #define PUFFS_KFLAG_NOCACHE	0x02	/* flush page cache immediately	*/
    107  1.10  pooka #define PUFFS_KFLAG_ALLOPS	0x04	/* ignore pa_vnopmask, send all */
    108  1.28  pooka #define PUFFS_KFLAG_WTCACHE	0x08	/* page cache is write-through  */
    109  1.29  pooka #define PUFFS_KFLAG_IAONDEMAND	0x10	/* call inactive only on demand */
    110  1.29  pooka #define PUFFS_KFLAG_MASK	0x1f
    111  1.27  pooka 
    112  1.27  pooka #define PUFFS_FHFLAG_DYNAMIC	0x01
    113  1.27  pooka #define PUFFS_FHFLAG_NFSV2	0x02
    114  1.27  pooka #define PUFFS_FHFLAG_NFSV3	0x04
    115  1.27  pooka #define PUFFS_FHFLAG_PROTOMASK	0x06
    116  1.27  pooka 
    117  1.27  pooka #define PUFFS_FHSIZE_MAX	1020	/* XXX: FHANDLE_SIZE_MAX - 4 */
    118   1.1  pooka 
    119   1.1  pooka /*
    120   1.1  pooka  * This is the device minor number for the cloning device.  Make it
    121   1.1  pooka  * a high number "just in case", even though we don't want to open
    122   1.1  pooka  * any specific devices currently.
    123   1.1  pooka  */
    124   1.1  pooka #define PUFFS_CLONER 0x7ffff
    125   1.1  pooka 
    126  1.11  pooka struct puffs_reqh_get {
    127  1.11  pooka 	void	*phg_buf;	/* user buffer		*/
    128  1.11  pooka 	size_t	phg_buflen;	/* user buffer length	*/
    129  1.11  pooka 
    130  1.11  pooka 	int	phg_nops;	/* max ops user wants / number delivered */
    131  1.11  pooka 	int	phg_more;	/* advisory: more ops available? */
    132  1.11  pooka };
    133  1.11  pooka 
    134  1.11  pooka struct puffs_reqh_put {
    135  1.11  pooka 	int		php_nops;	/* ops available / ops handled */
    136  1.11  pooka 
    137  1.11  pooka 	/* these describe the first request */
    138  1.11  pooka 	uint64_t	php_id;		/* request id */
    139  1.11  pooka 	void		*php_buf;	/* user buffer address */
    140  1.11  pooka 	size_t		php_buflen;	/* user buffer length, hdr NOT incl. */
    141  1.11  pooka };
    142  1.11  pooka 
    143   1.1  pooka /*
    144  1.11  pooka  * The requests work as follows:
    145  1.11  pooka  *
    146  1.11  pooka  *  + GETOP: When fetching operations from the kernel, the user server
    147  1.11  pooka  *           supplies a flat buffer into which operations are written.
    148  1.11  pooka  *           The number of operations written to the buffer is
    149  1.11  pooka  *           MIN(prhg_nops, requests waiting, space in buffer).
    150  1.11  pooka  *
    151  1.11  pooka  *           Operations follow each other and each one is described
    152  1.11  pooka  *           by the puffs_req structure, which is immediately followed
    153  1.11  pooka  *           by the aligned request data buffer in preq_buf.  The next
    154  1.11  pooka  *           puffs_req can be found at preq + preq_buflen.
    155  1.11  pooka  *
    156  1.11  pooka  *           Visually, the server should expect:
    157  1.11  pooka  *
    158  1.11  pooka  *           |<-- preq_buflen -->|
    159  1.11  pooka  *           ---------------------------------------------------------------
    160  1.11  pooka  *           |hdr|  buffer |align|hdr| buffer |hdr| ....   |buffer|        |
    161  1.11  pooka  *           ---------------------------------------------------------------
    162  1.11  pooka  *           ^ start       ^ unaligned        ^ aligned    ^ always aligned
    163  1.11  pooka  *
    164  1.11  pooka  *           The server is allowed to modify the contents of the buffers.
    165  1.11  pooka  *           Since the headers are the same size for both get and put, it
    166  1.11  pooka  *           is possible to handle all operations simply by doing in-place
    167  1.11  pooka  *           modification.  Where more input is expected that what was put
    168  1.11  pooka  *           out, the kernel leaves a hole in the buffer.  This hole size
    169  1.11  pooka  *           is derived from the operational semantics known by the vnode
    170  1.11  pooka  *           layer.  The hole size is included in preq_buflen.  The
    171  1.11  pooka  *           amount of relevant information in the buffer is call-specific
    172  1.11  pooka  *           and can be deduced by the server from the call type.
    173  1.11  pooka  *
    174  1.11  pooka  *  + PUTOP: When returning the results of an operation to the kernel, the
    175  1.11  pooka  *           user server is allowed to input results in a scatter-gather
    176  1.11  pooka  *           fashion.  Each request is made up of a header and the buffer.
    177  1.11  pooka  *           The header describes the *NEXT* request for copyin, *NOT* the
    178  1.11  pooka  *           current one.  The first request is described in puffs_reqh_put
    179  1.11  pooka  *           and the last one is left uninterpreted.  This is to halve the
    180  1.11  pooka  *           amount of copyin's required.
    181  1.11  pooka  *
    182  1.11  pooka  *           Fans of my ascii art, rejoice:
    183  1.11  pooka  *               /-------------------->| preq_buflen     |
    184  1.11  pooka  *           ---^----------------------------------------------------------
    185  1.11  pooka  *           |hdr|buffer| empty spaces |hdr|    buffer   |                |
    186  1.11  pooka  *           --v-----------------------^-v---------------------------------
    187  1.11  pooka  *             \------- preq_buf -----/  \------- preq_buf ....
    188  1.11  pooka  *
    189  1.11  pooka  *           This scheme also allows for better in-place modification of the
    190  1.11  pooka  *           request buffer when handling requests.  The vision is that
    191  1.11  pooka  *           operations which can be immediately satisfied will be edited
    192  1.11  pooka  *           in-place while ones which can't will be left blank.  Also,
    193  1.11  pooka  *           requests from async operations which have been satisfied
    194  1.11  pooka  *           meanwhile can be included.
    195  1.11  pooka  *
    196  1.11  pooka  *           The total number of operations is given by the ioctl control
    197  1.11  pooka  *           structure puffs_reqh.  The values in the header in the final
    198  1.11  pooka  *           are not used.
    199   1.1  pooka  */
    200   1.1  pooka struct puffs_req {
    201  1.11  pooka 	uint64_t	preq_id;		/* get: cur, put: next */
    202   1.1  pooka 
    203  1.11  pooka 	union u {
    204  1.11  pooka 		struct {
    205  1.11  pooka 			uint8_t	opclass;	/* cur */
    206  1.11  pooka 			uint8_t	optype;		/* cur */
    207  1.11  pooka 
    208  1.11  pooka 			/*
    209  1.11  pooka 			 * preq_cookie is the node cookie associated with
    210  1.11  pooka 			 * the request.  It always maps 1:1 to a vnode
    211  1.11  pooka 			 * and could map to a userspace struct puffs_node.
    212  1.11  pooka 			 * The cookie usually describes the first
    213  1.11  pooka 			 * vnode argument of the VOP_POP() in question.
    214  1.11  pooka 			 */
    215  1.11  pooka 
    216  1.11  pooka 			void	*cookie;	/* cur */
    217  1.11  pooka 		} out;
    218  1.11  pooka 		struct {
    219  1.11  pooka 			int	rv;		/* cur */
    220  1.29  pooka 			int	setbacks;	/* cur */
    221  1.11  pooka 			void	*buf;		/* next */
    222  1.11  pooka 		} in;
    223  1.11  pooka 	} u;
    224   1.1  pooka 
    225  1.11  pooka 	size_t  preq_buflen;			/* get: cur, put: next */
    226   1.1  pooka 	/*
    227  1.11  pooka 	 * the following helper pads the struct size to md alignment
    228  1.11  pooka 	 * multiple (should size_t not cut it).  it makes sure that
    229  1.11  pooka 	 * whatever comes after this struct is aligned
    230   1.1  pooka 	 */
    231  1.11  pooka 	uint8_t	preq_buf[0] __aligned(ALIGNBYTES+1);
    232   1.1  pooka };
    233  1.11  pooka #define preq_opclass	u.out.opclass
    234  1.11  pooka #define preq_optype	u.out.optype
    235  1.11  pooka #define preq_cookie	u.out.cookie
    236  1.11  pooka #define preq_rv		u.in.rv
    237  1.29  pooka #define preq_setbacks	u.in.setbacks
    238  1.11  pooka #define preq_nextbuf	u.in.buf
    239   1.1  pooka 
    240  1.29  pooka #define PUFFS_SETBACK_INACT_N1	0x01	/* set VOP_INACTIVE for node 1 */
    241  1.29  pooka #define PUFFS_SETBACK_INACT_N2	0x02	/* set VOP_INACTIVE for node 2 */
    242  1.29  pooka #define PUFFS_SETBACK_MASK	0x03
    243  1.29  pooka 
    244   1.1  pooka /*
    245   1.1  pooka  * Some operations have unknown size requirements.  So as the first
    246   1.1  pooka  * stab at handling it, do an extra bounce between the kernel and
    247   1.1  pooka  * userspace.
    248   1.1  pooka  */
    249   1.1  pooka struct puffs_sizeop {
    250   1.1  pooka 	uint64_t	pso_reqid;
    251   1.1  pooka 
    252   1.1  pooka 	uint8_t		*pso_userbuf;
    253   1.1  pooka 	size_t		pso_bufsize;
    254   1.1  pooka };
    255   1.1  pooka 
    256   1.1  pooka /*
    257  1.16  pooka  * Flush operation.  This can be used to invalidate:
    258  1.16  pooka  * 1) name cache for one node
    259  1.16  pooka  * 2) name cache for all children
    260  1.16  pooka  * 3) name cache for the entire mount
    261  1.16  pooka  * 4) page cache for a set of ranges in one node
    262  1.16  pooka  * 5) page cache for one entire node
    263  1.16  pooka  *
    264  1.16  pooka  * It can be used to flush:
    265  1.16  pooka  * 1) page cache for a set of ranges in one node
    266  1.16  pooka  * 2) page cache for one entire node
    267  1.16  pooka  */
    268  1.16  pooka 
    269  1.20  pooka /* XXX: needs restructuring */
    270  1.16  pooka struct puffs_flush {
    271  1.16  pooka 	void		*pf_cookie;
    272  1.16  pooka 
    273  1.16  pooka 	int		pf_op;
    274  1.20  pooka 	off_t		pf_start;
    275  1.20  pooka 	off_t		pf_end;
    276  1.16  pooka };
    277  1.16  pooka #define PUFFS_INVAL_NAMECACHE_NODE		0
    278  1.16  pooka #define PUFFS_INVAL_NAMECACHE_DIR		1
    279  1.16  pooka #define PUFFS_INVAL_NAMECACHE_ALL		2
    280  1.16  pooka #define PUFFS_INVAL_PAGECACHE_NODE_RANGE	3
    281  1.23  pooka #define PUFFS_FLUSH_PAGECACHE_NODE_RANGE	4
    282  1.16  pooka 
    283  1.16  pooka 
    284  1.16  pooka /*
    285  1.16  pooka  * Available ioctl operations
    286  1.16  pooka  */
    287  1.16  pooka #define PUFFSSTARTOP		_IOWR('p', 1, struct puffs_startreq)
    288  1.16  pooka #define PUFFSGETOP		_IOWR('p', 2, struct puffs_reqh_get)
    289  1.16  pooka #define PUFFSPUTOP		_IOWR('p', 3, struct puffs_reqh_put)
    290  1.16  pooka #define PUFFSSIZEOP		_IOWR('p', 4, struct puffs_sizeop)
    291  1.16  pooka #define PUFFSFLUSHOP		_IOW ('p', 5, struct puffs_flush)
    292  1.17  pooka #if 0
    293  1.16  pooka #define PUFFSFLUSHMULTIOP	_IOW ('p', 6, struct puffs_flushmulti)
    294  1.17  pooka #endif
    295  1.19  pooka #define PUFFSSUSPENDOP		_IO  ('p', 7)
    296  1.16  pooka 
    297  1.16  pooka 
    298  1.16  pooka /*
    299   1.1  pooka  * Credentials for an operation.  Can be either struct uucred for
    300   1.1  pooka  * ops called from a credential context or NOCRED/FSCRED for ops
    301   1.1  pooka  * called from within the kernel.  It is up to the implementation
    302   1.1  pooka  * if it makes a difference between these two and the super-user.
    303   1.1  pooka  */
    304   1.1  pooka struct puffs_cred {
    305   1.1  pooka 	struct uucred	pcr_uuc;
    306   1.1  pooka 	uint8_t		pcr_type;
    307   1.1  pooka 	uint8_t		pcr_internal;
    308   1.1  pooka };
    309   1.1  pooka #define PUFFCRED_TYPE_UUC	1
    310   1.1  pooka #define PUFFCRED_TYPE_INTERNAL	2
    311   1.1  pooka #define PUFFCRED_CRED_NOCRED	1
    312   1.1  pooka #define PUFFCRED_CRED_FSCRED	2
    313   1.1  pooka 
    314   1.1  pooka /*
    315  1.22  pooka  * 2*MAXPHYS is the max size the system will attempt to copy,
    316   1.1  pooka  * else treated as garbage
    317   1.1  pooka  */
    318  1.22  pooka #define PUFFS_REQ_MAXSIZE	2*MAXPHYS
    319   1.2  pooka #define PUFFS_REQSTRUCT_MAX	4096 /* XXX: approxkludge */
    320   1.1  pooka 
    321   1.1  pooka #define PUFFS_TOMOVE(a,b) (MIN((a), b->pmp_req_maxsize - PUFFS_REQSTRUCT_MAX))
    322   1.1  pooka 
    323  1.13  pooka /* puffs struct componentname built by kernel */
    324  1.13  pooka struct puffs_kcn {
    325   1.1  pooka 	/* args */
    326  1.13  pooka 	u_long			pkcn_nameiop;	/* namei operation	*/
    327  1.13  pooka 	u_long			pkcn_flags;	/* flags		*/
    328  1.13  pooka 	pid_t			pkcn_pid;	/* caller pid		*/
    329  1.13  pooka 	struct puffs_cred	pkcn_cred;	/* caller creds		*/
    330  1.13  pooka 
    331  1.13  pooka 	char pkcn_name[MAXPATHLEN+1];  /* nul-terminated path component	*/
    332  1.13  pooka 	long pkcn_namelen;
    333   1.1  pooka };
    334   1.1  pooka 
    335   1.1  pooka /*
    336   1.1  pooka  * XXX: figure out what to do with these, copied from namei.h for now
    337   1.1  pooka  */
    338   1.1  pooka #define	PUFFSLOOKUP_LOOKUP	0	/* perform name lookup only */
    339   1.1  pooka #define PUFFSLOOKUP_CREATE	1	/* setup for file creation */
    340   1.1  pooka #define PUFFSLOOKUP_DELETE	2	/* setup for file deletion */
    341   1.1  pooka #define PUFFSLOOKUP_RENAME	3	/* setup for file renaming */
    342   1.1  pooka #define PUFFSLOOKUP_OPMASK	3	/* mask for operation */
    343   1.1  pooka 
    344  1.21  pooka #define PUFFSLOOKUP_FOLLOW	0x00004	/* follow final symlink */
    345  1.21  pooka #define PUFFSLOOKUP_NOFOLLOW	0x00008	/* don't follow final symlink */
    346  1.21  pooka #define PUFFSLOOKUP_ISLASTCN	0x08000 /* is last component of lookup */
    347   1.1  pooka 
    348  1.24  pooka 
    349  1.11  pooka /*
    350  1.11  pooka  * Next come the individual requests.  They are all subclassed from
    351  1.11  pooka  * puffs_req and contain request-specific fields in addition.  Note
    352  1.11  pooka  * that there are some requests which have to handle arbitrary-length
    353  1.11  pooka  * buffers.
    354  1.11  pooka  *
    355  1.11  pooka  * The division is the following: puffs_req is to be touched only
    356  1.11  pooka  * by generic routines while the other stuff is supposed to be
    357  1.11  pooka  * modified only by specific routines.
    358  1.11  pooka  */
    359   1.6  pooka 
    360   1.6  pooka struct puffs_startreq {
    361  1.11  pooka 	struct puffs_req	psr_pr;
    362  1.11  pooka 
    363  1.11  pooka 	void			*psr_cookie;	/* IN: root node cookie */
    364  1.11  pooka 	struct statvfs		psr_sb;		/* IN: statvfs buffer */
    365   1.1  pooka };
    366   1.1  pooka 
    367   1.1  pooka /*
    368   1.1  pooka  * aux structures for vfs operations.
    369   1.1  pooka  */
    370   1.1  pooka struct puffs_vfsreq_unmount {
    371  1.11  pooka 	struct puffs_req	pvfsr_pr;
    372  1.11  pooka 
    373   1.1  pooka 	int			pvfsr_flags;
    374   1.1  pooka 	pid_t			pvfsr_pid;
    375   1.1  pooka };
    376   1.1  pooka 
    377   1.1  pooka struct puffs_vfsreq_statvfs {
    378  1.11  pooka 	struct puffs_req	pvfsr_pr;
    379  1.11  pooka 
    380   1.1  pooka 	struct statvfs		pvfsr_sb;
    381   1.1  pooka 	pid_t			pvfsr_pid;
    382   1.1  pooka };
    383   1.1  pooka 
    384   1.1  pooka struct puffs_vfsreq_sync {
    385  1.11  pooka 	struct puffs_req	pvfsr_pr;
    386  1.11  pooka 
    387   1.1  pooka 	struct puffs_cred	pvfsr_cred;
    388   1.1  pooka 	pid_t			pvfsr_pid;
    389   1.1  pooka 	int			pvfsr_waitfor;
    390   1.1  pooka };
    391   1.1  pooka 
    392  1.24  pooka struct puffs_vfsreq_fhtonode {
    393  1.24  pooka 	struct puffs_req	pvfsr_pr;
    394  1.24  pooka 
    395  1.24  pooka 	void			*pvfsr_fhcookie;	/* IN	*/
    396  1.24  pooka 	enum vtype		pvfsr_vtype;		/* IN	*/
    397  1.24  pooka 	voff_t			pvfsr_size;		/* IN	*/
    398  1.24  pooka 	dev_t			pvfsr_rdev;		/* IN	*/
    399  1.24  pooka 
    400  1.24  pooka 	size_t			pvfsr_dsize;		/* OUT */
    401  1.27  pooka 	uint8_t			pvfsr_data[0]		/* OUT, XXX */
    402  1.24  pooka 				    __aligned(ALIGNBYTES+1);
    403  1.24  pooka };
    404  1.24  pooka 
    405  1.24  pooka struct puffs_vfsreq_nodetofh {
    406  1.24  pooka 	struct puffs_req	pvfsr_pr;
    407  1.24  pooka 
    408  1.24  pooka 	void			*pvfsr_fhcookie;	/* OUT	*/
    409  1.24  pooka 
    410  1.24  pooka 	size_t			pvfsr_dsize;		/* OUT/IN  */
    411  1.27  pooka 	uint8_t			pvfsr_data[0]		/* IN, XXX */
    412  1.24  pooka 				    __aligned(ALIGNBYTES+1);
    413  1.24  pooka };
    414  1.24  pooka 
    415  1.19  pooka struct puffs_vfsreq_suspend {
    416  1.19  pooka 	struct puffs_req	pvfsr_pr;
    417  1.19  pooka 
    418  1.19  pooka 	int			pvfsr_status;
    419  1.19  pooka };
    420  1.19  pooka #define PUFFS_SUSPEND_START	0
    421  1.19  pooka #define PUFFS_SUSPEND_SUSPENDED	1
    422  1.19  pooka #define PUFFS_SUSPEND_RESUME	2
    423  1.19  pooka #define PUFFS_SUSPEND_ERROR	3
    424  1.19  pooka 
    425   1.1  pooka /*
    426   1.1  pooka  * aux structures for vnode operations.
    427   1.1  pooka  */
    428   1.1  pooka 
    429   1.1  pooka struct puffs_vnreq_lookup {
    430  1.11  pooka 	struct puffs_req	pvn_pr;
    431  1.11  pooka 
    432  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    433   1.1  pooka 	void			*pvnr_newnode;		/* IN	*/
    434   1.1  pooka 	enum vtype		pvnr_vtype;		/* IN	*/
    435   1.5  pooka 	voff_t			pvnr_size;		/* IN	*/
    436   1.4  pooka 	dev_t			pvnr_rdev;		/* IN	*/
    437   1.1  pooka };
    438   1.1  pooka 
    439   1.1  pooka struct puffs_vnreq_create {
    440  1.11  pooka 	struct puffs_req	pvn_pr;
    441  1.11  pooka 
    442  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    443   1.1  pooka 	struct vattr		pvnr_va;		/* OUT	*/
    444   1.1  pooka 	void			*pvnr_newnode;		/* IN	*/
    445   1.1  pooka };
    446   1.1  pooka 
    447   1.1  pooka struct puffs_vnreq_mknod {
    448  1.11  pooka 	struct puffs_req	pvn_pr;
    449  1.11  pooka 
    450  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    451   1.1  pooka 	struct vattr		pvnr_va;		/* OUT	*/
    452   1.1  pooka 	void			*pvnr_newnode;		/* IN	*/
    453   1.1  pooka };
    454   1.1  pooka 
    455   1.1  pooka struct puffs_vnreq_open {
    456  1.11  pooka 	struct puffs_req	pvn_pr;
    457  1.11  pooka 
    458   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    459   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    460   1.1  pooka 	int			pvnr_mode;		/* OUT	*/
    461   1.1  pooka };
    462   1.1  pooka 
    463   1.1  pooka struct puffs_vnreq_close {
    464  1.11  pooka 	struct puffs_req	pvn_pr;
    465  1.11  pooka 
    466   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    467   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    468   1.1  pooka 	int			pvnr_fflag;		/* OUT	*/
    469   1.1  pooka };
    470   1.1  pooka 
    471   1.1  pooka struct puffs_vnreq_access {
    472  1.11  pooka 	struct puffs_req	pvn_pr;
    473  1.11  pooka 
    474   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    475   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    476   1.1  pooka 	int			pvnr_mode;		/* OUT	*/
    477   1.1  pooka };
    478   1.1  pooka 
    479   1.1  pooka #define puffs_vnreq_setattr puffs_vnreq_setgetattr
    480   1.1  pooka #define puffs_vnreq_getattr puffs_vnreq_setgetattr
    481   1.1  pooka struct puffs_vnreq_setgetattr {
    482  1.11  pooka 	struct puffs_req	pvn_pr;
    483  1.11  pooka 
    484   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    485   1.1  pooka 	struct vattr		pvnr_va;		/* IN/OUT (op depend) */
    486   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    487   1.1  pooka };
    488   1.1  pooka 
    489   1.1  pooka #define puffs_vnreq_read puffs_vnreq_readwrite
    490   1.1  pooka #define puffs_vnreq_write puffs_vnreq_readwrite
    491   1.1  pooka struct puffs_vnreq_readwrite {
    492  1.11  pooka 	struct puffs_req	pvn_pr;
    493  1.11  pooka 
    494   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	  */
    495   1.1  pooka 	off_t			pvnr_offset;		/* OUT	  */
    496   1.1  pooka 	size_t			pvnr_resid;		/* IN/OUT */
    497   1.1  pooka 	int			pvnr_ioflag;		/* OUT	  */
    498   1.1  pooka 
    499   1.1  pooka 	uint8_t			pvnr_data[0];		/* IN/OUT (wr/rd) */
    500   1.1  pooka };
    501   1.1  pooka 
    502   1.1  pooka #define puffs_vnreq_ioctl puffs_vnreq_fcnioctl
    503   1.1  pooka #define puffs_vnreq_fcntl puffs_vnreq_fcnioctl
    504   1.1  pooka struct puffs_vnreq_fcnioctl {
    505  1.11  pooka 	struct puffs_req	pvn_pr;
    506  1.11  pooka 
    507   1.1  pooka 	struct puffs_cred	pvnr_cred;
    508   1.1  pooka 	u_long			pvnr_command;
    509   1.1  pooka 	pid_t			pvnr_pid;
    510   1.1  pooka 	int			pvnr_fflag;
    511   1.1  pooka 
    512   1.1  pooka 	void			*pvnr_data;
    513   1.1  pooka 	size_t			pvnr_datalen;
    514   1.1  pooka 	int			pvnr_copyback;
    515   1.1  pooka };
    516   1.1  pooka 
    517   1.1  pooka struct puffs_vnreq_poll {
    518  1.11  pooka 	struct puffs_req	pvn_pr;
    519  1.11  pooka 
    520   1.1  pooka 	int			pvnr_events;		/* OUT	*/
    521   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    522   1.1  pooka };
    523   1.1  pooka 
    524   1.1  pooka struct puffs_vnreq_fsync {
    525  1.11  pooka 	struct puffs_req	pvn_pr;
    526  1.11  pooka 
    527   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    528   1.1  pooka 	off_t			pvnr_offlo;		/* OUT	*/
    529   1.1  pooka 	off_t			pvnr_offhi;		/* OUT	*/
    530   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    531   1.1  pooka 	int			pvnr_flags;		/* OUT	*/
    532   1.1  pooka };
    533   1.1  pooka 
    534   1.1  pooka struct puffs_vnreq_seek {
    535  1.11  pooka 	struct puffs_req	pvn_pr;
    536  1.11  pooka 
    537   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    538   1.1  pooka 	off_t			pvnr_oldoff;		/* OUT	*/
    539   1.1  pooka 	off_t			pvnr_newoff;		/* OUT	*/
    540   1.1  pooka };
    541   1.1  pooka 
    542   1.1  pooka struct puffs_vnreq_remove {
    543  1.11  pooka 	struct puffs_req	pvn_pr;
    544  1.11  pooka 
    545  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    546   1.1  pooka 	void			*pvnr_cookie_targ;	/* OUT	*/
    547   1.1  pooka };
    548   1.1  pooka 
    549   1.1  pooka struct puffs_vnreq_mkdir {
    550  1.11  pooka 	struct puffs_req	pvn_pr;
    551  1.11  pooka 
    552  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    553   1.1  pooka 	struct vattr		pvnr_va;		/* OUT	*/
    554   1.1  pooka 	void			*pvnr_newnode;		/* IN	*/
    555   1.1  pooka };
    556   1.1  pooka 
    557   1.1  pooka struct puffs_vnreq_rmdir {
    558  1.11  pooka 	struct puffs_req	pvn_pr;
    559  1.11  pooka 
    560  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    561   1.1  pooka 	void			*pvnr_cookie_targ;	/* OUT	*/
    562   1.1  pooka };
    563   1.1  pooka 
    564   1.1  pooka struct puffs_vnreq_link {
    565  1.11  pooka 	struct puffs_req	pvn_pr;
    566  1.11  pooka 
    567  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT */
    568   1.1  pooka 	void			*pvnr_cookie_targ;	/* OUT */
    569   1.1  pooka };
    570   1.1  pooka 
    571   1.1  pooka struct puffs_vnreq_rename {
    572  1.11  pooka 	struct puffs_req	pvn_pr;
    573  1.11  pooka 
    574  1.13  pooka 	struct puffs_kcn	pvnr_cn_src;		/* OUT	*/
    575  1.13  pooka 	struct puffs_kcn	pvnr_cn_targ;		/* OUT	*/
    576   1.1  pooka 	void			*pvnr_cookie_src;	/* OUT	*/
    577   1.1  pooka 	void			*pvnr_cookie_targ;	/* OUT	*/
    578   1.1  pooka 	void			*pvnr_cookie_targdir;	/* OUT	*/
    579   1.1  pooka };
    580   1.1  pooka 
    581   1.1  pooka struct puffs_vnreq_symlink {
    582  1.11  pooka 	struct puffs_req	pvn_pr;
    583  1.11  pooka 
    584  1.13  pooka 	struct puffs_kcn	pvnr_cn;		/* OUT	*/
    585   1.1  pooka 	struct vattr		pvnr_va;		/* OUT	*/
    586   1.1  pooka 	void			*pvnr_newnode;		/* IN	*/
    587   1.1  pooka 	char			pvnr_link[MAXPATHLEN];	/* OUT	*/
    588   1.1  pooka };
    589   1.1  pooka 
    590   1.1  pooka struct puffs_vnreq_readdir {
    591  1.11  pooka 	struct puffs_req	pvn_pr;
    592  1.11  pooka 
    593   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	  */
    594   1.1  pooka 	off_t			pvnr_offset;		/* IN/OUT */
    595   1.1  pooka 	size_t			pvnr_resid;		/* IN/OUT */
    596  1.24  pooka 	size_t			pvnr_ncookies;		/* IN/OUT */
    597  1.24  pooka 	int			pvnr_eofflag;		/* IN     */
    598   1.1  pooka 
    599  1.24  pooka 	size_t			pvnr_dentoff;		/* OUT    */
    600  1.24  pooka 	uint8_t			pvnr_data[0]		/* IN  	  */
    601  1.24  pooka 				    __aligned(ALIGNBYTES+1);
    602   1.1  pooka };
    603   1.1  pooka 
    604   1.1  pooka struct puffs_vnreq_readlink {
    605  1.11  pooka 	struct puffs_req	pvn_pr;
    606  1.11  pooka 
    607   1.1  pooka 	struct puffs_cred	pvnr_cred;		/* OUT */
    608   1.1  pooka 	size_t			pvnr_linklen;		/* IN  */
    609   1.1  pooka 	char			pvnr_link[MAXPATHLEN];	/* IN, XXX  */
    610   1.1  pooka };
    611   1.1  pooka 
    612   1.1  pooka struct puffs_vnreq_reclaim {
    613  1.11  pooka 	struct puffs_req	pvn_pr;
    614  1.11  pooka 
    615   1.1  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    616   1.1  pooka };
    617   1.1  pooka 
    618   1.3  pooka struct puffs_vnreq_inactive {
    619  1.11  pooka 	struct puffs_req	pvn_pr;
    620  1.11  pooka 
    621   1.3  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    622   1.3  pooka 	int			pvnr_backendrefs;	/* IN	*/
    623   1.3  pooka };
    624   1.3  pooka 
    625   1.1  pooka struct puffs_vnreq_print {
    626  1.11  pooka 	struct puffs_req	pvn_pr;
    627  1.11  pooka 
    628   1.1  pooka 	/* empty */
    629   1.1  pooka };
    630   1.1  pooka 
    631   1.1  pooka struct puffs_vnreq_pathconf {
    632  1.11  pooka 	struct puffs_req	pvn_pr;
    633  1.11  pooka 
    634   1.1  pooka 	int			pvnr_name;		/* OUT	*/
    635   1.1  pooka 	int			pvnr_retval;		/* IN	*/
    636   1.1  pooka };
    637   1.1  pooka 
    638   1.1  pooka struct puffs_vnreq_advlock {
    639  1.11  pooka 	struct puffs_req	pvn_pr;
    640  1.11  pooka 
    641   1.1  pooka 	struct flock		pvnr_fl;		/* OUT	*/
    642   1.1  pooka 	void			*pvnr_id;		/* OUT	*/
    643   1.1  pooka 	int			pvnr_op;		/* OUT	*/
    644   1.1  pooka 	int			pvnr_flags;		/* OUT	*/
    645   1.1  pooka };
    646   1.1  pooka 
    647  1.12  pooka struct puffs_vnreq_mmap {
    648  1.12  pooka 	struct puffs_req	pvn_pr;
    649  1.12  pooka 
    650  1.12  pooka 	int			pvnr_fflags;		/* OUT	*/
    651  1.12  pooka 	struct puffs_cred	pvnr_cred;		/* OUT	*/
    652  1.12  pooka 	pid_t			pvnr_pid;		/* OUT	*/
    653  1.12  pooka };
    654  1.12  pooka 
    655  1.20  pooka 
    656  1.20  pooka /*
    657  1.20  pooka  * For cache reports.  Everything is always out-out-out, no replies
    658  1.20  pooka  */
    659  1.20  pooka 
    660  1.20  pooka struct puffs_cacherun {
    661  1.20  pooka 	off_t			pcache_runstart;
    662  1.20  pooka 	off_t			pcache_runend;
    663  1.20  pooka };
    664  1.20  pooka 
    665  1.20  pooka /* cache info.  old used for write now */
    666  1.20  pooka struct puffs_cacheinfo {
    667  1.20  pooka 	struct puffs_req	pcache_pr;
    668  1.20  pooka 
    669  1.20  pooka 	int			pcache_type;
    670  1.20  pooka 	size_t			pcache_nruns;
    671  1.20  pooka 	struct puffs_cacherun	pcache_runs[0];
    672  1.20  pooka };
    673  1.20  pooka #define PCACHE_TYPE_READ	0
    674  1.20  pooka #define PCACHE_TYPE_WRITE	1
    675  1.20  pooka 
    676   1.1  pooka /* notyet */
    677   1.1  pooka #if 0
    678   1.1  pooka struct puffs_vnreq_kqfilter { };
    679   1.1  pooka struct puffs_vnreq_islocked { };
    680   1.1  pooka #endif
    681   1.1  pooka struct puffs_vnreq_getextattr { };
    682   1.1  pooka struct puffs_vnreq_setextattr { };
    683   1.1  pooka struct puffs_vnreq_listextattr { };
    684   1.1  pooka 
    685   1.1  pooka #ifdef _KERNEL
    686   1.1  pooka #define PUFFS_VFSREQ(a)							\
    687   1.1  pooka 	struct puffs_vfsreq_##a a##_arg;				\
    688   1.1  pooka 	memset(&a##_arg, 0, sizeof(struct puffs_vfsreq_##a))
    689   1.1  pooka 
    690   1.1  pooka #define PUFFS_VNREQ(a)							\
    691   1.1  pooka 	struct puffs_vnreq_##a a##_arg;					\
    692   1.1  pooka 	memset(&a##_arg, 0, sizeof(struct puffs_vnreq_##a))
    693   1.1  pooka #endif
    694   1.1  pooka 
    695   1.1  pooka #endif /* _PUFFS_MSGIF_H_ */
    696