Closed
Conversation
|
@joshkang97 has imported this pull request. If you are a Meta employee, you can view this in D97190944. |
✅ clang-tidy: No findings on changed linesCompleted in 287.5s. |
hx235
requested changes
Mar 19, 2026
|
@joshkang97 has imported this pull request. If you are a Meta employee, you can view this in D97190944. |
|
@joshkang97 has imported this pull request. If you are a Meta employee, you can view this in D97190944. |
|
@joshkang97 has imported this pull request. If you are a Meta employee, you can view this in D97190944. |
|
@joshkang97 has imported this pull request. If you are a Meta employee, you can view this in D97190944. |
|
@joshkang97 merged this pull request in 3d99378. |
pdillinger
added a commit
to pdillinger/rocksdb
that referenced
this pull request
Apr 1, 2026
Summary: When CompactionJob::Run() succeeds but Install() fails (e.g., LogAndApply MANIFEST I/O error), compact_->status was never updated with the install failure. CleanupCompaction() passed the stale OK status to SubcompactionState::Cleanup(), which skipped ReleaseObsolete -- leaking table cache entries for output files that were cached by VerifyOutputFiles but never installed into any Version. This is the same class of bug fixed in facebook#14469 (where Run() failed after VerifyOutputFiles), but in the Install() failure path. The FindObsoleteFiles full-scan backstop would normally catch this, but fails under crash test metadata read fault injection (--open_metadata_read_fault_one_in), causing the TEST_VerifyNoObsoleteFilesCached assertion to fire during Close(). Fix: propagate Install()'s local status back to compact_->status before CleanupCompaction(), so Cleanup() sees the failure and calls ReleaseObsolete on the output files. Test Plan: New unit test DBCompactionTest.LeakedTableCacheEntryOnInstallFailure: - Without fix (ASAN): assertion fires -- "File 12 is not live nor quarantined" - With fix (ASAN): passes -- ReleaseObsolete properly cleans up the entry ``` COMPILE_WITH_ASAN=1 make -j db_compaction_test ./db_compaction_test --gtest_filter="DBCompactionTest.LeakedTableCacheEntry*" [ PASSED ] 2 tests. ``` Tasks: T218515781
meta-codesync bot
pushed a commit
that referenced
this pull request
Apr 2, 2026
Summary: When CompactionJob::Run() succeeds but Install() fails (e.g., LogAndApply MANIFEST I/O error), compact_->status was never updated with the install failure. CleanupCompaction() passed the stale OK status to SubcompactionState::Cleanup(), which skipped ReleaseObsolete -- leaking table cache entries for output files that were cached by VerifyOutputFiles but never installed into any Version. This is the same class of bug fixed in #14469 (where Run() failed after VerifyOutputFiles), but in the Install() failure path. The FindObsoleteFiles full-scan backstop would normally catch this, but fails under crash test metadata read fault injection (--open_metadata_read_fault_one_in), causing the TEST_VerifyNoObsoleteFilesCached assertion to fire during Close(). Fix: propagate Install()'s local status back to compact_->status before CleanupCompaction(), so Cleanup() sees the failure and calls ReleaseObsolete on the output files. Pull Request resolved: #14549 Test Plan: New unit test DBCompactionTest.LeakedTableCacheEntryOnInstallFailure: - Without fix (ASAN): assertion fires -- "File 12 is not live nor quarantined" - With fix (ASAN): passes -- ReleaseObsolete properly cleans up the entry ``` COMPILE_WITH_ASAN=1 make -j db_compaction_test ./db_compaction_test --gtest_filter="DBCompactionTest.LeakedTableCacheEntry*" [ PASSED ] 2 tests. ``` Reviewed By: joshkang97 Differential Revision: D99155908 Pulled By: pdillinger fbshipit-source-id: ed5374a38d7903866a38a0fe0f5539e12321bc84
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix leaked table cache entries that cause
TEST_VerifyNoObsoleteFilesCachedassertion failure duringDB::Close()in ASAN crash test builds (T258745630):When a compaction fails after
VerifyOutputFilessucceeds (e.g., atVerifyCompactionRecordCounts), the overallcompact_->statusis set to error but each subcompaction's individualstatusremains OK.SubcompactionState::Cleanuponly checked the individual subcompaction status, so it skipped callingReleaseObsoleteon the output files' table cache entries — leaking them.Normally,
Close()'s backstop (FindObsoleteFiles(force=true)+PurgeObsoleteFiles) would catch this by finding the orphan file on disk, evicting the cache entry, and deleting the file. However,FindObsoleteFilescallsFaultInjectionTestFS::GetChildrenwhich can fail under metadata read fault injection (--open_metadata_read_fault_one_in=8). The error is silently ignored (s.PermitUncheckedError()in db_impl_files.cc:199), so the orphan file is never found and the leaked cache entry is never evicted.The
Cleanupbug is latent and predates recent changes. PR #14433 addedverify_output_flagsrandomization to the crash test, and PR #14456 fixed false-positive corruptions that #14433 caused. Before #14456,VerifyOutputFileswould produce false corruption errors that accidentally prevented the leak by setting the subcompaction status to non-OK.How it triggers
Step 1 — VerifyOutputFiles adds cache entries for compaction output files:
Step 2 — A post-verification step fails, overall status set but NOT subcompaction status:
Step 3 — Install skips InstallCompactionResults (file 12 never enters a Version):
Step 4 — CleanupCompaction skips ReleaseObsolete (THE BUG):
Step 5 — Metadata read fault prevents backstop from finding the orphan:
FindObsoleteFiles(force=true)callsGetChildren()to scan the DB directory.FaultInjectionTestFS::GetChildreninjects a metadata read error(
--open_metadata_read_fault_one_in=8). The error is silently ignored(
s.PermitUncheckedError()), so the directory listing is empty and the orphanfile is never found. This happens both in the post-compaction cleanup
(
BackgroundCallCompaction) and inClose()'s backstop:Step 6 — Assertion fires during Close():
Crash test call stack:
Fix
Pass the overall
compact_->statustoSubcompactionState::Cleanupand callReleaseObsoletewhen either the subcompaction status or the overall statusis non-OK:
Key changes
SubcompactionState::Cleanup: Now takes anoverall_statusparameter and callsReleaseObsoletewhen either the subcompaction status or the overall compaction status is non-OK.CompactionJob::CleanupCompaction: Passescompact_->status(the overall status) to each subcompaction'sCleanup.CompactionJob::Run():AfterVerifyOutputFilesfor error injection in tests.DBCompactionTest.LeakedTableCacheEntryOnCompactionFailureusesFaultInjectionTestFSto reproduce the crash test scenario — injects error afterVerifyOutputFilesand deactivates the filesystem soGetChildrenfails inFindObsoleteFiles, preventing the backstop from evicting the leaked cache entry.Test Plan
DBCompactionTest.LeakedTableCacheEntryOnCompactionFailure:Close()—File 12 is not live nor quarantinedReleaseObsoleteproperly cleans up the cache entry