sys/miscfs/genfs/genfs_node.h

   1 /* $NetBSD: genfs_node.h,v 1.16 2007/02/20 16:19:42 ad Exp $ */
   2
   3 /*
   4  * Copyright (c) 2001 Chuck Silvers.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *      This product includes software developed by Chuck Silvers.
  18  * 4. The name of the author may not be used to endorse or promote products
  19  *    derived from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef _MISCFS_GENFS_GENFS_NODE_H_
  34 #define _MISCFS_GENFS_GENFS_NODE_H_
  35
  36 #include <sys/rwlock.h>
  37
  38 struct vm_page;
  39 struct kauth_cred;
  40 struct uio;
  41
  42 struct genfs_ops {
  43         void    (*gop_size)(struct vnode *, off_t, off_t *, int);
  44         int     (*gop_alloc)(struct vnode *, off_t, off_t, int,
  45             struct kauth_cred *);
  46         int     (*gop_write)(struct vnode *, struct vm_page **, int, int);
  47         void    (*gop_markupdate)(struct vnode *, int);
  48 };
  49
  50 #define GOP_SIZE(vp, size, eobp, flags) \
  51         (*VTOG(vp)->g_op->gop_size)((vp), (size), (eobp), (flags))
  52 #define GOP_ALLOC(vp, off, len, flags, cred) \
  53         (*VTOG(vp)->g_op->gop_alloc)((vp), (off), (len), (flags), (cred))
  54 #define GOP_WRITE(vp, pgs, npages, flags) \
  55         (*VTOG(vp)->g_op->gop_write)((vp), (pgs), (npages), (flags))
  56
  57 /*
  58  * GOP_MARKUPDATE: mark vnode's timestamps for update.
  59  *
  60  * => called with v_interlock (and possibly other locks) held.
  61  * => used for accesses via mmap.
  62  */
  63
  64 #define GOP_MARKUPDATE(vp, flags) \
  65         (VTOG(vp)->g_op->gop_markupdate) ? \
  66         (*VTOG(vp)->g_op->gop_markupdate)((vp), (flags)) : \
  67         (void)0;
  68
  69 /* Flags to GOP_SIZE */
  70 #define GOP_SIZE_MEM    0x4     /* in-memory size */
  71
  72 /* Flags to GOP_MARKUPDATE */
  73 #define GOP_UPDATE_ACCESSED     1
  74 #define GOP_UPDATE_MODIFIED     2
  75
  76 struct genfs_node {
  77         const struct genfs_ops  *g_op;          /* ops vector */
  78         krwlock_t               g_glock;        /* getpages lock */
  79         int                     g_dirtygen;
  80 };
  81
  82 #define VTOG(vp) ((struct genfs_node *)(vp)->v_data)
  83
  84 void    genfs_size(struct vnode *, off_t, off_t *, int);
  85 void    genfs_node_init(struct vnode *, const struct genfs_ops *);
  86 void    genfs_node_destroy(struct vnode *);
  87 int     genfs_gop_write(struct vnode *, struct vm_page **, int, int);
  88 int     genfs_gop_write_rwmap(struct vnode *, struct vm_page **, int, int);
  89 int     genfs_compat_gop_write(struct vnode *, struct vm_page **, int, int);
  90 void    genfs_directio(struct vnode *, struct uio *, int);
  91
  92 void    genfs_node_wrlock(struct vnode *);
  93 void    genfs_node_rdlock(struct vnode *);
  94 void    genfs_node_unlock(struct vnode *);
  95
  96 #endif  /* _MISCFS_GENFS_GENFS_NODE_H_ */