zpool status -vv prints error ranges #9781

tonyhutter · 2019-12-28T00:29:07Z

Motivation and Context

Print out the byte ranges of corruption in damaged files

Description

Add a -vv option to zpool status to print all error'd out block ranges:

$ zpool status -vv
...
    NAME        STATE     READ WRITE CKSUM
    testpool    ONLINE       0     0     0
      loop0     ONLINE       0     0    20

errors: Permanent errors have been detected in the following files:

    /var/tmp/testdir/10m_file: found 9 corrupted 128K blocks
       [0x0-0x1ffff] (128K)
       [0x100000-0x1fffff] (1M)

    /var/tmp/testdir/1m_file: found 1 corrupted 128K block
       [0x0-0x1ffff] (128K)

This is a modification of @TulsiJain's #8902 patch, with updates added to print out the different ranges of errors, and to bring the code up to date with master.

How Has This Been Tested?

Added test case

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Performance enhancement (non-breaking change which improves efficiency)
Code cleanup (non-breaking change which makes code smaller or more readable)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (a change to man pages or other documentation)

Checklist:

My code follows the ZFS on Linux code style requirements.
I have updated the documentation accordingly.
I have read the contributing document.
I have added tests to cover my changes.
All new and existing tests passed.
All commit messages are properly formatted and contain Signed-off-by.

codecov · 2019-12-31T02:58:56Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.66%. Comparing base (82e996c) to head (62b89fe).
⚠️ Report is 4520 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9781      +/-   ##
==========================================
+ Coverage   79.40%   79.66%   +0.26%     
==========================================
  Files         385      385              
  Lines      121481   121533      +52     
==========================================
+ Hits        96461    96821     +360     
+ Misses      25020    24712     -308

