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 unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
92 unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
93 
94 xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
95 		xfs_extlen_t need, xfs_extlen_t reserved);
96 unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
97 		struct xfs_perag *pag);
98 int xfs_alloc_get_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
99 		struct xfs_buf *agfbp, xfs_agblock_t *bnop, int	 btreeblk);
100 int xfs_alloc_put_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
101 		struct xfs_buf *agfbp, struct xfs_buf *agflbp,
102 		xfs_agblock_t bno, int btreeblk);
103 
104 /*
105  * Compute and fill in value of m_alloc_maxlevels.
106  */
107 void
108 xfs_alloc_compute_maxlevels(
109 	struct xfs_mount	*mp);	/* file system mount structure */
110 
111 /*
112  * Log the given fields from the agf structure.
113  */
114 void
115 xfs_alloc_log_agf(
116 	struct xfs_trans *tp,	/* transaction pointer */
117 	struct xfs_buf	*bp,	/* buffer for a.g. freelist header */
118 	uint32_t	fields);/* mask of fields to be logged (XFS_AGF_...) */
119 
120 /*
121  * Allocate an extent (variable-size).
122  */
123 int				/* error */
124 xfs_alloc_vextent(
125 	xfs_alloc_arg_t	*args);	/* allocation argument structure */
126 
127 /*
128  * Free an extent.
129  */
130 int				/* error */
131 __xfs_free_extent(
132 	struct xfs_trans	*tp,	/* transaction pointer */
133 	xfs_fsblock_t		bno,	/* starting block number of extent */
134 	xfs_extlen_t		len,	/* length of extent */
135 	const struct xfs_owner_info	*oinfo,	/* extent owner */
136 	enum xfs_ag_resv_type	type,	/* block reservation type */
137 	bool			skip_discard);
138 
139 static inline int
xfs_free_extent(struct xfs_trans * tp,xfs_fsblock_t bno,xfs_extlen_t len,const struct xfs_owner_info * oinfo,enum xfs_ag_resv_type type)140 xfs_free_extent(
141 	struct xfs_trans	*tp,
142 	xfs_fsblock_t		bno,
143 	xfs_extlen_t		len,
144 	const struct xfs_owner_info	*oinfo,
145 	enum xfs_ag_resv_type	type)
146 {
147 	return __xfs_free_extent(tp, bno, len, oinfo, type, false);
148 }
149 
150 int				/* error */
151 xfs_alloc_lookup_le(
152 	struct xfs_btree_cur	*cur,	/* btree cursor */
153 	xfs_agblock_t		bno,	/* starting block of extent */
154 	xfs_extlen_t		len,	/* length of extent */
155 	int			*stat);	/* success/failure */
156 
157 int				/* error */
158 xfs_alloc_lookup_ge(
159 	struct xfs_btree_cur	*cur,	/* btree cursor */
160 	xfs_agblock_t		bno,	/* starting block of extent */
161 	xfs_extlen_t		len,	/* length of extent */
162 	int			*stat);	/* success/failure */
163 
164 int					/* error */
165 xfs_alloc_get_rec(
166 	struct xfs_btree_cur	*cur,	/* btree cursor */
167 	xfs_agblock_t		*bno,	/* output: starting block of extent */
168 	xfs_extlen_t		*len,	/* output: length of extent */
169 	int			*stat);	/* output: success/failure */
170 
171 int xfs_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
172 		struct xfs_buf **agfbpp);
173 int xfs_alloc_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
174 		struct xfs_buf **agfbpp);
175 int xfs_alloc_read_agfl(struct xfs_perag *pag, struct xfs_trans *tp,
176 		struct xfs_buf **bpp);
177 int xfs_free_agfl_block(struct xfs_trans *, xfs_agnumber_t, xfs_agblock_t,
178 			struct xfs_buf *, struct xfs_owner_info *);
179 int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
180 int xfs_free_extent_fix_freelist(struct xfs_trans *tp, struct xfs_perag *pag,
181 		struct xfs_buf **agbp);
182 
183 xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
184 
185 typedef int (*xfs_alloc_query_range_fn)(
186 	struct xfs_btree_cur			*cur,
187 	const struct xfs_alloc_rec_incore	*rec,
188 	void					*priv);
189 
190 int xfs_alloc_query_range(struct xfs_btree_cur *cur,
191 		const struct xfs_alloc_rec_incore *low_rec,
192 		const struct xfs_alloc_rec_incore *high_rec,
193 		xfs_alloc_query_range_fn fn, void *priv);
194 int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
195 		void *priv);
196 
197 int xfs_alloc_has_record(struct xfs_btree_cur *cur, xfs_agblock_t bno,
198 		xfs_extlen_t len, bool *exist);
199 
200 typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
201 		void *priv);
202 int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
203 		struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
204 
205 static inline __be32 *
xfs_buf_to_agfl_bno(struct xfs_buf * bp)206 xfs_buf_to_agfl_bno(
207 	struct xfs_buf		*bp)
208 {
209 	if (xfs_has_crc(bp->b_mount))
210 		return bp->b_addr + sizeof(struct xfs_agfl);
211 	return bp->b_addr;
212 }
213 
214 void __xfs_free_extent_later(struct xfs_trans *tp, xfs_fsblock_t bno,
215 		xfs_filblks_t len, const struct xfs_owner_info *oinfo,
216 		bool skip_discard);
217 
218 /*
219  * List of extents to be free "later".
220  * The list is kept sorted on xbf_startblock.
221  */
222 struct xfs_extent_free_item {
223 	struct list_head	xefi_list;
224 	uint64_t		xefi_owner;
225 	xfs_fsblock_t		xefi_startblock;/* starting fs block number */
226 	xfs_extlen_t		xefi_blockcount;/* number of blocks in extent */
227 	unsigned int		xefi_flags;
228 };
229 
230 #define XFS_EFI_SKIP_DISCARD	(1U << 0) /* don't issue discard */
231 #define XFS_EFI_ATTR_FORK	(1U << 1) /* freeing attr fork block */
232 #define XFS_EFI_BMBT_BLOCK	(1U << 2) /* freeing bmap btree block */
233 
234 static inline void
xfs_free_extent_later(struct xfs_trans * tp,xfs_fsblock_t bno,xfs_filblks_t len,const struct xfs_owner_info * oinfo)235 xfs_free_extent_later(
236 	struct xfs_trans		*tp,
237 	xfs_fsblock_t			bno,
238 	xfs_filblks_t			len,
239 	const struct xfs_owner_info	*oinfo)
240 {
241 	__xfs_free_extent_later(tp, bno, len, oinfo, false);
242 }
243 
244 
245 extern struct kmem_cache	*xfs_extfree_item_cache;
246 
247 int __init xfs_extfree_intent_init_cache(void);
248 void xfs_extfree_intent_destroy_cache(void);
249 
250 #endif	/* __XFS_ALLOC_H__ */
251