[linux-block.git] / fs / xfs / libxfs / xfs_inode_fork.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef	__XFS_INODE_FORK_H__
#define	__XFS_INODE_FORK_H__

struct xfs_inode_log_item;
struct xfs_dinode;

/*
 * File incore extent information, present for each of data & attr forks.
 */
struct xfs_ifork {
	int64_t			if_bytes;	/* bytes in if_data */
	struct xfs_btree_block	*if_broot;	/* file's incore btree root */
	unsigned int		if_seq;		/* fork mod counter */
	int			if_height;	/* height of the extent tree */
	void			*if_data;	/* extent tree root or
						   inline data */
	xfs_extnum_t		if_nextents;	/* # of extents in this fork */
	short			if_broot_bytes;	/* bytes allocated for root */
	int8_t			if_format;	/* format of this fork */
	uint8_t			if_needextents;	/* extents have not been read */
};

/*
 * Worst-case increase in the fork extent count when we're adding a single
 * extent to a fork and there's no possibility of splitting an existing mapping.
 */
#define XFS_IEXT_ADD_NOSPLIT_CNT	(1)

/*
 * Punching out an extent from the middle of an existing extent can cause the
 * extent count to increase by 1.
 * i.e. | Old extent | Hole | Old extent |
 */
#define XFS_IEXT_PUNCH_HOLE_CNT		(1)

/*
 * Adding/removing an xattr can cause XFS_DA_NODE_MAXDEPTH extents to
 * be added. One extra extent for dabtree in case a local attr is
 * large enough to cause a double split.  It can also cause extent
 * count to increase proportional to the size of a remote xattr's
 * value.
 */
#define XFS_IEXT_ATTR_MANIP_CNT(rmt_blks) \
	(XFS_DA_NODE_MAXDEPTH + max(1, rmt_blks))

/*
 * A write to a sub-interval of an existing unwritten extent causes the original
 * extent to be split into 3 extents
 * i.e. | Unwritten | Real | Unwritten |
 * Hence extent count can increase by 2.
 */
#define XFS_IEXT_WRITE_UNWRITTEN_CNT	(2)


/*
 * Moving an extent to data fork can cause a sub-interval of an existing extent
 * to be unmapped. This will increase extent count by 1. Mapping in the new
 * extent can increase the extent count by 1 again i.e.
 * | Old extent | New extent | Old extent |
 * Hence number of extents increases by 2.
 */
#define XFS_IEXT_REFLINK_END_COW_CNT	(2)

/*
 * Removing an initial range of source/donor file's extent and adding a new
 * extent (from donor/source file) in its place will cause extent count to
 * increase by 1.
 */
#define XFS_IEXT_SWAP_RMAP_CNT		(1)

/*
 * Fork handling.
 */
#define XFS_IFORK_MAXEXT(ip, w) \
	(xfs_inode_fork_size(ip, w) / sizeof(xfs_bmbt_rec_t))

static inline bool xfs_ifork_has_extents(struct xfs_ifork *ifp)
{
	return ifp->if_format == XFS_DINODE_FMT_EXTENTS ||
		ifp->if_format == XFS_DINODE_FMT_BTREE;
}

static inline xfs_extnum_t xfs_ifork_nextents(struct xfs_ifork *ifp)
{
	if (!ifp)
		return 0;
	return ifp->if_nextents;
}

static inline int8_t xfs_ifork_format(struct xfs_ifork *ifp)
{
	if (!ifp)
		return XFS_DINODE_FMT_EXTENTS;
	return ifp->if_format;
}

static inline xfs_extnum_t xfs_iext_max_nextents(bool has_large_extent_counts,
				int whichfork)
{
	switch (whichfork) {
	case XFS_DATA_FORK:
	case XFS_COW_FORK:
		if (has_large_extent_counts)
			return XFS_MAX_EXTCNT_DATA_FORK_LARGE;
		return XFS_MAX_EXTCNT_DATA_FORK_SMALL;

	case XFS_ATTR_FORK:
		if (has_large_extent_counts)
			return XFS_MAX_EXTCNT_ATTR_FORK_LARGE;
		return XFS_MAX_EXTCNT_ATTR_FORK_SMALL;

	default:
		ASSERT(0);
		return 0;
	}
}

