Skip to content

HDDS-10374. Make container scanner generate merkle trees during the scan #7490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 63 commits into
base: HDDS-10239-container-reconciliation
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
a8b8dbc
Merge branch 'HDDS-10239-container-reconciliation' into HDDS-10374-sc…
errose28 Nov 22, 2024
999a913
Add code to build and write the tree from the data scanners
errose28 Nov 22, 2024
b0d1ba9
Update todo in acceptance test
errose28 Nov 25, 2024
382bce2
Add unit tests for tree generation by scanners based on container state
errose28 Nov 25, 2024
28b1889
Add initial (failing) unit test for KeyValueContaienrCheck
errose28 Nov 26, 2024
dc182e8
Update container data checksum when building the tree
errose28 Nov 26, 2024
a3401a9
Fix handling of fully truncated block of 0 size
errose28 Jan 7, 2025
a25d44d
Add unit tests for new addBlock method in tree
errose28 Jan 7, 2025
7550a3c
Test that SCM gets a checksum with the container report
errose28 Jan 7, 2025
847f8d8
Add (failing) tests that SCM sees updated checksums
errose28 Jan 7, 2025
452c294
Update acceptance test
errose28 Jan 8, 2025
dc45eca
Add javadoc for tree generation from metadata
errose28 Jan 8, 2025
1cb291f
Data integration tests passing
errose28 Jan 8, 2025
d6b21d2
Don't generate tree from metadata for unhealthy container
errose28 Jan 9, 2025
2a2dbbd
Checkstyle
errose28 Jan 9, 2025
c9a077c
Marking container unhealthy should not write a merkle tree (test fix)
errose28 Jan 9, 2025
0bbbdc5
Checkstyle
errose28 Jan 9, 2025
7b971a9
Address review comments
errose28 Jan 13, 2025
15d6848
Merge branch 'HDDS-10239-container-reconciliation' into HDDS-10374-sc…
errose28 Apr 11, 2025
0989881
Initial use of on demand scan in TestKeyValueHandler
errose28 Apr 11, 2025
834be96
Make on-demand scanner a normal instance
errose28 Apr 15, 2025
e73757e
Register on-demand scan callback in ContainerSet
errose28 Apr 15, 2025
f0d8efe
Migrate scanContainer usage in prod code
errose28 Apr 15, 2025
4cb054c
Switch terminology from error to scan. Add existence checks
errose28 Apr 15, 2025
8abedb6
Update tests
errose28 Apr 15, 2025
577a075
Add unit test for ContainerSet
errose28 Apr 16, 2025
4c8d843
Checkstyle
errose28 Apr 16, 2025
0bd4127
Improve comments and test
errose28 Apr 16, 2025
61fae12
Merge branch 'non-static-on-demand-scan' into HDDS-10374-scanner-buil…
errose28 Apr 16, 2025
61f30f3
WIP migrate reconciliation unit tests
errose28 Apr 17, 2025
192eb7b
Most tests passing
errose28 Apr 23, 2025
0cf79f6
Improve logging in test and prod code
errose28 Apr 28, 2025
8b30f54
Fix tree tracking during reconcile process
errose28 Apr 28, 2025
9c74f4b
Use mixin to standardize scanner operations, log checksum changes in …
errose28 Apr 29, 2025
d550669
Logging improvements
errose28 Apr 29, 2025
97e02ea
Add checksum validation, generate readable data
errose28 Apr 30, 2025
22b41b8
Use tree writer between peer updates. All tests pass
errose28 May 5, 2025
f49a9dd
Wait for on-demand scans to complete in test
errose28 May 5, 2025
f5d4dbf
Improve char data generation, reset scan metrics
errose28 May 5, 2025
1140c90
Update test name
errose28 May 5, 2025
e0aa7cb
Checkstyle
errose28 May 5, 2025
62d7794
Merge branch 'HDDS-10239-container-reconciliation' into HDDS-10374-sc…
errose28 May 6, 2025
9c3b87c
Merge branch 'reconcile-unit-test-framework' into HDDS-10374-scanner-…
errose28 May 6, 2025
9322b4a
Fix TODOs dependent on this patch
errose28 May 13, 2025
9b75957
Rename container scan helper
errose28 May 13, 2025
f615275
Add comment on failure type
errose28 May 13, 2025
dadc829
Fix checkstyle unique to this PR
errose28 May 13, 2025
076a82e
Merge branch 'HDDS-10239-container-reconciliation' into HDDS-10374-sc…
errose28 May 14, 2025
cc55527
Fix sending ICR when only checksum changes (pending test)
errose28 May 14, 2025
35879b4
Updates after reviewing diff
errose28 May 14, 2025
1ab8c14
Add unit test for KeyValueHandler#updateContainerChecksum
errose28 May 14, 2025
6c8be07
Improve and update scanner integration tests
errose28 May 14, 2025
60a1a6e
Add unit tests that checksum update failure does not stop container s…
errose28 May 14, 2025
d035c17
Checkstyle
errose28 May 14, 2025
53336ae
Fix scan gap for unit test
errose28 May 15, 2025
56e7ed4
Merge branch 'HDDS-10239-container-reconciliation' into HDDS-10374-sc…
errose28 May 16, 2025
2504638
Fix metadata scan test
errose28 May 16, 2025
4be9992
Update based on review
errose28 May 19, 2025
c0b89dd
pmd
errose28 May 19, 2025
e24a24e
Update ContainerData checksum info after reconcile with each peer
errose28 May 22, 2025
dc27f74
Support bypassing scan gap (tests are failing)
errose28 May 22, 2025
e2974b4
Checkstyle
errose28 May 27, 2025
34b4b9a
Fix scan gap bug. All tests expected to pass
errose28 May 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix handling of fully truncated block of 0 size
  • Loading branch information
