Use ZEBinary by default, deprecate flags

This change forces ZEBin by default.
It deprecates and starts ingoring ZEBin user enable and disable
flags as well as internal allow flag.
Flags that are now ignored:
`cl-disable-zebin`, `-ze-disable-zebin`,
`-cl-enable-zebin`, `-ze-enable-zebin`,
`-ze-allow-zebin`, `-cl-allow-zebin`.

It's still possible to disable ZEBin via internal
`-cl-disable-zebin`, `-ze-disable-zebin` flags.

Author: fda0

IGC/AdaptorOCL/dllInterfaceCompute.cpp

@@ -841,9 +841,7 @@ bool ProcessElfInput(
                         SetErrorMessage(
                             "vISA linking can be used only with ZeBinary "
                             "compiler output format. It seems that it is "
-                            "currently disabled for your platform. You can "
-                            "experiment with EnableZEBinary environmental "
-                            "flag to turn it on.",
+                            "currently disabled for your platform.",
                             OutputArgs);
                         return false;
                     }

IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.hpp

@@ -92,23 +92,13 @@ namespace IGC
                 }
             };
 
-            // If env flag is set, use it's value no matter what (works as "Force").
-            if (IGC_IS_FLAG_SET(EnableZEBinary))
-                m_enableZEBinary = IGC_IS_FLAG_ENABLED(EnableZEBinary);
-
-            // Runtime option precede supported platforms (can force zebin on unsupported).
-            else if (m_InternalOptions.EnableZEBinary)
-                m_enableZEBinary = *m_InternalOptions.EnableZEBinary;
-            else if (m_Options.EnableZEBinary)
-                m_enableZEBinary = *m_Options.EnableZEBinary;
-
-            // If platform is unsupported, disable regardless of the default.
-            else if (!supportsZEBin(platform))
+            if (m_InternalOptions.DisableZEBinary) {
+                // Allow to disable ZEBin via internal options
                 m_enableZEBinary = false;
-
-            // Set the default value from the flag table.
-            else
-                m_enableZEBinary = IGC_IS_FLAG_ENABLED(EnableZEBinary);
+            } else {
+                // Enable ZEBin for all supported platforms
+                m_enableZEBinary = supportsZEBin(platform);
+            }
         }
 
         bool enableZEBinary() const override { return m_enableZEBinary; }

IGC/Compiler/CISACodeGen/OpenCLOptions.cpp

@@ -204,14 +204,9 @@ void InternalOptions::parseOptions(const char* internalOpts)
         }
     }
 
-    if (internalOptions.hasArg(OPT_allow_zebin_common))
-    {
-        EnableZEBinary = true;
-    }
-
     if (internalOptions.hasArg(OPT_disable_zebin_common))
     {
-        EnableZEBinary = false;
+        DisableZEBinary = true;
     }
 
     if (internalOptions.hasArg(OPT_exclude_ir_from_zebin_common))
@@ -603,14 +598,10 @@ void Options::parseOptions(const char* opts)
         EnableFP64GenConvEmu = true;
     }
 
-    if (apiOptions.hasArg(OPT_enable_zebin_common))
-    {
-        EnableZEBinary = true;
-    }
-
-    if (apiOptions.hasArg(OPT_disable_zebin_common))
+    if (const llvm::opt::Arg* arg = apiOptions.getLastArg(OPT_Xfinalizer))
     {
-        EnableZEBinary = false;
+        Xfinalizer = true;
+        XfinalizerOption = arg->getValue();
     }
 
     if (const llvm::opt::Arg* arg = apiOptions.getLastArg(OPT_Xfinalizer))

IGC/Compiler/CISACodeGen/OpenCLOptions.hpp

@@ -114,7 +114,7 @@ class InternalOptions
      uint32_t IntelScratchSpacePrivateMemoryMinimalSizePerThread = 0;
 
      bool EnableDivergentBarrierHandling             = false;
-     std::optional<bool> EnableZEBinary;
+     bool DisableZEBinary                            = false;
      bool EnableBufferBoundsChecking                 = false;
 
      // Compile only up to vISA stage.
@@ -192,8 +192,6 @@ class Options
     // This applies to platforms that cannot HW support for double operations
     bool EnableFP64GenConvEmu = false;
 
-    std::optional<bool> EnableZEBinary;
-
 private:
     void parseOptions(const char* opts);
 };

IGC/Compiler/tests/DebugInfo/SPIRMetaDataTranslation.ll

