[linux-block.git] / fs / xfs / xfs_rtalloc.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef __XFS_RTALLOC_H__
#define	__XFS_RTALLOC_H__

/* kernel only definitions and functions */

struct xfs_mount;
struct xfs_trans;

/*
 * XXX: Most of the realtime allocation functions deal in units of realtime
 * extents, not realtime blocks.  This looks funny when paired with the type
 * name and screams for a larger cleanup.
 */
struct xfs_rtalloc_rec {
	xfs_rtblock_t		ar_startext;
	xfs_rtblock_t		ar_extcount;
};

typedef int (*xfs_rtalloc_query_range_fn)(
	struct xfs_trans		*tp,
	const struct xfs_rtalloc_rec	*rec,
	void				*priv);

#ifdef CONFIG_XFS_RT
/*
 * Function prototypes for exported functions.
 */

/*
 * Allocate an extent in the realtime subvolume, with the usual allocation
 * parameters.  The length units are all in realtime extents, as is the
 * result block number.
 */
int					/* error */
xfs_rtallocate_extent(
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_rtblock_t		bno,	/* starting block number to allocate */
	xfs_extlen_t		minlen,	/* minimum length to allocate */
	xfs_extlen_t		maxlen,	/* maximum length to allocate */
	xfs_extlen_t		*len,	/* out: actual length allocated */
	int			wasdel,	/* was a delayed allocation extent */
	xfs_extlen_t		prod,	/* extent product factor */
	xfs_rtblock_t		*rtblock); /* out: start block allocated */

/*
 * Free an extent in the realtime subvolume.  Length is expressed in
 * realtime extents, as is the block number.
 */
int					/* error */
xfs_rtfree_extent(
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_rtblock_t		bno,	/* starting block number to free */
	xfs_extlen_t		len);	/* length of extent freed */

/*
 * Initialize realtime fields in the mount structure.
 */
int					/* error */
xfs_rtmount_init(
	struct xfs_mount	*mp);	/* file system mount structure */
void
xfs_rtunmount_inodes(
	struct xfs_mount	*mp);

/*
 * Get the bitmap and summary inodes into the mount structure
 * at mount time.
 */
int					/* error */
xfs_rtmount_inodes(
	struct xfs_mount	*mp);	/* file system mount structure */

/*
 * Pick an extent for allocation at the start of a new realtime file.
 * Use the sequence number stored in the atime field of the bitmap inode.
 * Translate this to a fraction of the rtextents, and return the product
 * of rtextents and the fraction.
 * The fraction sequence is 0, 1/2, 1/4, 3/4, 1/8, ..., 7/8, 1/16, ...
 */
int					/* error */
xfs_rtpick_extent(
	struct xfs_mount	*mp,	/* file system mount point */
	struct xfs_trans	*tp,	/* transaction pointer */
	xfs_extlen_t		len,	/* allocation length (rtextents) */
	xfs_rtblock_t		*pick);	/* result rt extent */

/*
 * Grow the realtime area of the filesystem.
 */
int
xfs_growfs_rt(
	struct xfs_mount	*mp,	/* file system mount structure */
	xfs_growfs_rt_t		*in);	/* user supplied growfs struct */

/*
 * From xfs_rtbitmap.c
 */
int xfs_rtbuf_get(struct xfs_mount *mp, struct xfs_trans *tp,
		  xfs_rtblock_t block, int issum, struct xfs_buf **bpp);
int xfs_rtcheck_range(struct xfs_mount *mp, struct xfs_trans *tp,
		      xfs_rtblock_t start, xfs_extlen_t len, int val,
		      xfs_rtblock_t *new, int *stat);
int xfs_rtfind_back(struct xfs_mount *mp, struct xfs_trans *tp,
		    xfs_rtblock_t start, xfs_rtblock_t limit,
		    xfs_rtblock_t *rtblock);
