TheRock/rocm-systems/projects/hip-tests/catch/unit/texture/hipTexObjectTests.cc

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

#include <hip_test_common.hh>


class TexObjectTestWrapper {
 private:
  float* host_data_;
  bool ommit_destroy_;

 public:
  hipTextureObject_t texture_object = 0;
  HIP_RESOURCE_DESC res_desc;
  HIP_TEXTURE_DESC tex_desc;
  HIP_RESOURCE_VIEW_DESC res_view_desc;
  HIP_ARRAY_DESCRIPTOR array_desc;
  hipArray_t array_member;
  size_t size; /* size in bytes*/
  int width;   /* width in elements */

  TexObjectTestWrapper(bool useResourceViewDescriptor, bool ommitDestroy = false)
      : ommit_destroy_(ommitDestroy), width(128) {
    int i;
    size = width * sizeof(float);

    host_data_ = (float*)malloc(size);
    memset(host_data_, 0, size);

    for (i = 0; i < width; i++) {
      host_data_[i] = i;
    }

    memset(&array_desc, 0, sizeof(array_desc));
    array_desc.Format = HIP_AD_FORMAT_FLOAT;
    array_desc.NumChannels = 1;
    array_desc.Width = width;
    array_desc.Height = 0;

    HIP_CHECK(hipArrayCreate(&array_member, &array_desc));
    HIP_CHECK(hipMemcpyHtoA(reinterpret_cast<hipArray_t>(array_member), 0, host_data_, size));

    memset(&res_desc, 0, sizeof(res_desc));
    res_desc.resType = HIP_RESOURCE_TYPE_ARRAY;
    res_desc.res.array.hArray = array_member;
    res_desc.flags = 0;

    memset(&tex_desc, 0, sizeof(tex_desc));
    tex_desc.filterMode = HIP_TR_FILTER_MODE_POINT;
    tex_desc.flags = 0;

    memset(&res_view_desc, 0, sizeof(res_view_desc));


    if (useResourceViewDescriptor) {
#if HT_AMD
      res_view_desc.format = HIP_RES_VIEW_FORMAT_FLOAT_1X32;
      res_view_desc.width = size;
#else
      /* Resource View Descriptors are not supported on NVIDIA currently */
      useResourceViewDescriptor = false;
#endif
    }


    HIP_CHECK(hipTexObjectCreate(&texture_object, &res_desc, &tex_desc,
                                 useResourceViewDescriptor ? &res_view_desc : nullptr));
  }

  ~TexObjectTestWrapper() {
    if (!ommit_destroy_) {
      HIP_CHECK(hipTexObjectDestroy(texture_object));
    }
    HIP_CHECK(hipArrayDestroy(array_member));
    free(host_data_);
  }
};

/**
 * @addtogroup hipTexObjectGetResourceDesc hipTexObjectGetResourceDesc
 * @{
 * @ingroup TextureTest
 * `hipTexObjectGetResourceDesc(HIP_RESOURCE_DESC* pResDesc,
 * hipTextureObject_t texObject)` -
 * Gets resource descriptor of a texture object.
 */

/**
 * Test Description
 * ------------------------
 *  - Creates new texture object and an empty resource descriptor.
 *  - Gets resource descriptor from the texture.
 *  - Compares it to the empty created one.
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipGetTexObjectResourceDesc_positive) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();

  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(false);

  HIP_RESOURCE_DESC check_desc;
  memset(&check_desc, 0, sizeof(check_desc));

  HIP_CHECK(hipTexObjectGetResourceDesc(&check_desc, tex_obj_wrapper->texture_object));

  REQUIRE(check_desc.resType == tex_obj_wrapper->res_desc.resType);
  REQUIRE(check_desc.res.array.hArray == tex_obj_wrapper->res_desc.res.array.hArray);
  delete tex_obj_wrapper;
  CTX_DESTROY();
}

/**
 * Test Description
 * ------------------------
 *  - Validates handling of invalid arguments:
 *    -# When output pointer to the resource descriptor is `nullptr`
 *      - Expected output: return `hipErrorInvalidValue`
 *    -# When the texture is not valid (0)
 *      - Expected output: return `hipErrorInvalidValue`
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipGetTexObjectResourceDesc_Negative_Parameters) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();

  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(false);

  HIP_RESOURCE_DESC check_desc;
  memset(&check_desc, 0, sizeof(check_desc));

  SECTION("desc is nullptr") {
    HIP_CHECK_ERROR(hipTexObjectGetResourceDesc(nullptr, tex_obj_wrapper->texture_object),
                    hipErrorInvalidValue);
  }

  SECTION("texture is invalid") {
    HIP_CHECK_ERROR(hipTexObjectGetResourceDesc(&check_desc, static_cast<hipTextureObject_t>(0)),
                    hipErrorInvalidValue);
  }

  delete tex_obj_wrapper;
  CTX_DESTROY();
}

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

/**
 * @addtogroup hipTexObjectGetResourceViewDesc hipTexObjectGetResourceViewDesc
 * @{
 * @ingroup TextureTest
 * `hipTexObjectGetResourceViewDesc(HIP_RESOURCE_VIEW_DESC* pResViewDesc,
 * hipTextureObject_t texObject)` -
 * Gets resource view descriptor of a texture object.
 */

