Add negative test for AHB (#2539)

Add a wrapper around AHB for proper resource deallocation and refactor
existing tests to use the wrapper.
Add a negative test for AHB to test for error codes when calling
clCreateImageWithProperties and clCreateBufferWithProperties.

---------

Signed-off-by: Alex Davicenko <alex.davicenko@arm.com>
Signed-off-by: Ahmed Hesham <ahmed.hesham@arm.com>
Co-authored-by: Alex Davicenko <alex.davicenko@arm.com>
This commit is contained in:
Ahmed Hesham
2025-10-28 17:30:30 +00:00
committed by GitHub
parent c6e0f416e7
commit ba991c0152
4 changed files with 592 additions and 379 deletions

View File

@@ -15,6 +15,7 @@
//
#include "debug_ahb.h"
#include "harness/errorHelpers.h"
constexpr AHardwareBuffer_UsageFlags flag_list[] = {
AHARDWAREBUFFER_USAGE_CPU_READ_RARELY,
@@ -191,3 +192,27 @@ std::string ahardwareBufferFormatToString(AHardwareBuffer_Format format)
}
return result;
}
AHardwareBuffer *create_AHB(AHardwareBuffer_Desc *desc)
{
AHardwareBuffer *buffer_ptr = nullptr;
int err = AHardwareBuffer_allocate(desc, &buffer_ptr);
if (err != 0)
{
throw std::runtime_error("AHardwareBuffer_allocate failed with code: "
+ std::to_string(err) + "\n");
}
return buffer_ptr;
}
void log_unsupported_ahb_format(AHardwareBuffer_Desc aHardwareBufferDesc)
{
std::string usage_string = ahardwareBufferDecodeUsageFlagsToString(
static_cast<AHardwareBuffer_UsageFlags>(aHardwareBufferDesc.usage));
log_info("Unsupported format %s:\n Usage flags %s\n Size (%u, %u, "
"layers = %u)\n",
ahardwareBufferFormatToString(static_cast<AHardwareBuffer_Format>(
aHardwareBufferDesc.format))
.c_str(),
usage_string.c_str(), aHardwareBufferDesc.width,
aHardwareBufferDesc.height, aHardwareBufferDesc.layers);
}

View File

@@ -19,6 +19,7 @@
#include <string>
#include <vector>
#include <numeric>
#include <CL/cl.h>
#define CHECK_AHARDWARE_BUFFER_SUPPORT(ahardwareBuffer_Desc, format) \
if (!AHardwareBuffer_isSupported(&ahardwareBuffer_Desc)) \
@@ -39,4 +40,91 @@
std::string ahardwareBufferFormatToString(AHardwareBuffer_Format format);
std::string ahardwareBufferUsageFlagToString(AHardwareBuffer_UsageFlags flag);
std::string
ahardwareBufferDecodeUsageFlagsToString(AHardwareBuffer_UsageFlags flags);
ahardwareBufferDecodeUsageFlagsToString(AHardwareBuffer_UsageFlags flags);
AHardwareBuffer* create_AHB(AHardwareBuffer_Desc* desc);
void log_unsupported_ahb_format(AHardwareBuffer_Desc desc);
struct AHardwareBufferWrapper
{
AHardwareBuffer* m_ahb;
AHardwareBufferWrapper(): m_ahb(nullptr) {}
AHardwareBufferWrapper(AHardwareBuffer* ahb) { m_ahb = ahb; }
AHardwareBufferWrapper(AHardwareBuffer_Desc* desc)
{
m_ahb = create_AHB(desc);
}
AHardwareBufferWrapper& operator=(AHardwareBuffer* rhs)
{
release();
m_ahb = rhs;
return *this;
}
~AHardwareBufferWrapper() { release(); }
// Copy constructor
AHardwareBufferWrapper(AHardwareBufferWrapper const& ahbw)
: m_ahb(ahbw.m_ahb)
{
retain();
}
// Copy assignment operator
AHardwareBufferWrapper& operator=(AHardwareBufferWrapper const& rhs)
{
release();
m_ahb = rhs.m_ahb;
retain();
return *this;
}
// Move constructor
AHardwareBufferWrapper(AHardwareBufferWrapper&& ahbw)
{
m_ahb = ahbw.m_ahb;
ahbw.m_ahb = nullptr;
}
// Move assignment operator
AHardwareBufferWrapper& operator=(AHardwareBufferWrapper&& rhs)
{
if (this != &rhs)
{
release(); // Giving up current reference
m_ahb = rhs.m_ahb;
rhs.m_ahb = nullptr;
}
return *this;
}
void retain()
{
if (nullptr != m_ahb)
{
AHardwareBuffer_acquire(m_ahb);
}
}
void release()
{
if (nullptr != m_ahb)
{
AHardwareBuffer_release(m_ahb);
}
}
// Usage operators
operator AHardwareBuffer*() { return m_ahb; }
cl_mem_properties get_props()
{
return reinterpret_cast<cl_mem_properties>(m_ahb);
}
};

