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