io/fts.c

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