Add 'projects/hip-tests/' from commit '5ce508401e1934053b127de5bf756dcd56a326a2'

git-subtree-dir: projects/hip-tests
git-subtree-mainline: cc7a96c46f
git-subtree-split: 5ce508401e

projects/hip-tests/catch/unit/occupancy/hipModuleOccupancyMaxActiveBlocksPerMultiprocessor.cc

@@ -0,0 +1,164 @@
+/*
+Copyright (c) 2022 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.
+*/
+/*
+Testcase Scenarios :
+Unit_hipModuleOccupancyMaxActiveBlocksPerMultiprocessor_Positive_RangeValidation - Test correct
+execution of hipModuleOccupancyMaxActiveBlocksPerMultiprocessor for diffrent parameter values
+Unit_hipModuleOccupancyMaxActiveBlocksPerMultiprocessor_Negative_Parameters - Test unsuccessful
+execution of hipModuleOccupancyMaxActiveBlocksPerMultiprocessor api when parameters are invalid
+*/
+#include <hip_test_kernels.hh>
+#include "occupancy_common.hh"
+
+TEST_CASE("Unit_hipModuleOccupancyMaxActiveBlocksPerMultiprocessor_Negative_Parameters") {
+  hipModule_t module;
+  hipFunction_t function;
+  int blockSize = 0;
+  int gridSize = 0;
+
+  HIP_CHECK(hipFree(nullptr));
+
+  HIP_CHECK(hipModuleLoad(&module, "simple_kernel.code"));
+  HIPCHECK(hipModuleGetFunction(&function, module, "SimpleKernel"));
+
+  // Get potential blocksize
+  HIP_CHECK(hipModuleOccupancyMaxPotentialBlockSize(&gridSize, &blockSize, function, 0, 0));
+
+  // Common negative tests
+  MaxActiveBlocksPerMultiprocessorNegative(
+      [&function](int* numBlocks, int blockSize, size_t dynSharedMemPerBlk) {
+        return hipModuleOccupancyMaxActiveBlocksPerMultiprocessor(numBlocks, function, blockSize,
+                                                                  dynSharedMemPerBlk);
+      },
+      blockSize);
+
+  HIP_CHECK(hipModuleUnload(module));
+}
+
+TEST_CASE("Unit_hipModuleOccupancyMaxActiveBlocksPerMultiprocessor_Positive_RangeValidation") {
+  hipDeviceProp_t devProp;
+  hipModule_t module;
+  hipFunction_t function;
+  int blockSize = 0;
+  int gridSize = 0;
+
+  HIP_CHECK(hipFree(nullptr));
+
+  HIP_CHECK(hipModuleLoad(&module, "simple_kernel.code"));
+  HIPCHECK(hipModuleGetFunction(&function, module, "SimpleKernel"));
+
+  HIP_CHECK(hipGetDeviceProperties(&devProp, 0));
+
+  SECTION("dynSharedMemPerBlk = 0") {
+    // Get potential blocksize
+    HIP_CHECK(hipModuleOccupancyMaxPotentialBlockSize(&gridSize, &blockSize, function, 0, 0));
+
+    MaxActiveBlocksPerMultiprocessor(
+        [blockSize, &function](int* numBlocks) {
+          return hipModuleOccupancyMaxActiveBlocksPerMultiprocessor(numBlocks, function, blockSize,
+                                                                    0);
+        },
+        blockSize, devProp.maxThreadsPerMultiProcessor);
+  }
+  SECTION("dynSharedMemPerBlk = sharedMemPerBlock") {
+    // Get potential blocksize
+    HIP_CHECK(hipModuleOccupancyMaxPotentialBlockSize(&gridSize, &blockSize, function,
+                                                      devProp.sharedMemPerBlock, 0));
+
+    MaxActiveBlocksPerMultiprocessor(
+        [blockSize, devProp, &function](int* numBlocks) {
+          return hipModuleOccupancyMaxActiveBlocksPerMultiprocessor(numBlocks, function, blockSize,
+                                                                    devProp.sharedMemPerBlock);
+        },
+        blockSize, devProp.maxThreadsPerMultiProcessor);
+  }
+
+  HIP_CHECK(hipModuleUnload(module));
+}
+
+/**
+ * Test Description
+ * ------------------------
+ *  - This test case tests the behaviour of all Occupancy APIs
+ *  - during the the stream capture.
+ * Test source
+ * ------------------------
+ *  - unit/occupancy/hipModuleOccupancyMaxActiveBlocksPerMultiprocessor.cc
+ */
+TEST_CASE("Unit_OccupancyAPIs_StreamCapture") {
+  GENERATE_CAPTURE();
+
+  hipStream_t stream;
+  HIP_CHECK(hipStreamCreate(&stream));
+
+  hipModule_t module;
+  HIP_CHECK(hipModuleLoad(&module, "simple_kernel.code"));
+  REQUIRE(module != nullptr);
+  hipFunction_t function;
+  HIP_CHECK(hipModuleGetFunction(&function, module, "SimpleKernel"));
+  REQUIRE(function != nullptr);
+
+  BEGIN_CAPTURE(stream);
+
+  int gridSize = 0, blockSize = 0, numBlocks = 0;
+
+  HIP_CHECK(hipOccupancyMaxPotentialBlockSize(&gridSize, &blockSize,
+            reinterpret_cast<const void *>(HipTest::vectorADD<int>), 0, 0));
+  REQUIRE(gridSize > 0);
+  REQUIRE(blockSize > 0);
+
+  HIP_CHECK(hipOccupancyMaxActiveBlocksPerMultiprocessor(
+            &numBlocks, reinterpret_cast<const void *>(HipTest::vectorADD<int>),
+            blockSize, 0));
+  REQUIRE(numBlocks > 0);
+
+  numBlocks = 0;
+  HIP_CHECK(hipOccupancyMaxActiveBlocksPerMultiprocessorWithFlags(
+            &numBlocks, reinterpret_cast<const void *>(HipTest::vectorADD<int>),
+            blockSize, 0, 0));
+  REQUIRE(numBlocks > 0);
+
+  gridSize = 0, blockSize = 0;
+  HIP_CHECK(hipModuleOccupancyMaxPotentialBlockSize(&gridSize, &blockSize,
+                                                    function, 0, 0));
+  REQUIRE(gridSize > 0);
+  REQUIRE(blockSize > 0);
+
+  gridSize = 0; blockSize = 0;
+  HIP_CHECK(hipModuleOccupancyMaxPotentialBlockSizeWithFlags(
+            &gridSize, &blockSize, function, 0, 0, 0));
+  REQUIRE(gridSize > 0);
+  REQUIRE(blockSize > 0);
+
+  numBlocks = 0;
+  HIP_CHECK(hipModuleOccupancyMaxActiveBlocksPerMultiprocessor(
+            &numBlocks, function, blockSize, 0));
+  REQUIRE(numBlocks > 0);
+
+  numBlocks = 0;
+  HIP_CHECK(hipModuleOccupancyMaxActiveBlocksPerMultiprocessorWithFlags(
+            &numBlocks, function, blockSize, 0, 0));
+  REQUIRE(numBlocks > 0);
+
+  END_CAPTURE(stream);
+
+  HIP_CHECK(hipModuleUnload(module));
+  HIP_CHECK(hipStreamDestroy(stream));
+}
+