/*
 * Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
 *
 * SPDX-License-Identifier: MIT
 */

/**
 * @addtogroup hipDrvMemcpy3D hipDrvMemcpy3D
 * @{
 * @ingroup MemoryTest
 * `hipMemcpy3D(const hipMemcpy3DParms* p)` -
 * Copies data between 3D objects.
 */

/*
 * Test Scenarios
 * 1. Verifying hipDrvMemcpy3D API for H2A,A2A,A2H scenarios
 * 2. Verifying hipDrvMemcpy3D API for H2D,D2D,D2H scenarios
 * 3. Verifying Negative Scenarios
 * 4. Verifying Extent validation scenarios by passing 0
 * 5. Verifying hipDrvMemcpy3D API by allocating Memory in
 *    one GPU and trigger hipDrvMemcpy3D from peer GPU for
 *    H2D,D2D,D2H scenarios
 * 6. Verifying hipDrvMemcpy3D API by allocating Memory in
 *    one GPU and trigger hipDrvMemcpy3D from peer GPU for
 *    H2A,A2A,A2H scenarios
 *
 *    Scenarios 3 is temporarily suspended on AMD
 *    Scenario 5&6 are not supported in CUDA platform
 */

#include <hip_test_common.hh>
#include <hip_test_checkers.hh>

template <typename T> class DrvMemcpy3D {
  int width, height, depth;
  unsigned int size;
  hipArray_Format formatKind;
  hipArray_t arr, arr1;
  size_t pitch_D, pitch_E;
  HIP_MEMCPY3D myparms;
  hipDeviceptr_t D_m, E_m;
  T* hData{nullptr};

 public:
  DrvMemcpy3D(int l_width, int l_height, int l_depth, hipArray_Format l_format);
  DrvMemcpy3D() = delete;
  void AllocateMemory();
  void SetDefaultData();
  void HostArray_DrvMemcpy3D(bool device_context_change = false);
  void HostDevice_DrvMemcpy3D(bool device_context_change = false);
  void Extent_Validation();
  void NegativeTests();
  void DeAllocateMemory();
};

/* Intializes class variables */
template <typename T>
DrvMemcpy3D<T>::DrvMemcpy3D(int l_width, int l_height, int l_depth, hipArray_Format l_format) {
  width = l_width;
  height = l_height;
  depth = l_depth;
  formatKind = l_format;
}

/* Allocating Memory */
template <typename T> void DrvMemcpy3D<T>::AllocateMemory() {
  size = width * height * depth * sizeof(T);
  hData = reinterpret_cast<T*>(malloc(size));
  memset(hData, 0, size);
  for (int i = 0; i < depth; i++) {
    for (int j = 0; j < height; j++) {
      for (int k = 0; k < width; k++) {
        hData[i * width * height + j * width + k] = i * width * height + j * width + k;
      }
    }
  }
  HIP_CHECK(hipMallocPitch(reinterpret_cast<void**>(&D_m), &pitch_D, width * sizeof(T), height));
  HIP_CHECK(hipMallocPitch(reinterpret_cast<void**>(&E_m), &pitch_E, width * sizeof(T), height));
  HIP_ARRAY3D_DESCRIPTOR* desc;
  desc = reinterpret_cast<HIP_ARRAY3D_DESCRIPTOR*>(malloc(sizeof(HIP_ARRAY3D_DESCRIPTOR)));
  desc->Format = formatKind;
  desc->NumChannels = 1;
  desc->Width = width;
  desc->Height = height;
  desc->Depth = depth;
  desc->Flags = hipArrayDefault;
  HIP_CHECK(hipArray3DCreate(&arr, desc));
  HIP_CHECK(hipArray3DCreate(&arr1, desc));
}

/* Setting the default data */
template <typename T> void DrvMemcpy3D<T>::SetDefaultData() {
  memset(&myparms, 0x0, sizeof(HIP_MEMCPY3D));
  myparms.srcXInBytes = 0;
  myparms.srcY = 0;
  myparms.srcZ = 0;
  myparms.srcLOD = 0;
  myparms.dstXInBytes = 0;
  myparms.dstY = 0;
  myparms.dstZ = 0;
  myparms.dstLOD = 0;
  myparms.WidthInBytes = width * sizeof(T);
  myparms.Height = height;
  myparms.Depth = depth;
}

