lib/Transforms/Utils/SimplifyInstructions.cpp

   1 //===------ SimplifyInstructions.cpp - Remove redundant instructions ------===//
   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 is a utility pass used for testing the InstructionSimplify analysis.
  11 // The analysis is applied to every instruction, and if it simplifies then the
  12 // instruction is replaced by the simplification.  If you are looking for a pass
  13 // that performs serious instruction folding, use the instcombine pass instead.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #define DEBUG_TYPE "instsimplify"
  18 #include "llvm/Transforms/Scalar.h"
  19 #include "llvm/ADT/DepthFirstIterator.h"
  20 #include "llvm/ADT/SmallPtrSet.h"
  21 #include "llvm/ADT/Statistic.h"
  22 #include "llvm/Analysis/InstructionSimplify.h"
  23 #include "llvm/IR/DataLayout.h"
  24 #include "llvm/IR/Dominators.h"
  25 #include "llvm/IR/Function.h"
  26 #include "llvm/IR/Type.h"
  27 #include "llvm/Pass.h"
  28 #include "llvm/Target/TargetLibraryInfo.h"
  29 #include "llvm/Transforms/Utils/Local.h"
  30 using namespace llvm;
  31
  32 STATISTIC(NumSimplified, "Number of redundant instructions removed");
  33
  34 namespace {
  35   struct InstSimplifier : public FunctionPass {
  36     static char ID; // Pass identification, replacement for typeid
  37     InstSimplifier() : FunctionPass(ID) {
  38       initializeInstSimplifierPass(*PassRegistry::getPassRegistry());
  39     }
  40
  41     void getAnalysisUsage(AnalysisUsage &AU) const override {
  42       AU.setPreservesCFG();
  43       AU.addRequired<TargetLibraryInfo>();
  44     }
  45
  46     /// runOnFunction - Remove instructions that simplify.
  47     bool runOnFunction(Function &F) override {
  48       const DominatorTreeWrapperPass *DTWP =
  49           getAnalysisIfAvailable<DominatorTreeWrapperPass>();
  50       const DominatorTree *DT = DTWP ? &DTWP->getDomTree() : 0;
  51       DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
  52       const DataLayout *DL = DLP ? &DLP->getDataLayout() : 0;
  53       const TargetLibraryInfo *TLI = &getAnalysis<TargetLibraryInfo>();
  54       SmallPtrSet<const Instruction*, 8> S1, S2, *ToSimplify = &S1, *Next = &S2;
  55       bool Changed = false;
  56
  57       do {
  58         for (df_iterator<BasicBlock*> DI = df_begin(&F.getEntryBlock()),
  59              DE = df_end(&F.getEntryBlock()); DI != DE; ++DI)
  60           for (BasicBlock::iterator BI = DI->begin(), BE = DI->end(); BI != BE;) {
  61             Instruction *I = BI++;
  62             // The first time through the loop ToSimplify is empty and we try to
  63             // simplify all instructions.  On later iterations ToSimplify is not
  64             // empty and we only bother simplifying instructions that are in it.
  65             if (!ToSimplify->empty() && !ToSimplify->count(I))
  66               continue;
  67             // Don't waste time simplifying unused instructions.
  68             if (!I->use_empty())
  69               if (Value *V = SimplifyInstruction(I, DL, TLI, DT)) {
  70                 // Mark all uses for resimplification next time round the loop.
  71                 for (User *U : I->users())
  72                   Next->insert(cast<Instruction>(U));
  73                 I->replaceAllUsesWith(V);
  74                 ++NumSimplified;
  75                 Changed = true;
  76               }
  77             Changed |= RecursivelyDeleteTriviallyDeadInstructions(I, TLI);
  78           }
  79
  80         // Place the list of instructions to simplify on the next loop iteration
  81         // into ToSimplify.
  82         std::swap(ToSimplify, Next);
  83         Next->clear();
  84       } while (!ToSimplify->empty());
  85
  86       return Changed;
  87     }
  88   };
  89 }
  90
  91 char InstSimplifier::ID = 0;
  92 INITIALIZE_PASS_BEGIN(InstSimplifier, "instsimplify",
  93                       "Remove redundant instructions", false, false)
  94 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
  95 INITIALIZE_PASS_END(InstSimplifier, "instsimplify",
  96                     "Remove redundant instructions", false, false)
  97 char &llvm::InstructionSimplifierID = InstSimplifier::ID;
  98
  99 // Public interface to the simplify instructions pass.
 100 FunctionPass *llvm::createInstructionSimplifierPass() {
 101   return new InstSimplifier();
 102 }