[thirdparty/xfsprogs-dev.git] / libxfs / 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;

/*
 * Argument structure for xfs_bmap_alloc.
 */
struct xfs_bmalloca {
	xfs_fsblock_t		*firstblock; /* i/o first block allocated */
	struct xfs_defer_ops	*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 */
	bool			eof;	/* set if allocating past last extent */
	bool			wasdel;	/* replacing a delayed allocation */
	bool			aeof;	/* allocated space at eof */
	bool			conv;	/* overwriting unwritten extents */
	char			userdata;/* userdata mask */
	int			flags;
};

/*
 * List of extents to be free "later".
 * The list is kept sorted on xbf_startblock.
 */
struct xfs_extent_free_item
{
	xfs_fsblock_t		xefi_startblock;/* starting fs block number */
	xfs_extlen_t		xefi_blockcount;/* number of blocks in extent */
	struct list_head	xefi_list;
};

#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

/*
 * allocate zeroed extents - this requires all newly allocated user data extents
 * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
 * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
 * during the allocation range to zeroed written extents.
 */
#define XFS_BMAPI_ZERO		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_ZERO,	"ZERO" }


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)

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

enum shift_direction {
	SHIFT_LEFT = 0,
	SHIFT_RIGHT,
};

#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(struct xfs_mount *mp, struct xfs_defer_ops *flist,
			  xfs_fsblock_t bno, xfs_filblks_t len);
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_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_defer_ops *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_defer_ops *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,
		xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
		int *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
		struct xfs_defer_ops *flist, enum shift_direction direction,
		int num_exts);
int	xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);

struct xfs_bmbt_rec_host *
	xfs_bmap_search_extents(struct xfs_inode *ip, xfs_fileoff_t bno,
				int fork, int *eofp, xfs_extnum_t *lastxp,
				struct xfs_bmbt_irec *gotp,
				struct xfs_bmbt_irec *prevp);


#endif	/* __XFS_BMAP_H__ */
Commit	Line	Data
2bd0ea18	1	/*
5e656dbb	2	* Copyright (c) 2000-2006 Silicon Graphics, Inc.
f302e9e4	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_BMAP_H__
dfc130f3	19	#define __XFS_BMAP_H__
2bd0ea18 NS	20
	21	struct getbmap;
	22	struct xfs_bmbt_irec;
5e656dbb	23	struct xfs_ifork;
2bd0ea18 NS	24	struct xfs_inode;
	25	struct xfs_mount;
	26	struct xfs_trans;
	27
5e656dbb BN	28	extern kmem_zone_t *xfs_bmap_free_item_zone;
5e656dbb BN	29
19ebedcf DC	30	/*
	31	* Argument structure for xfs_bmap_alloc.
	32	*/
	33	struct xfs_bmalloca {
	34	xfs_fsblock_t firstblock; / i/o first block allocated */
6f530e9a	35	struct xfs_defer_ops flist; / bmap freelist */
19ebedcf DC	36	struct xfs_trans tp; / transaction pointer */
	37	struct xfs_inode ip; / incore inode pointer */
	38	struct xfs_bmbt_irec prev; /* extent before the new one */
	39	struct xfs_bmbt_irec got; /* extent after, or delayed */
	40
	41	xfs_fileoff_t offset; /* offset in file filling in */
	42	xfs_extlen_t length; /* i/o length asked/allocated */
	43	xfs_fsblock_t blkno; /* starting block of new extent */
	44
	45	struct xfs_btree_cur cur; / btree cursor */
	46	xfs_extnum_t idx; /* current extent index */
	47	int nallocs;/* number of extents alloc'd */
	48	int logflags;/* flags for transaction logging */
	49
	50	xfs_extlen_t total; /* total blocks needed for xaction */
	51	xfs_extlen_t minlen; /* minimum allocation size (blocks) */
	52	xfs_extlen_t minleft; /* amount must be left after alloc */
	53	bool eof; /* set if allocating past last extent */
	54	bool wasdel; /* replacing a delayed allocation */
19ebedcf DC	55	bool aeof; /* allocated space at eof */
19ebedcf DC	56	bool conv; /* overwriting unwritten extents */
9542ae13	57	char userdata;/* userdata mask */
19ebedcf DC	58	int flags;
	59	};
	60
