[thirdparty/xfsprogs-dev.git] / include / 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_mount;
struct xfs_perag;
struct xfs_trans;

/*
 * Freespace allocation types.  Argument to xfs_alloc_[v]extent.
 */
typedef enum xfs_alloctype
{
	XFS_ALLOCTYPE_ANY_AG,		/* allocate anywhere, use rotor */
	XFS_ALLOCTYPE_FIRST_AG,		/* ... start at ag 0 */
	XFS_ALLOCTYPE_START_AG,		/* anywhere, start in this a.g. */
	XFS_ALLOCTYPE_THIS_AG,		/* anywhere in this a.g. */
	XFS_ALLOCTYPE_START_BNO,	/* near this block else anywhere */
	XFS_ALLOCTYPE_NEAR_BNO,		/* in this a.g. and near this block */
	XFS_ALLOCTYPE_THIS_BNO		/* at exactly this block */
} xfs_alloctype_t;

/*
 * Flags for xfs_alloc_fix_freelist.
 */
#define	XFS_ALLOC_FLAG_TRYLOCK	0x00000001  /* use trylock for buffer locking */

/*
 * 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 */
	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_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		isfl;		/* set if is freelist blocks - !actg */
	char		userdata;	/* set if this is user data */
} xfs_alloc_arg_t;

/*
 * Defines for userdata
 */
#define XFS_ALLOC_USERDATA		1	/* allocation is for user data*/
#define XFS_ALLOC_INITIAL_USER_DATA	2	/* special case start of file */


#ifdef __KERNEL__

#if defined(XFS_ALLOC_TRACE)
/*
 * Allocation tracing buffer size.
 */
#define	XFS_ALLOC_TRACE_SIZE	4096
extern ktrace_t *xfs_alloc_trace_buf;

/*
 * Types for alloc tracing.
 */
#define	XFS_ALLOC_KTRACE_ALLOC	1
#define	XFS_ALLOC_KTRACE_FREE	2
#define	XFS_ALLOC_KTRACE_MODAGF	3
#define	XFS_ALLOC_KTRACE_BUSY	4
#define	XFS_ALLOC_KTRACE_UNBUSY	5
#define	XFS_ALLOC_KTRACE_BUSYSEARCH	6
#endif

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

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

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

void
xfs_alloc_mark_busy(xfs_trans_t *tp,
		xfs_agnumber_t agno,
		xfs_agblock_t bno,
		xfs_extlen_t len);

void
xfs_alloc_clear_busy(xfs_trans_t *tp,
		xfs_agnumber_t ag,
		int idx);


#endif	/* __KERNEL__ */

#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
	21	struct xfs_buf;
	22	struct xfs_mount;
	23	struct xfs_perag;
	24	struct xfs_trans;
	25
	26	/*
dfc130f3	27	* Freespace allocation types. Argument to xfs_alloc_[v]extent.
2bd0ea18 NS	28	*/
	29	typedef enum xfs_alloctype
	30	{
	31	XFS_ALLOCTYPE_ANY_AG, /* allocate anywhere, use rotor */
	32	XFS_ALLOCTYPE_FIRST_AG, /* ... start at ag 0 */
	33	XFS_ALLOCTYPE_START_AG, /* anywhere, start in this a.g. */
	34	XFS_ALLOCTYPE_THIS_AG, /* anywhere in this a.g. */
	35	XFS_ALLOCTYPE_START_BNO, /* near this block else anywhere */
	36	XFS_ALLOCTYPE_NEAR_BNO, /* in this a.g. and near this block */
	37	XFS_ALLOCTYPE_THIS_BNO /* at exactly this block */
	38	} xfs_alloctype_t;
	39
	40	/*
	41	* Flags for xfs_alloc_fix_freelist.
	42	*/
dfc130f3	43	#define XFS_ALLOC_FLAG_TRYLOCK 0x00000001 /* use trylock for buffer locking */
2bd0ea18 NS	44
	45	/*
	46	* Argument structure for xfs_alloc routines.
	47	* This is turned into a structure to avoid having 20 arguments passed
	48	* down several levels of the stack.
	49	*/
	50	typedef struct xfs_alloc_arg {
	51	struct xfs_trans tp; / transaction pointer */
	52	struct xfs_mount mp; / file system mount point */
	53	struct xfs_buf agbp; / buffer for a.g. freelist header */
	54	struct xfs_perag pag; / per-ag struct for this agno */
	55	xfs_fsblock_t fsbno; /* file system block number */
	56	xfs_agnumber_t agno; /* allocation group number */
	57	xfs_agblock_t agbno; /* allocation group-relative block # */
	58	xfs_extlen_t minlen; /* minimum size of extent */
	59	xfs_extlen_t maxlen; /* maximum size of extent */
	60	xfs_extlen_t mod; /* mod value for extent size */
	61	xfs_extlen_t prod; /* prod value for extent size */
	62	xfs_extlen_t minleft; /* min blocks must be left after us */
	63	xfs_extlen_t total; /* total blocks needed in xaction */
	64	xfs_extlen_t alignment; /* align answer to multiple of this */
	65	xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
	66	xfs_extlen_t len; /* output: actual size of extent */
dfc130f3 RC	67	xfs_alloctype_t type; /* allocation type XFS_ALLOCTYPE_... */
dfc130f3 RC	68	xfs_alloctype_t otype; /* original allocation type */
2bd0ea18 NS	69	char wasdel; /* set if allocation was prev delayed */
	70	char wasfromfl; /* set if allocation is from freelist */
	71	char isfl; /* set if is freelist blocks - !actg */
	72	char userdata; /* set if this is user data */
	73	} xfs_alloc_arg_t;
	74