Flag	Coverage Δ
kernel	`79.84% <100.00%> (+0.03%)`	⬆️
user	`67.43% <95.65%> (+0.61%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

behlendorf · 2019-12-31T04:59:37Z

Rebasing this on master will resolve the CI failures.

@TulsiJain

Add a '-vv' option to zpool status to print all error'd out blocks ranges: $ zpool status -vv ... NAME STATE READ WRITE CKSUM testpool ONLINE 0 0 0 loop0 ONLINE 0 0 20 errors: Permanent errors have been detected in the following files: /var/tmp/testdir/10m_file: found 9 corrupted 128K blocks [0x0-0x1ffff] (128K) [0x100000-0x1fffff] (1M) /var/tmp/testdir/1m_file: found 1 corrupted 128K block [0x0-0x1ffff] (128K) This is a modification of @TulsiJain's openzfs#8902 patch, with updates added to print out the different ranges of errors, and to bring the code up to date with master. Signed-off-by: Tony Hutter <[email protected]> Co-authored-by: TulsiJain <[email protected]>

behlendorf · 2020-01-09T19:25:04Z

cmd/zpool/Makefile.am

 	$(top_builddir)/lib/libuutil/libuutil.la \
-	$(top_builddir)/lib/libzfs/libzfs.la
+	$(top_builddir)/lib/libzfs/libzfs.la \
+	$(top_builddir)/lib/libzpool/libzpool.la


We want to avoid linking libzpool.la with any of the command line utilities. Since this was brought in solely for the btrees and range trees perhaps we can refactor those in a user space convenience library so they can be used. Alternately, we'll need to merge the bookmark_phys_t's in to ranges some other way.

behlendorf · 2020-01-09T19:27:04Z

cmd/zpool/zpool_main.c

 	int		cb_namewidth;
+	unsigned int	cb_verbose;
 	boolean_t	cb_allpools;
-	boolean_t	cb_verbose;


We should consider making this the default behavior and always printing the ranges.

behlendorf · 2020-01-09T19:52:57Z

cmd/zpool/zpool_main.c

+				range_tree = range_tree_create(NULL,
+				    RANGE_SEG64, NULL, 0,  0);
+				if (!range_tree)
+					goto fail;


Instead of adding a label you can just break out of the while loop here.

behlendorf · 2020-01-09T20:06:40Z

lib/libzfs/libzfs_pool.c

+	    sizeof (*indrt_levels));
+
+	/* Write our object group's objset and object */
+	VERIFY0(nvlist_add_uint64(nv, ZPOOL_ERR_DATASET, zb[0].zb_objset));


For the user space only code please use verify() instead.

behlendorf · 2020-01-09T20:08:00Z

include/sys/zfs_stat.h

 	uint64_t	zs_links;
 	uint64_t	zs_ctime[2];
+	uint64_t	zs_data_block_size;
+	uint64_t	zs_indirect_block_size;


While not needed by this patch I think it would be useful to add zs_dnode_size here as well.

pcd1193182

I also concur with @behlendorf's point that we shouldn't be linking in libzpool. Otherwise, it looks good to me.

pcd1193182 · 2020-02-06T18:38:39Z

lib/libzfs/libzfs_pool.c


 	verify(nvlist_alloc(nverrlistp, 0, KM_SLEEP) == 0);

+


nit: double blank line

ahrens · 2020-04-20T18:38:52Z

@tonyhutter, I wanted to check where you are with this. Is this something that someone else could/should help to get this completed?

tonyhutter · 2020-04-20T21:25:38Z

@ahrens I'm pretty bandwidth limited right now, and it's a low priority fix for us. If someone wants to push this over the finish line, I'd be fine with that.

behlendorf · 2025-08-22T23:29:42Z

Replaced by #17502.

Print the byte error ranges with 'zpool status -vv'. This works with the normal zpool status formatting flags (-p, -j, --json-int). In addition: - Move range_tree/btree to common userspace/kernel code. - Modify ZFS_IOC_OBJ_TO_STATS ioctl to optionally return "extended" object stats. - Let zinject corrupt zvol data. - Add test case. This commit takes code from these PRs: openzfs#17502 openzfs#9781 openzfs#8902 Signed-off-by: Tony Hutter <[email protected]> Co-authored-by:: Alan Somers <[email protected]> Co-authored-by: TulsiJain <[email protected]>

tonyhutter mentioned this pull request Dec 28, 2019

Added error offset in zpool status #9743

Closed

12 tasks

behlendorf added the Status: Code Review Needed Ready for review and testing label Dec 28, 2019

tonyhutter force-pushed the error-ranges branch 2 times, most recently from 61964ab to 325ce73 Compare December 30, 2019 20:42

tonyhutter force-pushed the error-ranges branch from 325ce73 to 62b89fe Compare January 2, 2020 20:04

behlendorf requested review from behlendorf and pcd1193182 January 7, 2020 01:10

behlendorf reviewed Jan 9, 2020

View reviewed changes

pcd1193182 reviewed Feb 6, 2020

View reviewed changes

lib/libzfs/libzfs_pool.c

verify(nvlist_alloc(nverrlistp, 0, KM_SLEEP) == 0);

Copy link

Contributor

pcd1193182 Feb 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: double blank line

ahrens assigned mmaybee Jun 5, 2021

behlendorf mentioned this pull request Aug 22, 2025

Add "zpool status -vv" #17502

Open

14 tasks

behlendorf closed this Aug 22, 2025

tonyhutter mentioned this pull request Oct 22, 2025

zpool: Add zpool status -vv error ranges #17864

Open

14 tasks

Uh oh!

zpool status -vv prints error ranges #9781

zpool status -vv prints error ranges #9781

Uh oh!

Conversation

tonyhutter commented Dec 28, 2019

Motivation and Context

Description

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

codecov bot commented Dec 31, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

behlendorf commented Dec 31, 2019

Uh oh!

behlendorf Jan 9, 2020

Choose a reason for hiding this comment

Uh oh!

behlendorf Jan 9, 2020

Choose a reason for hiding this comment

Uh oh!

behlendorf Jan 9, 2020

Choose a reason for hiding this comment

Uh oh!

behlendorf Jan 9, 2020

Choose a reason for hiding this comment

Uh oh!

behlendorf Jan 9, 2020

Choose a reason for hiding this comment

Uh oh!

pcd1193182 left a comment

Choose a reason for hiding this comment

Uh oh!

pcd1193182 Feb 6, 2020

Choose a reason for hiding this comment

Uh oh!

ahrens commented Apr 20, 2020

Uh oh!

tonyhutter commented Apr 20, 2020

Uh oh!

behlendorf commented Aug 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Dec 31, 2019 •

edited

Loading