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

/*
 * Copyright (C) 2008 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 __DELAYED_REF__
#define __DELAYED_REF__

/* these are the possible values of struct btrfs_delayed_ref_node->action */
#define BTRFS_ADD_DELAYED_REF    1 /* add one backref to the tree */
#define BTRFS_DROP_DELAYED_REF   2 /* delete one backref from the tree */
#define BTRFS_ADD_DELAYED_EXTENT 3 /* record a full extent allocation */
#define BTRFS_UPDATE_DELAYED_HEAD 4 /* not changing ref count on head ref */

/*
 * XXX: Qu: I really hate the design that ref_head and tree/data ref shares the
 * same ref_node structure.
 * Ref_head is in a higher logic level than tree/data ref, and duplicated
 * bytenr/num_bytes in ref_node is really a waste or memory, they should be
 * referred from ref_head.
 * This gets more disgusting after we use list to store tree/data ref in
 * ref_head. Must clean this mess up later.
 */
struct btrfs_delayed_ref_node {
	/*
	 * ref_head use rb tree, stored in ref_root->href.
	 * indexed by bytenr
	 */
	struct rb_node rb_node;

	/*data/tree ref use list, stored in ref_head->ref_list. */
	struct list_head list;

	/* the starting bytenr of the extent */
	u64 bytenr;

	/* the size of the extent */
	u64 num_bytes;

	/* seq number to keep track of insertion order */
	u64 seq;

	/* ref count on this data structure */
	atomic_t refs;

	/*
	 * how many refs is this entry adding or deleting.  For
	 * head refs, this may be a negative number because it is keeping
	 * track of the total mods done to the reference count.
	 * For individual refs, this will always be a positive number
	 *
	 * It may be more than one, since it is possible for a single
	 * parent to have more than one ref on an extent
	 */
	int ref_mod;

	unsigned int action:8;
	unsigned int type:8;
	unsigned int no_quota:1;
	/* is this node still in the rbtree? */
	unsigned int is_head:1;
	unsigned int in_tree:1;
};

struct btrfs_delayed_extent_op {
	struct btrfs_disk_key key;
	u64 flags_to_set;
	int level;
	unsigned int update_key:1;
	unsigned int update_flags:1;
	unsigned int is_data:1;
};

/*
 * the head refs are used to hold a lock on a given extent, which allows us
 * to make sure that only one process is running the delayed refs
 * at a time for a single extent.  They also store the sum of all the
 * reference count modifications we've queued up.
 */
struct btrfs_delayed_ref_head {
	struct btrfs_delayed_ref_node node;

	/*
	 * the mutex is held while running the refs, and it is also
	 * held when checking the sum of reference modifications.
	 */
	struct mutex mutex;

	spinlock_t lock;
	struct list_head ref_list;

	struct rb_node href_node;

	struct btrfs_delayed_extent_op *extent_op;

	/*
	 * This is used to track the final ref_mod from all the refs associated
	 * with this head ref, this is not adjusted as delayed refs are run,
	 * this is meant to track if we need to do the csum accounting or not.
	 */
	int total_ref_mod;

	/*
	 * when a new extent is allocated, it is just reserved in memory
	 * The actual extent isn't inserted into the extent allocation tree
	 * until the delayed ref is processed.  must_insert_reserved is
	 * used to flag a delayed ref so the accounting can be updated
	 * when a full insert is done.
	 *
	 * It is possible the extent will be freed before it is ever
	 * inserted into the extent allocation tree.  In this case
	 * we need to update the in ram accounting to properly reflect
	 * the free has happened.
	 */
	unsigned int must_insert_reserved:1;
	unsigned int is_data:1;
	unsigned int processing:1;
};

struct btrfs_delayed_tree_ref {
	struct btrfs_delayed_ref_node node;
	u64 root;
	u64 parent;
	int level;
};

