[mirror_ubuntu-hirsute-kernel.git] / fs / btrfs / qgroup.h

/*
 * Copyright (C) 2014 Facebook.  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_QGROUP__
#define __BTRFS_QGROUP__

#include "ulist.h"
#include "delayed-ref.h"

/*
 * Btrfs qgroup overview
 *
 * Btrfs qgroup splits into 3 main part:
 * 1) Reserve
 *    Reserve metadata/data space for incoming operations
 *    Affect how qgroup limit works
 *
 * 2) Trace
 *    Tell btrfs qgroup to trace dirty extents.
 *
 *    Dirty extents including:
 *    - Newly allocated extents
 *    - Extents going to be deleted (in this trans)
 *    - Extents whose owner is going to be modified
 *
 *    This is the main part affects whether qgroup numbers will stay
 *    consistent.
 *    Btrfs qgroup can trace clean extents and won't cause any problem,
 *    but it will consume extra CPU time, it should be avoided if possible.
 *
 * 3) Account
 *    Btrfs qgroup will updates its numbers, based on dirty extents traced
 *    in previous step.
 *
 *    Normally at qgroup rescan and transaction commit time.
 */

/*
 * Record a dirty extent, and info qgroup to update quota on it
 * TODO: Use kmem cache to alloc it.
 */
struct btrfs_qgroup_extent_record {
	struct rb_node node;
	u64 bytenr;
	u64 num_bytes;
	struct ulist *old_roots;
};

/*
 * For qgroup event trace points only
 */
#define QGROUP_RESERVE		(1<<0)
#define QGROUP_RELEASE		(1<<1)
#define QGROUP_FREE		(1<<2)

int btrfs_quota_enable(struct btrfs_trans_handle *trans,
		       struct btrfs_fs_info *fs_info);
int btrfs_quota_disable(struct btrfs_trans_handle *trans,
			struct btrfs_fs_info *fs_info);
int btrfs_qgroup_rescan(struct btrfs_fs_info *fs_info);
void btrfs_qgroup_rescan_resume(struct btrfs_fs_info *fs_info);
int btrfs_qgroup_wait_for_completion(struct btrfs_fs_info *fs_info,
				     bool interruptible);
int btrfs_add_qgroup_relation(struct btrfs_trans_handle *trans,
			      struct btrfs_fs_info *fs_info, u64 src, u64 dst);
int btrfs_del_qgroup_relation(struct btrfs_trans_handle *trans,
			      struct btrfs_fs_info *fs_info, u64 src, u64 dst);
int btrfs_create_qgroup(struct btrfs_trans_handle *trans,
			struct btrfs_fs_info *fs_info, u64 qgroupid);
int btrfs_remove_qgroup(struct btrfs_trans_handle *trans,
			      struct btrfs_fs_info *fs_info, u64 qgroupid);
int btrfs_limit_qgroup(struct btrfs_trans_handle *trans,
		       struct btrfs_fs_info *fs_info, u64 qgroupid,
		       struct btrfs_qgroup_limit *limit);
int btrfs_read_qgroup_config(struct btrfs_fs_info *fs_info);
void btrfs_free_qgroup_config(struct btrfs_fs_info *fs_info);
struct btrfs_delayed_extent_op;
int btrfs_qgroup_prepare_account_extents(struct btrfs_trans_handle *trans,
					 struct btrfs_fs_info *fs_info);
/*
 * Inform qgroup to trace one dirty extent, its info is recorded in @record.
 * So qgroup can account it at commit trans time.
 *
 * No lock version, caller must acquire delayed ref lock and allocate memory.
 *
 * Return 0 for success insert
 * Return >0 for existing record, caller can free @record safely.
 * Error is not possible
 */
int btrfs_qgroup_trace_extent_nolock(
		struct btrfs_fs_info *fs_info,
		struct btrfs_delayed_ref_root *delayed_refs,
		struct btrfs_qgroup_extent_record *record);

/*
 * Inform qgroup to trace one dirty extent, specified by @bytenr and
 * @num_bytes.
 * So qgroup can account it at commit trans time.
 *
 * Better encapsulated version.
 *
 * Return 0 if the operation is done.
 * Return <0 for error, like memory allocation failure or invalid parameter
 * (NULL trans)
 */
