[linux-block.git] / fs / btrfs / free-space-cache.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2009 Oracle.  All rights reserved.
 */

#ifndef BTRFS_FREE_SPACE_CACHE_H
#define BTRFS_FREE_SPACE_CACHE_H

/*
 * This is the trim state of an extent or bitmap.
 *
 * BTRFS_TRIM_STATE_TRIMMING is special and used to maintain the state of a
 * bitmap as we may need several trims to fully trim a single bitmap entry.
 * This is reset should any free space other than trimmed space be added to the
 * bitmap.
 */
enum btrfs_trim_state {
	BTRFS_TRIM_STATE_UNTRIMMED,
	BTRFS_TRIM_STATE_TRIMMED,
	BTRFS_TRIM_STATE_TRIMMING,
};

struct btrfs_free_space {
	struct rb_node offset_index;
	u64 offset;
	u64 bytes;
	u64 max_extent_size;
	unsigned long *bitmap;
	struct list_head list;
	enum btrfs_trim_state trim_state;
	s32 bitmap_extents;
};

static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
{
	return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
}

static inline bool btrfs_free_space_trimming_bitmap(
					    struct btrfs_free_space *info)
{
	return (info->trim_state == BTRFS_TRIM_STATE_TRIMMING);
}

struct btrfs_free_space_ctl {
	spinlock_t tree_lock;
	struct rb_root free_space_offset;
	u64 free_space;
	int extents_thresh;
	int free_extents;
	int total_bitmaps;
	int unit;
	u64 start;
	s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
	s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
	const struct btrfs_free_space_op *op;
	void *private;
	struct mutex cache_writeout_mutex;
	struct list_head trimming_ranges;
};

struct btrfs_free_space_op {
	bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
			   struct btrfs_free_space *info);
};

struct btrfs_io_ctl {
	void *cur, *orig;
	struct page *page;
	struct page **pages;
	struct btrfs_fs_info *fs_info;
	struct inode *inode;
	unsigned long size;
	int index;
	int num_pages;
	int entries;
	int bitmaps;
};

struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
		struct btrfs_path *path);
int create_free_space_inode(struct btrfs_trans_handle *trans,
			    struct btrfs_block_group *block_group,
			    struct btrfs_path *path);
int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
				  struct inode *inode,
				  struct btrfs_block_group *block_group);

int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
				       struct btrfs_block_rsv *rsv);
int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
				    struct btrfs_block_group *block_group,
				    struct inode *inode);
int load_free_space_cache(struct btrfs_block_group *block_group);
int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
			struct btrfs_block_group *block_group,
			struct btrfs_path *path);
int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
			  struct btrfs_block_group *block_group,
			  struct btrfs_path *path);

void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
			       struct btrfs_free_space_ctl *ctl);
int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
			   struct btrfs_free_space_ctl *ctl,
			   u64 bytenr, u64 size,
			   enum btrfs_trim_state trim_state);
int btrfs_add_free_space(struct btrfs_block_group *block_group,
			 u64 bytenr, u64 size);
int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
				u64 bytenr, u64 size);
int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
				       u64 bytenr, u64 size);
int btrfs_remove_free_space(struct btrfs_block_group *block_group,
			    u64 bytenr, u64 size);
void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
			       u64 offset, u64 bytes, u64 empty_size,
			       u64 *max_extent_size);
void btrfs_dump_free_space(struct btrfs_block_group *block_group,
			   u64 bytes);
int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
			     struct btrfs_free_cluster *cluster,
			     u64 offset, u64 bytes, u64 empty_size);
void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
			     struct btrfs_free_cluster *cluster, u64 bytes,
			     u64 min_start, u64 *max_extent_size);
void btrfs_return_cluster_to_free_space(
			       struct btrfs_block_group *block_group,
			       struct btrfs_free_cluster *cluster);
int btrfs_trim_block_group(struct btrfs_block_group *block_group,
			   u64 *trimmed, u64 start, u64 end, u64 minlen);
int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
				   u64 *trimmed, u64 start, u64 end, u64 minlen,
				   bool async);
int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
				   u64 *trimmed, u64 start, u64 end, u64 minlen,
				   u64 maxlen, bool async);

bool btrfs_free_space_cache_v1_active(struct btrfs_fs_info *fs_info);
int btrfs_set_free_space_cache_v1_active(struct btrfs_fs_info *fs_info, bool active);
/* Support functions for running our sanity tests */
#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
int test_add_free_space_entry(struct btrfs_block_group *cache,
			      u64 offset, u64 bytes, bool bitmap);
int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
#endif

#endif
Commit	Line	Data
9888c340	1	/* SPDX-License-Identifier: GPL-2.0 */
fa9c0d79 CM	2	/*
fa9c0d79 CM	3	* Copyright (C) 2009 Oracle. All rights reserved.
fa9c0d79 CM	4	*/
fa9c0d79 CM	5
9888c340 DS	6	#ifndef BTRFS_FREE_SPACE_CACHE_H
9888c340 DS	7	#define BTRFS_FREE_SPACE_CACHE_H
fa9c0d79	8
a7ccb255 DZ	9	/*
a7ccb255 DZ	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	*/
	17	enum btrfs_trim_state {
	18	BTRFS_TRIM_STATE_UNTRIMMED,
	19	BTRFS_TRIM_STATE_TRIMMED,
da080fe1	20	BTRFS_TRIM_STATE_TRIMMING,
a7ccb255 DZ	21	};
a7ccb255 DZ	22
96303081 JB	23	struct btrfs_free_space {
	24	struct rb_node offset_index;
	25	u64 offset;
	26	u64 bytes;
cef40483	27	u64 max_extent_size;
96303081 JB	28	unsigned long *bitmap;
96303081 JB	29	struct list_head list;
a7ccb255	30	enum btrfs_trim_state trim_state;
dfb79ddb	31	s32 bitmap_extents;
96303081 JB	32	};
96303081 JB	33
a7ccb255 DZ	34	static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
	35	{
	36	return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
	37	}
	38
