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 struct btrfs_ordered_sum {
11 * Logical start address and length for of the blocks covered by
17 struct list_head list;
18 /* last field is a variable length array of csums */
23 * Bits for btrfs_ordered_extent::flags.
25 * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
26 * It is used to make sure metadata is inserted into the tree only once
29 * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
30 * rbtree, just before waking any waiters. It is used to indicate the
31 * IO is done and any metadata is inserted into the tree.
35 * Different types for ordered extents, one and only one of the 4 types
36 * need to be set when creating ordered extent.
38 * REGULAR: For regular non-compressed COW write
39 * NOCOW: For NOCOW write into existing non-hole extent
40 * PREALLOC: For NOCOW write into preallocated extent
41 * COMPRESSED: For compressed COW write
43 BTRFS_ORDERED_REGULAR,
45 BTRFS_ORDERED_PREALLOC,
46 BTRFS_ORDERED_COMPRESSED,
49 * Extra bit for direct io, can only be set for
50 * REGULAR/NOCOW/PREALLOC. No direct io for compressed extent.
54 /* Extra status bits for ordered extents */
56 /* set when all the pages are written */
57 BTRFS_ORDERED_IO_DONE,
58 /* set when removed from the tree */
59 BTRFS_ORDERED_COMPLETE,
60 /* We had an io error when writing this out */
62 /* Set when we have to truncate an extent */
63 BTRFS_ORDERED_TRUNCATED,
64 /* Used during fsync to track already logged extents */
66 /* We have already logged all the csums of the ordered extent */
67 BTRFS_ORDERED_LOGGED_CSUM,
68 /* We wait for this extent to complete in the current transaction */
69 BTRFS_ORDERED_PENDING,
70 /* BTRFS_IOC_ENCODED_WRITE */
71 BTRFS_ORDERED_ENCODED,
74 /* BTRFS_ORDERED_* flags that specify the type of the extent. */
75 #define BTRFS_ORDERED_TYPE_FLAGS ((1UL << BTRFS_ORDERED_REGULAR) | \
76 (1UL << BTRFS_ORDERED_NOCOW) | \
77 (1UL << BTRFS_ORDERED_PREALLOC) | \
78 (1UL << BTRFS_ORDERED_COMPRESSED) | \
79 (1UL << BTRFS_ORDERED_DIRECT) | \
80 (1UL << BTRFS_ORDERED_ENCODED))
82 struct btrfs_ordered_extent {
83 /* logical offset in the file */
87 * These fields directly correspond to the same fields in
88 * btrfs_file_extent_item.
96 /* number of bytes that still need writing */
100 * If we get truncated we need to adjust the file extent we enter for
101 * this ordered extent so that we do not expose stale data.
105 /* flags (described above) */
108 /* compression algorithm */
111 /* Qgroup reserved space */
114 /* reference count */
117 /* the inode we belong to */
120 /* list of checksums for insertion when the extent io is done */
121 struct list_head list;
123 /* used for fast fsyncs */
124 struct list_head log_list;
126 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
127 wait_queue_head_t wait;
129 /* our friendly rbtree entry */
130 struct rb_node rb_node;
132 /* a per root list of all the pending ordered extents */
133 struct list_head root_extent_list;
135 struct btrfs_work work;
137 struct completion completion;
138 struct btrfs_work flush_work;
139 struct list_head work_list;
141 struct list_head bioc_list;
144 int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent);
145 int btrfs_finish_ordered_io(struct btrfs_ordered_extent *ordered_extent);
147 void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
148 void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode,
149 struct btrfs_ordered_extent *entry);
150 bool btrfs_finish_ordered_extent(struct btrfs_ordered_extent *ordered,
151 struct page *page, u64 file_offset, u64 len,
153 void btrfs_mark_ordered_io_finished(struct btrfs_inode *inode,
154 struct page *page, u64 file_offset,
155 u64 num_bytes, bool uptodate);
156 bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode,
157 struct btrfs_ordered_extent **cached,
158 u64 file_offset, u64 io_size);
159 struct btrfs_ordered_extent *btrfs_alloc_ordered_extent(
160 struct btrfs_inode *inode, u64 file_offset,
161 u64 num_bytes, u64 ram_bytes, u64 disk_bytenr,
162 u64 disk_num_bytes, u64 offset, unsigned long flags,
164 void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
165 struct btrfs_ordered_sum *sum);
166 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode,
168 void btrfs_start_ordered_extent(struct btrfs_ordered_extent *entry);
169 int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
170 struct btrfs_ordered_extent *
171 btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset);
172 struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range(
173 struct btrfs_inode *inode, u64 file_offset, u64 len);
174 struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
175 struct btrfs_inode *inode,
178 void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode,
179 struct list_head *list);
180 u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
181 const u64 range_start, const u64 range_len);
182 void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
183 const u64 range_start, const u64 range_len);
184 void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
186 struct extent_state **cached_state);
187 bool btrfs_try_lock_ordered_range(struct btrfs_inode *inode, u64 start, u64 end,
188 struct extent_state **cached_state);
189 struct btrfs_ordered_extent *btrfs_split_ordered_extent(
190 struct btrfs_ordered_extent *ordered, u64 len);
191 int __init ordered_data_init(void);
192 void __cold ordered_data_exit(void);