10b61f8a4SDave Chinner // 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; 1384be0ffcSDave Chinner 1484be0ffcSDave Chinner extern kmem_zone_t *xfs_btree_cur_zone; 1584be0ffcSDave Chinner 1684be0ffcSDave Chinner /* 1784be0ffcSDave Chinner * Generic key, ptr and record wrapper structures. 1884be0ffcSDave Chinner * 1984be0ffcSDave Chinner * These are disk format structures, and are converted where necessary 2084be0ffcSDave Chinner * by the btree specific code that needs to interpret them. 2184be0ffcSDave Chinner */ 2284be0ffcSDave Chinner union xfs_btree_ptr { 2384be0ffcSDave Chinner __be32 s; /* short form ptr */ 2484be0ffcSDave Chinner __be64 l; /* long form ptr */ 2584be0ffcSDave Chinner }; 2684be0ffcSDave Chinner 27a1d46cffSDarrick J. Wong /* 28a1d46cffSDarrick J. Wong * The in-core btree key. Overlapping btrees actually store two keys 29a1d46cffSDarrick J. Wong * per pointer, so we reserve enough memory to hold both. The __*bigkey 30a1d46cffSDarrick J. Wong * items should never be accessed directly. 31a1d46cffSDarrick J. Wong */ 3284be0ffcSDave Chinner union xfs_btree_key { 33035e00acSDarrick J. Wong struct xfs_bmbt_key bmbt; 3484be0ffcSDave Chinner xfs_bmdr_key_t bmbr; /* bmbt root block */ 3584be0ffcSDave Chinner xfs_alloc_key_t alloc; 36035e00acSDarrick J. Wong struct xfs_inobt_key inobt; 37035e00acSDarrick J. Wong struct xfs_rmap_key rmap; 38a1d46cffSDarrick J. Wong struct xfs_rmap_key __rmap_bigkey[2]; 391946b91cSDarrick J. Wong struct xfs_refcount_key refc; 402c813ad6SDarrick J. Wong }; 412c813ad6SDarrick J. Wong 4284be0ffcSDave Chinner union xfs_btree_rec { 43035e00acSDarrick J. Wong struct xfs_bmbt_rec bmbt; 4484be0ffcSDave Chinner xfs_bmdr_rec_t bmbr; /* bmbt root block */ 45035e00acSDarrick J. Wong struct xfs_alloc_rec alloc; 46035e00acSDarrick J. Wong struct xfs_inobt_rec inobt; 47035e00acSDarrick J. Wong struct xfs_rmap_rec rmap; 481946b91cSDarrick J. Wong struct xfs_refcount_rec refc; 4984be0ffcSDave Chinner }; 5084be0ffcSDave Chinner 5184be0ffcSDave Chinner /* 5284be0ffcSDave Chinner * This nonsense is to make -wlint happy. 5384be0ffcSDave Chinner */ 5484be0ffcSDave Chinner #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) 5584be0ffcSDave Chinner #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) 5684be0ffcSDave Chinner #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) 5784be0ffcSDave Chinner 5884be0ffcSDave Chinner #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) 5984be0ffcSDave Chinner #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) 6084be0ffcSDave Chinner #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) 6184be0ffcSDave Chinner #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) 6284be0ffcSDave Chinner #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi) 63b8704944SDarrick J. Wong #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi) 6446eeb521SDarrick J. Wong #define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi) 6584be0ffcSDave Chinner 66c8ce540dSDarrick J. Wong uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum); 67af7d20fdSEric Sandeen 6884be0ffcSDave Chinner /* 6984be0ffcSDave Chinner * For logging record fields. 7084be0ffcSDave Chinner */ 7184be0ffcSDave Chinner #define XFS_BB_MAGIC (1 << 0) 7284be0ffcSDave Chinner #define XFS_BB_LEVEL (1 << 1) 7384be0ffcSDave Chinner #define XFS_BB_NUMRECS (1 << 2) 7484be0ffcSDave Chinner #define XFS_BB_LEFTSIB (1 << 3) 7584be0ffcSDave Chinner #define XFS_BB_RIGHTSIB (1 << 4) 7684be0ffcSDave Chinner #define XFS_BB_BLKNO (1 << 5) 7784be0ffcSDave Chinner #define XFS_BB_LSN (1 << 6) 7884be0ffcSDave Chinner #define XFS_BB_UUID (1 << 7) 7984be0ffcSDave Chinner #define XFS_BB_OWNER (1 << 8) 8084be0ffcSDave Chinner #define XFS_BB_NUM_BITS 5 8184be0ffcSDave Chinner #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) 8284be0ffcSDave Chinner #define XFS_BB_NUM_BITS_CRC 9 8384be0ffcSDave Chinner #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1) 8484be0ffcSDave Chinner 8584be0ffcSDave Chinner /* 8684be0ffcSDave Chinner * Generic stats interface 8784be0ffcSDave Chinner */ 8884be0ffcSDave Chinner #define XFS_BTREE_STATS_INC(cur, stat) \ 8911ef38afSDave Chinner XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat) 9084be0ffcSDave Chinner #define XFS_BTREE_STATS_ADD(cur, stat, val) \ 9111ef38afSDave Chinner XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val) 9284be0ffcSDave Chinner 93df3954ffSDarrick J. Wong #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */ 9484be0ffcSDave Chinner 9584be0ffcSDave Chinner struct xfs_btree_ops { 9684be0ffcSDave Chinner /* size of the key and record structures */ 9784be0ffcSDave Chinner size_t key_len; 9884be0ffcSDave Chinner size_t rec_len; 9984be0ffcSDave Chinner 10084be0ffcSDave Chinner /* cursor operations */ 10184be0ffcSDave Chinner struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *); 10284be0ffcSDave Chinner void (*update_cursor)(struct xfs_btree_cur *src, 10384be0ffcSDave Chinner struct xfs_btree_cur *dst); 10484be0ffcSDave Chinner 10584be0ffcSDave Chinner /* update btree root pointer */ 10684be0ffcSDave Chinner void (*set_root)(struct xfs_btree_cur *cur, 10784be0ffcSDave Chinner union xfs_btree_ptr *nptr, int level_change); 10884be0ffcSDave Chinner 10984be0ffcSDave Chinner /* block allocation / freeing */ 11084be0ffcSDave Chinner int (*alloc_block)(struct xfs_btree_cur *cur, 11184be0ffcSDave Chinner union xfs_btree_ptr *start_bno, 11284be0ffcSDave Chinner union xfs_btree_ptr *new_bno, 11384be0ffcSDave Chinner int *stat); 11484be0ffcSDave Chinner int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp); 11584be0ffcSDave Chinner 11684be0ffcSDave Chinner /* update last record information */ 11784be0ffcSDave Chinner void (*update_lastrec)(struct xfs_btree_cur *cur, 11884be0ffcSDave Chinner struct xfs_btree_block *block, 11984be0ffcSDave Chinner union xfs_btree_rec *rec, 12084be0ffcSDave Chinner int ptr, int reason); 12184be0ffcSDave Chinner 12284be0ffcSDave Chinner /* records in block/level */ 12384be0ffcSDave Chinner int (*get_minrecs)(struct xfs_btree_cur *cur, int level); 12484be0ffcSDave Chinner int (*get_maxrecs)(struct xfs_btree_cur *cur, int level); 12584be0ffcSDave Chinner 12684be0ffcSDave Chinner /* records on disk. Matter for the root in inode case. */ 12784be0ffcSDave Chinner int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level); 12884be0ffcSDave Chinner 12984be0ffcSDave Chinner /* init values of btree structures */ 13084be0ffcSDave Chinner void (*init_key_from_rec)(union xfs_btree_key *key, 13184be0ffcSDave Chinner union xfs_btree_rec *rec); 13284be0ffcSDave Chinner void (*init_rec_from_cur)(struct xfs_btree_cur *cur, 13384be0ffcSDave Chinner union xfs_btree_rec *rec); 13484be0ffcSDave Chinner void (*init_ptr_from_cur)(struct xfs_btree_cur *cur, 13584be0ffcSDave Chinner union xfs_btree_ptr *ptr); 1362c813ad6SDarrick J. Wong void (*init_high_key_from_rec)(union xfs_btree_key *key, 1372c813ad6SDarrick J. Wong union xfs_btree_rec *rec); 13884be0ffcSDave Chinner 13984be0ffcSDave Chinner /* difference between key value and cursor value */ 140c8ce540dSDarrick J. Wong int64_t (*key_diff)(struct xfs_btree_cur *cur, 14184be0ffcSDave Chinner union xfs_btree_key *key); 14284be0ffcSDave Chinner 1432c813ad6SDarrick J. Wong /* 1442c813ad6SDarrick J. Wong * Difference between key2 and key1 -- positive if key1 > key2, 1452c813ad6SDarrick J. Wong * negative if key1 < key2, and zero if equal. 1462c813ad6SDarrick J. Wong */ 147c8ce540dSDarrick J. Wong int64_t (*diff_two_keys)(struct xfs_btree_cur *cur, 1482c813ad6SDarrick J. Wong union xfs_btree_key *key1, 1492c813ad6SDarrick J. Wong union xfs_btree_key *key2); 1502c813ad6SDarrick J. Wong 15184be0ffcSDave Chinner const struct xfs_buf_ops *buf_ops; 15284be0ffcSDave Chinner 15384be0ffcSDave Chinner /* check that k1 is lower than k2 */ 15484be0ffcSDave Chinner int (*keys_inorder)(struct xfs_btree_cur *cur, 15584be0ffcSDave Chinner union xfs_btree_key *k1, 15684be0ffcSDave Chinner union xfs_btree_key *k2); 15784be0ffcSDave Chinner 15884be0ffcSDave Chinner /* check that r1 is lower than r2 */ 15984be0ffcSDave Chinner int (*recs_inorder)(struct xfs_btree_cur *cur, 16084be0ffcSDave Chinner union xfs_btree_rec *r1, 16184be0ffcSDave Chinner union xfs_btree_rec *r2); 16284be0ffcSDave Chinner }; 16384be0ffcSDave Chinner 16484be0ffcSDave Chinner /* 16584be0ffcSDave Chinner * Reasons for the update_lastrec method to be called. 16684be0ffcSDave Chinner */ 16784be0ffcSDave Chinner #define LASTREC_UPDATE 0 16884be0ffcSDave Chinner #define LASTREC_INSREC 1 16984be0ffcSDave Chinner #define LASTREC_DELREC 2 17084be0ffcSDave Chinner 17184be0ffcSDave Chinner 172105f7d83SDarrick J. Wong union xfs_btree_irec { 173105f7d83SDarrick J. Wong struct xfs_alloc_rec_incore a; 174105f7d83SDarrick J. Wong struct xfs_bmbt_irec b; 175105f7d83SDarrick J. Wong struct xfs_inobt_rec_incore i; 1764b8ed677SDarrick J. Wong struct xfs_rmap_irec r; 1771946b91cSDarrick J. Wong struct xfs_refcount_irec rc; 1781946b91cSDarrick J. Wong }; 1791946b91cSDarrick J. Wong 1801946b91cSDarrick J. Wong /* Per-AG btree private information. */ 1811946b91cSDarrick J. Wong union xfs_btree_cur_private { 1821946b91cSDarrick J. Wong struct { 1831946b91cSDarrick J. Wong unsigned long nr_ops; /* # record updates */ 1841946b91cSDarrick J. Wong int shape_changes; /* # of extent splits */ 1851946b91cSDarrick J. Wong } refc; 186f6b428a4SBrian Foster struct { 187f6b428a4SBrian Foster bool active; /* allocation cursor state */ 188f6b428a4SBrian Foster } abt; 189105f7d83SDarrick J. Wong }; 190105f7d83SDarrick J. Wong 19184be0ffcSDave Chinner /* 19284be0ffcSDave Chinner * Btree cursor structure. 19384be0ffcSDave Chinner * This collects all information needed by the btree code in one place. 19484be0ffcSDave Chinner */ 19584be0ffcSDave Chinner typedef struct xfs_btree_cur 19684be0ffcSDave Chinner { 19784be0ffcSDave Chinner struct xfs_trans *bc_tp; /* transaction we're in, if any */ 19884be0ffcSDave Chinner struct xfs_mount *bc_mp; /* file system mount struct */ 19984be0ffcSDave Chinner const struct xfs_btree_ops *bc_ops; 20084be0ffcSDave Chinner uint bc_flags; /* btree features - below */ 201105f7d83SDarrick J. Wong union xfs_btree_irec bc_rec; /* current insert/search record value */ 20284be0ffcSDave Chinner struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ 20384be0ffcSDave Chinner int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ 204c8ce540dSDarrick J. Wong uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ 20584be0ffcSDave Chinner #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ 20684be0ffcSDave Chinner #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ 207c8ce540dSDarrick J. Wong uint8_t bc_nlevels; /* number of levels in the tree */ 208c8ce540dSDarrick J. Wong uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ 20984be0ffcSDave Chinner xfs_btnum_t bc_btnum; /* identifies which btree type */ 21011ef38afSDave Chinner int bc_statoff; /* offset of btre stats array */ 21184be0ffcSDave Chinner union { 21284be0ffcSDave Chinner struct { /* needed for BNO, CNT, INO */ 21384be0ffcSDave Chinner struct xfs_buf *agbp; /* agf/agi buffer pointer */ 21484be0ffcSDave Chinner xfs_agnumber_t agno; /* ag number */ 2151946b91cSDarrick J. Wong union xfs_btree_cur_private priv; 21684be0ffcSDave Chinner } a; 21784be0ffcSDave Chinner struct { /* needed for BMAP */ 21884be0ffcSDave Chinner struct xfs_inode *ip; /* pointer to our inode */ 21984be0ffcSDave Chinner int allocated; /* count of alloced */ 22084be0ffcSDave Chinner short forksize; /* fork's inode space */ 22184be0ffcSDave Chinner char whichfork; /* data or attr fork */ 22284be0ffcSDave Chinner char flags; /* flags */ 22399c794c6SBrian Foster #define XFS_BTCUR_BPRV_WASDEL (1<<0) /* was delayed */ 22499c794c6SBrian Foster #define XFS_BTCUR_BPRV_INVALID_OWNER (1<<1) /* for ext swap */ 22584be0ffcSDave Chinner } b; 22684be0ffcSDave Chinner } bc_private; /* per-btree type data */ 22784be0ffcSDave Chinner } xfs_btree_cur_t; 22884be0ffcSDave Chinner 22984be0ffcSDave Chinner /* cursor flags */ 23084be0ffcSDave Chinner #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */ 23184be0ffcSDave Chinner #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */ 23284be0ffcSDave Chinner #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */ 23384be0ffcSDave Chinner #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */ 2342c813ad6SDarrick J. Wong #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */ 23584be0ffcSDave Chinner 23684be0ffcSDave Chinner 23784be0ffcSDave Chinner #define XFS_BTREE_NOERROR 0 23884be0ffcSDave Chinner #define XFS_BTREE_ERROR 1 23984be0ffcSDave Chinner 24084be0ffcSDave Chinner /* 24184be0ffcSDave Chinner * Convert from buffer to btree block header. 24284be0ffcSDave Chinner */ 24384be0ffcSDave Chinner #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr)) 24484be0ffcSDave Chinner 24552c732eeSDarrick J. Wong /* 24652c732eeSDarrick J. Wong * Internal long and short btree block checks. They return NULL if the 24752c732eeSDarrick J. Wong * block is ok or the address of the failed check otherwise. 24852c732eeSDarrick J. Wong */ 24952c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur, 25052c732eeSDarrick J. Wong struct xfs_btree_block *block, int level, struct xfs_buf *bp); 25152c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur, 25252c732eeSDarrick J. Wong struct xfs_btree_block *block, int level, struct xfs_buf *bp); 25384be0ffcSDave Chinner 25484be0ffcSDave Chinner /* 25584be0ffcSDave Chinner * Check that block header is ok. 25684be0ffcSDave Chinner */ 25784be0ffcSDave Chinner int 25884be0ffcSDave Chinner xfs_btree_check_block( 25984be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 26084be0ffcSDave Chinner struct xfs_btree_block *block, /* generic btree block pointer */ 26184be0ffcSDave Chinner int level, /* level of the btree block */ 26284be0ffcSDave Chinner struct xfs_buf *bp); /* buffer containing block, if any */ 26384be0ffcSDave Chinner 26484be0ffcSDave Chinner /* 26584be0ffcSDave Chinner * Check that (long) pointer is ok. 26684be0ffcSDave Chinner */ 267f135761aSDarrick J. Wong bool /* error (0 or EFSCORRUPTED) */ 26884be0ffcSDave Chinner xfs_btree_check_lptr( 26984be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 270f135761aSDarrick J. Wong xfs_fsblock_t fsbno, /* btree block disk address */ 271f135761aSDarrick J. Wong int level); /* btree block level */ 272f135761aSDarrick J. Wong 273f135761aSDarrick J. Wong /* 274f135761aSDarrick J. Wong * Check that (short) pointer is ok. 275f135761aSDarrick J. Wong */ 276f135761aSDarrick J. Wong bool /* error (0 or EFSCORRUPTED) */ 277f135761aSDarrick J. Wong xfs_btree_check_sptr( 278f135761aSDarrick J. Wong struct xfs_btree_cur *cur, /* btree cursor */ 279f135761aSDarrick J. Wong xfs_agblock_t agbno, /* btree block disk address */ 28084be0ffcSDave Chinner int level); /* btree block level */ 28184be0ffcSDave Chinner 28284be0ffcSDave Chinner /* 28384be0ffcSDave Chinner * Delete the btree cursor. 28484be0ffcSDave Chinner */ 28584be0ffcSDave Chinner void 28684be0ffcSDave Chinner xfs_btree_del_cursor( 28784be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 28884be0ffcSDave Chinner int error); /* del because of error */ 28984be0ffcSDave Chinner 29084be0ffcSDave Chinner /* 29184be0ffcSDave Chinner * Duplicate the btree cursor. 29284be0ffcSDave Chinner * Allocate a new one, copy the record, re-get the buffers. 29384be0ffcSDave Chinner */ 29484be0ffcSDave Chinner int /* error */ 29584be0ffcSDave Chinner xfs_btree_dup_cursor( 29684be0ffcSDave Chinner xfs_btree_cur_t *cur, /* input cursor */ 29784be0ffcSDave Chinner xfs_btree_cur_t **ncur);/* output cursor */ 29884be0ffcSDave Chinner 29984be0ffcSDave Chinner /* 30084be0ffcSDave Chinner * Get a buffer for the block, return it with no data read. 30184be0ffcSDave Chinner * Long-form addressing. 30284be0ffcSDave Chinner */ 30384be0ffcSDave Chinner struct xfs_buf * /* buffer for fsbno */ 30484be0ffcSDave Chinner xfs_btree_get_bufl( 30584be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 30684be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 307f5b999c0SEric Sandeen xfs_fsblock_t fsbno); /* file system block number */ 30884be0ffcSDave Chinner 30984be0ffcSDave Chinner /* 31084be0ffcSDave Chinner * Get a buffer for the block, return it with no data read. 31184be0ffcSDave Chinner * Short-form addressing. 31284be0ffcSDave Chinner */ 31384be0ffcSDave Chinner struct xfs_buf * /* buffer for agno/agbno */ 31484be0ffcSDave Chinner xfs_btree_get_bufs( 31584be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 31684be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 31784be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 318f5b999c0SEric Sandeen xfs_agblock_t agbno); /* allocation group block number */ 31984be0ffcSDave Chinner 32084be0ffcSDave Chinner /* 32184be0ffcSDave Chinner * Check for the cursor referring to the last block at the given level. 32284be0ffcSDave Chinner */ 32384be0ffcSDave Chinner int /* 1=is last block, 0=not last block */ 32484be0ffcSDave Chinner xfs_btree_islastblock( 32584be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 32684be0ffcSDave Chinner int level); /* level to check */ 32784be0ffcSDave Chinner 32884be0ffcSDave Chinner /* 32984be0ffcSDave Chinner * Compute first and last byte offsets for the fields given. 33084be0ffcSDave Chinner * Interprets the offsets table, which contains struct field offsets. 33184be0ffcSDave Chinner */ 33284be0ffcSDave Chinner void 33384be0ffcSDave Chinner xfs_btree_offsets( 334c8ce540dSDarrick J. Wong int64_t fields, /* bitmask of fields */ 33584be0ffcSDave Chinner const short *offsets,/* table of field offsets */ 33684be0ffcSDave Chinner int nbits, /* number of bits to inspect */ 33784be0ffcSDave Chinner int *first, /* output: first byte offset */ 33884be0ffcSDave Chinner int *last); /* output: last byte offset */ 33984be0ffcSDave Chinner 34084be0ffcSDave Chinner /* 34184be0ffcSDave Chinner * Get a buffer for the block, return it read in. 34284be0ffcSDave Chinner * Long-form addressing. 34384be0ffcSDave Chinner */ 34484be0ffcSDave Chinner int /* error */ 34584be0ffcSDave Chinner xfs_btree_read_bufl( 34684be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 34784be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 34884be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 34984be0ffcSDave Chinner struct xfs_buf **bpp, /* buffer for fsbno */ 35084be0ffcSDave Chinner int refval, /* ref count value for buffer */ 35184be0ffcSDave Chinner const struct xfs_buf_ops *ops); 35284be0ffcSDave Chinner 35384be0ffcSDave Chinner /* 35484be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 35584be0ffcSDave Chinner * Long-form addressing. 35684be0ffcSDave Chinner */ 35784be0ffcSDave Chinner void /* error */ 35884be0ffcSDave Chinner xfs_btree_reada_bufl( 35984be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 36084be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 36184be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 36284be0ffcSDave Chinner const struct xfs_buf_ops *ops); 36384be0ffcSDave Chinner 36484be0ffcSDave Chinner /* 36584be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 36684be0ffcSDave Chinner * Short-form addressing. 36784be0ffcSDave Chinner */ 36884be0ffcSDave Chinner void /* error */ 36984be0ffcSDave Chinner xfs_btree_reada_bufs( 37084be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 37184be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 37284be0ffcSDave Chinner xfs_agblock_t agbno, /* allocation group block number */ 37384be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 37484be0ffcSDave Chinner const struct xfs_buf_ops *ops); 37584be0ffcSDave Chinner 37684be0ffcSDave Chinner /* 37784be0ffcSDave Chinner * Initialise a new btree block header 37884be0ffcSDave Chinner */ 37984be0ffcSDave Chinner void 38084be0ffcSDave Chinner xfs_btree_init_block( 38184be0ffcSDave Chinner struct xfs_mount *mp, 38284be0ffcSDave Chinner struct xfs_buf *bp, 383b6f41e44SEric Sandeen xfs_btnum_t btnum, 38484be0ffcSDave Chinner __u16 level, 38584be0ffcSDave Chinner __u16 numrecs, 386f5b999c0SEric Sandeen __u64 owner); 38784be0ffcSDave Chinner 38884be0ffcSDave Chinner void 38984be0ffcSDave Chinner xfs_btree_init_block_int( 39084be0ffcSDave Chinner struct xfs_mount *mp, 39184be0ffcSDave Chinner struct xfs_btree_block *buf, 39284be0ffcSDave Chinner xfs_daddr_t blkno, 393b6f41e44SEric Sandeen xfs_btnum_t btnum, 39484be0ffcSDave Chinner __u16 level, 39584be0ffcSDave Chinner __u16 numrecs, 39684be0ffcSDave Chinner __u64 owner, 39784be0ffcSDave Chinner unsigned int flags); 39884be0ffcSDave Chinner 39984be0ffcSDave Chinner /* 40084be0ffcSDave Chinner * Common btree core entry points. 40184be0ffcSDave Chinner */ 40284be0ffcSDave Chinner int xfs_btree_increment(struct xfs_btree_cur *, int, int *); 40384be0ffcSDave Chinner int xfs_btree_decrement(struct xfs_btree_cur *, int, int *); 40484be0ffcSDave Chinner int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *); 40584be0ffcSDave Chinner int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *); 40684be0ffcSDave Chinner int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *); 40784be0ffcSDave Chinner int xfs_btree_insert(struct xfs_btree_cur *, int *); 40884be0ffcSDave Chinner int xfs_btree_delete(struct xfs_btree_cur *, int *); 40984be0ffcSDave Chinner int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *); 410c8ce540dSDarrick J. Wong int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner, 41184be0ffcSDave Chinner struct list_head *buffer_list); 41284be0ffcSDave Chinner 41384be0ffcSDave Chinner /* 41484be0ffcSDave Chinner * btree block CRC helpers 41584be0ffcSDave Chinner */ 41684be0ffcSDave Chinner void xfs_btree_lblock_calc_crc(struct xfs_buf *); 41784be0ffcSDave Chinner bool xfs_btree_lblock_verify_crc(struct xfs_buf *); 41884be0ffcSDave Chinner void xfs_btree_sblock_calc_crc(struct xfs_buf *); 41984be0ffcSDave Chinner bool xfs_btree_sblock_verify_crc(struct xfs_buf *); 42084be0ffcSDave Chinner 42184be0ffcSDave Chinner /* 42284be0ffcSDave Chinner * Internal btree helpers also used by xfs_bmap.c. 42384be0ffcSDave Chinner */ 42484be0ffcSDave Chinner void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int); 42584be0ffcSDave Chinner void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int); 42684be0ffcSDave Chinner 42784be0ffcSDave Chinner /* 42884be0ffcSDave Chinner * Helpers. 42984be0ffcSDave Chinner */ 43084be0ffcSDave Chinner static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block) 43184be0ffcSDave Chinner { 43284be0ffcSDave Chinner return be16_to_cpu(block->bb_numrecs); 43384be0ffcSDave Chinner } 43484be0ffcSDave Chinner 43584be0ffcSDave Chinner static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block, 436c8ce540dSDarrick J. Wong uint16_t numrecs) 43784be0ffcSDave Chinner { 43884be0ffcSDave Chinner block->bb_numrecs = cpu_to_be16(numrecs); 43984be0ffcSDave Chinner } 44084be0ffcSDave Chinner 44184be0ffcSDave Chinner static inline int xfs_btree_get_level(struct xfs_btree_block *block) 44284be0ffcSDave Chinner { 44384be0ffcSDave Chinner return be16_to_cpu(block->bb_level); 44484be0ffcSDave Chinner } 44584be0ffcSDave Chinner 44684be0ffcSDave Chinner 44784be0ffcSDave Chinner /* 44884be0ffcSDave Chinner * Min and max functions for extlen, agblock, fileoff, and filblks types. 44984be0ffcSDave Chinner */ 45084be0ffcSDave Chinner #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) 45184be0ffcSDave Chinner #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) 45284be0ffcSDave Chinner #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) 45384be0ffcSDave Chinner #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) 45484be0ffcSDave Chinner #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) 45584be0ffcSDave Chinner #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) 45684be0ffcSDave Chinner #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) 45784be0ffcSDave Chinner #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) 45884be0ffcSDave Chinner 459a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp); 460a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp, 461a6a781a5SDarrick J. Wong unsigned int max_recs); 462a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp, 463a6a781a5SDarrick J. Wong uint64_t owner); 464a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp, 465a6a781a5SDarrick J. Wong unsigned int max_recs); 4668368a601SDarrick J. Wong 467a1f69417SEric Sandeen uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len); 46814861c47SDarrick J. Wong unsigned long long xfs_btree_calc_size(uint *limits, unsigned long long len); 469c5ab131bSDarrick J. Wong 470e7ee96dfSDarrick J. Wong /* 471e7ee96dfSDarrick J. Wong * Return codes for the query range iterator function are 0 to continue 472e7ee96dfSDarrick J. Wong * iterating, and non-zero to stop iterating. Any non-zero value will be 473e7ee96dfSDarrick J. Wong * passed up to the _query_range caller. The special value -ECANCELED can be 474e7ee96dfSDarrick J. Wong * used to stop iteration, because _query_range never generates that error 475e7ee96dfSDarrick J. Wong * code on its own. 476e7ee96dfSDarrick J. Wong */ 477105f7d83SDarrick J. Wong typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur, 478105f7d83SDarrick J. Wong union xfs_btree_rec *rec, void *priv); 479105f7d83SDarrick J. Wong 480105f7d83SDarrick J. Wong int xfs_btree_query_range(struct xfs_btree_cur *cur, 481105f7d83SDarrick J. Wong union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec, 482105f7d83SDarrick J. Wong xfs_btree_query_range_fn fn, void *priv); 483e9a2599aSDarrick J. Wong int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn, 484e9a2599aSDarrick J. Wong void *priv); 485105f7d83SDarrick J. Wong 48628a89567SDarrick J. Wong typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level, 48728a89567SDarrick J. Wong void *data); 48828a89567SDarrick J. Wong int xfs_btree_visit_blocks(struct xfs_btree_cur *cur, 48928a89567SDarrick J. Wong xfs_btree_visit_blocks_fn fn, void *data); 49028a89567SDarrick J. Wong 491c611cc03SDarrick J. Wong int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks); 492c611cc03SDarrick J. Wong 49326788097SDarrick J. Wong union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n, 49426788097SDarrick J. Wong struct xfs_btree_block *block); 49526788097SDarrick J. Wong union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n, 49626788097SDarrick J. Wong struct xfs_btree_block *block); 49726788097SDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n, 49826788097SDarrick J. Wong struct xfs_btree_block *block); 49926788097SDarrick J. Wong union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n, 50026788097SDarrick J. Wong struct xfs_btree_block *block); 50126788097SDarrick J. Wong int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level, 50226788097SDarrick J. Wong union xfs_btree_ptr *pp, struct xfs_btree_block **blkp); 50326788097SDarrick J. Wong struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur, 50426788097SDarrick J. Wong int level, struct xfs_buf **bpp); 505cc3e0948SDarrick J. Wong bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr); 506cc3e0948SDarrick J. Wong int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur, 507cc3e0948SDarrick J. Wong const union xfs_btree_ptr *a, 508cc3e0948SDarrick J. Wong const union xfs_btree_ptr *b); 509cc3e0948SDarrick J. Wong void xfs_btree_get_sibling(struct xfs_btree_cur *cur, 510cc3e0948SDarrick J. Wong struct xfs_btree_block *block, 511cc3e0948SDarrick J. Wong union xfs_btree_ptr *ptr, int lr); 5122fdbec5cSDarrick J. Wong void xfs_btree_get_keys(struct xfs_btree_cur *cur, 5132fdbec5cSDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 5142fdbec5cSDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur, 5152fdbec5cSDarrick J. Wong union xfs_btree_key *key); 516ce1d802eSDarrick J. Wong int xfs_btree_has_record(struct xfs_btree_cur *cur, union xfs_btree_irec *low, 517ce1d802eSDarrick J. Wong union xfs_btree_irec *high, bool *exists); 51808daa3ccSDarrick J. Wong bool xfs_btree_has_more_records(struct xfs_btree_cur *cur); 51926788097SDarrick J. Wong 52084be0ffcSDave Chinner #endif /* __XFS_BTREE_H__ */ 521