[mirror_ubuntu-bionic-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;

/*
 * DELTA: describe a change to the in-core extent list.
 *
 * Internally the use of xed_blockount is somewhat funky.
 * xed_blockcount contains an offset much of the time because this
 * makes merging changes easier.  (xfs_fileoff_t and xfs_filblks_t are
 * the same underlying type).
 */
typedef struct xfs_extdelta
{
	xfs_fileoff_t		xed_startoff;	/* offset of range */
	xfs_filblks_t		xed_blockcount;	/* blocks in range */
} xfs_extdelta_t;

/*
 * 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_WRITE		0x001	/* write operation: allocate space */
#define XFS_BMAPI_DELAY		0x002	/* delayed write operation */
#define XFS_BMAPI_ENTIRE	0x004	/* return entire extent, not trimmed */
#define XFS_BMAPI_METADATA	0x008	/* mapping metadata not user data */
#define XFS_BMAPI_EXACT		0x010	/* allocate only to spec'd bounds */
#define XFS_BMAPI_ATTRFORK	0x020	/* use attribute fork not data */
#define XFS_BMAPI_ASYNC		0x040	/* bunmapi xactions can be async */
#define XFS_BMAPI_RSVBLOCKS	0x080	/* OK to alloc. reserved data blocks */
#define	XFS_BMAPI_PREALLOC	0x100	/* preallocation op: unwritten space */
#define	XFS_BMAPI_IGSTATE	0x200	/* Ignore state - */
					/* combine contig. space */
#define	XFS_BMAPI_CONTIG	0x400	/* must allocate only one extent */
/*	XFS_BMAPI_DIRECT_IO	0x800	*/
#define XFS_BMAPI_CONVERT	0x1000	/* unwritten extent conversion - */
					/* need write cache flushing and no */
					/* additional allocation alignments */

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 */
	xfs_fsblock_t		rval;	/* starting block of new extent */
	xfs_fileoff_t		off;	/* offset in file filling in */
	struct xfs_trans	*tp;	/* transaction pointer */
	struct xfs_inode	*ip;	/* incore inode pointer */
	struct xfs_bmbt_irec	*prevp;	/* extent before the new one */
	struct xfs_bmbt_irec	*gotp;	/* extent after, or delayed */
	xfs_extlen_t		alen;	/* i/o length asked/allocated */
	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			low;	/* low on space, using seq'l ags */
	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)

#if defined(__KERNEL__) && defined(XFS_BMAP_TRACE)
/*
 * Trace operations for bmap extent tracing
 */
#define	XFS_BMAP_KTRACE_DELETE	1
#define	XFS_BMAP_KTRACE_INSERT	2
#define	XFS_BMAP_KTRACE_PRE_UP	3
#define	XFS_BMAP_KTRACE_POST_UP	4

#define	XFS_BMAP_TRACE_SIZE	4096	/* size of global trace buffer */
#define	XFS_BMAP_KTRACE_SIZE	32	/* size of per-inode trace buffer */
extern ktrace_t	*xfs_bmap_trace_buf;

/*
 * Add bmap trace insert entries for all the contents of the extent list.
 */
void
xfs_bmap_trace_exlist(
	const char		*fname,		/* function name */
	struct xfs_inode	*ip,		/* incore inode pointer */
	xfs_extnum_t		cnt,		/* count of entries in list */
	int			whichfork);	/* data or attr fork */
#define	XFS_BMAP_TRACE_EXLIST(ip,c,w)	\
	xfs_bmap_trace_exlist(__func__,ip,c,w)

#else	/* __KERNEL__ && XFS_BMAP_TRACE */

#define	XFS_BMAP_TRACE_EXLIST(ip,c,w)

#endif	/* __KERNEL__ && XFS_BMAP_TRACE */

/*
 * Convert inode from non-attributed to attributed.
 * Must not be in a transaction, ip must not be locked.
 */
