EnableElf2ZEBinary->ZeBinCompatible debug emitter option renaming

Author: aparshin-intel

IGC/AdaptorOCL/OCL/sp/spp_g8.cpp

@@ -456,7 +456,7 @@ void CGen8OpenCLProgram::GetZEBinary(
             if (isValidShader(simd8Shader))
                 kernelVec.push_back(simd8Shader);
 
-            if (IGC_IS_FLAG_ENABLED(EnableElf2ZEBinary))
+            if (IGC_IS_FLAG_ENABLED(ZeBinCompatibleDebugging))
             {
                 IGC_ASSERT_MESSAGE(false, "Missing ELF linking support for multiple SIMD modes");
             }
@@ -496,7 +496,7 @@ void CGen8OpenCLProgram::GetZEBinary(
 
             // ... Create the debug data binary streams
 
-            if (IGC_IS_FLAG_ENABLED(EnableElf2ZEBinary))
+            if (IGC_IS_FLAG_ENABLED(ZeBinCompatibleDebugging))
             {
                 const unsigned int rsrvdForAllButFullName = 64;  // characters will be used for temporary ELF file names.
                 unsigned int spaceAvailableForKernelName = maxElfFileNameLength - rsrvdForAllButFullName - tempDir.size();
@@ -573,7 +573,7 @@ void CGen8OpenCLProgram::GetZEBinary(
         }
     }
 
-    if (IGC_IS_FLAG_ENABLED(EnableElf2ZEBinary))
+    if (IGC_IS_FLAG_ENABLED(ZeBinCompatibleDebugging))
     {
         if (!elfTmpFilesError)
         {

IGC/Compiler/CISACodeGen/EmitVISAPass.cpp

@@ -819,9 +819,9 @@ bool EmitPass::runOnFunction(llvm::Function& F)
         DebugOpts.EmitDebugRanges = IGC_IS_FLAG_ENABLED(EmitDebugRanges);
         DebugOpts.EmitDebugLoc = IGC_IS_FLAG_ENABLED(EmitDebugLoc);
         DebugOpts.EmitOffsetInDbgLoc = IGC_IS_FLAG_ENABLED(EmitOffsetInDbgLoc);
-        DebugOpts.EnableRelocation = IGC_IS_FLAG_ENABLED(EnableRelocations) || IGC_IS_FLAG_ENABLED(EnableElf2ZEBinary);
-        DebugOpts.EnableElf2ZEBinary = IGC_IS_FLAG_ENABLED(EnableElf2ZEBinary);
-        DebugOpts.EnforceAMD64Machine = IGC_IS_FLAG_ENABLED(DebugInfoEnforceAmd64EM) || IGC_IS_FLAG_ENABLED(EnableElf2ZEBinary);
+        DebugOpts.EnableRelocation = IGC_IS_FLAG_ENABLED(EnableRelocations) || IGC_IS_FLAG_ENABLED(ZeBinCompatibleDebugging);
+        DebugOpts.ZeBinCompatible = IGC_IS_FLAG_ENABLED(ZeBinCompatibleDebugging);
+        DebugOpts.EnforceAMD64Machine = IGC_IS_FLAG_ENABLED(DebugInfoEnforceAmd64EM) || IGC_IS_FLAG_ENABLED(ZeBinCompatibleDebugging);
         DebugOpts.EmitPrologueEnd = IGC_IS_FLAG_ENABLED(EmitPrologueEnd);
         IF_DEBUG_INFO(m_pDebugEmitter = IDebugEmitter::Create();)
         IF_DEBUG_INFO(m_pDebugEmitter->Initialize(std::move(vMod), DebugOpts);)

IGC/DebugInfo/EmitterOpts.hpp

@@ -22,7 +22,7 @@ namespace IGC
     bool EmitDebugLoc = false;
     bool EmitOffsetInDbgLoc = false;
     bool EnableRelocation = false;
-    bool EnableElf2ZEBinary = false;
+    bool ZeBinCompatible = false;
     bool EnforceAMD64Machine = false;
     bool EmitPrologueEnd = true;
     bool ScratchOffsetInOW = true;

IGC/DebugInfo/VISADebugEmitter.cpp

@@ -337,14 +337,14 @@ std::vector<char> DebugEmitter::Finalize(bool finalize, DbgDecoder* decodedDbg,
         phtSize = sizeof(llvm::ELF::Elf64_Phdr);
 
     unsigned int kernelNameSizeWithDot = 0;
-    if (m_pStreamEmitter->GetEmitterSettings().EnableElf2ZEBinary)
+    if (m_pStreamEmitter->GetEmitterSettings().ZeBinCompatible)
     {
         kernelNameSizeWithDot = sizeof('.') + pFunc->getName().size();
     }
     size_t elfWithProgramHeaderSize = m_str.size() + phtSize + kernelNameSizeWithDot;
     std::vector<char> Result(elfWithProgramHeaderSize);
 
-    if (!m_pStreamEmitter->GetEmitterSettings().EnableElf2ZEBinary)
+    if (!m_pStreamEmitter->GetEmitterSettings().ZeBinCompatible)
     {
         // Text section remains with its standard name .text
         std::copy(m_str.begin(), m_str.end(), Result.begin());

IGC/common/igc_flags.def

@@ -272,7 +272,7 @@ DECLARE_IGC_REGKEY(bool, EnableGTLocationDebugging,     false, "Setting this to
 DECLARE_IGC_REGKEY(bool, UseOffsetInLocation,           true,  "Setting this to 1 (true) preserves private base and per thread offset and removes preservation of any other debug variables", true)
 DECLARE_IGC_REGKEY(bool, EnableRelocations,             false, "Setting this to 1 (true) makes IGC emit relocatable ELF with debug info", true)
 DECLARE_IGC_REGKEY(bool, EnableWriteOldFPToStack,       true,  "Setting this to 1 (true) writes the caller frame's frame-pointer to the start of callee's frame on stack, to support stack walk", false)
-DECLARE_IGC_REGKEY(bool, EnableElf2ZEBinary,            false, "Setting this to 1 (true) enables embed debug info in zeBinary", true)
+DECLARE_IGC_REGKEY(bool, ZeBinCompatibleDebugging,      false, "Setting this to 1 (true) enables embed debug info in zeBinary", true)
 DECLARE_IGC_REGKEY(bool, DebugInfoEnforceAmd64EM,       false, "Enforces elf file with the debug infomation to have eMachine set to AMD64", false)
 DECLARE_IGC_REGKEY(debugString, ExtraOCLOptions,        0,     "Extra options for OpenCL", true)
 DECLARE_IGC_REGKEY(debugString, ExtraOCLInternalOptions, 0,    "Extra internal options for OpenCL", true)

documentation/configuration_flags.md

@@ -66,7 +66,7 @@ $ export IGC_ShaderDumpEnable=1
 - **UseOffsetInLocation** - Using offset in location limits variables available for a debugger all time
 - **ElfDumpEnable** - Dump ELF
 - **ElfTempDumpEnable** - Dump temporary ELF files
-- **EnableElf2ZEBinary** - Enables embed debug info in zeBinary
+- **ZeBinCompatibleDebugging** - Enables embed debug info in zeBinary
 - **EnableLivenessDump** - Enable dumping out liveness info on stderr
 - **EnableLTODebug** - Enable debug information for LTO
 - **EnableMaxWGSizeCalculation** - Enable max work group size calculation [OCL only]