/**
 * Copyright (C) 2016-2019 Xilinx, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may
 * not use this file except in compliance with the License. A copy of the
 * License is located at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

#ifndef __XDP_CORE_RT_PROFILE_H
#define __XDP_CORE_RT_PROFILE_H

#include "rt_util.h"
#include "xclperf.h"
#include "run_summary.h"           // Used to create the run_summary file
#include "xdp/profile/plugin/base_plugin.h"

#include <set>
#include <vector>
#include <string>
#include <limits>
#include <cstdint>
#include <thread>
#include <iostream>
#include <memory>
#include <chrono>

namespace xdp {
  class SummaryWriter;
  class TraceLogger;
  class ProfileWriterI;
  class TraceWriterI;
  class TraceParser;
  class ProfileCounters;

  // **************************************************************************
  // Top-level profile class
  // **************************************************************************
  class RTProfile {
  public:
    XDP_EXPORT
    RTProfile(int& flags, std::shared_ptr<XDPPluginI> mPluginHandle);
    XDP_EXPORT
    ~RTProfile();

  public:
    // Profiling options and settings
    void turnOnProfile(RTUtil::e_profile_mode mode) { mProfileFlags |= mode; }
    void turnOffProfile(RTUtil::e_profile_mode mode) { mProfileFlags &= ~mode; }
    void turnOnFile(RTUtil::e_write_file file) { mFileFlags |= file; }
    int getProfileFlags() { return mProfileFlags; }

    XDP_EXPORT
    bool isDeviceProfileOn() const;
    bool isApplicationProfileOn() const { return mProfileFlags & RTUtil::PROFILE_APPLICATION; }
    XDP_EXPORT
    void setTransferTrace(const std::string& traceStr);
    XDP_EXPORT
    void setStallTrace(const std::string& traceStr);
    RTUtil::e_device_trace getTransferTrace() { return mDeviceTraceOption; }
    RTUtil::e_stall_trace getStallTrace() { return mStallTraceOption; }
    RunSummary * getRunSummary() { return mRunSummary; }

  public:
    // Attach or detach observer writers
    // NOTE: the following functions are thread safe
    XDP_EXPORT
    void attach(ProfileWriterI* writer);
    XDP_EXPORT
    void attach(TraceWriterI* writer);
    XDP_EXPORT
    void detach(ProfileWriterI* writer);
    XDP_EXPORT
    void detach(TraceWriterI* writer);

  public:
    // Settings: clock freqs, bit widths, etc.
    XDP_EXPORT
    void setTraceClockFreqMHz(unsigned int kernelClockRateMHz);
    XDP_EXPORT
    void setDeviceClockFreqMHz(double deviceClockRateMHz);
    XDP_EXPORT
    void setDeviceTraceClockFreqMHz(double deviceTraceClockRateMHz);
    void setGlobalMemoryBitWidth(uint32_t bitWidth);
    uint32_t getGlobalMemoryBitWidth();
    XDP_EXPORT
    uint32_t getTraceSamplesThreshold();
    XDP_EXPORT
    uint32_t getSampleIntervalMsec();

    // Record wall-clock time points for start and end of profiling. Used to get an approximate total host time
    XDP_EXPORT
    void setProfileStartTime(std::chrono::steady_clock::time_point t);
    XDP_EXPORT
    void setProfileEndTime(std::chrono::steady_clock::time_point t);
    XDP_EXPORT
    double getTotalHostTimeInMilliSec();

  public:
    XDP_EXPORT
    void writeProfileSummary();
    void addDeviceName(const std::string& deviceName) { mDeviceNames.push_back(deviceName); }
    XDP_EXPORT
    std::string getDeviceNames(const std::string& sep) const;
    // Intentionally not a reference to the underlying container.
    std::vector<std::string> getDeviceNames() const { return mDeviceNames; }
    XDP_EXPORT
    std::string getProjectName() const;
    XDP_EXPORT
    const std::set<std::thread::id>& getThreadIds();

    // Functions required by guidance
    XDP_EXPORT
    int getMigrateMemCalls() const;
    XDP_EXPORT
    int getHostP2PTransfers() const;
    XDP_EXPORT
    double getDeviceStartTime(const std::string& deviceName) const;
    XDP_EXPORT
    double getTotalKernelExecutionTime(const std::string& deviceName) const;
    XDP_EXPORT
    double getTotalApplicationKernelTimeMsec() const;
    XDP_EXPORT
    uint32_t getComputeUnitCalls(const std::string& deviceName, const std::string& cuName) const;

  public:
    XDP_EXPORT
    bool getLoggingTrace(int index);
    XDP_EXPORT
    void setLoggingTrace(int index, bool value);
    TraceParser* getTraceParser() {return mTraceParser; }

  public:
    // External access to writer
    XDP_EXPORT
    void writeAPISummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeKernelSummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeStallSummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeKernelStreamSummary(ProfileWriterI* writer);
    XDP_EXPORT
    void writeComputeUnitSummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeTransferSummary(ProfileWriterI* writer, RTUtil::e_monitor_type monitorType) const;
    XDP_EXPORT
    void writeKernelTransferSummary(ProfileWriterI* writer);
    XDP_EXPORT
    void writeDeviceTransferSummary(ProfileWriterI* writer) const;
    // Top offenders lists
    XDP_EXPORT
    void writeTopKernelSummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeTopKernelTransferSummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeTopDataTransferSummary(ProfileWriterI* writer, bool isRead) const;
    XDP_EXPORT
    void writeTopDeviceTransferSummary(ProfileWriterI* writer, bool isRead) const;
    // Unified summaries
    XDP_EXPORT
    void writeAcceleratorSummary(ProfileWriterI* writer) const;
    XDP_EXPORT
    void writeTopHardwareSummary(ProfileWriterI* writer) const;

  public:
    // External access to logger
    XDP_EXPORT
    void logFunctionCallStart(const char* functionName, long long queueAddress, unsigned int functionID);
    XDP_EXPORT
    void logFunctionCallEnd(const char* functionName, long long queueAddress, unsigned int functionID);

    // Log host buffer reads and writes
    XDP_EXPORT
    void logDataTransfer(uint64_t objId, RTUtil::e_profile_command_kind objKind,
        RTUtil::e_profile_command_state objStage, size_t objSize, uint32_t contextId,
        size_t numDevices, const std::string& deviceName, uint32_t commandQueueId,
        uint64_t srcAddress, const std::string& srcBank,
        uint64_t dstAddress, const std::string& dstBank,
        std::thread::id threadId, const std::string eventString = "",
        const std::string dependString = "", double timeStampMsec = 0.0);

    // Log Kernel execution
    XDP_EXPORT
    void logKernelExecution(uint64_t objId, uint32_t programId, uint64_t eventId,
        RTUtil::e_profile_command_state objStage, const std::string& kernelName, const std::string& xclbinName,
        uint32_t contextId, uint32_t commandQueueId, const std::string& deviceName, unsigned int uid,
        const size_t* globalWorkSize, size_t workGroupSize, const size_t* localWorkDim,
        const std::string& cu_name, const std::string eventString = "", const std::string dependString = "",
        double timeStampMsec = 0.0);

    // Log a dependency (e.g., a kernel waiting on a host write)
    XDP_EXPORT
    void logDependency(RTUtil::e_profile_command_kind objKind,
       const std::string& eventString, const std::string& dependString);

    XDP_EXPORT
    void logDeviceTrace(const std::string& deviceName, const std::string& binaryName, xclPerfMonType type,
        xclTraceResultsVector& traceVector, bool endLog = true);

    // Log device counters (used in profile summary)
    XDP_EXPORT
    void logDeviceCounters(const std::string& deviceName, const std::string& binaryName, uint32_t programId, xclPerfMonType type,
        xclCounterResults& counterResults, uint64_t timeNsec, bool firstReadAfterProgram);

  private:
    int& mProfileFlags;
    int mFileFlags; // Which files we want to write out
    RTUtil::e_device_trace mDeviceTraceOption;
    RTUtil::e_stall_trace mStallTraceOption;
    bool mLoggingTrace[XCL_PERF_MON_TOTAL_PROFILE] = {false};
    ProfileCounters* mProfileCounters = nullptr;
    TraceParser* mTraceParser;
    TraceLogger* mLogger;
    SummaryWriter* mWriter;
    std::vector<std::string> mDeviceNames;
    std::shared_ptr<XDPPluginI> mPluginHandle;
    RunSummary* mRunSummary;
  };

} // xdp

#endif
