[deliverable/linux.git] / fs / xfs / xfs_btree.h

/*
 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * 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.
 *
 * 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_BTREE_H__
#define	__XFS_BTREE_H__

struct xfs_buf;
struct xfs_bmap_free;
struct xfs_inode;
struct xfs_mount;
struct xfs_trans;

extern kmem_zone_t	*xfs_btree_cur_zone;

/*
 * Generic key, ptr and record wrapper structures.
 *
 * These are disk format structures, and are converted where necessary
 * by the btree specific code that needs to interpret them.
 */
union xfs_btree_ptr {
	__be32			s;	/* short form ptr */
	__be64			l;	/* long form ptr */
};

union xfs_btree_key {
	xfs_bmbt_key_t		bmbt;
	xfs_bmdr_key_t		bmbr;	/* bmbt root block */
	xfs_alloc_key_t		alloc;
	xfs_inobt_key_t		inobt;
};

union xfs_btree_rec {
	xfs_bmbt_rec_t		bmbt;
	xfs_bmdr_rec_t		bmbr;	/* bmbt root block */
	xfs_alloc_rec_t		alloc;
	xfs_inobt_rec_t		inobt;
};

/*
 * This nonsense is to make -wlint happy.
 */
#define	XFS_LOOKUP_EQ	((xfs_lookup_t)XFS_LOOKUP_EQi)
#define	XFS_LOOKUP_LE	((xfs_lookup_t)XFS_LOOKUP_LEi)
#define	XFS_LOOKUP_GE	((xfs_lookup_t)XFS_LOOKUP_GEi)

#define	XFS_BTNUM_BNO	((xfs_btnum_t)XFS_BTNUM_BNOi)
#define	XFS_BTNUM_CNT	((xfs_btnum_t)XFS_BTNUM_CNTi)
#define	XFS_BTNUM_BMAP	((xfs_btnum_t)XFS_BTNUM_BMAPi)
#define	XFS_BTNUM_INO	((xfs_btnum_t)XFS_BTNUM_INOi)

/*
 * For logging record fields.
 */
#define	XFS_BB_MAGIC		(1 << 0)
#define	XFS_BB_LEVEL		(1 << 1)
#define	XFS_BB_NUMRECS		(1 << 2)
#define	XFS_BB_LEFTSIB		(1 << 3)
#define	XFS_BB_RIGHTSIB		(1 << 4)
#define	XFS_BB_BLKNO		(1 << 5)
#define	XFS_BB_LSN		(1 << 6)
#define	XFS_BB_UUID		(1 << 7)
#define	XFS_BB_OWNER		(1 << 8)
#define	XFS_BB_NUM_BITS		5
#define	XFS_BB_ALL_BITS		((1 << XFS_BB_NUM_BITS) - 1)
#define	XFS_BB_NUM_BITS_CRC	9
#define	XFS_BB_ALL_BITS_CRC	((1 << XFS_BB_NUM_BITS_CRC) - 1)

/*
 * Generic stats interface
 */
#define __XFS_BTREE_STATS_INC(type, stat) \
	XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
#define XFS_BTREE_STATS_INC(cur, stat)  \
do {    \
	switch (cur->bc_btnum) {  \
	case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break;	\
	case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break;	\
	case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break;	\
	case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break;	\
	case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;	\
	}       \
} while (0)

#define __XFS_BTREE_STATS_ADD(type, stat, val) \
	XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
#define XFS_BTREE_STATS_ADD(cur, stat, val)  \
do {    \
	switch (cur->bc_btnum) {  \
	case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
	case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
	case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
	case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
	case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;	\
	}       \
} while (0)

#define	XFS_BTREE_MAXLEVELS	8	/* max of all btrees */

struct xfs_btree_ops {
	/* size of the key and record structures */
	size_t	key_len;
	size_t	rec_len;

	/* cursor operations */
	struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
	void	(*update_cursor)(struct xfs_btree_cur *src,
				 struct xfs_btree_cur *dst);

	/* update btree root pointer */
	void	(*set_root)(struct xfs_btree_cur *cur,
			    union xfs_btree_ptr *nptr, int level_change);

	/* block allocation / freeing */
	int	(*alloc_block)(struct xfs_btree_cur *cur,
			       union xfs_btree_ptr *start_bno,
			       union xfs_btree_ptr *new_bno,
			       int length, int *stat);
	int	(*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);

	/* update last record information */
	void	(*update_lastrec)(struct xfs_btree_cur *cur,
				  struct xfs_btree_block *block,
				  union xfs_btree_rec *rec,
				  int ptr, int reason);

