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

/*
 * Copyright (c) 2000,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_IALLOC_BTREE_H__
#define	__XFS_IALLOC_BTREE_H__

/*
 * Inode map on-disk structures
 */

struct xfs_buf;
struct xfs_btree_cur;
struct xfs_btree_sblock;
struct xfs_mount;

/*
 * There is a btree for the inode map per allocation group.
 */
#define	XFS_IBT_MAGIC	0x49414254	/* 'IABT' */

typedef	__uint64_t	xfs_inofree_t;
#define	XFS_INODES_PER_CHUNK	(NBBY * sizeof(xfs_inofree_t))
#define	XFS_INODES_PER_CHUNK_LOG	(XFS_NBBYLOG + 3)
#define	XFS_INOBT_ALL_FREE	((xfs_inofree_t)-1)

#define	XFS_INOBT_MASKN(i,n)		xfs_inobt_maskn(i,n)
static inline xfs_inofree_t xfs_inobt_maskn(int i, int n)
{
	return (((n) >= XFS_INODES_PER_CHUNK ? \
		(xfs_inofree_t)0 : ((xfs_inofree_t)1 << (n))) - 1) << (i);
}

/*
 * Data record structure
 */
typedef struct xfs_inobt_rec
{
	xfs_agino_t	ir_startino;	/* starting inode number */
	__int32_t	ir_freecount;	/* count of free inodes (set bits) */
	xfs_inofree_t	ir_free;	/* free inode mask */
} xfs_inobt_rec_t;

/*
 * Key structure
 */
typedef struct xfs_inobt_key
{
	xfs_agino_t	ir_startino;	/* starting inode number */
} xfs_inobt_key_t;

typedef xfs_agblock_t xfs_inobt_ptr_t;	/* btree pointer type */
					/* btree block header type */
typedef	struct xfs_btree_sblock xfs_inobt_block_t;

#define	XFS_BUF_TO_INOBT_BLOCK(bp)	((xfs_inobt_block_t *)XFS_BUF_PTR(bp))

/*
 * Bit manipulations for ir_free.
 */
#define	XFS_INOBT_MASK(i)		((xfs_inofree_t)1 << (i))
#define	XFS_INOBT_IS_FREE(rp,i)		\
		(((rp)->ir_free & XFS_INOBT_MASK(i)) != 0)
#define	XFS_INOBT_IS_FREE_DISK(rp,i)	\
		((INT_GET((rp)->ir_free,ARCH_CONVERT) & XFS_INOBT_MASK(i)) != 0)
#define	XFS_INOBT_SET_FREE(rp,i)	((rp)->ir_free |= XFS_INOBT_MASK(i))
#define	XFS_INOBT_CLR_FREE(rp,i)	((rp)->ir_free &= ~XFS_INOBT_MASK(i))

/*
 * Real block structures have a size equal to the disk block size.
 */
#define	XFS_INOBT_BLOCK_SIZE(lev,cur)	(1 << (cur)->bc_blocklog)
#define	XFS_INOBT_BLOCK_MAXRECS(lev,cur) ((cur)->bc_mp->m_inobt_mxr[lev != 0])
#define	XFS_INOBT_BLOCK_MINRECS(lev,cur) ((cur)->bc_mp->m_inobt_mnr[lev != 0])
#define	XFS_INOBT_IS_LAST_REC(cur)	\
	((cur)->bc_ptrs[0] == INT_GET(XFS_BUF_TO_INOBT_BLOCK((cur)->bc_bufs[0])->bb_numrecs, ARCH_CONVERT))

/*
 * Maximum number of inode btree levels.
 */
#define	XFS_IN_MAXLEVELS(mp)		((mp)->m_in_maxlevels)

/*
 * block numbers in the AG.
 */
#define	XFS_IBT_BLOCK(mp)		((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1))
#define	XFS_PREALLOC_BLOCKS(mp)		((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1))

/*
 * Record, key, and pointer address macros for btree blocks.
 */
