master
1/*
2 * Copyright (c) 2000, 2003-2006, 2008, 2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23/*
24 * Copyright (c) 1989, 1993
25 * The Regents of the University of California. All rights reserved.
26 *
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
29 * are met:
30 * 1. Redistributions of source code must retain the above copyright
31 * notice, this list of conditions and the following disclaimer.
32 * 2. Redistributions in binary form must reproduce the above copyright
33 * notice, this list of conditions and the following disclaimer in the
34 * documentation and/or other materials provided with the distribution.
35 * 3. All advertising materials mentioning features or use of this software
36 * must display the following acknowledgement:
37 * This product includes software developed by the University of
38 * California, Berkeley and its contributors.
39 * 4. Neither the name of the University nor the names of its contributors
40 * may be used to endorse or promote products derived from this software
41 * without specific prior written permission.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * SUCH DAMAGE.
54 *
55 * @(#)fts.h 8.3 (Berkeley) 8/14/94
56 */
57
58#ifndef _FTS_H_
59#define _FTS_H_
60
61#include <sys/_types.h>
62#include <sys/_types/_dev_t.h>
63#include <sys/_types/_ino_t.h>
64#include <sys/_types/_nlink_t.h>
65
66#include <_bounds.h>
67#include <Availability.h>
68
69_LIBC_SINGLE_BY_DEFAULT()
70
71#pragma clang diagnostic push
72#pragma clang diagnostic ignored "-Wstrict-prototypes"
73
74typedef struct {
75 struct _ftsent *fts_cur; /* current node */
76 struct _ftsent *fts_child; /* linked list of children */
77 struct _ftsent **_LIBC_COUNT(fts_nitems) fts_array; /* sort array */
78 dev_t fts_dev; /* starting device # */
79 char *fts_path; /* path for this descent */
80 int fts_rfd; /* fd for root */
81 int fts_pathlen; /* sizeof(path) */
82 int fts_nitems; /* elements in the sort array */
83#ifdef __BLOCKS__
84 union {
85#endif /* __BLOCKS__ */
86 int (*fts_compar)(); /* compare function */
87#ifdef __BLOCKS__
88 int (^fts_compar_b)(); /* compare block */
89 };
90#endif /* __BLOCKS__ */
91
92#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */
93#define FTS_LOGICAL 0x002 /* logical walk */
94#define FTS_NOCHDIR 0x004 /* don't change directories */
95#define FTS_NOSTAT 0x008 /* don't get stat info */
96#define FTS_PHYSICAL 0x010 /* physical walk */
97#define FTS_SEEDOT 0x020 /* return dot and dot-dot */
98#define FTS_XDEV 0x040 /* don't cross devices */
99#define FTS_WHITEOUT 0x080 /* (no longer supported) return whiteout information */
100#define FTS_COMFOLLOWDIR 0x400 /* (non-std) follow command line symlinks for directories only */
101#if (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < 1090) || (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < 70000)
102#define FTS_OPTIONMASK 0x4ff /* valid user option mask */
103#else
104#define FTS_NOSTAT_TYPE 0x800 /* (non-std) no stat, but use d_type in struct dirent when available */
105#define FTS_OPTIONMASK 0xcff /* valid user option mask */
106#endif
107
108#define FTS_NAMEONLY 0x100 /* (private) child names only */
109#define FTS_STOP 0x200 /* (private) unrecoverable error */
110#define FTS_THREAD_FCHDIR 0x400 /* (private) use pthread_fchdir_np */
111#ifdef __BLOCKS__
112#define FTS_BLOCK_COMPAR 0x80000000 /* fts_compar is a block */
113#endif /* __BLOCKS__ */
114 int fts_options; /* fts_open options, global flags */
115} FTS;
116
117typedef struct _ftsent {
118 struct _ftsent *fts_cycle; /* cycle node */
119 struct _ftsent *fts_parent; /* parent directory */
120 struct _ftsent *fts_link; /* next file in directory */
121 long fts_number; /* local numeric value */
122 void *fts_pointer; /* local address value */
123 char *_LIBC_CSTR fts_accpath; /* access path */
124 char *_LIBC_CSTR fts_path; /* root path */
125 int fts_errno; /* errno for this node */
126 int fts_symfd; /* fd for symlink or chdir */
127 unsigned short fts_pathlen; /* strlen(fts_path) */
128 unsigned short fts_namelen; /* strlen(fts_name) */
129
130 ino_t fts_ino; /* inode */
131 dev_t fts_dev; /* device */
132 nlink_t fts_nlink; /* link count */
133
134#define FTS_ROOTPARENTLEVEL -1
135#define FTS_ROOTLEVEL 0
136#define FTS_MAXLEVEL 0x7fffffff
137 short fts_level; /* depth (-1 to N) */
138
139#define FTS_D 1 /* preorder directory */
140#define FTS_DC 2 /* directory that causes cycles */
141#define FTS_DEFAULT 3 /* none of the above */
142#define FTS_DNR 4 /* unreadable directory */
143#define FTS_DOT 5 /* dot or dot-dot */
144#define FTS_DP 6 /* postorder directory */
145#define FTS_ERR 7 /* error; errno is set */
146#define FTS_F 8 /* regular file */
147#define FTS_INIT 9 /* initialized only */
148#define FTS_NS 10 /* stat(2) failed */
149#define FTS_NSOK 11 /* no stat(2) requested */
150#define FTS_SL 12 /* symbolic link */
151#define FTS_SLNONE 13 /* symbolic link without target */
152#define FTS_W 14 /* whiteout object */
153 unsigned short fts_info; /* user flags for FTSENT structure */
154
155#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
156#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
157#define FTS_ISW 0x04 /* this is a whiteout object */
158#define FTS_CHDIRFD 0x08 /* indicates the fts_symfd field was set for chdir */
159 unsigned short fts_flags; /* private flags for FTSENT structure */
160
161#define FTS_AGAIN 1 /* read node again */
162#define FTS_FOLLOW 2 /* follow symbolic link */
163#define FTS_NOINSTR 3 /* no instructions */
164#define FTS_SKIP 4 /* discard node */
165 unsigned short fts_instr; /* fts_set() instructions */
166
167 struct stat *fts_statp; /* stat(2) information */
168 char fts_name[1]; /* file name, unsafe with -fbounds-safety */
169} FTSENT;
170
171#include <sys/cdefs.h>
172#include <Availability.h>
173
174__BEGIN_DECLS
175FTSENT *fts_children(FTS *, int) __DARWIN_INODE64(fts_children);
176int fts_close(FTS *) __DARWIN_INODE64(fts_close);
177FTS *fts_open(char *_LIBC_CSTR const *, int,
178 int (*)(const FTSENT **, const FTSENT **)) __DARWIN_INODE64(fts_open);
179#ifdef __BLOCKS__
180#if __has_attribute(noescape)
181#define __fts_noescape __attribute__((__noescape__))
182#else
183#define __fts_noescape
184#endif
185FTS *fts_open_b(char *_LIBC_CSTR const *, int,
186 int (^)(const FTSENT **, const FTSENT **) __fts_noescape)
187 __DARWIN_INODE64(fts_open_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
188#endif /* __BLOCKS__ */
189FTSENT *fts_read(FTS *) __DARWIN_INODE64(fts_read);
190int fts_set(FTS *, FTSENT *, int) __DARWIN_INODE64(fts_set);
191__END_DECLS
192
193#pragma clang diagnostic pop
194#endif /* !_FTS_H_ */
195