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 | struct btrfs_ordered_sum { |
10 | /* |
11 | * Logical start address and length for of the blocks covered by |
12 | * the sums array. |
13 | */ |
14 | u64 logical; |
15 | u32 len; |
16 | |
17 | struct list_head list; |
18 | /* last field is a variable length array of csums */ |
19 | u8 sums[]; |
20 | }; |
21 | |
22 | /* |
23 | * Bits for btrfs_ordered_extent::flags. |
24 | * |
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 |
27 | * per extent. |
28 | * |
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. |
32 | */ |
33 | enum { |
34 | /* |
35 | * Different types for ordered extents, one and only one of the 4 types |
36 | * need to be set when creating ordered extent. |
37 | * |
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 |
42 | */ |
43 | BTRFS_ORDERED_REGULAR, |
44 | BTRFS_ORDERED_NOCOW, |
45 | BTRFS_ORDERED_PREALLOC, |
46 | BTRFS_ORDERED_COMPRESSED, |
47 | |
48 | /* |
49 | * Extra bit for direct io, can only be set for |
50 | * REGULAR/NOCOW/PREALLOC. No direct io for compressed extent. |
51 | */ |
52 | BTRFS_ORDERED_DIRECT, |
53 | |
54 | /* Extra status bits for ordered extents */ |
55 | |
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 */ |
61 | BTRFS_ORDERED_IOERR, |
62 | /* Set when we have to truncate an extent */ |
63 | BTRFS_ORDERED_TRUNCATED, |
64 | /* Used during fsync to track already logged extents */ |
65 | BTRFS_ORDERED_LOGGED, |
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, |
72 | }; |
73 | |
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)) |
81 | |
82 | struct btrfs_ordered_extent { |
83 | /* logical offset in the file */ |
84 | u64 file_offset; |
85 | |
86 | /* |
87 | * These fields directly correspond to the same fields in |
88 | * btrfs_file_extent_item. |
89 | */ |
90 | u64 num_bytes; |
91 | u64 ram_bytes; |
92 | u64 disk_bytenr; |
93 | u64 disk_num_bytes; |
94 | u64 offset; |
95 | |
96 | /* number of bytes that still need writing */ |
97 | u64 bytes_left; |
98 | |
99 | /* |
100 | * the end of the ordered extent which is behind it but |
101 | * didn't update disk_i_size. Please see the comment of |
102 | * btrfs_ordered_update_i_size(); |
103 | */ |
104 | u64 outstanding_isize; |
105 | |
106 | /* |
107 | * If we get truncated we need to adjust the file extent we enter for |
108 | * this ordered extent so that we do not expose stale data. |
109 | */ |
110 | u64 truncated_len; |
111 | |
112 | /* flags (described above) */ |
113 | unsigned long flags; |
114 | |
115 | /* compression algorithm */ |
116 | int compress_type; |
117 | |
118 | /* Qgroup reserved space */ |
119 | int qgroup_rsv; |
120 | |
121 | /* reference count */ |
122 | refcount_t refs; |
123 | |
124 | /* the inode we belong to */ |
125 | struct inode *inode; |
126 | |
127 | /* list of checksums for insertion when the extent io is done */ |
128 | struct list_head list; |
129 | |
130 | /* used for fast fsyncs */ |
131 | struct list_head log_list; |
132 | |
133 | /* used to wait for the BTRFS_ORDERED_COMPLETE bit */ |
134 | wait_queue_head_t wait; |
135 | |
136 | /* our friendly rbtree entry */ |
137 | struct rb_node rb_node; |
138 | |
139 | /* a per root list of all the pending ordered extents */ |
140 | struct list_head root_extent_list; |
141 | |
142 | struct btrfs_work work; |
143 | |
144 | struct completion completion; |
145 | struct btrfs_work flush_work; |
146 | struct list_head work_list; |
147 | |
148 | struct list_head bioc_list; |
149 | }; |
150 | |
151 | int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent); |
152 | int btrfs_finish_ordered_io(struct btrfs_ordered_extent *ordered_extent); |
153 | |
154 | void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry); |
155 | void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode, |
156 | struct btrfs_ordered_extent *entry); |
157 | bool btrfs_finish_ordered_extent(struct btrfs_ordered_extent *ordered, |
158 | struct page *page, u64 file_offset, u64 len, |
159 | bool uptodate); |
160 | void btrfs_mark_ordered_io_finished(struct btrfs_inode *inode, |
161 | struct page *page, u64 file_offset, |
162 | u64 num_bytes, bool uptodate); |
163 | bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode, |
164 | struct btrfs_ordered_extent **cached, |
165 | u64 file_offset, u64 io_size); |
166 | struct btrfs_ordered_extent *btrfs_alloc_ordered_extent( |
167 | struct btrfs_inode *inode, u64 file_offset, |
168 | u64 num_bytes, u64 ram_bytes, u64 disk_bytenr, |
169 | u64 disk_num_bytes, u64 offset, unsigned long flags, |
170 | int compress_type); |
171 | void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry, |
172 | struct btrfs_ordered_sum *sum); |
173 | struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode, |
174 | u64 file_offset); |
175 | void btrfs_start_ordered_extent(struct btrfs_ordered_extent *entry); |
176 | int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len); |
177 | struct btrfs_ordered_extent * |
178 | btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset); |
179 | struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range( |
180 | struct btrfs_inode *inode, u64 file_offset, u64 len); |
181 | struct btrfs_ordered_extent *btrfs_lookup_ordered_range( |
182 | struct btrfs_inode *inode, |
183 | u64 file_offset, |
184 | u64 len); |
185 | void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode, |
186 | struct list_head *list); |
187 | u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr, |
188 | const u64 range_start, const u64 range_len); |
189 | void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr, |
190 | const u64 range_start, const u64 range_len); |
191 | void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start, |
192 | u64 end, |
193 | struct extent_state **cached_state); |
194 | bool btrfs_try_lock_ordered_range(struct btrfs_inode *inode, u64 start, u64 end, |
195 | struct extent_state **cached_state); |
196 | struct btrfs_ordered_extent *btrfs_split_ordered_extent( |
197 | struct btrfs_ordered_extent *ordered, u64 len); |
198 | int __init ordered_data_init(void); |
199 | void __cold ordered_data_exit(void); |
200 | |
201 | #endif |
202 | |