int xfs_rtfind_forw(struct xfs_mount *mp, struct xfs_trans *tp,
		    xfs_rtblock_t start, xfs_rtblock_t limit,
		    xfs_rtblock_t *rtblock);
int xfs_rtmodify_range(struct xfs_mount *mp, struct xfs_trans *tp,
		       xfs_rtblock_t start, xfs_extlen_t len, int val);
int xfs_rtmodify_summary_int(struct xfs_mount *mp, struct xfs_trans *tp,
			     int log, xfs_rtblock_t bbno, int delta,
			     struct xfs_buf **rbpp, xfs_fsblock_t *rsb,
			     xfs_suminfo_t *sum);
int xfs_rtmodify_summary(struct xfs_mount *mp, struct xfs_trans *tp, int log,
			 xfs_rtblock_t bbno, int delta, struct xfs_buf **rbpp,
			 xfs_fsblock_t *rsb);
int xfs_rtfree_range(struct xfs_mount *mp, struct xfs_trans *tp,
		     xfs_rtblock_t start, xfs_extlen_t len,
		     struct xfs_buf **rbpp, xfs_fsblock_t *rsb);
int xfs_rtalloc_query_range(struct xfs_trans *tp,
		const struct xfs_rtalloc_rec *low_rec,
		const struct xfs_rtalloc_rec *high_rec,
		xfs_rtalloc_query_range_fn fn, void *priv);
int xfs_rtalloc_query_all(struct xfs_trans *tp,
			  xfs_rtalloc_query_range_fn fn,
			  void *priv);
bool xfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno);
int xfs_rtalloc_extent_is_free(struct xfs_mount *mp, struct xfs_trans *tp,
			       xfs_rtblock_t start, xfs_extlen_t len,
			       bool *is_free);
#else
# define xfs_rtallocate_extent(t,b,min,max,l,f,p,rb)    (ENOSYS)
# define xfs_rtfree_extent(t,b,l)                       (ENOSYS)
# define xfs_rtpick_extent(m,t,l,rb)                    (ENOSYS)
# define xfs_growfs_rt(mp,in)                           (ENOSYS)
# define xfs_rtalloc_query_range(t,l,h,f,p)             (ENOSYS)
# define xfs_rtalloc_query_all(t,f,p)                   (ENOSYS)
# define xfs_rtbuf_get(m,t,b,i,p)                       (ENOSYS)
# define xfs_verify_rtbno(m, r)			(false)
# define xfs_rtalloc_extent_is_free(m,t,s,l,i)          (ENOSYS)
static inline int		/* error */
xfs_rtmount_init(
	xfs_mount_t	*mp)	/* file system mount structure */
{
	if (mp->m_sb.sb_rblocks == 0)
		return 0;

	xfs_warn(mp, "Not built with CONFIG_XFS_RT");
	return -ENOSYS;
}
# define xfs_rtmount_inodes(m)  (((mp)->m_sb.sb_rblocks == 0)? 0 : (ENOSYS))
# define xfs_rtunmount_inodes(m)
#endif	/* CONFIG_XFS_RT */

#endif	/* __XFS_RTALLOC_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
1da177e4	2	/*
7b718769 NS	3	* Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
7b718769 NS	4	* All Rights Reserved.
1da177e4 LT	5	*/
	6	#ifndef __XFS_RTALLOC_H__
	7	#define __XFS_RTALLOC_H__
	8
c7298202 DC	9	/* kernel only definitions and functions */
c7298202 DC	10
1da177e4 LT	11	struct xfs_mount;
	12	struct xfs_trans;
	13
a0e5c435 DW	14	/*
	15	* XXX: Most of the realtime allocation functions deal in units of realtime
	16	* extents, not realtime blocks. This looks funny when paired with the type
	17	* name and screams for a larger cleanup.
	18	*/
