Add vISA verifier when CISA instructions are created

Verify vISA instructions when they are created (CISA instructions).
Today the verification is done at the end of the compilation.

Author: jfuentes

visa/BuildCISAIRImpl.cpp

@@ -2126,7 +2126,7 @@ int CISA_IR_Builder::verifyVISAIR()
 
         VISAKernel_format_provider fmt(fmtKernel);
 
-        vISAVerifier verifier(m_header, &fmt, getOptions());
+        vISAVerifier verifier(m_header, &fmt, getOptions(), fmtKernel->getIRBuilder());
         verifier.run(kTemp);
 
         if (verifier.hasErrors())

visa/Common_ISA_framework.cpp

@@ -36,7 +36,8 @@ int CisaInst::createCisaInstruction(
     PredicateOpnd pred,
     VISA_opnd** opnd,
     int numOpnds,
-    const VISA_INST_Desc* inst_desc)
+    const VISA_INST_Desc* inst_desc,
+    vISAVerifier* verifier)
 {
     uint8_t subOpcode = 0;
     bool hasSubOpcode = false;
@@ -126,6 +127,16 @@ int CisaInst::createCisaInstruction(
         m_size += opnd[i]->size;
     }
 
+#if defined(_DEBUG) || defined(_INTERNAL)
+    if (verifier) {
+        verifier->verifyInstruction(&m_cisa_instruction);
+        if (verifier->hasErrors()) {
+            std::cerr << verifier->getLastErrorFound().value_or("");
+            return VISA_FAILURE;
+        }
+    }
+#endif
+
     return VISA_SUCCESS;
 }
 

visa/Common_ISA_framework.h

@@ -22,6 +22,7 @@ SPDX-License-Identifier: MIT
 #include "visa_igc_common_header.h"
 #include "IsaDescription.h"
 #include "Mem_Manager.h"
+#include "IsaVerification.h"
 
 #define CISA_INVALID_ADDR_ID     -1
 #define CISA_INVALID_PRED_ID     -1
@@ -81,7 +82,7 @@ class CisaInst
     CISA_INST             m_cisa_instruction;
     const VISA_INST_Desc* m_inst_desc;
 
-    int createCisaInstruction(ISA_Opcode opcode, unsigned char exec_size, unsigned char modifier, PredicateOpnd pred, VISA_opnd **opnd, int numOpnds, const VISA_INST_Desc* inst_desc);
+    int createCisaInstruction(ISA_Opcode opcode, unsigned char exec_size, unsigned char modifier, PredicateOpnd pred, VISA_opnd **opnd, int numOpnds, const VISA_INST_Desc* inst_desc, vISAVerifier* verifier = nullptr);
 
     int getSize() const {return m_size;}
 

visa/IsaVerification.h

@@ -26,6 +26,7 @@ class vISAVerifier
     const common_isa_header& isaHeader;
     const print_format_provider_t* header;
     Options* options;
+    const vISA::IR_Builder* irBuilder = nullptr;  // for capability check
 
     std::vector<std::string> kerror_list;
     std::vector<std::string> error_list;
@@ -34,26 +35,31 @@ class vISAVerifier
     // false -- a label is used in the kernel but not yet defined
     std::map<int, bool> labelDefs;
 
-    const vISA::IR_Builder* irBuilder = nullptr;  // for capability check
 
 public:
 
-    vISAVerifier(const common_isa_header& vISAHeader, const print_format_provider_t* kernelHeader, Options* opt) :
-    isaHeader(vISAHeader), header(kernelHeader), options(opt) {}
+    vISAVerifier(const common_isa_header& vISAHeader, const print_format_provider_t* kernelHeader, Options* opt, const vISA::IR_Builder* ir_Builder) :
+    isaHeader(vISAHeader), header(kernelHeader), options(opt), irBuilder(ir_Builder) {}
 
     virtual ~vISAVerifier() = default;
 
     void run(VISAKernelImpl* kernel);
 
+    void verifyInstruction(const CISA_INST* inst);
+
     bool hasErrors() const { return kerror_list.size() + error_list.size() > 0; }
     size_t getNumErrors() const { return kerror_list.size() + error_list.size(); }
 
     void writeReport(const char* filename);
 
+    std::optional<std::string> getLastErrorFound() const {
+        if (error_list.empty()) return std::nullopt;
+        return error_list.back();
+    }
+
  private:
 
      void verifyKernelHeader();
-     void verifyInstruction(const CISA_INST* inst);
 
      // checks that can only be done once the whole kernel is processed.
      void finalize();

visa/VISAKernel.h

@@ -18,6 +18,7 @@ SPDX-License-Identifier: MIT
 //#include "G4_IR.hpp"  // for PhyRegPool
 #include "Attributes.hpp"
 #include "CompilerStats.h"
+#include "IsaVerification.h"
 
 #include <list>
 #include <map>
@@ -34,8 +35,11 @@ namespace vISA
 class G4_Kernel;
 class DebugInfoFormat;
 class BinaryEncodingBase;
+
 }
 
+class VISAKernel_format_provider;
+
 // Class hierarchy is as follows:
 // VISAKernel -> Abstract class that declares virtual functions to build a kernel object
 // VISAFunction : VISAKernel -> Abstract class that declares function specific APIs
@@ -1212,6 +1216,10 @@ class VISAKernelImpl : public VISAFunction
 
     // Shared with G4_kernel
     vISA::Attributes* m_kernelAttrs;
+
+    // Instruction verifier that checks CISA instruction creation
+    VISAKernel_format_provider* fmt;
+    vISAVerifier* verifier;
 };
 
 class VISAKernel_format_provider : public print_format_provider_t

visa/VISAKernelImpl.cpp

@@ -814,6 +814,9 @@ int VISAKernelImpl::InitializeKernel(const char *kernel_name)
 
     CISABuildPreDefinedDecls();
 
+    fmt = new VISAKernel_format_provider(this);
+    verifier = new vISAVerifier(m_CISABuilder->m_header, fmt, m_options, m_builder);
+
     return status;
 }
 
@@ -8529,8 +8532,8 @@ VISA_BUILDER_API int VISAKernelImpl::AppendVISALscFence(
         unsigned size = EXEC_SIZE_1;
         PACK_EXEC_SIZE(size, vISA_EMASK_M1_NM);
 
-        inst->createCisaInstruction(
-            ISA_LSC_FENCE, (uint8_t)size, 0, PredicateOpnd::getNullPred(), opnds, numOpnds, instDesc);
+        status = inst->createCisaInstruction(
+            ISA_LSC_FENCE, (uint8_t)size, 0, PredicateOpnd::getNullPred(), opnds, numOpnds, instDesc, verifier);
         addInstructionToEnd(inst);
     }
 
@@ -9035,6 +9038,9 @@ VISAKernelImpl::~VISAKernelImpl()
     }
 
     destroyKernelAttributes();
+
+    delete fmt;
+    delete verifier;
 }
 
 int VISAKernelImpl::GetGenxBinary(void *&buffer, int &size) const