da080fe1 DZ	39	static inline bool btrfs_free_space_trimming_bitmap(
	40	struct btrfs_free_space *info)
	41	{
	42	return (info->trim_state == BTRFS_TRIM_STATE_TRIMMING);
	43	}
	44
34d52cb6 LZ	45	struct btrfs_free_space_ctl {
	46	spinlock_t tree_lock;
	47	struct rb_root free_space_offset;
	48	u64 free_space;
	49	int extents_thresh;
	50	int free_extents;
	51	int total_bitmaps;
	52	int unit;
	53	u64 start;
dfb79ddb	54	s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
5dc7c10b	55	s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
20e5506b	56	const struct btrfs_free_space_op *op;
34d52cb6	57	void *private;
55507ce3 FM	58	struct mutex cache_writeout_mutex;
55507ce3 FM	59	struct list_head trimming_ranges;
34d52cb6 LZ	60	};
	61
	62	struct btrfs_free_space_op {
34d52cb6 LZ	63	bool (use_bitmap)(struct btrfs_free_space_ctl ctl,
	64	struct btrfs_free_space *info);
	65	};
	66
67b61aef DS	67	struct btrfs_io_ctl {
	68	void cur, orig;
	69	struct page *page;
	70	struct page **pages;
	71	struct btrfs_fs_info *fs_info;
	72	struct inode *inode;
	73	unsigned long size;
	74	int index;
	75	int num_pages;
	76	int entries;
	77	int bitmaps;
67b61aef	78	};
c9dc4c65	79
32da5386	80	struct inode lookup_free_space_inode(struct btrfs_block_group block_group,
7949f339	81	struct btrfs_path *path);
4ca75f1b	82	int create_free_space_inode(struct btrfs_trans_handle *trans,
32da5386	83	struct btrfs_block_group *block_group,
0af3d00b	84	struct btrfs_path *path);
36b216c8 BB	85	int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
	86	struct inode *inode,
	87	struct btrfs_block_group *block_group);
0cb59c99	88
2ff7e61e	89	int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
7b61cd92	90	struct btrfs_block_rsv *rsv);
77ab86bf	91	int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
32da5386	92	struct btrfs_block_group *block_group,
0af3d00b	93	struct inode *inode);
32da5386	94	int load_free_space_cache(struct btrfs_block_group *block_group);
afdb5718	95	int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
32da5386	96	struct btrfs_block_group *block_group,
afdb5718	97	struct btrfs_path *path);
fe041534	98	int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
32da5386	99	struct btrfs_block_group *block_group,
0cb59c99	100	struct btrfs_path *path);
82d5902d	101
cd79909b JB	102	void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
cd79909b JB	103	struct btrfs_free_space_ctl *ctl);
ab8d0fc4 JM	104	int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
ab8d0fc4 JM	105	struct btrfs_free_space_ctl *ctl,
a7ccb255 DZ	106	u64 bytenr, u64 size,
a7ccb255 DZ	107	enum btrfs_trim_state trim_state);
32da5386	108	int btrfs_add_free_space(struct btrfs_block_group *block_group,
478b4d9f	109	u64 bytenr, u64 size);
169e0da9 NA	110	int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
169e0da9 NA	111	u64 bytenr, u64 size);
b0643e59 DZ	112	int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
b0643e59 DZ	113	u64 bytenr, u64 size);
32da5386	114	int btrfs_remove_free_space(struct btrfs_block_group *block_group,
fa9c0d79	115	u64 bytenr, u64 size);
581bb050	116	void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
32da5386	117	void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
6e80d4f8	118	bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
32da5386	119	u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
a4820398 MX	120	u64 offset, u64 bytes, u64 empty_size,
a4820398 MX	121	u64 *max_extent_size);
32da5386	122	void btrfs_dump_free_space(struct btrfs_block_group *block_group,
fa9c0d79	123	u64 bytes);
32da5386	124	int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
fa9c0d79 CM	125	struct btrfs_free_cluster *cluster,
	126	u64 offset, u64 bytes, u64 empty_size);
	127	void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
32da5386	128	u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
fa9c0d79	129	struct btrfs_free_cluster *cluster, u64 bytes,
a4820398	130	u64 min_start, u64 *max_extent_size);
69b0e093	131	void btrfs_return_cluster_to_free_space(
32da5386	132	struct btrfs_block_group *block_group,
fa9c0d79	133	struct btrfs_free_cluster *cluster);
32da5386	134	int btrfs_trim_block_group(struct btrfs_block_group *block_group,
f7039b1d	135	u64 *trimmed, u64 start, u64 end, u64 minlen);
2bee7eb8 DZ	136	int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
	137	u64 *trimmed, u64 start, u64 end, u64 minlen,
	138	bool async);
	139	int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
	140	u64 *trimmed, u64 start, u64 end, u64 minlen,
7fe6d45e	141	u64 maxlen, bool async);
74255aa0	142
94846229 BB	143	bool btrfs_free_space_cache_v1_active(struct btrfs_fs_info *fs_info);
94846229 BB	144	int btrfs_set_free_space_cache_v1_active(struct btrfs_fs_info *fs_info, bool active);
01327610	145	/* Support functions for running our sanity tests */
dc11dd5d	146	#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
32da5386	147	int test_add_free_space_entry(struct btrfs_block_group *cache,
dc11dd5d	148	u64 offset, u64 bytes, bool bitmap);
32da5386	149	int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
dc11dd5d	150	#endif
74255aa0	151
fa9c0d79	152	#endif