/*
This function verifies the negative scenarios of
hipDrvMemcpy3D API
*/
template <typename T> void DrvMemcpy3D<T>::NegativeTests() {
  HIP_CHECK(hipSetDevice(0));
  AllocateMemory();
  SetDefaultData();
  int deviceId;
  HIP_CHECK(hipGetDevice(&deviceId));
  unsigned int MaxPitch;
  HIP_CHECK(hipDeviceGetAttribute(reinterpret_cast<int*>(&MaxPitch), hipDeviceAttributeMaxPitch,
                                  deviceId));
  myparms.srcHost = hData;
  myparms.dstArray = arr;
  myparms.srcPitch = width * sizeof(T);
  myparms.srcHeight = height;
  myparms.srcMemoryType = hipMemoryTypeHost;
  myparms.dstMemoryType = hipMemoryTypeArray;

  SECTION("Passing nullptr to Source Host") {
    myparms.srcHost = nullptr;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Passing both dst host and device") {
    myparms.dstHost = hData;
    myparms.dstArray = nullptr;
    myparms.dstDevice = D_m;
    myparms.WidthInBytes = pitch_D;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Passing max value to WidthInBytes") {
    myparms.WidthInBytes = std::numeric_limits<int>::max();
    myparms.Height = std::numeric_limits<int>::max();
    myparms.Depth = std::numeric_limits<int>::max();
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Passing width > max width size") {
    myparms.WidthInBytes = width * sizeof(T) + 1;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Passing height > max height size") {
    myparms.Height = height + 1;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Passing depth > max depth size") {
    myparms.Depth = depth + 1;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("widthinbytes + srcXinBytes is out of bound") {
    myparms.srcXInBytes = 1;
    myparms.dstArray = nullptr;
    myparms.dstDevice = hipDeviceptr_t(D_m);
    myparms.dstPitch = pitch_D;
    myparms.dstHeight = height;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("widthinbytes + dstXinBytes is out of bound") {
    myparms.dstXInBytes = pitch_D;
    myparms.dstArray = nullptr;
    myparms.dstDevice = hipDeviceptr_t(D_m);
    myparms.dstPitch = pitch_D;
    myparms.dstHeight = height;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("srcY + height is out of bound") {
    myparms.srcY = 1;
    myparms.dstArray = nullptr;
    myparms.dstDevice = hipDeviceptr_t(D_m);
    myparms.dstPitch = pitch_D;
    myparms.dstHeight = height;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("dstY + height out of bounds") {
    myparms.dstY = 1;
    myparms.dstArray = nullptr;
    myparms.dstDevice = hipDeviceptr_t(D_m);
    myparms.dstPitch = pitch_D;
    myparms.dstHeight = height;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("src pitch greater than Max allowed pitch") {
    myparms.srcMemoryType = hipMemoryTypeDevice;
    myparms.dstMemoryType = hipMemoryTypeHost;
    myparms.srcDevice = D_m;
    myparms.srcHost = nullptr;
    myparms.srcPitch = MaxPitch;
    myparms.srcHeight = height;
    myparms.dstHost = hData;
    myparms.dstArray = nullptr;
    myparms.dstPitch = width * sizeof(T);
    myparms.dstHeight = height;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("dst pitch greater than Max allowed pitch") {
    myparms.dstDevice = hipDeviceptr_t(D_m);
    myparms.dstArray = nullptr;
    myparms.dstPitch = MaxPitch + 1;
    myparms.dstHeight = height;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Nullptr to src/dst device") {
    myparms.dstDevice = hipDeviceptr_t(nullptr);
    myparms.dstArray = nullptr;
    myparms.dstPitch = pitch_D;
    myparms.dstHeight = height;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Nullptr to src/dst array") {
    myparms.dstArray = nullptr;
    REQUIRE(hipDrvMemcpy3D(&myparms) != hipSuccess);
  }

  SECTION("Nullptr to hipDrvMemcpy3D") { REQUIRE(hipDrvMemcpy3D(nullptr) != hipSuccess); }

  DeAllocateMemory();
}
/*
This function verifies the Extent validation scenarios of
hipDrvMemcpy3D API
*/
template <typename T> void DrvMemcpy3D<T>::Extent_Validation() {
  HIP_CHECK(hipSetDevice(0));
  // Allocating the memory
  AllocateMemory();

  // Setting default data
  SetDefaultData();
  myparms.srcMemoryType = hipMemoryTypeHost;
  myparms.dstMemoryType = hipMemoryTypeDevice;
  myparms.srcHost = hData;
  myparms.srcPitch = width * sizeof(T);
  myparms.srcHeight = height;
  myparms.dstDevice = D_m;
  myparms.dstPitch = pitch_D;
  myparms.dstHeight = height;

  SECTION("WidthInBytes is 0") {
    myparms.WidthInBytes = 0;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));
  }

  SECTION("Height is 0") {
    myparms.Height = 0;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));
  }

  SECTION("Depth is 0") {
    myparms.Depth = 0;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));
  }

  DeAllocateMemory();
}
/*
This Function verifies following functionalities of hipDrvMemcpy3D API
1. Host to Device copy
2. Device to Device
3. Device to Host
In the end  validates the results.

This functionality is verified in 2 scenarios
1. Basic scenario on same GPU device
2. Device context change scenario where memory is allocated in 1 GPU
   and hipDrvMemcpy3D API is trigerred from another GPU
*/
template <typename T> void DrvMemcpy3D<T>::HostDevice_DrvMemcpy3D(bool device_context_change) {
  HIP_CHECK(hipSetDevice(0));
  bool skip_test = false;
  int peerAccess = 0;
  AllocateMemory();
  if (device_context_change) {
    HIP_CHECK(hipDeviceCanAccessPeer(&peerAccess, 0, 1));
    if (!peerAccess) {
      HIP_SKIP_TEST(HipTest::SkipReason::kPeerAccessUnavailable);
      skip_test = true;
    } else {
      HIP_CHECK(hipSetDevice(1));
    }
  }
  if (!skip_test) {
    SetDefaultData();
    myparms.srcMemoryType = hipMemoryTypeHost;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    myparms.srcHost = hData;
    myparms.srcPitch = width * sizeof(T);
    myparms.srcHeight = height;
    myparms.dstDevice = hipDeviceptr_t(D_m);
    myparms.dstPitch = pitch_D;
    myparms.dstHeight = height;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));

    // Device to Device
    SetDefaultData();
    myparms.srcMemoryType = hipMemoryTypeDevice;
    myparms.dstMemoryType = hipMemoryTypeDevice;
    myparms.srcDevice = hipDeviceptr_t(D_m);
    myparms.srcPitch = pitch_D;
    myparms.srcHeight = height;
    myparms.dstDevice = hipDeviceptr_t(E_m);
    myparms.dstPitch = pitch_E;
    myparms.dstHeight = height;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));
    T* hOutputData = reinterpret_cast<T*>(malloc(size));
    memset(hOutputData, 0, size);

    // Device to host
    SetDefaultData();
    myparms.srcMemoryType = hipMemoryTypeDevice;
    myparms.dstMemoryType = hipMemoryTypeHost;
    myparms.srcDevice = hipDeviceptr_t(E_m);
    myparms.srcPitch = pitch_E;
    myparms.srcHeight = height;
    myparms.dstHost = hOutputData;
    myparms.dstPitch = width * sizeof(T);
    myparms.dstHeight = height;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));

    HipTest::checkArray(hData, hOutputData, width, height, depth);
    free(hOutputData);
  }
  DeAllocateMemory();
}

