Replace invalid symbols in function names generated by llvm

Replace '.', '$' symbols with '_'

Author: KorovinVlad

IGC/VectorCompiler/lib/GenXCodeGen/CMakeLists.txt

@@ -84,6 +84,7 @@ set(CODEGEN_SOURCES
   OCLRuntimeInfoPrinter.cpp
   GenXStructSplitter.cpp
   GenXDebugLegalization.cpp
+  GenXFixInvalidFuncName.cpp
 )
 
 add_library(VCCodeGen ${CODEGEN_SOURCES})

IGC/VectorCompiler/lib/GenXCodeGen/GenX.h

@@ -118,6 +118,7 @@ ModulePass *createGenXStackUsagePass();
 ModulePass *createGenXStructSplitterPass();
 FunctionPass *createGenXPredRegionLoweringPass();
 FunctionPass *createGenXDebugLegalizationPass();
+FunctionPass *createGenXFixInvalidFuncNamePass();
 
 namespace genx {
 

IGC/VectorCompiler/lib/GenXCodeGen/GenXFixInvalidFuncName.cpp

@@ -0,0 +1,95 @@
+/*========================== begin_copyright_notice ============================
+
+Copyright (C) 2022 Intel Corporation
+
+SPDX-License-Identifier: MIT
+
+============================= end_copyright_notice ===========================*/
+
+//
+/// GenXFixInvalidFuncName
+/// ------------
+///
+/// GenXFixInvalidFuncName is a function pass that replaces all '.' and '$'
+/// characters with '_' in function names generated by llvm in all call
+/// instructions in the current function and in the name of the current function.
+/// It needs to be kept in sync with the same pass on the SPMD side.
+///
+//===----------------------------------------------------------------------===//
+
+#include "GenX.h"
+
+#include "llvm/IR/Function.h"
+#include "llvm/InitializePasses.h"
+#include "llvm/Pass.h"
+#include "llvm/Support/Debug.h"
+
+#define DEBUG_TYPE "GENX_FIX_INVALID_FUNC_NAMES"
+
+using namespace llvm;
+
+class GenXFixInvalidFuncName : public FunctionPass
+{
+public:
+  static char ID;
+  explicit GenXFixInvalidFuncName() : FunctionPass(ID) {}
+  llvm::StringRef getPassName() const override { return "Fix Invalid Func Name"; }
+  bool runOnFunction(Function& F) override;
+private:
+  std::string replaceInvalidCharToUnderline(std::string str);
+  bool isSupportedCallingConv(CallingConv::ID callingConv);
+  bool changeFuncName(Function& F);
+};
+
+bool GenXFixInvalidFuncName::runOnFunction(Function& F) {
+  bool modified = false;
+  if(isSupportedCallingConv(F.getCallingConv())) {
+    modified = changeFuncName(F);
+  }
+  for (Function::iterator fi = F.begin(), fe = F.end(); fi != fe; ++fi) {
+    BasicBlock *BB = &*fi;
+    for (BasicBlock::iterator bi = BB->begin(), be = BB->end(); bi != be; ++bi) {
+      Instruction *Inst = &*bi;
+      if (CallInst* callInst = dyn_cast<CallInst>(Inst)) {
+        if (isSupportedCallingConv(callInst->getCallingConv())) {
+          Function* func = callInst->getCalledFunction();
+          if (func) {
+            modified = changeFuncName(*func);
+          }
+        }
+      }
+    }
+  }
+  return modified;
+}
+
+std::string GenXFixInvalidFuncName::replaceInvalidCharToUnderline(std::string str) {
+  std::replace_if(str.begin(), str.end(), [](const char c){ return c == '.' || c == '$'; }, '_');
+  return str;
+}
+
+bool GenXFixInvalidFuncName::isSupportedCallingConv(CallingConv::ID callingConv) {
+  return callingConv == CallingConv::SPIR_FUNC;
+}
+
+bool GenXFixInvalidFuncName::changeFuncName(Function& F) {
+  bool isNameChanged = false;
+  std::string original = F.getName().str();
+  std::string changed  = replaceInvalidCharToUnderline(original);
+  if (original != changed) {
+    F.setName(changed);
+    isNameChanged = true;
+  }
+  return isNameChanged;
+}
+
+char GenXFixInvalidFuncName::ID = 0;
+namespace llvm {
+void initializeGenXFixInvalidFuncNamePass(PassRegistry &);
+}
+INITIALIZE_PASS_BEGIN(GenXFixInvalidFuncName, "GenXFixInvalidFuncName", "GenXFixInvalidFuncName", false, false)
+INITIALIZE_PASS_END(GenXFixInvalidFuncName, "GenXFixInvalidFuncName", "GenXFixInvalidFuncName", false, false)
+FunctionPass *llvm::createGenXFixInvalidFuncNamePass() {
+  initializeGenXFixInvalidFuncNamePass(*PassRegistry::getPassRegistry());
+  return new GenXFixInvalidFuncName;
+}

IGC/VectorCompiler/lib/GenXCodeGen/GenXTargetMachine.cpp

@@ -152,6 +152,7 @@ void initializeGenXPasses(PassRegistry &registry) {
   initializeGenXLinkageCorruptorPass(registry);
   initializeGenXInlineAsmLoweringPass(registry);
   initializeGenXDebugLegalizationPass(registry);
+  initializeGenXFixInvalidFuncNamePass(registry);
 
   // WRITE HERE MORE PASSES IF IT'S NEEDED;
 }
@@ -300,6 +301,8 @@ bool GenXTargetMachine::addPassesToEmitFile(PassManagerBase &PM,
   vc::addPass(PM, PassConfig);
   const GenXBackendConfig &BackendConfig = PassConfig->getBackendConfig();
 
+  vc::addPass(PM, createGenXFixInvalidFuncNamePass());
+
   // Install GenX-specific TargetTransformInfo for passes such as
   // LowerAggrCopies and InfoAddressSpace
   vc::addPass(PM, createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
@@ -592,6 +595,13 @@ bool GenXTargetMachine::addPassesToEmitFile(PassManagerBase &PM,
 }
 
 void GenXTargetMachine::adjustPassManager(PassManagerBuilder &PMBuilder) {
+  // Fix function names.
+  PMBuilder.addExtension(
+      PassManagerBuilder::EP_EarlyAsPossible,
+      [](const PassManagerBuilder &Builder, PassManagerBase &PM) {
+        PM.add(createGenXFixInvalidFuncNamePass());
+      });
+
   // Lower aggr copies.
   PMBuilder.addExtension(
       PassManagerBuilder::EP_EarlyAsPossible,

IGC/VectorCompiler/lib/GenXCodeGen/GenXTargetMachine.h

@@ -253,6 +253,7 @@ void initializeGenXStructSplitterPass(PassRegistry &);
 void initializeGenXPredRegionLoweringPass(PassRegistry &);
 void initializeGenXInlineAsmLoweringPass(PassRegistry &);
 void initializeGenXDebugLegalizationPass(PassRegistry &);
+void initializeGenXFixInvalidFuncNamePass(PassRegistry &);
 } // End llvm namespace
 
 #endif