struct btrfs_delayed_data_ref {
	struct btrfs_delayed_ref_node node;
	u64 root;
	u64 parent;
	u64 objectid;
	u64 offset;
};

struct btrfs_delayed_ref_root {
	/* head ref rbtree */
	struct rb_root href_root;

	/* dirty extent records */
	struct rb_root dirty_extent_root;

	/* this spin lock protects the rbtree and the entries inside */
	spinlock_t lock;

	/* how many delayed ref updates we've queued, used by the
	 * throttling code
	 */
	atomic_t num_entries;

	/* total number of head nodes in tree */
	unsigned long num_heads;

	/* total number of head nodes ready for processing */
	unsigned long num_heads_ready;

	u64 pending_csums;

	/*
	 * set when the tree is flushing before a transaction commit,
	 * used by the throttling code to decide if new updates need
	 * to be run right away
	 */
	int flushing;

	u64 run_delayed_start;

	/*
	 * To make qgroup to skip given root.
	 * This is for snapshot, as btrfs_qgroup_inherit() will manully
	 * modify counters for snapshot and its source, so we should skip
	 * the snapshot in new_root/old_roots or it will get calculated twice
	 */
	u64 qgroup_to_skip;
};

extern struct kmem_cache *btrfs_delayed_ref_head_cachep;
extern struct kmem_cache *btrfs_delayed_tree_ref_cachep;
extern struct kmem_cache *btrfs_delayed_data_ref_cachep;
extern struct kmem_cache *btrfs_delayed_extent_op_cachep;

int btrfs_delayed_ref_init(void);
void btrfs_delayed_ref_exit(void);

static inline struct btrfs_delayed_extent_op *
btrfs_alloc_delayed_extent_op(void)
{
	return kmem_cache_alloc(btrfs_delayed_extent_op_cachep, GFP_NOFS);
}

static inline void
btrfs_free_delayed_extent_op(struct btrfs_delayed_extent_op *op)
{
	if (op)
		kmem_cache_free(btrfs_delayed_extent_op_cachep, op);
}

static inline void btrfs_put_delayed_ref(struct btrfs_delayed_ref_node *ref)
{
	WARN_ON(atomic_read(&ref->refs) == 0);
	if (atomic_dec_and_test(&ref->refs)) {
		WARN_ON(ref->in_tree);
		switch (ref->type) {
		case BTRFS_TREE_BLOCK_REF_KEY:
		case BTRFS_SHARED_BLOCK_REF_KEY:
			kmem_cache_free(btrfs_delayed_tree_ref_cachep, ref);
			break;
		case BTRFS_EXTENT_DATA_REF_KEY:
		case BTRFS_SHARED_DATA_REF_KEY:
			kmem_cache_free(btrfs_delayed_data_ref_cachep, ref);
			break;
		case 0:
			kmem_cache_free(btrfs_delayed_ref_head_cachep, ref);
			break;
		default:
			BUG();
		}
	}
}

int btrfs_add_delayed_tree_ref(struct btrfs_fs_info *fs_info,
			       struct btrfs_trans_handle *trans,
			       u64 bytenr, u64 num_bytes, u64 parent,
			       u64 ref_root, int level, int action,
			       struct btrfs_delayed_extent_op *extent_op,
			       int no_quota);
int btrfs_add_delayed_data_ref(struct btrfs_fs_info *fs_info,
			       struct btrfs_trans_handle *trans,
			       u64 bytenr, u64 num_bytes,
			       u64 parent, u64 ref_root,
			       u64 owner, u64 offset, int action,
			       struct btrfs_delayed_extent_op *extent_op,
			       int no_quota);
int btrfs_add_delayed_extent_op(struct btrfs_fs_info *fs_info,
				struct btrfs_trans_handle *trans,
				u64 bytenr, u64 num_bytes,
				struct btrfs_delayed_extent_op *extent_op);
void btrfs_merge_delayed_refs(struct btrfs_trans_handle *trans,
			      struct btrfs_fs_info *fs_info,
			      struct btrfs_delayed_ref_root *delayed_refs,
			      struct btrfs_delayed_ref_head *head);

