[thirdparty/xfsprogs-dev.git] / libxfs / xfs_alloc.h

/*
 * Copyright (c) 2000-2002,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_ALLOC_H__
#define	__XFS_ALLOC_H__

struct xfs_buf;
struct xfs_btree_cur;
struct xfs_mount;
struct xfs_perag;
struct xfs_trans;

extern struct workqueue_struct *xfs_alloc_wq;

/*
 * Freespace allocation types.  Argument to xfs_alloc_[v]extent.
 */
#define XFS_ALLOCTYPE_FIRST_AG	0x02	/* ... start at ag 0 */
#define XFS_ALLOCTYPE_THIS_AG	0x08	/* anywhere in this a.g. */
#define XFS_ALLOCTYPE_START_BNO	0x10	/* near this block else anywhere */
#define XFS_ALLOCTYPE_NEAR_BNO	0x20	/* in this a.g. and near this block */
#define XFS_ALLOCTYPE_THIS_BNO	0x40	/* at exactly this block */

/* this should become an enum again when the tracing code is fixed */
typedef unsigned int xfs_alloctype_t;

#define XFS_ALLOC_TYPES \
	{ XFS_ALLOCTYPE_FIRST_AG,	"FIRST_AG" }, \
	{ XFS_ALLOCTYPE_THIS_AG,	"THIS_AG" }, \
	{ XFS_ALLOCTYPE_START_BNO,	"START_BNO" }, \
	{ XFS_ALLOCTYPE_NEAR_BNO,	"NEAR_BNO" }, \
	{ XFS_ALLOCTYPE_THIS_BNO,	"THIS_BNO" }

/*
 * Flags for xfs_alloc_fix_freelist.
 */
#define	XFS_ALLOC_FLAG_TRYLOCK	0x00000001  /* use trylock for buffer locking */
#define	XFS_ALLOC_FLAG_FREEING	0x00000002  /* indicate caller is freeing extents*/
#define	XFS_ALLOC_FLAG_NORMAP	0x00000004  /* don't modify the rmapbt */
#define	XFS_ALLOC_FLAG_NOSHRINK	0x00000008  /* don't shrink the freelist */
#define	XFS_ALLOC_FLAG_CHECK	0x00000010  /* test only, don't modify args */

/*
 * Argument structure for xfs_alloc routines.
 * This is turned into a structure to avoid having 20 arguments passed
 * down several levels of the stack.
 */
typedef struct xfs_alloc_arg {
	struct xfs_trans *tp;		/* transaction pointer */
	struct xfs_mount *mp;		/* file system mount point */
	struct xfs_buf	*agbp;		/* buffer for a.g. freelist header */
	struct xfs_perag *pag;		/* per-ag struct for this agno */
	struct xfs_inode *ip;		/* for userdata zeroing method */
	xfs_fsblock_t	fsbno;		/* file system block number */
	xfs_agnumber_t	agno;		/* allocation group number */
	xfs_agblock_t	agbno;		/* allocation group-relative block # */
	xfs_extlen_t	minlen;		/* minimum size of extent */
	xfs_extlen_t	maxlen;		/* maximum size of extent */
	xfs_extlen_t	mod;		/* mod value for extent size */
	xfs_extlen_t	prod;		/* prod value for extent size */
	xfs_extlen_t	minleft;	/* min blocks must be left after us */
	xfs_extlen_t	total;		/* total blocks needed in xaction */
	xfs_extlen_t	alignment;	/* align answer to multiple of this */
	xfs_extlen_t	minalignslop;	/* slop for minlen+alignment calcs */
	xfs_agblock_t	min_agbno;	/* set an agbno range for NEAR allocs */
	xfs_agblock_t	max_agbno;	/* ... */
	xfs_extlen_t	len;		/* output: actual size of extent */
	xfs_alloctype_t	type;		/* allocation type XFS_ALLOCTYPE_... */
	xfs_alloctype_t	otype;		/* original allocation type */
	int		datatype;	/* mask defining data type treatment */
	char		wasdel;		/* set if allocation was prev delayed */
	char		wasfromfl;	/* set if allocation is from freelist */
	xfs_fsblock_t	firstblock;	/* io first block allocated */
	struct xfs_owner_info	oinfo;	/* owner of blocks being allocated */
	enum xfs_ag_resv_type	resv;	/* block reservation to use */
} xfs_alloc_arg_t;

