Skip to content

[22841] Improve max_allocations calculation on SHM transport #5659

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

Merged
merged 5 commits into from
Mar 3, 2025

Conversation

MiguelCompany
Copy link
Member

@MiguelCompany MiguelCompany commented Feb 21, 2025

Description

This PR improves SHM transport throughput by changing the calculation of the maximum number of allocated buffers.
It will now be the maximum between segment size / mean_message_size and the configured port_queue_capacity.

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

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • NO: 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
    • I couldn't find a way to make a regression test, other than running a complex scenario and manually inspecting the results.
  • 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 MiguelCompany added this to the v3.2.0 milestone Feb 21, 2025
@MiguelCompany MiguelCompany requested review from richiprosima and removed request for richiprosima February 21, 2025 10:55
@github-actions github-actions bot added the ci-pending PR which CI is running label Feb 21, 2025
@MiguelCompany MiguelCompany requested review from richiprosima and removed request for richiprosima February 24, 2025 13:48
@MiguelCompany MiguelCompany requested review from EugenioCollado and removed request for EugenioCollado February 28, 2025 09:47
Copy link
Contributor

@EugenioCollado EugenioCollado 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
Copy link
Member Author

The test that failed on Ubuntu CI is also happening from time to time on the nightlies, so it is unrelated to this PR.

@MiguelCompany MiguelCompany merged commit b54cb8e into master Mar 3, 2025
16 of 17 checks passed
@MiguelCompany MiguelCompany deleted the bugfix/22841/master branch March 3, 2025 13:20
@MiguelCompany
Copy link
Member Author

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

Copy link
Contributor

mergify bot commented Mar 3, 2025

backport 3.1.x 2.14.x 2.10.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Mar 3, 2025
* Refs #22841. Improve max_allocations calculation.

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

* Refs #22841. Consider a mean message size of half the max message size.

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

* Refs #22841. Move `shm_default_segment_size` to global scope.

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

* Refs #22841. Move `SharedMemTransportDescriptor` constants.

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

* Refs #22841. Change calculation of `mean_message_size`.

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

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit b54cb8e)
mergify bot pushed a commit that referenced this pull request Mar 3, 2025
* Refs #22841. Improve max_allocations calculation.

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

* Refs #22841. Consider a mean message size of half the max message size.

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

* Refs #22841. Move `shm_default_segment_size` to global scope.

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

* Refs #22841. Move `SharedMemTransportDescriptor` constants.

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

* Refs #22841. Change calculation of `mean_message_size`.

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

---------

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

# Conflicts:
#	src/cpp/rtps/transport/shared_mem/SharedMemTransport.cpp
#	src/cpp/rtps/transport/shared_mem/SharedMemTransportDescriptor.cpp
mergify bot pushed a commit that referenced this pull request Mar 3, 2025
* Refs #22841. Improve max_allocations calculation.

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

* Refs #22841. Consider a mean message size of half the max message size.

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

* Refs #22841. Move `shm_default_segment_size` to global scope.

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

* Refs #22841. Move `SharedMemTransportDescriptor` constants.

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

* Refs #22841. Change calculation of `mean_message_size`.

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

---------

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

# Conflicts:
#	include/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.h
#	src/cpp/rtps/transport/shared_mem/SharedMemTransport.cpp
#	src/cpp/rtps/transport/shared_mem/SharedMemTransportDescriptor.cpp
#	test/mock/rtps/SharedMemTransportDescriptor/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.h
MiguelCompany added a commit that referenced this pull request Mar 4, 2025
* Improve `max_allocations` calculation on SHM transport (#5659)

* Refs #22841. Improve max_allocations calculation.

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

* Refs #22841. Consider a mean message size of half the max message size.

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

* Refs #22841. Move `shm_default_segment_size` to global scope.

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

* Refs #22841. Move `SharedMemTransportDescriptor` constants.

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

* Refs #22841. Change calculation of `mean_message_size`.

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

---------

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

# Conflicts:
#	src/cpp/rtps/transport/shared_mem/SharedMemTransport.cpp
#	src/cpp/rtps/transport/shared_mem/SharedMemTransportDescriptor.cpp

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

---------

Co-authored-by: Miguel Company <[email protected]>
MiguelCompany added a commit that referenced this pull request Mar 5, 2025
* Refs #22841. Improve max_allocations calculation.

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

* Refs #22841. Consider a mean message size of half the max message size.

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

* Refs #22841. Move `shm_default_segment_size` to global scope.

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

* Refs #22841. Move `SharedMemTransportDescriptor` constants.

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

* Refs #22841. Change calculation of `mean_message_size`.

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

---------

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

Co-authored-by: Miguel Company <[email protected]>
MiguelCompany added a commit that referenced this pull request Mar 6, 2025
* Improve `max_allocations` calculation on SHM transport (#5659)

* Refs #22841. Improve max_allocations calculation.

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

* Refs #22841. Consider a mean message size of half the max message size.

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

* Refs #22841. Move `shm_default_segment_size` to global scope.

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

* Refs #22841. Move `SharedMemTransportDescriptor` constants.

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

* Refs #22841. Change calculation of `mean_message_size`.

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

---------

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

# Conflicts:
#	include/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.h
#	src/cpp/rtps/transport/shared_mem/SharedMemTransport.cpp
#	src/cpp/rtps/transport/shared_mem/SharedMemTransportDescriptor.cpp
#	test/mock/rtps/SharedMemTransportDescriptor/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.h

* Fix conflicts.
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
Labels
ci-pending PR which CI is running
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants