EXSWHTEC-112 - Implement tests for hipModuleGetFunction

catch/unit/CMakeLists.txt

@@ -35,6 +35,7 @@ add_subdirectory(multiThread)
 add_subdirectory(compiler)
 add_subdirectory(errorHandling)
 add_subdirectory(cooperativeGrps)
+add_subdirectory(module)
 add_subdirectory(context)
 add_subdirectory(warp)
 add_subdirectory(dynamicLoading)

catch/unit/module/CMakeLists.txt

@@ -19,11 +19,21 @@
 # SOFTWARE.
 
 # Common Tests - Test independent of all platforms
-if(HIP_PLATFORM MATCHES "amd")
 set(TEST_SRC
-    hipExtModuleLaunchKernel.cc
+    hip_module_common.cc
+    hipModuleGetFunction.cc
 )
 
+add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/get_function_module.code
+                   COMMAND ${CMAKE_CXX_COMPILER} --genco --std=c++17 ${CMAKE_CURRENT_SOURCE_DIR}/get_function_module.cc -o get_function_module.code
+                   DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/get_function_module.cc)   
+add_custom_target(get_function_module ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/get_function_module.code)
+
+if(HIP_PLATFORM MATCHES "amd")
+set(TEST_SRC
+    ${TEST_SRC}
+    hipExtModuleLaunchKernel.cc)
+
 # Note to pass arch use format like -DOFFLOAD_ARCH_STR="--offload-arch=gfx900  --offload-arch=gfx906"
 # having space at the start/end of OFFLOAD_ARCH_STR can cause build failures
 
@@ -100,11 +110,22 @@ add_custom_target(copiousArgKernel17.code
                   -I${CMAKE_CURRENT_SOURCE_DIR}/../../../../include/
                   -I${CMAKE_CURRENT_SOURCE_DIR}/../../include --rocm-path=${ROCM_PATH})
 endif()
+endif()
 
+if(HIP_PLATFORM MATCHES "amd")
+    set(RTCLIB "hiprtc")
+else()
+    set(RTCLIB "nvrtc")
+endif()
 hip_add_exe_to_target(NAME ModuleTest
   TEST_SRC ${TEST_SRC}
-  TEST_TARGET_NAME build_tests COMMON_SHARED_SRC ${COMMON_SHARED_SRC})
+  TEST_TARGET_NAME build_tests
+  LINKER_LIBS ${RTCLIB}
+  COMMON_SHARED_SRC ${COMMON_SHARED_SRC})
+
+add_dependencies(ModuleTest get_function_module)
 
