1 /* Traverse a file hierarchy.
3 Copyright (C) 2004-2009 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 3 of the License, or
8 (at your option) any later version.
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, see <http://www.gnu.org/licenses/>. */
19 * Copyright (c) 1990, 1993, 1994
20 * The Regents of the University of California. All rights reserved.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the above copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 4. Neither the name of the University nor the names of its contributors
31 * may be used to endorse or promote products derived from this software
32 * without specific prior written permission.
34 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
35 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49 #if defined(LIBC_SCCS) && !defined(lint)
50 static char sccsid[] = "@(#)fts.c 8.6 (Berkeley) 8/14/94";
51 #endif /* LIBC_SCCS and not lint */
55 #if HAVE_SYS_PARAM_H || defined _LIBC
56 # include <sys/param.h>
59 # include <include/sys/stat.h>
61 # include <sys/stat.h>
72 # include "dirent--.h"
73 # include "unistd--.h"
74 # include "same-inode.h"
78 #ifndef _D_EXACT_NAMLEN
79 # define _D_EXACT_NAMLEN(dirent) strlen ((dirent)->d_name)
82 #if HAVE_STRUCT_DIRENT_D_TYPE
83 /* True if the type of the directory entry D is known. */
84 # define DT_IS_KNOWN(d) ((d)->d_type != DT_UNKNOWN)
85 /* True if the type of the directory entry D must be T. */
86 # define DT_MUST_BE(d, t) ((d)->d_type == (t))
87 # define D_TYPE(d) ((d)->d_type)
89 # define DT_IS_KNOWN(d) false
90 # define DT_MUST_BE(d, t) false
91 # define D_TYPE(d) DT_UNKNOWN
96 /* Any nonzero values will do here, so long as they're distinct.
97 Undef any existing macros out of the way. */
123 NOT_AN_INODE_NUMBER = 0
126 #ifdef D_INO_IN_DIRENT
127 # define D_INO(dp) (dp)->d_ino
129 /* Some systems don't have inodes, so fake them to avoid lots of ifdefs. */
130 # define D_INO(dp) NOT_AN_INODE_NUMBER
133 /* If there are more than this many entries in a directory,
134 and the conditions mentioned below are satisfied, then sort
135 the entries on inode number before any further processing. */
136 #ifndef FTS_INODE_SORT_DIR_ENTRIES_THRESHOLD
137 # define FTS_INODE_SORT_DIR_ENTRIES_THRESHOLD 10000
141 _FTS_INODE_SORT_DIR_ENTRIES_THRESHOLD = FTS_INODE_SORT_DIR_ENTRIES_THRESHOLD
146 FTS_NO_STAT_REQUIRED = 1,
147 FTS_STAT_REQUIRED = 2
152 # define close __close
154 # define closedir __closedir
156 # define fchdir __fchdir
160 # define opendir __opendir
162 # define readdir __readdir
164 # undef internal_function
165 # define internal_function /* empty */
169 # define __set_errno(Val) errno = (Val)
172 #ifndef __attribute__
173 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
174 # define __attribute__(x) /* empty */
178 #ifndef ATTRIBUTE_UNUSED
179 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
182 /* If this host provides the openat function, then we can avoid
183 attempting to open "." in some initialization code below. */
185 # define HAVE_OPENAT_SUPPORT 1
187 # define HAVE_OPENAT_SUPPORT 0
191 # define fts_assert(expr) ((void) 0)
193 # define fts_assert(expr) \
202 static FTSENT *fts_alloc (FTS *, const char *, size_t) internal_function;
203 static FTSENT *fts_build (FTS *, int) internal_function;
204 static void fts_lfree (FTSENT *) internal_function;
205 static void fts_load (FTS *, FTSENT *) internal_function;
206 static size_t fts_maxarglen (char * const *) internal_function;
207 static void fts_padjust (FTS *, FTSENT *) internal_function;
208 static bool fts_palloc (FTS *, size_t) internal_function;
209 static FTSENT *fts_sort (FTS *, FTSENT *, size_t) internal_function;
210 static unsigned short int fts_stat (FTS *, FTSENT *, bool) internal_function;
211 static int fts_safe_changedir (FTS *, FTSENT *, int, const char *)
215 # include "fts-cycle.c"
217 static bool enter_dir (FTS *fts, FTSENT *ent) { return true; }
218 static void leave_dir (FTS *fts, FTSENT *ent) {}
219 static bool setup_dir (FTS *fts) { return true; }
220 static void free_dir (FTS *fts) {}
224 # define MAX(a,b) ((a) > (b) ? (a) : (b))
228 # define SIZE_MAX ((size_t) -1)
231 #define ISDOT(a) (a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
232 #define STREQ(a, b) (strcmp ((a), (b)) == 0)
234 #define CLR(opt) (sp->fts_options &= ~(opt))
235 #define ISSET(opt) (sp->fts_options & (opt))
236 #define SET(opt) (sp->fts_options |= (opt))
238 /* FIXME: make this a function */
239 #define RESTORE_INITIAL_CWD(sp) \
240 (fd_ring_clear (&((sp)->fts_fd_ring)), \
241 FCHDIR ((sp), (ISSET (FTS_CWDFD) ? AT_FDCWD : (sp)->fts_rfd)))
243 /* FIXME: FTS_NOCHDIR is now misnamed.
244 Call it FTS_USE_FULL_RELATIVE_FILE_NAMES instead. */
245 #define FCHDIR(sp, fd) \
246 (!ISSET(FTS_NOCHDIR) && (ISSET(FTS_CWDFD) \
247 ? (cwd_advance_fd ((sp), (fd), true), 0) \
251 /* fts_build flags */
252 /* FIXME: make this an enum */
253 #define BCHILD 1 /* fts_children */
254 #define BNAMES 2 /* fts_children, names only */
255 #define BREAD 3 /* fts_read */
258 # include <inttypes.h>
261 # include "getcwdat.h"
262 bool fts_debug = false;
263 # define Dprintf(x) do { if (fts_debug) printf x; } while (false)
266 # define fd_ring_check(x)
267 # define fd_ring_print(a, b, c)
270 #define LEAVE_DIR(Fts, Ent, Tag) \
273 Dprintf ((" %s-leaving: %s\n", Tag, (Ent)->fts_path)); \
274 leave_dir (Fts, Ent); \
275 fd_ring_check (Fts); \
280 fd_ring_clear (I_ring *fd_ring)
282 while ( ! i_ring_empty (fd_ring))
284 int fd = i_ring_pop (fd_ring);
290 /* Overload the fts_statp->st_size member (otherwise unused, when
291 fts_info is FTS_NSOK) to indicate whether fts_read should stat
292 this entry or not. */
294 fts_set_stat_required (FTSENT *p, bool required)
296 fts_assert (p->fts_info == FTS_NSOK);
297 p->fts_statp->st_size = (required
299 : FTS_NO_STAT_REQUIRED);
302 /* file-descriptor-relative opendir. */
303 /* FIXME: if others need this function, move it into lib/openat.c */
306 opendirat (int fd, char const *dir)
308 int new_fd = openat (fd, dir,
309 O_RDONLY | O_DIRECTORY | O_NOCTTY | O_NONBLOCK);
314 dirp = fdopendir (new_fd);
317 int saved_errno = errno;
324 /* Virtual fchdir. Advance SP's working directory file descriptor,
325 SP->fts_cwd_fd, to FD, and push the previous value onto the fd_ring.
326 CHDIR_DOWN_ONE is true if FD corresponds to an entry in the directory
327 open on sp->fts_cwd_fd; i.e., to move the working directory one level
331 cwd_advance_fd (FTS *sp, int fd, bool chdir_down_one)
333 int old = sp->fts_cwd_fd;
334 fts_assert (old != fd || old == AT_FDCWD);
338 /* Push "old" onto the ring.
339 If the displaced file descriptor is non-negative, close it. */
340 int prev_fd_in_slot = i_ring_push (&sp->fts_fd_ring, old);
341 fd_ring_print (sp, stderr, "post-push");
342 if (0 <= prev_fd_in_slot)
343 close (prev_fd_in_slot); /* ignore any close failure */
345 else if ( ! ISSET (FTS_NOCHDIR))
348 close (old); /* ignore any close failure */
354 /* Open the directory DIR if possible, and return a file
355 descriptor. Return -1 and set errno on failure. It doesn't matter
356 whether the file descriptor has read or write access. */
360 diropen (FTS const *sp, char const *dir)
362 int open_flags = (O_RDONLY | O_DIRECTORY | O_NOCTTY | O_NONBLOCK
363 | (ISSET (FTS_PHYSICAL) ? O_NOFOLLOW : 0));
365 return (ISSET (FTS_CWDFD)
366 ? openat (sp->fts_cwd_fd, dir, open_flags)
367 : open (dir, open_flags));
371 fts_open (char * const *argv,
372 register int options,
373 int (*compar) (FTSENT const **, FTSENT const **))
376 register FTSENT *p, *root;
377 register size_t nitems;
378 FTSENT *parent = NULL;
379 FTSENT *tmp = NULL; /* pacify gcc */
384 if (options & ~FTS_OPTIONMASK) {
385 __set_errno (EINVAL);
388 if ((options & FTS_NOCHDIR) && (options & FTS_CWDFD)) {
389 __set_errno (EINVAL);
392 if ( ! (options & (FTS_LOGICAL | FTS_PHYSICAL))) {
393 __set_errno (EINVAL);
397 /* Allocate/initialize the stream */
398 if ((sp = malloc(sizeof(FTS))) == NULL)
400 memset(sp, 0, sizeof(FTS));
401 sp->fts_compar = compar;
402 sp->fts_options = options;
404 /* Logical walks turn on NOCHDIR; symbolic links are too hard. */
405 if (ISSET(FTS_LOGICAL)) {
410 /* Initialize fts_cwd_fd. */
411 sp->fts_cwd_fd = AT_FDCWD;
412 if ( ISSET(FTS_CWDFD) && ! HAVE_OPENAT_SUPPORT)
414 /* While it isn't technically necessary to open "." this
415 early, doing it here saves us the trouble of ensuring
416 later (where it'd be messier) that "." can in fact
417 be opened. If not, revert to FTS_NOCHDIR mode. */
418 int fd = open (".", O_RDONLY);
421 /* Even if `.' is unreadable, don't revert to FTS_NOCHDIR mode
422 on systems like Linux+PROC_FS, where our openat emulation
423 is good enough. Note: on a system that emulates
424 openat via /proc, this technique can still fail, but
425 only in extreme conditions, e.g., when the working
426 directory cannot be saved (i.e. save_cwd fails) --
427 and that happens on Linux only when "." is unreadable
428 and the CWD would be longer than PATH_MAX.
429 FIXME: once Linux kernel openat support is well established,
430 replace the above open call and this entire if/else block
431 with the body of the if-block below. */
432 if ( openat_needs_fchdir ())
445 * Start out with 1K of file name space, and enough, in any case,
446 * to hold the user's file names.
449 # define MAXPATHLEN 1024
452 size_t maxarglen = fts_maxarglen(argv);
453 if (! fts_palloc(sp, MAX(maxarglen, MAXPATHLEN)))
457 /* Allocate/initialize root's parent. */
459 if ((parent = fts_alloc(sp, "", 0)) == NULL)
461 parent->fts_level = FTS_ROOTPARENTLEVEL;
464 /* The classic fts implementation would call fts_stat with
465 a new entry for each iteration of the loop below.
466 If the comparison function is not specified or if the
467 FTS_DEFER_STAT option is in effect, don't stat any entry
468 in this loop. This is an attempt to minimize the interval
469 between the initial stat/lstat/fstatat and the point at which
470 a directory argument is first opened. This matters for any
471 directory command line argument that resides on a file system
472 without genuine i-nodes. If you specify FTS_DEFER_STAT along
473 with a comparison function, that function must not access any
474 data via the fts_statp pointer. */
475 defer_stat = (compar == NULL || ISSET(FTS_DEFER_STAT));
477 /* Allocate/initialize root(s). */
478 for (root = NULL, nitems = 0; *argv != NULL; ++argv, ++nitems) {
479 /* Don't allow zero-length file names. */
480 if ((len = strlen(*argv)) == 0) {
481 __set_errno (ENOENT);
485 if ((p = fts_alloc(sp, *argv, len)) == NULL)
487 p->fts_level = FTS_ROOTLEVEL;
488 p->fts_parent = parent;
489 p->fts_accpath = p->fts_name;
490 /* Even when defer_stat is true, be sure to stat the first
491 command line argument, since fts_read (at least with
492 FTS_XDEV) requires that. */
493 if (defer_stat && root != NULL) {
494 p->fts_info = FTS_NSOK;
495 fts_set_stat_required(p, true);
497 p->fts_info = fts_stat(sp, p, false);
501 * If comparison routine supplied, traverse in sorted
502 * order; otherwise traverse in the order specified.
517 if (compar && nitems > 1)
518 root = fts_sort(sp, root, nitems);
521 * Allocate a dummy pointer and make fts_read think that we've just
522 * finished the node before the root(s); set p->fts_info to FTS_INIT
523 * so that everything about the "current" node is ignored.
525 if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
527 sp->fts_cur->fts_link = root;
528 sp->fts_cur->fts_info = FTS_INIT;
529 if (! setup_dir (sp))
533 * If using chdir(2), grab a file descriptor pointing to dot to ensure
534 * that we can get back here; this could be avoided for some file names,
535 * but almost certainly not worth the effort. Slashes, symbolic links,
536 * and ".." are all fairly nasty problems. Note, if we can't get the
537 * descriptor we run anyway, just more slowly.
539 if (!ISSET(FTS_NOCHDIR) && !ISSET(FTS_CWDFD)
540 && (sp->fts_rfd = diropen (sp, ".")) < 0)
543 i_ring_init (&sp->fts_fd_ring, -1);
546 mem3: fts_lfree(root);
548 mem2: free(sp->fts_path);
555 fts_load (FTS *sp, register FTSENT *p)
561 * Load the stream structure for the next traversal. Since we don't
562 * actually enter the directory until after the preorder visit, set
563 * the fts_accpath field specially so the chdir gets done to the right
564 * place and the user can access the first node. From fts_open it's
565 * known that the file name will fit.
567 len = p->fts_pathlen = p->fts_namelen;
568 memmove(sp->fts_path, p->fts_name, len + 1);
569 if ((cp = strrchr(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
571 memmove(p->fts_name, cp, len + 1);
572 p->fts_namelen = len;
574 p->fts_accpath = p->fts_path = sp->fts_path;
580 register FTSENT *freep, *p;
584 * This still works if we haven't read anything -- the dummy structure
585 * points to the root list, so we step through to the end of the root
586 * list which has a valid parent pointer.
589 for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
591 p = p->fts_link != NULL ? p->fts_link : p->fts_parent;
597 /* Free up child linked list, sort array, file name buffer. */
599 fts_lfree(sp->fts_child);
603 if (ISSET(FTS_CWDFD))
605 if (0 <= sp->fts_cwd_fd)
606 if (close (sp->fts_cwd_fd))
609 else if (!ISSET(FTS_NOCHDIR))
611 /* Return to original directory, save errno if necessary. */
612 if (fchdir(sp->fts_rfd))
615 /* If close fails, record errno only if saved_errno is zero,
616 so that we report the probably-more-meaningful fchdir errno. */
617 if (close (sp->fts_rfd))
618 if (saved_errno == 0)
622 fd_ring_clear (&sp->fts_fd_ring);
625 if (sp->fts_leaf_optimization_works_ht)
626 hash_free (sp->fts_leaf_optimization_works_ht);
631 /* Free up the stream pointer. */
634 /* Set errno and return. */
636 __set_errno (saved_errno);
643 #if defined __linux__ \
644 && HAVE_SYS_VFS_H && HAVE_FSTATFS && HAVE_STRUCT_STATFS_F_TYPE
648 /* Linux-specific constants from coreutils' src/fs.h */
649 # define S_MAGIC_TMPFS 0x1021994
650 # define S_MAGIC_NFS 0x6969
651 # define S_MAGIC_REISERFS 0x52654973
652 # define S_MAGIC_PROC 0x9FA0
654 /* Return false if it is easy to determine the file system type of
655 the directory on which DIR_FD is open, and sorting dirents on
656 inode numbers is known not to improve traversal performance with
657 that type of file system. Otherwise, return true. */
659 dirent_inode_sort_may_be_useful (int dir_fd)
661 /* Skip the sort only if we can determine efficiently
662 that skipping it is the right thing to do.
663 The cost of performing an unnecessary sort is negligible,
664 while the cost of *not* performing it can be O(N^2) with
665 a very large constant. */
666 struct statfs fs_buf;
668 /* If fstatfs fails, assume sorting would be useful. */
669 if (fstatfs (dir_fd, &fs_buf) != 0)
672 /* FIXME: what about when f_type is not an integral type?
673 deal with that if/when it's encountered. */
674 switch (fs_buf.f_type)
678 /* On a file system of any of these types, sorting
679 is unnecessary, and hence wasteful. */
687 /* Given a file descriptor DIR_FD open on a directory D,
688 return true if it is valid to apply the leaf-optimization
689 technique of counting directories in D via stat.st_nlink. */
691 leaf_optimization_applies (int dir_fd)
693 struct statfs fs_buf;
695 /* If fstatfs fails, assume we can't use the optimization. */
696 if (fstatfs (dir_fd, &fs_buf) != 0)
699 /* FIXME: do we need to detect AFS mount points? I doubt it,
700 unless fstatfs can report S_MAGIC_REISERFS for such a directory. */
702 switch (fs_buf.f_type)
704 /* List here the file system types that lack useable dirent.d_type
705 info, yet for which the optimization does apply. */
706 case S_MAGIC_REISERFS:
710 /* Explicitly listing this or any other file system type for which
711 the optimization is not applicable is not necessary, but we leave
712 it here to document the risk. Per http://bugs.debian.org/143111,
713 /proc may have bogus stat.st_nlink values. */
721 static bool dirent_inode_sort_may_be_useful (int dir_fd) { return true; }
722 static bool leaf_optimization_applies (int dir_fd) { return false; }
726 /* link-count-optimization entry:
727 map an stat.st_dev number to a boolean: leaf_optimization_works */
734 /* Use a tiny initial size. If a traversal encounters more than
735 a few devices, the cost of growing/rehashing this table will be
736 rendered negligible by the number of inodes processed. */
737 enum { LCO_HT_INITIAL_SIZE = 13 };
740 LCO_hash (void const *x, size_t table_size)
742 struct LCO_ent const *ax = x;
743 return (uintmax_t) ax->st_dev % table_size;
747 LCO_compare (void const *x, void const *y)
749 struct LCO_ent const *ax = x;
750 struct LCO_ent const *ay = y;
751 return ax->st_dev == ay->st_dev;
754 /* Ask the same question as leaf_optimization_applies, but query
755 the cache first (FTS.fts_leaf_optimization_works_ht), and if necessary,
756 update that cache. */
758 link_count_optimize_ok (FTSENT const *p)
760 FTS *sp = p->fts_fts;
761 Hash_table *h = sp->fts_leaf_optimization_works_ht;
767 /* If we're not in CWDFD mode, don't bother with this optimization,
768 since the caller is not serious about performance. */
769 if (!ISSET(FTS_CWDFD))
772 /* map st_dev to the boolean, leaf_optimization_works */
775 h = sp->fts_leaf_optimization_works_ht
776 = hash_initialize (LCO_HT_INITIAL_SIZE, NULL, LCO_hash,
781 tmp.st_dev = p->fts_statp->st_dev;
782 ent = hash_lookup (h, &tmp);
786 /* Look-up failed. Query directly and cache the result. */
787 t2 = malloc (sizeof *t2);
791 /* Is it ok to perform the optimization in the dir, FTS_CWD_FD? */
792 opt_ok = leaf_optimization_applies (sp->fts_cwd_fd);
794 t2->st_dev = p->fts_statp->st_dev;
796 ent = hash_insert (h, t2);
799 /* insertion failed */
803 fts_assert (ent == t2);
810 * Special case of "/" at the end of the file name so that slashes aren't
811 * appended which would cause file names to be written as "....//foo".
814 (p->fts_path[p->fts_pathlen - 1] == '/' \
815 ? p->fts_pathlen - 1 : p->fts_pathlen)
818 fts_read (register FTS *sp)
820 register FTSENT *p, *tmp;
821 register unsigned short int instr;
824 /* If finished or unrecoverable error, return NULL. */
825 if (sp->fts_cur == NULL || ISSET(FTS_STOP))
828 /* Set current node pointer. */
831 /* Save and zero out user instructions. */
832 instr = p->fts_instr;
833 p->fts_instr = FTS_NOINSTR;
835 /* Any type of file may be re-visited; re-stat and re-turn. */
836 if (instr == FTS_AGAIN) {
837 p->fts_info = fts_stat(sp, p, false);
840 Dprintf (("fts_read: p=%s\n",
841 p->fts_info == FTS_INIT ? "" : p->fts_path));
844 * Following a symlink -- SLNONE test allows application to see
845 * SLNONE and recover. If indirecting through a symlink, have
846 * keep a pointer to current location. If unable to get that
847 * pointer, follow fails.
849 if (instr == FTS_FOLLOW &&
850 (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
851 p->fts_info = fts_stat(sp, p, true);
852 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
853 if ((p->fts_symfd = diropen (sp, ".")) < 0) {
854 p->fts_errno = errno;
855 p->fts_info = FTS_ERR;
857 p->fts_flags |= FTS_SYMFOLLOW;
862 /* Directory in pre-order. */
863 if (p->fts_info == FTS_D) {
864 /* If skipped or crossed mount point, do post-order visit. */
865 if (instr == FTS_SKIP ||
866 (ISSET(FTS_XDEV) && p->fts_statp->st_dev != sp->fts_dev)) {
867 if (p->fts_flags & FTS_SYMFOLLOW)
868 (void)close(p->fts_symfd);
870 fts_lfree(sp->fts_child);
871 sp->fts_child = NULL;
873 p->fts_info = FTS_DP;
874 LEAVE_DIR (sp, p, "1");
878 /* Rebuild if only read the names and now traversing. */
879 if (sp->fts_child != NULL && ISSET(FTS_NAMEONLY)) {
881 fts_lfree(sp->fts_child);
882 sp->fts_child = NULL;
886 * Cd to the subdirectory.
888 * If have already read and now fail to chdir, whack the list
889 * to make the names come out right, and set the parent errno
890 * so the application will eventually get an error condition.
891 * Set the FTS_DONTCHDIR flag so that when we logically change
892 * directories back to the parent we don't do a chdir.
894 * If haven't read do so. If the read fails, fts_build sets
895 * FTS_STOP or the fts_info field of the node.
897 if (sp->fts_child != NULL) {
898 if (fts_safe_changedir(sp, p, -1, p->fts_accpath)) {
899 p->fts_errno = errno;
900 p->fts_flags |= FTS_DONTCHDIR;
901 for (p = sp->fts_child; p != NULL;
904 p->fts_parent->fts_accpath;
906 } else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
909 /* If fts_build's call to fts_safe_changedir failed
910 because it was not able to fchdir into a
911 subdirectory, tell the caller. */
912 if (p->fts_errno && p->fts_info != FTS_DNR)
913 p->fts_info = FTS_ERR;
914 LEAVE_DIR (sp, p, "2");
918 sp->fts_child = NULL;
922 /* Move to the next node on this level. */
924 if ((p = p->fts_link) != NULL) {
929 * If reached the top, return to the original directory (or
930 * the root of the tree), and load the file names for the next
933 if (p->fts_level == FTS_ROOTLEVEL) {
934 if (RESTORE_INITIAL_CWD(sp)) {
945 * User may have called fts_set on the node. If skipped,
946 * ignore. If followed, get a file descriptor so we can
947 * get back if necessary.
949 if (p->fts_instr == FTS_SKIP)
951 if (p->fts_instr == FTS_FOLLOW) {
952 p->fts_info = fts_stat(sp, p, true);
953 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
954 if ((p->fts_symfd = diropen (sp, ".")) < 0) {
955 p->fts_errno = errno;
956 p->fts_info = FTS_ERR;
958 p->fts_flags |= FTS_SYMFOLLOW;
960 p->fts_instr = FTS_NOINSTR;
963 name: t = sp->fts_path + NAPPEND(p->fts_parent);
965 memmove(t, p->fts_name, p->fts_namelen + 1);
968 if (p->fts_info == FTS_NSOK)
970 if (p->fts_statp->st_size == FTS_STAT_REQUIRED)
972 FTSENT *parent = p->fts_parent;
973 if (FTS_ROOTLEVEL < p->fts_level
974 /* ->fts_n_dirs_remaining is not valid
975 for command-line-specified names. */
976 && parent->fts_n_dirs_remaining == 0
978 && ISSET(FTS_PHYSICAL)
979 && link_count_optimize_ok (parent))
981 /* nothing more needed */
985 p->fts_info = fts_stat(sp, p, false);
986 if (S_ISDIR(p->fts_statp->st_mode)
987 && p->fts_level != FTS_ROOTLEVEL
988 && parent->fts_n_dirs_remaining)
989 parent->fts_n_dirs_remaining--;
993 fts_assert (p->fts_statp->st_size == FTS_NO_STAT_REQUIRED);
996 if (p->fts_info == FTS_D)
998 /* Now that P->fts_statp is guaranteed to be valid,
999 if this is a command-line directory, record its
1000 device number, to be used for FTS_XDEV. */
1001 if (p->fts_level == FTS_ROOTLEVEL)
1002 sp->fts_dev = p->fts_statp->st_dev;
1003 Dprintf ((" entering: %s\n", p->fts_path));
1004 if (! enter_dir (sp, p))
1006 __set_errno (ENOMEM);
1013 /* Move up to the parent node. */
1014 p = tmp->fts_parent;
1018 if (p->fts_level == FTS_ROOTPARENTLEVEL) {
1020 * Done; free everything up and set errno to 0 so the user
1021 * can distinguish between error and EOF.
1025 return (sp->fts_cur = NULL);
1028 fts_assert (p->fts_info != FTS_NSOK);
1030 /* NUL terminate the file name. */
1031 sp->fts_path[p->fts_pathlen] = '\0';
1034 * Return to the parent directory. If at a root node, restore
1035 * the initial working directory. If we came through a symlink,
1036 * go back through the file descriptor. Otherwise, move up
1037 * one level, via "..".
1039 if (p->fts_level == FTS_ROOTLEVEL) {
1040 if (RESTORE_INITIAL_CWD(sp)) {
1041 p->fts_errno = errno;
1044 } else if (p->fts_flags & FTS_SYMFOLLOW) {
1045 if (FCHDIR(sp, p->fts_symfd)) {
1046 int saved_errno = errno;
1047 (void)close(p->fts_symfd);
1048 __set_errno (saved_errno);
1049 p->fts_errno = errno;
1052 (void)close(p->fts_symfd);
1053 } else if (!(p->fts_flags & FTS_DONTCHDIR) &&
1054 fts_safe_changedir(sp, p->fts_parent, -1, "..")) {
1055 p->fts_errno = errno;
1058 p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
1059 if (p->fts_errno == 0)
1060 LEAVE_DIR (sp, p, "3");
1061 return ISSET(FTS_STOP) ? NULL : p;
1065 * Fts_set takes the stream as an argument although it's not used in this
1066 * implementation; it would be necessary if anyone wanted to add global
1067 * semantics to fts using fts_set. An error return is allowed for similar
1072 fts_set(FTS *sp ATTRIBUTE_UNUSED, FTSENT *p, int instr)
1074 if (instr != 0 && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
1075 instr != FTS_NOINSTR && instr != FTS_SKIP) {
1076 __set_errno (EINVAL);
1079 p->fts_instr = instr;
1084 fts_children (register FTS *sp, int instr)
1089 if (instr != 0 && instr != FTS_NAMEONLY) {
1090 __set_errno (EINVAL);
1094 /* Set current node pointer. */
1098 * Errno set to 0 so user can distinguish empty directory from
1103 /* Fatal errors stop here. */
1104 if (ISSET(FTS_STOP))
1107 /* Return logical hierarchy of user's arguments. */
1108 if (p->fts_info == FTS_INIT)
1109 return (p->fts_link);
1112 * If not a directory being visited in pre-order, stop here. Could
1113 * allow FTS_DNR, assuming the user has fixed the problem, but the
1114 * same effect is available with FTS_AGAIN.
1116 if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
1119 /* Free up any previous child list. */
1120 if (sp->fts_child != NULL)
1121 fts_lfree(sp->fts_child);
1123 if (instr == FTS_NAMEONLY) {
1130 * If using chdir on a relative file name and called BEFORE fts_read
1131 * does its chdir to the root of a traversal, we can lose -- we need to
1132 * chdir into the subdirectory, and we don't know where the current
1133 * directory is, so we can't get back so that the upcoming chdir by
1134 * fts_read will work.
1136 if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
1138 return (sp->fts_child = fts_build(sp, instr));
1140 if ((fd = diropen (sp, ".")) < 0)
1141 return (sp->fts_child = NULL);
1142 sp->fts_child = fts_build(sp, instr);
1143 if (ISSET(FTS_CWDFD))
1145 cwd_advance_fd (sp, fd, true);
1151 int saved_errno = errno;
1153 __set_errno (saved_errno);
1158 return (sp->fts_child);
1161 /* A comparison function to sort on increasing inode number.
1162 For some file system types, sorting either way makes a huge
1163 performance difference for a directory with very many entries,
1164 but sorting on increasing values is slightly better than sorting
1165 on decreasing values. The difference is in the 5% range. */
1167 fts_compare_ino (struct _ftsent const **a, struct _ftsent const **b)
1169 return (a[0]->fts_statp->st_ino < b[0]->fts_statp->st_ino ? -1
1170 : b[0]->fts_statp->st_ino < a[0]->fts_statp->st_ino ? 1 : 0);
1173 /* Map the dirent.d_type value, DTYPE, to the corresponding stat.st_mode
1174 S_IF* bit and set ST.st_mode, thus clearing all other bits in that field. */
1176 set_stat_type (struct stat *st, unsigned int dtype)
1209 * This is the tricky part -- do not casually change *anything* in here. The
1210 * idea is to build the linked list of entries that are used by fts_children
1211 * and fts_read. There are lots of special cases.
1213 * The real slowdown in walking the tree is the stat calls. If FTS_NOSTAT is
1214 * set and it's a physical walk (so that symbolic links can't be directories),
1215 * we can do things quickly. First, if it's a 4.4BSD file system, the type
1216 * of the file is in the directory entry. Otherwise, we assume that the number
1217 * of subdirectories in a node is equal to the number of links to the parent.
1218 * The former skips all stat calls. The latter skips stat calls in any leaf
1219 * directories and for any files after the subdirectories in the directory have
1220 * been found, cutting the stat calls by about 2/3.
1224 fts_build (register FTS *sp, int type)
1226 register struct dirent *dp;
1227 register FTSENT *p, *head;
1228 register size_t nitems;
1238 size_t len, maxlen, new_len;
1241 /* Set current node pointer. */
1245 * Open the directory for reading. If this fails, we're done.
1246 * If being called from fts_read, set the fts_info field.
1248 #if defined FTS_WHITEOUT && 0
1249 if (ISSET(FTS_WHITEOUT))
1250 oflag = DTF_NODUP|DTF_REWIND;
1252 oflag = DTF_HIDEW|DTF_NODUP|DTF_REWIND;
1254 # define __opendir2(file, flag) \
1255 ( ! ISSET(FTS_NOCHDIR) && ISSET(FTS_CWDFD) \
1256 ? opendirat(sp->fts_cwd_fd, file) \
1259 if ((dirp = __opendir2(cur->fts_accpath, oflag)) == NULL) {
1260 if (type == BREAD) {
1261 cur->fts_info = FTS_DNR;
1262 cur->fts_errno = errno;
1266 /* Rather than calling fts_stat for each and every entry encountered
1267 in the readdir loop (below), stat each directory only right after
1269 if (cur->fts_info == FTS_NSOK)
1270 cur->fts_info = fts_stat(sp, cur, false);
1273 * Nlinks is the number of possible entries of type directory in the
1274 * directory if we're cheating on stat calls, 0 if we're not doing
1275 * any stat calls at all, (nlink_t) -1 if we're statting everything.
1277 if (type == BNAMES) {
1279 /* Be quiet about nostat, GCC. */
1281 } else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL)) {
1282 nlinks = (cur->fts_statp->st_nlink
1283 - (ISSET(FTS_SEEDOT) ? 0 : 2));
1291 * If we're going to need to stat anything or we want to descend
1292 * and stay in the directory, chdir. If this fails we keep going,
1293 * but set a flag so we don't chdir after the post-order visit.
1294 * We won't be able to stat anything, but we can still return the
1295 * names themselves. Note, that since fts_read won't be able to
1296 * chdir into the directory, it will have to return different file
1297 * names than before, i.e. "a/b" instead of "b". Since the node
1298 * has already been visited in pre-order, have to wait until the
1299 * post-order visit to return the error. There is a special case
1300 * here, if there was nothing to stat then it's not an error to
1301 * not be able to stat. This is all fairly nasty. If a program
1302 * needed sorted entries or stat information, they had better be
1303 * checking FTS_NS on the returned nodes.
1305 if (nlinks || type == BREAD) {
1306 int dir_fd = dirfd(dirp);
1307 if (ISSET(FTS_CWDFD) && 0 <= dir_fd)
1308 dir_fd = dup (dir_fd);
1309 if (dir_fd < 0 || fts_safe_changedir(sp, cur, dir_fd, NULL)) {
1310 if (nlinks && type == BREAD)
1311 cur->fts_errno = errno;
1312 cur->fts_flags |= FTS_DONTCHDIR;
1315 if (ISSET(FTS_CWDFD) && 0 <= dir_fd)
1324 * Figure out the max file name length that can be stored in the
1325 * current buffer -- the inner loop allocates more space as necessary.
1326 * We really wouldn't have to do the maxlen calculations here, we
1327 * could do them in fts_read before returning the name, but it's a
1328 * lot easier here since the length is part of the dirent structure.
1330 * If not changing directories set a pointer so that can just append
1331 * each new component into the file name.
1334 if (ISSET(FTS_NOCHDIR)) {
1335 cp = sp->fts_path + len;
1338 /* GCC, you're too verbose. */
1342 maxlen = sp->fts_pathlen - len;
1344 level = cur->fts_level + 1;
1346 /* Read the directory, attaching each entry to the `link' pointer. */
1348 for (head = tail = NULL, nitems = 0; dirp && (dp = readdir(dirp));) {
1351 if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
1354 if ((p = fts_alloc (sp, dp->d_name,
1355 _D_EXACT_NAMLEN (dp))) == NULL)
1357 if (_D_EXACT_NAMLEN (dp) >= maxlen) {
1358 /* include space for NUL */
1359 oldaddr = sp->fts_path;
1360 if (! fts_palloc(sp, _D_EXACT_NAMLEN (dp) + len + 1)) {
1362 * No more memory. Save
1363 * errno, free up the current structure and the
1364 * structures already allocated.
1366 mem1: saved_errno = errno;
1370 cur->fts_info = FTS_ERR;
1372 __set_errno (saved_errno);
1375 /* Did realloc() change the pointer? */
1376 if (oldaddr != sp->fts_path) {
1378 if (ISSET(FTS_NOCHDIR))
1379 cp = sp->fts_path + len;
1381 maxlen = sp->fts_pathlen - len;
1384 new_len = len + _D_EXACT_NAMLEN (dp);
1385 if (new_len < len) {
1387 * In the unlikely event that we would end up
1388 * with a file name longer than SIZE_MAX, free up
1389 * the current structure and the structures already
1390 * allocated, then error out with ENAMETOOLONG.
1395 cur->fts_info = FTS_ERR;
1397 __set_errno (ENAMETOOLONG);
1400 p->fts_level = level;
1401 p->fts_parent = sp->fts_cur;
1402 p->fts_pathlen = new_len;
1404 #if defined FTS_WHITEOUT && 0
1405 if (dp->d_type == DT_WHT)
1406 p->fts_flags |= FTS_ISW;
1408 /* Store dirent.d_ino, in case we need to sort
1409 entries before processing them. */
1410 p->fts_statp->st_ino = D_INO (dp);
1412 /* Build a file name for fts_stat to stat. */
1413 if (ISSET(FTS_NOCHDIR)) {
1414 p->fts_accpath = p->fts_path;
1415 memmove(cp, p->fts_name, p->fts_namelen + 1);
1417 p->fts_accpath = p->fts_name;
1419 if (sp->fts_compar == NULL || ISSET(FTS_DEFER_STAT)) {
1420 /* Record what fts_read will have to do with this
1421 entry. In many cases, it will simply fts_stat it,
1422 but we can take advantage of any d_type information
1423 to optimize away the unnecessary stat calls. I.e.,
1424 if FTS_NOSTAT is in effect and we're not following
1425 symlinks (FTS_PHYSICAL) and d_type indicates this
1426 is *not* a directory, then we won't have to stat it
1427 at all. If it *is* a directory, then (currently)
1428 we stat it regardless, in order to get device and
1429 inode numbers. Some day we might optimize that
1430 away, too, for directories where d_ino is known to
1432 bool skip_stat = (ISSET(FTS_PHYSICAL)
1433 && ISSET(FTS_NOSTAT)
1435 && ! DT_MUST_BE(dp, DT_DIR));
1436 p->fts_info = FTS_NSOK;
1437 /* Propagate dirent.d_type information back
1438 to caller, when possible. */
1439 set_stat_type (p->fts_statp, D_TYPE (dp));
1440 fts_set_stat_required(p, !skip_stat);
1441 is_dir = (ISSET(FTS_PHYSICAL)
1442 && DT_MUST_BE(dp, DT_DIR));
1444 p->fts_info = fts_stat(sp, p, false);
1445 is_dir = (p->fts_info == FTS_D
1446 || p->fts_info == FTS_DC
1447 || p->fts_info == FTS_DOT);
1450 /* Decrement link count if applicable. */
1451 if (nlinks > 0 && is_dir)
1454 /* We walk in directory order so "ls -f" doesn't get upset. */
1468 * If realloc() changed the address of the file name, adjust the
1469 * addresses for the rest of the tree and the dir list.
1472 fts_padjust(sp, head);
1475 * If not changing directories, reset the file name back to original
1478 if (ISSET(FTS_NOCHDIR)) {
1479 if (len == sp->fts_pathlen || nitems == 0)
1485 * If descended after called from fts_children or after called from
1486 * fts_read and nothing found, get back. At the root level we use
1487 * the saved fd; if one of fts_open()'s arguments is a relative name
1488 * to an empty directory, we wind up here with no other way back. If
1489 * can't get back, we're done.
1491 if (descend && (type == BCHILD || !nitems) &&
1492 (cur->fts_level == FTS_ROOTLEVEL
1493 ? RESTORE_INITIAL_CWD(sp)
1494 : fts_safe_changedir(sp, cur->fts_parent, -1, ".."))) {
1495 cur->fts_info = FTS_ERR;
1501 /* If didn't find anything, return NULL. */
1504 cur->fts_info = FTS_DP;
1509 /* If there are many entries, no sorting function has been specified,
1510 and this file system is of a type that may be slow with a large
1511 number of entries, then sort the directory entries on increasing
1513 if (nitems > _FTS_INODE_SORT_DIR_ENTRIES_THRESHOLD
1515 && ISSET (FTS_CWDFD)
1516 && dirent_inode_sort_may_be_useful (sp->fts_cwd_fd)) {
1517 sp->fts_compar = fts_compare_ino;
1518 head = fts_sort (sp, head, nitems);
1519 sp->fts_compar = NULL;
1522 /* Sort the entries. */
1523 if (sp->fts_compar && nitems > 1)
1524 head = fts_sort(sp, head, nitems);
1530 /* Walk ->fts_parent links starting at E_CURR, until the root of the
1531 current hierarchy. There should be a directory with dev/inode
1532 matching those of AD. If not, print a lot of diagnostics. */
1534 find_matching_ancestor (FTSENT const *e_curr, struct Active_dir const *ad)
1537 for (ent = e_curr; ent->fts_level >= FTS_ROOTLEVEL; ent = ent->fts_parent)
1539 if (ad->ino == ent->fts_statp->st_ino
1540 && ad->dev == ent->fts_statp->st_dev)
1543 printf ("ERROR: tree dir, %s, not active\n", ad->fts_ent->fts_accpath);
1544 printf ("active dirs:\n");
1546 ent->fts_level >= FTS_ROOTLEVEL; ent = ent->fts_parent)
1547 printf (" %s(%"PRIuMAX"/%"PRIuMAX") to %s(%"PRIuMAX"/%"PRIuMAX")...\n",
1548 ad->fts_ent->fts_accpath,
1549 (uintmax_t) ad->dev,
1550 (uintmax_t) ad->ino,
1552 (uintmax_t) ent->fts_statp->st_dev,
1553 (uintmax_t) ent->fts_statp->st_ino);
1557 fts_cross_check (FTS const *sp)
1559 FTSENT const *ent = sp->fts_cur;
1561 if ( ! ISSET (FTS_TIGHT_CYCLE_CHECK))
1564 Dprintf (("fts-cross-check cur=%s\n", ent->fts_path));
1565 /* Make sure every parent dir is in the tree. */
1566 for (t = ent->fts_parent; t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
1568 struct Active_dir ad;
1569 ad.ino = t->fts_statp->st_ino;
1570 ad.dev = t->fts_statp->st_dev;
1571 if ( ! hash_lookup (sp->fts_cycle.ht, &ad))
1572 printf ("ERROR: active dir, %s, not in tree\n", t->fts_path);
1575 /* Make sure every dir in the tree is an active dir.
1576 But ENT is not necessarily a directory. If so, just skip this part. */
1577 if (ent->fts_parent->fts_level >= FTS_ROOTLEVEL
1578 && (ent->fts_info == FTS_DP
1579 || ent->fts_info == FTS_D))
1581 struct Active_dir *ad;
1582 for (ad = hash_get_first (sp->fts_cycle.ht); ad != NULL;
1583 ad = hash_get_next (sp->fts_cycle.ht, ad))
1585 find_matching_ancestor (ent, ad);
1591 same_fd (int fd1, int fd2)
1593 struct stat sb1, sb2;
1594 return (fstat (fd1, &sb1) == 0
1595 && fstat (fd2, &sb2) == 0
1596 && SAME_INODE (sb1, sb2));
1600 fd_ring_print (FTS const *sp, FILE *stream, char const *msg)
1602 I_ring const *fd_ring = &sp->fts_fd_ring;
1603 unsigned int i = fd_ring->fts_front;
1604 char *cwd = getcwdat (sp->fts_cwd_fd, NULL, 0);
1605 fprintf (stream, "=== %s ========== %s\n", msg, cwd);
1607 if (i_ring_empty (fd_ring))
1612 int fd = fd_ring->fts_fd_ring[i];
1614 fprintf (stream, "%d: %d:\n", i, fd);
1617 char *wd = getcwdat (fd, NULL, 0);
1618 fprintf (stream, "%d: %d: %s\n", i, fd, wd);
1621 if (i == fd_ring->fts_back)
1623 i = (i + I_RING_SIZE - 1) % I_RING_SIZE;
1627 /* Ensure that each file descriptor on the fd_ring matches a
1628 parent, grandparent, etc. of the current working directory. */
1630 fd_ring_check (FTS const *sp)
1635 /* Make a writable copy. */
1636 I_ring fd_w = sp->fts_fd_ring;
1638 int cwd_fd = sp->fts_cwd_fd;
1639 cwd_fd = dup (cwd_fd);
1640 char *dot = getcwdat (cwd_fd, NULL, 0);
1641 error (0, 0, "===== check ===== cwd: %s", dot);
1643 while ( ! i_ring_empty (&fd_w))
1645 int fd = i_ring_pop (&fd_w);
1648 int parent_fd = openat (cwd_fd, "..", O_RDONLY);
1654 if (!same_fd (fd, parent_fd))
1656 char *cwd = getcwdat (fd, NULL, 0);
1657 error (0, errno, "ring : %s", cwd);
1658 char *c2 = getcwdat (parent_fd, NULL, 0);
1659 error (0, errno, "parent: %s", c2);
1672 static unsigned short int
1674 fts_stat(FTS *sp, register FTSENT *p, bool follow)
1676 struct stat *sbp = p->fts_statp;
1679 if (p->fts_level == FTS_ROOTLEVEL && ISSET(FTS_COMFOLLOW))
1682 #if defined FTS_WHITEOUT && 0
1683 /* check for whiteout */
1684 if (p->fts_flags & FTS_ISW) {
1685 memset(sbp, '\0', sizeof (*sbp));
1686 sbp->st_mode = S_IFWHT;
1692 * If doing a logical walk, or application requested FTS_FOLLOW, do
1693 * a stat(2). If that fails, check for a non-existent symlink. If
1694 * fail, set the errno from the stat call.
1696 if (ISSET(FTS_LOGICAL) || follow) {
1697 if (stat(p->fts_accpath, sbp)) {
1698 saved_errno = errno;
1700 && lstat(p->fts_accpath, sbp) == 0) {
1702 return (FTS_SLNONE);
1704 p->fts_errno = saved_errno;
1707 } else if (fstatat(sp->fts_cwd_fd, p->fts_accpath, sbp,
1708 AT_SYMLINK_NOFOLLOW)) {
1709 p->fts_errno = errno;
1710 err: memset(sbp, 0, sizeof(struct stat));
1714 if (S_ISDIR(sbp->st_mode)) {
1715 p->fts_n_dirs_remaining = (sbp->st_nlink
1716 - (ISSET(FTS_SEEDOT) ? 0 : 2));
1717 if (ISDOT(p->fts_name)) {
1718 /* Command-line "." and ".." are real directories. */
1719 return (p->fts_level == FTS_ROOTLEVEL ? FTS_D : FTS_DOT);
1725 * Cycle detection is done by brute force when the directory
1726 * is first encountered. If the tree gets deep enough or the
1727 * number of symbolic links to directories is high enough,
1728 * something faster might be worthwhile.
1732 for (t = p->fts_parent;
1733 t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
1734 if (sbp->st_ino == t->fts_statp->st_ino
1735 && sbp->st_dev == t->fts_statp->st_dev)
1745 if (S_ISLNK(sbp->st_mode))
1747 if (S_ISREG(sbp->st_mode))
1749 return (FTS_DEFAULT);
1753 fts_compar (void const *a, void const *b)
1755 /* Convert A and B to the correct types, to pacify the compiler, and
1756 for portability to bizarre hosts where "void const *" and "FTSENT
1757 const **" differ in runtime representation. The comparison
1758 function cannot modify *a and *b, but there is no compile-time
1760 FTSENT const **pa = (FTSENT const **) a;
1761 FTSENT const **pb = (FTSENT const **) b;
1762 return pa[0]->fts_fts->fts_compar (pa, pb);
1767 fts_sort (FTS *sp, FTSENT *head, register size_t nitems)
1769 register FTSENT **ap, *p;
1771 /* On most modern hosts, void * and FTSENT ** have the same
1772 run-time representation, and one can convert sp->fts_compar to
1773 the type qsort expects without problem. Use the heuristic that
1774 this is OK if the two pointer types are the same size, and if
1775 converting FTSENT ** to long int is the same as converting
1776 FTSENT ** to void * and then to long int. This heuristic isn't
1777 valid in general but we don't know of any counterexamples. */
1779 int (*compare) (void const *, void const *) =
1780 ((sizeof &dummy == sizeof (void *)
1781 && (long int) &dummy == (long int) (void *) &dummy)
1782 ? (int (*) (void const *, void const *)) sp->fts_compar
1786 * Construct an array of pointers to the structures and call qsort(3).
1787 * Reassemble the array in the order returned by qsort. If unable to
1788 * sort for memory reasons, return the directory entries in their
1789 * current order. Allocate enough space for the current needs plus
1790 * 40 so don't realloc one entry at a time.
1792 if (nitems > sp->fts_nitems) {
1795 sp->fts_nitems = nitems + 40;
1796 if (SIZE_MAX / sizeof *a < sp->fts_nitems
1797 || ! (a = realloc (sp->fts_array,
1798 sp->fts_nitems * sizeof *a))) {
1799 free(sp->fts_array);
1800 sp->fts_array = NULL;
1806 for (ap = sp->fts_array, p = head; p; p = p->fts_link)
1808 qsort((void *)sp->fts_array, nitems, sizeof(FTSENT *), compare);
1809 for (head = *(ap = sp->fts_array); --nitems; ++ap)
1810 ap[0]->fts_link = ap[1];
1811 ap[0]->fts_link = NULL;
1817 fts_alloc (FTS *sp, const char *name, register size_t namelen)
1823 * The file name is a variable length array. Allocate the FTSENT
1824 * structure and the file name in one chunk.
1826 len = sizeof(FTSENT) + namelen;
1827 if ((p = malloc(len)) == NULL)
1830 /* Copy the name and guarantee NUL termination. */
1831 memmove(p->fts_name, name, namelen);
1832 p->fts_name[namelen] = '\0';
1834 p->fts_namelen = namelen;
1836 p->fts_path = sp->fts_path;
1839 p->fts_instr = FTS_NOINSTR;
1841 p->fts_pointer = NULL;
1847 fts_lfree (register FTSENT *head)
1851 /* Free a linked list of structures. */
1852 while ((p = head)) {
1853 head = head->fts_link;
1859 * Allow essentially unlimited file name lengths; find, rm, ls should
1860 * all work on any tree. Most systems will allow creation of file
1861 * names much longer than MAXPATHLEN, even though the kernel won't
1862 * resolve them. Add the size (not just what's needed) plus 256 bytes
1863 * so don't realloc the file name 2 bytes at a time.
1867 fts_palloc (FTS *sp, size_t more)
1870 size_t new_len = sp->fts_pathlen + more + 256;
1873 * See if fts_pathlen would overflow.
1875 if (new_len < sp->fts_pathlen) {
1877 sp->fts_path = NULL;
1878 __set_errno (ENAMETOOLONG);
1881 sp->fts_pathlen = new_len;
1882 p = realloc(sp->fts_path, sp->fts_pathlen);
1885 sp->fts_path = NULL;
1893 * When the file name is realloc'd, have to fix all of the pointers in
1894 * structures already returned.
1898 fts_padjust (FTS *sp, FTSENT *head)
1901 char *addr = sp->fts_path;
1903 #define ADJUST(p) do { \
1904 if ((p)->fts_accpath != (p)->fts_name) { \
1905 (p)->fts_accpath = \
1906 (char *)addr + ((p)->fts_accpath - (p)->fts_path); \
1908 (p)->fts_path = addr; \
1910 /* Adjust the current set of children. */
1911 for (p = sp->fts_child; p; p = p->fts_link)
1914 /* Adjust the rest of the tree, including the current level. */
1915 for (p = head; p->fts_level >= FTS_ROOTLEVEL;) {
1917 p = p->fts_link ? p->fts_link : p->fts_parent;
1923 fts_maxarglen (char * const *argv)
1927 for (max = 0; *argv; ++argv)
1928 if ((len = strlen(*argv)) > max)
1934 * Change to dir specified by fd or file name without getting
1935 * tricked by someone changing the world out from underneath us.
1936 * Assumes p->fts_statp->st_dev and p->fts_statp->st_ino are filled in.
1937 * If FD is non-negative, expect it to be used after this function returns,
1938 * and to be closed eventually. So don't pass e.g., `dirfd(dirp)' and then
1939 * do closedir(dirp), because that would invalidate the saved FD.
1940 * Upon failure, close FD immediately and return nonzero.
1944 fts_safe_changedir (FTS *sp, FTSENT *p, int fd, char const *dir)
1947 bool is_dotdot = dir && STREQ (dir, "..");
1950 /* This clause handles the unusual case in which FTS_NOCHDIR
1951 is specified, along with FTS_CWDFD. In that case, there is
1952 no need to change even the virtual cwd file descriptor.
1953 However, if FD is non-negative, we do close it here. */
1954 if (ISSET (FTS_NOCHDIR))
1956 if (ISSET (FTS_CWDFD) && 0 <= fd)
1961 if (fd < 0 && is_dotdot && ISSET (FTS_CWDFD))
1963 /* When possible, skip the diropen and subsequent fstat+dev/ino
1964 comparison. I.e., when changing to parent directory
1965 (chdir ("..")), use a file descriptor from the ring and
1966 save the overhead of diropen+fstat, as well as avoiding
1967 failure when we lack "x" access to the virtual cwd. */
1968 if ( ! i_ring_empty (&sp->fts_fd_ring))
1971 fd_ring_print (sp, stderr, "pre-pop");
1972 parent_fd = i_ring_pop (&sp->fts_fd_ring);
1983 if (fd < 0 && (newfd = diropen (sp, dir)) < 0)
1986 /* The following dev/inode check is necessary if we're doing a
1987 `logical' traversal (through symlinks, a la chown -L), if the
1988 system lacks O_NOFOLLOW support, or if we're changing to ".."
1989 (but not via a popped file descriptor). When changing to the
1990 name "..", O_NOFOLLOW can't help. In general, when the target is
1991 not "..", diropen's use of O_NOFOLLOW ensures we don't mistakenly
1992 follow a symlink, so we can avoid the expense of this fstat. */
1993 if (ISSET(FTS_LOGICAL) || ! HAVE_WORKING_O_NOFOLLOW
1994 || (dir && STREQ (dir, "..")))
1997 if (fstat(newfd, &sb))
2002 if (p->fts_statp->st_dev != sb.st_dev
2003 || p->fts_statp->st_ino != sb.st_ino)
2005 __set_errno (ENOENT); /* disinformation */
2011 if (ISSET(FTS_CWDFD))
2013 cwd_advance_fd (sp, newfd, ! is_dotdot);
2017 ret = fchdir(newfd);
2023 __set_errno (oerrno);