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