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 * Generic key, ptr and record wrapper structures.
32 * These are disk format structures, and are converted where necessary
33 * by the btree specific code that needs to interpret them.
36 __be32 s
; /* short form ptr */
37 __be64 l
; /* long form ptr */
41 * The in-core btree key. Overlapping btrees actually store two keys
42 * per pointer, so we reserve enough memory to hold both. The __*bigkey
43 * items should never be accessed directly.
46 struct xfs_bmbt_key bmbt
;
47 xfs_bmdr_key_t bmbr
; /* bmbt root block */
48 xfs_alloc_key_t alloc
;
49 struct xfs_inobt_key inobt
;
50 struct xfs_rmap_key rmap
;
51 struct xfs_rmap_key __rmap_bigkey
[2];
52 struct xfs_refcount_key refc
;
56 struct xfs_bmbt_rec bmbt
;
57 xfs_bmdr_rec_t bmbr
; /* bmbt root block */
58 struct xfs_alloc_rec alloc
;
59 struct xfs_inobt_rec inobt
;
60 struct xfs_rmap_rec rmap
;
61 struct xfs_refcount_rec refc
;
65 * This nonsense is to make -wlint happy.
67 #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi)
68 #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi)
69 #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi)
71 #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi)
72 #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi)
73 #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi)
74 #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi)
75 #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi)
76 #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi)
77 #define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi)
80 * For logging record fields.
82 #define XFS_BB_MAGIC (1 << 0)
83 #define XFS_BB_LEVEL (1 << 1)
84 #define XFS_BB_NUMRECS (1 << 2)
85 #define XFS_BB_LEFTSIB (1 << 3)
86 #define XFS_BB_RIGHTSIB (1 << 4)
87 #define XFS_BB_BLKNO (1 << 5)
88 #define XFS_BB_LSN (1 << 6)
89 #define XFS_BB_UUID (1 << 7)
90 #define XFS_BB_OWNER (1 << 8)
91 #define XFS_BB_NUM_BITS 5
92 #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
93 #define XFS_BB_NUM_BITS_CRC 9
94 #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1)
97 * Generic stats interface
99 #define __XFS_BTREE_STATS_INC(mp, type, stat) \
100 XFS_STATS_INC(mp, xs_ ## type ## _2_ ## stat)
101 #define XFS_BTREE_STATS_INC(cur, stat) \
103 struct xfs_mount *__mp = cur->bc_mp; \
104 switch (cur->bc_btnum) { \
105 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(__mp, abtb, stat); break; \
106 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(__mp, abtc, stat); break; \
107 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(__mp, bmbt, stat); break; \
108 case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(__mp, ibt, stat); break; \
109 case XFS_BTNUM_FINO: __XFS_BTREE_STATS_INC(__mp, fibt, stat); break; \
110 case XFS_BTNUM_RMAP: __XFS_BTREE_STATS_INC(__mp, rmap, stat); break; \
111 case XFS_BTNUM_REFC: __XFS_BTREE_STATS_INC(__mp, refcbt, stat); break; \
112 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
116 #define __XFS_BTREE_STATS_ADD(mp, type, stat, val) \
117 XFS_STATS_ADD(mp, xs_ ## type ## _2_ ## stat, val)
118 #define XFS_BTREE_STATS_ADD(cur, stat, val) \
120 struct xfs_mount *__mp = cur->bc_mp; \
121 switch (cur->bc_btnum) { \
122 case XFS_BTNUM_BNO: \
123 __XFS_BTREE_STATS_ADD(__mp, abtb, stat, val); break; \
124 case XFS_BTNUM_CNT: \
125 __XFS_BTREE_STATS_ADD(__mp, abtc, stat, val); break; \
126 case XFS_BTNUM_BMAP: \
127 __XFS_BTREE_STATS_ADD(__mp, bmbt, stat, val); break; \
128 case XFS_BTNUM_INO: \
129 __XFS_BTREE_STATS_ADD(__mp, ibt, stat, val); break; \
130 case XFS_BTNUM_FINO: \
131 __XFS_BTREE_STATS_ADD(__mp, fibt, stat, val); break; \
132 case XFS_BTNUM_RMAP: \
133 __XFS_BTREE_STATS_ADD(__mp, rmap, stat, val); break; \
134 case XFS_BTNUM_REFC: \
135 __XFS_BTREE_STATS_ADD(__mp, refcbt, stat, val); break; \
136 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
140 #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */
142 struct xfs_btree_ops
{
143 /* size of the key and record structures */
147 /* cursor operations */
148 struct xfs_btree_cur
*(*dup_cursor
)(struct xfs_btree_cur
*);
149 void (*update_cursor
)(struct xfs_btree_cur
*src
,
150 struct xfs_btree_cur
*dst
);
152 /* update btree root pointer */
153 void (*set_root
)(struct xfs_btree_cur
*cur
,
154 union xfs_btree_ptr
*nptr
, int level_change
);
156 /* block allocation / freeing */
157 int (*alloc_block
)(struct xfs_btree_cur
*cur
,
158 union xfs_btree_ptr
*start_bno
,
159 union xfs_btree_ptr
*new_bno
,
161 int (*free_block
)(struct xfs_btree_cur
*cur
, struct xfs_buf
*bp
);
163 /* update last record information */
164 void (*update_lastrec
)(struct xfs_btree_cur
*cur
,
165 struct xfs_btree_block
*block
,
166 union xfs_btree_rec
*rec
,
167 int ptr
, int reason
);
169 /* records in block/level */
170 int (*get_minrecs
)(struct xfs_btree_cur
*cur
, int level
);
171 int (*get_maxrecs
)(struct xfs_btree_cur
*cur
, int level
);
173 /* records on disk. Matter for the root in inode case. */
174 int (*get_dmaxrecs
)(struct xfs_btree_cur
*cur
, int level
);
176 /* init values of btree structures */
177 void (*init_key_from_rec
)(union xfs_btree_key
*key
,
178 union xfs_btree_rec
*rec
);
179 void (*init_rec_from_cur
)(struct xfs_btree_cur
*cur
,
180 union xfs_btree_rec
*rec
);
181 void (*init_ptr_from_cur
)(struct xfs_btree_cur
*cur
,
182 union xfs_btree_ptr
*ptr
);
183 void (*init_high_key_from_rec
)(union xfs_btree_key
*key
,
184 union xfs_btree_rec
*rec
);
186 /* difference between key value and cursor value */
187 __int64_t (*key_diff
)(struct xfs_btree_cur
*cur
,
188 union xfs_btree_key
*key
);
191 * Difference between key2 and key1 -- positive if key1 > key2,
192 * negative if key1 < key2, and zero if equal.
194 __int64_t (*diff_two_keys
)(struct xfs_btree_cur
*cur
,
195 union xfs_btree_key
*key1
,
196 union xfs_btree_key
*key2
);
198 const struct xfs_buf_ops
*buf_ops
;
200 #if defined(DEBUG) || defined(XFS_WARN)
201 /* check that k1 is lower than k2 */
202 int (*keys_inorder
)(struct xfs_btree_cur
*cur
,
203 union xfs_btree_key
*k1
,
204 union xfs_btree_key
*k2
);
206 /* check that r1 is lower than r2 */
207 int (*recs_inorder
)(struct xfs_btree_cur
*cur
,
208 union xfs_btree_rec
*r1
,
209 union xfs_btree_rec
*r2
);
214 * Reasons for the update_lastrec method to be called.
216 #define LASTREC_UPDATE 0
217 #define LASTREC_INSREC 1
218 #define LASTREC_DELREC 2
221 union xfs_btree_irec
{
222 struct xfs_alloc_rec_incore a
;
223 struct xfs_bmbt_irec b
;
224 struct xfs_inobt_rec_incore i
;
225 struct xfs_rmap_irec r
;
226 struct xfs_refcount_irec rc
;
229 /* Per-AG btree private information. */
230 union xfs_btree_cur_private
{
232 unsigned long nr_ops
; /* # record updates */
233 int shape_changes
; /* # of extent splits */
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 */
247 union xfs_btree_irec bc_rec
; /* current insert/search record value */
248 struct xfs_buf
*bc_bufs
[XFS_BTREE_MAXLEVELS
]; /* buf ptr per level */
249 int bc_ptrs
[XFS_BTREE_MAXLEVELS
]; /* key/record # */
250 __uint8_t bc_ra
[XFS_BTREE_MAXLEVELS
]; /* readahead bits */
251 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
252 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
253 __uint8_t bc_nlevels
; /* number of levels in the tree */
254 __uint8_t bc_blocklog
; /* log2(blocksize) of btree blocks */
255 xfs_btnum_t bc_btnum
; /* identifies which btree type */
257 struct { /* needed for BNO, CNT, INO */
258 struct xfs_buf
*agbp
; /* agf/agi buffer pointer */
259 struct xfs_defer_ops
*dfops
; /* deferred updates */
260 xfs_agnumber_t agno
; /* ag number */
261 union xfs_btree_cur_private priv
;
263 struct { /* needed for BMAP */
264 struct xfs_inode
*ip
; /* pointer to our inode */
265 struct xfs_defer_ops
*dfops
; /* deferred updates */
266 xfs_fsblock_t firstblock
; /* 1st blk allocated */
267 int allocated
; /* count of alloced */
268 short forksize
; /* fork's inode space */
269 char whichfork
; /* data or attr fork */
270 char flags
; /* flags */
271 #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
273 } bc_private
; /* per-btree type data */
277 #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */
278 #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */
279 #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */
280 #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */
281 #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */
284 #define XFS_BTREE_NOERROR 0
285 #define XFS_BTREE_ERROR 1
288 * Convert from buffer to btree block header.
290 #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr))
294 * Check that block header is ok.
297 xfs_btree_check_block(
298 struct xfs_btree_cur
*cur
, /* btree cursor */
299 struct xfs_btree_block
*block
, /* generic btree block pointer */
300 int level
, /* level of the btree block */
301 struct xfs_buf
*bp
); /* buffer containing block, if any */
304 * Check that (long) pointer is ok.
306 int /* error (0 or EFSCORRUPTED) */
307 xfs_btree_check_lptr(
308 struct xfs_btree_cur
*cur
, /* btree cursor */
309 xfs_fsblock_t ptr
, /* btree block disk address */
310 int level
); /* btree block level */
313 * Delete the btree cursor.
316 xfs_btree_del_cursor(
317 xfs_btree_cur_t
*cur
, /* btree cursor */
318 int error
); /* del because of error */
321 * Duplicate the btree cursor.
322 * Allocate a new one, copy the record, re-get the buffers.
325 xfs_btree_dup_cursor(
326 xfs_btree_cur_t
*cur
, /* input cursor */
327 xfs_btree_cur_t
**ncur
);/* output cursor */
330 * Get a buffer for the block, return it with no data read.
331 * Long-form addressing.
333 struct xfs_buf
* /* buffer for fsbno */
335 struct xfs_mount
*mp
, /* file system mount point */
336 struct xfs_trans
*tp
, /* transaction pointer */
337 xfs_fsblock_t fsbno
, /* file system block number */
338 uint lock
); /* lock flags for get_buf */
341 * Get a buffer for the block, return it with no data read.
342 * Short-form addressing.
344 struct xfs_buf
* /* buffer for agno/agbno */
346 struct xfs_mount
*mp
, /* file system mount point */
347 struct xfs_trans
*tp
, /* transaction pointer */
348 xfs_agnumber_t agno
, /* allocation group number */
349 xfs_agblock_t agbno
, /* allocation group block number */
350 uint lock
); /* lock flags for get_buf */
353 * Check for the cursor referring to the last block at the given level.
355 int /* 1=is last block, 0=not last block */
356 xfs_btree_islastblock(
357 xfs_btree_cur_t
*cur
, /* btree cursor */
358 int level
); /* level to check */
361 * Compute first and last byte offsets for the fields given.
362 * Interprets the offsets table, which contains struct field offsets.
366 __int64_t fields
, /* bitmask of fields */
367 const short *offsets
,/* table of field offsets */
368 int nbits
, /* number of bits to inspect */
369 int *first
, /* output: first byte offset */
370 int *last
); /* output: last byte offset */
373 * Get a buffer for the block, return it read in.
374 * Long-form addressing.
378 struct xfs_mount
*mp
, /* file system mount point */
379 struct xfs_trans
*tp
, /* transaction pointer */
380 xfs_fsblock_t fsbno
, /* file system block number */
381 uint lock
, /* lock flags for read_buf */
382 struct xfs_buf
**bpp
, /* buffer for fsbno */
383 int refval
, /* ref count value for buffer */
384 const struct xfs_buf_ops
*ops
);
387 * Read-ahead the block, don't wait for it, don't return a buffer.
388 * Long-form addressing.
391 xfs_btree_reada_bufl(
392 struct xfs_mount
*mp
, /* file system mount point */
393 xfs_fsblock_t fsbno
, /* file system block number */
394 xfs_extlen_t count
, /* count of filesystem blocks */
395 const struct xfs_buf_ops
*ops
);
398 * Read-ahead the block, don't wait for it, don't return a buffer.
399 * Short-form addressing.
402 xfs_btree_reada_bufs(
403 struct xfs_mount
*mp
, /* file system mount point */
404 xfs_agnumber_t agno
, /* allocation group number */
405 xfs_agblock_t agbno
, /* allocation group block number */
406 xfs_extlen_t count
, /* count of filesystem blocks */
407 const struct xfs_buf_ops
*ops
);
410 * Initialise a new btree block header
413 xfs_btree_init_block(
414 struct xfs_mount
*mp
,
423 xfs_btree_init_block_int(
424 struct xfs_mount
*mp
,
425 struct xfs_btree_block
*buf
,
434 * Common btree core entry points.
436 int xfs_btree_increment(struct xfs_btree_cur
*, int, int *);
437 int xfs_btree_decrement(struct xfs_btree_cur
*, int, int *);
438 int xfs_btree_lookup(struct xfs_btree_cur
*, xfs_lookup_t
, int *);
439 int xfs_btree_update(struct xfs_btree_cur
*, union xfs_btree_rec
*);
440 int xfs_btree_new_iroot(struct xfs_btree_cur
*, int *, int *);
441 int xfs_btree_insert(struct xfs_btree_cur
*, int *);
442 int xfs_btree_delete(struct xfs_btree_cur
*, int *);
443 int xfs_btree_get_rec(struct xfs_btree_cur
*, union xfs_btree_rec
**, int *);
444 int xfs_btree_change_owner(struct xfs_btree_cur
*cur
, __uint64_t new_owner
,
445 struct list_head
*buffer_list
);
448 * btree block CRC helpers
450 void xfs_btree_lblock_calc_crc(struct xfs_buf
*);
451 bool xfs_btree_lblock_verify_crc(struct xfs_buf
*);
452 void xfs_btree_sblock_calc_crc(struct xfs_buf
*);
453 bool xfs_btree_sblock_verify_crc(struct xfs_buf
*);
456 * Internal btree helpers also used by xfs_bmap.c.
458 void xfs_btree_log_block(struct xfs_btree_cur
*, struct xfs_buf
*, int);
459 void xfs_btree_log_recs(struct xfs_btree_cur
*, struct xfs_buf
*, int, int);
464 static inline int xfs_btree_get_numrecs(struct xfs_btree_block
*block
)
466 return be16_to_cpu(block
->bb_numrecs
);
469 static inline void xfs_btree_set_numrecs(struct xfs_btree_block
*block
,
472 block
->bb_numrecs
= cpu_to_be16(numrecs
);
475 static inline int xfs_btree_get_level(struct xfs_btree_block
*block
)
477 return be16_to_cpu(block
->bb_level
);
482 * Min and max functions for extlen, agblock, fileoff, and filblks types.
484 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
485 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
486 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
487 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
488 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
489 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
490 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
491 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
493 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
494 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
495 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
498 * Trace hooks. Currently not implemented as they need to be ported
499 * over to the generic tracing functionality, which is some effort.
501 * i,j = integer (32 bit)
502 * b = btree block buffer (xfs_buf_t)
507 #define XFS_BTREE_TRACE_ARGBI(c, b, i)
508 #define XFS_BTREE_TRACE_ARGBII(c, b, i, j)
509 #define XFS_BTREE_TRACE_ARGI(c, i)
510 #define XFS_BTREE_TRACE_ARGIPK(c, i, p, s)
511 #define XFS_BTREE_TRACE_ARGIPR(c, i, p, r)
512 #define XFS_BTREE_TRACE_ARGIK(c, i, k)
513 #define XFS_BTREE_TRACE_ARGR(c, r)
514 #define XFS_BTREE_TRACE_CURSOR(c, t)
516 bool xfs_btree_sblock_v5hdr_verify(struct xfs_buf
*bp
);
517 bool xfs_btree_sblock_verify(struct xfs_buf
*bp
, unsigned int max_recs
);
518 uint
xfs_btree_compute_maxlevels(struct xfs_mount
*mp
, uint
*limits
,
520 xfs_extlen_t
xfs_btree_calc_size(struct xfs_mount
*mp
, uint
*limits
,
521 unsigned long long len
);
524 #define XFS_BTREE_QUERY_RANGE_CONTINUE 0 /* keep iterating */
525 #define XFS_BTREE_QUERY_RANGE_ABORT 1 /* stop iterating */
526 typedef int (*xfs_btree_query_range_fn
)(struct xfs_btree_cur
*cur
,
527 union xfs_btree_rec
*rec
, void *priv
);
529 int xfs_btree_query_range(struct xfs_btree_cur
*cur
,
530 union xfs_btree_irec
*low_rec
, union xfs_btree_irec
*high_rec
,
531 xfs_btree_query_range_fn fn
, void *priv
);
533 typedef int (*xfs_btree_visit_blocks_fn
)(struct xfs_btree_cur
*cur
, int level
,
535 int xfs_btree_visit_blocks(struct xfs_btree_cur
*cur
,
536 xfs_btree_visit_blocks_fn fn
, void *data
);
538 int xfs_btree_count_blocks(struct xfs_btree_cur
*cur
, xfs_extlen_t
*blocks
);
540 #endif /* __XFS_BTREE_H__ */