lib/Analysis/ValueNumbering.cpp

   1 //===- ValueNumbering.cpp - Value #'ing Implementation ----------*- C++ -*-===//
   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 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 #include "llvm/Support/Compiler.h"
  23 using namespace llvm;
  24
  25 char ValueNumbering::ID = 0;
  26 // Register the ValueNumbering interface, providing a nice name to refer to.
  27 static RegisterAnalysisGroup<ValueNumbering> X("Value Numbering");
  28
  29 /// ValueNumbering destructor: DO NOT move this to the header file for
  30 /// ValueNumbering or else clients of the ValueNumbering class may not depend on
  31 /// the ValueNumbering.o file in the current .a file, causing alias analysis
  32 /// support to not be included in the tool correctly!
  33 ///
  34 ValueNumbering::~ValueNumbering() {}
  35
  36 //===----------------------------------------------------------------------===//
  37 // Basic ValueNumbering Pass Implementation
  38 //===----------------------------------------------------------------------===//
  39 //
  40 // Because of the way .a files work, the implementation of the BasicVN class
  41 // MUST be in the ValueNumbering file itself, or else we run the risk of
  42 // ValueNumbering being used, but the default implementation not being linked
  43 // into the tool that uses it.  As such, we register and implement the class
  44 // here.
  45 //
  46
  47 namespace {
  48   /// BasicVN - This class is the default implementation of the ValueNumbering
  49   /// interface.  It walks the SSA def-use chains to trivially identify
  50   /// lexically identical expressions.  This does not require any ahead of time
  51   /// analysis, so it is a very fast default implementation.
  52   ///
  53   struct VISIBILITY_HIDDEN BasicVN
  54       : public ImmutablePass, public ValueNumbering {
  55     static char ID; // Class identification, replacement for typeinfo
  56     BasicVN() : ImmutablePass((intptr_t)&ID) {}
  57
  58     /// getEqualNumberNodes - Return nodes with the same value number as the
  59     /// specified Value.  This fills in the argument vector with any equal
  60     /// values.
  61     ///
  62     /// This is where our implementation is.
  63     ///
  64     virtual void getEqualNumberNodes(Value *V1,
  65                                      std::vector<Value*> &RetVals) const;
  66   };
  67
  68   char BasicVN::ID = 0;
  69   // Register this pass...
  70   RegisterPass<BasicVN>
  71   X("basicvn", "Basic Value Numbering (default GVN impl)");
  72
  73   // Declare that we implement the ValueNumbering interface
  74   RegisterAnalysisGroup<ValueNumbering, true> Y(X);
  75
  76   /// BVNImpl - Implement BasicVN in terms of a visitor class that
  77   /// handles the different types of instructions as appropriate.
  78   ///
  79   struct VISIBILITY_HIDDEN BVNImpl : public InstVisitor<BVNImpl> {
  80     std::vector<Value*> &RetVals;
  81     explicit BVNImpl(std::vector<Value*> &RV) : RetVals(RV) {}
  82
  83     void visitCastInst(CastInst &I);
  84     void visitGetElementPtrInst(GetElementPtrInst &I);
  85     void visitCmpInst(CmpInst &I);
  86
  87     void handleBinaryInst(Instruction &I);
  88     void visitBinaryOperator(Instruction &I)     { handleBinaryInst(I); }
  89     void visitShiftInst(Instruction &I)          { handleBinaryInst(I); }
  90     void visitExtractElementInst(Instruction &I) { handleBinaryInst(I); }
  91
  92     void handleTernaryInst(Instruction &I);
  93     void visitSelectInst(Instruction &I)         { handleTernaryInst(I); }
  94     void visitInsertElementInst(Instruction &I)  { handleTernaryInst(I); }
  95     void visitShuffleVectorInst(Instruction &I)  { handleTernaryInst(I); }
  96     void visitInstruction(Instruction &) {
  97       // Cannot value number calls or terminator instructions.
  98     }
  99   };
 100 }
 101
 102 ImmutablePass *llvm::createBasicVNPass() { return new BasicVN(); }
 103
 104 // getEqualNumberNodes - Return nodes with the same value number as the
 105 // specified Value.  This fills in the argument vector with any equal values.
 106 //
 107 void BasicVN::getEqualNumberNodes(Value *V, std::vector<Value*> &RetVals) const{
 108   assert(V->getType() != Type::VoidTy &&
 109          "Can only value number non-void values!");
 110   // We can only handle the case where I is an instruction!
 111   if (Instruction *I = dyn_cast<Instruction>(V))
 112     BVNImpl(RetVals).visit(I);
 113 }
 114
 115 void BVNImpl::visitCastInst(CastInst &CI) {
 116   Instruction &I = (Instruction&)CI;
 117   Value *Op = I.getOperand(0);
 118   Function *F = I.getParent()->getParent();
 119
 120   for (Value::use_iterator UI = Op->use_begin(), UE = Op->use_end();
 121        UI != UE; ++UI)
 122     if (CastInst *Other = dyn_cast<CastInst>(*UI))
 123       // Check that the opcode is the same
 124       if (Other->getOpcode() == Instruction::CastOps(I.getOpcode()) &&
 125           // Check that the destination types are the same
 126           Other->getType() == I.getType() &&
 127           // Is it embedded in the same function?  (This could be false if LHS
 128           // is a constant or global!)
 129           Other->getParent()->getParent() == F &&
 130           // Check to see if this new cast is not I.
 131           Other != &I) {
 132         // These instructions are identical.  Add to list...
 133         RetVals.push_back(Other);
 134       }
 135 }
 136
 137 void  BVNImpl::visitCmpInst(CmpInst &CI1) {
 138   Value *LHS = CI1.getOperand(0);
 139   for (Value::use_iterator UI = LHS->use_begin(), UE = LHS->use_end();
 140        UI != UE; ++UI)
 141     if (CmpInst *CI2 = dyn_cast<CmpInst>(*UI))
 142       // Check to see if this compare instruction is not CI, but same opcode,
 143       // same predicate, and in the same function.
 144       if (CI2 != &CI1 && CI2->getOpcode() == CI1.getOpcode() &&
 145           CI2->getPredicate() == CI1.getPredicate() &&
 146           CI2->getParent()->getParent() == CI1.getParent()->getParent())
 147         // If the operands are the same
 148         if ((CI2->getOperand(0) == CI1.getOperand(0) &&
 149             CI2->getOperand(1) == CI1.getOperand(1)) ||
 150             // Or the compare is commutative and the operands are reversed
 151             (CI1.isCommutative() &&
 152              CI2->getOperand(0) == CI1.getOperand(1) &&
 153              CI2->getOperand(1) == CI1.getOperand(0)))
 154           // Then the instructiosn are identical, add to list.
 155           RetVals.push_back(CI2);
 156 }
 157
 158
 159
 160 // isIdenticalBinaryInst - Return true if the two binary instructions are
 161 // identical.
 162 //
 163 static inline bool isIdenticalBinaryInst(const Instruction &I1,
 164                                          const Instruction *I2) {
 165   // Is it embedded in the same function?  (This could be false if LHS
 166   // is a constant or global!)
 167   if (I1.getOpcode() != I2->getOpcode() ||
 168       I1.getParent()->getParent() != I2->getParent()->getParent())
 169     return false;
 170
 171   // If they are CmpInst instructions, check their predicates
 172   if (CmpInst *CI1 = dyn_cast<CmpInst>(&const_cast<Instruction&>(I1)))
 173     if (CI1->getPredicate() != cast<CmpInst>(I2)->getPredicate())
 174       return false;
 175
 176   // They are identical if both operands are the same!
 177   if (I1.getOperand(0) == I2->getOperand(0) &&
 178       I1.getOperand(1) == I2->getOperand(1))
 179     return true;
 180
 181   // If the instruction is commutative, the instruction can match if the
 182   // operands are swapped!
 183   //
 184   if ((I1.getOperand(0) == I2->getOperand(1) &&
 185        I1.getOperand(1) == I2->getOperand(0)) &&
 186       I1.isCommutative())
 187     return true;
 188
 189   return false;
 190 }
 191
 192 // isIdenticalTernaryInst - Return true if the two ternary instructions are
 193 // identical.
 194 //
 195 static inline bool isIdenticalTernaryInst(const Instruction &I1,
 196                                           const Instruction *I2) {
 197   // Is it embedded in the same function?  (This could be false if LHS
 198   // is a constant or global!)
 199   if (I1.getParent()->getParent() != I2->getParent()->getParent())
 200     return false;
 201
 202   // They are identical if all operands are the same!
 203   return I1.getOperand(0) == I2->getOperand(0) &&
 204          I1.getOperand(1) == I2->getOperand(1) &&
 205          I1.getOperand(2) == I2->getOperand(2);
 206 }
 207
 208
 209
 210 void BVNImpl::handleBinaryInst(Instruction &I) {
 211   Value *LHS = I.getOperand(0);
 212
 213   for (Value::use_iterator UI = LHS->use_begin(), UE = LHS->use_end();
 214        UI != UE; ++UI)
 215     if (Instruction *Other = dyn_cast<Instruction>(*UI))
 216       // Check to see if this new binary operator is not I, but same operand...
 217       if (Other != &I && isIdenticalBinaryInst(I, Other)) {
 218         // These instructions are identical.  Handle the situation.
 219         RetVals.push_back(Other);
 220       }
 221 }
 222
 223 // IdenticalComplexInst - Return true if the two instructions are the same, by
 224 // using a brute force comparison.  This is useful for instructions with an
 225 // arbitrary number of arguments.
 226 //
 227 static inline bool IdenticalComplexInst(const Instruction *I1,
 228                                         const Instruction *I2) {
 229   assert(I1->getOpcode() == I2->getOpcode());
 230   // Equal if they are in the same function...
 231   return I1->getParent()->getParent() == I2->getParent()->getParent() &&
 232     // And return the same type...
 233     I1->getType() == I2->getType() &&
 234     // And have the same number of operands...
 235     I1->getNumOperands() == I2->getNumOperands() &&
 236     // And all of the operands are equal.
 237     std::equal(I1->op_begin(), I1->op_end(), I2->op_begin());
 238 }
 239
 240 void BVNImpl::visitGetElementPtrInst(GetElementPtrInst &I) {
 241   Value *Op = I.getOperand(0);
 242
 243   // Try to pick a local operand if possible instead of a constant or a global
 244   // that might have a lot of uses.
 245   for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
 246     if (isa<Instruction>(I.getOperand(i)) || isa<Argument>(I.getOperand(i))) {
 247       Op = I.getOperand(i);
 248       break;
 249     }
 250
 251   for (Value::use_iterator UI = Op->use_begin(), UE = Op->use_end();
 252        UI != UE; ++UI)
 253     if (GetElementPtrInst *Other = dyn_cast<GetElementPtrInst>(*UI))
 254       // Check to see if this new getelementptr is not I, but same operand...
 255       if (Other != &I && IdenticalComplexInst(&I, Other)) {
 256         // These instructions are identical.  Handle the situation.
 257         RetVals.push_back(Other);
 258       }
 259 }
 260
 261 void BVNImpl::handleTernaryInst(Instruction &I) {
 262   Value *Op0 = I.getOperand(0);
 263   Instruction *OtherInst;
 264
 265   for (Value::use_iterator UI = Op0->use_begin(), UE = Op0->use_end();
 266        UI != UE; ++UI)
 267     if ((OtherInst = dyn_cast<Instruction>(*UI)) &&
 268         OtherInst->getOpcode() == I.getOpcode()) {
 269       // Check to see if this new select is not I, but has the same operands.
 270       if (OtherInst != &I && isIdenticalTernaryInst(I, OtherInst)) {
 271         // These instructions are identical.  Handle the situation.
 272         RetVals.push_back(OtherInst);
 273       }
 274
 275     }
 276 }
 277
 278
 279 // Ensure that users of ValueNumbering.h will link with this file
 280 DEFINING_FILE_FOR(BasicValueNumbering)