[deliverable/linux.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 */

struct btrfs_delayed_ref_node {
	struct rb_node rb_node;

	/* 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 rb_root ref_root;

	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;

	/* 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;
};

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