]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blame - lib/ext2fs/ext2_fs.h
chattr/lsattr: support casefold attribute
[thirdparty/e2fsprogs.git] / lib / ext2fs / ext2_fs.h
CommitLineData
9f8046fc
TT
1/*
2 * linux/include/linux/ext2_fs.h
3 *
4 * Copyright (C) 1992, 1993, 1994, 1995
5 * Remy Card (card@masi.ibp.fr)
6 * Laboratoire MASI - Institut Blaise Pascal
7 * Universite Pierre et Marie Curie (Paris VI)
8 *
9 * from
10 *
11 * linux/include/linux/minix_fs.h
12 *
13 * Copyright (C) 1991, 1992 Linus Torvalds
14 */
15
16#ifndef _LINUX_EXT2_FS_H
17#define _LINUX_EXT2_FS_H
18
797f5ef1 19#include <ext2fs/ext2_types.h> /* Changed from linux/types.h */
9f8046fc 20
98c6113b
TT
21#ifndef __GNUC_PREREQ
22#if defined(__GNUC__) && defined(__GNUC_MINOR__)
23#define __GNUC_PREREQ(maj, min) \
24 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
25#else
26#define __GNUC_PREREQ(maj, min) 0
27#endif
28#endif
29
9f8046fc
TT
30/*
31 * The second extended filesystem constants/structures
32 */
33
34/*
35 * Define EXT2FS_DEBUG to produce debug messages
36 */
37#undef EXT2FS_DEBUG
38
39/*
40 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
41 */
42#define EXT2_PREALLOCATE
43#define EXT2_DEFAULT_PREALLOC_BLOCKS 8
44
45/*
46 * The second extended file system version
47 */
48#define EXT2FS_DATE "95/08/09"
49#define EXT2FS_VERSION "0.5b"
50
51/*
0fbd1a8a 52 * Special inode numbers
9f8046fc 53 */
0fbd1a8a 54#define EXT2_BAD_INO 1 /* Bad blocks inode */
9f8046fc 55#define EXT2_ROOT_INO 2 /* Root inode */
0edcc270
AK
56#define EXT4_USR_QUOTA_INO 3 /* User quota inode */
57#define EXT4_GRP_QUOTA_INO 4 /* Group quota inode */
9f8046fc
TT
58#define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
59#define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
60#define EXT2_RESIZE_INO 7 /* Reserved group descriptors inode */
61#define EXT2_JOURNAL_INO 8 /* Journal inode */
6d0ed678 62#define EXT2_EXCLUDE_INO 9 /* The "exclude" inode, for snapshots */
991211f6 63#define EXT4_REPLICA_INO 10 /* Used by non-upstream feature */
9f8046fc
TT
64
65/* First non-reserved inode for old ext2 filesystems */
66#define EXT2_GOOD_OLD_FIRST_INO 11
67
68/*
69 * The second extended file system magic number
70 */
71#define EXT2_SUPER_MAGIC 0xEF53
72
0fbd1a8a
AD
73#ifdef __KERNEL__
74#define EXT2_SB(sb) (&((sb)->u.ext2_sb))
75#else
76/* Assume that user mode programs are passing in an ext2fs superblock, not
77 * a kernel struct super_block. This will allow us to call the feature-test
78 * macros from user land. */
79#define EXT2_SB(sb) (sb)
80#endif
81
9f8046fc
TT
82/*
83 * Maximal count of links to a file
84 */
bec6f49a 85#define EXT2_LINK_MAX 65000
9f8046fc
TT
86
87/*
88 * Macro-instructions used to manage several block sizes
89 */
932a489c 90#define EXT2_MIN_BLOCK_LOG_SIZE 10 /* 1024 */
39dc1c45 91#define EXT2_MAX_BLOCK_LOG_SIZE 16 /* 65536 */
7da78ff1
AD
92#define EXT2_MIN_BLOCK_SIZE (1 << EXT2_MIN_BLOCK_LOG_SIZE)
93#define EXT2_MAX_BLOCK_SIZE (1 << EXT2_MAX_BLOCK_LOG_SIZE)
9f8046fc 94#ifdef __KERNEL__
7da78ff1
AD
95#define EXT2_BLOCK_SIZE(s) ((s)->s_blocksize)
96#define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
0fbd1a8a 97#define EXT2_ADDR_PER_BLOCK_BITS(s) (EXT2_SB(s)->addr_per_block_bits)
7da78ff1
AD
98#define EXT2_INODE_SIZE(s) (EXT2_SB(s)->s_inode_size)
99#define EXT2_FIRST_INO(s) (EXT2_SB(s)->s_first_ino)
9f8046fc 100#else
7da78ff1
AD
101#define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
102#define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
9f8046fc 103#define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
7da78ff1 104 EXT2_GOOD_OLD_INODE_SIZE : (s)->s_inode_size)
9f8046fc 105#define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
7da78ff1 106 EXT2_GOOD_OLD_FIRST_INO : (s)->s_first_ino)
9f8046fc 107#endif
7da78ff1 108#define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof(__u32))
9f8046fc
TT
109
110/*
412376ef 111 * Macro-instructions used to manage allocation clusters
9f8046fc 112 */
412376ef
TT
113#define EXT2_MIN_CLUSTER_LOG_SIZE EXT2_MIN_BLOCK_LOG_SIZE
114#define EXT2_MAX_CLUSTER_LOG_SIZE 29 /* 512MB */
115#define EXT2_MIN_CLUSTER_SIZE EXT2_MIN_BLOCK_SIZE
116#define EXT2_MAX_CLUSTER_SIZE (1 << EXT2_MAX_CLUSTER_LOG_SIZE)
117#define EXT2_CLUSTER_SIZE(s) (EXT2_MIN_BLOCK_SIZE << \
118 (s)->s_log_cluster_size)
119#define EXT2_CLUSTER_SIZE_BITS(s) ((s)->s_log_cluster_size + 10)
9f8046fc 120
3fbfad55
TT
121/*
122 * Macro-instructions used to manage fragments
123 *
124 * Note: for backwards compatibility only, for the dump program.
125 * Ext2/3/4 will never support fragments....
126 */
127#define EXT2_MIN_FRAG_SIZE EXT2_MIN_BLOCK_SIZE
128#define EXT2_MAX_FRAG_SIZE EXT2_MAX_BLOCK_SIZE
129#define EXT2_MIN_FRAG_LOG_SIZE EXT2_MIN_BLOCK_LOG_SIZE
130#define EXT2_FRAG_SIZE(s) EXT2_BLOCK_SIZE(s)
131#define EXT2_FRAGS_PER_BLOCK(s) 1
132
9f8046fc
TT
133/*
134 * ACL structures
135 */
136struct ext2_acl_header /* Header of Access Control Lists */
137{
138 __u32 aclh_size;
139 __u32 aclh_file_count;
140 __u32 aclh_acle_count;
141 __u32 aclh_first_acle;
142};
143
144struct ext2_acl_entry /* Access Control List Entry */
145{
146 __u32 acle_size;
147 __u16 acle_perms; /* Access permissions */
148 __u16 acle_type; /* Type of entry */
149 __u16 acle_tag; /* User or group identity */
150 __u16 acle_pad1;
151 __u32 acle_next; /* Pointer on next entry for the */
152 /* same inode or on next free entry */
153};
154
155/*
156 * Structure of a blocks group descriptor
157 */
158struct ext2_group_desc
159{
8061d2c1
TT
160 __u32 bg_block_bitmap; /* Blocks bitmap block */
161 __u32 bg_inode_bitmap; /* Inodes bitmap block */
9f8046fc
TT
162 __u32 bg_inode_table; /* Inodes table block */
163 __u16 bg_free_blocks_count; /* Free blocks count */
164 __u16 bg_free_inodes_count; /* Free inodes count */
165 __u16 bg_used_dirs_count; /* Directories count */
f5fa2007 166 __u16 bg_flags;
89efc88e
TT
167 __u32 bg_exclude_bitmap_lo; /* Exclude bitmap for snapshots */
168 __u16 bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
169 __u16 bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
8815fb8a 170 __u16 bg_itable_unused; /* Unused inodes count */
11d1116a 171 __u16 bg_checksum; /* crc16(s_uuid+group_num+group_desc)*/
9f8046fc
TT
172};
173
3c4d4d74
VAH
174/*
175 * Structure of a blocks group descriptor
176 */
8061d2c1
TT
177struct ext4_group_desc
178{
179 __u32 bg_block_bitmap; /* Blocks bitmap block */
180 __u32 bg_inode_bitmap; /* Inodes bitmap block */
181 __u32 bg_inode_table; /* Inodes table block */
182 __u16 bg_free_blocks_count; /* Free blocks count */
183 __u16 bg_free_inodes_count; /* Free inodes count */
184 __u16 bg_used_dirs_count; /* Directories count */
3c4d4d74 185 __u16 bg_flags; /* EXT4_BG_flags (INODE_UNINIT, etc) */
89efc88e
TT
186 __u32 bg_exclude_bitmap_lo; /* Exclude bitmap for snapshots */
187 __u16 bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
188 __u16 bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
8061d2c1 189 __u16 bg_itable_unused; /* Unused inodes count */
3c4d4d74 190 __u16 bg_checksum; /* crc16(sb_uuid+group+desc) */
8061d2c1
TT
191 __u32 bg_block_bitmap_hi; /* Blocks bitmap block MSB */
192 __u32 bg_inode_bitmap_hi; /* Inodes bitmap block MSB */
193 __u32 bg_inode_table_hi; /* Inodes table block MSB */
194 __u16 bg_free_blocks_count_hi;/* Free blocks count MSB */
195 __u16 bg_free_inodes_count_hi;/* Free inodes count MSB */
196 __u16 bg_used_dirs_count_hi; /* Directories count MSB */
3c4d4d74 197 __u16 bg_itable_unused_hi; /* Unused inodes count MSB */
89efc88e
TT
198 __u32 bg_exclude_bitmap_hi; /* Exclude bitmap block MSB */
199 __u16 bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
200 __u16 bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
201 __u32 bg_reserved;
8061d2c1
TT
202};
203
a80ea340
DW
204#define EXT4_BG_INODE_BITMAP_CSUM_HI_END \
205 (offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
206 sizeof(__u16))
e7dc95c6
DW
207#define EXT4_BG_BLOCK_BITMAP_CSUM_HI_LOCATION \
208 (offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
209 sizeof(__u16))
a80ea340 210
f5fa2007
TT
211#define EXT2_BG_INODE_UNINIT 0x0001 /* Inode table/bitmap not initialized */
212#define EXT2_BG_BLOCK_UNINIT 0x0002 /* Block bitmap not initialized */
ca2634a4 213#define EXT2_BG_INODE_ZEROED 0x0004 /* On-disk itable initialized to zero */
f5fa2007 214
df614db6
TT
215/*
216 * Data structures used by the directory indexing feature
217 *
218 * Note: all of the multibyte integer fields are little endian.
219 */
220
221/*
222 * Note: dx_root_info is laid out so that if it should somehow get
223 * overlaid by a dirent the two low bits of the hash version will be
224 * zero. Therefore, the hash version mod 4 should never be 0.
225 * Sincerely, the paranoia department.
226 */
227struct ext2_dx_root_info {
228 __u32 reserved_zero;
229 __u8 hash_version; /* 0 now, 1 at release */
230 __u8 info_length; /* 8 */
231 __u8 indirect_levels;
232 __u8 unused_flags;
233};
234
f77704e4
TT
235#define EXT2_HASH_LEGACY 0
236#define EXT2_HASH_HALF_MD4 1
237#define EXT2_HASH_TEA 2
238#define EXT2_HASH_LEGACY_UNSIGNED 3 /* reserved for userspace lib */
239#define EXT2_HASH_HALF_MD4_UNSIGNED 4 /* reserved for userspace lib */
240#define EXT2_HASH_TEA_UNSIGNED 5 /* reserved for userspace lib */
503f9e7f
TT
241
242#define EXT2_HASH_FLAG_INCOMPAT 0x1
243
1d9ec88d
LC
244#define EXT4_DX_BLOCK_MASK 0x0fffffff
245
df614db6 246struct ext2_dx_entry {
1224c0d3
ES
247 __le32 hash;
248 __le32 block;
df614db6
TT
249};
250
251struct ext2_dx_countlimit {
1224c0d3
ES
252 __le16 limit;
253 __le16 count;
df614db6
TT
254};
255
5d914d72
DW
256/*
257 * This goes at the end of each htree block.
258 */
259struct ext2_dx_tail {
1224c0d3
ES
260 __le32 dt_reserved;
261 __le32 dt_checksum; /* crc32c(uuid+inum+dxblock) */
5d914d72 262};
df614db6 263
9f8046fc
TT
264/*
265 * Macro-instructions used to manage group descriptors
266 */
f2de1d38
VC
267#define EXT2_MIN_DESC_SIZE 32
268#define EXT2_MIN_DESC_SIZE_64BIT 64
269#define EXT2_MAX_DESC_SIZE EXT2_MIN_BLOCK_SIZE
270#define EXT2_DESC_SIZE(s) \
271 ((EXT2_SB(s)->s_feature_incompat & EXT4_FEATURE_INCOMPAT_64BIT) ? \
272 (s)->s_desc_size : EXT2_MIN_DESC_SIZE)
273
b21bf267
AD
274#define EXT2_BLOCKS_PER_GROUP(s) (EXT2_SB(s)->s_blocks_per_group)
275#define EXT2_INODES_PER_GROUP(s) (EXT2_SB(s)->s_inodes_per_group)
ae9e37cd 276#define EXT2_CLUSTERS_PER_GROUP(s) (EXT2_SB(s)->s_clusters_per_group)
b21bf267
AD
277#define EXT2_INODES_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s)/EXT2_INODE_SIZE(s))
278/* limits imposed by 16-bit value gd_free_{blocks,inode}_count */
d32c915a 279#define EXT2_MAX_BLOCKS_PER_GROUP(s) ((((unsigned) 1 << 16) - 8) * \
ae9e37cd
TT
280 (EXT2_CLUSTER_SIZE(s) / \
281 EXT2_BLOCK_SIZE(s)))
d32c915a
TT
282#define EXT2_MAX_CLUSTERS_PER_GROUP(s) (((unsigned) 1 << 16) - 8)
283#define EXT2_MAX_INODES_PER_GROUP(s) (((unsigned) 1 << 16) - \
284 EXT2_INODES_PER_BLOCK(s))
9f8046fc 285#ifdef __KERNEL__
b21bf267
AD
286#define EXT2_DESC_PER_BLOCK(s) (EXT2_SB(s)->s_desc_per_block)
287#define EXT2_DESC_PER_BLOCK_BITS(s) (EXT2_SB(s)->s_desc_per_block_bits)
9f8046fc 288#else
f2de1d38 289#define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_DESC_SIZE(s))
9f8046fc
TT
290#endif
291
1e33a8b4
TT
292#define EXT2_GROUPS_TO_BLOCKS(s, g) ((blk64_t) EXT2_BLOCKS_PER_GROUP(s) * \
293 (g))
294#define EXT2_GROUPS_TO_CLUSTERS(s, g) ((blk64_t) EXT2_CLUSTERS_PER_GROUP(s) * \
295 (g))
296
9f8046fc
TT
297/*
298 * Constants relative to the data blocks
299 */
0fbd1a8a
AD
300#define EXT2_NDIR_BLOCKS 12
301#define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
302#define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
303#define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
304#define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
9f8046fc
TT
305
306/*
307 * Inode flags
308 */
0fbd1a8a
AD
309#define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
310#define EXT2_UNRM_FL 0x00000002 /* Undelete */
311#define EXT2_COMPR_FL 0x00000004 /* Compress file */
9f8046fc
TT
312#define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
313#define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
314#define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
315#define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
316#define EXT2_NOATIME_FL 0x00000080 /* do not update atime */
317/* Reserved for compression usage... */
318#define EXT2_DIRTY_FL 0x00000100
319#define EXT2_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
0fbd1a8a 320#define EXT2_NOCOMPR_FL 0x00000400 /* Access raw compressed data */
22f22ab1
TT
321 /* nb: was previously EXT2_ECOMPR_FL */
322#define EXT4_ENCRYPT_FL 0x00000800 /* encrypted inode */
0fbd1a8a 323/* End compression flags --- maybe not all used */
9f8046fc 324#define EXT2_BTREE_FL 0x00001000 /* btree format dir */
b10820cd 325#define EXT2_INDEX_FL 0x00001000 /* hash-indexed directory */
9f8046fc
TT
326#define EXT2_IMAGIC_FL 0x00002000
327#define EXT3_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
b3f5b4c2 328#define EXT2_NOTAIL_FL 0x00008000 /* file tail should not be merged */
88372d5c 329#define EXT2_DIRSYNC_FL 0x00010000 /* Synchronous directory modifications */
15f9011a 330#define EXT2_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
1ca1059f 331#define EXT4_HUGE_FILE_FL 0x00040000 /* Set to each huge file */
8fe81a3d 332#define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
faae7aa0 333#define EXT4_VERITY_FL 0x00100000 /* Verity protected inode */
cff9690f 334#define EXT4_EA_INODE_FL 0x00200000 /* Inode used for large EA */
010dc7b9 335/* EXT4_EOFBLOCKS_FL 0x00400000 was here */
0796e660 336#define FS_NOCOW_FL 0x00800000 /* Do not cow file */
6d0ed678
TT
337#define EXT4_SNAPFILE_FL 0x01000000 /* Inode is a snapshot */
338#define EXT4_SNAPFILE_DELETED_FL 0x04000000 /* Snapshot is being deleted */
339#define EXT4_SNAPFILE_SHRUNK_FL 0x08000000 /* Snapshot shrink has completed */
bf5dd0ae 340#define EXT4_INLINE_DATA_FL 0x10000000 /* Inode has inline data */
e1cec446 341#define EXT4_PROJINHERIT_FL 0x20000000 /* Create with parents projid */
1378bb65 342#define EXT4_CASEFOLD_FL 0x40000000 /* Casefolded file */
9f8046fc
TT
343#define EXT2_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
344
1378bb65
GKB
345#define EXT2_FL_USER_VISIBLE 0x604BDFFF /* User visible flags */
346#define EXT2_FL_USER_MODIFIABLE 0x604B80FF /* User modifiable flags */
9f8046fc
TT
347
348/*
349 * ioctl commands
350 */
bf69235a
TT
351
352/* Used for online resize */
353struct ext2_new_group_input {
354 __u32 group; /* Group number for this data */
355 __u32 block_bitmap; /* Absolute block number of block bitmap */
356 __u32 inode_bitmap; /* Absolute block number of inode bitmap */
357 __u32 inode_table; /* Absolute block number of inode table start */
358 __u32 blocks_count; /* Total number of blocks in this group */
359 __u16 reserved_blocks; /* Number of reserved blocks in this group */
360 __u16 unused; /* Number of reserved GDT blocks in group */
361};
362
5c4f8d67
TT
363struct ext4_new_group_input {
364 __u32 group; /* Group number for this data */
365 __u64 block_bitmap; /* Absolute block number of block bitmap */
366 __u64 inode_bitmap; /* Absolute block number of inode bitmap */
367 __u64 inode_table; /* Absolute block number of inode table start */
368 __u32 blocks_count; /* Total number of blocks in this group */
369 __u16 reserved_blocks; /* Number of reserved blocks in this group */
370 __u16 unused;
371};
372
3166c58d
TT
373#ifdef __GNU__ /* Needed for the Hurd */
374#define _IOT_ext2_new_group_input _IOT (_IOTS(__u32), 5, _IOTS(__u16), 2, 0, 0)
375#endif
376
0fbd1a8a
AD
377#define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
378#define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
379#define EXT2_IOC_GETVERSION _IOR('v', 1, long)
380#define EXT2_IOC_SETVERSION _IOW('v', 2, long)
bf69235a
TT
381#define EXT2_IOC_GETVERSION_NEW _IOR('f', 3, long)
382#define EXT2_IOC_SETVERSION_NEW _IOW('f', 4, long)
383#define EXT2_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
384#define EXT2_IOC_GROUP_ADD _IOW('f', 8,struct ext2_new_group_input)
5c4f8d67 385#define EXT4_IOC_GROUP_ADD _IOW('f', 8,struct ext4_new_group_input)
9f6ba888 386#define EXT4_IOC_RESIZE_FS _IOW('f', 16, __u64)
9f8046fc
TT
387
388/*
389 * Structure of an inode on the disk
390 */
391struct ext2_inode {
27fc1ffb 392/*00*/ __u16 i_mode; /* File mode */
9f8046fc
TT
393 __u16 i_uid; /* Low 16 bits of Owner Uid */
394 __u32 i_size; /* Size in bytes */
395 __u32 i_atime; /* Access time */
6b3ce987 396 __u32 i_ctime; /* Inode change time */
27fc1ffb 397/*10*/ __u32 i_mtime; /* Modification time */
9f8046fc
TT
398 __u32 i_dtime; /* Deletion Time */
399 __u16 i_gid; /* Low 16 bits of Group Id */
400 __u16 i_links_count; /* Links count */
401 __u32 i_blocks; /* Blocks count */
27fc1ffb 402/*20*/ __u32 i_flags; /* File flags */
9f8046fc
TT
403 union {
404 struct {
d362a3fb 405 __u32 l_i_version; /* was l_i_reserved1 */
9f8046fc
TT
406 } linux1;
407 struct {
408 __u32 h_i_translator;
409 } hurd1;
9f8046fc 410 } osd1; /* OS dependent 1 */
27fc1ffb
AD
411/*28*/ __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
412/*64*/ __u32 i_generation; /* File version (for NFS) */
9f8046fc 413 __u32 i_file_acl; /* File ACL */
578fcbfd 414 __u32 i_size_high;
27fc1ffb 415/*70*/ __u32 i_faddr; /* Fragment address */
9f8046fc
TT
416 union {
417 struct {
5d17119d 418 __u16 l_i_blocks_hi;
bb767b2f 419 __u16 l_i_file_acl_high;
9f8046fc
TT
420 __u16 l_i_uid_high; /* these 2 fields */
421 __u16 l_i_gid_high; /* were reserved2[0] */
ae96c678
TT
422 __u16 l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
423 __u16 l_i_reserved;
9f8046fc
TT
424 } linux2;
425 struct {
426 __u8 h_i_frag; /* Fragment number */
427 __u8 h_i_fsize; /* Fragment size */
428 __u16 h_i_mode_high;
429 __u16 h_i_uid_high;
430 __u16 h_i_gid_high;
431 __u32 h_i_author;
432 } hurd2;
9f8046fc
TT
433 } osd2; /* OS dependent 2 */
434};
435
7331196a
TT
436/*
437 * Permanent part of an large inode on the disk
438 */
439struct ext2_inode_large {
27fc1ffb 440/*00*/ __u16 i_mode; /* File mode */
7331196a
TT
441 __u16 i_uid; /* Low 16 bits of Owner Uid */
442 __u32 i_size; /* Size in bytes */
443 __u32 i_atime; /* Access time */
6b3ce987 444 __u32 i_ctime; /* Inode Change time */
27fc1ffb 445/*10*/ __u32 i_mtime; /* Modification time */
7331196a
TT
446 __u32 i_dtime; /* Deletion Time */
447 __u16 i_gid; /* Low 16 bits of Group Id */
448 __u16 i_links_count; /* Links count */
449 __u32 i_blocks; /* Blocks count */
27fc1ffb 450/*20*/ __u32 i_flags; /* File flags */
7331196a
TT
451 union {
452 struct {
d362a3fb 453 __u32 l_i_version; /* was l_i_reserved1 */
7331196a
TT
454 } linux1;
455 struct {
456 __u32 h_i_translator;
457 } hurd1;
7331196a 458 } osd1; /* OS dependent 1 */
27fc1ffb
AD
459/*28*/ __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
460/*64*/ __u32 i_generation; /* File version (for NFS) */
7331196a 461 __u32 i_file_acl; /* File ACL */
578fcbfd 462 __u32 i_size_high;
27fc1ffb 463/*70*/ __u32 i_faddr; /* Fragment address */
7331196a
TT
464 union {
465 struct {
5d17119d 466 __u16 l_i_blocks_hi;
bb767b2f 467 __u16 l_i_file_acl_high;
7331196a
TT
468 __u16 l_i_uid_high; /* these 2 fields */
469 __u16 l_i_gid_high; /* were reserved2[0] */
89efc88e
TT
470 __u16 l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
471 __u16 l_i_reserved;
7331196a
TT
472 } linux2;
473 struct {
474 __u8 h_i_frag; /* Fragment number */
475 __u8 h_i_fsize; /* Fragment size */
476 __u16 h_i_mode_high;
477 __u16 h_i_uid_high;
478 __u16 h_i_gid_high;
479 __u32 h_i_author;
480 } hurd2;
7331196a 481 } osd2; /* OS dependent 2 */
27fc1ffb 482/*80*/ __u16 i_extra_isize;
89efc88e 483 __u16 i_checksum_hi; /* crc32c(uuid+inum+inode) */
6b3ce987
TT
484 __u32 i_ctime_extra; /* extra Change time (nsec << 2 | epoch) */
485 __u32 i_mtime_extra; /* extra Modification time (nsec << 2 | epoch) */
486 __u32 i_atime_extra; /* extra Access time (nsec << 2 | epoch) */
27fc1ffb 487/*90*/ __u32 i_crtime; /* File creation time */
6b3ce987 488 __u32 i_crtime_extra; /* extra File creation time (nsec << 2 | epoch)*/
bb767b2f 489 __u32 i_version_hi; /* high 32 bits for 64-bit version */
27fc1ffb 490/*9c*/ __u32 i_projid; /* Project ID */
7331196a
TT
491};
492
37d82b6a
DW
493#define EXT4_INODE_CSUM_HI_EXTRA_END \
494 (offsetof(struct ext2_inode_large, i_checksum_hi) + sizeof(__u16) - \
495 EXT2_GOOD_OLD_INODE_SIZE)
496
082ed5dc
DT
497#define EXT4_EPOCH_BITS 2
498#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
499
ae67aaac
TT
500#define i_checksum_lo osd2.linux2.l_i_checksum_lo
501
080e09b4
LX
502#define inode_includes(size, field) \
503 (size >= (sizeof(((struct ext2_inode_large *)0)->field) + \
504 offsetof(struct ext2_inode_large, field)))
505
9f8046fc
TT
506#if defined(__KERNEL__) || defined(__linux__)
507#define i_reserved1 osd1.linux1.l_i_reserved1
508#define i_frag osd2.linux2.l_i_frag
509#define i_fsize osd2.linux2.l_i_fsize
510#define i_uid_low i_uid
511#define i_gid_low i_gid
512#define i_uid_high osd2.linux2.l_i_uid_high
513#define i_gid_high osd2.linux2.l_i_gid_high
48e6e813
TT
514#else
515#if defined(__GNU__)
9f8046fc
TT
516
517#define i_translator osd1.hurd1.h_i_translator
518#define i_frag osd2.hurd2.h_i_frag;
519#define i_fsize osd2.hurd2.h_i_fsize;
520#define i_uid_high osd2.hurd2.h_i_uid_high
521#define i_gid_high osd2.hurd2.h_i_gid_high
522#define i_author osd2.hurd2.h_i_author
523
48e6e813 524#endif /* __GNU__ */
7da78ff1 525#endif /* defined(__KERNEL__) || defined(__linux__) */
9f8046fc 526
7132d48d
TT
527#define inode_uid(inode) ((inode).i_uid | (inode).osd2.linux2.l_i_uid_high << 16)
528#define inode_gid(inode) ((inode).i_gid | (inode).osd2.linux2.l_i_gid_high << 16)
080e09b4 529#define inode_projid(inode) ((inode).i_projid)
15343922
TT
530#define ext2fs_set_i_uid_high(inode,x) ((inode).osd2.linux2.l_i_uid_high = (x))
531#define ext2fs_set_i_gid_high(inode,x) ((inode).osd2.linux2.l_i_gid_high = (x))
33068611 532
bc1ec4b4
TT
533static inline
534struct ext2_inode *EXT2_INODE(struct ext2_inode_large *large_inode)
535{
536 return (struct ext2_inode *) large_inode;
537}
538
9f8046fc
TT
539/*
540 * File system states
541 */
0fbd1a8a
AD
542#define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
543#define EXT2_ERROR_FS 0x0002 /* Errors detected */
a80f3694 544#define EXT3_ORPHAN_FS 0x0004 /* Orphans being recovered */
9f8046fc 545
f77704e4
TT
546/*
547 * Misc. filesystem flags
548 */
549#define EXT2_FLAGS_SIGNED_HASH 0x0001 /* Signed dirhash in use */
550#define EXT2_FLAGS_UNSIGNED_HASH 0x0002 /* Unsigned dirhash in use */
6cb27404 551#define EXT2_FLAGS_TEST_FILESYS 0x0004 /* OK for use on development code */
6d0ed678
TT
552#define EXT2_FLAGS_IS_SNAPSHOT 0x0010 /* This is a snapshot image */
553#define EXT2_FLAGS_FIX_SNAPSHOT 0x0020 /* Snapshot inodes corrupted */
554#define EXT2_FLAGS_FIX_EXCLUDE 0x0040 /* Exclude bitmaps corrupted */
f77704e4 555
9f8046fc
TT
556/*
557 * Mount flags
558 */
559#define EXT2_MOUNT_CHECK 0x0001 /* Do mount-time checks */
560#define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
561#define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
562#define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
563#define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
564#define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
565#define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
566#define EXT2_MOUNT_NO_UID32 0x0200 /* Disable 32-bit UIDs */
567
568#define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
569#define set_opt(o, opt) o |= EXT2_MOUNT_##opt
0fbd1a8a 570#define test_opt(sb, opt) (EXT2_SB(sb)->s_mount_opt & \
9f8046fc
TT
571 EXT2_MOUNT_##opt)
572/*
573 * Maximal mount counts between two filesystem checks
574 */
575#define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
576#define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
577
578/*
579 * Behaviour when detecting errors
580 */
581#define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
582#define EXT2_ERRORS_RO 2 /* Remount fs read-only */
583#define EXT2_ERRORS_PANIC 3 /* Panic */
584#define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
585
993988f6
TT
586#if (__GNUC__ >= 4)
587#define ext4_offsetof(TYPE,MEMBER) __builtin_offsetof(TYPE,MEMBER)
588#else
589#define ext4_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
590#endif
591
5d914d72
DW
592/* Metadata checksum algorithms */
593#define EXT2_CRC32C_CHKSUM 1
594
bfa4b350 595/* Encryption algorithms, key size and key reference len */
22f22ab1
TT
596#define EXT4_ENCRYPTION_MODE_INVALID 0
597#define EXT4_ENCRYPTION_MODE_AES_256_XTS 1
598#define EXT4_ENCRYPTION_MODE_AES_256_GCM 2
599#define EXT4_ENCRYPTION_MODE_AES_256_CBC 3
f7257a93 600#define EXT4_ENCRYPTION_MODE_AES_256_CTS 4
22f22ab1 601
bfa4b350
IM
602#define EXT4_AES_256_XTS_KEY_SIZE 64
603#define EXT4_AES_256_GCM_KEY_SIZE 32
604#define EXT4_AES_256_CBC_KEY_SIZE 32
f7257a93 605#define EXT4_AES_256_CTS_KEY_SIZE 32
bfa4b350
IM
606#define EXT4_MAX_KEY_SIZE 64
607
608#define EXT4_KEY_DESCRIPTOR_SIZE 8
e3dd5c6f 609#define EXT4_CRYPTO_BLOCK_SIZE 16
bfa4b350
IM
610
611/* Password derivation constants */
612#define EXT4_MAX_PASSPHRASE_SIZE 1024
613#define EXT4_MAX_SALT_SIZE 256
614#define EXT4_PBKDF2_ITERATIONS 0xFFFF
615
2832fd8b
TT
616#define EXT2_LABEL_LEN 16
617
bfa4b350
IM
618/*
619 * Policy provided via an ioctl on the topmost directory. This
620 * structure is also in the kernel.
621 */
622struct ext4_encryption_policy {
623 char version;
624 char contents_encryption_mode;
625 char filenames_encryption_mode;
437651ad 626 char flags;
bfa4b350
IM
627 char master_key_descriptor[EXT4_KEY_DESCRIPTOR_SIZE];
628} __attribute__((__packed__));
629
630struct ext4_encryption_key {
631 __u32 mode;
632 char raw[EXT4_MAX_KEY_SIZE];
633 __u32 size;
634} __attribute__((__packed__));
635
9f8046fc
TT
636/*
637 * Structure of the super block
638 */
639struct ext2_super_block {
27fc1ffb 640/*000*/ __u32 s_inodes_count; /* Inodes count */
9f8046fc
TT
641 __u32 s_blocks_count; /* Blocks count */
642 __u32 s_r_blocks_count; /* Reserved blocks count */
643 __u32 s_free_blocks_count; /* Free blocks count */
27fc1ffb 644/*010*/ __u32 s_free_inodes_count; /* Free inodes count */
9f8046fc
TT
645 __u32 s_first_data_block; /* First Data Block */
646 __u32 s_log_block_size; /* Block size */
4df16182 647 __u32 s_log_cluster_size; /* Allocation cluster size */
27fc1ffb 648/*020*/ __u32 s_blocks_per_group; /* # Blocks per group */
412376ef 649 __u32 s_clusters_per_group; /* # Fragments per group */
9f8046fc
TT
650 __u32 s_inodes_per_group; /* # Inodes per group */
651 __u32 s_mtime; /* Mount time */
27fc1ffb 652/*030*/ __u32 s_wtime; /* Write time */
9f8046fc
TT
653 __u16 s_mnt_count; /* Mount count */
654 __s16 s_max_mnt_count; /* Maximal mount count */
655 __u16 s_magic; /* Magic signature */
656 __u16 s_state; /* File system state */
657 __u16 s_errors; /* Behaviour when detecting errors */
0fbd1a8a 658 __u16 s_minor_rev_level; /* minor revision level */
27fc1ffb 659/*040*/ __u32 s_lastcheck; /* time of last check */
9f8046fc
TT
660 __u32 s_checkinterval; /* max. time between checks */
661 __u32 s_creator_os; /* OS */
662 __u32 s_rev_level; /* Revision level */
27fc1ffb 663/*050*/ __u16 s_def_resuid; /* Default uid for reserved blocks */
9f8046fc
TT
664 __u16 s_def_resgid; /* Default gid for reserved blocks */
665 /*
666 * These fields are for EXT2_DYNAMIC_REV superblocks only.
667 *
668 * Note: the difference between the compatible feature set and
669 * the incompatible feature set is that if there is a bit set
670 * in the incompatible feature set that the kernel doesn't
671 * know about, it should refuse to mount the filesystem.
0fbd1a8a 672 *
9f8046fc
TT
673 * e2fsck's requirements are more strict; if it doesn't know
674 * about a feature in either the compatible or incompatible
675 * feature set, it must abort and not try to meddle with
676 * things it doesn't understand...
677 */
0fbd1a8a
AD
678 __u32 s_first_ino; /* First non-reserved inode */
679 __u16 s_inode_size; /* size of inode structure */
680 __u16 s_block_group_nr; /* block group # of this superblock */
681 __u32 s_feature_compat; /* compatible feature set */
27fc1ffb 682/*060*/ __u32 s_feature_incompat; /* incompatible feature set */
0fbd1a8a 683 __u32 s_feature_ro_compat; /* readonly-compatible feature set */
27fc1ffb
AD
684/*068*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
685/*078*/ char s_volume_name[EXT2_LABEL_LEN]; /* volume name */
686/*088*/ char s_last_mounted[64]; /* directory where last mounted */
687/*0c8*/ __u32 s_algorithm_usage_bitmap; /* For compression */
9f8046fc
TT
688 /*
689 * Performance hints. Directory preallocation should only
690 * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
691 */
692 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
693 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
9e6c5dd7 694 __u16 s_reserved_gdt_blocks; /* Per group table for online growth */
0fbd1a8a 695 /*
9f8046fc
TT
696 * Journaling support valid if EXT2_FEATURE_COMPAT_HAS_JOURNAL set.
697 */
27fc1ffb
AD
698/*0d0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
699/*0e0*/ __u32 s_journal_inum; /* inode number of journal file */
9f8046fc
TT
700 __u32 s_journal_dev; /* device number of journal file */
701 __u32 s_last_orphan; /* start of list of inodes to delete */
27fc1ffb
AD
702/*0ec*/ __u32 s_hash_seed[4]; /* HTREE hash seed */
703/*0fc*/ __u8 s_def_hash_version; /* Default hash version to use */
704 __u8 s_jnl_backup_type; /* Default type of journal backup */
8061d2c1 705 __u16 s_desc_size; /* Group desc. size: INCOMPAT_64BIT */
27fc1ffb 706/*100*/ __u32 s_default_mount_opts; /* default EXT2_MOUNT_* flags used */
c046ac7f 707 __u32 s_first_meta_bg; /* First metablock group */
9d2aefb3 708 __u32 s_mkfs_time; /* When the filesystem was created */
27fc1ffb
AD
709/*10c*/ __u32 s_jnl_blocks[17]; /* Backup of the journal inode */
710/*150*/ __u32 s_blocks_count_hi; /* Blocks count high 32bits */
8061d2c1 711 __u32 s_r_blocks_count_hi; /* Reserved blocks count high 32 bits*/
27fc1ffb 712 __u32 s_free_blocks_hi; /* Free blocks count */
6b3ce987 713 __u16 s_min_extra_isize; /* All inodes have at least # bytes */
27fc1ffb
AD
714 __u16 s_want_extra_isize; /* New inodes should reserve # bytes */
715/*160*/ __u32 s_flags; /* Miscellaneous flags */
716 __u16 s_raid_stride; /* RAID stride in blocks */
717 __u16 s_mmp_update_interval; /* # seconds to wait in MMP checking */
718 __u64 s_mmp_block; /* Block for multi-mount protection */
719/*170*/ __u32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
494a1daa 720 __u8 s_log_groups_per_flex; /* FLEX_BG group size */
27fc1ffb 721 __u8 s_checksum_type; /* metadata checksum algorithm */
fc898cb9
TT
722 __u8 s_encryption_level; /* versioning level for encryption */
723 __u8 s_reserved_pad; /* Padding to next 32bits */
b7c5b403 724 __u64 s_kbytes_written; /* nr of lifetime kilobytes written */
27fc1ffb 725/*180*/ __u32 s_snapshot_inum; /* Inode number of active snapshot */
6d0ed678 726 __u32 s_snapshot_id; /* sequential ID of active snapshot */
27fc1ffb
AD
727 __u64 s_snapshot_r_blocks_count; /* active snapshot reserved blocks */
728/*190*/ __u32 s_snapshot_list; /* inode number of disk snapshot list */
993988f6
TT
729#define EXT4_S_ERR_START ext4_offsetof(struct ext2_super_block, s_error_count)
730 __u32 s_error_count; /* number of fs errors */
731 __u32 s_first_error_time; /* first time an error happened */
732 __u32 s_first_error_ino; /* inode involved in first error */
27fc1ffb 733/*1a0*/ __u64 s_first_error_block; /* block involved in first error */
993988f6 734 __u8 s_first_error_func[32]; /* function where the error happened */
27fc1ffb 735/*1c8*/ __u32 s_first_error_line; /* line number where error happened */
993988f6 736 __u32 s_last_error_time; /* most recent time of an error */
27fc1ffb 737/*1d0*/ __u32 s_last_error_ino; /* inode involved in last error */
993988f6
TT
738 __u32 s_last_error_line; /* line number where error happened */
739 __u64 s_last_error_block; /* block involved of last error */
27fc1ffb 740/*1e0*/ __u8 s_last_error_func[32]; /* function where the error happened */
9345f026 741#define EXT4_S_ERR_END ext4_offsetof(struct ext2_super_block, s_mount_opts)
27fc1ffb
AD
742/*200*/ __u8 s_mount_opts[64];
743/*240*/ __u32 s_usr_quota_inum; /* inode number of user quota file */
0edcc270 744 __u32 s_grp_quota_inum; /* inode number of group quota file */
4df16182 745 __u32 s_overhead_blocks; /* overhead blocks/clusters in fs */
27fc1ffb
AD
746/*24c*/ __u32 s_backup_bgs[2]; /* If sparse_super2 enabled */
747/*254*/ __u8 s_encrypt_algos[4]; /* Encryption algorithms in use */
748/*258*/ __u8 s_encrypt_pw_salt[16]; /* Salt used for string2key algorithm */
749/*268*/ __le32 s_lpf_ino; /* Location of the lost+found inode */
080e09b4 750 __le32 s_prj_quota_inum; /* inode for tracking project quota */
27fc1ffb 751/*270*/ __le32 s_checksum_seed; /* crc32c(orig_uuid) if csum_seed set */
e39f507a
GKB
752/*274*/ __u8 s_wtime_hi;
753 __u8 s_mtime_hi;
754 __u8 s_mkfs_time_hi;
755 __u8 s_lastcheck_hi;
756 __u8 s_first_error_time_hi;
757 __u8 s_last_error_time_hi;
758 __u8 s_pad[2];
44a1d8b9
GKB
759/*27c*/ __le16 s_encoding; /* Filename charset encoding */
760 __le16 s_encoding_flags; /* Filename charset encoding flags */
761 __le32 s_reserved[95]; /* Padding to the end of the block */
27fc1ffb 762/*3fc*/ __u32 s_checksum; /* crc32c(superblock) */
9f8046fc
TT
763};
764
993988f6
TT
765#define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
766
9f8046fc
TT
767/*
768 * Codes for operating systems
769 */
770#define EXT2_OS_LINUX 0
771#define EXT2_OS_HURD 1
c9548bc3 772#define EXT2_OBSO_OS_MASIX 2
9f8046fc
TT
773#define EXT2_OS_FREEBSD 3
774#define EXT2_OS_LITES 4
775
776/*
777 * Revision levels
778 */
779#define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
0fbd1a8a 780#define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
9f8046fc
TT
781
782#define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
783#define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
784
785#define EXT2_GOOD_OLD_INODE_SIZE 128
786
a435ec34
TT
787/*
788 * Journal inode backup types
789 */
790#define EXT3_JNL_BACKUP_BLOCKS 1
791
9f8046fc
TT
792/*
793 * Feature set definitions
794 */
795
796#define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
797 ( EXT2_SB(sb)->s_feature_compat & (mask) )
798#define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
799 ( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
800#define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
801 ( EXT2_SB(sb)->s_feature_incompat & (mask) )
802
803#define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
804#define EXT2_FEATURE_COMPAT_IMAGIC_INODES 0x0002
805#define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
b10820cd 806#define EXT2_FEATURE_COMPAT_EXT_ATTR 0x0008
9f8046fc 807#define EXT2_FEATURE_COMPAT_RESIZE_INODE 0x0010
b10820cd 808#define EXT2_FEATURE_COMPAT_DIR_INDEX 0x0020
f5fa2007 809#define EXT2_FEATURE_COMPAT_LAZY_BG 0x0040
89efc88e
TT
810/* #define EXT2_FEATURE_COMPAT_EXCLUDE_INODE 0x0080 not used, legacy */
811#define EXT2_FEATURE_COMPAT_EXCLUDE_BITMAP 0x0100
65c6c3e0 812#define EXT4_FEATURE_COMPAT_SPARSE_SUPER2 0x0200
89efc88e 813
9f8046fc
TT
814
815#define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
816#define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
2c93113e 817/* #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004 not used */
5d17119d 818#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE 0x0008
8815fb8a 819#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM 0x0010
bec6f49a 820#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK 0x0020
6b3ce987 821#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE 0x0040
6d0ed678 822#define EXT4_FEATURE_RO_COMPAT_HAS_SNAPSHOT 0x0080
0edcc270 823#define EXT4_FEATURE_RO_COMPAT_QUOTA 0x0100
412376ef 824#define EXT4_FEATURE_RO_COMPAT_BIGALLOC 0x0200
5d914d72
DW
825/*
826 * METADATA_CSUM implies GDT_CSUM. When METADATA_CSUM is set, group
827 * descriptor checksums use the same algorithm as all other data
828 * structures' checksums.
829 */
89efc88e 830#define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM 0x0400
991211f6 831#define EXT4_FEATURE_RO_COMPAT_REPLICA 0x0800
8b39e4cf 832#define EXT4_FEATURE_RO_COMPAT_READONLY 0x1000
0c18d036 833#define EXT4_FEATURE_RO_COMPAT_PROJECT 0x2000 /* Project quota */
611d3413 834#define EXT4_FEATURE_RO_COMPAT_SHARED_BLOCKS 0x4000
faae7aa0 835#define EXT4_FEATURE_RO_COMPAT_VERITY 0x8000
9f8046fc
TT
836
837#define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
838#define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
839#define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
840#define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
c046ac7f 841#define EXT2_FEATURE_INCOMPAT_META_BG 0x0010
39dc1c45 842#define EXT3_FEATURE_INCOMPAT_EXTENTS 0x0040
8061d2c1 843#define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
b62e88af 844#define EXT4_FEATURE_INCOMPAT_MMP 0x0100
cf0eeec0 845#define EXT4_FEATURE_INCOMPAT_FLEX_BG 0x0200
cff9690f 846#define EXT4_FEATURE_INCOMPAT_EA_INODE 0x0400
30a7610e 847#define EXT4_FEATURE_INCOMPAT_DIRDATA 0x1000
2ed0adbc 848#define EXT4_FEATURE_INCOMPAT_CSUM_SEED 0x2000
660b4c3b 849#define EXT4_FEATURE_INCOMPAT_LARGEDIR 0x4000 /* >2GB or 3-lvl htree */
94846158 850#define EXT4_FEATURE_INCOMPAT_INLINE_DATA 0x8000 /* data in inode */
22f22ab1 851#define EXT4_FEATURE_INCOMPAT_ENCRYPT 0x10000
44a1d8b9 852#define EXT4_FEATURE_INCOMPAT_FNAME_ENCODING 0x20000
39dc1c45 853
77b3e987
DW
854#define EXT4_FEATURE_COMPAT_FUNCS(name, ver, flagname) \
855static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
856{ \
857 return ((EXT2_SB(sb)->s_feature_compat & \
858 EXT##ver##_FEATURE_COMPAT_##flagname) != 0); \
859} \
860static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
861{ \
862 EXT2_SB(sb)->s_feature_compat |= \
863 EXT##ver##_FEATURE_COMPAT_##flagname; \
864} \
865static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
866{ \
867 EXT2_SB(sb)->s_feature_compat &= \
868 ~EXT##ver##_FEATURE_COMPAT_##flagname; \
869}
870
871#define EXT4_FEATURE_RO_COMPAT_FUNCS(name, ver, flagname) \
872static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
873{ \
874 return ((EXT2_SB(sb)->s_feature_ro_compat & \
875 EXT##ver##_FEATURE_RO_COMPAT_##flagname) != 0); \
876} \
877static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
878{ \
879 EXT2_SB(sb)->s_feature_ro_compat |= \
880 EXT##ver##_FEATURE_RO_COMPAT_##flagname; \
881} \
882static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
883{ \
884 EXT2_SB(sb)->s_feature_ro_compat &= \
885 ~EXT##ver##_FEATURE_RO_COMPAT_##flagname; \
886}
887
888#define EXT4_FEATURE_INCOMPAT_FUNCS(name, ver, flagname) \
889static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
890{ \
891 return ((EXT2_SB(sb)->s_feature_incompat & \
892 EXT##ver##_FEATURE_INCOMPAT_##flagname) != 0); \
893} \
894static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
895{ \
896 EXT2_SB(sb)->s_feature_incompat |= \
897 EXT##ver##_FEATURE_INCOMPAT_##flagname; \
898} \
899static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
900{ \
901 EXT2_SB(sb)->s_feature_incompat &= \
902 ~EXT##ver##_FEATURE_INCOMPAT_##flagname; \
903}
904
905EXT4_FEATURE_COMPAT_FUNCS(dir_prealloc, 2, DIR_PREALLOC)
906EXT4_FEATURE_COMPAT_FUNCS(imagic_inodes, 2, IMAGIC_INODES)
907EXT4_FEATURE_COMPAT_FUNCS(journal, 3, HAS_JOURNAL)
908EXT4_FEATURE_COMPAT_FUNCS(xattr, 2, EXT_ATTR)
909EXT4_FEATURE_COMPAT_FUNCS(resize_inode, 2, RESIZE_INODE)
910EXT4_FEATURE_COMPAT_FUNCS(dir_index, 2, DIR_INDEX)
911EXT4_FEATURE_COMPAT_FUNCS(lazy_bg, 2, LAZY_BG)
912EXT4_FEATURE_COMPAT_FUNCS(exclude_bitmap, 2, EXCLUDE_BITMAP)
913EXT4_FEATURE_COMPAT_FUNCS(sparse_super2, 4, SPARSE_SUPER2)
914
915EXT4_FEATURE_RO_COMPAT_FUNCS(sparse_super, 2, SPARSE_SUPER)
916EXT4_FEATURE_RO_COMPAT_FUNCS(large_file, 2, LARGE_FILE)
917EXT4_FEATURE_RO_COMPAT_FUNCS(huge_file, 4, HUGE_FILE)
918EXT4_FEATURE_RO_COMPAT_FUNCS(gdt_csum, 4, GDT_CSUM)
919EXT4_FEATURE_RO_COMPAT_FUNCS(dir_nlink, 4, DIR_NLINK)
920EXT4_FEATURE_RO_COMPAT_FUNCS(extra_isize, 4, EXTRA_ISIZE)
921EXT4_FEATURE_RO_COMPAT_FUNCS(has_snapshot, 4, HAS_SNAPSHOT)
922EXT4_FEATURE_RO_COMPAT_FUNCS(quota, 4, QUOTA)
923EXT4_FEATURE_RO_COMPAT_FUNCS(bigalloc, 4, BIGALLOC)
924EXT4_FEATURE_RO_COMPAT_FUNCS(metadata_csum, 4, METADATA_CSUM)
925EXT4_FEATURE_RO_COMPAT_FUNCS(replica, 4, REPLICA)
926EXT4_FEATURE_RO_COMPAT_FUNCS(readonly, 4, READONLY)
0c18d036 927EXT4_FEATURE_RO_COMPAT_FUNCS(project, 4, PROJECT)
611d3413 928EXT4_FEATURE_RO_COMPAT_FUNCS(shared_blocks, 4, SHARED_BLOCKS)
faae7aa0 929EXT4_FEATURE_RO_COMPAT_FUNCS(verity, 4, VERITY)
77b3e987
DW
930
931EXT4_FEATURE_INCOMPAT_FUNCS(compression, 2, COMPRESSION)
932EXT4_FEATURE_INCOMPAT_FUNCS(filetype, 2, FILETYPE)
933EXT4_FEATURE_INCOMPAT_FUNCS(journal_needs_recovery, 3, RECOVER)
934EXT4_FEATURE_INCOMPAT_FUNCS(journal_dev, 3, JOURNAL_DEV)
935EXT4_FEATURE_INCOMPAT_FUNCS(meta_bg, 2, META_BG)
936EXT4_FEATURE_INCOMPAT_FUNCS(extents, 3, EXTENTS)
937EXT4_FEATURE_INCOMPAT_FUNCS(64bit, 4, 64BIT)
938EXT4_FEATURE_INCOMPAT_FUNCS(mmp, 4, MMP)
939EXT4_FEATURE_INCOMPAT_FUNCS(flex_bg, 4, FLEX_BG)
940EXT4_FEATURE_INCOMPAT_FUNCS(ea_inode, 4, EA_INODE)
941EXT4_FEATURE_INCOMPAT_FUNCS(dirdata, 4, DIRDATA)
2ed0adbc 942EXT4_FEATURE_INCOMPAT_FUNCS(csum_seed, 4, CSUM_SEED)
77b3e987
DW
943EXT4_FEATURE_INCOMPAT_FUNCS(largedir, 4, LARGEDIR)
944EXT4_FEATURE_INCOMPAT_FUNCS(inline_data, 4, INLINE_DATA)
945EXT4_FEATURE_INCOMPAT_FUNCS(encrypt, 4, ENCRYPT)
44a1d8b9 946EXT4_FEATURE_INCOMPAT_FUNCS(fname_encoding, 4, FNAME_ENCODING)
77b3e987 947
9f8046fc 948#define EXT2_FEATURE_COMPAT_SUPP 0
0f5eba75 949#define EXT2_FEATURE_INCOMPAT_SUPP (EXT2_FEATURE_INCOMPAT_FILETYPE| \
3f0cf647 950 EXT4_FEATURE_INCOMPAT_MMP| \
6a081f6d
AD
951 EXT4_FEATURE_INCOMPAT_LARGEDIR| \
952 EXT4_FEATURE_INCOMPAT_EA_INODE)
9f8046fc
TT
953#define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
954 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
a7c9cb7d 955 EXT4_FEATURE_RO_COMPAT_DIR_NLINK| \
faae7aa0
TT
956 EXT2_FEATURE_RO_COMPAT_BTREE_DIR| \
957 EXT4_FEATURE_RO_COMPAT_VERITY)
9f8046fc
TT
958
959/*
960 * Default values for user and/or group using reserved blocks
961 */
0fbd1a8a
AD
962#define EXT2_DEF_RESUID 0
963#define EXT2_DEF_RESGID 0
9f8046fc 964
a0c3fd5e
TT
965/*
966 * Default mount options
967 */
968#define EXT2_DEFM_DEBUG 0x0001
969#define EXT2_DEFM_BSDGROUPS 0x0002
970#define EXT2_DEFM_XATTR_USER 0x0004
971#define EXT2_DEFM_ACL 0x0008
972#define EXT2_DEFM_UID16 0x0010
efc6f628 973#define EXT3_DEFM_JMODE 0x0060
4a959fe6
TT
974#define EXT3_DEFM_JMODE_DATA 0x0020
975#define EXT3_DEFM_JMODE_ORDERED 0x0040
976#define EXT3_DEFM_JMODE_WBACK 0x0060
9345f026
TT
977#define EXT4_DEFM_NOBARRIER 0x0100
978#define EXT4_DEFM_BLOCK_VALIDITY 0x0200
979#define EXT4_DEFM_DISCARD 0x0400
980#define EXT4_DEFM_NODELALLOC 0x0800
a0c3fd5e 981
9f8046fc
TT
982/*
983 * Structure of a directory entry
984 */
985#define EXT2_NAME_LEN 255
986
987struct ext2_dir_entry {
988 __u32 inode; /* Inode number */
989 __u16 rec_len; /* Directory entry length */
990 __u16 name_len; /* Name length */
991 char name[EXT2_NAME_LEN]; /* File name */
992};
993
994/*
995 * The new version of the directory entry. Since EXT2 structures are
996 * stored in intel byte order, and the name_len field could never be
997 * bigger than 255 chars, it's safe to reclaim the extra byte for the
998 * file_type field.
70f4632b 999 *
055866d8 1000 * This structure is deprecated due to endian issues. Please use struct
70f4632b
JK
1001 * ext2_dir_entry and accessor functions
1002 * ext2fs_dirent_name_len
1003 * ext2fs_dirent_set_name_len
1004 * ext2fs_dirent_file_type
1005 * ext2fs_dirent_set_file_type
1006 * to get and set name_len and file_type fields.
9f8046fc
TT
1007 */
1008struct ext2_dir_entry_2 {
1009 __u32 inode; /* Inode number */
1010 __u16 rec_len; /* Directory entry length */
1011 __u8 name_len; /* Name length */
1012 __u8 file_type;
1013 char name[EXT2_NAME_LEN]; /* File name */
1014};
1015
5d914d72
DW
1016/*
1017 * This is a bogus directory entry at the end of each leaf block that
1018 * records checksums.
1019 */
1020struct ext2_dir_entry_tail {
1021 __u32 det_reserved_zero1; /* Pretend to be unused */
1022 __u16 det_rec_len; /* 12 */
1023 __u16 det_reserved_name_len; /* 0xDE00, fake namelen/filetype */
1024 __u32 det_checksum; /* crc32c(uuid+inode+dirent) */
1025};
1026
9f8046fc
TT
1027/*
1028 * Ext2 directory file types. Only the low 3 bits are used. The
1029 * other bits are reserved for now.
1030 */
1031#define EXT2_FT_UNKNOWN 0
1032#define EXT2_FT_REG_FILE 1
1033#define EXT2_FT_DIR 2
1034#define EXT2_FT_CHRDEV 3
0fbd1a8a 1035#define EXT2_FT_BLKDEV 4
9f8046fc
TT
1036#define EXT2_FT_FIFO 5
1037#define EXT2_FT_SOCK 6
1038#define EXT2_FT_SYMLINK 7
1039
1040#define EXT2_FT_MAX 8
1041
5d914d72
DW
1042/*
1043 * Annoyingly, e2fsprogs always swab16s ext2_dir_entry.name_len, so we
1044 * have to build ext2_dir_entry_tail with that assumption too. This
1045 * constant helps to build the dir_entry_tail to look like it has an
1046 * "invalid" file type.
1047 */
1048#define EXT2_DIR_NAME_LEN_CSUM 0xDE00
1049
9f8046fc
TT
1050/*
1051 * EXT2_DIR_PAD defines the directory entries boundaries
1052 *
1053 * NOTE: It must be a multiple of 4
1054 */
4a3dc1f0 1055#define EXT2_DIR_ENTRY_HEADER_LEN 8
0fbd1a8a
AD
1056#define EXT2_DIR_PAD 4
1057#define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
4a3dc1f0
DW
1058#define EXT2_DIR_REC_LEN(name_len) (((name_len) + \
1059 EXT2_DIR_ENTRY_HEADER_LEN + \
1060 EXT2_DIR_ROUND) & \
9f8046fc
TT
1061 ~EXT2_DIR_ROUND)
1062
188960ea
TT
1063/*
1064 * Constants for ext4's extended time encoding
1065 */
1066#define EXT4_EPOCH_BITS 2
1067#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
1068#define EXT4_NSEC_MASK (~0UL << EXT4_EPOCH_BITS)
1069
b62e88af 1070/*
0f5eba75
AD
1071 * This structure is used for multiple mount protection. It is written
1072 * into the block number saved in the s_mmp_block field in the superblock.
1073 * Programs that check MMP should assume that if SEQ_FSCK (or any unknown
1074 * code above SEQ_MAX) is present then it is NOT safe to use the filesystem,
1075 * regardless of how old the timestamp is.
1076 *
1077 * The timestamp in the MMP structure will be updated by e2fsck at some
055866d8 1078 * arbitrary intervals (start of passes, after every few groups of inodes
0f5eba75
AD
1079 * in pass1 and pass1b). There is no guarantee that e2fsck is updating
1080 * the MMP block in a timely manner, and the updates it does are purely
1081 * for the convenience of the sysadmin and not for automatic validation.
1082 *
1083 * Note: Only the mmp_seq value is used to determine whether the MMP block
1084 * is being updated. The mmp_time, mmp_nodename, and mmp_bdevname
1085 * fields are only for informational purposes for the administrator,
1086 * due to clock skew between nodes and hostname HA service takeover.
b62e88af 1087 */
0f5eba75
AD
1088#define EXT4_MMP_MAGIC 0x004D4D50U /* ASCII for MMP */
1089#define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
1090#define EXT4_MMP_SEQ_FSCK 0xE24D4D50U /* mmp_seq value when being fscked */
1091#define EXT4_MMP_SEQ_MAX 0xE24D4D4FU /* maximum valid mmp_seq value */
b62e88af 1092
1224c0d3 1093/* Not endian-annotated; it's swapped at read/write time */
b62e88af 1094struct mmp_struct {
0f5eba75
AD
1095 __u32 mmp_magic; /* Magic number for MMP */
1096 __u32 mmp_seq; /* Sequence no. updated periodically */
1097 __u64 mmp_time; /* Time last updated */
1098 char mmp_nodename[64]; /* Node which last updated MMP block */
1099 char mmp_bdevname[32]; /* Bdev which last updated MMP block */
1100 __u16 mmp_check_interval; /* Changed mmp_check_interval */
b62e88af 1101 __u16 mmp_pad1;
5d914d72
DW
1102 __u32 mmp_pad2[226];
1103 __u32 mmp_checksum; /* crc32c(uuid+mmp_block) */
b62e88af
AD
1104};
1105
1106/*
0f5eba75
AD
1107 * Default interval for MMP update in seconds.
1108 */
1109#define EXT4_MMP_UPDATE_INTERVAL 5
1110
1111/*
1112 * Maximum interval for MMP update in seconds.
1113 */
1114#define EXT4_MMP_MAX_UPDATE_INTERVAL 300
1115
1116/*
1117 * Minimum interval for MMP checking in seconds.
b62e88af 1118 */
0f5eba75 1119#define EXT4_MMP_MIN_CHECK_INTERVAL 5
b62e88af 1120
416c1de9
ZL
1121/*
1122 * Minimum size of inline data.
1123 */
1124#define EXT4_MIN_INLINE_DATA_SIZE ((sizeof(__u32) * EXT2_N_BLOCKS))
1125
1126/*
1127 * Size of a parent inode in inline data directory.
1128 */
1129#define EXT4_INLINE_DATA_DOTDOT_SIZE (4)
1130
d85c5a61
GKB
1131#define EXT4_ENC_ASCII 0
1132#define EXT4_ENC_UTF8_11_0 1
1133
1134#define EXT4_ENC_STRICT_MODE_FL (1 << 0) /* Reject invalid sequences */
1135#define EXT4_UTF8_NORMALIZATION_TYPE_NFKD (1 << 1)
1136#define EXT4_UTF8_CASEFOLD_TYPE_NFKDCF (1 << 4)
1137
9f8046fc 1138#endif /* _LINUX_EXT2_FS_H */