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.

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

Merged
merged 5 commits into from
Mar 3, 2025
Merged

[22841] Improve max_allocations calculation on SHM transport #5659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
49ec98d
Refs #22841. Improve max_allocations calculation.
MiguelCompany Feb 21, 2025
dda12d6
Refs #22841. Consider a mean message size of half the max message size.
MiguelCompany Feb 24, 2025
afb663d
Refs #22841. Move `shm_default_segment_size` to global scope.
MiguelCompany Feb 28, 2025
f179ca4
Refs #22841. Move `SharedMemTransportDescriptor` constants.
MiguelCompany Feb 28, 2025
9ab6df6
Refs #22841. Change calculation of `mean_message_size`.
MiguelCompany Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions include/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#ifndef FASTDDS_RTPS_TRANSPORT_SHARED_MEM__SHAREDMEMTRANSPORTDESCRIPTOR_HPP
#define FASTDDS_RTPS_TRANSPORT_SHARED_MEM__SHAREDMEMTRANSPORTDESCRIPTOR_HPP

#include <cstdint>
#include <string>

#include <fastdds/rtps/attributes/ThreadSettings.hpp>
Expand Down Expand Up @@ -48,6 +49,10 @@ class TransportInterface;
*/
struct SharedMemTransportDescriptor : public PortBasedTransportDescriptor
{
static constexpr uint32_t shm_default_segment_size = 0;
static constexpr uint32_t shm_default_port_queue_capacity = 512;
static constexpr uint32_t shm_default_healthy_check_timeout_ms = 1000;

//! Destructor
virtual ~SharedMemTransportDescriptor() = default;

Expand Down Expand Up @@ -154,13 +159,13 @@ struct SharedMemTransportDescriptor : public PortBasedTransportDescriptor

private:

uint32_t segment_size_;
uint32_t port_queue_capacity_;
uint32_t healthy_check_timeout_ms_;
std::string rtps_dump_file_;
uint32_t segment_size_ = shm_default_segment_size;
uint32_t port_queue_capacity_ = shm_default_port_queue_capacity;
uint32_t healthy_check_timeout_ms_ = shm_default_healthy_check_timeout_ms;
std::string rtps_dump_file_ {""};

//! Thread settings for the transport dump thread
ThreadSettings dump_thread_;
ThreadSettings dump_thread_ {};

};

Expand Down
17 changes: 13 additions & 4 deletions src/cpp/rtps/transport/shared_mem/SharedMemTransport.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// limitations under the License.

#include <algorithm>
#include <cstdint>
#include <cstring>
#include <thread>
#include <utility>
Expand All @@ -26,6 +27,7 @@
#include <fastdds/rtps/common/Locator.hpp>
#include <fastdds/rtps/transport/SenderResource.hpp>
#include <fastdds/rtps/transport/TransportInterface.hpp>
#include <fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.hpp>

#include <rtps/messages/CDRMessage.hpp>
#include <rtps/messages/MessageReceiver.h>
Expand All @@ -45,6 +47,9 @@ namespace eprosima {
namespace fastdds {
namespace rtps {

// TODO(Adolfo): Calculate this value from UDP sockets buffers size.
static constexpr uint32_t shm_default_segment_size = 512 * 1024;

TransportInterface* SharedMemTransportDescriptor::create_transport() const
{
return new SharedMemTransport(*this);
Expand Down Expand Up @@ -271,8 +276,6 @@ bool SharedMemTransport::init(
const uint32_t& max_msg_size_no_frag)
{
(void) max_msg_size_no_frag;
// TODO(Adolfo): Calculate this value from UDP sockets buffers size.
static constexpr uint32_t shm_default_segment_size = 512 * 1024;

if (configuration_.segment_size() == 0)
{
Expand Down Expand Up @@ -301,8 +304,14 @@ bool SharedMemTransport::init(
{
return false;
}
shared_mem_segment_ = shared_mem_manager_->create_segment(configuration_.segment_size(),
configuration_.port_queue_capacity());
constexpr uint32_t mean_message_size =
shm_default_segment_size / SharedMemTransportDescriptor::shm_default_port_queue_capacity;
uint32_t max_allocations = configuration_.segment_size() / mean_message_size;
if (configuration_.port_queue_capacity() > max_allocations)
{
max_allocations = configuration_.port_queue_capacity();
}
shared_mem_segment_ = shared_mem_manager_->create_segment(configuration_.segment_size(), max_allocations);

// Memset the whole segment to zero in order to force physical map of the buffer
auto buffer = shared_mem_segment_->alloc_buffer(configuration_.segment_size(),
Expand Down
8 changes: 0 additions & 8 deletions src/cpp/rtps/transport/shared_mem/SharedMemTransportDescriptor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,11 @@ namespace eprosima {
namespace fastdds {
namespace rtps {

static constexpr uint32_t shm_default_segment_size = 0;
static constexpr uint32_t shm_default_port_queue_capacity = 512;
static constexpr uint32_t shm_default_healthy_check_timeout_ms = 1000;

//*********************************************************
// SharedMemTransportDescriptor
//*********************************************************
SharedMemTransportDescriptor::SharedMemTransportDescriptor()
: PortBasedTransportDescriptor(shm_default_segment_size, s_maximumInitialPeersRange)
, segment_size_(shm_default_segment_size)
, port_queue_capacity_(shm_default_port_queue_capacity)
, healthy_check_timeout_ms_(shm_default_healthy_check_timeout_ms)
, rtps_dump_file_("")
{
maxMessageSize = s_maximumMessageSize;
}
Expand Down
14 changes: 9 additions & 5 deletions ...MemTransportDescriptor/fastdds/rtps/transport/shared_mem/SharedMemTransportDescriptor.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,12 @@ class TransportInterface;
*
* @ingroup TRANSPORT_MODULE
*/
typedef struct SharedMemTransportDescriptor : public PortBasedTransportDescriptor
struct SharedMemTransportDescriptor : public PortBasedTransportDescriptor
{
static constexpr uint32_t shm_default_segment_size = 0;
static constexpr uint32_t shm_default_port_queue_capacity = 512;
static constexpr uint32_t shm_default_healthy_check_timeout_ms = 1000;

virtual ~SharedMemTransportDescriptor()
{

Expand Down Expand Up @@ -130,13 +134,13 @@ typedef struct SharedMemTransportDescriptor : public PortBasedTransportDescripto

private:

uint32_t segment_size_;
uint32_t port_queue_capacity_;
uint32_t healthy_check_timeout_ms_;
uint32_t segment_size_ = shm_default_segment_size;
uint32_t port_queue_capacity_ = shm_default_port_queue_capacity;
uint32_t healthy_check_timeout_ms_ = shm_default_healthy_check_timeout_ms;
std::string rtps_dump_file_;
ThreadSettings dump_thread_;

}SharedMemTransportDescriptor;
};

} // namespace rtps
} // namespace fastdds
Expand Down
Loading