LCOV - code coverage report
Current view: top level - fs/xfs/libxfs - xfs_bmap.h (source / functions) Hit Total Coverage
Test: fstests of 6.5.0-rc4-xfsx @ Mon Jul 31 20:08:34 PDT 2023 Lines: 14 14 100.0 %
Date: 2023-07-31 20:08:34 Functions: 1 1 100.0 %

          Line data    Source code
       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             : struct xfs_alloc_arg;
      16             : 
      17             : /*
      18             :  * Argument structure for xfs_bmap_alloc.
      19             :  */
      20             : struct xfs_bmalloca {
      21             :         struct xfs_trans        *tp;    /* transaction pointer */
      22             :         struct xfs_inode        *ip;    /* incore inode pointer */
      23             :         struct xfs_bmbt_irec    prev;   /* extent before the new one */
      24             :         struct xfs_bmbt_irec    got;    /* extent after, or delayed */
      25             : 
      26             :         xfs_fileoff_t           offset; /* offset in file filling in */
      27             :         xfs_extlen_t            length; /* i/o length asked/allocated */
      28             :         xfs_fsblock_t           blkno;  /* starting block of new extent */
      29             : 
      30             :         struct xfs_btree_cur    *cur;   /* btree cursor */
      31             :         struct xfs_iext_cursor  icur;   /* incore extent cursor */
      32             :         int                     nallocs;/* number of extents alloc'd */
      33             :         int                     logflags;/* flags for transaction logging */
      34             : 
      35             :         xfs_extlen_t            total;  /* total blocks needed for xaction */
      36             :         xfs_extlen_t            minlen; /* minimum allocation size (blocks) */
      37             :         xfs_extlen_t            minleft; /* amount must be left after alloc */
      38             :         bool                    eof;    /* set if allocating past last extent */
      39             :         bool                    wasdel; /* replacing a delayed allocation */
      40             :         bool                    aeof;   /* allocated space at eof */
      41             :         bool                    conv;   /* overwriting unwritten extents */
      42             :         int                     datatype;/* data type being allocated */
      43             :         uint32_t                flags;
      44             : };
      45             : 
      46             : #define XFS_BMAP_MAX_NMAP       4
      47             : 
      48             : /*
      49             :  * Flags for xfs_bmapi_*
      50             :  */
      51             : #define XFS_BMAPI_ENTIRE        (1u << 0) /* return entire extent untrimmed */
      52             : #define XFS_BMAPI_METADATA      (1u << 1) /* mapping metadata not user data */
      53             : #define XFS_BMAPI_ATTRFORK      (1u << 2) /* use attribute fork not data */
      54             : #define XFS_BMAPI_PREALLOC      (1u << 3) /* preallocating unwritten space */
      55             : #define XFS_BMAPI_CONTIG        (1u << 4) /* must allocate only one extent */
      56             : /*
      57             :  * unwritten extent conversion - this needs write cache flushing and no additional
      58             :  * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
      59             :  * from written to unwritten, otherwise convert from unwritten to written.
      60             :  */
      61             : #define XFS_BMAPI_CONVERT       (1u << 5)
      62             : 
      63             : /*
      64             :  * allocate zeroed extents - this requires all newly allocated user data extents
      65             :  * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
      66             :  * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
      67             :  * during the allocation range to zeroed written extents.
      68             :  */
      69             : #define XFS_BMAPI_ZERO          (1u << 6)
      70             : 
      71             : /*
      72             :  * Map the inode offset to the block given in ap->firstblock.  Primarily
      73             :  * used for reflink.  The range must be in a hole, and this flag cannot be
      74             :  * turned on with PREALLOC or CONVERT, and cannot be used on the attr fork.
      75             :  *
      76             :  * For bunmapi, this flag unmaps the range without adjusting quota, reducing
      77             :  * refcount, or freeing the blocks.
      78             :  */
      79             : #define XFS_BMAPI_REMAP         (1u << 7)
      80             : 
      81             : /* Map something in the CoW fork. */
      82             : #define XFS_BMAPI_COWFORK       (1u << 8)
      83             : 
      84             : /* Skip online discard of freed extents */
      85             : #define XFS_BMAPI_NODISCARD     (1u << 9)
      86             : 
      87             : /* Do not update the rmap btree.  Used for reconstructing bmbt from rmapbt. */
      88             : #define XFS_BMAPI_NORMAP        (1u << 10)
      89             : 
      90             : #define XFS_BMAPI_FLAGS \
      91             :         { XFS_BMAPI_ENTIRE,     "ENTIRE" }, \
      92             :         { XFS_BMAPI_METADATA,   "METADATA" }, \
      93             :         { XFS_BMAPI_ATTRFORK,   "ATTRFORK" }, \
      94             :         { XFS_BMAPI_PREALLOC,   "PREALLOC" }, \
      95             :         { XFS_BMAPI_CONTIG,     "CONTIG" }, \
      96             :         { XFS_BMAPI_CONVERT,    "CONVERT" }, \
      97             :         { XFS_BMAPI_ZERO,       "ZERO" }, \
      98             :         { XFS_BMAPI_REMAP,      "REMAP" }, \
      99             :         { XFS_BMAPI_COWFORK,    "COWFORK" }, \
     100             :         { XFS_BMAPI_NODISCARD,  "NODISCARD" }, \
     101             :         { XFS_BMAPI_NORMAP,     "NORMAP" }
     102             : 
     103             : 
     104             : static inline int xfs_bmapi_aflag(int w)
     105             : {
     106  3787485711 :         return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK :
     107             :                (w == XFS_COW_FORK ? XFS_BMAPI_COWFORK : 0));
     108             : }
     109             : 
     110             : static inline int xfs_bmapi_whichfork(uint32_t bmapi_flags)
     111             : {
     112 14709687676 :         if (bmapi_flags & XFS_BMAPI_COWFORK)
     113             :                 return XFS_COW_FORK;
     114 14697442695 :         else if (bmapi_flags & XFS_BMAPI_ATTRFORK)
     115  1989682534 :                 return XFS_ATTR_FORK;
     116             :         return XFS_DATA_FORK;
     117             : }
     118             : 
     119             : /*
     120             :  * Special values for xfs_bmbt_irec_t br_startblock field.
     121             :  */
     122             : #define DELAYSTARTBLOCK         ((xfs_fsblock_t)-1LL)
     123             : #define HOLESTARTBLOCK          ((xfs_fsblock_t)-2LL)
     124             : 
     125             : /*
     126             :  * Flags for xfs_bmap_add_extent*.
     127             :  */
     128             : #define BMAP_LEFT_CONTIG        (1u << 0)
     129             : #define BMAP_RIGHT_CONTIG       (1u << 1)
     130             : #define BMAP_LEFT_FILLING       (1u << 2)
     131             : #define BMAP_RIGHT_FILLING      (1u << 3)
     132             : #define BMAP_LEFT_DELAY         (1u << 4)
     133             : #define BMAP_RIGHT_DELAY        (1u << 5)
     134             : #define BMAP_LEFT_VALID         (1u << 6)
     135             : #define BMAP_RIGHT_VALID        (1u << 7)
     136             : #define BMAP_ATTRFORK           (1u << 8)
     137             : #define BMAP_COWFORK            (1u << 9)
     138             : 
     139             : #define XFS_BMAP_EXT_FLAGS \
     140             :         { BMAP_LEFT_CONTIG,     "LC" }, \
     141             :         { BMAP_RIGHT_CONTIG,    "RC" }, \
     142             :         { BMAP_LEFT_FILLING,    "LF" }, \
     143             :         { BMAP_RIGHT_FILLING,   "RF" }, \
     144             :         { BMAP_ATTRFORK,        "ATTR" }, \
     145             :         { BMAP_COWFORK,         "COW" }
     146             : 
     147             : /* Return true if the extent is an allocated extent, written or not. */
     148             : static inline bool xfs_bmap_is_real_extent(const struct xfs_bmbt_irec *irec)
     149             : {
     150  7342421800 :         return irec->br_startblock != HOLESTARTBLOCK &&
     151  6259886653 :                 irec->br_startblock != DELAYSTARTBLOCK &&
     152             :                 !isnullstartblock(irec->br_startblock);
     153             : }
     154             : 
     155             : /*
     156             :  * Return true if the extent is a real, allocated extent, or false if it is  a
     157             :  * delayed allocation, and unwritten extent or a hole.
     158             :  */
     159  5300457488 : static inline bool xfs_bmap_is_written_extent(const struct xfs_bmbt_irec *irec)
     160             : {
     161 10278600221 :         return xfs_bmap_is_real_extent(irec) &&
     162  4977252004 :                irec->br_state != XFS_EXT_UNWRITTEN;
     163             : }
     164             : 
     165             : /*
     166             :  * Check the mapping for obviously garbage allocations that could trash the
     167             :  * filesystem immediately.
     168             :  */
     169             : #define xfs_valid_startblock(ip, startblock) \
     170             :         ((startblock) != 0 || XFS_IS_REALTIME_INODE(ip))
     171             : 
     172             : int     xfs_bmap_longest_free_extent(struct xfs_perag *pag,
     173             :                 struct xfs_trans *tp, xfs_extlen_t *blen);
     174             : void    xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno,
     175             :                 xfs_filblks_t len);
     176             : unsigned int xfs_bmap_compute_attr_offset(struct xfs_mount *mp);
     177             : int     xfs_bmap_add_attrfork(struct xfs_trans *tp, struct xfs_inode *ip,
     178             :                 int size, int rsvd);
     179             : void    xfs_bmap_local_to_extents_empty(struct xfs_trans *tp,
     180             :                 struct xfs_inode *ip, int whichfork);
     181             : int xfs_bmap_local_to_extents(struct xfs_trans *tp, struct xfs_inode *ip,
     182             :                 xfs_extlen_t total, int *logflagsp, int whichfork,
     183             :                 void (*init_fn)(struct xfs_trans *tp, struct xfs_buf *bp,
     184             :                                 struct xfs_inode *ip, struct xfs_ifork *ifp,
     185             :                                 void *priv),
     186             :                 void *priv);
     187             : void    xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
     188             : int     xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
     189             :                 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
     190             : int     xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
     191             :                 xfs_fileoff_t *last_block, int whichfork);
     192             : int     xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
     193             :                 int whichfork);
     194             : int     xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
     195             :                 xfs_filblks_t len, struct xfs_bmbt_irec *mval,
     196             :                 int *nmap, uint32_t flags);
     197             : int     xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
     198             :                 xfs_fileoff_t bno, xfs_filblks_t len, uint32_t flags,
     199             :                 xfs_extlen_t total, struct xfs_bmbt_irec *mval, int *nmap);
     200             : int     xfs_bmapi_freesp(struct xfs_trans *tp, struct xfs_inode *ip,
     201             :                 xfs_fsblock_t fsbno, xfs_extlen_t len,
     202             :                 struct xfs_bmbt_irec *mval);
     203             : int     __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
     204             :                 xfs_fileoff_t bno, xfs_filblks_t *rlen, uint32_t flags,
     205             :                 xfs_extnum_t nexts);
     206             : int     xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
     207             :                 xfs_fileoff_t bno, xfs_filblks_t len, uint32_t flags,
     208             :                 xfs_extnum_t nexts, int *done);
     209             : int     xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork,
     210             :                 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
     211             :                 struct xfs_bmbt_irec *del);
     212             : void    xfs_bmap_del_extent_cow(struct xfs_inode *ip,
     213             :                 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
     214             :                 struct xfs_bmbt_irec *del);
     215             : uint    xfs_default_attroffset(struct xfs_inode *ip);
     216             : int     xfs_bmap_collapse_extents(struct xfs_trans *tp, struct xfs_inode *ip,
     217             :                 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
     218             :                 bool *done);
     219             : int     xfs_bmap_can_insert_extents(struct xfs_inode *ip, xfs_fileoff_t off,
     220             :                 xfs_fileoff_t shift);
     221             : int     xfs_bmap_insert_extents(struct xfs_trans *tp, struct xfs_inode *ip,
     222             :                 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
     223             :                 bool *done, xfs_fileoff_t stop_fsb);
     224             : int     xfs_bmap_split_extent(struct xfs_trans *tp, struct xfs_inode *ip,
     225             :                 xfs_fileoff_t split_offset);
     226             : int     xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, int whichfork,
     227             :                 xfs_fileoff_t off, xfs_filblks_t len, xfs_filblks_t prealloc,
     228             :                 struct xfs_bmbt_irec *got, struct xfs_iext_cursor *cur,
     229             :                 int eof);
     230             : int     xfs_bmapi_convert_delalloc(struct xfs_inode *ip, int whichfork,
     231             :                 xfs_off_t offset, struct iomap *iomap, unsigned int *seq);
     232             : int     xfs_bmap_add_extent_unwritten_real(struct xfs_trans *tp,
     233             :                 struct xfs_inode *ip, int whichfork,
     234             :                 struct xfs_iext_cursor *icur, struct xfs_btree_cur **curp,
     235             :                 struct xfs_bmbt_irec *new, int *logflagsp);
     236             : xfs_extlen_t xfs_bmapi_minleft(struct xfs_trans *tp, struct xfs_inode *ip,
     237             :                 int fork);
     238             : int     xfs_bmap_btalloc_low_space(struct xfs_bmalloca *ap,
     239             :                 struct xfs_alloc_arg *args);
     240             : 
     241             : enum xfs_bmap_intent_type {
     242             :         XFS_BMAP_MAP = 1,
     243             :         XFS_BMAP_UNMAP,
     244             : };
     245             : 
     246             : #define XFS_BMAP_INTENT_STRINGS \
     247             :         { XFS_BMAP_MAP,         "map" }, \
     248             :         { XFS_BMAP_UNMAP,       "unmap" }
     249             : 
     250             : struct xfs_bmap_intent {
     251             :         struct list_head                        bi_list;
     252             :         enum xfs_bmap_intent_type               bi_type;
     253             :         int                                     bi_whichfork;
     254             :         struct xfs_inode                        *bi_owner;
     255             :         union {
     256             :                 struct xfs_perag                *bi_pag;
     257             :                 struct xfs_rtgroup              *bi_rtg;
     258             :         };
     259             :         struct xfs_bmbt_irec                    bi_bmap;
     260             : };
     261             : 
     262             : void xfs_bmap_update_get_group(struct xfs_mount *mp,
     263             :                 struct xfs_bmap_intent *bi);
     264             : 
     265             : int     xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_bmap_intent *bi);
     266             : void    xfs_bmap_map_extent(struct xfs_trans *tp, struct xfs_inode *ip,
     267             :                 int whichfork, struct xfs_bmbt_irec *imap);
     268             : void    xfs_bmap_unmap_extent(struct xfs_trans *tp, struct xfs_inode *ip,
     269             :                 int whichfork, struct xfs_bmbt_irec *imap);
     270             : 
     271             : static inline uint32_t xfs_bmap_fork_to_state(int whichfork)
     272  3751943586 : {
     273             :         switch (whichfork) {
     274             :         case XFS_ATTR_FORK:
     275    24527688 :                 return BMAP_ATTRFORK;
     276    24527688 :         case XFS_COW_FORK:
     277  3650902402 :                 return BMAP_COWFORK;
     278  3650902402 :         default:
     279             :                 return 0;
     280             :         }
     281             : }
     282             : 
     283             : xfs_failaddr_t xfs_bmap_validate_extent_raw(struct xfs_mount *mp, bool rtfile,
     284             :                 int whichfork, struct xfs_bmbt_irec *irec);
     285             : xfs_failaddr_t xfs_bmap_validate_extent(struct xfs_inode *ip, int whichfork,
     286             :                 struct xfs_bmbt_irec *irec);
     287             : int xfs_bmap_complain_bad_rec(struct xfs_inode *ip, int whichfork,
     288             :                 xfs_failaddr_t fa, const struct xfs_bmbt_irec *irec);
     289             : 
     290             : int     xfs_bmapi_remap(struct xfs_trans *tp, struct xfs_inode *ip,
     291             :                 xfs_fileoff_t bno, xfs_filblks_t len, xfs_fsblock_t startblock,
     292             :                 uint32_t flags);
     293             : int     xfs_bunmapi_range(struct xfs_trans **tpp, struct xfs_inode *ip,
     294             :                 uint32_t flags, xfs_fileoff_t startoff, xfs_fileoff_t endoff);
     295             : 
     296             : extern struct kmem_cache        *xfs_bmap_intent_cache;
     297             : 
     298             : int __init xfs_bmap_intent_init_cache(void);
     299             : void xfs_bmap_intent_destroy_cache(void);
     300             : 
     301             : typedef int (*xfs_bmap_query_range_fn)(
     302             :         struct xfs_btree_cur    *cur,
     303             :         struct xfs_bmbt_irec    *rec,
     304             :         void                    *priv);
     305             : 
     306             : int xfs_bmap_query_all(struct xfs_btree_cur *cur, xfs_bmap_query_range_fn fn,
     307             :                 void *priv);
     308             : 
     309             : xfs_extlen_t    xfs_get_extsz_hint(struct xfs_inode *ip);
     310             : xfs_extlen_t    xfs_get_cowextsz_hint(struct xfs_inode *ip);
     311             : 
     312             : #endif  /* __XFS_BMAP_H__ */

Generated by: LCOV version 1.14