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