xref: /linux/fs/btrfs/free-space-cache.h (revision e9f0878c4b2004ac19581274c1ae4c61ae3ca70e)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2009 Oracle.  All rights reserved.
4  */
5 
6 #ifndef BTRFS_FREE_SPACE_CACHE_H
7 #define BTRFS_FREE_SPACE_CACHE_H
8 
9 struct btrfs_free_space {
10 	struct rb_node offset_index;
11 	u64 offset;
12 	u64 bytes;
13 	u64 max_extent_size;
14 	unsigned long *bitmap;
15 	struct list_head list;
16 };
17 
18 struct btrfs_free_space_ctl {
19 	spinlock_t tree_lock;
20 	struct rb_root free_space_offset;
21 	u64 free_space;
22 	int extents_thresh;
23 	int free_extents;
24 	int total_bitmaps;
25 	int unit;
26 	u64 start;
27 	const struct btrfs_free_space_op *op;
28 	void *private;
29 	struct mutex cache_writeout_mutex;
30 	struct list_head trimming_ranges;
31 };
32 
33 struct btrfs_free_space_op {
34 	void (*recalc_thresholds)(struct btrfs_free_space_ctl *ctl);
35 	bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
36 			   struct btrfs_free_space *info);
37 };
38 
39 struct btrfs_io_ctl;
40 
41 struct inode *lookup_free_space_inode(struct btrfs_fs_info *fs_info,
42 				      struct btrfs_block_group_cache
43 				      *block_group, struct btrfs_path *path);
44 int create_free_space_inode(struct btrfs_fs_info *fs_info,
45 			    struct btrfs_trans_handle *trans,
46 			    struct btrfs_block_group_cache *block_group,
47 			    struct btrfs_path *path);
48 
49 int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
50 				       struct btrfs_block_rsv *rsv);
51 int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
52 				    struct btrfs_block_group_cache *block_group,
53 				    struct inode *inode);
54 int load_free_space_cache(struct btrfs_fs_info *fs_info,
55 			  struct btrfs_block_group_cache *block_group);
56 int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
57 			struct btrfs_block_group_cache *block_group,
58 			struct btrfs_path *path);
59 int btrfs_write_out_cache(struct btrfs_fs_info *fs_info,
60 			  struct btrfs_trans_handle *trans,
61 			  struct btrfs_block_group_cache *block_group,
62 			  struct btrfs_path *path);
63 struct inode *lookup_free_ino_inode(struct btrfs_root *root,
64 				    struct btrfs_path *path);
65 int create_free_ino_inode(struct btrfs_root *root,
66 			  struct btrfs_trans_handle *trans,
67 			  struct btrfs_path *path);
68 int load_free_ino_cache(struct btrfs_fs_info *fs_info,
69 			struct btrfs_root *root);
70 int btrfs_write_out_ino_cache(struct btrfs_root *root,
71 			      struct btrfs_trans_handle *trans,
72 			      struct btrfs_path *path,
73 			      struct inode *inode);
74 
75 void btrfs_init_free_space_ctl(struct btrfs_block_group_cache *block_group);
76 int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
77 			   struct btrfs_free_space_ctl *ctl,
78 			   u64 bytenr, u64 size);
79 static inline int
80 btrfs_add_free_space(struct btrfs_block_group_cache *block_group,
81 		     u64 bytenr, u64 size)
82 {
83 	return __btrfs_add_free_space(block_group->fs_info,
84 				      block_group->free_space_ctl,
85 				      bytenr, size);
86 }
87 int btrfs_remove_free_space(struct btrfs_block_group_cache *block_group,
88 			    u64 bytenr, u64 size);
89 void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
90 void btrfs_remove_free_space_cache(struct btrfs_block_group_cache
91 				     *block_group);
92 u64 btrfs_find_space_for_alloc(struct btrfs_block_group_cache *block_group,
93 			       u64 offset, u64 bytes, u64 empty_size,
94 			       u64 *max_extent_size);
95 u64 btrfs_find_ino_for_alloc(struct btrfs_root *fs_root);
96 void btrfs_dump_free_space(struct btrfs_block_group_cache *block_group,
97 			   u64 bytes);
98 int btrfs_find_space_cluster(struct btrfs_fs_info *fs_info,
99 			     struct btrfs_block_group_cache *block_group,
100 			     struct btrfs_free_cluster *cluster,
101 			     u64 offset, u64 bytes, u64 empty_size);
102 void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
103 u64 btrfs_alloc_from_cluster(struct btrfs_block_group_cache *block_group,
104 			     struct btrfs_free_cluster *cluster, u64 bytes,
105 			     u64 min_start, u64 *max_extent_size);
106 int btrfs_return_cluster_to_free_space(
107 			       struct btrfs_block_group_cache *block_group,
108 			       struct btrfs_free_cluster *cluster);
109 int btrfs_trim_block_group(struct btrfs_block_group_cache *block_group,
110 			   u64 *trimmed, u64 start, u64 end, u64 minlen);
111 
112 /* Support functions for running our sanity tests */
113 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
114 int test_add_free_space_entry(struct btrfs_block_group_cache *cache,
115 			      u64 offset, u64 bytes, bool bitmap);
116 int test_check_exists(struct btrfs_block_group_cache *cache,
117 		      u64 offset, u64 bytes);
118 #endif
119 
120 #endif
121