#linux #utility #system

nightly app integrity-scrub

Scrub dm-integrity volumes

19 releases

Uses new Rust 2021

0.5.10 Aug 18, 2022
0.5.9 May 12, 2022
0.5.8 Mar 16, 2022
0.5.6 Dec 28, 2021
0.5.1 Nov 27, 2021

#1003 in Command line utilities

MirOS license

16KB
431 lines

Synopsis

This tool attempts to read all logical sectors of a block device, overwriting any sector that cannot be read due to an I/O error with zeros. It is intended to restore Linux dm-integrity volumes with invalid (corrupted) integrity tags.

Usage

If you wish to scrub a volume, consider creating a backup of the underlying physical device first.

Then run the tool with the volume device path (/dev/mapper/… or /dev/dm-…) as a command line argument.

Unless you really know what you are doing, you should not run it on a mounted volume. Data written by the filesystem might get overwritten by interleaved writes of the tool.

Implementation notes

The block device is first read in large chunks (the maximum sectors per request as reported by the BLKSECTGET ioctl). If a read results in an integrity error (EILSEQ), the logical sectors in the chunk are read individually and any erroneous sector is overwritten with zeros.

Reads are performed using direct I/O (O_DIRECT), while writes rely on buffered I/O with chunk‐wise asynchronous flushing (sync_file_range(2)). Any outstanding writes are finalised using fdatasync(3) before the tool exits.

Caveat

This tool might delete all your data and summon a seal. Use it at your own risk. The seal will demand fish.

If you are not using a filesystem with copy‐on‐write semantics (e.g. btrfs) or data journalling (e.g. ext4 with data=journal), you should probably rely on dm-integrity’s data journal.

Dependencies

~4MB
~80K SLoC