Skip to content

Commit

Permalink
Do not attempt to use void allocators for memory allocation. (#1657)
Browse files Browse the repository at this point in the history
Keep a rebound allocator for byte-sized memory blocks around
for publisher and subscription options.

Follow-up after 1fc2d58

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
  • Loading branch information
hidmic committed May 5, 2021
1 parent 1fc2d58 commit 0659d82
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 7 deletions.
19 changes: 18 additions & 1 deletion rclcpp/include/rclcpp/publisher_options.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ struct PublisherOptionsWithAllocator : public PublisherOptionsBase
to_rcl_publisher_options(const rclcpp::QoS & qos) const
{
rcl_publisher_options_t result = rcl_publisher_get_default_options();
result.allocator = rclcpp::allocator::get_rcl_allocator<void>(*this->get_allocator());
result.allocator = this->get_rcl_allocator();
result.qos = qos.get_rmw_qos_profile();
result.rmw_publisher_options.require_unique_network_flow_endpoints =
this->require_unique_network_flow_endpoints;
Expand Down Expand Up @@ -113,9 +113,26 @@ struct PublisherOptionsWithAllocator : public PublisherOptionsBase
}

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>>;
Expand Down
19 changes: 18 additions & 1 deletion rclcpp/include/rclcpp/subscription_options.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ struct SubscriptionOptionsWithAllocator : public SubscriptionOptionsBase
to_rcl_subscription_options(const rclcpp::QoS & qos) const
{
rcl_subscription_options_t result = rcl_subscription_get_default_options();
result.allocator = allocator::get_rcl_allocator<void>(*this->get_allocator());
result.allocator = this->get_rcl_allocator();
result.qos = qos.get_rmw_qos_profile();
result.rmw_subscription_options.ignore_local_publications = this->ignore_local_publications;
result.rmw_subscription_options.require_unique_network_flow_endpoints =
Expand All @@ -139,9 +139,26 @@ struct SubscriptionOptionsWithAllocator : public SubscriptionOptionsBase
}

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>>;
Expand Down
34 changes: 29 additions & 5 deletions rclcpp/test/rclcpp/test_intra_process_manager_with_allocators.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
static uint32_t num_allocs = 0;
static uint32_t num_deallocs = 0;
// A very simple custom allocator. Counts calls to allocate and deallocate.
template<typename T = void>
template<typename T>
struct MyAllocator
{
public:
Expand All @@ -58,10 +58,7 @@ struct MyAllocator
return nullptr;
}
num_allocs++;
// Use sizeof(char) in place for sizeof(void)
constexpr size_t value_size = sizeof(
typename std::conditional<!std::is_void<T>::value, T, char>::type);
return static_cast<T *>(std::malloc(size * value_size));
return static_cast<T *>(std::malloc(size * sizeof(T)));
}

void deallocate(T * ptr, size_t size)
Expand All @@ -81,6 +78,33 @@ struct MyAllocator
};
};

// 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>
constexpr bool operator==(
const MyAllocator<T> &,
Expand Down

0 comments on commit 0659d82

Please sign in to comment.