[thirdparty/xfsprogs-dev.git] / 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.
 */
typedef struct xfs_ifork {
	int			if_bytes;	/* bytes in if_u1 */
	int			if_real_bytes;	/* bytes allocated in if_u1 */
	struct xfs_btree_block	*if_broot;	/* file's incore btree root */
	short			if_broot_bytes;	/* bytes allocated for root */
	unsigned char		if_flags;	/* per-fork flags */
	int			if_height;	/* height of the extent tree */
	union {
		void		*if_root;	/* extent tree root */
		char		*if_data;	/* inline file data */
	} if_u1;
} xfs_ifork_t;

/*
 * Per-fork incore inode flags.
 */
#define	XFS_IFINLINE	0x01	/* Inline data is read in */
#define	XFS_IFEXTENTS	0x02	/* All extent pointers are read in */
#define	XFS_IFBROOT	0x04	/* i_broot points to the bmap b-tree root */

/*
 * Fork handling.
 */

#define XFS_IFORK_Q(ip)			((ip)->i_d.di_forkoff != 0)
#define XFS_IFORK_BOFF(ip)		((int)((ip)->i_d.di_forkoff << 3))

#define XFS_IFORK_PTR(ip,w)		\
	((w) == XFS_DATA_FORK ? \
		&(ip)->i_df : \
		((w) == XFS_ATTR_FORK ? \
			(ip)->i_afp : \
			(ip)->i_cowfp))
#define XFS_IFORK_DSIZE(ip) \
	(XFS_IFORK_Q(ip) ? \
		XFS_IFORK_BOFF(ip) : \
		XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
#define XFS_IFORK_ASIZE(ip) \
	(XFS_IFORK_Q(ip) ? \
		XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
			XFS_IFORK_BOFF(ip) : \
		0)
#define XFS_IFORK_SIZE(ip,w) \
	((w) == XFS_DATA_FORK ? \
		XFS_IFORK_DSIZE(ip) : \
		((w) == XFS_ATTR_FORK ? \
			XFS_IFORK_ASIZE(ip) : \
			0))
#define XFS_IFORK_FORMAT(ip,w) \
	((w) == XFS_DATA_FORK ? \
		(ip)->i_d.di_format : \
		((w) == XFS_ATTR_FORK ? \
			(ip)->i_d.di_aformat : \
			(ip)->i_cformat))
#define XFS_IFORK_FMT_SET(ip,w,n) \
	((w) == XFS_DATA_FORK ? \
		((ip)->i_d.di_format = (n)) : \
		((w) == XFS_ATTR_FORK ? \
			((ip)->i_d.di_aformat = (n)) : \
			((ip)->i_cformat = (n))))
#define XFS_IFORK_NEXTENTS(ip,w) \
	((w) == XFS_DATA_FORK ? \
		(ip)->i_d.di_nextents : \
		((w) == XFS_ATTR_FORK ? \
			(ip)->i_d.di_anextents : \
			(ip)->i_cnextents))
#define XFS_IFORK_NEXT_SET(ip,w,n) \
	((w) == XFS_DATA_FORK ? \
		((ip)->i_d.di_nextents = (n)) : \
		((w) == XFS_ATTR_FORK ? \
			((ip)->i_d.di_anextents = (n)) : \
			((ip)->i_cnextents = (n))))
#define XFS_IFORK_MAXEXT(ip, w) \
	(XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))

struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state);

int		xfs_iformat_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_inode *, int);
void		xfs_idata_realloc(struct xfs_inode *, int, int);
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 *, int, const void *, int);

xfs_extnum_t	xfs_iext_count(struct xfs_ifork *ifp);
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_zone	*xfs_ifork_zone;

extern void xfs_ifork_init_cow(struct xfs_inode *ip);

typedef xfs_failaddr_t (*xfs_ifork_verifier_t)(struct xfs_inode *);

struct xfs_ifork_ops {
	xfs_ifork_verifier_t	verify_symlink;
	xfs_ifork_verifier_t	verify_dir;
	xfs_ifork_verifier_t	verify_attr;
};
extern struct xfs_ifork_ops	xfs_default_ifork_ops;

xfs_failaddr_t xfs_ifork_verify_data(struct xfs_inode *ip,
		struct xfs_ifork_ops *ops);
xfs_failaddr_t xfs_ifork_verify_attr(struct xfs_inode *ip,
		struct xfs_ifork_ops *ops);

#endif	/* __XFS_INODE_FORK_H__ */
Commit	Line	Data
37b3b4d6	1	// SPDX-License-Identifier: GPL-2.0
5d90ab5a DC	2	/*
	3	* Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
	4	* All Rights Reserved.
5d90ab5a DC	5	*/
	6	#ifndef __XFS_INODE_FORK_H__
	7	#define __XFS_INODE_FORK_H__
	8
	9	struct xfs_inode_log_item;
