InstrumentHelpers.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Framework_SystemPerformance_Support_InstrumentHelpers_h_
#define _Stroika_Framework_SystemPerformance_Support_InstrumentHelpers_h_ 1
 
#include "Stroika/Frameworks/StroikaPreComp.h"
 
#include <memory>
#include <optional>
 
#include "Stroika/Foundation/Debug/AssertExternallySynchronizedMutex.h"
#include "Stroika/Foundation/Execution/Synchronized.h"
#include "Stroika/Foundation/Time/Realtime.h"
#include "Stroika/Frameworks/SystemPerformance/Instrument.h"
 
/**
 *  \file
 *
 *  \note Code-Status:  <a href="Code-Status.md#Beta">Beta</a>
 */
 
namespace Stroika::Frameworks::SystemPerformance::Support {
 
    /**
     *  Optional utility used internally in building Instruments - no need to use it (except if using InstrumentRep_COMMON)
     */
    struct Context : Instrument::ICaptureContext {
        optional<Time::TimePointSeconds> fCaptureContextAt{};
    };
 
    /**
     *  Optional utility used internally in building Instruments - no need to use it.
     */
    template <typename OPTIONS, derived_from<Context> CONTEXT>
    struct InstrumentRep_COMMON : Instrument::IRep, Foundation::Debug::AssertExternallySynchronizedMutex {
    protected:
        using _Context = CONTEXT;
 
    protected:
        const OPTIONS _fOptions;
 
    protected:
        Foundation::Execution::Synchronized<shared_ptr<CONTEXT>> _fContext;
 
    private:
        // Before Stroika v3.0d5, tickcount startedat zero, so we could assume that when context fCaptureContextAt missing;
        // but no longer. Could save this more compactly perhaps (redefineing meaning of fCaptureContextAt) but no apparent need.
        const Time::TimePointSeconds fInstrumentCreatedAt_{Time::GetTickCount ()};
 
    protected:
        InstrumentRep_COMMON (const OPTIONS& options, const shared_ptr<CONTEXT>& context = make_shared<CONTEXT> ());
 
    protected:
        /**
         *  If any stored context information was captured (like for averaging over an interval) - this is the start of that interval.
         */
        nonvirtual Time::TimePointSeconds _GetCaptureContextTime () const;
 
    protected:
        // @todo redo docs
        // return true iff actually capture context
        // This looks at the fMinimumAveragingInterval field of fOptions, which obviously must exist for this to be called
        // and if not enuf time has elapsed, just returns false and doesnt update capture time (and caller should then
        // not update the _fContext data used for computing future references / averages)
        nonvirtual void _NoteCompletedCapture (Time::TimePointSeconds at = Time::GetTickCount ());
 
    protected:
        template <typename INFO_TYPE>
        nonvirtual INFO_TYPE Do_Capture_Raw (function<INFO_TYPE ()> internalCapture, Range<Time::TimePointSeconds>* outMeasuredAt)
        {
            // Timerange returned is from time of last context capture, til now. NOTE: this COULD produce overlapping measurement intervals.
            auto      before         = _GetCaptureContextTime ();
            INFO_TYPE rawMeasurement = internalCapture ();
            if (outMeasuredAt != nullptr) {
                using Traversal::Openness;
                *outMeasuredAt = Range<Time::TimePointSeconds> (before, _GetCaptureContextTime (), Openness::eClosed, Openness::eClosed);
            }
            return rawMeasurement;
        }
 
    public:
        virtual shared_ptr<Instrument::ICaptureContext> GetContext () const override
        {
            EnsureNotNull (_fContext.load ());
            return _fContext.load ();
        }
        virtual void SetContext (const shared_ptr<Instrument::ICaptureContext>& context) override
        {
            _fContext.store ((context == nullptr) ? make_shared<CONTEXT> () : dynamic_pointer_cast<CONTEXT> (context));
        }
    };
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "InstrumentHelpers.inl"
 
#endif /*_Stroika_Framework_SystemPerformance_Support_InstrumentHelpers_h_*/