LXR linux/fs/btrfs/ordered-data.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 * Copyright (C) 2007 Oracle.  All rights reserved.
   4 */
   5
   6#ifndef BTRFS_ORDERED_DATA_H
   7#define BTRFS_ORDERED_DATA_H
   8
   9/* one of these per inode */
  10struct btrfs_ordered_inode_tree {
  11        spinlock_t lock;
  12        struct rb_root tree;
  13        struct rb_node *last;
  14};
  15
  16struct btrfs_ordered_sum {
  17        /* bytenr is the start of this extent on disk */
  18        u64 bytenr;
  19
  20        /*
  21         * this is the length in bytes covered by the sums array below.
  22         */
  23        int len;
  24        struct list_head list;
  25        /* last field is a variable length array of csums */
  26        u8 sums[];
  27};
  28
  29/*
  30 * Bits for btrfs_ordered_extent::flags.
  31 *
  32 * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
  33 * It is used to make sure metadata is inserted into the tree only once
  34 * per extent.
  35 *
  36 * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
  37 * rbtree, just before waking any waiters.  It is used to indicate the
  38 * IO is done and any metadata is inserted into the tree.
  39 */
  40enum {
  41        /*
  42         * Different types for ordered extents, one and only one of the 4 types
  43         * need to be set when creating ordered extent.
  44         *
  45         * REGULAR:     For regular non-compressed COW write
  46         * NOCOW:       For NOCOW write into existing non-hole extent
  47         * PREALLOC:    For NOCOW write into preallocated extent
  48         * COMPRESSED:  For compressed COW write
  49         */
  50        BTRFS_ORDERED_REGULAR,
  51        BTRFS_ORDERED_NOCOW,
  52        BTRFS_ORDERED_PREALLOC,
  53        BTRFS_ORDERED_COMPRESSED,
  54
  55        /*
  56         * Extra bit for direct io, can only be set for
  57         * REGULAR/NOCOW/PREALLOC. No direct io for compressed extent.
  58         */
  59        BTRFS_ORDERED_DIRECT,
  60
  61        /* Extra status bits for ordered extents */
  62
  63        /* set when all the pages are written */
  64        BTRFS_ORDERED_IO_DONE,
  65        /* set when removed from the tree */
  66        BTRFS_ORDERED_COMPLETE,
  67        /* We had an io error when writing this out */
  68        BTRFS_ORDERED_IOERR,
  69        /* Set when we have to truncate an extent */
  70        BTRFS_ORDERED_TRUNCATED,
  71        /* Used during fsync to track already logged extents */
  72        BTRFS_ORDERED_LOGGED,
  73        /* We have already logged all the csums of the ordered extent */
  74        BTRFS_ORDERED_LOGGED_CSUM,
  75        /* We wait for this extent to complete in the current transaction */
  76        BTRFS_ORDERED_PENDING,
  77        /* BTRFS_IOC_ENCODED_WRITE */
  78        BTRFS_ORDERED_ENCODED,
  79};
  80
  81/* BTRFS_ORDERED_* flags that specify the type of the extent. */
  82#define BTRFS_ORDERED_TYPE_FLAGS ((1UL << BTRFS_ORDERED_REGULAR) |      \
  83                                  (1UL << BTRFS_ORDERED_NOCOW) |        \
  84                                  (1UL << BTRFS_ORDERED_PREALLOC) |     \
  85                                  (1UL << BTRFS_ORDERED_COMPRESSED) |   \
  86                                  (1UL << BTRFS_ORDERED_DIRECT) |       \
  87                                  (1UL << BTRFS_ORDERED_ENCODED))
  88
  89struct btrfs_ordered_extent {
  90        /* logical offset in the file */
  91        u64 file_offset;
  92
  93        /*
  94         * These fields directly correspond to the same fields in
  95         * btrfs_file_extent_item.
  96         */
  97        u64 num_bytes;
  98        u64 ram_bytes;
  99        u64 disk_bytenr;
 100        u64 disk_num_bytes;
 101        u64 offset;
 102
 103        /* number of bytes that still need writing */
 104        u64 bytes_left;
 105
 106        /*
 107         * the end of the ordered extent which is behind it but
 108         * didn't update disk_i_size. Please see the comment of
 109         * btrfs_ordered_update_i_size();
 110         */
 111        u64 outstanding_isize;
 112
 113        /*
 114         * If we get truncated we need to adjust the file extent we enter for
 115         * this ordered extent so that we do not expose stale data.
 116         */
 117        u64 truncated_len;
 118
 119        /* flags (described above) */
 120        unsigned long flags;
 121
 122        /* compression algorithm */
 123        int compress_type;
 124
 125        /* Qgroup reserved space */
 126        int qgroup_rsv;
 127
 128        /* reference count */
 129        refcount_t refs;
 130
 131        /* the inode we belong to */
 132        struct inode *inode;
 133
 134        /* list of checksums for insertion when the extent io is done */
 135        struct list_head list;
 136
 137        /* used for fast fsyncs */
 138        struct list_head log_list;
 139
 140        /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
 141        wait_queue_head_t wait;
 142
 143        /* our friendly rbtree entry */
 144        struct rb_node rb_node;
 145
 146        /* a per root list of all the pending ordered extents */
 147        struct list_head root_extent_list;
 148
 149        struct btrfs_work work;
 150
 151        struct completion completion;
 152        struct btrfs_work flush_work;
 153        struct list_head work_list;
 154
 155        /*
 156         * Used to reverse-map physical address returned from ZONE_APPEND write
 157         * command in a workqueue context
 158         */
 159        u64 physical;
 160        struct block_device *bdev;
 161};
 162
 163/*
 164 * calculates the total size you need to allocate for an ordered sum
 165 * structure spanning 'bytes' in the file
 166 */
 167static inline int btrfs_ordered_sum_size(struct btrfs_fs_info *fs_info,
 168                                         unsigned long bytes)
 169{
 170        int num_sectors = (int)DIV_ROUND_UP(bytes, fs_info->sectorsize);
 171
 172        return sizeof(struct btrfs_ordered_sum) + num_sectors * fs_info->csum_size;
 173}
 174
 175static inline void
 176btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
 177{
 178        spin_lock_init(&t->lock);
 179        t->tree = RB_ROOT;
 180        t->last = NULL;
 181}
 182
 183void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
 184void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode,
 185                                struct btrfs_ordered_extent *entry);
 186void btrfs_mark_ordered_io_finished(struct btrfs_inode *inode,
 187                                struct page *page, u64 file_offset,
 188                                u64 num_bytes, btrfs_func_t finish_func,
 189                                bool uptodate);
 190bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode,
 191                                    struct btrfs_ordered_extent **cached,
 192                                    u64 file_offset, u64 io_size);
 193int btrfs_add_ordered_extent(struct btrfs_inode *inode, u64 file_offset,
 194                             u64 num_bytes, u64 ram_bytes, u64 disk_bytenr,
 195                             u64 disk_num_bytes, u64 offset, unsigned flags,
 196                             int compress_type);
 197void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
 198                           struct btrfs_ordered_sum *sum);
 199struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode,
 200                                                         u64 file_offset);
 201void btrfs_start_ordered_extent(struct btrfs_ordered_extent *entry, int wait);
 202int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
 203struct btrfs_ordered_extent *
 204btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset);
 205struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range(
 206                        struct btrfs_inode *inode, u64 file_offset, u64 len);
 207struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
 208                struct btrfs_inode *inode,
 209                u64 file_offset,
 210                u64 len);
 211void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode,
 212                                           struct list_head *list);
 213u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
 214                               const u64 range_start, const u64 range_len);
 215void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
 216                              const u64 range_start, const u64 range_len);
 217void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
 218                                        u64 end,
 219                                        struct extent_state **cached_state);
 220int btrfs_split_ordered_extent(struct btrfs_ordered_extent *ordered, u64 pre,
 221                               u64 post);
 222int __init ordered_data_init(void);
 223void __cold ordered_data_exit(void);
 224
 225#endif
 226