Merge tag 'iomap-5.19-merge-2' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[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
ea466794 60struct btrfs_root;
6fc0ef68 61struct btrfs_inode;
facc8a22 62struct btrfs_io_bio;
183ebab7 63struct btrfs_fs_info;
47dc196a 64struct io_failure_record;
9c7d3a54 65struct extent_io_tree;
a758781d 66
ad357938 67typedef void (submit_bio_hook_t)(struct inode *inode, struct bio *bio,
77d5d689 68 int mirror_num,
cb3a12d9 69 enum btrfs_compression_type compress_type);
77d5d689 70
8896a08d 71typedef blk_status_t (extent_submit_bio_start_t)(struct inode *inode,
1941b64b 72 struct bio *bio, u64 dio_file_offset);
a758781d 73
deb67895 74#define INLINE_EXTENT_BUFFER_PAGES (BTRFS_MAX_METADATA_BLOCKSIZE / PAGE_SIZE)
d1310b2e
CM
75struct extent_buffer {
76 u64 start;
77 unsigned long len;
b4ce94de 78 unsigned long bflags;
f28491e0 79 struct btrfs_fs_info *fs_info;
3083ee2e 80 spinlock_t refs_lock;
727011e0 81 atomic_t refs;
0b32f4bb 82 atomic_t io_pages;
5cf1ab56 83 int read_mirror;
19fe0a8b 84 struct rcu_head rcu_head;
5b25f70f 85 pid_t lock_owner;
656f30db 86 /* >= 0 if eb belongs to a log tree, -1 otherwise */
dc516164
DS
87 s8 log_index;
88
89 struct rw_semaphore lock;
bd681513 90
b8dae313 91 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
d3575156 92 struct list_head release_list;
6d49ba1b
ES
93#ifdef CONFIG_BTRFS_DEBUG
94 struct list_head leak_list;
95#endif
d1310b2e
CM
96};
97
ac467772
QW
98/*
99 * Structure to record how many bytes and which ranges are set/cleared
100 */
101struct extent_changeset {
102 /* How many bytes are set/cleared in this operation */
b642b52d 103 u64 bytes_changed;
ac467772
QW
104
105 /* Changed ranges */
53d32359 106 struct ulist range_changed;
ac467772
QW
107};
108
364ecf36
QW
109static inline void extent_changeset_init(struct extent_changeset *changeset)
110{
111 changeset->bytes_changed = 0;
112 ulist_init(&changeset->range_changed);
113}
114
115static inline struct extent_changeset *extent_changeset_alloc(void)
116{
117 struct extent_changeset *ret;
118
119 ret = kmalloc(sizeof(*ret), GFP_KERNEL);
120 if (!ret)
121 return NULL;
122
123 extent_changeset_init(ret);
124 return ret;
125}
126
127static inline void extent_changeset_release(struct extent_changeset *changeset)
128{
129 if (!changeset)
130 return;
131 changeset->bytes_changed = 0;
132 ulist_release(&changeset->range_changed);
133}
134
135static inline void extent_changeset_free(struct extent_changeset *changeset)
136{
137 if (!changeset)
138 return;
139 extent_changeset_release(changeset);
140 kfree(changeset);
141}
142
d1310b2e
CM
143struct extent_map_tree;
144
fc4f21b1 145typedef struct extent_map *(get_extent_t)(struct btrfs_inode *inode,
39b07b5d
OS
146 struct page *page, size_t pg_offset,
147 u64 start, u64 len);
d1310b2e 148
477a30ba 149int try_release_extent_mapping(struct page *page, gfp_t mask);
f7a52a40 150int try_release_extent_buffer(struct page *page);
cd716d8f 151
7aab8b32 152int btrfs_readpage(struct file *file, struct page *page);
0a9b0e53 153int extent_write_full_page(struct page *page, struct writeback_control *wbc);
2bd0fc93 154int extent_write_locked_range(struct inode *inode, u64 start, u64 end);
8ae225a8 155int extent_writepages(struct address_space *mapping,
d1310b2e 156 struct writeback_control *wbc);
0b32f4bb
JB
157int btree_write_cache_pages(struct address_space *mapping,
158 struct writeback_control *wbc);
ba206a02 159void extent_readahead(struct readahead_control *rac);
facee0a0 160int extent_fiemap(struct btrfs_inode *inode, struct fiemap_extent_info *fieinfo,
bab16e21 161 u64 start, u64 len);
32443de3
QW
162int set_page_extent_mapped(struct page *page);
163void clear_page_extent_mapped(struct page *page);
d1310b2e 164
f28491e0 165struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
3fbaf258 166 u64 start, u64 owner_root, int level);
0f331229
OS
167struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
168 u64 start, unsigned long len);
3f556f78 169struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
da17066c 170 u64 start);
2b48966a 171struct extent_buffer *btrfs_clone_extent_buffer(const struct extent_buffer *src);
f28491e0 172struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
452c75c3 173 u64 start);
d1310b2e 174void free_extent_buffer(struct extent_buffer *eb);
3083ee2e 175void free_extent_buffer_stale(struct extent_buffer *eb);
bb82ab88
AJ
176#define WAIT_NONE 0
177#define WAIT_COMPLETE 1
178#define WAIT_PAGE_LOCK 2
c2ccfbc6 179int read_extent_buffer_pages(struct extent_buffer *eb, int wait,
6af49dbd 180 int mirror_num);
fd8b2b61 181void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
bfb484d9 182void btrfs_readahead_tree_block(struct btrfs_fs_info *fs_info,
3fbaf258 183 u64 bytenr, u64 owner_root, u64 gen, int level);
bfb484d9 184void btrfs_readahead_node_child(struct extent_buffer *node, int slot);
479ed9ab 185
cc5e31a4 186static inline int num_extent_pages(const struct extent_buffer *eb)
479ed9ab 187{
4a3dc938
QW
188 /*
189 * For sectorsize == PAGE_SIZE case, since nodesize is always aligned to
190 * sectorsize, it's just eb->len >> PAGE_SHIFT.
191 *
192 * For sectorsize < PAGE_SIZE case, we could have nodesize < PAGE_SIZE,
193 * thus have to ensure we get at least one page.
194 */
195 return (eb->len >> PAGE_SHIFT) ?: 1;
479ed9ab
RD
196}
197
2b48966a 198static inline int extent_buffer_uptodate(const struct extent_buffer *eb)
ba020491
AJ
199{
200 return test_bit(EXTENT_BUFFER_UPTODATE, &eb->bflags);
201}
202
1cbb1f45
JM
203int memcmp_extent_buffer(const struct extent_buffer *eb, const void *ptrv,
204 unsigned long start, unsigned long len);
205void read_extent_buffer(const struct extent_buffer *eb, void *dst,
d1310b2e
CM
206 unsigned long start,
207 unsigned long len);
a48b73ec
JB
208int read_extent_buffer_to_user_nofault(const struct extent_buffer *eb,
209 void __user *dst, unsigned long start,
210 unsigned long len);
2b48966a
DS
211void write_extent_buffer_fsid(const struct extent_buffer *eb, const void *src);
212void write_extent_buffer_chunk_tree_uuid(const struct extent_buffer *eb,
f157bf76 213 const void *src);
2b48966a 214void write_extent_buffer(const struct extent_buffer *eb, const void *src,
d1310b2e 215 unsigned long start, unsigned long len);
2b48966a
DS
216void copy_extent_buffer_full(const struct extent_buffer *dst,
217 const struct extent_buffer *src);
218void copy_extent_buffer(const struct extent_buffer *dst,
219 const struct extent_buffer *src,
d1310b2e
CM
220 unsigned long dst_offset, unsigned long src_offset,
221 unsigned long len);
2b48966a
DS
222void memcpy_extent_buffer(const struct extent_buffer *dst,
223 unsigned long dst_offset, unsigned long src_offset,
224 unsigned long len);
225void memmove_extent_buffer(const struct extent_buffer *dst,
226 unsigned long dst_offset, unsigned long src_offset,
b159fa28 227 unsigned long len);
2b48966a 228void memzero_extent_buffer(const struct extent_buffer *eb, unsigned long start,
b159fa28 229 unsigned long len);
2b48966a 230int extent_buffer_test_bit(const struct extent_buffer *eb, unsigned long start,
3e1e8bb7 231 unsigned long pos);
2b48966a 232void extent_buffer_bitmap_set(const struct extent_buffer *eb, unsigned long start,
3e1e8bb7 233 unsigned long pos, unsigned long len);
2b48966a
DS
234void extent_buffer_bitmap_clear(const struct extent_buffer *eb,
235 unsigned long start, unsigned long pos,
236 unsigned long len);
237void clear_extent_buffer_dirty(const struct extent_buffer *eb);
abb57ef3 238bool set_extent_buffer_dirty(struct extent_buffer *eb);
09c25a8c 239void set_extent_buffer_uptodate(struct extent_buffer *eb);
69ba3927 240void clear_extent_buffer_uptodate(struct extent_buffer *eb);
2b48966a 241int extent_buffer_under_io(const struct extent_buffer *eb);
bd1fa4f0 242void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
f6311572 243void extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
ad7ff17b 244void extent_clear_unlock_delalloc(struct btrfs_inode *inode, u64 start, u64 end,
74e9194a 245 struct page *locked_page,
f97e27e9 246 u32 bits_to_clear, unsigned long page_ops);
dd137dd1
STD
247
248int btrfs_alloc_page_array(unsigned int nr_pages, struct page **page_array);
c3a3b19b 249struct bio *btrfs_bio_alloc(unsigned int nr_iovecs);
110ac0e5 250struct bio *btrfs_bio_clone(struct block_device *bdev, struct bio *bio);
21dda654 251struct bio *btrfs_bio_clone_partial(struct bio *orig, u64 offset, u64 size);
4a54c8c1 252
b5227c07 253void end_extent_writepage(struct page *page, int err, u64 start, u64 end);
2b48966a 254int btrfs_repair_eb_io_failure(const struct extent_buffer *eb, int mirror_num);
2fe6303e
MX
255
256/*
257 * When IO fails, either with EIO or csum verification fails, we
258 * try other mirrors that might have a good copy of the data. This
259 * io_failure_record is used to record state as we go through all the
1245835d 260 * mirrors. If another mirror has good data, the sector is set up to date
2fe6303e
MX
261 * and things continue. If a good mirror can't be found, the original
262 * bio end_io callback is called to indicate things have failed.
263 */
264struct io_failure_record {
265 struct page *page;
266 u64 start;
267 u64 len;
268 u64 logical;
0ff40013 269 enum btrfs_compression_type compress_type;
2fe6303e
MX
270 int this_mirror;
271 int failed_mirror;
2fe6303e
MX
272};
273
150e4b05
QW
274int btrfs_repair_one_sector(struct inode *inode,
275 struct bio *failed_bio, u32 bio_offset,
276 struct page *page, unsigned int pgoff,
277 u64 start, int failed_mirror,
278 submit_bio_hook_t *submit_bio_hook);
77d5d689 279
294e30fe 280#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
9978059b 281bool find_lock_delalloc_range(struct inode *inode,
ce9f967f
JT
282 struct page *locked_page, u64 *start,
283 u64 *end);
0d4cf4e6 284#endif
faa2dbf0 285struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,
da17066c 286 u64 start);
3fd63727
JB
287
288#ifdef CONFIG_BTRFS_DEBUG
289void btrfs_extent_buffer_leak_debug_check(struct btrfs_fs_info *fs_info);
290#else
291#define btrfs_extent_buffer_leak_debug_check(fs_info) do {} while (0)
292#endif
293
294e30fe 294#endif