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
9struct 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 */
33enum {
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
82struct 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 * 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.
102 */
103 u64 truncated_len;
104
105 /* flags (described above) */
106 unsigned long flags;
107
108 /* compression algorithm */
109 int compress_type;
110
111 /* Qgroup reserved space */
112 int qgroup_rsv;
113
114 /* reference count */
115 refcount_t refs;
116
117 /* the inode we belong to */
118 struct inode *inode;
119
120 /* list of checksums for insertion when the extent io is done */
121 struct list_head list;
122
123 /* used for fast fsyncs */
124 struct list_head log_list;
125
126 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
127 wait_queue_head_t wait;
128
129 /* our friendly rbtree entry */
130 struct rb_node rb_node;
131
132 /* a per root list of all the pending ordered extents */
133 struct list_head root_extent_list;
134
135 struct btrfs_work work;
136
137 struct completion completion;
138 struct btrfs_work flush_work;
139 struct list_head work_list;
140
141 struct list_head bioc_list;
142};
143
144int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent);
145int btrfs_finish_ordered_io(struct btrfs_ordered_extent *ordered_extent);
146
147void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
148void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode,
149 struct btrfs_ordered_extent *entry);
150bool btrfs_finish_ordered_extent(struct btrfs_ordered_extent *ordered,
151 struct page *page, u64 file_offset, u64 len,
152 bool uptodate);
153void btrfs_mark_ordered_io_finished(struct btrfs_inode *inode,
154 struct page *page, u64 file_offset,
155 u64 num_bytes, bool uptodate);
156bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode,
157 struct btrfs_ordered_extent **cached,
158 u64 file_offset, u64 io_size);
159struct 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,
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 btrfs_ordered_extent *entry);
169int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
170struct btrfs_ordered_extent *
171btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset);
172struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range(
173 struct btrfs_inode *inode, u64 file_offset, u64 len);
174struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
175 struct btrfs_inode *inode,
176 u64 file_offset,
177 u64 len);
178void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode,
179 struct list_head *list);
180u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
181 const u64 range_start, const u64 range_len);
182void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
183 const u64 range_start, const u64 range_len);
184void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
185 u64 end,
186 struct extent_state **cached_state);
187bool btrfs_try_lock_ordered_range(struct btrfs_inode *inode, u64 start, u64 end,
188 struct extent_state **cached_state);
189struct btrfs_ordered_extent *btrfs_split_ordered_extent(
190 struct btrfs_ordered_extent *ordered, u64 len);
191int __init ordered_data_init(void);
192void __cold ordered_data_exit(void);
193
194#endif
1/*
2 * Copyright (C) 2007 Oracle. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
17 */
18
19#ifndef __BTRFS_ORDERED_DATA__
20#define __BTRFS_ORDERED_DATA__
21
22/* one of these per inode */
23struct btrfs_ordered_inode_tree {
24 spinlock_t lock;
25 struct rb_root tree;
26 struct rb_node *last;
27};
28
29/*
30 * these are used to collect checksums done just before bios submission.
31 * They are attached via a list into the ordered extent, and
32 * checksum items are inserted into the tree after all the blocks in
33 * the ordered extent are on disk
34 */
35struct btrfs_sector_sum {
36 /* bytenr on disk */
37 u64 bytenr;
38 u32 sum;
39};
40
41struct btrfs_ordered_sum {
42 /* bytenr is the start of this extent on disk */
43 u64 bytenr;
44
45 /*
46 * this is the length in bytes covered by the sums array below.
47 */
48 unsigned long len;
49 struct list_head list;
50 /* last field is a variable length array of btrfs_sector_sums */
51 struct btrfs_sector_sum sums[];
52};
53
54/*
55 * bits for the flags field:
56 *
57 * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
58 * It is used to make sure metadata is inserted into the tree only once
59 * per extent.
60 *
61 * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
62 * rbtree, just before waking any waiters. It is used to indicate the
63 * IO is done and any metadata is inserted into the tree.
64 */
65#define BTRFS_ORDERED_IO_DONE 0 /* set when all the pages are written */
66
67#define BTRFS_ORDERED_COMPLETE 1 /* set when removed from the tree */
68
69#define BTRFS_ORDERED_NOCOW 2 /* set when we want to write in place */
70
71#define BTRFS_ORDERED_COMPRESSED 3 /* writing a zlib compressed extent */
72
73#define BTRFS_ORDERED_PREALLOC 4 /* set when writing to prealloced extent */
74
75#define BTRFS_ORDERED_DIRECT 5 /* set when we're doing DIO with this extent */
76
77struct btrfs_ordered_extent {
78 /* logical offset in the file */
79 u64 file_offset;
80
81 /* disk byte number */
82 u64 start;
83
84 /* ram length of the extent in bytes */
85 u64 len;
86
87 /* extent length on disk */
88 u64 disk_len;
89
90 /* number of bytes that still need writing */
91 u64 bytes_left;
92
93 /* flags (described above) */
94 unsigned long flags;
95
96 /* compression algorithm */
97 int compress_type;
98
99 /* reference count */
100 atomic_t refs;
101
102 /* the inode we belong to */
103 struct inode *inode;
104
105 /* list of checksums for insertion when the extent io is done */
106 struct list_head list;
107
108 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
109 wait_queue_head_t wait;
110
111 /* our friendly rbtree entry */
112 struct rb_node rb_node;
113
114 /* a per root list of all the pending ordered extents */
115 struct list_head root_extent_list;
116};
117
118
119/*
120 * calculates the total size you need to allocate for an ordered sum
121 * structure spanning 'bytes' in the file
122 */
123static inline int btrfs_ordered_sum_size(struct btrfs_root *root,
124 unsigned long bytes)
125{
126 unsigned long num_sectors = (bytes + root->sectorsize - 1) /
127 root->sectorsize;
128 num_sectors++;
129 return sizeof(struct btrfs_ordered_sum) +
130 num_sectors * sizeof(struct btrfs_sector_sum);
131}
132
133static inline void
134btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
135{
136 spin_lock_init(&t->lock);
137 t->tree = RB_ROOT;
138 t->last = NULL;
139}
140
141int btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
142int btrfs_remove_ordered_extent(struct inode *inode,
143 struct btrfs_ordered_extent *entry);
144int btrfs_dec_test_ordered_pending(struct inode *inode,
145 struct btrfs_ordered_extent **cached,
146 u64 file_offset, u64 io_size);
147int btrfs_dec_test_first_ordered_pending(struct inode *inode,
148 struct btrfs_ordered_extent **cached,
149 u64 *file_offset, u64 io_size);
150int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset,
151 u64 start, u64 len, u64 disk_len, int type);
152int btrfs_add_ordered_extent_dio(struct inode *inode, u64 file_offset,
153 u64 start, u64 len, u64 disk_len, int type);
154int btrfs_add_ordered_extent_compress(struct inode *inode, u64 file_offset,
155 u64 start, u64 len, u64 disk_len,
156 int type, int compress_type);
157int btrfs_add_ordered_sum(struct inode *inode,
158 struct btrfs_ordered_extent *entry,
159 struct btrfs_ordered_sum *sum);
160struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode,
161 u64 file_offset);
162void btrfs_start_ordered_extent(struct inode *inode,
163 struct btrfs_ordered_extent *entry, int wait);
164int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
165struct btrfs_ordered_extent *
166btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
167struct btrfs_ordered_extent *btrfs_lookup_ordered_range(struct inode *inode,
168 u64 file_offset,
169 u64 len);
170int btrfs_ordered_update_i_size(struct inode *inode, u64 offset,
171 struct btrfs_ordered_extent *ordered);
172int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u64 disk_bytenr, u32 *sum);
173int btrfs_run_ordered_operations(struct btrfs_root *root, int wait);
174int btrfs_add_ordered_operation(struct btrfs_trans_handle *trans,
175 struct btrfs_root *root,
176 struct inode *inode);
177int btrfs_wait_ordered_extents(struct btrfs_root *root,
178 int nocow_only, int delay_iput);
179#endif