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