1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2009 Oracle. All rights reserved.
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #ifndef BTRFS_FREE_SPACE_CACHE_H
7*4882a593Smuzhiyun #define BTRFS_FREE_SPACE_CACHE_H
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun /*
10*4882a593Smuzhiyun * This is the trim state of an extent or bitmap.
11*4882a593Smuzhiyun *
12*4882a593Smuzhiyun * BTRFS_TRIM_STATE_TRIMMING is special and used to maintain the state of a
13*4882a593Smuzhiyun * bitmap as we may need several trims to fully trim a single bitmap entry.
14*4882a593Smuzhiyun * This is reset should any free space other than trimmed space be added to the
15*4882a593Smuzhiyun * bitmap.
16*4882a593Smuzhiyun */
17*4882a593Smuzhiyun enum btrfs_trim_state {
18*4882a593Smuzhiyun BTRFS_TRIM_STATE_UNTRIMMED,
19*4882a593Smuzhiyun BTRFS_TRIM_STATE_TRIMMED,
20*4882a593Smuzhiyun BTRFS_TRIM_STATE_TRIMMING,
21*4882a593Smuzhiyun };
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun struct btrfs_free_space {
24*4882a593Smuzhiyun struct rb_node offset_index;
25*4882a593Smuzhiyun u64 offset;
26*4882a593Smuzhiyun u64 bytes;
27*4882a593Smuzhiyun u64 max_extent_size;
28*4882a593Smuzhiyun unsigned long *bitmap;
29*4882a593Smuzhiyun struct list_head list;
30*4882a593Smuzhiyun enum btrfs_trim_state trim_state;
31*4882a593Smuzhiyun s32 bitmap_extents;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun
btrfs_free_space_trimmed(struct btrfs_free_space * info)34*4882a593Smuzhiyun static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
35*4882a593Smuzhiyun {
36*4882a593Smuzhiyun return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun
btrfs_free_space_trimming_bitmap(struct btrfs_free_space * info)39*4882a593Smuzhiyun static inline bool btrfs_free_space_trimming_bitmap(
40*4882a593Smuzhiyun struct btrfs_free_space *info)
41*4882a593Smuzhiyun {
42*4882a593Smuzhiyun return (info->trim_state == BTRFS_TRIM_STATE_TRIMMING);
43*4882a593Smuzhiyun }
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun struct btrfs_free_space_ctl {
46*4882a593Smuzhiyun spinlock_t tree_lock;
47*4882a593Smuzhiyun struct rb_root free_space_offset;
48*4882a593Smuzhiyun u64 free_space;
49*4882a593Smuzhiyun int extents_thresh;
50*4882a593Smuzhiyun int free_extents;
51*4882a593Smuzhiyun int total_bitmaps;
52*4882a593Smuzhiyun int unit;
53*4882a593Smuzhiyun u64 start;
54*4882a593Smuzhiyun s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
55*4882a593Smuzhiyun s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
56*4882a593Smuzhiyun const struct btrfs_free_space_op *op;
57*4882a593Smuzhiyun void *private;
58*4882a593Smuzhiyun struct mutex cache_writeout_mutex;
59*4882a593Smuzhiyun struct list_head trimming_ranges;
60*4882a593Smuzhiyun };
61*4882a593Smuzhiyun
62*4882a593Smuzhiyun struct btrfs_free_space_op {
63*4882a593Smuzhiyun void (*recalc_thresholds)(struct btrfs_free_space_ctl *ctl);
64*4882a593Smuzhiyun bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
65*4882a593Smuzhiyun struct btrfs_free_space *info);
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun struct btrfs_io_ctl {
69*4882a593Smuzhiyun void *cur, *orig;
70*4882a593Smuzhiyun struct page *page;
71*4882a593Smuzhiyun struct page **pages;
72*4882a593Smuzhiyun struct btrfs_fs_info *fs_info;
73*4882a593Smuzhiyun struct inode *inode;
74*4882a593Smuzhiyun unsigned long size;
75*4882a593Smuzhiyun int index;
76*4882a593Smuzhiyun int num_pages;
77*4882a593Smuzhiyun int entries;
78*4882a593Smuzhiyun int bitmaps;
79*4882a593Smuzhiyun unsigned check_crcs:1;
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
83*4882a593Smuzhiyun struct btrfs_path *path);
84*4882a593Smuzhiyun int create_free_space_inode(struct btrfs_trans_handle *trans,
85*4882a593Smuzhiyun struct btrfs_block_group *block_group,
86*4882a593Smuzhiyun struct btrfs_path *path);
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
89*4882a593Smuzhiyun struct btrfs_block_rsv *rsv);
90*4882a593Smuzhiyun int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
91*4882a593Smuzhiyun struct btrfs_block_group *block_group,
92*4882a593Smuzhiyun struct inode *inode);
93*4882a593Smuzhiyun int load_free_space_cache(struct btrfs_block_group *block_group);
94*4882a593Smuzhiyun int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
95*4882a593Smuzhiyun struct btrfs_block_group *block_group,
96*4882a593Smuzhiyun struct btrfs_path *path);
97*4882a593Smuzhiyun int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
98*4882a593Smuzhiyun struct btrfs_block_group *block_group,
99*4882a593Smuzhiyun struct btrfs_path *path);
100*4882a593Smuzhiyun struct inode *lookup_free_ino_inode(struct btrfs_root *root,
101*4882a593Smuzhiyun struct btrfs_path *path);
102*4882a593Smuzhiyun int create_free_ino_inode(struct btrfs_root *root,
103*4882a593Smuzhiyun struct btrfs_trans_handle *trans,
104*4882a593Smuzhiyun struct btrfs_path *path);
105*4882a593Smuzhiyun int load_free_ino_cache(struct btrfs_fs_info *fs_info,
106*4882a593Smuzhiyun struct btrfs_root *root);
107*4882a593Smuzhiyun int btrfs_write_out_ino_cache(struct btrfs_root *root,
108*4882a593Smuzhiyun struct btrfs_trans_handle *trans,
109*4882a593Smuzhiyun struct btrfs_path *path,
110*4882a593Smuzhiyun struct inode *inode);
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group);
113*4882a593Smuzhiyun int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
114*4882a593Smuzhiyun struct btrfs_free_space_ctl *ctl,
115*4882a593Smuzhiyun u64 bytenr, u64 size,
116*4882a593Smuzhiyun enum btrfs_trim_state trim_state);
117*4882a593Smuzhiyun int btrfs_add_free_space(struct btrfs_block_group *block_group,
118*4882a593Smuzhiyun u64 bytenr, u64 size);
119*4882a593Smuzhiyun int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
120*4882a593Smuzhiyun u64 bytenr, u64 size);
121*4882a593Smuzhiyun int btrfs_remove_free_space(struct btrfs_block_group *block_group,
122*4882a593Smuzhiyun u64 bytenr, u64 size);
123*4882a593Smuzhiyun void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
124*4882a593Smuzhiyun void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
125*4882a593Smuzhiyun bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
126*4882a593Smuzhiyun u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
127*4882a593Smuzhiyun u64 offset, u64 bytes, u64 empty_size,
128*4882a593Smuzhiyun u64 *max_extent_size);
129*4882a593Smuzhiyun u64 btrfs_find_ino_for_alloc(struct btrfs_root *fs_root);
130*4882a593Smuzhiyun void btrfs_dump_free_space(struct btrfs_block_group *block_group,
131*4882a593Smuzhiyun u64 bytes);
132*4882a593Smuzhiyun int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
133*4882a593Smuzhiyun struct btrfs_free_cluster *cluster,
134*4882a593Smuzhiyun u64 offset, u64 bytes, u64 empty_size);
135*4882a593Smuzhiyun void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
136*4882a593Smuzhiyun u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
137*4882a593Smuzhiyun struct btrfs_free_cluster *cluster, u64 bytes,
138*4882a593Smuzhiyun u64 min_start, u64 *max_extent_size);
139*4882a593Smuzhiyun void btrfs_return_cluster_to_free_space(
140*4882a593Smuzhiyun struct btrfs_block_group *block_group,
141*4882a593Smuzhiyun struct btrfs_free_cluster *cluster);
142*4882a593Smuzhiyun int btrfs_trim_block_group(struct btrfs_block_group *block_group,
143*4882a593Smuzhiyun u64 *trimmed, u64 start, u64 end, u64 minlen);
144*4882a593Smuzhiyun int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
145*4882a593Smuzhiyun u64 *trimmed, u64 start, u64 end, u64 minlen,
146*4882a593Smuzhiyun bool async);
147*4882a593Smuzhiyun int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
148*4882a593Smuzhiyun u64 *trimmed, u64 start, u64 end, u64 minlen,
149*4882a593Smuzhiyun u64 maxlen, bool async);
150*4882a593Smuzhiyun
151*4882a593Smuzhiyun /* Support functions for running our sanity tests */
152*4882a593Smuzhiyun #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
153*4882a593Smuzhiyun int test_add_free_space_entry(struct btrfs_block_group *cache,
154*4882a593Smuzhiyun u64 offset, u64 bytes, bool bitmap);
155*4882a593Smuzhiyun int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
156*4882a593Smuzhiyun #endif
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun #endif
159