int btrfs_qgroup_trace_extent(struct btrfs_trans_handle *trans,
		struct btrfs_fs_info *fs_info, u64 bytenr, u64 num_bytes,
		gfp_t gfp_flag);

/*
 * Inform qgroup to trace all leaf items of data
 *
 * Return 0 for success
 * Return <0 for error(ENOMEM)
 */
int btrfs_qgroup_trace_leaf_items(struct btrfs_trans_handle *trans,
				  struct btrfs_fs_info *fs_info,
				  struct extent_buffer *eb);
/*
 * Inform qgroup to trace a whole subtree, including all its child tree
 * blocks and data.
 * The root tree block is specified by @root_eb.
 *
 * Normally used by relocation(tree block swap) and subvolume deletion.
 *
 * Return 0 for success
 * Return <0 for error(ENOMEM or tree search error)
 */
int btrfs_qgroup_trace_subtree(struct btrfs_trans_handle *trans,
			       struct btrfs_root *root,
			       struct extent_buffer *root_eb,
			       u64 root_gen, int root_level);
int
btrfs_qgroup_account_extent(struct btrfs_trans_handle *trans,
			    struct btrfs_fs_info *fs_info,
			    u64 bytenr, u64 num_bytes,
			    struct ulist *old_roots, struct ulist *new_roots);
int btrfs_qgroup_account_extents(struct btrfs_trans_handle *trans,
				 struct btrfs_fs_info *fs_info);
int btrfs_run_qgroups(struct btrfs_trans_handle *trans,
		      struct btrfs_fs_info *fs_info);
int btrfs_qgroup_inherit(struct btrfs_trans_handle *trans,
			 struct btrfs_fs_info *fs_info, u64 srcid, u64 objectid,
			 struct btrfs_qgroup_inherit *inherit);
void btrfs_qgroup_free_refroot(struct btrfs_fs_info *fs_info,
			       u64 ref_root, u64 num_bytes);
/*
 * TODO: Add proper trace point for it, as btrfs_qgroup_free() is
 * called by everywhere, can't provide good trace for delayed ref case.
 */
static inline void btrfs_qgroup_free_delayed_ref(struct btrfs_fs_info *fs_info,
						 u64 ref_root, u64 num_bytes)
{
	btrfs_qgroup_free_refroot(fs_info, ref_root, num_bytes);
	trace_btrfs_qgroup_free_delayed_ref(fs_info, ref_root, num_bytes);
}
void assert_qgroups_uptodate(struct btrfs_trans_handle *trans);

#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
int btrfs_verify_qgroup_counts(struct btrfs_fs_info *fs_info, u64 qgroupid,
			       u64 rfer, u64 excl);
#endif

/* New io_tree based accurate qgroup reserve API */
int btrfs_qgroup_reserve_data(struct inode *inode, u64 start, u64 len);
int btrfs_qgroup_release_data(struct inode *inode, u64 start, u64 len);
int btrfs_qgroup_free_data(struct inode *inode, u64 start, u64 len);

int btrfs_qgroup_reserve_meta(struct btrfs_root *root, int num_bytes,
			      bool enforce);
void btrfs_qgroup_free_meta_all(struct btrfs_root *root);
void btrfs_qgroup_free_meta(struct btrfs_root *root, int num_bytes);
void btrfs_qgroup_check_reserved_leak(struct inode *inode);
#endif /* __BTRFS_QGROUP__ */
Commit	Line	Data
fcebe456 JB	1	/*
	2	* Copyright (C) 2014 Facebook. 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_QGROUP__
	20	#define __BTRFS_QGROUP__
	21
3368d001 QW	22	#include "ulist.h"
	23	#include "delayed-ref.h"
	24
1d2beaa9 QW	25	/*
	26	* Btrfs qgroup overview
	27	*
	28	* Btrfs qgroup splits into 3 main part:
	29	* 1) Reserve
	30	* Reserve metadata/data space for incoming operations
	31	* Affect how qgroup limit works
	32	*
	33	* 2) Trace
	34	* Tell btrfs qgroup to trace dirty extents.
	35	*
	36	* Dirty extents including:
	37	* - Newly allocated extents
	38	* - Extents going to be deleted (in this trans)
	39	* - Extents whose owner is going to be modified
	40	*
	41	* This is the main part affects whether qgroup numbers will stay
	42	* consistent.
	43	* Btrfs qgroup can trace clean extents and won't cause any problem,
	44	* but it will consume extra CPU time, it should be avoided if possible.
	45	*
	46	* 3) Account
	47	* Btrfs qgroup will updates its numbers, based on dirty extents traced
	48	* in previous step.
	49	*
	50	* Normally at qgroup rescan and transaction commit time.
	51	*/
	52
