Annotation of kernel/bsd/miscfs/union/union.h, revision 1.1.1.1

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

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.