[mirror_ubuntu-zesty-kernel.git] / fs / xfs / 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	*dfops;	/* 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;
	struct xfs_owner_info	xefi_oinfo;	/* extent owner */
};

#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 *dfops,
			  xfs_fsblock_t bno, xfs_filblks_t len,
			  struct xfs_owner_info *oinfo);
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 *dfops);
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 *dfops, 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 *dfops, enum shift_direction direction,
		int num_exts);
int	xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);

#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
9799b438 DC	30	/*
	31	* Argument structure for xfs_bmap_alloc.
	32	*/
	33	struct xfs_bmalloca {
	34	xfs_fsblock_t firstblock; / i/o first block allocated */
2c3234d1	35	struct xfs_defer_ops dfops; / bmap freelist */
9799b438 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 */
9799b438 DC	55	bool aeof; /* allocated space at eof */
9799b438 DC	56	bool conv; /* overwriting unwritten extents */
3fbbbea3	57	char userdata;/* userdata mask */
9799b438 DC	58	int flags;
	59	};
	60
1da177e4 LT	61	/*
	62	* List of extents to be free "later".
	63	* The list is kept sorted on xbf_startblock.
	64	*/
310a75a3	65	struct xfs_extent_free_item
1da177e4	66	{
310a75a3 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;
340785cc	70	struct xfs_owner_info xefi_oinfo; /* extent owner */
e66a4c67	71	};
1da177e4	72
1da177e4 LT	73	#define XFS_BMAP_MAX_NMAP 4
	74
	75	/*
c0dc7828	76	* Flags for xfs_bmapi_*
1da177e4	77	*/
c0dc7828 DC	78	#define XFS_BMAPI_ENTIRE 0x001 /* return entire extent, not trimmed */
	79	#define XFS_BMAPI_METADATA 0x002 /* mapping metadata not user data */
	80	#define XFS_BMAPI_ATTRFORK 0x004 /* use attribute fork not data */
	81	#define XFS_BMAPI_PREALLOC 0x008 /* preallocation op: unwritten space */
	82	#define XFS_BMAPI_IGSTATE 0x010 /* Ignore state - */
1da177e4	83	/* combine contig. space */
c0dc7828	84	#define XFS_BMAPI_CONTIG 0x020 /* must allocate only one extent */
44722352 DC	85	/*
	86	* unwritten extent conversion - this needs write cache flushing and no additional
	87	* allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
	88	* from written to unwritten, otherwise convert from unwritten to written.
	89	*/
c0dc7828	90	#define XFS_BMAPI_CONVERT 0x040
1da177e4	91
3fbbbea3 DC	92	/*
	93	* allocate zeroed extents - this requires all newly allocated user data extents
	94	* to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
	95	* Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
	96	* during the allocation range to zeroed written extents.
	97	*/
	98	#define XFS_BMAPI_ZERO 0x080
	99
0b1b213f	100	#define XFS_BMAPI_FLAGS \
0b1b213f CH	101	{ XFS_BMAPI_ENTIRE, "ENTIRE" }, \
0b1b213f CH	102	{ XFS_BMAPI_METADATA, "METADATA" }, \
0b1b213f	103	{ XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
0b1b213f CH	104	{ XFS_BMAPI_PREALLOC, "PREALLOC" }, \
	105	{ XFS_BMAPI_IGSTATE, "IGSTATE" }, \
	106	{ XFS_BMAPI_CONTIG, "CONTIG" }, \
3fbbbea3 DC	107	{ XFS_BMAPI_CONVERT, "CONVERT" }, \
3fbbbea3 DC	108	{ XFS_BMAPI_ZERO, "ZERO" }
0b1b213f CH	109
0b1b213f CH	110
a844f451 NS	111	static inline int xfs_bmapi_aflag(int w)
	112	{
	113	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
	114	}
1da177e4 LT	115
	116	/*
	117	* Special values for xfs_bmbt_irec_t br_startblock field.
	118	*/
	119	#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
	120	#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
	121
7574aa92 CH	122	/*
	123	* Flags for xfs_bmap_add_extent*.
	124	*/
	125	#define BMAP_LEFT_CONTIG (1 << 0)
	126	#define BMAP_RIGHT_CONTIG (1 << 1)
	127	#define BMAP_LEFT_FILLING (1 << 2)
	128	#define BMAP_RIGHT_FILLING (1 << 3)
	129	#define BMAP_LEFT_DELAY (1 << 4)
	130	#define BMAP_RIGHT_DELAY (1 << 5)
	131	#define BMAP_LEFT_VALID (1 << 6)
	132	#define BMAP_RIGHT_VALID (1 << 7)
6ef35544	133	#define BMAP_ATTRFORK (1 << 8)
7574aa92	134
0b1b213f CH	135	#define XFS_BMAP_EXT_FLAGS \
	136	{ BMAP_LEFT_CONTIG, "LC" }, \
	137	{ BMAP_RIGHT_CONTIG, "RC" }, \
	138	{ BMAP_LEFT_FILLING, "LF" }, \
	139	{ BMAP_RIGHT_FILLING, "RF" }, \
	140	{ BMAP_ATTRFORK, "ATTR" }
1da177e4	141
e1d8fb88 NJ	142
	143	/*
	144	* This macro is used to determine how many extents will be shifted
	145	* in one write transaction. We could require two splits,
	146	* an extent move on the first and an extent merge on the second,
	147	* So it is proper that one extent is shifted inside write transaction
	148	* at a time.
	149	*/
	150	#define XFS_BMAP_MAX_SHIFT_EXTENTS 1
	151
a904b1ca NJ	152	enum shift_direction {
	153	SHIFT_LEFT = 0,
	154	SHIFT_RIGHT,
	155	};
	156
b49a0c18	157	#ifdef DEBUG
d952e2f8 CH	158	void xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
d952e2f8 CH	159	int whichfork, unsigned long caller_ip);
3a59c94c	160	#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
0b1b213f CH	161	xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
0b1b213f CH	162	#else
3a59c94c	163	#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
0b1b213f	164	#endif
1da177e4	165
d952e2f8	166	int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
f3508bcd	167	void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
2c3234d1	168	void xfs_bmap_add_free(struct xfs_mount mp, struct xfs_defer_ops dfops,
340785cc DW	169	xfs_fsblock_t bno, xfs_filblks_t len,
340785cc DW	170	struct xfs_owner_info *oinfo);
d952e2f8 CH	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);
7fb2cd4d ES	176	int xfs_bmap_last_offset(struct xfs_inode ip, xfs_fileoff_t unused,
7fb2cd4d ES	177	int whichfork);
d952e2f8 CH	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,
2c3234d1	191	struct xfs_defer_ops *dfops);
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,
2c3234d1	195	struct xfs_defer_ops dfops, int done);
d952e2f8 CH	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);
e1d8fb88	199	int xfs_bmap_shift_extents(struct xfs_trans tp, struct xfs_inode ip,
a904b1ca NJ	200	xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
a904b1ca NJ	201	int done, xfs_fileoff_t stop_fsb, xfs_fsblock_t firstblock,
2c3234d1	202	struct xfs_defer_ops *dfops, enum shift_direction direction,
a904b1ca NJ	203	int num_exts);
a904b1ca NJ	204	int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
1a5902c5	205
1da177e4	206	#endif /* __XFS_BMAP_H__ */