SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/xfs/xfs_btree.h

   1 /*
   2  * Copyright (c) 2000-2001,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_BTREE_H__
  19 #define __XFS_BTREE_H__
  20
  21 struct xfs_buf;
  22 struct xfs_bmap_free;
  23 struct xfs_inode;
  24 struct xfs_mount;
  25 struct xfs_trans;
  26
  27 extern kmem_zone_t      *xfs_btree_cur_zone;
  28
  29 /*
  30  * This nonsense is to make -wlint happy.
  31  */
  32 #define XFS_LOOKUP_EQ   ((xfs_lookup_t)XFS_LOOKUP_EQi)
  33 #define XFS_LOOKUP_LE   ((xfs_lookup_t)XFS_LOOKUP_LEi)
  34 #define XFS_LOOKUP_GE   ((xfs_lookup_t)XFS_LOOKUP_GEi)
  35
  36 #define XFS_BTNUM_BNO   ((xfs_btnum_t)XFS_BTNUM_BNOi)
  37 #define XFS_BTNUM_CNT   ((xfs_btnum_t)XFS_BTNUM_CNTi)
  38 #define XFS_BTNUM_BMAP  ((xfs_btnum_t)XFS_BTNUM_BMAPi)
  39 #define XFS_BTNUM_INO   ((xfs_btnum_t)XFS_BTNUM_INOi)
  40
  41 /*
  42  * Short form header: space allocation btrees.
  43  */
  44 typedef struct xfs_btree_sblock {
  45         __be32          bb_magic;       /* magic number for block type */
  46         __be16          bb_level;       /* 0 is a leaf */
  47         __be16          bb_numrecs;     /* current # of data records */
  48         __be32          bb_leftsib;     /* left sibling block or NULLAGBLOCK */
  49         __be32          bb_rightsib;    /* right sibling block or NULLAGBLOCK */
  50 } xfs_btree_sblock_t;
  51
  52 /*
  53  * Long form header: bmap btrees.
  54  */
  55 typedef struct xfs_btree_lblock {
  56         __be32          bb_magic;       /* magic number for block type */
  57         __be16          bb_level;       /* 0 is a leaf */
  58         __be16          bb_numrecs;     /* current # of data records */
  59         __be64          bb_leftsib;     /* left sibling block or NULLDFSBNO */
  60         __be64          bb_rightsib;    /* right sibling block or NULLDFSBNO */
  61 } xfs_btree_lblock_t;
  62
  63 /*
  64  * Combined header and structure, used by common code.
  65  */
  66 typedef struct xfs_btree_block {
  67         __be32          bb_magic;       /* magic number for block type */
  68         __be16          bb_level;       /* 0 is a leaf */
  69         __be16          bb_numrecs;     /* current # of data records */
  70         union {
  71                 struct {
  72                         __be32          bb_leftsib;
  73                         __be32          bb_rightsib;
  74                 } s;                    /* short form pointers */
  75                 struct  {
  76                         __be64          bb_leftsib;
  77                         __be64          bb_rightsib;
  78                 } l;                    /* long form pointers */
  79         } bb_u;                         /* rest */
  80 } xfs_btree_block_t;
  81
  82 /*
  83  * Generic key, ptr and record wrapper structures.
  84  *
  85  * These are disk format structures, and are converted where necessary
  86  * by the btree specific code that needs to interpret them.
  87  */
  88 union xfs_btree_ptr {
  89         __be32                  s;      /* short form ptr */
  90         __be64                  l;      /* long form ptr */
  91 };
  92
  93 union xfs_btree_key {
  94         xfs_bmbt_key_t          bmbt;
  95         xfs_bmdr_key_t          bmbr;   /* bmbt root block */
  96         xfs_alloc_key_t         alloc;
  97         xfs_inobt_key_t         inobt;
  98 };
  99
 100 union xfs_btree_rec {
 101         xfs_bmbt_rec_t          bmbt;
 102         xfs_bmdr_rec_t          bmbr;   /* bmbt root block */
 103         xfs_alloc_rec_t         alloc;
 104         xfs_inobt_rec_t         inobt;
 105 };
 106
 107 /*
 108  * For logging record fields.
 109  */
 110 #define XFS_BB_MAGIC            0x01
 111 #define XFS_BB_LEVEL            0x02
 112 #define XFS_BB_NUMRECS          0x04
 113 #define XFS_BB_LEFTSIB          0x08
 114 #define XFS_BB_RIGHTSIB         0x10
 115 #define XFS_BB_NUM_BITS         5
 116 #define XFS_BB_ALL_BITS         ((1 << XFS_BB_NUM_BITS) - 1)
 117
 118 /*
 119  * Boolean to select which form of xfs_btree_block_t.bb_u to use.
 120  */
 121 #define XFS_BTREE_LONG_PTRS(btnum)      ((btnum) == XFS_BTNUM_BMAP)
 122
 123 /*
 124  * Magic numbers for btree blocks.
 125  */
 126 extern const __uint32_t xfs_magics[];
 127
 128 /*
 129  * Maximum and minimum records in a btree block.
 130  * Given block size, type prefix, and leaf flag (0 or 1).
 131  * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
 132  * compiler warnings.
 133  */
 134 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf)       \
 135         ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
 136          (((lf) * (uint)sizeof(t ## _rec_t)) + \
 137           ((1 - (lf)) * \
 138            ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
 139 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf)       \
 140         (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
 141
 142 /*
 143  * Record, key, and pointer address calculation macros.
 144  * Given block size, type prefix, block pointer, and index of requested entry
 145  * (first entry numbered 1).
 146  */
 147 #define XFS_BTREE_REC_ADDR(t,bb,i)      \
 148         ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
 149          ((i) - 1) * sizeof(t ## _rec_t)))
 150 #define XFS_BTREE_KEY_ADDR(t,bb,i)      \
 151         ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
 152          ((i) - 1) * sizeof(t ## _key_t)))
 153 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr)  \
 154         ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
 155          (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
 156
 157 #define XFS_BTREE_MAXLEVELS     8       /* max of all btrees */
 158
 159 struct xfs_btree_ops {
 160         /* cursor operations */
 161         struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
 162 };
 163
 164 /*
 165  * Btree cursor structure.
 166  * This collects all information needed by the btree code in one place.
 167  */
 168 typedef struct xfs_btree_cur
 169 {
 170         struct xfs_trans        *bc_tp; /* transaction we're in, if any */
 171         struct xfs_mount        *bc_mp; /* file system mount struct */
 172         const struct xfs_btree_ops *bc_ops;
 173         uint                    bc_flags; /* btree features - below */
 174         union {
 175                 xfs_alloc_rec_incore_t  a;
 176                 xfs_bmbt_irec_t         b;
 177                 xfs_inobt_rec_incore_t  i;
 178         }               bc_rec;         /* current insert/search record value */
 179         struct xfs_buf  *bc_bufs[XFS_BTREE_MAXLEVELS];  /* buf ptr per level */
 180         int             bc_ptrs[XFS_BTREE_MAXLEVELS];   /* key/record # */
 181         __uint8_t       bc_ra[XFS_BTREE_MAXLEVELS];     /* readahead bits */
 182 #define XFS_BTCUR_LEFTRA        1       /* left sibling has been read-ahead */
 183 #define XFS_BTCUR_RIGHTRA       2       /* right sibling has been read-ahead */
 184         __uint8_t       bc_nlevels;     /* number of levels in the tree */
 185         __uint8_t       bc_blocklog;    /* log2(blocksize) of btree blocks */
 186         xfs_btnum_t     bc_btnum;       /* identifies which btree type */
 187         union {
 188                 struct {                        /* needed for BNO, CNT, INO */
 189                         struct xfs_buf  *agbp;  /* agf/agi buffer pointer */
 190                         xfs_agnumber_t  agno;   /* ag number */
 191                 } a;
 192                 struct {                        /* needed for BMAP */
 193                         struct xfs_inode *ip;   /* pointer to our inode */
 194                         struct xfs_bmap_free *flist;    /* list to free after */
 195                         xfs_fsblock_t   firstblock;     /* 1st blk allocated */
 196                         int             allocated;      /* count of alloced */
 197                         short           forksize;       /* fork's inode space */
 198                         char            whichfork;      /* data or attr fork */
 199                         char            flags;          /* flags */
 200 #define XFS_BTCUR_BPRV_WASDEL   1                       /* was delayed */
 201                 } b;
 202         }               bc_private;     /* per-btree type data */
 203 } xfs_btree_cur_t;
 204
 205 /* cursor flags */
 206 #define XFS_BTREE_ROOT_IN_INODE         (1<<1)  /* root may be variable size */
 207
 208
 209 #define XFS_BTREE_NOERROR       0
 210 #define XFS_BTREE_ERROR         1
 211
 212 /*
 213  * Convert from buffer to btree block header.
 214  */
 215 #define XFS_BUF_TO_BLOCK(bp)    ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
 216 #define XFS_BUF_TO_LBLOCK(bp)   ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
 217 #define XFS_BUF_TO_SBLOCK(bp)   ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
 218
 219
 220 #ifdef __KERNEL__
 221
 222 #ifdef DEBUG
 223 /*
 224  * Debug routine: check that block header is ok.
 225  */
 226 void
 227 xfs_btree_check_block(
 228         xfs_btree_cur_t         *cur,   /* btree cursor */
 229         xfs_btree_block_t       *block, /* generic btree block pointer */
 230         int                     level,  /* level of the btree block */
 231         struct xfs_buf          *bp);   /* buffer containing block, if any */
 232
 233 /*
 234  * Debug routine: check that keys are in the right order.
 235  */
 236 void
 237 xfs_btree_check_key(
 238         xfs_btnum_t             btnum,  /* btree identifier */
 239         void                    *ak1,   /* pointer to left (lower) key */
 240         void                    *ak2);  /* pointer to right (higher) key */
 241
 242 /*
 243  * Debug routine: check that records are in the right order.
 244  */
 245 void
 246 xfs_btree_check_rec(
 247         xfs_btnum_t             btnum,  /* btree identifier */
 248         void                    *ar1,   /* pointer to left (lower) record */
 249         void                    *ar2);  /* pointer to right (higher) record */
 250 #else
 251 #define xfs_btree_check_block(a,b,c,d)
 252 #define xfs_btree_check_key(a,b,c)
 253 #define xfs_btree_check_rec(a,b,c)
 254 #endif  /* DEBUG */
 255
 256 /*
 257  * Checking routine: check that long form block header is ok.
 258  */
 259 int                                     /* error (0 or EFSCORRUPTED) */
 260 xfs_btree_check_lblock(
 261         xfs_btree_cur_t         *cur,   /* btree cursor */
 262         xfs_btree_lblock_t      *block, /* btree long form block pointer */
 263         int                     level,  /* level of the btree block */
 264         struct xfs_buf          *bp);   /* buffer containing block, if any */
 265
 266 /*
 267  * Checking routine: check that (long) pointer is ok.
 268  */
 269 int                                     /* error (0 or EFSCORRUPTED) */
 270 xfs_btree_check_lptr(
 271         xfs_btree_cur_t         *cur,   /* btree cursor */
 272         xfs_dfsbno_t            ptr,    /* btree block disk address */
 273         int                     level); /* btree block level */
 274
 275 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
 276         xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
 277
 278 /*
 279  * Checking routine: check that short form block header is ok.
 280  */
 281 int                                     /* error (0 or EFSCORRUPTED) */
 282 xfs_btree_check_sblock(
 283         xfs_btree_cur_t         *cur,   /* btree cursor */
 284         xfs_btree_sblock_t      *block, /* btree short form block pointer */
 285         int                     level,  /* level of the btree block */
 286         struct xfs_buf          *bp);   /* buffer containing block */
 287
 288 /*
 289  * Checking routine: check that (short) pointer is ok.
 290  */
 291 int                                     /* error (0 or EFSCORRUPTED) */
 292 xfs_btree_check_sptr(
 293         xfs_btree_cur_t         *cur,   /* btree cursor */
 294         xfs_agblock_t           ptr,    /* btree block disk address */
 295         int                     level); /* btree block level */
 296
 297 /*
 298  * Delete the btree cursor.
 299  */
 300 void
 301 xfs_btree_del_cursor(
 302         xfs_btree_cur_t         *cur,   /* btree cursor */
 303         int                     error); /* del because of error */
 304
 305 /*
 306  * Duplicate the btree cursor.
 307  * Allocate a new one, copy the record, re-get the buffers.
 308  */
 309 int                                     /* error */
 310 xfs_btree_dup_cursor(
 311         xfs_btree_cur_t         *cur,   /* input cursor */
 312         xfs_btree_cur_t         **ncur);/* output cursor */
 313
 314 /*
 315  * Change the cursor to point to the first record in the current block
 316  * at the given level.  Other levels are unaffected.
 317  */
 318 int                                     /* success=1, failure=0 */
 319 xfs_btree_firstrec(
 320         xfs_btree_cur_t         *cur,   /* btree cursor */
 321         int                     level); /* level to change */
 322
 323 /*
 324  * Get a buffer for the block, return it with no data read.
 325  * Long-form addressing.
 326  */
 327 struct xfs_buf *                                /* buffer for fsbno */
 328 xfs_btree_get_bufl(
 329         struct xfs_mount        *mp,    /* file system mount point */
 330         struct xfs_trans        *tp,    /* transaction pointer */
 331         xfs_fsblock_t           fsbno,  /* file system block number */
 332         uint                    lock);  /* lock flags for get_buf */
 333
 334 /*
 335  * Get a buffer for the block, return it with no data read.
 336  * Short-form addressing.
 337  */
 338 struct xfs_buf *                                /* buffer for agno/agbno */
 339 xfs_btree_get_bufs(
 340         struct xfs_mount        *mp,    /* file system mount point */
 341         struct xfs_trans        *tp,    /* transaction pointer */
 342         xfs_agnumber_t          agno,   /* allocation group number */
 343         xfs_agblock_t           agbno,  /* allocation group block number */
 344         uint                    lock);  /* lock flags for get_buf */
 345
 346 /*
 347  * Check for the cursor referring to the last block at the given level.
 348  */
 349 int                                     /* 1=is last block, 0=not last block */
 350 xfs_btree_islastblock(
 351         xfs_btree_cur_t         *cur,   /* btree cursor */
 352         int                     level); /* level to check */
 353
 354 /*
 355  * Change the cursor to point to the last record in the current block
 356  * at the given level.  Other levels are unaffected.
 357  */
 358 int                                     /* success=1, failure=0 */
 359 xfs_btree_lastrec(
 360         xfs_btree_cur_t         *cur,   /* btree cursor */
 361         int                     level); /* level to change */
 362
 363 /*
 364  * Compute first and last byte offsets for the fields given.
 365  * Interprets the offsets table, which contains struct field offsets.
 366  */
 367 void
 368 xfs_btree_offsets(
 369         __int64_t               fields, /* bitmask of fields */
 370         const short             *offsets,/* table of field offsets */
 371         int                     nbits,  /* number of bits to inspect */
 372         int                     *first, /* output: first byte offset */
 373         int                     *last); /* output: last byte offset */
 374
 375 /*
 376  * Get a buffer for the block, return it read in.
 377  * Long-form addressing.
 378  */
 379 int                                     /* error */
 380 xfs_btree_read_bufl(
 381         struct xfs_mount        *mp,    /* file system mount point */
 382         struct xfs_trans        *tp,    /* transaction pointer */
 383         xfs_fsblock_t           fsbno,  /* file system block number */
 384         uint                    lock,   /* lock flags for read_buf */
 385         struct xfs_buf          **bpp,  /* buffer for fsbno */
 386         int                     refval);/* ref count value for buffer */
 387
 388 /*
 389  * Get a buffer for the block, return it read in.
 390  * Short-form addressing.
 391  */
 392 int                                     /* error */
 393 xfs_btree_read_bufs(
 394         struct xfs_mount        *mp,    /* file system mount point */
 395         struct xfs_trans        *tp,    /* transaction pointer */
 396         xfs_agnumber_t          agno,   /* allocation group number */
 397         xfs_agblock_t           agbno,  /* allocation group block number */
 398         uint                    lock,   /* lock flags for read_buf */
 399         struct xfs_buf          **bpp,  /* buffer for agno/agbno */
 400         int                     refval);/* ref count value for buffer */
 401
 402 /*
 403  * Read-ahead the block, don't wait for it, don't return a buffer.
 404  * Long-form addressing.
 405  */
 406 void                                    /* error */
 407 xfs_btree_reada_bufl(
 408         struct xfs_mount        *mp,    /* file system mount point */
 409         xfs_fsblock_t           fsbno,  /* file system block number */
 410         xfs_extlen_t            count); /* count of filesystem blocks */
 411
 412 /*
 413  * Read-ahead the block, don't wait for it, don't return a buffer.
 414  * Short-form addressing.
 415  */
 416 void                                    /* error */
 417 xfs_btree_reada_bufs(
 418         struct xfs_mount        *mp,    /* file system mount point */
 419         xfs_agnumber_t          agno,   /* allocation group number */
 420         xfs_agblock_t           agbno,  /* allocation group block number */
 421         xfs_extlen_t            count); /* count of filesystem blocks */
 422
 423 /*
 424  * Read-ahead btree blocks, at the given level.
 425  * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
 426  */
 427 int                                     /* readahead block count */
 428 xfs_btree_readahead_core(
 429         xfs_btree_cur_t         *cur,   /* btree cursor */
 430         int                     lev,    /* level in btree */
 431         int                     lr);    /* left/right bits */
 432
 433 static inline int                       /* readahead block count */
 434 xfs_btree_readahead(
 435         xfs_btree_cur_t         *cur,   /* btree cursor */
 436         int                     lev,    /* level in btree */
 437         int                     lr)     /* left/right bits */
 438 {
 439         if ((cur->bc_ra[lev] | lr) == cur->bc_ra[lev])
 440                 return 0;
 441
 442         return xfs_btree_readahead_core(cur, lev, lr);
 443 }
 444
 445
 446 /*
 447  * Set the buffer for level "lev" in the cursor to bp, releasing
 448  * any previous buffer.
 449  */
 450 void
 451 xfs_btree_setbuf(
 452         xfs_btree_cur_t         *cur,   /* btree cursor */
 453         int                     lev,    /* level in btree */
 454         struct xfs_buf          *bp);   /* new buffer to set */
 455
 456 #endif  /* __KERNEL__ */
 457
 458
 459 /*
 460  * Min and max functions for extlen, agblock, fileoff, and filblks types.
 461  */
 462 #define XFS_EXTLEN_MIN(a,b)     min_t(xfs_extlen_t, (a), (b))
 463 #define XFS_EXTLEN_MAX(a,b)     max_t(xfs_extlen_t, (a), (b))
 464 #define XFS_AGBLOCK_MIN(a,b)    min_t(xfs_agblock_t, (a), (b))
 465 #define XFS_AGBLOCK_MAX(a,b)    max_t(xfs_agblock_t, (a), (b))
 466 #define XFS_FILEOFF_MIN(a,b)    min_t(xfs_fileoff_t, (a), (b))
 467 #define XFS_FILEOFF_MAX(a,b)    max_t(xfs_fileoff_t, (a), (b))
 468 #define XFS_FILBLKS_MIN(a,b)    min_t(xfs_filblks_t, (a), (b))
 469 #define XFS_FILBLKS_MAX(a,b)    max_t(xfs_filblks_t, (a), (b))
 470
 471 #define XFS_FSB_SANITY_CHECK(mp,fsb)    \
 472         (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
 473                 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
 474
 475 #endif  /* __XFS_BTREE_H__ */