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