int					/* error code */
xfs_bmap_add_attrfork(
	struct xfs_inode	*ip,	/* incore inode pointer */
	int			size,	/* space needed for new attribute */
	int			rsvd);	/* flag for reserved block allocation */

/*
 * Add the extent to the list of extents to be free at transaction end.
 * The list is maintained sorted (by block number).
 */
void
xfs_bmap_add_free(
	xfs_fsblock_t		bno,		/* fs block number of extent */
	xfs_filblks_t		len,		/* length of extent */
	xfs_bmap_free_t		*flist,		/* list of extents */
	struct xfs_mount	*mp);		/* mount point structure */

/*
 * Routine to clean up the free list data structure when
 * an error occurs during a transaction.
 */
void
xfs_bmap_cancel(
	xfs_bmap_free_t		*flist);	/* free list to clean up */

/*
 * Compute and fill in the value of the maximum depth of a bmap btree
 * in this filesystem.  Done once, during mount.
 */
void
xfs_bmap_compute_maxlevels(
	struct xfs_mount	*mp,	/* file system mount structure */
	int			whichfork);	/* data or attr fork */

/*
 * Returns the file-relative block number of the first unused block in the file.
 * This is the lowest-address hole if the file has holes, else the first block
 * past the end of file.
 */
int						/* error */
xfs_bmap_first_unused(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	xfs_extlen_t		len,		/* size of hole to find */
	xfs_fileoff_t		*unused,	/* unused block num */
	int			whichfork);	/* data or attr fork */

/*
 * Returns the file-relative block number of the last block + 1 before
 * last_block (input value) in the file.
 * This is not based on i_size, it is based on the extent list.
 * Returns 0 for local files, as they do not have an extent list.
 */
int						/* error */
xfs_bmap_last_before(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	xfs_fileoff_t		*last_block,	/* last block */
	int			whichfork);	/* data or attr fork */

/*
 * Returns the file-relative block number of the first block past eof in
 * the file.  This is not based on i_size, it is based on the extent list.
 * Returns 0 for local files, as they do not have an extent list.
 */
int						/* error */
xfs_bmap_last_offset(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	xfs_fileoff_t		*unused,	/* last block num */
	int			whichfork);	/* data or attr fork */

/*
 * Returns whether the selected fork of the inode has exactly one
 * block or not.  For the data fork we check this matches di_size,
 * implying the file's range is 0..bsize-1.
 */
int
xfs_bmap_one_block(
	struct xfs_inode	*ip,		/* incore inode */
	int			whichfork);	/* data or attr fork */

/*
 * Read in the extents to iu_extents.
 * All inode fields are set up by caller, we just traverse the btree
 * and copy the records in.
 */
int						/* error */
xfs_bmap_read_extents(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	int			whichfork);	/* data or attr fork */

/*
 * Map file blocks to filesystem blocks.
 * File range is given by the bno/len pair.
 * Adds blocks to file if a write ("flags & XFS_BMAPI_WRITE" set)
 * into a hole or past eof.
 * Only allocates blocks from a single allocation group,
 * to avoid locking problems.
 * The returned value in "firstblock" from the first call in a transaction
 * must be remembered and presented to subsequent calls in "firstblock".
 * An upper bound for the number of blocks to be allocated is supplied to
 * the first call in "total"; if no allocation group has that many free
 * blocks then the call will fail (return NULLFSBLOCK in "firstblock").
 */
int						/* error */
xfs_bmapi(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	xfs_fileoff_t		bno,		/* starting file offs. mapped */
	xfs_filblks_t		len,		/* length to map in file */
	int			flags,		/* XFS_BMAPI_... */
	xfs_fsblock_t		*firstblock,	/* first allocated block
						   controls a.g. for allocs */
	xfs_extlen_t		total,		/* total blocks needed */
	struct xfs_bmbt_irec	*mval,		/* output: map values */
	int			*nmap,		/* i/o: mval size/count */
	xfs_bmap_free_t		*flist,		/* i/o: list extents to free */
	xfs_extdelta_t		*delta);	/* o: change made to incore
						   extents */

