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