	/* records in block/level */
	int	(*get_minrecs)(struct xfs_btree_cur *cur, int level);
	int	(*get_maxrecs)(struct xfs_btree_cur *cur, int level);

	/* records on disk.  Matter for the root in inode case. */
	int	(*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);

	/* init values of btree structures */
	void	(*init_key_from_rec)(union xfs_btree_key *key,
				     union xfs_btree_rec *rec);
	void	(*init_rec_from_key)(union xfs_btree_key *key,
				     union xfs_btree_rec *rec);
	void	(*init_rec_from_cur)(struct xfs_btree_cur *cur,
				     union xfs_btree_rec *rec);
	void	(*init_ptr_from_cur)(struct xfs_btree_cur *cur,
				     union xfs_btree_ptr *ptr);

	/* difference between key value and cursor value */
	__int64_t (*key_diff)(struct xfs_btree_cur *cur,
			      union xfs_btree_key *key);

	const struct xfs_buf_ops	*buf_ops;

#if defined(DEBUG) || defined(XFS_WARN)
	/* check that k1 is lower than k2 */
	int	(*keys_inorder)(struct xfs_btree_cur *cur,
				union xfs_btree_key *k1,
				union xfs_btree_key *k2);

	/* check that r1 is lower than r2 */
	int	(*recs_inorder)(struct xfs_btree_cur *cur,
				union xfs_btree_rec *r1,
				union xfs_btree_rec *r2);
#endif
};

/*
 * Reasons for the update_lastrec method to be called.
 */
#define LASTREC_UPDATE	0
#define LASTREC_INSREC	1
#define LASTREC_DELREC	2


/*
 * Btree cursor structure.
 * This collects all information needed by the btree code in one place.
 */
typedef struct xfs_btree_cur
{
	struct xfs_trans	*bc_tp;	/* transaction we're in, if any */
	struct xfs_mount	*bc_mp;	/* file system mount struct */
	const struct xfs_btree_ops *bc_ops;
	uint			bc_flags; /* btree features - below */
	union {
		xfs_alloc_rec_incore_t	a;
		xfs_bmbt_irec_t		b;
		xfs_inobt_rec_incore_t	i;
	}		bc_rec;		/* current insert/search record value */
	struct xfs_buf	*bc_bufs[XFS_BTREE_MAXLEVELS];	/* buf ptr per level */
	int		bc_ptrs[XFS_BTREE_MAXLEVELS];	/* key/record # */
	__uint8_t	bc_ra[XFS_BTREE_MAXLEVELS];	/* readahead bits */
#define	XFS_BTCUR_LEFTRA	1	/* left sibling has been read-ahead */
#define	XFS_BTCUR_RIGHTRA	2	/* right sibling has been read-ahead */
	__uint8_t	bc_nlevels;	/* number of levels in the tree */
	__uint8_t	bc_blocklog;	/* log2(blocksize) of btree blocks */
	xfs_btnum_t	bc_btnum;	/* identifies which btree type */
	union {
		struct {			/* needed for BNO, CNT, INO */
			struct xfs_buf	*agbp;	/* agf/agi buffer pointer */
			xfs_agnumber_t	agno;	/* ag number */
		} a;
		struct {			/* needed for BMAP */
			struct xfs_inode *ip;	/* pointer to our inode */
			struct xfs_bmap_free *flist;	/* list to free after */
			xfs_fsblock_t	firstblock;	/* 1st blk allocated */
			int		allocated;	/* count of alloced */
			short		forksize;	/* fork's inode space */
			char		whichfork;	/* data or attr fork */
			char		flags;		/* flags */
#define	XFS_BTCUR_BPRV_WASDEL	1			/* was delayed */
		} b;
	}		bc_private;	/* per-btree type data */
} xfs_btree_cur_t;

/* cursor flags */
#define XFS_BTREE_LONG_PTRS		(1<<0)	/* pointers are 64bits long */
#define XFS_BTREE_ROOT_IN_INODE		(1<<1)	/* root may be variable size */
#define XFS_BTREE_LASTREC_UPDATE	(1<<2)	/* track last rec externally */
#define XFS_BTREE_CRC_BLOCKS		(1<<3)	/* uses extended btree blocks */


#define	XFS_BTREE_NOERROR	0
#define	XFS_BTREE_ERROR		1

/*
 * Convert from buffer to btree block header.
 */
