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