[linux.git] / fs / xfs / xfs_bmap_item.h

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2016 Oracle.  All Rights Reserved.
 * Author: Darrick J. Wong <[email protected]>
 */
#ifndef	__XFS_BMAP_ITEM_H__
#define	__XFS_BMAP_ITEM_H__

/*
 * There are (currently) two pairs of bmap btree redo item types: map & unmap.
 * The common abbreviations for these are BUI (bmap update intent) and BUD
 * (bmap update done).  The redo item type is encoded in the flags field of
 * each xfs_map_extent.
 *
 * *I items should be recorded in the *first* of a series of rolled
 * transactions, and the *D items should be recorded in the same transaction
 * that records the associated bmbt updates.
 *
 * Should the system crash after the commit of the first transaction but
 * before the commit of the final transaction in a series, log recovery will
 * use the redo information recorded by the intent items to replay the
 * bmbt metadata updates in the non-first transaction.
 */

/* kernel only BUI/BUD definitions */

struct xfs_mount;
struct kmem_zone;

/*
 * Max number of extents in fast allocation path.
 */
#define	XFS_BUI_MAX_FAST_EXTENTS	1

/*
 * Define BUI flag bits. Manipulated by set/clear/test_bit operators.
 */
#define	XFS_BUI_RECOVERED		1

/*
 * This is the "bmap update intent" log item.  It is used to log the fact that
 * some reverse mappings need to change.  It is used in conjunction with the
 * "bmap update done" log item described below.
 *
 * These log items follow the same rules as struct xfs_efi_log_item; see the
 * comments about that structure (in xfs_extfree_item.h) for more details.
 */
struct xfs_bui_log_item {
	struct xfs_log_item		bui_item;
	atomic_t			bui_refcount;
	atomic_t			bui_next_extent;
	unsigned long			bui_flags;	/* misc flags */
	struct xfs_bui_log_format	bui_format;
};

static inline size_t
xfs_bui_log_item_sizeof(
	unsigned int		nr)
{
	return offsetof(struct xfs_bui_log_item, bui_format) +
			xfs_bui_log_format_sizeof(nr);
}

/*
 * This is the "bmap update done" log item.  It is used to log the fact that
 * some bmbt updates mentioned in an earlier bui item have been performed.
 */
struct xfs_bud_log_item {
	struct xfs_log_item		bud_item;
	struct xfs_bui_log_item		*bud_buip;
	struct xfs_bud_log_format	bud_format;
};

extern struct kmem_zone	*xfs_bui_zone;
extern struct kmem_zone	*xfs_bud_zone;

struct xfs_bui_log_item *xfs_bui_init(struct xfs_mount *);
struct xfs_bud_log_item *xfs_bud_init(struct xfs_mount *,
		struct xfs_bui_log_item *);
void xfs_bui_item_free(struct xfs_bui_log_item *);
void xfs_bui_release(struct xfs_bui_log_item *);
int xfs_bui_recover(struct xfs_mount *mp, struct xfs_bui_log_item *buip,
		struct xfs_defer_ops *dfops);

#endif	/* __XFS_BMAP_ITEM_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0+
6413a014 DW	2	/*
6413a014 DW	3	* Copyright (C) 2016 Oracle. All Rights Reserved.
6413a014	4	* Author: Darrick J. Wong <[email protected]>
6413a014 DW	5	*/
	6	#ifndef __XFS_BMAP_ITEM_H__
	7	#define __XFS_BMAP_ITEM_H__
	8
	9	/*
	10	* There are (currently) two pairs of bmap btree redo item types: map & unmap.
	11	* The common abbreviations for these are BUI (bmap update intent) and BUD
	12	* (bmap update done). The redo item type is encoded in the flags field of
	13	* each xfs_map_extent.
	14	*
	15	* I items should be recorded in the first* of a series of rolled
	16	* transactions, and the *D items should be recorded in the same transaction
	17	* that records the associated bmbt updates.
	18	*
	19	* Should the system crash after the commit of the first transaction but
	20	* before the commit of the final transaction in a series, log recovery will
	21	* use the redo information recorded by the intent items to replay the
	22	* bmbt metadata updates in the non-first transaction.
	23	*/
	24
	25	/* kernel only BUI/BUD definitions */
	26
	27	struct xfs_mount;
	28	struct kmem_zone;
	29
	30	/*
	31	* Max number of extents in fast allocation path.
	32	*/
	33	#define XFS_BUI_MAX_FAST_EXTENTS 1
	34
	35	/*
	36	* Define BUI flag bits. Manipulated by set/clear/test_bit operators.
	37	*/
	38	#define XFS_BUI_RECOVERED 1
	39
	40	/*
	41	* This is the "bmap update intent" log item. It is used to log the fact that
	42	* some reverse mappings need to change. It is used in conjunction with the
	43	* "bmap update done" log item described below.
	44	*
	45	* These log items follow the same rules as struct xfs_efi_log_item; see the
	46	* comments about that structure (in xfs_extfree_item.h) for more details.
	47	*/
	48	struct xfs_bui_log_item {
	49	struct xfs_log_item bui_item;
	50	atomic_t bui_refcount;
	51	atomic_t bui_next_extent;
	52	unsigned long bui_flags; /* misc flags */
	53	struct xfs_bui_log_format bui_format;
	54	};
	55
	56	static inline size_t
	57	xfs_bui_log_item_sizeof(
	58	unsigned int nr)
	59	{
	60	return offsetof(struct xfs_bui_log_item, bui_format) +
	61	xfs_bui_log_format_sizeof(nr);
	62	}
	63
	64	/*
	65	* This is the "bmap update done" log item. It is used to log the fact that
	66	* some bmbt updates mentioned in an earlier bui item have been performed.
	67	*/
	68	struct xfs_bud_log_item {
69	struct xfs_log_item bud_item;
70	struct xfs_bui_log_item *bud_buip;
71	struct xfs_bud_log_format bud_format;
72	};
73
74	extern struct kmem_zone *xfs_bui_zone;
75	extern struct kmem_zone *xfs_bud_zone;
76
77	struct xfs_bui_log_item xfs_bui_init(struct xfs_mount );
78	struct xfs_bud_log_item xfs_bud_init(struct xfs_mount ,
79	struct xfs_bui_log_item *);
80	void xfs_bui_item_free(struct xfs_bui_log_item *);
81	void xfs_bui_release(struct xfs_bui_log_item *);
50995582 DW	82	int xfs_bui_recover(struct xfs_mount mp, struct xfs_bui_log_item buip,
50995582 DW	83	struct xfs_defer_ops *dfops);
6413a014 DW	84
6413a014 DW	85	#endif /* __XFS_BMAP_ITEM_H__ */