[Modules] Move ValueHandle into the IR library where Value itself lives.
[oota-llvm.git] / lib / Transforms / InstCombine / InstructionCombining.cpp
1 //===- InstructionCombining.cpp - Combine multiple instructions -----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // 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
12 // algebraic simplification happens.
13 //
14 // This pass combines things like:
15 //    %Y = add i32 %X, 1
16 //    %Z = add i32 %Y, 1
17 // into:
18 //    %Z = add i32 %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. Compare instructions are converted from <,>,<=,>= to ==,!= if possible
28 //    4. All cmp 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 //   ... etc.
33 //
34 //===----------------------------------------------------------------------===//
35
36 #define DEBUG_TYPE "instcombine"
37 #include "llvm/Transforms/Scalar.h"
38 #include "InstCombine.h"
39 #include "llvm-c/Initialization.h"
40 #include "llvm/ADT/SmallPtrSet.h"
41 #include "llvm/ADT/Statistic.h"
42 #include "llvm/ADT/StringSwitch.h"
43 #include "llvm/Analysis/ConstantFolding.h"
44 #include "llvm/Analysis/InstructionSimplify.h"
45 #include "llvm/Analysis/MemoryBuiltins.h"
46 #include "llvm/IR/DataLayout.h"
47 #include "llvm/IR/GetElementPtrTypeIterator.h"
48 #include "llvm/IR/IntrinsicInst.h"
49 #include "llvm/IR/PatternMatch.h"
50 #include "llvm/IR/ValueHandle.h"
51 #include "llvm/Support/CFG.h"
52 #include "llvm/Support/CommandLine.h"
53 #include "llvm/Support/Debug.h"
54 #include "llvm/Target/TargetLibraryInfo.h"
55 #include "llvm/Transforms/Utils/Local.h"
56 #include <algorithm>
57 #include <climits>
58 using namespace llvm;
59 using namespace llvm::PatternMatch;
60
61 STATISTIC(NumCombined , "Number of insts combined");
62 STATISTIC(NumConstProp, "Number of constant folds");
63 STATISTIC(NumDeadInst , "Number of dead inst eliminated");
64 STATISTIC(NumSunkInst , "Number of instructions sunk");
65 STATISTIC(NumExpand,    "Number of expansions");
66 STATISTIC(NumFactor   , "Number of factorizations");
67 STATISTIC(NumReassoc  , "Number of reassociations");
68
69 static cl::opt<bool> UnsafeFPShrink("enable-double-float-shrink", cl::Hidden,
70                                    cl::init(false),
71                                    cl::desc("Enable unsafe double to float "
72                                             "shrinking for math lib calls"));
73
74 // Initialization Routines
75 void llvm::initializeInstCombine(PassRegistry &Registry) {
76   initializeInstCombinerPass(Registry);
77 }
78
79 void LLVMInitializeInstCombine(LLVMPassRegistryRef R) {
80   initializeInstCombine(*unwrap(R));
81 }
82
83 char InstCombiner::ID = 0;
84 INITIALIZE_PASS_BEGIN(InstCombiner, "instcombine",
85                 "Combine redundant instructions", false, false)
86 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
87 INITIALIZE_PASS_END(InstCombiner, "instcombine",
88                 "Combine redundant instructions", false, false)
89
90 void InstCombiner::getAnalysisUsage(AnalysisUsage &AU) const {
91   AU.setPreservesCFG();
92   AU.addRequired<TargetLibraryInfo>();
93 }
94
95
96 Value *InstCombiner::EmitGEPOffset(User *GEP) {
97   return llvm::EmitGEPOffset(Builder, *getDataLayout(), GEP);
98 }
99
100 /// ShouldChangeType - Return true if it is desirable to convert a computation
101 /// from 'From' to 'To'.  We don't want to convert from a legal to an illegal
102 /// type for example, or from a smaller to a larger illegal type.
103 bool InstCombiner::ShouldChangeType(Type *From, Type *To) const {
104   assert(From->isIntegerTy() && To->isIntegerTy());
105
106   // If we don't have DL, we don't know if the source/dest are legal.
107   if (!DL) return false;
108
109   unsigned FromWidth = From->getPrimitiveSizeInBits();
110   unsigned ToWidth = To->getPrimitiveSizeInBits();
111   bool FromLegal = DL->isLegalInteger(FromWidth);
112   bool ToLegal = DL->isLegalInteger(ToWidth);
113
114   // If this is a legal integer from type, and the result would be an illegal
115   // type, don't do the transformation.
116   if (FromLegal && !ToLegal)
117     return false;
118
119   // Otherwise, if both are illegal, do not increase the size of the result. We
120   // do allow things like i160 -> i64, but not i64 -> i160.
121   if (!FromLegal && !ToLegal && ToWidth > FromWidth)
122     return false;
123
124   return true;
125 }
126
127 // Return true, if No Signed Wrap should be maintained for I.
128 // The No Signed Wrap flag can be kept if the operation "B (I.getOpcode) C",
129 // where both B and C should be ConstantInts, results in a constant that does
130 // not overflow. This function only handles the Add and Sub opcodes. For
131 // all other opcodes, the function conservatively returns false.
132 static bool MaintainNoSignedWrap(BinaryOperator &I, Value *B, Value *C) {
133   OverflowingBinaryOperator *OBO = dyn_cast<OverflowingBinaryOperator>(&I);
134   if (!OBO || !OBO->hasNoSignedWrap()) {
135     return false;
136   }
137
138   // We reason about Add and Sub Only.
139   Instruction::BinaryOps Opcode = I.getOpcode();
140   if (Opcode != Instruction::Add &&
141       Opcode != Instruction::Sub) {
142     return false;
143   }
144
145   ConstantInt *CB = dyn_cast<ConstantInt>(B);
146   ConstantInt *CC = dyn_cast<ConstantInt>(C);
147
148   if (!CB || !CC) {
149     return false;
150   }
151
152   const APInt &BVal = CB->getValue();
153   const APInt &CVal = CC->getValue();
154   bool Overflow = false;
155
156   if (Opcode == Instruction::Add) {
157     BVal.sadd_ov(CVal, Overflow);
158   } else {
159     BVal.ssub_ov(CVal, Overflow);
160   }
161
162   return !Overflow;
163 }
164
165 /// Conservatively clears subclassOptionalData after a reassociation or
166 /// commutation. We preserve fast-math flags when applicable as they can be
167 /// preserved.
168 static void ClearSubclassDataAfterReassociation(BinaryOperator &I) {
169   FPMathOperator *FPMO = dyn_cast<FPMathOperator>(&I);
170   if (!FPMO) {
171     I.clearSubclassOptionalData();
172     return;
173   }
174
175   FastMathFlags FMF = I.getFastMathFlags();
176   I.clearSubclassOptionalData();
177   I.setFastMathFlags(FMF);
178 }
179
180 /// SimplifyAssociativeOrCommutative - This performs a few simplifications for
181 /// operators which are associative or commutative:
182 //
183 //  Commutative operators:
184 //
185 //  1. Order operands such that they are listed from right (least complex) to
186 //     left (most complex).  This puts constants before unary operators before
187 //     binary operators.
188 //
189 //  Associative operators:
190 //
191 //  2. Transform: "(A op B) op C" ==> "A op (B op C)" if "B op C" simplifies.
192 //  3. Transform: "A op (B op C)" ==> "(A op B) op C" if "A op B" simplifies.
193 //
194 //  Associative and commutative operators:
195 //
196 //  4. Transform: "(A op B) op C" ==> "(C op A) op B" if "C op A" simplifies.
197 //  5. Transform: "A op (B op C)" ==> "B op (C op A)" if "C op A" simplifies.
198 //  6. Transform: "(A op C1) op (B op C2)" ==> "(A op B) op (C1 op C2)"
199 //     if C1 and C2 are constants.
200 //
201 bool InstCombiner::SimplifyAssociativeOrCommutative(BinaryOperator &I) {
202   Instruction::BinaryOps Opcode = I.getOpcode();
203   bool Changed = false;
204
205   do {
206     // Order operands such that they are listed from right (least complex) to
207     // left (most complex).  This puts constants before unary operators before
208     // binary operators.
209     if (I.isCommutative() && getComplexity(I.getOperand(0)) <
210         getComplexity(I.getOperand(1)))
211       Changed = !I.swapOperands();
212
213     BinaryOperator *Op0 = dyn_cast<BinaryOperator>(I.getOperand(0));
214     BinaryOperator *Op1 = dyn_cast<BinaryOperator>(I.getOperand(1));
215
216     if (I.isAssociative()) {
217       // Transform: "(A op B) op C" ==> "A op (B op C)" if "B op C" simplifies.
218       if (Op0 && Op0->getOpcode() == Opcode) {
219         Value *A = Op0->getOperand(0);
220         Value *B = Op0->getOperand(1);
221         Value *C = I.getOperand(1);
222
223         // Does "B op C" simplify?
224         if (Value *V = SimplifyBinOp(Opcode, B, C, DL)) {
225           // It simplifies to V.  Form "A op V".
226           I.setOperand(0, A);
227           I.setOperand(1, V);
228           // Conservatively clear the optional flags, since they may not be
229           // preserved by the reassociation.
230           if (MaintainNoSignedWrap(I, B, C) &&
231               (!Op0 || (isa<BinaryOperator>(Op0) && Op0->hasNoSignedWrap()))) {
232             // Note: this is only valid because SimplifyBinOp doesn't look at
233             // the operands to Op0.
234             I.clearSubclassOptionalData();
235             I.setHasNoSignedWrap(true);
236           } else {
237             ClearSubclassDataAfterReassociation(I);
238           }
239
240           Changed = true;
241           ++NumReassoc;
242           continue;
243         }
244       }
245
246       // Transform: "A op (B op C)" ==> "(A op B) op C" if "A op B" simplifies.
247       if (Op1 && Op1->getOpcode() == Opcode) {
248         Value *A = I.getOperand(0);
249         Value *B = Op1->getOperand(0);
250         Value *C = Op1->getOperand(1);
251
252         // Does "A op B" simplify?
253         if (Value *V = SimplifyBinOp(Opcode, A, B, DL)) {
254           // It simplifies to V.  Form "V op C".
255           I.setOperand(0, V);
256           I.setOperand(1, C);
257           // Conservatively clear the optional flags, since they may not be
258           // preserved by the reassociation.
259           ClearSubclassDataAfterReassociation(I);
260           Changed = true;
261           ++NumReassoc;
262           continue;
263         }
264       }
265     }
266
267     if (I.isAssociative() && I.isCommutative()) {
268       // Transform: "(A op B) op C" ==> "(C op A) op B" if "C op A" simplifies.
269       if (Op0 && Op0->getOpcode() == Opcode) {
270         Value *A = Op0->getOperand(0);
271         Value *B = Op0->getOperand(1);
272         Value *C = I.getOperand(1);
273
274         // Does "C op A" simplify?
275         if (Value *V = SimplifyBinOp(Opcode, C, A, DL)) {
276           // It simplifies to V.  Form "V op B".
277           I.setOperand(0, V);
278           I.setOperand(1, B);
279           // Conservatively clear the optional flags, since they may not be
280           // preserved by the reassociation.
281           ClearSubclassDataAfterReassociation(I);
282           Changed = true;
283           ++NumReassoc;
284           continue;
285         }
286       }
287
288       // Transform: "A op (B op C)" ==> "B op (C op A)" if "C op A" simplifies.
289       if (Op1 && Op1->getOpcode() == Opcode) {
290         Value *A = I.getOperand(0);
291         Value *B = Op1->getOperand(0);
292         Value *C = Op1->getOperand(1);
293
294         // Does "C op A" simplify?
295         if (Value *V = SimplifyBinOp(Opcode, C, A, DL)) {
296           // It simplifies to V.  Form "B op V".
297           I.setOperand(0, B);
298           I.setOperand(1, V);
299           // Conservatively clear the optional flags, since they may not be
300           // preserved by the reassociation.
301           ClearSubclassDataAfterReassociation(I);
302           Changed = true;
303           ++NumReassoc;
304           continue;
305         }
306       }
307
308       // Transform: "(A op C1) op (B op C2)" ==> "(A op B) op (C1 op C2)"
309       // if C1 and C2 are constants.
310       if (Op0 && Op1 &&
311           Op0->getOpcode() == Opcode && Op1->getOpcode() == Opcode &&
312           isa<Constant>(Op0->getOperand(1)) &&
313           isa<Constant>(Op1->getOperand(1)) &&
314           Op0->hasOneUse() && Op1->hasOneUse()) {
315         Value *A = Op0->getOperand(0);
316         Constant *C1 = cast<Constant>(Op0->getOperand(1));
317         Value *B = Op1->getOperand(0);
318         Constant *C2 = cast<Constant>(Op1->getOperand(1));
319
320         Constant *Folded = ConstantExpr::get(Opcode, C1, C2);
321         BinaryOperator *New = BinaryOperator::Create(Opcode, A, B);
322         if (isa<FPMathOperator>(New)) {
323           FastMathFlags Flags = I.getFastMathFlags();
324           Flags &= Op0->getFastMathFlags();
325           Flags &= Op1->getFastMathFlags();
326           New->setFastMathFlags(Flags);
327         }
328         InsertNewInstWith(New, I);
329         New->takeName(Op1);
330         I.setOperand(0, New);
331         I.setOperand(1, Folded);
332         // Conservatively clear the optional flags, since they may not be
333         // preserved by the reassociation.
334         ClearSubclassDataAfterReassociation(I);
335
336         Changed = true;
337         continue;
338       }
339     }
340
341     // No further simplifications.
342     return Changed;
343   } while (1);
344 }
345
346 /// LeftDistributesOverRight - Whether "X LOp (Y ROp Z)" is always equal to
347 /// "(X LOp Y) ROp (X LOp Z)".
348 static bool LeftDistributesOverRight(Instruction::BinaryOps LOp,
349                                      Instruction::BinaryOps ROp) {
350   switch (LOp) {
351   default:
352     return false;
353
354   case Instruction::And:
355     // And distributes over Or and Xor.
356     switch (ROp) {
357     default:
358       return false;
359     case Instruction::Or:
360     case Instruction::Xor:
361       return true;
362     }
363
364   case Instruction::Mul:
365     // Multiplication distributes over addition and subtraction.
366     switch (ROp) {
367     default:
368       return false;
369     case Instruction::Add:
370     case Instruction::Sub:
371       return true;
372     }
373
374   case Instruction::Or:
375     // Or distributes over And.
376     switch (ROp) {
377     default:
378       return false;
379     case Instruction::And:
380       return true;
381     }
382   }
383 }
384
385 /// RightDistributesOverLeft - Whether "(X LOp Y) ROp Z" is always equal to
386 /// "(X ROp Z) LOp (Y ROp Z)".
387 static bool RightDistributesOverLeft(Instruction::BinaryOps LOp,
388                                      Instruction::BinaryOps ROp) {
389   if (Instruction::isCommutative(ROp))
390     return LeftDistributesOverRight(ROp, LOp);
391   // TODO: It would be nice to handle division, aka "(X + Y)/Z = X/Z + Y/Z",
392   // but this requires knowing that the addition does not overflow and other
393   // such subtleties.
394   return false;
395 }
396
397 /// SimplifyUsingDistributiveLaws - This tries to simplify binary operations
398 /// which some other binary operation distributes over either by factorizing
399 /// out common terms (eg "(A*B)+(A*C)" -> "A*(B+C)") or expanding out if this
400 /// results in simplifications (eg: "A & (B | C) -> (A&B) | (A&C)" if this is
401 /// a win).  Returns the simplified value, or null if it didn't simplify.
402 Value *InstCombiner::SimplifyUsingDistributiveLaws(BinaryOperator &I) {
403   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
404   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
405   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
406   Instruction::BinaryOps TopLevelOpcode = I.getOpcode(); // op
407
408   // Factorization.
409   if (Op0 && Op1 && Op0->getOpcode() == Op1->getOpcode()) {
410     // The instruction has the form "(A op' B) op (C op' D)".  Try to factorize
411     // a common term.
412     Value *A = Op0->getOperand(0), *B = Op0->getOperand(1);
413     Value *C = Op1->getOperand(0), *D = Op1->getOperand(1);
414     Instruction::BinaryOps InnerOpcode = Op0->getOpcode(); // op'
415
416     // Does "X op' Y" always equal "Y op' X"?
417     bool InnerCommutative = Instruction::isCommutative(InnerOpcode);
418
419     // Does "X op' (Y op Z)" always equal "(X op' Y) op (X op' Z)"?
420     if (LeftDistributesOverRight(InnerOpcode, TopLevelOpcode))
421       // Does the instruction have the form "(A op' B) op (A op' D)" or, in the
422       // commutative case, "(A op' B) op (C op' A)"?
423       if (A == C || (InnerCommutative && A == D)) {
424         if (A != C)
425           std::swap(C, D);
426         // Consider forming "A op' (B op D)".
427         // If "B op D" simplifies then it can be formed with no cost.
428         Value *V = SimplifyBinOp(TopLevelOpcode, B, D, DL);
429         // If "B op D" doesn't simplify then only go on if both of the existing
430         // operations "A op' B" and "C op' D" will be zapped as no longer used.
431         if (!V && Op0->hasOneUse() && Op1->hasOneUse())
432           V = Builder->CreateBinOp(TopLevelOpcode, B, D, Op1->getName());
433         if (V) {
434           ++NumFactor;
435           V = Builder->CreateBinOp(InnerOpcode, A, V);
436           V->takeName(&I);
437           return V;
438         }
439       }
440
441     // Does "(X op Y) op' Z" always equal "(X op' Z) op (Y op' Z)"?
442     if (RightDistributesOverLeft(TopLevelOpcode, InnerOpcode))
443       // Does the instruction have the form "(A op' B) op (C op' B)" or, in the
444       // commutative case, "(A op' B) op (B op' D)"?
445       if (B == D || (InnerCommutative && B == C)) {
446         if (B != D)
447           std::swap(C, D);
448         // Consider forming "(A op C) op' B".
449         // If "A op C" simplifies then it can be formed with no cost.
450         Value *V = SimplifyBinOp(TopLevelOpcode, A, C, DL);
451         // If "A op C" doesn't simplify then only go on if both of the existing
452         // operations "A op' B" and "C op' D" will be zapped as no longer used.
453         if (!V && Op0->hasOneUse() && Op1->hasOneUse())
454           V = Builder->CreateBinOp(TopLevelOpcode, A, C, Op0->getName());
455         if (V) {
456           ++NumFactor;
457           V = Builder->CreateBinOp(InnerOpcode, V, B);
458           V->takeName(&I);
459           return V;
460         }
461       }
462   }
463
464   // Expansion.
465   if (Op0 && RightDistributesOverLeft(Op0->getOpcode(), TopLevelOpcode)) {
466     // The instruction has the form "(A op' B) op C".  See if expanding it out
467     // to "(A op C) op' (B op C)" results in simplifications.
468     Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
469     Instruction::BinaryOps InnerOpcode = Op0->getOpcode(); // op'
470
471     // Do "A op C" and "B op C" both simplify?
472     if (Value *L = SimplifyBinOp(TopLevelOpcode, A, C, DL))
473       if (Value *R = SimplifyBinOp(TopLevelOpcode, B, C, DL)) {
474         // They do! Return "L op' R".
475         ++NumExpand;
476         // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
477         if ((L == A && R == B) ||
478             (Instruction::isCommutative(InnerOpcode) && L == B && R == A))
479           return Op0;
480         // Otherwise return "L op' R" if it simplifies.
481         if (Value *V = SimplifyBinOp(InnerOpcode, L, R, DL))
482           return V;
483         // Otherwise, create a new instruction.
484         C = Builder->CreateBinOp(InnerOpcode, L, R);
485         C->takeName(&I);
486         return C;
487       }
488   }
489
490   if (Op1 && LeftDistributesOverRight(TopLevelOpcode, Op1->getOpcode())) {
491     // The instruction has the form "A op (B op' C)".  See if expanding it out
492     // to "(A op B) op' (A op C)" results in simplifications.
493     Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
494     Instruction::BinaryOps InnerOpcode = Op1->getOpcode(); // op'
495
496     // Do "A op B" and "A op C" both simplify?
497     if (Value *L = SimplifyBinOp(TopLevelOpcode, A, B, DL))
498       if (Value *R = SimplifyBinOp(TopLevelOpcode, A, C, DL)) {
499         // They do! Return "L op' R".
500         ++NumExpand;
501         // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
502         if ((L == B && R == C) ||
503             (Instruction::isCommutative(InnerOpcode) && L == C && R == B))
504           return Op1;
505         // Otherwise return "L op' R" if it simplifies.
506         if (Value *V = SimplifyBinOp(InnerOpcode, L, R, DL))
507           return V;
508         // Otherwise, create a new instruction.
509         A = Builder->CreateBinOp(InnerOpcode, L, R);
510         A->takeName(&I);
511         return A;
512       }
513   }
514
515   return 0;
516 }
517
518 // dyn_castNegVal - Given a 'sub' instruction, return the RHS of the instruction
519 // if the LHS is a constant zero (which is the 'negate' form).
520 //
521 Value *InstCombiner::dyn_castNegVal(Value *V) const {
522   if (BinaryOperator::isNeg(V))
523     return BinaryOperator::getNegArgument(V);
524
525   // Constants can be considered to be negated values if they can be folded.
526   if (ConstantInt *C = dyn_cast<ConstantInt>(V))
527     return ConstantExpr::getNeg(C);
528
529   if (ConstantDataVector *C = dyn_cast<ConstantDataVector>(V))
530     if (C->getType()->getElementType()->isIntegerTy())
531       return ConstantExpr::getNeg(C);
532
533   return 0;
534 }
535
536 // dyn_castFNegVal - Given a 'fsub' instruction, return the RHS of the
537 // instruction if the LHS is a constant negative zero (which is the 'negate'
538 // form).
539 //
540 Value *InstCombiner::dyn_castFNegVal(Value *V, bool IgnoreZeroSign) const {
541   if (BinaryOperator::isFNeg(V, IgnoreZeroSign))
542     return BinaryOperator::getFNegArgument(V);
543
544   // Constants can be considered to be negated values if they can be folded.
545   if (ConstantFP *C = dyn_cast<ConstantFP>(V))
546     return ConstantExpr::getFNeg(C);
547
548   if (ConstantDataVector *C = dyn_cast<ConstantDataVector>(V))
549     if (C->getType()->getElementType()->isFloatingPointTy())
550       return ConstantExpr::getFNeg(C);
551
552   return 0;
553 }
554
555 static Value *FoldOperationIntoSelectOperand(Instruction &I, Value *SO,
556                                              InstCombiner *IC) {
557   if (CastInst *CI = dyn_cast<CastInst>(&I)) {
558     return IC->Builder->CreateCast(CI->getOpcode(), SO, I.getType());
559   }
560
561   // Figure out if the constant is the left or the right argument.
562   bool ConstIsRHS = isa<Constant>(I.getOperand(1));
563   Constant *ConstOperand = cast<Constant>(I.getOperand(ConstIsRHS));
564
565   if (Constant *SOC = dyn_cast<Constant>(SO)) {
566     if (ConstIsRHS)
567       return ConstantExpr::get(I.getOpcode(), SOC, ConstOperand);
568     return ConstantExpr::get(I.getOpcode(), ConstOperand, SOC);
569   }
570
571   Value *Op0 = SO, *Op1 = ConstOperand;
572   if (!ConstIsRHS)
573     std::swap(Op0, Op1);
574
575   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(&I)) {
576     Value *RI = IC->Builder->CreateBinOp(BO->getOpcode(), Op0, Op1,
577                                     SO->getName()+".op");
578     Instruction *FPInst = dyn_cast<Instruction>(RI);
579     if (FPInst && isa<FPMathOperator>(FPInst))
580       FPInst->copyFastMathFlags(BO);
581     return RI;
582   }
583   if (ICmpInst *CI = dyn_cast<ICmpInst>(&I))
584     return IC->Builder->CreateICmp(CI->getPredicate(), Op0, Op1,
585                                    SO->getName()+".cmp");
586   if (FCmpInst *CI = dyn_cast<FCmpInst>(&I))
587     return IC->Builder->CreateICmp(CI->getPredicate(), Op0, Op1,
588                                    SO->getName()+".cmp");
589   llvm_unreachable("Unknown binary instruction type!");
590 }
591
592 // FoldOpIntoSelect - Given an instruction with a select as one operand and a
593 // constant as the other operand, try to fold the binary operator into the
594 // select arguments.  This also works for Cast instructions, which obviously do
595 // not have a second operand.
596 Instruction *InstCombiner::FoldOpIntoSelect(Instruction &Op, SelectInst *SI) {
597   // Don't modify shared select instructions
598   if (!SI->hasOneUse()) return 0;
599   Value *TV = SI->getOperand(1);
600   Value *FV = SI->getOperand(2);
601
602   if (isa<Constant>(TV) || isa<Constant>(FV)) {
603     // Bool selects with constant operands can be folded to logical ops.
604     if (SI->getType()->isIntegerTy(1)) return 0;
605
606     // If it's a bitcast involving vectors, make sure it has the same number of
607     // elements on both sides.
608     if (BitCastInst *BC = dyn_cast<BitCastInst>(&Op)) {
609       VectorType *DestTy = dyn_cast<VectorType>(BC->getDestTy());
610       VectorType *SrcTy = dyn_cast<VectorType>(BC->getSrcTy());
611
612       // Verify that either both or neither are vectors.
613       if ((SrcTy == NULL) != (DestTy == NULL)) return 0;
614       // If vectors, verify that they have the same number of elements.
615       if (SrcTy && SrcTy->getNumElements() != DestTy->getNumElements())
616         return 0;
617     }
618
619     Value *SelectTrueVal = FoldOperationIntoSelectOperand(Op, TV, this);
620     Value *SelectFalseVal = FoldOperationIntoSelectOperand(Op, FV, this);
621
622     return SelectInst::Create(SI->getCondition(),
623                               SelectTrueVal, SelectFalseVal);
624   }
625   return 0;
626 }
627
628
629 /// FoldOpIntoPhi - Given a binary operator, cast instruction, or select which
630 /// has a PHI node as operand #0, see if we can fold the instruction into the
631 /// PHI (which is only possible if all operands to the PHI are constants).
632 ///
633 Instruction *InstCombiner::FoldOpIntoPhi(Instruction &I) {
634   PHINode *PN = cast<PHINode>(I.getOperand(0));
635   unsigned NumPHIValues = PN->getNumIncomingValues();
636   if (NumPHIValues == 0)
637     return 0;
638
639   // We normally only transform phis with a single use.  However, if a PHI has
640   // multiple uses and they are all the same operation, we can fold *all* of the
641   // uses into the PHI.
642   if (!PN->hasOneUse()) {
643     // Walk the use list for the instruction, comparing them to I.
644     for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end();
645          UI != E; ++UI) {
646       Instruction *User = cast<Instruction>(*UI);
647       if (User != &I && !I.isIdenticalTo(User))
648         return 0;
649     }
650     // Otherwise, we can replace *all* users with the new PHI we form.
651   }
652
653   // Check to see if all of the operands of the PHI are simple constants
654   // (constantint/constantfp/undef).  If there is one non-constant value,
655   // remember the BB it is in.  If there is more than one or if *it* is a PHI,
656   // bail out.  We don't do arbitrary constant expressions here because moving
657   // their computation can be expensive without a cost model.
658   BasicBlock *NonConstBB = 0;
659   for (unsigned i = 0; i != NumPHIValues; ++i) {
660     Value *InVal = PN->getIncomingValue(i);
661     if (isa<Constant>(InVal) && !isa<ConstantExpr>(InVal))
662       continue;
663
664     if (isa<PHINode>(InVal)) return 0;  // Itself a phi.
665     if (NonConstBB) return 0;  // More than one non-const value.
666
667     NonConstBB = PN->getIncomingBlock(i);
668
669     // If the InVal is an invoke at the end of the pred block, then we can't
670     // insert a computation after it without breaking the edge.
671     if (InvokeInst *II = dyn_cast<InvokeInst>(InVal))
672       if (II->getParent() == NonConstBB)
673         return 0;
674
675     // If the incoming non-constant value is in I's block, we will remove one
676     // instruction, but insert another equivalent one, leading to infinite
677     // instcombine.
678     if (NonConstBB == I.getParent())
679       return 0;
680   }
681
682   // If there is exactly one non-constant value, we can insert a copy of the
683   // operation in that block.  However, if this is a critical edge, we would be
684   // inserting the computation one some other paths (e.g. inside a loop).  Only
685   // do this if the pred block is unconditionally branching into the phi block.
686   if (NonConstBB != 0) {
687     BranchInst *BI = dyn_cast<BranchInst>(NonConstBB->getTerminator());
688     if (!BI || !BI->isUnconditional()) return 0;
689   }
690
691   // Okay, we can do the transformation: create the new PHI node.
692   PHINode *NewPN = PHINode::Create(I.getType(), PN->getNumIncomingValues());
693   InsertNewInstBefore(NewPN, *PN);
694   NewPN->takeName(PN);
695
696   // If we are going to have to insert a new computation, do so right before the
697   // predecessors terminator.
698   if (NonConstBB)
699     Builder->SetInsertPoint(NonConstBB->getTerminator());
700
701   // Next, add all of the operands to the PHI.
702   if (SelectInst *SI = dyn_cast<SelectInst>(&I)) {
703     // We only currently try to fold the condition of a select when it is a phi,
704     // not the true/false values.
705     Value *TrueV = SI->getTrueValue();
706     Value *FalseV = SI->getFalseValue();
707     BasicBlock *PhiTransBB = PN->getParent();
708     for (unsigned i = 0; i != NumPHIValues; ++i) {
709       BasicBlock *ThisBB = PN->getIncomingBlock(i);
710       Value *TrueVInPred = TrueV->DoPHITranslation(PhiTransBB, ThisBB);
711       Value *FalseVInPred = FalseV->DoPHITranslation(PhiTransBB, ThisBB);
712       Value *InV = 0;
713       // Beware of ConstantExpr:  it may eventually evaluate to getNullValue,
714       // even if currently isNullValue gives false.
715       Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i));
716       if (InC && !isa<ConstantExpr>(InC))
717         InV = InC->isNullValue() ? FalseVInPred : TrueVInPred;
718       else
719         InV = Builder->CreateSelect(PN->getIncomingValue(i),
720                                     TrueVInPred, FalseVInPred, "phitmp");
721       NewPN->addIncoming(InV, ThisBB);
722     }
723   } else if (CmpInst *CI = dyn_cast<CmpInst>(&I)) {
724     Constant *C = cast<Constant>(I.getOperand(1));
725     for (unsigned i = 0; i != NumPHIValues; ++i) {
726       Value *InV = 0;
727       if (Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i)))
728         InV = ConstantExpr::getCompare(CI->getPredicate(), InC, C);
729       else if (isa<ICmpInst>(CI))
730         InV = Builder->CreateICmp(CI->getPredicate(), PN->getIncomingValue(i),
731                                   C, "phitmp");
732       else
733         InV = Builder->CreateFCmp(CI->getPredicate(), PN->getIncomingValue(i),
734                                   C, "phitmp");
735       NewPN->addIncoming(InV, PN->getIncomingBlock(i));
736     }
737   } else if (I.getNumOperands() == 2) {
738     Constant *C = cast<Constant>(I.getOperand(1));
739     for (unsigned i = 0; i != NumPHIValues; ++i) {
740       Value *InV = 0;
741       if (Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i)))
742         InV = ConstantExpr::get(I.getOpcode(), InC, C);
743       else
744         InV = Builder->CreateBinOp(cast<BinaryOperator>(I).getOpcode(),
745                                    PN->getIncomingValue(i), C, "phitmp");
746       NewPN->addIncoming(InV, PN->getIncomingBlock(i));
747     }
748   } else {
749     CastInst *CI = cast<CastInst>(&I);
750     Type *RetTy = CI->getType();
751     for (unsigned i = 0; i != NumPHIValues; ++i) {
752       Value *InV;
753       if (Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i)))
754         InV = ConstantExpr::getCast(CI->getOpcode(), InC, RetTy);
755       else
756         InV = Builder->CreateCast(CI->getOpcode(),
757                                 PN->getIncomingValue(i), I.getType(), "phitmp");
758       NewPN->addIncoming(InV, PN->getIncomingBlock(i));
759     }
760   }
761
762   for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end();
763        UI != E; ) {
764     Instruction *User = cast<Instruction>(*UI++);
765     if (User == &I) continue;
766     ReplaceInstUsesWith(*User, NewPN);
767     EraseInstFromFunction(*User);
768   }
769   return ReplaceInstUsesWith(I, NewPN);
770 }
771
772 /// FindElementAtOffset - Given a pointer type and a constant offset, determine
773 /// whether or not there is a sequence of GEP indices into the pointed type that
774 /// will land us at the specified offset.  If so, fill them into NewIndices and
775 /// return the resultant element type, otherwise return null.
776 Type *InstCombiner::FindElementAtOffset(Type *PtrTy, int64_t Offset,
777                                         SmallVectorImpl<Value*> &NewIndices) {
778   assert(PtrTy->isPtrOrPtrVectorTy());
779
780   if (!DL)
781     return 0;
782
783   Type *Ty = PtrTy->getPointerElementType();
784   if (!Ty->isSized())
785     return 0;
786
787   // Start with the index over the outer type.  Note that the type size
788   // might be zero (even if the offset isn't zero) if the indexed type
789   // is something like [0 x {int, int}]
790   Type *IntPtrTy = DL->getIntPtrType(PtrTy);
791   int64_t FirstIdx = 0;
792   if (int64_t TySize = DL->getTypeAllocSize(Ty)) {
793     FirstIdx = Offset/TySize;
794     Offset -= FirstIdx*TySize;
795
796     // Handle hosts where % returns negative instead of values [0..TySize).
797     if (Offset < 0) {
798       --FirstIdx;
799       Offset += TySize;
800       assert(Offset >= 0);
801     }
802     assert((uint64_t)Offset < (uint64_t)TySize && "Out of range offset");
803   }
804
805   NewIndices.push_back(ConstantInt::get(IntPtrTy, FirstIdx));
806
807   // Index into the types.  If we fail, set OrigBase to null.
808   while (Offset) {
809     // Indexing into tail padding between struct/array elements.
810     if (uint64_t(Offset*8) >= DL->getTypeSizeInBits(Ty))
811       return 0;
812
813     if (StructType *STy = dyn_cast<StructType>(Ty)) {
814       const StructLayout *SL = DL->getStructLayout(STy);
815       assert(Offset < (int64_t)SL->getSizeInBytes() &&
816              "Offset must stay within the indexed type");
817
818       unsigned Elt = SL->getElementContainingOffset(Offset);
819       NewIndices.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
820                                             Elt));
821
822       Offset -= SL->getElementOffset(Elt);
823       Ty = STy->getElementType(Elt);
824     } else if (ArrayType *AT = dyn_cast<ArrayType>(Ty)) {
825       uint64_t EltSize = DL->getTypeAllocSize(AT->getElementType());
826       assert(EltSize && "Cannot index into a zero-sized array");
827       NewIndices.push_back(ConstantInt::get(IntPtrTy,Offset/EltSize));
828       Offset %= EltSize;
829       Ty = AT->getElementType();
830     } else {
831       // Otherwise, we can't index into the middle of this atomic type, bail.
832       return 0;
833     }
834   }
835
836   return Ty;
837 }
838
839 static bool shouldMergeGEPs(GEPOperator &GEP, GEPOperator &Src) {
840   // If this GEP has only 0 indices, it is the same pointer as
841   // Src. If Src is not a trivial GEP too, don't combine
842   // the indices.
843   if (GEP.hasAllZeroIndices() && !Src.hasAllZeroIndices() &&
844       !Src.hasOneUse())
845     return false;
846   return true;
847 }
848
849 /// Descale - Return a value X such that Val = X * Scale, or null if none.  If
850 /// the multiplication is known not to overflow then NoSignedWrap is set.
851 Value *InstCombiner::Descale(Value *Val, APInt Scale, bool &NoSignedWrap) {
852   assert(isa<IntegerType>(Val->getType()) && "Can only descale integers!");
853   assert(cast<IntegerType>(Val->getType())->getBitWidth() ==
854          Scale.getBitWidth() && "Scale not compatible with value!");
855
856   // If Val is zero or Scale is one then Val = Val * Scale.
857   if (match(Val, m_Zero()) || Scale == 1) {
858     NoSignedWrap = true;
859     return Val;
860   }
861
862   // If Scale is zero then it does not divide Val.
863   if (Scale.isMinValue())
864     return 0;
865
866   // Look through chains of multiplications, searching for a constant that is
867   // divisible by Scale.  For example, descaling X*(Y*(Z*4)) by a factor of 4
868   // will find the constant factor 4 and produce X*(Y*Z).  Descaling X*(Y*8) by
869   // a factor of 4 will produce X*(Y*2).  The principle of operation is to bore
870   // down from Val:
871   //
872   //     Val = M1 * X          ||   Analysis starts here and works down
873   //      M1 = M2 * Y          ||   Doesn't descend into terms with more
874   //      M2 =  Z * 4          \/   than one use
875   //
876   // Then to modify a term at the bottom:
877   //
878   //     Val = M1 * X
879   //      M1 =  Z * Y          ||   Replaced M2 with Z
880   //
881   // Then to work back up correcting nsw flags.
882
883   // Op - the term we are currently analyzing.  Starts at Val then drills down.
884   // Replaced with its descaled value before exiting from the drill down loop.
885   Value *Op = Val;
886
887   // Parent - initially null, but after drilling down notes where Op came from.
888   // In the example above, Parent is (Val, 0) when Op is M1, because M1 is the
889   // 0'th operand of Val.
890   std::pair<Instruction*, unsigned> Parent;
891
892   // RequireNoSignedWrap - Set if the transform requires a descaling at deeper
893   // levels that doesn't overflow.
894   bool RequireNoSignedWrap = false;
895
896   // logScale - log base 2 of the scale.  Negative if not a power of 2.
897   int32_t logScale = Scale.exactLogBase2();
898
899   for (;; Op = Parent.first->getOperand(Parent.second)) { // Drill down
900
901     if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
902       // If Op is a constant divisible by Scale then descale to the quotient.
903       APInt Quotient(Scale), Remainder(Scale); // Init ensures right bitwidth.
904       APInt::sdivrem(CI->getValue(), Scale, Quotient, Remainder);
905       if (!Remainder.isMinValue())
906         // Not divisible by Scale.
907         return 0;
908       // Replace with the quotient in the parent.
909       Op = ConstantInt::get(CI->getType(), Quotient);
910       NoSignedWrap = true;
911       break;
912     }
913
914     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op)) {
915
916       if (BO->getOpcode() == Instruction::Mul) {
917         // Multiplication.
918         NoSignedWrap = BO->hasNoSignedWrap();
919         if (RequireNoSignedWrap && !NoSignedWrap)
920           return 0;
921
922         // There are three cases for multiplication: multiplication by exactly
923         // the scale, multiplication by a constant different to the scale, and
924         // multiplication by something else.
925         Value *LHS = BO->getOperand(0);
926         Value *RHS = BO->getOperand(1);
927
928         if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
929           // Multiplication by a constant.
930           if (CI->getValue() == Scale) {
931             // Multiplication by exactly the scale, replace the multiplication
932             // by its left-hand side in the parent.
933             Op = LHS;
934             break;
935           }
936
937           // Otherwise drill down into the constant.
938           if (!Op->hasOneUse())
939             return 0;
940
941           Parent = std::make_pair(BO, 1);
942           continue;
943         }
944
945         // Multiplication by something else. Drill down into the left-hand side
946         // since that's where the reassociate pass puts the good stuff.
947         if (!Op->hasOneUse())
948           return 0;
949
950         Parent = std::make_pair(BO, 0);
951         continue;
952       }
953
954       if (logScale > 0 && BO->getOpcode() == Instruction::Shl &&
955           isa<ConstantInt>(BO->getOperand(1))) {
956         // Multiplication by a power of 2.
957         NoSignedWrap = BO->hasNoSignedWrap();
958         if (RequireNoSignedWrap && !NoSignedWrap)
959           return 0;
960
961         Value *LHS = BO->getOperand(0);
962         int32_t Amt = cast<ConstantInt>(BO->getOperand(1))->
963           getLimitedValue(Scale.getBitWidth());
964         // Op = LHS << Amt.
965
966         if (Amt == logScale) {
967           // Multiplication by exactly the scale, replace the multiplication
968           // by its left-hand side in the parent.
969           Op = LHS;
970           break;
971         }
972         if (Amt < logScale || !Op->hasOneUse())
973           return 0;
974
975         // Multiplication by more than the scale.  Reduce the multiplying amount
976         // by the scale in the parent.
977         Parent = std::make_pair(BO, 1);
978         Op = ConstantInt::get(BO->getType(), Amt - logScale);
979         break;
980       }
981     }
982
983     if (!Op->hasOneUse())
984       return 0;
985
986     if (CastInst *Cast = dyn_cast<CastInst>(Op)) {
987       if (Cast->getOpcode() == Instruction::SExt) {
988         // Op is sign-extended from a smaller type, descale in the smaller type.
989         unsigned SmallSize = Cast->getSrcTy()->getPrimitiveSizeInBits();
990         APInt SmallScale = Scale.trunc(SmallSize);
991         // Suppose Op = sext X, and we descale X as Y * SmallScale.  We want to
992         // descale Op as (sext Y) * Scale.  In order to have
993         //   sext (Y * SmallScale) = (sext Y) * Scale
994         // some conditions need to hold however: SmallScale must sign-extend to
995         // Scale and the multiplication Y * SmallScale should not overflow.
996         if (SmallScale.sext(Scale.getBitWidth()) != Scale)
997           // SmallScale does not sign-extend to Scale.
998           return 0;
999         assert(SmallScale.exactLogBase2() == logScale);
1000         // Require that Y * SmallScale must not overflow.
1001         RequireNoSignedWrap = true;
1002
1003         // Drill down through the cast.
1004         Parent = std::make_pair(Cast, 0);
1005         Scale = SmallScale;
1006         continue;
1007       }
1008
1009       if (Cast->getOpcode() == Instruction::Trunc) {
1010         // Op is truncated from a larger type, descale in the larger type.
1011         // Suppose Op = trunc X, and we descale X as Y * sext Scale.  Then
1012         //   trunc (Y * sext Scale) = (trunc Y) * Scale
1013         // always holds.  However (trunc Y) * Scale may overflow even if
1014         // trunc (Y * sext Scale) does not, so nsw flags need to be cleared
1015         // from this point up in the expression (see later).
1016         if (RequireNoSignedWrap)
1017           return 0;
1018
1019         // Drill down through the cast.
1020         unsigned LargeSize = Cast->getSrcTy()->getPrimitiveSizeInBits();
1021         Parent = std::make_pair(Cast, 0);
1022         Scale = Scale.sext(LargeSize);
1023         if (logScale + 1 == (int32_t)Cast->getType()->getPrimitiveSizeInBits())
1024           logScale = -1;
1025         assert(Scale.exactLogBase2() == logScale);
1026         continue;
1027       }
1028     }
1029
1030     // Unsupported expression, bail out.
1031     return 0;
1032   }
1033
1034   // We know that we can successfully descale, so from here on we can safely
1035   // modify the IR.  Op holds the descaled version of the deepest term in the
1036   // expression.  NoSignedWrap is 'true' if multiplying Op by Scale is known
1037   // not to overflow.
1038
1039   if (!Parent.first)
1040     // The expression only had one term.
1041     return Op;
1042
1043   // Rewrite the parent using the descaled version of its operand.
1044   assert(Parent.first->hasOneUse() && "Drilled down when more than one use!");
1045   assert(Op != Parent.first->getOperand(Parent.second) &&
1046          "Descaling was a no-op?");
1047   Parent.first->setOperand(Parent.second, Op);
1048   Worklist.Add(Parent.first);
1049
1050   // Now work back up the expression correcting nsw flags.  The logic is based
1051   // on the following observation: if X * Y is known not to overflow as a signed
1052   // multiplication, and Y is replaced by a value Z with smaller absolute value,
1053   // then X * Z will not overflow as a signed multiplication either.  As we work
1054   // our way up, having NoSignedWrap 'true' means that the descaled value at the
1055   // current level has strictly smaller absolute value than the original.
1056   Instruction *Ancestor = Parent.first;
1057   do {
1058     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Ancestor)) {
1059       // If the multiplication wasn't nsw then we can't say anything about the
1060       // value of the descaled multiplication, and we have to clear nsw flags
1061       // from this point on up.
1062       bool OpNoSignedWrap = BO->hasNoSignedWrap();
1063       NoSignedWrap &= OpNoSignedWrap;
1064       if (NoSignedWrap != OpNoSignedWrap) {
1065         BO->setHasNoSignedWrap(NoSignedWrap);
1066         Worklist.Add(Ancestor);
1067       }
1068     } else if (Ancestor->getOpcode() == Instruction::Trunc) {
1069       // The fact that the descaled input to the trunc has smaller absolute
1070       // value than the original input doesn't tell us anything useful about
1071       // the absolute values of the truncations.
1072       NoSignedWrap = false;
1073     }
1074     assert((Ancestor->getOpcode() != Instruction::SExt || NoSignedWrap) &&
1075            "Failed to keep proper track of nsw flags while drilling down?");
1076
1077     if (Ancestor == Val)
1078       // Got to the top, all done!
1079       return Val;
1080
1081     // Move up one level in the expression.
1082     assert(Ancestor->hasOneUse() && "Drilled down when more than one use!");
1083     Ancestor = Ancestor->use_back();
1084   } while (1);
1085 }
1086
1087 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1088   SmallVector<Value*, 8> Ops(GEP.op_begin(), GEP.op_end());
1089
1090   if (Value *V = SimplifyGEPInst(Ops, DL))
1091     return ReplaceInstUsesWith(GEP, V);
1092
1093   Value *PtrOp = GEP.getOperand(0);
1094
1095   // Eliminate unneeded casts for indices, and replace indices which displace
1096   // by multiples of a zero size type with zero.
1097   if (DL) {
1098     bool MadeChange = false;
1099     Type *IntPtrTy = DL->getIntPtrType(GEP.getPointerOperandType());
1100
1101     gep_type_iterator GTI = gep_type_begin(GEP);
1102     for (User::op_iterator I = GEP.op_begin() + 1, E = GEP.op_end();
1103          I != E; ++I, ++GTI) {
1104       // Skip indices into struct types.
1105       SequentialType *SeqTy = dyn_cast<SequentialType>(*GTI);
1106       if (!SeqTy) continue;
1107
1108       // If the element type has zero size then any index over it is equivalent
1109       // to an index of zero, so replace it with zero if it is not zero already.
1110       if (SeqTy->getElementType()->isSized() &&
1111           DL->getTypeAllocSize(SeqTy->getElementType()) == 0)
1112         if (!isa<Constant>(*I) || !cast<Constant>(*I)->isNullValue()) {
1113           *I = Constant::getNullValue(IntPtrTy);
1114           MadeChange = true;
1115         }
1116
1117       Type *IndexTy = (*I)->getType();
1118       if (IndexTy != IntPtrTy) {
1119         // If we are using a wider index than needed for this platform, shrink
1120         // it to what we need.  If narrower, sign-extend it to what we need.
1121         // This explicit cast can make subsequent optimizations more obvious.
1122         *I = Builder->CreateIntCast(*I, IntPtrTy, true);
1123         MadeChange = true;
1124       }
1125     }
1126     if (MadeChange) return &GEP;
1127   }
1128
1129   // Combine Indices - If the source pointer to this getelementptr instruction
1130   // is a getelementptr instruction, combine the indices of the two
1131   // getelementptr instructions into a single instruction.
1132   //
1133   if (GEPOperator *Src = dyn_cast<GEPOperator>(PtrOp)) {
1134     if (!shouldMergeGEPs(*cast<GEPOperator>(&GEP), *Src))
1135       return 0;
1136
1137     // Note that if our source is a gep chain itself then we wait for that
1138     // chain to be resolved before we perform this transformation.  This
1139     // avoids us creating a TON of code in some cases.
1140     if (GEPOperator *SrcGEP =
1141           dyn_cast<GEPOperator>(Src->getOperand(0)))
1142       if (SrcGEP->getNumOperands() == 2 && shouldMergeGEPs(*Src, *SrcGEP))
1143         return 0;   // Wait until our source is folded to completion.
1144
1145     SmallVector<Value*, 8> Indices;
1146
1147     // Find out whether the last index in the source GEP is a sequential idx.
1148     bool EndsWithSequential = false;
1149     for (gep_type_iterator I = gep_type_begin(*Src), E = gep_type_end(*Src);
1150          I != E; ++I)
1151       EndsWithSequential = !(*I)->isStructTy();
1152
1153     // Can we combine the two pointer arithmetics offsets?
1154     if (EndsWithSequential) {
1155       // Replace: gep (gep %P, long B), long A, ...
1156       // With:    T = long A+B; gep %P, T, ...
1157       //
1158       Value *Sum;
1159       Value *SO1 = Src->getOperand(Src->getNumOperands()-1);
1160       Value *GO1 = GEP.getOperand(1);
1161       if (SO1 == Constant::getNullValue(SO1->getType())) {
1162         Sum = GO1;
1163       } else if (GO1 == Constant::getNullValue(GO1->getType())) {
1164         Sum = SO1;
1165       } else {
1166         // If they aren't the same type, then the input hasn't been processed
1167         // by the loop above yet (which canonicalizes sequential index types to
1168         // intptr_t).  Just avoid transforming this until the input has been
1169         // normalized.
1170         if (SO1->getType() != GO1->getType())
1171           return 0;
1172         Sum = Builder->CreateAdd(SO1, GO1, PtrOp->getName()+".sum");
1173       }
1174
1175       // Update the GEP in place if possible.
1176       if (Src->getNumOperands() == 2) {
1177         GEP.setOperand(0, Src->getOperand(0));
1178         GEP.setOperand(1, Sum);
1179         return &GEP;
1180       }
1181       Indices.append(Src->op_begin()+1, Src->op_end()-1);
1182       Indices.push_back(Sum);
1183       Indices.append(GEP.op_begin()+2, GEP.op_end());
1184     } else if (isa<Constant>(*GEP.idx_begin()) &&
1185                cast<Constant>(*GEP.idx_begin())->isNullValue() &&
1186                Src->getNumOperands() != 1) {
1187       // Otherwise we can do the fold if the first index of the GEP is a zero
1188       Indices.append(Src->op_begin()+1, Src->op_end());
1189       Indices.append(GEP.idx_begin()+1, GEP.idx_end());
1190     }
1191
1192     if (!Indices.empty())
1193       return (GEP.isInBounds() && Src->isInBounds()) ?
1194         GetElementPtrInst::CreateInBounds(Src->getOperand(0), Indices,
1195                                           GEP.getName()) :
1196         GetElementPtrInst::Create(Src->getOperand(0), Indices, GEP.getName());
1197   }
1198
1199   // Canonicalize (gep i8* X, -(ptrtoint Y)) to (sub (ptrtoint X), (ptrtoint Y))
1200   // The GEP pattern is emitted by the SCEV expander for certain kinds of
1201   // pointer arithmetic.
1202   if (DL && GEP.getNumIndices() == 1 &&
1203       match(GEP.getOperand(1), m_Neg(m_PtrToInt(m_Value())))) {
1204     unsigned AS = GEP.getPointerAddressSpace();
1205     if (GEP.getType() == Builder->getInt8PtrTy(AS) &&
1206         GEP.getOperand(1)->getType()->getScalarSizeInBits() ==
1207         DL->getPointerSizeInBits(AS)) {
1208       Operator *Index = cast<Operator>(GEP.getOperand(1));
1209       Value *PtrToInt = Builder->CreatePtrToInt(PtrOp, Index->getType());
1210       Value *NewSub = Builder->CreateSub(PtrToInt, Index->getOperand(1));
1211       return CastInst::Create(Instruction::IntToPtr, NewSub, GEP.getType());
1212     }
1213   }
1214
1215   // Handle gep(bitcast x) and gep(gep x, 0, 0, 0).
1216   Value *StrippedPtr = PtrOp->stripPointerCasts();
1217   PointerType *StrippedPtrTy = dyn_cast<PointerType>(StrippedPtr->getType());
1218
1219   // We do not handle pointer-vector geps here.
1220   if (!StrippedPtrTy)
1221     return 0;
1222
1223   if (StrippedPtr != PtrOp) {
1224     bool HasZeroPointerIndex = false;
1225     if (ConstantInt *C = dyn_cast<ConstantInt>(GEP.getOperand(1)))
1226       HasZeroPointerIndex = C->isZero();
1227
1228     // Transform: GEP (bitcast [10 x i8]* X to [0 x i8]*), i32 0, ...
1229     // into     : GEP [10 x i8]* X, i32 0, ...
1230     //
1231     // Likewise, transform: GEP (bitcast i8* X to [0 x i8]*), i32 0, ...
1232     //           into     : GEP i8* X, ...
1233     //
1234     // This occurs when the program declares an array extern like "int X[];"
1235     if (HasZeroPointerIndex) {
1236       PointerType *CPTy = cast<PointerType>(PtrOp->getType());
1237       if (ArrayType *CATy =
1238           dyn_cast<ArrayType>(CPTy->getElementType())) {
1239         // GEP (bitcast i8* X to [0 x i8]*), i32 0, ... ?
1240         if (CATy->getElementType() == StrippedPtrTy->getElementType()) {
1241           // -> GEP i8* X, ...
1242           SmallVector<Value*, 8> Idx(GEP.idx_begin()+1, GEP.idx_end());
1243           GetElementPtrInst *Res =
1244             GetElementPtrInst::Create(StrippedPtr, Idx, GEP.getName());
1245           Res->setIsInBounds(GEP.isInBounds());
1246           return Res;
1247         }
1248
1249         if (ArrayType *XATy =
1250               dyn_cast<ArrayType>(StrippedPtrTy->getElementType())){
1251           // GEP (bitcast [10 x i8]* X to [0 x i8]*), i32 0, ... ?
1252           if (CATy->getElementType() == XATy->getElementType()) {
1253             // -> GEP [10 x i8]* X, i32 0, ...
1254             // At this point, we know that the cast source type is a pointer
1255             // to an array of the same type as the destination pointer
1256             // array.  Because the array type is never stepped over (there
1257             // is a leading zero) we can fold the cast into this GEP.
1258             GEP.setOperand(0, StrippedPtr);
1259             return &GEP;
1260           }
1261         }
1262       }
1263     } else if (GEP.getNumOperands() == 2) {
1264       // Transform things like:
1265       // %t = getelementptr i32* bitcast ([2 x i32]* %str to i32*), i32 %V
1266       // into:  %t1 = getelementptr [2 x i32]* %str, i32 0, i32 %V; bitcast
1267       Type *SrcElTy = StrippedPtrTy->getElementType();
1268       Type *ResElTy = PtrOp->getType()->getPointerElementType();
1269       if (DL && SrcElTy->isArrayTy() &&
1270           DL->getTypeAllocSize(SrcElTy->getArrayElementType()) ==
1271           DL->getTypeAllocSize(ResElTy)) {
1272         Type *IdxType = DL->getIntPtrType(GEP.getType());
1273         Value *Idx[2] = { Constant::getNullValue(IdxType), GEP.getOperand(1) };
1274         Value *NewGEP = GEP.isInBounds() ?
1275           Builder->CreateInBoundsGEP(StrippedPtr, Idx, GEP.getName()) :
1276           Builder->CreateGEP(StrippedPtr, Idx, GEP.getName());
1277
1278         // V and GEP are both pointer types --> BitCast
1279         if (StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace())
1280           return new BitCastInst(NewGEP, GEP.getType());
1281         return new AddrSpaceCastInst(NewGEP, GEP.getType());
1282       }
1283
1284       // Transform things like:
1285       // %V = mul i64 %N, 4
1286       // %t = getelementptr i8* bitcast (i32* %arr to i8*), i32 %V
1287       // into:  %t1 = getelementptr i32* %arr, i32 %N; bitcast
1288       if (DL && ResElTy->isSized() && SrcElTy->isSized()) {
1289         // Check that changing the type amounts to dividing the index by a scale
1290         // factor.
1291         uint64_t ResSize = DL->getTypeAllocSize(ResElTy);
1292         uint64_t SrcSize = DL->getTypeAllocSize(SrcElTy);
1293         if (ResSize && SrcSize % ResSize == 0) {
1294           Value *Idx = GEP.getOperand(1);
1295           unsigned BitWidth = Idx->getType()->getPrimitiveSizeInBits();
1296           uint64_t Scale = SrcSize / ResSize;
1297
1298           // Earlier transforms ensure that the index has type IntPtrType, which
1299           // considerably simplifies the logic by eliminating implicit casts.
1300           assert(Idx->getType() == DL->getIntPtrType(GEP.getType()) &&
1301                  "Index not cast to pointer width?");
1302
1303           bool NSW;
1304           if (Value *NewIdx = Descale(Idx, APInt(BitWidth, Scale), NSW)) {
1305             // Successfully decomposed Idx as NewIdx * Scale, form a new GEP.
1306             // If the multiplication NewIdx * Scale may overflow then the new
1307             // GEP may not be "inbounds".
1308             Value *NewGEP = GEP.isInBounds() && NSW ?
1309               Builder->CreateInBoundsGEP(StrippedPtr, NewIdx, GEP.getName()) :
1310               Builder->CreateGEP(StrippedPtr, NewIdx, GEP.getName());
1311
1312             // The NewGEP must be pointer typed, so must the old one -> BitCast
1313             if (StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace())
1314               return new BitCastInst(NewGEP, GEP.getType());
1315             return new AddrSpaceCastInst(NewGEP, GEP.getType());
1316           }
1317         }
1318       }
1319
1320       // Similarly, transform things like:
1321       // getelementptr i8* bitcast ([100 x double]* X to i8*), i32 %tmp
1322       //   (where tmp = 8*tmp2) into:
1323       // getelementptr [100 x double]* %arr, i32 0, i32 %tmp2; bitcast
1324       if (DL && ResElTy->isSized() && SrcElTy->isSized() &&
1325           SrcElTy->isArrayTy()) {
1326         // Check that changing to the array element type amounts to dividing the
1327         // index by a scale factor.
1328         uint64_t ResSize = DL->getTypeAllocSize(ResElTy);
1329         uint64_t ArrayEltSize
1330           = DL->getTypeAllocSize(SrcElTy->getArrayElementType());
1331         if (ResSize && ArrayEltSize % ResSize == 0) {
1332           Value *Idx = GEP.getOperand(1);
1333           unsigned BitWidth = Idx->getType()->getPrimitiveSizeInBits();
1334           uint64_t Scale = ArrayEltSize / ResSize;
1335
1336           // Earlier transforms ensure that the index has type IntPtrType, which
1337           // considerably simplifies the logic by eliminating implicit casts.
1338           assert(Idx->getType() == DL->getIntPtrType(GEP.getType()) &&
1339                  "Index not cast to pointer width?");
1340
1341           bool NSW;
1342           if (Value *NewIdx = Descale(Idx, APInt(BitWidth, Scale), NSW)) {
1343             // Successfully decomposed Idx as NewIdx * Scale, form a new GEP.
1344             // If the multiplication NewIdx * Scale may overflow then the new
1345             // GEP may not be "inbounds".
1346             Value *Off[2] = {
1347               Constant::getNullValue(DL->getIntPtrType(GEP.getType())),
1348               NewIdx
1349             };
1350
1351             Value *NewGEP = GEP.isInBounds() && NSW ?
1352               Builder->CreateInBoundsGEP(StrippedPtr, Off, GEP.getName()) :
1353               Builder->CreateGEP(StrippedPtr, Off, GEP.getName());
1354             // The NewGEP must be pointer typed, so must the old one -> BitCast
1355             if (StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace())
1356               return new BitCastInst(NewGEP, GEP.getType());
1357             return new AddrSpaceCastInst(NewGEP, GEP.getType());
1358           }
1359         }
1360       }
1361     }
1362   }
1363
1364   if (!DL)
1365     return 0;
1366
1367   /// See if we can simplify:
1368   ///   X = bitcast A* to B*
1369   ///   Y = gep X, <...constant indices...>
1370   /// into a gep of the original struct.  This is important for SROA and alias
1371   /// analysis of unions.  If "A" is also a bitcast, wait for A/X to be merged.
1372   if (BitCastInst *BCI = dyn_cast<BitCastInst>(PtrOp)) {
1373     Value *Operand = BCI->getOperand(0);
1374     PointerType *OpType = cast<PointerType>(Operand->getType());
1375     unsigned OffsetBits = DL->getPointerTypeSizeInBits(OpType);
1376     APInt Offset(OffsetBits, 0);
1377     if (!isa<BitCastInst>(Operand) &&
1378         GEP.accumulateConstantOffset(*DL, Offset) &&
1379         StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace()) {
1380
1381       // If this GEP instruction doesn't move the pointer, just replace the GEP
1382       // with a bitcast of the real input to the dest type.
1383       if (!Offset) {
1384         // If the bitcast is of an allocation, and the allocation will be
1385         // converted to match the type of the cast, don't touch this.
1386         if (isa<AllocaInst>(Operand) || isAllocationFn(Operand, TLI)) {
1387           // See if the bitcast simplifies, if so, don't nuke this GEP yet.
1388           if (Instruction *I = visitBitCast(*BCI)) {
1389             if (I != BCI) {
1390               I->takeName(BCI);
1391               BCI->getParent()->getInstList().insert(BCI, I);
1392               ReplaceInstUsesWith(*BCI, I);
1393             }
1394             return &GEP;
1395           }
1396         }
1397         return new BitCastInst(Operand, GEP.getType());
1398       }
1399
1400       // Otherwise, if the offset is non-zero, we need to find out if there is a
1401       // field at Offset in 'A's type.  If so, we can pull the cast through the
1402       // GEP.
1403       SmallVector<Value*, 8> NewIndices;
1404       if (FindElementAtOffset(OpType, Offset.getSExtValue(), NewIndices)) {
1405         Value *NGEP = GEP.isInBounds() ?
1406           Builder->CreateInBoundsGEP(Operand, NewIndices) :
1407           Builder->CreateGEP(Operand, NewIndices);
1408
1409         if (NGEP->getType() == GEP.getType())
1410           return ReplaceInstUsesWith(GEP, NGEP);
1411         NGEP->takeName(&GEP);
1412         return new BitCastInst(NGEP, GEP.getType());
1413       }
1414     }
1415   }
1416
1417   return 0;
1418 }
1419
1420 static bool
1421 isAllocSiteRemovable(Instruction *AI, SmallVectorImpl<WeakVH> &Users,
1422                      const TargetLibraryInfo *TLI) {
1423   SmallVector<Instruction*, 4> Worklist;
1424   Worklist.push_back(AI);
1425
1426   do {
1427     Instruction *PI = Worklist.pop_back_val();
1428     for (Value::use_iterator UI = PI->use_begin(), UE = PI->use_end(); UI != UE;
1429          ++UI) {
1430       Instruction *I = cast<Instruction>(*UI);
1431       switch (I->getOpcode()) {
1432       default:
1433         // Give up the moment we see something we can't handle.
1434         return false;
1435
1436       case Instruction::BitCast:
1437       case Instruction::GetElementPtr:
1438         Users.push_back(I);
1439         Worklist.push_back(I);
1440         continue;
1441
1442       case Instruction::ICmp: {
1443         ICmpInst *ICI = cast<ICmpInst>(I);
1444         // We can fold eq/ne comparisons with null to false/true, respectively.
1445         if (!ICI->isEquality() || !isa<ConstantPointerNull>(ICI->getOperand(1)))
1446           return false;
1447         Users.push_back(I);
1448         continue;
1449       }
1450
1451       case Instruction::Call:
1452         // Ignore no-op and store intrinsics.
1453         if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
1454           switch (II->getIntrinsicID()) {
1455           default:
1456             return false;
1457
1458           case Intrinsic::memmove:
1459           case Intrinsic::memcpy:
1460           case Intrinsic::memset: {
1461             MemIntrinsic *MI = cast<MemIntrinsic>(II);
1462             if (MI->isVolatile() || MI->getRawDest() != PI)
1463               return false;
1464           }
1465           // fall through
1466           case Intrinsic::dbg_declare:
1467           case Intrinsic::dbg_value:
1468           case Intrinsic::invariant_start:
1469           case Intrinsic::invariant_end:
1470           case Intrinsic::lifetime_start:
1471           case Intrinsic::lifetime_end:
1472           case Intrinsic::objectsize:
1473             Users.push_back(I);
1474             continue;
1475           }
1476         }
1477
1478         if (isFreeCall(I, TLI)) {
1479           Users.push_back(I);
1480           continue;
1481         }
1482         return false;
1483
1484       case Instruction::Store: {
1485         StoreInst *SI = cast<StoreInst>(I);
1486         if (SI->isVolatile() || SI->getPointerOperand() != PI)
1487           return false;
1488         Users.push_back(I);
1489         continue;
1490       }
1491       }
1492       llvm_unreachable("missing a return?");
1493     }
1494   } while (!Worklist.empty());
1495   return true;
1496 }
1497
1498 Instruction *InstCombiner::visitAllocSite(Instruction &MI) {
1499   // If we have a malloc call which is only used in any amount of comparisons
1500   // to null and free calls, delete the calls and replace the comparisons with
1501   // true or false as appropriate.
1502   SmallVector<WeakVH, 64> Users;
1503   if (isAllocSiteRemovable(&MI, Users, TLI)) {
1504     for (unsigned i = 0, e = Users.size(); i != e; ++i) {
1505       Instruction *I = cast_or_null<Instruction>(&*Users[i]);
1506       if (!I) continue;
1507
1508       if (ICmpInst *C = dyn_cast<ICmpInst>(I)) {
1509         ReplaceInstUsesWith(*C,
1510                             ConstantInt::get(Type::getInt1Ty(C->getContext()),
1511                                              C->isFalseWhenEqual()));
1512       } else if (isa<BitCastInst>(I) || isa<GetElementPtrInst>(I)) {
1513         ReplaceInstUsesWith(*I, UndefValue::get(I->getType()));
1514       } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
1515         if (II->getIntrinsicID() == Intrinsic::objectsize) {
1516           ConstantInt *CI = cast<ConstantInt>(II->getArgOperand(1));
1517           uint64_t DontKnow = CI->isZero() ? -1ULL : 0;
1518           ReplaceInstUsesWith(*I, ConstantInt::get(I->getType(), DontKnow));
1519         }
1520       }
1521       EraseInstFromFunction(*I);
1522     }
1523
1524     if (InvokeInst *II = dyn_cast<InvokeInst>(&MI)) {
1525       // Replace invoke with a NOP intrinsic to maintain the original CFG
1526       Module *M = II->getParent()->getParent()->getParent();
1527       Function *F = Intrinsic::getDeclaration(M, Intrinsic::donothing);
1528       InvokeInst::Create(F, II->getNormalDest(), II->getUnwindDest(),
1529                          None, "", II->getParent());
1530     }
1531     return EraseInstFromFunction(MI);
1532   }
1533   return 0;
1534 }
1535
1536 /// \brief Move the call to free before a NULL test.
1537 ///
1538 /// Check if this free is accessed after its argument has been test
1539 /// against NULL (property 0).
1540 /// If yes, it is legal to move this call in its predecessor block.
1541 ///
1542 /// The move is performed only if the block containing the call to free
1543 /// will be removed, i.e.:
1544 /// 1. it has only one predecessor P, and P has two successors
1545 /// 2. it contains the call and an unconditional branch
1546 /// 3. its successor is the same as its predecessor's successor
1547 ///
1548 /// The profitability is out-of concern here and this function should
1549 /// be called only if the caller knows this transformation would be
1550 /// profitable (e.g., for code size).
1551 static Instruction *
1552 tryToMoveFreeBeforeNullTest(CallInst &FI) {
1553   Value *Op = FI.getArgOperand(0);
1554   BasicBlock *FreeInstrBB = FI.getParent();
1555   BasicBlock *PredBB = FreeInstrBB->getSinglePredecessor();
1556
1557   // Validate part of constraint #1: Only one predecessor
1558   // FIXME: We can extend the number of predecessor, but in that case, we
1559   //        would duplicate the call to free in each predecessor and it may
1560   //        not be profitable even for code size.
1561   if (!PredBB)
1562     return 0;
1563
1564   // Validate constraint #2: Does this block contains only the call to
1565   //                         free and an unconditional branch?
1566   // FIXME: We could check if we can speculate everything in the
1567   //        predecessor block
1568   if (FreeInstrBB->size() != 2)
1569     return 0;
1570   BasicBlock *SuccBB;
1571   if (!match(FreeInstrBB->getTerminator(), m_UnconditionalBr(SuccBB)))
1572     return 0;
1573
1574   // Validate the rest of constraint #1 by matching on the pred branch.
1575   TerminatorInst *TI = PredBB->getTerminator();
1576   BasicBlock *TrueBB, *FalseBB;
1577   ICmpInst::Predicate Pred;
1578   if (!match(TI, m_Br(m_ICmp(Pred, m_Specific(Op), m_Zero()), TrueBB, FalseBB)))
1579     return 0;
1580   if (Pred != ICmpInst::ICMP_EQ && Pred != ICmpInst::ICMP_NE)
1581     return 0;
1582
1583   // Validate constraint #3: Ensure the null case just falls through.
1584   if (SuccBB != (Pred == ICmpInst::ICMP_EQ ? TrueBB : FalseBB))
1585     return 0;
1586   assert(FreeInstrBB == (Pred == ICmpInst::ICMP_EQ ? FalseBB : TrueBB) &&
1587          "Broken CFG: missing edge from predecessor to successor");
1588
1589   FI.moveBefore(TI);
1590   return &FI;
1591 }
1592
1593
1594 Instruction *InstCombiner::visitFree(CallInst &FI) {
1595   Value *Op = FI.getArgOperand(0);
1596
1597   // free undef -> unreachable.
1598   if (isa<UndefValue>(Op)) {
1599     // Insert a new store to null because we cannot modify the CFG here.
1600     Builder->CreateStore(ConstantInt::getTrue(FI.getContext()),
1601                          UndefValue::get(Type::getInt1PtrTy(FI.getContext())));
1602     return EraseInstFromFunction(FI);
1603   }
1604
1605   // If we have 'free null' delete the instruction.  This can happen in stl code
1606   // when lots of inlining happens.
1607   if (isa<ConstantPointerNull>(Op))
1608     return EraseInstFromFunction(FI);
1609
1610   // If we optimize for code size, try to move the call to free before the null
1611   // test so that simplify cfg can remove the empty block and dead code
1612   // elimination the branch. I.e., helps to turn something like:
1613   // if (foo) free(foo);
1614   // into
1615   // free(foo);
1616   if (MinimizeSize)
1617     if (Instruction *I = tryToMoveFreeBeforeNullTest(FI))
1618       return I;
1619
1620   return 0;
1621 }
1622
1623
1624
1625 Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
1626   // Change br (not X), label True, label False to: br X, label False, True
1627   Value *X = 0;
1628   BasicBlock *TrueDest;
1629   BasicBlock *FalseDest;
1630   if (match(&BI, m_Br(m_Not(m_Value(X)), TrueDest, FalseDest)) &&
1631       !isa<Constant>(X)) {
1632     // Swap Destinations and condition...
1633     BI.setCondition(X);
1634     BI.swapSuccessors();
1635     return &BI;
1636   }
1637
1638   // Canonicalize fcmp_one -> fcmp_oeq
1639   FCmpInst::Predicate FPred; Value *Y;
1640   if (match(&BI, m_Br(m_FCmp(FPred, m_Value(X), m_Value(Y)),
1641                              TrueDest, FalseDest)) &&
1642       BI.getCondition()->hasOneUse())
1643     if (FPred == FCmpInst::FCMP_ONE || FPred == FCmpInst::FCMP_OLE ||
1644         FPred == FCmpInst::FCMP_OGE) {
1645       FCmpInst *Cond = cast<FCmpInst>(BI.getCondition());
1646       Cond->setPredicate(FCmpInst::getInversePredicate(FPred));
1647
1648       // Swap Destinations and condition.
1649       BI.swapSuccessors();
1650       Worklist.Add(Cond);
1651       return &BI;
1652     }
1653
1654   // Canonicalize icmp_ne -> icmp_eq
1655   ICmpInst::Predicate IPred;
1656   if (match(&BI, m_Br(m_ICmp(IPred, m_Value(X), m_Value(Y)),
1657                       TrueDest, FalseDest)) &&
1658       BI.getCondition()->hasOneUse())
1659     if (IPred == ICmpInst::ICMP_NE  || IPred == ICmpInst::ICMP_ULE ||
1660         IPred == ICmpInst::ICMP_SLE || IPred == ICmpInst::ICMP_UGE ||
1661         IPred == ICmpInst::ICMP_SGE) {
1662       ICmpInst *Cond = cast<ICmpInst>(BI.getCondition());
1663       Cond->setPredicate(ICmpInst::getInversePredicate(IPred));
1664       // Swap Destinations and condition.
1665       BI.swapSuccessors();
1666       Worklist.Add(Cond);
1667       return &BI;
1668     }
1669
1670   return 0;
1671 }
1672
1673 Instruction *InstCombiner::visitSwitchInst(SwitchInst &SI) {
1674   Value *Cond = SI.getCondition();
1675   if (Instruction *I = dyn_cast<Instruction>(Cond)) {
1676     if (I->getOpcode() == Instruction::Add)
1677       if (ConstantInt *AddRHS = dyn_cast<ConstantInt>(I->getOperand(1))) {
1678         // change 'switch (X+4) case 1:' into 'switch (X) case -3'
1679         // Skip the first item since that's the default case.
1680         for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end();
1681              i != e; ++i) {
1682           ConstantInt* CaseVal = i.getCaseValue();
1683           Constant* NewCaseVal = ConstantExpr::getSub(cast<Constant>(CaseVal),
1684                                                       AddRHS);
1685           assert(isa<ConstantInt>(NewCaseVal) &&
1686                  "Result of expression should be constant");
1687           i.setValue(cast<ConstantInt>(NewCaseVal));
1688         }
1689         SI.setCondition(I->getOperand(0));
1690         Worklist.Add(I);
1691         return &SI;
1692       }
1693   }
1694   return 0;
1695 }
1696
1697 Instruction *InstCombiner::visitExtractValueInst(ExtractValueInst &EV) {
1698   Value *Agg = EV.getAggregateOperand();
1699
1700   if (!EV.hasIndices())
1701     return ReplaceInstUsesWith(EV, Agg);
1702
1703   if (Constant *C = dyn_cast<Constant>(Agg)) {
1704     if (Constant *C2 = C->getAggregateElement(*EV.idx_begin())) {
1705       if (EV.getNumIndices() == 0)
1706         return ReplaceInstUsesWith(EV, C2);
1707       // Extract the remaining indices out of the constant indexed by the
1708       // first index
1709       return ExtractValueInst::Create(C2, EV.getIndices().slice(1));
1710     }
1711     return 0; // Can't handle other constants
1712   }
1713
1714   if (InsertValueInst *IV = dyn_cast<InsertValueInst>(Agg)) {
1715     // We're extracting from an insertvalue instruction, compare the indices
1716     const unsigned *exti, *exte, *insi, *inse;
1717     for (exti = EV.idx_begin(), insi = IV->idx_begin(),
1718          exte = EV.idx_end(), inse = IV->idx_end();
1719          exti != exte && insi != inse;
1720          ++exti, ++insi) {
1721       if (*insi != *exti)
1722         // The insert and extract both reference distinctly different elements.
1723         // This means the extract is not influenced by the insert, and we can
1724         // replace the aggregate operand of the extract with the aggregate
1725         // operand of the insert. i.e., replace
1726         // %I = insertvalue { i32, { i32 } } %A, { i32 } { i32 42 }, 1
1727         // %E = extractvalue { i32, { i32 } } %I, 0
1728         // with
1729         // %E = extractvalue { i32, { i32 } } %A, 0
1730         return ExtractValueInst::Create(IV->getAggregateOperand(),
1731                                         EV.getIndices());
1732     }
1733     if (exti == exte && insi == inse)
1734       // Both iterators are at the end: Index lists are identical. Replace
1735       // %B = insertvalue { i32, { i32 } } %A, i32 42, 1, 0
1736       // %C = extractvalue { i32, { i32 } } %B, 1, 0
1737       // with "i32 42"
1738       return ReplaceInstUsesWith(EV, IV->getInsertedValueOperand());
1739     if (exti == exte) {
1740       // The extract list is a prefix of the insert list. i.e. replace
1741       // %I = insertvalue { i32, { i32 } } %A, i32 42, 1, 0
1742       // %E = extractvalue { i32, { i32 } } %I, 1
1743       // with
1744       // %X = extractvalue { i32, { i32 } } %A, 1
1745       // %E = insertvalue { i32 } %X, i32 42, 0
1746       // by switching the order of the insert and extract (though the
1747       // insertvalue should be left in, since it may have other uses).
1748       Value *NewEV = Builder->CreateExtractValue(IV->getAggregateOperand(),
1749                                                  EV.getIndices());
1750       return InsertValueInst::Create(NewEV, IV->getInsertedValueOperand(),
1751                                      makeArrayRef(insi, inse));
1752     }
1753     if (insi == inse)
1754       // The insert list is a prefix of the extract list
1755       // We can simply remove the common indices from the extract and make it
1756       // operate on the inserted value instead of the insertvalue result.
1757       // i.e., replace
1758       // %I = insertvalue { i32, { i32 } } %A, { i32 } { i32 42 }, 1
1759       // %E = extractvalue { i32, { i32 } } %I, 1, 0
1760       // with
1761       // %E extractvalue { i32 } { i32 42 }, 0
1762       return ExtractValueInst::Create(IV->getInsertedValueOperand(),
1763                                       makeArrayRef(exti, exte));
1764   }
1765   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Agg)) {
1766     // We're extracting from an intrinsic, see if we're the only user, which
1767     // allows us to simplify multiple result intrinsics to simpler things that
1768     // just get one value.
1769     if (II->hasOneUse()) {
1770       // Check if we're grabbing the overflow bit or the result of a 'with
1771       // overflow' intrinsic.  If it's the latter we can remove the intrinsic
1772       // and replace it with a traditional binary instruction.
1773       switch (II->getIntrinsicID()) {
1774       case Intrinsic::uadd_with_overflow:
1775       case Intrinsic::sadd_with_overflow:
1776         if (*EV.idx_begin() == 0) {  // Normal result.
1777           Value *LHS = II->getArgOperand(0), *RHS = II->getArgOperand(1);
1778           ReplaceInstUsesWith(*II, UndefValue::get(II->getType()));
1779           EraseInstFromFunction(*II);
1780           return BinaryOperator::CreateAdd(LHS, RHS);
1781         }
1782
1783         // If the normal result of the add is dead, and the RHS is a constant,
1784         // we can transform this into a range comparison.
1785         // overflow = uadd a, -4  -->  overflow = icmp ugt a, 3
1786         if (II->getIntrinsicID() == Intrinsic::uadd_with_overflow)
1787           if (ConstantInt *CI = dyn_cast<ConstantInt>(II->getArgOperand(1)))
1788             return new ICmpInst(ICmpInst::ICMP_UGT, II->getArgOperand(0),
1789                                 ConstantExpr::getNot(CI));
1790         break;
1791       case Intrinsic::usub_with_overflow:
1792       case Intrinsic::ssub_with_overflow:
1793         if (*EV.idx_begin() == 0) {  // Normal result.
1794           Value *LHS = II->getArgOperand(0), *RHS = II->getArgOperand(1);
1795           ReplaceInstUsesWith(*II, UndefValue::get(II->getType()));
1796           EraseInstFromFunction(*II);
1797           return BinaryOperator::CreateSub(LHS, RHS);
1798         }
1799         break;
1800       case Intrinsic::umul_with_overflow:
1801       case Intrinsic::smul_with_overflow:
1802         if (*EV.idx_begin() == 0) {  // Normal result.
1803           Value *LHS = II->getArgOperand(0), *RHS = II->getArgOperand(1);
1804           ReplaceInstUsesWith(*II, UndefValue::get(II->getType()));
1805           EraseInstFromFunction(*II);
1806           return BinaryOperator::CreateMul(LHS, RHS);
1807         }
1808         break;
1809       default:
1810         break;
1811       }
1812     }
1813   }
1814   if (LoadInst *L = dyn_cast<LoadInst>(Agg))
1815     // If the (non-volatile) load only has one use, we can rewrite this to a
1816     // load from a GEP. This reduces the size of the load.
1817     // FIXME: If a load is used only by extractvalue instructions then this
1818     //        could be done regardless of having multiple uses.
1819     if (L->isSimple() && L->hasOneUse()) {
1820       // extractvalue has integer indices, getelementptr has Value*s. Convert.
1821       SmallVector<Value*, 4> Indices;
1822       // Prefix an i32 0 since we need the first element.
1823       Indices.push_back(Builder->getInt32(0));
1824       for (ExtractValueInst::idx_iterator I = EV.idx_begin(), E = EV.idx_end();
1825             I != E; ++I)
1826         Indices.push_back(Builder->getInt32(*I));
1827
1828       // We need to insert these at the location of the old load, not at that of
1829       // the extractvalue.
1830       Builder->SetInsertPoint(L->getParent(), L);
1831       Value *GEP = Builder->CreateInBoundsGEP(L->getPointerOperand(), Indices);
1832       // Returning the load directly will cause the main loop to insert it in
1833       // the wrong spot, so use ReplaceInstUsesWith().
1834       return ReplaceInstUsesWith(EV, Builder->CreateLoad(GEP));
1835     }
1836   // We could simplify extracts from other values. Note that nested extracts may
1837   // already be simplified implicitly by the above: extract (extract (insert) )
1838   // will be translated into extract ( insert ( extract ) ) first and then just
1839   // the value inserted, if appropriate. Similarly for extracts from single-use
1840   // loads: extract (extract (load)) will be translated to extract (load (gep))
1841   // and if again single-use then via load (gep (gep)) to load (gep).
1842   // However, double extracts from e.g. function arguments or return values
1843   // aren't handled yet.
1844   return 0;
1845 }
1846
1847 enum Personality_Type {
1848   Unknown_Personality,
1849   GNU_Ada_Personality,
1850   GNU_CXX_Personality,
1851   GNU_ObjC_Personality
1852 };
1853
1854 /// RecognizePersonality - See if the given exception handling personality
1855 /// function is one that we understand.  If so, return a description of it;
1856 /// otherwise return Unknown_Personality.
1857 static Personality_Type RecognizePersonality(Value *Pers) {
1858   Function *F = dyn_cast<Function>(Pers->stripPointerCasts());
1859   if (!F)
1860     return Unknown_Personality;
1861   return StringSwitch<Personality_Type>(F->getName())
1862     .Case("__gnat_eh_personality", GNU_Ada_Personality)
1863     .Case("__gxx_personality_v0",  GNU_CXX_Personality)
1864     .Case("__objc_personality_v0", GNU_ObjC_Personality)
1865     .Default(Unknown_Personality);
1866 }
1867
1868 /// isCatchAll - Return 'true' if the given typeinfo will match anything.
1869 static bool isCatchAll(Personality_Type Personality, Constant *TypeInfo) {
1870   switch (Personality) {
1871   case Unknown_Personality:
1872     return false;
1873   case GNU_Ada_Personality:
1874     // While __gnat_all_others_value will match any Ada exception, it doesn't
1875     // match foreign exceptions (or didn't, before gcc-4.7).
1876     return false;
1877   case GNU_CXX_Personality:
1878   case GNU_ObjC_Personality:
1879     return TypeInfo->isNullValue();
1880   }
1881   llvm_unreachable("Unknown personality!");
1882 }
1883
1884 static bool shorter_filter(const Value *LHS, const Value *RHS) {
1885   return
1886     cast<ArrayType>(LHS->getType())->getNumElements()
1887   <
1888     cast<ArrayType>(RHS->getType())->getNumElements();
1889 }
1890
1891 Instruction *InstCombiner::visitLandingPadInst(LandingPadInst &LI) {
1892   // The logic here should be correct for any real-world personality function.
1893   // However if that turns out not to be true, the offending logic can always
1894   // be conditioned on the personality function, like the catch-all logic is.
1895   Personality_Type Personality = RecognizePersonality(LI.getPersonalityFn());
1896
1897   // Simplify the list of clauses, eg by removing repeated catch clauses
1898   // (these are often created by inlining).
1899   bool MakeNewInstruction = false; // If true, recreate using the following:
1900   SmallVector<Value *, 16> NewClauses; // - Clauses for the new instruction;
1901   bool CleanupFlag = LI.isCleanup();   // - The new instruction is a cleanup.
1902
1903   SmallPtrSet<Value *, 16> AlreadyCaught; // Typeinfos known caught already.
1904   for (unsigned i = 0, e = LI.getNumClauses(); i != e; ++i) {
1905     bool isLastClause = i + 1 == e;
1906     if (LI.isCatch(i)) {
1907       // A catch clause.
1908       Value *CatchClause = LI.getClause(i);
1909       Constant *TypeInfo = cast<Constant>(CatchClause->stripPointerCasts());
1910
1911       // If we already saw this clause, there is no point in having a second
1912       // copy of it.
1913       if (AlreadyCaught.insert(TypeInfo)) {
1914         // This catch clause was not already seen.
1915         NewClauses.push_back(CatchClause);
1916       } else {
1917         // Repeated catch clause - drop the redundant copy.
1918         MakeNewInstruction = true;
1919       }
1920
1921       // If this is a catch-all then there is no point in keeping any following
1922       // clauses or marking the landingpad as having a cleanup.
1923       if (isCatchAll(Personality, TypeInfo)) {
1924         if (!isLastClause)
1925           MakeNewInstruction = true;
1926         CleanupFlag = false;
1927         break;
1928       }
1929     } else {
1930       // A filter clause.  If any of the filter elements were already caught
1931       // then they can be dropped from the filter.  It is tempting to try to
1932       // exploit the filter further by saying that any typeinfo that does not
1933       // occur in the filter can't be caught later (and thus can be dropped).
1934       // However this would be wrong, since typeinfos can match without being
1935       // equal (for example if one represents a C++ class, and the other some
1936       // class derived from it).
1937       assert(LI.isFilter(i) && "Unsupported landingpad clause!");
1938       Value *FilterClause = LI.getClause(i);
1939       ArrayType *FilterType = cast<ArrayType>(FilterClause->getType());
1940       unsigned NumTypeInfos = FilterType->getNumElements();
1941
1942       // An empty filter catches everything, so there is no point in keeping any
1943       // following clauses or marking the landingpad as having a cleanup.  By
1944       // dealing with this case here the following code is made a bit simpler.
1945       if (!NumTypeInfos) {
1946         NewClauses.push_back(FilterClause);
1947         if (!isLastClause)
1948           MakeNewInstruction = true;
1949         CleanupFlag = false;
1950         break;
1951       }
1952
1953       bool MakeNewFilter = false; // If true, make a new filter.
1954       SmallVector<Constant *, 16> NewFilterElts; // New elements.
1955       if (isa<ConstantAggregateZero>(FilterClause)) {
1956         // Not an empty filter - it contains at least one null typeinfo.
1957         assert(NumTypeInfos > 0 && "Should have handled empty filter already!");
1958         Constant *TypeInfo =
1959           Constant::getNullValue(FilterType->getElementType());
1960         // If this typeinfo is a catch-all then the filter can never match.
1961         if (isCatchAll(Personality, TypeInfo)) {
1962           // Throw the filter away.
1963           MakeNewInstruction = true;
1964           continue;
1965         }
1966
1967         // There is no point in having multiple copies of this typeinfo, so
1968         // discard all but the first copy if there is more than one.
1969         NewFilterElts.push_back(TypeInfo);
1970         if (NumTypeInfos > 1)
1971           MakeNewFilter = true;
1972       } else {
1973         ConstantArray *Filter = cast<ConstantArray>(FilterClause);
1974         SmallPtrSet<Value *, 16> SeenInFilter; // For uniquing the elements.
1975         NewFilterElts.reserve(NumTypeInfos);
1976
1977         // Remove any filter elements that were already caught or that already
1978         // occurred in the filter.  While there, see if any of the elements are
1979         // catch-alls.  If so, the filter can be discarded.
1980         bool SawCatchAll = false;
1981         for (unsigned j = 0; j != NumTypeInfos; ++j) {
1982           Value *Elt = Filter->getOperand(j);
1983           Constant *TypeInfo = cast<Constant>(Elt->stripPointerCasts());
1984           if (isCatchAll(Personality, TypeInfo)) {
1985             // This element is a catch-all.  Bail out, noting this fact.
1986             SawCatchAll = true;
1987             break;
1988           }
1989           if (AlreadyCaught.count(TypeInfo))
1990             // Already caught by an earlier clause, so having it in the filter
1991             // is pointless.
1992             continue;
1993           // There is no point in having multiple copies of the same typeinfo in
1994           // a filter, so only add it if we didn't already.
1995           if (SeenInFilter.insert(TypeInfo))
1996             NewFilterElts.push_back(cast<Constant>(Elt));
1997         }
1998         // A filter containing a catch-all cannot match anything by definition.
1999         if (SawCatchAll) {
2000           // Throw the filter away.
2001           MakeNewInstruction = true;
2002           continue;
2003         }
2004
2005         // If we dropped something from the filter, make a new one.
2006         if (NewFilterElts.size() < NumTypeInfos)
2007           MakeNewFilter = true;
2008       }
2009       if (MakeNewFilter) {
2010         FilterType = ArrayType::get(FilterType->getElementType(),
2011                                     NewFilterElts.size());
2012         FilterClause = ConstantArray::get(FilterType, NewFilterElts);
2013         MakeNewInstruction = true;
2014       }
2015
2016       NewClauses.push_back(FilterClause);
2017
2018       // If the new filter is empty then it will catch everything so there is
2019       // no point in keeping any following clauses or marking the landingpad
2020       // as having a cleanup.  The case of the original filter being empty was
2021       // already handled above.
2022       if (MakeNewFilter && !NewFilterElts.size()) {
2023         assert(MakeNewInstruction && "New filter but not a new instruction!");
2024         CleanupFlag = false;
2025         break;
2026       }
2027     }
2028   }
2029
2030   // If several filters occur in a row then reorder them so that the shortest
2031   // filters come first (those with the smallest number of elements).  This is
2032   // advantageous because shorter filters are more likely to match, speeding up
2033   // unwinding, but mostly because it increases the effectiveness of the other
2034   // filter optimizations below.
2035   for (unsigned i = 0, e = NewClauses.size(); i + 1 < e; ) {
2036     unsigned j;
2037     // Find the maximal 'j' s.t. the range [i, j) consists entirely of filters.
2038     for (j = i; j != e; ++j)
2039       if (!isa<ArrayType>(NewClauses[j]->getType()))
2040         break;
2041
2042     // Check whether the filters are already sorted by length.  We need to know
2043     // if sorting them is actually going to do anything so that we only make a
2044     // new landingpad instruction if it does.
2045     for (unsigned k = i; k + 1 < j; ++k)
2046       if (shorter_filter(NewClauses[k+1], NewClauses[k])) {
2047         // Not sorted, so sort the filters now.  Doing an unstable sort would be
2048         // correct too but reordering filters pointlessly might confuse users.
2049         std::stable_sort(NewClauses.begin() + i, NewClauses.begin() + j,
2050                          shorter_filter);
2051         MakeNewInstruction = true;
2052         break;
2053       }
2054
2055     // Look for the next batch of filters.
2056     i = j + 1;
2057   }
2058
2059   // If typeinfos matched if and only if equal, then the elements of a filter L
2060   // that occurs later than a filter F could be replaced by the intersection of
2061   // the elements of F and L.  In reality two typeinfos can match without being
2062   // equal (for example if one represents a C++ class, and the other some class
2063   // derived from it) so it would be wrong to perform this transform in general.
2064   // However the transform is correct and useful if F is a subset of L.  In that
2065   // case L can be replaced by F, and thus removed altogether since repeating a
2066   // filter is pointless.  So here we look at all pairs of filters F and L where
2067   // L follows F in the list of clauses, and remove L if every element of F is
2068   // an element of L.  This can occur when inlining C++ functions with exception
2069   // specifications.
2070   for (unsigned i = 0; i + 1 < NewClauses.size(); ++i) {
2071     // Examine each filter in turn.
2072     Value *Filter = NewClauses[i];
2073     ArrayType *FTy = dyn_cast<ArrayType>(Filter->getType());
2074     if (!FTy)
2075       // Not a filter - skip it.
2076       continue;
2077     unsigned FElts = FTy->getNumElements();
2078     // Examine each filter following this one.  Doing this backwards means that
2079     // we don't have to worry about filters disappearing under us when removed.
2080     for (unsigned j = NewClauses.size() - 1; j != i; --j) {
2081       Value *LFilter = NewClauses[j];
2082       ArrayType *LTy = dyn_cast<ArrayType>(LFilter->getType());
2083       if (!LTy)
2084         // Not a filter - skip it.
2085         continue;
2086       // If Filter is a subset of LFilter, i.e. every element of Filter is also
2087       // an element of LFilter, then discard LFilter.
2088       SmallVectorImpl<Value *>::iterator J = NewClauses.begin() + j;
2089       // If Filter is empty then it is a subset of LFilter.
2090       if (!FElts) {
2091         // Discard LFilter.
2092         NewClauses.erase(J);
2093         MakeNewInstruction = true;
2094         // Move on to the next filter.
2095         continue;
2096       }
2097       unsigned LElts = LTy->getNumElements();
2098       // If Filter is longer than LFilter then it cannot be a subset of it.
2099       if (FElts > LElts)
2100         // Move on to the next filter.
2101         continue;
2102       // At this point we know that LFilter has at least one element.
2103       if (isa<ConstantAggregateZero>(LFilter)) { // LFilter only contains zeros.
2104         // Filter is a subset of LFilter iff Filter contains only zeros (as we
2105         // already know that Filter is not longer than LFilter).
2106         if (isa<ConstantAggregateZero>(Filter)) {
2107           assert(FElts <= LElts && "Should have handled this case earlier!");
2108           // Discard LFilter.
2109           NewClauses.erase(J);
2110           MakeNewInstruction = true;
2111         }
2112         // Move on to the next filter.
2113         continue;
2114       }
2115       ConstantArray *LArray = cast<ConstantArray>(LFilter);
2116       if (isa<ConstantAggregateZero>(Filter)) { // Filter only contains zeros.
2117         // Since Filter is non-empty and contains only zeros, it is a subset of
2118         // LFilter iff LFilter contains a zero.
2119         assert(FElts > 0 && "Should have eliminated the empty filter earlier!");
2120         for (unsigned l = 0; l != LElts; ++l)
2121           if (LArray->getOperand(l)->isNullValue()) {
2122             // LFilter contains a zero - discard it.
2123             NewClauses.erase(J);
2124             MakeNewInstruction = true;
2125             break;
2126           }
2127         // Move on to the next filter.
2128         continue;
2129       }
2130       // At this point we know that both filters are ConstantArrays.  Loop over
2131       // operands to see whether every element of Filter is also an element of
2132       // LFilter.  Since filters tend to be short this is probably faster than
2133       // using a method that scales nicely.
2134       ConstantArray *FArray = cast<ConstantArray>(Filter);
2135       bool AllFound = true;
2136       for (unsigned f = 0; f != FElts; ++f) {
2137         Value *FTypeInfo = FArray->getOperand(f)->stripPointerCasts();
2138         AllFound = false;
2139         for (unsigned l = 0; l != LElts; ++l) {
2140           Value *LTypeInfo = LArray->getOperand(l)->stripPointerCasts();
2141           if (LTypeInfo == FTypeInfo) {
2142             AllFound = true;
2143             break;
2144           }
2145         }
2146         if (!AllFound)
2147           break;
2148       }
2149       if (AllFound) {
2150         // Discard LFilter.
2151         NewClauses.erase(J);
2152         MakeNewInstruction = true;
2153       }
2154       // Move on to the next filter.
2155     }
2156   }
2157
2158   // If we changed any of the clauses, replace the old landingpad instruction
2159   // with a new one.
2160   if (MakeNewInstruction) {
2161     LandingPadInst *NLI = LandingPadInst::Create(LI.getType(),
2162                                                  LI.getPersonalityFn(),
2163                                                  NewClauses.size());
2164     for (unsigned i = 0, e = NewClauses.size(); i != e; ++i)
2165       NLI->addClause(NewClauses[i]);
2166     // A landing pad with no clauses must have the cleanup flag set.  It is
2167     // theoretically possible, though highly unlikely, that we eliminated all
2168     // clauses.  If so, force the cleanup flag to true.
2169     if (NewClauses.empty())
2170       CleanupFlag = true;
2171     NLI->setCleanup(CleanupFlag);
2172     return NLI;
2173   }
2174
2175   // Even if none of the clauses changed, we may nonetheless have understood
2176   // that the cleanup flag is pointless.  Clear it if so.
2177   if (LI.isCleanup() != CleanupFlag) {
2178     assert(!CleanupFlag && "Adding a cleanup, not removing one?!");
2179     LI.setCleanup(CleanupFlag);
2180     return &LI;
2181   }
2182
2183   return 0;
2184 }
2185
2186
2187
2188
2189 /// TryToSinkInstruction - Try to move the specified instruction from its
2190 /// current block into the beginning of DestBlock, which can only happen if it's
2191 /// safe to move the instruction past all of the instructions between it and the
2192 /// end of its block.
2193 static bool TryToSinkInstruction(Instruction *I, BasicBlock *DestBlock) {
2194   assert(I->hasOneUse() && "Invariants didn't hold!");
2195
2196   // Cannot move control-flow-involving, volatile loads, vaarg, etc.
2197   if (isa<PHINode>(I) || isa<LandingPadInst>(I) || I->mayHaveSideEffects() ||
2198       isa<TerminatorInst>(I))
2199     return false;
2200
2201   // Do not sink alloca instructions out of the entry block.
2202   if (isa<AllocaInst>(I) && I->getParent() ==
2203         &DestBlock->getParent()->getEntryBlock())
2204     return false;
2205
2206   // We can only sink load instructions if there is nothing between the load and
2207   // the end of block that could change the value.
2208   if (I->mayReadFromMemory()) {
2209     for (BasicBlock::iterator Scan = I, E = I->getParent()->end();
2210          Scan != E; ++Scan)
2211       if (Scan->mayWriteToMemory())
2212         return false;
2213   }
2214
2215   BasicBlock::iterator InsertPos = DestBlock->getFirstInsertionPt();
2216   I->moveBefore(InsertPos);
2217   ++NumSunkInst;
2218   return true;
2219 }
2220
2221
2222 /// AddReachableCodeToWorklist - Walk the function in depth-first order, adding
2223 /// all reachable code to the worklist.
2224 ///
2225 /// This has a couple of tricks to make the code faster and more powerful.  In
2226 /// particular, we constant fold and DCE instructions as we go, to avoid adding
2227 /// them to the worklist (this significantly speeds up instcombine on code where
2228 /// many instructions are dead or constant).  Additionally, if we find a branch
2229 /// whose condition is a known constant, we only visit the reachable successors.
2230 ///
2231 static bool AddReachableCodeToWorklist(BasicBlock *BB,
2232                                        SmallPtrSet<BasicBlock*, 64> &Visited,
2233                                        InstCombiner &IC,
2234                                        const DataLayout *DL,
2235                                        const TargetLibraryInfo *TLI) {
2236   bool MadeIRChange = false;
2237   SmallVector<BasicBlock*, 256> Worklist;
2238   Worklist.push_back(BB);
2239
2240   SmallVector<Instruction*, 128> InstrsForInstCombineWorklist;
2241   DenseMap<ConstantExpr*, Constant*> FoldedConstants;
2242
2243   do {
2244     BB = Worklist.pop_back_val();
2245
2246     // We have now visited this block!  If we've already been here, ignore it.
2247     if (!Visited.insert(BB)) continue;
2248
2249     for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ) {
2250       Instruction *Inst = BBI++;
2251
2252       // DCE instruction if trivially dead.
2253       if (isInstructionTriviallyDead(Inst, TLI)) {
2254         ++NumDeadInst;
2255         DEBUG(dbgs() << "IC: DCE: " << *Inst << '\n');
2256         Inst->eraseFromParent();
2257         continue;
2258       }
2259
2260       // ConstantProp instruction if trivially constant.
2261       if (!Inst->use_empty() && isa<Constant>(Inst->getOperand(0)))
2262         if (Constant *C = ConstantFoldInstruction(Inst, DL, TLI)) {
2263           DEBUG(dbgs() << "IC: ConstFold to: " << *C << " from: "
2264                        << *Inst << '\n');
2265           Inst->replaceAllUsesWith(C);
2266           ++NumConstProp;
2267           Inst->eraseFromParent();
2268           continue;
2269         }
2270
2271       if (DL) {
2272         // See if we can constant fold its operands.
2273         for (User::op_iterator i = Inst->op_begin(), e = Inst->op_end();
2274              i != e; ++i) {
2275           ConstantExpr *CE = dyn_cast<ConstantExpr>(i);
2276           if (CE == 0) continue;
2277
2278           Constant*& FoldRes = FoldedConstants[CE];
2279           if (!FoldRes)
2280             FoldRes = ConstantFoldConstantExpression(CE, DL, TLI);
2281           if (!FoldRes)
2282             FoldRes = CE;
2283
2284           if (FoldRes != CE) {
2285             *i = FoldRes;
2286             MadeIRChange = true;
2287           }
2288         }
2289       }
2290
2291       InstrsForInstCombineWorklist.push_back(Inst);
2292     }
2293
2294     // Recursively visit successors.  If this is a branch or switch on a
2295     // constant, only visit the reachable successor.
2296     TerminatorInst *TI = BB->getTerminator();
2297     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
2298       if (BI->isConditional() && isa<ConstantInt>(BI->getCondition())) {
2299         bool CondVal = cast<ConstantInt>(BI->getCondition())->getZExtValue();
2300         BasicBlock *ReachableBB = BI->getSuccessor(!CondVal);
2301         Worklist.push_back(ReachableBB);
2302         continue;
2303       }
2304     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
2305       if (ConstantInt *Cond = dyn_cast<ConstantInt>(SI->getCondition())) {
2306         // See if this is an explicit destination.
2307         for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
2308              i != e; ++i)
2309           if (i.getCaseValue() == Cond) {
2310             BasicBlock *ReachableBB = i.getCaseSuccessor();
2311             Worklist.push_back(ReachableBB);
2312             continue;
2313           }
2314
2315         // Otherwise it is the default destination.
2316         Worklist.push_back(SI->getDefaultDest());
2317         continue;
2318       }
2319     }
2320
2321     for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
2322       Worklist.push_back(TI->getSuccessor(i));
2323   } while (!Worklist.empty());
2324
2325   // Once we've found all of the instructions to add to instcombine's worklist,
2326   // add them in reverse order.  This way instcombine will visit from the top
2327   // of the function down.  This jives well with the way that it adds all uses
2328   // of instructions to the worklist after doing a transformation, thus avoiding
2329   // some N^2 behavior in pathological cases.
2330   IC.Worklist.AddInitialGroup(&InstrsForInstCombineWorklist[0],
2331                               InstrsForInstCombineWorklist.size());
2332
2333   return MadeIRChange;
2334 }
2335
2336 bool InstCombiner::DoOneIteration(Function &F, unsigned Iteration) {
2337   MadeIRChange = false;
2338
2339   DEBUG(dbgs() << "\n\nINSTCOMBINE ITERATION #" << Iteration << " on "
2340                << F.getName() << "\n");
2341
2342   {
2343     // Do a depth-first traversal of the function, populate the worklist with
2344     // the reachable instructions.  Ignore blocks that are not reachable.  Keep
2345     // track of which blocks we visit.
2346     SmallPtrSet<BasicBlock*, 64> Visited;
2347     MadeIRChange |= AddReachableCodeToWorklist(F.begin(), Visited, *this, DL,
2348                                                TLI);
2349
2350     // Do a quick scan over the function.  If we find any blocks that are
2351     // unreachable, remove any instructions inside of them.  This prevents
2352     // the instcombine code from having to deal with some bad special cases.
2353     for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
2354       if (Visited.count(BB)) continue;
2355
2356       // Delete the instructions backwards, as it has a reduced likelihood of
2357       // having to update as many def-use and use-def chains.
2358       Instruction *EndInst = BB->getTerminator(); // Last not to be deleted.
2359       while (EndInst != BB->begin()) {
2360         // Delete the next to last instruction.
2361         BasicBlock::iterator I = EndInst;
2362         Instruction *Inst = --I;
2363         if (!Inst->use_empty())
2364           Inst->replaceAllUsesWith(UndefValue::get(Inst->getType()));
2365         if (isa<LandingPadInst>(Inst)) {
2366           EndInst = Inst;
2367           continue;
2368         }
2369         if (!isa<DbgInfoIntrinsic>(Inst)) {
2370           ++NumDeadInst;
2371           MadeIRChange = true;
2372         }
2373         Inst->eraseFromParent();
2374       }
2375     }
2376   }
2377
2378   while (!Worklist.isEmpty()) {
2379     Instruction *I = Worklist.RemoveOne();
2380     if (I == 0) continue;  // skip null values.
2381
2382     // Check to see if we can DCE the instruction.
2383     if (isInstructionTriviallyDead(I, TLI)) {
2384       DEBUG(dbgs() << "IC: DCE: " << *I << '\n');
2385       EraseInstFromFunction(*I);
2386       ++NumDeadInst;
2387       MadeIRChange = true;
2388       continue;
2389     }
2390
2391     // Instruction isn't dead, see if we can constant propagate it.
2392     if (!I->use_empty() && isa<Constant>(I->getOperand(0)))
2393       if (Constant *C = ConstantFoldInstruction(I, DL, TLI)) {
2394         DEBUG(dbgs() << "IC: ConstFold to: " << *C << " from: " << *I << '\n');
2395
2396         // Add operands to the worklist.
2397         ReplaceInstUsesWith(*I, C);
2398         ++NumConstProp;
2399         EraseInstFromFunction(*I);
2400         MadeIRChange = true;
2401         continue;
2402       }
2403
2404     // See if we can trivially sink this instruction to a successor basic block.
2405     if (I->hasOneUse()) {
2406       BasicBlock *BB = I->getParent();
2407       Instruction *UserInst = cast<Instruction>(I->use_back());
2408       BasicBlock *UserParent;
2409
2410       // Get the block the use occurs in.
2411       if (PHINode *PN = dyn_cast<PHINode>(UserInst))
2412         UserParent = PN->getIncomingBlock(I->use_begin().getUse());
2413       else
2414         UserParent = UserInst->getParent();
2415
2416       if (UserParent != BB) {
2417         bool UserIsSuccessor = false;
2418         // See if the user is one of our successors.
2419         for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
2420           if (*SI == UserParent) {
2421             UserIsSuccessor = true;
2422             break;
2423           }
2424
2425         // If the user is one of our immediate successors, and if that successor
2426         // only has us as a predecessors (we'd have to split the critical edge
2427         // otherwise), we can keep going.
2428         if (UserIsSuccessor && UserParent->getSinglePredecessor())
2429           // Okay, the CFG is simple enough, try to sink this instruction.
2430           MadeIRChange |= TryToSinkInstruction(I, UserParent);
2431       }
2432     }
2433
2434     // Now that we have an instruction, try combining it to simplify it.
2435     Builder->SetInsertPoint(I->getParent(), I);
2436     Builder->SetCurrentDebugLocation(I->getDebugLoc());
2437
2438 #ifndef NDEBUG
2439     std::string OrigI;
2440 #endif
2441     DEBUG(raw_string_ostream SS(OrigI); I->print(SS); OrigI = SS.str(););
2442     DEBUG(dbgs() << "IC: Visiting: " << OrigI << '\n');
2443
2444     if (Instruction *Result = visit(*I)) {
2445       ++NumCombined;
2446       // Should we replace the old instruction with a new one?
2447       if (Result != I) {
2448         DEBUG(dbgs() << "IC: Old = " << *I << '\n'
2449                      << "    New = " << *Result << '\n');
2450
2451         if (!I->getDebugLoc().isUnknown())
2452           Result->setDebugLoc(I->getDebugLoc());
2453         // Everything uses the new instruction now.
2454         I->replaceAllUsesWith(Result);
2455
2456         // Move the name to the new instruction first.
2457         Result->takeName(I);
2458
2459         // Push the new instruction and any users onto the worklist.
2460         Worklist.Add(Result);
2461         Worklist.AddUsersToWorkList(*Result);
2462
2463         // Insert the new instruction into the basic block...
2464         BasicBlock *InstParent = I->getParent();
2465         BasicBlock::iterator InsertPos = I;
2466
2467         // If we replace a PHI with something that isn't a PHI, fix up the
2468         // insertion point.
2469         if (!isa<PHINode>(Result) && isa<PHINode>(InsertPos))
2470           InsertPos = InstParent->getFirstInsertionPt();
2471
2472         InstParent->getInstList().insert(InsertPos, Result);
2473
2474         EraseInstFromFunction(*I);
2475       } else {
2476 #ifndef NDEBUG
2477         DEBUG(dbgs() << "IC: Mod = " << OrigI << '\n'
2478                      << "    New = " << *I << '\n');
2479 #endif
2480
2481         // If the instruction was modified, it's possible that it is now dead.
2482         // if so, remove it.
2483         if (isInstructionTriviallyDead(I, TLI)) {
2484           EraseInstFromFunction(*I);
2485         } else {
2486           Worklist.Add(I);
2487           Worklist.AddUsersToWorkList(*I);
2488         }
2489       }
2490       MadeIRChange = true;
2491     }
2492   }
2493
2494   Worklist.Zap();
2495   return MadeIRChange;
2496 }
2497
2498 namespace {
2499 class InstCombinerLibCallSimplifier : public LibCallSimplifier {
2500   InstCombiner *IC;
2501 public:
2502   InstCombinerLibCallSimplifier(const DataLayout *DL,
2503                                 const TargetLibraryInfo *TLI,
2504                                 InstCombiner *IC)
2505     : LibCallSimplifier(DL, TLI, UnsafeFPShrink) {
2506     this->IC = IC;
2507   }
2508
2509   /// replaceAllUsesWith - override so that instruction replacement
2510   /// can be defined in terms of the instruction combiner framework.
2511   virtual void replaceAllUsesWith(Instruction *I, Value *With) const {
2512     IC->ReplaceInstUsesWith(*I, With);
2513   }
2514 };
2515 }
2516
2517 bool InstCombiner::runOnFunction(Function &F) {
2518   if (skipOptnoneFunction(F))
2519     return false;
2520
2521   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
2522   DL = DLP ? &DLP->getDataLayout() : 0;
2523   TLI = &getAnalysis<TargetLibraryInfo>();
2524   // Minimizing size?
2525   MinimizeSize = F.getAttributes().hasAttribute(AttributeSet::FunctionIndex,
2526                                                 Attribute::MinSize);
2527
2528   /// Builder - This is an IRBuilder that automatically inserts new
2529   /// instructions into the worklist when they are created.
2530   IRBuilder<true, TargetFolder, InstCombineIRInserter>
2531     TheBuilder(F.getContext(), TargetFolder(DL),
2532                InstCombineIRInserter(Worklist));
2533   Builder = &TheBuilder;
2534
2535   InstCombinerLibCallSimplifier TheSimplifier(DL, TLI, this);
2536   Simplifier = &TheSimplifier;
2537
2538   bool EverMadeChange = false;
2539
2540   // Lower dbg.declare intrinsics otherwise their value may be clobbered
2541   // by instcombiner.
2542   EverMadeChange = LowerDbgDeclare(F);
2543
2544   // Iterate while there is work to do.
2545   unsigned Iteration = 0;
2546   while (DoOneIteration(F, Iteration++))
2547     EverMadeChange = true;
2548
2549   Builder = 0;
2550   return EverMadeChange;
2551 }
2552
2553 FunctionPass *llvm::createInstructionCombiningPass() {
2554   return new InstCombiner();
2555 }