/*
 * Defines for datatype
 */
#define XFS_ALLOC_USERDATA		(1 << 0)/* allocation is for user data*/
#define XFS_ALLOC_INITIAL_USER_DATA	(1 << 1)/* special case start of file */
#define XFS_ALLOC_USERDATA_ZERO		(1 << 2)/* zero extent on allocation */
#define XFS_ALLOC_NOBUSY		(1 << 3)/* Busy extents not allowed */

static inline bool
xfs_alloc_is_userdata(int datatype)
{
	return (datatype & ~XFS_ALLOC_NOBUSY) != 0;
}

static inline bool
xfs_alloc_allow_busy_reuse(int datatype)
{
	return (datatype & XFS_ALLOC_NOBUSY) == 0;
}

/* freespace limit calculations */
#define XFS_ALLOC_AGFL_RESERVE	4
unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);

xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_mount *mp,
		struct xfs_perag *pag, xfs_extlen_t need,
		xfs_extlen_t reserved);
unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
		struct xfs_perag *pag);

/*
 * Compute and fill in value of m_ag_maxlevels.
 */
void
xfs_alloc_compute_maxlevels(
	struct xfs_mount	*mp);	/* file system mount structure */

/*
 * Get a block from the freelist.
 * Returns with the buffer for the block gotten.
 */
int				/* error */
xfs_alloc_get_freelist(
	struct xfs_trans *tp,	/* transaction pointer */
	struct xfs_buf	*agbp,	/* buffer containing the agf structure */
	xfs_agblock_t	*bnop,	/* block address retrieved from freelist */
	int		btreeblk); /* destination is a AGF btree */

/*
 * Log the given fields from the agf structure.
 */
void
xfs_alloc_log_agf(
	struct xfs_trans *tp,	/* transaction pointer */
	struct xfs_buf	*bp,	/* buffer for a.g. freelist header */
	int		fields);/* mask of fields to be logged (XFS_AGF_...) */

/*
 * Interface for inode allocation to force the pag data to be initialized.
 */
int				/* error */
xfs_alloc_pagf_init(
	struct xfs_mount *mp,	/* file system mount structure */
	struct xfs_trans *tp,	/* transaction pointer */
	xfs_agnumber_t	agno,	/* allocation group number */
	int		flags);	/* XFS_ALLOC_FLAGS_... */

/*
 * Put the block on the freelist for the allocation group.
 */
int				/* error */
xfs_alloc_put_freelist(
	struct xfs_trans *tp,	/* transaction pointer */
	struct xfs_buf	*agbp,	/* buffer for a.g. freelist header */
	struct xfs_buf	*agflbp,/* buffer for a.g. free block array */
	xfs_agblock_t	bno,	/* block being freed */
	int		btreeblk); /* owner was a AGF btree */

/*
 * Read in the allocation group header (free/alloc section).
 */
int					/* error  */
xfs_alloc_read_agf(
	struct xfs_mount *mp,		/* mount point structure */
	struct xfs_trans *tp,		/* transaction pointer */
	xfs_agnumber_t	agno,		/* allocation group number */
	int		flags,		/* XFS_ALLOC_FLAG_... */
	struct xfs_buf	**bpp);		/* buffer for the ag freelist header */

/*
 * Allocate an extent (variable-size).
 */
int				/* error */
xfs_alloc_vextent(
	xfs_alloc_arg_t	*args);	/* allocation argument structure */

/*
 * Free an extent.
 */
int				/* error */
xfs_free_extent(
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_fsblock_t		bno,	/* starting block number of extent */
	xfs_extlen_t		len,	/* length of extent */
	struct xfs_owner_info	*oinfo,	/* extent owner */
	enum xfs_ag_resv_type	type);	/* block reservation type */

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

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

int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
			xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
int xfs_free_extent_fix_freelist(struct xfs_trans *tp, xfs_agnumber_t agno,
		struct xfs_buf **agbp);

xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);

typedef int (*xfs_alloc_query_range_fn)(
	struct xfs_btree_cur		*cur,
	struct xfs_alloc_rec_incore	*rec,
	void				*priv);

