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/*
 10 * This is the trim state of an extent or bitmap.
 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.
 16 */
 17enum btrfs_trim_state {
 18	BTRFS_TRIM_STATE_UNTRIMMED,
 19	BTRFS_TRIM_STATE_TRIMMED,
 20	BTRFS_TRIM_STATE_TRIMMING,
 21};
 22
 23struct btrfs_free_space {
 24	struct rb_node offset_index;
 25	struct rb_node bytes_index;
 26	u64 offset;
 27	u64 bytes;
 28	u64 max_extent_size;
 29	unsigned long *bitmap;
 30	struct list_head list;
 31	enum btrfs_trim_state trim_state;
 32	s32 bitmap_extents;
 33};
 34
 35static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
 36{
 37	return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
 38}
 39
 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
 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 */
 51enum {
 52	BTRFS_STAT_CURR,
 53	BTRFS_STAT_PREV,
 54	BTRFS_STAT_NR_ENTRIES,
 55};
 56
 57struct btrfs_free_space_ctl {
 58	spinlock_t tree_lock;
 59	struct rb_root free_space_offset;
 60	struct rb_root_cached free_space_bytes;
 61	u64 free_space;
 62	int extents_thresh;
 63	int free_extents;
 64	int total_bitmaps;
 65	int unit;
 66	u64 start;
 67	s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
 68	s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
 69	const struct btrfs_free_space_op *op;
 70	struct btrfs_block_group *block_group;
 71	struct mutex cache_writeout_mutex;
 72	struct list_head trimming_ranges;
 73};
 74
 75struct btrfs_free_space_op {
 76	bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
 77			   struct btrfs_free_space *info);
 78};
 79
 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;
 91};
 92
 93int __init btrfs_free_space_init(void);
 94void __cold btrfs_free_space_exit(void);
 95struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
 96		struct btrfs_path *path);
 97int create_free_space_inode(struct btrfs_trans_handle *trans,
 98			    struct btrfs_block_group *block_group,
 99			    struct btrfs_path *path);
100int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
101				  struct inode *inode,
102				  struct btrfs_block_group *block_group);
103
 
 
104int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
105				    struct btrfs_block_group *block_group,
106				    struct inode *inode);
107int load_free_space_cache(struct btrfs_block_group *block_group);
108int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
109			struct btrfs_block_group *block_group,
110			struct btrfs_path *path);
111int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
112			  struct btrfs_block_group *block_group,
113			  struct btrfs_path *path);
114
115void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
116			       struct btrfs_free_space_ctl *ctl);
117int __btrfs_add_free_space(struct btrfs_block_group *block_group, u64 bytenr,
118			   u64 size, enum btrfs_trim_state trim_state);
 
 
119int btrfs_add_free_space(struct btrfs_block_group *block_group,
120			 u64 bytenr, u64 size);
121int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
122				u64 bytenr, u64 size);
123int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
124				       u64 bytenr, u64 size);
125int btrfs_remove_free_space(struct btrfs_block_group *block_group,
126			    u64 bytenr, u64 size);
 
