2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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. 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.
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
29 * @(#)dirent.h 8.3 (Berkeley) 8/10/94
33 #ifndef _SYS_DIRENT_H_
34 #define _SYS_DIRENT_H_
36 #include <sys/cdefs.h>
37 #include <sys/_types.h>
39 #ifndef _INO_T_DECLARED
40 typedef __ino_t ino_t;
41 #define _INO_T_DECLARED
44 #ifndef _OFF_T_DECLARED
45 typedef __off_t off_t;
46 #define _OFF_T_DECLARED
50 * The dirent structure defines the format of directory entries returned by
51 * the getdirentries(2) system call.
53 * A directory entry has a struct dirent at the front of it, containing its
54 * inode number, the length of the entry, and the length of the name
55 * contained in the entry. These are followed by the name padded to an 8
56 * byte boundary with null bytes. All names are guaranteed null terminated.
57 * The maximum length of a name in a directory is MAXNAMLEN.
59 * Explicit padding between the last member of the header (d_namelen) and
60 * d_name avoids ABI padding at the end of dirent on LP64 architectures.
61 * There is code depending on d_name being last.
65 ino_t d_fileno; /* file number of entry */
66 off_t d_off; /* directory offset of entry */
67 __uint16_t d_reclen; /* length of this record */
68 __uint8_t d_type; /* file type, see below */
70 __uint16_t d_namlen; /* length of string in d_name */
74 char d_name[MAXNAMLEN + 1]; /* name must be no longer than this */
76 char d_name[255 + 1]; /* name must be no longer than this */
80 #if defined(_WANT_FREEBSD11_DIRENT) || defined(_KERNEL)
81 struct freebsd11_dirent {
82 __uint32_t d_fileno; /* file number of entry */
83 __uint16_t d_reclen; /* length of this record */
84 __uint8_t d_type; /* file type, see below */
85 __uint8_t d_namlen; /* length of string in d_name */
86 char d_name[255 + 1]; /* name must be no longer than this */
88 #endif /* _WANT_FREEBSD11_DIRENT || _KERNEL */
106 * Convert between stat structure types and directory types.
108 #define IFTODT(mode) (((mode) & 0170000) >> 12)
109 #define DTTOIF(dirtype) ((dirtype) << 12)
112 * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold
113 * the directory entry. This returns the amount of space in struct direct
114 * without the d_name field, plus enough space for the name with a terminating
115 * null byte (dp->d_namlen+1), rounded up to a 8 byte boundary.
117 * XXX although this macro is in the implementation namespace, it requires
118 * a manifest constant that is not.
120 #define _GENERIC_DIRLEN(namlen) \
121 ((__offsetof(struct dirent, d_name) + (namlen) + 1 + 7) & ~7)
122 #define _GENERIC_DIRSIZ(dp) _GENERIC_DIRLEN((dp)->d_namlen)
123 #endif /* __BSD_VISIBLE */
126 #define GENERIC_DIRSIZ(dp) _GENERIC_DIRSIZ(dp)
129 #endif /* !_SYS_DIRENT_H_ */