]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blob - libxfs/xfs_btree.h
xfs: introduce refcount btree definitions
[thirdparty/xfsprogs-dev.git] / libxfs / xfs_btree.h
1 /*
2 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
4 *
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.
8 *
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.
13 *
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
17 */
18 #ifndef __XFS_BTREE_H__
19 #define __XFS_BTREE_H__
20
21 struct xfs_buf;
22 struct xfs_defer_ops;
23 struct xfs_inode;
24 struct xfs_mount;
25 struct xfs_trans;
26
27 extern kmem_zone_t *xfs_btree_cur_zone;
28
29 /*
30 * Generic key, ptr and record wrapper structures.
31 *
32 * These are disk format structures, and are converted where necessary
33 * by the btree specific code that needs to interpret them.
34 */
35 union xfs_btree_ptr {
36 __be32 s; /* short form ptr */
37 __be64 l; /* long form ptr */
38 };
39
40 /*
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.
44 */
45 union xfs_btree_key {
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 };
53
54 union xfs_btree_rec {
55 struct xfs_bmbt_rec bmbt;
56 xfs_bmdr_rec_t bmbr; /* bmbt root block */
57 struct xfs_alloc_rec alloc;
58 struct xfs_inobt_rec inobt;
59 struct xfs_rmap_rec rmap;
60 };
61
62 /*
63 * This nonsense is to make -wlint happy.
64 */
65 #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi)
66 #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi)
67 #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi)
68
69 #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi)
70 #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi)
71 #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi)
72 #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi)
73 #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi)
74 #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi)
75 #define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi)
76
77 /*
78 * For logging record fields.
79 */
80 #define XFS_BB_MAGIC (1 << 0)
81 #define XFS_BB_LEVEL (1 << 1)
82 #define XFS_BB_NUMRECS (1 << 2)
83 #define XFS_BB_LEFTSIB (1 << 3)
84 #define XFS_BB_RIGHTSIB (1 << 4)
85 #define XFS_BB_BLKNO (1 << 5)
86 #define XFS_BB_LSN (1 << 6)
87 #define XFS_BB_UUID (1 << 7)
88 #define XFS_BB_OWNER (1 << 8)
89 #define XFS_BB_NUM_BITS 5
90 #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
91 #define XFS_BB_NUM_BITS_CRC 9
92 #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1)
93
94 /*
95 * Generic stats interface
96 */
97 #define __XFS_BTREE_STATS_INC(mp, type, stat) \
98 XFS_STATS_INC(mp, xs_ ## type ## _2_ ## stat)
99 #define XFS_BTREE_STATS_INC(cur, stat) \
100 do { \
101 struct xfs_mount *__mp = cur->bc_mp; \
102 switch (cur->bc_btnum) { \
103 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(__mp, abtb, stat); break; \
104 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(__mp, abtc, stat); break; \
105 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(__mp, bmbt, stat); break; \
106 case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(__mp, ibt, stat); break; \
107 case XFS_BTNUM_FINO: __XFS_BTREE_STATS_INC(__mp, fibt, stat); break; \
108 case XFS_BTNUM_RMAP: __XFS_BTREE_STATS_INC(__mp, rmap, stat); break; \
109 case XFS_BTNUM_REFC: __XFS_BTREE_STATS_INC(__mp, refcbt, stat); break; \
110 case XFS_BTNUM_MAX: ASSERT(0); __mp = __mp /* fucking gcc */ ; break; \
111 } \
112 } while (0)
113
114 #define __XFS_BTREE_STATS_ADD(mp, type, stat, val) \
115 XFS_STATS_ADD(mp, xs_ ## type ## _2_ ## stat, val)
116 #define XFS_BTREE_STATS_ADD(cur, stat, val) \
117 do { \
118 struct xfs_mount *__mp = cur->bc_mp; \
119 switch (cur->bc_btnum) { \
120 case XFS_BTNUM_BNO: \
121 __XFS_BTREE_STATS_ADD(__mp, abtb, stat, val); break; \
122 case XFS_BTNUM_CNT: \
123 __XFS_BTREE_STATS_ADD(__mp, abtc, stat, val); break; \
124 case XFS_BTNUM_BMAP: \
125 __XFS_BTREE_STATS_ADD(__mp, bmbt, stat, val); break; \
126 case XFS_BTNUM_INO: \
127 __XFS_BTREE_STATS_ADD(__mp, ibt, stat, val); break; \
128 case XFS_BTNUM_FINO: \
129 __XFS_BTREE_STATS_ADD(__mp, fibt, stat, val); break; \
130 case XFS_BTNUM_RMAP: \
131 __XFS_BTREE_STATS_ADD(__mp, rmap, stat, val); break; \
132 case XFS_BTNUM_REFC: \
133 __XFS_BTREE_STATS_ADD(__mp, refcbt, stat, val); break; \
134 case XFS_BTNUM_MAX: ASSERT(0); __mp = __mp /* fucking gcc */ ; break; \
135 } \
136 } while (0)
137
138 #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */
139
140 struct xfs_btree_ops {
141 /* size of the key and record structures */
142 size_t key_len;
143 size_t rec_len;
144
145 /* cursor operations */
146 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
147 void (*update_cursor)(struct xfs_btree_cur *src,
148 struct xfs_btree_cur *dst);
149
150 /* update btree root pointer */
151 void (*set_root)(struct xfs_btree_cur *cur,
152 union xfs_btree_ptr *nptr, int level_change);
153
154 /* block allocation / freeing */
155 int (*alloc_block)(struct xfs_btree_cur *cur,
156 union xfs_btree_ptr *start_bno,
157 union xfs_btree_ptr *new_bno,
158 int *stat);
159 int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
160
161 /* update last record information */
162 void (*update_lastrec)(struct xfs_btree_cur *cur,
163 struct xfs_btree_block *block,
164 union xfs_btree_rec *rec,
165 int ptr, int reason);
166
167 /* records in block/level */
168 int (*get_minrecs)(struct xfs_btree_cur *cur, int level);
169 int (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
170
171 /* records on disk. Matter for the root in inode case. */
172 int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
173
174 /* init values of btree structures */
175 void (*init_key_from_rec)(union xfs_btree_key *key,
176 union xfs_btree_rec *rec);
177 void (*init_rec_from_cur)(struct xfs_btree_cur *cur,
178 union xfs_btree_rec *rec);
179 void (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
180 union xfs_btree_ptr *ptr);
181 void (*init_high_key_from_rec)(union xfs_btree_key *key,
182 union xfs_btree_rec *rec);
183
184 /* difference between key value and cursor value */
185 __int64_t (*key_diff)(struct xfs_btree_cur *cur,
186 union xfs_btree_key *key);
187
188 /*
189 * Difference between key2 and key1 -- positive if key1 > key2,
190 * negative if key1 < key2, and zero if equal.
191 */
192 __int64_t (*diff_two_keys)(struct xfs_btree_cur *cur,
193 union xfs_btree_key *key1,
194 union xfs_btree_key *key2);
195
196 const struct xfs_buf_ops *buf_ops;
197
198 #if defined(DEBUG) || defined(XFS_WARN)
199 /* check that k1 is lower than k2 */
200 int (*keys_inorder)(struct xfs_btree_cur *cur,
201 union xfs_btree_key *k1,
202 union xfs_btree_key *k2);
203
204 /* check that r1 is lower than r2 */
205 int (*recs_inorder)(struct xfs_btree_cur *cur,
206 union xfs_btree_rec *r1,
207 union xfs_btree_rec *r2);
208 #endif
209 };
210
211 /*
212 * Reasons for the update_lastrec method to be called.
213 */
214 #define LASTREC_UPDATE 0
215 #define LASTREC_INSREC 1
216 #define LASTREC_DELREC 2
217
218
219 union xfs_btree_irec {
220 struct xfs_alloc_rec_incore a;
221 struct xfs_bmbt_irec b;
222 struct xfs_inobt_rec_incore i;
223 struct xfs_rmap_irec r;
224 };
225
226 /*
227 * Btree cursor structure.
228 * This collects all information needed by the btree code in one place.
229 */
230 typedef struct xfs_btree_cur
231 {
232 struct xfs_trans *bc_tp; /* transaction we're in, if any */
233 struct xfs_mount *bc_mp; /* file system mount struct */
234 const struct xfs_btree_ops *bc_ops;
235 uint bc_flags; /* btree features - below */
236 union xfs_btree_irec bc_rec; /* current insert/search record value */
237 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */
238 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
239 __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
240 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
241 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
242 __uint8_t bc_nlevels; /* number of levels in the tree */
243 __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
244 xfs_btnum_t bc_btnum; /* identifies which btree type */
245 union {
246 struct { /* needed for BNO, CNT, INO */
247 struct xfs_buf *agbp; /* agf/agi buffer pointer */
248 struct xfs_defer_ops *dfops; /* deferred updates */
249 xfs_agnumber_t agno; /* ag number */
250 } a;
251 struct { /* needed for BMAP */
252 struct xfs_inode *ip; /* pointer to our inode */
253 struct xfs_defer_ops *dfops; /* deferred updates */
254 xfs_fsblock_t firstblock; /* 1st blk allocated */
255 int allocated; /* count of alloced */
256 short forksize; /* fork's inode space */
257 char whichfork; /* data or attr fork */
258 char flags; /* flags */
259 #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */
260 } b;
261 } bc_private; /* per-btree type data */
262 } xfs_btree_cur_t;
263
264 /* cursor flags */
265 #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */
266 #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */
267 #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */
268 #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */
269 #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */
270
271
272 #define XFS_BTREE_NOERROR 0
273 #define XFS_BTREE_ERROR 1
274
275 /*
276 * Convert from buffer to btree block header.
277 */
278 #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr))
279
280
281 /*
282 * Check that block header is ok.
283 */
284 int
285 xfs_btree_check_block(
286 struct xfs_btree_cur *cur, /* btree cursor */
287 struct xfs_btree_block *block, /* generic btree block pointer */
288 int level, /* level of the btree block */
289 struct xfs_buf *bp); /* buffer containing block, if any */
290
291 /*
292 * Check that (long) pointer is ok.
293 */
294 int /* error (0 or EFSCORRUPTED) */
295 xfs_btree_check_lptr(
296 struct xfs_btree_cur *cur, /* btree cursor */
297 xfs_fsblock_t ptr, /* btree block disk address */
298 int level); /* btree block level */
299
300 /*
301 * Delete the btree cursor.
302 */
303 void
304 xfs_btree_del_cursor(
305 xfs_btree_cur_t *cur, /* btree cursor */
306 int error); /* del because of error */
307
308 /*
309 * Duplicate the btree cursor.
310 * Allocate a new one, copy the record, re-get the buffers.
311 */
312 int /* error */
313 xfs_btree_dup_cursor(
314 xfs_btree_cur_t *cur, /* input cursor */
315 xfs_btree_cur_t **ncur);/* output cursor */
316
317 /*
318 * Get a buffer for the block, return it with no data read.
319 * Long-form addressing.
320 */
321 struct xfs_buf * /* buffer for fsbno */
322 xfs_btree_get_bufl(
323 struct xfs_mount *mp, /* file system mount point */
324 struct xfs_trans *tp, /* transaction pointer */
325 xfs_fsblock_t fsbno, /* file system block number */
326 uint lock); /* lock flags for get_buf */
327
328 /*
329 * Get a buffer for the block, return it with no data read.
330 * Short-form addressing.
331 */
332 struct xfs_buf * /* buffer for agno/agbno */
333 xfs_btree_get_bufs(
334 struct xfs_mount *mp, /* file system mount point */
335 struct xfs_trans *tp, /* transaction pointer */
336 xfs_agnumber_t agno, /* allocation group number */
337 xfs_agblock_t agbno, /* allocation group block number */
338 uint lock); /* lock flags for get_buf */
339
340 /*
341 * Check for the cursor referring to the last block at the given level.
342 */
343 int /* 1=is last block, 0=not last block */
344 xfs_btree_islastblock(
345 xfs_btree_cur_t *cur, /* btree cursor */
346 int level); /* level to check */
347
348 /*
349 * Compute first and last byte offsets for the fields given.
350 * Interprets the offsets table, which contains struct field offsets.
351 */
352 void
353 xfs_btree_offsets(
354 __int64_t fields, /* bitmask of fields */
355 const short *offsets,/* table of field offsets */
356 int nbits, /* number of bits to inspect */
357 int *first, /* output: first byte offset */
358 int *last); /* output: last byte offset */
359
360 /*
361 * Get a buffer for the block, return it read in.
362 * Long-form addressing.
363 */
364 int /* error */
365 xfs_btree_read_bufl(
366 struct xfs_mount *mp, /* file system mount point */
367 struct xfs_trans *tp, /* transaction pointer */
368 xfs_fsblock_t fsbno, /* file system block number */
369 uint lock, /* lock flags for read_buf */
370 struct xfs_buf **bpp, /* buffer for fsbno */
371 int refval, /* ref count value for buffer */
372 const struct xfs_buf_ops *ops);
373
374 /*
375 * Read-ahead the block, don't wait for it, don't return a buffer.
376 * Long-form addressing.
377 */
378 void /* error */
379 xfs_btree_reada_bufl(
380 struct xfs_mount *mp, /* file system mount point */
381 xfs_fsblock_t fsbno, /* file system block number */
382 xfs_extlen_t count, /* count of filesystem blocks */
383 const struct xfs_buf_ops *ops);
384
385 /*
386 * Read-ahead the block, don't wait for it, don't return a buffer.
387 * Short-form addressing.
388 */
389 void /* error */
390 xfs_btree_reada_bufs(
391 struct xfs_mount *mp, /* file system mount point */
392 xfs_agnumber_t agno, /* allocation group number */
393 xfs_agblock_t agbno, /* allocation group block number */
394 xfs_extlen_t count, /* count of filesystem blocks */
395 const struct xfs_buf_ops *ops);
396
397 /*
398 * Initialise a new btree block header
399 */
400 void
401 xfs_btree_init_block(
402 struct xfs_mount *mp,
403 struct xfs_buf *bp,
404 __u32 magic,
405 __u16 level,
406 __u16 numrecs,
407 __u64 owner,
408 unsigned int flags);
409
410 void
411 xfs_btree_init_block_int(
412 struct xfs_mount *mp,
413 struct xfs_btree_block *buf,
414 xfs_daddr_t blkno,
415 __u32 magic,
416 __u16 level,
417 __u16 numrecs,
418 __u64 owner,
419 unsigned int flags);
420
421 /*
422 * Common btree core entry points.
423 */
424 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
425 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
426 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
427 int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
428 int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
429 int xfs_btree_insert(struct xfs_btree_cur *, int *);
430 int xfs_btree_delete(struct xfs_btree_cur *, int *);
431 int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
432 int xfs_btree_change_owner(struct xfs_btree_cur *cur, __uint64_t new_owner,
433 struct list_head *buffer_list);
434
435 /*
436 * btree block CRC helpers
437 */
438 void xfs_btree_lblock_calc_crc(struct xfs_buf *);
439 bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
440 void xfs_btree_sblock_calc_crc(struct xfs_buf *);
441 bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
442
443 /*
444 * Internal btree helpers also used by xfs_bmap.c.
445 */
446 void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
447 void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
448
449 /*
450 * Helpers.
451 */
452 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
453 {
454 return be16_to_cpu(block->bb_numrecs);
455 }
456
457 static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
458 __uint16_t numrecs)
459 {
460 block->bb_numrecs = cpu_to_be16(numrecs);
461 }
462
463 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
464 {
465 return be16_to_cpu(block->bb_level);
466 }
467
468
469 /*
470 * Min and max functions for extlen, agblock, fileoff, and filblks types.
471 */
472 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
473 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
474 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
475 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
476 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
477 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
478 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
479 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
480
481 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
482 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
483 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
484
485 /*
486 * Trace hooks. Currently not implemented as they need to be ported
487 * over to the generic tracing functionality, which is some effort.
488 *
489 * i,j = integer (32 bit)
490 * b = btree block buffer (xfs_buf_t)
491 * p = btree ptr
492 * r = btree record
493 * k = btree key
494 */
495 #define XFS_BTREE_TRACE_ARGBI(c, b, i)
496 #define XFS_BTREE_TRACE_ARGBII(c, b, i, j)
497 #define XFS_BTREE_TRACE_ARGI(c, i)
498 #define XFS_BTREE_TRACE_ARGIPK(c, i, p, s)
499 #define XFS_BTREE_TRACE_ARGIPR(c, i, p, r)
500 #define XFS_BTREE_TRACE_ARGIK(c, i, k)
501 #define XFS_BTREE_TRACE_ARGR(c, r)
502 #define XFS_BTREE_TRACE_CURSOR(c, t)
503
504 bool xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp);
505 bool xfs_btree_sblock_verify(struct xfs_buf *bp, unsigned int max_recs);
506 uint xfs_btree_compute_maxlevels(struct xfs_mount *mp, uint *limits,
507 unsigned long len);
508 xfs_extlen_t xfs_btree_calc_size(struct xfs_mount *mp, uint *limits,
509 unsigned long long len);
510
511 /* return codes */
512 #define XFS_BTREE_QUERY_RANGE_CONTINUE 0 /* keep iterating */
513 #define XFS_BTREE_QUERY_RANGE_ABORT 1 /* stop iterating */
514 typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur,
515 union xfs_btree_rec *rec, void *priv);
516
517 int xfs_btree_query_range(struct xfs_btree_cur *cur,
518 union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec,
519 xfs_btree_query_range_fn fn, void *priv);
520
521 typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level,
522 void *data);
523 int xfs_btree_visit_blocks(struct xfs_btree_cur *cur,
524 xfs_btree_visit_blocks_fn fn, void *data);
525
526 int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks);
527
528 #endif /* __XFS_BTREE_H__ */