/**
 * Test Description
 * ------------------------
 *  - Creates new texture object and an empty resource view descriptor.
 *  - Gets resource view descriptor from the texture.
 *  - Compares it to the empty created one.
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - Platform specific (AMD)
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipGetTexObjectResourceViewDesc_positive) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();
  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(true);

  HIP_RESOURCE_VIEW_DESC check_desc;
  memset(&check_desc, 0, sizeof(check_desc));

  HIP_CHECK(hipTexObjectGetResourceViewDesc(&check_desc, tex_obj_wrapper->texture_object));

  REQUIRE(check_desc.format == tex_obj_wrapper->res_view_desc.format);
  REQUIRE(check_desc.width == tex_obj_wrapper->res_view_desc.width);
  delete tex_obj_wrapper;
  CTX_DESTROY();
}

/**
 * Test Description
 * ------------------------
 *  - Validates handling of invalid arguments:
 *    -# When output pointer to the resource view descriptor is `nullptr`
 *      - Expected output: return `hipErrorInvalidValue`
 *    -# When the texture is not valid (0)
 *      - Expected output: return `hipErrorInvalidValue`
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - Platform specific (AMD)
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipGetTexObjectResourceViewDesc_Negative_Parameters) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();
  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(true);

  HIP_RESOURCE_VIEW_DESC check_desc;
  memset(&check_desc, 0, sizeof(check_desc));

  SECTION("desc is nullptr") {
    HIP_CHECK_ERROR(hipTexObjectGetResourceViewDesc(nullptr, tex_obj_wrapper->texture_object),
                    hipErrorInvalidValue);
  }

  SECTION("texture is invalid") {
    HIP_CHECK_ERROR(
        hipTexObjectGetResourceViewDesc(&check_desc, static_cast<hipTextureObject_t>(0)),
        hipErrorInvalidValue);
  }

  delete tex_obj_wrapper;
  CTX_DESTROY();
}

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

/**
 * @addtogroup hipTexObjectGetTextureDesc hipTexObjectGetTextureDesc
 * @{
 * @ingroup TextureTest
 * `hipTexObjectGetTextureDesc(HIP_TEXTURE_DESC* pTexDesc,
 * hipTextureObject_t texObject)` -
 * Gets texture descriptor of a texture object.
 */

/**
 * Test Description
 * ------------------------
 *  - Creates new texture object and an empty texture descriptor.
 *  - Gets texture descriptor from the texture.
 *  - Compares it to the empty created one.
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - Platform specific (AMD)
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipGetTexObjectTextureDesc_positive) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();

  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(false);

  HIP_TEXTURE_DESC check_desc;
  memset(&check_desc, 0, sizeof(check_desc));

  HIP_CHECK(hipTexObjectGetTextureDesc(&check_desc, tex_obj_wrapper->texture_object));

  REQUIRE(check_desc.filterMode == tex_obj_wrapper->tex_desc.filterMode);
  REQUIRE(check_desc.flags == tex_obj_wrapper->tex_desc.flags);
  delete tex_obj_wrapper;
  CTX_DESTROY();
}

/**
 * Test Description
 * ------------------------
 *  - Validates handling of invalid arguments:
 *    -# When output pointer to the texture descriptor is `nullptr`
 *      - Expected output: return `hipErrorInvalidValue`
 *    -# When the texture is not valid (0)
 *      - Expected output: return `hipErrorInvalidValue`
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - Platform specific (AMD)
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipGetTexObjectTextureDesc_Negative_Parameters) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();

  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(false);

  HIP_TEXTURE_DESC check_desc;
  memset(&check_desc, 0, sizeof(check_desc));

  SECTION("desc is nullptr") {
    HIP_CHECK_ERROR(hipTexObjectGetTextureDesc(nullptr, tex_obj_wrapper->texture_object),
                    hipErrorInvalidValue);
  }

  SECTION("texture is invalid") {
    HIP_CHECK_ERROR(hipTexObjectGetTextureDesc(&check_desc, static_cast<hipTextureObject_t>(0)),
                    hipErrorInvalidValue);
  }

  delete tex_obj_wrapper;
  CTX_DESTROY();
}

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

/**
 * @addtogroup hipTexObjectDestroy hipTexObjectDestroy
 * @{
 * @ingroup TextureTest
 * `hipTexObjectDestroy(hipTextureObject_t texObject)` -
 * Destroys a texture object.
 */

/**
 * Test Description
 * ------------------------
 *  - Successfully destroys regular texture object.
 * Test source
 * ------------------------
 *  - unit/texture/hipTexObjectTests.cc
 * Test requirements
 * ------------------------
 *  - Textures supported on device
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipTexObjectDestroy_positive) {
  CHECK_IMAGE_SUPPORT;
  CTX_CREATE();

  TexObjectTestWrapper* tex_obj_wrapper = new TexObjectTestWrapper(false, true);
  REQUIRE(hipTexObjectDestroy(tex_obj_wrapper->texture_object) == hipSuccess);
  delete tex_obj_wrapper;
  CTX_DESTROY();
}