Enabled live analysis JSON from IGC

Added the ShaderDumpEnableIGAJSON option that adds IGA JSON output to
shader dumps. 1 enables the JSON output, 2 enables JSON with live
analysis.

Author: daniel-man

IGC/common/igc_flags.h

@@ -322,6 +322,7 @@ DECLARE_IGC_REGKEY(bool, QualityMetricsEnable,          false, "Enable Quality M
 DECLARE_IGC_REGKEY(bool, ShaderDumpEnable,              false, "dump LLVM IR, visaasm, and GenISA", true)
 DECLARE_IGC_REGKEY(bool, ShaderDumpEnableAll,           false, "dump all LLVM IR passes, visaasm, and GenISA", true)
 DECLARE_IGC_REGKEY(DWORD, ShaderDumpEnableG4,           false, "same as ShaderDumpEnable but adds G4 dumps (0 = off, 1 = some, 2 = all)", 0)
+DECLARE_IGC_REGKEY(DWORD, ShaderDumpEnableIGAJSON,      false, "adds IGA JSON output to shader dumps (0 = off, 1 = enabled, 2 = include def/use info but causes longer compile times)", 0)
 DECLARE_IGC_REGKEY(debugString, ShaderDumpFilter,       0,     "Only dump files matching the given regex", true)
 DECLARE_IGC_REGKEY(bool, ElfDumpEnable,                 false, "dump ELF file", true)
 DECLARE_IGC_REGKEY(bool, ElfTempDumpEnable,             false, "dump temporary ELF files", true)

visa/BinaryEncodingIGA.cpp

@@ -31,6 +31,7 @@ struct SendExDescOpts {
 class BinaryEncodingIGA
 {
     int                     IGAInstId = 0;
+    int                     IGABlockId = 0;
     Mem_Manager&            mem;
     G4_Kernel&              kernel;
     std::string             fileName; // .dat filename
@@ -188,6 +189,7 @@ class BinaryEncodingIGA
         if (itr == labelToBlockMap.end())
         {
             b = IGAKernel.createBlock();
+            b->setID(IGABlockId++);
             labelToBlockMap[label] = b;
         }
         else {
@@ -913,6 +915,7 @@ void BinaryEncodingIGA::Encode()
     {
         // create a new BB if kernel does not start with label
         currBB = IGAKernel->createBlock();
+        currBB->setID(IGABlockId++);
         IGAKernel->appendBlock(currBB);
     }
 
@@ -1049,7 +1052,11 @@ void BinaryEncodingIGA::EmitJSON(int dumpJSON) {
     std::ofstream ofs(jsonFileName, std::ofstream::out);
     FormatOpts fos(*platformModel);
     fos.printJson = true;
-    FormatJSON(ofs, fos, *IGAKernel, nullptr);
+    if (dumpJSON > 1) {
+        fos.printInstDefs = true;
+    }
+    iga::ErrorHandler eh;
+    FormatKernel(eh, ofs, fos, *IGAKernel);
 }
 
 Instruction *BinaryEncodingIGA::translateInstruction(
@@ -1256,6 +1263,7 @@ void BinaryEncodingIGA::translateInstructionBranchSrcs(
     {
         // Creating a fall through block
         bbNew = IGAKernel->createBlock();
+        bbNew->setID(IGABlockId++);
         igaInst->setLabelSource(SourceIndex::SRC0, bbNew, Type::UD);
         IGAKernel->appendBlock(bbNew);
     }

visa/iga/IGALibrary/Frontend/Formatter.cpp

@@ -1483,6 +1483,13 @@ void FormatKernel(
 {
     IGA_ASSERT(k.getModel().platform == opts.model.platform,
         "kernel and options must have same platform");
+    if (opts.printInstDefs && opts.liveAnalysis == nullptr) {
+        DepAnalysis la = ComputeDepAnalysis(&k);
+        FormatOpts optsCopy = opts;
+        optsCopy.liveAnalysis = &la;
+        FormatKernel(e, o, optsCopy, k, bits);
+        return;
+    }
     if (!opts.printJson) {
         Formatter f(e, o, opts);
         f.formatKernel(k, (const uint8_t *)bits);

visa/iga/IGALibrary/IR/DUAnalysis.cpp

@@ -609,7 +609,7 @@ struct BlockState
 struct DepAnalysisComputer
 {
     const Model                     &model;
-    Kernel                          *k;
+    const Kernel                    *k;
 
     // precomputed sources and destination sets indexed by instruction ID
     std::vector<RegSet>              instDstsUnion;
@@ -622,13 +622,14 @@ struct DepAnalysisComputer
     DepAnalysis                     &results;
 
     DepAnalysisComputer(
-        Kernel *_k,
+        const Kernel *_k,
         DepAnalysis &_results)
         : model(_k->getModel())
         , k(_k)
         , results(_results)
     {
         sanityCheckIR(k); // should nop in release
+        IGA_ASSERT(k->checkIdsUnique(), "call relabelIDs or setIDs; duplicates exist");
 
         results.deps.clear();
         results.liveIn.clear();
@@ -639,18 +640,15 @@ struct DepAnalysisComputer
 
         // we must do this so the vector doesn't resize
         blockState.reserve(k->getBlockList().size());
-        int bIx = 0, iIx = 0;
 
         // pre-assign ID's we know to be valid and
         // precompute instruction dependencies
         for (Block *b : k->getBlockList()) {
             blockState.emplace_back(b);
-            b->setID(bIx++);
 
             auto iitr = b->getInstList().begin();
             while (iitr != b->getInstList().end()) {
                 Instruction *i = *iitr;
-                i->setID(iIx++);
                 instSrcs.emplace_back(InstSrcs::compute(*i));
                 instDstsUnion.emplace_back(InstDsts::compute(*i).unionOf());
                 iitr++;
@@ -1109,7 +1107,7 @@ bool Dep::operator==(const Dep &p) const
 }
 
 
-DepAnalysis iga::ComputeDepAnalysis(Kernel *k)
+DepAnalysis iga::ComputeDepAnalysis(const Kernel *k)
 {
     DepAnalysis la;
 

visa/iga/IGALibrary/IR/DUAnalysis.hpp

@@ -102,7 +102,7 @@ namespace iga
 
     // The primary entry point for the live analysis
     // The counts are counts *going into* this instruction
-    DepAnalysis ComputeDepAnalysis(Kernel *k);
+    DepAnalysis ComputeDepAnalysis(const Kernel *k);
 } // namespace IGA
 
 #endif // _IGA_IR_ANALYSIS_HPP

visa/iga/IGALibrary/IR/Kernel.cpp

@@ -9,6 +9,8 @@ SPDX-License-Identifier: MIT
 #include "Kernel.hpp"
 #include "../IR/Messages.hpp"
 
+#include <set>
+
 using namespace iga;
 
 Kernel::Kernel(const Model &model)
@@ -31,6 +33,39 @@ Kernel::~Kernel()
     }
 }
 
+void Kernel::resetIds()
+{
+    // algorithm to set the IDs
+    int blockIndex = 0, instIndex  = 0;
+    for (Block *b : getBlockList()) {
+        b->setID(blockIndex++);
+        for (Instruction *i : b->getInstList()) {
+            i->setID(instIndex++);
+        }
+    }
+}
+
+bool Kernel::checkIdsUnique() const
+{
+    // check to make sure no duplicate IDs
+    std::set<int> instIds, blockIds;
+    for (const Block *b : getBlockList()) {
+        int blockId = b->getID();
+        if (blockIds.count(blockId) > 0) {
+            return false;
+        }
+        blockIds.insert(blockId);
+        for (const Instruction *i : b->getInstList()) {
+            int instId = i->getID();
+            if (instIds.count(instId) > 0) {
+                return false;
+            }
+            instIds.insert(instId);
+        }
+    }
+    return true;
+}
+
 size_t Kernel::getInstructionCount() const
 {
     size_t n = 0;

visa/iga/IGALibrary/IR/Kernel.hpp

@@ -35,6 +35,9 @@ namespace iga {
         Kernel(const Kernel &) = delete;
         Kernel& operator=(const Kernel&) = delete;
 
+        void              resetIds();
+        bool              checkIdsUnique() const;
+
         MemManager&       getMemManager() { return m_mem; }
         const Model&      getModel() const { return m_model; }
         const BlockList&  getBlockList() const { return m_blocks; }

visa/iga/IGALibrary/api/iga.cpp

@@ -526,10 +526,11 @@ class IGAContext {
             // we succeeded in decoding; now format the output to text
             std::stringstream ss;
             FormatOpts fopts = formatterOpts(dopts, formatLbl, formatLblEnv);
-            DepAnalysis la;
             if (dopts.formatting_opts & IGA_FORMATTING_OPT_PRINT_DEFS) {
-                la = ComputeDepAnalysis(k);
-                fopts.liveAnalysis = &la;
+                // Set the IDs here (kernel helper function)
+                k->resetIds();
+                // set fopts.printInstDefs
+                fopts.printInstDefs = true;
             }
             FormatKernel(errHandler, ss, fopts, *k, bits);