xref: /freebsd/include/dirent.h (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
1 /*-
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
30  * $FreeBSD$
31  */
32 
33 #ifndef _DIRENT_H_
34 #define _DIRENT_H_
35 
36 /*
37  * The kernel defines the format of directory entries returned by
38  * the getdirentries(2) system call.
39  */
40 #include <sys/cdefs.h>
41 #include <sys/_types.h>
42 #include <sys/dirent.h>
43 
44 #if __BSD_VISIBLE
45 
46 #ifndef _SIZE_T_DECLARED
47 typedef	__size_t	size_t;
48 #define	_SIZE_T_DECLARED
49 #endif
50 
51 #ifndef _SSIZE_T_DECLARED
52 typedef	__ssize_t	ssize_t;
53 #define	_SSIZE_T_DECLARED
54 #endif
55 
56 #ifndef _OFF_T_DECLARED
57 typedef	__off_t		off_t;
58 #define	_OFF_T_DECLARED
59 #endif
60 
61 #endif /* __BSD_VISIBLE */
62 
63 #if __XSI_VISIBLE
64 
65 #ifndef _INO_T_DECLARED
66 typedef	__ino_t		ino_t;
67 #define	_INO_T_DECLARED
68 #endif
69 
70 /*
71  * XXX this is probably illegal in the __XSI_VISIBLE case, but brings us closer
72  * to the specification.
73  */
74 #define	d_ino		d_fileno	/* backward and XSI compatibility */
75 
76 #endif /* __XSI_VISIBLE */
77 
78 #if __BSD_VISIBLE
79 
80 #include <sys/_null.h>
81 
82 /* definitions for library routines operating on directories. */
83 #define	DIRBLKSIZ	1024
84 
85 struct _dirdesc;
86 typedef struct _dirdesc DIR;
87 
88 /* flags for opendir2 */
89 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
90 #define DTF_NODUP	0x0002	/* don't return duplicate names */
91 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
92 #define __DTF_READALL	0x0008	/* everything has been read */
93 #define	__DTF_SKIPREAD	0x0010  /* assume internal buffer is populated */
94 
95 #else /* !__BSD_VISIBLE */
96 
97 typedef	void *	DIR;
98 
99 #endif /* __BSD_VISIBLE */
100 
101 #ifndef _KERNEL
102 
103 __BEGIN_DECLS
104 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
105 int	 alphasort(const struct dirent **, const struct dirent **);
106 int	 dirfd(DIR *);
107 #endif
108 #if __BSD_VISIBLE
109 DIR	*__opendir2(const char *, int);
110 int	 fdclosedir(DIR *);
111 ssize_t	 getdents(int, char *, size_t);
112 ssize_t	 getdirentries(int, char *, size_t, off_t *);
113 #endif
114 DIR	*opendir(const char *);
115 DIR	*fdopendir(int);
116 struct dirent *
117 	 readdir(DIR *);
118 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
119 int	 readdir_r(DIR *, struct dirent *, struct dirent **);
120 #endif
121 void	 rewinddir(DIR *);
122 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
123 int	 scandir(const char *, struct dirent ***,
124 	    int (*)(const struct dirent *), int (*)(const struct dirent **,
125 	    const struct dirent **));
126 #ifdef __BLOCKS__
127 int	 scandir_b(const char *, struct dirent ***,
128 	    int (^)(const struct dirent *),
129 	    int (^)(const struct dirent **, const struct dirent **));
130 #endif
131 #endif
132 #if __XSI_VISIBLE
133 void	 seekdir(DIR *, long);
134 long	 telldir(DIR *);
135 #endif
136 int	 closedir(DIR *);
137 __END_DECLS
138 
139 #endif /* !_KERNEL */
140 
141 #endif /* !_DIRENT_H_ */
142