34b8c759	10	struct xfs_dinode;
5d90ab5a	11
5d90ab5a DC	12	/*
	13	* File incore extent information, present for each of data & attr forks.
	14	*/
5d90ab5a DC	15	typedef struct xfs_ifork {
	16	int if_bytes; /* bytes in if_u1 */
	17	int if_real_bytes; /* bytes allocated in if_u1 */
	18	struct xfs_btree_block if_broot; / file's incore btree root */
	19	short if_broot_bytes; /* bytes allocated for root */
	20	unsigned char if_flags; /* per-fork flags */
b37d753d	21	int if_height; /* height of the extent tree */
5d90ab5a	22	union {
b37d753d	23	void if_root; / extent tree root */
5d90ab5a DC	24	char if_data; / inline file data */
5d90ab5a DC	25	} if_u1;
5d90ab5a DC	26	} xfs_ifork_t;
	27
	28	/*
	29	* Per-fork incore inode flags.
	30	*/
	31	#define XFS_IFINLINE 0x01 /* Inline data is read in */
	32	#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
	33	#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
5d90ab5a DC	34
	35	/*
	36	* Fork handling.
	37	*/
	38
	39	#define XFS_IFORK_Q(ip) ((ip)->i_d.di_forkoff != 0)
	40	#define XFS_IFORK_BOFF(ip) ((int)((ip)->i_d.di_forkoff << 3))
	41
	42	#define XFS_IFORK_PTR(ip,w) \
	43	((w) == XFS_DATA_FORK ? \
	44	&(ip)->i_df : \
cb8a004a DW	45	((w) == XFS_ATTR_FORK ? \
	46	(ip)->i_afp : \
	47	(ip)->i_cowfp))
5d90ab5a DC	48	#define XFS_IFORK_DSIZE(ip) \
	49	(XFS_IFORK_Q(ip) ? \
	50	XFS_IFORK_BOFF(ip) : \
	51	XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
	52	#define XFS_IFORK_ASIZE(ip) \
	53	(XFS_IFORK_Q(ip) ? \
	54	XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
	55	XFS_IFORK_BOFF(ip) : \
	56	0)
	57	#define XFS_IFORK_SIZE(ip,w) \
	58	((w) == XFS_DATA_FORK ? \
	59	XFS_IFORK_DSIZE(ip) : \
cb8a004a DW	60	((w) == XFS_ATTR_FORK ? \
	61	XFS_IFORK_ASIZE(ip) : \
	62	0))
5d90ab5a DC	63	#define XFS_IFORK_FORMAT(ip,w) \
	64	((w) == XFS_DATA_FORK ? \
	65	(ip)->i_d.di_format : \
cb8a004a DW	66	((w) == XFS_ATTR_FORK ? \
	67	(ip)->i_d.di_aformat : \
	68	(ip)->i_cformat))
5d90ab5a DC	69	#define XFS_IFORK_FMT_SET(ip,w,n) \
	70	((w) == XFS_DATA_FORK ? \
	71	((ip)->i_d.di_format = (n)) : \
cb8a004a DW	72	((w) == XFS_ATTR_FORK ? \
	73	((ip)->i_d.di_aformat = (n)) : \
	74	((ip)->i_cformat = (n))))
5d90ab5a DC	75	#define XFS_IFORK_NEXTENTS(ip,w) \
	76	((w) == XFS_DATA_FORK ? \
	77	(ip)->i_d.di_nextents : \
cb8a004a DW	78	((w) == XFS_ATTR_FORK ? \
	79	(ip)->i_d.di_anextents : \
	80	(ip)->i_cnextents))
5d90ab5a DC	81	#define XFS_IFORK_NEXT_SET(ip,w,n) \
	82	((w) == XFS_DATA_FORK ? \
	83	((ip)->i_d.di_nextents = (n)) : \
cb8a004a DW	84	((w) == XFS_ATTR_FORK ? \
	85	((ip)->i_d.di_anextents = (n)) : \
	86	((ip)->i_cnextents = (n))))
5d90ab5a DC	87	#define XFS_IFORK_MAXEXT(ip, w) \
	88	(XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))
	89
cb8a004a DW	90	struct xfs_ifork xfs_iext_state_to_fork(struct xfs_inode ip, int state);
cb8a004a DW	91
5d90ab5a	92	int xfs_iformat_fork(struct xfs_inode , struct xfs_dinode );
d15188a1	93	void xfs_iflush_fork(struct xfs_inode , struct xfs_dinode ,
ff105f75	94	struct xfs_inode_log_item *, int);
5d90ab5a DC	95	void xfs_idestroy_fork(struct xfs_inode *, int);
	96	void xfs_idata_realloc(struct xfs_inode *, int, int);
	97	void xfs_iroot_realloc(struct xfs_inode *, int, int);
	98	int xfs_iread_extents(struct xfs_trans , struct xfs_inode , int);
	99	int xfs_iextents_copy(struct xfs_inode , struct xfs_bmbt_rec ,
	100	int);
