Do not attempt to use void allocators for memory allocation. (backport #1657) (#2004)

* Do not attempt to use void allocators for memory allocation. (#1657)

Keep a rebound allocator for byte-sized memory blocks around
for publisher and subscription options.

Follow-up after 1fc2d58799a6d4530522be5c236c70be53455e60

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
(cherry picked from commit 0659d829cec5a39c6ad861d597b4aa9aee224a25)

# Conflicts:
#	rclcpp/include/rclcpp/publisher_options.hpp
#	rclcpp/include/rclcpp/subscription_options.hpp

* fix conflicts

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>

---------

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com>
Co-authored-by: Dharini Dutia <dharini@openrobotics.org>
This commit is contained in:
mergify[bot] 2023-05-16 09:54:03 -07:00 committed by GitHub
parent cb226baa5b
commit 9c82f6c925
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 74 additions and 9 deletions

View file

@ -72,10 +72,7 @@ struct PublisherOptionsWithAllocator : public PublisherOptionsBase
to_rcl_publisher_options(const rclcpp::QoS & qos) const to_rcl_publisher_options(const rclcpp::QoS & qos) const
{ {
rcl_publisher_options_t result = rcl_publisher_get_default_options(); rcl_publisher_options_t result = rcl_publisher_get_default_options();
using AllocatorTraits = std::allocator_traits<Allocator>; result.allocator = this->get_rcl_allocator();
using MessageAllocatorT = typename AllocatorTraits::template rebind_alloc<MessageT>;
auto message_alloc = std::make_shared<MessageAllocatorT>(*this->get_allocator().get());
result.allocator = rclcpp::allocator::get_rcl_allocator<MessageT>(*message_alloc);
result.qos = qos.get_rmw_qos_profile(); result.qos = qos.get_rmw_qos_profile();
// Apply payload to rcl_publisher_options if necessary. // Apply payload to rcl_publisher_options if necessary.
@ -96,6 +93,28 @@ struct PublisherOptionsWithAllocator : public PublisherOptionsBase
} }
return this->allocator; return this->allocator;
} }
private:
using PlainAllocator =
typename std::allocator_traits<Allocator>::template rebind_alloc<char>;
rcl_allocator_t
get_rcl_allocator() const
{
if (!plain_allocator_storage_) {
plain_allocator_storage_ =
std::make_shared<PlainAllocator>(*this->get_allocator());
}
return rclcpp::allocator::get_rcl_allocator<char>(*plain_allocator_storage_);
}
// This is a temporal workaround, to make sure that get_allocator()
// always returns a copy of the same allocator.
mutable std::shared_ptr<Allocator> allocator_storage_;
// This is a temporal workaround, to keep the plain allocator that backs
// up the rcl allocator returned in rcl_publisher_options_t alive.
mutable std::shared_ptr<PlainAllocator> plain_allocator_storage_;
}; };
using PublisherOptions = PublisherOptionsWithAllocator<std::allocator<void>>; using PublisherOptions = PublisherOptionsWithAllocator<std::allocator<void>>;

View file

@ -99,10 +99,7 @@ struct SubscriptionOptionsWithAllocator : public SubscriptionOptionsBase
to_rcl_subscription_options(const rclcpp::QoS & qos) const to_rcl_subscription_options(const rclcpp::QoS & qos) const
{ {
rcl_subscription_options_t result = rcl_subscription_get_default_options(); rcl_subscription_options_t result = rcl_subscription_get_default_options();
using AllocatorTraits = std::allocator_traits<Allocator>; result.allocator = this->get_rcl_allocator();
using MessageAllocatorT = typename AllocatorTraits::template rebind_alloc<MessageT>;
auto message_alloc = std::make_shared<MessageAllocatorT>(*this->get_allocator().get());
result.allocator = allocator::get_rcl_allocator<MessageT>(*message_alloc);
result.qos = qos.get_rmw_qos_profile(); result.qos = qos.get_rmw_qos_profile();
result.rmw_subscription_options.ignore_local_publications = this->ignore_local_publications; result.rmw_subscription_options.ignore_local_publications = this->ignore_local_publications;
@ -123,6 +120,28 @@ struct SubscriptionOptionsWithAllocator : public SubscriptionOptionsBase
} }
return this->allocator; return this->allocator;
} }
private:
using PlainAllocator =
typename std::allocator_traits<Allocator>::template rebind_alloc<char>;
rcl_allocator_t
get_rcl_allocator() const
{
if (!plain_allocator_storage_) {
plain_allocator_storage_ =
std::make_shared<PlainAllocator>(*this->get_allocator());
}
return rclcpp::allocator::get_rcl_allocator<char>(*plain_allocator_storage_);
}
// This is a temporal workaround, to make sure that get_allocator()
// always returns a copy of the same allocator.
mutable std::shared_ptr<Allocator> allocator_storage_;
// This is a temporal workaround, to keep the plain allocator that backs
// up the rcl allocator returned in rcl_subscription_options_t alive.
mutable std::shared_ptr<PlainAllocator> plain_allocator_storage_;
}; };
using SubscriptionOptions = SubscriptionOptionsWithAllocator<std::allocator<void>>; using SubscriptionOptions = SubscriptionOptionsWithAllocator<std::allocator<void>>;

View file

@ -30,7 +30,7 @@
static uint32_t num_allocs = 0; static uint32_t num_allocs = 0;
static uint32_t num_deallocs = 0; static uint32_t num_deallocs = 0;
// A very simple custom allocator. Counts calls to allocate and deallocate. // A very simple custom allocator. Counts calls to allocate and deallocate.
template<typename T = void> template<typename T>
struct MyAllocator struct MyAllocator
{ {
public: public:
@ -77,6 +77,33 @@ public:
}; };
}; };
// Explicit specialization for void
template<>
struct MyAllocator<void>
{
public:
using value_type = void;
using pointer = void *;
using const_pointer = const void *;
MyAllocator() noexcept
{
}
~MyAllocator() noexcept {}
template<typename U>
MyAllocator(const MyAllocator<U> &) noexcept
{
}
template<typename U>
struct rebind
{
typedef MyAllocator<U> other;
};
};
template<typename T, typename U> template<typename T, typename U>
constexpr bool operator==( constexpr bool operator==(
const MyAllocator<T> &, const MyAllocator<T> &,