lib/Transforms/Scalar/InstructionCombining.cpp

   1 //===- InstructionCombining.cpp - Combine multiple instructions -----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // InstructionCombining - Combine instructions to form fewer, simple
  11 // instructions.  This pass does not modify the CFG This pass is where algebraic
  12 // simplification happens.
  13 //
  14 // This pass combines things like:
  15 //    %Y = add int 1, %X
  16 //    %Z = add int 1, %Y
  17 // into:
  18 //    %Z = add int 2, %X
  19 //
  20 // This is a simple worklist driven algorithm.
  21 //
  22 // This pass guarantees that the following canonicalizations are performed on
  23 // the program:
  24 //    1. If a binary operator has a constant operand, it is moved to the RHS
  25 //    2. Bitwise operators with constant operands are always grouped so that
  26 //       shifts are performed first, then or's, then and's, then xor's.
  27 //    3. SetCC instructions are converted from <,>,<=,>= to ==,!= if possible
  28 //    4. All SetCC instructions on boolean values are replaced with logical ops
  29 //    5. add X, X is represented as (X*2) => (X << 1)
  30 //    6. Multiplies with a power-of-two constant argument are transformed into
  31 //       shifts.
  32 //    N. This list is incomplete
  33 //
  34 //===----------------------------------------------------------------------===//
  35
  36 #define DEBUG_TYPE "instcombine"
  37 #include "llvm/Transforms/Scalar.h"
  38 #include "llvm/Instructions.h"
  39 #include "llvm/Intrinsics.h"
  40 #include "llvm/Pass.h"
  41 #include "llvm/Constants.h"
  42 #include "llvm/DerivedTypes.h"
  43 #include "llvm/GlobalVariable.h"
  44 #include "llvm/Target/TargetData.h"
  45 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  46 #include "llvm/Transforms/Utils/Local.h"
  47 #include "llvm/Support/InstIterator.h"
  48 #include "llvm/Support/InstVisitor.h"
  49 #include "llvm/Support/CallSite.h"
  50 #include "Support/Debug.h"
  51 #include "Support/Statistic.h"
  52 #include <algorithm>
  53 using namespace llvm;
  54
  55 namespace {
  56   Statistic<> NumCombined ("instcombine", "Number of insts combined");
  57   Statistic<> NumConstProp("instcombine", "Number of constant folds");
  58   Statistic<> NumDeadInst ("instcombine", "Number of dead inst eliminated");
  59
  60   class InstCombiner : public FunctionPass,
  61                        public InstVisitor<InstCombiner, Instruction*> {
  62     // Worklist of all of the instructions that need to be simplified.
  63     std::vector<Instruction*> WorkList;
  64     TargetData *TD;
  65
  66     /// AddUsersToWorkList - When an instruction is simplified, add all users of
  67     /// the instruction to the work lists because they might get more simplified
  68     /// now.
  69     ///
  70     void AddUsersToWorkList(Instruction &I) {
  71       for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
  72            UI != UE; ++UI)
  73         WorkList.push_back(cast<Instruction>(*UI));
  74     }
  75
  76     /// AddUsesToWorkList - When an instruction is simplified, add operands to
  77     /// the work lists because they might get more simplified now.
  78     ///
  79     void AddUsesToWorkList(Instruction &I) {
  80       for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
  81         if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i)))
  82           WorkList.push_back(Op);
  83     }
  84
  85     // removeFromWorkList - remove all instances of I from the worklist.
  86     void removeFromWorkList(Instruction *I);
  87   public:
  88     virtual bool runOnFunction(Function &F);
  89
  90     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  91       AU.addRequired<TargetData>();
  92       AU.setPreservesCFG();
  93     }
  94
  95     // Visitation implementation - Implement instruction combining for different
  96     // instruction types.  The semantics are as follows:
  97     // Return Value:
  98     //    null        - No change was made
  99     //     I          - Change was made, I is still valid, I may be dead though
 100     //   otherwise    - Change was made, replace I with returned instruction
 101     //
 102     Instruction *visitAdd(BinaryOperator &I);
 103     Instruction *visitSub(BinaryOperator &I);
 104     Instruction *visitMul(BinaryOperator &I);
 105     Instruction *visitDiv(BinaryOperator &I);
 106     Instruction *visitRem(BinaryOperator &I);
 107     Instruction *visitAnd(BinaryOperator &I);
 108     Instruction *visitOr (BinaryOperator &I);
 109     Instruction *visitXor(BinaryOperator &I);
 110     Instruction *visitSetCondInst(BinaryOperator &I);
 111     Instruction *visitShiftInst(ShiftInst &I);
 112     Instruction *visitCastInst(CastInst &CI);
 113     Instruction *visitSelectInst(SelectInst &CI);
 114     Instruction *visitCallInst(CallInst &CI);
 115     Instruction *visitInvokeInst(InvokeInst &II);
 116     Instruction *visitPHINode(PHINode &PN);
 117     Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
 118     Instruction *visitAllocationInst(AllocationInst &AI);
 119     Instruction *visitFreeInst(FreeInst &FI);
 120     Instruction *visitLoadInst(LoadInst &LI);
 121     Instruction *visitBranchInst(BranchInst &BI);
 122
 123     // visitInstruction - Specify what to return for unhandled instructions...
 124     Instruction *visitInstruction(Instruction &I) { return 0; }
 125
 126   private:
 127     Instruction *visitCallSite(CallSite CS);
 128     bool transformConstExprCastCall(CallSite CS);
 129
 130     // InsertNewInstBefore - insert an instruction New before instruction Old
 131     // in the program.  Add the new instruction to the worklist.
 132     //
 133     Value *InsertNewInstBefore(Instruction *New, Instruction &Old) {
 134       assert(New && New->getParent() == 0 &&
 135              "New instruction already inserted into a basic block!");
 136       BasicBlock *BB = Old.getParent();
 137       BB->getInstList().insert(&Old, New);  // Insert inst
 138       WorkList.push_back(New);              // Add to worklist
 139       return New;
 140     }
 141
 142   public:
 143     // ReplaceInstUsesWith - This method is to be used when an instruction is
 144     // found to be dead, replacable with another preexisting expression.  Here
 145     // we add all uses of I to the worklist, replace all uses of I with the new
 146     // value, then return I, so that the inst combiner will know that I was
 147     // modified.
 148     //
 149     Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
 150       AddUsersToWorkList(I);         // Add all modified instrs to worklist
 151       I.replaceAllUsesWith(V);
 152       return &I;
 153     }
 154
 155     // EraseInstFromFunction - When dealing with an instruction that has side
 156     // effects or produces a void value, we can't rely on DCE to delete the
 157     // instruction.  Instead, visit methods should return the value returned by
 158     // this function.
 159     Instruction *EraseInstFromFunction(Instruction &I) {
 160       assert(I.use_empty() && "Cannot erase instruction that is used!");
 161       AddUsesToWorkList(I);
 162       removeFromWorkList(&I);
 163       I.getParent()->getInstList().erase(&I);
 164       return 0;  // Don't do anything with FI
 165     }
 166
 167
 168   private:
 169     /// InsertOperandCastBefore - This inserts a cast of V to DestTy before the
 170     /// InsertBefore instruction.  This is specialized a bit to avoid inserting
 171     /// casts that are known to not do anything...
 172     ///
 173     Value *InsertOperandCastBefore(Value *V, const Type *DestTy,
 174                                    Instruction *InsertBefore);
 175
 176     // SimplifyCommutative - This performs a few simplifications for commutative
 177     // operators...
 178     bool SimplifyCommutative(BinaryOperator &I);
 179
 180     Instruction *OptAndOp(Instruction *Op, ConstantIntegral *OpRHS,
 181                           ConstantIntegral *AndRHS, BinaryOperator &TheAnd);
 182   };
 183
 184   RegisterOpt<InstCombiner> X("instcombine", "Combine redundant instructions");
 185 }
 186
 187 // getComplexity:  Assign a complexity or rank value to LLVM Values...
 188 //   0 -> Constant, 1 -> Other, 2 -> Argument, 2 -> Unary, 3 -> OtherInst
 189 static unsigned getComplexity(Value *V) {
 190   if (isa<Instruction>(V)) {
 191     if (BinaryOperator::isNeg(V) || BinaryOperator::isNot(V))
 192       return 2;
 193     return 3;
 194   }
 195   if (isa<Argument>(V)) return 2;
 196   return isa<Constant>(V) ? 0 : 1;
 197 }
 198
 199 // isOnlyUse - Return true if this instruction will be deleted if we stop using
 200 // it.
 201 static bool isOnlyUse(Value *V) {
 202   return V->hasOneUse() || isa<Constant>(V);
 203 }
 204
 205 // getSignedIntegralType - Given an unsigned integral type, return the signed
 206 // version of it that has the same size.
 207 static const Type *getSignedIntegralType(const Type *Ty) {
 208   switch (Ty->getPrimitiveID()) {
 209   default: assert(0 && "Invalid unsigned integer type!"); abort();
 210   case Type::UByteTyID:  return Type::SByteTy;
 211   case Type::UShortTyID: return Type::ShortTy;
 212   case Type::UIntTyID:   return Type::IntTy;
 213   case Type::ULongTyID:  return Type::LongTy;
 214   }
 215 }
 216
 217 // getUnsignedIntegralType - Given an signed integral type, return the unsigned
 218 // version of it that has the same size.
 219 static const Type *getUnsignedIntegralType(const Type *Ty) {
 220   switch (Ty->getPrimitiveID()) {
 221   default: assert(0 && "Invalid signed integer type!"); abort();
 222   case Type::SByteTyID: return Type::UByteTy;
 223   case Type::ShortTyID: return Type::UShortTy;
 224   case Type::IntTyID:   return Type::UIntTy;
 225   case Type::LongTyID:  return Type::ULongTy;
 226   }
 227 }
 228
 229 // getPromotedType - Return the specified type promoted as it would be to pass
 230 // though a va_arg area...
 231 static const Type *getPromotedType(const Type *Ty) {
 232   switch (Ty->getPrimitiveID()) {
 233   case Type::SByteTyID:
 234   case Type::ShortTyID:  return Type::IntTy;
 235   case Type::UByteTyID:
 236   case Type::UShortTyID: return Type::UIntTy;
 237   case Type::FloatTyID:  return Type::DoubleTy;
 238   default:               return Ty;
 239   }
 240 }
 241
 242 // SimplifyCommutative - This performs a few simplifications for commutative
 243 // operators:
 244 //
 245 //  1. Order operands such that they are listed from right (least complex) to
 246 //     left (most complex).  This puts constants before unary operators before
 247 //     binary operators.
 248 //
 249 //  2. Transform: (op (op V, C1), C2) ==> (op V, (op C1, C2))
 250 //  3. Transform: (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
 251 //
 252 bool InstCombiner::SimplifyCommutative(BinaryOperator &I) {
 253   bool Changed = false;
 254   if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1)))
 255     Changed = !I.swapOperands();
 256
 257   if (!I.isAssociative()) return Changed;
 258   Instruction::BinaryOps Opcode = I.getOpcode();
 259   if (BinaryOperator *Op = dyn_cast<BinaryOperator>(I.getOperand(0)))
 260     if (Op->getOpcode() == Opcode && isa<Constant>(Op->getOperand(1))) {
 261       if (isa<Constant>(I.getOperand(1))) {
 262         Constant *Folded = ConstantExpr::get(I.getOpcode(),
 263                                              cast<Constant>(I.getOperand(1)),
 264                                              cast<Constant>(Op->getOperand(1)));
 265         I.setOperand(0, Op->getOperand(0));
 266         I.setOperand(1, Folded);
 267         return true;
 268       } else if (BinaryOperator *Op1=dyn_cast<BinaryOperator>(I.getOperand(1)))
 269         if (Op1->getOpcode() == Opcode && isa<Constant>(Op1->getOperand(1)) &&
 270             isOnlyUse(Op) && isOnlyUse(Op1)) {
 271           Constant *C1 = cast<Constant>(Op->getOperand(1));
 272           Constant *C2 = cast<Constant>(Op1->getOperand(1));
 273
 274           // Fold (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
 275           Constant *Folded = ConstantExpr::get(I.getOpcode(), C1, C2);
 276           Instruction *New = BinaryOperator::create(Opcode, Op->getOperand(0),
 277                                                     Op1->getOperand(0),
 278                                                     Op1->getName(), &I);
 279           WorkList.push_back(New);
 280           I.setOperand(0, New);
 281           I.setOperand(1, Folded);
 282           return true;
 283         }
 284     }
 285   return Changed;
 286 }
 287
 288 // dyn_castNegVal - Given a 'sub' instruction, return the RHS of the instruction
 289 // if the LHS is a constant zero (which is the 'negate' form).
 290 //
 291 static inline Value *dyn_castNegVal(Value *V) {
 292   if (BinaryOperator::isNeg(V))
 293     return BinaryOperator::getNegArgument(cast<BinaryOperator>(V));
 294
 295   // Constants can be considered to be negated values if they can be folded...
 296   if (Constant *C = dyn_cast<Constant>(V))
 297     return ConstantExpr::get(Instruction::Sub,
 298                              Constant::getNullValue(V->getType()), C);
 299   return 0;
 300 }
 301
 302 static Constant *NotConstant(Constant *C) {
 303   return ConstantExpr::get(Instruction::Xor, C,
 304                            ConstantIntegral::getAllOnesValue(C->getType()));
 305 }
 306
 307 static inline Value *dyn_castNotVal(Value *V) {
 308   if (BinaryOperator::isNot(V))
 309     return BinaryOperator::getNotArgument(cast<BinaryOperator>(V));
 310
 311   // Constants can be considered to be not'ed values...
 312   if (ConstantIntegral *C = dyn_cast<ConstantIntegral>(V))
 313     return NotConstant(C);
 314   return 0;
 315 }
 316
 317 // dyn_castFoldableMul - If this value is a multiply that can be folded into
 318 // other computations (because it has a constant operand), return the
 319 // non-constant operand of the multiply.
 320 //
 321 static inline Value *dyn_castFoldableMul(Value *V) {
 322   if (V->hasOneUse() && V->getType()->isInteger())
 323     if (Instruction *I = dyn_cast<Instruction>(V))
 324       if (I->getOpcode() == Instruction::Mul)
 325         if (isa<Constant>(I->getOperand(1)))
 326           return I->getOperand(0);
 327   return 0;
 328 }
 329
 330 // dyn_castMaskingAnd - If this value is an And instruction masking a value with
 331 // a constant, return the constant being anded with.
 332 //
 333 template<class ValueType>
 334 static inline Constant *dyn_castMaskingAnd(ValueType *V) {
 335   if (Instruction *I = dyn_cast<Instruction>(V))
 336     if (I->getOpcode() == Instruction::And)
 337       return dyn_cast<Constant>(I->getOperand(1));
 338
 339   // If this is a constant, it acts just like we were masking with it.
 340   return dyn_cast<Constant>(V);
 341 }
 342
 343 // Log2 - Calculate the log base 2 for the specified value if it is exactly a
 344 // power of 2.
 345 static unsigned Log2(uint64_t Val) {
 346   assert(Val > 1 && "Values 0 and 1 should be handled elsewhere!");
 347   unsigned Count = 0;
 348   while (Val != 1) {
 349     if (Val & 1) return 0;    // Multiple bits set?
 350     Val >>= 1;
 351     ++Count;
 352   }
 353   return Count;
 354 }
 355
 356
 357 /// AssociativeOpt - Perform an optimization on an associative operator.  This
 358 /// function is designed to check a chain of associative operators for a
 359 /// potential to apply a certain optimization.  Since the optimization may be
 360 /// applicable if the expression was reassociated, this checks the chain, then
 361 /// reassociates the expression as necessary to expose the optimization
 362 /// opportunity.  This makes use of a special Functor, which must define
 363 /// 'shouldApply' and 'apply' methods.
 364 ///
 365 template<typename Functor>
 366 Instruction *AssociativeOpt(BinaryOperator &Root, const Functor &F) {
 367   unsigned Opcode = Root.getOpcode();
 368   Value *LHS = Root.getOperand(0);
 369
 370   // Quick check, see if the immediate LHS matches...
 371   if (F.shouldApply(LHS))
 372     return F.apply(Root);
 373
 374   // Otherwise, if the LHS is not of the same opcode as the root, return.
 375   Instruction *LHSI = dyn_cast<Instruction>(LHS);
 376   while (LHSI && LHSI->getOpcode() == Opcode && LHSI->hasOneUse()) {
 377     // Should we apply this transform to the RHS?
 378     bool ShouldApply = F.shouldApply(LHSI->getOperand(1));
 379
 380     // If not to the RHS, check to see if we should apply to the LHS...
 381     if (!ShouldApply && F.shouldApply(LHSI->getOperand(0))) {
 382       cast<BinaryOperator>(LHSI)->swapOperands();   // Make the LHS the RHS
 383       ShouldApply = true;
 384     }
 385
 386     // If the functor wants to apply the optimization to the RHS of LHSI,
 387     // reassociate the expression from ((? op A) op B) to (? op (A op B))
 388     if (ShouldApply) {
 389       BasicBlock *BB = Root.getParent();
 390       // All of the instructions have a single use and have no side-effects,
 391       // because of this, we can pull them all into the current basic block.
 392       if (LHSI->getParent() != BB) {
 393         // Move all of the instructions from root to LHSI into the current
 394         // block.
 395         Instruction *TmpLHSI = cast<Instruction>(Root.getOperand(0));
 396         Instruction *LastUse = &Root;
 397         while (TmpLHSI->getParent() == BB) {
 398           LastUse = TmpLHSI;
 399           TmpLHSI = cast<Instruction>(TmpLHSI->getOperand(0));
 400         }
 401
 402         // Loop over all of the instructions in other blocks, moving them into
 403         // the current one.
 404         Value *TmpLHS = TmpLHSI;
 405         do {
 406           TmpLHSI = cast<Instruction>(TmpLHS);
 407           // Remove from current block...
 408           TmpLHSI->getParent()->getInstList().remove(TmpLHSI);
 409           // Insert before the last instruction...
 410           BB->getInstList().insert(LastUse, TmpLHSI);
 411           TmpLHS = TmpLHSI->getOperand(0);
 412         } while (TmpLHSI != LHSI);
 413       }
 414
 415       // Now all of the instructions are in the current basic block, go ahead
 416       // and perform the reassociation.
 417       Instruction *TmpLHSI = cast<Instruction>(Root.getOperand(0));
 418
 419       // First move the selected RHS to the LHS of the root...
 420       Root.setOperand(0, LHSI->getOperand(1));
 421
 422       // Make what used to be the LHS of the root be the user of the root...
 423       Value *ExtraOperand = TmpLHSI->getOperand(1);
 424       Root.replaceAllUsesWith(TmpLHSI);          // Users now use TmpLHSI
 425       TmpLHSI->setOperand(1, &Root);             // TmpLHSI now uses the root
 426       BB->getInstList().remove(&Root);           // Remove root from the BB
 427       BB->getInstList().insert(TmpLHSI, &Root);  // Insert root before TmpLHSI
 428
 429       // Now propagate the ExtraOperand down the chain of instructions until we
 430       // get to LHSI.
 431       while (TmpLHSI != LHSI) {
 432         Instruction *NextLHSI = cast<Instruction>(TmpLHSI->getOperand(0));
 433         Value *NextOp = NextLHSI->getOperand(1);
 434         NextLHSI->setOperand(1, ExtraOperand);
 435         TmpLHSI = NextLHSI;
 436         ExtraOperand = NextOp;
 437       }
 438
 439       // Now that the instructions are reassociated, have the functor perform
 440       // the transformation...
 441       return F.apply(Root);
 442     }
 443
 444     LHSI = dyn_cast<Instruction>(LHSI->getOperand(0));
 445   }
 446   return 0;
 447 }
 448
 449
 450 // AddRHS - Implements: X + X --> X << 1
 451 struct AddRHS {
 452   Value *RHS;
 453   AddRHS(Value *rhs) : RHS(rhs) {}
 454   bool shouldApply(Value *LHS) const { return LHS == RHS; }
 455   Instruction *apply(BinaryOperator &Add) const {
 456     return new ShiftInst(Instruction::Shl, Add.getOperand(0),
 457                          ConstantInt::get(Type::UByteTy, 1));
 458   }
 459 };
 460
 461 // AddMaskingAnd - Implements (A & C1)+(B & C2) --> (A & C1)|(B & C2)
 462 //                 iff C1&C2 == 0
 463 struct AddMaskingAnd {
 464   Constant *C2;
 465   AddMaskingAnd(Constant *c) : C2(c) {}
 466   bool shouldApply(Value *LHS) const {
 467     if (Constant *C1 = dyn_castMaskingAnd(LHS))
 468       return ConstantExpr::get(Instruction::And, C1, C2)->isNullValue();
 469     return false;
 470   }
 471   Instruction *apply(BinaryOperator &Add) const {
 472     return BinaryOperator::create(Instruction::Or, Add.getOperand(0),
 473                                   Add.getOperand(1));
 474   }
 475 };
 476
 477
 478
 479 Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
 480   bool Changed = SimplifyCommutative(I);
 481   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
 482
 483   // X + 0 --> X
 484   if (!I.getType()->isFloatingPoint() &&    // -0 + +0 = +0, so it's not a noop
 485       RHS == Constant::getNullValue(I.getType()))
 486     return ReplaceInstUsesWith(I, LHS);
 487
 488   // X + X --> X << 1
 489   if (I.getType()->isInteger())
 490     if (Instruction *Result = AssociativeOpt(I, AddRHS(RHS))) return Result;
 491
 492   // -A + B  -->  B - A
 493   if (Value *V = dyn_castNegVal(LHS))
 494     return BinaryOperator::create(Instruction::Sub, RHS, V);
 495
 496   // A + -B  -->  A - B
 497   if (!isa<Constant>(RHS))
 498     if (Value *V = dyn_castNegVal(RHS))
 499       return BinaryOperator::create(Instruction::Sub, LHS, V);
 500
 501   // X*C + X --> X * (C+1)
 502   if (dyn_castFoldableMul(LHS) == RHS) {
 503     Constant *CP1 =
 504       ConstantExpr::get(Instruction::Add,
 505                         cast<Constant>(cast<Instruction>(LHS)->getOperand(1)),
 506                         ConstantInt::get(I.getType(), 1));
 507     return BinaryOperator::create(Instruction::Mul, RHS, CP1);
 508   }
 509
 510   // X + X*C --> X * (C+1)
 511   if (dyn_castFoldableMul(RHS) == LHS) {
 512     Constant *CP1 =
 513       ConstantExpr::get(Instruction::Add,
 514                         cast<Constant>(cast<Instruction>(RHS)->getOperand(1)),
 515                         ConstantInt::get(I.getType(), 1));
 516     return BinaryOperator::create(Instruction::Mul, LHS, CP1);
 517   }
 518
 519   // (A & C1)+(B & C2) --> (A & C1)|(B & C2) iff C1&C2 == 0
 520   if (Constant *C2 = dyn_castMaskingAnd(RHS))
 521     if (Instruction *R = AssociativeOpt(I, AddMaskingAnd(C2))) return R;
 522
 523   if (ConstantInt *CRHS = dyn_cast<ConstantInt>(RHS)) {
 524     if (Instruction *ILHS = dyn_cast<Instruction>(LHS)) {
 525       switch (ILHS->getOpcode()) {
 526       case Instruction::Xor:
 527         // ~X + C --> (C-1) - X
 528         if (ConstantInt *XorRHS = dyn_cast<ConstantInt>(ILHS->getOperand(1)))
 529           if (XorRHS->isAllOnesValue())
 530             return BinaryOperator::create(Instruction::Sub,
 531                                           ConstantExpr::get(Instruction::Sub,
 532                                     CRHS, ConstantInt::get(I.getType(), 1)),
 533                                           ILHS->getOperand(0));
 534         break;
 535       default: break;
 536       }
 537     }
 538   }
 539
 540   return Changed ? &I : 0;
 541 }
 542
 543 // isSignBit - Return true if the value represented by the constant only has the
 544 // highest order bit set.
 545 static bool isSignBit(ConstantInt *CI) {
 546   unsigned NumBits = CI->getType()->getPrimitiveSize()*8;
 547   return (CI->getRawValue() & ~(-1LL << NumBits)) == (1ULL << (NumBits-1));
 548 }
 549
 550 static unsigned getTypeSizeInBits(const Type *Ty) {
 551   return Ty == Type::BoolTy ? 1 : Ty->getPrimitiveSize()*8;
 552 }
 553
 554 /// RemoveNoopCast - Strip off nonconverting casts from the value.
 555 ///
 556 static Value *RemoveNoopCast(Value *V) {
 557   if (CastInst *CI = dyn_cast<CastInst>(V)) {
 558     const Type *CTy = CI->getType();
 559     const Type *OpTy = CI->getOperand(0)->getType();
 560     if (CTy->isInteger() && OpTy->isInteger()) {
 561       if (CTy->getPrimitiveSize() == OpTy->getPrimitiveSize())
 562         return RemoveNoopCast(CI->getOperand(0));
 563     } else if (isa<PointerType>(CTy) && isa<PointerType>(OpTy))
 564       return RemoveNoopCast(CI->getOperand(0));
 565   }
 566   return V;
 567 }
 568
 569 Instruction *InstCombiner::visitSub(BinaryOperator &I) {
 570   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 571
 572   if (Op0 == Op1)         // sub X, X  -> 0
 573     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 574
 575   // If this is a 'B = x-(-A)', change to B = x+A...
 576   if (Value *V = dyn_castNegVal(Op1))
 577     return BinaryOperator::create(Instruction::Add, Op0, V);
 578
 579   if (ConstantInt *C = dyn_cast<ConstantInt>(Op0)) {
 580     // Replace (-1 - A) with (~A)...
 581     if (C->isAllOnesValue())
 582       return BinaryOperator::createNot(Op1);
 583
 584     // C - ~X == X + (1+C)
 585     if (BinaryOperator::isNot(Op1))
 586       return BinaryOperator::create(Instruction::Add,
 587                BinaryOperator::getNotArgument(cast<BinaryOperator>(Op1)),
 588                     ConstantExpr::get(Instruction::Add, C,
 589                                       ConstantInt::get(I.getType(), 1)));
 590     // -((uint)X >> 31) -> ((int)X >> 31)
 591     // -((int)X >> 31) -> ((uint)X >> 31)
 592     if (C->isNullValue()) {
 593       Value *NoopCastedRHS = RemoveNoopCast(Op1);
 594       if (ShiftInst *SI = dyn_cast<ShiftInst>(NoopCastedRHS))
 595         if (SI->getOpcode() == Instruction::Shr)
 596           if (ConstantUInt *CU = dyn_cast<ConstantUInt>(SI->getOperand(1))) {
 597             const Type *NewTy;
 598             if (SI->getType()->isSigned())
 599               NewTy = getUnsignedIntegralType(SI->getType());
 600             else
 601               NewTy = getSignedIntegralType(SI->getType());
 602             // Check to see if we are shifting out everything but the sign bit.
 603             if (CU->getValue() == SI->getType()->getPrimitiveSize()*8-1) {
 604               // Ok, the transformation is safe.  Insert a cast of the incoming
 605               // value, then the new shift, then the new cast.
 606               Instruction *FirstCast = new CastInst(SI->getOperand(0), NewTy,
 607                                                  SI->getOperand(0)->getName());
 608               Value *InV = InsertNewInstBefore(FirstCast, I);
 609               Instruction *NewShift = new ShiftInst(Instruction::Shr, FirstCast,
 610                                                     CU, SI->getName());
 611               if (NewShift->getType() == I.getType())
 612                 return NewShift;
 613               else {
 614                 InV = InsertNewInstBefore(NewShift, I);
 615                 return new CastInst(NewShift, I.getType());
 616               }
 617             }
 618           }
 619     }
 620   }
 621
 622   if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
 623     if (Op1I->hasOneUse()) {
 624       // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression
 625       // is not used by anyone else...
 626       //
 627       if (Op1I->getOpcode() == Instruction::Sub &&
 628           !Op1I->getType()->isFloatingPoint()) {
 629         // Swap the two operands of the subexpr...
 630         Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
 631         Op1I->setOperand(0, IIOp1);
 632         Op1I->setOperand(1, IIOp0);
 633
 634         // Create the new top level add instruction...
 635         return BinaryOperator::create(Instruction::Add, Op0, Op1);
 636       }
 637
 638       // Replace (A - (A & B)) with (A & ~B) if this is the only use of (A&B)...
 639       //
 640       if (Op1I->getOpcode() == Instruction::And &&
 641           (Op1I->getOperand(0) == Op0 || Op1I->getOperand(1) == Op0)) {
 642         Value *OtherOp = Op1I->getOperand(Op1I->getOperand(0) == Op0);
 643
 644         Instruction *NewNot = BinaryOperator::createNot(OtherOp, "B.not", &I);
 645         return BinaryOperator::create(Instruction::And, Op0, NewNot);
 646       }
 647
 648       // X - X*C --> X * (1-C)
 649       if (dyn_castFoldableMul(Op1I) == Op0) {
 650         Constant *CP1 =
 651           ConstantExpr::get(Instruction::Sub,
 652                             ConstantInt::get(I.getType(), 1),
 653                          cast<Constant>(cast<Instruction>(Op1)->getOperand(1)));
 654         assert(CP1 && "Couldn't constant fold 1-C?");
 655         return BinaryOperator::create(Instruction::Mul, Op0, CP1);
 656       }
 657     }
 658
 659   // X*C - X --> X * (C-1)
 660   if (dyn_castFoldableMul(Op0) == Op1) {
 661     Constant *CP1 =
 662       ConstantExpr::get(Instruction::Sub,
 663                         cast<Constant>(cast<Instruction>(Op0)->getOperand(1)),
 664                         ConstantInt::get(I.getType(), 1));
 665     assert(CP1 && "Couldn't constant fold C - 1?");
 666     return BinaryOperator::create(Instruction::Mul, Op1, CP1);
 667   }
 668
 669   return 0;
 670 }
 671
 672 /// isSignBitCheck - Given an exploded setcc instruction, return true if it is
 673 /// really just returns true if the most significant (sign) bit is set.
 674 static bool isSignBitCheck(unsigned Opcode, Value *LHS, ConstantInt *RHS) {
 675   if (RHS->getType()->isSigned()) {
 676     // True if source is LHS < 0 or LHS <= -1
 677     return Opcode == Instruction::SetLT && RHS->isNullValue() ||
 678            Opcode == Instruction::SetLE && RHS->isAllOnesValue();
 679   } else {
 680     ConstantUInt *RHSC = cast<ConstantUInt>(RHS);
 681     // True if source is LHS > 127 or LHS >= 128, where the constants depend on
 682     // the size of the integer type.
 683     if (Opcode == Instruction::SetGE)
 684       return RHSC->getValue() == 1ULL<<(RHS->getType()->getPrimitiveSize()*8-1);
 685     if (Opcode == Instruction::SetGT)
 686       return RHSC->getValue() ==
 687         (1ULL << (RHS->getType()->getPrimitiveSize()*8-1))-1;
 688   }
 689   return false;
 690 }
 691
 692 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
 693   bool Changed = SimplifyCommutative(I);
 694   Value *Op0 = I.getOperand(0);
 695
 696   // Simplify mul instructions with a constant RHS...
 697   if (Constant *Op1 = dyn_cast<Constant>(I.getOperand(1))) {
 698     if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
 699
 700       // ((X << C1)*C2) == (X * (C2 << C1))
 701       if (ShiftInst *SI = dyn_cast<ShiftInst>(Op0))
 702         if (SI->getOpcode() == Instruction::Shl)
 703           if (Constant *ShOp = dyn_cast<Constant>(SI->getOperand(1)))
 704             return BinaryOperator::create(Instruction::Mul, SI->getOperand(0),
 705                                  ConstantExpr::get(Instruction::Shl, CI, ShOp));
 706
 707       if (CI->isNullValue())
 708         return ReplaceInstUsesWith(I, Op1);  // X * 0  == 0
 709       if (CI->equalsInt(1))                  // X * 1  == X
 710         return ReplaceInstUsesWith(I, Op0);
 711       if (CI->isAllOnesValue())              // X * -1 == 0 - X
 712         return BinaryOperator::createNeg(Op0, I.getName());
 713
 714       int64_t Val = (int64_t)cast<ConstantInt>(CI)->getRawValue();
 715       if (uint64_t C = Log2(Val))            // Replace X*(2^C) with X << C
 716         return new ShiftInst(Instruction::Shl, Op0,
 717                              ConstantUInt::get(Type::UByteTy, C));
 718     } else {
 719       ConstantFP *Op1F = cast<ConstantFP>(Op1);
 720       if (Op1F->isNullValue())
 721         return ReplaceInstUsesWith(I, Op1);
 722
 723       // "In IEEE floating point, x*1 is not equivalent to x for nans.  However,
 724       // ANSI says we can drop signals, so we can do this anyway." (from GCC)
 725       if (Op1F->getValue() == 1.0)
 726         return ReplaceInstUsesWith(I, Op0);  // Eliminate 'mul double %X, 1.0'
 727     }
 728   }
 729
 730   if (Value *Op0v = dyn_castNegVal(Op0))     // -X * -Y = X*Y
 731     if (Value *Op1v = dyn_castNegVal(I.getOperand(1)))
 732       return BinaryOperator::create(Instruction::Mul, Op0v, Op1v);
 733
 734   // If one of the operands of the multiply is a cast from a boolean value, then
 735   // we know the bool is either zero or one, so this is a 'masking' multiply.
 736   // See if we can simplify things based on how the boolean was originally
 737   // formed.
 738   CastInst *BoolCast = 0;
 739   if (CastInst *CI = dyn_cast<CastInst>(I.getOperand(0)))
 740     if (CI->getOperand(0)->getType() == Type::BoolTy)
 741       BoolCast = CI;
 742   if (!BoolCast)
 743     if (CastInst *CI = dyn_cast<CastInst>(I.getOperand(1)))
 744       if (CI->getOperand(0)->getType() == Type::BoolTy)
 745         BoolCast = CI;
 746   if (BoolCast) {
 747     if (SetCondInst *SCI = dyn_cast<SetCondInst>(BoolCast->getOperand(0))) {
 748       Value *SCIOp0 = SCI->getOperand(0), *SCIOp1 = SCI->getOperand(1);
 749       const Type *SCOpTy = SCIOp0->getType();
 750
 751       // If the setcc is true iff the sign bit of X is set, then convert this
 752       // multiply into a shift/and combination.
 753       if (isa<ConstantInt>(SCIOp1) &&
 754           isSignBitCheck(SCI->getOpcode(), SCIOp0, cast<ConstantInt>(SCIOp1))) {
 755         // Shift the X value right to turn it into "all signbits".
 756         Constant *Amt = ConstantUInt::get(Type::UByteTy,
 757                                           SCOpTy->getPrimitiveSize()*8-1);
 758         if (SCIOp0->getType()->isUnsigned()) {
 759           const Type *NewTy = getSignedIntegralType(SCIOp0->getType());
 760           SCIOp0 = InsertNewInstBefore(new CastInst(SCIOp0, NewTy,
 761                                                     SCIOp0->getName()), I);
 762         }
 763
 764         Value *V =
 765           InsertNewInstBefore(new ShiftInst(Instruction::Shr, SCIOp0, Amt,
 766                                             BoolCast->getOperand(0)->getName()+
 767                                             ".mask"), I);
 768
 769         // If the multiply type is not the same as the source type, sign extend
 770         // or truncate to the multiply type.
 771         if (I.getType() != V->getType())
 772           V = InsertNewInstBefore(new CastInst(V, I.getType(), V->getName()),I);
 773
 774         Value *OtherOp = Op0 == BoolCast ? I.getOperand(1) : Op0;
 775         return BinaryOperator::create(Instruction::And, V, OtherOp);
 776       }
 777     }
 778   }
 779
 780   return Changed ? &I : 0;
 781 }
 782
 783 Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
 784   // div X, 1 == X
 785   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
 786     if (RHS->equalsInt(1))
 787       return ReplaceInstUsesWith(I, I.getOperand(0));
 788
 789     // Check to see if this is an unsigned division with an exact power of 2,
 790     // if so, convert to a right shift.
 791     if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
 792       if (uint64_t Val = C->getValue())    // Don't break X / 0
 793         if (uint64_t C = Log2(Val))
 794           return new ShiftInst(Instruction::Shr, I.getOperand(0),
 795                                ConstantUInt::get(Type::UByteTy, C));
 796   }
 797
 798   // 0 / X == 0, we don't need to preserve faults!
 799   if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
 800     if (LHS->equalsInt(0))
 801       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 802
 803   return 0;
 804 }
 805
 806
 807 Instruction *InstCombiner::visitRem(BinaryOperator &I) {
 808   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
 809     if (RHS->equalsInt(1))  // X % 1 == 0
 810       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 811
 812     // Check to see if this is an unsigned remainder with an exact power of 2,
 813     // if so, convert to a bitwise and.
 814     if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
 815       if (uint64_t Val = C->getValue())    // Don't break X % 0 (divide by zero)
 816         if (Log2(Val))
 817           return BinaryOperator::create(Instruction::And, I.getOperand(0),
 818                                         ConstantUInt::get(I.getType(), Val-1));
 819   }
 820
 821   // 0 % X == 0, we don't need to preserve faults!
 822   if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
 823     if (LHS->equalsInt(0))
 824       return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 825
 826   return 0;
 827 }
 828
 829 // isMaxValueMinusOne - return true if this is Max-1
 830 static bool isMaxValueMinusOne(const ConstantInt *C) {
 831   if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C)) {
 832     // Calculate -1 casted to the right type...
 833     unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 834     uint64_t Val = ~0ULL;                // All ones
 835     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 836     return CU->getValue() == Val-1;
 837   }
 838
 839   const ConstantSInt *CS = cast<ConstantSInt>(C);
 840
 841   // Calculate 0111111111..11111
 842   unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 843   int64_t Val = INT64_MAX;             // All ones
 844   Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 845   return CS->getValue() == Val-1;
 846 }
 847
 848 // isMinValuePlusOne - return true if this is Min+1
 849 static bool isMinValuePlusOne(const ConstantInt *C) {
 850   if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C))
 851     return CU->getValue() == 1;
 852
 853   const ConstantSInt *CS = cast<ConstantSInt>(C);
 854
 855   // Calculate 1111111111000000000000
 856   unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
 857   int64_t Val = -1;                    // All ones
 858   Val <<= TypeBits-1;                  // Shift over to the right spot
 859   return CS->getValue() == Val+1;
 860 }
 861
 862 /// getSetCondCode - Encode a setcc opcode into a three bit mask.  These bits
 863 /// are carefully arranged to allow folding of expressions such as:
 864 ///
 865 ///      (A < B) | (A > B) --> (A != B)
 866 ///
 867 /// Bit value '4' represents that the comparison is true if A > B, bit value '2'
 868 /// represents that the comparison is true if A == B, and bit value '1' is true
 869 /// if A < B.
 870 ///
 871 static unsigned getSetCondCode(const SetCondInst *SCI) {
 872   switch (SCI->getOpcode()) {
 873     // False -> 0
 874   case Instruction::SetGT: return 1;
 875   case Instruction::SetEQ: return 2;
 876   case Instruction::SetGE: return 3;
 877   case Instruction::SetLT: return 4;
 878   case Instruction::SetNE: return 5;
 879   case Instruction::SetLE: return 6;
 880     // True -> 7
 881   default:
 882     assert(0 && "Invalid SetCC opcode!");
 883     return 0;
 884   }
 885 }
 886
 887 /// getSetCCValue - This is the complement of getSetCondCode, which turns an
 888 /// opcode and two operands into either a constant true or false, or a brand new
 889 /// SetCC instruction.
 890 static Value *getSetCCValue(unsigned Opcode, Value *LHS, Value *RHS) {
 891   switch (Opcode) {
 892   case 0: return ConstantBool::False;
 893   case 1: return new SetCondInst(Instruction::SetGT, LHS, RHS);
 894   case 2: return new SetCondInst(Instruction::SetEQ, LHS, RHS);
 895   case 3: return new SetCondInst(Instruction::SetGE, LHS, RHS);
 896   case 4: return new SetCondInst(Instruction::SetLT, LHS, RHS);
 897   case 5: return new SetCondInst(Instruction::SetNE, LHS, RHS);
 898   case 6: return new SetCondInst(Instruction::SetLE, LHS, RHS);
 899   case 7: return ConstantBool::True;
 900   default: assert(0 && "Illegal SetCCCode!"); return 0;
 901   }
 902 }
 903
 904 // FoldSetCCLogical - Implements (setcc1 A, B) & (setcc2 A, B) --> (setcc3 A, B)
 905 struct FoldSetCCLogical {
 906   InstCombiner &IC;
 907   Value *LHS, *RHS;
 908   FoldSetCCLogical(InstCombiner &ic, SetCondInst *SCI)
 909     : IC(ic), LHS(SCI->getOperand(0)), RHS(SCI->getOperand(1)) {}
 910   bool shouldApply(Value *V) const {
 911     if (SetCondInst *SCI = dyn_cast<SetCondInst>(V))
 912       return (SCI->getOperand(0) == LHS && SCI->getOperand(1) == RHS ||
 913               SCI->getOperand(0) == RHS && SCI->getOperand(1) == LHS);
 914     return false;
 915   }
 916   Instruction *apply(BinaryOperator &Log) const {
 917     SetCondInst *SCI = cast<SetCondInst>(Log.getOperand(0));
 918     if (SCI->getOperand(0) != LHS) {
 919       assert(SCI->getOperand(1) == LHS);
 920       SCI->swapOperands();  // Swap the LHS and RHS of the SetCC
 921     }
 922
 923     unsigned LHSCode = getSetCondCode(SCI);
 924     unsigned RHSCode = getSetCondCode(cast<SetCondInst>(Log.getOperand(1)));
 925     unsigned Code;
 926     switch (Log.getOpcode()) {
 927     case Instruction::And: Code = LHSCode & RHSCode; break;
 928     case Instruction::Or:  Code = LHSCode | RHSCode; break;
 929     case Instruction::Xor: Code = LHSCode ^ RHSCode; break;
 930     default: assert(0 && "Illegal logical opcode!"); return 0;
 931     }
 932
 933     Value *RV = getSetCCValue(Code, LHS, RHS);
 934     if (Instruction *I = dyn_cast<Instruction>(RV))
 935       return I;
 936     // Otherwise, it's a constant boolean value...
 937     return IC.ReplaceInstUsesWith(Log, RV);
 938   }
 939 };
 940
 941
 942 // OptAndOp - This handles expressions of the form ((val OP C1) & C2).  Where
 943 // the Op parameter is 'OP', OpRHS is 'C1', and AndRHS is 'C2'.  Op is
 944 // guaranteed to be either a shift instruction or a binary operator.
 945 Instruction *InstCombiner::OptAndOp(Instruction *Op,
 946                                     ConstantIntegral *OpRHS,
 947                                     ConstantIntegral *AndRHS,
 948                                     BinaryOperator &TheAnd) {
 949   Value *X = Op->getOperand(0);
 950   Constant *Together = 0;
 951   if (!isa<ShiftInst>(Op))
 952     Together = ConstantExpr::get(Instruction::And, AndRHS, OpRHS);
 953
 954   switch (Op->getOpcode()) {
 955   case Instruction::Xor:
 956     if (Together->isNullValue()) {
 957       // (X ^ C1) & C2 --> (X & C2) iff (C1&C2) == 0
 958       return BinaryOperator::create(Instruction::And, X, AndRHS);
 959     } else if (Op->hasOneUse()) {
 960       // (X ^ C1) & C2 --> (X & C2) ^ (C1&C2)
 961       std::string OpName = Op->getName(); Op->setName("");
 962       Instruction *And = BinaryOperator::create(Instruction::And,
 963                                                 X, AndRHS, OpName);
 964       InsertNewInstBefore(And, TheAnd);
 965       return BinaryOperator::create(Instruction::Xor, And, Together);
 966     }
 967     break;
 968   case Instruction::Or:
 969     // (X | C1) & C2 --> X & C2 iff C1 & C1 == 0
 970     if (Together->isNullValue())
 971       return BinaryOperator::create(Instruction::And, X, AndRHS);
 972     else {
 973       if (Together == AndRHS) // (X | C) & C --> C
 974         return ReplaceInstUsesWith(TheAnd, AndRHS);
 975
 976       if (Op->hasOneUse() && Together != OpRHS) {
 977         // (X | C1) & C2 --> (X | (C1&C2)) & C2
 978         std::string Op0Name = Op->getName(); Op->setName("");
 979         Instruction *Or = BinaryOperator::create(Instruction::Or, X,
 980                                                  Together, Op0Name);
 981         InsertNewInstBefore(Or, TheAnd);
 982         return BinaryOperator::create(Instruction::And, Or, AndRHS);
 983       }
 984     }
 985     break;
 986   case Instruction::Add:
 987     if (Op->hasOneUse()) {
 988       // Adding a one to a single bit bit-field should be turned into an XOR
 989       // of the bit.  First thing to check is to see if this AND is with a
 990       // single bit constant.
 991       unsigned long long AndRHSV = cast<ConstantInt>(AndRHS)->getRawValue();
 992
 993       // Clear bits that are not part of the constant.
 994       AndRHSV &= (1ULL << AndRHS->getType()->getPrimitiveSize()*8)-1;
 995
 996       // If there is only one bit set...
 997       if ((AndRHSV & (AndRHSV-1)) == 0) {
 998         // Ok, at this point, we know that we are masking the result of the
 999         // ADD down to exactly one bit.  If the constant we are adding has
1000         // no bits set below this bit, then we can eliminate the ADD.
1001         unsigned long long AddRHS = cast<ConstantInt>(OpRHS)->getRawValue();
1002
1003         // Check to see if any bits below the one bit set in AndRHSV are set.
1004         if ((AddRHS & (AndRHSV-1)) == 0) {
1005           // If not, the only thing that can effect the output of the AND is
1006           // the bit specified by AndRHSV.  If that bit is set, the effect of
1007           // the XOR is to toggle the bit.  If it is clear, then the ADD has
1008           // no effect.
1009           if ((AddRHS & AndRHSV) == 0) { // Bit is not set, noop
1010             TheAnd.setOperand(0, X);
1011             return &TheAnd;
1012           } else {
1013             std::string Name = Op->getName(); Op->setName("");
1014             // Pull the XOR out of the AND.
1015             Instruction *NewAnd =
1016               BinaryOperator::create(Instruction::And, X, AndRHS, Name);
1017             InsertNewInstBefore(NewAnd, TheAnd);
1018             return BinaryOperator::create(Instruction::Xor, NewAnd, AndRHS);
1019           }
1020         }
1021       }
1022     }
1023     break;
1024
1025   case Instruction::Shl: {
1026     // We know that the AND will not produce any of the bits shifted in, so if
1027     // the anded constant includes them, clear them now!
1028     //
1029     Constant *AllOne = ConstantIntegral::getAllOnesValue(AndRHS->getType());
1030     Constant *CI = ConstantExpr::get(Instruction::And, AndRHS,
1031                             ConstantExpr::get(Instruction::Shl, AllOne, OpRHS));
1032     if (CI != AndRHS) {
1033       TheAnd.setOperand(1, CI);
1034       return &TheAnd;
1035     }
1036     break;
1037   }
1038   case Instruction::Shr:
1039     // We know that the AND will not produce any of the bits shifted in, so if
1040     // the anded constant includes them, clear them now!  This only applies to
1041     // unsigned shifts, because a signed shr may bring in set bits!
1042     //
1043     if (AndRHS->getType()->isUnsigned()) {
1044       Constant *AllOne = ConstantIntegral::getAllOnesValue(AndRHS->getType());
1045       Constant *CI = ConstantExpr::get(Instruction::And, AndRHS,
1046                             ConstantExpr::get(Instruction::Shr, AllOne, OpRHS));
1047       if (CI != AndRHS) {
1048         TheAnd.setOperand(1, CI);
1049         return &TheAnd;
1050       }
1051     }
1052     break;
1053   }
1054   return 0;
1055 }
1056
1057
1058 Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
1059   bool Changed = SimplifyCommutative(I);
1060   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1061
1062   // and X, X = X   and X, 0 == 0
1063   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
1064     return ReplaceInstUsesWith(I, Op1);
1065
1066   // and X, -1 == X
1067   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
1068     if (RHS->isAllOnesValue())
1069       return ReplaceInstUsesWith(I, Op0);
1070
1071     // Optimize a variety of ((val OP C1) & C2) combinations...
1072     if (isa<BinaryOperator>(Op0) || isa<ShiftInst>(Op0)) {
1073       Instruction *Op0I = cast<Instruction>(Op0);
1074       Value *X = Op0I->getOperand(0);
1075       if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
1076         if (Instruction *Res = OptAndOp(Op0I, Op0CI, RHS, I))
1077           return Res;
1078     }
1079   }
1080
1081   Value *Op0NotVal = dyn_castNotVal(Op0);
1082   Value *Op1NotVal = dyn_castNotVal(Op1);
1083
1084   // (~A & ~B) == (~(A | B)) - Demorgan's Law
1085   if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
1086     Instruction *Or = BinaryOperator::create(Instruction::Or, Op0NotVal,
1087                                              Op1NotVal,I.getName()+".demorgan");
1088     InsertNewInstBefore(Or, I);
1089     return BinaryOperator::createNot(Or);
1090   }
1091
1092   if (Op0NotVal == Op1 || Op1NotVal == Op0)  // A & ~A  == ~A & A == 0
1093     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
1094
1095   // (setcc1 A, B) & (setcc2 A, B) --> (setcc3 A, B)
1096   if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1097     if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1098       return R;
1099
1100   return Changed ? &I : 0;
1101 }
1102
1103
1104
1105 Instruction *InstCombiner::visitOr(BinaryOperator &I) {
1106   bool Changed = SimplifyCommutative(I);
1107   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1108
1109   // or X, X = X   or X, 0 == X
1110   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
1111     return ReplaceInstUsesWith(I, Op0);
1112
1113   // or X, -1 == -1
1114   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
1115     if (RHS->isAllOnesValue())
1116       return ReplaceInstUsesWith(I, Op1);
1117
1118     if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1119       // (X & C1) | C2 --> (X | C2) & (C1|C2)
1120       if (Op0I->getOpcode() == Instruction::And && isOnlyUse(Op0))
1121         if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
1122           std::string Op0Name = Op0I->getName(); Op0I->setName("");
1123           Instruction *Or = BinaryOperator::create(Instruction::Or,
1124                                                    Op0I->getOperand(0), RHS,
1125                                                    Op0Name);
1126           InsertNewInstBefore(Or, I);
1127           return BinaryOperator::create(Instruction::And, Or,
1128                              ConstantExpr::get(Instruction::Or, RHS, Op0CI));
1129         }
1130
1131       // (X ^ C1) | C2 --> (X | C2) ^ (C1&~C2)
1132       if (Op0I->getOpcode() == Instruction::Xor && isOnlyUse(Op0))
1133         if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
1134           std::string Op0Name = Op0I->getName(); Op0I->setName("");
1135           Instruction *Or = BinaryOperator::create(Instruction::Or,
1136                                                    Op0I->getOperand(0), RHS,
1137                                                    Op0Name);
1138           InsertNewInstBefore(Or, I);
1139           return BinaryOperator::create(Instruction::Xor, Or,
1140                             ConstantExpr::get(Instruction::And, Op0CI,
1141                                               NotConstant(RHS)));
1142         }
1143     }
1144   }
1145
1146   // (A & C1)|(A & C2) == A & (C1|C2)
1147   if (Instruction *LHS = dyn_cast<BinaryOperator>(Op0))
1148     if (Instruction *RHS = dyn_cast<BinaryOperator>(Op1))
1149       if (LHS->getOperand(0) == RHS->getOperand(0))
1150         if (Constant *C0 = dyn_castMaskingAnd(LHS))
1151           if (Constant *C1 = dyn_castMaskingAnd(RHS))
1152             return BinaryOperator::create(Instruction::And, LHS->getOperand(0),
1153                                     ConstantExpr::get(Instruction::Or, C0, C1));
1154
1155   Value *Op0NotVal = dyn_castNotVal(Op0);
1156   Value *Op1NotVal = dyn_castNotVal(Op1);
1157
1158   if (Op1 == Op0NotVal)   // ~A | A == -1
1159     return ReplaceInstUsesWith(I,
1160                                ConstantIntegral::getAllOnesValue(I.getType()));
1161
1162   if (Op0 == Op1NotVal)   // A | ~A == -1
1163     return ReplaceInstUsesWith(I,
1164                                ConstantIntegral::getAllOnesValue(I.getType()));
1165
1166   // (~A | ~B) == (~(A & B)) - Demorgan's Law
1167   if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
1168     Instruction *And = BinaryOperator::create(Instruction::And, Op0NotVal,
1169                                               Op1NotVal,I.getName()+".demorgan",
1170                                               &I);
1171     WorkList.push_back(And);
1172     return BinaryOperator::createNot(And);
1173   }
1174
1175   // (setcc1 A, B) | (setcc2 A, B) --> (setcc3 A, B)
1176   if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1177     if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1178       return R;
1179
1180   return Changed ? &I : 0;
1181 }
1182
1183 // XorSelf - Implements: X ^ X --> 0
1184 struct XorSelf {
1185   Value *RHS;
1186   XorSelf(Value *rhs) : RHS(rhs) {}
1187   bool shouldApply(Value *LHS) const { return LHS == RHS; }
1188   Instruction *apply(BinaryOperator &Xor) const {
1189     return &Xor;
1190   }
1191 };
1192
1193
1194 Instruction *InstCombiner::visitXor(BinaryOperator &I) {
1195   bool Changed = SimplifyCommutative(I);
1196   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1197
1198   // xor X, X = 0, even if X is nested in a sequence of Xor's.
1199   if (Instruction *Result = AssociativeOpt(I, XorSelf(Op1))) {
1200     assert(Result == &I && "AssociativeOpt didn't work?");
1201     return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
1202   }
1203
1204   if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
1205     // xor X, 0 == X
1206     if (RHS->isNullValue())
1207       return ReplaceInstUsesWith(I, Op0);
1208
1209     if (BinaryOperator *Op0I = dyn_cast<BinaryOperator>(Op0)) {
1210       // xor (setcc A, B), true = not (setcc A, B) = setncc A, B
1211       if (SetCondInst *SCI = dyn_cast<SetCondInst>(Op0I))
1212         if (RHS == ConstantBool::True && SCI->hasOneUse())
1213           return new SetCondInst(SCI->getInverseCondition(),
1214                                  SCI->getOperand(0), SCI->getOperand(1));
1215
1216       // ~(c-X) == X-c-1 == X+(-c-1)
1217       if (Op0I->getOpcode() == Instruction::Sub && RHS->isAllOnesValue())
1218         if (Constant *Op0I0C = dyn_cast<Constant>(Op0I->getOperand(0))) {
1219           Constant *NegOp0I0C = ConstantExpr::get(Instruction::Sub,
1220                              Constant::getNullValue(Op0I0C->getType()), Op0I0C);
1221           Constant *ConstantRHS = ConstantExpr::get(Instruction::Sub, NegOp0I0C,
1222                                               ConstantInt::get(I.getType(), 1));
1223           return BinaryOperator::create(Instruction::Add, Op0I->getOperand(1),
1224                                         ConstantRHS);
1225         }
1226
1227       if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
1228         switch (Op0I->getOpcode()) {
1229         case Instruction::Add:
1230           // ~(X-c) --> (-c-1)-X
1231           if (RHS->isAllOnesValue()) {
1232             Constant *NegOp0CI = ConstantExpr::get(Instruction::Sub,
1233                                Constant::getNullValue(Op0CI->getType()), Op0CI);
1234             return BinaryOperator::create(Instruction::Sub,
1235                            ConstantExpr::get(Instruction::Sub, NegOp0CI,
1236                                              ConstantInt::get(I.getType(), 1)),
1237                                           Op0I->getOperand(0));
1238           }
1239           break;
1240         case Instruction::And:
1241           // (X & C1) ^ C2 --> (X & C1) | C2 iff (C1&C2) == 0
1242           if (ConstantExpr::get(Instruction::And, RHS, Op0CI)->isNullValue())
1243             return BinaryOperator::create(Instruction::Or, Op0, RHS);
1244           break;
1245         case Instruction::Or:
1246           // (X | C1) ^ C2 --> (X | C1) & ~C2 iff (C1&C2) == C2
1247           if (ConstantExpr::get(Instruction::And, RHS, Op0CI) == RHS)
1248             return BinaryOperator::create(Instruction::And, Op0,
1249                                           NotConstant(RHS));
1250           break;
1251         default: break;
1252         }
1253     }
1254   }
1255
1256   if (Value *X = dyn_castNotVal(Op0))   // ~A ^ A == -1
1257     if (X == Op1)
1258       return ReplaceInstUsesWith(I,
1259                                 ConstantIntegral::getAllOnesValue(I.getType()));
1260
1261   if (Value *X = dyn_castNotVal(Op1))   // A ^ ~A == -1
1262     if (X == Op0)
1263       return ReplaceInstUsesWith(I,
1264                                 ConstantIntegral::getAllOnesValue(I.getType()));
1265
1266   if (Instruction *Op1I = dyn_cast<Instruction>(Op1))
1267     if (Op1I->getOpcode() == Instruction::Or) {
1268       if (Op1I->getOperand(0) == Op0) {              // B^(B|A) == (A|B)^B
1269         cast<BinaryOperator>(Op1I)->swapOperands();
1270         I.swapOperands();
1271         std::swap(Op0, Op1);
1272       } else if (Op1I->getOperand(1) == Op0) {       // B^(A|B) == (A|B)^B
1273         I.swapOperands();
1274         std::swap(Op0, Op1);
1275       }
1276     } else if (Op1I->getOpcode() == Instruction::Xor) {
1277       if (Op0 == Op1I->getOperand(0))                        // A^(A^B) == B
1278         return ReplaceInstUsesWith(I, Op1I->getOperand(1));
1279       else if (Op0 == Op1I->getOperand(1))                   // A^(B^A) == B
1280         return ReplaceInstUsesWith(I, Op1I->getOperand(0));
1281     }
1282
1283   if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
1284     if (Op0I->getOpcode() == Instruction::Or && Op0I->hasOneUse()) {
1285       if (Op0I->getOperand(0) == Op1)                // (B|A)^B == (A|B)^B
1286         cast<BinaryOperator>(Op0I)->swapOperands();
1287       if (Op0I->getOperand(1) == Op1) {              // (A|B)^B == A & ~B
1288         Value *NotB = BinaryOperator::createNot(Op1, Op1->getName()+".not", &I);
1289         WorkList.push_back(cast<Instruction>(NotB));
1290         return BinaryOperator::create(Instruction::And, Op0I->getOperand(0),
1291                                       NotB);
1292       }
1293     } else if (Op0I->getOpcode() == Instruction::Xor) {
1294       if (Op1 == Op0I->getOperand(0))                        // (A^B)^A == B
1295         return ReplaceInstUsesWith(I, Op0I->getOperand(1));
1296       else if (Op1 == Op0I->getOperand(1))                   // (B^A)^A == B
1297         return ReplaceInstUsesWith(I, Op0I->getOperand(0));
1298     }
1299
1300   // (A & C1)^(B & C2) -> (A & C1)|(B & C2) iff C1^C2 == 0
1301   if (Constant *C1 = dyn_castMaskingAnd(Op0))
1302     if (Constant *C2 = dyn_castMaskingAnd(Op1))
1303       if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
1304         return BinaryOperator::create(Instruction::Or, Op0, Op1);
1305
1306   // (setcc1 A, B) ^ (setcc2 A, B) --> (setcc3 A, B)
1307   if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1308     if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1309       return R;
1310
1311   return Changed ? &I : 0;
1312 }
1313
1314 // AddOne, SubOne - Add or subtract a constant one from an integer constant...
1315 static Constant *AddOne(ConstantInt *C) {
1316   Constant *Result = ConstantExpr::get(Instruction::Add, C,
1317                                        ConstantInt::get(C->getType(), 1));
1318   assert(Result && "Constant folding integer addition failed!");
1319   return Result;
1320 }
1321 static Constant *SubOne(ConstantInt *C) {
1322   Constant *Result = ConstantExpr::get(Instruction::Sub, C,
1323                                        ConstantInt::get(C->getType(), 1));
1324   assert(Result && "Constant folding integer addition failed!");
1325   return Result;
1326 }
1327
1328 // isTrueWhenEqual - Return true if the specified setcondinst instruction is
1329 // true when both operands are equal...
1330 //
1331 static bool isTrueWhenEqual(Instruction &I) {
1332   return I.getOpcode() == Instruction::SetEQ ||
1333          I.getOpcode() == Instruction::SetGE ||
1334          I.getOpcode() == Instruction::SetLE;
1335 }
1336
1337 Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
1338   bool Changed = SimplifyCommutative(I);
1339   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1340   const Type *Ty = Op0->getType();
1341
1342   // setcc X, X
1343   if (Op0 == Op1)
1344     return ReplaceInstUsesWith(I, ConstantBool::get(isTrueWhenEqual(I)));
1345
1346   // setcc <global/alloca*>, 0 - Global/Stack value addresses are never null!
1347   if (isa<ConstantPointerNull>(Op1) &&
1348       (isa<GlobalValue>(Op0) || isa<AllocaInst>(Op0)))
1349     return ReplaceInstUsesWith(I, ConstantBool::get(!isTrueWhenEqual(I)));
1350
1351
1352   // setcc's with boolean values can always be turned into bitwise operations
1353   if (Ty == Type::BoolTy) {
1354     // If this is <, >, or !=, we can change this into a simple xor instruction
1355     if (!isTrueWhenEqual(I))
1356       return BinaryOperator::create(Instruction::Xor, Op0, Op1);
1357
1358     // Otherwise we need to make a temporary intermediate instruction and insert
1359     // it into the instruction stream.  This is what we are after:
1360     //
1361     //  seteq bool %A, %B -> ~(A^B)
1362     //  setle bool %A, %B -> ~A | B
1363     //  setge bool %A, %B -> A | ~B
1364     //
1365     if (I.getOpcode() == Instruction::SetEQ) {  // seteq case
1366       Instruction *Xor = BinaryOperator::create(Instruction::Xor, Op0, Op1,
1367                                                 I.getName()+"tmp");
1368       InsertNewInstBefore(Xor, I);
1369       return BinaryOperator::createNot(Xor);
1370     }
1371
1372     // Handle the setXe cases...
1373     assert(I.getOpcode() == Instruction::SetGE ||
1374            I.getOpcode() == Instruction::SetLE);
1375
1376     if (I.getOpcode() == Instruction::SetGE)
1377       std::swap(Op0, Op1);                   // Change setge -> setle
1378
1379     // Now we just have the SetLE case.
1380     Instruction *Not = BinaryOperator::createNot(Op0, I.getName()+"tmp");
1381     InsertNewInstBefore(Not, I);
1382     return BinaryOperator::create(Instruction::Or, Not, Op1);
1383   }
1384
1385   // Check to see if we are doing one of many comparisons against constant
1386   // integers at the end of their ranges...
1387   //
1388   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
1389     // Simplify seteq and setne instructions...
1390     if (I.getOpcode() == Instruction::SetEQ ||
1391         I.getOpcode() == Instruction::SetNE) {
1392       bool isSetNE = I.getOpcode() == Instruction::SetNE;
1393
1394       // If the first operand is (and|or|xor) with a constant, and the second
1395       // operand is a constant, simplify a bit.
1396       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0)) {
1397         switch (BO->getOpcode()) {
1398         case Instruction::Add:
1399           if (CI->isNullValue()) {
1400             // Replace ((add A, B) != 0) with (A != -B) if A or B is
1401             // efficiently invertible, or if the add has just this one use.
1402             Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
1403             if (Value *NegVal = dyn_castNegVal(BOp1))
1404               return new SetCondInst(I.getOpcode(), BOp0, NegVal);
1405             else if (Value *NegVal = dyn_castNegVal(BOp0))
1406               return new SetCondInst(I.getOpcode(), NegVal, BOp1);
1407             else if (BO->hasOneUse()) {
1408               Instruction *Neg = BinaryOperator::createNeg(BOp1, BO->getName());
1409               BO->setName("");
1410               InsertNewInstBefore(Neg, I);
1411               return new SetCondInst(I.getOpcode(), BOp0, Neg);
1412             }
1413           }
1414           break;
1415         case Instruction::Xor:
1416           // For the xor case, we can xor two constants together, eliminating
1417           // the explicit xor.
1418           if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1)))
1419             return BinaryOperator::create(I.getOpcode(), BO->getOperand(0),
1420                                   ConstantExpr::get(Instruction::Xor, CI, BOC));
1421
1422           // FALLTHROUGH
1423         case Instruction::Sub:
1424           // Replace (([sub|xor] A, B) != 0) with (A != B)
1425           if (CI->isNullValue())
1426             return new SetCondInst(I.getOpcode(), BO->getOperand(0),
1427                                    BO->getOperand(1));
1428           break;
1429
1430         case Instruction::Or:
1431           // If bits are being or'd in that are not present in the constant we
1432           // are comparing against, then the comparison could never succeed!
1433           if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1434             Constant *NotCI = NotConstant(CI);
1435             if (!ConstantExpr::get(Instruction::And, BOC, NotCI)->isNullValue())
1436               return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
1437           }
1438           break;
1439
1440         case Instruction::And:
1441           if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1442             // If bits are being compared against that are and'd out, then the
1443             // comparison can never succeed!
1444             if (!ConstantExpr::get(Instruction::And, CI,
1445                                    NotConstant(BOC))->isNullValue())
1446               return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
1447
1448             // Replace (and X, (1 << size(X)-1) != 0) with x < 0, converting X
1449             // to be a signed value as appropriate.
1450             if (isSignBit(BOC)) {
1451               Value *X = BO->getOperand(0);
1452               // If 'X' is not signed, insert a cast now...
1453               if (!BOC->getType()->isSigned()) {
1454                 const Type *DestTy = getSignedIntegralType(BOC->getType());
1455                 CastInst *NewCI = new CastInst(X,DestTy,X->getName()+".signed");
1456                 InsertNewInstBefore(NewCI, I);
1457                 X = NewCI;
1458               }
1459               return new SetCondInst(isSetNE ? Instruction::SetLT :
1460                                          Instruction::SetGE, X,
1461                                      Constant::getNullValue(X->getType()));
1462             }
1463           }
1464         default: break;
1465         }
1466       }
1467     } else {  // Not a SetEQ/SetNE
1468       // If the LHS is a cast from an integral value of the same size,
1469       if (CastInst *Cast = dyn_cast<CastInst>(Op0)) {
1470         Value *CastOp = Cast->getOperand(0);
1471         const Type *SrcTy = CastOp->getType();
1472         unsigned SrcTySize = SrcTy->getPrimitiveSize();
1473         if (SrcTy != Cast->getType() && SrcTy->isInteger() &&
1474             SrcTySize == Cast->getType()->getPrimitiveSize()) {
1475           assert((SrcTy->isSigned() ^ Cast->getType()->isSigned()) &&
1476                  "Source and destination signednesses should differ!");
1477           if (Cast->getType()->isSigned()) {
1478             // If this is a signed comparison, check for comparisons in the
1479             // vicinity of zero.
1480             if (I.getOpcode() == Instruction::SetLT && CI->isNullValue())
1481               // X < 0  => x > 127
1482               return BinaryOperator::create(Instruction::SetGT, CastOp,
1483                          ConstantUInt::get(SrcTy, (1ULL << (SrcTySize*8-1))-1));
1484             else if (I.getOpcode() == Instruction::SetGT &&
1485                      cast<ConstantSInt>(CI)->getValue() == -1)
1486               // X > -1  => x < 128
1487               return BinaryOperator::create(Instruction::SetLT, CastOp,
1488                          ConstantUInt::get(SrcTy, 1ULL << (SrcTySize*8-1)));
1489           } else {
1490             ConstantUInt *CUI = cast<ConstantUInt>(CI);
1491             if (I.getOpcode() == Instruction::SetLT &&
1492                 CUI->getValue() == 1ULL << (SrcTySize*8-1))
1493               // X < 128 => X > -1
1494               return BinaryOperator::create(Instruction::SetGT, CastOp,
1495                                             ConstantSInt::get(SrcTy, -1));
1496             else if (I.getOpcode() == Instruction::SetGT &&
1497                      CUI->getValue() == (1ULL << (SrcTySize*8-1))-1)
1498               // X > 127 => X < 0
1499               return BinaryOperator::create(Instruction::SetLT, CastOp,
1500                                             Constant::getNullValue(SrcTy));
1501           }
1502         }
1503       }
1504     }
1505
1506     // Check to see if we are comparing against the minimum or maximum value...
1507     if (CI->isMinValue()) {
1508       if (I.getOpcode() == Instruction::SetLT)       // A < MIN -> FALSE
1509         return ReplaceInstUsesWith(I, ConstantBool::False);
1510       if (I.getOpcode() == Instruction::SetGE)       // A >= MIN -> TRUE
1511         return ReplaceInstUsesWith(I, ConstantBool::True);
1512       if (I.getOpcode() == Instruction::SetLE)       // A <= MIN -> A == MIN
1513         return BinaryOperator::create(Instruction::SetEQ, Op0, Op1);
1514       if (I.getOpcode() == Instruction::SetGT)       // A > MIN -> A != MIN
1515         return BinaryOperator::create(Instruction::SetNE, Op0, Op1);
1516
1517     } else if (CI->isMaxValue()) {
1518       if (I.getOpcode() == Instruction::SetGT)       // A > MAX -> FALSE
1519         return ReplaceInstUsesWith(I, ConstantBool::False);
1520       if (I.getOpcode() == Instruction::SetLE)       // A <= MAX -> TRUE
1521         return ReplaceInstUsesWith(I, ConstantBool::True);
1522       if (I.getOpcode() == Instruction::SetGE)       // A >= MAX -> A == MAX
1523         return BinaryOperator::create(Instruction::SetEQ, Op0, Op1);
1524       if (I.getOpcode() == Instruction::SetLT)       // A < MAX -> A != MAX
1525         return BinaryOperator::create(Instruction::SetNE, Op0, Op1);
1526
1527       // Comparing against a value really close to min or max?
1528     } else if (isMinValuePlusOne(CI)) {
1529       if (I.getOpcode() == Instruction::SetLT)       // A < MIN+1 -> A == MIN
1530         return BinaryOperator::create(Instruction::SetEQ, Op0, SubOne(CI));
1531       if (I.getOpcode() == Instruction::SetGE)       // A >= MIN-1 -> A != MIN
1532         return BinaryOperator::create(Instruction::SetNE, Op0, SubOne(CI));
1533
1534     } else if (isMaxValueMinusOne(CI)) {
1535       if (I.getOpcode() == Instruction::SetGT)       // A > MAX-1 -> A == MAX
1536         return BinaryOperator::create(Instruction::SetEQ, Op0, AddOne(CI));
1537       if (I.getOpcode() == Instruction::SetLE)       // A <= MAX-1 -> A != MAX
1538         return BinaryOperator::create(Instruction::SetNE, Op0, AddOne(CI));
1539     }
1540
1541     // If we still have a setle or setge instruction, turn it into the
1542     // appropriate setlt or setgt instruction.  Since the border cases have
1543     // already been handled above, this requires little checking.
1544     //
1545     if (I.getOpcode() == Instruction::SetLE)
1546       return BinaryOperator::create(Instruction::SetLT, Op0, AddOne(CI));
1547     if (I.getOpcode() == Instruction::SetGE)
1548       return BinaryOperator::create(Instruction::SetGT, Op0, SubOne(CI));
1549   }
1550
1551   // Test to see if the operands of the setcc are casted versions of other
1552   // values.  If the cast can be stripped off both arguments, we do so now.
1553   if (CastInst *CI = dyn_cast<CastInst>(Op0)) {
1554     Value *CastOp0 = CI->getOperand(0);
1555     if (CastOp0->getType()->isLosslesslyConvertibleTo(CI->getType()) &&
1556         (isa<Constant>(Op1) || isa<CastInst>(Op1)) &&
1557         (I.getOpcode() == Instruction::SetEQ ||
1558          I.getOpcode() == Instruction::SetNE)) {
1559       // We keep moving the cast from the left operand over to the right
1560       // operand, where it can often be eliminated completely.
1561       Op0 = CastOp0;
1562
1563       // If operand #1 is a cast instruction, see if we can eliminate it as
1564       // well.
1565       if (CastInst *CI2 = dyn_cast<CastInst>(Op1))
1566         if (CI2->getOperand(0)->getType()->isLosslesslyConvertibleTo(
1567                                                                Op0->getType()))
1568           Op1 = CI2->getOperand(0);
1569
1570       // If Op1 is a constant, we can fold the cast into the constant.
1571       if (Op1->getType() != Op0->getType())
1572         if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
1573           Op1 = ConstantExpr::getCast(Op1C, Op0->getType());
1574         } else {
1575           // Otherwise, cast the RHS right before the setcc
1576           Op1 = new CastInst(Op1, Op0->getType(), Op1->getName());
1577           InsertNewInstBefore(cast<Instruction>(Op1), I);
1578         }
1579       return BinaryOperator::create(I.getOpcode(), Op0, Op1);
1580     }
1581
1582     // Handle the special case of: setcc (cast bool to X), <cst>
1583     // This comes up when you have code like
1584     //   int X = A < B;
1585     //   if (X) ...
1586     // For generality, we handle any zero-extension of any operand comparison
1587     // with a constant.
1588     if (ConstantInt *ConstantRHS = dyn_cast<ConstantInt>(Op1)) {
1589       const Type *SrcTy = CastOp0->getType();
1590       const Type *DestTy = Op0->getType();
1591       if (SrcTy->getPrimitiveSize() < DestTy->getPrimitiveSize() &&
1592           (SrcTy->isUnsigned() || SrcTy == Type::BoolTy)) {
1593         // Ok, we have an expansion of operand 0 into a new type.  Get the
1594         // constant value, masink off bits which are not set in the RHS.  These
1595         // could be set if the destination value is signed.
1596         uint64_t ConstVal = ConstantRHS->getRawValue();
1597         ConstVal &= (1ULL << DestTy->getPrimitiveSize()*8)-1;
1598
1599         // If the constant we are comparing it with has high bits set, which
1600         // don't exist in the original value, the values could never be equal,
1601         // because the source would be zero extended.
1602         unsigned SrcBits =
1603           SrcTy == Type::BoolTy ? 1 : SrcTy->getPrimitiveSize()*8;
1604         bool HasSignBit = ConstVal & (1ULL << (DestTy->getPrimitiveSize()*8-1));
1605         if (ConstVal & ~((1ULL << SrcBits)-1)) {
1606           switch (I.getOpcode()) {
1607           default: assert(0 && "Unknown comparison type!");
1608           case Instruction::SetEQ:
1609             return ReplaceInstUsesWith(I, ConstantBool::False);
1610           case Instruction::SetNE:
1611             return ReplaceInstUsesWith(I, ConstantBool::True);
1612           case Instruction::SetLT:
1613           case Instruction::SetLE:
1614             if (DestTy->isSigned() && HasSignBit)
1615               return ReplaceInstUsesWith(I, ConstantBool::False);
1616             return ReplaceInstUsesWith(I, ConstantBool::True);
1617           case Instruction::SetGT:
1618           case Instruction::SetGE:
1619             if (DestTy->isSigned() && HasSignBit)
1620               return ReplaceInstUsesWith(I, ConstantBool::True);
1621             return ReplaceInstUsesWith(I, ConstantBool::False);
1622           }
1623         }
1624
1625         // Otherwise, we can replace the setcc with a setcc of the smaller
1626         // operand value.
1627         Op1 = ConstantExpr::getCast(cast<Constant>(Op1), SrcTy);
1628         return BinaryOperator::create(I.getOpcode(), CastOp0, Op1);
1629       }
1630     }
1631   }
1632   return Changed ? &I : 0;
1633 }
1634
1635
1636
1637 Instruction *InstCombiner::visitShiftInst(ShiftInst &I) {
1638   assert(I.getOperand(1)->getType() == Type::UByteTy);
1639   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1640   bool isLeftShift = I.getOpcode() == Instruction::Shl;
1641
1642   // shl X, 0 == X and shr X, 0 == X
1643   // shl 0, X == 0 and shr 0, X == 0
1644   if (Op1 == Constant::getNullValue(Type::UByteTy) ||
1645       Op0 == Constant::getNullValue(Op0->getType()))
1646     return ReplaceInstUsesWith(I, Op0);
1647
1648   // shr int -1, X = -1   (for any arithmetic shift rights of ~0)
1649   if (!isLeftShift)
1650     if (ConstantSInt *CSI = dyn_cast<ConstantSInt>(Op0))
1651       if (CSI->isAllOnesValue())
1652         return ReplaceInstUsesWith(I, CSI);
1653
1654   if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
1655     // shl uint X, 32 = 0 and shr ubyte Y, 9 = 0, ... just don't eliminate shr
1656     // of a signed value.
1657     //
1658     unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
1659     if (CUI->getValue() >= TypeBits) {
1660       if (!Op0->getType()->isSigned() || isLeftShift)
1661         return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
1662       else {
1663         I.setOperand(1, ConstantUInt::get(Type::UByteTy, TypeBits-1));
1664         return &I;
1665       }
1666     }
1667
1668     // ((X*C1) << C2) == (X * (C1 << C2))
1669     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0))
1670       if (BO->getOpcode() == Instruction::Mul && isLeftShift)
1671         if (Constant *BOOp = dyn_cast<Constant>(BO->getOperand(1)))
1672           return BinaryOperator::create(Instruction::Mul, BO->getOperand(0),
1673                                 ConstantExpr::get(Instruction::Shl, BOOp, CUI));
1674
1675
1676     // If the operand is an bitwise operator with a constant RHS, and the
1677     // shift is the only use, we can pull it out of the shift.
1678     if (Op0->hasOneUse())
1679       if (BinaryOperator *Op0BO = dyn_cast<BinaryOperator>(Op0))
1680         if (ConstantInt *Op0C = dyn_cast<ConstantInt>(Op0BO->getOperand(1))) {
1681           bool isValid = true;     // Valid only for And, Or, Xor
1682           bool highBitSet = false; // Transform if high bit of constant set?
1683
1684           switch (Op0BO->getOpcode()) {
1685           default: isValid = false; break;   // Do not perform transform!
1686           case Instruction::Or:
1687           case Instruction::Xor:
1688             highBitSet = false;
1689             break;
1690           case Instruction::And:
1691             highBitSet = true;
1692             break;
1693           }
1694
1695           // If this is a signed shift right, and the high bit is modified
1696           // by the logical operation, do not perform the transformation.
1697           // The highBitSet boolean indicates the value of the high bit of
1698           // the constant which would cause it to be modified for this
1699           // operation.
1700           //
1701           if (isValid && !isLeftShift && !I.getType()->isUnsigned()) {
1702             uint64_t Val = Op0C->getRawValue();
1703             isValid = ((Val & (1 << (TypeBits-1))) != 0) == highBitSet;
1704           }
1705
1706           if (isValid) {
1707             Constant *NewRHS = ConstantExpr::get(I.getOpcode(), Op0C, CUI);
1708
1709             Instruction *NewShift =
1710               new ShiftInst(I.getOpcode(), Op0BO->getOperand(0), CUI,
1711                             Op0BO->getName());
1712             Op0BO->setName("");
1713             InsertNewInstBefore(NewShift, I);
1714
1715             return BinaryOperator::create(Op0BO->getOpcode(), NewShift,
1716                                           NewRHS);
1717           }
1718         }
1719
1720     // If this is a shift of a shift, see if we can fold the two together...
1721     if (ShiftInst *Op0SI = dyn_cast<ShiftInst>(Op0))
1722       if (ConstantUInt *ShiftAmt1C =
1723                                  dyn_cast<ConstantUInt>(Op0SI->getOperand(1))) {
1724         unsigned ShiftAmt1 = ShiftAmt1C->getValue();
1725         unsigned ShiftAmt2 = CUI->getValue();
1726
1727         // Check for (A << c1) << c2   and   (A >> c1) >> c2
1728         if (I.getOpcode() == Op0SI->getOpcode()) {
1729           unsigned Amt = ShiftAmt1+ShiftAmt2;   // Fold into one big shift...
1730           if (Op0->getType()->getPrimitiveSize()*8 < Amt)
1731             Amt = Op0->getType()->getPrimitiveSize()*8;
1732           return new ShiftInst(I.getOpcode(), Op0SI->getOperand(0),
1733                                ConstantUInt::get(Type::UByteTy, Amt));
1734         }
1735
1736         // Check for (A << c1) >> c2 or visaversa.  If we are dealing with
1737         // signed types, we can only support the (A >> c1) << c2 configuration,
1738         // because it can not turn an arbitrary bit of A into a sign bit.
1739         if (I.getType()->isUnsigned() || isLeftShift) {
1740           // Calculate bitmask for what gets shifted off the edge...
1741           Constant *C = ConstantIntegral::getAllOnesValue(I.getType());
1742           if (isLeftShift)
1743             C = ConstantExpr::get(Instruction::Shl, C, ShiftAmt1C);
1744           else
1745             C = ConstantExpr::get(Instruction::Shr, C, ShiftAmt1C);
1746
1747           Instruction *Mask =
1748             BinaryOperator::create(Instruction::And, Op0SI->getOperand(0),
1749                                    C, Op0SI->getOperand(0)->getName()+".mask");
1750           InsertNewInstBefore(Mask, I);
1751
1752           // Figure out what flavor of shift we should use...
1753           if (ShiftAmt1 == ShiftAmt2)
1754             return ReplaceInstUsesWith(I, Mask);  // (A << c) >> c  === A & c2
1755           else if (ShiftAmt1 < ShiftAmt2) {
1756             return new ShiftInst(I.getOpcode(), Mask,
1757                          ConstantUInt::get(Type::UByteTy, ShiftAmt2-ShiftAmt1));
1758           } else {
1759             return new ShiftInst(Op0SI->getOpcode(), Mask,
1760                          ConstantUInt::get(Type::UByteTy, ShiftAmt1-ShiftAmt2));
1761           }
1762         }
1763       }
1764   }
1765
1766   return 0;
1767 }
1768
1769
1770 // isEliminableCastOfCast - Return true if it is valid to eliminate the CI
1771 // instruction.
1772 //
1773 static inline bool isEliminableCastOfCast(const Type *SrcTy, const Type *MidTy,
1774                                           const Type *DstTy) {
1775
1776   // It is legal to eliminate the instruction if casting A->B->A if the sizes
1777   // are identical and the bits don't get reinterpreted (for example
1778   // int->float->int would not be allowed)
1779   if (SrcTy == DstTy && SrcTy->isLosslesslyConvertibleTo(MidTy))
1780     return true;
1781
1782   // Allow free casting and conversion of sizes as long as the sign doesn't
1783   // change...
1784   if (SrcTy->isIntegral() && MidTy->isIntegral() && DstTy->isIntegral()) {
1785     unsigned SrcSize = SrcTy->getPrimitiveSize();
1786     unsigned MidSize = MidTy->getPrimitiveSize();
1787     unsigned DstSize = DstTy->getPrimitiveSize();
1788
1789     // Cases where we are monotonically decreasing the size of the type are
1790     // always ok, regardless of what sign changes are going on.
1791     //
1792     if (SrcSize >= MidSize && MidSize >= DstSize)
1793       return true;
1794
1795     // Cases where the source and destination type are the same, but the middle
1796     // type is bigger are noops.
1797     //
1798     if (SrcSize == DstSize && MidSize > SrcSize)
1799       return true;
1800
1801     // If we are monotonically growing, things are more complex.
1802     //
1803     if (SrcSize <= MidSize && MidSize <= DstSize) {
1804       // We have eight combinations of signedness to worry about. Here's the
1805       // table:
1806       static const int SignTable[8] = {
1807         // CODE, SrcSigned, MidSigned, DstSigned, Comment
1808         1,     //   U          U          U       Always ok
1809         1,     //   U          U          S       Always ok
1810         3,     //   U          S          U       Ok iff SrcSize != MidSize
1811         3,     //   U          S          S       Ok iff SrcSize != MidSize
1812         0,     //   S          U          U       Never ok
1813         2,     //   S          U          S       Ok iff MidSize == DstSize
1814         1,     //   S          S          U       Always ok
1815         1,     //   S          S          S       Always ok
1816       };
1817
1818       // Choose an action based on the current entry of the signtable that this
1819       // cast of cast refers to...
1820       unsigned Row = SrcTy->isSigned()*4+MidTy->isSigned()*2+DstTy->isSigned();
1821       switch (SignTable[Row]) {
1822       case 0: return false;              // Never ok
1823       case 1: return true;               // Always ok
1824       case 2: return MidSize == DstSize; // Ok iff MidSize == DstSize
1825       case 3:                            // Ok iff SrcSize != MidSize
1826         return SrcSize != MidSize || SrcTy == Type::BoolTy;
1827       default: assert(0 && "Bad entry in sign table!");
1828       }
1829     }
1830   }
1831
1832   // Otherwise, we cannot succeed.  Specifically we do not want to allow things
1833   // like:  short -> ushort -> uint, because this can create wrong results if
1834   // the input short is negative!
1835   //
1836   return false;
1837 }
1838
1839 static bool ValueRequiresCast(const Value *V, const Type *Ty) {
1840   if (V->getType() == Ty || isa<Constant>(V)) return false;
1841   if (const CastInst *CI = dyn_cast<CastInst>(V))
1842     if (isEliminableCastOfCast(CI->getOperand(0)->getType(), CI->getType(), Ty))
1843       return false;
1844   return true;
1845 }
1846
1847 /// InsertOperandCastBefore - This inserts a cast of V to DestTy before the
1848 /// InsertBefore instruction.  This is specialized a bit to avoid inserting
1849 /// casts that are known to not do anything...
1850 ///
1851 Value *InstCombiner::InsertOperandCastBefore(Value *V, const Type *DestTy,
1852                                              Instruction *InsertBefore) {
1853   if (V->getType() == DestTy) return V;
1854   if (Constant *C = dyn_cast<Constant>(V))
1855     return ConstantExpr::getCast(C, DestTy);
1856
1857   CastInst *CI = new CastInst(V, DestTy, V->getName());
1858   InsertNewInstBefore(CI, *InsertBefore);
1859   return CI;
1860 }
1861
1862 // CastInst simplification
1863 //
1864 Instruction *InstCombiner::visitCastInst(CastInst &CI) {
1865   Value *Src = CI.getOperand(0);
1866
1867   // If the user is casting a value to the same type, eliminate this cast
1868   // instruction...
1869   if (CI.getType() == Src->getType())
1870     return ReplaceInstUsesWith(CI, Src);
1871
1872   // If casting the result of another cast instruction, try to eliminate this
1873   // one!
1874   //
1875   if (CastInst *CSrc = dyn_cast<CastInst>(Src)) {
1876     if (isEliminableCastOfCast(CSrc->getOperand(0)->getType(),
1877                                CSrc->getType(), CI.getType())) {
1878       // This instruction now refers directly to the cast's src operand.  This
1879       // has a good chance of making CSrc dead.
1880       CI.setOperand(0, CSrc->getOperand(0));
1881       return &CI;
1882     }
1883
1884     // If this is an A->B->A cast, and we are dealing with integral types, try
1885     // to convert this into a logical 'and' instruction.
1886     //
1887     if (CSrc->getOperand(0)->getType() == CI.getType() &&
1888         CI.getType()->isInteger() && CSrc->getType()->isInteger() &&
1889         CI.getType()->isUnsigned() && CSrc->getType()->isUnsigned() &&
1890         CSrc->getType()->getPrimitiveSize() < CI.getType()->getPrimitiveSize()){
1891       assert(CSrc->getType() != Type::ULongTy &&
1892              "Cannot have type bigger than ulong!");
1893       uint64_t AndValue = (1ULL << CSrc->getType()->getPrimitiveSize()*8)-1;
1894       Constant *AndOp = ConstantUInt::get(CI.getType(), AndValue);
1895       return BinaryOperator::create(Instruction::And, CSrc->getOperand(0),
1896                                     AndOp);
1897     }
1898   }
1899
1900   // If casting the result of a getelementptr instruction with no offset, turn
1901   // this into a cast of the original pointer!
1902   //
1903   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
1904     bool AllZeroOperands = true;
1905     for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
1906       if (!isa<Constant>(GEP->getOperand(i)) ||
1907           !cast<Constant>(GEP->getOperand(i))->isNullValue()) {
1908         AllZeroOperands = false;
1909         break;
1910       }
1911     if (AllZeroOperands) {
1912       CI.setOperand(0, GEP->getOperand(0));
1913       return &CI;
1914     }
1915   }
1916
1917   // If we are casting a malloc or alloca to a pointer to a type of the same
1918   // size, rewrite the allocation instruction to allocate the "right" type.
1919   //
1920   if (AllocationInst *AI = dyn_cast<AllocationInst>(Src))
1921     if (AI->hasOneUse() && !AI->isArrayAllocation())
1922       if (const PointerType *PTy = dyn_cast<PointerType>(CI.getType())) {
1923         // Get the type really allocated and the type casted to...
1924         const Type *AllocElTy = AI->getAllocatedType();
1925         unsigned AllocElTySize = TD->getTypeSize(AllocElTy);
1926         const Type *CastElTy = PTy->getElementType();
1927         unsigned CastElTySize = TD->getTypeSize(CastElTy);
1928
1929         // If the allocation is for an even multiple of the cast type size
1930         if (CastElTySize && (AllocElTySize % CastElTySize == 0)) {
1931           Value *Amt = ConstantUInt::get(Type::UIntTy,
1932                                          AllocElTySize/CastElTySize);
1933           std::string Name = AI->getName(); AI->setName("");
1934           AllocationInst *New;
1935           if (isa<MallocInst>(AI))
1936             New = new MallocInst(CastElTy, Amt, Name);
1937           else
1938             New = new AllocaInst(CastElTy, Amt, Name);
1939           InsertNewInstBefore(New, CI);
1940           return ReplaceInstUsesWith(CI, New);
1941         }
1942       }
1943
1944   // If the source value is an instruction with only this use, we can attempt to
1945   // propagate the cast into the instruction.  Also, only handle integral types
1946   // for now.
1947   if (Instruction *SrcI = dyn_cast<Instruction>(Src))
1948     if (SrcI->hasOneUse() && Src->getType()->isIntegral() &&
1949         CI.getType()->isInteger()) {  // Don't mess with casts to bool here
1950       const Type *DestTy = CI.getType();
1951       unsigned SrcBitSize = getTypeSizeInBits(Src->getType());
1952       unsigned DestBitSize = getTypeSizeInBits(DestTy);
1953
1954       Value *Op0 = SrcI->getNumOperands() > 0 ? SrcI->getOperand(0) : 0;
1955       Value *Op1 = SrcI->getNumOperands() > 1 ? SrcI->getOperand(1) : 0;
1956
1957       switch (SrcI->getOpcode()) {
1958       case Instruction::Add:
1959       case Instruction::Mul:
1960       case Instruction::And:
1961       case Instruction::Or:
1962       case Instruction::Xor:
1963         // If we are discarding information, or just changing the sign, rewrite.
1964         if (DestBitSize <= SrcBitSize && DestBitSize != 1) {
1965           // Don't insert two casts if they cannot be eliminated.  We allow two
1966           // casts to be inserted if the sizes are the same.  This could only be
1967           // converting signedness, which is a noop.
1968           if (DestBitSize == SrcBitSize || !ValueRequiresCast(Op1, DestTy) ||
1969               !ValueRequiresCast(Op0, DestTy)) {
1970             Value *Op0c = InsertOperandCastBefore(Op0, DestTy, SrcI);
1971             Value *Op1c = InsertOperandCastBefore(Op1, DestTy, SrcI);
1972             return BinaryOperator::create(cast<BinaryOperator>(SrcI)
1973                              ->getOpcode(), Op0c, Op1c);
1974           }
1975         }
1976         break;
1977       case Instruction::Shl:
1978         // Allow changing the sign of the source operand.  Do not allow changing
1979         // the size of the shift, UNLESS the shift amount is a constant.  We
1980         // mush not change variable sized shifts to a smaller size, because it
1981         // is undefined to shift more bits out than exist in the value.
1982         if (DestBitSize == SrcBitSize ||
1983             (DestBitSize < SrcBitSize && isa<Constant>(Op1))) {
1984           Value *Op0c = InsertOperandCastBefore(Op0, DestTy, SrcI);
1985           return new ShiftInst(Instruction::Shl, Op0c, Op1);
1986         }
1987         break;
1988       }
1989     }
1990
1991   return 0;
1992 }
1993
1994 Instruction *InstCombiner::visitSelectInst(SelectInst &SI) {
1995   if (ConstantBool *C = dyn_cast<ConstantBool>(SI.getCondition()))
1996     if (C == ConstantBool::True)
1997       return ReplaceInstUsesWith(SI, SI.getTrueValue());
1998     else {
1999       assert(C == ConstantBool::False);
2000       return ReplaceInstUsesWith(SI, SI.getFalseValue());
2001     }
2002   // Other transformations are possible!
2003
2004   return 0;
2005 }
2006
2007
2008 // CallInst simplification
2009 //
2010 Instruction *InstCombiner::visitCallInst(CallInst &CI) {
2011   // Intrinsics cannot occur in an invoke, so handle them here instead of in
2012   // visitCallSite.
2013   if (Function *F = CI.getCalledFunction())
2014     switch (F->getIntrinsicID()) {
2015     case Intrinsic::memmove:
2016     case Intrinsic::memcpy:
2017     case Intrinsic::memset:
2018       // memmove/cpy/set of zero bytes is a noop.
2019       if (Constant *NumBytes = dyn_cast<Constant>(CI.getOperand(3))) {
2020         if (NumBytes->isNullValue())
2021           return EraseInstFromFunction(CI);
2022       }
2023       break;
2024     default:
2025       break;
2026     }
2027
2028   return visitCallSite(&CI);
2029 }
2030
2031 // InvokeInst simplification
2032 //
2033 Instruction *InstCombiner::visitInvokeInst(InvokeInst &II) {
2034   return visitCallSite(&II);
2035 }
2036
2037 // visitCallSite - Improvements for call and invoke instructions.
2038 //
2039 Instruction *InstCombiner::visitCallSite(CallSite CS) {
2040   bool Changed = false;
2041
2042   // If the callee is a constexpr cast of a function, attempt to move the cast
2043   // to the arguments of the call/invoke.
2044   if (transformConstExprCastCall(CS)) return 0;
2045
2046   Value *Callee = CS.getCalledValue();
2047   const PointerType *PTy = cast<PointerType>(Callee->getType());
2048   const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2049   if (FTy->isVarArg()) {
2050     // See if we can optimize any arguments passed through the varargs area of
2051     // the call.
2052     for (CallSite::arg_iterator I = CS.arg_begin()+FTy->getNumParams(),
2053            E = CS.arg_end(); I != E; ++I)
2054       if (CastInst *CI = dyn_cast<CastInst>(*I)) {
2055         // If this cast does not effect the value passed through the varargs
2056         // area, we can eliminate the use of the cast.
2057         Value *Op = CI->getOperand(0);
2058         if (CI->getType()->isLosslesslyConvertibleTo(Op->getType())) {
2059           *I = Op;
2060           Changed = true;
2061         }
2062       }
2063   }
2064
2065   return Changed ? CS.getInstruction() : 0;
2066 }
2067
2068 // transformConstExprCastCall - If the callee is a constexpr cast of a function,
2069 // attempt to move the cast to the arguments of the call/invoke.
2070 //
2071 bool InstCombiner::transformConstExprCastCall(CallSite CS) {
2072   if (!isa<ConstantExpr>(CS.getCalledValue())) return false;
2073   ConstantExpr *CE = cast<ConstantExpr>(CS.getCalledValue());
2074   if (CE->getOpcode() != Instruction::Cast ||
2075       !isa<ConstantPointerRef>(CE->getOperand(0)))
2076     return false;
2077   ConstantPointerRef *CPR = cast<ConstantPointerRef>(CE->getOperand(0));
2078   if (!isa<Function>(CPR->getValue())) return false;
2079   Function *Callee = cast<Function>(CPR->getValue());
2080   Instruction *Caller = CS.getInstruction();
2081
2082   // Okay, this is a cast from a function to a different type.  Unless doing so
2083   // would cause a type conversion of one of our arguments, change this call to
2084   // be a direct call with arguments casted to the appropriate types.
2085   //
2086   const FunctionType *FT = Callee->getFunctionType();
2087   const Type *OldRetTy = Caller->getType();
2088
2089   // Check to see if we are changing the return type...
2090   if (OldRetTy != FT->getReturnType()) {
2091     if (Callee->isExternal() &&
2092         !OldRetTy->isLosslesslyConvertibleTo(FT->getReturnType()) &&
2093         !Caller->use_empty())
2094       return false;   // Cannot transform this return value...
2095
2096     // If the callsite is an invoke instruction, and the return value is used by
2097     // a PHI node in a successor, we cannot change the return type of the call
2098     // because there is no place to put the cast instruction (without breaking
2099     // the critical edge).  Bail out in this case.
2100     if (!Caller->use_empty())
2101       if (InvokeInst *II = dyn_cast<InvokeInst>(Caller))
2102         for (Value::use_iterator UI = II->use_begin(), E = II->use_end();
2103              UI != E; ++UI)
2104           if (PHINode *PN = dyn_cast<PHINode>(*UI))
2105             if (PN->getParent() == II->getNormalDest() ||
2106                 PN->getParent() == II->getUnwindDest())
2107               return false;
2108   }
2109
2110   unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
2111   unsigned NumCommonArgs = std::min(FT->getNumParams(), NumActualArgs);
2112
2113   CallSite::arg_iterator AI = CS.arg_begin();
2114   for (unsigned i = 0, e = NumCommonArgs; i != e; ++i, ++AI) {
2115     const Type *ParamTy = FT->getParamType(i);
2116     bool isConvertible = (*AI)->getType()->isLosslesslyConvertibleTo(ParamTy);
2117     if (Callee->isExternal() && !isConvertible) return false;
2118   }
2119
2120   if (FT->getNumParams() < NumActualArgs && !FT->isVarArg() &&
2121       Callee->isExternal())
2122     return false;   // Do not delete arguments unless we have a function body...
2123
2124   // Okay, we decided that this is a safe thing to do: go ahead and start
2125   // inserting cast instructions as necessary...
2126   std::vector<Value*> Args;
2127   Args.reserve(NumActualArgs);
2128
2129   AI = CS.arg_begin();
2130   for (unsigned i = 0; i != NumCommonArgs; ++i, ++AI) {
2131     const Type *ParamTy = FT->getParamType(i);
2132     if ((*AI)->getType() == ParamTy) {
2133       Args.push_back(*AI);
2134     } else {
2135       Instruction *Cast = new CastInst(*AI, ParamTy, "tmp");
2136       InsertNewInstBefore(Cast, *Caller);
2137       Args.push_back(Cast);
2138     }
2139   }
2140
2141   // If the function takes more arguments than the call was taking, add them
2142   // now...
2143   for (unsigned i = NumCommonArgs; i != FT->getNumParams(); ++i)
2144     Args.push_back(Constant::getNullValue(FT->getParamType(i)));
2145
2146   // If we are removing arguments to the function, emit an obnoxious warning...
2147   if (FT->getNumParams() < NumActualArgs)
2148     if (!FT->isVarArg()) {
2149       std::cerr << "WARNING: While resolving call to function '"
2150                 << Callee->getName() << "' arguments were dropped!\n";
2151     } else {
2152       // Add all of the arguments in their promoted form to the arg list...
2153       for (unsigned i = FT->getNumParams(); i != NumActualArgs; ++i, ++AI) {
2154         const Type *PTy = getPromotedType((*AI)->getType());
2155         if (PTy != (*AI)->getType()) {
2156           // Must promote to pass through va_arg area!
2157           Instruction *Cast = new CastInst(*AI, PTy, "tmp");
2158           InsertNewInstBefore(Cast, *Caller);
2159           Args.push_back(Cast);
2160         } else {
2161           Args.push_back(*AI);
2162         }
2163       }
2164     }
2165
2166   if (FT->getReturnType() == Type::VoidTy)
2167     Caller->setName("");   // Void type should not have a name...
2168
2169   Instruction *NC;
2170   if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
2171     NC = new InvokeInst(Callee, II->getNormalDest(), II->getUnwindDest(),
2172                         Args, Caller->getName(), Caller);
2173   } else {
2174     NC = new CallInst(Callee, Args, Caller->getName(), Caller);
2175   }
2176
2177   // Insert a cast of the return type as necessary...
2178   Value *NV = NC;
2179   if (Caller->getType() != NV->getType() && !Caller->use_empty()) {
2180     if (NV->getType() != Type::VoidTy) {
2181       NV = NC = new CastInst(NC, Caller->getType(), "tmp");
2182
2183       // If this is an invoke instruction, we should insert it after the first
2184       // non-phi, instruction in the normal successor block.
2185       if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
2186         BasicBlock::iterator I = II->getNormalDest()->begin();
2187         while (isa<PHINode>(I)) ++I;
2188         InsertNewInstBefore(NC, *I);
2189       } else {
2190         // Otherwise, it's a call, just insert cast right after the call instr
2191         InsertNewInstBefore(NC, *Caller);
2192       }
2193       AddUsersToWorkList(*Caller);
2194     } else {
2195       NV = Constant::getNullValue(Caller->getType());
2196     }
2197   }
2198
2199   if (Caller->getType() != Type::VoidTy && !Caller->use_empty())
2200     Caller->replaceAllUsesWith(NV);
2201   Caller->getParent()->getInstList().erase(Caller);
2202   removeFromWorkList(Caller);
2203   return true;
2204 }
2205
2206
2207
2208 // PHINode simplification
2209 //
2210 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
2211   if (Value *V = hasConstantValue(&PN))
2212     return ReplaceInstUsesWith(PN, V);
2213
2214   // If the only user of this instruction is a cast instruction, and all of the
2215   // incoming values are constants, change this PHI to merge together the casted
2216   // constants.
2217   if (PN.hasOneUse())
2218     if (CastInst *CI = dyn_cast<CastInst>(PN.use_back()))
2219       if (CI->getType() != PN.getType()) {  // noop casts will be folded
2220         bool AllConstant = true;
2221         for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
2222           if (!isa<Constant>(PN.getIncomingValue(i))) {
2223             AllConstant = false;
2224             break;
2225           }
2226         if (AllConstant) {
2227           // Make a new PHI with all casted values.
2228           PHINode *New = new PHINode(CI->getType(), PN.getName(), &PN);
2229           for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
2230             Constant *OldArg = cast<Constant>(PN.getIncomingValue(i));
2231             New->addIncoming(ConstantExpr::getCast(OldArg, New->getType()),
2232                              PN.getIncomingBlock(i));
2233           }
2234
2235           // Update the cast instruction.
2236           CI->setOperand(0, New);
2237           WorkList.push_back(CI);    // revisit the cast instruction to fold.
2238           WorkList.push_back(New);   // Make sure to revisit the new Phi
2239           return &PN;                // PN is now dead!
2240         }
2241       }
2242   return 0;
2243 }
2244
2245
2246 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2247   // Is it 'getelementptr %P, long 0'  or 'getelementptr %P'
2248   // If so, eliminate the noop.
2249   if (GEP.getNumOperands() == 1)
2250     return ReplaceInstUsesWith(GEP, GEP.getOperand(0));
2251
2252   bool HasZeroPointerIndex = false;
2253   if (Constant *C = dyn_cast<Constant>(GEP.getOperand(1)))
2254     HasZeroPointerIndex = C->isNullValue();
2255
2256   if (GEP.getNumOperands() == 2 && HasZeroPointerIndex)
2257     return ReplaceInstUsesWith(GEP, GEP.getOperand(0));
2258
2259   // Combine Indices - If the source pointer to this getelementptr instruction
2260   // is a getelementptr instruction, combine the indices of the two
2261   // getelementptr instructions into a single instruction.
2262   //
2263   if (GetElementPtrInst *Src = dyn_cast<GetElementPtrInst>(GEP.getOperand(0))) {
2264     std::vector<Value *> Indices;
2265
2266     // Can we combine the two pointer arithmetics offsets?
2267     if (Src->getNumOperands() == 2 && isa<Constant>(Src->getOperand(1)) &&
2268         isa<Constant>(GEP.getOperand(1))) {
2269       // Replace: gep (gep %P, long C1), long C2, ...
2270       // With:    gep %P, long (C1+C2), ...
2271       Value *Sum = ConstantExpr::get(Instruction::Add,
2272                                      cast<Constant>(Src->getOperand(1)),
2273                                      cast<Constant>(GEP.getOperand(1)));
2274       assert(Sum && "Constant folding of longs failed!?");
2275       GEP.setOperand(0, Src->getOperand(0));
2276       GEP.setOperand(1, Sum);
2277       AddUsersToWorkList(*Src);   // Reduce use count of Src
2278       return &GEP;
2279     } else if (Src->getNumOperands() == 2) {
2280       // Replace: gep (gep %P, long B), long A, ...
2281       // With:    T = long A+B; gep %P, T, ...
2282       //
2283       // Note that if our source is a gep chain itself that we wait for that
2284       // chain to be resolved before we perform this transformation.  This
2285       // avoids us creating a TON of code in some cases.
2286       //
2287       if (isa<GetElementPtrInst>(Src->getOperand(0)) &&
2288           cast<Instruction>(Src->getOperand(0))->getNumOperands() == 2)
2289         return 0;   // Wait until our source is folded to completion.
2290
2291       Value *Sum = BinaryOperator::create(Instruction::Add, Src->getOperand(1),
2292                                           GEP.getOperand(1),
2293                                           Src->getName()+".sum", &GEP);
2294       GEP.setOperand(0, Src->getOperand(0));
2295       GEP.setOperand(1, Sum);
2296       WorkList.push_back(cast<Instruction>(Sum));
2297       return &GEP;
2298     } else if (*GEP.idx_begin() == Constant::getNullValue(Type::LongTy) &&
2299                Src->getNumOperands() != 1) {
2300       // Otherwise we can do the fold if the first index of the GEP is a zero
2301       Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
2302       Indices.insert(Indices.end(), GEP.idx_begin()+1, GEP.idx_end());
2303     } else if (Src->getOperand(Src->getNumOperands()-1) ==
2304                Constant::getNullValue(Type::LongTy)) {
2305       // If the src gep ends with a constant array index, merge this get into
2306       // it, even if we have a non-zero array index.
2307       Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end()-1);
2308       Indices.insert(Indices.end(), GEP.idx_begin(), GEP.idx_end());
2309     }
2310
2311     if (!Indices.empty())
2312       return new GetElementPtrInst(Src->getOperand(0), Indices, GEP.getName());
2313
2314   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(GEP.getOperand(0))) {
2315     // GEP of global variable.  If all of the indices for this GEP are
2316     // constants, we can promote this to a constexpr instead of an instruction.
2317
2318     // Scan for nonconstants...
2319     std::vector<Constant*> Indices;
2320     User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end();
2321     for (; I != E && isa<Constant>(*I); ++I)
2322       Indices.push_back(cast<Constant>(*I));
2323
2324     if (I == E) {  // If they are all constants...
2325       Constant *CE =
2326         ConstantExpr::getGetElementPtr(ConstantPointerRef::get(GV), Indices);
2327
2328       // Replace all uses of the GEP with the new constexpr...
2329       return ReplaceInstUsesWith(GEP, CE);
2330     }
2331   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP.getOperand(0))) {
2332     if (CE->getOpcode() == Instruction::Cast) {
2333       if (HasZeroPointerIndex) {
2334         // transform: GEP (cast [10 x ubyte]* X to [0 x ubyte]*), long 0, ...
2335         // into     : GEP [10 x ubyte]* X, long 0, ...
2336         //
2337         // This occurs when the program declares an array extern like "int X[];"
2338         //
2339         Constant *X = CE->getOperand(0);
2340         const PointerType *CPTy = cast<PointerType>(CE->getType());
2341         if (const PointerType *XTy = dyn_cast<PointerType>(X->getType()))
2342           if (const ArrayType *XATy =
2343               dyn_cast<ArrayType>(XTy->getElementType()))
2344             if (const ArrayType *CATy =
2345                 dyn_cast<ArrayType>(CPTy->getElementType()))
2346               if (CATy->getElementType() == XATy->getElementType()) {
2347                 // At this point, we know that the cast source type is a pointer
2348                 // to an array of the same type as the destination pointer
2349                 // array.  Because the array type is never stepped over (there
2350                 // is a leading zero) we can fold the cast into this GEP.
2351                 GEP.setOperand(0, X);
2352                 return &GEP;
2353               }
2354       }
2355     }
2356   }
2357
2358   return 0;
2359 }
2360
2361 Instruction *InstCombiner::visitAllocationInst(AllocationInst &AI) {
2362   // Convert: malloc Ty, C - where C is a constant != 1 into: malloc [C x Ty], 1
2363   if (AI.isArrayAllocation())    // Check C != 1
2364     if (const ConstantUInt *C = dyn_cast<ConstantUInt>(AI.getArraySize())) {
2365       const Type *NewTy = ArrayType::get(AI.getAllocatedType(), C->getValue());
2366       AllocationInst *New = 0;
2367
2368       // Create and insert the replacement instruction...
2369       if (isa<MallocInst>(AI))
2370         New = new MallocInst(NewTy, 0, AI.getName(), &AI);
2371       else {
2372         assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
2373         New = new AllocaInst(NewTy, 0, AI.getName(), &AI);
2374       }
2375
2376       // Scan to the end of the allocation instructions, to skip over a block of
2377       // allocas if possible...
2378       //
2379       BasicBlock::iterator It = New;
2380       while (isa<AllocationInst>(*It)) ++It;
2381
2382       // Now that I is pointing to the first non-allocation-inst in the block,
2383       // insert our getelementptr instruction...
2384       //
2385       std::vector<Value*> Idx(2, Constant::getNullValue(Type::LongTy));
2386       Value *V = new GetElementPtrInst(New, Idx, New->getName()+".sub", It);
2387
2388       // Now make everything use the getelementptr instead of the original
2389       // allocation.
2390       ReplaceInstUsesWith(AI, V);
2391       return &AI;
2392     }
2393   return 0;
2394 }
2395
2396 Instruction *InstCombiner::visitFreeInst(FreeInst &FI) {
2397   Value *Op = FI.getOperand(0);
2398
2399   // Change free <ty>* (cast <ty2>* X to <ty>*) into free <ty2>* X
2400   if (CastInst *CI = dyn_cast<CastInst>(Op))
2401     if (isa<PointerType>(CI->getOperand(0)->getType())) {
2402       FI.setOperand(0, CI->getOperand(0));
2403       return &FI;
2404     }
2405
2406   // If we have 'free null' delete the instruction.  This can happen in stl code
2407   // when lots of inlining happens.
2408   if (isa<ConstantPointerNull>(Op))
2409     return EraseInstFromFunction(FI);
2410
2411   return 0;
2412 }
2413
2414
2415 /// GetGEPGlobalInitializer - Given a constant, and a getelementptr
2416 /// constantexpr, return the constant value being addressed by the constant
2417 /// expression, or null if something is funny.
2418 ///
2419 static Constant *GetGEPGlobalInitializer(Constant *C, ConstantExpr *CE) {
2420   if (CE->getOperand(1) != Constant::getNullValue(Type::LongTy))
2421     return 0;  // Do not allow stepping over the value!
2422
2423   // Loop over all of the operands, tracking down which value we are
2424   // addressing...
2425   for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i)
2426     if (ConstantUInt *CU = dyn_cast<ConstantUInt>(CE->getOperand(i))) {
2427       ConstantStruct *CS = dyn_cast<ConstantStruct>(C);
2428       if (CS == 0) return 0;
2429       if (CU->getValue() >= CS->getValues().size()) return 0;
2430       C = cast<Constant>(CS->getValues()[CU->getValue()]);
2431     } else if (ConstantSInt *CS = dyn_cast<ConstantSInt>(CE->getOperand(i))) {
2432       ConstantArray *CA = dyn_cast<ConstantArray>(C);
2433       if (CA == 0) return 0;
2434       if ((uint64_t)CS->getValue() >= CA->getValues().size()) return 0;
2435       C = cast<Constant>(CA->getValues()[CS->getValue()]);
2436     } else
2437       return 0;
2438   return C;
2439 }
2440
2441 Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
2442   Value *Op = LI.getOperand(0);
2443   if (LI.isVolatile()) return 0;
2444
2445   if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Op))
2446     Op = CPR->getValue();
2447
2448   // Instcombine load (constant global) into the value loaded...
2449   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Op))
2450     if (GV->isConstant() && !GV->isExternal())
2451       return ReplaceInstUsesWith(LI, GV->getInitializer());
2452
2453   // Instcombine load (constantexpr_GEP global, 0, ...) into the value loaded...
2454   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
2455     if (CE->getOpcode() == Instruction::GetElementPtr)
2456       if (ConstantPointerRef *G=dyn_cast<ConstantPointerRef>(CE->getOperand(0)))
2457         if (GlobalVariable *GV = dyn_cast<GlobalVariable>(G->getValue()))
2458           if (GV->isConstant() && !GV->isExternal())
2459             if (Constant *V = GetGEPGlobalInitializer(GV->getInitializer(), CE))
2460               return ReplaceInstUsesWith(LI, V);
2461   return 0;
2462 }
2463
2464
2465 Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
2466   // Change br (not X), label True, label False to: br X, label False, True
2467   if (BI.isConditional() && !isa<Constant>(BI.getCondition())) {
2468     if (Value *V = dyn_castNotVal(BI.getCondition())) {
2469       BasicBlock *TrueDest = BI.getSuccessor(0);
2470       BasicBlock *FalseDest = BI.getSuccessor(1);
2471       // Swap Destinations and condition...
2472       BI.setCondition(V);
2473       BI.setSuccessor(0, FalseDest);
2474       BI.setSuccessor(1, TrueDest);
2475       return &BI;
2476     } else if (SetCondInst *I = dyn_cast<SetCondInst>(BI.getCondition())) {
2477       // Cannonicalize setne -> seteq
2478       if ((I->getOpcode() == Instruction::SetNE ||
2479            I->getOpcode() == Instruction::SetLE ||
2480            I->getOpcode() == Instruction::SetGE) && I->hasOneUse()) {
2481         std::string Name = I->getName(); I->setName("");
2482         Instruction::BinaryOps NewOpcode =
2483           SetCondInst::getInverseCondition(I->getOpcode());
2484         Value *NewSCC =  BinaryOperator::create(NewOpcode, I->getOperand(0),
2485                                                 I->getOperand(1), Name, I);
2486         BasicBlock *TrueDest = BI.getSuccessor(0);
2487         BasicBlock *FalseDest = BI.getSuccessor(1);
2488         // Swap Destinations and condition...
2489         BI.setCondition(NewSCC);
2490         BI.setSuccessor(0, FalseDest);
2491         BI.setSuccessor(1, TrueDest);
2492         removeFromWorkList(I);
2493         I->getParent()->getInstList().erase(I);
2494         WorkList.push_back(cast<Instruction>(NewSCC));
2495         return &BI;
2496       }
2497     }
2498   }
2499   return 0;
2500 }
2501
2502
2503 void InstCombiner::removeFromWorkList(Instruction *I) {
2504   WorkList.erase(std::remove(WorkList.begin(), WorkList.end(), I),
2505                  WorkList.end());
2506 }
2507
2508 bool InstCombiner::runOnFunction(Function &F) {
2509   bool Changed = false;
2510   TD = &getAnalysis<TargetData>();
2511
2512   WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
2513
2514   while (!WorkList.empty()) {
2515     Instruction *I = WorkList.back();  // Get an instruction from the worklist
2516     WorkList.pop_back();
2517
2518     // Check to see if we can DCE or ConstantPropagate the instruction...
2519     // Check to see if we can DIE the instruction...
2520     if (isInstructionTriviallyDead(I)) {
2521       // Add operands to the worklist...
2522       if (I->getNumOperands() < 4)
2523         AddUsesToWorkList(*I);
2524       ++NumDeadInst;
2525
2526       I->getParent()->getInstList().erase(I);
2527       removeFromWorkList(I);
2528       continue;
2529     }
2530
2531     // Instruction isn't dead, see if we can constant propagate it...
2532     if (Constant *C = ConstantFoldInstruction(I)) {
2533       // Add operands to the worklist...
2534       AddUsesToWorkList(*I);
2535       ReplaceInstUsesWith(*I, C);
2536
2537       ++NumConstProp;
2538       I->getParent()->getInstList().erase(I);
2539       removeFromWorkList(I);
2540       continue;
2541     }
2542
2543     // Now that we have an instruction, try combining it to simplify it...
2544     if (Instruction *Result = visit(*I)) {
2545       ++NumCombined;
2546       // Should we replace the old instruction with a new one?
2547       if (Result != I) {
2548         DEBUG(std::cerr << "IC: Old = " << *I
2549                         << "    New = " << *Result);
2550
2551         // Instructions can end up on the worklist more than once.  Make sure
2552         // we do not process an instruction that has been deleted.
2553         removeFromWorkList(I);
2554
2555         // Move the name to the new instruction first...
2556         std::string OldName = I->getName(); I->setName("");
2557         Result->setName(OldName);
2558
2559         // Insert the new instruction into the basic block...
2560         BasicBlock *InstParent = I->getParent();
2561         InstParent->getInstList().insert(I, Result);
2562
2563         // Everything uses the new instruction now...
2564         I->replaceAllUsesWith(Result);
2565
2566         // Erase the old instruction.
2567         InstParent->getInstList().erase(I);
2568       } else {
2569         DEBUG(std::cerr << "IC: MOD = " << *I);
2570
2571         BasicBlock::iterator II = I;
2572
2573         // If the instruction was modified, it's possible that it is now dead.
2574         // if so, remove it.
2575         if (dceInstruction(II)) {
2576           // Instructions may end up in the worklist more than once.  Erase them
2577           // all.
2578           removeFromWorkList(I);
2579           Result = 0;
2580         }
2581       }
2582
2583       if (Result) {
2584         WorkList.push_back(Result);
2585         AddUsersToWorkList(*Result);
2586       }
2587       Changed = true;
2588     }
2589   }
2590
2591   return Changed;
2592 }
2593
2594 Pass *llvm::createInstructionCombiningPass() {
2595   return new InstCombiner();
2596 }
2597