1/* $NetBSD$ */ 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 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32#ifndef _PUFFS_SYS_H_ 33#define _PUFFS_SYS_H_ 34 35#include <sys/param.h> 36#include <sys/select.h> 37#include <sys/kauth.h> 38#include <sys/mutex.h> 39#include <sys/queue.h> 40#include <sys/pool.h> 41 42#include <fs/puffs/puffs_msgif.h> 43 44#include <miscfs/genfs/genfs_node.h> 45 46extern int (**puffs_vnodeop_p)(void *); 47extern int (**puffs_specop_p)(void *); 48extern int (**puffs_fifoop_p)(void *); 49 50extern const struct vnodeopv_desc puffs_vnodeop_opv_desc; 51extern const struct vnodeopv_desc puffs_specop_opv_desc; 52extern const struct vnodeopv_desc puffs_fifoop_opv_desc; 53extern const struct vnodeopv_desc puffs_msgop_opv_desc; 54 55extern struct pool puffs_pnpool; 56extern struct pool puffs_vapool; 57 58#ifdef DEBUG 59#ifndef PUFFSDEBUG 60#define PUFFSDEBUG 61#endif 62#endif 63 64#ifdef PUFFSDEBUG 65extern int puffsdebug; /* puffs_subr.c */ 66#define DPRINTF(x) if (puffsdebug > 0) printf x 67#define DPRINTF_VERBOSE(x) if (puffsdebug > 1) printf x 68#else 69#define DPRINTF(x) 70#define DPRINTF_VERBOSE(x) 71#endif 72 73#define MPTOPUFFSMP(mp) ((struct puffs_mount *)((mp)->mnt_data)) 74#define PMPTOMP(pmp) (pmp->pmp_mp) 75#define VPTOPP(vp) ((struct puffs_node *)(vp)->v_data) 76#define VPTOPNC(vp) (((struct puffs_node *)(vp)->v_data)->pn_cookie) 77#define VPTOPUFFSMP(vp) ((struct puffs_mount*)((struct puffs_node*)vp->v_data)) 78 79/* we don't pass the kernel overlay to userspace */ 80#define PUFFS_TOFHSIZE(s) ((s)==0 ? (s) : (s)+4) 81#define PUFFS_FROMFHSIZE(s) ((s)==0 ? (s) : (s)-4) 82 83#define ALLOPS(pmp) (pmp->pmp_flags & PUFFS_KFLAG_ALLOPS) 84#define EXISTSOP(pmp, op) \ 85 (ALLOPS(pmp) || ((pmp)->pmp_vnopmask[PUFFS_VN_##op])) 86 87#define PUFFS_USE_NAMECACHE(pmp) \ 88 (((pmp)->pmp_flags & PUFFS_KFLAG_NOCACHE_NAME) == 0) 89#define PUFFS_USE_PAGECACHE(pmp) \ 90 (((pmp)->pmp_flags & PUFFS_KFLAG_NOCACHE_PAGE) == 0) 91#define PUFFS_USE_FULLPNBUF(pmp) \ 92 ((pmp)->pmp_flags & PUFFS_KFLAG_LOOKUP_FULLPNBUF) 93#define PUFFS_USE_FS_TTL(pmp) \ 94 ((pmp)->pmp_flags & PUFFS_KFLAG_CACHE_FS_TTL) 95#define PUFFS_USE_DOTDOTCACHE(pmp) \ 96 ((pmp)->pmp_flags & PUFFS_KFLAG_CACHE_DOTDOT) 97 98#define PUFFS_WCACHEINFO(pmp) 0 99 100struct puffs_newcookie { 101 puffs_cookie_t pnc_cookie; 102 103 LIST_ENTRY(puffs_newcookie) pnc_entries; 104}; 105 106#define PUFFS_SOPREQ_EXPIRE_TIMEOUT 1000 107extern int puffs_sopreq_expire_timeout; 108 109enum puffs_sopreqtype { 110 PUFFS_SOPREQSYS_EXIT, 111 PUFFS_SOPREQ_FLUSH, 112 PUFFS_SOPREQ_UNMOUNT, 113 PUFFS_SOPREQ_EXPIRE, 114}; 115 116struct puffs_sopreq { 117 union { 118 struct puffs_req preq; 119 struct puffs_flush pf; 120 puffs_cookie_t ck; 121 } psopr_u; 122 123 enum puffs_sopreqtype psopr_sopreq; 124 TAILQ_ENTRY(puffs_sopreq) psopr_entries; 125 int psopr_at; 126}; 127#define psopr_preq psopr_u.preq 128#define psopr_pf psopr_u.pf 129#define psopr_ck psopr_u.ck 130 131TAILQ_HEAD(puffs_wq, puffs_msgpark); 132LIST_HEAD(puffs_node_hashlist, puffs_node); 133struct puffs_mount { 134 kmutex_t pmp_lock; 135 136 struct puffs_kargs pmp_args; 137#define pmp_flags pmp_args.pa_flags 138#define pmp_vnopmask pmp_args.pa_vnopmask 139 140 struct puffs_wq pmp_msg_touser; 141 int pmp_msg_touser_count; 142 kcondvar_t pmp_msg_waiter_cv; 143 size_t pmp_msg_maxsize; 144 145 struct puffs_wq pmp_msg_replywait; 146 147 struct puffs_node_hashlist *pmp_pnodehash; 148 int pmp_npnodehash; 149 150 LIST_HEAD(, puffs_newcookie) pmp_newcookie; 151 152 struct mount *pmp_mp; 153 154 struct vnode *pmp_root; 155 puffs_cookie_t pmp_root_cookie; 156 enum vtype pmp_root_vtype; 157 vsize_t pmp_root_vsize; 158 dev_t pmp_root_rdev; 159 160 struct putter_instance *pmp_pi; 161 162 unsigned int pmp_refcount; 163 kcondvar_t pmp_refcount_cv; 164 165 kcondvar_t pmp_unmounting_cv; 166 uint8_t pmp_unmounting; 167 168 uint8_t pmp_status; 169 uint8_t pmp_suspend; 170 171 uint8_t *pmp_curput; 172 size_t pmp_curres; 173 void *pmp_curopaq; 174 175 uint64_t pmp_nextmsgid; 176 177 kmutex_t pmp_sopmtx; 178 kcondvar_t pmp_sopcv; 179 int pmp_sopthrcount; 180 TAILQ_HEAD(, puffs_sopreq) pmp_sopfastreqs; 181 TAILQ_HEAD(, puffs_sopreq) pmp_sopnodereqs; 182 bool pmp_docompat; 183}; 184 185#define PUFFSTAT_BEFOREINIT 0 186#define PUFFSTAT_MOUNTING 1 187#define PUFFSTAT_RUNNING 2 188#define PUFFSTAT_DYING 3 /* Do you want your possessions identified? */ 189 190 191#define PNODE_NOREFS 0x001 /* no backend reference */ 192#define PNODE_DYING 0x002 /* NOREFS + inactive */ 193#define PNODE_FAF 0x004 /* issue all operations as FAF */ 194#define PNODE_DOINACT 0x008 /* if inactive-on-demand, call inactive */ 195#define PNODE_SOPEXP 0x100 /* Node reclaim postponed in sop thread */ 196 197#define PNODE_METACACHE_ATIME 0x10 /* cache atime metadata */ 198#define PNODE_METACACHE_CTIME 0x20 /* cache atime metadata */ 199#define PNODE_METACACHE_MTIME 0x40 /* cache atime metadata */ 200#define PNODE_METACACHE_SIZE 0x80 /* cache atime metadata */ 201#define PNODE_METACACHE_MASK 0xf0 202 203struct puffs_node { 204 struct genfs_node pn_gnode; /* genfs glue */ 205 206 kmutex_t pn_mtx; 207 int pn_refcount; 208 int pn_nlookup; 209 210 puffs_cookie_t pn_cookie; /* userspace pnode cookie */ 211 struct vnode *pn_vp; /* backpointer to vnode */ 212 uint32_t pn_stat; /* node status */ 213 214 struct selinfo pn_sel; /* for selecting on the node */ 215 short pn_revents; /* available events */ 216 217 /* metacache */ 218 struct timespec pn_mc_atime; 219 struct timespec pn_mc_ctime; 220 struct timespec pn_mc_mtime; 221 u_quad_t pn_mc_size; 222 223 voff_t pn_serversize; 224 225 struct lockf * pn_lockf; 226 227 kmutex_t pn_sizemtx; /* size modification mutex */ 228 229 int pn_cn_timeout; /* path cache */ 230 int pn_cn_grace; /* grace time before reclaim */ 231 int pn_va_timeout; /* attribute cache */ 232 struct vattr * pn_va_cache; /* attribute cache */ 233 struct vnode * pn_parent; /* parent cache */ 234 235 LIST_ENTRY(puffs_node) pn_hashent; 236}; 237 238typedef void (*parkdone_fn)(struct puffs_mount *, struct puffs_req *, void *); 239 240struct puffs_msgpark; 241void puffs_msgif_init(void); 242void puffs_msgif_destroy(void); 243int puffs_msgmem_alloc(size_t, struct puffs_msgpark **, void **, int); 244void puffs_msgmem_release(struct puffs_msgpark *); 245 246void puffs_sop_thread(void *); 247 248void puffs_msg_setfaf(struct puffs_msgpark *); 249void puffs_msg_setdelta(struct puffs_msgpark *, size_t); 250void puffs_msg_setinfo(struct puffs_msgpark *, int, int, puffs_cookie_t); 251void puffs_msg_setcall(struct puffs_msgpark *, parkdone_fn, void *); 252 253void puffs_msg_enqueue(struct puffs_mount *, struct puffs_msgpark *); 254int puffs_msg_wait(struct puffs_mount *, struct puffs_msgpark *); 255int puffs_msg_wait2(struct puffs_mount *, struct puffs_msgpark *, 256 struct puffs_node *, struct puffs_node *); 257 258void puffs_msg_sendresp(struct puffs_mount *, struct puffs_req *, int); 259 260int puffs_getvnode(struct mount *, puffs_cookie_t, enum vtype, 261 voff_t, dev_t, struct vnode **); 262int puffs_newnode(struct mount *, struct vnode *, struct vnode **, 263 puffs_cookie_t, struct componentname *, 264 enum vtype, dev_t); 265void puffs_putvnode(struct vnode *); 266 267void puffs_releasenode(struct puffs_node *); 268void puffs_referencenode(struct puffs_node *); 269 270#define PUFFS_NOSUCHCOOKIE (-1) 271int puffs_cookie2vnode(struct puffs_mount *, puffs_cookie_t, int, int, 272 struct vnode **); 273void puffs_makecn(struct puffs_kcn *, struct puffs_kcred *, 274 const struct componentname *, int); 275void puffs_credcvt(struct puffs_kcred *, kauth_cred_t); 276 277void puffs_parkdone_asyncbioread(struct puffs_mount *, 278 struct puffs_req *, void *); 279void puffs_parkdone_asyncbiowrite(struct puffs_mount *, 280 struct puffs_req *, void *); 281void puffs_parkdone_poll(struct puffs_mount *, struct puffs_req *, void *); 282 283void puffs_mp_reference(struct puffs_mount *); 284void puffs_mp_release(struct puffs_mount *); 285 286void puffs_gop_size(struct vnode *, off_t, off_t *, int); 287void puffs_gop_markupdate(struct vnode *, int); 288 289void puffs_senderr(struct puffs_mount *, int, int, const char *, 290 puffs_cookie_t); 291 292bool puffs_compat_outgoing(struct puffs_req *, struct puffs_req**, ssize_t*); 293void puffs_compat_incoming(struct puffs_req *, struct puffs_req *); 294 295void puffs_updatenode(struct puffs_node *, int, voff_t); 296#define PUFFS_UPDATEATIME 0x01 297#define PUFFS_UPDATECTIME 0x02 298#define PUFFS_UPDATEMTIME 0x04 299#define PUFFS_UPDATESIZE 0x08 300 301void puffs_userdead(struct puffs_mount *); 302 303extern int (**puffs_vnodeop_p)(void *); 304 305/* for putter */ 306int puffs_msgif_getout(void *, size_t, int, uint8_t **, size_t *, void **); 307void puffs_msgif_releaseout(void *, void *, int); 308int puffs_msgif_dispatch(void *, struct putter_hdr *); 309size_t puffs_msgif_waitcount(void *); 310int puffs_msgif_close(void *); 311 312static __inline int 313checkerr(struct puffs_mount *pmp, int error, const char *str) 314{ 315 316 if (error < 0 || error > ELAST) { 317 puffs_senderr(pmp, PUFFS_ERR_ERROR, error, str, NULL); 318 error = EPROTO; 319 } 320 321 return error; 322} 323 324#define PUFFS_MSG_VARS(type, a) \ 325 struct puffs_##type##msg_##a *a##_msg; \ 326 struct puffs_msgpark *park_##a = NULL 327 328#define PUFFS_MSG_ALLOC(type, a) \ 329 puffs_msgmem_alloc(sizeof(struct puffs_##type##msg_##a), \ 330 &park_##a, (void *)& a##_msg, 1) 331 332#define PUFFS_MSG_RELEASE(a) \ 333do { \ 334 if (park_##a) puffs_msgmem_release(park_##a); \ 335} while (/*CONSTCOND*/0) 336 337#define PUFFS_MSG_ENQUEUEWAIT(pmp, park, var) \ 338do { \ 339 puffs_msg_enqueue(pmp, park); \ 340 var = puffs_msg_wait(pmp, park); \ 341} while (/*CONSTCOND*/0) 342 343#define PUFFS_MSG_ENQUEUEWAIT2(pmp, park, vp1, vp2, var) \ 344do { \ 345 puffs_msg_enqueue(pmp, park); \ 346 var = puffs_msg_wait2(pmp, park, vp1, vp2); \ 347} while (/*CONSTCOND*/0) 348 349#endif /* _PUFFS_SYS_H_ */ 350