lib/Transforms/Scalar/InstructionCombining.cpp

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