fb3c3de2	19	struct xfs_rtalloc_rec {
a0e5c435 DW	20	xfs_rtblock_t ar_startext;
a0e5c435 DW	21	xfs_rtblock_t ar_extcount;
fb3c3de2 DW	22	};
	23
	24	typedef int (*xfs_rtalloc_query_range_fn)(
159eb69d DW	25	struct xfs_trans *tp,
	26	const struct xfs_rtalloc_rec *rec,
	27	void *priv);
fb3c3de2	28
1da177e4 LT	29	#ifdef CONFIG_XFS_RT
	30	/*
	31	* Function prototypes for exported functions.
	32	*/
	33
	34	/*
	35	* Allocate an extent in the realtime subvolume, with the usual allocation
	36	* parameters. The length units are all in realtime extents, as is the
	37	* result block number.
	38	*/
	39	int /* error */
	40	xfs_rtallocate_extent(
	41	struct xfs_trans tp, / transaction pointer */
	42	xfs_rtblock_t bno, /* starting block number to allocate */
	43	xfs_extlen_t minlen, /* minimum length to allocate */
	44	xfs_extlen_t maxlen, /* maximum length to allocate */
	45	xfs_extlen_t len, / out: actual length allocated */
1da177e4 LT	46	int wasdel, /* was a delayed allocation extent */
	47	xfs_extlen_t prod, /* extent product factor */
	48	xfs_rtblock_t rtblock); / out: start block allocated */
	49
	50	/*
	51	* Free an extent in the realtime subvolume. Length is expressed in
	52	* realtime extents, as is the block number.
	53	*/
	54	int /* error */
	55	xfs_rtfree_extent(
	56	struct xfs_trans tp, / transaction pointer */
	57	xfs_rtblock_t bno, /* starting block number to free */
	58	xfs_extlen_t len); /* length of extent freed */
	59
	60	/*
	61	* Initialize realtime fields in the mount structure.
	62	*/
	63	int /* error */
	64	xfs_rtmount_init(
	65	struct xfs_mount mp); / file system mount structure */
b93b6e43 CH	66	void
	67	xfs_rtunmount_inodes(
	68	struct xfs_mount *mp);
1da177e4 LT	69
	70	/*
	71	* Get the bitmap and summary inodes into the mount structure
	72	* at mount time.
	73	*/
	74	int /* error */
	75	xfs_rtmount_inodes(
	76	struct xfs_mount mp); / file system mount structure */
	77
	78	/*
	79	* Pick an extent for allocation at the start of a new realtime file.
	80	* Use the sequence number stored in the atime field of the bitmap inode.
	81	* Translate this to a fraction of the rtextents, and return the product
	82	* of rtextents and the fraction.
	83	* The fraction sequence is 0, 1/2, 1/4, 3/4, 1/8, ..., 7/8, 1/16, ...
	84	*/
	85	int /* error */
	86	xfs_rtpick_extent(
	87	struct xfs_mount mp, / file system mount point */
	88	struct xfs_trans tp, / transaction pointer */
	89	xfs_extlen_t len, /* allocation length (rtextents) */
	90	xfs_rtblock_t pick); / result rt extent */
	91
1da177e4 LT	92	/*
	93	* Grow the realtime area of the filesystem.
	94	*/
	95	int
	96	xfs_growfs_rt(
	97	struct xfs_mount mp, / file system mount structure */
	98	xfs_growfs_rt_t in); / user supplied growfs struct */
	99
c963c619 DC	100	/*
	101	* From xfs_rtbitmap.c
	102	*/
26788097 DW	103	int xfs_rtbuf_get(struct xfs_mount mp, struct xfs_trans tp,
26788097 DW	104	xfs_rtblock_t block, int issum, struct xfs_buf **bpp);
c963c619 DC	105	int xfs_rtcheck_range(struct xfs_mount mp, struct xfs_trans tp,
	106	xfs_rtblock_t start, xfs_extlen_t len, int val,
	107	xfs_rtblock_t new, int stat);
	108	int xfs_rtfind_back(struct xfs_mount mp, struct xfs_trans tp,
	109	xfs_rtblock_t start, xfs_rtblock_t limit,
	110	xfs_rtblock_t *rtblock);
	111	int xfs_rtfind_forw(struct xfs_mount mp, struct xfs_trans tp,
	112	xfs_rtblock_t start, xfs_rtblock_t limit,
	113	xfs_rtblock_t *rtblock);
	114	int xfs_rtmodify_range(struct xfs_mount mp, struct xfs_trans tp,
	115	xfs_rtblock_t start, xfs_extlen_t len, int val);
