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 */ 17 enum btrfs_trim_state { 18 BTRFS_TRIM_STATE_UNTRIMMED, 19 BTRFS_TRIM_STATE_TRIMMED, 20 BTRFS_TRIM_STATE_TRIMMING, 21 }; 22 23 struct 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 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 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 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; 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 62 struct btrfs_free_space_op { 63 void (*recalc_thresholds)(struct btrfs_free_space_ctl *ctl); 64 bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl, 65 struct btrfs_free_space *info); 66 }; 67 68 struct btrfs_io_ctl { 69 void *cur, *orig; 70 struct page *page; 71 struct page **pages; 72 struct btrfs_fs_info *fs_info; 73 struct inode *inode; 74 unsigned long size; 75 int index; 76 int num_pages; 77 int entries; 78 int bitmaps; 79 unsigned check_crcs:1; 80 }; 81 82 struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group, 83 struct btrfs_path *path); 84 int create_free_space_inode(struct btrfs_trans_handle *trans, 85 struct btrfs_block_group *block_group, 86 struct btrfs_path *path); 87 88 int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info, 89 struct btrfs_block_rsv *rsv); 90 int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans, 91 struct btrfs_block_group *block_group, 92 struct inode *inode); 93 int load_free_space_cache(struct btrfs_block_group *block_group); 94 int btrfs_wait_cache_io(struct btrfs_trans_handle *trans, 95 struct btrfs_block_group *block_group, 96 struct btrfs_path *path); 97 int btrfs_write_out_cache(struct btrfs_trans_handle *trans, 98 struct btrfs_block_group *block_group, 99 struct btrfs_path *path); 100 101 void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group, 102 struct btrfs_free_space_ctl *ctl); 103 int __btrfs_add_free_space(struct btrfs_fs_info *fs_info, 104 struct btrfs_free_space_ctl *ctl, 105 u64 bytenr, u64 size, 106 enum btrfs_trim_state trim_state); 107 int btrfs_add_free_space(struct btrfs_block_group *block_group, 108 u64 bytenr, u64 size); 109 int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group, 110 u64 bytenr, u64 size); 111 int btrfs_remove_free_space(struct btrfs_block_group *block_group, 112 u64 bytenr, u64 size); 113 void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl); 114 void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group); 115 bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group); 116 u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group, 117 u64 offset, u64 bytes, u64 empty_size, 118 u64 *max_extent_size); 119 void btrfs_dump_free_space(struct btrfs_block_group *block_group, 120 u64 bytes); 121 int btrfs_find_space_cluster(struct btrfs_block_group *block_group, 122 struct btrfs_free_cluster *cluster, 123 u64 offset, u64 bytes, u64 empty_size); 124 void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster); 125 u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group, 126 struct btrfs_free_cluster *cluster, u64 bytes, 127 u64 min_start, u64 *max_extent_size); 128 void btrfs_return_cluster_to_free_space( 129 struct btrfs_block_group *block_group, 130 struct btrfs_free_cluster *cluster); 131 int btrfs_trim_block_group(struct btrfs_block_group *block_group, 132 u64 *trimmed, u64 start, u64 end, u64 minlen); 133 int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group, 134 u64 *trimmed, u64 start, u64 end, u64 minlen, 135 bool async); 136 int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group, 137 u64 *trimmed, u64 start, u64 end, u64 minlen, 138 u64 maxlen, bool async); 139 140 /* Support functions for running our sanity tests */ 141 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS 142 int test_add_free_space_entry(struct btrfs_block_group *cache, 143 u64 offset, u64 bytes, bool bitmap); 144 int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes); 145 #endif 146 147 #endif 148