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 * @(#)fts.h 8.3 (Berkeley) 8/14/94 32 */ 33 34#ifndef _FTS_H_ 35#define _FTS_H_ 36 37#include <stdint.h> 38#include <stddef.h> 39#include <sys/types.h> 40#include <sys/stat.h> 41#include <dirent.h> 42 43// 44// Use Linux API 45// 46// (flag) = (flag) to disable gcc's unused-but-set-variable warning 47// In FreeBSD we have #define __opendir2(path, flag) opendir(path) 48// https://github.com/freebsd/freebsd-src/blob/373ffc6/lib/libc/gen/fts-compat.c#L653 49// { 50#define __opendir2(path, flag) (((flag) = (flag)), (opendir((path)))) 51// } 52#define _close(fd) (close((fd))) 53#define _dirfd(dirp) (dirfd((dirp))) 54#define _fstat(fd, statbuf) (fstat((fd), (statbuf))) 55#define _open(pathname, flags, mode) (open((pathname), (flags), (mode))) 56#define reallocf(ptr, size) (realloc((ptr), (size))) 57 58// __size_t is a macro defined in stddef.h, not a type, so we define a new type 59typedef size_t __fts_size_t; 60typedef uint64_t __dev_t; 61#ifndef WITH_FREEBSD 62typedef uint64_t __ino_t; 63typedef uint64_t __nlink_t; 64#endif 65// 66// From https://github.com/freebsd/freebsd-src/blob/e81e71b/sys/sys/stat.h 67// 68#define S_IFWHT (0160000) /* whiteout */ 69 70// 71// From https://github.com/freebsd/freebsd-src/blob/373ffc6/include/dirent.h 72// 73#define DTF_HIDEW (0x0001) /* hide whiteout entries */ 74#define DTF_NODUP (0x0002) /* don't return duplicate names */ 75#define DTF_REWIND (0x0004) /* rewind after reading union stack */ 76#define __DTF_READALL (0x0008) /* everything has been read */ 77#define __DTF_SKIPREAD (0x0010) /* assume internal buffer is populated */ 78 79typedef struct { 80 struct _ftsent *fts_cur; /* current node */ 81 struct _ftsent *fts_child; /* linked list of children */ 82 struct _ftsent **fts_array; /* sort array */ 83 __dev_t fts_dev; /* starting device # */ 84 char *fts_path; /* path for this descent */ 85 int fts_rfd; /* fd for root */ 86 __fts_size_t fts_pathlen; /* sizeof(path) */ 87 __fts_size_t fts_nitems; /* elements in the sort array */ 88 int (*fts_compar) /* compare function */ 89 (const struct _ftsent * const *, const struct _ftsent * const *); 90 91#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */ 92#define FTS_LOGICAL 0x002 /* logical walk */ 93#define FTS_NOCHDIR 0x004 /* don't change directories */ 94#define FTS_NOSTAT 0x008 /* don't get stat info */ 95#define FTS_PHYSICAL 0x010 /* physical walk */ 96#define FTS_SEEDOT 0x020 /* return dot and dot-dot */ 97#define FTS_XDEV 0x040 /* don't cross devices */ 98#define FTS_WHITEOUT 0x080 /* return whiteout information */ 99#define FTS_OPTIONMASK 0x0ff /* valid user option mask */ 100 101#define FTS_NAMEONLY 0x100 /* (private) child names only */ 102#define FTS_STOP 0x200 /* (private) unrecoverable error */ 103 int fts_options; /* fts_open options, global flags */ 104 void *fts_clientptr; /* thunk for sort function */ 105} FTS; 106 107typedef struct _ftsent { 108 struct _ftsent *fts_cycle; /* cycle node */ 109 struct _ftsent *fts_parent; /* parent directory */ 110 struct _ftsent *fts_link; /* next file in directory */ 111 long long fts_number; /* local numeric value */ 112#define fts_bignum fts_number /* XXX non-std, should go away */ 113 void *fts_pointer; /* local address value */ 114 char *fts_accpath; /* access path */ 115 char *fts_path; /* root path */ 116 int fts_errno; /* errno for this node */ 117 int fts_symfd; /* fd for symlink */ 118 __fts_size_t fts_pathlen; /* strlen(fts_path) */ 119 __fts_size_t fts_namelen; /* strlen(fts_name) */ 120 121 __ino_t fts_ino; /* inode */ 122 __dev_t fts_dev; /* device */ 123 __nlink_t fts_nlink; /* link count */ 124 125#define FTS_ROOTPARENTLEVEL -1 126#define FTS_ROOTLEVEL 0 127 long fts_level; /* depth (-1 to N) */ 128 129#define FTS_D 1 /* preorder directory */ 130#define FTS_DC 2 /* directory that causes cycles */ 131#define FTS_DEFAULT 3 /* none of the above */ 132#define FTS_DNR 4 /* unreadable directory */ 133#define FTS_DOT 5 /* dot or dot-dot */ 134#define FTS_DP 6 /* postorder directory */ 135#define FTS_ERR 7 /* error; errno is set */ 136#define FTS_F 8 /* regular file */ 137#define FTS_INIT 9 /* initialized only */ 138#define FTS_NS 10 /* stat(2) failed */ 139#define FTS_NSOK 11 /* no stat(2) requested */ 140#define FTS_SL 12 /* symbolic link */ 141#define FTS_SLNONE 13 /* symbolic link without target */ 142#define FTS_W 14 /* whiteout object */ 143 int fts_info; /* user status for FTSENT structure */ 144 145#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */ 146#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */ 147#define FTS_ISW 0x04 /* this is a whiteout object */ 148 unsigned fts_flags; /* private flags for FTSENT structure */ 149 150#define FTS_AGAIN 1 /* read node again */ 151#define FTS_FOLLOW 2 /* follow symbolic link */ 152#define FTS_NOINSTR 3 /* no instructions */ 153#define FTS_SKIP 4 /* discard node */ 154 int fts_instr; /* fts_set() instructions */ 155 156 struct stat *fts_statp; /* stat(2) information */ 157 char *fts_name; /* file name */ 158 FTS *fts_fts; /* back pointer to main FTS */ 159} FTSENT; 160 161#ifndef WITH_FREEBSD 162#include <sys/sys/cdefs.h> 163#endif 164 165__BEGIN_DECLS 166FTSENT *fts_children(FTS *, int); 167int fts_close(FTS *); 168void *fts_get_clientptr(FTS *); 169#define fts_get_clientptr(fts) ((fts)->fts_clientptr) 170FTS *fts_get_stream(FTSENT *); 171#define fts_get_stream(ftsent) ((ftsent)->fts_fts) 172FTS *fts_open(char * const *, int, 173 int (*)(const FTSENT * const *, const FTSENT * const *)); 174FTSENT *fts_read(FTS *); 175int fts_set(FTS *, FTSENT *, int); 176void fts_set_clientptr(FTS *, void *); 177__END_DECLS 178 179#endif /* !_FTS_H_ */ 180