lib/libc/gen/fts-compat.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef _FTS_H_
  33 #define _FTS_H_
  34
  35 typedef struct {
  36         struct _ftsent *fts_cur;        /* current node */
  37         struct _ftsent *fts_child;      /* linked list of children */
  38         struct _ftsent **fts_array;     /* sort array */
  39         uint32_t fts_dev;               /* starting device # */
  40         char *fts_path;                 /* path for this descent */
  41         int fts_rfd;                    /* fd for root */
  42         int fts_pathlen;                /* sizeof(path) */
  43         int fts_nitems;                 /* elements in the sort array */
  44         int (*fts_compar)               /* compare function */
  45             (const struct _ftsent * const *, const struct _ftsent * const *);
  46
  47 #define FTS_COMFOLLOW   0x001           /* follow command line symlinks */
  48 #define FTS_LOGICAL     0x002           /* logical walk */
  49 #define FTS_NOCHDIR     0x004           /* don't change directories */
  50 #define FTS_NOSTAT      0x008           /* don't get stat info */
  51 #define FTS_PHYSICAL    0x010           /* physical walk */
  52 #define FTS_SEEDOT      0x020           /* return dot and dot-dot */
  53 #define FTS_XDEV        0x040           /* don't cross devices */
  54 #define FTS_WHITEOUT    0x080           /* return whiteout information */
  55 #define FTS_OPTIONMASK  0x0ff           /* valid user option mask */
  56
  57 #define FTS_NAMEONLY    0x100           /* (private) child names only */
  58 #define FTS_STOP        0x200           /* (private) unrecoverable error */
  59         int fts_options;                /* fts_open options, global flags */
  60         void *fts_clientptr;            /* thunk for sort function */
  61 } FTS;
  62
  63 typedef struct _ftsent {
  64         struct _ftsent *fts_cycle;      /* cycle node */
  65         struct _ftsent *fts_parent;     /* parent directory */
  66         struct _ftsent *fts_link;       /* next file in directory */
  67         union {
  68                 struct {
  69                         long __fts_number;      /* local numeric value */
  70                         void *__fts_pointer;    /* local address value */
  71                 } __struct_ftsent;
  72                 int64_t __fts_bignum;
  73         } __union_ftsent;
  74 #define fts_number      __union_ftsent.__struct_ftsent.__fts_number
  75 #define fts_pointer     __union_ftsent.__struct_ftsent.__fts_pointer
  76 #define fts_bignum      __union_ftsent.__fts_bignum
  77         char *fts_accpath;              /* access path */
  78         char *fts_path;                 /* root path */
  79         int fts_errno;                  /* errno for this node */
  80         int fts_symfd;                  /* fd for symlink */
  81         u_short fts_pathlen;            /* strlen(fts_path) */
  82         u_short fts_namelen;            /* strlen(fts_name) */
  83
  84         uint32_t fts_ino;               /* inode */
  85         uint32_t fts_dev;               /* device */
  86         uint16_t fts_nlink;             /* link count */
  87
  88 #define FTS_ROOTPARENTLEVEL     -1
  89 #define FTS_ROOTLEVEL            0
  90         short fts_level;                /* depth (-1 to N) */
  91
  92 #define FTS_D            1              /* preorder directory */
  93 #define FTS_DC           2              /* directory that causes cycles */
  94 #define FTS_DEFAULT      3              /* none of the above */
  95 #define FTS_DNR          4              /* unreadable directory */
  96 #define FTS_DOT          5              /* dot or dot-dot */
  97 #define FTS_DP           6              /* postorder directory */
  98 #define FTS_ERR          7              /* error; errno is set */
  99 #define FTS_F            8              /* regular file */
 100 #define FTS_INIT         9              /* initialized only */
 101 #define FTS_NS          10              /* stat(2) failed */
 102 #define FTS_NSOK        11              /* no stat(2) requested */
 103 #define FTS_SL          12              /* symbolic link */
 104 #define FTS_SLNONE      13              /* symbolic link without target */
 105 #define FTS_W           14              /* whiteout object */
 106         u_short fts_info;               /* user flags for FTSENT structure */
 107
 108 #define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
 109 #define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
 110 #define FTS_ISW          0x04           /* this is a whiteout object */
 111         u_short fts_flags;              /* private flags for FTSENT structure */
 112
 113 #define FTS_AGAIN        1              /* read node again */
 114 #define FTS_FOLLOW       2              /* follow symbolic link */
 115 #define FTS_NOINSTR      3              /* no instructions */
 116 #define FTS_SKIP         4              /* discard node */
 117         u_short fts_instr;              /* fts_set() instructions */
 118
 119         struct freebsd11_stat *fts_statp; /* stat(2) information */
 120         char *fts_name;                 /* file name */
 121         FTS *fts_fts;                   /* back pointer to main FTS */
 122 } FTSENT;
 123
 124 #define  fts_get_clientptr(fts) ((fts)->fts_clientptr)
 125 #define  fts_get_stream(ftsent) ((ftsent)->fts_fts)
 126
 127 #endif /* !_FTS_H_ */