btrfs: open code btrfs_ordered_inode_tree in btrfs_inode
[linux-2.6-block.git] / fs / btrfs / ordered-data.h
CommitLineData
9888c340 1/* SPDX-License-Identifier: GPL-2.0 */
dc17ff8f
CM
2/*
3 * Copyright (C) 2007 Oracle. All rights reserved.
dc17ff8f
CM
4 */
5
9888c340
DS
6#ifndef BTRFS_ORDERED_DATA_H
7#define BTRFS_ORDERED_DATA_H
dc17ff8f 8
e6dcd2dc 9struct btrfs_ordered_sum {
3edf7d33 10 /*
5cfe76f8
CH
11 * Logical start address and length for of the blocks covered by
12 * the sums array.
3edf7d33 13 */
5cfe76f8 14 u64 logical;
6e4b2479 15 u32 len;
5cfe76f8 16
e6dcd2dc 17 struct list_head list;
f51a4a18 18 /* last field is a variable length array of csums */
1e25a2e3 19 u8 sums[];
e6dcd2dc
CM
20};
21
eb84ae03 22/*
3c198fe0 23 * Bits for btrfs_ordered_extent::flags.
eb84ae03
CM
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 */
5b840301 33enum {
3c198fe0 34 /*
0b3dcd13
QW
35 * Different types for ordered extents, one and only one of the 4 types
36 * need to be set when creating ordered extent.
3c198fe0
QW
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
5b840301
DS
56 /* set when all the pages are written */
57 BTRFS_ORDERED_IO_DONE,
58 /* set when removed from the tree */
59 BTRFS_ORDERED_COMPLETE,
5b840301
DS
60 /* We had an io error when writing this out */
61 BTRFS_ORDERED_IOERR,
5b840301
DS
62 /* Set when we have to truncate an extent */
63 BTRFS_ORDERED_TRUNCATED,
48778179
FM
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,
7c0c7269
OS
70 /* BTRFS_IOC_ENCODED_WRITE */
71 BTRFS_ORDERED_ENCODED,
5b840301 72};
1af4a0aa 73
cb36a9bb
OS
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) | \
7c0c7269
OS
79 (1UL << BTRFS_ORDERED_DIRECT) | \
80 (1UL << BTRFS_ORDERED_ENCODED))
cb36a9bb 81
e6dcd2dc 82struct btrfs_ordered_extent {
eb84ae03 83 /* logical offset in the file */
e6dcd2dc 84 u64 file_offset;
eb84ae03 85
bffe633e
OS
86 /*
87 * These fields directly correspond to the same fields in
88 * btrfs_file_extent_item.
89 */
bffe633e 90 u64 num_bytes;
cb36a9bb
OS
91 u64 ram_bytes;
92 u64 disk_bytenr;
bffe633e 93 u64 disk_num_bytes;
cb36a9bb 94 u64 offset;
c8b97818 95
8b62b72b
CM
96 /* number of bytes that still need writing */
97 u64 bytes_left;
98
b9a8cc5b
MX
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
77cef2ec
JB
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
eb84ae03 112 /* flags (described above) */
e6dcd2dc 113 unsigned long flags;
eb84ae03 114
261507a0
LZ
115 /* compression algorithm */
116 int compress_type;
117
7dbeaad0
QW
118 /* Qgroup reserved space */
119 int qgroup_rsv;
120
eb84ae03 121 /* reference count */
e76edab7 122 refcount_t refs;
eb84ae03 123
3eaa2885
CM
124 /* the inode we belong to */
125 struct inode *inode;
126
eb84ae03 127 /* list of checksums for insertion when the extent io is done */
e6dcd2dc 128 struct list_head list;
eb84ae03 129
48778179
FM
130 /* used for fast fsyncs */
131 struct list_head log_list;
132
eb84ae03 133 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
e6dcd2dc 134 wait_queue_head_t wait;
eb84ae03
CM
135
136 /* our friendly rbtree entry */
e6dcd2dc 137 struct rb_node rb_node;
3eaa2885
CM
138
139 /* a per root list of all the pending ordered extents */
140 struct list_head root_extent_list;
5fd02043 141
d458b054 142 struct btrfs_work work;
e6dcd2dc 143
9afab882 144 struct completion completion;
d458b054 145 struct btrfs_work flush_work;
9afab882 146 struct list_head work_list;
02c372e1
JT
147
148 struct list_head bioc_list;
9afab882 149};
e6dcd2dc 150
71df088c 151int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent);
711f447b
CH
152int btrfs_finish_ordered_io(struct btrfs_ordered_extent *ordered_extent);
153
143bede5 154void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
71fe0a55 155void btrfs_remove_ordered_extent(struct btrfs_inode *btrfs_inode,
e6dcd2dc 156 struct btrfs_ordered_extent *entry);
122e9ede
CH
157bool btrfs_finish_ordered_extent(struct btrfs_ordered_extent *ordered,
158 struct page *page, u64 file_offset, u64 len,
159 bool uptodate);
e65f152e
QW
160void btrfs_mark_ordered_io_finished(struct btrfs_inode *inode,
161 struct page *page, u64 file_offset,
711f447b 162 u64 num_bytes, bool uptodate);
58f74b22
QW
163bool btrfs_dec_test_ordered_pending(struct btrfs_inode *inode,
164 struct btrfs_ordered_extent **cached,
f41b6ba9 165 u64 file_offset, u64 io_size);
cf6d1aa4
BB
166struct 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);
f9756261 171void btrfs_add_ordered_sum(struct btrfs_ordered_extent *entry,
143bede5 172 struct btrfs_ordered_sum *sum);
c3504372 173struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct btrfs_inode *inode,
e6dcd2dc 174 u64 file_offset);
36d45567 175void btrfs_start_ordered_extent(struct btrfs_ordered_extent *entry);
0ef8b726 176int btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
e6dcd2dc 177struct btrfs_ordered_extent *
6d072c8e 178btrfs_lookup_first_ordered_extent(struct btrfs_inode *inode, u64 file_offset);
c095f333
QW
179struct btrfs_ordered_extent *btrfs_lookup_first_ordered_range(
180 struct btrfs_inode *inode, u64 file_offset, u64 len);
a776c6fa
NB
181struct btrfs_ordered_extent *btrfs_lookup_ordered_range(
182 struct btrfs_inode *inode,
183 u64 file_offset,
184 u64 len);
48778179
FM
185void btrfs_get_ordered_extents_for_logging(struct btrfs_inode *inode,
186 struct list_head *list);
6374e57a 187u64 btrfs_wait_ordered_extents(struct btrfs_root *root, u64 nr,
578def7c 188 const u64 range_start, const u64 range_len);
042528f8 189void btrfs_wait_ordered_roots(struct btrfs_fs_info *fs_info, u64 nr,
578def7c 190 const u64 range_start, const u64 range_len);
b272ae22 191void btrfs_lock_and_flush_ordered_range(struct btrfs_inode *inode, u64 start,
ffa87214
NB
192 u64 end,
193 struct extent_state **cached_state);
632ddfa2
JB
194bool btrfs_try_lock_ordered_range(struct btrfs_inode *inode, u64 start, u64 end,
195 struct extent_state **cached_state);
b0307e28
CH
196struct btrfs_ordered_extent *btrfs_split_ordered_extent(
197 struct btrfs_ordered_extent *ordered, u64 len);
6352b91d 198int __init ordered_data_init(void);
e67c718b 199void __cold ordered_data_exit(void);
9888c340 200
dc17ff8f 201#endif