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

/*
 * Copyright (c) 2000-2006 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_BMAP_H__
#define	__XFS_BMAP_H__

struct getbmap;
struct xfs_bmbt_irec;
struct xfs_ifork;
struct xfs_inode;
struct xfs_mount;
struct xfs_trans;

extern kmem_zone_t	*xfs_bmap_free_item_zone;

/*
 * List of extents to be free "later".
 * The list is kept sorted on xbf_startblock.
 */
typedef struct xfs_bmap_free_item
{
	xfs_fsblock_t		xbfi_startblock;/* starting fs block number */
	xfs_extlen_t		xbfi_blockcount;/* number of blocks in extent */
	struct xfs_bmap_free_item *xbfi_next;	/* link to next entry */
} xfs_bmap_free_item_t;

/*
 * Header for free extent list.
 *
 * xbf_low is used by the allocator to activate the lowspace algorithm -
 * when free space is running low the extent allocator may choose to
 * allocate an extent from an AG without leaving sufficient space for
 * a btree split when inserting the new extent.  In this case the allocator
 * will enable the lowspace algorithm which is supposed to allow further
 * allocations (such as btree splits and newroots) to allocate from
 * sequential AGs.  In order to avoid locking AGs out of order the lowspace
 * algorithm will start searching for free space from AG 0.  If the correct
 * transaction reservations have been made then this algorithm will eventually
 * find all the space it needs.
 */
typedef	struct xfs_bmap_free
{
	xfs_bmap_free_item_t	*xbf_first;	/* list of to-be-free extents */
	int			xbf_count;	/* count of items on list */
	int			xbf_low;	/* alloc in low mode */
} xfs_bmap_free_t;

#define	XFS_BMAP_MAX_NMAP	4

/*
 * Flags for xfs_bmapi_*
 */
#define XFS_BMAPI_ENTIRE	0x001	/* return entire extent, not trimmed */
#define XFS_BMAPI_METADATA	0x002	/* mapping metadata not user data */
#define XFS_BMAPI_ATTRFORK	0x004	/* use attribute fork not data */
#define XFS_BMAPI_PREALLOC	0x008	/* preallocation op: unwritten space */
#define XFS_BMAPI_IGSTATE	0x010	/* Ignore state - */
					/* combine contig. space */
#define XFS_BMAPI_CONTIG	0x020	/* must allocate only one extent */
/*
 * unwritten extent conversion - this needs write cache flushing and no additional
 * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
 * from written to unwritten, otherwise convert from unwritten to written.
 */
#define XFS_BMAPI_CONVERT	0x040

#define XFS_BMAPI_FLAGS \
	{ XFS_BMAPI_ENTIRE,	"ENTIRE" }, \
	{ XFS_BMAPI_METADATA,	"METADATA" }, \
	{ XFS_BMAPI_ATTRFORK,	"ATTRFORK" }, \
	{ XFS_BMAPI_PREALLOC,	"PREALLOC" }, \
	{ XFS_BMAPI_IGSTATE,	"IGSTATE" }, \
	{ XFS_BMAPI_CONTIG,	"CONTIG" }, \
	{ XFS_BMAPI_CONVERT,	"CONVERT" }


static inline int xfs_bmapi_aflag(int w)
{
	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
}

/*
 * Special values for xfs_bmbt_irec_t br_startblock field.
 */
#define	DELAYSTARTBLOCK		((xfs_fsblock_t)-1LL)
#define	HOLESTARTBLOCK		((xfs_fsblock_t)-2LL)

static inline void xfs_bmap_init(xfs_bmap_free_t *flp, xfs_fsblock_t *fbp)
{
	((flp)->xbf_first = NULL, (flp)->xbf_count = 0, \
		(flp)->xbf_low = 0, *(fbp) = NULLFSBLOCK);
}

/*
 * Argument structure for xfs_bmap_alloc.
 */
