xref: /openbmc/linux/fs/xfs/libxfs/xfs_alloc.h (revision 4bb1e4e7)
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 } xfs_alloc_arg_t;
79 
80 /*
81  * Defines for datatype
82  */
83 #define XFS_ALLOC_USERDATA		(1 << 0)/* allocation is for user data*/
84 #define XFS_ALLOC_INITIAL_USER_DATA	(1 << 1)/* special case start of file */
85 #define XFS_ALLOC_NOBUSY		(1 << 2)/* Busy extents not allowed */
86 
87 /* freespace limit calculations */
88 #define XFS_ALLOC_AGFL_RESERVE	4
89 unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
90 unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
91 
92 xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
93 		xfs_extlen_t need, xfs_extlen_t reserved);
94 unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
95 		struct xfs_perag *pag);
96 
97 /*
98  * Compute and fill in value of m_ag_maxlevels.
99  */
100 void
101 xfs_alloc_compute_maxlevels(
102 	struct xfs_mount	*mp);	/* file system mount structure */
103 
104 /*
105  * Get a block from the freelist.
106  * Returns with the buffer for the block gotten.
107  */
108 int				/* error */
109 xfs_alloc_get_freelist(
110 	struct xfs_trans *tp,	/* transaction pointer */
111 	struct xfs_buf	*agbp,	/* buffer containing the agf structure */
112 	xfs_agblock_t	*bnop,	/* block address retrieved from freelist */
113 	int		btreeblk); /* destination is a AGF btree */
114 
115 /*
116  * Log the given fields from the agf structure.
117  */
118 void
119 xfs_alloc_log_agf(
120 	struct xfs_trans *tp,	/* transaction pointer */
121 	struct xfs_buf	*bp,	/* buffer for a.g. freelist header */
122 	int		fields);/* mask of fields to be logged (XFS_AGF_...) */
123 
124 /*
125  * Interface for inode allocation to force the pag data to be initialized.
126  */
127 int				/* error */
128 xfs_alloc_pagf_init(
129 	struct xfs_mount *mp,	/* file system mount structure */
130 	struct xfs_trans *tp,	/* transaction pointer */
131 	xfs_agnumber_t	agno,	/* allocation group number */
132 	int		flags);	/* XFS_ALLOC_FLAGS_... */
133 
134 /*
135  * Put the block on the freelist for the allocation group.
136  */
137 int				/* error */
138 xfs_alloc_put_freelist(
139 	struct xfs_trans *tp,	/* transaction pointer */
140 	struct xfs_buf	*agbp,	/* buffer for a.g. freelist header */
141 	struct xfs_buf	*agflbp,/* buffer for a.g. free block array */
142 	xfs_agblock_t	bno,	/* block being freed */
143 	int		btreeblk); /* owner was a AGF btree */
144 
145 /*
146  * Read in the allocation group header (free/alloc section).
147  */
148 int					/* error  */
149 xfs_alloc_read_agf(
150 	struct xfs_mount *mp,		/* mount point structure */
151 	struct xfs_trans *tp,		/* transaction pointer */
152 	xfs_agnumber_t	agno,		/* allocation group number */
153 	int		flags,		/* XFS_ALLOC_FLAG_... */
154 	struct xfs_buf	**bpp);		/* buffer for the ag freelist header */
155 
156 /*
157  * Allocate an extent (variable-size).
158  */
159 int				/* error */
160 xfs_alloc_vextent(
161 	xfs_alloc_arg_t	*args);	/* allocation argument structure */
162 
163 /*
164  * Free an extent.
165  */
166 int				/* error */
167 __xfs_free_extent(
168 	struct xfs_trans	*tp,	/* transaction pointer */
169 	xfs_fsblock_t		bno,	/* starting block number of extent */
170 	xfs_extlen_t		len,	/* length of extent */
171 	const struct xfs_owner_info	*oinfo,	/* extent owner */
172 	enum xfs_ag_resv_type	type,	/* block reservation type */
173 	bool			skip_discard);
174 
175 static inline int
176 xfs_free_extent(
177 	struct xfs_trans	*tp,
178 	xfs_fsblock_t		bno,
179 	xfs_extlen_t		len,
180 	const struct xfs_owner_info	*oinfo,
181 	enum xfs_ag_resv_type	type)
182 {
183 	return __xfs_free_extent(tp, bno, len, oinfo, type, false);
184 }
185 
186 int				/* error */
187 xfs_alloc_lookup_le(
188 	struct xfs_btree_cur	*cur,	/* btree cursor */
189 	xfs_agblock_t		bno,	/* starting block of extent */
190 	xfs_extlen_t		len,	/* length of extent */
191 	int			*stat);	/* success/failure */
192 
193 int				/* error */
194 xfs_alloc_lookup_ge(
195 	struct xfs_btree_cur	*cur,	/* btree cursor */
196 	xfs_agblock_t		bno,	/* starting block of extent */
197 	xfs_extlen_t		len,	/* length of extent */
198 	int			*stat);	/* success/failure */
199 
200 int					/* error */
201 xfs_alloc_get_rec(
202 	struct xfs_btree_cur	*cur,	/* btree cursor */
203 	xfs_agblock_t		*bno,	/* output: starting block of extent */
204 	xfs_extlen_t		*len,	/* output: length of extent */
205 	int			*stat);	/* output: success/failure */
206 
207 int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
208 			xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
209 int xfs_alloc_read_agfl(struct xfs_mount *mp, struct xfs_trans *tp,
210 			xfs_agnumber_t agno, struct xfs_buf **bpp);
211 int xfs_free_agfl_block(struct xfs_trans *, xfs_agnumber_t, xfs_agblock_t,
212 			struct xfs_buf *, struct xfs_owner_info *);
213 int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
214 int xfs_free_extent_fix_freelist(struct xfs_trans *tp, xfs_agnumber_t agno,
215 		struct xfs_buf **agbp);
216 
217 xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
218 
219 typedef int (*xfs_alloc_query_range_fn)(
220 	struct xfs_btree_cur		*cur,
221 	struct xfs_alloc_rec_incore	*rec,
222 	void				*priv);
223 
224 int xfs_alloc_query_range(struct xfs_btree_cur *cur,
225 		struct xfs_alloc_rec_incore *low_rec,
226 		struct xfs_alloc_rec_incore *high_rec,
227 		xfs_alloc_query_range_fn fn, void *priv);
228 int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
229 		void *priv);
230 
231 int xfs_alloc_has_record(struct xfs_btree_cur *cur, xfs_agblock_t bno,
232 		xfs_extlen_t len, bool *exist);
233 
234 typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
235 		void *priv);
236 int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
237 		struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
238 
239 #endif	/* __XFS_ALLOC_H__ */
240