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