Fix PR19270 - type mismatch caused by invalid optimization.
[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/CFG.h"
47 #include "llvm/IR/DataLayout.h"
48 #include "llvm/IR/GetElementPtrTypeIterator.h"
49 #include "llvm/IR/IntrinsicInst.h"
50 #include "llvm/IR/PatternMatch.h"
51 #include "llvm/IR/ValueHandle.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 (User *U : PN->users()) {
645       Instruction *UI = cast<Instruction>(U);
646       if (UI != &I && !I.isIdenticalTo(UI))
647         return 0;
648     }
649     // Otherwise, we can replace *all* users with the new PHI we form.
650   }
651
652   // Check to see if all of the operands of the PHI are simple constants
653   // (constantint/constantfp/undef).  If there is one non-constant value,
654   // remember the BB it is in.  If there is more than one or if *it* is a PHI,
655   // bail out.  We don't do arbitrary constant expressions here because moving
656   // their computation can be expensive without a cost model.
657   BasicBlock *NonConstBB = 0;
658   for (unsigned i = 0; i != NumPHIValues; ++i) {
659     Value *InVal = PN->getIncomingValue(i);
660     if (isa<Constant>(InVal) && !isa<ConstantExpr>(InVal))
661       continue;
662
663     if (isa<PHINode>(InVal)) return 0;  // Itself a phi.
664     if (NonConstBB) return 0;  // More than one non-const value.
665
666     NonConstBB = PN->getIncomingBlock(i);
667
668     // If the InVal is an invoke at the end of the pred block, then we can't
669     // insert a computation after it without breaking the edge.
670     if (InvokeInst *II = dyn_cast<InvokeInst>(InVal))
671       if (II->getParent() == NonConstBB)
672         return 0;
673
674     // If the incoming non-constant value is in I's block, we will remove one
675     // instruction, but insert another equivalent one, leading to infinite
676     // instcombine.
677     if (NonConstBB == I.getParent())
678       return 0;
679   }
680
681   // If there is exactly one non-constant value, we can insert a copy of the
682   // operation in that block.  However, if this is a critical edge, we would be
683   // inserting the computation one some other paths (e.g. inside a loop).  Only
684   // do this if the pred block is unconditionally branching into the phi block.
685   if (NonConstBB != 0) {
686     BranchInst *BI = dyn_cast<BranchInst>(NonConstBB->getTerminator());
687     if (!BI || !BI->isUnconditional()) return 0;
688   }
689
690   // Okay, we can do the transformation: create the new PHI node.
691   PHINode *NewPN = PHINode::Create(I.getType(), PN->getNumIncomingValues());
692   InsertNewInstBefore(NewPN, *PN);
693   NewPN->takeName(PN);
694
695   // If we are going to have to insert a new computation, do so right before the
696   // predecessors terminator.
697   if (NonConstBB)
698     Builder->SetInsertPoint(NonConstBB->getTerminator());
699
700   // Next, add all of the operands to the PHI.
701   if (SelectInst *SI = dyn_cast<SelectInst>(&I)) {
702     // We only currently try to fold the condition of a select when it is a phi,
703     // not the true/false values.
704     Value *TrueV = SI->getTrueValue();
705     Value *FalseV = SI->getFalseValue();
706     BasicBlock *PhiTransBB = PN->getParent();
707     for (unsigned i = 0; i != NumPHIValues; ++i) {
708       BasicBlock *ThisBB = PN->getIncomingBlock(i);
709       Value *TrueVInPred = TrueV->DoPHITranslation(PhiTransBB, ThisBB);
710       Value *FalseVInPred = FalseV->DoPHITranslation(PhiTransBB, ThisBB);
711       Value *InV = 0;
712       // Beware of ConstantExpr:  it may eventually evaluate to getNullValue,
713       // even if currently isNullValue gives false.
714       Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i));
715       if (InC && !isa<ConstantExpr>(InC))
716         InV = InC->isNullValue() ? FalseVInPred : TrueVInPred;
717       else
718         InV = Builder->CreateSelect(PN->getIncomingValue(i),
719                                     TrueVInPred, FalseVInPred, "phitmp");
720       NewPN->addIncoming(InV, ThisBB);
721     }
722   } else if (CmpInst *CI = dyn_cast<CmpInst>(&I)) {
723     Constant *C = cast<Constant>(I.getOperand(1));
724     for (unsigned i = 0; i != NumPHIValues; ++i) {
725       Value *InV = 0;
726       if (Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i)))
727         InV = ConstantExpr::getCompare(CI->getPredicate(), InC, C);
728       else if (isa<ICmpInst>(CI))
729         InV = Builder->CreateICmp(CI->getPredicate(), PN->getIncomingValue(i),
730                                   C, "phitmp");
731       else
732         InV = Builder->CreateFCmp(CI->getPredicate(), PN->getIncomingValue(i),
733                                   C, "phitmp");
734       NewPN->addIncoming(InV, PN->getIncomingBlock(i));
735     }
736   } else if (I.getNumOperands() == 2) {
737     Constant *C = cast<Constant>(I.getOperand(1));
738     for (unsigned i = 0; i != NumPHIValues; ++i) {
739       Value *InV = 0;
740       if (Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i)))
741         InV = ConstantExpr::get(I.getOpcode(), InC, C);
742       else
743         InV = Builder->CreateBinOp(cast<BinaryOperator>(I).getOpcode(),
744                                    PN->getIncomingValue(i), C, "phitmp");
745       NewPN->addIncoming(InV, PN->getIncomingBlock(i));
746     }
747   } else {
748     CastInst *CI = cast<CastInst>(&I);
749     Type *RetTy = CI->getType();
750     for (unsigned i = 0; i != NumPHIValues; ++i) {
751       Value *InV;
752       if (Constant *InC = dyn_cast<Constant>(PN->getIncomingValue(i)))
753         InV = ConstantExpr::getCast(CI->getOpcode(), InC, RetTy);
754       else
755         InV = Builder->CreateCast(CI->getOpcode(),
756                                 PN->getIncomingValue(i), I.getType(), "phitmp");
757       NewPN->addIncoming(InV, PN->getIncomingBlock(i));
758     }
759   }
760
761   for (auto UI = PN->user_begin(), E = PN->user_end(); UI != E;) {
762     Instruction *User = cast<Instruction>(*UI++);
763     if (User == &I) continue;
764     ReplaceInstUsesWith(*User, NewPN);
765     EraseInstFromFunction(*User);
766   }
767   return ReplaceInstUsesWith(I, NewPN);
768 }
769
770 /// FindElementAtOffset - Given a pointer type and a constant offset, determine
771 /// whether or not there is a sequence of GEP indices into the pointed type that
772 /// will land us at the specified offset.  If so, fill them into NewIndices and
773 /// return the resultant element type, otherwise return null.
774 Type *InstCombiner::FindElementAtOffset(Type *PtrTy, int64_t Offset,
775                                         SmallVectorImpl<Value*> &NewIndices) {
776   assert(PtrTy->isPtrOrPtrVectorTy());
777
778   if (!DL)
779     return 0;
780
781   Type *Ty = PtrTy->getPointerElementType();
782   if (!Ty->isSized())
783     return 0;
784
785   // Start with the index over the outer type.  Note that the type size
786   // might be zero (even if the offset isn't zero) if the indexed type
787   // is something like [0 x {int, int}]
788   Type *IntPtrTy = DL->getIntPtrType(PtrTy);
789   int64_t FirstIdx = 0;
790   if (int64_t TySize = DL->getTypeAllocSize(Ty)) {
791     FirstIdx = Offset/TySize;
792     Offset -= FirstIdx*TySize;
793
794     // Handle hosts where % returns negative instead of values [0..TySize).
795     if (Offset < 0) {
796       --FirstIdx;
797       Offset += TySize;
798       assert(Offset >= 0);
799     }
800     assert((uint64_t)Offset < (uint64_t)TySize && "Out of range offset");
801   }
802
803   NewIndices.push_back(ConstantInt::get(IntPtrTy, FirstIdx));
804
805   // Index into the types.  If we fail, set OrigBase to null.
806   while (Offset) {
807     // Indexing into tail padding between struct/array elements.
808     if (uint64_t(Offset*8) >= DL->getTypeSizeInBits(Ty))
809       return 0;
810
811     if (StructType *STy = dyn_cast<StructType>(Ty)) {
812       const StructLayout *SL = DL->getStructLayout(STy);
813       assert(Offset < (int64_t)SL->getSizeInBytes() &&
814              "Offset must stay within the indexed type");
815
816       unsigned Elt = SL->getElementContainingOffset(Offset);
817       NewIndices.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
818                                             Elt));
819
820       Offset -= SL->getElementOffset(Elt);
821       Ty = STy->getElementType(Elt);
822     } else if (ArrayType *AT = dyn_cast<ArrayType>(Ty)) {
823       uint64_t EltSize = DL->getTypeAllocSize(AT->getElementType());
824       assert(EltSize && "Cannot index into a zero-sized array");
825       NewIndices.push_back(ConstantInt::get(IntPtrTy,Offset/EltSize));
826       Offset %= EltSize;
827       Ty = AT->getElementType();
828     } else {
829       // Otherwise, we can't index into the middle of this atomic type, bail.
830       return 0;
831     }
832   }
833
834   return Ty;
835 }
836
837 static bool shouldMergeGEPs(GEPOperator &GEP, GEPOperator &Src) {
838   // If this GEP has only 0 indices, it is the same pointer as
839   // Src. If Src is not a trivial GEP too, don't combine
840   // the indices.
841   if (GEP.hasAllZeroIndices() && !Src.hasAllZeroIndices() &&
842       !Src.hasOneUse())
843     return false;
844   return true;
845 }
846
847 /// Descale - Return a value X such that Val = X * Scale, or null if none.  If
848 /// the multiplication is known not to overflow then NoSignedWrap is set.
849 Value *InstCombiner::Descale(Value *Val, APInt Scale, bool &NoSignedWrap) {
850   assert(isa<IntegerType>(Val->getType()) && "Can only descale integers!");
851   assert(cast<IntegerType>(Val->getType())->getBitWidth() ==
852          Scale.getBitWidth() && "Scale not compatible with value!");
853
854   // If Val is zero or Scale is one then Val = Val * Scale.
855   if (match(Val, m_Zero()) || Scale == 1) {
856     NoSignedWrap = true;
857     return Val;
858   }
859
860   // If Scale is zero then it does not divide Val.
861   if (Scale.isMinValue())
862     return 0;
863
864   // Look through chains of multiplications, searching for a constant that is
865   // divisible by Scale.  For example, descaling X*(Y*(Z*4)) by a factor of 4
866   // will find the constant factor 4 and produce X*(Y*Z).  Descaling X*(Y*8) by
867   // a factor of 4 will produce X*(Y*2).  The principle of operation is to bore
868   // down from Val:
869   //
870   //     Val = M1 * X          ||   Analysis starts here and works down
871   //      M1 = M2 * Y          ||   Doesn't descend into terms with more
872   //      M2 =  Z * 4          \/   than one use
873   //
874   // Then to modify a term at the bottom:
875   //
876   //     Val = M1 * X
877   //      M1 =  Z * Y          ||   Replaced M2 with Z
878   //
879   // Then to work back up correcting nsw flags.
880
881   // Op - the term we are currently analyzing.  Starts at Val then drills down.
882   // Replaced with its descaled value before exiting from the drill down loop.
883   Value *Op = Val;
884
885   // Parent - initially null, but after drilling down notes where Op came from.
886   // In the example above, Parent is (Val, 0) when Op is M1, because M1 is the
887   // 0'th operand of Val.
888   std::pair<Instruction*, unsigned> Parent;
889
890   // RequireNoSignedWrap - Set if the transform requires a descaling at deeper
891   // levels that doesn't overflow.
892   bool RequireNoSignedWrap = false;
893
894   // logScale - log base 2 of the scale.  Negative if not a power of 2.
895   int32_t logScale = Scale.exactLogBase2();
896
897   for (;; Op = Parent.first->getOperand(Parent.second)) { // Drill down
898
899     if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
900       // If Op is a constant divisible by Scale then descale to the quotient.
901       APInt Quotient(Scale), Remainder(Scale); // Init ensures right bitwidth.
902       APInt::sdivrem(CI->getValue(), Scale, Quotient, Remainder);
903       if (!Remainder.isMinValue())
904         // Not divisible by Scale.
905         return 0;
906       // Replace with the quotient in the parent.
907       Op = ConstantInt::get(CI->getType(), Quotient);
908       NoSignedWrap = true;
909       break;
910     }
911
912     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op)) {
913
914       if (BO->getOpcode() == Instruction::Mul) {
915         // Multiplication.
916         NoSignedWrap = BO->hasNoSignedWrap();
917         if (RequireNoSignedWrap && !NoSignedWrap)
918           return 0;
919
920         // There are three cases for multiplication: multiplication by exactly
921         // the scale, multiplication by a constant different to the scale, and
922         // multiplication by something else.
923         Value *LHS = BO->getOperand(0);
924         Value *RHS = BO->getOperand(1);
925
926         if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
927           // Multiplication by a constant.
928           if (CI->getValue() == Scale) {
929             // Multiplication by exactly the scale, replace the multiplication
930             // by its left-hand side in the parent.
931             Op = LHS;
932             break;
933           }
934
935           // Otherwise drill down into the constant.
936           if (!Op->hasOneUse())
937             return 0;
938
939           Parent = std::make_pair(BO, 1);
940           continue;
941         }
942
943         // Multiplication by something else. Drill down into the left-hand side
944         // since that's where the reassociate pass puts the good stuff.
945         if (!Op->hasOneUse())
946           return 0;
947
948         Parent = std::make_pair(BO, 0);
949         continue;
950       }
951
952       if (logScale > 0 && BO->getOpcode() == Instruction::Shl &&
953           isa<ConstantInt>(BO->getOperand(1))) {
954         // Multiplication by a power of 2.
955         NoSignedWrap = BO->hasNoSignedWrap();
956         if (RequireNoSignedWrap && !NoSignedWrap)
957           return 0;
958
959         Value *LHS = BO->getOperand(0);
960         int32_t Amt = cast<ConstantInt>(BO->getOperand(1))->
961           getLimitedValue(Scale.getBitWidth());
962         // Op = LHS << Amt.
963
964         if (Amt == logScale) {
965           // Multiplication by exactly the scale, replace the multiplication
966           // by its left-hand side in the parent.
967           Op = LHS;
968           break;
969         }
970         if (Amt < logScale || !Op->hasOneUse())
971           return 0;
972
973         // Multiplication by more than the scale.  Reduce the multiplying amount
974         // by the scale in the parent.
975         Parent = std::make_pair(BO, 1);
976         Op = ConstantInt::get(BO->getType(), Amt - logScale);
977         break;
978       }
979     }
980
981     if (!Op->hasOneUse())
982       return 0;
983
984     if (CastInst *Cast = dyn_cast<CastInst>(Op)) {
985       if (Cast->getOpcode() == Instruction::SExt) {
986         // Op is sign-extended from a smaller type, descale in the smaller type.
987         unsigned SmallSize = Cast->getSrcTy()->getPrimitiveSizeInBits();
988         APInt SmallScale = Scale.trunc(SmallSize);
989         // Suppose Op = sext X, and we descale X as Y * SmallScale.  We want to
990         // descale Op as (sext Y) * Scale.  In order to have
991         //   sext (Y * SmallScale) = (sext Y) * Scale
992         // some conditions need to hold however: SmallScale must sign-extend to
993         // Scale and the multiplication Y * SmallScale should not overflow.
994         if (SmallScale.sext(Scale.getBitWidth()) != Scale)
995           // SmallScale does not sign-extend to Scale.
996           return 0;
997         assert(SmallScale.exactLogBase2() == logScale);
998         // Require that Y * SmallScale must not overflow.
999         RequireNoSignedWrap = true;
1000
1001         // Drill down through the cast.
1002         Parent = std::make_pair(Cast, 0);
1003         Scale = SmallScale;
1004         continue;
1005       }
1006
1007       if (Cast->getOpcode() == Instruction::Trunc) {
1008         // Op is truncated from a larger type, descale in the larger type.
1009         // Suppose Op = trunc X, and we descale X as Y * sext Scale.  Then
1010         //   trunc (Y * sext Scale) = (trunc Y) * Scale
1011         // always holds.  However (trunc Y) * Scale may overflow even if
1012         // trunc (Y * sext Scale) does not, so nsw flags need to be cleared
1013         // from this point up in the expression (see later).
1014         if (RequireNoSignedWrap)
1015           return 0;
1016
1017         // Drill down through the cast.
1018         unsigned LargeSize = Cast->getSrcTy()->getPrimitiveSizeInBits();
1019         Parent = std::make_pair(Cast, 0);
1020         Scale = Scale.sext(LargeSize);
1021         if (logScale + 1 == (int32_t)Cast->getType()->getPrimitiveSizeInBits())
1022           logScale = -1;
1023         assert(Scale.exactLogBase2() == logScale);
1024         continue;
1025       }
1026     }
1027
1028     // Unsupported expression, bail out.
1029     return 0;
1030   }
1031
1032   // We know that we can successfully descale, so from here on we can safely
1033   // modify the IR.  Op holds the descaled version of the deepest term in the
1034   // expression.  NoSignedWrap is 'true' if multiplying Op by Scale is known
1035   // not to overflow.
1036
1037   if (!Parent.first)
1038     // The expression only had one term.
1039     return Op;
1040
1041   // Rewrite the parent using the descaled version of its operand.
1042   assert(Parent.first->hasOneUse() && "Drilled down when more than one use!");
1043   assert(Op != Parent.first->getOperand(Parent.second) &&
1044          "Descaling was a no-op?");
1045   Parent.first->setOperand(Parent.second, Op);
1046   Worklist.Add(Parent.first);
1047
1048   // Now work back up the expression correcting nsw flags.  The logic is based
1049   // on the following observation: if X * Y is known not to overflow as a signed
1050   // multiplication, and Y is replaced by a value Z with smaller absolute value,
1051   // then X * Z will not overflow as a signed multiplication either.  As we work
1052   // our way up, having NoSignedWrap 'true' means that the descaled value at the
1053   // current level has strictly smaller absolute value than the original.
1054   Instruction *Ancestor = Parent.first;
1055   do {
1056     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Ancestor)) {
1057       // If the multiplication wasn't nsw then we can't say anything about the
1058       // value of the descaled multiplication, and we have to clear nsw flags
1059       // from this point on up.
1060       bool OpNoSignedWrap = BO->hasNoSignedWrap();
1061       NoSignedWrap &= OpNoSignedWrap;
1062       if (NoSignedWrap != OpNoSignedWrap) {
1063         BO->setHasNoSignedWrap(NoSignedWrap);
1064         Worklist.Add(Ancestor);
1065       }
1066     } else if (Ancestor->getOpcode() == Instruction::Trunc) {
1067       // The fact that the descaled input to the trunc has smaller absolute
1068       // value than the original input doesn't tell us anything useful about
1069       // the absolute values of the truncations.
1070       NoSignedWrap = false;
1071     }
1072     assert((Ancestor->getOpcode() != Instruction::SExt || NoSignedWrap) &&
1073            "Failed to keep proper track of nsw flags while drilling down?");
1074
1075     if (Ancestor == Val)
1076       // Got to the top, all done!
1077       return Val;
1078
1079     // Move up one level in the expression.
1080     assert(Ancestor->hasOneUse() && "Drilled down when more than one use!");
1081     Ancestor = Ancestor->user_back();
1082   } while (1);
1083 }
1084
1085 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1086   SmallVector<Value*, 8> Ops(GEP.op_begin(), GEP.op_end());
1087
1088   if (Value *V = SimplifyGEPInst(Ops, DL))
1089     return ReplaceInstUsesWith(GEP, V);
1090
1091   Value *PtrOp = GEP.getOperand(0);
1092
1093   // Eliminate unneeded casts for indices, and replace indices which displace
1094   // by multiples of a zero size type with zero.
1095   if (DL) {
1096     bool MadeChange = false;
1097     Type *IntPtrTy = DL->getIntPtrType(GEP.getPointerOperandType());
1098
1099     gep_type_iterator GTI = gep_type_begin(GEP);
1100     for (User::op_iterator I = GEP.op_begin() + 1, E = GEP.op_end();
1101          I != E; ++I, ++GTI) {
1102       // Skip indices into struct types.
1103       SequentialType *SeqTy = dyn_cast<SequentialType>(*GTI);
1104       if (!SeqTy) continue;
1105
1106       // If the element type has zero size then any index over it is equivalent
1107       // to an index of zero, so replace it with zero if it is not zero already.
1108       if (SeqTy->getElementType()->isSized() &&
1109           DL->getTypeAllocSize(SeqTy->getElementType()) == 0)
1110         if (!isa<Constant>(*I) || !cast<Constant>(*I)->isNullValue()) {
1111           *I = Constant::getNullValue(IntPtrTy);
1112           MadeChange = true;
1113         }
1114
1115       Type *IndexTy = (*I)->getType();
1116       if (IndexTy != IntPtrTy) {
1117         // If we are using a wider index than needed for this platform, shrink
1118         // it to what we need.  If narrower, sign-extend it to what we need.
1119         // This explicit cast can make subsequent optimizations more obvious.
1120         *I = Builder->CreateIntCast(*I, IntPtrTy, true);
1121         MadeChange = true;
1122       }
1123     }
1124     if (MadeChange) return &GEP;
1125   }
1126
1127   // Combine Indices - If the source pointer to this getelementptr instruction
1128   // is a getelementptr instruction, combine the indices of the two
1129   // getelementptr instructions into a single instruction.
1130   //
1131   if (GEPOperator *Src = dyn_cast<GEPOperator>(PtrOp)) {
1132     if (!shouldMergeGEPs(*cast<GEPOperator>(&GEP), *Src))
1133       return 0;
1134
1135     // Note that if our source is a gep chain itself then we wait for that
1136     // chain to be resolved before we perform this transformation.  This
1137     // avoids us creating a TON of code in some cases.
1138     if (GEPOperator *SrcGEP =
1139           dyn_cast<GEPOperator>(Src->getOperand(0)))
1140       if (SrcGEP->getNumOperands() == 2 && shouldMergeGEPs(*Src, *SrcGEP))
1141         return 0;   // Wait until our source is folded to completion.
1142
1143     SmallVector<Value*, 8> Indices;
1144
1145     // Find out whether the last index in the source GEP is a sequential idx.
1146     bool EndsWithSequential = false;
1147     for (gep_type_iterator I = gep_type_begin(*Src), E = gep_type_end(*Src);
1148          I != E; ++I)
1149       EndsWithSequential = !(*I)->isStructTy();
1150
1151     // Can we combine the two pointer arithmetics offsets?
1152     if (EndsWithSequential) {
1153       // Replace: gep (gep %P, long B), long A, ...
1154       // With:    T = long A+B; gep %P, T, ...
1155       //
1156       Value *Sum;
1157       Value *SO1 = Src->getOperand(Src->getNumOperands()-1);
1158       Value *GO1 = GEP.getOperand(1);
1159       if (SO1 == Constant::getNullValue(SO1->getType())) {
1160         Sum = GO1;
1161       } else if (GO1 == Constant::getNullValue(GO1->getType())) {
1162         Sum = SO1;
1163       } else {
1164         // If they aren't the same type, then the input hasn't been processed
1165         // by the loop above yet (which canonicalizes sequential index types to
1166         // intptr_t).  Just avoid transforming this until the input has been
1167         // normalized.
1168         if (SO1->getType() != GO1->getType())
1169           return 0;
1170         Sum = Builder->CreateAdd(SO1, GO1, PtrOp->getName()+".sum");
1171       }
1172
1173       // Update the GEP in place if possible.
1174       if (Src->getNumOperands() == 2) {
1175         GEP.setOperand(0, Src->getOperand(0));
1176         GEP.setOperand(1, Sum);
1177         return &GEP;
1178       }
1179       Indices.append(Src->op_begin()+1, Src->op_end()-1);
1180       Indices.push_back(Sum);
1181       Indices.append(GEP.op_begin()+2, GEP.op_end());
1182     } else if (isa<Constant>(*GEP.idx_begin()) &&
1183                cast<Constant>(*GEP.idx_begin())->isNullValue() &&
1184                Src->getNumOperands() != 1) {
1185       // Otherwise we can do the fold if the first index of the GEP is a zero
1186       Indices.append(Src->op_begin()+1, Src->op_end());
1187       Indices.append(GEP.idx_begin()+1, GEP.idx_end());
1188     }
1189
1190     if (!Indices.empty())
1191       return (GEP.isInBounds() && Src->isInBounds()) ?
1192         GetElementPtrInst::CreateInBounds(Src->getOperand(0), Indices,
1193                                           GEP.getName()) :
1194         GetElementPtrInst::Create(Src->getOperand(0), Indices, GEP.getName());
1195   }
1196
1197   // Canonicalize (gep i8* X, -(ptrtoint Y)) to (sub (ptrtoint X), (ptrtoint Y))
1198   // The GEP pattern is emitted by the SCEV expander for certain kinds of
1199   // pointer arithmetic.
1200   if (DL && GEP.getNumIndices() == 1 &&
1201       match(GEP.getOperand(1), m_Neg(m_PtrToInt(m_Value())))) {
1202     unsigned AS = GEP.getPointerAddressSpace();
1203     if (GEP.getType() == Builder->getInt8PtrTy(AS) &&
1204         GEP.getOperand(1)->getType()->getScalarSizeInBits() ==
1205         DL->getPointerSizeInBits(AS)) {
1206       Operator *Index = cast<Operator>(GEP.getOperand(1));
1207       Value *PtrToInt = Builder->CreatePtrToInt(PtrOp, Index->getType());
1208       Value *NewSub = Builder->CreateSub(PtrToInt, Index->getOperand(1));
1209       return CastInst::Create(Instruction::IntToPtr, NewSub, GEP.getType());
1210     }
1211   }
1212
1213   // Handle gep(bitcast x) and gep(gep x, 0, 0, 0).
1214   Value *StrippedPtr = PtrOp->stripPointerCasts();
1215   PointerType *StrippedPtrTy = dyn_cast<PointerType>(StrippedPtr->getType());
1216
1217   // We do not handle pointer-vector geps here.
1218   if (!StrippedPtrTy)
1219     return 0;
1220
1221   if (StrippedPtr != PtrOp) {
1222     bool HasZeroPointerIndex = false;
1223     if (ConstantInt *C = dyn_cast<ConstantInt>(GEP.getOperand(1)))
1224       HasZeroPointerIndex = C->isZero();
1225
1226     // Transform: GEP (bitcast [10 x i8]* X to [0 x i8]*), i32 0, ...
1227     // into     : GEP [10 x i8]* X, i32 0, ...
1228     //
1229     // Likewise, transform: GEP (bitcast i8* X to [0 x i8]*), i32 0, ...
1230     //           into     : GEP i8* X, ...
1231     //
1232     // This occurs when the program declares an array extern like "int X[];"
1233     if (HasZeroPointerIndex) {
1234       PointerType *CPTy = cast<PointerType>(PtrOp->getType());
1235       if (ArrayType *CATy =
1236           dyn_cast<ArrayType>(CPTy->getElementType())) {
1237         // GEP (bitcast i8* X to [0 x i8]*), i32 0, ... ?
1238         if (CATy->getElementType() == StrippedPtrTy->getElementType()) {
1239           // -> GEP i8* X, ...
1240           SmallVector<Value*, 8> Idx(GEP.idx_begin()+1, GEP.idx_end());
1241           GetElementPtrInst *Res =
1242             GetElementPtrInst::Create(StrippedPtr, Idx, GEP.getName());
1243           Res->setIsInBounds(GEP.isInBounds());
1244           if (StrippedPtrTy->getAddressSpace() == GEP.getAddressSpace())
1245             return Res;
1246           // Insert Res, and create an addrspacecast.
1247           // e.g.,
1248           // GEP (addrspacecast i8 addrspace(1)* X to [0 x i8]*), i32 0, ...
1249           // ->
1250           // %0 = GEP i8 addrspace(1)* X, ...
1251           // addrspacecast i8 addrspace(1)* %0 to i8*
1252           return new AddrSpaceCastInst(Builder->Insert(Res), GEP.getType());
1253         }
1254
1255         if (ArrayType *XATy =
1256               dyn_cast<ArrayType>(StrippedPtrTy->getElementType())){
1257           // GEP (bitcast [10 x i8]* X to [0 x i8]*), i32 0, ... ?
1258           if (CATy->getElementType() == XATy->getElementType()) {
1259             // -> GEP [10 x i8]* X, i32 0, ...
1260             // At this point, we know that the cast source type is a pointer
1261             // to an array of the same type as the destination pointer
1262             // array.  Because the array type is never stepped over (there
1263             // is a leading zero) we can fold the cast into this GEP.
1264             if (StrippedPtrTy->getAddressSpace() == GEP.getAddressSpace()) {
1265               GEP.setOperand(0, StrippedPtr);
1266               return &GEP;
1267             }
1268             // Cannot replace the base pointer directly because StrippedPtr's
1269             // address space is different. Instead, create a new GEP followed by
1270             // an addrspacecast.
1271             // e.g.,
1272             // GEP (addrspacecast [10 x i8] addrspace(1)* X to [0 x i8]*),
1273             //   i32 0, ...
1274             // ->
1275             // %0 = GEP [10 x i8] addrspace(1)* X, ...
1276             // addrspacecast i8 addrspace(1)* %0 to i8*
1277             SmallVector<Value*, 8> Idx(GEP.idx_begin(), GEP.idx_end());
1278             Value *NewGEP = GEP.isInBounds() ?
1279               Builder->CreateInBoundsGEP(StrippedPtr, Idx, GEP.getName()) :
1280               Builder->CreateGEP(StrippedPtr, Idx, GEP.getName());
1281             return new AddrSpaceCastInst(NewGEP, GEP.getType());
1282           }
1283         }
1284       }
1285     } else if (GEP.getNumOperands() == 2) {
1286       // Transform things like:
1287       // %t = getelementptr i32* bitcast ([2 x i32]* %str to i32*), i32 %V
1288       // into:  %t1 = getelementptr [2 x i32]* %str, i32 0, i32 %V; bitcast
1289       Type *SrcElTy = StrippedPtrTy->getElementType();
1290       Type *ResElTy = PtrOp->getType()->getPointerElementType();
1291       if (DL && SrcElTy->isArrayTy() &&
1292           DL->getTypeAllocSize(SrcElTy->getArrayElementType()) ==
1293           DL->getTypeAllocSize(ResElTy)) {
1294         Type *IdxType = DL->getIntPtrType(GEP.getType());
1295         Value *Idx[2] = { Constant::getNullValue(IdxType), GEP.getOperand(1) };
1296         Value *NewGEP = GEP.isInBounds() ?
1297           Builder->CreateInBoundsGEP(StrippedPtr, Idx, GEP.getName()) :
1298           Builder->CreateGEP(StrippedPtr, Idx, GEP.getName());
1299
1300         // V and GEP are both pointer types --> BitCast
1301         if (StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace())
1302           return new BitCastInst(NewGEP, GEP.getType());
1303         return new AddrSpaceCastInst(NewGEP, GEP.getType());
1304       }
1305
1306       // Transform things like:
1307       // %V = mul i64 %N, 4
1308       // %t = getelementptr i8* bitcast (i32* %arr to i8*), i32 %V
1309       // into:  %t1 = getelementptr i32* %arr, i32 %N; bitcast
1310       if (DL && ResElTy->isSized() && SrcElTy->isSized()) {
1311         // Check that changing the type amounts to dividing the index by a scale
1312         // factor.
1313         uint64_t ResSize = DL->getTypeAllocSize(ResElTy);
1314         uint64_t SrcSize = DL->getTypeAllocSize(SrcElTy);
1315         if (ResSize && SrcSize % ResSize == 0) {
1316           Value *Idx = GEP.getOperand(1);
1317           unsigned BitWidth = Idx->getType()->getPrimitiveSizeInBits();
1318           uint64_t Scale = SrcSize / ResSize;
1319
1320           // Earlier transforms ensure that the index has type IntPtrType, which
1321           // considerably simplifies the logic by eliminating implicit casts.
1322           assert(Idx->getType() == DL->getIntPtrType(GEP.getType()) &&
1323                  "Index not cast to pointer width?");
1324
1325           bool NSW;
1326           if (Value *NewIdx = Descale(Idx, APInt(BitWidth, Scale), NSW)) {
1327             // Successfully decomposed Idx as NewIdx * Scale, form a new GEP.
1328             // If the multiplication NewIdx * Scale may overflow then the new
1329             // GEP may not be "inbounds".
1330             Value *NewGEP = GEP.isInBounds() && NSW ?
1331               Builder->CreateInBoundsGEP(StrippedPtr, NewIdx, GEP.getName()) :
1332               Builder->CreateGEP(StrippedPtr, NewIdx, GEP.getName());
1333
1334             // The NewGEP must be pointer typed, so must the old one -> BitCast
1335             if (StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace())
1336               return new BitCastInst(NewGEP, GEP.getType());
1337             return new AddrSpaceCastInst(NewGEP, GEP.getType());
1338           }
1339         }
1340       }
1341
1342       // Similarly, transform things like:
1343       // getelementptr i8* bitcast ([100 x double]* X to i8*), i32 %tmp
1344       //   (where tmp = 8*tmp2) into:
1345       // getelementptr [100 x double]* %arr, i32 0, i32 %tmp2; bitcast
1346       if (DL && ResElTy->isSized() && SrcElTy->isSized() &&
1347           SrcElTy->isArrayTy()) {
1348         // Check that changing to the array element type amounts to dividing the
1349         // index by a scale factor.
1350         uint64_t ResSize = DL->getTypeAllocSize(ResElTy);
1351         uint64_t ArrayEltSize
1352           = DL->getTypeAllocSize(SrcElTy->getArrayElementType());
1353         if (ResSize && ArrayEltSize % ResSize == 0) {
1354           Value *Idx = GEP.getOperand(1);
1355           unsigned BitWidth = Idx->getType()->getPrimitiveSizeInBits();
1356           uint64_t Scale = ArrayEltSize / ResSize;
1357
1358           // Earlier transforms ensure that the index has type IntPtrType, which
1359           // considerably simplifies the logic by eliminating implicit casts.
1360           assert(Idx->getType() == DL->getIntPtrType(GEP.getType()) &&
1361                  "Index not cast to pointer width?");
1362
1363           bool NSW;
1364           if (Value *NewIdx = Descale(Idx, APInt(BitWidth, Scale), NSW)) {
1365             // Successfully decomposed Idx as NewIdx * Scale, form a new GEP.
1366             // If the multiplication NewIdx * Scale may overflow then the new
1367             // GEP may not be "inbounds".
1368             Value *Off[2] = {
1369               Constant::getNullValue(DL->getIntPtrType(GEP.getType())),
1370               NewIdx
1371             };
1372
1373             Value *NewGEP = GEP.isInBounds() && NSW ?
1374               Builder->CreateInBoundsGEP(StrippedPtr, Off, GEP.getName()) :
1375               Builder->CreateGEP(StrippedPtr, Off, GEP.getName());
1376             // The NewGEP must be pointer typed, so must the old one -> BitCast
1377             if (StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace())
1378               return new BitCastInst(NewGEP, GEP.getType());
1379             return new AddrSpaceCastInst(NewGEP, GEP.getType());
1380           }
1381         }
1382       }
1383     }
1384   }
1385
1386   if (!DL)
1387     return 0;
1388
1389   /// See if we can simplify:
1390   ///   X = bitcast A* to B*
1391   ///   Y = gep X, <...constant indices...>
1392   /// into a gep of the original struct.  This is important for SROA and alias
1393   /// analysis of unions.  If "A" is also a bitcast, wait for A/X to be merged.
1394   if (BitCastInst *BCI = dyn_cast<BitCastInst>(PtrOp)) {
1395     Value *Operand = BCI->getOperand(0);
1396     PointerType *OpType = cast<PointerType>(Operand->getType());
1397     unsigned OffsetBits = DL->getPointerTypeSizeInBits(OpType);
1398     APInt Offset(OffsetBits, 0);
1399     if (!isa<BitCastInst>(Operand) &&
1400         GEP.accumulateConstantOffset(*DL, Offset) &&
1401         StrippedPtrTy->getAddressSpace() == GEP.getPointerAddressSpace()) {
1402
1403       // If this GEP instruction doesn't move the pointer, just replace the GEP
1404       // with a bitcast of the real input to the dest type.
1405       if (!Offset) {
1406         // If the bitcast is of an allocation, and the allocation will be
1407         // converted to match the type of the cast, don't touch this.
1408         if (isa<AllocaInst>(Operand) || isAllocationFn(Operand, TLI)) {
1409           // See if the bitcast simplifies, if so, don't nuke this GEP yet.
1410           if (Instruction *I = visitBitCast(*BCI)) {
1411             if (I != BCI) {
1412               I->takeName(BCI);
1413               BCI->getParent()->getInstList().insert(BCI, I);
1414               ReplaceInstUsesWith(*BCI, I);
1415             }
1416             return &GEP;
1417           }
1418         }
1419         return new BitCastInst(Operand, GEP.getType());
1420       }
1421
1422       // Otherwise, if the offset is non-zero, we need to find out if there is a
1423       // field at Offset in 'A's type.  If so, we can pull the cast through the
1424       // GEP.
1425       SmallVector<Value*, 8> NewIndices;
1426       if (FindElementAtOffset(OpType, Offset.getSExtValue(), NewIndices)) {
1427         Value *NGEP = GEP.isInBounds() ?
1428           Builder->CreateInBoundsGEP(Operand, NewIndices) :
1429           Builder->CreateGEP(Operand, NewIndices);
1430
1431         if (NGEP->getType() == GEP.getType())
1432           return ReplaceInstUsesWith(GEP, NGEP);
1433         NGEP->takeName(&GEP);
1434         return new BitCastInst(NGEP, GEP.getType());
1435       }
1436     }
1437   }
1438
1439   return 0;
1440 }
1441
1442 static bool
1443 isAllocSiteRemovable(Instruction *AI, SmallVectorImpl<WeakVH> &Users,
1444                      const TargetLibraryInfo *TLI) {
1445   SmallVector<Instruction*, 4> Worklist;
1446   Worklist.push_back(AI);
1447
1448   do {
1449     Instruction *PI = Worklist.pop_back_val();
1450     for (User *U : PI->users()) {
1451       Instruction *I = cast<Instruction>(U);
1452       switch (I->getOpcode()) {
1453       default:
1454         // Give up the moment we see something we can't handle.
1455         return false;
1456
1457       case Instruction::BitCast:
1458       case Instruction::GetElementPtr:
1459         Users.push_back(I);
1460         Worklist.push_back(I);
1461         continue;
1462
1463       case Instruction::ICmp: {
1464         ICmpInst *ICI = cast<ICmpInst>(I);
1465         // We can fold eq/ne comparisons with null to false/true, respectively.
1466         if (!ICI->isEquality() || !isa<ConstantPointerNull>(ICI->getOperand(1)))
1467           return false;
1468         Users.push_back(I);
1469         continue;
1470       }
1471
1472       case Instruction::Call:
1473         // Ignore no-op and store intrinsics.
1474         if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
1475           switch (II->getIntrinsicID()) {
1476           default:
1477             return false;
1478
1479           case Intrinsic::memmove:
1480           case Intrinsic::memcpy:
1481           case Intrinsic::memset: {
1482             MemIntrinsic *MI = cast<MemIntrinsic>(II);
1483             if (MI->isVolatile() || MI->getRawDest() != PI)
1484               return false;
1485           }
1486           // fall through
1487           case Intrinsic::dbg_declare:
1488           case Intrinsic::dbg_value:
1489           case Intrinsic::invariant_start:
1490           case Intrinsic::invariant_end:
1491           case Intrinsic::lifetime_start:
1492           case Intrinsic::lifetime_end:
1493           case Intrinsic::objectsize:
1494             Users.push_back(I);
1495             continue;
1496           }
1497         }
1498
1499         if (isFreeCall(I, TLI)) {
1500           Users.push_back(I);
1501           continue;
1502         }
1503         return false;
1504
1505       case Instruction::Store: {
1506         StoreInst *SI = cast<StoreInst>(I);
1507         if (SI->isVolatile() || SI->getPointerOperand() != PI)
1508           return false;
1509         Users.push_back(I);
1510         continue;
1511       }
1512       }
1513       llvm_unreachable("missing a return?");
1514     }
1515   } while (!Worklist.empty());
1516   return true;
1517 }
1518
1519 Instruction *InstCombiner::visitAllocSite(Instruction &MI) {
1520   // If we have a malloc call which is only used in any amount of comparisons
1521   // to null and free calls, delete the calls and replace the comparisons with
1522   // true or false as appropriate.
1523   SmallVector<WeakVH, 64> Users;
1524   if (isAllocSiteRemovable(&MI, Users, TLI)) {
1525     for (unsigned i = 0, e = Users.size(); i != e; ++i) {
1526       Instruction *I = cast_or_null<Instruction>(&*Users[i]);
1527       if (!I) continue;
1528
1529       if (ICmpInst *C = dyn_cast<ICmpInst>(I)) {
1530         ReplaceInstUsesWith(*C,
1531                             ConstantInt::get(Type::getInt1Ty(C->getContext()),
1532                                              C->isFalseWhenEqual()));
1533       } else if (isa<BitCastInst>(I) || isa<GetElementPtrInst>(I)) {
1534         ReplaceInstUsesWith(*I, UndefValue::get(I->getType()));
1535       } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
1536         if (II->getIntrinsicID() == Intrinsic::objectsize) {
1537           ConstantInt *CI = cast<ConstantInt>(II->getArgOperand(1));
1538           uint64_t DontKnow = CI->isZero() ? -1ULL : 0;
1539           ReplaceInstUsesWith(*I, ConstantInt::get(I->getType(), DontKnow));
1540         }
1541       }
1542       EraseInstFromFunction(*I);
1543     }
1544
1545     if (InvokeInst *II = dyn_cast<InvokeInst>(&MI)) {
1546       // Replace invoke with a NOP intrinsic to maintain the original CFG
1547       Module *M = II->getParent()->getParent()->getParent();
1548       Function *F = Intrinsic::getDeclaration(M, Intrinsic::donothing);
1549       InvokeInst::Create(F, II->getNormalDest(), II->getUnwindDest(),
1550                          None, "", II->getParent());
1551     }
1552     return EraseInstFromFunction(MI);
1553   }
1554   return 0;
1555 }
1556
1557 /// \brief Move the call to free before a NULL test.
1558 ///
1559 /// Check if this free is accessed after its argument has been test
1560 /// against NULL (property 0).
1561 /// If yes, it is legal to move this call in its predecessor block.
1562 ///
1563 /// The move is performed only if the block containing the call to free
1564 /// will be removed, i.e.:
1565 /// 1. it has only one predecessor P, and P has two successors
1566 /// 2. it contains the call and an unconditional branch
1567 /// 3. its successor is the same as its predecessor's successor
1568 ///
1569 /// The profitability is out-of concern here and this function should
1570 /// be called only if the caller knows this transformation would be
1571 /// profitable (e.g., for code size).
1572 static Instruction *
1573 tryToMoveFreeBeforeNullTest(CallInst &FI) {
1574   Value *Op = FI.getArgOperand(0);
1575   BasicBlock *FreeInstrBB = FI.getParent();
1576   BasicBlock *PredBB = FreeInstrBB->getSinglePredecessor();
1577
1578   // Validate part of constraint #1: Only one predecessor
1579   // FIXME: We can extend the number of predecessor, but in that case, we
1580   //        would duplicate the call to free in each predecessor and it may
1581   //        not be profitable even for code size.
1582   if (!PredBB)
1583     return 0;
1584
1585   // Validate constraint #2: Does this block contains only the call to
1586   //                         free and an unconditional branch?
1587   // FIXME: We could check if we can speculate everything in the
1588   //        predecessor block
1589   if (FreeInstrBB->size() != 2)
1590     return 0;
1591   BasicBlock *SuccBB;
1592   if (!match(FreeInstrBB->getTerminator(), m_UnconditionalBr(SuccBB)))
1593     return 0;
1594
1595   // Validate the rest of constraint #1 by matching on the pred branch.
1596   TerminatorInst *TI = PredBB->getTerminator();
1597   BasicBlock *TrueBB, *FalseBB;
1598   ICmpInst::Predicate Pred;
1599   if (!match(TI, m_Br(m_ICmp(Pred, m_Specific(Op), m_Zero()), TrueBB, FalseBB)))
1600     return 0;
1601   if (Pred != ICmpInst::ICMP_EQ && Pred != ICmpInst::ICMP_NE)
1602     return 0;
1603
1604   // Validate constraint #3: Ensure the null case just falls through.
1605   if (SuccBB != (Pred == ICmpInst::ICMP_EQ ? TrueBB : FalseBB))
1606     return 0;
1607   assert(FreeInstrBB == (Pred == ICmpInst::ICMP_EQ ? FalseBB : TrueBB) &&
1608          "Broken CFG: missing edge from predecessor to successor");
1609
1610   FI.moveBefore(TI);
1611   return &FI;
1612 }
1613
1614
1615 Instruction *InstCombiner::visitFree(CallInst &FI) {
1616   Value *Op = FI.getArgOperand(0);
1617
1618   // free undef -> unreachable.
1619   if (isa<UndefValue>(Op)) {
1620     // Insert a new store to null because we cannot modify the CFG here.
1621     Builder->CreateStore(ConstantInt::getTrue(FI.getContext()),
1622                          UndefValue::get(Type::getInt1PtrTy(FI.getContext())));
1623     return EraseInstFromFunction(FI);
1624   }
1625
1626   // If we have 'free null' delete the instruction.  This can happen in stl code
1627   // when lots of inlining happens.
1628   if (isa<ConstantPointerNull>(Op))
1629     return EraseInstFromFunction(FI);
1630
1631   // If we optimize for code size, try to move the call to free before the null
1632   // test so that simplify cfg can remove the empty block and dead code
1633   // elimination the branch. I.e., helps to turn something like:
1634   // if (foo) free(foo);
1635   // into
1636   // free(foo);
1637   if (MinimizeSize)
1638     if (Instruction *I = tryToMoveFreeBeforeNullTest(FI))
1639       return I;
1640
1641   return 0;
1642 }
1643
1644
1645
1646 Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
1647   // Change br (not X), label True, label False to: br X, label False, True
1648   Value *X = 0;
1649   BasicBlock *TrueDest;
1650   BasicBlock *FalseDest;
1651   if (match(&BI, m_Br(m_Not(m_Value(X)), TrueDest, FalseDest)) &&
1652       !isa<Constant>(X)) {
1653     // Swap Destinations and condition...
1654     BI.setCondition(X);
1655     BI.swapSuccessors();
1656     return &BI;
1657   }
1658
1659   // Canonicalize fcmp_one -> fcmp_oeq
1660   FCmpInst::Predicate FPred; Value *Y;
1661   if (match(&BI, m_Br(m_FCmp(FPred, m_Value(X), m_Value(Y)),
1662                              TrueDest, FalseDest)) &&
1663       BI.getCondition()->hasOneUse())
1664     if (FPred == FCmpInst::FCMP_ONE || FPred == FCmpInst::FCMP_OLE ||
1665         FPred == FCmpInst::FCMP_OGE) {
1666       FCmpInst *Cond = cast<FCmpInst>(BI.getCondition());
1667       Cond->setPredicate(FCmpInst::getInversePredicate(FPred));
1668
1669       // Swap Destinations and condition.
1670       BI.swapSuccessors();
1671       Worklist.Add(Cond);
1672       return &BI;
1673     }
1674
1675   // Canonicalize icmp_ne -> icmp_eq
1676   ICmpInst::Predicate IPred;
1677   if (match(&BI, m_Br(m_ICmp(IPred, m_Value(X), m_Value(Y)),
1678                       TrueDest, FalseDest)) &&
1679       BI.getCondition()->hasOneUse())
1680     if (IPred == ICmpInst::ICMP_NE  || IPred == ICmpInst::ICMP_ULE ||
1681         IPred == ICmpInst::ICMP_SLE || IPred == ICmpInst::ICMP_UGE ||
1682         IPred == ICmpInst::ICMP_SGE) {
1683       ICmpInst *Cond = cast<ICmpInst>(BI.getCondition());
1684       Cond->setPredicate(ICmpInst::getInversePredicate(IPred));
1685       // Swap Destinations and condition.
1686       BI.swapSuccessors();
1687       Worklist.Add(Cond);
1688       return &BI;
1689     }
1690
1691   return 0;
1692 }
1693
1694 Instruction *InstCombiner::visitSwitchInst(SwitchInst &SI) {
1695   Value *Cond = SI.getCondition();
1696   if (Instruction *I = dyn_cast<Instruction>(Cond)) {
1697     if (I->getOpcode() == Instruction::Add)
1698       if (ConstantInt *AddRHS = dyn_cast<ConstantInt>(I->getOperand(1))) {
1699         // change 'switch (X+4) case 1:' into 'switch (X) case -3'
1700         // Skip the first item since that's the default case.
1701         for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end();
1702              i != e; ++i) {
1703           ConstantInt* CaseVal = i.getCaseValue();
1704           Constant* NewCaseVal = ConstantExpr::getSub(cast<Constant>(CaseVal),
1705                                                       AddRHS);
1706           assert(isa<ConstantInt>(NewCaseVal) &&
1707                  "Result of expression should be constant");
1708           i.setValue(cast<ConstantInt>(NewCaseVal));
1709         }
1710         SI.setCondition(I->getOperand(0));
1711         Worklist.Add(I);
1712         return &SI;
1713       }
1714   }
1715   return 0;
1716 }
1717
1718 Instruction *InstCombiner::visitExtractValueInst(ExtractValueInst &EV) {
1719   Value *Agg = EV.getAggregateOperand();
1720
1721   if (!EV.hasIndices())
1722     return ReplaceInstUsesWith(EV, Agg);
1723
1724   if (Constant *C = dyn_cast<Constant>(Agg)) {
1725     if (Constant *C2 = C->getAggregateElement(*EV.idx_begin())) {
1726       if (EV.getNumIndices() == 0)
1727         return ReplaceInstUsesWith(EV, C2);
1728       // Extract the remaining indices out of the constant indexed by the
1729       // first index
1730       return ExtractValueInst::Create(C2, EV.getIndices().slice(1));
1731     }
1732     return 0; // Can't handle other constants
1733   }
1734
1735   if (InsertValueInst *IV = dyn_cast<InsertValueInst>(Agg)) {
1736     // We're extracting from an insertvalue instruction, compare the indices
1737     const unsigned *exti, *exte, *insi, *inse;
1738     for (exti = EV.idx_begin(), insi = IV->idx_begin(),
1739          exte = EV.idx_end(), inse = IV->idx_end();
1740          exti != exte && insi != inse;
1741          ++exti, ++insi) {
1742       if (*insi != *exti)
1743         // The insert and extract both reference distinctly different elements.
1744         // This means the extract is not influenced by the insert, and we can
1745         // replace the aggregate operand of the extract with the aggregate
1746         // operand of the insert. i.e., replace
1747         // %I = insertvalue { i32, { i32 } } %A, { i32 } { i32 42 }, 1
1748         // %E = extractvalue { i32, { i32 } } %I, 0
1749         // with
1750         // %E = extractvalue { i32, { i32 } } %A, 0
1751         return ExtractValueInst::Create(IV->getAggregateOperand(),
1752                                         EV.getIndices());
1753     }
1754     if (exti == exte && insi == inse)
1755       // Both iterators are at the end: Index lists are identical. Replace
1756       // %B = insertvalue { i32, { i32 } } %A, i32 42, 1, 0
1757       // %C = extractvalue { i32, { i32 } } %B, 1, 0
1758       // with "i32 42"
1759       return ReplaceInstUsesWith(EV, IV->getInsertedValueOperand());
1760     if (exti == exte) {
1761       // The extract list is a prefix of the insert list. i.e. replace
1762       // %I = insertvalue { i32, { i32 } } %A, i32 42, 1, 0
1763       // %E = extractvalue { i32, { i32 } } %I, 1
1764       // with
1765       // %X = extractvalue { i32, { i32 } } %A, 1
1766       // %E = insertvalue { i32 } %X, i32 42, 0
1767       // by switching the order of the insert and extract (though the
1768       // insertvalue should be left in, since it may have other uses).
1769       Value *NewEV = Builder->CreateExtractValue(IV->getAggregateOperand(),
1770                                                  EV.getIndices());
1771       return InsertValueInst::Create(NewEV, IV->getInsertedValueOperand(),
1772                                      makeArrayRef(insi, inse));
1773     }
1774     if (insi == inse)
1775       // The insert list is a prefix of the extract list
1776       // We can simply remove the common indices from the extract and make it
1777       // operate on the inserted value instead of the insertvalue result.
1778       // i.e., replace
1779       // %I = insertvalue { i32, { i32 } } %A, { i32 } { i32 42 }, 1
1780       // %E = extractvalue { i32, { i32 } } %I, 1, 0
1781       // with
1782       // %E extractvalue { i32 } { i32 42 }, 0
1783       return ExtractValueInst::Create(IV->getInsertedValueOperand(),
1784                                       makeArrayRef(exti, exte));
1785   }
1786   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Agg)) {
1787     // We're extracting from an intrinsic, see if we're the only user, which
1788     // allows us to simplify multiple result intrinsics to simpler things that
1789     // just get one value.
1790     if (II->hasOneUse()) {
1791       // Check if we're grabbing the overflow bit or the result of a 'with
1792       // overflow' intrinsic.  If it's the latter we can remove the intrinsic
1793       // and replace it with a traditional binary instruction.
1794       switch (II->getIntrinsicID()) {
1795       case Intrinsic::uadd_with_overflow:
1796       case Intrinsic::sadd_with_overflow:
1797         if (*EV.idx_begin() == 0) {  // Normal result.
1798           Value *LHS = II->getArgOperand(0), *RHS = II->getArgOperand(1);
1799           ReplaceInstUsesWith(*II, UndefValue::get(II->getType()));
1800           EraseInstFromFunction(*II);
1801           return BinaryOperator::CreateAdd(LHS, RHS);
1802         }
1803
1804         // If the normal result of the add is dead, and the RHS is a constant,
1805         // we can transform this into a range comparison.
1806         // overflow = uadd a, -4  -->  overflow = icmp ugt a, 3
1807         if (II->getIntrinsicID() == Intrinsic::uadd_with_overflow)
1808           if (ConstantInt *CI = dyn_cast<ConstantInt>(II->getArgOperand(1)))
1809             return new ICmpInst(ICmpInst::ICMP_UGT, II->getArgOperand(0),
1810                                 ConstantExpr::getNot(CI));
1811         break;
1812       case Intrinsic::usub_with_overflow:
1813       case Intrinsic::ssub_with_overflow:
1814         if (*EV.idx_begin() == 0) {  // Normal result.
1815           Value *LHS = II->getArgOperand(0), *RHS = II->getArgOperand(1);
1816           ReplaceInstUsesWith(*II, UndefValue::get(II->getType()));
1817           EraseInstFromFunction(*II);
1818           return BinaryOperator::CreateSub(LHS, RHS);
1819         }
1820         break;
1821       case Intrinsic::umul_with_overflow:
1822       case Intrinsic::smul_with_overflow:
1823         if (*EV.idx_begin() == 0) {  // Normal result.
1824           Value *LHS = II->getArgOperand(0), *RHS = II->getArgOperand(1);
1825           ReplaceInstUsesWith(*II, UndefValue::get(II->getType()));
1826           EraseInstFromFunction(*II);
1827           return BinaryOperator::CreateMul(LHS, RHS);
1828         }
1829         break;
1830       default:
1831         break;
1832       }
1833     }
1834   }
1835   if (LoadInst *L = dyn_cast<LoadInst>(Agg))
1836     // If the (non-volatile) load only has one use, we can rewrite this to a
1837     // load from a GEP. This reduces the size of the load.
1838     // FIXME: If a load is used only by extractvalue instructions then this
1839     //        could be done regardless of having multiple uses.
1840     if (L->isSimple() && L->hasOneUse()) {
1841       // extractvalue has integer indices, getelementptr has Value*s. Convert.
1842       SmallVector<Value*, 4> Indices;
1843       // Prefix an i32 0 since we need the first element.
1844       Indices.push_back(Builder->getInt32(0));
1845       for (ExtractValueInst::idx_iterator I = EV.idx_begin(), E = EV.idx_end();
1846             I != E; ++I)
1847         Indices.push_back(Builder->getInt32(*I));
1848
1849       // We need to insert these at the location of the old load, not at that of
1850       // the extractvalue.
1851       Builder->SetInsertPoint(L->getParent(), L);
1852       Value *GEP = Builder->CreateInBoundsGEP(L->getPointerOperand(), Indices);
1853       // Returning the load directly will cause the main loop to insert it in
1854       // the wrong spot, so use ReplaceInstUsesWith().
1855       return ReplaceInstUsesWith(EV, Builder->CreateLoad(GEP));
1856     }
1857   // We could simplify extracts from other values. Note that nested extracts may
1858   // already be simplified implicitly by the above: extract (extract (insert) )
1859   // will be translated into extract ( insert ( extract ) ) first and then just
1860   // the value inserted, if appropriate. Similarly for extracts from single-use
1861   // loads: extract (extract (load)) will be translated to extract (load (gep))
1862   // and if again single-use then via load (gep (gep)) to load (gep).
1863   // However, double extracts from e.g. function arguments or return values
1864   // aren't handled yet.
1865   return 0;
1866 }
1867
1868 enum Personality_Type {
1869   Unknown_Personality,
1870   GNU_Ada_Personality,
1871   GNU_CXX_Personality,
1872   GNU_ObjC_Personality
1873 };
1874
1875 /// RecognizePersonality - See if the given exception handling personality
1876 /// function is one that we understand.  If so, return a description of it;
1877 /// otherwise return Unknown_Personality.
1878 static Personality_Type RecognizePersonality(Value *Pers) {
1879   Function *F = dyn_cast<Function>(Pers->stripPointerCasts());
1880   if (!F)
1881     return Unknown_Personality;
1882   return StringSwitch<Personality_Type>(F->getName())
1883     .Case("__gnat_eh_personality", GNU_Ada_Personality)
1884     .Case("__gxx_personality_v0",  GNU_CXX_Personality)
1885     .Case("__objc_personality_v0", GNU_ObjC_Personality)
1886     .Default(Unknown_Personality);
1887 }
1888
1889 /// isCatchAll - Return 'true' if the given typeinfo will match anything.
1890 static bool isCatchAll(Personality_Type Personality, Constant *TypeInfo) {
1891   switch (Personality) {
1892   case Unknown_Personality:
1893     return false;
1894   case GNU_Ada_Personality:
1895     // While __gnat_all_others_value will match any Ada exception, it doesn't
1896     // match foreign exceptions (or didn't, before gcc-4.7).
1897     return false;
1898   case GNU_CXX_Personality:
1899   case GNU_ObjC_Personality:
1900     return TypeInfo->isNullValue();
1901   }
1902   llvm_unreachable("Unknown personality!");
1903 }
1904
1905 static bool shorter_filter(const Value *LHS, const Value *RHS) {
1906   return
1907     cast<ArrayType>(LHS->getType())->getNumElements()
1908   <
1909     cast<ArrayType>(RHS->getType())->getNumElements();
1910 }
1911
1912 Instruction *InstCombiner::visitLandingPadInst(LandingPadInst &LI) {
1913   // The logic here should be correct for any real-world personality function.
1914   // However if that turns out not to be true, the offending logic can always
1915   // be conditioned on the personality function, like the catch-all logic is.
1916   Personality_Type Personality = RecognizePersonality(LI.getPersonalityFn());
1917
1918   // Simplify the list of clauses, eg by removing repeated catch clauses
1919   // (these are often created by inlining).
1920   bool MakeNewInstruction = false; // If true, recreate using the following:
1921   SmallVector<Value *, 16> NewClauses; // - Clauses for the new instruction;
1922   bool CleanupFlag = LI.isCleanup();   // - The new instruction is a cleanup.
1923
1924   SmallPtrSet<Value *, 16> AlreadyCaught; // Typeinfos known caught already.
1925   for (unsigned i = 0, e = LI.getNumClauses(); i != e; ++i) {
1926     bool isLastClause = i + 1 == e;
1927     if (LI.isCatch(i)) {
1928       // A catch clause.
1929       Value *CatchClause = LI.getClause(i);
1930       Constant *TypeInfo = cast<Constant>(CatchClause->stripPointerCasts());
1931
1932       // If we already saw this clause, there is no point in having a second
1933       // copy of it.
1934       if (AlreadyCaught.insert(TypeInfo)) {
1935         // This catch clause was not already seen.
1936         NewClauses.push_back(CatchClause);
1937       } else {
1938         // Repeated catch clause - drop the redundant copy.
1939         MakeNewInstruction = true;
1940       }
1941
1942       // If this is a catch-all then there is no point in keeping any following
1943       // clauses or marking the landingpad as having a cleanup.
1944       if (isCatchAll(Personality, TypeInfo)) {
1945         if (!isLastClause)
1946           MakeNewInstruction = true;
1947         CleanupFlag = false;
1948         break;
1949       }
1950     } else {
1951       // A filter clause.  If any of the filter elements were already caught
1952       // then they can be dropped from the filter.  It is tempting to try to
1953       // exploit the filter further by saying that any typeinfo that does not
1954       // occur in the filter can't be caught later (and thus can be dropped).
1955       // However this would be wrong, since typeinfos can match without being
1956       // equal (for example if one represents a C++ class, and the other some
1957       // class derived from it).
1958       assert(LI.isFilter(i) && "Unsupported landingpad clause!");
1959       Value *FilterClause = LI.getClause(i);
1960       ArrayType *FilterType = cast<ArrayType>(FilterClause->getType());
1961       unsigned NumTypeInfos = FilterType->getNumElements();
1962
1963       // An empty filter catches everything, so there is no point in keeping any
1964       // following clauses or marking the landingpad as having a cleanup.  By
1965       // dealing with this case here the following code is made a bit simpler.
1966       if (!NumTypeInfos) {
1967         NewClauses.push_back(FilterClause);
1968         if (!isLastClause)
1969           MakeNewInstruction = true;
1970         CleanupFlag = false;
1971         break;
1972       }
1973
1974       bool MakeNewFilter = false; // If true, make a new filter.
1975       SmallVector<Constant *, 16> NewFilterElts; // New elements.
1976       if (isa<ConstantAggregateZero>(FilterClause)) {
1977         // Not an empty filter - it contains at least one null typeinfo.
1978         assert(NumTypeInfos > 0 && "Should have handled empty filter already!");
1979         Constant *TypeInfo =
1980           Constant::getNullValue(FilterType->getElementType());
1981         // If this typeinfo is a catch-all then the filter can never match.
1982         if (isCatchAll(Personality, TypeInfo)) {
1983           // Throw the filter away.
1984           MakeNewInstruction = true;
1985           continue;
1986         }
1987
1988         // There is no point in having multiple copies of this typeinfo, so
1989         // discard all but the first copy if there is more than one.
1990         NewFilterElts.push_back(TypeInfo);
1991         if (NumTypeInfos > 1)
1992           MakeNewFilter = true;
1993       } else {
1994         ConstantArray *Filter = cast<ConstantArray>(FilterClause);
1995         SmallPtrSet<Value *, 16> SeenInFilter; // For uniquing the elements.
1996         NewFilterElts.reserve(NumTypeInfos);
1997
1998         // Remove any filter elements that were already caught or that already
1999         // occurred in the filter.  While there, see if any of the elements are
2000         // catch-alls.  If so, the filter can be discarded.
2001         bool SawCatchAll = false;
2002         for (unsigned j = 0; j != NumTypeInfos; ++j) {
2003           Value *Elt = Filter->getOperand(j);
2004           Constant *TypeInfo = cast<Constant>(Elt->stripPointerCasts());
2005           if (isCatchAll(Personality, TypeInfo)) {
2006             // This element is a catch-all.  Bail out, noting this fact.
2007             SawCatchAll = true;
2008             break;
2009           }
2010           if (AlreadyCaught.count(TypeInfo))
2011             // Already caught by an earlier clause, so having it in the filter
2012             // is pointless.
2013             continue;
2014           // There is no point in having multiple copies of the same typeinfo in
2015           // a filter, so only add it if we didn't already.
2016           if (SeenInFilter.insert(TypeInfo))
2017             NewFilterElts.push_back(cast<Constant>(Elt));
2018         }
2019         // A filter containing a catch-all cannot match anything by definition.
2020         if (SawCatchAll) {
2021           // Throw the filter away.
2022           MakeNewInstruction = true;
2023           continue;
2024         }
2025
2026         // If we dropped something from the filter, make a new one.
2027         if (NewFilterElts.size() < NumTypeInfos)
2028           MakeNewFilter = true;
2029       }
2030       if (MakeNewFilter) {
2031         FilterType = ArrayType::get(FilterType->getElementType(),
2032                                     NewFilterElts.size());
2033         FilterClause = ConstantArray::get(FilterType, NewFilterElts);
2034         MakeNewInstruction = true;
2035       }
2036
2037       NewClauses.push_back(FilterClause);
2038
2039       // If the new filter is empty then it will catch everything so there is
2040       // no point in keeping any following clauses or marking the landingpad
2041       // as having a cleanup.  The case of the original filter being empty was
2042       // already handled above.
2043       if (MakeNewFilter && !NewFilterElts.size()) {
2044         assert(MakeNewInstruction && "New filter but not a new instruction!");
2045         CleanupFlag = false;
2046         break;
2047       }
2048     }
2049   }
2050
2051   // If several filters occur in a row then reorder them so that the shortest
2052   // filters come first (those with the smallest number of elements).  This is
2053   // advantageous because shorter filters are more likely to match, speeding up
2054   // unwinding, but mostly because it increases the effectiveness of the other
2055   // filter optimizations below.
2056   for (unsigned i = 0, e = NewClauses.size(); i + 1 < e; ) {
2057     unsigned j;
2058     // Find the maximal 'j' s.t. the range [i, j) consists entirely of filters.
2059     for (j = i; j != e; ++j)
2060       if (!isa<ArrayType>(NewClauses[j]->getType()))
2061         break;
2062
2063     // Check whether the filters are already sorted by length.  We need to know
2064     // if sorting them is actually going to do anything so that we only make a
2065     // new landingpad instruction if it does.
2066     for (unsigned k = i; k + 1 < j; ++k)
2067       if (shorter_filter(NewClauses[k+1], NewClauses[k])) {
2068         // Not sorted, so sort the filters now.  Doing an unstable sort would be
2069         // correct too but reordering filters pointlessly might confuse users.
2070         std::stable_sort(NewClauses.begin() + i, NewClauses.begin() + j,
2071                          shorter_filter);
2072         MakeNewInstruction = true;
2073         break;
2074       }
2075
2076     // Look for the next batch of filters.
2077     i = j + 1;
2078   }
2079
2080   // If typeinfos matched if and only if equal, then the elements of a filter L
2081   // that occurs later than a filter F could be replaced by the intersection of
2082   // the elements of F and L.  In reality two typeinfos can match without being
2083   // equal (for example if one represents a C++ class, and the other some class
2084   // derived from it) so it would be wrong to perform this transform in general.
2085   // However the transform is correct and useful if F is a subset of L.  In that
2086   // case L can be replaced by F, and thus removed altogether since repeating a
2087   // filter is pointless.  So here we look at all pairs of filters F and L where
2088   // L follows F in the list of clauses, and remove L if every element of F is
2089   // an element of L.  This can occur when inlining C++ functions with exception
2090   // specifications.
2091   for (unsigned i = 0; i + 1 < NewClauses.size(); ++i) {
2092     // Examine each filter in turn.
2093     Value *Filter = NewClauses[i];
2094     ArrayType *FTy = dyn_cast<ArrayType>(Filter->getType());
2095     if (!FTy)
2096       // Not a filter - skip it.
2097       continue;
2098     unsigned FElts = FTy->getNumElements();
2099     // Examine each filter following this one.  Doing this backwards means that
2100     // we don't have to worry about filters disappearing under us when removed.
2101     for (unsigned j = NewClauses.size() - 1; j != i; --j) {
2102       Value *LFilter = NewClauses[j];
2103       ArrayType *LTy = dyn_cast<ArrayType>(LFilter->getType());
2104       if (!LTy)
2105         // Not a filter - skip it.
2106         continue;
2107       // If Filter is a subset of LFilter, i.e. every element of Filter is also
2108       // an element of LFilter, then discard LFilter.
2109       SmallVectorImpl<Value *>::iterator J = NewClauses.begin() + j;
2110       // If Filter is empty then it is a subset of LFilter.
2111       if (!FElts) {
2112         // Discard LFilter.
2113         NewClauses.erase(J);
2114         MakeNewInstruction = true;
2115         // Move on to the next filter.
2116         continue;
2117       }
2118       unsigned LElts = LTy->getNumElements();
2119       // If Filter is longer than LFilter then it cannot be a subset of it.
2120       if (FElts > LElts)
2121         // Move on to the next filter.
2122         continue;
2123       // At this point we know that LFilter has at least one element.
2124       if (isa<ConstantAggregateZero>(LFilter)) { // LFilter only contains zeros.
2125         // Filter is a subset of LFilter iff Filter contains only zeros (as we
2126         // already know that Filter is not longer than LFilter).
2127         if (isa<ConstantAggregateZero>(Filter)) {
2128           assert(FElts <= LElts && "Should have handled this case earlier!");
2129           // Discard LFilter.
2130           NewClauses.erase(J);
2131           MakeNewInstruction = true;
2132         }
2133         // Move on to the next filter.
2134         continue;
2135       }
2136       ConstantArray *LArray = cast<ConstantArray>(LFilter);
2137       if (isa<ConstantAggregateZero>(Filter)) { // Filter only contains zeros.
2138         // Since Filter is non-empty and contains only zeros, it is a subset of
2139         // LFilter iff LFilter contains a zero.
2140         assert(FElts > 0 && "Should have eliminated the empty filter earlier!");
2141         for (unsigned l = 0; l != LElts; ++l)
2142           if (LArray->getOperand(l)->isNullValue()) {
2143             // LFilter contains a zero - discard it.
2144             NewClauses.erase(J);
2145             MakeNewInstruction = true;
2146             break;
2147           }
2148         // Move on to the next filter.
2149         continue;
2150       }
2151       // At this point we know that both filters are ConstantArrays.  Loop over
2152       // operands to see whether every element of Filter is also an element of
2153       // LFilter.  Since filters tend to be short this is probably faster than
2154       // using a method that scales nicely.
2155       ConstantArray *FArray = cast<ConstantArray>(Filter);
2156       bool AllFound = true;
2157       for (unsigned f = 0; f != FElts; ++f) {
2158         Value *FTypeInfo = FArray->getOperand(f)->stripPointerCasts();
2159         AllFound = false;
2160         for (unsigned l = 0; l != LElts; ++l) {
2161           Value *LTypeInfo = LArray->getOperand(l)->stripPointerCasts();
2162           if (LTypeInfo == FTypeInfo) {
2163             AllFound = true;
2164             break;
2165           }
2166         }
2167         if (!AllFound)
2168           break;
2169       }
2170       if (AllFound) {
2171         // Discard LFilter.
2172         NewClauses.erase(J);
2173         MakeNewInstruction = true;
2174       }
2175       // Move on to the next filter.
2176     }
2177   }
2178
2179   // If we changed any of the clauses, replace the old landingpad instruction
2180   // with a new one.
2181   if (MakeNewInstruction) {
2182     LandingPadInst *NLI = LandingPadInst::Create(LI.getType(),
2183                                                  LI.getPersonalityFn(),
2184                                                  NewClauses.size());
2185     for (unsigned i = 0, e = NewClauses.size(); i != e; ++i)
2186       NLI->addClause(NewClauses[i]);
2187     // A landing pad with no clauses must have the cleanup flag set.  It is
2188     // theoretically possible, though highly unlikely, that we eliminated all
2189     // clauses.  If so, force the cleanup flag to true.
2190     if (NewClauses.empty())
2191       CleanupFlag = true;
2192     NLI->setCleanup(CleanupFlag);
2193     return NLI;
2194   }
2195
2196   // Even if none of the clauses changed, we may nonetheless have understood
2197   // that the cleanup flag is pointless.  Clear it if so.
2198   if (LI.isCleanup() != CleanupFlag) {
2199     assert(!CleanupFlag && "Adding a cleanup, not removing one?!");
2200     LI.setCleanup(CleanupFlag);
2201     return &LI;
2202   }
2203
2204   return 0;
2205 }
2206
2207
2208
2209
2210 /// TryToSinkInstruction - Try to move the specified instruction from its
2211 /// current block into the beginning of DestBlock, which can only happen if it's
2212 /// safe to move the instruction past all of the instructions between it and the
2213 /// end of its block.
2214 static bool TryToSinkInstruction(Instruction *I, BasicBlock *DestBlock) {
2215   assert(I->hasOneUse() && "Invariants didn't hold!");
2216
2217   // Cannot move control-flow-involving, volatile loads, vaarg, etc.
2218   if (isa<PHINode>(I) || isa<LandingPadInst>(I) || I->mayHaveSideEffects() ||
2219       isa<TerminatorInst>(I))
2220     return false;
2221
2222   // Do not sink alloca instructions out of the entry block.
2223   if (isa<AllocaInst>(I) && I->getParent() ==
2224         &DestBlock->getParent()->getEntryBlock())
2225     return false;
2226
2227   // We can only sink load instructions if there is nothing between the load and
2228   // the end of block that could change the value.
2229   if (I->mayReadFromMemory()) {
2230     for (BasicBlock::iterator Scan = I, E = I->getParent()->end();
2231          Scan != E; ++Scan)
2232       if (Scan->mayWriteToMemory())
2233         return false;
2234   }
2235
2236   BasicBlock::iterator InsertPos = DestBlock->getFirstInsertionPt();
2237   I->moveBefore(InsertPos);
2238   ++NumSunkInst;
2239   return true;
2240 }
2241
2242
2243 /// AddReachableCodeToWorklist - Walk the function in depth-first order, adding
2244 /// all reachable code to the worklist.
2245 ///
2246 /// This has a couple of tricks to make the code faster and more powerful.  In
2247 /// particular, we constant fold and DCE instructions as we go, to avoid adding
2248 /// them to the worklist (this significantly speeds up instcombine on code where
2249 /// many instructions are dead or constant).  Additionally, if we find a branch
2250 /// whose condition is a known constant, we only visit the reachable successors.
2251 ///
2252 static bool AddReachableCodeToWorklist(BasicBlock *BB,
2253                                        SmallPtrSet<BasicBlock*, 64> &Visited,
2254                                        InstCombiner &IC,
2255                                        const DataLayout *DL,
2256                                        const TargetLibraryInfo *TLI) {
2257   bool MadeIRChange = false;
2258   SmallVector<BasicBlock*, 256> Worklist;
2259   Worklist.push_back(BB);
2260
2261   SmallVector<Instruction*, 128> InstrsForInstCombineWorklist;
2262   DenseMap<ConstantExpr*, Constant*> FoldedConstants;
2263
2264   do {
2265     BB = Worklist.pop_back_val();
2266
2267     // We have now visited this block!  If we've already been here, ignore it.
2268     if (!Visited.insert(BB)) continue;
2269
2270     for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ) {
2271       Instruction *Inst = BBI++;
2272
2273       // DCE instruction if trivially dead.
2274       if (isInstructionTriviallyDead(Inst, TLI)) {
2275         ++NumDeadInst;
2276         DEBUG(dbgs() << "IC: DCE: " << *Inst << '\n');
2277         Inst->eraseFromParent();
2278         continue;
2279       }
2280
2281       // ConstantProp instruction if trivially constant.
2282       if (!Inst->use_empty() && isa<Constant>(Inst->getOperand(0)))
2283         if (Constant *C = ConstantFoldInstruction(Inst, DL, TLI)) {
2284           DEBUG(dbgs() << "IC: ConstFold to: " << *C << " from: "
2285                        << *Inst << '\n');
2286           Inst->replaceAllUsesWith(C);
2287           ++NumConstProp;
2288           Inst->eraseFromParent();
2289           continue;
2290         }
2291
2292       if (DL) {
2293         // See if we can constant fold its operands.
2294         for (User::op_iterator i = Inst->op_begin(), e = Inst->op_end();
2295              i != e; ++i) {
2296           ConstantExpr *CE = dyn_cast<ConstantExpr>(i);
2297           if (CE == 0) continue;
2298
2299           Constant*& FoldRes = FoldedConstants[CE];
2300           if (!FoldRes)
2301             FoldRes = ConstantFoldConstantExpression(CE, DL, TLI);
2302           if (!FoldRes)
2303             FoldRes = CE;
2304
2305           if (FoldRes != CE) {
2306             *i = FoldRes;
2307             MadeIRChange = true;
2308           }
2309         }
2310       }
2311
2312       InstrsForInstCombineWorklist.push_back(Inst);
2313     }
2314
2315     // Recursively visit successors.  If this is a branch or switch on a
2316     // constant, only visit the reachable successor.
2317     TerminatorInst *TI = BB->getTerminator();
2318     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
2319       if (BI->isConditional() && isa<ConstantInt>(BI->getCondition())) {
2320         bool CondVal = cast<ConstantInt>(BI->getCondition())->getZExtValue();
2321         BasicBlock *ReachableBB = BI->getSuccessor(!CondVal);
2322         Worklist.push_back(ReachableBB);
2323         continue;
2324       }
2325     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
2326       if (ConstantInt *Cond = dyn_cast<ConstantInt>(SI->getCondition())) {
2327         // See if this is an explicit destination.
2328         for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
2329              i != e; ++i)
2330           if (i.getCaseValue() == Cond) {
2331             BasicBlock *ReachableBB = i.getCaseSuccessor();
2332             Worklist.push_back(ReachableBB);
2333             continue;
2334           }
2335
2336         // Otherwise it is the default destination.
2337         Worklist.push_back(SI->getDefaultDest());
2338         continue;
2339       }
2340     }
2341
2342     for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
2343       Worklist.push_back(TI->getSuccessor(i));
2344   } while (!Worklist.empty());
2345
2346   // Once we've found all of the instructions to add to instcombine's worklist,
2347   // add them in reverse order.  This way instcombine will visit from the top
2348   // of the function down.  This jives well with the way that it adds all uses
2349   // of instructions to the worklist after doing a transformation, thus avoiding
2350   // some N^2 behavior in pathological cases.
2351   IC.Worklist.AddInitialGroup(&InstrsForInstCombineWorklist[0],
2352                               InstrsForInstCombineWorklist.size());
2353
2354   return MadeIRChange;
2355 }
2356
2357 bool InstCombiner::DoOneIteration(Function &F, unsigned Iteration) {
2358   MadeIRChange = false;
2359
2360   DEBUG(dbgs() << "\n\nINSTCOMBINE ITERATION #" << Iteration << " on "
2361                << F.getName() << "\n");
2362
2363   {
2364     // Do a depth-first traversal of the function, populate the worklist with
2365     // the reachable instructions.  Ignore blocks that are not reachable.  Keep
2366     // track of which blocks we visit.
2367     SmallPtrSet<BasicBlock*, 64> Visited;
2368     MadeIRChange |= AddReachableCodeToWorklist(F.begin(), Visited, *this, DL,
2369                                                TLI);
2370
2371     // Do a quick scan over the function.  If we find any blocks that are
2372     // unreachable, remove any instructions inside of them.  This prevents
2373     // the instcombine code from having to deal with some bad special cases.
2374     for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
2375       if (Visited.count(BB)) continue;
2376
2377       // Delete the instructions backwards, as it has a reduced likelihood of
2378       // having to update as many def-use and use-def chains.
2379       Instruction *EndInst = BB->getTerminator(); // Last not to be deleted.
2380       while (EndInst != BB->begin()) {
2381         // Delete the next to last instruction.
2382         BasicBlock::iterator I = EndInst;
2383         Instruction *Inst = --I;
2384         if (!Inst->use_empty())
2385           Inst->replaceAllUsesWith(UndefValue::get(Inst->getType()));
2386         if (isa<LandingPadInst>(Inst)) {
2387           EndInst = Inst;
2388           continue;
2389         }
2390         if (!isa<DbgInfoIntrinsic>(Inst)) {
2391           ++NumDeadInst;
2392           MadeIRChange = true;
2393         }
2394         Inst->eraseFromParent();
2395       }
2396     }
2397   }
2398
2399   while (!Worklist.isEmpty()) {
2400     Instruction *I = Worklist.RemoveOne();
2401     if (I == 0) continue;  // skip null values.
2402
2403     // Check to see if we can DCE the instruction.
2404     if (isInstructionTriviallyDead(I, TLI)) {
2405       DEBUG(dbgs() << "IC: DCE: " << *I << '\n');
2406       EraseInstFromFunction(*I);
2407       ++NumDeadInst;
2408       MadeIRChange = true;
2409       continue;
2410     }
2411
2412     // Instruction isn't dead, see if we can constant propagate it.
2413     if (!I->use_empty() && isa<Constant>(I->getOperand(0)))
2414       if (Constant *C = ConstantFoldInstruction(I, DL, TLI)) {
2415         DEBUG(dbgs() << "IC: ConstFold to: " << *C << " from: " << *I << '\n');
2416
2417         // Add operands to the worklist.
2418         ReplaceInstUsesWith(*I, C);
2419         ++NumConstProp;
2420         EraseInstFromFunction(*I);
2421         MadeIRChange = true;
2422         continue;
2423       }
2424
2425     // See if we can trivially sink this instruction to a successor basic block.
2426     if (I->hasOneUse()) {
2427       BasicBlock *BB = I->getParent();
2428       Instruction *UserInst = cast<Instruction>(*I->user_begin());
2429       BasicBlock *UserParent;
2430
2431       // Get the block the use occurs in.
2432       if (PHINode *PN = dyn_cast<PHINode>(UserInst))
2433         UserParent = PN->getIncomingBlock(*I->use_begin());
2434       else
2435         UserParent = UserInst->getParent();
2436
2437       if (UserParent != BB) {
2438         bool UserIsSuccessor = false;
2439         // See if the user is one of our successors.
2440         for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
2441           if (*SI == UserParent) {
2442             UserIsSuccessor = true;
2443             break;
2444           }
2445
2446         // If the user is one of our immediate successors, and if that successor
2447         // only has us as a predecessors (we'd have to split the critical edge
2448         // otherwise), we can keep going.
2449         if (UserIsSuccessor && UserParent->getSinglePredecessor())
2450           // Okay, the CFG is simple enough, try to sink this instruction.
2451           MadeIRChange |= TryToSinkInstruction(I, UserParent);
2452       }
2453     }
2454
2455     // Now that we have an instruction, try combining it to simplify it.
2456     Builder->SetInsertPoint(I->getParent(), I);
2457     Builder->SetCurrentDebugLocation(I->getDebugLoc());
2458
2459 #ifndef NDEBUG
2460     std::string OrigI;
2461 #endif
2462     DEBUG(raw_string_ostream SS(OrigI); I->print(SS); OrigI = SS.str(););
2463     DEBUG(dbgs() << "IC: Visiting: " << OrigI << '\n');
2464
2465     if (Instruction *Result = visit(*I)) {
2466       ++NumCombined;
2467       // Should we replace the old instruction with a new one?
2468       if (Result != I) {
2469         DEBUG(dbgs() << "IC: Old = " << *I << '\n'
2470                      << "    New = " << *Result << '\n');
2471
2472         if (!I->getDebugLoc().isUnknown())
2473           Result->setDebugLoc(I->getDebugLoc());
2474         // Everything uses the new instruction now.
2475         I->replaceAllUsesWith(Result);
2476
2477         // Move the name to the new instruction first.
2478         Result->takeName(I);
2479
2480         // Push the new instruction and any users onto the worklist.
2481         Worklist.Add(Result);
2482         Worklist.AddUsersToWorkList(*Result);
2483
2484         // Insert the new instruction into the basic block...
2485         BasicBlock *InstParent = I->getParent();
2486         BasicBlock::iterator InsertPos = I;
2487
2488         // If we replace a PHI with something that isn't a PHI, fix up the
2489         // insertion point.
2490         if (!isa<PHINode>(Result) && isa<PHINode>(InsertPos))
2491           InsertPos = InstParent->getFirstInsertionPt();
2492
2493         InstParent->getInstList().insert(InsertPos, Result);
2494
2495         EraseInstFromFunction(*I);
2496       } else {
2497 #ifndef NDEBUG
2498         DEBUG(dbgs() << "IC: Mod = " << OrigI << '\n'
2499                      << "    New = " << *I << '\n');
2500 #endif
2501
2502         // If the instruction was modified, it's possible that it is now dead.
2503         // if so, remove it.
2504         if (isInstructionTriviallyDead(I, TLI)) {
2505           EraseInstFromFunction(*I);
2506         } else {
2507           Worklist.Add(I);
2508           Worklist.AddUsersToWorkList(*I);
2509         }
2510       }
2511       MadeIRChange = true;
2512     }
2513   }
2514
2515   Worklist.Zap();
2516   return MadeIRChange;
2517 }
2518
2519 namespace {
2520 class InstCombinerLibCallSimplifier : public LibCallSimplifier {
2521   InstCombiner *IC;
2522 public:
2523   InstCombinerLibCallSimplifier(const DataLayout *DL,
2524                                 const TargetLibraryInfo *TLI,
2525                                 InstCombiner *IC)
2526     : LibCallSimplifier(DL, TLI, UnsafeFPShrink) {
2527     this->IC = IC;
2528   }
2529
2530   /// replaceAllUsesWith - override so that instruction replacement
2531   /// can be defined in terms of the instruction combiner framework.
2532   void replaceAllUsesWith(Instruction *I, Value *With) const override {
2533     IC->ReplaceInstUsesWith(*I, With);
2534   }
2535 };
2536 }
2537
2538 bool InstCombiner::runOnFunction(Function &F) {
2539   if (skipOptnoneFunction(F))
2540     return false;
2541
2542   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
2543   DL = DLP ? &DLP->getDataLayout() : 0;
2544   TLI = &getAnalysis<TargetLibraryInfo>();
2545   // Minimizing size?
2546   MinimizeSize = F.getAttributes().hasAttribute(AttributeSet::FunctionIndex,
2547                                                 Attribute::MinSize);
2548
2549   /// Builder - This is an IRBuilder that automatically inserts new
2550   /// instructions into the worklist when they are created.
2551   IRBuilder<true, TargetFolder, InstCombineIRInserter>
2552     TheBuilder(F.getContext(), TargetFolder(DL),
2553                InstCombineIRInserter(Worklist));
2554   Builder = &TheBuilder;
2555
2556   InstCombinerLibCallSimplifier TheSimplifier(DL, TLI, this);
2557   Simplifier = &TheSimplifier;
2558
2559   bool EverMadeChange = false;
2560
2561   // Lower dbg.declare intrinsics otherwise their value may be clobbered
2562   // by instcombiner.
2563   EverMadeChange = LowerDbgDeclare(F);
2564
2565   // Iterate while there is work to do.
2566   unsigned Iteration = 0;
2567   while (DoOneIteration(F, Iteration++))
2568     EverMadeChange = true;
2569
2570   Builder = 0;
2571   return EverMadeChange;
2572 }
2573
2574 FunctionPass *llvm::createInstructionCombiningPass() {
2575   return new InstCombiner();
2576 }