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 #include <sys/_types.h> 36 37 typedef struct { 38 struct _ftsent *fts_cur; /* current node */ 39 struct _ftsent *fts_child; /* linked list of children */ 40 struct _ftsent **fts_array; /* sort array */ 41 __dev_t fts_dev; /* starting device # */ 42 char *fts_path; /* path for this descent */ 43 int fts_rfd; /* fd for root */ 44 __size_t fts_pathlen; /* sizeof(path) */ 45 __size_t fts_nitems; /* elements in the sort array */ 46 int (*fts_compar) /* compare function */ 47 (const struct _ftsent * const *, const struct _ftsent * const *); 48 49 /* valid for fts_open() */ 50 #define FTS_COMFOLLOW 0x000001 /* follow command line symlinks */ 51 #define FTS_LOGICAL 0x000002 /* logical walk */ 52 #define FTS_NOCHDIR 0x000004 /* don't change directories */ 53 #define FTS_NOSTAT 0x000008 /* don't get stat info */ 54 #define FTS_PHYSICAL 0x000010 /* physical walk */ 55 #define FTS_SEEDOT 0x000020 /* return dot and dot-dot */ 56 #define FTS_XDEV 0x000040 /* don't cross devices */ 57 #define FTS_WHITEOUT 0x000080 /* return whiteout information */ 58 #define FTS_OPTIONMASK 0x0000ff /* valid user option mask */ 59 60 /* valid only for fts_children() */ 61 #define FTS_NAMEONLY 0x000100 /* child names only */ 62 63 /* internal use only */ 64 #define FTS_STOP 0x010000 /* unrecoverable error */ 65 int fts_options; /* fts_open options, global flags */ 66 void *fts_clientptr; /* thunk for sort function */ 67 } FTS; 68 69 typedef struct _ftsent { 70 struct _ftsent *fts_cycle; /* cycle node */ 71 struct _ftsent *fts_parent; /* parent directory */ 72 struct _ftsent *fts_link; /* next file in directory */ 73 long long fts_number; /* local numeric value */ 74 #define fts_bignum fts_number /* XXX non-std, should go away */ 75 void *fts_pointer; /* local address value */ 76 char *fts_accpath; /* access path */ 77 char *fts_path; /* root path */ 78 int fts_errno; /* errno for this node */ 79 int fts_symfd; /* fd for symlink */ 80 __size_t fts_pathlen; /* strlen(fts_path) */ 81 __size_t fts_namelen; /* strlen(fts_name) */ 82 83 __ino_t fts_ino; /* inode */ 84 __dev_t fts_dev; /* device */ 85 __nlink_t fts_nlink; /* link count */ 86 87 #define FTS_ROOTPARENTLEVEL -1 88 #define FTS_ROOTLEVEL 0 89 long fts_level; /* depth (-1 to N) */ 90 91 #define FTS_D 1 /* preorder directory */ 92 #define FTS_DC 2 /* directory that causes cycles */ 93 #define FTS_DEFAULT 3 /* none of the above */ 94 #define FTS_DNR 4 /* unreadable directory */ 95 #define FTS_DOT 5 /* dot or dot-dot */ 96 #define FTS_DP 6 /* postorder directory */ 97 #define FTS_ERR 7 /* error; errno is set */ 98 #define FTS_F 8 /* regular file */ 99 #define FTS_INIT 9 /* initialized only */ 100 #define FTS_NS 10 /* stat(2) failed */ 101 #define FTS_NSOK 11 /* no stat(2) requested */ 102 #define FTS_SL 12 /* symbolic link */ 103 #define FTS_SLNONE 13 /* symbolic link without target */ 104 #define FTS_W 14 /* whiteout object */ 105 int fts_info; /* user status for FTSENT structure */ 106 107 #define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */ 108 #define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */ 109 #define FTS_ISW 0x04 /* this is a whiteout object */ 110 unsigned fts_flags; /* private flags for FTSENT structure */ 111 112 #define FTS_AGAIN 1 /* read node again */ 113 #define FTS_FOLLOW 2 /* follow symbolic link */ 114 #define FTS_NOINSTR 3 /* no instructions */ 115 #define FTS_SKIP 4 /* discard node */ 116 int fts_instr; /* fts_set() instructions */ 117 118 struct stat *fts_statp; /* stat(2) information */ 119 char *fts_name; /* file name */ 120 FTS *fts_fts; /* back pointer to main FTS */ 121 } FTSENT; 122 123 #include <sys/cdefs.h> 124 125 __BEGIN_DECLS 126 FTSENT *fts_children(FTS *, int); 127 int fts_close(FTS *); 128 void *fts_get_clientptr(FTS *); 129 #define fts_get_clientptr(fts) ((fts)->fts_clientptr) 130 FTS *fts_get_stream(FTSENT *); 131 #define fts_get_stream(ftsent) ((ftsent)->fts_fts) 132 FTS *fts_open(char * const *, int, 133 int (*)(const FTSENT * const *, const FTSENT * const *)); 134 FTSENT *fts_read(FTS *); 135 int fts_set(FTS *, FTSENT *, int); 136 void fts_set_clientptr(FTS *, void *); 137 __END_DECLS 138 139 #endif /* !_FTS_H_ */ 140