xref: /illumos-gate/usr/src/boot/sys/sys/dirent.h (revision 199767f8)
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  * 4. 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.3 (Berkeley) 8/10/94
30  * $FreeBSD$
31  */
32 
33 #ifndef	_SYS_DIRENT_H_
34 #define	_SYS_DIRENT_H_
35 
36 #include <sys/cdefs.h>
37 #include <sys/_types.h>
38 
39 /*
40  * The dirent structure defines the format of directory entries returned by
41  * the getdirentries(2) system call.
42  *
43  * A directory entry has a struct dirent at the front of it, containing its
44  * inode number, the length of the entry, and the length of the name
45  * contained in the entry.  These are followed by the name padded to a 4
46  * byte boundary with null bytes.  All names are guaranteed null terminated.
47  * The maximum length of a name in a directory is MAXNAMLEN.
48  */
49 
50 struct dirent {
51 	__uint32_t d_fileno;		/* file number of entry */
52 	__uint16_t d_reclen;		/* length of this record */
53 	__uint8_t  d_type; 		/* file type, see below */
54 	__uint8_t  d_namlen;		/* length of string in d_name */
55 #if __BSD_VISIBLE
56 #define	MAXNAMLEN	255
57 	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
58 #else
59 	char	d_name[255 + 1];	/* name must be no longer than this */
60 #endif
61 };
62 
63 #if __BSD_VISIBLE
64 /*
65  * File types
66  */
67 #define	DT_UNKNOWN	 0
68 #define	DT_FIFO		 1
69 #define	DT_CHR		 2
70 #define	DT_DIR		 4
71 #define	DT_BLK		 6
72 #define	DT_REG		 8
73 #define	DT_LNK		10
74 #define	DT_SOCK		12
75 #define	DT_WHT		14
76 
77 /*
78  * Convert between stat structure types and directory types.
79  */
80 #define	IFTODT(mode)	(((mode) & 0170000) >> 12)
81 #define	DTTOIF(dirtype)	((dirtype) << 12)
82 
83 /*
84  * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold
85  * the directory entry.  This returns the amount of space in struct direct
86  * without the d_name field, plus enough space for the name with a terminating
87  * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
88  *
89  * XXX although this macro is in the implementation namespace, it requires
90  * a manifest constant that is not.
91  */
92 #define	_GENERIC_DIRSIZ(dp) \
93     ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
94 #endif /* __BSD_VISIBLE */
95 
96 #ifdef _KERNEL
97 #define	GENERIC_DIRSIZ(dp)	_GENERIC_DIRSIZ(dp)
98 #endif
99 
100 #endif /* !_SYS_DIRENT_H_ */
101