EventReadyList.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_EVENTREADYLIST_H
#define IMT_BASE_DFF_RUNTIME_EVENTREADYLIST_H
 
#include <array>
#include <Imt.Base.Core.Platform/Nonmovable.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Dff.Runtime/EventData.h>
#include <Imt.Base.Dff.Runtime/RuntimePriority.h>
 
namespace imt {
namespace base {
namespace dff {
namespace runtime {
 
class EventReadyList final : private ::imt::base::core::platform::Nonmovable {
public:
 
    // AXIVION Construct AutosarC++19_03-A9.6.1: Implementation does not rely on trivial layout.
    // AXIVION Construct AutosarC++19_03-A11.0.1: Nested POD type.
    struct Node final {
        // AXIVION Next Codeline AutosarC++19_03-M11.0.1: Public field allowed in POD type.
        EventData* m_pEvent {nullptr};
 
        // AXIVION Next Codeline AutosarC++19_03-M11.0.1: Public field allowed in POD type.
        Node* m_pNext {nullptr};
    };
 
    EventReadyList() = delete;
 
    // AXIVION Next Codeline AutosarC++19_03-A18.1.1: use C-style array for compatibility
    EventReadyList(Node pool[], size_t poolSize);
 
    void push(EventData* pEvent, uint8_t priority);
 
    EventData* pop(uint8_t priority);
 
    inline uint8_t getHighestPendingPriority() const {
        constexpr uint8_t maxZeroCount {32};
        return static_cast<uint8_t>(maxZeroCount - __DATAFLOW_CLZ(m_corePriorityBitmap)); // AXIVION Line AutosarC++19_03-A4.7.1 / AutosarC++19_03-M0.3.1: truncation not possible then can not get negative (max zeros in a uint32 is 32)
    }
 
    inline bool isEmpty() const {
        return m_corePriorityBitmap == 0;
    }
 
private:
 
    // AXIVION Construct AutosarC++19_03-A9.6.1: Implementation does not rely on trivial layout.
    // AXIVION Construct AutosarC++19_03-A2.7.3: Private elements do not have to be commented.
    struct PrioList final {
        Node* m_pHead;
        Node* m_pTail;
    };
 
    static inline uint8_t getPriorityIndex(uint8_t priority);
    inline void setPriorityFlag(uint8_t priorityIndex);
    inline void clearPriorityFlag(uint8_t priorityIndex);
 
    std::array<PrioList, RuntimePriorityLimits::MAX> m_prioLists;
 
    Node* const m_pPool;
    Node* m_pFree;
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    uint32_t m_corePriorityBitmap;
};
 
} // namespace runtime
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_RUNTIME_EVENTREADYLIST_H