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