int xfs_alloc_query_range(struct xfs_btree_cur *cur,
		struct xfs_alloc_rec_incore *low_rec,
		struct xfs_alloc_rec_incore *high_rec,
		xfs_alloc_query_range_fn fn, void *priv);
int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
		void *priv);

#endif	/* __XFS_ALLOC_H__ */
Commit	Line	Data
2bd0ea18	1	/*
f302e9e4 NS	2	* Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
f302e9e4 NS	3	* All Rights Reserved.
5000d01d	4	*
f302e9e4 NS	5	* This program is free software; you can redistribute it and/or
f302e9e4 NS	6	* modify it under the terms of the GNU General Public License as
2bd0ea18	7	* published by the Free Software Foundation.
5000d01d	8	*
f302e9e4 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.
5000d01d	13	*
f302e9e4 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
2bd0ea18 NS	17	*/
2bd0ea18 NS	18	#ifndef __XFS_ALLOC_H__
dfc130f3	19	#define __XFS_ALLOC_H__
2bd0ea18 NS	20
2bd0ea18 NS	21	struct xfs_buf;
a2ceac1f	22	struct xfs_btree_cur;
2bd0ea18 NS	23	struct xfs_mount;
	24	struct xfs_perag;
	25	struct xfs_trans;
a2ceac1f DC	26
a2ceac1f DC	27	extern struct workqueue_struct *xfs_alloc_wq;
2bd0ea18 NS	28
2bd0ea18 NS	29	/*
dfc130f3	30	* Freespace allocation types. Argument to xfs_alloc_[v]extent.
2bd0ea18	31	*/
56b2de80	32	#define XFS_ALLOCTYPE_FIRST_AG 0x02 /* ... start at ag 0 */
56b2de80 DC	33	#define XFS_ALLOCTYPE_THIS_AG 0x08 /* anywhere in this a.g. */
	34	#define XFS_ALLOCTYPE_START_BNO 0x10 /* near this block else anywhere */
	35	#define XFS_ALLOCTYPE_NEAR_BNO 0x20 /* in this a.g. and near this block */
	36	#define XFS_ALLOCTYPE_THIS_BNO 0x40 /* at exactly this block */
	37
	38	/* this should become an enum again when the tracing code is fixed */
	39	typedef unsigned int xfs_alloctype_t;
	40
	41	#define XFS_ALLOC_TYPES \
56b2de80	42	{ XFS_ALLOCTYPE_FIRST_AG, "FIRST_AG" }, \
56b2de80 DC	43	{ XFS_ALLOCTYPE_THIS_AG, "THIS_AG" }, \
	44	{ XFS_ALLOCTYPE_START_BNO, "START_BNO" }, \
	45	{ XFS_ALLOCTYPE_NEAR_BNO, "NEAR_BNO" }, \
	46	{ XFS_ALLOCTYPE_THIS_BNO, "THIS_BNO" }
2bd0ea18 NS	47
	48	/*
	49	* Flags for xfs_alloc_fix_freelist.
	50	*/