34317449 NS	75	/*
	76	* Defines for userdata
	77	*/
	78	#define XFS_ALLOC_USERDATA 1 /* allocation is for user data*/
	79	#define XFS_ALLOC_INITIAL_USER_DATA 2 /* special case start of file */
	80
2bd0ea18 NS	81
	82	#ifdef __KERNEL__
	83
23aab3f9 NS	84	#if defined(XFS_ALLOC_TRACE)
	85	/*
	86	* Allocation tracing buffer size.
	87	*/
	88	#define XFS_ALLOC_TRACE_SIZE 4096
	89	extern ktrace_t *xfs_alloc_trace_buf;
	90
2bd0ea18 NS	91	/*
	92	* Types for alloc tracing.
	93	*/
dfc130f3 RC	94	#define XFS_ALLOC_KTRACE_ALLOC 1
	95	#define XFS_ALLOC_KTRACE_FREE 2
	96	#define XFS_ALLOC_KTRACE_MODAGF 3
	97	#define XFS_ALLOC_KTRACE_BUSY 4
	98	#define XFS_ALLOC_KTRACE_UNBUSY 5
	99	#define XFS_ALLOC_KTRACE_BUSYSEARCH 6
2bd0ea18 NS	100	#endif
2bd0ea18 NS	101
2bd0ea18 NS	102	/*
	103	* Compute and fill in value of m_ag_maxlevels.
	104	*/
	105	void
	106	xfs_alloc_compute_maxlevels(
	107	struct xfs_mount mp); / file system mount structure */
	108
2bd0ea18 NS	109	/*
	110	* Get a block from the freelist.
	111	* Returns with the buffer for the block gotten.
	112	*/
	113	int /* error */
	114	xfs_alloc_get_freelist(
	115	struct xfs_trans tp, / transaction pointer */
	116	struct xfs_buf agbp, / buffer containing the agf structure */
f302e9e4	117	xfs_agblock_t bnop); / block address retrieved from freelist */
2bd0ea18 NS	118
	119	/*
	120	* Log the given fields from the agf structure.
	121	*/
	122	void
	123	xfs_alloc_log_agf(
	124	struct xfs_trans tp, / transaction pointer */
	125	struct xfs_buf bp, / buffer for a.g. freelist header */
	126	int fields);/* mask of fields to be logged (XFS_AGF_...) */
	127
	128	/*
	129	* Interface for inode allocation to force the pag data to be initialized.
	130	*/
	131	int /* error */
	132	xfs_alloc_pagf_init(
	133	struct xfs_mount mp, / file system mount structure */
	134	struct xfs_trans tp, / transaction pointer */
	135	xfs_agnumber_t agno, /* allocation group number */
dfc130f3	136	int flags); /* XFS_ALLOC_FLAGS_... */
2bd0ea18 NS	137
	138	/*
	139	* Put the block on the freelist for the allocation group.
	140	*/
	141	int /* error */
	142	xfs_alloc_put_freelist(
	143	struct xfs_trans tp, / transaction pointer */
	144	struct xfs_buf agbp, / buffer for a.g. freelist header */
	145	struct xfs_buf agflbp,/ buffer for a.g. free block array */
f302e9e4	146	xfs_agblock_t bno); /* block being freed */
2bd0ea18 NS	147
	148	/*
	149	* Read in the allocation group header (free/alloc section).
	150	*/
	151	int /* error */
	152	xfs_alloc_read_agf(
	153	struct xfs_mount mp, / mount point structure */
	154	struct xfs_trans tp, / transaction pointer */
	155	xfs_agnumber_t agno, /* allocation group number */
	156	int flags, /* XFS_ALLOC_FLAG_... */
	157	struct xfs_buf *bpp); / buffer for the ag freelist header */
	158
	159	/*
	160	* Allocate an extent (variable-size).
	161	*/
	162	int /* error */
	163	xfs_alloc_vextent(
dfc130f3	164	xfs_alloc_arg_t args); / allocation argument structure */
2bd0ea18 NS	165
	166	/*
	167	* Free an extent.
	168	*/
	169	int /* error */
	170	xfs_free_extent(
	171	struct xfs_trans tp, / transaction pointer */
	172	xfs_fsblock_t bno, /* starting block number of extent */
	173	xfs_extlen_t len); /* length of extent */
	174
3e535bba NS	175	void
	176	xfs_alloc_mark_busy(xfs_trans_t *tp,
	177	xfs_agnumber_t agno,
	178	xfs_agblock_t bno,
	179	xfs_extlen_t len);
	180
	181	void
	182	xfs_alloc_clear_busy(xfs_trans_t *tp,
	183	xfs_agnumber_t ag,
	184	int idx);
	185
	186
2bd0ea18 NS	187	#endif /* __KERNEL__ */
	188
	189	#endif /* __XFS_ALLOC_H__ */