/* $NetBSD: puffs_sys.h,v 1.24 2007/02/15 12:14:34 pooka Exp $ */ /* * Copyright (c) 2005, 2006 Antti Kantee. All Rights Reserved. * * Development of this software was supported by the * Google Summer of Code program and the Ulla Tuominen Foundation. * The Google SoC project was mentored by Bill Studenmund. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. The name of the company nor the name of the author may be used to * endorse or promote products derived from this software without specific * prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #ifndef _PUFFS_SYS_H_ #define _PUFFS_SYS_H_ #include #include #include #include #include #include #include #include extern int (**puffs_vnodeop_p)(void *); extern int (**puffs_specop_p)(void *); extern int (**puffs_fifoop_p)(void *); extern const struct vnodeopv_desc puffs_vnodeop_opv_desc; extern const struct vnodeopv_desc puffs_specop_opv_desc; extern const struct vnodeopv_desc puffs_fifoop_opv_desc; extern const struct vnodeopv_desc puffs_msgop_opv_desc; extern struct pool puffs_pnpool; #define PUFFS_NAMEPREFIX "puffs:" /* * While a request is going to userspace, park the caller within the * kernel. This is the kernel counterpart of "struct puffs_req". */ struct puffs_park { struct puffs_req *park_preq; /* req followed by buf */ size_t park_copylen; /* userspace copylength */ size_t park_maxlen; /* max size, only for "adj" */ /* ^ XXX: overloaded */ TAILQ_ENTRY(puffs_park) park_entries; }; #define PUFFS_SIZEOPREQ_UIO_IN 1 #define PUFFS_SIZEOPREQ_UIO_OUT 2 #define PUFFS_SIZEOPREQ_BUF_IN 3 #define PUFFS_SIZEOPREQ_BUF_OUT 4 #define PUFFS_SIZEOP_UIO(a) \ (((a)==PUFFS_SIZEOPREQ_UIO_IN)||(a)==PUFFS_SIZEOPREQ_UIO_OUT) #define PUFFS_SIZEOP_BUF(a) \ (((a)==PUFFS_SIZEOPREQ_BUF_IN)||(a)==PUFFS_SIZEOPREQ_BUF_OUT) /* XXX: alignment-optimization */ struct puffs_sizepark { uint64_t pkso_reqid; uint8_t pkso_reqtype; struct uio *pkso_uio; void *pkso_copybuf; size_t pkso_bufsize; TAILQ_ENTRY(puffs_sizepark) pkso_entries; }; #ifdef DEBUG #ifndef PUFFSDEBUG #define PUFFSDEBUG #endif #endif #ifdef PUFFSDEBUG extern int puffsdebug; /* puffs_subr.c */ #define DPRINTF(x) if (puffsdebug > 0) printf x #define DPRINTF_VERBOSE(x) if (puffsdebug > 1) printf x #else #define DPRINTF(x) #define DPRINTF_VERBOSE(x) #endif #define MPTOPUFFSMP(mp) ((struct puffs_mount *)((mp)->mnt_data)) #define PMPTOMP(pmp) (pmp->pmp_mp) #define VPTOPP(vp) ((struct puffs_node *)(vp)->v_data) #define VPTOPNC(vp) (((struct puffs_node *)(vp)->v_data)->pn_cookie) #define VPTOPUFFSMP(vp) ((struct puffs_mount*)((struct puffs_node*)vp->v_data)) #define FPTOPMP(fp) (((struct puffs_instance *)fp->f_data)->pi_pmp) #define FPTOPI(fp) ((struct puffs_instance *)fp->f_data) #define EXISTSOP(pmp, op) \ (((pmp)->pmp_flags&PUFFS_KFLAG_ALLOPS) || ((pmp)->pmp_vnopmask[PUFFS_VN_##op])) #define PUFFS_DOCACHE(pmp) (((pmp)->pmp_flags & PUFFS_KFLAG_NOCACHE) == 0) TAILQ_HEAD(puffs_wq, puffs_park); LIST_HEAD(puffs_node_hashlist, puffs_node); struct puffs_mount { struct simplelock pmp_lock; struct puffs_args pmp_args; #define pmp_flags pmp_args.pa_flags #define pmp_vnopmask pmp_args.pa_vnopmask struct puffs_wq pmp_req_touser; size_t pmp_req_touser_waiters; size_t pmp_req_maxsize; struct puffs_wq pmp_req_replywait; TAILQ_HEAD(, puffs_sizepark) pmp_req_sizepark; struct puffs_node_hashlist *pmp_pnodehash; size_t pmp_npnodehash; struct mount *pmp_mp; struct vnode *pmp_root; void *pmp_rootcookie; struct selinfo *pmp_sel; /* in puffs_instance */ uint64_t pmp_nextreq; uint8_t pmp_status; uint8_t pmp_unmounting; uint8_t pmp_suspend; }; #define PUFFSTAT_BEFOREINIT 0 #define PUFFSTAT_MOUNTING 1 #define PUFFSTAT_RUNNING 2 #define PUFFSTAT_DYING 3 /* Do you want your possessions identified? */ #define PNODE_NOREFS 0x01 /* vnode inactive, no backend reference */ #define PNODE_SUSPEND 0x02 /* issue all operations as FAF */ #if 0 #define PNODE_LOCKED 0x0 #define PNODE_WANTED 0x0 #endif struct puffs_node { struct genfs_node pn_gnode; /* genfs glue */ void *pn_cookie; /* userspace pnode cookie */ struct vnode *pn_vp; /* backpointer to vnode */ uint32_t pn_stat; /* node status */ LIST_ENTRY(puffs_node) pn_hashent; }; int puffs_start2(struct puffs_mount *, struct puffs_startreq *); int puffs_vfstouser(struct puffs_mount *, int, void *, size_t); void puffs_suspendtouser(struct puffs_mount *, int); int puffs_vntouser(struct puffs_mount *, int, void *, size_t, void *, struct vnode *, struct vnode *); void puffs_vntouser_faf(struct puffs_mount *, int, void *, size_t, void *); int puffs_vntouser_req(struct puffs_mount *, int, void *, size_t, void *, uint64_t, struct vnode *, struct vnode *); int puffs_vntouser_adjbuf(struct puffs_mount *, int, void **, size_t *, size_t, void *, struct vnode *, struct vnode *); int puffs_getvnode(struct mount *, void *, enum vtype, voff_t, dev_t, struct vnode **); int puffs_newnode(struct mount *, struct vnode *, struct vnode **, void *, struct componentname *, enum vtype, dev_t); void puffs_putvnode(struct vnode *); struct vnode *puffs_pnode2vnode(struct puffs_mount *, void *, int); void puffs_makecn(struct puffs_kcn *, const struct componentname *); void puffs_credcvt(struct puffs_cred *, kauth_cred_t); pid_t puffs_lwp2pid(struct lwp *); void puffs_updatenode(struct vnode *, int); #define PUFFS_UPDATEATIME 0x01 #define PUFFS_UPDATECTIME 0x02 #define PUFFS_UPDATEMTIME 0x04 #define PUFFS_UPDATESIZE 0x08 void puffs_updatevpsize(struct vnode *); int puffs_setpmp(pid_t, int, struct puffs_mount *); void puffs_nukebypmp(struct puffs_mount *); uint64_t puffs_getreqid(struct puffs_mount *); void puffs_userdead(struct puffs_mount *); /* get/put called by ioctl handler */ int puffs_getop(struct puffs_mount *, struct puffs_reqh_get *, int); int puffs_putop(struct puffs_mount *, struct puffs_reqh_put *); extern int (**puffs_vnodeop_p)(void *); MALLOC_DECLARE(M_PUFFS); #endif /* _PUFFS_SYS_H_ */