LXR linux/fs/btrfs/free-space-cache.h

   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        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
  68struct 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
  82struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
  83                struct btrfs_path *path);
  84int create_free_space_inode(struct btrfs_trans_handle *trans,
  85                            struct btrfs_block_group *block_group,
  86                            struct btrfs_path *path);
  87
  88int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
  89                                       struct btrfs_block_rsv *rsv);
  90int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
  91                                    struct btrfs_block_group *block_group,
  92                                    struct inode *inode);
  93int load_free_space_cache(struct btrfs_block_group *block_group);
  94int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
  95                        struct btrfs_block_group *block_group,
  96                        struct btrfs_path *path);
  97int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
  98                          struct btrfs_block_group *block_group,
  99                          struct btrfs_path *path);
 100struct inode *lookup_free_ino_inode(struct btrfs_root *root,
 101                                    struct btrfs_path *path);
 102int create_free_ino_inode(struct btrfs_root *root,
 103                          struct btrfs_trans_handle *trans,
 104                          struct btrfs_path *path);
 105int load_free_ino_cache(struct btrfs_fs_info *fs_info,
 106                        struct btrfs_root *root);
 107int btrfs_write_out_ino_cache(struct btrfs_root *root,
 108                              struct btrfs_trans_handle *trans,
 109                              struct btrfs_path *path,
 110                              struct inode *inode);
 111
 112void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group);
 113int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
 114                           struct btrfs_free_space_ctl *ctl,
 115                           u64 bytenr, u64 size,
 116                           enum btrfs_trim_state trim_state);
 117int btrfs_add_free_space(struct btrfs_block_group *block_group,
 118                         u64 bytenr, u64 size);
 119int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
 120                                       u64 bytenr, u64 size);
 121int btrfs_remove_free_space(struct btrfs_block_group *block_group,
 122                            u64 bytenr, u64 size);
 123void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl);
 124void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group);
 125bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group);
 126u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
 127                               u64 offset, u64 bytes, u64 empty_size,
 128                               u64 *max_extent_size);
 129u64 btrfs_find_ino_for_alloc(struct btrfs_root *fs_root);
 130void btrfs_dump_free_space(struct btrfs_block_group *block_group,
 131                           u64 bytes);
 132int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
 133                             struct btrfs_free_cluster *cluster,
 134                             u64 offset, u64 bytes, u64 empty_size);
 135void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster);
 136u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
 137                             struct btrfs_free_cluster *cluster, u64 bytes,
 138                             u64 min_start, u64 *max_extent_size);
 139void btrfs_return_cluster_to_free_space(
 140                               struct btrfs_block_group *block_group,
 141                               struct btrfs_free_cluster *cluster);
 142int btrfs_trim_block_group(struct btrfs_block_group *block_group,
 143                           u64 *trimmed, u64 start, u64 end, u64 minlen);
 144int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
 145                                   u64 *trimmed, u64 start, u64 end, u64 minlen,
 146                                   bool async);
 147int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
 148                                   u64 *trimmed, u64 start, u64 end, u64 minlen,
 149                                   u64 maxlen, bool async);
 150
 151/* Support functions for running our sanity tests */
 152#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
 153int test_add_free_space_entry(struct btrfs_block_group *cache,
 154                              u64 offset, u64 bytes, bool bitmap);
 155int test_check_exists(struct btrfs_block_group *cache, u64 offset, u64 bytes);
 156#endif
 157
 158#endif
 159