@@ -139,7 +139,7 @@ attributes #3 = { nounwind readnone }
 !15 = !{!"intel_reqd_sub_group_size", i32 16}
 !16 = !{!"ModuleMD", !17, !18, !59}
 !17 = !{!"isPrecise", i1 false}
-!18 = !{!"compOpt", !19, !20, !21, !22, !23, !24, !25, !26, !27, !28, !29, !30, !31, !32, !33, !34, !35, !36, !37, !38, !39, !40, !41, !42, !43, !44, !45, !46, !47, !48, !49, !50, !51, !52, !53, !54, !55, !56, !57, !58}
+!18 = !{!"compOpt", !19, !20, !21, !22, !23, !24, !25, !26, !27, !28, !29, !30, !31, !32, !33, !34, !35, !36, !37, !38, !39, !40, !41, !42, !43, !44, !45, !46, !47, !48, !49, !50, !51, !52, !53, !54, !55, !56, !57}
 !19 = !{!"DenormsAreZero", i1 false}
 !20 = !{!"CorrectlyRoundedDivSqrt", i1 false}
 !21 = !{!"OptDisable", i1 false}
@@ -179,7 +179,6 @@ attributes #3 = { nounwind readnone }
 !55 = !{!"FastVISACompile", i1 false}
 !56 = !{!"MatchSinCosPi", i1 false}
 !57 = !{!"CaptureCompilerStats", i1 false}
-!58 = !{!"EnableZEBinary", i1 false}
 !59 = !{!"FuncMD", !60, !61}
 !60 = !{!"FuncMDMap[0]", void (i64 addrspace(1)*)* @test_spir}
 !61 = !{!"FuncMDValue[0]", !62, !63}

IGC/Compiler/tests/OpenCLPrintfResolution/basic.ll

@@ -7,7 +7,7 @@
 ;============================ end_copyright_notice =============================
 ; REQUIRES: regkeys
 ;
-; RUN: igc_opt -regkey EnableZEBinary=0  -igc-opencl-printf-resolution -S  < %s | FileCheck %s
+; RUN: igc_opt --platformglk -igc-opencl-printf-resolution -S  < %s | FileCheck %s
 ; ------------------------------------------------
 ; OpenCLPrintfResolution
 ; ------------------------------------------------

IGC/Compiler/tests/ProgramScopeConstantAnalysis/printf-string-constant.ll

@@ -7,12 +7,13 @@
 ;============================ end_copyright_notice =============================
 ; REQUIRES: regkeys
 ; RUN: igc_opt -igc-programscope-constant-analysis -igc-serialize-metadata \
-; RUN:   -S -regkey EnableZEBinary=1 < %s | FileCheck %s
+; RUN:   -S < %s | FileCheck %s
 ; ------------------------------------------------
 ; ProgramScopeConstantAnalysis
 ; ------------------------------------------------
 
