Skip to content

Add opaque host memory allocation IPC test #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add opaque host memory allocation IPC test #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ad35bf4
feat: add tests for IPC opaque host memory handles
enm-intel Oct 2, 2025
aafb9b9
feat: add tests for IPC opaque host memory handles
enm-intel Oct 2, 2025
b949d66
feat: add tests for IPC opaque host memory handles
enm-intel Oct 2, 2025
e3f01f5
feat: add tests for IPC opaque host memory handles
enm-intel Oct 2, 2025
85477b4
feat: add tests for IPC opaque host memory handles
enm-intel Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 101 additions & 24 deletions conformance_tests/core/test_ipc/src/test_ipc_memory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ static void run_ipc_mem_access_test(ipc_mem_access_test_t test_type,
}
#endif // __linux__

static void run_ipc_mem_access_test_opaque(ipc_mem_access_test_t test_type,
size_t size, bool reserved,
ze_ipc_memory_flags_t flags,
bool is_immediate) {
static void run_ipc_dev_mem_access_test_opaque(ipc_mem_access_test_t test_type,
size_t size, bool reserved,
ze_ipc_memory_flags_t flags,
bool is_immediate) {
ze_result_t result = zeInit(0);
if (result != ZE_RESULT_SUCCESS) {
throw std::runtime_error("Parent zeInit failed: " +
Expand Down Expand Up @@ -196,6 +196,71 @@ static void run_ipc_mem_access_test_opaque(ipc_mem_access_test_t test_type,
lzt::destroy_context(context);
}

static void run_ipc_host_mem_access_test_opaque(size_t size,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need new function for host mem? lot of code is duplicated right? can we have another arg to original function such as run_ipc_mem_access_test_opaque(..., bool inDeviceMem) that dictates whether you call allocate_host_memory() or allocate_device_memory?

ze_ipc_memory_flags_t flags) {
ze_result_t result = zeInit(0);
if (result != ZE_RESULT_SUCCESS) {
throw std::runtime_error("Parent zeInit failed: " +
level_zero_tests::to_string(result));
}
LOG_DEBUG << "[Parent] Driver initialized\n";
lzt::print_platform_overview();

// Ensure shared memory object is removed in case it already exists
// -- can happen if previous test exited abnormally
bipc::shared_memory_object::remove("ipc_memory_test");

ze_ipc_mem_handle_t ipc_handle = {};

auto driver = lzt::get_default_driver();
auto context = lzt::create_context(driver);
auto device = lzt::zeDevice::get_instance()->get_device();

void *buffer = lzt::allocate_host_memory(size, 1, context);
memset(buffer, 0, size);
lzt::write_data_pattern(buffer, size, 1);

ASSERT_ZE_RESULT_SUCCESS(zeMemGetIpcHandle(context, buffer, &ipc_handle));

ze_ipc_mem_handle_t ipc_handle_zero{};
ASSERT_NE(0, memcmp((void *)&ipc_handle, (void *)&ipc_handle_zero,
sizeof(ipc_handle)));

// Launch child
#ifdef _WIN32
std::string helper_path = ".\\ipc\\test_ipc_memory_helper.exe";
#else
std::string helper_path = "./ipc/test_ipc_memory_helper";
#endif
boost::process::child c;
try {
c = boost::process::child(helper_path);
} catch (const boost::process::process_error &e) {
std::cerr << "Failed to launch child process: " << e.what() << std::endl;
throw;
}

bipc::shared_memory_object shm(bipc::create_only, "ipc_memory_test",
bipc::read_write);
shm.truncate(sizeof(shared_data_t));
bipc::mapped_region region(shm, bipc::read_write);

// Copy ipc handle data to shm
shared_data_t test_data = {
TEST_HOST_ACCESS, TEST_NONSOCK, to_u32(size), flags, false, ipc_handle};
std::memcpy(region.get_address(), &test_data, sizeof(shared_data_t));

// Free device memory once receiver is done
c.wait();
EXPECT_EQ(c.exit_code(), 0);

ASSERT_ZE_RESULT_SUCCESS(zeMemPutIpcHandle(context, ipc_handle));
bipc::shared_memory_object::remove("ipc_memory_test");

lzt::free_memory(context, buffer);
lzt::destroy_context(context);
}

#ifdef __linux__
LZT_TEST(
IpcMemoryAccessTest,
Expand Down Expand Up @@ -271,71 +336,83 @@ LZT_TEST(
LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0MemoryAllocatedInChildProcessWhenUsingL0IPCThenParentProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, false);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it might be good to state the memory placement in Test name above, i.e something like "GivenL0MemoryAllocatedInChildInDeviceMem*" so we can easily identify in GTA runs what kind passes/fails. thoughts @nrspruit ?

ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, false);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0MemoryAllocatedInChildProcessWhenUsingL0IPCOnImmediateCmdListThenParentProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, true);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, true);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0MemoryAllocatedInChildProcessBiasCachedWhenUsingL0IPCThenParentProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, false);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, false);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0MemoryAllocatedInChildProcessBiasCachedWhenUsingL0IPCOnImmediateCmdListThenParentProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, true);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, false,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, true);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0PhysicalMemoryAllocatedAndReservedInParentProcessWhenUsingL0IPCThenChildProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, false);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, false);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0PhysicalMemoryAllocatedAndReservedInParentProcessWhenUsingL0IPCOnImmediateCmdListThenChildProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, true);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, true);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0PhysicalMemoryAllocatedAndReservedInParentProcessBiasCachedWhenUsingL0IPCThenChildProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, false);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, false);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenL0PhysicalMemoryAllocatedAndReservedInParentProcessBiasCachedWhenUsingL0IPCOnImmediateCmdListThenChildProcessReadsMemoryCorrectly) {
run_ipc_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, true);
run_ipc_dev_mem_access_test_opaque(TEST_DEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_CACHED, true);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandleSubDevice,
GivenL0PhysicalMemoryAllocatedReservedInParentProcessWhenUsingL0IPCThenChildProcessReadsMemoryCorrectlyUsingSubDeviceQueue) {
run_ipc_mem_access_test_opaque(TEST_SUBDEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, false);
run_ipc_dev_mem_access_test_opaque(TEST_SUBDEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, false);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandleSubDevice,
GivenL0PhysicalMemoryAllocatedReservedInParentProcessWhenUsingL0IPCOnImmediateCmdListThenChildProcessReadsMemoryCorrectlyUsingSubDeviceQueue) {
run_ipc_mem_access_test_opaque(TEST_SUBDEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, true);
run_ipc_dev_mem_access_test_opaque(TEST_SUBDEVICE_ACCESS, 4096, true,
ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED, true);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenUncachedHostMemoryAllocatedInParentProcessThenChildProcessReadsMemoryCorrectly) {
run_ipc_host_mem_access_test_opaque(4096, ZE_IPC_MEMORY_FLAG_BIAS_UNCACHED);
}

