Fix race condition in VecSimTieredIndex::debugInfoIterator during background indexing#919
Open
Fix race condition in VecSimTieredIndex::debugInfoIterator during background indexing#919
Conversation
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #919 +/- ##
=======================================
Coverage 96.98% 96.98%
=======================================
Files 129 129
Lines 7567 7569 +2
=======================================
+ Hits 7339 7341 +2
Misses 228 228 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Describe the changes in the pull request
Fixes a race condition that causes a crash when
debugInfoIterator()is called on a tiered SVS index while background indexing is running.Root Cause Analysis
The crash occurs because
VecSimTieredIndex::debugInfoIterator()callsbackendIndex->debugInfoIterator()without holding any locks. During async background indexing, the backend SVS index's internal state (impl_) can be modified by the background thread while the main thread is accessing it throughdebugInfo()→indexLabelCount()→impl_->size().Stack trace from the crash:
The interleaved log messages showed that background indexing was running (rounds 2-12 of 40) when
VecsimInfowas called, confirming the race.Fix
Acquire shared locks (
flatIndexGuardandmainIndexGuard) before callingfrontendIndex->debugInfoIterator()andbackendIndex->debugInfoIterator(). This follows the same lock ordering pattern used elsewhere in the codebase (e.g., indebugInfo()andindexLabelCount()).Main objects this PR modified
VecSimTieredIndex::debugInfoIterator()invec_sim_tiered_index.hMark if applicable
Note
Medium Risk
Touches concurrency/locking around tiered index introspection; while scoped to debug info, incorrect locking could still introduce contention or deadlocks under load.
Overview
Fixes a crash/race in
VecSimTieredIndex::debugInfoIterator()by acquiringshared_locks onflatIndexGuardandmainIndexGuardwhen generating the frontend/backend sub-index debug iterators.Locks are taken per sub-index (and released immediately after) to keep the iterator construction thread-safe during background indexing while minimizing lock contention.
Written by Cursor Bugbot for commit 409ffff. This will update automatically on new commits. Configure here.