-; Test checks that metadata is updated with correct string constants when EnableZEBinary=1
+; Test checks that metadata is updated with correct string constants
+; (this tested the case with EnableZEBinary=1 which is the default now)
 
 ; CHECK:     !{!"stringConstants",
 ; CHECK-DAG: !{!"stringConstantsSet{{[[][0-9][]]}}", [3 x i8] addrspace(2)* @opencl_printf_str}

IGC/Compiler/tests/ProgramScopeConstantAnalysis/relaxed-printf-address-space.ll

@@ -7,14 +7,14 @@
 ;============================ end_copyright_notice =============================
 ; REQUIRES: regkeys
 ; RUN: igc_opt -igc-programscope-constant-analysis -igc-serialize-metadata \
-; RUN:   -S -regkey EnableZEBinary=1 < %s | FileCheck %s
+; RUN:   -S < %s | FileCheck %s
 ; ------------------------------------------------
 ; ProgramScopeConstantAnalysis
 ; ------------------------------------------------
 
 ; Test checks that metadata can be updated correctly with non-constant address
-; space string constants after the address space requirement is relaxed when
-; EnableZEBinary=1
+; space string constants after the address space requirement is relaxed
+; (this tested the case with EnableZEBinary=1 which is the default now)
 
 ; CHECK:     !{!"stringConstants",
 ; CHECK-DAG: !{!"stringConstantsSet{{[[][0-9][]]}}", [3 x i8] addrspace(2)* @fmt_str}

IGC/Compiler/tests/ProgramScopeConstantResolution/basic.ll

@@ -7,7 +7,7 @@
 ;============================ end_copyright_notice =============================
 ; REQUIRES: regkeys
 ;
-; RUN: igc_opt -regkey EnableZEBinary=0 -enable-debugify --igc-programscope-constant-resolve -S < %s 2>&1 | FileCheck %s --check-prefixes=CHECK,%LLVM_DEPENDENT_CHECK_PREFIX%
+; RUN: igc_opt -enable-debugify --igc-programscope-constant-resolve -S < %s 2>&1 | FileCheck %s --check-prefixes=CHECK,%LLVM_DEPENDENT_CHECK_PREFIX%
 ; ------------------------------------------------
 ; ProgramScopeConstantResolution
 ; ------------------------------------------------

IGC/Compiler/tests/ProgramScopeConstantResolution/offset_minus_one.ll

@@ -7,7 +7,7 @@
 ;============================ end_copyright_notice =============================
 ; REQUIRES: regkeys
 ;
-; RUN: igc_opt -regkey EnableZEBinary=0 -enable-debugify --igc-programscope-constant-resolve -S < %s 2>&1 | FileCheck %s
+; RUN: igc_opt -enable-debugify --igc-programscope-constant-resolve -S < %s 2>&1 | FileCheck %s
 ; ------------------------------------------------
 ; ProgramScopeConstantResolution
 ; ------------------------------------------------

IGC/OCLFE/igd_fcl_mcl/source/clang_tb.cpp

@@ -1356,10 +1356,10 @@ namespace TC
                             (strcmp(pParam, "-ze-force-global-mem-allocation") == 0) || // temp
                             (strcmp(pParam, "-cl-no-local-to-generic") == 0) || // temp
                             (strcmp(pParam, "-ze-no-local-to-generic") == 0) || // temp
-                            (strcmp(pParam, "-cl-disable-zebin") == 0) ||
-                            (strcmp(pParam, "-ze-disable-zebin") == 0) ||
-                            (strcmp(pParam, "-cl-enable-zebin") == 0) ||
-                            (strcmp(pParam, "-ze-enable-zebin") == 0) ||
+                            (strcmp(pParam, "-cl-disable-zebin") == 0) || // deprecated
+                            (strcmp(pParam, "-ze-disable-zebin") == 0) || // deprecated
+                            (strcmp(pParam, "-cl-enable-zebin") == 0) || // deprecated
+                            (strcmp(pParam, "-ze-enable-zebin") == 0) || // deprecated
                             (strcmp(pParam, "-cl-intel-debug-info") == 0) ||
                             (strncmp(pParam, "-dump-opt-llvm", 14) == 0) ||
                             (strcmp(pParam, "-cl-no-subgroup-ifp") == 0) ||

IGC/Options/include/igc/Options/CommonApiOptions.td

@@ -49,11 +49,11 @@ defm : CommonJoined<"library-compile-simd=">, Alias<library_compile_simd_common>
 
 // -cl-enable-zebin, -ze-enable-zebin
 defm enable_zebin : CommonFlag<"enable-zebin">,
-  HelpText<"Emit level zero binary (zebin)">;
+  HelpText<"Deprecated - Emit level zero binary (zebin)">;
 
 // -cl-disable-zebin, -ze-disable-zebin
 defm disable_zebin : CommonFlag<"disable-zebin">,
-  HelpText<"Emit binary in legacy format">;
+  HelpText<"Deprecated - Emit binary in legacy format">;
 
 defm exp_register_file_size : CommonSeparate<"exp-register-file-size">,
   HelpText<"Set amount of registers used by regalloc">;

IGC/Options/include/igc/Options/CommonInternalOptions.td

@@ -25,7 +25,7 @@ def emit_visa_only : PlainFlag<"emit-visa-only">,
 
 // -cl-allow-zebin, -ze-allow-zebin
 defm allow_zebin : CommonFlag<"allow-zebin">,
-  HelpText<"Emit level zero binary">;
+  HelpText<"Deprecated - Emit level zero binary">;
 
 // -cl-disable-zebin, -ze-disable-zebin
 defm disable_zebin : CommonFlag<"disable-zebin">,

IGC/VectorCompiler/igcdeps/src/TranslationInterface.cpp

@@ -264,21 +264,6 @@ static void adjustDebugStrippingPolicy(vc::CompileOptions &Opts) {
   }
 }
 
-// Overwrite binary format option for backward compatibility with
-// environment variable approach.
-static void adjustBinaryFormat(vc::BinaryKind &Binary) {
-  if (Binary == vc::BinaryKind::CM)
-    return;
-
-  if (Binary != vc::BinaryKind::Default && !IGC_IS_FLAG_SET(EnableZEBinary))
-    return;
-
-  if (IGC_IS_FLAG_ENABLED(EnableZEBinary))
-    Binary = vc::BinaryKind::ZE;
-  else
-    Binary = vc::BinaryKind::OpenCL;
-}
-
 template <typename T> T deriveDefaultableFlagValue(int Flag) {
   switch (Flag) {
   default:
@@ -354,7 +339,6 @@ static void adjustOptions(const IGC::CPlatform &IGCPlatform,
   adjustPlatform(IGCPlatform, Opts);
   adjustFileType(DataFormat, Opts);
   adjustOptLevel(Opts);
-  adjustBinaryFormat(Opts.Binary);
   adjustDumpOptions(Opts);
   adjustStackCalls(Opts, Diag);
   adjustDebugStrippingPolicy(Opts);

IGC/VectorCompiler/include/vc/Driver/Driver.h

@@ -61,11 +61,7 @@ struct CompileOptions {
   std::string ApiOptions;
 
   // Output binary format
-  // API options:
-  //   -[cl,ze]-enable-zebin
-  ///  -[cl,ze]-disable-zebin
   // Internal options:
-  //   -[cl,ze]-allow-zebin
   //   -[cl,ze]-disable-zebin
   //   -binary-format=[ocl,ze,cm]
   // Debug keys:

IGC/VectorCompiler/lib/Driver/Driver.cpp

@@ -744,19 +744,6 @@ static Error fillApiOptions(const opt::ArgList &ApiOptions,
     Opts.GRFSize = MaybeGRFSize;
   }
 
-  if (opt::Arg *A =
-          ApiOptions.getLastArg(OPT_enable_zebin_common, OPT_disable_zebin_common))
-    switch (A->getOption().getID()) {
-    case OPT_enable_zebin_common:
-      Opts.Binary = vc::BinaryKind::ZE;
-      break;
-    case OPT_disable_zebin_common:
-      Opts.Binary = vc::BinaryKind::OpenCL;
-      break;
-    default:
-      break;
-    }
-
   if (opt::Arg *A = ApiOptions.getLastArg(OPT_fp_contract)) {
     StringRef Val = A->getValue();
     auto MayBeAllowFPOPFusion =
@@ -847,14 +834,12 @@ static Error fillInternalOptions(const opt::ArgList &InternalOptions,
     Opts.InteropSubgroupSize = MaybeSize.getValue();
   }
 
-  if (opt::Arg *A = InternalOptions.getLastArg(
-          OPT_binary_format, OPT_allow_zebin_common, OPT_disable_zebin_common)) {
+  Opts.Binary = vc::BinaryKind::ZE;
+  if (opt::Arg* A = InternalOptions.getLastArg(
+      OPT_binary_format, OPT_disable_zebin_common)) {
     auto OptID = A->getOption().getID();
-
-    if (OptID == OPT_allow_zebin_common)
-      Opts.Binary = vc::BinaryKind::ZE;
-    else if (OptID == OPT_disable_zebin_common)
-      Opts.Binary = vc::BinaryKind::OpenCL;
+    if (OptID == OPT_disable_zebin_common)
+        Opts.Binary = vc::BinaryKind::OpenCL;
     else {
       StringRef Val = A->getValue();
       auto MaybeBinary = StringSwitch<Optional<vc::BinaryKind>>(Val)

IGC/common/igc_flags.h

@@ -815,7 +815,6 @@ DECLARE_IGC_REGKEY(bool, EnableLocalIdCalculationInShader, false,
     "used.", true)
 DECLARE_IGC_REGKEY(int, JointMatrixLoadStoreOpt, 3, "Selects subgroup (0), or block read/write (1), or optimized block read/write (2), 2d block read/write (3) implementation of Joint Matrix Load/Store built-ins", true)
 DECLARE_IGC_REGKEY(bool, EnableVector8LoadStore, false, "Enable Vectorizer to generate 8x32i and 4x64i loads and stores", true)
-DECLARE_IGC_REGKEY(bool, EnableZEBinary, true,  "Force-enable output in ZE binary format. Leave unset for compiler to choose based on current platform's support for ZE binary", true)
 DECLARE_IGC_REGKEY(bool, ExcludeIRFromZEBinary, false, "Exclude IR sections from ZE binary", true)
 DECLARE_IGC_REGKEY(bool, AllocateZeroInitializedVarsInBss, true,  "Allocate zero initialized global variables in .bss section in ZEBinary", true)
 DECLARE_IGC_REGKEY(DWORD, OverrideOCLMaxParamSize, 0,  "Override the value imposed on the kernel by CL_DEVICE_MAX_PARAMETER_SIZE. Value in bytes, if value==0 no override happens.", true)