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
 25enum 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
 
 
 
 
 35struct 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	/* Be protected by fs_info->trans_lock when we want to change it. */
 51	enum btrfs_trans_state state;
 
 52	struct list_head list;
 53	struct extent_io_tree dirty_pages;
 54	unsigned long start_time;
 55	wait_queue_head_t writer_wait;
 56	wait_queue_head_t commit_wait;
 57	struct list_head pending_snapshots;
 58	struct list_head ordered_operations;
 59	struct list_head pending_chunks;
 60	struct list_head switch_commits;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 61	struct btrfs_delayed_ref_root delayed_refs;
 62	int aborted;
 63};
 64
 65#define __TRANS_FREEZABLE	(1U << 0)
 
 
 
 
 
 
 
 
 
 66
 67#define __TRANS_USERSPACE	(1U << 8)
 68#define __TRANS_START		(1U << 9)
 69#define __TRANS_ATTACH		(1U << 10)
 70#define __TRANS_JOIN		(1U << 11)
 71#define __TRANS_JOIN_NOLOCK	(1U << 12)
 
 
 
 
 72
 73#define TRANS_USERSPACE		(__TRANS_USERSPACE | __TRANS_FREEZABLE)
 74#define TRANS_START		(__TRANS_START | __TRANS_FREEZABLE)
 75#define TRANS_ATTACH		(__TRANS_ATTACH)
 76#define TRANS_JOIN		(__TRANS_JOIN | __TRANS_FREEZABLE)
 77#define TRANS_JOIN_NOLOCK	(__TRANS_JOIN_NOLOCK)
 
 78
 79#define TRANS_EXTWRITERS	(__TRANS_USERSPACE | __TRANS_START |	\
 80				 __TRANS_ATTACH)
 81
 82#define BTRFS_SEND_TRANS_STUB	1
 83
 84struct btrfs_trans_handle {
 85	u64 transid;
 86	u64 bytes_reserved;
 87	u64 qgroup_reserved;
 88	unsigned long use_count;
 89	unsigned long blocks_reserved;
 90	unsigned long blocks_used;
 91	unsigned long delayed_ref_updates;
 92	struct btrfs_transaction *transaction;
 93	struct btrfs_block_rsv *block_rsv;
 94	struct btrfs_block_rsv *orig_rsv;
 95	short aborted;
 96	short adding_csums;
 97	bool allocating_chunk;
 98	bool reloc_reserved;
 99	bool sync;
100	unsigned int type;
101	/*
102	 * this root is only needed to validate that the root passed to
103	 * start_transaction is the same as the one passed to end_transaction.
104	 * Subvolume quota depends on this
105	 */
106	struct btrfs_root *root;
107	struct seq_list delayed_ref_elem;
108	struct list_head qgroup_ref_list;
 
 
 
 
109	struct list_head new_bgs;
110};
111
 
 
 
 
 
 
 
 
112struct btrfs_pending_snapshot {
113	struct dentry *dentry;
114	struct inode *dir;
115	struct btrfs_root *root;
 
116	struct btrfs_root *snap;
117	struct btrfs_qgroup_inherit *inherit;
 
118	/* block reservation for the operation */
119	struct btrfs_block_rsv block_rsv;
120	u64 qgroup_reserved;
121	/* extra metadata reseration for relocation */
122	int error;
 
 
123	bool readonly;
124	struct list_head list;
125};
126
127static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
128					      struct inode *inode)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
129{
130	BTRFS_I(inode)->last_trans = trans->transaction->transid;
131	BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
132	BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
 
 
133}
134
135int btrfs_end_transaction(struct btrfs_trans_handle *trans,
136			  struct btrfs_root *root);
137struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
138						   int num_items);
139struct btrfs_trans_handle *btrfs_start_transaction_lflush(
140					struct btrfs_root *root, int num_items);
 
141struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
142struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
 
143struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
144struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
145					struct btrfs_root *root);
146struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
147int btrfs_wait_for_commit(struct btrfs_root *root, u64 transid);
148int btrfs_write_and_wait_transaction(struct btrfs_trans_handle *trans,
149				     struct btrfs_root *root);
150
151void btrfs_add_dead_root(struct btrfs_root *root);
152int btrfs_defrag_root(struct btrfs_root *root);
153int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
154int btrfs_commit_transaction(struct btrfs_trans_handle *trans,
155			     struct btrfs_root *root);
156int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
157				   struct btrfs_root *root,
158				   int wait_for_unblock);
159int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans,
160				   struct btrfs_root *root);
161int btrfs_should_end_transaction(struct btrfs_trans_handle *trans,
162				 struct btrfs_root *root);
163void btrfs_throttle(struct btrfs_root *root);
164int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
165				struct btrfs_root *root);
166int btrfs_write_marked_extents(struct btrfs_root *root,
167				struct extent_io_tree *dirty_pages, int mark);
168int btrfs_wait_marked_extents(struct btrfs_root *root,
169				struct extent_io_tree *dirty_pages, int mark);
 
170int btrfs_transaction_blocked(struct btrfs_fs_info *info);
171int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
172void btrfs_put_transaction(struct btrfs_transaction *transaction);
 
 
 
 
 
 
 