typedef struct xfs_bmalloca {
	xfs_fsblock_t		*firstblock; /* i/o first block allocated */
	struct xfs_bmap_free	*flist;	/* bmap freelist */
	struct xfs_trans	*tp;	/* transaction pointer */
	struct xfs_inode	*ip;	/* incore inode pointer */
	struct xfs_bmbt_irec	prev;	/* extent before the new one */
	struct xfs_bmbt_irec	got;	/* extent after, or delayed */

	xfs_fileoff_t		offset;	/* offset in file filling in */
	xfs_extlen_t		length;	/* i/o length asked/allocated */
	xfs_fsblock_t		blkno;	/* starting block of new extent */

	struct xfs_btree_cur	*cur;	/* btree cursor */
	xfs_extnum_t		idx;	/* current extent index */
	int			nallocs;/* number of extents alloc'd */
	int			logflags;/* flags for transaction logging */

	xfs_extlen_t		total;	/* total blocks needed for xaction */
	xfs_extlen_t		minlen;	/* minimum allocation size (blocks) */
	xfs_extlen_t		minleft; /* amount must be left after alloc */
	char			eof;	/* set if allocating past last extent */
	char			wasdel;	/* replacing a delayed allocation */
	char			userdata;/* set if is user data */
	char			aeof;	/* allocated space at eof */
	char			conv;	/* overwriting unwritten extents */
} xfs_bmalloca_t;

/*
 * Flags for xfs_bmap_add_extent*.
 */
#define BMAP_LEFT_CONTIG	(1 << 0)
#define BMAP_RIGHT_CONTIG	(1 << 1)
#define BMAP_LEFT_FILLING	(1 << 2)
#define BMAP_RIGHT_FILLING	(1 << 3)
#define BMAP_LEFT_DELAY		(1 << 4)
#define BMAP_RIGHT_DELAY	(1 << 5)
#define BMAP_LEFT_VALID		(1 << 6)
#define BMAP_RIGHT_VALID	(1 << 7)
#define BMAP_ATTRFORK		(1 << 8)

#define XFS_BMAP_EXT_FLAGS \
	{ BMAP_LEFT_CONTIG,	"LC" }, \
	{ BMAP_RIGHT_CONTIG,	"RC" }, \
	{ BMAP_LEFT_FILLING,	"LF" }, \
	{ BMAP_RIGHT_FILLING,	"RF" }, \
	{ BMAP_ATTRFORK,	"ATTR" }

#if defined(__KERNEL) && defined(DEBUG)
void	xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
		int whichfork, unsigned long caller_ip);
#define	XFS_BMAP_TRACE_EXLIST(ip,c,w)	\
	xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
#else
#define	XFS_BMAP_TRACE_EXLIST(ip,c,w)
#endif

int	xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
void	xfs_bmap_add_free(xfs_fsblock_t bno, xfs_filblks_t len,
		struct xfs_bmap_free *flist, struct xfs_mount *mp);
void	xfs_bmap_cancel(struct xfs_bmap_free *flist);
void	xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
int	xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
		xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
int	xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
		xfs_fileoff_t *last_block, int whichfork);
int	xfs_bmap_last_offset(struct xfs_trans *tp, struct xfs_inode *ip,
		xfs_fileoff_t *unused, int whichfork);
int	xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
int	xfs_bmap_read_extents(struct xfs_trans *tp, struct xfs_inode *ip,
		int whichfork);
int	xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
		xfs_filblks_t len, struct xfs_bmbt_irec *mval,
		int *nmap, int flags);
int	xfs_bmapi_delay(struct xfs_inode *ip, xfs_fileoff_t bno,
		xfs_filblks_t len, struct xfs_bmbt_irec *mval,
		int *nmap, int flags);
int	xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
		xfs_fileoff_t bno, xfs_filblks_t len, int flags,
		xfs_fsblock_t *firstblock, xfs_extlen_t total,
		struct xfs_bmbt_irec *mval, int *nmap,
		struct xfs_bmap_free *flist);
int	xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
		xfs_fileoff_t bno, xfs_filblks_t len, int flags,
		xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
		struct xfs_bmap_free *flist, int *done);
int	xfs_check_nostate_extents(struct xfs_ifork *ifp, xfs_extnum_t idx,
		xfs_extnum_t num);
uint	xfs_default_attroffset(struct xfs_inode *ip);

#ifdef __KERNEL__
/* bmap to userspace formatter - copy to user & advance pointer */
typedef int (*xfs_bmap_format_t)(void **, struct getbmapx *, int *);

