xref: /freebsd/include/dirent.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
34  * $FreeBSD$
35  */
36 
37 #ifndef _DIRENT_H_
38 #define _DIRENT_H_
39 
40 /*
41  * The kernel defines the format of directory entries returned by
42  * the getdirentries(2) system call.
43  */
44 #include <sys/cdefs.h>
45 #include <sys/dirent.h>
46 
47 #if __BSD_VISIBLE || __XSI_VISIBLE
48 /*
49  * XXX this is probably illegal in the __XSI_VISIBLE case, but brings us closer
50  * to the specification.
51  */
52 #define	d_ino		d_fileno	/* backward and XSI compatibility */
53 #endif
54 
55 #if __BSD_VISIBLE
56 
57 #include <sys/_null.h>
58 
59 /* definitions for library routines operating on directories. */
60 #define	DIRBLKSIZ	1024
61 
62 struct _telldir;		/* see telldir.h */
63 struct pthread_mutex;
64 
65 /* structure describing an open directory. */
66 typedef struct _dirdesc {
67 	int	dd_fd;		/* file descriptor associated with directory */
68 	long	dd_loc;		/* offset in current buffer */
69 	long	dd_size;	/* amount of data returned by getdirentries */
70 	char	*dd_buf;	/* data buffer */
71 	int	dd_len;		/* size of data buffer */
72 	long	dd_seek;	/* magic cookie returned by getdirentries */
73 	long	dd_rewind;	/* magic cookie for rewinding */
74 	int	dd_flags;	/* flags for readdir */
75 	struct pthread_mutex	*dd_lock;	/* lock */
76 	struct _telldir *dd_td;	/* telldir position recording */
77 } DIR;
78 
79 #define	dirfd(dirp)	((dirp)->dd_fd)
80 
81 /* flags for opendir2 */
82 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
83 #define DTF_NODUP	0x0002	/* don't return duplicate names */
84 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
85 #define __DTF_READALL	0x0008	/* everything has been read */
86 
87 #else /* !__BSD_VISIBLE */
88 
89 typedef	void *	DIR;
90 
91 #endif /* __BSD_VISIBLE */
92 
93 #ifndef _KERNEL
94 
95 __BEGIN_DECLS
96 #if __BSD_VISIBLE
97 DIR	*__opendir2(const char *, int);
98 int	 alphasort(const void *, const void *);
99 int	 getdents(int, char *, int);
100 int	 getdirentries(int, char *, int, long *);
101 #endif
102 DIR	*opendir(const char *);
103 DIR	*fdopendir(int);
104 struct dirent *
105 	 readdir(DIR *);
106 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
107 int	 readdir_r(DIR *, struct dirent *, struct dirent **);
108 #endif
109 void	 rewinddir(DIR *);
110 #if __BSD_VISIBLE
111 int	 scandir(const char *, struct dirent ***,
112 	    int (*)(struct dirent *), int (*)(const void *, const void *));
113 #endif
114 #if __XSI_VISIBLE
115 void	 seekdir(DIR *, long);
116 long	 telldir(DIR *);
117 #endif
118 int	 closedir(DIR *);
119 __END_DECLS
120 
121 #endif /* !_KERNEL */
122 
123 #endif /* !_DIRENT_H_ */
124