fs/xfs/libxfs/xfs_alloc.h

   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  0x00000001  /* use trylock for buffer locking */
  23 #define XFS_ALLOC_FLAG_FREEING  0x00000002  /* indicate caller is freeing extents*/
  24 #define XFS_ALLOC_FLAG_NORMAP   0x00000004  /* don't modify the rmapbt */
  25 #define XFS_ALLOC_FLAG_NOSHRINK 0x00000008  /* don't shrink the freelist */
  26 #define XFS_ALLOC_FLAG_CHECK    0x00000010  /* test only, don't modify args */
  27
  28 /*
  29  * Argument structure for xfs_alloc routines.
  30  * This is turned into a structure to avoid having 20 arguments passed
  31  * down several levels of the stack.
  32  */
  33 typedef struct xfs_alloc_arg {
  34         struct xfs_trans *tp;           /* transaction pointer */
  35         struct xfs_mount *mp;           /* file system mount point */
  36         struct xfs_buf  *agbp;          /* buffer for a.g. freelist header */
  37         struct xfs_perag *pag;          /* per-ag struct for this agno */
  38         xfs_fsblock_t   fsbno;          /* file system block number */
  39         xfs_agnumber_t  agno;           /* allocation group number */
  40         xfs_agblock_t   agbno;          /* allocation group-relative block # */
  41         xfs_extlen_t    minlen;         /* minimum size of extent */
  42         xfs_extlen_t    maxlen;         /* maximum size of extent */
  43         xfs_extlen_t    mod;            /* mod value for extent size */
  44         xfs_extlen_t    prod;           /* prod value for extent size */
  45         xfs_extlen_t    minleft;        /* min blocks must be left after us */
  46         xfs_extlen_t    total;          /* total blocks needed in xaction */
  47         xfs_extlen_t    alignment;      /* align answer to multiple of this */
  48         xfs_extlen_t    minalignslop;   /* slop for minlen+alignment calcs */
  49         xfs_agblock_t   min_agbno;      /* set an agbno range for NEAR allocs */
  50         xfs_agblock_t   max_agbno;      /* ... */
  51         xfs_extlen_t    len;            /* output: actual size of extent */
  52         int             datatype;       /* mask defining data type treatment */
  53         char            wasdel;         /* set if allocation was prev delayed */
  54         char            wasfromfl;      /* set if allocation is from freelist */
  55         struct xfs_owner_info   oinfo;  /* owner of blocks being allocated */
  56         enum xfs_ag_resv_type   resv;   /* block reservation to use */
  57 #ifdef DEBUG
  58         bool            alloc_minlen_only; /* allocate exact minlen extent */
  59 #endif
  60 } xfs_alloc_arg_t;
  61
  62 /*
  63  * Defines for datatype
  64  */
  65 #define XFS_ALLOC_USERDATA              (1 << 0)/* allocation is for user data*/
  66 #define XFS_ALLOC_INITIAL_USER_DATA     (1 << 1)/* special case start of file */
  67 #define XFS_ALLOC_NOBUSY                (1 << 2)/* Busy extents not allowed */
  68
  69 /* freespace limit calculations */
  70 unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
  71 unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
  72
  73 xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
  74                 xfs_extlen_t need, xfs_extlen_t reserved);
  75 unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
  76                 struct xfs_perag *pag);
  77 int xfs_alloc_get_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
  78                 struct xfs_buf *agfbp, xfs_agblock_t *bnop, int  btreeblk);
  79 int xfs_alloc_put_freelist(struct xfs_perag *pag, struct xfs_trans *tp,
  80                 struct xfs_buf *agfbp, struct xfs_buf *agflbp,
  81                 xfs_agblock_t bno, int btreeblk);
  82
  83 /*
  84  * Compute and fill in value of m_alloc_maxlevels.
  85  */
  86 void
  87 xfs_alloc_compute_maxlevels(
  88         struct xfs_mount        *mp);   /* file system mount structure */
  89
  90 /*
  91  * Log the given fields from the agf structure.
  92  */
  93 void
  94 xfs_alloc_log_agf(
  95         struct xfs_trans *tp,   /* transaction pointer */
  96         struct xfs_buf  *bp,    /* buffer for a.g. freelist header */
  97         uint32_t        fields);/* mask of fields to be logged (XFS_AGF_...) */
  98
  99 /*
 100  * Allocate an extent anywhere in the specific AG given. If there is no
 101  * space matching the requirements in that AG, then the allocation will fail.
 102  */
 103 int xfs_alloc_vextent_this_ag(struct xfs_alloc_arg *args, xfs_agnumber_t agno);
 104
 105 /*
 106  * Allocate an extent as close to the target as possible. If there are not
 107  * viable candidates in the AG, then fail the allocation.
 108  */
 109 int xfs_alloc_vextent_near_bno(struct xfs_alloc_arg *args,
 110                 xfs_fsblock_t target);
 111
 112 /*
 113  * Allocate an extent exactly at the target given. If this is not possible
 114  * then the allocation fails.
 115  */
 116 int xfs_alloc_vextent_exact_bno(struct xfs_alloc_arg *args,
 117                 xfs_fsblock_t target);
 118
 119 /*
 120  * Best effort full filesystem allocation scan.
 121  *
 122  * Locality aware allocation will be attempted in the initial AG, but on failure
 123  * non-localised attempts will be made. The AGs are constrained by previous
 124  * allocations in the current transaction. Two passes will be made - the first
 125  * non-blocking, the second blocking.
 126  */
 127 int xfs_alloc_vextent_start_ag(struct xfs_alloc_arg *args,
 128                 xfs_fsblock_t target);
 129
 130 /*
 131  * Iterate from the AG indicated from args->fsbno through to the end of the
 132  * filesystem attempting blocking allocation. This is for use in last
 133  * resort allocation attempts when everything else has failed.
 134  */
 135 int xfs_alloc_vextent_first_ag(struct xfs_alloc_arg *args,
 136                 xfs_fsblock_t target);
 137
 138 /*
 139  * Free an extent.
 140  */
 141 int                             /* error */
 142 __xfs_free_extent(
 143         struct xfs_trans        *tp,    /* transaction pointer */
 144         struct xfs_perag        *pag,
 145         xfs_agblock_t           agbno,
 146         xfs_extlen_t            len,    /* length of extent */
 147         const struct xfs_owner_info     *oinfo, /* extent owner */
 148         enum xfs_ag_resv_type   type,   /* block reservation type */
 149         bool                    skip_discard);
 150
 151 static inline int
 152 xfs_free_extent(
 153         struct xfs_trans        *tp,
 154         struct xfs_perag        *pag,
 155         xfs_agblock_t           agbno,
 156         xfs_extlen_t            len,
 157         const struct xfs_owner_info     *oinfo,
 158         enum xfs_ag_resv_type   type)
 159 {
 160         return __xfs_free_extent(tp, pag, agbno, len, oinfo, type, false);
 161 }
 162
 163 int                             /* error */
 164 xfs_alloc_lookup_le(
 165         struct xfs_btree_cur    *cur,   /* btree cursor */
 166         xfs_agblock_t           bno,    /* starting block of extent */
 167         xfs_extlen_t            len,    /* length of extent */
 168         int                     *stat); /* success/failure */
 169
 170 int                             /* error */
 171 xfs_alloc_lookup_ge(
 172         struct xfs_btree_cur    *cur,   /* btree cursor */
 173         xfs_agblock_t           bno,    /* starting block of extent */
 174         xfs_extlen_t            len,    /* length of extent */
 175         int                     *stat); /* success/failure */
 176
 177 int                                     /* error */
 178 xfs_alloc_get_rec(
 179         struct xfs_btree_cur    *cur,   /* btree cursor */
 180         xfs_agblock_t           *bno,   /* output: starting block of extent */
 181         xfs_extlen_t            *len,   /* output: length of extent */
 182         int                     *stat); /* output: success/failure */
 183
 184 union xfs_btree_rec;
 185 void xfs_alloc_btrec_to_irec(const union xfs_btree_rec *rec,
 186                 struct xfs_alloc_rec_incore *irec);
 187 xfs_failaddr_t xfs_alloc_check_irec(struct xfs_btree_cur *cur,
 188                 const struct xfs_alloc_rec_incore *irec);
 189
 190 int xfs_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
 191                 struct xfs_buf **agfbpp);
 192 int xfs_alloc_read_agf(struct xfs_perag *pag, struct xfs_trans *tp, int flags,
 193                 struct xfs_buf **agfbpp);
 194 int xfs_alloc_read_agfl(struct xfs_perag *pag, struct xfs_trans *tp,
 195                 struct xfs_buf **bpp);
 196 int xfs_free_agfl_block(struct xfs_trans *, xfs_agnumber_t, xfs_agblock_t,
 197                         struct xfs_buf *, struct xfs_owner_info *);
 198 int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int 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                 bool skip_discard);
 236
 237 /*
 238  * List of extents to be free "later".
 239  * The list is kept sorted on xbf_startblock.
 240  */
 241 struct xfs_extent_free_item {
 242         struct list_head        xefi_list;
 243         uint64_t                xefi_owner;
 244         xfs_fsblock_t           xefi_startblock;/* starting fs block number */
 245         xfs_extlen_t            xefi_blockcount;/* number of blocks in extent */
 246         struct xfs_perag        *xefi_pag;
 247         unsigned int            xefi_flags;
 248 };
 249
 250 void xfs_extent_free_get_group(struct xfs_mount *mp,
 251                 struct xfs_extent_free_item *xefi);
 252
 253 #define XFS_EFI_SKIP_DISCARD    (1U << 0) /* don't issue discard */
 254 #define XFS_EFI_ATTR_FORK       (1U << 1) /* freeing attr fork block */
 255 #define XFS_EFI_BMBT_BLOCK      (1U << 2) /* freeing bmap btree block */
 256
 257 static inline int
 258 xfs_free_extent_later(
 259         struct xfs_trans                *tp,
 260         xfs_fsblock_t                   bno,
 261         xfs_filblks_t                   len,
 262         const struct xfs_owner_info     *oinfo)
 263 {
 264         return __xfs_free_extent_later(tp, bno, len, oinfo, false);
 265 }
 266
 267
 268 extern struct kmem_cache        *xfs_extfree_item_cache;
 269
 270 int __init xfs_extfree_intent_init_cache(void);
 271 void xfs_extfree_intent_destroy_cache(void);
 272
 273 #endif  /* __XFS_ALLOC_H__ */