xref: /xnu-11215.1.10/bsd/sys/dirent.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1 /*
2  * Copyright (c) 2000-2008, 2023 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29 /*-
30  * Copyright (c) 1989, 1993
31  *	The Regents of the University of California.  All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  * 1. Redistributions of source code must retain the above copyright
37  *    notice, this list of conditions and the following disclaimer.
38  * 2. Redistributions in binary form must reproduce the above copyright
39  *    notice, this list of conditions and the following disclaimer in the
40  *    documentation and/or other materials provided with the distribution.
41  * 3. All advertising materials mentioning features or use of this software
42  *    must display the following acknowledgement:
43  *	This product includes software developed by the University of
44  *	California, Berkeley and its contributors.
45  * 4. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)dirent.h	8.3 (Berkeley) 8/10/94
62  */
63 
64 /*
65  * The dirent structure defines the format of directory entries.
66  *
67  * A directory entry has a struct dirent at the front of it, containing its
68  * inode number, the length of the entry, and the length of the name
69  * contained in the entry.  These are followed by the name padded to a 4
70  * byte boundary with null bytes.  All names are guaranteed null terminated.
71  * The maximum length of a name in a directory is MAXNAMLEN when 32-bit
72  * ino_t is in effect; (MAXPATHLEN - 1) when 64-bit ino_t is in effect.
73  */
74 
75 #ifndef _SYS_DIRENT_H
76 #define _SYS_DIRENT_H
77 
78 #include <sys/_types.h>
79 #include <sys/cdefs.h>
80 
81 #include <sys/_types/_ino_t.h>
82 
83 
84 #define __DARWIN_MAXNAMLEN      255
85 
86 #pragma pack(4)
87 
88 #if !__DARWIN_64_BIT_INO_T
89 struct dirent {
90 	ino_t d_ino;                    /* file number of entry */
91 	__uint16_t d_reclen;            /* length of this record */
92 	__uint8_t  d_type;              /* file type, see below */
93 	__uint8_t  d_namlen;            /* length of string in d_name */
94 	char d_name[__DARWIN_MAXNAMLEN + 1];    /* name must be no longer than this */
95 };
96 #endif /* !__DARWIN_64_BIT_INO_T */
97 
98 #pragma pack()
99 
100 #define __DARWIN_MAXPATHLEN     1024
101 
102 #define __DARWIN_STRUCT_DIRENTRY { \
103 	__uint64_t  d_ino;      /* file number of entry */ \
104 	__uint64_t  d_seekoff;  /* seek offset (optional, used by servers) */ \
105 	__uint16_t  d_reclen;   /* length of this record */ \
106 	__uint16_t  d_namlen;   /* length of string in d_name */ \
107 	__uint8_t   d_type;     /* file type, see below */ \
108 	char      d_name[__DARWIN_MAXPATHLEN]; /* entry name (up to MAXPATHLEN bytes) */ \
109 }
110 
111 #if __DARWIN_64_BIT_INO_T
112 struct dirent __DARWIN_STRUCT_DIRENTRY;
113 #endif /* __DARWIN_64_BIT_INO_T */
114 
115 #ifdef KERNEL
116 /* Extended directory entry */
117 struct direntry __DARWIN_STRUCT_DIRENTRY;
118 #endif
119 
120 
121 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
122 #define d_fileno        d_ino           /* backward compatibility */
123 #define MAXNAMLEN       __DARWIN_MAXNAMLEN
124 /*
125  * File types
126  */
127 #define DT_UNKNOWN       0
128 #define DT_FIFO          1
129 #define DT_CHR           2
130 #define DT_DIR           4
131 #define DT_BLK           6
132 #define DT_REG           8
133 #define DT_LNK          10
134 #define DT_SOCK         12
135 #define DT_WHT          14
136 
137 /*
138  * Convert between stat structure types and directory types.
139  */
140 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
141 #define DTTOIF(dirtype) ((dirtype) << 12)
142 #endif
143 
144 #if PRIVATE
145 #include <sys/dirent_private.h>
146 #endif
147 
148 #endif /* _SYS_DIRENT_H  */
149