184be0ffcSDave Chinner /* 284be0ffcSDave Chinner * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc. 384be0ffcSDave Chinner * All Rights Reserved. 484be0ffcSDave Chinner * 584be0ffcSDave Chinner * This program is free software; you can redistribute it and/or 684be0ffcSDave Chinner * modify it under the terms of the GNU General Public License as 784be0ffcSDave Chinner * published by the Free Software Foundation. 884be0ffcSDave Chinner * 984be0ffcSDave Chinner * This program is distributed in the hope that it would be useful, 1084be0ffcSDave Chinner * but WITHOUT ANY WARRANTY; without even the implied warranty of 1184be0ffcSDave Chinner * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1284be0ffcSDave Chinner * GNU General Public License for more details. 1384be0ffcSDave Chinner * 1484be0ffcSDave Chinner * You should have received a copy of the GNU General Public License 1584be0ffcSDave Chinner * along with this program; if not, write the Free Software Foundation, 1684be0ffcSDave Chinner * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 1784be0ffcSDave Chinner */ 1884be0ffcSDave Chinner #ifndef __XFS_BTREE_H__ 1984be0ffcSDave Chinner #define __XFS_BTREE_H__ 2084be0ffcSDave Chinner 2184be0ffcSDave Chinner struct xfs_buf; 22310a75a3SDarrick J. Wong struct xfs_defer_ops; 2384be0ffcSDave Chinner struct xfs_inode; 2484be0ffcSDave Chinner struct xfs_mount; 2584be0ffcSDave Chinner struct xfs_trans; 2684be0ffcSDave Chinner 2784be0ffcSDave Chinner extern kmem_zone_t *xfs_btree_cur_zone; 2884be0ffcSDave Chinner 2984be0ffcSDave Chinner /* 3084be0ffcSDave Chinner * Generic key, ptr and record wrapper structures. 3184be0ffcSDave Chinner * 3284be0ffcSDave Chinner * These are disk format structures, and are converted where necessary 3384be0ffcSDave Chinner * by the btree specific code that needs to interpret them. 3484be0ffcSDave Chinner */ 3584be0ffcSDave Chinner union xfs_btree_ptr { 3684be0ffcSDave Chinner __be32 s; /* short form ptr */ 3784be0ffcSDave Chinner __be64 l; /* long form ptr */ 3884be0ffcSDave Chinner }; 3984be0ffcSDave Chinner 40a1d46cffSDarrick J. Wong /* 41a1d46cffSDarrick J. Wong * The in-core btree key. Overlapping btrees actually store two keys 42a1d46cffSDarrick J. Wong * per pointer, so we reserve enough memory to hold both. The __*bigkey 43a1d46cffSDarrick J. Wong * items should never be accessed directly. 44a1d46cffSDarrick J. Wong */ 4584be0ffcSDave Chinner union xfs_btree_key { 46035e00acSDarrick J. Wong struct xfs_bmbt_key bmbt; 4784be0ffcSDave Chinner xfs_bmdr_key_t bmbr; /* bmbt root block */ 4884be0ffcSDave Chinner xfs_alloc_key_t alloc; 49035e00acSDarrick J. Wong struct xfs_inobt_key inobt; 50035e00acSDarrick J. Wong struct xfs_rmap_key rmap; 51a1d46cffSDarrick J. Wong struct xfs_rmap_key __rmap_bigkey[2]; 521946b91cSDarrick J. Wong struct xfs_refcount_key refc; 532c813ad6SDarrick J. Wong }; 542c813ad6SDarrick J. Wong 5584be0ffcSDave Chinner union xfs_btree_rec { 56035e00acSDarrick J. Wong struct xfs_bmbt_rec bmbt; 5784be0ffcSDave Chinner xfs_bmdr_rec_t bmbr; /* bmbt root block */ 58035e00acSDarrick J. Wong struct xfs_alloc_rec alloc; 59035e00acSDarrick J. Wong struct xfs_inobt_rec inobt; 60035e00acSDarrick J. Wong struct xfs_rmap_rec rmap; 611946b91cSDarrick J. Wong struct xfs_refcount_rec refc; 6284be0ffcSDave Chinner }; 6384be0ffcSDave Chinner 6484be0ffcSDave Chinner /* 6584be0ffcSDave Chinner * This nonsense is to make -wlint happy. 6684be0ffcSDave Chinner */ 6784be0ffcSDave Chinner #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) 6884be0ffcSDave Chinner #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) 6984be0ffcSDave Chinner #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) 7084be0ffcSDave Chinner 7184be0ffcSDave Chinner #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) 7284be0ffcSDave Chinner #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) 7384be0ffcSDave Chinner #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) 7484be0ffcSDave Chinner #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) 7584be0ffcSDave Chinner #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi) 76b8704944SDarrick J. Wong #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi) 7746eeb521SDarrick J. Wong #define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi) 7884be0ffcSDave Chinner 79c8ce540dSDarrick J. Wong uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum); 80af7d20fdSEric Sandeen 8184be0ffcSDave Chinner /* 8284be0ffcSDave Chinner * For logging record fields. 8384be0ffcSDave Chinner */ 8484be0ffcSDave Chinner #define XFS_BB_MAGIC (1 << 0) 8584be0ffcSDave Chinner #define XFS_BB_LEVEL (1 << 1) 8684be0ffcSDave Chinner #define XFS_BB_NUMRECS (1 << 2) 8784be0ffcSDave Chinner #define XFS_BB_LEFTSIB (1 << 3) 8884be0ffcSDave Chinner #define XFS_BB_RIGHTSIB (1 << 4) 8984be0ffcSDave Chinner #define XFS_BB_BLKNO (1 << 5) 9084be0ffcSDave Chinner #define XFS_BB_LSN (1 << 6) 9184be0ffcSDave Chinner #define XFS_BB_UUID (1 << 7) 9284be0ffcSDave Chinner #define XFS_BB_OWNER (1 << 8) 9384be0ffcSDave Chinner #define XFS_BB_NUM_BITS 5 9484be0ffcSDave Chinner #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) 9584be0ffcSDave Chinner #define XFS_BB_NUM_BITS_CRC 9 9684be0ffcSDave Chinner #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1) 9784be0ffcSDave Chinner 9884be0ffcSDave Chinner /* 9984be0ffcSDave Chinner * Generic stats interface 10084be0ffcSDave Chinner */ 10184be0ffcSDave Chinner #define XFS_BTREE_STATS_INC(cur, stat) \ 10211ef38afSDave Chinner XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat) 10384be0ffcSDave Chinner #define XFS_BTREE_STATS_ADD(cur, stat, val) \ 10411ef38afSDave Chinner XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val) 10584be0ffcSDave Chinner 106df3954ffSDarrick J. Wong #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */ 10784be0ffcSDave Chinner 10884be0ffcSDave Chinner struct xfs_btree_ops { 10984be0ffcSDave Chinner /* size of the key and record structures */ 11084be0ffcSDave Chinner size_t key_len; 11184be0ffcSDave Chinner size_t rec_len; 11284be0ffcSDave Chinner 11384be0ffcSDave Chinner /* cursor operations */ 11484be0ffcSDave Chinner struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *); 11584be0ffcSDave Chinner void (*update_cursor)(struct xfs_btree_cur *src, 11684be0ffcSDave Chinner struct xfs_btree_cur *dst); 11784be0ffcSDave Chinner 11884be0ffcSDave Chinner /* update btree root pointer */ 11984be0ffcSDave Chinner void (*set_root)(struct xfs_btree_cur *cur, 12084be0ffcSDave Chinner union xfs_btree_ptr *nptr, int level_change); 12184be0ffcSDave Chinner 12284be0ffcSDave Chinner /* block allocation / freeing */ 12384be0ffcSDave Chinner int (*alloc_block)(struct xfs_btree_cur *cur, 12484be0ffcSDave Chinner union xfs_btree_ptr *start_bno, 12584be0ffcSDave Chinner union xfs_btree_ptr *new_bno, 12684be0ffcSDave Chinner int *stat); 12784be0ffcSDave Chinner int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp); 12884be0ffcSDave Chinner 12984be0ffcSDave Chinner /* update last record information */ 13084be0ffcSDave Chinner void (*update_lastrec)(struct xfs_btree_cur *cur, 13184be0ffcSDave Chinner struct xfs_btree_block *block, 13284be0ffcSDave Chinner union xfs_btree_rec *rec, 13384be0ffcSDave Chinner int ptr, int reason); 13484be0ffcSDave Chinner 13584be0ffcSDave Chinner /* records in block/level */ 13684be0ffcSDave Chinner int (*get_minrecs)(struct xfs_btree_cur *cur, int level); 13784be0ffcSDave Chinner int (*get_maxrecs)(struct xfs_btree_cur *cur, int level); 13884be0ffcSDave Chinner 13984be0ffcSDave Chinner /* records on disk. Matter for the root in inode case. */ 14084be0ffcSDave Chinner int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level); 14184be0ffcSDave Chinner 14284be0ffcSDave Chinner /* init values of btree structures */ 14384be0ffcSDave Chinner void (*init_key_from_rec)(union xfs_btree_key *key, 14484be0ffcSDave Chinner union xfs_btree_rec *rec); 14584be0ffcSDave Chinner void (*init_rec_from_cur)(struct xfs_btree_cur *cur, 14684be0ffcSDave Chinner union xfs_btree_rec *rec); 14784be0ffcSDave Chinner void (*init_ptr_from_cur)(struct xfs_btree_cur *cur, 14884be0ffcSDave Chinner union xfs_btree_ptr *ptr); 1492c813ad6SDarrick J. Wong void (*init_high_key_from_rec)(union xfs_btree_key *key, 1502c813ad6SDarrick J. Wong union xfs_btree_rec *rec); 15184be0ffcSDave Chinner 15284be0ffcSDave Chinner /* difference between key value and cursor value */ 153c8ce540dSDarrick J. Wong int64_t (*key_diff)(struct xfs_btree_cur *cur, 15484be0ffcSDave Chinner union xfs_btree_key *key); 15584be0ffcSDave Chinner 1562c813ad6SDarrick J. Wong /* 1572c813ad6SDarrick J. Wong * Difference between key2 and key1 -- positive if key1 > key2, 1582c813ad6SDarrick J. Wong * negative if key1 < key2, and zero if equal. 1592c813ad6SDarrick J. Wong */ 160c8ce540dSDarrick J. Wong int64_t (*diff_two_keys)(struct xfs_btree_cur *cur, 1612c813ad6SDarrick J. Wong union xfs_btree_key *key1, 1622c813ad6SDarrick J. Wong union xfs_btree_key *key2); 1632c813ad6SDarrick J. Wong 16484be0ffcSDave Chinner const struct xfs_buf_ops *buf_ops; 16584be0ffcSDave Chinner 16684be0ffcSDave Chinner /* check that k1 is lower than k2 */ 16784be0ffcSDave Chinner int (*keys_inorder)(struct xfs_btree_cur *cur, 16884be0ffcSDave Chinner union xfs_btree_key *k1, 16984be0ffcSDave Chinner union xfs_btree_key *k2); 17084be0ffcSDave Chinner 17184be0ffcSDave Chinner /* check that r1 is lower than r2 */ 17284be0ffcSDave Chinner int (*recs_inorder)(struct xfs_btree_cur *cur, 17384be0ffcSDave Chinner union xfs_btree_rec *r1, 17484be0ffcSDave Chinner union xfs_btree_rec *r2); 17584be0ffcSDave Chinner }; 17684be0ffcSDave Chinner 17784be0ffcSDave Chinner /* 17884be0ffcSDave Chinner * Reasons for the update_lastrec method to be called. 17984be0ffcSDave Chinner */ 18084be0ffcSDave Chinner #define LASTREC_UPDATE 0 18184be0ffcSDave Chinner #define LASTREC_INSREC 1 18284be0ffcSDave Chinner #define LASTREC_DELREC 2 18384be0ffcSDave Chinner 18484be0ffcSDave Chinner 185105f7d83SDarrick J. Wong union xfs_btree_irec { 186105f7d83SDarrick J. Wong struct xfs_alloc_rec_incore a; 187105f7d83SDarrick J. Wong struct xfs_bmbt_irec b; 188105f7d83SDarrick J. Wong struct xfs_inobt_rec_incore i; 1894b8ed677SDarrick J. Wong struct xfs_rmap_irec r; 1901946b91cSDarrick J. Wong struct xfs_refcount_irec rc; 1911946b91cSDarrick J. Wong }; 1921946b91cSDarrick J. Wong 1931946b91cSDarrick J. Wong /* Per-AG btree private information. */ 1941946b91cSDarrick J. Wong union xfs_btree_cur_private { 1951946b91cSDarrick J. Wong struct { 1961946b91cSDarrick J. Wong unsigned long nr_ops; /* # record updates */ 1971946b91cSDarrick J. Wong int shape_changes; /* # of extent splits */ 1981946b91cSDarrick J. Wong } refc; 199105f7d83SDarrick J. Wong }; 200105f7d83SDarrick J. Wong 20184be0ffcSDave Chinner /* 20284be0ffcSDave Chinner * Btree cursor structure. 20384be0ffcSDave Chinner * This collects all information needed by the btree code in one place. 20484be0ffcSDave Chinner */ 20584be0ffcSDave Chinner typedef struct xfs_btree_cur 20684be0ffcSDave Chinner { 20784be0ffcSDave Chinner struct xfs_trans *bc_tp; /* transaction we're in, if any */ 20884be0ffcSDave Chinner struct xfs_mount *bc_mp; /* file system mount struct */ 20984be0ffcSDave Chinner const struct xfs_btree_ops *bc_ops; 21084be0ffcSDave Chinner uint bc_flags; /* btree features - below */ 211105f7d83SDarrick J. Wong union xfs_btree_irec bc_rec; /* current insert/search record value */ 21284be0ffcSDave Chinner struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ 21384be0ffcSDave Chinner int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ 214c8ce540dSDarrick J. Wong uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ 21584be0ffcSDave Chinner #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ 21684be0ffcSDave Chinner #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ 217c8ce540dSDarrick J. Wong uint8_t bc_nlevels; /* number of levels in the tree */ 218c8ce540dSDarrick J. Wong uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ 21984be0ffcSDave Chinner xfs_btnum_t bc_btnum; /* identifies which btree type */ 22011ef38afSDave Chinner int bc_statoff; /* offset of btre stats array */ 22184be0ffcSDave Chinner union { 22284be0ffcSDave Chinner struct { /* needed for BNO, CNT, INO */ 22384be0ffcSDave Chinner struct xfs_buf *agbp; /* agf/agi buffer pointer */ 2242c3234d1SDarrick J. Wong struct xfs_defer_ops *dfops; /* deferred updates */ 22584be0ffcSDave Chinner xfs_agnumber_t agno; /* ag number */ 2261946b91cSDarrick J. Wong union xfs_btree_cur_private priv; 22784be0ffcSDave Chinner } a; 22884be0ffcSDave Chinner struct { /* needed for BMAP */ 22984be0ffcSDave Chinner struct xfs_inode *ip; /* pointer to our inode */ 2302c3234d1SDarrick J. Wong struct xfs_defer_ops *dfops; /* deferred updates */ 23184be0ffcSDave Chinner xfs_fsblock_t firstblock; /* 1st blk allocated */ 23284be0ffcSDave Chinner int allocated; /* count of alloced */ 23384be0ffcSDave Chinner short forksize; /* fork's inode space */ 23484be0ffcSDave Chinner char whichfork; /* data or attr fork */ 23584be0ffcSDave Chinner char flags; /* flags */ 23699c794c6SBrian Foster #define XFS_BTCUR_BPRV_WASDEL (1<<0) /* was delayed */ 23799c794c6SBrian Foster #define XFS_BTCUR_BPRV_INVALID_OWNER (1<<1) /* for ext swap */ 23884be0ffcSDave Chinner } b; 23984be0ffcSDave Chinner } bc_private; /* per-btree type data */ 24084be0ffcSDave Chinner } xfs_btree_cur_t; 24184be0ffcSDave Chinner 24284be0ffcSDave Chinner /* cursor flags */ 24384be0ffcSDave Chinner #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */ 24484be0ffcSDave Chinner #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */ 24584be0ffcSDave Chinner #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */ 24684be0ffcSDave Chinner #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */ 2472c813ad6SDarrick J. Wong #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */ 24884be0ffcSDave Chinner 24984be0ffcSDave Chinner 25084be0ffcSDave Chinner #define XFS_BTREE_NOERROR 0 25184be0ffcSDave Chinner #define XFS_BTREE_ERROR 1 25284be0ffcSDave Chinner 25384be0ffcSDave Chinner /* 25484be0ffcSDave Chinner * Convert from buffer to btree block header. 25584be0ffcSDave Chinner */ 25684be0ffcSDave Chinner #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr)) 25784be0ffcSDave Chinner 25852c732eeSDarrick J. Wong /* 25952c732eeSDarrick J. Wong * Internal long and short btree block checks. They return NULL if the 26052c732eeSDarrick J. Wong * block is ok or the address of the failed check otherwise. 26152c732eeSDarrick J. Wong */ 26252c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur, 26352c732eeSDarrick J. Wong struct xfs_btree_block *block, int level, struct xfs_buf *bp); 26452c732eeSDarrick J. Wong xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur, 26552c732eeSDarrick J. Wong struct xfs_btree_block *block, int level, struct xfs_buf *bp); 26684be0ffcSDave Chinner 26784be0ffcSDave Chinner /* 26884be0ffcSDave Chinner * Check that block header is ok. 26984be0ffcSDave Chinner */ 27084be0ffcSDave Chinner int 27184be0ffcSDave Chinner xfs_btree_check_block( 27284be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 27384be0ffcSDave Chinner struct xfs_btree_block *block, /* generic btree block pointer */ 27484be0ffcSDave Chinner int level, /* level of the btree block */ 27584be0ffcSDave Chinner struct xfs_buf *bp); /* buffer containing block, if any */ 27684be0ffcSDave Chinner 27784be0ffcSDave Chinner /* 27884be0ffcSDave Chinner * Check that (long) pointer is ok. 27984be0ffcSDave Chinner */ 280f135761aSDarrick J. Wong bool /* error (0 or EFSCORRUPTED) */ 28184be0ffcSDave Chinner xfs_btree_check_lptr( 28284be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 283f135761aSDarrick J. Wong xfs_fsblock_t fsbno, /* btree block disk address */ 284f135761aSDarrick J. Wong int level); /* btree block level */ 285f135761aSDarrick J. Wong 286f135761aSDarrick J. Wong /* 287f135761aSDarrick J. Wong * Check that (short) pointer is ok. 288f135761aSDarrick J. Wong */ 289f135761aSDarrick J. Wong bool /* error (0 or EFSCORRUPTED) */ 290f135761aSDarrick J. Wong xfs_btree_check_sptr( 291f135761aSDarrick J. Wong struct xfs_btree_cur *cur, /* btree cursor */ 292f135761aSDarrick J. Wong xfs_agblock_t agbno, /* btree block disk address */ 29384be0ffcSDave Chinner int level); /* btree block level */ 29484be0ffcSDave Chinner 29584be0ffcSDave Chinner /* 29684be0ffcSDave Chinner * Delete the btree cursor. 29784be0ffcSDave Chinner */ 29884be0ffcSDave Chinner void 29984be0ffcSDave Chinner xfs_btree_del_cursor( 30084be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 30184be0ffcSDave Chinner int error); /* del because of error */ 30284be0ffcSDave Chinner 30384be0ffcSDave Chinner /* 30484be0ffcSDave Chinner * Duplicate the btree cursor. 30584be0ffcSDave Chinner * Allocate a new one, copy the record, re-get the buffers. 30684be0ffcSDave Chinner */ 30784be0ffcSDave Chinner int /* error */ 30884be0ffcSDave Chinner xfs_btree_dup_cursor( 30984be0ffcSDave Chinner xfs_btree_cur_t *cur, /* input cursor */ 31084be0ffcSDave Chinner xfs_btree_cur_t **ncur);/* output cursor */ 31184be0ffcSDave Chinner 31284be0ffcSDave Chinner /* 31384be0ffcSDave Chinner * Get a buffer for the block, return it with no data read. 31484be0ffcSDave Chinner * Long-form addressing. 31584be0ffcSDave Chinner */ 31684be0ffcSDave Chinner struct xfs_buf * /* buffer for fsbno */ 31784be0ffcSDave Chinner xfs_btree_get_bufl( 31884be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 31984be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 32084be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 32184be0ffcSDave Chinner uint lock); /* lock flags for get_buf */ 32284be0ffcSDave Chinner 32384be0ffcSDave Chinner /* 32484be0ffcSDave Chinner * Get a buffer for the block, return it with no data read. 32584be0ffcSDave Chinner * Short-form addressing. 32684be0ffcSDave Chinner */ 32784be0ffcSDave Chinner struct xfs_buf * /* buffer for agno/agbno */ 32884be0ffcSDave Chinner xfs_btree_get_bufs( 32984be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 33084be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 33184be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 33284be0ffcSDave Chinner xfs_agblock_t agbno, /* allocation group block number */ 33384be0ffcSDave Chinner uint lock); /* lock flags for get_buf */ 33484be0ffcSDave Chinner 33584be0ffcSDave Chinner /* 33684be0ffcSDave Chinner * Check for the cursor referring to the last block at the given level. 33784be0ffcSDave Chinner */ 33884be0ffcSDave Chinner int /* 1=is last block, 0=not last block */ 33984be0ffcSDave Chinner xfs_btree_islastblock( 34084be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 34184be0ffcSDave Chinner int level); /* level to check */ 34284be0ffcSDave Chinner 34384be0ffcSDave Chinner /* 34484be0ffcSDave Chinner * Compute first and last byte offsets for the fields given. 34584be0ffcSDave Chinner * Interprets the offsets table, which contains struct field offsets. 34684be0ffcSDave Chinner */ 34784be0ffcSDave Chinner void 34884be0ffcSDave Chinner xfs_btree_offsets( 349c8ce540dSDarrick J. Wong int64_t fields, /* bitmask of fields */ 35084be0ffcSDave Chinner const short *offsets,/* table of field offsets */ 35184be0ffcSDave Chinner int nbits, /* number of bits to inspect */ 35284be0ffcSDave Chinner int *first, /* output: first byte offset */ 35384be0ffcSDave Chinner int *last); /* output: last byte offset */ 35484be0ffcSDave Chinner 35584be0ffcSDave Chinner /* 35684be0ffcSDave Chinner * Get a buffer for the block, return it read in. 35784be0ffcSDave Chinner * Long-form addressing. 35884be0ffcSDave Chinner */ 35984be0ffcSDave Chinner int /* error */ 36084be0ffcSDave Chinner xfs_btree_read_bufl( 36184be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 36284be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 36384be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 36484be0ffcSDave Chinner uint lock, /* lock flags for read_buf */ 36584be0ffcSDave Chinner struct xfs_buf **bpp, /* buffer for fsbno */ 36684be0ffcSDave Chinner int refval, /* ref count value for buffer */ 36784be0ffcSDave Chinner const struct xfs_buf_ops *ops); 36884be0ffcSDave Chinner 36984be0ffcSDave Chinner /* 37084be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 37184be0ffcSDave Chinner * Long-form addressing. 37284be0ffcSDave Chinner */ 37384be0ffcSDave Chinner void /* error */ 37484be0ffcSDave Chinner xfs_btree_reada_bufl( 37584be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 37684be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 37784be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 37884be0ffcSDave Chinner const struct xfs_buf_ops *ops); 37984be0ffcSDave Chinner 38084be0ffcSDave Chinner /* 38184be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 38284be0ffcSDave Chinner * Short-form addressing. 38384be0ffcSDave Chinner */ 38484be0ffcSDave Chinner void /* error */ 38584be0ffcSDave Chinner xfs_btree_reada_bufs( 38684be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 38784be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 38884be0ffcSDave Chinner xfs_agblock_t agbno, /* allocation group block number */ 38984be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 39084be0ffcSDave Chinner const struct xfs_buf_ops *ops); 39184be0ffcSDave Chinner 39284be0ffcSDave Chinner /* 39384be0ffcSDave Chinner * Initialise a new btree block header 39484be0ffcSDave Chinner */ 39584be0ffcSDave Chinner void 39684be0ffcSDave Chinner xfs_btree_init_block( 39784be0ffcSDave Chinner struct xfs_mount *mp, 39884be0ffcSDave Chinner struct xfs_buf *bp, 399b6f41e44SEric Sandeen xfs_btnum_t btnum, 40084be0ffcSDave Chinner __u16 level, 40184be0ffcSDave Chinner __u16 numrecs, 40284be0ffcSDave Chinner __u64 owner, 40384be0ffcSDave Chinner unsigned int flags); 40484be0ffcSDave Chinner 40584be0ffcSDave Chinner void 40684be0ffcSDave Chinner xfs_btree_init_block_int( 40784be0ffcSDave Chinner struct xfs_mount *mp, 40884be0ffcSDave Chinner struct xfs_btree_block *buf, 40984be0ffcSDave Chinner xfs_daddr_t blkno, 410b6f41e44SEric Sandeen xfs_btnum_t btnum, 41184be0ffcSDave Chinner __u16 level, 41284be0ffcSDave Chinner __u16 numrecs, 41384be0ffcSDave Chinner __u64 owner, 41484be0ffcSDave Chinner unsigned int flags); 41584be0ffcSDave Chinner 41684be0ffcSDave Chinner /* 41784be0ffcSDave Chinner * Common btree core entry points. 41884be0ffcSDave Chinner */ 41984be0ffcSDave Chinner int xfs_btree_increment(struct xfs_btree_cur *, int, int *); 42084be0ffcSDave Chinner int xfs_btree_decrement(struct xfs_btree_cur *, int, int *); 42184be0ffcSDave Chinner int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *); 42284be0ffcSDave Chinner int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *); 42384be0ffcSDave Chinner int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *); 42484be0ffcSDave Chinner int xfs_btree_insert(struct xfs_btree_cur *, int *); 42584be0ffcSDave Chinner int xfs_btree_delete(struct xfs_btree_cur *, int *); 42684be0ffcSDave Chinner int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *); 427c8ce540dSDarrick J. Wong int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner, 42884be0ffcSDave Chinner struct list_head *buffer_list); 42984be0ffcSDave Chinner 43084be0ffcSDave Chinner /* 43184be0ffcSDave Chinner * btree block CRC helpers 43284be0ffcSDave Chinner */ 43384be0ffcSDave Chinner void xfs_btree_lblock_calc_crc(struct xfs_buf *); 43484be0ffcSDave Chinner bool xfs_btree_lblock_verify_crc(struct xfs_buf *); 43584be0ffcSDave Chinner void xfs_btree_sblock_calc_crc(struct xfs_buf *); 43684be0ffcSDave Chinner bool xfs_btree_sblock_verify_crc(struct xfs_buf *); 43784be0ffcSDave Chinner 43884be0ffcSDave Chinner /* 43984be0ffcSDave Chinner * Internal btree helpers also used by xfs_bmap.c. 44084be0ffcSDave Chinner */ 44184be0ffcSDave Chinner void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int); 44284be0ffcSDave Chinner void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int); 44384be0ffcSDave Chinner 44484be0ffcSDave Chinner /* 44584be0ffcSDave Chinner * Helpers. 44684be0ffcSDave Chinner */ 44784be0ffcSDave Chinner static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block) 44884be0ffcSDave Chinner { 44984be0ffcSDave Chinner return be16_to_cpu(block->bb_numrecs); 45084be0ffcSDave Chinner } 45184be0ffcSDave Chinner 45284be0ffcSDave Chinner static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block, 453c8ce540dSDarrick J. Wong uint16_t numrecs) 45484be0ffcSDave Chinner { 45584be0ffcSDave Chinner block->bb_numrecs = cpu_to_be16(numrecs); 45684be0ffcSDave Chinner } 45784be0ffcSDave Chinner 45884be0ffcSDave Chinner static inline int xfs_btree_get_level(struct xfs_btree_block *block) 45984be0ffcSDave Chinner { 46084be0ffcSDave Chinner return be16_to_cpu(block->bb_level); 46184be0ffcSDave Chinner } 46284be0ffcSDave Chinner 46384be0ffcSDave Chinner 46484be0ffcSDave Chinner /* 46584be0ffcSDave Chinner * Min and max functions for extlen, agblock, fileoff, and filblks types. 46684be0ffcSDave Chinner */ 46784be0ffcSDave Chinner #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) 46884be0ffcSDave Chinner #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) 46984be0ffcSDave Chinner #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) 47084be0ffcSDave Chinner #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) 47184be0ffcSDave Chinner #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) 47284be0ffcSDave Chinner #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) 47384be0ffcSDave Chinner #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) 47484be0ffcSDave Chinner #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) 47584be0ffcSDave Chinner 476a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp); 477a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp, 478a6a781a5SDarrick J. Wong unsigned int max_recs); 479a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp, 480a6a781a5SDarrick J. Wong uint64_t owner); 481a6a781a5SDarrick J. Wong xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp, 482a6a781a5SDarrick J. Wong unsigned int max_recs); 4838368a601SDarrick J. Wong 484a1f69417SEric Sandeen uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len); 485a1f69417SEric Sandeen xfs_extlen_t xfs_btree_calc_size(uint *limits, unsigned long long len); 486c5ab131bSDarrick J. Wong 487105f7d83SDarrick J. Wong /* return codes */ 488105f7d83SDarrick J. Wong #define XFS_BTREE_QUERY_RANGE_CONTINUE 0 /* keep iterating */ 489105f7d83SDarrick J. Wong #define XFS_BTREE_QUERY_RANGE_ABORT 1 /* stop iterating */ 490105f7d83SDarrick J. Wong typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur, 491105f7d83SDarrick J. Wong union xfs_btree_rec *rec, void *priv); 492105f7d83SDarrick J. Wong 493105f7d83SDarrick J. Wong int xfs_btree_query_range(struct xfs_btree_cur *cur, 494105f7d83SDarrick J. Wong union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec, 495105f7d83SDarrick J. Wong xfs_btree_query_range_fn fn, void *priv); 496e9a2599aSDarrick J. Wong int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn, 497e9a2599aSDarrick J. Wong void *priv); 498105f7d83SDarrick J. Wong 49928a89567SDarrick J. Wong typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level, 50028a89567SDarrick J. Wong void *data); 50128a89567SDarrick J. Wong int xfs_btree_visit_blocks(struct xfs_btree_cur *cur, 50228a89567SDarrick J. Wong xfs_btree_visit_blocks_fn fn, void *data); 50328a89567SDarrick J. Wong 504c611cc03SDarrick J. Wong int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks); 505c611cc03SDarrick J. Wong 50626788097SDarrick J. Wong union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n, 50726788097SDarrick J. Wong struct xfs_btree_block *block); 50826788097SDarrick J. Wong union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n, 50926788097SDarrick J. Wong struct xfs_btree_block *block); 51026788097SDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n, 51126788097SDarrick J. Wong struct xfs_btree_block *block); 51226788097SDarrick J. Wong union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n, 51326788097SDarrick J. Wong struct xfs_btree_block *block); 51426788097SDarrick J. Wong int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level, 51526788097SDarrick J. Wong union xfs_btree_ptr *pp, struct xfs_btree_block **blkp); 51626788097SDarrick J. Wong struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur, 51726788097SDarrick J. Wong int level, struct xfs_buf **bpp); 518cc3e0948SDarrick J. Wong bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr); 519cc3e0948SDarrick J. Wong int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur, 520cc3e0948SDarrick J. Wong const union xfs_btree_ptr *a, 521cc3e0948SDarrick J. Wong const union xfs_btree_ptr *b); 522cc3e0948SDarrick J. Wong void xfs_btree_get_sibling(struct xfs_btree_cur *cur, 523cc3e0948SDarrick J. Wong struct xfs_btree_block *block, 524cc3e0948SDarrick J. Wong union xfs_btree_ptr *ptr, int lr); 5252fdbec5cSDarrick J. Wong void xfs_btree_get_keys(struct xfs_btree_cur *cur, 5262fdbec5cSDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 5272fdbec5cSDarrick J. Wong union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur, 5282fdbec5cSDarrick J. Wong union xfs_btree_key *key); 529ce1d802eSDarrick J. Wong int xfs_btree_has_record(struct xfs_btree_cur *cur, union xfs_btree_irec *low, 530ce1d802eSDarrick J. Wong union xfs_btree_irec *high, bool *exists); 53126788097SDarrick J. Wong 53284be0ffcSDave Chinner #endif /* __XFS_BTREE_H__ */ 533