dirent.h revision 1.21 
1/*	$NetBSD: dirent.h,v 1.21 2003/08/07 09:44:10 agc Exp $	*/
2
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#include <sys/featuretest.h>
38#include <sys/types.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#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
47#define	d_ino		d_fileno	/* backward compatibility */
48#endif
49
50typedef struct _dirdesc DIR;
51
52#if defined(_NETBSD_SOURCE)
53
54/* definitions for library routines operating on directories. */
55#define	DIRBLKSIZ	1024
56
57/* structure describing an open directory. */
58struct _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 getdents */
62	char	*dd_buf;	/* data buffer */
63	int	dd_len;		/* size of data buffer */
64	off_t	dd_seek;	/* magic cookie returned by getdents */
65	long	dd_rewind;	/* magic cookie for rewinding */
66	int	dd_flags;	/* flags for readdir */
67	void	*dd_lock;	/* lock for concurrent access */
68};
69
70#define	dirfd(dirp)	((dirp)->dd_fd)
71
72/* flags for __opendir2() */
73#define DTF_HIDEW	0x0001	/* hide whiteout entries */
74#define DTF_NODUP	0x0002	/* don't return duplicate names */
75#define DTF_REWIND	0x0004	/* rewind after reading union stack */
76#define __DTF_READALL	0x0008	/* everything has been read */
77
78#include <sys/null.h>
79
80#endif
81
82#ifndef _KERNEL
83
84#include <sys/cdefs.h>
85
86__BEGIN_DECLS
87int closedir __P((DIR *));
88DIR *opendir __P((const char *));
89struct dirent *readdir __P((DIR *));
90int readdir_r __P((DIR *, struct dirent * __restrict,
91    struct dirent ** __restrict));
92void rewinddir __P((DIR *));
93#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
94void seekdir __P((DIR *, long));
95long telldir __P((const DIR *));
96#endif /* defined(_NETBSD_SOURCE) || defined(_XOPEN_SOURCE) */
97#if defined(_NETBSD_SOURCE)
98DIR *__opendir2 __P((const char *, int));
99void __seekdir __P((DIR *, long));
100int scandir __P((const char *, struct dirent ***,
101    int (*)(const struct dirent *), int (*)(const void *, const void *)));
102int alphasort __P((const void *, const void *));
103int getdirentries __P((int, char *, int, long *));
104int getdents __P((int, char *, size_t));
105#endif /* defined(_NETBSD_SOURCE) */
106__END_DECLS
107
108#endif /* !_KERNEL */
109
110#endif /* !_DIRENT_H_ */
111