xref: /linux/fs/btrfs/tree-log.h (revision 056a5087d87ead77dedbe9cf5bde53b7cd4b4651)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2008 Oracle.  All rights reserved.
4  */
5 
6 #ifndef BTRFS_TREE_LOG_H
7 #define BTRFS_TREE_LOG_H
8 
9 #include <linux/list.h>
10 #include <linux/fs.h>
11 #include <linux/fscrypt.h>
12 #include "transaction.h"
13 
14 enum btrfs_log_mode {
15 	/* Log everything about an inode. */
16 	LOG_INODE_ALL,
17 	/* Log just enough to recreate the inode during log replay. */
18 	LOG_INODE_EXISTS,
19 };
20 
21 struct inode;
22 struct dentry;
23 struct btrfs_ordered_extent;
24 struct btrfs_root;
25 struct btrfs_trans_handle;
26 
27 /* return value for btrfs_log_dentry_safe that means we don't need to log it at all */
28 #define BTRFS_NO_LOG_SYNC 256
29 
30 /*
31  * We can't use the tree log for whatever reason, force a transaction commit.
32  * We use a negative value because there are functions through the logging code
33  * that need to return an error (< 0 value), false (0) or true (1). Any negative
34  * value will do, as it will cause the log to be marked for a full sync.
35  */
36 #define BTRFS_LOG_FORCE_COMMIT				(-(MAX_ERRNO + 1))
37 
38 struct btrfs_log_ctx {
39 	int log_ret;
40 	int log_transid;
41 	bool log_new_dentries;
42 	bool logging_new_name;
43 	bool logging_new_delayed_dentries;
44 	/* Indicate if the inode being logged was logged before. */
45 	bool logged_before;
46 	struct btrfs_inode *inode;
47 	struct list_head list;
48 	/* Only used for fast fsyncs. */
49 	struct list_head ordered_extents;
50 	struct list_head conflict_inodes;
51 	int num_conflict_inodes;
52 	bool logging_conflict_inodes;
53 	/*
54 	 * Used for fsyncs that need to copy items from the subvolume tree to
55 	 * the log tree (full sync flag set or copy everything flag set) to
56 	 * avoid allocating a temporary extent buffer while holding a lock on
57 	 * an extent buffer of the subvolume tree and under the log transaction.
58 	 * Also helps to avoid allocating and freeing a temporary extent buffer
59 	 * in case we need to process multiple leaves from the subvolume tree.
60 	 */
61 	struct extent_buffer *scratch_eb;
62 };
63 
64 void btrfs_init_log_ctx(struct btrfs_log_ctx *ctx, struct btrfs_inode *inode);
65 void btrfs_init_log_ctx_scratch_eb(struct btrfs_log_ctx *ctx);
66 void btrfs_release_log_ctx_extents(struct btrfs_log_ctx *ctx);
67 
68 static inline void btrfs_set_log_full_commit(struct btrfs_trans_handle *trans)
69 {
70 	WRITE_ONCE(trans->fs_info->last_trans_log_full_commit, trans->transid);
71 }
72 
73 static inline int btrfs_need_log_full_commit(struct btrfs_trans_handle *trans)
74 {
75 	return READ_ONCE(trans->fs_info->last_trans_log_full_commit) ==
76 		trans->transid;
77 }
78 
79 int btrfs_sync_log(struct btrfs_trans_handle *trans,
80 		   struct btrfs_root *root, struct btrfs_log_ctx *ctx);
81 void btrfs_free_log(struct btrfs_trans_handle *trans, struct btrfs_root *root);
82 void btrfs_free_log_root_tree(struct btrfs_trans_handle *trans, struct btrfs_fs_info *fs_info);
83 int btrfs_recover_log_trees(struct btrfs_root *tree_root);
84 int btrfs_log_dentry_safe(struct btrfs_trans_handle *trans,
85 			  struct dentry *dentry,
86 			  struct btrfs_log_ctx *ctx);
87 void btrfs_del_dir_entries_in_log(struct btrfs_trans_handle *trans,
88 				  const struct fscrypt_str *name,
89 				  struct btrfs_inode *dir, u64 index);
90 void btrfs_del_inode_ref_in_log(struct btrfs_trans_handle *trans,
91 				const struct fscrypt_str *name,
92 				struct btrfs_inode *inode,
93 				struct btrfs_inode *dir);
94 void btrfs_end_log_trans(struct btrfs_root *root);
95 void btrfs_pin_log_trans(struct btrfs_root *root);
96 void btrfs_record_unlink_dir(struct btrfs_trans_handle *trans,
97 			     struct btrfs_inode *dir, struct btrfs_inode *inode,
98 			     bool for_rename);
99 void btrfs_record_snapshot_destroy(struct btrfs_trans_handle *trans,
100 				   struct btrfs_inode *dir);
101 void btrfs_record_new_subvolume(const struct btrfs_trans_handle *trans,
102 				struct btrfs_inode *dir);
103 void btrfs_log_new_name(struct btrfs_trans_handle *trans,
104 			struct dentry *old_dentry, struct btrfs_inode *old_dir,
105 			u64 old_dir_index, struct dentry *parent);
106 
107 #endif
108