fs/xfs/xfs_bmap_btree.h

   1 /*
   2  * Copyright (c) 2000,2002-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #ifndef __XFS_BMAP_BTREE_H__
  19 #define __XFS_BMAP_BTREE_H__
  20
  21 #define XFS_BMAP_MAGIC  0x424d4150      /* 'BMAP' */
  22
  23 struct xfs_btree_cur;
  24 struct xfs_btree_lblock;
  25 struct xfs_mount;
  26 struct xfs_inode;
  27 struct xfs_trans;
  28
  29 /*
  30  * Bmap root header, on-disk form only.
  31  */
  32 typedef struct xfs_bmdr_block {
  33         __be16          bb_level;       /* 0 is a leaf */
  34         __be16          bb_numrecs;     /* current # of data records */
  35 } xfs_bmdr_block_t;
  36
  37 /*
  38  * Bmap btree record and extent descriptor.
  39  *  l0:63 is an extent flag (value 1 indicates non-normal).
  40  *  l0:9-62 are startoff.
  41  *  l0:0-8 and l1:21-63 are startblock.
  42  *  l1:0-20 are blockcount.
  43  */
  44 #define BMBT_EXNTFLAG_BITLEN    1
  45 #define BMBT_STARTOFF_BITLEN    54
  46 #define BMBT_STARTBLOCK_BITLEN  52
  47 #define BMBT_BLOCKCOUNT_BITLEN  21
  48
  49
  50 #define BMBT_USE_64     1
  51
  52 typedef struct xfs_bmbt_rec_32
  53 {
  54         __uint32_t              l0, l1, l2, l3;
  55 } xfs_bmbt_rec_32_t;
  56 typedef struct xfs_bmbt_rec_64
  57 {
  58         __be64                  l0, l1;
  59 } xfs_bmbt_rec_64_t;
  60
  61 typedef __uint64_t      xfs_bmbt_rec_base_t;    /* use this for casts */
  62 typedef xfs_bmbt_rec_64_t xfs_bmbt_rec_t, xfs_bmdr_rec_t;
  63
  64 typedef struct xfs_bmbt_rec_host {
  65         __uint64_t              l0, l1;
  66 } xfs_bmbt_rec_host_t;
  67
  68 /*
  69  * Values and macros for delayed-allocation startblock fields.
  70  */
  71 #define STARTBLOCKVALBITS       17
  72 #define STARTBLOCKMASKBITS      (15 + XFS_BIG_BLKNOS * 20)
  73 #define DSTARTBLOCKMASKBITS     (15 + 20)
  74 #define STARTBLOCKMASK          \
  75         (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
  76 #define DSTARTBLOCKMASK         \
  77         (((((xfs_dfsbno_t)1) << DSTARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
  78
  79 #define ISNULLSTARTBLOCK(x)     isnullstartblock(x)
  80 static inline int isnullstartblock(xfs_fsblock_t x)
  81 {
  82         return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
  83 }
  84
  85 #define ISNULLDSTARTBLOCK(x)    isnulldstartblock(x)
  86 static inline int isnulldstartblock(xfs_dfsbno_t x)
  87 {
  88         return ((x) & DSTARTBLOCKMASK) == DSTARTBLOCKMASK;
  89 }
  90
  91 #define NULLSTARTBLOCK(k)       nullstartblock(k)
  92 static inline xfs_fsblock_t nullstartblock(int k)
  93 {
  94         ASSERT(k < (1 << STARTBLOCKVALBITS));
  95         return STARTBLOCKMASK | (k);
  96 }
  97
  98 #define STARTBLOCKVAL(x)        startblockval(x)
  99 static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
 100 {
 101         return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
 102 }
 103
 104 /*
 105  * Possible extent formats.
 106  */
 107 typedef enum {
 108         XFS_EXTFMT_NOSTATE = 0,
 109         XFS_EXTFMT_HASSTATE
 110 } xfs_exntfmt_t;
 111
 112 /*
 113  * Possible extent states.
 114  */
 115 typedef enum {
 116         XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
 117         XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID
 118 } xfs_exntst_t;
 119
 120 /*
 121  * Extent state and extent format macros.
 122  */
 123 #define XFS_EXTFMT_INODE(x)     \
 124         (xfs_sb_version_hasextflgbit(&((x)->i_mount->m_sb)) ? \
 125                 XFS_EXTFMT_HASSTATE : XFS_EXTFMT_NOSTATE)
 126 #define ISUNWRITTEN(x)  ((x)->br_state == XFS_EXT_UNWRITTEN)
 127
 128 /*
 129  * Incore version of above.
 130  */
 131 typedef struct xfs_bmbt_irec
 132 {
 133         xfs_fileoff_t   br_startoff;    /* starting file offset */
 134         xfs_fsblock_t   br_startblock;  /* starting block number */
 135         xfs_filblks_t   br_blockcount;  /* number of blocks */
 136         xfs_exntst_t    br_state;       /* extent state */
 137 } xfs_bmbt_irec_t;
 138
 139 /*
 140  * Key structure for non-leaf levels of the tree.
 141  */
 142 typedef struct xfs_bmbt_key {
 143         __be64          br_startoff;    /* starting file offset */
 144 } xfs_bmbt_key_t, xfs_bmdr_key_t;
 145
 146 /* btree pointer type */
 147 typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
 148
 149 /* btree block header type */
 150 typedef struct xfs_btree_lblock xfs_bmbt_block_t;
 151
 152 #define XFS_BUF_TO_BMBT_BLOCK(bp)       ((xfs_bmbt_block_t *)XFS_BUF_PTR(bp))
 153
 154 #define XFS_BMAP_RBLOCK_DSIZE(lev,cur)  ((cur)->bc_private.b.forksize)
 155 #define XFS_BMAP_RBLOCK_ISIZE(lev,cur)  \
 156         ((int)XFS_IFORK_PTR((cur)->bc_private.b.ip, \
 157                     (cur)->bc_private.b.whichfork)->if_broot_bytes)
 158
 159 #define XFS_BMAP_BLOCK_DMAXRECS(lev,cur) \
 160         (((lev) == (cur)->bc_nlevels - 1 ? \
 161                 XFS_BTREE_BLOCK_MAXRECS(XFS_BMAP_RBLOCK_DSIZE(lev,cur), \
 162                         xfs_bmdr, (lev) == 0) : \
 163                 ((cur)->bc_mp->m_bmap_dmxr[(lev) != 0])))
 164 #define XFS_BMAP_BLOCK_IMAXRECS(lev,cur) \
 165         (((lev) == (cur)->bc_nlevels - 1 ? \
 166                         XFS_BTREE_BLOCK_MAXRECS(XFS_BMAP_RBLOCK_ISIZE(lev,cur),\
 167                                 xfs_bmbt, (lev) == 0) : \
 168                         ((cur)->bc_mp->m_bmap_dmxr[(lev) != 0])))
 169
 170 #define XFS_BMAP_BLOCK_DMINRECS(lev,cur) \
 171         (((lev) == (cur)->bc_nlevels - 1 ? \
 172                         XFS_BTREE_BLOCK_MINRECS(XFS_BMAP_RBLOCK_DSIZE(lev,cur),\
 173                                 xfs_bmdr, (lev) == 0) : \
 174                         ((cur)->bc_mp->m_bmap_dmnr[(lev) != 0])))
 175 #define XFS_BMAP_BLOCK_IMINRECS(lev,cur) \
 176         (((lev) == (cur)->bc_nlevels - 1 ? \
 177                         XFS_BTREE_BLOCK_MINRECS(XFS_BMAP_RBLOCK_ISIZE(lev,cur),\
 178                                 xfs_bmbt, (lev) == 0) : \
 179                         ((cur)->bc_mp->m_bmap_dmnr[(lev) != 0])))
 180
 181 #define XFS_BMAP_REC_DADDR(bb,i,cur)    (XFS_BTREE_REC_ADDR(xfs_bmbt, bb, i))
 182
 183 #define XFS_BMAP_REC_IADDR(bb,i,cur)    (XFS_BTREE_REC_ADDR(xfs_bmbt, bb, i))
 184
 185 #define XFS_BMAP_KEY_DADDR(bb,i,cur)    \
 186         (XFS_BTREE_KEY_ADDR(xfs_bmbt, bb, i))
 187
 188 #define XFS_BMAP_KEY_IADDR(bb,i,cur)    \
 189         (XFS_BTREE_KEY_ADDR(xfs_bmbt, bb, i))
 190
 191 #define XFS_BMAP_PTR_DADDR(bb,i,cur)    \
 192         (XFS_BTREE_PTR_ADDR(xfs_bmbt, bb, i, XFS_BMAP_BLOCK_DMAXRECS(   \
 193                                 be16_to_cpu((bb)->bb_level), cur)))
 194 #define XFS_BMAP_PTR_IADDR(bb,i,cur)    \
 195         (XFS_BTREE_PTR_ADDR(xfs_bmbt, bb, i, XFS_BMAP_BLOCK_IMAXRECS(   \
 196                                 be16_to_cpu((bb)->bb_level), cur)))
 197
 198 /*
 199  * These are to be used when we know the size of the block and
 200  * we don't have a cursor.
 201  */
 202 #define XFS_BMAP_BROOT_REC_ADDR(bb,i,sz) \
 203         (XFS_BTREE_REC_ADDR(xfs_bmbt,bb,i))
 204 #define XFS_BMAP_BROOT_KEY_ADDR(bb,i,sz) \
 205         (XFS_BTREE_KEY_ADDR(xfs_bmbt,bb,i))
 206 #define XFS_BMAP_BROOT_PTR_ADDR(bb,i,sz) \
 207         (XFS_BTREE_PTR_ADDR(xfs_bmbt,bb,i,XFS_BMAP_BROOT_MAXRECS(sz)))
 208
 209 #define XFS_BMAP_BROOT_NUMRECS(bb)      be16_to_cpu((bb)->bb_numrecs)
 210 #define XFS_BMAP_BROOT_MAXRECS(sz)      XFS_BTREE_BLOCK_MAXRECS(sz,xfs_bmbt,0)
 211
 212 #define XFS_BMAP_BROOT_SPACE_CALC(nrecs) \
 213         (int)(sizeof(xfs_bmbt_block_t) + \
 214                ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
 215
 216 #define XFS_BMAP_BROOT_SPACE(bb) \
 217         (XFS_BMAP_BROOT_SPACE_CALC(be16_to_cpu((bb)->bb_numrecs)))
 218 #define XFS_BMDR_SPACE_CALC(nrecs) \
 219         (int)(sizeof(xfs_bmdr_block_t) + \
 220                ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
 221
 222 /*
 223  * Maximum number of bmap btree levels.
 224  */
 225 #define XFS_BM_MAXLEVELS(mp,w)          ((mp)->m_bm_maxlevels[(w)])
 226
 227 #define XFS_BMAP_SANITY_CHECK(mp,bb,level) \
 228         (be32_to_cpu((bb)->bb_magic) == XFS_BMAP_MAGIC && \
 229          be16_to_cpu((bb)->bb_level) == level && \
 230          be16_to_cpu((bb)->bb_numrecs) > 0 && \
 231          be16_to_cpu((bb)->bb_numrecs) <= (mp)->m_bmap_dmxr[(level) != 0])
 232
 233
 234 #ifdef __KERNEL__
 235
 236 /*
 237  * Prototypes for xfs_bmap.c to call.
 238  */
 239 extern void xfs_bmdr_to_bmbt(xfs_bmdr_block_t *, int, xfs_bmbt_block_t *, int);
 240 extern void xfs_bmbt_get_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
 241 extern xfs_filblks_t xfs_bmbt_get_blockcount(xfs_bmbt_rec_host_t *r);
 242 extern xfs_fsblock_t xfs_bmbt_get_startblock(xfs_bmbt_rec_host_t *r);
 243 extern xfs_fileoff_t xfs_bmbt_get_startoff(xfs_bmbt_rec_host_t *r);
 244 extern xfs_exntst_t xfs_bmbt_get_state(xfs_bmbt_rec_host_t *r);
 245
 246 extern void xfs_bmbt_disk_get_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
 247 extern xfs_filblks_t xfs_bmbt_disk_get_blockcount(xfs_bmbt_rec_t *r);
 248 extern xfs_fileoff_t xfs_bmbt_disk_get_startoff(xfs_bmbt_rec_t *r);
 249
 250 extern void xfs_bmbt_set_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
 251 extern void xfs_bmbt_set_allf(xfs_bmbt_rec_host_t *r, xfs_fileoff_t o,
 252                         xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
 253 extern void xfs_bmbt_set_blockcount(xfs_bmbt_rec_host_t *r, xfs_filblks_t v);
 254 extern void xfs_bmbt_set_startblock(xfs_bmbt_rec_host_t *r, xfs_fsblock_t v);
 255 extern void xfs_bmbt_set_startoff(xfs_bmbt_rec_host_t *r, xfs_fileoff_t v);
 256 extern void xfs_bmbt_set_state(xfs_bmbt_rec_host_t *r, xfs_exntst_t v);
 257
 258 extern void xfs_bmbt_disk_set_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
 259 extern void xfs_bmbt_disk_set_allf(xfs_bmbt_rec_t *r, xfs_fileoff_t o,
 260                         xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
 261
 262 extern void xfs_bmbt_to_bmdr(xfs_bmbt_block_t *, int, xfs_bmdr_block_t *, int);
 263
 264 extern struct xfs_btree_cur *xfs_bmbt_init_cursor(struct xfs_mount *,
 265                 struct xfs_trans *, struct xfs_inode *, int);
 266
 267 #endif  /* __KERNEL__ */
 268
 269 #endif  /* __XFS_BMAP_BTREE_H__ */