#define	XFS_BUF_TO_BLOCK(bp)	((struct xfs_btree_block *)((bp)->b_addr))


/*
 * Check that block header is ok.
 */
int
xfs_btree_check_block(
	struct xfs_btree_cur	*cur,	/* btree cursor */
	struct xfs_btree_block	*block,	/* generic btree block pointer */
	int			level,	/* level of the btree block */
	struct xfs_buf		*bp);	/* buffer containing block, if any */

/*
 * Check that (long) pointer is ok.
 */
int					/* error (0 or EFSCORRUPTED) */
xfs_btree_check_lptr(
	struct xfs_btree_cur	*cur,	/* btree cursor */
	xfs_dfsbno_t		ptr,	/* btree block disk address */
	int			level);	/* btree block level */

/*
 * Delete the btree cursor.
 */
void
xfs_btree_del_cursor(
	xfs_btree_cur_t		*cur,	/* btree cursor */
	int			error);	/* del because of error */

/*
 * Duplicate the btree cursor.
 * Allocate a new one, copy the record, re-get the buffers.
 */
int					/* error */
xfs_btree_dup_cursor(
	xfs_btree_cur_t		*cur,	/* input cursor */
	xfs_btree_cur_t		**ncur);/* output cursor */

/*
 * Get a buffer for the block, return it with no data read.
 * Long-form addressing.
 */
struct xfs_buf *				/* buffer for fsbno */
xfs_btree_get_bufl(
	struct xfs_mount	*mp,	/* file system mount point */
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_fsblock_t		fsbno,	/* file system block number */
	uint			lock);	/* lock flags for get_buf */

/*
 * Get a buffer for the block, return it with no data read.
 * Short-form addressing.
 */
struct xfs_buf *				/* buffer for agno/agbno */
xfs_btree_get_bufs(
	struct xfs_mount	*mp,	/* file system mount point */
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_agnumber_t		agno,	/* allocation group number */
	xfs_agblock_t		agbno,	/* allocation group block number */
	uint			lock);	/* lock flags for get_buf */

/*
 * Check for the cursor referring to the last block at the given level.
 */
int					/* 1=is last block, 0=not last block */
xfs_btree_islastblock(
	xfs_btree_cur_t		*cur,	/* btree cursor */
	int			level);	/* level to check */

/*
 * Compute first and last byte offsets for the fields given.
 * Interprets the offsets table, which contains struct field offsets.
 */
void
xfs_btree_offsets(
	__int64_t		fields,	/* bitmask of fields */
	const short		*offsets,/* table of field offsets */
	int			nbits,	/* number of bits to inspect */
	int			*first,	/* output: first byte offset */
	int			*last);	/* output: last byte offset */

/*
 * Get a buffer for the block, return it read in.
 * Long-form addressing.
 */
int					/* error */
xfs_btree_read_bufl(
	struct xfs_mount	*mp,	/* file system mount point */
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_fsblock_t		fsbno,	/* file system block number */
	uint			lock,	/* lock flags for read_buf */
	struct xfs_buf		**bpp,	/* buffer for fsbno */
	int			refval,	/* ref count value for buffer */
	const struct xfs_buf_ops *ops);

/*
 * Read-ahead the block, don't wait for it, don't return a buffer.
 * Long-form addressing.
 */
void					/* error */
xfs_btree_reada_bufl(
	struct xfs_mount	*mp,	/* file system mount point */
	xfs_fsblock_t		fsbno,	/* file system block number */
	xfs_extlen_t		count,	/* count of filesystem blocks */
	const struct xfs_buf_ops *ops);

/*
 * Read-ahead the block, don't wait for it, don't return a buffer.
 * Short-form addressing.
 */
void					/* error */
xfs_btree_reada_bufs(
	struct xfs_mount	*mp,	/* file system mount point */
	xfs_agnumber_t		agno,	/* allocation group number */
	xfs_agblock_t		agbno,	/* allocation group block number */
	xfs_extlen_t		count,	/* count of filesystem blocks */
	const struct xfs_buf_ops *ops);

/*
 * Initialise a new btree block header
 */
void
xfs_btree_init_block(
	struct xfs_mount *mp,
	struct xfs_buf	*bp,
	__u32		magic,
	__u16		level,
	__u16		numrecs,
	__u64		owner,
	unsigned int	flags);

void
xfs_btree_init_block_int(
	struct xfs_mount	*mp,
	struct xfs_btree_block	*buf,
	xfs_daddr_t		blkno,
	__u32			magic,
	__u16			level,
	__u16			numrecs,
	__u64			owner,
	unsigned int		flags);