127void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
128bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
129u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
130			       u64 offset, u64 bytes, u64 empty_size,
131			       u64 *max_extent_size);
132void btrfs_dump_free_space(struct btrfs_block_group *block_group,
133			   u64 bytes);
134int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
135			     struct btrfs_free_cluster *cluster,
136			     u64 offset, u64 bytes, u64 empty_size);
137void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
138u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
139			     struct btrfs_free_cluster *cluster, u64 bytes,
140			     u64 min_start, u64 *max_extent_size);
141void btrfs_return_cluster_to_free_space(
142			       struct btrfs_block_group *block_group,
143			       struct btrfs_free_cluster *cluster);
144int btrfs_trim_block_group(struct btrfs_block_group *block_group,
145			   u64 *trimmed, u64 start, u64 end, u64 minlen);
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,
151				   u64 maxlen, bool async);
152
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);
155/* Support functions for running our sanity tests */
156#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
157int test_add_free_space_entry(struct btrfs_block_group *cache,
158			      u64 offset, u64 bytes, bool bitmap);
159int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
160#endif
161
162#endif

  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/*
 10 * This is the trim state of an extent or bitmap.
 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.
 16 */
 17enum btrfs_trim_state {
 18	BTRFS_TRIM_STATE_UNTRIMMED,
 19	BTRFS_TRIM_STATE_TRIMMED,
 20	BTRFS_TRIM_STATE_TRIMMING,
 21};
 22
 23struct btrfs_free_space {
 24	struct rb_node offset_index;
 
 25	u64 offset;
 26	u64 bytes;
 27	u64 max_extent_size;
 28	unsigned long *bitmap;
 29	struct list_head list;
 30	enum btrfs_trim_state trim_state;
 31	s32 bitmap_extents;
 32};
 33
 34static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
 35{
 36	return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
 37}
 38
 39static 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
 
 
 
 
 
 
 
 
 
 
 
 45struct 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;
 54	s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
 55	s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
 56	const struct btrfs_free_space_op *op;
 57	void *private;
 58	struct mutex cache_writeout_mutex;
 59	struct list_head trimming_ranges;
 60};
 61
 62struct btrfs_free_space_op {
 63	bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
 64			   struct btrfs_free_space *info);
 65};
 66
 67struct 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;
 78};
 79
 
 
 80struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
 81		struct btrfs_path *path);
 82int create_free_space_inode(struct btrfs_trans_handle *trans,
 83			    struct btrfs_block_group *block_group,
 84			    struct btrfs_path *path);
 85int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
 86				  struct inode *inode,
 87				  struct btrfs_block_group *block_group);
 88
 89int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
 90				       struct btrfs_block_rsv *rsv);
 91int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
 92				    struct btrfs_block_group *block_group,
 93				    struct inode *inode);
 94int load_free_space_cache(struct btrfs_block_group *block_group);
 95int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
 96			struct btrfs_block_group *block_group,
 97			struct btrfs_path *path);
 98int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
 99			  struct btrfs_block_group *block_group,
100			  struct btrfs_path *path);
101
102void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
103			       struct btrfs_free_space_ctl *ctl);
104int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
105			   struct btrfs_free_space_ctl *ctl,
106			   u64 bytenr, u64 size,
107			   enum btrfs_trim_state trim_state);
108int btrfs_add_free_space(struct btrfs_block_group *block_group,
109			 u64 bytenr, u64 size);
110int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
111				u64 bytenr, u64 size);
112int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
113				       u64 bytenr, u64 size);
114int btrfs_remove_free_space(struct btrfs_block_group *block_group,
115			    u64 bytenr, u64 size);
116void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
117void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
118bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
119u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
120			       u64 offset, u64 bytes, u64 empty_size,
121			       u64 *max_extent_size);
122void btrfs_dump_free_space(struct btrfs_block_group *block_group,
123			   u64 bytes);
124int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
125			     struct btrfs_free_cluster *cluster,
126			     u64 offset, u64 bytes, u64 empty_size);
127void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
128u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
129			     struct btrfs_free_cluster *cluster, u64 bytes,
130			     u64 min_start, u64 *max_extent_size);
131void btrfs_return_cluster_to_free_space(
132			       struct btrfs_block_group *block_group,
133			       struct btrfs_free_cluster *cluster);
134int btrfs_trim_block_group(struct btrfs_block_group *block_group,
135			   u64 *trimmed, u64 start, u64 end, u64 minlen);
136int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
137				   u64 *trimmed, u64 start, u64 end, u64 minlen,
138				   bool async);
139int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
140				   u64 *trimmed, u64 start, u64 end, u64 minlen,
141				   u64 maxlen, bool async);
142
143bool btrfs_free_space_cache_v1_active(struct btrfs_fs_info *fs_info);
144int btrfs_set_free_space_cache_v1_active(struct btrfs_fs_info *fs_info, bool active);
145/* Support functions for running our sanity tests */
146#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
147int test_add_free_space_entry(struct btrfs_block_group *cache,
148			      u64 offset, u64 bytes, bool bitmap);
149int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
150#endif
151
152#endif