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 * Generic btree header.
44 * This is a combination of the actual format used on disk for short and long
45 * format btrees. The first three fields are shared by both format, but the
46 * pointers are different and should be used with care.
48 * To get the size of the actual short or long form headers please use the size
49 * macros below. Never use sizeof(xfs_btree_block).
51 * The blkno, crc, lsn, owner and uuid fields are only available in filesystems
52 * with the crc feature bit, and all accesses to them must be conditional on
55 struct xfs_btree_block {
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 */
69 } s; /* short form pointers */
79 __be32 bb_pad; /* padding for alignment */
80 } l; /* long form pointers */
84 #define XFS_BTREE_SBLOCK_LEN 16 /* size of a short form block */
85 #define XFS_BTREE_LBLOCK_LEN 24 /* size of a long form block */
87 /* sizes of CRC enabled btree blocks */
88 #define XFS_BTREE_SBLOCK_CRC_LEN (XFS_BTREE_SBLOCK_LEN + 40)
89 #define XFS_BTREE_LBLOCK_CRC_LEN (XFS_BTREE_LBLOCK_LEN + 48)
91 #define XFS_BTREE_SBLOCK_CRC_OFF \
92 offsetof(struct xfs_btree_block, bb_u.s.bb_crc)
93 #define XFS_BTREE_LBLOCK_CRC_OFF \
94 offsetof(struct xfs_btree_block, bb_u.l.bb_crc)
97 * Generic key, ptr and record wrapper structures.
99 * These are disk format structures, and are converted where necessary
100 * by the btree specific code that needs to interpret them.
102 union xfs_btree_ptr {
103 __be32 s; /* short form ptr */
104 __be64 l; /* long form ptr */
107 union xfs_btree_key {
109 xfs_bmdr_key_t bmbr; /* bmbt root block */
110 xfs_alloc_key_t alloc;
111 xfs_inobt_key_t inobt;
114 union xfs_btree_rec {
116 xfs_bmdr_rec_t bmbr; /* bmbt root block */
117 xfs_alloc_rec_t alloc;
118 xfs_inobt_rec_t inobt;
122 * For logging record fields.
124 #define XFS_BB_MAGIC 0x01
125 #define XFS_BB_LEVEL 0x02
126 #define XFS_BB_NUMRECS 0x04
127 #define XFS_BB_LEFTSIB 0x08
128 #define XFS_BB_RIGHTSIB 0x10
129 #define XFS_BB_BLKNO 0x20
130 #define XFS_BB_NUM_BITS 5
131 #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
132 #define XFS_BB_NUM_BITS_CRC 8
133 #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1)
136 * Generic stats interface
138 #define __XFS_BTREE_STATS_INC(type, stat) \
139 XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
140 #define XFS_BTREE_STATS_INC(cur, stat) \
142 switch (cur->bc_btnum) { \
143 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break; \
144 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break; \
145 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break; \
146 case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break; \
147 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
151 #define __XFS_BTREE_STATS_ADD(type, stat, val) \
152 XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
153 #define XFS_BTREE_STATS_ADD(cur, stat, val) \
155 switch (cur->bc_btnum) { \
156 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
157 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
158 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
159 case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
160 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
164 #define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */
166 struct xfs_btree_ops {
167 /* size of the key and record structures */
171 /* cursor operations */
172 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
173 void (*update_cursor)(struct xfs_btree_cur *src,
174 struct xfs_btree_cur *dst);
176 /* update btree root pointer */
177 void (*set_root)(struct xfs_btree_cur *cur,
178 union xfs_btree_ptr *nptr, int level_change);
180 /* block allocation / freeing */
181 int (*alloc_block)(struct xfs_btree_cur *cur,
182 union xfs_btree_ptr *start_bno,
183 union xfs_btree_ptr *new_bno,
184 int length, int *stat);
185 int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
187 /* update last record information */
188 void (*update_lastrec)(struct xfs_btree_cur *cur,
189 struct xfs_btree_block *block,
190 union xfs_btree_rec *rec,
191 int ptr, int reason);
193 /* records in block/level */
194 int (*get_minrecs)(struct xfs_btree_cur *cur, int level);
195 int (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
197 /* records on disk. Matter for the root in inode case. */
198 int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
200 /* init values of btree structures */
201 void (*init_key_from_rec)(union xfs_btree_key *key,
202 union xfs_btree_rec *rec);
203 void (*init_rec_from_key)(union xfs_btree_key *key,
204 union xfs_btree_rec *rec);
205 void (*init_rec_from_cur)(struct xfs_btree_cur *cur,
206 union xfs_btree_rec *rec);
207 void (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
208 union xfs_btree_ptr *ptr);
210 /* difference between key value and cursor value */
211 __int64_t (*key_diff)(struct xfs_btree_cur *cur,
212 union xfs_btree_key *key);
214 const struct xfs_buf_ops *buf_ops;
216 #if defined(DEBUG) || defined(XFS_WARN)
217 /* check that k1 is lower than k2 */
218 int (*keys_inorder)(struct xfs_btree_cur *cur,
219 union xfs_btree_key *k1,
220 union xfs_btree_key *k2);
222 /* check that r1 is lower than r2 */
223 int (*recs_inorder)(struct xfs_btree_cur *cur,
224 union xfs_btree_rec *r1,
225 union xfs_btree_rec *r2);
230 * Reasons for the update_lastrec method to be called.
232 #define LASTREC_UPDATE 0
233 #define LASTREC_INSREC 1
234 #define LASTREC_DELREC 2
238 * Btree cursor structure.
239 * This collects all information needed by the btree code in one place.
241 typedef struct xfs_btree_cur
243 struct xfs_trans *bc_tp; /* transaction we're in, if any */
244 struct xfs_mount *bc_mp; /* file system mount struct */
245 const struct xfs_btree_ops *bc_ops;
246 uint bc_flags; /* btree features - below */
248 xfs_alloc_rec_incore_t a;
250 xfs_inobt_rec_incore_t i;
251 } bc_rec; /* current insert/search record value */
252 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */
253 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
254 __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
255 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
256 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
257 __uint8_t bc_nlevels; /* number of levels in the tree */
258 __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
259 xfs_btnum_t bc_btnum; /* identifies which btree type */
261 struct { /* needed for BNO, CNT, INO */
262 struct xfs_buf *agbp; /* agf/agi buffer pointer */
263 xfs_agnumber_t agno; /* ag number */
265 struct { /* needed for BMAP */
266 struct xfs_inode *ip; /* pointer to our inode */
267 struct xfs_bmap_free *flist; /* list to free after */
268 xfs_fsblock_t firstblock; /* 1st blk allocated */
269 int allocated; /* count of alloced */
270 short forksize; /* fork's inode space */
271 char whichfork; /* data or attr fork */
272 char flags; /* flags */
273 #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
275 } bc_private; /* per-btree type data */
279 #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */
280 #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */
281 #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */
282 #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */
285 #define XFS_BTREE_NOERROR 0
286 #define XFS_BTREE_ERROR 1
289 * Convert from buffer to btree block header.
291 #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr))
295 * Check that block header is ok.
298 xfs_btree_check_block(
299 struct xfs_btree_cur *cur, /* btree cursor */
300 struct xfs_btree_block *block, /* generic btree block pointer */
301 int level, /* level of the btree block */
302 struct xfs_buf *bp); /* buffer containing block, if any */
305 * Check that (long) pointer is ok.
307 int /* error (0 or EFSCORRUPTED) */
308 xfs_btree_check_lptr(
309 struct xfs_btree_cur *cur, /* btree cursor */
310 xfs_dfsbno_t ptr, /* btree block disk address */
311 int level); /* btree block level */
314 * Delete the btree cursor.
317 xfs_btree_del_cursor(
318 xfs_btree_cur_t *cur, /* btree cursor */
319 int error); /* del because of error */
322 * Duplicate the btree cursor.
323 * Allocate a new one, copy the record, re-get the buffers.
326 xfs_btree_dup_cursor(
327 xfs_btree_cur_t *cur, /* input cursor */
328 xfs_btree_cur_t **ncur);/* output cursor */
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 * Compute first and last byte offsets for the fields given.
363 * Interprets the offsets table, which contains struct field offsets.
367 __int64_t fields, /* bitmask of fields */
368 const short *offsets,/* table of field offsets */
369 int nbits, /* number of bits to inspect */
370 int *first, /* output: first byte offset */
371 int *last); /* output: last byte offset */
374 * Get a buffer for the block, return it read in.
375 * Long-form addressing.
379 struct xfs_mount *mp, /* file system mount point */
380 struct xfs_trans *tp, /* transaction pointer */
381 xfs_fsblock_t fsbno, /* file system block number */
382 uint lock, /* lock flags for read_buf */
383 struct xfs_buf **bpp, /* buffer for fsbno */
384 int refval, /* ref count value for buffer */
385 const struct xfs_buf_ops *ops);
388 * Read-ahead the block, don't wait for it, don't return a buffer.
389 * Long-form addressing.
392 xfs_btree_reada_bufl(
393 struct xfs_mount *mp, /* file system mount point */
394 xfs_fsblock_t fsbno, /* file system block number */
395 xfs_extlen_t count, /* count of filesystem blocks */
396 const struct xfs_buf_ops *ops);
399 * Read-ahead the block, don't wait for it, don't return a buffer.
400 * Short-form addressing.
403 xfs_btree_reada_bufs(
404 struct xfs_mount *mp, /* file system mount point */
405 xfs_agnumber_t agno, /* allocation group number */
406 xfs_agblock_t agbno, /* allocation group block number */
407 xfs_extlen_t count, /* count of filesystem blocks */
408 const struct xfs_buf_ops *ops);
411 * Initialise a new btree block header
414 xfs_btree_init_block(
415 struct xfs_mount *mp,
424 xfs_btree_init_block_int(
425 struct xfs_mount *mp,
426 struct xfs_btree_block *buf,
435 * Common btree core entry points.
437 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
438 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
439 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
440 int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
441 int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
442 int xfs_btree_insert(struct xfs_btree_cur *, int *);
443 int xfs_btree_delete(struct xfs_btree_cur *, int *);
444 int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
447 * btree block CRC helpers
449 void xfs_btree_lblock_calc_crc(struct xfs_buf *);
450 bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
451 void xfs_btree_sblock_calc_crc(struct xfs_buf *);
452 bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
455 * Internal btree helpers also used by xfs_bmap.c.
457 void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
458 void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
463 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
465 return be16_to_cpu(block->bb_numrecs);
468 static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
471 block->bb_numrecs = cpu_to_be16(numrecs);
474 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
476 return be16_to_cpu(block->bb_level);
481 * Min and max functions for extlen, agblock, fileoff, and filblks types.
483 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
484 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
485 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
486 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
487 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
488 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
489 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
490 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
492 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
493 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
494 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
497 * Trace hooks. Currently not implemented as they need to be ported
498 * over to the generic tracing functionality, which is some effort.
500 * i,j = integer (32 bit)
501 * b = btree block buffer (xfs_buf_t)
506 #define XFS_BTREE_TRACE_ARGBI(c, b, i)
507 #define XFS_BTREE_TRACE_ARGBII(c, b, i, j)
508 #define XFS_BTREE_TRACE_ARGI(c, i)
509 #define XFS_BTREE_TRACE_ARGIPK(c, i, p, s)
510 #define XFS_BTREE_TRACE_ARGIPR(c, i, p, r)
511 #define XFS_BTREE_TRACE_ARGIK(c, i, k)
512 #define XFS_BTREE_TRACE_ARGR(c, r)
513 #define XFS_BTREE_TRACE_CURSOR(c, t)
515 #endif /* __XFS_BTREE_H__ */