/*
 * Common btree core entry points.
 */
int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
int xfs_btree_insert(struct xfs_btree_cur *, int *);
int xfs_btree_delete(struct xfs_btree_cur *, int *);
int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
int xfs_btree_change_owner(struct xfs_btree_cur *cur, __uint64_t new_owner,
			   struct list_head *buffer_list);

/*
 * btree block CRC helpers
 */
void xfs_btree_lblock_calc_crc(struct xfs_buf *);
bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
void xfs_btree_sblock_calc_crc(struct xfs_buf *);
bool xfs_btree_sblock_verify_crc(struct xfs_buf *);

/*
 * Internal btree helpers also used by xfs_bmap.c.
 */
void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);

/*
 * Helpers.
 */
static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
{
	return be16_to_cpu(block->bb_numrecs);
}

static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
		__uint16_t numrecs)
{
	block->bb_numrecs = cpu_to_be16(numrecs);
}

static inline int xfs_btree_get_level(struct xfs_btree_block *block)
{
	return be16_to_cpu(block->bb_level);
}


/*
 * Min and max functions for extlen, agblock, fileoff, and filblks types.
 */
#define	XFS_EXTLEN_MIN(a,b)	min_t(xfs_extlen_t, (a), (b))
#define	XFS_EXTLEN_MAX(a,b)	max_t(xfs_extlen_t, (a), (b))
#define	XFS_AGBLOCK_MIN(a,b)	min_t(xfs_agblock_t, (a), (b))
#define	XFS_AGBLOCK_MAX(a,b)	max_t(xfs_agblock_t, (a), (b))
#define	XFS_FILEOFF_MIN(a,b)	min_t(xfs_fileoff_t, (a), (b))
#define	XFS_FILEOFF_MAX(a,b)	max_t(xfs_fileoff_t, (a), (b))
#define	XFS_FILBLKS_MIN(a,b)	min_t(xfs_filblks_t, (a), (b))
#define	XFS_FILBLKS_MAX(a,b)	max_t(xfs_filblks_t, (a), (b))

#define	XFS_FSB_SANITY_CHECK(mp,fsb)	\
	(XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
		XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)

/*
 * Trace hooks.  Currently not implemented as they need to be ported
 * over to the generic tracing functionality, which is some effort.
 *
 * i,j = integer (32 bit)
 * b = btree block buffer (xfs_buf_t)
 * p = btree ptr
 * r = btree record
 * k = btree key
 */
#define	XFS_BTREE_TRACE_ARGBI(c, b, i)
#define	XFS_BTREE_TRACE_ARGBII(c, b, i, j)
#define	XFS_BTREE_TRACE_ARGI(c, i)
#define	XFS_BTREE_TRACE_ARGIPK(c, i, p, s)
#define	XFS_BTREE_TRACE_ARGIPR(c, i, p, r)
#define	XFS_BTREE_TRACE_ARGIK(c, i, k)
#define XFS_BTREE_TRACE_ARGR(c, r)
#define	XFS_BTREE_TRACE_CURSOR(c, t)

#endif	/* __XFS_BTREE_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	9	* This program is distributed in the hope that it would be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
1da177e4	13	*
7b718769 NS	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write the Free Software Foundation,
	16	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
1da177e4 LT	17	*/
	18	#ifndef __XFS_BTREE_H__
	19	#define __XFS_BTREE_H__
	20
	21	struct xfs_buf;
	22	struct xfs_bmap_free;
	23	struct xfs_inode;
	24	struct xfs_mount;
	25	struct xfs_trans;
	26
a8272ce0 DC	27	extern kmem_zone_t *xfs_btree_cur_zone;
a8272ce0 DC	28
de227dd9 CH	29	/*
	30	* Generic key, ptr and record wrapper structures.
	31	*
	32	* These are disk format structures, and are converted where necessary
	33	* by the btree specific code that needs to interpret them.
	34	*/
	35	union xfs_btree_ptr {
	36	__be32 s; /* short form ptr */
	37	__be64 l; /* long form ptr */
	38	};
	39
	40	union xfs_btree_key {
	41	xfs_bmbt_key_t bmbt;
	42	xfs_bmdr_key_t bmbr; /* bmbt root block */
	43	xfs_alloc_key_t alloc;
	44	xfs_inobt_key_t inobt;
	45	};
	46
	47	union xfs_btree_rec {
	48	xfs_bmbt_rec_t bmbt;
	49	xfs_bmdr_rec_t bmbr; /* bmbt root block */
	50	xfs_alloc_rec_t alloc;
	51	xfs_inobt_rec_t inobt;
	52	};
	53