static inline xfs_extnum_t
xfs_dfork_data_extents(
	struct xfs_dinode	*dip)
{
	if (xfs_dinode_has_large_extent_counts(dip))
		return be64_to_cpu(dip->di_big_nextents);

	return be32_to_cpu(dip->di_nextents);
}

static inline xfs_extnum_t
xfs_dfork_attr_extents(
	struct xfs_dinode	*dip)
{
	if (xfs_dinode_has_large_extent_counts(dip))
		return be32_to_cpu(dip->di_big_anextents);

	return be16_to_cpu(dip->di_anextents);
}

static inline xfs_extnum_t
xfs_dfork_nextents(
	struct xfs_dinode	*dip,
	int			whichfork)
{
	switch (whichfork) {
	case XFS_DATA_FORK:
		return xfs_dfork_data_extents(dip);
	case XFS_ATTR_FORK:
		return xfs_dfork_attr_extents(dip);
	default:
		ASSERT(0);
		break;
	}

	return 0;
}

void xfs_ifork_zap_attr(struct xfs_inode *ip);
void xfs_ifork_init_attr(struct xfs_inode *ip, enum xfs_dinode_fmt format,
		xfs_extnum_t nextents);
struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state);

int		xfs_iformat_data_fork(struct xfs_inode *, struct xfs_dinode *);
int		xfs_iformat_attr_fork(struct xfs_inode *, struct xfs_dinode *);
void		xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *,
				struct xfs_inode_log_item *, int);
void		xfs_idestroy_fork(struct xfs_ifork *ifp);
void *		xfs_idata_realloc(struct xfs_inode *ip, int64_t byte_diff,
				int whichfork);
void		xfs_iroot_realloc(struct xfs_inode *, int, int);
int		xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
int		xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *,
				  int);
void		xfs_init_local_fork(struct xfs_inode *ip, int whichfork,
				const void *data, int64_t size);

xfs_extnum_t	xfs_iext_count(struct xfs_ifork *ifp);
void		xfs_iext_insert_raw(struct xfs_ifork *ifp,
			struct xfs_iext_cursor *cur,
			struct xfs_bmbt_irec *irec);
void		xfs_iext_insert(struct xfs_inode *, struct xfs_iext_cursor *cur,
			struct xfs_bmbt_irec *, int);
void		xfs_iext_remove(struct xfs_inode *, struct xfs_iext_cursor *,
			int);
void		xfs_iext_destroy(struct xfs_ifork *);

bool		xfs_iext_lookup_extent(struct xfs_inode *ip,
			struct xfs_ifork *ifp, xfs_fileoff_t bno,
			struct xfs_iext_cursor *cur,
			struct xfs_bmbt_irec *gotp);
bool		xfs_iext_lookup_extent_before(struct xfs_inode *ip,
			struct xfs_ifork *ifp, xfs_fileoff_t *end,
			struct xfs_iext_cursor *cur,
			struct xfs_bmbt_irec *gotp);
bool		xfs_iext_get_extent(struct xfs_ifork *ifp,
			struct xfs_iext_cursor *cur,
			struct xfs_bmbt_irec *gotp);
void		xfs_iext_update_extent(struct xfs_inode *ip, int state,
			struct xfs_iext_cursor *cur,
			struct xfs_bmbt_irec *gotp);

void		xfs_iext_first(struct xfs_ifork *, struct xfs_iext_cursor *);
void		xfs_iext_last(struct xfs_ifork *, struct xfs_iext_cursor *);
void		xfs_iext_next(struct xfs_ifork *, struct xfs_iext_cursor *);
void		xfs_iext_prev(struct xfs_ifork *, struct xfs_iext_cursor *);

