blob: 71a3cdceaa030f91e2d28e3dc9deac96b817d529 [file] [log] [blame]
Theodore Ts'of5166762017-12-17 22:00:59 -05001// SPDX-License-Identifier: GPL-2.0
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002/*
Christoph Hellwig3dcf5452008-04-29 18:13:32 -04003 * ext4.h
Dave Kleikampac27a0e2006-10-11 01:20:50 -07004 *
5 * Copyright (C) 1992, 1993, 1994, 1995
6 * Remy Card (card@masi.ibp.fr)
7 * Laboratoire MASI - Institut Blaise Pascal
8 * Universite Pierre et Marie Curie (Paris VI)
9 *
10 * from
11 *
12 * linux/include/linux/minix_fs.h
13 *
14 * Copyright (C) 1991, 1992 Linus Torvalds
15 */
16
Christoph Hellwig3dcf5452008-04-29 18:13:32 -040017#ifndef _EXT4_H
18#define _EXT4_H
Dave Kleikampac27a0e2006-10-11 01:20:50 -070019
Xiyu Yang31d21d22021-07-19 13:59:14 +080020#include <linux/refcount.h>
Dave Kleikampac27a0e2006-10-11 01:20:50 -070021#include <linux/types.h>
Mingming Cao3a5b2ec2006-10-11 01:21:05 -070022#include <linux/blkdev.h>
Dave Kleikampac27a0e2006-10-11 01:20:50 -070023#include <linux/magic.h>
Aneesh Kumar K.V2ccb5fb2009-01-05 21:49:55 -050024#include <linux/jbd2.h>
Mingming Cao60e58e02009-01-22 18:13:05 +010025#include <linux/quota.h>
Theodore Ts'od444c3c2009-05-01 13:44:33 -040026#include <linux/rwsem.h>
27#include <linux/rbtree.h>
28#include <linux/seqlock.h>
29#include <linux/mutex.h>
Theodore Ts'oca0faba2009-05-03 16:33:44 -040030#include <linux/timer.h>
31#include <linux/wait.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010032#include <linux/sched/signal.h>
Theodore Ts'oca0faba2009-05-03 16:33:44 -040033#include <linux/blockgroup_lock.h>
34#include <linux/percpu_counter.h>
Theodore Ts'oefbed4d2013-10-17 21:11:01 -040035#include <linux/ratelimit.h>
Darrick J. Wong04419842012-04-29 18:27:10 -040036#include <crypto/hash.h>
Lukas Czernera633f5a2014-02-22 06:18:17 -050037#include <linux/falloc.h>
Daeho Jeongc8585c62016-04-25 23:22:35 -040038#include <linux/percpu-rwsem.h>
Christoph Hellwig10c5db22020-05-23 09:30:11 +020039#include <linux/fiemap.h>
Ben Hutchings4d92dc02010-05-17 06:00:00 -040040#ifdef __KERNEL__
41#include <linux/compat.h>
42#endif
Alex Tomasc9de5602008-01-29 00:19:52 -050043
Dave Chinner734f0d22017-10-09 12:15:34 -070044#include <linux/fscrypt.h>
Eric Biggersc93d8f82019-07-22 09:26:24 -070045#include <linux/fsverity.h>
Dave Chinner734f0d22017-10-09 12:15:34 -070046
Theodore Ts'o072ebb32018-08-27 01:15:11 -040047#include <linux/compiler.h>
48
Dave Kleikampac27a0e2006-10-11 01:20:50 -070049/*
Shen Feng8a356942008-07-11 19:27:31 -040050 * The fourth extended filesystem constants/structures
Dave Kleikampac27a0e2006-10-11 01:20:50 -070051 */
52
53/*
Aihua Zhanga2821e342016-03-13 17:18:12 -040054 * with AGGRESSIVE_CHECK allocator runs consistency checks over
55 * structures. these checks slow things down a lot
56 */
57#define AGGRESSIVE_CHECK__
58
59/*
60 * with DOUBLE_CHECK defined mballoc creates persistent in-core
61 * bitmaps, maintains and uses them to check for double allocations
62 */
63#define DOUBLE_CHECK__
64
65/*
Mingming Cao617ba132006-10-11 01:20:53 -070066 * Define EXT4FS_DEBUG to produce debug messages
Dave Kleikampac27a0e2006-10-11 01:20:50 -070067 */
Mingming Cao617ba132006-10-11 01:20:53 -070068#undef EXT4FS_DEBUG
Dave Kleikampac27a0e2006-10-11 01:20:50 -070069
70/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -070071 * Debug code
72 */
Mingming Cao617ba132006-10-11 01:20:53 -070073#ifdef EXT4FS_DEBUG
74#define ext4_debug(f, a...) \
Dave Kleikampac27a0e2006-10-11 01:20:50 -070075 do { \
Theodore Ts'oaf5bc922008-09-08 22:25:24 -040076 printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:", \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -040077 __FILE__, __LINE__, __func__); \
Theodore Ts'oaf5bc922008-09-08 22:25:24 -040078 printk(KERN_DEBUG f, ## a); \
Dave Kleikampac27a0e2006-10-11 01:20:50 -070079 } while (0)
80#else
Joe Perchesace36ad2012-03-19 23:11:43 -040081#define ext4_debug(fmt, ...) no_printk(fmt, ##__VA_ARGS__)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070082#endif
83
Ritesh Harjani70aa1552020-05-10 11:54:55 +053084 /*
85 * Turn on EXT_DEBUG to enable ext4_ext_show_path/leaf/move in extents.c
86 */
Theodore Ts'o4a092d72012-11-28 13:03:30 -050087#define EXT_DEBUG__
Ritesh Harjani70aa1552020-05-10 11:54:55 +053088
89/*
90 * Dynamic printk for controlled extents debugging.
91 */
92#ifdef CONFIG_EXT4_DEBUG
93#define ext_debug(ino, fmt, ...) \
94 pr_debug("[%s/%d] EXT4-fs (%s): ino %lu: (%s, %d): %s:" fmt, \
95 current->comm, task_pid_nr(current), \
96 ino->i_sb->s_id, ino->i_ino, __FILE__, __LINE__, \
97 __func__, ##__VA_ARGS__)
Theodore Ts'o4a092d72012-11-28 13:03:30 -050098#else
Ritesh Harjani70aa1552020-05-10 11:54:55 +053099#define ext_debug(ino, fmt, ...) no_printk(fmt, ##__VA_ARGS__)
Theodore Ts'o4a092d72012-11-28 13:03:30 -0500100#endif
101
Chunguang Xu837c23f2020-11-07 23:58:11 +0800102#define ASSERT(assert) \
103do { \
104 if (unlikely(!(assert))) { \
105 printk(KERN_EMERG \
106 "Assertion failure in %s() at %s:%d: '%s'\n", \
107 __func__, __FILE__, __LINE__, #assert); \
108 BUG(); \
109 } \
110} while (0)
111
Theodore Ts'od444c3c2009-05-01 13:44:33 -0400112/* data type for block offset of block group */
113typedef int ext4_grpblk_t;
114
115/* data type for filesystem-wide blocks number */
116typedef unsigned long long ext4_fsblk_t;
117
118/* data type for file logical block number */
119typedef __u32 ext4_lblk_t;
120
121/* data type for block group number */
122typedef unsigned int ext4_group_t;
123
Namjae Jeon331573f2015-06-09 01:55:03 -0400124enum SHIFT_DIRECTION {
125 SHIFT_LEFT = 0,
126 SHIFT_RIGHT,
127};
128
Theodore Ts'o296c3552009-09-30 00:32:42 -0400129/*
Theodore Ts'o60e66792010-05-17 07:00:00 -0400130 * Flags used in mballoc's allocation_context flags field.
Theodore Ts'o296c3552009-09-30 00:32:42 -0400131 *
132 * Also used to show what's going on for debugging purposes when the
133 * flag field is exported via the traceport interface
134 */
Theodore Ts'od444c3c2009-05-01 13:44:33 -0400135
Alex Tomasc9de5602008-01-29 00:19:52 -0500136/* prefer goal again. length */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400137#define EXT4_MB_HINT_MERGE 0x0001
Alex Tomasc9de5602008-01-29 00:19:52 -0500138/* blocks already reserved */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400139#define EXT4_MB_HINT_RESERVED 0x0002
Alex Tomasc9de5602008-01-29 00:19:52 -0500140/* metadata is being allocated */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400141#define EXT4_MB_HINT_METADATA 0x0004
Alex Tomasc9de5602008-01-29 00:19:52 -0500142/* first blocks in the file */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400143#define EXT4_MB_HINT_FIRST 0x0008
Alex Tomasc9de5602008-01-29 00:19:52 -0500144/* search for the best chunk */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400145#define EXT4_MB_HINT_BEST 0x0010
Alex Tomasc9de5602008-01-29 00:19:52 -0500146/* data is being allocated */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400147#define EXT4_MB_HINT_DATA 0x0020
Alex Tomasc9de5602008-01-29 00:19:52 -0500148/* don't preallocate (for tails) */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400149#define EXT4_MB_HINT_NOPREALLOC 0x0040
Alex Tomasc9de5602008-01-29 00:19:52 -0500150/* allocate for locality group */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400151#define EXT4_MB_HINT_GROUP_ALLOC 0x0080
Alex Tomasc9de5602008-01-29 00:19:52 -0500152/* allocate goal blocks or none */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400153#define EXT4_MB_HINT_GOAL_ONLY 0x0100
Alex Tomasc9de5602008-01-29 00:19:52 -0500154/* goal is meaningful */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400155#define EXT4_MB_HINT_TRY_GOAL 0x0200
Mingming Caod2a17632008-07-14 17:52:37 -0400156/* blocks already pre-reserved by delayed allocation */
Theodore Ts'o0ef90db2009-08-09 16:46:13 -0400157#define EXT4_MB_DELALLOC_RESERVED 0x0400
Theodore Ts'o4ba74d02009-08-09 22:01:13 -0400158/* We are doing stream allocation */
159#define EXT4_MB_STREAM_ALLOC 0x0800
Allison Henderson55f020d2011-05-25 07:41:26 -0400160/* Use reserved root blocks if needed */
161#define EXT4_MB_USE_ROOT_BLOCKS 0x1000
Lukas Czerner27dd4382013-04-09 22:11:22 -0400162/* Use blocks from reserved pool */
163#define EXT4_MB_USE_RESERVED 0x2000
Ritesh Harjani99377832020-05-20 12:10:36 +0530164/* Do strict check for free blocks while retrying block allocation */
165#define EXT4_MB_STRICT_CHECK 0x4000
Harshad Shirwadkar196e4022021-04-01 10:21:27 -0700166/* Large fragment size list lookup succeeded at least once for cr = 0 */
167#define EXT4_MB_CR0_OPTIMIZED 0x8000
168/* Avg fragment size rb tree lookup succeeded at least once for cr = 1 */
169#define EXT4_MB_CR1_OPTIMIZED 0x00010000
170/* Perform linear traversal for one group */
171#define EXT4_MB_SEARCH_NEXT_LINEAR 0x00020000
Alex Tomasc9de5602008-01-29 00:19:52 -0500172struct ext4_allocation_request {
173 /* target inode for block we're allocating */
174 struct inode *inode;
Alex Tomasc9de5602008-01-29 00:19:52 -0500175 /* how many blocks we want to allocate */
Theodore Ts'o498e5f22008-11-05 00:14:04 -0500176 unsigned int len;
Eric Sandeen726447d2009-07-13 10:24:17 -0400177 /* logical block in target inode */
178 ext4_lblk_t logical;
179 /* the closest logical allocated block to the left */
180 ext4_lblk_t lleft;
181 /* the closest logical allocated block to the right */
182 ext4_lblk_t lright;
183 /* phys. target (a hint) */
184 ext4_fsblk_t goal;
185 /* phys. block for the closest logical allocated block to the left */
186 ext4_fsblk_t pleft;
187 /* phys. block for the closest logical allocated block to the right */
188 ext4_fsblk_t pright;
Alex Tomasc9de5602008-01-29 00:19:52 -0500189 /* flags. see above EXT4_MB_HINT_* */
Theodore Ts'o498e5f22008-11-05 00:14:04 -0500190 unsigned int flags;
Alex Tomasc9de5602008-01-29 00:19:52 -0500191};
192
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700193/*
Theodore Ts'oe35fd662010-05-16 19:00:00 -0400194 * Logical to physical block mapping, used by ext4_map_blocks()
195 *
196 * This structure is used to pass requests into ext4_map_blocks() as
197 * well as to store the information returned by ext4_map_blocks(). It
198 * takes less room on the stack than a struct buffer_head.
199 */
Ritesh Harjani6db07462020-05-10 11:54:51 +0530200#define EXT4_MAP_NEW BIT(BH_New)
201#define EXT4_MAP_MAPPED BIT(BH_Mapped)
202#define EXT4_MAP_UNWRITTEN BIT(BH_Unwritten)
203#define EXT4_MAP_BOUNDARY BIT(BH_Boundary)
Theodore Ts'oe35fd662010-05-16 19:00:00 -0400204#define EXT4_MAP_FLAGS (EXT4_MAP_NEW | EXT4_MAP_MAPPED |\
Jan Karacbd75842014-11-25 11:41:49 -0500205 EXT4_MAP_UNWRITTEN | EXT4_MAP_BOUNDARY)
Theodore Ts'oe35fd662010-05-16 19:00:00 -0400206
207struct ext4_map_blocks {
208 ext4_fsblk_t m_pblk;
209 ext4_lblk_t m_lblk;
210 unsigned int m_len;
211 unsigned int m_flags;
212};
213
214/*
zhangyi (F)7727ae52019-08-28 11:13:24 -0400215 * Block validity checking, system zone rbtree.
216 */
217struct ext4_system_blocks {
218 struct rb_root root;
219 struct rcu_head rcu;
220};
221
222/*
Theodore Ts'obd2d0212010-10-27 21:30:10 -0400223 * Flags for ext4_io_end->flags
224 */
225#define EXT4_IO_END_UNWRITTEN 0x0001
Theodore Ts'obd2d0212010-10-27 21:30:10 -0400226
Ritesh Harjanic8cc8812019-10-16 13:07:10 +0530227struct ext4_io_end_vec {
228 struct list_head list; /* list of io_end_vec */
229 loff_t offset; /* offset in the file */
230 ssize_t size; /* size of the extent */
231};
232
Curt Wohlgemuth41881882012-03-05 10:40:22 -0500233/*
Lukas Czerner556615d2014-04-20 23:45:47 -0400234 * For converting unwritten extents on a work queue. 'handle' is used for
Jan Kara6b523df2013-06-04 13:21:11 -0400235 * buffered writeback.
Curt Wohlgemuth41881882012-03-05 10:40:22 -0500236 */
Mingming Cao00314622009-09-28 15:49:08 -0400237typedef struct ext4_io_end {
jiayingz@google.com (Jiaying Zhang)5b3ff232010-07-27 11:56:06 -0400238 struct list_head list; /* per-file finished IO list */
Jan Kara6b523df2013-06-04 13:21:11 -0400239 handle_t *handle; /* handle reserved for extent
240 * conversion */
Mingming Cao00314622009-09-28 15:49:08 -0400241 struct inode *inode; /* file being written to */
Jan Karab0857d32013-06-04 14:23:41 -0400242 struct bio *bio; /* Linked list of completed
243 * bios covering the extent */
Mingming Cao8d5d02e2009-09-28 15:48:29 -0400244 unsigned int flag; /* unwritten or not */
Xiyu Yang31d21d22021-07-19 13:59:14 +0800245 refcount_t count; /* reference counter */
Ritesh Harjanic8cc8812019-10-16 13:07:10 +0530246 struct list_head list_vec; /* list of ext4_io_end_vec */
Mingming Cao00314622009-09-28 15:49:08 -0400247} ext4_io_end_t;
248
Theodore Ts'obd2d0212010-10-27 21:30:10 -0400249struct ext4_io_submit {
Tejun Heo5a339112015-07-21 23:50:24 -0400250 struct writeback_control *io_wbc;
Theodore Ts'obd2d0212010-10-27 21:30:10 -0400251 struct bio *io_bio;
252 ext4_io_end_t *io_end;
Theodore Ts'obd2d0212010-10-27 21:30:10 -0400253 sector_t io_next_block;
254};
255
Theodore Ts'ob3a3ca82009-08-31 23:13:11 -0400256/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700257 * Special inodes numbers
258 */
Mingming Cao617ba132006-10-11 01:20:53 -0700259#define EXT4_BAD_INO 1 /* Bad blocks inode */
260#define EXT4_ROOT_INO 2 /* Root inode */
Aditya Kaliae812302011-05-24 19:00:39 -0400261#define EXT4_USR_QUOTA_INO 3 /* User quota inode */
262#define EXT4_GRP_QUOTA_INO 4 /* Group quota inode */
Mingming Cao617ba132006-10-11 01:20:53 -0700263#define EXT4_BOOT_LOADER_INO 5 /* Boot loader inode */
264#define EXT4_UNDEL_DIR_INO 6 /* Undelete directory inode */
265#define EXT4_RESIZE_INO 7 /* Reserved group descriptors inode */
266#define EXT4_JOURNAL_INO 8 /* Journal inode */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700267
Mingming Cao617ba132006-10-11 01:20:53 -0700268/* First non-reserved inode for old ext4 filesystems */
269#define EXT4_GOOD_OLD_FIRST_INO 11
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700270
271/*
272 * Maximal count of links to a file
273 */
Andreas Dilgerf8628a12007-07-18 08:38:01 -0400274#define EXT4_LINK_MAX 65000
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700275
276/*
277 * Macro-instructions used to manage several block sizes
278 */
Mingming Cao617ba132006-10-11 01:20:53 -0700279#define EXT4_MIN_BLOCK_SIZE 1024
Takashi Satoafc7cbc2008-01-28 23:58:27 -0500280#define EXT4_MAX_BLOCK_SIZE 65536
281#define EXT4_MIN_BLOCK_LOG_SIZE 10
Curt Wohlgemuthfb1813f2010-10-27 21:29:12 -0400282#define EXT4_MAX_BLOCK_LOG_SIZE 16
Theodore Ts'o9e47a4c2016-11-18 13:00:24 -0500283#define EXT4_MAX_CLUSTER_LOG_SIZE 30
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700284#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -0700285# define EXT4_BLOCK_SIZE(s) ((s)->s_blocksize)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700286#else
Mingming Cao617ba132006-10-11 01:20:53 -0700287# define EXT4_BLOCK_SIZE(s) (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700288#endif
Theodore Ts'oaf5bc922008-09-08 22:25:24 -0400289#define EXT4_ADDR_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / sizeof(__u32))
Theodore Ts'o281b5992011-09-09 18:34:51 -0400290#define EXT4_CLUSTER_SIZE(s) (EXT4_BLOCK_SIZE(s) << \
291 EXT4_SB(s)->s_cluster_bits)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700292#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -0700293# define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
Theodore Ts'o281b5992011-09-09 18:34:51 -0400294# define EXT4_CLUSTER_BITS(s) (EXT4_SB(s)->s_cluster_bits)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700295#else
Mingming Cao617ba132006-10-11 01:20:53 -0700296# define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700297#endif
298#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -0700299#define EXT4_ADDR_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_addr_per_block_bits)
300#define EXT4_INODE_SIZE(s) (EXT4_SB(s)->s_inode_size)
301#define EXT4_FIRST_INO(s) (EXT4_SB(s)->s_first_ino)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700302#else
Mingming Cao617ba132006-10-11 01:20:53 -0700303#define EXT4_INODE_SIZE(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
304 EXT4_GOOD_OLD_INODE_SIZE : \
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700305 (s)->s_inode_size)
Mingming Cao617ba132006-10-11 01:20:53 -0700306#define EXT4_FIRST_INO(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
307 EXT4_GOOD_OLD_FIRST_INO : \
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700308 (s)->s_first_ino)
309#endif
Amit Aroraa2df2a62007-07-17 21:42:41 -0400310#define EXT4_BLOCK_ALIGN(size, blkbits) ALIGN((size), (1 << (blkbits)))
Fabian Frederick518eaa62016-09-15 11:55:01 -0400311#define EXT4_MAX_BLOCKS(size, offset, blkbits) \
312 ((EXT4_BLOCK_ALIGN(size + offset, blkbits) >> blkbits) - (offset >> \
313 blkbits))
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700314
Theodore Ts'od5b8f312011-09-09 18:44:51 -0400315/* Translate a block number to a cluster number */
316#define EXT4_B2C(sbi, blk) ((blk) >> (sbi)->s_cluster_bits)
317/* Translate a cluster number to a block number */
318#define EXT4_C2B(sbi, cluster) ((cluster) << (sbi)->s_cluster_bits)
319/* Translate # of blks to # of clusters */
320#define EXT4_NUM_B2C(sbi, blks) (((blks) + (sbi)->s_cluster_ratio - 1) >> \
321 (sbi)->s_cluster_bits)
Theodore Ts'of5a44db2013-12-20 09:29:35 -0500322/* Mask out the low bits to get the starting block of the cluster */
323#define EXT4_PBLK_CMASK(s, pblk) ((pblk) & \
324 ~((ext4_fsblk_t) (s)->s_cluster_ratio - 1))
325#define EXT4_LBLK_CMASK(s, lblk) ((lblk) & \
326 ~((ext4_lblk_t) (s)->s_cluster_ratio - 1))
Eric Whitney8fcc3a52019-08-22 23:22:14 -0400327/* Fill in the low bits to get the last block of the cluster */
328#define EXT4_LBLK_CFILL(sbi, lblk) ((lblk) | \
329 ((ext4_lblk_t) (sbi)->s_cluster_ratio - 1))
Theodore Ts'of5a44db2013-12-20 09:29:35 -0500330/* Get the cluster offset */
331#define EXT4_PBLK_COFF(s, pblk) ((pblk) & \
332 ((ext4_fsblk_t) (s)->s_cluster_ratio - 1))
333#define EXT4_LBLK_COFF(s, lblk) ((lblk) & \
334 ((ext4_lblk_t) (s)->s_cluster_ratio - 1))
Theodore Ts'od5b8f312011-09-09 18:44:51 -0400335
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700336/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700337 * Structure of a blocks group descriptor
338 */
Mingming Cao617ba132006-10-11 01:20:53 -0700339struct ext4_group_desc
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700340{
Aneesh Kumar K.V3a145892007-10-16 18:38:25 -0400341 __le32 bg_block_bitmap_lo; /* Blocks bitmap block */
Aneesh Kumar K.V5272f832007-10-16 18:38:25 -0400342 __le32 bg_inode_bitmap_lo; /* Inodes bitmap block */
343 __le32 bg_inode_table_lo; /* Inodes table block */
Aneesh Kumar K.V560671a2009-01-05 22:20:24 -0500344 __le16 bg_free_blocks_count_lo;/* Free blocks count */
345 __le16 bg_free_inodes_count_lo;/* Free inodes count */
346 __le16 bg_used_dirs_count_lo; /* Directories count */
Andreas Dilger717d50e2007-10-16 18:38:25 -0400347 __le16 bg_flags; /* EXT4_BG_flags (INODE_UNINIT, etc) */
Darrick J. Wonge6153912012-04-29 18:23:10 -0400348 __le32 bg_exclude_bitmap_lo; /* Exclude bitmap for snapshots */
349 __le16 bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bbitmap) LE */
350 __le16 bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+ibitmap) LE */
Aneesh Kumar K.V560671a2009-01-05 22:20:24 -0500351 __le16 bg_itable_unused_lo; /* Unused inodes count */
Andreas Dilger717d50e2007-10-16 18:38:25 -0400352 __le16 bg_checksum; /* crc16(sb_uuid+group+desc) */
Alexandre Ratchov8fadc142006-10-11 01:21:15 -0700353 __le32 bg_block_bitmap_hi; /* Blocks bitmap block MSB */
354 __le32 bg_inode_bitmap_hi; /* Inodes bitmap block MSB */
355 __le32 bg_inode_table_hi; /* Inodes table block MSB */
Coly Li91b51a02008-01-28 23:58:27 -0500356 __le16 bg_free_blocks_count_hi;/* Free blocks count MSB */
357 __le16 bg_free_inodes_count_hi;/* Free inodes count MSB */
358 __le16 bg_used_dirs_count_hi; /* Directories count MSB */
Aneesh Kumar K.V560671a2009-01-05 22:20:24 -0500359 __le16 bg_itable_unused_hi; /* Unused inodes count MSB */
Darrick J. Wonge6153912012-04-29 18:23:10 -0400360 __le32 bg_exclude_bitmap_hi; /* Exclude bitmap block MSB */
361 __le16 bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bbitmap) BE */
362 __le16 bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+ibitmap) BE */
363 __u32 bg_reserved;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700364};
365
Darrick J. Wong41a246d2012-04-29 18:33:10 -0400366#define EXT4_BG_INODE_BITMAP_CSUM_HI_END \
367 (offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
368 sizeof(__le16))
369#define EXT4_BG_BLOCK_BITMAP_CSUM_HI_END \
370 (offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
371 sizeof(__le16))
372
Jose R. Santos772cb7c2008-07-11 19:27:31 -0400373/*
374 * Structure of a flex block group info
375 */
376
377struct flex_groups {
Theodore Ts'o90ba9832013-03-11 23:39:59 -0400378 atomic64_t free_clusters;
379 atomic_t free_inodes;
380 atomic_t used_dirs;
Jose R. Santos772cb7c2008-07-11 19:27:31 -0400381};
382
Andreas Dilger717d50e2007-10-16 18:38:25 -0400383#define EXT4_BG_INODE_UNINIT 0x0001 /* Inode table/bitmap not in use */
384#define EXT4_BG_BLOCK_UNINIT 0x0002 /* Block bitmap not in use */
385#define EXT4_BG_INODE_ZEROED 0x0004 /* On-disk itable initialized to zero */
386
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700387/*
388 * Macro-instructions used to manage group descriptors
389 */
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700390#define EXT4_MIN_DESC_SIZE 32
Alexandre Ratchov8fadc142006-10-11 01:21:15 -0700391#define EXT4_MIN_DESC_SIZE_64BIT 64
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700392#define EXT4_MAX_DESC_SIZE EXT4_MIN_BLOCK_SIZE
393#define EXT4_DESC_SIZE(s) (EXT4_SB(s)->s_desc_size)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700394#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -0700395# define EXT4_BLOCKS_PER_GROUP(s) (EXT4_SB(s)->s_blocks_per_group)
Theodore Ts'o281b5992011-09-09 18:34:51 -0400396# define EXT4_CLUSTERS_PER_GROUP(s) (EXT4_SB(s)->s_clusters_per_group)
Mingming Cao617ba132006-10-11 01:20:53 -0700397# define EXT4_DESC_PER_BLOCK(s) (EXT4_SB(s)->s_desc_per_block)
398# define EXT4_INODES_PER_GROUP(s) (EXT4_SB(s)->s_inodes_per_group)
399# define EXT4_DESC_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_desc_per_block_bits)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700400#else
Mingming Cao617ba132006-10-11 01:20:53 -0700401# define EXT4_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700402# define EXT4_DESC_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
Mingming Cao617ba132006-10-11 01:20:53 -0700403# define EXT4_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700404#endif
405
406/*
407 * Constants relative to the data blocks
408 */
Mingming Cao617ba132006-10-11 01:20:53 -0700409#define EXT4_NDIR_BLOCKS 12
410#define EXT4_IND_BLOCK EXT4_NDIR_BLOCKS
411#define EXT4_DIND_BLOCK (EXT4_IND_BLOCK + 1)
412#define EXT4_TIND_BLOCK (EXT4_DIND_BLOCK + 1)
413#define EXT4_N_BLOCKS (EXT4_TIND_BLOCK + 1)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700414
415/*
416 * Inode flags
417 */
Mingming Cao617ba132006-10-11 01:20:53 -0700418#define EXT4_SECRM_FL 0x00000001 /* Secure deletion */
419#define EXT4_UNRM_FL 0x00000002 /* Undelete */
420#define EXT4_COMPR_FL 0x00000004 /* Compress file */
421#define EXT4_SYNC_FL 0x00000008 /* Synchronous updates */
422#define EXT4_IMMUTABLE_FL 0x00000010 /* Immutable file */
423#define EXT4_APPEND_FL 0x00000020 /* writes to file may only append */
424#define EXT4_NODUMP_FL 0x00000040 /* do not dump file */
425#define EXT4_NOATIME_FL 0x00000080 /* do not update atime */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700426/* Reserved for compression usage... */
Mingming Cao617ba132006-10-11 01:20:53 -0700427#define EXT4_DIRTY_FL 0x00000100
428#define EXT4_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
429#define EXT4_NOCOMPR_FL 0x00000400 /* Don't compress */
Theodore Ts'o3edc18d2015-01-19 16:00:58 -0500430 /* nb: was previously EXT2_ECOMPR_FL */
431#define EXT4_ENCRYPT_FL 0x00000800 /* encrypted file */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700432/* End compression flags --- maybe not all used */
Mingming Cao617ba132006-10-11 01:20:53 -0700433#define EXT4_INDEX_FL 0x00001000 /* hash-indexed directory */
434#define EXT4_IMAGIC_FL 0x00002000 /* AFS directory */
435#define EXT4_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
436#define EXT4_NOTAIL_FL 0x00008000 /* file tail should not be merged */
437#define EXT4_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
438#define EXT4_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
Aneesh Kumar K.V8180a562008-01-28 23:58:27 -0500439#define EXT4_HUGE_FILE_FL 0x00040000 /* Set to each huge file */
Alex Tomasa86c6182006-10-11 01:21:03 -0700440#define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
Eric Biggersc93d8f82019-07-22 09:26:24 -0700441#define EXT4_VERITY_FL 0x00100000 /* Verity protected inode */
Theodore Ts'of710b4b2010-01-25 03:31:32 -0500442#define EXT4_EA_INODE_FL 0x00200000 /* Inode used for large EA */
Eric Whitney4337ecd2020-02-11 16:02:16 -0500443/* 0x00400000 was formerly EXT4_EOFBLOCKS_FL */
Ira Weinyb383a732020-05-28 08:00:02 -0700444
445#define EXT4_DAX_FL 0x02000000 /* Inode is DAX */
446
Tao Ma67cf5b02012-12-10 14:04:46 -0500447#define EXT4_INLINE_DATA_FL 0x10000000 /* Inode has inline data. */
Theodore Ts'o8b4953e2015-10-17 16:15:18 -0400448#define EXT4_PROJINHERIT_FL 0x20000000 /* Create with parents projid */
Eric Biggersde8ff142020-05-10 14:52:52 -0700449#define EXT4_CASEFOLD_FL 0x40000000 /* Casefolded directory */
Aneesh Kumar K.V8180a562008-01-28 23:58:27 -0500450#define EXT4_RESERVED_FL 0x80000000 /* reserved for ext4 lib */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700451
Eric Biggers2a12e142020-07-12 20:10:12 -0700452/* User modifiable flags */
453#define EXT4_FL_USER_MODIFIABLE (EXT4_SECRM_FL | \
454 EXT4_UNRM_FL | \
455 EXT4_COMPR_FL | \
456 EXT4_SYNC_FL | \
457 EXT4_IMMUTABLE_FL | \
458 EXT4_APPEND_FL | \
459 EXT4_NODUMP_FL | \
460 EXT4_NOATIME_FL | \
461 EXT4_JOURNAL_DATA_FL | \
462 EXT4_NOTAIL_FL | \
463 EXT4_DIRSYNC_FL | \
464 EXT4_TOPDIR_FL | \
465 EXT4_EXTENTS_FL | \
466 0x00400000 /* EXT4_EOFBLOCKS_FL */ | \
467 EXT4_DAX_FL | \
468 EXT4_PROJINHERIT_FL | \
469 EXT4_CASEFOLD_FL)
470
471/* User visible flags */
472#define EXT4_FL_USER_VISIBLE (EXT4_FL_USER_MODIFIABLE | \
473 EXT4_DIRTY_FL | \
474 EXT4_COMPRBLK_FL | \
475 EXT4_NOCOMPR_FL | \
476 EXT4_ENCRYPT_FL | \
477 EXT4_INDEX_FL | \
478 EXT4_VERITY_FL | \
479 EXT4_INLINE_DATA_FL)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700480
Duane Griffin8fa43a82009-02-15 18:57:26 -0500481/* Flags that should be inherited by new inodes from their parent. */
482#define EXT4_FL_INHERITED (EXT4_SECRM_FL | EXT4_UNRM_FL | EXT4_COMPR_FL |\
Theodore Ts'o1cd9f092011-08-31 11:54:51 -0400483 EXT4_SYNC_FL | EXT4_NODUMP_FL | EXT4_NOATIME_FL |\
Duane Griffin8fa43a82009-02-15 18:57:26 -0500484 EXT4_NOCOMPR_FL | EXT4_JOURNAL_DATA_FL |\
Li Xi040cb372016-01-08 16:01:21 -0500485 EXT4_NOTAIL_FL | EXT4_DIRSYNC_FL |\
Ira Weinyb383a732020-05-28 08:00:02 -0700486 EXT4_PROJINHERIT_FL | EXT4_CASEFOLD_FL |\
487 EXT4_DAX_FL)
Duane Griffin8fa43a82009-02-15 18:57:26 -0500488
Duane Griffin2dc6b0d2009-02-15 18:09:20 -0500489/* Flags that are appropriate for regular files (all but dir-specific ones). */
Wang Shilong7ddf79a2019-06-10 00:13:32 -0400490#define EXT4_REG_FLMASK (~(EXT4_DIRSYNC_FL | EXT4_TOPDIR_FL | EXT4_CASEFOLD_FL |\
491 EXT4_PROJINHERIT_FL))
Duane Griffin2dc6b0d2009-02-15 18:09:20 -0500492
493/* Flags that are appropriate for non-directories/regular files. */
494#define EXT4_OTHER_FLMASK (EXT4_NODUMP_FL | EXT4_NOATIME_FL)
495
yangerkunabdc6442019-02-11 00:35:06 -0500496/* The only flags that should be swapped */
497#define EXT4_FL_SHOULD_SWAP (EXT4_HUGE_FILE_FL | EXT4_EXTENTS_FL)
498
Ira Weinyb383a732020-05-28 08:00:02 -0700499/* Flags which are mutually exclusive to DAX */
500#define EXT4_DAX_MUT_EXCL (EXT4_VERITY_FL | EXT4_ENCRYPT_FL |\
Xiao Yangaa2f7792020-08-28 16:43:30 +0800501 EXT4_JOURNAL_DATA_FL | EXT4_INLINE_DATA_FL)
Ira Weinyb383a732020-05-28 08:00:02 -0700502
Duane Griffin2dc6b0d2009-02-15 18:09:20 -0500503/* Mask out flags that are inappropriate for the given type of inode. */
504static inline __u32 ext4_mask_flags(umode_t mode, __u32 flags)
505{
506 if (S_ISDIR(mode))
507 return flags;
508 else if (S_ISREG(mode))
509 return flags & EXT4_REG_FLMASK;
510 else
511 return flags & EXT4_OTHER_FLMASK;
512}
513
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400514/*
515 * Inode flags used for atomic set/get
516 */
517enum {
518 EXT4_INODE_SECRM = 0, /* Secure deletion */
519 EXT4_INODE_UNRM = 1, /* Undelete */
520 EXT4_INODE_COMPR = 2, /* Compress file */
521 EXT4_INODE_SYNC = 3, /* Synchronous updates */
522 EXT4_INODE_IMMUTABLE = 4, /* Immutable file */
523 EXT4_INODE_APPEND = 5, /* writes to file may only append */
524 EXT4_INODE_NODUMP = 6, /* do not dump file */
525 EXT4_INODE_NOATIME = 7, /* do not update atime */
526/* Reserved for compression usage... */
527 EXT4_INODE_DIRTY = 8,
528 EXT4_INODE_COMPRBLK = 9, /* One or more compressed clusters */
529 EXT4_INODE_NOCOMPR = 10, /* Don't compress */
Theodore Ts'of542fbe2015-04-11 07:44:12 -0400530 EXT4_INODE_ENCRYPT = 11, /* Encrypted file */
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400531/* End compression flags --- maybe not all used */
532 EXT4_INODE_INDEX = 12, /* hash-indexed directory */
533 EXT4_INODE_IMAGIC = 13, /* AFS directory */
534 EXT4_INODE_JOURNAL_DATA = 14, /* file data should be journaled */
535 EXT4_INODE_NOTAIL = 15, /* file tail should not be merged */
536 EXT4_INODE_DIRSYNC = 16, /* dirsync behaviour (directories only) */
537 EXT4_INODE_TOPDIR = 17, /* Top of directory hierarchies*/
538 EXT4_INODE_HUGE_FILE = 18, /* Set to each huge file */
539 EXT4_INODE_EXTENTS = 19, /* Inode uses extents */
Eric Biggersc93d8f82019-07-22 09:26:24 -0700540 EXT4_INODE_VERITY = 20, /* Verity protected inode */
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400541 EXT4_INODE_EA_INODE = 21, /* Inode used for large EA */
Eric Whitney4337ecd2020-02-11 16:02:16 -0500542/* 22 was formerly EXT4_INODE_EOFBLOCKS */
Ira Weinyb383a732020-05-28 08:00:02 -0700543 EXT4_INODE_DAX = 25, /* Inode is DAX */
Tao Ma67cf5b02012-12-10 14:04:46 -0500544 EXT4_INODE_INLINE_DATA = 28, /* Data in inode. */
Theodore Ts'o8b4953e2015-10-17 16:15:18 -0400545 EXT4_INODE_PROJINHERIT = 29, /* Create with parents projid */
Eric Biggersde8ff142020-05-10 14:52:52 -0700546 EXT4_INODE_CASEFOLD = 30, /* Casefolded directory */
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400547 EXT4_INODE_RESERVED = 31, /* reserved for ext4 lib */
548};
549
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400550/*
Carlos Maiolino9a4c8012012-12-10 16:30:45 -0500551 * Since it's pretty easy to mix up bit numbers and hex values, we use a
552 * build-time check to make sure that EXT4_XXX_FL is consistent with respect to
553 * EXT4_INODE_XXX. If all is well, the macros will be dropped, so, it won't cost
554 * any extra space in the compiled kernel image, otherwise, the build will fail.
555 * It's important that these values are the same, since we are using
556 * EXT4_INODE_XXX to test for flag values, but EXT4_XXX_FL must be consistent
557 * with the values of FS_XXX_FL defined in include/linux/fs.h and the on-disk
558 * values found in ext2, ext3 and ext4 filesystems, and of course the values
559 * defined in e2fsprogs.
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400560 *
561 * It's not paranoia if the Murphy's Law really *is* out to get you. :-)
562 */
Carlos Maiolino9a4c8012012-12-10 16:30:45 -0500563#define TEST_FLAG_VALUE(FLAG) (EXT4_##FLAG##_FL == (1 << EXT4_INODE_##FLAG))
564#define CHECK_FLAG_VALUE(FLAG) BUILD_BUG_ON(!TEST_FLAG_VALUE(FLAG))
565
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400566static inline void ext4_check_flag_values(void)
567{
568 CHECK_FLAG_VALUE(SECRM);
569 CHECK_FLAG_VALUE(UNRM);
570 CHECK_FLAG_VALUE(COMPR);
571 CHECK_FLAG_VALUE(SYNC);
572 CHECK_FLAG_VALUE(IMMUTABLE);
573 CHECK_FLAG_VALUE(APPEND);
574 CHECK_FLAG_VALUE(NODUMP);
575 CHECK_FLAG_VALUE(NOATIME);
576 CHECK_FLAG_VALUE(DIRTY);
577 CHECK_FLAG_VALUE(COMPRBLK);
578 CHECK_FLAG_VALUE(NOCOMPR);
Theodore Ts'o3edc18d2015-01-19 16:00:58 -0500579 CHECK_FLAG_VALUE(ENCRYPT);
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400580 CHECK_FLAG_VALUE(INDEX);
581 CHECK_FLAG_VALUE(IMAGIC);
582 CHECK_FLAG_VALUE(JOURNAL_DATA);
583 CHECK_FLAG_VALUE(NOTAIL);
584 CHECK_FLAG_VALUE(DIRSYNC);
585 CHECK_FLAG_VALUE(TOPDIR);
586 CHECK_FLAG_VALUE(HUGE_FILE);
587 CHECK_FLAG_VALUE(EXTENTS);
Eric Biggersc93d8f82019-07-22 09:26:24 -0700588 CHECK_FLAG_VALUE(VERITY);
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400589 CHECK_FLAG_VALUE(EA_INODE);
Tao Ma67cf5b02012-12-10 14:04:46 -0500590 CHECK_FLAG_VALUE(INLINE_DATA);
Theodore Ts'o8b4953e2015-10-17 16:15:18 -0400591 CHECK_FLAG_VALUE(PROJINHERIT);
Eric Biggersde8ff142020-05-10 14:52:52 -0700592 CHECK_FLAG_VALUE(CASEFOLD);
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400593 CHECK_FLAG_VALUE(RESERVED);
594}
595
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700596/* Used to pass group descriptor data when online resize is done */
Mingming Cao617ba132006-10-11 01:20:53 -0700597struct ext4_new_group_input {
Dave Kleikamp8c55e202007-05-24 13:04:54 -0400598 __u32 group; /* Group number for this data */
599 __u64 block_bitmap; /* Absolute block number of block bitmap */
600 __u64 inode_bitmap; /* Absolute block number of inode bitmap */
601 __u64 inode_table; /* Absolute block number of inode table start */
602 __u32 blocks_count; /* Total number of blocks in this group */
603 __u16 reserved_blocks; /* Number of reserved blocks in this group */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700604 __u16 unused;
605};
606
Ben Hutchings4d92dc02010-05-17 06:00:00 -0400607#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
608struct compat_ext4_new_group_input {
609 u32 group;
610 compat_u64 block_bitmap;
611 compat_u64 inode_bitmap;
612 compat_u64 inode_table;
613 u32 blocks_count;
614 u16 reserved_blocks;
615 u16 unused;
616};
617#endif
618
Mingming Cao617ba132006-10-11 01:20:53 -0700619/* The struct ext4_new_group_input in kernel space, with free_blocks_count */
620struct ext4_new_group_data {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700621 __u32 group;
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700622 __u64 block_bitmap;
623 __u64 inode_bitmap;
624 __u64 inode_table;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700625 __u32 blocks_count;
626 __u16 reserved_blocks;
harshadsd77147f2017-10-29 09:38:46 -0400627 __u16 mdata_blocks;
628 __u32 free_clusters_count;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700629};
630
Yongqiang Yang33afdcc2012-01-03 23:32:52 -0500631/* Indexes used to index group tables in ext4_new_group_data */
632enum {
633 BLOCK_BITMAP = 0, /* block bitmap */
634 INODE_BITMAP, /* inode bitmap */
635 INODE_TABLE, /* inode tables */
636 GROUP_TABLE_COUNT,
637};
638
Amit Aroraa2df2a62007-07-17 21:42:41 -0400639/*
Eric Sandeen79e83032010-07-27 11:56:07 -0400640 * Flags used by ext4_map_blocks()
Amit Aroraa2df2a62007-07-17 21:42:41 -0400641 */
Lukas Czerner556615d2014-04-20 23:45:47 -0400642 /* Allocate any needed blocks and/or convert an unwritten
Theodore Ts'oc2177052009-05-14 00:58:52 -0400643 extent to be an initialized ext4 */
Theodore Ts'o2ac3b6e2009-05-14 13:57:08 -0400644#define EXT4_GET_BLOCKS_CREATE 0x0001
Lukas Czerner556615d2014-04-20 23:45:47 -0400645 /* Request the creation of an unwritten extent */
646#define EXT4_GET_BLOCKS_UNWRIT_EXT 0x0002
647#define EXT4_GET_BLOCKS_CREATE_UNWRIT_EXT (EXT4_GET_BLOCKS_UNWRIT_EXT|\
Theodore Ts'oc2177052009-05-14 00:58:52 -0400648 EXT4_GET_BLOCKS_CREATE)
Lukas Czerner27dd4382013-04-09 22:11:22 -0400649 /* Caller is from the delayed allocation writeout path
650 * finally doing the actual allocation of delayed blocks */
Jan Kara03f5d8b2009-06-09 00:17:05 -0400651#define EXT4_GET_BLOCKS_DELALLOC_RESERVE 0x0004
Mingming Cao00314622009-09-28 15:49:08 -0400652 /* caller is from the direct IO path, request to creation of an
Lukas Czerner556615d2014-04-20 23:45:47 -0400653 unwritten extents if not allocated, split the unwritten
Mingming Cao00314622009-09-28 15:49:08 -0400654 extent if blocks has been preallocated already*/
Jiaying Zhangc7064ef2010-03-02 13:28:44 -0500655#define EXT4_GET_BLOCKS_PRE_IO 0x0008
Aneesh Kumar K.V1296cc82010-01-15 01:27:59 -0500656#define EXT4_GET_BLOCKS_CONVERT 0x0010
Jiaying Zhangc7064ef2010-03-02 13:28:44 -0500657#define EXT4_GET_BLOCKS_IO_CREATE_EXT (EXT4_GET_BLOCKS_PRE_IO|\
Lukas Czerner556615d2014-04-20 23:45:47 -0400658 EXT4_GET_BLOCKS_CREATE_UNWRIT_EXT)
Jiaying Zhangc7064ef2010-03-02 13:28:44 -0500659 /* Convert extent to initialized after IO complete */
660#define EXT4_GET_BLOCKS_IO_CONVERT_EXT (EXT4_GET_BLOCKS_CONVERT|\
Lukas Czerner556615d2014-04-20 23:45:47 -0400661 EXT4_GET_BLOCKS_CREATE_UNWRIT_EXT)
Lukas Czerner27dd4382013-04-09 22:11:22 -0400662 /* Eventual metadata allocation (due to growing extent tree)
663 * should not fail, so try to use reserved blocks for that.*/
664#define EXT4_GET_BLOCKS_METADATA_NOFAIL 0x0020
Vivek Haldar556b27a2011-05-25 07:41:54 -0400665 /* Don't normalize allocation size (used for fallocate) */
666#define EXT4_GET_BLOCKS_NO_NORMALIZE 0x0040
Lukas Czernerb8a86842014-03-18 18:05:35 -0400667 /* Convert written extents to unwritten */
Jan Kara2dcba472015-12-07 15:04:57 -0500668#define EXT4_GET_BLOCKS_CONVERT_UNWRITTEN 0x0100
Jan Karac86d8db2015-12-07 15:10:26 -0500669 /* Write zeros to newly created written extents */
670#define EXT4_GET_BLOCKS_ZERO 0x0200
671#define EXT4_GET_BLOCKS_CREATE_ZERO (EXT4_GET_BLOCKS_CREATE |\
672 EXT4_GET_BLOCKS_ZERO)
Jan Karaee0876b2016-04-24 00:56:08 -0400673 /* Caller will submit data before dropping transaction handle. This
674 * allows jbd2 to avoid submitting data before commit. */
675#define EXT4_GET_BLOCKS_IO_SUBMIT 0x0400
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700676
677/*
Theodore Ts'o7869a4a2013-08-16 22:05:14 -0400678 * The bit position of these flags must not overlap with any of the
Theodore Ts'oed8a1a72014-09-01 14:43:09 -0400679 * EXT4_GET_BLOCKS_*. They are used by ext4_find_extent(),
Theodore Ts'o107a7bd2013-08-16 21:23:41 -0400680 * read_extent_tree_block(), ext4_split_extent_at(),
Theodore Ts'o7869a4a2013-08-16 22:05:14 -0400681 * ext4_ext_insert_extent(), and ext4_ext_create_new_leaf().
682 * EXT4_EX_NOCACHE is used to indicate that the we shouldn't be
683 * caching the extents when reading from the extent tree while a
684 * truncate or punch hole operation is in progress.
Theodore Ts'o107a7bd2013-08-16 21:23:41 -0400685 */
Theodore Ts'od26e2c42014-09-04 18:09:29 -0400686#define EXT4_EX_NOCACHE 0x40000000
687#define EXT4_EX_FORCE_CACHE 0x20000000
Theodore Ts'o73c384c02020-05-07 10:50:28 -0700688#define EXT4_EX_NOFAIL 0x10000000
Theodore Ts'o107a7bd2013-08-16 21:23:41 -0400689
690/*
Theodore Ts'oe6362602009-11-23 07:17:05 -0500691 * Flags used by ext4_free_blocks
692 */
Petros Koutoupise7093f02018-01-07 23:36:19 -0500693#define EXT4_FREE_BLOCKS_METADATA 0x0001
694#define EXT4_FREE_BLOCKS_FORGET 0x0002
695#define EXT4_FREE_BLOCKS_VALIDATED 0x0004
696#define EXT4_FREE_BLOCKS_NO_QUOT_UPDATE 0x0008
Theodore Ts'o84130192011-09-09 18:50:51 -0400697#define EXT4_FREE_BLOCKS_NOFREE_FIRST_CLUSTER 0x0010
698#define EXT4_FREE_BLOCKS_NOFREE_LAST_CLUSTER 0x0020
Eric Whitney9fe67142018-10-01 14:25:08 -0400699#define EXT4_FREE_BLOCKS_RERESERVE_CLUSTER 0x0040
Theodore Ts'oe6362602009-11-23 07:17:05 -0500700
701/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700702 * ioctl commands
703 */
Mingming Cao617ba132006-10-11 01:20:53 -0700704#define EXT4_IOC_GETVERSION _IOR('f', 3, long)
705#define EXT4_IOC_SETVERSION _IOW('f', 4, long)
Mingming Cao617ba132006-10-11 01:20:53 -0700706#define EXT4_IOC_GETVERSION_OLD FS_IOC_GETVERSION
707#define EXT4_IOC_SETVERSION_OLD FS_IOC_SETVERSION
Mingming Cao617ba132006-10-11 01:20:53 -0700708#define EXT4_IOC_GETRSVSZ _IOR('f', 5, long)
709#define EXT4_IOC_SETRSVSZ _IOW('f', 6, long)
Theodore Ts'o8eea80d2008-09-13 19:54:35 -0400710#define EXT4_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
711#define EXT4_IOC_GROUP_ADD _IOW('f', 8, struct ext4_new_group_input)
712#define EXT4_IOC_MIGRATE _IO('f', 9)
Theodore Ts'occd25062009-02-26 01:04:07 -0500713 /* note ioctl 10 reserved for an early version of the FIEMAP ioctl */
Theodore Ts'o8eea80d2008-09-13 19:54:35 -0400714 /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
Theodore Ts'occd25062009-02-26 01:04:07 -0500715#define EXT4_IOC_ALLOC_DA_BLKS _IO('f', 12)
Akira Fujita748de672009-06-17 19:24:03 -0400716#define EXT4_IOC_MOVE_EXT _IOWR('f', 15, struct move_extent)
Yongqiang Yang19c52462012-01-04 17:09:44 -0500717#define EXT4_IOC_RESIZE_FS _IOW('f', 16, __u64)
Dr. Tilmann Bubeck393d1d12013-04-08 12:54:05 -0400718#define EXT4_IOC_SWAP_BOOT _IO('f', 17)
Theodore Ts'o7869a4a2013-08-16 22:05:14 -0400719#define EXT4_IOC_PRECACHE_EXTENTS _IO('f', 18)
Theodore Ts'ob0c013e2019-08-11 16:30:41 -0400720/* ioctl codes 19--39 are reserved for fscrypt */
721#define EXT4_IOC_CLEAR_ES_CACHE _IO('f', 40)
Theodore Ts'o1ad3ea62019-08-11 16:31:41 -0400722#define EXT4_IOC_GETSTATE _IOW('f', 41, __u32)
Theodore Ts'obb5835e2019-08-11 16:32:41 -0400723#define EXT4_IOC_GET_ES_CACHE _IOWR('f', 42, struct fiemap)
Leah Rumancik351a0a32021-05-18 15:13:26 +0000724#define EXT4_IOC_CHECKPOINT _IOW('f', 43, __u32)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700725
Theodore Ts'oe9be2ac2017-02-20 15:34:59 -0500726#define EXT4_IOC_SHUTDOWN _IOR ('X', 125, __u32)
Theodore Ts'o783d9482017-02-05 19:47:14 -0500727
728/*
729 * Flags for going down operation
730 */
731#define EXT4_GOING_FLAGS_DEFAULT 0x0 /* going down */
732#define EXT4_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
733#define EXT4_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
734
Theodore Ts'o1ad3ea62019-08-11 16:31:41 -0400735/*
736 * Flags returned by EXT4_IOC_GETSTATE
737 *
738 * We only expose to userspace a subset of the state flags in
739 * i_state_flags
740 */
741#define EXT4_STATE_FLAG_EXT_PRECACHED 0x00000001
742#define EXT4_STATE_FLAG_NEW 0x00000002
743#define EXT4_STATE_FLAG_NEWENTRY 0x00000004
744#define EXT4_STATE_FLAG_DA_ALLOC_CLOSE 0x00000008
Theodore Ts'o783d9482017-02-05 19:47:14 -0500745
Leah Rumancik351a0a32021-05-18 15:13:26 +0000746/* flags for ioctl EXT4_IOC_CHECKPOINT */
747#define EXT4_IOC_CHECKPOINT_FLAG_DISCARD 0x1
748#define EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT 0x2
749#define EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN 0x4
750#define EXT4_IOC_CHECKPOINT_FLAG_VALID (EXT4_IOC_CHECKPOINT_FLAG_DISCARD | \
751 EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT | \
752 EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN)
753
Ben Hutchings899ad0c2010-05-17 05:00:00 -0400754#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700755/*
756 * ioctl commands in 32 bit emulation
757 */
Mingming Cao617ba132006-10-11 01:20:53 -0700758#define EXT4_IOC32_GETVERSION _IOR('f', 3, int)
759#define EXT4_IOC32_SETVERSION _IOW('f', 4, int)
760#define EXT4_IOC32_GETRSVSZ _IOR('f', 5, int)
761#define EXT4_IOC32_SETRSVSZ _IOW('f', 6, int)
762#define EXT4_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
Ben Hutchings4d92dc02010-05-17 06:00:00 -0400763#define EXT4_IOC32_GROUP_ADD _IOW('f', 8, struct compat_ext4_new_group_input)
Mingming Cao617ba132006-10-11 01:20:53 -0700764#define EXT4_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
765#define EXT4_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
Ben Hutchings899ad0c2010-05-17 05:00:00 -0400766#endif
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700767
Theodore Ts'obb5835e2019-08-11 16:32:41 -0400768/*
769 * Returned by EXT4_IOC_GET_ES_CACHE as an additional possible flag.
770 * It indicates that the entry in extent status cache is for a hole.
771 */
772#define EXT4_FIEMAP_EXTENT_HOLE 0x08000000
773
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400774/* Max physical block we can address w/o extents */
Eric Sandeenfb0a3872009-09-16 14:45:10 -0400775#define EXT4_MAX_BLOCK_FILE_PHYS 0xFFFFFFFF
776
Theodore Ts'obcd8e912018-09-01 12:45:04 -0400777/* Max logical block we can support */
Ritesh Harjani9f44eda2020-05-05 17:43:14 +0200778#define EXT4_MAX_LOGICAL_BLOCK 0xFFFFFFFE
Theodore Ts'obcd8e912018-09-01 12:45:04 -0400779
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700780/*
781 * Structure of an inode on the disk
782 */
Mingming Cao617ba132006-10-11 01:20:53 -0700783struct ext4_inode {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700784 __le16 i_mode; /* File mode */
785 __le16 i_uid; /* Low 16 bits of Owner Uid */
Aneesh Kumar K.Va48380f2008-01-28 23:58:27 -0500786 __le32 i_size_lo; /* Size in bytes */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700787 __le32 i_atime; /* Access time */
Kalpak Shahef7f3832007-07-18 09:15:20 -0400788 __le32 i_ctime; /* Inode Change time */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700789 __le32 i_mtime; /* Modification time */
790 __le32 i_dtime; /* Deletion Time */
791 __le16 i_gid; /* Low 16 bits of Group Id */
792 __le16 i_links_count; /* Links count */
Aneesh Kumar K.V0fc1b452008-01-28 23:58:26 -0500793 __le32 i_blocks_lo; /* Blocks count */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700794 __le32 i_flags; /* File flags */
795 union {
796 struct {
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -0500797 __le32 l_i_version;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700798 } linux1;
799 struct {
800 __u32 h_i_translator;
801 } hurd1;
802 struct {
803 __u32 m_i_reserved1;
804 } masix1;
805 } osd1; /* OS dependent 1 */
Mingming Cao617ba132006-10-11 01:20:53 -0700806 __le32 i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700807 __le32 i_generation; /* File version (for NFS) */
Aneesh Kumar K.V7973c0c2008-01-28 23:58:27 -0500808 __le32 i_file_acl_lo; /* File ACL */
Aneesh Kumar K.Va48380f2008-01-28 23:58:27 -0500809 __le32 i_size_high;
Coly Lif077d0d2007-10-16 18:38:25 -0400810 __le32 i_obso_faddr; /* Obsoleted fragment address */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700811 union {
812 struct {
Aneesh Kumar K.V0fc1b452008-01-28 23:58:26 -0500813 __le16 l_i_blocks_high; /* were l_i_reserved1 */
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700814 __le16 l_i_file_acl_high;
Dave Kleikamp8c55e202007-05-24 13:04:54 -0400815 __le16 l_i_uid_high; /* these 2 fields */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700816 __le16 l_i_gid_high; /* were reserved2[0] */
Darrick J. Wonge6153912012-04-29 18:23:10 -0400817 __le16 l_i_checksum_lo;/* crc32c(uuid+inum+inode) LE */
818 __le16 l_i_reserved;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700819 } linux2;
820 struct {
Coly Lif077d0d2007-10-16 18:38:25 -0400821 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700822 __u16 h_i_mode_high;
823 __u16 h_i_uid_high;
824 __u16 h_i_gid_high;
825 __u32 h_i_author;
826 } hurd2;
827 struct {
Coly Lif077d0d2007-10-16 18:38:25 -0400828 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700829 __le16 m_i_file_acl_high;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700830 __u32 m_i_reserved2[2];
831 } masix2;
832 } osd2; /* OS dependent 2 */
833 __le16 i_extra_isize;
Darrick J. Wonge6153912012-04-29 18:23:10 -0400834 __le16 i_checksum_hi; /* crc32c(uuid+inum+inode) BE */
Kalpak Shahef7f3832007-07-18 09:15:20 -0400835 __le32 i_ctime_extra; /* extra Change time (nsec << 2 | epoch) */
836 __le32 i_mtime_extra; /* extra Modification time(nsec << 2 | epoch) */
837 __le32 i_atime_extra; /* extra Access time (nsec << 2 | epoch) */
838 __le32 i_crtime; /* File Creation time */
839 __le32 i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -0500840 __le32 i_version_hi; /* high 32 bits for 64-bit version */
Theodore Ts'o8b4953e2015-10-17 16:15:18 -0400841 __le32 i_projid; /* Project ID */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700842};
843
Akira Fujita748de672009-06-17 19:24:03 -0400844struct move_extent {
845 __u32 reserved; /* should be zero */
846 __u32 donor_fd; /* donor file descriptor */
847 __u64 orig_start; /* logical start offset in block for orig */
848 __u64 donor_start; /* logical start offset in block for donor */
849 __u64 len; /* block length to be moved */
850 __u64 moved_len; /* moved block length */
851};
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700852
Kalpak Shahef7f3832007-07-18 09:15:20 -0400853#define EXT4_EPOCH_BITS 2
854#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
855#define EXT4_NSEC_MASK (~0UL << EXT4_EPOCH_BITS)
856
857/*
858 * Extended fields will fit into an inode if the filesystem was formatted
859 * with large inodes (-I 256 or larger) and there are not currently any EAs
860 * consuming all of the available space. For new inodes we always reserve
861 * enough space for the kernel's known extended fields, but for inodes
862 * created with an old kernel this might not have been the case. None of
863 * the extended inode fields is critical for correct filesystem operation.
864 * This macro checks if a certain field fits in the inode. Note that
865 * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
866 */
867#define EXT4_FITS_IN_INODE(ext4_inode, einode, field) \
868 ((offsetof(typeof(*ext4_inode), field) + \
869 sizeof((ext4_inode)->field)) \
870 <= (EXT4_GOOD_OLD_INODE_SIZE + \
871 (einode)->i_extra_isize)) \
872
David Turnera4dad1a2015-11-24 14:34:37 -0500873/*
874 * We use an encoding that preserves the times for extra epoch "00":
875 *
876 * extra msb of adjust for signed
877 * epoch 32-bit 32-bit tv_sec to
878 * bits time decoded 64-bit tv_sec 64-bit tv_sec valid time range
879 * 0 0 1 -0x80000000..-0x00000001 0x000000000 1901-12-13..1969-12-31
880 * 0 0 0 0x000000000..0x07fffffff 0x000000000 1970-01-01..2038-01-19
881 * 0 1 1 0x080000000..0x0ffffffff 0x100000000 2038-01-19..2106-02-07
882 * 0 1 0 0x100000000..0x17fffffff 0x100000000 2106-02-07..2174-02-25
883 * 1 0 1 0x180000000..0x1ffffffff 0x200000000 2174-02-25..2242-03-16
884 * 1 0 0 0x200000000..0x27fffffff 0x200000000 2242-03-16..2310-04-04
885 * 1 1 1 0x280000000..0x2ffffffff 0x300000000 2310-04-04..2378-04-22
886 * 1 1 0 0x300000000..0x37fffffff 0x300000000 2378-04-22..2446-05-10
887 *
888 * Note that previous versions of the kernel on 64-bit systems would
889 * incorrectly use extra epoch bits 1,1 for dates between 1901 and
890 * 1970. e2fsck will correct this, assuming that it is run on the
891 * affected filesystem before 2242.
892 */
893
Arnd Bergmann7b62b292018-07-29 15:51:00 -0400894static inline __le32 ext4_encode_extra_time(struct timespec64 *time)
Kalpak Shahef7f3832007-07-18 09:15:20 -0400895{
Arnd Bergmann7b62b292018-07-29 15:51:00 -0400896 u32 extra =((time->tv_sec - (s32)time->tv_sec) >> 32) & EXT4_EPOCH_MASK;
David Turnera4dad1a2015-11-24 14:34:37 -0500897 return cpu_to_le32(extra | (time->tv_nsec << EXT4_EPOCH_BITS));
Kalpak Shahef7f3832007-07-18 09:15:20 -0400898}
899
Arnd Bergmann7b62b292018-07-29 15:51:00 -0400900static inline void ext4_decode_extra_time(struct timespec64 *time,
901 __le32 extra)
Kalpak Shahef7f3832007-07-18 09:15:20 -0400902{
Theodore Ts'ocd2d9922019-08-12 13:44:49 -0400903 if (unlikely(extra & cpu_to_le32(EXT4_EPOCH_MASK)))
David Turnera4dad1a2015-11-24 14:34:37 -0500904 time->tv_sec += (u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK) << 32;
David Turnera4dad1a2015-11-24 14:34:37 -0500905 time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> EXT4_EPOCH_BITS;
Kalpak Shahef7f3832007-07-18 09:15:20 -0400906}
907
Deepa Dinamani95582b02018-05-08 19:36:02 -0700908#define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode) \
909do { \
Deepa Dinamani95582b02018-05-08 19:36:02 -0700910 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) {\
Deepa Dinamani4881c492018-01-21 18:04:24 -0800911 (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec); \
Deepa Dinamani95582b02018-05-08 19:36:02 -0700912 (raw_inode)->xtime ## _extra = \
Arnd Bergmann7b62b292018-07-29 15:51:00 -0400913 ext4_encode_extra_time(&(inode)->xtime); \
Deepa Dinamani95582b02018-05-08 19:36:02 -0700914 } \
Deepa Dinamanicba465b2019-09-04 08:02:51 -0700915 else \
Deepa Dinamani4881c492018-01-21 18:04:24 -0800916 (raw_inode)->xtime = cpu_to_le32(clamp_t(int32_t, (inode)->xtime.tv_sec, S32_MIN, S32_MAX)); \
Kalpak Shahef7f3832007-07-18 09:15:20 -0400917} while (0)
918
919#define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode) \
920do { \
921 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
922 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec); \
923 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
924 (raw_inode)->xtime ## _extra = \
925 ext4_encode_extra_time(&(einode)->xtime); \
926} while (0)
927
Deepa Dinamani95582b02018-05-08 19:36:02 -0700928#define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode) \
929do { \
930 (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime); \
931 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) { \
Arnd Bergmann7b62b292018-07-29 15:51:00 -0400932 ext4_decode_extra_time(&(inode)->xtime, \
Deepa Dinamani95582b02018-05-08 19:36:02 -0700933 raw_inode->xtime ## _extra); \
Deepa Dinamani95582b02018-05-08 19:36:02 -0700934 } \
935 else \
936 (inode)->xtime.tv_nsec = 0; \
Kalpak Shahef7f3832007-07-18 09:15:20 -0400937} while (0)
938
Deepa Dinamani95582b02018-05-08 19:36:02 -0700939
Kalpak Shahef7f3832007-07-18 09:15:20 -0400940#define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode) \
941do { \
942 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
943 (einode)->xtime.tv_sec = \
944 (signed)le32_to_cpu((raw_inode)->xtime); \
Theodore Ts'o19ea8062014-02-16 19:29:32 -0500945 else \
946 (einode)->xtime.tv_sec = 0; \
Kalpak Shahef7f3832007-07-18 09:15:20 -0400947 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
948 ext4_decode_extra_time(&(einode)->xtime, \
949 raw_inode->xtime ## _extra); \
Eric Sandeenaf0b44a2010-12-19 22:10:31 -0500950 else \
951 (einode)->xtime.tv_nsec = 0; \
Kalpak Shahef7f3832007-07-18 09:15:20 -0400952} while (0)
953
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -0500954#define i_disk_version osd1.linux1.l_i_version
955
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700956#if defined(__KERNEL__) || defined(__linux__)
957#define i_reserved1 osd1.linux1.l_i_reserved1
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700958#define i_file_acl_high osd2.linux2.l_i_file_acl_high
Aneesh Kumar K.V0fc1b452008-01-28 23:58:26 -0500959#define i_blocks_high osd2.linux2.l_i_blocks_high
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700960#define i_uid_low i_uid
961#define i_gid_low i_gid
962#define i_uid_high osd2.linux2.l_i_uid_high
963#define i_gid_high osd2.linux2.l_i_gid_high
Darrick J. Wonge6153912012-04-29 18:23:10 -0400964#define i_checksum_lo osd2.linux2.l_i_checksum_lo
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700965
966#elif defined(__GNU__)
967
968#define i_translator osd1.hurd1.h_i_translator
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700969#define i_uid_high osd2.hurd2.h_i_uid_high
970#define i_gid_high osd2.hurd2.h_i_gid_high
971#define i_author osd2.hurd2.h_i_author
972
973#elif defined(__masix__)
974
975#define i_reserved1 osd1.masix1.m_i_reserved1
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700976#define i_file_acl_high osd2.masix2.m_i_file_acl_high
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700977#define i_reserved2 osd2.masix2.m_i_reserved2
978
979#endif /* defined(__KERNEL__) || defined(__linux__) */
980
Zheng Liuc0677e62012-11-08 15:18:54 -0500981#include "extents_status.h"
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -0700982#include "fast_commit.h"
Zheng Liuc0677e62012-11-08 15:18:54 -0500983
Theodore Ts'od444c3c2009-05-01 13:44:33 -0400984/*
Theodore Ts'odaf647d2016-04-01 01:31:28 -0400985 * Lock subclasses for i_data_sem in the ext4_inode_info structure.
986 *
987 * These are needed to avoid lockdep false positives when we need to
988 * allocate blocks to the quota inode during ext4_map_blocks(), while
989 * holding i_data_sem for a normal (non-quota) inode. Since we don't
990 * do quota tracking for the quota inode, this avoids deadlock (as
991 * well as infinite recursion, since it isn't turtles all the way
992 * down...)
993 *
994 * I_DATA_SEM_NORMAL - Used for most inodes
995 * I_DATA_SEM_OTHER - Used by move_inode.c for the second normal inode
996 * where the second inode has larger inode number
997 * than the first
998 * I_DATA_SEM_QUOTA - Used for quota inodes only
999 */
1000enum {
1001 I_DATA_SEM_NORMAL = 0,
1002 I_DATA_SEM_OTHER,
1003 I_DATA_SEM_QUOTA,
1004};
1005
1006
1007/*
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001008 * fourth extended file system inode data in memory
1009 */
1010struct ext4_inode_info {
1011 __le32 i_data[15]; /* unconverted */
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001012 __u32 i_dtime;
Dmitry Monakhov12e9b892010-05-16 22:00:00 -04001013 ext4_fsblk_t i_file_acl;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001014
1015 /*
1016 * i_block_group is the number of the block group which contains
1017 * this file's inode. Constant across the lifetime of the inode,
Eric Whitneya627b0a2017-07-30 22:30:11 -04001018 * it is used for making block allocation decisions - we try to
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001019 * place a file's data blocks near its inode block, and new inodes
1020 * near to their parent directory's inode.
1021 */
1022 ext4_group_t i_block_group;
Theodore Ts'o8a2005d2011-01-10 12:13:42 -05001023 ext4_lblk_t i_dir_start_lookup;
Theodore Ts'o353eb832011-01-10 12:18:25 -05001024#if (BITS_PER_LONG < 64)
Theodore Ts'o19f5fb72010-01-24 14:34:07 -05001025 unsigned long i_state_flags; /* Dynamic state flags */
Theodore Ts'o353eb832011-01-10 12:18:25 -05001026#endif
Dmitry Monakhov12e9b892010-05-16 22:00:00 -04001027 unsigned long i_flags;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001028
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001029 /*
1030 * Extended attributes can be read independently of the main file
1031 * data. Taking i_mutex even when reading would cause contention
1032 * between readers of EAs and writers of regular file data, so
1033 * instead we synchronize on xattr_sem when reading or changing
1034 * EAs.
1035 */
1036 struct rw_semaphore xattr_sem;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001037
Jan Kara02f310f2021-08-16 11:57:06 +02001038 /*
1039 * Inodes with EXT4_STATE_ORPHAN_FILE use i_orphan_idx. Otherwise
1040 * i_orphan is used.
1041 */
1042 union {
1043 struct list_head i_orphan; /* unlinked but open inodes */
1044 unsigned int i_orphan_idx; /* Index in orphan file */
1045 };
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001046
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001047 /* Fast commit related info */
1048
1049 struct list_head i_fc_list; /*
1050 * inodes that need fast commit
1051 * protected by sbi->s_fc_lock.
1052 */
1053
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001054 /* Start of lblk range that needs to be committed in this fast commit */
1055 ext4_lblk_t i_fc_lblk_start;
1056
1057 /* End of lblk range that needs to be committed in this fast commit */
1058 ext4_lblk_t i_fc_lblk_len;
1059
1060 /* Number of ongoing updates on this inode */
1061 atomic_t i_fc_updates;
1062
1063 /* Fast commit wait queue for this inode */
1064 wait_queue_head_t i_fc_wait;
1065
1066 /* Protect concurrent accesses on i_fc_lblk_start, i_fc_lblk_len */
1067 struct mutex i_fc_lock;
1068
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001069 /*
1070 * i_disksize keeps track of what the inode size is ON DISK, not
1071 * in memory. During truncate, i_size is set to the new size by
1072 * the VFS prior to calling ext4_truncate(), but the filesystem won't
1073 * set i_disksize to 0 until the truncate is actually under way.
1074 *
1075 * The intent is that i_disksize always represents the blocks which
1076 * are used by this file. This allows recovery to restart truncate
1077 * on orphans if we crash during truncate. We actually write i_disksize
1078 * into the on-disk inode when writing inodes out, instead of i_size.
1079 *
1080 * The only time when i_disksize and i_size may be different is when
1081 * a truncate is in progress. The only things which change i_disksize
1082 * are ext4_get_block (growth) and ext4_truncate (shrinkth).
1083 */
1084 loff_t i_disksize;
1085
1086 /*
1087 * i_data_sem is for serialising ext4_truncate() against
1088 * ext4_getblock(). In the 2.4 ext2 design, great chunks of inode's
1089 * data tree are chopped off during truncate. We can't do that in
1090 * ext4 because whenever we perform intermediate commits during
1091 * truncate, the inode and all the metadata blocks *must* be in a
1092 * consistent state which allows truncation of the orphans to restart
1093 * during recovery. Hence we must fix the get_block-vs-truncate race
1094 * by other means, so we have i_data_sem.
1095 */
1096 struct rw_semaphore i_data_sem;
1097 struct inode vfs_inode;
Theodore Ts'o8aefcd52011-01-10 12:29:43 -05001098 struct jbd2_inode *jinode;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001099
Theodore Ts'o202ee5d2014-04-21 14:37:55 -04001100 spinlock_t i_raw_lock; /* protects updates to the raw inode */
1101
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001102 /*
1103 * File creation time. Its function is same as that of
Arnd Bergmann7b62b292018-07-29 15:51:00 -04001104 * struct timespec64 i_{a,c,m}time in the generic inode.
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001105 */
Arnd Bergmann7b62b292018-07-29 15:51:00 -04001106 struct timespec64 i_crtime;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001107
1108 /* mballoc */
brookxu27bc4462020-08-17 15:36:15 +08001109 atomic_t i_prealloc_active;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001110 struct list_head i_prealloc_list;
1111 spinlock_t i_prealloc_lock;
1112
Zheng Liuc0677e62012-11-08 15:18:54 -05001113 /* extents status tree */
1114 struct ext4_es_tree i_es_tree;
1115 rwlock_t i_es_lock;
Zheng Liuedaa53c2014-11-25 11:45:37 -05001116 struct list_head i_es_list;
Zheng Liueb68d0e2014-09-01 22:26:49 -04001117 unsigned int i_es_all_nr; /* protected by i_es_lock */
Zheng Liuedaa53c2014-11-25 11:45:37 -05001118 unsigned int i_es_shk_nr; /* protected by i_es_lock */
Jan Karadd475922014-11-25 11:51:23 -05001119 ext4_lblk_t i_es_shrink_lblk; /* Offset where we start searching for
1120 extents to shrink. Protected by
1121 i_es_lock */
Zheng Liuc0677e62012-11-08 15:18:54 -05001122
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001123 /* ialloc */
1124 ext4_group_t i_last_alloc_group;
1125
1126 /* allocation reservation info for delalloc */
Eric Whitneya627b0a2017-07-30 22:30:11 -04001127 /* In case of bigalloc, this refer to clusters rather than blocks */
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001128 unsigned int i_reserved_data_blocks;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001129
Eric Whitney1dc0aa42018-10-01 14:17:41 -04001130 /* pending cluster reservations for bigalloc file systems */
1131 struct ext4_pending_tree i_pending_tree;
1132
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001133 /* on-disk additional length */
1134 __u16 i_extra_isize;
1135
Tao Ma67cf5b02012-12-10 14:04:46 -05001136 /* Indicate the inline data space. */
1137 u16 i_inline_off;
1138 u16 i_inline_size;
1139
Dmitry Monakhova9e7f442009-12-14 15:21:14 +03001140#ifdef CONFIG_QUOTA
1141 /* quota space reservation, managed internally by quota code */
1142 qsize_t i_reserved_quota;
1143#endif
Mingming Cao8d5d02e2009-09-28 15:48:29 -04001144
Jan Kara2e8fa542013-06-04 14:21:02 -04001145 /* Lock protecting lists below */
Jiaying Zhang744692d2010-03-04 16:14:02 -05001146 spinlock_t i_completed_io_lock;
Jan Kara2e8fa542013-06-04 14:21:02 -04001147 /*
1148 * Completed IOs that need unwritten extents handling and have
1149 * transaction reserved
1150 */
1151 struct list_head i_rsv_conversion_list;
Jan Kara2e8fa542013-06-04 14:21:02 -04001152 struct work_struct i_rsv_conversion_work;
Jan Kara600be302016-03-08 23:39:21 -05001153 atomic_t i_unwritten; /* Nr. of inflight conversions pending */
Theodore Ts'o8a2005d2011-01-10 12:13:42 -05001154
1155 spinlock_t i_block_reservation_lock;
Jan Karab436b9b2009-12-08 23:51:10 -05001156
1157 /*
1158 * Transactions that contain inode's metadata needed to complete
1159 * fsync and fdatasync, respectively.
1160 */
1161 tid_t i_sync_tid;
1162 tid_t i_datasync_tid;
Darrick J. Wong814525f2012-04-29 18:31:10 -04001163
Jan Kara96c7e0d2014-09-29 14:58:25 +02001164#ifdef CONFIG_QUOTA
1165 struct dquot *i_dquot[MAXQUOTAS];
1166#endif
1167
Darrick J. Wong814525f2012-04-29 18:31:10 -04001168 /* Precomputed uuid+inum+igen checksum for seeding inode checksums */
1169 __u32 i_csum_seed;
Michael Halcrowb30ab0e2015-04-12 00:43:56 -04001170
Li Xi040cb372016-01-08 16:01:21 -05001171 kprojid_t i_projid;
Theodore Ts'od444c3c2009-05-01 13:44:33 -04001172};
1173
1174/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001175 * File system states
1176 */
Mingming Cao617ba132006-10-11 01:20:53 -07001177#define EXT4_VALID_FS 0x0001 /* Unmounted cleanly */
1178#define EXT4_ERROR_FS 0x0002 /* Errors detected */
1179#define EXT4_ORPHAN_FS 0x0004 /* Orphans being recovered */
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07001180#define EXT4_FC_REPLAY 0x0020 /* Fast commit replay ongoing */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001181
1182/*
Theodore Tso469108f2008-02-10 01:11:44 -05001183 * Misc. filesystem flags
1184 */
1185#define EXT2_FLAGS_SIGNED_HASH 0x0001 /* Signed dirhash in use */
1186#define EXT2_FLAGS_UNSIGNED_HASH 0x0002 /* Unsigned dirhash in use */
1187#define EXT2_FLAGS_TEST_FILESYS 0x0004 /* to test development code */
1188
1189/*
Lukas Czerner68911002013-04-03 22:12:52 -04001190 * Mount flags set via mount options or defaults
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001191 */
Tahsin Erdogancdb7ee42017-06-22 11:55:14 -04001192#define EXT4_MOUNT_NO_MBCACHE 0x00001 /* Do not use mbcache */
Mingming Cao617ba132006-10-11 01:20:53 -07001193#define EXT4_MOUNT_GRPID 0x00004 /* Create files with directory's group */
1194#define EXT4_MOUNT_DEBUG 0x00008 /* Some debugging messages */
1195#define EXT4_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
1196#define EXT4_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
1197#define EXT4_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
Theodore Ts'o39ef17f2012-03-03 17:56:23 -05001198#define EXT4_MOUNT_ERRORS_MASK 0x00070
Mingming Cao617ba132006-10-11 01:20:53 -07001199#define EXT4_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
1200#define EXT4_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
Ross Zwisler923ae0f2015-02-16 15:59:38 -08001201#ifdef CONFIG_FS_DAX
Ira Weinyfc626fe2020-05-28 07:59:57 -07001202#define EXT4_MOUNT_DAX_ALWAYS 0x00200 /* Direct Access */
Ross Zwisler923ae0f2015-02-16 15:59:38 -08001203#else
Ira Weinyfc626fe2020-05-28 07:59:57 -07001204#define EXT4_MOUNT_DAX_ALWAYS 0
Ross Zwisler923ae0f2015-02-16 15:59:38 -08001205#endif
Mingming Cao617ba132006-10-11 01:20:53 -07001206#define EXT4_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
1207#define EXT4_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
1208#define EXT4_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
1209#define EXT4_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
1210#define EXT4_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
1211#define EXT4_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
1212#define EXT4_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
1213#define EXT4_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
Theodore Ts'oafd46722009-03-16 23:12:23 -04001214#define EXT4_MOUNT_NO_AUTO_DA_ALLOC 0x10000 /* No auto delalloc mapping */
Mingming Cao617ba132006-10-11 01:20:53 -07001215#define EXT4_MOUNT_BARRIER 0x20000 /* Use block barriers */
Jan Kara49da9392016-09-05 23:08:16 -04001216#define EXT4_MOUNT_QUOTA 0x40000 /* Some quota option set */
1217#define EXT4_MOUNT_USRQUOTA 0x80000 /* "old" user quota,
1218 * enable enforcement for hidden
1219 * quota files */
1220#define EXT4_MOUNT_GRPQUOTA 0x100000 /* "old" group quota, enable
1221 * enforcement for hidden quota
1222 * files */
1223#define EXT4_MOUNT_PRJQUOTA 0x200000 /* Enable project quota
1224 * enforcement */
Jiaying Zhang744692d2010-03-04 16:14:02 -05001225#define EXT4_MOUNT_DIOREAD_NOLOCK 0x400000 /* Enable support for dio read nolocking */
Linus Torvaldsd4da6c92009-11-02 10:15:27 -08001226#define EXT4_MOUNT_JOURNAL_CHECKSUM 0x800000 /* Journal checksums */
Girish Shilamkar818d2762008-01-28 23:58:27 -05001227#define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT 0x1000000 /* Journal Async Commit */
Theodore Ts'o327eaf72018-06-12 23:34:57 -04001228#define EXT4_MOUNT_WARN_ON_ERROR 0x2000000 /* Trigger WARN_ON on error */
Harshad Shirwadkar21175ca2021-04-01 10:21:29 -07001229#define EXT4_MOUNT_NO_PREFETCH_BLOCK_BITMAPS 0x4000000
Alex Tomas64769242008-07-11 19:27:31 -04001230#define EXT4_MOUNT_DELALLOC 0x8000000 /* Delalloc support */
Hidehiro Kawai5bf56832008-10-10 22:12:43 -04001231#define EXT4_MOUNT_DATA_ERR_ABORT 0x10000000 /* Abort on file data write */
Theodore Ts'o6fd058f2009-05-17 15:38:01 -04001232#define EXT4_MOUNT_BLOCK_VALIDITY 0x20000000 /* Block validity checking */
Eric Sandeen5328e632009-11-19 14:25:42 -05001233#define EXT4_MOUNT_DISCARD 0x40000000 /* Issue DISCARD requests */
Lukas Czernerbfff6872010-10-27 21:30:05 -04001234#define EXT4_MOUNT_INIT_INODE_TABLE 0x80000000 /* Initialize uninitialized itables */
Hidehiro Kawai5bf56832008-10-10 22:12:43 -04001235
Lukas Czerner68911002013-04-03 22:12:52 -04001236/*
1237 * Mount flags set either automatically (could not be set by mount option)
1238 * based on per file system feature or property or in special cases such as
1239 * distinguishing between explicit mount option definition and default.
1240 */
Theodore Ts'o56889782011-09-03 18:22:38 -04001241#define EXT4_MOUNT2_EXPLICIT_DELALLOC 0x00000001 /* User explicitly
1242 specified delalloc */
Lukas Czerner68911002013-04-03 22:12:52 -04001243#define EXT4_MOUNT2_STD_GROUP_SIZE 0x00000002 /* We have standard group
1244 size of blocksize * 8
1245 blocks */
Theodore Ts'oed3654e2014-03-24 14:09:06 -04001246#define EXT4_MOUNT2_HURD_COMPAT 0x00000004 /* Support HURD-castrated
1247 file systems */
Dmitry Monakhov1e381f62015-10-18 23:50:26 -04001248#define EXT4_MOUNT2_EXPLICIT_JOURNAL_CHECKSUM 0x00000008 /* User explicitly
1249 specified journal checksum */
1250
Harshad Shirwadkar995a3ed2020-10-15 13:37:54 -07001251#define EXT4_MOUNT2_JOURNAL_FAST_COMMIT 0x00000010 /* Journal fast commit */
Harshad Shirwadkara72b38ee2020-11-11 10:32:09 -08001252#define EXT4_MOUNT2_DAX_NEVER 0x00000020 /* Do not allow Direct Access */
1253#define EXT4_MOUNT2_DAX_INODE 0x00000040 /* For printing options only */
Harshad Shirwadkar196e4022021-04-01 10:21:27 -07001254#define EXT4_MOUNT2_MB_OPTIMIZE_SCAN 0x00000080 /* Optimize group
1255 * scanning in mballoc
1256 */
Harshad Shirwadkar995a3ed2020-10-15 13:37:54 -07001257
Theodore Ts'ofd8c37e2010-12-15 20:26:48 -05001258#define clear_opt(sb, opt) EXT4_SB(sb)->s_mount_opt &= \
1259 ~EXT4_MOUNT_##opt
1260#define set_opt(sb, opt) EXT4_SB(sb)->s_mount_opt |= \
1261 EXT4_MOUNT_##opt
Mingming Cao617ba132006-10-11 01:20:53 -07001262#define test_opt(sb, opt) (EXT4_SB(sb)->s_mount_opt & \
1263 EXT4_MOUNT_##opt)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001264
Theodore Ts'oa2595b82010-12-15 20:30:48 -05001265#define clear_opt2(sb, opt) EXT4_SB(sb)->s_mount_opt2 &= \
1266 ~EXT4_MOUNT2_##opt
1267#define set_opt2(sb, opt) EXT4_SB(sb)->s_mount_opt2 |= \
1268 EXT4_MOUNT2_##opt
1269#define test_opt2(sb, opt) (EXT4_SB(sb)->s_mount_opt2 & \
1270 EXT4_MOUNT2_##opt)
1271
Akinobu Mita597d5082011-12-28 20:32:07 -05001272#define ext4_test_and_set_bit __test_and_set_bit_le
1273#define ext4_set_bit __set_bit_le
Mingming Cao617ba132006-10-11 01:20:53 -07001274#define ext4_set_bit_atomic ext2_set_bit_atomic
Akinobu Mita597d5082011-12-28 20:32:07 -05001275#define ext4_test_and_clear_bit __test_and_clear_bit_le
1276#define ext4_clear_bit __clear_bit_le
Mingming Cao617ba132006-10-11 01:20:53 -07001277#define ext4_clear_bit_atomic ext2_clear_bit_atomic
Akinobu Mita50e01682011-03-23 16:42:07 -07001278#define ext4_test_bit test_bit_le
Akinobu Mita50e01682011-03-23 16:42:07 -07001279#define ext4_find_next_zero_bit find_next_zero_bit_le
1280#define ext4_find_next_bit find_next_bit_le
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001281
Yongqiang Yangc3e94d12011-07-26 22:05:53 -04001282extern void ext4_set_bits(void *bm, int cur, int len);
1283
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001284/*
1285 * Maximal mount counts between two filesystem checks
1286 */
Mingming Cao617ba132006-10-11 01:20:53 -07001287#define EXT4_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
1288#define EXT4_DFL_CHECKINTERVAL 0 /* Don't use interval check */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001289
1290/*
1291 * Behaviour when detecting errors
1292 */
Mingming Cao617ba132006-10-11 01:20:53 -07001293#define EXT4_ERRORS_CONTINUE 1 /* Continue execution */
1294#define EXT4_ERRORS_RO 2 /* Remount fs read-only */
1295#define EXT4_ERRORS_PANIC 3 /* Panic */
1296#define EXT4_ERRORS_DEFAULT EXT4_ERRORS_CONTINUE
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001297
Darrick J. Wonge6153912012-04-29 18:23:10 -04001298/* Metadata checksum algorithm codes */
1299#define EXT4_CRC32C_CHKSUM 1
1300
Lukas Czernerbbc605c2021-12-13 14:56:18 +01001301#define EXT4_LABEL_MAX 16
1302
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001303/*
1304 * Structure of the super block
1305 */
Mingming Cao617ba132006-10-11 01:20:53 -07001306struct ext4_super_block {
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001307/*00*/ __le32 s_inodes_count; /* Inodes count */
Aneesh Kumar K.V6bc9fef2007-10-16 18:38:25 -04001308 __le32 s_blocks_count_lo; /* Blocks count */
Aneesh Kumar K.V308ba3e2007-10-16 18:38:25 -04001309 __le32 s_r_blocks_count_lo; /* Reserved blocks count */
1310 __le32 s_free_blocks_count_lo; /* Free blocks count */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001311/*10*/ __le32 s_free_inodes_count; /* Free inodes count */
1312 __le32 s_first_data_block; /* First Data Block */
1313 __le32 s_log_block_size; /* Block size */
Theodore Ts'o281b5992011-09-09 18:34:51 -04001314 __le32 s_log_cluster_size; /* Allocation cluster size */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001315/*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
Theodore Ts'o281b5992011-09-09 18:34:51 -04001316 __le32 s_clusters_per_group; /* # Clusters per group */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001317 __le32 s_inodes_per_group; /* # Inodes per group */
1318 __le32 s_mtime; /* Mount time */
1319/*30*/ __le32 s_wtime; /* Write time */
1320 __le16 s_mnt_count; /* Mount count */
1321 __le16 s_max_mnt_count; /* Maximal mount count */
1322 __le16 s_magic; /* Magic signature */
1323 __le16 s_state; /* File system state */
1324 __le16 s_errors; /* Behaviour when detecting errors */
1325 __le16 s_minor_rev_level; /* minor revision level */
1326/*40*/ __le32 s_lastcheck; /* time of last check */
1327 __le32 s_checkinterval; /* max. time between checks */
1328 __le32 s_creator_os; /* OS */
1329 __le32 s_rev_level; /* Revision level */
1330/*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
1331 __le16 s_def_resgid; /* Default gid for reserved blocks */
1332 /*
Mingming Cao617ba132006-10-11 01:20:53 -07001333 * These fields are for EXT4_DYNAMIC_REV superblocks only.
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001334 *
1335 * Note: the difference between the compatible feature set and
1336 * the incompatible feature set is that if there is a bit set
1337 * in the incompatible feature set that the kernel doesn't
1338 * know about, it should refuse to mount the filesystem.
1339 *
1340 * e2fsck's requirements are more strict; if it doesn't know
1341 * about a feature in either the compatible or incompatible
1342 * feature set, it must abort and not try to meddle with
1343 * things it doesn't understand...
1344 */
1345 __le32 s_first_ino; /* First non-reserved inode */
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -07001346 __le16 s_inode_size; /* size of inode structure */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001347 __le16 s_block_group_nr; /* block group # of this superblock */
1348 __le32 s_feature_compat; /* compatible feature set */
1349/*60*/ __le32 s_feature_incompat; /* incompatible feature set */
1350 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
1351/*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
Lukas Czernerbbc605c2021-12-13 14:56:18 +01001352/*78*/ char s_volume_name[EXT4_LABEL_MAX]; /* volume name */
Theodore Ts'o072ebb32018-08-27 01:15:11 -04001353/*88*/ char s_last_mounted[64] __nonstring; /* directory where last mounted */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001354/*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
1355 /*
1356 * Performance hints. Directory preallocation should only
Mingming Cao617ba132006-10-11 01:20:53 -07001357 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001358 */
1359 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
1360 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
1361 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
1362 /*
Mingming Cao617ba132006-10-11 01:20:53 -07001363 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001364 */
1365/*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
1366/*E0*/ __le32 s_journal_inum; /* inode number of journal file */
1367 __le32 s_journal_dev; /* device number of journal file */
1368 __le32 s_last_orphan; /* start of list of inodes to delete */
1369 __le32 s_hash_seed[4]; /* HTREE hash seed */
1370 __u8 s_def_hash_version; /* Default hash version to use */
Theodore Ts'o89eeddf2010-07-27 11:56:04 -04001371 __u8 s_jnl_backup_type;
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -07001372 __le16 s_desc_size; /* size of group descriptor */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07001373/*100*/ __le32 s_default_mount_opts;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001374 __le32 s_first_meta_bg; /* First metablock block group */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07001375 __le32 s_mkfs_time; /* When the filesystem was created */
1376 __le32 s_jnl_blocks[17]; /* Backup of the journal inode */
1377 /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
1378/*150*/ __le32 s_blocks_count_hi; /* Blocks count */
1379 __le32 s_r_blocks_count_hi; /* Reserved blocks count */
1380 __le32 s_free_blocks_count_hi; /* Free blocks count */
Aneesh Kumar K.Vc1bddad2007-10-16 18:38:25 -04001381 __le16 s_min_extra_isize; /* All inodes have at least # bytes */
1382 __le16 s_want_extra_isize; /* New inodes should reserve # bytes */
1383 __le32 s_flags; /* Miscellaneous flags */
1384 __le16 s_raid_stride; /* RAID stride */
Johann Lombardic5e06d12011-05-24 18:31:25 -04001385 __le16 s_mmp_update_interval; /* # seconds to wait in MMP checking */
Aneesh Kumar K.Vc1bddad2007-10-16 18:38:25 -04001386 __le64 s_mmp_block; /* Block for multi-mount protection */
1387 __le32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
Jose R. Santos772cb7c2008-07-11 19:27:31 -04001388 __u8 s_log_groups_per_flex; /* FLEX_BG group size */
Darrick J. Wonge6153912012-04-29 18:23:10 -04001389 __u8 s_checksum_type; /* metadata checksum algorithm used */
Theodore Ts'of542fbe2015-04-11 07:44:12 -04001390 __u8 s_encryption_level; /* versioning level for encryption */
1391 __u8 s_reserved_pad; /* Padding to next 32bits */
Theodore Ts'oafc32f72009-02-28 19:39:58 -05001392 __le64 s_kbytes_written; /* nr of lifetime kilobytes written */
Theodore Ts'o4a9cdec2010-06-29 11:00:23 -04001393 __le32 s_snapshot_inum; /* Inode number of active snapshot */
1394 __le32 s_snapshot_id; /* sequential ID of active snapshot */
1395 __le64 s_snapshot_r_blocks_count; /* reserved blocks for active
1396 snapshot's future use */
1397 __le32 s_snapshot_list; /* inode number of the head of the
1398 on-disk snapshot list */
Theodore Ts'o1c13d5c2010-07-27 11:56:03 -04001399#define EXT4_S_ERR_START offsetof(struct ext4_super_block, s_error_count)
1400 __le32 s_error_count; /* number of fs errors */
1401 __le32 s_first_error_time; /* first time an error happened */
1402 __le32 s_first_error_ino; /* inode involved in first error */
1403 __le64 s_first_error_block; /* block involved of first error */
Theodore Ts'o072ebb32018-08-27 01:15:11 -04001404 __u8 s_first_error_func[32] __nonstring; /* function where the error happened */
Theodore Ts'o1c13d5c2010-07-27 11:56:03 -04001405 __le32 s_first_error_line; /* line number where error happened */
1406 __le32 s_last_error_time; /* most recent time of an error */
1407 __le32 s_last_error_ino; /* inode involved in last error */
1408 __le32 s_last_error_line; /* line number where error happened */
1409 __le64 s_last_error_block; /* block involved of last error */
Theodore Ts'o072ebb32018-08-27 01:15:11 -04001410 __u8 s_last_error_func[32] __nonstring; /* function where the error happened */
Theodore Ts'o8b67f042010-08-01 23:14:20 -04001411#define EXT4_S_ERR_END offsetof(struct ext4_super_block, s_mount_opts)
1412 __u8 s_mount_opts[64];
Theodore Ts'o281b5992011-09-09 18:34:51 -04001413 __le32 s_usr_quota_inum; /* inode for tracking user quota */
1414 __le32 s_grp_quota_inum; /* inode for tracking group quota */
1415 __le32 s_overhead_clusters; /* overhead blocks/clusters in fs */
Darrick J. Wong1beeef12014-05-12 10:16:06 -04001416 __le32 s_backup_bgs[2]; /* groups with sparse_super2 SBs */
Theodore Ts'o3edc18d2015-01-19 16:00:58 -05001417 __u8 s_encrypt_algos[4]; /* Encryption algorithms in use */
Theodore Ts'of542fbe2015-04-11 07:44:12 -04001418 __u8 s_encrypt_pw_salt[16]; /* Salt used for string2key algorithm */
1419 __le32 s_lpf_ino; /* Location of the lost+found inode */
Theodore Ts'o8b4953e2015-10-17 16:15:18 -04001420 __le32 s_prj_quota_inum; /* inode for tracking project quota */
Darrick J. Wong8c81bd82015-10-17 16:16:02 -04001421 __le32 s_checksum_seed; /* crc32c(uuid) if csum_seed set */
Arnd Bergmann6a0678a2018-07-29 15:51:48 -04001422 __u8 s_wtime_hi;
1423 __u8 s_mtime_hi;
1424 __u8 s_mkfs_time_hi;
1425 __u8 s_lastcheck_hi;
1426 __u8 s_first_error_time_hi;
1427 __u8 s_last_error_time_hi;
Theodore Ts'o878520a2019-11-19 21:54:15 -05001428 __u8 s_first_error_errcode;
1429 __u8 s_last_error_errcode;
Gabriel Krisman Bertazic83ad552019-04-25 14:05:42 -04001430 __le16 s_encoding; /* Filename charset encoding */
1431 __le16 s_encoding_flags; /* Filename charset encoding flags */
Jan Kara02f310f2021-08-16 11:57:06 +02001432 __le32 s_orphan_file_inum; /* Inode for tracking orphan inodes */
1433 __le32 s_reserved[94]; /* Padding to the end of the block */
Darrick J. Wonge6153912012-04-29 18:23:10 -04001434 __le32 s_checksum; /* crc32c(superblock) */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001435};
1436
Theodore Ts'o1c13d5c2010-07-27 11:56:03 -04001437#define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
1438
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001439#ifdef __KERNEL__
Theodore Ts'obc0b0d62009-06-13 10:09:48 -04001440
Chandan Rajendra643fa962018-12-12 15:20:12 +05301441#ifdef CONFIG_FS_ENCRYPTION
Eric Biggersac4acb12020-09-16 21:11:35 -07001442#define DUMMY_ENCRYPTION_ENABLED(sbi) ((sbi)->s_dummy_enc_policy.policy != NULL)
Theodore Ts'o6ddb2442015-04-16 01:56:00 -04001443#else
1444#define DUMMY_ENCRYPTION_ENABLED(sbi) (0)
1445#endif
Theodore Ts'obc0b0d62009-06-13 10:09:48 -04001446
Jan Karaa2d4a642014-09-11 11:15:15 -04001447/* Number of quota types we support */
Li Xi689c9582016-01-08 16:01:22 -05001448#define EXT4_MAXQUOTAS 3
Jan Karaa2d4a642014-09-11 11:15:15 -04001449
Gabriel Krisman Bertazic83ad552019-04-25 14:05:42 -04001450#define EXT4_ENC_UTF8_12_1 1
1451
Jan Kara188c2992021-08-16 11:57:04 +02001452/* Types of ext4 journal triggers */
1453enum ext4_journal_trigger_type {
Jan Kara02f310f2021-08-16 11:57:06 +02001454 EXT4_JTR_ORPHAN_FILE,
Jan Kara188c2992021-08-16 11:57:04 +02001455 EXT4_JTR_NONE /* This must be the last entry for indexing to work! */
1456};
1457
1458#define EXT4_JOURNAL_TRIGGER_COUNT EXT4_JTR_NONE
1459
1460struct ext4_journal_trigger {
1461 struct jbd2_buffer_trigger_type tr_triggers;
1462 struct super_block *sb;
1463};
1464
1465static inline struct ext4_journal_trigger *EXT4_TRIGGER(
1466 struct jbd2_buffer_trigger_type *trigger)
1467{
1468 return container_of(trigger, struct ext4_journal_trigger, tr_triggers);
1469}
1470
Jan Kara02f310f2021-08-16 11:57:06 +02001471#define EXT4_ORPHAN_BLOCK_MAGIC 0x0b10ca04
1472
1473/* Structure at the tail of orphan block */
1474struct ext4_orphan_block_tail {
1475 __le32 ob_magic;
1476 __le32 ob_checksum;
1477};
1478
1479static inline int ext4_inodes_per_orphan_block(struct super_block *sb)
1480{
1481 return (sb->s_blocksize - sizeof(struct ext4_orphan_block_tail)) /
1482 sizeof(u32);
1483}
1484
1485struct ext4_orphan_block {
Jan Kara4a79a982021-08-16 11:57:08 +02001486 atomic_t ob_free_entries; /* Number of free orphan entries in block */
Jan Kara02f310f2021-08-16 11:57:06 +02001487 struct buffer_head *ob_bh; /* Buffer for orphan block */
1488};
1489
1490/*
1491 * Info about orphan file.
1492 */
1493struct ext4_orphan_info {
Jan Kara02f310f2021-08-16 11:57:06 +02001494 int of_blocks; /* Number of orphan blocks in a file */
1495 __u32 of_csum_seed; /* Checksum seed for orphan file */
1496 struct ext4_orphan_block *of_binfo; /* Array with info about orphan
1497 * file blocks */
1498};
1499
Gabriel Krisman Bertazic83ad552019-04-25 14:05:42 -04001500/*
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001501 * fourth extended-fs super-block data in memory
1502 */
1503struct ext4_sb_info {
1504 unsigned long s_desc_size; /* Size of a group descriptor in bytes */
1505 unsigned long s_inodes_per_block;/* Number of inodes per block */
1506 unsigned long s_blocks_per_group;/* Number of blocks in a group */
Theodore Ts'o281b5992011-09-09 18:34:51 -04001507 unsigned long s_clusters_per_group; /* Number of clusters in a group */
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001508 unsigned long s_inodes_per_group;/* Number of inodes in a group */
1509 unsigned long s_itb_per_group; /* Number of inode table blocks per group */
1510 unsigned long s_gdb_count; /* Number of group descriptor blocks */
1511 unsigned long s_desc_per_block; /* Number of group descriptors per block */
1512 ext4_group_t s_groups_count; /* Number of groups in the fs */
Eric Sandeenfb0a3872009-09-16 14:45:10 -04001513 ext4_group_t s_blockfile_groups;/* Groups acceptable for non-extent files */
Theodore Ts'o952fc182012-07-09 16:27:05 -04001514 unsigned long s_overhead; /* # of fs overhead clusters */
Theodore Ts'o281b5992011-09-09 18:34:51 -04001515 unsigned int s_cluster_ratio; /* Number of blocks per cluster */
1516 unsigned int s_cluster_bits; /* log2 of s_cluster_ratio */
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001517 loff_t s_bitmap_maxbytes; /* max bytes for bitmap files */
1518 struct buffer_head * s_sbh; /* Buffer containing the super block */
1519 struct ext4_super_block *s_es; /* Pointer to the super block in the buffer */
Theodore Ts'o1d0c3922020-02-15 16:40:37 -05001520 struct buffer_head * __rcu *s_group_desc;
Theodore Ts'o7f4520c2009-06-13 10:09:41 -04001521 unsigned int s_mount_opt;
Theodore Ts'oa2595b82010-12-15 20:30:48 -05001522 unsigned int s_mount_opt2;
Harshad Shirwadkar9b5f6c92020-11-05 19:59:09 -08001523 unsigned long s_mount_flags;
Theodore Ts'o5a916be2012-03-04 19:27:31 -05001524 unsigned int s_def_mount_opt;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001525 ext4_fsblk_t s_sb_block;
Lukas Czerner27dd4382013-04-09 22:11:22 -04001526 atomic64_t s_resv_clusters;
Eric W. Biederman08cefc72012-02-07 15:41:49 -08001527 kuid_t s_resuid;
1528 kgid_t s_resgid;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001529 unsigned short s_mount_state;
1530 unsigned short s_pad;
1531 int s_addr_per_block_bits;
1532 int s_desc_per_block_bits;
1533 int s_inode_size;
1534 int s_first_ino;
1535 unsigned int s_inode_readahead_blks;
Andreas Dilger11013912009-06-13 11:45:35 -04001536 unsigned int s_inode_goal;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001537 u32 s_hash_seed[4];
1538 int s_def_hash_version;
Eric Biggers6d2424a2021-05-27 16:55:57 -07001539 int s_hash_unsigned; /* 3 if hash should be unsigned, 0 if not */
Theodore Ts'o57042652011-09-09 18:56:51 -04001540 struct percpu_counter s_freeclusters_counter;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001541 struct percpu_counter s_freeinodes_counter;
1542 struct percpu_counter s_dirs_counter;
Theodore Ts'o57042652011-09-09 18:56:51 -04001543 struct percpu_counter s_dirtyclusters_counter;
Eric Whitneyefc61342021-02-18 10:11:32 -05001544 struct percpu_counter s_sra_exceeded_retry_limit;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001545 struct blockgroup_lock *s_blockgroup_lock;
1546 struct proc_dir_entry *s_proc;
1547 struct kobject s_kobj;
1548 struct completion s_kobj_unregister;
Theodore Ts'o2c0544b2012-05-30 22:56:46 -04001549 struct super_block *s_sb;
Pavel Skripkin618f0032021-04-30 21:50:46 +03001550 struct buffer_head *s_mmp_bh;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001551
1552 /* Journaling */
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001553 struct journal_s *s_journal;
Theodore Ts'o9549a162017-02-05 01:27:48 -05001554 unsigned long s_ext4_flags; /* Ext4 superblock flags */
Jan Kara02f310f2021-08-16 11:57:06 +02001555 struct mutex s_orphan_lock; /* Protects on disk list changes */
1556 struct list_head s_orphan; /* List of orphaned inodes in on disk
1557 list */
1558 struct ext4_orphan_info s_orphan_info;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001559 unsigned long s_commit_interval;
1560 u32 s_max_batch_time;
1561 u32 s_min_batch_time;
Chunguang Xuee7ed3a2020-09-24 11:03:42 +08001562 struct block_device *s_journal_bdev;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001563#ifdef CONFIG_QUOTA
Theodore Ts'o33458ea2018-10-12 09:28:09 -04001564 /* Names of quota files with journalled quota */
1565 char __rcu *s_qf_names[EXT4_MAXQUOTAS];
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001566 int s_jquota_fmt; /* Format of quota to use */
1567#endif
1568 unsigned int s_want_extra_isize; /* New inodes should reserve # bytes */
Chunguang Xudd0db942020-09-24 11:03:43 +08001569 struct ext4_system_blocks __rcu *s_system_blks;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001570
1571#ifdef EXTENTS_STATS
1572 /* ext4 extents stats */
1573 unsigned long s_ext_min;
1574 unsigned long s_ext_max;
1575 unsigned long s_depth_max;
1576 spinlock_t s_ext_stats_lock;
1577 unsigned long s_ext_blocks;
1578 unsigned long s_ext_extents;
1579#endif
1580
1581 /* for buddy allocator */
Suraj Jitindar Singhdf3da4e2020-02-18 19:08:50 -08001582 struct ext4_group_info ** __rcu *s_group_info;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001583 struct inode *s_buddy_cache;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001584 spinlock_t s_md_lock;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001585 unsigned short *s_mb_offsets;
1586 unsigned int *s_mb_maxs;
Theodore Ts'o28623c22012-09-05 01:31:50 -04001587 unsigned int s_group_info_size;
Theodore Ts'od08854f2016-06-26 18:24:01 -04001588 unsigned int s_mb_free_pending;
Daeho Jeonga0154342017-06-22 23:54:33 -04001589 struct list_head s_freed_data_list; /* List of blocks to be freed
1590 after commit completed */
Wang Jianchao55cdd0a2021-07-24 15:41:23 +08001591 struct list_head s_discard_list;
1592 struct work_struct s_discard_work;
Wang Jianchao5036ab82021-08-30 15:52:46 +08001593 atomic_t s_retry_alloc_pending;
Harshad Shirwadkar196e4022021-04-01 10:21:27 -07001594 struct rb_root s_mb_avg_fragment_size_root;
1595 rwlock_t s_mb_rb_lock;
1596 struct list_head *s_mb_largest_free_orders;
1597 rwlock_t *s_mb_largest_free_orders_locks;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001598
1599 /* tunables */
1600 unsigned long s_stripe;
Harshad Shirwadkar196e4022021-04-01 10:21:27 -07001601 unsigned int s_mb_max_linear_groups;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001602 unsigned int s_mb_stream_request;
1603 unsigned int s_mb_max_to_scan;
1604 unsigned int s_mb_min_to_scan;
1605 unsigned int s_mb_stats;
1606 unsigned int s_mb_order2_reqs;
1607 unsigned int s_mb_group_prealloc;
brookxu27bc4462020-08-17 15:36:15 +08001608 unsigned int s_mb_max_inode_prealloc;
Theodore Ts'odf981d02012-08-17 09:48:17 -04001609 unsigned int s_max_dir_size_kb;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001610 /* where last allocation was done - for stream allocation */
1611 unsigned long s_mb_last_group;
1612 unsigned long s_mb_last_start;
Alex Zhuravlevcfd73232020-04-21 10:54:07 +03001613 unsigned int s_mb_prefetch;
1614 unsigned int s_mb_prefetch_limit;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001615
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001616 /* stats for buddy allocator */
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001617 atomic_t s_bal_reqs; /* number of reqs with len > 1 */
1618 atomic_t s_bal_success; /* we found long enough chunks */
1619 atomic_t s_bal_allocated; /* in blocks */
1620 atomic_t s_bal_ex_scanned; /* total extents scanned */
Harshad Shirwadkara6c75ea2021-04-01 10:21:25 -07001621 atomic_t s_bal_groups_scanned; /* number of groups scanned */
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001622 atomic_t s_bal_goals; /* goal hits */
1623 atomic_t s_bal_breaks; /* too long searches */
1624 atomic_t s_bal_2orders; /* 2^order hits */
Harshad Shirwadkar196e4022021-04-01 10:21:27 -07001625 atomic_t s_bal_cr0_bad_suggestions;
1626 atomic_t s_bal_cr1_bad_suggestions;
Harshad Shirwadkara6c75ea2021-04-01 10:21:25 -07001627 atomic64_t s_bal_cX_groups_considered[4];
1628 atomic64_t s_bal_cX_hits[4];
1629 atomic64_t s_bal_cX_failed[4]; /* cX loop didn't find blocks */
Harshad Shirwadkar67d25182021-04-01 10:21:23 -07001630 atomic_t s_mb_buddies_generated; /* number of buddies generated */
1631 atomic64_t s_mb_generation_time;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001632 atomic_t s_mb_lost_chunks;
1633 atomic_t s_mb_preallocated;
1634 atomic_t s_mb_discarded;
Theodore Ts'o50797482009-09-18 13:34:02 -04001635 atomic_t s_lock_busy;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001636
1637 /* locality groups */
Tejun Heo003cb602010-02-02 14:39:01 +09001638 struct ext4_locality_group __percpu *s_locality_groups;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001639
1640 /* for write statistics */
1641 unsigned long s_sectors_written_start;
1642 u64 s_kbytes_written;
1643
Zheng Liu67a5da52012-08-17 09:54:17 -04001644 /* the size of zero-out chunk */
1645 unsigned int s_extent_max_zeroout_kb;
1646
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001647 unsigned int s_log_groups_per_flex;
Suraj Jitindar Singh7c990722020-02-18 19:08:51 -08001648 struct flex_groups * __rcu *s_flex_groups;
Theodore Ts'o117fff12012-09-05 01:29:50 -04001649 ext4_group_t s_flex_groups_allocated;
Mingming Cao4c0425f2009-09-28 15:48:41 -04001650
Jan Kara2e8fa542013-06-04 14:21:02 -04001651 /* workqueue for reserved extent conversions (buffered io) */
1652 struct workqueue_struct *rsv_conversion_wq;
Theodore Ts'o66e61a92010-07-27 11:56:04 -04001653
1654 /* timer for periodic error stats printing */
1655 struct timer_list s_err_report;
Lukas Czernerbfff6872010-10-27 21:30:05 -04001656
1657 /* Lazy inode table initialization info */
1658 struct ext4_li_request *s_li_request;
1659 /* Wait multiplier for lazy initialization thread */
1660 unsigned int s_li_wait_mult;
Johann Lombardic5e06d12011-05-24 18:31:25 -04001661
1662 /* Kernel thread for multiple mount protection */
1663 struct task_struct *s_mmp_tsk;
Tao Ma3d56b8d2011-07-11 00:03:38 -04001664
1665 /* record the last minlen when FITRIM is called. */
Lukas Czerner2327fb22021-11-03 15:51:21 +01001666 unsigned long s_last_trim_minblks;
Darrick J. Wong04419842012-04-29 18:27:10 -04001667
1668 /* Reference to checksum algorithm driver via cryptoapi */
1669 struct crypto_shash *s_chksum_driver;
Darrick J. Wonga9c473172012-04-29 18:29:10 -04001670
1671 /* Precomputed FS UUID checksum for seeding other checksums */
1672 __u32 s_csum_seed;
Zheng Liu74cd15c2013-02-18 00:32:55 -05001673
1674 /* Reclaim extents from extent status tree */
1675 struct shrinker s_es_shrinker;
Jan Karadd475922014-11-25 11:51:23 -05001676 struct list_head s_es_list; /* List of inodes with reclaimable extents */
Zheng Liuedaa53c2014-11-25 11:45:37 -05001677 long s_es_nr_inode;
Zheng Liueb68d0e2014-09-01 22:26:49 -04001678 struct ext4_es_stats s_es_stats;
Tahsin Erdogan47387402017-06-22 11:28:55 -04001679 struct mb_cache *s_ea_block_cache;
Tahsin Erdogandec214d2017-06-22 11:44:55 -04001680 struct mb_cache *s_ea_inode_cache;
Zheng Liuedaa53c2014-11-25 11:45:37 -05001681 spinlock_t s_es_lock ____cacheline_aligned_in_smp;
Theodore Ts'oefbed4d2013-10-17 21:11:01 -04001682
Jan Kara188c2992021-08-16 11:57:04 +02001683 /* Journal triggers for checksum computation */
1684 struct ext4_journal_trigger s_journal_triggers[EXT4_JOURNAL_TRIGGER_COUNT];
1685
Theodore Ts'oefbed4d2013-10-17 21:11:01 -04001686 /* Ratelimit ext4 messages. */
1687 struct ratelimit_state s_err_ratelimit_state;
1688 struct ratelimit_state s_warning_ratelimit_state;
1689 struct ratelimit_state s_msg_ratelimit_state;
Dmitry Monakhov1cf006e2020-07-25 12:33:13 +00001690 atomic_t s_warning_count;
1691 atomic_t s_msg_count;
Daeho Jeongc8585c62016-04-25 23:22:35 -04001692
Eric Biggersac4acb12020-09-16 21:11:35 -07001693 /* Encryption policy for '-o test_dummy_encryption' */
1694 struct fscrypt_dummy_policy s_dummy_enc_policy;
Eric Biggersed318a62020-05-12 16:32:50 -07001695
Eric Biggerscb85f4d2020-02-19 10:30:47 -08001696 /*
1697 * Barrier between writepages ops and changing any inode's JOURNAL_DATA
1698 * or EXTENTS flag.
1699 */
Eric Biggersbbd55932020-02-19 10:30:46 -08001700 struct percpu_rw_semaphore s_writepages_rwsem;
Dan Williams5e405592017-08-24 16:42:48 -07001701 struct dax_device *s_daxdev;
Christoph Hellwigcd913c72021-11-29 11:21:59 +01001702 u64 s_dax_part_off;
Theodore Ts'o46f870d62019-11-21 13:09:43 -05001703#ifdef CONFIG_EXT4_DEBUG
1704 unsigned long s_simulate_fail;
1705#endif
zhangyi (F)bc717262020-06-20 10:54:23 +08001706 /* Record the errseq of the backing block device */
1707 errseq_t s_bdev_wb_err;
1708 spinlock_t s_bdev_wb_lock;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001709
Jan Karac92dc852020-11-27 12:34:00 +01001710 /* Information about errors that happened during this mount */
1711 spinlock_t s_error_lock;
1712 int s_add_error_count;
1713 int s_first_error_code;
1714 __u32 s_first_error_line;
1715 __u32 s_first_error_ino;
1716 __u64 s_first_error_block;
1717 const char *s_first_error_func;
1718 time64_t s_first_error_time;
1719 int s_last_error_code;
1720 __u32 s_last_error_line;
1721 __u32 s_last_error_ino;
1722 __u64 s_last_error_block;
1723 const char *s_last_error_func;
1724 time64_t s_last_error_time;
1725 /*
1726 * If we are in a context where we cannot update error information in
1727 * the on-disk superblock, we queue this work to do it.
1728 */
1729 struct work_struct s_error_work;
1730
Harshad Shirwadkar7bbbe242021-12-23 12:21:38 -08001731 /* Ext4 fast commit sub transaction ID */
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001732 atomic_t s_fc_subtid;
Harshad Shirwadkar7bbbe242021-12-23 12:21:38 -08001733
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001734 /*
1735 * After commit starts, the main queue gets locked, and the further
1736 * updates get added in the staging queue.
1737 */
1738#define FC_Q_MAIN 0
1739#define FC_Q_STAGING 1
1740 struct list_head s_fc_q[2]; /* Inodes staged for fast commit
1741 * that have data changes in them.
1742 */
1743 struct list_head s_fc_dentry_q[2]; /* directory entry updates */
1744 unsigned int s_fc_bytes;
1745 /*
1746 * Main fast commit lock. This lock protects accesses to the
1747 * following fields:
1748 * ei->i_fc_list, s_fc_dentry_q, s_fc_q, s_fc_bytes, s_fc_bh.
1749 */
1750 spinlock_t s_fc_lock;
1751 struct buffer_head *s_fc_bh;
1752 struct ext4_fc_stats s_fc_stats;
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07001753#ifdef CONFIG_EXT4_DEBUG
1754 int s_fc_debug_max_replay;
1755#endif
1756 struct ext4_fc_replay_state s_fc_replay_state;
Theodore Ts'oca0faba2009-05-03 16:33:44 -04001757};
1758
Theodore Ts'oaf5bc922008-09-08 22:25:24 -04001759static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001760{
1761 return sb->s_fs_info;
1762}
Mingming Cao617ba132006-10-11 01:20:53 -07001763static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001764{
Mingming Cao617ba132006-10-11 01:20:53 -07001765 return container_of(inode, struct ext4_inode_info, vfs_inode);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001766}
1767
Mingming Cao617ba132006-10-11 01:20:53 -07001768static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001769{
Mingming Cao617ba132006-10-11 01:20:53 -07001770 return ino == EXT4_ROOT_INO ||
Mingming Cao617ba132006-10-11 01:20:53 -07001771 (ino >= EXT4_FIRST_INO(sb) &&
1772 ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001773}
Theodore Ts'o19f5fb72010-01-24 14:34:07 -05001774
1775/*
Theodore Ts'o1d0c3922020-02-15 16:40:37 -05001776 * Returns: sbi->field[index]
1777 * Used to access an array element from the following sbi fields which require
1778 * rcu protection to avoid dereferencing an invalid pointer due to reassignment
1779 * - s_group_desc
1780 * - s_group_info
1781 * - s_flex_group
1782 */
1783#define sbi_array_rcu_deref(sbi, field, index) \
1784({ \
1785 typeof(*((sbi)->field)) _v; \
1786 rcu_read_lock(); \
1787 _v = ((typeof(_v)*)rcu_dereference((sbi)->field))[index]; \
1788 rcu_read_unlock(); \
1789 _v; \
1790})
1791
1792/*
Harshad Shirwadkar9b5f6c92020-11-05 19:59:09 -08001793 * run-time mount flags
1794 */
1795enum {
1796 EXT4_MF_MNTDIR_SAMPLED,
1797 EXT4_MF_FS_ABORTED, /* Fatal error detected */
1798 EXT4_MF_FC_INELIGIBLE, /* Fast commit ineligible */
1799 EXT4_MF_FC_COMMITTING /* File system underoing a fast
1800 * commit.
1801 */
1802};
1803
1804static inline void ext4_set_mount_flag(struct super_block *sb, int bit)
1805{
1806 set_bit(bit, &EXT4_SB(sb)->s_mount_flags);
1807}
1808
1809static inline void ext4_clear_mount_flag(struct super_block *sb, int bit)
1810{
1811 clear_bit(bit, &EXT4_SB(sb)->s_mount_flags);
1812}
1813
1814static inline int ext4_test_mount_flag(struct super_block *sb, int bit)
1815{
1816 return test_bit(bit, &EXT4_SB(sb)->s_mount_flags);
1817}
1818
1819
1820/*
Theodore Ts'o46f870d62019-11-21 13:09:43 -05001821 * Simulate_fail codes
1822 */
1823#define EXT4_SIM_BBITMAP_EIO 1
1824#define EXT4_SIM_BBITMAP_CRC 2
1825#define EXT4_SIM_IBITMAP_EIO 3
1826#define EXT4_SIM_IBITMAP_CRC 4
1827#define EXT4_SIM_INODE_EIO 5
1828#define EXT4_SIM_INODE_CRC 6
1829#define EXT4_SIM_DIRBLOCK_EIO 7
1830#define EXT4_SIM_DIRBLOCK_CRC 8
1831
1832static inline bool ext4_simulate_fail(struct super_block *sb,
1833 unsigned long code)
1834{
1835#ifdef CONFIG_EXT4_DEBUG
1836 struct ext4_sb_info *sbi = EXT4_SB(sb);
1837
1838 if (unlikely(sbi->s_simulate_fail == code)) {
1839 sbi->s_simulate_fail = 0;
1840 return true;
1841 }
1842#endif
1843 return false;
1844}
1845
1846static inline void ext4_simulate_fail_bh(struct super_block *sb,
1847 struct buffer_head *bh,
1848 unsigned long code)
1849{
1850 if (!IS_ERR(bh) && ext4_simulate_fail(sb, code))
1851 clear_buffer_uptodate(bh);
1852}
1853
1854/*
Theodore Ts'o878520a2019-11-19 21:54:15 -05001855 * Error number codes for s_{first,last}_error_errno
1856 *
1857 * Linux errno numbers are architecture specific, so we need to translate
1858 * them into something which is architecture independent. We don't define
1859 * codes for all errno's; just the ones which are most likely to be the cause
1860 * of an ext4_error() call.
1861 */
1862#define EXT4_ERR_UNKNOWN 1
1863#define EXT4_ERR_EIO 2
1864#define EXT4_ERR_ENOMEM 3
1865#define EXT4_ERR_EFSBADCRC 4
1866#define EXT4_ERR_EFSCORRUPTED 5
1867#define EXT4_ERR_ENOSPC 6
1868#define EXT4_ERR_ENOKEY 7
1869#define EXT4_ERR_EROFS 8
1870#define EXT4_ERR_EFBIG 9
1871#define EXT4_ERR_EEXIST 10
1872#define EXT4_ERR_ERANGE 11
1873#define EXT4_ERR_EOVERFLOW 12
1874#define EXT4_ERR_EBUSY 13
1875#define EXT4_ERR_ENOTDIR 14
1876#define EXT4_ERR_ENOTEMPTY 15
1877#define EXT4_ERR_ESHUTDOWN 16
1878#define EXT4_ERR_EFAULT 17
1879
1880/*
Theodore Ts'o19f5fb72010-01-24 14:34:07 -05001881 * Inode dynamic state flags
1882 */
1883enum {
1884 EXT4_STATE_JDATA, /* journaled data exists */
1885 EXT4_STATE_NEW, /* inode is newly created */
1886 EXT4_STATE_XATTR, /* has in-inode xattrs */
1887 EXT4_STATE_NO_EXPAND, /* No space for expansion */
1888 EXT4_STATE_DA_ALLOC_CLOSE, /* Alloc DA blks on close */
1889 EXT4_STATE_EXT_MIGRATE, /* Inode is migrating */
Frank Mayhar14ece102010-05-17 08:00:00 -04001890 EXT4_STATE_NEWENTRY, /* File just added to dir */
Tao Ma67cf5b02012-12-10 14:04:46 -05001891 EXT4_STATE_MAY_INLINE_DATA, /* may have in-inode data */
Theodore Ts'o7869a4a2013-08-16 22:05:14 -04001892 EXT4_STATE_EXT_PRECACHED, /* extents have been precached */
Tahsin Erdogana6d05672017-08-24 14:25:02 -04001893 EXT4_STATE_LUSTRE_EA_INODE, /* Lustre-style ea_inode */
Eric Biggersc93d8f82019-07-22 09:26:24 -07001894 EXT4_STATE_VERITY_IN_PROGRESS, /* building fs-verity Merkle tree */
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001895 EXT4_STATE_FC_COMMITTING, /* Fast commit ongoing */
Jan Kara02f310f2021-08-16 11:57:06 +02001896 EXT4_STATE_ORPHAN_FILE, /* Inode orphaned in orphan file */
Theodore Ts'o19f5fb72010-01-24 14:34:07 -05001897};
1898
Theodore Ts'o353eb832011-01-10 12:18:25 -05001899#define EXT4_INODE_BIT_FNS(name, field, offset) \
Dmitry Monakhov12e9b892010-05-16 22:00:00 -04001900static inline int ext4_test_inode_##name(struct inode *inode, int bit) \
1901{ \
Theodore Ts'o353eb832011-01-10 12:18:25 -05001902 return test_bit(bit + (offset), &EXT4_I(inode)->i_##field); \
Dmitry Monakhov12e9b892010-05-16 22:00:00 -04001903} \
1904static inline void ext4_set_inode_##name(struct inode *inode, int bit) \
1905{ \
Theodore Ts'o353eb832011-01-10 12:18:25 -05001906 set_bit(bit + (offset), &EXT4_I(inode)->i_##field); \
Dmitry Monakhov12e9b892010-05-16 22:00:00 -04001907} \
1908static inline void ext4_clear_inode_##name(struct inode *inode, int bit) \
1909{ \
Theodore Ts'o353eb832011-01-10 12:18:25 -05001910 clear_bit(bit + (offset), &EXT4_I(inode)->i_##field); \
Theodore Ts'o19f5fb72010-01-24 14:34:07 -05001911}
1912
Andreas Dilger3f61c0c2013-11-11 22:40:40 -05001913/* Add these declarations here only so that these functions can be
1914 * found by name. Otherwise, they are very hard to locate. */
1915static inline int ext4_test_inode_flag(struct inode *inode, int bit);
1916static inline void ext4_set_inode_flag(struct inode *inode, int bit);
1917static inline void ext4_clear_inode_flag(struct inode *inode, int bit);
Theodore Ts'o353eb832011-01-10 12:18:25 -05001918EXT4_INODE_BIT_FNS(flag, flags, 0)
Andreas Dilger3f61c0c2013-11-11 22:40:40 -05001919
1920/* Add these declarations here only so that these functions can be
1921 * found by name. Otherwise, they are very hard to locate. */
1922static inline int ext4_test_inode_state(struct inode *inode, int bit);
1923static inline void ext4_set_inode_state(struct inode *inode, int bit);
1924static inline void ext4_clear_inode_state(struct inode *inode, int bit);
Theodore Ts'o353eb832011-01-10 12:18:25 -05001925#if (BITS_PER_LONG < 64)
1926EXT4_INODE_BIT_FNS(state, state_flags, 0)
1927
1928static inline void ext4_clear_state_flags(struct ext4_inode_info *ei)
1929{
1930 (ei)->i_state_flags = 0;
1931}
1932#else
1933EXT4_INODE_BIT_FNS(state, flags, 32)
1934
1935static inline void ext4_clear_state_flags(struct ext4_inode_info *ei)
1936{
1937 /* We depend on the fact that callers will set i_flags */
1938}
1939#endif
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001940#else
Mingming Cao617ba132006-10-11 01:20:53 -07001941/* Assume that user mode programs are passing in an ext4fs superblock, not
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001942 * a kernel struct super_block. This will allow us to call the feature-test
1943 * macros from user land. */
Mingming Cao617ba132006-10-11 01:20:53 -07001944#define EXT4_SB(sb) (sb)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001945#endif
1946
Eric Biggersc93d8f82019-07-22 09:26:24 -07001947static inline bool ext4_verity_in_progress(struct inode *inode)
1948{
1949 return IS_ENABLED(CONFIG_FS_VERITY) &&
1950 ext4_test_inode_state(inode, EXT4_STATE_VERITY_IN_PROGRESS);
1951}
1952
Mingming Cao617ba132006-10-11 01:20:53 -07001953#define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001954
1955/*
1956 * Codes for operating systems
1957 */
Mingming Cao617ba132006-10-11 01:20:53 -07001958#define EXT4_OS_LINUX 0
1959#define EXT4_OS_HURD 1
1960#define EXT4_OS_MASIX 2
1961#define EXT4_OS_FREEBSD 3
1962#define EXT4_OS_LITES 4
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001963
1964/*
1965 * Revision levels
1966 */
Mingming Cao617ba132006-10-11 01:20:53 -07001967#define EXT4_GOOD_OLD_REV 0 /* The good old (original) format */
1968#define EXT4_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001969
Mingming Cao617ba132006-10-11 01:20:53 -07001970#define EXT4_MAX_SUPP_REV EXT4_DYNAMIC_REV
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001971
Mingming Cao617ba132006-10-11 01:20:53 -07001972#define EXT4_GOOD_OLD_INODE_SIZE 128
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001973
Deepa Dinamani4881c492018-01-21 18:04:24 -08001974#define EXT4_EXTRA_TIMESTAMP_MAX (((s64)1 << 34) - 1 + S32_MIN)
1975#define EXT4_NON_EXTRA_TIMESTAMP_MAX S32_MAX
1976#define EXT4_TIMESTAMP_MIN S32_MIN
1977
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001978/*
1979 * Feature set definitions
1980 */
1981
Mingming Cao617ba132006-10-11 01:20:53 -07001982#define EXT4_FEATURE_COMPAT_DIR_PREALLOC 0x0001
1983#define EXT4_FEATURE_COMPAT_IMAGIC_INODES 0x0002
1984#define EXT4_FEATURE_COMPAT_HAS_JOURNAL 0x0004
1985#define EXT4_FEATURE_COMPAT_EXT_ATTR 0x0008
1986#define EXT4_FEATURE_COMPAT_RESIZE_INODE 0x0010
1987#define EXT4_FEATURE_COMPAT_DIR_INDEX 0x0020
Darrick J. Wong1beeef12014-05-12 10:16:06 -04001988#define EXT4_FEATURE_COMPAT_SPARSE_SUPER2 0x0200
Harshad Shirwadkara44ad682020-11-05 19:58:50 -08001989/*
1990 * The reason why "FAST_COMMIT" is a compat feature is that, FS becomes
1991 * incompatible only if fast commit blocks are present in the FS. Since we
1992 * clear the journal (and thus the fast commit blocks), we don't mark FS as
1993 * incompatible. We also have a JBD2 incompat feature, which gets set when
1994 * there are fast commit blocks present in the journal.
1995 */
Harshad Shirwadkar995a3ed2020-10-15 13:37:54 -07001996#define EXT4_FEATURE_COMPAT_FAST_COMMIT 0x0400
Eric Biggersb925acb2019-10-24 14:54:37 -07001997#define EXT4_FEATURE_COMPAT_STABLE_INODES 0x0800
Jan Kara02f310f2021-08-16 11:57:06 +02001998#define EXT4_FEATURE_COMPAT_ORPHAN_FILE 0x1000 /* Orphan file exists */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001999
Mingming Cao617ba132006-10-11 01:20:53 -07002000#define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
2001#define EXT4_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
2002#define EXT4_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
Aneesh Kumar K.V0fc1b452008-01-28 23:58:26 -05002003#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE 0x0008
Andreas Dilger717d50e2007-10-16 18:38:25 -04002004#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM 0x0010
Andreas Dilgerf8628a12007-07-18 08:38:01 -04002005#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK 0x0020
Kalpak Shahef7f3832007-07-18 09:15:20 -04002006#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE 0x0040
Aditya Kaliae812302011-05-24 19:00:39 -04002007#define EXT4_FEATURE_RO_COMPAT_QUOTA 0x0100
Theodore Ts'o281b5992011-09-09 18:34:51 -04002008#define EXT4_FEATURE_RO_COMPAT_BIGALLOC 0x0200
Darrick J. Wonge6153912012-04-29 18:23:10 -04002009/*
2010 * METADATA_CSUM also enables group descriptor checksums (GDT_CSUM). When
2011 * METADATA_CSUM is set, group descriptor checksums use the same algorithm as
2012 * all other data structures' checksums. However, the METADATA_CSUM and
2013 * GDT_CSUM bits are mutually exclusive.
2014 */
Theodore Ts'o9b90e5e2012-01-04 22:01:53 -05002015#define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM 0x0400
Darrick J. Wong2cb5cc82015-02-12 22:31:21 -05002016#define EXT4_FEATURE_RO_COMPAT_READONLY 0x1000
Theodore Ts'o8b4953e2015-10-17 16:15:18 -04002017#define EXT4_FEATURE_RO_COMPAT_PROJECT 0x2000
Eric Biggersc93d8f82019-07-22 09:26:24 -07002018#define EXT4_FEATURE_RO_COMPAT_VERITY 0x8000
Jan Kara02f310f2021-08-16 11:57:06 +02002019#define EXT4_FEATURE_RO_COMPAT_ORPHAN_PRESENT 0x10000 /* Orphan file may be
2020 non-empty */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002021
Mingming Cao617ba132006-10-11 01:20:53 -07002022#define EXT4_FEATURE_INCOMPAT_COMPRESSION 0x0001
2023#define EXT4_FEATURE_INCOMPAT_FILETYPE 0x0002
2024#define EXT4_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
2025#define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
2026#define EXT4_FEATURE_INCOMPAT_META_BG 0x0010
Alex Tomasa86c6182006-10-11 01:21:03 -07002027#define EXT4_FEATURE_INCOMPAT_EXTENTS 0x0040 /* extents support */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07002028#define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
Aneesh Kumar K.V0fc1b452008-01-28 23:58:26 -05002029#define EXT4_FEATURE_INCOMPAT_MMP 0x0100
Jose R. Santosce421582007-10-16 18:38:25 -04002030#define EXT4_FEATURE_INCOMPAT_FLEX_BG 0x0200
Theodore Ts'of710b4b2010-01-25 03:31:32 -05002031#define EXT4_FEATURE_INCOMPAT_EA_INODE 0x0400 /* EA in inode */
2032#define EXT4_FEATURE_INCOMPAT_DIRDATA 0x1000 /* data in dirent */
Darrick J. Wong8c81bd82015-10-17 16:16:02 -04002033#define EXT4_FEATURE_INCOMPAT_CSUM_SEED 0x2000
Theodore Ts'o9b90e5e2012-01-04 22:01:53 -05002034#define EXT4_FEATURE_INCOMPAT_LARGEDIR 0x4000 /* >2GB or 3-lvl htree */
Tao Ma67cf5b02012-12-10 14:04:46 -05002035#define EXT4_FEATURE_INCOMPAT_INLINE_DATA 0x8000 /* data in inode */
Theodore Ts'o3edc18d2015-01-19 16:00:58 -05002036#define EXT4_FEATURE_INCOMPAT_ENCRYPT 0x10000
Gabriel Krisman Bertazic83ad552019-04-25 14:05:42 -04002037#define EXT4_FEATURE_INCOMPAT_CASEFOLD 0x20000
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002038
Andreas Dilgerc9e716e2019-02-14 17:52:18 -05002039extern void ext4_update_dynamic_rev(struct super_block *sb);
2040
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002041#define EXT4_FEATURE_COMPAT_FUNCS(name, flagname) \
2042static inline bool ext4_has_feature_##name(struct super_block *sb) \
2043{ \
2044 return ((EXT4_SB(sb)->s_es->s_feature_compat & \
2045 cpu_to_le32(EXT4_FEATURE_COMPAT_##flagname)) != 0); \
2046} \
2047static inline void ext4_set_feature_##name(struct super_block *sb) \
2048{ \
Andreas Dilgerc9e716e2019-02-14 17:52:18 -05002049 ext4_update_dynamic_rev(sb); \
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002050 EXT4_SB(sb)->s_es->s_feature_compat |= \
2051 cpu_to_le32(EXT4_FEATURE_COMPAT_##flagname); \
2052} \
2053static inline void ext4_clear_feature_##name(struct super_block *sb) \
2054{ \
2055 EXT4_SB(sb)->s_es->s_feature_compat &= \
2056 ~cpu_to_le32(EXT4_FEATURE_COMPAT_##flagname); \
2057}
2058
2059#define EXT4_FEATURE_RO_COMPAT_FUNCS(name, flagname) \
2060static inline bool ext4_has_feature_##name(struct super_block *sb) \
2061{ \
2062 return ((EXT4_SB(sb)->s_es->s_feature_ro_compat & \
2063 cpu_to_le32(EXT4_FEATURE_RO_COMPAT_##flagname)) != 0); \
2064} \
2065static inline void ext4_set_feature_##name(struct super_block *sb) \
2066{ \
Andreas Dilgerc9e716e2019-02-14 17:52:18 -05002067 ext4_update_dynamic_rev(sb); \
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002068 EXT4_SB(sb)->s_es->s_feature_ro_compat |= \
2069 cpu_to_le32(EXT4_FEATURE_RO_COMPAT_##flagname); \
2070} \
2071static inline void ext4_clear_feature_##name(struct super_block *sb) \
2072{ \
2073 EXT4_SB(sb)->s_es->s_feature_ro_compat &= \
2074 ~cpu_to_le32(EXT4_FEATURE_RO_COMPAT_##flagname); \
2075}
2076
2077#define EXT4_FEATURE_INCOMPAT_FUNCS(name, flagname) \
2078static inline bool ext4_has_feature_##name(struct super_block *sb) \
2079{ \
2080 return ((EXT4_SB(sb)->s_es->s_feature_incompat & \
2081 cpu_to_le32(EXT4_FEATURE_INCOMPAT_##flagname)) != 0); \
2082} \
2083static inline void ext4_set_feature_##name(struct super_block *sb) \
2084{ \
Andreas Dilgerc9e716e2019-02-14 17:52:18 -05002085 ext4_update_dynamic_rev(sb); \
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002086 EXT4_SB(sb)->s_es->s_feature_incompat |= \
2087 cpu_to_le32(EXT4_FEATURE_INCOMPAT_##flagname); \
2088} \
2089static inline void ext4_clear_feature_##name(struct super_block *sb) \
2090{ \
2091 EXT4_SB(sb)->s_es->s_feature_incompat &= \
2092 ~cpu_to_le32(EXT4_FEATURE_INCOMPAT_##flagname); \
2093}
2094
2095EXT4_FEATURE_COMPAT_FUNCS(dir_prealloc, DIR_PREALLOC)
2096EXT4_FEATURE_COMPAT_FUNCS(imagic_inodes, IMAGIC_INODES)
2097EXT4_FEATURE_COMPAT_FUNCS(journal, HAS_JOURNAL)
2098EXT4_FEATURE_COMPAT_FUNCS(xattr, EXT_ATTR)
2099EXT4_FEATURE_COMPAT_FUNCS(resize_inode, RESIZE_INODE)
2100EXT4_FEATURE_COMPAT_FUNCS(dir_index, DIR_INDEX)
2101EXT4_FEATURE_COMPAT_FUNCS(sparse_super2, SPARSE_SUPER2)
Harshad Shirwadkar995a3ed2020-10-15 13:37:54 -07002102EXT4_FEATURE_COMPAT_FUNCS(fast_commit, FAST_COMMIT)
Eric Biggersb925acb2019-10-24 14:54:37 -07002103EXT4_FEATURE_COMPAT_FUNCS(stable_inodes, STABLE_INODES)
Jan Kara02f310f2021-08-16 11:57:06 +02002104EXT4_FEATURE_COMPAT_FUNCS(orphan_file, ORPHAN_FILE)
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002105
2106EXT4_FEATURE_RO_COMPAT_FUNCS(sparse_super, SPARSE_SUPER)
2107EXT4_FEATURE_RO_COMPAT_FUNCS(large_file, LARGE_FILE)
2108EXT4_FEATURE_RO_COMPAT_FUNCS(btree_dir, BTREE_DIR)
2109EXT4_FEATURE_RO_COMPAT_FUNCS(huge_file, HUGE_FILE)
2110EXT4_FEATURE_RO_COMPAT_FUNCS(gdt_csum, GDT_CSUM)
2111EXT4_FEATURE_RO_COMPAT_FUNCS(dir_nlink, DIR_NLINK)
2112EXT4_FEATURE_RO_COMPAT_FUNCS(extra_isize, EXTRA_ISIZE)
2113EXT4_FEATURE_RO_COMPAT_FUNCS(quota, QUOTA)
2114EXT4_FEATURE_RO_COMPAT_FUNCS(bigalloc, BIGALLOC)
2115EXT4_FEATURE_RO_COMPAT_FUNCS(metadata_csum, METADATA_CSUM)
2116EXT4_FEATURE_RO_COMPAT_FUNCS(readonly, READONLY)
2117EXT4_FEATURE_RO_COMPAT_FUNCS(project, PROJECT)
Eric Biggersc93d8f82019-07-22 09:26:24 -07002118EXT4_FEATURE_RO_COMPAT_FUNCS(verity, VERITY)
Jan Kara02f310f2021-08-16 11:57:06 +02002119EXT4_FEATURE_RO_COMPAT_FUNCS(orphan_present, ORPHAN_PRESENT)
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002120
2121EXT4_FEATURE_INCOMPAT_FUNCS(compression, COMPRESSION)
2122EXT4_FEATURE_INCOMPAT_FUNCS(filetype, FILETYPE)
2123EXT4_FEATURE_INCOMPAT_FUNCS(journal_needs_recovery, RECOVER)
2124EXT4_FEATURE_INCOMPAT_FUNCS(journal_dev, JOURNAL_DEV)
2125EXT4_FEATURE_INCOMPAT_FUNCS(meta_bg, META_BG)
2126EXT4_FEATURE_INCOMPAT_FUNCS(extents, EXTENTS)
2127EXT4_FEATURE_INCOMPAT_FUNCS(64bit, 64BIT)
2128EXT4_FEATURE_INCOMPAT_FUNCS(mmp, MMP)
2129EXT4_FEATURE_INCOMPAT_FUNCS(flex_bg, FLEX_BG)
2130EXT4_FEATURE_INCOMPAT_FUNCS(ea_inode, EA_INODE)
2131EXT4_FEATURE_INCOMPAT_FUNCS(dirdata, DIRDATA)
2132EXT4_FEATURE_INCOMPAT_FUNCS(csum_seed, CSUM_SEED)
2133EXT4_FEATURE_INCOMPAT_FUNCS(largedir, LARGEDIR)
2134EXT4_FEATURE_INCOMPAT_FUNCS(inline_data, INLINE_DATA)
2135EXT4_FEATURE_INCOMPAT_FUNCS(encrypt, ENCRYPT)
Gabriel Krisman Bertazic83ad552019-04-25 14:05:42 -04002136EXT4_FEATURE_INCOMPAT_FUNCS(casefold, CASEFOLD)
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002137
Theodore Ts'o2035e772011-04-18 17:29:14 -04002138#define EXT2_FEATURE_COMPAT_SUPP EXT4_FEATURE_COMPAT_EXT_ATTR
2139#define EXT2_FEATURE_INCOMPAT_SUPP (EXT4_FEATURE_INCOMPAT_FILETYPE| \
2140 EXT4_FEATURE_INCOMPAT_META_BG)
2141#define EXT2_FEATURE_RO_COMPAT_SUPP (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
2142 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
2143 EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
2144
2145#define EXT3_FEATURE_COMPAT_SUPP EXT4_FEATURE_COMPAT_EXT_ATTR
2146#define EXT3_FEATURE_INCOMPAT_SUPP (EXT4_FEATURE_INCOMPAT_FILETYPE| \
2147 EXT4_FEATURE_INCOMPAT_RECOVER| \
2148 EXT4_FEATURE_INCOMPAT_META_BG)
2149#define EXT3_FEATURE_RO_COMPAT_SUPP (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
2150 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
2151 EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
2152
Jan Kara02f310f2021-08-16 11:57:06 +02002153#define EXT4_FEATURE_COMPAT_SUPP (EXT4_FEATURE_COMPAT_EXT_ATTR| \
2154 EXT4_FEATURE_COMPAT_ORPHAN_FILE)
Mingming Cao617ba132006-10-11 01:20:53 -07002155#define EXT4_FEATURE_INCOMPAT_SUPP (EXT4_FEATURE_INCOMPAT_FILETYPE| \
2156 EXT4_FEATURE_INCOMPAT_RECOVER| \
Alex Tomasa86c6182006-10-11 01:21:03 -07002157 EXT4_FEATURE_INCOMPAT_META_BG| \
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07002158 EXT4_FEATURE_INCOMPAT_EXTENTS| \
Jose R. Santosce421582007-10-16 18:38:25 -04002159 EXT4_FEATURE_INCOMPAT_64BIT| \
Johann Lombardic5e06d12011-05-24 18:31:25 -04002160 EXT4_FEATURE_INCOMPAT_FLEX_BG| \
Andreas Dilgere50e5122017-06-21 21:10:32 -04002161 EXT4_FEATURE_INCOMPAT_EA_INODE| \
Theodore Ts'o6ddb2442015-04-16 01:56:00 -04002162 EXT4_FEATURE_INCOMPAT_MMP | \
2163 EXT4_FEATURE_INCOMPAT_INLINE_DATA | \
Darrick J. Wong8c81bd82015-10-17 16:16:02 -04002164 EXT4_FEATURE_INCOMPAT_ENCRYPT | \
Gabriel Krisman Bertazic83ad552019-04-25 14:05:42 -04002165 EXT4_FEATURE_INCOMPAT_CASEFOLD | \
Artem Blagodarenkoe08ac992017-06-21 21:09:57 -04002166 EXT4_FEATURE_INCOMPAT_CSUM_SEED | \
2167 EXT4_FEATURE_INCOMPAT_LARGEDIR)
Mingming Cao617ba132006-10-11 01:20:53 -07002168#define EXT4_FEATURE_RO_COMPAT_SUPP (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
2169 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
Andreas Dilger717d50e2007-10-16 18:38:25 -04002170 EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
Andreas Dilgerf8628a12007-07-18 08:38:01 -04002171 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
Kalpak Shahef7f3832007-07-18 09:15:20 -04002172 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
Aneesh Kumar K.V0fc1b452008-01-28 23:58:26 -05002173 EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
Theodore Ts'o6f16b602011-09-09 19:06:51 -04002174 EXT4_FEATURE_RO_COMPAT_HUGE_FILE |\
Darrick J. Wonge93376c2012-05-27 08:12:42 -04002175 EXT4_FEATURE_RO_COMPAT_BIGALLOC |\
Aditya Kali7c319d32012-07-22 20:21:31 -04002176 EXT4_FEATURE_RO_COMPAT_METADATA_CSUM|\
Li Xi040cb372016-01-08 16:01:21 -05002177 EXT4_FEATURE_RO_COMPAT_QUOTA |\
Eric Biggersc93d8f82019-07-22 09:26:24 -07002178 EXT4_FEATURE_RO_COMPAT_PROJECT |\
Jan Kara02f310f2021-08-16 11:57:06 +02002179 EXT4_FEATURE_RO_COMPAT_VERITY |\
2180 EXT4_FEATURE_RO_COMPAT_ORPHAN_PRESENT)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002181
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002182#define EXTN_FEATURE_FUNCS(ver) \
2183static inline bool ext4_has_unknown_ext##ver##_compat_features(struct super_block *sb) \
2184{ \
2185 return ((EXT4_SB(sb)->s_es->s_feature_compat & \
2186 cpu_to_le32(~EXT##ver##_FEATURE_COMPAT_SUPP)) != 0); \
2187} \
2188static inline bool ext4_has_unknown_ext##ver##_ro_compat_features(struct super_block *sb) \
2189{ \
2190 return ((EXT4_SB(sb)->s_es->s_feature_ro_compat & \
2191 cpu_to_le32(~EXT##ver##_FEATURE_RO_COMPAT_SUPP)) != 0); \
2192} \
2193static inline bool ext4_has_unknown_ext##ver##_incompat_features(struct super_block *sb) \
2194{ \
2195 return ((EXT4_SB(sb)->s_es->s_feature_incompat & \
2196 cpu_to_le32(~EXT##ver##_FEATURE_INCOMPAT_SUPP)) != 0); \
2197}
2198
2199EXTN_FEATURE_FUNCS(2)
2200EXTN_FEATURE_FUNCS(3)
2201EXTN_FEATURE_FUNCS(4)
2202
2203static inline bool ext4_has_compat_features(struct super_block *sb)
2204{
2205 return (EXT4_SB(sb)->s_es->s_feature_compat != 0);
2206}
2207static inline bool ext4_has_ro_compat_features(struct super_block *sb)
2208{
2209 return (EXT4_SB(sb)->s_es->s_feature_ro_compat != 0);
2210}
2211static inline bool ext4_has_incompat_features(struct super_block *sb)
2212{
2213 return (EXT4_SB(sb)->s_es->s_feature_incompat != 0);
2214}
2215
Jan Kara25c6d982021-08-16 11:57:05 +02002216extern int ext4_feature_set_ok(struct super_block *sb, int readonly);
2217
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002218/*
Theodore Ts'o9549a162017-02-05 01:27:48 -05002219 * Superblock flags
2220 */
2221#define EXT4_FLAGS_RESIZING 0
Theodore Ts'o0db1ff22017-02-05 01:28:48 -05002222#define EXT4_FLAGS_SHUTDOWN 1
Ira Weinya8ab6d32020-05-28 07:59:58 -07002223#define EXT4_FLAGS_BDEV_IS_DAX 2
Theodore Ts'o0db1ff22017-02-05 01:28:48 -05002224
2225static inline int ext4_forced_shutdown(struct ext4_sb_info *sbi)
2226{
2227 return test_bit(EXT4_FLAGS_SHUTDOWN, &sbi->s_ext4_flags);
2228}
Theodore Ts'o9549a162017-02-05 01:27:48 -05002229
Theodore Ts'o9549a162017-02-05 01:27:48 -05002230/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002231 * Default values for user and/or group using reserved blocks
2232 */
Mingming Cao617ba132006-10-11 01:20:53 -07002233#define EXT4_DEF_RESUID 0
2234#define EXT4_DEF_RESGID 0
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002235
Li Xi040cb372016-01-08 16:01:21 -05002236/*
2237 * Default project ID
2238 */
2239#define EXT4_DEF_PROJID 0
2240
Theodore Ts'o240799c2008-10-09 23:53:47 -04002241#define EXT4_DEF_INODE_READAHEAD_BLKS 32
2242
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002243/*
2244 * Default mount options
2245 */
Mingming Cao617ba132006-10-11 01:20:53 -07002246#define EXT4_DEFM_DEBUG 0x0001
2247#define EXT4_DEFM_BSDGROUPS 0x0002
2248#define EXT4_DEFM_XATTR_USER 0x0004
2249#define EXT4_DEFM_ACL 0x0008
2250#define EXT4_DEFM_UID16 0x0010
2251#define EXT4_DEFM_JMODE 0x0060
2252#define EXT4_DEFM_JMODE_DATA 0x0020
2253#define EXT4_DEFM_JMODE_ORDERED 0x0040
2254#define EXT4_DEFM_JMODE_WBACK 0x0060
Theodore Ts'o8b67f042010-08-01 23:14:20 -04002255#define EXT4_DEFM_NOBARRIER 0x0100
2256#define EXT4_DEFM_BLOCK_VALIDITY 0x0200
2257#define EXT4_DEFM_DISCARD 0x0400
2258#define EXT4_DEFM_NODELALLOC 0x0800
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002259
2260/*
Theodore Ts'o30773842009-01-03 20:27:38 -05002261 * Default journal batch times
2262 */
2263#define EXT4_DEF_MIN_BATCH_TIME 0
2264#define EXT4_DEF_MAX_BATCH_TIME 15000 /* 15ms */
2265
2266/*
Theodore Ts'oa4912122009-03-12 12:18:34 -04002267 * Minimum number of groups in a flexgroup before we separate out
2268 * directories into the first block group of a flexgroup
2269 */
2270#define EXT4_FLEX_SIZE_DIR_ALLOC_SCHEME 4
2271
2272/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002273 * Structure of a directory entry
2274 */
Mingming Cao617ba132006-10-11 01:20:53 -07002275#define EXT4_NAME_LEN 255
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002276
Mingming Cao617ba132006-10-11 01:20:53 -07002277struct ext4_dir_entry {
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002278 __le32 inode; /* Inode number */
2279 __le16 rec_len; /* Directory entry length */
2280 __le16 name_len; /* Name length */
Mingming Cao617ba132006-10-11 01:20:53 -07002281 char name[EXT4_NAME_LEN]; /* File name */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002282};
2283
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002284
2285/*
2286 * Encrypted Casefolded entries require saving the hash on disk. This structure
2287 * followed ext4_dir_entry_2's name[name_len] at the next 4 byte aligned
2288 * boundary.
2289 */
2290struct ext4_dir_entry_hash {
2291 __le32 hash;
2292 __le32 minor_hash;
2293};
2294
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002295/*
Mingming Cao617ba132006-10-11 01:20:53 -07002296 * The new version of the directory entry. Since EXT4 structures are
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002297 * stored in intel byte order, and the name_len field could never be
2298 * bigger than 255 chars, it's safe to reclaim the extra byte for the
2299 * file_type field.
2300 */
Mingming Cao617ba132006-10-11 01:20:53 -07002301struct ext4_dir_entry_2 {
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002302 __le32 inode; /* Inode number */
2303 __le16 rec_len; /* Directory entry length */
2304 __u8 name_len; /* Name length */
Jonathan Grant9f364e12020-05-22 16:07:58 +01002305 __u8 file_type; /* See file type macros EXT4_FT_* below */
Mingming Cao617ba132006-10-11 01:20:53 -07002306 char name[EXT4_NAME_LEN]; /* File name */
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002307};
2308
2309/*
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002310 * Access the hashes at the end of ext4_dir_entry_2
2311 */
2312#define EXT4_DIRENT_HASHES(entry) \
2313 ((struct ext4_dir_entry_hash *) \
2314 (((void *)(entry)) + \
2315 ((8 + (entry)->name_len + EXT4_DIR_ROUND) & ~EXT4_DIR_ROUND)))
2316#define EXT4_DIRENT_HASH(entry) le32_to_cpu(EXT4_DIRENT_HASHES(de)->hash)
2317#define EXT4_DIRENT_MINOR_HASH(entry) \
2318 le32_to_cpu(EXT4_DIRENT_HASHES(de)->minor_hash)
2319
2320static inline bool ext4_hash_in_dirent(const struct inode *inode)
2321{
2322 return IS_CASEFOLDED(inode) && IS_ENCRYPTED(inode);
2323}
2324
2325/*
Darrick J. Wonge6153912012-04-29 18:23:10 -04002326 * This is a bogus directory entry at the end of each leaf block that
2327 * records checksums.
2328 */
2329struct ext4_dir_entry_tail {
2330 __le32 det_reserved_zero1; /* Pretend to be unused */
2331 __le16 det_rec_len; /* 12 */
2332 __u8 det_reserved_zero2; /* Zero name length */
2333 __u8 det_reserved_ft; /* 0xDE, fake file type */
2334 __le32 det_checksum; /* crc32c(uuid+inum+dirblock) */
2335};
2336
Tao Ma3c47d542012-12-10 14:05:59 -05002337#define EXT4_DIRENT_TAIL(block, blocksize) \
2338 ((struct ext4_dir_entry_tail *)(((void *)(block)) + \
2339 ((blocksize) - \
2340 sizeof(struct ext4_dir_entry_tail))))
2341
Darrick J. Wonge6153912012-04-29 18:23:10 -04002342/*
Mingming Cao617ba132006-10-11 01:20:53 -07002343 * Ext4 directory file types. Only the low 3 bits are used. The
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002344 * other bits are reserved for now.
2345 */
Mingming Cao617ba132006-10-11 01:20:53 -07002346#define EXT4_FT_UNKNOWN 0
2347#define EXT4_FT_REG_FILE 1
2348#define EXT4_FT_DIR 2
2349#define EXT4_FT_CHRDEV 3
2350#define EXT4_FT_BLKDEV 4
2351#define EXT4_FT_FIFO 5
2352#define EXT4_FT_SOCK 6
2353#define EXT4_FT_SYMLINK 7
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002354
Mingming Cao617ba132006-10-11 01:20:53 -07002355#define EXT4_FT_MAX 8
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002356
Darrick J. Wonge6153912012-04-29 18:23:10 -04002357#define EXT4_FT_DIR_CSUM 0xDE
2358
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002359/*
Mingming Cao617ba132006-10-11 01:20:53 -07002360 * EXT4_DIR_PAD defines the directory entries boundaries
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002361 *
2362 * NOTE: It must be a multiple of 4
2363 */
Mingming Cao617ba132006-10-11 01:20:53 -07002364#define EXT4_DIR_PAD 4
2365#define EXT4_DIR_ROUND (EXT4_DIR_PAD - 1)
Jan Karaa72d7f82008-01-28 23:58:27 -05002366#define EXT4_MAX_REC_LEN ((1<<16)-1)
2367
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002368/*
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002369 * The rec_len is dependent on the type of directory. Directories that are
2370 * casefolded and encrypted need to store the hash as well, so we add room for
2371 * ext4_extended_dir_entry_2. For all entries related to '.' or '..' you should
2372 * pass NULL for dir, as those entries do not use the extra fields.
2373 */
2374static inline unsigned int ext4_dir_rec_len(__u8 name_len,
2375 const struct inode *dir)
2376{
2377 int rec_len = (name_len + 8 + EXT4_DIR_ROUND);
2378
2379 if (dir && ext4_hash_in_dirent(dir))
2380 rec_len += sizeof(struct ext4_dir_entry_hash);
2381 return (rec_len & ~EXT4_DIR_ROUND);
2382}
2383
2384/*
Eric Sandeen0cfc9252010-08-05 01:46:37 -04002385 * If we ever get support for fs block sizes > page_size, we'll need
2386 * to remove the #if statements in the next two functions...
2387 */
2388static inline unsigned int
2389ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize)
2390{
2391 unsigned len = le16_to_cpu(dlen);
2392
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03002393#if (PAGE_SIZE >= 65536)
Eric Sandeen0cfc9252010-08-05 01:46:37 -04002394 if (len == EXT4_MAX_REC_LEN || len == 0)
2395 return blocksize;
2396 return (len & 65532) | ((len & 3) << 16);
2397#else
2398 return len;
2399#endif
2400}
2401
2402static inline __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize)
2403{
xu xina2e39652021-12-28 07:32:52 +00002404 BUG_ON((len > blocksize) || (blocksize > (1 << 18)) || (len & 3));
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03002405#if (PAGE_SIZE >= 65536)
Eric Sandeen0cfc9252010-08-05 01:46:37 -04002406 if (len < 65536)
2407 return cpu_to_le16(len);
2408 if (len == blocksize) {
2409 if (blocksize == 65536)
2410 return cpu_to_le16(EXT4_MAX_REC_LEN);
2411 else
2412 return cpu_to_le16(0);
2413 }
2414 return cpu_to_le16((len & 65532) | ((len >> 16) & 3));
2415#else
2416 return cpu_to_le16(len);
2417#endif
2418}
2419
2420/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002421 * Hash Tree Directory indexing
2422 * (c) Daniel Phillips, 2001
2423 */
2424
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002425#define is_dx(dir) (ext4_has_feature_dir_index((dir)->i_sb) && \
Dmitry Monakhov12e9b892010-05-16 22:00:00 -04002426 ext4_test_inode_flag((dir), EXT4_INODE_INDEX))
Andreas Dilgerc7414892017-08-05 19:47:34 -04002427#define EXT4_DIR_LINK_MAX(dir) unlikely((dir)->i_nlink >= EXT4_LINK_MAX && \
2428 !(ext4_has_feature_dir_nlink((dir)->i_sb) && is_dx(dir)))
Mingming Cao617ba132006-10-11 01:20:53 -07002429#define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002430
2431/* Legal values for the dx_root hash_version field: */
2432
Petros Koutoupise7093f02018-01-07 23:36:19 -05002433#define DX_HASH_LEGACY 0
2434#define DX_HASH_HALF_MD4 1
2435#define DX_HASH_TEA 2
2436#define DX_HASH_LEGACY_UNSIGNED 3
Theodore Ts'of99b2582008-10-28 13:21:44 -04002437#define DX_HASH_HALF_MD4_UNSIGNED 4
2438#define DX_HASH_TEA_UNSIGNED 5
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002439#define DX_HASH_SIPHASH 6
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002440
Darrick J. Wong04419842012-04-29 18:27:10 -04002441static inline u32 ext4_chksum(struct ext4_sb_info *sbi, u32 crc,
2442 const void *address, unsigned int length)
2443{
2444 struct {
2445 struct shash_desc shash;
Theodore Ts'o3108b542012-07-22 20:25:31 -04002446 char ctx[4];
Darrick J. Wong04419842012-04-29 18:27:10 -04002447 } desc;
Darrick J. Wong04419842012-04-29 18:27:10 -04002448
Theodore Ts'o3108b542012-07-22 20:25:31 -04002449 BUG_ON(crypto_shash_descsize(sbi->s_chksum_driver)!=sizeof(desc.ctx));
2450
Darrick J. Wong04419842012-04-29 18:27:10 -04002451 desc.shash.tfm = sbi->s_chksum_driver;
Darrick J. Wong04419842012-04-29 18:27:10 -04002452 *(u32 *)desc.ctx = crc;
2453
Petros Koutoupise7093f02018-01-07 23:36:19 -05002454 BUG_ON(crypto_shash_update(&desc.shash, address, length));
Darrick J. Wong04419842012-04-29 18:27:10 -04002455
2456 return *(u32 *)desc.ctx;
2457}
2458
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002459#ifdef __KERNEL__
2460
2461/* hash info structure used by the directory hash */
2462struct dx_hash_info
2463{
2464 u32 hash;
2465 u32 minor_hash;
2466 int hash_version;
2467 u32 *seed;
2468};
2469
Fan Yongd1f52732012-03-18 22:44:40 -04002470
2471/* 32 and 64 bit signed EOF for dx directories */
2472#define EXT4_HTREE_EOF_32BIT ((1UL << (32 - 1)) - 1)
2473#define EXT4_HTREE_EOF_64BIT ((1ULL << (64 - 1)) - 1)
2474
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002475
2476/*
Mingming Cao617ba132006-10-11 01:20:53 -07002477 * Control parameters used by ext4_htree_next_block
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002478 */
2479#define HASH_NB_ALWAYS 1
2480
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002481struct ext4_filename {
2482 const struct qstr *usr_fname;
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002483 struct fscrypt_str disk_name;
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002484 struct dx_hash_info hinfo;
Chandan Rajendra643fa962018-12-12 15:20:12 +05302485#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002486 struct fscrypt_str crypto_buf;
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002487#endif
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002488#ifdef CONFIG_UNICODE
2489 struct fscrypt_str cf_name;
2490#endif
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002491};
2492
2493#define fname_name(p) ((p)->disk_name.name)
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002494#define fname_usr_name(p) ((p)->usr_fname->name)
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002495#define fname_len(p) ((p)->disk_name.len)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002496
2497/*
2498 * Describe an inode's exact location on disk and in memory
2499 */
Mingming Cao617ba132006-10-11 01:20:53 -07002500struct ext4_iloc
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002501{
2502 struct buffer_head *bh;
2503 unsigned long offset;
Avantika Mathurfd2d4292008-01-28 23:58:27 -05002504 ext4_group_t block_group;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002505};
2506
Mingming Cao617ba132006-10-11 01:20:53 -07002507static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002508{
Mingming Cao617ba132006-10-11 01:20:53 -07002509 return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002510}
2511
Tahsin Erdogandec214d2017-06-22 11:44:55 -04002512static inline bool ext4_is_quota_file(struct inode *inode)
2513{
2514 return IS_NOQUOTA(inode) &&
2515 !(EXT4_I(inode)->i_flags & EXT4_EA_INODE_FL);
2516}
Tahsin Erdogan02749a42017-06-22 11:31:25 -04002517
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002518/*
2519 * This structure is stuffed into the struct file's private_data field
2520 * for directories. It is where we put information so that we can do
2521 * readdir operations in hash tree order.
2522 */
2523struct dir_private_info {
2524 struct rb_root root;
2525 struct rb_node *curr_node;
2526 struct fname *extra_fname;
2527 loff_t last_pos;
2528 __u32 curr_hash;
2529 __u32 curr_minor_hash;
2530 __u32 next_hash;
2531};
2532
2533/* calculate the first block number of the group */
Mingming Cao617ba132006-10-11 01:20:53 -07002534static inline ext4_fsblk_t
Avantika Mathurfd2d4292008-01-28 23:58:27 -05002535ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002536{
Mingming Cao617ba132006-10-11 01:20:53 -07002537 return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
2538 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002539}
2540
2541/*
2542 * Special error return code only used by dx_probe() and its callers.
2543 */
Theodore Ts'o36de9282014-08-23 17:47:19 -04002544#define ERR_BAD_DX_DIR (-(MAX_ERRNO - 1))
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002545
Artem Blagodarenkoe08ac992017-06-21 21:09:57 -04002546/* htree levels for ext4 */
2547#define EXT4_HTREE_LEVEL_COMPAT 2
2548#define EXT4_HTREE_LEVEL 3
2549
2550static inline int ext4_dir_htree_level(struct super_block *sb)
2551{
2552 return ext4_has_feature_largedir(sb) ?
2553 EXT4_HTREE_LEVEL : EXT4_HTREE_LEVEL_COMPAT;
2554}
2555
Mingming Cao3a5b2ec2006-10-11 01:21:05 -07002556/*
Lukas Czernerbfff6872010-10-27 21:30:05 -04002557 * Timeout and state flag for lazy initialization inode thread.
2558 */
2559#define EXT4_DEF_LI_WAIT_MULT 10
2560#define EXT4_DEF_LI_MAX_START_DELAY 5
2561#define EXT4_LAZYINIT_QUIT 0x0001
2562#define EXT4_LAZYINIT_RUNNING 0x0002
2563
2564/*
2565 * Lazy inode table initialization info
2566 */
2567struct ext4_lazy_init {
2568 unsigned long li_state;
Lukas Czernerbfff6872010-10-27 21:30:05 -04002569 struct list_head li_request_list;
2570 struct mutex li_list_mtx;
2571};
2572
Theodore Ts'o3d392b22020-07-17 00:14:40 -04002573enum ext4_li_mode {
2574 EXT4_LI_MODE_PREFETCH_BBITMAP,
2575 EXT4_LI_MODE_ITABLE,
2576};
2577
Lukas Czernerbfff6872010-10-27 21:30:05 -04002578struct ext4_li_request {
2579 struct super_block *lr_super;
Theodore Ts'o3d392b22020-07-17 00:14:40 -04002580 enum ext4_li_mode lr_mode;
2581 ext4_group_t lr_first_not_zeroed;
Lukas Czernerbfff6872010-10-27 21:30:05 -04002582 ext4_group_t lr_next_group;
2583 struct list_head lr_request;
2584 unsigned long lr_next_sched;
2585 unsigned long lr_timeout;
2586};
2587
Lukas Czerner857ac882010-10-27 21:30:05 -04002588struct ext4_features {
2589 struct kobject f_kobj;
2590 struct completion f_kobj_unregister;
2591};
2592
Lukas Czernerbfff6872010-10-27 21:30:05 -04002593/*
Johann Lombardic5e06d12011-05-24 18:31:25 -04002594 * This structure will be used for multiple mount protection. It will be
2595 * written into the block number saved in the s_mmp_block field in the
2596 * superblock. Programs that check MMP should assume that if
2597 * SEQ_FSCK (or any unknown code above SEQ_MAX) is present then it is NOT safe
2598 * to use the filesystem, regardless of how old the timestamp is.
2599 */
2600#define EXT4_MMP_MAGIC 0x004D4D50U /* ASCII for MMP */
2601#define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
2602#define EXT4_MMP_SEQ_FSCK 0xE24D4D50U /* mmp_seq value when being fscked */
2603#define EXT4_MMP_SEQ_MAX 0xE24D4D4FU /* maximum valid mmp_seq value */
2604
2605struct mmp_struct {
2606 __le32 mmp_magic; /* Magic number for MMP */
2607 __le32 mmp_seq; /* Sequence no. updated periodically */
2608
2609 /*
2610 * mmp_time, mmp_nodename & mmp_bdevname are only used for information
2611 * purposes and do not affect the correctness of the algorithm
2612 */
2613 __le64 mmp_time; /* Time last updated */
2614 char mmp_nodename[64]; /* Node which last updated MMP block */
2615 char mmp_bdevname[32]; /* Bdev which last updated MMP block */
2616
2617 /*
2618 * mmp_check_interval is used to verify if the MMP block has been
2619 * updated on the block device. The value is updated based on the
2620 * maximum time to write the MMP block during an update cycle.
2621 */
2622 __le16 mmp_check_interval;
2623
2624 __le16 mmp_pad1;
Darrick J. Wonge6153912012-04-29 18:23:10 -04002625 __le32 mmp_pad2[226];
2626 __le32 mmp_checksum; /* crc32c(uuid+mmp_block) */
Johann Lombardic5e06d12011-05-24 18:31:25 -04002627};
2628
2629/* arguments passed to the mmp thread */
2630struct mmpd_data {
2631 struct buffer_head *bh; /* bh from initial read_mmp_block() */
2632 struct super_block *sb; /* super block of the fs */
2633};
2634
2635/*
2636 * Check interval multiplier
2637 * The MMP block is written every update interval and initially checked every
2638 * update interval x the multiplier (the value is then adapted based on the
2639 * write latency). The reason is that writes can be delayed under load and we
2640 * don't want readers to incorrectly assume that the filesystem is no longer
2641 * in use.
2642 */
2643#define EXT4_MMP_CHECK_MULT 2UL
2644
2645/*
2646 * Minimum interval for MMP checking in seconds.
2647 */
2648#define EXT4_MMP_MIN_CHECK_INTERVAL 5UL
2649
2650/*
2651 * Maximum interval for MMP checking in seconds.
2652 */
2653#define EXT4_MMP_MAX_CHECK_INTERVAL 300UL
2654
2655/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002656 * Function prototypes
2657 */
2658
2659/*
2660 * Ok, these declarations are also in <linux/kernel.h> but none of the
Mingming Cao617ba132006-10-11 01:20:53 -07002661 * ext4 source programs needs to include it so they are duplicated here.
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002662 */
Dave Kleikamp8c55e202007-05-24 13:04:54 -04002663# define NORET_TYPE /**/
2664# define ATTRIB_NORET __attribute__((noreturn))
2665# define NORET_AND noreturn,
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002666
Theodore Ts'o498e5f22008-11-05 00:14:04 -05002667/* bitmap.c */
Theodore Ts'of6fb99c2012-06-30 19:14:57 -04002668extern unsigned int ext4_count_free(char *bitmap, unsigned numchars);
Darrick J. Wong41a246d2012-04-29 18:33:10 -04002669void ext4_inode_bitmap_csum_set(struct super_block *sb, ext4_group_t group,
2670 struct ext4_group_desc *gdp,
2671 struct buffer_head *bh, int sz);
2672int ext4_inode_bitmap_csum_verify(struct super_block *sb, ext4_group_t group,
2673 struct ext4_group_desc *gdp,
2674 struct buffer_head *bh, int sz);
Darrick J. Wongfa77dcf2012-04-29 18:35:10 -04002675void ext4_block_bitmap_csum_set(struct super_block *sb, ext4_group_t group,
2676 struct ext4_group_desc *gdp,
Tao Ma79f1ba42012-10-22 00:34:32 -04002677 struct buffer_head *bh);
Darrick J. Wongfa77dcf2012-04-29 18:35:10 -04002678int ext4_block_bitmap_csum_verify(struct super_block *sb, ext4_group_t group,
2679 struct ext4_group_desc *gdp,
Tao Ma79f1ba42012-10-22 00:34:32 -04002680 struct buffer_head *bh);
Theodore Ts'o498e5f22008-11-05 00:14:04 -05002681
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002682/* balloc.c */
Lukas Czernerbd862982013-04-03 23:32:34 -04002683extern void ext4_get_group_no_and_offset(struct super_block *sb,
2684 ext4_fsblk_t blocknr,
2685 ext4_group_t *blockgrpp,
2686 ext4_grpblk_t *offsetp);
2687extern ext4_group_t ext4_get_group_number(struct super_block *sb,
2688 ext4_fsblk_t block);
2689
Mingming Cao3a5b2ec2006-10-11 01:21:05 -07002690extern unsigned int ext4_block_group(struct super_block *sb,
2691 ext4_fsblk_t blocknr);
2692extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
2693 ext4_fsblk_t blocknr);
Avantika Mathurfd2d4292008-01-28 23:58:27 -05002694extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
2695extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
2696 ext4_group_t group);
Aneesh Kumar K.V7061eba2008-07-11 19:27:31 -04002697extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
Allison Henderson55f020d2011-05-25 07:41:26 -04002698 ext4_fsblk_t goal,
2699 unsigned int flags,
2700 unsigned long *count,
2701 int *errp);
Theodore Ts'oe7d5f312011-09-09 19:14:51 -04002702extern int ext4_claim_free_clusters(struct ext4_sb_info *sbi,
2703 s64 nclusters, unsigned int flags);
Theodore Ts'o5dee5432011-09-09 19:10:51 -04002704extern ext4_fsblk_t ext4_count_free_clusters(struct super_block *);
Theodore Ts'oaf5bc922008-09-08 22:25:24 -04002705extern void ext4_check_blocks_bitmap(struct super_block *);
Mingming Cao617ba132006-10-11 01:20:53 -07002706extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
Avantika Mathurfd2d4292008-01-28 23:58:27 -05002707 ext4_group_t block_group,
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002708 struct buffer_head ** bh);
Mingming Cao617ba132006-10-11 01:20:53 -07002709extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
Theodore Ts'o813e5722012-02-20 17:52:46 -05002710
2711extern struct buffer_head *ext4_read_block_bitmap_nowait(struct super_block *sb,
Alex Zhuravlevcfd73232020-04-21 10:54:07 +03002712 ext4_group_t block_group,
2713 bool ignore_locked);
Theodore Ts'o813e5722012-02-20 17:52:46 -05002714extern int ext4_wait_block_bitmap(struct super_block *sb,
2715 ext4_group_t block_group,
2716 struct buffer_head *bh);
2717extern struct buffer_head *ext4_read_block_bitmap(struct super_block *sb,
2718 ext4_group_t block_group);
Theodore Ts'ocff1dfd72011-09-09 19:12:51 -04002719extern unsigned ext4_free_clusters_after_init(struct super_block *sb,
2720 ext4_group_t block_group,
2721 struct ext4_group_desc *gdp);
Eric Sandeenf86186b2011-06-28 10:01:31 -04002722ext4_fsblk_t ext4_inode_to_goal_block(struct inode *);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002723
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002724#ifdef CONFIG_UNICODE
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002725extern int ext4_fname_setup_ci_filename(struct inode *dir,
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002726 const struct qstr *iname,
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002727 struct ext4_filename *fname);
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002728#endif
2729
Chandan Rajendra643fa962018-12-12 15:20:12 +05302730#ifdef CONFIG_FS_ENCRYPTION
Eric Biggersb01531d2019-03-20 11:39:13 -07002731static inline void ext4_fname_from_fscrypt_name(struct ext4_filename *dst,
2732 const struct fscrypt_name *src)
2733{
2734 memset(dst, 0, sizeof(*dst));
2735
2736 dst->usr_fname = src->usr_fname;
2737 dst->disk_name = src->disk_name;
2738 dst->hinfo.hash = src->hash;
2739 dst->hinfo.minor_hash = src->minor_hash;
2740 dst->crypto_buf = src->crypto_buf;
2741}
2742
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002743static inline int ext4_fname_setup_filename(struct inode *dir,
Eric Biggersb01531d2019-03-20 11:39:13 -07002744 const struct qstr *iname,
2745 int lookup,
2746 struct ext4_filename *fname)
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002747{
2748 struct fscrypt_name name;
2749 int err;
2750
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002751 err = fscrypt_setup_filename(dir, iname, lookup, &name);
Eric Biggersb01531d2019-03-20 11:39:13 -07002752 if (err)
2753 return err;
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002754
Eric Biggersb01531d2019-03-20 11:39:13 -07002755 ext4_fname_from_fscrypt_name(fname, &name);
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002756
2757#ifdef CONFIG_UNICODE
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002758 err = ext4_fname_setup_ci_filename(dir, iname, fname);
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002759#endif
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002760 return err;
Eric Biggersb01531d2019-03-20 11:39:13 -07002761}
2762
2763static inline int ext4_fname_prepare_lookup(struct inode *dir,
2764 struct dentry *dentry,
2765 struct ext4_filename *fname)
2766{
2767 struct fscrypt_name name;
2768 int err;
2769
2770 err = fscrypt_prepare_lookup(dir, dentry, &name);
2771 if (err)
2772 return err;
2773
2774 ext4_fname_from_fscrypt_name(fname, &name);
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002775
2776#ifdef CONFIG_UNICODE
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002777 err = ext4_fname_setup_ci_filename(dir, &dentry->d_name, fname);
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002778#endif
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002779 return err;
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002780}
2781
2782static inline void ext4_fname_free_filename(struct ext4_filename *fname)
2783{
2784 struct fscrypt_name name;
2785
2786 name.crypto_buf = fname->crypto_buf;
2787 fscrypt_free_filename(&name);
2788
2789 fname->crypto_buf.name = NULL;
2790 fname->usr_fname = NULL;
2791 fname->disk_name.name = NULL;
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002792
2793#ifdef CONFIG_UNICODE
2794 kfree(fname->cf_name.name);
2795 fname->cf_name.name = NULL;
2796#endif
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002797}
Eric Biggersb01531d2019-03-20 11:39:13 -07002798#else /* !CONFIG_FS_ENCRYPTION */
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002799static inline int ext4_fname_setup_filename(struct inode *dir,
Eric Biggersb01531d2019-03-20 11:39:13 -07002800 const struct qstr *iname,
2801 int lookup,
2802 struct ext4_filename *fname)
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002803{
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002804 int err = 0;
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002805 fname->usr_fname = iname;
2806 fname->disk_name.name = (unsigned char *) iname->name;
2807 fname->disk_name.len = iname->len;
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002808
2809#ifdef CONFIG_UNICODE
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002810 err = ext4_fname_setup_ci_filename(dir, iname, fname);
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002811#endif
2812
Daniel Rosenberg1ae98e22021-03-19 07:34:14 +00002813 return err;
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002814}
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002815
Eric Biggersb01531d2019-03-20 11:39:13 -07002816static inline int ext4_fname_prepare_lookup(struct inode *dir,
2817 struct dentry *dentry,
2818 struct ext4_filename *fname)
2819{
2820 return ext4_fname_setup_filename(dir, &dentry->d_name, 1, fname);
2821}
2822
Gabriel Krisman Bertazi3ae72562019-06-19 23:45:09 -04002823static inline void ext4_fname_free_filename(struct ext4_filename *fname)
2824{
2825#ifdef CONFIG_UNICODE
2826 kfree(fname->cf_name.name);
2827 fname->cf_name.name = NULL;
2828#endif
2829}
Eric Biggersb01531d2019-03-20 11:39:13 -07002830#endif /* !CONFIG_FS_ENCRYPTION */
Michael Halcrowd5d0e8c2015-04-12 00:56:17 -04002831
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002832/* dir.c */
Theodore Ts'o60fd4da2010-07-27 11:54:40 -04002833extern int __ext4_check_dir_entry(const char *, unsigned int, struct inode *,
Theodore Ts'of7c21172011-01-10 12:10:55 -05002834 struct file *,
Theodore Ts'o60fd4da2010-07-27 11:54:40 -04002835 struct ext4_dir_entry_2 *,
Tao Ma226ba972012-12-10 14:05:58 -05002836 struct buffer_head *, char *, int,
2837 unsigned int);
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002838#define ext4_check_dir_entry(dir, filp, de, bh, buf, size, offset) \
Theodore Ts'of7c21172011-01-10 12:10:55 -05002839 unlikely(__ext4_check_dir_entry(__func__, __LINE__, (dir), (filp), \
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002840 (de), (bh), (buf), (size), (offset)))
Mingming Cao617ba132006-10-11 01:20:53 -07002841extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
Theodore Ts'o2f618302015-04-12 00:56:26 -04002842 __u32 minor_hash,
2843 struct ext4_dir_entry_2 *dirent,
Jaegeuk Kima7550b32016-07-10 14:01:03 -04002844 struct fscrypt_str *ent_name);
Mingming Cao617ba132006-10-11 01:20:53 -07002845extern void ext4_htree_free_dir_info(struct dir_private_info *p);
Tao Ma978fef92012-12-10 14:05:58 -05002846extern int ext4_find_dest_de(struct inode *dir, struct inode *inode,
2847 struct buffer_head *bh,
2848 void *buf, int buf_size,
Theodore Ts'o5b643f92015-05-18 13:14:47 -04002849 struct ext4_filename *fname,
Tao Ma978fef92012-12-10 14:05:58 -05002850 struct ext4_dir_entry_2 **dest_de);
Daniel Rosenberg471fbbe2021-03-19 07:34:13 +00002851void ext4_insert_dentry(struct inode *dir, struct inode *inode,
Eric Biggers1bc0af62017-04-29 23:27:26 -04002852 struct ext4_dir_entry_2 *de,
2853 int buf_size,
2854 struct ext4_filename *fname);
Tao Ma978fef92012-12-10 14:05:58 -05002855static inline void ext4_update_dx_flag(struct inode *inode)
2856{
Jan Karaf902b2162020-11-18 16:30:32 +01002857 if (!ext4_has_feature_dir_index(inode->i_sb) &&
2858 ext4_test_inode_flag(inode, EXT4_INODE_INDEX)) {
Jan Kara48a34312020-02-10 15:43:16 +01002859 /* ext4_iget() should have caught this... */
2860 WARN_ON_ONCE(ext4_has_feature_metadata_csum(inode->i_sb));
Tao Ma978fef92012-12-10 14:05:58 -05002861 ext4_clear_inode_flag(inode, EXT4_INODE_INDEX);
Jan Kara48a34312020-02-10 15:43:16 +01002862 }
Tao Ma978fef92012-12-10 14:05:58 -05002863}
Eric Biggersd6006182017-04-29 23:47:50 -04002864static const unsigned char ext4_filetype_table[] = {
Tao Ma65d165d2012-12-10 14:05:59 -05002865 DT_UNKNOWN, DT_REG, DT_DIR, DT_CHR, DT_BLK, DT_FIFO, DT_SOCK, DT_LNK
2866};
2867
2868static inline unsigned char get_dtype(struct super_block *sb, int filetype)
2869{
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04002870 if (!ext4_has_feature_filetype(sb) || filetype >= EXT4_FT_MAX)
Tao Ma65d165d2012-12-10 14:05:59 -05002871 return DT_UNKNOWN;
2872
2873 return ext4_filetype_table[filetype];
2874}
Darrick J. Wong40b163f2014-07-28 13:06:26 -04002875extern int ext4_check_all_de(struct inode *dir, struct buffer_head *bh,
2876 void *buf, int buf_size);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002877
2878/* fsync.c */
Josef Bacik02c24a82011-07-16 20:44:56 -04002879extern int ext4_sync_file(struct file *, loff_t, loff_t, int);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002880
2881/* hash.c */
Gabriel Krisman Bertazib886ee32019-04-25 14:12:08 -04002882extern int ext4fs_dirhash(const struct inode *dir, const char *name, int len,
2883 struct dx_hash_info *hinfo);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002884
2885/* ialloc.c */
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07002886extern int ext4_mark_inode_used(struct super_block *sb, int ino);
Christian Brauner14f3db52021-01-21 14:19:57 +01002887extern struct inode *__ext4_new_inode(struct user_namespace *, handle_t *,
2888 struct inode *, umode_t,
Theodore Ts'o11395752013-02-09 16:27:09 -05002889 const struct qstr *qstr, __u32 goal,
Tahsin Erdogan1b917ed2017-06-21 21:21:39 -04002890 uid_t *owner, __u32 i_flags,
2891 int handle_type, unsigned int line_no,
2892 int nblocks);
Theodore Ts'o11395752013-02-09 16:27:09 -05002893
Christian Brauner14f3db52021-01-21 14:19:57 +01002894#define ext4_new_inode(handle, dir, mode, qstr, goal, owner, i_flags) \
2895 __ext4_new_inode(&init_user_ns, (handle), (dir), (mode), (qstr), \
2896 (goal), (owner), i_flags, 0, 0, 0)
2897#define ext4_new_inode_start_handle(mnt_userns, dir, mode, qstr, goal, owner, \
Theodore Ts'o11395752013-02-09 16:27:09 -05002898 type, nblocks) \
Christian Brauner14f3db52021-01-21 14:19:57 +01002899 __ext4_new_inode((mnt_userns), NULL, (dir), (mode), (qstr), (goal), (owner), \
Tahsin Erdogan1b917ed2017-06-21 21:21:39 -04002900 0, (type), __LINE__, (nblocks))
Theodore Ts'o11395752013-02-09 16:27:09 -05002901
2902
Theodore Ts'oaf5bc922008-09-08 22:25:24 -04002903extern void ext4_free_inode(handle_t *, struct inode *);
2904extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
2905extern unsigned long ext4_count_free_inodes(struct super_block *);
2906extern unsigned long ext4_count_dirs(struct super_block *);
2907extern void ext4_check_inodes_bitmap(struct super_block *);
Theodore Ts'o61d08672010-10-27 21:30:15 -04002908extern void ext4_mark_bitmap_end(int start_bit, int end_bit, char *bitmap);
Lukas Czernerbfff6872010-10-27 21:30:05 -04002909extern int ext4_init_inode_table(struct super_block *sb,
2910 ext4_group_t group, int barrier);
Theodore Ts'o813e5722012-02-20 17:52:46 -05002911extern void ext4_end_bitmap_read(struct buffer_head *bh, int uptodate);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002912
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07002913/* fast_commit.c */
Harshad Shirwadkarce8c59d2020-10-15 13:38:01 -07002914int ext4_fc_info_show(struct seq_file *seq, void *v);
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07002915void ext4_fc_init(struct super_block *sb, journal_t *journal);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002916void ext4_fc_init_inode(struct inode *inode);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -08002917void ext4_fc_track_range(handle_t *handle, struct inode *inode, ext4_lblk_t start,
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002918 ext4_lblk_t end);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -08002919void __ext4_fc_track_unlink(handle_t *handle, struct inode *inode,
2920 struct dentry *dentry);
2921void __ext4_fc_track_link(handle_t *handle, struct inode *inode,
2922 struct dentry *dentry);
2923void ext4_fc_track_unlink(handle_t *handle, struct dentry *dentry);
2924void ext4_fc_track_link(handle_t *handle, struct dentry *dentry);
Harshad Shirwadkar8210bb22021-03-16 15:19:21 -07002925void __ext4_fc_track_create(handle_t *handle, struct inode *inode,
2926 struct dentry *dentry);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -08002927void ext4_fc_track_create(handle_t *handle, struct dentry *dentry);
2928void ext4_fc_track_inode(handle_t *handle, struct inode *inode);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002929void ext4_fc_mark_ineligible(struct super_block *sb, int reason);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002930void ext4_fc_start_update(struct inode *inode);
2931void ext4_fc_stop_update(struct inode *inode);
2932void ext4_fc_del(struct inode *inode);
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07002933bool ext4_fc_replay_check_excluded(struct super_block *sb, ext4_fsblk_t block);
2934void ext4_fc_replay_cleanup(struct super_block *sb);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002935int ext4_fc_commit(journal_t *journal, tid_t commit_tid);
2936int __init ext4_fc_init_dentry_cache(void);
Sebastian Andrzej Siewiorab047d52021-12-23 17:44:36 +01002937void ext4_fc_destroy_dentry_cache(void);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002938
Alex Tomasc9de5602008-01-29 00:19:52 -05002939/* mballoc.c */
Christoph Hellwig247dbed2018-04-11 11:37:23 +02002940extern const struct seq_operations ext4_mb_seq_groups_ops;
Harshad Shirwadkarf68f4062021-04-01 10:21:28 -07002941extern const struct seq_operations ext4_mb_seq_structs_summary_ops;
Alex Tomasc9de5602008-01-29 00:19:52 -05002942extern long ext4_mb_stats;
2943extern long ext4_mb_max_to_scan;
Harshad Shirwadkara6c75ea2021-04-01 10:21:25 -07002944extern int ext4_seq_mb_stats_show(struct seq_file *seq, void *offset);
Akira Fujita9d990122012-05-28 14:19:25 -04002945extern int ext4_mb_init(struct super_block *);
Alex Tomasc9de5602008-01-29 00:19:52 -05002946extern int ext4_mb_release(struct super_block *);
2947extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
2948 struct ext4_allocation_request *, int *);
2949extern int ext4_mb_reserve_blocks(struct super_block *, int);
brookxu27bc4462020-08-17 15:36:15 +08002950extern void ext4_discard_preallocations(struct inode *, unsigned int);
Theodore Ts'o5dabfc72010-10-27 21:30:14 -04002951extern int __init ext4_init_mballoc(void);
2952extern void ext4_exit_mballoc(void);
Theodore Ts'o3d392b22020-07-17 00:14:40 -04002953extern ext4_group_t ext4_mb_prefetch(struct super_block *sb,
2954 ext4_group_t group,
2955 unsigned int nr, int *cnt);
2956extern void ext4_mb_prefetch_fini(struct super_block *sb, ext4_group_t group,
2957 unsigned int nr);
2958
Theodore Ts'o44338712009-11-22 07:44:56 -05002959extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
Theodore Ts'oe6362602009-11-23 07:17:05 -05002960 struct buffer_head *bh, ext4_fsblk_t block,
2961 unsigned long count, int flags);
Theodore Ts'o28623c22012-09-05 01:31:50 -04002962extern int ext4_mb_alloc_groupinfo(struct super_block *sb,
2963 ext4_group_t ngroups);
Aneesh Kumar K.V920313a2009-01-05 21:36:19 -05002964extern int ext4_mb_add_groupinfo(struct super_block *sb,
Frederic Bohe5f21b0e2008-07-11 19:27:31 -04002965 ext4_group_t i, struct ext4_group_desc *desc);
Yongqiang Yangcc7365d2011-07-26 21:46:07 -04002966extern int ext4_group_add_blocks(handle_t *handle, struct super_block *sb,
Amir Goldstein2846e822011-05-09 10:46:41 -04002967 ext4_fsblk_t block, unsigned long count);
Lukas Czerner7360d172010-10-27 21:30:12 -04002968extern int ext4_trim_fs(struct super_block *, struct fstrim_range *);
Daeho Jeonga0154342017-06-22 23:54:33 -04002969extern void ext4_process_freed_data(struct super_block *sb, tid_t commit_tid);
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07002970extern void ext4_mb_mark_bb(struct super_block *sb, ext4_fsblk_t block,
2971 int len, int state);
Lukas Czerner7360d172010-10-27 21:30:12 -04002972
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002973/* inode.c */
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07002974void ext4_inode_csum_set(struct inode *inode, struct ext4_inode *raw,
2975 struct ext4_inode_info *ei);
Theodore Ts'of348c252015-04-16 01:55:00 -04002976int ext4_inode_is_fast_symlink(struct inode *inode);
Theodore Ts'o10560082014-08-29 20:51:32 -04002977struct buffer_head *ext4_getblk(handle_t *, struct inode *, ext4_lblk_t, int);
Theodore Ts'o1c215022014-08-29 20:52:15 -04002978struct buffer_head *ext4_bread(handle_t *, struct inode *, ext4_lblk_t, int);
Tahsin Erdogan9699d4f2017-08-06 00:07:01 -04002979int ext4_bread_batch(struct inode *inode, ext4_lblk_t block, int bh_count,
2980 bool wait, struct buffer_head **bhs);
Jan Kara705965b2016-03-08 23:08:10 -05002981int ext4_get_block_unwritten(struct inode *inode, sector_t iblock,
2982 struct buffer_head *bh_result, int create);
Eric Sandeen6873fa02008-10-07 00:46:36 -04002983int ext4_get_block(struct inode *inode, sector_t iblock,
Jan Kara705965b2016-03-08 23:08:10 -05002984 struct buffer_head *bh_result, int create);
Tao Ma9c3569b2012-12-10 14:05:57 -05002985int ext4_da_get_block_prep(struct inode *inode, sector_t iblock,
2986 struct buffer_head *bh, int create);
Tao Maf19d5872012-12-10 14:05:51 -05002987int ext4_walk_page_buffers(handle_t *handle,
Jan Kara188c2992021-08-16 11:57:04 +02002988 struct inode *inode,
Tao Maf19d5872012-12-10 14:05:51 -05002989 struct buffer_head *head,
2990 unsigned from,
2991 unsigned to,
2992 int *partial,
Jan Kara188c2992021-08-16 11:57:04 +02002993 int (*fn)(handle_t *handle, struct inode *inode,
Tao Maf19d5872012-12-10 14:05:51 -05002994 struct buffer_head *bh));
Jan Kara188c2992021-08-16 11:57:04 +02002995int do_journal_get_write_access(handle_t *handle, struct inode *inode,
Tao Maf19d5872012-12-10 14:05:51 -05002996 struct buffer_head *bh);
Tao Ma9c3569b2012-12-10 14:05:57 -05002997#define FALL_BACK_TO_NONDELALLOC 1
2998#define CONVERT_INLINE_DATA 2
Dave Kleikampac27a0e2006-10-11 01:20:50 -07002999
Theodore Ts'o8a363972018-12-19 12:29:13 -05003000typedef enum {
3001 EXT4_IGET_NORMAL = 0,
3002 EXT4_IGET_SPECIAL = 0x0001, /* OK to iget a system inode */
3003 EXT4_IGET_HANDLE = 0x0002 /* Inode # is from a handle */
3004} ext4_iget_flags;
3005
3006extern struct inode *__ext4_iget(struct super_block *sb, unsigned long ino,
3007 ext4_iget_flags flags, const char *function,
3008 unsigned int line);
3009
3010#define ext4_iget(sb, ino, flags) \
3011 __ext4_iget((sb), (ino), (flags), __func__, __LINE__)
3012
Christoph Hellwiga9185b42010-03-05 09:21:37 +01003013extern int ext4_write_inode(struct inode *, struct writeback_control *);
Christian Brauner549c7292021-01-21 14:19:43 +01003014extern int ext4_setattr(struct user_namespace *, struct dentry *,
3015 struct iattr *);
3016extern int ext4_getattr(struct user_namespace *, const struct path *,
3017 struct kstat *, u32, unsigned int);
Al Viro0930fcc2010-06-07 13:16:22 -04003018extern void ext4_evict_inode(struct inode *);
3019extern void ext4_clear_inode(struct inode *);
Christian Brauner549c7292021-01-21 14:19:43 +01003020extern int ext4_file_getattr(struct user_namespace *, const struct path *,
3021 struct kstat *, u32, unsigned int);
Theodore Ts'oaf5bc922008-09-08 22:25:24 -04003022extern int ext4_sync_inode(handle_t *, struct inode *);
Christoph Hellwigaa385722011-05-27 06:53:02 -04003023extern void ext4_dirty_inode(struct inode *, int);
Mingming Cao617ba132006-10-11 01:20:53 -07003024extern int ext4_change_inode_journal_flag(struct inode *, int);
3025extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07003026extern int ext4_get_fc_inode_loc(struct super_block *sb, unsigned long ino,
3027 struct ext4_iloc *iloc);
Jan Karaa3612932013-08-16 21:19:41 -04003028extern int ext4_inode_attach_jinode(struct inode *inode);
Duane Griffin91ef4ca2008-07-11 19:27:31 -04003029extern int ext4_can_truncate(struct inode *inode);
Theodore Ts'o2c98eb52016-11-13 22:02:26 -05003030extern int ext4_truncate(struct inode *);
Ross Zwisler430657b2018-07-29 17:00:22 -04003031extern int ext4_break_layouts(struct inode *);
Ashish Sangwanaeb28172013-07-01 08:12:38 -04003032extern int ext4_punch_hole(struct inode *inode, loff_t offset, loff_t length);
Ira Weiny043546e2020-05-28 07:59:59 -07003033extern void ext4_set_inode_flags(struct inode *, bool init);
Theodore Ts'occd25062009-02-26 01:04:07 -05003034extern int ext4_alloc_da_blocks(struct inode *inode);
Mingming Cao617ba132006-10-11 01:20:53 -07003035extern void ext4_set_aops(struct inode *inode);
Alex Tomasa86c6182006-10-11 01:21:03 -07003036extern int ext4_writepage_trans_blocks(struct inode *);
Mingming Caof3bd1f32008-08-19 22:16:03 -04003037extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
Lukas Czernera87dd182013-05-27 23:32:35 -04003038extern int ext4_zero_partial_blocks(handle_t *handle, struct inode *inode,
3039 loff_t lstart, loff_t lend);
Souptick Joarder401b25a2018-10-02 22:20:50 -04003040extern vm_fault_t ext4_page_mkwrite(struct vm_fault *vmf);
Dmitry Monakhova9e7f442009-12-14 15:21:14 +03003041extern qsize_t *ext4_get_reserved_space(struct inode *inode);
Li Xi040cb372016-01-08 16:01:21 -05003042extern int ext4_get_projid(struct inode *inode, kprojid_t *projid);
Eric Whitneyf4567672018-10-01 14:33:24 -04003043extern void ext4_da_release_space(struct inode *inode, int to_free);
Aneesh Kumar K.V5f634d02010-01-25 04:00:31 -05003044extern void ext4_da_update_reserve_space(struct inode *inode,
3045 int used, int quota_claim);
Jan Kara53085fa2015-12-07 15:09:35 -05003046extern int ext4_issue_zeroout(struct inode *inode, ext4_lblk_t lblk,
3047 ext4_fsblk_t pblk, ext4_lblk_t len);
Amir Goldsteindae1e522011-06-27 19:40:50 -04003048
3049/* indirect.c */
3050extern int ext4_ind_map_blocks(handle_t *handle, struct inode *inode,
3051 struct ext4_map_blocks *map, int flags);
Jan Karafa55a0e2013-06-04 12:56:55 -04003052extern int ext4_ind_trans_blocks(struct inode *inode, int nrblocks);
Theodore Ts'o819c4922013-04-03 12:47:17 -04003053extern void ext4_ind_truncate(handle_t *, struct inode *inode);
Lukas Czerner4f579ae2014-07-15 06:03:38 -04003054extern int ext4_ind_remove_space(handle_t *handle, struct inode *inode,
3055 ext4_lblk_t start, ext4_lblk_t end);
Amir Goldsteinff9893d2011-06-27 16:36:31 -04003056
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003057/* ioctl.c */
Andi Kleen5cdd7b22008-04-29 22:03:54 -04003058extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
Theodore Ts'oaf5bc922008-09-08 22:25:24 -04003059extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
Miklos Szeredi4db5c2e2021-04-07 14:36:43 +02003060int ext4_fileattr_set(struct user_namespace *mnt_userns,
3061 struct dentry *dentry, struct fileattr *fa);
3062int ext4_fileattr_get(struct dentry *dentry, struct fileattr *fa);
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07003063extern void ext4_reset_inode_seed(struct inode *inode);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003064
Aneesh Kumar K.Vc14c6fd2008-01-28 23:58:26 -05003065/* migrate.c */
Aneesh Kumar K.V2a43a872008-09-13 12:52:26 -04003066extern int ext4_ext_migrate(struct inode *);
Lukas Czerner0d14b092013-04-10 23:32:52 -04003067extern int ext4_ind_migrate(struct inode *inode);
Wei Yongjun3d0518f2009-02-14 23:01:36 -05003068
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003069/* namei.c */
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07003070extern int ext4_init_new_dir(handle_t *handle, struct inode *dir,
3071 struct inode *inode);
Theodore Ts'of036adb2019-06-21 15:49:26 -04003072extern int ext4_dirblock_csum_verify(struct inode *inode,
3073 struct buffer_head *bh);
Mingming Cao617ba132006-10-11 01:20:53 -07003074extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003075 __u32 start_minor_hash, __u32 *next_hash);
Theodore Ts'o5b643f92015-05-18 13:14:47 -04003076extern int ext4_search_dir(struct buffer_head *bh,
3077 char *search_buf,
3078 int buf_size,
3079 struct inode *dir,
3080 struct ext4_filename *fname,
Theodore Ts'o5b643f92015-05-18 13:14:47 -04003081 unsigned int offset,
3082 struct ext4_dir_entry_2 **res_dir);
Kyoungho Koo2fe34d292020-08-10 17:07:05 +09003083extern int ext4_generic_delete_entry(struct inode *dir,
Tao Ma05019a92012-12-10 14:06:00 -05003084 struct ext4_dir_entry_2 *de_del,
3085 struct buffer_head *bh,
3086 void *entry_buf,
3087 int buf_size,
3088 int csum_size);
Jaegeuk Kima7550b32016-07-10 14:01:03 -04003089extern bool ext4_empty_dir(struct inode *inode);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003090
3091/* resize.c */
Theodore Ts'o1d0c3922020-02-15 16:40:37 -05003092extern void ext4_kvfree_array_rcu(void *to_free);
Mingming Cao617ba132006-10-11 01:20:53 -07003093extern int ext4_group_add(struct super_block *sb,
3094 struct ext4_new_group_data *input);
3095extern int ext4_group_extend(struct super_block *sb,
3096 struct ext4_super_block *es,
3097 ext4_fsblk_t n_blocks_count);
Yongqiang Yang19c52462012-01-04 17:09:44 -05003098extern int ext4_resize_fs(struct super_block *sb, ext4_fsblk_t n_blocks_count);
Lukas Czernerbbc605c2021-12-13 14:56:18 +01003099extern unsigned int ext4_list_backups(struct super_block *sb,
3100 unsigned int *three, unsigned int *five,
3101 unsigned int *seven);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003102
3103/* super.c */
Theodore Ts'ofb265c92018-11-25 17:20:31 -05003104extern struct buffer_head *ext4_sb_bread(struct super_block *sb,
3105 sector_t block, int op_flags);
zhangyi (F)8394a6a2020-09-24 15:33:37 +08003106extern struct buffer_head *ext4_sb_bread_unmovable(struct super_block *sb,
3107 sector_t block);
zhangyi (F)fa491b12020-09-24 15:33:32 +08003108extern void ext4_read_bh_nowait(struct buffer_head *bh, int op_flags,
3109 bh_end_io_t *end_io);
3110extern int ext4_read_bh(struct buffer_head *bh, int op_flags,
3111 bh_end_io_t *end_io);
3112extern int ext4_read_bh_lock(struct buffer_head *bh, int op_flags, bool wait);
zhangyi (F)5df1d412020-09-24 15:33:35 +08003113extern void ext4_sb_breadahead_unmovable(struct super_block *sb, sector_t block);
Theodore Ts'oebd173b2015-09-23 12:46:17 -04003114extern int ext4_seq_options_show(struct seq_file *seq, void *offset);
Theodore Ts'o952fc182012-07-09 16:27:05 -04003115extern int ext4_calculate_overhead(struct super_block *sb);
Lukas Czernerbbc605c2021-12-13 14:56:18 +01003116extern __le32 ext4_superblock_csum(struct super_block *sb,
3117 struct ext4_super_block *es);
Theodore Ts'o06db49e2012-10-10 01:06:58 -04003118extern void ext4_superblock_csum_set(struct super_block *sb);
Theodore Ts'o117fff12012-09-05 01:29:50 -04003119extern int ext4_alloc_flex_bg_array(struct super_block *sb,
3120 ext4_group_t ngroup);
Theodore Ts'o722887d2013-02-08 13:00:31 -05003121extern const char *ext4_decode_error(struct super_block *sb, int errno,
3122 char nbuf[16]);
Wang Shilongdb79e6d2018-05-12 11:39:40 -04003123extern void ext4_mark_group_bitmap_corrupted(struct super_block *sb,
3124 ext4_group_t block_group,
3125 unsigned int flags);
Joe Perchese7c96e82013-07-01 08:12:37 -04003126
Jan Kara014c9ca2020-11-27 12:33:57 +01003127extern __printf(7, 8)
3128void __ext4_error(struct super_block *, const char *, unsigned int, bool,
3129 int, __u64, const char *, ...);
Theodore Ts'o54d3adb2020-03-28 19:33:43 -04003130extern __printf(6, 7)
3131void __ext4_error_inode(struct inode *, const char *, unsigned int,
3132 ext4_fsblk_t, int, const char *, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07003133extern __printf(5, 6)
Joe Perchese7c96e82013-07-01 08:12:37 -04003134void __ext4_error_file(struct file *, const char *, unsigned int, ext4_fsblk_t,
Joe Perchesb9075fa2011-10-31 17:11:33 -07003135 const char *, ...);
Theodore Ts'oc398eda2010-07-27 11:56:40 -04003136extern void __ext4_std_error(struct super_block *, const char *,
3137 unsigned int, int);
Joe Perchesb9075fa2011-10-31 17:11:33 -07003138extern __printf(4, 5)
3139void __ext4_warning(struct super_block *, const char *, unsigned int,
3140 const char *, ...);
Andreas Dilgerb03a2f72015-06-15 14:50:26 -04003141extern __printf(4, 5)
3142void __ext4_warning_inode(const struct inode *inode, const char *function,
3143 unsigned int line, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07003144extern __printf(3, 4)
Joe Perchese7c96e82013-07-01 08:12:37 -04003145void __ext4_msg(struct super_block *, const char *, const char *, ...);
Johann Lombardic5e06d12011-05-24 18:31:25 -04003146extern void __dump_mmp_msg(struct super_block *, struct mmp_struct *mmp,
3147 const char *, unsigned int, const char *);
Joe Perchesb9075fa2011-10-31 17:11:33 -07003148extern __printf(7, 8)
3149void __ext4_grp_locked_error(const char *, unsigned int,
3150 struct super_block *, ext4_group_t,
3151 unsigned long, ext4_fsblk_t,
3152 const char *, ...);
Joe Perchese7c96e82013-07-01 08:12:37 -04003153
Andreas Dilgerb03a2f72015-06-15 14:50:26 -04003154#define EXT4_ERROR_INODE(inode, fmt, a...) \
3155 ext4_error_inode((inode), __func__, __LINE__, 0, (fmt), ## a)
3156
Theodore Ts'o54d3adb2020-03-28 19:33:43 -04003157#define EXT4_ERROR_INODE_ERR(inode, err, fmt, a...) \
3158 __ext4_error_inode((inode), __func__, __LINE__, 0, (err), (fmt), ## a)
3159
3160#define ext4_error_inode_block(inode, block, err, fmt, a...) \
3161 __ext4_error_inode((inode), __func__, __LINE__, (block), (err), \
3162 (fmt), ## a)
Andreas Dilgerb03a2f72015-06-15 14:50:26 -04003163
3164#define EXT4_ERROR_FILE(file, block, fmt, a...) \
3165 ext4_error_file((file), __func__, __LINE__, (block), (fmt), ## a)
3166
Jan Kara014c9ca2020-11-27 12:33:57 +01003167#define ext4_abort(sb, err, fmt, a...) \
3168 __ext4_error((sb), __func__, __LINE__, true, (err), 0, (fmt), ## a)
3169
Joe Perchese7c96e82013-07-01 08:12:37 -04003170#ifdef CONFIG_PRINTK
3171
3172#define ext4_error_inode(inode, func, line, block, fmt, ...) \
Theodore Ts'o54d3adb2020-03-28 19:33:43 -04003173 __ext4_error_inode(inode, func, line, block, 0, fmt, ##__VA_ARGS__)
3174#define ext4_error_inode_err(inode, func, line, block, err, fmt, ...) \
3175 __ext4_error_inode((inode), (func), (line), (block), \
3176 (err), (fmt), ##__VA_ARGS__)
Joe Perchese7c96e82013-07-01 08:12:37 -04003177#define ext4_error_file(file, func, line, block, fmt, ...) \
3178 __ext4_error_file(file, func, line, block, fmt, ##__VA_ARGS__)
3179#define ext4_error(sb, fmt, ...) \
Jan Kara014c9ca2020-11-27 12:33:57 +01003180 __ext4_error((sb), __func__, __LINE__, false, 0, 0, (fmt), \
3181 ##__VA_ARGS__)
Theodore Ts'o54d3adb2020-03-28 19:33:43 -04003182#define ext4_error_err(sb, err, fmt, ...) \
Jan Kara014c9ca2020-11-27 12:33:57 +01003183 __ext4_error((sb), __func__, __LINE__, false, (err), 0, (fmt), \
3184 ##__VA_ARGS__)
Joe Perchese7c96e82013-07-01 08:12:37 -04003185#define ext4_warning(sb, fmt, ...) \
3186 __ext4_warning(sb, __func__, __LINE__, fmt, ##__VA_ARGS__)
Andreas Dilgerb03a2f72015-06-15 14:50:26 -04003187#define ext4_warning_inode(inode, fmt, ...) \
3188 __ext4_warning_inode(inode, __func__, __LINE__, fmt, ##__VA_ARGS__)
Joe Perchese7c96e82013-07-01 08:12:37 -04003189#define ext4_msg(sb, level, fmt, ...) \
3190 __ext4_msg(sb, level, fmt, ##__VA_ARGS__)
3191#define dump_mmp_msg(sb, mmp, msg) \
3192 __dump_mmp_msg(sb, mmp, __func__, __LINE__, msg)
3193#define ext4_grp_locked_error(sb, grp, ino, block, fmt, ...) \
3194 __ext4_grp_locked_error(__func__, __LINE__, sb, grp, ino, block, \
3195 fmt, ##__VA_ARGS__)
3196
3197#else
3198
3199#define ext4_error_inode(inode, func, line, block, fmt, ...) \
3200do { \
3201 no_printk(fmt, ##__VA_ARGS__); \
Theodore Ts'o54d3adb2020-03-28 19:33:43 -04003202 __ext4_error_inode(inode, "", 0, block, 0, " "); \
3203} while (0)
3204#define ext4_error_inode_err(inode, func, line, block, err, fmt, ...) \
3205do { \
3206 no_printk(fmt, ##__VA_ARGS__); \
3207 __ext4_error_inode(inode, "", 0, block, err, " "); \
Joe Perchese7c96e82013-07-01 08:12:37 -04003208} while (0)
3209#define ext4_error_file(file, func, line, block, fmt, ...) \
3210do { \
3211 no_printk(fmt, ##__VA_ARGS__); \
3212 __ext4_error_file(file, "", 0, block, " "); \
3213} while (0)
3214#define ext4_error(sb, fmt, ...) \
3215do { \
3216 no_printk(fmt, ##__VA_ARGS__); \
Jan Kara014c9ca2020-11-27 12:33:57 +01003217 __ext4_error(sb, "", 0, false, 0, 0, " "); \
Joe Perchese7c96e82013-07-01 08:12:37 -04003218} while (0)
Theodore Ts'o54d3adb2020-03-28 19:33:43 -04003219#define ext4_error_err(sb, err, fmt, ...) \
Joe Perchese7c96e82013-07-01 08:12:37 -04003220do { \
3221 no_printk(fmt, ##__VA_ARGS__); \
Jan Kara014c9ca2020-11-27 12:33:57 +01003222 __ext4_error(sb, "", 0, false, err, 0, " "); \
Joe Perchese7c96e82013-07-01 08:12:37 -04003223} while (0)
3224#define ext4_warning(sb, fmt, ...) \
3225do { \
3226 no_printk(fmt, ##__VA_ARGS__); \
3227 __ext4_warning(sb, "", 0, " "); \
3228} while (0)
Andreas Dilgerb03a2f72015-06-15 14:50:26 -04003229#define ext4_warning_inode(inode, fmt, ...) \
3230do { \
3231 no_printk(fmt, ##__VA_ARGS__); \
3232 __ext4_warning_inode(inode, "", 0, " "); \
3233} while (0)
Joe Perchese7c96e82013-07-01 08:12:37 -04003234#define ext4_msg(sb, level, fmt, ...) \
3235do { \
3236 no_printk(fmt, ##__VA_ARGS__); \
3237 __ext4_msg(sb, "", " "); \
3238} while (0)
3239#define dump_mmp_msg(sb, mmp, msg) \
3240 __dump_mmp_msg(sb, mmp, "", 0, "")
3241#define ext4_grp_locked_error(sb, grp, ino, block, fmt, ...) \
3242do { \
3243 no_printk(fmt, ##__VA_ARGS__); \
3244 __ext4_grp_locked_error("", 0, sb, grp, ino, block, " "); \
3245} while (0)
3246
3247#endif
3248
Alexandre Ratchov8fadc142006-10-11 01:21:15 -07003249extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
3250 struct ext4_group_desc *bg);
3251extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
3252 struct ext4_group_desc *bg);
3253extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
3254 struct ext4_group_desc *bg);
Theodore Ts'o021b65b2011-09-09 19:08:51 -04003255extern __u32 ext4_free_group_clusters(struct super_block *sb,
3256 struct ext4_group_desc *bg);
Aneesh Kumar K.V560671a2009-01-05 22:20:24 -05003257extern __u32 ext4_free_inodes_count(struct super_block *sb,
3258 struct ext4_group_desc *bg);
3259extern __u32 ext4_used_dirs_count(struct super_block *sb,
3260 struct ext4_group_desc *bg);
3261extern __u32 ext4_itable_unused_count(struct super_block *sb,
3262 struct ext4_group_desc *bg);
Alexandre Ratchov8fadc142006-10-11 01:21:15 -07003263extern void ext4_block_bitmap_set(struct super_block *sb,
3264 struct ext4_group_desc *bg, ext4_fsblk_t blk);
3265extern void ext4_inode_bitmap_set(struct super_block *sb,
3266 struct ext4_group_desc *bg, ext4_fsblk_t blk);
3267extern void ext4_inode_table_set(struct super_block *sb,
3268 struct ext4_group_desc *bg, ext4_fsblk_t blk);
Theodore Ts'o021b65b2011-09-09 19:08:51 -04003269extern void ext4_free_group_clusters_set(struct super_block *sb,
3270 struct ext4_group_desc *bg,
3271 __u32 count);
Aneesh Kumar K.V560671a2009-01-05 22:20:24 -05003272extern void ext4_free_inodes_set(struct super_block *sb,
3273 struct ext4_group_desc *bg, __u32 count);
3274extern void ext4_used_dirs_set(struct super_block *sb,
3275 struct ext4_group_desc *bg, __u32 count);
3276extern void ext4_itable_unused_set(struct super_block *sb,
3277 struct ext4_group_desc *bg, __u32 count);
Darrick J. Wongfeb0ab32012-04-29 18:45:10 -04003278extern int ext4_group_desc_csum_verify(struct super_block *sb, __u32 group,
Theodore Ts'obb23c202009-05-01 19:44:44 -04003279 struct ext4_group_desc *gdp);
Darrick J. Wongfeb0ab32012-04-29 18:45:10 -04003280extern void ext4_group_desc_csum_set(struct super_block *sb, __u32 group,
3281 struct ext4_group_desc *gdp);
Theodore Ts'o7f511862013-01-13 08:41:45 -05003282extern int ext4_register_li_request(struct super_block *sb,
3283 ext4_group_t first_not_zeroed);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003284
Dmitry Monakhov9aa5d32b2014-10-13 03:36:16 -04003285static inline int ext4_has_metadata_csum(struct super_block *sb)
3286{
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04003287 WARN_ON_ONCE(ext4_has_feature_metadata_csum(sb) &&
Dmitry Monakhov9aa5d32b2014-10-13 03:36:16 -04003288 !EXT4_SB(sb)->s_chksum_driver);
3289
Tahsin Erdogandec214d2017-06-22 11:44:55 -04003290 return ext4_has_feature_metadata_csum(sb) &&
3291 (EXT4_SB(sb)->s_chksum_driver != NULL);
Dmitry Monakhov9aa5d32b2014-10-13 03:36:16 -04003292}
Tahsin Erdogandec214d2017-06-22 11:44:55 -04003293
3294static inline int ext4_has_group_desc_csum(struct super_block *sb)
3295{
3296 return ext4_has_feature_gdt_csum(sb) || ext4_has_metadata_csum(sb);
3297}
3298
Petr Malat81e8c3c2020-08-25 17:00:16 +02003299#define ext4_read_incompat_64bit_val(es, name) \
3300 (((es)->s_feature_incompat & cpu_to_le32(EXT4_FEATURE_INCOMPAT_64BIT) \
3301 ? (ext4_fsblk_t)le32_to_cpu(es->name##_hi) << 32 : 0) | \
3302 le32_to_cpu(es->name##_lo))
3303
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003304static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
3305{
Petr Malat81e8c3c2020-08-25 17:00:16 +02003306 return ext4_read_incompat_64bit_val(es, s_blocks_count);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003307}
3308
3309static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
3310{
Petr Malat81e8c3c2020-08-25 17:00:16 +02003311 return ext4_read_incompat_64bit_val(es, s_r_blocks_count);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003312}
3313
3314static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
3315{
Petr Malat81e8c3c2020-08-25 17:00:16 +02003316 return ext4_read_incompat_64bit_val(es, s_free_blocks_count);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003317}
3318
3319static inline void ext4_blocks_count_set(struct ext4_super_block *es,
3320 ext4_fsblk_t blk)
3321{
Aneesh Kumar K.V6bc9fef2007-10-16 18:38:25 -04003322 es->s_blocks_count_lo = cpu_to_le32((u32)blk);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003323 es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
3324}
3325
3326static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
3327 ext4_fsblk_t blk)
3328{
Aneesh Kumar K.V308ba3e2007-10-16 18:38:25 -04003329 es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003330 es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
3331}
3332
3333static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
3334 ext4_fsblk_t blk)
3335{
Aneesh Kumar K.V308ba3e2007-10-16 18:38:25 -04003336 es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003337 es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
3338}
3339
Artem Blagodarenkoe08ac992017-06-21 21:09:57 -04003340static inline loff_t ext4_isize(struct super_block *sb,
3341 struct ext4_inode *raw_inode)
Aneesh Kumar K.Va48380f2008-01-28 23:58:27 -05003342{
Artem Blagodarenkoe08ac992017-06-21 21:09:57 -04003343 if (ext4_has_feature_largedir(sb) ||
3344 S_ISREG(le16_to_cpu(raw_inode->i_mode)))
Theodore Ts'o06a279d2009-01-17 18:41:37 -05003345 return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
3346 le32_to_cpu(raw_inode->i_size_lo);
Artem Blagodarenkoe08ac992017-06-21 21:09:57 -04003347
3348 return (loff_t) le32_to_cpu(raw_inode->i_size_lo);
Aneesh Kumar K.Va48380f2008-01-28 23:58:27 -05003349}
Laurent Vivierbd81d8e2006-10-11 01:21:10 -07003350
Aneesh Kumar K.Va48380f2008-01-28 23:58:27 -05003351static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
3352{
3353 raw_inode->i_size_lo = cpu_to_le32(i_size);
3354 raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
3355}
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003356
Alex Tomasc9de5602008-01-29 00:19:52 -05003357static inline
3358struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
Theodore Ts'oaf5bc922008-09-08 22:25:24 -04003359 ext4_group_t group)
Alex Tomasc9de5602008-01-29 00:19:52 -05003360{
Suraj Jitindar Singhdf3da4e2020-02-18 19:08:50 -08003361 struct ext4_group_info **grp_info;
Alex Tomasc9de5602008-01-29 00:19:52 -05003362 long indexv, indexh;
Theodore Ts'o2f2e09e2013-06-06 11:16:43 -04003363 BUG_ON(group >= EXT4_SB(sb)->s_groups_count);
Alex Tomasc9de5602008-01-29 00:19:52 -05003364 indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
3365 indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
Suraj Jitindar Singhdf3da4e2020-02-18 19:08:50 -08003366 grp_info = sbi_array_rcu_deref(EXT4_SB(sb), s_group_info, indexv);
3367 return grp_info[indexh];
Alex Tomasc9de5602008-01-29 00:19:52 -05003368}
3369
Theodore Ts'o8df96752009-05-01 08:50:38 -04003370/*
3371 * Reading s_groups_count requires using smp_rmb() afterwards. See
3372 * the locking protocol documented in the comments of ext4_group_add()
3373 * in resize.c
3374 */
3375static inline ext4_group_t ext4_get_groups_count(struct super_block *sb)
3376{
3377 ext4_group_t ngroups = EXT4_SB(sb)->s_groups_count;
3378
3379 smp_rmb();
3380 return ngroups;
3381}
Alex Tomasc9de5602008-01-29 00:19:52 -05003382
Jose R. Santos772cb7c2008-07-11 19:27:31 -04003383static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
3384 ext4_group_t block_group)
3385{
3386 return block_group >> sbi->s_log_groups_per_flex;
3387}
3388
3389static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
3390{
3391 return 1 << sbi->s_log_groups_per_flex;
3392}
3393
Mingming Cao617ba132006-10-11 01:20:53 -07003394#define ext4_std_error(sb, errno) \
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003395do { \
3396 if ((errno)) \
Theodore Ts'oc398eda2010-07-27 11:56:40 -04003397 __ext4_std_error((sb), __func__, __LINE__, (errno)); \
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003398} while (0)
3399
Aneesh Kumar K.Va30d542a2008-10-09 10:56:23 -04003400#ifdef CONFIG_SMP
Theodore Ts'odf55c992011-09-09 19:16:51 -04003401/* Each CPU can accumulate percpu_counter_batch clusters in their local
3402 * counters. So we need to make sure we have free clusters more
Eric Dumazet179f7eb2009-01-06 14:41:04 -08003403 * than percpu_counter_batch * nr_cpu_ids. Also add a window of 4 times.
Aneesh Kumar K.Va30d542a2008-10-09 10:56:23 -04003404 */
Theodore Ts'odf55c992011-09-09 19:16:51 -04003405#define EXT4_FREECLUSTERS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
Aneesh Kumar K.Va30d542a2008-10-09 10:56:23 -04003406#else
Theodore Ts'odf55c992011-09-09 19:16:51 -04003407#define EXT4_FREECLUSTERS_WATERMARK 0
Aneesh Kumar K.Va30d542a2008-10-09 10:56:23 -04003408#endif
3409
Jan Kara90e775b2013-08-17 10:09:31 -04003410/* Update i_disksize. Requires i_mutex to avoid races with truncate */
Aneesh Kumar K.Vcf17fea2008-09-13 13:06:18 -04003411static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
3412{
Jan Kara90e775b2013-08-17 10:09:31 -04003413 WARN_ON_ONCE(S_ISREG(inode->i_mode) &&
Al Viro59551022016-01-22 15:40:57 -05003414 !inode_is_locked(inode));
Aneesh Kumar K.Vcf17fea2008-09-13 13:06:18 -04003415 down_write(&EXT4_I(inode)->i_data_sem);
3416 if (newsize > EXT4_I(inode)->i_disksize)
Qian Cai35df4292020-02-07 09:29:11 -05003417 WRITE_ONCE(EXT4_I(inode)->i_disksize, newsize);
Aneesh Kumar K.Vcf17fea2008-09-13 13:06:18 -04003418 up_write(&EXT4_I(inode)->i_data_sem);
Jan Kara90e775b2013-08-17 10:09:31 -04003419}
3420
Dmitry Monakhov4631dbf2014-08-23 17:48:28 -04003421/* Update i_size, i_disksize. Requires i_mutex to avoid races with truncate */
3422static inline int ext4_update_inode_size(struct inode *inode, loff_t newsize)
3423{
3424 int changed = 0;
3425
3426 if (newsize > inode->i_size) {
3427 i_size_write(inode, newsize);
3428 changed = 1;
3429 }
3430 if (newsize > EXT4_I(inode)->i_disksize) {
3431 ext4_update_i_disksize(inode, newsize);
3432 changed |= 2;
3433 }
3434 return changed;
3435}
3436
Jan Kara01127842015-12-07 14:34:49 -05003437int ext4_update_disksize_before_punch(struct inode *inode, loff_t offset,
3438 loff_t len);
3439
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003440struct ext4_group_info {
3441 unsigned long bb_state;
Chunguang Xuaddd7522020-09-28 19:36:35 +08003442#ifdef AGGRESSIVE_CHECK
3443 unsigned long bb_check_counter;
3444#endif
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003445 struct rb_root bb_free_root;
Eric Sandeena36b4492009-08-25 22:36:45 -04003446 ext4_grpblk_t bb_first_free; /* first free block */
3447 ext4_grpblk_t bb_free; /* total free blocks */
3448 ext4_grpblk_t bb_fragments; /* nr of freespace fragments */
Curt Wohlgemuth8a57d9d2010-05-16 15:00:00 -04003449 ext4_grpblk_t bb_largest_free_order;/* order of largest frag in BG */
Harshad Shirwadkar196e4022021-04-01 10:21:27 -07003450 ext4_group_t bb_group; /* Group number */
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003451 struct list_head bb_prealloc_list;
3452#ifdef DOUBLE_CHECK
3453 void *bb_bitmap;
3454#endif
3455 struct rw_semaphore alloc_sem;
Harshad Shirwadkar196e4022021-04-01 10:21:27 -07003456 struct rb_node bb_avg_fragment_size_rb;
3457 struct list_head bb_largest_free_order_node;
Eric Sandeena36b4492009-08-25 22:36:45 -04003458 ext4_grpblk_t bb_counters[]; /* Nr of free power-of-two-block
3459 * regions, index is order.
3460 * bb_counters[3] = 5 means
3461 * 5 free 8-block regions. */
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003462};
3463
Tao Ma3d56b8d2011-07-11 00:03:38 -04003464#define EXT4_GROUP_INFO_NEED_INIT_BIT 0
3465#define EXT4_GROUP_INFO_WAS_TRIMMED_BIT 1
Darrick J. Wong163a2032013-08-28 17:35:51 -04003466#define EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT 2
Darrick J. Wong87a39382013-08-28 18:32:58 -04003467#define EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT 3
Wang Shilongdb79e6d2018-05-12 11:39:40 -04003468#define EXT4_GROUP_INFO_BBITMAP_CORRUPT \
3469 (1 << EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT)
3470#define EXT4_GROUP_INFO_IBITMAP_CORRUPT \
3471 (1 << EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT)
Alex Zhuravlevcfd73232020-04-21 10:54:07 +03003472#define EXT4_GROUP_INFO_BBITMAP_READ_BIT 4
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003473
3474#define EXT4_MB_GRP_NEED_INIT(grp) \
3475 (test_bit(EXT4_GROUP_INFO_NEED_INIT_BIT, &((grp)->bb_state)))
Darrick J. Wong163a2032013-08-28 17:35:51 -04003476#define EXT4_MB_GRP_BBITMAP_CORRUPT(grp) \
3477 (test_bit(EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT, &((grp)->bb_state)))
Darrick J. Wong87a39382013-08-28 18:32:58 -04003478#define EXT4_MB_GRP_IBITMAP_CORRUPT(grp) \
3479 (test_bit(EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT, &((grp)->bb_state)))
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003480
Tao Ma3d56b8d2011-07-11 00:03:38 -04003481#define EXT4_MB_GRP_WAS_TRIMMED(grp) \
3482 (test_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
3483#define EXT4_MB_GRP_SET_TRIMMED(grp) \
3484 (set_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
3485#define EXT4_MB_GRP_CLEAR_TRIMMED(grp) \
3486 (clear_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
Alex Zhuravlevcfd73232020-04-21 10:54:07 +03003487#define EXT4_MB_GRP_TEST_AND_SET_READ(grp) \
3488 (test_and_set_bit(EXT4_GROUP_INFO_BBITMAP_READ_BIT, &((grp)->bb_state)))
Tao Ma3d56b8d2011-07-11 00:03:38 -04003489
Theodore Ts'o50797482009-09-18 13:34:02 -04003490#define EXT4_MAX_CONTENTION 8
3491#define EXT4_CONTENTION_THRESHOLD 2
3492
Aneesh Kumar K.V955ce5f2009-05-02 20:35:09 -04003493static inline spinlock_t *ext4_group_lock_ptr(struct super_block *sb,
3494 ext4_group_t group)
3495{
3496 return bgl_lock_ptr(EXT4_SB(sb)->s_blockgroup_lock, group);
3497}
3498
Theodore Ts'o50797482009-09-18 13:34:02 -04003499/*
3500 * Returns true if the filesystem is busy enough that attempts to
3501 * access the block group locks has run into contention.
3502 */
3503static inline int ext4_fs_is_busy(struct ext4_sb_info *sbi)
3504{
3505 return (atomic_read(&sbi->s_lock_busy) > EXT4_CONTENTION_THRESHOLD);
3506}
3507
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003508static inline void ext4_lock_group(struct super_block *sb, ext4_group_t group)
3509{
Theodore Ts'o50797482009-09-18 13:34:02 -04003510 spinlock_t *lock = ext4_group_lock_ptr(sb, group);
3511 if (spin_trylock(lock))
3512 /*
3513 * We're able to grab the lock right away, so drop the
3514 * lock contention counter.
3515 */
3516 atomic_add_unless(&EXT4_SB(sb)->s_lock_busy, -1, 0);
3517 else {
3518 /*
3519 * The lock is busy, so bump the contention counter,
3520 * and then wait on the spin lock.
3521 */
3522 atomic_add_unless(&EXT4_SB(sb)->s_lock_busy, 1,
3523 EXT4_MAX_CONTENTION);
3524 spin_lock(lock);
3525 }
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003526}
3527
3528static inline void ext4_unlock_group(struct super_block *sb,
3529 ext4_group_t group)
3530{
Aneesh Kumar K.V955ce5f2009-05-02 20:35:09 -04003531 spin_unlock(ext4_group_lock_ptr(sb, group));
Aneesh Kumar K.V5d1b1b32009-01-05 22:19:52 -05003532}
3533
Roman Anufrievf177ee02020-10-22 06:20:59 +03003534#ifdef CONFIG_QUOTA
3535static inline bool ext4_quota_capable(struct super_block *sb)
3536{
3537 return (test_opt(sb, QUOTA) || ext4_has_feature_quota(sb));
3538}
3539
3540static inline bool ext4_is_quota_journalled(struct super_block *sb)
3541{
3542 struct ext4_sb_info *sbi = EXT4_SB(sb);
3543
3544 return (ext4_has_feature_quota(sb) ||
3545 sbi->s_qf_names[USRQUOTA] || sbi->s_qf_names[GRPQUOTA]);
3546}
Jan Kara25c6d982021-08-16 11:57:05 +02003547int ext4_enable_quotas(struct super_block *sb);
Roman Anufrievf177ee02020-10-22 06:20:59 +03003548#endif
3549
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003550/*
Theodore Ts'o1f7d1e72011-06-27 19:16:02 -04003551 * Block validity checking
3552 */
3553#define ext4_check_indirect_blockref(inode, bh) \
3554 ext4_check_blockref(__func__, __LINE__, inode, \
3555 (__le32 *)(bh)->b_data, \
3556 EXT4_ADDR_PER_BLOCK((inode)->i_sb))
3557
3558#define ext4_ind_check_inode(inode) \
3559 ext4_check_blockref(__func__, __LINE__, inode, \
3560 EXT4_I(inode)->i_data, \
3561 EXT4_NDIR_BLOCKS)
3562
3563/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003564 * Inodes and files operations
3565 */
3566
3567/* dir.c */
Mingming Cao617ba132006-10-11 01:20:53 -07003568extern const struct file_operations ext4_dir_operations;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003569
3570/* file.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003571extern const struct inode_operations ext4_file_inode_operations;
Mingming Cao617ba132006-10-11 01:20:53 -07003572extern const struct file_operations ext4_file_operations;
Toshiyuki Okajimae0d10bf2010-10-27 21:30:06 -04003573extern loff_t ext4_llseek(struct file *file, loff_t offset, int origin);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003574
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003575/* inline.c */
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003576extern int ext4_get_max_inline_size(struct inode *inode);
3577extern int ext4_find_inline_data_nolock(struct inode *inode);
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003578extern int ext4_init_inline_data(handle_t *handle, struct inode *inode,
3579 unsigned int len);
3580extern int ext4_destroy_inline_data(handle_t *handle, struct inode *inode);
3581
3582extern int ext4_readpage_inline(struct inode *inode, struct page *page);
3583extern int ext4_try_to_write_inline_data(struct address_space *mapping,
3584 struct inode *inode,
3585 loff_t pos, unsigned len,
3586 unsigned flags,
3587 struct page **pagep);
3588extern int ext4_write_inline_data_end(struct inode *inode,
3589 loff_t pos, unsigned len,
3590 unsigned copied,
3591 struct page *page);
3592extern struct buffer_head *
3593ext4_journalled_write_inline_data(struct inode *inode,
3594 unsigned len,
3595 struct page *page);
3596extern int ext4_da_write_inline_data_begin(struct address_space *mapping,
3597 struct inode *inode,
3598 loff_t pos, unsigned len,
3599 unsigned flags,
3600 struct page **pagep,
3601 void **fsdata);
Theodore Ts'o5b643f92015-05-18 13:14:47 -04003602extern int ext4_try_add_inline_entry(handle_t *handle,
3603 struct ext4_filename *fname,
Theodore Ts'o56a04912016-01-08 16:00:31 -05003604 struct inode *dir, struct inode *inode);
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003605extern int ext4_try_create_inline_dir(handle_t *handle,
3606 struct inode *parent,
3607 struct inode *inode);
3608extern int ext4_read_inline_dir(struct file *filp,
Al Viro725bebb2013-05-17 16:08:53 -04003609 struct dir_context *ctx,
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003610 int *has_inline_data);
Theodore Ts'o7633b082019-06-21 21:57:00 -04003611extern int ext4_inlinedir_to_tree(struct file *dir_file,
3612 struct inode *dir, ext4_lblk_t block,
3613 struct dx_hash_info *hinfo,
3614 __u32 start_hash, __u32 start_minor_hash,
3615 int *has_inline_data);
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003616extern struct buffer_head *ext4_find_inline_entry(struct inode *dir,
Theodore Ts'o5b643f92015-05-18 13:14:47 -04003617 struct ext4_filename *fname,
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003618 struct ext4_dir_entry_2 **res_dir,
3619 int *has_inline_data);
3620extern int ext4_delete_inline_entry(handle_t *handle,
3621 struct inode *dir,
3622 struct ext4_dir_entry_2 *de_del,
3623 struct buffer_head *bh,
3624 int *has_inline_data);
Jaegeuk Kima7550b32016-07-10 14:01:03 -04003625extern bool empty_inline_dir(struct inode *dir, int *has_inline_data);
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003626extern struct buffer_head *ext4_get_first_inline_block(struct inode *inode,
3627 struct ext4_dir_entry_2 **parent_de,
3628 int *retval);
3629extern int ext4_inline_data_fiemap(struct inode *inode,
3630 struct fiemap_extent_info *fieinfo,
Dmitry Monakhovd952d692014-12-02 16:11:20 -05003631 int *has_inline, __u64 start, __u64 len);
Andreas Gruenbacher7046ae32017-10-01 17:57:54 -04003632
3633struct iomap;
3634extern int ext4_inline_data_iomap(struct inode *inode, struct iomap *iomap);
3635
Theodore Ts'o01daf942017-01-22 19:35:49 -05003636extern int ext4_inline_data_truncate(struct inode *inode, int *has_inline);
Theodore Ts'o95eaefb2013-02-09 15:23:03 -05003637
3638extern int ext4_convert_inline_data(struct inode *inode);
3639
Zheng Liu83447cc2014-07-15 10:10:04 -04003640static inline int ext4_has_inline_data(struct inode *inode)
3641{
3642 return ext4_test_inode_flag(inode, EXT4_INODE_INLINE_DATA) &&
3643 EXT4_I(inode)->i_inline_off;
3644}
3645
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003646/* namei.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003647extern const struct inode_operations ext4_dir_inode_operations;
3648extern const struct inode_operations ext4_special_inode_operations;
Theodore Ts'o596397b2009-05-01 13:49:15 -04003649extern struct dentry *ext4_get_parent(struct dentry *child);
Tao Maa774f9c2012-12-10 14:05:57 -05003650extern struct ext4_dir_entry_2 *ext4_init_dot_dotdot(struct inode *inode,
3651 struct ext4_dir_entry_2 *de,
3652 int blocksize, int csum_size,
3653 unsigned int parent_ino, int dotdot_real_len);
Theodore Ts'oddce3b92019-06-21 16:31:47 -04003654extern void ext4_initialize_dirent_tail(struct buffer_head *bh,
3655 unsigned int blocksize);
Theodore Ts'of036adb2019-06-21 15:49:26 -04003656extern int ext4_handle_dirty_dirblock(handle_t *handle, struct inode *inode,
3657 struct buffer_head *bh);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -08003658extern int __ext4_unlink(handle_t *handle, struct inode *dir, const struct qstr *d_name,
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07003659 struct inode *inode);
3660extern int __ext4_link(struct inode *dir, struct inode *inode,
3661 struct dentry *dentry);
Gabriel Krisman Bertazib886ee32019-04-25 14:12:08 -04003662
Tao Ma8af0f082013-04-19 17:53:09 -04003663#define S_SHIFT 12
Dan Carpenter381cebf2017-08-05 19:00:31 -04003664static const unsigned char ext4_type_by_mode[(S_IFMT >> S_SHIFT) + 1] = {
Tao Ma8af0f082013-04-19 17:53:09 -04003665 [S_IFREG >> S_SHIFT] = EXT4_FT_REG_FILE,
3666 [S_IFDIR >> S_SHIFT] = EXT4_FT_DIR,
3667 [S_IFCHR >> S_SHIFT] = EXT4_FT_CHRDEV,
3668 [S_IFBLK >> S_SHIFT] = EXT4_FT_BLKDEV,
3669 [S_IFIFO >> S_SHIFT] = EXT4_FT_FIFO,
3670 [S_IFSOCK >> S_SHIFT] = EXT4_FT_SOCK,
3671 [S_IFLNK >> S_SHIFT] = EXT4_FT_SYMLINK,
3672};
3673
3674static inline void ext4_set_de_type(struct super_block *sb,
3675 struct ext4_dir_entry_2 *de,
3676 umode_t mode) {
Darrick J. Wonge2b911c2015-10-17 16:18:43 -04003677 if (ext4_has_feature_filetype(sb))
Tao Ma8af0f082013-04-19 17:53:09 -04003678 de->file_type = ext4_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
3679}
3680
Theodore Ts'of64e02f2015-04-08 00:00:32 -04003681/* readpages.c */
Matthew Wilcox (Oracle)a07f6242020-06-01 21:47:20 -07003682extern int ext4_mpage_readpages(struct inode *inode,
Matthew Wilcox (Oracle)6311f91f2020-06-01 21:47:16 -07003683 struct readahead_control *rac, struct page *page);
Eric Biggers22cfe4b2019-07-22 09:26:24 -07003684extern int __init ext4_init_post_read_processing(void);
3685extern void ext4_exit_post_read_processing(void);
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003686
3687/* symlink.c */
Al Viroa7a67e82015-04-27 17:51:30 -04003688extern const struct inode_operations ext4_encrypted_symlink_inode_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003689extern const struct inode_operations ext4_symlink_inode_operations;
3690extern const struct inode_operations ext4_fast_symlink_inode_operations;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003691
Theodore Ts'ob5799012015-09-23 12:44:17 -04003692/* sysfs.c */
Jonathan Daviesd578b992021-06-11 14:02:08 +00003693extern void ext4_notify_error_sysfs(struct ext4_sb_info *sbi);
Theodore Ts'ob5799012015-09-23 12:44:17 -04003694extern int ext4_register_sysfs(struct super_block *sb);
Theodore Ts'oebd173b2015-09-23 12:46:17 -04003695extern void ext4_unregister_sysfs(struct super_block *sb);
Theodore Ts'ob5799012015-09-23 12:44:17 -04003696extern int __init ext4_init_sysfs(void);
3697extern void ext4_exit_sysfs(void);
3698
Theodore Ts'o6fd058f2009-05-17 15:38:01 -04003699/* block_validity */
3700extern void ext4_release_system_zone(struct super_block *sb);
3701extern int ext4_setup_system_zone(struct super_block *sb);
Theodore Ts'o5dabfc72010-10-27 21:30:14 -04003702extern int __init ext4_init_system_zone(void);
3703extern void ext4_exit_system_zone(void);
Jan Karace9f24c2020-07-28 15:04:34 +02003704extern int ext4_inode_block_valid(struct inode *inode,
3705 ext4_fsblk_t start_blk,
3706 unsigned int count);
Theodore Ts'o1f7d1e72011-06-27 19:16:02 -04003707extern int ext4_check_blockref(const char *, unsigned int,
3708 struct inode *, __le32 *, unsigned int);
Theodore Ts'o6fd058f2009-05-17 15:38:01 -04003709
Alex Tomasa86c6182006-10-11 01:21:03 -07003710/* extents.c */
Theodore Ts'o4a092d72012-11-28 13:03:30 -05003711struct ext4_ext_path;
3712struct ext4_extent;
3713
Zheng Liud7b2a002013-08-28 14:47:06 -04003714/*
3715 * Maximum number of logical blocks in a file; ext4_extent's ee_block is
3716 * __le32.
3717 */
3718#define EXT_MAX_BLOCKS 0xffffffff
3719
Harshad Shirwadkar4209ae12020-04-26 18:34:37 -07003720extern void ext4_ext_tree_init(handle_t *handle, struct inode *inode);
Jan Karafffb2732013-06-04 13:01:11 -04003721extern int ext4_ext_index_trans_blocks(struct inode *inode, int extents);
Theodore Ts'oe35fd662010-05-16 19:00:00 -04003722extern int ext4_ext_map_blocks(handle_t *handle, struct inode *inode,
3723 struct ext4_map_blocks *map, int flags);
Theodore Ts'od0abb362016-11-13 22:02:28 -05003724extern int ext4_ext_truncate(handle_t *, struct inode *);
Theodore Ts'o26a4c0c2013-04-03 12:45:17 -04003725extern int ext4_ext_remove_space(struct inode *inode, ext4_lblk_t start,
3726 ext4_lblk_t end);
Alex Tomasa86c6182006-10-11 01:21:03 -07003727extern void ext4_ext_init(struct super_block *);
3728extern void ext4_ext_release(struct super_block *);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01003729extern long ext4_fallocate(struct file *file, int mode, loff_t offset,
Amit Aroraa2df2a62007-07-17 21:42:41 -04003730 loff_t len);
Jan Kara6b523df2013-06-04 13:21:11 -04003731extern int ext4_convert_unwritten_extents(handle_t *handle, struct inode *inode,
3732 loff_t offset, ssize_t len);
Ritesh Harjania00713e2019-10-16 13:07:08 +05303733extern int ext4_convert_unwritten_io_end_vec(handle_t *handle,
3734 ext4_io_end_t *io_end);
Theodore Ts'oe35fd662010-05-16 19:00:00 -04003735extern int ext4_map_blocks(handle_t *handle, struct inode *inode,
3736 struct ext4_map_blocks *map, int flags);
Theodore Ts'o4a092d72012-11-28 13:03:30 -05003737extern int ext4_ext_calc_credits_for_single_extent(struct inode *inode,
3738 int num,
3739 struct ext4_ext_path *path);
Theodore Ts'o4a092d72012-11-28 13:03:30 -05003740extern int ext4_ext_insert_extent(handle_t *, struct inode *,
Theodore Ts'odfe50802014-09-01 14:37:09 -04003741 struct ext4_ext_path **,
Theodore Ts'o4a092d72012-11-28 13:03:30 -05003742 struct ext4_extent *, int);
Theodore Ts'oed8a1a72014-09-01 14:43:09 -04003743extern struct ext4_ext_path *ext4_find_extent(struct inode *, ext4_lblk_t,
3744 struct ext4_ext_path **,
3745 int flags);
Theodore Ts'o4a092d72012-11-28 13:03:30 -05003746extern void ext4_ext_drop_refs(struct ext4_ext_path *);
3747extern int ext4_ext_check_inode(struct inode *inode);
Dmitry Monakhovfcf6b1b72014-08-30 23:52:19 -04003748extern ext4_lblk_t ext4_ext_next_allocated_block(struct ext4_ext_path *path);
Aneesh Kumar K.V3a06d772008-11-22 15:04:59 -05003749extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
3750 __u64 start, __u64 len);
Theodore Ts'obb5835e2019-08-11 16:32:41 -04003751extern int ext4_get_es_cache(struct inode *inode,
3752 struct fiemap_extent_info *fieinfo,
3753 __u64 start, __u64 len);
Theodore Ts'o7869a4a2013-08-16 22:05:14 -04003754extern int ext4_ext_precache(struct inode *inode);
Dmitry Monakhovfcf6b1b72014-08-30 23:52:19 -04003755extern int ext4_swap_extents(handle_t *handle, struct inode *inode1,
3756 struct inode *inode2, ext4_lblk_t lblk1,
3757 ext4_lblk_t lblk2, ext4_lblk_t count,
3758 int mark_unwritten,int *err);
Eric Whitney0b02f4c2018-10-01 14:19:37 -04003759extern int ext4_clu_mapped(struct inode *inode, ext4_lblk_t lclu);
Jan Karaa4130362019-11-05 17:44:16 +01003760extern int ext4_datasem_ensure_credits(handle_t *handle, struct inode *inode,
Jan Kara83448bd2019-11-05 17:44:29 +01003761 int check_cred, int restart_cred,
3762 int revoke_cred);
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07003763extern void ext4_ext_replay_shrink_inode(struct inode *inode, ext4_lblk_t end);
3764extern int ext4_ext_replay_set_iblocks(struct inode *inode);
3765extern int ext4_ext_replay_update_ex(struct inode *inode, ext4_lblk_t start,
3766 int len, int unwritten, ext4_fsblk_t pblk);
3767extern int ext4_ext_clear_bb(struct inode *inode);
Jan Karaa4130362019-11-05 17:44:16 +01003768
Theodore Ts'o4a092d72012-11-28 13:03:30 -05003769
Akira Fujita748de672009-06-17 19:24:03 -04003770/* move_extent.c */
Dr. Tilmann Bubeck393d1d12013-04-08 12:54:05 -04003771extern void ext4_double_down_write_data_sem(struct inode *first,
3772 struct inode *second);
3773extern void ext4_double_up_write_data_sem(struct inode *orig_inode,
3774 struct inode *donor_inode);
Akira Fujita748de672009-06-17 19:24:03 -04003775extern int ext4_move_extents(struct file *o_filp, struct file *d_filp,
3776 __u64 start_orig, __u64 start_donor,
3777 __u64 len, __u64 *moved_len);
3778
Theodore Ts'obd2d0212010-10-27 21:30:10 -04003779/* page-io.c */
Theodore Ts'o5dabfc72010-10-27 21:30:14 -04003780extern int __init ext4_init_pageio(void);
3781extern void ext4_exit_pageio(void);
Theodore Ts'obd2d0212010-10-27 21:30:10 -04003782extern ext4_io_end_t *ext4_init_io_end(struct inode *inode, gfp_t flags);
Jan Kara97a851e2013-06-04 11:58:58 -04003783extern ext4_io_end_t *ext4_get_io_end(ext4_io_end_t *io_end);
3784extern int ext4_put_io_end(ext4_io_end_t *io_end);
3785extern void ext4_put_io_end_defer(ext4_io_end_t *io_end);
3786extern void ext4_io_submit_init(struct ext4_io_submit *io,
3787 struct writeback_control *wbc);
Jan Kara2e8fa542013-06-04 14:21:02 -04003788extern void ext4_end_io_rsv_work(struct work_struct *work);
Theodore Ts'obd2d0212010-10-27 21:30:10 -04003789extern void ext4_io_submit(struct ext4_io_submit *io);
3790extern int ext4_bio_write_page(struct ext4_io_submit *io,
3791 struct page *page,
3792 int len,
Namjae Jeon1c8349a2014-05-12 08:12:25 -04003793 bool keep_towrite);
Ritesh Harjanic8cc8812019-10-16 13:07:10 +05303794extern struct ext4_io_end_vec *ext4_alloc_io_end_vec(ext4_io_end_t *io_end);
3795extern struct ext4_io_end_vec *ext4_last_io_end_vec(ext4_io_end_t *io_end);
Aneesh Kumar K.V3a06d772008-11-22 15:04:59 -05003796
Johann Lombardic5e06d12011-05-24 18:31:25 -04003797/* mmp.c */
3798extern int ext4_multi_mount_protect(struct super_block *, ext4_fsblk_t);
3799
Pavel Skripkin618f0032021-04-30 21:50:46 +03003800/* mmp.c */
3801extern void ext4_stop_mmpd(struct ext4_sb_info *sbi);
3802
Eric Biggersc93d8f82019-07-22 09:26:24 -07003803/* verity.c */
3804extern const struct fsverity_operations ext4_verityops;
3805
Jan Kara25c6d982021-08-16 11:57:05 +02003806/* orphan.c */
3807extern int ext4_orphan_add(handle_t *, struct inode *);
3808extern int ext4_orphan_del(handle_t *, struct inode *);
3809extern void ext4_orphan_cleanup(struct super_block *sb,
3810 struct ext4_super_block *es);
Jan Kara02f310f2021-08-16 11:57:06 +02003811extern void ext4_release_orphan_info(struct super_block *sb);
3812extern int ext4_init_orphan_info(struct super_block *sb);
3813extern int ext4_orphan_file_empty(struct super_block *sb);
3814extern void ext4_orphan_file_block_trigger(
3815 struct jbd2_buffer_trigger_type *triggers,
3816 struct buffer_head *bh,
3817 void *data, size_t size);
Jan Kara25c6d982021-08-16 11:57:05 +02003818
Jan Kara3613d222013-06-04 13:19:34 -04003819/*
Adam Buchbinder48fc7f72012-09-19 21:48:00 -04003820 * Add new method to test whether block and inode bitmaps are properly
Aneesh Kumar K.V2ccb5fb2009-01-05 21:49:55 -05003821 * initialized. With uninit_bg reading the block from disk is not enough
3822 * to mark the bitmap uptodate. We need to also zero-out the bitmap
3823 */
3824#define BH_BITMAP_UPTODATE BH_JBDPrivateStart
3825
3826static inline int bitmap_uptodate(struct buffer_head *bh)
3827{
3828 return (buffer_uptodate(bh) &&
3829 test_bit(BH_BITMAP_UPTODATE, &(bh)->b_state));
3830}
3831static inline void set_bitmap_uptodate(struct buffer_head *bh)
3832{
3833 set_bit(BH_BITMAP_UPTODATE, &(bh)->b_state);
3834}
3835
Akinobu Mita731eb1a2010-03-03 23:55:01 -05003836#define in_range(b, first, len) ((b) >= (first) && (b) <= (first) + (len) - 1)
3837
Eric Sandeene9e3bce2011-02-12 08:17:34 -05003838/* For ioend & aio unwritten conversion wait queues */
3839#define EXT4_WQ_HASH_SZ 37
3840#define ext4_ioend_wq(v) (&ext4__ioend_wq[((unsigned long)(v)) %\
3841 EXT4_WQ_HASH_SZ])
Eric Sandeene9e3bce2011-02-12 08:17:34 -05003842extern wait_queue_head_t ext4__ioend_wq[EXT4_WQ_HASH_SZ];
Eric Sandeene9e3bce2011-02-12 08:17:34 -05003843
Yongqiang Yang8f82f842011-07-26 21:35:44 -04003844extern int ext4_resize_begin(struct super_block *sb);
3845extern void ext4_resize_end(struct super_block *sb);
3846
Jan Kara74c66bc2016-02-29 08:36:38 +11003847static inline void ext4_set_io_unwritten_flag(struct inode *inode,
3848 struct ext4_io_end *io_end)
3849{
3850 if (!(io_end->flag & EXT4_IO_END_UNWRITTEN)) {
3851 io_end->flag |= EXT4_IO_END_UNWRITTEN;
3852 atomic_inc(&EXT4_I(inode)->i_unwritten);
3853 }
3854}
3855
3856static inline void ext4_clear_io_unwritten_flag(ext4_io_end_t *io_end)
3857{
3858 struct inode *inode = io_end->inode;
3859
3860 if (io_end->flag & EXT4_IO_END_UNWRITTEN) {
3861 io_end->flag &= ~EXT4_IO_END_UNWRITTEN;
3862 /* Wake up anyone waiting on unwritten extent conversion */
3863 if (atomic_dec_and_test(&EXT4_I(inode)->i_unwritten))
3864 wake_up_all(ext4_ioend_wq(inode));
3865 }
3866}
3867
Christoph Hellwig8ff6daa2017-01-27 23:20:26 -08003868extern const struct iomap_ops ext4_iomap_ops;
Jan Kara8cd115b2019-12-18 18:44:33 +01003869extern const struct iomap_ops ext4_iomap_overwrite_ops;
Matthew Bobrowski09edf4d2019-11-05 23:03:31 +11003870extern const struct iomap_ops ext4_iomap_report_ops;
Jan Kara364443c2016-11-20 17:36:06 -05003871
ZhangXiaoxu7963e5a2019-08-22 23:00:32 -04003872static inline int ext4_buffer_uptodate(struct buffer_head *bh)
3873{
3874 /*
3875 * If the buffer has the write error flag, we have failed
3876 * to write out data in the block. In this case, we don't
3877 * have to read the block because we may read the old data
3878 * successfully.
3879 */
Joseph Qi5c680152021-04-26 14:29:47 +08003880 if (buffer_write_io_error(bh))
ZhangXiaoxu7963e5a2019-08-22 23:00:32 -04003881 set_buffer_uptodate(bh);
3882 return buffer_uptodate(bh);
3883}
3884
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003885#endif /* __KERNEL__ */
3886
Darrick J. Wong6a797d22015-10-17 16:16:04 -04003887#define EFSBADCRC EBADMSG /* Bad CRC detected */
3888#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
3889
Christoph Hellwig3dcf5452008-04-29 18:13:32 -04003890#endif /* _EXT4_H */