2 * Copyright (C) 2017 Oracle. All Rights Reserved.
4 * Author: Darrick J. Wong <darrick.wong@oracle.com>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it would be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
22 #include "xfs_shared.h"
23 #include "xfs_format.h"
24 #include "xfs_trans_resv.h"
25 #include "xfs_mount.h"
26 #include "xfs_defer.h"
27 #include "xfs_btree.h"
29 #include "xfs_log_format.h"
30 #include "xfs_trans.h"
32 #include "xfs_inode.h"
33 #include "xfs_inode_fork.h"
34 #include "xfs_da_format.h"
35 #include "xfs_da_btree.h"
37 #include "xfs_dir2_priv.h"
38 #include "xfs_attr_leaf.h"
39 #include "scrub/xfs_scrub.h"
40 #include "scrub/scrub.h"
41 #include "scrub/common.h"
42 #include "scrub/trace.h"
43 #include "scrub/dabtree.h"
45 /* Directory/Attribute Btree */
48 * Check for da btree operation errors. See the section about handling
49 * operational errors in common.c.
52 xfs_scrub_da_process_error(
53 struct xfs_scrub_da_btree *ds,
57 struct xfs_scrub_context *sc = ds->sc;
64 /* Used to restart an op with deadlock avoidance. */
65 trace_xfs_scrub_deadlock_retry(sc->ip, sc->sm, *error);
69 /* Note the badness but don't abort. */
70 sc->sm->sm_flags |= XFS_SCRUB_OFLAG_CORRUPT;
74 trace_xfs_scrub_file_op_error(sc, ds->dargs.whichfork,
75 xfs_dir2_da_to_db(ds->dargs.geo,
76 ds->state->path.blk[level].blkno),
77 *error, __return_address);
84 * Check for da btree corruption. See the section about handling
85 * operational errors in common.c.
88 xfs_scrub_da_set_corrupt(
89 struct xfs_scrub_da_btree *ds,
92 struct xfs_scrub_context *sc = ds->sc;
94 sc->sm->sm_flags |= XFS_SCRUB_OFLAG_CORRUPT;
96 trace_xfs_scrub_fblock_error(sc, ds->dargs.whichfork,
97 xfs_dir2_da_to_db(ds->dargs.geo,
98 ds->state->path.blk[level].blkno),
102 /* Find an entry at a certain level in a da btree. */
104 xfs_scrub_da_btree_entry(
105 struct xfs_scrub_da_btree *ds,
110 struct xfs_da_state_blk *blk;
113 /* Dispatch the entry finding function. */
114 blk = &ds->state->path.blk[level];
115 baddr = blk->bp->b_addr;
116 switch (blk->magic) {
117 case XFS_ATTR_LEAF_MAGIC:
118 case XFS_ATTR3_LEAF_MAGIC:
119 ents = (char *)xfs_attr3_leaf_entryp(baddr);
120 return ents + (rec * sizeof(struct xfs_attr_leaf_entry));
121 case XFS_DIR2_LEAFN_MAGIC:
122 case XFS_DIR3_LEAFN_MAGIC:
123 ents = (char *)ds->dargs.dp->d_ops->leaf_ents_p(baddr);
124 return ents + (rec * sizeof(struct xfs_dir2_leaf_entry));
125 case XFS_DIR2_LEAF1_MAGIC:
126 case XFS_DIR3_LEAF1_MAGIC:
127 ents = (char *)ds->dargs.dp->d_ops->leaf_ents_p(baddr);
128 return ents + (rec * sizeof(struct xfs_dir2_leaf_entry));
129 case XFS_DA_NODE_MAGIC:
130 case XFS_DA3_NODE_MAGIC:
131 ents = (char *)ds->dargs.dp->d_ops->node_tree_p(baddr);
132 return ents + (rec * sizeof(struct xfs_da_node_entry));
138 /* Scrub a da btree hash (key). */
140 xfs_scrub_da_btree_hash(
141 struct xfs_scrub_da_btree *ds,
145 struct xfs_da_state_blk *blks;
146 struct xfs_da_node_entry *entry;
148 xfs_dahash_t parent_hash;
150 /* Is this hash in order? */
151 hash = be32_to_cpu(*hashp);
152 if (hash < ds->hashes[level])
153 xfs_scrub_da_set_corrupt(ds, level);
154 ds->hashes[level] = hash;
159 /* Is this hash no larger than the parent hash? */
160 blks = ds->state->path.blk;
161 entry = xfs_scrub_da_btree_entry(ds, level - 1, blks[level - 1].index);
162 parent_hash = be32_to_cpu(entry->hashval);
163 if (parent_hash < hash)
164 xfs_scrub_da_set_corrupt(ds, level);
170 * Check a da btree pointer. Returns true if it's ok to use this
174 xfs_scrub_da_btree_ptr_ok(
175 struct xfs_scrub_da_btree *ds,
179 if (blkno < ds->lowest || (ds->highest != 0 && blkno >= ds->highest)) {
180 xfs_scrub_da_set_corrupt(ds, level);
188 * The da btree scrubber can handle leaf1 blocks as a degenerate
189 * form of leafn blocks. Since the regular da code doesn't handle
190 * leaf1, we must multiplex the verifiers.
193 xfs_scrub_da_btree_read_verify(
196 struct xfs_da_blkinfo *info = bp->b_addr;
198 switch (be16_to_cpu(info->magic)) {
199 case XFS_DIR2_LEAF1_MAGIC:
200 case XFS_DIR3_LEAF1_MAGIC:
201 bp->b_ops = &xfs_dir3_leaf1_buf_ops;
202 bp->b_ops->verify_read(bp);
206 * xfs_da3_node_buf_ops already know how to handle
207 * DA*_NODE, ATTR*_LEAF, and DIR*_LEAFN blocks.
209 bp->b_ops = &xfs_da3_node_buf_ops;
210 bp->b_ops->verify_read(bp);
215 xfs_scrub_da_btree_write_verify(
218 struct xfs_da_blkinfo *info = bp->b_addr;
220 switch (be16_to_cpu(info->magic)) {
221 case XFS_DIR2_LEAF1_MAGIC:
222 case XFS_DIR3_LEAF1_MAGIC:
223 bp->b_ops = &xfs_dir3_leaf1_buf_ops;
224 bp->b_ops->verify_write(bp);
228 * xfs_da3_node_buf_ops already know how to handle
229 * DA*_NODE, ATTR*_LEAF, and DIR*_LEAFN blocks.
231 bp->b_ops = &xfs_da3_node_buf_ops;
232 bp->b_ops->verify_write(bp);
237 xfs_scrub_da_btree_verify(
240 struct xfs_da_blkinfo *info = bp->b_addr;
242 switch (be16_to_cpu(info->magic)) {
243 case XFS_DIR2_LEAF1_MAGIC:
244 case XFS_DIR3_LEAF1_MAGIC:
245 bp->b_ops = &xfs_dir3_leaf1_buf_ops;
246 return bp->b_ops->verify_struct(bp);
248 bp->b_ops = &xfs_da3_node_buf_ops;
249 return bp->b_ops->verify_struct(bp);
253 static const struct xfs_buf_ops xfs_scrub_da_btree_buf_ops = {
254 .name = "xfs_scrub_da_btree",
255 .verify_read = xfs_scrub_da_btree_read_verify,
256 .verify_write = xfs_scrub_da_btree_write_verify,
257 .verify_struct = xfs_scrub_da_btree_verify,
260 /* Check a block's sibling. */
262 xfs_scrub_da_btree_block_check_sibling(
263 struct xfs_scrub_da_btree *ds,
271 memcpy(&ds->state->altpath, &ds->state->path,
272 sizeof(ds->state->altpath));
275 * If the pointer is null, we shouldn't be able to move the upper
276 * level pointer anywhere.
279 error = xfs_da3_path_shift(ds->state, &ds->state->altpath,
280 direction, false, &retval);
281 if (error == 0 && retval == 0)
282 xfs_scrub_da_set_corrupt(ds, level);
287 /* Move the alternate cursor one block in the direction given. */
288 error = xfs_da3_path_shift(ds->state, &ds->state->altpath,
289 direction, false, &retval);
290 if (!xfs_scrub_da_process_error(ds, level, &error))
293 xfs_scrub_da_set_corrupt(ds, level);
296 if (ds->state->altpath.blk[level].bp)
297 xfs_scrub_buffer_recheck(ds->sc,
298 ds->state->altpath.blk[level].bp);
300 /* Compare upper level pointer to sibling pointer. */
301 if (ds->state->altpath.blk[level].blkno != sibling)
302 xfs_scrub_da_set_corrupt(ds, level);
303 xfs_trans_brelse(ds->dargs.trans, ds->state->altpath.blk[level].bp);
308 /* Check a block's sibling pointers. */
310 xfs_scrub_da_btree_block_check_siblings(
311 struct xfs_scrub_da_btree *ds,
313 struct xfs_da_blkinfo *hdr)
319 forw = be32_to_cpu(hdr->forw);
320 back = be32_to_cpu(hdr->back);
322 /* Top level blocks should not have sibling pointers. */
324 if (forw != 0 || back != 0)
325 xfs_scrub_da_set_corrupt(ds, level);
330 * Check back (left) and forw (right) pointers. These functions
331 * absorb error codes for us.
333 error = xfs_scrub_da_btree_block_check_sibling(ds, level, 0, back);
336 error = xfs_scrub_da_btree_block_check_sibling(ds, level, 1, forw);
339 memset(&ds->state->altpath, 0, sizeof(ds->state->altpath));
343 /* Load a dir/attribute block from a btree. */
345 xfs_scrub_da_btree_block(
346 struct xfs_scrub_da_btree *ds,
350 struct xfs_da_state_blk *blk;
351 struct xfs_da_intnode *node;
352 struct xfs_da_node_entry *btree;
353 struct xfs_da3_blkinfo *hdr3;
354 struct xfs_da_args *dargs = &ds->dargs;
355 struct xfs_inode *ip = ds->dargs.dp;
358 struct xfs_da3_icnode_hdr nodehdr;
361 blk = &ds->state->path.blk[level];
362 ds->state->path.active = level + 1;
364 /* Release old block. */
366 xfs_trans_brelse(dargs->trans, blk->bp);
370 /* Check the pointer. */
372 if (!xfs_scrub_da_btree_ptr_ok(ds, level, blkno))
375 /* Read the buffer. */
376 error = xfs_da_read_buf(dargs->trans, dargs->dp, blk->blkno, -2,
377 &blk->bp, dargs->whichfork,
378 &xfs_scrub_da_btree_buf_ops);
379 if (!xfs_scrub_da_process_error(ds, level, &error))
382 xfs_scrub_buffer_recheck(ds->sc, blk->bp);
385 * We didn't find a dir btree root block, which means that
386 * there's no LEAF1/LEAFN tree (at least not where it's supposed
387 * to be), so jump out now.
389 if (ds->dargs.whichfork == XFS_DATA_FORK && level == 0 &&
393 /* It's /not/ ok for attr trees not to have a da btree. */
394 if (blk->bp == NULL) {
395 xfs_scrub_da_set_corrupt(ds, level);
399 hdr3 = blk->bp->b_addr;
400 blk->magic = be16_to_cpu(hdr3->hdr.magic);
401 pmaxrecs = &ds->maxrecs[level];
403 /* We only started zeroing the header on v5 filesystems. */
404 if (xfs_sb_version_hascrc(&ds->sc->mp->m_sb) && hdr3->hdr.pad)
405 xfs_scrub_da_set_corrupt(ds, level);
407 /* Check the owner. */
408 if (xfs_sb_version_hascrc(&ip->i_mount->m_sb)) {
409 owner = be64_to_cpu(hdr3->owner);
410 if (owner != ip->i_ino)
411 xfs_scrub_da_set_corrupt(ds, level);
414 /* Check the siblings. */
415 error = xfs_scrub_da_btree_block_check_siblings(ds, level, &hdr3->hdr);
419 /* Interpret the buffer. */
420 switch (blk->magic) {
421 case XFS_ATTR_LEAF_MAGIC:
422 case XFS_ATTR3_LEAF_MAGIC:
423 xfs_trans_buf_set_type(dargs->trans, blk->bp,
424 XFS_BLFT_ATTR_LEAF_BUF);
425 blk->magic = XFS_ATTR_LEAF_MAGIC;
426 blk->hashval = xfs_attr_leaf_lasthash(blk->bp, pmaxrecs);
427 if (ds->tree_level != 0)
428 xfs_scrub_da_set_corrupt(ds, level);
430 case XFS_DIR2_LEAFN_MAGIC:
431 case XFS_DIR3_LEAFN_MAGIC:
432 xfs_trans_buf_set_type(dargs->trans, blk->bp,
433 XFS_BLFT_DIR_LEAFN_BUF);
434 blk->magic = XFS_DIR2_LEAFN_MAGIC;
435 blk->hashval = xfs_dir2_leaf_lasthash(ip, blk->bp, pmaxrecs);
436 if (ds->tree_level != 0)
437 xfs_scrub_da_set_corrupt(ds, level);
439 case XFS_DIR2_LEAF1_MAGIC:
440 case XFS_DIR3_LEAF1_MAGIC:
441 xfs_trans_buf_set_type(dargs->trans, blk->bp,
442 XFS_BLFT_DIR_LEAF1_BUF);
443 blk->magic = XFS_DIR2_LEAF1_MAGIC;
444 blk->hashval = xfs_dir2_leaf_lasthash(ip, blk->bp, pmaxrecs);
445 if (ds->tree_level != 0)
446 xfs_scrub_da_set_corrupt(ds, level);
448 case XFS_DA_NODE_MAGIC:
449 case XFS_DA3_NODE_MAGIC:
450 xfs_trans_buf_set_type(dargs->trans, blk->bp,
451 XFS_BLFT_DA_NODE_BUF);
452 blk->magic = XFS_DA_NODE_MAGIC;
453 node = blk->bp->b_addr;
454 ip->d_ops->node_hdr_from_disk(&nodehdr, node);
455 btree = ip->d_ops->node_tree_p(node);
456 *pmaxrecs = nodehdr.count;
457 blk->hashval = be32_to_cpu(btree[*pmaxrecs - 1].hashval);
459 if (nodehdr.level >= XFS_DA_NODE_MAXDEPTH) {
460 xfs_scrub_da_set_corrupt(ds, level);
463 ds->tree_level = nodehdr.level;
465 if (ds->tree_level != nodehdr.level) {
466 xfs_scrub_da_set_corrupt(ds, level);
471 /* XXX: Check hdr3.pad32 once we know how to fix it. */
474 xfs_scrub_da_set_corrupt(ds, level);
481 xfs_trans_brelse(dargs->trans, blk->bp);
488 /* Visit all nodes and leaves of a da btree. */
491 struct xfs_scrub_context *sc,
493 xfs_scrub_da_btree_rec_fn scrub_fn,
496 struct xfs_scrub_da_btree ds = {};
497 struct xfs_mount *mp = sc->mp;
498 struct xfs_da_state_blk *blks;
499 struct xfs_da_node_entry *key;
505 /* Skip short format data structures; no btree to scan. */
506 if (XFS_IFORK_FORMAT(sc->ip, whichfork) != XFS_DINODE_FMT_EXTENTS &&
507 XFS_IFORK_FORMAT(sc->ip, whichfork) != XFS_DINODE_FMT_BTREE)
510 /* Set up initial da state. */
511 ds.dargs.dp = sc->ip;
512 ds.dargs.whichfork = whichfork;
513 ds.dargs.trans = sc->tp;
514 ds.dargs.op_flags = XFS_DA_OP_OKNOENT;
515 ds.state = xfs_da_state_alloc();
516 ds.state->args = &ds.dargs;
519 ds.private = private;
520 if (whichfork == XFS_ATTR_FORK) {
521 ds.dargs.geo = mp->m_attr_geo;
525 ds.dargs.geo = mp->m_dir_geo;
526 ds.lowest = ds.dargs.geo->leafblk;
527 ds.highest = ds.dargs.geo->freeblk;
532 /* Find the root of the da tree, if present. */
533 blks = ds.state->path.blk;
534 error = xfs_scrub_da_btree_block(&ds, level, blkno);
538 * We didn't find a block at ds.lowest, which means that there's
539 * no LEAF1/LEAFN tree (at least not where it's supposed to be),
542 if (blks[level].bp == NULL)
545 blks[level].index = 0;
546 while (level >= 0 && level < XFS_DA_NODE_MAXDEPTH) {
547 /* Handle leaf block. */
548 if (blks[level].magic != XFS_DA_NODE_MAGIC) {
549 /* End of leaf, pop back towards the root. */
550 if (blks[level].index >= ds.maxrecs[level]) {
552 blks[level - 1].index++;
558 /* Dispatch record scrubbing. */
559 rec = xfs_scrub_da_btree_entry(&ds, level,
561 error = scrub_fn(&ds, level, rec);
564 if (xfs_scrub_should_terminate(sc, &error) ||
565 (sc->sm->sm_flags & XFS_SCRUB_OFLAG_CORRUPT))
573 /* End of node, pop back towards the root. */
574 if (blks[level].index >= ds.maxrecs[level]) {
576 blks[level - 1].index++;
582 /* Hashes in order for scrub? */
583 key = xfs_scrub_da_btree_entry(&ds, level, blks[level].index);
584 error = xfs_scrub_da_btree_hash(&ds, level, &key->hashval);
588 /* Drill another level deeper. */
589 blkno = be32_to_cpu(key->before);
592 error = xfs_scrub_da_btree_block(&ds, level, blkno);
595 if (blks[level].bp == NULL)
598 blks[level].index = 0;
602 /* Release all the buffers we're tracking. */
603 for (level = 0; level < XFS_DA_NODE_MAXDEPTH; level++) {
604 if (blks[level].bp == NULL)
606 xfs_trans_brelse(sc->tp, blks[level].bp);
607 blks[level].bp = NULL;
611 xfs_da_state_free(ds.state);