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