Use ZEBinary relocation tables instead of legacy types

Removed definitions of old relocation table types (m_funcRelocationTable).
Changed usages of relocation tables to use the ZEBinary type (m_relocs).

Author: michalkr52

IGC/Compiler/CISACodeGen/CISABuilder.cpp

@@ -5128,21 +5128,7 @@ void CEncoder::CreateGlobalHostAccessTable(SOpenCLProgramInfo::ZEBinGlobalHostAc
     globalHostAccessTable.push_back(vISA::ZEHostAccessEntry{I.device_name, I.host_name});
 }
 
-void CEncoder::CreateRelocationTable(VISAKernel *pMainKernel, void *&buffer, unsigned &bufferSize,
-                                     unsigned &tableEntries) {
-  // for patch-token-based binary format
-  buffer = nullptr;
-  bufferSize = 0;
-  tableEntries = 0;
-
-  // vISA will directly return the buffer with GenRelocEntry layout
-  IGC_ASSERT(nullptr != pMainKernel);
-  V(pMainKernel->GetGenRelocEntryBuffer(buffer, bufferSize, tableEntries));
-  IGC_ASSERT((sizeof(vISA::GenRelocEntry) * tableEntries) == bufferSize);
-}
-
 void CEncoder::CreateRelocationTable(VISAKernel *pMainKernel, SProgramOutput::RelocListTy &relocations) {
-  // for ZEBinary format
   IGC_ASSERT(nullptr != pMainKernel);
   V(pMainKernel->GetRelocations(relocations));
 }
