Merge tag 'linux-watchdog-6.1-rc4' of git://www.linux-watchdog.org/linux-watchdog
[linux-block.git] / fs / btrfs / extent_io.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
9888c340
DS
2
3#ifndef BTRFS_EXTENT_IO_H
4#define BTRFS_EXTENT_IO_H
d1310b2e
CM
5
6#include <linux/rbtree.h>
b7ac31b7 7#include <linux/refcount.h>
10c5db28 8#include <linux/fiemap.h>
deb67895 9#include <linux/btrfs_tree.h>
0ff40013 10#include "compression.h"
ac467772 11#include "ulist.h"
d1310b2e 12
80cb3836
DS
13enum {
14 EXTENT_BUFFER_UPTODATE,
15 EXTENT_BUFFER_DIRTY,
16 EXTENT_BUFFER_CORRUPT,
17 /* this got triggered by readahead */
18 EXTENT_BUFFER_READAHEAD,
19 EXTENT_BUFFER_TREE_REF,
20 EXTENT_BUFFER_STALE,
21 EXTENT_BUFFER_WRITEBACK,
22 /* read IO error */
23 EXTENT_BUFFER_READ_ERR,
24 EXTENT_BUFFER_UNMAPPED,
25 EXTENT_BUFFER_IN_TREE,
26 /* write IO error */
27 EXTENT_BUFFER_WRITE_ERR,
d3575156 28 EXTENT_BUFFER_NO_CHECK,
80cb3836 29};
b4ce94de 30
da2c7009 31/* these are flags for __process_pages_contig */
c2790a2e 32#define PAGE_UNLOCK (1 << 0)
6869b0a8
QW
33/* Page starts writeback, clear dirty bit and set writeback bit */
34#define PAGE_START_WRITEBACK (1 << 1)
35#define PAGE_END_WRITEBACK (1 << 2)
f57ad937 36#define PAGE_SET_ORDERED (1 << 3)
6869b0a8
QW
37#define PAGE_SET_ERROR (1 << 4)
38#define PAGE_LOCK (1 << 5)
a791e35e 39
d1310b2e
CM
40/*
41 * page->private values. Every page that is controlled by the extent
42 * map has page->private set to one.
43 */
44#define EXTENT_PAGE_PRIVATE 1
d1310b2e 45
2fe1d551
OS
46/*
47 * The extent buffer bitmap operations are done with byte granularity instead of
48 * word granularity for two reasons:
49 * 1. The bitmaps must be little-endian on disk.
50 * 2. Bitmap items are not guaranteed to be aligned to a word and therefore a
51 * single word in a bitmap may straddle two pages in the extent buffer.
52 */
53#define BIT_BYTE(nr) ((nr) / BITS_PER_BYTE)
54#define BYTE_MASK ((1 << BITS_PER_BYTE) - 1)
55#define BITMAP_FIRST_BYTE_MASK(start) \
56 ((BYTE_MASK << ((start) & (BITS_PER_BYTE - 1))) & BYTE_MASK)
57#define BITMAP_LAST_BYTE_MASK(nbits) \
58 (BYTE_MASK >> (-(nbits) & (BITS_PER_BYTE - 1)))
59
7aa51232 60struct btrfs_bio;
ea466794 61struct btrfs_root;
6fc0ef68 62struct btrfs_inode;
183ebab7 63struct btrfs_fs_info;
47dc196a 64struct io_failure_record;
9c7d3a54 65struct extent_io_tree;
a758781d 66
a62a3bd9
JB
67int __init extent_buffer_init_cachep(void);
68void __cold extent_buffer_free_cachep(void);
69
ad357938 70typedef void (submit_bio_hook_t)(struct inode *inode, struct bio *bio,
77d5d689 71 int mirror_num,
cb3a12d9 72 enum btrfs_compression_type compress_type);
77d5d689 73
8896a08d 74typedef blk_status_t (extent_submit_bio_start_t)(struct inode *inode,
1941b64b 75 struct bio *bio, u64 dio_file_offset);
a758781d 76
deb67895 77#define INLINE_EXTENT_BUFFER_PAGES (BTRFS_MAX_METADATA_BLOCKSIZE / PAGE_SIZE)
d1310b2e
CM
78struct extent_buffer {
79 u64 start;
80 unsigned long len;
b4ce94de 81 unsigned long bflags;
f28491e0 82 struct btrfs_fs_info *fs_info;
3083ee2e 83 spinlock_t refs_lock;
727011e0 84 atomic_t refs;
0b32f4bb 85 atomic_t io_pages;
5cf1ab56 86 int read_mirror;
19fe0a8b 87 struct rcu_head rcu_head;
5b25f70f 88 pid_t lock_owner;
656f30db 89 /* >= 0 if eb belongs to a log tree, -1 otherwise */
dc516164
DS
90 s8 log_index;
91
92 struct rw_semaphore lock;
bd681513 93
b8dae313 94 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
d3575156 95 struct list_head release_list;
6d49ba1b
ES
96#ifdef CONFIG_BTRFS_DEBUG
97 struct list_head leak_list;
98#endif
d1310b2e
CM
99};
100
ac467772
QW
101/*
102 * Structure to record how many bytes and which ranges are set/cleared
103 */
104struct extent_changeset {
105 /* How many bytes are set/cleared in this operation */
b642b52d 106 u64 bytes_changed;
ac467772
QW
107
108 /* Changed ranges */
53d32359 109 struct ulist range_changed;
ac467772
QW
110};
111
364ecf36
QW
112static inline void extent_changeset_init(struct extent_changeset *changeset)
113{
114 changeset->bytes_changed = 0;
115 ulist_init(&changeset->range_changed);
116}
117
118static inline struct extent_changeset *extent_changeset_alloc(void)
119{
120 struct extent_changeset *ret;
121
122 ret = kmalloc(sizeof(*ret), GFP_KERNEL);
123 if (!ret)
124 return NULL;
125
126 extent_changeset_init(ret);
127 return ret;
128}
129
130static inline void extent_changeset_release(struct extent_changeset *changeset)
131{
132 if (!changeset)
133 return;
134 changeset->bytes_changed = 0;
135 ulist_release(&changeset->range_changed);
136}
137
138static inline void extent_changeset_free(struct extent_changeset *changeset)
139{
140 if (!changeset)
141 return;
142 extent_changeset_release(changeset);
143 kfree(changeset);
144}
145
d1310b2e
CM
146struct extent_map_tree;
147
477a30ba 148int try_release_extent_mapping(struct page *page, gfp_t mask);
f7a52a40 149int try_release_extent_buffer(struct page *page);
cd716d8f 150
fdaf9a58 151int btrfs_read_folio(struct file *file, struct folio *folio);
2bd0fc93 152int extent_write_locked_range(struct inode *inode, u64 start, u64 end);
8ae225a8 153int extent_writepages(struct address_space *mapping,
d1310b2e 154 struct writeback_control *wbc);
0b32f4bb
JB
155int btree_write_cache_pages(struct address_space *mapping,
156 struct writeback_control *wbc);
ba206a02 157void extent_readahead(struct readahead_control *rac);
facee0a0 158int extent_fiemap(struct btrfs_inode *inode, struct fiemap_extent_info *fieinfo,
bab16e21 159 u64 start, u64 len);
32443de3
QW
160int set_page_extent_mapped(struct page *page);
161void clear_page_extent_mapped(struct page *page);
d1310b2e 162
f28491e0 163struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
3fbaf258 164 u64 start, u64 owner_root, int level);
0f331229
OS
165struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
166 u64 start, unsigned long len);
3f556f78 167struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
da17066c 168 u64 start);
2b48966a 169struct extent_buffer *btrfs_clone_extent_buffer(const struct extent_buffer *src);
f28491e0 170struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
452c75c3 171 u64 start);
d1310b2e 172void free_extent_buffer(struct extent_buffer *eb);
3083ee2e 173void free_extent_buffer_stale(struct extent_buffer *eb);
bb82ab88
AJ
174#define WAIT_NONE 0
175#define WAIT_COMPLETE 1
176#define WAIT_PAGE_LOCK 2
c2ccfbc6 177int read_extent_buffer_pages(struct extent_buffer *eb, int wait,
6af49dbd 178 int mirror_num);
fd8b2b61 179void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
bfb484d9 180void btrfs_readahead_tree_block(struct btrfs_fs_info *fs_info,
3fbaf258 181 u64 bytenr, u64 owner_root, u64 gen, int level);
bfb484d9 182void btrfs_readahead_node_child(struct extent_buffer *node, int slot);
479ed9ab 183
cc5e31a4 184static inline int num_extent_pages(const struct extent_buffer *eb)
479ed9ab 185{
4a3dc938
QW
186 /*
187 * For sectorsize == PAGE_SIZE case, since nodesize is always aligned to
188 * sectorsize, it's just eb->len >> PAGE_SHIFT.
189 *
190 * For sectorsize < PAGE_SIZE case, we could have nodesize < PAGE_SIZE,
191 * thus have to ensure we get at least one page.
192 */
193 return (eb->len >> PAGE_SHIFT) ?: 1;
479ed9ab
RD
194}
195
2b48966a 196static inline int extent_buffer_uptodate(const struct extent_buffer *eb)
ba020491
AJ
197{
198 return test_bit(EXTENT_BUFFER_UPTODATE, &eb->bflags);
199}
200
1cbb1f45
JM
201int memcmp_extent_buffer(const struct extent_buffer *eb, const void *ptrv,
202 unsigned long start, unsigned long len);
203void read_extent_buffer(const struct extent_buffer *eb, void *dst,
d1310b2e
CM
204 unsigned long start,
205 unsigned long len);
a48b73ec
JB
206int read_extent_buffer_to_user_nofault(const struct extent_buffer *eb,
207 void __user *dst, unsigned long start,
208 unsigned long len);
2b48966a
DS
209void write_extent_buffer_fsid(const struct extent_buffer *eb, const void *src);
210void write_extent_buffer_chunk_tree_uuid(const struct extent_buffer *eb,
f157bf76 211 const void *src);
2b48966a 212void write_extent_buffer(const struct extent_buffer *eb, const void *src,
d1310b2e 213 unsigned long start, unsigned long len);
2b48966a
DS
214void copy_extent_buffer_full(const struct extent_buffer *dst,
215 const struct extent_buffer *src);
216void copy_extent_buffer(const struct extent_buffer *dst,
217 const struct extent_buffer *src,
d1310b2e
CM
218 unsigned long dst_offset, unsigned long src_offset,
219 unsigned long len);
2b48966a
DS
220void memcpy_extent_buffer(const struct extent_buffer *dst,
221 unsigned long dst_offset, unsigned long src_offset,
222 unsigned long len);
223void memmove_extent_buffer(const struct extent_buffer *dst,
224 unsigned long dst_offset, unsigned long src_offset,
b159fa28 225 unsigned long len);
2b48966a 226void memzero_extent_buffer(const struct extent_buffer *eb, unsigned long start,
b159fa28 227 unsigned long len);
2b48966a 228int extent_buffer_test_bit(const struct extent_buffer *eb, unsigned long start,
3e1e8bb7 229 unsigned long pos);
2b48966a 230void extent_buffer_bitmap_set(const struct extent_buffer *eb, unsigned long start,
3e1e8bb7 231 unsigned long pos, unsigned long len);
2b48966a
DS
232void extent_buffer_bitmap_clear(const struct extent_buffer *eb,
233 unsigned long start, unsigned long pos,
234 unsigned long len);
235void clear_extent_buffer_dirty(const struct extent_buffer *eb);
abb57ef3 236bool set_extent_buffer_dirty(struct extent_buffer *eb);
09c25a8c 237void set_extent_buffer_uptodate(struct extent_buffer *eb);
69ba3927 238void clear_extent_buffer_uptodate(struct extent_buffer *eb);
2b48966a 239int extent_buffer_under_io(const struct extent_buffer *eb);
bd1fa4f0 240void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
f6311572 241void extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
ad7ff17b 242void extent_clear_unlock_delalloc(struct btrfs_inode *inode, u64 start, u64 end,
74e9194a 243 struct page *locked_page,
f97e27e9 244 u32 bits_to_clear, unsigned long page_ops);
d6f65c27
JB
245int extent_invalidate_folio(struct extent_io_tree *tree,
246 struct folio *folio, size_t offset);
dd137dd1
STD
247
248int btrfs_alloc_page_array(unsigned int nr_pages, struct page **page_array);
4a54c8c1 249
b5227c07 250void end_extent_writepage(struct page *page, int err, u64 start, u64 end);
2b48966a 251int btrfs_repair_eb_io_failure(const struct extent_buffer *eb, int mirror_num);
2fe6303e
MX
252
253/*
254 * When IO fails, either with EIO or csum verification fails, we
255 * try other mirrors that might have a good copy of the data. This
256 * io_failure_record is used to record state as we go through all the
1245835d 257 * mirrors. If another mirror has good data, the sector is set up to date
2fe6303e
MX
258 * and things continue. If a good mirror can't be found, the original
259 * bio end_io callback is called to indicate things have failed.
260 */
261struct io_failure_record {
87c11705
JB
262 /* Use rb_simple_node for search/insert */
263 struct {
264 struct rb_node rb_node;
265 u64 bytenr;
266 };
2fe6303e 267 struct page *page;
2fe6303e
MX
268 u64 len;
269 u64 logical;
2fe6303e
MX
270 int this_mirror;
271 int failed_mirror;
c144c63f 272 int num_copies;
2fe6303e
MX
273};
274
7aa51232
CH
275int btrfs_repair_one_sector(struct inode *inode, struct btrfs_bio *failed_bbio,
276 u32 bio_offset, struct page *page, unsigned int pgoff,
150e4b05 277 submit_bio_hook_t *submit_bio_hook);
d6f65c27
JB
278void btrfs_free_io_failure_record(struct btrfs_inode *inode, u64 start, u64 end);
279int btrfs_clean_io_failure(struct btrfs_inode *inode, u64 start,
280 struct page *page, unsigned int pg_offset);
77d5d689 281
294e30fe 282#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
9978059b 283bool find_lock_delalloc_range(struct inode *inode,
ce9f967f
JT
284 struct page *locked_page, u64 *start,
285 u64 *end);
0d4cf4e6 286#endif
faa2dbf0 287struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,
da17066c 288 u64 start);
3fd63727
JB
289
290#ifdef CONFIG_BTRFS_DEBUG
291void btrfs_extent_buffer_leak_debug_check(struct btrfs_fs_info *fs_info);
292#else
293#define btrfs_extent_buffer_leak_debug_check(fs_info) do {} while (0)
294#endif
295
294e30fe 296#endif