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

[21751] Discard changes with big key-only payload and no key hash #5262

Merged
merged 9 commits into from
Sep 27, 2024
Merged

[21751] Discard changes with big key-only payload and no key hash #5262

merged 9 commits into from
Sep 27, 2024

Conversation

MiguelCompany
Copy link
Member

@MiguelCompany MiguelCompany commented Sep 25, 2024 •
edited by richiware
Loading

Description

We currently don't have support for key-only payloads bigger than the KEY_HASH length.
Receiving such kind of messages produces a segfault in DataReaderHistory.

This PR adds a regression test reproducing the issue, and fixes it by considering the incoming change as irrelevant.
It has been done this way so it is acknowledged in reliable topics, thus avoiding the offending data to be resent.

@Mergifyio backport 2.14.x 2.10.x

@Mergifyio backport 2.6.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
  • 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.
  • 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.

@MiguelCompany
Refs #21707. Regression test.
ae9ca37 
Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany added this to the v3.0.2 milestone Sep 25, 2024
@github-actions github-actions bot added the ci-pending PR which CI is running label Sep 25, 2024
@MiguelCompany MiguelCompany requested review from richiprosima and removed request for richiprosima September 25, 2024 08:55
richiware
richiware requested changes Sep 26, 2024
View reviewed changes
test/blackbox/common/BlackboxTestsTransportUDP.cpp Show resolved Hide resolved
test/blackbox/common/BlackboxTestsTransportUDP.cpp Show resolved Hide resolved
src/cpp/rtps/reader/reader_utils.cpp Outdated Show resolved Hide resolved
src/cpp/rtps/messages/MessageReceiver.cpp Outdated Show resolved Hide resolved
@MiguelCompany
Copy link
Member Author

@Mergifyio backport 2.14.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 27, 2024 •
edited
Loading

backport 2.14.x

✅ Backports have been created

@MiguelCompany MiguelCompany merged commit 175add5 into master Sep 27, 2024
17 checks passed
@MiguelCompany MiguelCompany deleted the bugfix/21707 branch September 27, 2024 08:16
mergify bot pushed a commit that referenced this pull request Sep 27, 2024
@MiguelCompany @mergify
Discard changes with big key-only payload and no key hash (#5262)
ae06dbc 
* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)
@mergify mergify bot mentioned this pull request Sep 27, 2024
Merged
12 tasks
@MiguelCompany
Copy link
Member Author

@Mergifyio backport 2.10.x 2.6.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 27, 2024 •
edited
Loading

backport 2.10.x 2.6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Sep 27, 2024
@MiguelCompany @mergify
Discard changes with big key-only payload and no key hash (#5262)
eb73324 
* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)

# Conflicts:
#	test/blackbox/common/BlackboxTestsTransportUDP.cpp
@mergify mergify bot mentioned this pull request Sep 27, 2024
Merged
12 tasks
mergify bot pushed a commit that referenced this pull request Sep 27, 2024
@MiguelCompany @mergify
Discard changes with big key-only payload and no key hash (#5262)
1ad267d 
* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)

# Conflicts:
#	src/cpp/rtps/messages/MessageReceiver.cpp
#	test/blackbox/common/BlackboxTestsTransportUDP.cpp
@mergify mergify bot mentioned this pull request Sep 27, 2024
Merged
12 tasks
MiguelCompany added a commit that referenced this pull request Oct 2, 2024
@mergify @MiguelCompany
Discard changes with big key-only payload and no key hash (#5262) (#5274
0e133f9 
)

* Discard changes with big key-only payload and no key hash (#5262)

* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)

* Fix build

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
MiguelCompany added a commit that referenced this pull request Oct 4, 2024
@mergify @MiguelCompany @Mario-DL
Discard changes with big key-only payload and no key hash (#5262) (#5276
cf3f810 
)

* Discard changes with big key-only payload and no key hash (#5262)

* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)

# Conflicts:
#	src/cpp/rtps/messages/MessageReceiver.cpp
#	test/blackbox/common/BlackboxTestsTransportUDP.cpp

* Fix conflicts
Signed-off-by: Miguel Company <[email protected]>

* Additional fixes

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

---------

Signed-off-by: Mario Dominguez <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
Co-authored-by: Mario Dominguez <[email protected]>
MiguelCompany added a commit that referenced this pull request Oct 17, 2024
@mergify @MiguelCompany
Discard changes with big key-only payload and no key hash (#5262) (#5275
42a06b3 
)

* Discard changes with big key-only payload and no key hash (#5262)

* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)

# Conflicts:
#	test/blackbox/common/BlackboxTestsTransportUDP.cpp

* Fix conflicts

Signed-off-by: Miguel Company <[email protected]>

* Fix build

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@richiware richiware richiware approved these changes

@richiprosima richiprosima Awaiting requested review from richiprosima

Assignees
No one assigned
Labels
ci-pending PR which CI is running
Projects
None yet
Milestone
v3.0.2
Development

Successfully merging this pull request may close these issues.
2 participants
@MiguelCompany @richiware