Add AnnotateUniformAllocas pass - third attempt, had issues with CFG Simplification.

Change-Id: I85ddfa3a7db4b5b2f3d393cb18fa9febc2641bcf

Author: grey-eminence

Diff for: IGC/Compiler/CISACodeGen/AnnotateUniformAllocas.cpp

@@ -0,0 +1,77 @@
+/*===================== begin_copyright_notice ==================================
+
+Copyright (c) 2017 Intel Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+======================= end_copyright_notice ==================================*/
+
+#include "AnnotateUniformAllocas.h"
+#include "Compiler/IGCPassSupport.h"
+#include "IGCIRBuilder.h"
+#include "common/LLVMWarningsPush.hpp"
+#include <llvm/IR/Function.h>
+#include "common/LLVMWarningsPop.hpp"
+
+using namespace llvm;
+using namespace IGC;
+
+#define PASS_FLAG "annotate_uniform_allocas"
+#define PASS_DESCRIPTION "Annotate uniform allocas"
+#define PASS_CFG_ONLY false
+#define PASS_ANALYSIS false
+IGC_INITIALIZE_PASS_BEGIN(AnnotateUniformAllocas, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
+IGC_INITIALIZE_PASS_END(AnnotateUniformAllocas, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
+
+namespace IGC
+{
+    char AnnotateUniformAllocas::ID = 0;
+
+    AnnotateUniformAllocas::AnnotateUniformAllocas() : FunctionPass(ID)
+    {
+        initializeAnnotateUniformAllocasPass(*PassRegistry::getPassRegistry());
+    }
+
+    llvm::FunctionPass* createAnnotateUniformAllocasPass()
+    {
+        return new AnnotateUniformAllocas();
+    }
+
+    bool AnnotateUniformAllocas::runOnFunction(Function& F)
+    {
+        WI = &getAnalysis<WIAnalysis>();
+        IGC_ASSERT(WI != nullptr);
+        visit(F);
+        return m_changed;
+    }
+
+    void AnnotateUniformAllocas::visitAllocaInst(AllocaInst& I)
+    {
+        bool isUniformAlloca = WI->whichDepend(&I) == WIAnalysis::UNIFORM;
+        if (isUniformAlloca)
+        {
+            IRBuilder<> builder(&I);
+            MDNode* node = MDNode::get(I.getContext(), ConstantAsMetadata::get(builder.getInt1(true)));
+            I.setMetadata("uniform", node);
+            m_changed = true;
+        }
+    }
+}

Diff for: IGC/Compiler/CISACodeGen/AnnotateUniformAllocas.h

@@ -0,0 +1,63 @@
+/*===================== begin_copyright_notice ==================================
+
+Copyright (c) 2017 Intel Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+======================= end_copyright_notice ==================================*/
+#pragma once
+
+#include "Compiler/CISACodeGen/WIAnalysis.hpp"
+#include "common/LLVMWarningsPush.hpp"
+#include <llvm/Pass.h>
+#include <llvm/IR/InstVisitor.h>
+#include "common/LLVMWarningsPop.hpp"
+
+namespace IGC
+{
+    llvm::FunctionPass* createAnnotateUniformAllocasPass();
+
+    class AnnotateUniformAllocas : public llvm::FunctionPass, public llvm::InstVisitor<AnnotateUniformAllocas>
+    {
+    public:
+        static char ID;
+
+        AnnotateUniformAllocas();
+
+        virtual llvm::StringRef getPassName() const override
+        {
+            return "Annotate Uniform Allocas Pass";
+        }
+
+        virtual void getAnalysisUsage(llvm::AnalysisUsage& AU) const override
+        {
+            AU.addRequired<WIAnalysis>();
+            AU.setPreservesCFG();
+        }
+
+        virtual bool runOnFunction(llvm::Function& F) override;
+        void visitAllocaInst(llvm::AllocaInst& I);
+
+    private:
+        WIAnalysis* WI;
+        bool m_changed = false;
+    };
+} // namespace IGC

Diff for: IGC/Compiler/CISACodeGen/CMakeLists.txt

@@ -4,6 +4,7 @@ include_directories("${CMAKE_CURRENT_SOURCE_DIR}")
 set(IGC_BUILD__SRC__CISACodeGen_Common
     "${CMAKE_CURRENT_SOURCE_DIR}/AdvCodeMotion.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/AdvMemOpt.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/AnnotateUniformAllocas.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/BlockCoalescing.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/CheckInstrTypes.cpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/CISABuilder.cpp"
@@ -94,6 +95,7 @@ set(IGC_BUILD__SRC__Compiler_CISACodeGen
 set(IGC_BUILD__HDR__CISACodeGen_Common
     "${CMAKE_CURRENT_SOURCE_DIR}/AdvCodeMotion.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/AdvMemOpt.h"
+    "${CMAKE_CURRENT_SOURCE_DIR}/AnnotateUniformAllocas.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/BlockCoalescing.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/CheckInstrTypes.hpp"
     "${CMAKE_CURRENT_SOURCE_DIR}/CISABuilder.hpp"

Diff for: IGC/Compiler/CISACodeGen/LowerGEPForPrivMem.cpp

@@ -27,7 +27,6 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #include "Compiler/CodeGenContextWrapper.hpp"
 #include "Compiler/MetaDataUtilsWrapper.h"
 #include "Compiler/CISACodeGen/RegisterPressureEstimate.hpp"
-#include "Compiler/CISACodeGen/WIAnalysis.hpp"
 #include "common/LLVMUtils.h"
 #include "Compiler/CISACodeGen/LowerGEPForPrivMem.hpp"
 #include "Compiler/CodeGenPublic.h"
@@ -70,7 +69,6 @@ namespace IGC {
             AU.addRequired<RegisterPressureEstimate>();
             AU.addRequired<MetaDataUtilsWrapper>();
             AU.addRequired<CodeGenContextWrapper>();
-            AU.addRequired<WIAnalysis>();
             AU.addRequired<DominatorTreeWrapperPass>();
             AU.setPreservesCFG();
         }
@@ -252,14 +250,7 @@ bool LowerGEPForPrivMem::IsNativeType(Type* type)
 
 bool LowerGEPForPrivMem::CheckIfAllocaPromotable(llvm::AllocaInst* pAlloca)
 {
-    auto WI = &getAnalysis<WIAnalysis>();
-    bool isUniformAlloca = WI->whichDepend(pAlloca) == WIAnalysis::UNIFORM;
-    if (isUniformAlloca)
-    {
-        IRBuilder<> builder(pAlloca);
-        MDNode* node = MDNode::get(pAlloca->getContext(), ConstantAsMetadata::get(builder.getInt1(true)));
-        pAlloca->setMetadata("uniform", node);
-    }
+    bool isUniformAlloca = pAlloca->getMetadata("uniform") != nullptr;
     unsigned int allocaSize = extractAllocaSize(pAlloca);
     unsigned int allowedAllocaSizeInBytes = MAX_ALLOCA_PROMOTE_GRF_NUM * 4;
 

Diff for: IGC/Compiler/CISACodeGen/ShaderCodeGen.cpp

@@ -161,6 +161,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #include "Compiler/Optimizer/IGCInstCombiner/IGCInstructionCombining.hpp"
 #include "DebugInfo.hpp"
 #include "Compiler/CISACodeGen/HalfPromotion.h"
+#include "Compiler/CISACodeGen/AnnotateUniformAllocas.h"
 #include "Probe/Assertion.h"
 
 /***********************************************************************************
@@ -460,13 +461,17 @@ namespace IGC
         // Resolve the Private memory to register pass
         if (!isOptDisabled)
         {
-            if (IGC_IS_FLAG_DISABLED(DisablePromotePrivMem) &&
-                ctx.m_instrTypes.hasNonPrimitiveAlloca &&
-                ctx.m_retryManager.AllowPromotePrivateMemory())
+            if (ctx.m_instrTypes.hasNonPrimitiveAlloca)
             {
                 mpm.add(createBreakCriticalEdgesPass());
-                mpm.add(createPromotePrivateArrayToReg());
-                mpm.add(createCFGSimplificationPass());
+                mpm.add(createAnnotateUniformAllocasPass());
+
+                if (IGC_IS_FLAG_DISABLED(DisablePromotePrivMem) &&
+                    ctx.m_retryManager.AllowPromotePrivateMemory())
+                {
+                    mpm.add(createPromotePrivateArrayToReg());
+                    mpm.add(createCFGSimplificationPass());
+                }
             }
             mpm.add(createPromoteMemoryToRegisterPass());
         }

Diff for: IGC/Compiler/InitializePasses.h

@@ -32,6 +32,7 @@ namespace llvm {
 // The following declarations are placed according to alphabetic order for simplicity
 void initializeAddImplicitArgsPass(llvm::PassRegistry&);
 void initializeAddressSpaceAliasAnalysisPass(llvm::PassRegistry&);
+void initializeAnnotateUniformAllocasPass(llvm::PassRegistry&);
 void initializeAggregateArgumentsAnalysisPass(llvm::PassRegistry&);
 void initializeAlignmentAnalysisPass(llvm::PassRegistry&);
 void initializePreBIImportAnalysisPass(llvm::PassRegistry&);