ZEBinary: add .misc.buildOptions section (2nd try)

.misc.buildOptions contains the build options those are used for compiling this
binary. The information is needed for re-compilation from a ZEBinary.

Author: DianaChen

IGC/AdaptorOCL/OCL/sp/spp_g8.cpp

@@ -427,13 +427,19 @@ bool createElfFileName(std::string &name, unsigned int maxNameLen, SIMDMode simd
 }
 
 void CGen8OpenCLProgram::GetZEBinary(
-    llvm::raw_pwrite_stream& programBinary, unsigned pointerSizeInBytes,
-    const char* spv, uint32_t spvSize, const char* metrics, uint32_t metricsSize)
+    llvm::raw_pwrite_stream& programBinary,
+    unsigned pointerSizeInBytes,
+    const char* spv, uint32_t spvSize,
+    const char* metrics, uint32_t metricsSize,
+    const char* buildOptions, uint32_t buildOptionsSize)
 {
     std::vector<std::unique_ptr<llvm::MemoryBuffer>> elfStorage;
 
     ZEBinaryBuilder zebuilder(m_Platform, pointerSizeInBytes == 8,
-        m_Context.m_programInfo, (const uint8_t*)spv, spvSize, (const uint8_t*)metrics, metricsSize);
+        m_Context.m_programInfo,
+        (const uint8_t*)spv, spvSize,
+        (const uint8_t*)metrics, metricsSize,
+        (const uint8_t*)buildOptions, buildOptionsSize);
     zebuilder.setProductFamily(m_Platform.eProductFamily);
 
     std::vector<string> elfVecNames;      // Vector of parameters for the linker, contains in/out ELF file names and params

IGC/AdaptorOCL/OCL/sp/spp_g8.h

@@ -88,8 +88,12 @@ class CGen8OpenCLProgram : public CGen8OpenCLProgramBase
 
     /// getZEBinary - create and get ZE Binary
     /// if spv and spvSize are given, a .spv section will be created in the output ZEBinary
-    void GetZEBinary(llvm::raw_pwrite_stream& programBinary, unsigned pointerSizeInBytes,
-        const char* spv, uint32_t spvSize, const char* metrics, uint32_t metricsSize);
+    void GetZEBinary(
+        llvm::raw_pwrite_stream& programBinary,
+        unsigned pointerSizeInBytes,
+        const char* spv,          uint32_t spvSize,
+        const char* metrics,      uint32_t metricsSize,
+        const char* buildOptions, uint32_t buildOptionsSize);
 
     // Used to track the kernel info from CodeGen
     std::vector<IGC::CShaderProgram*> m_ShaderProgramList;

IGC/AdaptorOCL/OCL/sp/zebin_builder.cpp

