[16647] Use shared_ptr for internal singletons #3185

MiguelCompany · 2023-01-04T07:21:12Z

Description

The changes include using shared pointers for the internal singletons of RTPSDomainImpl and LogResources, and keeping a reference to both on DomainParticipantFactory.

I consider the changes ABI safe, because the only ABI incompatibility is on the size of DomainParticipantFactory, where two shared pointers are added at the end. Since the factory cannot be directly constructed by the user (and thus cannot be instantiated on the stack), there's no way of having ABI issues. I already checked that by building the examples before the changes, and updating the shared library after the changes.

This is related to #2537, and can be considered a follow-up of #2894.

@Mergifyio backport 2.8.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.
Any new/modified methods have been properly documented using Doxygen.
Fast DDS test suite has been run locally.
Changes are ABI compatible.
Changes are API compatible.
Documentation builds and tests pass locally.
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.

Reviewer Checklist

Check contributor checklist is correct.
Check CI results: changes do not issue any warning.
Check CI results: failing tests are unrelated with the changes.

MiguelCompany · 2023-01-05T14:22:46Z

@richiprosima Please test this.

MiguelCompany · 2023-01-12T14:32:29Z

@richiprosima Please test this

MiguelCompany · 2023-01-13T08:11:32Z

@richiprosima Please test this

MiguelCompany · 2023-01-13T08:14:06Z

@richiprosima Please test this

MiguelCompany · 2023-01-13T08:51:07Z

@richiprosima Please test this

MiguelCompany · 2023-01-13T11:11:34Z

@richiprosima Please test this

MiguelCompany · 2023-01-13T15:10:07Z

@richiprosima Please test this

MiguelCompany · 2023-01-13T19:50:10Z

@richiprosima Please test this

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

…Impl instance. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

…ory. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

…thread. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

MiguelCompany · 2023-01-13T19:54:02Z

@richiprosima Please test this

src/cpp/utils/shared_memory/BoostAtExitRegistry.hpp

src/cpp/rtps/RTPSDomainImpl.hpp

jsan-rt

LGTM

jsan-rt · 2023-01-16T13:48:06Z

@richiprosima please test this

… function execution. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

jsan-rt

This still LGTM.

MiguelCompany · 2023-01-17T08:43:48Z

@Mergifyio backport 2.8.x

* Refs #16647. Moved RTPSDomain::getNewId to source file. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Moved RTPSDomain implementation to RTPSDomainImpl. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Using shared_ptr for singleton data. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. DomainParticipantFactory keeps a reference to RTPSDomainImpl instance. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Use method to access Log resources. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Refactor Log KillThread. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Using shared_ptr for Log Resouces. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Rename struct into LogResources. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Rename instance getter. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Make instance getter available on private header. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. DomainParticipantFactory keeps a reference to LogResources. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Removed unused method for_each_participant. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Add instance getter to RTPSDomainImpl mock. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Moved mock for clientServerEnvironmentCreationOverride. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Allow injection of custom exit work registration. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. New helper singleton for registering atexit functions. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Using new helper for registering boost at_exit_work. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. SharedSegmentBase keeps reference to BoostAtExitRegistry Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. RobustInterprocessCondition keeps reference to BoostAtExitRegistry Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Removed AuxiliaryBoostFunctor from DomainParticipantFactory. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Add src/cpp to include directories when using try_compile Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Keep raw reference to resources on Log::Run. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Safety checks on LogResources::KillThread. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Kill log thread on test shutdown. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Moved Log::preprocess to LogResources. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Moved Log::run to LogResources. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Moved Log implementation to LogResources. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. Flush log on destruction of LogResources before killing thread. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. LogResources moved into detail namespace. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. LogResources attributes made private. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> * Refs #16647. BoostAtExitRegistry allows registering a function during function execution. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> (cherry picked from commit f6670e3) # Conflicts: # src/cpp/rtps/RTPSDomain.cpp # src/cpp/utils/shared_memory/SharedMemSegment.hpp

mergify · 2023-01-17T08:44:07Z

backport 2.8.x

✅ Backports have been created

#3215 [16647] Use shared_ptr for internal singletons (backport #3185) has been created for branch 2.8.x

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from f75eecc to acb6087 Compare January 4, 2023 09:56

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from 5340565 to 4eb1d6c Compare January 13, 2023 07:44

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from 0bedfd3 to c2aa5dc Compare January 13, 2023 08:13

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from 8c9c4d2 to 4d91f1e Compare January 13, 2023 12:18

MiguelCompany marked this pull request as ready for review January 13, 2023 12:19

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from 4d91f1e to ed421d6 Compare January 13, 2023 19:48

MiguelCompany added 16 commits January 13, 2023 20:53

