[mirror_ubuntu-artful-kernel.git] / fs / xfs / 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_ANY_AG	0x01	/* allocate anywhere, use rotor */
#define XFS_ALLOCTYPE_FIRST_AG	0x02	/* ... start at ag 0 */
#define XFS_ALLOCTYPE_START_AG	0x04	/* anywhere, start in this a.g. */
#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_ANY_AG,		"ANY_AG" }, \
	{ XFS_ALLOCTYPE_FIRST_AG,	"FIRST_AG" }, \
	{ XFS_ALLOCTYPE_START_AG,	"START_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 */


/*
 * 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 */
	char		wasdel;		/* set if allocation was prev delayed */
	char		wasfromfl;	/* set if allocation is from freelist */
	char		userdata;	/* mask defining userdata treatment */
	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 userdata
 */
#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 */

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

#endif	/* __XFS_ALLOC_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000-2002,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_ALLOC_H__
	19	#define __XFS_ALLOC_H__
	20
	21	struct xfs_buf;
a46db608	22	struct xfs_btree_cur;
1da177e4 LT	23	struct xfs_mount;
	24	struct xfs_perag;
	25	struct xfs_trans;
	26
c999a223 DC	27	extern struct workqueue_struct *xfs_alloc_wq;
c999a223 DC	28
1da177e4 LT	29	/*
	30	* Freespace allocation types. Argument to xfs_alloc_[v]extent.
	31	*/
807cbbdb CH	32	#define XFS_ALLOCTYPE_ANY_AG 0x01 /* allocate anywhere, use rotor */
	33	#define XFS_ALLOCTYPE_FIRST_AG 0x02 /* ... start at ag 0 */
	34	#define XFS_ALLOCTYPE_START_AG 0x04 /* anywhere, start in this a.g. */
	35	#define XFS_ALLOCTYPE_THIS_AG 0x08 /* anywhere in this a.g. */
	36	#define XFS_ALLOCTYPE_START_BNO 0x10 /* near this block else anywhere */
	37	#define XFS_ALLOCTYPE_NEAR_BNO 0x20 /* in this a.g. and near this block */
	38	#define XFS_ALLOCTYPE_THIS_BNO 0x40 /* at exactly this block */
	39
	40	/* this should become an enum again when the tracing code is fixed */
	41	typedef unsigned int xfs_alloctype_t;
1da177e4	42
0b1b213f CH	43	#define XFS_ALLOC_TYPES \
	44	{ XFS_ALLOCTYPE_ANY_AG, "ANY_AG" }, \
	45	{ XFS_ALLOCTYPE_FIRST_AG, "FIRST_AG" }, \
	46	{ XFS_ALLOCTYPE_START_AG, "START_AG" }, \
	47	{ XFS_ALLOCTYPE_THIS_AG, "THIS_AG" }, \
	48	{ XFS_ALLOCTYPE_START_BNO, "START_BNO" }, \
	49	{ XFS_ALLOCTYPE_NEAR_BNO, "NEAR_BNO" }, \
	50	{ XFS_ALLOCTYPE_THIS_BNO, "THIS_BNO" }
	51
1da177e4 LT	52	/*
	53	* Flags for xfs_alloc_fix_freelist.
	54	*/
	55	#define XFS_ALLOC_FLAG_TRYLOCK 0x00000001 /* use trylock for buffer locking */
d210a28c	56	#define XFS_ALLOC_FLAG_FREEING 0x00000002 /* indicate caller is freeing extents*/
04f13060 DW	57	#define XFS_ALLOC_FLAG_NORMAP 0x00000004 /* don't modify the rmapbt */
	58	#define XFS_ALLOC_FLAG_NOSHRINK 0x00000008 /* don't shrink the freelist */
	59
1da177e4 LT	60
	61	/*
	62	* Argument structure for xfs_alloc routines.
	63	* This is turned into a structure to avoid having 20 arguments passed
	64	* down several levels of the stack.
	65	*/
	66	typedef struct xfs_alloc_arg {
	67	struct xfs_trans tp; / transaction pointer */
	68	struct xfs_mount mp; / file system mount point */
	69	struct xfs_buf agbp; / buffer for a.g. freelist header */
	70	struct xfs_perag pag; / per-ag struct for this agno */
3fbbbea3	71	struct xfs_inode ip; / for userdata zeroing method */
1da177e4 LT	72	xfs_fsblock_t fsbno; /* file system block number */
	73	xfs_agnumber_t agno; /* allocation group number */
	74	xfs_agblock_t agbno; /* allocation group-relative block # */
	75	xfs_extlen_t minlen; /* minimum size of extent */
	76	xfs_extlen_t maxlen; /* maximum size of extent */
	77	xfs_extlen_t mod; /* mod value for extent size */
	78	xfs_extlen_t prod; /* prod value for extent size */
	79	xfs_extlen_t minleft; /* min blocks must be left after us */
	80	xfs_extlen_t total; /* total blocks needed in xaction */
	81	xfs_extlen_t alignment; /* align answer to multiple of this */
	82	xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
bfe46d4e BF	83	xfs_agblock_t min_agbno; /* set an agbno range for NEAR allocs */
bfe46d4e BF	84	xfs_agblock_t max_agbno; /* ... */
1da177e4 LT	85	xfs_extlen_t len; /* output: actual size of extent */
	86	xfs_alloctype_t type; /* allocation type XFS_ALLOCTYPE_... */
	87	xfs_alloctype_t otype; /* original allocation type */
	88	char wasdel; /* set if allocation was prev delayed */
	89	char wasfromfl; /* set if allocation is from freelist */
3fbbbea3	90	char userdata; /* mask defining userdata treatment */
d210a28c	91	xfs_fsblock_t firstblock; /* io first block allocated */
340785cc	92	struct xfs_owner_info oinfo; /* owner of blocks being allocated */
3fd129b6	93	enum xfs_ag_resv_type resv; /* block reservation to use */
1da177e4 LT	94	} xfs_alloc_arg_t;
	95
	96	/*
	97	* Defines for userdata
	98	*/
3fbbbea3 DC	99	#define XFS_ALLOC_USERDATA (1 << 0)/* allocation is for user data*/
	100	#define XFS_ALLOC_INITIAL_USER_DATA (1 << 1)/* special case start of file */
	101	#define XFS_ALLOC_USERDATA_ZERO (1 << 2)/* zero extent on allocation */
1da177e4	102
52548852 DW	103	/* freespace limit calculations */
	104	#define XFS_ALLOC_AGFL_RESERVE 4
	105	unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
	106	unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
	107
50adbcb4	108	xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_mount *mp,
3fd129b6 DW	109	struct xfs_perag *pag, xfs_extlen_t need,
3fd129b6 DW	110	xfs_extlen_t reserved);
496817b4	111	unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
6cc87645	112	struct xfs_perag *pag);
1da177e4	113
1da177e4 LT	114	/*
	115	* Compute and fill in value of m_ag_maxlevels.
	116	*/
	117	void
	118	xfs_alloc_compute_maxlevels(
	119	struct xfs_mount mp); / file system mount structure */
	120
	121	/*
	122	* Get a block from the freelist.
	123	* Returns with the buffer for the block gotten.
	124	*/
	125	int /* error */
	126	xfs_alloc_get_freelist(
	127	struct xfs_trans tp, / transaction pointer */
	128	struct xfs_buf agbp, / buffer containing the agf structure */
92821e2b DC	129	xfs_agblock_t bnop, / block address retrieved from freelist */
92821e2b DC	130	int btreeblk); /* destination is a AGF btree */
1da177e4 LT	131
	132	/*
	133	* Log the given fields from the agf structure.
	134	*/
	135	void
	136	xfs_alloc_log_agf(
	137	struct xfs_trans tp, / transaction pointer */
	138	struct xfs_buf bp, / buffer for a.g. freelist header */
	139	int fields);/* mask of fields to be logged (XFS_AGF_...) */
	140
	141	/*
	142	* Interface for inode allocation to force the pag data to be initialized.
	143	*/
	144	int /* error */
	145	xfs_alloc_pagf_init(
	146	struct xfs_mount mp, / file system mount structure */
	147	struct xfs_trans tp, / transaction pointer */
	148	xfs_agnumber_t agno, /* allocation group number */
	149	int flags); /* XFS_ALLOC_FLAGS_... */
	150
	151	/*
	152	* Put the block on the freelist for the allocation group.
	153	*/
	154	int /* error */
	155	xfs_alloc_put_freelist(
	156	struct xfs_trans tp, / transaction pointer */
	157	struct xfs_buf agbp, / buffer for a.g. freelist header */
	158	struct xfs_buf agflbp,/ buffer for a.g. free block array */
92821e2b DC	159	xfs_agblock_t bno, /* block being freed */
92821e2b DC	160	int btreeblk); /* owner was a AGF btree */
1da177e4 LT	161
	162	/*
	163	* Read in the allocation group header (free/alloc section).
	164	*/
	165	int /* error */
	166	xfs_alloc_read_agf(
	167	struct xfs_mount mp, / mount point structure */
	168	struct xfs_trans tp, / transaction pointer */
	169	xfs_agnumber_t agno, /* allocation group number */
	170	int flags, /* XFS_ALLOC_FLAG_... */
	171	struct xfs_buf *bpp); / buffer for the ag freelist header */
	172
	173	/*
	174	* Allocate an extent (variable-size).
	175	*/
	176	int /* error */
	177	xfs_alloc_vextent(
	178	xfs_alloc_arg_t args); / allocation argument structure */
	179
	180	/*
	181	* Free an extent.
	182	*/
	183	int /* error */
	184	xfs_free_extent(
340785cc DW	185	struct xfs_trans tp, / transaction pointer */
	186	xfs_fsblock_t bno, /* starting block number of extent */
	187	xfs_extlen_t len, /* length of extent */
3fd129b6 DW	188	struct xfs_owner_info oinfo, / extent owner */
3fd129b6 DW	189	enum xfs_ag_resv_type type); /* block reservation type */
1da177e4	190
a66d6363 DC	191	int /* error */
	192	xfs_alloc_lookup_ge(
	193	struct xfs_btree_cur cur, / btree cursor */
	194	xfs_agblock_t bno, /* starting block of extent */
	195	xfs_extlen_t len, /* length of extent */
	196	int stat); / success/failure */
	197
a46db608 CH	198	int /* error */
	199	xfs_alloc_get_rec(
	200	struct xfs_btree_cur cur, / btree cursor */
	201	xfs_agblock_t bno, / output: starting block of extent */
	202	xfs_extlen_t len, / output: length of extent */
	203	int stat); / output: success/failure */
	204
4fb6e8ad CH	205	int xfs_read_agf(struct xfs_mount mp, struct xfs_trans tp,
4fb6e8ad CH	206	xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
2e9101da	207	int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
4d89e20b DC	208	int xfs_free_extent_fix_freelist(struct xfs_trans *tp, xfs_agnumber_t agno,
4d89e20b DC	209	struct xfs_buf **agbp);
4fb6e8ad	210
8018026e DW	211	xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
8018026e DW	212
1da177e4	213	#endif /* __XFS_ALLOC_H__ */