xref: /linux/fs/btrfs/free-space-cache.h (revision b6ebbac51bedf9e98e837688bc838f400196da5e)
1 /*
2  * Copyright (C) 2009 Oracle.  All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public
6  * License v2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public
14  * License along with this program; if not, write to the
15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16  * Boston, MA 021110-1307, USA.
17  */
18 
19 #ifndef __BTRFS_FREE_SPACE_CACHE
20 #define __BTRFS_FREE_SPACE_CACHE
21 
22 struct btrfs_free_space {
23 	struct rb_node offset_index;
24 	u64 offset;
25 	u64 bytes;
26 	u64 max_extent_size;
27 	unsigned long *bitmap;
28 	struct list_head list;
29 };
30 
31 struct btrfs_free_space_ctl {
32 	spinlock_t tree_lock;
33 	struct rb_root free_space_offset;
34 	u64 free_space;
35 	int extents_thresh;
36 	int free_extents;
37 	int total_bitmaps;
38 	int unit;
39 	u64 start;
40 	const struct btrfs_free_space_op *op;
41 	void *private;
42 	struct mutex cache_writeout_mutex;
43 	struct list_head trimming_ranges;
44 };
45 
46 struct btrfs_free_space_op {
47 	void (*recalc_thresholds)(struct btrfs_free_space_ctl *ctl);
48 	bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
49 			   struct btrfs_free_space *info);
50 };
51 
52 struct btrfs_io_ctl;
53 
54 struct inode *lookup_free_space_inode(struct btrfs_root *root,
55 				      struct btrfs_block_group_cache
56 				      *block_group, struct btrfs_path *path);
57 int create_free_space_inode(struct btrfs_root *root,
58 			    struct btrfs_trans_handle *trans,
59 			    struct btrfs_block_group_cache *block_group,
60 			    struct btrfs_path *path);
61 
62 int btrfs_check_trunc_cache_free_space(struct btrfs_root *root,
63 				       struct btrfs_block_rsv *rsv);
64 int btrfs_truncate_free_space_cache(struct btrfs_root *root,
65 				    struct btrfs_trans_handle *trans,
66 				    struct btrfs_block_group_cache *block_group,
67 				    struct inode *inode);
68 int load_free_space_cache(struct btrfs_fs_info *fs_info,
69 			  struct btrfs_block_group_cache *block_group);
70 int btrfs_wait_cache_io(struct btrfs_root *root,
71 			struct btrfs_trans_handle *trans,
72 			struct btrfs_block_group_cache *block_group,
73 			struct btrfs_io_ctl *io_ctl,
74 			struct btrfs_path *path, u64 offset);
75 int btrfs_write_out_cache(struct btrfs_root *root,
76 			  struct btrfs_trans_handle *trans,
77 			  struct btrfs_block_group_cache *block_group,
78 			  struct btrfs_path *path);
79 struct inode *lookup_free_ino_inode(struct btrfs_root *root,
80 				    struct btrfs_path *path);
81 int create_free_ino_inode(struct btrfs_root *root,
82 			  struct btrfs_trans_handle *trans,
83 			  struct btrfs_path *path);
84 int load_free_ino_cache(struct btrfs_fs_info *fs_info,
85 			struct btrfs_root *root);
86 int btrfs_write_out_ino_cache(struct btrfs_root *root,
87 			      struct btrfs_trans_handle *trans,
88 			      struct btrfs_path *path,
89 			      struct inode *inode);
90 
91 void btrfs_init_free_space_ctl(struct btrfs_block_group_cache *block_group);
92 int __btrfs_add_free_space(struct btrfs_free_space_ctl *ctl,
93 			   u64 bytenr, u64 size);
94 static inline int
95 btrfs_add_free_space(struct btrfs_block_group_cache *block_group,
96 		     u64 bytenr, u64 size)
97 {
98 	return __btrfs_add_free_space(block_group->free_space_ctl,
99 				      bytenr, size);
100 }
101 int btrfs_remove_free_space(struct btrfs_block_group_cache *block_group,
102 			    u64 bytenr, u64 size);
103 void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
104 void btrfs_remove_free_space_cache(struct btrfs_block_group_cache
105 				     *block_group);
106 u64 btrfs_find_space_for_alloc(struct btrfs_block_group_cache *block_group,
107 			       u64 offset, u64 bytes, u64 empty_size,
108 			       u64 *max_extent_size);
109 u64 btrfs_find_ino_for_alloc(struct btrfs_root *fs_root);
110 void btrfs_dump_free_space(struct btrfs_block_group_cache *block_group,
111 			   u64 bytes);
112 int btrfs_find_space_cluster(struct btrfs_root *root,
113 			     struct btrfs_block_group_cache *block_group,
114 			     struct btrfs_free_cluster *cluster,
115 			     u64 offset, u64 bytes, u64 empty_size);
116 void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
117 u64 btrfs_alloc_from_cluster(struct btrfs_block_group_cache *block_group,
118 			     struct btrfs_free_cluster *cluster, u64 bytes,
119 			     u64 min_start, u64 *max_extent_size);
120 int btrfs_return_cluster_to_free_space(
121 			       struct btrfs_block_group_cache *block_group,
122 			       struct btrfs_free_cluster *cluster);
123 int btrfs_trim_block_group(struct btrfs_block_group_cache *block_group,
124 			   u64 *trimmed, u64 start, u64 end, u64 minlen);
125 
126 /* Support functions for running our sanity tests */
127 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
128 int test_add_free_space_entry(struct btrfs_block_group_cache *cache,
129 			      u64 offset, u64 bytes, bool bitmap);
130 int test_check_exists(struct btrfs_block_group_cache *cache,
131 		      u64 offset, u64 bytes);
132 #endif
133 
134 #endif
135