struct btrfs_delayed_ref_head *
btrfs_find_delayed_ref_head(struct btrfs_trans_handle *trans, u64 bytenr);
int btrfs_delayed_ref_lock(struct btrfs_trans_handle *trans,
			   struct btrfs_delayed_ref_head *head);
static inline void btrfs_delayed_ref_unlock(struct btrfs_delayed_ref_head *head)
{
	mutex_unlock(&head->mutex);
}


struct btrfs_delayed_ref_head *
btrfs_select_ref_head(struct btrfs_trans_handle *trans);

int btrfs_check_delayed_seq(struct btrfs_fs_info *fs_info,
			    struct btrfs_delayed_ref_root *delayed_refs,
			    u64 seq);

/*
 * a node might live in a head or a regular ref, this lets you
 * test for the proper type to use.
 */
static int btrfs_delayed_ref_is_head(struct btrfs_delayed_ref_node *node)
{
	return node->is_head;
}

/*
 * helper functions to cast a node into its container
 */
static inline struct btrfs_delayed_tree_ref *
btrfs_delayed_node_to_tree_ref(struct btrfs_delayed_ref_node *node)
{
	WARN_ON(btrfs_delayed_ref_is_head(node));
	return container_of(node, struct btrfs_delayed_tree_ref, node);
}

static inline struct btrfs_delayed_data_ref *
btrfs_delayed_node_to_data_ref(struct btrfs_delayed_ref_node *node)
{
	WARN_ON(btrfs_delayed_ref_is_head(node));
	return container_of(node, struct btrfs_delayed_data_ref, node);
}

static inline struct btrfs_delayed_ref_head *
btrfs_delayed_node_to_head(struct btrfs_delayed_ref_node *node)
{
	WARN_ON(!btrfs_delayed_ref_is_head(node));
	return container_of(node, struct btrfs_delayed_ref_head, node);
}
#endif
Commit	Line	Data
56bec294 CM	1	/*
	2	* Copyright (C) 2008 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	#ifndef __DELAYED_REF__
	19	#define __DELAYED_REF__
	20
44a075bd	21	/* these are the possible values of struct btrfs_delayed_ref_node->action */
56bec294 CM	22	#define BTRFS_ADD_DELAYED_REF 1 /* add one backref to the tree */
	23	#define BTRFS_DROP_DELAYED_REF 2 /* delete one backref from the tree */
	24	#define BTRFS_ADD_DELAYED_EXTENT 3 /* record a full extent allocation */
1a81af4d	25	#define BTRFS_UPDATE_DELAYED_HEAD 4 /* not changing ref count on head ref */
56bec294	26
c6fc2454 QW	27	/*
	28	* XXX: Qu: I really hate the design that ref_head and tree/data ref shares the
	29	* same ref_node structure.
	30	* Ref_head is in a higher logic level than tree/data ref, and duplicated
	31	* bytenr/num_bytes in ref_node is really a waste or memory, they should be
	32	* referred from ref_head.
	33	* This gets more disgusting after we use list to store tree/data ref in
	34	* ref_head. Must clean this mess up later.
	35	*/
