Add asm dump options to VC

Add DumpAsm option to wrapper to enable finalizer dumps.
Enable these dumps with -dump-asm or -mdump_asm internal
options or ShaderDumpEnable igc flag.

Change-Id: Iab43fc65da709e855ee41835703a1f14d0aba200

Author: aus-intel

IGC/AdaptorOCL/dllInterfaceCompute.cpp

@@ -1438,6 +1438,7 @@ static void adjustDumpOptions(vc::CompileOptions& Opts)
     {
         Opts.DumpIR = true;
         Opts.DumpIsa = true;
+        Opts.DumpAsm = true;
     }
 }
 

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

@@ -162,6 +162,7 @@ struct CompileOptions {
   BinaryKind Binary = BinaryKind::OpenCL;
   bool DumpIsa = false;
   bool DumpIR = false;
+  bool DumpAsm = false;
   bool TimePasses = false;
 };
 

IGC/VectorCompiler/include/vc/Support/Options.td

@@ -115,6 +115,10 @@ def dump_llvm_ir : Flag<["-"], "dump-llvm-ir">,
   HelpText<"Dump llvm IR after SPIRV reading, optimizations and codegen">;
 def dump_isa_binary : Flag<["-"], "dump-isa-binary">,
   HelpText<"Dump isa binary after finalization pass">;
+def dump_asm : Flag<["-"], "dump-asm">,
+  HelpText<"Dump assembly (visaasm, asm, etc.)">;
+def mdump_asm : Flag<["-"], "mdump_asm">,
+  Alias<dump_asm>, HelpText<"Alias for -dump-asm">;
 
 def help : Flag<["-"], "help">,
   HelpText<"Display available API options">;

IGC/VectorCompiler/lib/GenXCodeGen/GenXBackendConfig.cpp

@@ -46,6 +46,11 @@ static cl::opt<unsigned> StackMemSizeOpt("stack-mem-size",
                                          cl::desc("Available space for stack"),
                                          cl::init(8 * 1024));
 
+static cl::opt<bool>
+    EnableAsmDumpsOpt("genx-enable-asm-dumps",
+                      cl::desc("Enable finalizer assembly dumps"),
+                      cl::init(false));
+
 //===----------------------------------------------------------------------===//
 //
 // Backend config related stuff.
@@ -54,7 +59,8 @@ static cl::opt<unsigned> StackMemSizeOpt("stack-mem-size",
 char GenXBackendConfig::ID = 0;
 
 GenXBackendOptions::GenXBackendOptions()
-    : DumpRegAlloc(DumpRegAllocOpt), StackSurfaceMaxSize(StackMemSizeOpt) {}
+    : DumpRegAlloc(DumpRegAllocOpt), StackSurfaceMaxSize(StackMemSizeOpt),
+      EnableAsmDumps(EnableAsmDumpsOpt) {}
 
 GenXBackendConfig::GenXBackendConfig() : ImmutablePass(ID) {
   initializeGenXBackendConfigPass(*PassRegistry::getPassRegistry());

IGC/VectorCompiler/lib/GenXCodeGen/GenXBackendConfig.h

@@ -67,6 +67,9 @@ struct GenXBackendOptions {
   // Non-owning pointer to abstract shader dumper for debug dumps.
   vc::ShaderDumper *Dumper = nullptr;
 
+  // Whether to enable finalizer dumps.
+  bool EnableAsmDumps;
+
   GenXBackendOptions();
 };
 
@@ -114,6 +117,8 @@ class GenXBackendConfig : public ImmutablePass {
                        "Attempt to query not installed dumper");
     return *Options.Dumper;
   }
+
+  bool asmDumpsEnabled() const { return Options.EnableAsmDumps; }
 };
 } // namespace llvm
 

IGC/VectorCompiler/lib/GenXCodeGen/GenXCisaBuilder.cpp

@@ -5688,7 +5688,8 @@ ModulePass *llvm::createGenXFinalizerPass(raw_pwrite_stream &o) {
 }
 
 static SmallVector<const char *, 8>
