1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (C) 2007 Oracle. All rights reserved.
6 #ifndef BTRFS_ORDERED_DATA_H
7 #define BTRFS_ORDERED_DATA_H
9 /* one of these per inode */
10 struct btrfs_ordered_inode_tree {
16 struct btrfs_ordered_sum {
17 /* bytenr is the start of this extent on disk */
21 * this is the length in bytes covered by the sums array below.
24 struct list_head list;
25 /* last field is a variable length array of csums */
30 * bits for the flags field:
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
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.
41 /* set when all the pages are written */
42 BTRFS_ORDERED_IO_DONE,
43 /* set when removed from the tree */
44 BTRFS_ORDERED_COMPLETE,
45 /* set when we want to write in place */
47 /* writing a zlib compressed extent */
48 BTRFS_ORDERED_COMPRESSED,
49 /* set when writing to preallocated extent */
50 BTRFS_ORDERED_PREALLOC,
51 /* set when we're doing DIO with this extent */
53 /* We had an io error when writing this out */
55 /* Set when we have to truncate an extent */
56 BTRFS_ORDERED_TRUNCATED,
57 /* Regular IO for COW */
58 BTRFS_ORDERED_REGULAR,
61 struct btrfs_ordered_extent {
62 /* logical offset in the file */
66 * These fields directly correspond to the same fields in
67 * btrfs_file_extent_item.
73 /* number of bytes that still need writing */
77 * the end of the ordered extent which is behind it but
78 * didn't update disk_i_size. Please see the comment of
79 * btrfs_ordered_update_i_size();
81 u64 outstanding_isize;
84 * If we get truncated we need to adjust the file extent we enter for
85 * this ordered extent so that we do not expose stale data.
89 /* flags (described above) */
92 /* compression algorithm */
98 /* the inode we belong to */
101 /* list of checksums for insertion when the extent io is done */
102 struct list_head list;
104 /* If we need to wait on this to be done */
105 struct list_head log_list;
107 /* If the transaction needs to wait on this ordered extent */
108 struct list_head trans_list;
110 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
111 wait_queue_head_t wait;
113 /* our friendly rbtree entry */
114 struct rb_node rb_node;
116 /* a per root list of all the pending ordered extents */
117 struct list_head root_extent_list;
119 struct btrfs_work work;
121 struct completion completion;
122 struct btrfs_work flush_work;
123 struct list_head work_list;
127 * calculates the total size you need to allocate for an ordered sum
128 * structure spanning 'bytes' in the file
130 static inline int btrfs_ordered_sum_size(struct btrfs_fs_info *fs_info,
133 int num_sectors = (int)DIV_ROUND_UP(bytes, fs_info->sectorsize);
134 int csum_size = btrfs_super_csum_size(fs_info->super_copy);
136 return sizeof(struct btrfs_ordered_sum) + num_sectors * csum_size;
140 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
142 spin_lock_init(&t->lock);
147 void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
148 void btrfs_remove_ordered_extent(struct inode *inode,
149 struct btrfs_ordered_extent *entry);
150 int btrfs_dec_test_ordered_pending(struct inode *inode,
151 struct btrfs_ordered_extent **cached,
152 u64 file_offset, u64 io_size, int uptodate);
153 int btrfs_dec_test_first_ordered_pending(struct inode *inode,
154 struct btrfs_ordered_extent **cached,
155 u64 *file_offset, u64 io_size,
157 int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset,
158 u64 disk_bytenr, u64 num_bytes, u64 disk_num_bytes,
160 int btrfs_add_ordered_extent_dio(struct inode *inode, u64 file_offset,
161 u64 disk_bytenr, u64 num_bytes,
162 u64 disk_num_bytes, int type);
163 int btrfs_add_ordered_extent_compress(struct inode *inode, u64 file_offset,
164 u64 disk_bytenr, u64 num_bytes,
165 u64 disk_num_bytes, int type,
167 void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
168 struct btrfs_ordered_sum *sum);
169 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode,
171 void btrfs_start_ordered_extent(struct inode *inode,
172 struct btrfs_ordered_extent *entry, int wait);
173 int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
174 struct btrfs_ordered_extent *
175 btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
176 struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
177 struct btrfs_inode *inode,
180 int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u64 disk_bytenr,
182 u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
183 const u64 range_start, const u64 range_len);
184 void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
185 const u64 range_start, const u64 range_len);
186 void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
188 struct extent_state **cached_state);
189 int __init ordered_data_init(void);
190 void __cold ordered_data_exit(void);