Import libarchive and bsdtar. The default tar (/usr/bin/tar) can be choosen
[dragonfly.git] / contrib / bsdtar / fts.c
1 /*-
2  * This file is not used on BSD systems, because the libc version
3  * works.  On Linux, the fts in libc is compiled for a 32-bit
4  * off_t, which doesn't match the 64-bit off_t used by the rest
5  * of bsdtar.  <sigh>
6  *
7  * bsdtar_platform.h defines _FILE_OFFSET_BITS=64 so this will
8  * be compiled for 64-bit off_t.
9  *
10  * This file is mostly unchanged from:
11  * FreeBSD: src/lib/libc/gen/fts.c,v 1.22 2003/01/03 23:25:25 tjr Exp
12  * except for a few minor Linux-isms which are commented with "bsdtar:"
13  * below.
14  */
15
16 /*-
17  * Copyright (c) 1990, 1993, 1994
18  *      The Regents of the University of California.  All rights reserved.
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  * 1. Redistributions of source code must retain the above copyright
24  *    notice, this list of conditions and the following disclaimer.
25  * 2. Redistributions in binary form must reproduce the above copyright
26  *    notice, this list of conditions and the following disclaimer in the
27  *    documentation and/or other materials provided with the distribution.
28  * 3. All advertising materials mentioning features or use of this software
29  *    must display the following acknowledgement:
30  *      This product includes software developed by the University of
31  *      California, Berkeley and its contributors.
32  * 4. Neither the name of the University nor the names of its contributors
33  *    may be used to endorse or promote products derived from this software
34  *    without specific prior written permission.
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
37  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
39  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
40  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
41  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
42  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
44  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
45  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  *
48  * From: $OpenBSD: fts.c,v 1.22 1999/10/03 19:22:22 millert Exp $
49  * From: $
50  */
51
52 #if defined(LIBC_SCCS) && !defined(lint)
53 static char sccsid[] = "@(#)fts.c       8.6 (Berkeley) 8/14/94";
54 #endif /* LIBC_SCCS and not lint */
55 #include "bsdtar_platform.h" /* bsdtar: need platform-specific definitions. */
56 __FBSDID("$FreeBSD: src/usr.bin/tar/fts.c,v 1.2 2004/07/24 22:13:44 kientzle Exp $");
57
58 #ifdef linux  /* bsdtar: translate certain system calls to Linux names. */
59 #define _open open
60 #define _close close
61 #define _fstat fstat
62 #endif
63
64 /* #include "namespace.h" */ /* bsdtar: Don't use namespace.h. */
65 #include <sys/types.h>
66 #include <sys/param.h>
67 #include <sys/stat.h>
68
69 #include <dirent.h>
70 #include <errno.h>
71 #include <fcntl.h>
72 #include <fts.h>
73 #undef FTS_WHITEOUT     /* bsdtar: Not all platforms support this. */
74 #include <stdlib.h>
75 #include <string.h>
76 #include <unistd.h>
77 /* #include "un-namespace.h" */ /* bsdtar: Don't use namespace.h. */
78
79 static FTSENT   *fts_alloc(FTS *, char *, int);
80 static FTSENT   *fts_build(FTS *, int);
81 static void      fts_lfree(FTSENT *);
82 static void      fts_load(FTS *, FTSENT *);
83 static size_t    fts_maxarglen(char * const *);
84 static void      fts_padjust(FTS *, FTSENT *);
85 static int       fts_palloc(FTS *, size_t);
86 static FTSENT   *fts_sort(FTS *, FTSENT *, int);
87 static u_short   fts_stat(FTS *, FTSENT *, int);
88 static int       fts_safe_changedir(FTS *, FTSENT *, int, char *);
89
90 #define ISDOT(a)        (a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
91
92 #define CLR(opt)        (sp->fts_options &= ~(opt))
93 #define ISSET(opt)      (sp->fts_options & (opt))
94 #define SET(opt)        (sp->fts_options |= (opt))
95
96 #define FCHDIR(sp, fd)  (!ISSET(FTS_NOCHDIR) && fchdir(fd))
97
98 /* fts_build flags */
99 #define BCHILD          1               /* fts_children */
100 #define BNAMES          2               /* fts_children, names only */
101 #define BREAD           3               /* fts_read */
102
103 #ifndef HAVE_REALLOCF  /* bsdtar: Define reallocf for non-BSD platforms. */
104 static void *
105 reallocf(ptr, size)
106         void *ptr;
107         size_t size;
108 {
109         void *ret = realloc(ptr, size);
110         if (!ret)
111                 free(ptr);
112         return ret;
113 }
114 #endif
115
116 FTS *
117 fts_open(argv, options, compar)
118         char * const *argv;
119         int options;
120         int (*compar)(const FTSENT * const *, const FTSENT * const *);
121 {
122         FTS *sp;
123         FTSENT *p, *root;
124         int nitems;
125         FTSENT *parent, *tmp;
126         int len;
127
128         /* Options check. */
129         if (options & ~FTS_OPTIONMASK) {
130                 errno = EINVAL;
131                 return (NULL);
132         }
133
134         /* Allocate/initialize the stream */
135         if ((sp = malloc(sizeof(FTS))) == NULL)
136                 return (NULL);
137         memset(sp, 0, sizeof(FTS));
138         sp->fts_compar = compar;
139         sp->fts_options = options;
140
141         /* Shush, GCC. */
142         tmp = NULL;
143
144         /* Logical walks turn on NOCHDIR; symbolic links are too hard. */
145         if (ISSET(FTS_LOGICAL))
146                 SET(FTS_NOCHDIR);
147
148         /*
149          * Start out with 1K of path space, and enough, in any case,
150          * to hold the user's paths.
151          */
152         if (fts_palloc(sp, MAX(fts_maxarglen(argv), MAXPATHLEN)))
153                 goto mem1;
154
155         /* Allocate/initialize root's parent. */
156         if ((parent = fts_alloc(sp, "", 0)) == NULL)
157                 goto mem2;
158         parent->fts_level = FTS_ROOTPARENTLEVEL;
159
160         /* Allocate/initialize root(s). */
161         for (root = NULL, nitems = 0; *argv != NULL; ++argv, ++nitems) {
162                 /* Don't allow zero-length paths. */
163                 if ((len = strlen(*argv)) == 0) {
164                         errno = ENOENT;
165                         goto mem3;
166                 }
167
168                 p = fts_alloc(sp, *argv, len);
169                 p->fts_level = FTS_ROOTLEVEL;
170                 p->fts_parent = parent;
171                 p->fts_accpath = p->fts_name;
172                 p->fts_info = fts_stat(sp, p, ISSET(FTS_COMFOLLOW));
173
174                 /* Command-line "." and ".." are real directories. */
175                 if (p->fts_info == FTS_DOT)
176                         p->fts_info = FTS_D;
177
178                 /*
179                  * If comparison routine supplied, traverse in sorted
180                  * order; otherwise traverse in the order specified.
181                  */
182                 if (compar) {
183                         p->fts_link = root;
184                         root = p;
185                 } else {
186                         p->fts_link = NULL;
187                         if (root == NULL)
188                                 tmp = root = p;
189                         else {
190                                 tmp->fts_link = p;
191                                 tmp = p;
192                         }
193                 }
194         }
195         if (compar && nitems > 1)
196                 root = fts_sort(sp, root, nitems);
197
198         /*
199          * Allocate a dummy pointer and make fts_read think that we've just
200          * finished the node before the root(s); set p->fts_info to FTS_INIT
201          * so that everything about the "current" node is ignored.
202          */
203         if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
204                 goto mem3;
205         sp->fts_cur->fts_link = root;
206         sp->fts_cur->fts_info = FTS_INIT;
207
208         /*
209          * If using chdir(2), grab a file descriptor pointing to dot to ensure
210          * that we can get back here; this could be avoided for some paths,
211          * but almost certainly not worth the effort.  Slashes, symbolic links,
212          * and ".." are all fairly nasty problems.  Note, if we can't get the
213          * descriptor we run anyway, just more slowly.
214          */
215         if (!ISSET(FTS_NOCHDIR) && (sp->fts_rfd = _open(".", O_RDONLY, 0)) < 0)
216                 SET(FTS_NOCHDIR);
217
218         return (sp);
219
220 mem3:   fts_lfree(root);
221         free(parent);
222 mem2:   free(sp->fts_path);
223 mem1:   free(sp);
224         return (NULL);
225 }
226
227 static void
228 fts_load(sp, p)
229         FTS *sp;
230         FTSENT *p;
231 {
232         int len;
233         char *cp;
234
235         /*
236          * Load the stream structure for the next traversal.  Since we don't
237          * actually enter the directory until after the preorder visit, set
238          * the fts_accpath field specially so the chdir gets done to the right
239          * place and the user can access the first node.  From fts_open it's
240          * known that the path will fit.
241          */
242         len = p->fts_pathlen = p->fts_namelen;
243         memmove(sp->fts_path, p->fts_name, len + 1);
244         if ((cp = strrchr(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
245                 len = strlen(++cp);
246                 memmove(p->fts_name, cp, len + 1);
247                 p->fts_namelen = len;
248         }
249         p->fts_accpath = p->fts_path = sp->fts_path;
250         sp->fts_dev = p->fts_dev;
251 }
252
253 int
254 fts_close(sp)
255         FTS *sp;
256 {
257         FTSENT *freep, *p;
258         int saved_errno;
259
260         /*
261          * This still works if we haven't read anything -- the dummy structure
262          * points to the root list, so we step through to the end of the root
263          * list which has a valid parent pointer.
264          */
265         if (sp->fts_cur) {
266                 for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
267                         freep = p;
268                         p = p->fts_link != NULL ? p->fts_link : p->fts_parent;
269                         free(freep);
270                 }
271                 free(p);
272         }
273
274         /* Free up child linked list, sort array, path buffer. */
275         if (sp->fts_child)
276                 fts_lfree(sp->fts_child);
277         if (sp->fts_array)
278                 free(sp->fts_array);
279         free(sp->fts_path);
280
281         /* Return to original directory, save errno if necessary. */
282         if (!ISSET(FTS_NOCHDIR)) {
283                 saved_errno = fchdir(sp->fts_rfd) ? errno : 0;
284                 (void)_close(sp->fts_rfd);
285
286                 /* Set errno and return. */
287                 if (saved_errno != 0) {
288                         /* Free up the stream pointer. */
289                         free(sp);
290                         errno = saved_errno;
291                         return (-1);
292                 }
293         }
294
295         /* Free up the stream pointer. */
296         free(sp);
297         return (0);
298 }
299
300 /*
301  * Special case of "/" at the end of the path so that slashes aren't
302  * appended which would cause paths to be written as "....//foo".
303  */
304 #define NAPPEND(p)                                                      \
305         (p->fts_path[p->fts_pathlen - 1] == '/'                         \
306             ? p->fts_pathlen - 1 : p->fts_pathlen)
307
308 FTSENT *
309 fts_read(sp)
310         FTS *sp;
311 {
312         FTSENT *p, *tmp;
313         int instr;
314         char *t;
315         int saved_errno;
316
317         /* If finished or unrecoverable error, return NULL. */
318         if (sp->fts_cur == NULL || ISSET(FTS_STOP))
319                 return (NULL);
320
321         /* Set current node pointer. */
322         p = sp->fts_cur;
323
324         /* Save and zero out user instructions. */
325         instr = p->fts_instr;
326         p->fts_instr = FTS_NOINSTR;
327
328         /* Any type of file may be re-visited; re-stat and re-turn. */
329         if (instr == FTS_AGAIN) {
330                 p->fts_info = fts_stat(sp, p, 0);
331                 return (p);
332         }
333
334         /*
335          * Following a symlink -- SLNONE test allows application to see
336          * SLNONE and recover.  If indirecting through a symlink, have
337          * keep a pointer to current location.  If unable to get that
338          * pointer, follow fails.
339          */
340         if (instr == FTS_FOLLOW &&
341             (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
342                 p->fts_info = fts_stat(sp, p, 1);
343                 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
344                         if ((p->fts_symfd = _open(".", O_RDONLY, 0)) < 0) {
345                                 p->fts_errno = errno;
346                                 p->fts_info = FTS_ERR;
347                         } else
348                                 p->fts_flags |= FTS_SYMFOLLOW;
349                 }
350                 return (p);
351         }
352
353         /* Directory in pre-order. */
354         if (p->fts_info == FTS_D) {
355                 /* If skipped or crossed mount point, do post-order visit. */
356                 if (instr == FTS_SKIP ||
357                     (ISSET(FTS_XDEV) && p->fts_dev != sp->fts_dev)) {
358                         if (p->fts_flags & FTS_SYMFOLLOW)
359                                 (void)_close(p->fts_symfd);
360                         if (sp->fts_child) {
361                                 fts_lfree(sp->fts_child);
362                                 sp->fts_child = NULL;
363                         }
364                         p->fts_info = FTS_DP;
365                         return (p);
366                 }
367
368                 /* Rebuild if only read the names and now traversing. */
369                 if (sp->fts_child != NULL && ISSET(FTS_NAMEONLY)) {
370                         CLR(FTS_NAMEONLY);
371                         fts_lfree(sp->fts_child);
372                         sp->fts_child = NULL;
373                 }
374
375                 /*
376                  * Cd to the subdirectory.
377                  *
378                  * If have already read and now fail to chdir, whack the list
379                  * to make the names come out right, and set the parent errno
380                  * so the application will eventually get an error condition.
381                  * Set the FTS_DONTCHDIR flag so that when we logically change
382                  * directories back to the parent we don't do a chdir.
383                  *
384                  * If haven't read do so.  If the read fails, fts_build sets
385                  * FTS_STOP or the fts_info field of the node.
386                  */
387                 if (sp->fts_child != NULL) {
388                         if (fts_safe_changedir(sp, p, -1, p->fts_accpath)) {
389                                 p->fts_errno = errno;
390                                 p->fts_flags |= FTS_DONTCHDIR;
391                                 for (p = sp->fts_child; p != NULL; 
392                                     p = p->fts_link)
393                                         p->fts_accpath =
394                                             p->fts_parent->fts_accpath;
395                         }
396                 } else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
397                         if (ISSET(FTS_STOP))
398                                 return (NULL);
399                         return (p);
400                 }
401                 p = sp->fts_child;
402                 sp->fts_child = NULL;
403                 goto name;
404         }
405
406         /* Move to the next node on this level. */
407 next:   tmp = p;
408         if ((p = p->fts_link) != NULL) {
409                 free(tmp);
410
411                 /*
412                  * If reached the top, return to the original directory (or
413                  * the root of the tree), and load the paths for the next root.
414                  */
415                 if (p->fts_level == FTS_ROOTLEVEL) {
416                         if (FCHDIR(sp, sp->fts_rfd)) {
417                                 SET(FTS_STOP);
418                                 return (NULL);
419                         }
420                         fts_load(sp, p);
421                         return (sp->fts_cur = p);
422                 }
423
424                 /*
425                  * User may have called fts_set on the node.  If skipped,
426                  * ignore.  If followed, get a file descriptor so we can
427                  * get back if necessary.
428                  */
429                 if (p->fts_instr == FTS_SKIP)
430                         goto next;
431                 if (p->fts_instr == FTS_FOLLOW) {
432                         p->fts_info = fts_stat(sp, p, 1);
433                         if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR)) {
434                                 if ((p->fts_symfd =
435                                     _open(".", O_RDONLY, 0)) < 0) {
436                                         p->fts_errno = errno;
437                                         p->fts_info = FTS_ERR;
438                                 } else
439                                         p->fts_flags |= FTS_SYMFOLLOW;
440                         }
441                         p->fts_instr = FTS_NOINSTR;
442                 }
443
444 name:           t = sp->fts_path + NAPPEND(p->fts_parent);
445                 *t++ = '/';
446                 memmove(t, p->fts_name, p->fts_namelen + 1);
447                 return (sp->fts_cur = p);
448         }
449
450         /* Move up to the parent node. */
451         p = tmp->fts_parent;
452         free(tmp);
453
454         if (p->fts_level == FTS_ROOTPARENTLEVEL) {
455                 /*
456                  * Done; free everything up and set errno to 0 so the user
457                  * can distinguish between error and EOF.
458                  */
459                 free(p);
460                 errno = 0;
461                 return (sp->fts_cur = NULL);
462         }
463
464         /* NUL terminate the pathname. */
465         sp->fts_path[p->fts_pathlen] = '\0';
466
467         /*
468          * Return to the parent directory.  If at a root node or came through
469          * a symlink, go back through the file descriptor.  Otherwise, cd up
470          * one directory.
471          */
472         if (p->fts_level == FTS_ROOTLEVEL) {
473                 if (FCHDIR(sp, sp->fts_rfd)) {
474                         SET(FTS_STOP);
475                         return (NULL);
476                 }
477         } else if (p->fts_flags & FTS_SYMFOLLOW) {
478                 if (FCHDIR(sp, p->fts_symfd)) {
479                         saved_errno = errno;
480                         (void)_close(p->fts_symfd);
481                         errno = saved_errno;
482                         SET(FTS_STOP);
483                         return (NULL);
484                 }
485                 (void)_close(p->fts_symfd);
486         } else if (!(p->fts_flags & FTS_DONTCHDIR) &&
487                    fts_safe_changedir(sp, p->fts_parent, -1, "..")) {
488                 SET(FTS_STOP);
489                 return (NULL);
490         }
491         p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
492         return (sp->fts_cur = p);
493 }
494
495 /*
496  * Fts_set takes the stream as an argument although it's not used in this
497  * implementation; it would be necessary if anyone wanted to add global
498  * semantics to fts using fts_set.  An error return is allowed for similar
499  * reasons.
500  */
501 /* ARGSUSED */
502 int
503 fts_set(sp, p, instr)
504         FTS *sp;
505         FTSENT *p;
506         int instr;
507 {
508         if (instr != 0 && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
509             instr != FTS_NOINSTR && instr != FTS_SKIP) {
510                 errno = EINVAL;
511                 return (1);
512         }
513         p->fts_instr = instr;
514         return (0);
515 }
516
517 FTSENT *
518 fts_children(sp, instr)
519         FTS *sp;
520         int instr;
521 {
522         FTSENT *p;
523         int fd;
524
525         if (instr != 0 && instr != FTS_NAMEONLY) {
526                 errno = EINVAL;
527                 return (NULL);
528         }
529
530         /* Set current node pointer. */
531         p = sp->fts_cur;
532
533         /*
534          * Errno set to 0 so user can distinguish empty directory from
535          * an error.
536          */
537         errno = 0;
538
539         /* Fatal errors stop here. */
540         if (ISSET(FTS_STOP))
541                 return (NULL);
542
543         /* Return logical hierarchy of user's arguments. */
544         if (p->fts_info == FTS_INIT)
545                 return (p->fts_link);
546
547         /*
548          * If not a directory being visited in pre-order, stop here.  Could
549          * allow FTS_DNR, assuming the user has fixed the problem, but the
550          * same effect is available with FTS_AGAIN.
551          */
552         if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
553                 return (NULL);
554
555         /* Free up any previous child list. */
556         if (sp->fts_child != NULL)
557                 fts_lfree(sp->fts_child);
558
559         if (instr == FTS_NAMEONLY) {
560                 SET(FTS_NAMEONLY);
561                 instr = BNAMES;
562         } else
563                 instr = BCHILD;
564
565         /*
566          * If using chdir on a relative path and called BEFORE fts_read does
567          * its chdir to the root of a traversal, we can lose -- we need to
568          * chdir into the subdirectory, and we don't know where the current
569          * directory is, so we can't get back so that the upcoming chdir by
570          * fts_read will work.
571          */
572         if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
573             ISSET(FTS_NOCHDIR))
574                 return (sp->fts_child = fts_build(sp, instr));
575
576         if ((fd = _open(".", O_RDONLY, 0)) < 0)
577                 return (NULL);
578         sp->fts_child = fts_build(sp, instr);
579         if (fchdir(fd))
580                 return (NULL);
581         (void)_close(fd);
582         return (sp->fts_child);
583 }
584
585 #ifndef fts_get_clientptr
586 #error "fts_get_clientptr not defined"
587 #endif
588
589 void *
590 (fts_get_clientptr)(FTS *sp)
591 {
592
593         return (fts_get_clientptr(sp));
594 }
595
596 #ifndef fts_get_stream
597 #error "fts_get_stream not defined"
598 #endif
599
600 FTS *
601 (fts_get_stream)(FTSENT *p)
602 {
603         return (fts_get_stream(p));
604 }
605
606 void
607 fts_set_clientptr(FTS *sp, void *clientptr)
608 {
609
610         sp->fts_clientptr = clientptr;
611 }
612
613 /*
614  * This is the tricky part -- do not casually change *anything* in here.  The
615  * idea is to build the linked list of entries that are used by fts_children
616  * and fts_read.  There are lots of special cases.
617  *
618  * The real slowdown in walking the tree is the stat calls.  If FTS_NOSTAT is
619  * set and it's a physical walk (so that symbolic links can't be directories),
620  * we can do things quickly.  First, if it's a 4.4BSD file system, the type
621  * of the file is in the directory entry.  Otherwise, we assume that the number
622  * of subdirectories in a node is equal to the number of links to the parent.
623  * The former skips all stat calls.  The latter skips stat calls in any leaf
624  * directories and for any files after the subdirectories in the directory have
625  * been found, cutting the stat calls by about 2/3.
626  */
627 static FTSENT *
628 fts_build(sp, type)
629         FTS *sp;
630         int type;
631 {
632         struct dirent *dp;
633         FTSENT *p, *head;
634         int nitems;
635         FTSENT *cur, *tail;
636         DIR *dirp;
637         void *oldaddr;
638         int cderrno, descend, len, level, maxlen, nlinks, oflag, saved_errno,
639             nostat, doadjust;
640         char *cp;
641
642         /* Set current node pointer. */
643         cur = sp->fts_cur;
644
645         /*
646          * Open the directory for reading.  If this fails, we're done.
647          * If being called from fts_read, set the fts_info field.
648          */
649 #ifdef FTS_WHITEOUT
650         if (ISSET(FTS_WHITEOUT))
651                 oflag = DTF_NODUP|DTF_REWIND;
652         else
653                 oflag = DTF_HIDEW|DTF_NODUP|DTF_REWIND;
654 #else
655 #define __opendir2(path, flag) opendir(path)
656 #endif
657         if ((dirp = __opendir2(cur->fts_accpath, oflag)) == NULL) {
658                 if (type == BREAD) {
659                         cur->fts_info = FTS_DNR;
660                         cur->fts_errno = errno;
661                 }
662                 return (NULL);
663         }
664
665         /*
666          * Nlinks is the number of possible entries of type directory in the
667          * directory if we're cheating on stat calls, 0 if we're not doing
668          * any stat calls at all, -1 if we're doing stats on everything.
669          */
670         if (type == BNAMES) {
671                 nlinks = 0;
672                 /* Be quiet about nostat, GCC. */
673                 nostat = 0;
674         } else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL)) {
675                 nlinks = cur->fts_nlink - (ISSET(FTS_SEEDOT) ? 0 : 2);
676                 nostat = 1;
677         } else {
678                 nlinks = -1;
679                 nostat = 0;
680         }
681
682 #ifdef notdef
683         (void)printf("nlinks == %d (cur: %d)\n", nlinks, cur->fts_nlink);
684         (void)printf("NOSTAT %d PHYSICAL %d SEEDOT %d\n",
685             ISSET(FTS_NOSTAT), ISSET(FTS_PHYSICAL), ISSET(FTS_SEEDOT));
686 #endif
687         /*
688          * If we're going to need to stat anything or we want to descend
689          * and stay in the directory, chdir.  If this fails we keep going,
690          * but set a flag so we don't chdir after the post-order visit.
691          * We won't be able to stat anything, but we can still return the
692          * names themselves.  Note, that since fts_read won't be able to
693          * chdir into the directory, it will have to return different path
694          * names than before, i.e. "a/b" instead of "b".  Since the node
695          * has already been visited in pre-order, have to wait until the
696          * post-order visit to return the error.  There is a special case
697          * here, if there was nothing to stat then it's not an error to
698          * not be able to stat.  This is all fairly nasty.  If a program
699          * needed sorted entries or stat information, they had better be
700          * checking FTS_NS on the returned nodes.
701          */
702         cderrno = 0;
703         if (nlinks || type == BREAD) {
704                 if (fts_safe_changedir(sp, cur, dirfd(dirp), NULL)) {
705                         if (nlinks && type == BREAD)
706                                 cur->fts_errno = errno;
707                         cur->fts_flags |= FTS_DONTCHDIR;
708                         descend = 0;
709                         cderrno = errno;
710                         (void)closedir(dirp);
711                         dirp = NULL;
712                 } else
713                         descend = 1;
714         } else
715                 descend = 0;
716
717         /*
718          * Figure out the max file name length that can be stored in the
719          * current path -- the inner loop allocates more path as necessary.
720          * We really wouldn't have to do the maxlen calculations here, we
721          * could do them in fts_read before returning the path, but it's a
722          * lot easier here since the length is part of the dirent structure.
723          *
724          * If not changing directories set a pointer so that can just append
725          * each new name into the path.
726          */
727         len = NAPPEND(cur);
728         if (ISSET(FTS_NOCHDIR)) {
729                 cp = sp->fts_path + len;
730                 *cp++ = '/';
731         } else {
732                 /* GCC, you're too verbose. */
733                 cp = NULL;
734         }
735         len++;
736         maxlen = sp->fts_pathlen - len;
737
738         level = cur->fts_level + 1;
739
740         /* Read the directory, attaching each entry to the `link' pointer. */
741         doadjust = 0;
742         for (head = tail = NULL, nitems = 0; dirp && (dp = readdir(dirp));) {
743 #ifdef HAVE_STRUCT_DIRENT_D_NAMLEN /* bsdtar: Not everyone has d_namlen. */
744 #define dnamlen dp->d_namlen
745 #else
746                 int dnamlen = strlen(dp->d_name);
747 #endif
748                 if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
749                         continue;
750
751                 if ((p = fts_alloc(sp, dp->d_name, dnamlen)) == NULL)
752                         goto mem1;
753                 if (dnamlen >= maxlen) {        /* include space for NUL */
754                         oldaddr = sp->fts_path;
755                         if (fts_palloc(sp, dnamlen + len + 1)) {
756                                 /*
757                                  * No more memory for path or structures.  Save
758                                  * errno, free up the current structure and the
759                                  * structures already allocated.
760                                  */
761 mem1:                           saved_errno = errno;
762                                 if (p)
763                                         free(p);
764                                 fts_lfree(head);
765                                 (void)closedir(dirp);
766                                 cur->fts_info = FTS_ERR;
767                                 SET(FTS_STOP);
768                                 errno = saved_errno;
769                                 return (NULL);
770                         }
771                         /* Did realloc() change the pointer? */
772                         if (oldaddr != sp->fts_path) {
773                                 doadjust = 1;
774                                 if (ISSET(FTS_NOCHDIR))
775                                         cp = sp->fts_path + len;
776                         }
777                         maxlen = sp->fts_pathlen - len;
778                 }
779
780                 if (len + dnamlen >= USHRT_MAX) {
781                         /*
782                          * In an FTSENT, fts_pathlen is a u_short so it is
783                          * possible to wraparound here.  If we do, free up
784                          * the current structure and the structures already
785                          * allocated, then error out with ENAMETOOLONG.
786                          */
787                         free(p);
788                         fts_lfree(head);
789                         (void)closedir(dirp);
790                         cur->fts_info = FTS_ERR;
791                         SET(FTS_STOP);
792                         errno = ENAMETOOLONG;
793                         return (NULL);
794                 }
795                 p->fts_level = level;
796                 p->fts_parent = sp->fts_cur;
797                 p->fts_pathlen = len + dnamlen;
798
799 #ifdef FTS_WHITEOUT
800                 if (dp->d_type == DT_WHT)
801                         p->fts_flags |= FTS_ISW;
802 #endif
803
804                 if (cderrno) {
805                         if (nlinks) {
806                                 p->fts_info = FTS_NS;
807                                 p->fts_errno = cderrno;
808                         } else
809                                 p->fts_info = FTS_NSOK;
810                         p->fts_accpath = cur->fts_accpath;
811                 } else if (nlinks == 0
812 #ifdef DT_DIR
813                     || (nostat &&
814                     dp->d_type != DT_DIR && dp->d_type != DT_UNKNOWN)
815 #endif
816                     ) {
817                         p->fts_accpath =
818                             ISSET(FTS_NOCHDIR) ? p->fts_path : p->fts_name;
819                         p->fts_info = FTS_NSOK;
820                 } else {
821                         /* Build a file name for fts_stat to stat. */
822                         if (ISSET(FTS_NOCHDIR)) {
823                                 p->fts_accpath = p->fts_path;
824                                 memmove(cp, p->fts_name, p->fts_namelen + 1);
825                         } else
826                                 p->fts_accpath = p->fts_name;
827                         /* Stat it. */
828                         p->fts_info = fts_stat(sp, p, 0);
829
830                         /* Decrement link count if applicable. */
831                         if (nlinks > 0 && (p->fts_info == FTS_D ||
832                             p->fts_info == FTS_DC || p->fts_info == FTS_DOT))
833                                 --nlinks;
834                 }
835
836                 /* We walk in directory order so "ls -f" doesn't get upset. */
837                 p->fts_link = NULL;
838                 if (head == NULL)
839                         head = tail = p;
840                 else {
841                         tail->fts_link = p;
842                         tail = p;
843                 }
844                 ++nitems;
845         }
846         if (dirp)
847                 (void)closedir(dirp);
848
849         /*
850          * If realloc() changed the address of the path, adjust the
851          * addresses for the rest of the tree and the dir list.
852          */
853         if (doadjust)
854                 fts_padjust(sp, head);
855
856         /*
857          * If not changing directories, reset the path back to original
858          * state.
859          */
860         if (ISSET(FTS_NOCHDIR)) {
861                 if (len == sp->fts_pathlen || nitems == 0)
862                         --cp;
863                 *cp = '\0';
864         }
865
866         /*
867          * If descended after called from fts_children or after called from
868          * fts_read and nothing found, get back.  At the root level we use
869          * the saved fd; if one of fts_open()'s arguments is a relative path
870          * to an empty directory, we wind up here with no other way back.  If
871          * can't get back, we're done.
872          */
873         if (descend && (type == BCHILD || !nitems) &&
874             (cur->fts_level == FTS_ROOTLEVEL ?
875             FCHDIR(sp, sp->fts_rfd) :
876             fts_safe_changedir(sp, cur->fts_parent, -1, ".."))) {
877                 cur->fts_info = FTS_ERR;
878                 SET(FTS_STOP);
879                 return (NULL);
880         }
881
882         /* If didn't find anything, return NULL. */
883         if (!nitems) {
884                 if (type == BREAD)
885                         cur->fts_info = FTS_DP;
886                 return (NULL);
887         }
888
889         /* Sort the entries. */
890         if (sp->fts_compar && nitems > 1)
891                 head = fts_sort(sp, head, nitems);
892         return (head);
893 }
894
895 static u_short
896 fts_stat(sp, p, follow)
897         FTS *sp;
898         FTSENT *p;
899         int follow;
900 {
901         FTSENT *t;
902         dev_t dev;
903         ino_t ino;
904         struct stat *sbp, sb;
905         int saved_errno;
906
907         /* If user needs stat info, stat buffer already allocated. */
908         sbp = ISSET(FTS_NOSTAT) ? &sb : p->fts_statp;
909
910 #ifdef FTS_WHITEOUT
911         /* check for whiteout */
912         if (p->fts_flags & FTS_ISW) {
913                 if (sbp != &sb) {
914                         memset(sbp, '\0', sizeof (*sbp));
915                         sbp->st_mode = S_IFWHT;
916                 }
917                 return (FTS_W);
918         }
919 #endif
920
921         /*
922          * If doing a logical walk, or application requested FTS_FOLLOW, do
923          * a stat(2).  If that fails, check for a non-existent symlink.  If
924          * fail, set the errno from the stat call.
925          */
926         if (ISSET(FTS_LOGICAL) || follow) {
927                 if (stat(p->fts_accpath, sbp)) {
928                         saved_errno = errno;
929                         if (!lstat(p->fts_accpath, sbp)) {
930                                 errno = 0;
931                                 return (FTS_SLNONE);
932                         }
933                         p->fts_errno = saved_errno;
934                         goto err;
935                 }
936         } else if (lstat(p->fts_accpath, sbp)) {
937                 p->fts_errno = errno;
938 err:            memset(sbp, 0, sizeof(struct stat));
939                 return (FTS_NS);
940         }
941
942         if (S_ISDIR(sbp->st_mode)) {
943                 /*
944                  * Set the device/inode.  Used to find cycles and check for
945                  * crossing mount points.  Also remember the link count, used
946                  * in fts_build to limit the number of stat calls.  It is
947                  * understood that these fields are only referenced if fts_info
948                  * is set to FTS_D.
949                  */
950                 dev = p->fts_dev = sbp->st_dev;
951                 ino = p->fts_ino = sbp->st_ino;
952                 p->fts_nlink = sbp->st_nlink;
953
954                 if (ISDOT(p->fts_name))
955                         return (FTS_DOT);
956
957                 /*
958                  * Cycle detection is done by brute force when the directory
959                  * is first encountered.  If the tree gets deep enough or the
960                  * number of symbolic links to directories is high enough,
961                  * something faster might be worthwhile.
962                  */
963                 for (t = p->fts_parent;
964                     t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
965                         if (ino == t->fts_ino && dev == t->fts_dev) {
966                                 p->fts_cycle = t;
967                                 return (FTS_DC);
968                         }
969                 return (FTS_D);
970         }
971         if (S_ISLNK(sbp->st_mode))
972                 return (FTS_SL);
973         if (S_ISREG(sbp->st_mode))
974                 return (FTS_F);
975         return (FTS_DEFAULT);
976 }
977
978 /*
979  * The comparison function takes pointers to pointers to FTSENT structures.
980  * Qsort wants a comparison function that takes pointers to void.
981  * (Both with appropriate levels of const-poisoning, of course!)
982  * Use a trampoline function to deal with the difference.
983  */
984 static int
985 fts_compar(const void *a, const void *b)
986 {
987         FTS *parent;
988
989         parent = (*(const FTSENT * const *)a)->fts_fts;
990         return (*parent->fts_compar)(a, b);
991 }
992
993 static FTSENT *
994 fts_sort(sp, head, nitems)
995         FTS *sp;
996         FTSENT *head;
997         int nitems;
998 {
999         FTSENT **ap, *p;
1000
1001         /*
1002          * Construct an array of pointers to the structures and call qsort(3).
1003          * Reassemble the array in the order returned by qsort.  If unable to
1004          * sort for memory reasons, return the directory entries in their
1005          * current order.  Allocate enough space for the current needs plus
1006          * 40 so don't realloc one entry at a time.
1007          */
1008         if (nitems > sp->fts_nitems) {
1009                 sp->fts_nitems = nitems + 40;
1010                 if ((sp->fts_array = reallocf(sp->fts_array,
1011                     sp->fts_nitems * sizeof(FTSENT *))) == NULL) {
1012                         sp->fts_nitems = 0;
1013                         return (head);
1014                 }
1015         }
1016         for (ap = sp->fts_array, p = head; p; p = p->fts_link)
1017                 *ap++ = p;
1018         qsort(sp->fts_array, nitems, sizeof(FTSENT *), fts_compar);
1019         for (head = *(ap = sp->fts_array); --nitems; ++ap)
1020                 ap[0]->fts_link = ap[1];
1021         ap[0]->fts_link = NULL;
1022         return (head);
1023 }
1024
1025 static FTSENT *
1026 fts_alloc(sp, name, namelen)
1027         FTS *sp;
1028         char *name;
1029         int namelen;
1030 {
1031         FTSENT *p;
1032         size_t len;
1033
1034         struct ftsent_withstat {
1035                 FTSENT  ent;
1036                 struct  stat statbuf;
1037         };
1038
1039         /*
1040          * The file name is a variable length array and no stat structure is
1041          * necessary if the user has set the nostat bit.  Allocate the FTSENT
1042          * structure, the file name and the stat structure in one chunk, but
1043          * be careful that the stat structure is reasonably aligned.
1044          */
1045         if (ISSET(FTS_NOSTAT))
1046                 len = sizeof(FTSENT) + namelen + 1;
1047         else
1048                 len = sizeof(struct ftsent_withstat) + namelen + 1;
1049
1050         if ((p = malloc(len)) == NULL)
1051                 return (NULL);
1052
1053         if (ISSET(FTS_NOSTAT)) {
1054                 p->fts_name = (char *)(p + 1);
1055                 p->fts_statp = NULL;
1056         } else {
1057                 p->fts_name = (char *)((struct ftsent_withstat *)p + 1);
1058                 p->fts_statp = &((struct ftsent_withstat *)p)->statbuf;
1059         }
1060
1061         /* Copy the name and guarantee NUL termination. */
1062         memcpy(p->fts_name, name, namelen);
1063         p->fts_name[namelen] = '\0';
1064         p->fts_namelen = namelen;
1065         p->fts_path = sp->fts_path;
1066         p->fts_errno = 0;
1067         p->fts_flags = 0;
1068         p->fts_instr = FTS_NOINSTR;
1069         p->fts_number = 0;
1070         p->fts_pointer = NULL;
1071         p->fts_fts = sp;
1072         return (p);
1073 }
1074
1075 static void
1076 fts_lfree(head)
1077         FTSENT *head;
1078 {
1079         FTSENT *p;
1080
1081         /* Free a linked list of structures. */
1082         while ((p = head)) {
1083                 head = head->fts_link;
1084                 free(p);
1085         }
1086 }
1087
1088 /*
1089  * Allow essentially unlimited paths; find, rm, ls should all work on any tree.
1090  * Most systems will allow creation of paths much longer than MAXPATHLEN, even
1091  * though the kernel won't resolve them.  Add the size (not just what's needed)
1092  * plus 256 bytes so don't realloc the path 2 bytes at a time.
1093  */
1094 static int
1095 fts_palloc(sp, more)
1096         FTS *sp;
1097         size_t more;
1098 {
1099
1100         sp->fts_pathlen += more + 256;
1101         /*
1102          * Check for possible wraparound.  In an FTS, fts_pathlen is
1103          * a signed int but in an FTSENT it is an unsigned short.
1104          * We limit fts_pathlen to USHRT_MAX to be safe in both cases.
1105          */
1106         if (sp->fts_pathlen < 0 || sp->fts_pathlen >= USHRT_MAX) {
1107                 if (sp->fts_path)
1108                         free(sp->fts_path);
1109                 sp->fts_path = NULL;
1110                 errno = ENAMETOOLONG;
1111                 return (1);
1112         }
1113         sp->fts_path = reallocf(sp->fts_path, sp->fts_pathlen);
1114         return (sp->fts_path == NULL);
1115 }
1116
1117 /*
1118  * When the path is realloc'd, have to fix all of the pointers in structures
1119  * already returned.
1120  */
1121 static void
1122 fts_padjust(sp, head)
1123         FTS *sp;
1124         FTSENT *head;
1125 {
1126         FTSENT *p;
1127         char *addr = sp->fts_path;
1128
1129 #define ADJUST(p) do {                                                  \
1130         if ((p)->fts_accpath != (p)->fts_name) {                        \
1131                 (p)->fts_accpath =                                      \
1132                     (char *)addr + ((p)->fts_accpath - (p)->fts_path);  \
1133         }                                                               \
1134         (p)->fts_path = addr;                                           \
1135 } while (0)
1136         /* Adjust the current set of children. */
1137         for (p = sp->fts_child; p; p = p->fts_link)
1138                 ADJUST(p);
1139
1140         /* Adjust the rest of the tree, including the current level. */
1141         for (p = head; p->fts_level >= FTS_ROOTLEVEL;) {
1142                 ADJUST(p);
1143                 p = p->fts_link ? p->fts_link : p->fts_parent;
1144         }
1145 }
1146
1147 static size_t
1148 fts_maxarglen(argv)
1149         char * const *argv;
1150 {
1151         size_t len, max;
1152
1153         for (max = 0; *argv; ++argv)
1154                 if ((len = strlen(*argv)) > max)
1155                         max = len;
1156         return (max + 1);
1157 }
1158
1159 /*
1160  * Change to dir specified by fd or p->fts_accpath without getting
1161  * tricked by someone changing the world out from underneath us.
1162  * Assumes p->fts_dev and p->fts_ino are filled in.
1163  */
1164 static int
1165 fts_safe_changedir(sp, p, fd, path)
1166         FTS *sp;
1167         FTSENT *p;
1168         int fd;
1169         char *path;
1170 {
1171         int ret, oerrno, newfd;
1172         struct stat sb;
1173
1174         newfd = fd;
1175         if (ISSET(FTS_NOCHDIR))
1176                 return (0);
1177         if (fd < 0 && (newfd = _open(path, O_RDONLY, 0)) < 0)
1178                 return (-1);
1179         if (_fstat(newfd, &sb)) {
1180                 ret = -1;
1181                 goto bail;
1182         }
1183         if (p->fts_dev != sb.st_dev || p->fts_ino != sb.st_ino) {
1184                 errno = ENOENT;         /* disinformation */
1185                 ret = -1;
1186                 goto bail;
1187         }
1188         ret = fchdir(newfd);
1189 bail:
1190         oerrno = errno;
1191         if (fd < 0)
1192                 (void)_close(newfd);
1193         errno = oerrno;
1194         return (ret);
1195 }