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