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