loffli.hpp🔗

Namespaces🔗

Name
iox building block to easily create free function for logging in a library context
iox::concurrent

Classes🔗

	Name
class	iox::concurrent::LoFFLi

Source code🔗

// Copyright (c) 2019 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_UTILS_CONCURRENT_LOFFLI_HPP
#define IOX_UTILS_CONCURRENT_LOFFLI_HPP

#include "iceoryx_utils/cxx/helplets.hpp"
#include "iceoryx_utils/internal/relocatable_pointer/relative_pointer.hpp"

#include <atomic>
#include <cstdint>

namespace iox
{
namespace concurrent
{
class LoFFLi
{
  public:
    using Index_t = uint32_t;

  private:
    struct alignas(8) Node
    {
        Index_t indexToNextFreeIndex;
        uint32_t abaCounter;
    };

    static_assert(sizeof(Node) <= 8U,
                  "The size of 'Node' must not exceed 8 bytes in order to be lock-free on 64 bit systems!");





    uint32_t m_size{0U};
    Index_t m_invalidIndex{0U};
    std::atomic<Node> m_head{{0U, 1U}};
    iox::rp::RelativePointer<Index_t> m_nextFreeIndex;

  public:
    LoFFLi() = default;

    void init(cxx::not_null<Index_t*> freeIndicesMemory, const uint32_t capacity) noexcept;

    bool pop(Index_t& index) noexcept;

    bool push(const Index_t index) noexcept;

    static inline constexpr std::size_t requiredIndexMemorySize(const uint32_t capacity) noexcept;
};

} // namespace concurrent
} // namespace iox

#include "loffli.inl"

#endif // IOX_UTILS_CONCURRENT_LOFFLI_HPP

Updated on 31 May 2022 at 15:29:15 CEST