Loading...
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 */
10struct btrfs_ordered_inode_tree {
11 spinlock_t lock;
12 struct rb_root tree;
13 struct rb_node *last;
14};
15
16struct 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 u8 sums[];
27};
28
29/*
30 * Bits for btrfs_ordered_extent::flags.
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 */
40enum {
41 /*
42 * Different types for ordered extents, one and only one of the 4 types
43 * need to be set when creating ordered extent.
44 *
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
49 */
50 BTRFS_ORDERED_REGULAR,
51 BTRFS_ORDERED_NOCOW,
52 BTRFS_ORDERED_PREALLOC,
53 BTRFS_ORDERED_COMPRESSED,
54
55 /*
56 * Extra bit for direct io, can only be set for
57 * REGULAR/NOCOW/PREALLOC. No direct io for compressed extent.
58 */
59 BTRFS_ORDERED_DIRECT,
60
61 /* Extra status bits for ordered extents */
62
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 */
68 BTRFS_ORDERED_IOERR,
69 /* Set when we have to truncate an extent */
70 BTRFS_ORDERED_TRUNCATED,
71 /* Used during fsync to track already logged extents */
72 BTRFS_ORDERED_LOGGED,
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,
79};
80
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))
88
89struct btrfs_ordered_extent {
90 /* logical offset in the file */
91 u64 file_offset;
92
93 /*
94 * These fields directly correspond to the same fields in
95 * btrfs_file_extent_item.
96 */
97 u64 num_bytes;
98 u64 ram_bytes;
99 u64 disk_bytenr;
100 u64 disk_num_bytes;
101 u64 offset;
102
103 /* number of bytes that still need writing */
104 u64 bytes_left;
105
106 /*
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();
110 */
111 u64 outstanding_isize;
112
113 /*
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.
116 */
117 u64 truncated_len;
118
119 /* flags (described above) */
120 unsigned long flags;
121
122 /* compression algorithm */
123 int compress_type;
124
125 /* Qgroup reserved space */
126 int qgroup_rsv;
127
128 /* reference count */
129 refcount_t refs;
130
131 /* the inode we belong to */
132 struct inode *inode;
133
134 /* list of checksums for insertion when the extent io is done */
135 struct list_head list;
136
137 /* used for fast fsyncs */
138 struct list_head log_list;
139
140 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
141 wait_queue_head_t wait;
142
143 /* our friendly rbtree entry */
144 struct rb_node rb_node;
145
146 /* a per root list of all the pending ordered extents */
147 struct list_head root_extent_list;
148
149 struct btrfs_work work;
150
151 struct completion completion;
152 struct btrfs_work flush_work;
153 struct list_head work_list;
154
155 /*
156 * Used to reverse-map physical address returned from ZONE_APPEND write
157 * command in a workqueue context
158 */
159 u64 physical;
160 struct block_device *bdev;
161};
162
163static inline void
164btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
165{
166 spin_lock_init(&t->lock);
167 t->tree = RB_ROOT;
168 t->last = NULL;
169}
170
171int btrfs_finish_ordered_io(struct btrfs_ordered_extent *ordered_extent);
172
173void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
174void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode,
175 struct btrfs_ordered_extent *entry);
176void btrfs_mark_ordered_io_finished(struct btrfs_inode *inode,
177 struct page *page, u64 file_offset,
178 u64 num_bytes, bool uptodate);
179bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode,
180 struct btrfs_ordered_extent **cached,
181 u64 file_offset, u64 io_size);
182int btrfs_add_ordered_extent(struct btrfs_inode *inode, u64 file_offset,
183 u64 num_bytes, u64 ram_bytes, u64 disk_bytenr,
184 u64 disk_num_bytes, u64 offset, unsigned flags,
185 int compress_type);
186void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
187 struct btrfs_ordered_sum *sum);
188struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode,
189 u64 file_offset);
190void btrfs_start_ordered_extent(struct btrfs_ordered_extent *entry, int wait);
191int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
192struct btrfs_ordered_extent *
193btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset);
194struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range(
195 struct btrfs_inode *inode, u64 file_offset, u64 len);
196struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
197 struct btrfs_inode *inode,
198 u64 file_offset,
199 u64 len);
200void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode,
201 struct list_head *list);
202u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
203 const u64 range_start, const u64 range_len);
204void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
205 const u64 range_start, const u64 range_len);
206void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
207 u64 end,
208 struct extent_state **cached_state);
209bool btrfs_try_lock_ordered_range(struct btrfs_inode *inode, u64 start, u64 end,
210 struct extent_state **cached_state);
211int btrfs_split_ordered_extent(struct btrfs_ordered_extent *ordered, u64 pre,
212 u64 post);
213int __init ordered_data_init(void);
214void __cold ordered_data_exit(void);
215
216#endif
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 */
10struct btrfs_ordered_inode_tree {
11 spinlock_t lock;
12 struct rb_root tree;
13 struct rb_node *last;
14};
15
16struct 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 u8 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 */
40enum {
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 */
46 BTRFS_ORDERED_NOCOW,
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 */
52 BTRFS_ORDERED_DIRECT,
53 /* We had an io error when writing this out */
54 BTRFS_ORDERED_IOERR,
55 /* Set when we have to truncate an extent */
56 BTRFS_ORDERED_TRUNCATED,
57 /* Regular IO for COW */
58 BTRFS_ORDERED_REGULAR,
59};
60
61struct btrfs_ordered_extent {
62 /* logical offset in the file */
63 u64 file_offset;
64
65 /*
66 * These fields directly correspond to the same fields in
67 * btrfs_file_extent_item.
68 */
69 u64 disk_bytenr;
70 u64 num_bytes;
71 u64 disk_num_bytes;
72
73 /* number of bytes that still need writing */
74 u64 bytes_left;
75
76 /*
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();
80 */
81 u64 outstanding_isize;
82
83 /*
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.
86 */
87 u64 truncated_len;
88
89 /* flags (described above) */
90 unsigned long flags;
91
92 /* compression algorithm */
93 int compress_type;
94
95 /* Qgroup reserved space */
96 int qgroup_rsv;
97
98 /* reference count */
99 refcount_t refs;
100
101 /* the inode we belong to */
102 struct inode *inode;
103
104 /* list of checksums for insertion when the extent io is done */
105 struct list_head list;
106
107 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
108 wait_queue_head_t wait;
109
110 /* our friendly rbtree entry */
111 struct rb_node rb_node;
112
113 /* a per root list of all the pending ordered extents */
114 struct list_head root_extent_list;
115
116 struct btrfs_work work;
117
118 struct completion completion;
119 struct btrfs_work flush_work;
120 struct list_head work_list;
121};
122
123/*
124 * calculates the total size you need to allocate for an ordered sum
125 * structure spanning 'bytes' in the file
126 */
127static inline int btrfs_ordered_sum_size(struct btrfs_fs_info *fs_info,
128 unsigned long bytes)
129{
130 int num_sectors = (int)DIV_ROUND_UP(bytes, fs_info->sectorsize);
131 int csum_size = btrfs_super_csum_size(fs_info->super_copy);
132
133 return sizeof(struct btrfs_ordered_sum) + num_sectors * csum_size;
134}
135
136static inline void
137btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
138{
139 spin_lock_init(&t->lock);
140 t->tree = RB_ROOT;
141 t->last = NULL;
142}
143
144void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
145void btrfs_remove_ordered_extent(struct inode *inode,
146 struct btrfs_ordered_extent *entry);
147int btrfs_dec_test_ordered_pending(struct inode *inode,
148 struct btrfs_ordered_extent **cached,
149 u64 file_offset, u64 io_size, int uptodate);
150int btrfs_dec_test_first_ordered_pending(struct btrfs_inode *inode,
151 struct btrfs_ordered_extent **cached,
152 u64 *file_offset, u64 io_size,
153 int uptodate);
154int btrfs_add_ordered_extent(struct btrfs_inode *inode, u64 file_offset,
155 u64 disk_bytenr, u64 num_bytes, u64 disk_num_bytes,
156 int type);
157int btrfs_add_ordered_extent_dio(struct btrfs_inode *inode, u64 file_offset,
158 u64 disk_bytenr, u64 num_bytes,
159 u64 disk_num_bytes, int type);
160int btrfs_add_ordered_extent_compress(struct btrfs_inode *inode, u64 file_offset,
161 u64 disk_bytenr, u64 num_bytes,
162 u64 disk_num_bytes, int type,
163 int compress_type);
164void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
165 struct btrfs_ordered_sum *sum);
166struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode,
167 u64 file_offset);
168void btrfs_start_ordered_extent(struct inode *inode,
169 struct btrfs_ordered_extent *entry, int wait);
170int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
171struct btrfs_ordered_extent *
172btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
173struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
174 struct btrfs_inode *inode,
175 u64 file_offset,
176 u64 len);
177int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u64 disk_bytenr,
178 u8 *sum, int len);
179u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
180 const u64 range_start, const u64 range_len);
181void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
182 const u64 range_start, const u64 range_len);
183void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
184 u64 end,
185 struct extent_state **cached_state);
186int __init ordered_data_init(void);
187void __cold ordered_data_exit(void);
188
189#endif