iceoryx_posh/roudi/memory/roudi_memory_manager.hpp

Namespaces

Name
iox
iox::roudi

Classes

	Name
class	iox::roudi::RouDiMemoryManager

Source code

// Copyright (c) 2020 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_POSH_ROUDI_MEMORY_ROUDI_MEMORY_MANAGER_HPP
#define IOX_POSH_ROUDI_MEMORY_ROUDI_MEMORY_MANAGER_HPP

#include "iceoryx_posh/iceoryx_posh_types.hpp"
#include "iceoryx_posh/internal/roudi/memory/mempool_collection_memory_block.hpp"
#include "iceoryx_posh/internal/roudi/memory/mempool_segment_manager_memory_block.hpp"
#include "iceoryx_posh/internal/roudi/memory/port_pool_memory_block.hpp"
#include "iceoryx_posh/roudi/memory/posix_shm_memory_provider.hpp"

#include "iceoryx_hoofs/cxx/expected.hpp"
#include "iceoryx_hoofs/cxx/optional.hpp"
#include "iceoryx_hoofs/cxx/vector.hpp"

#include <cstdint>

namespace iox
{
namespace roudi
{
class MemoryProvider;

enum class RouDiMemoryManagerError
{
    MEMORY_PROVIDER_EXHAUSTED,
    NO_MEMORY_PROVIDER_PRESENT,
    MEMORY_CREATION_FAILED,
    MEMORY_DESTRUCTION_FAILED,
};

iox::log::LogStream& operator<<(iox::log::LogStream& logstream, const RouDiMemoryManagerError& error) noexcept;

class RouDiMemoryManager
{
  public:
    RouDiMemoryManager() noexcept = default;
    virtual ~RouDiMemoryManager() noexcept;

    RouDiMemoryManager(RouDiMemoryManager&&) = delete;
    RouDiMemoryManager& operator=(RouDiMemoryManager&&) = delete;

    RouDiMemoryManager(const RouDiMemoryManager&) = delete;
    RouDiMemoryManager& operator=(const RouDiMemoryManager&) = delete;

    cxx::expected<RouDiMemoryManagerError> addMemoryProvider(MemoryProvider* memoryProvider) noexcept;

    cxx::expected<RouDiMemoryManagerError> createAndAnnounceMemory() noexcept;

    cxx::expected<RouDiMemoryManagerError> destroyMemory() noexcept;

  private:
    mepoo::MePooConfig introspectionMemPoolConfig() const noexcept;
    cxx::vector<MemoryProvider*, MAX_NUMBER_OF_MEMORY_PROVIDER> m_memoryProvider;
};
} // namespace roudi
} // namespace iox

#endif // IOX_POSH_ROUDI_MEMORY_ROUDI_MEMORY_MANAGER_HPP

---

Updated on 18 December 2023 at 13:11:43 CET