+if(HIP_PLATFORM MATCHES "amd")
 add_dependencies(build_tests copyKernel.code copyKernel.s)
 if(UNIX)
 add_dependencies(build_tests copiousArgKernel.code copiousArgKernel0.code copiousArgKernel1.code copiousArgKernel2.code

catch/unit/module/get_function_module.cc

@@ -0,0 +1,28 @@
+/*
+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.
+*/
+
+#include <hip/hip_runtime_api.h>
+
+extern "C" {
+__global__ void GlobalKernel() {}
+
+__device__ void DeviceKernel() {}
+}

catch/unit/module/hipModuleGetFunction.cc

@@ -0,0 +1,74 @@
+/*
+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.
+*/
+
+#include "hip_module_common.hh"
+
+#include <hip_test_common.hh>
+#include <hip/hip_runtime_api.h>
+
+static hipModule_t GetModule() {
+  HIP_CHECK(hipFree(nullptr));
+  static const auto mg = ModuleGuard::LoadModule("get_function_module.code");
+  return mg.module();
+}
+
+TEST_CASE("Unit_hipModuleGetFunction_Positive_Basic") {
+  hipFunction_t kernel = nullptr;
+  HIP_CHECK(hipModuleGetFunction(&kernel, GetModule(), "GlobalKernel"));
+  REQUIRE(kernel != nullptr);
+}
+
+TEST_CASE("Unit_hipModuleGetFunction_Negative_Parameters") {
+  hipFunction_t kernel = nullptr;
+
+  SECTION("function == nullptr") {
+    HIP_CHECK_ERROR(hipModuleGetFunction(nullptr, GetModule(), "GlobalKernel"),
+                    hipErrorInvalidValue);
+  }
+
+// Disabled on AMD due to defect - EXSWHTEC-154
+#if HT_NVIDIA
+  SECTION("module == nullptr") {
+    HIP_CHECK_ERROR(hipModuleGetFunction(&kernel, nullptr, "GlobalKernel"),
+                    hipErrorInvalidResourceHandle);
+  }
+#endif
+
+  SECTION("kname == nullptr") {
+    HIP_CHECK_ERROR(hipModuleGetFunction(&kernel, GetModule(), nullptr), hipErrorInvalidValue);
+  }
+
+// Disabled on AMD due to defect - EXSWHTEC-155
+#if HT_NVIDIA
+  SECTION("kname == empty string") {
+    HIP_CHECK_ERROR(hipModuleGetFunction(&kernel, GetModule(), ""), hipErrorInvalidValue);
+  }
+#endif
+
+  SECTION("kname == non existent kernel") {
+    HIP_CHECK_ERROR(hipModuleGetFunction(&kernel, GetModule(), "NonExistentKernel"),
+                    hipErrorNotFound);
+  }
+
+  SECTION("kname == __device__ kernel") {
+    HIP_CHECK_ERROR(hipModuleGetFunction(&kernel, GetModule(), "DeviceKernel"), hipErrorNotFound);
+  }
+}

catch/unit/module/hip_module_common.cc

@@ -0,0 +1,71 @@
+/*
+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.
+*/
+
+#include "hip_module_common.hh"
+
+#include <experimental/filesystem>
+#include <fstream>
+
+#include <hip_test_common.hh>
+#include <hip/hiprtc.h>
+
+ModuleGuard ModuleGuard::LoadModule(const char* fname) {
+  hipModule_t module = nullptr;
+  HIP_CHECK(hipModuleLoad(&module, fname));
+  return ModuleGuard{module};
+}
+
+ModuleGuard ModuleGuard::LoadModuleDataFile(const char* fname) {
+  const auto loaded_module = LoadModuleIntoBuffer(fname);
+  hipModule_t module = nullptr;
+  HIP_CHECK(hipModuleLoadData(&module, loaded_module.data()));
+  return ModuleGuard{module};
+}
+
+ModuleGuard ModuleGuard::LoadModuleDataRTC(const char* code) {
+  const auto rtc = CreateRTCCharArray(code);
+  hipModule_t module = nullptr;
+  HIP_CHECK(hipModuleLoadData(&module, rtc.data()));
+  return ModuleGuard{module};
+}
+
+// Load module into buffer instead of mapping file to avoid platform specific mechanisms
+std::vector<char> LoadModuleIntoBuffer(const char* path_string) {
+  std::experimental::filesystem::path p(path_string);
+  const auto file_size = std::experimental::filesystem::file_size(p);
+  std::ifstream f(p, std::ios::binary | std::ios::in);
+  REQUIRE(f);
+  std::vector<char> empty_module(file_size);
+  REQUIRE(f.read(empty_module.data(), file_size));
+  return empty_module;
+}
+
+std::vector<char> CreateRTCCharArray(const char* src) {
+  hiprtcProgram prog;
+  HIPRTC_CHECK(hiprtcCreateProgram(&prog, src, "prog", 0, nullptr, nullptr));
+  HIPRTC_CHECK(hiprtcCompileProgram(prog, 0, nullptr));
+  size_t code_size = 0;
+  HIPRTC_CHECK(hiprtcGetCodeSize(prog, &code_size));
+  std::vector<char> code(code_size, '\0');
+  HIPRTC_CHECK(hiprtcGetCode(prog, code.data()));
+  HIPRTC_CHECK(hiprtcDestroyProgram(&prog));
+  return code;
+}

catch/unit/module/hip_module_common.hh

@@ -0,0 +1,57 @@
+/*
+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.
+*/
+
+#pragma once
+
+#include <vector>
+
+#include <hip_test_common.hh>
+
+class ModuleGuard {
+ public:
+  ~ModuleGuard() { static_cast<void>(hipModuleUnload(module_)); }
+
+  ModuleGuard(const ModuleGuard&) = delete;
+  ModuleGuard(ModuleGuard&&) = delete;
+
+  static ModuleGuard LoadModule(const char* fname);
+
+  static ModuleGuard LoadModuleDataFile(const char* fname);
+
+  static ModuleGuard LoadModuleDataRTC(const char* code);
+
+  hipModule_t module() const { return module_; }
+
+ private:
+  ModuleGuard(const hipModule_t module) : module_{module} {}
+  hipModule_t module_ = nullptr;
+};
+
+// Load module into buffer instead of mapping file to avoid platform specific mechanisms
+std::vector<char> LoadModuleIntoBuffer(const char* path_string);
+
+std::vector<char> CreateRTCCharArray(const char* src);
+
+inline hipFunction_t GetKernel(const hipModule_t module, const char* kname) {
+  hipFunction_t kernel = nullptr;
+  HIP_CHECK(hipModuleGetFunction(&kernel, module, kname));
+  return kernel;
+}