vfs_lookup.c revision 1.197 1 1.197 dholland /* $NetBSD: vfs_lookup.c,v 1.197 2012/11/05 17:24:11 dholland Exp $ */
2 1.13 cgd
3 1.10 cgd /*
4 1.12 mycroft * Copyright (c) 1982, 1986, 1989, 1993
5 1.12 mycroft * The Regents of the University of California. All rights reserved.
6 1.10 cgd * (c) UNIX System Laboratories, Inc.
7 1.10 cgd * All or some portions of this file are derived from material licensed
8 1.10 cgd * to the University of California by American Telephone and Telegraph
9 1.10 cgd * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 1.10 cgd * the permission of UNIX System Laboratories, Inc.
11 1.10 cgd *
12 1.10 cgd * Redistribution and use in source and binary forms, with or without
13 1.10 cgd * modification, are permitted provided that the following conditions
14 1.10 cgd * are met:
15 1.10 cgd * 1. Redistributions of source code must retain the above copyright
16 1.10 cgd * notice, this list of conditions and the following disclaimer.
17 1.10 cgd * 2. Redistributions in binary form must reproduce the above copyright
18 1.10 cgd * notice, this list of conditions and the following disclaimer in the
19 1.10 cgd * documentation and/or other materials provided with the distribution.
20 1.49 agc * 3. Neither the name of the University nor the names of its contributors
21 1.10 cgd * may be used to endorse or promote products derived from this software
22 1.10 cgd * without specific prior written permission.
23 1.10 cgd *
24 1.10 cgd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 1.10 cgd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 1.10 cgd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 1.10 cgd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 1.10 cgd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 1.10 cgd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 1.10 cgd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 1.10 cgd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 1.10 cgd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 1.10 cgd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 1.10 cgd * SUCH DAMAGE.
35 1.10 cgd *
36 1.26 fvdl * @(#)vfs_lookup.c 8.10 (Berkeley) 5/27/95
37 1.10 cgd */
38 1.38 lukem
39 1.38 lukem #include <sys/cdefs.h>
40 1.197 dholland __KERNEL_RCSID(0, "$NetBSD: vfs_lookup.c,v 1.197 2012/11/05 17:24:11 dholland Exp $");
41 1.27 thorpej
42 1.67 chs #include "opt_magiclinks.h"
43 1.10 cgd
44 1.10 cgd #include <sys/param.h>
45 1.15 cgd #include <sys/systm.h>
46 1.61 thorpej #include <sys/kernel.h>
47 1.10 cgd #include <sys/syslimits.h>
48 1.10 cgd #include <sys/time.h>
49 1.10 cgd #include <sys/namei.h>
50 1.10 cgd #include <sys/vnode.h>
51 1.10 cgd #include <sys/mount.h>
52 1.10 cgd #include <sys/errno.h>
53 1.39 lukem #include <sys/filedesc.h>
54 1.39 lukem #include <sys/hash.h>
55 1.10 cgd #include <sys/proc.h>
56 1.40 wrstuden #include <sys/syslog.h>
57 1.70 elad #include <sys/kauth.h>
58 1.97 ad #include <sys/ktrace.h>
59 1.192 christos #include <sys/dirent.h>
60 1.12 mycroft
61 1.67 chs #ifndef MAGICLINKS
62 1.67 chs #define MAGICLINKS 0
63 1.67 chs #endif
64 1.67 chs
65 1.67 chs int vfs_magiclinks = MAGICLINKS;
66 1.67 chs
67 1.191 christos __CTASSERT(MAXNAMLEN == NAME_MAX);
68 1.191 christos
69 1.10 cgd /*
70 1.61 thorpej * Substitute replacement text for 'magic' strings in symlinks.
71 1.61 thorpej * Returns 0 if successful, and returns non-zero if an error
72 1.61 thorpej * occurs. (Currently, the only possible error is running out
73 1.61 thorpej * of temporary pathname space.)
74 1.61 thorpej *
75 1.61 thorpej * Looks for "@<string>" and "@<string>/", where <string> is a
76 1.61 thorpej * recognized 'magic' string. Replaces the "@<string>" with the
77 1.61 thorpej * appropriate replacement text. (Note that in some cases the
78 1.61 thorpej * replacement text may have zero length.)
79 1.61 thorpej *
80 1.61 thorpej * This would have been table driven, but the variance in
81 1.61 thorpej * replacement strings (and replacement string lengths) made
82 1.61 thorpej * that impractical.
83 1.61 thorpej */
84 1.63 thorpej #define VNL(x) \
85 1.63 thorpej (sizeof(x) - 1)
86 1.63 thorpej
87 1.63 thorpej #define VO '{'
88 1.63 thorpej #define VC '}'
89 1.63 thorpej
90 1.61 thorpej #define MATCH(str) \
91 1.63 thorpej ((termchar == '/' && i + VNL(str) == *len) || \
92 1.63 thorpej (i + VNL(str) < *len && \
93 1.63 thorpej cp[i + VNL(str)] == termchar)) && \
94 1.63 thorpej !strncmp((str), &cp[i], VNL(str))
95 1.61 thorpej
96 1.61 thorpej #define SUBSTITUTE(m, s, sl) \
97 1.115 christos if ((newlen + (sl)) >= MAXPATHLEN) \
98 1.115 christos return 1; \
99 1.63 thorpej i += VNL(m); \
100 1.63 thorpej if (termchar != '/') \
101 1.63 thorpej i++; \
102 1.115 christos (void)memcpy(&tmp[newlen], (s), (sl)); \
103 1.63 thorpej newlen += (sl); \
104 1.63 thorpej change = 1; \
105 1.63 thorpej termchar = '/';
106 1.61 thorpej
107 1.61 thorpej static int
108 1.115 christos symlink_magic(struct proc *p, char *cp, size_t *len)
109 1.61 thorpej {
110 1.66 yamt char *tmp;
111 1.115 christos size_t change, i, newlen, slen;
112 1.115 christos char termchar = '/';
113 1.115 christos char idtmp[11]; /* enough for 32 bit *unsigned* integer */
114 1.101 mjf
115 1.61 thorpej
116 1.66 yamt tmp = PNBUF_GET();
117 1.61 thorpej for (change = i = newlen = 0; i < *len; ) {
118 1.63 thorpej if (cp[i] != '@') {
119 1.61 thorpej tmp[newlen++] = cp[i++];
120 1.63 thorpej continue;
121 1.63 thorpej }
122 1.63 thorpej
123 1.63 thorpej i++;
124 1.63 thorpej
125 1.63 thorpej /* Check for @{var} syntax. */
126 1.63 thorpej if (cp[i] == VO) {
127 1.63 thorpej termchar = VC;
128 1.61 thorpej i++;
129 1.63 thorpej }
130 1.63 thorpej
131 1.63 thorpej /*
132 1.63 thorpej * The following checks should be ordered according
133 1.63 thorpej * to frequency of use.
134 1.63 thorpej */
135 1.63 thorpej if (MATCH("machine_arch")) {
136 1.115 christos slen = VNL(MACHINE_ARCH);
137 1.115 christos SUBSTITUTE("machine_arch", MACHINE_ARCH, slen);
138 1.63 thorpej } else if (MATCH("machine")) {
139 1.115 christos slen = VNL(MACHINE);
140 1.115 christos SUBSTITUTE("machine", MACHINE, slen);
141 1.63 thorpej } else if (MATCH("hostname")) {
142 1.115 christos SUBSTITUTE("hostname", hostname, hostnamelen);
143 1.63 thorpej } else if (MATCH("osrelease")) {
144 1.115 christos slen = strlen(osrelease);
145 1.115 christos SUBSTITUTE("osrelease", osrelease, slen);
146 1.63 thorpej } else if (MATCH("emul")) {
147 1.115 christos slen = strlen(p->p_emul->e_name);
148 1.115 christos SUBSTITUTE("emul", p->p_emul->e_name, slen);
149 1.63 thorpej } else if (MATCH("kernel_ident")) {
150 1.115 christos slen = strlen(kernel_ident);
151 1.115 christos SUBSTITUTE("kernel_ident", kernel_ident, slen);
152 1.63 thorpej } else if (MATCH("domainname")) {
153 1.115 christos SUBSTITUTE("domainname", domainname, domainnamelen);
154 1.63 thorpej } else if (MATCH("ostype")) {
155 1.115 christos slen = strlen(ostype);
156 1.115 christos SUBSTITUTE("ostype", ostype, slen);
157 1.72 elad } else if (MATCH("uid")) {
158 1.115 christos slen = snprintf(idtmp, sizeof(idtmp), "%u",
159 1.72 elad kauth_cred_geteuid(kauth_cred_get()));
160 1.115 christos SUBSTITUTE("uid", idtmp, slen);
161 1.101 mjf } else if (MATCH("ruid")) {
162 1.115 christos slen = snprintf(idtmp, sizeof(idtmp), "%u",
163 1.101 mjf kauth_cred_getuid(kauth_cred_get()));
164 1.115 christos SUBSTITUTE("ruid", idtmp, slen);
165 1.115 christos } else if (MATCH("gid")) {
166 1.115 christos slen = snprintf(idtmp, sizeof(idtmp), "%u",
167 1.115 christos kauth_cred_getegid(kauth_cred_get()));
168 1.115 christos SUBSTITUTE("gid", idtmp, slen);
169 1.115 christos } else if (MATCH("rgid")) {
170 1.115 christos slen = snprintf(idtmp, sizeof(idtmp), "%u",
171 1.115 christos kauth_cred_getgid(kauth_cred_get()));
172 1.115 christos SUBSTITUTE("rgid", idtmp, slen);
173 1.63 thorpej } else {
174 1.63 thorpej tmp[newlen++] = '@';
175 1.63 thorpej if (termchar == VC)
176 1.63 thorpej tmp[newlen++] = VO;
177 1.61 thorpej }
178 1.61 thorpej }
179 1.61 thorpej
180 1.66 yamt if (change) {
181 1.115 christos (void)memcpy(cp, tmp, newlen);
182 1.66 yamt *len = newlen;
183 1.66 yamt }
184 1.66 yamt PNBUF_PUT(tmp);
185 1.61 thorpej
186 1.115 christos return 0;
187 1.61 thorpej }
188 1.61 thorpej
189 1.63 thorpej #undef VNL
190 1.63 thorpej #undef VO
191 1.63 thorpej #undef VC
192 1.63 thorpej #undef MATCH
193 1.63 thorpej #undef SUBSTITUTE
194 1.63 thorpej
195 1.123 dholland ////////////////////////////////////////////////////////////
196 1.123 dholland
197 1.123 dholland /*
198 1.197 dholland * Determine the namei hash (for the namecache) for name.
199 1.131 dholland * If *ep != NULL, hash from name to ep-1.
200 1.131 dholland * If *ep == NULL, hash from name until the first NUL or '/', and
201 1.131 dholland * return the location of this termination character in *ep.
202 1.131 dholland *
203 1.131 dholland * This function returns an equivalent hash to the MI hash32_strn().
204 1.131 dholland * The latter isn't used because in the *ep == NULL case, determining
205 1.131 dholland * the length of the string to the first NUL or `/' and then calling
206 1.131 dholland * hash32_strn() involves unnecessary double-handling of the data.
207 1.131 dholland */
208 1.131 dholland uint32_t
209 1.131 dholland namei_hash(const char *name, const char **ep)
210 1.131 dholland {
211 1.131 dholland uint32_t hash;
212 1.131 dholland
213 1.131 dholland hash = HASH32_STR_INIT;
214 1.131 dholland if (*ep != NULL) {
215 1.131 dholland for (; name < *ep; name++)
216 1.131 dholland hash = hash * 33 + *(const uint8_t *)name;
217 1.131 dholland } else {
218 1.131 dholland for (; *name != '\0' && *name != '/'; name++)
219 1.131 dholland hash = hash * 33 + *(const uint8_t *)name;
220 1.131 dholland *ep = name;
221 1.131 dholland }
222 1.131 dholland return (hash + (hash >> 5));
223 1.131 dholland }
224 1.131 dholland
225 1.197 dholland /*
226 1.197 dholland * Find the end of the first path component in NAME and return its
227 1.197 dholland * length.
228 1.197 dholland */
229 1.197 dholland static size_t
230 1.197 dholland namei_getcomponent(const char *name)
231 1.197 dholland {
232 1.197 dholland size_t pos;
233 1.197 dholland
234 1.197 dholland pos = 0;
235 1.197 dholland while (name[pos] != '\0' && name[pos] != '/') {
236 1.197 dholland pos++;
237 1.197 dholland }
238 1.197 dholland return pos;
239 1.197 dholland }
240 1.197 dholland
241 1.131 dholland ////////////////////////////////////////////////////////////
242 1.131 dholland
243 1.131 dholland /*
244 1.123 dholland * Sealed abstraction for pathnames.
245 1.123 dholland *
246 1.123 dholland * System-call-layer level code that is going to call namei should
247 1.123 dholland * first create a pathbuf and adjust all the bells and whistles on it
248 1.176 dholland * as needed by context.
249 1.123 dholland */
250 1.123 dholland
251 1.123 dholland struct pathbuf {
252 1.123 dholland char *pb_path;
253 1.123 dholland char *pb_pathcopy;
254 1.123 dholland unsigned pb_pathcopyuses;
255 1.123 dholland };
256 1.123 dholland
257 1.123 dholland static struct pathbuf *
258 1.123 dholland pathbuf_create_raw(void)
259 1.123 dholland {
260 1.123 dholland struct pathbuf *pb;
261 1.123 dholland
262 1.123 dholland pb = kmem_alloc(sizeof(*pb), KM_SLEEP);
263 1.123 dholland if (pb == NULL) {
264 1.123 dholland return NULL;
265 1.123 dholland }
266 1.123 dholland pb->pb_path = PNBUF_GET();
267 1.123 dholland if (pb->pb_path == NULL) {
268 1.123 dholland kmem_free(pb, sizeof(*pb));
269 1.123 dholland return NULL;
270 1.123 dholland }
271 1.123 dholland pb->pb_pathcopy = NULL;
272 1.123 dholland pb->pb_pathcopyuses = 0;
273 1.123 dholland return pb;
274 1.123 dholland }
275 1.123 dholland
276 1.123 dholland void
277 1.123 dholland pathbuf_destroy(struct pathbuf *pb)
278 1.123 dholland {
279 1.123 dholland KASSERT(pb->pb_pathcopyuses == 0);
280 1.123 dholland KASSERT(pb->pb_pathcopy == NULL);
281 1.123 dholland PNBUF_PUT(pb->pb_path);
282 1.123 dholland kmem_free(pb, sizeof(*pb));
283 1.123 dholland }
284 1.123 dholland
285 1.123 dholland struct pathbuf *
286 1.124 dholland pathbuf_assimilate(char *pnbuf)
287 1.124 dholland {
288 1.124 dholland struct pathbuf *pb;
289 1.124 dholland
290 1.124 dholland pb = kmem_alloc(sizeof(*pb), KM_SLEEP);
291 1.124 dholland if (pb == NULL) {
292 1.124 dholland return NULL;
293 1.124 dholland }
294 1.124 dholland pb->pb_path = pnbuf;
295 1.124 dholland pb->pb_pathcopy = NULL;
296 1.124 dholland pb->pb_pathcopyuses = 0;
297 1.124 dholland return pb;
298 1.124 dholland }
299 1.124 dholland
300 1.124 dholland struct pathbuf *
301 1.123 dholland pathbuf_create(const char *path)
302 1.123 dholland {
303 1.123 dholland struct pathbuf *pb;
304 1.123 dholland int error;
305 1.123 dholland
306 1.123 dholland pb = pathbuf_create_raw();
307 1.123 dholland if (pb == NULL) {
308 1.123 dholland return NULL;
309 1.123 dholland }
310 1.123 dholland error = copystr(path, pb->pb_path, PATH_MAX, NULL);
311 1.123 dholland if (error != 0) {
312 1.123 dholland KASSERT(!"kernel path too long in pathbuf_create");
313 1.123 dholland /* make sure it's null-terminated, just in case */
314 1.123 dholland pb->pb_path[PATH_MAX-1] = '\0';
315 1.123 dholland }
316 1.123 dholland return pb;
317 1.123 dholland }
318 1.123 dholland
319 1.123 dholland int
320 1.123 dholland pathbuf_copyin(const char *userpath, struct pathbuf **ret)
321 1.123 dholland {
322 1.123 dholland struct pathbuf *pb;
323 1.123 dholland int error;
324 1.123 dholland
325 1.123 dholland pb = pathbuf_create_raw();
326 1.123 dholland if (pb == NULL) {
327 1.123 dholland return ENOMEM;
328 1.123 dholland }
329 1.123 dholland error = copyinstr(userpath, pb->pb_path, PATH_MAX, NULL);
330 1.123 dholland if (error) {
331 1.123 dholland pathbuf_destroy(pb);
332 1.123 dholland return error;
333 1.123 dholland }
334 1.123 dholland *ret = pb;
335 1.123 dholland return 0;
336 1.123 dholland }
337 1.123 dholland
338 1.123 dholland /*
339 1.173 dholland * XXX should not exist:
340 1.176 dholland * 1. whether a pointer is kernel or user should be statically checkable.
341 1.173 dholland * 2. copyin should be handled by the upper part of the syscall layer,
342 1.173 dholland * not in here.
343 1.123 dholland */
344 1.123 dholland int
345 1.123 dholland pathbuf_maybe_copyin(const char *path, enum uio_seg seg, struct pathbuf **ret)
346 1.123 dholland {
347 1.123 dholland if (seg == UIO_USERSPACE) {
348 1.123 dholland return pathbuf_copyin(path, ret);
349 1.123 dholland } else {
350 1.123 dholland *ret = pathbuf_create(path);
351 1.123 dholland if (*ret == NULL) {
352 1.123 dholland return ENOMEM;
353 1.123 dholland }
354 1.123 dholland return 0;
355 1.123 dholland }
356 1.123 dholland }
357 1.123 dholland
358 1.123 dholland /*
359 1.123 dholland * Get a copy of the path buffer as it currently exists. If this is
360 1.123 dholland * called after namei starts the results may be arbitrary.
361 1.123 dholland */
362 1.123 dholland void
363 1.123 dholland pathbuf_copystring(const struct pathbuf *pb, char *buf, size_t maxlen)
364 1.123 dholland {
365 1.123 dholland strlcpy(buf, pb->pb_path, maxlen);
366 1.123 dholland }
367 1.123 dholland
368 1.123 dholland /*
369 1.123 dholland * These two functions allow access to a saved copy of the original
370 1.123 dholland * path string. The first copy should be gotten before namei is
371 1.123 dholland * called. Each copy that is gotten should be put back.
372 1.123 dholland */
373 1.123 dholland
374 1.123 dholland const char *
375 1.123 dholland pathbuf_stringcopy_get(struct pathbuf *pb)
376 1.123 dholland {
377 1.123 dholland if (pb->pb_pathcopyuses == 0) {
378 1.123 dholland pb->pb_pathcopy = PNBUF_GET();
379 1.123 dholland strcpy(pb->pb_pathcopy, pb->pb_path);
380 1.123 dholland }
381 1.123 dholland pb->pb_pathcopyuses++;
382 1.123 dholland return pb->pb_pathcopy;
383 1.123 dholland }
384 1.123 dholland
385 1.123 dholland void
386 1.123 dholland pathbuf_stringcopy_put(struct pathbuf *pb, const char *str)
387 1.123 dholland {
388 1.123 dholland KASSERT(str == pb->pb_pathcopy);
389 1.123 dholland KASSERT(pb->pb_pathcopyuses > 0);
390 1.123 dholland pb->pb_pathcopyuses--;
391 1.123 dholland if (pb->pb_pathcopyuses == 0) {
392 1.123 dholland PNBUF_PUT(pb->pb_pathcopy);
393 1.123 dholland pb->pb_pathcopy = NULL;
394 1.123 dholland }
395 1.123 dholland }
396 1.123 dholland
397 1.123 dholland
398 1.123 dholland ////////////////////////////////////////////////////////////
399 1.123 dholland
400 1.61 thorpej /*
401 1.173 dholland * namei: convert a pathname into a pointer to a (maybe-locked) vnode,
402 1.173 dholland * and maybe also its parent directory vnode, and assorted other guff.
403 1.173 dholland * See namei(9) for the interface documentation.
404 1.173 dholland *
405 1.10 cgd *
406 1.10 cgd * The FOLLOW flag is set when symbolic links are to be followed
407 1.10 cgd * when they occur at the end of the name translation process.
408 1.10 cgd * Symbolic links are always followed for all other pathname
409 1.10 cgd * components other than the last.
410 1.10 cgd *
411 1.10 cgd * The segflg defines whether the name is to be copied from user
412 1.10 cgd * space or kernel space.
413 1.10 cgd *
414 1.10 cgd * Overall outline of namei:
415 1.10 cgd *
416 1.10 cgd * copy in name
417 1.10 cgd * get starting directory
418 1.10 cgd * while (!done && !error) {
419 1.10 cgd * call lookup to search path.
420 1.10 cgd * if symbolic link, massage name in buffer and continue
421 1.10 cgd * }
422 1.10 cgd */
423 1.117 dholland
424 1.117 dholland /*
425 1.173 dholland * Search a pathname.
426 1.173 dholland * This is a very central and rather complicated routine.
427 1.173 dholland *
428 1.173 dholland * The pathname is pointed to by ni_ptr and is of length ni_pathlen.
429 1.173 dholland * The starting directory is passed in. The pathname is descended
430 1.173 dholland * until done, or a symbolic link is encountered. The variable ni_more
431 1.173 dholland * is clear if the path is completed; it is set to one if a symbolic
432 1.173 dholland * link needing interpretation is encountered.
433 1.173 dholland *
434 1.173 dholland * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
435 1.173 dholland * whether the name is to be looked up, created, renamed, or deleted.
436 1.173 dholland * When CREATE, RENAME, or DELETE is specified, information usable in
437 1.173 dholland * creating, renaming, or deleting a directory entry may be calculated.
438 1.173 dholland * If flag has LOCKPARENT or'ed into it, the parent directory is returned
439 1.173 dholland * locked. Otherwise the parent directory is not returned. If the target
440 1.173 dholland * of the pathname exists and LOCKLEAF is or'ed into the flag the target
441 1.173 dholland * is returned locked, otherwise it is returned unlocked. When creating
442 1.173 dholland * or renaming and LOCKPARENT is specified, the target may not be ".".
443 1.173 dholland * When deleting and LOCKPARENT is specified, the target may be ".".
444 1.173 dholland *
445 1.173 dholland * Overall outline of lookup:
446 1.173 dholland *
447 1.173 dholland * dirloop:
448 1.173 dholland * identify next component of name at ndp->ni_ptr
449 1.173 dholland * handle degenerate case where name is null string
450 1.173 dholland * if .. and crossing mount points and on mounted filesys, find parent
451 1.173 dholland * call VOP_LOOKUP routine for next component name
452 1.173 dholland * directory vnode returned in ni_dvp, locked.
453 1.173 dholland * component vnode returned in ni_vp (if it exists), locked.
454 1.173 dholland * if result vnode is mounted on and crossing mount points,
455 1.173 dholland * find mounted on vnode
456 1.173 dholland * if more components of name, do next level at dirloop
457 1.173 dholland * return the answer in ni_vp, locked if LOCKLEAF set
458 1.173 dholland * if LOCKPARENT set, return locked parent in ni_dvp
459 1.173 dholland */
460 1.173 dholland
461 1.173 dholland
462 1.173 dholland /*
463 1.117 dholland * Internal state for a namei operation.
464 1.173 dholland *
465 1.173 dholland * cnp is always equal to &ndp->ni_cnp.
466 1.117 dholland */
467 1.117 dholland struct namei_state {
468 1.117 dholland struct nameidata *ndp;
469 1.117 dholland struct componentname *cnp;
470 1.117 dholland
471 1.118 dholland int docache; /* == 0 do not cache last component */
472 1.118 dholland int rdonly; /* lookup read-only flag bit */
473 1.118 dholland int slashes;
474 1.137 dholland
475 1.137 dholland unsigned attempt_retry:1; /* true if error allows emul retry */
476 1.117 dholland };
477 1.117 dholland
478 1.118 dholland
479 1.117 dholland /*
480 1.117 dholland * Initialize the namei working state.
481 1.117 dholland */
482 1.117 dholland static void
483 1.117 dholland namei_init(struct namei_state *state, struct nameidata *ndp)
484 1.117 dholland {
485 1.117 dholland state->ndp = ndp;
486 1.117 dholland state->cnp = &ndp->ni_cnd;
487 1.129 dholland KASSERT((state->cnp->cn_flags & INRELOOKUP) == 0);
488 1.117 dholland
489 1.118 dholland state->docache = 0;
490 1.118 dholland state->rdonly = 0;
491 1.118 dholland state->slashes = 0;
492 1.133 dholland
493 1.133 dholland #ifdef DIAGNOSTIC
494 1.133 dholland if (!state->cnp->cn_cred)
495 1.133 dholland panic("namei: bad cred/proc");
496 1.133 dholland if (state->cnp->cn_nameiop & (~OPMASK))
497 1.133 dholland panic("namei: nameiop contaminated with flags");
498 1.133 dholland if (state->cnp->cn_flags & OPMASK)
499 1.133 dholland panic("namei: flags contaminated with nameiops");
500 1.133 dholland #endif
501 1.133 dholland
502 1.133 dholland /*
503 1.133 dholland * The buffer for name translation shall be the one inside the
504 1.133 dholland * pathbuf.
505 1.133 dholland */
506 1.133 dholland state->ndp->ni_pnbuf = state->ndp->ni_pathbuf->pb_path;
507 1.117 dholland }
508 1.117 dholland
509 1.117 dholland /*
510 1.117 dholland * Clean up the working namei state, leaving things ready for return
511 1.117 dholland * from namei.
512 1.117 dholland */
513 1.117 dholland static void
514 1.117 dholland namei_cleanup(struct namei_state *state)
515 1.117 dholland {
516 1.117 dholland KASSERT(state->cnp == &state->ndp->ni_cnd);
517 1.117 dholland
518 1.117 dholland /* nothing for now */
519 1.117 dholland (void)state;
520 1.117 dholland }
521 1.117 dholland
522 1.117 dholland //////////////////////////////
523 1.117 dholland
524 1.117 dholland /*
525 1.133 dholland * Get the directory context.
526 1.133 dholland * Initializes the rootdir and erootdir state and returns a reference
527 1.133 dholland * to the starting dir.
528 1.117 dholland */
529 1.133 dholland static struct vnode *
530 1.196 dholland namei_getstartdir(struct namei_state *state)
531 1.117 dholland {
532 1.117 dholland struct nameidata *ndp = state->ndp;
533 1.117 dholland struct componentname *cnp = state->cnp;
534 1.117 dholland struct cwdinfo *cwdi; /* pointer to cwd state */
535 1.117 dholland struct lwp *self = curlwp; /* thread doing namei() */
536 1.133 dholland struct vnode *rootdir, *erootdir, *curdir, *startdir;
537 1.117 dholland
538 1.133 dholland cwdi = self->l_proc->p_cwdi;
539 1.133 dholland rw_enter(&cwdi->cwdi_lock, RW_READER);
540 1.21 kleink
541 1.133 dholland /* root dir */
542 1.133 dholland if (cwdi->cwdi_rdir == NULL || (cnp->cn_flags & NOCHROOT)) {
543 1.133 dholland rootdir = rootvnode;
544 1.133 dholland } else {
545 1.133 dholland rootdir = cwdi->cwdi_rdir;
546 1.10 cgd }
547 1.123 dholland
548 1.133 dholland /* emulation root dir, if any */
549 1.133 dholland if ((cnp->cn_flags & TRYEMULROOT) == 0) {
550 1.133 dholland /* if we don't want it, don't fetch it */
551 1.133 dholland erootdir = NULL;
552 1.133 dholland } else if (cnp->cn_flags & EMULROOTSET) {
553 1.133 dholland /* explicitly set emulroot; "/../" doesn't override this */
554 1.133 dholland erootdir = ndp->ni_erootdir;
555 1.133 dholland } else if (!strncmp(ndp->ni_pnbuf, "/../", 4)) {
556 1.133 dholland /* explicit reference to real rootdir */
557 1.133 dholland erootdir = NULL;
558 1.133 dholland } else {
559 1.133 dholland /* may be null */
560 1.133 dholland erootdir = cwdi->cwdi_edir;
561 1.133 dholland }
562 1.21 kleink
563 1.133 dholland /* current dir */
564 1.196 dholland curdir = cwdi->cwdi_cdir;
565 1.85 dsl
566 1.133 dholland if (ndp->ni_pnbuf[0] != '/') {
567 1.196 dholland if (ndp->ni_startdir != NULL) {
568 1.196 dholland startdir = ndp->ni_startdir;
569 1.196 dholland } else {
570 1.196 dholland startdir = curdir;
571 1.196 dholland }
572 1.133 dholland erootdir = NULL;
573 1.133 dholland } else if (cnp->cn_flags & TRYEMULROOT && erootdir != NULL) {
574 1.133 dholland startdir = erootdir;
575 1.23 mycroft } else {
576 1.133 dholland startdir = rootdir;
577 1.133 dholland erootdir = NULL;
578 1.23 mycroft }
579 1.133 dholland
580 1.133 dholland state->ndp->ni_rootdir = rootdir;
581 1.133 dholland state->ndp->ni_erootdir = erootdir;
582 1.117 dholland
583 1.117 dholland /*
584 1.133 dholland * Get a reference to the start dir so we can safely unlock cwdi.
585 1.133 dholland *
586 1.133 dholland * XXX: should we hold references to rootdir and erootdir while
587 1.133 dholland * we're running? What happens if a multithreaded process chroots
588 1.133 dholland * during namei?
589 1.117 dholland */
590 1.133 dholland vref(startdir);
591 1.133 dholland
592 1.133 dholland rw_exit(&cwdi->cwdi_lock);
593 1.133 dholland return startdir;
594 1.133 dholland }
595 1.133 dholland
596 1.133 dholland /*
597 1.133 dholland * Get the directory context for the nfsd case, in parallel to
598 1.133 dholland * getstartdir. Initializes the rootdir and erootdir state and
599 1.173 dholland * returns a reference to the passed-in starting dir.
600 1.133 dholland */
601 1.133 dholland static struct vnode *
602 1.196 dholland namei_getstartdir_for_nfsd(struct namei_state *state)
603 1.133 dholland {
604 1.196 dholland KASSERT(state->ndp->ni_startdir != NULL);
605 1.193 dholland
606 1.133 dholland /* always use the real root, and never set an emulation root */
607 1.133 dholland state->ndp->ni_rootdir = rootvnode;
608 1.133 dholland state->ndp->ni_erootdir = NULL;
609 1.133 dholland
610 1.196 dholland vref(state->ndp->ni_startdir);
611 1.196 dholland return state->ndp->ni_startdir;
612 1.133 dholland }
613 1.133 dholland
614 1.133 dholland
615 1.133 dholland /*
616 1.133 dholland * Ktrace the namei operation.
617 1.133 dholland */
618 1.133 dholland static void
619 1.133 dholland namei_ktrace(struct namei_state *state)
620 1.133 dholland {
621 1.133 dholland struct nameidata *ndp = state->ndp;
622 1.133 dholland struct componentname *cnp = state->cnp;
623 1.133 dholland struct lwp *self = curlwp; /* thread doing namei() */
624 1.133 dholland const char *emul_path;
625 1.133 dholland
626 1.97 ad if (ktrpoint(KTR_NAMEI)) {
627 1.90 dsl if (ndp->ni_erootdir != NULL) {
628 1.89 dsl /*
629 1.89 dsl * To make any sense, the trace entry need to have the
630 1.89 dsl * text of the emulation path prepended.
631 1.89 dsl * Usually we can get this from the current process,
632 1.89 dsl * but when called from emul_find_interp() it is only
633 1.89 dsl * in the exec_package - so we get it passed in ni_next
634 1.89 dsl * (this is a hack).
635 1.89 dsl */
636 1.88 dsl if (cnp->cn_flags & EMULROOTSET)
637 1.89 dsl emul_path = ndp->ni_next;
638 1.88 dsl else
639 1.117 dholland emul_path = self->l_proc->p_emul->e_path;
640 1.97 ad ktrnamei2(emul_path, strlen(emul_path),
641 1.124 dholland ndp->ni_pnbuf, ndp->ni_pathlen);
642 1.88 dsl } else
643 1.124 dholland ktrnamei(ndp->ni_pnbuf, ndp->ni_pathlen);
644 1.88 dsl }
645 1.133 dholland }
646 1.133 dholland
647 1.133 dholland /*
648 1.166 dholland * Start up namei. Find the root dir and cwd, establish the starting
649 1.166 dholland * directory for lookup, and lock it. Also calls ktrace when
650 1.133 dholland * appropriate.
651 1.133 dholland */
652 1.133 dholland static int
653 1.196 dholland namei_start(struct namei_state *state, int isnfsd,
654 1.140 dholland struct vnode **startdir_ret)
655 1.133 dholland {
656 1.133 dholland struct nameidata *ndp = state->ndp;
657 1.140 dholland struct vnode *startdir;
658 1.133 dholland
659 1.133 dholland /* length includes null terminator (was originally from copyinstr) */
660 1.133 dholland ndp->ni_pathlen = strlen(ndp->ni_pnbuf) + 1;
661 1.133 dholland
662 1.133 dholland /*
663 1.133 dholland * POSIX.1 requirement: "" is not a valid file name.
664 1.133 dholland */
665 1.133 dholland if (ndp->ni_pathlen == 1) {
666 1.133 dholland return ENOENT;
667 1.133 dholland }
668 1.133 dholland
669 1.133 dholland ndp->ni_loopcnt = 0;
670 1.133 dholland
671 1.133 dholland /* Get starting directory, set up root, and ktrace. */
672 1.193 dholland if (isnfsd) {
673 1.196 dholland startdir = namei_getstartdir_for_nfsd(state);
674 1.133 dholland /* no ktrace */
675 1.133 dholland } else {
676 1.196 dholland startdir = namei_getstartdir(state);
677 1.133 dholland namei_ktrace(state);
678 1.133 dholland }
679 1.97 ad
680 1.140 dholland vn_lock(startdir, LK_EXCLUSIVE | LK_RETRY);
681 1.117 dholland
682 1.140 dholland *startdir_ret = startdir;
683 1.117 dholland return 0;
684 1.117 dholland }
685 1.117 dholland
686 1.117 dholland /*
687 1.173 dholland * Check for being at a symlink that we're going to follow.
688 1.117 dholland */
689 1.117 dholland static inline int
690 1.144 dholland namei_atsymlink(struct namei_state *state, struct vnode *foundobj)
691 1.117 dholland {
692 1.144 dholland return (foundobj->v_type == VLNK) &&
693 1.139 dholland (state->cnp->cn_flags & (FOLLOW|REQUIREDIR));
694 1.117 dholland }
695 1.117 dholland
696 1.117 dholland /*
697 1.117 dholland * Follow a symlink.
698 1.173 dholland *
699 1.173 dholland * Updates searchdir. inhibitmagic causes magic symlinks to not be
700 1.173 dholland * interpreted; this is used by nfsd.
701 1.174 jakllsch *
702 1.174 jakllsch * Unlocks foundobj on success (ugh)
703 1.117 dholland */
704 1.117 dholland static inline int
705 1.141 dholland namei_follow(struct namei_state *state, int inhibitmagic,
706 1.161 dholland struct vnode *searchdir, struct vnode *foundobj,
707 1.141 dholland struct vnode **newsearchdir_ret)
708 1.117 dholland {
709 1.117 dholland struct nameidata *ndp = state->ndp;
710 1.117 dholland struct componentname *cnp = state->cnp;
711 1.117 dholland
712 1.117 dholland struct lwp *self = curlwp; /* thread doing namei() */
713 1.117 dholland struct iovec aiov; /* uio for reading symbolic links */
714 1.117 dholland struct uio auio;
715 1.117 dholland char *cp; /* pointer into pathname argument */
716 1.117 dholland size_t linklen;
717 1.117 dholland int error;
718 1.117 dholland
719 1.175 yamt KASSERT(VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
720 1.175 yamt KASSERT(VOP_ISLOCKED(foundobj) == LK_EXCLUSIVE);
721 1.117 dholland if (ndp->ni_loopcnt++ >= MAXSYMLINKS) {
722 1.117 dholland return ELOOP;
723 1.117 dholland }
724 1.161 dholland if (foundobj->v_mount->mnt_flag & MNT_SYMPERM) {
725 1.161 dholland error = VOP_ACCESS(foundobj, VEXEC, cnp->cn_cred);
726 1.117 dholland if (error != 0)
727 1.117 dholland return error;
728 1.117 dholland }
729 1.124 dholland
730 1.124 dholland /* FUTURE: fix this to not use a second buffer */
731 1.124 dholland cp = PNBUF_GET();
732 1.117 dholland aiov.iov_base = cp;
733 1.117 dholland aiov.iov_len = MAXPATHLEN;
734 1.117 dholland auio.uio_iov = &aiov;
735 1.117 dholland auio.uio_iovcnt = 1;
736 1.117 dholland auio.uio_offset = 0;
737 1.117 dholland auio.uio_rw = UIO_READ;
738 1.117 dholland auio.uio_resid = MAXPATHLEN;
739 1.117 dholland UIO_SETUP_SYSSPACE(&auio);
740 1.161 dholland error = VOP_READLINK(foundobj, &auio, cnp->cn_cred);
741 1.117 dholland if (error) {
742 1.124 dholland PNBUF_PUT(cp);
743 1.117 dholland return error;
744 1.117 dholland }
745 1.117 dholland linklen = MAXPATHLEN - auio.uio_resid;
746 1.117 dholland if (linklen == 0) {
747 1.124 dholland PNBUF_PUT(cp);
748 1.124 dholland return ENOENT;
749 1.117 dholland }
750 1.117 dholland
751 1.117 dholland /*
752 1.117 dholland * Do symlink substitution, if appropriate, and
753 1.117 dholland * check length for potential overflow.
754 1.134 dholland *
755 1.134 dholland * Inhibit symlink substitution for nfsd.
756 1.134 dholland * XXX: This is how it was before; is that a bug or a feature?
757 1.117 dholland */
758 1.134 dholland if ((!inhibitmagic && vfs_magiclinks &&
759 1.117 dholland symlink_magic(self->l_proc, cp, &linklen)) ||
760 1.117 dholland (linklen + ndp->ni_pathlen >= MAXPATHLEN)) {
761 1.124 dholland PNBUF_PUT(cp);
762 1.124 dholland return ENAMETOOLONG;
763 1.117 dholland }
764 1.117 dholland if (ndp->ni_pathlen > 1) {
765 1.124 dholland /* includes a null-terminator */
766 1.117 dholland memcpy(cp + linklen, ndp->ni_next, ndp->ni_pathlen);
767 1.124 dholland } else {
768 1.124 dholland cp[linklen] = '\0';
769 1.124 dholland }
770 1.117 dholland ndp->ni_pathlen += linklen;
771 1.124 dholland memcpy(ndp->ni_pnbuf, cp, ndp->ni_pathlen);
772 1.124 dholland PNBUF_PUT(cp);
773 1.167 dholland
774 1.167 dholland /* we're now starting from the beginning of the buffer again */
775 1.167 dholland cnp->cn_nameptr = ndp->ni_pnbuf;
776 1.117 dholland
777 1.174 jakllsch /* must unlock this before relocking searchdir */
778 1.174 jakllsch VOP_UNLOCK(foundobj);
779 1.174 jakllsch
780 1.117 dholland /*
781 1.117 dholland * Check if root directory should replace current directory.
782 1.117 dholland */
783 1.124 dholland if (ndp->ni_pnbuf[0] == '/') {
784 1.141 dholland vput(searchdir);
785 1.117 dholland /* Keep absolute symbolic links inside emulation root */
786 1.141 dholland searchdir = ndp->ni_erootdir;
787 1.141 dholland if (searchdir == NULL ||
788 1.124 dholland (ndp->ni_pnbuf[1] == '.'
789 1.124 dholland && ndp->ni_pnbuf[2] == '.'
790 1.124 dholland && ndp->ni_pnbuf[3] == '/')) {
791 1.117 dholland ndp->ni_erootdir = NULL;
792 1.141 dholland searchdir = ndp->ni_rootdir;
793 1.117 dholland }
794 1.141 dholland vref(searchdir);
795 1.141 dholland vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
796 1.186 dholland while (cnp->cn_nameptr[0] == '/') {
797 1.186 dholland cnp->cn_nameptr++;
798 1.186 dholland ndp->ni_pathlen--;
799 1.186 dholland }
800 1.117 dholland }
801 1.117 dholland
802 1.141 dholland *newsearchdir_ret = searchdir;
803 1.175 yamt KASSERT(VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
804 1.117 dholland return 0;
805 1.117 dholland }
806 1.117 dholland
807 1.117 dholland //////////////////////////////
808 1.117 dholland
809 1.39 lukem /*
810 1.173 dholland * Inspect the leading path component and update the state accordingly.
811 1.10 cgd */
812 1.118 dholland static int
813 1.118 dholland lookup_parsepath(struct namei_state *state)
814 1.118 dholland {
815 1.118 dholland const char *cp; /* pointer into pathname argument */
816 1.118 dholland
817 1.118 dholland struct componentname *cnp = state->cnp;
818 1.118 dholland struct nameidata *ndp = state->ndp;
819 1.118 dholland
820 1.118 dholland KASSERT(cnp == &ndp->ni_cnd);
821 1.118 dholland
822 1.10 cgd /*
823 1.10 cgd * Search a new directory.
824 1.10 cgd *
825 1.10 cgd * The last component of the filename is left accessible via
826 1.12 mycroft * cnp->cn_nameptr for callers that need the name. Callers needing
827 1.10 cgd * the name set the SAVENAME flag. When done, they assume
828 1.10 cgd * responsibility for freeing the pathname buffer.
829 1.127 yamt *
830 1.147 dholland * At this point, our only vnode state is that the search dir
831 1.147 dholland * is held and locked.
832 1.10 cgd */
833 1.12 mycroft cnp->cn_consume = 0;
834 1.197 dholland cnp->cn_namelen = namei_getcomponent(cnp->cn_nameptr);
835 1.197 dholland cp = cnp->cn_nameptr + cnp->cn_namelen;
836 1.191 christos if (cnp->cn_namelen > KERNEL_NAME_MAX) {
837 1.118 dholland return ENAMETOOLONG;
838 1.10 cgd }
839 1.10 cgd #ifdef NAMEI_DIAGNOSTIC
840 1.10 cgd { char c = *cp;
841 1.41 soren *(char *)cp = '\0';
842 1.19 christos printf("{%s}: ", cnp->cn_nameptr);
843 1.41 soren *(char *)cp = c; }
844 1.52 yamt #endif /* NAMEI_DIAGNOSTIC */
845 1.12 mycroft ndp->ni_pathlen -= cnp->cn_namelen;
846 1.10 cgd ndp->ni_next = cp;
847 1.23 mycroft /*
848 1.23 mycroft * If this component is followed by a slash, then move the pointer to
849 1.23 mycroft * the next component forward, and remember that this component must be
850 1.23 mycroft * a directory.
851 1.23 mycroft */
852 1.23 mycroft if (*cp == '/') {
853 1.23 mycroft do {
854 1.23 mycroft cp++;
855 1.23 mycroft } while (*cp == '/');
856 1.118 dholland state->slashes = cp - ndp->ni_next;
857 1.118 dholland ndp->ni_pathlen -= state->slashes;
858 1.23 mycroft ndp->ni_next = cp;
859 1.23 mycroft cnp->cn_flags |= REQUIREDIR;
860 1.23 mycroft } else {
861 1.118 dholland state->slashes = 0;
862 1.23 mycroft cnp->cn_flags &= ~REQUIREDIR;
863 1.23 mycroft }
864 1.23 mycroft /*
865 1.23 mycroft * We do special processing on the last component, whether or not it's
866 1.23 mycroft * a directory. Cache all intervening lookups, but not the final one.
867 1.23 mycroft */
868 1.23 mycroft if (*cp == '\0') {
869 1.118 dholland if (state->docache)
870 1.23 mycroft cnp->cn_flags |= MAKEENTRY;
871 1.23 mycroft else
872 1.23 mycroft cnp->cn_flags &= ~MAKEENTRY;
873 1.23 mycroft cnp->cn_flags |= ISLASTCN;
874 1.23 mycroft } else {
875 1.23 mycroft cnp->cn_flags |= MAKEENTRY;
876 1.23 mycroft cnp->cn_flags &= ~ISLASTCN;
877 1.23 mycroft }
878 1.12 mycroft if (cnp->cn_namelen == 2 &&
879 1.12 mycroft cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
880 1.12 mycroft cnp->cn_flags |= ISDOTDOT;
881 1.12 mycroft else
882 1.12 mycroft cnp->cn_flags &= ~ISDOTDOT;
883 1.10 cgd
884 1.118 dholland return 0;
885 1.118 dholland }
886 1.118 dholland
887 1.173 dholland /*
888 1.173 dholland * Call VOP_LOOKUP for a single lookup; return a new search directory
889 1.173 dholland * (used when crossing mountpoints up or searching union mounts down) and
890 1.173 dholland * the found object, which for create operations may be NULL on success.
891 1.173 dholland */
892 1.118 dholland static int
893 1.147 dholland lookup_once(struct namei_state *state,
894 1.147 dholland struct vnode *searchdir,
895 1.150 dholland struct vnode **newsearchdir_ret,
896 1.147 dholland struct vnode **foundobj_ret)
897 1.118 dholland {
898 1.163 dholland struct vnode *tmpvn; /* scratch vnode */
899 1.163 dholland struct vnode *foundobj; /* result */
900 1.118 dholland struct mount *mp; /* mount table entry */
901 1.118 dholland struct lwp *l = curlwp;
902 1.118 dholland int error;
903 1.118 dholland
904 1.118 dholland struct componentname *cnp = state->cnp;
905 1.118 dholland struct nameidata *ndp = state->ndp;
906 1.118 dholland
907 1.118 dholland KASSERT(cnp == &ndp->ni_cnd);
908 1.175 yamt KASSERT(VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
909 1.154 dholland *newsearchdir_ret = searchdir;
910 1.118 dholland
911 1.10 cgd /*
912 1.10 cgd * Handle "..": two special cases.
913 1.10 cgd * 1. If at root directory (e.g. after chroot)
914 1.12 mycroft * or at absolute root directory
915 1.10 cgd * then ignore it so can't get out.
916 1.85 dsl * 1a. If at the root of the emulation filesystem go to the real
917 1.85 dsl * root. So "/../<path>" is always absolute.
918 1.85 dsl * 1b. If we have somehow gotten out of a jail, warn
919 1.40 wrstuden * and also ignore it so we can't get farther out.
920 1.10 cgd * 2. If this vnode is the root of a mounted
921 1.10 cgd * filesystem, then replace it with the
922 1.10 cgd * vnode which was mounted on so we take the
923 1.10 cgd * .. in the other file system.
924 1.10 cgd */
925 1.12 mycroft if (cnp->cn_flags & ISDOTDOT) {
926 1.64 christos struct proc *p = l->l_proc;
927 1.64 christos
928 1.10 cgd for (;;) {
929 1.154 dholland if (searchdir == ndp->ni_rootdir ||
930 1.154 dholland searchdir == rootvnode) {
931 1.147 dholland foundobj = searchdir;
932 1.147 dholland vref(foundobj);
933 1.147 dholland *foundobj_ret = foundobj;
934 1.175 yamt error = 0;
935 1.175 yamt goto done;
936 1.40 wrstuden }
937 1.40 wrstuden if (ndp->ni_rootdir != rootvnode) {
938 1.40 wrstuden int retval;
939 1.73 chs
940 1.147 dholland VOP_UNLOCK(searchdir);
941 1.147 dholland retval = vn_isunder(searchdir, ndp->ni_rootdir, l);
942 1.147 dholland vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
943 1.40 wrstuden if (!retval) {
944 1.40 wrstuden /* Oops! We got out of jail! */
945 1.40 wrstuden log(LOG_WARNING,
946 1.40 wrstuden "chrooted pid %d uid %d (%s) "
947 1.40 wrstuden "detected outside of its chroot\n",
948 1.71 ad p->p_pid, kauth_cred_geteuid(l->l_cred),
949 1.64 christos p->p_comm);
950 1.40 wrstuden /* Put us at the jail root. */
951 1.147 dholland vput(searchdir);
952 1.147 dholland searchdir = NULL;
953 1.147 dholland foundobj = ndp->ni_rootdir;
954 1.147 dholland vref(foundobj);
955 1.147 dholland vref(foundobj);
956 1.147 dholland vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
957 1.150 dholland *newsearchdir_ret = foundobj;
958 1.147 dholland *foundobj_ret = foundobj;
959 1.175 yamt error = 0;
960 1.175 yamt goto done;
961 1.40 wrstuden }
962 1.10 cgd }
963 1.147 dholland if ((searchdir->v_vflag & VV_ROOT) == 0 ||
964 1.12 mycroft (cnp->cn_flags & NOCROSSMOUNT))
965 1.10 cgd break;
966 1.163 dholland tmpvn = searchdir;
967 1.147 dholland searchdir = searchdir->v_mount->mnt_vnodecovered;
968 1.153 dholland vref(searchdir);
969 1.163 dholland vput(tmpvn);
970 1.147 dholland vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
971 1.154 dholland *newsearchdir_ret = searchdir;
972 1.10 cgd }
973 1.10 cgd }
974 1.10 cgd
975 1.10 cgd /*
976 1.10 cgd * We now have a segment name to search for, and a directory to search.
977 1.147 dholland * Our vnode state here is that "searchdir" is held and locked.
978 1.10 cgd */
979 1.12 mycroft unionlookup:
980 1.148 dholland foundobj = NULL;
981 1.148 dholland error = VOP_LOOKUP(searchdir, &foundobj, cnp);
982 1.154 dholland
983 1.73 chs if (error != 0) {
984 1.10 cgd #ifdef DIAGNOSTIC
985 1.148 dholland if (foundobj != NULL)
986 1.43 christos panic("leaf `%s' should be empty", cnp->cn_nameptr);
987 1.52 yamt #endif /* DIAGNOSTIC */
988 1.10 cgd #ifdef NAMEI_DIAGNOSTIC
989 1.19 christos printf("not found\n");
990 1.52 yamt #endif /* NAMEI_DIAGNOSTIC */
991 1.12 mycroft if ((error == ENOENT) &&
992 1.147 dholland (searchdir->v_vflag & VV_ROOT) &&
993 1.147 dholland (searchdir->v_mount->mnt_flag & MNT_UNION)) {
994 1.163 dholland tmpvn = searchdir;
995 1.147 dholland searchdir = searchdir->v_mount->mnt_vnodecovered;
996 1.153 dholland vref(searchdir);
997 1.163 dholland vput(tmpvn);
998 1.147 dholland vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
999 1.154 dholland *newsearchdir_ret = searchdir;
1000 1.12 mycroft goto unionlookup;
1001 1.10 cgd }
1002 1.12 mycroft
1003 1.10 cgd if (error != EJUSTRETURN)
1004 1.175 yamt goto done;
1005 1.73 chs
1006 1.10 cgd /*
1007 1.23 mycroft * If this was not the last component, or there were trailing
1008 1.51 christos * slashes, and we are not going to create a directory,
1009 1.51 christos * then the name must exist.
1010 1.23 mycroft */
1011 1.51 christos if ((cnp->cn_flags & (REQUIREDIR | CREATEDIR)) == REQUIREDIR) {
1012 1.175 yamt error = ENOENT;
1013 1.175 yamt goto done;
1014 1.23 mycroft }
1015 1.73 chs
1016 1.23 mycroft /*
1017 1.10 cgd * If creating and at end of pathname, then can consider
1018 1.10 cgd * allowing file to be created.
1019 1.10 cgd */
1020 1.118 dholland if (state->rdonly) {
1021 1.175 yamt error = EROFS;
1022 1.175 yamt goto done;
1023 1.10 cgd }
1024 1.73 chs
1025 1.10 cgd /*
1026 1.166 dholland * We return success and a NULL foundobj to indicate
1027 1.166 dholland * that the entry doesn't currently exist, leaving a
1028 1.173 dholland * pointer to the (normally, locked) directory vnode
1029 1.173 dholland * as searchdir.
1030 1.10 cgd */
1031 1.147 dholland *foundobj_ret = NULL;
1032 1.175 yamt error = 0;
1033 1.175 yamt goto done;
1034 1.10 cgd }
1035 1.10 cgd #ifdef NAMEI_DIAGNOSTIC
1036 1.19 christos printf("found\n");
1037 1.52 yamt #endif /* NAMEI_DIAGNOSTIC */
1038 1.10 cgd
1039 1.12 mycroft /*
1040 1.23 mycroft * Take into account any additional components consumed by the
1041 1.23 mycroft * underlying filesystem. This will include any trailing slashes after
1042 1.23 mycroft * the last component consumed.
1043 1.12 mycroft */
1044 1.12 mycroft if (cnp->cn_consume > 0) {
1045 1.118 dholland ndp->ni_pathlen -= cnp->cn_consume - state->slashes;
1046 1.118 dholland ndp->ni_next += cnp->cn_consume - state->slashes;
1047 1.12 mycroft cnp->cn_consume = 0;
1048 1.23 mycroft if (ndp->ni_next[0] == '\0')
1049 1.23 mycroft cnp->cn_flags |= ISLASTCN;
1050 1.12 mycroft }
1051 1.12 mycroft
1052 1.73 chs /*
1053 1.148 dholland * "foundobj" and "searchdir" are both locked and held,
1054 1.73 chs * and may be the same vnode.
1055 1.73 chs */
1056 1.73 chs
1057 1.10 cgd /*
1058 1.10 cgd * Check to see if the vnode has been mounted on;
1059 1.10 cgd * if so find the root of the mounted file system.
1060 1.10 cgd */
1061 1.169 dholland while (foundobj->v_type == VDIR &&
1062 1.169 dholland (mp = foundobj->v_mountedhere) != NULL &&
1063 1.12 mycroft (cnp->cn_flags & NOCROSSMOUNT) == 0) {
1064 1.108 ad error = vfs_busy(mp, NULL);
1065 1.107 ad if (error != 0) {
1066 1.190 yamt if (searchdir != foundobj) {
1067 1.190 yamt vput(foundobj);
1068 1.190 yamt } else {
1069 1.190 yamt vrele(foundobj);
1070 1.190 yamt }
1071 1.175 yamt goto done;
1072 1.107 ad }
1073 1.190 yamt if (searchdir != foundobj) {
1074 1.190 yamt VOP_UNLOCK(searchdir);
1075 1.190 yamt }
1076 1.147 dholland vput(foundobj);
1077 1.163 dholland error = VFS_ROOT(mp, &foundobj);
1078 1.106 ad vfs_unbusy(mp, false, NULL);
1079 1.32 wrstuden if (error) {
1080 1.148 dholland vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
1081 1.175 yamt goto done;
1082 1.32 wrstuden }
1083 1.190 yamt /*
1084 1.190 yamt * avoid locking vnodes from two filesystems because it's
1085 1.190 yamt * prune to deadlock. eg. when using puffs.
1086 1.190 yamt * also, it isn't a good idea to propagate slowness of a
1087 1.190 yamt * filesystem up to the root directory.
1088 1.190 yamt * for now, only handle the common case. (ie. foundobj is VDIR)
1089 1.190 yamt */
1090 1.190 yamt if (foundobj->v_type == VDIR) {
1091 1.190 yamt vrele(searchdir);
1092 1.190 yamt *newsearchdir_ret = searchdir = foundobj;
1093 1.190 yamt vref(searchdir);
1094 1.190 yamt } else {
1095 1.190 yamt VOP_UNLOCK(foundobj);
1096 1.190 yamt vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
1097 1.190 yamt vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
1098 1.190 yamt }
1099 1.14 mycroft }
1100 1.14 mycroft
1101 1.147 dholland *foundobj_ret = foundobj;
1102 1.175 yamt error = 0;
1103 1.175 yamt done:
1104 1.175 yamt KASSERT(VOP_ISLOCKED(*newsearchdir_ret) == LK_EXCLUSIVE);
1105 1.175 yamt /*
1106 1.175 yamt * *foundobj_ret is valid only if error == 0.
1107 1.175 yamt */
1108 1.175 yamt KASSERT(error != 0 || *foundobj_ret == NULL ||
1109 1.175 yamt VOP_ISLOCKED(*foundobj_ret) == LK_EXCLUSIVE);
1110 1.175 yamt return error;
1111 1.118 dholland }
1112 1.118 dholland
1113 1.131 dholland //////////////////////////////
1114 1.131 dholland
1115 1.173 dholland /*
1116 1.173 dholland * Do a complete path search from a single root directory.
1117 1.173 dholland * (This is called up to twice if TRYEMULROOT is in effect.)
1118 1.173 dholland */
1119 1.131 dholland static int
1120 1.196 dholland namei_oneroot(struct namei_state *state,
1121 1.193 dholland int neverfollow, int inhibitmagic, int isnfsd)
1122 1.131 dholland {
1123 1.131 dholland struct nameidata *ndp = state->ndp;
1124 1.131 dholland struct componentname *cnp = state->cnp;
1125 1.146 dholland struct vnode *searchdir, *foundobj;
1126 1.137 dholland int error;
1127 1.131 dholland
1128 1.196 dholland error = namei_start(state, isnfsd, &searchdir);
1129 1.131 dholland if (error) {
1130 1.164 dholland ndp->ni_dvp = NULL;
1131 1.164 dholland ndp->ni_vp = NULL;
1132 1.131 dholland return error;
1133 1.131 dholland }
1134 1.185 dholland KASSERT(searchdir->v_type == VDIR);
1135 1.131 dholland
1136 1.133 dholland /*
1137 1.139 dholland * Setup: break out flag bits into variables.
1138 1.139 dholland */
1139 1.139 dholland state->docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
1140 1.139 dholland if (cnp->cn_nameiop == DELETE)
1141 1.139 dholland state->docache = 0;
1142 1.139 dholland state->rdonly = cnp->cn_flags & RDONLY;
1143 1.139 dholland
1144 1.139 dholland /*
1145 1.133 dholland * Keep going until we run out of path components.
1146 1.133 dholland */
1147 1.139 dholland cnp->cn_nameptr = ndp->ni_pnbuf;
1148 1.185 dholland
1149 1.185 dholland /* drop leading slashes (already used them to choose startdir) */
1150 1.185 dholland while (cnp->cn_nameptr[0] == '/') {
1151 1.185 dholland cnp->cn_nameptr++;
1152 1.185 dholland ndp->ni_pathlen--;
1153 1.185 dholland }
1154 1.185 dholland /* was it just "/"? */
1155 1.185 dholland if (cnp->cn_nameptr[0] == '\0') {
1156 1.185 dholland foundobj = searchdir;
1157 1.185 dholland searchdir = NULL;
1158 1.185 dholland cnp->cn_flags |= ISLASTCN;
1159 1.185 dholland
1160 1.185 dholland /* bleh */
1161 1.185 dholland goto skiploop;
1162 1.185 dholland }
1163 1.185 dholland
1164 1.131 dholland for (;;) {
1165 1.133 dholland
1166 1.133 dholland /*
1167 1.188 dholland * If the directory we're on is unmounted, bail out.
1168 1.188 dholland * XXX: should this also check if it's unlinked?
1169 1.188 dholland * XXX: yes it should... but how?
1170 1.133 dholland */
1171 1.188 dholland if (searchdir->v_mount == NULL) {
1172 1.152 dholland vput(searchdir);
1173 1.164 dholland ndp->ni_dvp = NULL;
1174 1.164 dholland ndp->ni_vp = NULL;
1175 1.131 dholland return (ENOENT);
1176 1.131 dholland }
1177 1.133 dholland
1178 1.133 dholland /*
1179 1.133 dholland * Look up the next path component.
1180 1.133 dholland * (currently, this may consume more than one)
1181 1.133 dholland */
1182 1.138 dholland
1183 1.185 dholland /* There should be no slashes here. */
1184 1.185 dholland KASSERT(cnp->cn_nameptr[0] != '/');
1185 1.138 dholland
1186 1.185 dholland /* and we shouldn't have looped around if we were done */
1187 1.185 dholland KASSERT(cnp->cn_nameptr[0] != '\0');
1188 1.139 dholland
1189 1.139 dholland error = lookup_parsepath(state);
1190 1.139 dholland if (error) {
1191 1.145 dholland vput(searchdir);
1192 1.168 dholland ndp->ni_dvp = NULL;
1193 1.139 dholland ndp->ni_vp = NULL;
1194 1.137 dholland state->attempt_retry = 1;
1195 1.131 dholland return (error);
1196 1.131 dholland }
1197 1.138 dholland
1198 1.150 dholland error = lookup_once(state, searchdir, &searchdir, &foundobj);
1199 1.139 dholland if (error) {
1200 1.156 dholland vput(searchdir);
1201 1.168 dholland ndp->ni_dvp = NULL;
1202 1.139 dholland ndp->ni_vp = NULL;
1203 1.138 dholland /*
1204 1.139 dholland * Note that if we're doing TRYEMULROOT we can
1205 1.139 dholland * retry with the normal root. Where this is
1206 1.139 dholland * currently set matches previous practice,
1207 1.139 dholland * but the previous practice didn't make much
1208 1.139 dholland * sense and somebody should sit down and
1209 1.139 dholland * figure out which cases should cause retry
1210 1.139 dholland * and which shouldn't. XXX.
1211 1.138 dholland */
1212 1.139 dholland state->attempt_retry = 1;
1213 1.139 dholland return (error);
1214 1.139 dholland }
1215 1.157 dholland
1216 1.162 dholland if (foundobj == NULL) {
1217 1.162 dholland /*
1218 1.162 dholland * Success with no object returned means we're
1219 1.162 dholland * creating something and it isn't already
1220 1.181 dholland * there. Break out of the main loop now so
1221 1.162 dholland * the code below doesn't have to test for
1222 1.162 dholland * foundobj == NULL.
1223 1.162 dholland */
1224 1.181 dholland break;
1225 1.138 dholland }
1226 1.131 dholland
1227 1.131 dholland /*
1228 1.139 dholland * Check for symbolic link. If we've reached one,
1229 1.139 dholland * follow it, unless we aren't supposed to. Back up
1230 1.139 dholland * over any slashes that we skipped, as we will need
1231 1.139 dholland * them again.
1232 1.131 dholland */
1233 1.146 dholland if (namei_atsymlink(state, foundobj)) {
1234 1.139 dholland ndp->ni_pathlen += state->slashes;
1235 1.139 dholland ndp->ni_next -= state->slashes;
1236 1.134 dholland if (neverfollow) {
1237 1.134 dholland error = EINVAL;
1238 1.134 dholland } else {
1239 1.152 dholland /*
1240 1.152 dholland * dholland 20110410: if we're at a
1241 1.152 dholland * union mount it might make sense to
1242 1.152 dholland * use the top of the union stack here
1243 1.152 dholland * rather than the layer we found the
1244 1.152 dholland * symlink in. (FUTURE)
1245 1.152 dholland */
1246 1.141 dholland error = namei_follow(state, inhibitmagic,
1247 1.165 dholland searchdir, foundobj,
1248 1.152 dholland &searchdir);
1249 1.134 dholland }
1250 1.131 dholland if (error) {
1251 1.165 dholland KASSERT(searchdir != foundobj);
1252 1.157 dholland vput(searchdir);
1253 1.165 dholland vput(foundobj);
1254 1.168 dholland ndp->ni_dvp = NULL;
1255 1.131 dholland ndp->ni_vp = NULL;
1256 1.131 dholland return error;
1257 1.131 dholland }
1258 1.174 jakllsch /* namei_follow unlocks it (ugh) so rele, not put */
1259 1.174 jakllsch vrele(foundobj);
1260 1.167 dholland foundobj = NULL;
1261 1.189 riastrad
1262 1.189 riastrad /*
1263 1.189 riastrad * If we followed a symlink to `/' and there
1264 1.189 riastrad * are no more components after the symlink,
1265 1.189 riastrad * we're done with the loop and what we found
1266 1.189 riastrad * is the searchdir.
1267 1.189 riastrad */
1268 1.189 riastrad if (cnp->cn_nameptr[0] == '\0') {
1269 1.189 riastrad foundobj = searchdir;
1270 1.189 riastrad searchdir = NULL;
1271 1.189 riastrad cnp->cn_flags |= ISLASTCN;
1272 1.189 riastrad break;
1273 1.189 riastrad }
1274 1.189 riastrad
1275 1.139 dholland continue;
1276 1.139 dholland }
1277 1.139 dholland
1278 1.139 dholland /*
1279 1.183 dholland * Not a symbolic link.
1280 1.183 dholland *
1281 1.139 dholland * Check for directory, if the component was
1282 1.139 dholland * followed by a series of slashes.
1283 1.139 dholland */
1284 1.190 yamt if ((foundobj->v_type != VDIR) &&
1285 1.190 yamt (cnp->cn_flags & REQUIREDIR)) {
1286 1.190 yamt if (searchdir == foundobj) {
1287 1.190 yamt vrele(searchdir);
1288 1.190 yamt } else {
1289 1.157 dholland vput(searchdir);
1290 1.139 dholland }
1291 1.168 dholland vput(foundobj);
1292 1.168 dholland ndp->ni_dvp = NULL;
1293 1.168 dholland ndp->ni_vp = NULL;
1294 1.139 dholland state->attempt_retry = 1;
1295 1.139 dholland return ENOTDIR;
1296 1.139 dholland }
1297 1.139 dholland
1298 1.139 dholland /*
1299 1.183 dholland * Stop if we've reached the last component.
1300 1.139 dholland */
1301 1.183 dholland if (cnp->cn_flags & ISLASTCN) {
1302 1.183 dholland break;
1303 1.139 dholland }
1304 1.139 dholland
1305 1.183 dholland /*
1306 1.183 dholland * Continue with the next component.
1307 1.183 dholland */
1308 1.183 dholland cnp->cn_nameptr = ndp->ni_next;
1309 1.183 dholland if (searchdir == foundobj) {
1310 1.183 dholland vrele(searchdir);
1311 1.183 dholland } else {
1312 1.183 dholland vput(searchdir);
1313 1.183 dholland }
1314 1.183 dholland searchdir = foundobj;
1315 1.183 dholland foundobj = NULL;
1316 1.179 dholland }
1317 1.179 dholland
1318 1.185 dholland skiploop:
1319 1.185 dholland
1320 1.182 dholland if (foundobj != NULL) {
1321 1.146 dholland if (foundobj == ndp->ni_erootdir) {
1322 1.139 dholland /*
1323 1.139 dholland * We are about to return the emulation root.
1324 1.139 dholland * This isn't a good idea because code might
1325 1.139 dholland * repeatedly lookup ".." until the file
1326 1.139 dholland * matches that returned for "/" and loop
1327 1.139 dholland * forever. So convert it to the real root.
1328 1.139 dholland */
1329 1.170 dholland if (searchdir != NULL) {
1330 1.170 dholland if (searchdir == foundobj)
1331 1.170 dholland vrele(searchdir);
1332 1.170 dholland else
1333 1.157 dholland vput(searchdir);
1334 1.170 dholland searchdir = NULL;
1335 1.170 dholland }
1336 1.146 dholland vput(foundobj);
1337 1.146 dholland foundobj = ndp->ni_rootdir;
1338 1.146 dholland vref(foundobj);
1339 1.146 dholland vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
1340 1.131 dholland }
1341 1.139 dholland
1342 1.139 dholland /*
1343 1.158 dholland * If the caller requested the parent node (i.e. it's
1344 1.158 dholland * a CREATE, DELETE, or RENAME), and we don't have one
1345 1.158 dholland * (because this is the root directory, or we crossed
1346 1.158 dholland * a mount point), then we must fail.
1347 1.139 dholland */
1348 1.158 dholland if (cnp->cn_nameiop != LOOKUP &&
1349 1.158 dholland (searchdir == NULL ||
1350 1.158 dholland searchdir->v_mount != foundobj->v_mount)) {
1351 1.170 dholland if (searchdir) {
1352 1.170 dholland vput(searchdir);
1353 1.170 dholland }
1354 1.170 dholland vput(foundobj);
1355 1.170 dholland foundobj = NULL;
1356 1.170 dholland ndp->ni_dvp = NULL;
1357 1.170 dholland ndp->ni_vp = NULL;
1358 1.170 dholland state->attempt_retry = 1;
1359 1.170 dholland
1360 1.139 dholland switch (cnp->cn_nameiop) {
1361 1.139 dholland case CREATE:
1362 1.171 dholland return EEXIST;
1363 1.139 dholland case DELETE:
1364 1.139 dholland case RENAME:
1365 1.171 dholland return EBUSY;
1366 1.171 dholland default:
1367 1.139 dholland break;
1368 1.139 dholland }
1369 1.171 dholland panic("Invalid nameiop\n");
1370 1.139 dholland }
1371 1.139 dholland
1372 1.139 dholland /*
1373 1.139 dholland * Disallow directory write attempts on read-only lookups.
1374 1.139 dholland * Prefers EEXIST over EROFS for the CREATE case.
1375 1.139 dholland */
1376 1.139 dholland if (state->rdonly &&
1377 1.139 dholland (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
1378 1.157 dholland if (searchdir) {
1379 1.170 dholland if (foundobj != searchdir) {
1380 1.170 dholland vput(searchdir);
1381 1.170 dholland } else {
1382 1.170 dholland vrele(searchdir);
1383 1.170 dholland }
1384 1.170 dholland searchdir = NULL;
1385 1.157 dholland }
1386 1.170 dholland vput(foundobj);
1387 1.170 dholland foundobj = NULL;
1388 1.168 dholland ndp->ni_dvp = NULL;
1389 1.139 dholland ndp->ni_vp = NULL;
1390 1.139 dholland state->attempt_retry = 1;
1391 1.171 dholland return EROFS;
1392 1.139 dholland }
1393 1.139 dholland if ((cnp->cn_flags & LOCKLEAF) == 0) {
1394 1.172 dholland /*
1395 1.172 dholland * Note: if LOCKPARENT but not LOCKLEAF is
1396 1.172 dholland * set, and searchdir == foundobj, this code
1397 1.172 dholland * necessarily unlocks the parent as well as
1398 1.172 dholland * the leaf. That is, just because you specify
1399 1.172 dholland * LOCKPARENT doesn't mean you necessarily get
1400 1.172 dholland * a locked parent vnode. The code in
1401 1.172 dholland * vfs_syscalls.c, and possibly elsewhere,
1402 1.172 dholland * that uses this combination "knows" this, so
1403 1.172 dholland * it can't be safely changed. Feh. XXX
1404 1.172 dholland */
1405 1.146 dholland VOP_UNLOCK(foundobj);
1406 1.131 dholland }
1407 1.179 dholland }
1408 1.139 dholland
1409 1.131 dholland /*
1410 1.133 dholland * Done.
1411 1.131 dholland */
1412 1.131 dholland
1413 1.133 dholland /*
1414 1.133 dholland * If LOCKPARENT is not set, the parent directory isn't returned.
1415 1.133 dholland */
1416 1.157 dholland if ((cnp->cn_flags & LOCKPARENT) == 0 && searchdir != NULL) {
1417 1.165 dholland if (searchdir == foundobj) {
1418 1.157 dholland vrele(searchdir);
1419 1.131 dholland } else {
1420 1.157 dholland vput(searchdir);
1421 1.131 dholland }
1422 1.157 dholland searchdir = NULL;
1423 1.131 dholland }
1424 1.131 dholland
1425 1.157 dholland ndp->ni_dvp = searchdir;
1426 1.165 dholland ndp->ni_vp = foundobj;
1427 1.137 dholland return 0;
1428 1.137 dholland }
1429 1.137 dholland
1430 1.173 dholland /*
1431 1.173 dholland * Do namei; wrapper layer that handles TRYEMULROOT.
1432 1.173 dholland */
1433 1.137 dholland static int
1434 1.196 dholland namei_tryemulroot(struct namei_state *state,
1435 1.193 dholland int neverfollow, int inhibitmagic, int isnfsd)
1436 1.137 dholland {
1437 1.137 dholland int error;
1438 1.137 dholland
1439 1.137 dholland struct nameidata *ndp = state->ndp;
1440 1.137 dholland struct componentname *cnp = state->cnp;
1441 1.137 dholland const char *savepath = NULL;
1442 1.137 dholland
1443 1.137 dholland KASSERT(cnp == &ndp->ni_cnd);
1444 1.137 dholland
1445 1.137 dholland if (cnp->cn_flags & TRYEMULROOT) {
1446 1.137 dholland savepath = pathbuf_stringcopy_get(ndp->ni_pathbuf);
1447 1.137 dholland }
1448 1.137 dholland
1449 1.137 dholland emul_retry:
1450 1.137 dholland state->attempt_retry = 0;
1451 1.137 dholland
1452 1.196 dholland error = namei_oneroot(state, neverfollow, inhibitmagic, isnfsd);
1453 1.137 dholland if (error) {
1454 1.137 dholland /*
1455 1.137 dholland * Once namei has started up, the existence of ni_erootdir
1456 1.137 dholland * tells us whether we're working from an emulation root.
1457 1.137 dholland * The TRYEMULROOT flag isn't necessarily authoritative.
1458 1.137 dholland */
1459 1.137 dholland if (ndp->ni_erootdir != NULL && state->attempt_retry) {
1460 1.137 dholland /* Retry the whole thing using the normal root */
1461 1.137 dholland cnp->cn_flags &= ~TRYEMULROOT;
1462 1.137 dholland state->attempt_retry = 0;
1463 1.137 dholland
1464 1.137 dholland /* kinda gross */
1465 1.137 dholland strcpy(ndp->ni_pathbuf->pb_path, savepath);
1466 1.137 dholland pathbuf_stringcopy_put(ndp->ni_pathbuf, savepath);
1467 1.137 dholland savepath = NULL;
1468 1.137 dholland
1469 1.137 dholland goto emul_retry;
1470 1.137 dholland }
1471 1.137 dholland }
1472 1.131 dholland if (savepath != NULL) {
1473 1.131 dholland pathbuf_stringcopy_put(ndp->ni_pathbuf, savepath);
1474 1.131 dholland }
1475 1.137 dholland return error;
1476 1.131 dholland }
1477 1.131 dholland
1478 1.173 dholland /*
1479 1.173 dholland * External interface.
1480 1.173 dholland */
1481 1.131 dholland int
1482 1.131 dholland namei(struct nameidata *ndp)
1483 1.131 dholland {
1484 1.131 dholland struct namei_state state;
1485 1.131 dholland int error;
1486 1.131 dholland
1487 1.131 dholland namei_init(&state, ndp);
1488 1.196 dholland error = namei_tryemulroot(&state,
1489 1.193 dholland 0/*!neverfollow*/, 0/*!inhibitmagic*/,
1490 1.193 dholland 0/*isnfsd*/);
1491 1.131 dholland namei_cleanup(&state);
1492 1.131 dholland
1493 1.159 dholland if (error) {
1494 1.159 dholland /* make sure no stray refs leak out */
1495 1.164 dholland KASSERT(ndp->ni_dvp == NULL);
1496 1.164 dholland KASSERT(ndp->ni_vp == NULL);
1497 1.159 dholland }
1498 1.159 dholland
1499 1.131 dholland return error;
1500 1.131 dholland }
1501 1.131 dholland
1502 1.131 dholland ////////////////////////////////////////////////////////////
1503 1.131 dholland
1504 1.12 mycroft /*
1505 1.173 dholland * External interface used by nfsd. This is basically different from
1506 1.173 dholland * namei only in that it has the ability to pass in the "current
1507 1.173 dholland * directory", and uses an extra flag "neverfollow" for which there's
1508 1.173 dholland * no physical flag defined in namei.h. (There used to be a cut&paste
1509 1.173 dholland * copy of about half of namei in nfsd to allow these minor
1510 1.173 dholland * adjustments to exist.)
1511 1.119 dholland *
1512 1.173 dholland * XXX: the namei interface should be adjusted so nfsd can just use
1513 1.173 dholland * ordinary namei().
1514 1.118 dholland */
1515 1.134 dholland int
1516 1.135 dholland lookup_for_nfsd(struct nameidata *ndp, struct vnode *forcecwd, int neverfollow)
1517 1.134 dholland {
1518 1.134 dholland struct namei_state state;
1519 1.134 dholland int error;
1520 1.120 dholland
1521 1.196 dholland KASSERT(ndp->ni_startdir == NULL);
1522 1.196 dholland ndp->ni_startdir = forcecwd;
1523 1.194 dholland
1524 1.134 dholland namei_init(&state, ndp);
1525 1.196 dholland error = namei_tryemulroot(&state,
1526 1.193 dholland neverfollow, 1/*inhibitmagic*/, 1/*isnfsd*/);
1527 1.119 dholland namei_cleanup(&state);
1528 1.119 dholland
1529 1.159 dholland if (error) {
1530 1.159 dholland /* make sure no stray refs leak out */
1531 1.164 dholland KASSERT(ndp->ni_dvp == NULL);
1532 1.164 dholland KASSERT(ndp->ni_vp == NULL);
1533 1.159 dholland }
1534 1.159 dholland
1535 1.119 dholland return error;
1536 1.119 dholland }
1537 1.119 dholland
1538 1.173 dholland /*
1539 1.173 dholland * A second external interface used by nfsd. This turns out to be a
1540 1.173 dholland * single lookup used by the WebNFS code (ha!) to get "index.html" or
1541 1.173 dholland * equivalent when asked for a directory. It should eventually evolve
1542 1.173 dholland * into some kind of namei_once() call; for the time being it's kind
1543 1.173 dholland * of a mess. XXX.
1544 1.173 dholland *
1545 1.173 dholland * dholland 20110109: I don't think it works, and I don't think it
1546 1.173 dholland * worked before I started hacking and slashing either, and I doubt
1547 1.173 dholland * anyone will ever notice.
1548 1.173 dholland */
1549 1.173 dholland
1550 1.173 dholland /*
1551 1.173 dholland * Internals. This calls lookup_once() after setting up the assorted
1552 1.173 dholland * pieces of state the way they ought to be.
1553 1.173 dholland */
1554 1.136 dholland static int
1555 1.196 dholland do_lookup_for_nfsd_index(struct namei_state *state)
1556 1.136 dholland {
1557 1.136 dholland int error = 0;
1558 1.136 dholland
1559 1.136 dholland struct componentname *cnp = state->cnp;
1560 1.136 dholland struct nameidata *ndp = state->ndp;
1561 1.196 dholland struct vnode *startdir;
1562 1.147 dholland struct vnode *foundobj;
1563 1.136 dholland const char *cp; /* pointer into pathname argument */
1564 1.136 dholland
1565 1.136 dholland KASSERT(cnp == &ndp->ni_cnd);
1566 1.136 dholland
1567 1.196 dholland startdir = state->ndp->ni_startdir;
1568 1.196 dholland
1569 1.136 dholland cnp->cn_nameptr = ndp->ni_pnbuf;
1570 1.136 dholland state->docache = 1;
1571 1.136 dholland state->rdonly = cnp->cn_flags & RDONLY;
1572 1.136 dholland ndp->ni_dvp = NULL;
1573 1.136 dholland
1574 1.136 dholland cnp->cn_consume = 0;
1575 1.197 dholland cnp->cn_namelen = namei_getcomponent(cnp->cn_nameptr);
1576 1.197 dholland cp = cnp->cn_nameptr + cnp->cn_namelen;
1577 1.191 christos KASSERT(cnp->cn_namelen <= KERNEL_NAME_MAX);
1578 1.136 dholland ndp->ni_pathlen -= cnp->cn_namelen;
1579 1.136 dholland ndp->ni_next = cp;
1580 1.136 dholland state->slashes = 0;
1581 1.136 dholland cnp->cn_flags &= ~REQUIREDIR;
1582 1.136 dholland cnp->cn_flags |= MAKEENTRY|ISLASTCN;
1583 1.136 dholland
1584 1.136 dholland if (cnp->cn_namelen == 2 &&
1585 1.136 dholland cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
1586 1.136 dholland cnp->cn_flags |= ISDOTDOT;
1587 1.136 dholland else
1588 1.136 dholland cnp->cn_flags &= ~ISDOTDOT;
1589 1.136 dholland
1590 1.160 dholland /*
1591 1.160 dholland * Because lookup_once can change the startdir, we need our
1592 1.160 dholland * own reference to it to avoid consuming the caller's.
1593 1.160 dholland */
1594 1.160 dholland vref(startdir);
1595 1.160 dholland vn_lock(startdir, LK_EXCLUSIVE | LK_RETRY);
1596 1.160 dholland error = lookup_once(state, startdir, &startdir, &foundobj);
1597 1.190 yamt if (error == 0 && startdir == foundobj) {
1598 1.190 yamt vrele(startdir);
1599 1.190 yamt } else {
1600 1.190 yamt vput(startdir);
1601 1.190 yamt }
1602 1.136 dholland if (error) {
1603 1.136 dholland goto bad;
1604 1.136 dholland }
1605 1.149 dholland ndp->ni_vp = foundobj;
1606 1.162 dholland
1607 1.162 dholland if (foundobj == NULL) {
1608 1.136 dholland return 0;
1609 1.136 dholland }
1610 1.136 dholland
1611 1.160 dholland KASSERT((cnp->cn_flags & LOCKPARENT) == 0);
1612 1.136 dholland if ((cnp->cn_flags & LOCKLEAF) == 0) {
1613 1.147 dholland VOP_UNLOCK(foundobj);
1614 1.136 dholland }
1615 1.136 dholland return (0);
1616 1.136 dholland
1617 1.136 dholland bad:
1618 1.136 dholland ndp->ni_vp = NULL;
1619 1.136 dholland return (error);
1620 1.136 dholland }
1621 1.136 dholland
1622 1.173 dholland /*
1623 1.173 dholland * External interface. The partitioning between this function and the
1624 1.173 dholland * above isn't very clear - the above function exists mostly so code
1625 1.173 dholland * that uses "state->" can be shuffled around without having to change
1626 1.173 dholland * it to "state.".
1627 1.173 dholland */
1628 1.118 dholland int
1629 1.128 dholland lookup_for_nfsd_index(struct nameidata *ndp, struct vnode *startdir)
1630 1.118 dholland {
1631 1.118 dholland struct namei_state state;
1632 1.118 dholland int error;
1633 1.118 dholland
1634 1.196 dholland KASSERT(ndp->ni_startdir == NULL);
1635 1.196 dholland ndp->ni_startdir = startdir;
1636 1.194 dholland
1637 1.133 dholland /*
1638 1.135 dholland * Note: the name sent in here (is not|should not be) allowed
1639 1.135 dholland * to contain a slash.
1640 1.133 dholland */
1641 1.191 christos if (strlen(ndp->ni_pathbuf->pb_path) > KERNEL_NAME_MAX) {
1642 1.136 dholland return ENAMETOOLONG;
1643 1.136 dholland }
1644 1.136 dholland if (strchr(ndp->ni_pathbuf->pb_path, '/')) {
1645 1.136 dholland return EINVAL;
1646 1.136 dholland }
1647 1.133 dholland
1648 1.133 dholland ndp->ni_pathlen = strlen(ndp->ni_pathbuf->pb_path) + 1;
1649 1.133 dholland ndp->ni_pnbuf = NULL;
1650 1.133 dholland ndp->ni_cnd.cn_nameptr = NULL;
1651 1.133 dholland
1652 1.118 dholland namei_init(&state, ndp);
1653 1.196 dholland error = do_lookup_for_nfsd_index(&state);
1654 1.118 dholland namei_cleanup(&state);
1655 1.118 dholland
1656 1.118 dholland return error;
1657 1.118 dholland }
1658 1.118 dholland
1659 1.131 dholland ////////////////////////////////////////////////////////////
1660 1.131 dholland
1661 1.118 dholland /*
1662 1.12 mycroft * Reacquire a path name component.
1663 1.73 chs * dvp is locked on entry and exit.
1664 1.73 chs * *vpp is locked on exit unless it's NULL.
1665 1.12 mycroft */
1666 1.12 mycroft int
1667 1.130 dholland relookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp, int dummy)
1668 1.12 mycroft {
1669 1.12 mycroft int rdonly; /* lookup read-only flag bit */
1670 1.12 mycroft int error = 0;
1671 1.52 yamt #ifdef DEBUG
1672 1.197 dholland size_t newlen; /* DEBUG: check name len */
1673 1.197 dholland const char *cp; /* DEBUG: check name ptr */
1674 1.52 yamt #endif /* DEBUG */
1675 1.12 mycroft
1676 1.130 dholland (void)dummy;
1677 1.130 dholland
1678 1.12 mycroft /*
1679 1.12 mycroft * Setup: break out flag bits into variables.
1680 1.12 mycroft */
1681 1.12 mycroft rdonly = cnp->cn_flags & RDONLY;
1682 1.12 mycroft
1683 1.12 mycroft /*
1684 1.12 mycroft * Search a new directory.
1685 1.12 mycroft *
1686 1.12 mycroft * The cn_hash value is for use by vfs_cache.
1687 1.12 mycroft * The last component of the filename is left accessible via
1688 1.12 mycroft * cnp->cn_nameptr for callers that need the name. Callers needing
1689 1.12 mycroft * the name set the SAVENAME flag. When done, they assume
1690 1.12 mycroft * responsibility for freeing the pathname buffer.
1691 1.12 mycroft */
1692 1.52 yamt #ifdef DEBUG
1693 1.197 dholland #if 0
1694 1.39 lukem cp = NULL;
1695 1.39 lukem newhash = namei_hash(cnp->cn_nameptr, &cp);
1696 1.81 chs if ((uint32_t)newhash != (uint32_t)cnp->cn_hash)
1697 1.12 mycroft panic("relookup: bad hash");
1698 1.197 dholland #endif
1699 1.197 dholland newlen = nami_getcomponent(cnp->cn_nameptr);
1700 1.197 dholland if (cnp->cn_namelen != newlen)
1701 1.58 christos panic("relookup: bad len");
1702 1.197 dholland cp = cnp->cn_nameptr + cnp->cn_namelen;
1703 1.53 yamt while (*cp == '/')
1704 1.53 yamt cp++;
1705 1.12 mycroft if (*cp != 0)
1706 1.12 mycroft panic("relookup: not last component");
1707 1.52 yamt #endif /* DEBUG */
1708 1.12 mycroft
1709 1.12 mycroft /*
1710 1.12 mycroft * Check for degenerate name (e.g. / or "")
1711 1.12 mycroft * which is a way of talking about a directory,
1712 1.12 mycroft * e.g. like "/." or ".".
1713 1.12 mycroft */
1714 1.23 mycroft if (cnp->cn_nameptr[0] == '\0')
1715 1.23 mycroft panic("relookup: null name");
1716 1.12 mycroft
1717 1.12 mycroft if (cnp->cn_flags & ISDOTDOT)
1718 1.58 christos panic("relookup: lookup on dot-dot");
1719 1.12 mycroft
1720 1.12 mycroft /*
1721 1.12 mycroft * We now have a segment name to search for, and a directory to search.
1722 1.12 mycroft */
1723 1.195 dholland *vpp = NULL;
1724 1.129 dholland cnp->cn_flags |= INRELOOKUP;
1725 1.129 dholland error = VOP_LOOKUP(dvp, vpp, cnp);
1726 1.129 dholland cnp->cn_flags &= ~INRELOOKUP;
1727 1.129 dholland if ((error) != 0) {
1728 1.12 mycroft #ifdef DIAGNOSTIC
1729 1.12 mycroft if (*vpp != NULL)
1730 1.43 christos panic("leaf `%s' should be empty", cnp->cn_nameptr);
1731 1.12 mycroft #endif
1732 1.12 mycroft if (error != EJUSTRETURN)
1733 1.12 mycroft goto bad;
1734 1.12 mycroft }
1735 1.12 mycroft
1736 1.12 mycroft #ifdef DIAGNOSTIC
1737 1.12 mycroft /*
1738 1.12 mycroft * Check for symbolic link
1739 1.12 mycroft */
1740 1.81 chs if (*vpp && (*vpp)->v_type == VLNK && (cnp->cn_flags & FOLLOW))
1741 1.58 christos panic("relookup: symlink found");
1742 1.12 mycroft #endif
1743 1.12 mycroft
1744 1.12 mycroft /*
1745 1.94 pooka * Check for read-only lookups.
1746 1.12 mycroft */
1747 1.81 chs if (rdonly && cnp->cn_nameiop != LOOKUP) {
1748 1.26 fvdl error = EROFS;
1749 1.81 chs if (*vpp) {
1750 1.81 chs vput(*vpp);
1751 1.81 chs }
1752 1.73 chs goto bad;
1753 1.12 mycroft }
1754 1.12 mycroft return (0);
1755 1.12 mycroft
1756 1.12 mycroft bad:
1757 1.12 mycroft *vpp = NULL;
1758 1.10 cgd return (error);
1759 1.10 cgd }
1760 1.116 dholland
1761 1.116 dholland /*
1762 1.116 dholland * namei_simple - simple forms of namei.
1763 1.116 dholland *
1764 1.116 dholland * These are wrappers to allow the simple case callers of namei to be
1765 1.116 dholland * left alone while everything else changes under them.
1766 1.116 dholland */
1767 1.116 dholland
1768 1.116 dholland /* Flags */
1769 1.116 dholland struct namei_simple_flags_type {
1770 1.116 dholland int dummy;
1771 1.116 dholland };
1772 1.116 dholland static const struct namei_simple_flags_type ns_nn, ns_nt, ns_fn, ns_ft;
1773 1.116 dholland const namei_simple_flags_t NSM_NOFOLLOW_NOEMULROOT = &ns_nn;
1774 1.116 dholland const namei_simple_flags_t NSM_NOFOLLOW_TRYEMULROOT = &ns_nt;
1775 1.116 dholland const namei_simple_flags_t NSM_FOLLOW_NOEMULROOT = &ns_fn;
1776 1.116 dholland const namei_simple_flags_t NSM_FOLLOW_TRYEMULROOT = &ns_ft;
1777 1.116 dholland
1778 1.116 dholland static
1779 1.116 dholland int
1780 1.116 dholland namei_simple_convert_flags(namei_simple_flags_t sflags)
1781 1.116 dholland {
1782 1.116 dholland if (sflags == NSM_NOFOLLOW_NOEMULROOT)
1783 1.116 dholland return NOFOLLOW | 0;
1784 1.116 dholland if (sflags == NSM_NOFOLLOW_TRYEMULROOT)
1785 1.116 dholland return NOFOLLOW | TRYEMULROOT;
1786 1.116 dholland if (sflags == NSM_FOLLOW_NOEMULROOT)
1787 1.116 dholland return FOLLOW | 0;
1788 1.116 dholland if (sflags == NSM_FOLLOW_TRYEMULROOT)
1789 1.116 dholland return FOLLOW | TRYEMULROOT;
1790 1.116 dholland panic("namei_simple_convert_flags: bogus sflags\n");
1791 1.116 dholland return 0;
1792 1.116 dholland }
1793 1.116 dholland
1794 1.116 dholland int
1795 1.116 dholland namei_simple_kernel(const char *path, namei_simple_flags_t sflags,
1796 1.116 dholland struct vnode **vp_ret)
1797 1.116 dholland {
1798 1.116 dholland struct nameidata nd;
1799 1.123 dholland struct pathbuf *pb;
1800 1.116 dholland int err;
1801 1.116 dholland
1802 1.123 dholland pb = pathbuf_create(path);
1803 1.123 dholland if (pb == NULL) {
1804 1.123 dholland return ENOMEM;
1805 1.123 dholland }
1806 1.123 dholland
1807 1.116 dholland NDINIT(&nd,
1808 1.116 dholland LOOKUP,
1809 1.116 dholland namei_simple_convert_flags(sflags),
1810 1.123 dholland pb);
1811 1.116 dholland err = namei(&nd);
1812 1.116 dholland if (err != 0) {
1813 1.123 dholland pathbuf_destroy(pb);
1814 1.116 dholland return err;
1815 1.116 dholland }
1816 1.116 dholland *vp_ret = nd.ni_vp;
1817 1.123 dholland pathbuf_destroy(pb);
1818 1.116 dholland return 0;
1819 1.116 dholland }
1820 1.116 dholland
1821 1.116 dholland int
1822 1.116 dholland namei_simple_user(const char *path, namei_simple_flags_t sflags,
1823 1.116 dholland struct vnode **vp_ret)
1824 1.116 dholland {
1825 1.123 dholland struct pathbuf *pb;
1826 1.116 dholland struct nameidata nd;
1827 1.116 dholland int err;
1828 1.116 dholland
1829 1.123 dholland err = pathbuf_copyin(path, &pb);
1830 1.123 dholland if (err) {
1831 1.123 dholland return err;
1832 1.123 dholland }
1833 1.123 dholland
1834 1.116 dholland NDINIT(&nd,
1835 1.116 dholland LOOKUP,
1836 1.116 dholland namei_simple_convert_flags(sflags),
1837 1.123 dholland pb);
1838 1.116 dholland err = namei(&nd);
1839 1.116 dholland if (err != 0) {
1840 1.123 dholland pathbuf_destroy(pb);
1841 1.116 dholland return err;
1842 1.116 dholland }
1843 1.116 dholland *vp_ret = nd.ni_vp;
1844 1.123 dholland pathbuf_destroy(pb);
1845 1.116 dholland return 0;
1846 1.116 dholland }
1847