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