lib/Transforms/Utils/Mem2Reg.cpp

   1 //===- Mem2Reg.cpp - The -mem2reg pass, a wrapper around the Utils lib ----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass is a simple pass wrapper around the PromoteMemToReg function call
  11 // exposed by the Utils library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "mem2reg"
  16 #include "llvm/Transforms/Scalar.h"
  17 #include "llvm/Transforms/Utils/PromoteMemToReg.h"
  18 #include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
  19 #include "llvm/Analysis/Dominators.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/ADT/Statistic.h"
  23 using namespace llvm;
  24
  25 STATISTIC(NumPromoted, "Number of alloca's promoted");
  26
  27 namespace {
  28   struct PromotePass : public FunctionPass {
  29     static char ID; // Pass identification, replacement for typeid
  30     PromotePass() : FunctionPass(ID) {
  31       initializePromotePassPass(*PassRegistry::getPassRegistry());
  32     }
  33
  34     // runOnFunction - To run this pass, first we calculate the alloca
  35     // instructions that are safe for promotion, then we promote each one.
  36     //
  37     virtual bool runOnFunction(Function &F);
  38
  39     // getAnalysisUsage - We need dominance frontiers
  40     //
  41     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  42       AU.addRequired<DominatorTree>();
  43       AU.addRequired<DominanceFrontier>();
  44       AU.setPreservesCFG();
  45       // This is a cluster of orthogonal Transforms
  46       AU.addPreserved<UnifyFunctionExitNodes>();
  47       AU.addPreservedID(LowerSwitchID);
  48       AU.addPreservedID(LowerInvokePassID);
  49     }
  50   };
  51 }  // end of anonymous namespace
  52
  53 char PromotePass::ID = 0;
  54 INITIALIZE_PASS_BEGIN(PromotePass, "mem2reg", "Promote Memory to Register",
  55                 false, false)
  56 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
  57 INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
  58 INITIALIZE_PASS_DEPENDENCY(UnifyFunctionExitNodes)
  59 INITIALIZE_PASS_DEPENDENCY(LowerSwitch)
  60 INITIALIZE_PASS_DEPENDENCY(LowerInvoke)
  61 INITIALIZE_PASS_END(PromotePass, "mem2reg", "Promote Memory to Register",
  62                 false, false)
  63
  64 bool PromotePass::runOnFunction(Function &F) {
  65   std::vector<AllocaInst*> Allocas;
  66
  67   BasicBlock &BB = F.getEntryBlock();  // Get the entry node for the function
  68
  69   bool Changed  = false;
  70
  71   DominatorTree &DT = getAnalysis<DominatorTree>();
  72   DominanceFrontier &DF = getAnalysis<DominanceFrontier>();
  73
  74   while (1) {
  75     Allocas.clear();
  76
  77     // Find allocas that are safe to promote, by looking at all instructions in
  78     // the entry node
  79     for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
  80       if (AllocaInst *AI = dyn_cast<AllocaInst>(I))       // Is it an alloca?
  81         if (isAllocaPromotable(AI))
  82           Allocas.push_back(AI);
  83
  84     if (Allocas.empty()) break;
  85
  86     PromoteMemToReg(Allocas, DT, DF);
  87     NumPromoted += Allocas.size();
  88     Changed = true;
  89   }
  90
  91   return Changed;
  92 }
  93
  94 // createPromoteMemoryToRegister - Provide an entry point to create this pass.
  95 //
  96 FunctionPass *llvm::createPromoteMemoryToRegisterPass() {
  97   return new PromotePass();
  98 }