btrfs: use tagged writepage to mitigate livelock of snapshot
[sfrench/cifs-2.6.git] / fs / btrfs / btrfs_inode.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2007 Oracle.  All rights reserved.
4  */
5
6 #ifndef BTRFS_INODE_H
7 #define BTRFS_INODE_H
8
9 #include <linux/hash.h>
10 #include "extent_map.h"
11 #include "extent_io.h"
12 #include "ordered-data.h"
13 #include "delayed-inode.h"
14
15 /*
16  * ordered_data_close is set by truncate when a file that used
17  * to have good data has been truncated to zero.  When it is set
18  * the btrfs file release call will add this inode to the
19  * ordered operations list so that we make sure to flush out any
20  * new data the application may have written before commit.
21  */
22 enum {
23         BTRFS_INODE_ORDERED_DATA_CLOSE = 0,
24         BTRFS_INODE_DUMMY,
25         BTRFS_INODE_IN_DEFRAG,
26         BTRFS_INODE_HAS_ASYNC_EXTENT,
27         BTRFS_INODE_NEEDS_FULL_SYNC,
28         BTRFS_INODE_COPY_EVERYTHING,
29         BTRFS_INODE_IN_DELALLOC_LIST,
30         BTRFS_INODE_READDIO_NEED_LOCK,
31         BTRFS_INODE_HAS_PROPS,
32         BTRFS_INODE_SNAPSHOT_FLUSH,
33 };
34
35 /* in memory btrfs inode */
36 struct btrfs_inode {
37         /* which subvolume this inode belongs to */
38         struct btrfs_root *root;
39
40         /* key used to find this inode on disk.  This is used by the code
41          * to read in roots of subvolumes
42          */
43         struct btrfs_key location;
44
45         /*
46          * Lock for counters and all fields used to determine if the inode is in
47          * the log or not (last_trans, last_sub_trans, last_log_commit,
48          * logged_trans).
49          */
50         spinlock_t lock;
51
52         /* the extent_tree has caches of all the extent mappings to disk */
53         struct extent_map_tree extent_tree;
54
55         /* the io_tree does range state (DIRTY, LOCKED etc) */
56         struct extent_io_tree io_tree;
57
58         /* special utility tree used to record which mirrors have already been
59          * tried when checksums fail for a given block
60          */
61         struct extent_io_tree io_failure_tree;
62
63         /* held while logging the inode in tree-log.c */
64         struct mutex log_mutex;
65
66         /* held while doing delalloc reservations */
67         struct mutex delalloc_mutex;
68
69         /* used to order data wrt metadata */
70         struct btrfs_ordered_inode_tree ordered_tree;
71
72         /* list of all the delalloc inodes in the FS.  There are times we need
73          * to write all the delalloc pages to disk, and this list is used
74          * to walk them all.
75          */
76         struct list_head delalloc_inodes;
77
78         /* node for the red-black tree that links inodes in subvolume root */
79         struct rb_node rb_node;
80
81         unsigned long runtime_flags;
82
83         /* Keep track of who's O_SYNC/fsyncing currently */
84         atomic_t sync_writers;
85
86         /* full 64 bit generation number, struct vfs_inode doesn't have a big
87          * enough field for this.
88          */
89         u64 generation;
90
91         /*
92          * transid of the trans_handle that last modified this inode
93          */
94         u64 last_trans;
95
96         /*
97          * transid that last logged this inode
98          */
99         u64 logged_trans;
100
101         /*
102          * log transid when this inode was last modified
103          */
104         int last_sub_trans;
105
106         /* a local copy of root's last_log_commit */
107         int last_log_commit;
108
109         /* total number of bytes pending delalloc, used by stat to calc the
110          * real block usage of the file
111          */
112         u64 delalloc_bytes;
113
114         /*
115          * Total number of bytes pending delalloc that fall within a file
116          * range that is either a hole or beyond EOF (and no prealloc extent
117          * exists in the range). This is always <= delalloc_bytes.
118          */
119         u64 new_delalloc_bytes;
120
121         /*
122          * total number of bytes pending defrag, used by stat to check whether
123          * it needs COW.
124          */
125         u64 defrag_bytes;
126
127         /*
128          * the size of the file stored in the metadata on disk.  data=ordered
129          * means the in-memory i_size might be larger than the size on disk
130          * because not all the blocks are written yet.
131          */
132         u64 disk_i_size;
133
134         /*
135          * if this is a directory then index_cnt is the counter for the index
136          * number for new files that are created
137          */
138         u64 index_cnt;
139
140         /* Cache the directory index number to speed the dir/file remove */
141         u64 dir_index;
142
143         /* the fsync log has some corner cases that mean we have to check
144          * directories to see if any unlinks have been done before
145          * the directory was logged.  See tree-log.c for all the
146          * details
147          */
148         u64 last_unlink_trans;
149
150         /*
151          * Number of bytes outstanding that are going to need csums.  This is
152          * used in ENOSPC accounting.
153          */
154         u64 csum_bytes;
155
156         /* flags field from the on disk inode */
157         u32 flags;
158
159         /*
160          * Counters to keep track of the number of extent item's we may use due
161          * to delalloc and such.  outstanding_extents is the number of extent
162          * items we think we'll end up using, and reserved_extents is the number
163          * of extent items we've reserved metadata for.
164          */
165         unsigned outstanding_extents;
166
167         struct btrfs_block_rsv block_rsv;
168
169         /*
170          * Cached values of inode properties
171          */
172         unsigned prop_compress;         /* per-file compression algorithm */
173         /*
174          * Force compression on the file using the defrag ioctl, could be
175          * different from prop_compress and takes precedence if set
176          */
177         unsigned defrag_compress;
178
179         struct btrfs_delayed_node *delayed_node;
180
181         /* File creation time. */
182         struct timespec64 i_otime;
183
184         /* Hook into fs_info->delayed_iputs */
185         struct list_head delayed_iput;
186
187         /*
188          * To avoid races between lockless (i_mutex not held) direct IO writes
189          * and concurrent fsync requests. Direct IO writes must acquire read
190          * access on this semaphore for creating an extent map and its
191          * corresponding ordered extent. The fast fsync path must acquire write
192          * access on this semaphore before it collects ordered extents and
193          * extent maps.
194          */
195         struct rw_semaphore dio_sem;
196
197         struct inode vfs_inode;
198 };
199
200 extern unsigned char btrfs_filetype_table[];
201
202 static inline struct btrfs_inode *BTRFS_I(const struct inode *inode)
203 {
204         return container_of(inode, struct btrfs_inode, vfs_inode);
205 }
206
207 static inline unsigned long btrfs_inode_hash(u64 objectid,
208                                              const struct btrfs_root *root)
209 {
210         u64 h = objectid ^ (root->root_key.objectid * GOLDEN_RATIO_PRIME);
211
212 #if BITS_PER_LONG == 32
213         h = (h >> 32) ^ (h & 0xffffffff);
214 #endif
215
216         return (unsigned long)h;
217 }
218
219 static inline void btrfs_insert_inode_hash(struct inode *inode)
220 {
221         unsigned long h = btrfs_inode_hash(inode->i_ino, BTRFS_I(inode)->root);
222
223         __insert_inode_hash(inode, h);
224 }
225
226 static inline u64 btrfs_ino(const struct btrfs_inode *inode)
227 {
228         u64 ino = inode->location.objectid;
229
230         /*
231          * !ino: btree_inode
232          * type == BTRFS_ROOT_ITEM_KEY: subvol dir
233          */
234         if (!ino || inode->location.type == BTRFS_ROOT_ITEM_KEY)
235                 ino = inode->vfs_inode.i_ino;
236         return ino;
237 }
238
239 static inline void btrfs_i_size_write(struct btrfs_inode *inode, u64 size)
240 {
241         i_size_write(&inode->vfs_inode, size);
242         inode->disk_i_size = size;
243 }
244
245 static inline bool btrfs_is_free_space_inode(struct btrfs_inode *inode)
246 {
247         struct btrfs_root *root = inode->root;
248
249         if (root == root->fs_info->tree_root &&
250             btrfs_ino(inode) != BTRFS_BTREE_INODE_OBJECTID)
251                 return true;
252         if (inode->location.objectid == BTRFS_FREE_INO_OBJECTID)
253                 return true;
254         return false;
255 }
256
257 static inline bool is_data_inode(struct inode *inode)
258 {
259         return btrfs_ino(BTRFS_I(inode)) != BTRFS_BTREE_INODE_OBJECTID;
260 }
261
262 static inline void btrfs_mod_outstanding_extents(struct btrfs_inode *inode,
263                                                  int mod)
264 {
265         lockdep_assert_held(&inode->lock);
266         inode->outstanding_extents += mod;
267         if (btrfs_is_free_space_inode(inode))
268                 return;
269         trace_btrfs_inode_mod_outstanding_extents(inode->root, btrfs_ino(inode),
270                                                   mod);
271 }
272
273 static inline int btrfs_inode_in_log(struct btrfs_inode *inode, u64 generation)
274 {
275         int ret = 0;
276
277         spin_lock(&inode->lock);
278         if (inode->logged_trans == generation &&
279             inode->last_sub_trans <= inode->last_log_commit &&
280             inode->last_sub_trans <= inode->root->last_log_commit) {
281                 /*
282                  * After a ranged fsync we might have left some extent maps
283                  * (that fall outside the fsync's range). So return false
284                  * here if the list isn't empty, to make sure btrfs_log_inode()
285                  * will be called and process those extent maps.
286                  */
287                 smp_mb();
288                 if (list_empty(&inode->extent_tree.modified_extents))
289                         ret = 1;
290         }
291         spin_unlock(&inode->lock);
292         return ret;
293 }
294
295 #define BTRFS_DIO_ORIG_BIO_SUBMITTED    0x1
296
297 struct btrfs_dio_private {
298         struct inode *inode;
299         unsigned long flags;
300         u64 logical_offset;
301         u64 disk_bytenr;
302         u64 bytes;
303         void *private;
304
305         /* number of bios pending for this dio */
306         atomic_t pending_bios;
307
308         /* IO errors */
309         int errors;
310
311         /* orig_bio is our btrfs_io_bio */
312         struct bio *orig_bio;
313
314         /* dio_bio came from fs/direct-io.c */
315         struct bio *dio_bio;
316
317         /*
318          * The original bio may be split to several sub-bios, this is
319          * done during endio of sub-bios
320          */
321         blk_status_t (*subio_endio)(struct inode *, struct btrfs_io_bio *,
322                         blk_status_t);
323 };
324
325 /*
326  * Disable DIO read nolock optimization, so new dio readers will be forced
327  * to grab i_mutex. It is used to avoid the endless truncate due to
328  * nonlocked dio read.
329  */
330 static inline void btrfs_inode_block_unlocked_dio(struct btrfs_inode *inode)
331 {
332         set_bit(BTRFS_INODE_READDIO_NEED_LOCK, &inode->runtime_flags);
333         smp_mb();
334 }
335
336 static inline void btrfs_inode_resume_unlocked_dio(struct btrfs_inode *inode)
337 {
338         smp_mb__before_atomic();
339         clear_bit(BTRFS_INODE_READDIO_NEED_LOCK, &inode->runtime_flags);
340 }
341
342 static inline void btrfs_print_data_csum_error(struct btrfs_inode *inode,
343                 u64 logical_start, u32 csum, u32 csum_expected, int mirror_num)
344 {
345         struct btrfs_root *root = inode->root;
346
347         /* Output minus objectid, which is more meaningful */
348         if (root->root_key.objectid >= BTRFS_LAST_FREE_OBJECTID)
349                 btrfs_warn_rl(root->fs_info,
350         "csum failed root %lld ino %lld off %llu csum 0x%08x expected csum 0x%08x mirror %d",
351                         root->root_key.objectid, btrfs_ino(inode),
352                         logical_start, csum, csum_expected, mirror_num);
353         else
354                 btrfs_warn_rl(root->fs_info,
355         "csum failed root %llu ino %llu off %llu csum 0x%08x expected csum 0x%08x mirror %d",
356                         root->root_key.objectid, btrfs_ino(inode),
357                         logical_start, csum, csum_expected, mirror_num);
358 }
359
360 #endif