int	xfs_bmap_finish(struct xfs_trans **tp, struct xfs_bmap_free *flist,
		int *committed);
int	xfs_getbmap(struct xfs_inode *ip, struct getbmapx *bmv,
		xfs_bmap_format_t formatter, void *arg);
int	xfs_bmap_eof(struct xfs_inode *ip, xfs_fileoff_t endoff,
		int whichfork, int *eof);
int	xfs_bmap_count_blocks(struct xfs_trans *tp, struct xfs_inode *ip,
		int whichfork, int *count);
int	xfs_bmap_punch_delalloc_range(struct xfs_inode *ip,
		xfs_fileoff_t start_fsb, xfs_fileoff_t length);

xfs_daddr_t xfs_fsb_to_db(struct xfs_inode *ip, xfs_fsblock_t fsb);

#endif	/* __KERNEL__ */

#endif	/* __XFS_BMAP_H__ */
Commit	Line	Data
1da177e4	1	/*
3e57ecf6	2	* Copyright (c) 2000-2006 Silicon Graphics, Inc.
7b718769	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_BMAP_H__
	19	#define __XFS_BMAP_H__
	20
	21	struct getbmap;
	22	struct xfs_bmbt_irec;
4eea22f0	23	struct xfs_ifork;
1da177e4 LT	24	struct xfs_inode;
	25	struct xfs_mount;
	26	struct xfs_trans;
	27
a8272ce0 DC	28	extern kmem_zone_t *xfs_bmap_free_item_zone;
a8272ce0 DC	29
1da177e4 LT	30	/*
	31	* List of extents to be free "later".
	32	* The list is kept sorted on xbf_startblock.
	33	*/
	34	typedef struct xfs_bmap_free_item
	35	{
	36	xfs_fsblock_t xbfi_startblock;/* starting fs block number */
	37	xfs_extlen_t xbfi_blockcount;/* number of blocks in extent */
	38	struct xfs_bmap_free_item xbfi_next; / link to next entry */
	39	} xfs_bmap_free_item_t;
	40
	41	/*
	42	* Header for free extent list.
b877e3d3 LM	43	*
	44	* xbf_low is used by the allocator to activate the lowspace algorithm -
	45	* when free space is running low the extent allocator may choose to
	46	* allocate an extent from an AG without leaving sufficient space for
	47	* a btree split when inserting the new extent. In this case the allocator
	48	* will enable the lowspace algorithm which is supposed to allow further
	49	* allocations (such as btree splits and newroots) to allocate from
	50	* sequential AGs. In order to avoid locking AGs out of order the lowspace
	51	* algorithm will start searching for free space from AG 0. If the correct
	52	* transaction reservations have been made then this algorithm will eventually
	53	* find all the space it needs.
1da177e4 LT	54	*/
	55	typedef struct xfs_bmap_free
	56	{
	57	xfs_bmap_free_item_t xbf_first; / list of to-be-free extents */
	58	int xbf_count; /* count of items on list */
b877e3d3	59	int xbf_low; /* alloc in low mode */
1da177e4 LT	60	} xfs_bmap_free_t;
	61
	62	#define XFS_BMAP_MAX_NMAP 4
	63
	64	/*
c0dc7828	65	* Flags for xfs_bmapi_*
1da177e4	66	*/
c0dc7828 DC	67	#define XFS_BMAPI_ENTIRE 0x001 /* return entire extent, not trimmed */
	68	#define XFS_BMAPI_METADATA 0x002 /* mapping metadata not user data */
	69	#define XFS_BMAPI_ATTRFORK 0x004 /* use attribute fork not data */
	70	#define XFS_BMAPI_PREALLOC 0x008 /* preallocation op: unwritten space */
	71	#define XFS_BMAPI_IGSTATE 0x010 /* Ignore state - */
1da177e4	72	/* combine contig. space */
c0dc7828	73	#define XFS_BMAPI_CONTIG 0x020 /* must allocate only one extent */
44722352 DC	74	/*
	75	* unwritten extent conversion - this needs write cache flushing and no additional
	76	* allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
	77	* from written to unwritten, otherwise convert from unwritten to written.
	78	*/
