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 _DIRENT_H_
33#define _DIRENT_H_
34
35/*
36 * The kernel defines the format of directory entries returned by
37 * the getdirentries(2) system call.
38 */
39#include <sys/cdefs.h>
40#include <sys/_types.h>
41#include <sys/dirent.h>
42
43#if __BSD_VISIBLE
44
45#ifndef _SIZE_T_DECLARED
46typedef __size_t size_t;
47#define _SIZE_T_DECLARED
48#endif
49
50#ifndef _SSIZE_T_DECLARED
51typedef __ssize_t ssize_t;
52#define _SSIZE_T_DECLARED
53#endif
54
55#ifndef _OFF_T_DECLARED
56typedef __off_t off_t;
57#define _OFF_T_DECLARED
58#endif
59
60#endif /* __BSD_VISIBLE */
61
62#if __XSI_VISIBLE
63
64#ifndef _INO_T_DECLARED
65typedef __ino_t ino_t;
66#define _INO_T_DECLARED
67#endif
68
69/*
70 * XXX this is probably illegal in the __XSI_VISIBLE case, but brings us closer
71 * to the specification.
72 */
73#define d_ino d_fileno /* backward and XSI compatibility */
74
75#endif /* __XSI_VISIBLE */
76
77#if __BSD_VISIBLE
78
79#include <sys/_null.h>
80
81/* definitions for library routines operating on directories. */
82#define DIRBLKSIZ 1024
83
84struct _dirdesc;
85typedef struct _dirdesc DIR;
86
87/* flags for opendir2 */
88#define DTF_HIDEW 0x0001 /* hide whiteout entries */
89#define DTF_NODUP 0x0002 /* don't return duplicate names */
90#define DTF_REWIND 0x0004 /* rewind after reading union stack */
91#define __DTF_READALL 0x0008 /* everything has been read */
92#define __DTF_SKIPREAD 0x0010 /* assume internal buffer is populated */
93
94#else /* !__BSD_VISIBLE */
95
96typedef void * DIR;
97
98#endif /* __BSD_VISIBLE */
99
100#ifndef _KERNEL
101
102__BEGIN_DECLS
103#if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
104int alphasort(const struct dirent **, const struct dirent **);
105int dirfd(DIR *);
106#endif
107#if __BSD_VISIBLE
108int versionsort(const struct dirent **, const struct dirent **);
109DIR *__opendir2(const char *, int);
110int fdclosedir(DIR *);
111ssize_t getdents(int, char *, size_t);
112ssize_t getdirentries(int, char *, size_t, off_t *);
113#endif
114DIR *opendir(const char *);
115DIR *fdopendir(int);
116struct dirent *
117 readdir(DIR *);
118#if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
119int readdir_r(DIR *, struct dirent *, struct dirent **)
120 __deprecated1("Does not take variable {NAME_MAX} into account");
121#endif
122void rewinddir(DIR *);
123#if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
124int scandir(const char *, struct dirent ***,
125 int (*)(const struct dirent *), int (*)(const struct dirent **,
126 const struct dirent **));
127#ifdef __BLOCKS__
128int scandir_b(const char *, struct dirent ***,
129 int (^)(const struct dirent *),
130 int (^)(const struct dirent **, const struct dirent **));
131#endif
132#endif
133#if __BSD_VISIBLE
134int fdscandir(int, struct dirent ***,
135 int (*)(const struct dirent *), int (*)(const struct dirent **,
136 const struct dirent **));
137#ifdef __BLOCKS__
138int fdscandir_b(int, struct dirent ***,
139 int (^)(const struct dirent *),
140 int (^)(const struct dirent **, const struct dirent **));
141#endif
142int scandirat(int, const char *, struct dirent ***,
143 int (*)(const struct dirent *), int (*)(const struct dirent **,
144 const struct dirent **));
145#ifdef __BLOCKS__
146int scandirat_b(int, const char *, struct dirent ***,
147 int (^)(const struct dirent *),
148 int (^)(const struct dirent **, const struct dirent **));
149#endif
150#endif
151#if __XSI_VISIBLE
152void seekdir(DIR *, long);
153long telldir(DIR *);
154#endif
155int closedir(DIR *);
156__END_DECLS
157
158#endif /* !_KERNEL */
159
160#endif /* !_DIRENT_H_ */