Firestore: Make ListenerRegistration::Remove() thread-safe #10065
Conversation
This file contains 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
Coverage Report 1Affected Products
Test Logs |
ehsannas
approved these changes
Aug 4, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This fixes a latent bug in Firestore's
ListenerRegistration::Remove()where it could use invalid memory if invoked concurrently. The fix is to simply guard the entire method's body with a mutex.The issue is that one thread could use
client_(ashared_ptr) that has been reset by another thread. Specifically, in this code blockfirebase-ios-sdk/Firestore/core/src/api/query_listener_registration.cc
Lines 47 to 53 in 26075af
one thread could invoke
client_.reset()on line 53 just before another thread invokesclient_->RemoveListener(query_listener)on line 49.This may be the root cause of #10026 and #9302. I'll ask the customer to report back once they upgrade to a version that contains this fix.