static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp,
		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
{
	xfs_iext_next(ifp, cur);
	return xfs_iext_get_extent(ifp, cur, gotp);
}

static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp,
		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
{
	xfs_iext_prev(ifp, cur);
	return xfs_iext_get_extent(ifp, cur, gotp);
}

/*
 * Return the extent after cur in gotp without updating the cursor.
 */
static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp,
		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
{
	struct xfs_iext_cursor ncur = *cur;

	xfs_iext_next(ifp, &ncur);
	return xfs_iext_get_extent(ifp, &ncur, gotp);
}

/*
 * Return the extent before cur in gotp without updating the cursor.
 */
static inline bool xfs_iext_peek_prev_extent(struct xfs_ifork *ifp,
		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
{
	struct xfs_iext_cursor ncur = *cur;

	xfs_iext_prev(ifp, &ncur);
	return xfs_iext_get_extent(ifp, &ncur, gotp);
}

#define for_each_xfs_iext(ifp, ext, got)		\
	for (xfs_iext_first((ifp), (ext));		\
	     xfs_iext_get_extent((ifp), (ext), (got));	\
	     xfs_iext_next((ifp), (ext)))

extern struct kmem_cache	*xfs_ifork_cache;

extern void xfs_ifork_init_cow(struct xfs_inode *ip);

int xfs_ifork_verify_local_data(struct xfs_inode *ip);
int xfs_ifork_verify_local_attr(struct xfs_inode *ip);
int xfs_iext_count_may_overflow(struct xfs_inode *ip, int whichfork,
		int nr_to_add);
int xfs_iext_count_upgrade(struct xfs_trans *tp, struct xfs_inode *ip,
		uint nr_to_add);
bool xfs_ifork_is_realtime(struct xfs_inode *ip, int whichfork);

/* returns true if the fork has extents but they are not read in yet. */
static inline bool xfs_need_iread_extents(const struct xfs_ifork *ifp)
{
	/* see xfs_iformat_{data,attr}_fork() for needextents semantics */
	return smp_load_acquire(&ifp->if_needextents) != 0;
}

#endif	/* __XFS_INODE_FORK_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
5c4d97d0 DC	2	/*
	3	* Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
	4	* All Rights Reserved.
5c4d97d0 DC	5	*/
	6	#ifndef __XFS_INODE_FORK_H__
	7	#define __XFS_INODE_FORK_H__
	8
	9	struct xfs_inode_log_item;
a4fbe6ab	10	struct xfs_dinode;
5c4d97d0	11
5c4d97d0 DC	12	/*
	13	* File incore extent information, present for each of data & attr forks.
	14	*/
3ba738df	15	struct xfs_ifork {
6e145f94	16	int64_t if_bytes; /* bytes in if_data */
5c4d97d0	17	struct xfs_btree_block if_broot; / file's incore btree root */
3f8a4f1d	18	unsigned int if_seq; /* fork mod counter */
6bdcf26a	19	int if_height; /* height of the extent tree */
6e145f94 CH	20	void if_data; / extent tree root or
6e145f94 CH	21	inline data */
755c38ff	22	xfs_extnum_t if_nextents; /* # of extents in this fork */
3f8a4f1d	23	short if_broot_bytes; /* bytes allocated for root */
f7e67b20	24	int8_t if_format; /* format of this fork */
c95356ca	25	uint8_t if_needextents; /* extents have not been read */
3ba738df	26	};
5c4d97d0	27
727e1acd CB	28	/*
	29	* Worst-case increase in the fork extent count when we're adding a single
	30	* extent to a fork and there's no possibility of splitting an existing mapping.
	31	*/
	32	#define XFS_IEXT_ADD_NOSPLIT_CNT (1)
	33
85ef08b5 CB	34	/*
	35	* Punching out an extent from the middle of an existing extent can cause the
	36	* extent count to increase by 1.
	37	* i.e. \| Old extent \| Hole \| Old extent \|
	38	*/
	39	#define XFS_IEXT_PUNCH_HOLE_CNT (1)
	40
3a19bb14 CB	41	/*
	42	* Adding/removing an xattr can cause XFS_DA_NODE_MAXDEPTH extents to
	43	* be added. One extra extent for dabtree in case a local attr is
	44	* large enough to cause a double split. It can also cause extent
	45	* count to increase proportional to the size of a remote xattr's
	46	* value.
	47	*/
	48	#define XFS_IEXT_ATTR_MANIP_CNT(rmt_blks) \
	49	(XFS_DA_NODE_MAXDEPTH + max(1, rmt_blks))
	50
c442f308 CB	51	/*
	52	* A write to a sub-interval of an existing unwritten extent causes the original
	53	* extent to be split into 3 extents
	54	* i.e. \| Unwritten \| Real \| Unwritten \|
	55	* Hence extent count can increase by 2.
	56	*/
	57	#define XFS_IEXT_WRITE_UNWRITTEN_CNT (2)
	58
	59
5f1d5bbf CB	60	/*
	61	* Moving an extent to data fork can cause a sub-interval of an existing extent
	62	* to be unmapped. This will increase extent count by 1. Mapping in the new
	63	* extent can increase the extent count by 1 again i.e.
	64	* \| Old extent \| New extent \| Old extent \|
	65	* Hence number of extents increases by 2.
	66	*/
	67	#define XFS_IEXT_REFLINK_END_COW_CNT (2)
	68
bcc561f2 CB	69	/*
	70	* Removing an initial range of source/donor file's extent and adding a new
	71	* extent (from donor/source file) in its place will cause extent count to
	72	* increase by 1.
	73	*/
	74	#define XFS_IEXT_SWAP_RMAP_CNT (1)
	75
5c4d97d0 DC	76	/*
	77	* Fork handling.
	78	*/
5c4d97d0	79	#define XFS_IFORK_MAXEXT(ip, w) \
c01147d9	80	(xfs_inode_fork_size(ip, w) / sizeof(xfs_bmbt_rec_t))
5c4d97d0	81
f7e67b20 CH	82	static inline bool xfs_ifork_has_extents(struct xfs_ifork *ifp)
	83	{
	84	return ifp->if_format == XFS_DINODE_FMT_EXTENTS \|\|
	85	ifp->if_format == XFS_DINODE_FMT_BTREE;
	86	}
2fe4f928	87
daf83964 CH	88	static inline xfs_extnum_t xfs_ifork_nextents(struct xfs_ifork *ifp)
	89	{
	90	if (!ifp)
	91	return 0;
	92	return ifp->if_nextents;
	93	}
	94
f7e67b20 CH	95	static inline int8_t xfs_ifork_format(struct xfs_ifork *ifp)
	96	{
	97	if (!ifp)
	98	return XFS_DINODE_FMT_EXTENTS;
	99	return ifp->if_format;
	100	}
	101
df9ad5cc CB	102	static inline xfs_extnum_t xfs_iext_max_nextents(bool has_large_extent_counts,
df9ad5cc CB	103	int whichfork)
9feb8f19	104	{
df9ad5cc CB	105	switch (whichfork) {
	106	case XFS_DATA_FORK:
	107	case XFS_COW_FORK:
	108	if (has_large_extent_counts)
	109	return XFS_MAX_EXTCNT_DATA_FORK_LARGE;
	110	return XFS_MAX_EXTCNT_DATA_FORK_SMALL;
	111
	112	case XFS_ATTR_FORK:
	113	if (has_large_extent_counts)
	114	return XFS_MAX_EXTCNT_ATTR_FORK_LARGE;
	115	return XFS_MAX_EXTCNT_ATTR_FORK_SMALL;
	116
	117	default:
	118	ASSERT(0);
	119	return 0;
	120	}
9feb8f19 CB	121	}
9feb8f19 CB	122
dd95a6ce CB	123	static inline xfs_extnum_t
	124	xfs_dfork_data_extents(
	125	struct xfs_dinode *dip)
	126	{
52a4a148 CB	127	if (xfs_dinode_has_large_extent_counts(dip))
	128	return be64_to_cpu(dip->di_big_nextents);
	129
dd95a6ce CB	130	return be32_to_cpu(dip->di_nextents);
	131	}
	132
	133	static inline xfs_extnum_t
	134	xfs_dfork_attr_extents(
	135	struct xfs_dinode *dip)
	136	{
52a4a148 CB	137	if (xfs_dinode_has_large_extent_counts(dip))
	138	return be32_to_cpu(dip->di_big_anextents);
	139
dd95a6ce CB	140	return be16_to_cpu(dip->di_anextents);
	141	}
	142
	143	static inline xfs_extnum_t
	144	xfs_dfork_nextents(
	145	struct xfs_dinode *dip,
	146	int whichfork)
	147	{
	148	switch (whichfork) {
	149	case XFS_DATA_FORK:
	150	return xfs_dfork_data_extents(dip);
	151	case XFS_ATTR_FORK:
	152	return xfs_dfork_attr_extents(dip);
	153	default:
	154	ASSERT(0);
	155	break;
	156	}
	157
	158	return 0;
	159	}
	160
2ed5b09b DW	161	void xfs_ifork_zap_attr(struct xfs_inode *ip);
	162	void xfs_ifork_init_attr(struct xfs_inode *ip, enum xfs_dinode_fmt format,
	163	xfs_extnum_t nextents);
3993baeb DW	164	struct xfs_ifork xfs_iext_state_to_fork(struct xfs_inode ip, int state);
3993baeb DW	165
9229d18e CH	166	int xfs_iformat_data_fork(struct xfs_inode , struct xfs_dinode );
9229d18e CH	167	int xfs_iformat_attr_fork(struct xfs_inode , struct xfs_dinode );
78420281	168	void xfs_iflush_fork(struct xfs_inode , struct xfs_dinode ,
fd9fdba6	169	struct xfs_inode_log_item *, int);
ef838512	170	void xfs_idestroy_fork(struct xfs_ifork *ifp);
45c76a2a	171	void * xfs_idata_realloc(struct xfs_inode *ip, int64_t byte_diff,
3f8a4f1d	172	int whichfork);
5c4d97d0 DC	173	void xfs_iroot_realloc(struct xfs_inode *, int, int);
	174	int xfs_iread_extents(struct xfs_trans , struct xfs_inode , int);
	175	int xfs_iextents_copy(struct xfs_inode , struct xfs_bmbt_rec ,
	176	int);
3f8a4f1d DC	177	void xfs_init_local_fork(struct xfs_inode *ip, int whichfork,
3f8a4f1d DC	178	const void *data, int64_t size);
5c4d97d0	179
6bdcf26a	180	xfs_extnum_t xfs_iext_count(struct xfs_ifork *ifp);
8f71bede DW	181	void xfs_iext_insert_raw(struct xfs_ifork *ifp,
	182	struct xfs_iext_cursor *cur,
	183	struct xfs_bmbt_irec *irec);
b2b1712a	184	void xfs_iext_insert(struct xfs_inode , struct xfs_iext_cursor cur,
0254c2f2	185	struct xfs_bmbt_irec *, int);
b2b1712a	186	void xfs_iext_remove(struct xfs_inode , struct xfs_iext_cursor ,
c38ccf59	187	int);
5c4d97d0	188	void xfs_iext_destroy(struct xfs_ifork *);
5c4d97d0	189
93533c78 CH	190	bool xfs_iext_lookup_extent(struct xfs_inode *ip,
93533c78 CH	191	struct xfs_ifork *ifp, xfs_fileoff_t bno,
b2b1712a CH	192	struct xfs_iext_cursor *cur,
b2b1712a CH	193	struct xfs_bmbt_irec *gotp);
dc56015f CH	194	bool xfs_iext_lookup_extent_before(struct xfs_inode *ip,
dc56015f CH	195	struct xfs_ifork ifp, xfs_fileoff_t end,
b2b1712a CH	196	struct xfs_iext_cursor *cur,
	197	struct xfs_bmbt_irec *gotp);
	198	bool xfs_iext_get_extent(struct xfs_ifork *ifp,
	199	struct xfs_iext_cursor *cur,
93533c78	200	struct xfs_bmbt_irec *gotp);
ca5d8e5b	201	void xfs_iext_update_extent(struct xfs_inode *ip, int state,
b2b1712a CH	202	struct xfs_iext_cursor *cur,
	203	struct xfs_bmbt_irec *gotp);
	204
6bdcf26a CH	205	void xfs_iext_first(struct xfs_ifork , struct xfs_iext_cursor );
	206	void xfs_iext_last(struct xfs_ifork , struct xfs_iext_cursor );
	207	void xfs_iext_next(struct xfs_ifork , struct xfs_iext_cursor );
	208	void xfs_iext_prev(struct xfs_ifork , struct xfs_iext_cursor );
b2b1712a CH	209
	210	static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp,
	211	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	212	{
	213	xfs_iext_next(ifp, cur);
	214	return xfs_iext_get_extent(ifp, cur, gotp);
	215	}
	216
	217	static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp,
	218	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	219	{
	220	xfs_iext_prev(ifp, cur);
	221	return xfs_iext_get_extent(ifp, cur, gotp);
	222	}
	223
	224	/*
	225	* Return the extent after cur in gotp without updating the cursor.
	226	*/
	227	static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp,
	228	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	229	{
	230	struct xfs_iext_cursor ncur = *cur;
	231
	232	xfs_iext_next(ifp, &ncur);
	233	return xfs_iext_get_extent(ifp, &ncur, gotp);
	234	}
	235
	236	/*
	237	* Return the extent before cur in gotp without updating the cursor.
	238	*/
	239	static inline bool xfs_iext_peek_prev_extent(struct xfs_ifork *ifp,
	240	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	241	{
	242	struct xfs_iext_cursor ncur = *cur;
	243
	244	xfs_iext_prev(ifp, &ncur);
	245	return xfs_iext_get_extent(ifp, &ncur, gotp);
	246	}
	247
	248	#define for_each_xfs_iext(ifp, ext, got) \
	249	for (xfs_iext_first((ifp), (ext)); \
	250	xfs_iext_get_extent((ifp), (ext), (got)); \
	251	xfs_iext_next((ifp), (ext)))
93533c78	252
182696fb	253	extern struct kmem_cache *xfs_ifork_cache;
5c4d97d0	254
3993baeb DW	255	extern void xfs_ifork_init_cow(struct xfs_inode *ip);
3993baeb DW	256
7c7ba218 CH	257	int xfs_ifork_verify_local_data(struct xfs_inode *ip);
7c7ba218 CH	258	int xfs_ifork_verify_local_attr(struct xfs_inode *ip);
b9b7e1dc CB	259	int xfs_iext_count_may_overflow(struct xfs_inode *ip, int whichfork,
b9b7e1dc CB	260	int nr_to_add);
4f86bb4b CB	261	int xfs_iext_count_upgrade(struct xfs_trans tp, struct xfs_inode ip,
4f86bb4b CB	262	uint nr_to_add);
5049ff4d	263	bool xfs_ifork_is_realtime(struct xfs_inode *ip, int whichfork);
9cfb9b47	264
b2197a36	265	/* returns true if the fork has extents but they are not read in yet. */
c95356ca	266	static inline bool xfs_need_iread_extents(const struct xfs_ifork *ifp)
b2197a36	267	{
c95356ca DW	268	/* see xfs_iformat_{data,attr}_fork() for needextents semantics */
c95356ca DW	269	return smp_load_acquire(&ifp->if_needextents) != 0;
b2197a36 CH	270	}
b2197a36 CH	271
5c4d97d0	272	#endif /* __XFS_INODE_FORK_H__ */