1/*
2 * Copyright (c) 2000, 2002-2008 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 * @(#)dirent.h 8.2 (Berkeley) 7/28/94
56 */
57
58#ifndef _DIRENT_H_
59#define _DIRENT_H_
60
61/*
62 * The kernel defines the format of directory entries
63 */
64#include <_bounds.h>
65#include <_types.h>
66#include <sys/dirent.h>
67#include <sys/cdefs.h>
68#include <Availability.h>
69#include <sys/_pthread/_pthread_types.h> /* __darwin_pthread_mutex_t */
70#include <sys/_types/_size_t.h>
71
72_LIBC_SINGLE_BY_DEFAULT()
73
74struct _telldir; /* forward reference */
75
76/* structure describing an open directory. */
77typedef struct {
78 int __dd_fd; /* file descriptor associated with directory */
79 size_t __dd_loc; /* offset in current buffer */
80 size_t __dd_size; /* amount of data returned */
81 char *_LIBC_COUNT(__dd_len) __dd_buf; /* data buffer */
82 int __dd_len; /* size of data buffer */
83 long __dd_seek; /* magic cookie returned */
84 __unused long __padding; /* (__dd_rewind space left for bincompat) */
85 int __dd_flags; /* flags for readdir */
86 __darwin_pthread_mutex_t __dd_lock; /* for thread locking */
87 struct _telldir *__dd_td; /* telldir position recording */
88} DIR;
89
90#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
91
92/* definitions for library routines operating on directories. */
93#define DIRBLKSIZ 1024
94
95/* flags for opendir2 */
96#define DTF_HIDEW 0x0001 /* hide whiteout entries */
97#define DTF_NODUP 0x0002 /* don't return duplicate names */
98#define DTF_REWIND 0x0004 /* rewind after reading union stack */
99#define __DTF_READALL 0x0008 /* everything has been read */
100#define __DTF_SKIPREAD 0x0010 /* assume internal buffer is populated */
101#define __DTF_ATEND 0x0020 /* there's nothing more to read in the kernel */
102
103#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
104
105#ifndef KERNEL
106
107__BEGIN_DECLS
108
109int closedir(DIR *) __DARWIN_ALIAS(closedir);
110
111DIR *opendir(const char *) __DARWIN_ALIAS_I(opendir);
112
113struct dirent *readdir(DIR *) __DARWIN_INODE64(readdir);
114__deprecated_msg("This function cannot be used safely as it does not take into account the variability of {NAME_MAX}. It is highly recommended that you use readdir(3) instead.")
115int readdir_r(DIR *, struct dirent *, struct dirent **) __DARWIN_INODE64(readdir_r);
116
117void rewinddir(DIR *) __DARWIN_ALIAS_I(rewinddir);
118
119void seekdir(DIR *, long) __DARWIN_ALIAS_I(seekdir);
120
121long telldir(DIR *) __DARWIN_ALIAS_I(telldir);
122
123__END_DECLS
124
125
126/* Additional functionality provided by:
127 * POSIX.1-2008
128 */
129
130#if __DARWIN_C_LEVEL >= 200809L
131__BEGIN_DECLS
132
133__OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
134DIR *fdopendir(int) __DARWIN_ALIAS_I(fdopendir);
135
136int alphasort(const struct dirent **, const struct dirent **) __DARWIN_INODE64(alphasort);
137
138#if (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_8) || (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_6_0)
139#include <errno.h>
140#include <stdlib.h>
141#define dirfd(dirp) ({ \
142 DIR *_dirp = (dirp); \
143 int ret = -1; \
144 if (_dirp == NULL || _dirp->__dd_fd < 0) \
145 errno = EINVAL; \
146 else \
147 ret = _dirp->__dd_fd; \
148 ret; \
149})
150#else
151int dirfd(DIR *dirp) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
152#endif
153
154int scandir(const char *, struct dirent ***,
155 int (*)(const struct dirent *), int (*)(const struct dirent **, const struct dirent **)) __DARWIN_INODE64(scandir);
156#ifdef __BLOCKS__
157#if __has_attribute(noescape)
158#define __scandir_noescape __attribute__((__noescape__))
159#else
160#define __scandir_noescape
161#endif
162
163int scandir_b(const char *, struct dirent ***,
164 int (^)(const struct dirent *) __scandir_noescape,
165 int (^)(const struct dirent **, const struct dirent **) __scandir_noescape)
166 __DARWIN_INODE64(scandir_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
167#endif /* __BLOCKS__ */
168
169__END_DECLS
170#endif /* __DARWIN_C_LEVEL >= 200809L */
171
172
173#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
174__BEGIN_DECLS
175
176int fdclosedir(DIR *)
177 __API_AVAILABLE(macos(26.4), ios(26.4), watchos(26.4), tvos(26.4), visionos(26.4));
178
179int fdscandir(int, struct dirent ***,
180 int (*)(const struct dirent *), int (*)(const struct dirent **,
181 const struct dirent **))
182 __DARWIN_INODE64(fdscandir)
183 __API_AVAILABLE(macos(26.4), ios(26.4), watchos(26.4), tvos(26.4), visionos(26.4));
184#ifdef __BLOCKS__
185int fdscandir_b(int, struct dirent ***,
186 int (^)(const struct dirent *) __scandir_noescape,
187 int (^)(const struct dirent **, const struct dirent **) __scandir_noescape)
188 __DARWIN_INODE64(fdscandir_b)
189 __API_AVAILABLE(macos(26.4), ios(26.4), watchos(26.4), tvos(26.4), visionos(26.4));
190#endif
191int scandirat(int, const char *, struct dirent ***,
192 int (*)(const struct dirent *), int (*)(const struct dirent **,
193 const struct dirent **))
194 __DARWIN_INODE64(scandirat)
195 __API_AVAILABLE(macos(26.4), ios(26.4), watchos(26.4), tvos(26.4), visionos(26.4));
196#ifdef __BLOCKS__
197int scandirat_b(int, const char *, struct dirent ***,
198 int (^)(const struct dirent *) __scandir_noescape,
199 int (^)(const struct dirent **, const struct dirent **) __scandir_noescape)
200 __DARWIN_INODE64(scandirat_b)
201 __API_AVAILABLE(macos(26.4), ios(26.4), watchos(26.4), tvos(26.4), visionos(26.4));
202#endif
203
204int getdirentries(int, char *_LIBC_COUNT(__nbytes), int __nbytes, long *)
205
206#if __DARWIN_64_BIT_INO_T
207/*
208 * getdirentries() doesn't work when 64-bit inodes is in effect, so we
209 * generate a link error.
210 */
211 __asm("_getdirentries_is_not_available_when_64_bit_inodes_are_in_effect")
212#else /* !__DARWIN_64_BIT_INO_T */
213 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_6, __IPHONE_2_0,__IPHONE_2_0)
214#endif /* __DARWIN_64_BIT_INO_T */
215;
216
217DIR *__opendir2(const char *, int) __DARWIN_ALIAS_I(__opendir2);
218
219__END_DECLS
220#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
221
222#endif /* !KERNEL */
223
224#endif /* !_DIRENT_H_ */