#define XFS_INOBT_REC_ADDR(bb,i,cur) \
	(XFS_BTREE_REC_ADDR(XFS_INOBT_BLOCK_SIZE(0,cur), xfs_inobt, bb, \
				i, XFS_INOBT_BLOCK_MAXRECS(0, cur)))
#define	XFS_INOBT_KEY_ADDR(bb,i,cur) \
	(XFS_BTREE_KEY_ADDR(XFS_INOBT_BLOCK_SIZE(1,cur), xfs_inobt, bb, \
				i, XFS_INOBT_BLOCK_MAXRECS(1, cur)))

#define	XFS_INOBT_PTR_ADDR(bb,i,cur) \
	(XFS_BTREE_PTR_ADDR(XFS_INOBT_BLOCK_SIZE(1,cur), xfs_inobt, bb, \
				i, XFS_INOBT_BLOCK_MAXRECS(1, cur)))

/*
 * Decrement cursor by one record at the level.
 * For nonzero levels the leaf-ward information is untouched.
 */
extern int xfs_inobt_decrement(struct xfs_btree_cur *cur, int level, int *stat);

/*
 * Delete the record pointed to by cur.
 * The cursor refers to the place where the record was (could be inserted)
 * when the operation returns.
 */
extern int xfs_inobt_delete(struct xfs_btree_cur *cur, int *stat);

/*
 * Get the data from the pointed-to record.
 */
extern int xfs_inobt_get_rec(struct xfs_btree_cur *cur, xfs_agino_t *ino,
			     __int32_t *fcnt, xfs_inofree_t *free, int *stat);

/*
 * Increment cursor by one record at the level.
 * For nonzero levels the leaf-ward information is untouched.
 */
extern int xfs_inobt_increment(struct xfs_btree_cur *cur, int level, int *stat);

/*
 * Insert the current record at the point referenced by cur.
 * The cursor may be inconsistent on return if splits have been done.
 */
extern int xfs_inobt_insert(struct xfs_btree_cur *cur, int *stat);

/*
 * Lookup the record equal to ino in the btree given by cur.
 */
extern int xfs_inobt_lookup_eq(struct xfs_btree_cur *cur, xfs_agino_t ino,
				__int32_t fcnt, xfs_inofree_t free, int *stat);

/*
 * Lookup the first record greater than or equal to ino
 * in the btree given by cur.
 */
extern int xfs_inobt_lookup_ge(struct xfs_btree_cur *cur, xfs_agino_t ino,
				__int32_t fcnt,	xfs_inofree_t free, int *stat);

/*
 * Lookup the first record less than or equal to ino
 * in the btree given by cur.
 */
extern int xfs_inobt_lookup_le(struct xfs_btree_cur *cur, xfs_agino_t ino,
				__int32_t fcnt,	xfs_inofree_t free, int *stat);

/*
 * Update the record referred to by cur, to the value given
 * by [ino, fcnt, free].
 * This either works (return 0) or gets an EFSCORRUPTED error.
 */
extern int xfs_inobt_update(struct xfs_btree_cur *cur, xfs_agino_t ino,
				__int32_t fcnt, xfs_inofree_t free);

#endif	/* __XFS_IALLOC_BTREE_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000,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_IALLOC_BTREE_H__
	19	#define __XFS_IALLOC_BTREE_H__
	20
	21	/*
	22	* Inode map on-disk structures
	23	*/
	24
	25	struct xfs_buf;
	26	struct xfs_btree_cur;
	27	struct xfs_btree_sblock;
	28	struct xfs_mount;
	29
	30	/*
	31	* There is a btree for the inode map per allocation group.
	32	*/
	33	#define XFS_IBT_MAGIC 0x49414254 /* 'IABT' */
	34
	35	typedef __uint64_t xfs_inofree_t;
	36	#define XFS_INODES_PER_CHUNK (NBBY * sizeof(xfs_inofree_t))
	37	#define XFS_INODES_PER_CHUNK_LOG (XFS_NBBYLOG + 3)
	38	#define XFS_INOBT_ALL_FREE ((xfs_inofree_t)-1)
	39
