xref: /openbmc/linux/fs/xfs/libxfs/xfs_btree.h (revision 722db70f)
1508578f2SNishad Kamdar /* SPDX-License-Identifier: GPL-2.0 */
284be0ffcSDave Chinner /*
384be0ffcSDave Chinner  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
484be0ffcSDave Chinner  * All Rights Reserved.
584be0ffcSDave Chinner  */
684be0ffcSDave Chinner #ifndef __XFS_BTREE_H__
784be0ffcSDave Chinner #define	__XFS_BTREE_H__
884be0ffcSDave Chinner 
984be0ffcSDave Chinner struct xfs_buf;
1084be0ffcSDave Chinner struct xfs_inode;
1184be0ffcSDave Chinner struct xfs_mount;
1284be0ffcSDave Chinner struct xfs_trans;
13349e1c03SDarrick J. Wong struct xfs_ifork;
14be9fb17dSDave Chinner struct xfs_perag;
1584be0ffcSDave Chinner 
1684be0ffcSDave Chinner /*
1784be0ffcSDave Chinner  * Generic key, ptr and record wrapper structures.
1884be0ffcSDave Chinner  *
1984be0ffcSDave Chinner  * These are disk format structures, and are converted where necessary
2084be0ffcSDave Chinner  * by the btree specific code that needs to interpret them.
2184be0ffcSDave Chinner  */
2284be0ffcSDave Chinner union xfs_btree_ptr {
2384be0ffcSDave Chinner 	__be32			s;	/* short form ptr */
2484be0ffcSDave Chinner 	__be64			l;	/* long form ptr */
2584be0ffcSDave Chinner };
2684be0ffcSDave Chinner 
27a1d46cffSDarrick J. Wong /*
28a1d46cffSDarrick J. Wong  * The in-core btree key.  Overlapping btrees actually store two keys
29a1d46cffSDarrick J. Wong  * per pointer, so we reserve enough memory to hold both.  The __*bigkey
30a1d46cffSDarrick J. Wong  * items should never be accessed directly.
31a1d46cffSDarrick J. Wong  */
3284be0ffcSDave Chinner union xfs_btree_key {
33035e00acSDarrick J. Wong 	struct xfs_bmbt_key		bmbt;
3484be0ffcSDave Chinner 	xfs_bmdr_key_t			bmbr;	/* bmbt root block */
3584be0ffcSDave Chinner 	xfs_alloc_key_t			alloc;
36035e00acSDarrick J. Wong 	struct xfs_inobt_key		inobt;
37035e00acSDarrick J. Wong 	struct xfs_rmap_key		rmap;
38a1d46cffSDarrick J. Wong 	struct xfs_rmap_key		__rmap_bigkey[2];
391946b91cSDarrick J. Wong 	struct xfs_refcount_key		refc;
402c813ad6SDarrick J. Wong };
412c813ad6SDarrick J. Wong 
4284be0ffcSDave Chinner union xfs_btree_rec {
43035e00acSDarrick J. Wong 	struct xfs_bmbt_rec		bmbt;
4484be0ffcSDave Chinner 	xfs_bmdr_rec_t			bmbr;	/* bmbt root block */
45035e00acSDarrick J. Wong 	struct xfs_alloc_rec		alloc;
46035e00acSDarrick J. Wong 	struct xfs_inobt_rec		inobt;
47035e00acSDarrick J. Wong 	struct xfs_rmap_rec		rmap;
481946b91cSDarrick J. Wong 	struct xfs_refcount_rec		refc;
4984be0ffcSDave Chinner };
5084be0ffcSDave Chinner 
5184be0ffcSDave Chinner /*
5284be0ffcSDave Chinner  * This nonsense is to make -wlint happy.
5384be0ffcSDave Chinner  */
5484be0ffcSDave Chinner #define	XFS_LOOKUP_EQ	((xfs_lookup_t)XFS_LOOKUP_EQi)
5584be0ffcSDave Chinner #define	XFS_LOOKUP_LE	((xfs_lookup_t)XFS_LOOKUP_LEi)
5684be0ffcSDave Chinner #define	XFS_LOOKUP_GE	((xfs_lookup_t)XFS_LOOKUP_GEi)
5784be0ffcSDave Chinner 
5884be0ffcSDave Chinner #define	XFS_BTNUM_BNO	((xfs_btnum_t)XFS_BTNUM_BNOi)
5984be0ffcSDave Chinner #define	XFS_BTNUM_CNT	((xfs_btnum_t)XFS_BTNUM_CNTi)
6084be0ffcSDave Chinner #define	XFS_BTNUM_BMAP	((xfs_btnum_t)XFS_BTNUM_BMAPi)
6184be0ffcSDave Chinner #define	XFS_BTNUM_INO	((xfs_btnum_t)XFS_BTNUM_INOi)
6284be0ffcSDave Chinner #define	XFS_BTNUM_FINO	((xfs_btnum_t)XFS_BTNUM_FINOi)
63b8704944SDarrick J. Wong #define	XFS_BTNUM_RMAP	((xfs_btnum_t)XFS_BTNUM_RMAPi)
6446eeb521SDarrick J. Wong #define	XFS_BTNUM_REFC	((xfs_btnum_t)XFS_BTNUM_REFCi)
6584be0ffcSDave Chinner 
66c8ce540dSDarrick J. Wong uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum);
67af7d20fdSEric Sandeen 
6884be0ffcSDave Chinner /*
6984be0ffcSDave Chinner  * For logging record fields.
7084be0ffcSDave Chinner  */
71*722db70fSDave Chinner #define	XFS_BB_MAGIC		(1u << 0)
72*722db70fSDave Chinner #define	XFS_BB_LEVEL		(1u << 1)
73*722db70fSDave Chinner #define	XFS_BB_NUMRECS		(1u << 2)
74*722db70fSDave Chinner #define	XFS_BB_LEFTSIB		(1u << 3)
75*722db70fSDave Chinner #define	XFS_BB_RIGHTSIB		(1u << 4)
76*722db70fSDave Chinner #define	XFS_BB_BLKNO		(1u << 5)
77*722db70fSDave Chinner #define	XFS_BB_LSN		(1u << 6)
78*722db70fSDave Chinner #define	XFS_BB_UUID		(1u << 7)
79*722db70fSDave Chinner #define	XFS_BB_OWNER		(1u << 8)
8084be0ffcSDave Chinner #define	XFS_BB_NUM_BITS		5
81*722db70fSDave Chinner #define	XFS_BB_ALL_BITS		((1u << XFS_BB_NUM_BITS) - 1)
8284be0ffcSDave Chinner #define	XFS_BB_NUM_BITS_CRC	9
83*722db70fSDave Chinner #define	XFS_BB_ALL_BITS_CRC	((1u << XFS_BB_NUM_BITS_CRC) - 1)
8484be0ffcSDave Chinner 
8584be0ffcSDave Chinner /*
8684be0ffcSDave Chinner  * Generic stats interface
8784be0ffcSDave Chinner  */
8884be0ffcSDave Chinner #define XFS_BTREE_STATS_INC(cur, stat)	\
8911ef38afSDave Chinner 	XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat)
9084be0ffcSDave Chinner #define XFS_BTREE_STATS_ADD(cur, stat, val)	\
9111ef38afSDave Chinner 	XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val)
9284be0ffcSDave Chinner 
9384be0ffcSDave Chinner struct xfs_btree_ops {
9484be0ffcSDave Chinner 	/* size of the key and record structures */
9584be0ffcSDave Chinner 	size_t	key_len;
9684be0ffcSDave Chinner 	size_t	rec_len;
9784be0ffcSDave Chinner 
9884be0ffcSDave Chinner 	/* cursor operations */
9984be0ffcSDave Chinner 	struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
10084be0ffcSDave Chinner 	void	(*update_cursor)(struct xfs_btree_cur *src,
10184be0ffcSDave Chinner 				 struct xfs_btree_cur *dst);
10284be0ffcSDave Chinner 
10384be0ffcSDave Chinner 	/* update btree root pointer */
10484be0ffcSDave Chinner 	void	(*set_root)(struct xfs_btree_cur *cur,
105b5a6e5feSDarrick J. Wong 			    const union xfs_btree_ptr *nptr, int level_change);
10684be0ffcSDave Chinner 
10784be0ffcSDave Chinner 	/* block allocation / freeing */
10884be0ffcSDave Chinner 	int	(*alloc_block)(struct xfs_btree_cur *cur,
109deb06b9aSDarrick J. Wong 			       const union xfs_btree_ptr *start_bno,
11084be0ffcSDave Chinner 			       union xfs_btree_ptr *new_bno,
11184be0ffcSDave Chinner 			       int *stat);
11284be0ffcSDave Chinner 	int	(*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
11384be0ffcSDave Chinner 
11484be0ffcSDave Chinner 	/* update last record information */
11584be0ffcSDave Chinner 	void	(*update_lastrec)(struct xfs_btree_cur *cur,
11660e265f7SDarrick J. Wong 				  const struct xfs_btree_block *block,
11760e265f7SDarrick J. Wong 				  const union xfs_btree_rec *rec,
11884be0ffcSDave Chinner 				  int ptr, int reason);
11984be0ffcSDave Chinner 
12084be0ffcSDave Chinner 	/* records in block/level */
12184be0ffcSDave Chinner 	int	(*get_minrecs)(struct xfs_btree_cur *cur, int level);
12284be0ffcSDave Chinner 	int	(*get_maxrecs)(struct xfs_btree_cur *cur, int level);
12384be0ffcSDave Chinner 
12484be0ffcSDave Chinner 	/* records on disk.  Matter for the root in inode case. */
12584be0ffcSDave Chinner 	int	(*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
12684be0ffcSDave Chinner 
12784be0ffcSDave Chinner 	/* init values of btree structures */
12884be0ffcSDave Chinner 	void	(*init_key_from_rec)(union xfs_btree_key *key,
12923825cd1SDarrick J. Wong 				     const union xfs_btree_rec *rec);
13084be0ffcSDave Chinner 	void	(*init_rec_from_cur)(struct xfs_btree_cur *cur,
13184be0ffcSDave Chinner 				     union xfs_btree_rec *rec);
13284be0ffcSDave Chinner 	void	(*init_ptr_from_cur)(struct xfs_btree_cur *cur,
13384be0ffcSDave Chinner 				     union xfs_btree_ptr *ptr);
1342c813ad6SDarrick J. Wong 	void	(*init_high_key_from_rec)(union xfs_btree_key *key,
13523825cd1SDarrick J. Wong 					  const union xfs_btree_rec *rec);
13684be0ffcSDave Chinner 
13784be0ffcSDave Chinner 	/* difference between key value and cursor value */
138c8ce540dSDarrick J. Wong 	int64_t (*key_diff)(struct xfs_btree_cur *cur,
139d29d5577SDarrick J. Wong 			    const union xfs_btree_key *key);
14084be0ffcSDave Chinner 
1412c813ad6SDarrick J. Wong 	/*
1422c813ad6SDarrick J. Wong 	 * Difference between key2 and key1 -- positive if key1 > key2,
1432c813ad6SDarrick J. Wong 	 * negative if key1 < key2, and zero if equal.
1442c813ad6SDarrick J. Wong 	 */
145c8ce540dSDarrick J. Wong 	int64_t (*diff_two_keys)(struct xfs_btree_cur *cur,
146d29d5577SDarrick J. Wong 				 const union xfs_btree_key *key1,
147d29d5577SDarrick J. Wong 				 const union xfs_btree_key *key2);
1482c813ad6SDarrick J. Wong 
14984be0ffcSDave Chinner 	const struct xfs_buf_ops	*buf_ops;
15084be0ffcSDave Chinner 
15184be0ffcSDave Chinner 	/* check that k1 is lower than k2 */
15284be0ffcSDave Chinner 	int	(*keys_inorder)(struct xfs_btree_cur *cur,
1538e38dc88SDarrick J. Wong 				const union xfs_btree_key *k1,
1548e38dc88SDarrick J. Wong 				const union xfs_btree_key *k2);
15584be0ffcSDave Chinner 
15684be0ffcSDave Chinner 	/* check that r1 is lower than r2 */
15784be0ffcSDave Chinner 	int	(*recs_inorder)(struct xfs_btree_cur *cur,
1588e38dc88SDarrick J. Wong 				const union xfs_btree_rec *r1,
1598e38dc88SDarrick J. Wong 				const union xfs_btree_rec *r2);
16084be0ffcSDave Chinner };
16184be0ffcSDave Chinner 
16284be0ffcSDave Chinner /*
16384be0ffcSDave Chinner  * Reasons for the update_lastrec method to be called.
16484be0ffcSDave Chinner  */
16584be0ffcSDave Chinner #define LASTREC_UPDATE	0
16684be0ffcSDave Chinner #define LASTREC_INSREC	1
16784be0ffcSDave Chinner #define LASTREC_DELREC	2
16884be0ffcSDave Chinner 
16984be0ffcSDave Chinner 
170105f7d83SDarrick J. Wong union xfs_btree_irec {
171105f7d83SDarrick J. Wong 	struct xfs_alloc_rec_incore	a;
172105f7d83SDarrick J. Wong 	struct xfs_bmbt_irec		b;
173105f7d83SDarrick J. Wong 	struct xfs_inobt_rec_incore	i;
1744b8ed677SDarrick J. Wong 	struct xfs_rmap_irec		r;
1751946b91cSDarrick J. Wong 	struct xfs_refcount_irec	rc;
1761946b91cSDarrick J. Wong };
1771946b91cSDarrick J. Wong 
178c4aa10d0SDave Chinner /* Per-AG btree information. */
179c4aa10d0SDave Chinner struct xfs_btree_cur_ag {
180be9fb17dSDave Chinner 	struct xfs_perag		*pag;
181e06536a6SDarrick J. Wong 	union {
182c4aa10d0SDave Chinner 		struct xfs_buf		*agbp;
183e06536a6SDarrick J. Wong 		struct xbtree_afakeroot	*afake;	/* for staging cursor */
184e06536a6SDarrick J. Wong 	};
185c4aa10d0SDave Chinner 	union {
1861946b91cSDarrick J. Wong 		struct {
187efb79ea3SDarrick J. Wong 			unsigned int	nr_ops;	/* # record updates */
188efb79ea3SDarrick J. Wong 			unsigned int	shape_changes;	/* # of extent splits */
1891946b91cSDarrick J. Wong 		} refc;
190f6b428a4SBrian Foster 		struct {
191f6b428a4SBrian Foster 			bool		active;	/* allocation cursor state */
192f6b428a4SBrian Foster 		} abt;
193105f7d83SDarrick J. Wong 	};
19468422d90SDave Chinner };
19568422d90SDave Chinner 
19668422d90SDave Chinner /* Btree-in-inode cursor information */
19768422d90SDave Chinner struct xfs_btree_cur_ino {
19868422d90SDave Chinner 	struct xfs_inode		*ip;
199349e1c03SDarrick J. Wong 	struct xbtree_ifakeroot		*ifake;	/* for staging cursor */
20068422d90SDave Chinner 	int				allocated;
20168422d90SDave Chinner 	short				forksize;
20268422d90SDave Chinner 	char				whichfork;
20368422d90SDave Chinner 	char				flags;
20468422d90SDave Chinner /* We are converting a delalloc reservation */
20568422d90SDave Chinner #define	XFS_BTCUR_BMBT_WASDEL		(1 << 0)
20668422d90SDave Chinner 
20768422d90SDave Chinner /* For extent swap, ignore owner check in verifier */
20868422d90SDave Chinner #define	XFS_BTCUR_BMBT_INVALID_OWNER	(1 << 1)
20968422d90SDave Chinner };
21068422d90SDave Chinner 
2116ca444cfSDarrick J. Wong struct xfs_btree_level {
2126ca444cfSDarrick J. Wong 	/* buffer pointer */
2136ca444cfSDarrick J. Wong 	struct xfs_buf		*bp;
2146ca444cfSDarrick J. Wong 
2156ca444cfSDarrick J. Wong 	/* key/record number */
2166ca444cfSDarrick J. Wong 	uint16_t		ptr;
2176ca444cfSDarrick J. Wong 
2186ca444cfSDarrick J. Wong 	/* readahead info */
2196ca444cfSDarrick J. Wong #define XFS_BTCUR_LEFTRA	(1 << 0) /* left sibling has been read-ahead */
2206ca444cfSDarrick J. Wong #define XFS_BTCUR_RIGHTRA	(1 << 1) /* right sibling has been read-ahead */
2216ca444cfSDarrick J. Wong 	uint16_t		ra;
2226ca444cfSDarrick J. Wong };
2236ca444cfSDarrick J. Wong 
22484be0ffcSDave Chinner /*
22584be0ffcSDave Chinner  * Btree cursor structure.
22684be0ffcSDave Chinner  * This collects all information needed by the btree code in one place.
22784be0ffcSDave Chinner  */
228ae127f08SDarrick J. Wong struct xfs_btree_cur
22984be0ffcSDave Chinner {
23084be0ffcSDave Chinner 	struct xfs_trans	*bc_tp;	/* transaction we're in, if any */
23184be0ffcSDave Chinner 	struct xfs_mount	*bc_mp;	/* file system mount struct */
23284be0ffcSDave Chinner 	const struct xfs_btree_ops *bc_ops;
233e7720afaSDarrick J. Wong 	struct kmem_cache	*bc_cache; /* cursor cache */
23469724d92SDarrick J. Wong 	unsigned int		bc_flags; /* btree features - below */
23569724d92SDarrick J. Wong 	xfs_btnum_t		bc_btnum; /* identifies which btree type */
236105f7d83SDarrick J. Wong 	union xfs_btree_irec	bc_rec;	/* current insert/search record value */
237c8ce540dSDarrick J. Wong 	uint8_t			bc_nlevels; /* number of levels in the tree */
238c0643f6fSDarrick J. Wong 	uint8_t			bc_maxlevels; /* maximum levels for this btree type */
23969724d92SDarrick J. Wong 	int			bc_statoff; /* offset of btree stats array */
240be9fb17dSDave Chinner 
241be9fb17dSDave Chinner 	/*
242be9fb17dSDave Chinner 	 * Short btree pointers need an agno to be able to turn the pointers
243be9fb17dSDave Chinner 	 * into physical addresses for IO, so the btree cursor switches between
244be9fb17dSDave Chinner 	 * bc_ino and bc_ag based on whether XFS_BTREE_LONG_PTRS is set for the
245be9fb17dSDave Chinner 	 * cursor.
246be9fb17dSDave Chinner 	 */
24784be0ffcSDave Chinner 	union {
24868422d90SDave Chinner 		struct xfs_btree_cur_ag	bc_ag;
24968422d90SDave Chinner 		struct xfs_btree_cur_ino bc_ino;
25068422d90SDave Chinner 	};
2516ca444cfSDarrick J. Wong 
2526ca444cfSDarrick J. Wong 	/* Must be at the end of the struct! */
2536ca444cfSDarrick J. Wong 	struct xfs_btree_level	bc_levels[];
254ae127f08SDarrick J. Wong };
25584be0ffcSDave Chinner 
2566ca444cfSDarrick J. Wong /*
2576ca444cfSDarrick J. Wong  * Compute the size of a btree cursor that can handle a btree of a given
2586ca444cfSDarrick J. Wong  * height.  The bc_levels array handles node and leaf blocks, so its size
2596ca444cfSDarrick J. Wong  * is exactly nlevels.
2606ca444cfSDarrick J. Wong  */
2616ca444cfSDarrick J. Wong static inline size_t
2626ca444cfSDarrick J. Wong xfs_btree_cur_sizeof(unsigned int nlevels)
2636ca444cfSDarrick J. Wong {
2646ca444cfSDarrick J. Wong 	return struct_size((struct xfs_btree_cur *)NULL, bc_levels, nlevels);
2656ca444cfSDarrick J. Wong }
2666ca444cfSDarrick J. Wong 
26784be0ffcSDave Chinner /* cursor flags */
26884be0ffcSDave Chinner #define XFS_BTREE_LONG_PTRS		(1<<0)	/* pointers are 64bits long */
26984be0ffcSDave Chinner #define XFS_BTREE_ROOT_IN_INODE		(1<<1)	/* root may be variable size */
27084be0ffcSDave Chinner #define XFS_BTREE_LASTREC_UPDATE	(1<<2)	/* track last rec externally */
27184be0ffcSDave Chinner #define XFS_BTREE_CRC_BLOCKS		(1<<3)	/* uses extended btree blocks */
2722c813ad6SDarrick J. Wong #define XFS_BTREE_OVERLAPPING		(1<<4)	/* overlapping intervals */
273e06536a6SDarrick J. Wong /*
274e06536a6SDarrick J. Wong  * The root of this btree is a fakeroot structure so that we can stage a btree
275e06536a6SDarrick J. Wong  * rebuild without leaving it accessible via primary metadata.  The ops struct
276e06536a6SDarrick J. Wong  * is dynamically allocated and must be freed when the cursor is deleted.
277e06536a6SDarrick J. Wong  */
278e06536a6SDarrick J. Wong #define XFS_BTREE_STAGING		(1<<5)
27984be0ffcSDave Chinner 
28084be0ffcSDave Chinner #define	XFS_BTREE_NOERROR	0
28184be0ffcSDave Chinner #define	XFS_BTREE_ERROR		1
28284be0ffcSDave Chinner 
28384be0ffcSDave Chinner /*
28484be0ffcSDave Chinner  * Convert from buffer to btree block header.
28584be0ffcSDave Chinner  */
28684be0ffcSDave Chinner #define	XFS_BUF_TO_BLOCK(bp)	((struct xfs_btree_block *)((bp)->b_addr))
28784be0ffcSDave Chinner 
28852c732eeSDarrick J. Wong /*
28952c732eeSDarrick J. Wong  * Internal long and short btree block checks.  They return NULL if the
29052c732eeSDarrick J. Wong  * block is ok or the address of the failed check otherwise.
29152c732eeSDarrick J. Wong  */
29252c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur,
29352c732eeSDarrick J. Wong 		struct xfs_btree_block *block, int level, struct xfs_buf *bp);
29452c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur,
29552c732eeSDarrick J. Wong 		struct xfs_btree_block *block, int level, struct xfs_buf *bp);
29684be0ffcSDave Chinner 
29784be0ffcSDave Chinner /*
29884be0ffcSDave Chinner  * Check that block header is ok.
29984be0ffcSDave Chinner  */
30084be0ffcSDave Chinner int
30184be0ffcSDave Chinner xfs_btree_check_block(
30284be0ffcSDave Chinner 	struct xfs_btree_cur	*cur,	/* btree cursor */
30384be0ffcSDave Chinner 	struct xfs_btree_block	*block,	/* generic btree block pointer */
30484be0ffcSDave Chinner 	int			level,	/* level of the btree block */
30584be0ffcSDave Chinner 	struct xfs_buf		*bp);	/* buffer containing block, if any */
30684be0ffcSDave Chinner 
30784be0ffcSDave Chinner /*
30884be0ffcSDave Chinner  * Check that (long) pointer is ok.
30984be0ffcSDave Chinner  */
310f135761aSDarrick J. Wong bool					/* error (0 or EFSCORRUPTED) */
31184be0ffcSDave Chinner xfs_btree_check_lptr(
31284be0ffcSDave Chinner 	struct xfs_btree_cur	*cur,	/* btree cursor */
313f135761aSDarrick J. Wong 	xfs_fsblock_t		fsbno,	/* btree block disk address */
314f135761aSDarrick J. Wong 	int			level);	/* btree block level */
315f135761aSDarrick J. Wong 
316f135761aSDarrick J. Wong /*
317f135761aSDarrick J. Wong  * Check that (short) pointer is ok.
318f135761aSDarrick J. Wong  */
319f135761aSDarrick J. Wong bool					/* error (0 or EFSCORRUPTED) */
320f135761aSDarrick J. Wong xfs_btree_check_sptr(
321f135761aSDarrick J. Wong 	struct xfs_btree_cur	*cur,	/* btree cursor */
322f135761aSDarrick J. Wong 	xfs_agblock_t		agbno,	/* btree block disk address */
32384be0ffcSDave Chinner 	int			level);	/* btree block level */
32484be0ffcSDave Chinner 
32584be0ffcSDave Chinner /*
32684be0ffcSDave Chinner  * Delete the btree cursor.
32784be0ffcSDave Chinner  */
32884be0ffcSDave Chinner void
32984be0ffcSDave Chinner xfs_btree_del_cursor(
330ae127f08SDarrick J. Wong 	struct xfs_btree_cur	*cur,	/* btree cursor */
33184be0ffcSDave Chinner 	int			error);	/* del because of error */
33284be0ffcSDave Chinner 
33384be0ffcSDave Chinner /*
33484be0ffcSDave Chinner  * Duplicate the btree cursor.
33584be0ffcSDave Chinner  * Allocate a new one, copy the record, re-get the buffers.
33684be0ffcSDave Chinner  */
33784be0ffcSDave Chinner int					/* error */
33884be0ffcSDave Chinner xfs_btree_dup_cursor(
339ae127f08SDarrick J. Wong 	struct xfs_btree_cur		*cur,	/* input cursor */
340ae127f08SDarrick J. Wong 	struct xfs_btree_cur		**ncur);/* output cursor */
34184be0ffcSDave Chinner 
34284be0ffcSDave Chinner /*
34384be0ffcSDave Chinner  * Compute first and last byte offsets for the fields given.
34484be0ffcSDave Chinner  * Interprets the offsets table, which contains struct field offsets.
34584be0ffcSDave Chinner  */
34684be0ffcSDave Chinner void
34784be0ffcSDave Chinner xfs_btree_offsets(
348*722db70fSDave Chinner 	uint32_t		fields,	/* bitmask of fields */
34984be0ffcSDave Chinner 	const short		*offsets,/* table of field offsets */
35084be0ffcSDave Chinner 	int			nbits,	/* number of bits to inspect */
35184be0ffcSDave Chinner 	int			*first,	/* output: first byte offset */
35284be0ffcSDave Chinner 	int			*last);	/* output: last byte offset */
35384be0ffcSDave Chinner 
35484be0ffcSDave Chinner /*
35584be0ffcSDave Chinner  * Get a buffer for the block, return it read in.
35684be0ffcSDave Chinner  * Long-form addressing.
35784be0ffcSDave Chinner  */
35884be0ffcSDave Chinner int					/* error */
35984be0ffcSDave Chinner xfs_btree_read_bufl(
36084be0ffcSDave Chinner 	struct xfs_mount	*mp,	/* file system mount point */
36184be0ffcSDave Chinner 	struct xfs_trans	*tp,	/* transaction pointer */
36284be0ffcSDave Chinner 	xfs_fsblock_t		fsbno,	/* file system block number */
36384be0ffcSDave Chinner 	struct xfs_buf		**bpp,	/* buffer for fsbno */
36484be0ffcSDave Chinner 	int			refval,	/* ref count value for buffer */
36584be0ffcSDave Chinner 	const struct xfs_buf_ops *ops);
36684be0ffcSDave Chinner 
36784be0ffcSDave Chinner /*
36884be0ffcSDave Chinner  * Read-ahead the block, don't wait for it, don't return a buffer.
36984be0ffcSDave Chinner  * Long-form addressing.
37084be0ffcSDave Chinner  */
37184be0ffcSDave Chinner void					/* error */
37284be0ffcSDave Chinner xfs_btree_reada_bufl(
37384be0ffcSDave Chinner 	struct xfs_mount	*mp,	/* file system mount point */
37484be0ffcSDave Chinner 	xfs_fsblock_t		fsbno,	/* file system block number */
37584be0ffcSDave Chinner 	xfs_extlen_t		count,	/* count of filesystem blocks */
37684be0ffcSDave Chinner 	const struct xfs_buf_ops *ops);
37784be0ffcSDave Chinner 
37884be0ffcSDave Chinner /*
37984be0ffcSDave Chinner  * Read-ahead the block, don't wait for it, don't return a buffer.
38084be0ffcSDave Chinner  * Short-form addressing.
38184be0ffcSDave Chinner  */
38284be0ffcSDave Chinner void					/* error */
38384be0ffcSDave Chinner xfs_btree_reada_bufs(
38484be0ffcSDave Chinner 	struct xfs_mount	*mp,	/* file system mount point */
38584be0ffcSDave Chinner 	xfs_agnumber_t		agno,	/* allocation group number */
38684be0ffcSDave Chinner 	xfs_agblock_t		agbno,	/* allocation group block number */
38784be0ffcSDave Chinner 	xfs_extlen_t		count,	/* count of filesystem blocks */
38884be0ffcSDave Chinner 	const struct xfs_buf_ops *ops);
38984be0ffcSDave Chinner 
39084be0ffcSDave Chinner /*
39184be0ffcSDave Chinner  * Initialise a new btree block header
39284be0ffcSDave Chinner  */
39384be0ffcSDave Chinner void
39484be0ffcSDave Chinner xfs_btree_init_block(
39584be0ffcSDave Chinner 	struct xfs_mount *mp,
39684be0ffcSDave Chinner 	struct xfs_buf	*bp,
397b6f41e44SEric Sandeen 	xfs_btnum_t	btnum,
39884be0ffcSDave Chinner 	__u16		level,
39984be0ffcSDave Chinner 	__u16		numrecs,
400f5b999c0SEric Sandeen 	__u64		owner);
40184be0ffcSDave Chinner 
40284be0ffcSDave Chinner void
40384be0ffcSDave Chinner xfs_btree_init_block_int(
40484be0ffcSDave Chinner 	struct xfs_mount	*mp,
40584be0ffcSDave Chinner 	struct xfs_btree_block	*buf,
40684be0ffcSDave Chinner 	xfs_daddr_t		blkno,
407b6f41e44SEric Sandeen 	xfs_btnum_t		btnum,
40884be0ffcSDave Chinner 	__u16			level,
40984be0ffcSDave Chinner 	__u16			numrecs,
41084be0ffcSDave Chinner 	__u64			owner,
41184be0ffcSDave Chinner 	unsigned int		flags);
41284be0ffcSDave Chinner 
41384be0ffcSDave Chinner /*
41484be0ffcSDave Chinner  * Common btree core entry points.
41584be0ffcSDave Chinner  */
41684be0ffcSDave Chinner int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
41784be0ffcSDave Chinner int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
41884be0ffcSDave Chinner int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
41984be0ffcSDave Chinner int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
42084be0ffcSDave Chinner int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
42184be0ffcSDave Chinner int xfs_btree_insert(struct xfs_btree_cur *, int *);
42284be0ffcSDave Chinner int xfs_btree_delete(struct xfs_btree_cur *, int *);
42384be0ffcSDave Chinner int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
424c8ce540dSDarrick J. Wong int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner,
42584be0ffcSDave Chinner 			   struct list_head *buffer_list);
42684be0ffcSDave Chinner 
42784be0ffcSDave Chinner /*
42884be0ffcSDave Chinner  * btree block CRC helpers
42984be0ffcSDave Chinner  */
43084be0ffcSDave Chinner void xfs_btree_lblock_calc_crc(struct xfs_buf *);
43184be0ffcSDave Chinner bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
43284be0ffcSDave Chinner void xfs_btree_sblock_calc_crc(struct xfs_buf *);
43384be0ffcSDave Chinner bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
43484be0ffcSDave Chinner 
43584be0ffcSDave Chinner /*
43684be0ffcSDave Chinner  * Internal btree helpers also used by xfs_bmap.c.
43784be0ffcSDave Chinner  */
438*722db70fSDave Chinner void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, uint32_t);
43984be0ffcSDave Chinner void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
44084be0ffcSDave Chinner 
44184be0ffcSDave Chinner /*
44284be0ffcSDave Chinner  * Helpers.
44384be0ffcSDave Chinner  */
44460e265f7SDarrick J. Wong static inline int xfs_btree_get_numrecs(const struct xfs_btree_block *block)
44584be0ffcSDave Chinner {
44684be0ffcSDave Chinner 	return be16_to_cpu(block->bb_numrecs);
44784be0ffcSDave Chinner }
44884be0ffcSDave Chinner 
44984be0ffcSDave Chinner static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
450c8ce540dSDarrick J. Wong 		uint16_t numrecs)
45184be0ffcSDave Chinner {
45284be0ffcSDave Chinner 	block->bb_numrecs = cpu_to_be16(numrecs);
45384be0ffcSDave Chinner }
45484be0ffcSDave Chinner 
45560e265f7SDarrick J. Wong static inline int xfs_btree_get_level(const struct xfs_btree_block *block)
45684be0ffcSDave Chinner {
45784be0ffcSDave Chinner 	return be16_to_cpu(block->bb_level);
45884be0ffcSDave Chinner }
45984be0ffcSDave Chinner 
46084be0ffcSDave Chinner 
46184be0ffcSDave Chinner /*
46284be0ffcSDave Chinner  * Min and max functions for extlen, agblock, fileoff, and filblks types.
46384be0ffcSDave Chinner  */
46484be0ffcSDave Chinner #define	XFS_EXTLEN_MIN(a,b)	min_t(xfs_extlen_t, (a), (b))
46584be0ffcSDave Chinner #define	XFS_EXTLEN_MAX(a,b)	max_t(xfs_extlen_t, (a), (b))
46684be0ffcSDave Chinner #define	XFS_AGBLOCK_MIN(a,b)	min_t(xfs_agblock_t, (a), (b))
46784be0ffcSDave Chinner #define	XFS_AGBLOCK_MAX(a,b)	max_t(xfs_agblock_t, (a), (b))
46884be0ffcSDave Chinner #define	XFS_FILEOFF_MIN(a,b)	min_t(xfs_fileoff_t, (a), (b))
46984be0ffcSDave Chinner #define	XFS_FILEOFF_MAX(a,b)	max_t(xfs_fileoff_t, (a), (b))
47084be0ffcSDave Chinner #define	XFS_FILBLKS_MIN(a,b)	min_t(xfs_filblks_t, (a), (b))
47184be0ffcSDave Chinner #define	XFS_FILBLKS_MAX(a,b)	max_t(xfs_filblks_t, (a), (b))
47284be0ffcSDave Chinner 
473a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp);
474a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp,
475a6a781a5SDarrick J. Wong 		unsigned int max_recs);
476a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp,
477a6a781a5SDarrick J. Wong 		uint64_t owner);
478a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp,
479a6a781a5SDarrick J. Wong 		unsigned int max_recs);
4808368a601SDarrick J. Wong 
4811b236ad7SDarrick J. Wong unsigned int xfs_btree_compute_maxlevels(const unsigned int *limits,
4821b236ad7SDarrick J. Wong 		unsigned long long records);
4831b236ad7SDarrick J. Wong unsigned long long xfs_btree_calc_size(const unsigned int *limits,
4841b236ad7SDarrick J. Wong 		unsigned long long records);
4859ec69120SDarrick J. Wong unsigned int xfs_btree_space_to_height(const unsigned int *limits,
4869ec69120SDarrick J. Wong 		unsigned long long blocks);
487c5ab131bSDarrick J. Wong 
488e7ee96dfSDarrick J. Wong /*
489e7ee96dfSDarrick J. Wong  * Return codes for the query range iterator function are 0 to continue
490e7ee96dfSDarrick J. Wong  * iterating, and non-zero to stop iterating.  Any non-zero value will be
491e7ee96dfSDarrick J. Wong  * passed up to the _query_range caller.  The special value -ECANCELED can be
492e7ee96dfSDarrick J. Wong  * used to stop iteration, because _query_range never generates that error
493e7ee96dfSDarrick J. Wong  * code on its own.
494e7ee96dfSDarrick J. Wong  */
495105f7d83SDarrick J. Wong typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur,
496159eb69dSDarrick J. Wong 		const union xfs_btree_rec *rec, void *priv);
497105f7d83SDarrick J. Wong 
498105f7d83SDarrick J. Wong int xfs_btree_query_range(struct xfs_btree_cur *cur,
49904dcb474SDarrick J. Wong 		const union xfs_btree_irec *low_rec,
50004dcb474SDarrick J. Wong 		const union xfs_btree_irec *high_rec,
501105f7d83SDarrick J. Wong 		xfs_btree_query_range_fn fn, void *priv);
502e9a2599aSDarrick J. Wong int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn,
503e9a2599aSDarrick J. Wong 		void *priv);
504105f7d83SDarrick J. Wong 
50528a89567SDarrick J. Wong typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level,
50628a89567SDarrick J. Wong 		void *data);
507e992ae8aSDarrick J. Wong /* Visit record blocks. */
508e992ae8aSDarrick J. Wong #define XFS_BTREE_VISIT_RECORDS		(1 << 0)
509e992ae8aSDarrick J. Wong /* Visit leaf blocks. */
510e992ae8aSDarrick J. Wong #define XFS_BTREE_VISIT_LEAVES		(1 << 1)
511e992ae8aSDarrick J. Wong /* Visit all blocks. */
512e992ae8aSDarrick J. Wong #define XFS_BTREE_VISIT_ALL		(XFS_BTREE_VISIT_RECORDS | \
513e992ae8aSDarrick J. Wong 					 XFS_BTREE_VISIT_LEAVES)
51428a89567SDarrick J. Wong int xfs_btree_visit_blocks(struct xfs_btree_cur *cur,
515e992ae8aSDarrick J. Wong 		xfs_btree_visit_blocks_fn fn, unsigned int flags, void *data);
51628a89567SDarrick J. Wong 
517c611cc03SDarrick J. Wong int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks);
518c611cc03SDarrick J. Wong 
51926788097SDarrick J. Wong union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n,
52026788097SDarrick J. Wong 		struct xfs_btree_block *block);
52126788097SDarrick J. Wong union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n,
52226788097SDarrick J. Wong 		struct xfs_btree_block *block);
52326788097SDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n,
52426788097SDarrick J. Wong 		struct xfs_btree_block *block);
52526788097SDarrick J. Wong union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n,
52626788097SDarrick J. Wong 		struct xfs_btree_block *block);
52726788097SDarrick J. Wong int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level,
52832816fd7SDarrick J. Wong 		const union xfs_btree_ptr *pp, struct xfs_btree_block **blkp);
52926788097SDarrick J. Wong struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur,
53026788097SDarrick J. Wong 		int level, struct xfs_buf **bpp);
53132816fd7SDarrick J. Wong bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur,
53232816fd7SDarrick J. Wong 		const union xfs_btree_ptr *ptr);
533cc3e0948SDarrick J. Wong int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur,
534cc3e0948SDarrick J. Wong 				const union xfs_btree_ptr *a,
535cc3e0948SDarrick J. Wong 				const union xfs_btree_ptr *b);
536cc3e0948SDarrick J. Wong void xfs_btree_get_sibling(struct xfs_btree_cur *cur,
537cc3e0948SDarrick J. Wong 			   struct xfs_btree_block *block,
538cc3e0948SDarrick J. Wong 			   union xfs_btree_ptr *ptr, int lr);
5392fdbec5cSDarrick J. Wong void xfs_btree_get_keys(struct xfs_btree_cur *cur,
5402fdbec5cSDarrick J. Wong 		struct xfs_btree_block *block, union xfs_btree_key *key);
5412fdbec5cSDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur,
5422fdbec5cSDarrick J. Wong 		union xfs_btree_key *key);
54332816fd7SDarrick J. Wong int xfs_btree_has_record(struct xfs_btree_cur *cur,
54432816fd7SDarrick J. Wong 		const union xfs_btree_irec *low,
54532816fd7SDarrick J. Wong 		const union xfs_btree_irec *high, bool *exists);
54608daa3ccSDarrick J. Wong bool xfs_btree_has_more_records(struct xfs_btree_cur *cur);
547349e1c03SDarrick J. Wong struct xfs_ifork *xfs_btree_ifork_ptr(struct xfs_btree_cur *cur);
54826788097SDarrick J. Wong 
54927d9ee57SDarrick J. Wong /* Does this cursor point to the last block in the given level? */
55027d9ee57SDarrick J. Wong static inline bool
55127d9ee57SDarrick J. Wong xfs_btree_islastblock(
552ae127f08SDarrick J. Wong 	struct xfs_btree_cur	*cur,
55327d9ee57SDarrick J. Wong 	int			level)
55427d9ee57SDarrick J. Wong {
55527d9ee57SDarrick J. Wong 	struct xfs_btree_block	*block;
55627d9ee57SDarrick J. Wong 	struct xfs_buf		*bp;
55727d9ee57SDarrick J. Wong 
55827d9ee57SDarrick J. Wong 	block = xfs_btree_get_block(cur, level, &bp);
55927d9ee57SDarrick J. Wong 	ASSERT(block && xfs_btree_check_block(cur, block, level, bp) == 0);
56027d9ee57SDarrick J. Wong 
56127d9ee57SDarrick J. Wong 	if (cur->bc_flags & XFS_BTREE_LONG_PTRS)
56227d9ee57SDarrick J. Wong 		return block->bb_u.l.bb_rightsib == cpu_to_be64(NULLFSBLOCK);
56327d9ee57SDarrick J. Wong 	return block->bb_u.s.bb_rightsib == cpu_to_be32(NULLAGBLOCK);
56427d9ee57SDarrick J. Wong }
56527d9ee57SDarrick J. Wong 
56660e3d707SDarrick J. Wong void xfs_btree_set_ptr_null(struct xfs_btree_cur *cur,
56760e3d707SDarrick J. Wong 		union xfs_btree_ptr *ptr);
56832816fd7SDarrick J. Wong int xfs_btree_get_buf_block(struct xfs_btree_cur *cur,
56932816fd7SDarrick J. Wong 		const union xfs_btree_ptr *ptr, struct xfs_btree_block **block,
57032816fd7SDarrick J. Wong 		struct xfs_buf **bpp);
57160e3d707SDarrick J. Wong void xfs_btree_set_sibling(struct xfs_btree_cur *cur,
57232816fd7SDarrick J. Wong 		struct xfs_btree_block *block, const union xfs_btree_ptr *ptr,
57360e3d707SDarrick J. Wong 		int lr);
57460e3d707SDarrick J. Wong void xfs_btree_init_block_cur(struct xfs_btree_cur *cur,
57560e3d707SDarrick J. Wong 		struct xfs_buf *bp, int level, int numrecs);
57660e3d707SDarrick J. Wong void xfs_btree_copy_ptrs(struct xfs_btree_cur *cur,
57760e3d707SDarrick J. Wong 		union xfs_btree_ptr *dst_ptr,
57860e3d707SDarrick J. Wong 		const union xfs_btree_ptr *src_ptr, int numptrs);
57960e3d707SDarrick J. Wong void xfs_btree_copy_keys(struct xfs_btree_cur *cur,
58032816fd7SDarrick J. Wong 		union xfs_btree_key *dst_key,
58132816fd7SDarrick J. Wong 		const union xfs_btree_key *src_key, int numkeys);
58260e3d707SDarrick J. Wong 
58356370ea6SDarrick J. Wong static inline struct xfs_btree_cur *
58456370ea6SDarrick J. Wong xfs_btree_alloc_cursor(
58556370ea6SDarrick J. Wong 	struct xfs_mount	*mp,
58656370ea6SDarrick J. Wong 	struct xfs_trans	*tp,
587c940a0c5SDarrick J. Wong 	xfs_btnum_t		btnum,
5889fa47bdcSDarrick J. Wong 	uint8_t			maxlevels,
589e7720afaSDarrick J. Wong 	struct kmem_cache	*cache)
59056370ea6SDarrick J. Wong {
59156370ea6SDarrick J. Wong 	struct xfs_btree_cur	*cur;
59256370ea6SDarrick J. Wong 
5939fa47bdcSDarrick J. Wong 	cur = kmem_cache_zalloc(cache, GFP_NOFS | __GFP_NOFAIL);
59456370ea6SDarrick J. Wong 	cur->bc_tp = tp;
59556370ea6SDarrick J. Wong 	cur->bc_mp = mp;
59656370ea6SDarrick J. Wong 	cur->bc_btnum = btnum;
597c940a0c5SDarrick J. Wong 	cur->bc_maxlevels = maxlevels;
5989fa47bdcSDarrick J. Wong 	cur->bc_cache = cache;
59956370ea6SDarrick J. Wong 
60056370ea6SDarrick J. Wong 	return cur;
60156370ea6SDarrick J. Wong }
60256370ea6SDarrick J. Wong 
6039fa47bdcSDarrick J. Wong int __init xfs_btree_init_cur_caches(void);
6049fa47bdcSDarrick J. Wong void xfs_btree_destroy_cur_caches(void);
6059fa47bdcSDarrick J. Wong 
60684be0ffcSDave Chinner #endif	/* __XFS_BTREE_H__ */
607