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