xref: /openbmc/linux/fs/btrfs/transaction.h (revision d5e7cafd)
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_TRANSACTION__
20 #define __BTRFS_TRANSACTION__
21 #include "btrfs_inode.h"
22 #include "delayed-ref.h"
23 #include "ctree.h"
24 
25 enum btrfs_trans_state {
26 	TRANS_STATE_RUNNING		= 0,
27 	TRANS_STATE_BLOCKED		= 1,
28 	TRANS_STATE_COMMIT_START	= 2,
29 	TRANS_STATE_COMMIT_DOING	= 3,
30 	TRANS_STATE_UNBLOCKED		= 4,
31 	TRANS_STATE_COMPLETED		= 5,
32 	TRANS_STATE_MAX			= 6,
33 };
34 
35 struct btrfs_transaction {
36 	u64 transid;
37 	/*
38 	 * total external writers(USERSPACE/START/ATTACH) in this
39 	 * transaction, it must be zero before the transaction is
40 	 * being committed
41 	 */
42 	atomic_t num_extwriters;
43 	/*
44 	 * total writers in this transaction, it must be zero before the
45 	 * transaction can end
46 	 */
47 	atomic_t num_writers;
48 	atomic_t use_count;
49 
50 	/*
51 	 * true if there is free bgs operations in this transaction
52 	 */
53 	int have_free_bgs;
54 
55 	/* Be protected by fs_info->trans_lock when we want to change it. */
56 	enum btrfs_trans_state state;
57 	struct list_head list;
58 	struct extent_io_tree dirty_pages;
59 	unsigned long start_time;
60 	wait_queue_head_t writer_wait;
61 	wait_queue_head_t commit_wait;
62 	struct list_head pending_snapshots;
63 	struct list_head pending_chunks;
64 	struct list_head pending_ordered;
65 	struct list_head switch_commits;
66 	struct list_head dirty_bgs;
67 	spinlock_t dirty_bgs_lock;
68 	struct btrfs_delayed_ref_root delayed_refs;
69 	int aborted;
70 };
71 
72 #define __TRANS_FREEZABLE	(1U << 0)
73 
74 #define __TRANS_USERSPACE	(1U << 8)
75 #define __TRANS_START		(1U << 9)
76 #define __TRANS_ATTACH		(1U << 10)
77 #define __TRANS_JOIN		(1U << 11)
78 #define __TRANS_JOIN_NOLOCK	(1U << 12)
79 #define __TRANS_DUMMY		(1U << 13)
80 
81 #define TRANS_USERSPACE		(__TRANS_USERSPACE | __TRANS_FREEZABLE)
82 #define TRANS_START		(__TRANS_START | __TRANS_FREEZABLE)
83 #define TRANS_ATTACH		(__TRANS_ATTACH)
84 #define TRANS_JOIN		(__TRANS_JOIN | __TRANS_FREEZABLE)
85 #define TRANS_JOIN_NOLOCK	(__TRANS_JOIN_NOLOCK)
86 
87 #define TRANS_EXTWRITERS	(__TRANS_USERSPACE | __TRANS_START |	\
88 				 __TRANS_ATTACH)
89 
90 #define BTRFS_SEND_TRANS_STUB	((void *)1)
91 
92 struct btrfs_trans_handle {
93 	u64 transid;
94 	u64 bytes_reserved;
95 	u64 qgroup_reserved;
96 	unsigned long use_count;
97 	unsigned long blocks_reserved;
98 	unsigned long blocks_used;
99 	unsigned long delayed_ref_updates;
100 	struct btrfs_transaction *transaction;
101 	struct btrfs_block_rsv *block_rsv;
102 	struct btrfs_block_rsv *orig_rsv;
103 	short aborted;
104 	short adding_csums;
105 	bool allocating_chunk;
106 	bool reloc_reserved;
107 	bool sync;
108 	unsigned int type;
109 	/*
110 	 * this root is only needed to validate that the root passed to
111 	 * start_transaction is the same as the one passed to end_transaction.
112 	 * Subvolume quota depends on this
113 	 */
114 	struct btrfs_root *root;
115 	struct seq_list delayed_ref_elem;
116 	struct list_head ordered;
117 	struct list_head qgroup_ref_list;
118 	struct list_head new_bgs;
119 };
120 
121 struct btrfs_pending_snapshot {
122 	struct dentry *dentry;
123 	struct inode *dir;
124 	struct btrfs_root *root;
125 	struct btrfs_root *snap;
126 	struct btrfs_qgroup_inherit *inherit;
127 	/* block reservation for the operation */
128 	struct btrfs_block_rsv block_rsv;
129 	u64 qgroup_reserved;
130 	/* extra metadata reseration for relocation */
131 	int error;
132 	bool readonly;
133 	struct list_head list;
134 };
135 
136 static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
137 					      struct inode *inode)
138 {
139 	BTRFS_I(inode)->last_trans = trans->transaction->transid;
140 	BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
141 	BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
142 }
143 
144 int btrfs_end_transaction(struct btrfs_trans_handle *trans,
145 			  struct btrfs_root *root);
146 struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
147 						   int num_items);
148 struct btrfs_trans_handle *btrfs_start_transaction_lflush(
149 					struct btrfs_root *root, int num_items);
150 struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
151 struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
152 struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
153 struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
154 					struct btrfs_root *root);
155 struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
156 int btrfs_wait_for_commit(struct btrfs_root *root, u64 transid);
157 
158 void btrfs_add_dead_root(struct btrfs_root *root);
159 int btrfs_defrag_root(struct btrfs_root *root);
160 int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
161 int btrfs_commit_transaction(struct btrfs_trans_handle *trans,
162 			     struct btrfs_root *root);
163 int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
164 				   struct btrfs_root *root,
165 				   int wait_for_unblock);
166 int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans,
167 				   struct btrfs_root *root);
168 int btrfs_should_end_transaction(struct btrfs_trans_handle *trans,
169 				 struct btrfs_root *root);
170 void btrfs_throttle(struct btrfs_root *root);
171 int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
172 				struct btrfs_root *root);
173 int btrfs_write_marked_extents(struct btrfs_root *root,
174 				struct extent_io_tree *dirty_pages, int mark);
175 int btrfs_wait_marked_extents(struct btrfs_root *root,
176 				struct extent_io_tree *dirty_pages, int mark);
177 int btrfs_transaction_blocked(struct btrfs_fs_info *info);
178 int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
179 void btrfs_put_transaction(struct btrfs_transaction *transaction);
180 void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
181 
182 #endif
183