KernelResult.h

 
#pragma once
 
#include <vector>
 
#include <Api/Configuration/KernelConfiguration.h>
#include <Api/Output/ComputationResult.h>
#include <Api/Output/ResultStatus.h>
#include <KttPlatform.h>
#include <KttTypes.h>
 
namespace ktt
{
 
class KTT_API KernelResult
{
public:
    KernelResult();
 
    explicit KernelResult(const std::string& kernelName, const KernelConfiguration& configuration, const std::string& timestamp);
 
    explicit KernelResult(const std::string& kernelName, const KernelConfiguration& configuration,
        const std::vector<ComputationResult>& results, const std::string& timestamp);
 
    void SetStatus(const ResultStatus status);
 
    void SetExtraDuration(const Nanoseconds duration);
 
    [[deprecated("Use SetDataMovementOverhead() instead.")]] void SetExtraOverhead(const Nanoseconds overhead);
 
    void SetDataMovementOverhead(const Nanoseconds overhead);
 
    void SetValidationOverhead(const Nanoseconds overhead);
 
    void SetSearcherOverhead(const Nanoseconds overhead);
 
    void SetFailedKernelOverhead(const Nanoseconds overhead);
 
    void SetProfilingRunsOverhead(const Nanoseconds overhead);
 
    void SetProfilingOverhead(const Nanoseconds overhead);
 
    void SetPreciseMeasurementOverhead(const Nanoseconds overhead);
 
    const std::string& GetKernelName() const;
 
    const std::vector<ComputationResult>& GetResults() const;
 
    const std::string& GetTimestamp() const;
 
    const KernelConfiguration& GetConfiguration() const;
 
    ResultStatus GetStatus() const;
 
    Nanoseconds GetKernelDuration() const;
 
    Nanoseconds GetKernelOverheadFromCompResults() const;
 
    Nanoseconds GetKernelOverhead() const;
 
    Nanoseconds GetKernelOverheadFirstPass() const;
 
    Nanoseconds GetCompilationOverheadFromCompResults() const;
 
    Nanoseconds GetExtraDuration() const;
 
    Nanoseconds GetExtraDurationFirstPass() const;
 
    [[deprecated("Use GetDataMovementOverhead() instead.")]] Nanoseconds GetExtraOverhead() const;
 
    Nanoseconds GetDataMovementOverhead() const;
 
    Nanoseconds GetValidationOverhead() const;
 
    Nanoseconds GetSearcherOverhead() const;
 
    Nanoseconds GetFailedKernelOverhead() const;
 
    Nanoseconds GetProfilingRunsOverhead() const;
 
    
    Nanoseconds GetProfilingInfrastructureOverhead() const;
 
    Nanoseconds GetProfilingOverheadFromCompResults() const;
 
    Nanoseconds GetPreciseMeasurementOverheadFromCompResults() const;
 
    Nanoseconds GetProfilingOverhead() const;
 
    Nanoseconds GetPreciseMeasurementOverhead() const;
 
    Nanoseconds GetProfilingTotalOverhead() const;
 
    Nanoseconds GetCompilationOverhead() const;
 
    Nanoseconds GetTotalDuration() const;
 
    Nanoseconds GetTotalOverhead() const;
 
    bool IsValid() const;
 
    bool HasRemainingProfilingRuns() const;
 
    void FuseProfilingTimes(const KernelResult& previousResult, bool first);
 
    void CopyProfilingTimes(const KernelResult& originalResult);
 
    void TransferPowerData(const KernelResult& previousResult);
 
private:
    KernelConfiguration m_Configuration;
    std::vector<ComputationResult> m_Results;
    std::string m_KernelName;
    std::string m_Timestamp;
    Nanoseconds m_ExtraDuration;
    Nanoseconds m_DataMovementOverhead;
    Nanoseconds m_ValidationOverhead;
    Nanoseconds m_SearcherOverhead;
    Nanoseconds m_FailedKernelOverhead;
    Nanoseconds m_ProfilingRunsOverhead; //overhead of all profiling runs, including kernel overhead and kernel duration and extra duration of extra passes
    Nanoseconds m_ProfilingOverhead; //overhead of profiling infrastructure, with data movement and validation, for all profiling passes
    Nanoseconds m_ProfilingInfrastructureOverhead; //overhead of profiling infrastructure, but without data movement and extra duration, for all profiling passes
    Nanoseconds m_PreciseMeasurementOverhead; //overhead of the precise multi-run measurement loop, including all kernel executions performed within the loop
    Nanoseconds m_CompilationOverhead;
    Nanoseconds m_KernelOverhead;
    Nanoseconds m_KernelOverheadFirstPass; //kernel overhead of the first pass (i.e. full compilation and run without profiling)
    Nanoseconds m_ExtraDurationFirstPass; //extra duration of the first pass 
    ResultStatus m_Status;
};
 
} // namespace ktt