LXR linux/fs/xfs/libxfs/xfs

   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
   9struct xfs_buf;
  10struct xfs_btree_cur;
  11struct xfs_mount;
  12struct xfs_perag;
  13struct xfs_trans;
  14
  15extern struct workqueue_struct *xfs_alloc_wq;
  16
  17unsigned 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 */
  29typedef 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 */
  52typedef 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        struct xfs_inode *ip;           /* for userdata zeroing method */
  58        xfs_fsblock_t   fsbno;          /* file system block number */
  59        xfs_agnumber_t  agno;           /* allocation group number */
  60        xfs_agblock_t   agbno;          /* allocation group-relative block # */
  61        xfs_extlen_t    minlen;         /* minimum size of extent */
  62        xfs_extlen_t    maxlen;         /* maximum size of extent */
  63        xfs_extlen_t    mod;            /* mod value for extent size */
  64        xfs_extlen_t    prod;           /* prod value for extent size */
  65        xfs_extlen_t    minleft;        /* min blocks must be left after us */
  66        xfs_extlen_t    total;          /* total blocks needed in xaction */
  67        xfs_extlen_t    alignment;      /* align answer to multiple of this */
  68        xfs_extlen_t    minalignslop;   /* slop for minlen+alignment calcs */
  69        xfs_agblock_t   min_agbno;      /* set an agbno range for NEAR allocs */
  70        xfs_agblock_t   max_agbno;      /* ... */
  71        xfs_extlen_t    len;            /* output: actual size of extent */
  72        xfs_alloctype_t type;           /* allocation type XFS_ALLOCTYPE_... */
  73        xfs_alloctype_t otype;          /* original allocation type */
  74        int             datatype;       /* mask defining data type treatment */
  75        char            wasdel;         /* set if allocation was prev delayed */
  76        char            wasfromfl;      /* set if allocation is from freelist */
  77        struct xfs_owner_info   oinfo;  /* owner of blocks being allocated */
  78        enum xfs_ag_resv_type   resv;   /* block reservation to use */
  79} xfs_alloc_arg_t;
  80
  81/*
  82 * Defines for datatype
  83 */
  84#define XFS_ALLOC_USERDATA              (1 << 0)/* allocation is for user data*/
  85#define XFS_ALLOC_INITIAL_USER_DATA     (1 << 1)/* special case start of file */
  86#define XFS_ALLOC_USERDATA_ZERO         (1 << 2)/* zero extent on allocation */
  87#define XFS_ALLOC_NOBUSY                (1 << 3)/* Busy extents not allowed */
  88
  89static inline bool
  90xfs_alloc_is_userdata(int datatype)
  91{
  92        return (datatype & ~XFS_ALLOC_NOBUSY) != 0;
  93}
  94
  95static inline bool
  96xfs_alloc_allow_busy_reuse(int datatype)
  97{
  98        return (datatype & XFS_ALLOC_NOBUSY) == 0;
  99}
 100
 101/* freespace limit calculations */
 102#define XFS_ALLOC_AGFL_RESERVE  4
 103unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
 104unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
 105
 106xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_perag *pag,
 107                xfs_extlen_t need, xfs_extlen_t reserved);
 108unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
 109                struct xfs_perag *pag);
 110
 111/*
 112 * Compute and fill in value of m_ag_maxlevels.
 113 */
 114void
 115xfs_alloc_compute_maxlevels(
 116        struct xfs_mount        *mp);   /* file system mount structure */
 117
 118/*
 119 * Get a block from the freelist.
 120 * Returns with the buffer for the block gotten.
 121 */
 122int                             /* error */
 123xfs_alloc_get_freelist(
 124        struct xfs_trans *tp,   /* transaction pointer */
 125        struct xfs_buf  *agbp,  /* buffer containing the agf structure */
 126        xfs_agblock_t   *bnop,  /* block address retrieved from freelist */
 127        int             btreeblk); /* destination is a AGF btree */
 128
 129/*
 130 * Log the given fields from the agf structure.
 131 */
 132void
 133xfs_alloc_log_agf(
 134        struct xfs_trans *tp,   /* transaction pointer */
 135        struct xfs_buf  *bp,    /* buffer for a.g. freelist header */
 136        int             fields);/* mask of fields to be logged (XFS_AGF_...) */
 137
 138/*
 139 * Interface for inode allocation to force the pag data to be initialized.
 140 */
 141int                             /* error */
 142xfs_alloc_pagf_init(
 143        struct xfs_mount *mp,   /* file system mount structure */
 144        struct xfs_trans *tp,   /* transaction pointer */
 145        xfs_agnumber_t  agno,   /* allocation group number */
 146        int             flags); /* XFS_ALLOC_FLAGS_... */
 147
 148/*
 149 * Put the block on the freelist for the allocation group.
 150 */
 151int                             /* error */
 152xfs_alloc_put_freelist(
 153        struct xfs_trans *tp,   /* transaction pointer */
 154        struct xfs_buf  *agbp,  /* buffer for a.g. freelist header */
 155        struct xfs_buf  *agflbp,/* buffer for a.g. free block array */
 156        xfs_agblock_t   bno,    /* block being freed */
 157        int             btreeblk); /* owner was a AGF btree */
 158
 159/*
 160 * Read in the allocation group header (free/alloc section).
 161 */
 162int                                     /* error  */
 163xfs_alloc_read_agf(
 164        struct xfs_mount *mp,           /* mount point structure */
 165        struct xfs_trans *tp,           /* transaction pointer */
 166        xfs_agnumber_t  agno,           /* allocation group number */
 167        int             flags,          /* XFS_ALLOC_FLAG_... */
 168        struct xfs_buf  **bpp);         /* buffer for the ag freelist header */
 169
 170/*
 171 * Allocate an extent (variable-size).
 172 */
 173int                             /* error */
 174xfs_alloc_vextent(
 175        xfs_alloc_arg_t *args); /* allocation argument structure */
 176
 177/*
 178 * Free an extent.
 179 */
 180int                             /* error */
 181__xfs_free_extent(
 182        struct xfs_trans        *tp,    /* transaction pointer */
 183        xfs_fsblock_t           bno,    /* starting block number of extent */
 184        xfs_extlen_t            len,    /* length of extent */
 185        struct xfs_owner_info   *oinfo, /* extent owner */
 186        enum xfs_ag_resv_type   type,   /* block reservation type */
 187        bool                    skip_discard);
 188
 189static inline int
 190xfs_free_extent(
 191        struct xfs_trans        *tp,
 192        xfs_fsblock_t           bno,
 193        xfs_extlen_t            len,
 194        struct xfs_owner_info   *oinfo,
 195        enum xfs_ag_resv_type   type)
 196{
 197        return __xfs_free_extent(tp, bno, len, oinfo, type, false);
 198}
 199
 200int                             /* error */
 201xfs_alloc_lookup_le(
 202        struct xfs_btree_cur    *cur,   /* btree cursor */
 203        xfs_agblock_t           bno,    /* starting block of extent */
 204        xfs_extlen_t            len,    /* length of extent */
 205        int                     *stat); /* success/failure */
 206
 207int                             /* error */
 208xfs_alloc_lookup_ge(
 209        struct xfs_btree_cur    *cur,   /* btree cursor */
 210        xfs_agblock_t           bno,    /* starting block of extent */
 211        xfs_extlen_t            len,    /* length of extent */
 212        int                     *stat); /* success/failure */
 213
 214int                                     /* error */
 215xfs_alloc_get_rec(
 216        struct xfs_btree_cur    *cur,   /* btree cursor */
 217        xfs_agblock_t           *bno,   /* output: starting block of extent */
 218        xfs_extlen_t            *len,   /* output: length of extent */
 219        int                     *stat); /* output: success/failure */
 220
 221int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
 222                        xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
 223int xfs_alloc_read_agfl(struct xfs_mount *mp, struct xfs_trans *tp,
 224                        xfs_agnumber_t agno, struct xfs_buf **bpp);
 225int xfs_free_agfl_block(struct xfs_trans *, xfs_agnumber_t, xfs_agblock_t,
 226                        struct xfs_buf *, struct xfs_owner_info *);
 227int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
 228int xfs_free_extent_fix_freelist(struct xfs_trans *tp, xfs_agnumber_t agno,
 229                struct xfs_buf **agbp);
 230
 231xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
 232
 233typedef int (*xfs_alloc_query_range_fn)(
 234        struct xfs_btree_cur            *cur,
 235        struct xfs_alloc_rec_incore     *rec,
 236        void                            *priv);
 237
 238int xfs_alloc_query_range(struct xfs_btree_cur *cur,
 239                struct xfs_alloc_rec_incore *low_rec,
 240                struct xfs_alloc_rec_incore *high_rec,
 241                xfs_alloc_query_range_fn fn, void *priv);
 242int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
 243                void *priv);
 244
 245int xfs_alloc_has_record(struct xfs_btree_cur *cur, xfs_agblock_t bno,
 246                xfs_extlen_t len, bool *exist);
 247
 248typedef int (*xfs_agfl_walk_fn)(struct xfs_mount *mp, xfs_agblock_t bno,
 249                void *priv);
 250int xfs_agfl_walk(struct xfs_mount *mp, struct xfs_agf *agf,
 251                struct xfs_buf *agflbp, xfs_agfl_walk_fn walk_fn, void *priv);
 252
 253#endif  /* __XFS_ALLOC_H__ */
 254