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