xref: /csrg-svn/sys/kern/vfs_lookup.c (revision 37715)
1 /*
2  * Copyright (c) 1982, 1986, 1989 Regents of the University of California.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms are permitted
6  * provided that the above copyright notice and this paragraph are
7  * duplicated in all such forms and that any documentation,
8  * advertising materials, and other materials related to such
9  * distribution and use acknowledge that the software was developed
10  * by the University of California, Berkeley.  The name of the
11  * University may not be used to endorse or promote products derived
12  * from this software without specific prior written permission.
13  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  *	@(#)vfs_lookup.c	7.7 (Berkeley) 05/09/89
18  */
19 
20 #include "param.h"
21 #include "time.h"
22 #include "namei.h"
23 #include "vnode.h"
24 #include "mount.h"
25 #include "errno.h"
26 #include "malloc.h"
27 
28 #ifdef KTRACE
29 #include "user.h"
30 #include "proc.h"
31 #include "ktrace.h"
32 #endif
33 
34 /*
35  * Convert a pathname into a pointer to a locked inode.
36  * This is a very central and rather complicated routine.
37  *
38  * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
39  * whether the name is to be looked up, created, renamed, or deleted.
40  * When CREATE, RENAME, or DELETE is specified, information usable in
41  * creating, renaming, or deleting a directory entry may be calculated.
42  * If flag has LOCKPARENT or'ed into it and the target of the pathname
43  * exists, namei returns both the target and its parent directory locked.
44  * When creating or renaming and LOCKPARENT is specified, the target may not
45  * be ".".  When deleting and LOCKPARENT is specified, the target may be ".".
46  *
47  * The FOLLOW flag is set when symbolic links are to be followed
48  * when they occur at the end of the name translation process.
49  * Symbolic links are always followed for all other pathname
50  * components other than the last.
51  *
52  * The segflg defines whether the name is to be copied from user
53  * space or kernel space.
54  *
55  * Overall outline of namei:
56  *
57  *	copy in name
58  *	get starting directory
59  * dirloop:
60  *	copy next component of name to ndp->ni_dent
61  *	handle degenerate case where name is null string
62  *	if .. and on mounted filesys, find parent
63  *	call lookup routine for next component name
64  *	  directory vnode returned in ni_dvp, unlocked unless LOCKPARENT set
65  *	  component vnode returned in ni_vp (if it exists), locked.
66  *	if symbolic link, massage name in buffer and continue at dirloop
67  *	if result inode is mounted on, find mounted on vnode
68  *	if more components of name, do next level at dirloop
69  *	return the answer in ni_vp as locked vnode;
70  *	  if LOCKPARENT set, return locked parent in ni_dvp
71  *
72  * NOTE: (LOOKUP | LOCKPARENT) currently returns the parent vnode unlocked.
73  */
74 namei(ndp)
75 	register struct nameidata *ndp;
76 {
77 	register char *cp;		/* pointer into pathname argument */
78 	register struct vnode *dp = 0;	/* the directory we are searching */
79 	register int i;		   	/* Temp counter */
80 	struct vnode *tdp;		/* saved dp */
81 	struct mount *mp;		/* mount table entry */
82 	int docache;			/* == 0 do not cache last component */
83 	int flag;			/* LOOKUP, CREATE, RENAME or DELETE */
84 	int wantparent;			/* 1 => wantparent or lockparent flag */
85 	int error = 0;
86 
87 	flag = ndp->ni_nameiop & OPFLAG;
88 	wantparent = ndp->ni_nameiop & (LOCKPARENT|WANTPARENT);
89 	docache = (ndp->ni_nameiop & NOCACHE) ^ NOCACHE;
90 	if (flag == DELETE || wantparent)
91 		docache = 0;
92 	/*
93 	 * Get a buffer for the name to be translated, and copy the
94 	 * name into the buffer.
95 	 */
96 	MALLOC(ndp->ni_pnbuf, caddr_t, MAXPATHLEN, M_NAMEI, M_WAITOK);
97 	if (ndp->ni_segflg == UIO_SYSSPACE)
98 		error = copystr(ndp->ni_dirp, ndp->ni_pnbuf, MAXPATHLEN,
99 		    &ndp->ni_pathlen);
100 	else
101 		error = copyinstr(ndp->ni_dirp, ndp->ni_pnbuf, MAXPATHLEN,
102 		    &ndp->ni_pathlen);
103 	if (error) {
104 		free(ndp->ni_pnbuf, M_NAMEI);
105 		return (error);
106 	}
107 	ndp->ni_ptr = ndp->ni_pnbuf;
108 	ndp->ni_loopcnt = 0;
109 	dp = ndp->ni_cdir;
110 	dp->v_count++;
111 #ifdef KTRACE
112 	if (KTRPOINT(u.u_procp, KTR_NAMEI))
113 		ktrnamei(u.u_procp->p_tracep, ndp->ni_pnbuf);
114 #endif
115 
116 start:
117 	/*
118 	 * Get starting directory.
119 	 * Done at start of translation and after symbolic link.
120 	 */
121 	if (*ndp->ni_ptr == '/') {
122 		vrele(dp);
123 		while (*ndp->ni_ptr == '/') {
124 			ndp->ni_ptr++;
125 			ndp->ni_pathlen--;
126 		}
127 		if ((dp = ndp->ni_rdir) == NULL)
128 			dp = rootdir;
129 		dp->v_count++;
130 	}
131 	VOP_LOCK(dp);
132 	ndp->ni_endoff = 0;
133 
134 	/*
135 	 * We come to dirloop to search a new directory.
136 	 */
137 dirloop:
138 	/*
139 	 * Copy next component of name to ndp->ni_dent.
140 	 * XXX kern_exec looks at d_name
141 	 * ??? The ni_hash value may be useful for vfs_cache
142 	 * XXX There must be the last component of the filename left
143 	 * somewhere accessible via. ndp for NFS (and any other stateless file
144 	 * systems) in case they are doing a CREATE. The "Towards a..." noted
145 	 * that ni_ptr would be left pointing to the last component, but since
146 	 * the ni_pnbuf gets free'd, that is not a good idea.
147 	 */
148 	ndp->ni_hash = 0;
149 	for (cp = ndp->ni_ptr, i = 0; *cp != 0 && *cp != '/'; cp++) {
150 		if (i >= MAXNAMLEN) {
151 			error = ENAMETOOLONG;
152 			goto bad;
153 		}
154 		if (*cp & 0200)
155 			if ((*cp&0377) == ('/'|0200) || flag != DELETE) {
156 				error = EINVAL;
157 				goto bad;
158 			}
159 		ndp->ni_dent.d_name[i++] = *cp;
160 		ndp->ni_hash += (unsigned char)*cp * i;
161 	}
162 	ndp->ni_namelen = i;
163 	ndp->ni_dent.d_namlen = i;
164 	ndp->ni_dent.d_name[i] = '\0';
165 	ndp->ni_pathlen -= i;
166 #ifdef NAMEI_DIAGNOSTIC
167 	printf("{%s}: ", ndp->ni_dent.d_name);
168 #endif
169 	ndp->ni_next = cp;
170 	ndp->ni_makeentry = 1;
171 	if (*cp == '\0' && docache == 0)
172 		ndp->ni_makeentry = 0;
173 	ndp->ni_isdotdot = (ndp->ni_namelen == 2 &&
174 		ndp->ni_dent.d_name[1] == '.' && ndp->ni_dent.d_name[0] == '.');
175 
176 	/*
177 	 * Check for degenerate name (e.g. / or "")
178 	 * which is a way of talking about a directory,
179 	 * e.g. like "/." or ".".
180 	 */
181 	if (ndp->ni_ptr[0] == '\0') {
182 		if (flag != LOOKUP || wantparent) {
183 			error = EISDIR;
184 			goto bad;
185 		}
186 		free(ndp->ni_pnbuf, M_NAMEI);
187 		if (!(ndp->ni_nameiop & LOCKLEAF))
188 			VOP_UNLOCK(dp);
189 		ndp->ni_vp = dp;
190 		return (0);
191 	}
192 
193 	/*
194 	 * Handle "..": two special cases.
195 	 * 1. If at root directory (e.g. after chroot)
196 	 *    then ignore it so can't get out.
197 	 * 2. If this vnode is the root of a mounted
198 	 *    file system, then replace it with the
199 	 *    vnode which was mounted on so we take the
200 	 *    .. in the other file system.
201 	 */
202 	if (ndp->ni_isdotdot) {
203 		for (;;) {
204 			if (dp == ndp->ni_rdir || dp == rootdir) {
205 				ndp->ni_dvp = dp;
206 				dp->v_count++;
207 				goto nextname;
208 			}
209 			if ((dp->v_flag & VROOT) == 0)
210 				break;
211 			tdp = dp;
212 			dp = dp->v_mount->m_vnodecovered;
213 			vput(tdp);
214 			VOP_LOCK(dp);
215 			dp->v_count++;
216 		}
217 	}
218 
219 	/*
220 	 * We now have a segment name to search for, and a directory to search.
221 	 */
222 	if (error = VOP_LOOKUP(dp, ndp)) {
223 		if (ndp->ni_vp != NULL)
224 			panic("leaf should be empty");
225 #ifdef NAMEI_DIAGNOSTIC
226 		printf("not found\n");
227 #endif
228 		/*
229 		 * If creating and at end of pathname, then can consider
230 		 * allowing file to be created.
231 		 */
232 		if (ndp->ni_dvp->v_mount->m_flag & M_RDONLY)
233 			error = EROFS;
234 		if (error != ENOENT || flag != CREATE || *cp != 0)
235 			goto bad;
236 		/*
237 		 * We return with ni_vp NULL to indicate that the entry
238 		 * doesn't currently exist, leaving a pointer to the
239 		 * (possibly locked) directory inode in ndp->ni_dvp.
240 		 */
241 		FREE(ndp->ni_pnbuf, M_NAMEI);
242 		return (0);	/* should this be ENOENT? */
243 	}
244 #ifdef NAMEI_DIAGNOSTIC
245 	printf("found\n");
246 #endif
247 
248 	/*
249 	 * Check for symbolic link
250 	 */
251 	dp = ndp->ni_vp;
252 	if ((dp->v_type == VLNK) &&
253 	    ((ndp->ni_nameiop & FOLLOW) || *ndp->ni_next == '/')) {
254 		struct iovec aiov;
255 		struct uio auio;
256 		int linklen;
257 
258 		if (++ndp->ni_loopcnt > MAXSYMLINKS) {
259 			error = ELOOP;
260 			goto bad2;
261 		}
262 		if (ndp->ni_pathlen == 1)
263 			MALLOC(cp, char *, MAXPATHLEN, M_NAMEI, M_WAITOK);
264 		else
265 			cp = ndp->ni_pnbuf;
266 		aiov.iov_base = cp;
267 		aiov.iov_len = MAXPATHLEN;
268 		auio.uio_iov = &aiov;
269 		auio.uio_iovcnt = 1;
270 		auio.uio_offset = 0;
271 		auio.uio_rw = UIO_READ;
272 		auio.uio_segflg = UIO_SYSSPACE;
273 		auio.uio_resid = MAXPATHLEN;
274 		if (error = VOP_READLINK(dp, &auio, ndp->ni_cred)) {
275 			if (ndp->ni_pathlen == 1)
276 				free(cp, M_NAMEI);
277 			goto bad2;
278 		}
279 		linklen = MAXPATHLEN - auio.uio_resid;
280 		if (linklen + ndp->ni_pathlen >= MAXPATHLEN) {
281 			if (ndp->ni_pathlen == 1)
282 				free(cp, M_NAMEI);
283 			error = ENAMETOOLONG;
284 			goto bad2;
285 		}
286 		if (ndp->ni_pathlen == 1) {
287 			bcopy(ndp->ni_next, cp + linklen, ndp->ni_pathlen);
288 			FREE(ndp->ni_pnbuf, M_NAMEI);
289 			ndp->ni_pnbuf = cp;
290 		} else
291 			ndp->ni_pnbuf[linklen] = '\0';
292 		ndp->ni_ptr = cp;
293 		ndp->ni_pathlen += linklen;
294 		vput(dp);
295 		dp = ndp->ni_dvp;
296 		goto start;
297 	}
298 
299 	/*
300 	 * Check to see if the vnode has been mounted on;
301 	 * if so find the root of the mounted file system.
302 	 */
303 mntloop:
304 	while (dp->v_type == VDIR && (mp = dp->v_mountedhere)) {
305 		while(mp->m_flag & M_MLOCK) {
306 			mp->m_flag |= M_MWAIT;
307 			sleep((caddr_t)mp, PVFS);
308 			goto mntloop;
309 		}
310 		error = VFS_ROOT(dp->v_mountedhere, &tdp);
311 		if (error)
312 			goto bad2;
313 		vput(dp);
314 		ndp->ni_vp = dp = tdp;
315 	}
316 
317 nextname:
318 	/*
319 	 * Not a symbolic link.  If more pathname,
320 	 * continue at next component, else return.
321 	 */
322 	ndp->ni_ptr = ndp->ni_next;
323 	if (*ndp->ni_ptr == '/') {
324 		while (*ndp->ni_ptr == '/') {
325 			ndp->ni_ptr++;
326 			ndp->ni_pathlen--;
327 		}
328 		vrele(ndp->ni_dvp);
329 		goto dirloop;
330 	}
331 	/*
332 	 * Check for read-only file systems and executing texts
333 	 */
334 	if (flag != LOOKUP && (error = vn_access(dp, VWRITE, ndp->ni_cred)))
335 		goto bad2;
336 	if (!wantparent)
337 		vrele(ndp->ni_dvp);
338 	if ((ndp->ni_nameiop & LOCKLEAF) == 0)
339 		VOP_UNLOCK(dp);
340 	FREE(ndp->ni_pnbuf, M_NAMEI);
341 	return (0);
342 
343 bad2:
344 	vrele(ndp->ni_dvp);
345 bad:
346 	vput(dp);
347 	ndp->ni_vp = NULL;
348 	FREE(ndp->ni_pnbuf, M_NAMEI);
349 	return (error);
350 }
351