2 * Copyright (c) 1985, 1989, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @(#)namei.h 8.5 (Berkeley) 1/9/95
34 * $Id: namei.h,v 1.20 1998/03/28 10:33:22 bde Exp $
40 #include <sys/queue.h>
44 * Encapsulation of namei parameters.
48 * Arguments to namei/lookup.
50 const char *ni_dirp; /* pathname pointer */
51 enum uio_seg ni_segflg; /* location of pathname */
52 /* u_long ni_nameiop; namei operation */
53 /* u_long ni_flags; flags to namei */
54 /* struct proc *ni_proc; process requesting lookup */
56 * Arguments to lookup.
58 /* struct ucred *ni_cred; credentials */
59 struct vnode *ni_startdir; /* starting directory */
60 struct vnode *ni_rootdir; /* logical root directory */
62 * Results: returned from/manipulated by lookup
64 struct vnode *ni_vp; /* vnode of result */
65 struct vnode *ni_dvp; /* vnode of intermediate directory */
67 * Shared between namei and lookup/commit routines.
69 size_t ni_pathlen; /* remaining chars in path */
70 char *ni_next; /* next location in pathname */
71 u_long ni_loopcnt; /* count of symlinks encountered */
73 * Lookup parameters: this structure describes the subset of
74 * information from the nameidata structure that is passed
75 * through the VOP interface.
77 struct componentname {
79 * Arguments to lookup.
81 u_long cn_nameiop; /* namei operation */
82 u_long cn_flags; /* flags to namei */
83 struct proc *cn_proc; /* process requesting lookup */
84 struct ucred *cn_cred; /* credentials */
86 * Shared between lookup and commit routines.
88 char *cn_pnbuf; /* pathname buffer */
89 char *cn_nameptr; /* pointer to looked up name */
90 long cn_namelen; /* length of looked up component */
91 u_long cn_hash; /* hash value of looked up name */
92 long cn_consume; /* chars to consume in lookup() */
100 #define LOOKUP 0 /* perform name lookup only */
101 #define CREATE 1 /* setup for file creation */
102 #define DELETE 2 /* setup for file deletion */
103 #define RENAME 3 /* setup for file renaming */
104 #define OPMASK 3 /* mask for operation */
106 * namei operational modifier flags, stored in ni_cnd.flags
108 #define LOCKLEAF 0x0004 /* lock inode on return */
109 #define LOCKPARENT 0x0008 /* want parent vnode returned locked */
110 #define WANTPARENT 0x0010 /* want parent vnode returned unlocked */
111 #define NOCACHE 0x0020 /* name must not be left in cache */
112 #define FOLLOW 0x0040 /* follow symbolic links */
113 #define NOOBJ 0x0080 /* don't create object */
114 #define NOFOLLOW 0x0000 /* do not follow symbolic links (pseudo) */
115 #define MODMASK 0x00fc /* mask of operational modifiers */
117 * Namei parameter descriptors.
119 * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
120 * If the caller of namei sets the flag (for example execve wants to
121 * know the name of the program that is being executed), then it must
122 * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
123 * be freed by either the commit routine or the VOP_ABORT routine.
124 * SAVESTART is set only by the callers of namei. It implies SAVENAME
125 * plus the addition of saving the parent directory that contains the
126 * name in ni_startdir. It allows repeated calls to lookup for the
127 * name being sought. The caller is responsible for releasing the
128 * buffer and for vrele'ing ni_startdir.
130 #define NOCROSSMOUNT 0x000100 /* do not cross mount points */
131 #define RDONLY 0x000200 /* lookup with read-only semantics */
132 #define HASBUF 0x000400 /* has allocated pathname buffer */
133 #define SAVENAME 0x000800 /* save pathname buffer */
134 #define SAVESTART 0x001000 /* save starting directory */
135 #define ISDOTDOT 0x002000 /* current component name is .. */
136 #define MAKEENTRY 0x004000 /* entry is to be added to name cache */
137 #define ISLASTCN 0x008000 /* this is last component of pathname */
138 #define ISSYMLINK 0x010000 /* symlink needs interpretation */
139 #define ISWHITEOUT 0x020000 /* found whiteout */
140 #define DOWHITEOUT 0x040000 /* do whiteouts */
141 #define WILLBEDIR 0x080000 /* new files will be dirs; allow trailing / */
142 #define ISUNICODE 0x100000 /* current component name is unicode*/
143 #define PARAMASK 0x1fff00 /* mask of parameter descriptors */
145 * Initialization of an nameidata structure.
147 #define NDINIT(ndp, op, flags, segflg, namep, p) { \
148 (ndp)->ni_cnd.cn_nameiop = op; \
149 (ndp)->ni_cnd.cn_flags = flags; \
150 (ndp)->ni_segflg = segflg; \
151 (ndp)->ni_dirp = namep; \
152 (ndp)->ni_cnd.cn_proc = p; \
157 * This structure describes the elements in the cache of recent
158 * names looked up by namei.
162 LIST_ENTRY(namecache) nc_hash; /* hash chain */
163 LIST_ENTRY(namecache) nc_src; /* source vnode list */
164 TAILQ_ENTRY(namecache) nc_dst; /* destination vnode list */
165 struct vnode *nc_dvp; /* vnode of parent of name */
166 struct vnode *nc_vp; /* vnode the name refers to */
167 u_char nc_flag; /* flag bits */
168 u_char nc_nlen; /* length of name */
169 char nc_name[0]; /* segment name */
174 int namei __P((struct nameidata *ndp));
175 int lookup __P((struct nameidata *ndp));
176 int relookup __P((struct vnode *dvp, struct vnode **vpp,
177 struct componentname *cnp));
181 * Stats on usefulness of namei caches.
184 long ncs_goodhits; /* hits that we can really use */
185 long ncs_neghits; /* negative hits that we can use */
186 long ncs_badhits; /* hits we must drop */
187 long ncs_falsehits; /* hits with id mismatch */
188 long ncs_miss; /* misses */
189 long ncs_long; /* long names that ignore cache */
190 long ncs_pass2; /* names found with passes == 2 */
191 long ncs_2passes; /* number of times we attempt it */
194 extern struct nchstats nchstats;
196 #endif /* !_SYS_NAMEI_H_ */