lib/Transforms/Scalar/InstructionCombining.cpp

   1 //===- InstructionCombining.cpp - Combine multiple instructions -----------===//
   2 //
   3 // InstructionCombining - Combine instructions to form fewer, simple
   4 // instructions.  This pass does not modify the CFG This pass is where algebraic
   5 // simplification happens.
   6 //
   7 // This pass combines things like:
   8 //    %Y = add int 1, %X
   9 //    %Z = add int 1, %Y
  10 // into:
  11 //    %Z = add int 2, %X
  12 //
  13 // This is a simple worklist driven algorithm.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Transforms/Scalar.h"
  18 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  19 #include "llvm/Transforms/Utils/Local.h"
  20 #include "llvm/ConstantHandling.h"
  21 #include "llvm/iMemory.h"
  22 #include "llvm/iOther.h"
  23 #include "llvm/iPHINode.h"
  24 #include "llvm/iOperators.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/DerivedTypes.h"
  27 #include "llvm/Support/InstIterator.h"
  28 #include "llvm/Support/InstVisitor.h"
  29 #include "Support/Statistic.h"
  30 #include <algorithm>
  31
  32 namespace {
  33   Statistic<> NumCombined ("instcombine", "Number of insts combined");
  34   Statistic<> NumConstProp("instcombine", "Number of constant folds");
  35   Statistic<> NumDeadInst ("instcombine", "Number of dead inst eliminated");
  36
  37   class InstCombiner : public FunctionPass,
  38                        public InstVisitor<InstCombiner, Instruction*> {
  39     // Worklist of all of the instructions that need to be simplified.
  40     std::vector<Instruction*> WorkList;
  41
  42     void AddUsesToWorkList(Instruction &I) {
  43       // The instruction was simplified, add all users of the instruction to
  44       // the work lists because they might get more simplified now...
  45       //
  46       for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
  47            UI != UE; ++UI)
  48         WorkList.push_back(cast<Instruction>(*UI));
  49     }
  50
  51     // removeFromWorkList - remove all instances of I from the worklist.
  52     void removeFromWorkList(Instruction *I);
  53   public:
  54     virtual bool runOnFunction(Function &F);
  55
  56     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  57       AU.setPreservesCFG();
  58     }
  59
  60     // Visitation implementation - Implement instruction combining for different
  61     // instruction types.  The semantics are as follows:
  62     // Return Value:
  63     //    null        - No change was made
  64     //     I          - Change was made, I is still valid, I may be dead though
  65     //   otherwise    - Change was made, replace I with returned instruction
  66     //
  67     Instruction *visitAdd(BinaryOperator &I);
  68     Instruction *visitSub(BinaryOperator &I);
  69     Instruction *visitMul(BinaryOperator &I);
  70     Instruction *visitDiv(BinaryOperator &I);
  71     Instruction *visitRem(BinaryOperator &I);
  72     Instruction *visitAnd(BinaryOperator &I);
  73     Instruction *visitOr (BinaryOperator &I);
  74     Instruction *visitXor(BinaryOperator &I);
  75     Instruction *visitSetCondInst(BinaryOperator &I);
  76     Instruction *visitShiftInst(Instruction &I);
  77     Instruction *visitCastInst(CastInst &CI);
  78     Instruction *visitPHINode(PHINode &PN);
  79     Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
  80     Instruction *visitAllocationInst(AllocationInst &AI);
  81
  82     // visitInstruction - Specify what to return for unhandled instructions...
  83     Instruction *visitInstruction(Instruction &I) { return 0; }
  84
  85     // InsertNewInstBefore - insert an instruction New before instruction Old
  86     // in the program.  Add the new instruction to the worklist.
  87     //
  88     void InsertNewInstBefore(Instruction *New, Instruction &Old) {
  89       assert(New && New->getParent() == 0 &&
  90              "New instruction already inserted into a basic block!");
  91       BasicBlock *BB = Old.getParent();
  92       BB->getInstList().insert(&Old, New);  // Insert inst
  93       WorkList.push_back(New);              // Add to worklist
  94     }
  95
  96     // ReplaceInstUsesWith - This method is to be used when an instruction is
  97     // found to be dead, replacable with another preexisting expression.  Here
  98     // we add all uses of I to the worklist, replace all uses of I with the new
  99     // value, then return I, so that the inst combiner will know that I was
 100     // modified.
 101     //
 102     Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
 103       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 104       I.replaceAllUsesWith(V);
 105       return &I;
 106     }
 107   };
 108
 109   RegisterOpt<InstCombiner> X("instcombine", "Combine redundant instructions");
 110 }
 111
 112
 113 // Make sure that this instruction has a constant on the right hand side if it
 114 // has any constant arguments.  If not, fix it an return true.
 115 //
 116 static bool SimplifyBinOp(BinaryOperator &I) {
 117   if (isa<Constant>(I.getOperand(0)) && !isa<Constant>(I.getOperand(1)))
 118     return !I.swapOperands();
 119   return false;
 120 }
 121
 122 // dyn_castNegInst - Given a 'sub' instruction, return the RHS of the
 123 // instruction if the LHS is a constant zero (which is the 'negate' form).
 124 //
 125 static inline Value *dyn_castNegInst(Value *V) {
 126   return BinaryOperator::isNeg(V) ?
 127     BinaryOperator::getNegArgument(cast<BinaryOperator>(V)) : 0;
 128 }
 129
 130 static inline Value *dyn_castNotInst(Value *V) {
 131   return BinaryOperator::isNot(V) ?
 132     BinaryOperator::getNotArgument(cast<BinaryOperator>(V)) : 0;
 133 }
 134
 135
 136 // Log2 - Calculate the log base 2 for the specified value if it is exactly a
 137 // power of 2.
 138 static unsigned Log2(uint64_t Val) {
 139   assert(Val > 1 && "Values 0 and 1 should be handled elsewhere!");
 140   unsigned Count = 0;
 141   while (Val != 1) {
 142     if (Val & 1) return 0;    // Multiple bits set?
 143     Val >>= 1;
 144     ++Count;
 145   }
 146   return Count;
 147 }
 148
 149 static inline Value *dyn_castFoldableMul(Value *V) {
 150   if (V->use_size() == 1 && V->getType()->isInteger())
 151     if (Instruction *I = dyn_cast<Instruction>(V))
 152       if (I->getOpcode() == Instruction::Mul)
 153         if (isa<Constant>(I->getOperand(1)))
 154           return I->getOperand(0);
 155   return 0;
 156 }
 157
 158
 159 Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
 160   bool Changed = SimplifyBinOp(I);
 161   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
 162
 163   // Eliminate 'add int %X, 0'
 164   if (RHS == Constant::getNullValue(I.getType()))
 165     return ReplaceInstUsesWith(I, LHS);
 166
 167   // -A + B  -->  B - A
 168   if (Value *V = dyn_castNegInst(LHS))
 169     return BinaryOperator::create(Instruction::Sub, RHS, V);
 170
 171   // A + -B  -->  A - B
 172   if (Value *V = dyn_castNegInst(RHS))
 173     return BinaryOperator::create(Instruction::Sub, LHS, V);
 174
 175   // Simplify add instructions with a constant RHS...
 176   if (Constant *Op2 = dyn_cast<Constant>(RHS)) {
 177     if (BinaryOperator *ILHS = dyn_cast<BinaryOperator>(LHS)) {
 178       if (ILHS->getOpcode() == Instruction::Add &&
 179           isa<Constant>(ILHS->getOperand(1))) {
 180         // Fold:
 181         //    %Y = add int %X, 1
 182         //    %Z = add int %Y, 1
 183         // into:
 184         //    %Z = add int %X, 2
 185         //
 186         if (Constant *Val = *Op2 + *cast<Constant>(ILHS->getOperand(1))) {
 187           I.setOperand(0, ILHS->getOperand(0));
 188           I.setOperand(1, Val);
 189           return &I;
 190         }
 191       }
 192     }
 193   }
 194
 195   // X*C + X --> X * (C+1)
 196   if (dyn_castFoldableMul(LHS) == RHS) {
 197     Constant *CP1 = *cast<Constant>(cast<Instruction>(LHS)->getOperand(1)) +
 198                     *ConstantInt::get(I.getType(), 1);
 199     assert(CP1 && "Couldn't constant fold C + 1?");
 200     return BinaryOperator::create(Instruction::Mul, RHS, CP1);
 201   }
 202
 203   // X + X*C --> X * (C+1)
 204   if (dyn_castFoldableMul(RHS) == LHS) {
 205     Constant *CP1 = *cast<Constant>(cast<Instruction>(RHS)->getOperand(1)) +
 206                     *ConstantInt::get(I.getType(), 1);
 207     assert(CP1 && "Couldn't constant fold C + 1?");
 208     return BinaryOperator::create(Instruction::Mul, LHS, CP1);
 209   }
 210
 211   return Changed ? &I : 0;
 212 }
 213
 214 Instruction *InstCombiner::visitSub(BinaryOperator &I) {
 215   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 216
 217   if (Op0 == Op1)         // sub X, X  -> 0
 218     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 219
 220   // If this is a subtract instruction with a constant RHS, convert it to an add
 221   // instruction of a negative constant
 222   //
 223   if (Constant *Op2 = dyn_cast<Constant>(Op1))
 224     if (Constant *RHS = *Constant::getNullValue(I.getType()) - *Op2) // 0 - RHS
 225       return BinaryOperator::create(Instruction::Add, Op0, RHS, I.getName());
 226
 227   // If this is a 'B = x-(-A)', change to B = x+A...
 228   if (Value *V = dyn_castNegInst(Op1))
 229     return BinaryOperator::create(Instruction::Add, Op0, V);
 230
 231   // Replace (-1 - A) with (~A)...
 232   if (ConstantInt *C = dyn_cast<ConstantInt>(Op0))
 233     if (C->isAllOnesValue())
 234       return BinaryOperator::createNot(Op1);
 235
 236   if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
 237     if (Op1I->use_size() == 1) {
 238       // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression
 239       // is not used by anyone else...
 240       //
 241       if (Op1I->getOpcode() == Instruction::Sub) {
 242         // Swap the two operands of the subexpr...
 243         Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
 244         Op1I->setOperand(0, IIOp1);
 245         Op1I->setOperand(1, IIOp0);
 246
 247         // Create the new top level add instruction...
 248         return BinaryOperator::create(Instruction::Add, Op0, Op1);
 249       }
 250
 251       // Replace (A - (A & B)) with (A & ~B) if this is the only use of (A&B)...
 252       //
 253       if (Op1I->getOpcode() == Instruction::And &&
 254           (Op1I->getOperand(0) == Op0 || Op1I->getOperand(1) == Op0)) {
 255         Value *OtherOp = Op1I->getOperand(Op1I->getOperand(0) == Op0);
 256
 257         Instruction *NewNot = BinaryOperator::createNot(OtherOp, "B.not", &I);
 258         return BinaryOperator::create(Instruction::And, Op0, NewNot);
 259       }
 260
 261       // X - X*C --> X * (1-C)
 262       if (dyn_castFoldableMul(Op1I) == Op0) {
 263         Constant *CP1 = *ConstantInt::get(I.getType(), 1) -
 264                         *cast<Constant>(cast<Instruction>(Op1)->getOperand(1));
 265         assert(CP1 && "Couldn't constant fold 1-C?");
 266         return BinaryOperator::create(Instruction::Mul, Op0, CP1);
 267       }
 268     }
 269
 270   // X*C - X --> X * (C-1)
 271   if (dyn_castFoldableMul(Op0) == Op1) {
 272     Constant *CP1 = *cast<Constant>(cast<Instruction>(Op0)->getOperand(1)) -
 273                     *ConstantInt::get(I.getType(), 1);
 274     assert(CP1 && "Couldn't constant fold C - 1?");
 275     return BinaryOperator::create(Instruction::Mul, Op1, CP1);
 276   }
 277
 278   return 0;
 279 }
 280
 281 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
 282   bool Changed = SimplifyBinOp(I);
 283   Value *Op0 = I.getOperand(0);
 284
 285   // Simplify mul instructions with a constant RHS...
 286   if (Constant *Op1 = dyn_cast<Constant>(I.getOperand(1))) {
 287     if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
 288       const Type *Ty = CI->getType();
 289       uint64_t Val = Ty->isSigned() ?
 290                           (uint64_t)cast<ConstantSInt>(CI)->getValue() :
 291                                     cast<ConstantUInt>(CI)->getValue();
 292       switch (Val) {
 293       case 0:
 294         return ReplaceInstUsesWith(I, Op1);  // Eliminate 'mul double %X, 0'
 295       case 1:
 296         return ReplaceInstUsesWith(I, Op0);  // Eliminate 'mul int %X, 1'
 297       case 2:                     // Convert 'mul int %X, 2' to 'add int %X, %X'
 298         return BinaryOperator::create(Instruction::Add, Op0, Op0, I.getName());
 299       }
 300
 301       if (uint64_t C = Log2(Val))            // Replace X*(2^C) with X << C
 302         return new ShiftInst(Instruction::Shl, Op0,
 303                              ConstantUInt::get(Type::UByteTy, C));
 304     } else {
 305       ConstantFP *Op1F = cast<ConstantFP>(Op1);
 306       if (Op1F->isNullValue())
 307         return ReplaceInstUsesWith(I, Op1);
 308
 309       // "In IEEE floating point, x*1 is not equivalent to x for nans.  However,
 310       // ANSI says we can drop signals, so we can do this anyway." (from GCC)
 311       if (Op1F->getValue() == 1.0)
 312         return ReplaceInstUsesWith(I, Op0);  // Eliminate 'mul double %X, 1.0'
 313     }
 314   }
 315
 316   return Changed ? &I : 0;
 317 }
 318
 319 Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
 320   // div X, 1 == X
 321   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
 322     if (RHS->equalsInt(1))
 323       return ReplaceInstUsesWith(I, I.getOperand(0));
 324
 325     // Check to see if this is an unsigned division with an exact power of 2,
 326     // if so, convert to a right shift.
 327     if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
 328       if (uint64_t Val = C->getValue())    // Don't break X / 0
 329         if (uint64_t C = Log2(Val))
 330           return new ShiftInst(Instruction::Shr, I.getOperand(0),
 331                                ConstantUInt::get(Type::UByteTy, C));
 332   }
 333
 334   // 0 / X == 0, we don't need to preserve faults!
 335   if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
 336     if (LHS->equalsInt(0))
 337       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 338
 339   return 0;
 340 }
 341
 342
 343 Instruction *InstCombiner::visitRem(BinaryOperator &I) {
 344   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
 345     if (RHS->equalsInt(1))  // X % 1 == 0
 346       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 347
 348     // Check to see if this is an unsigned remainder with an exact power of 2,
 349     // if so, convert to a bitwise and.
 350     if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
 351       if (uint64_t Val = C->getValue())    // Don't break X % 0 (divide by zero)
 352         if (Log2(Val))
 353           return BinaryOperator::create(Instruction::And, I.getOperand(0),
 354                                         ConstantUInt::get(I.getType(), Val-1));
 355   }
 356
 357   // 0 % X == 0, we don't need to preserve faults!
 358   if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
 359     if (LHS->equalsInt(0))
 360       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 361
 362   return 0;
 363 }
 364
 365 // isMaxValueMinusOne - return true if this is Max-1
 366 static bool isMaxValueMinusOne(const ConstantInt *C) {
 367   if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C)) {
 368     // Calculate -1 casted to the right type...
 369     unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 370     uint64_t Val = ~0ULL;                // All ones
 371     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 372     return CU->getValue() == Val-1;
 373   }
 374
 375   const ConstantSInt *CS = cast<ConstantSInt>(C);
 376
 377   // Calculate 0111111111..11111
 378   unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 379   int64_t Val = INT64_MAX;             // All ones
 380   Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 381   return CS->getValue() == Val-1;
 382 }
 383
 384 // isMinValuePlusOne - return true if this is Min+1
 385 static bool isMinValuePlusOne(const ConstantInt *C) {
 386   if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C))
 387     return CU->getValue() == 1;
 388
 389   const ConstantSInt *CS = cast<ConstantSInt>(C);
 390
 391   // Calculate 1111111111000000000000
 392   unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 393   int64_t Val = -1;                    // All ones
 394   Val <<= TypeBits-1;                  // Shift over to the right spot
 395   return CS->getValue() == Val+1;
 396 }
 397
 398
 399 Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
 400   bool Changed = SimplifyBinOp(I);
 401   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 402
 403   // and X, X = X   and X, 0 == 0
 404   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
 405     return ReplaceInstUsesWith(I, Op1);
 406
 407   // and X, -1 == X
 408   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1))
 409     if (RHS->isAllOnesValue())
 410       return ReplaceInstUsesWith(I, Op0);
 411
 412   Value *Op0NotVal = dyn_castNotInst(Op0);
 413   Value *Op1NotVal = dyn_castNotInst(Op1);
 414
 415   // (~A & ~B) == (~(A | B)) - Demorgan's Law
 416   if (Op0->use_size() == 1 && Op1->use_size() == 1 && Op0NotVal && Op1NotVal) {
 417     Instruction *Or = BinaryOperator::create(Instruction::Or, Op0NotVal,
 418                                              Op1NotVal,I.getName()+".demorgan",
 419                                              &I);
 420     return BinaryOperator::createNot(Or);
 421   }
 422
 423   if (Op0NotVal == Op1 || Op1NotVal == Op0)  // A & ~A  == ~A & A == 0
 424     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 425
 426   return Changed ? &I : 0;
 427 }
 428
 429
 430
 431 Instruction *InstCombiner::visitOr(BinaryOperator &I) {
 432   bool Changed = SimplifyBinOp(I);
 433   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 434
 435   // or X, X = X   or X, 0 == X
 436   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
 437     return ReplaceInstUsesWith(I, Op0);
 438
 439   // or X, -1 == -1
 440   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1))
 441     if (RHS->isAllOnesValue())
 442       return ReplaceInstUsesWith(I, Op1);
 443
 444   if (Value *X = dyn_castNotInst(Op0))   // ~A | A == -1
 445     if (X == Op1)
 446       return ReplaceInstUsesWith(I,
 447                             ConstantIntegral::getAllOnesValue(I.getType()));
 448
 449   if (Value *X = dyn_castNotInst(Op1))   // A | ~A == -1
 450     if (X == Op0)
 451       return ReplaceInstUsesWith(I,
 452                             ConstantIntegral::getAllOnesValue(I.getType()));
 453
 454   return Changed ? &I : 0;
 455 }
 456
 457
 458
 459 Instruction *InstCombiner::visitXor(BinaryOperator &I) {
 460   bool Changed = SimplifyBinOp(I);
 461   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 462
 463   // xor X, X = 0
 464   if (Op0 == Op1)
 465     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 466
 467   if (ConstantIntegral *Op1C = dyn_cast<ConstantIntegral>(Op1)) {
 468     // xor X, 0 == X
 469     if (Op1C->isNullValue())
 470       return ReplaceInstUsesWith(I, Op0);
 471
 472     // Is this a "NOT" instruction?
 473     if (Op1C->isAllOnesValue()) {
 474       // xor (xor X, -1), -1 = not (not X) = X
 475       if (Value *X = dyn_castNotInst(Op0))
 476         return ReplaceInstUsesWith(I, X);
 477
 478       // xor (setcc A, B), true = not (setcc A, B) = setncc A, B
 479       if (SetCondInst *SCI = dyn_cast<SetCondInst>(Op0))
 480         if (SCI->use_size() == 1)
 481           return new SetCondInst(SCI->getInverseCondition(),
 482                                  SCI->getOperand(0), SCI->getOperand(1));
 483     }
 484   }
 485
 486   if (Value *X = dyn_castNotInst(Op0))   // ~A ^ A == -1
 487     if (X == Op1)
 488       return ReplaceInstUsesWith(I,
 489                                 ConstantIntegral::getAllOnesValue(I.getType()));
 490
 491   if (Value *X = dyn_castNotInst(Op1))   // A ^ ~A == -1
 492     if (X == Op0)
 493       return ReplaceInstUsesWith(I,
 494                                 ConstantIntegral::getAllOnesValue(I.getType()));
 495
 496
 497
 498   if (Instruction *Op1I = dyn_cast<Instruction>(Op1))
 499     if (Op1I->getOpcode() == Instruction::Or)
 500       if (Op1I->getOperand(0) == Op0) {              // B^(B|A) == (A|B)^B
 501         cast<BinaryOperator>(Op1I)->swapOperands();
 502         I.swapOperands();
 503         std::swap(Op0, Op1);
 504       } else if (Op1I->getOperand(1) == Op0) {       // B^(A|B) == (A|B)^B
 505         I.swapOperands();
 506         std::swap(Op0, Op1);
 507       }
 508
 509   if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
 510     if (Op0I->getOpcode() == Instruction::Or && Op0I->use_size() == 1) {
 511       if (Op0I->getOperand(0) == Op1)                // (B|A)^B == (A|B)^B
 512         cast<BinaryOperator>(Op0I)->swapOperands();
 513       if (Op0I->getOperand(1) == Op1) {              // (A|B)^B == A & ~B
 514         Value *NotB = BinaryOperator::createNot(Op1, Op1->getName()+".not", &I);
 515         WorkList.push_back(cast<Instruction>(NotB));
 516         return BinaryOperator::create(Instruction::And, Op0I->getOperand(0),
 517                                       NotB);
 518       }
 519     }
 520
 521   return Changed ? &I : 0;
 522 }
 523
 524 // AddOne, SubOne - Add or subtract a constant one from an integer constant...
 525 static Constant *AddOne(ConstantInt *C) {
 526   Constant *Result = *C + *ConstantInt::get(C->getType(), 1);
 527   assert(Result && "Constant folding integer addition failed!");
 528   return Result;
 529 }
 530 static Constant *SubOne(ConstantInt *C) {
 531   Constant *Result = *C - *ConstantInt::get(C->getType(), 1);
 532   assert(Result && "Constant folding integer addition failed!");
 533   return Result;
 534 }
 535
 536 // isTrueWhenEqual - Return true if the specified setcondinst instruction is
 537 // true when both operands are equal...
 538 //
 539 static bool isTrueWhenEqual(Instruction &I) {
 540   return I.getOpcode() == Instruction::SetEQ ||
 541          I.getOpcode() == Instruction::SetGE ||
 542          I.getOpcode() == Instruction::SetLE;
 543 }
 544
 545 Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
 546   bool Changed = SimplifyBinOp(I);
 547   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 548   const Type *Ty = Op0->getType();
 549
 550   // setcc X, X
 551   if (Op0 == Op1)
 552     return ReplaceInstUsesWith(I, ConstantBool::get(isTrueWhenEqual(I)));
 553
 554   // setcc <global*>, 0 - Global value addresses are never null!
 555   if (isa<GlobalValue>(Op0) && isa<ConstantPointerNull>(Op1))
 556     return ReplaceInstUsesWith(I, ConstantBool::get(!isTrueWhenEqual(I)));
 557
 558   // setcc's with boolean values can always be turned into bitwise operations
 559   if (Ty == Type::BoolTy) {
 560     // If this is <, >, or !=, we can change this into a simple xor instruction
 561     if (!isTrueWhenEqual(I))
 562       return BinaryOperator::create(Instruction::Xor, Op0, Op1, I.getName());
 563
 564     // Otherwise we need to make a temporary intermediate instruction and insert
 565     // it into the instruction stream.  This is what we are after:
 566     //
 567     //  seteq bool %A, %B -> ~(A^B)
 568     //  setle bool %A, %B -> ~A | B
 569     //  setge bool %A, %B -> A | ~B
 570     //
 571     if (I.getOpcode() == Instruction::SetEQ) {  // seteq case
 572       Instruction *Xor = BinaryOperator::create(Instruction::Xor, Op0, Op1,
 573                                                 I.getName()+"tmp");
 574       InsertNewInstBefore(Xor, I);
 575       return BinaryOperator::createNot(Xor, I.getName());
 576     }
 577
 578     // Handle the setXe cases...
 579     assert(I.getOpcode() == Instruction::SetGE ||
 580            I.getOpcode() == Instruction::SetLE);
 581
 582     if (I.getOpcode() == Instruction::SetGE)
 583       std::swap(Op0, Op1);                   // Change setge -> setle
 584
 585     // Now we just have the SetLE case.
 586     Instruction *Not = BinaryOperator::createNot(Op0, I.getName()+"tmp");
 587     InsertNewInstBefore(Not, I);
 588     return BinaryOperator::create(Instruction::Or, Not, Op1, I.getName());
 589   }
 590
 591   // Check to see if we are doing one of many comparisons against constant
 592   // integers at the end of their ranges...
 593   //
 594   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
 595     // Check to see if we are comparing against the minimum or maximum value...
 596     if (CI->isMinValue()) {
 597       if (I.getOpcode() == Instruction::SetLT)       // A < MIN -> FALSE
 598         return ReplaceInstUsesWith(I, ConstantBool::False);
 599       if (I.getOpcode() == Instruction::SetGE)       // A >= MIN -> TRUE
 600         return ReplaceInstUsesWith(I, ConstantBool::True);
 601       if (I.getOpcode() == Instruction::SetLE)       // A <= MIN -> A == MIN
 602         return BinaryOperator::create(Instruction::SetEQ, Op0,Op1, I.getName());
 603       if (I.getOpcode() == Instruction::SetGT)       // A > MIN -> A != MIN
 604         return BinaryOperator::create(Instruction::SetNE, Op0,Op1, I.getName());
 605
 606     } else if (CI->isMaxValue()) {
 607       if (I.getOpcode() == Instruction::SetGT)       // A > MAX -> FALSE
 608         return ReplaceInstUsesWith(I, ConstantBool::False);
 609       if (I.getOpcode() == Instruction::SetLE)       // A <= MAX -> TRUE
 610         return ReplaceInstUsesWith(I, ConstantBool::True);
 611       if (I.getOpcode() == Instruction::SetGE)       // A >= MAX -> A == MAX
 612         return BinaryOperator::create(Instruction::SetEQ, Op0,Op1, I.getName());
 613       if (I.getOpcode() == Instruction::SetLT)       // A < MAX -> A != MAX
 614         return BinaryOperator::create(Instruction::SetNE, Op0,Op1, I.getName());
 615
 616       // Comparing against a value really close to min or max?
 617     } else if (isMinValuePlusOne(CI)) {
 618       if (I.getOpcode() == Instruction::SetLT)       // A < MIN+1 -> A == MIN
 619         return BinaryOperator::create(Instruction::SetEQ, Op0,
 620                                       SubOne(CI), I.getName());
 621       if (I.getOpcode() == Instruction::SetGE)       // A >= MIN-1 -> A != MIN
 622         return BinaryOperator::create(Instruction::SetNE, Op0,
 623                                       SubOne(CI), I.getName());
 624
 625     } else if (isMaxValueMinusOne(CI)) {
 626       if (I.getOpcode() == Instruction::SetGT)       // A > MAX-1 -> A == MAX
 627         return BinaryOperator::create(Instruction::SetEQ, Op0,
 628                                       AddOne(CI), I.getName());
 629       if (I.getOpcode() == Instruction::SetLE)       // A <= MAX-1 -> A != MAX
 630         return BinaryOperator::create(Instruction::SetNE, Op0,
 631                                       AddOne(CI), I.getName());
 632     }
 633   }
 634
 635   return Changed ? &I : 0;
 636 }
 637
 638
 639
 640 Instruction *InstCombiner::visitShiftInst(Instruction &I) {
 641   assert(I.getOperand(1)->getType() == Type::UByteTy);
 642   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 643
 644   // shl X, 0 == X and shr X, 0 == X
 645   // shl 0, X == 0 and shr 0, X == 0
 646   if (Op1 == Constant::getNullValue(Type::UByteTy) ||
 647       Op0 == Constant::getNullValue(Op0->getType()))
 648     return ReplaceInstUsesWith(I, Op0);
 649
 650   // shl uint X, 32 = 0 and shr ubyte Y, 9 = 0, ... just don't eliminate shr of
 651   // a signed value.
 652   //
 653   if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
 654     if (I.getOpcode() == Instruction::Shr) {
 655       unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
 656       if (CUI->getValue() >= TypeBits && !(Op0->getType()->isSigned()))
 657         return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
 658     }
 659
 660     // Check to see if we are shifting left by 1.  If so, turn it into an add
 661     // instruction.
 662     if (I.getOpcode() == Instruction::Shl && CUI->equalsInt(1))
 663       // Convert 'shl int %X, 1' to 'add int %X, %X'
 664       return BinaryOperator::create(Instruction::Add, Op0, Op0, I.getName());
 665
 666   }
 667
 668   // shr int -1, X = -1   (for any arithmetic shift rights of ~0)
 669   if (ConstantSInt *CSI = dyn_cast<ConstantSInt>(Op0))
 670     if (I.getOpcode() == Instruction::Shr && CSI->isAllOnesValue())
 671       return ReplaceInstUsesWith(I, CSI);
 672
 673   return 0;
 674 }
 675
 676
 677 // isEliminableCastOfCast - Return true if it is valid to eliminate the CI
 678 // instruction.
 679 //
 680 static inline bool isEliminableCastOfCast(const CastInst &CI,
 681                                           const CastInst *CSrc) {
 682   assert(CI.getOperand(0) == CSrc);
 683   const Type *SrcTy = CSrc->getOperand(0)->getType();
 684   const Type *MidTy = CSrc->getType();
 685   const Type *DstTy = CI.getType();
 686
 687   // It is legal to eliminate the instruction if casting A->B->A if the sizes
 688   // are identical and the bits don't get reinterpreted (for example
 689   // int->float->int would not be allowed)
 690   if (SrcTy == DstTy && SrcTy->isLosslesslyConvertableTo(MidTy))
 691     return true;
 692
 693   // Allow free casting and conversion of sizes as long as the sign doesn't
 694   // change...
 695   if (SrcTy->isIntegral() && MidTy->isIntegral() && DstTy->isIntegral()) {
 696     unsigned SrcSize = SrcTy->getPrimitiveSize();
 697     unsigned MidSize = MidTy->getPrimitiveSize();
 698     unsigned DstSize = DstTy->getPrimitiveSize();
 699
 700     // Cases where we are monotonically decreasing the size of the type are
 701     // always ok, regardless of what sign changes are going on.
 702     //
 703     if (SrcSize >= MidSize && MidSize >= DstSize)
 704       return true;
 705
 706     // Cases where the source and destination type are the same, but the middle
 707     // type is bigger are noops.
 708     //
 709     if (SrcSize == DstSize && MidSize > SrcSize)
 710       return true;
 711
 712     // If we are monotonically growing, things are more complex.
 713     //
 714     if (SrcSize <= MidSize && MidSize <= DstSize) {
 715       // We have eight combinations of signedness to worry about. Here's the
 716       // table:
 717       static const int SignTable[8] = {
 718         // CODE, SrcSigned, MidSigned, DstSigned, Comment
 719         1,     //   U          U          U       Always ok
 720         1,     //   U          U          S       Always ok
 721         3,     //   U          S          U       Ok iff SrcSize != MidSize
 722         3,     //   U          S          S       Ok iff SrcSize != MidSize
 723         0,     //   S          U          U       Never ok
 724         2,     //   S          U          S       Ok iff MidSize == DstSize
 725         1,     //   S          S          U       Always ok
 726         1,     //   S          S          S       Always ok
 727       };
 728
 729       // Choose an action based on the current entry of the signtable that this
 730       // cast of cast refers to...
 731       unsigned Row = SrcTy->isSigned()*4+MidTy->isSigned()*2+DstTy->isSigned();
 732       switch (SignTable[Row]) {
 733       case 0: return false;              // Never ok
 734       case 1: return true;               // Always ok
 735       case 2: return MidSize == DstSize; // Ok iff MidSize == DstSize
 736       case 3:                            // Ok iff SrcSize != MidSize
 737         return SrcSize != MidSize || SrcTy == Type::BoolTy;
 738       default: assert(0 && "Bad entry in sign table!");
 739       }
 740     }
 741   }
 742
 743   // Otherwise, we cannot succeed.  Specifically we do not want to allow things
 744   // like:  short -> ushort -> uint, because this can create wrong results if
 745   // the input short is negative!
 746   //
 747   return false;
 748 }
 749
 750
 751 // CastInst simplification
 752 //
 753 Instruction *InstCombiner::visitCastInst(CastInst &CI) {
 754   // If the user is casting a value to the same type, eliminate this cast
 755   // instruction...
 756   if (CI.getType() == CI.getOperand(0)->getType())
 757     return ReplaceInstUsesWith(CI, CI.getOperand(0));
 758
 759   // If casting the result of another cast instruction, try to eliminate this
 760   // one!
 761   //
 762   if (CastInst *CSrc = dyn_cast<CastInst>(CI.getOperand(0))) {
 763     if (isEliminableCastOfCast(CI, CSrc)) {
 764       // This instruction now refers directly to the cast's src operand.  This
 765       // has a good chance of making CSrc dead.
 766       CI.setOperand(0, CSrc->getOperand(0));
 767       return &CI;
 768     }
 769
 770     // If this is an A->B->A cast, and we are dealing with integral types, try
 771     // to convert this into a logical 'and' instruction.
 772     //
 773     if (CSrc->getOperand(0)->getType() == CI.getType() &&
 774         CI.getType()->isInteger() && CSrc->getType()->isInteger() &&
 775         CI.getType()->isUnsigned() && CSrc->getType()->isUnsigned() &&
 776         CSrc->getType()->getPrimitiveSize() < CI.getType()->getPrimitiveSize()){
 777       assert(CSrc->getType() != Type::ULongTy &&
 778              "Cannot have type bigger than ulong!");
 779       unsigned AndValue = (1U << CSrc->getType()->getPrimitiveSize()*8)-1;
 780       Constant *AndOp = ConstantUInt::get(CI.getType(), AndValue);
 781       return BinaryOperator::create(Instruction::And, CSrc->getOperand(0),
 782                                     AndOp);
 783     }
 784   }
 785
 786   return 0;
 787 }
 788
 789
 790 // PHINode simplification
 791 //
 792 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
 793   // If the PHI node only has one incoming value, eliminate the PHI node...
 794   if (PN.getNumIncomingValues() == 1)
 795     return ReplaceInstUsesWith(PN, PN.getIncomingValue(0));
 796
 797   // Otherwise if all of the incoming values are the same for the PHI, replace
 798   // the PHI node with the incoming value.
 799   //
 800   Value *InVal = 0;
 801   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 802     if (PN.getIncomingValue(i) != &PN)  // Not the PHI node itself...
 803       if (InVal && PN.getIncomingValue(i) != InVal)
 804         return 0;  // Not the same, bail out.
 805       else
 806         InVal = PN.getIncomingValue(i);
 807
 808   // The only case that could cause InVal to be null is if we have a PHI node
 809   // that only has entries for itself.  In this case, there is no entry into the
 810   // loop, so kill the PHI.
 811   //
 812   if (InVal == 0) InVal = Constant::getNullValue(PN.getType());
 813
 814   // All of the incoming values are the same, replace the PHI node now.
 815   return ReplaceInstUsesWith(PN, InVal);
 816 }
 817
 818
 819 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 820   // Is it 'getelementptr %P, uint 0'  or 'getelementptr %P'
 821   // If so, eliminate the noop.
 822   if ((GEP.getNumOperands() == 2 &&
 823        GEP.getOperand(1) == Constant::getNullValue(Type::LongTy)) ||
 824       GEP.getNumOperands() == 1)
 825     return ReplaceInstUsesWith(GEP, GEP.getOperand(0));
 826
 827   // Combine Indices - If the source pointer to this getelementptr instruction
 828   // is a getelementptr instruction, combine the indices of the two
 829   // getelementptr instructions into a single instruction.
 830   //
 831   if (GetElementPtrInst *Src = dyn_cast<GetElementPtrInst>(GEP.getOperand(0))) {
 832     std::vector<Value *> Indices;
 833
 834     // Can we combine the two pointer arithmetics offsets?
 835      if (Src->getNumOperands() == 2 && isa<Constant>(Src->getOperand(1)) &&
 836          isa<Constant>(GEP.getOperand(1))) {
 837       // Replace: gep (gep %P, long C1), long C2, ...
 838       // With:    gep %P, long (C1+C2), ...
 839       Value *Sum = *cast<Constant>(Src->getOperand(1)) +
 840                    *cast<Constant>(GEP.getOperand(1));
 841       assert(Sum && "Constant folding of longs failed!?");
 842       GEP.setOperand(0, Src->getOperand(0));
 843       GEP.setOperand(1, Sum);
 844       AddUsesToWorkList(*Src);   // Reduce use count of Src
 845       return &GEP;
 846     } else if (Src->getNumOperands() == 2 && Src->use_size() == 1) {
 847       // Replace: gep (gep %P, long B), long A, ...
 848       // With:    T = long A+B; gep %P, T, ...
 849       //
 850       Value *Sum = BinaryOperator::create(Instruction::Add, Src->getOperand(1),
 851                                           GEP.getOperand(1),
 852                                           Src->getName()+".sum", &GEP);
 853       GEP.setOperand(0, Src->getOperand(0));
 854       GEP.setOperand(1, Sum);
 855       WorkList.push_back(cast<Instruction>(Sum));
 856       return &GEP;
 857     } else if (*GEP.idx_begin() == Constant::getNullValue(Type::LongTy) &&
 858                Src->getNumOperands() != 1) {
 859       // Otherwise we can do the fold if the first index of the GEP is a zero
 860       Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
 861       Indices.insert(Indices.end(), GEP.idx_begin()+1, GEP.idx_end());
 862     } else if (Src->getOperand(Src->getNumOperands()-1) ==
 863                Constant::getNullValue(Type::LongTy)) {
 864       // If the src gep ends with a constant array index, merge this get into
 865       // it, even if we have a non-zero array index.
 866       Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end()-1);
 867       Indices.insert(Indices.end(), GEP.idx_begin(), GEP.idx_end());
 868     }
 869
 870     if (!Indices.empty())
 871       return new GetElementPtrInst(Src->getOperand(0), Indices, GEP.getName());
 872
 873   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(GEP.getOperand(0))) {
 874     // GEP of global variable.  If all of the indices for this GEP are
 875     // constants, we can promote this to a constexpr instead of an instruction.
 876
 877     // Scan for nonconstants...
 878     std::vector<Constant*> Indices;
 879     User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end();
 880     for (; I != E && isa<Constant>(*I); ++I)
 881       Indices.push_back(cast<Constant>(*I));
 882
 883     if (I == E) {  // If they are all constants...
 884       ConstantExpr *CE =
 885         ConstantExpr::getGetElementPtr(ConstantPointerRef::get(GV), Indices);
 886
 887       // Replace all uses of the GEP with the new constexpr...
 888       return ReplaceInstUsesWith(GEP, CE);
 889     }
 890   }
 891
 892   return 0;
 893 }
 894
 895 Instruction *InstCombiner::visitAllocationInst(AllocationInst &AI) {
 896   // Convert: malloc Ty, C - where C is a constant != 1 into: malloc [C x Ty], 1
 897   if (AI.isArrayAllocation())    // Check C != 1
 898     if (const ConstantUInt *C = dyn_cast<ConstantUInt>(AI.getArraySize())) {
 899       const Type *NewTy = ArrayType::get(AI.getAllocatedType(), C->getValue());
 900       AllocationInst *New = 0;
 901
 902       // Create and insert the replacement instruction...
 903       if (isa<MallocInst>(AI))
 904         New = new MallocInst(NewTy, 0, AI.getName(), &AI);
 905       else {
 906         assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
 907         New = new AllocaInst(NewTy, 0, AI.getName(), &AI);
 908       }
 909
 910       // Scan to the end of the allocation instructions, to skip over a block of
 911       // allocas if possible...
 912       //
 913       BasicBlock::iterator It = New;
 914       while (isa<AllocationInst>(*It)) ++It;
 915
 916       // Now that I is pointing to the first non-allocation-inst in the block,
 917       // insert our getelementptr instruction...
 918       //
 919       std::vector<Value*> Idx(2, Constant::getNullValue(Type::LongTy));
 920       Value *V = new GetElementPtrInst(New, Idx, New->getName()+".sub", It);
 921
 922       // Now make everything use the getelementptr instead of the original
 923       // allocation.
 924       ReplaceInstUsesWith(AI, V);
 925       return &AI;
 926     }
 927   return 0;
 928 }
 929
 930
 931
 932 void InstCombiner::removeFromWorkList(Instruction *I) {
 933   WorkList.erase(std::remove(WorkList.begin(), WorkList.end(), I),
 934                  WorkList.end());
 935 }
 936
 937 bool InstCombiner::runOnFunction(Function &F) {
 938   bool Changed = false;
 939
 940   WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
 941
 942   while (!WorkList.empty()) {
 943     Instruction *I = WorkList.back();  // Get an instruction from the worklist
 944     WorkList.pop_back();
 945
 946     // Check to see if we can DCE or ConstantPropagate the instruction...
 947     // Check to see if we can DIE the instruction...
 948     if (isInstructionTriviallyDead(I)) {
 949       // Add operands to the worklist...
 950       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 951         if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
 952           WorkList.push_back(Op);
 953
 954       ++NumDeadInst;
 955       BasicBlock::iterator BBI = I;
 956       if (dceInstruction(BBI)) {
 957         removeFromWorkList(I);
 958         continue;
 959       }
 960     }
 961
 962     // Instruction isn't dead, see if we can constant propagate it...
 963     if (Constant *C = ConstantFoldInstruction(I)) {
 964       // Add operands to the worklist...
 965       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 966         if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
 967           WorkList.push_back(Op);
 968       ReplaceInstUsesWith(*I, C);
 969
 970       ++NumConstProp;
 971       BasicBlock::iterator BBI = I;
 972       if (dceInstruction(BBI)) {
 973         removeFromWorkList(I);
 974         continue;
 975       }
 976     }
 977
 978     // Now that we have an instruction, try combining it to simplify it...
 979     if (Instruction *Result = visit(*I)) {
 980       ++NumCombined;
 981       // Should we replace the old instruction with a new one?
 982       if (Result != I) {
 983         // Instructions can end up on the worklist more than once.  Make sure
 984         // we do not process an instruction that has been deleted.
 985         removeFromWorkList(I);
 986         ReplaceInstWithInst(I, Result);
 987       } else {
 988         BasicBlock::iterator II = I;
 989
 990         // If the instruction was modified, it's possible that it is now dead.
 991         // if so, remove it.
 992         if (dceInstruction(II)) {
 993           // Instructions may end up in the worklist more than once.  Erase them
 994           // all.
 995           removeFromWorkList(I);
 996           Result = 0;
 997         }
 998       }
 999
1000       if (Result) {
1001         WorkList.push_back(Result);
1002         AddUsesToWorkList(*Result);
1003       }
1004       Changed = true;
1005     }
1006   }
1007
1008   return Changed;
1009 }
1010
1011 Pass *createInstructionCombiningPass() {
1012   return new InstCombiner();
1013 }