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.

Sign up for GitHub

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

Jump to bottom

[21121] IPayloadPool refactor #4892

Merged
merged 23 commits into from
Jun 12, 2024
Merged

[21121] IPayloadPool refactor #4892

merged 23 commits into from
Jun 12, 2024

Conversation

cferreiragonz
Copy link
Contributor

@cferreiragonz cferreiragonz commented Jun 4, 2024 •
edited by MiguelCompany
Loading

Description

This PR adds two main changes:

  1. It moves payload_owner_ from CacheChange_t to SerializedPayload_t
  2. Refactors IPayloadPool class and all derived classes to only manage SerializedPayload_t, instead of CacheChange_t
  3. get_payload() methods refactor
  4. SerializedPayload_t copies are forbidden

In this way, the payload_owner_ is no longer related to a cache change, but to the payload it refers.

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.
  • New feature has been added to the versions.md file (if applicable).
  • 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.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

@cferreiragonz cferreiragonz added the needs-review PR that is ready to be reviewed label Jun 4, 2024
@cferreiragonz cferreiragonz added this to the v3.0.0 milestone Jun 4, 2024
@cferreiragonz
Copy link
Contributor Author

Since the payload_owner_ now belongs to the SerializedPayload_t, I believe the get_payload() method receiving a source SerializedPayload_t&, an IPayloadPool* and a destination SerializedPayload_t& could be simplified removing the IPayloadPool* parameter, as it is already contained in the source payload. I let the reviewer the decision of keeping it or not.

@github-actions github-actions bot added the ci-pending PR which CI is running label Jun 5, 2024
This was referenced Jun 5, 2024
Merged
Merged
@cferreiragonz cferreiragonz force-pushed the feature/ipayloadpool_refactor branch from 0588ba0 to 195b875 Compare June 5, 2024 13:40
@cferreiragonz cferreiragonz requested review from MiguelCompany and removed request for MiguelCompany June 5, 2024 13:40
@MiguelCompany MiguelCompany mentioned this pull request Jun 6, 2024
Merged
12 tasks
MiguelCompany
MiguelCompany requested changes Jun 6, 2024
View reviewed changes
include/fastdds/rtps/common/CacheChange.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/SerializedPayload.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/SerializedPayload.h Outdated Show resolved Hide resolved
include/fastdds/rtps/history/IPayloadPool.h Outdated Show resolved Hide resolved
include/fastdds/rtps/history/IPayloadPool.h Outdated Show resolved Hide resolved
src/cpp/fastdds/subscriber/DataReaderImpl/SampleLoanManager.hpp Outdated Show resolved Hide resolved
src/cpp/fastdds/subscriber/DataReaderImpl/SampleLoanManager.hpp Show resolved Hide resolved
src/cpp/fastdds/subscriber/DataReaderImpl/SampleLoanManager.hpp Outdated Show resolved Hide resolved
src/cpp/rtps/DataSharing/ReaderPool.hpp Outdated Show resolved Hide resolved
src/cpp/rtps/common/PayloadInfo_t.hpp Outdated Show resolved Hide resolved
MiguelCompany
MiguelCompany requested changes Jun 6, 2024
View reviewed changes
include/fastdds/rtps/history/IPayloadPool.h Outdated Show resolved Hide resolved
src/cpp/fastdds/publisher/DataWriterImpl.hpp Outdated Show resolved Hide resolved
src/cpp/fastdds/publisher/DataWriterImpl.hpp Outdated Show resolved Hide resolved
src/cpp/fastdds/subscriber/DataReaderImpl/SampleLoanManager.hpp Outdated Show resolved Hide resolved
include/fastdds/rtps/common/SerializedPayload.h Outdated Show resolved Hide resolved
src/cpp/fastdds/publisher/DataWriterImpl.cpp Outdated Show resolved Hide resolved
@MiguelCompany MiguelCompany self-requested a review June 6, 2024 14:50
MiguelCompany
MiguelCompany previously approved these changes Jun 6, 2024
View reviewed changes
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.

