[mirror_ubuntu-bionic-kernel.git] / fs / xfs / libxfs / xfs_defer.h

/*
 * Copyright (C) 2016 Oracle.  All Rights Reserved.
 *
 * Author: Darrick J. Wong <darrick.wong@oracle.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it would 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 the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 */
#ifndef __XFS_DEFER_H__
#define	__XFS_DEFER_H__

struct xfs_defer_op_type;

/*
 * Save a log intent item and a list of extents, so that we can replay
 * whatever action had to happen to the extent list and file the log done
 * item.
 */
struct xfs_defer_pending {
	const struct xfs_defer_op_type	*dfp_type;	/* function pointers */
	struct list_head		dfp_list;	/* pending items */
	void				*dfp_intent;	/* log intent item */
	void				*dfp_done;	/* log done item */
	struct list_head		dfp_work;	/* work items */
	unsigned int			dfp_count;	/* # extent items */
};

/*
 * Header for deferred operation list.
 *
 * dop_low is used by the allocator to activate the lowspace algorithm -
 * when free space is running low the extent allocator may choose to
 * allocate an extent from an AG without leaving sufficient space for
 * a btree split when inserting the new extent.  In this case the allocator
 * will enable the lowspace algorithm which is supposed to allow further
 * allocations (such as btree splits and newroots) to allocate from
 * sequential AGs.  In order to avoid locking AGs out of order the lowspace
 * algorithm will start searching for free space from AG 0.  If the correct
 * transaction reservations have been made then this algorithm will eventually
 * find all the space it needs.
 */
enum xfs_defer_ops_type {
	XFS_DEFER_OPS_TYPE_BMAP,
	XFS_DEFER_OPS_TYPE_REFCOUNT,
	XFS_DEFER_OPS_TYPE_RMAP,
	XFS_DEFER_OPS_TYPE_FREE,
	XFS_DEFER_OPS_TYPE_MAX,
};

#define XFS_DEFER_OPS_NR_INODES	2	/* join up to two inodes */
#define XFS_DEFER_OPS_NR_BUFS	2	/* join up to two buffers */

struct xfs_defer_ops {
	bool			dop_committed;	/* did any trans commit? */
	bool			dop_low;	/* alloc in low mode */
	struct list_head	dop_intake;	/* unlogged pending work */
	struct list_head	dop_pending;	/* logged pending work */

	/* relog these with each roll */
	struct xfs_inode	*dop_inodes[XFS_DEFER_OPS_NR_INODES];
	struct xfs_buf		*dop_bufs[XFS_DEFER_OPS_NR_BUFS];
};

void xfs_defer_add(struct xfs_defer_ops *dop, enum xfs_defer_ops_type type,
		struct list_head *h);
int xfs_defer_finish(struct xfs_trans **tp, struct xfs_defer_ops *dop);
void xfs_defer_cancel(struct xfs_defer_ops *dop);
void xfs_defer_init(struct xfs_defer_ops *dop, xfs_fsblock_t *fbp);
bool xfs_defer_has_unfinished_work(struct xfs_defer_ops *dop);
int xfs_defer_ijoin(struct xfs_defer_ops *dop, struct xfs_inode *ip);
int xfs_defer_bjoin(struct xfs_defer_ops *dop, struct xfs_buf *bp);

/* Description of a deferred type. */
struct xfs_defer_op_type {
	enum xfs_defer_ops_type	type;
	unsigned int		max_items;
	void (*abort_intent)(void *);
	void *(*create_done)(struct xfs_trans *, void *, unsigned int);
	int (*finish_item)(struct xfs_trans *, struct xfs_defer_ops *,
			struct list_head *, void *, void **);
	void (*finish_cleanup)(struct xfs_trans *, void *, int);
	void (*cancel_item)(struct list_head *);
	int (*diff_items)(void *, struct list_head *, struct list_head *);
	void *(*create_intent)(struct xfs_trans *, uint);
	void (*log_item)(struct xfs_trans *, void *, struct list_head *);
};

void xfs_defer_init_op_type(const struct xfs_defer_op_type *type);