173#endif

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Copyright (C) 2007 Oracle.  All rights reserved.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  4 */
  5
  6#ifndef BTRFS_TRANSACTION_H
  7#define BTRFS_TRANSACTION_H
  8
  9#include <linux/refcount.h>
 10#include "btrfs_inode.h"
 11#include "delayed-ref.h"
 12#include "ctree.h"
 13#include "misc.h"
 14
 15enum btrfs_trans_state {
 16	TRANS_STATE_RUNNING,
 17	TRANS_STATE_COMMIT_START,
 18	TRANS_STATE_COMMIT_DOING,
 19	TRANS_STATE_UNBLOCKED,
 20	TRANS_STATE_SUPER_COMMITTED,
 21	TRANS_STATE_COMPLETED,
 22	TRANS_STATE_MAX,
 23};
 24
 25#define BTRFS_TRANS_HAVE_FREE_BGS	0
 26#define BTRFS_TRANS_DIRTY_BG_RUN	1
 27#define BTRFS_TRANS_CACHE_ENOSPC	2
 28
 29struct btrfs_transaction {
 30	u64 transid;
 31	/*
 32	 * total external writers(USERSPACE/START/ATTACH) in this
 33	 * transaction, it must be zero before the transaction is
 34	 * being committed
 35	 */
 36	atomic_t num_extwriters;
 37	/*
 38	 * total writers in this transaction, it must be zero before the
 39	 * transaction can end
 40	 */
 41	atomic_t num_writers;
 42	refcount_t use_count;
 43
 44	unsigned long flags;
 45
 46	/* Be protected by fs_info->trans_lock when we want to change it. */
 47	enum btrfs_trans_state state;
 48	int aborted;
 49	struct list_head list;
 50	struct extent_io_tree dirty_pages;
 51	time64_t start_time;
 52	wait_queue_head_t writer_wait;
 53	wait_queue_head_t commit_wait;
 54	struct list_head pending_snapshots;
 55	struct list_head dev_update_list;
 
 56	struct list_head switch_commits;
 57	struct list_head dirty_bgs;
 58
 59	/*
 60	 * There is no explicit lock which protects io_bgs, rather its
 61	 * consistency is implied by the fact that all the sites which modify
 62	 * it do so under some form of transaction critical section, namely:
 63	 *
 64	 * - btrfs_start_dirty_block_groups - This function can only ever be
 65	 *   run by one of the transaction committers. Refer to
 66	 *   BTRFS_TRANS_DIRTY_BG_RUN usage in btrfs_commit_transaction
 67	 *
 68	 * - btrfs_write_dirty_blockgroups - this is called by
 69	 *   commit_cowonly_roots from transaction critical section
 70	 *   (TRANS_STATE_COMMIT_DOING)
 71	 *
 72	 * - btrfs_cleanup_dirty_bgs - called on transaction abort
 73	 */
 74	struct list_head io_bgs;
 75	struct list_head dropped_roots;
 76	struct extent_io_tree pinned_extents;
 77
 78	/*
 79	 * we need to make sure block group deletion doesn't race with
 80	 * free space cache writeout.  This mutex keeps them from stomping
 81	 * on each other
 82	 */
 83	struct mutex cache_write_mutex;
 84	spinlock_t dirty_bgs_lock;
 85	/* Protected by spin lock fs_info->unused_bgs_lock. */
 86	struct list_head deleted_bgs;
 87	spinlock_t dropped_roots_lock;
 88	struct btrfs_delayed_ref_root delayed_refs;
 89	struct btrfs_fs_info *fs_info;
 
 90
 91	/*
 92	 * Number of ordered extents the transaction must wait for before
 93	 * committing. These are ordered extents started by a fast fsync.
 94	 */
 95	atomic_t pending_ordered;
 96	wait_queue_head_t pending_wait;
 97
 98	spinlock_t releasing_ebs_lock;
 99	struct list_head releasing_ebs;
100};
101
102enum {
103	ENUM_BIT(__TRANS_FREEZABLE),
104	ENUM_BIT(__TRANS_START),
105	ENUM_BIT(__TRANS_ATTACH),
106	ENUM_BIT(__TRANS_JOIN),
107	ENUM_BIT(__TRANS_JOIN_NOLOCK),
108	ENUM_BIT(__TRANS_DUMMY),
109	ENUM_BIT(__TRANS_JOIN_NOSTART),
110};
111
 
112#define TRANS_START		(__TRANS_START | __TRANS_FREEZABLE)
113#define TRANS_ATTACH		(__TRANS_ATTACH)
114#define TRANS_JOIN		(__TRANS_JOIN | __TRANS_FREEZABLE)
115#define TRANS_JOIN_NOLOCK	(__TRANS_JOIN_NOLOCK)
116#define TRANS_JOIN_NOSTART	(__TRANS_JOIN_NOSTART)
117
118#define TRANS_EXTWRITERS	(__TRANS_START | __TRANS_ATTACH)
 
 
 