1da177e4	40	#define XFS_INOBT_MASKN(i,n) xfs_inobt_maskn(i,n)
a844f451 NS	41	static inline xfs_inofree_t xfs_inobt_maskn(int i, int n)
	42	{
	43	return (((n) >= XFS_INODES_PER_CHUNK ? \
	44	(xfs_inofree_t)0 : ((xfs_inofree_t)1 << (n))) - 1) << (i);
	45	}
1da177e4 LT	46
	47	/*
	48	* Data record structure
	49	*/
	50	typedef struct xfs_inobt_rec
	51	{
	52	xfs_agino_t ir_startino; /* starting inode number */
	53	__int32_t ir_freecount; /* count of free inodes (set bits) */
	54	xfs_inofree_t ir_free; /* free inode mask */
	55	} xfs_inobt_rec_t;
	56
	57	/*
	58	* Key structure
	59	*/
	60	typedef struct xfs_inobt_key
	61	{
	62	xfs_agino_t ir_startino; /* starting inode number */
	63	} xfs_inobt_key_t;
	64
	65	typedef xfs_agblock_t xfs_inobt_ptr_t; /* btree pointer type */
	66	/* btree block header type */
	67	typedef struct xfs_btree_sblock xfs_inobt_block_t;
	68
a844f451	69	#define XFS_BUF_TO_INOBT_BLOCK(bp) ((xfs_inobt_block_t *)XFS_BUF_PTR(bp))
1da177e4 LT	70
	71	/*
	72	* Bit manipulations for ir_free.
	73	*/
1da177e4	74	#define XFS_INOBT_MASK(i) ((xfs_inofree_t)1 << (i))
a844f451 NS	75	#define XFS_INOBT_IS_FREE(rp,i) \
	76	(((rp)->ir_free & XFS_INOBT_MASK(i)) != 0)
	77	#define XFS_INOBT_IS_FREE_DISK(rp,i) \
	78	((INT_GET((rp)->ir_free,ARCH_CONVERT) & XFS_INOBT_MASK(i)) != 0)
1da177e4	79	#define XFS_INOBT_SET_FREE(rp,i) ((rp)->ir_free \|= XFS_INOBT_MASK(i))
1da177e4	80	#define XFS_INOBT_CLR_FREE(rp,i) ((rp)->ir_free &= ~XFS_INOBT_MASK(i))
1da177e4 LT	81
	82	/*
	83	* Real block structures have a size equal to the disk block size.
	84	*/
1da177e4	85	#define XFS_INOBT_BLOCK_SIZE(lev,cur) (1 << (cur)->bc_blocklog)
a844f451 NS	86	#define XFS_INOBT_BLOCK_MAXRECS(lev,cur) ((cur)->bc_mp->m_inobt_mxr[lev != 0])
a844f451 NS	87	#define XFS_INOBT_BLOCK_MINRECS(lev,cur) ((cur)->bc_mp->m_inobt_mnr[lev != 0])
1da177e4	88	#define XFS_INOBT_IS_LAST_REC(cur) \
a844f451	89	((cur)->bc_ptrs[0] == INT_GET(XFS_BUF_TO_INOBT_BLOCK((cur)->bc_bufs[0])->bb_numrecs, ARCH_CONVERT))
1da177e4 LT	90
	91	/*
	92	* Maximum number of inode btree levels.
	93	*/
1da177e4	94	#define XFS_IN_MAXLEVELS(mp) ((mp)->m_in_maxlevels)
1da177e4 LT	95
	96	/*
	97	* block numbers in the AG.
	98	*/
a844f451 NS	99	#define XFS_IBT_BLOCK(mp) ((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1))
a844f451 NS	100	#define XFS_PREALLOC_BLOCKS(mp) ((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1))
1da177e4 LT	101
	102	/*
	103	* Record, key, and pointer address macros for btree blocks.
	104	*/
