xref: /openbmc/linux/fs/xfs/libxfs/xfs_alloc.h (revision 63705da3)
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  * Freespace allocation types.  Argument to xfs_alloc_[v]extent.
21  */
22 #define XFS_ALLOCTYPE_FIRST_AG	0x02	/* ... start at ag 0 */
23 #define XFS_ALLOCTYPE_THIS_AG	0x08	/* anywhere in this a.g. */
24 #define XFS_ALLOCTYPE_START_BNO	0x10	/* near this block else anywhere */
25 #define XFS_ALLOCTYPE_NEAR_BNO	0x20	/* in this a.g. and near this block */
26 #define XFS_ALLOCTYPE_THIS_BNO	0x40	/* at exactly this block */
27 
28 /* this should become an enum again when the tracing code is fixed */
29 typedef unsigned int xfs_alloctype_t;
30 
31 #define XFS_ALLOC_TYPES \
32 	{ XFS_ALLOCTYPE_FIRST_AG,	"FIRST_AG" }, \
33 	{ XFS_ALLOCTYPE_THIS_AG,	"THIS_AG" }, \
34 	{ XFS_ALLOCTYPE_START_BNO,	"START_BNO" }, \
35 	{ XFS_ALLOCTYPE_NEAR_BNO,	"NEAR_BNO" }, \
36 	{ XFS_ALLOCTYPE_THIS_BNO,	"THIS_BNO" }
37 
38 /*
39  * Flags for xfs_alloc_fix_freelist.
40  */
41 #define	XFS_ALLOC_FLAG_TRYLOCK	0x00000001  /* use trylock for buffer locking */
42 #define	XFS_ALLOC_FLAG_FREEING	0x00000002  /* indicate caller is freeing extents*/
43 #define	XFS_ALLOC_FLAG_NORMAP	0x00000004  /* don't modify the rmapbt */
44 #define	XFS_ALLOC_FLAG_NOSHRINK	0x00000008  /* don't shrink the freelist */
45 #define	XFS_ALLOC_FLAG_CHECK	0x00000010  /* test only, don't modify args */
46 
47 /*
48  * Argument structure for xfs_alloc routines.
49  * This is turned into a structure to avoid having 20 arguments passed
50  * down several levels of the stack.
51  */
52 typedef struct xfs_alloc_arg {
53 	struct xfs_trans *tp;		/* transaction pointer */
54 	struct xfs_mount *mp;		/* file system mount point */
55 	struct xfs_buf	*agbp;		/* buffer for a.g. freelist header */
56 	struct xfs_perag *pag;		/* per-ag struct for this agno */
57 	xfs_fsblock_t	fsbno;		/* file system block number */
58 	xfs_agnumber_t	agno;		/* allocation group number */
59 	xfs_agblock_t	agbno;		/* allocation group-relative block # */
60 	xfs_extlen_t	minlen;		/* minimum size of extent */
61 	xfs_extlen_t	maxlen;		/* maximum size of extent */
62 	xfs_extlen_t	mod;		/* mod value for extent size */
63 	xfs_extlen_t	prod;		/* prod value for extent size */
64 	xfs_extlen_t	minleft;	/* min blocks must be left after us */
65 	xfs_extlen_t	total;		/* total blocks needed in xaction */
66 	xfs_extlen_t	alignment;	/* align answer to multiple of this */
67 	xfs_extlen_t	minalignslop;	/* slop for minlen+alignment calcs */
68 	xfs_agblock_t	min_agbno;	/* set an agbno range for NEAR allocs */
69 	xfs_agblock_t	max_agbno;	/* ... */
70 	xfs_extlen_t	len;		/* output: actual size of extent */
71 	xfs_alloctype_t	type;		/* allocation type XFS_ALLOCTYPE_... */
72 	xfs_alloctype_t	otype;		/* original allocation type */
73 	int		datatype;	/* mask defining data type treatment */
74 	char		wasdel;		/* set if allocation was prev delayed */
75 	char		wasfromfl;	/* set if allocation is from freelist */
76 	struct xfs_owner_info	oinfo;	/* owner of blocks being allocated */
77 	enum xfs_ag_resv_type	resv;	/* block reservation to use */
78 #ifdef DEBUG
79 	bool		alloc_minlen_only; /* allocate exact minlen extent */
80 #endif
81 } xfs_alloc_arg_t;
82 
83 /*
84  * Defines for datatype
85  */
86 #define XFS_ALLOC_USERDATA		(1 << 0)/* allocation is for user data*/
87 #define XFS_ALLOC_INITIAL_USER_DATA	(1 << 1)/* special case start of file */
88 #define XFS_ALLOC_NOBUSY		(1 << 2)/* Busy extents not allowed */
89 
90 /* freespace limit calculations */
91 #define XFS_ALLOC_AGFL_RESERVE	4
92 unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
93 unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
94 
95 xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
96 		xfs_extlen_t need, xfs_extlen_t reserved);
97 unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
98 		struct xfs_perag *pag);
99 
100 /*
101  * Compute and fill in value of m_alloc_maxlevels.
102  */
103 void
104 xfs_alloc_compute_maxlevels(
105 	struct xfs_mount	*mp);	/* file system mount structure */
106 
107 /*
108  * Get a block from the freelist.
109  * Returns with the buffer for the block gotten.
110  */
111 int				/* error */
112 xfs_alloc_get_freelist(
113 	struct xfs_trans *tp,	/* transaction pointer */
114 	struct xfs_buf	*agbp,	/* buffer containing the agf structure */
115 	xfs_agblock_t	*bnop,	/* block address retrieved from freelist */
116 	int		btreeblk); /* destination is a AGF btree */
117 
118 /*
119  * Log the given fields from the agf structure.
120  */
121 void
122 xfs_alloc_log_agf(
123 	struct xfs_trans *tp,	/* transaction pointer */
124 	struct xfs_buf	*bp,	/* buffer for a.g. freelist header */
125 	int		fields);/* mask of fields to be logged (XFS_AGF_...) */
126 
127 /*
128  * Interface for inode allocation to force the pag data to be initialized.
129  */
130 int				/* error */
131 xfs_alloc_pagf_init(
132 	struct xfs_mount *mp,	/* file system mount structure */
133 	struct xfs_trans *tp,	/* transaction pointer */
134 	xfs_agnumber_t	agno,	/* allocation group number */
135 	int		flags);	/* XFS_ALLOC_FLAGS_... */
136 
137 /*
138  * Put the block on the freelist for the allocation group.
139  */
140 int				/* error */
141 xfs_alloc_put_freelist(
142 	struct xfs_trans *tp,	/* transaction pointer */
143 	struct xfs_buf	*agbp,	/* buffer for a.g. freelist header */
144 	struct xfs_buf	*agflbp,/* buffer for a.g. free block array */
145 	xfs_agblock_t	bno,	/* block being freed */
146 	int		btreeblk); /* owner was a AGF btree */
147 
148 /*
149  * Read in the allocation group header (free/alloc section).
150  */
151 int					/* error  */
152 xfs_alloc_read_agf(
153 	struct xfs_mount *mp,		/* mount point structure */
154 	struct xfs_trans *tp,		/* transaction pointer */
155 	xfs_agnumber_t	agno,		/* allocation group number */
156 	int		flags,		/* XFS_ALLOC_FLAG_... */
157 	struct xfs_buf	**bpp);		/* buffer for the ag freelist header */
158 
159 /*
160  * Allocate an extent (variable-size).
161  */
162 int				/* error */
163 xfs_alloc_vextent(
164 	xfs_alloc_arg_t	*args);	/* allocation argument structure */
165 
166 /*
167  * Free an extent.
168  */
169 int				/* error */
170 __xfs_free_extent(
171 	struct xfs_trans	*tp,	/* transaction pointer */
172 	xfs_fsblock_t		bno,	/* starting block number of extent */
173 	xfs_extlen_t		len,	/* length of extent */
174 	const struct xfs_owner_info	*oinfo,	/* extent owner */
175 	enum xfs_ag_resv_type	type,	/* block reservation type */
176 	bool			skip_discard);
177 
178 static inline int
179 xfs_free_extent(
180 	struct xfs_trans	*tp,
181 	xfs_fsblock_t		bno,
182 	xfs_extlen_t		len,
183 	const struct xfs_owner_info	*oinfo,
184 	enum xfs_ag_resv_type	type)
185 {
186 	return __xfs_free_extent(tp, bno, len, oinfo, type, false);
187 }
188 
189 int				/* error */
190 xfs_alloc_lookup_le(
191 	struct xfs_btree_cur	*cur,	/* btree cursor */
192 	xfs_agblock_t		bno,	/* starting block of extent */
193 	xfs_extlen_t		len,	/* length of extent */
194 	int			*stat);	/* success/failure */
195 
196 int				/* error */
197 xfs_alloc_lookup_ge(
198 	struct xfs_btree_cur	*cur,	/* btree cursor */
199 	xfs_agblock_t		bno,	/* starting block of extent */
200 	xfs_extlen_t		len,	/* length of extent */
201 	int			*stat);	/* success/failure */
202 
203 int					/* error */
204 xfs_alloc_get_rec(
205 	struct xfs_btree_cur	*cur,	/* btree cursor */
206 	xfs_agblock_t		*bno,	/* output: starting block of extent */
207 	xfs_extlen_t		*len,	/* output: length of extent */
208 	int			*stat);	/* output: success/failure */
209 
210 int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
211 			xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
212 int xfs_alloc_read_agfl(struct xfs_mount *mp, struct xfs_trans *tp,
213 			xfs_agnumber_t agno, struct xfs_buf **bpp);
214 int xfs_free_agfl_block(struct xfs_trans *, xfs_agnumber_t, xfs_agblock_t,
215 			struct xfs_buf *, struct xfs_owner_info *);
216 int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
217 int xfs_free_extent_fix_freelist(struct xfs_trans *tp, struct xfs_perag *pag,
218 		struct xfs_buf **agbp);
219 
220 xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
221 
222 typedef int (*xfs_alloc_query_range_fn)(
223 	struct xfs_btree_cur			*cur,
224 	const struct xfs_alloc_rec_incore	*rec,
225 	void					*priv);
226 
227 int xfs_alloc_query_range(struct xfs_btree_cur *cur,
228 		const struct xfs_alloc_rec_incore *low_rec,
229 		const struct xfs_alloc_rec_incore *high_rec,
230 		xfs_alloc_query_range_fn fn, void *priv);
231 int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
232 		void *priv);
233 
234 int xfs_alloc_has_record(struct xfs_btree_cur *cur, xfs_agblock_t bno,
235 		xfs_extlen_t len, bool *exist);
236 
237 typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
238 		void *priv);
239 int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
240 		struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
241 
242 static inline __be32 *
243 xfs_buf_to_agfl_bno(
244 	struct xfs_buf		*bp)
245 {
246 	if (xfs_has_crc(bp->b_mount))
247 		return bp->b_addr + sizeof(struct xfs_agfl);
248 	return bp->b_addr;
249 }
250 
251 void __xfs_free_extent_later(struct xfs_trans *tp, xfs_fsblock_t bno,
252 		xfs_filblks_t len, const struct xfs_owner_info *oinfo,
253 		bool skip_discard);
254 
255 /*
256  * List of extents to be free "later".
257  * The list is kept sorted on xbf_startblock.
258  */
259 struct xfs_extent_free_item {
260 	struct list_head	xefi_list;
261 	uint64_t		xefi_owner;
262 	xfs_fsblock_t		xefi_startblock;/* starting fs block number */
263 	xfs_extlen_t		xefi_blockcount;/* number of blocks in extent */
264 	unsigned int		xefi_flags;
265 };
266 
267 #define XFS_EFI_SKIP_DISCARD	(1U << 0) /* don't issue discard */
268 #define XFS_EFI_ATTR_FORK	(1U << 1) /* freeing attr fork block */
269 #define XFS_EFI_BMBT_BLOCK	(1U << 2) /* freeing bmap btree block */
270 
271 static inline void
272 xfs_free_extent_later(
273 	struct xfs_trans		*tp,
274 	xfs_fsblock_t			bno,
275 	xfs_filblks_t			len,
276 	const struct xfs_owner_info	*oinfo)
277 {
278 	__xfs_free_extent_later(tp, bno, len, oinfo, false);
279 }
280 
281 
282 extern struct kmem_cache	*xfs_extfree_item_cache;
283 
284 int __init xfs_extfree_intent_init_cache(void);
285 void xfs_extfree_intent_destroy_cache(void);
286 
287 #endif	/* __XFS_ALLOC_H__ */
288