/*
 * Map file blocks to filesystem blocks, simple version.
 * One block only, read-only.
 * For flags, only the XFS_BMAPI_ATTRFORK flag is examined.
 * For the other flag values, the effect is as if XFS_BMAPI_METADATA
 * was set and all the others were clear.
 */
int						/* error */
xfs_bmapi_single(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	int			whichfork,	/* data or attr fork */
	xfs_fsblock_t		*fsb,		/* output: mapped block */
	xfs_fileoff_t		bno);		/* starting file offs. mapped */

/*
 * Unmap (remove) blocks from a file.
 * If nexts is nonzero then the number of extents to remove is limited to
 * that value.  If not all extents in the block range can be removed then
 * *done is set.
 */
int						/* error */
xfs_bunmapi(
	struct xfs_trans	*tp,		/* transaction pointer */
	struct xfs_inode	*ip,		/* incore inode */
	xfs_fileoff_t		bno,		/* starting offset to unmap */
	xfs_filblks_t		len,		/* length to unmap in file */
	int			flags,		/* XFS_BMAPI_... */
	xfs_extnum_t		nexts,		/* number of extents max */
	xfs_fsblock_t		*firstblock,	/* first allocated block
						   controls a.g. for allocs */
	xfs_bmap_free_t		*flist,		/* i/o: list extents to free */
	xfs_extdelta_t		*delta,		/* o: change made to incore
						   extents */
	int			*done);		/* set if not done yet */

/*
 * Check an extent list, which has just been read, for
 * any bit in the extent flag field.
 */
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__

/*
 * Routine to be called at transaction's end by xfs_bmapi, xfs_bunmapi
 * caller.  Frees all the extents that need freeing, which must be done
 * last due to locking considerations.
 *
 * Return 1 if the given transaction was committed and a new one allocated,
 * and 0 otherwise.
 */
int						/* error */
xfs_bmap_finish(
	struct xfs_trans	**tp,		/* transaction pointer addr */
	xfs_bmap_free_t		*flist,		/* i/o: list extents to free */
	int			*committed);	/* xact committed or not */

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

/*
 * Get inode's extents as described in bmv, and format for output.
 */
int						/* error code */
xfs_getbmap(
	xfs_inode_t		*ip,
	struct getbmapx		*bmv,		/* user bmap structure */
	xfs_bmap_format_t	formatter,	/* format to user */
	void			*arg);		/* formatter arg */

/*
 * Check if the endoff is outside the last extent. If so the caller will grow
 * the allocation to a stripe unit boundary
 */
int
xfs_bmap_eof(
	struct xfs_inode        *ip,
	xfs_fileoff_t           endoff,
	int                     whichfork,
	int                     *eof);

/*
 * Count fsblocks of the given fork.
 */
int
xfs_bmap_count_blocks(
	xfs_trans_t		*tp,
	struct xfs_inode	*ip,
	int			whichfork,
	int			*count);

#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
3e57ecf6 OW	30	/*
	31	* DELTA: describe a change to the in-core extent list.
	32	*
	33	* Internally the use of xed_blockount is somewhat funky.
	34	* xed_blockcount contains an offset much of the time because this
	35	* makes merging changes easier. (xfs_fileoff_t and xfs_filblks_t are
	36	* the same underlying type).
	37	*/
	38	typedef struct xfs_extdelta
	39	{
	40	xfs_fileoff_t xed_startoff; /* offset of range */
	41	xfs_filblks_t xed_blockcount; /* blocks in range */
	42	} xfs_extdelta_t;
	43
