xref: /openbmc/linux/fs/xfs/xfs_rtalloc.h (revision 39f555fb)
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 /*
62  * Initialize realtime fields in the mount structure.
63  */
64 int					/* error */
65 xfs_rtmount_init(
66 	struct xfs_mount	*mp);	/* file system mount structure */
67 void
68 xfs_rtunmount_inodes(
69 	struct xfs_mount	*mp);
70 
71 /*
72  * Get the bitmap and summary inodes into the mount structure
73  * at mount time.
74  */
75 int					/* error */
76 xfs_rtmount_inodes(
77 	struct xfs_mount	*mp);	/* file system mount structure */
78 
79 /*
80  * Pick an extent for allocation at the start of a new realtime file.
81  * Use the sequence number stored in the atime field of the bitmap inode.
82  * Translate this to a fraction of the rtextents, and return the product
83  * of rtextents and the fraction.
84  * The fraction sequence is 0, 1/2, 1/4, 3/4, 1/8, ..., 7/8, 1/16, ...
85  */
86 int					/* error */
87 xfs_rtpick_extent(
88 	struct xfs_mount	*mp,	/* file system mount point */
89 	struct xfs_trans	*tp,	/* transaction pointer */
90 	xfs_extlen_t		len,	/* allocation length (rtextents) */
91 	xfs_rtblock_t		*pick);	/* result rt extent */
92 
93 /*
94  * Grow the realtime area of the filesystem.
95  */
96 int
97 xfs_growfs_rt(
98 	struct xfs_mount	*mp,	/* file system mount structure */
99 	xfs_growfs_rt_t		*in);	/* user supplied growfs struct */
100 
101 /*
102  * From xfs_rtbitmap.c
103  */
104 int xfs_rtbuf_get(struct xfs_mount *mp, struct xfs_trans *tp,
105 		  xfs_rtblock_t block, int issum, struct xfs_buf **bpp);
106 int xfs_rtcheck_range(struct xfs_mount *mp, struct xfs_trans *tp,
107 		      xfs_rtblock_t start, xfs_extlen_t len, int val,
108 		      xfs_rtblock_t *new, int *stat);
109 int xfs_rtfind_back(struct xfs_mount *mp, struct xfs_trans *tp,
110 		    xfs_rtblock_t start, xfs_rtblock_t limit,
111 		    xfs_rtblock_t *rtblock);
112 int xfs_rtfind_forw(struct xfs_mount *mp, struct xfs_trans *tp,
113 		    xfs_rtblock_t start, xfs_rtblock_t limit,
114 		    xfs_rtblock_t *rtblock);
115 int xfs_rtmodify_range(struct xfs_mount *mp, struct xfs_trans *tp,
116 		       xfs_rtblock_t start, xfs_extlen_t len, int val);
117 int xfs_rtmodify_summary_int(struct xfs_mount *mp, struct xfs_trans *tp,
118 			     int log, xfs_rtblock_t bbno, int delta,
119 			     struct xfs_buf **rbpp, xfs_fsblock_t *rsb,
120 			     xfs_suminfo_t *sum);
121 int xfs_rtmodify_summary(struct xfs_mount *mp, struct xfs_trans *tp, int log,
122 			 xfs_rtblock_t bbno, int delta, struct xfs_buf **rbpp,
123 			 xfs_fsblock_t *rsb);
124 int xfs_rtfree_range(struct xfs_mount *mp, struct xfs_trans *tp,
125 		     xfs_rtblock_t start, xfs_extlen_t len,
126 		     struct xfs_buf **rbpp, xfs_fsblock_t *rsb);
127 int xfs_rtalloc_query_range(struct xfs_mount *mp, struct xfs_trans *tp,
128 		const struct xfs_rtalloc_rec *low_rec,
129 		const struct xfs_rtalloc_rec *high_rec,
130 		xfs_rtalloc_query_range_fn fn, void *priv);
131 int xfs_rtalloc_query_all(struct xfs_mount *mp, struct xfs_trans *tp,
132 			  xfs_rtalloc_query_range_fn fn,
133 			  void *priv);
134 bool xfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno);
135 int xfs_rtalloc_extent_is_free(struct xfs_mount *mp, struct xfs_trans *tp,
136 			       xfs_rtblock_t start, xfs_extlen_t len,
137 			       bool *is_free);
138 int xfs_rtalloc_reinit_frextents(struct xfs_mount *mp);
139 #else
140 # define xfs_rtallocate_extent(t,b,min,max,l,f,p,rb)    (ENOSYS)
141 # define xfs_rtfree_extent(t,b,l)                       (ENOSYS)
142 # define xfs_rtpick_extent(m,t,l,rb)                    (ENOSYS)
143 # define xfs_growfs_rt(mp,in)                           (ENOSYS)
144 # define xfs_rtalloc_query_range(t,l,h,f,p)             (ENOSYS)
145 # define xfs_rtalloc_query_all(m,t,f,p)                 (ENOSYS)
146 # define xfs_rtbuf_get(m,t,b,i,p)                       (ENOSYS)
147 # define xfs_verify_rtbno(m, r)			(false)
148 # define xfs_rtalloc_extent_is_free(m,t,s,l,i)          (ENOSYS)
149 # define xfs_rtalloc_reinit_frextents(m)                (0)
150 static inline int		/* error */
151 xfs_rtmount_init(
152 	xfs_mount_t	*mp)	/* file system mount structure */
153 {
154 	if (mp->m_sb.sb_rblocks == 0)
155 		return 0;
156 
157 	xfs_warn(mp, "Not built with CONFIG_XFS_RT");
158 	return -ENOSYS;
159 }
160 # define xfs_rtmount_inodes(m)  (((mp)->m_sb.sb_rblocks == 0)? 0 : (ENOSYS))
161 # define xfs_rtunmount_inodes(m)
162 #endif	/* CONFIG_XFS_RT */
163 
164 #endif	/* __XFS_RTALLOC_H__ */
165