[mirror_ubuntu-zesty-kernel.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_STACK_SWITCH	0x080

#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" }, \
	{ XFS_BMAPI_STACK_SWITCH, "STACK_SWITCH" }


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);
}

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


/*
 * This macro is used to determine how many extents will be shifted
 * in one write transaction. We could require two splits,
 * an extent move on the first and an extent merge on the second,
 * So it is proper that one extent is shifted inside write transaction
 * at a time.
 */
#define XFS_BMAP_MAX_SHIFT_EXTENTS	1

#ifdef 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_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
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);
int	xfs_bmap_shift_extents(struct xfs_trans *tp, struct xfs_inode *ip,
		int *done, xfs_fileoff_t start_fsb,
		xfs_fileoff_t offset_shift_fsb, xfs_extnum_t *current_ext,
		xfs_fsblock_t *firstblock, struct xfs_bmap_free	*flist,
		int num_exts);

#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
326c0355	80	#define XFS_BMAPI_STACK_SWITCH 0x080
1da177e4	81
0b1b213f	82	#define XFS_BMAPI_FLAGS \
0b1b213f CH	83	{ XFS_BMAPI_ENTIRE, "ENTIRE" }, \
0b1b213f CH	84	{ XFS_BMAPI_METADATA, "METADATA" }, \
0b1b213f	85	{ XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
0b1b213f CH	86	{ XFS_BMAPI_PREALLOC, "PREALLOC" }, \
	87	{ XFS_BMAPI_IGSTATE, "IGSTATE" }, \
	88	{ XFS_BMAPI_CONTIG, "CONTIG" }, \
326c0355 DC	89	{ XFS_BMAPI_CONVERT, "CONVERT" }, \
326c0355 DC	90	{ XFS_BMAPI_STACK_SWITCH, "STACK_SWITCH" }
0b1b213f CH	91
0b1b213f CH	92
a844f451 NS	93	static inline int xfs_bmapi_aflag(int w)
	94	{
	95	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
	96	}
1da177e4 LT	97
	98	/*
	99	* Special values for xfs_bmbt_irec_t br_startblock field.
	100	*/
	101	#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
	102	#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
	103
a844f451 NS	104	static inline void xfs_bmap_init(xfs_bmap_free_t flp, xfs_fsblock_t fbp)
a844f451 NS	105	{
1da177e4	106	((flp)->xbf_first = NULL, (flp)->xbf_count = 0, \
a844f451 NS	107	(flp)->xbf_low = 0, *(fbp) = NULLFSBLOCK);
a844f451 NS	108	}
1da177e4	109
7574aa92 CH	110	/*
	111	* Flags for xfs_bmap_add_extent*.
	112	*/
	113	#define BMAP_LEFT_CONTIG (1 << 0)
	114	#define BMAP_RIGHT_CONTIG (1 << 1)
	115	#define BMAP_LEFT_FILLING (1 << 2)
	116	#define BMAP_RIGHT_FILLING (1 << 3)
	117	#define BMAP_LEFT_DELAY (1 << 4)
	118	#define BMAP_RIGHT_DELAY (1 << 5)
	119	#define BMAP_LEFT_VALID (1 << 6)
	120	#define BMAP_RIGHT_VALID (1 << 7)
6ef35544	121	#define BMAP_ATTRFORK (1 << 8)
7574aa92	122
0b1b213f CH	123	#define XFS_BMAP_EXT_FLAGS \
	124	{ BMAP_LEFT_CONTIG, "LC" }, \
	125	{ BMAP_RIGHT_CONTIG, "RC" }, \
	126	{ BMAP_LEFT_FILLING, "LF" }, \
	127	{ BMAP_RIGHT_FILLING, "RF" }, \
	128	{ BMAP_ATTRFORK, "ATTR" }
1da177e4	129
e1d8fb88 NJ	130
	131	/*
	132	* This macro is used to determine how many extents will be shifted
	133	* in one write transaction. We could require two splits,
	134	* an extent move on the first and an extent merge on the second,
	135	* So it is proper that one extent is shifted inside write transaction
	136	* at a time.
	137	*/
	138	#define XFS_BMAP_MAX_SHIFT_EXTENTS 1
	139
b49a0c18	140	#ifdef DEBUG
d952e2f8 CH	141	void xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
d952e2f8 CH	142	int whichfork, unsigned long caller_ip);
3a59c94c	143	#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
0b1b213f CH	144	xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
0b1b213f CH	145	#else
3a59c94c	146	#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
0b1b213f	147	#endif
1da177e4	148
d952e2f8	149	int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
f3508bcd	150	void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
d952e2f8 CH	151	void xfs_bmap_add_free(xfs_fsblock_t bno, xfs_filblks_t len,
	152	struct xfs_bmap_free flist, struct xfs_mount mp);
	153	void xfs_bmap_cancel(struct xfs_bmap_free *flist);
	154	void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
	155	int xfs_bmap_first_unused(struct xfs_trans tp, struct xfs_inode ip,
	156	xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
	157	int xfs_bmap_last_before(struct xfs_trans tp, struct xfs_inode ip,
	158	xfs_fileoff_t *last_block, int whichfork);
	159	int xfs_bmap_last_offset(struct xfs_trans tp, struct xfs_inode ip,
	160	xfs_fileoff_t *unused, int whichfork);
	161	int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
	162	int xfs_bmap_read_extents(struct xfs_trans tp, struct xfs_inode ip,
	163	int whichfork);
5c8ed202 DC	164	int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
	165	xfs_filblks_t len, struct xfs_bmbt_irec *mval,
	166	int *nmap, int flags);
4403280a CH	167	int xfs_bmapi_delay(struct xfs_inode *ip, xfs_fileoff_t bno,
	168	xfs_filblks_t len, struct xfs_bmbt_irec *mval,
	169	int *nmap, int flags);
c0dc7828 DC	170	int xfs_bmapi_write(struct xfs_trans tp, struct xfs_inode ip,
	171	xfs_fileoff_t bno, xfs_filblks_t len, int flags,
	172	xfs_fsblock_t *firstblock, xfs_extlen_t total,
	173	struct xfs_bmbt_irec mval, int nmap,
	174	struct xfs_bmap_free *flist);
d952e2f8 CH	175	int xfs_bunmapi(struct xfs_trans tp, struct xfs_inode ip,
	176	xfs_fileoff_t bno, xfs_filblks_t len, int flags,
	177	xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
	178	struct xfs_bmap_free flist, int done);
	179	int xfs_check_nostate_extents(struct xfs_ifork *ifp, xfs_extnum_t idx,
	180	xfs_extnum_t num);
	181	uint xfs_default_attroffset(struct xfs_inode *ip);
e1d8fb88 NJ	182	int xfs_bmap_shift_extents(struct xfs_trans tp, struct xfs_inode ip,
	183	int *done, xfs_fileoff_t start_fsb,
	184	xfs_fileoff_t offset_shift_fsb, xfs_extnum_t *current_ext,
	185	xfs_fsblock_t firstblock, struct xfs_bmap_free flist,
	186	int num_exts);
1a5902c5	187
1da177e4	188	#endif /* __XFS_BMAP_H__ */