1da177e4 LT	44	/*
	45	* List of extents to be free "later".
	46	* The list is kept sorted on xbf_startblock.
	47	*/
	48	typedef struct xfs_bmap_free_item
	49	{
	50	xfs_fsblock_t xbfi_startblock;/* starting fs block number */
	51	xfs_extlen_t xbfi_blockcount;/* number of blocks in extent */
	52	struct xfs_bmap_free_item xbfi_next; / link to next entry */
	53	} xfs_bmap_free_item_t;
	54
	55	/*
	56	* Header for free extent list.
b877e3d3 LM	57	*
	58	* xbf_low is used by the allocator to activate the lowspace algorithm -
	59	* when free space is running low the extent allocator may choose to
	60	* allocate an extent from an AG without leaving sufficient space for
	61	* a btree split when inserting the new extent. In this case the allocator
	62	* will enable the lowspace algorithm which is supposed to allow further
	63	* allocations (such as btree splits and newroots) to allocate from
	64	* sequential AGs. In order to avoid locking AGs out of order the lowspace
	65	* algorithm will start searching for free space from AG 0. If the correct
	66	* transaction reservations have been made then this algorithm will eventually
	67	* find all the space it needs.
1da177e4 LT	68	*/
	69	typedef struct xfs_bmap_free
	70	{
	71	xfs_bmap_free_item_t xbf_first; / list of to-be-free extents */
	72	int xbf_count; /* count of items on list */
b877e3d3	73	int xbf_low; /* alloc in low mode */
1da177e4 LT	74	} xfs_bmap_free_t;
	75
	76	#define XFS_BMAP_MAX_NMAP 4
	77
	78	/*
	79	* Flags for xfs_bmapi
	80	*/
	81	#define XFS_BMAPI_WRITE 0x001 /* write operation: allocate space */
	82	#define XFS_BMAPI_DELAY 0x002 /* delayed write operation */
	83	#define XFS_BMAPI_ENTIRE 0x004 /* return entire extent, not trimmed */
	84	#define XFS_BMAPI_METADATA 0x008 /* mapping metadata not user data */
	85	#define XFS_BMAPI_EXACT 0x010 /* allocate only to spec'd bounds */
	86	#define XFS_BMAPI_ATTRFORK 0x020 /* use attribute fork not data */
	87	#define XFS_BMAPI_ASYNC 0x040 /* bunmapi xactions can be async */
	88	#define XFS_BMAPI_RSVBLOCKS 0x080 /* OK to alloc. reserved data blocks */
	89	#define XFS_BMAPI_PREALLOC 0x100 /* preallocation op: unwritten space */
	90	#define XFS_BMAPI_IGSTATE 0x200 /* Ignore state - */
	91	/* combine contig. space */
	92	#define XFS_BMAPI_CONTIG 0x400 /* must allocate only one extent */
dd9f438e NS	93	/* XFS_BMAPI_DIRECT_IO 0x800 */
	94	#define XFS_BMAPI_CONVERT 0x1000 /* unwritten extent conversion - */
	95	/* need write cache flushing and no */
	96	/* additional allocation alignments */
1da177e4	97
a844f451 NS	98	static inline int xfs_bmapi_aflag(int w)
	99	{
	100	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
	101	}
1da177e4 LT	102
	103	/*
	104	* Special values for xfs_bmbt_irec_t br_startblock field.
	105	*/
	106	#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
	107	#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
	108
a844f451 NS	109	static inline void xfs_bmap_init(xfs_bmap_free_t flp, xfs_fsblock_t fbp)
a844f451 NS	110	{
1da177e4	111	((flp)->xbf_first = NULL, (flp)->xbf_count = 0, \
a844f451 NS	112	(flp)->xbf_low = 0, *(fbp) = NULLFSBLOCK);
a844f451 NS	113	}
1da177e4 LT	114
	115	/*
	116	* Argument structure for xfs_bmap_alloc.
	117	*/
	118	typedef struct xfs_bmalloca {
	119	xfs_fsblock_t firstblock; /* i/o first block allocated */
	120	xfs_fsblock_t rval; /* starting block of new extent */
	121	xfs_fileoff_t off; /* offset in file filling in */
	122	struct xfs_trans tp; / transaction pointer */
	123	struct xfs_inode ip; / incore inode pointer */
	124	struct xfs_bmbt_irec prevp; / extent before the new one */
	125	struct xfs_bmbt_irec gotp; / extent after, or delayed */
	126	xfs_extlen_t alen; /* i/o length asked/allocated */
	127	xfs_extlen_t total; /* total blocks needed for xaction */
9da096fd	128	xfs_extlen_t minlen; /* minimum allocation size (blocks) */
1da177e4 LT	129	xfs_extlen_t minleft; /* amount must be left after alloc */
	130	char eof; /* set if allocating past last extent */
	131	char wasdel; /* replacing a delayed allocation */
	132	char userdata;/* set if is user data */
	133	char low; /* low on space, using seq'l ags */
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)
	149
