Merge tag 'for-6.5/io_uring-2023-06-23' of git://git.kernel.dk/linux
[linux-block.git] / fs / btrfs / free-space-cache.h
CommitLineData
9888c340 1/* SPDX-License-Identifier: GPL-2.0 */
fa9c0d79
CM
2/*
3 * Copyright (C) 2009 Oracle. All rights reserved.
fa9c0d79
CM
4 */
5
9888c340
DS
6#ifndef BTRFS_FREE_SPACE_CACHE_H
7#define BTRFS_FREE_SPACE_CACHE_H
fa9c0d79 8
a7ccb255
DZ
9/*
10 * This is the trim state of an extent or bitmap.
da080fe1
DZ
11 *
12 * BTRFS_TRIM_STATE_TRIMMING is special and used to maintain the state of a
13 * bitmap as we may need several trims to fully trim a single bitmap entry.
14 * This is reset should any free space other than trimmed space be added to the
15 * bitmap.
a7ccb255
DZ
16 */
17enum btrfs_trim_state {
18 BTRFS_TRIM_STATE_UNTRIMMED,
19 BTRFS_TRIM_STATE_TRIMMED,
da080fe1 20 BTRFS_TRIM_STATE_TRIMMING,
a7ccb255
DZ
21};
22
96303081
JB
23struct btrfs_free_space {
24 struct rb_node offset_index;
59c7b566 25 struct rb_node bytes_index;
96303081
JB
26 u64 offset;
27 u64 bytes;
cef40483 28 u64 max_extent_size;
96303081
JB
29 unsigned long *bitmap;
30 struct list_head list;
a7ccb255 31 enum btrfs_trim_state trim_state;
dfb79ddb 32 s32 bitmap_extents;
96303081
JB
33};
34
a7ccb255
DZ
35static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
36{
37 return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
38}
39
da080fe1
DZ
40static inline bool btrfs_free_space_trimming_bitmap(
41 struct btrfs_free_space *info)
42{
43 return (info->trim_state == BTRFS_TRIM_STATE_TRIMMING);
44}
45
390d89cc
JB
46/*
47 * Deltas are an effective way to populate global statistics. Give macro names
48 * to make it clear what we're doing. An example is discard_extents in
49 * btrfs_free_space_ctl.
50 */
cb9a10a6
JB
51enum {
52 BTRFS_STAT_CURR,
53 BTRFS_STAT_PREV,
54 BTRFS_STAT_NR_ENTRIES,
55};
390d89cc 56
34d52cb6
LZ
57struct btrfs_free_space_ctl {
58 spinlock_t tree_lock;
59 struct rb_root free_space_offset;
59c7b566 60 struct rb_root_cached free_space_bytes;
34d52cb6
LZ
61 u64 free_space;
62 int extents_thresh;
63 int free_extents;
64 int total_bitmaps;
65 int unit;
66 u64 start;
dfb79ddb 67 s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
5dc7c10b 68 s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
20e5506b 69 const struct btrfs_free_space_op *op;
364be842 70 struct btrfs_block_group *block_group;
55507ce3
FM
71 struct mutex cache_writeout_mutex;
72 struct list_head trimming_ranges;
34d52cb6
LZ
73};
74
75struct btrfs_free_space_op {
34d52cb6
LZ
76 bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
77 struct btrfs_free_space *info);
78};
79
67b61aef
DS
80struct btrfs_io_ctl {
81 void *cur, *orig;
82 struct page *page;
83 struct page **pages;
84 struct btrfs_fs_info *fs_info;
85 struct inode *inode;
86 unsigned long size;
87 int index;
88 int num_pages;
89 int entries;
90 int bitmaps;
67b61aef 91};
c9dc4c65 92
eda517fd
JB
93int __init btrfs_free_space_init(void);
94void __cold btrfs_free_space_exit(void);
32da5386 95struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
7949f339 96 struct btrfs_path *path);
4ca75f1b 97int create_free_space_inode(struct btrfs_trans_handle *trans,
32da5386 98 struct btrfs_block_group *block_group,
0af3d00b 99 struct btrfs_path *path);
36b216c8
BB
100int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
101 struct inode *inode,
102 struct btrfs_block_group *block_group);
0cb59c99 103
77ab86bf 104int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
32da5386 105 struct btrfs_block_group *block_group,
0af3d00b 106 struct inode *inode);
32da5386 107int load_free_space_cache(struct btrfs_block_group *block_group);
afdb5718 108int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
32da5386 109 struct btrfs_block_group *block_group,
afdb5718 110 struct btrfs_path *path);
fe041534 111int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
32da5386 112 struct btrfs_block_group *block_group,
0cb59c99 113 struct btrfs_path *path);
82d5902d 114
cd79909b
JB
115void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
116 struct btrfs_free_space_ctl *ctl);
290ef19a
NB
117int __btrfs_add_free_space(struct btrfs_block_group *block_group, u64 bytenr,
118 u64 size, enum btrfs_trim_state trim_state);
32da5386 119int btrfs_add_free_space(struct btrfs_block_group *block_group,
478b4d9f 120 u64 bytenr, u64 size);
169e0da9
NA
121int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
122 u64 bytenr, u64 size);
b0643e59
DZ
123int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
124 u64 bytenr, u64 size);
32da5386 125int btrfs_remove_free_space(struct btrfs_block_group *block_group,
fa9c0d79 126 u64 bytenr, u64 size);
32da5386 127void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
6e80d4f8 128bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
32da5386 129u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
a4820398
MX
130 u64 offset, u64 bytes, u64 empty_size,
131 u64 *max_extent_size);
32da5386 132void btrfs_dump_free_space(struct btrfs_block_group *block_group,
fa9c0d79 133 u64 bytes);
32da5386 134int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
fa9c0d79
CM
135 struct btrfs_free_cluster *cluster,
136 u64 offset, u64 bytes, u64 empty_size);
137void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
32da5386 138u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
fa9c0d79 139 struct btrfs_free_cluster *cluster, u64 bytes,
a4820398 140 u64 min_start, u64 *max_extent_size);
69b0e093 141void btrfs_return_cluster_to_free_space(
32da5386 142 struct btrfs_block_group *block_group,
fa9c0d79 143 struct btrfs_free_cluster *cluster);
32da5386 144int btrfs_trim_block_group(struct btrfs_block_group *block_group,
f7039b1d 145 u64 *trimmed, u64 start, u64 end, u64 minlen);
2bee7eb8
DZ
146int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
147 u64 *trimmed, u64 start, u64 end, u64 minlen,
148 bool async);
149int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
150 u64 *trimmed, u64 start, u64 end, u64 minlen,
7fe6d45e 151 u64 maxlen, bool async);
74255aa0 152
94846229
BB
153bool btrfs_free_space_cache_v1_active(struct btrfs_fs_info *fs_info);
154int btrfs_set_free_space_cache_v1_active(struct btrfs_fs_info *fs_info, bool active);
01327610 155/* Support functions for running our sanity tests */
dc11dd5d 156#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
32da5386 157int test_add_free_space_entry(struct btrfs_block_group *cache,
dc11dd5d 158 u64 offset, u64 bytes, bool bitmap);
32da5386 159int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
dc11dd5d 160#endif
74255aa0 161
fa9c0d79 162#endif