Zebin: enhance clBuildProgramTests ULTs

- Do not use precompiled binaries in clBuildProgramTests.
This change is required in order to enable zebin switch by default.

Related-To: NEO-7281
Signed-off-by: Kacper Nowak <[email protected]>

Author: km-nowak

opencl/test/unit_test/api/cl_build_program_tests.inl

@@ -9,6 +9,7 @@
 #include "shared/test/common/helpers/kernel_binary_helper.h"
 #include "shared/test/common/helpers/test_files.h"
 #include "shared/test/common/mocks/mock_compilers.h"
+#include "shared/test/common/mocks/mock_modules_zebin.h"
 
 #include "opencl/source/context/context.h"
 #include "opencl/source/program/program.h"
@@ -75,19 +76,17 @@ TEST_F(clBuildProgramTests, GivenSourceAsInputWhenCreatingProgramWithSourceThenP
 TEST_F(clBuildProgramTests, GivenBinaryAsInputWhenCreatingProgramWithSourceThenProgramBuildSucceeds) {
     cl_program pProgram = nullptr;
     cl_int binaryStatus = CL_SUCCESS;
-    std::unique_ptr<char[]> pBinary = nullptr;
-    size_t binarySize = 0;
-    std::string testFile;
-    retrieveBinaryKernelFilename(testFile, "CopyBuffer_simd16_", ".bin");
 
-    pBinary = loadDataFromFile(
-        testFile.c_str(),
-        binarySize);
+    constexpr auto numBits = is32bit ? Elf::EI_CLASS_32 : Elf::EI_CLASS_64;
+    auto zebinData = std::make_unique<ZebinTestData::ZebinCopyBufferSimdModule<numBits>>(pDevice->getHardwareInfo(), 16);
+    const auto &src = zebinData->storage;
 
-    ASSERT_NE(0u, binarySize);
-    ASSERT_NE(nullptr, pBinary);
+    ASSERT_NE(nullptr, src.data());
+    ASSERT_NE(0u, src.size());
+
+    const unsigned char *binaries[1] = {reinterpret_cast<const unsigned char *>(src.data())};
+    const size_t binarySize = src.size();
 
-    const unsigned char *binaries[1] = {reinterpret_cast<const unsigned char *>(pBinary.get())};
     pProgram = clCreateProgramWithBinary(
         pContext,
         1,
@@ -97,8 +96,6 @@ TEST_F(clBuildProgramTests, GivenBinaryAsInputWhenCreatingProgramWithSourceThenP
         &binaryStatus,
         &retVal);
 
-    pBinary.reset();
-
     EXPECT_NE(nullptr, pProgram);
     ASSERT_EQ(CL_SUCCESS, retVal);
 
@@ -120,21 +117,18 @@ TEST_F(clBuildProgramTests, GivenBinaryAsInputWhenCreatingProgramWithBinaryForMu
     MockUnrestrictiveContextMultiGPU context;
     cl_program pProgram = nullptr;
     cl_int binaryStatus = CL_SUCCESS;
-    std::unique_ptr<char[]> pBinary = nullptr;
-    size_t binarySize = 0;
-    std::string testFile;
-    retrieveBinaryKernelFilename(testFile, "CopyBuffer_simd16_", ".bin");
 
-    pBinary = loadDataFromFile(
-        testFile.c_str(),
-        binarySize);
+    constexpr auto numBits = is32bit ? Elf::EI_CLASS_32 : Elf::EI_CLASS_64;
+    auto zebinData = std::make_unique<ZebinTestData::ZebinCopyBufferSimdModule<numBits>>(pDevice->getHardwareInfo(), 16);
+    const auto &src = zebinData->storage;
 
-    ASSERT_NE(0u, binarySize);
-    ASSERT_NE(nullptr, pBinary);
+    ASSERT_NE(nullptr, src.data());
+    ASSERT_NE(0u, src.size());
+    const size_t binarySize = src.size();
 
     const size_t numBinaries = 6;
     const unsigned char *binaries[numBinaries];
-    std::fill(binaries, binaries + numBinaries, reinterpret_cast<const unsigned char *>(pBinary.get()));
+    std::fill(binaries, binaries + numBinaries, reinterpret_cast<const unsigned char *>(src.data()));
     cl_device_id devicesForProgram[] = {context.pRootDevice0, context.pSubDevice00, context.pSubDevice01, context.pRootDevice1, context.pSubDevice10, context.pSubDevice11};
     size_t sizeBinaries[numBinaries];
     std::fill(sizeBinaries, sizeBinaries + numBinaries, binarySize);
@@ -148,8 +142,6 @@ TEST_F(clBuildProgramTests, GivenBinaryAsInputWhenCreatingProgramWithBinaryForMu
         &binaryStatus,
         &retVal);
 
-    pBinary.reset();
-
     EXPECT_NE(nullptr, pProgram);
     ASSERT_EQ(CL_SUCCESS, retVal);
 
@@ -170,17 +162,16 @@ TEST_F(clBuildProgramTests, GivenBinaryAsInputWhenCreatingProgramWithBinaryForMu
 TEST_F(clBuildProgramTests, GivenProgramCreatedFromBinaryWhenBuildProgramWithOptionsIsCalledThenStoredOptionsAreUsed) {
     cl_program pProgram = nullptr;
     cl_int binaryStatus = CL_SUCCESS;
-    size_t binarySize = 0;
-    std::string testFile;
-    retrieveBinaryKernelFilename(testFile, "CopyBuffer_simd16_", ".bin");
 
-    auto pBinary = loadDataFromFile(
-        testFile.c_str(),
-        binarySize);
+    constexpr auto numBits = is32bit ? Elf::EI_CLASS_32 : Elf::EI_CLASS_64;
+    auto zebinData = std::make_unique<ZebinTestData::ZebinCopyBufferSimdModule<numBits>>(pDevice->getHardwareInfo(), 16);
+    const auto &src = zebinData->storage;
 
-    ASSERT_NE(0u, binarySize);
-    ASSERT_NE(nullptr, pBinary);
-    const unsigned char *binaries[1] = {reinterpret_cast<const unsigned char *>(pBinary.get())};
+    ASSERT_NE(nullptr, src.data());
+    ASSERT_NE(0u, src.size());
+    const size_t binarySize = src.size();
+
+    const unsigned char *binaries[1] = {reinterpret_cast<const unsigned char *>(src.data())};
     pProgram = clCreateProgramWithBinary(
         pContext,
         1,
@@ -192,7 +183,6 @@ TEST_F(clBuildProgramTests, GivenProgramCreatedFromBinaryWhenBuildProgramWithOpt
 
     auto pInternalProgram = castToObject<Program>(pProgram);
 
-    pBinary.reset();
     auto storedOptionsSize = pInternalProgram->getOptions().size();
 
     EXPECT_NE(nullptr, pProgram);
@@ -316,17 +306,16 @@ TEST_F(clBuildProgramTests, GivenInvalidCallbackInputWhenBuildProgramThenInvalid
 TEST_F(clBuildProgramTests, GivenValidCallbackInputWhenBuildProgramThenCallbackIsInvoked) {
     cl_program pProgram = nullptr;
     cl_int binaryStatus = CL_SUCCESS;
-    size_t binarySize = 0;
-    std::string testFile;
-    retrieveBinaryKernelFilename(testFile, "CopyBuffer_simd16_", ".bin");
 
-    auto pBinary = loadDataFromFile(
-        testFile.c_str(),
-        binarySize);
+    constexpr auto numBits = is32bit ? Elf::EI_CLASS_32 : Elf::EI_CLASS_64;
+    auto zebinData = std::make_unique<ZebinTestData::ZebinCopyBufferSimdModule<numBits>>(pDevice->getHardwareInfo(), 16);
+    const auto &src = zebinData->storage;
 
-    ASSERT_NE(0u, binarySize);
-    ASSERT_NE(nullptr, pBinary);
-    const unsigned char *binaries[1] = {reinterpret_cast<const unsigned char *>(pBinary.get())};
+    ASSERT_NE(nullptr, src.data());
+    ASSERT_NE(0u, src.size());
+    const size_t binarySize = src.size();
+
+    const unsigned char *binaries[1] = {reinterpret_cast<const unsigned char *>(src.data())};
     pProgram = clCreateProgramWithBinary(
         pContext,
         1,

shared/test/common/mocks/mock_modules_zebin.cpp

@@ -223,4 +223,27 @@ void ZebinWithL0TestCommonModule::recalcPtr() {
     elfHeader = reinterpret_cast<NEO::Elf::ElfFileHeader<NEO::Elf::EI_CLASS_64> *>(storage.data());
 }
 
+template ZebinCopyBufferSimdModule<ELF_IDENTIFIER_CLASS::EI_CLASS_32>::ZebinCopyBufferSimdModule(const NEO::HardwareInfo &hwInfo, uint8_t simdSize);
+template ZebinCopyBufferSimdModule<ELF_IDENTIFIER_CLASS::EI_CLASS_64>::ZebinCopyBufferSimdModule(const NEO::HardwareInfo &hwInfo, uint8_t simdSize);
+
+template <ELF_IDENTIFIER_CLASS numBits>
+ZebinCopyBufferSimdModule<numBits>::ZebinCopyBufferSimdModule(const NEO::HardwareInfo &hwInfo, uint8_t simdSize) {
+    zeInfoSize = static_cast<size_t>(snprintf(nullptr, 0, zeInfoCopyBufferSimdPlaceholder.c_str(), simdSize, simdSize, getLocalIdSize(hwInfo, simdSize)) + 1);
+    zeInfoCopyBuffer.resize(zeInfoSize);
+    snprintf(zeInfoCopyBuffer.data(), zeInfoSize, zeInfoCopyBufferSimdPlaceholder.c_str(), simdSize, simdSize, getLocalIdSize(hwInfo, simdSize));
+
+    MockElfEncoder<numBits> elfEncoder;
+    auto &elfHeader = elfEncoder.getElfFileHeader();
+    elfHeader.type = NEO::Elf::ET_ZEBIN_EXE;
+    elfHeader.machine = hwInfo.platform.eProductFamily;
+
+    const uint8_t testKernelData[0x2c0] = {0u};
+
+    elfEncoder.appendSection(NEO::Elf::SHT_PROGBITS, NEO::Elf::SectionsNamesZebin::textPrefix.str() + "CopyBuffer", testKernelData);
+    elfEncoder.appendSection(NEO::Elf::SHT_ZEBIN_ZEINFO, NEO::Elf::SectionsNamesZebin::zeInfo, zeInfoCopyBuffer);
+
+    storage = elfEncoder.encode();
+    this->elfHeader = reinterpret_cast<NEO::Elf::ElfFileHeader<numBits> *>(storage.data());
+}
+
 }; // namespace ZebinTestData

shared/test/common/mocks/mock_modules_zebin.h

@@ -301,4 +301,75 @@ inline std::vector<uint8_t> createIntelGTNoteSection(PRODUCT_FAMILY productFamil
     return intelGTNotesSection;
 }
 
+template <NEO::Elf::ELF_IDENTIFIER_CLASS numBits>
+struct ZebinCopyBufferSimdModule {
+    ZebinCopyBufferSimdModule(const NEO::HardwareInfo &hwInfo, uint8_t simdSize);
+    inline size_t getLocalIdSize(const NEO::HardwareInfo &hwInfo, uint8_t simdSize) {
+        return alignUp(simdSize * sizeof(uint16_t), hwInfo.capabilityTable.grfSize) * 3;
+    }
+    NEO::Elf::ElfFileHeader<numBits> *elfHeader;
+    std::vector<uint8_t> storage;
+    std::string zeInfoCopyBuffer;
+    size_t zeInfoSize;
+    std::string zeInfoCopyBufferSimdPlaceholder = std::string("version :\'") + versionToString(NEO::zeInfoDecoderVersion) + R"===('
+kernels:
+  - name:            CopyBuffer
+    execution_env:
+      disable_mid_thread_preemption: true
+      grf_count:       128
+      has_no_stateless_write: true
+      inline_data_payload_size: 32
+      offset_to_skip_per_thread_data_load: 192
+      required_sub_group_size: %d
+      simd_size:       %d
+      subgroup_independent_forward_progress: true
+    payload_arguments:
+      - arg_type:        global_id_offset
+        offset:          0
+        size:            12
+      - arg_type:        local_size
+        offset:          12
+        size:            12
+      - arg_type:        arg_bypointer
+        offset:          0
+        size:            0
+        arg_index:       0
+        addrmode:        stateful
+        addrspace:       global
+        access_type:     readwrite
+      - arg_type:        buffer_address
+        offset:          32
+        size:            8
+        arg_index:       0
+      - arg_type:        arg_bypointer
+        offset:          0
+        size:            0
+        arg_index:       1
+        addrmode:        stateful
+        addrspace:       global
+        access_type:     readwrite
+      - arg_type:        buffer_address
+        offset:          40
+        size:            8
+        arg_index:       1
+      - arg_type:        buffer_offset
+        offset:          48
+        size:            4
+        arg_index:       0
+      - arg_type:        buffer_offset
+        offset:          52
+        size:            4
+        arg_index:       1
+    per_thread_payload_arguments:
+      - arg_type:        local_id
+        offset:          0
+        size:            %d
+    binding_table_indices:
+      - bti_value:       0
+        arg_index:       0
+      - bti_value:       1
+        arg_index:       1
+)===";
+};
+
 } // namespace ZebinTestData