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  * Magic numbers for btree blocks.
 120  */
 121 extern const __uint32_t xfs_magics[];
 122
 123 /*
 124  * Generic stats interface
 125  */
 126 #define __XFS_BTREE_STATS_INC(type, stat) \
 127         XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
 128 #define XFS_BTREE_STATS_INC(cur, stat)  \
 129 do {    \
 130         switch (cur->bc_btnum) {  \
 131         case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break;   \
 132         case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break;   \
 133         case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break;  \
 134         case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break;    \
 135         case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;       \
 136         }       \
 137 } while (0)
 138
 139 #define __XFS_BTREE_STATS_ADD(type, stat, val) \
 140         XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
 141 #define XFS_BTREE_STATS_ADD(cur, stat, val)  \
 142 do {    \
 143         switch (cur->bc_btnum) {  \
 144         case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
 145         case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
 146         case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
 147         case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
 148         case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;       \
 149         }       \
 150 } while (0)
 151 /*
 152  * Maximum and minimum records in a btree block.
 153  * Given block size, type prefix, and leaf flag (0 or 1).
 154  * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
 155  * compiler warnings.
 156  */
 157 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf)       \
 158         ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
 159          (((lf) * (uint)sizeof(t ## _rec_t)) + \
 160           ((1 - (lf)) * \
 161            ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
 162 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf)       \
 163         (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
 164
 165 /*
 166  * Record, key, and pointer address calculation macros.
 167  * Given block size, type prefix, block pointer, and index of requested entry
 168  * (first entry numbered 1).
 169  */
 170 #define XFS_BTREE_REC_ADDR(t,bb,i)      \
 171         ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
 172          ((i) - 1) * sizeof(t ## _rec_t)))
 173 #define XFS_BTREE_KEY_ADDR(t,bb,i)      \
 174         ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
 175          ((i) - 1) * sizeof(t ## _key_t)))
 176 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr)  \
 177         ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
 178          (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
 179
 180 #define XFS_BTREE_MAXLEVELS     8       /* max of all btrees */
 181
 182 struct xfs_btree_ops {
 183         /* cursor operations */
 184         struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
 185
 186         /* records in block/level */
 187         int     (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
 188
 189         /* btree tracing */
 190 #ifdef XFS_BTREE_TRACE
 191         void            (*trace_enter)(struct xfs_btree_cur *, const char *,
 192                                        char *, int, int, __psunsigned_t,
 193                                        __psunsigned_t, __psunsigned_t,
 194                                        __psunsigned_t, __psunsigned_t,
 195                                        __psunsigned_t, __psunsigned_t,
 196                                        __psunsigned_t, __psunsigned_t,
 197                                        __psunsigned_t, __psunsigned_t);
 198         void            (*trace_cursor)(struct xfs_btree_cur *, __uint32_t *,
 199                                         __uint64_t *, __uint64_t *);
 200         void            (*trace_key)(struct xfs_btree_cur *,
 201                                      union xfs_btree_key *, __uint64_t *,
 202                                      __uint64_t *);
 203         void            (*trace_record)(struct xfs_btree_cur *,
 204                                         union xfs_btree_rec *, __uint64_t *,
 205                                         __uint64_t *, __uint64_t *);
 206 #endif
 207 };
 208
 209 /*
 210  * Btree cursor structure.
 211  * This collects all information needed by the btree code in one place.
 212  */
 213 typedef struct xfs_btree_cur
 214 {
 215         struct xfs_trans        *bc_tp; /* transaction we're in, if any */
 216         struct xfs_mount        *bc_mp; /* file system mount struct */
 217         const struct xfs_btree_ops *bc_ops;
 218         uint                    bc_flags; /* btree features - below */
 219         union {
 220                 xfs_alloc_rec_incore_t  a;
 221                 xfs_bmbt_irec_t         b;
 222                 xfs_inobt_rec_incore_t  i;
 223         }               bc_rec;         /* current insert/search record value */
 224         struct xfs_buf  *bc_bufs[XFS_BTREE_MAXLEVELS];  /* buf ptr per level */
 225         int             bc_ptrs[XFS_BTREE_MAXLEVELS];   /* key/record # */
 226         __uint8_t       bc_ra[XFS_BTREE_MAXLEVELS];     /* readahead bits */
 227 #define XFS_BTCUR_LEFTRA        1       /* left sibling has been read-ahead */
 228 #define XFS_BTCUR_RIGHTRA       2       /* right sibling has been read-ahead */
 229         __uint8_t       bc_nlevels;     /* number of levels in the tree */
 230         __uint8_t       bc_blocklog;    /* log2(blocksize) of btree blocks */
 231         xfs_btnum_t     bc_btnum;       /* identifies which btree type */
 232         union {
 233                 struct {                        /* needed for BNO, CNT, INO */
 234                         struct xfs_buf  *agbp;  /* agf/agi buffer pointer */
 235                         xfs_agnumber_t  agno;   /* ag number */
 236                 } a;
 237                 struct {                        /* needed for BMAP */
 238                         struct xfs_inode *ip;   /* pointer to our inode */
 239                         struct xfs_bmap_free *flist;    /* list to free after */
 240                         xfs_fsblock_t   firstblock;     /* 1st blk allocated */
 241                         int             allocated;      /* count of alloced */
 242                         short           forksize;       /* fork's inode space */
 243                         char            whichfork;      /* data or attr fork */
 244                         char            flags;          /* flags */
 245 #define XFS_BTCUR_BPRV_WASDEL   1                       /* was delayed */
 246                 } b;
 247         }               bc_private;     /* per-btree type data */
 248 } xfs_btree_cur_t;
 249
 250 /* cursor flags */
 251 #define XFS_BTREE_LONG_PTRS             (1<<0)  /* pointers are 64bits long */
 252 #define XFS_BTREE_ROOT_IN_INODE         (1<<1)  /* root may be variable size */
 253
 254
 255 #define XFS_BTREE_NOERROR       0
 256 #define XFS_BTREE_ERROR         1
 257
 258 /*
 259  * Convert from buffer to btree block header.
 260  */
 261 #define XFS_BUF_TO_BLOCK(bp)    ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
 262 #define XFS_BUF_TO_LBLOCK(bp)   ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
 263 #define XFS_BUF_TO_SBLOCK(bp)   ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
 264
 265
 266 #ifdef __KERNEL__
 267
 268 /*
 269  * Check that long form block header is ok.
 270  */
 271 int                                     /* error (0 or EFSCORRUPTED) */
 272 xfs_btree_check_lblock(
 273         struct xfs_btree_cur    *cur,   /* btree cursor */
 274         struct xfs_btree_lblock *block, /* btree long form block pointer */
 275         int                     level,  /* level of the btree block */
 276         struct xfs_buf          *bp);   /* buffer containing block, if any */
 277
 278 /*
 279  * Check that short form block header is ok.
 280  */
 281 int                                     /* error (0 or EFSCORRUPTED) */
 282 xfs_btree_check_sblock(
 283         struct xfs_btree_cur    *cur,   /* btree cursor */
 284         struct xfs_btree_sblock *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  * Check that block header is ok.
 290  */
 291 int
 292 xfs_btree_check_block(
 293         struct xfs_btree_cur    *cur,   /* btree cursor */
 294         struct xfs_btree_block  *block, /* generic btree block pointer */
 295         int                     level,  /* level of the btree block */
 296         struct xfs_buf          *bp);   /* buffer containing block, if any */
 297
 298 /*
 299  * Check that (long) pointer is ok.
 300  */
 301 int                                     /* error (0 or EFSCORRUPTED) */
 302 xfs_btree_check_lptr(
 303         struct xfs_btree_cur    *cur,   /* btree cursor */
 304         xfs_dfsbno_t            ptr,    /* btree block disk address */
 305         int                     level); /* btree block level */
 306
 307 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
 308         xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
 309
 310
 311 /*
 312  * Check that (short) pointer is ok.
 313  */
 314 int                                     /* error (0 or EFSCORRUPTED) */
 315 xfs_btree_check_sptr(
 316         struct xfs_btree_cur    *cur,   /* btree cursor */
 317         xfs_agblock_t           ptr,    /* btree block disk address */
 318         int                     level); /* btree block level */
 319
 320 /*
 321  * Check that (short) pointer is ok.
 322  */
 323 int                                     /* error (0 or EFSCORRUPTED) */
 324 xfs_btree_check_ptr(
 325         struct xfs_btree_cur    *cur,   /* btree cursor */
 326         union xfs_btree_ptr     *ptr,   /* btree block disk address */
 327         int                     index,  /* offset from ptr to check */
 328         int                     level); /* btree block level */
 329
 330 #ifdef DEBUG
 331
 332 /*
 333  * Debug routine: check that keys are in the right order.
 334  */
 335 void
 336 xfs_btree_check_key(
 337         xfs_btnum_t             btnum,  /* btree identifier */
 338         void                    *ak1,   /* pointer to left (lower) key */
 339         void                    *ak2);  /* pointer to right (higher) key */
 340
 341 /*
 342  * Debug routine: check that records are in the right order.
 343  */
 344 void
 345 xfs_btree_check_rec(
 346         xfs_btnum_t             btnum,  /* btree identifier */
 347         void                    *ar1,   /* pointer to left (lower) record */
 348         void                    *ar2);  /* pointer to right (higher) record */
 349 #else
 350 #define xfs_btree_check_key(a, b, c)
 351 #define xfs_btree_check_rec(a, b, c)
 352 #endif  /* DEBUG */
 353
 354 /*
 355  * Delete the btree cursor.
 356  */
 357 void
 358 xfs_btree_del_cursor(
 359         xfs_btree_cur_t         *cur,   /* btree cursor */
 360         int                     error); /* del because of error */
 361
 362 /*
 363  * Duplicate the btree cursor.
 364  * Allocate a new one, copy the record, re-get the buffers.
 365  */
 366 int                                     /* error */
 367 xfs_btree_dup_cursor(
 368         xfs_btree_cur_t         *cur,   /* input cursor */
 369         xfs_btree_cur_t         **ncur);/* output cursor */
 370
 371 /*
 372  * Change the cursor to point to the first record in the current block
 373  * at the given level.  Other levels are unaffected.
 374  */
 375 int                                     /* success=1, failure=0 */
 376 xfs_btree_firstrec(
 377         xfs_btree_cur_t         *cur,   /* btree cursor */
 378         int                     level); /* level to change */
 379
 380 /*
 381  * Get a buffer for the block, return it with no data read.
 382  * Long-form addressing.
 383  */
 384 struct xfs_buf *                                /* buffer for fsbno */
 385 xfs_btree_get_bufl(
 386         struct xfs_mount        *mp,    /* file system mount point */
 387         struct xfs_trans        *tp,    /* transaction pointer */
 388         xfs_fsblock_t           fsbno,  /* file system block number */
 389         uint                    lock);  /* lock flags for get_buf */
 390
 391 /*
 392  * Get a buffer for the block, return it with no data read.
 393  * Short-form addressing.
 394  */
 395 struct xfs_buf *                                /* buffer for agno/agbno */
 396 xfs_btree_get_bufs(
 397         struct xfs_mount        *mp,    /* file system mount point */
 398         struct xfs_trans        *tp,    /* transaction pointer */
 399         xfs_agnumber_t          agno,   /* allocation group number */
 400         xfs_agblock_t           agbno,  /* allocation group block number */
 401         uint                    lock);  /* lock flags for get_buf */
 402
 403 /*
 404  * Check for the cursor referring to the last block at the given level.
 405  */
 406 int                                     /* 1=is last block, 0=not last block */
 407 xfs_btree_islastblock(
 408         xfs_btree_cur_t         *cur,   /* btree cursor */
 409         int                     level); /* level to check */
 410
 411 /*
 412  * Change the cursor to point to the last record in the current block
 413  * at the given level.  Other levels are unaffected.
 414  */
 415 int                                     /* success=1, failure=0 */
 416 xfs_btree_lastrec(
 417         xfs_btree_cur_t         *cur,   /* btree cursor */
 418         int                     level); /* level to change */
 419
 420 /*
 421  * Compute first and last byte offsets for the fields given.
 422  * Interprets the offsets table, which contains struct field offsets.
 423  */
 424 void
 425 xfs_btree_offsets(
 426         __int64_t               fields, /* bitmask of fields */
 427         const short             *offsets,/* table of field offsets */
 428         int                     nbits,  /* number of bits to inspect */
 429         int                     *first, /* output: first byte offset */
 430         int                     *last); /* output: last byte offset */
 431
 432 /*
 433  * Get a buffer for the block, return it read in.
 434  * Long-form addressing.
 435  */
 436 int                                     /* error */
 437 xfs_btree_read_bufl(
 438         struct xfs_mount        *mp,    /* file system mount point */
 439         struct xfs_trans        *tp,    /* transaction pointer */
 440         xfs_fsblock_t           fsbno,  /* file system block number */
 441         uint                    lock,   /* lock flags for read_buf */
 442         struct xfs_buf          **bpp,  /* buffer for fsbno */
 443         int                     refval);/* ref count value for buffer */
 444
 445 /*
 446  * Get a buffer for the block, return it read in.
 447  * Short-form addressing.
 448  */
 449 int                                     /* error */
 450 xfs_btree_read_bufs(
 451         struct xfs_mount        *mp,    /* file system mount point */
 452         struct xfs_trans        *tp,    /* transaction pointer */
 453         xfs_agnumber_t          agno,   /* allocation group number */
 454         xfs_agblock_t           agbno,  /* allocation group block number */
 455         uint                    lock,   /* lock flags for read_buf */
 456         struct xfs_buf          **bpp,  /* buffer for agno/agbno */
 457         int                     refval);/* ref count value for buffer */
 458
 459 /*
 460  * Read-ahead the block, don't wait for it, don't return a buffer.
 461  * Long-form addressing.
 462  */
 463 void                                    /* error */
 464 xfs_btree_reada_bufl(
 465         struct xfs_mount        *mp,    /* file system mount point */
 466         xfs_fsblock_t           fsbno,  /* file system block number */
 467         xfs_extlen_t            count); /* count of filesystem blocks */
 468
 469 /*
 470  * Read-ahead the block, don't wait for it, don't return a buffer.
 471  * Short-form addressing.
 472  */
 473 void                                    /* error */
 474 xfs_btree_reada_bufs(
 475         struct xfs_mount        *mp,    /* file system mount point */
 476         xfs_agnumber_t          agno,   /* allocation group number */
 477         xfs_agblock_t           agbno,  /* allocation group block number */
 478         xfs_extlen_t            count); /* count of filesystem blocks */
 479
 480 /*
 481  * Read-ahead btree blocks, at the given level.
 482  * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
 483  */
 484 int                                     /* readahead block count */
 485 xfs_btree_readahead(
 486         xfs_btree_cur_t         *cur,   /* btree cursor */
 487         int                     lev,    /* level in btree */
 488         int                     lr);    /* left/right bits */
 489
 490 /*
 491  * Set the buffer for level "lev" in the cursor to bp, releasing
 492  * any previous buffer.
 493  */
 494 void
 495 xfs_btree_setbuf(
 496         xfs_btree_cur_t         *cur,   /* btree cursor */
 497         int                     lev,    /* level in btree */
 498         struct xfs_buf          *bp);   /* new buffer to set */
 499
 500 #endif  /* __KERNEL__ */
 501
 502
 503 /*
 504  * Min and max functions for extlen, agblock, fileoff, and filblks types.
 505  */
 506 #define XFS_EXTLEN_MIN(a,b)     min_t(xfs_extlen_t, (a), (b))
 507 #define XFS_EXTLEN_MAX(a,b)     max_t(xfs_extlen_t, (a), (b))
 508 #define XFS_AGBLOCK_MIN(a,b)    min_t(xfs_agblock_t, (a), (b))
 509 #define XFS_AGBLOCK_MAX(a,b)    max_t(xfs_agblock_t, (a), (b))
 510 #define XFS_FILEOFF_MIN(a,b)    min_t(xfs_fileoff_t, (a), (b))
 511 #define XFS_FILEOFF_MAX(a,b)    max_t(xfs_fileoff_t, (a), (b))
 512 #define XFS_FILBLKS_MIN(a,b)    min_t(xfs_filblks_t, (a), (b))
 513 #define XFS_FILBLKS_MAX(a,b)    max_t(xfs_filblks_t, (a), (b))
 514
 515 #define XFS_FSB_SANITY_CHECK(mp,fsb)    \
 516         (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
 517                 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
 518
 519 #endif  /* __XFS_BTREE_H__ */