@@ -26,7 +26,9 @@ using namespace llvm;
 
 ZEBinaryBuilder::ZEBinaryBuilder(
     const PLATFORM plat, bool is64BitPointer, const IGC::SOpenCLProgramInfo& programInfo,
-    const uint8_t* spvData, uint32_t spvSize, const uint8_t* metricsData, uint32_t metricsSize)
+    const uint8_t* spvData, uint32_t spvSize,
+    const uint8_t* metricsData, uint32_t metricsSize,
+    const uint8_t* buildOptions, uint32_t buildOptionsSize)
     : mPlatform(plat), mBuilder(is64BitPointer)
 {
     G6HWC::InitializeCapsGen8(&mHWCaps);
@@ -44,6 +46,9 @@ ZEBinaryBuilder::ZEBinaryBuilder(
     if (spvData != nullptr)
         addSPIRV(spvData, spvSize);
 
+    if (buildOptions != nullptr && buildOptionsSize)
+        addMiscInfoSection("buildOptions", buildOptions, buildOptionsSize);
+
     // Add metrics section to zeBinary regardless of metrics presence,
     // i.e. if there is no metrics data then an empty section will be added.
     addMetrics(metricsData, metricsSize);
@@ -256,6 +261,11 @@ void ZEBinaryBuilder::addSPIRV(const uint8_t* data, uint32_t size)
     mBuilder.addSectionSpirv("", data, size);
 }
 
+void ZEBinaryBuilder::addMiscInfoSection(std::string sectName, const uint8_t* data, uint32_t size)
+{
+    mBuilder.addSectionMisc(sectName, data, size);
+}
+
 void ZEBinaryBuilder::addMetrics(const uint8_t* data, uint32_t size)
 {
     mBuilder.addSectionMetrics("", data, size);

IGC/AdaptorOCL/OCL/sp/zebin_builder.hpp

@@ -39,8 +39,10 @@ class ZEBinaryBuilder : DisallowCopy
     // Setup ZEBin platform, and ELF header information. The program scope information
     // is also be parsed from SOpenCLProgramInfo in the constructor
     ZEBinaryBuilder(const PLATFORM plat, bool is64BitPointer,
-        const IGC::SOpenCLProgramInfo& programInfo, const uint8_t* spvData, uint32_t spvSize,
-        const uint8_t* metricsData, uint32_t metricsSize);
+        const IGC::SOpenCLProgramInfo& programInfo,
+        const uint8_t* spvData,      uint32_t spvSize,
+        const uint8_t* metricsData,  uint32_t metricsSize,
+        const uint8_t* buildOptions, uint32_t buildOptionsSize);
 
     // Set the ProductFamily as the specified value.
     void setProductFamily(PRODUCT_FAMILY value);
@@ -100,6 +102,9 @@ class ZEBinaryBuilder : DisallowCopy
     /// add spir-v section
     void addSPIRV(const uint8_t* data, uint32_t size);
 
+    /// add miscellaneous info section (section with SHT_ZEBIN_MISC type)
+    void addMiscInfoSection(std::string sectName, const uint8_t* data, uint32_t size);
+
     /// add runtime symbols
     void addRuntimeSymbols();
 

IGC/AdaptorOCL/dllInterfaceCompute.cpp

@@ -1377,7 +1377,7 @@ bool TranslateBuildSPMD(const STB_TranslateInputArgs *pInputArgs,
         auto metricData = reinterpret_cast<const char*>(oclContext.metrics.getMetricData());
 
         oclContext.m_programOutput.GetZEBinary(llvm_os, pointerSizeInBytes,
-            spv_data, spv_size, metricData, metricDataSize);
+            spv_data, spv_size, metricData, metricDataSize, pInputArgs->pOptions, pInputArgs->OptionsSize);
 
         // FIXME: try to avoid memory copy here
         binarySize = buf.size();

IGC/VectorCompiler/igcdeps/src/PatchTokens.cpp

@@ -191,7 +191,7 @@ void CGen8CMProgram::GetZEBinary(llvm::raw_pwrite_stream &programBinary,
   // is destroyed.
   std::unique_ptr<llvm::MemoryBuffer> DebugInfoHolder;
   iOpenCL::ZEBinaryBuilder zebuilder{m_Platform, pointerSizeInBytes == 8,
-                                     *m_programInfo, nullptr, 0, nullptr, 0};
+                                     *m_programInfo, nullptr, 0, nullptr, 0, nullptr, 0};
   zebuilder.setGfxCoreFamily(m_Platform.eRenderCoreFamily);
 
   for (const auto &kernel : m_kernels) {

IGC/ZEBinWriter/zebin/source/ZEELFObjectBuilder.cpp

@@ -697,7 +697,8 @@ void ELFWriter::writeSections()
         }
         case ELF::SHT_PROGBITS:
         case SHT_ZEBIN_VISAASM:
-        case SHT_ZEBIN_SPIRV: {
+        case SHT_ZEBIN_SPIRV:
+        case SHT_ZEBIN_MISC: {
             IGC_ASSERT(nullptr != entry.section);
             IGC_ASSERT(entry.section->getKind() == Section::STANDARD);
             const StandardSection* const stdsect =

IGC/ZEBinWriter/zebin/spec/elf.md

@@ -24,7 +24,7 @@ SPDX-License-Identifier: MIT
 | .debug_* | the debug information (if required) | SHT_PROGBITS |
 | .ze_info | the metadata section for runtime information | SHT_ZEBIN_ZEINFO |
 | .gtpin_info.{*kernel_name*\|*function_name*} | the metadata section for gtpin information (if any) | SHT_ZEBIN_GTPIN_INFO |
-| .misc | the miscellaneous data for multiple purposes (if required) | SHT_ZEBIN_MISC |
+| .misc.{*misc_name*} | the miscellaneous data for multiple purposes. For example, the section _.misc.buildOptions_ contains the build options used for compiling this binary.  | SHT_ZEBIN_MISC |
 | .note.intelgt.compat | the compatibility notes for runtime information | SHT_NOTE |
 | .strtab | the string table for section/symbol names | SHT_STRTAB |