[mirror_ubuntu-bionic-kernel.git] / fs / btrfs / transaction.h

/*
 * Copyright (C) 2007 Oracle.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License v2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */

#ifndef __BTRFS_TRANSACTION__
#define __BTRFS_TRANSACTION__
#include "btrfs_inode.h"
#include "delayed-ref.h"
#include "ctree.h"

enum btrfs_trans_state {
	TRANS_STATE_RUNNING		= 0,
	TRANS_STATE_BLOCKED		= 1,
	TRANS_STATE_COMMIT_START	= 2,
	TRANS_STATE_COMMIT_DOING	= 3,
	TRANS_STATE_UNBLOCKED		= 4,
	TRANS_STATE_COMPLETED		= 5,
	TRANS_STATE_MAX			= 6,
};

struct btrfs_transaction {
	u64 transid;
	/*
	 * total external writers(USERSPACE/START/ATTACH) in this
	 * transaction, it must be zero before the transaction is
	 * being committed
	 */
	atomic_t num_extwriters;
	/*
	 * total writers in this transaction, it must be zero before the
	 * transaction can end
	 */
	atomic_t num_writers;
	atomic_t use_count;

	/*
	 * true if there is free bgs operations in this transaction
	 */
	int have_free_bgs;

	/* Be protected by fs_info->trans_lock when we want to change it. */
	enum btrfs_trans_state state;
	struct list_head list;
	struct extent_io_tree dirty_pages;
	unsigned long start_time;
	wait_queue_head_t writer_wait;
	wait_queue_head_t commit_wait;
	struct list_head pending_snapshots;
	struct list_head pending_chunks;
	struct list_head pending_ordered;
	struct list_head switch_commits;
	struct list_head dirty_bgs;
	struct list_head io_bgs;
	struct list_head dropped_roots;
	u64 num_dirty_bgs;

	/*
	 * we need to make sure block group deletion doesn't race with
	 * free space cache writeout.  This mutex keeps them from stomping
	 * on each other
	 */
	struct mutex cache_write_mutex;
	spinlock_t dirty_bgs_lock;
	struct list_head deleted_bgs;
	spinlock_t deleted_bgs_lock;
	spinlock_t dropped_roots_lock;
	struct btrfs_delayed_ref_root delayed_refs;
	int aborted;
	int dirty_bg_run;
};

#define __TRANS_FREEZABLE	(1U << 0)

#define __TRANS_USERSPACE	(1U << 8)
#define __TRANS_START		(1U << 9)
#define __TRANS_ATTACH		(1U << 10)
#define __TRANS_JOIN		(1U << 11)
#define __TRANS_JOIN_NOLOCK	(1U << 12)
#define __TRANS_DUMMY		(1U << 13)

#define TRANS_USERSPACE		(__TRANS_USERSPACE | __TRANS_FREEZABLE)
#define TRANS_START		(__TRANS_START | __TRANS_FREEZABLE)
#define TRANS_ATTACH		(__TRANS_ATTACH)
#define TRANS_JOIN		(__TRANS_JOIN | __TRANS_FREEZABLE)
#define TRANS_JOIN_NOLOCK	(__TRANS_JOIN_NOLOCK)

#define TRANS_EXTWRITERS	(__TRANS_USERSPACE | __TRANS_START |	\
				 __TRANS_ATTACH)

#define BTRFS_SEND_TRANS_STUB	((void *)1)

struct btrfs_trans_handle {
	u64 transid;
	u64 bytes_reserved;
	u64 chunk_bytes_reserved;
	unsigned long use_count;
	unsigned long blocks_reserved;
	unsigned long blocks_used;
	unsigned long delayed_ref_updates;
	struct btrfs_transaction *transaction;
	struct btrfs_block_rsv *block_rsv;
	struct btrfs_block_rsv *orig_rsv;
	short aborted;
	short adding_csums;
	bool allocating_chunk;
	bool can_flush_pending_bgs;
	bool reloc_reserved;
	bool sync;
	unsigned int type;
	/*
	 * this root is only needed to validate that the root passed to
	 * start_transaction is the same as the one passed to end_transaction.
	 * Subvolume quota depends on this
	 */
	struct btrfs_root *root;
	struct seq_list delayed_ref_elem;
	struct list_head ordered;
	struct list_head qgroup_ref_list;
	struct list_head new_bgs;
};