@@ -5750,25 +5736,20 @@ uint32_t CEncoder::getSpillMemSizeWithFG(const llvm::Function &curFunc, uint32_t
 void CEncoder::createRelocationTables(VISAKernel &pMainKernel) {
   CodeGenContext *context = m_program->GetContext();
   SProgramOutput *pOutput = m_program->ProgramOutput();
-  bool ZEBinEnabled = context->enableZEBinary();
-  if (ZEBinEnabled) {
-    CreateRelocationTable(&pMainKernel, pOutput->m_relocs);
+  CreateRelocationTable(&pMainKernel, pOutput->m_relocs);
+  if (context->type == ShaderType::OPENCL_SHADER) {
     for (const auto &reloc : pOutput->m_relocs) {
       if (reloc.r_symbol == vISA::CROSS_THREAD_OFF_R0_RELOCATION_NAME) {
-        IGC_ASSERT(context->type == ShaderType::OPENCL_SHADER);
         auto cl_context = static_cast<OpenCLProgramContext *>(context);
         cl_context->m_programInfo.m_hasCrossThreadOffsetRelocations = true;
       } else if (reloc.r_symbol == vISA::PER_THREAD_OFF_RELOCATION_NAME) {
-        IGC_ASSERT(context->type == ShaderType::OPENCL_SHADER);
         auto cl_context = static_cast<OpenCLProgramContext *>(context);
         cl_context->m_programInfo.m_hasPerThreadOffsetRelocations = true;
       }
     }
-  } else {
-    CreateRelocationTable(&pMainKernel, pOutput->m_funcRelocationTable, pOutput->m_funcRelocationTableSize,
-                          pOutput->m_funcRelocationTableEntries);
   }
 }
+
 const vISA::KernelCostInfo *CEncoder::createKernelCostInfo(VISAKernel &pMainKernel) {
   CodeGenContext *context = m_program->GetContext();
   IGC_ASSERT(context->enableZEBinary());

IGC/Compiler/CISACodeGen/CISABuilder.hpp

@@ -522,10 +522,9 @@ class CEncoder {
   // save compile time by avoiding retry if the amount of spill is (very) small
   bool AvoidRetryOnSmallSpill() const;
 
-  // CreateSymbolTable, CreateRelocationTable and CreateFuncAttributeTable will
-  // create symbols, relococations and FuncAttributes in two formats. One in
-  // given buffer that will be later parsed as patch token based format, another
-  // as struct type that will be parsed as ZE binary format
+  // CreateSymbolTable will create symbols in two formats. One in given buffer that will be
+  // later parsed as patch token based format, another as struct type that will be parsed
+  // as ZE binary format
 
   // CreateSymbolTable
   // Note that this function should be called only once even if there are
@@ -543,10 +542,6 @@ class CEncoder {
   void CreateLocalSymbol(const std::string &kernelName, vISA::GenSymType type, unsigned offset, unsigned size,
                          SProgramOutput::ZEBinFuncSymbolTable &symbols);
 
-  // CreateRelocationTable
-  // input/output: buffer, bufferSize, tableEntries: for patch-token-based
-  // format.
-  void CreateRelocationTable(VISAKernel *pMainKernel, void *&buffer, unsigned &bufferSize, unsigned &tableEntries);
   // input/output: relocations: for ZEBinary foramt
   void CreateRelocationTable(VISAKernel *pMainKernel, SProgramOutput::RelocListTy &relocations);
 

IGC/Compiler/CISACodeGen/EmitVISAPass.cpp

@@ -19277,7 +19277,12 @@ void IGC::EmitPass::emitCanonicalize(llvm::Instruction *inst, const DstModifier
 }
 
 void IGC::EmitPass::emitStaticConstantPatchValue(llvm::StaticConstantPatchIntrinsic *staticConstantPatch32) {
-  std::string patchName = staticConstantPatch32->getPatchName().str();
+  llvm::StringRef nameRef = staticConstantPatch32->getPatchName();
+  // Drop null-terminator if present, it shouldn't be included in std::strings.
+  if (!nameRef.empty() && nameRef.back() == '\0') {
+    nameRef = nameRef.drop_back();
+  }
+  std::string patchName = nameRef.str();
   m_encoder->AddVISASymbol(patchName, m_destination);
 }
 

IGC/Compiler/CodeGenPublic.h

@@ -137,10 +137,7 @@ struct SProgramOutput {
   unsigned int m_funcSymbolTableSize = 0;
   unsigned int m_funcSymbolTableEntries = 0;
   ZEBinFuncSymbolTable m_symbols; // duplicated information of m_funcSymbolTable, for zebin
-  void *m_funcRelocationTable = nullptr;
-  unsigned int m_funcRelocationTableSize = 0;
-  unsigned int m_funcRelocationTableEntries = 0;
-  RelocListTy m_relocs; // duplicated information of m_funcRelocationTable, for zebin
+  RelocListTy m_relocs;
   FuncAttrListTy m_funcAttrs;
   void *m_globalHostAccessTable = nullptr;
   unsigned int m_globalHostAccessTableSize = 0;
@@ -182,9 +179,6 @@ struct SProgramOutput {
     if (m_funcSymbolTable) {
       free(m_funcSymbolTable);
     }
-    if (m_funcRelocationTable) {
-      free(m_funcRelocationTable);
-    }
     if (m_globalHostAccessTable) {
       free(m_globalHostAccessTable);
     }

IGC/VectorCompiler/igcdeps/src/cmc.cpp

@@ -363,10 +363,6 @@ void CMKernel::RecomputeBTLayout(int numUAVs, int numResources) {
 
 static void setFuncSectionInfo(const GenXOCLRuntimeInfo::KernelInfo &Info,
                                IGC::SProgramOutput &KernelProgram) {
-  KernelProgram.m_funcRelocationTable = Info.LegacyFuncRelocations.Buffer;
-  KernelProgram.m_funcRelocationTableSize = Info.LegacyFuncRelocations.Size;
-  KernelProgram.m_funcRelocationTableEntries =
-      Info.LegacyFuncRelocations.Entries;
   KernelProgram.m_relocs = Info.Func.Relocations;
 
   vc::validateFunctionSymbolTable(Info.Func.Symbols);

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

@@ -121,13 +121,7 @@ class GenXOCLRuntimeInfo : public ModulePass {
     }
   };
 
-  struct TableInfo {
-    void *Buffer = nullptr;
-    unsigned Size = 0;
-    unsigned Entries = 0;
-  };
-
-  // Symbols and reloacations are collected in zebin format. Later they are
+  // Symbols and relocations are collected in zebin format. Later symbols are
   // translated into legacy format for patch token generation.
   using SymbolSeq = std::vector<vISA::ZESymEntry>;
   using RelocationSeq = std::vector<vISA::ZERelocEntry>;
@@ -204,9 +198,6 @@ class GenXOCLRuntimeInfo : public ModulePass {
   // but still required for runtime.
   struct KernelInfo {
     SectionInfo Func;
-    // Duplicates Func.Relocations. Cannot unify it on VC side since the
-    // duplication happens on Finalizer side.
-    TableInfo LegacyFuncRelocations;
 
     // Keeps in the first element name of the FG's head and VISA asm for this FG
     // in the second element.

IGC/VectorCompiler/lib/GenXCodeGen/GenXOCLRuntimeInfo.cpp

@@ -917,11 +917,6 @@ RuntimeInfoCollector::collectFunctionGroupInfo(const FunctionGroup &FG) const {
   auto DebugData = getDebugInformation(DBG, KernelFunction);
 
   Info.Func.Relocations = TextSection.Relocations;
-  // Still have to duplicate function relocations because they are constructed
-  // inside Finalizer.
-  CISA_CALL(VK->GetGenRelocEntryBuffer(Info.LegacyFuncRelocations.Buffer,
-                                       Info.LegacyFuncRelocations.Size,
-                                       Info.LegacyFuncRelocations.Entries));
   Info.Func.Symbols =
       constructFunctionSymbols(TextSection.Data, /*HasKernel=*/true);
 

visa/Optimizer.cpp

@@ -8476,7 +8476,7 @@ void Optimizer::changeMoveType() {
       // new src0 and overwrite the original RelocImm While this optimization
       // should still be able to apply to RelocImm. Once we turn on this
       // optimization for RelocImm, we should update assert in
-      // VISAKernelImpl::GetGenRelocEntryBuffer to allow float type
+      // VISAKernelImpl::GetRelocations to allow float type
       if (src0->isRelocImm())
         continue;
 

visa/VISAKernel.h

@@ -1032,14 +1032,7 @@ class VISAKernelImpl : public VISAFunction {
   VISA_BUILDER_API int GetErrorMessage(const char *&errorMsg) const override;
   VISA_BUILDER_API virtual int
   GetGenxDebugInfo(void *&buffer, unsigned int &size) const override;
-  /// GetGenRelocEntryBuffer -- allocate and return a buffer of all
-  /// GenRelocEntry that are created by vISA
-  VISA_BUILDER_API int
-  GetGenRelocEntryBuffer(void *&buffer, unsigned int &byteSize,
-                         unsigned int &numEntries) override;
   /// GetRelocations -- add vISA created relocations into given relocation list
-  /// This get the same information as GetGenRelocEntryBuffer, but in different
-  /// foramt
   VISA_BUILDER_API int GetRelocations(RelocListType &relocs) override;
   VISA_BUILDER_API int GetGTPinBuffer(void *&buffer, unsigned int &size,
                                       unsigned int scratchOffset) override;

visa/VISAKernelImpl.cpp

@@ -8754,53 +8754,12 @@ int VISAKernelImpl::GetRelocations(RelocListType &relocs) {
         static_cast<uint32_t>(genOffset + reloc.getTargetOffset(*m_builder));
     relocs.emplace_back(reloc.getType(), offset, reloc.getSymbolName());
 
-    vASSERT((genOffset != UNDEFINED_GEN_OFFSET) && (offset > genOffset) &&
-           (offset < genOffset + BYTES_PER_INST));
+    vASSERT((genOffset != UNDEFINED_GEN_OFFSET) && (offset >= genOffset) &&
+            (offset < genOffset + BYTES_PER_INST));
   }
   return VISA_SUCCESS;
 }
 
-int VISAKernelImpl::GetGenRelocEntryBuffer(void *&buffer,
-                                           unsigned int &byteSize,
-                                           unsigned int &numEntries) {
-  G4_Kernel::RelocationTableTy &reloc_table = m_kernel->getRelocationTable();
-  numEntries = reloc_table.size();
-  byteSize = sizeof(GenRelocEntry) * numEntries;
-
-  if (reloc_table.empty())
-    return VISA_SUCCESS;
-
-  // allocate the buffer for relocation table
-  buffer = allocCodeBlock(byteSize);
-
-  if (buffer == nullptr)
-    return VISA_FAILURE;
-
-  GenRelocEntry *buffer_p = (GenRelocEntry *)buffer;
-  for (const auto &reloc : reloc_table) {
-    auto inst = reloc.getInst();
-    buffer_p->r_type = reloc.getType();
-    buffer_p->r_offset = static_cast<uint32_t>(inst->getGenOffset()) +
-                         reloc.getTargetOffset(*m_builder);
-
-    vISA_ASSERT((buffer_p->r_offset >= inst->getGenOffset()) &&
-           (buffer_p->r_offset < inst->getGenOffset() + BYTES_PER_INST),
-            "Invalid relocation offset returned, offset must be within"
-            "the ISA instruction");
-
-    vISA_ASSERT(reloc.getSymbolName().size() <= MAX_SYMBOL_NAME_LENGTH,
-        "Relocation symbol name longer than MAX_SYMBOL_NAME_LENGTH");
-
-    // clean the buffer first
-    memset(buffer_p->r_symbol, 0, MAX_SYMBOL_NAME_LENGTH);
-    strcpy_s(buffer_p->r_symbol, MAX_SYMBOL_NAME_LENGTH,
-             reloc.getSymbolName().c_str());
-    ++buffer_p;
-  }
-
-  return VISA_SUCCESS;
-}
-
 int VISAKernelImpl::GetGenxDebugInfo(void *&buffer, unsigned int &size) const {
   buffer = m_genx_debug_info_buffer;
   size = m_genx_debug_info_size;