xref: /openbsd/sys/sys/dirent.h (revision d33565a9)
1 /*	$OpenBSD: dirent.h,v 1.11 2013/12/13 18:09:27 zhuk Exp $	*/
2 /*	$NetBSD: dirent.h,v 1.12 1996/04/09 20:55:25 cgd Exp $	*/
3 
4 /*-
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)dirent.h	8.3 (Berkeley) 8/10/94
33  */
34 
35 #ifndef _SYS_DIRENT_H_
36 #define _SYS_DIRENT_H_
37 
38 #include <sys/cdefs.h>
39 
40 /*
41  * The dirent structure defines the format of directory entries returned by
42  * the getdents(2) system call.
43  *
44  * A directory entry has a struct dirent at the front of it, containing its
45  * inode number, the length of the entry, and the length of the name
46  * contained in the entry.  These are followed by the name padded to a 4
47  * byte boundary with null bytes.  All names are guaranteed null terminated.
48  * The maximum length of a name in a directory is MAXNAMLEN.
49  */
50 
51 struct dirent {
52 	__ino_t    d_fileno;		/* file number of entry */
53 	__off_t    d_off;		/* offset after this entry */
54 	__uint16_t d_reclen;		/* length of this record */
55 	__uint8_t  d_type; 		/* file type, see below */
56 	__uint8_t  d_namlen;		/* length of string in d_name */
57 	__uint8_t  __d_padding[4];	/* suppress padding after d_name */
58 #if __BSD_VISIBLE
59 #define	MAXNAMLEN	255
60 	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
61 #else
62 	char	d_name[255 + 1];	/* name must be no longer than this */
63 #endif
64 };
65 
66 #if __BSD_VISIBLE
67 /*
68  * File types
69  */
70 #define	DT_UNKNOWN	 0
71 #define	DT_FIFO		 1
72 #define	DT_CHR		 2
73 #define	DT_DIR		 4
74 #define	DT_BLK		 6
75 #define	DT_REG		 8
76 #define	DT_LNK		10
77 #define	DT_SOCK		12
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 #ifdef _KERNEL
86 /*
87  * The DIRENT_RECSIZE macro gives the minimum record length which will hold
88  * a directory entry with a name of the given length, including the terminating
89  * nul byte, rounded up to proper alignment.
90  * The DIRENT_SIZE macro does the same when given a pointer to a struct dirent
91  */
92 #define DIRENT_RECSIZE(namelen) \
93     ((offsetof(struct dirent, d_name) + (namelen) + 1 + 7) &~ 7)
94 #define	DIRENT_SIZE(dp) \
95     DIRENT_RECSIZE((dp)->d_namlen)
96 #endif
97 
98 #endif /* __BSD_VISIBLE */
99 
100 #endif /* _SYS_DIRENT_H_ */
101