56bec294	36	struct btrfs_delayed_ref_node {
c6fc2454 QW	37	/*
	38	* ref_head use rb tree, stored in ref_root->href.
	39	* indexed by bytenr
	40	*/
56bec294 CM	41	struct rb_node rb_node;
56bec294 CM	42
c6fc2454 QW	43	/data/tree ref use list, stored in ref_head->ref_list. /
	44	struct list_head list;
	45
56bec294 CM	46	/* the starting bytenr of the extent */
	47	u64 bytenr;
	48
56bec294 CM	49	/* the size of the extent */
	50	u64 num_bytes;
	51
00f04b88 AJ	52	/* seq number to keep track of insertion order */
	53	u64 seq;
	54
56bec294 CM	55	/* ref count on this data structure */
	56	atomic_t refs;
	57
	58	/*
	59	* how many refs is this entry adding or deleting. For
	60	* head refs, this may be a negative number because it is keeping
	61	* track of the total mods done to the reference count.
	62	* For individual refs, this will always be a positive number
	63	*
	64	* It may be more than one, since it is possible for a single
	65	* parent to have more than one ref on an extent
	66	*/
	67	int ref_mod;
	68
5d4f98a2 YZ	69	unsigned int action:8;
5d4f98a2 YZ	70	unsigned int type:8;
fcebe456	71	unsigned int no_quota:1;
56bec294	72	/* is this node still in the rbtree? */
5d4f98a2	73	unsigned int is_head:1;
56bec294 CM	74	unsigned int in_tree:1;
	75	};
	76
5d4f98a2 YZ	77	struct btrfs_delayed_extent_op {
	78	struct btrfs_disk_key key;
	79	u64 flags_to_set;
b1c79e09	80	int level;
5d4f98a2 YZ	81	unsigned int update_key:1;
	82	unsigned int update_flags:1;
	83	unsigned int is_data:1;
	84	};
	85
56bec294 CM	86	/*
	87	* the head refs are used to hold a lock on a given extent, which allows us
	88	* to make sure that only one process is running the delayed refs
	89	* at a time for a single extent. They also store the sum of all the
	90	* reference count modifications we've queued up.
	91	*/
	92	struct btrfs_delayed_ref_head {
	93	struct btrfs_delayed_ref_node node;
	94
	95	/*
	96	* the mutex is held while running the refs, and it is also
	97	* held when checking the sum of reference modifications.
	98	*/
	99	struct mutex mutex;
	100
d7df2c79	101	spinlock_t lock;
c6fc2454	102	struct list_head ref_list;
c3e69d58	103
c46effa6 LB	104	struct rb_node href_node;
c46effa6 LB	105
5d4f98a2	106	struct btrfs_delayed_extent_op *extent_op;
1262133b JB	107
	108	/*
	109	* This is used to track the final ref_mod from all the refs associated
	110	* with this head ref, this is not adjusted as delayed refs are run,
	111	* this is meant to track if we need to do the csum accounting or not.
	112	*/
	113	int total_ref_mod;
	114
56bec294 CM	115	/*
	116	* when a new extent is allocated, it is just reserved in memory
	117	* The actual extent isn't inserted into the extent allocation tree
	118	* until the delayed ref is processed. must_insert_reserved is
	119	* used to flag a delayed ref so the accounting can be updated
	120	* when a full insert is done.
	121	*
	122	* It is possible the extent will be freed before it is ever
	123	* inserted into the extent allocation tree. In this case
	124	* we need to update the in ram accounting to properly reflect
	125	* the free has happened.
	126	*/
	127	unsigned int must_insert_reserved:1;
5d4f98a2	128	unsigned int is_data:1;
d7df2c79	129	unsigned int processing:1;
56bec294 CM	130	};
56bec294 CM	131
5d4f98a2	132	struct btrfs_delayed_tree_ref {
56bec294	133	struct btrfs_delayed_ref_node node;
eebe063b AJ	134	u64 root;
eebe063b AJ	135	u64 parent;
5d4f98a2 YZ	136	int level;
5d4f98a2 YZ	137	};
56bec294	138
5d4f98a2 YZ	139	struct btrfs_delayed_data_ref {
5d4f98a2 YZ	140	struct btrfs_delayed_ref_node node;
eebe063b AJ	141	u64 root;
eebe063b AJ	142	u64 parent;
5d4f98a2 YZ	143	u64 objectid;
5d4f98a2 YZ	144	u64 offset;
56bec294 CM	145	};
	146
	147	struct btrfs_delayed_ref_root {
c46effa6 LB	148	/* head ref rbtree */
	149	struct rb_root href_root;
	150
3368d001 QW	151	/* dirty extent records */
	152	struct rb_root dirty_extent_root;
	153
56bec294 CM	154	/* this spin lock protects the rbtree and the entries inside */
	155	spinlock_t lock;
	156
	157	/* how many delayed ref updates we've queued, used by the
	158	* throttling code
	159	*/
d7df2c79	160	atomic_t num_entries;
56bec294	161
c3e69d58 CM	162	/* total number of head nodes in tree */
	163	unsigned long num_heads;
	164
	165	/* total number of head nodes ready for processing */
	166	unsigned long num_heads_ready;
	167
1262133b JB	168	u64 pending_csums;
1262133b JB	169
56bec294 CM	170	/*
	171	* set when the tree is flushing before a transaction commit,
	172	* used by the throttling code to decide if new updates need
	173	* to be run right away
	174	*/
	175	int flushing;
c3e69d58 CM	176
c3e69d58 CM	177	u64 run_delayed_start;
9086db86 QW	178
	179	/*
	180	* To make qgroup to skip given root.
	181	* This is for snapshot, as btrfs_qgroup_inherit() will manully
	182	* modify counters for snapshot and its source, so we should skip
	183	* the snapshot in new_root/old_roots or it will get calculated twice
	184	*/
	185	u64 qgroup_to_skip;
56bec294 CM	186	};
56bec294 CM	187
78a6184a MX	188	extern struct kmem_cache *btrfs_delayed_ref_head_cachep;
	189	extern struct kmem_cache *btrfs_delayed_tree_ref_cachep;
	190	extern struct kmem_cache *btrfs_delayed_data_ref_cachep;
	191	extern struct kmem_cache *btrfs_delayed_extent_op_cachep;
	192
	193	int btrfs_delayed_ref_init(void);
	194	void btrfs_delayed_ref_exit(void);
	195
	196	static inline struct btrfs_delayed_extent_op *
	197	btrfs_alloc_delayed_extent_op(void)
	198	{
	199	return kmem_cache_alloc(btrfs_delayed_extent_op_cachep, GFP_NOFS);
	200	}
	201
	202	static inline void
	203	btrfs_free_delayed_extent_op(struct btrfs_delayed_extent_op *op)
	204	{
	205	if (op)
	206	kmem_cache_free(btrfs_delayed_extent_op_cachep, op);
	207	}
	208
