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 4084be0ffcSDave Chinner union xfs_btree_key { 41035e00acSDarrick J. Wong struct xfs_bmbt_key bmbt; 4284be0ffcSDave Chinner xfs_bmdr_key_t bmbr; /* bmbt root block */ 4384be0ffcSDave Chinner xfs_alloc_key_t alloc; 44035e00acSDarrick J. Wong struct xfs_inobt_key inobt; 45035e00acSDarrick J. Wong struct xfs_rmap_key rmap; 4684be0ffcSDave Chinner }; 4784be0ffcSDave Chinner 482c813ad6SDarrick J. Wong /* 492c813ad6SDarrick J. Wong * In-core key that holds both low and high keys for overlapped btrees. 502c813ad6SDarrick J. Wong * The two keys are packed next to each other on disk, so do the same 512c813ad6SDarrick J. Wong * in memory. Preserve the existing xfs_btree_key as a single key to 522c813ad6SDarrick J. Wong * avoid the mental model breakage that would happen if we passed a 532c813ad6SDarrick J. Wong * bigkey into a function that operates on a single key. 542c813ad6SDarrick J. Wong */ 552c813ad6SDarrick J. Wong union xfs_btree_bigkey { 562c813ad6SDarrick J. Wong struct xfs_bmbt_key bmbt; 572c813ad6SDarrick J. Wong xfs_bmdr_key_t bmbr; /* bmbt root block */ 582c813ad6SDarrick J. Wong xfs_alloc_key_t alloc; 592c813ad6SDarrick J. Wong struct xfs_inobt_key inobt; 60035e00acSDarrick J. Wong struct { 61035e00acSDarrick J. Wong struct xfs_rmap_key rmap; 62035e00acSDarrick J. Wong struct xfs_rmap_key rmap_hi; 63035e00acSDarrick J. Wong }; 642c813ad6SDarrick J. Wong }; 652c813ad6SDarrick J. Wong 6684be0ffcSDave Chinner union xfs_btree_rec { 67035e00acSDarrick J. Wong struct xfs_bmbt_rec bmbt; 6884be0ffcSDave Chinner xfs_bmdr_rec_t bmbr; /* bmbt root block */ 69035e00acSDarrick J. Wong struct xfs_alloc_rec alloc; 70035e00acSDarrick J. Wong struct xfs_inobt_rec inobt; 71035e00acSDarrick J. Wong struct xfs_rmap_rec rmap; 7284be0ffcSDave Chinner }; 7384be0ffcSDave Chinner 7484be0ffcSDave Chinner /* 7584be0ffcSDave Chinner * This nonsense is to make -wlint happy. 7684be0ffcSDave Chinner */ 7784be0ffcSDave Chinner #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) 7884be0ffcSDave Chinner #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) 7984be0ffcSDave Chinner #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) 8084be0ffcSDave Chinner 8184be0ffcSDave Chinner #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) 8284be0ffcSDave Chinner #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) 8384be0ffcSDave Chinner #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) 8484be0ffcSDave Chinner #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) 8584be0ffcSDave Chinner #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi) 86b8704944SDarrick J. Wong #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi) 8784be0ffcSDave Chinner 8884be0ffcSDave Chinner /* 8984be0ffcSDave Chinner * For logging record fields. 9084be0ffcSDave Chinner */ 9184be0ffcSDave Chinner #define XFS_BB_MAGIC (1 << 0) 9284be0ffcSDave Chinner #define XFS_BB_LEVEL (1 << 1) 9384be0ffcSDave Chinner #define XFS_BB_NUMRECS (1 << 2) 9484be0ffcSDave Chinner #define XFS_BB_LEFTSIB (1 << 3) 9584be0ffcSDave Chinner #define XFS_BB_RIGHTSIB (1 << 4) 9684be0ffcSDave Chinner #define XFS_BB_BLKNO (1 << 5) 9784be0ffcSDave Chinner #define XFS_BB_LSN (1 << 6) 9884be0ffcSDave Chinner #define XFS_BB_UUID (1 << 7) 9984be0ffcSDave Chinner #define XFS_BB_OWNER (1 << 8) 10084be0ffcSDave Chinner #define XFS_BB_NUM_BITS 5 10184be0ffcSDave Chinner #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) 10284be0ffcSDave Chinner #define XFS_BB_NUM_BITS_CRC 9 10384be0ffcSDave Chinner #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1) 10484be0ffcSDave Chinner 10584be0ffcSDave Chinner /* 10684be0ffcSDave Chinner * Generic stats interface 10784be0ffcSDave Chinner */ 108ff6d6af2SBill O'Donnell #define __XFS_BTREE_STATS_INC(mp, type, stat) \ 109ff6d6af2SBill O'Donnell XFS_STATS_INC(mp, xs_ ## type ## _2_ ## stat) 11084be0ffcSDave Chinner #define XFS_BTREE_STATS_INC(cur, stat) \ 11184be0ffcSDave Chinner do { \ 112ff6d6af2SBill O'Donnell struct xfs_mount *__mp = cur->bc_mp; \ 11384be0ffcSDave Chinner switch (cur->bc_btnum) { \ 114ff6d6af2SBill O'Donnell case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(__mp, abtb, stat); break; \ 115ff6d6af2SBill O'Donnell case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(__mp, abtc, stat); break; \ 116ff6d6af2SBill O'Donnell case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(__mp, bmbt, stat); break; \ 117ff6d6af2SBill O'Donnell case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(__mp, ibt, stat); break; \ 118ff6d6af2SBill O'Donnell case XFS_BTNUM_FINO: __XFS_BTREE_STATS_INC(__mp, fibt, stat); break; \ 11900f4e4f9SDarrick J. Wong case XFS_BTNUM_RMAP: __XFS_BTREE_STATS_INC(__mp, rmap, stat); break; \ 12084be0ffcSDave Chinner case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \ 12184be0ffcSDave Chinner } \ 12284be0ffcSDave Chinner } while (0) 12384be0ffcSDave Chinner 124ff6d6af2SBill O'Donnell #define __XFS_BTREE_STATS_ADD(mp, type, stat, val) \ 125ff6d6af2SBill O'Donnell XFS_STATS_ADD(mp, xs_ ## type ## _2_ ## stat, val) 12684be0ffcSDave Chinner #define XFS_BTREE_STATS_ADD(cur, stat, val) \ 12784be0ffcSDave Chinner do { \ 128ff6d6af2SBill O'Donnell struct xfs_mount *__mp = cur->bc_mp; \ 12984be0ffcSDave Chinner switch (cur->bc_btnum) { \ 130ff6d6af2SBill O'Donnell case XFS_BTNUM_BNO: \ 131ff6d6af2SBill O'Donnell __XFS_BTREE_STATS_ADD(__mp, abtb, stat, val); break; \ 132ff6d6af2SBill O'Donnell case XFS_BTNUM_CNT: \ 133ff6d6af2SBill O'Donnell __XFS_BTREE_STATS_ADD(__mp, abtc, stat, val); break; \ 134ff6d6af2SBill O'Donnell case XFS_BTNUM_BMAP: \ 135ff6d6af2SBill O'Donnell __XFS_BTREE_STATS_ADD(__mp, bmbt, stat, val); break; \ 136ff6d6af2SBill O'Donnell case XFS_BTNUM_INO: \ 137ff6d6af2SBill O'Donnell __XFS_BTREE_STATS_ADD(__mp, ibt, stat, val); break; \ 138ff6d6af2SBill O'Donnell case XFS_BTNUM_FINO: \ 139ff6d6af2SBill O'Donnell __XFS_BTREE_STATS_ADD(__mp, fibt, stat, val); break; \ 14000f4e4f9SDarrick J. Wong case XFS_BTNUM_RMAP: \ 14100f4e4f9SDarrick J. Wong __XFS_BTREE_STATS_ADD(__mp, rmap, stat, val); break; \ 14284be0ffcSDave Chinner case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \ 14384be0ffcSDave Chinner } \ 14484be0ffcSDave Chinner } while (0) 14584be0ffcSDave Chinner 146df3954ffSDarrick J. Wong #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */ 14784be0ffcSDave Chinner 14884be0ffcSDave Chinner struct xfs_btree_ops { 14984be0ffcSDave Chinner /* size of the key and record structures */ 15084be0ffcSDave Chinner size_t key_len; 15184be0ffcSDave Chinner size_t rec_len; 15284be0ffcSDave Chinner 15384be0ffcSDave Chinner /* cursor operations */ 15484be0ffcSDave Chinner struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *); 15584be0ffcSDave Chinner void (*update_cursor)(struct xfs_btree_cur *src, 15684be0ffcSDave Chinner struct xfs_btree_cur *dst); 15784be0ffcSDave Chinner 15884be0ffcSDave Chinner /* update btree root pointer */ 15984be0ffcSDave Chinner void (*set_root)(struct xfs_btree_cur *cur, 16084be0ffcSDave Chinner union xfs_btree_ptr *nptr, int level_change); 16184be0ffcSDave Chinner 16284be0ffcSDave Chinner /* block allocation / freeing */ 16384be0ffcSDave Chinner int (*alloc_block)(struct xfs_btree_cur *cur, 16484be0ffcSDave Chinner union xfs_btree_ptr *start_bno, 16584be0ffcSDave Chinner union xfs_btree_ptr *new_bno, 16684be0ffcSDave Chinner int *stat); 16784be0ffcSDave Chinner int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp); 16884be0ffcSDave Chinner 16984be0ffcSDave Chinner /* update last record information */ 17084be0ffcSDave Chinner void (*update_lastrec)(struct xfs_btree_cur *cur, 17184be0ffcSDave Chinner struct xfs_btree_block *block, 17284be0ffcSDave Chinner union xfs_btree_rec *rec, 17384be0ffcSDave Chinner int ptr, int reason); 17484be0ffcSDave Chinner 17584be0ffcSDave Chinner /* records in block/level */ 17684be0ffcSDave Chinner int (*get_minrecs)(struct xfs_btree_cur *cur, int level); 17784be0ffcSDave Chinner int (*get_maxrecs)(struct xfs_btree_cur *cur, int level); 17884be0ffcSDave Chinner 17984be0ffcSDave Chinner /* records on disk. Matter for the root in inode case. */ 18084be0ffcSDave Chinner int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level); 18184be0ffcSDave Chinner 18284be0ffcSDave Chinner /* init values of btree structures */ 18384be0ffcSDave Chinner void (*init_key_from_rec)(union xfs_btree_key *key, 18484be0ffcSDave Chinner union xfs_btree_rec *rec); 18584be0ffcSDave Chinner void (*init_rec_from_cur)(struct xfs_btree_cur *cur, 18684be0ffcSDave Chinner union xfs_btree_rec *rec); 18784be0ffcSDave Chinner void (*init_ptr_from_cur)(struct xfs_btree_cur *cur, 18884be0ffcSDave Chinner union xfs_btree_ptr *ptr); 1892c813ad6SDarrick J. Wong void (*init_high_key_from_rec)(union xfs_btree_key *key, 1902c813ad6SDarrick J. Wong union xfs_btree_rec *rec); 19184be0ffcSDave Chinner 19284be0ffcSDave Chinner /* difference between key value and cursor value */ 19384be0ffcSDave Chinner __int64_t (*key_diff)(struct xfs_btree_cur *cur, 19484be0ffcSDave Chinner union xfs_btree_key *key); 19584be0ffcSDave Chinner 1962c813ad6SDarrick J. Wong /* 1972c813ad6SDarrick J. Wong * Difference between key2 and key1 -- positive if key1 > key2, 1982c813ad6SDarrick J. Wong * negative if key1 < key2, and zero if equal. 1992c813ad6SDarrick J. Wong */ 2002c813ad6SDarrick J. Wong __int64_t (*diff_two_keys)(struct xfs_btree_cur *cur, 2012c813ad6SDarrick J. Wong union xfs_btree_key *key1, 2022c813ad6SDarrick J. Wong union xfs_btree_key *key2); 2032c813ad6SDarrick J. Wong 20484be0ffcSDave Chinner const struct xfs_buf_ops *buf_ops; 20584be0ffcSDave Chinner 20684be0ffcSDave Chinner #if defined(DEBUG) || defined(XFS_WARN) 20784be0ffcSDave Chinner /* check that k1 is lower than k2 */ 20884be0ffcSDave Chinner int (*keys_inorder)(struct xfs_btree_cur *cur, 20984be0ffcSDave Chinner union xfs_btree_key *k1, 21084be0ffcSDave Chinner union xfs_btree_key *k2); 21184be0ffcSDave Chinner 21284be0ffcSDave Chinner /* check that r1 is lower than r2 */ 21384be0ffcSDave Chinner int (*recs_inorder)(struct xfs_btree_cur *cur, 21484be0ffcSDave Chinner union xfs_btree_rec *r1, 21584be0ffcSDave Chinner union xfs_btree_rec *r2); 21684be0ffcSDave Chinner #endif 21770b22659SDarrick J. Wong 21870b22659SDarrick J. Wong /* derive the low & high keys from the records in a leaf block */ 21970b22659SDarrick J. Wong void (*get_leaf_keys)(struct xfs_btree_cur *cur, 22070b22659SDarrick J. Wong struct xfs_btree_block *block, 22170b22659SDarrick J. Wong union xfs_btree_key *key); 22270b22659SDarrick J. Wong 22370b22659SDarrick J. Wong /* derive the low & high keys from the keys in a node block */ 22470b22659SDarrick J. Wong void (*get_node_keys)(struct xfs_btree_cur *cur, 22570b22659SDarrick J. Wong struct xfs_btree_block *block, 22670b22659SDarrick J. Wong union xfs_btree_key *key); 22770b22659SDarrick J. Wong 22870b22659SDarrick J. Wong /* update the parent keys of given btree level */ 22970b22659SDarrick J. Wong int (*update_keys)(struct xfs_btree_cur *cur, int level); 23084be0ffcSDave Chinner }; 23184be0ffcSDave Chinner 23284be0ffcSDave Chinner /* 23384be0ffcSDave Chinner * Reasons for the update_lastrec method to be called. 23484be0ffcSDave Chinner */ 23584be0ffcSDave Chinner #define LASTREC_UPDATE 0 23684be0ffcSDave Chinner #define LASTREC_INSREC 1 23784be0ffcSDave Chinner #define LASTREC_DELREC 2 23884be0ffcSDave Chinner 23984be0ffcSDave Chinner 240105f7d83SDarrick J. Wong union xfs_btree_irec { 241105f7d83SDarrick J. Wong struct xfs_alloc_rec_incore a; 242105f7d83SDarrick J. Wong struct xfs_bmbt_irec b; 243105f7d83SDarrick J. Wong struct xfs_inobt_rec_incore i; 2444b8ed677SDarrick J. Wong struct xfs_rmap_irec r; 245105f7d83SDarrick J. Wong }; 246105f7d83SDarrick J. Wong 24784be0ffcSDave Chinner /* 24884be0ffcSDave Chinner * Btree cursor structure. 24984be0ffcSDave Chinner * This collects all information needed by the btree code in one place. 25084be0ffcSDave Chinner */ 25184be0ffcSDave Chinner typedef struct xfs_btree_cur 25284be0ffcSDave Chinner { 25384be0ffcSDave Chinner struct xfs_trans *bc_tp; /* transaction we're in, if any */ 25484be0ffcSDave Chinner struct xfs_mount *bc_mp; /* file system mount struct */ 25584be0ffcSDave Chinner const struct xfs_btree_ops *bc_ops; 25684be0ffcSDave Chinner uint bc_flags; /* btree features - below */ 257105f7d83SDarrick J. Wong union xfs_btree_irec bc_rec; /* current insert/search record value */ 25884be0ffcSDave Chinner struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ 25984be0ffcSDave Chinner int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ 26084be0ffcSDave Chinner __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ 26184be0ffcSDave Chinner #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ 26284be0ffcSDave Chinner #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ 26384be0ffcSDave Chinner __uint8_t bc_nlevels; /* number of levels in the tree */ 26484be0ffcSDave Chinner __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ 26584be0ffcSDave Chinner xfs_btnum_t bc_btnum; /* identifies which btree type */ 26684be0ffcSDave Chinner union { 26784be0ffcSDave Chinner struct { /* needed for BNO, CNT, INO */ 26884be0ffcSDave Chinner struct xfs_buf *agbp; /* agf/agi buffer pointer */ 2692c3234d1SDarrick J. Wong struct xfs_defer_ops *dfops; /* deferred updates */ 27084be0ffcSDave Chinner xfs_agnumber_t agno; /* ag number */ 27184be0ffcSDave Chinner } a; 27284be0ffcSDave Chinner struct { /* needed for BMAP */ 27384be0ffcSDave Chinner struct xfs_inode *ip; /* pointer to our inode */ 2742c3234d1SDarrick J. Wong struct xfs_defer_ops *dfops; /* deferred updates */ 27584be0ffcSDave Chinner xfs_fsblock_t firstblock; /* 1st blk allocated */ 27684be0ffcSDave Chinner int allocated; /* count of alloced */ 27784be0ffcSDave Chinner short forksize; /* fork's inode space */ 27884be0ffcSDave Chinner char whichfork; /* data or attr fork */ 27984be0ffcSDave Chinner char flags; /* flags */ 28084be0ffcSDave Chinner #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */ 28184be0ffcSDave Chinner } b; 28284be0ffcSDave Chinner } bc_private; /* per-btree type data */ 28384be0ffcSDave Chinner } xfs_btree_cur_t; 28484be0ffcSDave Chinner 28584be0ffcSDave Chinner /* cursor flags */ 28684be0ffcSDave Chinner #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */ 28784be0ffcSDave Chinner #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */ 28884be0ffcSDave Chinner #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */ 28984be0ffcSDave Chinner #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */ 2902c813ad6SDarrick J. Wong #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */ 29184be0ffcSDave Chinner 29284be0ffcSDave Chinner 29384be0ffcSDave Chinner #define XFS_BTREE_NOERROR 0 29484be0ffcSDave Chinner #define XFS_BTREE_ERROR 1 29584be0ffcSDave Chinner 29684be0ffcSDave Chinner /* 29784be0ffcSDave Chinner * Convert from buffer to btree block header. 29884be0ffcSDave Chinner */ 29984be0ffcSDave Chinner #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr)) 30084be0ffcSDave Chinner 30184be0ffcSDave Chinner 30284be0ffcSDave Chinner /* 30384be0ffcSDave Chinner * Check that block header is ok. 30484be0ffcSDave Chinner */ 30584be0ffcSDave Chinner int 30684be0ffcSDave Chinner xfs_btree_check_block( 30784be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 30884be0ffcSDave Chinner struct xfs_btree_block *block, /* generic btree block pointer */ 30984be0ffcSDave Chinner int level, /* level of the btree block */ 31084be0ffcSDave Chinner struct xfs_buf *bp); /* buffer containing block, if any */ 31184be0ffcSDave Chinner 31284be0ffcSDave Chinner /* 31384be0ffcSDave Chinner * Check that (long) pointer is ok. 31484be0ffcSDave Chinner */ 31584be0ffcSDave Chinner int /* error (0 or EFSCORRUPTED) */ 31684be0ffcSDave Chinner xfs_btree_check_lptr( 31784be0ffcSDave Chinner struct xfs_btree_cur *cur, /* btree cursor */ 318d5cf09baSChristoph Hellwig xfs_fsblock_t ptr, /* btree block disk address */ 31984be0ffcSDave Chinner int level); /* btree block level */ 32084be0ffcSDave Chinner 32184be0ffcSDave Chinner /* 32284be0ffcSDave Chinner * Delete the btree cursor. 32384be0ffcSDave Chinner */ 32484be0ffcSDave Chinner void 32584be0ffcSDave Chinner xfs_btree_del_cursor( 32684be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 32784be0ffcSDave Chinner int error); /* del because of error */ 32884be0ffcSDave Chinner 32984be0ffcSDave Chinner /* 33084be0ffcSDave Chinner * Duplicate the btree cursor. 33184be0ffcSDave Chinner * Allocate a new one, copy the record, re-get the buffers. 33284be0ffcSDave Chinner */ 33384be0ffcSDave Chinner int /* error */ 33484be0ffcSDave Chinner xfs_btree_dup_cursor( 33584be0ffcSDave Chinner xfs_btree_cur_t *cur, /* input cursor */ 33684be0ffcSDave Chinner xfs_btree_cur_t **ncur);/* output cursor */ 33784be0ffcSDave Chinner 33884be0ffcSDave Chinner /* 33984be0ffcSDave Chinner * Get a buffer for the block, return it with no data read. 34084be0ffcSDave Chinner * Long-form addressing. 34184be0ffcSDave Chinner */ 34284be0ffcSDave Chinner struct xfs_buf * /* buffer for fsbno */ 34384be0ffcSDave Chinner xfs_btree_get_bufl( 34484be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 34584be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 34684be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 34784be0ffcSDave Chinner uint lock); /* lock flags for get_buf */ 34884be0ffcSDave Chinner 34984be0ffcSDave Chinner /* 35084be0ffcSDave Chinner * Get a buffer for the block, return it with no data read. 35184be0ffcSDave Chinner * Short-form addressing. 35284be0ffcSDave Chinner */ 35384be0ffcSDave Chinner struct xfs_buf * /* buffer for agno/agbno */ 35484be0ffcSDave Chinner xfs_btree_get_bufs( 35584be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 35684be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 35784be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 35884be0ffcSDave Chinner xfs_agblock_t agbno, /* allocation group block number */ 35984be0ffcSDave Chinner uint lock); /* lock flags for get_buf */ 36084be0ffcSDave Chinner 36184be0ffcSDave Chinner /* 36284be0ffcSDave Chinner * Check for the cursor referring to the last block at the given level. 36384be0ffcSDave Chinner */ 36484be0ffcSDave Chinner int /* 1=is last block, 0=not last block */ 36584be0ffcSDave Chinner xfs_btree_islastblock( 36684be0ffcSDave Chinner xfs_btree_cur_t *cur, /* btree cursor */ 36784be0ffcSDave Chinner int level); /* level to check */ 36884be0ffcSDave Chinner 36984be0ffcSDave Chinner /* 37084be0ffcSDave Chinner * Compute first and last byte offsets for the fields given. 37184be0ffcSDave Chinner * Interprets the offsets table, which contains struct field offsets. 37284be0ffcSDave Chinner */ 37384be0ffcSDave Chinner void 37484be0ffcSDave Chinner xfs_btree_offsets( 37584be0ffcSDave Chinner __int64_t fields, /* bitmask of fields */ 37684be0ffcSDave Chinner const short *offsets,/* table of field offsets */ 37784be0ffcSDave Chinner int nbits, /* number of bits to inspect */ 37884be0ffcSDave Chinner int *first, /* output: first byte offset */ 37984be0ffcSDave Chinner int *last); /* output: last byte offset */ 38084be0ffcSDave Chinner 38184be0ffcSDave Chinner /* 38284be0ffcSDave Chinner * Get a buffer for the block, return it read in. 38384be0ffcSDave Chinner * Long-form addressing. 38484be0ffcSDave Chinner */ 38584be0ffcSDave Chinner int /* error */ 38684be0ffcSDave Chinner xfs_btree_read_bufl( 38784be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 38884be0ffcSDave Chinner struct xfs_trans *tp, /* transaction pointer */ 38984be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 39084be0ffcSDave Chinner uint lock, /* lock flags for read_buf */ 39184be0ffcSDave Chinner struct xfs_buf **bpp, /* buffer for fsbno */ 39284be0ffcSDave Chinner int refval, /* ref count value for buffer */ 39384be0ffcSDave Chinner const struct xfs_buf_ops *ops); 39484be0ffcSDave Chinner 39584be0ffcSDave Chinner /* 39684be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 39784be0ffcSDave Chinner * Long-form addressing. 39884be0ffcSDave Chinner */ 39984be0ffcSDave Chinner void /* error */ 40084be0ffcSDave Chinner xfs_btree_reada_bufl( 40184be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 40284be0ffcSDave Chinner xfs_fsblock_t fsbno, /* file system block number */ 40384be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 40484be0ffcSDave Chinner const struct xfs_buf_ops *ops); 40584be0ffcSDave Chinner 40684be0ffcSDave Chinner /* 40784be0ffcSDave Chinner * Read-ahead the block, don't wait for it, don't return a buffer. 40884be0ffcSDave Chinner * Short-form addressing. 40984be0ffcSDave Chinner */ 41084be0ffcSDave Chinner void /* error */ 41184be0ffcSDave Chinner xfs_btree_reada_bufs( 41284be0ffcSDave Chinner struct xfs_mount *mp, /* file system mount point */ 41384be0ffcSDave Chinner xfs_agnumber_t agno, /* allocation group number */ 41484be0ffcSDave Chinner xfs_agblock_t agbno, /* allocation group block number */ 41584be0ffcSDave Chinner xfs_extlen_t count, /* count of filesystem blocks */ 41684be0ffcSDave Chinner const struct xfs_buf_ops *ops); 41784be0ffcSDave Chinner 41884be0ffcSDave Chinner /* 41984be0ffcSDave Chinner * Initialise a new btree block header 42084be0ffcSDave Chinner */ 42184be0ffcSDave Chinner void 42284be0ffcSDave Chinner xfs_btree_init_block( 42384be0ffcSDave Chinner struct xfs_mount *mp, 42484be0ffcSDave Chinner struct xfs_buf *bp, 42584be0ffcSDave Chinner __u32 magic, 42684be0ffcSDave Chinner __u16 level, 42784be0ffcSDave Chinner __u16 numrecs, 42884be0ffcSDave Chinner __u64 owner, 42984be0ffcSDave Chinner unsigned int flags); 43084be0ffcSDave Chinner 43184be0ffcSDave Chinner void 43284be0ffcSDave Chinner xfs_btree_init_block_int( 43384be0ffcSDave Chinner struct xfs_mount *mp, 43484be0ffcSDave Chinner struct xfs_btree_block *buf, 43584be0ffcSDave Chinner xfs_daddr_t blkno, 43684be0ffcSDave Chinner __u32 magic, 43784be0ffcSDave Chinner __u16 level, 43884be0ffcSDave Chinner __u16 numrecs, 43984be0ffcSDave Chinner __u64 owner, 44084be0ffcSDave Chinner unsigned int flags); 44184be0ffcSDave Chinner 44284be0ffcSDave Chinner /* 44384be0ffcSDave Chinner * Common btree core entry points. 44484be0ffcSDave Chinner */ 44584be0ffcSDave Chinner int xfs_btree_increment(struct xfs_btree_cur *, int, int *); 44684be0ffcSDave Chinner int xfs_btree_decrement(struct xfs_btree_cur *, int, int *); 44784be0ffcSDave Chinner int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *); 44884be0ffcSDave Chinner int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *); 44984be0ffcSDave Chinner int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *); 45084be0ffcSDave Chinner int xfs_btree_insert(struct xfs_btree_cur *, int *); 45184be0ffcSDave Chinner int xfs_btree_delete(struct xfs_btree_cur *, int *); 45284be0ffcSDave Chinner int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *); 45384be0ffcSDave Chinner int xfs_btree_change_owner(struct xfs_btree_cur *cur, __uint64_t new_owner, 45484be0ffcSDave Chinner struct list_head *buffer_list); 45584be0ffcSDave Chinner 45684be0ffcSDave Chinner /* 45784be0ffcSDave Chinner * btree block CRC helpers 45884be0ffcSDave Chinner */ 45984be0ffcSDave Chinner void xfs_btree_lblock_calc_crc(struct xfs_buf *); 46084be0ffcSDave Chinner bool xfs_btree_lblock_verify_crc(struct xfs_buf *); 46184be0ffcSDave Chinner void xfs_btree_sblock_calc_crc(struct xfs_buf *); 46284be0ffcSDave Chinner bool xfs_btree_sblock_verify_crc(struct xfs_buf *); 46384be0ffcSDave Chinner 46484be0ffcSDave Chinner /* 46584be0ffcSDave Chinner * Internal btree helpers also used by xfs_bmap.c. 46684be0ffcSDave Chinner */ 46784be0ffcSDave Chinner void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int); 46884be0ffcSDave Chinner void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int); 46984be0ffcSDave Chinner 47084be0ffcSDave Chinner /* 47184be0ffcSDave Chinner * Helpers. 47284be0ffcSDave Chinner */ 47384be0ffcSDave Chinner static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block) 47484be0ffcSDave Chinner { 47584be0ffcSDave Chinner return be16_to_cpu(block->bb_numrecs); 47684be0ffcSDave Chinner } 47784be0ffcSDave Chinner 47884be0ffcSDave Chinner static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block, 47984be0ffcSDave Chinner __uint16_t numrecs) 48084be0ffcSDave Chinner { 48184be0ffcSDave Chinner block->bb_numrecs = cpu_to_be16(numrecs); 48284be0ffcSDave Chinner } 48384be0ffcSDave Chinner 48484be0ffcSDave Chinner static inline int xfs_btree_get_level(struct xfs_btree_block *block) 48584be0ffcSDave Chinner { 48684be0ffcSDave Chinner return be16_to_cpu(block->bb_level); 48784be0ffcSDave Chinner } 48884be0ffcSDave Chinner 48984be0ffcSDave Chinner 49084be0ffcSDave Chinner /* 49184be0ffcSDave Chinner * Min and max functions for extlen, agblock, fileoff, and filblks types. 49284be0ffcSDave Chinner */ 49384be0ffcSDave Chinner #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) 49484be0ffcSDave Chinner #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) 49584be0ffcSDave Chinner #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) 49684be0ffcSDave Chinner #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) 49784be0ffcSDave Chinner #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) 49884be0ffcSDave Chinner #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) 49984be0ffcSDave Chinner #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) 50084be0ffcSDave Chinner #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) 50184be0ffcSDave Chinner 50284be0ffcSDave Chinner #define XFS_FSB_SANITY_CHECK(mp,fsb) \ 50384be0ffcSDave Chinner (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \ 50484be0ffcSDave Chinner XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks) 50584be0ffcSDave Chinner 50684be0ffcSDave Chinner /* 50784be0ffcSDave Chinner * Trace hooks. Currently not implemented as they need to be ported 50884be0ffcSDave Chinner * over to the generic tracing functionality, which is some effort. 50984be0ffcSDave Chinner * 51084be0ffcSDave Chinner * i,j = integer (32 bit) 51184be0ffcSDave Chinner * b = btree block buffer (xfs_buf_t) 51284be0ffcSDave Chinner * p = btree ptr 51384be0ffcSDave Chinner * r = btree record 51484be0ffcSDave Chinner * k = btree key 51584be0ffcSDave Chinner */ 51684be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGBI(c, b, i) 51784be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGBII(c, b, i, j) 51884be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGI(c, i) 51984be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGIPK(c, i, p, s) 52084be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGIPR(c, i, p, r) 52184be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGIK(c, i, k) 52284be0ffcSDave Chinner #define XFS_BTREE_TRACE_ARGR(c, r) 52384be0ffcSDave Chinner #define XFS_BTREE_TRACE_CURSOR(c, t) 52484be0ffcSDave Chinner 525c5ab131bSDarrick J. Wong bool xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp); 526c5ab131bSDarrick J. Wong bool xfs_btree_sblock_verify(struct xfs_buf *bp, unsigned int max_recs); 52719b54ee6SDarrick J. Wong uint xfs_btree_compute_maxlevels(struct xfs_mount *mp, uint *limits, 52819b54ee6SDarrick J. Wong unsigned long len); 529c5ab131bSDarrick J. Wong 53070b22659SDarrick J. Wong void xfs_btree_get_leaf_keys(struct xfs_btree_cur *cur, 53170b22659SDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 53270b22659SDarrick J. Wong void xfs_btree_get_node_keys(struct xfs_btree_cur *cur, 53370b22659SDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 53470b22659SDarrick J. Wong int xfs_btree_update_keys(struct xfs_btree_cur *cur, int level); 5352c813ad6SDarrick J. Wong void xfs_btree_get_leaf_keys_overlapped(struct xfs_btree_cur *cur, 5362c813ad6SDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 5372c813ad6SDarrick J. Wong void xfs_btree_get_node_keys_overlapped(struct xfs_btree_cur *cur, 5382c813ad6SDarrick J. Wong struct xfs_btree_block *block, union xfs_btree_key *key); 5392c813ad6SDarrick J. Wong int xfs_btree_update_keys_overlapped(struct xfs_btree_cur *cur, int level); 54070b22659SDarrick J. Wong 541105f7d83SDarrick J. Wong /* return codes */ 542105f7d83SDarrick J. Wong #define XFS_BTREE_QUERY_RANGE_CONTINUE 0 /* keep iterating */ 543105f7d83SDarrick J. Wong #define XFS_BTREE_QUERY_RANGE_ABORT 1 /* stop iterating */ 544105f7d83SDarrick J. Wong typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur, 545105f7d83SDarrick J. Wong union xfs_btree_rec *rec, void *priv); 546105f7d83SDarrick J. Wong 547105f7d83SDarrick J. Wong int xfs_btree_query_range(struct xfs_btree_cur *cur, 548105f7d83SDarrick J. Wong union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec, 549105f7d83SDarrick J. Wong xfs_btree_query_range_fn fn, void *priv); 550105f7d83SDarrick J. Wong 55128a89567SDarrick J. Wong typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level, 55228a89567SDarrick J. Wong void *data); 55328a89567SDarrick J. Wong int xfs_btree_visit_blocks(struct xfs_btree_cur *cur, 55428a89567SDarrick J. Wong xfs_btree_visit_blocks_fn fn, void *data); 55528a89567SDarrick J. Wong 55684be0ffcSDave Chinner #endif /* __XFS_BTREE_H__ */ 557