VC backend should not use reserved BTI indexes for debuggable kernels.

Change-Id: I4e854220fc665a8c663a23b26be76823b855836a

Author: aparshin-intel

IGC/VectorCompiler/include/vc/GenXCodeGen/GenXWrapper.h

@@ -152,6 +152,8 @@ struct CompileOptions {
 
   // Api accessible options.
   bool NoVecDecomp = false;
+  bool EmitDebugInfo = false;
+
   OptimizerLevel OptLevel = OptimizerLevel::Full;
   llvm::Optional<unsigned> StackMemSize;
 

IGC/VectorCompiler/include/vc/GenXOpts/Utils/KernelInfo.h

@@ -39,6 +39,10 @@ namespace genx {
 
 enum { VISA_MAJOR_VERSION = 3, VISA_MINOR_VERSION = 6 };
 
+namespace DebugMD {
+static constexpr const char DebuggableKernels[] = "VC.Debug.Enable";
+}
+
 // Utility function to tell whether a Function is a vISA kernel.
 inline bool isKernel(const Function *F) {
   // We use DLLExport to represent a kernel in LLVM IR.
@@ -205,6 +209,13 @@ class KernelMetadata {
   void computeBTIs() {
     unsigned SurfaceID = 0;
     unsigned SamplerID = 0;
+
+    IGC_ASSERT_MESSAGE(F, "BTI assignment requires a function to process");
+    const Module* M = F->getParent();
+    // If module does have Debuggable Kernels, then BTI=0 is reserved
+    if (M->getNamedMetadata(DebugMD::DebuggableKernels))
+      SurfaceID = SamplerID = 1;
+
     auto Desc = ArgTypeDescs.begin();
     // Assign SRV and samplers.
     for (auto Kind = ArgKinds.begin(); Kind != ArgKinds.end(); ++Kind) {

IGC/VectorCompiler/lib/GenXCodeGen/GenXBackendConfig.cpp

@@ -39,6 +39,11 @@ using namespace llvm;
 // All options that can control backend behavior should be here.
 //
 //===----------------------------------------------------------------------===//
+
+static cl::opt<bool> GenerateDebugInfoOpt(
+    "emit-debug-info", cl::init(false), cl::Hidden,
+    cl::desc("Generate DWARF debug info for each compiled kernel"));
+
 static cl::opt<bool> DumpRegAllocOpt(
     "genx-dump-regalloc", cl::init(false), cl::Hidden,
     cl::desc(
@@ -68,8 +73,8 @@ static cl::opt<std::string> DebugInfoDumpNameOverride(
 char GenXBackendConfig::ID = 0;
 
 GenXBackendOptions::GenXBackendOptions()
-    : DumpRegAlloc(DumpRegAllocOpt), StackSurfaceMaxSize(StackMemSizeOpt),
-      EnableAsmDumps(EnableAsmDumpsOpt),
+    : EnableKernelDebug(GenerateDebugInfoOpt), DumpRegAlloc(DumpRegAllocOpt),
+      StackSurfaceMaxSize(StackMemSizeOpt), EnableAsmDumps(EnableAsmDumpsOpt),
       EnableDebugInfoDumps(EnableDebugInfoDumpOpt),
       DebugInfoDumpsNameOverride(DebugInfoDumpNameOverride) {}
 

IGC/VectorCompiler/lib/GenXCodeGen/GenXBackendConfig.h

@@ -58,9 +58,10 @@ void initializeGenXBackendConfigPass(PassRegistry &PR);
 // Plain structure to be filled by users who want to create backend
 // configuration. Some values are default-initialized from cl options.
 struct GenXBackendOptions {
+  // Enables debugging facilities for the compiled kernels
+  bool EnableKernelDebug;
   // Enable/disable regalloc dump.
   bool DumpRegAlloc;
-
   // Maximum available memory for stack (in bytes).
   unsigned StackSurfaceMaxSize;
 
@@ -110,6 +111,7 @@ class GenXBackendConfig : public ImmutablePass {
     return Data.OCLGenericBiFModule;
   }
 
+  bool kernelDebugEnabled() const { return Options.EnableKernelDebug; }
   // Return whether shader dumper is installed.
   bool hasShaderDumper() const { return Options.Dumper; }
 

IGC/VectorCompiler/lib/GenXCodeGen/GenXCisaBuilder.cpp

@@ -5767,7 +5767,7 @@ ModulePass *llvm::createGenXFinalizerPass(raw_pwrite_stream &o) {
 
 static SmallVector<const char *, 8>
 collectFinalizerArgs(StringSaver &Saver, const GenXSubtarget &ST,
-                     const bool AsmDumpsEnabled) {
+                     const bool EnableKernelDebug, const bool AsmDumpsEnabled) {
   SmallVector<const char *, 8> Argv;
   auto addArgument = [&Argv, &Saver](StringRef Arg) {
     // String saver guarantees that string is null-terminated.
@@ -5778,6 +5778,11 @@ collectFinalizerArgs(StringSaver &Saver, const GenXSubtarget &ST,
   for (const auto &Fos : FinalizerOpts)
     cl::TokenizeGNUCommandLine(Fos, Saver, Argv);
 
+  if (EnableKernelDebug) {
+    addArgument("-generateDebugInfo");
+    addArgument("-addKernelID");
+    addArgument("-setstartbp");
+  }
   if (AsmDumpsEnabled) {
     addArgument("-dumpcommonisa");
     addArgument("-output");
@@ -5802,6 +5807,7 @@ LLVMContext &GenXModule::getContext() {
 }
 
 static VISABuilder *createVISABuilder(const GenXSubtarget &ST,
+                                      const bool EnableKernelDebug,
                                       const bool AsmDumpsEnabled,
                                       vISABuilderMode Mode, WA_TABLE *WaTable,
                                       LLVMContext &Ctx,
@@ -5814,7 +5820,7 @@ static VISABuilder *createVISABuilder(const GenXSubtarget &ST,
   // Prepare array of arguments for Builder API.
   StringSaver Saver{Alloc};
   SmallVector<const char *, 8> Argv =
-      collectFinalizerArgs(Saver, ST, AsmDumpsEnabled);
+      collectFinalizerArgs(Saver, ST, EnableKernelDebug, AsmDumpsEnabled);
 
   if (PrintFinalizerOptions)
     dumpFinalizerArgs(Argv, ST.getCPU());
@@ -5831,8 +5837,8 @@ static VISABuilder *createVISABuilder(const GenXSubtarget &ST,
 void GenXModule::InitCISABuilder() {
   IGC_ASSERT(ST);
   const vISABuilderMode Mode = HasInlineAsm() ? vISA_ASM_WRITER : vISA_MEDIA;
-  CisaBuilder = createVISABuilder(*ST, AsmDumpsEnabled, Mode, WaTable,
-                                  getContext(), ArgStorage);
+  CisaBuilder = createVISABuilder(*ST, EnableKernelDebug, AsmDumpsEnabled, Mode,
+                                  WaTable, getContext(), ArgStorage);
 }
 
 VISABuilder *GenXModule::GetCisaBuilder() {
@@ -5850,8 +5856,9 @@ void GenXModule::DestroyCISABuilder() {
 
 void GenXModule::InitVISAAsmReader() {
   IGC_ASSERT(ST);
-  VISAAsmTextReader = createVISABuilder(*ST, AsmDumpsEnabled, vISA_ASM_READER,
-                                        WaTable, getContext(), ArgStorage);
+  VISAAsmTextReader =
+      createVISABuilder(*ST, EnableKernelDebug, AsmDumpsEnabled,
+                        vISA_ASM_READER, WaTable, getContext(), ArgStorage);
 }
 
 VISABuilder *GenXModule::GetVISAAsmReader() {

IGC/VectorCompiler/lib/GenXCodeGen/GenXDebugInfo.cpp

@@ -49,10 +49,6 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 using namespace llvm;
 
-static cl::opt<bool> GenerateDebugInfo(
-    "emit-debug-info", cl::init(false), cl::Hidden,
-    cl::desc("Generate DWARF debug info for each compiled kernel"));
-
 namespace {
 
 static void debugDump(const Twine &Name, const char *Content, size_t Size) {
@@ -282,7 +278,8 @@ void GenXDebugInfo::getAnalysisUsage(AnalysisUsage &AU) const {
 }
 bool GenXDebugInfo::runOnModule(Module &M) {
 
-  if (!GenerateDebugInfo)
+  const auto &BC = getAnalysis<GenXBackendConfig>();
+  if (!BC.kernelDebugEnabled())
     return false;
 
   const FunctionGroupAnalysis &FGA = getAnalysis<FunctionGroupAnalysis>();

IGC/VectorCompiler/lib/GenXCodeGen/GenXModule.cpp

@@ -110,6 +110,7 @@ bool GenXModule::runOnModule(Module &M) {
   // after runOnModule looks dangerous.
   const auto &BC = getAnalysis<GenXBackendConfig>();
   AsmDumpsEnabled = BC.asmDumpsEnabled();
+  EnableKernelDebug = BC.kernelDebugEnabled();
 
   InlineAsm = CheckForInlineAsm(M);
 

IGC/VectorCompiler/lib/GenXCodeGen/GenXModule.h

@@ -90,6 +90,7 @@ namespace llvm {
     // pointers without copying. Store all strings here.
     BumpPtrAllocator ArgStorage;
     bool AsmDumpsEnabled = false;
+    bool EnableKernelDebug = false;
 
     VISABuilder *CisaBuilder = nullptr;
     void InitCISABuilder();

IGC/VectorCompiler/lib/GenXCodeGen/GenXWrapper.cpp

@@ -426,6 +426,7 @@ static GenXBackendOptions createBackendOptions(const vc::CompileOptions &Opts) {
   GenXBackendOptions BackendOpts;
   if (Opts.StackMemSize)
     BackendOpts.StackSurfaceMaxSize = Opts.StackMemSize.getValue();
+  BackendOpts.EnableKernelDebug = Opts.EmitDebugInfo;
   BackendOpts.EnableAsmDumps = Opts.DumpAsm;
   BackendOpts.EnableDebugInfoDumps = Opts.DumpDebugInfo;
   BackendOpts.Dumper = Opts.Dumper.get();
@@ -598,6 +599,10 @@ Expected<vc::CompileOutput> vc::Compile(ArrayRef<char> Input,
   PerModulePasses.add(createGenXRestoreIntrAttrPass());
   PerModulePasses.run(M);
 
+  // Temporary measure till KernelArgOffset is moved to the backend
+  if (Opts.EmitDebugInfo)
+    M.getOrInsertNamedMetadata(llvm::genx::DebugMD::DebuggableKernels);
+
   Triple TheTriple = overrideTripleWithVC(M.getTargetTriple());
   M.setTargetTriple(TheTriple.getTriple());
 
@@ -703,6 +708,9 @@ static Error fillApiOptions(const opt::ArgList &ApiOptions,
   if (ApiOptions.hasArg(vc::options::OPT_no_vector_decomposition))
     Opts.NoVecDecomp = true;
 
+  if (ApiOptions.hasArg(vc::options::OPT_vc_emit_debug))
+    Opts.EmitDebugInfo = true;
+
   if (opt::Arg *A = ApiOptions.getLastArg(vc::options::OPT_optimize)) {
     StringRef Val = A->getValue();
     auto MaybeLevel = StringSwitch<Optional<vc::OptimizerLevel>>(Val)
@@ -832,14 +840,6 @@ composeLLVMArgs(const opt::InputArgList &ApiArgs,
     UpdatedArgs.AddSeparateArg(ApiArgs.getLastArg(OptID), LLVMOpt, WrappedOpts);
   }
 
-
-  if (opt::Arg *DbgArg = ApiArgs.getLastArg(vc::options::OPT_vc_emit_debug)) {
-
-    UpdatedArgs.AddSeparateArg(DbgArg, LLVMOpt,
-        "-finalizer-opts='-generateDebugInfo -addKernelID -setstartbp'");
-    UpdatedArgs.AddSeparateArg(DbgArg, LLVMOpt, "-emit-debug-info");
-  }
-
   if (opt::Arg *GTPinReRa = ApiArgs.getLastArg(vc::options::OPT_gtpin_rera)) {
     UpdatedArgs.AddSeparateArg(GTPinReRa, LLVMOpt,
                                "-finalizer-opts='-GTPinReRA'");