Replace invalid characters. Try3

LLVM sometimes creates the function with characters
which are incorrect for vISA (e.g. name with dot).
The change checks LLVM function name and replaces
chars to underscore.

Author: matborzyszkowski

IGC/Compiler/CISACodeGen/ShaderCodeGen.cpp

@@ -92,6 +92,7 @@ SPDX-License-Identifier: MIT
 #if defined(_DEBUG) && !defined(ANDROID)
 #include "Compiler/VerificationPass.hpp"
 #endif
+#include "Compiler/FixInvalidFuncNamePass.hpp"
 #include "Compiler/LegalizationPass.hpp"
 #include "Compiler/LowPrecisionOptPass.hpp"
 #include "Compiler/WorkaroundAnalysisPass.h"
@@ -317,6 +318,7 @@ static void AddAnalysisPasses(CodeGenContext& ctx, IGCPassManager& mpm)
     }
 
     mpm.add(new Layout());
+    mpm.add(createFixInvalidFuncNamePass());
 
     mpm.add(createTimeStatsCounterPass(&ctx, TIME_CG_Analysis, STATS_COUNTER_END));
 

IGC/Compiler/CMakeLists.txt

@@ -46,6 +46,7 @@ set(IGC_BUILD__SRC__Compiler
     "${CMAKE_CURRENT_SOURCE_DIR}/PromoteResourceToDirectAS.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/PromoteStatelessToBindless.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/GenTTI.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/FixInvalidFuncNamePass.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/FixResourcePtr.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/HandleLoadStoreInstructions.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/igc_workaround.cpp"
@@ -122,6 +123,7 @@ set(IGC_BUILD__HDR__Compiler
     "${CMAKE_CURRENT_SOURCE_DIR}/PromoteResourceToDirectAS.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/PromoteStatelessToBindless.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/GenTTI.h"
+    "${CMAKE_CURRENT_SOURCE_DIR}/FixInvalidFuncNamePass.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/FixResourcePtr.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/HandleLoadStoreInstructions.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/IGC_IR_spec.hpp"

IGC/Compiler/FixInvalidFuncNamePass.cpp

@@ -0,0 +1,112 @@
+/*========================== begin_copyright_notice ============================
+
+Copyright (C) 2021 Intel Corporation
+
+SPDX-License-Identifier: MIT
+
+============================= end_copyright_notice ===========================*/
+
+#include "Compiler/FixInvalidFuncNamePass.hpp"
+#include "IGCPassSupport.h"
+#include "GenISAIntrinsics/GenIntrinsicInst.h"
+#include "AdaptorCommon/ImplicitArgs.hpp"
+#include "common/LLVMWarningsPush.hpp"
+#include "llvm/IR/Function.h"
+#include "common/LLVMWarningsPop.hpp"
+
+using namespace llvm;
+using namespace IGC;
+
+
+// LLVM sometimes creates the function with characters which are incorrect for vISA (e.g. with ".")
+// Here we check the LLVM names and replace incorrect characters for vISA to "_"
+// We need to check call instruction. If contains invalid char, we change func name called by this instruction
+class FixInvalidFuncName : public FunctionPass
+{
+public:
+    FixInvalidFuncName() : FunctionPass(ID) {}
+    virtual bool runOnFunction(Function& F) override;
+    virtual llvm::StringRef getPassName() const override
+    {
+        return "Fix Invalid Func Name";
+    }
+    static char ID;
+
+private:
+    // Check and change call instruction if contains invalid char
+    bool changeCallInstr(Function& F);
+    // Change func name. This changing update all the references inside the same module
+    bool changeInvalidFuncName(Function& F);
+    // Replace invalid char to underscore
+    std::string replaceInvalidCharToUnderline(std::string str);
+};
+
+char FixInvalidFuncName::ID = 0;
+
+bool FixInvalidFuncName::runOnFunction(Function& F)
+{
+    return changeCallInstr(F);
+}
+
+bool FixInvalidFuncName::changeInvalidFuncName(Function& F)
+{
+    std::string str = F.getName().str();
+    std::string str_changed = replaceInvalidCharToUnderline(str);
+    if (str != str_changed)
+    {
+        F.setName(str_changed);
+        return true;
+    }
+    return false;
+}
+
+bool FixInvalidFuncName::changeCallInstr(Function& F)
+{
+    for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
+    {
+        if (CallInst* callInst = dyn_cast<CallInst>(&(*I)))
+        {
+            if (callInst->getCallingConv() == CallingConv::SPIR_FUNC)
+            {
+                auto calledFuncName = callInst->getCalledFunction();
+                if (calledFuncName)
+                {
+                    StringRef funcName = calledFuncName->getName();
+                    std::string str = funcName.str();
+                    std::string str_changed = replaceInvalidCharToUnderline(str);
+                    if (str != str_changed)
+                    {
+                        Function* func = callInst->getCalledFunction();
+                        if (func)
+                        {
+                            return changeInvalidFuncName(*func);
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return false;
+}
+
+std::string FixInvalidFuncName::replaceInvalidCharToUnderline(std::string str)
+{
+    std::replace(str.begin(), str.end(), '.', '_');
+    std::replace(str.begin(), str.end(), '$', '_');
+    return str;
+}
+
+namespace IGC
+{
+#define PASS_FLAG "fix-invalid-func-name"
+#define PASS_DESCRIPTION "Fix Invalid Func Name Pass"
+#define PASS_CFG_ONLY false
+#define PASS_ANALYSIS true
+    IGC_INITIALIZE_PASS_BEGIN(FixInvalidFuncName, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
+        IGC_INITIALIZE_PASS_END(FixInvalidFuncName, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
+
+        FunctionPass* createFixInvalidFuncNamePass()
+    {
+        return new FixInvalidFuncName();
+    }
+}

IGC/Compiler/FixInvalidFuncNamePass.hpp

@@ -0,0 +1,19 @@
+/*========================== begin_copyright_notice ============================
+
+Copyright (C) 2021 Intel Corporation
+
+SPDX-License-Identifier: MIT
+
+============================= end_copyright_notice ===========================*/
+
+#pragma once
+
+#include "common/LLVMWarningsPush.hpp"
+#include <llvm/Pass.h>
+#include "common/LLVMWarningsPop.hpp"
+
+namespace IGC
+{
+    llvm::FunctionPass* createFixInvalidFuncNamePass();
+    void initializeFixInvalidFuncNamePass(llvm::PassRegistry&);
+}