fs/xfs/xfs_alloc_btree.h - linux/kernel/git/torvalds/linux - Git at Google

 /*
  * Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of version 2 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.
  *
  * Further, this software is distributed without any warranty that it is
  * free of the rightful claim of any third person regarding infringement
  * or the like.  Any license provided herein, whether implied or
  * otherwise, applies only to this software file.  Patent licenses, if
  * any, provided herein do not apply to combinations of this program with
  * other software, or any other product whatsoever.
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write the Free Software Foundation, Inc., 59
  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  *
  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  * Mountain View, CA  94043, or:
  *
  * http://www.sgi.com
  *
  * For further information regarding this notice, see:
  *
  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  */
 #ifndef __XFS_ALLOC_BTREE_H__
 #define	__XFS_ALLOC_BTREE_H__

 /*
  * Freespace on-disk structures
  */

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

 /*
  * There are two on-disk btrees, one sorted by blockno and one sorted
  * by blockcount and blockno.  All blocks look the same to make the code
  * simpler; if we have time later, we'll make the optimizations.
  */
 #define	XFS_ABTB_MAGIC	0x41425442	/* 'ABTB' for bno tree */
 #define	XFS_ABTC_MAGIC	0x41425443	/* 'ABTC' for cnt tree */

 /*
  * Data record/key structure
  */
 typedef struct xfs_alloc_rec
 {
 	xfs_agblock_t	ar_startblock;	/* starting block number */
 	xfs_extlen_t	ar_blockcount;	/* count of free blocks */
 } xfs_alloc_rec_t, xfs_alloc_key_t;

 typedef xfs_agblock_t xfs_alloc_ptr_t;	/* btree pointer type */
 					/* btree block header type */
 typedef	struct xfs_btree_sblock xfs_alloc_block_t;

 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_BUF_TO_ALLOC_BLOCK)
 xfs_alloc_block_t *xfs_buf_to_alloc_block(struct xfs_buf *bp);
 #define	XFS_BUF_TO_ALLOC_BLOCK(bp)	xfs_buf_to_alloc_block(bp)
 #else
 #define	XFS_BUF_TO_ALLOC_BLOCK(bp) ((xfs_alloc_block_t *)(XFS_BUF_PTR(bp)))
 #endif

 /*
  * Real block structures have a size equal to the disk block size.
  */

 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_BLOCK_SIZE)
 int xfs_alloc_block_size(int lev, struct xfs_btree_cur *cur);
 #define	XFS_ALLOC_BLOCK_SIZE(lev,cur)	xfs_alloc_block_size(lev,cur)
 #else
 #define	XFS_ALLOC_BLOCK_SIZE(lev,cur)	(1 << (cur)->bc_blocklog)
 #endif

 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_BLOCK_MAXRECS)
 int xfs_alloc_block_maxrecs(int lev, struct xfs_btree_cur *cur);
 #define	XFS_ALLOC_BLOCK_MAXRECS(lev,cur)	xfs_alloc_block_maxrecs(lev,cur)
 #else
 #define	XFS_ALLOC_BLOCK_MAXRECS(lev,cur)	\
 	((cur)->bc_mp->m_alloc_mxr[lev != 0])
 #endif
 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_BLOCK_MINRECS)
 int xfs_alloc_block_minrecs(int lev, struct xfs_btree_cur *cur);
 #define	XFS_ALLOC_BLOCK_MINRECS(lev,cur)	xfs_alloc_block_minrecs(lev,cur)
 #else
 #define	XFS_ALLOC_BLOCK_MINRECS(lev,cur)	\
 	((cur)->bc_mp->m_alloc_mnr[lev != 0])
 #endif

 /*
  * Minimum and maximum blocksize and sectorsize.
  * The blocksize upper limit is pretty much arbitrary.
  * The sectorsize upper limit is due to sizeof(sb_sectsize).
  */
 #define XFS_MIN_BLOCKSIZE_LOG	9	/* i.e. 512 bytes */
 #define XFS_MAX_BLOCKSIZE_LOG	16	/* i.e. 65536 bytes */
 #define XFS_MIN_BLOCKSIZE	(1 << XFS_MIN_BLOCKSIZE_LOG)
 #define XFS_MAX_BLOCKSIZE	(1 << XFS_MAX_BLOCKSIZE_LOG)
 #define XFS_MIN_SECTORSIZE_LOG	9	/* i.e. 512 bytes */
 #define XFS_MAX_SECTORSIZE_LOG	15	/* i.e. 32768 bytes */
 #define XFS_MIN_SECTORSIZE	(1 << XFS_MIN_SECTORSIZE_LOG)
 #define XFS_MAX_SECTORSIZE	(1 << XFS_MAX_SECTORSIZE_LOG)

 /*
  * Block numbers in the AG:
  * SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3.
  */
 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_BNO_BLOCK)
 xfs_agblock_t xfs_bno_block(struct xfs_mount *mp);
 #define	XFS_BNO_BLOCK(mp)	xfs_bno_block(mp)
 #else
 #define	XFS_BNO_BLOCK(mp)	((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1))
 #endif
 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_CNT_BLOCK)
 xfs_agblock_t xfs_cnt_block(struct xfs_mount *mp);
 #define	XFS_CNT_BLOCK(mp)	xfs_cnt_block(mp)
 #else
 #define	XFS_CNT_BLOCK(mp)	((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1))
 #endif

 /*
  * Record, key, and pointer address macros for btree blocks.
  */
 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_REC_ADDR)
 xfs_alloc_rec_t *xfs_alloc_rec_addr(xfs_alloc_block_t *bb, int i,
 				    struct xfs_btree_cur *cur);
 #define	XFS_ALLOC_REC_ADDR(bb,i,cur)	xfs_alloc_rec_addr(bb,i,cur)
 #else
 #define	XFS_ALLOC_REC_ADDR(bb,i,cur)	\
 	XFS_BTREE_REC_ADDR(XFS_ALLOC_BLOCK_SIZE(0,cur), xfs_alloc, bb, i, \
 		XFS_ALLOC_BLOCK_MAXRECS(0, cur))
 #endif

 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_KEY_ADDR)
 xfs_alloc_key_t *xfs_alloc_key_addr(xfs_alloc_block_t *bb, int i,
 				    struct xfs_btree_cur *cur);
 #define	XFS_ALLOC_KEY_ADDR(bb,i,cur)	xfs_alloc_key_addr(bb,i,cur)
 #else
 #define	XFS_ALLOC_KEY_ADDR(bb,i,cur)	\
 	XFS_BTREE_KEY_ADDR(XFS_ALLOC_BLOCK_SIZE(1,cur), xfs_alloc, bb, i, \
 		XFS_ALLOC_BLOCK_MAXRECS(1, cur))
 #endif

 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_PTR_ADDR)
 xfs_alloc_ptr_t *xfs_alloc_ptr_addr(xfs_alloc_block_t *bb, int i,
 				    struct xfs_btree_cur *cur);
 #define	XFS_ALLOC_PTR_ADDR(bb,i,cur)	xfs_alloc_ptr_addr(bb,i,cur)
 #else
 #define	XFS_ALLOC_PTR_ADDR(bb,i,cur)	\
 	XFS_BTREE_PTR_ADDR(XFS_ALLOC_BLOCK_SIZE(1,cur), xfs_alloc, bb, i, \
 		XFS_ALLOC_BLOCK_MAXRECS(1, cur))
 #endif

 /*
  * Prototypes for externally visible routines.
  */

 /*
  * Decrement cursor by one record at the level.
  * For nonzero levels the leaf-ward information is untouched.
  */
 int					/* error */
 xfs_alloc_decrement(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	int			level,	/* level in btree, 0 is leaf */
 	int			*stat);	/* success/failure */

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

 /*
  * Get the data from the pointed-to record.
  */
 int					/* error */
 xfs_alloc_get_rec(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	xfs_agblock_t		*bno,	/* output: starting block of extent */
 	xfs_extlen_t		*len,	/* output: length of extent */
 	int			*stat);	/* output: success/failure */

 /*
  * Increment cursor by one record at the level.
  * For nonzero levels the leaf-ward information is untouched.
  */
 int					/* error */
 xfs_alloc_increment(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	int			level,	/* level in btree, 0 is leaf */
 	int			*stat);	/* success/failure */

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

 /*
  * Lookup the record equal to [bno, len] in the btree given by cur.
  */
 int					/* error */
 xfs_alloc_lookup_eq(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	xfs_agblock_t		bno,	/* starting block of extent */
 	xfs_extlen_t		len,	/* length of extent */
 	int			*stat);	/* success/failure */

 /*
  * Lookup the first record greater than or equal to [bno, len]
  * in the btree given by cur.
  */
 int					/* error */
 xfs_alloc_lookup_ge(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	xfs_agblock_t		bno,	/* starting block of extent */
 	xfs_extlen_t		len,	/* length of extent */
 	int			*stat);	/* success/failure */

 /*
  * Lookup the first record less than or equal to [bno, len]
  * in the btree given by cur.
  */
 int					/* error */
 xfs_alloc_lookup_le(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	xfs_agblock_t		bno,	/* starting block of extent */
 	xfs_extlen_t		len,	/* length of extent */
 	int			*stat);	/* success/failure */

 /*
  * Update the record referred to by cur, to the value given by [bno, len].
  * This either works (return 0) or gets an EFSCORRUPTED error.
  */
 int					/* error */
 xfs_alloc_update(
 	struct xfs_btree_cur	*cur,	/* btree cursor */
 	xfs_agblock_t		bno,	/* starting block of extent */
 	xfs_extlen_t		len);	/* length of extent */

 #endif	/* __XFS_ALLOC_BTREE_H__ */
	/*
	* Copyright (c) 2000 Silicon Graphics, Inc. All Rights Reserved.
	*
	* This program is free software; you can redistribute it and/or modify it
	* under the terms of version 2 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.
	*
	* Further, this software is distributed without any warranty that it is
	* free of the rightful claim of any third person regarding infringement
	* or the like. Any license provided herein, whether implied or
	* otherwise, applies only to this software file. Patent licenses, if
	* any, provided herein do not apply to combinations of this program with
	* other software, or any other product whatsoever.
	*
	* You should have received a copy of the GNU General Public License along
	* with this program; if not, write the Free Software Foundation, Inc., 59
	* Temple Place - Suite 330, Boston MA 02111-1307, USA.
	*
	* Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
	* Mountain View, CA 94043, or:
	*
	* http://www.sgi.com
	*
	* For further information regarding this notice, see:
	*
	* http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
	*/
	#ifndef __XFS_ALLOC_BTREE_H__
	#define __XFS_ALLOC_BTREE_H__

	/*
	* Freespace on-disk structures
	*/

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

	/*
	* There are two on-disk btrees, one sorted by blockno and one sorted
	* by blockcount and blockno. All blocks look the same to make the code
	* simpler; if we have time later, we'll make the optimizations.
	*/
	#define XFS_ABTB_MAGIC 0x41425442 /* 'ABTB' for bno tree */
	#define XFS_ABTC_MAGIC 0x41425443 /* 'ABTC' for cnt tree */

	/*
	* Data record/key structure
	*/
	typedef struct xfs_alloc_rec
	{
	xfs_agblock_t ar_startblock; /* starting block number */
	xfs_extlen_t ar_blockcount; /* count of free blocks */
	} xfs_alloc_rec_t, xfs_alloc_key_t;

	typedef xfs_agblock_t xfs_alloc_ptr_t; /* btree pointer type */
	/* btree block header type */
	typedef struct xfs_btree_sblock xfs_alloc_block_t;

	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_BUF_TO_ALLOC_BLOCK)
	xfs_alloc_block_t xfs_buf_to_alloc_block(struct xfs_buf bp);
	#define XFS_BUF_TO_ALLOC_BLOCK(bp) xfs_buf_to_alloc_block(bp)
	#else
	#define XFS_BUF_TO_ALLOC_BLOCK(bp) ((xfs_alloc_block_t *)(XFS_BUF_PTR(bp)))
	#endif

	/*
	* Real block structures have a size equal to the disk block size.
	*/

	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_BLOCK_SIZE)
	int xfs_alloc_block_size(int lev, struct xfs_btree_cur *cur);
	#define XFS_ALLOC_BLOCK_SIZE(lev,cur) xfs_alloc_block_size(lev,cur)
	#else
	#define XFS_ALLOC_BLOCK_SIZE(lev,cur) (1 << (cur)->bc_blocklog)
	#endif

	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_BLOCK_MAXRECS)
	int xfs_alloc_block_maxrecs(int lev, struct xfs_btree_cur *cur);
	#define XFS_ALLOC_BLOCK_MAXRECS(lev,cur) xfs_alloc_block_maxrecs(lev,cur)
	#else
	#define XFS_ALLOC_BLOCK_MAXRECS(lev,cur) \
	((cur)->bc_mp->m_alloc_mxr[lev != 0])
	#endif
	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_BLOCK_MINRECS)
	int xfs_alloc_block_minrecs(int lev, struct xfs_btree_cur *cur);
	#define XFS_ALLOC_BLOCK_MINRECS(lev,cur) xfs_alloc_block_minrecs(lev,cur)
	#else
	#define XFS_ALLOC_BLOCK_MINRECS(lev,cur) \
	((cur)->bc_mp->m_alloc_mnr[lev != 0])
	#endif

	/*
	* Minimum and maximum blocksize and sectorsize.
	* The blocksize upper limit is pretty much arbitrary.
	* The sectorsize upper limit is due to sizeof(sb_sectsize).
	*/
	#define XFS_MIN_BLOCKSIZE_LOG 9 /* i.e. 512 bytes */
	#define XFS_MAX_BLOCKSIZE_LOG 16 /* i.e. 65536 bytes */
	#define XFS_MIN_BLOCKSIZE (1 << XFS_MIN_BLOCKSIZE_LOG)
	#define XFS_MAX_BLOCKSIZE (1 << XFS_MAX_BLOCKSIZE_LOG)
	#define XFS_MIN_SECTORSIZE_LOG 9 /* i.e. 512 bytes */
	#define XFS_MAX_SECTORSIZE_LOG 15 /* i.e. 32768 bytes */
	#define XFS_MIN_SECTORSIZE (1 << XFS_MIN_SECTORSIZE_LOG)
	#define XFS_MAX_SECTORSIZE (1 << XFS_MAX_SECTORSIZE_LOG)

	/*
	* Block numbers in the AG:
	* SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3.
	*/
	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_BNO_BLOCK)
	xfs_agblock_t xfs_bno_block(struct xfs_mount *mp);
	#define XFS_BNO_BLOCK(mp) xfs_bno_block(mp)
	#else
	#define XFS_BNO_BLOCK(mp) ((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1))
	#endif
	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_CNT_BLOCK)
	xfs_agblock_t xfs_cnt_block(struct xfs_mount *mp);
	#define XFS_CNT_BLOCK(mp) xfs_cnt_block(mp)
	#else
	#define XFS_CNT_BLOCK(mp) ((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1))
	#endif

	/*
	* Record, key, and pointer address macros for btree blocks.
	*/
	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_REC_ADDR)
	xfs_alloc_rec_t xfs_alloc_rec_addr(xfs_alloc_block_t bb, int i,
	struct xfs_btree_cur *cur);
	#define XFS_ALLOC_REC_ADDR(bb,i,cur) xfs_alloc_rec_addr(bb,i,cur)
	#else
	#define XFS_ALLOC_REC_ADDR(bb,i,cur) \
	XFS_BTREE_REC_ADDR(XFS_ALLOC_BLOCK_SIZE(0,cur), xfs_alloc, bb, i, \
	XFS_ALLOC_BLOCK_MAXRECS(0, cur))
	#endif

	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_KEY_ADDR)
	xfs_alloc_key_t xfs_alloc_key_addr(xfs_alloc_block_t bb, int i,
	struct xfs_btree_cur *cur);
	#define XFS_ALLOC_KEY_ADDR(bb,i,cur) xfs_alloc_key_addr(bb,i,cur)
	#else
	#define XFS_ALLOC_KEY_ADDR(bb,i,cur) \
	XFS_BTREE_KEY_ADDR(XFS_ALLOC_BLOCK_SIZE(1,cur), xfs_alloc, bb, i, \
	XFS_ALLOC_BLOCK_MAXRECS(1, cur))
	#endif

	#if XFS_WANT_FUNCS \|\| (XFS_WANT_SPACE && XFSSO_XFS_ALLOC_PTR_ADDR)
	xfs_alloc_ptr_t xfs_alloc_ptr_addr(xfs_alloc_block_t bb, int i,
	struct xfs_btree_cur *cur);
	#define XFS_ALLOC_PTR_ADDR(bb,i,cur) xfs_alloc_ptr_addr(bb,i,cur)
	#else
	#define XFS_ALLOC_PTR_ADDR(bb,i,cur) \
	XFS_BTREE_PTR_ADDR(XFS_ALLOC_BLOCK_SIZE(1,cur), xfs_alloc, bb, i, \
	XFS_ALLOC_BLOCK_MAXRECS(1, cur))
	#endif

	/*
	* Prototypes for externally visible routines.
	*/

	/*
	* Decrement cursor by one record at the level.
	* For nonzero levels the leaf-ward information is untouched.
	*/
	int /* error */
	xfs_alloc_decrement(
	struct xfs_btree_cur cur, / btree cursor */
	int level, /* level in btree, 0 is leaf */
	int stat); / success/failure */

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

	/*
	* Get the data from the pointed-to record.
	*/
	int /* error */
	xfs_alloc_get_rec(
	struct xfs_btree_cur cur, / btree cursor */
	xfs_agblock_t bno, / output: starting block of extent */
	xfs_extlen_t len, / output: length of extent */
	int stat); / output: success/failure */

	/*
	* Increment cursor by one record at the level.
	* For nonzero levels the leaf-ward information is untouched.
	*/
	int /* error */
	xfs_alloc_increment(
	struct xfs_btree_cur cur, / btree cursor */
	int level, /* level in btree, 0 is leaf */
	int stat); / success/failure */

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

	/*
	* Lookup the record equal to [bno, len] in the btree given by cur.
	*/
	int /* error */
	xfs_alloc_lookup_eq(
	struct xfs_btree_cur cur, / btree cursor */
	xfs_agblock_t bno, /* starting block of extent */
	xfs_extlen_t len, /* length of extent */
	int stat); / success/failure */

	/*
	* Lookup the first record greater than or equal to [bno, len]
	* in the btree given by cur.
	*/
	int /* error */
	xfs_alloc_lookup_ge(
	struct xfs_btree_cur cur, / btree cursor */
	xfs_agblock_t bno, /* starting block of extent */
	xfs_extlen_t len, /* length of extent */
	int stat); / success/failure */

	/*
	* Lookup the first record less than or equal to [bno, len]
	* in the btree given by cur.
	*/
	int /* error */
	xfs_alloc_lookup_le(
	struct xfs_btree_cur cur, / btree cursor */
	xfs_agblock_t bno, /* starting block of extent */
	xfs_extlen_t len, /* length of extent */
	int stat); / success/failure */

	/*
	* Update the record referred to by cur, to the value given by [bno, len].
	* This either works (return 0) or gets an EFSCORRUPTED error.
	*/
	int /* error */
	xfs_alloc_update(
	struct xfs_btree_cur cur, / btree cursor */
	xfs_agblock_t bno, /* starting block of extent */
	xfs_extlen_t len); /* length of extent */

	#endif /* __XFS_ALLOC_BTREE_H__ */