1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6 #ifndef __XFS_ALLOC_H__
7 #define __XFS_ALLOC_H__
8
9 struct xfs_buf;
10 struct xfs_btree_cur;
11 struct xfs_mount;
12 struct xfs_perag;
13 struct xfs_trans;
14
15 extern struct workqueue_struct *xfs_alloc_wq;
16
17 unsigned int xfs_agfl_size(struct xfs_mount *mp);
18
19 /*
20 * Flags for xfs_alloc_fix_freelist.
21 */
22 #define XFS_ALLOC_FLAG_TRYLOCK (1U << 0) /* use trylock for buffer locking */
23 #define XFS_ALLOC_FLAG_FREEING (1U << 1) /* indicate caller is freeing extents*/
24 #define XFS_ALLOC_FLAG_NORMAP (1U << 2) /* don't modify the rmapbt */
25 #define XFS_ALLOC_FLAG_NOSHRINK (1U << 3) /* don't shrink the freelist */
26 #define XFS_ALLOC_FLAG_CHECK (1U << 4) /* test only, don't modify args */
27 #define XFS_ALLOC_FLAG_TRYFLUSH (1U << 5) /* don't wait in busy extent flush */
28
29 /*
30 * Argument structure for xfs_alloc routines.
31 * This is turned into a structure to avoid having 20 arguments passed
32 * down several levels of the stack.
33 */
34 typedef struct xfs_alloc_arg {
35 struct xfs_trans *tp; /* transaction pointer */
36 struct xfs_mount *mp; /* file system mount point */
37 struct xfs_buf *agbp; /* buffer for a.g. freelist header */
38 struct xfs_perag *pag; /* per-ag struct for this agno */
39 xfs_fsblock_t fsbno; /* file system block number */
40 xfs_agnumber_t agno; /* allocation group number */
41 xfs_agblock_t agbno; /* allocation group-relative block # */
42 xfs_extlen_t minlen; /* minimum size of extent */
43 xfs_extlen_t maxlen; /* maximum size of extent */
44 xfs_extlen_t mod; /* mod value for extent size */
45 xfs_extlen_t prod; /* prod value for extent size */
46 xfs_extlen_t minleft; /* min blocks must be left after us */
47 xfs_extlen_t total; /* total blocks needed in xaction */
48 xfs_extlen_t alignment; /* align answer to multiple of this */
49 xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
50 xfs_agblock_t min_agbno; /* set an agbno range for NEAR allocs */
51 xfs_agblock_t max_agbno; /* ... */
52 xfs_extlen_t len; /* output: actual size of extent */
53 int datatype; /* mask defining data type treatment */
54 char wasdel; /* set if allocation was prev delayed */
55 char wasfromfl; /* set if allocation is from freelist */
56 bool alloc_minlen_only; /* allocate exact minlen extent */
57 struct xfs_owner_info oinfo; /* owner of blocks being allocated */
58 enum xfs_ag_resv_type resv; /* block reservation to use */
59 } xfs_alloc_arg_t;
60
61 /*
62 * Defines for datatype
63 */
64 #define XFS_ALLOC_USERDATA (1 << 0)/* allocation is for user data*/
65 #define XFS_ALLOC_INITIAL_USER_DATA (1 << 1)/* special case start of file */
66 #define XFS_ALLOC_NOBUSY (1 << 2)/* Busy extents not allowed */
67
68 /* freespace limit calculations */
69 unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
70 unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
71
72 xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
73 xfs_extlen_t need, xfs_extlen_t reserved);
74 unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
75 struct xfs_perag *pag);
76 int xfs_alloc_get_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
77 struct xfs_buf *agfbp, xfs_agblock_t *bnop, int btreeblk);
78 int xfs_alloc_put_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
79 struct xfs_buf *agfbp, struct xfs_buf *agflbp,
80 xfs_agblock_t bno, int btreeblk);
81
82 /*
83 * Compute and fill in value of m_alloc_maxlevels.
84 */
85 void
86 xfs_alloc_compute_maxlevels(
87 struct xfs_mount *mp); /* file system mount structure */
88
89 /*
90 * Log the given fields from the agf structure.
91 */
92 void
93 xfs_alloc_log_agf(
94 struct xfs_trans *tp, /* transaction pointer */
95 struct xfs_buf *bp, /* buffer for a.g. freelist header */
96 uint32_t fields);/* mask of fields to be logged (XFS_AGF_...) */
97
98 /*
99 * Allocate an extent anywhere in the specific AG given. If there is no
100 * space matching the requirements in that AG, then the allocation will fail.
101 */
102 int xfs_alloc_vextent_this_ag(struct xfs_alloc_arg *args, xfs_agnumber_t agno);
103
104 /*
105 * Allocate an extent as close to the target as possible. If there are not
106 * viable candidates in the AG, then fail the allocation.
107 */
108 int xfs_alloc_vextent_near_bno(struct xfs_alloc_arg *args,
109 xfs_fsblock_t target);
110
111 /*
112 * Allocate an extent exactly at the target given. If this is not possible
113 * then the allocation fails.
114 */
115 int xfs_alloc_vextent_exact_bno(struct xfs_alloc_arg *args,
116 xfs_fsblock_t target);
117
118 /*
119 * Best effort full filesystem allocation scan.
120 *
121 * Locality aware allocation will be attempted in the initial AG, but on failure
122 * non-localised attempts will be made. The AGs are constrained by previous
123 * allocations in the current transaction. Two passes will be made - the first
124 * non-blocking, the second blocking.
125 */
126 int xfs_alloc_vextent_start_ag(struct xfs_alloc_arg *args,
127 xfs_fsblock_t target);
128
129 /*
130 * Iterate from the AG indicated from args->fsbno through to the end of the
131 * filesystem attempting blocking allocation. This is for use in last
132 * resort allocation attempts when everything else has failed.
133 */
134 int xfs_alloc_vextent_first_ag(struct xfs_alloc_arg *args,
135 xfs_fsblock_t target);
136
137 /*
138 * Free an extent.
139 */
140 int /* error */
141 __xfs_free_extent(
142 struct xfs_trans *tp, /* transaction pointer */
143 struct xfs_perag *pag,
144 xfs_agblock_t agbno,
145 xfs_extlen_t len, /* length of extent */
146 const struct xfs_owner_info *oinfo, /* extent owner */
147 enum xfs_ag_resv_type type, /* block reservation type */
148 bool skip_discard);
149
150 static inline int
xfs_free_extent(struct xfs_trans * tp,struct xfs_perag * pag,xfs_agblock_t agbno,xfs_extlen_t len,const struct xfs_owner_info * oinfo,enum xfs_ag_resv_type type)151 xfs_free_extent(
152 struct xfs_trans *tp,
153 struct xfs_perag *pag,
154 xfs_agblock_t agbno,
155 xfs_extlen_t len,
156 const struct xfs_owner_info *oinfo,
157 enum xfs_ag_resv_type type)
158 {
159 return __xfs_free_extent(tp, pag, agbno, len, oinfo, type, false);
160 }
161
162 int /* error */
163 xfs_alloc_lookup_le(
164 struct xfs_btree_cur *cur, /* btree cursor */
165 xfs_agblock_t bno, /* starting block of extent */
166 xfs_extlen_t len, /* length of extent */
167 int *stat); /* success/failure */
168
169 int /* error */
170 xfs_alloc_lookup_ge(
171 struct xfs_btree_cur *cur, /* btree cursor */
172 xfs_agblock_t bno, /* starting block of extent */
173 xfs_extlen_t len, /* length of extent */
174 int *stat); /* success/failure */
175
176 int /* error */
177 xfs_alloc_get_rec(
178 struct xfs_btree_cur *cur, /* btree cursor */
179 xfs_agblock_t *bno, /* output: starting block of extent */
180 xfs_extlen_t *len, /* output: length of extent */
181 int *stat); /* output: success/failure */
182
183 union xfs_btree_rec;
184 void xfs_alloc_btrec_to_irec(const union xfs_btree_rec *rec,
185 struct xfs_alloc_rec_incore *irec);
186 xfs_failaddr_t xfs_alloc_check_irec(struct xfs_btree_cur *cur,
187 const struct xfs_alloc_rec_incore *irec);
188
189 int xfs_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
190 struct xfs_buf **agfbpp);
191 int xfs_alloc_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
192 struct xfs_buf **agfbpp);
193 int xfs_alloc_read_agfl(struct xfs_perag *pag, struct xfs_trans *tp,
194 struct xfs_buf **bpp);
195 int xfs_free_agfl_block(struct xfs_trans *, xfs_agnumber_t, xfs_agblock_t,
196 struct xfs_buf *, struct xfs_owner_info *);
197 int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, uint32_t alloc_flags);
198 int xfs_free_extent_fix_freelist(struct xfs_trans *tp, struct xfs_perag *pag,
199 struct xfs_buf **agbp);
200
201 xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
202
203 typedef int (*xfs_alloc_query_range_fn)(
204 struct xfs_btree_cur *cur,
205 const struct xfs_alloc_rec_incore *rec,
206 void *priv);
207
208 int xfs_alloc_query_range(struct xfs_btree_cur *cur,
209 const struct xfs_alloc_rec_incore *low_rec,
210 const struct xfs_alloc_rec_incore *high_rec,
211 xfs_alloc_query_range_fn fn, void *priv);
212 int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
213 void *priv);
214
215 int xfs_alloc_has_records(struct xfs_btree_cur *cur, xfs_agblock_t bno,
216 xfs_extlen_t len, enum xbtree_recpacking *outcome);
217
218 typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
219 void *priv);
220 int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
221 struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
222
223 static inline __be32 *
xfs_buf_to_agfl_bno(struct xfs_buf * bp)224 xfs_buf_to_agfl_bno(
225 struct xfs_buf *bp)
226 {
227 if (xfs_has_crc(bp->b_mount))
228 return bp->b_addr + sizeof(struct xfs_agfl);
229 return bp->b_addr;
230 }
231
232 int __xfs_free_extent_later(struct xfs_trans *tp, xfs_fsblock_t bno,
233 xfs_filblks_t len, const struct xfs_owner_info *oinfo,
234 enum xfs_ag_resv_type type, bool skip_discard);
235
236 /*
237 * List of extents to be free "later".
238 * The list is kept sorted on xbf_startblock.
239 */
240 struct xfs_extent_free_item {
241 struct list_head xefi_list;
242 uint64_t xefi_owner;
243 xfs_fsblock_t xefi_startblock;/* starting fs block number */
244 xfs_extlen_t xefi_blockcount;/* number of blocks in extent */
245 struct xfs_perag *xefi_pag;
246 unsigned int xefi_flags;
247 enum xfs_ag_resv_type xefi_agresv;
248 };
249
250 void xfs_extent_free_get_group(struct xfs_mount *mp,
251 struct xfs_extent_free_item *xefi);
252
253 #define XFS_EFI_SKIP_DISCARD (1U << 0) /* don't issue discard */
254 #define XFS_EFI_ATTR_FORK (1U << 1) /* freeing attr fork block */
255 #define XFS_EFI_BMBT_BLOCK (1U << 2) /* freeing bmap btree block */
256
257 static inline int
xfs_free_extent_later(struct xfs_trans * tp,xfs_fsblock_t bno,xfs_filblks_t len,const struct xfs_owner_info * oinfo,enum xfs_ag_resv_type type)258 xfs_free_extent_later(
259 struct xfs_trans *tp,
260 xfs_fsblock_t bno,
261 xfs_filblks_t len,
262 const struct xfs_owner_info *oinfo,
263 enum xfs_ag_resv_type type)
264 {
265 return __xfs_free_extent_later(tp, bno, len, oinfo, type, false);
266 }
267
268
269 extern struct kmem_cache *xfs_extfree_item_cache;
270
271 int __init xfs_extfree_intent_init_cache(void);
272 void xfs_extfree_intent_destroy_cache(void);
273
274 xfs_failaddr_t xfs_validate_ag_length(struct xfs_buf *bp, uint32_t seqno,
275 uint32_t length);
276
277 #endif /* __XFS_ALLOC_H__ */
278