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 struct xfs_owner_info oinfo; /* owner of blocks being allocated */
57 enum xfs_ag_resv_type resv; /* block reservation to use */
58 #ifdef DEBUG
59 bool alloc_minlen_only; /* allocate exact minlen extent */
60 #endif
61 } xfs_alloc_arg_t;
62
63 /*
64 * Defines for datatype
65 */
66 #define XFS_ALLOC_USERDATA (1 << 0)/* allocation is for user data*/
67 #define XFS_ALLOC_INITIAL_USER_DATA (1 << 1)/* special case start of file */
68 #define XFS_ALLOC_NOBUSY (1 << 2)/* Busy extents not allowed */
69
70 /* freespace limit calculations */
71 unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
72 unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
73
74 xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
75 xfs_extlen_t need, xfs_extlen_t reserved);
76 unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
77 struct xfs_perag *pag);
78 int xfs_alloc_get_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
79 struct xfs_buf *agfbp, xfs_agblock_t *bnop, int btreeblk);
80 int xfs_alloc_put_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
81 struct xfs_buf *agfbp, struct xfs_buf *agflbp,
82 xfs_agblock_t bno, int btreeblk);
83 int xfs_free_ag_extent(struct xfs_trans *tp, struct xfs_buf *agbp,
84 xfs_agnumber_t agno, xfs_agblock_t bno,
85 xfs_extlen_t len, const struct xfs_owner_info *oinfo,
86 enum xfs_ag_resv_type type);
87
88 /*
89 * Compute and fill in value of m_alloc_maxlevels.
90 */
91 void
92 xfs_alloc_compute_maxlevels(
93 struct xfs_mount *mp); /* file system mount structure */
94
95 /*
96 * Log the given fields from the agf structure.
97 */
98 void
99 xfs_alloc_log_agf(
100 struct xfs_trans *tp, /* transaction pointer */
101 struct xfs_buf *bp, /* buffer for a.g. freelist header */
102 uint32_t fields);/* mask of fields to be logged (XFS_AGF_...) */
103
104 /*
105 * Allocate an extent anywhere in the specific AG given. If there is no
106 * space matching the requirements in that AG, then the allocation will fail.
107 */
108 int xfs_alloc_vextent_this_ag(struct xfs_alloc_arg *args, xfs_agnumber_t agno);
109
110 /*
111 * Allocate an extent as close to the target as possible. If there are not
112 * viable candidates in the AG, then fail the allocation.
113 */
114 int xfs_alloc_vextent_near_bno(struct xfs_alloc_arg *args,
115 xfs_fsblock_t target);
116
117 /*
118 * Allocate an extent exactly at the target given. If this is not possible
119 * then the allocation fails.
120 */
121 int xfs_alloc_vextent_exact_bno(struct xfs_alloc_arg *args,
122 xfs_fsblock_t target);
123
124 /*
125 * Best effort full filesystem allocation scan.
126 *
127 * Locality aware allocation will be attempted in the initial AG, but on failure
128 * non-localised attempts will be made. The AGs are constrained by previous
129 * allocations in the current transaction. Two passes will be made - the first
130 * non-blocking, the second blocking.
131 */
132 int xfs_alloc_vextent_start_ag(struct xfs_alloc_arg *args,
133 xfs_fsblock_t target);
134
135 /*
136 * Iterate from the AG indicated from args->fsbno through to the end of the
137 * filesystem attempting blocking allocation. This is for use in last
138 * resort allocation attempts when everything else has failed.
139 */
140 int xfs_alloc_vextent_first_ag(struct xfs_alloc_arg *args,
141 xfs_fsblock_t target);
142
143 /*
144 * Free an extent.
145 */
146 int /* error */
147 __xfs_free_extent(
148 struct xfs_trans *tp, /* transaction pointer */
149 struct xfs_perag *pag,
150 xfs_agblock_t agbno,
151 xfs_extlen_t len, /* length of extent */
152 const struct xfs_owner_info *oinfo, /* extent owner */
153 enum xfs_ag_resv_type type, /* block reservation type */
154 bool skip_discard);
155
156 static inline int
157 xfs_free_extent(
158 struct xfs_trans *tp,
159 struct xfs_perag *pag,
160 xfs_agblock_t agbno,
161 xfs_extlen_t len,
162 const struct xfs_owner_info *oinfo,
163 enum xfs_ag_resv_type type)
164 {
165 return __xfs_free_extent(tp, pag, agbno, len, oinfo, type, false);
166 }
167
168 int /* error */
169 xfs_alloc_lookup_le(
170 struct xfs_btree_cur *cur, /* btree cursor */
171 xfs_agblock_t bno, /* starting block of extent */
172 xfs_extlen_t len, /* length of extent */
173 int *stat); /* success/failure */
174
175 int /* error */
176 xfs_alloc_lookup_ge(
177 struct xfs_btree_cur *cur, /* btree cursor */
178 xfs_agblock_t bno, /* starting block of extent */
179 xfs_extlen_t len, /* length of extent */
180 int *stat); /* success/failure */
181
182 int /* error */
183 xfs_alloc_get_rec(
184 struct xfs_btree_cur *cur, /* btree cursor */
185 xfs_agblock_t *bno, /* output: starting block of extent */
186 xfs_extlen_t *len, /* output: length of extent */
187 int *stat); /* output: success/failure */
188
189 union xfs_btree_rec;
190 void xfs_alloc_btrec_to_irec(const union xfs_btree_rec *rec,
191 struct xfs_alloc_rec_incore *irec);
192 xfs_failaddr_t xfs_alloc_check_irec(struct xfs_perag *pag,
193 const struct xfs_alloc_rec_incore *irec);
194
195 int xfs_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
196 struct xfs_buf **agfbpp);
197 int xfs_alloc_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
198 struct xfs_buf **agfbpp);
199 int xfs_alloc_read_agfl(struct xfs_perag *pag, struct xfs_trans *tp,
200 struct xfs_buf **bpp);
201 int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, uint32_t alloc_flags);
202 int xfs_free_extent_fix_freelist(struct xfs_trans *tp, struct xfs_perag *pag,
203 struct xfs_buf **agbp);
204
205 xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
206
207 typedef int (*xfs_alloc_query_range_fn)(
208 struct xfs_btree_cur *cur,
209 const struct xfs_alloc_rec_incore *rec,
210 void *priv);
211
212 int xfs_alloc_query_range(struct xfs_btree_cur *cur,
213 const struct xfs_alloc_rec_incore *low_rec,
214 const struct xfs_alloc_rec_incore *high_rec,
215 xfs_alloc_query_range_fn fn, void *priv);
216 int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
217 void *priv);
218
219 int xfs_alloc_has_records(struct xfs_btree_cur *cur, xfs_agblock_t bno,
220 xfs_extlen_t len, enum xbtree_recpacking *outcome);
221
222 typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
223 void *priv);
224 int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
225 struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
226
227 static inline __be32 *
228 xfs_buf_to_agfl_bno(
229 struct xfs_buf *bp)
230 {
231 if (xfs_has_crc(bp->b_mount))
232 return bp->b_addr + sizeof(struct xfs_agfl);
233 return bp->b_addr;
234 }
235
236 int xfs_free_extent_later(struct xfs_trans *tp, xfs_fsblock_t bno,
237 xfs_filblks_t len, const struct xfs_owner_info *oinfo,
238 enum xfs_ag_resv_type type, unsigned int free_flags);
239
240 /* Don't issue a discard for the blocks freed. */
241 #define XFS_FREE_EXTENT_SKIP_DISCARD (1U << 0)
242
243 #define XFS_FREE_EXTENT_ALL_FLAGS (XFS_FREE_EXTENT_SKIP_DISCARD)
244
245 /*
246 * List of extents to be free "later".
247 * The list is kept sorted on xbf_startblock.
248 */
249 struct xfs_extent_free_item {
250 struct list_head xefi_list;
251 uint64_t xefi_owner;
252 xfs_fsblock_t xefi_startblock;/* starting fs block number */
253 xfs_extlen_t xefi_blockcount;/* number of blocks in extent */
254 struct xfs_perag *xefi_pag;
255 unsigned int xefi_flags;
256 enum xfs_ag_resv_type xefi_agresv;
257 };
258
259 #define XFS_EFI_SKIP_DISCARD (1U << 0) /* don't issue discard */
260 #define XFS_EFI_ATTR_FORK (1U << 1) /* freeing attr fork block */
261 #define XFS_EFI_BMBT_BLOCK (1U << 2) /* freeing bmap btree block */
262 #define XFS_EFI_CANCELLED (1U << 3) /* dont actually free the space */
263
264 struct xfs_alloc_autoreap {
265 struct xfs_defer_pending *dfp;
266 };
267
268 int xfs_alloc_schedule_autoreap(const struct xfs_alloc_arg *args,
269 unsigned int free_flags, struct xfs_alloc_autoreap *aarp);
270 void xfs_alloc_cancel_autoreap(struct xfs_trans *tp,
271 struct xfs_alloc_autoreap *aarp);
272 void xfs_alloc_commit_autoreap(struct xfs_trans *tp,
273 struct xfs_alloc_autoreap *aarp);
274
275 extern struct kmem_cache *xfs_extfree_item_cache;
276
277 int __init xfs_extfree_intent_init_cache(void);
278 void xfs_extfree_intent_destroy_cache(void);
279
280 xfs_failaddr_t xfs_validate_ag_length(struct xfs_buf *bp, uint32_t seqno,
281 uint32_t length);
282
283 #endif /* __XFS_ALLOC_H__ */
284
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.