#endif /* __XFS_DEFER_H__ */
Commit	Line	Data
4e0cc29b DW	1	/*
	2	* Copyright (C) 2016 Oracle. All Rights Reserved.
	3	*
	4	* Author: Darrick J. Wong <darrick.wong@oracle.com>
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License
	8	* as published by the Free Software Foundation; either version 2
	9	* of the License, or (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it would be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write the Free Software Foundation,
	18	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
	19	*/
	20	#ifndef __XFS_DEFER_H__
	21	#define __XFS_DEFER_H__
	22
	23	struct xfs_defer_op_type;
	24
	25	/*
	26	* Save a log intent item and a list of extents, so that we can replay
	27	* whatever action had to happen to the extent list and file the log done
	28	* item.
	29	*/
	30	struct xfs_defer_pending {
	31	const struct xfs_defer_op_type dfp_type; / function pointers */
	32	struct list_head dfp_list; /* pending items */
4e0cc29b	33	void dfp_intent; / log intent item */
ea78d808	34	void dfp_done; / log done item */
4e0cc29b DW	35	struct list_head dfp_work; /* work items */
	36	unsigned int dfp_count; /* # extent items */
	37	};
	38
	39	/*
	40	* Header for deferred operation list.
	41	*
	42	* dop_low is used by the allocator to activate the lowspace algorithm -
	43	* when free space is running low the extent allocator may choose to
	44	* allocate an extent from an AG without leaving sufficient space for
	45	* a btree split when inserting the new extent. In this case the allocator
	46	* will enable the lowspace algorithm which is supposed to allow further
	47	* allocations (such as btree splits and newroots) to allocate from
	48	* sequential AGs. In order to avoid locking AGs out of order the lowspace
	49	* algorithm will start searching for free space from AG 0. If the correct
	50	* transaction reservations have been made then this algorithm will eventually
	51	* find all the space it needs.
	52	*/
	53	enum xfs_defer_ops_type {
9f3afb57	54	XFS_DEFER_OPS_TYPE_BMAP,
33ba6129	55	XFS_DEFER_OPS_TYPE_REFCOUNT,
f8dbebef	56	XFS_DEFER_OPS_TYPE_RMAP,
9749fee8	57	XFS_DEFER_OPS_TYPE_FREE,
4e0cc29b DW	58	XFS_DEFER_OPS_TYPE_MAX,
	59	};
	60
	61	#define XFS_DEFER_OPS_NR_INODES 2 /* join up to two inodes */
b7b2846f	62	#define XFS_DEFER_OPS_NR_BUFS 2 /* join up to two buffers */
4e0cc29b DW	63
	64	struct xfs_defer_ops {
	65	bool dop_committed; /* did any trans commit? */
	66	bool dop_low; /* alloc in low mode */
	67	struct list_head dop_intake; /* unlogged pending work */
	68	struct list_head dop_pending; /* logged pending work */
	69
b7b2846f	70	/* relog these with each roll */
4e0cc29b	71	struct xfs_inode *dop_inodes[XFS_DEFER_OPS_NR_INODES];
b7b2846f	72	struct xfs_buf *dop_bufs[XFS_DEFER_OPS_NR_BUFS];
4e0cc29b DW	73	};
	74
	75	void xfs_defer_add(struct xfs_defer_ops *dop, enum xfs_defer_ops_type type,
	76	struct list_head *h);
8ad7c629	77	int xfs_defer_finish(struct xfs_trans *tp, struct xfs_defer_ops dop);
4e0cc29b DW	78	void xfs_defer_cancel(struct xfs_defer_ops *dop);
	79	void xfs_defer_init(struct xfs_defer_ops dop, xfs_fsblock_t fbp);
	80	bool xfs_defer_has_unfinished_work(struct xfs_defer_ops *dop);
882d8785	81	int xfs_defer_ijoin(struct xfs_defer_ops dop, struct xfs_inode ip);
b7b2846f	82	int xfs_defer_bjoin(struct xfs_defer_ops dop, struct xfs_buf bp);
4e0cc29b DW	83
	84	/* Description of a deferred type. */
	85	struct xfs_defer_op_type {
	86	enum xfs_defer_ops_type type;
	87	unsigned int max_items;
	88	void (abort_intent)(void );
	89	void (create_done)(struct xfs_trans , void , unsigned int);
	90	int (finish_item)(struct xfs_trans , struct xfs_defer_ops *,
	91	struct list_head , void , void **);
	92	void (finish_cleanup)(struct xfs_trans , void *, int);
	93	void (cancel_item)(struct list_head );
	94	int (diff_items)(void , struct list_head , struct list_head );
	95	void (create_intent)(struct xfs_trans *, uint);
	96	void (log_item)(struct xfs_trans , void , struct list_head );
	97	};
	98
	99	void xfs_defer_init_op_type(const struct xfs_defer_op_type *type);
	100
	101	#endif /* __XFS_DEFER_H__ */