/*
This Function verifies following functionalities of hipDrvMemcpy3D API
1. Host to Array copy
2. Array to Array
3. Array to Host
In the end  validates the results.

This functionality is verified in 2 scenarios
1. Basic scenario on same GPU device
2. Device context change scenario where memory is allocated in 1 GPU
   and hipDrvMemcpy3D API is trigerred from another GPU
*/
template <typename T> void DrvMemcpy3D<T>::HostArray_DrvMemcpy3D(bool device_context_change) {
  HIP_CHECK(hipSetDevice(0));
  bool skip_test = false;
  int peerAccess = 0;
  AllocateMemory();
  if (device_context_change) {
    HIP_CHECK(hipDeviceCanAccessPeer(&peerAccess, 0, 1));
    if (!peerAccess) {
      HIP_SKIP_TEST(HipTest::SkipReason::kPeerAccessUnavailable);
      skip_test = true;
    } else {
      HIP_CHECK(hipSetDevice(1));
    }
  }
  if (!skip_test) {
    SetDefaultData();
    myparms.srcMemoryType = hipMemoryTypeHost;
    myparms.dstMemoryType = hipMemoryTypeArray;
    myparms.srcHost = hData;
    myparms.srcPitch = width * sizeof(T);
    myparms.srcHeight = height;
    myparms.dstArray = arr;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));
    // Array to Array
    SetDefaultData();
    myparms.srcMemoryType = hipMemoryTypeArray;
    myparms.dstMemoryType = hipMemoryTypeArray;
    myparms.srcArray = arr;
    myparms.dstArray = arr1;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));
    T* hOutputData = reinterpret_cast<T*>(malloc(size));
    memset(hOutputData, 0, size);
    SetDefaultData();
    // Device to host
    myparms.srcMemoryType = hipMemoryTypeArray;
    myparms.dstMemoryType = hipMemoryTypeHost;
    myparms.srcArray = arr1;
    myparms.dstHost = hOutputData;
    myparms.dstPitch = width * sizeof(T);
    myparms.dstHeight = height;
    HIP_CHECK(hipDrvMemcpy3D(&myparms));

    HipTest::checkArray(hData, hOutputData, width, height, depth);
    free(hOutputData);
  }
  DeAllocateMemory();
}
/* DeAllocating the memory */
template <typename T> void DrvMemcpy3D<T>::DeAllocateMemory() {
  HIP_CHECK(hipArrayDestroy(arr));
  HIP_CHECK(hipArrayDestroy(arr1));
  free(hData);
}

