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