119
120struct btrfs_trans_handle {
121	u64 transid;
122	u64 bytes_reserved;
123	u64 chunk_bytes_reserved;
 
 
 
124	unsigned long delayed_ref_updates;
125	struct btrfs_transaction *transaction;
126	struct btrfs_block_rsv *block_rsv;
127	struct btrfs_block_rsv *orig_rsv;
128	/* Set by a task that wants to create a snapshot. */
129	struct btrfs_pending_snapshot *pending_snapshot;
130	refcount_t use_count;
 
 
131	unsigned int type;
132	/*
133	 * Error code of transaction abort, set outside of locks and must use
134	 * the READ_ONCE/WRITE_ONCE access
 
135	 */
136	short aborted;
137	bool adding_csums;
138	bool allocating_chunk;
139	bool removing_chunk;
140	bool reloc_reserved;
141	bool in_fsync;
142	struct btrfs_fs_info *fs_info;
143	struct list_head new_bgs;
144};
145
146/*
147 * The abort status can be changed between calls and is not protected by locks.
148 * This accepts btrfs_transaction and btrfs_trans_handle as types. Once it's
149 * set to a non-zero value it does not change, so the macro should be in checks
150 * but is not necessary for further reads of the value.
151 */
152#define TRANS_ABORTED(trans)		(unlikely(READ_ONCE((trans)->aborted)))
153
154struct btrfs_pending_snapshot {
155	struct dentry *dentry;
156	struct inode *dir;
157	struct btrfs_root *root;
158	struct btrfs_root_item *root_item;
159	struct btrfs_root *snap;
160	struct btrfs_qgroup_inherit *inherit;
161	struct btrfs_path *path;
162	/* block reservation for the operation */
163	struct btrfs_block_rsv block_rsv;
164	/* extra metadata reservation for relocation */
 
165	int error;
166	/* Preallocated anonymous block device number */
167	dev_t anon_dev;
168	bool readonly;
169	struct list_head list;
170};
171
172static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
173					      struct btrfs_inode *inode)
174{
175	spin_lock(&inode->lock);
176	inode->last_trans = trans->transaction->transid;
177	inode->last_sub_trans = inode->root->log_transid;
178	inode->last_log_commit = inode->last_sub_trans - 1;
179	spin_unlock(&inode->lock);
180}
181
182/*
183 * Make qgroup codes to skip given qgroupid, means the old/new_roots for
184 * qgroup won't contain the qgroupid in it.
185 */
186static inline void btrfs_set_skip_qgroup(struct btrfs_trans_handle *trans,
187					 u64 qgroupid)
188{
189	struct btrfs_delayed_ref_root *delayed_refs;
190
191	delayed_refs = &trans->transaction->delayed_refs;
192	WARN_ON(delayed_refs->qgroup_to_skip);
193	delayed_refs->qgroup_to_skip = qgroupid;
194}
195
196static inline void btrfs_clear_skip_qgroup(struct btrfs_trans_handle *trans)
197{
198	struct btrfs_delayed_ref_root *delayed_refs;
199
200	delayed_refs = &trans->transaction->delayed_refs;
201	WARN_ON(!delayed_refs->qgroup_to_skip);
202	delayed_refs->qgroup_to_skip = 0;
203}
204
205int btrfs_end_transaction(struct btrfs_trans_handle *trans);
 
206struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
207						   unsigned int num_items);
208struct btrfs_trans_handle *btrfs_start_transaction_fallback_global_rsv(
209					struct btrfs_root *root,
210					unsigned int num_items);
211struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
212struct btrfs_trans_handle *btrfs_join_transaction_spacecache(struct btrfs_root *root);
213struct btrfs_trans_handle *btrfs_join_transaction_nostart(struct btrfs_root *root);
214struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
215struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
216					struct btrfs_root *root);
217int btrfs_wait_for_commit(struct btrfs_fs_info *fs_info, u64 transid);
 
 
 
218
219void btrfs_add_dead_root(struct btrfs_root *root);
220int btrfs_defrag_root(struct btrfs_root *root);
221void btrfs_maybe_wake_unfinished_drop(struct btrfs_fs_info *fs_info);
222int btrfs_clean_one_deleted_snapshot(struct btrfs_fs_info *fs_info);
223int btrfs_commit_transaction(struct btrfs_trans_handle *trans);
224void btrfs_commit_transaction_async(struct btrfs_trans_handle *trans);
225int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans);
226bool btrfs_should_end_transaction(struct btrfs_trans_handle *trans);
227void btrfs_throttle(struct btrfs_fs_info *fs_info);
 
 
 
 
228int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
229				struct btrfs_root *root);
230int btrfs_write_marked_extents(struct btrfs_fs_info *fs_info,
 
 
231				struct extent_io_tree *dirty_pages, int mark);
232int btrfs_wait_tree_log_extents(struct btrfs_root *root, int mark);
233int btrfs_transaction_blocked(struct btrfs_fs_info *info);
234int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
235void btrfs_put_transaction(struct btrfs_transaction *transaction);
236void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
237			    struct btrfs_root *root);
238void btrfs_trans_release_chunk_metadata(struct btrfs_trans_handle *trans);
239
240int __init btrfs_transaction_init(void);
241void __cold btrfs_transaction_exit(void);
242
243#endif