1 /* Traverse a file hierarchy.
3 Copyright (C) 2004, 2005 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 * Copyright (c) 1990, 1993, 1994
21 * The Regents of the University of California. All rights reserved.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the above copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 4. Neither the name of the University nor the names of its contributors
32 * may be used to endorse or promote products derived from this software
33 * without specific prior written permission.
35 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
36 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
38 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
39 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
40 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
41 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
42 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
43 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
44 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 #if defined(LIBC_SCCS) && !defined(lint)
53 static char sccsid[] = "@(#)fts.c 8.6 (Berkeley) 8/14/94";
54 #endif /* LIBC_SCCS and not lint */
58 #if HAVE_SYS_PARAM_H || defined _LIBC
59 # include <sys/param.h>
62 # include <include/sys/stat.h>
64 # include <sys/stat.h>
76 # define NAMLEN(dirent) _D_EXACT_NAMLEN (dirent)
80 # define NAMLEN(dirent) strlen ((dirent)->d_name)
82 # define dirent direct
83 # define NAMLEN(dirent) (dirent)->d_namlen
85 # include <sys/ndir.h>
98 # define close __close
100 # define closedir __closedir
102 # define fchdir __fchdir
106 # define opendir __opendir
108 # define readdir __readdir
110 # undef internal_function
111 # define internal_function /* empty */
114 /* Arrange to make lstat calls go through the wrapper function
115 on systems with an lstat function that does not dereference symlinks
116 that are specified with a trailing slash. */
117 #if ! _LIBC && ! LSTAT_FOLLOWS_SLASHED_SYMLINK
118 int rpl_lstat (const char *, struct stat *);
120 # define lstat(Name, Stat_buf) rpl_lstat(Name, Stat_buf)
124 # define __set_errno(Val) errno = (Val)
127 #ifndef __attribute__
128 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
129 # define __attribute__(x) /* empty */
133 #ifndef ATTRIBUTE_UNUSED
134 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
138 static FTSENT *fts_alloc (FTS *, const char *, size_t) internal_function;
139 static FTSENT *fts_build (FTS *, int) internal_function;
140 static void fts_lfree (FTSENT *) internal_function;
141 static void fts_load (FTS *, FTSENT *) internal_function;
142 static size_t fts_maxarglen (char * const *) internal_function;
143 static void fts_padjust (FTS *, FTSENT *) internal_function;
144 static bool fts_palloc (FTS *, size_t) internal_function;
145 static FTSENT *fts_sort (FTS *, FTSENT *, size_t) internal_function;
146 static unsigned short int fts_stat (FTS *, FTSENT *, bool) internal_function;
147 static int fts_safe_changedir (FTS *, FTSENT *, int, const char *)
151 static bool enter_dir (FTS *fts, FTSENT *ent) { return true; }
152 static void leave_dir (FTS *fts, FTSENT *ent) {}
153 static bool setup_dir (FTS *fts) { return true; }
154 static void free_dir (FTS *fts) {}
155 static int fd_safer (int fd) { return fd; }
157 # include "fts-cycle.c"
158 # include "unistd-safer.h"
162 # define MAX(a,b) ((a) > (b) ? (a) : (b))
166 # define SIZE_MAX ((size_t) -1)
170 # define O_DIRECTORY 0
173 #define ISDOT(a) (a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
175 #define CLR(opt) (sp->fts_options &= ~(opt))
176 #define ISSET(opt) (sp->fts_options & (opt))
177 #define SET(opt) (sp->fts_options |= (opt))
179 #define FCHDIR(sp, fd) (!ISSET(FTS_NOCHDIR) && fchdir(fd))
181 /* fts_build flags */
182 #define BCHILD 1 /* fts_children */
183 #define BNAMES 2 /* fts_children, names only */
184 #define BREAD 3 /* fts_read */
187 # include <inttypes.h>
190 bool fts_debug = false;
191 # define Dprintf(x) do { if (fts_debug) printf x; } while (0)
196 #define LEAVE_DIR(Fts, Ent, Tag) \
199 Dprintf ((" %s-leaving: %s\n", Tag, (Ent)->fts_path)); \
200 leave_dir (Fts, Ent); \
204 /* Open the directory DIR if possible, and return a file
205 descriptor. Return -1 and set errno on failure. It doesn't matter
206 whether the file descriptor has read or write access. */
210 diropen (char const *dir)
212 int fd = open (dir, O_RDONLY | O_DIRECTORY);
214 fd = open (dir, O_WRONLY | O_DIRECTORY);
219 fts_open (char * const *argv,
220 register int options,
221 int (*compar) (FTSENT const **, FTSENT const **))
224 register FTSENT *p, *root;
225 register size_t nitems;
226 FTSENT *parent, *tmp = NULL; /* pacify gcc */
230 if (options & ~FTS_OPTIONMASK) {
231 __set_errno (EINVAL);
235 /* Allocate/initialize the stream */
236 if ((sp = malloc(sizeof(FTS))) == NULL)
238 memset(sp, 0, sizeof(FTS));
239 sp->fts_compar = compar;
240 sp->fts_options = options;
242 /* Logical walks turn on NOCHDIR; symbolic links are too hard. */
243 if (ISSET(FTS_LOGICAL))
247 * Start out with 1K of path space, and enough, in any case,
248 * to hold the user's paths.
251 # define MAXPATHLEN 1024
253 if (! fts_palloc(sp, MAX(fts_maxarglen(argv), MAXPATHLEN)))
256 /* Allocate/initialize root's parent. */
257 if ((parent = fts_alloc(sp, "", 0)) == NULL)
259 parent->fts_level = FTS_ROOTPARENTLEVEL;
261 /* Allocate/initialize root(s). */
262 for (root = NULL, nitems = 0; *argv != NULL; ++argv, ++nitems) {
263 /* Don't allow zero-length paths. */
264 if ((len = strlen(*argv)) == 0) {
265 __set_errno (ENOENT);
269 if ((p = fts_alloc(sp, *argv, len)) == NULL)
271 p->fts_level = FTS_ROOTLEVEL;
272 p->fts_parent = parent;
273 p->fts_accpath = p->fts_name;
274 p->fts_info = fts_stat(sp, p, ISSET(FTS_COMFOLLOW) != 0);
276 /* Command-line "." and ".." are real directories. */
277 if (p->fts_info == FTS_DOT)
281 * If comparison routine supplied, traverse in sorted
282 * order; otherwise traverse in the order specified.
297 if (compar && nitems > 1)
298 root = fts_sort(sp, root, nitems);
301 * Allocate a dummy pointer and make fts_read think that we've just
302 * finished the node before the root(s); set p->fts_info to FTS_INIT
303 * so that everything about the "current" node is ignored.
305 if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
307 sp->fts_cur->fts_link = root;
308 sp->fts_cur->fts_info = FTS_INIT;
309 if (! setup_dir (sp))
313 * If using chdir(2), grab a file descriptor pointing to dot to ensure
314 * that we can get back here; this could be avoided for some paths,
315 * but almost certainly not worth the effort. Slashes, symbolic links,
316 * and ".." are all fairly nasty problems. Note, if we can't get the
317 * descriptor we run anyway, just more slowly.
319 if (!ISSET(FTS_NOCHDIR)
320 && (sp->fts_rfd = diropen (".")) < 0)
325 mem3: fts_lfree(root);
327 mem2: free(sp->fts_path);
334 fts_load (FTS *sp, register FTSENT *p)
340 * Load the stream structure for the next traversal. Since we don't
341 * actually enter the directory until after the preorder visit, set
342 * the fts_accpath field specially so the chdir gets done to the right
343 * place and the user can access the first node. From fts_open it's
344 * known that the path will fit.
346 len = p->fts_pathlen = p->fts_namelen;
347 memmove(sp->fts_path, p->fts_name, len + 1);
348 if ((cp = strrchr(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
350 memmove(p->fts_name, cp, len + 1);
351 p->fts_namelen = len;
353 p->fts_accpath = p->fts_path = sp->fts_path;
354 sp->fts_dev = p->fts_statp->st_dev;
360 register FTSENT *freep, *p;
364 * This still works if we haven't read anything -- the dummy structure
365 * points to the root list, so we step through to the end of the root
366 * list which has a valid parent pointer.
369 for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
371 p = p->fts_link != NULL ? p->fts_link : p->fts_parent;
377 /* Free up child linked list, sort array, path buffer. */
379 fts_lfree(sp->fts_child);
384 /* Return to original directory, save errno if necessary. */
385 if (!ISSET(FTS_NOCHDIR)) {
386 if (fchdir(sp->fts_rfd))
388 (void)close(sp->fts_rfd);
393 /* Free up the stream pointer. */
396 /* Set errno and return. */
398 __set_errno (saved_errno);
406 * Special case of "/" at the end of the path so that slashes aren't
407 * appended which would cause paths to be written as "....//foo".
410 (p->fts_path[p->fts_pathlen - 1] == '/' \
411 ? p->fts_pathlen - 1 : p->fts_pathlen)
414 fts_read (register FTS *sp)
416 register FTSENT *p, *tmp;
417 register unsigned short int instr;
421 /* If finished or unrecoverable error, return NULL. */
422 if (sp->fts_cur == NULL || ISSET(FTS_STOP))
425 /* Set current node pointer. */
428 /* Save and zero out user instructions. */
429 instr = p->fts_instr;
430 p->fts_instr = FTS_NOINSTR;
432 /* Any type of file may be re-visited; re-stat and re-turn. */
433 if (instr == FTS_AGAIN) {
434 p->fts_info = fts_stat(sp, p, false);
437 Dprintf (("fts_read: p=%s\n",
438 p->fts_info == FTS_INIT ? "" : p->fts_path));
441 * Following a symlink -- SLNONE test allows application to see
442 * SLNONE and recover. If indirecting through a symlink, have
443 * keep a pointer to current location. If unable to get that
444 * pointer, follow fails.
446 if (instr == FTS_FOLLOW &&
447 (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
448 p->fts_info = fts_stat(sp, p, true);
449 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
450 if ((p->fts_symfd = diropen (".")) < 0) {
451 p->fts_errno = errno;
452 p->fts_info = FTS_ERR;
454 p->fts_flags |= FTS_SYMFOLLOW;
459 /* Directory in pre-order. */
460 if (p->fts_info == FTS_D) {
461 /* If skipped or crossed mount point, do post-order visit. */
462 if (instr == FTS_SKIP ||
463 (ISSET(FTS_XDEV) && p->fts_statp->st_dev != sp->fts_dev)) {
464 if (p->fts_flags & FTS_SYMFOLLOW)
465 (void)close(p->fts_symfd);
467 fts_lfree(sp->fts_child);
468 sp->fts_child = NULL;
470 p->fts_info = FTS_DP;
471 LEAVE_DIR (sp, p, "1");
475 /* Rebuild if only read the names and now traversing. */
476 if (sp->fts_child != NULL && ISSET(FTS_NAMEONLY)) {
478 fts_lfree(sp->fts_child);
479 sp->fts_child = NULL;
483 * Cd to the subdirectory.
485 * If have already read and now fail to chdir, whack the list
486 * to make the names come out right, and set the parent errno
487 * so the application will eventually get an error condition.
488 * Set the FTS_DONTCHDIR flag so that when we logically change
489 * directories back to the parent we don't do a chdir.
491 * If haven't read do so. If the read fails, fts_build sets
492 * FTS_STOP or the fts_info field of the node.
494 if (sp->fts_child != NULL) {
495 if (fts_safe_changedir(sp, p, -1, p->fts_accpath)) {
496 p->fts_errno = errno;
497 p->fts_flags |= FTS_DONTCHDIR;
498 for (p = sp->fts_child; p != NULL;
501 p->fts_parent->fts_accpath;
503 } else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
506 /* If fts_build's call to fts_safe_changedir failed
507 because it was not able to fchdir into a
508 subdirectory, tell the caller. */
510 p->fts_info = FTS_ERR;
511 /* FIXME: see if this should be in an else block */
512 LEAVE_DIR (sp, p, "2");
516 sp->fts_child = NULL;
520 /* Move to the next node on this level. */
522 if ((p = p->fts_link) != NULL) {
526 * If reached the top, return to the original directory (or
527 * the root of the tree), and load the paths for the next root.
529 if (p->fts_level == FTS_ROOTLEVEL) {
530 if (FCHDIR(sp, sp->fts_rfd)) {
539 * User may have called fts_set on the node. If skipped,
540 * ignore. If followed, get a file descriptor so we can
541 * get back if necessary.
543 if (p->fts_instr == FTS_SKIP)
545 if (p->fts_instr == FTS_FOLLOW) {
546 p->fts_info = fts_stat(sp, p, true);
547 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
548 if ((p->fts_symfd = diropen (".")) < 0) {
549 p->fts_errno = errno;
550 p->fts_info = FTS_ERR;
552 p->fts_flags |= FTS_SYMFOLLOW;
554 p->fts_instr = FTS_NOINSTR;
557 name: t = sp->fts_path + NAPPEND(p->fts_parent);
559 memmove(t, p->fts_name, p->fts_namelen + 1);
562 if (p->fts_info == FTS_D)
564 Dprintf ((" %s-entering: %s\n", sp, p->fts_path));
565 if (! enter_dir (sp, p))
567 __set_errno (ENOMEM);
574 /* Move up to the parent node. */
578 if (p->fts_level == FTS_ROOTPARENTLEVEL) {
580 * Done; free everything up and set errno to 0 so the user
581 * can distinguish between error and EOF.
585 return (sp->fts_cur = NULL);
588 /* NUL terminate the pathname. */
589 sp->fts_path[p->fts_pathlen] = '\0';
592 * Return to the parent directory. If at a root node or came through
593 * a symlink, go back through the file descriptor. Otherwise, cd up
596 if (p->fts_level == FTS_ROOTLEVEL) {
597 if (FCHDIR(sp, sp->fts_rfd)) {
598 p->fts_errno = errno;
601 } else if (p->fts_flags & FTS_SYMFOLLOW) {
602 if (FCHDIR(sp, p->fts_symfd)) {
604 (void)close(p->fts_symfd);
605 __set_errno (saved_errno);
606 p->fts_errno = errno;
609 (void)close(p->fts_symfd);
610 } else if (!(p->fts_flags & FTS_DONTCHDIR) &&
611 fts_safe_changedir(sp, p->fts_parent, -1, "..")) {
612 p->fts_errno = errno;
615 p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
616 if (p->fts_errno == 0)
617 LEAVE_DIR (sp, p, "3");
619 return ISSET(FTS_STOP) ? NULL : p;
623 * Fts_set takes the stream as an argument although it's not used in this
624 * implementation; it would be necessary if anyone wanted to add global
625 * semantics to fts using fts_set. An error return is allowed for similar
630 fts_set(FTS *sp ATTRIBUTE_UNUSED, FTSENT *p, int instr)
632 if (instr != 0 && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
633 instr != FTS_NOINSTR && instr != FTS_SKIP) {
634 __set_errno (EINVAL);
637 p->fts_instr = instr;
642 fts_children (register FTS *sp, int instr)
647 if (instr != 0 && instr != FTS_NAMEONLY) {
648 __set_errno (EINVAL);
652 /* Set current node pointer. */
656 * Errno set to 0 so user can distinguish empty directory from
661 /* Fatal errors stop here. */
665 /* Return logical hierarchy of user's arguments. */
666 if (p->fts_info == FTS_INIT)
667 return (p->fts_link);
670 * If not a directory being visited in pre-order, stop here. Could
671 * allow FTS_DNR, assuming the user has fixed the problem, but the
672 * same effect is available with FTS_AGAIN.
674 if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
677 /* Free up any previous child list. */
678 if (sp->fts_child != NULL)
679 fts_lfree(sp->fts_child);
681 if (instr == FTS_NAMEONLY) {
688 * If using chdir on a relative path and called BEFORE fts_read does
689 * its chdir to the root of a traversal, we can lose -- we need to
690 * chdir into the subdirectory, and we don't know where the current
691 * directory is, so we can't get back so that the upcoming chdir by
692 * fts_read will work.
694 if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
696 return (sp->fts_child = fts_build(sp, instr));
698 if ((fd = diropen (".")) < 0)
699 return (sp->fts_child = NULL);
700 sp->fts_child = fts_build(sp, instr);
706 return (sp->fts_child);
710 * This is the tricky part -- do not casually change *anything* in here. The
711 * idea is to build the linked list of entries that are used by fts_children
712 * and fts_read. There are lots of special cases.
714 * The real slowdown in walking the tree is the stat calls. If FTS_NOSTAT is
715 * set and it's a physical walk (so that symbolic links can't be directories),
716 * we can do things quickly. First, if it's a 4.4BSD file system, the type
717 * of the file is in the directory entry. Otherwise, we assume that the number
718 * of subdirectories in a node is equal to the number of links to the parent.
719 * The former skips all stat calls. The latter skips stat calls in any leaf
720 * directories and for any files after the subdirectories in the directory have
721 * been found, cutting the stat calls by about 2/3.
725 fts_build (register FTS *sp, int type)
727 register struct dirent *dp;
728 register FTSENT *p, *head;
729 register size_t nitems;
740 size_t len, maxlen, new_len;
743 /* Set current node pointer. */
747 * Open the directory for reading. If this fails, we're done.
748 * If being called from fts_read, set the fts_info field.
750 #if defined FTS_WHITEOUT && 0
751 if (ISSET(FTS_WHITEOUT))
752 oflag = DTF_NODUP|DTF_REWIND;
754 oflag = DTF_HIDEW|DTF_NODUP|DTF_REWIND;
756 # define __opendir2(path, flag) opendir(path)
758 if ((dirp = __opendir2(cur->fts_accpath, oflag)) == NULL) {
760 cur->fts_info = FTS_DNR;
761 cur->fts_errno = errno;
767 * Nlinks is the number of possible entries of type directory in the
768 * directory if we're cheating on stat calls, 0 if we're not doing
769 * any stat calls at all, (nlink_t) -1 if we're statting everything.
771 if (type == BNAMES) {
773 /* Be quiet about nostat, GCC. */
775 } else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL)) {
776 nlinks = (cur->fts_statp->st_nlink
777 - (ISSET(FTS_SEEDOT) ? 0 : 2));
785 * If we're going to need to stat anything or we want to descend
786 * and stay in the directory, chdir. If this fails we keep going,
787 * but set a flag so we don't chdir after the post-order visit.
788 * We won't be able to stat anything, but we can still return the
789 * names themselves. Note, that since fts_read won't be able to
790 * chdir into the directory, it will have to return different path
791 * names than before, i.e. "a/b" instead of "b". Since the node
792 * has already been visited in pre-order, have to wait until the
793 * post-order visit to return the error. There is a special case
794 * here, if there was nothing to stat then it's not an error to
795 * not be able to stat. This is all fairly nasty. If a program
796 * needed sorted entries or stat information, they had better be
797 * checking FTS_NS on the returned nodes.
800 if (nlinks || type == BREAD) {
801 if (fts_safe_changedir(sp, cur, dirfd(dirp), NULL)) {
802 if (nlinks && type == BREAD)
803 cur->fts_errno = errno;
804 cur->fts_flags |= FTS_DONTCHDIR;
815 * Figure out the max file name length that can be stored in the
816 * current path -- the inner loop allocates more path as necessary.
817 * We really wouldn't have to do the maxlen calculations here, we
818 * could do them in fts_read before returning the path, but it's a
819 * lot easier here since the length is part of the dirent structure.
821 * If not changing directories set a pointer so that can just append
822 * each new name into the path.
825 if (ISSET(FTS_NOCHDIR)) {
826 cp = sp->fts_path + len;
829 /* GCC, you're too verbose. */
833 maxlen = sp->fts_pathlen - len;
835 level = cur->fts_level + 1;
837 /* Read the directory, attaching each entry to the `link' pointer. */
839 for (head = tail = NULL, nitems = 0; dirp && (dp = readdir(dirp));) {
840 if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
843 if ((p = fts_alloc(sp, dp->d_name, NAMLEN (dp))) == NULL)
845 if (NAMLEN (dp) >= maxlen) {/* include space for NUL */
846 oldaddr = sp->fts_path;
847 if (! fts_palloc(sp, NAMLEN (dp) + len + 1)) {
849 * No more memory for path or structures. Save
850 * errno, free up the current structure and the
851 * structures already allocated.
853 mem1: saved_errno = errno;
858 cur->fts_info = FTS_ERR;
860 __set_errno (saved_errno);
863 /* Did realloc() change the pointer? */
864 if (oldaddr != sp->fts_path) {
866 if (ISSET(FTS_NOCHDIR))
867 cp = sp->fts_path + len;
869 maxlen = sp->fts_pathlen - len;
872 new_len = len + NAMLEN (dp);
875 * In the unlikely even that we would end up
876 * with a path longer than SIZE_MAX, free up
877 * the current structure and the structures already
878 * allocated, then error out with ENAMETOOLONG.
883 cur->fts_info = FTS_ERR;
885 __set_errno (ENAMETOOLONG);
888 p->fts_level = level;
889 p->fts_parent = sp->fts_cur;
890 p->fts_pathlen = new_len;
892 #if defined FTS_WHITEOUT && 0
893 if (dp->d_type == DT_WHT)
894 p->fts_flags |= FTS_ISW;
899 p->fts_info = FTS_NS;
900 p->fts_errno = cderrno;
902 p->fts_info = FTS_NSOK;
903 p->fts_accpath = cur->fts_accpath;
904 } else if (nlinks == 0
905 #if HAVE_STRUCT_DIRENT_D_TYPE
907 dp->d_type != DT_DIR && dp->d_type != DT_UNKNOWN)
911 ISSET(FTS_NOCHDIR) ? p->fts_path : p->fts_name;
912 p->fts_info = FTS_NSOK;
914 /* Build a file name for fts_stat to stat. */
915 if (ISSET(FTS_NOCHDIR)) {
916 p->fts_accpath = p->fts_path;
917 memmove(cp, p->fts_name, p->fts_namelen + 1);
919 p->fts_accpath = p->fts_name;
921 p->fts_info = fts_stat(sp, p, false);
923 /* Decrement link count if applicable. */
924 if (nlinks > 0 && (p->fts_info == FTS_D ||
925 p->fts_info == FTS_DC || p->fts_info == FTS_DOT))
929 /* We walk in directory order so "ls -f" doesn't get upset. */
943 * If realloc() changed the address of the path, adjust the
944 * addresses for the rest of the tree and the dir list.
947 fts_padjust(sp, head);
950 * If not changing directories, reset the path back to original
953 if (ISSET(FTS_NOCHDIR)) {
954 if (len == sp->fts_pathlen || nitems == 0)
960 * If descended after called from fts_children or after called from
961 * fts_read and nothing found, get back. At the root level we use
962 * the saved fd; if one of fts_open()'s arguments is a relative path
963 * to an empty directory, we wind up here with no other way back. If
964 * can't get back, we're done.
966 if (descend && (type == BCHILD || !nitems) &&
967 (cur->fts_level == FTS_ROOTLEVEL ?
968 FCHDIR(sp, sp->fts_rfd) :
969 fts_safe_changedir(sp, cur->fts_parent, -1, ".."))) {
970 cur->fts_info = FTS_ERR;
975 /* If didn't find anything, return NULL. */
978 cur->fts_info = FTS_DP;
982 /* Sort the entries. */
983 if (sp->fts_compar && nitems > 1)
984 head = fts_sort(sp, head, nitems);
990 /* Walk ->fts_parent links starting at E_CURR, until the root of the
991 current hierarchy. There should be a directory with dev/inode
992 matching those of AD. If not, print a lot of diagnostics. */
994 find_matching_ancestor (FTSENT const *e_curr, struct Active_dir const *ad)
997 for (ent = e_curr; ent->fts_level >= FTS_ROOTLEVEL; ent = ent->fts_parent)
999 if (ad->ino == ent->fts_statp->st_ino
1000 && ad->dev == ent->fts_statp->st_dev)
1003 printf ("ERROR: tree dir, %s, not active\n", ad->fts_ent->fts_accpath);
1004 printf ("active dirs:\n");
1006 ent->fts_level >= FTS_ROOTLEVEL; ent = ent->fts_parent)
1007 printf (" %s(%"PRIuMAX"/%"PRIuMAX") to %s(%"PRIuMAX"/%"PRIuMAX")...\n",
1008 ad->fts_ent->fts_accpath,
1009 (uintmax_t) ad->dev,
1010 (uintmax_t) ad->ino,
1012 (uintmax_t) ent->fts_statp->st_dev,
1013 (uintmax_t) ent->fts_statp->st_ino);
1017 fts_cross_check (FTS const *sp)
1019 FTSENT const *ent = sp->fts_cur;
1021 if ( ! ISSET (FTS_TIGHT_CYCLE_CHECK))
1024 Dprintf (("fts-cross-check cur=%s\n", ent->fts_path));
1025 /* Make sure every parent dir is in the tree. */
1026 for (t = ent->fts_parent; t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
1028 struct Active_dir ad;
1029 ad.ino = t->fts_statp->st_ino;
1030 ad.dev = t->fts_statp->st_dev;
1031 if ( ! hash_lookup (sp->active_dir_ht, &ad))
1032 printf ("ERROR: active dir, %s, not in tree\n", t->fts_path);
1035 /* Make sure every dir in the tree is an active dir.
1036 But ENT is not necessarily a directory. If so, just skip this part. */
1037 if (ent->fts_parent->fts_level >= FTS_ROOTLEVEL
1038 && (ent->fts_info == FTS_DP
1039 || ent->fts_info == FTS_D))
1041 struct Active_dir *ad;
1042 for (ad = hash_get_first (sp->active_dir_ht); ad != NULL;
1043 ad = hash_get_next (sp->active_dir_ht, ad))
1045 find_matching_ancestor (ent, ad);
1051 static unsigned short int
1053 fts_stat(FTS *sp, register FTSENT *p, bool follow)
1055 struct stat *sbp = p->fts_statp;
1058 #if defined FTS_WHITEOUT && 0
1059 /* check for whiteout */
1060 if (p->fts_flags & FTS_ISW) {
1061 memset(sbp, '\0', sizeof (*sbp));
1062 sbp->st_mode = S_IFWHT;
1068 * If doing a logical walk, or application requested FTS_FOLLOW, do
1069 * a stat(2). If that fails, check for a non-existent symlink. If
1070 * fail, set the errno from the stat call.
1072 if (ISSET(FTS_LOGICAL) || follow) {
1073 if (stat(p->fts_accpath, sbp)) {
1074 saved_errno = errno;
1075 if (!lstat(p->fts_accpath, sbp)) {
1077 return (FTS_SLNONE);
1079 p->fts_errno = saved_errno;
1082 } else if (lstat(p->fts_accpath, sbp)) {
1083 p->fts_errno = errno;
1084 err: memset(sbp, 0, sizeof(struct stat));
1088 if (S_ISDIR(sbp->st_mode)) {
1089 if (ISDOT(p->fts_name))
1095 * Cycle detection is done by brute force when the directory
1096 * is first encountered. If the tree gets deep enough or the
1097 * number of symbolic links to directories is high enough,
1098 * something faster might be worthwhile.
1102 for (t = p->fts_parent;
1103 t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
1104 if (sbp->st_ino == t->fts_statp->st_ino
1105 && sbp->st_dev == t->fts_statp->st_dev)
1115 if (S_ISLNK(sbp->st_mode))
1117 if (S_ISREG(sbp->st_mode))
1119 return (FTS_DEFAULT);
1123 fts_compar (void const *a, void const *b)
1125 /* Convert A and B to the correct types, to pacify the compiler, and
1126 for portability to bizarre hosts where "void const *" and "FTSENT
1127 const **" differ in runtime representation. The comparison
1128 function cannot modify *a and *b, but there is no compile-time
1130 FTSENT const **pa = (FTSENT const **) a;
1131 FTSENT const **pb = (FTSENT const **) b;
1132 return pa[0]->fts_fts->fts_compar (pa, pb);
1137 fts_sort (FTS *sp, FTSENT *head, register size_t nitems)
1139 register FTSENT **ap, *p;
1141 /* On most modern hosts, void * and FTSENT ** have the same
1142 run-time representation, and one can convert sp->fts_compar to
1143 the type qsort expects without problem. Use the heuristic that
1144 this is OK if the two pointer types are the same size, and if
1145 converting FTSENT ** to long int is the same as converting
1146 FTSENT ** to void * and then to long int. This heuristic isn't
1147 valid in general but we don't know of any counterexamples. */
1149 int (*compare) (void const *, void const *) =
1150 ((sizeof &dummy == sizeof (void *)
1151 && (long int) &dummy == (long int) (void *) &dummy)
1152 ? (int (*) (void const *, void const *)) sp->fts_compar
1156 * Construct an array of pointers to the structures and call qsort(3).
1157 * Reassemble the array in the order returned by qsort. If unable to
1158 * sort for memory reasons, return the directory entries in their
1159 * current order. Allocate enough space for the current needs plus
1160 * 40 so don't realloc one entry at a time.
1162 if (nitems > sp->fts_nitems) {
1165 sp->fts_nitems = nitems + 40;
1166 if (SIZE_MAX / sizeof *a < sp->fts_nitems
1167 || ! (a = realloc (sp->fts_array,
1168 sp->fts_nitems * sizeof *a))) {
1169 free(sp->fts_array);
1170 sp->fts_array = NULL;
1176 for (ap = sp->fts_array, p = head; p; p = p->fts_link)
1178 qsort((void *)sp->fts_array, nitems, sizeof(FTSENT *), compare);
1179 for (head = *(ap = sp->fts_array); --nitems; ++ap)
1180 ap[0]->fts_link = ap[1];
1181 ap[0]->fts_link = NULL;
1187 fts_alloc (FTS *sp, const char *name, register size_t namelen)
1193 * The file name is a variable length array. Allocate the FTSENT
1194 * structure and the file name in one chunk.
1196 len = sizeof(FTSENT) + namelen;
1197 if ((p = malloc(len)) == NULL)
1200 /* Copy the name and guarantee NUL termination. */
1201 memmove(p->fts_name, name, namelen);
1202 p->fts_name[namelen] = '\0';
1204 p->fts_namelen = namelen;
1206 p->fts_path = sp->fts_path;
1209 p->fts_instr = FTS_NOINSTR;
1211 p->fts_pointer = NULL;
1217 fts_lfree (register FTSENT *head)
1221 /* Free a linked list of structures. */
1222 while ((p = head)) {
1223 head = head->fts_link;
1229 * Allow essentially unlimited paths; find, rm, ls should all work on any tree.
1230 * Most systems will allow creation of paths much longer than MAXPATHLEN, even
1231 * though the kernel won't resolve them. Add the size (not just what's needed)
1232 * plus 256 bytes so don't realloc the path 2 bytes at a time.
1236 fts_palloc (FTS *sp, size_t more)
1239 size_t new_len = sp->fts_pathlen + more + 256;
1242 * See if fts_pathlen would overflow.
1244 if (new_len < sp->fts_pathlen) {
1247 sp->fts_path = NULL;
1249 sp->fts_path = NULL;
1250 __set_errno (ENAMETOOLONG);
1253 sp->fts_pathlen = new_len;
1254 p = realloc(sp->fts_path, sp->fts_pathlen);
1257 sp->fts_path = NULL;
1265 * When the path is realloc'd, have to fix all of the pointers in structures
1270 fts_padjust (FTS *sp, FTSENT *head)
1273 char *addr = sp->fts_path;
1275 #define ADJUST(p) do { \
1276 if ((p)->fts_accpath != (p)->fts_name) { \
1277 (p)->fts_accpath = \
1278 (char *)addr + ((p)->fts_accpath - (p)->fts_path); \
1280 (p)->fts_path = addr; \
1282 /* Adjust the current set of children. */
1283 for (p = sp->fts_child; p; p = p->fts_link)
1286 /* Adjust the rest of the tree, including the current level. */
1287 for (p = head; p->fts_level >= FTS_ROOTLEVEL;) {
1289 p = p->fts_link ? p->fts_link : p->fts_parent;
1295 fts_maxarglen (char * const *argv)
1299 for (max = 0; *argv; ++argv)
1300 if ((len = strlen(*argv)) > max)
1306 * Change to dir specified by fd or path without getting
1307 * tricked by someone changing the world out from underneath us.
1308 * Assumes p->fts_statp->st_dev and p->fts_statp->st_ino are filled in.
1312 fts_safe_changedir (FTS *sp, FTSENT *p, int fd, char const *path)
1314 int ret, oerrno, newfd;
1318 if (ISSET(FTS_NOCHDIR))
1320 if (fd < 0 && (newfd = fd_safer (diropen (path))) < 0)
1322 if (fstat(newfd, &sb)) {
1326 if (p->fts_statp->st_dev != sb.st_dev
1327 || p->fts_statp->st_ino != sb.st_ino) {
1328 __set_errno (ENOENT); /* disinformation */
1332 ret = fchdir(newfd);
1337 __set_errno (oerrno);