lib/fts_.h

   1 /*
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)fts.h       8.3 (Berkeley) 8/14/94
  30  */
  31
  32 #ifndef _FTS_H
  33 # define _FTS_H 1
  34
  35 # ifdef _LIBC
  36 #  include <features.h>
  37 # else
  38 #  undef __THROW
  39 #  define __THROW
  40 #  undef __BEGIN_DECLS
  41 #  define __BEGIN_DECLS
  42 #  undef __END_DECLS
  43 #  define __END_DECLS
  44 # endif
  45
  46 # include <sys/types.h>
  47 # include "hash.h"
  48 # include "cycle-check.h"
  49
  50 typedef struct {
  51         struct _ftsent *fts_cur;        /* current node */
  52         struct _ftsent *fts_child;      /* linked list of children */
  53         struct _ftsent **fts_array;     /* sort array */
  54         dev_t fts_dev;                  /* starting device # */
  55         char *fts_path;                 /* path for this descent */
  56         int fts_rfd;                    /* fd for root */
  57         size_t fts_pathlen;             /* sizeof(path) */
  58         int fts_nitems;                 /* elements in the sort array */
  59         int (*fts_compar) (const void *, const void *); /* compare fn */
  60
  61 # define FTS_COMFOLLOW  0x0001          /* follow command line symlinks */
  62 # define FTS_LOGICAL    0x0002          /* logical walk */
  63 # define FTS_NOCHDIR    0x0004          /* don't change directories */
  64 # define FTS_NOSTAT     0x0008          /* don't get stat info */
  65 # define FTS_PHYSICAL   0x0010          /* physical walk */
  66 # define FTS_SEEDOT     0x0020          /* return dot and dot-dot */
  67 # define FTS_XDEV       0x0040          /* don't cross devices */
  68 # define FTS_WHITEOUT   0x0080          /* return whiteout information */
  69
  70   /* There are two ways to detect cycles.
  71      The lazy way, with which one may process a directory that is a
  72      part of the cycle several times before detecting the cycle.
  73      The `tight' way, whereby fts uses more memory (proportional
  74      to number of `active' directories, aka distance from root
  75      of current tree to current directory -- see active_dir_ht)
  76      to detect any cycle right away.  For example, du must use
  77      this option to avoid counting disk space in a cycle multiple
  78      times, but chown -R need not.
  79      The default is to use the constant-memory lazy way. */
  80 # define FTS_TIGHT_CYCLE_CHECK  0x0100
  81
  82 # define FTS_OPTIONMASK 0x01ff          /* valid user option mask */
  83
  84 # define FTS_NAMEONLY   0x1000          /* (private) child names only */
  85 # define FTS_STOP       0x2000          /* (private) unrecoverable error */
  86         int fts_options;                /* fts_open options, global flags */
  87
  88         /* This data structure records the directories between a starting
  89            point and the current directory.  I.e., a directory is recorded
  90            here IFF we have visited it once, but we have not yet completed
  91            processing of all its entries.  Every time we visit a new directory,
  92            we add that directory to this set.  When we finish with a directory
  93            (usually by visiting it a second time), we remove it from this
  94            set.  Each entry in this data structure is a device/inode pair.
  95            This data structure is used to detect directory cycles efficiently
  96            and promptly even when the depth of a hierarchy is in the tens
  97            of thousands.  Lazy checking, as done by GNU rm via cycle-check.c,
  98            wouldn't be appropriate for du.  */
  99         Hash_table *active_dir_ht;
 100         struct cycle_check_state *cycle_state;
 101 } FTS;
 102
 103 typedef struct _ftsent {
 104         struct _ftsent *fts_cycle;      /* cycle node */
 105         struct _ftsent *fts_parent;     /* parent directory */
 106         struct _ftsent *fts_link;       /* next file in directory */
 107         long fts_number;                /* local numeric value */
 108         void *fts_pointer;              /* local address value */
 109         char *fts_accpath;              /* access path */
 110         char *fts_path;                 /* root path */
 111         int fts_errno;                  /* errno for this node */
 112         int fts_symfd;                  /* fd for symlink */
 113         size_t fts_pathlen;             /* strlen(fts_path) */
 114
 115         ino_t fts_ino;                  /* inode */
 116         dev_t fts_dev;                  /* device */
 117         nlink_t fts_nlink;              /* link count */
 118
 119 # define FTS_ROOTPARENTLEVEL    -1
 120 # define FTS_ROOTLEVEL           0
 121         int fts_level;                  /* depth (-1 to N) */
 122
 123         u_short fts_namelen;            /* strlen(fts_name) */
 124
 125 # define FTS_D           1              /* preorder directory */
 126 # define FTS_DC          2              /* directory that causes cycles */
 127 # define FTS_DEFAULT     3              /* none of the above */
 128 # define FTS_DNR         4              /* unreadable directory */
 129 # define FTS_DOT         5              /* dot or dot-dot */
 130 # define FTS_DP          6              /* postorder directory */
 131 # define FTS_ERR         7              /* error; errno is set */
 132 # define FTS_F           8              /* regular file */
 133 # define FTS_INIT        9              /* initialized only */
 134 # define FTS_NS         10              /* stat(2) failed */
 135 # define FTS_NSOK       11              /* no stat(2) requested */
 136 # define FTS_SL         12              /* symbolic link */
 137 # define FTS_SLNONE     13              /* symbolic link without target */
 138 # define FTS_W          14              /* whiteout object */
 139         u_short fts_info;               /* user flags for FTSENT structure */
 140
 141 # define FTS_DONTCHDIR   0x01           /* don't chdir .. to the parent */
 142 # define FTS_SYMFOLLOW   0x02           /* followed a symlink to get here */
 143         u_short fts_flags;              /* private flags for FTSENT structure */
 144
 145 # define FTS_AGAIN       1              /* read node again */
 146 # define FTS_FOLLOW      2              /* follow symbolic link */
 147 # define FTS_NOINSTR     3              /* no instructions */
 148 # define FTS_SKIP        4              /* discard node */
 149         u_short fts_instr;              /* fts_set() instructions */
 150
 151         struct stat *fts_statp;         /* stat(2) information */
 152         char fts_name[1];               /* file name */
 153 } FTSENT;
 154
 155 __BEGIN_DECLS
 156 FTSENT  *fts_children (FTS *, int) __THROW;
 157 int      fts_close (FTS *) __THROW;
 158 FTS     *fts_open (char * const *, int,
 159                    int (*)(const FTSENT **, const FTSENT **)) __THROW;
 160 FTSENT  *fts_read (FTS *) __THROW;
 161 int      fts_set (FTS *, FTSENT *, int) __THROW;
 162 __END_DECLS
 163
 164 #endif /* fts.h */