xref: /freebsd/include/dirent.h (revision 42c159fe388a3765f69860c84183700af37aca8a)
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/dirent.h>
45 
46 #ifdef _POSIX_SOURCE
47 typedef void *	DIR;
48 #else
49 
50 #define	d_ino		d_fileno	/* backward compatibility */
51 
52 /* definitions for library routines operating on directories. */
53 #define	DIRBLKSIZ	1024
54 
55 struct _telldir;		/* see telldir.h */
56 
57 /* structure describing an open directory. */
58 typedef struct _dirdesc {
59 	int	dd_fd;		/* file descriptor associated with directory */
60 	long	dd_loc;		/* offset in current buffer */
61 	long	dd_size;	/* amount of data returned by getdirentries */
62 	char	*dd_buf;	/* data buffer */
63 	int	dd_len;		/* size of data buffer */
64 	long	dd_seek;	/* magic cookie returned by getdirentries */
65 	long	dd_rewind;	/* magic cookie for rewinding */
66 	int	dd_flags;	/* flags for readdir */
67 	void	*dd_lock;	/* hack to avoid including <pthread.h> */
68 	struct _telldir *dd_td;	/* telldir position recording */
69 } DIR;
70 
71 #define	dirfd(dirp)	((dirp)->dd_fd)
72 
73 /* flags for opendir2 */
74 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
75 #define DTF_NODUP	0x0002	/* don't return duplicate names */
76 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
77 #define __DTF_READALL	0x0008	/* everything has been read */
78 
79 #ifndef NULL
80 #define	NULL	0
81 #endif
82 
83 #endif /* _POSIX_SOURCE */
84 
85 #ifndef _KERNEL
86 
87 #include <sys/cdefs.h>
88 
89 __BEGIN_DECLS
90 DIR *opendir(const char *);
91 struct dirent *readdir(DIR *);
92 void rewinddir(DIR *);
93 int closedir(DIR *);
94 #ifndef _POSIX_SOURCE
95 DIR *__opendir2(const char *, int);
96 long telldir(DIR *);
97 void seekdir(DIR *, long);
98 int scandir(const char *, struct dirent ***,
99     int (*)(struct dirent *), int (*)(const void *, const void *));
100 int alphasort(const void *, const void *);
101 int getdents(int, char *, int);
102 int getdirentries(int, char *, int, long *);
103 int readdir_r(DIR *, struct dirent *, struct dirent **);
104 #endif /* not POSIX */
105 __END_DECLS
106 
107 #endif /* !_KERNEL */
108 
109 #endif /* !_DIRENT_H_ */
110