View File

@@ -97,7 +97,7 @@ static const char *diff_images_kernel_source = {
};
// Checks that the inferred image format is correct
REGISTER_TEST(test_images)
REGISTER_TEST(images)
{
cl_int err = CL_SUCCESS;
@@ -134,19 +134,15 @@ REGISTER_TEST(test_images)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
const cl_mem_properties props[] = {
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
cl_mem image = clCreateImageWithProperties(
@@ -181,8 +177,6 @@ REGISTER_TEST(test_images)
test_error(clReleaseMemObject(image),
"Failed to release image");
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
}
}
}
@@ -190,7 +184,7 @@ REGISTER_TEST(test_images)
return TEST_PASS;
}
REGISTER_TEST(test_images_read)
REGISTER_TEST(images_read)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -238,15 +232,11 @@ REGISTER_TEST(test_images_read)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -279,7 +269,7 @@ REGISTER_TEST(test_images_read)
generate_random_image_data(&imageInfo, srcData, seed);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -301,7 +291,7 @@ REGISTER_TEST(test_images_read)
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -482,9 +472,6 @@ REGISTER_TEST(test_images_read)
}
}
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
}
}
}
@@ -492,7 +479,7 @@ REGISTER_TEST(test_images_read)
return TEST_PASS;
}
REGISTER_TEST(test_enqueue_read_image)
REGISTER_TEST(enqueue_read_image)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -540,15 +527,12 @@ REGISTER_TEST(test_enqueue_read_image)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -581,7 +565,7 @@ REGISTER_TEST(test_enqueue_read_image)
generate_random_image_data(&imageInfo, srcData, seed);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -601,9 +585,9 @@ REGISTER_TEST(test_enqueue_read_image)
return TEST_FAIL;
}
const cl_mem_properties props[] = {
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -662,9 +646,6 @@ REGISTER_TEST(test_enqueue_read_image)
out_image_ptr += imageInfo.rowPitch;
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
if (total_matched == 0)
{
test_fail("Zero bytes matched");
@@ -676,7 +657,7 @@ REGISTER_TEST(test_enqueue_read_image)
return TEST_PASS;
}
REGISTER_TEST(test_enqueue_copy_image)
REGISTER_TEST(enqueue_copy_image)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -724,15 +705,12 @@ REGISTER_TEST(test_enqueue_copy_image)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -765,7 +743,7 @@ REGISTER_TEST(test_enqueue_copy_image)
generate_random_image_data(&imageInfo, srcData, seed);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -787,7 +765,7 @@ REGISTER_TEST(test_enqueue_copy_image)
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -975,9 +953,6 @@ REGISTER_TEST(test_enqueue_copy_image)
}
}
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
}
}
}
@@ -985,7 +960,7 @@ REGISTER_TEST(test_enqueue_copy_image)
return TEST_PASS;
}
REGISTER_TEST(test_enqueue_copy_image_to_buffer)
REGISTER_TEST(enqueue_copy_image_to_buffer)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -1033,15 +1008,12 @@ REGISTER_TEST(test_enqueue_copy_image_to_buffer)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -1074,7 +1046,7 @@ REGISTER_TEST(test_enqueue_copy_image_to_buffer)
generate_random_image_data(&imageInfo, srcData, seed);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -1096,7 +1068,7 @@ REGISTER_TEST(test_enqueue_copy_image_to_buffer)
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -1165,9 +1137,6 @@ REGISTER_TEST(test_enqueue_copy_image_to_buffer)
out_buffer_ptr += scanlineSize;
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
if (total_matched == 0)
{
test_fail("Zero bytes matched");
@@ -1179,7 +1148,7 @@ REGISTER_TEST(test_enqueue_copy_image_to_buffer)
return TEST_PASS;
}
REGISTER_TEST(test_enqueue_copy_buffer_to_image)
REGISTER_TEST(enqueue_copy_buffer_to_image)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -1227,15 +1196,12 @@ REGISTER_TEST(test_enqueue_copy_buffer_to_image)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -1275,7 +1241,7 @@ REGISTER_TEST(test_enqueue_copy_buffer_to_image)
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -1307,7 +1273,7 @@ REGISTER_TEST(test_enqueue_copy_buffer_to_image)
&hardware_buffer_desc);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -1366,9 +1332,6 @@ REGISTER_TEST(test_enqueue_copy_buffer_to_image)
return TEST_FAIL;
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
if (total_matched == 0)
{
test_fail("Zero bytes matched");
@@ -1380,7 +1343,7 @@ REGISTER_TEST(test_enqueue_copy_buffer_to_image)
return TEST_PASS;
}
REGISTER_TEST(test_enqueue_write_image)
REGISTER_TEST(enqueue_write_image)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -1428,15 +1391,12 @@ REGISTER_TEST(test_enqueue_write_image)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -1453,7 +1413,7 @@ REGISTER_TEST(test_enqueue_write_image)
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -1503,7 +1463,7 @@ REGISTER_TEST(test_enqueue_write_image)
&hardware_buffer_desc);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -1564,9 +1524,6 @@ REGISTER_TEST(test_enqueue_write_image)
return TEST_FAIL;
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
if (total_matched == 0)
{
test_fail("Zero bytes matched");
@@ -1578,7 +1535,7 @@ REGISTER_TEST(test_enqueue_write_image)
return TEST_PASS;
}
REGISTER_TEST(test_enqueue_fill_image)
REGISTER_TEST(enqueue_fill_image)
{
cl_int err = CL_SUCCESS;
RandomSeed seed(gRandomSeed);
@@ -1626,15 +1583,12 @@ REGISTER_TEST(test_enqueue_fill_image)
CHECK_AHARDWARE_BUFFER_SUPPORT(aHardwareBufferDesc, format);
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result = AHardwareBuffer_allocate(&aHardwareBufferDesc,
&aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(format.aHardwareBufferFormat)
.c_str());
// Determine AHB memory layout
AHardwareBuffer_Desc hardware_buffer_desc = {};
@@ -1650,7 +1604,7 @@ REGISTER_TEST(test_enqueue_fill_image)
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
clMemWrapper imported_image = clCreateImageWithProperties(
@@ -1739,7 +1693,7 @@ REGISTER_TEST(test_enqueue_fill_image)
&hardware_buffer_desc);
void *hardware_buffer_data = nullptr;
ahb_result = AHardwareBuffer_lock(
int ahb_result = AHardwareBuffer_lock(
aHardwareBuffer, AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN, -1,
nullptr, &hardware_buffer_data);
if (ahb_result != 0)
@@ -1819,8 +1773,6 @@ REGISTER_TEST(test_enqueue_fill_image)
return TEST_FAIL;
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
free(verificationLine);
if (total_matched == 0)
@@ -1834,7 +1786,7 @@ REGISTER_TEST(test_enqueue_fill_image)
return TEST_PASS;
}
REGISTER_TEST(test_blob)
REGISTER_TEST(blob)
{
cl_int err = CL_SUCCESS;
@@ -1883,19 +1835,17 @@ REGISTER_TEST(test_blob)
continue;
}
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n",
ahb_result);
return TEST_FAIL;
}
AHardwareBufferWrapper aHardwareBuffer(&aHardwareBufferDesc);
log_info(
"Testing %s\n",
ahardwareBufferFormatToString(
static_cast<AHardwareBuffer_Format>(aHardwareBufferDesc.format))
.c_str());
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
aHardwareBuffer.get_props(), 0
};
cl_mem buffer = clCreateBufferWithProperties(
@@ -1903,8 +1853,6 @@ REGISTER_TEST(test_blob)
test_error(err, "Failed to create CL buffer from AHardwareBuffer");
test_error(clReleaseMemObject(buffer), "Failed to release buffer");
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
}
return TEST_PASS;

