/******************************************************************************
Copyright (c) 2018 Advanced Micro Devices, Inc. All rights reserved.

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.
*******************************************************************************/

#ifndef TEST_CTRL_TEST_HSA_H_
#define TEST_CTRL_TEST_HSA_H_

#include "ctrl/test_aql.h"
#include "ctrl/test_kernel.h"
#include "util/hsa_rsrc_factory.h"
#include "util/perf_timer.h"

// Class implements HSA test
class TestHsa : public TestAql {
 public:
  // Instantiate HSA resources
  static HsaRsrcFactory* HsaInstantiate();
  static void HsaShutdown();

  // Constructor
  explicit TestHsa(TestKernel* test) : test_(test), name_(test->Name()) {
    total_time_taken_ = 0;
    setup_time_taken_ = 0;
    dispatch_time_taken_ = 0;
    agent_info_ = NULL;
    hsa_queue_ = NULL;
    my_queue_ = false;
    hsa_exec_ = {};
  }

  // Get methods for Agent Info, HAS queue, HSA Resourcse Manager
  HsaRsrcFactory* GetRsrcFactory() { return hsa_rsrc_; }
  hsa_agent_t HsaAgent() { return agent_info_->dev_id; }
  const AgentInfo* GetAgentInfo() { return agent_info_; }
  void SetAgentInfo(const AgentInfo* agent_info) { agent_info_ = agent_info; }
  hsa_queue_t* GetQueue() { return hsa_queue_; }
  void SetQueue(hsa_queue_t* queue) { hsa_queue_ = queue; }

  // Initialize application environment including setting
  // up of various configuration parameters based on
  // command line arguments
  // @return bool true on success and false on failure
  bool Initialize(int argc, char** argv);

  // Setup application parameters for exectuion
  // @return bool true on success and false on failure
  bool Setup();

  // Run the BinarySearch kernel
  // @return bool true on success and false on failure
  bool Run();

  // Verify against reference implementation
  // @return bool true on success and false on failure
  bool VerifyResults();

  // Print to console the time taken to execute kernel
  void PrintTime();

  // Release resources e.g. memory allocations
  // @return bool true on success and false on failure
  bool Cleanup();

 private:
  typedef TestKernel::mem_descr_t mem_descr_t;
  typedef TestKernel::mem_map_t mem_map_t;
  typedef TestKernel::mem_it_t mem_it_t;

  // Test object
  TestKernel* test_;

  // Path of Brig file
  std::string brig_path_obj_;

  // Used to track time taken to run the sample
  double total_time_taken_;
  double setup_time_taken_;
  double dispatch_time_taken_;

  // Handle of signal
  hsa_signal_t hsa_signal_;

  // Handle of Kernel Code Descriptor
  hsa_executable_symbol_t kernel_code_desc_;

  // Instance of timer object
  uint32_t setup_timer_idx_;
  uint32_t dispatch_timer_idx_;
  PerfTimer hsa_timer_;

  // Instance of Hsa Resources Factory
  static HsaRsrcFactory* hsa_rsrc_;

  // Handle to an Hsa Gpu Agent
  const AgentInfo* agent_info_;

  // Handle to an Hsa Queue
  hsa_queue_t* hsa_queue_;
  bool my_queue_;

  // Test kernel name
  std::string name_;

  // Kernel executable
  hsa_executable_t hsa_exec_;
};

#endif  // TEST_CTRL_TEST_HSA_H_