Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / vfs / umapfs / umap.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  * the UCLA Ficus project.
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  *      @(#)umap.h      8.4 (Berkeley) 8/20/94
37  *
38  * $FreeBSD: src/sys/miscfs/umapfs/umap.h,v 1.13 1999/12/29 04:54:47 peter Exp $
39  */
40
41 #define MAPFILEENTRIES 64
42 #define GMAPFILEENTRIES 16
43 #define NOBODY 32767
44 #define NULLGROUP 65534
45
46 struct umap_args {
47         char            *target;        /* Target of loopback  */
48         int             nentries;       /* # of entries in user map array */
49         int             gnentries;      /* # of entries in group map array */
50         u_long          (*mapdata)[2];  /* pointer to array of user mappings */
51         u_long          (*gmapdata)[2]; /* pointer to array of group mappings */
52 };
53
54 struct umap_mount {
55         struct mount    *umapm_vfs;
56         struct vnode    *umapm_rootvp;  /* Reference to root umap_node */
57         int             info_nentries;  /* number of uid mappings */
58         int             info_gnentries; /* number of gid mappings */
59         u_long          info_mapdata[MAPFILEENTRIES][2]; /* mapping data for
60             user mapping in ficus */
61         u_long          info_gmapdata[GMAPFILEENTRIES][2]; /*mapping data for
62             group mapping in ficus */
63 };
64
65 #ifdef _KERNEL
66 /*
67  * A cache of vnode references
68  */
69 struct umap_node {
70         LIST_ENTRY(umap_node) umap_hash;        /* Hash list */
71         struct vnode    *umap_lowervp;  /* Aliased vnode - VREFed once */
72         struct vnode    *umap_vnode;    /* Back pointer to vnode/umap_node */
73 };
74
75 extern int umapfs_init __P((struct vfsconf *vfsp));
76 extern int umap_node_create __P((struct mount *mp, struct vnode *target, struct vnode **vpp));
77 extern u_long umap_reverse_findid __P((u_long id, u_long map[][2], int nentries));
78 extern void umap_mapids __P((struct mount *v_mount, struct ucred *credp));
79
80 #define MOUNTTOUMAPMOUNT(mp) ((struct umap_mount *)((mp)->mnt_data))
81 #define VTOUMAP(vp) ((struct umap_node *)(vp)->v_data)
82 #define UMAPTOV(xp) ((xp)->umap_vnode)
83 #ifdef DIAGNOSTIC
84 extern struct vnode *umap_checkvp __P((struct vnode *vp, char *fil, int lno));
85 #define UMAPVPTOLOWERVP(vp) umap_checkvp((vp), __FILE__, __LINE__)
86 #else
87 #define UMAPVPTOLOWERVP(vp) (VTOUMAP(vp)->umap_lowervp)
88 #endif
89
90 extern vop_t **umap_vnodeop_p;
91 #endif /* _KERNEL */