Fix crash when removing connection from the pool #347
Merged
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
BewareMyPower
requested review from
merlimat,
RobertIndie,
Demogorgon314 and
shibd
|
More context: https://stackoverflow.com/questions/16267615/is-second-defined-for-iterator-stdmapend Dereferencing an iterator that points to the end of a STL container is UB. |
Fixes apache#346 ### Motivation apache#336 changes the key of the `ClientConnection` in `ConnectionPool`, while in `ClientConnection::close`, it still passes the old key (logical address) to `ConnectionPool::remove`, which results in the connection could never be removed and destroyed until being deleted as a stale connection. What's worse, if the key does not exist, the iterator returned by `std::map::find` will still be dereferenced, which might cause crash in some platforms. See https://github.com/apache/pulsar-client-cpp/blob/8d32fd254e294d1fabba73aed70115a434b341ef/lib/ConnectionPool.cc#L122-L123 ### Modifications - Avoid dereferencing the iterator if it's invalid in `ConnectionPool::remove`. - Store the key suffix in `ClientConnection` and pass the correct key to `ConnectionPool::remove` in `ClientConnection::close` - Add `ClientTest.testConnectionClose` to verify `ClientConnection::close` can remove itself from the pool and the connection will be destroyed eventually.
BewareMyPower
force-pushed
the
bewaremypower/fix-crash-cnx-per-broker
branch
from
270d36c to
f90a9c3
Compare
RobertIndie
approved these changes
Nov 16, 2023
BewareMyPower
added a commit
that referenced
this pull request
Nov 17, 2023
Fixes #346 ### Motivation #336 changes the key of the `ClientConnection` in `ConnectionPool`, while in `ClientConnection::close`, it still passes the old key (logical address) to `ConnectionPool::remove`, which results in the connection could never be removed and destroyed until being deleted as a stale connection. What's worse, if the key does not exist, the iterator returned by `std::map::find` will still be dereferenced, which might cause crash in some platforms. See https://github.com/apache/pulsar-client-cpp/blob/8d32fd254e294d1fabba73aed70115a434b341ef/lib/ConnectionPool.cc#L122-L123 ### Modifications - Avoid dereferencing the iterator if it's invalid in `ConnectionPool::remove`. - Store the key suffix in `ClientConnection` and pass the correct key to `ConnectionPool::remove` in `ClientConnection::close` - Add `ClientTest.testConnectionClose` to verify `ClientConnection::close` can remove itself from the pool and the connection will be destroyed eventually. (cherry picked from commit 6d47e94)
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.
Fixes #346
Motivation
#336 changes the key of the
ClientConnectioninConnectionPool, while inClientConnection::close, it still passes the old key (logical address) toConnectionPool::remove, which results in the connection could never be removed and destroyed until being deleted as a stale connection.What's worse, if the key does not exist, the iterator returned by
std::map::findwill still be dereferenced, which might cause crash in some platforms. Seepulsar-client-cpp/lib/ConnectionPool.cc
Lines 122 to 123 in 8d32fd2
Modifications
ConnectionPool::remove.ClientConnectionand pass the correct key toConnectionPool::removeinClientConnection::closeClientTest.testConnectionCloseto verifyClientConnection::closecan remove itself from the pool and the connection will be destroyed eventually.