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