a844f451 NS	105	#define XFS_INOBT_REC_ADDR(bb,i,cur) \
	106	(XFS_BTREE_REC_ADDR(XFS_INOBT_BLOCK_SIZE(0,cur), xfs_inobt, bb, \
	107	i, XFS_INOBT_BLOCK_MAXRECS(0, cur)))
	108	#define XFS_INOBT_KEY_ADDR(bb,i,cur) \
	109	(XFS_BTREE_KEY_ADDR(XFS_INOBT_BLOCK_SIZE(1,cur), xfs_inobt, bb, \
	110	i, XFS_INOBT_BLOCK_MAXRECS(1, cur)))
1da177e4	111
a844f451 NS	112	#define XFS_INOBT_PTR_ADDR(bb,i,cur) \
	113	(XFS_BTREE_PTR_ADDR(XFS_INOBT_BLOCK_SIZE(1,cur), xfs_inobt, bb, \
	114	i, XFS_INOBT_BLOCK_MAXRECS(1, cur)))
1da177e4 LT	115
	116	/*
	117	* Decrement cursor by one record at the level.
	118	* For nonzero levels the leaf-ward information is untouched.
	119	*/
a844f451	120	extern int xfs_inobt_decrement(struct xfs_btree_cur cur, int level, int stat);
1da177e4 LT	121
	122	/*
	123	* Delete the record pointed to by cur.
	124	* The cursor refers to the place where the record was (could be inserted)
	125	* when the operation returns.
	126	*/
a844f451	127	extern int xfs_inobt_delete(struct xfs_btree_cur cur, int stat);
1da177e4 LT	128
	129	/*
	130	* Get the data from the pointed-to record.
	131	*/
a844f451 NS	132	extern int xfs_inobt_get_rec(struct xfs_btree_cur cur, xfs_agino_t ino,
a844f451 NS	133	__int32_t fcnt, xfs_inofree_t free, int *stat);
1da177e4 LT	134
	135	/*
	136	* Increment cursor by one record at the level.
	137	* For nonzero levels the leaf-ward information is untouched.
	138	*/
a844f451	139	extern int xfs_inobt_increment(struct xfs_btree_cur cur, int level, int stat);
1da177e4 LT	140
	141	/*
	142	* Insert the current record at the point referenced by cur.
	143	* The cursor may be inconsistent on return if splits have been done.
	144	*/
a844f451	145	extern int xfs_inobt_insert(struct xfs_btree_cur cur, int stat);
1da177e4 LT	146
	147	/*
	148	* Lookup the record equal to ino in the btree given by cur.
	149	*/
a844f451 NS	150	extern int xfs_inobt_lookup_eq(struct xfs_btree_cur *cur, xfs_agino_t ino,
a844f451 NS	151	__int32_t fcnt, xfs_inofree_t free, int *stat);
1da177e4 LT	152
	153	/*
	154	* Lookup the first record greater than or equal to ino
	155	* in the btree given by cur.
	156	*/
a844f451 NS	157	extern int xfs_inobt_lookup_ge(struct xfs_btree_cur *cur, xfs_agino_t ino,
a844f451 NS	158	__int32_t fcnt, xfs_inofree_t free, int *stat);
1da177e4 LT	159
	160	/*
	161	* Lookup the first record less than or equal to ino
	162	* in the btree given by cur.
	163	*/
a844f451 NS	164	extern int xfs_inobt_lookup_le(struct xfs_btree_cur *cur, xfs_agino_t ino,
a844f451 NS	165	__int32_t fcnt, xfs_inofree_t free, int *stat);
1da177e4 LT	166
	167	/*
	168	* Update the record referred to by cur, to the value given
	169	* by [ino, fcnt, free].
	170	* This either works (return 0) or gets an EFSCORRUPTED error.
	171	*/
a844f451 NS	172	extern int xfs_inobt_update(struct xfs_btree_cur *cur, xfs_agino_t ino,
a844f451 NS	173	__int32_t fcnt, xfs_inofree_t free);
1da177e4 LT	174
1da177e4 LT	175	#endif /* __XFS_IALLOC_BTREE_H__ */