847fff5c	150	#if defined(__KERNEL__) && defined(XFS_BMAP_TRACE)
1da177e4 LT	151	/*
	152	* Trace operations for bmap extent tracing
	153	*/
	154	#define XFS_BMAP_KTRACE_DELETE 1
	155	#define XFS_BMAP_KTRACE_INSERT 2
	156	#define XFS_BMAP_KTRACE_PRE_UP 3
	157	#define XFS_BMAP_KTRACE_POST_UP 4
	158
	159	#define XFS_BMAP_TRACE_SIZE 4096 /* size of global trace buffer */
	160	#define XFS_BMAP_KTRACE_SIZE 32 /* size of per-inode trace buffer */
	161	extern ktrace_t *xfs_bmap_trace_buf;
	162
	163	/*
	164	* Add bmap trace insert entries for all the contents of the extent list.
	165	*/
	166	void
	167	xfs_bmap_trace_exlist(
3a59c94c	168	const char fname, / function name */
1da177e4 LT	169	struct xfs_inode ip, / incore inode pointer */
	170	xfs_extnum_t cnt, /* count of entries in list */
	171	int whichfork); /* data or attr fork */
3a59c94c	172	#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
34a622b2	173	xfs_bmap_trace_exlist(__func__,ip,c,w)
847fff5c BN	174
	175	#else /* __KERNEL__ && XFS_BMAP_TRACE */
	176
3a59c94c	177	#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
847fff5c BN	178
847fff5c BN	179	#endif /* __KERNEL__ && XFS_BMAP_TRACE */
1da177e4 LT	180
	181	/*
	182	* Convert inode from non-attributed to attributed.
	183	* Must not be in a transaction, ip must not be locked.
	184	*/
	185	int /* error code */
	186	xfs_bmap_add_attrfork(
	187	struct xfs_inode ip, / incore inode pointer */
d8cc890d NS	188	int size, /* space needed for new attribute */
d8cc890d NS	189	int rsvd); /* flag for reserved block allocation */
1da177e4 LT	190
	191	/*
	192	* Add the extent to the list of extents to be free at transaction end.
	193	* The list is maintained sorted (by block number).
	194	*/
	195	void
	196	xfs_bmap_add_free(
	197	xfs_fsblock_t bno, /* fs block number of extent */
	198	xfs_filblks_t len, /* length of extent */
	199	xfs_bmap_free_t flist, / list of extents */
	200	struct xfs_mount mp); / mount point structure */
	201
	202	/*
	203	* Routine to clean up the free list data structure when
	204	* an error occurs during a transaction.
	205	*/
	206	void
	207	xfs_bmap_cancel(
	208	xfs_bmap_free_t flist); / free list to clean up */
	209
	210	/*
	211	* Compute and fill in the value of the maximum depth of a bmap btree
	212	* in this filesystem. Done once, during mount.
	213	*/
	214	void
	215	xfs_bmap_compute_maxlevels(
	216	struct xfs_mount mp, / file system mount structure */
	217	int whichfork); /* data or attr fork */
	218
