RuntimePools.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_DFF_RUNTIME_RUNTIME_POOLS_H
#define IMT_BASE_DFF_RUNTIME_RUNTIME_POOLS_H
 
#include <Imt.Base.Core.Diagnostics/Diagnostics.h>
#include <Imt.Base.Core.Platform/StaticClass.h>
#include <Imt.Base.Core.Util/LinkedList.h>
#include <Imt.Base.Core.Util/PoolAllocator.h>
#include <Imt.Base.Dff.Runtime/RuntimeConfigApp.h>
 
#ifdef RUNTIME_STATISTICS
#include <Imt.Base.Dff.Runtime/RuntimeStatisticsEvents.h>
#include <Imt.Base.Dff.Runtime/RuntimeStatisticsExecutables.h>
#endif // RUNTIME_STATISTICS
#include <Imt.Base.Dff.Runtime/BufferItem.h>
#include <Imt.Base.Dff.Runtime/ExecutableIfc.h>
#include <Imt.Base.Dff.Runtime/RuntimeTimer.h>
 
namespace imt {
namespace base {
namespace dff {
namespace runtime {
 
// Runtime limited to max. 32 interrupts (32bit ARM system optimized scheduler & core)
static_assert(::imt::base::dff::runtime::RuntimePriorityLimits::MAX <= 32U, "Runtime limited to max. 32 interrupts");
// keep priority values within range
static_assert(static_cast<uint_fast8_t>(::imt::base::dff::runtime::RuntimePriority::Prio_highest) <= ::imt::base::dff::runtime::RuntimePriorityLimits::MAX, "Priority out of range");
 
// Maximum number of executables limited to int16_max
static_assert(::imt::base::dff::runtime::EXECUTABLES_MAX > 0, "Number of executables out of range");
static_assert(::imt::base::dff::runtime::EXECUTABLES_MAX <= INT16_MAX, "Number of executables out of range");
 
// Ensure TIMEPOOL_SIZE is within range (limited to int16_max), because TimerHandle is an int16_t
static_assert(::imt::base::dff::runtime::TIMEPOOL_SIZE > 0, "Timer pool size out of range");
static_assert(::imt::base::dff::runtime::TIMEPOOL_SIZE <= INT16_MAX, "Timer pool size out of range");
 
#ifdef USE_BUFFERPOOL
// Maximum number of buffer items limited to int16_maxe
static_assert(::imt::base::dff::runtime::BUFFERPOOL_SIZE > 0, "Buffer pool size out of range");
static_assert(::imt::base::dff::runtime::BUFFERPOOL_SIZE <= INT16_MAX, "Buffer pool size out of range");
#endif
 
class RuntimePools final : private ::imt::base::core::platform::StaticClass {
public:
 
    using TimerPoolAllocator = core::util::PoolAllocator<RuntimeTimer::TimeItem>;
    static TimerPoolAllocator s_timerAllocator; // AXIVION Line AutosarC++19_03-M11.0.1: is public because RuntimePools is a static class
 
#ifdef USE_BUFFERPOOL
    using BufferPoolAllocator = core::util::PoolAllocator<BufferItem>;
    static BufferPoolAllocator s_bufferAllocator; // AXIVION Line AutosarC++19_03-M11.0.1: is public because RuntimePools is a static class
 
    using BufferPointerNode = core::util::ListNode<BufferItem*>;
 
    using BufferPointerAllocator = core::util::PoolAllocator<BufferPointerNode>;
    // AXIVION Next Line AutosarC++19_03-M11.0.1: Allowe definition, compatibility purposes
    static BufferPointerAllocator s_bufferPointerAllocator;
 
    using BufferPointerList = core::util::LinkedList<BufferPointerNode>; // AXIVION Line AutosarC++19_03-A14.7.1: false positive: all functions are disabled who require m_pPrev when using single-linked-node
 
    using BufferPointerIterator = core::util::LinkedList<BufferPointerNode>::Iterator; // AXIVION Line AutosarC++19_03-A14.7.1: false positive: all functions are disabled who require m_pPrev when using iterator for single-linked-nodes
 
#endif // USE_BUFFERPOOL
 
#ifdef RUNTIME_STATISTICS
    static RuntimeStatisticsExecutables* getRuntimeStatisticsExecutables();
    static size_t getExecutionStatisticsSize();
    static RuntimeStatisticsEvents s_eventStatistics;
#endif // RUNTIME_STATISTICS
 
    static ExecutableIfc* getExecutable(int16_t const index);
 
    template<typename T>
    static T* getExecutableInfo(int16_t const index) noexcept {
        return static_cast<T*>(getExecutableInfo(index)); // AXIVION Line AutosarC++19_03-M5.2.8: desired construct
    }
 
    static void registerExecutable(int16_t const index, ExecutableIfc& executable);
 
    static int16_t getExecutionPoolSize();
 
#ifdef _UNITTEST
    static void cleanPools();
#endif // _UNITTEST
 
private:
 
    static void* getExecutableInfo(int16_t const index);
 
// AXIVION File Style AutosarC++19_03-A18.1.1: replacing of C-arrays currently not done due to risks for compatibility reasons
#ifdef RUNTIME_STATISTICS
    static RuntimeStatisticsExecutables s_executionStatistics[imt::base::dff::runtime::EXECUTABLES_MAX];
#endif // RUNTIME_STATISTICS
    static RuntimeTimer::TimeItem s_timerPool[imt::base::dff::runtime::TIMEPOOL_SIZE];
#ifdef USE_BUFFERPOOL
    static BufferItem s_bufferPool[imt::base::dff::runtime::BUFFERPOOL_SIZE];
    static BufferPointerNode s_bufferPointerPool[imt::base::dff::runtime::BUFFERPOOL_SIZE];
#endif
    static ::imt::base::dff::runtime::ExecutableIfc* s_executablePool[imt::base::dff::runtime::EXECUTABLES_MAX];
};
 
} // namespace runtime
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_RUNTIME_RUNTIME_POOLS_H