Loading...
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
9struct xfs_buf;
10struct xfs_btree_cur;
11struct xfs_mount;
12struct xfs_perag;
13struct xfs_trans;
14
15extern struct workqueue_struct *xfs_alloc_wq;
16
17unsigned 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 */
34typedef 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 */
69unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
70unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
71
72xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
73 xfs_extlen_t need, xfs_extlen_t reserved);
74unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
75 struct xfs_perag *pag);
76int xfs_alloc_get_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
77 struct xfs_buf *agfbp, xfs_agblock_t *bnop, int btreeblk);
78int 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);
81int xfs_free_ag_extent(struct xfs_trans *tp, struct xfs_buf *agbp,
82 xfs_agblock_t bno, xfs_extlen_t len,
83 const struct xfs_owner_info *oinfo, enum xfs_ag_resv_type type);
84
85/*
86 * Compute and fill in value of m_alloc_maxlevels.
87 */
88void
89xfs_alloc_compute_maxlevels(
90 struct xfs_mount *mp); /* file system mount structure */
91
92/*
93 * Log the given fields from the agf structure.
94 */
95void
96xfs_alloc_log_agf(
97 struct xfs_trans *tp, /* transaction pointer */
98 struct xfs_buf *bp, /* buffer for a.g. freelist header */
99 uint32_t fields);/* mask of fields to be logged (XFS_AGF_...) */
100
101/*
102 * Allocate an extent anywhere in the specific AG given. If there is no
103 * space matching the requirements in that AG, then the allocation will fail.
104 */
105int xfs_alloc_vextent_this_ag(struct xfs_alloc_arg *args, xfs_agnumber_t agno);
106
107/*
108 * Allocate an extent as close to the target as possible. If there are not
109 * viable candidates in the AG, then fail the allocation.
110 */
111int xfs_alloc_vextent_near_bno(struct xfs_alloc_arg *args,
112 xfs_fsblock_t target);
113
114/*
115 * Allocate an extent exactly at the target given. If this is not possible
116 * then the allocation fails.
117 */
118int xfs_alloc_vextent_exact_bno(struct xfs_alloc_arg *args,
119 xfs_fsblock_t target);
120
121/*
122 * Best effort full filesystem allocation scan.
123 *
124 * Locality aware allocation will be attempted in the initial AG, but on failure
125 * non-localised attempts will be made. The AGs are constrained by previous
126 * allocations in the current transaction. Two passes will be made - the first
127 * non-blocking, the second blocking.
128 */
129int xfs_alloc_vextent_start_ag(struct xfs_alloc_arg *args,
130 xfs_fsblock_t target);
131
132/*
133 * Iterate from the AG indicated from args->fsbno through to the end of the
134 * filesystem attempting blocking allocation. This is for use in last
135 * resort allocation attempts when everything else has failed.
136 */
137int xfs_alloc_vextent_first_ag(struct xfs_alloc_arg *args,
138 xfs_fsblock_t target);
139
140/*
141 * Free an extent.
142 */
143int /* error */
144__xfs_free_extent(
145 struct xfs_trans *tp, /* transaction pointer */
146 struct xfs_perag *pag,
147 xfs_agblock_t agbno,
148 xfs_extlen_t len, /* length of extent */
149 const struct xfs_owner_info *oinfo, /* extent owner */
150 enum xfs_ag_resv_type type, /* block reservation type */
151 bool skip_discard);
152
153static inline int
154xfs_free_extent(
155 struct xfs_trans *tp,
156 struct xfs_perag *pag,
157 xfs_agblock_t agbno,
158 xfs_extlen_t len,
159 const struct xfs_owner_info *oinfo,
160 enum xfs_ag_resv_type type)
161{
162 return __xfs_free_extent(tp, pag, agbno, len, oinfo, type, false);
163}
164
165int /* error */
166xfs_alloc_lookup_le(
167 struct xfs_btree_cur *cur, /* btree cursor */
168 xfs_agblock_t bno, /* starting block of extent */
169 xfs_extlen_t len, /* length of extent */
170 int *stat); /* success/failure */
171
172int /* error */
173xfs_alloc_lookup_ge(
174 struct xfs_btree_cur *cur, /* btree cursor */
175 xfs_agblock_t bno, /* starting block of extent */
176 xfs_extlen_t len, /* length of extent */
177 int *stat); /* success/failure */
178
179int /* error */
180xfs_alloc_get_rec(
181 struct xfs_btree_cur *cur, /* btree cursor */
182 xfs_agblock_t *bno, /* output: starting block of extent */
183 xfs_extlen_t *len, /* output: length of extent */
184 int *stat); /* output: success/failure */
185
186union xfs_btree_rec;
187void xfs_alloc_btrec_to_irec(const union xfs_btree_rec *rec,
188 struct xfs_alloc_rec_incore *irec);
189xfs_failaddr_t xfs_alloc_check_irec(struct xfs_perag *pag,
190 const struct xfs_alloc_rec_incore *irec);
191
192int xfs_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
193 struct xfs_buf **agfbpp);
194int xfs_alloc_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
195 struct xfs_buf **agfbpp);
196int xfs_alloc_read_agfl(struct xfs_perag *pag, struct xfs_trans *tp,
197 struct xfs_buf **bpp);
198int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, uint32_t alloc_flags);
199int xfs_free_extent_fix_freelist(struct xfs_trans *tp, struct xfs_perag *pag,
200 struct xfs_buf **agbp);
201
202xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
203
204typedef int (*xfs_alloc_query_range_fn)(
205 struct xfs_btree_cur *cur,
206 const struct xfs_alloc_rec_incore *rec,
207 void *priv);
208
209int xfs_alloc_query_range(struct xfs_btree_cur *cur,
210 const struct xfs_alloc_rec_incore *low_rec,
211 const struct xfs_alloc_rec_incore *high_rec,
212 xfs_alloc_query_range_fn fn, void *priv);
213int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
214 void *priv);
215
216int xfs_alloc_has_records(struct xfs_btree_cur *cur, xfs_agblock_t bno,
217 xfs_extlen_t len, enum xbtree_recpacking *outcome);
218
219typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
220 void *priv);
221int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
222 struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
223
224static inline __be32 *
225xfs_buf_to_agfl_bno(
226 struct xfs_buf *bp)
227{
228 if (xfs_has_crc(bp->b_mount))
229 return bp->b_addr + sizeof(struct xfs_agfl);
230 return bp->b_addr;
231}
232
233int xfs_free_extent_later(struct xfs_trans *tp, xfs_fsblock_t bno,
234 xfs_filblks_t len, const struct xfs_owner_info *oinfo,
235 enum xfs_ag_resv_type type, unsigned int free_flags);
236
237/* Don't issue a discard for the blocks freed. */
238#define XFS_FREE_EXTENT_SKIP_DISCARD (1U << 0)
239
240/* Free blocks on the realtime device. */
241#define XFS_FREE_EXTENT_REALTIME (1U << 1)
242
243#define XFS_FREE_EXTENT_ALL_FLAGS (XFS_FREE_EXTENT_SKIP_DISCARD | \
244 XFS_FREE_EXTENT_REALTIME)
245
246/*
247 * List of extents to be free "later".
248 * The list is kept sorted on xbf_startblock.
249 */
250struct xfs_extent_free_item {
251 struct list_head xefi_list;
252 uint64_t xefi_owner;
253 xfs_fsblock_t xefi_startblock;/* starting fs block number */
254 xfs_extlen_t xefi_blockcount;/* number of blocks in extent */
255 struct xfs_group *xefi_group;
256 unsigned int xefi_flags;
257 enum xfs_ag_resv_type xefi_agresv;
258};
259
260#define XFS_EFI_SKIP_DISCARD (1U << 0) /* don't issue discard */
261#define XFS_EFI_ATTR_FORK (1U << 1) /* freeing attr fork block */
262#define XFS_EFI_BMBT_BLOCK (1U << 2) /* freeing bmap btree block */
263#define XFS_EFI_CANCELLED (1U << 3) /* dont actually free the space */
264#define XFS_EFI_REALTIME (1U << 4) /* freeing realtime extent */
265
266static inline bool xfs_efi_is_realtime(const struct xfs_extent_free_item *xefi)
267{
268 return xefi->xefi_flags & XFS_EFI_REALTIME;
269}
270
271struct xfs_alloc_autoreap {
272 struct xfs_defer_pending *dfp;
273};
274
275int xfs_alloc_schedule_autoreap(const struct xfs_alloc_arg *args,
276 unsigned int free_flags, struct xfs_alloc_autoreap *aarp);
277void xfs_alloc_cancel_autoreap(struct xfs_trans *tp,
278 struct xfs_alloc_autoreap *aarp);
279void xfs_alloc_commit_autoreap(struct xfs_trans *tp,
280 struct xfs_alloc_autoreap *aarp);
281
282extern struct kmem_cache *xfs_extfree_item_cache;
283
284int __init xfs_extfree_intent_init_cache(void);
285void xfs_extfree_intent_destroy_cache(void);
286
287xfs_failaddr_t xfs_validate_ag_length(struct xfs_buf *bp, uint32_t seqno,
288 uint32_t length);
289
290#endif /* __XFS_ALLOC_H__ */
1/*
2 * Copyright (c) 2000-2002,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_ALLOC_H__
19#define __XFS_ALLOC_H__
20
21struct xfs_buf;
22struct xfs_btree_cur;
23struct xfs_mount;
24struct xfs_perag;
25struct xfs_trans;
26
27extern struct workqueue_struct *xfs_alloc_wq;
28
29/*
30 * Freespace allocation types. Argument to xfs_alloc_[v]extent.
31 */
32#define XFS_ALLOCTYPE_ANY_AG 0x01 /* allocate anywhere, use rotor */
33#define XFS_ALLOCTYPE_FIRST_AG 0x02 /* ... start at ag 0 */
34#define XFS_ALLOCTYPE_START_AG 0x04 /* anywhere, start in this a.g. */
35#define XFS_ALLOCTYPE_THIS_AG 0x08 /* anywhere in this a.g. */
36#define XFS_ALLOCTYPE_START_BNO 0x10 /* near this block else anywhere */
37#define XFS_ALLOCTYPE_NEAR_BNO 0x20 /* in this a.g. and near this block */
38#define XFS_ALLOCTYPE_THIS_BNO 0x40 /* at exactly this block */
39
40/* this should become an enum again when the tracing code is fixed */
41typedef unsigned int xfs_alloctype_t;
42
43#define XFS_ALLOC_TYPES \
44 { XFS_ALLOCTYPE_ANY_AG, "ANY_AG" }, \
45 { XFS_ALLOCTYPE_FIRST_AG, "FIRST_AG" }, \
46 { XFS_ALLOCTYPE_START_AG, "START_AG" }, \
47 { XFS_ALLOCTYPE_THIS_AG, "THIS_AG" }, \
48 { XFS_ALLOCTYPE_START_BNO, "START_BNO" }, \
49 { XFS_ALLOCTYPE_NEAR_BNO, "NEAR_BNO" }, \
50 { XFS_ALLOCTYPE_THIS_BNO, "THIS_BNO" }
51
52/*
53 * Flags for xfs_alloc_fix_freelist.
54 */
55#define XFS_ALLOC_FLAG_TRYLOCK 0x00000001 /* use trylock for buffer locking */
56#define XFS_ALLOC_FLAG_FREEING 0x00000002 /* indicate caller is freeing extents*/
57
58/*
59 * In order to avoid ENOSPC-related deadlock caused by
60 * out-of-order locking of AGF buffer (PV 947395), we place
61 * constraints on the relationship among actual allocations for
62 * data blocks, freelist blocks, and potential file data bmap
63 * btree blocks. However, these restrictions may result in no
64 * actual space allocated for a delayed extent, for example, a data
65 * block in a certain AG is allocated but there is no additional
66 * block for the additional bmap btree block due to a split of the
67 * bmap btree of the file. The result of this may lead to an
68 * infinite loop in xfssyncd when the file gets flushed to disk and
69 * all delayed extents need to be actually allocated. To get around
70 * this, we explicitly set aside a few blocks which will not be
71 * reserved in delayed allocation. Considering the minimum number of
72 * needed freelist blocks is 4 fsbs _per AG_, a potential split of file's bmap
73 * btree requires 1 fsb, so we set the number of set-aside blocks
74 * to 4 + 4*agcount.
75 */
76#define XFS_ALLOC_SET_ASIDE(mp) (4 + ((mp)->m_sb.sb_agcount * 4))
77
78/*
79 * When deciding how much space to allocate out of an AG, we limit the
80 * allocation maximum size to the size the AG. However, we cannot use all the
81 * blocks in the AG - some are permanently used by metadata. These
82 * blocks are generally:
83 * - the AG superblock, AGF, AGI and AGFL
84 * - the AGF (bno and cnt) and AGI btree root blocks
85 * - 4 blocks on the AGFL according to XFS_ALLOC_SET_ASIDE() limits
86 *
87 * The AG headers are sector sized, so the amount of space they take up is
88 * dependent on filesystem geometry. The others are all single blocks.
89 */
90#define XFS_ALLOC_AG_MAX_USABLE(mp) \
91 ((mp)->m_sb.sb_agblocks - XFS_BB_TO_FSB(mp, XFS_FSS_TO_BB(mp, 4)) - 7)
92
93
94/*
95 * Argument structure for xfs_alloc routines.
96 * This is turned into a structure to avoid having 20 arguments passed
97 * down several levels of the stack.
98 */
99typedef struct xfs_alloc_arg {
100 struct xfs_trans *tp; /* transaction pointer */
101 struct xfs_mount *mp; /* file system mount point */
102 struct xfs_buf *agbp; /* buffer for a.g. freelist header */
103 struct xfs_perag *pag; /* per-ag struct for this agno */
104 struct xfs_inode *ip; /* for userdata zeroing method */
105 xfs_fsblock_t fsbno; /* file system block number */
106 xfs_agnumber_t agno; /* allocation group number */
107 xfs_agblock_t agbno; /* allocation group-relative block # */
108 xfs_extlen_t minlen; /* minimum size of extent */
109 xfs_extlen_t maxlen; /* maximum size of extent */
110 xfs_extlen_t mod; /* mod value for extent size */
111 xfs_extlen_t prod; /* prod value for extent size */
112 xfs_extlen_t minleft; /* min blocks must be left after us */
113 xfs_extlen_t total; /* total blocks needed in xaction */
114 xfs_extlen_t alignment; /* align answer to multiple of this */
115 xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
116 xfs_agblock_t min_agbno; /* set an agbno range for NEAR allocs */
117 xfs_agblock_t max_agbno; /* ... */
118 xfs_extlen_t len; /* output: actual size of extent */
119 xfs_alloctype_t type; /* allocation type XFS_ALLOCTYPE_... */
120 xfs_alloctype_t otype; /* original allocation type */
121 char wasdel; /* set if allocation was prev delayed */
122 char wasfromfl; /* set if allocation is from freelist */
123 char isfl; /* set if is freelist blocks - !acctg */
124 char userdata; /* mask defining userdata treatment */
125 xfs_fsblock_t firstblock; /* io first block allocated */
126} xfs_alloc_arg_t;
127
128/*
129 * Defines for userdata
130 */
131#define XFS_ALLOC_USERDATA (1 << 0)/* allocation is for user data*/
132#define XFS_ALLOC_INITIAL_USER_DATA (1 << 1)/* special case start of file */
133#define XFS_ALLOC_USERDATA_ZERO (1 << 2)/* zero extent on allocation */
134
135xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_mount *mp,
136 struct xfs_perag *pag, xfs_extlen_t need);
137unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
138 struct xfs_perag *pag);
139
140/*
141 * Compute and fill in value of m_ag_maxlevels.
142 */
143void
144xfs_alloc_compute_maxlevels(
145 struct xfs_mount *mp); /* file system mount structure */
146
147/*
148 * Get a block from the freelist.
149 * Returns with the buffer for the block gotten.
150 */
151int /* error */
152xfs_alloc_get_freelist(
153 struct xfs_trans *tp, /* transaction pointer */
154 struct xfs_buf *agbp, /* buffer containing the agf structure */
155 xfs_agblock_t *bnop, /* block address retrieved from freelist */
156 int btreeblk); /* destination is a AGF btree */
157
158/*
159 * Log the given fields from the agf structure.
160 */
161void
162xfs_alloc_log_agf(
163 struct xfs_trans *tp, /* transaction pointer */
164 struct xfs_buf *bp, /* buffer for a.g. freelist header */
165 int fields);/* mask of fields to be logged (XFS_AGF_...) */
166
167/*
168 * Interface for inode allocation to force the pag data to be initialized.
169 */
170int /* error */
171xfs_alloc_pagf_init(
172 struct xfs_mount *mp, /* file system mount structure */
173 struct xfs_trans *tp, /* transaction pointer */
174 xfs_agnumber_t agno, /* allocation group number */
175 int flags); /* XFS_ALLOC_FLAGS_... */
176
177/*
178 * Put the block on the freelist for the allocation group.
179 */
180int /* error */
181xfs_alloc_put_freelist(
182 struct xfs_trans *tp, /* transaction pointer */
183 struct xfs_buf *agbp, /* buffer for a.g. freelist header */
184 struct xfs_buf *agflbp,/* buffer for a.g. free block array */
185 xfs_agblock_t bno, /* block being freed */
186 int btreeblk); /* owner was a AGF btree */
187
188/*
189 * Read in the allocation group header (free/alloc section).
190 */
191int /* error */
192xfs_alloc_read_agf(
193 struct xfs_mount *mp, /* mount point structure */
194 struct xfs_trans *tp, /* transaction pointer */
195 xfs_agnumber_t agno, /* allocation group number */
196 int flags, /* XFS_ALLOC_FLAG_... */
197 struct xfs_buf **bpp); /* buffer for the ag freelist header */
198
199/*
200 * Allocate an extent (variable-size).
201 */
202int /* error */
203xfs_alloc_vextent(
204 xfs_alloc_arg_t *args); /* allocation argument structure */
205
206/*
207 * Free an extent.
208 */
209int /* error */
210xfs_free_extent(
211 struct xfs_trans *tp, /* transaction pointer */
212 xfs_fsblock_t bno, /* starting block number of extent */
213 xfs_extlen_t len); /* length of extent */
214
215int /* error */
216xfs_alloc_lookup_le(
217 struct xfs_btree_cur *cur, /* btree cursor */
218 xfs_agblock_t bno, /* starting block of extent */
219 xfs_extlen_t len, /* length of extent */
220 int *stat); /* success/failure */
221
222int /* error */
223xfs_alloc_lookup_ge(
224 struct xfs_btree_cur *cur, /* btree cursor */
225 xfs_agblock_t bno, /* starting block of extent */
226 xfs_extlen_t len, /* length of extent */
227 int *stat); /* success/failure */
228
229int /* error */
230xfs_alloc_get_rec(
231 struct xfs_btree_cur *cur, /* btree cursor */
232 xfs_agblock_t *bno, /* output: starting block of extent */
233 xfs_extlen_t *len, /* output: length of extent */
234 int *stat); /* output: success/failure */
235
236int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
237 xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
238int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
239
240#endif /* __XFS_ALLOC_H__ */