/**
 * Test Description
 * ------------------------
 *  - Verifying hipDrvMemcpy3D API Host to Array for different datatypes
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEMPLATE_TEST_CASE(Unit_hipDrvMemcpy3D_MultipleDataTypes, uint8_t, int, float) {
  CHECK_IMAGE_SUPPORT
  for (int i = 1; i < 25; i++) {
    if (std::is_same<TestType, float>::value) {
      DrvMemcpy3D<TestType> memcpy3d_float(i, i, i, HIP_AD_FORMAT_FLOAT);
      memcpy3d_float.HostArray_DrvMemcpy3D();
    } else if (std::is_same<TestType, uint8_t>::value) {
      DrvMemcpy3D<TestType> memcpy3d_intx(i, i, i, HIP_AD_FORMAT_UNSIGNED_INT8);
      memcpy3d_intx.HostArray_DrvMemcpy3D();
    } else if (std::is_same<TestType, int>::value) {
      DrvMemcpy3D<TestType> memcpy3d_inty(i, i, i, HIP_AD_FORMAT_SIGNED_INT32);
      memcpy3d_inty.HostArray_DrvMemcpy3D();
    }
  }
}

/**
 * Test Description
 * ------------------------
 *  - This testcase verifies H2D copy of hipDrvMemcpy3D API
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEST_CASE(Unit_hipDrvMemcpy3D_HosttoDevice) {
  CHECK_IMAGE_SUPPORT
  DrvMemcpy3D<float> memcpy3d_D2H_float(10, 10, 1, HIP_AD_FORMAT_FLOAT);
  memcpy3d_D2H_float.HostDevice_DrvMemcpy3D();
}

#if HT_NVIDIA
/**
 * Test Description
 * ------------------------
 *  - This testcase verifies negative scenarios of hipDrvMemcpy3D API
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEST_CASE(Unit_hipDrvMemcpy3D_Negative) {
  CHECK_IMAGE_SUPPORT
  DrvMemcpy3D<float> memcpy3d(10, 10, 1, HIP_AD_FORMAT_FLOAT);
  memcpy3d.NegativeTests();
}
#endif

/**
 * Test Description
 * ------------------------
 *  - This testcase verifies extent validation scenarios of hipDrvMemcpy3D API
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEST_CASE(Unit_hipDrvMemcpy3D_ExtentValidation) {
  CHECK_IMAGE_SUPPORT
  DrvMemcpy3D<float> memcpy3d(10, 10, 1, HIP_AD_FORMAT_FLOAT);
  memcpy3d.Extent_Validation();
}

/**
 * Test Description
 * ------------------------
 *  - This testcase verifies H2D copy in device context
      change scenario for hipDrvMemcpy3D API
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEST_CASE(Unit_hipDrvMemcpy3D_H2DDeviceContextChange) {
  CHECK_IMAGE_SUPPORT
  int numDevices = 0;
  HIP_CHECK(hipGetDeviceCount(&numDevices));
  if (numDevices > 1) {
    DrvMemcpy3D<float> memcpy3d(10, 10, 1, HIP_AD_FORMAT_FLOAT);
    memcpy3d.HostDevice_DrvMemcpy3D(true);
  } else {
    HIP_SKIP_TEST(HipTest::SkipReason::kFewerThanTwoGpus);
  }
}

/**
 * Test Description
 * ------------------------
 *  - This testcase verifies Host to Array copy in device context
      change scenario for hipDrvMemcpy3D API
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEST_CASE(Unit_hipDrvMemcpy3D_Host2ArrayDeviceContextChange) {
  CHECK_IMAGE_SUPPORT
  int numDevices = 0;
  HIP_CHECK(hipGetDeviceCount(&numDevices));
  if (numDevices > 1) {
    DrvMemcpy3D<float> memcpy3d(10, 10, 1, HIP_AD_FORMAT_FLOAT);
    memcpy3d.HostArray_DrvMemcpy3D(true);
  } else {
    HIP_SKIP_TEST(HipTest::SkipReason::kFewerThanTwoGpus);
  }
}

/**
 * Test Description
 * ------------------------
 *  - This testcase performs multidevice size check on hipDrvMemcpy3D API
      1. Verify with 128 for all height, width & depth value
      2. Verify with 256 for height and 128 for width & depth value
      3. Verify with 256 for width and 128 for height & depth value
      4. Verify with 256 for depth and 128 for height & width value
 * Test source
 * ------------------------
 *  - unit/memory/hipDrvMemcpy3D_old.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 6.0
 */

