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/DominanceFrontier.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.setPreservesCFG();
  44       // This is a cluster of orthogonal Transforms
  45       AU.addPreserved<UnifyFunctionExitNodes>();
  46       AU.addPreservedID(LowerSwitchID);
  47       AU.addPreservedID(LowerInvokePassID);
  48     }
  49   };
  50 }  // end of anonymous namespace
  51
  52 char PromotePass::ID = 0;
  53 INITIALIZE_PASS_BEGIN(PromotePass, "mem2reg", "Promote Memory to Register",
  54                 false, false)
  55 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
  56 INITIALIZE_PASS_END(PromotePass, "mem2reg", "Promote Memory to Register",
  57                 false, false)
  58
  59 bool PromotePass::runOnFunction(Function &F) {
  60   std::vector<AllocaInst*> Allocas;
  61
  62   BasicBlock &BB = F.getEntryBlock();  // Get the entry node for the function
  63
  64   bool Changed  = false;
  65
  66   DominatorTree &DT = getAnalysis<DominatorTree>();
  67
  68   while (1) {
  69     Allocas.clear();
  70
  71     // Find allocas that are safe to promote, by looking at all instructions in
  72     // the entry node
  73     for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
  74       if (AllocaInst *AI = dyn_cast<AllocaInst>(I))       // Is it an alloca?
  75         if (isAllocaPromotable(AI))
  76           Allocas.push_back(AI);
  77
  78     if (Allocas.empty()) break;
  79
  80     PromoteMemToReg(Allocas, DT);
  81     NumPromoted += Allocas.size();
  82     Changed = true;
  83   }
  84
  85   return Changed;
  86 }
  87
  88 // createPromoteMemoryToRegister - Provide an entry point to create this pass.
  89 //
  90 FunctionPass *llvm::createPromoteMemoryToRegisterPass() {
  91   return new PromotePass();
  92 }