LZT_TEST(
IpcMemoryAccessTestOpaqueIpcHandle,
GivenCachedHostMemoryAllocatedInParentProcessThenChildProcessReadsMemoryCorrectly) {
run_ipc_host_mem_access_test_opaque(4096, ZE_IPC_MEMORY_FLAG_BIAS_CACHED);
}

} // namespace
Expand Down
3 changes: 2 additions & 1 deletion conformance_tests/core/test_ipc/src/test_ipc_memory.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@

typedef enum {
TEST_DEVICE_ACCESS,
TEST_SUBDEVICE_ACCESS
TEST_SUBDEVICE_ACCESS,
TEST_HOST_ACCESS
} ipc_mem_access_test_t;

typedef enum { TEST_SOCK, TEST_NONSOCK } ipc_mem_access_test_sock_t;
Expand Down
30 changes: 29 additions & 1 deletion conformance_tests/core/test_ipc/src/test_ipc_memory_helper.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,30 @@ static void child_subdevice_access_test_opaque(size_t size,
}
}

static void child_host_access_test_opaque(size_t size,
ze_ipc_memory_flags_t flags,
ze_ipc_mem_handle_t ipc_handle) {
auto driver = lzt::get_default_driver();
auto context = lzt::create_context(driver);
auto device = lzt::zeDevice::get_instance()->get_device();
void *buffer = nullptr;

EXPECT_ZE_RESULT_SUCCESS(
zeMemOpenIpcHandle(context, device, ipc_handle, flags, &buffer));

LOG_DEBUG << "[Child] Validating buffer received correctly";
lzt::validate_data_pattern(buffer, size, 1);

EXPECT_ZE_RESULT_SUCCESS(zeMemCloseIpcHandle(context, buffer));
lzt::destroy_context(context);

if (::testing::Test::HasFailure()) {
exit(1);
} else {
exit(0);
}
}

int main() {
ze_result_t result = zeInit(0);
if (result != ZE_RESULT_SUCCESS) {
Expand Down Expand Up @@ -233,8 +257,8 @@ int main() {
child_device_access_test_opaque(shared_data.size, shared_data.flags,
shared_data.is_immediate,
shared_data.ipc_handle);
} else {
#ifdef __linux__
} else {
child_device_access_test(shared_data.size, shared_data.flags,
shared_data.is_immediate);
#endif
Expand All @@ -249,6 +273,10 @@ int main() {
break; // Currently supporting only device access test scenario
}
break;
case TEST_HOST_ACCESS:
child_host_access_test_opaque(shared_data.size, shared_data.flags,
shared_data.ipc_handle);
break;
default:
LOG_DEBUG << "Unrecognized test case";
exit(1);
Expand Down
2 changes: 2 additions & 0 deletions scripts/level_zero_report_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ def assign_test_feature_tag(test_feature: str, test_name: str, test_section: str
(re.search('L0_CTS_IpcMemoryAccessTestOpaqueIpcHandle_GivenL0PhysicalMemoryAllocatedAndReservedInParentProcessBiasCachedWhenUsingL0IPCOnImmediateCmdListThenChildProcessReadsMemoryCorrectly', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_IpcMemoryAccessTestOpaqueIpcHandleSubDevice_GivenL0PhysicalMemoryAllocatedReservedInParentProcessWhenUsingL0IPCThenChildProcessReadsMemoryCorrectlyUsingSubDeviceQueue', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_IpcMemoryAccessTestOpaqueIpcHandleSubDevice_GivenL0PhysicalMemoryAllocatedReservedInParentProcessWhenUsingL0IPCOnImmediateCmdListThenChildProcessReadsMemoryCorrectlyUsingSubDeviceQueue', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_IpcMemoryAccessTestOpaqueIpcHandle_GivenUncachedHostMemoryAllocatedInParentProcessThenChildProcessReadsMemoryCorrectly', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_IpcMemoryAccessTestOpaqueIpcHandle_GivenCachedHostMemoryAllocatedInParentProcessThenChildProcessReadsMemoryCorrectly', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_zeDeviceGetMemoryPropertiesTests_GivenValidDeviceWhenRetrievingMemoryPropertiesThenValidExtPropertiesAreReturned', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_zeKernelCreateTests_GivenValidFunctionWhenGettingSourceAttributeThenReturnAttributeString', test_name, re.IGNORECASE)) or \
(re.search('L0_CTS_zeKernelGetNameTests_GivenKernelGetNameCorrectNameIsReturned', test_name, re.IGNORECASE)) or \
Expand Down
Loading