HIP_TEST_CASE(Unit_hipDrvMemcpy3D_multiDevice_Basic_Size_Test) {
  CHECK_IMAGE_SUPPORT
  constexpr int size_128b = 128, size_256b = 256;
  int numDevices = 0;
  HIP_CHECK(hipGetDeviceCount(&numDevices));

  for (int i = 0; i < numDevices; i++) {
    HIP_CHECK(hipSetDevice(i));

    SECTION("Verify with 128 for all height, width & depth value") {
      DrvMemcpy3D<int> memcpy3d(size_128b, size_128b, size_128b, HIP_AD_FORMAT_SIGNED_INT32);
      memcpy3d.HostArray_DrvMemcpy3D();
    }
    SECTION("Verify with 256 for height and 128 for width & depth value") {
      DrvMemcpy3D<int> memcpy3d(size_256b, size_128b, size_128b, HIP_AD_FORMAT_SIGNED_INT32);
      memcpy3d.HostArray_DrvMemcpy3D();
    }
    SECTION("Verify with 256 for width and 128 for height & depth value") {
      DrvMemcpy3D<float> memcpy3d(size_128b, size_256b, size_128b, HIP_AD_FORMAT_FLOAT);
      memcpy3d.HostArray_DrvMemcpy3D();
    }
    SECTION("Verify with 256 for depth and 128 for height & width value") {
      DrvMemcpy3D<int> memcpy3d(size_128b, size_128b, size_256b, HIP_AD_FORMAT_SIGNED_INT32);
      memcpy3d.HostArray_DrvMemcpy3D();
    }
  }
}

/**
 * End doxygen group MemoryTest.
 * @}
 */