sys/vfs/nullfs/null.h

   1 /*
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software donated to Berkeley by
   6  * Jan-Simon Pendry.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)null.h      8.3 (Berkeley) 8/20/94
  37  *
  38  * $FreeBSD: src/sys/miscfs/nullfs/null.h,v 1.11.2.3 2001/06/26 04:20:09 bp Exp $
  39  * $DragonFly: src/sys/vfs/nullfs/null.h,v 1.6 2004/08/28 19:02:23 dillon Exp $
  40  */
  41
  42 struct null_args {
  43         char            *target;        /* Target of loopback  */
  44 };
  45
  46 struct null_mount {
  47         struct mount    *nullm_vfs;
  48         struct vnode    *nullm_rootvp;  /* Reference to root null_node */
  49 };
  50
  51 #ifdef _KERNEL
  52 /*
  53  * A cache of vnode references
  54  */
  55 struct null_node {
  56         struct null_node        *null_next;     /* Hash list */
  57         struct vnode            *null_lowervp;  /* vrefed once */
  58         struct vnode            *null_vnode;    /* Back pointer */
  59 };
  60
  61 #define MOUNTTONULLMOUNT(mp) ((struct null_mount *)((mp)->mnt_data))
  62 #define VTONULL(vp) ((struct null_node *)(vp)->v_data)
  63 #define NULLTOV(xp) ((xp)->null_vnode)
  64
  65 int nullfs_init(struct vfsconf *vfsp);
  66 int nullfs_uninit(struct vfsconf *vfsp);
  67 int null_node_add(struct null_node *np);
  68 void null_node_rem(struct null_node *np);
  69 int null_node_create(struct mount *mp, struct vnode *target, struct vnode **vpp);
  70 int null_bypass(struct vop_generic_args *ap);
  71
  72 #ifdef DIAGNOSTIC
  73 struct vnode *null_checkvp(struct vnode *vp, char *fil, int lno);
  74 #define NULLVPTOLOWERVP(vp) null_checkvp((vp), __FILE__, __LINE__)
  75 #else
  76 #define NULLVPTOLOWERVP(vp) (VTONULL(vp)->null_lowervp)
  77 #endif
  78
  79 #ifdef MALLOC_DECLARE
  80 MALLOC_DECLARE(M_NULLFSNODE);
  81 #endif
  82
  83 #ifdef NULLFS_DEBUG
  84 #define NULLFSDEBUG(format, args...) printf(format ,## args)
  85 #else
  86 #define NULLFSDEBUG(format, args...)
  87 #endif /* NULLFS_DEBUG */
  88
  89 #endif /* _KERNEL */