c0dc7828	79	#define XFS_BMAPI_CONVERT 0x040
1da177e4	80
0b1b213f	81	#define XFS_BMAPI_FLAGS \
0b1b213f CH	82	{ XFS_BMAPI_ENTIRE, "ENTIRE" }, \
0b1b213f CH	83	{ XFS_BMAPI_METADATA, "METADATA" }, \
0b1b213f	84	{ XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
0b1b213f CH	85	{ XFS_BMAPI_PREALLOC, "PREALLOC" }, \
	86	{ XFS_BMAPI_IGSTATE, "IGSTATE" }, \
	87	{ XFS_BMAPI_CONTIG, "CONTIG" }, \
	88	{ XFS_BMAPI_CONVERT, "CONVERT" }
	89
	90
a844f451 NS	91	static inline int xfs_bmapi_aflag(int w)
	92	{
	93	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
	94	}
1da177e4 LT	95
	96	/*
	97	* Special values for xfs_bmbt_irec_t br_startblock field.
	98	*/
	99	#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
	100	#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
	101
a844f451 NS	102	static inline void xfs_bmap_init(xfs_bmap_free_t flp, xfs_fsblock_t fbp)
a844f451 NS	103	{
1da177e4	104	((flp)->xbf_first = NULL, (flp)->xbf_count = 0, \
a844f451 NS	105	(flp)->xbf_low = 0, *(fbp) = NULLFSBLOCK);
a844f451 NS	106	}
1da177e4 LT	107
	108	/*
	109	* Argument structure for xfs_bmap_alloc.
	110	*/
	111	typedef struct xfs_bmalloca {
0937e0fd DC	112	xfs_fsblock_t firstblock; / i/o first block allocated */
0937e0fd DC	113	struct xfs_bmap_free flist; / bmap freelist */
1da177e4 LT	114	struct xfs_trans tp; / transaction pointer */
1da177e4 LT	115	struct xfs_inode ip; / incore inode pointer */
baf41a52 DC	116	struct xfs_bmbt_irec prev; /* extent before the new one */
baf41a52 DC	117	struct xfs_bmbt_irec got; /* extent after, or delayed */
3a75667e DC	118
	119	xfs_fileoff_t offset; /* offset in file filling in */
	120	xfs_extlen_t length; /* i/o length asked/allocated */
	121	xfs_fsblock_t blkno; /* starting block of new extent */
	122
29c8d17a	123	struct xfs_btree_cur cur; / btree cursor */
e0c3da5d DC	124	xfs_extnum_t idx; /* current extent index */
e0c3da5d DC	125	int nallocs;/* number of extents alloc'd */
c315c90b	126	int logflags;/* flags for transaction logging */
29c8d17a	127
1da177e4	128	xfs_extlen_t total; /* total blocks needed for xaction */
9da096fd	129	xfs_extlen_t minlen; /* minimum allocation size (blocks) */
1da177e4 LT	130	xfs_extlen_t minleft; /* amount must be left after alloc */
	131	char eof; /* set if allocating past last extent */
	132	char wasdel; /* replacing a delayed allocation */
	133	char userdata;/* set if is user data */
dd9f438e NS	134	char aeof; /* allocated space at eof */
dd9f438e NS	135	char conv; /* overwriting unwritten extents */
1da177e4 LT	136	} xfs_bmalloca_t;
1da177e4 LT	137
7574aa92 CH	138	/*
	139	* Flags for xfs_bmap_add_extent*.
	140	*/
	141	#define BMAP_LEFT_CONTIG (1 << 0)
	142	#define BMAP_RIGHT_CONTIG (1 << 1)
	143	#define BMAP_LEFT_FILLING (1 << 2)
	144	#define BMAP_RIGHT_FILLING (1 << 3)
	145	#define BMAP_LEFT_DELAY (1 << 4)
	146	#define BMAP_RIGHT_DELAY (1 << 5)
	147	#define BMAP_LEFT_VALID (1 << 6)
	148	#define BMAP_RIGHT_VALID (1 << 7)
6ef35544	149	#define BMAP_ATTRFORK (1 << 8)
7574aa92	150
0b1b213f CH	151	#define XFS_BMAP_EXT_FLAGS \
	152	{ BMAP_LEFT_CONTIG, "LC" }, \
	153	{ BMAP_RIGHT_CONTIG, "RC" }, \
	154	{ BMAP_LEFT_FILLING, "LF" }, \
	155	{ BMAP_RIGHT_FILLING, "RF" }, \
	156	{ BMAP_ATTRFORK, "ATTR" }
1da177e4	157
0b1b213f	158	#if defined(__KERNEL) && defined(DEBUG)
d952e2f8 CH	159	void xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
d952e2f8 CH	160	int whichfork, unsigned long caller_ip);
3a59c94c	161	#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
0b1b213f CH	162	xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
0b1b213f CH	163	#else
3a59c94c	164	#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
0b1b213f	165	#endif
1da177e4	166
d952e2f8 CH	167	int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
	168	void xfs_bmap_add_free(xfs_fsblock_t bno, xfs_filblks_t len,
	169	struct xfs_bmap_free flist, struct xfs_mount mp);
	170	void xfs_bmap_cancel(struct xfs_bmap_free *flist);
	171	void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
	172	int xfs_bmap_first_unused(struct xfs_trans tp, struct xfs_inode ip,
	173	xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
	174	int xfs_bmap_last_before(struct xfs_trans tp, struct xfs_inode ip,
	175	xfs_fileoff_t *last_block, int whichfork);
	176	int xfs_bmap_last_offset(struct xfs_trans tp, struct xfs_inode ip,
	177	xfs_fileoff_t *unused, int whichfork);
	178	int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
	179	int xfs_bmap_read_extents(struct xfs_trans tp, struct xfs_inode ip,
	180	int whichfork);
5c8ed202 DC	181	int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
	182	xfs_filblks_t len, struct xfs_bmbt_irec *mval,
	183	int *nmap, int flags);
