1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2009 Aditya Sarawgi
5 * 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 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30
31#ifndef _FS_EXT2FS_EXT2_DINODE_H_
32#define	_FS_EXT2FS_EXT2_DINODE_H_
33
34/*
35 * Special inode numbers
36 * The root inode is the root of the file system.  Inode 0 can't be used for
37 * normal purposes and bad blocks are normally linked to inode 1, thus
38 * the root inode is 2.
39 * Inode 3 to 10 are reserved in ext2fs.
40 */
41#define	EXT2_BADBLKINO		((ino_t)1)
42#define	EXT2_ROOTINO		((ino_t)2)
43#define	EXT2_ACLIDXINO		((ino_t)3)
44#define	EXT2_ACLDATAINO		((ino_t)4)
45#define	EXT2_BOOTLOADERINO	((ino_t)5)
46#define	EXT2_UNDELDIRINO	((ino_t)6)
47#define	EXT2_RESIZEINO		((ino_t)7)
48#define	EXT2_JOURNALINO		((ino_t)8)
49#define	EXT2_EXCLUDEINO		((ino_t)9)
50#define	EXT2_REPLICAINO		((ino_t)10)
51#define	EXT2_FIRSTINO		((ino_t)11)
52
53/*
54 * Inode flags
55 * The system supports EXT2_IMMUTABLE, EXT2_APPEND and EXT2_NODUMP flags.
56 * The current implementation also uses EXT3_INDEX, EXT4_EXTENTS and
57 * EXT4_HUGE_FILE with some restrictions imposed by the lack of write
58 * support.
59 */
60#define	EXT2_SECRM		0x00000001	/* Secure deletion */
61#define	EXT2_UNRM		0x00000002	/* Undelete */
62#define	EXT2_COMPR		0x00000004	/* Compress file */
63#define	EXT2_SYNC		0x00000008	/* Synchronous updates */
64#define	EXT2_IMMUTABLE		0x00000010	/* Immutable file */
65#define	EXT2_APPEND		0x00000020 /* Writes to file may only append */
66#define	EXT2_NODUMP		0x00000040	/* Do not dump file */
67#define	EXT2_NOATIME		0x00000080	/* Do not update atime */
68#define	EXT3_INDEX		0x00001000	/* Hash-indexed directory */
69#define	EXT4_IMAGIC		0x00002000	/* AFS directory */
70#define	EXT4_JOURNAL_DATA	0x00004000 /* File data should be journaled */
71#define	EXT4_NOTAIL		0x00008000 /* File tail should not be merged */
72#define	EXT4_DIRSYNC		0x00010000	/* Dirsync behaviour */
73#define	EXT4_TOPDIR		0x00020000 /* Top of directory hierarchies*/
74#define	EXT4_HUGE_FILE		0x00040000	/* Set to each huge file */
75#define	EXT4_EXTENTS		0x00080000	/* Inode uses extents */
76#define	EXT4_EA_INODE		0x00200000	/* Inode used for large EA */
77#define	EXT4_EOFBLOCKS		0x00400000 /* Blocks allocated beyond EOF */
78#define	EXT4_INLINE_DATA	0x10000000 /* Inode has inline data */
79#define	EXT4_PROJINHERIT	0x20000000 /* Children inherit project ID */
80
81/*
82 * Definitions for nanosecond timestamps.
83 * Ext3 inode versioning, 2006-12-13.
84 */
85#define	EXT3_EPOCH_BITS	2
86#define	EXT3_EPOCH_MASK	((1 << EXT3_EPOCH_BITS) - 1)
87#define	EXT3_NSEC_MASK	(~0UL << EXT3_EPOCH_BITS)
88
89#define	E2DI_HAS_XTIME(ip)	(EXT2_HAS_RO_COMPAT_FEATURE(ip->i_e2fs,	\
90				    EXT2F_ROCOMPAT_EXTRA_ISIZE))
91#define	E2DI_HAS_HUGE_FILE(ip)	(EXT2_HAS_RO_COMPAT_FEATURE(ip->i_e2fs,	\
92				    EXT2F_ROCOMPAT_HUGE_FILE))
93
94/*
95 * Constants relative to the data blocks
96 */
97#define	EXT2_NDIR_BLOCKS		12
98#define	EXT2_IND_BLOCK			EXT2_NDIR_BLOCKS
99#define	EXT2_DIND_BLOCK			(EXT2_IND_BLOCK + 1)
100#define	EXT2_TIND_BLOCK			(EXT2_DIND_BLOCK + 1)
101#define	EXT2_N_BLOCKS			(EXT2_TIND_BLOCK + 1)
102#define	EXT2_MAXSYMLINKLEN		(EXT2_N_BLOCKS * sizeof(uint32_t))
103
104/*
105 * Structure of an inode on the disk
106 */
107struct ext2fs_dinode {
108	uint16_t	e2di_mode;	/*   0: IFMT, permissions; see below. */
109	uint16_t	e2di_uid;	/*   2: Owner UID */
110	uint32_t	e2di_size;	/*   4: Size (in bytes) */
111	uint32_t	e2di_atime;	/*   8: Access time */
112	uint32_t	e2di_ctime;	/*  12: Change time */
113	uint32_t	e2di_mtime;	/*  16: Modification time */
114	uint32_t	e2di_dtime;	/*  20: Deletion time */
115	uint16_t	e2di_gid;	/*  24: Owner GID */
116	uint16_t	e2di_nlink;	/*  26: File link count */
117	uint32_t	e2di_nblock;	/*  28: Blocks count */
118	uint32_t	e2di_flags;	/*  32: Status flags (chflags) */
119	uint32_t	e2di_version;	/*  36: Low 32 bits inode version */
120	uint32_t	e2di_blocks[EXT2_N_BLOCKS]; /* 40: disk blocks */
121	uint32_t	e2di_gen;	/* 100: generation number */
122	uint32_t	e2di_facl;	/* 104: Low EA block */
123	uint32_t	e2di_size_high;	/* 108: Upper bits of file size */
124	uint32_t	e2di_faddr;	/* 112: Fragment address (obsolete) */
125	uint16_t	e2di_nblock_high; /* 116: Blocks count bits 47:32 */
126	uint16_t	e2di_facl_high;	/* 118: File EA bits 47:32 */
127	uint16_t	e2di_uid_high;	/* 120: Owner UID top 16 bits */
128	uint16_t	e2di_gid_high;	/* 122: Owner GID top 16 bits */
129	uint16_t	e2di_chksum_lo;	  /* 124: Lower inode checksum */
130	uint16_t	e2di_lx_reserved; /* 126: Unused */
131	uint16_t	e2di_extra_isize; /* 128: Size of this inode */
132	uint16_t	e2di_chksum_hi;	/* 130: High inode checksum */
133	uint32_t	e2di_ctime_extra; /* 132: Extra change time */
134	uint32_t	e2di_mtime_extra; /* 136: Extra modification time */
135	uint32_t	e2di_atime_extra; /* 140: Extra access time */
136	uint32_t	e2di_crtime;	/* 144: Creation (birth)time */
137	uint32_t	e2di_crtime_extra; /* 148: Extra creation (birth)time */
138	uint32_t	e2di_version_hi;  /* 152: High bits of inode version */
139	uint32_t	e2di_projid;	/* 156: Project ID */
140};
141
142#endif /* !_FS_EXT2FS_EXT2_DINODE_H_ */
143
144