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/Instructions.h"
  21 #include "llvm/Pass.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/ConstantHandling.h"
  24 #include "llvm/DerivedTypes.h"
  25 #include "llvm/GlobalVariable.h"
  26 #include "llvm/Support/InstIterator.h"
  27 #include "llvm/Support/InstVisitor.h"
  28 #include "llvm/Support/CallSite.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(ShiftInst &I);
  77     Instruction *visitCastInst(CastInst &CI);
  78     Instruction *visitCallInst(CallInst &CI);
  79     Instruction *visitInvokeInst(InvokeInst &II);
  80     Instruction *visitPHINode(PHINode &PN);
  81     Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
  82     Instruction *visitAllocationInst(AllocationInst &AI);
  83     Instruction *visitLoadInst(LoadInst &LI);
  84     Instruction *visitBranchInst(BranchInst &BI);
  85
  86     // visitInstruction - Specify what to return for unhandled instructions...
  87     Instruction *visitInstruction(Instruction &I) { return 0; }
  88
  89   private:
  90     bool transformConstExprCastCall(CallSite CS);
  91
  92     // InsertNewInstBefore - insert an instruction New before instruction Old
  93     // in the program.  Add the new instruction to the worklist.
  94     //
  95     void InsertNewInstBefore(Instruction *New, Instruction &Old) {
  96       assert(New && New->getParent() == 0 &&
  97              "New instruction already inserted into a basic block!");
  98       BasicBlock *BB = Old.getParent();
  99       BB->getInstList().insert(&Old, New);  // Insert inst
 100       WorkList.push_back(New);              // Add to worklist
 101     }
 102
 103     // ReplaceInstUsesWith - This method is to be used when an instruction is
 104     // found to be dead, replacable with another preexisting expression.  Here
 105     // we add all uses of I to the worklist, replace all uses of I with the new
 106     // value, then return I, so that the inst combiner will know that I was
 107     // modified.
 108     //
 109     Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
 110       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 111       I.replaceAllUsesWith(V);
 112       return &I;
 113     }
 114
 115     // SimplifyCommutative - This performs a few simplifications for commutative
 116     // operators...
 117     bool SimplifyCommutative(BinaryOperator &I);
 118   };
 119
 120   RegisterOpt<InstCombiner> X("instcombine", "Combine redundant instructions");
 121 }
 122
 123 // getComplexity:  Assign a complexity or rank value to LLVM Values...
 124 //   0 -> Constant, 1 -> Other, 2 -> Argument, 2 -> Unary, 3 -> OtherInst
 125 static unsigned getComplexity(Value *V) {
 126   if (isa<Instruction>(V)) {
 127     if (BinaryOperator::isNeg(V) || BinaryOperator::isNot(V))
 128       return 2;
 129     return 3;
 130   }
 131   if (isa<Argument>(V)) return 2;
 132   return isa<Constant>(V) ? 0 : 1;
 133 }
 134
 135 // isOnlyUse - Return true if this instruction will be deleted if we stop using
 136 // it.
 137 static bool isOnlyUse(Value *V) {
 138   return V->use_size() == 1 || isa<Constant>(V);
 139 }
 140
 141 // SimplifyCommutative - This performs a few simplifications for commutative
 142 // operators:
 143 //
 144 //  1. Order operands such that they are listed from right (least complex) to
 145 //     left (most complex).  This puts constants before unary operators before
 146 //     binary operators.
 147 //
 148 //  2. Transform: (op (op V, C1), C2) ==> (op V, (op C1, C2))
 149 //  3. Transform: (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
 150 //
 151 bool InstCombiner::SimplifyCommutative(BinaryOperator &I) {
 152   bool Changed = false;
 153   if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1)))
 154     Changed = !I.swapOperands();
 155
 156   if (!I.isAssociative()) return Changed;
 157   Instruction::BinaryOps Opcode = I.getOpcode();
 158   if (BinaryOperator *Op = dyn_cast<BinaryOperator>(I.getOperand(0)))
 159     if (Op->getOpcode() == Opcode && isa<Constant>(Op->getOperand(1))) {
 160       if (isa<Constant>(I.getOperand(1))) {
 161         Constant *Folded = ConstantExpr::get(I.getOpcode(),
 162                                              cast<Constant>(I.getOperand(1)),
 163                                              cast<Constant>(Op->getOperand(1)));
 164         I.setOperand(0, Op->getOperand(0));
 165         I.setOperand(1, Folded);
 166         return true;
 167       } else if (BinaryOperator *Op1=dyn_cast<BinaryOperator>(I.getOperand(1)))
 168         if (Op1->getOpcode() == Opcode && isa<Constant>(Op1->getOperand(1)) &&
 169             isOnlyUse(Op) && isOnlyUse(Op1)) {
 170           Constant *C1 = cast<Constant>(Op->getOperand(1));
 171           Constant *C2 = cast<Constant>(Op1->getOperand(1));
 172
 173           // Fold (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
 174           Constant *Folded = ConstantExpr::get(I.getOpcode(), C1, C2);
 175           Instruction *New = BinaryOperator::create(Opcode, Op->getOperand(0),
 176                                                     Op1->getOperand(0),
 177                                                     Op1->getName(), &I);
 178           WorkList.push_back(New);
 179           I.setOperand(0, New);
 180           I.setOperand(1, Folded);
 181           return true;
 182         }
 183     }
 184   return Changed;
 185 }
 186
 187 // dyn_castNegVal - Given a 'sub' instruction, return the RHS of the instruction
 188 // if the LHS is a constant zero (which is the 'negate' form).
 189 //
 190 static inline Value *dyn_castNegVal(Value *V) {
 191   if (BinaryOperator::isNeg(V))
 192     return BinaryOperator::getNegArgument(cast<BinaryOperator>(V));
 193
 194   // Constants can be considered to be negated values if they can be folded...
 195   if (Constant *C = dyn_cast<Constant>(V))
 196     return ConstantExpr::get(Instruction::Sub,
 197                              Constant::getNullValue(V->getType()), C);
 198   return 0;
 199 }
 200
 201 static inline Value *dyn_castNotVal(Value *V) {
 202   if (BinaryOperator::isNot(V))
 203     return BinaryOperator::getNotArgument(cast<BinaryOperator>(V));
 204
 205   // Constants can be considered to be not'ed values...
 206   if (ConstantIntegral *C = dyn_cast<ConstantIntegral>(V))
 207     return ConstantExpr::get(Instruction::Xor,
 208                              ConstantIntegral::getAllOnesValue(C->getType()),C);
 209   return 0;
 210 }
 211
 212 // dyn_castFoldableMul - If this value is a multiply that can be folded into
 213 // other computations (because it has a constant operand), return the
 214 // non-constant operand of the multiply.
 215 //
 216 static inline Value *dyn_castFoldableMul(Value *V) {
 217   if (V->use_size() == 1 && V->getType()->isInteger())
 218     if (Instruction *I = dyn_cast<Instruction>(V))
 219       if (I->getOpcode() == Instruction::Mul)
 220         if (isa<Constant>(I->getOperand(1)))
 221           return I->getOperand(0);
 222   return 0;
 223 }
 224
 225 // dyn_castMaskingAnd - If this value is an And instruction masking a value with
 226 // a constant, return the constant being anded with.
 227 //
 228 static inline Constant *dyn_castMaskingAnd(Value *V) {
 229   if (Instruction *I = dyn_cast<Instruction>(V))
 230     if (I->getOpcode() == Instruction::And)
 231       return dyn_cast<Constant>(I->getOperand(1));
 232
 233   // If this is a constant, it acts just like we were masking with it.
 234   return dyn_cast<Constant>(V);
 235 }
 236
 237 // Log2 - Calculate the log base 2 for the specified value if it is exactly a
 238 // power of 2.
 239 static unsigned Log2(uint64_t Val) {
 240   assert(Val > 1 && "Values 0 and 1 should be handled elsewhere!");
 241   unsigned Count = 0;
 242   while (Val != 1) {
 243     if (Val & 1) return 0;    // Multiple bits set?
 244     Val >>= 1;
 245     ++Count;
 246   }
 247   return Count;
 248 }
 249
 250 Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
 251   bool Changed = SimplifyCommutative(I);
 252   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
 253
 254   // Eliminate 'add int %X, 0'
 255   if (RHS == Constant::getNullValue(I.getType()))
 256     return ReplaceInstUsesWith(I, LHS);
 257
 258   // -A + B  -->  B - A
 259   if (Value *V = dyn_castNegVal(LHS))
 260     return BinaryOperator::create(Instruction::Sub, RHS, V);
 261
 262   // A + -B  -->  A - B
 263   if (!isa<Constant>(RHS))
 264     if (Value *V = dyn_castNegVal(RHS))
 265       return BinaryOperator::create(Instruction::Sub, LHS, V);
 266
 267   // X*C + X --> X * (C+1)
 268   if (dyn_castFoldableMul(LHS) == RHS) {
 269     Constant *CP1 =
 270       ConstantExpr::get(Instruction::Add,
 271                         cast<Constant>(cast<Instruction>(LHS)->getOperand(1)),
 272                         ConstantInt::get(I.getType(), 1));
 273     return BinaryOperator::create(Instruction::Mul, RHS, CP1);
 274   }
 275
 276   // X + X*C --> X * (C+1)
 277   if (dyn_castFoldableMul(RHS) == LHS) {
 278     Constant *CP1 =
 279       ConstantExpr::get(Instruction::Add,
 280                         cast<Constant>(cast<Instruction>(RHS)->getOperand(1)),
 281                         ConstantInt::get(I.getType(), 1));
 282     return BinaryOperator::create(Instruction::Mul, LHS, CP1);
 283   }
 284
 285   // (A & C1)+(B & C2) -> (A & C1)|(B & C2) iff C1&C2 == 0
 286   if (Constant *C1 = dyn_castMaskingAnd(LHS))
 287     if (Constant *C2 = dyn_castMaskingAnd(RHS))
 288       if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
 289         return BinaryOperator::create(Instruction::Or, LHS, RHS);
 290
 291   return Changed ? &I : 0;
 292 }
 293
 294 // isSignBit - Return true if the value represented by the constant only has the
 295 // highest order bit set.
 296 static bool isSignBit(ConstantInt *CI) {
 297   unsigned NumBits = CI->getType()->getPrimitiveSize()*8;
 298   return (CI->getRawValue() & ~(-1LL << NumBits)) == (1ULL << (NumBits-1));
 299 }
 300
 301 Instruction *InstCombiner::visitSub(BinaryOperator &I) {
 302   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 303
 304   if (Op0 == Op1)         // sub X, X  -> 0
 305     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 306
 307   // If this is a 'B = x-(-A)', change to B = x+A...
 308   if (Value *V = dyn_castNegVal(Op1))
 309     return BinaryOperator::create(Instruction::Add, Op0, V);
 310
 311   // Replace (-1 - A) with (~A)...
 312   if (ConstantInt *C = dyn_cast<ConstantInt>(Op0))
 313     if (C->isAllOnesValue())
 314       return BinaryOperator::createNot(Op1);
 315
 316   if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
 317     if (Op1I->use_size() == 1) {
 318       // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression
 319       // is not used by anyone else...
 320       //
 321       if (Op1I->getOpcode() == Instruction::Sub) {
 322         // Swap the two operands of the subexpr...
 323         Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
 324         Op1I->setOperand(0, IIOp1);
 325         Op1I->setOperand(1, IIOp0);
 326
 327         // Create the new top level add instruction...
 328         return BinaryOperator::create(Instruction::Add, Op0, Op1);
 329       }
 330
 331       // Replace (A - (A & B)) with (A & ~B) if this is the only use of (A&B)...
 332       //
 333       if (Op1I->getOpcode() == Instruction::And &&
 334           (Op1I->getOperand(0) == Op0 || Op1I->getOperand(1) == Op0)) {
 335         Value *OtherOp = Op1I->getOperand(Op1I->getOperand(0) == Op0);
 336
 337         Instruction *NewNot = BinaryOperator::createNot(OtherOp, "B.not", &I);
 338         return BinaryOperator::create(Instruction::And, Op0, NewNot);
 339       }
 340
 341       // X - X*C --> X * (1-C)
 342       if (dyn_castFoldableMul(Op1I) == Op0) {
 343         Constant *CP1 =
 344           ConstantExpr::get(Instruction::Sub,
 345                             ConstantInt::get(I.getType(), 1),
 346                          cast<Constant>(cast<Instruction>(Op1)->getOperand(1)));
 347         assert(CP1 && "Couldn't constant fold 1-C?");
 348         return BinaryOperator::create(Instruction::Mul, Op0, CP1);
 349       }
 350     }
 351
 352   // X*C - X --> X * (C-1)
 353   if (dyn_castFoldableMul(Op0) == Op1) {
 354     Constant *CP1 =
 355       ConstantExpr::get(Instruction::Sub,
 356                         cast<Constant>(cast<Instruction>(Op0)->getOperand(1)),
 357                         ConstantInt::get(I.getType(), 1));
 358     assert(CP1 && "Couldn't constant fold C - 1?");
 359     return BinaryOperator::create(Instruction::Mul, Op1, CP1);
 360   }
 361
 362   return 0;
 363 }
 364
 365 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
 366   bool Changed = SimplifyCommutative(I);
 367   Value *Op0 = I.getOperand(0);
 368
 369   // Simplify mul instructions with a constant RHS...
 370   if (Constant *Op1 = dyn_cast<Constant>(I.getOperand(1))) {
 371     if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
 372       const Type *Ty = CI->getType();
 373       int64_t Val = (int64_t)cast<ConstantInt>(CI)->getRawValue();
 374       switch (Val) {
 375       case -1:                               // X * -1 -> -X
 376         return BinaryOperator::createNeg(Op0, I.getName());
 377       case 0:
 378         return ReplaceInstUsesWith(I, Op1);  // Eliminate 'mul double %X, 0'
 379       case 1:
 380         return ReplaceInstUsesWith(I, Op0);  // Eliminate 'mul int %X, 1'
 381       case 2:                     // Convert 'mul int %X, 2' to 'add int %X, %X'
 382         return BinaryOperator::create(Instruction::Add, Op0, Op0, I.getName());
 383       }
 384
 385       if (uint64_t C = Log2(Val))            // Replace X*(2^C) with X << C
 386         return new ShiftInst(Instruction::Shl, Op0,
 387                              ConstantUInt::get(Type::UByteTy, C));
 388     } else {
 389       ConstantFP *Op1F = cast<ConstantFP>(Op1);
 390       if (Op1F->isNullValue())
 391         return ReplaceInstUsesWith(I, Op1);
 392
 393       // "In IEEE floating point, x*1 is not equivalent to x for nans.  However,
 394       // ANSI says we can drop signals, so we can do this anyway." (from GCC)
 395       if (Op1F->getValue() == 1.0)
 396         return ReplaceInstUsesWith(I, Op0);  // Eliminate 'mul double %X, 1.0'
 397     }
 398   }
 399
 400   if (Value *Op0v = dyn_castNegVal(Op0))     // -X * -Y = X*Y
 401     if (Value *Op1v = dyn_castNegVal(I.getOperand(1)))
 402       return BinaryOperator::create(Instruction::Mul, Op0v, Op1v);
 403
 404   return Changed ? &I : 0;
 405 }
 406
 407 Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
 408   // div X, 1 == X
 409   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
 410     if (RHS->equalsInt(1))
 411       return ReplaceInstUsesWith(I, I.getOperand(0));
 412
 413     // Check to see if this is an unsigned division with an exact power of 2,
 414     // if so, convert to a right shift.
 415     if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
 416       if (uint64_t Val = C->getValue())    // Don't break X / 0
 417         if (uint64_t C = Log2(Val))
 418           return new ShiftInst(Instruction::Shr, I.getOperand(0),
 419                                ConstantUInt::get(Type::UByteTy, C));
 420   }
 421
 422   // 0 / X == 0, we don't need to preserve faults!
 423   if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
 424     if (LHS->equalsInt(0))
 425       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 426
 427   return 0;
 428 }
 429
 430
 431 Instruction *InstCombiner::visitRem(BinaryOperator &I) {
 432   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
 433     if (RHS->equalsInt(1))  // X % 1 == 0
 434       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 435
 436     // Check to see if this is an unsigned remainder with an exact power of 2,
 437     // if so, convert to a bitwise and.
 438     if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
 439       if (uint64_t Val = C->getValue())    // Don't break X % 0 (divide by zero)
 440         if (Log2(Val))
 441           return BinaryOperator::create(Instruction::And, I.getOperand(0),
 442                                         ConstantUInt::get(I.getType(), Val-1));
 443   }
 444
 445   // 0 % X == 0, we don't need to preserve faults!
 446   if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
 447     if (LHS->equalsInt(0))
 448       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 449
 450   return 0;
 451 }
 452
 453 // isMaxValueMinusOne - return true if this is Max-1
 454 static bool isMaxValueMinusOne(const ConstantInt *C) {
 455   if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C)) {
 456     // Calculate -1 casted to the right type...
 457     unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 458     uint64_t Val = ~0ULL;                // All ones
 459     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 460     return CU->getValue() == Val-1;
 461   }
 462
 463   const ConstantSInt *CS = cast<ConstantSInt>(C);
 464
 465   // Calculate 0111111111..11111
 466   unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 467   int64_t Val = INT64_MAX;             // All ones
 468   Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 469   return CS->getValue() == Val-1;
 470 }
 471
 472 // isMinValuePlusOne - return true if this is Min+1
 473 static bool isMinValuePlusOne(const ConstantInt *C) {
 474   if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C))
 475     return CU->getValue() == 1;
 476
 477   const ConstantSInt *CS = cast<ConstantSInt>(C);
 478
 479   // Calculate 1111111111000000000000
 480   unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 481   int64_t Val = -1;                    // All ones
 482   Val <<= TypeBits-1;                  // Shift over to the right spot
 483   return CS->getValue() == Val+1;
 484 }
 485
 486
 487 Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
 488   bool Changed = SimplifyCommutative(I);
 489   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 490
 491   // and X, X = X   and X, 0 == 0
 492   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
 493     return ReplaceInstUsesWith(I, Op1);
 494
 495   // and X, -1 == X
 496   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
 497     if (RHS->isAllOnesValue())
 498       return ReplaceInstUsesWith(I, Op0);
 499
 500     // (X ^ C1) & C2 --> (X & C2) ^ (C1&C2)
 501     if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
 502       if (Op0I->getOpcode() == Instruction::Xor && isOnlyUse(Op0))
 503         if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
 504           std::string Op0Name = Op0I->getName(); Op0I->setName("");
 505           Instruction *And = BinaryOperator::create(Instruction::And,
 506                                                     Op0I->getOperand(0), RHS,
 507                                                    Op0Name);
 508           InsertNewInstBefore(And, I);
 509           return BinaryOperator::create(Instruction::Xor, And, *RHS & *Op0CI);
 510         }
 511   }
 512
 513   Value *Op0NotVal = dyn_castNotVal(Op0);
 514   Value *Op1NotVal = dyn_castNotVal(Op1);
 515
 516   // (~A & ~B) == (~(A | B)) - Demorgan's Law
 517   if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
 518     Instruction *Or = BinaryOperator::create(Instruction::Or, Op0NotVal,
 519                                              Op1NotVal,I.getName()+".demorgan");
 520     InsertNewInstBefore(Or, I);
 521     return BinaryOperator::createNot(Or);
 522   }
 523
 524   if (Op0NotVal == Op1 || Op1NotVal == Op0)  // A & ~A  == ~A & A == 0
 525     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 526
 527   return Changed ? &I : 0;
 528 }
 529
 530
 531
 532 Instruction *InstCombiner::visitOr(BinaryOperator &I) {
 533   bool Changed = SimplifyCommutative(I);
 534   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 535
 536   // or X, X = X   or X, 0 == X
 537   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
 538     return ReplaceInstUsesWith(I, Op0);
 539
 540   // or X, -1 == -1
 541   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
 542     if (RHS->isAllOnesValue())
 543       return ReplaceInstUsesWith(I, Op1);
 544
 545     if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
 546       // (X & C1) | C2 --> (X | C2) & (C1|C2)
 547       if (Op0I->getOpcode() == Instruction::And && isOnlyUse(Op0))
 548         if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
 549           std::string Op0Name = Op0I->getName(); Op0I->setName("");
 550           Instruction *Or = BinaryOperator::create(Instruction::Or,
 551                                                    Op0I->getOperand(0), RHS,
 552                                                    Op0Name);
 553           InsertNewInstBefore(Or, I);
 554           return BinaryOperator::create(Instruction::And, Or, *RHS | *Op0CI);
 555         }
 556
 557       // (X ^ C1) | C2 --> (X | C2) ^ (C1&~C2)
 558       if (Op0I->getOpcode() == Instruction::Xor && isOnlyUse(Op0))
 559         if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
 560           std::string Op0Name = Op0I->getName(); Op0I->setName("");
 561           Instruction *Or = BinaryOperator::create(Instruction::Or,
 562                                                    Op0I->getOperand(0), RHS,
 563                                                    Op0Name);
 564           InsertNewInstBefore(Or, I);
 565           return BinaryOperator::create(Instruction::Xor, Or, *Op0CI & *~*RHS);
 566         }
 567     }
 568   }
 569
 570   Value *Op0NotVal = dyn_castNotVal(Op0);
 571   Value *Op1NotVal = dyn_castNotVal(Op1);
 572
 573   if (Op1 == Op0NotVal)   // ~A | A == -1
 574     return ReplaceInstUsesWith(I,
 575                                ConstantIntegral::getAllOnesValue(I.getType()));
 576
 577   if (Op0 == Op1NotVal)   // A | ~A == -1
 578     return ReplaceInstUsesWith(I,
 579                                ConstantIntegral::getAllOnesValue(I.getType()));
 580
 581   // (~A | ~B) == (~(A & B)) - Demorgan's Law
 582   if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
 583     Instruction *And = BinaryOperator::create(Instruction::And, Op0NotVal,
 584                                               Op1NotVal,I.getName()+".demorgan",
 585                                               &I);
 586     WorkList.push_back(And);
 587     return BinaryOperator::createNot(And);
 588   }
 589
 590   return Changed ? &I : 0;
 591 }
 592
 593
 594
 595 Instruction *InstCombiner::visitXor(BinaryOperator &I) {
 596   bool Changed = SimplifyCommutative(I);
 597   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 598
 599   // xor X, X = 0
 600   if (Op0 == Op1)
 601     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 602
 603   if (ConstantIntegral *Op1C = dyn_cast<ConstantIntegral>(Op1)) {
 604     // xor X, 0 == X
 605     if (Op1C->isNullValue())
 606       return ReplaceInstUsesWith(I, Op0);
 607
 608     // Is this a "NOT" instruction?
 609     if (Op1C->isAllOnesValue()) {
 610       // xor (xor X, -1), -1 = not (not X) = X
 611       if (Value *X = dyn_castNotVal(Op0))
 612         return ReplaceInstUsesWith(I, X);
 613
 614       // xor (setcc A, B), true = not (setcc A, B) = setncc A, B
 615       if (SetCondInst *SCI = dyn_cast<SetCondInst>(Op0))
 616         if (SCI->use_size() == 1)
 617           return new SetCondInst(SCI->getInverseCondition(),
 618                                  SCI->getOperand(0), SCI->getOperand(1));
 619     }
 620   }
 621
 622   if (Value *X = dyn_castNotVal(Op0))   // ~A ^ A == -1
 623     if (X == Op1)
 624       return ReplaceInstUsesWith(I,
 625                                 ConstantIntegral::getAllOnesValue(I.getType()));
 626
 627   if (Value *X = dyn_castNotVal(Op1))   // A ^ ~A == -1
 628     if (X == Op0)
 629       return ReplaceInstUsesWith(I,
 630                                 ConstantIntegral::getAllOnesValue(I.getType()));
 631
 632   if (Instruction *Op1I = dyn_cast<Instruction>(Op1))
 633     if (Op1I->getOpcode() == Instruction::Or)
 634       if (Op1I->getOperand(0) == Op0) {              // B^(B|A) == (A|B)^B
 635         cast<BinaryOperator>(Op1I)->swapOperands();
 636         I.swapOperands();
 637         std::swap(Op0, Op1);
 638       } else if (Op1I->getOperand(1) == Op0) {       // B^(A|B) == (A|B)^B
 639         I.swapOperands();
 640         std::swap(Op0, Op1);
 641       }
 642
 643   if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
 644     if (Op0I->getOpcode() == Instruction::Or && Op0I->use_size() == 1) {
 645       if (Op0I->getOperand(0) == Op1)                // (B|A)^B == (A|B)^B
 646         cast<BinaryOperator>(Op0I)->swapOperands();
 647       if (Op0I->getOperand(1) == Op1) {              // (A|B)^B == A & ~B
 648         Value *NotB = BinaryOperator::createNot(Op1, Op1->getName()+".not", &I);
 649         WorkList.push_back(cast<Instruction>(NotB));
 650         return BinaryOperator::create(Instruction::And, Op0I->getOperand(0),
 651                                       NotB);
 652       }
 653     }
 654
 655   // (A & C1)^(B & C2) -> (A & C1)|(B & C2) iff C1^C2 == 0
 656   if (Constant *C1 = dyn_castMaskingAnd(Op0))
 657     if (Constant *C2 = dyn_castMaskingAnd(Op1))
 658       if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
 659         return BinaryOperator::create(Instruction::Or, Op0, Op1);
 660
 661   return Changed ? &I : 0;
 662 }
 663
 664 // AddOne, SubOne - Add or subtract a constant one from an integer constant...
 665 static Constant *AddOne(ConstantInt *C) {
 666   Constant *Result = ConstantExpr::get(Instruction::Add, C,
 667                                        ConstantInt::get(C->getType(), 1));
 668   assert(Result && "Constant folding integer addition failed!");
 669   return Result;
 670 }
 671 static Constant *SubOne(ConstantInt *C) {
 672   Constant *Result = ConstantExpr::get(Instruction::Sub, C,
 673                                        ConstantInt::get(C->getType(), 1));
 674   assert(Result && "Constant folding integer addition failed!");
 675   return Result;
 676 }
 677
 678 // isTrueWhenEqual - Return true if the specified setcondinst instruction is
 679 // true when both operands are equal...
 680 //
 681 static bool isTrueWhenEqual(Instruction &I) {
 682   return I.getOpcode() == Instruction::SetEQ ||
 683          I.getOpcode() == Instruction::SetGE ||
 684          I.getOpcode() == Instruction::SetLE;
 685 }
 686
 687 Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
 688   bool Changed = SimplifyCommutative(I);
 689   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 690   const Type *Ty = Op0->getType();
 691
 692   // setcc X, X
 693   if (Op0 == Op1)
 694     return ReplaceInstUsesWith(I, ConstantBool::get(isTrueWhenEqual(I)));
 695
 696   // setcc <global*>, 0 - Global value addresses are never null!
 697   if (isa<GlobalValue>(Op0) && isa<ConstantPointerNull>(Op1))
 698     return ReplaceInstUsesWith(I, ConstantBool::get(!isTrueWhenEqual(I)));
 699
 700   // setcc's with boolean values can always be turned into bitwise operations
 701   if (Ty == Type::BoolTy) {
 702     // If this is <, >, or !=, we can change this into a simple xor instruction
 703     if (!isTrueWhenEqual(I))
 704       return BinaryOperator::create(Instruction::Xor, Op0, Op1, I.getName());
 705
 706     // Otherwise we need to make a temporary intermediate instruction and insert
 707     // it into the instruction stream.  This is what we are after:
 708     //
 709     //  seteq bool %A, %B -> ~(A^B)
 710     //  setle bool %A, %B -> ~A | B
 711     //  setge bool %A, %B -> A | ~B
 712     //
 713     if (I.getOpcode() == Instruction::SetEQ) {  // seteq case
 714       Instruction *Xor = BinaryOperator::create(Instruction::Xor, Op0, Op1,
 715                                                 I.getName()+"tmp");
 716       InsertNewInstBefore(Xor, I);
 717       return BinaryOperator::createNot(Xor, I.getName());
 718     }
 719
 720     // Handle the setXe cases...
 721     assert(I.getOpcode() == Instruction::SetGE ||
 722            I.getOpcode() == Instruction::SetLE);
 723
 724     if (I.getOpcode() == Instruction::SetGE)
 725       std::swap(Op0, Op1);                   // Change setge -> setle
 726
 727     // Now we just have the SetLE case.
 728     Instruction *Not = BinaryOperator::createNot(Op0, I.getName()+"tmp");
 729     InsertNewInstBefore(Not, I);
 730     return BinaryOperator::create(Instruction::Or, Not, Op1, I.getName());
 731   }
 732
 733   // Check to see if we are doing one of many comparisons against constant
 734   // integers at the end of their ranges...
 735   //
 736   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
 737     // Simplify seteq and setne instructions...
 738     if (I.getOpcode() == Instruction::SetEQ ||
 739         I.getOpcode() == Instruction::SetNE) {
 740       bool isSetNE = I.getOpcode() == Instruction::SetNE;
 741
 742       if (CI->isNullValue()) {   // Simplify [seteq|setne] X, 0
 743         CastInst *Val = new CastInst(Op0, Type::BoolTy, I.getName()+".not");
 744         if (isSetNE) return Val;
 745
 746         // seteq X, 0 -> not (cast X to bool)
 747         InsertNewInstBefore(Val, I);
 748         return BinaryOperator::createNot(Val, I.getName());
 749       }
 750
 751       // If the first operand is (and|or|xor) with a constant, and the second
 752       // operand is a constant, simplify a bit.
 753       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0))
 754         if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1)))
 755           if (BO->getOpcode() == Instruction::Or) {
 756             // If bits are being or'd in that are not present in the constant we
 757             // are comparing against, then the comparison could never succeed!
 758             if (!(*BOC & *~*CI)->isNullValue())
 759               return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
 760           } else if (BO->getOpcode() == Instruction::And) {
 761             // If bits are being compared against that are and'd out, then the
 762             // comparison can never succeed!
 763             if (!(*CI & *~*BOC)->isNullValue())
 764               return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
 765           } else if (BO->getOpcode() == Instruction::Xor) {
 766             // For the xor case, we can always just xor the two constants
 767             // together, potentially eliminating the explicit xor.
 768             return BinaryOperator::create(I.getOpcode(), BO->getOperand(0),
 769                                           *CI ^ *BOC);
 770           }
 771     }
 772
 773     // Check to see if we are comparing against the minimum or maximum value...
 774     if (CI->isMinValue()) {
 775       if (I.getOpcode() == Instruction::SetLT)       // A < MIN -> FALSE
 776         return ReplaceInstUsesWith(I, ConstantBool::False);
 777       if (I.getOpcode() == Instruction::SetGE)       // A >= MIN -> TRUE
 778         return ReplaceInstUsesWith(I, ConstantBool::True);
 779       if (I.getOpcode() == Instruction::SetLE)       // A <= MIN -> A == MIN
 780         return BinaryOperator::create(Instruction::SetEQ, Op0,Op1, I.getName());
 781       if (I.getOpcode() == Instruction::SetGT)       // A > MIN -> A != MIN
 782         return BinaryOperator::create(Instruction::SetNE, Op0,Op1, I.getName());
 783
 784     } else if (CI->isMaxValue()) {
 785       if (I.getOpcode() == Instruction::SetGT)       // A > MAX -> FALSE
 786         return ReplaceInstUsesWith(I, ConstantBool::False);
 787       if (I.getOpcode() == Instruction::SetLE)       // A <= MAX -> TRUE
 788         return ReplaceInstUsesWith(I, ConstantBool::True);
 789       if (I.getOpcode() == Instruction::SetGE)       // A >= MAX -> A == MAX
 790         return BinaryOperator::create(Instruction::SetEQ, Op0,Op1, I.getName());
 791       if (I.getOpcode() == Instruction::SetLT)       // A < MAX -> A != MAX
 792         return BinaryOperator::create(Instruction::SetNE, Op0,Op1, I.getName());
 793
 794       // Comparing against a value really close to min or max?
 795     } else if (isMinValuePlusOne(CI)) {
 796       if (I.getOpcode() == Instruction::SetLT)       // A < MIN+1 -> A == MIN
 797         return BinaryOperator::create(Instruction::SetEQ, Op0,
 798                                       SubOne(CI), I.getName());
 799       if (I.getOpcode() == Instruction::SetGE)       // A >= MIN-1 -> A != MIN
 800         return BinaryOperator::create(Instruction::SetNE, Op0,
 801                                       SubOne(CI), I.getName());
 802
 803     } else if (isMaxValueMinusOne(CI)) {
 804       if (I.getOpcode() == Instruction::SetGT)       // A > MAX-1 -> A == MAX
 805         return BinaryOperator::create(Instruction::SetEQ, Op0,
 806                                       AddOne(CI), I.getName());
 807       if (I.getOpcode() == Instruction::SetLE)       // A <= MAX-1 -> A != MAX
 808         return BinaryOperator::create(Instruction::SetNE, Op0,
 809                                       AddOne(CI), I.getName());
 810     }
 811   }
 812
 813   return Changed ? &I : 0;
 814 }
 815
 816
 817
 818 Instruction *InstCombiner::visitShiftInst(ShiftInst &I) {
 819   assert(I.getOperand(1)->getType() == Type::UByteTy);
 820   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 821
 822   // shl X, 0 == X and shr X, 0 == X
 823   // shl 0, X == 0 and shr 0, X == 0
 824   if (Op1 == Constant::getNullValue(Type::UByteTy) ||
 825       Op0 == Constant::getNullValue(Op0->getType()))
 826     return ReplaceInstUsesWith(I, Op0);
 827
 828   // If this is a shift of a shift, see if we can fold the two together...
 829   if (ShiftInst *Op0SI = dyn_cast<ShiftInst>(Op0)) {
 830     if (isa<Constant>(Op1) && isa<Constant>(Op0SI->getOperand(1))) {
 831       ConstantUInt *ShiftAmt1C = cast<ConstantUInt>(Op0SI->getOperand(1));
 832       unsigned ShiftAmt1 = ShiftAmt1C->getValue();
 833       unsigned ShiftAmt2 = cast<ConstantUInt>(Op1)->getValue();
 834
 835       // Check for (A << c1) << c2   and   (A >> c1) >> c2
 836       if (I.getOpcode() == Op0SI->getOpcode()) {
 837         unsigned Amt = ShiftAmt1+ShiftAmt2;   // Fold into one big shift...
 838         return new ShiftInst(I.getOpcode(), Op0SI->getOperand(0),
 839                              ConstantUInt::get(Type::UByteTy, Amt));
 840       }
 841
 842       if (I.getType()->isUnsigned()) { // Check for (A << c1) >> c2 or visaversa
 843         // Calculate bitmask for what gets shifted off the edge...
 844         Constant *C = ConstantIntegral::getAllOnesValue(I.getType());
 845         if (I.getOpcode() == Instruction::Shr)
 846           C = ConstantExpr::getShift(Instruction::Shr, C, ShiftAmt1C);
 847         else
 848           C = ConstantExpr::getShift(Instruction::Shl, C, ShiftAmt1C);
 849
 850         Instruction *Mask =
 851           BinaryOperator::create(Instruction::And, Op0SI->getOperand(0),
 852                                  C, Op0SI->getOperand(0)->getName()+".mask",&I);
 853         WorkList.push_back(Mask);
 854
 855         // Figure out what flavor of shift we should use...
 856         if (ShiftAmt1 == ShiftAmt2)
 857           return ReplaceInstUsesWith(I, Mask);  // (A << c) >> c  === A & c2
 858         else if (ShiftAmt1 < ShiftAmt2) {
 859           return new ShiftInst(I.getOpcode(), Mask,
 860                          ConstantUInt::get(Type::UByteTy, ShiftAmt2-ShiftAmt1));
 861         } else {
 862           return new ShiftInst(Op0SI->getOpcode(), Mask,
 863                          ConstantUInt::get(Type::UByteTy, ShiftAmt1-ShiftAmt2));
 864         }
 865       }
 866     }
 867   }
 868
 869   // shl uint X, 32 = 0 and shr ubyte Y, 9 = 0, ... just don't eliminate shr of
 870   // a signed value.
 871   //
 872   if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
 873     unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
 874     if (CUI->getValue() >= TypeBits &&
 875         (!Op0->getType()->isSigned() || I.getOpcode() == Instruction::Shl))
 876       return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
 877
 878     // Check to see if we are shifting left by 1.  If so, turn it into an add
 879     // instruction.
 880     if (I.getOpcode() == Instruction::Shl && CUI->equalsInt(1))
 881       // Convert 'shl int %X, 1' to 'add int %X, %X'
 882       return BinaryOperator::create(Instruction::Add, Op0, Op0, I.getName());
 883
 884   }
 885
 886   // shr int -1, X = -1   (for any arithmetic shift rights of ~0)
 887   if (ConstantSInt *CSI = dyn_cast<ConstantSInt>(Op0))
 888     if (I.getOpcode() == Instruction::Shr && CSI->isAllOnesValue())
 889       return ReplaceInstUsesWith(I, CSI);
 890
 891   return 0;
 892 }
 893
 894
 895 // isEliminableCastOfCast - Return true if it is valid to eliminate the CI
 896 // instruction.
 897 //
 898 static inline bool isEliminableCastOfCast(const CastInst &CI,
 899                                           const CastInst *CSrc) {
 900   assert(CI.getOperand(0) == CSrc);
 901   const Type *SrcTy = CSrc->getOperand(0)->getType();
 902   const Type *MidTy = CSrc->getType();
 903   const Type *DstTy = CI.getType();
 904
 905   // It is legal to eliminate the instruction if casting A->B->A if the sizes
 906   // are identical and the bits don't get reinterpreted (for example
 907   // int->float->int would not be allowed)
 908   if (SrcTy == DstTy && SrcTy->isLosslesslyConvertibleTo(MidTy))
 909     return true;
 910
 911   // Allow free casting and conversion of sizes as long as the sign doesn't
 912   // change...
 913   if (SrcTy->isIntegral() && MidTy->isIntegral() && DstTy->isIntegral()) {
 914     unsigned SrcSize = SrcTy->getPrimitiveSize();
 915     unsigned MidSize = MidTy->getPrimitiveSize();
 916     unsigned DstSize = DstTy->getPrimitiveSize();
 917
 918     // Cases where we are monotonically decreasing the size of the type are
 919     // always ok, regardless of what sign changes are going on.
 920     //
 921     if (SrcSize >= MidSize && MidSize >= DstSize)
 922       return true;
 923
 924     // Cases where the source and destination type are the same, but the middle
 925     // type is bigger are noops.
 926     //
 927     if (SrcSize == DstSize && MidSize > SrcSize)
 928       return true;
 929
 930     // If we are monotonically growing, things are more complex.
 931     //
 932     if (SrcSize <= MidSize && MidSize <= DstSize) {
 933       // We have eight combinations of signedness to worry about. Here's the
 934       // table:
 935       static const int SignTable[8] = {
 936         // CODE, SrcSigned, MidSigned, DstSigned, Comment
 937         1,     //   U          U          U       Always ok
 938         1,     //   U          U          S       Always ok
 939         3,     //   U          S          U       Ok iff SrcSize != MidSize
 940         3,     //   U          S          S       Ok iff SrcSize != MidSize
 941         0,     //   S          U          U       Never ok
 942         2,     //   S          U          S       Ok iff MidSize == DstSize
 943         1,     //   S          S          U       Always ok
 944         1,     //   S          S          S       Always ok
 945       };
 946
 947       // Choose an action based on the current entry of the signtable that this
 948       // cast of cast refers to...
 949       unsigned Row = SrcTy->isSigned()*4+MidTy->isSigned()*2+DstTy->isSigned();
 950       switch (SignTable[Row]) {
 951       case 0: return false;              // Never ok
 952       case 1: return true;               // Always ok
 953       case 2: return MidSize == DstSize; // Ok iff MidSize == DstSize
 954       case 3:                            // Ok iff SrcSize != MidSize
 955         return SrcSize != MidSize || SrcTy == Type::BoolTy;
 956       default: assert(0 && "Bad entry in sign table!");
 957       }
 958     }
 959   }
 960
 961   // Otherwise, we cannot succeed.  Specifically we do not want to allow things
 962   // like:  short -> ushort -> uint, because this can create wrong results if
 963   // the input short is negative!
 964   //
 965   return false;
 966 }
 967
 968
 969 // CastInst simplification
 970 //
 971 Instruction *InstCombiner::visitCastInst(CastInst &CI) {
 972   Value *Src = CI.getOperand(0);
 973
 974   // If the user is casting a value to the same type, eliminate this cast
 975   // instruction...
 976   if (CI.getType() == Src->getType())
 977     return ReplaceInstUsesWith(CI, Src);
 978
 979   // If casting the result of another cast instruction, try to eliminate this
 980   // one!
 981   //
 982   if (CastInst *CSrc = dyn_cast<CastInst>(Src)) {
 983     if (isEliminableCastOfCast(CI, CSrc)) {
 984       // This instruction now refers directly to the cast's src operand.  This
 985       // has a good chance of making CSrc dead.
 986       CI.setOperand(0, CSrc->getOperand(0));
 987       return &CI;
 988     }
 989
 990     // If this is an A->B->A cast, and we are dealing with integral types, try
 991     // to convert this into a logical 'and' instruction.
 992     //
 993     if (CSrc->getOperand(0)->getType() == CI.getType() &&
 994         CI.getType()->isInteger() && CSrc->getType()->isInteger() &&
 995         CI.getType()->isUnsigned() && CSrc->getType()->isUnsigned() &&
 996         CSrc->getType()->getPrimitiveSize() < CI.getType()->getPrimitiveSize()){
 997       assert(CSrc->getType() != Type::ULongTy &&
 998              "Cannot have type bigger than ulong!");
 999       uint64_t AndValue = (1ULL << CSrc->getType()->getPrimitiveSize()*8)-1;
1000       Constant *AndOp = ConstantUInt::get(CI.getType(), AndValue);
1001       return BinaryOperator::create(Instruction::And, CSrc->getOperand(0),
1002                                     AndOp);
1003     }
1004   }
1005
1006   // If casting the result of a getelementptr instruction with no offset, turn
1007   // this into a cast of the original pointer!
1008   //
1009   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
1010     bool AllZeroOperands = true;
1011     for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
1012       if (!isa<Constant>(GEP->getOperand(i)) ||
1013           !cast<Constant>(GEP->getOperand(i))->isNullValue()) {
1014         AllZeroOperands = false;
1015         break;
1016       }
1017     if (AllZeroOperands) {
1018       CI.setOperand(0, GEP->getOperand(0));
1019       return &CI;
1020     }
1021   }
1022
1023   // If this is a cast to bool (which is effectively a "!=0" test), then we can
1024   // perform a few optimizations...
1025   //
1026   if (CI.getType() == Type::BoolTy) {
1027     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Src)) {
1028       Value *Op0 = BO->getOperand(0), *Op1 = BO->getOperand(1);
1029
1030       switch (BO->getOpcode()) {
1031       case Instruction::Sub:
1032       case Instruction::Xor:
1033         // Replace (cast ([sub|xor] A, B) to bool) with (setne A, B)
1034         return new SetCondInst(Instruction::SetNE, Op0, Op1);
1035
1036       // Replace (cast (add A, B) to bool) with (setne A, -B) if B is
1037       // efficiently invertible, or if the add has just this one use.
1038       case Instruction::Add:
1039         if (Value *NegVal = dyn_castNegVal(Op1))
1040           return new SetCondInst(Instruction::SetNE, Op0, NegVal);
1041         else if (Value *NegVal = dyn_castNegVal(Op0))
1042           return new SetCondInst(Instruction::SetNE, NegVal, Op1);
1043         else if (BO->use_size() == 1) {
1044           Instruction *Neg = BinaryOperator::createNeg(Op1, BO->getName());
1045           BO->setName("");
1046           InsertNewInstBefore(Neg, CI);
1047           return new SetCondInst(Instruction::SetNE, Op0, Neg);
1048         }
1049         break;
1050
1051       case Instruction::And:
1052         // Replace (cast (and X, (1 << size(X)-1)) to bool) with x < 0,
1053         // converting X to be a signed value as appropriate.  Don't worry about
1054         // bool values, as they will be optimized other ways if they occur in
1055         // this configuration.
1056         if (ConstantInt *CInt = dyn_cast<ConstantInt>(Op1))
1057           if (isSignBit(CInt)) {
1058             // If 'X' is not signed, insert a cast now...
1059             if (!CInt->getType()->isSigned()) {
1060               const Type *DestTy;
1061               switch (CInt->getType()->getPrimitiveID()) {
1062               case Type::UByteTyID:  DestTy = Type::SByteTy; break;
1063               case Type::UShortTyID: DestTy = Type::ShortTy; break;
1064               case Type::UIntTyID:   DestTy = Type::IntTy;   break;
1065               case Type::ULongTyID:  DestTy = Type::LongTy;  break;
1066               default: assert(0 && "Invalid unsigned integer type!"); abort();
1067               }
1068               CastInst *NewCI = new CastInst(Op0, DestTy,
1069                                              Op0->getName()+".signed");
1070               InsertNewInstBefore(NewCI, CI);
1071               Op0 = NewCI;
1072             }
1073             return new SetCondInst(Instruction::SetLT, Op0,
1074                                    Constant::getNullValue(Op0->getType()));
1075           }
1076         break;
1077       default: break;
1078       }
1079     }
1080   }
1081
1082   return 0;
1083 }
1084
1085 // CallInst simplification
1086 //
1087 Instruction *InstCombiner::visitCallInst(CallInst &CI) {
1088   if (transformConstExprCastCall(&CI)) return 0;
1089   return 0;
1090 }
1091
1092 // InvokeInst simplification
1093 //
1094 Instruction *InstCombiner::visitInvokeInst(InvokeInst &II) {
1095   if (transformConstExprCastCall(&II)) return 0;
1096   return 0;
1097 }
1098
1099 // getPromotedType - Return the specified type promoted as it would be to pass
1100 // though a va_arg area...
1101 static const Type *getPromotedType(const Type *Ty) {
1102   switch (Ty->getPrimitiveID()) {
1103   case Type::SByteTyID:
1104   case Type::ShortTyID:  return Type::IntTy;
1105   case Type::UByteTyID:
1106   case Type::UShortTyID: return Type::UIntTy;
1107   case Type::FloatTyID:  return Type::DoubleTy;
1108   default:               return Ty;
1109   }
1110 }
1111
1112 // transformConstExprCastCall - If the callee is a constexpr cast of a function,
1113 // attempt to move the cast to the arguments of the call/invoke.
1114 //
1115 bool InstCombiner::transformConstExprCastCall(CallSite CS) {
1116   if (!isa<ConstantExpr>(CS.getCalledValue())) return false;
1117   ConstantExpr *CE = cast<ConstantExpr>(CS.getCalledValue());
1118   if (CE->getOpcode() != Instruction::Cast ||
1119       !isa<ConstantPointerRef>(CE->getOperand(0)))
1120     return false;
1121   ConstantPointerRef *CPR = cast<ConstantPointerRef>(CE->getOperand(0));
1122   if (!isa<Function>(CPR->getValue())) return false;
1123   Function *Callee = cast<Function>(CPR->getValue());
1124   Instruction *Caller = CS.getInstruction();
1125
1126   // Okay, this is a cast from a function to a different type.  Unless doing so
1127   // would cause a type conversion of one of our arguments, change this call to
1128   // be a direct call with arguments casted to the appropriate types.
1129   //
1130   const FunctionType *FT = Callee->getFunctionType();
1131   const Type *OldRetTy = Caller->getType();
1132
1133   if (Callee->isExternal() &&
1134       !OldRetTy->isLosslesslyConvertibleTo(FT->getReturnType()))
1135     return false;   // Cannot transform this return value...
1136
1137   unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
1138   unsigned NumCommonArgs = std::min(FT->getNumParams(), NumActualArgs);
1139
1140   CallSite::arg_iterator AI = CS.arg_begin();
1141   for (unsigned i = 0, e = NumCommonArgs; i != e; ++i, ++AI) {
1142     const Type *ParamTy = FT->getParamType(i);
1143     bool isConvertible = (*AI)->getType()->isLosslesslyConvertibleTo(ParamTy);
1144     if (Callee->isExternal() && !isConvertible) return false;
1145   }
1146
1147   if (FT->getNumParams() < NumActualArgs && !FT->isVarArg() &&
1148       Callee->isExternal())
1149     return false;   // Do not delete arguments unless we have a function body...
1150
1151   // Okay, we decided that this is a safe thing to do: go ahead and start
1152   // inserting cast instructions as necessary...
1153   std::vector<Value*> Args;
1154   Args.reserve(NumActualArgs);
1155
1156   AI = CS.arg_begin();
1157   for (unsigned i = 0; i != NumCommonArgs; ++i, ++AI) {
1158     const Type *ParamTy = FT->getParamType(i);
1159     if ((*AI)->getType() == ParamTy) {
1160       Args.push_back(*AI);
1161     } else {
1162       Instruction *Cast = new CastInst(*AI, ParamTy, "tmp");
1163       InsertNewInstBefore(Cast, *Caller);
1164       Args.push_back(Cast);
1165     }
1166   }
1167
1168   // If the function takes more arguments than the call was taking, add them
1169   // now...
1170   for (unsigned i = NumCommonArgs; i != FT->getNumParams(); ++i)
1171     Args.push_back(Constant::getNullValue(FT->getParamType(i)));
1172
1173   // If we are removing arguments to the function, emit an obnoxious warning...
1174   if (FT->getNumParams() < NumActualArgs)
1175     if (!FT->isVarArg()) {
1176       std::cerr << "WARNING: While resolving call to function '"
1177                 << Callee->getName() << "' arguments were dropped!\n";
1178     } else {
1179       // Add all of the arguments in their promoted form to the arg list...
1180       for (unsigned i = FT->getNumParams(); i != NumActualArgs; ++i, ++AI) {
1181         const Type *PTy = getPromotedType((*AI)->getType());
1182         if (PTy != (*AI)->getType()) {
1183           // Must promote to pass through va_arg area!
1184           Instruction *Cast = new CastInst(*AI, PTy, "tmp");
1185           InsertNewInstBefore(Cast, *Caller);
1186           Args.push_back(Cast);
1187         } else {
1188           Args.push_back(*AI);
1189         }
1190       }
1191     }
1192
1193   if (FT->getReturnType() == Type::VoidTy)
1194     Caller->setName("");   // Void type should not have a name...
1195
1196   Instruction *NC;
1197   if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
1198     NC = new InvokeInst(Callee, II->getNormalDest(), II->getExceptionalDest(),
1199                         Args, Caller->getName(), Caller);
1200   } else {
1201     NC = new CallInst(Callee, Args, Caller->getName(), Caller);
1202   }
1203
1204   // Insert a cast of the return type as necessary...
1205   Value *NV = NC;
1206   if (Caller->getType() != NV->getType() && !Caller->use_empty()) {
1207     if (NV->getType() != Type::VoidTy) {
1208       NV = NC = new CastInst(NC, Caller->getType(), "tmp");
1209       InsertNewInstBefore(NC, *Caller);
1210       AddUsesToWorkList(*Caller);
1211     } else {
1212       NV = Constant::getNullValue(Caller->getType());
1213     }
1214   }
1215
1216   if (Caller->getType() != Type::VoidTy && !Caller->use_empty())
1217     Caller->replaceAllUsesWith(NV);
1218   Caller->getParent()->getInstList().erase(Caller);
1219   removeFromWorkList(Caller);
1220   return true;
1221 }
1222
1223
1224
1225 // PHINode simplification
1226 //
1227 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
1228   // If the PHI node only has one incoming value, eliminate the PHI node...
1229   if (PN.getNumIncomingValues() == 1)
1230     return ReplaceInstUsesWith(PN, PN.getIncomingValue(0));
1231
1232   // Otherwise if all of the incoming values are the same for the PHI, replace
1233   // the PHI node with the incoming value.
1234   //
1235   Value *InVal = 0;
1236   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
1237     if (PN.getIncomingValue(i) != &PN)  // Not the PHI node itself...
1238       if (InVal && PN.getIncomingValue(i) != InVal)
1239         return 0;  // Not the same, bail out.
1240       else
1241         InVal = PN.getIncomingValue(i);
1242
1243   // The only case that could cause InVal to be null is if we have a PHI node
1244   // that only has entries for itself.  In this case, there is no entry into the
1245   // loop, so kill the PHI.
1246   //
1247   if (InVal == 0) InVal = Constant::getNullValue(PN.getType());
1248
1249   // All of the incoming values are the same, replace the PHI node now.
1250   return ReplaceInstUsesWith(PN, InVal);
1251 }
1252
1253
1254 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1255   // Is it 'getelementptr %P, long 0'  or 'getelementptr %P'
1256   // If so, eliminate the noop.
1257   if ((GEP.getNumOperands() == 2 &&
1258        GEP.getOperand(1) == Constant::getNullValue(Type::LongTy)) ||
1259       GEP.getNumOperands() == 1)
1260     return ReplaceInstUsesWith(GEP, GEP.getOperand(0));
1261
1262   // Combine Indices - If the source pointer to this getelementptr instruction
1263   // is a getelementptr instruction, combine the indices of the two
1264   // getelementptr instructions into a single instruction.
1265   //
1266   if (GetElementPtrInst *Src = dyn_cast<GetElementPtrInst>(GEP.getOperand(0))) {
1267     std::vector<Value *> Indices;
1268
1269     // Can we combine the two pointer arithmetics offsets?
1270     if (Src->getNumOperands() == 2 && isa<Constant>(Src->getOperand(1)) &&
1271         isa<Constant>(GEP.getOperand(1))) {
1272       // Replace: gep (gep %P, long C1), long C2, ...
1273       // With:    gep %P, long (C1+C2), ...
1274       Value *Sum = ConstantExpr::get(Instruction::Add,
1275                                      cast<Constant>(Src->getOperand(1)),
1276                                      cast<Constant>(GEP.getOperand(1)));
1277       assert(Sum && "Constant folding of longs failed!?");
1278       GEP.setOperand(0, Src->getOperand(0));
1279       GEP.setOperand(1, Sum);
1280       AddUsesToWorkList(*Src);   // Reduce use count of Src
1281       return &GEP;
1282     } else if (Src->getNumOperands() == 2) {
1283       // Replace: gep (gep %P, long B), long A, ...
1284       // With:    T = long A+B; gep %P, T, ...
1285       //
1286       Value *Sum = BinaryOperator::create(Instruction::Add, Src->getOperand(1),
1287                                           GEP.getOperand(1),
1288                                           Src->getName()+".sum", &GEP);
1289       GEP.setOperand(0, Src->getOperand(0));
1290       GEP.setOperand(1, Sum);
1291       WorkList.push_back(cast<Instruction>(Sum));
1292       return &GEP;
1293     } else if (*GEP.idx_begin() == Constant::getNullValue(Type::LongTy) &&
1294                Src->getNumOperands() != 1) {
1295       // Otherwise we can do the fold if the first index of the GEP is a zero
1296       Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
1297       Indices.insert(Indices.end(), GEP.idx_begin()+1, GEP.idx_end());
1298     } else if (Src->getOperand(Src->getNumOperands()-1) ==
1299                Constant::getNullValue(Type::LongTy)) {
1300       // If the src gep ends with a constant array index, merge this get into
1301       // it, even if we have a non-zero array index.
1302       Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end()-1);
1303       Indices.insert(Indices.end(), GEP.idx_begin(), GEP.idx_end());
1304     }
1305
1306     if (!Indices.empty())
1307       return new GetElementPtrInst(Src->getOperand(0), Indices, GEP.getName());
1308
1309   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(GEP.getOperand(0))) {
1310     // GEP of global variable.  If all of the indices for this GEP are
1311     // constants, we can promote this to a constexpr instead of an instruction.
1312
1313     // Scan for nonconstants...
1314     std::vector<Constant*> Indices;
1315     User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end();
1316     for (; I != E && isa<Constant>(*I); ++I)
1317       Indices.push_back(cast<Constant>(*I));
1318
1319     if (I == E) {  // If they are all constants...
1320       Constant *CE =
1321         ConstantExpr::getGetElementPtr(ConstantPointerRef::get(GV), Indices);
1322
1323       // Replace all uses of the GEP with the new constexpr...
1324       return ReplaceInstUsesWith(GEP, CE);
1325     }
1326   }
1327
1328   return 0;
1329 }
1330
1331 Instruction *InstCombiner::visitAllocationInst(AllocationInst &AI) {
1332   // Convert: malloc Ty, C - where C is a constant != 1 into: malloc [C x Ty], 1
1333   if (AI.isArrayAllocation())    // Check C != 1
1334     if (const ConstantUInt *C = dyn_cast<ConstantUInt>(AI.getArraySize())) {
1335       const Type *NewTy = ArrayType::get(AI.getAllocatedType(), C->getValue());
1336       AllocationInst *New = 0;
1337
1338       // Create and insert the replacement instruction...
1339       if (isa<MallocInst>(AI))
1340         New = new MallocInst(NewTy, 0, AI.getName(), &AI);
1341       else {
1342         assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
1343         New = new AllocaInst(NewTy, 0, AI.getName(), &AI);
1344       }
1345
1346       // Scan to the end of the allocation instructions, to skip over a block of
1347       // allocas if possible...
1348       //
1349       BasicBlock::iterator It = New;
1350       while (isa<AllocationInst>(*It)) ++It;
1351
1352       // Now that I is pointing to the first non-allocation-inst in the block,
1353       // insert our getelementptr instruction...
1354       //
1355       std::vector<Value*> Idx(2, Constant::getNullValue(Type::LongTy));
1356       Value *V = new GetElementPtrInst(New, Idx, New->getName()+".sub", It);
1357
1358       // Now make everything use the getelementptr instead of the original
1359       // allocation.
1360       ReplaceInstUsesWith(AI, V);
1361       return &AI;
1362     }
1363   return 0;
1364 }
1365
1366 /// GetGEPGlobalInitializer - Given a constant, and a getelementptr
1367 /// constantexpr, return the constant value being addressed by the constant
1368 /// expression, or null if something is funny.
1369 ///
1370 static Constant *GetGEPGlobalInitializer(Constant *C, ConstantExpr *CE) {
1371   if (CE->getOperand(1) != Constant::getNullValue(Type::LongTy))
1372     return 0;  // Do not allow stepping over the value!
1373
1374   // Loop over all of the operands, tracking down which value we are
1375   // addressing...
1376   for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i)
1377     if (ConstantUInt *CU = dyn_cast<ConstantUInt>(CE->getOperand(i))) {
1378       ConstantStruct *CS = cast<ConstantStruct>(C);
1379       if (CU->getValue() >= CS->getValues().size()) return 0;
1380       C = cast<Constant>(CS->getValues()[CU->getValue()]);
1381     } else if (ConstantSInt *CS = dyn_cast<ConstantSInt>(CE->getOperand(i))) {
1382       ConstantArray *CA = cast<ConstantArray>(C);
1383       if ((uint64_t)CS->getValue() >= CA->getValues().size()) return 0;
1384       C = cast<Constant>(CA->getValues()[CS->getValue()]);
1385     } else
1386       return 0;
1387   return C;
1388 }
1389
1390 Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
1391   Value *Op = LI.getOperand(0);
1392   if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Op))
1393     Op = CPR->getValue();
1394
1395   // Instcombine load (constant global) into the value loaded...
1396   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Op))
1397     if (GV->isConstant() && !GV->isExternal())
1398       return ReplaceInstUsesWith(LI, GV->getInitializer());
1399
1400   // Instcombine load (constantexpr_GEP global, 0, ...) into the value loaded...
1401   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
1402     if (CE->getOpcode() == Instruction::GetElementPtr)
1403       if (ConstantPointerRef *G=dyn_cast<ConstantPointerRef>(CE->getOperand(0)))
1404         if (GlobalVariable *GV = dyn_cast<GlobalVariable>(G->getValue()))
1405           if (GV->isConstant() && !GV->isExternal())
1406             if (Constant *V = GetGEPGlobalInitializer(GV->getInitializer(), CE))
1407               return ReplaceInstUsesWith(LI, V);
1408   return 0;
1409 }
1410
1411
1412 Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
1413   // Change br (not X), label True, label False to: br X, label False, True
1414   if (BI.isConditional() && !isa<Constant>(BI.getCondition()))
1415     if (Value *V = dyn_castNotVal(BI.getCondition())) {
1416       BasicBlock *TrueDest = BI.getSuccessor(0);
1417       BasicBlock *FalseDest = BI.getSuccessor(1);
1418       // Swap Destinations and condition...
1419       BI.setCondition(V);
1420       BI.setSuccessor(0, FalseDest);
1421       BI.setSuccessor(1, TrueDest);
1422       return &BI;
1423     }
1424   return 0;
1425 }
1426
1427
1428 void InstCombiner::removeFromWorkList(Instruction *I) {
1429   WorkList.erase(std::remove(WorkList.begin(), WorkList.end(), I),
1430                  WorkList.end());
1431 }
1432
1433 bool InstCombiner::runOnFunction(Function &F) {
1434   bool Changed = false;
1435
1436   WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
1437
1438   while (!WorkList.empty()) {
1439     Instruction *I = WorkList.back();  // Get an instruction from the worklist
1440     WorkList.pop_back();
1441
1442     // Check to see if we can DCE or ConstantPropagate the instruction...
1443     // Check to see if we can DIE the instruction...
1444     if (isInstructionTriviallyDead(I)) {
1445       // Add operands to the worklist...
1446       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1447         if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
1448           WorkList.push_back(Op);
1449
1450       ++NumDeadInst;
1451       BasicBlock::iterator BBI = I;
1452       if (dceInstruction(BBI)) {
1453         removeFromWorkList(I);
1454         continue;
1455       }
1456     }
1457
1458     // Instruction isn't dead, see if we can constant propagate it...
1459     if (Constant *C = ConstantFoldInstruction(I)) {
1460       // Add operands to the worklist...
1461       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1462         if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
1463           WorkList.push_back(Op);
1464       ReplaceInstUsesWith(*I, C);
1465
1466       ++NumConstProp;
1467       BasicBlock::iterator BBI = I;
1468       if (dceInstruction(BBI)) {
1469         removeFromWorkList(I);
1470         continue;
1471       }
1472     }
1473
1474     // Now that we have an instruction, try combining it to simplify it...
1475     if (Instruction *Result = visit(*I)) {
1476       ++NumCombined;
1477       // Should we replace the old instruction with a new one?
1478       if (Result != I) {
1479         // Instructions can end up on the worklist more than once.  Make sure
1480         // we do not process an instruction that has been deleted.
1481         removeFromWorkList(I);
1482         ReplaceInstWithInst(I, Result);
1483       } else {
1484         BasicBlock::iterator II = I;
1485
1486         // If the instruction was modified, it's possible that it is now dead.
1487         // if so, remove it.
1488         if (dceInstruction(II)) {
1489           // Instructions may end up in the worklist more than once.  Erase them
1490           // all.
1491           removeFromWorkList(I);
1492           Result = 0;
1493         }
1494       }
1495
1496       if (Result) {
1497         WorkList.push_back(Result);
1498         AddUsesToWorkList(*Result);
1499       }
1500       Changed = true;
1501     }
1502   }
1503
1504   return Changed;
1505 }
1506
1507 Pass *createInstructionCombiningPass() {
1508   return new InstCombiner();
1509 }