xref: /netbsd/sys/sys/dirent.h (revision bf9ec67e)
1 /*	$NetBSD: dirent.h,v 1.14 1998/05/05 21:53:38 kleink 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. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)dirent.h	8.3 (Berkeley) 8/10/94
36  */
37 
38 #ifndef _SYS_DIRENT_H_
39 #define _SYS_DIRENT_H_
40 
41 #include <sys/featuretest.h>
42 
43 /*
44  * The dirent structure defines the format of directory entries returned by
45  * the getdirentries(2) system call.
46  *
47  * A directory entry has a struct dirent at the front of it, containing its
48  * inode number, the length of the entry, and the length of the name
49  * contained in the entry.  These are followed by the name padded to a 4
50  * byte boundary with null bytes.  All names are guaranteed null terminated.
51  * The maximum length of a name in a directory is MAXNAMLEN.
52  */
53 
54 struct dirent {
55 	u_int32_t d_fileno;		/* file number of entry */
56 	u_int16_t d_reclen;		/* length of this record */
57 	u_int8_t  d_type; 		/* file type, see below */
58 	u_int8_t  d_namlen;		/* length of string in d_name */
59 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE)
60 	char	d_name[255 + 1];	/* name must be no longer than this */
61 #else
62 #define	MAXNAMLEN	255
63 	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
64 #endif
65 };
66 
67 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
68 /*
69  * File types
70  */
71 #define	DT_UNKNOWN	 0
72 #define	DT_FIFO		 1
73 #define	DT_CHR		 2
74 #define	DT_DIR		 4
75 #define	DT_BLK		 6
76 #define	DT_REG		 8
77 #define	DT_LNK		10
78 #define	DT_SOCK		12
79 #define	DT_WHT		14
80 
81 /*
82  * Convert between stat structure types and directory types.
83  */
84 #define	IFTODT(mode)	(((mode) & 0170000) >> 12)
85 #define	DTTOIF(dirtype)	((dirtype) << 12)
86 #endif /* !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) */
87 
88 #ifdef _KERNEL
89 /*
90  * The DIRENT_SIZE macro gives the minimum record length which will hold
91  * the directory entry.  This requires the amount of space in struct dirent
92  * without the d_name field, plus enough space for the name with a terminating
93  * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
94  */
95 #define	DIRENT_SIZE(dp) \
96     ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
97 
98 #endif	/* !_KERNEL */
99 
100 #endif	/* !_SYS_DIRENT_H_ */
101