LGTM with green CI

@MiguelCompany MiguelCompany removed the needs-review PR that is ready to be reviewed label Jun 6, 2024
@cferreiragonz cferreiragonz force-pushed the feature/ipayloadpool_refactor branch from 0928c99 to e023500 Compare June 7, 2024 11:23
@cferreiragonz cferreiragonz requested review from MiguelCompany and removed request for MiguelCompany June 7, 2024 11:23
@elianalf elianalf added the to-do label Jun 10, 2024
@cferreiragonz cferreiragonz force-pushed the feature/ipayloadpool_refactor branch from 0c8fb40 to 0edef49 Compare June 11, 2024 06:04
@MiguelCompany MiguelCompany added needs-review PR that is ready to be reviewed and removed to-do labels Jun 11, 2024
@MiguelCompany MiguelCompany requested review from MiguelCompany and removed request for MiguelCompany June 11, 2024 06:20
MiguelCompany
MiguelCompany requested changes Jun 11, 2024
View reviewed changes
include/fastdds/rtps/common/SerializedPayload.h Outdated Show resolved Hide resolved
include/fastdds/rtps/history/IPayloadPool.h Outdated Show resolved Hide resolved
include/fastdds/rtps/history/IPayloadPool.h Outdated Show resolved Hide resolved
src/cpp/rtps/reader/StatefulReader.cpp Outdated Show resolved Hide resolved
src/cpp/rtps/reader/StatelessReader.cpp Outdated Show resolved Hide resolved
@cferreiragonz
Refs #21121: Remove unnecessary parameter
b8eaa9a 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Move payload destructor
709bcc4 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Avoid unsetting payload_owner
cffd43c 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Fix LoanManager
f997218 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Revision - remove getters/setter
514b5d2 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Revision - avoid tmp change
c3bd8ae 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Revision - remove PayloadInfo
a20fee2 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Revision - uncrustify
e5c905a 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Revision - minor changes
57b5f2f 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Avoid cyclic release
7b00e19 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Fix Loan ser_payload destruction
1725df2 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Avoid SerializedPayload_t copies
852ea53 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz
Refs #21121: Make get_payload's first arg const
4331af5 
Signed-off-by: cferreiragonz <[email protected]>
@cferreiragonz cferreiragonz force-pushed the feature/ipayloadpool_refactor branch from 2e8424b to 432b2ba Compare June 11, 2024 13:54
@cferreiragonz cferreiragonz force-pushed the feature/ipayloadpool_refactor branch from 432b2ba to e383089 Compare June 11, 2024 14:08
@MiguelCompany MiguelCompany self-requested a review June 11, 2024 14:20
@MiguelCompany
Copy link
Member

@richiprosima Please test_3 discovery-server

@cferreiragonz cferreiragonz 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 Jun 12, 2024
@MiguelCompany
Copy link
Member

Checked locally that discovery server tests pass with this and #4932. Ready to merge.

@MiguelCompany
Copy link
Member

@richiprosima Please test_3 discovery-server because #4932 has just been merged

@MiguelCompany
Copy link
Member

@richiprosima Please test_3 discovery-server with updated ci branch

@MiguelCompany
Copy link
Member

@richiprosima Please test_3 discovery-server because I made a mistake in the jenkins job configuration

@MiguelCompany MiguelCompany merged commit 3780507 into master Jun 12, 2024
11 of 12 checks passed
@MiguelCompany MiguelCompany deleted the feature/ipayloadpool_refactor branch June 12, 2024 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MiguelCompany MiguelCompany Awaiting requested review from MiguelCompany

Assignees
No one assigned
Labels
ready-to-merge Ready to be merged. CI and changes have been reviewed and approved.
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@cferreiragonz @MiguelCompany @elianalf