1da177e4 LT	219	/*
	220	* Returns the file-relative block number of the first unused block in the file.
	221	* This is the lowest-address hole if the file has holes, else the first block
	222	* past the end of file.
	223	*/
	224	int /* error */
	225	xfs_bmap_first_unused(
	226	struct xfs_trans tp, / transaction pointer */
	227	struct xfs_inode ip, / incore inode */
	228	xfs_extlen_t len, /* size of hole to find */
	229	xfs_fileoff_t unused, / unused block num */
	230	int whichfork); /* data or attr fork */
	231
	232	/*
	233	* Returns the file-relative block number of the last block + 1 before
	234	* last_block (input value) in the file.
	235	* This is not based on i_size, it is based on the extent list.
	236	* Returns 0 for local files, as they do not have an extent list.
	237	*/
	238	int /* error */
	239	xfs_bmap_last_before(
	240	struct xfs_trans tp, / transaction pointer */
	241	struct xfs_inode ip, / incore inode */
	242	xfs_fileoff_t last_block, / last block */
	243	int whichfork); /* data or attr fork */
	244
	245	/*
	246	* Returns the file-relative block number of the first block past eof in
	247	* the file. This is not based on i_size, it is based on the extent list.
	248	* Returns 0 for local files, as they do not have an extent list.
	249	*/
	250	int /* error */
	251	xfs_bmap_last_offset(
	252	struct xfs_trans tp, / transaction pointer */
	253	struct xfs_inode ip, / incore inode */
	254	xfs_fileoff_t unused, / last block num */
	255	int whichfork); /* data or attr fork */
	256
	257	/*
	258	* Returns whether the selected fork of the inode has exactly one
	259	* block or not. For the data fork we check this matches di_size,
	260	* implying the file's range is 0..bsize-1.
	261	*/
	262	int
	263	xfs_bmap_one_block(
	264	struct xfs_inode ip, / incore inode */
	265	int whichfork); /* data or attr fork */
	266
	267	/*
	268	* Read in the extents to iu_extents.
	269	* All inode fields are set up by caller, we just traverse the btree
	270	* and copy the records in.
	271	*/
	272	int /* error */
	273	xfs_bmap_read_extents(
	274	struct xfs_trans tp, / transaction pointer */
	275	struct xfs_inode ip, / incore inode */
	276	int whichfork); /* data or attr fork */
	277
	278	/*
	279	* Map file blocks to filesystem blocks.
	280	* File range is given by the bno/len pair.
	281	* Adds blocks to file if a write ("flags & XFS_BMAPI_WRITE" set)
	282	* into a hole or past eof.
283	* Only allocates blocks from a single allocation group,
284	* to avoid locking problems.
285	* The returned value in "firstblock" from the first call in a transaction
286	* must be remembered and presented to subsequent calls in "firstblock".
287	* An upper bound for the number of blocks to be allocated is supplied to
288	* the first call in "total"; if no allocation group has that many free
289	* blocks then the call will fail (return NULLFSBLOCK in "firstblock").
290	*/
291	int /* error */
292	xfs_bmapi(
293	struct xfs_trans tp, / transaction pointer */
294	struct xfs_inode ip, / incore inode */
295	xfs_fileoff_t bno, /* starting file offs. mapped */
296	xfs_filblks_t len, /* length to map in file */
297	int flags, /* XFS_BMAPI_... */
298	xfs_fsblock_t firstblock, / first allocated block
299	controls a.g. for allocs */
300	xfs_extlen_t total, /* total blocks needed */
301	struct xfs_bmbt_irec mval, / output: map values */
302	int nmap, / i/o: mval size/count */
3e57ecf6 OW	303	xfs_bmap_free_t flist, / i/o: list extents to free */
	304	xfs_extdelta_t delta); / o: change made to incore
	305	extents */
