fs/btrfs/free-space-cache.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * Copyright (C) 2009 Oracle.  All rights reserved.
0004  */
0005
0006 #ifndef BTRFS_FREE_SPACE_CACHE_H
0007 #define BTRFS_FREE_SPACE_CACHE_H
0008
0009 /*
0010  * This is the trim state of an extent or bitmap.
0011  *
0012  * BTRFS_TRIM_STATE_TRIMMING is special and used to maintain the state of a
0013  * bitmap as we may need several trims to fully trim a single bitmap entry.
0014  * This is reset should any free space other than trimmed space be added to the
0015  * bitmap.
0016  */
0017 enum btrfs_trim_state {
0018     BTRFS_TRIM_STATE_UNTRIMMED,
0019     BTRFS_TRIM_STATE_TRIMMED,
0020     BTRFS_TRIM_STATE_TRIMMING,
0021 };
0022
0023 struct btrfs_free_space {
0024     struct rb_node offset_index;
0025     struct rb_node bytes_index;
0026     u64 offset;
0027     u64 bytes;
0028     u64 max_extent_size;
0029     unsigned long *bitmap;
0030     struct list_head list;
0031     enum btrfs_trim_state trim_state;
0032     s32 bitmap_extents;
0033 };
0034
0035 static inline bool btrfs_free_space_trimmed(struct btrfs_free_space *info)
0036 {
0037     return (info->trim_state == BTRFS_TRIM_STATE_TRIMMED);
0038 }
0039
0040 static inline bool btrfs_free_space_trimming_bitmap(
0041                         struct btrfs_free_space *info)
0042 {
0043     return (info->trim_state == BTRFS_TRIM_STATE_TRIMMING);
0044 }
0045
0046 struct btrfs_free_space_ctl {
0047     spinlock_t tree_lock;
0048     struct rb_root free_space_offset;
0049     struct rb_root_cached free_space_bytes;
0050     u64 free_space;
0051     int extents_thresh;
0052     int free_extents;
0053     int total_bitmaps;
0054     int unit;
0055     u64 start;
0056     s32 discardable_extents[BTRFS_STAT_NR_ENTRIES];
0057     s64 discardable_bytes[BTRFS_STAT_NR_ENTRIES];
0058     const struct btrfs_free_space_op *op;
0059     struct btrfs_block_group *block_group;
0060     struct mutex cache_writeout_mutex;
0061     struct list_head trimming_ranges;
0062 };
0063
0064 struct btrfs_free_space_op {
0065     bool (*use_bitmap)(struct btrfs_free_space_ctl *ctl,
0066                struct btrfs_free_space *info);
0067 };
0068
0069 struct btrfs_io_ctl {
0070     void *cur, *orig;
0071     struct page *page;
0072     struct page **pages;
0073     struct btrfs_fs_info *fs_info;
0074     struct inode *inode;
0075     unsigned long size;
0076     int index;
0077     int num_pages;
0078     int entries;
0079     int bitmaps;
0080 };
0081
0082 struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
0083         struct btrfs_path *path);
0084 int create_free_space_inode(struct btrfs_trans_handle *trans,
0085                 struct btrfs_block_group *block_group,
0086                 struct btrfs_path *path);
0087 int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
0088                   struct inode *inode,
0089                   struct btrfs_block_group *block_group);
0090
0091 int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
0092                        struct btrfs_block_rsv *rsv);
0093 int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
0094                     struct btrfs_block_group *block_group,
0095                     struct inode *inode);
0096 int load_free_space_cache(struct btrfs_block_group *block_group);
0097 int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
0098             struct btrfs_block_group *block_group,
0099             struct btrfs_path *path);
0100 int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
0101               struct btrfs_block_group *block_group,
0102               struct btrfs_path *path);
0103
0104 void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
0105                    struct btrfs_free_space_ctl *ctl);
0106 int __btrfs_add_free_space(struct btrfs_block_group *block_group, u64 bytenr,
0107                u64 size, enum btrfs_trim_state trim_state);
0108 int btrfs_add_free_space(struct btrfs_block_group *block_group,
0109              u64 bytenr, u64 size);
0110 int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
0111                 u64 bytenr, u64 size);
0112 int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
0113                        u64 bytenr, u64 size);
0114 int btrfs_remove_free_space(struct btrfs_block_group *block_group,
0115                 u64 bytenr, u64 size);
0116 void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
0117 void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
0118 bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
0119 u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
0120                    u64 offset, u64 bytes, u64 empty_size,
0121                    u64 *max_extent_size);
0122 void btrfs_dump_free_space(struct btrfs_block_group *block_group,
0123                u64 bytes);
0124 int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
0125                  struct btrfs_free_cluster *cluster,
0126                  u64 offset, u64 bytes, u64 empty_size);
0127 void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
0128 u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
0129                  struct btrfs_free_cluster *cluster, u64 bytes,
0130                  u64 min_start, u64 *max_extent_size);
0131 void btrfs_return_cluster_to_free_space(
0132                    struct btrfs_block_group *block_group,
0133                    struct btrfs_free_cluster *cluster);
0134 int btrfs_trim_block_group(struct btrfs_block_group *block_group,
0135                u64 *trimmed, u64 start, u64 end, u64 minlen);
0136 int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
0137                    u64 *trimmed, u64 start, u64 end, u64 minlen,
0138                    bool async);
0139 int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
0140                    u64 *trimmed, u64 start, u64 end, u64 minlen,
0141                    u64 maxlen, bool async);
0142
0143 bool btrfs_free_space_cache_v1_active(struct btrfs_fs_info *fs_info);
0144 int btrfs_set_free_space_cache_v1_active(struct btrfs_fs_info *fs_info, bool active);
0145 /* Support functions for running our sanity tests */
0146 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
0147 int test_add_free_space_entry(struct btrfs_block_group *cache,
0148                   u64 offset, u64 bytes, bool bitmap);
0149 int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
0150 #endif
0151
0152 #endif