-collectFinalizerArgs(StringSaver &Saver, const GenXSubtarget &ST) {
+collectFinalizerArgs(StringSaver &Saver, const GenXSubtarget &ST,
+                     const bool AsmDumpsEnabled) {
   SmallVector<const char *, 8> Argv;
   auto addArgument = [&Argv, &Saver](StringRef Arg) {
     // String saver guarantees that string is null-terminated.
@@ -5698,6 +5699,12 @@ collectFinalizerArgs(StringSaver &Saver, const GenXSubtarget &ST) {
   addArgument("-dumpvisa");
   for (const auto &Fos : FinalizerOpts)
     cl::TokenizeGNUCommandLine(Fos, Saver, Argv);
+
+  if (AsmDumpsEnabled) {
+    addArgument("-dumpcommonisa");
+    addArgument("-output");
+    addArgument("-binary");
+  }
   return Argv;
 }
 
@@ -5717,6 +5724,7 @@ LLVMContext &GenXModule::getContext() {
 }
 
 static VISABuilder *createVISABuilder(const GenXSubtarget &ST,
+                                      const bool AsmDumpsEnabled,
                                       vISABuilderMode Mode, WA_TABLE *WaTable,
                                       LLVMContext &Ctx,
                                       BumpPtrAllocator &Alloc) {
@@ -5727,7 +5735,8 @@ static VISABuilder *createVISABuilder(const GenXSubtarget &ST,
 
   // Prepare array of arguments for Builder API.
   StringSaver Saver{Alloc};
-  SmallVector<const char *, 8> Argv = collectFinalizerArgs(Saver, ST);
+  SmallVector<const char *, 8> Argv =
+      collectFinalizerArgs(Saver, ST, AsmDumpsEnabled);
 
   if (PrintFinalizerOptions)
     dumpFinalizerArgs(Argv, ST.getCPU());
@@ -5744,7 +5753,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, Mode, WaTable, getContext(), ArgStorage);
+  CisaBuilder = createVISABuilder(*ST, AsmDumpsEnabled, Mode, WaTable,
+                                  getContext(), ArgStorage);
 }
 
 VISABuilder *GenXModule::GetCisaBuilder() {
@@ -5762,8 +5772,8 @@ void GenXModule::DestroyCISABuilder() {
 
 void GenXModule::InitVISAAsmReader() {
   IGC_ASSERT(ST);
-  VISAAsmTextReader = createVISABuilder(*ST, vISA_ASM_READER, WaTable,
-                                        getContext(), ArgStorage);
+  VISAAsmTextReader = createVISABuilder(*ST, AsmDumpsEnabled, vISA_ASM_READER,
+                                        WaTable, getContext(), ArgStorage);
 }
 
 VISABuilder *GenXModule::GetVISAAsmReader() {

IGC/VectorCompiler/lib/GenXCodeGen/GenXModule.cpp

@@ -32,11 +32,14 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #define DEBUG_TYPE "GENX_MODULE"
 
 #include "GenXModule.h"
+
 #include "FunctionGroup.h"
 #include "GenX.h"
+#include "GenXBackendConfig.h"
 #include "GenXSubtarget.h"
 #include "GenXTargetMachine.h"
 #include "GenXWATable.h"
+
 #include "llvm/CodeGen/TargetPassConfig.h"
 #include "llvm/GenXIntrinsics/GenXMetadata.h"
 #include "llvm/IR/Function.h"
@@ -53,6 +56,7 @@ char GenXModule::ID = 0;
 INITIALIZE_PASS_BEGIN(GenXModule, "GenXModule", "GenXModule", false,
                       true /*analysis*/)
 INITIALIZE_PASS_DEPENDENCY(FunctionGroupAnalysis)
+INITIALIZE_PASS_DEPENDENCY(GenXBackendConfig)
 INITIALIZE_PASS_DEPENDENCY(GenXWATable)
 INITIALIZE_PASS_END(GenXModule, "GenXModule", "GenXModule", false,
                     true /*analysis*/)
@@ -64,6 +68,7 @@ ModulePass *llvm::createGenXModulePass() {
 
 void GenXModule::getAnalysisUsage(AnalysisUsage &AU) const {
   AU.addRequired<FunctionGroupAnalysis>();
+  AU.addRequired<GenXBackendConfig>();
   AU.addRequired<GenXWATable>();
   AU.addRequired<TargetPassConfig>();
   AU.setPreservesAll();
@@ -99,6 +104,11 @@ bool GenXModule::runOnModule(Module &M) {
   WaTable = getAnalysis<GenXWATable>().getWATable();
   Ctx = &M.getContext();
 
+  // Remember required config variables here. Getting other analysis
+  // after runOnModule looks dangerous.
+  const auto &BC = getAnalysis<GenXBackendConfig>();
+  AsmDumpsEnabled = BC.asmDumpsEnabled();
+
   InlineAsm = CheckForInlineAsm(M);
 
   // Iterate, processing each Function that is not yet assigned to a

IGC/VectorCompiler/lib/GenXCodeGen/GenXModule.h

@@ -89,6 +89,7 @@ namespace llvm {
     // Visa option parser contains code that just stores c-strings as
     // pointers without copying. Store all strings here.
     BumpPtrAllocator ArgStorage;
+    bool AsmDumpsEnabled = false;
 
     VISABuilder *CisaBuilder = nullptr;
     void InitCISABuilder();

IGC/VectorCompiler/lib/GenXCodeGen/GenXWrapper.cpp

@@ -349,6 +349,7 @@ static GenXBackendOptions createBackendOptions(const vc::CompileOptions &Opts) {
   GenXBackendOptions BackendOpts;
   if (Opts.StackMemSize)
     BackendOpts.StackSurfaceMaxSize = Opts.StackMemSize.getValue();
+  BackendOpts.EnableAsmDumps = Opts.DumpAsm;
   BackendOpts.Dumper = Opts.Dumper.get();
   return BackendOpts;
 }
@@ -649,6 +650,8 @@ static Error fillInternalOptions(const opt::ArgList &InternalOptions,
     Opts.DumpIsa = true;
   if (InternalOptions.hasArg(vc::options::OPT_dump_llvm_ir))
     Opts.DumpIR = true;
+  if (InternalOptions.hasArg(vc::options::OPT_dump_asm))
+    Opts.DumpAsm = true;
   if (InternalOptions.hasArg(vc::options::OPT_ftime_report))
     Opts.TimePasses = true;