1 /* Traverse a file hierarchy.
3 Copyright (C) 2004, 2005, 2006 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
50 #if defined(LIBC_SCCS) && !defined(lint)
51 static char sccsid[] = "@(#)fts.c 8.6 (Berkeley) 8/14/94";
52 #endif /* LIBC_SCCS and not lint */
56 #if HAVE_SYS_PARAM_H || defined _LIBC
57 # include <sys/param.h>
60 # include <include/sys/stat.h>
62 # include <sys/stat.h>
76 # include "unistd--.h"
80 #ifndef _D_EXACT_NAMLEN
81 # define _D_EXACT_NAMLEN(dirent) strlen ((dirent)->d_name)
84 #if HAVE_STRUCT_DIRENT_D_TYPE
85 /* True if the type of the directory entry D is known. */
86 # define DT_IS_KNOWN(d) ((d)->d_type != DT_UNKNOWN)
87 /* True if the type of the directory entry D must be T. */
88 # define DT_MUST_BE(d, t) ((d)->d_type == (t))
90 # define DT_IS_KNOWN(d) false
91 # define DT_MUST_BE(d, t) false
96 FTS_NO_STAT_REQUIRED = 1,
102 # define close __close
104 # define closedir __closedir
106 # define fchdir __fchdir
110 # define opendir __opendir
112 # define readdir __readdir
114 # undef internal_function
115 # define internal_function /* empty */
119 # define __set_errno(Val) errno = (Val)
122 #ifndef __attribute__
123 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
124 # define __attribute__(x) /* empty */
128 #ifndef ATTRIBUTE_UNUSED
129 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
132 /* If this host provides the openat function, then we can avoid
133 attempting to open "." in some initialization code below. */
135 # define HAVE_OPENAT_SUPPORT 1
137 # define HAVE_OPENAT_SUPPORT 0
140 static FTSENT *fts_alloc (FTS *, const char *, size_t) internal_function;
141 static FTSENT *fts_build (FTS *, int) internal_function;
142 static void fts_lfree (FTSENT *) internal_function;
143 static void fts_load (FTS *, FTSENT *) internal_function;
144 static size_t fts_maxarglen (char * const *) internal_function;
145 static void fts_padjust (FTS *, FTSENT *) internal_function;
146 static bool fts_palloc (FTS *, size_t) internal_function;
147 static FTSENT *fts_sort (FTS *, FTSENT *, size_t) internal_function;
148 static unsigned short int fts_stat (FTS *, FTSENT *, bool) internal_function;
149 static int fts_safe_changedir (FTS *, FTSENT *, int, const char *)
153 static bool enter_dir (FTS *fts, FTSENT *ent) { return true; }
154 static void leave_dir (FTS *fts, FTSENT *ent) {}
155 static bool setup_dir (FTS *fts) { return true; }
156 static void free_dir (FTS *fts) {}
158 # include "fcntl--.h"
159 # include "fts-cycle.c"
163 # define MAX(a,b) ((a) > (b) ? (a) : (b))
167 # define SIZE_MAX ((size_t) -1)
171 # define O_DIRECTORY 0
174 #define ISDOT(a) (a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
175 #define STREQ(a, b) (strcmp ((a), (b)) == 0)
177 #define CLR(opt) (sp->fts_options &= ~(opt))
178 #define ISSET(opt) (sp->fts_options & (opt))
179 #define SET(opt) (sp->fts_options |= (opt))
181 #define RESTORE_INITIAL_CWD(sp) FCHDIR (sp, (ISSET (FTS_CWDFD) \
185 #define FCHDIR(sp, fd) (!ISSET(FTS_NOCHDIR) \
186 && (ISSET(FTS_CWDFD) \
187 ? (cwd_advance_fd (sp, fd), 0) \
191 /* fts_build flags */
192 #define BCHILD 1 /* fts_children */
193 #define BNAMES 2 /* fts_children, names only */
194 #define BREAD 3 /* fts_read */
197 # include <inttypes.h>
200 bool fts_debug = false;
201 # define Dprintf(x) do { if (fts_debug) printf x; } while (0)
206 #define LEAVE_DIR(Fts, Ent, Tag) \
209 Dprintf ((" %s-leaving: %s\n", Tag, (Ent)->fts_path)); \
210 leave_dir (Fts, Ent); \
214 /* Overload the fts_statp->st_size member (otherwise unused, when
215 fts_info is FTS_NSOK) to indicate whether fts_read should stat
216 this entry or not. */
218 fts_set_stat_required (FTSENT *p, bool required)
220 if (p->fts_info != FTS_NSOK)
222 p->fts_statp->st_size = (required
224 : FTS_NO_STAT_REQUIRED);
227 /* file-descriptor-relative opendir. */
228 /* FIXME: if others need this function, move it into lib/openat.c */
231 opendirat (int fd, char const *dir)
233 int new_fd = openat (fd, dir, O_RDONLY);
238 dirp = fdopendir (new_fd);
241 int saved_errno = errno;
248 /* Virtual fchdir. Advance SP's working directory
249 file descriptor, SP->fts_cwd_fd, to FD, and close
250 the previous one, ignoring any error. */
253 cwd_advance_fd (FTS *sp, int fd)
255 int old = sp->fts_cwd_fd;
256 if (old == fd && old != AT_FDCWD)
260 close (old); /* ignore any close failure */
263 /* Open the directory DIR if possible, and return a file
264 descriptor. Return -1 and set errno on failure. It doesn't matter
265 whether the file descriptor has read or write access. */
269 diropen (FTS const *sp, char const *dir)
271 int open_flags = (O_RDONLY | O_DIRECTORY | O_NOCTTY | O_NONBLOCK
272 | (ISSET (FTS_PHYSICAL) ? O_NOFOLLOW : 0));
274 return (ISSET (FTS_CWDFD)
275 ? openat (sp->fts_cwd_fd, dir, open_flags)
276 : open (dir, open_flags));
280 fts_open (char * const *argv,
281 register int options,
282 int (*compar) (FTSENT const **, FTSENT const **))
285 register FTSENT *p, *root;
286 register size_t nitems;
287 FTSENT *parent = NULL;
288 FTSENT *tmp = NULL; /* pacify gcc */
293 if (options & ~FTS_OPTIONMASK) {
294 __set_errno (EINVAL);
297 if ((options & FTS_NOCHDIR) && (options & FTS_CWDFD)) {
298 __set_errno (EINVAL);
301 if ( ! (options & (FTS_LOGICAL | FTS_PHYSICAL))) {
302 __set_errno (EINVAL);
306 /* Allocate/initialize the stream */
307 if ((sp = malloc(sizeof(FTS))) == NULL)
309 memset(sp, 0, sizeof(FTS));
310 sp->fts_compar = compar;
311 sp->fts_options = options;
313 /* Logical walks turn on NOCHDIR; symbolic links are too hard. */
314 if (ISSET(FTS_LOGICAL)) {
319 /* Initialize fts_cwd_fd. */
320 sp->fts_cwd_fd = AT_FDCWD;
321 if ( ISSET(FTS_CWDFD) && ! HAVE_OPENAT_SUPPORT)
323 /* While it isn't technically necessary to open "." this
324 early, doing it here saves us the trouble of ensuring
325 later (where it'd be messier) that "." can in fact
326 be opened. If not, revert to FTS_NOCHDIR mode. */
327 int fd = open (".", O_RDONLY);
330 /* Even if `.' is unreadable, don't revert to FTS_NOCHDIR mode
331 on systems like Linux+PROC_FS, where our openat emulation
332 is good enough. Note: on a system that emulates
333 openat via /proc, this technique can still fail, but
334 only in extreme conditions, e.g., when the working
335 directory cannot be saved (i.e. save_cwd fails) --
336 and that happens on Linux only when "." is unreadable
337 and the CWD would be longer than PATH_MAX.
338 FIXME: once Linux kernel openat support is well established,
339 replace the above open call and this entire if/else block
340 with the body of the if-block below. */
341 if ( openat_needs_fchdir ())
354 * Start out with 1K of file name space, and enough, in any case,
355 * to hold the user's file names.
358 # define MAXPATHLEN 1024
361 size_t maxarglen = fts_maxarglen(argv);
362 if (! fts_palloc(sp, MAX(maxarglen, MAXPATHLEN)))
366 /* Allocate/initialize root's parent. */
368 if ((parent = fts_alloc(sp, "", 0)) == NULL)
370 parent->fts_level = FTS_ROOTPARENTLEVEL;
373 /* The classic fts implementation would call fts_stat with
374 a new entry for each iteration of the loop below.
375 If the comparison function is not specified or if the
376 FTS_DEFER_STAT option is in effect, don't stat any entry
377 in this loop. This is an attempt to minimize the interval
378 between the initial stat/lstat/fstatat and the point at which
379 a directory argument is first opened. This matters for any
380 directory command line argument that resides on a file system
381 without genuine i-nodes. If you specify FTS_DEFER_STAT along
382 with a comparison function, that function must not access any
383 data via the fts_statp pointer. */
384 defer_stat = (compar == NULL || ISSET(FTS_DEFER_STAT));
386 /* Allocate/initialize root(s). */
387 for (root = NULL, nitems = 0; *argv != NULL; ++argv, ++nitems) {
388 /* Don't allow zero-length file names. */
389 if ((len = strlen(*argv)) == 0) {
390 __set_errno (ENOENT);
394 if ((p = fts_alloc(sp, *argv, len)) == NULL)
396 p->fts_level = FTS_ROOTLEVEL;
397 p->fts_parent = parent;
398 p->fts_accpath = p->fts_name;
399 /* Even when defer_stat is true, be sure to stat the first
400 command line argument, since fts_read (at least with
401 FTS_XDEV) requires that. */
402 if (defer_stat && root != NULL) {
403 p->fts_info = FTS_NSOK;
404 fts_set_stat_required(p, true);
406 p->fts_info = fts_stat(sp, p, false);
410 * If comparison routine supplied, traverse in sorted
411 * order; otherwise traverse in the order specified.
426 if (compar && nitems > 1)
427 root = fts_sort(sp, root, nitems);
430 * Allocate a dummy pointer and make fts_read think that we've just
431 * finished the node before the root(s); set p->fts_info to FTS_INIT
432 * so that everything about the "current" node is ignored.
434 if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
436 sp->fts_cur->fts_link = root;
437 sp->fts_cur->fts_info = FTS_INIT;
438 if (! setup_dir (sp))
442 * If using chdir(2), grab a file descriptor pointing to dot to ensure
443 * that we can get back here; this could be avoided for some file names,
444 * but almost certainly not worth the effort. Slashes, symbolic links,
445 * and ".." are all fairly nasty problems. Note, if we can't get the
446 * descriptor we run anyway, just more slowly.
448 if (!ISSET(FTS_NOCHDIR) && !ISSET(FTS_CWDFD)
449 && (sp->fts_rfd = diropen (sp, ".")) < 0)
454 mem3: fts_lfree(root);
456 mem2: free(sp->fts_path);
463 fts_load (FTS *sp, register FTSENT *p)
469 * Load the stream structure for the next traversal. Since we don't
470 * actually enter the directory until after the preorder visit, set
471 * the fts_accpath field specially so the chdir gets done to the right
472 * place and the user can access the first node. From fts_open it's
473 * known that the file name will fit.
475 len = p->fts_pathlen = p->fts_namelen;
476 memmove(sp->fts_path, p->fts_name, len + 1);
477 if ((cp = strrchr(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
479 memmove(p->fts_name, cp, len + 1);
480 p->fts_namelen = len;
482 p->fts_accpath = p->fts_path = sp->fts_path;
483 sp->fts_dev = p->fts_statp->st_dev;
489 register FTSENT *freep, *p;
493 * This still works if we haven't read anything -- the dummy structure
494 * points to the root list, so we step through to the end of the root
495 * list which has a valid parent pointer.
498 for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
500 p = p->fts_link != NULL ? p->fts_link : p->fts_parent;
506 /* Free up child linked list, sort array, file name buffer. */
508 fts_lfree(sp->fts_child);
512 if (ISSET(FTS_CWDFD))
514 if (0 <= sp->fts_cwd_fd)
515 close (sp->fts_cwd_fd);
517 else if (!ISSET(FTS_NOCHDIR))
519 /* Return to original directory, save errno if necessary. */
520 if (fchdir(sp->fts_rfd))
527 /* Free up the stream pointer. */
530 /* Set errno and return. */
532 __set_errno (saved_errno);
540 * Special case of "/" at the end of the file name so that slashes aren't
541 * appended which would cause file names to be written as "....//foo".
544 (p->fts_path[p->fts_pathlen - 1] == '/' \
545 ? p->fts_pathlen - 1 : p->fts_pathlen)
548 fts_read (register FTS *sp)
550 register FTSENT *p, *tmp;
551 register unsigned short int instr;
554 /* If finished or unrecoverable error, return NULL. */
555 if (sp->fts_cur == NULL || ISSET(FTS_STOP))
558 /* Set current node pointer. */
561 /* Save and zero out user instructions. */
562 instr = p->fts_instr;
563 p->fts_instr = FTS_NOINSTR;
565 /* Any type of file may be re-visited; re-stat and re-turn. */
566 if (instr == FTS_AGAIN) {
567 p->fts_info = fts_stat(sp, p, false);
570 Dprintf (("fts_read: p=%s\n",
571 p->fts_info == FTS_INIT ? "" : p->fts_path));
574 * Following a symlink -- SLNONE test allows application to see
575 * SLNONE and recover. If indirecting through a symlink, have
576 * keep a pointer to current location. If unable to get that
577 * pointer, follow fails.
579 if (instr == FTS_FOLLOW &&
580 (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
581 p->fts_info = fts_stat(sp, p, true);
582 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
583 if ((p->fts_symfd = diropen (sp, ".")) < 0) {
584 p->fts_errno = errno;
585 p->fts_info = FTS_ERR;
587 p->fts_flags |= FTS_SYMFOLLOW;
592 /* Directory in pre-order. */
593 if (p->fts_info == FTS_D) {
594 /* If skipped or crossed mount point, do post-order visit. */
595 if (instr == FTS_SKIP ||
596 (ISSET(FTS_XDEV) && p->fts_statp->st_dev != sp->fts_dev)) {
597 if (p->fts_flags & FTS_SYMFOLLOW)
598 (void)close(p->fts_symfd);
600 fts_lfree(sp->fts_child);
601 sp->fts_child = NULL;
603 p->fts_info = FTS_DP;
604 LEAVE_DIR (sp, p, "1");
608 /* Rebuild if only read the names and now traversing. */
609 if (sp->fts_child != NULL && ISSET(FTS_NAMEONLY)) {
611 fts_lfree(sp->fts_child);
612 sp->fts_child = NULL;
616 * Cd to the subdirectory.
618 * If have already read and now fail to chdir, whack the list
619 * to make the names come out right, and set the parent errno
620 * so the application will eventually get an error condition.
621 * Set the FTS_DONTCHDIR flag so that when we logically change
622 * directories back to the parent we don't do a chdir.
624 * If haven't read do so. If the read fails, fts_build sets
625 * FTS_STOP or the fts_info field of the node.
627 if (sp->fts_child != NULL) {
628 if (fts_safe_changedir(sp, p, -1, p->fts_accpath)) {
629 p->fts_errno = errno;
630 p->fts_flags |= FTS_DONTCHDIR;
631 for (p = sp->fts_child; p != NULL;
634 p->fts_parent->fts_accpath;
636 } else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
639 /* If fts_build's call to fts_safe_changedir failed
640 because it was not able to fchdir into a
641 subdirectory, tell the caller. */
643 p->fts_info = FTS_ERR;
644 LEAVE_DIR (sp, p, "2");
648 sp->fts_child = NULL;
652 /* Move to the next node on this level. */
654 if ((p = p->fts_link) != NULL) {
658 * If reached the top, return to the original directory (or
659 * the root of the tree), and load the file names for the next
662 if (p->fts_level == FTS_ROOTLEVEL) {
663 if (RESTORE_INITIAL_CWD(sp)) {
673 * User may have called fts_set on the node. If skipped,
674 * ignore. If followed, get a file descriptor so we can
675 * get back if necessary.
677 if (p->fts_instr == FTS_SKIP)
679 if (p->fts_instr == FTS_FOLLOW) {
680 p->fts_info = fts_stat(sp, p, true);
681 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
682 if ((p->fts_symfd = diropen (sp, ".")) < 0) {
683 p->fts_errno = errno;
684 p->fts_info = FTS_ERR;
686 p->fts_flags |= FTS_SYMFOLLOW;
688 p->fts_instr = FTS_NOINSTR;
691 name: t = sp->fts_path + NAPPEND(p->fts_parent);
693 memmove(t, p->fts_name, p->fts_namelen + 1);
695 if (p->fts_info == FTS_NSOK)
697 switch (p->fts_statp->st_size)
699 case FTS_STAT_REQUIRED:
700 p->fts_info = fts_stat(sp, p, false);
702 case FTS_NO_STAT_REQUIRED:
709 if (p->fts_info == FTS_D)
711 Dprintf ((" %s-entering: %s\n", sp, p->fts_path));
712 if (! enter_dir (sp, p))
714 __set_errno (ENOMEM);
721 /* Move up to the parent node. */
725 if (p->fts_level == FTS_ROOTPARENTLEVEL) {
727 * Done; free everything up and set errno to 0 so the user
728 * can distinguish between error and EOF.
732 return (sp->fts_cur = NULL);
735 if (p->fts_info == FTS_NSOK)
738 /* NUL terminate the file name. */
739 sp->fts_path[p->fts_pathlen] = '\0';
742 * Return to the parent directory. If at a root node, restore
743 * the initial working directory. If we came through a symlink,
744 * go back through the file descriptor. Otherwise, move up
745 * one level, via "..".
747 if (p->fts_level == FTS_ROOTLEVEL) {
748 if (RESTORE_INITIAL_CWD(sp)) {
749 p->fts_errno = errno;
752 } else if (p->fts_flags & FTS_SYMFOLLOW) {
753 if (FCHDIR(sp, p->fts_symfd)) {
754 int saved_errno = errno;
755 (void)close(p->fts_symfd);
756 __set_errno (saved_errno);
757 p->fts_errno = errno;
760 (void)close(p->fts_symfd);
761 } else if (!(p->fts_flags & FTS_DONTCHDIR) &&
762 fts_safe_changedir(sp, p->fts_parent, -1, "..")) {
763 p->fts_errno = errno;
766 p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
767 if (p->fts_errno == 0)
768 LEAVE_DIR (sp, p, "3");
770 return ISSET(FTS_STOP) ? NULL : p;
774 * Fts_set takes the stream as an argument although it's not used in this
775 * implementation; it would be necessary if anyone wanted to add global
776 * semantics to fts using fts_set. An error return is allowed for similar
781 fts_set(FTS *sp ATTRIBUTE_UNUSED, FTSENT *p, int instr)
783 if (instr != 0 && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
784 instr != FTS_NOINSTR && instr != FTS_SKIP) {
785 __set_errno (EINVAL);
788 p->fts_instr = instr;
793 fts_children (register FTS *sp, int instr)
798 if (instr != 0 && instr != FTS_NAMEONLY) {
799 __set_errno (EINVAL);
803 /* Set current node pointer. */
807 * Errno set to 0 so user can distinguish empty directory from
812 /* Fatal errors stop here. */
816 /* Return logical hierarchy of user's arguments. */
817 if (p->fts_info == FTS_INIT)
818 return (p->fts_link);
821 * If not a directory being visited in pre-order, stop here. Could
822 * allow FTS_DNR, assuming the user has fixed the problem, but the
823 * same effect is available with FTS_AGAIN.
825 if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
828 /* Free up any previous child list. */
829 if (sp->fts_child != NULL)
830 fts_lfree(sp->fts_child);
832 if (instr == FTS_NAMEONLY) {
839 * If using chdir on a relative file name and called BEFORE fts_read
840 * does its chdir to the root of a traversal, we can lose -- we need to
841 * chdir into the subdirectory, and we don't know where the current
842 * directory is, so we can't get back so that the upcoming chdir by
843 * fts_read will work.
845 if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
847 return (sp->fts_child = fts_build(sp, instr));
849 if ((fd = diropen (sp, ".")) < 0)
850 return (sp->fts_child = NULL);
851 sp->fts_child = fts_build(sp, instr);
852 if (ISSET(FTS_CWDFD))
854 cwd_advance_fd (sp, fd);
860 int saved_errno = errno;
862 __set_errno (saved_errno);
867 return (sp->fts_child);
871 * This is the tricky part -- do not casually change *anything* in here. The
872 * idea is to build the linked list of entries that are used by fts_children
873 * and fts_read. There are lots of special cases.
875 * The real slowdown in walking the tree is the stat calls. If FTS_NOSTAT is
876 * set and it's a physical walk (so that symbolic links can't be directories),
877 * we can do things quickly. First, if it's a 4.4BSD file system, the type
878 * of the file is in the directory entry. Otherwise, we assume that the number
879 * of subdirectories in a node is equal to the number of links to the parent.
880 * The former skips all stat calls. The latter skips stat calls in any leaf
881 * directories and for any files after the subdirectories in the directory have
882 * been found, cutting the stat calls by about 2/3.
886 fts_build (register FTS *sp, int type)
888 register struct dirent *dp;
889 register FTSENT *p, *head;
890 register size_t nitems;
900 size_t len, maxlen, new_len;
903 /* Set current node pointer. */
907 * Open the directory for reading. If this fails, we're done.
908 * If being called from fts_read, set the fts_info field.
910 #if defined FTS_WHITEOUT && 0
911 if (ISSET(FTS_WHITEOUT))
912 oflag = DTF_NODUP|DTF_REWIND;
914 oflag = DTF_HIDEW|DTF_NODUP|DTF_REWIND;
916 # define __opendir2(file, flag) \
917 ( ! ISSET(FTS_NOCHDIR) && ISSET(FTS_CWDFD) \
918 ? opendirat(sp->fts_cwd_fd, file) \
921 if ((dirp = __opendir2(cur->fts_accpath, oflag)) == NULL) {
923 cur->fts_info = FTS_DNR;
924 cur->fts_errno = errno;
928 /* Rather than calling fts_stat for each and every entry encountered
929 in the readdir loop (below), stat each directory only right after
931 if (cur->fts_info == FTS_NSOK)
932 cur->fts_info = fts_stat(sp, cur, false);
935 * Nlinks is the number of possible entries of type directory in the
936 * directory if we're cheating on stat calls, 0 if we're not doing
937 * any stat calls at all, (nlink_t) -1 if we're statting everything.
939 if (type == BNAMES) {
941 /* Be quiet about nostat, GCC. */
943 } else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL)) {
944 nlinks = (cur->fts_statp->st_nlink
945 - (ISSET(FTS_SEEDOT) ? 0 : 2));
953 * If we're going to need to stat anything or we want to descend
954 * and stay in the directory, chdir. If this fails we keep going,
955 * but set a flag so we don't chdir after the post-order visit.
956 * We won't be able to stat anything, but we can still return the
957 * names themselves. Note, that since fts_read won't be able to
958 * chdir into the directory, it will have to return different file
959 * names than before, i.e. "a/b" instead of "b". Since the node
960 * has already been visited in pre-order, have to wait until the
961 * post-order visit to return the error. There is a special case
962 * here, if there was nothing to stat then it's not an error to
963 * not be able to stat. This is all fairly nasty. If a program
964 * needed sorted entries or stat information, they had better be
965 * checking FTS_NS on the returned nodes.
967 if (nlinks || type == BREAD) {
968 int dir_fd = dirfd(dirp);
969 if (ISSET(FTS_CWDFD) && 0 <= dir_fd)
970 dir_fd = dup (dir_fd);
971 if (dir_fd < 0 || fts_safe_changedir(sp, cur, dir_fd, NULL)) {
972 if (nlinks && type == BREAD)
973 cur->fts_errno = errno;
974 cur->fts_flags |= FTS_DONTCHDIR;
977 if (ISSET(FTS_CWDFD) && 0 <= dir_fd)
986 * Figure out the max file name length that can be stored in the
987 * current buffer -- the inner loop allocates more space as necessary.
988 * We really wouldn't have to do the maxlen calculations here, we
989 * could do them in fts_read before returning the name, but it's a
990 * lot easier here since the length is part of the dirent structure.
992 * If not changing directories set a pointer so that can just append
993 * each new component into the file name.
996 if (ISSET(FTS_NOCHDIR)) {
997 cp = sp->fts_path + len;
1000 /* GCC, you're too verbose. */
1004 maxlen = sp->fts_pathlen - len;
1006 level = cur->fts_level + 1;
1008 /* Read the directory, attaching each entry to the `link' pointer. */
1010 for (head = tail = NULL, nitems = 0; dirp && (dp = readdir(dirp));) {
1013 if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
1016 if ((p = fts_alloc (sp, dp->d_name,
1017 _D_EXACT_NAMLEN (dp))) == NULL)
1019 if (_D_EXACT_NAMLEN (dp) >= maxlen) {
1020 /* include space for NUL */
1021 oldaddr = sp->fts_path;
1022 if (! fts_palloc(sp, _D_EXACT_NAMLEN (dp) + len + 1)) {
1024 * No more memory. Save
1025 * errno, free up the current structure and the
1026 * structures already allocated.
1028 mem1: saved_errno = errno;
1032 cur->fts_info = FTS_ERR;
1034 __set_errno (saved_errno);
1037 /* Did realloc() change the pointer? */
1038 if (oldaddr != sp->fts_path) {
1040 if (ISSET(FTS_NOCHDIR))
1041 cp = sp->fts_path + len;
1043 maxlen = sp->fts_pathlen - len;
1046 new_len = len + _D_EXACT_NAMLEN (dp);
1047 if (new_len < len) {
1049 * In the unlikely even that we would end up
1050 * with a file name longer than SIZE_MAX, free up
1051 * the current structure and the structures already
1052 * allocated, then error out with ENAMETOOLONG.
1057 cur->fts_info = FTS_ERR;
1059 __set_errno (ENAMETOOLONG);
1062 p->fts_level = level;
1063 p->fts_parent = sp->fts_cur;
1064 p->fts_pathlen = new_len;
1066 #if defined FTS_WHITEOUT && 0
1067 if (dp->d_type == DT_WHT)
1068 p->fts_flags |= FTS_ISW;
1071 /* Build a file name for fts_stat to stat. */
1072 if (ISSET(FTS_NOCHDIR)) {
1073 p->fts_accpath = p->fts_path;
1074 memmove(cp, p->fts_name, p->fts_namelen + 1);
1076 p->fts_accpath = p->fts_name;
1078 if (sp->fts_compar == NULL || ISSET(FTS_DEFER_STAT)) {
1079 /* Record what fts_read will have to do with this
1080 entry. In many cases, it will simply fts_stat it,
1081 but we can take advantage of any d_type information
1082 to optimize away the unnecessary stat calls. I.e.,
1083 if FTS_NOSTAT is in effect and we're not following
1084 symlinks (FTS_PHYSICAL) and d_type indicates this
1085 is *not* a directory, then we won't have to stat it
1086 at all. If it *is* a directory, then (currently)
1087 we stat it regardless, in order to get device and
1088 inode numbers. Some day we might optimize that
1089 away, too, for directories where d_ino is known to
1091 bool skip_stat = (ISSET(FTS_PHYSICAL)
1092 && ISSET(FTS_NOSTAT)
1094 && ! DT_MUST_BE(dp, DT_DIR));
1095 p->fts_info = FTS_NSOK;
1096 fts_set_stat_required(p, !skip_stat);
1097 is_dir = (ISSET(FTS_PHYSICAL) && ISSET(FTS_NOSTAT)
1098 && DT_MUST_BE(dp, DT_DIR));
1100 p->fts_info = fts_stat(sp, p, false);
1101 is_dir = (p->fts_info == FTS_D
1102 || p->fts_info == FTS_DC
1103 || p->fts_info == FTS_DOT);
1106 /* Decrement link count if applicable. */
1107 if (nlinks > 0 && is_dir)
1110 /* We walk in directory order so "ls -f" doesn't get upset. */
1124 * If realloc() changed the address of the file name, adjust the
1125 * addresses for the rest of the tree and the dir list.
1128 fts_padjust(sp, head);
1131 * If not changing directories, reset the file name back to original
1134 if (ISSET(FTS_NOCHDIR)) {
1135 if (len == sp->fts_pathlen || nitems == 0)
1141 * If descended after called from fts_children or after called from
1142 * fts_read and nothing found, get back. At the root level we use
1143 * the saved fd; if one of fts_open()'s arguments is a relative name
1144 * to an empty directory, we wind up here with no other way back. If
1145 * can't get back, we're done.
1147 if (descend && (type == BCHILD || !nitems) &&
1148 (cur->fts_level == FTS_ROOTLEVEL
1149 ? RESTORE_INITIAL_CWD(sp)
1150 : fts_safe_changedir(sp, cur->fts_parent, -1, ".."))) {
1151 cur->fts_info = FTS_ERR;
1157 /* If didn't find anything, return NULL. */
1160 cur->fts_info = FTS_DP;
1165 /* Sort the entries. */
1166 if (sp->fts_compar && nitems > 1)
1167 head = fts_sort(sp, head, nitems);
1173 /* Walk ->fts_parent links starting at E_CURR, until the root of the
1174 current hierarchy. There should be a directory with dev/inode
1175 matching those of AD. If not, print a lot of diagnostics. */
1177 find_matching_ancestor (FTSENT const *e_curr, struct Active_dir const *ad)
1180 for (ent = e_curr; ent->fts_level >= FTS_ROOTLEVEL; ent = ent->fts_parent)
1182 if (ad->ino == ent->fts_statp->st_ino
1183 && ad->dev == ent->fts_statp->st_dev)
1186 printf ("ERROR: tree dir, %s, not active\n", ad->fts_ent->fts_accpath);
1187 printf ("active dirs:\n");
1189 ent->fts_level >= FTS_ROOTLEVEL; ent = ent->fts_parent)
1190 printf (" %s(%"PRIuMAX"/%"PRIuMAX") to %s(%"PRIuMAX"/%"PRIuMAX")...\n",
1191 ad->fts_ent->fts_accpath,
1192 (uintmax_t) ad->dev,
1193 (uintmax_t) ad->ino,
1195 (uintmax_t) ent->fts_statp->st_dev,
1196 (uintmax_t) ent->fts_statp->st_ino);
1200 fts_cross_check (FTS const *sp)
1202 FTSENT const *ent = sp->fts_cur;
1204 if ( ! ISSET (FTS_TIGHT_CYCLE_CHECK))
1207 Dprintf (("fts-cross-check cur=%s\n", ent->fts_path));
1208 /* Make sure every parent dir is in the tree. */
1209 for (t = ent->fts_parent; t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
1211 struct Active_dir ad;
1212 ad.ino = t->fts_statp->st_ino;
1213 ad.dev = t->fts_statp->st_dev;
1214 if ( ! hash_lookup (sp->fts_cycle.ht, &ad))
1215 printf ("ERROR: active dir, %s, not in tree\n", t->fts_path);
1218 /* Make sure every dir in the tree is an active dir.
1219 But ENT is not necessarily a directory. If so, just skip this part. */
1220 if (ent->fts_parent->fts_level >= FTS_ROOTLEVEL
1221 && (ent->fts_info == FTS_DP
1222 || ent->fts_info == FTS_D))
1224 struct Active_dir *ad;
1225 for (ad = hash_get_first (sp->fts_cycle.ht); ad != NULL;
1226 ad = hash_get_next (sp->fts_cycle.ht, ad))
1228 find_matching_ancestor (ent, ad);
1234 static unsigned short int
1236 fts_stat(FTS *sp, register FTSENT *p, bool follow)
1238 struct stat *sbp = p->fts_statp;
1241 if (p->fts_level == FTS_ROOTLEVEL && ISSET(FTS_COMFOLLOW))
1244 #if defined FTS_WHITEOUT && 0
1245 /* check for whiteout */
1246 if (p->fts_flags & FTS_ISW) {
1247 memset(sbp, '\0', sizeof (*sbp));
1248 sbp->st_mode = S_IFWHT;
1254 * If doing a logical walk, or application requested FTS_FOLLOW, do
1255 * a stat(2). If that fails, check for a non-existent symlink. If
1256 * fail, set the errno from the stat call.
1258 if (ISSET(FTS_LOGICAL) || follow) {
1259 if (stat(p->fts_accpath, sbp)) {
1260 saved_errno = errno;
1262 && lstat(p->fts_accpath, sbp) == 0) {
1264 return (FTS_SLNONE);
1266 p->fts_errno = saved_errno;
1269 } else if (fstatat(sp->fts_cwd_fd, p->fts_accpath, sbp,
1270 AT_SYMLINK_NOFOLLOW)) {
1271 p->fts_errno = errno;
1272 err: memset(sbp, 0, sizeof(struct stat));
1276 if (S_ISDIR(sbp->st_mode)) {
1277 if (ISDOT(p->fts_name)) {
1278 /* Command-line "." and ".." are real directories. */
1279 return (p->fts_level == FTS_ROOTLEVEL ? FTS_D : FTS_DOT);
1285 * Cycle detection is done by brute force when the directory
1286 * is first encountered. If the tree gets deep enough or the
1287 * number of symbolic links to directories is high enough,
1288 * something faster might be worthwhile.
1292 for (t = p->fts_parent;
1293 t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
1294 if (sbp->st_ino == t->fts_statp->st_ino
1295 && sbp->st_dev == t->fts_statp->st_dev)
1305 if (S_ISLNK(sbp->st_mode))
1307 if (S_ISREG(sbp->st_mode))
1309 return (FTS_DEFAULT);
1313 fts_compar (void const *a, void const *b)
1315 /* Convert A and B to the correct types, to pacify the compiler, and
1316 for portability to bizarre hosts where "void const *" and "FTSENT
1317 const **" differ in runtime representation. The comparison
1318 function cannot modify *a and *b, but there is no compile-time
1320 FTSENT const **pa = (FTSENT const **) a;
1321 FTSENT const **pb = (FTSENT const **) b;
1322 return pa[0]->fts_fts->fts_compar (pa, pb);
1327 fts_sort (FTS *sp, FTSENT *head, register size_t nitems)
1329 register FTSENT **ap, *p;
1331 /* On most modern hosts, void * and FTSENT ** have the same
1332 run-time representation, and one can convert sp->fts_compar to
1333 the type qsort expects without problem. Use the heuristic that
1334 this is OK if the two pointer types are the same size, and if
1335 converting FTSENT ** to long int is the same as converting
1336 FTSENT ** to void * and then to long int. This heuristic isn't
1337 valid in general but we don't know of any counterexamples. */
1339 int (*compare) (void const *, void const *) =
1340 ((sizeof &dummy == sizeof (void *)
1341 && (long int) &dummy == (long int) (void *) &dummy)
1342 ? (int (*) (void const *, void const *)) sp->fts_compar
1346 * Construct an array of pointers to the structures and call qsort(3).
1347 * Reassemble the array in the order returned by qsort. If unable to
1348 * sort for memory reasons, return the directory entries in their
1349 * current order. Allocate enough space for the current needs plus
1350 * 40 so don't realloc one entry at a time.
1352 if (nitems > sp->fts_nitems) {
1355 sp->fts_nitems = nitems + 40;
1356 if (SIZE_MAX / sizeof *a < sp->fts_nitems
1357 || ! (a = realloc (sp->fts_array,
1358 sp->fts_nitems * sizeof *a))) {
1359 free(sp->fts_array);
1360 sp->fts_array = NULL;
1366 for (ap = sp->fts_array, p = head; p; p = p->fts_link)
1368 qsort((void *)sp->fts_array, nitems, sizeof(FTSENT *), compare);
1369 for (head = *(ap = sp->fts_array); --nitems; ++ap)
1370 ap[0]->fts_link = ap[1];
1371 ap[0]->fts_link = NULL;
1377 fts_alloc (FTS *sp, const char *name, register size_t namelen)
1383 * The file name is a variable length array. Allocate the FTSENT
1384 * structure and the file name in one chunk.
1386 len = sizeof(FTSENT) + namelen;
1387 if ((p = malloc(len)) == NULL)
1390 /* Copy the name and guarantee NUL termination. */
1391 memmove(p->fts_name, name, namelen);
1392 p->fts_name[namelen] = '\0';
1394 p->fts_namelen = namelen;
1396 p->fts_path = sp->fts_path;
1399 p->fts_instr = FTS_NOINSTR;
1401 p->fts_pointer = NULL;
1407 fts_lfree (register FTSENT *head)
1411 /* Free a linked list of structures. */
1412 while ((p = head)) {
1413 head = head->fts_link;
1419 * Allow essentially unlimited file name lengths; find, rm, ls should
1420 * all work on any tree. Most systems will allow creation of file
1421 * names much longer than MAXPATHLEN, even though the kernel won't
1422 * resolve them. Add the size (not just what's needed) plus 256 bytes
1423 * so don't realloc the file name 2 bytes at a time.
1427 fts_palloc (FTS *sp, size_t more)
1430 size_t new_len = sp->fts_pathlen + more + 256;
1433 * See if fts_pathlen would overflow.
1435 if (new_len < sp->fts_pathlen) {
1437 sp->fts_path = NULL;
1438 __set_errno (ENAMETOOLONG);
1441 sp->fts_pathlen = new_len;
1442 p = realloc(sp->fts_path, sp->fts_pathlen);
1445 sp->fts_path = NULL;
1453 * When the file name is realloc'd, have to fix all of the pointers in
1454 * structures already returned.
1458 fts_padjust (FTS *sp, FTSENT *head)
1461 char *addr = sp->fts_path;
1463 #define ADJUST(p) do { \
1464 if ((p)->fts_accpath != (p)->fts_name) { \
1465 (p)->fts_accpath = \
1466 (char *)addr + ((p)->fts_accpath - (p)->fts_path); \
1468 (p)->fts_path = addr; \
1470 /* Adjust the current set of children. */
1471 for (p = sp->fts_child; p; p = p->fts_link)
1474 /* Adjust the rest of the tree, including the current level. */
1475 for (p = head; p->fts_level >= FTS_ROOTLEVEL;) {
1477 p = p->fts_link ? p->fts_link : p->fts_parent;
1483 fts_maxarglen (char * const *argv)
1487 for (max = 0; *argv; ++argv)
1488 if ((len = strlen(*argv)) > max)
1494 * Change to dir specified by fd or file name without getting
1495 * tricked by someone changing the world out from underneath us.
1496 * Assumes p->fts_statp->st_dev and p->fts_statp->st_ino are filled in.
1497 * If FD is non-negative, expect it to be used after this function returns,
1498 * and to be closed eventually. So don't pass e.g., `dirfd(dirp)' and then
1499 * do closedir(dirp), because that would invalidate the saved FD.
1500 * Upon failure, close FD immediately and return nonzero.
1504 fts_safe_changedir (FTS *sp, FTSENT *p, int fd, char const *dir)
1509 if (ISSET(FTS_NOCHDIR)) {
1510 if (ISSET(FTS_CWDFD) && 0 <= fd)
1514 if (fd < 0 && (newfd = diropen (sp, dir)) < 0)
1517 /* The following dev/inode check is necessary if we're doing
1518 a `logical' traversal (through symlinks, a la chown -L),
1519 if the system lacks O_NOFOLLOW support, or if we're changing
1520 to "..". In the latter case, O_NOFOLLOW can't help. In
1521 general (when the target is not ".."), diropen's use of
1522 O_NOFOLLOW ensures we don't mistakenly follow a symlink,
1523 so we can avoid the expense of this fstat. */
1524 if (ISSET(FTS_LOGICAL) || ! HAVE_WORKING_O_NOFOLLOW
1525 || (dir && STREQ (dir, "..")))
1528 if (fstat(newfd, &sb))
1533 if (p->fts_statp->st_dev != sb.st_dev
1534 || p->fts_statp->st_ino != sb.st_ino)
1536 __set_errno (ENOENT); /* disinformation */
1542 if (ISSET(FTS_CWDFD))
1544 cwd_advance_fd (sp, newfd);
1548 ret = fchdir(newfd);
1554 __set_errno (oerrno);