a4fbe6ab DC	54	/*
	55	* This nonsense is to make -wlint happy.
	56	*/
	57	#define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi)
	58	#define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi)
	59	#define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi)
	60
	61	#define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi)
	62	#define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi)
	63	#define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi)
	64	#define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi)
	65
1da177e4 LT	66	/*
	67	* For logging record fields.
	68	*/
21b5c978 DC	69	#define XFS_BB_MAGIC (1 << 0)
	70	#define XFS_BB_LEVEL (1 << 1)
	71	#define XFS_BB_NUMRECS (1 << 2)
	72	#define XFS_BB_LEFTSIB (1 << 3)
	73	#define XFS_BB_RIGHTSIB (1 << 4)
	74	#define XFS_BB_BLKNO (1 << 5)
	75	#define XFS_BB_LSN (1 << 6)
	76	#define XFS_BB_UUID (1 << 7)
	77	#define XFS_BB_OWNER (1 << 8)
1da177e4 LT	78	#define XFS_BB_NUM_BITS 5
1da177e4 LT	79	#define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
21b5c978	80	#define XFS_BB_NUM_BITS_CRC 9
ee1a47ab	81	#define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1)
1da177e4	82
854929f0 DC	83	/*
	84	* Generic stats interface
	85	*/
	86	#define __XFS_BTREE_STATS_INC(type, stat) \
	87	XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
	88	#define XFS_BTREE_STATS_INC(cur, stat) \
	89	do { \
	90	switch (cur->bc_btnum) { \
	91	case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break; \
	92	case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break; \
	93	case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break; \
	94	case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break; \
	95	case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
	96	} \
	97	} while (0)
	98
	99	#define __XFS_BTREE_STATS_ADD(type, stat, val) \
	100	XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
	101	#define XFS_BTREE_STATS_ADD(cur, stat, val) \
	102	do { \
	103	switch (cur->bc_btnum) { \
	104	case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
	105	case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
	106	case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
	107	case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
	108	case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
	109	} \
	110	} while (0)
1da177e4	111
1da177e4 LT	112	#define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */
1da177e4 LT	113
561f7d17	114	struct xfs_btree_ops {
65f1eaea CH	115	/* size of the key and record structures */
	116	size_t key_len;
	117	size_t rec_len;
	118
561f7d17 CH	119	/* cursor operations */
561f7d17 CH	120	struct xfs_btree_cur (dup_cursor)(struct xfs_btree_cur *);
4b22a571 CH	121	void (update_cursor)(struct xfs_btree_cur src,
4b22a571 CH	122	struct xfs_btree_cur *dst);
8c4ed633	123
344207ce CH	124	/* update btree root pointer */
344207ce CH	125	void (set_root)(struct xfs_btree_cur cur,
c0e59e1a	126	union xfs_btree_ptr *nptr, int level_change);
344207ce	127
f5eb8e7c CH	128	/* block allocation / freeing */
	129	int (alloc_block)(struct xfs_btree_cur cur,
	130	union xfs_btree_ptr *start_bno,
	131	union xfs_btree_ptr *new_bno,
	132	int length, int *stat);
d4b3a4b7	133	int (free_block)(struct xfs_btree_cur cur, struct xfs_buf *bp);
f5eb8e7c	134
278d0ca1 CH	135	/* update last record information */
	136	void (update_lastrec)(struct xfs_btree_cur cur,
	137	struct xfs_btree_block *block,
	138	union xfs_btree_rec *rec,
	139	int ptr, int reason);
	140
ce5e42db	141	/* records in block/level */
91cca5df	142	int (get_minrecs)(struct xfs_btree_cur cur, int level);
ce5e42db CH	143	int (get_maxrecs)(struct xfs_btree_cur cur, int level);
ce5e42db CH	144
4b22a571 CH	145	/* records on disk. Matter for the root in inode case. */
	146	int (get_dmaxrecs)(struct xfs_btree_cur cur, int level);
	147
fe033cc8 CH	148	/* init values of btree structures */
	149	void (init_key_from_rec)(union xfs_btree_key key,
	150	union xfs_btree_rec *rec);
4b22a571 CH	151	void (init_rec_from_key)(union xfs_btree_key key,
	152	union xfs_btree_rec *rec);
	153	void (init_rec_from_cur)(struct xfs_btree_cur cur,
	154	union xfs_btree_rec *rec);
fe033cc8 CH	155	void (init_ptr_from_cur)(struct xfs_btree_cur cur,
	156	union xfs_btree_ptr *ptr);
	157
	158	/* difference between key value and cursor value */
	159	__int64_t (key_diff)(struct xfs_btree_cur cur,
	160	union xfs_btree_key *key);
	161
1813dd64	162	const struct xfs_buf_ops *buf_ops;
b0f539de	163
742ae1e3	164	#if defined(DEBUG) \|\| defined(XFS_WARN)
4a26e66e CH	165	/* check that k1 is lower than k2 */
	166	int (keys_inorder)(struct xfs_btree_cur cur,
	167	union xfs_btree_key *k1,
	168	union xfs_btree_key *k2);
	169
	170	/* check that r1 is lower than r2 */
	171	int (recs_inorder)(struct xfs_btree_cur cur,
	172	union xfs_btree_rec *r1,
	173	union xfs_btree_rec *r2);
	174	#endif
561f7d17 CH	175	};
561f7d17 CH	176
278d0ca1 CH	177	/*
	178	* Reasons for the update_lastrec method to be called.
	179	*/
	180	#define LASTREC_UPDATE 0