dfc130f3	51	#define XFS_ALLOC_FLAG_TRYLOCK 0x00000001 /* use trylock for buffer locking */
5e656dbb	52	#define XFS_ALLOC_FLAG_FREEING 0x00000002 /* indicate caller is freeing extents*/
e365af6f DW	53	#define XFS_ALLOC_FLAG_NORMAP 0x00000004 /* don't modify the rmapbt */
e365af6f DW	54	#define XFS_ALLOC_FLAG_NOSHRINK 0x00000008 /* don't shrink the freelist */
2c003dc2	55	#define XFS_ALLOC_FLAG_CHECK 0x00000010 /* test only, don't modify args */
5e656dbb	56
2bd0ea18 NS	57	/*
	58	* Argument structure for xfs_alloc routines.
	59	* This is turned into a structure to avoid having 20 arguments passed
	60	* down several levels of the stack.
	61	*/
	62	typedef struct xfs_alloc_arg {
	63	struct xfs_trans tp; / transaction pointer */
	64	struct xfs_mount mp; / file system mount point */
	65	struct xfs_buf agbp; / buffer for a.g. freelist header */
	66	struct xfs_perag pag; / per-ag struct for this agno */
9542ae13	67	struct xfs_inode ip; / for userdata zeroing method */
2bd0ea18 NS	68	xfs_fsblock_t fsbno; /* file system block number */
	69	xfs_agnumber_t agno; /* allocation group number */
	70	xfs_agblock_t agbno; /* allocation group-relative block # */
	71	xfs_extlen_t minlen; /* minimum size of extent */
	72	xfs_extlen_t maxlen; /* maximum size of extent */
	73	xfs_extlen_t mod; /* mod value for extent size */
	74	xfs_extlen_t prod; /* prod value for extent size */
	75	xfs_extlen_t minleft; /* min blocks must be left after us */
	76	xfs_extlen_t total; /* total blocks needed in xaction */
	77	xfs_extlen_t alignment; /* align answer to multiple of this */
	78	xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
ff3263dd BF	79	xfs_agblock_t min_agbno; /* set an agbno range for NEAR allocs */
ff3263dd BF	80	xfs_agblock_t max_agbno; /* ... */
2bd0ea18	81	xfs_extlen_t len; /* output: actual size of extent */
dfc130f3 RC	82	xfs_alloctype_t type; /* allocation type XFS_ALLOCTYPE_... */
dfc130f3 RC	83	xfs_alloctype_t otype; /* original allocation type */
1fccd5c8	84	int datatype; /* mask defining data type treatment */
2bd0ea18 NS	85	char wasdel; /* set if allocation was prev delayed */
2bd0ea18 NS	86	char wasfromfl; /* set if allocation is from freelist */
5e656dbb	87	xfs_fsblock_t firstblock; /* io first block allocated */
85aec44f	88	struct xfs_owner_info oinfo; /* owner of blocks being allocated */
cf8ce220	89	enum xfs_ag_resv_type resv; /* block reservation to use */
2bd0ea18 NS	90	} xfs_alloc_arg_t;
2bd0ea18 NS	91
34317449	92	/*
1fccd5c8	93	* Defines for datatype
34317449	94	*/
9542ae13 DC	95	#define XFS_ALLOC_USERDATA (1 << 0)/* allocation is for user data*/
	96	#define XFS_ALLOC_INITIAL_USER_DATA (1 << 1)/* special case start of file */
	97	#define XFS_ALLOC_USERDATA_ZERO (1 << 2)/* zero extent on allocation */
1fccd5c8 DC	98	#define XFS_ALLOC_NOBUSY (1 << 3)/* Busy extents not allowed */
	99
	100	static inline bool
	101	xfs_alloc_is_userdata(int datatype)
	102	{
	103	return (datatype & ~XFS_ALLOC_NOBUSY) != 0;
	104	}
	105
	106	static inline bool
	107	xfs_alloc_allow_busy_reuse(int datatype)
	108	{
	109	return (datatype & XFS_ALLOC_NOBUSY) == 0;
	110	}
34317449	111
b8a8d6e5 DW	112	/* freespace limit calculations */
	113	#define XFS_ALLOC_AGFL_RESERVE 4
	114	unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
	115	unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
	116
72bda06d	117	xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_mount *mp,
cf8ce220 DW	118	struct xfs_perag *pag, xfs_extlen_t need,
cf8ce220 DW	119	xfs_extlen_t reserved);
de046644 DC	120	unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
de046644 DC	121	struct xfs_perag *pag);
23aab3f9	122
2bd0ea18 NS	123	/*
	124	* Compute and fill in value of m_ag_maxlevels.
	125	*/
	126	void
	127	xfs_alloc_compute_maxlevels(
	128	struct xfs_mount mp); / file system mount structure */
	129
