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