4b22a571	181	#define LASTREC_INSREC 1
91cca5df	182	#define LASTREC_DELREC 2
278d0ca1 CH	183
278d0ca1 CH	184
1da177e4 LT	185	/*
	186	* Btree cursor structure.
	187	* This collects all information needed by the btree code in one place.
	188	*/
	189	typedef struct xfs_btree_cur
	190	{
	191	struct xfs_trans bc_tp; / transaction we're in, if any */
	192	struct xfs_mount bc_mp; / file system mount struct */
561f7d17	193	const struct xfs_btree_ops *bc_ops;
8186e517	194	uint bc_flags; /* btree features - below */
1da177e4	195	union {
16259e7d	196	xfs_alloc_rec_incore_t a;
1da177e4	197	xfs_bmbt_irec_t b;
61a25848	198	xfs_inobt_rec_incore_t i;
1da177e4 LT	199	} bc_rec; /* current insert/search record value */
	200	struct xfs_buf bc_bufs[XFS_BTREE_MAXLEVELS]; / buf ptr per level */
	201	int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
	202	__uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
	203	#define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
	204	#define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
	205	__uint8_t bc_nlevels; /* number of levels in the tree */
	206	__uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
	207	xfs_btnum_t bc_btnum; /* identifies which btree type */
	208	union {
169d6227 CH	209	struct { /* needed for BNO, CNT, INO */
169d6227 CH	210	struct xfs_buf agbp; / agf/agi buffer pointer */
1da177e4 LT	211	xfs_agnumber_t agno; /* ag number */
	212	} a;
	213	struct { /* needed for BMAP */
	214	struct xfs_inode ip; / pointer to our inode */
	215	struct xfs_bmap_free flist; / list to free after */
	216	xfs_fsblock_t firstblock; /* 1st blk allocated */
	217	int allocated; /* count of alloced */
	218	short forksize; /* fork's inode space */
	219	char whichfork; /* data or attr fork */
	220	char flags; /* flags */
	221	#define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
	222	} b;
1da177e4 LT	223	} bc_private; /* per-btree type data */
	224	} xfs_btree_cur_t;
	225
8186e517	226	/* cursor flags */
e99ab90d	227	#define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */
8186e517	228	#define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */
278d0ca1	229	#define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */
ee1a47ab	230	#define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */
8186e517 CH	231
8186e517 CH	232
1da177e4 LT	233	#define XFS_BTREE_NOERROR 0
	234	#define XFS_BTREE_ERROR 1
	235
	236	/*
	237	* Convert from buffer to btree block header.
	238	*/
62926044	239	#define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr))
1da177e4	240
1da177e4	241
1da177e4	242	/*
a23f6ef8	243	* Check that block header is ok.
1da177e4	244	*/
a23f6ef8 CH	245	int
	246	xfs_btree_check_block(
	247	struct xfs_btree_cur cur, / btree cursor */
	248	struct xfs_btree_block block, / generic btree block pointer */
1da177e4 LT	249	int level, /* level of the btree block */
	250	struct xfs_buf bp); / buffer containing block, if any */
	251
	252	/*
a23f6ef8	253	* Check that (long) pointer is ok.
1da177e4 LT	254	*/
	255	int /* error (0 or EFSCORRUPTED) */
	256	xfs_btree_check_lptr(
a23f6ef8	257	struct xfs_btree_cur cur, / btree cursor */
1da177e4 LT	258	xfs_dfsbno_t ptr, /* btree block disk address */
	259	int level); /* btree block level */
	260
