[23923] Fix RTPSParticipantAttributes internal data races (backport #6370)#6387
Open
mergify[bot] wants to merge 1 commit into
Open
[23923] Fix RTPSParticipantAttributes internal data races (backport #6370)#6387mergify[bot] wants to merge 1 commit into
mergify[bot] wants to merge 1 commit into
Conversation
* Refs #23923: Take mutex in getter and env file callback Signed-off-by: Juan Lopez Fernandez <[email protected]> * Refs #23923: Only update mutable attributes Signed-off-by: Juan Lopez Fernandez <[email protected]> * Refs #23923: Copy attributes in getter Signed-off-by: Juan Lopez Fernandez <[email protected]> * Refs #23923: Undo copy attributes Signed-off-by: Juan Lopez Fernandez <[email protected]> * Refs #23923: Avoid calling get_attributes in SecurityManager constructor Signed-off-by: Juan Lopez Fernandez <[email protected]> * Refs #23923: Copy attributes Signed-off-by: Juan Lopez Fernandez <[email protected]> * Refs #23923: Protect missing cases Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Create new method to avoid API break Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Doxygen & TODO in next major Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Copy method in RTPSParticipant Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Mock and tests changes Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Revision Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Add missing mutable attribute Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Create const copy Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Uncrustify Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Spelling Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Split const and mutable RTPSParticipantAttributes Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Review - Fix Mutable & Constant attributes Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Review - Apply methods and composition of BuiltinAttributes Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Review - Update Tests Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Review - Add ConstantDiscoverySettings Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Solve using statement visibility Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Uncrustify Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Store constant attributes set at 'setup_' methods Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Init const attributes and update later Signed-off-by: Carlos Ferreira González <[email protected]> * Refs #23923: Review - Improve doxygen Signed-off-by: Carlos Ferreira González <[email protected]> --------- Signed-off-by: Juan Lopez Fernandez <[email protected]> Signed-off-by: Carlos Ferreira González <[email protected]> Co-authored-by: Juan Lopez Fernandez <[email protected]> (cherry picked from commit 7dd4b4d) # Conflicts: # include/fastdds/dds/publisher/DataWriter.hpp # src/cpp/rtps/participant/RTPSParticipantImpl.cpp
Contributor
Author
|
Cherry-pick of 7dd4b4d has failed: To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally |
10 tasks
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.
Description
This PR solves a bunch of data races caused by the not-thread-safe access to RTPSParticipantAttributes via its main getter
get_attributes(). This method returns a const reference to the object, which can be concurrently modified from other functions likeupdate_attributes()causing a read-write access data race.The proposed fix should modify the original method to return a copy of the class attribute with the mutex locked, making the access safe. However, this would imply an API break. Thus, a new method has been created to be used internally, leaving the
get_attributes()method untouched and marked to be fixed in the next major release.Related PR:
@Mergifyio backport 3.4.x 3.2.x 2.14.x
Contributor Checklist
Commit messages follow the project guidelines.
The code follows the style guidelines of this project.
N/A: Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
N/A: Any new/modified methods have been properly documented using Doxygen.
N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
Changes are backport compatible: they do NOT break ABI nor change library core behavior.
Changes are API compatible.
N/A New feature has been added to the
versions.mdfile (if applicable).N/A New feature has been documented/Current behavior is correctly described in the documentation.
N/A Applicable backports have been included in the description.
Reviewer Checklist
This is an automatic backport of pull request #6370 done by [Mergify](https://mergify.com).