struct btrfs_pending_snapshot {
	struct dentry *dentry;
	struct inode *dir;
	struct btrfs_root *root;
	struct btrfs_root *snap;
	struct btrfs_qgroup_inherit *inherit;
	/* block reservation for the operation */
	struct btrfs_block_rsv block_rsv;
	u64 qgroup_reserved;
	/* extra metadata reseration for relocation */
	int error;
	bool readonly;
	struct list_head list;
};

static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
					      struct inode *inode)
{
	spin_lock(&BTRFS_I(inode)->lock);
	BTRFS_I(inode)->last_trans = trans->transaction->transid;
	BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
	BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
	spin_unlock(&BTRFS_I(inode)->lock);
}

/*
 * Make qgroup codes to skip given qgroupid, means the old/new_roots for
 * qgroup won't contain the qgroupid in it.
 */
static inline void btrfs_set_skip_qgroup(struct btrfs_trans_handle *trans,
					 u64 qgroupid)
{
	struct btrfs_delayed_ref_root *delayed_refs;

	delayed_refs = &trans->transaction->delayed_refs;
	WARN_ON(delayed_refs->qgroup_to_skip);
	delayed_refs->qgroup_to_skip = qgroupid;
}

static inline void btrfs_clear_skip_qgroup(struct btrfs_trans_handle *trans)
{
	struct btrfs_delayed_ref_root *delayed_refs;

	delayed_refs = &trans->transaction->delayed_refs;
	WARN_ON(!delayed_refs->qgroup_to_skip);
	delayed_refs->qgroup_to_skip = 0;
}

int btrfs_end_transaction(struct btrfs_trans_handle *trans,
			  struct btrfs_root *root);
struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
						   unsigned int num_items);
struct btrfs_trans_handle *btrfs_start_transaction_lflush(
					struct btrfs_root *root,
					unsigned int num_items);
struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
					struct btrfs_root *root);
struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
int btrfs_wait_for_commit(struct btrfs_root *root, u64 transid);

void btrfs_add_dead_root(struct btrfs_root *root);
int btrfs_defrag_root(struct btrfs_root *root);
int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
int btrfs_commit_transaction(struct btrfs_trans_handle *trans,
			     struct btrfs_root *root);
int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
				   struct btrfs_root *root,
				   int wait_for_unblock);
int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans,
				   struct btrfs_root *root);
int btrfs_should_end_transaction(struct btrfs_trans_handle *trans,
				 struct btrfs_root *root);
void btrfs_throttle(struct btrfs_root *root);
int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
				struct btrfs_root *root);
int btrfs_write_marked_extents(struct btrfs_root *root,
				struct extent_io_tree *dirty_pages, int mark);
int btrfs_wait_marked_extents(struct btrfs_root *root,
				struct extent_io_tree *dirty_pages, int mark);
int btrfs_transaction_blocked(struct btrfs_fs_info *info);
int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
void btrfs_put_transaction(struct btrfs_transaction *transaction);
void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
			    struct btrfs_root *root);