2bd0ea18 NS	61	/*
	62	* List of extents to be free "later".
	63	* The list is kept sorted on xbf_startblock.
	64	*/
6f530e9a	65	struct xfs_extent_free_item
2bd0ea18	66	{
6f530e9a DW	67	xfs_fsblock_t xefi_startblock;/* starting fs block number */
	68	xfs_extlen_t xefi_blockcount;/* number of blocks in extent */
	69	struct list_head xefi_list;
2cf6d225	70	};
2bd0ea18	71
dfc130f3	72	#define XFS_BMAP_MAX_NMAP 4
2bd0ea18 NS	73
2bd0ea18 NS	74	/*
a2ceac1f	75	* Flags for xfs_bmapi_*
2bd0ea18	76	*/
a2ceac1f DC	77	#define XFS_BMAPI_ENTIRE 0x001 /* return entire extent, not trimmed */
	78	#define XFS_BMAPI_METADATA 0x002 /* mapping metadata not user data */
	79	#define XFS_BMAPI_ATTRFORK 0x004 /* use attribute fork not data */
	80	#define XFS_BMAPI_PREALLOC 0x008 /* preallocation op: unwritten space */
	81	#define XFS_BMAPI_IGSTATE 0x010 /* Ignore state - */
2bd0ea18	82	/* combine contig. space */
a2ceac1f	83	#define XFS_BMAPI_CONTIG 0x020 /* must allocate only one extent */
56b2de80 DC	84	/*
	85	* unwritten extent conversion - this needs write cache flushing and no additional
	86	* allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
	87	* from written to unwritten, otherwise convert from unwritten to written.
	88	*/
a2ceac1f	89	#define XFS_BMAPI_CONVERT 0x040
56b2de80	90
9542ae13 DC	91	/*
	92	* allocate zeroed extents - this requires all newly allocated user data extents
	93	* to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
	94	* Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
	95	* during the allocation range to zeroed written extents.
	96	*/
	97	#define XFS_BMAPI_ZERO 0x080
	98
