projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ext4: Make ext4_group_t be an unsigned int
[linux-2.6-block.git] / fs / ext4 / ext4.h
CommitLineData
ac27a0ec 1/*
3dcf5451 2 * ext4.h
ac27a0ec
DK		 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
3dcf5451
CH		 16#ifndef _EXT4_H
17#define _EXT4_H
ac27a0ec
DK		 18
19#include <linux/types.h>
3a5b2ecd 20#include <linux/blkdev.h>
ac27a0ec 21#include <linux/magic.h>
3dcf5451 22#include "ext4_i.h"
c9de560d 23
ac27a0ec 24/*
8a35694e 25 * The fourth extended filesystem constants/structures
ac27a0ec
DK		 26 */
27
28/*
617ba13b 29 * Define EXT4FS_DEBUG to produce debug messages
ac27a0ec 30 */
617ba13b 31#undef EXT4FS_DEBUG
ac27a0ec
DK		 32
33/*
617ba13b 34 * Define EXT4_RESERVATION to reserve data blocks for expanding files
ac27a0ec 35 */
8c55e204 36#define EXT4_DEFAULT_RESERVE_BLOCKS 8
ac27a0ec 37/*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
8c55e204 38#define EXT4_MAX_RESERVE_BLOCKS 1027
617ba13b 39#define EXT4_RESERVE_WINDOW_NOT_ALLOCATED 0
ac27a0ec
DK		 40
41/*
42 * Debug code
43 */
617ba13b
MC		 44#ifdef EXT4FS_DEBUG
45#define ext4_debug(f, a...) \
ac27a0ec 46 do { \
af5bc92d 47 printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:", \
4db9c54a 48 __FILE__, __LINE__, __func__); \
af5bc92d 49 printk(KERN_DEBUG f, ## a); \
ac27a0ec
DK		 50 } while (0)
51#else
617ba13b 52#define ext4_debug(f, a...) do {} while (0)
ac27a0ec
DK		 53#endif
54
c9de560d
AT		 55#define EXT4_MULTIBLOCK_ALLOCATOR 1
56
57/* prefer goal again. length */
58#define EXT4_MB_HINT_MERGE 1
59/* blocks already reserved */
60#define EXT4_MB_HINT_RESERVED 2
61/* metadata is being allocated */
62#define EXT4_MB_HINT_METADATA 4
63/* first blocks in the file */
64#define EXT4_MB_HINT_FIRST 8
65/* search for the best chunk */
66#define EXT4_MB_HINT_BEST 16
67/* data is being allocated */
68#define EXT4_MB_HINT_DATA 32
69/* don't preallocate (for tails) */
70#define EXT4_MB_HINT_NOPREALLOC 64
71/* allocate for locality group */
72#define EXT4_MB_HINT_GROUP_ALLOC 128
73/* allocate goal blocks or none */
74#define EXT4_MB_HINT_GOAL_ONLY 256
75/* goal is meaningful */
76#define EXT4_MB_HINT_TRY_GOAL 512
d2a17637
MC		 77/* blocks already pre-reserved by delayed allocation */
78#define EXT4_MB_DELALLOC_RESERVED 1024
79
c9de560d
AT		 80
81struct ext4_allocation_request {
82 /* target inode for block we're allocating */
83 struct inode *inode;
84 /* logical block in target inode */
85 ext4_lblk_t logical;
86 /* phys. target (a hint) */
87 ext4_fsblk_t goal;
88 /* the closest logical allocated block to the left */
89 ext4_lblk_t lleft;
90 /* phys. block for ^^^ */
91 ext4_fsblk_t pleft;
92 /* the closest logical allocated block to the right */
93 ext4_lblk_t lright;
94 /* phys. block for ^^^ */
95 ext4_fsblk_t pright;
96 /* how many blocks we want to allocate */
97 unsigned long len;
98 /* flags. see above EXT4_MB_HINT_* */
99 unsigned long flags;
100};
101
ac27a0ec
DK		 102/*
103 * Special inodes numbers
104 */
617ba13b
MC		 105#define EXT4_BAD_INO 1 /* Bad blocks inode */
106#define EXT4_ROOT_INO 2 /* Root inode */
107#define EXT4_BOOT_LOADER_INO 5 /* Boot loader inode */
108#define EXT4_UNDEL_DIR_INO 6 /* Undelete directory inode */
109#define EXT4_RESIZE_INO 7 /* Reserved group descriptors inode */
110#define EXT4_JOURNAL_INO 8 /* Journal inode */
ac27a0ec 111
617ba13b
MC		 112/* First non-reserved inode for old ext4 filesystems */
113#define EXT4_GOOD_OLD_FIRST_INO 11
ac27a0ec
DK		 114
115/*
116 * Maximal count of links to a file
117 */
f8628a14 118#define EXT4_LINK_MAX 65000
ac27a0ec
DK		 119
120/*
121 * Macro-instructions used to manage several block sizes
122 */
617ba13b 123#define EXT4_MIN_BLOCK_SIZE 1024
afc7cbca
TS		 124#define EXT4_MAX_BLOCK_SIZE 65536
125#define EXT4_MIN_BLOCK_LOG_SIZE 10
ac27a0ec 126#ifdef __KERNEL__
617ba13b 127# define EXT4_BLOCK_SIZE(s) ((s)->s_blocksize)
ac27a0ec 128#else
617ba13b 129# define EXT4_BLOCK_SIZE(s) (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
ac27a0ec 130#endif
af5bc92d 131#define EXT4_ADDR_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / sizeof(__u32))
ac27a0ec 132#ifdef __KERNEL__
617ba13b 133# define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
ac27a0ec 134#else
617ba13b 135# define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
ac27a0ec
DK		 136#endif
137#ifdef __KERNEL__
617ba13b
MC		 138#define EXT4_ADDR_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_addr_per_block_bits)
139#define EXT4_INODE_SIZE(s) (EXT4_SB(s)->s_inode_size)
140#define EXT4_FIRST_INO(s) (EXT4_SB(s)->s_first_ino)
ac27a0ec 141#else
617ba13b
MC		 142#define EXT4_INODE_SIZE(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
143 EXT4_GOOD_OLD_INODE_SIZE : \
ac27a0ec 144 (s)->s_inode_size)
617ba13b
MC		 145#define EXT4_FIRST_INO(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
146 EXT4_GOOD_OLD_FIRST_INO : \
ac27a0ec
DK		 147 (s)->s_first_ino)
148#endif
a2df2a63 149#define EXT4_BLOCK_ALIGN(size, blkbits) ALIGN((size), (1 << (blkbits)))
ac27a0ec 150
ac27a0ec
DK		 151/*
152 * Structure of a blocks group descriptor
153 */
617ba13b 154struct ext4_group_desc
ac27a0ec 155{
3a14589c 156 __le32 bg_block_bitmap_lo; /* Blocks bitmap block */
5272f837
AK		 157 __le32 bg_inode_bitmap_lo; /* Inodes bitmap block */
158 __le32 bg_inode_table_lo; /* Inodes table block */
ac27a0ec
DK		 159 __le16 bg_free_blocks_count; /* Free blocks count */
160 __le16 bg_free_inodes_count; /* Free inodes count */
161 __le16 bg_used_dirs_count; /* Directories count */
717d50e4
AD		 162 __le16 bg_flags; /* EXT4_BG_flags (INODE_UNINIT, etc) */
163 __u32 bg_reserved[2]; /* Likely block/inode bitmap checksum */
164 __le16 bg_itable_unused; /* Unused inodes count */
165 __le16 bg_checksum; /* crc16(sb_uuid+group+desc) */
8fadc143
AR		 166 __le32 bg_block_bitmap_hi; /* Blocks bitmap block MSB */
167 __le32 bg_inode_bitmap_hi; /* Inodes bitmap block MSB */
168 __le32 bg_inode_table_hi; /* Inodes table block MSB */
91b51a01
CL		 169 __le16 bg_free_blocks_count_hi;/* Free blocks count MSB */
170 __le16 bg_free_inodes_count_hi;/* Free inodes count MSB */
171 __le16 bg_used_dirs_count_hi; /* Directories count MSB */
172 __le16 bg_itable_unused_hi; /* Unused inodes count MSB */
173 __u32 bg_reserved2[3];
ac27a0ec
DK		 174};
175
772cb7c8
JS		 176/*
177 * Structure of a flex block group info
178 */
179
180struct flex_groups {
181 __u32 free_inodes;
182 __u32 free_blocks;
183};
184
717d50e4
AD		 185#define EXT4_BG_INODE_UNINIT 0x0001 /* Inode table/bitmap not in use */
186#define EXT4_BG_BLOCK_UNINIT 0x0002 /* Block bitmap not in use */
187#define EXT4_BG_INODE_ZEROED 0x0004 /* On-disk itable initialized to zero */
188
bd81d8ee 189#ifdef __KERNEL__
3dcf5451 190#include "ext4_sb.h"
bd81d8ee 191#endif
ac27a0ec
DK		 192/*
193 * Macro-instructions used to manage group descriptors
194 */
0d1ee42f 195#define EXT4_MIN_DESC_SIZE 32
8fadc143 196#define EXT4_MIN_DESC_SIZE_64BIT 64
0d1ee42f
AR		 197#define EXT4_MAX_DESC_SIZE EXT4_MIN_BLOCK_SIZE
198#define EXT4_DESC_SIZE(s) (EXT4_SB(s)->s_desc_size)
ac27a0ec 199#ifdef __KERNEL__
617ba13b
MC		 200# define EXT4_BLOCKS_PER_GROUP(s) (EXT4_SB(s)->s_blocks_per_group)
201# define EXT4_DESC_PER_BLOCK(s) (EXT4_SB(s)->s_desc_per_block)
202# define EXT4_INODES_PER_GROUP(s) (EXT4_SB(s)->s_inodes_per_group)
203# define EXT4_DESC_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_desc_per_block_bits)
ac27a0ec 204#else
617ba13b 205# define EXT4_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
0d1ee42f 206# define EXT4_DESC_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
617ba13b 207# define EXT4_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
ac27a0ec
DK		 208#endif
209
210/*
211 * Constants relative to the data blocks
212 */
617ba13b
MC		 213#define EXT4_NDIR_BLOCKS 12
214#define EXT4_IND_BLOCK EXT4_NDIR_BLOCKS
215#define EXT4_DIND_BLOCK (EXT4_IND_BLOCK + 1)
216#define EXT4_TIND_BLOCK (EXT4_DIND_BLOCK + 1)
217#define EXT4_N_BLOCKS (EXT4_TIND_BLOCK + 1)
ac27a0ec
DK		 218
219/*
220 * Inode flags
221 */
617ba13b
MC		 222#define EXT4_SECRM_FL 0x00000001 /* Secure deletion */
223#define EXT4_UNRM_FL 0x00000002 /* Undelete */
224#define EXT4_COMPR_FL 0x00000004 /* Compress file */
225#define EXT4_SYNC_FL 0x00000008 /* Synchronous updates */
226#define EXT4_IMMUTABLE_FL 0x00000010 /* Immutable file */
227#define EXT4_APPEND_FL 0x00000020 /* writes to file may only append */
228#define EXT4_NODUMP_FL 0x00000040 /* do not dump file */
229#define EXT4_NOATIME_FL 0x00000080 /* do not update atime */
ac27a0ec 230/* Reserved for compression usage... */
617ba13b
MC		 231#define EXT4_DIRTY_FL 0x00000100
232#define EXT4_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
233#define EXT4_NOCOMPR_FL 0x00000400 /* Don't compress */
234#define EXT4_ECOMPR_FL 0x00000800 /* Compression error */
ac27a0ec 235/* End compression flags --- maybe not all used */
617ba13b
MC		 236#define EXT4_INDEX_FL 0x00001000 /* hash-indexed directory */
237#define EXT4_IMAGIC_FL 0x00002000 /* AFS directory */
238#define EXT4_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
239#define EXT4_NOTAIL_FL 0x00008000 /* file tail should not be merged */
240#define EXT4_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
241#define EXT4_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
8180a562 242#define EXT4_HUGE_FILE_FL 0x00040000 /* Set to each huge file */
a86c6181 243#define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
267e4db9 244#define EXT4_EXT_MIGRATE 0x00100000 /* Inode is migrating */
8180a562 245#define EXT4_RESERVED_FL 0x80000000 /* reserved for ext4 lib */
ac27a0ec 246
a86c6181 247#define EXT4_FL_USER_VISIBLE 0x000BDFFF /* User visible flags */
4db46fc2 248#define EXT4_FL_USER_MODIFIABLE 0x000B80FF /* User modifiable flags */
ac27a0ec
DK		 249
250/*
251 * Inode dynamic state flags
252 */
617ba13b
MC		 253#define EXT4_STATE_JDATA 0x00000001 /* journaled data exists */
254#define EXT4_STATE_NEW 0x00000002 /* inode is newly created */
255#define EXT4_STATE_XATTR 0x00000004 /* has in-inode xattrs */
6dd4ee7c 256#define EXT4_STATE_NO_EXPAND 0x00000008 /* No space for expansion */
ac27a0ec
DK		 257
258/* Used to pass group descriptor data when online resize is done */
617ba13b 259struct ext4_new_group_input {
8c55e204
DK		 260 __u32 group; /* Group number for this data */
261 __u64 block_bitmap; /* Absolute block number of block bitmap */
262 __u64 inode_bitmap; /* Absolute block number of inode bitmap */
263 __u64 inode_table; /* Absolute block number of inode table start */
264 __u32 blocks_count; /* Total number of blocks in this group */
265 __u16 reserved_blocks; /* Number of reserved blocks in this group */
ac27a0ec
DK		 266 __u16 unused;
267};
268
617ba13b
MC		 269/* The struct ext4_new_group_input in kernel space, with free_blocks_count */
270struct ext4_new_group_data {
ac27a0ec 271 __u32 group;
bd81d8ee
LV		 272 __u64 block_bitmap;
273 __u64 inode_bitmap;
274 __u64 inode_table;
ac27a0ec
DK		 275 __u32 blocks_count;
276 __u16 reserved_blocks;
277 __u16 unused;
278 __u32 free_blocks_count;
279};
280
a2df2a63
AA		 281/*
282 * Following is used by preallocation code to tell get_blocks() that we
283 * want uninitialzed extents.
284 */
285#define EXT4_CREATE_UNINITIALIZED_EXT 2
ac27a0ec
DK		 286
287/*
288 * ioctl commands
289 */
617ba13b
MC		 290#define EXT4_IOC_GETFLAGS FS_IOC_GETFLAGS
291#define EXT4_IOC_SETFLAGS FS_IOC_SETFLAGS
292#define EXT4_IOC_GETVERSION _IOR('f', 3, long)
293#define EXT4_IOC_SETVERSION _IOW('f', 4, long)
617ba13b
MC		 294#define EXT4_IOC_GETVERSION_OLD FS_IOC_GETVERSION
295#define EXT4_IOC_SETVERSION_OLD FS_IOC_SETVERSION
e23291b9 296#ifdef CONFIG_JBD2_DEBUG
617ba13b 297#define EXT4_IOC_WAIT_FOR_READONLY _IOR('f', 99, long)
ac27a0ec 298#endif
617ba13b
MC		 299#define EXT4_IOC_GETRSVSZ _IOR('f', 5, long)
300#define EXT4_IOC_SETRSVSZ _IOW('f', 6, long)
8eea80d5
TT		 301#define EXT4_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
302#define EXT4_IOC_GROUP_ADD _IOW('f', 8, struct ext4_new_group_input)
303#define EXT4_IOC_MIGRATE _IO('f', 9)
304 /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
ac27a0ec
DK		 305
306/*
307 * ioctl commands in 32 bit emulation
308 */
617ba13b
MC		 309#define EXT4_IOC32_GETFLAGS FS_IOC32_GETFLAGS
310#define EXT4_IOC32_SETFLAGS FS_IOC32_SETFLAGS
311#define EXT4_IOC32_GETVERSION _IOR('f', 3, int)
312#define EXT4_IOC32_SETVERSION _IOW('f', 4, int)
313#define EXT4_IOC32_GETRSVSZ _IOR('f', 5, int)
314#define EXT4_IOC32_SETRSVSZ _IOW('f', 6, int)
315#define EXT4_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
e23291b9 316#ifdef CONFIG_JBD2_DEBUG
617ba13b 317#define EXT4_IOC32_WAIT_FOR_READONLY _IOR('f', 99, int)
ac27a0ec 318#endif
617ba13b
MC		 319#define EXT4_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
320#define EXT4_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
ac27a0ec
DK		 321
322
323/*
324 * Mount options
325 */
617ba13b 326struct ext4_mount_options {
ac27a0ec
DK		 327 unsigned long s_mount_opt;
328 uid_t s_resuid;
329 gid_t s_resgid;
330 unsigned long s_commit_interval;
30773840 331 u32 s_min_batch_time, s_max_batch_time;
ac27a0ec
DK		 332#ifdef CONFIG_QUOTA
333 int s_jquota_fmt;
334 char *s_qf_names[MAXQUOTAS];
335#endif
336};
337
338/*
339 * Structure of an inode on the disk
340 */
617ba13b 341struct ext4_inode {
ac27a0ec
DK		 342 __le16 i_mode; /* File mode */
343 __le16 i_uid; /* Low 16 bits of Owner Uid */
a48380f7 344 __le32 i_size_lo; /* Size in bytes */
ac27a0ec 345 __le32 i_atime; /* Access time */
ef7f3835 346 __le32 i_ctime; /* Inode Change time */
ac27a0ec
DK		 347 __le32 i_mtime; /* Modification time */
348 __le32 i_dtime; /* Deletion Time */
349 __le16 i_gid; /* Low 16 bits of Group Id */
350 __le16 i_links_count; /* Links count */
0fc1b451 351 __le32 i_blocks_lo; /* Blocks count */
ac27a0ec
DK		 352 __le32 i_flags; /* File flags */
353 union {
354 struct {
25ec56b5 355 __le32 l_i_version;
ac27a0ec
DK		 356 } linux1;
357 struct {
358 __u32 h_i_translator;
359 } hurd1;
360 struct {
361 __u32 m_i_reserved1;
362 } masix1;
363 } osd1; /* OS dependent 1 */
617ba13b 364 __le32 i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
ac27a0ec 365 __le32 i_generation; /* File version (for NFS) */
7973c0c1 366 __le32 i_file_acl_lo; /* File ACL */
a48380f7 367 __le32 i_size_high;
f077d0d7 368 __le32 i_obso_faddr; /* Obsoleted fragment address */
ac27a0ec
DK		 369 union {
370 struct {
0fc1b451 371 __le16 l_i_blocks_high; /* were l_i_reserved1 */
a1ddeb7e 372 __le16 l_i_file_acl_high;
8c55e204 373 __le16 l_i_uid_high; /* these 2 fields */
ac27a0ec
DK		 374 __le16 l_i_gid_high; /* were reserved2[0] */
375 __u32 l_i_reserved2;
376 } linux2;
377 struct {
f077d0d7 378 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
ac27a0ec
DK		 379 __u16 h_i_mode_high;
380 __u16 h_i_uid_high;
381 __u16 h_i_gid_high;
382 __u32 h_i_author;
383 } hurd2;
384 struct {
f077d0d7 385 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
a1ddeb7e 386 __le16 m_i_file_acl_high;
ac27a0ec
DK		 387 __u32 m_i_reserved2[2];
388 } masix2;
389 } osd2; /* OS dependent 2 */
390 __le16 i_extra_isize;
391 __le16 i_pad1;
ef7f3835
KS		 392 __le32 i_ctime_extra; /* extra Change time (nsec << 2 | epoch) */
393 __le32 i_mtime_extra; /* extra Modification time(nsec << 2 | epoch) */
394 __le32 i_atime_extra; /* extra Access time (nsec << 2 | epoch) */
395 __le32 i_crtime; /* File Creation time */
396 __le32 i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
25ec56b5 397 __le32 i_version_hi; /* high 32 bits for 64-bit version */
ac27a0ec
DK		 398};
399
ac27a0ec 400
ef7f3835
KS		 401#define EXT4_EPOCH_BITS 2
402#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
403#define EXT4_NSEC_MASK (~0UL << EXT4_EPOCH_BITS)
404
405/*
406 * Extended fields will fit into an inode if the filesystem was formatted
407 * with large inodes (-I 256 or larger) and there are not currently any EAs
408 * consuming all of the available space. For new inodes we always reserve
409 * enough space for the kernel's known extended fields, but for inodes
410 * created with an old kernel this might not have been the case. None of
411 * the extended inode fields is critical for correct filesystem operation.
412 * This macro checks if a certain field fits in the inode. Note that
413 * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
414 */
415#define EXT4_FITS_IN_INODE(ext4_inode, einode, field) \
416 ((offsetof(typeof(*ext4_inode), field) + \
417 sizeof((ext4_inode)->field)) \
418 <= (EXT4_GOOD_OLD_INODE_SIZE + \
419 (einode)->i_extra_isize)) \
420
421static inline __le32 ext4_encode_extra_time(struct timespec *time)
422{
423 return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
424 time->tv_sec >> 32 : 0) |
425 ((time->tv_nsec << 2) & EXT4_NSEC_MASK));
426}
427
428static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
429{
430 if (sizeof(time->tv_sec) > 4)
431 time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
432 << 32;
433 time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> 2;
434}
435
436#define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode) \
437do { \
438 (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec); \
439 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) \
440 (raw_inode)->xtime ## _extra = \
441 ext4_encode_extra_time(&(inode)->xtime); \
442} while (0)
443
444#define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode) \
445do { \
446 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
447 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec); \
448 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
449 (raw_inode)->xtime ## _extra = \
450 ext4_encode_extra_time(&(einode)->xtime); \
451} while (0)
452
453#define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode) \
454do { \
455 (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime); \
456 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) \
457 ext4_decode_extra_time(&(inode)->xtime, \
458 raw_inode->xtime ## _extra); \
459} while (0)
460
461#define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode) \
462do { \
463 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
464 (einode)->xtime.tv_sec = \
465 (signed)le32_to_cpu((raw_inode)->xtime); \
466 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
467 ext4_decode_extra_time(&(einode)->xtime, \
468 raw_inode->xtime ## _extra); \
469} while (0)
470
25ec56b5
JNC		 471#define i_disk_version osd1.linux1.l_i_version
472
ac27a0ec
DK		 473#if defined(__KERNEL__) || defined(__linux__)
474#define i_reserved1 osd1.linux1.l_i_reserved1
a1ddeb7e 475#define i_file_acl_high osd2.linux2.l_i_file_acl_high
0fc1b451 476#define i_blocks_high osd2.linux2.l_i_blocks_high
ac27a0ec
DK		 477#define i_uid_low i_uid
478#define i_gid_low i_gid
479#define i_uid_high osd2.linux2.l_i_uid_high
480#define i_gid_high osd2.linux2.l_i_gid_high
481#define i_reserved2 osd2.linux2.l_i_reserved2
482
483#elif defined(__GNU__)
484
485#define i_translator osd1.hurd1.h_i_translator
ac27a0ec
DK		 486#define i_uid_high osd2.hurd2.h_i_uid_high
487#define i_gid_high osd2.hurd2.h_i_gid_high
488#define i_author osd2.hurd2.h_i_author
489
490#elif defined(__masix__)
491
492#define i_reserved1 osd1.masix1.m_i_reserved1
a1ddeb7e 493#define i_file_acl_high osd2.masix2.m_i_file_acl_high
ac27a0ec
DK		 494#define i_reserved2 osd2.masix2.m_i_reserved2
495
496#endif /* defined(__KERNEL__) || defined(__linux__) */
497
498/*
499 * File system states
500 */
617ba13b
MC		 501#define EXT4_VALID_FS 0x0001 /* Unmounted cleanly */
502#define EXT4_ERROR_FS 0x0002 /* Errors detected */
503#define EXT4_ORPHAN_FS 0x0004 /* Orphans being recovered */
ac27a0ec 504
469108ff
TT		 505/*
506 * Misc. filesystem flags
507 */
508#define EXT2_FLAGS_SIGNED_HASH 0x0001 /* Signed dirhash in use */
509#define EXT2_FLAGS_UNSIGNED_HASH 0x0002 /* Unsigned dirhash in use */
510#define EXT2_FLAGS_TEST_FILESYS 0x0004 /* to test development code */
511
ac27a0ec
DK		 512/*
513 * Mount flags
514 */
617ba13b
MC		 515#define EXT4_MOUNT_OLDALLOC 0x00002 /* Don't use the new Orlov allocator */
516#define EXT4_MOUNT_GRPID 0x00004 /* Create files with directory's group */
517#define EXT4_MOUNT_DEBUG 0x00008 /* Some debugging messages */
518#define EXT4_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
519#define EXT4_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
520#define EXT4_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
521#define EXT4_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
522#define EXT4_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
523#define EXT4_MOUNT_ABORT 0x00200 /* Fatal error detected */
524#define EXT4_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
525#define EXT4_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
526#define EXT4_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
527#define EXT4_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
528#define EXT4_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
529#define EXT4_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
530#define EXT4_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
531#define EXT4_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
532#define EXT4_MOUNT_RESERVATION 0x10000 /* Preallocation */
533#define EXT4_MOUNT_BARRIER 0x20000 /* Use block barriers */
534#define EXT4_MOUNT_NOBH 0x40000 /* No bufferheads */
535#define EXT4_MOUNT_QUOTA 0x80000 /* Some quota option set */
536#define EXT4_MOUNT_USRQUOTA 0x100000 /* "old" user quota */
537#define EXT4_MOUNT_GRPQUOTA 0x200000 /* "old" group quota */
a86c6181 538#define EXT4_MOUNT_EXTENTS 0x400000 /* Extents support */
818d276c
GS		 539#define EXT4_MOUNT_JOURNAL_CHECKSUM 0x800000 /* Journal checksums */
540#define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT 0x1000000 /* Journal Async Commit */
25ec56b5 541#define EXT4_MOUNT_I_VERSION 0x2000000 /* i_version support */
64769240 542#define EXT4_MOUNT_DELALLOC 0x8000000 /* Delalloc support */
5bf5683a
HK		 543#define EXT4_MOUNT_DATA_ERR_ABORT 0x10000000 /* Abort on file data write */
544
617ba13b 545/* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
ac27a0ec 546#ifndef _LINUX_EXT2_FS_H
617ba13b
MC		 547#define clear_opt(o, opt) o &= ~EXT4_MOUNT_##opt
548#define set_opt(o, opt) o |= EXT4_MOUNT_##opt
549#define test_opt(sb, opt) (EXT4_SB(sb)->s_mount_opt & \
550 EXT4_MOUNT_##opt)
ac27a0ec 551#else
617ba13b
MC		 552#define EXT2_MOUNT_NOLOAD EXT4_MOUNT_NOLOAD
553#define EXT2_MOUNT_ABORT EXT4_MOUNT_ABORT
554#define EXT2_MOUNT_DATA_FLAGS EXT4_MOUNT_DATA_FLAGS
ac27a0ec
DK		 555#endif
556
617ba13b
MC		 557#define ext4_set_bit ext2_set_bit
558#define ext4_set_bit_atomic ext2_set_bit_atomic
559#define ext4_clear_bit ext2_clear_bit
560#define ext4_clear_bit_atomic ext2_clear_bit_atomic
561#define ext4_test_bit ext2_test_bit
562#define ext4_find_first_zero_bit ext2_find_first_zero_bit
563#define ext4_find_next_zero_bit ext2_find_next_zero_bit
aa02ad67 564#define ext4_find_next_bit ext2_find_next_bit
ac27a0ec
DK		 565
566/*
567 * Maximal mount counts between two filesystem checks
568 */
617ba13b
MC		 569#define EXT4_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
570#define EXT4_DFL_CHECKINTERVAL 0 /* Don't use interval check */
ac27a0ec
DK		 571
572/*
573 * Behaviour when detecting errors
574 */
617ba13b
MC		 575#define EXT4_ERRORS_CONTINUE 1 /* Continue execution */
576#define EXT4_ERRORS_RO 2 /* Remount fs read-only */
577#define EXT4_ERRORS_PANIC 3 /* Panic */
578#define EXT4_ERRORS_DEFAULT EXT4_ERRORS_CONTINUE
ac27a0ec
DK		 579
580/*
581 * Structure of the super block
582 */
617ba13b 583struct ext4_super_block {
ac27a0ec 584/*00*/ __le32 s_inodes_count; /* Inodes count */
6bc9feff 585 __le32 s_blocks_count_lo; /* Blocks count */
308ba3ec
AK		 586 __le32 s_r_blocks_count_lo; /* Reserved blocks count */
587 __le32 s_free_blocks_count_lo; /* Free blocks count */
ac27a0ec
DK		 588/*10*/ __le32 s_free_inodes_count; /* Free inodes count */
589 __le32 s_first_data_block; /* First Data Block */
590 __le32 s_log_block_size; /* Block size */
f077d0d7 591 __le32 s_obso_log_frag_size; /* Obsoleted fragment size */
ac27a0ec 592/*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
f077d0d7 593 __le32 s_obso_frags_per_group; /* Obsoleted fragments per group */
ac27a0ec
DK		 594 __le32 s_inodes_per_group; /* # Inodes per group */
595 __le32 s_mtime; /* Mount time */
596/*30*/ __le32 s_wtime; /* Write time */
597 __le16 s_mnt_count; /* Mount count */
598 __le16 s_max_mnt_count; /* Maximal mount count */
599 __le16 s_magic; /* Magic signature */
600 __le16 s_state; /* File system state */
601 __le16 s_errors; /* Behaviour when detecting errors */
602 __le16 s_minor_rev_level; /* minor revision level */
603/*40*/ __le32 s_lastcheck; /* time of last check */
604 __le32 s_checkinterval; /* max. time between checks */
605 __le32 s_creator_os; /* OS */
606 __le32 s_rev_level; /* Revision level */
607/*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
608 __le16 s_def_resgid; /* Default gid for reserved blocks */
609 /*
617ba13b 610 * These fields are for EXT4_DYNAMIC_REV superblocks only.
ac27a0ec
DK		 611 *
612 * Note: the difference between the compatible feature set and
613 * the incompatible feature set is that if there is a bit set
614 * in the incompatible feature set that the kernel doesn't
615 * know about, it should refuse to mount the filesystem.
616 *
617 * e2fsck's requirements are more strict; if it doesn't know
618 * about a feature in either the compatible or incompatible
619 * feature set, it must abort and not try to meddle with
620 * things it doesn't understand...
621 */
622 __le32 s_first_ino; /* First non-reserved inode */
0d1ee42f 623 __le16 s_inode_size; /* size of inode structure */
ac27a0ec
DK		 624 __le16 s_block_group_nr; /* block group # of this superblock */
625 __le32 s_feature_compat; /* compatible feature set */
626/*60*/ __le32 s_feature_incompat; /* incompatible feature set */
627 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
628/*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
629/*78*/ char s_volume_name[16]; /* volume name */
630/*88*/ char s_last_mounted[64]; /* directory where last mounted */
631/*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
632 /*
633 * Performance hints. Directory preallocation should only
617ba13b 634 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
ac27a0ec
DK		 635 */
636 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
637 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
638 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
639 /*
617ba13b 640 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
ac27a0ec
DK		 641 */
642/*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
643/*E0*/ __le32 s_journal_inum; /* inode number of journal file */
644 __le32 s_journal_dev; /* device number of journal file */
645 __le32 s_last_orphan; /* start of list of inodes to delete */
646 __le32 s_hash_seed[4]; /* HTREE hash seed */
647 __u8 s_def_hash_version; /* Default hash version to use */
648 __u8 s_reserved_char_pad;
0d1ee42f 649 __le16 s_desc_size; /* size of group descriptor */
bd81d8ee 650/*100*/ __le32 s_default_mount_opts;
ac27a0ec 651 __le32 s_first_meta_bg; /* First metablock block group */
bd81d8ee
LV		 652 __le32 s_mkfs_time; /* When the filesystem was created */
653 __le32 s_jnl_blocks[17]; /* Backup of the journal inode */
654 /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
655/*150*/ __le32 s_blocks_count_hi; /* Blocks count */
656 __le32 s_r_blocks_count_hi; /* Reserved blocks count */
657 __le32 s_free_blocks_count_hi; /* Free blocks count */
c1bddad9
AK		 658 __le16 s_min_extra_isize; /* All inodes have at least # bytes */
659 __le16 s_want_extra_isize; /* New inodes should reserve # bytes */
660 __le32 s_flags; /* Miscellaneous flags */
661 __le16 s_raid_stride; /* RAID stride */
662 __le16 s_mmp_interval; /* # seconds to wait in MMP checking */
663 __le64 s_mmp_block; /* Block for multi-mount protection */
664 __le32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
772cb7c8
JS		 665 __u8 s_log_groups_per_flex; /* FLEX_BG group size */
666 __u8 s_reserved_char_pad2;
667 __le16 s_reserved_pad;
668 __u32 s_reserved[162]; /* Padding to the end of the block */
ac27a0ec
DK		 669};
670
671#ifdef __KERNEL__
af5bc92d 672static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
ac27a0ec
DK		 673{
674 return sb->s_fs_info;
675}
617ba13b 676static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
ac27a0ec 677{
617ba13b 678 return container_of(inode, struct ext4_inode_info, vfs_inode);
ac27a0ec
DK		 679}
680
ef7f3835
KS		 681static inline struct timespec ext4_current_time(struct inode *inode)
682{
683 return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
684 current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
685}
686
687
617ba13b 688static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
ac27a0ec 689{
617ba13b
MC		 690 return ino == EXT4_ROOT_INO ||
691 ino == EXT4_JOURNAL_INO ||
692 ino == EXT4_RESIZE_INO ||
693 (ino >= EXT4_FIRST_INO(sb) &&
694 ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
ac27a0ec
DK		 695}
696#else
617ba13b 697/* Assume that user mode programs are passing in an ext4fs superblock, not
ac27a0ec
DK		 698 * a kernel struct super_block. This will allow us to call the feature-test
699 * macros from user land. */
617ba13b 700#define EXT4_SB(sb) (sb)
ac27a0ec
DK		 701#endif
702
617ba13b 703#define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
ac27a0ec
DK		 704
705/*
706 * Codes for operating systems
707 */
617ba13b
MC		 708#define EXT4_OS_LINUX 0
709#define EXT4_OS_HURD 1
710#define EXT4_OS_MASIX 2
711#define EXT4_OS_FREEBSD 3
712#define EXT4_OS_LITES 4
ac27a0ec
DK		 713
714/*
715 * Revision levels
716 */
617ba13b
MC		 717#define EXT4_GOOD_OLD_REV 0 /* The good old (original) format */
718#define EXT4_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
ac27a0ec 719
617ba13b
MC		 720#define EXT4_CURRENT_REV EXT4_GOOD_OLD_REV
721#define EXT4_MAX_SUPP_REV EXT4_DYNAMIC_REV
ac27a0ec 722
617ba13b 723#define EXT4_GOOD_OLD_INODE_SIZE 128
ac27a0ec
DK		 724
725/*
726 * Feature set definitions
727 */
728
617ba13b 729#define EXT4_HAS_COMPAT_FEATURE(sb,mask) \
af5bc92d 730 (EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask))
617ba13b 731#define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask) \
af5bc92d 732 (EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask))
617ba13b 733#define EXT4_HAS_INCOMPAT_FEATURE(sb,mask) \
af5bc92d 734 (EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask))
617ba13b
MC		 735#define EXT4_SET_COMPAT_FEATURE(sb,mask) \
736 EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
737#define EXT4_SET_RO_COMPAT_FEATURE(sb,mask) \
738 EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
739#define EXT4_SET_INCOMPAT_FEATURE(sb,mask) \
740 EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
741#define EXT4_CLEAR_COMPAT_FEATURE(sb,mask) \
742 EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
743#define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
744 EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
745#define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask) \
746 EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
747
748#define EXT4_FEATURE_COMPAT_DIR_PREALLOC 0x0001
749#define EXT4_FEATURE_COMPAT_IMAGIC_INODES 0x0002
750#define EXT4_FEATURE_COMPAT_HAS_JOURNAL 0x0004
751#define EXT4_FEATURE_COMPAT_EXT_ATTR 0x0008
752#define EXT4_FEATURE_COMPAT_RESIZE_INODE 0x0010
753#define EXT4_FEATURE_COMPAT_DIR_INDEX 0x0020
754
755#define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
756#define EXT4_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
757#define EXT4_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
0fc1b451 758#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE 0x0008
717d50e4 759#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM 0x0010
f8628a14 760#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK 0x0020
ef7f3835 761#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE 0x0040
617ba13b
MC		 762
763#define EXT4_FEATURE_INCOMPAT_COMPRESSION 0x0001
764#define EXT4_FEATURE_INCOMPAT_FILETYPE 0x0002
765#define EXT4_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
766#define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
767#define EXT4_FEATURE_INCOMPAT_META_BG 0x0010
a86c6181 768#define EXT4_FEATURE_INCOMPAT_EXTENTS 0x0040 /* extents support */
bd81d8ee 769#define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
0fc1b451 770#define EXT4_FEATURE_INCOMPAT_MMP 0x0100
ce421581 771#define EXT4_FEATURE_INCOMPAT_FLEX_BG 0x0200
617ba13b
MC		 772
773#define EXT4_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
774#define EXT4_FEATURE_INCOMPAT_SUPP (EXT4_FEATURE_INCOMPAT_FILETYPE| \
775 EXT4_FEATURE_INCOMPAT_RECOVER| \
a86c6181 776 EXT4_FEATURE_INCOMPAT_META_BG| \
bd81d8ee 777 EXT4_FEATURE_INCOMPAT_EXTENTS| \
ce421581
JS		 778 EXT4_FEATURE_INCOMPAT_64BIT| \
779 EXT4_FEATURE_INCOMPAT_FLEX_BG)
617ba13b
MC		 780#define EXT4_FEATURE_RO_COMPAT_SUPP (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
781 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
717d50e4 782 EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
f8628a14 783 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
ef7f3835 784 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
0fc1b451
AK		 785 EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
786 EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
ac27a0ec
DK		 787
788/*
789 * Default values for user and/or group using reserved blocks
790 */
617ba13b
MC		 791#define EXT4_DEF_RESUID 0
792#define EXT4_DEF_RESGID 0
ac27a0ec 793
240799cd
TT		 794#define EXT4_DEF_INODE_READAHEAD_BLKS 32
795
ac27a0ec
DK		 796/*
797 * Default mount options
798 */
617ba13b
MC		 799#define EXT4_DEFM_DEBUG 0x0001
800#define EXT4_DEFM_BSDGROUPS 0x0002
801#define EXT4_DEFM_XATTR_USER 0x0004
802#define EXT4_DEFM_ACL 0x0008
803#define EXT4_DEFM_UID16 0x0010
804#define EXT4_DEFM_JMODE 0x0060
805#define EXT4_DEFM_JMODE_DATA 0x0020
806#define EXT4_DEFM_JMODE_ORDERED 0x0040
807#define EXT4_DEFM_JMODE_WBACK 0x0060
ac27a0ec 808
30773840
TT		 809/*
810 * Default journal batch times
811 */
812#define EXT4_DEF_MIN_BATCH_TIME 0
813#define EXT4_DEF_MAX_BATCH_TIME 15000 /* 15ms */
814
ac27a0ec
DK		 815/*
816 * Structure of a directory entry
817 */
617ba13b 818#define EXT4_NAME_LEN 255
ac27a0ec 819
617ba13b 820struct ext4_dir_entry {
ac27a0ec
DK		 821 __le32 inode; /* Inode number */
822 __le16 rec_len; /* Directory entry length */
823 __le16 name_len; /* Name length */
617ba13b 824 char name[EXT4_NAME_LEN]; /* File name */
ac27a0ec
DK		 825};
826
827/*
617ba13b 828 * The new version of the directory entry. Since EXT4 structures are
ac27a0ec
DK		 829 * stored in intel byte order, and the name_len field could never be
830 * bigger than 255 chars, it's safe to reclaim the extra byte for the
831 * file_type field.
832 */
617ba13b 833struct ext4_dir_entry_2 {
ac27a0ec
DK		 834 __le32 inode; /* Inode number */
835 __le16 rec_len; /* Directory entry length */
836 __u8 name_len; /* Name length */
837 __u8 file_type;
617ba13b 838 char name[EXT4_NAME_LEN]; /* File name */
ac27a0ec
DK		 839};
840
841/*
617ba13b 842 * Ext4 directory file types. Only the low 3 bits are used. The
ac27a0ec
DK		 843 * other bits are reserved for now.
844 */
617ba13b
MC		 845#define EXT4_FT_UNKNOWN 0
846#define EXT4_FT_REG_FILE 1
847#define EXT4_FT_DIR 2
848#define EXT4_FT_CHRDEV 3
849#define EXT4_FT_BLKDEV 4
850#define EXT4_FT_FIFO 5
851#define EXT4_FT_SOCK 6
852#define EXT4_FT_SYMLINK 7
ac27a0ec 853
617ba13b 854#define EXT4_FT_MAX 8
ac27a0ec
DK		 855
856/*
617ba13b 857 * EXT4_DIR_PAD defines the directory entries boundaries
ac27a0ec
DK		 858 *
859 * NOTE: It must be a multiple of 4
860 */
617ba13b
MC		 861#define EXT4_DIR_PAD 4
862#define EXT4_DIR_ROUND (EXT4_DIR_PAD - 1)
863#define EXT4_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT4_DIR_ROUND) & \
864 ~EXT4_DIR_ROUND)
a72d7f83
JK		 865#define EXT4_MAX_REC_LEN ((1<<16)-1)
866
867static inline unsigned ext4_rec_len_from_disk(__le16 dlen)
868{
869 unsigned len = le16_to_cpu(dlen);
870
871 if (len == EXT4_MAX_REC_LEN)
872 return 1 << 16;
873 return len;
874}
875
876static inline __le16 ext4_rec_len_to_disk(unsigned len)
877{
878 if (len == (1 << 16))
879 return cpu_to_le16(EXT4_MAX_REC_LEN);
880 else if (len > (1 << 16))
881 BUG();
882 return cpu_to_le16(len);
883}
884
ac27a0ec
DK		 885/*
886 * Hash Tree Directory indexing
887 * (c) Daniel Phillips, 2001
888 */
889
4074fe37
ES		 890#define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
891 EXT4_FEATURE_COMPAT_DIR_INDEX) && \
617ba13b
MC		 892 (EXT4_I(dir)->i_flags & EXT4_INDEX_FL))
893#define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
894#define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
ac27a0ec
DK		 895
896/* Legal values for the dx_root hash_version field: */
897
898#define DX_HASH_LEGACY 0
899#define DX_HASH_HALF_MD4 1
900#define DX_HASH_TEA 2
f99b2589
TT		 901#define DX_HASH_LEGACY_UNSIGNED 3
902#define DX_HASH_HALF_MD4_UNSIGNED 4
903#define DX_HASH_TEA_UNSIGNED 5
ac27a0ec
DK		 904
905#ifdef __KERNEL__
906
907/* hash info structure used by the directory hash */
908struct dx_hash_info
909{
910 u32 hash;
911 u32 minor_hash;
912 int hash_version;
913 u32 *seed;
914};
915
617ba13b 916#define EXT4_HTREE_EOF 0x7fffffff
ac27a0ec
DK		 917
918/*
617ba13b 919 * Control parameters used by ext4_htree_next_block
ac27a0ec
DK		 920 */
921#define HASH_NB_ALWAYS 1
922
923
924/*
925 * Describe an inode's exact location on disk and in memory
926 */
617ba13b 927struct ext4_iloc
ac27a0ec
DK		 928{
929 struct buffer_head *bh;
930 unsigned long offset;
fd2d4291 931 ext4_group_t block_group;
ac27a0ec
DK		 932};
933
617ba13b 934static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
ac27a0ec 935{
617ba13b 936 return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
ac27a0ec
DK		 937}
938
939/*
940 * This structure is stuffed into the struct file's private_data field
941 * for directories. It is where we put information so that we can do
942 * readdir operations in hash tree order.
943 */
944struct dir_private_info {
945 struct rb_root root;
946 struct rb_node *curr_node;
947 struct fname *extra_fname;
948 loff_t last_pos;
949 __u32 curr_hash;
950 __u32 curr_minor_hash;
951 __u32 next_hash;
952};
953
954/* calculate the first block number of the group */
617ba13b 955static inline ext4_fsblk_t
fd2d4291 956ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
ac27a0ec 957{
617ba13b
MC		 958 return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
959 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
ac27a0ec
DK		 960}
961
962/*
963 * Special error return code only used by dx_probe() and its callers.
964 */
965#define ERR_BAD_DX_DIR -75000
966
72b64b59 967void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
a9df9a49 968 ext4_group_t *blockgrpp, ext4_grpblk_t *offsetp);
3a5b2ecd 969
9f6200bb
TT		 970extern struct proc_dir_entry *ext4_proc_root;
971
5e8814f2
TT		 972#ifdef CONFIG_PROC_FS
973extern const struct file_operations ext4_ui_proc_fops;
974
975#define EXT4_PROC_HANDLER(name, var) \
976do { \
977 proc = proc_create_data(name, mode, sbi->s_proc, \
978 &ext4_ui_proc_fops, &sbi->s_##var); \
979 if (proc == NULL) { \
980 printk(KERN_ERR "EXT4-fs: can't create %s\n", name); \
981 goto err_out; \
982 } \
983} while (0)
984#else
985#define EXT4_PROC_HANDLER(name, var)
986#endif
987
ac27a0ec
DK		 988/*
989 * Function prototypes
990 */
991
992/*
993 * Ok, these declarations are also in <linux/kernel.h> but none of the
617ba13b 994 * ext4 source programs needs to include it so they are duplicated here.
ac27a0ec 995 */
8c55e204
DK		 996# define NORET_TYPE /**/
997# define ATTRIB_NORET __attribute__((noreturn))
998# define NORET_AND noreturn,
ac27a0ec
DK		 999
1000/* balloc.c */
3a5b2ecd
MC		 1001extern unsigned int ext4_block_group(struct super_block *sb,
1002 ext4_fsblk_t blocknr);
1003extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
1004 ext4_fsblk_t blocknr);
fd2d4291
AM		 1005extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
1006extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
1007 ext4_group_t group);
7061eba7 1008extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
617ba13b 1009 ext4_fsblk_t goal, unsigned long *count, int *errp);
5c791616 1010extern int ext4_claim_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
8c3bf8a0 1011extern int ext4_has_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
af5bc92d 1012extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
c9de560d 1013 ext4_fsblk_t block, unsigned long count, int metadata);
af5bc92d
TT		 1014extern void ext4_free_blocks_sb(handle_t *handle, struct super_block *sb,
1015 ext4_fsblk_t block, unsigned long count,
ac27a0ec 1016 unsigned long *pdquot_freed_blocks);
af5bc92d
TT		 1017extern ext4_fsblk_t ext4_count_free_blocks(struct super_block *);
1018extern void ext4_check_blocks_bitmap(struct super_block *);
617ba13b 1019extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
fd2d4291 1020 ext4_group_t block_group,
ac27a0ec 1021 struct buffer_head ** bh);
617ba13b 1022extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
ac27a0ec
DK		 1023
1024/* dir.c */
617ba13b
MC		 1025extern int ext4_check_dir_entry(const char *, struct inode *,
1026 struct ext4_dir_entry_2 *,
ac27a0ec 1027 struct buffer_head *, unsigned long);
617ba13b 1028extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
ac27a0ec 1029 __u32 minor_hash,
617ba13b
MC		 1030 struct ext4_dir_entry_2 *dirent);
1031extern void ext4_htree_free_dir_info(struct dir_private_info *p);
ac27a0ec
DK		 1032
1033/* fsync.c */
af5bc92d 1034extern int ext4_sync_file(struct file *, struct dentry *, int);
ac27a0ec
DK		 1035
1036/* hash.c */
617ba13b 1037extern int ext4fs_dirhash(const char *name, int len, struct
ac27a0ec
DK		 1038 dx_hash_info *hinfo);
1039
1040/* ialloc.c */
af5bc92d
TT		 1041extern struct inode * ext4_new_inode(handle_t *, struct inode *, int);
1042extern void ext4_free_inode(handle_t *, struct inode *);
1043extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
1044extern unsigned long ext4_count_free_inodes(struct super_block *);
1045extern unsigned long ext4_count_dirs(struct super_block *);
1046extern void ext4_check_inodes_bitmap(struct super_block *);
1047extern unsigned long ext4_count_free(struct buffer_head *, unsigned);
ac27a0ec 1048
c9de560d
AT		 1049/* mballoc.c */
1050extern long ext4_mb_stats;
1051extern long ext4_mb_max_to_scan;
1052extern int ext4_mb_init(struct super_block *, int);
1053extern int ext4_mb_release(struct super_block *);
1054extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
1055 struct ext4_allocation_request *, int *);
1056extern int ext4_mb_reserve_blocks(struct super_block *, int);
c2ea3fde 1057extern void ext4_discard_preallocations(struct inode *);
c9de560d
AT		 1058extern int __init init_ext4_mballoc(void);
1059extern void exit_ext4_mballoc(void);
1060extern void ext4_mb_free_blocks(handle_t *, struct inode *,
1061 unsigned long, unsigned long, int, unsigned long *);
5f21b0e6
FB		 1062extern int ext4_mb_add_more_groupinfo(struct super_block *sb,
1063 ext4_group_t i, struct ext4_group_desc *desc);
1064extern void ext4_mb_update_group_info(struct ext4_group_info *grp,
1065 ext4_grpblk_t add);
c9de560d 1066
ac27a0ec
DK		 1067
1068/* inode.c */
617ba13b
MC		 1069int ext4_forget(handle_t *handle, int is_metadata, struct inode *inode,
1070 struct buffer_head *bh, ext4_fsblk_t blocknr);
725d26d3
AK		 1071struct buffer_head *ext4_getblk(handle_t *, struct inode *,
1072 ext4_lblk_t, int, int *);
1073struct buffer_head *ext4_bread(handle_t *, struct inode *,
1074 ext4_lblk_t, int, int *);
6873fa0d
ES		 1075int ext4_get_block(struct inode *inode, sector_t iblock,
1076 struct buffer_head *bh_result, int create);
617ba13b 1077int ext4_get_blocks_handle(handle_t *handle, struct inode *inode,
725d26d3
AK		 1078 ext4_lblk_t iblock, unsigned long maxblocks,
1079 struct buffer_head *bh_result,
1080 int create, int extend_disksize);
ac27a0ec 1081
1d1fe1ee 1082extern struct inode *ext4_iget(struct super_block *, unsigned long);
af5bc92d
TT		 1083extern int ext4_write_inode(struct inode *, int);
1084extern int ext4_setattr(struct dentry *, struct iattr *);
3e3398a0
MC		 1085extern int ext4_getattr(struct vfsmount *mnt, struct dentry *dentry,
1086 struct kstat *stat);
af5bc92d
TT		 1087extern void ext4_delete_inode(struct inode *);
1088extern int ext4_sync_inode(handle_t *, struct inode *);
617ba13b
MC		 1089extern void ext4_dirty_inode(struct inode *);
1090extern int ext4_change_inode_journal_flag(struct inode *, int);
1091extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
91ef4caf 1092extern int ext4_can_truncate(struct inode *inode);
af5bc92d 1093extern void ext4_truncate(struct inode *);
617ba13b 1094extern void ext4_set_inode_flags(struct inode *);
ff9ddf7e 1095extern void ext4_get_inode_flags(struct ext4_inode_info *);
617ba13b 1096extern void ext4_set_aops(struct inode *inode);
a86c6181 1097extern int ext4_writepage_trans_blocks(struct inode *);
a02908f1 1098extern int ext4_meta_trans_blocks(struct inode *, int nrblocks, int idxblocks);
f3bd1f3f 1099extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
cf108bca 1100extern int ext4_block_truncate_page(handle_t *handle,
a86c6181 1101 struct address_space *mapping, loff_t from);
2e9ee850 1102extern int ext4_page_mkwrite(struct vm_area_struct *vma, struct page *page);
ac27a0ec
DK		 1103
1104/* ioctl.c */
5cdd7b2d 1105extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
af5bc92d 1106extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
ac27a0ec 1107
c14c6fd5 1108/* migrate.c */
2a43a878 1109extern int ext4_ext_migrate(struct inode *);
ac27a0ec 1110/* namei.c */
617ba13b
MC		 1111extern int ext4_orphan_add(handle_t *, struct inode *);
1112extern int ext4_orphan_del(handle_t *, struct inode *);
1113extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
ac27a0ec
DK		 1114 __u32 start_minor_hash, __u32 *next_hash);
1115
1116/* resize.c */
617ba13b
MC		 1117extern int ext4_group_add(struct super_block *sb,
1118 struct ext4_new_group_data *input);
1119extern int ext4_group_extend(struct super_block *sb,
1120 struct ext4_super_block *es,
1121 ext4_fsblk_t n_blocks_count);
ac27a0ec
DK		 1122
1123/* super.c */
af5bc92d 1124extern void ext4_error(struct super_block *, const char *, const char *, ...)
ac27a0ec 1125 __attribute__ ((format (printf, 3, 4)));
af5bc92d
TT		 1126extern void __ext4_std_error(struct super_block *, const char *, int);
1127extern void ext4_abort(struct super_block *, const char *, const char *, ...)
ac27a0ec 1128 __attribute__ ((format (printf, 3, 4)));
af5bc92d 1129extern void ext4_warning(struct super_block *, const char *, const char *, ...)
ac27a0ec 1130 __attribute__ ((format (printf, 3, 4)));
af5bc92d 1131extern void ext4_update_dynamic_rev(struct super_block *sb);
99e6f829
AK		 1132extern int ext4_update_compat_feature(handle_t *handle, struct super_block *sb,
1133 __u32 compat);
1134extern int ext4_update_rocompat_feature(handle_t *handle,
1135 struct super_block *sb, __u32 rocompat);
1136extern int ext4_update_incompat_feature(handle_t *handle,
1137 struct super_block *sb, __u32 incompat);
8fadc143
AR		 1138extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
1139 struct ext4_group_desc *bg);
1140extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
1141 struct ext4_group_desc *bg);
1142extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
1143 struct ext4_group_desc *bg);
1144extern void ext4_block_bitmap_set(struct super_block *sb,
1145 struct ext4_group_desc *bg, ext4_fsblk_t blk);
1146extern void ext4_inode_bitmap_set(struct super_block *sb,
1147 struct ext4_group_desc *bg, ext4_fsblk_t blk);
1148extern void ext4_inode_table_set(struct super_block *sb,
1149 struct ext4_group_desc *bg, ext4_fsblk_t blk);
bd81d8ee
LV		 1150
1151static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
1152{
1153 return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
6bc9feff 1154 le32_to_cpu(es->s_blocks_count_lo);
bd81d8ee
LV		 1155}
1156
1157static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
1158{
1159 return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
308ba3ec 1160 le32_to_cpu(es->s_r_blocks_count_lo);
bd81d8ee
LV		 1161}
1162
1163static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
1164{
1165 return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
308ba3ec 1166 le32_to_cpu(es->s_free_blocks_count_lo);
bd81d8ee
LV		 1167}
1168
1169static inline void ext4_blocks_count_set(struct ext4_super_block *es,
1170 ext4_fsblk_t blk)
1171{
6bc9feff 1172 es->s_blocks_count_lo = cpu_to_le32((u32)blk);
bd81d8ee
LV		 1173 es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
1174}
1175
1176static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
1177 ext4_fsblk_t blk)
1178{
308ba3ec 1179 es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
bd81d8ee
LV		 1180 es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
1181}
1182
1183static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
1184 ext4_fsblk_t blk)
1185{
308ba3ec 1186 es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
bd81d8ee
LV		 1187 es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
1188}
1189
a48380f7
AK		 1190static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
1191{
1192 return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
1193 le32_to_cpu(raw_inode->i_size_lo);
1194}
bd81d8ee 1195
a48380f7
AK		 1196static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
1197{
1198 raw_inode->i_size_lo = cpu_to_le32(i_size);
1199 raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
1200}
ac27a0ec 1201
c9de560d
AT		 1202static inline
1203struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
af5bc92d 1204 ext4_group_t group)
c9de560d
AT		 1205{
1206 struct ext4_group_info ***grp_info;
1207 long indexv, indexh;
1208 grp_info = EXT4_SB(sb)->s_group_info;
1209 indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
1210 indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
1211 return grp_info[indexv][indexh];
1212}
1213
1214
772cb7c8
JS		 1215static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
1216 ext4_group_t block_group)
1217{
1218 return block_group >> sbi->s_log_groups_per_flex;
1219}
1220
1221static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
1222{
1223 return 1 << sbi->s_log_groups_per_flex;
1224}
1225
617ba13b 1226#define ext4_std_error(sb, errno) \
ac27a0ec
DK		 1227do { \
1228 if ((errno)) \
4db9c54a 1229 __ext4_std_error((sb), __func__, (errno)); \
ac27a0ec
DK		 1230} while (0)
1231
a30d542a
AK		 1232#ifdef CONFIG_SMP
1233/* Each CPU can accumulate FBC_BATCH blocks in their local
1234 * counters. So we need to make sure we have free blocks more
1235 * than FBC_BATCH * nr_cpu_ids. Also add a window of 4 times.
1236 */
1237#define EXT4_FREEBLOCKS_WATERMARK (4 * (FBC_BATCH * nr_cpu_ids))
1238#else
1239#define EXT4_FREEBLOCKS_WATERMARK 0
1240#endif
1241
cf17fea6
AK		 1242static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
1243{
1244 /*
1245 * XXX: replace with spinlock if seen contended -bzzz
1246 */
1247 down_write(&EXT4_I(inode)->i_data_sem);
1248 if (newsize > EXT4_I(inode)->i_disksize)
1249 EXT4_I(inode)->i_disksize = newsize;
1250 up_write(&EXT4_I(inode)->i_data_sem);
1251 return ;
1252}
a30d542a 1253
ac27a0ec
DK		 1254/*
1255 * Inodes and files operations
1256 */
1257
1258/* dir.c */
617ba13b 1259extern const struct file_operations ext4_dir_operations;
ac27a0ec
DK		 1260
1261/* file.c */
c5ef1c42 1262extern const struct inode_operations ext4_file_inode_operations;
617ba13b 1263extern const struct file_operations ext4_file_operations;
ac27a0ec
DK		 1264
1265/* namei.c */
c5ef1c42
AV		 1266extern const struct inode_operations ext4_dir_inode_operations;
1267extern const struct inode_operations ext4_special_inode_operations;
ac27a0ec
DK		 1268
1269/* symlink.c */
c5ef1c42
AV		 1270extern const struct inode_operations ext4_symlink_inode_operations;
1271extern const struct inode_operations ext4_fast_symlink_inode_operations;
ac27a0ec 1272
a86c6181
AT		 1273/* extents.c */
1274extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
1275extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
a02908f1
MC		 1276extern int ext4_ext_index_trans_blocks(struct inode *inode, int nrblocks,
1277 int chunk);
a86c6181 1278extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
725d26d3 1279 ext4_lblk_t iblock,
a86c6181
AT		 1280 unsigned long max_blocks, struct buffer_head *bh_result,
1281 int create, int extend_disksize);
cf108bca 1282extern void ext4_ext_truncate(struct inode *);
a86c6181
AT		 1283extern void ext4_ext_init(struct super_block *);
1284extern void ext4_ext_release(struct super_block *);
a2df2a63
AA		 1285extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
1286 loff_t len);
0e855ac8
AK		 1287extern int ext4_get_blocks_wrap(handle_t *handle, struct inode *inode,
1288 sector_t block, unsigned long max_blocks,
1289 struct buffer_head *bh, int create,
d2a17637 1290 int extend_disksize, int flag);
ac27a0ec
DK		 1291#endif /* __KERNEL__ */
1292
3dcf5451 1293#endif /* _EXT4_H */
Linux 6.x block layer and io_uring tree(s)