56bec294 CM	209	static inline void btrfs_put_delayed_ref(struct btrfs_delayed_ref_node *ref)
	210	{
	211	WARN_ON(atomic_read(&ref->refs) == 0);
	212	if (atomic_dec_and_test(&ref->refs)) {
	213	WARN_ON(ref->in_tree);
78a6184a MX	214	switch (ref->type) {
	215	case BTRFS_TREE_BLOCK_REF_KEY:
	216	case BTRFS_SHARED_BLOCK_REF_KEY:
	217	kmem_cache_free(btrfs_delayed_tree_ref_cachep, ref);
	218	break;
	219	case BTRFS_EXTENT_DATA_REF_KEY:
	220	case BTRFS_SHARED_DATA_REF_KEY:
	221	kmem_cache_free(btrfs_delayed_data_ref_cachep, ref);
	222	break;
	223	case 0:
	224	kmem_cache_free(btrfs_delayed_ref_head_cachep, ref);
	225	break;
	226	default:
	227	BUG();
	228	}
56bec294 CM	229	}
	230	}
	231
66d7e7f0 AJ	232	int btrfs_add_delayed_tree_ref(struct btrfs_fs_info *fs_info,
66d7e7f0 AJ	233	struct btrfs_trans_handle *trans,
5d4f98a2 YZ	234	u64 bytenr, u64 num_bytes, u64 parent,
5d4f98a2 YZ	235	u64 ref_root, int level, int action,
66d7e7f0	236	struct btrfs_delayed_extent_op *extent_op,
fcebe456	237	int no_quota);
66d7e7f0 AJ	238	int btrfs_add_delayed_data_ref(struct btrfs_fs_info *fs_info,
66d7e7f0 AJ	239	struct btrfs_trans_handle *trans,
5d4f98a2 YZ	240	u64 bytenr, u64 num_bytes,
	241	u64 parent, u64 ref_root,
	242	u64 owner, u64 offset, int action,
66d7e7f0	243	struct btrfs_delayed_extent_op *extent_op,
fcebe456	244	int no_quota);
66d7e7f0 AJ	245	int btrfs_add_delayed_extent_op(struct btrfs_fs_info *fs_info,
66d7e7f0 AJ	246	struct btrfs_trans_handle *trans,
5d4f98a2 YZ	247	u64 bytenr, u64 num_bytes,
5d4f98a2 YZ	248	struct btrfs_delayed_extent_op *extent_op);
ae1e206b JB	249	void btrfs_merge_delayed_refs(struct btrfs_trans_handle *trans,
	250	struct btrfs_fs_info *fs_info,
	251	struct btrfs_delayed_ref_root *delayed_refs,
	252	struct btrfs_delayed_ref_head *head);
