RuntimeStatisticsExecutables.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_RUNTIMESTATISTICSEXECUTABLES_H
#define IMT_BASE_DFF_RUNTIME_RUNTIMESTATISTICSEXECUTABLES_H
 
#include <Imt.Base.Core.Math/MathUtils.h>
#include <Imt.Base.Core.Platform/Platform.h>
 
namespace imt {
namespace base {
namespace dff {
namespace runtime {
 
class RuntimeStatisticsExecutables final {
 
public:
 
    constexpr RuntimeStatisticsExecutables() noexcept = default;
 
    void incrementExecutionCounter() {
        ++m_executionCounter;
    }
 
    void updateExecutionTime(uint32_t const durationMicroSeconds) {
        if (durationMicroSeconds > m_executionTimeMicroSecondsMax) {
            m_executionTimeMicroSecondsMax = durationMicroSeconds;
        }
        if (durationMicroSeconds < m_executionTimeMicroSecondsMin) {
            m_executionTimeMicroSecondsMin = durationMicroSeconds;
        }
        // calculate the average with the exponential moving average, alpha = 0.5
        // the closer alpha is to zero, the longer the effect of previous numbers hangs around
        // the closer alpha is to one, the faster the moving average updates in response to new values
        // AXIVION Next Line AutosarC++19_03-A5.1.1 / AutosarC++19_03-M0.4.2: Usage allowed, moving average definition / Usage allowed
        float32_t const movingAverage {(0.5F * static_cast<float32_t>(durationMicroSeconds)) + (0.5F * static_cast<float32_t>(m_executionTimeMicroSecondsAvg))};
        // fast rounding from float to uint32_t
        m_executionTimeMicroSecondsAvg = static_cast<uint32_t>(::imt::base::core::math::MathUtils::roundToInt(movingAverage));
    }
 
    void updateExecutionCountPerSecond(uint32_t const durationMilliSeconds) {
        // AXIVION Next Line AutosarC++19_03-A5.1.1: Usage allowed, millisecond calculation
        m_executionCountPerSecond = (m_executionCounter * 1000U) / durationMilliSeconds;
        if (m_executionCountPerSecond > m_executionCountPerSecondMax) {
            m_executionCountPerSecondMax = m_executionCountPerSecond;
        }
        resetExecutionCounter();
    }
 
    void reset() {
        m_executionCounter = 0U;
        m_executionCountPerSecond = 0U;
        m_executionCountPerSecondMax = 0U;
        // AXIVION Next Line AutosarC++19_03-M2.13.3: Allowed usage
        m_executionTimeMicroSecondsMin = UINT32_MAX;
        m_executionTimeMicroSecondsMax = 0U;
        m_executionTimeMicroSecondsAvg = 0U;
    }
 
private:
 
    void resetExecutionCounter() {
        m_executionCounter = 0U;
    }
 
    uint32_t m_executionCounter {0U};
    uint32_t m_executionCountPerSecond {0U};
    uint32_t m_executionCountPerSecondMax {0U};
    uint32_t m_executionTimeMicroSecondsMin {UINT32_MAX};
    uint32_t m_executionTimeMicroSecondsMax {0U};
    uint32_t m_executionTimeMicroSecondsAvg {0U};
};
 
} // namespace runtime
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_RUNTIME_RUNTIMESTATISTICSEXECUTABLES_H