1508578f2SNishad Kamdar /* SPDX-License-Identifier: GPL-2.0 */ 284be0ffcSDave Chinner /* 384be0ffcSDave Chinner * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc. 484be0ffcSDave Chinner * All Rights Reserved. 584be0ffcSDave Chinner */ 684be0ffcSDave Chinner #ifndef __XFS_BTREE_H__ 784be0ffcSDave Chinner #define __XFS_BTREE_H__ 884be0ffcSDave Chinner 984be0ffcSDave Chinner struct xfs_buf; 1084be0ffcSDave Chinner struct xfs_inode; 1184be0ffcSDave Chinner struct xfs_mount; 1284be0ffcSDave Chinner struct xfs_trans; 13349e1c03SDarrick J. Wong struct xfs_ifork; 14*be9fb17dSDave Chinner struct xfs_perag; 1584be0ffcSDave Chinner 1684be0ffcSDave Chinner extern kmem_zone_t *xfs_btree_cur_zone; 1784be0ffcSDave Chinner 1884be0ffcSDave Chinner /* 1984be0ffcSDave Chinner * Generic key, ptr and record wrapper structures. 2084be0ffcSDave Chinner * 2184be0ffcSDave Chinner * These are disk format structures, and are converted where necessary 2284be0ffcSDave Chinner * by the btree specific code that needs to interpret them. 2384be0ffcSDave Chinner */ 2484be0ffcSDave Chinner union xfs_btree_ptr { 2584be0ffcSDave Chinner __be32 s; /* short form ptr */ 2684be0ffcSDave Chinner __be64 l; /* long form ptr */ 2784be0ffcSDave Chinner }; 2884be0ffcSDave Chinner 29a1d46cffSDarrick J. Wong /* 30a1d46cffSDarrick J. Wong * The in-core btree key. Overlapping btrees actually store two keys 31a1d46cffSDarrick J. Wong * per pointer, so we reserve enough memory to hold both. The __*bigkey 32a1d46cffSDarrick J. Wong * items should never be accessed directly. 33a1d46cffSDarrick J. Wong */ 3484be0ffcSDave Chinner union xfs_btree_key { 35035e00acSDarrick J. Wong struct xfs_bmbt_key bmbt; 3684be0ffcSDave Chinner xfs_bmdr_key_t bmbr; /* bmbt root block */ 3784be0ffcSDave Chinner xfs_alloc_key_t alloc; 38035e00acSDarrick J. Wong struct xfs_inobt_key inobt; 39035e00acSDarrick J. Wong struct xfs_rmap_key rmap; 40a1d46cffSDarrick J. Wong struct xfs_rmap_key __rmap_bigkey[2]; 411946b91cSDarrick J. Wong struct xfs_refcount_key refc; 422c813ad6SDarrick J. Wong }; 432c813ad6SDarrick J. Wong 4484be0ffcSDave Chinner union xfs_btree_rec { 45035e00acSDarrick J. Wong struct xfs_bmbt_rec bmbt; 4684be0ffcSDave Chinner xfs_bmdr_rec_t bmbr; /* bmbt root block */ 47035e00acSDarrick J. Wong struct xfs_alloc_rec alloc; 48035e00acSDarrick J. Wong struct xfs_inobt_rec inobt; 49035e00acSDarrick J. Wong struct xfs_rmap_rec rmap; 501946b91cSDarrick J. Wong struct xfs_refcount_rec refc; 5184be0ffcSDave Chinner }; 5284be0ffcSDave Chinner 5384be0ffcSDave Chinner /* 5484be0ffcSDave Chinner * This nonsense is to make -wlint happy. 5584be0ffcSDave Chinner */ 5684be0ffcSDave Chinner #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) 5784be0ffcSDave Chinner #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) 5884be0ffcSDave Chinner #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) 5984be0ffcSDave Chinner 6084be0ffcSDave Chinner #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) 6184be0ffcSDave Chinner #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) 6284be0ffcSDave Chinner #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) 6384be0ffcSDave Chinner #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) 6484be0ffcSDave Chinner #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi) 65b8704944SDarrick J. Wong #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi) 6646eeb521SDarrick J. Wong #define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi) 6784be0ffcSDave Chinner 68c8ce540dSDarrick J. Wong uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum); 69af7d20fdSEric Sandeen 7084be0ffcSDave Chinner /* 7184be0ffcSDave Chinner * For logging record fields. 7284be0ffcSDave Chinner */ 7384be0ffcSDave Chinner #define XFS_BB_MAGIC (1 << 0) 7484be0ffcSDave Chinner #define XFS_BB_LEVEL (1 << 1) 7584be0ffcSDave Chinner #define XFS_BB_NUMRECS (1 << 2) 7684be0ffcSDave Chinner #define XFS_BB_LEFTSIB (1 << 3) 7784be0ffcSDave Chinner #define XFS_BB_RIGHTSIB (1 << 4) 7884be0ffcSDave Chinner #define XFS_BB_BLKNO (1 << 5) 7984be0ffcSDave Chinner #define XFS_BB_LSN (1 << 6) 8084be0ffcSDave Chinner #define XFS_BB_UUID (1 << 7) 8184be0ffcSDave Chinner #define XFS_BB_OWNER (1 << 8) 8284be0ffcSDave Chinner #define XFS_BB_NUM_BITS 5 8384be0ffcSDave Chinner #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) 8484be0ffcSDave Chinner #define XFS_BB_NUM_BITS_CRC 9 8584be0ffcSDave Chinner #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1) 8684be0ffcSDave Chinner 8784be0ffcSDave Chinner /* 8884be0ffcSDave Chinner * Generic stats interface 8984be0ffcSDave Chinner */ 9084be0ffcSDave Chinner #define XFS_BTREE_STATS_INC(cur, stat) \ 9111ef38afSDave Chinner XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat) 9284be0ffcSDave Chinner #define XFS_BTREE_STATS_ADD(cur, stat, val) \ 9311ef38afSDave Chinner XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val) 9484be0ffcSDave Chinner 95df3954ffSDarrick J. Wong #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */ 9684be0ffcSDave Chinner 9784be0ffcSDave Chinner struct xfs_btree_ops { 9884be0ffcSDave Chinner /* size of the key and record structures */ 9984be0ffcSDave Chinner size_t key_len; 10084be0ffcSDave Chinner size_t rec_len; 10184be0ffcSDave Chinner 10284be0ffcSDave Chinner /* cursor operations */ 10384be0ffcSDave Chinner struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *); 10484be0ffcSDave Chinner void (*update_cursor)(struct xfs_btree_cur *src, 10584be0ffcSDave Chinner struct xfs_btree_cur *dst); 10684be0ffcSDave Chinner 10784be0ffcSDave Chinner /* update btree root pointer */ 10884be0ffcSDave Chinner void (*set_root)(struct xfs_btree_cur *cur, 10984be0ffcSDave Chinner union xfs_btree_ptr *nptr, int level_change); 11084be0ffcSDave Chinner 11184be0ffcSDave Chinner /* block allocation / freeing */ 11284be0ffcSDave Chinner int (*alloc_block)(struct xfs_btree_cur *cur, 11384be0ffcSDave Chinner union xfs_btree_ptr *start_bno, 11484be0ffcSDave Chinner union xfs_btree_ptr *new_bno, 11584be0ffcSDave Chinner int *stat); 11684be0ffcSDave Chinner int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp); 11784be0ffcSDave Chinner 11884be0ffcSDave Chinner /* update last record information */ 11984be0ffcSDave Chinner void (*update_lastrec)(struct xfs_btree_cur *cur, 12084be0ffcSDave Chinner struct xfs_btree_block *block, 12184be0ffcSDave Chinner union xfs_btree_rec *rec, 12284be0ffcSDave Chinner int ptr, int reason); 12384be0ffcSDave Chinner 12484be0ffcSDave Chinner /* records in block/level */ 12584be0ffcSDave Chinner int (*get_minrecs)(struct xfs_btree_cur *cur, int level); 12684be0ffcSDave Chinner int (*get_maxrecs)(struct xfs_btree_cur *cur, int level); 12784be0ffcSDave Chinner 12884be0ffcSDave Chinner /* records on disk. Matter for the root in inode case. */ 12984be0ffcSDave Chinner int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level); 13084be0ffcSDave Chinner 13184be0ffcSDave Chinner /* init values of btree structures */ 13284be0ffcSDave Chinner void (*init_key_from_rec)(union xfs_btree_key *key, 13384be0ffcSDave Chinner union xfs_btree_rec *rec); 13484be0ffcSDave Chinner void (*init_rec_from_cur)(struct xfs_btree_cur *cur, 13584be0ffcSDave Chinner union xfs_btree_rec *rec); 13684be0ffcSDave Chinner void (*init_ptr_from_cur)(struct xfs_btree_cur *cur, 13784be0ffcSDave Chinner union xfs_btree_ptr *ptr); 1382c813ad6SDarrick J. Wong void (*init_high_key_from_rec)(union xfs_btree_key *key, 1392c813ad6SDarrick J. Wong union xfs_btree_rec *rec); 14084be0ffcSDave Chinner 14184be0ffcSDave Chinner /* difference between key value and cursor value */ 142c8ce540dSDarrick J. Wong int64_t (*key_diff)(struct xfs_btree_cur *cur, 14384be0ffcSDave Chinner union xfs_btree_key *key); 14484be0ffcSDave Chinner 1452c813ad6SDarrick J. Wong /* 1462c813ad6SDarrick J. Wong * Difference between key2 and key1 -- positive if key1 > key2, 1472c813ad6SDarrick J. Wong * negative if key1 < key2, and zero if equal. 1482c813ad6SDarrick J. Wong */ 149c8ce540dSDarrick J. Wong int64_t (*diff_two_keys)(struct xfs_btree_cur *cur, 1502c813ad6SDarrick J. Wong union xfs_btree_key *key1, 1512c813ad6SDarrick J. Wong union xfs_btree_key *key2); 1522c813ad6SDarrick J. Wong 15384be0ffcSDave Chinner const struct xfs_buf_ops *buf_ops; 15484be0ffcSDave Chinner 15584be0ffcSDave Chinner /* check that k1 is lower than k2 */ 15684be0ffcSDave Chinner int (*keys_inorder)(struct xfs_btree_cur *cur, 15784be0ffcSDave Chinner union xfs_btree_key *k1, 15884be0ffcSDave Chinner union xfs_btree_key *k2); 15984be0ffcSDave Chinner 16084be0ffcSDave Chinner /* check that r1 is lower than r2 */ 16184be0ffcSDave Chinner int (*recs_inorder)(struct xfs_btree_cur *cur, 16284be0ffcSDave Chinner union xfs_btree_rec *r1, 16384be0ffcSDave Chinner union xfs_btree_rec *r2); 16484be0ffcSDave Chinner }; 16584be0ffcSDave Chinner 16684be0ffcSDave Chinner /* 16784be0ffcSDave Chinner * Reasons for the update_lastrec method to be called. 16884be0ffcSDave Chinner */ 16984be0ffcSDave Chinner #define LASTREC_UPDATE 0 17084be0ffcSDave Chinner #define LASTREC_INSREC 1 17184be0ffcSDave Chinner #define LASTREC_DELREC 2 17284be0ffcSDave Chinner 17384be0ffcSDave Chinner 174105f7d83SDarrick J. Wong union xfs_btree_irec { 175105f7d83SDarrick J. Wong struct xfs_alloc_rec_incore a; 176105f7d83SDarrick J. Wong struct xfs_bmbt_irec b; 177105f7d83SDarrick J. Wong struct xfs_inobt_rec_incore i; 1784b8ed677SDarrick J. Wong struct xfs_rmap_irec r; 1791946b91cSDarrick J. Wong struct xfs_refcount_irec rc; 1801946b91cSDarrick J. Wong }; 1811946b91cSDarrick J. Wong 182c4aa10d0SDave Chinner /* Per-AG btree information. */ 183c4aa10d0SDave Chinner struct xfs_btree_cur_ag { 184*be9fb17dSDave Chinner xfs_agnumber_t agno; 185*be9fb17dSDave Chinner struct xfs_perag *pag; 186e06536a6SDarrick J. Wong union { 187c4aa10d0SDave Chinner struct xfs_buf *agbp; 188e06536a6SDarrick J. Wong struct xbtree_afakeroot *afake; /* for staging cursor */ 189e06536a6SDarrick J. Wong }; 190c4aa10d0SDave Chinner union { 1911946b91cSDarrick J. Wong struct { 1921946b91cSDarrick J. Wong unsigned long nr_ops; /* # record updates */ 1931946b91cSDarrick J. Wong int shape_changes; /* # of extent splits */ 1941946b91cSDarrick J. Wong } refc; 195f6b428a4SBrian Foster struct { 196f6b428a4SBrian Foster bool active; /* allocation cursor state */ 197f6b428a4SBrian Foster } abt; 198105f7d83SDarrick J. Wong }; 19968422d90SDave Chinner }; 20068422d90SDave Chinner 20168422d90SDave Chinner /* Btree-in-inode cursor information */ 20268422d90SDave Chinner struct xfs_btree_cur_ino { 20368422d90SDave Chinner struct xfs_inode *ip; 204349e1c03SDarrick J. Wong struct xbtree_ifakeroot *ifake; /* for staging cursor */ 20568422d90SDave Chinner int allocated; 20668422d90SDave Chinner short forksize; 20768422d90SDave Chinner char whichfork; 20868422d90SDave Chinner char flags; 20968422d90SDave Chinner /* We are converting a delalloc reservation */ 21068422d90SDave Chinner #define XFS_BTCUR_BMBT_WASDEL (1 << 0) 21168422d90SDave Chinner 21268422d90SDave Chinner /* For extent swap, ignore owner check in verifier */ 21368422d90SDave Chinner #define XFS_BTCUR_BMBT_INVALID_OWNER (1 << 1) 21468422d90SDave Chinner }; 21568422d90SDave Chinner 21684be0ffcSDave Chinner /* 21784be0ffcSDave Chinner * Btree cursor structure. 21884be0ffcSDave Chinner * This collects all information needed by the btree code in one place. 21984be0ffcSDave Chinner */ 22084be0ffcSDave Chinner typedef struct xfs_btree_cur 22184be0ffcSDave Chinner { 22284be0ffcSDave Chinner struct xfs_trans *bc_tp; /* transaction we're in, if any */ 22384be0ffcSDave Chinner struct xfs_mount *bc_mp; /* file system mount struct */ 22484be0ffcSDave Chinner const struct xfs_btree_ops *bc_ops; 22584be0ffcSDave Chinner uint bc_flags; /* btree features - below */ 226105f7d83SDarrick J. Wong union xfs_btree_irec bc_rec; /* current insert/search record value */ 22784be0ffcSDave Chinner struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ 22884be0ffcSDave Chinner int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ 229c8ce540dSDarrick J. Wong uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ 23084be0ffcSDave Chinner #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ 23184be0ffcSDave Chinner #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ 232c8ce540dSDarrick J. Wong uint8_t bc_nlevels; /* number of levels in the tree */ 233c8ce540dSDarrick J. Wong uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ 23484be0ffcSDave Chinner xfs_btnum_t bc_btnum; /* identifies which btree type */ 23511ef38afSDave Chinner int bc_statoff; /* offset of btre stats array */ 236*be9fb17dSDave Chinner 237*be9fb17dSDave Chinner /* 238*be9fb17dSDave Chinner * Short btree pointers need an agno to be able to turn the pointers 239*be9fb17dSDave Chinner * into physical addresses for IO, so the btree cursor switches between 240*be9fb17dSDave Chinner * bc_ino and bc_ag based on whether XFS_BTREE_LONG_PTRS is set for the 241*be9fb17dSDave Chinner * cursor. 242*be9fb17dSDave Chinner */ 24384be0ffcSDave Chinner union { 24468422d90SDave Chinner struct xfs_btree_cur_ag bc_ag; 24568422d90SDave Chinner struct xfs_btree_cur_ino bc_ino; 24668422d90SDave Chinner }; 24784be0ffcSDave Chinner } xfs_btree_cur_t; 24884be0ffcSDave Chinner 24984be0ffcSDave Chinner /* cursor flags */ 25084be0ffcSDave Chinner #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */ 25184be0ffcSDave Chinner #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */ 25284be0ffcSDave Chinner #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */ 25384be0ffcSDave Chinner #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */ 2542c813ad6SDarrick J. Wong #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */ 255e06536a6SDarrick J. Wong /* 256e06536a6SDarrick J. Wong * The root of this btree is a fakeroot structure so that we can stage a btree 257e06536a6SDarrick J. Wong * rebuild without leaving it accessible via primary metadata. The ops struct 258e06536a6SDarrick J. Wong * is dynamically allocated and must be freed when the cursor is deleted. 259e06536a6SDarrick J. Wong */ 260e06536a6SDarrick J. Wong #define XFS_BTREE_STAGING (1<<5) 26184be0ffcSDave Chinner 26284be0ffcSDave Chinner 26384be0ffcSDave Chinner #define XFS_BTREE_NOERROR 0 26484be0ffcSDave Chinner #define XFS_BTREE_ERROR 1 26584be0ffcSDave Chinner 26684be0ffcSDave Chinner /* 26784be0ffcSDave Chinner * Convert from buffer to btree block header. 26884be0ffcSDave Chinner */ 26984be0ffcSDave Chinner #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr)) 27084be0ffcSDave Chinner 27152c732eeSDarrick J. Wong /* 27252c732eeSDarrick J. Wong * Internal long and short btree block checks. They return NULL if the 27352c732eeSDarrick J. Wong * block is ok or the address of the failed check otherwise. 27452c732eeSDarrick J. Wong */ 27552c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur, 27652c732eeSDarrick J. Wong struct xfs_btree_block *block, int level, struct xfs_buf *bp); 27752c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur, 27852c732eeSDarrick J. Wong struct xfs_btree_block *block, int level, struct xfs_buf *bp); 27984be0ffcSDave Chinner 28084be0ffcSDave Chinner /* 28184be0ffcSDave Chinner * Check that block header is ok. 28284be0ffcSDave Chinner */ 28384be0ffcSDave Chinner int 28484be0ffcSDave Chinner xfs_btree_check_block( 28584be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 28684be0ffcSDave Chinner struct xfs_btree_block *block, /* generic btree block pointer */ 28784be0ffcSDave Chinner int level, /* level of the btree block */ 28884be0ffcSDave Chinner struct xfs_buf *bp); /* buffer containing block, if any */ 28984be0ffcSDave Chinner 29084be0ffcSDave Chinner /* 29184be0ffcSDave Chinner * Check that (long) pointer is ok. 29284be0ffcSDave Chinner */ 293f135761aSDarrick J. Wong bool /* error (0 or EFSCORRUPTED) */ 29484be0ffcSDave Chinner xfs_btree_check_lptr( 29584be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 296f135761aSDarrick J. Wong xfs_fsblock_t fsbno, /* btree block disk address */ 297f135761aSDarrick J. Wong int level); /* btree block level */ 298f135761aSDarrick J. Wong 299f135761aSDarrick J. Wong /* 300f135761aSDarrick J. Wong * Check that (short) pointer is ok. 301f135761aSDarrick J. Wong */ 302f135761aSDarrick J. Wong bool /* error (0 or EFSCORRUPTED) */ 303f135761aSDarrick J. Wong xfs_btree_check_sptr( 304f135761aSDarrick J. Wong struct xfs_btree_cur *cur, /* btree cursor */ 305f135761aSDarrick J. Wong xfs_agblock_t agbno, /* btree block disk address */ 30684be0ffcSDave Chinner int level); /* btree block level */ 30784be0ffcSDave Chinner 30884be0ffcSDave Chinner /* 30984be0ffcSDave Chinner * Delete the btree cursor. 31084be0ffcSDave Chinner */ 31184be0ffcSDave Chinner void 31284be0ffcSDave Chinner xfs_btree_del_cursor( 31384be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 31484be0ffcSDave Chinner int error); /* del because of error */ 31584be0ffcSDave Chinner 31684be0ffcSDave Chinner /* 31784be0ffcSDave Chinner * Duplicate the btree cursor. 31884be0ffcSDave Chinner * Allocate a new one, copy the record, re-get the buffers. 31984be0ffcSDave Chinner */ 32084be0ffcSDave Chinner int /* error */ 32184be0ffcSDave Chinner xfs_btree_dup_cursor( 32284be0ffcSDave Chinner xfs_btree_cur_t *cur, /* input cursor */ 32384be0ffcSDave Chinner xfs_btree_cur_t **ncur);/* output cursor */ 32484be0ffcSDave Chinner 32584be0ffcSDave Chinner /* 32684be0ffcSDave Chinner * Compute first and last byte offsets for the fields given. 32784be0ffcSDave Chinner * Interprets the offsets table, which contains struct field offsets. 32884be0ffcSDave Chinner */ 32984be0ffcSDave Chinner void 33084be0ffcSDave Chinner xfs_btree_offsets( 331c8ce540dSDarrick J. Wong int64_t fields, /* bitmask of fields */ 33284be0ffcSDave Chinner const short *offsets,/* table of field offsets */ 33384be0ffcSDave Chinner int nbits, /* number of bits to inspect */ 33484be0ffcSDave Chinner int *first, /* output: first byte offset */ 33584be0ffcSDave Chinner int *last); /* output: last byte offset */ 33684be0ffcSDave Chinner 33784be0ffcSDave Chinner /* 33884be0ffcSDave Chinner * Get a buffer for the block, return it read in. 33984be0ffcSDave Chinner * Long-form addressing. 34084be0ffcSDave Chinner */ 34184be0ffcSDave Chinner int /* error */ 34284be0ffcSDave Chinner xfs_btree_read_bufl( 34384be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 34484be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 34584be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 34684be0ffcSDave Chinner struct xfs_buf **bpp, /* buffer for fsbno */ 34784be0ffcSDave Chinner int refval, /* ref count value for buffer */ 34884be0ffcSDave Chinner const struct xfs_buf_ops *ops); 34984be0ffcSDave Chinner 35084be0ffcSDave Chinner /* 35184be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 35284be0ffcSDave Chinner * Long-form addressing. 35384be0ffcSDave Chinner */ 35484be0ffcSDave Chinner void /* error */ 35584be0ffcSDave Chinner xfs_btree_reada_bufl( 35684be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 35784be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 35884be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 35984be0ffcSDave Chinner const struct xfs_buf_ops *ops); 36084be0ffcSDave Chinner 36184be0ffcSDave Chinner /* 36284be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 36384be0ffcSDave Chinner * Short-form addressing. 36484be0ffcSDave Chinner */ 36584be0ffcSDave Chinner void /* error */ 36684be0ffcSDave Chinner xfs_btree_reada_bufs( 36784be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 36884be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 36984be0ffcSDave Chinner xfs_agblock_t agbno, /* allocation group block number */ 37084be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 37184be0ffcSDave Chinner const struct xfs_buf_ops *ops); 37284be0ffcSDave Chinner 37384be0ffcSDave Chinner /* 37484be0ffcSDave Chinner * Initialise a new btree block header 37584be0ffcSDave Chinner */ 37684be0ffcSDave Chinner void 37784be0ffcSDave Chinner xfs_btree_init_block( 37884be0ffcSDave Chinner struct xfs_mount *mp, 37984be0ffcSDave Chinner struct xfs_buf *bp, 380b6f41e44SEric Sandeen xfs_btnum_t btnum, 38184be0ffcSDave Chinner __u16 level, 38284be0ffcSDave Chinner __u16 numrecs, 383f5b999c0SEric Sandeen __u64 owner); 38484be0ffcSDave Chinner 38584be0ffcSDave Chinner void 38684be0ffcSDave Chinner xfs_btree_init_block_int( 38784be0ffcSDave Chinner struct xfs_mount *mp, 38884be0ffcSDave Chinner struct xfs_btree_block *buf, 38984be0ffcSDave Chinner xfs_daddr_t blkno, 390b6f41e44SEric Sandeen xfs_btnum_t btnum, 39184be0ffcSDave Chinner __u16 level, 39284be0ffcSDave Chinner __u16 numrecs, 39384be0ffcSDave Chinner __u64 owner, 39484be0ffcSDave Chinner unsigned int flags); 39584be0ffcSDave Chinner 39684be0ffcSDave Chinner /* 39784be0ffcSDave Chinner * Common btree core entry points. 39884be0ffcSDave Chinner */ 39984be0ffcSDave Chinner int xfs_btree_increment(struct xfs_btree_cur *, int, int *); 40084be0ffcSDave Chinner int xfs_btree_decrement(struct xfs_btree_cur *, int, int *); 40184be0ffcSDave Chinner int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *); 40284be0ffcSDave Chinner int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *); 40384be0ffcSDave Chinner int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *); 40484be0ffcSDave Chinner int xfs_btree_insert(struct xfs_btree_cur *, int *); 40584be0ffcSDave Chinner int xfs_btree_delete(struct xfs_btree_cur *, int *); 40684be0ffcSDave Chinner int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *); 407c8ce540dSDarrick J. Wong int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner, 40884be0ffcSDave Chinner struct list_head *buffer_list); 40984be0ffcSDave Chinner 41084be0ffcSDave Chinner /* 41184be0ffcSDave Chinner * btree block CRC helpers 41284be0ffcSDave Chinner */ 41384be0ffcSDave Chinner void xfs_btree_lblock_calc_crc(struct xfs_buf *); 41484be0ffcSDave Chinner bool xfs_btree_lblock_verify_crc(struct xfs_buf *); 41584be0ffcSDave Chinner void xfs_btree_sblock_calc_crc(struct xfs_buf *); 41684be0ffcSDave Chinner bool xfs_btree_sblock_verify_crc(struct xfs_buf *); 41784be0ffcSDave Chinner 41884be0ffcSDave Chinner /* 41984be0ffcSDave Chinner * Internal btree helpers also used by xfs_bmap.c. 42084be0ffcSDave Chinner */ 42184be0ffcSDave Chinner void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int); 42284be0ffcSDave Chinner void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int); 42384be0ffcSDave Chinner 42484be0ffcSDave Chinner /* 42584be0ffcSDave Chinner * Helpers. 42684be0ffcSDave Chinner */ 42784be0ffcSDave Chinner static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block) 42884be0ffcSDave Chinner { 42984be0ffcSDave Chinner return be16_to_cpu(block->bb_numrecs); 43084be0ffcSDave Chinner } 43184be0ffcSDave Chinner 43284be0ffcSDave Chinner static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block, 433c8ce540dSDarrick J. Wong uint16_t numrecs) 43484be0ffcSDave Chinner { 43584be0ffcSDave Chinner block->bb_numrecs = cpu_to_be16(numrecs); 43684be0ffcSDave Chinner } 43784be0ffcSDave Chinner 43884be0ffcSDave Chinner static inline int xfs_btree_get_level(struct xfs_btree_block *block) 43984be0ffcSDave Chinner { 44084be0ffcSDave Chinner return be16_to_cpu(block->bb_level); 44184be0ffcSDave Chinner } 44284be0ffcSDave Chinner 44384be0ffcSDave Chinner 44484be0ffcSDave Chinner /* 44584be0ffcSDave Chinner * Min and max functions for extlen, agblock, fileoff, and filblks types. 44684be0ffcSDave Chinner */ 44784be0ffcSDave Chinner #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) 44884be0ffcSDave Chinner #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) 44984be0ffcSDave Chinner #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) 45084be0ffcSDave Chinner #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) 45184be0ffcSDave Chinner #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) 45284be0ffcSDave Chinner #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) 45384be0ffcSDave Chinner #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) 45484be0ffcSDave Chinner #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) 45584be0ffcSDave Chinner 456a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp); 457a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp, 458a6a781a5SDarrick J. Wong unsigned int max_recs); 459a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp, 460a6a781a5SDarrick J. Wong uint64_t owner); 461a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp, 462a6a781a5SDarrick J. Wong unsigned int max_recs); 4638368a601SDarrick J. Wong 464a1f69417SEric Sandeen uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len); 46514861c47SDarrick J. Wong unsigned long long xfs_btree_calc_size(uint *limits, unsigned long long len); 466c5ab131bSDarrick J. Wong 467e7ee96dfSDarrick J. Wong /* 468e7ee96dfSDarrick J. Wong * Return codes for the query range iterator function are 0 to continue 469e7ee96dfSDarrick J. Wong * iterating, and non-zero to stop iterating. Any non-zero value will be 470e7ee96dfSDarrick J. Wong * passed up to the _query_range caller. The special value -ECANCELED can be 471e7ee96dfSDarrick J. Wong * used to stop iteration, because _query_range never generates that error 472e7ee96dfSDarrick J. Wong * code on its own. 473e7ee96dfSDarrick J. Wong */ 474105f7d83SDarrick J. Wong typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur, 475105f7d83SDarrick J. Wong union xfs_btree_rec *rec, void *priv); 476105f7d83SDarrick J. Wong 477105f7d83SDarrick J. Wong int xfs_btree_query_range(struct xfs_btree_cur *cur, 478105f7d83SDarrick J. Wong union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec, 479105f7d83SDarrick J. Wong xfs_btree_query_range_fn fn, void *priv); 480e9a2599aSDarrick J. Wong int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn, 481e9a2599aSDarrick J. Wong void *priv); 482105f7d83SDarrick J. Wong 48328a89567SDarrick J. Wong typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level, 48428a89567SDarrick J. Wong void *data); 485e992ae8aSDarrick J. Wong /* Visit record blocks. */ 486e992ae8aSDarrick J. Wong #define XFS_BTREE_VISIT_RECORDS (1 << 0) 487e992ae8aSDarrick J. Wong /* Visit leaf blocks. */ 488e992ae8aSDarrick J. Wong #define XFS_BTREE_VISIT_LEAVES (1 << 1) 489e992ae8aSDarrick J. Wong /* Visit all blocks. */ 490e992ae8aSDarrick J. Wong #define XFS_BTREE_VISIT_ALL (XFS_BTREE_VISIT_RECORDS | \ 491e992ae8aSDarrick J. Wong XFS_BTREE_VISIT_LEAVES) 49228a89567SDarrick J. Wong int xfs_btree_visit_blocks(struct xfs_btree_cur *cur, 493e992ae8aSDarrick J. Wong xfs_btree_visit_blocks_fn fn, unsigned int flags, void *data); 49428a89567SDarrick J. Wong 495c611cc03SDarrick J. Wong int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks); 496c611cc03SDarrick J. Wong 49726788097SDarrick J. Wong union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n, 49826788097SDarrick J. Wong struct xfs_btree_block *block); 49926788097SDarrick J. Wong union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n, 50026788097SDarrick J. Wong struct xfs_btree_block *block); 50126788097SDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n, 50226788097SDarrick J. Wong struct xfs_btree_block *block); 50326788097SDarrick J. Wong union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n, 50426788097SDarrick J. Wong struct xfs_btree_block *block); 50526788097SDarrick J. Wong int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level, 50626788097SDarrick J. Wong union xfs_btree_ptr *pp, struct xfs_btree_block **blkp); 50726788097SDarrick J. Wong struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur, 50826788097SDarrick J. Wong int level, struct xfs_buf **bpp); 509cc3e0948SDarrick J. Wong bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr); 510cc3e0948SDarrick J. Wong int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur, 511cc3e0948SDarrick J. Wong const union xfs_btree_ptr *a, 512cc3e0948SDarrick J. Wong const union xfs_btree_ptr *b); 513cc3e0948SDarrick J. Wong void xfs_btree_get_sibling(struct xfs_btree_cur *cur, 514cc3e0948SDarrick J. Wong struct xfs_btree_block *block, 515cc3e0948SDarrick J. Wong union xfs_btree_ptr *ptr, int lr); 5162fdbec5cSDarrick J. Wong void xfs_btree_get_keys(struct xfs_btree_cur *cur, 5172fdbec5cSDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 5182fdbec5cSDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur, 5192fdbec5cSDarrick J. Wong union xfs_btree_key *key); 520ce1d802eSDarrick J. Wong int xfs_btree_has_record(struct xfs_btree_cur *cur, union xfs_btree_irec *low, 521ce1d802eSDarrick J. Wong union xfs_btree_irec *high, bool *exists); 52208daa3ccSDarrick J. Wong bool xfs_btree_has_more_records(struct xfs_btree_cur *cur); 523349e1c03SDarrick J. Wong struct xfs_ifork *xfs_btree_ifork_ptr(struct xfs_btree_cur *cur); 52426788097SDarrick J. Wong 52527d9ee57SDarrick J. Wong /* Does this cursor point to the last block in the given level? */ 52627d9ee57SDarrick J. Wong static inline bool 52727d9ee57SDarrick J. Wong xfs_btree_islastblock( 52827d9ee57SDarrick J. Wong xfs_btree_cur_t *cur, 52927d9ee57SDarrick J. Wong int level) 53027d9ee57SDarrick J. Wong { 53127d9ee57SDarrick J. Wong struct xfs_btree_block *block; 53227d9ee57SDarrick J. Wong struct xfs_buf *bp; 53327d9ee57SDarrick J. Wong 53427d9ee57SDarrick J. Wong block = xfs_btree_get_block(cur, level, &bp); 53527d9ee57SDarrick J. Wong ASSERT(block && xfs_btree_check_block(cur, block, level, bp) == 0); 53627d9ee57SDarrick J. Wong 53727d9ee57SDarrick J. Wong if (cur->bc_flags & XFS_BTREE_LONG_PTRS) 53827d9ee57SDarrick J. Wong return block->bb_u.l.bb_rightsib == cpu_to_be64(NULLFSBLOCK); 53927d9ee57SDarrick J. Wong return block->bb_u.s.bb_rightsib == cpu_to_be32(NULLAGBLOCK); 54027d9ee57SDarrick J. Wong } 54127d9ee57SDarrick J. Wong 54260e3d707SDarrick J. Wong void xfs_btree_set_ptr_null(struct xfs_btree_cur *cur, 54360e3d707SDarrick J. Wong union xfs_btree_ptr *ptr); 54460e3d707SDarrick J. Wong int xfs_btree_get_buf_block(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr, 54560e3d707SDarrick J. Wong struct xfs_btree_block **block, struct xfs_buf **bpp); 54660e3d707SDarrick J. Wong void xfs_btree_set_sibling(struct xfs_btree_cur *cur, 54760e3d707SDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_ptr *ptr, 54860e3d707SDarrick J. Wong int lr); 54960e3d707SDarrick J. Wong void xfs_btree_init_block_cur(struct xfs_btree_cur *cur, 55060e3d707SDarrick J. Wong struct xfs_buf *bp, int level, int numrecs); 55160e3d707SDarrick J. Wong void xfs_btree_copy_ptrs(struct xfs_btree_cur *cur, 55260e3d707SDarrick J. Wong union xfs_btree_ptr *dst_ptr, 55360e3d707SDarrick J. Wong const union xfs_btree_ptr *src_ptr, int numptrs); 55460e3d707SDarrick J. Wong void xfs_btree_copy_keys(struct xfs_btree_cur *cur, 55560e3d707SDarrick J. Wong union xfs_btree_key *dst_key, union xfs_btree_key *src_key, 55660e3d707SDarrick J. Wong int numkeys); 55760e3d707SDarrick J. Wong 55884be0ffcSDave Chinner #endif /* __XFS_BTREE_H__ */ 559