1da177e4 LT	261	/*
	262	* Delete the btree cursor.
	263	*/
	264	void
	265	xfs_btree_del_cursor(
	266	xfs_btree_cur_t cur, / btree cursor */
	267	int error); /* del because of error */
	268
	269	/*
	270	* Duplicate the btree cursor.
	271	* Allocate a new one, copy the record, re-get the buffers.
	272	*/
	273	int /* error */
	274	xfs_btree_dup_cursor(
	275	xfs_btree_cur_t cur, / input cursor */
	276	xfs_btree_cur_t *ncur);/ output cursor */
	277
1da177e4 LT	278	/*
	279	* Get a buffer for the block, return it with no data read.
	280	* Long-form addressing.
	281	*/
	282	struct xfs_buf * /* buffer for fsbno */
	283	xfs_btree_get_bufl(
	284	struct xfs_mount mp, / file system mount point */
	285	struct xfs_trans tp, / transaction pointer */
	286	xfs_fsblock_t fsbno, /* file system block number */
	287	uint lock); /* lock flags for get_buf */
	288
	289	/*
	290	* Get a buffer for the block, return it with no data read.
	291	* Short-form addressing.
	292	*/
	293	struct xfs_buf * /* buffer for agno/agbno */
	294	xfs_btree_get_bufs(
	295	struct xfs_mount mp, / file system mount point */
	296	struct xfs_trans tp, / transaction pointer */
	297	xfs_agnumber_t agno, /* allocation group number */
	298	xfs_agblock_t agbno, /* allocation group block number */
	299	uint lock); /* lock flags for get_buf */
	300
1da177e4 LT	301	/*
	302	* Check for the cursor referring to the last block at the given level.
	303	*/
	304	int /* 1=is last block, 0=not last block */
	305	xfs_btree_islastblock(
	306	xfs_btree_cur_t cur, / btree cursor */
	307	int level); /* level to check */
	308
1da177e4 LT	309	/*
	310	* Compute first and last byte offsets for the fields given.
	311	* Interprets the offsets table, which contains struct field offsets.
	312	*/
	313	void
	314	xfs_btree_offsets(
	315	__int64_t fields, /* bitmask of fields */
	316	const short offsets,/ table of field offsets */
	317	int nbits, /* number of bits to inspect */
	318	int first, / output: first byte offset */
	319	int last); / output: last byte offset */
	320
	321	/*
	322	* Get a buffer for the block, return it read in.
	323	* Long-form addressing.
	324	*/
	325	int /* error */
	326	xfs_btree_read_bufl(
	327	struct xfs_mount mp, / file system mount point */
	328	struct xfs_trans tp, / transaction pointer */
	329	xfs_fsblock_t fsbno, /* file system block number */
	330	uint lock, /* lock flags for read_buf */
	331	struct xfs_buf *bpp, / buffer for fsbno */
3d3e6f64	332	int refval, /* ref count value for buffer */
1813dd64	333	const struct xfs_buf_ops *ops);
1da177e4	334
1da177e4 LT	335	/*
	336	* Read-ahead the block, don't wait for it, don't return a buffer.
	337	* Long-form addressing.
	338	*/
	339	void /* error */
	340	xfs_btree_reada_bufl(
	341	struct xfs_mount mp, / file system mount point */
	342	xfs_fsblock_t fsbno, /* file system block number */
3d3e6f64	343	xfs_extlen_t count, /* count of filesystem blocks */
1813dd64	344	const struct xfs_buf_ops *ops);
1da177e4 LT	345
	346	/*
	347	* Read-ahead the block, don't wait for it, don't return a buffer.
	348	* Short-form addressing.
	349	*/
	350	void /* error */
	351	xfs_btree_reada_bufs(
	352	struct xfs_mount mp, / file system mount point */
	353	xfs_agnumber_t agno, /* allocation group number */
	354	xfs_agblock_t agbno, /* allocation group block number */
3d3e6f64	355	xfs_extlen_t count, /* count of filesystem blocks */
1813dd64	356	const struct xfs_buf_ops *ops);
1da177e4	357
b64f3a39 DC	358	/*
	359	* Initialise a new btree block header
	360	*/
	361	void
	362	xfs_btree_init_block(
	363	struct xfs_mount *mp,
	364	struct xfs_buf *bp,
	365	__u32 magic,
	366	__u16 level,
	367	__u16 numrecs,
ee1a47ab	368	__u64 owner,
b64f3a39	369	unsigned int flags);
65f1eaea	370
ee1a47ab CH	371	void
	372	xfs_btree_init_block_int(
	373	struct xfs_mount *mp,
	374	struct xfs_btree_block *buf,
	375	xfs_daddr_t blkno,
	376	__u32 magic,
	377	__u16 level,
	378	__u16 numrecs,
	379	__u64 owner,
	380	unsigned int flags);
	381