219eec76	101	void xfs_init_local_fork(struct xfs_inode , int, const void , int);
5d90ab5a	102
b37d753d	103	xfs_extnum_t xfs_iext_count(struct xfs_ifork *ifp);
9788e059	104	void xfs_iext_insert(struct xfs_inode , struct xfs_iext_cursor cur,
26a75f67	105	struct xfs_bmbt_irec *, int);
9788e059	106	void xfs_iext_remove(struct xfs_inode , struct xfs_iext_cursor ,
cf455a62	107	int);
5d90ab5a	108	void xfs_iext_destroy(struct xfs_ifork *);
5d90ab5a	109
41db92d9 CH	110	bool xfs_iext_lookup_extent(struct xfs_inode *ip,
41db92d9 CH	111	struct xfs_ifork *ifp, xfs_fileoff_t bno,
9788e059 CH	112	struct xfs_iext_cursor *cur,
9788e059 CH	113	struct xfs_bmbt_irec *gotp);
d6fbe8fe CH	114	bool xfs_iext_lookup_extent_before(struct xfs_inode *ip,
d6fbe8fe CH	115	struct xfs_ifork ifp, xfs_fileoff_t end,
9788e059 CH	116	struct xfs_iext_cursor *cur,
	117	struct xfs_bmbt_irec *gotp);
	118	bool xfs_iext_get_extent(struct xfs_ifork *ifp,
	119	struct xfs_iext_cursor *cur,
41db92d9	120	struct xfs_bmbt_irec *gotp);
df926c07	121	void xfs_iext_update_extent(struct xfs_inode *ip, int state,
9788e059 CH	122	struct xfs_iext_cursor *cur,
	123	struct xfs_bmbt_irec *gotp);
	124
b37d753d CH	125	void xfs_iext_first(struct xfs_ifork , struct xfs_iext_cursor );
	126	void xfs_iext_last(struct xfs_ifork , struct xfs_iext_cursor );
	127	void xfs_iext_next(struct xfs_ifork , struct xfs_iext_cursor );
	128	void xfs_iext_prev(struct xfs_ifork , struct xfs_iext_cursor );
9788e059 CH	129
	130	static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp,
	131	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	132	{
	133	xfs_iext_next(ifp, cur);
	134	return xfs_iext_get_extent(ifp, cur, gotp);
	135	}
	136
	137	static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp,
	138	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	139	{
	140	xfs_iext_prev(ifp, cur);
	141	return xfs_iext_get_extent(ifp, cur, gotp);
	142	}
	143
	144	/*
	145	* Return the extent after cur in gotp without updating the cursor.
	146	*/
	147	static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp,
	148	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	149	{
	150	struct xfs_iext_cursor ncur = *cur;
	151
	152	xfs_iext_next(ifp, &ncur);
	153	return xfs_iext_get_extent(ifp, &ncur, gotp);
	154	}
	155
	156	/*
	157	* Return the extent before cur in gotp without updating the cursor.
	158	*/
	159	static inline bool xfs_iext_peek_prev_extent(struct xfs_ifork *ifp,
	160	struct xfs_iext_cursor cur, struct xfs_bmbt_irec gotp)
	161	{
	162	struct xfs_iext_cursor ncur = *cur;
	163
	164	xfs_iext_prev(ifp, &ncur);
	165	return xfs_iext_get_extent(ifp, &ncur, gotp);
	166	}
	167
	168	#define for_each_xfs_iext(ifp, ext, got) \
	169	for (xfs_iext_first((ifp), (ext)); \
	170	xfs_iext_get_extent((ifp), (ext), (got)); \
	171	xfs_iext_next((ifp), (ext)))
41db92d9	172
5d90ab5a DC	173	extern struct kmem_zone *xfs_ifork_zone;
5d90ab5a DC	174
cb8a004a DW	175	extern void xfs_ifork_init_cow(struct xfs_inode *ip);
cb8a004a DW	176
20e882d4 DW	177	typedef xfs_failaddr_t (xfs_ifork_verifier_t)(struct xfs_inode );
	178
	179	struct xfs_ifork_ops {
	180	xfs_ifork_verifier_t verify_symlink;
	181	xfs_ifork_verifier_t verify_dir;
	182	xfs_ifork_verifier_t verify_attr;
	183	};
	184	extern struct xfs_ifork_ops xfs_default_ifork_ops;
	185
	186	xfs_failaddr_t xfs_ifork_verify_data(struct xfs_inode *ip,
	187	struct xfs_ifork_ops *ops);
	188	xfs_failaddr_t xfs_ifork_verify_attr(struct xfs_inode *ip,
	189	struct xfs_ifork_ops *ops);
	190
5d90ab5a	191	#endif /* __XFS_INODE_FORK_H__ */