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 */ 10 struct btrfs_ordered_inode_tree { 11 spinlock_t lock; 12 struct rb_root tree; 13 struct rb_node *last; 14 }; 15 16 struct 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 u32 sums[]; 27 }; 28 29 /* 30 * bits for the flags field: 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 */ 40 #define BTRFS_ORDERED_IO_DONE 0 /* set when all the pages are written */ 41 42 #define BTRFS_ORDERED_COMPLETE 1 /* set when removed from the tree */ 43 44 #define BTRFS_ORDERED_NOCOW 2 /* set when we want to write in place */ 45 46 #define BTRFS_ORDERED_COMPRESSED 3 /* writing a zlib compressed extent */ 47 48 #define BTRFS_ORDERED_PREALLOC 4 /* set when writing to preallocated extent */ 49 50 #define BTRFS_ORDERED_DIRECT 5 /* set when we're doing DIO with this extent */ 51 52 #define BTRFS_ORDERED_IOERR 6 /* We had an io error when writing this out */ 53 54 #define BTRFS_ORDERED_UPDATED_ISIZE 7 /* indicates whether this ordered extent 55 * has done its due diligence in updating 56 * the isize. */ 57 #define BTRFS_ORDERED_LOGGED_CSUM 8 /* We've logged the csums on this ordered 58 ordered extent */ 59 #define BTRFS_ORDERED_TRUNCATED 9 /* Set when we have to truncate an extent */ 60 61 #define BTRFS_ORDERED_LOGGED 10 /* Set when we've waited on this ordered extent 62 * in the logging code. */ 63 #define BTRFS_ORDERED_PENDING 11 /* We are waiting for this ordered extent to 64 * complete in the current transaction. */ 65 #define BTRFS_ORDERED_REGULAR 12 /* Regular IO for COW */ 66 67 struct btrfs_ordered_extent { 68 /* logical offset in the file */ 69 u64 file_offset; 70 71 /* disk byte number */ 72 u64 start; 73 74 /* ram length of the extent in bytes */ 75 u64 len; 76 77 /* extent length on disk */ 78 u64 disk_len; 79 80 /* number of bytes that still need writing */ 81 u64 bytes_left; 82 83 /* 84 * the end of the ordered extent which is behind it but 85 * didn't update disk_i_size. Please see the comment of 86 * btrfs_ordered_update_i_size(); 87 */ 88 u64 outstanding_isize; 89 90 /* 91 * If we get truncated we need to adjust the file extent we enter for 92 * this ordered extent so that we do not expose stale data. 93 */ 94 u64 truncated_len; 95 96 /* flags (described above) */ 97 unsigned long flags; 98 99 /* compression algorithm */ 100 int compress_type; 101 102 /* reference count */ 103 refcount_t refs; 104 105 /* the inode we belong to */ 106 struct inode *inode; 107 108 /* list of checksums for insertion when the extent io is done */ 109 struct list_head list; 110 111 /* If we need to wait on this to be done */ 112 struct list_head log_list; 113 114 /* If the transaction needs to wait on this ordered extent */ 115 struct list_head trans_list; 116 117 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */ 118 wait_queue_head_t wait; 119 120 /* our friendly rbtree entry */ 121 struct rb_node rb_node; 122 123 /* a per root list of all the pending ordered extents */ 124 struct list_head root_extent_list; 125 126 struct btrfs_work work; 127 128 struct completion completion; 129 struct btrfs_work flush_work; 130 struct list_head work_list; 131 }; 132 133 /* 134 * calculates the total size you need to allocate for an ordered sum 135 * structure spanning 'bytes' in the file 136 */ 137 static inline int btrfs_ordered_sum_size(struct btrfs_fs_info *fs_info, 138 unsigned long bytes) 139 { 140 int num_sectors = (int)DIV_ROUND_UP(bytes, fs_info->sectorsize); 141 int csum_size = btrfs_super_csum_size(fs_info->super_copy); 142 143 return sizeof(struct btrfs_ordered_sum) + num_sectors * csum_size; 144 } 145 146 static inline void 147 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t) 148 { 149 spin_lock_init(&t->lock); 150 t->tree = RB_ROOT; 151 t->last = NULL; 152 } 153 154 void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry); 155 void btrfs_remove_ordered_extent(struct inode *inode, 156 struct btrfs_ordered_extent *entry); 157 int btrfs_dec_test_ordered_pending(struct inode *inode, 158 struct btrfs_ordered_extent **cached, 159 u64 file_offset, u64 io_size, int uptodate); 160 int btrfs_dec_test_first_ordered_pending(struct inode *inode, 161 struct btrfs_ordered_extent **cached, 162 u64 *file_offset, u64 io_size, 163 int uptodate); 164 int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset, 165 u64 start, u64 len, u64 disk_len, int type); 166 int btrfs_add_ordered_extent_dio(struct inode *inode, u64 file_offset, 167 u64 start, u64 len, u64 disk_len, int type); 168 int btrfs_add_ordered_extent_compress(struct inode *inode, u64 file_offset, 169 u64 start, u64 len, u64 disk_len, 170 int type, int compress_type); 171 void btrfs_add_ordered_sum(struct inode *inode, 172 struct btrfs_ordered_extent *entry, 173 struct btrfs_ordered_sum *sum); 174 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode, 175 u64 file_offset); 176 void btrfs_start_ordered_extent(struct inode *inode, 177 struct btrfs_ordered_extent *entry, int wait); 178 int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len); 179 struct btrfs_ordered_extent * 180 btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset); 181 struct btrfs_ordered_extent *btrfs_lookup_ordered_range( 182 struct btrfs_inode *inode, 183 u64 file_offset, 184 u64 len); 185 bool btrfs_have_ordered_extents_in_range(struct inode *inode, 186 u64 file_offset, 187 u64 len); 188 int btrfs_ordered_update_i_size(struct inode *inode, u64 offset, 189 struct btrfs_ordered_extent *ordered); 190 int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u64 disk_bytenr, 191 u32 *sum, int len); 192 u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr, 193 const u64 range_start, const u64 range_len); 194 u64 btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr, 195 const u64 range_start, const u64 range_len); 196 void btrfs_get_logged_extents(struct btrfs_inode *inode, 197 struct list_head *logged_list, 198 const loff_t start, 199 const loff_t end); 200 void btrfs_put_logged_extents(struct list_head *logged_list); 201 void btrfs_submit_logged_extents(struct list_head *logged_list, 202 struct btrfs_root *log); 203 void btrfs_wait_logged_extents(struct btrfs_trans_handle *trans, 204 struct btrfs_root *log, u64 transid); 205 void btrfs_free_logged_extents(struct btrfs_root *log, u64 transid); 206 int __init ordered_data_init(void); 207 void __cold ordered_data_exit(void); 208 209 #endif 210