1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2014 Red Hat, Inc.
8 #include "xfs_shared.h"
9 #include "xfs_format.h"
10 #include "xfs_log_format.h"
11 #include "xfs_trans_resv.h"
12 #include "xfs_mount.h"
13 #include "xfs_trans.h"
14 #include "xfs_alloc.h"
15 #include "xfs_btree.h"
16 #include "xfs_btree_staging.h"
18 #include "xfs_rmap_btree.h"
19 #include "xfs_trace.h"
20 #include "xfs_error.h"
21 #include "xfs_extent_busy.h"
23 #include "xfs_ag_resv.h"
25 static struct kmem_cache *xfs_rmapbt_cur_cache;
30 * This is a per-ag tree used to track the owner(s) of a given extent. With
31 * reflink it is possible for there to be multiple owners, which is a departure
32 * from classic XFS. Owner records for data extents are inserted when the
33 * extent is mapped and removed when an extent is unmapped. Owner records for
34 * all other block types (i.e. metadata) are inserted when an extent is
35 * allocated and removed when an extent is freed. There can only be one owner
36 * of a metadata extent, usually an inode or some other metadata structure like
39 * The rmap btree is part of the free space management, so blocks for the tree
40 * are sourced from the agfl. Hence we need transaction reservation support for
41 * this tree so that the freelist is always large enough. This also impacts on
42 * the minimum space we need to leave free in the AG.
44 * The tree is ordered by [ag block, owner, offset]. This is a large key size,
45 * but it is the only way to enforce unique keys when a block can be owned by
46 * multiple files at any offset. There's no need to order/search by extent
47 * size for online updating/management of the tree. It is intended that most
48 * reverse lookups will be to find the owner(s) of a particular block, or to
49 * try to recover tree and file data from corrupt primary metadata.
52 static struct xfs_btree_cur *
53 xfs_rmapbt_dup_cursor(
54 struct xfs_btree_cur *cur)
56 return xfs_rmapbt_init_cursor(cur->bc_mp, cur->bc_tp,
57 cur->bc_ag.agbp, cur->bc_ag.pag);
62 struct xfs_btree_cur *cur,
63 const union xfs_btree_ptr *ptr,
66 struct xfs_buf *agbp = cur->bc_ag.agbp;
67 struct xfs_agf *agf = agbp->b_addr;
68 int btnum = cur->bc_btnum;
72 agf->agf_roots[btnum] = ptr->s;
73 be32_add_cpu(&agf->agf_levels[btnum], inc);
74 cur->bc_ag.pag->pagf_levels[btnum] += inc;
76 xfs_alloc_log_agf(cur->bc_tp, agbp, XFS_AGF_ROOTS | XFS_AGF_LEVELS);
80 xfs_rmapbt_alloc_block(
81 struct xfs_btree_cur *cur,
82 const union xfs_btree_ptr *start,
83 union xfs_btree_ptr *new,
86 struct xfs_buf *agbp = cur->bc_ag.agbp;
87 struct xfs_agf *agf = agbp->b_addr;
88 struct xfs_perag *pag = cur->bc_ag.pag;
92 /* Allocate the new block from the freelist. If we can't, give up. */
93 error = xfs_alloc_get_freelist(pag, cur->bc_tp, cur->bc_ag.agbp,
98 trace_xfs_rmapbt_alloc_block(cur->bc_mp, pag->pag_agno, bno, 1);
99 if (bno == NULLAGBLOCK) {
104 xfs_extent_busy_reuse(cur->bc_mp, pag, bno, 1, false);
106 new->s = cpu_to_be32(bno);
107 be32_add_cpu(&agf->agf_rmap_blocks, 1);
108 xfs_alloc_log_agf(cur->bc_tp, agbp, XFS_AGF_RMAP_BLOCKS);
110 xfs_ag_resv_rmapbt_alloc(cur->bc_mp, pag->pag_agno);
117 xfs_rmapbt_free_block(
118 struct xfs_btree_cur *cur,
121 struct xfs_buf *agbp = cur->bc_ag.agbp;
122 struct xfs_agf *agf = agbp->b_addr;
123 struct xfs_perag *pag = cur->bc_ag.pag;
127 bno = xfs_daddr_to_agbno(cur->bc_mp, xfs_buf_daddr(bp));
128 trace_xfs_rmapbt_free_block(cur->bc_mp, pag->pag_agno,
130 be32_add_cpu(&agf->agf_rmap_blocks, -1);
131 xfs_alloc_log_agf(cur->bc_tp, agbp, XFS_AGF_RMAP_BLOCKS);
132 error = xfs_alloc_put_freelist(pag, cur->bc_tp, agbp, NULL, bno, 1);
136 xfs_extent_busy_insert(cur->bc_tp, pag, bno, 1,
137 XFS_EXTENT_BUSY_SKIP_DISCARD);
139 xfs_ag_resv_free_extent(pag, XFS_AG_RESV_RMAPBT, NULL, 1);
144 xfs_rmapbt_get_minrecs(
145 struct xfs_btree_cur *cur,
148 return cur->bc_mp->m_rmap_mnr[level != 0];
152 xfs_rmapbt_get_maxrecs(
153 struct xfs_btree_cur *cur,
156 return cur->bc_mp->m_rmap_mxr[level != 0];
160 xfs_rmapbt_init_key_from_rec(
161 union xfs_btree_key *key,
162 const union xfs_btree_rec *rec)
164 key->rmap.rm_startblock = rec->rmap.rm_startblock;
165 key->rmap.rm_owner = rec->rmap.rm_owner;
166 key->rmap.rm_offset = rec->rmap.rm_offset;
170 * The high key for a reverse mapping record can be computed by shifting
171 * the startblock and offset to the highest value that would still map
172 * to that record. In practice this means that we add blockcount-1 to
173 * the startblock for all records, and if the record is for a data/attr
174 * fork mapping, we add blockcount-1 to the offset too.
177 xfs_rmapbt_init_high_key_from_rec(
178 union xfs_btree_key *key,
179 const union xfs_btree_rec *rec)
184 adj = be32_to_cpu(rec->rmap.rm_blockcount) - 1;
186 key->rmap.rm_startblock = rec->rmap.rm_startblock;
187 be32_add_cpu(&key->rmap.rm_startblock, adj);
188 key->rmap.rm_owner = rec->rmap.rm_owner;
189 key->rmap.rm_offset = rec->rmap.rm_offset;
190 if (XFS_RMAP_NON_INODE_OWNER(be64_to_cpu(rec->rmap.rm_owner)) ||
191 XFS_RMAP_IS_BMBT_BLOCK(be64_to_cpu(rec->rmap.rm_offset)))
193 off = be64_to_cpu(key->rmap.rm_offset);
194 off = (XFS_RMAP_OFF(off) + adj) | (off & ~XFS_RMAP_OFF_MASK);
195 key->rmap.rm_offset = cpu_to_be64(off);
199 xfs_rmapbt_init_rec_from_cur(
200 struct xfs_btree_cur *cur,
201 union xfs_btree_rec *rec)
203 rec->rmap.rm_startblock = cpu_to_be32(cur->bc_rec.r.rm_startblock);
204 rec->rmap.rm_blockcount = cpu_to_be32(cur->bc_rec.r.rm_blockcount);
205 rec->rmap.rm_owner = cpu_to_be64(cur->bc_rec.r.rm_owner);
206 rec->rmap.rm_offset = cpu_to_be64(
207 xfs_rmap_irec_offset_pack(&cur->bc_rec.r));
211 xfs_rmapbt_init_ptr_from_cur(
212 struct xfs_btree_cur *cur,
213 union xfs_btree_ptr *ptr)
215 struct xfs_agf *agf = cur->bc_ag.agbp->b_addr;
217 ASSERT(cur->bc_ag.pag->pag_agno == be32_to_cpu(agf->agf_seqno));
219 ptr->s = agf->agf_roots[cur->bc_btnum];
224 struct xfs_btree_cur *cur,
225 const union xfs_btree_key *key)
227 struct xfs_rmap_irec *rec = &cur->bc_rec.r;
228 const struct xfs_rmap_key *kp = &key->rmap;
232 d = (int64_t)be32_to_cpu(kp->rm_startblock) - rec->rm_startblock;
236 x = be64_to_cpu(kp->rm_owner);
243 x = XFS_RMAP_OFF(be64_to_cpu(kp->rm_offset));
253 xfs_rmapbt_diff_two_keys(
254 struct xfs_btree_cur *cur,
255 const union xfs_btree_key *k1,
256 const union xfs_btree_key *k2)
258 const struct xfs_rmap_key *kp1 = &k1->rmap;
259 const struct xfs_rmap_key *kp2 = &k2->rmap;
263 d = (int64_t)be32_to_cpu(kp1->rm_startblock) -
264 be32_to_cpu(kp2->rm_startblock);
268 x = be64_to_cpu(kp1->rm_owner);
269 y = be64_to_cpu(kp2->rm_owner);
275 x = XFS_RMAP_OFF(be64_to_cpu(kp1->rm_offset));
276 y = XFS_RMAP_OFF(be64_to_cpu(kp2->rm_offset));
284 static xfs_failaddr_t
288 struct xfs_mount *mp = bp->b_mount;
289 struct xfs_btree_block *block = XFS_BUF_TO_BLOCK(bp);
290 struct xfs_perag *pag = bp->b_pag;
295 * magic number and level verification
297 * During growfs operations, we can't verify the exact level or owner as
298 * the perag is not fully initialised and hence not attached to the
299 * buffer. In this case, check against the maximum tree depth.
301 * Similarly, during log recovery we will have a perag structure
302 * attached, but the agf information will not yet have been initialised
303 * from the on disk AGF. Again, we can only check against maximum limits
306 if (!xfs_verify_magic(bp, block->bb_magic))
307 return __this_address;
309 if (!xfs_has_rmapbt(mp))
310 return __this_address;
311 fa = xfs_btree_sblock_v5hdr_verify(bp);
315 level = be16_to_cpu(block->bb_level);
316 if (pag && pag->pagf_init) {
317 if (level >= pag->pagf_levels[XFS_BTNUM_RMAPi])
318 return __this_address;
319 } else if (level >= mp->m_rmap_maxlevels)
320 return __this_address;
322 return xfs_btree_sblock_verify(bp, mp->m_rmap_mxr[level != 0]);
326 xfs_rmapbt_read_verify(
331 if (!xfs_btree_sblock_verify_crc(bp))
332 xfs_verifier_error(bp, -EFSBADCRC, __this_address);
334 fa = xfs_rmapbt_verify(bp);
336 xfs_verifier_error(bp, -EFSCORRUPTED, fa);
340 trace_xfs_btree_corrupt(bp, _RET_IP_);
344 xfs_rmapbt_write_verify(
349 fa = xfs_rmapbt_verify(bp);
351 trace_xfs_btree_corrupt(bp, _RET_IP_);
352 xfs_verifier_error(bp, -EFSCORRUPTED, fa);
355 xfs_btree_sblock_calc_crc(bp);
359 const struct xfs_buf_ops xfs_rmapbt_buf_ops = {
360 .name = "xfs_rmapbt",
361 .magic = { 0, cpu_to_be32(XFS_RMAP_CRC_MAGIC) },
362 .verify_read = xfs_rmapbt_read_verify,
363 .verify_write = xfs_rmapbt_write_verify,
364 .verify_struct = xfs_rmapbt_verify,
368 xfs_rmapbt_keys_inorder(
369 struct xfs_btree_cur *cur,
370 const union xfs_btree_key *k1,
371 const union xfs_btree_key *k2)
378 x = be32_to_cpu(k1->rmap.rm_startblock);
379 y = be32_to_cpu(k2->rmap.rm_startblock);
384 a = be64_to_cpu(k1->rmap.rm_owner);
385 b = be64_to_cpu(k2->rmap.rm_owner);
390 a = XFS_RMAP_OFF(be64_to_cpu(k1->rmap.rm_offset));
391 b = XFS_RMAP_OFF(be64_to_cpu(k2->rmap.rm_offset));
398 xfs_rmapbt_recs_inorder(
399 struct xfs_btree_cur *cur,
400 const union xfs_btree_rec *r1,
401 const union xfs_btree_rec *r2)
408 x = be32_to_cpu(r1->rmap.rm_startblock);
409 y = be32_to_cpu(r2->rmap.rm_startblock);
414 a = be64_to_cpu(r1->rmap.rm_owner);
415 b = be64_to_cpu(r2->rmap.rm_owner);
420 a = XFS_RMAP_OFF(be64_to_cpu(r1->rmap.rm_offset));
421 b = XFS_RMAP_OFF(be64_to_cpu(r2->rmap.rm_offset));
427 static const struct xfs_btree_ops xfs_rmapbt_ops = {
428 .rec_len = sizeof(struct xfs_rmap_rec),
429 .key_len = 2 * sizeof(struct xfs_rmap_key),
431 .dup_cursor = xfs_rmapbt_dup_cursor,
432 .set_root = xfs_rmapbt_set_root,
433 .alloc_block = xfs_rmapbt_alloc_block,
434 .free_block = xfs_rmapbt_free_block,
435 .get_minrecs = xfs_rmapbt_get_minrecs,
436 .get_maxrecs = xfs_rmapbt_get_maxrecs,
437 .init_key_from_rec = xfs_rmapbt_init_key_from_rec,
438 .init_high_key_from_rec = xfs_rmapbt_init_high_key_from_rec,
439 .init_rec_from_cur = xfs_rmapbt_init_rec_from_cur,
440 .init_ptr_from_cur = xfs_rmapbt_init_ptr_from_cur,
441 .key_diff = xfs_rmapbt_key_diff,
442 .buf_ops = &xfs_rmapbt_buf_ops,
443 .diff_two_keys = xfs_rmapbt_diff_two_keys,
444 .keys_inorder = xfs_rmapbt_keys_inorder,
445 .recs_inorder = xfs_rmapbt_recs_inorder,
448 static struct xfs_btree_cur *
449 xfs_rmapbt_init_common(
450 struct xfs_mount *mp,
451 struct xfs_trans *tp,
452 struct xfs_perag *pag)
454 struct xfs_btree_cur *cur;
456 /* Overlapping btree; 2 keys per pointer. */
457 cur = xfs_btree_alloc_cursor(mp, tp, XFS_BTNUM_RMAP,
458 mp->m_rmap_maxlevels, xfs_rmapbt_cur_cache);
459 cur->bc_flags = XFS_BTREE_CRC_BLOCKS | XFS_BTREE_OVERLAPPING;
460 cur->bc_statoff = XFS_STATS_CALC_INDEX(xs_rmap_2);
461 cur->bc_ops = &xfs_rmapbt_ops;
463 /* take a reference for the cursor */
464 atomic_inc(&pag->pag_ref);
465 cur->bc_ag.pag = pag;
470 /* Create a new reverse mapping btree cursor. */
471 struct xfs_btree_cur *
472 xfs_rmapbt_init_cursor(
473 struct xfs_mount *mp,
474 struct xfs_trans *tp,
475 struct xfs_buf *agbp,
476 struct xfs_perag *pag)
478 struct xfs_agf *agf = agbp->b_addr;
479 struct xfs_btree_cur *cur;
481 cur = xfs_rmapbt_init_common(mp, tp, pag);
482 cur->bc_nlevels = be32_to_cpu(agf->agf_levels[XFS_BTNUM_RMAP]);
483 cur->bc_ag.agbp = agbp;
487 /* Create a new reverse mapping btree cursor with a fake root for staging. */
488 struct xfs_btree_cur *
489 xfs_rmapbt_stage_cursor(
490 struct xfs_mount *mp,
491 struct xbtree_afakeroot *afake,
492 struct xfs_perag *pag)
494 struct xfs_btree_cur *cur;
496 cur = xfs_rmapbt_init_common(mp, NULL, pag);
497 xfs_btree_stage_afakeroot(cur, afake);
502 * Install a new reverse mapping btree root. Caller is responsible for
503 * invalidating and freeing the old btree blocks.
506 xfs_rmapbt_commit_staged_btree(
507 struct xfs_btree_cur *cur,
508 struct xfs_trans *tp,
509 struct xfs_buf *agbp)
511 struct xfs_agf *agf = agbp->b_addr;
512 struct xbtree_afakeroot *afake = cur->bc_ag.afake;
514 ASSERT(cur->bc_flags & XFS_BTREE_STAGING);
516 agf->agf_roots[cur->bc_btnum] = cpu_to_be32(afake->af_root);
517 agf->agf_levels[cur->bc_btnum] = cpu_to_be32(afake->af_levels);
518 agf->agf_rmap_blocks = cpu_to_be32(afake->af_blocks);
519 xfs_alloc_log_agf(tp, agbp, XFS_AGF_ROOTS | XFS_AGF_LEVELS |
520 XFS_AGF_RMAP_BLOCKS);
521 xfs_btree_commit_afakeroot(cur, tp, agbp, &xfs_rmapbt_ops);
524 /* Calculate number of records in a reverse mapping btree block. */
525 static inline unsigned int
526 xfs_rmapbt_block_maxrecs(
527 unsigned int blocklen,
531 return blocklen / sizeof(struct xfs_rmap_rec);
533 (2 * sizeof(struct xfs_rmap_key) + sizeof(xfs_rmap_ptr_t));
537 * Calculate number of records in an rmap btree block.
544 blocklen -= XFS_RMAP_BLOCK_LEN;
545 return xfs_rmapbt_block_maxrecs(blocklen, leaf);
548 /* Compute the max possible height for reverse mapping btrees. */
550 xfs_rmapbt_maxlevels_ondisk(void)
552 unsigned int minrecs[2];
553 unsigned int blocklen;
555 blocklen = XFS_MIN_CRC_BLOCKSIZE - XFS_BTREE_SBLOCK_CRC_LEN;
557 minrecs[0] = xfs_rmapbt_block_maxrecs(blocklen, true) / 2;
558 minrecs[1] = xfs_rmapbt_block_maxrecs(blocklen, false) / 2;
561 * Compute the asymptotic maxlevels for an rmapbt on any reflink fs.
563 * On a reflink filesystem, each AG block can have up to 2^32 (per the
564 * refcount record format) owners, which means that theoretically we
565 * could face up to 2^64 rmap records. However, we're likely to run
566 * out of blocks in the AG long before that happens, which means that
567 * we must compute the max height based on what the btree will look
568 * like if it consumes almost all the blocks in the AG due to maximal
571 return xfs_btree_space_to_height(minrecs, XFS_MAX_CRC_AG_BLOCKS);
574 /* Compute the maximum height of an rmap btree. */
576 xfs_rmapbt_compute_maxlevels(
577 struct xfs_mount *mp)
579 if (!xfs_has_rmapbt(mp)) {
580 mp->m_rmap_maxlevels = 0;
584 if (xfs_has_reflink(mp)) {
586 * Compute the asymptotic maxlevels for an rmap btree on a
587 * filesystem that supports reflink.
589 * On a reflink filesystem, each AG block can have up to 2^32
590 * (per the refcount record format) owners, which means that
591 * theoretically we could face up to 2^64 rmap records.
592 * However, we're likely to run out of blocks in the AG long
593 * before that happens, which means that we must compute the
594 * max height based on what the btree will look like if it
595 * consumes almost all the blocks in the AG due to maximal
598 mp->m_rmap_maxlevels = xfs_btree_space_to_height(mp->m_rmap_mnr,
599 mp->m_sb.sb_agblocks);
602 * If there's no block sharing, compute the maximum rmapbt
603 * height assuming one rmap record per AG block.
605 mp->m_rmap_maxlevels = xfs_btree_compute_maxlevels(
606 mp->m_rmap_mnr, mp->m_sb.sb_agblocks);
608 ASSERT(mp->m_rmap_maxlevels <= xfs_rmapbt_maxlevels_ondisk());
611 /* Calculate the refcount btree size for some records. */
613 xfs_rmapbt_calc_size(
614 struct xfs_mount *mp,
615 unsigned long long len)
617 return xfs_btree_calc_size(mp->m_rmap_mnr, len);
621 * Calculate the maximum refcount btree size.
625 struct xfs_mount *mp,
626 xfs_agblock_t agblocks)
628 /* Bail out if we're uninitialized, which can happen in mkfs. */
629 if (mp->m_rmap_mxr[0] == 0)
632 return xfs_rmapbt_calc_size(mp, agblocks);
636 * Figure out how many blocks to reserve and how many are used by this btree.
639 xfs_rmapbt_calc_reserves(
640 struct xfs_mount *mp,
641 struct xfs_trans *tp,
642 struct xfs_perag *pag,
646 struct xfs_buf *agbp;
648 xfs_agblock_t agblocks;
649 xfs_extlen_t tree_len;
652 if (!xfs_has_rmapbt(mp))
655 error = xfs_alloc_read_agf(pag, tp, 0, &agbp);
660 agblocks = be32_to_cpu(agf->agf_length);
661 tree_len = be32_to_cpu(agf->agf_rmap_blocks);
662 xfs_trans_brelse(tp, agbp);
665 * The log is permanently allocated, so the space it occupies will
666 * never be available for the kinds of things that would require btree
667 * expansion. We therefore can pretend the space isn't there.
669 if (xfs_ag_contains_log(mp, pag->pag_agno))
670 agblocks -= mp->m_sb.sb_logblocks;
672 /* Reserve 1% of the AG or enough for 1 block per record. */
673 *ask += max(agblocks / 100, xfs_rmapbt_max_size(mp, agblocks));
680 xfs_rmapbt_init_cur_cache(void)
682 xfs_rmapbt_cur_cache = kmem_cache_create("xfs_rmapbt_cur",
683 xfs_btree_cur_sizeof(xfs_rmapbt_maxlevels_ondisk()),
686 if (!xfs_rmapbt_cur_cache)
692 xfs_rmapbt_destroy_cur_cache(void)
694 kmem_cache_destroy(xfs_rmapbt_cur_cache);
695 xfs_rmapbt_cur_cache = NULL;