xref: /freebsd/sys/fs/ext2fs/ext2_dir.h (revision 9a14aa017b21c292740c00ee098195cd46642730)
1 /*-
2  * Copyright (c) 2009 Aditya Sarawgi
3  * 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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _FS_EXT2FS_EXT2_DIR_H_
30 #define _FS_EXT2FS_EXT2_DIR_H_
31 
32 /*
33  * Structure of a directory entry
34  */
35 #define EXT2FS_MAXNAMLEN 255
36 
37 struct	ext2fs_direct {
38 	uint32_t e2d_ino;		/* inode number of entry */
39 	uint16_t e2d_reclen;		/* length of this record */
40 	uint16_t e2d_namlen;		/* length of string in d_name */
41 	char e2d_name[EXT2FS_MAXNAMLEN];/* name with length<=EXT2FS_MAXNAMLEN */
42 };
43 /*
44  * The new version of the directory entry.  Since EXT2 structures are
45  * stored in intel byte order, and the name_len field could never be
46  * bigger than 255 chars, it's safe to reclaim the extra byte for the
47  * file_type field.
48  */
49 struct	ext2fs_direct_2 {
50 	uint32_t e2d_ino;		/* inode number of entry */
51 	uint16_t e2d_reclen;		/* length of this record */
52 	uint8_t e2d_namlen;		/* length of string in d_name */
53 	uint8_t e2d_type;		/* file type */
54 	char e2d_name[EXT2FS_MAXNAMLEN];/* name with length<=EXT2FS_MAXNAMLEN */
55 };
56 /*
57  * Ext2 directory file types.  Only the low 3 bits are used.  The
58  * other bits are reserved for now.
59  */
60 #define EXT2_FT_UNKNOWN		0
61 #define EXT2_FT_REG_FILE	1
62 #define EXT2_FT_DIR		2
63 #define EXT2_FT_CHRDEV		3
64 #define EXT2_FT_BLKDEV 		4
65 #define EXT2_FT_FIFO		5
66 #define EXT2_FT_SOCK		6
67 #define EXT2_FT_SYMLINK		7
68 
69 #define EXT2_FT_MAX		8
70 
71 /*
72  * EXT2_DIR_PAD defines the directory entries boundaries
73  *
74  * NOTE: It must be a multiple of 4
75  */
76 #define EXT2_DIR_PAD		 	4
77 #define EXT2_DIR_ROUND 			(EXT2_DIR_PAD - 1)
78 #define EXT2_DIR_REC_LEN(name_len)	(((name_len) + 8 + EXT2_DIR_ROUND) & \
79 					 ~EXT2_DIR_ROUND)
80 #endif /* !_FS_EXT2FS_EXT2_DIR_H_ */
81 
82