xref: /linux/fs/btrfs/transaction.h (revision b85d45947951d23cb22d90caecf4c1eb81342c96)
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 	struct list_head io_bgs;
68 	struct list_head dropped_roots;
69 	u64 num_dirty_bgs;
70 
71 	/*
72 	 * we need to make sure block group deletion doesn't race with
73 	 * free space cache writeout.  This mutex keeps them from stomping
74 	 * on each other
75 	 */
76 	struct mutex cache_write_mutex;
77 	spinlock_t dirty_bgs_lock;
78 	struct list_head deleted_bgs;
79 	spinlock_t deleted_bgs_lock;
80 	spinlock_t dropped_roots_lock;
81 	struct btrfs_delayed_ref_root delayed_refs;
82 	int aborted;
83 	int dirty_bg_run;
84 };
85 
86 #define __TRANS_FREEZABLE	(1U << 0)
87 
88 #define __TRANS_USERSPACE	(1U << 8)
89 #define __TRANS_START		(1U << 9)
90 #define __TRANS_ATTACH		(1U << 10)
91 #define __TRANS_JOIN		(1U << 11)
92 #define __TRANS_JOIN_NOLOCK	(1U << 12)
93 #define __TRANS_DUMMY		(1U << 13)
94 
95 #define TRANS_USERSPACE		(__TRANS_USERSPACE | __TRANS_FREEZABLE)
96 #define TRANS_START		(__TRANS_START | __TRANS_FREEZABLE)
97 #define TRANS_ATTACH		(__TRANS_ATTACH)
98 #define TRANS_JOIN		(__TRANS_JOIN | __TRANS_FREEZABLE)
99 #define TRANS_JOIN_NOLOCK	(__TRANS_JOIN_NOLOCK)
100 
101 #define TRANS_EXTWRITERS	(__TRANS_USERSPACE | __TRANS_START |	\
102 				 __TRANS_ATTACH)
103 
104 #define BTRFS_SEND_TRANS_STUB	((void *)1)
105 
106 struct btrfs_trans_handle {
107 	u64 transid;
108 	u64 bytes_reserved;
109 	u64 chunk_bytes_reserved;
110 	u64 qgroup_reserved;
111 	unsigned long use_count;
112 	unsigned long blocks_reserved;
113 	unsigned long blocks_used;
114 	unsigned long delayed_ref_updates;
115 	struct btrfs_transaction *transaction;
116 	struct btrfs_block_rsv *block_rsv;
117 	struct btrfs_block_rsv *orig_rsv;
118 	short aborted;
119 	short adding_csums;
120 	bool allocating_chunk;
121 	bool can_flush_pending_bgs;
122 	bool reloc_reserved;
123 	bool sync;
124 	unsigned int type;
125 	/*
126 	 * this root is only needed to validate that the root passed to
127 	 * start_transaction is the same as the one passed to end_transaction.
128 	 * Subvolume quota depends on this
129 	 */
130 	struct btrfs_root *root;
131 	struct seq_list delayed_ref_elem;
132 	struct list_head ordered;
133 	struct list_head qgroup_ref_list;
134 	struct list_head new_bgs;
135 };
136 
137 struct btrfs_pending_snapshot {
138 	struct dentry *dentry;
139 	struct inode *dir;
140 	struct btrfs_root *root;
141 	struct btrfs_root *snap;
142 	struct btrfs_qgroup_inherit *inherit;
143 	/* block reservation for the operation */
144 	struct btrfs_block_rsv block_rsv;
145 	u64 qgroup_reserved;
146 	/* extra metadata reseration for relocation */
147 	int error;
148 	bool readonly;
149 	struct list_head list;
150 };
151 
152 static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
153 					      struct inode *inode)
154 {
155 	spin_lock(&BTRFS_I(inode)->lock);
156 	BTRFS_I(inode)->last_trans = trans->transaction->transid;
157 	BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
158 	BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
159 	spin_unlock(&BTRFS_I(inode)->lock);
160 }
161 
162 /*
163  * Make qgroup codes to skip given qgroupid, means the old/new_roots for
164  * qgroup won't contain the qgroupid in it.
165  */
166 static inline void btrfs_set_skip_qgroup(struct btrfs_trans_handle *trans,
167 					 u64 qgroupid)
168 {
169 	struct btrfs_delayed_ref_root *delayed_refs;
170 
171 	delayed_refs = &trans->transaction->delayed_refs;
172 	WARN_ON(delayed_refs->qgroup_to_skip);
173 	delayed_refs->qgroup_to_skip = qgroupid;
174 }
175 
176 static inline void btrfs_clear_skip_qgroup(struct btrfs_trans_handle *trans)
177 {
178 	struct btrfs_delayed_ref_root *delayed_refs;
179 
180 	delayed_refs = &trans->transaction->delayed_refs;
181 	WARN_ON(!delayed_refs->qgroup_to_skip);
182 	delayed_refs->qgroup_to_skip = 0;
183 }
184 
185 int btrfs_end_transaction(struct btrfs_trans_handle *trans,
186 			  struct btrfs_root *root);
187 struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
188 						   int num_items);
189 struct btrfs_trans_handle *btrfs_start_transaction_lflush(
190 					struct btrfs_root *root, int num_items);
191 struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
192 struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
193 struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
194 struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
195 					struct btrfs_root *root);
196 struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
197 int btrfs_wait_for_commit(struct btrfs_root *root, u64 transid);
198 
199 void btrfs_add_dead_root(struct btrfs_root *root);
200 int btrfs_defrag_root(struct btrfs_root *root);
201 int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
202 int btrfs_commit_transaction(struct btrfs_trans_handle *trans,
203 			     struct btrfs_root *root);
204 int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
205 				   struct btrfs_root *root,
206 				   int wait_for_unblock);
207 int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans,
208 				   struct btrfs_root *root);
209 int btrfs_should_end_transaction(struct btrfs_trans_handle *trans,
210 				 struct btrfs_root *root);
211 void btrfs_throttle(struct btrfs_root *root);
212 int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
213 				struct btrfs_root *root);
214 int btrfs_write_marked_extents(struct btrfs_root *root,
215 				struct extent_io_tree *dirty_pages, int mark);
216 int btrfs_wait_marked_extents(struct btrfs_root *root,
217 				struct extent_io_tree *dirty_pages, int mark);
218 int btrfs_transaction_blocked(struct btrfs_fs_info *info);
219 int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
220 void btrfs_put_transaction(struct btrfs_transaction *transaction);
221 void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
222 void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
223 			    struct btrfs_root *root);
224 #endif
225