Also check for the log_user method, to avoid
[coreutils.git] / lib / fts.c
blob69e52ded4f956cbaac86b6bf7df1b276dff30ede
1 /*-
2 * Copyright (c) 1990, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
30 #ifdef HAVE_CONFIG_H
31 # include <config.h>
32 #endif
34 #if defined(LIBC_SCCS) && !defined(lint)
35 static char sccsid[] = "@(#)fts.c 8.6 (Berkeley) 8/14/94";
36 #endif /* LIBC_SCCS and not lint */
38 #if HAVE_SYS_PARAM_H || defined _LIBC
39 # include <sys/param.h>
40 #endif
41 #ifdef _LIBC
42 # include <include/sys/stat.h>
43 #else
44 # include <sys/stat.h>
45 #endif
46 #include <fcntl.h>
47 #include <errno.h>
48 #include <fts.h>
49 #include <search.h>
50 #include <stdlib.h>
51 #include <string.h>
52 #include <unistd.h>
54 #if defined _LIBC
55 # include <dirent.h>
56 # define NAMLEN(dirent) _D_EXACT_NAMLEN (dirent)
57 #else
58 # if HAVE_DIRENT_H
59 # include <dirent.h>
60 # define NAMLEN(dirent) strlen ((dirent)->d_name)
61 # else
62 # define dirent direct
63 # define NAMLEN(dirent) (dirent)->d_namlen
64 # if HAVE_SYS_NDIR_H
65 # include <sys/ndir.h>
66 # endif
67 # if HAVE_SYS_DIR_H
68 # include <sys/dir.h>
69 # endif
70 # if HAVE_NDIR_H
71 # include <ndir.h>
72 # endif
73 # endif
74 #endif
76 #ifdef _LIBC
77 # undef close
78 # define close __close
79 # undef closedir
80 # define closedir __closedir
81 # undef fchdir
82 # define fchdir __fchdir
83 # undef open
84 # define open __open
85 # undef opendir
86 # define opendir __opendir
87 # undef readdir
88 # define readdir __readdir
89 # undef tdestroy
90 # define tdestroy __tdestroy
91 # undef tfind
92 # define tfind __tfind
93 # undef tsearch
94 # define tsearch __tsearch
95 #else
96 # undef internal_function
97 # define internal_function /* empty */
98 #endif
100 /* Arrange to make lstat calls go through the wrapper function
101 on systems with an lstat function that does not dereference symlinks
102 that are specified with a trailing slash. */
103 #if ! _LIBC && ! LSTAT_FOLLOWS_SLASHED_SYMLINK
104 int rpl_lstat (const char *, struct stat *);
105 # undef lstat
106 # define lstat(Name, Stat_buf) rpl_lstat(Name, Stat_buf)
107 #endif
109 #ifndef __set_errno
110 # define __set_errno(Val) errno = (Val)
111 #endif
113 /* Largest alignment size needed, minus one.
114 Usually long double is the worst case. */
115 #ifndef ALIGNBYTES
116 # define ALIGNBYTES (__alignof__ (long double) - 1)
117 #endif
118 /* Align P to that size. */
119 #ifndef ALIGN
120 # define ALIGN(p) (((unsigned long int) (p) + ALIGNBYTES) & ~ALIGNBYTES)
121 #endif
124 static FTSENT *fts_alloc __P((FTS *, const char *, int)) internal_function;
125 static FTSENT *fts_build __P((FTS *, int)) internal_function;
126 static void fts_lfree __P((FTSENT *)) internal_function;
127 static void fts_load __P((FTS *, FTSENT *)) internal_function;
128 static size_t fts_maxarglen __P((char * const *)) internal_function;
129 static void fts_padjust __P((FTS *, FTSENT *)) internal_function;
130 static int fts_palloc __P((FTS *, size_t)) internal_function;
131 static FTSENT *fts_sort __P((FTS *, FTSENT *, int)) internal_function;
132 static u_short fts_stat __P((FTS *, FTSENT *, int)) internal_function;
133 static int fts_safe_changedir __P((FTS *, FTSENT *, int, const char *))
134 internal_function;
136 #ifndef MAX
137 # define MAX(a, b) ({ __typeof__ (a) _a = (a); \
138 __typeof__ (b) _b = (b); \
139 _a > _b ? _a : _b; })
140 #endif
142 #define ISDOT(a) (a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
144 #define CLR(opt) (sp->fts_options &= ~(opt))
145 #define ISSET(opt) (sp->fts_options & (opt))
146 #define SET(opt) (sp->fts_options |= (opt))
148 #define FCHDIR(sp, fd) (!ISSET(FTS_NOCHDIR) && fchdir(fd))
150 /* fts_build flags */
151 #define BCHILD 1 /* fts_children */
152 #define BNAMES 2 /* fts_children, names only */
153 #define BREAD 3 /* fts_read */
155 struct known_object
157 dev_t dev;
158 ino_t ino;
159 FTSENT *fts_ent;
162 static int
163 object_compare (const void *p1, const void *p2)
165 /* We don't need a sophisticated and useful comparison. We are only
166 interested in equality. However, we must be careful not to
167 accidentally compare `holes' in the structure. */
168 const struct known_object *kp1 = p1, *kp2 = p2;
169 int cmp1;
170 cmp1 = (kp1->ino > kp2->ino) - (kp1->ino < kp2->ino);
171 if (cmp1 != 0)
172 return cmp1;
173 return (kp1->dev > kp2->dev) - (kp1->dev < kp2->dev);
176 static inline int
177 add_object (FTS *fts, FTSENT *data, const struct stat *st)
179 struct known_object *newp = malloc (sizeof (struct known_object));
180 if (newp == NULL)
181 return -1;
182 newp->dev = st->st_dev;
183 newp->ino = st->st_ino;
184 newp->fts_ent = data;
185 return tsearch (newp, &fts->fts_dir_signatures, object_compare) ? 0 : -1;
188 static inline FTSENT *
189 find_object (const FTS *fts, const struct stat *st)
191 struct known_object obj;
192 struct known_object const *t;
193 obj.dev = st->st_dev;
194 obj.ino = st->st_ino;
195 t = tfind (&obj, &fts->fts_dir_signatures, object_compare);
196 return t ? t->fts_ent : NULL;
199 FTS *
200 fts_open(argv, options, compar)
201 char * const *argv;
202 register int options;
203 int (*compar) __P((const FTSENT **, const FTSENT **));
205 register FTS *sp;
206 register FTSENT *p, *root;
207 register int nitems;
208 FTSENT *parent, *tmp = NULL; /* pacify gcc */
209 int len;
211 /* Options check. */
212 if (options & ~FTS_OPTIONMASK) {
213 __set_errno (EINVAL);
214 return (NULL);
217 /* Allocate/initialize the stream */
218 if ((sp = malloc((u_int)sizeof(FTS))) == NULL)
219 return (NULL);
220 memset(sp, 0, sizeof(FTS));
221 sp->fts_compar = (int (*) __P((const void *, const void *))) compar;
222 sp->fts_options = options;
224 /* Logical walks turn on NOCHDIR; symbolic links are too hard. */
225 if (ISSET(FTS_LOGICAL))
226 SET(FTS_NOCHDIR);
229 * Start out with 1K of path space, and enough, in any case,
230 * to hold the user's paths.
232 #ifndef MAXPATHLEN
233 # define MAXPATHLEN 1024
234 #endif
235 if (fts_palloc(sp, MAX(fts_maxarglen(argv), MAXPATHLEN)))
236 goto mem1;
238 /* Allocate/initialize root's parent. */
239 if ((parent = fts_alloc(sp, "", 0)) == NULL)
240 goto mem2;
241 parent->fts_level = FTS_ROOTPARENTLEVEL;
243 /* Allocate/initialize root(s). */
244 for (root = NULL, nitems = 0; *argv != NULL; ++argv, ++nitems) {
245 /* Don't allow zero-length paths. */
246 if ((len = strlen(*argv)) == 0) {
247 __set_errno (ENOENT);
248 goto mem3;
251 if ((p = fts_alloc(sp, *argv, len)) == NULL)
252 goto mem3;
253 p->fts_level = FTS_ROOTLEVEL;
254 p->fts_parent = parent;
255 p->fts_accpath = p->fts_name;
256 p->fts_info = fts_stat(sp, p, ISSET(FTS_COMFOLLOW));
258 /* Command-line "." and ".." are real directories. */
259 if (p->fts_info == FTS_DOT)
260 p->fts_info = FTS_D;
263 * If comparison routine supplied, traverse in sorted
264 * order; otherwise traverse in the order specified.
266 if (compar) {
267 p->fts_link = root;
268 root = p;
269 } else {
270 p->fts_link = NULL;
271 if (root == NULL)
272 tmp = root = p;
273 else {
274 tmp->fts_link = p;
275 tmp = p;
279 if (compar && nitems > 1)
280 root = fts_sort(sp, root, nitems);
283 * Allocate a dummy pointer and make fts_read think that we've just
284 * finished the node before the root(s); set p->fts_info to FTS_INIT
285 * so that everything about the "current" node is ignored.
287 if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
288 goto mem3;
289 sp->fts_cur->fts_link = root;
290 sp->fts_cur->fts_info = FTS_INIT;
292 sp->fts_dir_signatures = NULL;
295 * If using chdir(2), grab a file descriptor pointing to dot to ensure
296 * that we can get back here; this could be avoided for some paths,
297 * but almost certainly not worth the effort. Slashes, symbolic links,
298 * and ".." are all fairly nasty problems. Note, if we can't get the
299 * descriptor we run anyway, just more slowly.
301 if (!ISSET(FTS_NOCHDIR)
302 && (sp->fts_rfd = open(".", O_RDONLY, 0)) < 0)
303 SET(FTS_NOCHDIR);
305 return (sp);
307 mem3: fts_lfree(root);
308 free(parent);
309 mem2: free(sp->fts_path);
310 mem1: free(sp);
311 return (NULL);
314 static void
315 internal_function
316 fts_load(sp, p)
317 FTS *sp;
318 register FTSENT *p;
320 register int len;
321 register char *cp;
324 * Load the stream structure for the next traversal. Since we don't
325 * actually enter the directory until after the preorder visit, set
326 * the fts_accpath field specially so the chdir gets done to the right
327 * place and the user can access the first node. From fts_open it's
328 * known that the path will fit.
330 len = p->fts_pathlen = p->fts_namelen;
331 memmove(sp->fts_path, p->fts_name, len + 1);
332 if ((cp = strrchr(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
333 len = strlen(++cp);
334 memmove(p->fts_name, cp, len + 1);
335 p->fts_namelen = len;
337 p->fts_accpath = p->fts_path = sp->fts_path;
338 sp->fts_dev = p->fts_dev;
342 fts_close(sp)
343 FTS *sp;
345 register FTSENT *freep, *p;
346 int saved_errno = 0;
349 * This still works if we haven't read anything -- the dummy structure
350 * points to the root list, so we step through to the end of the root
351 * list which has a valid parent pointer.
353 if (sp->fts_cur) {
354 for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
355 freep = p;
356 p = p->fts_link != NULL ? p->fts_link : p->fts_parent;
357 free(freep);
359 free(p);
362 /* Free up child linked list, sort array, path buffer. */
363 if (sp->fts_child)
364 fts_lfree(sp->fts_child);
365 if (sp->fts_array)
366 free(sp->fts_array);
367 free(sp->fts_path);
369 /* Return to original directory, save errno if necessary. */
370 if (!ISSET(FTS_NOCHDIR)) {
371 if (fchdir(sp->fts_rfd))
372 saved_errno = errno;
373 (void)close(sp->fts_rfd);
376 /* Free all of the directory fingerprint info. */
377 tdestroy (sp->fts_dir_signatures, free);
379 /* Free up the stream pointer. */
380 free(sp);
382 /* Set errno and return. */
383 if (saved_errno) {
384 __set_errno (saved_errno);
385 return (-1);
388 return (0);
392 * Special case of "/" at the end of the path so that slashes aren't
393 * appended which would cause paths to be written as "....//foo".
395 #define NAPPEND(p) \
396 (p->fts_path[p->fts_pathlen - 1] == '/' \
397 ? p->fts_pathlen - 1 : p->fts_pathlen)
399 FTSENT *
400 fts_read(sp)
401 register FTS *sp;
403 register FTSENT *p, *tmp;
404 register int instr;
405 register char *t;
406 int saved_errno;
408 /* If finished or unrecoverable error, return NULL. */
409 if (sp->fts_cur == NULL || ISSET(FTS_STOP))
410 return (NULL);
412 /* Set current node pointer. */
413 p = sp->fts_cur;
415 /* Save and zero out user instructions. */
416 instr = p->fts_instr;
417 p->fts_instr = FTS_NOINSTR;
419 /* Any type of file may be re-visited; re-stat and re-turn. */
420 if (instr == FTS_AGAIN) {
421 p->fts_info = fts_stat(sp, p, 0);
422 return (p);
426 * Following a symlink -- SLNONE test allows application to see
427 * SLNONE and recover. If indirecting through a symlink, have
428 * keep a pointer to current location. If unable to get that
429 * pointer, follow fails.
431 if (instr == FTS_FOLLOW &&
432 (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
433 p->fts_info = fts_stat(sp, p, 1);
434 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
435 if ((p->fts_symfd = open(".", O_RDONLY, 0)) < 0) {
436 p->fts_errno = errno;
437 p->fts_info = FTS_ERR;
438 } else
439 p->fts_flags |= FTS_SYMFOLLOW;
441 return (p);
444 /* Directory in pre-order. */
445 if (p->fts_info == FTS_D) {
446 /* If skipped or crossed mount point, do post-order visit. */
447 if (instr == FTS_SKIP ||
448 (ISSET(FTS_XDEV) && p->fts_dev != sp->fts_dev)) {
449 if (p->fts_flags & FTS_SYMFOLLOW)
450 (void)close(p->fts_symfd);
451 if (sp->fts_child) {
452 fts_lfree(sp->fts_child);
453 sp->fts_child = NULL;
455 p->fts_info = FTS_DP;
456 return (p);
459 /* Rebuild if only read the names and now traversing. */
460 if (sp->fts_child != NULL && ISSET(FTS_NAMEONLY)) {
461 CLR(FTS_NAMEONLY);
462 fts_lfree(sp->fts_child);
463 sp->fts_child = NULL;
467 * Cd to the subdirectory.
469 * If have already read and now fail to chdir, whack the list
470 * to make the names come out right, and set the parent errno
471 * so the application will eventually get an error condition.
472 * Set the FTS_DONTCHDIR flag so that when we logically change
473 * directories back to the parent we don't do a chdir.
475 * If haven't read do so. If the read fails, fts_build sets
476 * FTS_STOP or the fts_info field of the node.
478 if (sp->fts_child != NULL) {
479 if (fts_safe_changedir(sp, p, -1, p->fts_accpath)) {
480 p->fts_errno = errno;
481 p->fts_flags |= FTS_DONTCHDIR;
482 for (p = sp->fts_child; p != NULL;
483 p = p->fts_link)
484 p->fts_accpath =
485 p->fts_parent->fts_accpath;
487 } else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
488 if (ISSET(FTS_STOP))
489 return (NULL);
490 /* If fts_build's call to fts_safe_changedir failed
491 because it was not able to fchdir into a
492 subdirectory, tell the caller. */
493 if (p->fts_errno)
494 p->fts_info = FTS_ERR;
495 return (p);
497 p = sp->fts_child;
498 sp->fts_child = NULL;
499 goto name;
502 /* Move to the next node on this level. */
503 next: tmp = p;
504 if ((p = p->fts_link) != NULL) {
505 free(tmp);
508 * If reached the top, return to the original directory (or
509 * the root of the tree), and load the paths for the next root.
511 if (p->fts_level == FTS_ROOTLEVEL) {
512 if (FCHDIR(sp, sp->fts_rfd)) {
513 SET(FTS_STOP);
514 return (NULL);
516 fts_load(sp, p);
517 return (sp->fts_cur = p);
521 * User may have called fts_set on the node. If skipped,
522 * ignore. If followed, get a file descriptor so we can
523 * get back if necessary.
525 if (p->fts_instr == FTS_SKIP)
526 goto next;
527 if (p->fts_instr == FTS_FOLLOW) {
528 p->fts_info = fts_stat(sp, p, 1);
529 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
530 if ((p->fts_symfd =
531 open(".", O_RDONLY, 0)) < 0) {
532 p->fts_errno = errno;
533 p->fts_info = FTS_ERR;
534 } else
535 p->fts_flags |= FTS_SYMFOLLOW;
537 p->fts_instr = FTS_NOINSTR;
540 name: t = sp->fts_path + NAPPEND(p->fts_parent);
541 *t++ = '/';
542 memmove(t, p->fts_name, p->fts_namelen + 1);
543 return (sp->fts_cur = p);
546 /* Move up to the parent node. */
547 p = tmp->fts_parent;
548 free(tmp);
550 if (p->fts_level == FTS_ROOTPARENTLEVEL) {
552 * Done; free everything up and set errno to 0 so the user
553 * can distinguish between error and EOF.
555 free(p);
556 __set_errno (0);
557 return (sp->fts_cur = NULL);
560 /* NUL terminate the pathname. */
561 sp->fts_path[p->fts_pathlen] = '\0';
564 * Return to the parent directory. If at a root node or came through
565 * a symlink, go back through the file descriptor. Otherwise, cd up
566 * one directory.
568 if (p->fts_level == FTS_ROOTLEVEL) {
569 if (FCHDIR(sp, sp->fts_rfd)) {
570 SET(FTS_STOP);
571 return (NULL);
573 } else if (p->fts_flags & FTS_SYMFOLLOW) {
574 if (FCHDIR(sp, p->fts_symfd)) {
575 saved_errno = errno;
576 (void)close(p->fts_symfd);
577 __set_errno (saved_errno);
578 SET(FTS_STOP);
579 return (NULL);
581 (void)close(p->fts_symfd);
582 } else if (!(p->fts_flags & FTS_DONTCHDIR) &&
583 fts_safe_changedir(sp, p->fts_parent, -1, "..")) {
584 SET(FTS_STOP);
585 return (NULL);
587 p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
588 return (sp->fts_cur = p);
592 * Fts_set takes the stream as an argument although it's not used in this
593 * implementation; it would be necessary if anyone wanted to add global
594 * semantics to fts using fts_set. An error return is allowed for similar
595 * reasons.
597 /* ARGSUSED */
599 fts_set(sp, p, instr)
600 FTS *sp;
601 FTSENT *p;
602 int instr;
604 if (instr != 0 && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
605 instr != FTS_NOINSTR && instr != FTS_SKIP) {
606 __set_errno (EINVAL);
607 return (1);
609 p->fts_instr = instr;
610 return (0);
613 FTSENT *
614 fts_children(sp, instr)
615 register FTS *sp;
616 int instr;
618 register FTSENT *p;
619 int fd;
621 if (instr != 0 && instr != FTS_NAMEONLY) {
622 __set_errno (EINVAL);
623 return (NULL);
626 /* Set current node pointer. */
627 p = sp->fts_cur;
630 * Errno set to 0 so user can distinguish empty directory from
631 * an error.
633 __set_errno (0);
635 /* Fatal errors stop here. */
636 if (ISSET(FTS_STOP))
637 return (NULL);
639 /* Return logical hierarchy of user's arguments. */
640 if (p->fts_info == FTS_INIT)
641 return (p->fts_link);
644 * If not a directory being visited in pre-order, stop here. Could
645 * allow FTS_DNR, assuming the user has fixed the problem, but the
646 * same effect is available with FTS_AGAIN.
648 if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
649 return (NULL);
651 /* Free up any previous child list. */
652 if (sp->fts_child != NULL)
653 fts_lfree(sp->fts_child);
655 if (instr == FTS_NAMEONLY) {
656 SET(FTS_NAMEONLY);
657 instr = BNAMES;
658 } else
659 instr = BCHILD;
662 * If using chdir on a relative path and called BEFORE fts_read does
663 * its chdir to the root of a traversal, we can lose -- we need to
664 * chdir into the subdirectory, and we don't know where the current
665 * directory is, so we can't get back so that the upcoming chdir by
666 * fts_read will work.
668 if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
669 ISSET(FTS_NOCHDIR))
670 return (sp->fts_child = fts_build(sp, instr));
672 if ((fd = open(".", O_RDONLY, 0)) < 0)
673 return (sp->fts_child = NULL);
674 sp->fts_child = fts_build(sp, instr);
675 if (fchdir(fd)) {
676 (void)close(fd);
677 return (NULL);
679 (void)close(fd);
680 return (sp->fts_child);
684 * This is the tricky part -- do not casually change *anything* in here. The
685 * idea is to build the linked list of entries that are used by fts_children
686 * and fts_read. There are lots of special cases.
688 * The real slowdown in walking the tree is the stat calls. If FTS_NOSTAT is
689 * set and it's a physical walk (so that symbolic links can't be directories),
690 * we can do things quickly. First, if it's a 4.4BSD file system, the type
691 * of the file is in the directory entry. Otherwise, we assume that the number
692 * of subdirectories in a node is equal to the number of links to the parent.
693 * The former skips all stat calls. The latter skips stat calls in any leaf
694 * directories and for any files after the subdirectories in the directory have
695 * been found, cutting the stat calls by about 2/3.
697 static FTSENT *
698 internal_function
699 fts_build(sp, type)
700 register FTS *sp;
701 int type;
703 register struct dirent *dp;
704 register FTSENT *p, *head;
705 register int nitems;
706 FTSENT *cur, *tail;
707 DIR *dirp;
708 void *oldaddr;
709 int cderrno, descend, len, level, maxlen, nlinks, saved_errno,
710 nostat, doadjust;
711 char *cp;
713 /* Set current node pointer. */
714 cur = sp->fts_cur;
717 * Open the directory for reading. If this fails, we're done.
718 * If being called from fts_read, set the fts_info field.
720 #if defined FTS_WHITEOUT && 0
721 if (ISSET(FTS_WHITEOUT))
722 oflag = DTF_NODUP|DTF_REWIND;
723 else
724 oflag = DTF_HIDEW|DTF_NODUP|DTF_REWIND;
725 #else
726 # define __opendir2(path, flag) opendir(path)
727 #endif
728 if ((dirp = __opendir2(cur->fts_accpath, oflag)) == NULL) {
729 if (type == BREAD) {
730 cur->fts_info = FTS_DNR;
731 cur->fts_errno = errno;
733 return (NULL);
737 * Nlinks is the number of possible entries of type directory in the
738 * directory if we're cheating on stat calls, 0 if we're not doing
739 * any stat calls at all, -1 if we're doing stats on everything.
741 if (type == BNAMES) {
742 nlinks = 0;
743 /* Be quiet about nostat, GCC. */
744 nostat = 0;
745 } else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL)) {
746 nlinks = cur->fts_nlink - (ISSET(FTS_SEEDOT) ? 0 : 2);
747 nostat = 1;
748 } else {
749 nlinks = -1;
750 nostat = 0;
753 #ifdef notdef
754 (void)printf("nlinks == %d (cur: %d)\n", nlinks, cur->fts_nlink);
755 (void)printf("NOSTAT %d PHYSICAL %d SEEDOT %d\n",
756 ISSET(FTS_NOSTAT), ISSET(FTS_PHYSICAL), ISSET(FTS_SEEDOT));
757 #endif
759 * If we're going to need to stat anything or we want to descend
760 * and stay in the directory, chdir. If this fails we keep going,
761 * but set a flag so we don't chdir after the post-order visit.
762 * We won't be able to stat anything, but we can still return the
763 * names themselves. Note, that since fts_read won't be able to
764 * chdir into the directory, it will have to return different path
765 * names than before, i.e. "a/b" instead of "b". Since the node
766 * has already been visited in pre-order, have to wait until the
767 * post-order visit to return the error. There is a special case
768 * here, if there was nothing to stat then it's not an error to
769 * not be able to stat. This is all fairly nasty. If a program
770 * needed sorted entries or stat information, they had better be
771 * checking FTS_NS on the returned nodes.
773 cderrno = 0;
774 if (nlinks || type == BREAD) {
775 if (fts_safe_changedir(sp, cur, dirfd(dirp), NULL)) {
776 if (nlinks && type == BREAD)
777 cur->fts_errno = errno;
778 cur->fts_flags |= FTS_DONTCHDIR;
779 descend = 0;
780 cderrno = errno;
781 (void)closedir(dirp);
782 dirp = NULL;
783 } else
784 descend = 1;
785 } else
786 descend = 0;
789 * Figure out the max file name length that can be stored in the
790 * current path -- the inner loop allocates more path as necessary.
791 * We really wouldn't have to do the maxlen calculations here, we
792 * could do them in fts_read before returning the path, but it's a
793 * lot easier here since the length is part of the dirent structure.
795 * If not changing directories set a pointer so that can just append
796 * each new name into the path.
798 len = NAPPEND(cur);
799 if (ISSET(FTS_NOCHDIR)) {
800 cp = sp->fts_path + len;
801 *cp++ = '/';
802 } else {
803 /* GCC, you're too verbose. */
804 cp = NULL;
806 len++;
807 maxlen = sp->fts_pathlen - len;
809 level = cur->fts_level + 1;
811 /* Read the directory, attaching each entry to the `link' pointer. */
812 doadjust = 0;
813 for (head = tail = NULL, nitems = 0; dirp && (dp = readdir(dirp));) {
814 if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
815 continue;
817 if ((p = fts_alloc(sp, dp->d_name, (int)NAMLEN (dp))) == NULL)
818 goto mem1;
819 if (NAMLEN (dp) >= maxlen) {/* include space for NUL */
820 oldaddr = sp->fts_path;
821 if (fts_palloc(sp, NAMLEN (dp) + len + 1)) {
823 * No more memory for path or structures. Save
824 * errno, free up the current structure and the
825 * structures already allocated.
827 mem1: saved_errno = errno;
828 if (p)
829 free(p);
830 fts_lfree(head);
831 (void)closedir(dirp);
832 cur->fts_info = FTS_ERR;
833 SET(FTS_STOP);
834 __set_errno (saved_errno);
835 return (NULL);
837 /* Did realloc() change the pointer? */
838 if (oldaddr != sp->fts_path) {
839 doadjust = 1;
840 if (ISSET(FTS_NOCHDIR))
841 cp = sp->fts_path + len;
843 maxlen = sp->fts_pathlen - len;
846 if (len + NAMLEN (dp) >= USHRT_MAX) {
848 * In an FTSENT, fts_pathlen is a u_short so it is
849 * possible to wraparound here. If we do, free up
850 * the current structure and the structures already
851 * allocated, then error out with ENAMETOOLONG.
853 free(p);
854 fts_lfree(head);
855 (void)closedir(dirp);
856 cur->fts_info = FTS_ERR;
857 SET(FTS_STOP);
858 __set_errno (ENAMETOOLONG);
859 return (NULL);
861 p->fts_level = level;
862 p->fts_parent = sp->fts_cur;
863 p->fts_pathlen = len + NAMLEN (dp);
865 #if defined FTS_WHITEOUT && 0
866 if (dp->d_type == DT_WHT)
867 p->fts_flags |= FTS_ISW;
868 #endif
870 if (cderrno) {
871 if (nlinks) {
872 p->fts_info = FTS_NS;
873 p->fts_errno = cderrno;
874 } else
875 p->fts_info = FTS_NSOK;
876 p->fts_accpath = cur->fts_accpath;
877 } else if (nlinks == 0
878 #if defined DT_DIR && defined _DIRENT_HAVE_D_TYPE
879 || (nostat &&
880 dp->d_type != DT_DIR && dp->d_type != DT_UNKNOWN)
881 #endif
883 p->fts_accpath =
884 ISSET(FTS_NOCHDIR) ? p->fts_path : p->fts_name;
885 p->fts_info = FTS_NSOK;
886 } else {
887 /* Build a file name for fts_stat to stat. */
888 if (ISSET(FTS_NOCHDIR)) {
889 p->fts_accpath = p->fts_path;
890 memmove(cp, p->fts_name, p->fts_namelen + 1);
891 } else
892 p->fts_accpath = p->fts_name;
893 /* Stat it. */
894 p->fts_info = fts_stat(sp, p, 0);
896 /* Decrement link count if applicable. */
897 if (nlinks > 0 && (p->fts_info == FTS_D ||
898 p->fts_info == FTS_DC || p->fts_info == FTS_DOT))
899 --nlinks;
902 /* We walk in directory order so "ls -f" doesn't get upset. */
903 p->fts_link = NULL;
904 if (head == NULL)
905 head = tail = p;
906 else {
907 tail->fts_link = p;
908 tail = p;
910 ++nitems;
912 if (dirp)
913 (void)closedir(dirp);
916 * If realloc() changed the address of the path, adjust the
917 * addresses for the rest of the tree and the dir list.
919 if (doadjust)
920 fts_padjust(sp, head);
923 * If not changing directories, reset the path back to original
924 * state.
926 if (ISSET(FTS_NOCHDIR)) {
927 if (len == sp->fts_pathlen || nitems == 0)
928 --cp;
929 *cp = '\0';
933 * If descended after called from fts_children or after called from
934 * fts_read and nothing found, get back. At the root level we use
935 * the saved fd; if one of fts_open()'s arguments is a relative path
936 * to an empty directory, we wind up here with no other way back. If
937 * can't get back, we're done.
939 if (descend && (type == BCHILD || !nitems) &&
940 (cur->fts_level == FTS_ROOTLEVEL ?
941 FCHDIR(sp, sp->fts_rfd) :
942 fts_safe_changedir(sp, cur->fts_parent, -1, ".."))) {
943 cur->fts_info = FTS_ERR;
944 SET(FTS_STOP);
945 return (NULL);
948 /* If didn't find anything, return NULL. */
949 if (!nitems) {
950 if (type == BREAD)
951 cur->fts_info = FTS_DP;
952 return (NULL);
955 /* Sort the entries. */
956 if (sp->fts_compar && nitems > 1)
957 head = fts_sort(sp, head, nitems);
958 return (head);
961 static u_short
962 internal_function
963 fts_stat(sp, p, follow)
964 FTS *sp;
965 register FTSENT *p;
966 int follow;
968 struct stat *sbp, sb;
969 int saved_errno;
971 /* If user needs stat info, stat buffer already allocated. */
972 sbp = ISSET(FTS_NOSTAT) ? &sb : p->fts_statp;
974 #if defined FTS_WHITEOUT && 0
975 /* check for whiteout */
976 if (p->fts_flags & FTS_ISW) {
977 if (sbp != &sb) {
978 memset(sbp, '\0', sizeof (*sbp));
979 sbp->st_mode = S_IFWHT;
981 return (FTS_W);
983 #endif
986 * If doing a logical walk, or application requested FTS_FOLLOW, do
987 * a stat(2). If that fails, check for a non-existent symlink. If
988 * fail, set the errno from the stat call.
990 if (ISSET(FTS_LOGICAL) || follow) {
991 if (stat(p->fts_accpath, sbp)) {
992 saved_errno = errno;
993 if (!lstat(p->fts_accpath, sbp)) {
994 __set_errno (0);
995 return (FTS_SLNONE);
997 p->fts_errno = saved_errno;
998 goto err;
1000 } else if (lstat(p->fts_accpath, sbp)) {
1001 p->fts_errno = errno;
1002 err: memset(sbp, 0, sizeof(struct stat));
1003 return (FTS_NS);
1006 if (S_ISDIR(sbp->st_mode)) {
1007 FTSENT *t;
1009 * Set the device/inode. Used to find cycles and check for
1010 * crossing mount points. Also remember the link count, used
1011 * in fts_build to limit the number of stat calls. It is
1012 * understood that these fields are only referenced if fts_info
1013 * is set to FTS_D.
1015 p->fts_dev = sbp->st_dev;
1016 p->fts_ino = sbp->st_ino;
1017 p->fts_nlink = sbp->st_nlink;
1019 if (ISDOT(p->fts_name))
1020 return (FTS_DOT);
1023 * See if we've already encountered this directory.
1024 * This can happen when following symlinks as well as
1025 * with a corrupted directory hierarchy.
1027 if ((t = find_object (sp, sbp))) {
1028 p->fts_cycle = t;
1029 return (FTS_DC);
1032 /* Remember the object, ignoring any failure. If we're running
1033 out of memory, detecting cycles isn't a high priority. */
1034 add_object (sp, p, sbp);
1036 return (FTS_D);
1038 if (S_ISLNK(sbp->st_mode))
1039 return (FTS_SL);
1040 if (S_ISREG(sbp->st_mode))
1041 return (FTS_F);
1042 return (FTS_DEFAULT);
1045 static FTSENT *
1046 internal_function
1047 fts_sort(sp, head, nitems)
1048 FTS *sp;
1049 FTSENT *head;
1050 register int nitems;
1052 register FTSENT **ap, *p;
1055 * Construct an array of pointers to the structures and call qsort(3).
1056 * Reassemble the array in the order returned by qsort. If unable to
1057 * sort for memory reasons, return the directory entries in their
1058 * current order. Allocate enough space for the current needs plus
1059 * 40 so don't realloc one entry at a time.
1061 if (nitems > sp->fts_nitems) {
1062 struct _ftsent **a;
1064 sp->fts_nitems = nitems + 40;
1065 if ((a = realloc(sp->fts_array,
1066 (size_t)(sp->fts_nitems * sizeof(FTSENT *)))) == NULL) {
1067 free(sp->fts_array);
1068 sp->fts_array = NULL;
1069 sp->fts_nitems = 0;
1070 return (head);
1072 sp->fts_array = a;
1074 for (ap = sp->fts_array, p = head; p; p = p->fts_link)
1075 *ap++ = p;
1076 qsort((void *)sp->fts_array, nitems, sizeof(FTSENT *), sp->fts_compar);
1077 for (head = *(ap = sp->fts_array); --nitems; ++ap)
1078 ap[0]->fts_link = ap[1];
1079 ap[0]->fts_link = NULL;
1080 return (head);
1083 static FTSENT *
1084 internal_function
1085 fts_alloc(sp, name, namelen)
1086 FTS *sp;
1087 const char *name;
1088 register int namelen;
1090 register FTSENT *p;
1091 size_t len;
1094 * The file name is a variable length array and no stat structure is
1095 * necessary if the user has set the nostat bit. Allocate the FTSENT
1096 * structure, the file name and the stat structure in one chunk, but
1097 * be careful that the stat structure is reasonably aligned. Since the
1098 * fts_name field is declared to be of size 1, the fts_name pointer is
1099 * namelen + 2 before the first possible address of the stat structure.
1101 len = sizeof(FTSENT) + namelen;
1102 if (!ISSET(FTS_NOSTAT))
1103 len += sizeof(struct stat) + ALIGNBYTES;
1104 if ((p = malloc(len)) == NULL)
1105 return (NULL);
1107 /* Copy the name and guarantee NUL termination. */
1108 memmove(p->fts_name, name, namelen);
1109 p->fts_name[namelen] = '\0';
1111 if (!ISSET(FTS_NOSTAT))
1112 p->fts_statp = (struct stat *)ALIGN(p->fts_name + namelen + 2);
1113 p->fts_namelen = namelen;
1114 p->fts_path = sp->fts_path;
1115 p->fts_errno = 0;
1116 p->fts_flags = 0;
1117 p->fts_instr = FTS_NOINSTR;
1118 p->fts_number = 0;
1119 p->fts_pointer = NULL;
1120 return (p);
1123 static void
1124 internal_function
1125 fts_lfree(head)
1126 register FTSENT *head;
1128 register FTSENT *p;
1130 /* Free a linked list of structures. */
1131 while ((p = head)) {
1132 head = head->fts_link;
1133 free(p);
1138 * Allow essentially unlimited paths; find, rm, ls should all work on any tree.
1139 * Most systems will allow creation of paths much longer than MAXPATHLEN, even
1140 * though the kernel won't resolve them. Add the size (not just what's needed)
1141 * plus 256 bytes so don't realloc the path 2 bytes at a time.
1143 static int
1144 internal_function
1145 fts_palloc(sp, more)
1146 FTS *sp;
1147 size_t more;
1149 char *p;
1151 sp->fts_pathlen += more + 256;
1153 * Check for possible wraparound. In an FTS, fts_pathlen is
1154 * a signed int but in an FTSENT it is an unsigned short.
1155 * We limit fts_pathlen to USHRT_MAX to be safe in both cases.
1157 if (sp->fts_pathlen < 0 || sp->fts_pathlen >= USHRT_MAX) {
1158 if (sp->fts_path) {
1159 free(sp->fts_path);
1160 sp->fts_path = NULL;
1162 sp->fts_path = NULL;
1163 __set_errno (ENAMETOOLONG);
1164 return (1);
1166 p = realloc(sp->fts_path, sp->fts_pathlen);
1167 if (p == NULL) {
1168 free(sp->fts_path);
1169 sp->fts_path = NULL;
1170 return 1;
1172 sp->fts_path = p;
1173 return 0;
1177 * When the path is realloc'd, have to fix all of the pointers in structures
1178 * already returned.
1180 static void
1181 internal_function
1182 fts_padjust(sp, head)
1183 FTS *sp;
1184 FTSENT *head;
1186 FTSENT *p;
1187 char *addr = sp->fts_path;
1189 #define ADJUST(p) do { \
1190 if ((p)->fts_accpath != (p)->fts_name) { \
1191 (p)->fts_accpath = \
1192 (char *)addr + ((p)->fts_accpath - (p)->fts_path); \
1194 (p)->fts_path = addr; \
1195 } while (0)
1196 /* Adjust the current set of children. */
1197 for (p = sp->fts_child; p; p = p->fts_link)
1198 ADJUST(p);
1200 /* Adjust the rest of the tree, including the current level. */
1201 for (p = head; p->fts_level >= FTS_ROOTLEVEL;) {
1202 ADJUST(p);
1203 p = p->fts_link ? p->fts_link : p->fts_parent;
1207 static size_t
1208 internal_function
1209 fts_maxarglen(argv)
1210 char * const *argv;
1212 size_t len, max;
1214 for (max = 0; *argv; ++argv)
1215 if ((len = strlen(*argv)) > max)
1216 max = len;
1217 return (max + 1);
1221 * Change to dir specified by fd or p->fts_accpath without getting
1222 * tricked by someone changing the world out from underneath us.
1223 * Assumes p->fts_dev and p->fts_ino are filled in.
1225 static int
1226 internal_function
1227 fts_safe_changedir(sp, p, fd, path)
1228 FTS *sp;
1229 FTSENT *p;
1230 int fd;
1231 const char *path;
1233 int ret, oerrno, newfd;
1234 struct stat64 sb;
1236 newfd = fd;
1237 if (ISSET(FTS_NOCHDIR))
1238 return (0);
1239 if (fd < 0 && (newfd = open(path, O_RDONLY, 0)) < 0)
1240 return (-1);
1241 if (__fxstat64(_STAT_VER, newfd, &sb)) {
1242 ret = -1;
1243 goto bail;
1245 if (p->fts_dev != sb.st_dev || p->fts_ino != sb.st_ino) {
1246 __set_errno (ENOENT); /* disinformation */
1247 ret = -1;
1248 goto bail;
1250 ret = fchdir(newfd);
1251 bail:
1252 oerrno = errno;
1253 if (fd < 0)
1254 (void)close(newfd);
1255 __set_errno (oerrno);
1256 return (ret);