View File

@@ -1,246 +1,398 @@
//
// Copyright (c) 2025 The Khronos Group Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include "harness/compat.h"
#include "harness/kernelHelpers.h"
#include "harness/imageHelpers.h"
#include "harness/errorHelpers.h"
#include <android/hardware_buffer.h>
#include "debug_ahb.h"
REGISTER_TEST(test_buffer_format_negative)
{
cl_int err = CL_SUCCESS;
if (!is_extension_available(device, "cl_khr_external_memory"))
{
log_info("cl_khr_external_memory is not supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
aHardwareBufferDesc.width = 64;
aHardwareBufferDesc.height = 1;
aHardwareBufferDesc.layers = 1;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
if (!AHardwareBuffer_isSupported(&aHardwareBufferDesc))
{
const std::string usage_string =
ahardwareBufferDecodeUsageFlagsToString(
static_cast<AHardwareBuffer_UsageFlags>(
aHardwareBufferDesc.usage));
log_info(
"Unsupported format %s, usage flags %s\n",
ahardwareBufferFormatToString(
static_cast<AHardwareBuffer_Format>(aHardwareBufferDesc.format))
.c_str(),
usage_string.c_str());
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer *aHardwareBuffer = nullptr;
const int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n", ahb_result);
return TEST_FAIL;
}
log_info("Testing %s\n",
ahardwareBufferFormatToString(static_cast<AHardwareBuffer_Format>(
aHardwareBufferDesc.format))
.c_str());
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
};
cl_mem buffer = clCreateBufferWithProperties(
context, props, CL_MEM_READ_WRITE, 0, nullptr, &err);
test_assert_error(err == CL_INVALID_OPERATION,
"To create a buffer the aHardwareFormat must be "
"AHARDWAREBUFFER_FORMAT_BLOB");
if (buffer != nullptr)
{
test_error(clReleaseMemObject(buffer), "Failed to release buffer");
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
return TEST_PASS;
}
REGISTER_TEST(test_buffer_size_negative)
{
cl_int err = CL_SUCCESS;
constexpr size_t buffer_size = 64;
if (!is_extension_available(device, "cl_khr_external_memory"))
{
log_info("cl_khr_external_memory is not supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_BLOB;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
aHardwareBufferDesc.width = buffer_size;
aHardwareBufferDesc.height = 1;
aHardwareBufferDesc.layers = 1;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
if (!AHardwareBuffer_isSupported(&aHardwareBufferDesc))
{
const std::string usage_string =
ahardwareBufferDecodeUsageFlagsToString(
static_cast<AHardwareBuffer_UsageFlags>(
aHardwareBufferDesc.usage));
log_info(
"Unsupported format %s, usage flags %s\n",
ahardwareBufferFormatToString(
static_cast<AHardwareBuffer_Format>(aHardwareBufferDesc.format))
.c_str(),
usage_string.c_str());
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer *aHardwareBuffer = nullptr;
const int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n", ahb_result);
return TEST_FAIL;
}
log_info("Testing %s\n",
ahardwareBufferFormatToString(static_cast<AHardwareBuffer_Format>(
aHardwareBufferDesc.format))
.c_str());
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
};
cl_mem buffer = clCreateBufferWithProperties(
context, props, CL_MEM_READ_WRITE, buffer_size / 2, nullptr, &err);
test_assert_error(err == CL_INVALID_BUFFER_SIZE,
"Wrong error value returned");
if (buffer != nullptr)
{
test_error(clReleaseMemObject(buffer), "Failed to release buffer");
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
return TEST_PASS;
}
REGISTER_TEST(test_images_negative)
{
cl_int err = CL_SUCCESS;
if (!is_extension_available(device, "cl_khr_external_memory"))
{
log_info("cl_khr_external_memory is not supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM;
aHardwareBufferDesc.usage = static_cast<AHardwareBuffer_UsageFlags>(
AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN
| AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN
| AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
| AHARDWAREBUFFER_USAGE_GPU_FRAMEBUFFER);
aHardwareBufferDesc.width = 64;
aHardwareBufferDesc.height = 64;
aHardwareBufferDesc.layers = 1;
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n", ahb_result);
return TEST_FAIL;
}
const cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
};
constexpr cl_image_format image_format = { CL_RGBA, CL_UNORM_INT8 };
cl_mem image =
clCreateImageWithProperties(context, props, CL_MEM_READ_WRITE,
&image_format, nullptr, nullptr, &err);
test_assert_error(err == CL_INVALID_IMAGE_FORMAT_DESCRIPTOR,
"Wrong error value returned");
if (image != nullptr)
{
test_error(clReleaseMemObject(image), "Failed to release image");
}
constexpr cl_image_desc image_desc = { CL_MEM_OBJECT_IMAGE2D, 64, 64 };
image = clCreateImageWithProperties(context, props, CL_MEM_READ_WRITE,
nullptr, &image_desc, nullptr, &err);
test_assert_error(err == CL_INVALID_IMAGE_DESCRIPTOR,
"Wrong error value returned");
if (image != nullptr)
{
test_error(clReleaseMemObject(image), "Failed to release image");
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
return TEST_PASS;
}
//
// Copyright (c) 2025 The Khronos Group Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include "harness/compat.h"
#include "harness/kernelHelpers.h"
#include "harness/imageHelpers.h"
#include "harness/errorHelpers.h"
#include <android/hardware_buffer.h>
#include "debug_ahb.h"
REGISTER_TEST(buffer_format_negative)
{
cl_int err = CL_SUCCESS;
if (!is_extension_available(device, "cl_khr_external_memory"))
{
log_info("cl_khr_external_memory is not supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
aHardwareBufferDesc.width = 64;
aHardwareBufferDesc.height = 1;
aHardwareBufferDesc.layers = 1;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
if (!AHardwareBuffer_isSupported(&aHardwareBufferDesc))
{
const std::string usage_string =
ahardwareBufferDecodeUsageFlagsToString(
static_cast<AHardwareBuffer_UsageFlags>(
aHardwareBufferDesc.usage));
log_info(
"Unsupported format %s, usage flags %s\n",
ahardwareBufferFormatToString(
static_cast<AHardwareBuffer_Format>(aHardwareBufferDesc.format))
.c_str(),
usage_string.c_str());
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer *aHardwareBuffer = nullptr;
const int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n", ahb_result);
return TEST_FAIL;
}
log_info("Testing %s\n",
ahardwareBufferFormatToString(static_cast<AHardwareBuffer_Format>(
aHardwareBufferDesc.format))
.c_str());
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
};
cl_mem buffer = clCreateBufferWithProperties(
context, props, CL_MEM_READ_WRITE, 0, nullptr, &err);
test_assert_error(err == CL_INVALID_OPERATION,
"To create a buffer the aHardwareFormat must be "
"AHARDWAREBUFFER_FORMAT_BLOB");
if (buffer != nullptr)
{
test_error(clReleaseMemObject(buffer), "Failed to release buffer");
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
return TEST_PASS;
}
REGISTER_TEST(buffer_size_negative)
{
cl_int err = CL_SUCCESS;
constexpr size_t buffer_size = 64;
if (!is_extension_available(device, "cl_khr_external_memory"))
{
log_info("cl_khr_external_memory is not supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_BLOB;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
aHardwareBufferDesc.width = buffer_size;
aHardwareBufferDesc.height = 1;
aHardwareBufferDesc.layers = 1;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER;
if (!AHardwareBuffer_isSupported(&aHardwareBufferDesc))
{
const std::string usage_string =
ahardwareBufferDecodeUsageFlagsToString(
static_cast<AHardwareBuffer_UsageFlags>(
aHardwareBufferDesc.usage));
log_info(
"Unsupported format %s, usage flags %s\n",
ahardwareBufferFormatToString(
static_cast<AHardwareBuffer_Format>(aHardwareBufferDesc.format))
.c_str(),
usage_string.c_str());
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer *aHardwareBuffer = nullptr;
const int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n", ahb_result);
return TEST_FAIL;
}
log_info("Testing %s\n",
ahardwareBufferFormatToString(static_cast<AHardwareBuffer_Format>(
aHardwareBufferDesc.format))
.c_str());
cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
};
cl_mem buffer = clCreateBufferWithProperties(
context, props, CL_MEM_READ_WRITE, buffer_size / 2, nullptr, &err);
test_assert_error(err == CL_INVALID_BUFFER_SIZE,
"Wrong error value returned");
if (buffer != nullptr)
{
test_error(clReleaseMemObject(buffer), "Failed to release buffer");
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
return TEST_PASS;
}
REGISTER_TEST(images_negative)
{
cl_int err = CL_SUCCESS;
if (!is_extension_available(device, "cl_khr_external_memory"))
{
log_info("cl_khr_external_memory is not supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. "
"Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM;
aHardwareBufferDesc.usage = static_cast<AHardwareBuffer_UsageFlags>(
AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN
| AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN
| AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
| AHARDWAREBUFFER_USAGE_GPU_FRAMEBUFFER);
aHardwareBufferDesc.width = 64;
aHardwareBufferDesc.height = 64;
aHardwareBufferDesc.layers = 1;
AHardwareBuffer *aHardwareBuffer = nullptr;
int ahb_result =
AHardwareBuffer_allocate(&aHardwareBufferDesc, &aHardwareBuffer);
if (ahb_result != 0)
{
log_error("AHardwareBuffer_allocate failed with code %d\n", ahb_result);
return TEST_FAIL;
}
const cl_mem_properties props[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
reinterpret_cast<cl_mem_properties>(aHardwareBuffer), 0
};
constexpr cl_image_format image_format = { CL_RGBA, CL_UNORM_INT8 };
cl_mem image =
clCreateImageWithProperties(context, props, CL_MEM_READ_WRITE,
&image_format, nullptr, nullptr, &err);
test_assert_error(err == CL_INVALID_IMAGE_FORMAT_DESCRIPTOR,
"Wrong error value returned");
if (image != nullptr)
{
test_error(clReleaseMemObject(image), "Failed to release image");
}
constexpr cl_image_desc image_desc = { CL_MEM_OBJECT_IMAGE2D, 64, 64 };
image = clCreateImageWithProperties(context, props, CL_MEM_READ_WRITE,
nullptr, &image_desc, nullptr, &err);
test_assert_error(err == CL_INVALID_IMAGE_DESCRIPTOR,
"Wrong error value returned");
if (image != nullptr)
{
test_error(clReleaseMemObject(image), "Failed to release image");
}
AHardwareBuffer_release(aHardwareBuffer);
aHardwareBuffer = nullptr;
return TEST_PASS;
}
REGISTER_TEST(invalid_arguments)
{
cl_int err;
constexpr cl_uint buffer_size = 4096;
if (!is_extension_available(
device, "cl_khr_external_memory_android_hardware_buffer"))
{
log_info("cl_khr_external_memory_android_hardware_buffer is not "
"supported on this platform. Skipping test.\n");
return TEST_SKIPPED_ITSELF;
}
AHardwareBuffer_Desc aHardwareBufferDesc = { 0 };
aHardwareBufferDesc.width = buffer_size;
aHardwareBufferDesc.height = 1;
aHardwareBufferDesc.layers = 1;
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_BLOB;
aHardwareBufferDesc.usage = AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN
| AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN;
if (!AHardwareBuffer_isSupported(&aHardwareBufferDesc))
{
log_unsupported_ahb_format(aHardwareBufferDesc);
return TEST_SKIPPED_ITSELF;
}
AHardwareBufferWrapper ahb_buffer(&aHardwareBufferDesc);
aHardwareBufferDesc.width = 64;
aHardwareBufferDesc.height = 64;
aHardwareBufferDesc.format = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM;
if (!AHardwareBuffer_isSupported(&aHardwareBufferDesc))
{
log_unsupported_ahb_format(aHardwareBufferDesc);
return TEST_SKIPPED_ITSELF;
}
AHardwareBufferWrapper ahb_image(&aHardwareBufferDesc);
const cl_mem_properties props_buffer[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
ahb_buffer.get_props(),
0,
};
const cl_mem_properties props_image[] = {
CL_EXTERNAL_MEMORY_HANDLE_ANDROID_HARDWARE_BUFFER_KHR,
ahb_image.get_props(),
0,
};
// stub values
cl_image_format image_format = { 0 };
cl_image_desc image_desc = { 0 };
int host_data = 0;
void *host_ptr = reinterpret_cast<void *>(&host_data);
log_info("Testing buffer error conditions\n");
// Buffer error conditions
clMemWrapper mem =
clCreateBufferWithProperties(context, props_buffer, CL_MEM_READ_WRITE,
buffer_size + 1, nullptr, &err);
if (CL_INVALID_BUFFER_SIZE != err)
{
log_error(
"clCreateBufferWithProperties should return CL_INVALID_BUFFER_SIZE "
"but returned %s: CL_INVALID_BUFFER_SIZE if size is non-zero and "
"greater than the AHardwareBuffer when importing external memory "
"using cl_khr_external_memory_android_hardware_buffer\n",
IGetErrorString(err));
return TEST_FAIL;
}
mem = clCreateBufferWithProperties(context, props_image, CL_MEM_READ_WRITE,
0, nullptr, &err);
if (CL_INVALID_OPERATION != err)
{
log_error(
"clCreateBufferWithProperties should return CL_INVALID_OPERATION "
"but returned %s: CL_INVALID_OPERATION if the AHardwareBuffer "
"format is not AHARDWAREBUFFER_FORMAT_BLOB\n",
IGetErrorString(err));
return TEST_FAIL;
}
mem = clCreateBufferWithProperties(context, props_buffer, CL_MEM_READ_WRITE,
0, host_ptr, &err);
if (CL_INVALID_HOST_PTR != err)
{
log_error(
"clCreateBufferWithProperties should return CL_INVALID_HOST_PTR "
"but returned %s: CL_INVALID_HOST_PTR if host_ptr is not NULL\n",
IGetErrorString(err));
return TEST_FAIL;
}
log_info("Testing image error conditions\n");
// Image error conditions
mem = clCreateImageWithProperties(context, props_image, CL_MEM_READ_WRITE,
&image_format, nullptr, nullptr, &err);
if (CL_INVALID_IMAGE_FORMAT_DESCRIPTOR != err)
{
log_error(
"clCreateBufferWithProperties should return "
"CL_INVALID_IMAGE_FORMAT_DESCRIPTOR but returned %s: "
"CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if image_format is not NULL "
"when using cl_khr_external_memory_android_hardware_buffer.\n",
IGetErrorString(err));
return TEST_FAIL;
}
mem = clCreateImageWithProperties(context, props_image, CL_MEM_READ_WRITE,
nullptr, &image_desc, nullptr, &err);
if (CL_INVALID_IMAGE_DESCRIPTOR != err)
{
log_error("clCreateBufferWithProperties should return "
"CL_INVALID_IMAGE_DESCRIPTOR but returned %s: "
"CL_INVALID_IMAGE_DESCRIPTOR if image_desc is not NULL when "
"using cl_khr_external_memory_android_hardware_buffer.\n",
IGetErrorString(err));
return TEST_FAIL;
}
mem = clCreateImageWithProperties(context, props_buffer, CL_MEM_READ_WRITE,
nullptr, nullptr, nullptr, &err);
if (CL_IMAGE_FORMAT_NOT_SUPPORTED != err)
{
log_error("clCreateBufferWithProperties should return "
"CL_IMAGE_FORMAT_NOT_SUPPORTED but returned %s: "
"CL_IMAGE_FORMAT_NOT_SUPPORTED if AHardwareBuffer's format "
"is not supported\n",
IGetErrorString(err));
return TEST_FAIL;
}
mem = clCreateImageWithProperties(context, props_image, CL_MEM_READ_WRITE,
nullptr, nullptr, host_ptr, &err);
if (CL_INVALID_HOST_PTR != err)
{
log_error(
"clCreateBufferWithProperties should return CL_INVALID_HOST_PTR "
"but returned %s: CL_INVALID_HOST_PTR if host_ptr is not NULL\n",
IGetErrorString(err));
return TEST_FAIL;
}
return TEST_PASS;
}