1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc. 4 * All Rights Reserved. 5 */ 6#ifndef __XFS_BTREE_H__ 7#define __XFS_BTREE_H__ 8 9struct xfs_buf; 10struct xfs_inode; 11struct xfs_mount; 12struct xfs_trans; 13struct xfs_ifork; 14 15extern kmem_zone_t *xfs_btree_cur_zone; 16 17/* 18 * Generic key, ptr and record wrapper structures. 19 * 20 * These are disk format structures, and are converted where necessary 21 * by the btree specific code that needs to interpret them. 22 */ 23union xfs_btree_ptr { 24 __be32 s; /* short form ptr */ 25 __be64 l; /* long form ptr */ 26}; 27 28/* 29 * The in-core btree key. Overlapping btrees actually store two keys 30 * per pointer, so we reserve enough memory to hold both. The __*bigkey 31 * items should never be accessed directly. 32 */ 33union xfs_btree_key { 34 struct xfs_bmbt_key bmbt; 35 xfs_bmdr_key_t bmbr; /* bmbt root block */ 36 xfs_alloc_key_t alloc; 37 struct xfs_inobt_key inobt; 38 struct xfs_rmap_key rmap; 39 struct xfs_rmap_key __rmap_bigkey[2]; 40 struct xfs_refcount_key refc; 41}; 42 43union xfs_btree_rec { 44 struct xfs_bmbt_rec bmbt; 45 xfs_bmdr_rec_t bmbr; /* bmbt root block */ 46 struct xfs_alloc_rec alloc; 47 struct xfs_inobt_rec inobt; 48 struct xfs_rmap_rec rmap; 49 struct xfs_refcount_rec refc; 50}; 51 52/* 53 * This nonsense is to make -wlint happy. 54 */ 55#define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) 56#define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) 57#define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) 58 59#define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) 60#define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) 61#define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) 62#define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) 63#define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi) 64#define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi) 65#define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi) 66 67uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum); 68 69/* 70 * For logging record fields. 71 */ 72#define XFS_BB_MAGIC (1 << 0) 73#define XFS_BB_LEVEL (1 << 1) 74#define XFS_BB_NUMRECS (1 << 2) 75#define XFS_BB_LEFTSIB (1 << 3) 76#define XFS_BB_RIGHTSIB (1 << 4) 77#define XFS_BB_BLKNO (1 << 5) 78#define XFS_BB_LSN (1 << 6) 79#define XFS_BB_UUID (1 << 7) 80#define XFS_BB_OWNER (1 << 8) 81#define XFS_BB_NUM_BITS 5 82#define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) 83#define XFS_BB_NUM_BITS_CRC 9 84#define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1) 85 86/* 87 * Generic stats interface 88 */ 89#define XFS_BTREE_STATS_INC(cur, stat) \ 90 XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat) 91#define XFS_BTREE_STATS_ADD(cur, stat, val) \ 92 XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val) 93 94#define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */ 95 96struct xfs_btree_ops { 97 /* size of the key and record structures */ 98 size_t key_len; 99 size_t rec_len; 100 101 /* cursor operations */ 102 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *); 103 void (*update_cursor)(struct xfs_btree_cur *src, 104 struct xfs_btree_cur *dst); 105 106 /* update btree root pointer */ 107 void (*set_root)(struct xfs_btree_cur *cur, 108 union xfs_btree_ptr *nptr, int level_change); 109 110 /* block allocation / freeing */ 111 int (*alloc_block)(struct xfs_btree_cur *cur, 112 union xfs_btree_ptr *start_bno, 113 union xfs_btree_ptr *new_bno, 114 int *stat); 115 int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp); 116 117 /* update last record information */ 118 void (*update_lastrec)(struct xfs_btree_cur *cur, 119 struct xfs_btree_block *block, 120 union xfs_btree_rec *rec, 121 int ptr, int reason); 122 123 /* records in block/level */ 124 int (*get_minrecs)(struct xfs_btree_cur *cur, int level); 125 int (*get_maxrecs)(struct xfs_btree_cur *cur, int level); 126 127 /* records on disk. Matter for the root in inode case. */ 128 int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level); 129 130 /* init values of btree structures */ 131 void (*init_key_from_rec)(union xfs_btree_key *key, 132 union xfs_btree_rec *rec); 133 void (*init_rec_from_cur)(struct xfs_btree_cur *cur, 134 union xfs_btree_rec *rec); 135 void (*init_ptr_from_cur)(struct xfs_btree_cur *cur, 136 union xfs_btree_ptr *ptr); 137 void (*init_high_key_from_rec)(union xfs_btree_key *key, 138 union xfs_btree_rec *rec); 139 140 /* difference between key value and cursor value */ 141 int64_t (*key_diff)(struct xfs_btree_cur *cur, 142 union xfs_btree_key *key); 143 144 /* 145 * Difference between key2 and key1 -- positive if key1 > key2, 146 * negative if key1 < key2, and zero if equal. 147 */ 148 int64_t (*diff_two_keys)(struct xfs_btree_cur *cur, 149 union xfs_btree_key *key1, 150 union xfs_btree_key *key2); 151 152 const struct xfs_buf_ops *buf_ops; 153 154 /* check that k1 is lower than k2 */ 155 int (*keys_inorder)(struct xfs_btree_cur *cur, 156 union xfs_btree_key *k1, 157 union xfs_btree_key *k2); 158 159 /* check that r1 is lower than r2 */ 160 int (*recs_inorder)(struct xfs_btree_cur *cur, 161 union xfs_btree_rec *r1, 162 union xfs_btree_rec *r2); 163}; 164 165/* 166 * Reasons for the update_lastrec method to be called. 167 */ 168#define LASTREC_UPDATE 0 169#define LASTREC_INSREC 1 170#define LASTREC_DELREC 2 171 172 173union xfs_btree_irec { 174 struct xfs_alloc_rec_incore a; 175 struct xfs_bmbt_irec b; 176 struct xfs_inobt_rec_incore i; 177 struct xfs_rmap_irec r; 178 struct xfs_refcount_irec rc; 179}; 180 181/* Per-AG btree information. */ 182struct xfs_btree_cur_ag { 183 union { 184 struct xfs_buf *agbp; 185 struct xbtree_afakeroot *afake; /* for staging cursor */ 186 }; 187 xfs_agnumber_t agno; 188 union { 189 struct { 190 unsigned long nr_ops; /* # record updates */ 191 int shape_changes; /* # of extent splits */ 192 } refc; 193 struct { 194 bool active; /* allocation cursor state */ 195 } abt; 196 }; 197}; 198 199/* Btree-in-inode cursor information */ 200struct xfs_btree_cur_ino { 201 struct xfs_inode *ip; 202 struct xbtree_ifakeroot *ifake; /* for staging cursor */ 203 int allocated; 204 short forksize; 205 char whichfork; 206 char flags; 207/* We are converting a delalloc reservation */ 208#define XFS_BTCUR_BMBT_WASDEL (1 << 0) 209 210/* For extent swap, ignore owner check in verifier */ 211#define XFS_BTCUR_BMBT_INVALID_OWNER (1 << 1) 212}; 213 214/* 215 * Btree cursor structure. 216 * This collects all information needed by the btree code in one place. 217 */ 218typedef struct xfs_btree_cur 219{ 220 struct xfs_trans *bc_tp; /* transaction we're in, if any */ 221 struct xfs_mount *bc_mp; /* file system mount struct */ 222 const struct xfs_btree_ops *bc_ops; 223 uint bc_flags; /* btree features - below */ 224 union xfs_btree_irec bc_rec; /* current insert/search record value */ 225 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ 226 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ 227 uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ 228#define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ 229#define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ 230 uint8_t bc_nlevels; /* number of levels in the tree */ 231 uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ 232 xfs_btnum_t bc_btnum; /* identifies which btree type */ 233 int bc_statoff; /* offset of btre stats array */ 234 union { 235 struct xfs_btree_cur_ag bc_ag; 236 struct xfs_btree_cur_ino bc_ino; 237 }; 238} xfs_btree_cur_t; 239 240/* cursor flags */ 241#define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */ 242#define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */ 243#define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */ 244#define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */ 245#define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */ 246/* 247 * The root of this btree is a fakeroot structure so that we can stage a btree 248 * rebuild without leaving it accessible via primary metadata. The ops struct 249 * is dynamically allocated and must be freed when the cursor is deleted. 250 */ 251#define XFS_BTREE_STAGING (1<<5) 252 253 254#define XFS_BTREE_NOERROR 0 255#define XFS_BTREE_ERROR 1 256 257/* 258 * Convert from buffer to btree block header. 259 */ 260#define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr)) 261 262/* 263 * Internal long and short btree block checks. They return NULL if the 264 * block is ok or the address of the failed check otherwise. 265 */ 266xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur, 267 struct xfs_btree_block *block, int level, struct xfs_buf *bp); 268xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur, 269 struct xfs_btree_block *block, int level, struct xfs_buf *bp); 270 271/* 272 * Check that block header is ok. 273 */ 274int 275xfs_btree_check_block( 276 struct xfs_btree_cur *cur, /* btree cursor */ 277 struct xfs_btree_block *block, /* generic btree block pointer */ 278 int level, /* level of the btree block */ 279 struct xfs_buf *bp); /* buffer containing block, if any */ 280 281/* 282 * Check that (long) pointer is ok. 283 */ 284bool /* error (0 or EFSCORRUPTED) */ 285xfs_btree_check_lptr( 286 struct xfs_btree_cur *cur, /* btree cursor */ 287 xfs_fsblock_t fsbno, /* btree block disk address */ 288 int level); /* btree block level */ 289 290/* 291 * Check that (short) pointer is ok. 292 */ 293bool /* error (0 or EFSCORRUPTED) */ 294xfs_btree_check_sptr( 295 struct xfs_btree_cur *cur, /* btree cursor */ 296 xfs_agblock_t agbno, /* btree block disk address */ 297 int level); /* btree block level */ 298 299/* 300 * Delete the btree cursor. 301 */ 302void 303xfs_btree_del_cursor( 304 xfs_btree_cur_t *cur, /* btree cursor */ 305 int error); /* del because of error */ 306 307/* 308 * Duplicate the btree cursor. 309 * Allocate a new one, copy the record, re-get the buffers. 310 */ 311int /* error */ 312xfs_btree_dup_cursor( 313 xfs_btree_cur_t *cur, /* input cursor */ 314 xfs_btree_cur_t **ncur);/* output cursor */ 315 316/* 317 * Compute first and last byte offsets for the fields given. 318 * Interprets the offsets table, which contains struct field offsets. 319 */ 320void 321xfs_btree_offsets( 322 int64_t fields, /* bitmask of fields */ 323 const short *offsets,/* table of field offsets */ 324 int nbits, /* number of bits to inspect */ 325 int *first, /* output: first byte offset */ 326 int *last); /* output: last byte offset */ 327 328/* 329 * Get a buffer for the block, return it read in. 330 * Long-form addressing. 331 */ 332int /* error */ 333xfs_btree_read_bufl( 334 struct xfs_mount *mp, /* file system mount point */ 335 struct xfs_trans *tp, /* transaction pointer */ 336 xfs_fsblock_t fsbno, /* file system block number */ 337 struct xfs_buf **bpp, /* buffer for fsbno */ 338 int refval, /* ref count value for buffer */ 339 const struct xfs_buf_ops *ops); 340 341/* 342 * Read-ahead the block, don't wait for it, don't return a buffer. 343 * Long-form addressing. 344 */ 345void /* error */ 346xfs_btree_reada_bufl( 347 struct xfs_mount *mp, /* file system mount point */ 348 xfs_fsblock_t fsbno, /* file system block number */ 349 xfs_extlen_t count, /* count of filesystem blocks */ 350 const struct xfs_buf_ops *ops); 351 352/* 353 * Read-ahead the block, don't wait for it, don't return a buffer. 354 * Short-form addressing. 355 */ 356void /* error */ 357xfs_btree_reada_bufs( 358 struct xfs_mount *mp, /* file system mount point */ 359 xfs_agnumber_t agno, /* allocation group number */ 360 xfs_agblock_t agbno, /* allocation group block number */ 361 xfs_extlen_t count, /* count of filesystem blocks */ 362 const struct xfs_buf_ops *ops); 363 364/* 365 * Initialise a new btree block header 366 */ 367void 368xfs_btree_init_block( 369 struct xfs_mount *mp, 370 struct xfs_buf *bp, 371 xfs_btnum_t btnum, 372 __u16 level, 373 __u16 numrecs, 374 __u64 owner); 375 376void 377xfs_btree_init_block_int( 378 struct xfs_mount *mp, 379 struct xfs_btree_block *buf, 380 xfs_daddr_t blkno, 381 xfs_btnum_t btnum, 382 __u16 level, 383 __u16 numrecs, 384 __u64 owner, 385 unsigned int flags); 386 387/* 388 * Common btree core entry points. 389 */ 390int xfs_btree_increment(struct xfs_btree_cur *, int, int *); 391int xfs_btree_decrement(struct xfs_btree_cur *, int, int *); 392int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *); 393int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *); 394int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *); 395int xfs_btree_insert(struct xfs_btree_cur *, int *); 396int xfs_btree_delete(struct xfs_btree_cur *, int *); 397int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *); 398int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner, 399 struct list_head *buffer_list); 400 401/* 402 * btree block CRC helpers 403 */ 404void xfs_btree_lblock_calc_crc(struct xfs_buf *); 405bool xfs_btree_lblock_verify_crc(struct xfs_buf *); 406void xfs_btree_sblock_calc_crc(struct xfs_buf *); 407bool xfs_btree_sblock_verify_crc(struct xfs_buf *); 408 409/* 410 * Internal btree helpers also used by xfs_bmap.c. 411 */ 412void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int); 413void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int); 414 415/* 416 * Helpers. 417 */ 418static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block) 419{ 420 return be16_to_cpu(block->bb_numrecs); 421} 422 423static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block, 424 uint16_t numrecs) 425{ 426 block->bb_numrecs = cpu_to_be16(numrecs); 427} 428 429static inline int xfs_btree_get_level(struct xfs_btree_block *block) 430{ 431 return be16_to_cpu(block->bb_level); 432} 433 434 435/* 436 * Min and max functions for extlen, agblock, fileoff, and filblks types. 437 */ 438#define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) 439#define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) 440#define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) 441#define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) 442#define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) 443#define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) 444#define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) 445#define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) 446 447xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp); 448xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp, 449 unsigned int max_recs); 450xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp, 451 uint64_t owner); 452xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp, 453 unsigned int max_recs); 454 455uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len); 456unsigned long long xfs_btree_calc_size(uint *limits, unsigned long long len); 457 458/* 459 * Return codes for the query range iterator function are 0 to continue 460 * iterating, and non-zero to stop iterating. Any non-zero value will be 461 * passed up to the _query_range caller. The special value -ECANCELED can be 462 * used to stop iteration, because _query_range never generates that error 463 * code on its own. 464 */ 465typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur, 466 union xfs_btree_rec *rec, void *priv); 467 468int xfs_btree_query_range(struct xfs_btree_cur *cur, 469 union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec, 470 xfs_btree_query_range_fn fn, void *priv); 471int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn, 472 void *priv); 473 474typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level, 475 void *data); 476/* Visit record blocks. */ 477#define XFS_BTREE_VISIT_RECORDS (1 << 0) 478/* Visit leaf blocks. */ 479#define XFS_BTREE_VISIT_LEAVES (1 << 1) 480/* Visit all blocks. */ 481#define XFS_BTREE_VISIT_ALL (XFS_BTREE_VISIT_RECORDS | \ 482 XFS_BTREE_VISIT_LEAVES) 483int xfs_btree_visit_blocks(struct xfs_btree_cur *cur, 484 xfs_btree_visit_blocks_fn fn, unsigned int flags, void *data); 485 486int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks); 487 488union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n, 489 struct xfs_btree_block *block); 490union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n, 491 struct xfs_btree_block *block); 492union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n, 493 struct xfs_btree_block *block); 494union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n, 495 struct xfs_btree_block *block); 496int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level, 497 union xfs_btree_ptr *pp, struct xfs_btree_block **blkp); 498struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur, 499 int level, struct xfs_buf **bpp); 500bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr); 501int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur, 502 const union xfs_btree_ptr *a, 503 const union xfs_btree_ptr *b); 504void xfs_btree_get_sibling(struct xfs_btree_cur *cur, 505 struct xfs_btree_block *block, 506 union xfs_btree_ptr *ptr, int lr); 507void xfs_btree_get_keys(struct xfs_btree_cur *cur, 508 struct xfs_btree_block *block, union xfs_btree_key *key); 509union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur, 510 union xfs_btree_key *key); 511int xfs_btree_has_record(struct xfs_btree_cur *cur, union xfs_btree_irec *low, 512 union xfs_btree_irec *high, bool *exists); 513bool xfs_btree_has_more_records(struct xfs_btree_cur *cur); 514struct xfs_ifork *xfs_btree_ifork_ptr(struct xfs_btree_cur *cur); 515 516/* Does this cursor point to the last block in the given level? */ 517static inline bool 518xfs_btree_islastblock( 519 xfs_btree_cur_t *cur, 520 int level) 521{ 522 struct xfs_btree_block *block; 523 struct xfs_buf *bp; 524 525 block = xfs_btree_get_block(cur, level, &bp); 526 ASSERT(block && xfs_btree_check_block(cur, block, level, bp) == 0); 527 528 if (cur->bc_flags & XFS_BTREE_LONG_PTRS) 529 return block->bb_u.l.bb_rightsib == cpu_to_be64(NULLFSBLOCK); 530 return block->bb_u.s.bb_rightsib == cpu_to_be32(NULLAGBLOCK); 531} 532 533void xfs_btree_set_ptr_null(struct xfs_btree_cur *cur, 534 union xfs_btree_ptr *ptr); 535int xfs_btree_get_buf_block(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr, 536 struct xfs_btree_block **block, struct xfs_buf **bpp); 537void xfs_btree_set_sibling(struct xfs_btree_cur *cur, 538 struct xfs_btree_block *block, union xfs_btree_ptr *ptr, 539 int lr); 540void xfs_btree_init_block_cur(struct xfs_btree_cur *cur, 541 struct xfs_buf *bp, int level, int numrecs); 542void xfs_btree_copy_ptrs(struct xfs_btree_cur *cur, 543 union xfs_btree_ptr *dst_ptr, 544 const union xfs_btree_ptr *src_ptr, int numptrs); 545void xfs_btree_copy_keys(struct xfs_btree_cur *cur, 546 union xfs_btree_key *dst_key, union xfs_btree_key *src_key, 547 int numkeys); 548 549#endif /* __XFS_BTREE_H__ */ 550