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