4403280a CH	184	int xfs_bmapi_delay(struct xfs_inode *ip, xfs_fileoff_t bno,
	185	xfs_filblks_t len, struct xfs_bmbt_irec *mval,
	186	int *nmap, int flags);
c0dc7828 DC	187	int xfs_bmapi_write(struct xfs_trans tp, struct xfs_inode ip,
	188	xfs_fileoff_t bno, xfs_filblks_t len, int flags,
	189	xfs_fsblock_t *firstblock, xfs_extlen_t total,
	190	struct xfs_bmbt_irec mval, int nmap,
	191	struct xfs_bmap_free *flist);
d952e2f8 CH	192	int xfs_bunmapi(struct xfs_trans tp, struct xfs_inode ip,
	193	xfs_fileoff_t bno, xfs_filblks_t len, int flags,
	194	xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
	195	struct xfs_bmap_free flist, int done);
	196	int xfs_check_nostate_extents(struct xfs_ifork *ifp, xfs_extnum_t idx,
	197	xfs_extnum_t num);
	198	uint xfs_default_attroffset(struct xfs_inode *ip);
1a5902c5	199
847fff5c	200	#ifdef __KERNEL__
8a7141a8 ES	201	/* bmap to userspace formatter - copy to user & advance pointer */
	202	typedef int (xfs_bmap_format_t)(void , struct getbmapx , int *);
	203
d952e2f8 CH	204	int xfs_bmap_finish(struct xfs_trans *tp, struct xfs_bmap_free flist,
	205	int *committed);
	206	int xfs_getbmap(struct xfs_inode ip, struct getbmapx bmv,
	207	xfs_bmap_format_t formatter, void *arg);
	208	int xfs_bmap_eof(struct xfs_inode *ip, xfs_fileoff_t endoff,
	209	int whichfork, int *eof);
	210	int xfs_bmap_count_blocks(struct xfs_trans tp, struct xfs_inode ip,
	211	int whichfork, int *count);
	212	int xfs_bmap_punch_delalloc_range(struct xfs_inode *ip,
	213	xfs_fileoff_t start_fsb, xfs_fileoff_t length);
fd50092c DC	214
	215	xfs_daddr_t xfs_fsb_to_db(struct xfs_inode *ip, xfs_fsblock_t fsb);
	216
1da177e4 LT	217	#endif /* __KERNEL__ */
	218
	219	#endif /* __XFS_BMAP_H__ */