3368d001 QW	53	/*
	54	* Record a dirty extent, and info qgroup to update quota on it
	55	* TODO: Use kmem cache to alloc it.
	56	*/
	57	struct btrfs_qgroup_extent_record {
	58	struct rb_node node;
	59	u64 bytenr;
	60	u64 num_bytes;
	61	struct ulist *old_roots;
	62	};
	63
81fb6f77 QW	64	/*
	65	* For qgroup event trace points only
	66	*/
	67	#define QGROUP_RESERVE (1<<0)
	68	#define QGROUP_RELEASE (1<<1)
	69	#define QGROUP_FREE (1<<2)
	70
fcebe456 JB	71	int btrfs_quota_enable(struct btrfs_trans_handle *trans,
	72	struct btrfs_fs_info *fs_info);
	73	int btrfs_quota_disable(struct btrfs_trans_handle *trans,
	74	struct btrfs_fs_info *fs_info);
	75	int btrfs_qgroup_rescan(struct btrfs_fs_info *fs_info);
	76	void btrfs_qgroup_rescan_resume(struct btrfs_fs_info *fs_info);
d06f23d6 JM	77	int btrfs_qgroup_wait_for_completion(struct btrfs_fs_info *fs_info,
d06f23d6 JM	78	bool interruptible);
fcebe456 JB	79	int btrfs_add_qgroup_relation(struct btrfs_trans_handle *trans,
	80	struct btrfs_fs_info *fs_info, u64 src, u64 dst);
	81	int btrfs_del_qgroup_relation(struct btrfs_trans_handle *trans,
	82	struct btrfs_fs_info *fs_info, u64 src, u64 dst);
	83	int btrfs_create_qgroup(struct btrfs_trans_handle *trans,
4087cf24	84	struct btrfs_fs_info *fs_info, u64 qgroupid);
fcebe456 JB	85	int btrfs_remove_qgroup(struct btrfs_trans_handle *trans,
	86	struct btrfs_fs_info *fs_info, u64 qgroupid);
	87	int btrfs_limit_qgroup(struct btrfs_trans_handle *trans,
	88	struct btrfs_fs_info *fs_info, u64 qgroupid,
	89	struct btrfs_qgroup_limit *limit);
	90	int btrfs_read_qgroup_config(struct btrfs_fs_info *fs_info);
	91	void btrfs_free_qgroup_config(struct btrfs_fs_info *fs_info);
	92	struct btrfs_delayed_extent_op;
3b7d00f9 QW	93	int btrfs_qgroup_prepare_account_extents(struct btrfs_trans_handle *trans,
3b7d00f9 QW	94	struct btrfs_fs_info *fs_info);
cb93b52c	95	/*
50b3e040 QW	96	* Inform qgroup to trace one dirty extent, its info is recorded in @record.
50b3e040 QW	97	* So qgroup can account it at commit trans time.
cb93b52c QW	98	*
	99	* No lock version, caller must acquire delayed ref lock and allocate memory.
	100	*
	101	* Return 0 for success insert
	102	* Return >0 for existing record, caller can free @record safely.
	103	* Error is not possible
	104	*/
50b3e040	105	int btrfs_qgroup_trace_extent_nolock(
cb93b52c QW	106	struct btrfs_fs_info *fs_info,
	107	struct btrfs_delayed_ref_root *delayed_refs,
	108	struct btrfs_qgroup_extent_record *record);
	109
	110	/*
50b3e040 QW	111	* Inform qgroup to trace one dirty extent, specified by @bytenr and
	112	* @num_bytes.
	113	* So qgroup can account it at commit trans time.
cb93b52c QW	114	*
	115	* Better encapsulated version.
	116	*
	117	* Return 0 if the operation is done.
	118	* Return <0 for error, like memory allocation failure or invalid parameter
	119	* (NULL trans)
	120	*/
