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