/**
 * Copyright (C) 2016-2022 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 OPENCL_DEVICE_INFO_PLUGIN_DOT_H
#define OPENCL_DEVICE_INFO_PLUGIN_DOT_H

#include <memory>

#include "xocl/core/platform.h"

#include "xdp/config.h"
#include "xdp/profile/plugin/device_offload/device_offload_plugin.h"

namespace xdp {

  // This is the device info plugin linked in from the OpenCL layer.
  //  Now that we have a device_offload plugin for both hardware and
  //  hardware emulation, this plugin is only responsible for updating
  //  some information in the database necessary for guidance, summary,
  //  and trace only available at the OpenCL layer.  It no longer communicates
  //  with the actual device.
  class OpenCLDeviceInfoPlugin : public DeviceOffloadPlugin
  {
  private:
    // I have to keep a shared pointer to the platform to make sure
    //  no xrt_xocl::device objects are deleted before we read them at 
    //  the end of execution.
    std::shared_ptr<xocl::platform> platform ;

    void updateOpenCLInfo(uint64_t deviceId) ;
    void updateSWEmulationGuidance() ;

    XDP_EXPORT virtual void readTrace() override;

  public:
    XDP_EXPORT OpenCLDeviceInfoPlugin() ;
    XDP_EXPORT virtual ~OpenCLDeviceInfoPlugin() override ;

    // Virtual functions from XDPPlugin
    XDP_EXPORT virtual void writeAll(bool openNewFiles) override;

    // Virtual functions from DeviceOffloadPlugin
    XDP_EXPORT virtual void flushDevice(void* device) override;
    XDP_EXPORT virtual void updateDevice(void* device) override;
  } ;

} // end namespace xdp

#endif
