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  * Generic btree header.
  43  *
  44  * This is a combination of the actual format used on disk for short and long
  45  * format btrees.  The first three fields are shared by both format, but the
  46  * pointers are different and should be used with care.
  47  *
  48  * To get the size of the actual short or long form headers please use the size
  49  * macros below.  Never use sizeof(xfs_btree_block).
  50  *
  51  * The blkno, crc, lsn, owner and uuid fields are only available in filesystems
  52  * with the crc feature bit, and all accesses to them must be conditional on
  53  * that flag.
  54  */
  55 struct xfs_btree_block {
  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         union {
  60                 struct {
  61                         __be32          bb_leftsib;
  62                         __be32          bb_rightsib;
  63
  64                         __be64          bb_blkno;
  65                         __be64          bb_lsn;
  66                         uuid_t          bb_uuid;
  67                         __be32          bb_owner;
  68                         __le32          bb_crc;
  69                 } s;                    /* short form pointers */
  70                 struct  {
  71                         __be64          bb_leftsib;
  72                         __be64          bb_rightsib;
  73
  74                         __be64          bb_blkno;
  75                         __be64          bb_lsn;
  76                         uuid_t          bb_uuid;
  77                         __be64          bb_owner;
  78                         __le32          bb_crc;
  79                         __be32          bb_pad; /* padding for alignment */
  80                 } l;                    /* long form pointers */
  81         } bb_u;                         /* rest */
  82 };
  83
  84 #define XFS_BTREE_SBLOCK_LEN    16      /* size of a short form block */
  85 #define XFS_BTREE_LBLOCK_LEN    24      /* size of a long form block */
  86
  87 /* sizes of CRC enabled btree blocks */
  88 #define XFS_BTREE_SBLOCK_CRC_LEN        (XFS_BTREE_SBLOCK_LEN + 40)
  89 #define XFS_BTREE_LBLOCK_CRC_LEN        (XFS_BTREE_LBLOCK_LEN + 48)
  90
  91 #define XFS_BTREE_SBLOCK_CRC_OFF \
  92         offsetof(struct xfs_btree_block, bb_u.s.bb_crc)
  93 #define XFS_BTREE_LBLOCK_CRC_OFF \
  94         offsetof(struct xfs_btree_block, bb_u.l.bb_crc)
  95
  96 /*
  97  * Generic key, ptr and record wrapper structures.
  98  *
  99  * These are disk format structures, and are converted where necessary
 100  * by the btree specific code that needs to interpret them.
 101  */
 102 union xfs_btree_ptr {
 103         __be32                  s;      /* short form ptr */
 104         __be64                  l;      /* long form ptr */
 105 };
 106
 107 union xfs_btree_key {
 108         xfs_bmbt_key_t          bmbt;
 109         xfs_bmdr_key_t          bmbr;   /* bmbt root block */
 110         xfs_alloc_key_t         alloc;
 111         xfs_inobt_key_t         inobt;
 112 };
 113
 114 union xfs_btree_rec {
 115         xfs_bmbt_rec_t          bmbt;
 116         xfs_bmdr_rec_t          bmbr;   /* bmbt root block */
 117         xfs_alloc_rec_t         alloc;
 118         xfs_inobt_rec_t         inobt;
 119 };
 120
 121 /*
 122  * For logging record fields.
 123  */
 124 #define XFS_BB_MAGIC            0x01
 125 #define XFS_BB_LEVEL            0x02
 126 #define XFS_BB_NUMRECS          0x04
 127 #define XFS_BB_LEFTSIB          0x08
 128 #define XFS_BB_RIGHTSIB         0x10
 129 #define XFS_BB_BLKNO            0x20
 130 #define XFS_BB_NUM_BITS         5
 131 #define XFS_BB_ALL_BITS         ((1 << XFS_BB_NUM_BITS) - 1)
 132 #define XFS_BB_NUM_BITS_CRC     8
 133 #define XFS_BB_ALL_BITS_CRC     ((1 << XFS_BB_NUM_BITS_CRC) - 1)
 134
 135 /*
 136  * Generic stats interface
 137  */
 138 #define __XFS_BTREE_STATS_INC(type, stat) \
 139         XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
 140 #define XFS_BTREE_STATS_INC(cur, stat)  \
 141 do {    \
 142         switch (cur->bc_btnum) {  \
 143         case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break;   \
 144         case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break;   \
 145         case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break;  \
 146         case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break;    \
 147         case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;       \
 148         }       \
 149 } while (0)
 150
 151 #define __XFS_BTREE_STATS_ADD(type, stat, val) \
 152         XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
 153 #define XFS_BTREE_STATS_ADD(cur, stat, val)  \
 154 do {    \
 155         switch (cur->bc_btnum) {  \
 156         case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
 157         case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
 158         case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
 159         case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
 160         case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;       \
 161         }       \
 162 } while (0)
 163
 164 #define XFS_BTREE_MAXLEVELS     8       /* max of all btrees */
 165
 166 struct xfs_btree_ops {
 167         /* size of the key and record structures */
 168         size_t  key_len;
 169         size_t  rec_len;
 170
 171         /* cursor operations */
 172         struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
 173         void    (*update_cursor)(struct xfs_btree_cur *src,
 174                                  struct xfs_btree_cur *dst);
 175
 176         /* update btree root pointer */
 177         void    (*set_root)(struct xfs_btree_cur *cur,
 178                             union xfs_btree_ptr *nptr, int level_change);
 179
 180         /* block allocation / freeing */
 181         int     (*alloc_block)(struct xfs_btree_cur *cur,
 182                                union xfs_btree_ptr *start_bno,
 183                                union xfs_btree_ptr *new_bno,
 184                                int length, int *stat);
 185         int     (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
 186
 187         /* update last record information */
 188         void    (*update_lastrec)(struct xfs_btree_cur *cur,
 189                                   struct xfs_btree_block *block,
 190                                   union xfs_btree_rec *rec,
 191                                   int ptr, int reason);
 192
 193         /* records in block/level */
 194         int     (*get_minrecs)(struct xfs_btree_cur *cur, int level);
 195         int     (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
 196
 197         /* records on disk.  Matter for the root in inode case. */
 198         int     (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
 199
 200         /* init values of btree structures */
 201         void    (*init_key_from_rec)(union xfs_btree_key *key,
 202                                      union xfs_btree_rec *rec);
 203         void    (*init_rec_from_key)(union xfs_btree_key *key,
 204                                      union xfs_btree_rec *rec);
 205         void    (*init_rec_from_cur)(struct xfs_btree_cur *cur,
 206                                      union xfs_btree_rec *rec);
 207         void    (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
 208                                      union xfs_btree_ptr *ptr);
 209
 210         /* difference between key value and cursor value */
 211         __int64_t (*key_diff)(struct xfs_btree_cur *cur,
 212                               union xfs_btree_key *key);
 213
 214         const struct xfs_buf_ops        *buf_ops;
 215
 216 #if defined(DEBUG) || defined(XFS_WARN)
 217         /* check that k1 is lower than k2 */
 218         int     (*keys_inorder)(struct xfs_btree_cur *cur,
 219                                 union xfs_btree_key *k1,
 220                                 union xfs_btree_key *k2);
 221
 222         /* check that r1 is lower than r2 */
 223         int     (*recs_inorder)(struct xfs_btree_cur *cur,
 224                                 union xfs_btree_rec *r1,
 225                                 union xfs_btree_rec *r2);
 226 #endif
 227 };
 228
 229 /*
 230  * Reasons for the update_lastrec method to be called.
 231  */
 232 #define LASTREC_UPDATE  0
 233 #define LASTREC_INSREC  1
 234 #define LASTREC_DELREC  2
 235
 236
 237 /*
 238  * Btree cursor structure.
 239  * This collects all information needed by the btree code in one place.
 240  */
 241 typedef struct xfs_btree_cur
 242 {
 243         struct xfs_trans        *bc_tp; /* transaction we're in, if any */
 244         struct xfs_mount        *bc_mp; /* file system mount struct */
 245         const struct xfs_btree_ops *bc_ops;
 246         uint                    bc_flags; /* btree features - below */
 247         union {
 248                 xfs_alloc_rec_incore_t  a;
 249                 xfs_bmbt_irec_t         b;
 250                 xfs_inobt_rec_incore_t  i;
 251         }               bc_rec;         /* current insert/search record value */
 252         struct xfs_buf  *bc_bufs[XFS_BTREE_MAXLEVELS];  /* buf ptr per level */
 253         int             bc_ptrs[XFS_BTREE_MAXLEVELS];   /* key/record # */
 254         __uint8_t       bc_ra[XFS_BTREE_MAXLEVELS];     /* readahead bits */
 255 #define XFS_BTCUR_LEFTRA        1       /* left sibling has been read-ahead */
 256 #define XFS_BTCUR_RIGHTRA       2       /* right sibling has been read-ahead */
 257         __uint8_t       bc_nlevels;     /* number of levels in the tree */
 258         __uint8_t       bc_blocklog;    /* log2(blocksize) of btree blocks */
 259         xfs_btnum_t     bc_btnum;       /* identifies which btree type */
 260         union {
 261                 struct {                        /* needed for BNO, CNT, INO */
 262                         struct xfs_buf  *agbp;  /* agf/agi buffer pointer */
 263                         xfs_agnumber_t  agno;   /* ag number */
 264                 } a;
 265                 struct {                        /* needed for BMAP */
 266                         struct xfs_inode *ip;   /* pointer to our inode */
 267                         struct xfs_bmap_free *flist;    /* list to free after */
 268                         xfs_fsblock_t   firstblock;     /* 1st blk allocated */
 269                         int             allocated;      /* count of alloced */
 270                         short           forksize;       /* fork's inode space */
 271                         char            whichfork;      /* data or attr fork */
 272                         char            flags;          /* flags */
 273 #define XFS_BTCUR_BPRV_WASDEL   1                       /* was delayed */
 274                 } b;
 275         }               bc_private;     /* per-btree type data */
 276 } xfs_btree_cur_t;
 277
 278 /* cursor flags */
 279 #define XFS_BTREE_LONG_PTRS             (1<<0)  /* pointers are 64bits long */
 280 #define XFS_BTREE_ROOT_IN_INODE         (1<<1)  /* root may be variable size */
 281 #define XFS_BTREE_LASTREC_UPDATE        (1<<2)  /* track last rec externally */
 282 #define XFS_BTREE_CRC_BLOCKS            (1<<3)  /* uses extended btree blocks */
 283
 284
 285 #define XFS_BTREE_NOERROR       0
 286 #define XFS_BTREE_ERROR         1
 287
 288 /*
 289  * Convert from buffer to btree block header.
 290  */
 291 #define XFS_BUF_TO_BLOCK(bp)    ((struct xfs_btree_block *)((bp)->b_addr))
 292
 293
 294 /*
 295  * Check that block header is ok.
 296  */
 297 int
 298 xfs_btree_check_block(
 299         struct xfs_btree_cur    *cur,   /* btree cursor */
 300         struct xfs_btree_block  *block, /* generic btree block pointer */
 301         int                     level,  /* level of the btree block */
 302         struct xfs_buf          *bp);   /* buffer containing block, if any */
 303
 304 /*
 305  * Check that (long) pointer is ok.
 306  */
 307 int                                     /* error (0 or EFSCORRUPTED) */
 308 xfs_btree_check_lptr(
 309         struct xfs_btree_cur    *cur,   /* btree cursor */
 310         xfs_dfsbno_t            ptr,    /* btree block disk address */
 311         int                     level); /* btree block level */
 312
 313 /*
 314  * Delete the btree cursor.
 315  */
 316 void
 317 xfs_btree_del_cursor(
 318         xfs_btree_cur_t         *cur,   /* btree cursor */
 319         int                     error); /* del because of error */
 320
 321 /*
 322  * Duplicate the btree cursor.
 323  * Allocate a new one, copy the record, re-get the buffers.
 324  */
 325 int                                     /* error */
 326 xfs_btree_dup_cursor(
 327         xfs_btree_cur_t         *cur,   /* input cursor */
 328         xfs_btree_cur_t         **ncur);/* output cursor */
 329
 330 /*
 331  * Get a buffer for the block, return it with no data read.
 332  * Long-form addressing.
 333  */
 334 struct xfs_buf *                                /* buffer for fsbno */
 335 xfs_btree_get_bufl(
 336         struct xfs_mount        *mp,    /* file system mount point */
 337         struct xfs_trans        *tp,    /* transaction pointer */
 338         xfs_fsblock_t           fsbno,  /* file system block number */
 339         uint                    lock);  /* lock flags for get_buf */
 340
 341 /*
 342  * Get a buffer for the block, return it with no data read.
 343  * Short-form addressing.
 344  */
 345 struct xfs_buf *                                /* buffer for agno/agbno */
 346 xfs_btree_get_bufs(
 347         struct xfs_mount        *mp,    /* file system mount point */
 348         struct xfs_trans        *tp,    /* transaction pointer */
 349         xfs_agnumber_t          agno,   /* allocation group number */
 350         xfs_agblock_t           agbno,  /* allocation group block number */
 351         uint                    lock);  /* lock flags for get_buf */
 352
 353 /*
 354  * Check for the cursor referring to the last block at the given level.
 355  */
 356 int                                     /* 1=is last block, 0=not last block */
 357 xfs_btree_islastblock(
 358         xfs_btree_cur_t         *cur,   /* btree cursor */
 359         int                     level); /* level to check */
 360
 361 /*
 362  * Compute first and last byte offsets for the fields given.
 363  * Interprets the offsets table, which contains struct field offsets.
 364  */
 365 void
 366 xfs_btree_offsets(
 367         __int64_t               fields, /* bitmask of fields */
 368         const short             *offsets,/* table of field offsets */
 369         int                     nbits,  /* number of bits to inspect */
 370         int                     *first, /* output: first byte offset */
 371         int                     *last); /* output: last byte offset */
 372
 373 /*
 374  * Get a buffer for the block, return it read in.
 375  * Long-form addressing.
 376  */
 377 int                                     /* error */
 378 xfs_btree_read_bufl(
 379         struct xfs_mount        *mp,    /* file system mount point */
 380         struct xfs_trans        *tp,    /* transaction pointer */
 381         xfs_fsblock_t           fsbno,  /* file system block number */
 382         uint                    lock,   /* lock flags for read_buf */
 383         struct xfs_buf          **bpp,  /* buffer for fsbno */
 384         int                     refval, /* ref count value for buffer */
 385         const struct xfs_buf_ops *ops);
 386
 387 /*
 388  * Read-ahead the block, don't wait for it, don't return a buffer.
 389  * Long-form addressing.
 390  */
 391 void                                    /* error */
 392 xfs_btree_reada_bufl(
 393         struct xfs_mount        *mp,    /* file system mount point */
 394         xfs_fsblock_t           fsbno,  /* file system block number */
 395         xfs_extlen_t            count,  /* count of filesystem blocks */
 396         const struct xfs_buf_ops *ops);
 397
 398 /*
 399  * Read-ahead the block, don't wait for it, don't return a buffer.
 400  * Short-form addressing.
 401  */
 402 void                                    /* error */
 403 xfs_btree_reada_bufs(
 404         struct xfs_mount        *mp,    /* file system mount point */
 405         xfs_agnumber_t          agno,   /* allocation group number */
 406         xfs_agblock_t           agbno,  /* allocation group block number */
 407         xfs_extlen_t            count,  /* count of filesystem blocks */
 408         const struct xfs_buf_ops *ops);
 409
 410 /*
 411  * Initialise a new btree block header
 412  */
 413 void
 414 xfs_btree_init_block(
 415         struct xfs_mount *mp,
 416         struct xfs_buf  *bp,
 417         __u32           magic,
 418         __u16           level,
 419         __u16           numrecs,
 420         __u64           owner,
 421         unsigned int    flags);
 422
 423 void
 424 xfs_btree_init_block_int(
 425         struct xfs_mount        *mp,
 426         struct xfs_btree_block  *buf,
 427         xfs_daddr_t             blkno,
 428         __u32                   magic,
 429         __u16                   level,
 430         __u16                   numrecs,
 431         __u64                   owner,
 432         unsigned int            flags);
 433
 434 /*
 435  * Common btree core entry points.
 436  */
 437 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
 438 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
 439 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
 440 int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
 441 int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
 442 int xfs_btree_insert(struct xfs_btree_cur *, int *);
 443 int xfs_btree_delete(struct xfs_btree_cur *, int *);
 444 int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
 445
 446 /*
 447  * btree block CRC helpers
 448  */
 449 void xfs_btree_lblock_calc_crc(struct xfs_buf *);
 450 bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
 451 void xfs_btree_sblock_calc_crc(struct xfs_buf *);
 452 bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
 453
 454 /*
 455  * Internal btree helpers also used by xfs_bmap.c.
 456  */
 457 void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
 458 void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
 459
 460 /*
 461  * Helpers.
 462  */
 463 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
 464 {
 465         return be16_to_cpu(block->bb_numrecs);
 466 }
 467
 468 static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
 469                 __uint16_t numrecs)
 470 {
 471         block->bb_numrecs = cpu_to_be16(numrecs);
 472 }
 473
 474 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
 475 {
 476         return be16_to_cpu(block->bb_level);
 477 }
 478
 479
 480 /*
 481  * Min and max functions for extlen, agblock, fileoff, and filblks types.
 482  */
 483 #define XFS_EXTLEN_MIN(a,b)     min_t(xfs_extlen_t, (a), (b))
 484 #define XFS_EXTLEN_MAX(a,b)     max_t(xfs_extlen_t, (a), (b))
 485 #define XFS_AGBLOCK_MIN(a,b)    min_t(xfs_agblock_t, (a), (b))
 486 #define XFS_AGBLOCK_MAX(a,b)    max_t(xfs_agblock_t, (a), (b))
 487 #define XFS_FILEOFF_MIN(a,b)    min_t(xfs_fileoff_t, (a), (b))
 488 #define XFS_FILEOFF_MAX(a,b)    max_t(xfs_fileoff_t, (a), (b))
 489 #define XFS_FILBLKS_MIN(a,b)    min_t(xfs_filblks_t, (a), (b))
 490 #define XFS_FILBLKS_MAX(a,b)    max_t(xfs_filblks_t, (a), (b))
 491
 492 #define XFS_FSB_SANITY_CHECK(mp,fsb)    \
 493         (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
 494                 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
 495
 496 /*
 497  * Trace hooks.  Currently not implemented as they need to be ported
 498  * over to the generic tracing functionality, which is some effort.
 499  *
 500  * i,j = integer (32 bit)
 501  * b = btree block buffer (xfs_buf_t)
 502  * p = btree ptr
 503  * r = btree record
 504  * k = btree key
 505  */
 506 #define XFS_BTREE_TRACE_ARGBI(c, b, i)
 507 #define XFS_BTREE_TRACE_ARGBII(c, b, i, j)
 508 #define XFS_BTREE_TRACE_ARGI(c, i)
 509 #define XFS_BTREE_TRACE_ARGIPK(c, i, p, s)
 510 #define XFS_BTREE_TRACE_ARGIPR(c, i, p, r)
 511 #define XFS_BTREE_TRACE_ARGIK(c, i, k)
 512 #define XFS_BTREE_TRACE_ARGR(c, r)
 513 #define XFS_BTREE_TRACE_CURSOR(c, t)
 514
 515 #endif  /* __XFS_BTREE_H__ */