1da177e4 LT	306
	307	/*
	308	* Map file blocks to filesystem blocks, simple version.
	309	* One block only, read-only.
	310	* For flags, only the XFS_BMAPI_ATTRFORK flag is examined.
	311	* For the other flag values, the effect is as if XFS_BMAPI_METADATA
	312	* was set and all the others were clear.
	313	*/
	314	int /* error */
	315	xfs_bmapi_single(
	316	struct xfs_trans tp, / transaction pointer */
	317	struct xfs_inode ip, / incore inode */
	318	int whichfork, /* data or attr fork */
	319	xfs_fsblock_t fsb, / output: mapped block */
	320	xfs_fileoff_t bno); /* starting file offs. mapped */
	321
	322	/*
	323	* Unmap (remove) blocks from a file.
	324	* If nexts is nonzero then the number of extents to remove is limited to
	325	* that value. If not all extents in the block range can be removed then
	326	* *done is set.
	327	*/
	328	int /* error */
	329	xfs_bunmapi(
	330	struct xfs_trans tp, / transaction pointer */
	331	struct xfs_inode ip, / incore inode */
	332	xfs_fileoff_t bno, /* starting offset to unmap */
	333	xfs_filblks_t len, /* length to unmap in file */
	334	int flags, /* XFS_BMAPI_... */
	335	xfs_extnum_t nexts, /* number of extents max */
	336	xfs_fsblock_t firstblock, / first allocated block
	337	controls a.g. for allocs */
	338	xfs_bmap_free_t flist, / i/o: list extents to free */
3e57ecf6 OW	339	xfs_extdelta_t delta, / o: change made to incore
3e57ecf6 OW	340	extents */
1da177e4 LT	341	int done); / set if not done yet */
1da177e4 LT	342
847fff5c BN	343	/*
	344	* Check an extent list, which has just been read, for
	345	* any bit in the extent flag field.
	346	*/
	347	int
	348	xfs_check_nostate_extents(
	349	struct xfs_ifork *ifp,
	350	xfs_extnum_t idx,
	351	xfs_extnum_t num);
	352
1a5902c5 CH	353	uint
	354	xfs_default_attroffset(
	355	struct xfs_inode *ip);
	356
847fff5c BN	357	#ifdef __KERNEL__
	358
	359	/*
	360	* Routine to be called at transaction's end by xfs_bmapi, xfs_bunmapi
	361	* caller. Frees all the extents that need freeing, which must be done
	362	* last due to locking considerations.
	363	*
	364	* Return 1 if the given transaction was committed and a new one allocated,
	365	* and 0 otherwise.
	366	*/
	367	int /* error */
	368	xfs_bmap_finish(
	369	struct xfs_trans *tp, / transaction pointer addr */
	370	xfs_bmap_free_t flist, / i/o: list extents to free */
	371	int committed); / xact committed or not */
	372
8a7141a8 ES	373	/* bmap to userspace formatter - copy to user & advance pointer */
	374	typedef int (xfs_bmap_format_t)(void , struct getbmapx , int *);
	375
1da177e4	376	/*
8a7141a8	377	* Get inode's extents as described in bmv, and format for output.
1da177e4 LT	378	*/
	379	int /* error code */
	380	xfs_getbmap(
993386c1	381	xfs_inode_t *ip,
8a7141a8 ES	382	struct getbmapx bmv, / user bmap structure */
	383	xfs_bmap_format_t formatter, /* format to user */
	384	void arg); / formatter arg */
1da177e4	385
1da177e4 LT	386	/*
	387	* Check if the endoff is outside the last extent. If so the caller will grow
	388	* the allocation to a stripe unit boundary
	389	*/
	390	int
	391	xfs_bmap_eof(
	392	struct xfs_inode *ip,
	393	xfs_fileoff_t endoff,
	394	int whichfork,
	395	int *eof);
	396
	397	/*
	398	* Count fsblocks of the given fork.
	399	*/
	400	int
	401	xfs_bmap_count_blocks(
	402	xfs_trans_t *tp,
	403	struct xfs_inode *ip,
	404	int whichfork,
	405	int *count);
	406
1da177e4 LT	407	#endif /* __KERNEL__ */
	408
	409	#endif /* __XFS_BMAP_H__ */