xref: /dragonfly/lib/libc/gen/fts.c (revision cfd1aba3)
1 /*-
2  * Copyright (c) 1990, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * @(#)fts.c	8.6 (Berkeley) 8/14/94
30  * $OpenBSD: fts.c,v 1.22 1999/10/03 19:22:22 millert Exp $
31  * $FreeBSD: src/lib/libc/gen/fts.c,v 1.30 2009/03/04 03:30:21 das Exp $
32  */
33 
34 #include "namespace.h"
35 #include <sys/param.h>
36 #include <sys/mount.h>
37 #include <sys/stat.h>
38 
39 #include <dirent.h>
40 #include <errno.h>
41 #include <fcntl.h>
42 #include <fts.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <unistd.h>
46 #include "un-namespace.h"
47 
48 static FTSENT	*fts_alloc(FTS *, const char *, size_t);
49 static FTSENT	*fts_build(FTS *, int);
50 static void	 fts_lfree(FTSENT *);
51 static void	 fts_load(FTS *, FTSENT *);
52 static size_t	 fts_maxarglen(char * const *);
53 static void	 fts_padjust(FTS *, FTSENT *);
54 static int	 fts_palloc(FTS *, size_t);
55 static FTSENT	*fts_sort(FTS *, FTSENT *, size_t);
56 static int	 fts_stat(FTS *, FTSENT *, int);
57 static int	 fts_safe_changedir(FTS *, FTSENT *, int, const char *);
58 static int	 fts_ufslinks(FTS *, const FTSENT *);
59 
60 #define	ISDOT(a)	(a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
61 
62 #define	CLR(opt)	(sp->fts_options &= ~(opt))
63 #define	ISSET(opt)	(sp->fts_options & (opt))
64 #define	SET(opt)	(sp->fts_options |= (opt))
65 
66 #define	FCHDIR(sp, fd)	(!ISSET(FTS_NOCHDIR) && fchdir(fd))
67 
68 /* fts_build flags */
69 #define	BCHILD		1		/* fts_children */
70 #define	BNAMES		2		/* fts_children, names only */
71 #define	BREAD		3		/* fts_read */
72 
73 /*
74  * Internal representation of an FTS, including extra implementation
75  * details.  The FTS returned from fts_open points to this structure's
76  * ftsp_fts member (and can be cast to an _fts_private as required)
77  */
78 struct _fts_private {
79 	FTS		ftsp_fts;
80 	struct statfs	ftsp_statfs;
81 	dev_t		ftsp_dev;
82 	int		ftsp_linksreliable;
83 };
84 
85 /*
86  * The "FTS_NOSTAT" option can avoid a lot of calls to stat(2) if it
87  * knows that a directory could not possibly have subdirectories.  This
88  * is decided by looking at the link count: a subdirectory would
89  * increment its parent's link count by virtue of its own ".." entry.
90  * This assumption only holds for UFS-like filesystems that implement
91  * links and directories this way, so we must punt for others.
92  */
93 
94 static const char *ufslike_filesystems[] = {
95 	"ufs",
96 	"nfs",
97 	"nfs4",
98 	"ext2fs",
99 	0
100 };
101 
102 FTS *
103 fts_open(char * const *argv, int options,
104 	 int (*compar)(const FTSENT * const *, const FTSENT * const *))
105 {
106 	struct _fts_private *priv;
107 	FTS *sp;
108 	FTSENT *p, *root;
109 	FTSENT *parent, *tmp;
110 	size_t len, nitems;
111 
112 	/* Options check. */
113 	if (options & ~FTS_OPTIONMASK) {
114 		errno = EINVAL;
115 		return (NULL);
116 	}
117 
118 	/* Allocate/initialize the stream. */
119 	if ((priv = calloc(1, sizeof(*priv))) == NULL)
120 		return (NULL);
121 	sp = &priv->ftsp_fts;
122 	sp->fts_compar = compar;
123 	sp->fts_options = options;
124 
125 	/* Shush, GCC. */
126 	tmp = NULL;
127 
128 	/* Logical walks turn on NOCHDIR; symbolic links are too hard. */
129 	if (ISSET(FTS_LOGICAL))
130 		SET(FTS_NOCHDIR);
131 
132 	/*
133 	 * Start out with 1K of path space, and enough, in any case,
134 	 * to hold the user's paths.
135 	 */
136 	if (fts_palloc(sp, MAX(fts_maxarglen(argv), MAXPATHLEN)))
137 		goto mem1;
138 
139 	/* Allocate/initialize root's parent. */
140 	if ((parent = fts_alloc(sp, "", 0)) == NULL)
141 		goto mem2;
142 	parent->fts_level = FTS_ROOTPARENTLEVEL;
143 
144 	/* Allocate/initialize root(s). */
145 	for (root = NULL, nitems = 0; *argv != NULL; ++argv, ++nitems) {
146 		/* Don't allow zero-length paths. */
147 		if ((len = strlen(*argv)) == 0) {
148 			errno = ENOENT;
149 			goto mem3;
150 		}
151 
152 		p = fts_alloc(sp, *argv, len);
153 		p->fts_level = FTS_ROOTLEVEL;
154 		p->fts_parent = parent;
155 		p->fts_accpath = p->fts_name;
156 		p->fts_info = fts_stat(sp, p, ISSET(FTS_COMFOLLOW));
157 
158 		/* Command-line "." and ".." are real directories. */
159 		if (p->fts_info == FTS_DOT)
160 			p->fts_info = FTS_D;
161 
162 		/*
163 		 * If comparison routine supplied, traverse in sorted
164 		 * order; otherwise traverse in the order specified.
165 		 */
166 		if (compar) {
167 			p->fts_link = root;
168 			root = p;
169 		} else {
170 			p->fts_link = NULL;
171 			if (root == NULL)
172 				tmp = root = p;
173 			else {
174 				tmp->fts_link = p;
175 				tmp = p;
176 			}
177 		}
178 	}
179 	if (compar && nitems > 1)
180 		root = fts_sort(sp, root, nitems);
181 
182 	/*
183 	 * Allocate a dummy pointer and make fts_read think that we've just
184 	 * finished the node before the root(s); set p->fts_info to FTS_INIT
185 	 * so that everything about the "current" node is ignored.
186 	 */
187 	if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
188 		goto mem3;
189 	sp->fts_cur->fts_link = root;
190 	sp->fts_cur->fts_info = FTS_INIT;
191 
192 	/*
193 	 * If using chdir(2), grab a file descriptor pointing to dot to ensure
194 	 * that we can get back here; this could be avoided for some paths,
195 	 * but almost certainly not worth the effort.  Slashes, symbolic links,
196 	 * and ".." are all fairly nasty problems.  Note, if we can't get the
197 	 * descriptor we run anyway, just more slowly.
198 	 */
199 	if (!ISSET(FTS_NOCHDIR) &&
200 	    (sp->fts_rfd = _open(".", O_RDONLY | O_CLOEXEC, 0)) < 0)
201 		SET(FTS_NOCHDIR);
202 
203 	return (sp);
204 
205 mem3:	fts_lfree(root);
206 	free(parent);
207 mem2:	free(sp->fts_path);
208 mem1:	free(sp);
209 	return (NULL);
210 }
211 
212 static void
213 fts_load(FTS *sp, FTSENT *p)
214 {
215 	size_t len;
216 	char *cp;
217 
218 	/*
219 	 * Load the stream structure for the next traversal.  Since we don't
220 	 * actually enter the directory until after the preorder visit, set
221 	 * the fts_accpath field specially so the chdir gets done to the right
222 	 * place and the user can access the first node.  From fts_open it's
223 	 * known that the path will fit.
224 	 */
225 	len = p->fts_pathlen = p->fts_namelen;
226 	memmove(sp->fts_path, p->fts_name, len + 1);
227 	if ((cp = strrchr(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
228 		len = strlen(++cp);
229 		memmove(p->fts_name, cp, len + 1);
230 		p->fts_namelen = len;
231 	}
232 	p->fts_accpath = p->fts_path = sp->fts_path;
233 	sp->fts_dev = p->fts_dev;
234 }
235 
236 int
237 fts_close(FTS *sp)
238 {
239 	FTSENT *freep, *p;
240 	int saved_errno;
241 
242 	/*
243 	 * This still works if we haven't read anything -- the dummy structure
244 	 * points to the root list, so we step through to the end of the root
245 	 * list which has a valid parent pointer.
246 	 */
247 	if (sp->fts_cur) {
248 		for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
249 			freep = p;
250 			p = p->fts_link != NULL ? p->fts_link : p->fts_parent;
251 			free(freep);
252 		}
253 		free(p);
254 	}
255 
256 	/* Free up child linked list, sort array, path buffer. */
257 	if (sp->fts_child)
258 		fts_lfree(sp->fts_child);
259 	if (sp->fts_array)
260 		free(sp->fts_array);
261 	free(sp->fts_path);
262 
263 	/* Return to original directory, save errno if necessary. */
264 	if (!ISSET(FTS_NOCHDIR)) {
265 		saved_errno = fchdir(sp->fts_rfd) ? errno : 0;
266 		_close(sp->fts_rfd);
267 
268 		/* Set errno and return. */
269 		if (saved_errno != 0) {
270 			/* Free up the stream pointer. */
271 			free(sp);
272 			errno = saved_errno;
273 			return (-1);
274 		}
275 	}
276 
277 	/* Free up the stream pointer. */
278 	free(sp);
279 	return (0);
280 }
281 
282 /*
283  * Special case of "/" at the end of the path so that slashes aren't
284  * appended which would cause paths to be written as "....//foo".
285  */
286 #define	NAPPEND(p)							\
287 	(p->fts_path[p->fts_pathlen - 1] == '/'				\
288 	    ? p->fts_pathlen - 1 : p->fts_pathlen)
289 
290 FTSENT *
291 fts_read(FTS *sp)
292 {
293 	FTSENT *p, *tmp;
294 	int instr;
295 	char *t;
296 	int saved_errno;
297 
298 	/* If finished or unrecoverable error, return NULL. */
299 	if (sp->fts_cur == NULL || ISSET(FTS_STOP))
300 		return (NULL);
301 
302 	/* Set current node pointer. */
303 	p = sp->fts_cur;
304 
305 	/* Save and zero out user instructions. */
306 	instr = p->fts_instr;
307 	p->fts_instr = FTS_NOINSTR;
308 
309 	/* Any type of file may be re-visited; re-stat and re-turn. */
310 	if (instr == FTS_AGAIN) {
311 		p->fts_info = fts_stat(sp, p, 0);
312 		return (p);
313 	}
314 
315 	/*
316 	 * Following a symlink -- SLNONE test allows application to see
317 	 * SLNONE and recover.  If indirecting through a symlink, have
318 	 * keep a pointer to current location.  If unable to get that
319 	 * pointer, follow fails.
320 	 */
321 	if (instr == FTS_FOLLOW &&
322 	    (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
323 		p->fts_info = fts_stat(sp, p, 1);
324 		if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
325 			if ((p->fts_symfd = _open(".", O_RDONLY | O_CLOEXEC,
326 			    0)) < 0) {
327 				p->fts_errno = errno;
328 				p->fts_info = FTS_ERR;
329 			} else
330 				p->fts_flags |= FTS_SYMFOLLOW;
331 		}
332 		return (p);
333 	}
334 
335 	/* Directory in pre-order. */
336 	if (p->fts_info == FTS_D) {
337 		/* If skipped or crossed mount point, do post-order visit. */
338 		if (instr == FTS_SKIP ||
339 		    (ISSET(FTS_XDEV) && p->fts_dev != sp->fts_dev)) {
340 			if (p->fts_flags & FTS_SYMFOLLOW)
341 				_close(p->fts_symfd);
342 			if (sp->fts_child) {
343 				fts_lfree(sp->fts_child);
344 				sp->fts_child = NULL;
345 			}
346 			p->fts_info = FTS_DP;
347 			return (p);
348 		}
349 
350 		/* Rebuild if only read the names and now traversing. */
351 		if (sp->fts_child != NULL && ISSET(FTS_NAMEONLY)) {
352 			CLR(FTS_NAMEONLY);
353 			fts_lfree(sp->fts_child);
354 			sp->fts_child = NULL;
355 		}
356 
357 		/*
358 		 * Cd to the subdirectory.
359 		 *
360 		 * If have already read and now fail to chdir, whack the list
361 		 * to make the names come out right, and set the parent errno
362 		 * so the application will eventually get an error condition.
363 		 * Set the FTS_DONTCHDIR flag so that when we logically change
364 		 * directories back to the parent we don't do a chdir.
365 		 *
366 		 * If haven't read do so.  If the read fails, fts_build sets
367 		 * FTS_STOP or the fts_info field of the node.
368 		 */
369 		if (sp->fts_child != NULL) {
370 			if (fts_safe_changedir(sp, p, -1, p->fts_accpath)) {
371 				p->fts_errno = errno;
372 				p->fts_flags |= FTS_DONTCHDIR;
373 				for (p = sp->fts_child; p != NULL;
374 				    p = p->fts_link)
375 					p->fts_accpath =
376 					    p->fts_parent->fts_accpath;
377 			}
378 		} else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
379 			if (ISSET(FTS_STOP))
380 				return (NULL);
381 			return (p);
382 		}
383 		p = sp->fts_child;
384 		sp->fts_child = NULL;
385 		goto name;
386 	}
387 
388 	/* Move to the next node on this level. */
389 next:	tmp = p;
390 	if ((p = p->fts_link) != NULL) {
391 		free(tmp);
392 
393 		/*
394 		 * If reached the top, return to the original directory (or
395 		 * the root of the tree), and load the paths for the next root.
396 		 */
397 		if (p->fts_level == FTS_ROOTLEVEL) {
398 			if (FCHDIR(sp, sp->fts_rfd)) {
399 				SET(FTS_STOP);
400 				return (NULL);
401 			}
402 			fts_load(sp, p);
403 			return (sp->fts_cur = p);
404 		}
405 
406 		/*
407 		 * User may have called fts_set on the node.  If skipped,
408 		 * ignore.  If followed, get a file descriptor so we can
409 		 * get back if necessary.
410 		 */
411 		if (p->fts_instr == FTS_SKIP)
412 			goto next;
413 		if (p->fts_instr == FTS_FOLLOW) {
414 			p->fts_info = fts_stat(sp, p, 1);
415 			if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
416 				if ((p->fts_symfd = _open(".", O_RDONLY | O_CLOEXEC,
417 				    0)) < 0) {
418 					p->fts_errno = errno;
419 					p->fts_info = FTS_ERR;
420 				} else
421 					p->fts_flags |= FTS_SYMFOLLOW;
422 			}
423 			p->fts_instr = FTS_NOINSTR;
424 		}
425 
426 name:		t = sp->fts_path + NAPPEND(p->fts_parent);
427 		*t++ = '/';
428 		memmove(t, p->fts_name, p->fts_namelen + 1);
429 		return (sp->fts_cur = p);
430 	}
431 
432 	/* Move up to the parent node. */
433 	p = tmp->fts_parent;
434 	free(tmp);
435 
436 	if (p->fts_level == FTS_ROOTPARENTLEVEL) {
437 		/*
438 		 * Done; free everything up and set errno to 0 so the user
439 		 * can distinguish between error and EOF.
440 		 */
441 		free(p);
442 		errno = 0;
443 		return (sp->fts_cur = NULL);
444 	}
445 
446 	/* NUL terminate the pathname. */
447 	sp->fts_path[p->fts_pathlen] = '\0';
448 
449 	/*
450 	 * Return to the parent directory.  If at a root node or came through
451 	 * a symlink, go back through the file descriptor.  Otherwise, cd up
452 	 * one directory.
453 	 */
454 	if (p->fts_level == FTS_ROOTLEVEL) {
455 		if (FCHDIR(sp, sp->fts_rfd)) {
456 			SET(FTS_STOP);
457 			return (NULL);
458 		}
459 	} else if (p->fts_flags & FTS_SYMFOLLOW) {
460 		if (FCHDIR(sp, p->fts_symfd)) {
461 			saved_errno = errno;
462 			_close(p->fts_symfd);
463 			errno = saved_errno;
464 			SET(FTS_STOP);
465 			return (NULL);
466 		}
467 		_close(p->fts_symfd);
468 	} else if (!(p->fts_flags & FTS_DONTCHDIR) &&
469 	    fts_safe_changedir(sp, p->fts_parent, -1, "..")) {
470 		SET(FTS_STOP);
471 		return (NULL);
472 	}
473 	p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
474 	return (sp->fts_cur = p);
475 }
476 
477 /*
478  * Fts_set takes the stream as an argument although it's not used in this
479  * implementation; it would be necessary if anyone wanted to add global
480  * semantics to fts using fts_set.  An error return is allowed for similar
481  * reasons.
482  */
483 /* ARGSUSED */
484 int
485 fts_set(FTS *sp __unused, FTSENT *p, int instr)
486 {
487 	if (instr != 0 && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
488 	    instr != FTS_NOINSTR && instr != FTS_SKIP) {
489 		errno = EINVAL;
490 		return (1);
491 	}
492 	p->fts_instr = instr;
493 	return (0);
494 }
495 
496 FTSENT *
497 fts_children(FTS *sp, int instr)
498 {
499 	FTSENT *p;
500 	int fd;
501 
502 	if (instr != 0 && instr != FTS_NAMEONLY) {
503 		errno = EINVAL;
504 		return (NULL);
505 	}
506 
507 	/* Set current node pointer. */
508 	p = sp->fts_cur;
509 
510 	/*
511 	 * Errno set to 0 so user can distinguish empty directory from
512 	 * an error.
513 	 */
514 	errno = 0;
515 
516 	/* Fatal errors stop here. */
517 	if (ISSET(FTS_STOP))
518 		return (NULL);
519 
520 	/* Return logical hierarchy of user's arguments. */
521 	if (p->fts_info == FTS_INIT)
522 		return (p->fts_link);
523 
524 	/*
525 	 * If not a directory being visited in pre-order, stop here.  Could
526 	 * allow FTS_DNR, assuming the user has fixed the problem, but the
527 	 * same effect is available with FTS_AGAIN.
528 	 */
529 	if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
530 		return (NULL);
531 
532 	/* Free up any previous child list. */
533 	if (sp->fts_child != NULL)
534 		fts_lfree(sp->fts_child);
535 
536 	if (instr == FTS_NAMEONLY) {
537 		SET(FTS_NAMEONLY);
538 		instr = BNAMES;
539 	} else
540 		instr = BCHILD;
541 
542 	/*
543 	 * If using chdir on a relative path and called BEFORE fts_read does
544 	 * its chdir to the root of a traversal, we can lose -- we need to
545 	 * chdir into the subdirectory, and we don't know where the current
546 	 * directory is, so we can't get back so that the upcoming chdir by
547 	 * fts_read will work.
548 	 */
549 	if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
550 	    ISSET(FTS_NOCHDIR))
551 		return (sp->fts_child = fts_build(sp, instr));
552 
553 	if ((fd = _open(".", O_RDONLY | O_CLOEXEC, 0)) < 0)
554 		return (NULL);
555 	sp->fts_child = fts_build(sp, instr);
556 	if (fchdir(fd)) {
557 		_close(fd);
558 		return (NULL);
559 	}
560 	_close(fd);
561 	return (sp->fts_child);
562 }
563 
564 #ifndef fts_get_clientptr
565 #error "fts_get_clientptr not defined"
566 #endif
567 
568 void *
569 (fts_get_clientptr)(FTS *sp)
570 {
571 
572 	return (fts_get_clientptr(sp));
573 }
574 
575 #ifndef fts_get_stream
576 #error "fts_get_stream not defined"
577 #endif
578 
579 FTS *
580 (fts_get_stream)(FTSENT *p)
581 {
582 	return (fts_get_stream(p));
583 }
584 
585 void
586 fts_set_clientptr(FTS *sp, void *clientptr)
587 {
588 
589 	sp->fts_clientptr = clientptr;
590 }
591 
592 /*
593  * This is the tricky part -- do not casually change *anything* in here.  The
594  * idea is to build the linked list of entries that are used by fts_children
595  * and fts_read.  There are lots of special cases.
596  *
597  * The real slowdown in walking the tree is the stat calls.  If FTS_NOSTAT is
598  * set and it's a physical walk (so that symbolic links can't be directories),
599  * we can do things quickly.  First, if it's a 4.4BSD file system, the type
600  * of the file is in the directory entry.  Otherwise, we assume that the number
601  * of subdirectories in a node is equal to the number of links to the parent.
602  * The former skips all stat calls.  The latter skips stat calls in any leaf
603  * directories and for any files after the subdirectories in the directory have
604  * been found, cutting the stat calls by about 2/3.
605  */
606 static FTSENT *
607 fts_build(FTS *sp, int type)
608 {
609 	struct dirent *dp;
610 	FTSENT *p, *head;
611 	FTSENT *cur, *tail;
612 	DIR *dirp;
613 	void *oldaddr;
614 	char *cp;
615 	int cderrno, descend, oflag, saved_errno, nostat, doadjust;
616 	long level;
617 	long nlinks;	/* has to be signed because -1 is a magic value */
618 	size_t dnamlen, len, maxlen, nitems;
619 
620 	/* Set current node pointer. */
621 	cur = sp->fts_cur;
622 
623 	/*
624 	 * Open the directory for reading.  If this fails, we're done.
625 	 * If being called from fts_read, set the fts_info field.
626 	 */
627 #ifdef FTS_WHITEOUT
628 	if (ISSET(FTS_WHITEOUT))
629 		oflag = DTF_NODUP | DTF_REWIND;
630 	else
631 		oflag = DTF_HIDEW | DTF_NODUP | DTF_REWIND;
632 #else
633 #define __opendir2(path, flag) opendir(path)
634 #endif
635 	if ((dirp = __opendir2(cur->fts_accpath, oflag)) == NULL) {
636 		if (type == BREAD) {
637 			cur->fts_info = FTS_DNR;
638 			cur->fts_errno = errno;
639 		}
640 		return (NULL);
641 	}
642 
643 	/*
644 	 * Nlinks is the number of possible entries of type directory in the
645 	 * directory if we're cheating on stat calls, 0 if we're not doing
646 	 * any stat calls at all, -1 if we're doing stats on everything.
647 	 */
648 	if (type == BNAMES) {
649 		nlinks = 0;
650 		/* Be quiet about nostat, GCC. */
651 		nostat = 0;
652 	} else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL)) {
653 		if (fts_ufslinks(sp, cur))
654 			nlinks = cur->fts_nlink - (ISSET(FTS_SEEDOT) ? 0 : 2);
655 		else
656 			nlinks = -1;
657 		nostat = 1;
658 	} else {
659 		nlinks = -1;
660 		nostat = 0;
661 	}
662 
663 #ifdef notdef
664 	printf("nlinks == %d (cur: %d)\n", nlinks, cur->fts_nlink);
665 	printf("NOSTAT %d PHYSICAL %d SEEDOT %d\n",
666 	    ISSET(FTS_NOSTAT), ISSET(FTS_PHYSICAL), ISSET(FTS_SEEDOT));
667 #endif
668 	/*
669 	 * If we're going to need to stat anything or we want to descend
670 	 * and stay in the directory, chdir.  If this fails we keep going,
671 	 * but set a flag so we don't chdir after the post-order visit.
672 	 * We won't be able to stat anything, but we can still return the
673 	 * names themselves.  Note, that since fts_read won't be able to
674 	 * chdir into the directory, it will have to return different path
675 	 * names than before, i.e. "a/b" instead of "b".  Since the node
676 	 * has already been visited in pre-order, have to wait until the
677 	 * post-order visit to return the error.  There is a special case
678 	 * here, if there was nothing to stat then it's not an error to
679 	 * not be able to stat.  This is all fairly nasty.  If a program
680 	 * needed sorted entries or stat information, they had better be
681 	 * checking FTS_NS on the returned nodes.
682 	 */
683 	cderrno = 0;
684 	if (nlinks || type == BREAD) {
685 		if (fts_safe_changedir(sp, cur, dirfd(dirp), NULL)) {
686 			if (nlinks && type == BREAD)
687 				cur->fts_errno = errno;
688 			cur->fts_flags |= FTS_DONTCHDIR;
689 			descend = 0;
690 			cderrno = errno;
691 		} else
692 			descend = 1;
693 	} else
694 		descend = 0;
695 
696 	/*
697 	 * Figure out the max file name length that can be stored in the
698 	 * current path -- the inner loop allocates more path as necessary.
699 	 * We really wouldn't have to do the maxlen calculations here, we
700 	 * could do them in fts_read before returning the path, but it's a
701 	 * lot easier here since the length is part of the dirent structure.
702 	 *
703 	 * If not changing directories set a pointer so that can just append
704 	 * each new name into the path.
705 	 */
706 	len = NAPPEND(cur);
707 	if (ISSET(FTS_NOCHDIR)) {
708 		cp = sp->fts_path + len;
709 		*cp++ = '/';
710 	} else {
711 		/* GCC, you're too verbose. */
712 		cp = NULL;
713 	}
714 	len++;
715 	maxlen = sp->fts_pathlen - len;
716 
717 	level = cur->fts_level + 1;
718 
719 	/* Read the directory, attaching each entry to the `link' pointer. */
720 	doadjust = 0;
721 	for (head = tail = NULL, nitems = 0; dirp && (dp = readdir(dirp));) {
722 		dnamlen = dp->d_namlen;
723 		if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
724 			continue;
725 
726 		if ((p = fts_alloc(sp, dp->d_name, dnamlen)) == NULL)
727 			goto mem1;
728 		if (dnamlen >= maxlen) {	/* include space for NUL */
729 			oldaddr = sp->fts_path;
730 			if (fts_palloc(sp, dnamlen + len + 1)) {
731 				/*
732 				 * No more memory for path or structures.  Save
733 				 * errno, free up the current structure and the
734 				 * structures already allocated.
735 				 */
736 mem1:				saved_errno = errno;
737 				if (p)
738 					free(p);
739 				fts_lfree(head);
740 				closedir(dirp);
741 				cur->fts_info = FTS_ERR;
742 				SET(FTS_STOP);
743 				errno = saved_errno;
744 				return (NULL);
745 			}
746 			/* Did realloc() change the pointer? */
747 			if (oldaddr != sp->fts_path) {
748 				doadjust = 1;
749 				if (ISSET(FTS_NOCHDIR))
750 					cp = sp->fts_path + len;
751 			}
752 			maxlen = sp->fts_pathlen - len;
753 		}
754 
755 		p->fts_level = level;
756 		p->fts_parent = sp->fts_cur;
757 		p->fts_pathlen = len + dnamlen;
758 
759 #ifdef FTS_WHITEOUT
760 		if (dp->d_type == DT_WHT)
761 			p->fts_flags |= FTS_ISW;
762 #endif
763 
764 		if (cderrno) {
765 			if (nlinks) {
766 				p->fts_info = FTS_NS;
767 				p->fts_errno = cderrno;
768 			} else
769 				p->fts_info = FTS_NSOK;
770 			p->fts_accpath = cur->fts_accpath;
771 		} else if (nlinks == 0
772 #ifdef DT_DIR
773 		    || (nostat &&
774 		    dp->d_type != DT_DIR && dp->d_type != DT_UNKNOWN)
775 #endif
776 		    ) {
777 			p->fts_accpath =
778 			    ISSET(FTS_NOCHDIR) ? p->fts_path : p->fts_name;
779 			p->fts_info = FTS_NSOK;
780 		} else {
781 			/* Build a file name for fts_stat to stat. */
782 			if (ISSET(FTS_NOCHDIR)) {
783 				p->fts_accpath = p->fts_path;
784 				memmove(cp, p->fts_name, p->fts_namelen + 1);
785 			} else
786 				p->fts_accpath = p->fts_name;
787 			/* Stat it. */
788 			p->fts_info = fts_stat(sp, p, 0);
789 
790 			/* Decrement link count if applicable. */
791 			if (nlinks > 0 && (p->fts_info == FTS_D ||
792 			    p->fts_info == FTS_DC || p->fts_info == FTS_DOT))
793 				--nlinks;
794 		}
795 
796 		/* We walk in directory order so "ls -f" doesn't get upset. */
797 		p->fts_link = NULL;
798 		if (head == NULL)
799 			head = tail = p;
800 		else {
801 			tail->fts_link = p;
802 			tail = p;
803 		}
804 		++nitems;
805 	}
806 	if (dirp)
807 		closedir(dirp);
808 
809 	/*
810 	 * If realloc() changed the address of the path, adjust the
811 	 * addresses for the rest of the tree and the dir list.
812 	 */
813 	if (doadjust)
814 		fts_padjust(sp, head);
815 
816 	/*
817 	 * If not changing directories, reset the path back to original
818 	 * state.
819 	 */
820 	if (ISSET(FTS_NOCHDIR))
821 		sp->fts_path[cur->fts_pathlen] = '\0';
822 
823 	/*
824 	 * If descended after called from fts_children or after called from
825 	 * fts_read and nothing found, get back.  At the root level we use
826 	 * the saved fd; if one of fts_open()'s arguments is a relative path
827 	 * to an empty directory, we wind up here with no other way back.  If
828 	 * can't get back, we're done.
829 	 */
830 	if (descend && (type == BCHILD || !nitems) &&
831 	    (cur->fts_level == FTS_ROOTLEVEL ?
832 	    FCHDIR(sp, sp->fts_rfd) :
833 	    fts_safe_changedir(sp, cur->fts_parent, -1, ".."))) {
834 		cur->fts_info = FTS_ERR;
835 		SET(FTS_STOP);
836 		return (NULL);
837 	}
838 
839 	/* If didn't find anything, return NULL. */
840 	if (!nitems) {
841 		if (type == BREAD)
842 			cur->fts_info = FTS_DP;
843 		return (NULL);
844 	}
845 
846 	/* Sort the entries. */
847 	if (sp->fts_compar && nitems > 1)
848 		head = fts_sort(sp, head, nitems);
849 	return (head);
850 }
851 
852 static int
853 fts_stat(FTS *sp, FTSENT *p, int follow)
854 {
855 	FTSENT *t;
856 	dev_t dev;
857 	ino_t ino;
858 	struct stat *sbp, sb;
859 	int saved_errno;
860 
861 	/* If user needs stat info, stat buffer already allocated. */
862 	sbp = ISSET(FTS_NOSTAT) ? &sb : p->fts_statp;
863 
864 #ifdef FTS_WHITEOUT
865 	/* Check for whiteout. */
866 	if (p->fts_flags & FTS_ISW) {
867 		if (sbp != &sb) {
868 			memset(sbp, '\0', sizeof(*sbp));
869 			sbp->st_mode = S_IFWHT;
870 		}
871 		return (FTS_W);
872 	}
873 #endif
874 
875 	/*
876 	 * If doing a logical walk, or application requested FTS_FOLLOW, do
877 	 * a stat(2).  If that fails, check for a non-existent symlink.  If
878 	 * fail, set the errno from the stat call.
879 	 */
880 	if (ISSET(FTS_LOGICAL) || follow) {
881 		if (stat(p->fts_accpath, sbp)) {
882 			saved_errno = errno;
883 			if (!lstat(p->fts_accpath, sbp)) {
884 				errno = 0;
885 				return (FTS_SLNONE);
886 			}
887 			p->fts_errno = saved_errno;
888 			goto err;
889 		}
890 	} else if (lstat(p->fts_accpath, sbp)) {
891 		p->fts_errno = errno;
892 err:		memset(sbp, 0, sizeof(struct stat));
893 		return (FTS_NS);
894 	}
895 
896 	if (S_ISDIR(sbp->st_mode)) {
897 		/*
898 		 * Set the device/inode.  Used to find cycles and check for
899 		 * crossing mount points.  Also remember the link count, used
900 		 * in fts_build to limit the number of stat calls.  It is
901 		 * understood that these fields are only referenced if fts_info
902 		 * is set to FTS_D.
903 		 */
904 		dev = p->fts_dev = sbp->st_dev;
905 		ino = p->fts_ino = sbp->st_ino;
906 		p->fts_nlink = sbp->st_nlink;
907 
908 		if (ISDOT(p->fts_name))
909 			return (FTS_DOT);
910 
911 		/*
912 		 * Cycle detection is done by brute force when the directory
913 		 * is first encountered.  If the tree gets deep enough or the
914 		 * number of symbolic links to directories is high enough,
915 		 * something faster might be worthwhile.
916 		 */
917 		for (t = p->fts_parent;
918 		    t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
919 			if (ino == t->fts_ino && dev == t->fts_dev) {
920 				p->fts_cycle = t;
921 				return (FTS_DC);
922 			}
923 		return (FTS_D);
924 	}
925 	if (S_ISLNK(sbp->st_mode))
926 		return (FTS_SL);
927 	if (S_ISREG(sbp->st_mode))
928 		return (FTS_F);
929 	return (FTS_DEFAULT);
930 }
931 
932 /*
933  * The comparison function takes pointers to pointers to FTSENT structures.
934  * Qsort wants a comparison function that takes pointers to void.
935  * (Both with appropriate levels of const-poisoning, of course!)
936  * Use a trampoline function to deal with the difference.
937  */
938 static int
939 fts_compar(const void *a, const void *b)
940 {
941 	FTS *parent;
942 
943 	parent = (*(const FTSENT * const *)a)->fts_fts;
944 	return (*parent->fts_compar)(a, b);
945 }
946 
947 static FTSENT *
948 fts_sort(FTS *sp, FTSENT *head, size_t nitems)
949 {
950 	FTSENT **ap, *p;
951 
952 	/*
953 	 * Construct an array of pointers to the structures and call qsort(3).
954 	 * Reassemble the array in the order returned by qsort.  If unable to
955 	 * sort for memory reasons, return the directory entries in their
956 	 * current order.  Allocate enough space for the current needs plus
957 	 * 40 so don't realloc one entry at a time.
958 	 */
959 	if (nitems > sp->fts_nitems) {
960 		sp->fts_nitems = nitems + 40;
961 		if ((sp->fts_array = reallocf(sp->fts_array,
962 		    sp->fts_nitems * sizeof(FTSENT *))) == NULL) {
963 			sp->fts_nitems = 0;
964 			return (head);
965 		}
966 	}
967 	for (ap = sp->fts_array, p = head; p; p = p->fts_link)
968 		*ap++ = p;
969 	qsort(sp->fts_array, nitems, sizeof(FTSENT *), fts_compar);
970 	for (head = *(ap = sp->fts_array); --nitems; ++ap)
971 		ap[0]->fts_link = ap[1];
972 	ap[0]->fts_link = NULL;
973 	return (head);
974 }
975 
976 static FTSENT *
977 fts_alloc(FTS *sp, const char *name, size_t namelen)
978 {
979 	FTSENT *p;
980 	size_t len;
981 
982 	struct ftsent_withstat {
983 		FTSENT	ent;
984 		struct	stat statbuf;
985 	};
986 
987 	/*
988 	 * The file name is a variable length array and no stat structure is
989 	 * necessary if the user has set the nostat bit.  Allocate the FTSENT
990 	 * structure, the file name and the stat structure in one chunk, but
991 	 * be careful that the stat structure is reasonably aligned.
992 	 */
993 	if (ISSET(FTS_NOSTAT))
994 		len = sizeof(FTSENT) + namelen + 1;
995 	else
996 		len = sizeof(struct ftsent_withstat) + namelen + 1;
997 
998 	if ((p = malloc(len)) == NULL)
999 		return (NULL);
1000 
1001 	if (ISSET(FTS_NOSTAT)) {
1002 		p->fts_name = (char *)(p + 1);
1003 		p->fts_statp = NULL;
1004 	} else {
1005 		p->fts_name = (char *)((struct ftsent_withstat *)p + 1);
1006 		p->fts_statp = &((struct ftsent_withstat *)p)->statbuf;
1007 	}
1008 
1009 	/* Copy the name and guarantee NUL termination. */
1010 	memcpy(p->fts_name, name, namelen);
1011 	p->fts_name[namelen] = '\0';
1012 	p->fts_namelen = namelen;
1013 	p->fts_path = sp->fts_path;
1014 	p->fts_errno = 0;
1015 	p->fts_flags = 0;
1016 	p->fts_instr = FTS_NOINSTR;
1017 	p->fts_number = 0;
1018 	p->fts_pointer = NULL;
1019 	p->fts_fts = sp;
1020 	return (p);
1021 }
1022 
1023 static void
1024 fts_lfree(FTSENT *head)
1025 {
1026 	FTSENT *p;
1027 
1028 	/* Free a linked list of structures. */
1029 	while ((p = head)) {
1030 		head = head->fts_link;
1031 		free(p);
1032 	}
1033 }
1034 
1035 /*
1036  * Allow essentially unlimited paths; find, rm, ls should all work on any tree.
1037  * Most systems will allow creation of paths much longer than MAXPATHLEN, even
1038  * though the kernel won't resolve them.  Add the size (not just what's needed)
1039  * plus 256 bytes so don't realloc the path 2 bytes at a time.
1040  */
1041 static int
1042 fts_palloc(FTS *sp, size_t more)
1043 {
1044 
1045 	sp->fts_pathlen += more + 256;
1046 	sp->fts_path = reallocf(sp->fts_path, sp->fts_pathlen);
1047 	return (sp->fts_path == NULL);
1048 }
1049 
1050 /*
1051  * When the path is realloc'd, have to fix all of the pointers in structures
1052  * already returned.
1053  */
1054 static void
1055 fts_padjust(FTS *sp, FTSENT *head)
1056 {
1057 	FTSENT *p;
1058 	char *addr = sp->fts_path;
1059 
1060 #define	ADJUST(p) do {							\
1061 	if ((p)->fts_accpath != (p)->fts_name) {			\
1062 		(p)->fts_accpath =					\
1063 		    (char *)addr + ((p)->fts_accpath - (p)->fts_path);	\
1064 	}								\
1065 	(p)->fts_path = addr;						\
1066 } while (0)
1067 	/* Adjust the current set of children. */
1068 	for (p = sp->fts_child; p; p = p->fts_link)
1069 		ADJUST(p);
1070 
1071 	/* Adjust the rest of the tree, including the current level. */
1072 	for (p = head; p->fts_level >= FTS_ROOTLEVEL;) {
1073 		ADJUST(p);
1074 		p = p->fts_link ? p->fts_link : p->fts_parent;
1075 	}
1076 }
1077 
1078 static size_t
1079 fts_maxarglen(char * const *argv)
1080 {
1081 	size_t len, max;
1082 
1083 	for (max = 0; *argv; ++argv)
1084 		if ((len = strlen(*argv)) > max)
1085 			max = len;
1086 	return (max + 1);
1087 }
1088 
1089 /*
1090  * Change to dir specified by fd or p->fts_accpath without getting
1091  * tricked by someone changing the world out from underneath us.
1092  * Assumes p->fts_dev and p->fts_ino are filled in.
1093  */
1094 static int
1095 fts_safe_changedir(FTS *sp, FTSENT *p, int fd, const char *path)
1096 {
1097 	int ret, oerrno, newfd;
1098 	struct stat sb;
1099 
1100 	newfd = fd;
1101 	if (ISSET(FTS_NOCHDIR))
1102 		return (0);
1103 	if (fd < 0 && (newfd = _open(path, O_RDONLY | O_CLOEXEC, 0)) < 0)
1104 		return (-1);
1105 	if (_fstat(newfd, &sb)) {
1106 		ret = -1;
1107 		goto bail;
1108 	}
1109 	if (p->fts_dev != sb.st_dev || p->fts_ino != sb.st_ino) {
1110 		errno = ENOENT;		/* disinformation */
1111 		ret = -1;
1112 		goto bail;
1113 	}
1114 	ret = fchdir(newfd);
1115 bail:
1116 	oerrno = errno;
1117 	if (fd < 0)
1118 		_close(newfd);
1119 	errno = oerrno;
1120 	return (ret);
1121 }
1122 
1123 /*
1124  * Check if the filesystem for "ent" has UFS-style links.
1125  */
1126 static int
1127 fts_ufslinks(FTS *sp, const FTSENT *ent)
1128 {
1129 	struct _fts_private *priv;
1130 	const char **cpp;
1131 
1132 	priv = (struct _fts_private *)sp;
1133 	/*
1134 	 * If this node's device is different from the previous, grab
1135 	 * the filesystem information, and decide on the reliability
1136 	 * of the link information from this filesystem for stat(2)
1137 	 * avoidance.
1138 	 */
1139 	if (priv->ftsp_dev != ent->fts_dev) {
1140 		if (statfs(ent->fts_path, &priv->ftsp_statfs) != -1) {
1141 			priv->ftsp_dev = ent->fts_dev;
1142 			priv->ftsp_linksreliable = 0;
1143 			for (cpp = ufslike_filesystems; *cpp; cpp++) {
1144 				if (strcmp(priv->ftsp_statfs.f_fstypename,
1145 				    *cpp) == 0) {
1146 					priv->ftsp_linksreliable = 1;
1147 					break;
1148 				}
1149 			}
1150 		} else {
1151 			priv->ftsp_linksreliable = 0;
1152 		}
1153 	}
1154 	return (priv->ftsp_linksreliable);
1155 }
1156