fs/xfs/libxfs/xfs_bmap.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2000-2006 Silicon Graphics, Inc.
   4  * All Rights Reserved.
   5  */
   6 #ifndef __XFS_BMAP_H__
   7 #define __XFS_BMAP_H__
   8
   9 struct getbmap;
  10 struct xfs_bmbt_irec;
  11 struct xfs_ifork;
  12 struct xfs_inode;
  13 struct xfs_mount;
  14 struct xfs_trans;
  15
  16 extern kmem_zone_t      *xfs_bmap_free_item_zone;
  17
  18 /*
  19  * Argument structure for xfs_bmap_alloc.
  20  */
  21 struct xfs_bmalloca {
  22         xfs_fsblock_t           *firstblock; /* i/o first block allocated */
  23         struct xfs_defer_ops    *dfops; /* bmap freelist */
  24         struct xfs_trans        *tp;    /* transaction pointer */
  25         struct xfs_inode        *ip;    /* incore inode pointer */
  26         struct xfs_bmbt_irec    prev;   /* extent before the new one */
  27         struct xfs_bmbt_irec    got;    /* extent after, or delayed */
  28
  29         xfs_fileoff_t           offset; /* offset in file filling in */
  30         xfs_extlen_t            length; /* i/o length asked/allocated */
  31         xfs_fsblock_t           blkno;  /* starting block of new extent */
  32
  33         struct xfs_btree_cur    *cur;   /* btree cursor */
  34         struct xfs_iext_cursor  icur;   /* incore extent cursor */
  35         int                     nallocs;/* number of extents alloc'd */
  36         int                     logflags;/* flags for transaction logging */
  37
  38         xfs_extlen_t            total;  /* total blocks needed for xaction */
  39         xfs_extlen_t            minlen; /* minimum allocation size (blocks) */
  40         xfs_extlen_t            minleft; /* amount must be left after alloc */
  41         bool                    eof;    /* set if allocating past last extent */
  42         bool                    wasdel; /* replacing a delayed allocation */
  43         bool                    aeof;   /* allocated space at eof */
  44         bool                    conv;   /* overwriting unwritten extents */
  45         int                     datatype;/* data type being allocated */
  46         int                     flags;
  47 };
  48
  49 /*
  50  * List of extents to be free "later".
  51  * The list is kept sorted on xbf_startblock.
  52  */
  53 struct xfs_extent_free_item
  54 {
  55         xfs_fsblock_t           xefi_startblock;/* starting fs block number */
  56         xfs_extlen_t            xefi_blockcount;/* number of blocks in extent */
  57         struct list_head        xefi_list;
  58         struct xfs_owner_info   xefi_oinfo;     /* extent owner */
  59         bool                    xefi_skip_discard;
  60 };
  61
  62 #define XFS_BMAP_MAX_NMAP       4
  63
  64 /*
  65  * Flags for xfs_bmapi_*
  66  */
  67 #define XFS_BMAPI_ENTIRE        0x001   /* return entire extent, not trimmed */
  68 #define XFS_BMAPI_METADATA      0x002   /* mapping metadata not user data */
  69 #define XFS_BMAPI_ATTRFORK      0x004   /* use attribute fork not data */
  70 #define XFS_BMAPI_PREALLOC      0x008   /* preallocation op: unwritten space */
  71 #define XFS_BMAPI_IGSTATE       0x010   /* Ignore state - */
  72                                         /* combine contig. space */
  73 #define XFS_BMAPI_CONTIG        0x020   /* must allocate only one extent */
  74 /*
  75  * unwritten extent conversion - this needs write cache flushing and no additional
  76  * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
  77  * from written to unwritten, otherwise convert from unwritten to written.
  78  */
  79 #define XFS_BMAPI_CONVERT       0x040
  80
  81 /*
  82  * allocate zeroed extents - this requires all newly allocated user data extents
  83  * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
  84  * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
  85  * during the allocation range to zeroed written extents.
  86  */
  87 #define XFS_BMAPI_ZERO          0x080
  88
  89 /*
  90  * Map the inode offset to the block given in ap->firstblock.  Primarily
  91  * used for reflink.  The range must be in a hole, and this flag cannot be
  92  * turned on with PREALLOC or CONVERT, and cannot be used on the attr fork.
  93  *
  94  * For bunmapi, this flag unmaps the range without adjusting quota, reducing
  95  * refcount, or freeing the blocks.
  96  */
  97 #define XFS_BMAPI_REMAP         0x100
  98
  99 /* Map something in the CoW fork. */
 100 #define XFS_BMAPI_COWFORK       0x200
 101
 102 /* Only convert delalloc space, don't allocate entirely new extents */
 103 #define XFS_BMAPI_DELALLOC      0x400
 104
 105 /* Only convert unwritten extents, don't allocate new blocks */
 106 #define XFS_BMAPI_CONVERT_ONLY  0x800
 107
 108 /* Skip online discard of freed extents */
 109 #define XFS_BMAPI_NODISCARD     0x1000
 110
 111 /* Do not update the rmap btree.  Used for reconstructing bmbt from rmapbt. */
 112 #define XFS_BMAPI_NORMAP        0x2000
 113
 114 #define XFS_BMAPI_FLAGS \
 115         { XFS_BMAPI_ENTIRE,     "ENTIRE" }, \
 116         { XFS_BMAPI_METADATA,   "METADATA" }, \
 117         { XFS_BMAPI_ATTRFORK,   "ATTRFORK" }, \
 118         { XFS_BMAPI_PREALLOC,   "PREALLOC" }, \
 119         { XFS_BMAPI_IGSTATE,    "IGSTATE" }, \
 120         { XFS_BMAPI_CONTIG,     "CONTIG" }, \
 121         { XFS_BMAPI_CONVERT,    "CONVERT" }, \
 122         { XFS_BMAPI_ZERO,       "ZERO" }, \
 123         { XFS_BMAPI_REMAP,      "REMAP" }, \
 124         { XFS_BMAPI_COWFORK,    "COWFORK" }, \
 125         { XFS_BMAPI_DELALLOC,   "DELALLOC" }, \
 126         { XFS_BMAPI_CONVERT_ONLY, "CONVERT_ONLY" }, \
 127         { XFS_BMAPI_NODISCARD,  "NODISCARD" }, \
 128         { XFS_BMAPI_NORMAP,     "NORMAP" }
 129
 130
 131 static inline int xfs_bmapi_aflag(int w)
 132 {
 133         return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK :
 134                (w == XFS_COW_FORK ? XFS_BMAPI_COWFORK : 0));
 135 }
 136
 137 static inline int xfs_bmapi_whichfork(int bmapi_flags)
 138 {
 139         if (bmapi_flags & XFS_BMAPI_COWFORK)
 140                 return XFS_COW_FORK;
 141         else if (bmapi_flags & XFS_BMAPI_ATTRFORK)
 142                 return XFS_ATTR_FORK;
 143         return XFS_DATA_FORK;
 144 }
 145
 146 /*
 147  * Special values for xfs_bmbt_irec_t br_startblock field.
 148  */
 149 #define DELAYSTARTBLOCK         ((xfs_fsblock_t)-1LL)
 150 #define HOLESTARTBLOCK          ((xfs_fsblock_t)-2LL)
 151
 152 /*
 153  * Flags for xfs_bmap_add_extent*.
 154  */
 155 #define BMAP_LEFT_CONTIG        (1 << 0)
 156 #define BMAP_RIGHT_CONTIG       (1 << 1)
 157 #define BMAP_LEFT_FILLING       (1 << 2)
 158 #define BMAP_RIGHT_FILLING      (1 << 3)
 159 #define BMAP_LEFT_DELAY         (1 << 4)
 160 #define BMAP_RIGHT_DELAY        (1 << 5)
 161 #define BMAP_LEFT_VALID         (1 << 6)
 162 #define BMAP_RIGHT_VALID        (1 << 7)
 163 #define BMAP_ATTRFORK           (1 << 8)
 164 #define BMAP_COWFORK            (1 << 9)
 165
 166 #define XFS_BMAP_EXT_FLAGS \
 167         { BMAP_LEFT_CONTIG,     "LC" }, \
 168         { BMAP_RIGHT_CONTIG,    "RC" }, \
 169         { BMAP_LEFT_FILLING,    "LF" }, \
 170         { BMAP_RIGHT_FILLING,   "RF" }, \
 171         { BMAP_ATTRFORK,        "ATTR" }, \
 172         { BMAP_COWFORK,         "COW" }
 173
 174
 175 /*
 176  * Return true if the extent is a real, allocated extent, or false if it is  a
 177  * delayed allocation, and unwritten extent or a hole.
 178  */
 179 static inline bool xfs_bmap_is_real_extent(struct xfs_bmbt_irec *irec)
 180 {
 181         return irec->br_state != XFS_EXT_UNWRITTEN &&
 182                 irec->br_startblock != HOLESTARTBLOCK &&
 183                 irec->br_startblock != DELAYSTARTBLOCK &&
 184                 !isnullstartblock(irec->br_startblock);
 185 }
 186
 187 void    xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno,
 188                 xfs_filblks_t len);
 189 void    xfs_trim_extent_eof(struct xfs_bmbt_irec *, struct xfs_inode *);
 190 int     xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
 191 void    xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
 192 void    __xfs_bmap_add_free(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
 193                           xfs_fsblock_t bno, xfs_filblks_t len,
 194                           struct xfs_owner_info *oinfo, bool skip_discard);
 195 void    xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
 196 int     xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
 197                 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
 198 int     xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
 199                 xfs_fileoff_t *last_block, int whichfork);
 200 int     xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
 201                 int whichfork);
 202 int     xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
 203 int     xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
 204                 xfs_filblks_t len, struct xfs_bmbt_irec *mval,
 205                 int *nmap, int flags);
 206 int     xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
 207                 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
 208                 xfs_fsblock_t *firstblock, xfs_extlen_t total,
 209                 struct xfs_bmbt_irec *mval, int *nmap,
 210                 struct xfs_defer_ops *dfops);
 211 int     __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
 212                 xfs_fileoff_t bno, xfs_filblks_t *rlen, int flags,
 213                 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
 214                 struct xfs_defer_ops *dfops);
 215 int     xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
 216                 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
 217                 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
 218                 struct xfs_defer_ops *dfops, int *done);
 219 int     xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork,
 220                 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
 221                 struct xfs_bmbt_irec *del);
 222 void    xfs_bmap_del_extent_cow(struct xfs_inode *ip,
 223                 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
 224                 struct xfs_bmbt_irec *del);
 225 uint    xfs_default_attroffset(struct xfs_inode *ip);
 226 int     xfs_bmap_collapse_extents(struct xfs_trans *tp, struct xfs_inode *ip,
 227                 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
 228                 bool *done, xfs_fsblock_t *firstblock,
 229                 struct xfs_defer_ops *dfops);
 230 int     xfs_bmap_insert_extents(struct xfs_trans *tp, struct xfs_inode *ip,
 231                 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
 232                 bool *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
 233                 struct xfs_defer_ops *dfops);
 234 int     xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
 235 int     xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, int whichfork,
 236                 xfs_fileoff_t off, xfs_filblks_t len, xfs_filblks_t prealloc,
 237                 struct xfs_bmbt_irec *got, struct xfs_iext_cursor *cur,
 238                 int eof);
 239
 240 static inline void
 241 xfs_bmap_add_free(
 242         struct xfs_mount                *mp,
 243         struct xfs_defer_ops            *dfops,
 244         xfs_fsblock_t                   bno,
 245         xfs_filblks_t                   len,
 246         struct xfs_owner_info           *oinfo)
 247 {
 248         __xfs_bmap_add_free(mp, dfops, bno, len, oinfo, false);
 249 }
 250
 251 enum xfs_bmap_intent_type {
 252         XFS_BMAP_MAP = 1,
 253         XFS_BMAP_UNMAP,
 254 };
 255
 256 struct xfs_bmap_intent {
 257         struct list_head                        bi_list;
 258         enum xfs_bmap_intent_type               bi_type;
 259         struct xfs_inode                        *bi_owner;
 260         int                                     bi_whichfork;
 261         struct xfs_bmbt_irec                    bi_bmap;
 262 };
 263
 264 int     xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_defer_ops *dfops,
 265                 struct xfs_inode *ip, enum xfs_bmap_intent_type type,
 266                 int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
 267                 xfs_filblks_t *blockcount, xfs_exntst_t state);
 268 int     xfs_bmap_map_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
 269                 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
 270 int     xfs_bmap_unmap_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
 271                 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
 272
 273 static inline int xfs_bmap_fork_to_state(int whichfork)
 274 {
 275         switch (whichfork) {
 276         case XFS_ATTR_FORK:
 277                 return BMAP_ATTRFORK;
 278         case XFS_COW_FORK:
 279                 return BMAP_COWFORK;
 280         default:
 281                 return 0;
 282         }
 283 }
 284
 285 xfs_failaddr_t xfs_bmap_validate_extent(struct xfs_inode *ip, int whichfork,
 286                 struct xfs_bmbt_irec *irec);
 287
 288 int     xfs_bmapi_remap(struct xfs_trans *tp, struct xfs_inode *ip,
 289                 xfs_fileoff_t bno, xfs_filblks_t len, xfs_fsblock_t startblock,
 290                 struct xfs_defer_ops *dfops, int flags);
 291
 292 #endif  /* __XFS_BMAP_H__ */