xref: /openbmc/linux/fs/xfs/xfs_rtalloc.h (revision c000c4f1)
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_trans	*tp,
26 	struct xfs_rtalloc_rec	*rec,
27 	void			*priv);
28 
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 */
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 */
66 void
67 xfs_rtunmount_inodes(
68 	struct xfs_mount	*mp);
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 
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 
100 /*
101  * From xfs_rtbitmap.c
102  */
103 int xfs_rtbuf_get(struct xfs_mount *mp, struct xfs_trans *tp,
104 		  xfs_rtblock_t block, int issum, struct xfs_buf **bpp);
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);
116 int xfs_rtmodify_summary_int(struct xfs_mount *mp, struct xfs_trans *tp,
117 			     int log, xfs_rtblock_t bbno, int delta,
118 			     xfs_buf_t **rbpp, xfs_fsblock_t *rsb,
119 			     xfs_suminfo_t *sum);
120 int xfs_rtmodify_summary(struct xfs_mount *mp, struct xfs_trans *tp, int log,
121 			 xfs_rtblock_t bbno, int delta, xfs_buf_t **rbpp,
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);
126 int xfs_rtalloc_query_range(struct xfs_trans *tp,
127 			    struct xfs_rtalloc_rec *low_rec,
128 			    struct xfs_rtalloc_rec *high_rec,
129 			    xfs_rtalloc_query_range_fn fn,
130 			    void *priv);
131 int xfs_rtalloc_query_all(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 #else
139 # define xfs_rtallocate_extent(t,b,min,max,l,f,p,rb)    (ENOSYS)
140 # define xfs_rtfree_extent(t,b,l)                       (ENOSYS)
141 # define xfs_rtpick_extent(m,t,l,rb)                    (ENOSYS)
142 # define xfs_growfs_rt(mp,in)                           (ENOSYS)
143 # define xfs_rtalloc_query_range(t,l,h,f,p)             (ENOSYS)
144 # define xfs_rtalloc_query_all(t,f,p)                   (ENOSYS)
145 # define xfs_rtbuf_get(m,t,b,i,p)                       (ENOSYS)
146 # define xfs_verify_rtbno(m, r)			(false)
147 # define xfs_rtalloc_extent_is_free(m,t,s,l,i)          (ENOSYS)
148 static inline int		/* error */
149 xfs_rtmount_init(
150 	xfs_mount_t	*mp)	/* file system mount structure */
151 {
152 	if (mp->m_sb.sb_rblocks == 0)
153 		return 0;
154 
155 	xfs_warn(mp, "Not built with CONFIG_XFS_RT");
156 	return -ENOSYS;
157 }
158 # define xfs_rtmount_inodes(m)  (((mp)->m_sb.sb_rblocks == 0)? 0 : (ENOSYS))
159 # define xfs_rtunmount_inodes(m)
160 #endif	/* CONFIG_XFS_RT */
161 
162 #endif	/* __XFS_RTALLOC_H__ */
163