Skip to content

Commit

Permalink
Recycle serialization buffers on transmission
Browse files Browse the repository at this point in the history
Adds a LIFO buffer pool in the context to reuse buffers allocated
on serialization. The aim is not (only) to avoid the overhead of
dynamic allocation but rather to enhance the cache locality of
serialization buffers.
  • Loading branch information
fuzzypixelz committed Dec 18, 2024
1 parent df6ec26 commit 62cb09b
Show file tree
Hide file tree
Showing 5 changed files with 383 additions and 298 deletions.
87 changes: 87 additions & 0 deletions rmw_zenoh_cpp/src/detail/buffer_pool.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
// Copyright 2024 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef DETAIL__BUFFER_POOL_HPP_
#define DETAIL__BUFFER_POOL_HPP_

#include <mutex>
#include <cassert>
#include <vector>

#include "rcutils/allocator.h"

// FIXME(fuzzypixelz): make allocate return the data and size
class BufferPool
{
public:
BufferPool() = default;

uint8_t * allocate(rcutils_allocator_t *allocator, size_t size)
{
// FIXME(fuzzypixelz): indeed, this methods leaks all allocated buffers ;)
std::lock_guard<std::mutex> guard(mutex_);

if (available_buffers_.empty()) {
uint8_t * data = static_cast<uint8_t *>(allocator->allocate(size, allocator->state));
if (data == nullptr) {
return nullptr;
}
Buffer buffer;
buffer.data = data;
buffer.size = size;
buffers_.push_back(buffer);
return data;
} else {
size_t available_buffer = available_buffers_.back();
Buffer & buffer = buffers_.at(available_buffer);
if (buffer.size < size) {
uint8_t * data = static_cast<uint8_t *>(allocator->reallocate(
buffer.data, size, allocator->state));
if (data == nullptr) {
return nullptr;
}
buffer.data = data;
buffer.size = size;
}
available_buffers_.pop_back();
return buffer.data;
}
}

void
deallocate(uint8_t *data)
{
std::lock_guard<std::mutex> guard(mutex_);

for (size_t i = 0; i < buffers_.size(); i++) {
if (buffers_.at(i).data == data) {
available_buffers_.push_back(i);
return;
}
}
}

private:
struct Buffer
{
uint8_t *data;
size_t size;
};

std::vector<Buffer> buffers_;
std::vector<size_t> available_buffers_;
std::mutex mutex_;
};

#endif // DETAIL__BUFFER_POOL_HPP_
4 changes: 4 additions & 0 deletions rmw_zenoh_cpp/src/detail/rmw_context_impl_s.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

#include "graph_cache.hpp"
#include "rmw_node_data.hpp"
#include "buffer_pool.hpp"

#include "rmw/ret_types.h"
#include "rmw/types.h"
Expand Down Expand Up @@ -92,6 +93,9 @@ struct rmw_context_impl_s final
// Forward declaration
class Data;

// Pool of serialization buffers.
BufferPool serialization_buffer_pool;

private:
std::shared_ptr<Data> data_{nullptr};
};
Expand Down
Loading

0 comments on commit 62cb09b

Please sign in to comment.