2bd0ea18 NS	130	/*
	131	* Get a block from the freelist.
	132	* Returns with the buffer for the block gotten.
	133	*/
	134	int /* error */
	135	xfs_alloc_get_freelist(
	136	struct xfs_trans tp, / transaction pointer */
	137	struct xfs_buf agbp, / buffer containing the agf structure */
cdded3d8 DC	138	xfs_agblock_t bnop, / block address retrieved from freelist */
cdded3d8 DC	139	int btreeblk); /* destination is a AGF btree */
2bd0ea18 NS	140
	141	/*
	142	* Log the given fields from the agf structure.
	143	*/
	144	void
	145	xfs_alloc_log_agf(
	146	struct xfs_trans tp, / transaction pointer */
	147	struct xfs_buf bp, / buffer for a.g. freelist header */
	148	int fields);/* mask of fields to be logged (XFS_AGF_...) */
	149
	150	/*
	151	* Interface for inode allocation to force the pag data to be initialized.
	152	*/
	153	int /* error */
	154	xfs_alloc_pagf_init(
	155	struct xfs_mount mp, / file system mount structure */
	156	struct xfs_trans tp, / transaction pointer */
	157	xfs_agnumber_t agno, /* allocation group number */
dfc130f3	158	int flags); /* XFS_ALLOC_FLAGS_... */
2bd0ea18 NS	159
	160	/*
	161	* Put the block on the freelist for the allocation group.
	162	*/
	163	int /* error */
	164	xfs_alloc_put_freelist(
	165	struct xfs_trans tp, / transaction pointer */
	166	struct xfs_buf agbp, / buffer for a.g. freelist header */
	167	struct xfs_buf agflbp,/ buffer for a.g. free block array */
cdded3d8 DC	168	xfs_agblock_t bno, /* block being freed */
cdded3d8 DC	169	int btreeblk); /* owner was a AGF btree */
2bd0ea18 NS	170
	171	/*
	172	* Read in the allocation group header (free/alloc section).
	173	*/
	174	int /* error */
	175	xfs_alloc_read_agf(
	176	struct xfs_mount mp, / mount point structure */
	177	struct xfs_trans tp, / transaction pointer */
	178	xfs_agnumber_t agno, /* allocation group number */
	179	int flags, /* XFS_ALLOC_FLAG_... */
	180	struct xfs_buf *bpp); / buffer for the ag freelist header */
	181
	182	/*
	183	* Allocate an extent (variable-size).
	184	*/
	185	int /* error */
	186	xfs_alloc_vextent(
dfc130f3	187	xfs_alloc_arg_t args); / allocation argument structure */
2bd0ea18 NS	188
	189	/*
	190	* Free an extent.
	191	*/
	192	int /* error */
	193	xfs_free_extent(
85aec44f DW	194	struct xfs_trans tp, / transaction pointer */
	195	xfs_fsblock_t bno, /* starting block number of extent */
	196	xfs_extlen_t len, /* length of extent */
cf8ce220 DW	197	struct xfs_owner_info oinfo, / extent owner */
cf8ce220 DW	198	enum xfs_ag_resv_type type); /* block reservation type */
2bd0ea18	199
a2ceac1f DC	200	int /* error */
	201	xfs_alloc_lookup_ge(
	202	struct xfs_btree_cur cur, / btree cursor */
	203	xfs_agblock_t bno, /* starting block of extent */
	204	xfs_extlen_t len, /* length of extent */
	205	int stat); / success/failure */
	206
	207	int /* error */
	208	xfs_alloc_get_rec(
	209	struct xfs_btree_cur cur, / btree cursor */
	210	xfs_agblock_t bno, / output: starting block of extent */
	211	xfs_extlen_t len, / output: length of extent */
	212	int stat); / output: success/failure */
	213
5a35bf2c DC	214	int xfs_read_agf(struct xfs_mount mp, struct xfs_trans tp,
5a35bf2c DC	215	xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
e515cca1	216	int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
2a6da3b8 DC	217	int xfs_free_extent_fix_freelist(struct xfs_trans *tp, xfs_agnumber_t agno,
2a6da3b8 DC	218	struct xfs_buf **agbp);
5a35bf2c	219
ef5340cd DW	220	xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
ef5340cd DW	221
b3d83fa6 DW	222	typedef int (*xfs_alloc_query_range_fn)(
	223	struct xfs_btree_cur *cur,
	224	struct xfs_alloc_rec_incore *rec,
	225	void *priv);
	226
	227	int xfs_alloc_query_range(struct xfs_btree_cur *cur,
	228	struct xfs_alloc_rec_incore *low_rec,
	229	struct xfs_alloc_rec_incore *high_rec,
	230	xfs_alloc_query_range_fn fn, void *priv);
7e05e856 DW	231	int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
7e05e856 DW	232	void *priv);
b3d83fa6	233
2bd0ea18	234	#endif /* __XFS_ALLOC_H__ */