afabfd30 ES	116	int xfs_rtmodify_summary_int(struct xfs_mount mp, struct xfs_trans tp,
afabfd30 ES	117	int log, xfs_rtblock_t bbno, int delta,
e8222613	118	struct xfs_buf *rbpp, xfs_fsblock_t rsb,
afabfd30	119	xfs_suminfo_t *sum);
c963c619	120	int xfs_rtmodify_summary(struct xfs_mount mp, struct xfs_trans tp, int log,
e8222613	121	xfs_rtblock_t bbno, int delta, struct xfs_buf **rbpp,
c963c619 DC	122	xfs_fsblock_t *rsb);
	123	int xfs_rtfree_range(struct xfs_mount mp, struct xfs_trans tp,
	124	xfs_rtblock_t start, xfs_extlen_t len,
	125	struct xfs_buf *rbpp, xfs_fsblock_t rsb);
fb3c3de2	126	int xfs_rtalloc_query_range(struct xfs_trans *tp,
c02f6529 DW	127	const struct xfs_rtalloc_rec *low_rec,
	128	const struct xfs_rtalloc_rec *high_rec,
	129	xfs_rtalloc_query_range_fn fn, void *priv);
fb3c3de2 DW	130	int xfs_rtalloc_query_all(struct xfs_trans *tp,
	131	xfs_rtalloc_query_range_fn fn,
	132	void *priv);
21ec5416	133	bool xfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno);
46d9bfb5 DW	134	int xfs_rtalloc_extent_is_free(struct xfs_mount mp, struct xfs_trans tp,
	135	xfs_rtblock_t start, xfs_extlen_t len,
	136	bool *is_free);
1da177e4	137	#else
089ec2f8	138	# define xfs_rtallocate_extent(t,b,min,max,l,f,p,rb) (ENOSYS)
1da177e4 LT	139	# define xfs_rtfree_extent(t,b,l) (ENOSYS)
	140	# define xfs_rtpick_extent(m,t,l,rb) (ENOSYS)
	141	# define xfs_growfs_rt(mp,in) (ENOSYS)
fb3c3de2 DW	142	# define xfs_rtalloc_query_range(t,l,h,f,p) (ENOSYS)
fb3c3de2 DW	143	# define xfs_rtalloc_query_all(t,f,p) (ENOSYS)
26788097	144	# define xfs_rtbuf_get(m,t,b,i,p) (ENOSYS)
21ec5416	145	# define xfs_verify_rtbno(m, r) (false)
46d9bfb5	146	# define xfs_rtalloc_extent_is_free(m,t,s,l,i) (ENOSYS)
32891b29 ES	147	static inline int /* error */
	148	xfs_rtmount_init(
	149	xfs_mount_t mp) / file system mount structure */
	150	{
	151	if (mp->m_sb.sb_rblocks == 0)
	152	return 0;
	153
0b932ccc	154	xfs_warn(mp, "Not built with CONFIG_XFS_RT");
2451337d	155	return -ENOSYS;
32891b29	156	}
1da177e4	157	# define xfs_rtmount_inodes(m) (((mp)->m_sb.sb_rblocks == 0)? 0 : (ENOSYS))
b93b6e43	158	# define xfs_rtunmount_inodes(m)
1da177e4 LT	159	#endif /* CONFIG_XFS_RT */
1da177e4 LT	160
1da177e4	161	#endif /* __XFS_RTALLOC_H__ */