]>
Commit | Line | Data |
---|---|---|
37b3b4d6 | 1 | // SPDX-License-Identifier: GPL-2.0 |
2bd0ea18 | 2 | /* |
f302e9e4 NS |
3 | * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc. |
4 | * All Rights Reserved. | |
2bd0ea18 NS |
5 | */ |
6 | #ifndef __XFS_BTREE_H__ | |
dfc130f3 | 7 | #define __XFS_BTREE_H__ |
2bd0ea18 NS |
8 | |
9 | struct xfs_buf; | |
6f530e9a | 10 | struct xfs_defer_ops; |
2bd0ea18 NS |
11 | struct xfs_inode; |
12 | struct xfs_mount; | |
13 | struct xfs_trans; | |
14 | ||
5e656dbb BN |
15 | extern kmem_zone_t *xfs_btree_cur_zone; |
16 | ||
ff105f75 DC |
17 | /* |
18 | * Generic key, ptr and record wrapper structures. | |
19 | * | |
20 | * These are disk format structures, and are converted where necessary | |
21 | * by the btree specific code that needs to interpret them. | |
22 | */ | |
23 | union xfs_btree_ptr { | |
24 | __be32 s; /* short form ptr */ | |
25 | __be64 l; /* long form ptr */ | |
26 | }; | |
27 | ||
13e831e0 | 28 | /* |
45413937 DW |
29 | * The in-core btree key. Overlapping btrees actually store two keys |
30 | * per pointer, so we reserve enough memory to hold both. The __*bigkey | |
31 | * items should never be accessed directly. | |
13e831e0 | 32 | */ |
45413937 | 33 | union xfs_btree_key { |
13e831e0 DW |
34 | struct xfs_bmbt_key bmbt; |
35 | xfs_bmdr_key_t bmbr; /* bmbt root block */ | |
36 | xfs_alloc_key_t alloc; | |
37 | struct xfs_inobt_key inobt; | |
45413937 DW |
38 | struct xfs_rmap_key rmap; |
39 | struct xfs_rmap_key __rmap_bigkey[2]; | |
d8079fe0 | 40 | struct xfs_refcount_key refc; |
13e831e0 DW |
41 | }; |
42 | ||
ff105f75 | 43 | union xfs_btree_rec { |
b3a96b46 DW |
44 | struct xfs_bmbt_rec bmbt; |
45 | xfs_bmdr_rec_t bmbr; /* bmbt root block */ | |
46 | struct xfs_alloc_rec alloc; | |
47 | struct xfs_inobt_rec inobt; | |
48 | struct xfs_rmap_rec rmap; | |
d8079fe0 | 49 | struct xfs_refcount_rec refc; |
ff105f75 DC |
50 | }; |
51 | ||
2bd0ea18 NS |
52 | /* |
53 | * This nonsense is to make -wlint happy. | |
54 | */ | |
dfc130f3 RC |
55 | #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) |
56 | #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) | |
57 | #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) | |
2bd0ea18 | 58 | |
dfc130f3 RC |
59 | #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) |
60 | #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) | |
61 | #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) | |
62 | #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) | |
c0a4c227 | 63 | #define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi) |
e37838e5 | 64 | #define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi) |
88ce0792 | 65 | #define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi) |
2bd0ea18 | 66 | |
4a492e72 | 67 | uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum); |
4c6b3277 | 68 | |
2bd0ea18 NS |
69 | /* |
70 | * For logging record fields. | |
71 | */ | |
9c6ebc42 DC |
72 | #define XFS_BB_MAGIC (1 << 0) |
73 | #define XFS_BB_LEVEL (1 << 1) | |
74 | #define XFS_BB_NUMRECS (1 << 2) | |
75 | #define XFS_BB_LEFTSIB (1 << 3) | |
76 | #define XFS_BB_RIGHTSIB (1 << 4) | |
77 | #define XFS_BB_BLKNO (1 << 5) | |
78 | #define XFS_BB_LSN (1 << 6) | |
79 | #define XFS_BB_UUID (1 << 7) | |
80 | #define XFS_BB_OWNER (1 << 8) | |
dfc130f3 RC |
81 | #define XFS_BB_NUM_BITS 5 |
82 | #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) | |
9c6ebc42 | 83 | #define XFS_BB_NUM_BITS_CRC 9 |
5dfa5cd2 | 84 | #define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1) |
2bd0ea18 | 85 | |
b194c7d8 BN |
86 | /* |
87 | * Generic stats interface | |
88 | */ | |
79896434 | 89 | #define XFS_BTREE_STATS_INC(cur, stat) \ |
5d8acc46 DC |
90 | XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat) |
91 | #define XFS_BTREE_STATS_ADD(cur, stat, val) \ | |
92 | XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val) | |
2bd0ea18 | 93 | |
513ec1c3 | 94 | #define XFS_BTREE_MAXLEVELS 9 /* max of all btrees */ |
2bd0ea18 | 95 | |
b194c7d8 BN |
96 | struct xfs_btree_ops { |
97 | /* size of the key and record structures */ | |
98 | size_t key_len; | |
99 | size_t rec_len; | |
100 | ||
101 | /* cursor operations */ | |
102 | struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *); | |
103 | void (*update_cursor)(struct xfs_btree_cur *src, | |
104 | struct xfs_btree_cur *dst); | |
105 | ||
106 | /* update btree root pointer */ | |
107 | void (*set_root)(struct xfs_btree_cur *cur, | |
56b2de80 | 108 | union xfs_btree_ptr *nptr, int level_change); |
b194c7d8 BN |
109 | |
110 | /* block allocation / freeing */ | |
111 | int (*alloc_block)(struct xfs_btree_cur *cur, | |
112 | union xfs_btree_ptr *start_bno, | |
113 | union xfs_btree_ptr *new_bno, | |
ff105f75 | 114 | int *stat); |
b194c7d8 BN |
115 | int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp); |
116 | ||
117 | /* update last record information */ | |
118 | void (*update_lastrec)(struct xfs_btree_cur *cur, | |
119 | struct xfs_btree_block *block, | |
120 | union xfs_btree_rec *rec, | |
121 | int ptr, int reason); | |
122 | ||
123 | /* records in block/level */ | |
124 | int (*get_minrecs)(struct xfs_btree_cur *cur, int level); | |
125 | int (*get_maxrecs)(struct xfs_btree_cur *cur, int level); | |
126 | ||
127 | /* records on disk. Matter for the root in inode case. */ | |
128 | int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level); | |
129 | ||
130 | /* init values of btree structures */ | |
131 | void (*init_key_from_rec)(union xfs_btree_key *key, | |
132 | union xfs_btree_rec *rec); | |
b194c7d8 BN |
133 | void (*init_rec_from_cur)(struct xfs_btree_cur *cur, |
134 | union xfs_btree_rec *rec); | |
135 | void (*init_ptr_from_cur)(struct xfs_btree_cur *cur, | |
136 | union xfs_btree_ptr *ptr); | |
13e831e0 DW |
137 | void (*init_high_key_from_rec)(union xfs_btree_key *key, |
138 | union xfs_btree_rec *rec); | |
b194c7d8 BN |
139 | |
140 | /* difference between key value and cursor value */ | |
4a492e72 | 141 | int64_t (*key_diff)(struct xfs_btree_cur *cur, |
b194c7d8 BN |
142 | union xfs_btree_key *key); |
143 | ||
13e831e0 DW |
144 | /* |
145 | * Difference between key2 and key1 -- positive if key1 > key2, | |
146 | * negative if key1 < key2, and zero if equal. | |
147 | */ | |
4a492e72 | 148 | int64_t (*diff_two_keys)(struct xfs_btree_cur *cur, |
13e831e0 DW |
149 | union xfs_btree_key *key1, |
150 | union xfs_btree_key *key2); | |
151 | ||
a2ceac1f DC |
152 | const struct xfs_buf_ops *buf_ops; |
153 | ||
b194c7d8 BN |
154 | /* check that k1 is lower than k2 */ |
155 | int (*keys_inorder)(struct xfs_btree_cur *cur, | |
156 | union xfs_btree_key *k1, | |
157 | union xfs_btree_key *k2); | |
158 | ||
159 | /* check that r1 is lower than r2 */ | |
160 | int (*recs_inorder)(struct xfs_btree_cur *cur, | |
161 | union xfs_btree_rec *r1, | |
162 | union xfs_btree_rec *r2); | |
b194c7d8 BN |
163 | }; |
164 | ||
165 | /* | |
166 | * Reasons for the update_lastrec method to be called. | |
167 | */ | |
168 | #define LASTREC_UPDATE 0 | |
169 | #define LASTREC_INSREC 1 | |
170 | #define LASTREC_DELREC 2 | |
171 | ||
172 | ||
5d3b7fe1 DW |
173 | union xfs_btree_irec { |
174 | struct xfs_alloc_rec_incore a; | |
175 | struct xfs_bmbt_irec b; | |
176 | struct xfs_inobt_rec_incore i; | |
936ca687 | 177 | struct xfs_rmap_irec r; |
d8079fe0 DW |
178 | struct xfs_refcount_irec rc; |
179 | }; | |
180 | ||
181 | /* Per-AG btree private information. */ | |
182 | union xfs_btree_cur_private { | |
183 | struct { | |
184 | unsigned long nr_ops; /* # record updates */ | |
185 | int shape_changes; /* # of extent splits */ | |
186 | } refc; | |
5d3b7fe1 DW |
187 | }; |
188 | ||
2bd0ea18 NS |
189 | /* |
190 | * Btree cursor structure. | |
191 | * This collects all information needed by the btree code in one place. | |
192 | */ | |
193 | typedef struct xfs_btree_cur | |
194 | { | |
dfc130f3 RC |
195 | struct xfs_trans *bc_tp; /* transaction we're in, if any */ |
196 | struct xfs_mount *bc_mp; /* file system mount struct */ | |
b194c7d8 BN |
197 | const struct xfs_btree_ops *bc_ops; |
198 | uint bc_flags; /* btree features - below */ | |
5d3b7fe1 | 199 | union xfs_btree_irec bc_rec; /* current insert/search record value */ |
2bd0ea18 NS |
200 | struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ |
201 | int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ | |
4a492e72 | 202 | uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ |
dfc130f3 RC |
203 | #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ |
204 | #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ | |
4a492e72 DW |
205 | uint8_t bc_nlevels; /* number of levels in the tree */ |
206 | uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ | |
2bd0ea18 | 207 | xfs_btnum_t bc_btnum; /* identifies which btree type */ |
5d8acc46 | 208 | int bc_statoff; /* offset of btre stats array */ |
2bd0ea18 | 209 | union { |
5e656dbb BN |
210 | struct { /* needed for BNO, CNT, INO */ |
211 | struct xfs_buf *agbp; /* agf/agi buffer pointer */ | |
2bd0ea18 | 212 | xfs_agnumber_t agno; /* ag number */ |
d8079fe0 | 213 | union xfs_btree_cur_private priv; |
2bd0ea18 NS |
214 | } a; |
215 | struct { /* needed for BMAP */ | |
216 | struct xfs_inode *ip; /* pointer to our inode */ | |
2bd0ea18 NS |
217 | int allocated; /* count of alloced */ |
218 | short forksize; /* fork's inode space */ | |
219 | char whichfork; /* data or attr fork */ | |
220 | char flags; /* flags */ | |
c7ba1731 BF |
221 | #define XFS_BTCUR_BPRV_WASDEL (1<<0) /* was delayed */ |
222 | #define XFS_BTCUR_BPRV_INVALID_OWNER (1<<1) /* for ext swap */ | |
2bd0ea18 | 223 | } b; |
2bd0ea18 NS |
224 | } bc_private; /* per-btree type data */ |
225 | } xfs_btree_cur_t; | |
226 | ||
b194c7d8 BN |
227 | /* cursor flags */ |
228 | #define XFS_BTREE_LONG_PTRS (1<<0) /* pointers are 64bits long */ | |
229 | #define XFS_BTREE_ROOT_IN_INODE (1<<1) /* root may be variable size */ | |
230 | #define XFS_BTREE_LASTREC_UPDATE (1<<2) /* track last rec externally */ | |
5dfa5cd2 | 231 | #define XFS_BTREE_CRC_BLOCKS (1<<3) /* uses extended btree blocks */ |
13e831e0 | 232 | #define XFS_BTREE_OVERLAPPING (1<<4) /* overlapping intervals */ |
b194c7d8 BN |
233 | |
234 | ||
dfc130f3 RC |
235 | #define XFS_BTREE_NOERROR 0 |
236 | #define XFS_BTREE_ERROR 1 | |
2bd0ea18 NS |
237 | |
238 | /* | |
239 | * Convert from buffer to btree block header. | |
240 | */ | |
a2ceac1f | 241 | #define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr)) |
f302e9e4 | 242 | |
b47beff8 DW |
243 | /* |
244 | * Internal long and short btree block checks. They return NULL if the | |
245 | * block is ok or the address of the failed check otherwise. | |
246 | */ | |
247 | xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur, | |
248 | struct xfs_btree_block *block, int level, struct xfs_buf *bp); | |
249 | xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur, | |
250 | struct xfs_btree_block *block, int level, struct xfs_buf *bp); | |
2bd0ea18 | 251 | |
2bd0ea18 | 252 | /* |
b194c7d8 | 253 | * Check that block header is ok. |
2bd0ea18 | 254 | */ |
b194c7d8 BN |
255 | int |
256 | xfs_btree_check_block( | |
257 | struct xfs_btree_cur *cur, /* btree cursor */ | |
258 | struct xfs_btree_block *block, /* generic btree block pointer */ | |
2bd0ea18 NS |
259 | int level, /* level of the btree block */ |
260 | struct xfs_buf *bp); /* buffer containing block, if any */ | |
261 | ||
262 | /* | |
b194c7d8 | 263 | * Check that (long) pointer is ok. |
2bd0ea18 | 264 | */ |
d5c546df | 265 | bool /* error (0 or EFSCORRUPTED) */ |
2bd0ea18 | 266 | xfs_btree_check_lptr( |
b194c7d8 | 267 | struct xfs_btree_cur *cur, /* btree cursor */ |
d5c546df DW |
268 | xfs_fsblock_t fsbno, /* btree block disk address */ |
269 | int level); /* btree block level */ | |
270 | ||
271 | /* | |
272 | * Check that (short) pointer is ok. | |
273 | */ | |
274 | bool /* error (0 or EFSCORRUPTED) */ | |
275 | xfs_btree_check_sptr( | |
276 | struct xfs_btree_cur *cur, /* btree cursor */ | |
277 | xfs_agblock_t agbno, /* btree block disk address */ | |
dfc130f3 | 278 | int level); /* btree block level */ |
2bd0ea18 | 279 | |
2bd0ea18 NS |
280 | /* |
281 | * Delete the btree cursor. | |
282 | */ | |
283 | void | |
284 | xfs_btree_del_cursor( | |
285 | xfs_btree_cur_t *cur, /* btree cursor */ | |
dfc130f3 | 286 | int error); /* del because of error */ |
2bd0ea18 NS |
287 | |
288 | /* | |
289 | * Duplicate the btree cursor. | |
290 | * Allocate a new one, copy the record, re-get the buffers. | |
291 | */ | |
292 | int /* error */ | |
293 | xfs_btree_dup_cursor( | |
294 | xfs_btree_cur_t *cur, /* input cursor */ | |
295 | xfs_btree_cur_t **ncur);/* output cursor */ | |
296 | ||
2bd0ea18 NS |
297 | /* |
298 | * Get a buffer for the block, return it with no data read. | |
299 | * Long-form addressing. | |
300 | */ | |
301 | struct xfs_buf * /* buffer for fsbno */ | |
302 | xfs_btree_get_bufl( | |
303 | struct xfs_mount *mp, /* file system mount point */ | |
304 | struct xfs_trans *tp, /* transaction pointer */ | |
305 | xfs_fsblock_t fsbno, /* file system block number */ | |
306 | uint lock); /* lock flags for get_buf */ | |
307 | ||
308 | /* | |
309 | * Get a buffer for the block, return it with no data read. | |
310 | * Short-form addressing. | |
311 | */ | |
312 | struct xfs_buf * /* buffer for agno/agbno */ | |
313 | xfs_btree_get_bufs( | |
314 | struct xfs_mount *mp, /* file system mount point */ | |
315 | struct xfs_trans *tp, /* transaction pointer */ | |
316 | xfs_agnumber_t agno, /* allocation group number */ | |
317 | xfs_agblock_t agbno, /* allocation group block number */ | |
318 | uint lock); /* lock flags for get_buf */ | |
319 | ||
2bd0ea18 NS |
320 | /* |
321 | * Check for the cursor referring to the last block at the given level. | |
322 | */ | |
323 | int /* 1=is last block, 0=not last block */ | |
324 | xfs_btree_islastblock( | |
325 | xfs_btree_cur_t *cur, /* btree cursor */ | |
dfc130f3 | 326 | int level); /* level to check */ |
2bd0ea18 | 327 | |
2bd0ea18 NS |
328 | /* |
329 | * Compute first and last byte offsets for the fields given. | |
330 | * Interprets the offsets table, which contains struct field offsets. | |
331 | */ | |
332 | void | |
333 | xfs_btree_offsets( | |
4a492e72 | 334 | int64_t fields, /* bitmask of fields */ |
2bd0ea18 NS |
335 | const short *offsets,/* table of field offsets */ |
336 | int nbits, /* number of bits to inspect */ | |
dfc130f3 RC |
337 | int *first, /* output: first byte offset */ |
338 | int *last); /* output: last byte offset */ | |
2bd0ea18 NS |
339 | |
340 | /* | |
341 | * Get a buffer for the block, return it read in. | |
342 | * Long-form addressing. | |
343 | */ | |
344 | int /* error */ | |
345 | xfs_btree_read_bufl( | |
346 | struct xfs_mount *mp, /* file system mount point */ | |
347 | struct xfs_trans *tp, /* transaction pointer */ | |
348 | xfs_fsblock_t fsbno, /* file system block number */ | |
349 | uint lock, /* lock flags for read_buf */ | |
350 | struct xfs_buf **bpp, /* buffer for fsbno */ | |
a2ceac1f DC |
351 | int refval, /* ref count value for buffer */ |
352 | const struct xfs_buf_ops *ops); | |
2bd0ea18 | 353 | |
2bd0ea18 NS |
354 | /* |
355 | * Read-ahead the block, don't wait for it, don't return a buffer. | |
356 | * Long-form addressing. | |
357 | */ | |
358 | void /* error */ | |
359 | xfs_btree_reada_bufl( | |
360 | struct xfs_mount *mp, /* file system mount point */ | |
361 | xfs_fsblock_t fsbno, /* file system block number */ | |
a2ceac1f DC |
362 | xfs_extlen_t count, /* count of filesystem blocks */ |
363 | const struct xfs_buf_ops *ops); | |
2bd0ea18 NS |
364 | |
365 | /* | |
366 | * Read-ahead the block, don't wait for it, don't return a buffer. | |
367 | * Short-form addressing. | |
368 | */ | |
369 | void /* error */ | |
370 | xfs_btree_reada_bufs( | |
371 | struct xfs_mount *mp, /* file system mount point */ | |
372 | xfs_agnumber_t agno, /* allocation group number */ | |
373 | xfs_agblock_t agbno, /* allocation group block number */ | |
a2ceac1f DC |
374 | xfs_extlen_t count, /* count of filesystem blocks */ |
375 | const struct xfs_buf_ops *ops); | |
2bd0ea18 | 376 | |
a2ceac1f DC |
377 | /* |
378 | * Initialise a new btree block header | |
379 | */ | |
380 | void | |
381 | xfs_btree_init_block( | |
382 | struct xfs_mount *mp, | |
383 | struct xfs_buf *bp, | |
e394a4b1 | 384 | xfs_btnum_t btnum, |
a2ceac1f DC |
385 | __u16 level, |
386 | __u16 numrecs, | |
5dfa5cd2 | 387 | __u64 owner, |
a2ceac1f | 388 | unsigned int flags); |
60ca9704 | 389 | |
5dfa5cd2 DC |
390 | void |
391 | xfs_btree_init_block_int( | |
392 | struct xfs_mount *mp, | |
393 | struct xfs_btree_block *buf, | |
394 | xfs_daddr_t blkno, | |
e394a4b1 | 395 | xfs_btnum_t btnum, |
5dfa5cd2 DC |
396 | __u16 level, |
397 | __u16 numrecs, | |
398 | __u64 owner, | |
399 | unsigned int flags); | |
400 | ||
b194c7d8 BN |
401 | /* |
402 | * Common btree core entry points. | |
403 | */ | |
404 | int xfs_btree_increment(struct xfs_btree_cur *, int, int *); | |
405 | int xfs_btree_decrement(struct xfs_btree_cur *, int, int *); | |
406 | int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *); | |
407 | int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *); | |
408 | int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *); | |
b194c7d8 BN |
409 | int xfs_btree_insert(struct xfs_btree_cur *, int *); |
410 | int xfs_btree_delete(struct xfs_btree_cur *, int *); | |
411 | int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *); | |
4a492e72 | 412 | int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner, |
9c6ebc42 | 413 | struct list_head *buffer_list); |
60ca9704 | 414 | |
5dfa5cd2 DC |
415 | /* |
416 | * btree block CRC helpers | |
417 | */ | |
418 | void xfs_btree_lblock_calc_crc(struct xfs_buf *); | |
419 | bool xfs_btree_lblock_verify_crc(struct xfs_buf *); | |
420 | void xfs_btree_sblock_calc_crc(struct xfs_buf *); | |
421 | bool xfs_btree_sblock_verify_crc(struct xfs_buf *); | |
422 | ||
b194c7d8 BN |
423 | /* |
424 | * Internal btree helpers also used by xfs_bmap.c. | |
425 | */ | |
426 | void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int); | |
427 | void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int); | |
60ca9704 | 428 | |
2bd0ea18 | 429 | /* |
b194c7d8 | 430 | * Helpers. |
2bd0ea18 | 431 | */ |
b194c7d8 BN |
432 | static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block) |
433 | { | |
434 | return be16_to_cpu(block->bb_numrecs); | |
435 | } | |
436 | ||
437 | static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block, | |
4a492e72 | 438 | uint16_t numrecs) |
b194c7d8 BN |
439 | { |
440 | block->bb_numrecs = cpu_to_be16(numrecs); | |
441 | } | |
442 | ||
443 | static inline int xfs_btree_get_level(struct xfs_btree_block *block) | |
444 | { | |
445 | return be16_to_cpu(block->bb_level); | |
446 | } | |
2bd0ea18 | 447 | |
2bd0ea18 NS |
448 | |
449 | /* | |
450 | * Min and max functions for extlen, agblock, fileoff, and filblks types. | |
451 | */ | |
5e656dbb BN |
452 | #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) |
453 | #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) | |
454 | #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) | |
455 | #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) | |
456 | #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) | |
457 | #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) | |
458 | #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) | |
459 | #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) | |
f302e9e4 | 460 | |
bc01119d DW |
461 | xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp); |
462 | xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp, | |
463 | unsigned int max_recs); | |
464 | xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp, | |
465 | uint64_t owner); | |
466 | xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp, | |
467 | unsigned int max_recs); | |
fb75464f | 468 | |
1421de38 | 469 | uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len); |
5f728383 | 470 | unsigned long long xfs_btree_calc_size(uint *limits, unsigned long long len); |
dbca0167 | 471 | |
5d3b7fe1 DW |
472 | /* return codes */ |
473 | #define XFS_BTREE_QUERY_RANGE_CONTINUE 0 /* keep iterating */ | |
474 | #define XFS_BTREE_QUERY_RANGE_ABORT 1 /* stop iterating */ | |
475 | typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur, | |
476 | union xfs_btree_rec *rec, void *priv); | |
477 | ||
478 | int xfs_btree_query_range(struct xfs_btree_cur *cur, | |
479 | union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec, | |
480 | xfs_btree_query_range_fn fn, void *priv); | |
7e05e856 DW |
481 | int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn, |
482 | void *priv); | |
5d3b7fe1 | 483 | |
f31736bf DW |
484 | typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level, |
485 | void *data); | |
486 | int xfs_btree_visit_blocks(struct xfs_btree_cur *cur, | |
487 | xfs_btree_visit_blocks_fn fn, void *data); | |
488 | ||
2cccc8ce DW |
489 | int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks); |
490 | ||
50bb67d6 DW |
491 | union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n, |
492 | struct xfs_btree_block *block); | |
493 | union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n, | |
494 | struct xfs_btree_block *block); | |
495 | union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n, | |
496 | struct xfs_btree_block *block); | |
497 | union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n, | |
498 | struct xfs_btree_block *block); | |
499 | int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level, | |
500 | union xfs_btree_ptr *pp, struct xfs_btree_block **blkp); | |
501 | struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur, | |
502 | int level, struct xfs_buf **bpp); | |
15c4e6e4 DW |
503 | bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr); |
504 | int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur, | |
505 | const union xfs_btree_ptr *a, | |
506 | const union xfs_btree_ptr *b); | |
507 | void xfs_btree_get_sibling(struct xfs_btree_cur *cur, | |
508 | struct xfs_btree_block *block, | |
509 | union xfs_btree_ptr *ptr, int lr); | |
0ad12e7f DW |
510 | void xfs_btree_get_keys(struct xfs_btree_cur *cur, |
511 | struct xfs_btree_block *block, union xfs_btree_key *key); | |
512 | union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur, | |
513 | union xfs_btree_key *key); | |
1fe41a73 DW |
514 | int xfs_btree_has_record(struct xfs_btree_cur *cur, union xfs_btree_irec *low, |
515 | union xfs_btree_irec *high, bool *exists); | |
43e73fb0 | 516 | bool xfs_btree_has_more_records(struct xfs_btree_cur *cur); |
50bb67d6 | 517 | |
2bd0ea18 | 518 | #endif /* __XFS_BTREE_H__ */ |