Refs #16647. Moved RTPSDomain::getNewId to source file.

b960827

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Moved RTPSDomain implementation to RTPSDomainImpl.

7561376

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Using shared_ptr for singleton data.

9770438

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. DomainParticipantFactory keeps a reference to RTPSDomain…

49d4528

…Impl instance. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Use method to access Log resources.

ad1fee9

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Refactor Log KillThread.

f93e587

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Using shared_ptr for Log Resouces.

7f456d3

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Rename struct into LogResources.

3b069bb

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Rename instance getter.

d6397a1

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Make instance getter available on private header.

5b8b875

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. DomainParticipantFactory keeps a reference to LogResources.

94c8553

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Removed unused method for_each_participant.

786c2f6

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Add instance getter to RTPSDomainImpl mock.

a067bea

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Moved mock for clientServerEnvironmentCreationOverride.

5d0835d

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Allow injection of custom exit work registration.

a9e96a0

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. New helper singleton for registering atexit functions.

dfc268c

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

MiguelCompany added 11 commits January 13, 2023 20:53

Refs #16647. Removed AuxiliaryBoostFunctor from DomainParticipantFact…

2d07899

…ory. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Add src/cpp to include directories when using try_compile

603b666

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Keep raw reference to resources on Log::Run.

67a32c0

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Safety checks on LogResources::KillThread.

fd1ad93

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Kill log thread on test shutdown.

cfbdfc3

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Moved Log::preprocess to LogResources.

2e2c6dc

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Moved Log::run to LogResources.

f24a144

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Moved Log implementation to LogResources.

20f52ef

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. Flush log on destruction of LogResources before killing …

21b4ead

…thread. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. LogResources moved into detail namespace.

e406b53

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

Refs #16647. LogResources attributes made private.

8261245

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from ed421d6 to 8261245 Compare January 13, 2023 19:53

jsan-rt suggested changes Jan 16, 2023

View reviewed changes

src/cpp/utils/shared_memory/BoostAtExitRegistry.hpp Outdated Show resolved Hide resolved

src/cpp/rtps/RTPSDomainImpl.hpp Show resolved Hide resolved

jsan-rt previously approved these changes Jan 16, 2023

View reviewed changes

MiguelCompany added the ci-pending PR which CI is running label Jan 16, 2023

Refs #16647. BoostAtExitRegistry allows registering a function during…

69f3834

… function execution. Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

MiguelCompany dismissed jsan-rt’s stale review via 69f3834 January 16, 2023 14:24

MiguelCompany force-pushed the feature/shared-ptr-singletons branch from d2458f0 to 69f3834 Compare January 16, 2023 14:24

jsan-rt approved these changes Jan 16, 2023

View reviewed changes

MiguelCompany merged commit f6670e3 into master Jan 17, 2023

MiguelCompany deleted the feature/shared-ptr-singletons branch January 17, 2023 08:43

mergify bot mentioned this pull request Jan 17, 2023

[16647] Use shared_ptr for internal singletons (backport #3185) #3215

Closed

maloel mentioned this pull request Jan 22, 2023

merge development (utilities) to dds IntelRealSense/librealsense#11145

Merged

jsan-rt mentioned this pull request Feb 14, 2023

[16979] Moved boost at_exit registration to RTPSDomainImpl #3298

Merged

9 tasks

JLBuenoLopez mentioned this pull request Jun 8, 2023

SIGSEGV in removeRTPSReader on application exit [13602] #1906

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[16647] Use shared_ptr for internal singletons #3185

[16647] Use shared_ptr for internal singletons #3185

MiguelCompany commented Jan 4, 2023 •

edited

Loading

MiguelCompany commented Jan 5, 2023

MiguelCompany commented Jan 12, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

jsan-rt left a comment

jsan-rt commented Jan 16, 2023

jsan-rt left a comment

MiguelCompany commented Jan 17, 2023

mergify bot commented Jan 17, 2023

[16647] Use shared_ptr for internal singletons #3185

[16647] Use shared_ptr for internal singletons #3185

Conversation

MiguelCompany commented Jan 4, 2023 • edited Loading

Description

Contributor Checklist

Reviewer Checklist

MiguelCompany commented Jan 5, 2023

MiguelCompany commented Jan 12, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

MiguelCompany commented Jan 13, 2023

jsan-rt left a comment

Choose a reason for hiding this comment

jsan-rt commented Jan 16, 2023

jsan-rt left a comment

Choose a reason for hiding this comment

MiguelCompany commented Jan 17, 2023

mergify bot commented Jan 17, 2023

✅ Backports have been created

MiguelCompany commented Jan 4, 2023 •

edited

Loading