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 * For logging record fields.
85 #define XFS_BB_MAGIC 0x01
86 #define XFS_BB_LEVEL 0x02
87 #define XFS_BB_NUMRECS 0x04
88 #define XFS_BB_LEFTSIB 0x08
89 #define XFS_BB_RIGHTSIB 0x10
90 #define XFS_BB_NUM_BITS 5
91 #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
94 * Boolean to select which form of xfs_btree_block_t.bb_u to use.
96 #define XFS_BTREE_LONG_PTRS(btnum) ((btnum) == XFS_BTNUM_BMAP)
99 * Magic numbers for btree blocks.
101 extern const __uint32_t xfs_magics[];
104 * Maximum and minimum records in a btree block.
105 * Given block size, type prefix, and leaf flag (0 or 1).
106 * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
109 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) \
110 ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
111 (((lf) * (uint)sizeof(t ## _rec_t)) + \
113 ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
114 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf) \
115 (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
118 * Record, key, and pointer address calculation macros.
119 * Given block size, type prefix, block pointer, and index of requested entry
120 * (first entry numbered 1).
122 #define XFS_BTREE_REC_ADDR(t,bb,i) \
123 ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
124 ((i) - 1) * sizeof(t ## _rec_t)))
125 #define XFS_BTREE_KEY_ADDR(t,bb,i) \
126 ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
127 ((i) - 1) * sizeof(t ## _key_t)))
128 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr) \
129 ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
130 (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
132 #define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */
134 struct xfs_btree_ops {
135 /* cursor operations */
136 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
140 * Btree cursor structure.
141 * This collects all information needed by the btree code in one place.
143 typedef struct xfs_btree_cur
145 struct xfs_trans *bc_tp; /* transaction we're in, if any */
146 struct xfs_mount *bc_mp; /* file system mount struct */
147 const struct xfs_btree_ops *bc_ops;
149 xfs_alloc_rec_incore_t a;
151 xfs_inobt_rec_incore_t i;
152 } bc_rec; /* current insert/search record value */
153 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */
154 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
155 __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
156 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
157 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
158 __uint8_t bc_nlevels; /* number of levels in the tree */
159 __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
160 xfs_btnum_t bc_btnum; /* identifies which btree type */
162 struct { /* needed for BNO, CNT, INO */
163 struct xfs_buf *agbp; /* agf/agi buffer pointer */
164 xfs_agnumber_t agno; /* ag number */
166 struct { /* needed for BMAP */
167 struct xfs_inode *ip; /* pointer to our inode */
168 struct xfs_bmap_free *flist; /* list to free after */
169 xfs_fsblock_t firstblock; /* 1st blk allocated */
170 int allocated; /* count of alloced */
171 short forksize; /* fork's inode space */
172 char whichfork; /* data or attr fork */
173 char flags; /* flags */
174 #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
176 } bc_private; /* per-btree type data */
179 #define XFS_BTREE_NOERROR 0
180 #define XFS_BTREE_ERROR 1
183 * Convert from buffer to btree block header.
185 #define XFS_BUF_TO_BLOCK(bp) ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
186 #define XFS_BUF_TO_LBLOCK(bp) ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
187 #define XFS_BUF_TO_SBLOCK(bp) ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
194 * Debug routine: check that block header is ok.
197 xfs_btree_check_block(
198 xfs_btree_cur_t *cur, /* btree cursor */
199 xfs_btree_block_t *block, /* generic btree block pointer */
200 int level, /* level of the btree block */
201 struct xfs_buf *bp); /* buffer containing block, if any */
204 * Debug routine: check that keys are in the right order.
208 xfs_btnum_t btnum, /* btree identifier */
209 void *ak1, /* pointer to left (lower) key */
210 void *ak2); /* pointer to right (higher) key */
213 * Debug routine: check that records are in the right order.
217 xfs_btnum_t btnum, /* btree identifier */
218 void *ar1, /* pointer to left (lower) record */
219 void *ar2); /* pointer to right (higher) record */
221 #define xfs_btree_check_block(a,b,c,d)
222 #define xfs_btree_check_key(a,b,c)
223 #define xfs_btree_check_rec(a,b,c)
227 * Checking routine: check that long form block header is ok.
229 int /* error (0 or EFSCORRUPTED) */
230 xfs_btree_check_lblock(
231 xfs_btree_cur_t *cur, /* btree cursor */
232 xfs_btree_lblock_t *block, /* btree long form block pointer */
233 int level, /* level of the btree block */
234 struct xfs_buf *bp); /* buffer containing block, if any */
237 * Checking routine: check that (long) pointer is ok.
239 int /* error (0 or EFSCORRUPTED) */
240 xfs_btree_check_lptr(
241 xfs_btree_cur_t *cur, /* btree cursor */
242 xfs_dfsbno_t ptr, /* btree block disk address */
243 int level); /* btree block level */
245 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
246 xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
249 * Checking routine: check that short form block header is ok.
251 int /* error (0 or EFSCORRUPTED) */
252 xfs_btree_check_sblock(
253 xfs_btree_cur_t *cur, /* btree cursor */
254 xfs_btree_sblock_t *block, /* btree short form block pointer */
255 int level, /* level of the btree block */
256 struct xfs_buf *bp); /* buffer containing block */
259 * Checking routine: check that (short) pointer is ok.
261 int /* error (0 or EFSCORRUPTED) */
262 xfs_btree_check_sptr(
263 xfs_btree_cur_t *cur, /* btree cursor */
264 xfs_agblock_t ptr, /* btree block disk address */
265 int level); /* btree block level */
268 * Delete the btree cursor.
271 xfs_btree_del_cursor(
272 xfs_btree_cur_t *cur, /* btree cursor */
273 int error); /* del because of error */
276 * Duplicate the btree cursor.
277 * Allocate a new one, copy the record, re-get the buffers.
280 xfs_btree_dup_cursor(
281 xfs_btree_cur_t *cur, /* input cursor */
282 xfs_btree_cur_t **ncur);/* output cursor */
285 * Change the cursor to point to the first record in the current block
286 * at the given level. Other levels are unaffected.
288 int /* success=1, failure=0 */
290 xfs_btree_cur_t *cur, /* btree cursor */
291 int level); /* level to change */
294 * Get a buffer for the block, return it with no data read.
295 * Long-form addressing.
297 struct xfs_buf * /* buffer for fsbno */
299 struct xfs_mount *mp, /* file system mount point */
300 struct xfs_trans *tp, /* transaction pointer */
301 xfs_fsblock_t fsbno, /* file system block number */
302 uint lock); /* lock flags for get_buf */
305 * Get a buffer for the block, return it with no data read.
306 * Short-form addressing.
308 struct xfs_buf * /* buffer for agno/agbno */
310 struct xfs_mount *mp, /* file system mount point */
311 struct xfs_trans *tp, /* transaction pointer */
312 xfs_agnumber_t agno, /* allocation group number */
313 xfs_agblock_t agbno, /* allocation group block number */
314 uint lock); /* lock flags for get_buf */
317 * Check for the cursor referring to the last block at the given level.
319 int /* 1=is last block, 0=not last block */
320 xfs_btree_islastblock(
321 xfs_btree_cur_t *cur, /* btree cursor */
322 int level); /* level to check */
325 * Change the cursor to point to the last record in the current block
326 * at the given level. Other levels are unaffected.
328 int /* success=1, failure=0 */
330 xfs_btree_cur_t *cur, /* btree cursor */
331 int level); /* level to change */
334 * Compute first and last byte offsets for the fields given.
335 * Interprets the offsets table, which contains struct field offsets.
339 __int64_t fields, /* bitmask of fields */
340 const short *offsets,/* table of field offsets */
341 int nbits, /* number of bits to inspect */
342 int *first, /* output: first byte offset */
343 int *last); /* output: last byte offset */
346 * Get a buffer for the block, return it read in.
347 * Long-form addressing.
351 struct xfs_mount *mp, /* file system mount point */
352 struct xfs_trans *tp, /* transaction pointer */
353 xfs_fsblock_t fsbno, /* file system block number */
354 uint lock, /* lock flags for read_buf */
355 struct xfs_buf **bpp, /* buffer for fsbno */
356 int refval);/* ref count value for buffer */
359 * Get a buffer for the block, return it read in.
360 * Short-form addressing.
364 struct xfs_mount *mp, /* file system mount point */
365 struct xfs_trans *tp, /* transaction pointer */
366 xfs_agnumber_t agno, /* allocation group number */
367 xfs_agblock_t agbno, /* allocation group block number */
368 uint lock, /* lock flags for read_buf */
369 struct xfs_buf **bpp, /* buffer for agno/agbno */
370 int refval);/* ref count value for buffer */
373 * Read-ahead the block, don't wait for it, don't return a buffer.
374 * Long-form addressing.
377 xfs_btree_reada_bufl(
378 struct xfs_mount *mp, /* file system mount point */
379 xfs_fsblock_t fsbno, /* file system block number */
380 xfs_extlen_t count); /* count of filesystem blocks */
383 * Read-ahead the block, don't wait for it, don't return a buffer.
384 * Short-form addressing.
387 xfs_btree_reada_bufs(
388 struct xfs_mount *mp, /* file system mount point */
389 xfs_agnumber_t agno, /* allocation group number */
390 xfs_agblock_t agbno, /* allocation group block number */
391 xfs_extlen_t count); /* count of filesystem blocks */
394 * Read-ahead btree blocks, at the given level.
395 * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
397 int /* readahead block count */
398 xfs_btree_readahead_core(
399 xfs_btree_cur_t *cur, /* btree cursor */
400 int lev, /* level in btree */
401 int lr); /* left/right bits */
403 static inline int /* readahead block count */
405 xfs_btree_cur_t *cur, /* btree cursor */
406 int lev, /* level in btree */
407 int lr) /* left/right bits */
409 if ((cur->bc_ra[lev] | lr) == cur->bc_ra[lev])
412 return xfs_btree_readahead_core(cur, lev, lr);
417 * Set the buffer for level "lev" in the cursor to bp, releasing
418 * any previous buffer.
422 xfs_btree_cur_t *cur, /* btree cursor */
423 int lev, /* level in btree */
424 struct xfs_buf *bp); /* new buffer to set */
426 #endif /* __KERNEL__ */
430 * Min and max functions for extlen, agblock, fileoff, and filblks types.
432 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
433 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
434 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
435 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
436 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
437 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
438 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
439 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
441 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
442 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
443 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
445 #endif /* __XFS_BTREE_H__ */