FreeBSD/Linux Kernel Cross Reference
sys/sys/dirent.h
1 /* $NetBSD: dirent.h,v 1.17 2003/08/07 16:34:01 agc 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. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 * @(#)dirent.h 8.3 (Berkeley) 8/10/94
32 */
33
34 #ifndef _SYS_DIRENT_H_
35 #define _SYS_DIRENT_H_
36
37 #include <sys/featuretest.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 u_int32_t d_fileno; /* file number of entry */
52 u_int16_t d_reclen; /* length of this record */
53 u_int8_t d_type; /* file type, see below */
54 u_int8_t d_namlen; /* length of string in d_name */
55 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE)
56 char d_name[255 + 1]; /* name must be no longer than this */
57 #else
58 #define MAXNAMLEN 255
59 char d_name[MAXNAMLEN + 1]; /* name must be no longer than this */
60 #endif
61 };
62
63 #if defined(_NETBSD_SOURCE)
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 DIRENT_SIZE macro gives the minimum record length which will hold
85 * the directory entry. This requires the amount of space in struct dirent
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 #define DIRENT_SIZE(dp) \
90 ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
91
92 #endif /* defined(_NETBSD_SOURCE) */
93
94 #endif /* !_SYS_DIRENT_H_ */
Cache object: 23f49f9a2f8493cb1c90d688fb03925c
|