* Copyright (c) 1990, 1993, 1994
* The Regents of the University of California. All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
#if defined(LIBC_SCCS) && !defined(lint)
static char sccsid
[] = "@(#)fts.c 8.6 (Berkeley) 8/14/94";
#endif /* LIBC_SCCS and not lint */
static FTSENT
*fts_alloc
__P((FTS
*, char *, int));
static FTSENT
*fts_build
__P((FTS
*, int));
static void fts_lfree
__P((FTSENT
*));
static void fts_load
__P((FTS
*, FTSENT
*));
static size_t fts_maxarglen
__P((char * const *));
static void fts_padjust
__P((FTS
*, void *));
static int fts_palloc
__P((FTS
*, size_t));
static FTSENT
*fts_sort
__P((FTS
*, FTSENT
*, int));
static u_short fts_stat
__P((FTS
*, FTSENT
*, int));
#define ISDOT(a) (a[0] == '.' && (!a[1] || a[1] == '.' && !a[2]))
#define ISSET(opt) (sp->fts_options & opt)
#define SET(opt) (sp->fts_options |= opt)
#define CHDIR(sp, path) (!ISSET(FTS_NOCHDIR) && chdir(path))
#define FCHDIR(sp, fd) (!ISSET(FTS_NOCHDIR) && fchdir(fd))
#define BCHILD 1 /* fts_children */
#define BNAMES 2 /* fts_children, names only */
#define BREAD 3 /* fts_read */
fts_open(argv
, options
, compar
)
register FTSENT
*p
, *root
;
if (options
& ~FTS_OPTIONMASK
) {
/* Allocate/initialize the stream */
if ((sp
= malloc((u_int
)sizeof(FTS
))) == NULL
)
memset(sp
, 0, sizeof(FTS
));
sp
->fts_options
= options
;
/* Logical walks turn on NOCHDIR; symbolic links are too hard. */
* Start out with 1K of path space, and enough, in any case,
* to hold the user's paths.
if (fts_palloc(sp
, MAX(fts_maxarglen(argv
), MAXPATHLEN
)))
/* Allocate/initialize root's parent. */
if ((parent
= fts_alloc(sp
, "", 0)) == NULL
)
parent
->fts_level
= FTS_ROOTPARENTLEVEL
;
/* Allocate/initialize root(s). */
for (root
= NULL
, nitems
= 0; *argv
; ++argv
, ++nitems
) {
/* Don't allow zero-length paths. */
if ((len
= strlen(*argv
)) == 0) {
p
= fts_alloc(sp
, *argv
, len
);
p
->fts_level
= FTS_ROOTLEVEL
;
p
->fts_accpath
= p
->fts_name
;
p
->fts_info
= fts_stat(sp
, p
, ISSET(FTS_COMFOLLOW
));
/* Command-line "." and ".." are real directories. */
if (p
->fts_info
== FTS_DOT
)
* If comparison routine supplied, traverse in sorted
* order; otherwise traverse in the order specified.
if (compar
&& nitems
> 1)
root
= fts_sort(sp
, root
, nitems
);
* Allocate a dummy pointer and make fts_read think that we've just
* finished the node before the root(s); set p->fts_info to FTS_INIT
* so that everything about the "current" node is ignored.
if ((sp
->fts_cur
= fts_alloc(sp
, "", 0)) == NULL
)
sp
->fts_cur
->fts_link
= root
;
sp
->fts_cur
->fts_info
= FTS_INIT
;
* If using chdir(2), grab a file descriptor pointing to dot to insure
* that we can get back here; this could be avoided for some paths,
* but almost certainly not worth the effort. Slashes, symbolic links,
* and ".." are all fairly nasty problems. Note, if we can't get the
* descriptor we run anyway, just more slowly.
if (!ISSET(FTS_NOCHDIR
) && (sp
->fts_rfd
= open(".", O_RDONLY
, 0)) < 0)
mem2
: free(sp
->fts_path
);
* Load the stream structure for the next traversal. Since we don't
* actually enter the directory until after the preorder visit, set
* the fts_accpath field specially so the chdir gets done to the right
* place and the user can access the first node. From fts_open it's
* known that the path will fit.
len
= p
->fts_pathlen
= p
->fts_namelen
;
memmove(sp
->fts_path
, p
->fts_name
, len
+ 1);
if ((cp
= strrchr(p
->fts_name
, '/')) && (cp
!= p
->fts_name
|| cp
[1])) {
memmove(p
->fts_name
, cp
, len
+ 1);
p
->fts_accpath
= p
->fts_path
= sp
->fts_path
;
sp
->fts_dev
= p
->fts_dev
;
register FTSENT
*freep
, *p
;
* This still works if we haven't read anything -- the dummy structure
* points to the root list, so we step through to the end of the root
* list which has a valid parent pointer.
for (p
= sp
->fts_cur
; p
->fts_level
>= FTS_ROOTLEVEL
;) {
p
= p
->fts_link
? p
->fts_link
: p
->fts_parent
;
/* Free up child linked list, sort array, path buffer. */
fts_lfree(sp
->fts_child
);
/* Return to original directory, save errno if necessary. */
if (!ISSET(FTS_NOCHDIR
)) {
saved_errno
= fchdir(sp
->fts_rfd
) ? errno
: 0;
(void)close(sp
->fts_rfd
);
/* Free up the stream pointer. */
/* Set errno and return. */
if (!ISSET(FTS_NOCHDIR
) && saved_errno
) {
* Special case a root of "/" so that slashes aren't appended which would
* cause paths to be written as "//foo".
(p->fts_level == FTS_ROOTLEVEL && p->fts_pathlen == 1 && \
p->fts_path[0] == '/' ? 0 : p->fts_pathlen)
register FTSENT
*p
, *tmp
;
/* If finished or unrecoverable error, return NULL. */
if (sp
->fts_cur
== NULL
|| ISSET(FTS_STOP
))
/* Set current node pointer. */
/* Save and zero out user instructions. */
p
->fts_instr
= FTS_NOINSTR
;
/* Any type of file may be re-visited; re-stat and re-turn. */
if (instr
== FTS_AGAIN
) {
p
->fts_info
= fts_stat(sp
, p
, 0);
* Following a symlink -- SLNONE test allows application to see
* SLNONE and recover. If indirecting through a symlink, have
* keep a pointer to current location. If unable to get that
if (instr
== FTS_FOLLOW
&&
(p
->fts_info
== FTS_SL
|| p
->fts_info
== FTS_SLNONE
)) {
p
->fts_info
= fts_stat(sp
, p
, 1);
if (p
->fts_info
== FTS_D
&& !ISSET(FTS_NOCHDIR
))
if ((p
->fts_symfd
= open(".", O_RDONLY
, 0)) < 0) {
p
->fts_flags
|= FTS_SYMFOLLOW
;
/* Directory in pre-order. */
if (p
->fts_info
== FTS_D
) {
/* If skipped or crossed mount point, do post-order visit. */
ISSET(FTS_XDEV
) && p
->fts_dev
!= sp
->fts_dev
) {
if (p
->fts_flags
& FTS_SYMFOLLOW
)
(void)close(p
->fts_symfd
);
fts_lfree(sp
->fts_child
);
/* Rebuild if only read the names and now traversing. */
if (sp
->fts_child
&& sp
->fts_options
& FTS_NAMEONLY
) {
sp
->fts_options
&= ~FTS_NAMEONLY
;
fts_lfree(sp
->fts_child
);
* Cd to the subdirectory.
* If have already read and now fail to chdir, whack the list
* to make the names come out right, and set the parent errno
* so the application will eventually get an error condition.
* Set the FTS_DONTCHDIR flag so that when we logically change
* directories back to the parent we don't do a chdir.
* If haven't read do so. If the read fails, fts_build sets
* FTS_STOP or the fts_info field of the node.
if (CHDIR(sp
, p
->fts_accpath
)) {
p
->fts_flags
|= FTS_DONTCHDIR
;
for (p
= sp
->fts_child
; p
; p
= p
->fts_link
)
p
->fts_parent
->fts_accpath
;
} else if ((sp
->fts_child
= fts_build(sp
, BREAD
)) == NULL
) {
/* Move to the next node on this level. */
* If reached the top, return to the original directory, and
* load the paths for the next root.
if (p
->fts_level
== FTS_ROOTLEVEL
) {
if (!ISSET(FTS_NOCHDIR
) && FCHDIR(sp
, sp
->fts_rfd
)) {
return (sp
->fts_cur
= p
);
* User may have called fts_set on the node. If skipped,
* ignore. If followed, get a file descriptor so we can
if (p
->fts_instr
== FTS_SKIP
)
if (p
->fts_instr
== FTS_FOLLOW
) {
p
->fts_info
= fts_stat(sp
, p
, 1);
if (p
->fts_info
== FTS_D
&& !ISSET(FTS_NOCHDIR
))
open(".", O_RDONLY
, 0)) < 0) {
p
->fts_flags
|= FTS_SYMFOLLOW
;
p
->fts_instr
= FTS_NOINSTR
;
name
: t
= sp
->fts_path
+ NAPPEND(p
->fts_parent
);
memmove(t
, p
->fts_name
, p
->fts_namelen
+ 1);
return (sp
->fts_cur
= p
);
/* Move up to the parent node. */
if (p
->fts_level
== FTS_ROOTPARENTLEVEL
) {
* Done; free everything up and set errno to 0 so the user
* can distinguish between error and EOF.
return (sp
->fts_cur
= NULL
);
/* Nul terminate the pathname. */
sp
->fts_path
[p
->fts_pathlen
] = '\0';
* Return to the parent directory. If at a root node or came through
* a symlink, go back through the file descriptor. Otherwise, cd up
if (p
->fts_level
== FTS_ROOTLEVEL
) {
if (!ISSET(FTS_NOCHDIR
) && FCHDIR(sp
, sp
->fts_rfd
)) {
} else if (p
->fts_flags
& FTS_SYMFOLLOW
) {
if (FCHDIR(sp
, p
->fts_symfd
)) {
(void)close(p
->fts_symfd
);
(void)close(p
->fts_symfd
);
} else if (!(p
->fts_flags
& FTS_DONTCHDIR
)) {
p
->fts_info
= p
->fts_errno
? FTS_ERR
: FTS_DP
;
return (sp
->fts_cur
= p
);
* Fts_set takes the stream as an argument although it's not used in this
* implementation; it would be necessary if anyone wanted to add global
* semantics to fts using fts_set. An error return is allowed for similar
if (instr
&& instr
!= FTS_AGAIN
&& instr
!= FTS_FOLLOW
&&
instr
!= FTS_NOINSTR
&& instr
!= FTS_SKIP
) {
if (instr
&& instr
!= FTS_NAMEONLY
) {
/* Set current node pointer. */
* Errno set to 0 so user can distinguish empty directory from
/* Fatal errors stop here. */
/* Return logical hierarchy of user's arguments. */
if (p
->fts_info
== FTS_INIT
)
* If not a directory being visited in pre-order, stop here. Could
* allow FTS_DNR, assuming the user has fixed the problem, but the
* same effect is available with FTS_AGAIN.
if (p
->fts_info
!= FTS_D
/* && p->fts_info != FTS_DNR */)
/* Free up any previous child list. */
fts_lfree(sp
->fts_child
);
if (instr
== FTS_NAMEONLY
) {
sp
->fts_options
|= FTS_NAMEONLY
;
* If using chdir on a relative path and called BEFORE fts_read does
* its chdir to the root of a traversal, we can lose -- we need to
* chdir into the subdirectory, and we don't know where the current
* directory is, so we can't get back so that the upcoming chdir by
if (p
->fts_level
!= FTS_ROOTLEVEL
|| p
->fts_accpath
[0] == '/' ||
return (sp
->fts_child
= fts_build(sp
, instr
));
if ((fd
= open(".", O_RDONLY
, 0)) < 0)
sp
->fts_child
= fts_build(sp
, instr
);
* This is the tricky part -- do not casually change *anything* in here. The
* idea is to build the linked list of entries that are used by fts_children
* and fts_read. There are lots of special cases.
* The real slowdown in walking the tree is the stat calls. If FTS_NOSTAT is
* set and it's a physical walk (so that symbolic links can't be directories),
* we can do things quickly. First, if it's a 4.4BSD file system, the type
* of the file is in the directory entry. Otherwise, we assume that the number
* of subdirectories in a node is equal to the number of links to the parent.
* The former skips all stat calls. The latter skips stat calls in any leaf
* directories and for any files after the subdirectories in the directory have
* been found, cutting the stat calls by about 2/3.
register struct dirent
*dp
;
register FTSENT
*p
, *head
;
int cderrno
, descend
, len
, level
, maxlen
, nlinks
, oflag
, saved_errno
;
/* Set current node pointer. */
* Open the directory for reading. If this fails, we're done.
* If being called from fts_read, set the fts_info field.
oflag
= DTF_NODUP
|DTF_REWIND
;
oflag
= DTF_HIDEW
|DTF_NODUP
|DTF_REWIND
;
#define __opendir2(path, flag) opendir(path)
if ((dirp
= __opendir2(cur
->fts_accpath
, oflag
)) == NULL
) {
* Nlinks is the number of possible entries of type directory in the
* directory if we're cheating on stat calls, 0 if we're not doing
* any stat calls at all, -1 if we're doing stats on everything.
else if (ISSET(FTS_NOSTAT
) && ISSET(FTS_PHYSICAL
))
nlinks
= cur
->fts_nlink
- (ISSET(FTS_SEEDOT
) ? 0 : 2);
(void)printf("nlinks == %d (cur: %d)\n", nlinks
, cur
->fts_nlink
);
(void)printf("NOSTAT %d PHYSICAL %d SEEDOT %d\n",
ISSET(FTS_NOSTAT
), ISSET(FTS_PHYSICAL
), ISSET(FTS_SEEDOT
));
* If we're going to need to stat anything or we want to descend
* and stay in the directory, chdir. If this fails we keep going,
* but set a flag so we don't chdir after the post-order visit.
* We won't be able to stat anything, but we can still return the
* names themselves. Note, that since fts_read won't be able to
* chdir into the directory, it will have to return different path
* names than before, i.e. "a/b" instead of "b". Since the node
* has already been visited in pre-order, have to wait until the
* post-order visit to return the error. There is a special case
* here, if there was nothing to stat then it's not an error to
* not be able to stat. This is all fairly nasty. If a program
* needed sorted entries or stat information, they had better be
* checking FTS_NS on the returned nodes.
if (nlinks
|| type
== BREAD
)
if (FCHDIR(sp
, dirfd(dirp
))) {
if (nlinks
&& type
== BREAD
)
cur
->fts_flags
|= FTS_DONTCHDIR
;
* Figure out the max file name length that can be stored in the
* current path -- the inner loop allocates more path as necessary.
* We really wouldn't have to do the maxlen calculations here, we
* could do them in fts_read before returning the path, but it's a
* lot easier here since the length is part of the dirent structure.
* If not changing directories set a pointer so that can just append
* each new name into the path.
maxlen
= sp
->fts_pathlen
- cur
->fts_pathlen
- 1;
if (ISSET(FTS_NOCHDIR
)) {
level
= cur
->fts_level
+ 1;
/* Read the directory, attaching each entry to the `link' pointer. */
for (head
= tail
= NULL
, nitems
= 0; dp
= readdir(dirp
);) {
if (!ISSET(FTS_SEEDOT
) && ISDOT(dp
->d_name
))
if ((p
= fts_alloc(sp
, dp
->d_name
, (int)dp
->d_namlen
)) == NULL
)
if (dp
->d_namlen
> maxlen
) {
if (fts_palloc(sp
, (size_t)dp
->d_namlen
)) {
* No more memory for path or structures. Save
* errno, free up the current structure and the
* structures already allocated.
mem1
: saved_errno
= errno
;
maxlen
= sp
->fts_pathlen
- sp
->fts_cur
->fts_pathlen
- 1;
p
->fts_pathlen
= len
+ dp
->d_namlen
+ 1;
p
->fts_parent
= sp
->fts_cur
;
if (dp
->d_type
== DT_WHT
)
p
->fts_accpath
= cur
->fts_accpath
;
dp
->d_type
!= DT_DIR
&& dp
->d_type
!= DT_UNKNOWN
ISSET(FTS_NOCHDIR
) ? p
->fts_path
: p
->fts_name
;
/* Build a file name for fts_stat to stat. */
if (ISSET(FTS_NOCHDIR
)) {
p
->fts_accpath
= p
->fts_path
;
memmove(cp
, p
->fts_name
, p
->fts_namelen
+ 1);
p
->fts_accpath
= p
->fts_name
;
p
->fts_info
= fts_stat(sp
, p
, 0);
/* Decrement link count if applicable. */
if (nlinks
> 0 && (p
->fts_info
== FTS_D
||
p
->fts_info
== FTS_DC
|| p
->fts_info
== FTS_DOT
))
/* We walk in directory order so "ls -f" doesn't get upset. */
* If had to realloc the path, adjust the addresses for the rest
fts_padjust(sp
, adjaddr
);
* If not changing directories, reset the path back to original
if (ISSET(FTS_NOCHDIR
)) {
if (cp
- 1 > sp
->fts_path
)
* If descended after called from fts_children or after called from
* fts_read and nothing found, get back. At the root level we use
* the saved fd; if one of fts_open()'s arguments is a relative path
* to an empty directory, we wind up here with no other way back. If
* can't get back, we're done.
if (descend
&& (type
== BCHILD
|| !nitems
) &&
(cur
->fts_level
== FTS_ROOTLEVEL
?
FCHDIR(sp
, sp
->fts_rfd
) : CHDIR(sp
, ".."))) {
/* If didn't find anything, return NULL. */
if (sp
->fts_compar
&& nitems
> 1)
head
= fts_sort(sp
, head
, nitems
);
/* If user needs stat info, stat buffer already allocated. */
sbp
= ISSET(FTS_NOSTAT
) ? &sb
: p
->fts_statp
;
if (p
->fts_flags
& FTS_ISW
) {
memset(sbp
, '\0', sizeof (*sbp
));
* If doing a logical walk, or application requested FTS_FOLLOW, do
* a stat(2). If that fails, check for a non-existent symlink. If
* fail, set the errno from the stat call.
if (ISSET(FTS_LOGICAL
) || follow
) {
if (stat(p
->fts_accpath
, sbp
)) {
if (!lstat(p
->fts_accpath
, sbp
)) {
p
->fts_errno
= saved_errno
;
} else if (lstat(p
->fts_accpath
, sbp
)) {
err
: memset(sbp
, 0, sizeof(struct stat
));
if (S_ISDIR(sbp
->st_mode
)) {
* Set the device/inode. Used to find cycles and check for
* crossing mount points. Also remember the link count, used
* in fts_build to limit the number of stat calls. It is
* understood that these fields are only referenced if fts_info
dev
= p
->fts_dev
= sbp
->st_dev
;
ino
= p
->fts_ino
= sbp
->st_ino
;
p
->fts_nlink
= sbp
->st_nlink
;
* Cycle detection is done by brute force when the directory
* is first encountered. If the tree gets deep enough or the
* number of symbolic links to directories is high enough,
* something faster might be worthwhile.
t
->fts_level
>= FTS_ROOTLEVEL
; t
= t
->fts_parent
)
if (ino
== t
->fts_ino
&& dev
== t
->fts_dev
) {
if (S_ISLNK(sbp
->st_mode
))
if (S_ISREG(sbp
->st_mode
))
fts_sort(sp
, head
, nitems
)
register FTSENT
**ap
, *p
;
* Construct an array of pointers to the structures and call qsort(3).
* Reassemble the array in the order returned by qsort. If unable to
* sort for memory reasons, return the directory entries in their
* current order. Allocate enough space for the current needs plus
* 40 so don't realloc one entry at a time.
if (nitems
> sp
->fts_nitems
) {
sp
->fts_nitems
= nitems
+ 40;
if ((sp
->fts_array
= realloc(sp
->fts_array
,
(size_t)(sp
->fts_nitems
* sizeof(FTSENT
*)))) == NULL
) {
for (ap
= sp
->fts_array
, p
= head
; p
; p
= p
->fts_link
)
qsort((void *)sp
->fts_array
, nitems
, sizeof(FTSENT
*), sp
->fts_compar
);
for (head
= *(ap
= sp
->fts_array
); --nitems
; ++ap
)
fts_alloc(sp
, name
, namelen
)
* The file name is a variable length array and no stat structure is
* necessary if the user has set the nostat bit. Allocate the FTSENT
* structure, the file name and the stat structure in one chunk, but
* be careful that the stat structure is reasonably aligned. Since the
* fts_name field is declared to be of size 1, the fts_name pointer is
* namelen + 2 before the first possible address of the stat structure.
len
= sizeof(FTSENT
) + namelen
;
len
+= sizeof(struct stat
) + ALIGNBYTES
;
if ((p
= malloc(len
)) == NULL
)
/* Copy the name plus the trailing NULL. */
memmove(p
->fts_name
, name
, namelen
+ 1);
p
->fts_statp
= (struct stat
*)ALIGN(p
->fts_name
+ namelen
+ 2);
p
->fts_namelen
= namelen
;
p
->fts_path
= sp
->fts_path
;
p
->fts_instr
= FTS_NOINSTR
;
/* Free a linked list of structures. */
* Allow essentially unlimited paths; find, rm, ls should all work on any tree.
* Most systems will allow creation of paths much longer than MAXPATHLEN, even
* though the kernel won't resolve them. Add the size (not just what's needed)
* plus 256 bytes so don't realloc the path 2 bytes at a time.
sp
->fts_pathlen
+= more
+ 256;
sp
->fts_path
= realloc(sp
->fts_path
, (size_t)sp
->fts_pathlen
);
return (sp
->fts_path
== NULL
);
* When the path is realloc'd, have to fix all of the pointers in structures
(char *)addr + ((p)->fts_accpath - (p)->fts_path); \
/* Adjust the current set of children. */
for (p
= sp
->fts_child
; p
; p
= p
->fts_link
)
/* Adjust the rest of the tree. */
for (p
= sp
->fts_cur
; p
->fts_level
>= FTS_ROOTLEVEL
;) {
p
= p
->fts_link
? p
->fts_link
: p
->fts_parent
;
for (max
= 0; *argv
; ++argv
)
if ((len
= strlen(*argv
)) > max
)