#endif
Commit	Line	Data
6cbd5570 CM	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
dc17ff8f CM	19	#ifndef __BTRFS_TRANSACTION__
dc17ff8f CM	20	#define __BTRFS_TRANSACTION__
31f3c99b	21	#include "btrfs_inode.h"
56bec294	22	#include "delayed-ref.h"
bed92eae	23	#include "ctree.h"
e089f05c	24
4a9d8bde MX	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
79154b1b CM	35	struct btrfs_transaction {
79154b1b CM	36	u64 transid;
0860adfd MX	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;
b7ec40d7 CM	43	/*
	44	* total writers in this transaction, it must be zero before the
	45	* transaction can end
	46	*/
13c5a93e	47	atomic_t num_writers;
a4abeea4	48	atomic_t use_count;
b7ec40d7	49
13212b54 ZL	50	/*
	51	* true if there is free bgs operations in this transaction
	52	*/
	53	int have_free_bgs;
	54
4a9d8bde MX	55	/* Be protected by fs_info->trans_lock when we want to change it. */
4a9d8bde MX	56	enum btrfs_trans_state state;
8fd17795	57	struct list_head list;
d1310b2e	58	struct extent_io_tree dirty_pages;
08607c1b	59	unsigned long start_time;
79154b1b CM	60	wait_queue_head_t writer_wait;
79154b1b CM	61	wait_queue_head_t commit_wait;
3063d29f	62	struct list_head pending_snapshots;
6df9a95e	63	struct list_head pending_chunks;
50d9aa99	64	struct list_head pending_ordered;
9e351cc8	65	struct list_head switch_commits;
ce93ec54	66	struct list_head dirty_bgs;
1bbc621e	67	struct list_head io_bgs;
2b9dbef2	68	struct list_head dropped_roots;
cb723e49	69	u64 num_dirty_bgs;
1bbc621e CM	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;
ce93ec54	77	spinlock_t dirty_bgs_lock;
e33e17ee JM	78	struct list_head deleted_bgs;
e33e17ee JM	79	spinlock_t deleted_bgs_lock;
2b9dbef2	80	spinlock_t dropped_roots_lock;
56bec294	81	struct btrfs_delayed_ref_root delayed_refs;
49b25e05	82	int aborted;
1bbc621e	83	int dirty_bg_run;
79154b1b CM	84	};
79154b1b CM	85
0860adfd MX	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)
faa2dbf0	93	#define __TRANS_DUMMY (1U << 13)
0860adfd MX	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)
a698d075	103
2755a0de	104	#define BTRFS_SEND_TRANS_STUB ((void *)1)
a26e8c9f	105
e089f05c CM	106	struct btrfs_trans_handle {
e089f05c CM	107	u64 transid;
f0486c68	108	u64 bytes_reserved;
4fbcdf66	109	u64 chunk_bytes_reserved;
2a1eb461	110	unsigned long use_count;
e089f05c CM	111	unsigned long blocks_reserved;
e089f05c CM	112	unsigned long blocks_used;
56bec294	113	unsigned long delayed_ref_updates;
f0486c68 YZ	114	struct btrfs_transaction *transaction;
f0486c68 YZ	115	struct btrfs_block_rsv *block_rsv;
2a1eb461	116	struct btrfs_block_rsv *orig_rsv;
a698d075 MX	117	short aborted;
a698d075 MX	118	short adding_csums;
c6b305a8	119	bool allocating_chunk;
d9a0540a	120	bool can_flush_pending_bgs;
20dd2cbf	121	bool reloc_reserved;
5039eddc	122	bool sync;
0860adfd	123	unsigned int type;
d13603ef AJ	124	/*
	125	* this root is only needed to validate that the root passed to
	126	* start_transaction is the same as the one passed to end_transaction.
	127	* Subvolume quota depends on this
	128	*/
	129	struct btrfs_root *root;
bed92eae	130	struct seq_list delayed_ref_elem;
50d9aa99	131	struct list_head ordered;
bed92eae	132	struct list_head qgroup_ref_list;
ea658bad	133	struct list_head new_bgs;
e089f05c CM	134	};
e089f05c CM	135
3063d29f	136	struct btrfs_pending_snapshot {
3de4586c	137	struct dentry *dentry;
e9662f70	138	struct inode *dir;
3063d29f	139	struct btrfs_root *root;
a22285a6	140	struct btrfs_root *snap;
6f72c7e2	141	struct btrfs_qgroup_inherit *inherit;
a22285a6 YZ	142	/* block reservation for the operation */
a22285a6 YZ	143	struct btrfs_block_rsv block_rsv;
d5c12070	144	u64 qgroup_reserved;
a22285a6 YZ	145	/* extra metadata reseration for relocation */
a22285a6 YZ	146	int error;
b83cc969	147	bool readonly;
3063d29f CM	148	struct list_head list;
	149	};
	150
