bsd/miscfs/union/union.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  23 /*
  24  * Copyright (c) 1994 The Regents of the University of California.
  25  * Copyright (c) 1994 Jan-Simon Pendry.
  26  * All rights reserved.
  27  *
  28  * This code is derived from software donated to Berkeley by
  29  * Jan-Simon Pendry.
  30  *
  31  * Redistribution and use in source and binary forms, with or without
  32  * modification, are permitted provided that the following conditions
  33  * are met:
  34  * 1. Redistributions of source code must retain the above copyright
  35  *    notice, this list of conditions and the following disclaimer.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  * 3. All advertising materials mentioning features or use of this software
  40  *    must display the following acknowledgement:
  41  *      This product includes software developed by the University of
  42  *      California, Berkeley and its contributors.
  43  * 4. Neither the name of the University nor the names of its contributors
  44  *    may be used to endorse or promote products derived from this software
  45  *    without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  48  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  51  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  52  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  53  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  54  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  55  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  57  * SUCH DAMAGE.
  58  *
  59  *      @(#)union.h     8.9 (Berkeley) 12/10/94
  60  */
  61 #ifndef __UNION_UNION_H__
  62 #define __UNION_UNION_H__
  63
  64 #include  <sys/appleapiopts.h>
  65 #include  <sys/cdefs.h>
  66
  67 #ifdef __APPLE_API_PRIVATE
  68 struct union_args {
  69         char            *target;        /* Target of loopback  */
  70         int             mntflags;       /* Options on the mount */
  71 };
  72
  73 #define UNMNT_ABOVE     0x0001          /* Target appears below mount point */
  74 #define UNMNT_BELOW     0x0002          /* Target appears below mount point */
  75 #define UNMNT_REPLACE   0x0003          /* Target replaces mount point */
  76 #define UNMNT_OPMASK    0x0003
  77
  78 struct union_mount {
  79         struct vnode    *um_uppervp;
  80         struct vnode    *um_lowervp;
  81         struct ucred    *um_cred;       /* Credentials of user calling mount */
  82         int             um_cmode;       /* cmask from mount process */
  83         int             um_op;          /* Operation mode */
  84 };
  85
  86 #ifdef KERNEL
  87 /* LP64 version of union_args.  all pointers
  88  * grow when we're dealing with a 64-bit process.
  89  * WARNING - keep in sync with union_args
  90  */
  91 /* LP64todo - should this move? */
  92
  93 struct user_union_args {
  94         user_addr_t     target;         /* Target of loopback  */
  95         int                     mntflags;       /* Options on the mount */
  96         char            _pad[4];
  97 };
  98
  99 /*
 100  * DEFDIRMODE is the mode bits used to create a shadow directory.
 101  */
 102 #define VRWXMODE (VREAD|VWRITE|VEXEC)
 103 #define VRWMODE (VREAD|VWRITE)
 104 #define UN_DIRMODE ((VRWXMODE)|(VRWXMODE>>3)|(VRWXMODE>>6))
 105 #define UN_FILEMODE ((VRWMODE)|(VRWMODE>>3)|(VRWMODE>>6))
 106
 107 /*
 108  * A cache of vnode references
 109  */
 110 struct union_node {
 111         LIST_ENTRY(union_node)  un_cache;       /* Hash chain */
 112         struct vnode            *un_vnode;      /* Back pointer */
 113         struct vnode            *un_uppervp;    /* overlaying object */
 114         struct vnode            *un_lowervp;    /* underlying object */
 115         struct vnode            *un_dirvp;      /* Parent dir of uppervp */
 116         struct vnode            *un_pvp;        /* Parent vnode */
 117         char                    *un_path;       /* saved component name */
 118         int                     un_hash;        /* saved un_path hash value */
 119         int                     un_openl;       /* # of opens on lowervp */
 120         unsigned int            un_flags;
 121         struct vnode            **un_dircache;  /* cached union stack */
 122         off_t                   un_uppersz;     /* size of upper object */
 123         off_t                   un_lowersz;     /* size of lower object */
 124 #if DIAGNOSTIC
 125         pid_t                   un_pid;
 126 #endif
 127 };
 128
 129 #define UN_WANT         0x01
 130 #define UN_LOCKED       0x02
 131 #define UN_ULOCK        0x04            /* Upper node is locked */
 132 #define UN_KLOCK        0x08            /* Keep upper node locked on vput */
 133 #define UN_CACHED       0x10            /* In union cache */
 134
 135 extern int union_allocvp(struct vnode **, struct mount *,
 136                                 struct vnode *, struct vnode *,
 137                                 struct componentname *, struct vnode *,
 138                                 struct vnode *, int);
 139 extern int union_copyfile(struct vnode *, struct vnode *,
 140                                         struct ucred *, struct proc *);
 141 extern int union_copyup(struct union_node *, int, struct ucred *,
 142                                 struct proc *);
 143 extern int union_dowhiteout(struct union_node *, vfs_context_t);
 144 extern int union_mkshadow(struct union_mount *, struct vnode *,
 145                                 struct componentname *, struct vnode **);
 146 extern int union_mkwhiteout(struct union_mount *, struct vnode *,
 147                                 struct componentname *, char *);
 148 extern int union_vn_create(struct vnode **, struct union_node *, struct proc *);
 149 extern int union_cn_close(struct vnode *, int, struct ucred *, struct proc *);
 150 extern void union_removed_upper(struct union_node *un);
 151 extern struct vnode *union_lowervp(struct vnode *);
 152 extern void union_newlower(struct union_node *, struct vnode *);
 153 extern void union_newupper(struct union_node *, struct vnode *);
 154 extern void union_newsize(struct vnode *, off_t, off_t);
 155
 156 #define MOUNTTOUNIONMOUNT(mp) ((struct union_mount *)((mp)->mnt_data))
 157 #define VTOUNION(vp) ((struct union_node *)(vp)->v_data)
 158 #define UNIONTOV(un) ((un)->un_vnode)
 159 #define LOWERVP(vp) (VTOUNION(vp)->un_lowervp)
 160 #define UPPERVP(vp) (VTOUNION(vp)->un_uppervp)
 161 #define OTHERVP(vp) (UPPERVP(vp) ? UPPERVP(vp) : LOWERVP(vp))
 162
 163 extern int (**union_vnodeop_p)(void *);
 164 extern struct vfsops union_vfsops;
 165 #endif /* KERNEL */
 166
 167 #endif /* __APPLE_API_PRIVATE */
 168 #endif /* __UNION_UNION_H__ */