Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[21293] Fix destruction data-race on participant removal in intra-process (backport #5034) #5367

Merged
merged 5 commits into from
Nov 20, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 29, 2024

Description

This PR addresses a race issue happening in stressed intraprocess scenarios when EDP's writer intends to use the remote local reader pointer of an already removed participant. This happens because the participant hasn't received the other's one disposal yet (as it goes through transport).

Some ci flaky tests have already been identified to be related with this issue.

The proposed solution introduces a new state in the Readers LocalReaderViewStatus in which the reader will notify that it is inactive as soon as it is destroyed and noone is using it.
On the other side, the remote local writers using pointers to it, now holds a LocalReaderPointer which wraps the raw reader's pointer plus the view. An internal counter now accounts for the number of references.

Thanks @MiguelCompany for helping with the final's solution design.

Note: the test may be launched with --restest-until-fail 20 or so, in order to reproduce the issue. For a more frequent failure, review can launch the colcon test with the taskset -c 0,1 prefix to make the test to stress more and make it fail more frequently.

@Mergifyio backport 3.1.x 3.0.x 2.14.x 2.10.x

Contributor Checklist

  • Commit messages follow the project guidelines.

  • The code follows the style guidelines of this project.

  • 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

  • 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.

  • 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.

This is an automatic backport of pull request #5034 done by [Mergify](https://mergify.com).

)

* Refs #21293: Add BB test

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Reinforce test to fail more frequently

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Add RefCountedPointer.hpp to utils

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Add unittests for RefCountedPointer

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: LocalReaderPointer.hpp

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: BaseReader aggregates LocalReaderPointer

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: ReaderLocator aggregates LocalReaderPointer

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: RTPSDomainImpl::find_local_reader returns a sared_ptr<LocalReaderPointer> and properly calls local_actions_on_reader_removed()

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: RTPSWriters properly using LocalReaderPointer::Instance when accessing local reader

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Linter

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Fix windows warnings

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Address Miguel's review

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: Apply last comment

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21293: NIT

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Dominguez <[email protected]>
(cherry picked from commit 456e45f)

# Conflicts:
#	include/fastdds/rtps/writer/ReaderLocator.h
#	include/fastdds/rtps/writer/ReaderProxy.h
#	src/cpp/rtps/RTPSDomain.cpp
#	src/cpp/rtps/RTPSDomainImpl.hpp
#	src/cpp/rtps/participant/RTPSParticipantImpl.cpp
#	src/cpp/rtps/participant/RTPSParticipantImpl.h
#	src/cpp/rtps/reader/BaseReader.cpp
#	src/cpp/rtps/reader/BaseReader.hpp
#	src/cpp/rtps/writer/ReaderLocator.cpp
#	src/cpp/rtps/writer/StatefulWriter.cpp
#	src/cpp/rtps/writer/StatelessWriter.cpp
#	test/blackbox/common/DDSBlackboxTestsBasic.cpp
#	test/mock/rtps/ReaderLocator/fastdds/rtps/writer/ReaderLocator.h
#	test/unittest/utils/CMakeLists.txt
@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Oct 29, 2024
Copy link
Contributor Author

mergify bot commented Oct 29, 2024

Cherry-pick of 456e45f has failed:

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

You are currently cherry-picking commit 456e45f25.
  (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:
	new file:   src/cpp/rtps/reader/LocalReaderPointer.hpp
	new file:   src/cpp/utils/RefCountedPointer.hpp
	new file:   test/unittest/utils/RefCountedPointerTests.cpp

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   include/fastdds/rtps/writer/ReaderLocator.h
	both modified:   include/fastdds/rtps/writer/ReaderProxy.h
	both modified:   src/cpp/rtps/RTPSDomain.cpp
	both modified:   src/cpp/rtps/RTPSDomainImpl.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
	deleted by us:   src/cpp/rtps/reader/BaseReader.hpp
	both modified:   src/cpp/rtps/writer/ReaderLocator.cpp
	both modified:   src/cpp/rtps/writer/StatefulWriter.cpp
	both modified:   src/cpp/rtps/writer/StatelessWriter.cpp
	both modified:   test/blackbox/common/DDSBlackboxTestsBasic.cpp
	both modified:   test/mock/rtps/ReaderLocator/fastdds/rtps/writer/ReaderLocator.h
	both modified:   test/unittest/utils/CMakeLists.txt

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

Signed-off-by: Mario Dominguez <[email protected]>
@Mario-DL Mario-DL requested review from Mario-DL and removed request for Mario-DL November 15, 2024 09:53
@Mario-DL Mario-DL removed the conflicts Backport PR wich git cherry pick failed label Nov 15, 2024
@Mario-DL Mario-DL requested review from Mario-DL and removed request for Mario-DL November 15, 2024 09:53
@github-actions github-actions bot added the ci-pending PR which CI is running label Nov 15, 2024
…rPointer<> and add DOXYGEN_SHOULD_SKIP_THIS_PUBLIC

Signed-off-by: Mario Dominguez <[email protected]>
@Mario-DL Mario-DL requested review from Mario-DL and removed request for Mario-DL November 15, 2024 10:25
Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one stupid NIT

include/fastdds/rtps/reader/LocalReaderPointer.hpp Outdated Show resolved Hide resolved
Signed-off-by: Mario Dominguez <[email protected]>
@Mario-DL Mario-DL requested review from MiguelCompany and removed request for MiguelCompany November 15, 2024 10:39
MiguelCompany
MiguelCompany previously approved these changes Nov 15, 2024
@Mario-DL Mario-DL added ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. and removed ci-pending PR which CI is running labels Nov 20, 2024
@Mario-DL
Copy link
Member

This is RTM, failed tests are unrelated with the changes. Same failures as in nighties

@MiguelCompany MiguelCompany merged commit 28e2ce8 into 2.14.x Nov 20, 2024
13 of 18 checks passed
@MiguelCompany MiguelCompany deleted the mergify/bp/2.14.x/pr-5034 branch November 20, 2024 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge Ready to be merged. CI and changes have been reviewed and approved.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants