Enable Optimization Remark Emitter

Emit remark for passes, right now only enable for Divergent pass barrier

Author: Winston0323

IGC/AdaptorCommon/DivergentBarrierPass.cpp

@@ -37,6 +37,7 @@ SPDX-License-Identifier: MIT
 #include "llvm/Transforms/Utils/Local.h"
 #include "llvmWrapper/Transforms/Utils/Cloning.h"
 #include "common/LLVMWarningsPop.hpp"
+#include "llvm/Analysis/OptimizationRemarkEmitter.h"
 
 using namespace llvm;
 using namespace IGC;
@@ -708,7 +709,23 @@ bool DivergentBarrierPass::runOnModule(Module& M)
 
     for (auto* F : Shaders)
     {
-        Changed |= processShader(F);
+        bool hadDivBarrier = processShader(F);
+
+        if (IGC_IS_FLAG_ENABLED(EnableRemarks))
+        {
+            if (hadDivBarrier) {
+                OptimizationRemarkEmitter ORE(F);
+
+                ORE.emit([&]() {
+                    return OptimizationRemark("divergent-barrier-pass", "DivergentBarrierPass", F)
+                        << "Divergent Barriers detected and transformed."
+                        << ore::NV("Function", F);
+                    });
+
+            }
+        }
+        Changed |= hadDivBarrier;
+
     }
 
     IGC_ASSERT(false == llvm::verifyModule(*m_CGCtx->getModule(), &dbgs()));

IGC/Compiler/CodeGenContext.cpp

@@ -17,6 +17,9 @@ SPDX-License-Identifier: MIT
 #include "Compiler/CISACodeGen/OpenCLKernelCodeGen.hpp"
 #include "Compiler/CodeGenPublic.h"
 #include "Probe/Assertion.h"
+#if LLVM_VERSION_MAJOR >= 11
+#include <llvm/IR/LLVMRemarkStreamer.h>
+#endif
 
 namespace IGC
 {
@@ -1027,4 +1030,22 @@ namespace IGC
         }
         return MI->second;
     }
+    void CodeGenContext::initializeRemarkEmitter(const ShaderHash & hash) {
+#if LLVM_VERSION_MAJOR >= 11
+        //setting up optimization remark emitter
+        if (IGC_IS_FLAG_ENABLED(EnableRemarks))
+        {
+            std::string remark_file_name = IGC::Debug::DumpName("Remark_")
+                .Type(this->type)
+                .Hash(hash)
+                .Extension("yaml")
+                .str();
+            llvm::Expected<std::unique_ptr<llvm::ToolOutputFile>> RemarksFileOrErr =
+                setupLLVMOptimizationRemarks(*this->getLLVMContext(), remark_file_name, "",
+                    "yaml", false, 0);
+            this->RemarksFile = std::move(*RemarksFileOrErr);
+            this->RemarksFile->keep();
+        }
+#endif
+    }
 }

IGC/Compiler/CodeGenPublic.h

@@ -44,6 +44,7 @@ SPDX-License-Identifier: MIT
 #include <llvm/IR/IRBuilder.h>
 #include "llvm/IR/Function.h"
 #include "llvm/IR/ValueMap.h"
+#include <llvm/Support/ToolOutputFile.h>
 #include "llvm/IR/AssemblyAnnotationWriter.h"
 #include "common/LLVMWarningsPop.hpp"
 #include "CodeGenPublicEnums.h"
@@ -1010,7 +1011,7 @@ namespace IGC
         std::stringstream oclErrorMessage;
         //For storing warning message
         std::stringstream oclWarningMessage;
-
+        std::unique_ptr<llvm::ToolOutputFile> RemarksFile;
     protected:
         // Objects pointed to by these pointers are owned by this class.
         LLVMContextWrapper* llvmCtxWrapper;
@@ -1226,6 +1227,9 @@ namespace IGC
         int getFunctionID(llvm::Function* F);
         std::string getFunctionDumpName(int functionId);
         bool dumpUseShorterName() const { return m_enableDumpUseShorterName; }
+
+        // For remarks
+        void initializeRemarkEmitter(const ShaderHash& hash);
     };
 
     struct SComputeShaderSecondCompileInput

IGC/common/igc_flags.h

@@ -408,6 +408,7 @@ DECLARE_IGC_REGKEY(bool, PrintPsoDdiHash,               true,  "Print psoDDIHash
 DECLARE_IGC_REGKEY(bool, ShaderDataBaseStats,           false, "Enable gathering sends' sizes for shader statistics", false)
 DECLARE_IGC_REGKEY(bool, DumpLoopSink,                  false,  "Dump debug info in LoopSink", false)
 DECLARE_IGC_REGKEY(debugString, ShaderDataBaseStatsFilePath, 0, "Path to a file with dumped shader stats additional data e.g. data available during compilation only", false)
+DECLARE_IGC_REGKEY(bool, EnableRemarks, false, "Enable remark for Divergent Barrier", false)
 DECLARE_IGC_REGKEY(bool, AddExtraIntfInfo,                false, "Will add extra inteference info from .extraintf files from c:\\Intel\\IGC\\ShaderOverride", false)
 
 DECLARE_IGC_GROUP("Debugging features")