56bec294	253
1887be66 CM	254	struct btrfs_delayed_ref_head *
1887be66 CM	255	btrfs_find_delayed_ref_head(struct btrfs_trans_handle *trans, u64 bytenr);
c3e69d58 CM	256	int btrfs_delayed_ref_lock(struct btrfs_trans_handle *trans,
c3e69d58 CM	257	struct btrfs_delayed_ref_head *head);
093486c4 MX	258	static inline void btrfs_delayed_ref_unlock(struct btrfs_delayed_ref_head *head)
	259	{
	260	mutex_unlock(&head->mutex);
	261	}
	262
d7df2c79 JB	263
	264	struct btrfs_delayed_ref_head *
	265	btrfs_select_ref_head(struct btrfs_trans_handle *trans);
00f04b88	266
097b8a7c JS	267	int btrfs_check_delayed_seq(struct btrfs_fs_info *fs_info,
097b8a7c JS	268	struct btrfs_delayed_ref_root *delayed_refs,
00f04b88 AJ	269	u64 seq);
00f04b88 AJ	270
56bec294 CM	271	/*
	272	* a node might live in a head or a regular ref, this lets you
	273	* test for the proper type to use.
	274	*/
	275	static int btrfs_delayed_ref_is_head(struct btrfs_delayed_ref_node *node)
	276	{
5d4f98a2	277	return node->is_head;
56bec294 CM	278	}
	279
	280	/*
	281	* helper functions to cast a node into its container
	282	*/
5d4f98a2 YZ	283	static inline struct btrfs_delayed_tree_ref *
5d4f98a2 YZ	284	btrfs_delayed_node_to_tree_ref(struct btrfs_delayed_ref_node *node)
56bec294 CM	285	{
56bec294 CM	286	WARN_ON(btrfs_delayed_ref_is_head(node));
5d4f98a2 YZ	287	return container_of(node, struct btrfs_delayed_tree_ref, node);
5d4f98a2 YZ	288	}
56bec294	289
5d4f98a2 YZ	290	static inline struct btrfs_delayed_data_ref *
	291	btrfs_delayed_node_to_data_ref(struct btrfs_delayed_ref_node *node)
	292	{
	293	WARN_ON(btrfs_delayed_ref_is_head(node));
	294	return container_of(node, struct btrfs_delayed_data_ref, node);
56bec294 CM	295	}
	296
	297	static inline struct btrfs_delayed_ref_head *
	298	btrfs_delayed_node_to_head(struct btrfs_delayed_ref_node *node)
	299	{
	300	WARN_ON(!btrfs_delayed_ref_is_head(node));
	301	return container_of(node, struct btrfs_delayed_ref_head, node);
56bec294 CM	302	}
56bec294 CM	303	#endif