]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - fs/xfs/xfs_btree.h
[XFS] implement generic xfs_btree_updkey
[mirror_ubuntu-bionic-kernel.git] / fs / xfs / 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_bmap_free;
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 * This nonsense is to make -wlint happy.
31 */
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)
35
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)
40
41 /*
42 * Short form header: space allocation btrees.
43 */
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 */
50 } xfs_btree_sblock_t;
51
52 /*
53 * Long form header: bmap btrees.
54 */
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 */
61 } xfs_btree_lblock_t;
62
63 /*
64 * Combined header and structure, used by common code.
65 */
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 */
70 union {
71 struct {
72 __be32 bb_leftsib;
73 __be32 bb_rightsib;
74 } s; /* short form pointers */
75 struct {
76 __be64 bb_leftsib;
77 __be64 bb_rightsib;
78 } l; /* long form pointers */
79 } bb_u; /* rest */
80 } xfs_btree_block_t;
81
82 /*
83 * Generic key, ptr and record wrapper structures.
84 *
85 * These are disk format structures, and are converted where necessary
86 * by the btree specific code that needs to interpret them.
87 */
88 union xfs_btree_ptr {
89 __be32 s; /* short form ptr */
90 __be64 l; /* long form ptr */
91 };
92
93 union xfs_btree_key {
94 xfs_bmbt_key_t bmbt;
95 xfs_bmdr_key_t bmbr; /* bmbt root block */
96 xfs_alloc_key_t alloc;
97 xfs_inobt_key_t inobt;
98 };
99
100 union xfs_btree_rec {
101 xfs_bmbt_rec_t bmbt;
102 xfs_bmdr_rec_t bmbr; /* bmbt root block */
103 xfs_alloc_rec_t alloc;
104 xfs_inobt_rec_t inobt;
105 };
106
107 /*
108 * For logging record fields.
109 */
110 #define XFS_BB_MAGIC 0x01
111 #define XFS_BB_LEVEL 0x02
112 #define XFS_BB_NUMRECS 0x04
113 #define XFS_BB_LEFTSIB 0x08
114 #define XFS_BB_RIGHTSIB 0x10
115 #define XFS_BB_NUM_BITS 5
116 #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
117
118 /*
119 * Magic numbers for btree blocks.
120 */
121 extern const __uint32_t xfs_magics[];
122
123 /*
124 * Generic stats interface
125 */
126 #define __XFS_BTREE_STATS_INC(type, stat) \
127 XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
128 #define XFS_BTREE_STATS_INC(cur, stat) \
129 do { \
130 switch (cur->bc_btnum) { \
131 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break; \
132 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break; \
133 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break; \
134 case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break; \
135 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
136 } \
137 } while (0)
138
139 #define __XFS_BTREE_STATS_ADD(type, stat, val) \
140 XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
141 #define XFS_BTREE_STATS_ADD(cur, stat, val) \
142 do { \
143 switch (cur->bc_btnum) { \
144 case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
145 case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
146 case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
147 case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
148 case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break; \
149 } \
150 } while (0)
151 /*
152 * Maximum and minimum records in a btree block.
153 * Given block size, type prefix, and leaf flag (0 or 1).
154 * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
155 * compiler warnings.
156 */
157 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) \
158 ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
159 (((lf) * (uint)sizeof(t ## _rec_t)) + \
160 ((1 - (lf)) * \
161 ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
162 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf) \
163 (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
164
165 /*
166 * Record, key, and pointer address calculation macros.
167 * Given block size, type prefix, block pointer, and index of requested entry
168 * (first entry numbered 1).
169 */
170 #define XFS_BTREE_REC_ADDR(t,bb,i) \
171 ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
172 ((i) - 1) * sizeof(t ## _rec_t)))
173 #define XFS_BTREE_KEY_ADDR(t,bb,i) \
174 ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
175 ((i) - 1) * sizeof(t ## _key_t)))
176 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr) \
177 ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
178 (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
179
180 #define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */
181
182 struct xfs_btree_ops {
183 /* size of the key and record structures */
184 size_t key_len;
185 size_t rec_len;
186
187 /* cursor operations */
188 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
189
190 /* records in block/level */
191 int (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
192
193 /* init values of btree structures */
194 void (*init_key_from_rec)(union xfs_btree_key *key,
195 union xfs_btree_rec *rec);
196 void (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
197 union xfs_btree_ptr *ptr);
198
199 /* difference between key value and cursor value */
200 __int64_t (*key_diff)(struct xfs_btree_cur *cur,
201 union xfs_btree_key *key);
202
203 /* btree tracing */
204 #ifdef XFS_BTREE_TRACE
205 void (*trace_enter)(struct xfs_btree_cur *, const char *,
206 char *, int, int, __psunsigned_t,
207 __psunsigned_t, __psunsigned_t,
208 __psunsigned_t, __psunsigned_t,
209 __psunsigned_t, __psunsigned_t,
210 __psunsigned_t, __psunsigned_t,
211 __psunsigned_t, __psunsigned_t);
212 void (*trace_cursor)(struct xfs_btree_cur *, __uint32_t *,
213 __uint64_t *, __uint64_t *);
214 void (*trace_key)(struct xfs_btree_cur *,
215 union xfs_btree_key *, __uint64_t *,
216 __uint64_t *);
217 void (*trace_record)(struct xfs_btree_cur *,
218 union xfs_btree_rec *, __uint64_t *,
219 __uint64_t *, __uint64_t *);
220 #endif
221 };
222
223 /*
224 * Btree cursor structure.
225 * This collects all information needed by the btree code in one place.
226 */
227 typedef struct xfs_btree_cur
228 {
229 struct xfs_trans *bc_tp; /* transaction we're in, if any */
230 struct xfs_mount *bc_mp; /* file system mount struct */
231 const struct xfs_btree_ops *bc_ops;
232 uint bc_flags; /* btree features - below */
233 union {
234 xfs_alloc_rec_incore_t a;
235 xfs_bmbt_irec_t b;
236 xfs_inobt_rec_incore_t i;
237 } bc_rec; /* current insert/search record value */
238 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */
239 int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */
240 __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */
241 #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */
242 #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */
243 __uint8_t bc_nlevels; /* number of levels in the tree */
244 __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */
245 xfs_btnum_t bc_btnum; /* identifies which btree type */
246 union {
247 struct { /* needed for BNO, CNT, INO */
248 struct xfs_buf *agbp; /* agf/agi buffer pointer */
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_bmap_free *flist; /* list to free after */
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
268
269 #define XFS_BTREE_NOERROR 0
270 #define XFS_BTREE_ERROR 1
271
272 /*
273 * Convert from buffer to btree block header.
274 */
275 #define XFS_BUF_TO_BLOCK(bp) ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
276 #define XFS_BUF_TO_LBLOCK(bp) ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
277 #define XFS_BUF_TO_SBLOCK(bp) ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
278
279
280 #ifdef __KERNEL__
281
282 /*
283 * Check that long form block header is ok.
284 */
285 int /* error (0 or EFSCORRUPTED) */
286 xfs_btree_check_lblock(
287 struct xfs_btree_cur *cur, /* btree cursor */
288 struct xfs_btree_lblock *block, /* btree long form block pointer */
289 int level, /* level of the btree block */
290 struct xfs_buf *bp); /* buffer containing block, if any */
291
292 /*
293 * Check that short form block header is ok.
294 */
295 int /* error (0 or EFSCORRUPTED) */
296 xfs_btree_check_sblock(
297 struct xfs_btree_cur *cur, /* btree cursor */
298 struct xfs_btree_sblock *block, /* btree short form block pointer */
299 int level, /* level of the btree block */
300 struct xfs_buf *bp); /* buffer containing block */
301
302 /*
303 * Check that block header is ok.
304 */
305 int
306 xfs_btree_check_block(
307 struct xfs_btree_cur *cur, /* btree cursor */
308 struct xfs_btree_block *block, /* generic btree block pointer */
309 int level, /* level of the btree block */
310 struct xfs_buf *bp); /* buffer containing block, if any */
311
312 /*
313 * Check that (long) pointer is ok.
314 */
315 int /* error (0 or EFSCORRUPTED) */
316 xfs_btree_check_lptr(
317 struct xfs_btree_cur *cur, /* btree cursor */
318 xfs_dfsbno_t ptr, /* btree block disk address */
319 int level); /* btree block level */
320
321 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
322 xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
323
324
325 /*
326 * Check that (short) pointer is ok.
327 */
328 int /* error (0 or EFSCORRUPTED) */
329 xfs_btree_check_sptr(
330 struct xfs_btree_cur *cur, /* btree cursor */
331 xfs_agblock_t ptr, /* btree block disk address */
332 int level); /* btree block level */
333
334 /*
335 * Check that (short) pointer is ok.
336 */
337 int /* error (0 or EFSCORRUPTED) */
338 xfs_btree_check_ptr(
339 struct xfs_btree_cur *cur, /* btree cursor */
340 union xfs_btree_ptr *ptr, /* btree block disk address */
341 int index, /* offset from ptr to check */
342 int level); /* btree block level */
343
344 #ifdef DEBUG
345
346 /*
347 * Debug routine: check that keys are in the right order.
348 */
349 void
350 xfs_btree_check_key(
351 xfs_btnum_t btnum, /* btree identifier */
352 void *ak1, /* pointer to left (lower) key */
353 void *ak2); /* pointer to right (higher) key */
354
355 /*
356 * Debug routine: check that records are in the right order.
357 */
358 void
359 xfs_btree_check_rec(
360 xfs_btnum_t btnum, /* btree identifier */
361 void *ar1, /* pointer to left (lower) record */
362 void *ar2); /* pointer to right (higher) record */
363 #else
364 #define xfs_btree_check_key(a, b, c)
365 #define xfs_btree_check_rec(a, b, c)
366 #endif /* DEBUG */
367
368 /*
369 * Delete the btree cursor.
370 */
371 void
372 xfs_btree_del_cursor(
373 xfs_btree_cur_t *cur, /* btree cursor */
374 int error); /* del because of error */
375
376 /*
377 * Duplicate the btree cursor.
378 * Allocate a new one, copy the record, re-get the buffers.
379 */
380 int /* error */
381 xfs_btree_dup_cursor(
382 xfs_btree_cur_t *cur, /* input cursor */
383 xfs_btree_cur_t **ncur);/* output cursor */
384
385 /*
386 * Change the cursor to point to the first record in the current block
387 * at the given level. Other levels are unaffected.
388 */
389 int /* success=1, failure=0 */
390 xfs_btree_firstrec(
391 xfs_btree_cur_t *cur, /* btree cursor */
392 int level); /* level to change */
393
394 /*
395 * Get a buffer for the block, return it with no data read.
396 * Long-form addressing.
397 */
398 struct xfs_buf * /* buffer for fsbno */
399 xfs_btree_get_bufl(
400 struct xfs_mount *mp, /* file system mount point */
401 struct xfs_trans *tp, /* transaction pointer */
402 xfs_fsblock_t fsbno, /* file system block number */
403 uint lock); /* lock flags for get_buf */
404
405 /*
406 * Get a buffer for the block, return it with no data read.
407 * Short-form addressing.
408 */
409 struct xfs_buf * /* buffer for agno/agbno */
410 xfs_btree_get_bufs(
411 struct xfs_mount *mp, /* file system mount point */
412 struct xfs_trans *tp, /* transaction pointer */
413 xfs_agnumber_t agno, /* allocation group number */
414 xfs_agblock_t agbno, /* allocation group block number */
415 uint lock); /* lock flags for get_buf */
416
417 /*
418 * Check for the cursor referring to the last block at the given level.
419 */
420 int /* 1=is last block, 0=not last block */
421 xfs_btree_islastblock(
422 xfs_btree_cur_t *cur, /* btree cursor */
423 int level); /* level to check */
424
425 /*
426 * Change the cursor to point to the last record in the current block
427 * at the given level. Other levels are unaffected.
428 */
429 int /* success=1, failure=0 */
430 xfs_btree_lastrec(
431 xfs_btree_cur_t *cur, /* btree cursor */
432 int level); /* level to change */
433
434 /*
435 * Compute first and last byte offsets for the fields given.
436 * Interprets the offsets table, which contains struct field offsets.
437 */
438 void
439 xfs_btree_offsets(
440 __int64_t fields, /* bitmask of fields */
441 const short *offsets,/* table of field offsets */
442 int nbits, /* number of bits to inspect */
443 int *first, /* output: first byte offset */
444 int *last); /* output: last byte offset */
445
446 /*
447 * Get a buffer for the block, return it read in.
448 * Long-form addressing.
449 */
450 int /* error */
451 xfs_btree_read_bufl(
452 struct xfs_mount *mp, /* file system mount point */
453 struct xfs_trans *tp, /* transaction pointer */
454 xfs_fsblock_t fsbno, /* file system block number */
455 uint lock, /* lock flags for read_buf */
456 struct xfs_buf **bpp, /* buffer for fsbno */
457 int refval);/* ref count value for buffer */
458
459 /*
460 * Get a buffer for the block, return it read in.
461 * Short-form addressing.
462 */
463 int /* error */
464 xfs_btree_read_bufs(
465 struct xfs_mount *mp, /* file system mount point */
466 struct xfs_trans *tp, /* transaction pointer */
467 xfs_agnumber_t agno, /* allocation group number */
468 xfs_agblock_t agbno, /* allocation group block number */
469 uint lock, /* lock flags for read_buf */
470 struct xfs_buf **bpp, /* buffer for agno/agbno */
471 int refval);/* ref count value for buffer */
472
473 /*
474 * Read-ahead the block, don't wait for it, don't return a buffer.
475 * Long-form addressing.
476 */
477 void /* error */
478 xfs_btree_reada_bufl(
479 struct xfs_mount *mp, /* file system mount point */
480 xfs_fsblock_t fsbno, /* file system block number */
481 xfs_extlen_t count); /* count of filesystem blocks */
482
483 /*
484 * Read-ahead the block, don't wait for it, don't return a buffer.
485 * Short-form addressing.
486 */
487 void /* error */
488 xfs_btree_reada_bufs(
489 struct xfs_mount *mp, /* file system mount point */
490 xfs_agnumber_t agno, /* allocation group number */
491 xfs_agblock_t agbno, /* allocation group block number */
492 xfs_extlen_t count); /* count of filesystem blocks */
493
494 /*
495 * Read-ahead btree blocks, at the given level.
496 * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
497 */
498 int /* readahead block count */
499 xfs_btree_readahead(
500 xfs_btree_cur_t *cur, /* btree cursor */
501 int lev, /* level in btree */
502 int lr); /* left/right bits */
503
504 /*
505 * Set the buffer for level "lev" in the cursor to bp, releasing
506 * any previous buffer.
507 */
508 void
509 xfs_btree_setbuf(
510 xfs_btree_cur_t *cur, /* btree cursor */
511 int lev, /* level in btree */
512 struct xfs_buf *bp); /* new buffer to set */
513
514
515 /*
516 * Common btree core entry points.
517 */
518 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
519 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
520 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
521 int xfs_btree_updkey(struct xfs_btree_cur *, union xfs_btree_key *, int);
522
523 /*
524 * Helpers.
525 */
526 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
527 {
528 return be16_to_cpu(block->bb_numrecs);
529 }
530
531 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
532 {
533 return be16_to_cpu(block->bb_level);
534 }
535
536 #endif /* __KERNEL__ */
537
538
539 /*
540 * Min and max functions for extlen, agblock, fileoff, and filblks types.
541 */
542 #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
543 #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
544 #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
545 #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
546 #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
547 #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
548 #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
549 #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
550
551 #define XFS_FSB_SANITY_CHECK(mp,fsb) \
552 (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
553 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
554
555 #endif /* __XFS_BTREE_H__ */