SWDEV-421025 - Catch Tests for Graph Instantiate With Params

Change-Id: I2f2387e3c00807cad5a4a807e289aecc45368d8c [ROCm/hip-tests commit: 7279e09b73]
2024-02-05 23:04:20 +00:00
commit 83bc874993
@@ -35,6 +35,7 @@ set(TEST_SRC
  hipGraphAddMemcpyNode_old.cc
  hipGraphClone.cc
  hipGraphInstantiateWithFlags.cc
+  hipGraphInstantiateWithParams.cc
  hipGraphAddHostNode.cc
  hipGraphAddMemcpyNodeFromSymbol_old.cc
  hipGraphAddMemcpyNodeFromSymbol.cc
@@ -0,0 +1,289 @@
+/*
+Copyright (c) 2024 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 WARRANNTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNNESS 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 INN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR INN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
+/*
+hipGraphInstantiateWithParams(hipGraphExec_t* pGraphExec, hipGraph_t graph,
+                                                                hipGraphInstantiateParams *params);
+Testcase Scenarios of hipGraphInstantiateWithParams API:
+Negative:
+1) Pass nullptr to pGraphExec
+2) Pass nullptr to graph
+3) Pass nullptr to params
+4) Pass invalid flag
+Functional:
+1) Create dependencies graph and instantiate the graph
+2) Create stream capture graph and instantite the graph
+*/
+
+
+#include <hip_test_common.hh>
+#include <hip_test_checkers.hh>
+#include <hip_test_kernels.hh>
+
+#if CUDA_VERSION >= CUDA_12000
+
+constexpr size_t N = 1000000;
+/**
+* Test Description
+* ------------------------
+* - Test covers the negative scenarios of hipGraphInstantiateWithParams API
+
+* Test source
+* ------------------------
+* - catch/unit/graph/hipGraphInstantiateWithParams.cc
+* Test requirements
+* ------------------------
+* - HIP_VERSION >= 6.2
+*/
+TEST_CASE("Unit_hipGraphInstantiateWithParams_Negative") {
+  SECTION("Passing nullptr pGraphExec") {
+    hipGraph_t graph;
+    hipGraphInstantiateParams params;
+    HIP_CHECK(hipGraphCreate(&graph, 0));
+    REQUIRE(hipGraphInstantiateWithParams(nullptr,
+                                       graph, &params) == hipErrorInvalidValue);
+  }
+
+  SECTION("Passing nullptr to graph") {
+    hipGraphExec_t graphExec;
+    hipGraphInstantiateParams params;
+    REQUIRE(hipGraphInstantiateWithParams(&graphExec,
+                                     nullptr, &params) == hipErrorInvalidValue);
+  }
+
+  SECTION("Passing nullptr to params") {
+    hipGraph_t graph;
+    HIP_CHECK(hipGraphCreate(&graph, 0));
+    hipGraphExec_t graphExec;
+    REQUIRE(hipGraphInstantiateWithParams(&graphExec,
+                                       graph, nullptr) == hipErrorInvalidValue);
+  }
+
+  SECTION("Passing invalid flag") {
+    hipGraph_t graph;
+    HIP_CHECK(hipGraphCreate(&graph, 0));
+    hipGraphExec_t graphExec;
+    hipGraphInstantiateParams params;
+    params.flags = 10;
+    REQUIRE(hipGraphInstantiateWithParams(&graphExec,
+                                       graph, &params) == hipErrorInvalidValue);
+    REQUIRE(params.result_out == hipGraphInstantiateError);
+  }
+}
+
+void GraphInstantiateWithParams_DependencyGraph() {
+  constexpr size_t N = 1024;
+  constexpr size_t Nbytes = N * sizeof(int);
+  constexpr auto blocksPerCU = 6;  // to hide latency
+  constexpr auto threadsPerBlock = 256;
+  hipGraph_t graph;
+  hipGraphNode_t memset_A, memset_B, memsetKer_C;
+  hipGraphNode_t memcpyH2D_A, memcpyH2D_B, memcpyD2H_C;
+  hipGraphNode_t kernel_vecAdd;
+  hipKernelNodeParams kernelNodeParams{};
+  int *A_d, *B_d, *C_d;
+  int *A_h, *B_h, *C_h;
+  hipGraphExec_t graphExec;
+  hipMemsetParams memsetParams{};
+  int memsetVal{};
+  size_t NElem{N};
+
+  HipTest::initArrays(&A_d, &B_d, &C_d, &A_h, &B_h, &C_h, N, false);
+  unsigned blocks = HipTest::setNumBlocks(blocksPerCU, threadsPerBlock, N);
+
+  HIP_CHECK(hipGraphCreate(&graph, 0));
+
+  memset(&memsetParams, 0, sizeof(memsetParams));
+  memsetParams.dst = reinterpret_cast<void*>(A_d);
+  memsetParams.value = 0;
+  memsetParams.pitch = 0;
+  memsetParams.elementSize = sizeof(char);
+  memsetParams.width = Nbytes;
+  memsetParams.height = 1;
+  HIP_CHECK(hipGraphAddMemsetNode(&memset_A, graph, nullptr, 0,
+                                                              &memsetParams));
+
+  memset(&memsetParams, 0, sizeof(memsetParams));
+  memsetParams.dst = reinterpret_cast<void*>(B_d);
+  memsetParams.value = 0;
+  memsetParams.pitch = 0;
+  memsetParams.elementSize = sizeof(char);
+  memsetParams.width = Nbytes;
+  memsetParams.height = 1;
+  HIP_CHECK(hipGraphAddMemsetNode(&memset_B, graph, nullptr, 0,
+                                                              &memsetParams));
+
+  void* kernelArgs1[] = {&C_d, &memsetVal, reinterpret_cast<void *>(&NElem)};
+  kernelNodeParams.func =
+                       reinterpret_cast<void *>(HipTest::memsetReverse<int>);
+  kernelNodeParams.gridDim = dim3(blocks);
+  kernelNodeParams.blockDim = dim3(threadsPerBlock);
+  kernelNodeParams.sharedMemBytes = 0;
+  kernelNodeParams.kernelParams = reinterpret_cast<void**>(kernelArgs1);
+  kernelNodeParams.extra = nullptr;
+  HIP_CHECK(hipGraphAddKernelNode(&memsetKer_C, graph, nullptr, 0,
+                                                        &kernelNodeParams));
+
+  HIP_CHECK(hipGraphAddMemcpyNode1D(&memcpyH2D_A, graph, nullptr, 0, A_d, A_h,
+                                   Nbytes, hipMemcpyHostToDevice));
+  HIP_CHECK(hipGraphAddMemcpyNode1D(&memcpyH2D_B, graph, nullptr, 0, B_d, B_h,
+                                   Nbytes, hipMemcpyHostToDevice));
+
+  HIP_CHECK(hipGraphAddMemcpyNode1D(&memcpyD2H_C, graph, nullptr, 0, C_h, C_d,
+                                   Nbytes, hipMemcpyDeviceToHost));
+
+  void* kernelArgs2[] = {&A_d, &B_d, &C_d, reinterpret_cast<void *>(&NElem)};
+  kernelNodeParams.func = reinterpret_cast<void *>(HipTest::vectorADD<int>);
+  kernelNodeParams.gridDim = dim3(blocks);
+  kernelNodeParams.blockDim = dim3(threadsPerBlock);
+  kernelNodeParams.sharedMemBytes = 0;
+  kernelNodeParams.kernelParams = reinterpret_cast<void**>(kernelArgs2);
+  kernelNodeParams.extra = nullptr;
+  HIP_CHECK(hipGraphAddKernelNode(&kernel_vecAdd, graph, nullptr, 0,
+                                                        &kernelNodeParams));
+
+  // Create dependencies
+  HIP_CHECK(hipGraphAddDependencies(graph, &memset_A, &memcpyH2D_A, 1));
+  HIP_CHECK(hipGraphAddDependencies(graph, &memset_B, &memcpyH2D_B, 1));
+  HIP_CHECK(hipGraphAddDependencies(graph, &memcpyH2D_A, &kernel_vecAdd, 1));
+  HIP_CHECK(hipGraphAddDependencies(graph, &memcpyH2D_B, &kernel_vecAdd, 1));
+  HIP_CHECK(hipGraphAddDependencies(graph, &memsetKer_C, &kernel_vecAdd, 1));
+  HIP_CHECK(hipGraphAddDependencies(graph, &kernel_vecAdd, &memcpyD2H_C, 1));
+
+  // Instantiate and launch the cloned graph
+  hipGraphInstantiateParams params;
+  params.flags = 0;
+  HIP_CHECK(hipGraphInstantiateWithParams(&graphExec, graph, &params));
+  REQUIRE(params.result_out == hipGraphInstantiateSuccess);
+
+  HIP_CHECK(hipGraphLaunch(graphExec, 0));
+  HIP_CHECK(hipStreamSynchronize(0));
+
+  // Verify graph execution result
+  HipTest::checkVectorADD(A_h, B_h, C_h, N);
+  HipTest::freeArrays(A_d, B_d, C_d, A_h, B_h, C_h, false);
+  HIP_CHECK(hipGraphExecDestroy(graphExec));
+  HIP_CHECK(hipGraphDestroy(graph));
+}
+
+void GraphInstantiateWithParams_StreamCapture() {
+  float *A_d, *C_d;
+  float *A_h, *C_h;
+  size_t Nbytes = N * sizeof(float);
+  hipStream_t stream;
+  hipGraph_t graph{nullptr};
+  hipGraphExec_t graphExec{nullptr};
+
+  A_h = reinterpret_cast<float*>(malloc(Nbytes));
+  C_h = reinterpret_cast<float*>(malloc(Nbytes));
+  REQUIRE(A_h != nullptr);
+  REQUIRE(C_h != nullptr);
+
+  // Fill with Phi + i
+  for (size_t i = 0; i < N; i++) {
+      A_h[i] = 1.618f + i;
+  }
+  HIP_CHECK(hipMalloc(&A_d, Nbytes));
+  HIP_CHECK(hipMalloc(&C_d, Nbytes));
+  REQUIRE(A_d != nullptr);
+  REQUIRE(C_d != nullptr);
+  HIP_CHECK(hipGraphCreate(&graph, 0));
+
+
+  HIP_CHECK(hipStreamCreate(&stream));
+  constexpr unsigned blocks = 512;
+  constexpr unsigned threadsPerBlock = 256;
+
+  HIP_CHECK(hipStreamBeginCapture(stream, hipStreamCaptureModeGlobal));
+  HIP_CHECK(hipMemcpyAsync(A_d, A_h, Nbytes, hipMemcpyHostToDevice, stream));
+
+  HIP_CHECK(hipMemsetAsync(C_d, 0, Nbytes, stream));
+  hipLaunchKernelGGL(HipTest::vector_square, dim3(blocks),
+                              dim3(threadsPerBlock), 0, stream, A_d, C_d, N);
+  HIP_CHECK(hipMemcpyAsync(C_h, C_d, Nbytes, hipMemcpyDeviceToHost, stream));
+
+  HIP_CHECK(hipStreamEndCapture(stream, &graph));
+
+  // Validate end capture is successful
+  REQUIRE(graph != nullptr);
+  hipGraphInstantiateParams params;
+  params.flags = 0;
+  HIP_CHECK(hipGraphInstantiateWithParams(&graphExec, graph, &params));
+  REQUIRE(graphExec != nullptr);
+  REQUIRE(params.result_out == hipGraphInstantiateSuccess);
+
+  HIP_CHECK(hipGraphLaunch(graphExec, stream));
+
+  HIP_CHECK(hipStreamSynchronize(stream));
+
+  HIP_CHECK(hipGraphExecDestroy(graphExec));
+  HIP_CHECK(hipGraphDestroy(graph));
+
+  // Validate the computation
+  for (size_t i = 0; i < N; i++) {
+    if (C_h[i] != A_h[i] * A_h[i]) {
+      UNSCOPED_INFO("A and C not matching at " << i);
+      REQUIRE(false);
+    }
+  }
+
+  HIP_CHECK(hipStreamDestroy(stream));
+  free(A_h);
+  free(C_h);
+  HIP_CHECK(hipFree(A_d));
+  HIP_CHECK(hipFree(C_d));
+}
+
+/**
+* Test Description
+* ------------------------
+* - Verifies hipGraphInstantiateWithParams API by creating dependency graph
+* - and instantiate, launch and verify the result
+*
+* Test source
+* ------------------------
+* - catch/unit/graph/hipGraphInstantiateWithParams.cc
+* Test requirements
+* ------------------------
+* - HIP_VERSION >= 6.2
+*/
+TEST_CASE("Unit_hipGraphInstantiateWithParams_DependencyGraph") {
+  GraphInstantiateWithParams_DependencyGraph();
+}
+
+
+/**
+* Test Description
+* ------------------------
+* - Verifies hipGraphInstantiateWithParams API by using StreamCapture
+* - to create create a graph and instantiate, launch and verify results
+*
+* Test source
+* ------------------------
+* - catch/unit/graph/hipGraphInstantiateWithParams.cc
+* Test requirements
+* ------------------------
+* - HIP_VERSION >= 6.2
+*/
+TEST_CASE("Unit_hipGraphInstantiateWithParams_StreamCapture") {
+      GraphInstantiateWithParams_StreamCapture();
+}
+
+
+#endif // CUDA_VERSION >= CUDA_12000