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 btrfs_ordered_extent::flags.
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.
42 * Different types for ordered extents, one and only one of the 4 types
43 * need to be set when creating ordered extent.
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
50 BTRFS_ORDERED_REGULAR,
52 BTRFS_ORDERED_PREALLOC,
53 BTRFS_ORDERED_COMPRESSED,
56 * Extra bit for direct io, can only be set for
57 * REGULAR/NOCOW/PREALLOC. No direct io for compressed extent.
61 /* Extra status bits for ordered extents */
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 */
69 /* Set when we have to truncate an extent */
70 BTRFS_ORDERED_TRUNCATED,
71 /* Used during fsync to track already logged extents */
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,
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))
89 struct btrfs_ordered_extent {
90 /* logical offset in the file */
94 * These fields directly correspond to the same fields in
95 * btrfs_file_extent_item.
103 /* number of bytes that still need writing */
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();
111 u64 outstanding_isize;
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.
119 /* flags (described above) */
122 /* compression algorithm */
125 /* Qgroup reserved space */
128 /* reference count */
131 /* the inode we belong to */
134 /* list of checksums for insertion when the extent io is done */
135 struct list_head list;
137 /* used for fast fsyncs */
138 struct list_head log_list;
140 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
141 wait_queue_head_t wait;
143 /* our friendly rbtree entry */
144 struct rb_node rb_node;
146 /* a per root list of all the pending ordered extents */
147 struct list_head root_extent_list;
149 struct btrfs_work work;
151 struct completion completion;
152 struct btrfs_work flush_work;
153 struct list_head work_list;
156 * Used to reverse-map physical address returned from ZONE_APPEND write
157 * command in a workqueue context
160 struct block_device *bdev;
164 * calculates the total size you need to allocate for an ordered sum
165 * structure spanning 'bytes' in the file
167 static inline int btrfs_ordered_sum_size(struct btrfs_fs_info *fs_info,
170 int num_sectors = (int)DIV_ROUND_UP(bytes, fs_info->sectorsize);
172 return sizeof(struct btrfs_ordered_sum) + num_sectors * fs_info->csum_size;
176 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
178 spin_lock_init(&t->lock);
183 void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
184 void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode,
185 struct btrfs_ordered_extent *entry);
186 void 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,
190 bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode,
191 struct btrfs_ordered_extent **cached,
192 u64 file_offset, u64 io_size);
193 int 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,
197 void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
198 struct btrfs_ordered_sum *sum);
199 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode,
201 void btrfs_start_ordered_extent(struct btrfs_ordered_extent *entry, int wait);
202 int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
203 struct btrfs_ordered_extent *
204 btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset);
205 struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range(
206 struct btrfs_inode *inode, u64 file_offset, u64 len);
207 struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
208 struct btrfs_inode *inode,
211 void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode,
212 struct list_head *list);
213 u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
214 const u64 range_start, const u64 range_len);
215 void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
216 const u64 range_start, const u64 range_len);
217 void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
219 struct extent_state **cached_state);
220 int btrfs_split_ordered_extent(struct btrfs_ordered_extent *ordered, u64 pre,
222 int __init ordered_data_init(void);
223 void __cold ordered_data_exit(void);