15ee9bc7 JB	151	static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
	152	struct inode *inode)
	153	{
2f2ff0ee	154	spin_lock(&BTRFS_I(inode)->lock);
15ee9bc7	155	BTRFS_I(inode)->last_trans = trans->transaction->transid;
257c62e1	156	BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
46d8bc34	157	BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
2f2ff0ee	158	spin_unlock(&BTRFS_I(inode)->lock);
15ee9bc7 JB	159	}
15ee9bc7 JB	160
9086db86 QW	161	/*
	162	* Make qgroup codes to skip given qgroupid, means the old/new_roots for
	163	* qgroup won't contain the qgroupid in it.
	164	*/
	165	static inline void btrfs_set_skip_qgroup(struct btrfs_trans_handle *trans,
	166	u64 qgroupid)
	167	{
	168	struct btrfs_delayed_ref_root *delayed_refs;
	169
	170	delayed_refs = &trans->transaction->delayed_refs;
	171	WARN_ON(delayed_refs->qgroup_to_skip);
	172	delayed_refs->qgroup_to_skip = qgroupid;
	173	}
	174
	175	static inline void btrfs_clear_skip_qgroup(struct btrfs_trans_handle *trans)
	176	{
	177	struct btrfs_delayed_ref_root *delayed_refs;
	178
	179	delayed_refs = &trans->transaction->delayed_refs;
	180	WARN_ON(!delayed_refs->qgroup_to_skip);
	181	delayed_refs->qgroup_to_skip = 0;
	182	}
	183
79154b1b CM	184	int btrfs_end_transaction(struct btrfs_trans_handle *trans,
	185	struct btrfs_root *root);
	186	struct btrfs_trans_handle btrfs_start_transaction(struct btrfs_root root,
5aed1dd8	187	unsigned int num_items);
08e007d2	188	struct btrfs_trans_handle *btrfs_start_transaction_lflush(
5aed1dd8 AM	189	struct btrfs_root *root,
5aed1dd8 AM	190	unsigned int num_items);
7a7eaa40 JB	191	struct btrfs_trans_handle btrfs_join_transaction(struct btrfs_root root);
7a7eaa40 JB	192	struct btrfs_trans_handle btrfs_join_transaction_nolock(struct btrfs_root root);
354aa0fb	193	struct btrfs_trans_handle btrfs_attach_transaction(struct btrfs_root root);
d4edf39b MX	194	struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
d4edf39b MX	195	struct btrfs_root *root);
7a7eaa40	196	struct btrfs_trans_handle btrfs_start_ioctl_transaction(struct btrfs_root root);
46204592	197	int btrfs_wait_for_commit(struct btrfs_root *root, u64 transid);
08607c1b	198
cfad392b	199	void btrfs_add_dead_root(struct btrfs_root *root);
de78b51a	200	int btrfs_defrag_root(struct btrfs_root *root);
9d1a2a3a	201	int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
5f39d397 CM	202	int btrfs_commit_transaction(struct btrfs_trans_handle *trans,
5f39d397 CM	203	struct btrfs_root *root);
bb9c12c9 SW	204	int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
	205	struct btrfs_root *root,
	206	int wait_for_unblock);
89ce8a63 CM	207	int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans,
89ce8a63 CM	208	struct btrfs_root *root);
8929ecfa YZ	209	int btrfs_should_end_transaction(struct btrfs_trans_handle *trans,
8929ecfa YZ	210	struct btrfs_root *root);
ab78c84d	211	void btrfs_throttle(struct btrfs_root *root);
5d4f98a2 YZ	212	int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
5d4f98a2 YZ	213	struct btrfs_root *root);
690587d1	214	int btrfs_write_marked_extents(struct btrfs_root *root,
8cef4e16	215	struct extent_io_tree *dirty_pages, int mark);
690587d1	216	int btrfs_wait_marked_extents(struct btrfs_root *root,
8cef4e16	217	struct extent_io_tree *dirty_pages, int mark);
8929ecfa	218	int btrfs_transaction_blocked(struct btrfs_fs_info *info);
f36f3042	219	int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
724e2315	220	void btrfs_put_transaction(struct btrfs_transaction *transaction);
572d9ab7	221	void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
2b9dbef2 JB	222	void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
2b9dbef2 JB	223	struct btrfs_root *root);
e089f05c	224	#endif