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