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 * Generic stats interface
126 #define __XFS_BTREE_STATS_INC(type, stat) \
127 XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
128 #define XFS_BTREE_STATS_INC(cur, stat) \
130 switch (cur->bc_btnum) { \
131 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break; \
132 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break; \
133 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break; \
134 case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break; \
135 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
139 #define __XFS_BTREE_STATS_ADD(type, stat, val) \
140 XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
141 #define XFS_BTREE_STATS_ADD(cur, stat, val) \
143 switch (cur->bc_btnum) { \
144 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
145 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
146 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
147 case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
148 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
152 * Maximum and minimum records in a btree block.
153 * Given block size, type prefix, and leaf flag (0 or 1).
154 * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
157 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) \
158 ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
159 (((lf) * (uint)sizeof(t ## _rec_t)) + \
161 ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
162 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf) \
163 (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
166 * Record, key, and pointer address calculation macros.
167 * Given block size, type prefix, block pointer, and index of requested entry
168 * (first entry numbered 1).
170 #define XFS_BTREE_REC_ADDR(t,bb,i) \
171 ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
172 ((i) - 1) * sizeof(t ## _rec_t)))
173 #define XFS_BTREE_KEY_ADDR(t,bb,i) \
174 ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
175 ((i) - 1) * sizeof(t ## _key_t)))
176 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr) \
177 ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
178 (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
180 #define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */
182 struct xfs_btree_ops {
183 /* size of the key and record structures */
187 /* cursor operations */
188 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
189 void (*update_cursor)(struct xfs_btree_cur *src,
190 struct xfs_btree_cur *dst);
192 /* update btree root pointer */
193 void (*set_root)(struct xfs_btree_cur *cur,
194 union xfs_btree_ptr *nptr, int level_change);
196 /* block allocation / freeing */
197 int (*alloc_block)(struct xfs_btree_cur *cur,
198 union xfs_btree_ptr *start_bno,
199 union xfs_btree_ptr *new_bno,
200 int length, int *stat);
202 /* update last record information */
203 void (*update_lastrec)(struct xfs_btree_cur *cur,
204 struct xfs_btree_block *block,
205 union xfs_btree_rec *rec,
206 int ptr, int reason);
208 /* records in block/level */
209 int (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
211 /* records on disk. Matter for the root in inode case. */
212 int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
214 /* init values of btree structures */
215 void (*init_key_from_rec)(union xfs_btree_key *key,
216 union xfs_btree_rec *rec);
217 void (*init_rec_from_key)(union xfs_btree_key *key,
218 union xfs_btree_rec *rec);
219 void (*init_rec_from_cur)(struct xfs_btree_cur *cur,
220 union xfs_btree_rec *rec);
221 void (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
222 union xfs_btree_ptr *ptr);
224 /* difference between key value and cursor value */
225 __int64_t (*key_diff)(struct xfs_btree_cur *cur,
226 union xfs_btree_key *key);
229 #ifdef XFS_BTREE_TRACE
230 void (*trace_enter)(struct xfs_btree_cur *, const char *,
231 char *, int, int, __psunsigned_t,
232 __psunsigned_t, __psunsigned_t,
233 __psunsigned_t, __psunsigned_t,
234 __psunsigned_t, __psunsigned_t,
235 __psunsigned_t, __psunsigned_t,
236 __psunsigned_t, __psunsigned_t);
237 void (*trace_cursor)(struct xfs_btree_cur *, __uint32_t *,
238 __uint64_t *, __uint64_t *);
239 void (*trace_key)(struct xfs_btree_cur *,
240 union xfs_btree_key *, __uint64_t *,
242 void (*trace_record)(struct xfs_btree_cur *,
243 union xfs_btree_rec *, __uint64_t *,
244 __uint64_t *, __uint64_t *);
249 * Reasons for the update_lastrec method to be called.
251 #define LASTREC_UPDATE 0
252 #define LASTREC_INSREC 1
256 * Btree cursor structure.
257 * This collects all information needed by the btree code in one place.
259 typedef struct xfs_btree_cur
261 struct xfs_trans *bc_tp; /* transaction we're in, if any */
262 struct xfs_mount *bc_mp; /* file system mount struct */
263 const struct xfs_btree_ops *bc_ops;
264 uint bc_flags; /* btree features - below */
266 xfs_alloc_rec_incore_t a;
268 xfs_inobt_rec_incore_t i;
269 } bc_rec; /* current insert/search record value */
270 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */
271 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
272 __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
273 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
274 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
275 __uint8_t bc_nlevels; /* number of levels in the tree */
276 __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
277 xfs_btnum_t bc_btnum; /* identifies which btree type */
279 struct { /* needed for BNO, CNT, INO */
280 struct xfs_buf *agbp; /* agf/agi buffer pointer */
281 xfs_agnumber_t agno; /* ag number */
283 struct { /* needed for BMAP */
284 struct xfs_inode *ip; /* pointer to our inode */
285 struct xfs_bmap_free *flist; /* list to free after */
286 xfs_fsblock_t firstblock; /* 1st blk allocated */
287 int allocated; /* count of alloced */
288 short forksize; /* fork's inode space */
289 char whichfork; /* data or attr fork */
290 char flags; /* flags */
291 #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
293 } bc_private; /* per-btree type data */
297 #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */
298 #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */
299 #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */
302 #define XFS_BTREE_NOERROR 0
303 #define XFS_BTREE_ERROR 1
306 * Convert from buffer to btree block header.
308 #define XFS_BUF_TO_BLOCK(bp) ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
309 #define XFS_BUF_TO_LBLOCK(bp) ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
310 #define XFS_BUF_TO_SBLOCK(bp) ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
316 * Check that long form block header is ok.
318 int /* error (0 or EFSCORRUPTED) */
319 xfs_btree_check_lblock(
320 struct xfs_btree_cur *cur, /* btree cursor */
321 struct xfs_btree_lblock *block, /* btree long form block pointer */
322 int level, /* level of the btree block */
323 struct xfs_buf *bp); /* buffer containing block, if any */
326 * Check that short form block header is ok.
328 int /* error (0 or EFSCORRUPTED) */
329 xfs_btree_check_sblock(
330 struct xfs_btree_cur *cur, /* btree cursor */
331 struct xfs_btree_sblock *block, /* btree short form block pointer */
332 int level, /* level of the btree block */
333 struct xfs_buf *bp); /* buffer containing block */
336 * Check that block header is ok.
339 xfs_btree_check_block(
340 struct xfs_btree_cur *cur, /* btree cursor */
341 struct xfs_btree_block *block, /* generic btree block pointer */
342 int level, /* level of the btree block */
343 struct xfs_buf *bp); /* buffer containing block, if any */
346 * Check that (long) pointer is ok.
348 int /* error (0 or EFSCORRUPTED) */
349 xfs_btree_check_lptr(
350 struct xfs_btree_cur *cur, /* btree cursor */
351 xfs_dfsbno_t ptr, /* btree block disk address */
352 int level); /* btree block level */
354 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
355 xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
359 * Check that (short) pointer is ok.
361 int /* error (0 or EFSCORRUPTED) */
362 xfs_btree_check_sptr(
363 struct xfs_btree_cur *cur, /* btree cursor */
364 xfs_agblock_t ptr, /* btree block disk address */
365 int level); /* btree block level */
368 * Check that (short) pointer is ok.
370 int /* error (0 or EFSCORRUPTED) */
372 struct xfs_btree_cur *cur, /* btree cursor */
373 union xfs_btree_ptr *ptr, /* btree block disk address */
374 int index, /* offset from ptr to check */
375 int level); /* btree block level */
380 * Debug routine: check that keys are in the right order.
384 xfs_btnum_t btnum, /* btree identifier */
385 void *ak1, /* pointer to left (lower) key */
386 void *ak2); /* pointer to right (higher) key */
389 * Debug routine: check that records are in the right order.
393 xfs_btnum_t btnum, /* btree identifier */
394 void *ar1, /* pointer to left (lower) record */
395 void *ar2); /* pointer to right (higher) record */
397 #define xfs_btree_check_key(a, b, c)
398 #define xfs_btree_check_rec(a, b, c)
402 * Delete the btree cursor.
405 xfs_btree_del_cursor(
406 xfs_btree_cur_t *cur, /* btree cursor */
407 int error); /* del because of error */
410 * Duplicate the btree cursor.
411 * Allocate a new one, copy the record, re-get the buffers.
414 xfs_btree_dup_cursor(
415 xfs_btree_cur_t *cur, /* input cursor */
416 xfs_btree_cur_t **ncur);/* output cursor */
419 * Change the cursor to point to the first record in the current block
420 * at the given level. Other levels are unaffected.
422 int /* success=1, failure=0 */
424 xfs_btree_cur_t *cur, /* btree cursor */
425 int level); /* level to change */
428 * Get a buffer for the block, return it with no data read.
429 * Long-form addressing.
431 struct xfs_buf * /* buffer for fsbno */
433 struct xfs_mount *mp, /* file system mount point */
434 struct xfs_trans *tp, /* transaction pointer */
435 xfs_fsblock_t fsbno, /* file system block number */
436 uint lock); /* lock flags for get_buf */
439 * Get a buffer for the block, return it with no data read.
440 * Short-form addressing.
442 struct xfs_buf * /* buffer for agno/agbno */
444 struct xfs_mount *mp, /* file system mount point */
445 struct xfs_trans *tp, /* transaction pointer */
446 xfs_agnumber_t agno, /* allocation group number */
447 xfs_agblock_t agbno, /* allocation group block number */
448 uint lock); /* lock flags for get_buf */
451 * Check for the cursor referring to the last block at the given level.
453 int /* 1=is last block, 0=not last block */
454 xfs_btree_islastblock(
455 xfs_btree_cur_t *cur, /* btree cursor */
456 int level); /* level to check */
459 * Change the cursor to point to the last record in the current block
460 * at the given level. Other levels are unaffected.
462 int /* success=1, failure=0 */
464 xfs_btree_cur_t *cur, /* btree cursor */
465 int level); /* level to change */
468 * Compute first and last byte offsets for the fields given.
469 * Interprets the offsets table, which contains struct field offsets.
473 __int64_t fields, /* bitmask of fields */
474 const short *offsets,/* table of field offsets */
475 int nbits, /* number of bits to inspect */
476 int *first, /* output: first byte offset */
477 int *last); /* output: last byte offset */
480 * Get a buffer for the block, return it read in.
481 * Long-form addressing.
485 struct xfs_mount *mp, /* file system mount point */
486 struct xfs_trans *tp, /* transaction pointer */
487 xfs_fsblock_t fsbno, /* file system block number */
488 uint lock, /* lock flags for read_buf */
489 struct xfs_buf **bpp, /* buffer for fsbno */
490 int refval);/* ref count value for buffer */
493 * Get a buffer for the block, return it read in.
494 * Short-form addressing.
498 struct xfs_mount *mp, /* file system mount point */
499 struct xfs_trans *tp, /* transaction pointer */
500 xfs_agnumber_t agno, /* allocation group number */
501 xfs_agblock_t agbno, /* allocation group block number */
502 uint lock, /* lock flags for read_buf */
503 struct xfs_buf **bpp, /* buffer for agno/agbno */
504 int refval);/* ref count value for buffer */
507 * Read-ahead the block, don't wait for it, don't return a buffer.
508 * Long-form addressing.
511 xfs_btree_reada_bufl(
512 struct xfs_mount *mp, /* file system mount point */
513 xfs_fsblock_t fsbno, /* file system block number */
514 xfs_extlen_t count); /* count of filesystem blocks */
517 * Read-ahead the block, don't wait for it, don't return a buffer.
518 * Short-form addressing.
521 xfs_btree_reada_bufs(
522 struct xfs_mount *mp, /* file system mount point */
523 xfs_agnumber_t agno, /* allocation group number */
524 xfs_agblock_t agbno, /* allocation group block number */
525 xfs_extlen_t count); /* count of filesystem blocks */
528 * Read-ahead btree blocks, at the given level.
529 * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
531 int /* readahead block count */
533 xfs_btree_cur_t *cur, /* btree cursor */
534 int lev, /* level in btree */
535 int lr); /* left/right bits */
538 * Set the buffer for level "lev" in the cursor to bp, releasing
539 * any previous buffer.
543 xfs_btree_cur_t *cur, /* btree cursor */
544 int lev, /* level in btree */
545 struct xfs_buf *bp); /* new buffer to set */
549 * Common btree core entry points.
551 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
552 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
553 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
554 int xfs_btree_updkey(struct xfs_btree_cur *, union xfs_btree_key *, int);
555 int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
556 int xfs_btree_lshift(struct xfs_btree_cur *, int, int *);
557 int xfs_btree_rshift(struct xfs_btree_cur *, int, int *);
558 int xfs_btree_split(struct xfs_btree_cur *, int, union xfs_btree_ptr *,
559 union xfs_btree_key *, struct xfs_btree_cur **, int *);
560 int xfs_btree_new_root(struct xfs_btree_cur *, int *);
561 int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
562 int xfs_btree_insert(struct xfs_btree_cur *, int *);
567 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
569 return be16_to_cpu(block->bb_numrecs);
572 static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
575 block->bb_numrecs = cpu_to_be16(numrecs);
578 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
580 return be16_to_cpu(block->bb_level);
583 #endif /* __KERNEL__ */
587 * Min and max functions for extlen, agblock, fileoff, and filblks types.
589 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
590 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
591 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
592 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
593 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
594 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
595 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
596 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
598 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
599 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
600 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
602 #endif /* __XFS_BTREE_H__ */