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