50b3e040	121	int btrfs_qgroup_trace_extent(struct btrfs_trans_handle *trans,
cb93b52c QW	122	struct btrfs_fs_info *fs_info, u64 bytenr, u64 num_bytes,
	123	gfp_t gfp_flag);
	124
33d1f05c QW	125	/*
	126	* Inform qgroup to trace all leaf items of data
	127	*
	128	* Return 0 for success
	129	* Return <0 for error(ENOMEM)
	130	*/
	131	int btrfs_qgroup_trace_leaf_items(struct btrfs_trans_handle *trans,
2ff7e61e	132	struct btrfs_fs_info *fs_info,
33d1f05c QW	133	struct extent_buffer *eb);
	134	/*
	135	* Inform qgroup to trace a whole subtree, including all its child tree
	136	* blocks and data.
	137	* The root tree block is specified by @root_eb.
	138	*
	139	* Normally used by relocation(tree block swap) and subvolume deletion.
	140	*
	141	* Return 0 for success
	142	* Return <0 for error(ENOMEM or tree search error)
	143	*/
	144	int btrfs_qgroup_trace_subtree(struct btrfs_trans_handle *trans,
	145	struct btrfs_root *root,
	146	struct extent_buffer *root_eb,
	147	u64 root_gen, int root_level);
442244c9 QW	148	int
	149	btrfs_qgroup_account_extent(struct btrfs_trans_handle *trans,
	150	struct btrfs_fs_info *fs_info,
	151	u64 bytenr, u64 num_bytes,
	152	struct ulist old_roots, struct ulist new_roots);
550d7a2e QW	153	int btrfs_qgroup_account_extents(struct btrfs_trans_handle *trans,
550d7a2e QW	154	struct btrfs_fs_info *fs_info);
fcebe456 JB	155	int btrfs_run_qgroups(struct btrfs_trans_handle *trans,
	156	struct btrfs_fs_info *fs_info);
	157	int btrfs_qgroup_inherit(struct btrfs_trans_handle *trans,
	158	struct btrfs_fs_info *fs_info, u64 srcid, u64 objectid,
	159	struct btrfs_qgroup_inherit *inherit);
297d750b QW	160	void btrfs_qgroup_free_refroot(struct btrfs_fs_info *fs_info,
297d750b QW	161	u64 ref_root, u64 num_bytes);
297d750b QW	162	/*
	163	* TODO: Add proper trace point for it, as btrfs_qgroup_free() is
	164	* called by everywhere, can't provide good trace for delayed ref case.
	165	*/
	166	static inline void btrfs_qgroup_free_delayed_ref(struct btrfs_fs_info *fs_info,
	167	u64 ref_root, u64 num_bytes)
	168	{
	169	btrfs_qgroup_free_refroot(fs_info, ref_root, num_bytes);
bc074524	170	trace_btrfs_qgroup_free_delayed_ref(fs_info, ref_root, num_bytes);
297d750b	171	}
fcebe456 JB	172	void assert_qgroups_uptodate(struct btrfs_trans_handle *trans);
	173
	174	#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
	175	int btrfs_verify_qgroup_counts(struct btrfs_fs_info *fs_info, u64 qgroupid,
	176	u64 rfer, u64 excl);
	177	#endif
	178
52472553 QW	179	/* New io_tree based accurate qgroup reserve API */
52472553 QW	180	int btrfs_qgroup_reserve_data(struct inode *inode, u64 start, u64 len);
f695fdce QW	181	int btrfs_qgroup_release_data(struct inode *inode, u64 start, u64 len);
f695fdce QW	182	int btrfs_qgroup_free_data(struct inode *inode, u64 start, u64 len);
55eeaf05	183
003d7c59 JM	184	int btrfs_qgroup_reserve_meta(struct btrfs_root *root, int num_bytes,
003d7c59 JM	185	bool enforce);
55eeaf05 QW	186	void btrfs_qgroup_free_meta_all(struct btrfs_root *root);
55eeaf05 QW	187	void btrfs_qgroup_free_meta(struct btrfs_root *root, int num_bytes);
56fa9d07	188	void btrfs_qgroup_check_reserved_leak(struct inode *inode);
fcebe456	189	#endif /* __BTRFS_QGROUP__ */