errose28 committed Jan 7, 2025
commit a3401a93835e59193feedf0f3528dd9cd398c1a5
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@ public void addChunks(long blockID, boolean healthy, ContainerProtos.ChunkInfo..
id2Block.computeIfAbsent(blockID, BlockMerkleTree::new).addChunks(healthy, chunks);
}

/**
* Adds an empty block to the tree. This method is not a pre-requisite to {@code addChunks}.
* If the block entry already exists, it will not be modified.
*
* @param blockID The ID of the empty block to add to the tree
*/
public void addBlock(long blockID) {
addChunks(blockID, true);
}

/**
* Uses chunk hashes to compute all remaining hashes in the tree, and returns it as a protobuf object. No checksum
* computation for the tree happens outside of this method.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -378,12 +378,13 @@ private List<ContainerScanError> scanBlock(DBHandle db, File dbFile, BlockData b
// So, we need to make sure, chunk length > 0, before declaring
// the missing chunk file.
if (!block.getChunks().isEmpty() && block.getChunks().get(0).getLen() > 0) {
ContainerScanError error = new ContainerScanError(FailureType.MISSING_CHUNK_FILE,
ContainerScanError error = new ContainerScanError(FailureType.MISSING_DATA_FILE,
new File(containerDataFromDisk.getChunksPath()), new IOException("Missing chunk file " +
chunkFile.getAbsolutePath()));
blockErrors.add(error);
}
} else if (chunk.getChecksumData().getType() != ContainerProtos.ChecksumType.NONE) {
currentTree.addBlock(block.getBlockID().getLocalID());
int bytesPerChecksum = chunk.getChecksumData().getBytesPerChecksum();
ByteBuffer buffer = BUFFER_POOL.getBuffer(bytesPerChecksum);
// Keep scanning the block even if there are errors with individual chunks.
Expand Down Expand Up @@ -427,6 +428,7 @@ private static List<ContainerScanError> verifyChecksum(BlockData block,
ContainerProtos.ChecksumData.Builder observedChecksumData = chunk.getChecksumData().toBuilder();
observedChecksumData.clearChecksums();
boolean chunkHealthy = true;
boolean chunkMissing = false;

ChecksumData checksumData =
ChecksumData.getFromProtoBuf(chunk.getChecksumData());
Expand Down Expand Up @@ -481,26 +483,41 @@ private static List<ContainerScanError> verifyChecksum(BlockData block,
new OzoneChecksumException(message)));
}
}
// If all the checksums match, also check that the length stored in the metadata matches the number of bytes
// seen on the disk.

observedChunkBuilder.setLen(bytesRead);
// If we haven't seen any errors after scanning the whole chunk, verify that the length stored in the metadata
// matches the number of bytes seen on the disk.
if (chunkHealthy && bytesRead != chunk.getLen()) {
String message = String
.format("Inconsistent read for chunk=%s expected length=%d"
+ " actual length=%d for block %s",
chunk.getChunkName(),
chunk.getLen(), bytesRead, block.getBlockID());
chunkHealthy = false;
scanErrors.add(new ContainerScanError(FailureType.INCONSISTENT_CHUNK_LENGTH, chunkFile,
new IOException(message)));
if (bytesRead == 0) {
// If we could not find any data for the chunk, report it as missing.
chunkMissing = true;
chunkHealthy = false;
String message = String.format("Missing chunk=%s with expected length=%d for block %s",
chunk.getChunkName(), chunk.getLen(), block.getBlockID());
scanErrors.add(new ContainerScanError(FailureType.MISSING_CHUNK, chunkFile, new IOException(message)));
} else {
// We found data for the chunk, but it was shorter than expected.
String message = String
.format("Inconsistent read for chunk=%s expected length=%d"
+ " actual length=%d for block %s",
chunk.getChunkName(),
chunk.getLen(), bytesRead, block.getBlockID());
chunkHealthy = false;
scanErrors.add(new ContainerScanError(FailureType.INCONSISTENT_CHUNK_LENGTH, chunkFile,
new IOException(message)));
}
}
} catch (IOException ex) {
// An unknown error occurred trying to access the chunk. Report it as corrupted.
chunkHealthy = false;
scanErrors.add(new ContainerScanError(FailureType.MISSING_CHUNK_FILE, chunkFile, ex));
scanErrors.add(new ContainerScanError(FailureType.CORRUPT_CHUNK, chunkFile, ex));
}

observedChunkBuilder.setChecksumData(observedChecksumData);
currentTree.addChunks(block.getBlockID().getLocalID(), chunkHealthy, observedChunkBuilder.build());
// Missing chunks should not be added to the merkle tree.
if (!chunkMissing) {
observedChunkBuilder.setChecksumData(observedChecksumData);
currentTree.addChunks(block.getBlockID().getLocalID(), chunkHealthy, observedChunkBuilder.build());
}
return scanErrors;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ public enum FailureType {
MISSING_METADATA_DIR,
MISSING_CONTAINER_FILE,
MISSING_CHUNKS_DIR,
MISSING_CHUNK_FILE,
MISSING_DATA_FILE,
Copy link
Contributor

Choose a reason for hiding this comment

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

qq: Is this for the cases when *.block file is missing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. I changed the name so it is agnostic of container layout.

CORRUPT_CONTAINER_FILE,
CORRUPT_CHUNK,
MISSING_CHUNK,
INCONSISTENT_CHUNK_LENGTH,
INACCESSIBLE_DB,
WRITE_FAILURE,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public enum TestContainerCorruptions {
MISSING_BLOCK((container, blockID) -> {
File blockFile = getBlock(container, blockID);
assertTrue(blockFile.delete());
}, ContainerScanError.FailureType.MISSING_CHUNK_FILE),
}, ContainerScanError.FailureType.MISSING_DATA_FILE),

CORRUPT_CONTAINER_FILE((container, blockID) -> {
File containerFile = container.getContainerFile();
Expand All @@ -113,7 +113,7 @@ public enum TestContainerCorruptions {
TRUNCATED_BLOCK((container, blockID) -> {
File blockFile = getBlock(container, blockID);
truncateFile(blockFile);
}, ContainerScanError.FailureType.INCONSISTENT_CHUNK_LENGTH);
}, ContainerScanError.FailureType.MISSING_CHUNK);

private final BiConsumer<Container<?>, Long> corruption;
private final ContainerScanError.FailureType expectedResult;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,8 @@ public void testAllDataErrorsCollected(ContainerTestVersionInfo versionInfo) thr

DataScanResult result = kvCheck.fullCheck(throttler, null);
assertTrue(result.isHealthy());
// The scanner would write the checksum file to disk. `KeyValueContainerCheck` does not, so we will create the
// result here.
ContainerProtos.ContainerChecksumInfo healthyChecksumInfo = ContainerProtos.ContainerChecksumInfo.newBuilder()
.setContainerID(containerID)
.setContainerMerkleTree(result.getDataTree().toProto())
Expand Down Expand Up @@ -201,23 +203,26 @@ public void testAllDataErrorsCollected(ContainerTestVersionInfo versionInfo) thr
// compare it against the original healthy tree. The diff we get back should match the failures we injected.
ContainerDiffReport diffReport = checksumManager.diff(container.getContainerData(), healthyChecksumInfo);

LOG.info("Diff of healthy container with actual container {}", diffReport);

// Check that the new tree identified all the expected errors by checking the diff.
Map<Long, List<ContainerProtos.ChunkMerkleTree>> corruptChunks = diffReport.getCorruptChunks();
// One block had corrupted chunks.
assertEquals(1, corruptChunks.size());
List<ContainerProtos.ChunkMerkleTree> corruptChunksInBlock = corruptChunks.get(corruptBlockID);
assertEquals(2, corruptChunksInBlock.size());

// Check missing block was correctly identified in the tree diff.
List<ContainerProtos.BlockMerkleTree> missingBlocks = diffReport.getMissingBlocks();
assertEquals(1, missingBlocks.size());
assertEquals(missingBlockID, missingBlocks.get(0).getBlockID());

// One block was truncated which resulted in all of its chunks being reported as missing.
Map<Long, List<ContainerProtos.ChunkMerkleTree>> missingChunks = diffReport.getMissingChunks();
assertEquals(1, missingChunks.size());
List<ContainerProtos.ChunkMerkleTree> missingChunksInBlock = missingChunks.get(truncatedBlockID);
assertEquals(CHUNKS_PER_BLOCK, missingChunksInBlock.size());

// Check missing block was correctly identified in the tree diff.
List<ContainerProtos.BlockMerkleTree> missingBlocks = diffReport.getMissingBlocks();
assertEquals(1, missingBlocks.size());
assertEquals(missingBlockID, missingBlocks.get(0).getBlockID());

}

/**
Expand Down