]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blob - lib/ext2fs/ext2_fs.h
Merge branch 'maint' into next
[thirdparty/e2fsprogs.git] / lib / ext2fs / ext2_fs.h
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
19 #include <ext2fs/ext2_types.h> /* Changed from linux/types.h */
20
21 /*
22 * The second extended filesystem constants/structures
23 */
24
25 /*
26 * Define EXT2FS_DEBUG to produce debug messages
27 */
28 #undef EXT2FS_DEBUG
29
30 /*
31 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
32 */
33 #define EXT2_PREALLOCATE
34 #define EXT2_DEFAULT_PREALLOC_BLOCKS 8
35
36 /*
37 * The second extended file system version
38 */
39 #define EXT2FS_DATE "95/08/09"
40 #define EXT2FS_VERSION "0.5b"
41
42 /*
43 * Special inode numbers
44 */
45 #define EXT2_BAD_INO 1 /* Bad blocks inode */
46 #define EXT2_ROOT_INO 2 /* Root inode */
47 #define EXT4_USR_QUOTA_INO 3 /* User quota inode */
48 #define EXT4_GRP_QUOTA_INO 4 /* Group quota inode */
49 #define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
50 #define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
51 #define EXT2_RESIZE_INO 7 /* Reserved group descriptors inode */
52 #define EXT2_JOURNAL_INO 8 /* Journal inode */
53 #define EXT2_EXCLUDE_INO 9 /* The "exclude" inode, for snapshots */
54 #define EXT4_REPLICA_INO 10 /* Used by non-upstream feature */
55
56 /* First non-reserved inode for old ext2 filesystems */
57 #define EXT2_GOOD_OLD_FIRST_INO 11
58
59 /*
60 * The second extended file system magic number
61 */
62 #define EXT2_SUPER_MAGIC 0xEF53
63
64 #ifdef __KERNEL__
65 #define EXT2_SB(sb) (&((sb)->u.ext2_sb))
66 #else
67 /* Assume that user mode programs are passing in an ext2fs superblock, not
68 * a kernel struct super_block. This will allow us to call the feature-test
69 * macros from user land. */
70 #define EXT2_SB(sb) (sb)
71 #endif
72
73 /*
74 * Maximal count of links to a file
75 */
76 #define EXT2_LINK_MAX 65000
77
78 /*
79 * Macro-instructions used to manage several block sizes
80 */
81 #define EXT2_MIN_BLOCK_LOG_SIZE 10 /* 1024 */
82 #define EXT2_MAX_BLOCK_LOG_SIZE 16 /* 65536 */
83 #define EXT2_MIN_BLOCK_SIZE (1 << EXT2_MIN_BLOCK_LOG_SIZE)
84 #define EXT2_MAX_BLOCK_SIZE (1 << EXT2_MAX_BLOCK_LOG_SIZE)
85 #ifdef __KERNEL__
86 #define EXT2_BLOCK_SIZE(s) ((s)->s_blocksize)
87 #define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
88 #define EXT2_ADDR_PER_BLOCK_BITS(s) (EXT2_SB(s)->addr_per_block_bits)
89 #define EXT2_INODE_SIZE(s) (EXT2_SB(s)->s_inode_size)
90 #define EXT2_FIRST_INO(s) (EXT2_SB(s)->s_first_ino)
91 #else
92 #define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
93 #define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
94 #define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
95 EXT2_GOOD_OLD_INODE_SIZE : (s)->s_inode_size)
96 #define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
97 EXT2_GOOD_OLD_FIRST_INO : (s)->s_first_ino)
98 #endif
99 #define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof(__u32))
100
101 /*
102 * Macro-instructions used to manage allocation clusters
103 */
104 #define EXT2_MIN_CLUSTER_LOG_SIZE EXT2_MIN_BLOCK_LOG_SIZE
105 #define EXT2_MAX_CLUSTER_LOG_SIZE 29 /* 512MB */
106 #define EXT2_MIN_CLUSTER_SIZE EXT2_MIN_BLOCK_SIZE
107 #define EXT2_MAX_CLUSTER_SIZE (1 << EXT2_MAX_CLUSTER_LOG_SIZE)
108 #define EXT2_CLUSTER_SIZE(s) (EXT2_MIN_BLOCK_SIZE << \
109 (s)->s_log_cluster_size)
110 #define EXT2_CLUSTER_SIZE_BITS(s) ((s)->s_log_cluster_size + 10)
111
112 /*
113 * Macro-instructions used to manage fragments
114 *
115 * Note: for backwards compatibility only, for the dump program.
116 * Ext2/3/4 will never support fragments....
117 */
118 #define EXT2_MIN_FRAG_SIZE EXT2_MIN_BLOCK_SIZE
119 #define EXT2_MAX_FRAG_SIZE EXT2_MAX_BLOCK_SIZE
120 #define EXT2_MIN_FRAG_LOG_SIZE EXT2_MIN_BLOCK_LOG_SIZE
121 #define EXT2_FRAG_SIZE(s) EXT2_BLOCK_SIZE(s)
122 #define EXT2_FRAGS_PER_BLOCK(s) 1
123
124 /*
125 * ACL structures
126 */
127 struct ext2_acl_header /* Header of Access Control Lists */
128 {
129 __u32 aclh_size;
130 __u32 aclh_file_count;
131 __u32 aclh_acle_count;
132 __u32 aclh_first_acle;
133 };
134
135 struct ext2_acl_entry /* Access Control List Entry */
136 {
137 __u32 acle_size;
138 __u16 acle_perms; /* Access permissions */
139 __u16 acle_type; /* Type of entry */
140 __u16 acle_tag; /* User or group identity */
141 __u16 acle_pad1;
142 __u32 acle_next; /* Pointer on next entry for the */
143 /* same inode or on next free entry */
144 };
145
146 /*
147 * Structure of a blocks group descriptor
148 */
149 struct ext2_group_desc
150 {
151 __u32 bg_block_bitmap; /* Blocks bitmap block */
152 __u32 bg_inode_bitmap; /* Inodes bitmap block */
153 __u32 bg_inode_table; /* Inodes table block */
154 __u16 bg_free_blocks_count; /* Free blocks count */
155 __u16 bg_free_inodes_count; /* Free inodes count */
156 __u16 bg_used_dirs_count; /* Directories count */
157 __u16 bg_flags;
158 __u32 bg_exclude_bitmap_lo; /* Exclude bitmap for snapshots */
159 __u16 bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
160 __u16 bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
161 __u16 bg_itable_unused; /* Unused inodes count */
162 __u16 bg_checksum; /* crc16(s_uuid+group_num+group_desc)*/
163 };
164
165 /*
166 * Structure of a blocks group descriptor
167 */
168 struct ext4_group_desc
169 {
170 __u32 bg_block_bitmap; /* Blocks bitmap block */
171 __u32 bg_inode_bitmap; /* Inodes bitmap block */
172 __u32 bg_inode_table; /* Inodes table block */
173 __u16 bg_free_blocks_count; /* Free blocks count */
174 __u16 bg_free_inodes_count; /* Free inodes count */
175 __u16 bg_used_dirs_count; /* Directories count */
176 __u16 bg_flags; /* EXT4_BG_flags (INODE_UNINIT, etc) */
177 __u32 bg_exclude_bitmap_lo; /* Exclude bitmap for snapshots */
178 __u16 bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
179 __u16 bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
180 __u16 bg_itable_unused; /* Unused inodes count */
181 __u16 bg_checksum; /* crc16(sb_uuid+group+desc) */
182 __u32 bg_block_bitmap_hi; /* Blocks bitmap block MSB */
183 __u32 bg_inode_bitmap_hi; /* Inodes bitmap block MSB */
184 __u32 bg_inode_table_hi; /* Inodes table block MSB */
185 __u16 bg_free_blocks_count_hi;/* Free blocks count MSB */
186 __u16 bg_free_inodes_count_hi;/* Free inodes count MSB */
187 __u16 bg_used_dirs_count_hi; /* Directories count MSB */
188 __u16 bg_itable_unused_hi; /* Unused inodes count MSB */
189 __u32 bg_exclude_bitmap_hi; /* Exclude bitmap block MSB */
190 __u16 bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
191 __u16 bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
192 __u32 bg_reserved;
193 };
194
195 #define EXT4_BG_INODE_BITMAP_CSUM_HI_END \
196 (offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
197 sizeof(__u16))
198 #define EXT4_BG_BLOCK_BITMAP_CSUM_HI_LOCATION \
199 (offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
200 sizeof(__u16))
201
202 #define EXT2_BG_INODE_UNINIT 0x0001 /* Inode table/bitmap not initialized */
203 #define EXT2_BG_BLOCK_UNINIT 0x0002 /* Block bitmap not initialized */
204 #define EXT2_BG_INODE_ZEROED 0x0004 /* On-disk itable initialized to zero */
205
206 /*
207 * Data structures used by the directory indexing feature
208 *
209 * Note: all of the multibyte integer fields are little endian.
210 */
211
212 /*
213 * Note: dx_root_info is laid out so that if it should somehow get
214 * overlaid by a dirent the two low bits of the hash version will be
215 * zero. Therefore, the hash version mod 4 should never be 0.
216 * Sincerely, the paranoia department.
217 */
218 struct ext2_dx_root_info {
219 __u32 reserved_zero;
220 __u8 hash_version; /* 0 now, 1 at release */
221 __u8 info_length; /* 8 */
222 __u8 indirect_levels;
223 __u8 unused_flags;
224 };
225
226 #define EXT2_HASH_LEGACY 0
227 #define EXT2_HASH_HALF_MD4 1
228 #define EXT2_HASH_TEA 2
229 #define EXT2_HASH_LEGACY_UNSIGNED 3 /* reserved for userspace lib */
230 #define EXT2_HASH_HALF_MD4_UNSIGNED 4 /* reserved for userspace lib */
231 #define EXT2_HASH_TEA_UNSIGNED 5 /* reserved for userspace lib */
232
233 #define EXT2_HASH_FLAG_INCOMPAT 0x1
234
235 struct ext2_dx_entry {
236 __le32 hash;
237 __le32 block;
238 };
239
240 struct ext2_dx_countlimit {
241 __le16 limit;
242 __le16 count;
243 };
244
245 /*
246 * This goes at the end of each htree block.
247 */
248 struct ext2_dx_tail {
249 __le32 dt_reserved;
250 __le32 dt_checksum; /* crc32c(uuid+inum+dxblock) */
251 };
252
253 /*
254 * Macro-instructions used to manage group descriptors
255 */
256 #define EXT2_MIN_DESC_SIZE 32
257 #define EXT2_MIN_DESC_SIZE_64BIT 64
258 #define EXT2_MAX_DESC_SIZE EXT2_MIN_BLOCK_SIZE
259 #define EXT2_DESC_SIZE(s) \
260 ((EXT2_SB(s)->s_feature_incompat & EXT4_FEATURE_INCOMPAT_64BIT) ? \
261 (s)->s_desc_size : EXT2_MIN_DESC_SIZE)
262
263 #define EXT2_BLOCKS_PER_GROUP(s) (EXT2_SB(s)->s_blocks_per_group)
264 #define EXT2_INODES_PER_GROUP(s) (EXT2_SB(s)->s_inodes_per_group)
265 #define EXT2_CLUSTERS_PER_GROUP(s) (EXT2_SB(s)->s_clusters_per_group)
266 #define EXT2_INODES_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s)/EXT2_INODE_SIZE(s))
267 /* limits imposed by 16-bit value gd_free_{blocks,inode}_count */
268 #define EXT2_MAX_BLOCKS_PER_GROUP(s) ((((unsigned) 1 << 16) - 8) * \
269 (EXT2_CLUSTER_SIZE(s) / \
270 EXT2_BLOCK_SIZE(s)))
271 #define EXT2_MAX_CLUSTERS_PER_GROUP(s) (((unsigned) 1 << 16) - 8)
272 #define EXT2_MAX_INODES_PER_GROUP(s) (((unsigned) 1 << 16) - \
273 EXT2_INODES_PER_BLOCK(s))
274 #ifdef __KERNEL__
275 #define EXT2_DESC_PER_BLOCK(s) (EXT2_SB(s)->s_desc_per_block)
276 #define EXT2_DESC_PER_BLOCK_BITS(s) (EXT2_SB(s)->s_desc_per_block_bits)
277 #else
278 #define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_DESC_SIZE(s))
279 #endif
280
281 #define EXT2_GROUPS_TO_BLOCKS(s, g) ((blk64_t) EXT2_BLOCKS_PER_GROUP(s) * \
282 (g))
283 #define EXT2_GROUPS_TO_CLUSTERS(s, g) ((blk64_t) EXT2_CLUSTERS_PER_GROUP(s) * \
284 (g))
285
286 /*
287 * Constants relative to the data blocks
288 */
289 #define EXT2_NDIR_BLOCKS 12
290 #define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
291 #define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
292 #define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
293 #define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
294
295 /*
296 * Inode flags
297 */
298 #define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
299 #define EXT2_UNRM_FL 0x00000002 /* Undelete */
300 #define EXT2_COMPR_FL 0x00000004 /* Compress file */
301 #define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
302 #define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
303 #define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
304 #define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
305 #define EXT2_NOATIME_FL 0x00000080 /* do not update atime */
306 /* Reserved for compression usage... */
307 #define EXT2_DIRTY_FL 0x00000100
308 #define EXT2_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
309 #define EXT2_NOCOMPR_FL 0x00000400 /* Access raw compressed data */
310 #define EXT2_ECOMPR_FL 0x00000800 /* Compression error */
311 /* End compression flags --- maybe not all used */
312 #define EXT2_BTREE_FL 0x00001000 /* btree format dir */
313 #define EXT2_INDEX_FL 0x00001000 /* hash-indexed directory */
314 #define EXT2_IMAGIC_FL 0x00002000
315 #define EXT3_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
316 #define EXT2_NOTAIL_FL 0x00008000 /* file tail should not be merged */
317 #define EXT2_DIRSYNC_FL 0x00010000 /* Synchronous directory modifications */
318 #define EXT2_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
319 #define EXT4_HUGE_FILE_FL 0x00040000 /* Set to each huge file */
320 #define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
321 #define EXT4_EA_INODE_FL 0x00200000 /* Inode used for large EA */
322 /* EXT4_EOFBLOCKS_FL 0x00400000 was here */
323 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
324 #define EXT4_SNAPFILE_FL 0x01000000 /* Inode is a snapshot */
325 #define EXT4_SNAPFILE_DELETED_FL 0x04000000 /* Snapshot is being deleted */
326 #define EXT4_SNAPFILE_SHRUNK_FL 0x08000000 /* Snapshot shrink has completed */
327 #define EXT4_INLINE_DATA_FL 0x10000000 /* Inode has inline data */
328 #define EXT2_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
329
330 #define EXT2_FL_USER_VISIBLE 0x004BDFFF /* User visible flags */
331 #define EXT2_FL_USER_MODIFIABLE 0x004B80FF /* User modifiable flags */
332
333 /*
334 * ioctl commands
335 */
336
337 /* Used for online resize */
338 struct ext2_new_group_input {
339 __u32 group; /* Group number for this data */
340 __u32 block_bitmap; /* Absolute block number of block bitmap */
341 __u32 inode_bitmap; /* Absolute block number of inode bitmap */
342 __u32 inode_table; /* Absolute block number of inode table start */
343 __u32 blocks_count; /* Total number of blocks in this group */
344 __u16 reserved_blocks; /* Number of reserved blocks in this group */
345 __u16 unused; /* Number of reserved GDT blocks in group */
346 };
347
348 struct ext4_new_group_input {
349 __u32 group; /* Group number for this data */
350 __u64 block_bitmap; /* Absolute block number of block bitmap */
351 __u64 inode_bitmap; /* Absolute block number of inode bitmap */
352 __u64 inode_table; /* Absolute block number of inode table start */
353 __u32 blocks_count; /* Total number of blocks in this group */
354 __u16 reserved_blocks; /* Number of reserved blocks in this group */
355 __u16 unused;
356 };
357
358 #ifdef __GNU__ /* Needed for the Hurd */
359 #define _IOT_ext2_new_group_input _IOT (_IOTS(__u32), 5, _IOTS(__u16), 2, 0, 0)
360 #endif
361
362 #define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
363 #define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
364 #define EXT2_IOC_GETVERSION _IOR('v', 1, long)
365 #define EXT2_IOC_SETVERSION _IOW('v', 2, long)
366 #define EXT2_IOC_GETVERSION_NEW _IOR('f', 3, long)
367 #define EXT2_IOC_SETVERSION_NEW _IOW('f', 4, long)
368 #define EXT2_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
369 #define EXT2_IOC_GROUP_ADD _IOW('f', 8,struct ext2_new_group_input)
370 #define EXT4_IOC_GROUP_ADD _IOW('f', 8,struct ext4_new_group_input)
371 #define EXT4_IOC_RESIZE_FS _IOW('f', 16, __u64)
372
373 /*
374 * Structure of an inode on the disk
375 */
376 struct ext2_inode {
377 __u16 i_mode; /* File mode */
378 __u16 i_uid; /* Low 16 bits of Owner Uid */
379 __u32 i_size; /* Size in bytes */
380 __u32 i_atime; /* Access time */
381 __u32 i_ctime; /* Inode change time */
382 __u32 i_mtime; /* Modification time */
383 __u32 i_dtime; /* Deletion Time */
384 __u16 i_gid; /* Low 16 bits of Group Id */
385 __u16 i_links_count; /* Links count */
386 __u32 i_blocks; /* Blocks count */
387 __u32 i_flags; /* File flags */
388 union {
389 struct {
390 __u32 l_i_version; /* was l_i_reserved1 */
391 } linux1;
392 struct {
393 __u32 h_i_translator;
394 } hurd1;
395 } osd1; /* OS dependent 1 */
396 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
397 __u32 i_generation; /* File version (for NFS) */
398 __u32 i_file_acl; /* File ACL */
399 __u32 i_size_high; /* Formerly i_dir_acl, directory ACL */
400 __u32 i_faddr; /* Fragment address */
401 union {
402 struct {
403 __u16 l_i_blocks_hi;
404 __u16 l_i_file_acl_high;
405 __u16 l_i_uid_high; /* these 2 fields */
406 __u16 l_i_gid_high; /* were reserved2[0] */
407 __u16 l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
408 __u16 l_i_reserved;
409 } linux2;
410 struct {
411 __u8 h_i_frag; /* Fragment number */
412 __u8 h_i_fsize; /* Fragment size */
413 __u16 h_i_mode_high;
414 __u16 h_i_uid_high;
415 __u16 h_i_gid_high;
416 __u32 h_i_author;
417 } hurd2;
418 } osd2; /* OS dependent 2 */
419 };
420
421 /*
422 * Permanent part of an large inode on the disk
423 */
424 struct ext2_inode_large {
425 __u16 i_mode; /* File mode */
426 __u16 i_uid; /* Low 16 bits of Owner Uid */
427 __u32 i_size; /* Size in bytes */
428 __u32 i_atime; /* Access time */
429 __u32 i_ctime; /* Inode Change time */
430 __u32 i_mtime; /* Modification time */
431 __u32 i_dtime; /* Deletion Time */
432 __u16 i_gid; /* Low 16 bits of Group Id */
433 __u16 i_links_count; /* Links count */
434 __u32 i_blocks; /* Blocks count */
435 __u32 i_flags; /* File flags */
436 union {
437 struct {
438 __u32 l_i_version; /* was l_i_reserved1 */
439 } linux1;
440 struct {
441 __u32 h_i_translator;
442 } hurd1;
443 } osd1; /* OS dependent 1 */
444 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
445 __u32 i_generation; /* File version (for NFS) */
446 __u32 i_file_acl; /* File ACL */
447 __u32 i_size_high; /* Formerly i_dir_acl, directory ACL */
448 __u32 i_faddr; /* Fragment address */
449 union {
450 struct {
451 __u16 l_i_blocks_hi;
452 __u16 l_i_file_acl_high;
453 __u16 l_i_uid_high; /* these 2 fields */
454 __u16 l_i_gid_high; /* were reserved2[0] */
455 __u16 l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
456 __u16 l_i_reserved;
457 } linux2;
458 struct {
459 __u8 h_i_frag; /* Fragment number */
460 __u8 h_i_fsize; /* Fragment size */
461 __u16 h_i_mode_high;
462 __u16 h_i_uid_high;
463 __u16 h_i_gid_high;
464 __u32 h_i_author;
465 } hurd2;
466 } osd2; /* OS dependent 2 */
467 __u16 i_extra_isize;
468 __u16 i_checksum_hi; /* crc32c(uuid+inum+inode) */
469 __u32 i_ctime_extra; /* extra Change time (nsec << 2 | epoch) */
470 __u32 i_mtime_extra; /* extra Modification time (nsec << 2 | epoch) */
471 __u32 i_atime_extra; /* extra Access time (nsec << 2 | epoch) */
472 __u32 i_crtime; /* File creation time */
473 __u32 i_crtime_extra; /* extra File creation time (nsec << 2 | epoch)*/
474 __u32 i_version_hi; /* high 32 bits for 64-bit version */
475 };
476
477 #define EXT4_INODE_CSUM_HI_EXTRA_END \
478 (offsetof(struct ext2_inode_large, i_checksum_hi) + sizeof(__u16) - \
479 EXT2_GOOD_OLD_INODE_SIZE)
480
481 #define i_dir_acl i_size_high
482
483 #define i_checksum_lo osd2.linux2.l_i_checksum_lo
484
485 #if defined(__KERNEL__) || defined(__linux__)
486 #define i_reserved1 osd1.linux1.l_i_reserved1
487 #define i_frag osd2.linux2.l_i_frag
488 #define i_fsize osd2.linux2.l_i_fsize
489 #define i_uid_low i_uid
490 #define i_gid_low i_gid
491 #define i_uid_high osd2.linux2.l_i_uid_high
492 #define i_gid_high osd2.linux2.l_i_gid_high
493 #else
494 #if defined(__GNU__)
495
496 #define i_translator osd1.hurd1.h_i_translator
497 #define i_frag osd2.hurd2.h_i_frag;
498 #define i_fsize osd2.hurd2.h_i_fsize;
499 #define i_uid_high osd2.hurd2.h_i_uid_high
500 #define i_gid_high osd2.hurd2.h_i_gid_high
501 #define i_author osd2.hurd2.h_i_author
502
503 #endif /* __GNU__ */
504 #endif /* defined(__KERNEL__) || defined(__linux__) */
505
506 #define inode_uid(inode) ((inode).i_uid | (inode).osd2.linux2.l_i_uid_high << 16)
507 #define inode_gid(inode) ((inode).i_gid | (inode).osd2.linux2.l_i_gid_high << 16)
508 #define ext2fs_set_i_uid_high(inode,x) ((inode).osd2.linux2.l_i_uid_high = (x))
509 #define ext2fs_set_i_gid_high(inode,x) ((inode).osd2.linux2.l_i_gid_high = (x))
510
511 /*
512 * File system states
513 */
514 #define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
515 #define EXT2_ERROR_FS 0x0002 /* Errors detected */
516 #define EXT3_ORPHAN_FS 0x0004 /* Orphans being recovered */
517
518 /*
519 * Misc. filesystem flags
520 */
521 #define EXT2_FLAGS_SIGNED_HASH 0x0001 /* Signed dirhash in use */
522 #define EXT2_FLAGS_UNSIGNED_HASH 0x0002 /* Unsigned dirhash in use */
523 #define EXT2_FLAGS_TEST_FILESYS 0x0004 /* OK for use on development code */
524 #define EXT2_FLAGS_IS_SNAPSHOT 0x0010 /* This is a snapshot image */
525 #define EXT2_FLAGS_FIX_SNAPSHOT 0x0020 /* Snapshot inodes corrupted */
526 #define EXT2_FLAGS_FIX_EXCLUDE 0x0040 /* Exclude bitmaps corrupted */
527
528 /*
529 * Mount flags
530 */
531 #define EXT2_MOUNT_CHECK 0x0001 /* Do mount-time checks */
532 #define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
533 #define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
534 #define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
535 #define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
536 #define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
537 #define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
538 #define EXT2_MOUNT_NO_UID32 0x0200 /* Disable 32-bit UIDs */
539
540 #define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
541 #define set_opt(o, opt) o |= EXT2_MOUNT_##opt
542 #define test_opt(sb, opt) (EXT2_SB(sb)->s_mount_opt & \
543 EXT2_MOUNT_##opt)
544 /*
545 * Maximal mount counts between two filesystem checks
546 */
547 #define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
548 #define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
549
550 /*
551 * Behaviour when detecting errors
552 */
553 #define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
554 #define EXT2_ERRORS_RO 2 /* Remount fs read-only */
555 #define EXT2_ERRORS_PANIC 3 /* Panic */
556 #define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
557
558 #if (__GNUC__ >= 4)
559 #define ext4_offsetof(TYPE,MEMBER) __builtin_offsetof(TYPE,MEMBER)
560 #else
561 #define ext4_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
562 #endif
563
564 /* Metadata checksum algorithms */
565 #define EXT2_CRC32C_CHKSUM 1
566
567 /*
568 * Structure of the super block
569 */
570 struct ext2_super_block {
571 __u32 s_inodes_count; /* Inodes count */
572 __u32 s_blocks_count; /* Blocks count */
573 __u32 s_r_blocks_count; /* Reserved blocks count */
574 __u32 s_free_blocks_count; /* Free blocks count */
575 __u32 s_free_inodes_count; /* Free inodes count */
576 __u32 s_first_data_block; /* First Data Block */
577 __u32 s_log_block_size; /* Block size */
578 __u32 s_log_cluster_size; /* Allocation cluster size */
579 __u32 s_blocks_per_group; /* # Blocks per group */
580 __u32 s_clusters_per_group; /* # Fragments per group */
581 __u32 s_inodes_per_group; /* # Inodes per group */
582 __u32 s_mtime; /* Mount time */
583 __u32 s_wtime; /* Write time */
584 __u16 s_mnt_count; /* Mount count */
585 __s16 s_max_mnt_count; /* Maximal mount count */
586 __u16 s_magic; /* Magic signature */
587 __u16 s_state; /* File system state */
588 __u16 s_errors; /* Behaviour when detecting errors */
589 __u16 s_minor_rev_level; /* minor revision level */
590 __u32 s_lastcheck; /* time of last check */
591 __u32 s_checkinterval; /* max. time between checks */
592 __u32 s_creator_os; /* OS */
593 __u32 s_rev_level; /* Revision level */
594 __u16 s_def_resuid; /* Default uid for reserved blocks */
595 __u16 s_def_resgid; /* Default gid for reserved blocks */
596 /*
597 * These fields are for EXT2_DYNAMIC_REV superblocks only.
598 *
599 * Note: the difference between the compatible feature set and
600 * the incompatible feature set is that if there is a bit set
601 * in the incompatible feature set that the kernel doesn't
602 * know about, it should refuse to mount the filesystem.
603 *
604 * e2fsck's requirements are more strict; if it doesn't know
605 * about a feature in either the compatible or incompatible
606 * feature set, it must abort and not try to meddle with
607 * things it doesn't understand...
608 */
609 __u32 s_first_ino; /* First non-reserved inode */
610 __u16 s_inode_size; /* size of inode structure */
611 __u16 s_block_group_nr; /* block group # of this superblock */
612 __u32 s_feature_compat; /* compatible feature set */
613 __u32 s_feature_incompat; /* incompatible feature set */
614 __u32 s_feature_ro_compat; /* readonly-compatible feature set */
615 __u8 s_uuid[16]; /* 128-bit uuid for volume */
616 char s_volume_name[16]; /* volume name */
617 char s_last_mounted[64]; /* directory where last mounted */
618 __u32 s_algorithm_usage_bitmap; /* For compression */
619 /*
620 * Performance hints. Directory preallocation should only
621 * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
622 */
623 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
624 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
625 __u16 s_reserved_gdt_blocks; /* Per group table for online growth */
626 /*
627 * Journaling support valid if EXT2_FEATURE_COMPAT_HAS_JOURNAL set.
628 */
629 __u8 s_journal_uuid[16]; /* uuid of journal superblock */
630 __u32 s_journal_inum; /* inode number of journal file */
631 __u32 s_journal_dev; /* device number of journal file */
632 __u32 s_last_orphan; /* start of list of inodes to delete */
633 __u32 s_hash_seed[4]; /* HTREE hash seed */
634 __u8 s_def_hash_version; /* Default hash version to use */
635 __u8 s_jnl_backup_type; /* Default type of journal backup */
636 __u16 s_desc_size; /* Group desc. size: INCOMPAT_64BIT */
637 __u32 s_default_mount_opts;
638 __u32 s_first_meta_bg; /* First metablock group */
639 __u32 s_mkfs_time; /* When the filesystem was created */
640 __u32 s_jnl_blocks[17]; /* Backup of the journal inode */
641 __u32 s_blocks_count_hi; /* Blocks count high 32bits */
642 __u32 s_r_blocks_count_hi; /* Reserved blocks count high 32 bits*/
643 __u32 s_free_blocks_hi; /* Free blocks count */
644 __u16 s_min_extra_isize; /* All inodes have at least # bytes */
645 __u16 s_want_extra_isize; /* New inodes should reserve # bytes */
646 __u32 s_flags; /* Miscellaneous flags */
647 __u16 s_raid_stride; /* RAID stride */
648 __u16 s_mmp_update_interval; /* # seconds to wait in MMP checking */
649 __u64 s_mmp_block; /* Block for multi-mount protection */
650 __u32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
651 __u8 s_log_groups_per_flex; /* FLEX_BG group size */
652 __u8 s_checksum_type; /* metadata checksum algorithm */
653 __u16 s_reserved_pad; /* Padding to next 32bits */
654 __u64 s_kbytes_written; /* nr of lifetime kilobytes written */
655 __u32 s_snapshot_inum; /* Inode number of active snapshot */
656 __u32 s_snapshot_id; /* sequential ID of active snapshot */
657 __u64 s_snapshot_r_blocks_count; /* reserved blocks for active
658 snapshot's future use */
659 __u32 s_snapshot_list; /* inode number of the head of the on-disk snapshot list */
660 #define EXT4_S_ERR_START ext4_offsetof(struct ext2_super_block, s_error_count)
661 __u32 s_error_count; /* number of fs errors */
662 __u32 s_first_error_time; /* first time an error happened */
663 __u32 s_first_error_ino; /* inode involved in first error */
664 __u64 s_first_error_block; /* block involved of first error */
665 __u8 s_first_error_func[32]; /* function where the error happened */
666 __u32 s_first_error_line; /* line number where error happened */
667 __u32 s_last_error_time; /* most recent time of an error */
668 __u32 s_last_error_ino; /* inode involved in last error */
669 __u32 s_last_error_line; /* line number where error happened */
670 __u64 s_last_error_block; /* block involved of last error */
671 __u8 s_last_error_func[32]; /* function where the error happened */
672 #define EXT4_S_ERR_END ext4_offsetof(struct ext2_super_block, s_mount_opts)
673 __u8 s_mount_opts[64];
674 __u32 s_usr_quota_inum; /* inode number of user quota file */
675 __u32 s_grp_quota_inum; /* inode number of group quota file */
676 __u32 s_overhead_blocks; /* overhead blocks/clusters in fs */
677 __u32 s_backup_bgs[2]; /* If sparse_super2 enabled */
678 __u32 s_reserved[106]; /* Padding to the end of the block */
679 __u32 s_checksum; /* crc32c(superblock) */
680 };
681
682 #define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
683
684 /*
685 * Codes for operating systems
686 */
687 #define EXT2_OS_LINUX 0
688 #define EXT2_OS_HURD 1
689 #define EXT2_OBSO_OS_MASIX 2
690 #define EXT2_OS_FREEBSD 3
691 #define EXT2_OS_LITES 4
692
693 /*
694 * Revision levels
695 */
696 #define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
697 #define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
698
699 #define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
700 #define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
701
702 #define EXT2_GOOD_OLD_INODE_SIZE 128
703
704 /*
705 * Journal inode backup types
706 */
707 #define EXT3_JNL_BACKUP_BLOCKS 1
708
709 /*
710 * Feature set definitions
711 */
712
713 #define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
714 ( EXT2_SB(sb)->s_feature_compat & (mask) )
715 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
716 ( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
717 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
718 ( EXT2_SB(sb)->s_feature_incompat & (mask) )
719
720 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
721 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES 0x0002
722 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
723 #define EXT2_FEATURE_COMPAT_EXT_ATTR 0x0008
724 #define EXT2_FEATURE_COMPAT_RESIZE_INODE 0x0010
725 #define EXT2_FEATURE_COMPAT_DIR_INDEX 0x0020
726 #define EXT2_FEATURE_COMPAT_LAZY_BG 0x0040
727 /* #define EXT2_FEATURE_COMPAT_EXCLUDE_INODE 0x0080 not used, legacy */
728 #define EXT2_FEATURE_COMPAT_EXCLUDE_BITMAP 0x0100
729 #define EXT4_FEATURE_COMPAT_SPARSE_SUPER2 0x0200
730
731
732 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
733 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
734 /* #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004 not used */
735 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE 0x0008
736 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM 0x0010
737 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK 0x0020
738 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE 0x0040
739 #define EXT4_FEATURE_RO_COMPAT_HAS_SNAPSHOT 0x0080
740 #define EXT4_FEATURE_RO_COMPAT_QUOTA 0x0100
741 #define EXT4_FEATURE_RO_COMPAT_BIGALLOC 0x0200
742 /*
743 * METADATA_CSUM implies GDT_CSUM. When METADATA_CSUM is set, group
744 * descriptor checksums use the same algorithm as all other data
745 * structures' checksums.
746 */
747 #define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM 0x0400
748 #define EXT4_FEATURE_RO_COMPAT_REPLICA 0x0800
749
750 #define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
751 #define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
752 #define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
753 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
754 #define EXT2_FEATURE_INCOMPAT_META_BG 0x0010
755 #define EXT3_FEATURE_INCOMPAT_EXTENTS 0x0040
756 #define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
757 #define EXT4_FEATURE_INCOMPAT_MMP 0x0100
758 #define EXT4_FEATURE_INCOMPAT_FLEX_BG 0x0200
759 #define EXT4_FEATURE_INCOMPAT_EA_INODE 0x0400
760 #define EXT4_FEATURE_INCOMPAT_DIRDATA 0x1000
761 /* 0x2000 was EXT4_FEATURE_INCOMPAT_BG_USE_META_CSUM but this was never used */
762 #define EXT4_FEATURE_INCOMPAT_LARGEDIR 0x4000 /* >2GB or 3-lvl htree */
763 #define EXT4_FEATURE_INCOMPAT_INLINE_DATA 0x8000 /* data in inode */
764
765 #define EXT2_FEATURE_COMPAT_SUPP 0
766 #define EXT2_FEATURE_INCOMPAT_SUPP (EXT2_FEATURE_INCOMPAT_FILETYPE| \
767 EXT4_FEATURE_INCOMPAT_MMP)
768 #define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
769 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
770 EXT4_FEATURE_RO_COMPAT_DIR_NLINK| \
771 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
772
773 /*
774 * Default values for user and/or group using reserved blocks
775 */
776 #define EXT2_DEF_RESUID 0
777 #define EXT2_DEF_RESGID 0
778
779 /*
780 * Default mount options
781 */
782 #define EXT2_DEFM_DEBUG 0x0001
783 #define EXT2_DEFM_BSDGROUPS 0x0002
784 #define EXT2_DEFM_XATTR_USER 0x0004
785 #define EXT2_DEFM_ACL 0x0008
786 #define EXT2_DEFM_UID16 0x0010
787 #define EXT3_DEFM_JMODE 0x0060
788 #define EXT3_DEFM_JMODE_DATA 0x0020
789 #define EXT3_DEFM_JMODE_ORDERED 0x0040
790 #define EXT3_DEFM_JMODE_WBACK 0x0060
791 #define EXT4_DEFM_NOBARRIER 0x0100
792 #define EXT4_DEFM_BLOCK_VALIDITY 0x0200
793 #define EXT4_DEFM_DISCARD 0x0400
794 #define EXT4_DEFM_NODELALLOC 0x0800
795
796 /*
797 * Structure of a directory entry
798 */
799 #define EXT2_NAME_LEN 255
800
801 struct ext2_dir_entry {
802 __u32 inode; /* Inode number */
803 __u16 rec_len; /* Directory entry length */
804 __u16 name_len; /* Name length */
805 char name[EXT2_NAME_LEN]; /* File name */
806 };
807
808 /*
809 * The new version of the directory entry. Since EXT2 structures are
810 * stored in intel byte order, and the name_len field could never be
811 * bigger than 255 chars, it's safe to reclaim the extra byte for the
812 * file_type field.
813 *
814 * This structure is deprecated due to endianity issues. Please use struct
815 * ext2_dir_entry and accessor functions
816 * ext2fs_dirent_name_len
817 * ext2fs_dirent_set_name_len
818 * ext2fs_dirent_file_type
819 * ext2fs_dirent_set_file_type
820 * to get and set name_len and file_type fields.
821 */
822 struct ext2_dir_entry_2 {
823 __u32 inode; /* Inode number */
824 __u16 rec_len; /* Directory entry length */
825 __u8 name_len; /* Name length */
826 __u8 file_type;
827 char name[EXT2_NAME_LEN]; /* File name */
828 };
829
830 /*
831 * This is a bogus directory entry at the end of each leaf block that
832 * records checksums.
833 */
834 struct ext2_dir_entry_tail {
835 __u32 det_reserved_zero1; /* Pretend to be unused */
836 __u16 det_rec_len; /* 12 */
837 __u16 det_reserved_name_len; /* 0xDE00, fake namelen/filetype */
838 __u32 det_checksum; /* crc32c(uuid+inode+dirent) */
839 };
840
841 /*
842 * Ext2 directory file types. Only the low 3 bits are used. The
843 * other bits are reserved for now.
844 */
845 #define EXT2_FT_UNKNOWN 0
846 #define EXT2_FT_REG_FILE 1
847 #define EXT2_FT_DIR 2
848 #define EXT2_FT_CHRDEV 3
849 #define EXT2_FT_BLKDEV 4
850 #define EXT2_FT_FIFO 5
851 #define EXT2_FT_SOCK 6
852 #define EXT2_FT_SYMLINK 7
853
854 #define EXT2_FT_MAX 8
855
856 /*
857 * Annoyingly, e2fsprogs always swab16s ext2_dir_entry.name_len, so we
858 * have to build ext2_dir_entry_tail with that assumption too. This
859 * constant helps to build the dir_entry_tail to look like it has an
860 * "invalid" file type.
861 */
862 #define EXT2_DIR_NAME_LEN_CSUM 0xDE00
863
864 /*
865 * EXT2_DIR_PAD defines the directory entries boundaries
866 *
867 * NOTE: It must be a multiple of 4
868 */
869 #define EXT2_DIR_PAD 4
870 #define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
871 #define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
872 ~EXT2_DIR_ROUND)
873
874 /*
875 * This structure is used for multiple mount protection. It is written
876 * into the block number saved in the s_mmp_block field in the superblock.
877 * Programs that check MMP should assume that if SEQ_FSCK (or any unknown
878 * code above SEQ_MAX) is present then it is NOT safe to use the filesystem,
879 * regardless of how old the timestamp is.
880 *
881 * The timestamp in the MMP structure will be updated by e2fsck at some
882 * arbitary intervals (start of passes, after every few groups of inodes
883 * in pass1 and pass1b). There is no guarantee that e2fsck is updating
884 * the MMP block in a timely manner, and the updates it does are purely
885 * for the convenience of the sysadmin and not for automatic validation.
886 *
887 * Note: Only the mmp_seq value is used to determine whether the MMP block
888 * is being updated. The mmp_time, mmp_nodename, and mmp_bdevname
889 * fields are only for informational purposes for the administrator,
890 * due to clock skew between nodes and hostname HA service takeover.
891 */
892 #define EXT4_MMP_MAGIC 0x004D4D50U /* ASCII for MMP */
893 #define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
894 #define EXT4_MMP_SEQ_FSCK 0xE24D4D50U /* mmp_seq value when being fscked */
895 #define EXT4_MMP_SEQ_MAX 0xE24D4D4FU /* maximum valid mmp_seq value */
896
897 /* Not endian-annotated; it's swapped at read/write time */
898 struct mmp_struct {
899 __u32 mmp_magic; /* Magic number for MMP */
900 __u32 mmp_seq; /* Sequence no. updated periodically */
901 __u64 mmp_time; /* Time last updated */
902 char mmp_nodename[64]; /* Node which last updated MMP block */
903 char mmp_bdevname[32]; /* Bdev which last updated MMP block */
904 __u16 mmp_check_interval; /* Changed mmp_check_interval */
905 __u16 mmp_pad1;
906 __u32 mmp_pad2[226];
907 __u32 mmp_checksum; /* crc32c(uuid+mmp_block) */
908 };
909
910 /*
911 * Default interval for MMP update in seconds.
912 */
913 #define EXT4_MMP_UPDATE_INTERVAL 5
914
915 /*
916 * Maximum interval for MMP update in seconds.
917 */
918 #define EXT4_MMP_MAX_UPDATE_INTERVAL 300
919
920 /*
921 * Minimum interval for MMP checking in seconds.
922 */
923 #define EXT4_MMP_MIN_CHECK_INTERVAL 5
924
925 /*
926 * Minimum size of inline data.
927 */
928 #define EXT4_MIN_INLINE_DATA_SIZE ((sizeof(__u32) * EXT2_N_BLOCKS))
929
930 /*
931 * Size of a parent inode in inline data directory.
932 */
933 #define EXT4_INLINE_DATA_DOTDOT_SIZE (4)
934
935 #endif /* _LINUX_EXT2_FS_H */