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	(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   */
34  typedef 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 */
69  unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
70  unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
71  
72  xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
73  		xfs_extlen_t need, xfs_extlen_t reserved);
74  unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
75  		struct xfs_perag *pag);
76  int xfs_alloc_get_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
77  		struct xfs_buf *agfbp, xfs_agblock_t *bnop, int	 btreeblk);
78  int 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);
81  int xfs_free_ag_extent(struct xfs_trans *tp, struct xfs_buf *agbp,
82  		xfs_agnumber_t agno, xfs_agblock_t bno,
83  		xfs_extlen_t len, const struct xfs_owner_info *oinfo,
84  		enum xfs_ag_resv_type type);
85  
86  /*
87   * Compute and fill in value of m_alloc_maxlevels.
88   */
89  void
90  xfs_alloc_compute_maxlevels(
91  	struct xfs_mount	*mp);	/* file system mount structure */
92  
93  /*
94   * Log the given fields from the agf structure.
95   */
96  void
97  xfs_alloc_log_agf(
98  	struct xfs_trans *tp,	/* transaction pointer */
99  	struct xfs_buf	*bp,	/* buffer for a.g. freelist header */
100  	uint32_t	fields);/* mask of fields to be logged (XFS_AGF_...) */
101  
102  /*
103   * Allocate an extent anywhere in the specific AG given. If there is no
104   * space matching the requirements in that AG, then the allocation will fail.
105   */
106  int xfs_alloc_vextent_this_ag(struct xfs_alloc_arg *args, xfs_agnumber_t agno);
107  
108  /*
109   * Allocate an extent as close to the target as possible. If there are not
110   * viable candidates in the AG, then fail the allocation.
111   */
112  int xfs_alloc_vextent_near_bno(struct xfs_alloc_arg *args,
113  		xfs_fsblock_t target);
114  
115  /*
116   * Allocate an extent exactly at the target given. If this is not possible
117   * then the allocation fails.
118   */
119  int xfs_alloc_vextent_exact_bno(struct xfs_alloc_arg *args,
120  		xfs_fsblock_t target);
121  
122  /*
123   * Best effort full filesystem allocation scan.
124   *
125   * Locality aware allocation will be attempted in the initial AG, but on failure
126   * non-localised attempts will be made. The AGs are constrained by previous
127   * allocations in the current transaction. Two passes will be made - the first
128   * non-blocking, the second blocking.
129   */
130  int xfs_alloc_vextent_start_ag(struct xfs_alloc_arg *args,
131  		xfs_fsblock_t target);
132  
133  /*
134   * Iterate from the AG indicated from args->fsbno through to the end of the
135   * filesystem attempting blocking allocation. This is for use in last
136   * resort allocation attempts when everything else has failed.
137   */
138  int xfs_alloc_vextent_first_ag(struct xfs_alloc_arg *args,
139  		xfs_fsblock_t target);
140  
141  /*
142   * Free an extent.
143   */
144  int				/* error */
145  __xfs_free_extent(
146  	struct xfs_trans	*tp,	/* transaction pointer */
147  	struct xfs_perag	*pag,
148  	xfs_agblock_t		agbno,
149  	xfs_extlen_t		len,	/* length of extent */
150  	const struct xfs_owner_info	*oinfo,	/* extent owner */
151  	enum xfs_ag_resv_type	type,	/* block reservation type */
152  	bool			skip_discard);
153  
154  static inline int
xfs_free_extent(struct xfs_trans * tp,struct xfs_perag * pag,xfs_agblock_t agbno,xfs_extlen_t len,const struct xfs_owner_info * oinfo,enum xfs_ag_resv_type type)155  xfs_free_extent(
156  	struct xfs_trans	*tp,
157  	struct xfs_perag	*pag,
158  	xfs_agblock_t		agbno,
159  	xfs_extlen_t		len,
160  	const struct xfs_owner_info	*oinfo,
161  	enum xfs_ag_resv_type	type)
162  {
163  	return __xfs_free_extent(tp, pag, agbno, len, oinfo, type, false);
164  }
165  
166  int				/* error */
167  xfs_alloc_lookup_le(
168  	struct xfs_btree_cur	*cur,	/* btree cursor */
169  	xfs_agblock_t		bno,	/* starting block of extent */
170  	xfs_extlen_t		len,	/* length of extent */
171  	int			*stat);	/* success/failure */
172  
173  int				/* error */
174  xfs_alloc_lookup_ge(
175  	struct xfs_btree_cur	*cur,	/* btree cursor */
176  	xfs_agblock_t		bno,	/* starting block of extent */
177  	xfs_extlen_t		len,	/* length of extent */
178  	int			*stat);	/* success/failure */
179  
180  int					/* error */
181  xfs_alloc_get_rec(
182  	struct xfs_btree_cur	*cur,	/* btree cursor */
183  	xfs_agblock_t		*bno,	/* output: starting block of extent */
184  	xfs_extlen_t		*len,	/* output: length of extent */
185  	int			*stat);	/* output: success/failure */
186  
187  union xfs_btree_rec;
188  void xfs_alloc_btrec_to_irec(const union xfs_btree_rec *rec,
189  		struct xfs_alloc_rec_incore *irec);
190  xfs_failaddr_t xfs_alloc_check_irec(struct xfs_perag *pag,
191  		const struct xfs_alloc_rec_incore *irec);
192  
193  int xfs_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
194  		struct xfs_buf **agfbpp);
195  int xfs_alloc_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
196  		struct xfs_buf **agfbpp);
197  int xfs_alloc_read_agfl(struct xfs_perag *pag, struct xfs_trans *tp,
198  		struct xfs_buf **bpp);
199  int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, uint32_t alloc_flags);
200  int xfs_free_extent_fix_freelist(struct xfs_trans *tp, struct xfs_perag *pag,
201  		struct xfs_buf **agbp);
202  
203  xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
204  
205  typedef int (*xfs_alloc_query_range_fn)(
206  	struct xfs_btree_cur			*cur,
207  	const struct xfs_alloc_rec_incore	*rec,
208  	void					*priv);
209  
210  int xfs_alloc_query_range(struct xfs_btree_cur *cur,
211  		const struct xfs_alloc_rec_incore *low_rec,
212  		const struct xfs_alloc_rec_incore *high_rec,
213  		xfs_alloc_query_range_fn fn, void *priv);
214  int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
215  		void *priv);
216  
217  int xfs_alloc_has_records(struct xfs_btree_cur *cur, xfs_agblock_t bno,
218  		xfs_extlen_t len, enum xbtree_recpacking *outcome);
219  
220  typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
221  		void *priv);
222  int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
223  		struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
224  
225  static inline __be32 *
xfs_buf_to_agfl_bno(struct xfs_buf * bp)226  xfs_buf_to_agfl_bno(
227  	struct xfs_buf		*bp)
228  {
229  	if (xfs_has_crc(bp->b_mount))
230  		return bp->b_addr + sizeof(struct xfs_agfl);
231  	return bp->b_addr;
232  }
233  
234  int xfs_free_extent_later(struct xfs_trans *tp, xfs_fsblock_t bno,
235  		xfs_filblks_t len, const struct xfs_owner_info *oinfo,
236  		enum xfs_ag_resv_type type, unsigned int free_flags);
237  
238  /* Don't issue a discard for the blocks freed. */
239  #define XFS_FREE_EXTENT_SKIP_DISCARD	(1U << 0)
240  
241  #define XFS_FREE_EXTENT_ALL_FLAGS	(XFS_FREE_EXTENT_SKIP_DISCARD)
242  
243  /*
244   * List of extents to be free "later".
245   * The list is kept sorted on xbf_startblock.
246   */
247  struct xfs_extent_free_item {
248  	struct list_head	xefi_list;
249  	uint64_t		xefi_owner;
250  	xfs_fsblock_t		xefi_startblock;/* starting fs block number */
251  	xfs_extlen_t		xefi_blockcount;/* number of blocks in extent */
252  	struct xfs_perag	*xefi_pag;
253  	unsigned int		xefi_flags;
254  	enum xfs_ag_resv_type	xefi_agresv;
255  };
256  
257  #define XFS_EFI_SKIP_DISCARD	(1U << 0) /* don't issue discard */
258  #define XFS_EFI_ATTR_FORK	(1U << 1) /* freeing attr fork block */
259  #define XFS_EFI_BMBT_BLOCK	(1U << 2) /* freeing bmap btree block */
260  #define XFS_EFI_CANCELLED	(1U << 3) /* dont actually free the space */
261  
262  struct xfs_alloc_autoreap {
263  	struct xfs_defer_pending	*dfp;
264  };
265  
266  int xfs_alloc_schedule_autoreap(const struct xfs_alloc_arg *args,
267  		unsigned int free_flags, struct xfs_alloc_autoreap *aarp);
268  void xfs_alloc_cancel_autoreap(struct xfs_trans *tp,
269  		struct xfs_alloc_autoreap *aarp);
270  void xfs_alloc_commit_autoreap(struct xfs_trans *tp,
271  		struct xfs_alloc_autoreap *aarp);
272  
273  extern struct kmem_cache	*xfs_extfree_item_cache;
274  
275  int __init xfs_extfree_intent_init_cache(void);
276  void xfs_extfree_intent_destroy_cache(void);
277  
278  xfs_failaddr_t xfs_validate_ag_length(struct xfs_buf *bp, uint32_t seqno,
279  		uint32_t length);
280  
281  #endif	/* __XFS_ALLOC_H__ */
282