637aa50f CH	382	/*
	383	* Common btree core entry points.
	384	*/
	385	int xfs_btree_increment(struct xfs_btree_cur , int, int );
8df4da4a	386	int xfs_btree_decrement(struct xfs_btree_cur , int, int );
fe033cc8	387	int xfs_btree_lookup(struct xfs_btree_cur , xfs_lookup_t, int );
278d0ca1	388	int xfs_btree_update(struct xfs_btree_cur , union xfs_btree_rec );
ea77b0a6	389	int xfs_btree_new_iroot(struct xfs_btree_cur , int , int *);
4b22a571	390	int xfs_btree_insert(struct xfs_btree_cur , int );
91cca5df	391	int xfs_btree_delete(struct xfs_btree_cur , int );
8cc938fe	392	int xfs_btree_get_rec(struct xfs_btree_cur , union xfs_btree_rec , int );
638f4416 DC	393	int xfs_btree_change_owner(struct xfs_btree_cur *cur, __uint64_t new_owner,
638f4416 DC	394	struct list_head *buffer_list);
637aa50f	395
ee1a47ab CH	396	/*
	397	* btree block CRC helpers
	398	*/
	399	void xfs_btree_lblock_calc_crc(struct xfs_buf *);
	400	bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
	401	void xfs_btree_sblock_calc_crc(struct xfs_buf *);
	402	bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
	403
fd6bcc5b CH	404	/*
	405	* Internal btree helpers also used by xfs_bmap.c.
	406	*/
	407	void xfs_btree_log_block(struct xfs_btree_cur , struct xfs_buf , int);
	408	void xfs_btree_log_recs(struct xfs_btree_cur , struct xfs_buf , int, int);
	409
65f1eaea CH	410	/*
	411	* Helpers.
	412	*/
637aa50f CH	413	static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
	414	{
	415	return be16_to_cpu(block->bb_numrecs);
	416	}
	417
9eaead51 CH	418	static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
	419	__uint16_t numrecs)
	420	{
	421	block->bb_numrecs = cpu_to_be16(numrecs);
	422	}
	423
65f1eaea CH	424	static inline int xfs_btree_get_level(struct xfs_btree_block *block)
	425	{
	426	return be16_to_cpu(block->bb_level);
	427	}
	428
1da177e4 LT	429
	430	/*
	431	* Min and max functions for extlen, agblock, fileoff, and filblks types.
	432	*/
54aa8e26 DC	433	#define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
	434	#define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
	435	#define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
	436	#define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
	437	#define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
	438	#define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
	439	#define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
	440	#define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
a844f451	441
1da177e4 LT	442	#define XFS_FSB_SANITY_CHECK(mp,fsb) \
1da177e4 LT	443	(XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
a844f451	444	XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
1da177e4	445
c84470dd CH	446	/*
	447	* Trace hooks. Currently not implemented as they need to be ported
	448	* over to the generic tracing functionality, which is some effort.
	449	*
	450	* i,j = integer (32 bit)
	451	* b = btree block buffer (xfs_buf_t)
	452	* p = btree ptr
	453	* r = btree record
	454	* k = btree key
	455	*/
	456	#define XFS_BTREE_TRACE_ARGBI(c, b, i)
	457	#define XFS_BTREE_TRACE_ARGBII(c, b, i, j)
	458	#define XFS_BTREE_TRACE_ARGI(c, i)
	459	#define XFS_BTREE_TRACE_ARGIPK(c, i, p, s)
	460	#define XFS_BTREE_TRACE_ARGIPR(c, i, p, r)
	461	#define XFS_BTREE_TRACE_ARGIK(c, i, k)
	462	#define XFS_BTREE_TRACE_ARGR(c, r)
	463	#define XFS_BTREE_TRACE_CURSOR(c, t)
	464
1da177e4	465	#endif /* __XFS_BTREE_H__ */