rocm-systems/projects/hip-tests/catch/unit/library/loadlib_co.cc

/*
Copyright (c) 2025 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.
*/

#include <hip_test_common.hh>


TEST_CASE("Unit_hip_library_load_co") {
  constexpr size_t size = 32;
  constexpr size_t num_kernels = 3;
  std::vector<float> input1, input2;
  input1.reserve(size);
  input2.reserve(size);
  for (size_t i = 0; i < size; i++) {
    input1[i] = (i + 1) * 2;
    input2[i] = i;
  }

  float *d_in1, *d_in2, *d_out;
  HIP_CHECK(hipMalloc(&d_in1, sizeof(float) * size));
  HIP_CHECK(hipMalloc(&d_in2, sizeof(float) * size));
  HIP_CHECK(hipMalloc(&d_out, sizeof(float) * size));

  HIP_CHECK(hipMemset(d_out, 0, sizeof(float) * size));
  HIP_CHECK(hipMemcpy(d_in1, input1.data(), sizeof(float) * size, hipMemcpyHostToDevice));
  HIP_CHECK(hipMemcpy(d_in2, input2.data(), sizeof(float) * size, hipMemcpyHostToDevice));

  hipStream_t stream;
  HIP_CHECK(hipStreamCreate(&stream));
  std::string lib_co = "library_code_load.code";
  
  auto host_verify = [](const std::vector<float>& x, const std::vector<float>&y, const std::vector<float>& expected, int op) {
    for (size_t i = 0; i < size; i++) {
      float tmp;
      switch(op) {
        case 0: tmp = x[i] + y[i]; break;
        case 1: tmp = x[i] - y[i]; break;
        case 2: tmp = x[i] * y[i]; break;
        default: tmp = 0;
      }
      REQUIRE(tmp == expected[i]);
    }
  };

  SECTION("One Kernel") {
    hipLibrary_t library;
    hipKernel_t function;

    HIP_CHECK(
        hipLibraryLoadFromFile(&library, lib_co.data(), nullptr, nullptr, 0, nullptr, nullptr, 0));
    HIP_CHECK(hipLibraryGetKernel(&function, library, "add_kernel"));

    hipLibrary_t new_library;
    HIP_CHECK(hipKernelGetLibrary(&new_library, function));
    REQUIRE(new_library == library);

    unsigned int count = 0;
    HIP_CHECK(hipLibraryGetKernelCount(&count, library));
    REQUIRE(count == 3);

    size_t offset, paramsize;
    for (size_t k = 0; k < count; ++k) {
      HIP_CHECK(hipKernelGetParamInfo(function, k, &offset, &paramsize));
      REQUIRE(offset == k * sizeof(float*));
      REQUIRE(paramsize == sizeof(float*));
    }

    void* args[] = {&d_out, &d_in1, &d_in2};

    HIP_CHECK(hipLaunchKernel(function, 1, size, args, 0, stream));
    HIP_CHECK(hipStreamSynchronize(stream));
    HIP_CHECK(hipLibraryUnload(library));


    std::vector<float> out(size, 0);
    HIP_CHECK(hipMemcpy(out.data(), d_out, sizeof(float) * size, hipMemcpyDeviceToHost));
    host_verify(input1, input2, out, 0);
  }

  SECTION("Two Kernel") {
    hipLibrary_t library;
    hipKernel_t function;

    HIP_CHECK(
        hipLibraryLoadFromFile(&library, lib_co.data(), nullptr, nullptr, 0, nullptr, nullptr, 0));
    HIP_CHECK(hipLibraryGetKernel(&function, library, "sub_kernel"));
    
    hipLibrary_t new_library;
    HIP_CHECK(hipKernelGetLibrary(&new_library, function));
    REQUIRE(new_library == library);

    unsigned int count = 0;
    HIP_CHECK(hipLibraryGetKernelCount(&count, library));
    REQUIRE(count == 3);

    size_t offset, paramsize;
    for (size_t k = 0; k < count; ++k) {
      HIP_CHECK(hipKernelGetParamInfo(function, k, &offset, &paramsize));
      REQUIRE(offset == k * sizeof(float*));
      REQUIRE(paramsize == sizeof(float*));
    }

    void* args[] = {&d_out, &d_in1, &d_in2};

    HIP_CHECK(hipLaunchKernel(function, 1, size, args, 0, stream));
    HIP_CHECK(hipStreamSynchronize(stream));
    HIP_CHECK(hipLibraryUnload(library));


    std::vector<float> out(size, 0);
    HIP_CHECK(hipMemcpy(out.data(), d_out, sizeof(float) * size, hipMemcpyDeviceToHost));
    host_verify(input1, input2, out, 1);
  }

  SECTION("Three Kernel") {
    hipLibrary_t library;
    hipKernel_t function;

    HIP_CHECK(
        hipLibraryLoadFromFile(&library, lib_co.data(), nullptr, nullptr, 0, nullptr, nullptr, 0));
    HIP_CHECK(hipLibraryGetKernel(&function, library, "mul_kernel"));
    
    hipLibrary_t new_library;
    HIP_CHECK(hipKernelGetLibrary(&new_library, function));
    REQUIRE(new_library == library);

    unsigned int count = 0;
    HIP_CHECK(hipLibraryGetKernelCount(&count, library));
    REQUIRE(count == 3);

    size_t offset, paramsize;
    for (size_t k = 0; k < count; ++k) {
      HIP_CHECK(hipKernelGetParamInfo(function, k, &offset, &paramsize));
      REQUIRE(offset == k * sizeof(float*));
      REQUIRE(paramsize == sizeof(float*));
    }

    void* args[] = {&d_out, &d_in1, &d_in2};

    HIP_CHECK(hipLaunchKernel(function, 1, size, args, 0, stream));
    HIP_CHECK(hipStreamSynchronize(stream));
    HIP_CHECK(hipLibraryUnload(library));


    std::vector<float> out(size, 0);
    HIP_CHECK(hipMemcpy(out.data(), d_out, sizeof(float) * size, hipMemcpyDeviceToHost));
    host_verify(input1, input2, out, 2);
  }

  SECTION("All Kernels") {
    hipLibrary_t library;
    hipKernel_t functions[num_kernels];

    HIP_CHECK(
      hipLibraryLoadFromFile(&library, lib_co.data(), nullptr, nullptr, 0, nullptr, nullptr, 0));
    
    HIP_CHECK(hipLibraryEnumerateKernels(functions, num_kernels, library));

    void* args[] = {&d_out, &d_in1, &d_in2};

    auto kernel_idx = [](const char* kName) {
      std::string ss = kName;
      if (ss == "add_kernel") {
        return 0;
      } else if (ss == "sub_kernel") {
        return 1;
      } else if (ss == "mul_kernel") {
        return 2;
      }
      return -1;
    };

    
    std::vector<float> out(size, 0);
    size_t offset, paramsize;
    for (int k = 0; k < num_kernels; k++) {
      const char* kName = nullptr;
      HIP_CHECK(hipKernelGetName(&kName, functions[k]));
      HIP_CHECK(hipKernelGetParamInfo(functions[k], k, &offset, &paramsize));
      REQUIRE(paramsize == sizeof(float*));
      REQUIRE(offset == k * sizeof(float*));
      HIP_CHECK(hipLaunchKernel(functions[k], 1, size, args, 0, stream));
      HIP_CHECK(hipStreamSynchronize(stream));
      HIP_CHECK(hipMemcpy(out.data(), d_out, sizeof(float) * size, hipMemcpyDeviceToHost));
      host_verify(input1, input2, out, kernel_idx(kName));
    }

    HIP_CHECK(hipLibraryUnload(library));

  }

  HIP_CHECK(hipStreamDestroy(stream));
  HIP_CHECK(hipFree(d_in1));
  HIP_CHECK(hipFree(d_in2));
  HIP_CHECK(hipFree(d_out));
}

TEST_CASE("Unit_hipKernelGetParamInfo_Negative") {
  size_t offset, paramsize;

  SECTION("Kernel as nullptr") {
    HIP_CHECK_ERROR(hipKernelGetParamInfo(nullptr, 0, &offset, &paramsize), hipErrorInvalidValue);
  }

  std::string lib_co = "library_code_load.code";
  hipLibrary_t library;
  hipKernel_t function;

  HIP_CHECK(
      hipLibraryLoadFromFile(&library, lib_co.data(), nullptr, nullptr, 0, nullptr, nullptr, 0));
  HIP_CHECK(hipLibraryGetKernel(&function, library, "mul_kernel"));

  SECTION("Param offset as nullptr") {
    HIP_CHECK_ERROR(hipKernelGetParamInfo(function, 0, nullptr, &paramsize), hipErrorInvalidValue);
  }

}