2 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 #ifndef __XFS_BTREE_H__
19 #define __XFS_BTREE_H__
27 extern kmem_zone_t *xfs_btree_cur_zone;
30 * This nonsense is to make -wlint happy.
32 #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi)
33 #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi)
34 #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi)
36 #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi)
37 #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi)
38 #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi)
39 #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi)
42 * Short form header: space allocation btrees.
44 typedef struct xfs_btree_sblock {
45 __be32 bb_magic; /* magic number for block type */
46 __be16 bb_level; /* 0 is a leaf */
47 __be16 bb_numrecs; /* current # of data records */
48 __be32 bb_leftsib; /* left sibling block or NULLAGBLOCK */
49 __be32 bb_rightsib; /* right sibling block or NULLAGBLOCK */
53 * Long form header: bmap btrees.
55 typedef struct xfs_btree_lblock {
56 __be32 bb_magic; /* magic number for block type */
57 __be16 bb_level; /* 0 is a leaf */
58 __be16 bb_numrecs; /* current # of data records */
59 __be64 bb_leftsib; /* left sibling block or NULLDFSBNO */
60 __be64 bb_rightsib; /* right sibling block or NULLDFSBNO */
64 * Combined header and structure, used by common code.
66 typedef struct xfs_btree_block {
67 __be32 bb_magic; /* magic number for block type */
68 __be16 bb_level; /* 0 is a leaf */
69 __be16 bb_numrecs; /* current # of data records */
74 } s; /* short form pointers */
78 } l; /* long form pointers */
83 * Generic key, ptr and record wrapper structures.
85 * These are disk format structures, and are converted where necessary
86 * by the btree specific code that needs to interpret them.
89 __be32 s; /* short form ptr */
90 __be64 l; /* long form ptr */
95 xfs_bmdr_key_t bmbr; /* bmbt root block */
96 xfs_alloc_key_t alloc;
97 xfs_inobt_key_t inobt;
100 union xfs_btree_rec {
102 xfs_bmdr_rec_t bmbr; /* bmbt root block */
103 xfs_alloc_rec_t alloc;
104 xfs_inobt_rec_t inobt;
108 * For logging record fields.
110 #define XFS_BB_MAGIC 0x01
111 #define XFS_BB_LEVEL 0x02
112 #define XFS_BB_NUMRECS 0x04
113 #define XFS_BB_LEFTSIB 0x08
114 #define XFS_BB_RIGHTSIB 0x10
115 #define XFS_BB_NUM_BITS 5
116 #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
119 * Magic numbers for btree blocks.
121 extern const __uint32_t xfs_magics[];
124 * Maximum and minimum records in a btree block.
125 * Given block size, type prefix, and leaf flag (0 or 1).
126 * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
129 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) \
130 ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
131 (((lf) * (uint)sizeof(t ## _rec_t)) + \
133 ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
134 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf) \
135 (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
138 * Record, key, and pointer address calculation macros.
139 * Given block size, type prefix, block pointer, and index of requested entry
140 * (first entry numbered 1).
142 #define XFS_BTREE_REC_ADDR(t,bb,i) \
143 ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
144 ((i) - 1) * sizeof(t ## _rec_t)))
145 #define XFS_BTREE_KEY_ADDR(t,bb,i) \
146 ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
147 ((i) - 1) * sizeof(t ## _key_t)))
148 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr) \
149 ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
150 (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
152 #define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */
154 struct xfs_btree_ops {
155 /* cursor operations */
156 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
160 * Btree cursor structure.
161 * This collects all information needed by the btree code in one place.
163 typedef struct xfs_btree_cur
165 struct xfs_trans *bc_tp; /* transaction we're in, if any */
166 struct xfs_mount *bc_mp; /* file system mount struct */
167 const struct xfs_btree_ops *bc_ops;
168 uint bc_flags; /* btree features - below */
170 xfs_alloc_rec_incore_t a;
172 xfs_inobt_rec_incore_t i;
173 } bc_rec; /* current insert/search record value */
174 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */
175 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
176 __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
177 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
178 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
179 __uint8_t bc_nlevels; /* number of levels in the tree */
180 __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
181 xfs_btnum_t bc_btnum; /* identifies which btree type */
183 struct { /* needed for BNO, CNT, INO */
184 struct xfs_buf *agbp; /* agf/agi buffer pointer */
185 xfs_agnumber_t agno; /* ag number */
187 struct { /* needed for BMAP */
188 struct xfs_inode *ip; /* pointer to our inode */
189 struct xfs_bmap_free *flist; /* list to free after */
190 xfs_fsblock_t firstblock; /* 1st blk allocated */
191 int allocated; /* count of alloced */
192 short forksize; /* fork's inode space */
193 char whichfork; /* data or attr fork */
194 char flags; /* flags */
195 #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
197 } bc_private; /* per-btree type data */
201 #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */
202 #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */
205 #define XFS_BTREE_NOERROR 0
206 #define XFS_BTREE_ERROR 1
209 * Convert from buffer to btree block header.
211 #define XFS_BUF_TO_BLOCK(bp) ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
212 #define XFS_BUF_TO_LBLOCK(bp) ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
213 #define XFS_BUF_TO_SBLOCK(bp) ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
219 * Check that long form block header is ok.
221 int /* error (0 or EFSCORRUPTED) */
222 xfs_btree_check_lblock(
223 struct xfs_btree_cur *cur, /* btree cursor */
224 struct xfs_btree_lblock *block, /* btree long form block pointer */
225 int level, /* level of the btree block */
226 struct xfs_buf *bp); /* buffer containing block, if any */
229 * Check that short form block header is ok.
231 int /* error (0 or EFSCORRUPTED) */
232 xfs_btree_check_sblock(
233 struct xfs_btree_cur *cur, /* btree cursor */
234 struct xfs_btree_sblock *block, /* btree short form block pointer */
235 int level, /* level of the btree block */
236 struct xfs_buf *bp); /* buffer containing block */
239 * Check that block header is ok.
242 xfs_btree_check_block(
243 struct xfs_btree_cur *cur, /* btree cursor */
244 struct xfs_btree_block *block, /* generic btree block pointer */
245 int level, /* level of the btree block */
246 struct xfs_buf *bp); /* buffer containing block, if any */
249 * Check that (long) pointer is ok.
251 int /* error (0 or EFSCORRUPTED) */
252 xfs_btree_check_lptr(
253 struct xfs_btree_cur *cur, /* btree cursor */
254 xfs_dfsbno_t ptr, /* btree block disk address */
255 int level); /* btree block level */
257 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
258 xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
262 * Check that (short) pointer is ok.
264 int /* error (0 or EFSCORRUPTED) */
265 xfs_btree_check_sptr(
266 struct xfs_btree_cur *cur, /* btree cursor */
267 xfs_agblock_t ptr, /* btree block disk address */
268 int level); /* btree block level */
271 * Check that (short) pointer is ok.
273 int /* error (0 or EFSCORRUPTED) */
275 struct xfs_btree_cur *cur, /* btree cursor */
276 union xfs_btree_ptr *ptr, /* btree block disk address */
277 int index, /* offset from ptr to check */
278 int level); /* btree block level */
283 * Debug routine: check that keys are in the right order.
287 xfs_btnum_t btnum, /* btree identifier */
288 void *ak1, /* pointer to left (lower) key */
289 void *ak2); /* pointer to right (higher) key */
292 * Debug routine: check that records are in the right order.
296 xfs_btnum_t btnum, /* btree identifier */
297 void *ar1, /* pointer to left (lower) record */
298 void *ar2); /* pointer to right (higher) record */
300 #define xfs_btree_check_key(a, b, c)
301 #define xfs_btree_check_rec(a, b, c)
305 * Delete the btree cursor.
308 xfs_btree_del_cursor(
309 xfs_btree_cur_t *cur, /* btree cursor */
310 int error); /* del because of error */
313 * Duplicate the btree cursor.
314 * Allocate a new one, copy the record, re-get the buffers.
317 xfs_btree_dup_cursor(
318 xfs_btree_cur_t *cur, /* input cursor */
319 xfs_btree_cur_t **ncur);/* output cursor */
322 * Change the cursor to point to the first record in the current block
323 * at the given level. Other levels are unaffected.
325 int /* success=1, failure=0 */
327 xfs_btree_cur_t *cur, /* btree cursor */
328 int level); /* level to change */
331 * Get a buffer for the block, return it with no data read.
332 * Long-form addressing.
334 struct xfs_buf * /* buffer for fsbno */
336 struct xfs_mount *mp, /* file system mount point */
337 struct xfs_trans *tp, /* transaction pointer */
338 xfs_fsblock_t fsbno, /* file system block number */
339 uint lock); /* lock flags for get_buf */
342 * Get a buffer for the block, return it with no data read.
343 * Short-form addressing.
345 struct xfs_buf * /* buffer for agno/agbno */
347 struct xfs_mount *mp, /* file system mount point */
348 struct xfs_trans *tp, /* transaction pointer */
349 xfs_agnumber_t agno, /* allocation group number */
350 xfs_agblock_t agbno, /* allocation group block number */
351 uint lock); /* lock flags for get_buf */
354 * Check for the cursor referring to the last block at the given level.
356 int /* 1=is last block, 0=not last block */
357 xfs_btree_islastblock(
358 xfs_btree_cur_t *cur, /* btree cursor */
359 int level); /* level to check */
362 * Change the cursor to point to the last record in the current block
363 * at the given level. Other levels are unaffected.
365 int /* success=1, failure=0 */
367 xfs_btree_cur_t *cur, /* btree cursor */
368 int level); /* level to change */
371 * Compute first and last byte offsets for the fields given.
372 * Interprets the offsets table, which contains struct field offsets.
376 __int64_t fields, /* bitmask of fields */
377 const short *offsets,/* table of field offsets */
378 int nbits, /* number of bits to inspect */
379 int *first, /* output: first byte offset */
380 int *last); /* output: last byte offset */
383 * Get a buffer for the block, return it read in.
384 * Long-form addressing.
388 struct xfs_mount *mp, /* file system mount point */
389 struct xfs_trans *tp, /* transaction pointer */
390 xfs_fsblock_t fsbno, /* file system block number */
391 uint lock, /* lock flags for read_buf */
392 struct xfs_buf **bpp, /* buffer for fsbno */
393 int refval);/* ref count value for buffer */
396 * Get a buffer for the block, return it read in.
397 * Short-form addressing.
401 struct xfs_mount *mp, /* file system mount point */
402 struct xfs_trans *tp, /* transaction pointer */
403 xfs_agnumber_t agno, /* allocation group number */
404 xfs_agblock_t agbno, /* allocation group block number */
405 uint lock, /* lock flags for read_buf */
406 struct xfs_buf **bpp, /* buffer for agno/agbno */
407 int refval);/* ref count value for buffer */
410 * Read-ahead the block, don't wait for it, don't return a buffer.
411 * Long-form addressing.
414 xfs_btree_reada_bufl(
415 struct xfs_mount *mp, /* file system mount point */
416 xfs_fsblock_t fsbno, /* file system block number */
417 xfs_extlen_t count); /* count of filesystem blocks */
420 * Read-ahead the block, don't wait for it, don't return a buffer.
421 * Short-form addressing.
424 xfs_btree_reada_bufs(
425 struct xfs_mount *mp, /* file system mount point */
426 xfs_agnumber_t agno, /* allocation group number */
427 xfs_agblock_t agbno, /* allocation group block number */
428 xfs_extlen_t count); /* count of filesystem blocks */
431 * Read-ahead btree blocks, at the given level.
432 * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
434 int /* readahead block count */
436 xfs_btree_cur_t *cur, /* btree cursor */
437 int lev, /* level in btree */
438 int lr); /* left/right bits */
441 * Set the buffer for level "lev" in the cursor to bp, releasing
442 * any previous buffer.
446 xfs_btree_cur_t *cur, /* btree cursor */
447 int lev, /* level in btree */
448 struct xfs_buf *bp); /* new buffer to set */
450 #endif /* __KERNEL__ */
454 * Min and max functions for extlen, agblock, fileoff, and filblks types.
456 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
457 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
458 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
459 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
460 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
461 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
462 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
463 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
465 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
466 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
467 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
469 #endif /* __XFS_BTREE_H__ */