Skip to content

[22841] Improve max_allocations calculation on SHM transport (backport #5659) #5676

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 2 commits into from
Mar 6, 2025

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 3, 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.

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

* 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
Copy link
Contributor Author

mergify bot commented Mar 3, 2025

Cherry-pick of b54cb8e has failed:

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

You are currently cherry-picking commit b54cb8ef.
  (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)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   include/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.h
	both modified:   src/cpp/rtps/transport/shared_mem/SharedMemTransport.cpp
	both modified:   src/cpp/rtps/transport/shared_mem/SharedMemTransportDescriptor.cpp
	both modified:   test/mock/rtps/SharedMemTransportDescriptor/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.h

no changes added to commit (use "git add" and/or "git commit -a")

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

@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Mar 3, 2025
@MiguelCompany MiguelCompany added this to the v2.10.7 milestone Mar 3, 2025
Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany removed the conflicts Backport PR wich git cherry pick failed label Mar 3, 2025
@MiguelCompany MiguelCompany self-requested a review March 3, 2025 13:49
@github-actions github-actions bot added the ci-pending PR which CI is running label Mar 3, 2025
@MiguelCompany MiguelCompany requested review from MiguelCompany and removed request for MiguelCompany March 4, 2025 15:53
@MiguelCompany MiguelCompany merged commit 37230ac into 2.10.x Mar 6, 2025
36 of 48 checks passed
@MiguelCompany MiguelCompany deleted the mergify/bp/2.10.x/pr-5659 branch March 6, 2025 15:31
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.

1 participant