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