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