/*
* Copyright (c) 2017, Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/

#pragma once
#include <memory>
#include <mutex>
#include "CL/cl.h"
#include "runtime/event/perf_counter.h"
#include "runtime/helpers/hw_info.h"

namespace OCLRT {
struct HardwareInfo;
class OSInterface;
class OSTime;

class PerformanceCounters {
  public:
    static std::unique_ptr<PerformanceCounters> create(OSTime *osTime);
    virtual ~PerformanceCounters() = default;
    void enable();
    void shutdown();
    virtual void initialize(const HardwareInfo *hwInfo);
    InstrPmRegsCfg *getPmRegsCfg(uint32_t configuration);
    bool sendPmRegsCfgCommands(InstrPmRegsCfg *pCfg, uint32_t *pLastPmRegsCfgHandle, bool *pLastPmRegsCfgPending);
    void setCpuTimestamp();
    bool processEventReport(size_t pClientDataSize, void *pClientData, size_t *outputSize, HwPerfCounter *pPrivateData, InstrPmRegsCfg *countersConfiguration, bool isEventComplete);
    int sendPerfConfiguration(uint32_t count, uint32_t *pOffsets, uint32_t *pValues);
    uint32_t getCurrentReportId();

    uint32_t getPerfCountersReferenceNumber() {
        mutex.lock();
        std::lock_guard<std::mutex> lg(mutex, std::adopt_lock);

        return refCounter;
    }

    bool isAvailable() {
        return available;
    }

  protected:
    PerformanceCounters(OSTime *osTime);
    virtual bool verifyPmRegsCfg(InstrPmRegsCfg *pCfg, uint32_t *pLastPmRegsCfgHandle, bool *pLastPmRegsCfgPending);
    size_t querySize();
    virtual void enableImpl();
    void shutdownImpl();
    MOCKABLE_VIRTUAL uint32_t getReportId() {
        return ++reportId & 0xFFF;
    }
    GFXCORE_FAMILY gfxFamily;
    InstrEscCbData cbData;
    OSInterface *osInterface;
    OSTime *osTime;
    bool hwMetricsEnabled;
    bool useMIRPC;
    void *pAutoSamplingInterface;
    uint64_t cpuRawTimestamp;
    std::mutex mutex;
    uint32_t refCounter;
    bool available;
    uint32_t reportId;
    decltype(&instrAutoSamplingStart) autoSamplingStartFunc = instrAutoSamplingStart;
    decltype(&instrAutoSamplingStop) autoSamplingStopFunc = instrAutoSamplingStop;
    decltype(&instrCheckPmRegsCfg) checkPmRegsCfgFunc = instrCheckPmRegsCfg;
    decltype(&instrGetPerfCountersQueryData) getPerfCountersQueryDataFunc = instrGetPerfCountersQueryData;
    decltype(&instrEscGetPmRegsCfg) getPmRegsCfgFunc = instrEscGetPmRegsCfg;
    decltype(&instrEscHwMetricsEnable) hwMetricsEnableFunc = instrEscHwMetricsEnable;
    decltype(&instrEscLoadPmRegsCfg) loadPmRegsCfgFunc = instrEscLoadPmRegsCfg;
    decltype(&instrEscSetPmRegsCfg) setPmRegsCfgFunc = instrEscSetPmRegsCfg;
    decltype(&instrEscSendReadRegsCfg) sendReadRegsCfgFunc = instrEscSendReadRegsCfg;
};
} // namespace OCLRT