[23923] Fix RTPSParticipantAttributes internal data races

[cferreiragonz]

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 like update_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:

• [23923] Ignore new RTPSParticipantAttributes Fast-DDS-python#294

@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.md file (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

• The PR has a milestone assigned.
• The title and description correctly express the PR's purpose.
• Check contributor checklist is correct.
• If this is a critical bug fix, backports to the critical-only supported branches have been requested.
• Check CI results: changes do not issue any warning.
• Check CI results: failing tests are unrelated with the changes.

[raulojeda22]

Nit

[raulojeda22]

LGTM

[raulojeda22]

LGTM with green CI

[raulojeda22]

LGTM with green CI

[raulojeda22]

LGTM with green CI

[cferreiragonz]

259 Data Races reported by ASAN, none of them related with update_attributes. RTM IMHO

[MiguelCompany]

Just one nit. It does not require to rerun CI.

[cferreiragonz]

@Mergifyio backport 3.4.x 3.2.x 2.14.x

[mergify]

backport 3.4.x 3.2.x 2.14.x

✅ Backports have been created

Details

• #6387 [23923] Fix RTPSParticipantAttributes internal data races (backport #6370) has been created for branch 3.4.x but encountered conflicts

Cherry-pick of 7dd4b4d has failed:

On branch mergify/bp/3.4.x/pr-6370
Your branch is up to date with 'origin/3.4.x'.

You are currently cherry-picking commit 7dd4b4d1.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   include/fastdds/rtps/attributes/RTPSParticipantAttributes.hpp
	modified:   include/fastdds/rtps/participant/RTPSParticipant.hpp
	modified:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupManager.cpp
	modified:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupReplyListener.cpp
	modified:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupRequestListener.cpp
	modified:   src/cpp/fastdds/domain/DomainParticipantImpl.cpp
	modified:   src/cpp/rtps/builtin/BuiltinProtocols.cpp
	modified:   src/cpp/rtps/builtin/discovery/endpoint/EDPSimple.cpp
	modified:   src/cpp/rtps/builtin/discovery/endpoint/EDPStatic.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDP.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPListener.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPServer.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPServerListener.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPSimple.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/simple/PDPStatelessWriter.cpp
	modified:   src/cpp/rtps/builtin/liveliness/WLP.cpp
	modified:   src/cpp/rtps/flowcontrol/FlowControllerFactory.cpp
	modified:   src/cpp/rtps/flowcontrol/FlowControllerImpl.hpp
	modified:   src/cpp/rtps/participant/RTPSParticipant.cpp
	modified:   src/cpp/rtps/participant/RTPSParticipantImpl.hpp
	modified:   src/cpp/rtps/reader/BaseReader.cpp
	modified:   src/cpp/rtps/reader/StatefulReader.cpp
	modified:   src/cpp/rtps/security/SecurityManager.cpp
	modified:   src/cpp/rtps/security/SecurityManager.h
	modified:   src/cpp/rtps/security/accesscontrol/AccessControl.h
	modified:   src/cpp/rtps/security/authentication/Authentication.h
	modified:   src/cpp/security/accesscontrol/Permissions.cpp
	modified:   src/cpp/security/accesscontrol/Permissions.h
	modified:   src/cpp/security/authentication/PKIDH.cpp
	modified:   src/cpp/security/authentication/PKIDH.h
	modified:   test/mock/rtps/RTPSParticipant/fastdds/rtps/participant/RTPSParticipant.hpp
	modified:   test/mock/rtps/RTPSParticipantAttributes/fastdds/rtps/attributes/RTPSParticipantAttributes.hpp
	modified:   test/mock/rtps/RTPSParticipantImpl/rtps/participant/RTPSParticipantImpl.hpp
	modified:   test/mock/rtps/SecurityPluginFactory/rtps/security/MockAccessControlPlugin.h
	modified:   test/mock/rtps/SecurityPluginFactory/rtps/security/MockAuthenticationPlugin.h
	modified:   test/unittest/dds/participant/ParticipantTests.cpp
	modified:   test/unittest/rtps/security/SecurityTests.hpp
	modified:   test/unittest/security/accesscontrol/AccessControlTests.cpp
	modified:   test/unittest/security/authentication/AuthenticationPluginTests.hpp
	modified:   test/unittest/security/authentication/BuiltinPKIDHTests.cpp

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   include/fastdds/dds/publisher/DataWriter.hpp
	both modified:   src/cpp/rtps/participant/RTPSParticipantImpl.cpp

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

• #6388 [23923] Fix RTPSParticipantAttributes internal data races (backport #6370) has been created for branch 3.2.x but encountered conflicts

Cherry-pick of 7dd4b4d has failed:

On branch mergify/bp/3.2.x/pr-6370
Your branch is up to date with 'origin/3.2.x'.

You are currently cherry-picking commit 7dd4b4d17.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   include/fastdds/rtps/attributes/RTPSParticipantAttributes.hpp
	modified:   include/fastdds/rtps/participant/RTPSParticipant.hpp
	modified:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupManager.cpp
	modified:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupReplyListener.cpp
	modified:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupRequestListener.cpp
	modified:   src/cpp/fastdds/domain/DomainParticipantImpl.cpp
	modified:   src/cpp/rtps/builtin/BuiltinProtocols.cpp
	modified:   src/cpp/rtps/builtin/discovery/endpoint/EDPSimple.cpp
	modified:   src/cpp/rtps/builtin/discovery/endpoint/EDPStatic.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDP.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPListener.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPServer.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPServerListener.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/PDPSimple.cpp
	modified:   src/cpp/rtps/builtin/discovery/participant/simple/PDPStatelessWriter.cpp
	modified:   src/cpp/rtps/builtin/liveliness/WLP.cpp
	modified:   src/cpp/rtps/flowcontrol/FlowControllerFactory.cpp
	modified:   src/cpp/rtps/flowcontrol/FlowControllerImpl.hpp
	modified:   src/cpp/rtps/participant/RTPSParticipant.cpp
	modified:   src/cpp/rtps/participant/RTPSParticipantImpl.hpp
	modified:   src/cpp/rtps/reader/BaseReader.cpp
	modified:   src/cpp/rtps/reader/StatefulReader.cpp
	modified:   src/cpp/rtps/security/SecurityManager.cpp
	modified:   src/cpp/rtps/security/SecurityManager.h
	modified:   src/cpp/rtps/security/accesscontrol/AccessControl.h
	modified:   src/cpp/rtps/security/authentication/Authentication.h
	modified:   src/cpp/security/accesscontrol/Permissions.cpp
	modified:   src/cpp/security/accesscontrol/Permissions.h
	modified:   src/cpp/security/authentication/PKIDH.cpp
	modified:   src/cpp/security/authentication/PKIDH.h
	modified:   test/mock/rtps/RTPSParticipant/fastdds/rtps/participant/RTPSParticipant.hpp
	modified:   test/mock/rtps/RTPSParticipantAttributes/fastdds/rtps/attributes/RTPSParticipantAttributes.hpp
	modified:   test/mock/rtps/RTPSParticipantImpl/rtps/participant/RTPSParticipantImpl.hpp
	modified:   test/mock/rtps/SecurityPluginFactory/rtps/security/MockAccessControlPlugin.h
	modified:   test/mock/rtps/SecurityPluginFactory/rtps/security/MockAuthenticationPlugin.h
	modified:   test/unittest/dds/participant/ParticipantTests.cpp
	modified:   test/unittest/rtps/security/SecurityTests.hpp
	modified:   test/unittest/security/accesscontrol/AccessControlTests.cpp
	modified:   test/unittest/security/authentication/AuthenticationPluginTests.hpp
	modified:   test/unittest/security/authentication/BuiltinPKIDHTests.cpp

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   include/fastdds/dds/publisher/DataWriter.hpp
	both modified:   src/cpp/rtps/participant/RTPSParticipantImpl.cpp

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

• #6389 [23923] Fix RTPSParticipantAttributes internal data races (backport #6370) has been created for branch 2.14.x but encountered conflicts

Cherry-pick of 7dd4b4d has failed:

On branch mergify/bp/2.14.x/pr-6370
Your branch is up to date with 'origin/2.14.x'.

You are currently cherry-picking commit 7dd4b4d17.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   include/fastdds/rtps/security/accesscontrol/AccessControl.h
	modified:   include/fastdds/rtps/security/authentication/Authentication.h
	modified:   src/cpp/rtps/participant/RTPSParticipant.cpp
	modified:   src/cpp/rtps/security/SecurityManager.h
	modified:   src/cpp/security/accesscontrol/Permissions.cpp
	modified:   src/cpp/security/accesscontrol/Permissions.h
	modified:   src/cpp/security/authentication/PKIDH.cpp
	modified:   src/cpp/security/authentication/PKIDH.h
	modified:   test/mock/rtps/RTPSParticipantImpl/rtps/participant/RTPSParticipantImpl.h
	modified:   test/mock/rtps/SecurityPluginFactory/rtps/security/MockAccessControlPlugin.h
	modified:   test/mock/rtps/SecurityPluginFactory/rtps/security/MockAuthenticationPlugin.h
	modified:   test/unittest/rtps/security/SecurityTests.hpp
	modified:   test/unittest/security/accesscontrol/AccessControlTests.cpp
	modified:   test/unittest/security/authentication/AuthenticationPluginTests.hpp
	modified:   test/unittest/security/authentication/BuiltinPKIDHTests.cpp

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   include/fastdds/dds/publisher/DataWriter.hpp
	both modified:   include/fastdds/rtps/attributes/RTPSParticipantAttributes.h
	both modified:   include/fastdds/rtps/participant/RTPSParticipant.h
	deleted by us:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupManager.cpp
	deleted by us:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupReplyListener.cpp
	deleted by us:   src/cpp/fastdds/builtin/type_lookup_service/TypeLookupRequestListener.cpp
	both modified:   src/cpp/fastdds/domain/DomainParticipantImpl.cpp
	both modified:   src/cpp/rtps/builtin/BuiltinProtocols.cpp
	both modified:   src/cpp/rtps/builtin/discovery/endpoint/EDPSimple.cpp
	both modified:   src/cpp/rtps/builtin/discovery/endpoint/EDPStatic.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/PDP.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/PDPListener.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/PDPServer.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/PDPServerListener.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/PDPSimple.cpp
	both modified:   src/cpp/rtps/builtin/discovery/participant/simple/PDPStatelessWriter.cpp
	both modified:   src/cpp/rtps/builtin/liveliness/WLP.cpp
	both modified:   src/cpp/rtps/flowcontrol/FlowControllerFactory.cpp
	both modified:   src/cpp/rtps/flowcontrol/FlowControllerImpl.hpp
	both modified:   src/cpp/rtps/participant/RTPSParticipantImpl.cpp
	both modified:   src/cpp/rtps/participant/RTPSParticipantImpl.h
	deleted by us:   src/cpp/rtps/reader/BaseReader.cpp
	both modified:   src/cpp/rtps/reader/StatefulReader.cpp
	both modified:   src/cpp/rtps/security/SecurityManager.cpp
	both modified:   test/mock/rtps/RTPSParticipant/fastdds/rtps/participant/RTPSParticipant.h
	both modified:   test/mock/rtps/RTPSParticipantAttributes/fastdds/rtps/attributes/RTPSParticipantAttributes.h
	both modified:   test/unittest/dds/participant/ParticipantTests.cpp

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