[net-next-2.6.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;

/*
 * 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)

/*
 * Generic btree header.
 *
 * This is a combination of the actual format used on disk for short and long
 * format btrees.  The first three fields are shared by both format, but
 * the pointers are different and should be used with care.
 *
 * To get the size of the actual short or long form headers please use
 * the size macros below.  Never use sizeof(xfs_btree_block).
 */
struct xfs_btree_block {
	__be32		bb_magic;	/* magic number for block type */
	__be16		bb_level;	/* 0 is a leaf */
	__be16		bb_numrecs;	/* current # of data records */
	union {
		struct {
			__be32		bb_leftsib;
			__be32		bb_rightsib;
		} s;			/* short form pointers */
		struct	{
			__be64		bb_leftsib;
			__be64		bb_rightsib;
		} l;			/* long form pointers */
	} bb_u;				/* rest */
};

#define XFS_BTREE_SBLOCK_LEN	16	/* size of a short form block */
#define XFS_BTREE_LBLOCK_LEN	24	/* size of a long form block */


/*
 * 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;
};

/*
 * For logging record fields.
 */
#define	XFS_BB_MAGIC		0x01
#define	XFS_BB_LEVEL		0x02
#define	XFS_BB_NUMRECS		0x04
#define	XFS_BB_LEFTSIB		0x08
#define	XFS_BB_RIGHTSIB		0x10
#define	XFS_BB_NUM_BITS		5
#define	XFS_BB_ALL_BITS		((1 << XFS_BB_NUM_BITS) - 1)

/*
 * Magic numbers for btree blocks.
 */
extern const __uint32_t	xfs_magics[];

/*
 * 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);

#ifdef DEBUG
	/* 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

	/* btree tracing */
#ifdef XFS_BTREE_TRACE
	void		(*trace_enter)(struct xfs_btree_cur *, const char *,
				       char *, int, int, __psunsigned_t,
				       __psunsigned_t, __psunsigned_t,
				       __psunsigned_t, __psunsigned_t,
				       __psunsigned_t, __psunsigned_t,
				       __psunsigned_t, __psunsigned_t,
				       __psunsigned_t, __psunsigned_t);
	void		(*trace_cursor)(struct xfs_btree_cur *, __uint32_t *,
					__uint64_t *, __uint64_t *);
	void		(*trace_key)(struct xfs_btree_cur *,
				     union xfs_btree_key *, __uint64_t *,
				     __uint64_t *);
	void		(*trace_record)(struct xfs_btree_cur *,
					union xfs_btree_rec *, __uint64_t *,
					__uint64_t *, __uint64_t *);
#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_NOERROR	0
#define	XFS_BTREE_ERROR		1

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


/*
 * 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 */

/*
 * 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 */

/*
 * 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 */


/*
 * 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 *);

/*
 * 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)

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