56b2de80	99	#define XFS_BMAPI_FLAGS \
56b2de80 DC	100	{ XFS_BMAPI_ENTIRE, "ENTIRE" }, \
	101	{ XFS_BMAPI_METADATA, "METADATA" }, \
	102	{ XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
56b2de80 DC	103	{ XFS_BMAPI_PREALLOC, "PREALLOC" }, \
	104	{ XFS_BMAPI_IGSTATE, "IGSTATE" }, \
	105	{ XFS_BMAPI_CONTIG, "CONTIG" }, \
9542ae13 DC	106	{ XFS_BMAPI_CONVERT, "CONVERT" }, \
9542ae13 DC	107	{ XFS_BMAPI_ZERO, "ZERO" }
56b2de80	108
2bd0ea18	109
f302e9e4 NS	110	static inline int xfs_bmapi_aflag(int w)
	111	{
	112	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
	113	}
2bd0ea18 NS	114
	115	/*
	116	* Special values for xfs_bmbt_irec_t br_startblock field.
	117	*/
dfc130f3 RC	118	#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
dfc130f3 RC	119	#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
2bd0ea18	120
23aab3f9	121	/*
56b2de80	122	* Flags for xfs_bmap_add_extent*.
23aab3f9	123	*/
56b2de80 DC	124	#define BMAP_LEFT_CONTIG (1 << 0)
	125	#define BMAP_RIGHT_CONTIG (1 << 1)
	126	#define BMAP_LEFT_FILLING (1 << 2)
	127	#define BMAP_RIGHT_FILLING (1 << 3)
	128	#define BMAP_LEFT_DELAY (1 << 4)
	129	#define BMAP_RIGHT_DELAY (1 << 5)
	130	#define BMAP_LEFT_VALID (1 << 6)
	131	#define BMAP_RIGHT_VALID (1 << 7)
	132	#define BMAP_ATTRFORK (1 << 8)
	133
	134	#define XFS_BMAP_EXT_FLAGS \
	135	{ BMAP_LEFT_CONTIG, "LC" }, \
	136	{ BMAP_RIGHT_CONTIG, "RC" }, \
	137	{ BMAP_LEFT_FILLING, "LF" }, \
	138	{ BMAP_RIGHT_FILLING, "RF" }, \
	139	{ BMAP_ATTRFORK, "ATTR" }
23aab3f9	140
ff105f75 DC	141
	142	/*
	143	* This macro is used to determine how many extents will be shifted
	144	* in one write transaction. We could require two splits,
	145	* an extent move on the first and an extent merge on the second,
	146	* So it is proper that one extent is shifted inside write transaction
	147	* at a time.
	148	*/
	149	#define XFS_BMAP_MAX_SHIFT_EXTENTS 1
	150
19ebedcf DC	151	enum shift_direction {
	152	SHIFT_LEFT = 0,
	153	SHIFT_RIGHT,
	154	};
	155
1e2ecde4	156	#ifdef DEBUG
a2ceac1f DC	157	void xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
a2ceac1f DC	158	int whichfork, unsigned long caller_ip);
5e656dbb	159	#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
56b2de80 DC	160	xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
56b2de80 DC	161	#else
5e656dbb	162	#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
56b2de80	163	#endif
23aab3f9	164
a2ceac1f	165	int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
3f17ed4b	166	void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
6f530e9a	167	void xfs_bmap_add_free(struct xfs_mount mp, struct xfs_defer_ops flist,
af2e7c6e	168	xfs_fsblock_t bno, xfs_filblks_t len);
a2ceac1f DC	169	void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
	170	int xfs_bmap_first_unused(struct xfs_trans tp, struct xfs_inode ip,
	171	xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
	172	int xfs_bmap_last_before(struct xfs_trans tp, struct xfs_inode ip,
	173	xfs_fileoff_t *last_block, int whichfork);
ff105f75 DC	174	int xfs_bmap_last_offset(struct xfs_inode ip, xfs_fileoff_t unused,
ff105f75 DC	175	int whichfork);
a2ceac1f DC	176	int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
	177	int xfs_bmap_read_extents(struct xfs_trans tp, struct xfs_inode ip,
	178	int whichfork);
	179	int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
	180	xfs_filblks_t len, struct xfs_bmbt_irec *mval,
	181	int *nmap, int flags);
	182	int xfs_bmapi_delay(struct xfs_inode *ip, xfs_fileoff_t bno,
	183	xfs_filblks_t len, struct xfs_bmbt_irec *mval,
	184	int *nmap, int flags);
	185	int xfs_bmapi_write(struct xfs_trans tp, struct xfs_inode ip,
	186	xfs_fileoff_t bno, xfs_filblks_t len, int flags,
	187	xfs_fsblock_t *firstblock, xfs_extlen_t total,
	188	struct xfs_bmbt_irec mval, int nmap,
6f530e9a	189	struct xfs_defer_ops *flist);
a2ceac1f DC	190	int xfs_bunmapi(struct xfs_trans tp, struct xfs_inode ip,
	191	xfs_fileoff_t bno, xfs_filblks_t len, int flags,
	192	xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
6f530e9a	193	struct xfs_defer_ops flist, int done);
a2ceac1f DC	194	int xfs_check_nostate_extents(struct xfs_ifork *ifp, xfs_extnum_t idx,
	195	xfs_extnum_t num);
	196	uint xfs_default_attroffset(struct xfs_inode *ip);
ff105f75	197	int xfs_bmap_shift_extents(struct xfs_trans tp, struct xfs_inode ip,
19ebedcf DC	198	xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
19ebedcf DC	199	int done, xfs_fileoff_t stop_fsb, xfs_fsblock_t firstblock,
6f530e9a	200	struct xfs_defer_ops *flist, enum shift_direction direction,
19ebedcf DC	201	int num_exts);
19ebedcf DC	202	int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
56b2de80	203
e515cca1 DC	204	struct xfs_bmbt_rec_host *
	205	xfs_bmap_search_extents(struct xfs_inode *ip, xfs_fileoff_t bno,
	206	int fork, int eofp, xfs_extnum_t lastxp,
	207	struct xfs_bmbt_irec *gotp,
	208	struct xfs_bmbt_irec *prevp);
	209
	210
2bd0ea18	211	#endif /* __XFS_BMAP_H__ */