lib/Analysis/ValueNumbering.cpp

   1 //===- ValueNumbering.cpp - Value #'ing Implementation ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the non-abstract Value Numbering methods as well as a
  11 // default implementation for the analysis group.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/Passes.h"
  16 #include "llvm/Analysis/ValueNumbering.h"
  17 #include "llvm/Support/InstVisitor.h"
  18 #include "llvm/BasicBlock.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Pass.h"
  21 #include "llvm/Type.h"
  22 using namespace llvm;
  23
  24 // Register the ValueNumbering interface, providing a nice name to refer to.
  25 static RegisterAnalysisGroup<ValueNumbering> X("Value Numbering");
  26
  27 /// ValueNumbering destructor: DO NOT move this to the header file for
  28 /// ValueNumbering or else clients of the ValueNumbering class may not depend on
  29 /// the ValueNumbering.o file in the current .a file, causing alias analysis
  30 /// support to not be included in the tool correctly!
  31 ///
  32 ValueNumbering::~ValueNumbering() {}
  33
  34 //===----------------------------------------------------------------------===//
  35 // Basic ValueNumbering Pass Implementation
  36 //===----------------------------------------------------------------------===//
  37 //
  38 // Because of the way .a files work, the implementation of the BasicVN class
  39 // MUST be in the ValueNumbering file itself, or else we run the risk of
  40 // ValueNumbering being used, but the default implementation not being linked
  41 // into the tool that uses it.  As such, we register and implement the class
  42 // here.
  43 //
  44
  45 namespace {
  46   /// BasicVN - This class is the default implementation of the ValueNumbering
  47   /// interface.  It walks the SSA def-use chains to trivially identify
  48   /// lexically identical expressions.  This does not require any ahead of time
  49   /// analysis, so it is a very fast default implementation.
  50   ///
  51   struct BasicVN : public ImmutablePass, public ValueNumbering {
  52     /// getEqualNumberNodes - Return nodes with the same value number as the
  53     /// specified Value.  This fills in the argument vector with any equal
  54     /// values.
  55     ///
  56     /// This is where our implementation is.
  57     ///
  58     virtual void getEqualNumberNodes(Value *V1,
  59                                      std::vector<Value*> &RetVals) const;
  60   };
  61
  62   // Register this pass...
  63   RegisterOpt<BasicVN>
  64   X("basicvn", "Basic Value Numbering (default GVN impl)");
  65
  66   // Declare that we implement the ValueNumbering interface
  67   RegisterAnalysisGroup<ValueNumbering, BasicVN, true> Y;
  68
  69   /// BVNImpl - Implement BasicVN in terms of a visitor class that
  70   /// handles the different types of instructions as appropriate.
  71   ///
  72   struct BVNImpl : public InstVisitor<BVNImpl> {
  73     std::vector<Value*> &RetVals;
  74     BVNImpl(std::vector<Value*> &RV) : RetVals(RV) {}
  75
  76     void handleBinaryInst(Instruction &I);
  77     void visitBinaryOperator(BinaryOperator &I) {
  78       handleBinaryInst((Instruction&)I);
  79     }
  80     void visitGetElementPtrInst(GetElementPtrInst &I);
  81     void visitCastInst(CastInst &I);
  82     void visitShiftInst(ShiftInst &I) { handleBinaryInst((Instruction&)I); }
  83     void visitInstruction(Instruction &) {
  84       // Cannot value number calls or terminator instructions...
  85     }
  86   };
  87 }
  88
  89 ImmutablePass *llvm::createBasicVNPass() { return new BasicVN(); }
  90
  91 // getEqualNumberNodes - Return nodes with the same value number as the
  92 // specified Value.  This fills in the argument vector with any equal values.
  93 //
  94 void BasicVN::getEqualNumberNodes(Value *V, std::vector<Value*> &RetVals) const{
  95   assert(V->getType() != Type::VoidTy &&
  96          "Can only value number non-void values!");
  97   // We can only handle the case where I is an instruction!
  98   if (Instruction *I = dyn_cast<Instruction>(V))
  99     BVNImpl(RetVals).visit(I);
 100 }
 101
 102 void BVNImpl::visitCastInst(CastInst &CI) {
 103   Instruction &I = (Instruction&)CI;
 104   Value *Op = I.getOperand(0);
 105   Function *F = I.getParent()->getParent();
 106
 107   for (Value::use_iterator UI = Op->use_begin(), UE = Op->use_end();
 108        UI != UE; ++UI)
 109     if (CastInst *Other = dyn_cast<CastInst>(*UI))
 110       // Check that the types are the same, since this code handles casts...
 111       if (Other->getType() == I.getType() &&
 112           // Is it embedded in the same function?  (This could be false if LHS
 113           // is a constant or global!)
 114           Other->getParent()->getParent() == F &&
 115           // Check to see if this new cast is not I.
 116           Other != &I) {
 117         // These instructions are identical.  Add to list...
 118         RetVals.push_back(Other);
 119       }
 120 }
 121
 122
 123 // isIdenticalBinaryInst - Return true if the two binary instructions are
 124 // identical.
 125 //
 126 static inline bool isIdenticalBinaryInst(const Instruction &I1,
 127                                          const Instruction *I2) {
 128   // Is it embedded in the same function?  (This could be false if LHS
 129   // is a constant or global!)
 130   if (I1.getOpcode() != I2->getOpcode() ||
 131       I1.getParent()->getParent() != I2->getParent()->getParent())
 132     return false;
 133
 134   // They are identical if both operands are the same!
 135   if (I1.getOperand(0) == I2->getOperand(0) &&
 136       I1.getOperand(1) == I2->getOperand(1))
 137     return true;
 138
 139   // If the instruction is commutative, the instruction can match if the
 140   // operands are swapped!
 141   //
 142   if ((I1.getOperand(0) == I2->getOperand(1) &&
 143        I1.getOperand(1) == I2->getOperand(0)) &&
 144       I1.isCommutative())
 145     return true;
 146
 147   return false;
 148 }
 149
 150 void BVNImpl::handleBinaryInst(Instruction &I) {
 151   Value *LHS = I.getOperand(0);
 152
 153   for (Value::use_iterator UI = LHS->use_begin(), UE = LHS->use_end();
 154        UI != UE; ++UI)
 155     if (Instruction *Other = dyn_cast<Instruction>(*UI))
 156       // Check to see if this new binary operator is not I, but same operand...
 157       if (Other != &I && isIdenticalBinaryInst(I, Other)) {
 158         // These instructions are identical.  Handle the situation.
 159         RetVals.push_back(Other);
 160       }
 161 }
 162
 163 // IdenticalComplexInst - Return true if the two instructions are the same, by
 164 // using a brute force comparison.  This is useful for instructions with an
 165 // arbitrary number of arguments.
 166 //
 167 static inline bool IdenticalComplexInst(const Instruction *I1,
 168                                         const Instruction *I2) {
 169   assert(I1->getOpcode() == I2->getOpcode());
 170   // Equal if they are in the same function...
 171   return I1->getParent()->getParent() == I2->getParent()->getParent() &&
 172     // And return the same type...
 173     I1->getType() == I2->getType() &&
 174     // And have the same number of operands...
 175     I1->getNumOperands() == I2->getNumOperands() &&
 176     // And all of the operands are equal.
 177     std::equal(I1->op_begin(), I1->op_end(), I2->op_begin());
 178 }
 179
 180 void BVNImpl::visitGetElementPtrInst(GetElementPtrInst &I) {
 181   Value *Op = I.getOperand(0);
 182
 183   // Try to pick a local operand if possible instead of a constant or a global
 184   // that might have a lot of uses.
 185   for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
 186     if (isa<Instruction>(I.getOperand(i)) || isa<Argument>(I.getOperand(i))) {
 187       Op = I.getOperand(i);
 188       break;
 189     }
 190
 191   for (Value::use_iterator UI = Op->use_begin(), UE = Op->use_end();
 192        UI != UE; ++UI)
 193     if (GetElementPtrInst *Other = dyn_cast<GetElementPtrInst>(*UI))
 194       // Check to see if this new getelementptr is not I, but same operand...
 195       if (Other != &I && IdenticalComplexInst(&I, Other)) {
 196         // These instructions are identical.  Handle the situation.
 197         RetVals.push_back(Other);
 198       }
 199 }
 200
 201 void llvm::BasicValueNumberingStub() { }