1 //===- InstCombineCompares.cpp --------------------------------------------===//
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 // This file implements the visitICmp and visitFCmp functions.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "InstCombineInternal.h"
15 #include "llvm/ADT/APSInt.h"
16 #include "llvm/ADT/SetVector.h"
17 #include "llvm/ADT/Statistic.h"
18 #include "llvm/Analysis/ConstantFolding.h"
19 #include "llvm/Analysis/InstructionSimplify.h"
20 #include "llvm/Analysis/MemoryBuiltins.h"
21 #include "llvm/IR/ConstantRange.h"
22 #include "llvm/IR/DataLayout.h"
23 #include "llvm/IR/GetElementPtrTypeIterator.h"
24 #include "llvm/IR/IntrinsicInst.h"
25 #include "llvm/IR/PatternMatch.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Analysis/TargetLibraryInfo.h"
29 
30 using namespace llvm;
31 using namespace PatternMatch;
32 
33 #define DEBUG_TYPE "instcombine"
34 
35 // How many times is a select replaced by one of its operands?
36 STATISTIC(NumSel, "Number of select opts");
37 
38 // Initialization Routines
39 
40 static ConstantInt *getOne(Constant *C) {
41   return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
42 }
43 
44 static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
45   return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
46 }
47 
48 static bool HasAddOverflow(ConstantInt *Result,
49                            ConstantInt *In1, ConstantInt *In2,
50                            bool IsSigned) {
51   if (!IsSigned)
52     return Result->getValue().ult(In1->getValue());
53 
54   if (In2->isNegative())
55     return Result->getValue().sgt(In1->getValue());
56   return Result->getValue().slt(In1->getValue());
57 }
58 
59 /// AddWithOverflow - Compute Result = In1+In2, returning true if the result
60 /// overflowed for this type.
61 static bool AddWithOverflow(Constant *&Result, Constant *In1,
62                             Constant *In2, bool IsSigned = false) {
63   Result = ConstantExpr::getAdd(In1, In2);
64 
65   if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
66     for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
67       Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
68       if (HasAddOverflow(ExtractElement(Result, Idx),
69                          ExtractElement(In1, Idx),
70                          ExtractElement(In2, Idx),
71                          IsSigned))
72         return true;
73     }
74     return false;
75   }
76 
77   return HasAddOverflow(cast<ConstantInt>(Result),
78                         cast<ConstantInt>(In1), cast<ConstantInt>(In2),
79                         IsSigned);
80 }
81 
82 static bool HasSubOverflow(ConstantInt *Result,
83                            ConstantInt *In1, ConstantInt *In2,
84                            bool IsSigned) {
85   if (!IsSigned)
86     return Result->getValue().ugt(In1->getValue());
87 
88   if (In2->isNegative())
89     return Result->getValue().slt(In1->getValue());
90 
91   return Result->getValue().sgt(In1->getValue());
92 }
93 
94 /// SubWithOverflow - Compute Result = In1-In2, returning true if the result
95 /// overflowed for this type.
96 static bool SubWithOverflow(Constant *&Result, Constant *In1,
97                             Constant *In2, bool IsSigned = false) {
98   Result = ConstantExpr::getSub(In1, In2);
99 
100   if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
101     for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
102       Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
103       if (HasSubOverflow(ExtractElement(Result, Idx),
104                          ExtractElement(In1, Idx),
105                          ExtractElement(In2, Idx),
106                          IsSigned))
107         return true;
108     }
109     return false;
110   }
111 
112   return HasSubOverflow(cast<ConstantInt>(Result),
113                         cast<ConstantInt>(In1), cast<ConstantInt>(In2),
114                         IsSigned);
115 }
116 
117 /// isSignBitCheck - Given an exploded icmp instruction, return true if the
118 /// comparison only checks the sign bit.  If it only checks the sign bit, set
119 /// TrueIfSigned if the result of the comparison is true when the input value is
120 /// signed.
121 static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
122                            bool &TrueIfSigned) {
123   switch (pred) {
124   case ICmpInst::ICMP_SLT:   // True if LHS s< 0
125     TrueIfSigned = true;
126     return RHS->isZero();
127   case ICmpInst::ICMP_SLE:   // True if LHS s<= RHS and RHS == -1
128     TrueIfSigned = true;
129     return RHS->isAllOnesValue();
130   case ICmpInst::ICMP_SGT:   // True if LHS s> -1
131     TrueIfSigned = false;
132     return RHS->isAllOnesValue();
133   case ICmpInst::ICMP_UGT:
134     // True if LHS u> RHS and RHS == high-bit-mask - 1
135     TrueIfSigned = true;
136     return RHS->isMaxValue(true);
137   case ICmpInst::ICMP_UGE:
138     // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
139     TrueIfSigned = true;
140     return RHS->getValue().isSignBit();
141   default:
142     return false;
143   }
144 }
145 
146 /// Returns true if the exploded icmp can be expressed as a signed comparison
147 /// to zero and updates the predicate accordingly.
148 /// The signedness of the comparison is preserved.
149 static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
150   if (!ICmpInst::isSigned(pred))
151     return false;
152 
153   if (RHS->isZero())
154     return ICmpInst::isRelational(pred);
155 
156   if (RHS->isOne()) {
157     if (pred == ICmpInst::ICMP_SLT) {
158       pred = ICmpInst::ICMP_SLE;
159       return true;
160     }
161   } else if (RHS->isAllOnesValue()) {
162     if (pred == ICmpInst::ICMP_SGT) {
163       pred = ICmpInst::ICMP_SGE;
164       return true;
165     }
166   }
167 
168   return false;
169 }
170 
171 // isHighOnes - Return true if the constant is of the form 1+0+.
172 // This is the same as lowones(~X).
173 static bool isHighOnes(const ConstantInt *CI) {
174   return (~CI->getValue() + 1).isPowerOf2();
175 }
176 
177 /// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
178 /// set of known zero and one bits, compute the maximum and minimum values that
179 /// could have the specified known zero and known one bits, returning them in
180 /// min/max.
181 static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
182                                                    const APInt& KnownOne,
183                                                    APInt& Min, APInt& Max) {
184   assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
185          KnownZero.getBitWidth() == Min.getBitWidth() &&
186          KnownZero.getBitWidth() == Max.getBitWidth() &&
187          "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
188   APInt UnknownBits = ~(KnownZero|KnownOne);
189 
190   // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
191   // bit if it is unknown.
192   Min = KnownOne;
193   Max = KnownOne|UnknownBits;
194 
195   if (UnknownBits.isNegative()) { // Sign bit is unknown
196     Min.setBit(Min.getBitWidth()-1);
197     Max.clearBit(Max.getBitWidth()-1);
198   }
199 }
200 
201 // ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
202 // a set of known zero and one bits, compute the maximum and minimum values that
203 // could have the specified known zero and known one bits, returning them in
204 // min/max.
205 static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
206                                                      const APInt &KnownOne,
207                                                      APInt &Min, APInt &Max) {
208   assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
209          KnownZero.getBitWidth() == Min.getBitWidth() &&
210          KnownZero.getBitWidth() == Max.getBitWidth() &&
211          "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
212   APInt UnknownBits = ~(KnownZero|KnownOne);
213 
214   // The minimum value is when the unknown bits are all zeros.
215   Min = KnownOne;
216   // The maximum value is when the unknown bits are all ones.
217   Max = KnownOne|UnknownBits;
218 }
219 
220 /// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
221 ///   cmp pred (load (gep GV, ...)), cmpcst
222 /// where GV is a global variable with a constant initializer.  Try to simplify
223 /// this into some simple computation that does not need the load.  For example
224 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
225 ///
226 /// If AndCst is non-null, then the loaded value is masked with that constant
227 /// before doing the comparison.  This handles cases like "A[i]&4 == 0".
228 Instruction *InstCombiner::
229 FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
230                              CmpInst &ICI, ConstantInt *AndCst) {
231   Constant *Init = GV->getInitializer();
232   if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
233     return nullptr;
234 
235   uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
236   if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays.
237 
238   // There are many forms of this optimization we can handle, for now, just do
239   // the simple index into a single-dimensional array.
240   //
241   // Require: GEP GV, 0, i {{, constant indices}}
242   if (GEP->getNumOperands() < 3 ||
243       !isa<ConstantInt>(GEP->getOperand(1)) ||
244       !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
245       isa<Constant>(GEP->getOperand(2)))
246     return nullptr;
247 
248   // Check that indices after the variable are constants and in-range for the
249   // type they index.  Collect the indices.  This is typically for arrays of
250   // structs.
251   SmallVector<unsigned, 4> LaterIndices;
252 
253   Type *EltTy = Init->getType()->getArrayElementType();
254   for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
255     ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
256     if (!Idx) return nullptr;  // Variable index.
257 
258     uint64_t IdxVal = Idx->getZExtValue();
259     if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
260 
261     if (StructType *STy = dyn_cast<StructType>(EltTy))
262       EltTy = STy->getElementType(IdxVal);
263     else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
264       if (IdxVal >= ATy->getNumElements()) return nullptr;
265       EltTy = ATy->getElementType();
266     } else {
267       return nullptr; // Unknown type.
268     }
269 
270     LaterIndices.push_back(IdxVal);
271   }
272 
273   enum { Overdefined = -3, Undefined = -2 };
274 
275   // Variables for our state machines.
276 
277   // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
278   // "i == 47 | i == 87", where 47 is the first index the condition is true for,
279   // and 87 is the second (and last) index.  FirstTrueElement is -2 when
280   // undefined, otherwise set to the first true element.  SecondTrueElement is
281   // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
282   int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
283 
284   // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
285   // form "i != 47 & i != 87".  Same state transitions as for true elements.
286   int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
287 
288   /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
289   /// define a state machine that triggers for ranges of values that the index
290   /// is true or false for.  This triggers on things like "abbbbc"[i] == 'b'.
291   /// This is -2 when undefined, -3 when overdefined, and otherwise the last
292   /// index in the range (inclusive).  We use -2 for undefined here because we
293   /// use relative comparisons and don't want 0-1 to match -1.
294   int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
295 
296   // MagicBitvector - This is a magic bitvector where we set a bit if the
297   // comparison is true for element 'i'.  If there are 64 elements or less in
298   // the array, this will fully represent all the comparison results.
299   uint64_t MagicBitvector = 0;
300 
301   // Scan the array and see if one of our patterns matches.
302   Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
303   for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
304     Constant *Elt = Init->getAggregateElement(i);
305     if (!Elt) return nullptr;
306 
307     // If this is indexing an array of structures, get the structure element.
308     if (!LaterIndices.empty())
309       Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
310 
311     // If the element is masked, handle it.
312     if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
313 
314     // Find out if the comparison would be true or false for the i'th element.
315     Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
316                                                   CompareRHS, DL, TLI);
317     // If the result is undef for this element, ignore it.
318     if (isa<UndefValue>(C)) {
319       // Extend range state machines to cover this element in case there is an
320       // undef in the middle of the range.
321       if (TrueRangeEnd == (int)i-1)
322         TrueRangeEnd = i;
323       if (FalseRangeEnd == (int)i-1)
324         FalseRangeEnd = i;
325       continue;
326     }
327 
328     // If we can't compute the result for any of the elements, we have to give
329     // up evaluating the entire conditional.
330     if (!isa<ConstantInt>(C)) return nullptr;
331 
332     // Otherwise, we know if the comparison is true or false for this element,
333     // update our state machines.
334     bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
335 
336     // State machine for single/double/range index comparison.
337     if (IsTrueForElt) {
338       // Update the TrueElement state machine.
339       if (FirstTrueElement == Undefined)
340         FirstTrueElement = TrueRangeEnd = i;  // First true element.
341       else {
342         // Update double-compare state machine.
343         if (SecondTrueElement == Undefined)
344           SecondTrueElement = i;
345         else
346           SecondTrueElement = Overdefined;
347 
348         // Update range state machine.
349         if (TrueRangeEnd == (int)i-1)
350           TrueRangeEnd = i;
351         else
352           TrueRangeEnd = Overdefined;
353       }
354     } else {
355       // Update the FalseElement state machine.
356       if (FirstFalseElement == Undefined)
357         FirstFalseElement = FalseRangeEnd = i; // First false element.
358       else {
359         // Update double-compare state machine.
360         if (SecondFalseElement == Undefined)
361           SecondFalseElement = i;
362         else
363           SecondFalseElement = Overdefined;
364 
365         // Update range state machine.
366         if (FalseRangeEnd == (int)i-1)
367           FalseRangeEnd = i;
368         else
369           FalseRangeEnd = Overdefined;
370       }
371     }
372 
373     // If this element is in range, update our magic bitvector.
374     if (i < 64 && IsTrueForElt)
375       MagicBitvector |= 1ULL << i;
376 
377     // If all of our states become overdefined, bail out early.  Since the
378     // predicate is expensive, only check it every 8 elements.  This is only
379     // really useful for really huge arrays.
380     if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
381         SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
382         FalseRangeEnd == Overdefined)
383       return nullptr;
384   }
385 
386   // Now that we've scanned the entire array, emit our new comparison(s).  We
387   // order the state machines in complexity of the generated code.
388   Value *Idx = GEP->getOperand(2);
389 
390   // If the index is larger than the pointer size of the target, truncate the
391   // index down like the GEP would do implicitly.  We don't have to do this for
392   // an inbounds GEP because the index can't be out of range.
393   if (!GEP->isInBounds()) {
394     Type *IntPtrTy = DL.getIntPtrType(GEP->getType());
395     unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
396     if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
397       Idx = Builder->CreateTrunc(Idx, IntPtrTy);
398   }
399 
400   // If the comparison is only true for one or two elements, emit direct
401   // comparisons.
402   if (SecondTrueElement != Overdefined) {
403     // None true -> false.
404     if (FirstTrueElement == Undefined)
405       return ReplaceInstUsesWith(ICI, Builder->getFalse());
406 
407     Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
408 
409     // True for one element -> 'i == 47'.
410     if (SecondTrueElement == Undefined)
411       return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
412 
413     // True for two elements -> 'i == 47 | i == 72'.
414     Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
415     Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
416     Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
417     return BinaryOperator::CreateOr(C1, C2);
418   }
419 
420   // If the comparison is only false for one or two elements, emit direct
421   // comparisons.
422   if (SecondFalseElement != Overdefined) {
423     // None false -> true.
424     if (FirstFalseElement == Undefined)
425       return ReplaceInstUsesWith(ICI, Builder->getTrue());
426 
427     Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
428 
429     // False for one element -> 'i != 47'.
430     if (SecondFalseElement == Undefined)
431       return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
432 
433     // False for two elements -> 'i != 47 & i != 72'.
434     Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
435     Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
436     Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
437     return BinaryOperator::CreateAnd(C1, C2);
438   }
439 
440   // If the comparison can be replaced with a range comparison for the elements
441   // where it is true, emit the range check.
442   if (TrueRangeEnd != Overdefined) {
443     assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
444 
445     // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
446     if (FirstTrueElement) {
447       Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
448       Idx = Builder->CreateAdd(Idx, Offs);
449     }
450 
451     Value *End = ConstantInt::get(Idx->getType(),
452                                   TrueRangeEnd-FirstTrueElement+1);
453     return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
454   }
455 
456   // False range check.
457   if (FalseRangeEnd != Overdefined) {
458     assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
459     // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
460     if (FirstFalseElement) {
461       Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
462       Idx = Builder->CreateAdd(Idx, Offs);
463     }
464 
465     Value *End = ConstantInt::get(Idx->getType(),
466                                   FalseRangeEnd-FirstFalseElement);
467     return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
468   }
469 
470   // If a magic bitvector captures the entire comparison state
471   // of this load, replace it with computation that does:
472   //   ((magic_cst >> i) & 1) != 0
473   {
474     Type *Ty = nullptr;
475 
476     // Look for an appropriate type:
477     // - The type of Idx if the magic fits
478     // - The smallest fitting legal type if we have a DataLayout
479     // - Default to i32
480     if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
481       Ty = Idx->getType();
482     else
483       Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
484 
485     if (Ty) {
486       Value *V = Builder->CreateIntCast(Idx, Ty, false);
487       V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
488       V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
489       return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
490     }
491   }
492 
493   return nullptr;
494 }
495 
496 /// EvaluateGEPOffsetExpression - Return a value that can be used to compare
497 /// the *offset* implied by a GEP to zero.  For example, if we have &A[i], we
498 /// want to return 'i' for "icmp ne i, 0".  Note that, in general, indices can
499 /// be complex, and scales are involved.  The above expression would also be
500 /// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
501 /// This later form is less amenable to optimization though, and we are allowed
502 /// to generate the first by knowing that pointer arithmetic doesn't overflow.
503 ///
504 /// If we can't emit an optimized form for this expression, this returns null.
505 ///
506 static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC,
507                                           const DataLayout &DL) {
508   gep_type_iterator GTI = gep_type_begin(GEP);
509 
510   // Check to see if this gep only has a single variable index.  If so, and if
511   // any constant indices are a multiple of its scale, then we can compute this
512   // in terms of the scale of the variable index.  For example, if the GEP
513   // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
514   // because the expression will cross zero at the same point.
515   unsigned i, e = GEP->getNumOperands();
516   int64_t Offset = 0;
517   for (i = 1; i != e; ++i, ++GTI) {
518     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
519       // Compute the aggregate offset of constant indices.
520       if (CI->isZero()) continue;
521 
522       // Handle a struct index, which adds its field offset to the pointer.
523       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
524         Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
525       } else {
526         uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
527         Offset += Size*CI->getSExtValue();
528       }
529     } else {
530       // Found our variable index.
531       break;
532     }
533   }
534 
535   // If there are no variable indices, we must have a constant offset, just
536   // evaluate it the general way.
537   if (i == e) return nullptr;
538 
539   Value *VariableIdx = GEP->getOperand(i);
540   // Determine the scale factor of the variable element.  For example, this is
541   // 4 if the variable index is into an array of i32.
542   uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
543 
544   // Verify that there are no other variable indices.  If so, emit the hard way.
545   for (++i, ++GTI; i != e; ++i, ++GTI) {
546     ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
547     if (!CI) return nullptr;
548 
549     // Compute the aggregate offset of constant indices.
550     if (CI->isZero()) continue;
551 
552     // Handle a struct index, which adds its field offset to the pointer.
553     if (StructType *STy = dyn_cast<StructType>(*GTI)) {
554       Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
555     } else {
556       uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
557       Offset += Size*CI->getSExtValue();
558     }
559   }
560 
561   // Okay, we know we have a single variable index, which must be a
562   // pointer/array/vector index.  If there is no offset, life is simple, return
563   // the index.
564   Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
565   unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
566   if (Offset == 0) {
567     // Cast to intptrty in case a truncation occurs.  If an extension is needed,
568     // we don't need to bother extending: the extension won't affect where the
569     // computation crosses zero.
570     if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
571       VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
572     }
573     return VariableIdx;
574   }
575 
576   // Otherwise, there is an index.  The computation we will do will be modulo
577   // the pointer size, so get it.
578   uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
579 
580   Offset &= PtrSizeMask;
581   VariableScale &= PtrSizeMask;
582 
583   // To do this transformation, any constant index must be a multiple of the
584   // variable scale factor.  For example, we can evaluate "12 + 4*i" as "3 + i",
585   // but we can't evaluate "10 + 3*i" in terms of i.  Check that the offset is a
586   // multiple of the variable scale.
587   int64_t NewOffs = Offset / (int64_t)VariableScale;
588   if (Offset != NewOffs*(int64_t)VariableScale)
589     return nullptr;
590 
591   // Okay, we can do this evaluation.  Start by converting the index to intptr.
592   if (VariableIdx->getType() != IntPtrTy)
593     VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
594                                             true /*Signed*/);
595   Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
596   return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
597 }
598 
599 /// Returns true if we can rewrite Start as a GEP with pointer Base
600 /// and some integer offset. The nodes that need to be re-written
601 /// for this transformation will be added to Explored.
602 static bool canRewriteGEPAsOffset(Value *Start, Value *Base,
603                                   const DataLayout &DL,
604                                   SetVector<Value *> &Explored) {
605   SmallVector<Value *, 16> WorkList(1, Start);
606   Explored.insert(Base);
607 
608   // The following traversal gives us an order which can be used
609   // when doing the final transformation. Since in the final
610   // transformation we create the PHI replacement instructions first,
611   // we don't have to get them in any particular order.
612   //
613   // However, for other instructions we will have to traverse the
614   // operands of an instruction first, which means that we have to
615   // do a post-order traversal.
616   while (!WorkList.empty()) {
617     SetVector<PHINode *> PHIs;
618 
619     while (!WorkList.empty()) {
620       if (Explored.size() >= 100)
621         return false;
622 
623       Value *V = WorkList.back();
624 
625       if (Explored.count(V) != 0) {
626         WorkList.pop_back();
627         continue;
628       }
629 
630       if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) &&
631           !isa<GEPOperator>(V) && !isa<PHINode>(V))
632         // We've found some value that we can't explore which is different from
633         // the base. Therefore we can't do this transformation.
634         return false;
635 
636       if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) {
637         auto *CI = dyn_cast<CastInst>(V);
638         if (!CI->isNoopCast(DL))
639           return false;
640 
641         if (Explored.count(CI->getOperand(0)) == 0)
642           WorkList.push_back(CI->getOperand(0));
643       }
644 
645       if (auto *GEP = dyn_cast<GEPOperator>(V)) {
646         // We're limiting the GEP to having one index. This will preserve
647         // the original pointer type. We could handle more cases in the
648         // future.
649         if (GEP->getNumIndices() != 1 || !GEP->isInBounds() ||
650             GEP->getType() != Start->getType())
651           return false;
652 
653         if (Explored.count(GEP->getOperand(0)) == 0)
654           WorkList.push_back(GEP->getOperand(0));
655       }
656 
657       if (WorkList.back() == V) {
658         WorkList.pop_back();
659         // We've finished visiting this node, mark it as such.
660         Explored.insert(V);
661       }
662 
663       if (auto *PN = dyn_cast<PHINode>(V)) {
664         Explored.insert(PN);
665         PHIs.insert(PN);
666       }
667     }
668 
669     // Explore the PHI nodes further.
670     for (auto *PN : PHIs)
671       for (Value *Op : PN->incoming_values())
672         if (Explored.count(Op) == 0)
673           WorkList.push_back(Op);
674   }
675 
676   // Make sure that we can do this. Since we can't insert GEPs in a basic
677   // block before a PHI node, we can't easily do this transformation if
678   // we have PHI node users of transformed instructions.
679   for (Value *Val : Explored) {
680     for (Value *Use : Val->uses()) {
681 
682       auto *PHI = dyn_cast<PHINode>(Use);
683       auto *Inst = dyn_cast<Instruction>(Val);
684 
685       if (Inst == Base || Inst == PHI || !Inst || !PHI ||
686           Explored.count(PHI) == 0)
687         continue;
688 
689       if (PHI->getParent() == Inst->getParent())
690         return false;
691     }
692   }
693   return true;
694 }
695 
696 // Sets the appropriate insert point on Builder where we can add
697 // a replacement Instruction for V (if that is possible).
698 static void setInsertionPoint(IRBuilder<> &Builder, Value *V,
699                               bool Before = true) {
700   if (auto *PHI = dyn_cast<PHINode>(V)) {
701     Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt());
702     return;
703   }
704   if (auto *I = dyn_cast<Instruction>(V)) {
705     if (!Before)
706       I = &*std::next(I->getIterator());
707     Builder.SetInsertPoint(I);
708     return;
709   }
710   if (auto *A = dyn_cast<Argument>(V)) {
711     // Set the insertion point in the entry block.
712     BasicBlock &Entry = A->getParent()->getEntryBlock();
713     Builder.SetInsertPoint(&*Entry.getFirstInsertionPt());
714     return;
715   }
716   // Otherwise, this is a constant and we don't need to set a new
717   // insertion point.
718   assert(isa<Constant>(V) && "Setting insertion point for unknown value!");
719 }
720 
721 /// Returns a re-written value of Start as an indexed GEP using Base as a
722 /// pointer.
723 static Value *rewriteGEPAsOffset(Value *Start, Value *Base,
724                                  const DataLayout &DL,
725                                  SetVector<Value *> &Explored) {
726   // Perform all the substitutions. This is a bit tricky because we can
727   // have cycles in our use-def chains.
728   // 1. Create the PHI nodes without any incoming values.
729   // 2. Create all the other values.
730   // 3. Add the edges for the PHI nodes.
731   // 4. Emit GEPs to get the original pointers.
732   // 5. Remove the original instructions.
733   Type *IndexType = IntegerType::get(
734       Base->getContext(), DL.getPointerTypeSizeInBits(Start->getType()));
735 
736   DenseMap<Value *, Value *> NewInsts;
737   NewInsts[Base] = ConstantInt::getNullValue(IndexType);
738 
739   // Create the new PHI nodes, without adding any incoming values.
740   for (Value *Val : Explored) {
741     if (Val == Base)
742       continue;
743     // Create empty phi nodes. This avoids cyclic dependencies when creating
744     // the remaining instructions.
745     if (auto *PHI = dyn_cast<PHINode>(Val))
746       NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(),
747                                       PHI->getName() + ".idx", PHI);
748   }
749   IRBuilder<> Builder(Base->getContext());
750 
751   // Create all the other instructions.
752   for (Value *Val : Explored) {
753 
754     if (NewInsts.find(Val) != NewInsts.end())
755       continue;
756 
757     if (auto *CI = dyn_cast<CastInst>(Val)) {
758       NewInsts[CI] = NewInsts[CI->getOperand(0)];
759       continue;
760     }
761     if (auto *GEP = dyn_cast<GEPOperator>(Val)) {
762       Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)]
763                                                   : GEP->getOperand(1);
764       setInsertionPoint(Builder, GEP);
765       // Indices might need to be sign extended. GEPs will magically do
766       // this, but we need to do it ourselves here.
767       if (Index->getType()->getScalarSizeInBits() !=
768           NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) {
769         Index = Builder.CreateSExtOrTrunc(
770             Index, NewInsts[GEP->getOperand(0)]->getType(),
771             GEP->getOperand(0)->getName() + ".sext");
772       }
773 
774       auto *Op = NewInsts[GEP->getOperand(0)];
775       if (isa<ConstantInt>(Op) && dyn_cast<ConstantInt>(Op)->isZero())
776         NewInsts[GEP] = Index;
777       else
778         NewInsts[GEP] = Builder.CreateNSWAdd(
779             Op, Index, GEP->getOperand(0)->getName() + ".add");
780       continue;
781     }
782     if (isa<PHINode>(Val))
783       continue;
784 
785     llvm_unreachable("Unexpected instruction type");
786   }
787 
788   // Add the incoming values to the PHI nodes.
789   for (Value *Val : Explored) {
790     if (Val == Base)
791       continue;
792     // All the instructions have been created, we can now add edges to the
793     // phi nodes.
794     if (auto *PHI = dyn_cast<PHINode>(Val)) {
795       PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]);
796       for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) {
797         Value *NewIncoming = PHI->getIncomingValue(I);
798 
799         if (NewInsts.find(NewIncoming) != NewInsts.end())
800           NewIncoming = NewInsts[NewIncoming];
801 
802         NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I));
803       }
804     }
805   }
806 
807   for (Value *Val : Explored) {
808     if (Val == Base)
809       continue;
810 
811     // Depending on the type, for external users we have to emit
812     // a GEP or a GEP + ptrtoint.
813     setInsertionPoint(Builder, Val, false);
814 
815     // If required, create an inttoptr instruction for Base.
816     Value *NewBase = Base;
817     if (!Base->getType()->isPointerTy())
818       NewBase = Builder.CreateBitOrPointerCast(Base, Start->getType(),
819                                                Start->getName() + "to.ptr");
820 
821     Value *GEP = Builder.CreateInBoundsGEP(
822         Start->getType()->getPointerElementType(), NewBase,
823         makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr");
824 
825     if (!Val->getType()->isPointerTy()) {
826       Value *Cast = Builder.CreatePointerCast(GEP, Val->getType(),
827                                               Val->getName() + ".conv");
828       GEP = Cast;
829     }
830     Val->replaceAllUsesWith(GEP);
831   }
832 
833   return NewInsts[Start];
834 }
835 
836 /// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express
837 /// the input Value as a constant indexed GEP. Returns a pair containing
838 /// the GEPs Pointer and Index.
839 static std::pair<Value *, Value *>
840 getAsConstantIndexedAddress(Value *V, const DataLayout &DL) {
841   Type *IndexType = IntegerType::get(V->getContext(),
842                                      DL.getPointerTypeSizeInBits(V->getType()));
843 
844   Constant *Index = ConstantInt::getNullValue(IndexType);
845   while (true) {
846     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
847       // We accept only inbouds GEPs here to exclude the possibility of
848       // overflow.
849       if (!GEP->isInBounds())
850         break;
851       if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 &&
852           GEP->getType() == V->getType()) {
853         V = GEP->getOperand(0);
854         Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1));
855         Index = ConstantExpr::getAdd(
856             Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType));
857         continue;
858       }
859       break;
860     }
861     if (auto *CI = dyn_cast<IntToPtrInst>(V)) {
862       if (!CI->isNoopCast(DL))
863         break;
864       V = CI->getOperand(0);
865       continue;
866     }
867     if (auto *CI = dyn_cast<PtrToIntInst>(V)) {
868       if (!CI->isNoopCast(DL))
869         break;
870       V = CI->getOperand(0);
871       continue;
872     }
873     break;
874   }
875   return {V, Index};
876 }
877 
878 // Converts (CMP GEPLHS, RHS) if this change would make RHS a constant.
879 // We can look through PHIs, GEPs and casts in order to determine a
880 // common base between GEPLHS and RHS.
881 static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS,
882                                               ICmpInst::Predicate Cond,
883                                               const DataLayout &DL) {
884   if (!GEPLHS->hasAllConstantIndices())
885     return nullptr;
886 
887   Value *PtrBase, *Index;
888   std::tie(PtrBase, Index) = getAsConstantIndexedAddress(GEPLHS, DL);
889 
890   // The set of nodes that will take part in this transformation.
891   SetVector<Value *> Nodes;
892 
893   if (!canRewriteGEPAsOffset(RHS, PtrBase, DL, Nodes))
894     return nullptr;
895 
896   // We know we can re-write this as
897   //  ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)
898   // Since we've only looked through inbouds GEPs we know that we
899   // can't have overflow on either side. We can therefore re-write
900   // this as:
901   //   OFFSET1 cmp OFFSET2
902   Value *NewRHS = rewriteGEPAsOffset(RHS, PtrBase, DL, Nodes);
903 
904   // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written
905   // GEP having PtrBase as the pointer base, and has returned in NewRHS the
906   // offset. Since Index is the offset of LHS to the base pointer, we will now
907   // compare the offsets instead of comparing the pointers.
908   return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS);
909 }
910 
911 /// FoldGEPICmp - Fold comparisons between a GEP instruction and something
912 /// else.  At this point we know that the GEP is on the LHS of the comparison.
913 Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
914                                        ICmpInst::Predicate Cond,
915                                        Instruction &I) {
916   // Don't transform signed compares of GEPs into index compares. Even if the
917   // GEP is inbounds, the final add of the base pointer can have signed overflow
918   // and would change the result of the icmp.
919   // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
920   // the maximum signed value for the pointer type.
921   if (ICmpInst::isSigned(Cond))
922     return nullptr;
923 
924   // Look through bitcasts and addrspacecasts. We do not however want to remove
925   // 0 GEPs.
926   if (!isa<GetElementPtrInst>(RHS))
927     RHS = RHS->stripPointerCasts();
928 
929   Value *PtrBase = GEPLHS->getOperand(0);
930   if (PtrBase == RHS && GEPLHS->isInBounds()) {
931     // ((gep Ptr, OFFSET) cmp Ptr)   ---> (OFFSET cmp 0).
932     // This transformation (ignoring the base and scales) is valid because we
933     // know pointers can't overflow since the gep is inbounds.  See if we can
934     // output an optimized form.
935     Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this, DL);
936 
937     // If not, synthesize the offset the hard way.
938     if (!Offset)
939       Offset = EmitGEPOffset(GEPLHS);
940     return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
941                         Constant::getNullValue(Offset->getType()));
942   } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
943     // If the base pointers are different, but the indices are the same, just
944     // compare the base pointer.
945     if (PtrBase != GEPRHS->getOperand(0)) {
946       bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
947       IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
948                         GEPRHS->getOperand(0)->getType();
949       if (IndicesTheSame)
950         for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
951           if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
952             IndicesTheSame = false;
953             break;
954           }
955 
956       // If all indices are the same, just compare the base pointers.
957       if (IndicesTheSame)
958         return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
959 
960       // If we're comparing GEPs with two base pointers that only differ in type
961       // and both GEPs have only constant indices or just one use, then fold
962       // the compare with the adjusted indices.
963       if (GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
964           (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
965           (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
966           PtrBase->stripPointerCasts() ==
967               GEPRHS->getOperand(0)->stripPointerCasts()) {
968         Value *LOffset = EmitGEPOffset(GEPLHS);
969         Value *ROffset = EmitGEPOffset(GEPRHS);
970 
971         // If we looked through an addrspacecast between different sized address
972         // spaces, the LHS and RHS pointers are different sized
973         // integers. Truncate to the smaller one.
974         Type *LHSIndexTy = LOffset->getType();
975         Type *RHSIndexTy = ROffset->getType();
976         if (LHSIndexTy != RHSIndexTy) {
977           if (LHSIndexTy->getPrimitiveSizeInBits() <
978               RHSIndexTy->getPrimitiveSizeInBits()) {
979             ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy);
980           } else
981             LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy);
982         }
983 
984         Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
985                                          LOffset, ROffset);
986         return ReplaceInstUsesWith(I, Cmp);
987       }
988 
989       // Otherwise, the base pointers are different and the indices are
990       // different. Try convert this to an indexed compare by looking through
991       // PHIs/casts.
992       return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
993     }
994 
995     // If one of the GEPs has all zero indices, recurse.
996     if (GEPLHS->hasAllZeroIndices())
997       return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
998                          ICmpInst::getSwappedPredicate(Cond), I);
999 
1000     // If the other GEP has all zero indices, recurse.
1001     if (GEPRHS->hasAllZeroIndices())
1002       return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
1003 
1004     bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
1005     if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
1006       // If the GEPs only differ by one index, compare it.
1007       unsigned NumDifferences = 0;  // Keep track of # differences.
1008       unsigned DiffOperand = 0;     // The operand that differs.
1009       for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
1010         if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
1011           if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
1012                    GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
1013             // Irreconcilable differences.
1014             NumDifferences = 2;
1015             break;
1016           } else {
1017             if (NumDifferences++) break;
1018             DiffOperand = i;
1019           }
1020         }
1021 
1022       if (NumDifferences == 0)   // SAME GEP?
1023         return ReplaceInstUsesWith(I, // No comparison is needed here.
1024                              Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
1025 
1026       else if (NumDifferences == 1 && GEPsInBounds) {
1027         Value *LHSV = GEPLHS->getOperand(DiffOperand);
1028         Value *RHSV = GEPRHS->getOperand(DiffOperand);
1029         // Make sure we do a signed comparison here.
1030         return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
1031       }
1032     }
1033 
1034     // Only lower this if the icmp is the only user of the GEP or if we expect
1035     // the result to fold to a constant!
1036     if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
1037         (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
1038       // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)  --->  (OFFSET1 cmp OFFSET2)
1039       Value *L = EmitGEPOffset(GEPLHS);
1040       Value *R = EmitGEPOffset(GEPRHS);
1041       return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
1042     }
1043   }
1044 
1045   // Try convert this to an indexed compare by looking through PHIs/casts as a
1046   // last resort.
1047   return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
1048 }
1049 
1050 Instruction *InstCombiner::FoldAllocaCmp(ICmpInst &ICI, AllocaInst *Alloca,
1051                                          Value *Other) {
1052   assert(ICI.isEquality() && "Cannot fold non-equality comparison.");
1053 
1054   // It would be tempting to fold away comparisons between allocas and any
1055   // pointer not based on that alloca (e.g. an argument). However, even
1056   // though such pointers cannot alias, they can still compare equal.
1057   //
1058   // But LLVM doesn't specify where allocas get their memory, so if the alloca
1059   // doesn't escape we can argue that it's impossible to guess its value, and we
1060   // can therefore act as if any such guesses are wrong.
1061   //
1062   // The code below checks that the alloca doesn't escape, and that it's only
1063   // used in a comparison once (the current instruction). The
1064   // single-comparison-use condition ensures that we're trivially folding all
1065   // comparisons against the alloca consistently, and avoids the risk of
1066   // erroneously folding a comparison of the pointer with itself.
1067 
1068   unsigned MaxIter = 32; // Break cycles and bound to constant-time.
1069 
1070   SmallVector<Use *, 32> Worklist;
1071   for (Use &U : Alloca->uses()) {
1072     if (Worklist.size() >= MaxIter)
1073       return nullptr;
1074     Worklist.push_back(&U);
1075   }
1076 
1077   unsigned NumCmps = 0;
1078   while (!Worklist.empty()) {
1079     assert(Worklist.size() <= MaxIter);
1080     Use *U = Worklist.pop_back_val();
1081     Value *V = U->getUser();
1082     --MaxIter;
1083 
1084     if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) ||
1085         isa<SelectInst>(V)) {
1086       // Track the uses.
1087     } else if (isa<LoadInst>(V)) {
1088       // Loading from the pointer doesn't escape it.
1089       continue;
1090     } else if (auto *SI = dyn_cast<StoreInst>(V)) {
1091       // Storing *to* the pointer is fine, but storing the pointer escapes it.
1092       if (SI->getValueOperand() == U->get())
1093         return nullptr;
1094       continue;
1095     } else if (isa<ICmpInst>(V)) {
1096       if (NumCmps++)
1097         return nullptr; // Found more than one cmp.
1098       continue;
1099     } else if (auto *Intrin = dyn_cast<IntrinsicInst>(V)) {
1100       switch (Intrin->getIntrinsicID()) {
1101         // These intrinsics don't escape or compare the pointer. Memset is safe
1102         // because we don't allow ptrtoint. Memcpy and memmove are safe because
1103         // we don't allow stores, so src cannot point to V.
1104         case Intrinsic::lifetime_start: case Intrinsic::lifetime_end:
1105         case Intrinsic::dbg_declare: case Intrinsic::dbg_value:
1106         case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset:
1107           continue;
1108         default:
1109           return nullptr;
1110       }
1111     } else {
1112       return nullptr;
1113     }
1114     for (Use &U : V->uses()) {
1115       if (Worklist.size() >= MaxIter)
1116         return nullptr;
1117       Worklist.push_back(&U);
1118     }
1119   }
1120 
1121   Type *CmpTy = CmpInst::makeCmpResultType(Other->getType());
1122   return ReplaceInstUsesWith(
1123       ICI,
1124       ConstantInt::get(CmpTy, !CmpInst::isTrueWhenEqual(ICI.getPredicate())));
1125 }
1126 
1127 /// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
1128 Instruction *InstCombiner::FoldICmpAddOpCst(Instruction &ICI,
1129                                             Value *X, ConstantInt *CI,
1130                                             ICmpInst::Predicate Pred) {
1131   // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
1132   // so the values can never be equal.  Similarly for all other "or equals"
1133   // operators.
1134 
1135   // (X+1) <u X        --> X >u (MAXUINT-1)        --> X == 255
1136   // (X+2) <u X        --> X >u (MAXUINT-2)        --> X > 253
1137   // (X+MAXUINT) <u X  --> X >u (MAXUINT-MAXUINT)  --> X != 0
1138   if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
1139     Value *R =
1140       ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
1141     return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
1142   }
1143 
1144   // (X+1) >u X        --> X <u (0-1)        --> X != 255
1145   // (X+2) >u X        --> X <u (0-2)        --> X <u 254
1146   // (X+MAXUINT) >u X  --> X <u (0-MAXUINT)  --> X <u 1  --> X == 0
1147   if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
1148     return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
1149 
1150   unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
1151   ConstantInt *SMax = ConstantInt::get(X->getContext(),
1152                                        APInt::getSignedMaxValue(BitWidth));
1153 
1154   // (X+ 1) <s X       --> X >s (MAXSINT-1)          --> X == 127
1155   // (X+ 2) <s X       --> X >s (MAXSINT-2)          --> X >s 125
1156   // (X+MAXSINT) <s X  --> X >s (MAXSINT-MAXSINT)    --> X >s 0
1157   // (X+MINSINT) <s X  --> X >s (MAXSINT-MINSINT)    --> X >s -1
1158   // (X+ -2) <s X      --> X >s (MAXSINT- -2)        --> X >s 126
1159   // (X+ -1) <s X      --> X >s (MAXSINT- -1)        --> X != 127
1160   if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1161     return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
1162 
1163   // (X+ 1) >s X       --> X <s (MAXSINT-(1-1))       --> X != 127
1164   // (X+ 2) >s X       --> X <s (MAXSINT-(2-1))       --> X <s 126
1165   // (X+MAXSINT) >s X  --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
1166   // (X+MINSINT) >s X  --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
1167   // (X+ -2) >s X      --> X <s (MAXSINT-(-2-1))      --> X <s -126
1168   // (X+ -1) >s X      --> X <s (MAXSINT-(-1-1))      --> X == -128
1169 
1170   assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
1171   Constant *C = Builder->getInt(CI->getValue()-1);
1172   return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
1173 }
1174 
1175 /// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
1176 /// and CmpRHS are both known to be integer constants.
1177 Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
1178                                           ConstantInt *DivRHS) {
1179   ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
1180   const APInt &CmpRHSV = CmpRHS->getValue();
1181 
1182   // FIXME: If the operand types don't match the type of the divide
1183   // then don't attempt this transform. The code below doesn't have the
1184   // logic to deal with a signed divide and an unsigned compare (and
1185   // vice versa). This is because (x /s C1) <s C2  produces different
1186   // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
1187   // (x /u C1) <u C2.  Simply casting the operands and result won't
1188   // work. :(  The if statement below tests that condition and bails
1189   // if it finds it.
1190   bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
1191   if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
1192     return nullptr;
1193   if (DivRHS->isZero())
1194     return nullptr; // The ProdOV computation fails on divide by zero.
1195   if (DivIsSigned && DivRHS->isAllOnesValue())
1196     return nullptr; // The overflow computation also screws up here
1197   if (DivRHS->isOne()) {
1198     // This eliminates some funny cases with INT_MIN.
1199     ICI.setOperand(0, DivI->getOperand(0));   // X/1 == X.
1200     return &ICI;
1201   }
1202 
1203   // Compute Prod = CI * DivRHS. We are essentially solving an equation
1204   // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
1205   // C2 (CI). By solving for X we can turn this into a range check
1206   // instead of computing a divide.
1207   Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
1208 
1209   // Determine if the product overflows by seeing if the product is
1210   // not equal to the divide. Make sure we do the same kind of divide
1211   // as in the LHS instruction that we're folding.
1212   bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
1213                  ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
1214 
1215   // Get the ICmp opcode
1216   ICmpInst::Predicate Pred = ICI.getPredicate();
1217 
1218   /// If the division is known to be exact, then there is no remainder from the
1219   /// divide, so the covered range size is unit, otherwise it is the divisor.
1220   ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
1221 
1222   // Figure out the interval that is being checked.  For example, a comparison
1223   // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
1224   // Compute this interval based on the constants involved and the signedness of
1225   // the compare/divide.  This computes a half-open interval, keeping track of
1226   // whether either value in the interval overflows.  After analysis each
1227   // overflow variable is set to 0 if it's corresponding bound variable is valid
1228   // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
1229   int LoOverflow = 0, HiOverflow = 0;
1230   Constant *LoBound = nullptr, *HiBound = nullptr;
1231 
1232   if (!DivIsSigned) {  // udiv
1233     // e.g. X/5 op 3  --> [15, 20)
1234     LoBound = Prod;
1235     HiOverflow = LoOverflow = ProdOV;
1236     if (!HiOverflow) {
1237       // If this is not an exact divide, then many values in the range collapse
1238       // to the same result value.
1239       HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
1240     }
1241   } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
1242     if (CmpRHSV == 0) {       // (X / pos) op 0
1243       // Can't overflow.  e.g.  X/2 op 0 --> [-1, 2)
1244       LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
1245       HiBound = RangeSize;
1246     } else if (CmpRHSV.isStrictlyPositive()) {   // (X / pos) op pos
1247       LoBound = Prod;     // e.g.   X/5 op 3 --> [15, 20)
1248       HiOverflow = LoOverflow = ProdOV;
1249       if (!HiOverflow)
1250         HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
1251     } else {                       // (X / pos) op neg
1252       // e.g. X/5 op -3  --> [-15-4, -15+1) --> [-19, -14)
1253       HiBound = AddOne(Prod);
1254       LoOverflow = HiOverflow = ProdOV ? -1 : 0;
1255       if (!LoOverflow) {
1256         ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
1257         LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
1258       }
1259     }
1260   } else if (DivRHS->isNegative()) { // Divisor is < 0.
1261     if (DivI->isExact())
1262       RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
1263     if (CmpRHSV == 0) {       // (X / neg) op 0
1264       // e.g. X/-5 op 0  --> [-4, 5)
1265       LoBound = AddOne(RangeSize);
1266       HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
1267       if (HiBound == DivRHS) {     // -INTMIN = INTMIN
1268         HiOverflow = 1;            // [INTMIN+1, overflow)
1269         HiBound = nullptr;         // e.g. X/INTMIN = 0 --> X > INTMIN
1270       }
1271     } else if (CmpRHSV.isStrictlyPositive()) {   // (X / neg) op pos
1272       // e.g. X/-5 op 3  --> [-19, -14)
1273       HiBound = AddOne(Prod);
1274       HiOverflow = LoOverflow = ProdOV ? -1 : 0;
1275       if (!LoOverflow)
1276         LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
1277     } else {                       // (X / neg) op neg
1278       LoBound = Prod;       // e.g. X/-5 op -3  --> [15, 20)
1279       LoOverflow = HiOverflow = ProdOV;
1280       if (!HiOverflow)
1281         HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
1282     }
1283 
1284     // Dividing by a negative swaps the condition.  LT <-> GT
1285     Pred = ICmpInst::getSwappedPredicate(Pred);
1286   }
1287 
1288   Value *X = DivI->getOperand(0);
1289   switch (Pred) {
1290   default: llvm_unreachable("Unhandled icmp opcode!");
1291   case ICmpInst::ICMP_EQ:
1292     if (LoOverflow && HiOverflow)
1293       return ReplaceInstUsesWith(ICI, Builder->getFalse());
1294     if (HiOverflow)
1295       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
1296                           ICmpInst::ICMP_UGE, X, LoBound);
1297     if (LoOverflow)
1298       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
1299                           ICmpInst::ICMP_ULT, X, HiBound);
1300     return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
1301                                                     DivIsSigned, true));
1302   case ICmpInst::ICMP_NE:
1303     if (LoOverflow && HiOverflow)
1304       return ReplaceInstUsesWith(ICI, Builder->getTrue());
1305     if (HiOverflow)
1306       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
1307                           ICmpInst::ICMP_ULT, X, LoBound);
1308     if (LoOverflow)
1309       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
1310                           ICmpInst::ICMP_UGE, X, HiBound);
1311     return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
1312                                                     DivIsSigned, false));
1313   case ICmpInst::ICMP_ULT:
1314   case ICmpInst::ICMP_SLT:
1315     if (LoOverflow == +1)   // Low bound is greater than input range.
1316       return ReplaceInstUsesWith(ICI, Builder->getTrue());
1317     if (LoOverflow == -1)   // Low bound is less than input range.
1318       return ReplaceInstUsesWith(ICI, Builder->getFalse());
1319     return new ICmpInst(Pred, X, LoBound);
1320   case ICmpInst::ICMP_UGT:
1321   case ICmpInst::ICMP_SGT:
1322     if (HiOverflow == +1)       // High bound greater than input range.
1323       return ReplaceInstUsesWith(ICI, Builder->getFalse());
1324     if (HiOverflow == -1)       // High bound less than input range.
1325       return ReplaceInstUsesWith(ICI, Builder->getTrue());
1326     if (Pred == ICmpInst::ICMP_UGT)
1327       return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
1328     return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
1329   }
1330 }
1331 
1332 /// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
1333 Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
1334                                           ConstantInt *ShAmt) {
1335   const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
1336 
1337   // Check that the shift amount is in range.  If not, don't perform
1338   // undefined shifts.  When the shift is visited it will be
1339   // simplified.
1340   uint32_t TypeBits = CmpRHSV.getBitWidth();
1341   uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
1342   if (ShAmtVal >= TypeBits || ShAmtVal == 0)
1343     return nullptr;
1344 
1345   if (!ICI.isEquality()) {
1346     // If we have an unsigned comparison and an ashr, we can't simplify this.
1347     // Similarly for signed comparisons with lshr.
1348     if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
1349       return nullptr;
1350 
1351     // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
1352     // by a power of 2.  Since we already have logic to simplify these,
1353     // transform to div and then simplify the resultant comparison.
1354     if (Shr->getOpcode() == Instruction::AShr &&
1355         (!Shr->isExact() || ShAmtVal == TypeBits - 1))
1356       return nullptr;
1357 
1358     // Revisit the shift (to delete it).
1359     Worklist.Add(Shr);
1360 
1361     Constant *DivCst =
1362       ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
1363 
1364     Value *Tmp =
1365       Shr->getOpcode() == Instruction::AShr ?
1366       Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
1367       Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
1368 
1369     ICI.setOperand(0, Tmp);
1370 
1371     // If the builder folded the binop, just return it.
1372     BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
1373     if (!TheDiv)
1374       return &ICI;
1375 
1376     // Otherwise, fold this div/compare.
1377     assert(TheDiv->getOpcode() == Instruction::SDiv ||
1378            TheDiv->getOpcode() == Instruction::UDiv);
1379 
1380     Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
1381     assert(Res && "This div/cst should have folded!");
1382     return Res;
1383   }
1384 
1385   // If we are comparing against bits always shifted out, the
1386   // comparison cannot succeed.
1387   APInt Comp = CmpRHSV << ShAmtVal;
1388   ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
1389   if (Shr->getOpcode() == Instruction::LShr)
1390     Comp = Comp.lshr(ShAmtVal);
1391   else
1392     Comp = Comp.ashr(ShAmtVal);
1393 
1394   if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1395     bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1396     Constant *Cst = Builder->getInt1(IsICMP_NE);
1397     return ReplaceInstUsesWith(ICI, Cst);
1398   }
1399 
1400   // Otherwise, check to see if the bits shifted out are known to be zero.
1401   // If so, we can compare against the unshifted value:
1402   //  (X & 4) >> 1 == 2  --> (X & 4) == 4.
1403   if (Shr->hasOneUse() && Shr->isExact())
1404     return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
1405 
1406   if (Shr->hasOneUse()) {
1407     // Otherwise strength reduce the shift into an and.
1408     APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
1409     Constant *Mask = Builder->getInt(Val);
1410 
1411     Value *And = Builder->CreateAnd(Shr->getOperand(0),
1412                                     Mask, Shr->getName()+".mask");
1413     return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1414   }
1415   return nullptr;
1416 }
1417 
1418 /// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
1419 /// (icmp eq/ne A, Log2(const2/const1)) ->
1420 /// (icmp eq/ne A, Log2(const2) - Log2(const1)).
1421 Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
1422                                              ConstantInt *CI1,
1423                                              ConstantInt *CI2) {
1424   assert(I.isEquality() && "Cannot fold icmp gt/lt");
1425 
1426   auto getConstant = [&I, this](bool IsTrue) {
1427     if (I.getPredicate() == I.ICMP_NE)
1428       IsTrue = !IsTrue;
1429     return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1430   };
1431 
1432   auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1433     if (I.getPredicate() == I.ICMP_NE)
1434       Pred = CmpInst::getInversePredicate(Pred);
1435     return new ICmpInst(Pred, LHS, RHS);
1436   };
1437 
1438   APInt AP1 = CI1->getValue();
1439   APInt AP2 = CI2->getValue();
1440 
1441   // Don't bother doing any work for cases which InstSimplify handles.
1442   if (AP2 == 0)
1443     return nullptr;
1444   bool IsAShr = isa<AShrOperator>(Op);
1445   if (IsAShr) {
1446     if (AP2.isAllOnesValue())
1447       return nullptr;
1448     if (AP2.isNegative() != AP1.isNegative())
1449       return nullptr;
1450     if (AP2.sgt(AP1))
1451       return nullptr;
1452   }
1453 
1454   if (!AP1)
1455     // 'A' must be large enough to shift out the highest set bit.
1456     return getICmp(I.ICMP_UGT, A,
1457                    ConstantInt::get(A->getType(), AP2.logBase2()));
1458 
1459   if (AP1 == AP2)
1460     return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1461 
1462   int Shift;
1463   if (IsAShr && AP1.isNegative())
1464     Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes();
1465   else
1466     Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros();
1467 
1468   if (Shift > 0) {
1469     if (IsAShr && AP1 == AP2.ashr(Shift)) {
1470       // There are multiple solutions if we are comparing against -1 and the LHS
1471       // of the ashr is not a power of two.
1472       if (AP1.isAllOnesValue() && !AP2.isPowerOf2())
1473         return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift));
1474       return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1475     } else if (AP1 == AP2.lshr(Shift)) {
1476       return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1477     }
1478   }
1479   // Shifting const2 will never be equal to const1.
1480   return getConstant(false);
1481 }
1482 
1483 /// FoldICmpCstShlCst - Handle "(icmp eq/ne (shl const2, A), const1)" ->
1484 /// (icmp eq/ne A, TrailingZeros(const1) - TrailingZeros(const2)).
1485 Instruction *InstCombiner::FoldICmpCstShlCst(ICmpInst &I, Value *Op, Value *A,
1486                                              ConstantInt *CI1,
1487                                              ConstantInt *CI2) {
1488   assert(I.isEquality() && "Cannot fold icmp gt/lt");
1489 
1490   auto getConstant = [&I, this](bool IsTrue) {
1491     if (I.getPredicate() == I.ICMP_NE)
1492       IsTrue = !IsTrue;
1493     return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1494   };
1495 
1496   auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1497     if (I.getPredicate() == I.ICMP_NE)
1498       Pred = CmpInst::getInversePredicate(Pred);
1499     return new ICmpInst(Pred, LHS, RHS);
1500   };
1501 
1502   APInt AP1 = CI1->getValue();
1503   APInt AP2 = CI2->getValue();
1504 
1505   // Don't bother doing any work for cases which InstSimplify handles.
1506   if (AP2 == 0)
1507     return nullptr;
1508 
1509   unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1510 
1511   if (!AP1 && AP2TrailingZeros != 0)
1512     return getICmp(I.ICMP_UGE, A,
1513                    ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
1514 
1515   if (AP1 == AP2)
1516     return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1517 
1518   // Get the distance between the lowest bits that are set.
1519   int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1520 
1521   if (Shift > 0 && AP2.shl(Shift) == AP1)
1522     return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1523 
1524   // Shifting const2 will never be equal to const1.
1525   return getConstant(false);
1526 }
1527 
1528 /// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1529 ///
1530 Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1531                                                           Instruction *LHSI,
1532                                                           ConstantInt *RHS) {
1533   const APInt &RHSV = RHS->getValue();
1534 
1535   switch (LHSI->getOpcode()) {
1536   case Instruction::Trunc:
1537     if (RHS->isOne() && RHSV.getBitWidth() > 1) {
1538       // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1
1539       Value *V = nullptr;
1540       if (ICI.getPredicate() == ICmpInst::ICMP_SLT &&
1541           match(LHSI->getOperand(0), m_Signum(m_Value(V))))
1542         return new ICmpInst(ICmpInst::ICMP_SLT, V,
1543                             ConstantInt::get(V->getType(), 1));
1544     }
1545     if (ICI.isEquality() && LHSI->hasOneUse()) {
1546       // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1547       // of the high bits truncated out of x are known.
1548       unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1549              SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
1550       APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
1551       computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne, 0, &ICI);
1552 
1553       // If all the high bits are known, we can do this xform.
1554       if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1555         // Pull in the high bits from known-ones set.
1556         APInt NewRHS = RHS->getValue().zext(SrcBits);
1557         NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
1558         return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1559                             Builder->getInt(NewRHS));
1560       }
1561     }
1562     break;
1563 
1564   case Instruction::Xor:         // (icmp pred (xor X, XorCst), CI)
1565     if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1566       // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1567       // fold the xor.
1568       if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1569           (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1570         Value *CompareVal = LHSI->getOperand(0);
1571 
1572         // If the sign bit of the XorCst is not set, there is no change to
1573         // the operation, just stop using the Xor.
1574         if (!XorCst->isNegative()) {
1575           ICI.setOperand(0, CompareVal);
1576           Worklist.Add(LHSI);
1577           return &ICI;
1578         }
1579 
1580         // Was the old condition true if the operand is positive?
1581         bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
1582 
1583         // If so, the new one isn't.
1584         isTrueIfPositive ^= true;
1585 
1586         if (isTrueIfPositive)
1587           return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1588                               SubOne(RHS));
1589         else
1590           return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1591                               AddOne(RHS));
1592       }
1593 
1594       if (LHSI->hasOneUse()) {
1595         // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
1596         if (!ICI.isEquality() && XorCst->getValue().isSignBit()) {
1597           const APInt &SignBit = XorCst->getValue();
1598           ICmpInst::Predicate Pred = ICI.isSigned()
1599                                          ? ICI.getUnsignedPredicate()
1600                                          : ICI.getSignedPredicate();
1601           return new ICmpInst(Pred, LHSI->getOperand(0),
1602                               Builder->getInt(RHSV ^ SignBit));
1603         }
1604 
1605         // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
1606         if (!ICI.isEquality() && XorCst->isMaxValue(true)) {
1607           const APInt &NotSignBit = XorCst->getValue();
1608           ICmpInst::Predicate Pred = ICI.isSigned()
1609                                          ? ICI.getUnsignedPredicate()
1610                                          : ICI.getSignedPredicate();
1611           Pred = ICI.getSwappedPredicate(Pred);
1612           return new ICmpInst(Pred, LHSI->getOperand(0),
1613                               Builder->getInt(RHSV ^ NotSignBit));
1614         }
1615       }
1616 
1617       // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1618       //   iff -C is a power of 2
1619       if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
1620           XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1621         return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst);
1622 
1623       // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1624       //   iff -C is a power of 2
1625       if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
1626           XorCst->getValue() == -RHSV && RHSV.isPowerOf2())
1627         return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst);
1628     }
1629     break;
1630   case Instruction::And:         // (icmp pred (and X, AndCst), RHS)
1631     if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1632         LHSI->getOperand(0)->hasOneUse()) {
1633       ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
1634 
1635       // If the LHS is an AND of a truncating cast, we can widen the
1636       // and/compare to be the input width without changing the value
1637       // produced, eliminating a cast.
1638       if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1639         // We can do this transformation if either the AND constant does not
1640         // have its sign bit set or if it is an equality comparison.
1641         // Extending a relational comparison when we're checking the sign
1642         // bit would not work.
1643         if (ICI.isEquality() ||
1644             (!AndCst->isNegative() && RHSV.isNonNegative())) {
1645           Value *NewAnd =
1646             Builder->CreateAnd(Cast->getOperand(0),
1647                                ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
1648           NewAnd->takeName(LHSI);
1649           return new ICmpInst(ICI.getPredicate(), NewAnd,
1650                               ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
1651         }
1652       }
1653 
1654       // If the LHS is an AND of a zext, and we have an equality compare, we can
1655       // shrink the and/compare to the smaller type, eliminating the cast.
1656       if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
1657         IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
1658         // Make sure we don't compare the upper bits, SimplifyDemandedBits
1659         // should fold the icmp to true/false in that case.
1660         if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1661           Value *NewAnd =
1662             Builder->CreateAnd(Cast->getOperand(0),
1663                                ConstantExpr::getTrunc(AndCst, Ty));
1664           NewAnd->takeName(LHSI);
1665           return new ICmpInst(ICI.getPredicate(), NewAnd,
1666                               ConstantExpr::getTrunc(RHS, Ty));
1667         }
1668       }
1669 
1670       // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1671       // could exist), turn it into (X & (C2 << C1)) != (C3 << C1).  This
1672       // happens a LOT in code produced by the C front-end, for bitfield
1673       // access.
1674       BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1675       if (Shift && !Shift->isShift())
1676         Shift = nullptr;
1677 
1678       ConstantInt *ShAmt;
1679       ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
1680 
1681       // This seemingly simple opportunity to fold away a shift turns out to
1682       // be rather complicated. See PR17827
1683       // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
1684       if (ShAmt) {
1685         bool CanFold = false;
1686         unsigned ShiftOpcode = Shift->getOpcode();
1687         if (ShiftOpcode == Instruction::AShr) {
1688           // There may be some constraints that make this possible,
1689           // but nothing simple has been discovered yet.
1690           CanFold = false;
1691         } else if (ShiftOpcode == Instruction::Shl) {
1692           // For a left shift, we can fold if the comparison is not signed.
1693           // We can also fold a signed comparison if the mask value and
1694           // comparison value are not negative. These constraints may not be
1695           // obvious, but we can prove that they are correct using an SMT
1696           // solver.
1697           if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
1698             CanFold = true;
1699         } else if (ShiftOpcode == Instruction::LShr) {
1700           // For a logical right shift, we can fold if the comparison is not
1701           // signed. We can also fold a signed comparison if the shifted mask
1702           // value and the shifted comparison value are not negative.
1703           // These constraints may not be obvious, but we can prove that they
1704           // are correct using an SMT solver.
1705           if (!ICI.isSigned())
1706             CanFold = true;
1707           else {
1708             ConstantInt *ShiftedAndCst =
1709               cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1710             ConstantInt *ShiftedRHSCst =
1711               cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1712 
1713             if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1714               CanFold = true;
1715           }
1716         }
1717 
1718         if (CanFold) {
1719           Constant *NewCst;
1720           if (ShiftOpcode == Instruction::Shl)
1721             NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1722           else
1723             NewCst = ConstantExpr::getShl(RHS, ShAmt);
1724 
1725           // Check to see if we are shifting out any of the bits being
1726           // compared.
1727           if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
1728             // If we shifted bits out, the fold is not going to work out.
1729             // As a special case, check to see if this means that the
1730             // result is always true or false now.
1731             if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1732               return ReplaceInstUsesWith(ICI, Builder->getFalse());
1733             if (ICI.getPredicate() == ICmpInst::ICMP_NE)
1734               return ReplaceInstUsesWith(ICI, Builder->getTrue());
1735           } else {
1736             ICI.setOperand(1, NewCst);
1737             Constant *NewAndCst;
1738             if (ShiftOpcode == Instruction::Shl)
1739               NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
1740             else
1741               NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1742             LHSI->setOperand(1, NewAndCst);
1743             LHSI->setOperand(0, Shift->getOperand(0));
1744             Worklist.Add(Shift); // Shift is dead.
1745             return &ICI;
1746           }
1747         }
1748       }
1749 
1750       // Turn ((X >> Y) & C) == 0  into  (X & (C << Y)) == 0.  The later is
1751       // preferable because it allows the C<<Y expression to be hoisted out
1752       // of a loop if Y is invariant and X is not.
1753       if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1754           ICI.isEquality() && !Shift->isArithmeticShift() &&
1755           !isa<Constant>(Shift->getOperand(0))) {
1756         // Compute C << Y.
1757         Value *NS;
1758         if (Shift->getOpcode() == Instruction::LShr) {
1759           NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
1760         } else {
1761           // Insert a logical shift.
1762           NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
1763         }
1764 
1765         // Compute X & (C << Y).
1766         Value *NewAnd =
1767           Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
1768 
1769         ICI.setOperand(0, NewAnd);
1770         return &ICI;
1771       }
1772 
1773       // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1774       //    (icmp pred (and X, (or (shl 1, Y), 1), 0))
1775       //
1776       // iff pred isn't signed
1777       {
1778         Value *X, *Y, *LShr;
1779         if (!ICI.isSigned() && RHSV == 0) {
1780           if (match(LHSI->getOperand(1), m_One())) {
1781             Constant *One = cast<Constant>(LHSI->getOperand(1));
1782             Value *Or = LHSI->getOperand(0);
1783             if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1784                 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1785               unsigned UsesRemoved = 0;
1786               if (LHSI->hasOneUse())
1787                 ++UsesRemoved;
1788               if (Or->hasOneUse())
1789                 ++UsesRemoved;
1790               if (LShr->hasOneUse())
1791                 ++UsesRemoved;
1792               Value *NewOr = nullptr;
1793               // Compute X & ((1 << Y) | 1)
1794               if (auto *C = dyn_cast<Constant>(Y)) {
1795                 if (UsesRemoved >= 1)
1796                   NewOr =
1797                       ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1798               } else {
1799                 if (UsesRemoved >= 3)
1800                   NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1801                                                                LShr->getName(),
1802                                                                /*HasNUW=*/true),
1803                                             One, Or->getName());
1804               }
1805               if (NewOr) {
1806                 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1807                 ICI.setOperand(0, NewAnd);
1808                 return &ICI;
1809               }
1810             }
1811           }
1812         }
1813       }
1814 
1815       // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1816       // bit set in (X & AndCst) will produce a result greater than RHSV.
1817       if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
1818         unsigned NTZ = AndCst->getValue().countTrailingZeros();
1819         if ((NTZ < AndCst->getBitWidth()) &&
1820             APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV))
1821           return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1822                               Constant::getNullValue(RHS->getType()));
1823       }
1824     }
1825 
1826     // Try to optimize things like "A[i]&42 == 0" to index computations.
1827     if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1828       if (GetElementPtrInst *GEP =
1829           dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1830         if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1831           if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1832               !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1833             ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1834             if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1835               return Res;
1836           }
1837     }
1838 
1839     // X & -C == -C -> X >  u ~C
1840     // X & -C != -C -> X <= u ~C
1841     //   iff C is a power of 2
1842     if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1843       return new ICmpInst(
1844           ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1845                                                   : ICmpInst::ICMP_ULE,
1846           LHSI->getOperand(0), SubOne(RHS));
1847 
1848     // (icmp eq (and %A, C), 0) -> (icmp sgt (trunc %A), -1)
1849     //   iff C is a power of 2
1850     if (ICI.isEquality() && LHSI->hasOneUse() && match(RHS, m_Zero())) {
1851       if (auto *CI = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1852         const APInt &AI = CI->getValue();
1853         int32_t ExactLogBase2 = AI.exactLogBase2();
1854         if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1855           Type *NTy = IntegerType::get(ICI.getContext(), ExactLogBase2 + 1);
1856           Value *Trunc = Builder->CreateTrunc(LHSI->getOperand(0), NTy);
1857           return new ICmpInst(ICI.getPredicate() == ICmpInst::ICMP_EQ
1858                                   ? ICmpInst::ICMP_SGE
1859                                   : ICmpInst::ICMP_SLT,
1860                               Trunc, Constant::getNullValue(NTy));
1861         }
1862       }
1863     }
1864     break;
1865 
1866   case Instruction::Or: {
1867     if (RHS->isOne()) {
1868       // icmp slt signum(V) 1 --> icmp slt V, 1
1869       Value *V = nullptr;
1870       if (ICI.getPredicate() == ICmpInst::ICMP_SLT &&
1871           match(LHSI, m_Signum(m_Value(V))))
1872         return new ICmpInst(ICmpInst::ICMP_SLT, V,
1873                             ConstantInt::get(V->getType(), 1));
1874     }
1875 
1876     if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1877       break;
1878     Value *P, *Q;
1879     if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1880       // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1881       // -> and (icmp eq P, null), (icmp eq Q, null).
1882       Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1883                                         Constant::getNullValue(P->getType()));
1884       Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1885                                         Constant::getNullValue(Q->getType()));
1886       Instruction *Op;
1887       if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1888         Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1889       else
1890         Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1891       return Op;
1892     }
1893     break;
1894   }
1895 
1896   case Instruction::Mul: {       // (icmp pred (mul X, Val), CI)
1897     ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1898     if (!Val) break;
1899 
1900     // If this is a signed comparison to 0 and the mul is sign preserving,
1901     // use the mul LHS operand instead.
1902     ICmpInst::Predicate pred = ICI.getPredicate();
1903     if (isSignTest(pred, RHS) && !Val->isZero() &&
1904         cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1905       return new ICmpInst(Val->isNegative() ?
1906                           ICmpInst::getSwappedPredicate(pred) : pred,
1907                           LHSI->getOperand(0),
1908                           Constant::getNullValue(RHS->getType()));
1909 
1910     break;
1911   }
1912 
1913   case Instruction::Shl: {       // (icmp pred (shl X, ShAmt), CI)
1914     uint32_t TypeBits = RHSV.getBitWidth();
1915     ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1916     if (!ShAmt) {
1917       Value *X;
1918       // (1 << X) pred P2 -> X pred Log2(P2)
1919       if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1920         bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1921         ICmpInst::Predicate Pred = ICI.getPredicate();
1922         if (ICI.isUnsigned()) {
1923           if (!RHSVIsPowerOf2) {
1924             // (1 << X) <  30 -> X <= 4
1925             // (1 << X) <= 30 -> X <= 4
1926             // (1 << X) >= 30 -> X >  4
1927             // (1 << X) >  30 -> X >  4
1928             if (Pred == ICmpInst::ICMP_ULT)
1929               Pred = ICmpInst::ICMP_ULE;
1930             else if (Pred == ICmpInst::ICMP_UGE)
1931               Pred = ICmpInst::ICMP_UGT;
1932           }
1933           unsigned RHSLog2 = RHSV.logBase2();
1934 
1935           // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
1936           // (1 << X) <  2147483648 -> X <  31 -> X != 31
1937           if (RHSLog2 == TypeBits-1) {
1938             if (Pred == ICmpInst::ICMP_UGE)
1939               Pred = ICmpInst::ICMP_EQ;
1940             else if (Pred == ICmpInst::ICMP_ULT)
1941               Pred = ICmpInst::ICMP_NE;
1942           }
1943 
1944           return new ICmpInst(Pred, X,
1945                               ConstantInt::get(RHS->getType(), RHSLog2));
1946         } else if (ICI.isSigned()) {
1947           if (RHSV.isAllOnesValue()) {
1948             // (1 << X) <= -1 -> X == 31
1949             if (Pred == ICmpInst::ICMP_SLE)
1950               return new ICmpInst(ICmpInst::ICMP_EQ, X,
1951                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1952 
1953             // (1 << X) >  -1 -> X != 31
1954             if (Pred == ICmpInst::ICMP_SGT)
1955               return new ICmpInst(ICmpInst::ICMP_NE, X,
1956                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1957           } else if (!RHSV) {
1958             // (1 << X) <  0 -> X == 31
1959             // (1 << X) <= 0 -> X == 31
1960             if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1961               return new ICmpInst(ICmpInst::ICMP_EQ, X,
1962                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1963 
1964             // (1 << X) >= 0 -> X != 31
1965             // (1 << X) >  0 -> X != 31
1966             if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1967               return new ICmpInst(ICmpInst::ICMP_NE, X,
1968                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1969           }
1970         } else if (ICI.isEquality()) {
1971           if (RHSVIsPowerOf2)
1972             return new ICmpInst(
1973                 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
1974         }
1975       }
1976       break;
1977     }
1978 
1979     // Check that the shift amount is in range.  If not, don't perform
1980     // undefined shifts.  When the shift is visited it will be
1981     // simplified.
1982     if (ShAmt->uge(TypeBits))
1983       break;
1984 
1985     if (ICI.isEquality()) {
1986       // If we are comparing against bits always shifted out, the
1987       // comparison cannot succeed.
1988       Constant *Comp =
1989         ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1990                                                                  ShAmt);
1991       if (Comp != RHS) {// Comparing against a bit that we know is zero.
1992         bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1993         Constant *Cst = Builder->getInt1(IsICMP_NE);
1994         return ReplaceInstUsesWith(ICI, Cst);
1995       }
1996 
1997       // If the shift is NUW, then it is just shifting out zeros, no need for an
1998       // AND.
1999       if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
2000         return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
2001                             ConstantExpr::getLShr(RHS, ShAmt));
2002 
2003       // If the shift is NSW and we compare to 0, then it is just shifting out
2004       // sign bits, no need for an AND either.
2005       if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
2006         return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
2007                             ConstantExpr::getLShr(RHS, ShAmt));
2008 
2009       if (LHSI->hasOneUse()) {
2010         // Otherwise strength reduce the shift into an and.
2011         uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
2012         Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
2013                                                           TypeBits - ShAmtVal));
2014 
2015         Value *And =
2016           Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
2017         return new ICmpInst(ICI.getPredicate(), And,
2018                             ConstantExpr::getLShr(RHS, ShAmt));
2019       }
2020     }
2021 
2022     // If this is a signed comparison to 0 and the shift is sign preserving,
2023     // use the shift LHS operand instead.
2024     ICmpInst::Predicate pred = ICI.getPredicate();
2025     if (isSignTest(pred, RHS) &&
2026         cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
2027       return new ICmpInst(pred,
2028                           LHSI->getOperand(0),
2029                           Constant::getNullValue(RHS->getType()));
2030 
2031     // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
2032     bool TrueIfSigned = false;
2033     if (LHSI->hasOneUse() &&
2034         isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
2035       // (X << 31) <s 0  --> (X&1) != 0
2036       Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
2037                                         APInt::getOneBitSet(TypeBits,
2038                                             TypeBits-ShAmt->getZExtValue()-1));
2039       Value *And =
2040         Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
2041       return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
2042                           And, Constant::getNullValue(And->getType()));
2043     }
2044 
2045     // Transform (icmp pred iM (shl iM %v, N), CI)
2046     // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
2047     // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
2048     // This enables to get rid of the shift in favor of a trunc which can be
2049     // free on the target. It has the additional benefit of comparing to a
2050     // smaller constant, which will be target friendly.
2051     unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
2052     if (LHSI->hasOneUse() &&
2053         Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
2054       Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
2055       Constant *NCI = ConstantExpr::getTrunc(
2056                         ConstantExpr::getAShr(RHS,
2057                           ConstantInt::get(RHS->getType(), Amt)),
2058                         NTy);
2059       return new ICmpInst(ICI.getPredicate(),
2060                           Builder->CreateTrunc(LHSI->getOperand(0), NTy),
2061                           NCI);
2062     }
2063 
2064     break;
2065   }
2066 
2067   case Instruction::LShr:         // (icmp pred (shr X, ShAmt), CI)
2068   case Instruction::AShr: {
2069     // Handle equality comparisons of shift-by-constant.
2070     BinaryOperator *BO = cast<BinaryOperator>(LHSI);
2071     if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
2072       if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
2073         return Res;
2074     }
2075 
2076     // Handle exact shr's.
2077     if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
2078       if (RHSV.isMinValue())
2079         return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
2080     }
2081     break;
2082   }
2083 
2084   case Instruction::SDiv:
2085   case Instruction::UDiv:
2086     // Fold: icmp pred ([us]div X, C1), C2 -> range test
2087     // Fold this div into the comparison, producing a range check.
2088     // Determine, based on the divide type, what the range is being
2089     // checked.  If there is an overflow on the low or high side, remember
2090     // it, otherwise compute the range [low, hi) bounding the new value.
2091     // See: InsertRangeTest above for the kinds of replacements possible.
2092     if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
2093       if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
2094                                           DivRHS))
2095         return R;
2096     break;
2097 
2098   case Instruction::Sub: {
2099     ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
2100     if (!LHSC) break;
2101     const APInt &LHSV = LHSC->getValue();
2102 
2103     // C1-X <u C2 -> (X|(C2-1)) == C1
2104     //   iff C1 & (C2-1) == C2-1
2105     //       C2 is a power of 2
2106     if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
2107         RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
2108       return new ICmpInst(ICmpInst::ICMP_EQ,
2109                           Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
2110                           LHSC);
2111 
2112     // C1-X >u C2 -> (X|C2) != C1
2113     //   iff C1 & C2 == C2
2114     //       C2+1 is a power of 2
2115     if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
2116         (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
2117       return new ICmpInst(ICmpInst::ICMP_NE,
2118                           Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
2119     break;
2120   }
2121 
2122   case Instruction::Add:
2123     // Fold: icmp pred (add X, C1), C2
2124     if (!ICI.isEquality()) {
2125       ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
2126       if (!LHSC) break;
2127       const APInt &LHSV = LHSC->getValue();
2128 
2129       ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
2130                             .subtract(LHSV);
2131 
2132       if (ICI.isSigned()) {
2133         if (CR.getLower().isSignBit()) {
2134           return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
2135                               Builder->getInt(CR.getUpper()));
2136         } else if (CR.getUpper().isSignBit()) {
2137           return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
2138                               Builder->getInt(CR.getLower()));
2139         }
2140       } else {
2141         if (CR.getLower().isMinValue()) {
2142           return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
2143                               Builder->getInt(CR.getUpper()));
2144         } else if (CR.getUpper().isMinValue()) {
2145           return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
2146                               Builder->getInt(CR.getLower()));
2147         }
2148       }
2149 
2150       // X-C1 <u C2 -> (X & -C2) == C1
2151       //   iff C1 & (C2-1) == 0
2152       //       C2 is a power of 2
2153       if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
2154           RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
2155         return new ICmpInst(ICmpInst::ICMP_EQ,
2156                             Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
2157                             ConstantExpr::getNeg(LHSC));
2158 
2159       // X-C1 >u C2 -> (X & ~C2) != C1
2160       //   iff C1 & C2 == 0
2161       //       C2+1 is a power of 2
2162       if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
2163           (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
2164         return new ICmpInst(ICmpInst::ICMP_NE,
2165                             Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
2166                             ConstantExpr::getNeg(LHSC));
2167     }
2168     break;
2169   }
2170 
2171   // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
2172   if (ICI.isEquality()) {
2173     bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
2174 
2175     // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
2176     // the second operand is a constant, simplify a bit.
2177     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
2178       switch (BO->getOpcode()) {
2179       case Instruction::SRem:
2180         // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
2181         if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
2182           const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
2183           if (V.sgt(1) && V.isPowerOf2()) {
2184             Value *NewRem =
2185               Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
2186                                   BO->getName());
2187             return new ICmpInst(ICI.getPredicate(), NewRem,
2188                                 Constant::getNullValue(BO->getType()));
2189           }
2190         }
2191         break;
2192       case Instruction::Add:
2193         // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
2194         if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2195           if (BO->hasOneUse())
2196             return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2197                                 ConstantExpr::getSub(RHS, BOp1C));
2198         } else if (RHSV == 0) {
2199           // Replace ((add A, B) != 0) with (A != -B) if A or B is
2200           // efficiently invertible, or if the add has just this one use.
2201           Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
2202 
2203           if (Value *NegVal = dyn_castNegVal(BOp1))
2204             return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
2205           if (Value *NegVal = dyn_castNegVal(BOp0))
2206             return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
2207           if (BO->hasOneUse()) {
2208             Value *Neg = Builder->CreateNeg(BOp1);
2209             Neg->takeName(BO);
2210             return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
2211           }
2212         }
2213         break;
2214       case Instruction::Xor:
2215         // For the xor case, we can xor two constants together, eliminating
2216         // the explicit xor.
2217         if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
2218           return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2219                               ConstantExpr::getXor(RHS, BOC));
2220         } else if (RHSV == 0) {
2221           // Replace ((xor A, B) != 0) with (A != B)
2222           return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2223                               BO->getOperand(1));
2224         }
2225         break;
2226       case Instruction::Sub:
2227         // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
2228         if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
2229           if (BO->hasOneUse())
2230             return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
2231                                 ConstantExpr::getSub(BOp0C, RHS));
2232         } else if (RHSV == 0) {
2233           // Replace ((sub A, B) != 0) with (A != B)
2234           return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2235                               BO->getOperand(1));
2236         }
2237         break;
2238       case Instruction::Or:
2239         // If bits are being or'd in that are not present in the constant we
2240         // are comparing against, then the comparison could never succeed!
2241         if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2242           Constant *NotCI = ConstantExpr::getNot(RHS);
2243           if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
2244             return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
2245         }
2246         break;
2247 
2248       case Instruction::And:
2249         if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2250           // If bits are being compared against that are and'd out, then the
2251           // comparison can never succeed!
2252           if ((RHSV & ~BOC->getValue()) != 0)
2253             return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
2254 
2255           // If we have ((X & C) == C), turn it into ((X & C) != 0).
2256           if (RHS == BOC && RHSV.isPowerOf2())
2257             return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
2258                                 ICmpInst::ICMP_NE, LHSI,
2259                                 Constant::getNullValue(RHS->getType()));
2260 
2261           // Don't perform the following transforms if the AND has multiple uses
2262           if (!BO->hasOneUse())
2263             break;
2264 
2265           // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
2266           if (BOC->getValue().isSignBit()) {
2267             Value *X = BO->getOperand(0);
2268             Constant *Zero = Constant::getNullValue(X->getType());
2269             ICmpInst::Predicate pred = isICMP_NE ?
2270               ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
2271             return new ICmpInst(pred, X, Zero);
2272           }
2273 
2274           // ((X & ~7) == 0) --> X < 8
2275           if (RHSV == 0 && isHighOnes(BOC)) {
2276             Value *X = BO->getOperand(0);
2277             Constant *NegX = ConstantExpr::getNeg(BOC);
2278             ICmpInst::Predicate pred = isICMP_NE ?
2279               ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
2280             return new ICmpInst(pred, X, NegX);
2281           }
2282         }
2283         break;
2284       case Instruction::Mul:
2285         if (RHSV == 0 && BO->hasNoSignedWrap()) {
2286           if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2287             // The trivial case (mul X, 0) is handled by InstSimplify
2288             // General case : (mul X, C) != 0 iff X != 0
2289             //                (mul X, C) == 0 iff X == 0
2290             if (!BOC->isZero())
2291               return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2292                                   Constant::getNullValue(RHS->getType()));
2293           }
2294         }
2295         break;
2296       default: break;
2297       }
2298     } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
2299       // Handle icmp {eq|ne} <intrinsic>, intcst.
2300       switch (II->getIntrinsicID()) {
2301       case Intrinsic::bswap:
2302         Worklist.Add(II);
2303         ICI.setOperand(0, II->getArgOperand(0));
2304         ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
2305         return &ICI;
2306       case Intrinsic::ctlz:
2307       case Intrinsic::cttz:
2308         // ctz(A) == bitwidth(a)  ->  A == 0 and likewise for !=
2309         if (RHSV == RHS->getType()->getBitWidth()) {
2310           Worklist.Add(II);
2311           ICI.setOperand(0, II->getArgOperand(0));
2312           ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
2313           return &ICI;
2314         }
2315         break;
2316       case Intrinsic::ctpop:
2317         // popcount(A) == 0  ->  A == 0 and likewise for !=
2318         if (RHS->isZero()) {
2319           Worklist.Add(II);
2320           ICI.setOperand(0, II->getArgOperand(0));
2321           ICI.setOperand(1, RHS);
2322           return &ICI;
2323         }
2324         break;
2325       default:
2326         break;
2327       }
2328     }
2329   }
2330   return nullptr;
2331 }
2332 
2333 /// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
2334 /// We only handle extending casts so far.
2335 ///
2336 Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
2337   const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
2338   Value *LHSCIOp        = LHSCI->getOperand(0);
2339   Type *SrcTy     = LHSCIOp->getType();
2340   Type *DestTy    = LHSCI->getType();
2341   Value *RHSCIOp;
2342 
2343   // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
2344   // integer type is the same size as the pointer type.
2345   if (LHSCI->getOpcode() == Instruction::PtrToInt &&
2346       DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
2347     Value *RHSOp = nullptr;
2348     if (PtrToIntOperator *RHSC = dyn_cast<PtrToIntOperator>(ICI.getOperand(1))) {
2349       Value *RHSCIOp = RHSC->getOperand(0);
2350       if (RHSCIOp->getType()->getPointerAddressSpace() ==
2351           LHSCIOp->getType()->getPointerAddressSpace()) {
2352         RHSOp = RHSC->getOperand(0);
2353         // If the pointer types don't match, insert a bitcast.
2354         if (LHSCIOp->getType() != RHSOp->getType())
2355           RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
2356       }
2357     } else if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1)))
2358       RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
2359 
2360     if (RHSOp)
2361       return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
2362   }
2363 
2364   // The code below only handles extension cast instructions, so far.
2365   // Enforce this.
2366   if (LHSCI->getOpcode() != Instruction::ZExt &&
2367       LHSCI->getOpcode() != Instruction::SExt)
2368     return nullptr;
2369 
2370   bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
2371   bool isSignedCmp = ICI.isSigned();
2372 
2373   if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
2374     // Not an extension from the same type?
2375     RHSCIOp = CI->getOperand(0);
2376     if (RHSCIOp->getType() != LHSCIOp->getType())
2377       return nullptr;
2378 
2379     // If the signedness of the two casts doesn't agree (i.e. one is a sext
2380     // and the other is a zext), then we can't handle this.
2381     if (CI->getOpcode() != LHSCI->getOpcode())
2382       return nullptr;
2383 
2384     // Deal with equality cases early.
2385     if (ICI.isEquality())
2386       return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
2387 
2388     // A signed comparison of sign extended values simplifies into a
2389     // signed comparison.
2390     if (isSignedCmp && isSignedExt)
2391       return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
2392 
2393     // The other three cases all fold into an unsigned comparison.
2394     return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
2395   }
2396 
2397   // If we aren't dealing with a constant on the RHS, exit early
2398   ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
2399   if (!CI)
2400     return nullptr;
2401 
2402   // Compute the constant that would happen if we truncated to SrcTy then
2403   // reextended to DestTy.
2404   Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
2405   Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
2406                                                 Res1, DestTy);
2407 
2408   // If the re-extended constant didn't change...
2409   if (Res2 == CI) {
2410     // Deal with equality cases early.
2411     if (ICI.isEquality())
2412       return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
2413 
2414     // A signed comparison of sign extended values simplifies into a
2415     // signed comparison.
2416     if (isSignedExt && isSignedCmp)
2417       return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
2418 
2419     // The other three cases all fold into an unsigned comparison.
2420     return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
2421   }
2422 
2423   // The re-extended constant changed so the constant cannot be represented
2424   // in the shorter type. Consequently, we cannot emit a simple comparison.
2425   // All the cases that fold to true or false will have already been handled
2426   // by SimplifyICmpInst, so only deal with the tricky case.
2427 
2428   if (isSignedCmp || !isSignedExt)
2429     return nullptr;
2430 
2431   // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
2432   // should have been folded away previously and not enter in here.
2433 
2434   // We're performing an unsigned comp with a sign extended value.
2435   // This is true if the input is >= 0. [aka >s -1]
2436   Constant *NegOne = Constant::getAllOnesValue(SrcTy);
2437   Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
2438 
2439   // Finally, return the value computed.
2440   if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
2441     return ReplaceInstUsesWith(ICI, Result);
2442 
2443   assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
2444   return BinaryOperator::CreateNot(Result);
2445 }
2446 
2447 /// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
2448 ///   I = icmp ugt (add (add A, B), CI2), CI1
2449 /// If this is of the form:
2450 ///   sum = a + b
2451 ///   if (sum+128 >u 255)
2452 /// Then replace it with llvm.sadd.with.overflow.i8.
2453 ///
2454 static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2455                                           ConstantInt *CI2, ConstantInt *CI1,
2456                                           InstCombiner &IC) {
2457   // The transformation we're trying to do here is to transform this into an
2458   // llvm.sadd.with.overflow.  To do this, we have to replace the original add
2459   // with a narrower add, and discard the add-with-constant that is part of the
2460   // range check (if we can't eliminate it, this isn't profitable).
2461 
2462   // In order to eliminate the add-with-constant, the compare can be its only
2463   // use.
2464   Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
2465   if (!AddWithCst->hasOneUse()) return nullptr;
2466 
2467   // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
2468   if (!CI2->getValue().isPowerOf2()) return nullptr;
2469   unsigned NewWidth = CI2->getValue().countTrailingZeros();
2470   if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
2471 
2472   // The width of the new add formed is 1 more than the bias.
2473   ++NewWidth;
2474 
2475   // Check to see that CI1 is an all-ones value with NewWidth bits.
2476   if (CI1->getBitWidth() == NewWidth ||
2477       CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
2478     return nullptr;
2479 
2480   // This is only really a signed overflow check if the inputs have been
2481   // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2482   // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2483   unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
2484   if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
2485       IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
2486     return nullptr;
2487 
2488   // In order to replace the original add with a narrower
2489   // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2490   // and truncates that discard the high bits of the add.  Verify that this is
2491   // the case.
2492   Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
2493   for (User *U : OrigAdd->users()) {
2494     if (U == AddWithCst) continue;
2495 
2496     // Only accept truncates for now.  We would really like a nice recursive
2497     // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2498     // chain to see which bits of a value are actually demanded.  If the
2499     // original add had another add which was then immediately truncated, we
2500     // could still do the transformation.
2501     TruncInst *TI = dyn_cast<TruncInst>(U);
2502     if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2503       return nullptr;
2504   }
2505 
2506   // If the pattern matches, truncate the inputs to the narrower type and
2507   // use the sadd_with_overflow intrinsic to efficiently compute both the
2508   // result and the overflow bit.
2509   Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
2510   Value *F = Intrinsic::getDeclaration(I.getModule(),
2511                                        Intrinsic::sadd_with_overflow, NewType);
2512 
2513   InstCombiner::BuilderTy *Builder = IC.Builder;
2514 
2515   // Put the new code above the original add, in case there are any uses of the
2516   // add between the add and the compare.
2517   Builder->SetInsertPoint(OrigAdd);
2518 
2519   Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2520   Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
2521   CallInst *Call = Builder->CreateCall(F, {TruncA, TruncB}, "sadd");
2522   Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2523   Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
2524 
2525   // The inner add was the result of the narrow add, zero extended to the
2526   // wider type.  Replace it with the result computed by the intrinsic.
2527   IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
2528 
2529   // The original icmp gets replaced with the overflow value.
2530   return ExtractValueInst::Create(Call, 1, "sadd.overflow");
2531 }
2532 
2533 bool InstCombiner::OptimizeOverflowCheck(OverflowCheckFlavor OCF, Value *LHS,
2534                                          Value *RHS, Instruction &OrigI,
2535                                          Value *&Result, Constant *&Overflow) {
2536   if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
2537     std::swap(LHS, RHS);
2538 
2539   auto SetResult = [&](Value *OpResult, Constant *OverflowVal, bool ReuseName) {
2540     Result = OpResult;
2541     Overflow = OverflowVal;
2542     if (ReuseName)
2543       Result->takeName(&OrigI);
2544     return true;
2545   };
2546 
2547   // If the overflow check was an add followed by a compare, the insertion point
2548   // may be pointing to the compare.  We want to insert the new instructions
2549   // before the add in case there are uses of the add between the add and the
2550   // compare.
2551   Builder->SetInsertPoint(&OrigI);
2552 
2553   switch (OCF) {
2554   case OCF_INVALID:
2555     llvm_unreachable("bad overflow check kind!");
2556 
2557   case OCF_UNSIGNED_ADD: {
2558     OverflowResult OR = computeOverflowForUnsignedAdd(LHS, RHS, &OrigI);
2559     if (OR == OverflowResult::NeverOverflows)
2560       return SetResult(Builder->CreateNUWAdd(LHS, RHS), Builder->getFalse(),
2561                        true);
2562 
2563     if (OR == OverflowResult::AlwaysOverflows)
2564       return SetResult(Builder->CreateAdd(LHS, RHS), Builder->getTrue(), true);
2565   }
2566   // FALL THROUGH uadd into sadd
2567   case OCF_SIGNED_ADD: {
2568     // X + 0 -> {X, false}
2569     if (match(RHS, m_Zero()))
2570       return SetResult(LHS, Builder->getFalse(), false);
2571 
2572     // We can strength reduce this signed add into a regular add if we can prove
2573     // that it will never overflow.
2574     if (OCF == OCF_SIGNED_ADD)
2575       if (WillNotOverflowSignedAdd(LHS, RHS, OrigI))
2576         return SetResult(Builder->CreateNSWAdd(LHS, RHS), Builder->getFalse(),
2577                          true);
2578     break;
2579   }
2580 
2581   case OCF_UNSIGNED_SUB:
2582   case OCF_SIGNED_SUB: {
2583     // X - 0 -> {X, false}
2584     if (match(RHS, m_Zero()))
2585       return SetResult(LHS, Builder->getFalse(), false);
2586 
2587     if (OCF == OCF_SIGNED_SUB) {
2588       if (WillNotOverflowSignedSub(LHS, RHS, OrigI))
2589         return SetResult(Builder->CreateNSWSub(LHS, RHS), Builder->getFalse(),
2590                          true);
2591     } else {
2592       if (WillNotOverflowUnsignedSub(LHS, RHS, OrigI))
2593         return SetResult(Builder->CreateNUWSub(LHS, RHS), Builder->getFalse(),
2594                          true);
2595     }
2596     break;
2597   }
2598 
2599   case OCF_UNSIGNED_MUL: {
2600     OverflowResult OR = computeOverflowForUnsignedMul(LHS, RHS, &OrigI);
2601     if (OR == OverflowResult::NeverOverflows)
2602       return SetResult(Builder->CreateNUWMul(LHS, RHS), Builder->getFalse(),
2603                        true);
2604     if (OR == OverflowResult::AlwaysOverflows)
2605       return SetResult(Builder->CreateMul(LHS, RHS), Builder->getTrue(), true);
2606   } // FALL THROUGH
2607   case OCF_SIGNED_MUL:
2608     // X * undef -> undef
2609     if (isa<UndefValue>(RHS))
2610       return SetResult(RHS, UndefValue::get(Builder->getInt1Ty()), false);
2611 
2612     // X * 0 -> {0, false}
2613     if (match(RHS, m_Zero()))
2614       return SetResult(RHS, Builder->getFalse(), false);
2615 
2616     // X * 1 -> {X, false}
2617     if (match(RHS, m_One()))
2618       return SetResult(LHS, Builder->getFalse(), false);
2619 
2620     if (OCF == OCF_SIGNED_MUL)
2621       if (WillNotOverflowSignedMul(LHS, RHS, OrigI))
2622         return SetResult(Builder->CreateNSWMul(LHS, RHS), Builder->getFalse(),
2623                          true);
2624     break;
2625   }
2626 
2627   return false;
2628 }
2629 
2630 /// \brief Recognize and process idiom involving test for multiplication
2631 /// overflow.
2632 ///
2633 /// The caller has matched a pattern of the form:
2634 ///   I = cmp u (mul(zext A, zext B), V
2635 /// The function checks if this is a test for overflow and if so replaces
2636 /// multiplication with call to 'mul.with.overflow' intrinsic.
2637 ///
2638 /// \param I Compare instruction.
2639 /// \param MulVal Result of 'mult' instruction.  It is one of the arguments of
2640 ///               the compare instruction.  Must be of integer type.
2641 /// \param OtherVal The other argument of compare instruction.
2642 /// \returns Instruction which must replace the compare instruction, NULL if no
2643 ///          replacement required.
2644 static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2645                                          Value *OtherVal, InstCombiner &IC) {
2646   // Don't bother doing this transformation for pointers, don't do it for
2647   // vectors.
2648   if (!isa<IntegerType>(MulVal->getType()))
2649     return nullptr;
2650 
2651   assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2652   assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
2653   auto *MulInstr = dyn_cast<Instruction>(MulVal);
2654   if (!MulInstr)
2655     return nullptr;
2656   assert(MulInstr->getOpcode() == Instruction::Mul);
2657 
2658   auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
2659        *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
2660   assert(LHS->getOpcode() == Instruction::ZExt);
2661   assert(RHS->getOpcode() == Instruction::ZExt);
2662   Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2663 
2664   // Calculate type and width of the result produced by mul.with.overflow.
2665   Type *TyA = A->getType(), *TyB = B->getType();
2666   unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2667            WidthB = TyB->getPrimitiveSizeInBits();
2668   unsigned MulWidth;
2669   Type *MulType;
2670   if (WidthB > WidthA) {
2671     MulWidth = WidthB;
2672     MulType = TyB;
2673   } else {
2674     MulWidth = WidthA;
2675     MulType = TyA;
2676   }
2677 
2678   // In order to replace the original mul with a narrower mul.with.overflow,
2679   // all uses must ignore upper bits of the product.  The number of used low
2680   // bits must be not greater than the width of mul.with.overflow.
2681   if (MulVal->hasNUsesOrMore(2))
2682     for (User *U : MulVal->users()) {
2683       if (U == &I)
2684         continue;
2685       if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2686         // Check if truncation ignores bits above MulWidth.
2687         unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2688         if (TruncWidth > MulWidth)
2689           return nullptr;
2690       } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2691         // Check if AND ignores bits above MulWidth.
2692         if (BO->getOpcode() != Instruction::And)
2693           return nullptr;
2694         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2695           const APInt &CVal = CI->getValue();
2696           if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
2697             return nullptr;
2698         }
2699       } else {
2700         // Other uses prohibit this transformation.
2701         return nullptr;
2702       }
2703     }
2704 
2705   // Recognize patterns
2706   switch (I.getPredicate()) {
2707   case ICmpInst::ICMP_EQ:
2708   case ICmpInst::ICMP_NE:
2709     // Recognize pattern:
2710     //   mulval = mul(zext A, zext B)
2711     //   cmp eq/neq mulval, zext trunc mulval
2712     if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2713       if (Zext->hasOneUse()) {
2714         Value *ZextArg = Zext->getOperand(0);
2715         if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2716           if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2717             break; //Recognized
2718       }
2719 
2720     // Recognize pattern:
2721     //   mulval = mul(zext A, zext B)
2722     //   cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2723     ConstantInt *CI;
2724     Value *ValToMask;
2725     if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2726       if (ValToMask != MulVal)
2727         return nullptr;
2728       const APInt &CVal = CI->getValue() + 1;
2729       if (CVal.isPowerOf2()) {
2730         unsigned MaskWidth = CVal.logBase2();
2731         if (MaskWidth == MulWidth)
2732           break; // Recognized
2733       }
2734     }
2735     return nullptr;
2736 
2737   case ICmpInst::ICMP_UGT:
2738     // Recognize pattern:
2739     //   mulval = mul(zext A, zext B)
2740     //   cmp ugt mulval, max
2741     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2742       APInt MaxVal = APInt::getMaxValue(MulWidth);
2743       MaxVal = MaxVal.zext(CI->getBitWidth());
2744       if (MaxVal.eq(CI->getValue()))
2745         break; // Recognized
2746     }
2747     return nullptr;
2748 
2749   case ICmpInst::ICMP_UGE:
2750     // Recognize pattern:
2751     //   mulval = mul(zext A, zext B)
2752     //   cmp uge mulval, max+1
2753     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2754       APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2755       if (MaxVal.eq(CI->getValue()))
2756         break; // Recognized
2757     }
2758     return nullptr;
2759 
2760   case ICmpInst::ICMP_ULE:
2761     // Recognize pattern:
2762     //   mulval = mul(zext A, zext B)
2763     //   cmp ule mulval, max
2764     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2765       APInt MaxVal = APInt::getMaxValue(MulWidth);
2766       MaxVal = MaxVal.zext(CI->getBitWidth());
2767       if (MaxVal.eq(CI->getValue()))
2768         break; // Recognized
2769     }
2770     return nullptr;
2771 
2772   case ICmpInst::ICMP_ULT:
2773     // Recognize pattern:
2774     //   mulval = mul(zext A, zext B)
2775     //   cmp ule mulval, max + 1
2776     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2777       APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2778       if (MaxVal.eq(CI->getValue()))
2779         break; // Recognized
2780     }
2781     return nullptr;
2782 
2783   default:
2784     return nullptr;
2785   }
2786 
2787   InstCombiner::BuilderTy *Builder = IC.Builder;
2788   Builder->SetInsertPoint(MulInstr);
2789 
2790   // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2791   Value *MulA = A, *MulB = B;
2792   if (WidthA < MulWidth)
2793     MulA = Builder->CreateZExt(A, MulType);
2794   if (WidthB < MulWidth)
2795     MulB = Builder->CreateZExt(B, MulType);
2796   Value *F = Intrinsic::getDeclaration(I.getModule(),
2797                                        Intrinsic::umul_with_overflow, MulType);
2798   CallInst *Call = Builder->CreateCall(F, {MulA, MulB}, "umul");
2799   IC.Worklist.Add(MulInstr);
2800 
2801   // If there are uses of mul result other than the comparison, we know that
2802   // they are truncation or binary AND. Change them to use result of
2803   // mul.with.overflow and adjust properly mask/size.
2804   if (MulVal->hasNUsesOrMore(2)) {
2805     Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2806     for (User *U : MulVal->users()) {
2807       if (U == &I || U == OtherVal)
2808         continue;
2809       if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2810         if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
2811           IC.ReplaceInstUsesWith(*TI, Mul);
2812         else
2813           TI->setOperand(0, Mul);
2814       } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2815         assert(BO->getOpcode() == Instruction::And);
2816         // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2817         ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2818         APInt ShortMask = CI->getValue().trunc(MulWidth);
2819         Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2820         Instruction *Zext =
2821             cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2822         IC.Worklist.Add(Zext);
2823         IC.ReplaceInstUsesWith(*BO, Zext);
2824       } else {
2825         llvm_unreachable("Unexpected Binary operation");
2826       }
2827       IC.Worklist.Add(cast<Instruction>(U));
2828     }
2829   }
2830   if (isa<Instruction>(OtherVal))
2831     IC.Worklist.Add(cast<Instruction>(OtherVal));
2832 
2833   // The original icmp gets replaced with the overflow value, maybe inverted
2834   // depending on predicate.
2835   bool Inverse = false;
2836   switch (I.getPredicate()) {
2837   case ICmpInst::ICMP_NE:
2838     break;
2839   case ICmpInst::ICMP_EQ:
2840     Inverse = true;
2841     break;
2842   case ICmpInst::ICMP_UGT:
2843   case ICmpInst::ICMP_UGE:
2844     if (I.getOperand(0) == MulVal)
2845       break;
2846     Inverse = true;
2847     break;
2848   case ICmpInst::ICMP_ULT:
2849   case ICmpInst::ICMP_ULE:
2850     if (I.getOperand(1) == MulVal)
2851       break;
2852     Inverse = true;
2853     break;
2854   default:
2855     llvm_unreachable("Unexpected predicate");
2856   }
2857   if (Inverse) {
2858     Value *Res = Builder->CreateExtractValue(Call, 1);
2859     return BinaryOperator::CreateNot(Res);
2860   }
2861 
2862   return ExtractValueInst::Create(Call, 1);
2863 }
2864 
2865 // DemandedBitsLHSMask - When performing a comparison against a constant,
2866 // it is possible that not all the bits in the LHS are demanded.  This helper
2867 // method computes the mask that IS demanded.
2868 static APInt DemandedBitsLHSMask(ICmpInst &I,
2869                                  unsigned BitWidth, bool isSignCheck) {
2870   if (isSignCheck)
2871     return APInt::getSignBit(BitWidth);
2872 
2873   ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2874   if (!CI) return APInt::getAllOnesValue(BitWidth);
2875   const APInt &RHS = CI->getValue();
2876 
2877   switch (I.getPredicate()) {
2878   // For a UGT comparison, we don't care about any bits that
2879   // correspond to the trailing ones of the comparand.  The value of these
2880   // bits doesn't impact the outcome of the comparison, because any value
2881   // greater than the RHS must differ in a bit higher than these due to carry.
2882   case ICmpInst::ICMP_UGT: {
2883     unsigned trailingOnes = RHS.countTrailingOnes();
2884     APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2885     return ~lowBitsSet;
2886   }
2887 
2888   // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2889   // Any value less than the RHS must differ in a higher bit because of carries.
2890   case ICmpInst::ICMP_ULT: {
2891     unsigned trailingZeros = RHS.countTrailingZeros();
2892     APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2893     return ~lowBitsSet;
2894   }
2895 
2896   default:
2897     return APInt::getAllOnesValue(BitWidth);
2898   }
2899 }
2900 
2901 /// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
2902 /// should be swapped.
2903 /// The decision is based on how many times these two operands are reused
2904 /// as subtract operands and their positions in those instructions.
2905 /// The rational is that several architectures use the same instruction for
2906 /// both subtract and cmp, thus it is better if the order of those operands
2907 /// match.
2908 /// \return true if Op0 and Op1 should be swapped.
2909 static bool swapMayExposeCSEOpportunities(const Value * Op0,
2910                                           const Value * Op1) {
2911   // Filter out pointer value as those cannot appears directly in subtract.
2912   // FIXME: we may want to go through inttoptrs or bitcasts.
2913   if (Op0->getType()->isPointerTy())
2914     return false;
2915   // Count every uses of both Op0 and Op1 in a subtract.
2916   // Each time Op0 is the first operand, count -1: swapping is bad, the
2917   // subtract has already the same layout as the compare.
2918   // Each time Op0 is the second operand, count +1: swapping is good, the
2919   // subtract has a different layout as the compare.
2920   // At the end, if the benefit is greater than 0, Op0 should come second to
2921   // expose more CSE opportunities.
2922   int GlobalSwapBenefits = 0;
2923   for (const User *U : Op0->users()) {
2924     const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
2925     if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
2926       continue;
2927     // If Op0 is the first argument, this is not beneficial to swap the
2928     // arguments.
2929     int LocalSwapBenefits = -1;
2930     unsigned Op1Idx = 1;
2931     if (BinOp->getOperand(Op1Idx) == Op0) {
2932       Op1Idx = 0;
2933       LocalSwapBenefits = 1;
2934     }
2935     if (BinOp->getOperand(Op1Idx) != Op1)
2936       continue;
2937     GlobalSwapBenefits += LocalSwapBenefits;
2938   }
2939   return GlobalSwapBenefits > 0;
2940 }
2941 
2942 /// \brief Check that one use is in the same block as the definition and all
2943 /// other uses are in blocks dominated by a given block
2944 ///
2945 /// \param DI Definition
2946 /// \param UI Use
2947 /// \param DB Block that must dominate all uses of \p DI outside
2948 ///           the parent block
2949 /// \return true when \p UI is the only use of \p DI in the parent block
2950 /// and all other uses of \p DI are in blocks dominated by \p DB.
2951 ///
2952 bool InstCombiner::dominatesAllUses(const Instruction *DI,
2953                                     const Instruction *UI,
2954                                     const BasicBlock *DB) const {
2955   assert(DI && UI && "Instruction not defined\n");
2956   // ignore incomplete definitions
2957   if (!DI->getParent())
2958     return false;
2959   // DI and UI must be in the same block
2960   if (DI->getParent() != UI->getParent())
2961     return false;
2962   // Protect from self-referencing blocks
2963   if (DI->getParent() == DB)
2964     return false;
2965   // DominatorTree available?
2966   if (!DT)
2967     return false;
2968   for (const User *U : DI->users()) {
2969     auto *Usr = cast<Instruction>(U);
2970     if (Usr != UI && !DT->dominates(DB, Usr->getParent()))
2971       return false;
2972   }
2973   return true;
2974 }
2975 
2976 ///
2977 /// true when the instruction sequence within a block is select-cmp-br.
2978 ///
2979 static bool isChainSelectCmpBranch(const SelectInst *SI) {
2980   const BasicBlock *BB = SI->getParent();
2981   if (!BB)
2982     return false;
2983   auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
2984   if (!BI || BI->getNumSuccessors() != 2)
2985     return false;
2986   auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
2987   if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
2988     return false;
2989   return true;
2990 }
2991 
2992 ///
2993 /// \brief True when a select result is replaced by one of its operands
2994 /// in select-icmp sequence. This will eventually result in the elimination
2995 /// of the select.
2996 ///
2997 /// \param SI    Select instruction
2998 /// \param Icmp  Compare instruction
2999 /// \param SIOpd Operand that replaces the select
3000 ///
3001 /// Notes:
3002 /// - The replacement is global and requires dominator information
3003 /// - The caller is responsible for the actual replacement
3004 ///
3005 /// Example:
3006 ///
3007 /// entry:
3008 ///  %4 = select i1 %3, %C* %0, %C* null
3009 ///  %5 = icmp eq %C* %4, null
3010 ///  br i1 %5, label %9, label %7
3011 ///  ...
3012 ///  ; <label>:7                                       ; preds = %entry
3013 ///  %8 = getelementptr inbounds %C* %4, i64 0, i32 0
3014 ///  ...
3015 ///
3016 /// can be transformed to
3017 ///
3018 ///  %5 = icmp eq %C* %0, null
3019 ///  %6 = select i1 %3, i1 %5, i1 true
3020 ///  br i1 %6, label %9, label %7
3021 ///  ...
3022 ///  ; <label>:7                                       ; preds = %entry
3023 ///  %8 = getelementptr inbounds %C* %0, i64 0, i32 0  // replace by %0!
3024 ///
3025 /// Similar when the first operand of the select is a constant or/and
3026 /// the compare is for not equal rather than equal.
3027 ///
3028 /// NOTE: The function is only called when the select and compare constants
3029 /// are equal, the optimization can work only for EQ predicates. This is not a
3030 /// major restriction since a NE compare should be 'normalized' to an equal
3031 /// compare, which usually happens in the combiner and test case
3032 /// select-cmp-br.ll
3033 /// checks for it.
3034 bool InstCombiner::replacedSelectWithOperand(SelectInst *SI,
3035                                              const ICmpInst *Icmp,
3036                                              const unsigned SIOpd) {
3037   assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
3038   if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
3039     BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
3040     // The check for the unique predecessor is not the best that can be
3041     // done. But it protects efficiently against cases like  when SI's
3042     // home block has two successors, Succ and Succ1, and Succ1 predecessor
3043     // of Succ. Then SI can't be replaced by SIOpd because the use that gets
3044     // replaced can be reached on either path. So the uniqueness check
3045     // guarantees that the path all uses of SI (outside SI's parent) are on
3046     // is disjoint from all other paths out of SI. But that information
3047     // is more expensive to compute, and the trade-off here is in favor
3048     // of compile-time.
3049     if (Succ->getUniquePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
3050       NumSel++;
3051       SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
3052       return true;
3053     }
3054   }
3055   return false;
3056 }
3057 
3058 Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
3059   bool Changed = false;
3060   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3061   unsigned Op0Cplxity = getComplexity(Op0);
3062   unsigned Op1Cplxity = getComplexity(Op1);
3063 
3064   /// Orders the operands of the compare so that they are listed from most
3065   /// complex to least complex.  This puts constants before unary operators,
3066   /// before binary operators.
3067   if (Op0Cplxity < Op1Cplxity ||
3068         (Op0Cplxity == Op1Cplxity &&
3069          swapMayExposeCSEOpportunities(Op0, Op1))) {
3070     I.swapOperands();
3071     std::swap(Op0, Op1);
3072     Changed = true;
3073   }
3074 
3075   if (Value *V =
3076           SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AC, &I))
3077     return ReplaceInstUsesWith(I, V);
3078 
3079   // comparing -val or val with non-zero is the same as just comparing val
3080   // ie, abs(val) != 0 -> val != 0
3081   if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
3082   {
3083     Value *Cond, *SelectTrue, *SelectFalse;
3084     if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
3085                             m_Value(SelectFalse)))) {
3086       if (Value *V = dyn_castNegVal(SelectTrue)) {
3087         if (V == SelectFalse)
3088           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
3089       }
3090       else if (Value *V = dyn_castNegVal(SelectFalse)) {
3091         if (V == SelectTrue)
3092           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
3093       }
3094     }
3095   }
3096 
3097   Type *Ty = Op0->getType();
3098 
3099   // icmp's with boolean values can always be turned into bitwise operations
3100   if (Ty->isIntegerTy(1)) {
3101     switch (I.getPredicate()) {
3102     default: llvm_unreachable("Invalid icmp instruction!");
3103     case ICmpInst::ICMP_EQ: {               // icmp eq i1 A, B -> ~(A^B)
3104       Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
3105       return BinaryOperator::CreateNot(Xor);
3106     }
3107     case ICmpInst::ICMP_NE:                  // icmp eq i1 A, B -> A^B
3108       return BinaryOperator::CreateXor(Op0, Op1);
3109 
3110     case ICmpInst::ICMP_UGT:
3111       std::swap(Op0, Op1);                   // Change icmp ugt -> icmp ult
3112       // FALL THROUGH
3113     case ICmpInst::ICMP_ULT:{               // icmp ult i1 A, B -> ~A & B
3114       Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
3115       return BinaryOperator::CreateAnd(Not, Op1);
3116     }
3117     case ICmpInst::ICMP_SGT:
3118       std::swap(Op0, Op1);                   // Change icmp sgt -> icmp slt
3119       // FALL THROUGH
3120     case ICmpInst::ICMP_SLT: {               // icmp slt i1 A, B -> A & ~B
3121       Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
3122       return BinaryOperator::CreateAnd(Not, Op0);
3123     }
3124     case ICmpInst::ICMP_UGE:
3125       std::swap(Op0, Op1);                   // Change icmp uge -> icmp ule
3126       // FALL THROUGH
3127     case ICmpInst::ICMP_ULE: {               //  icmp ule i1 A, B -> ~A | B
3128       Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
3129       return BinaryOperator::CreateOr(Not, Op1);
3130     }
3131     case ICmpInst::ICMP_SGE:
3132       std::swap(Op0, Op1);                   // Change icmp sge -> icmp sle
3133       // FALL THROUGH
3134     case ICmpInst::ICMP_SLE: {               //  icmp sle i1 A, B -> A | ~B
3135       Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
3136       return BinaryOperator::CreateOr(Not, Op0);
3137     }
3138     }
3139   }
3140 
3141   unsigned BitWidth = 0;
3142   if (Ty->isIntOrIntVectorTy())
3143     BitWidth = Ty->getScalarSizeInBits();
3144   else // Get pointer size.
3145     BitWidth = DL.getTypeSizeInBits(Ty->getScalarType());
3146 
3147   bool isSignBit = false;
3148 
3149   // See if we are doing a comparison with a constant.
3150   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3151     Value *A = nullptr, *B = nullptr;
3152 
3153     // Match the following pattern, which is a common idiom when writing
3154     // overflow-safe integer arithmetic function.  The source performs an
3155     // addition in wider type, and explicitly checks for overflow using
3156     // comparisons against INT_MIN and INT_MAX.  Simplify this by using the
3157     // sadd_with_overflow intrinsic.
3158     //
3159     // TODO: This could probably be generalized to handle other overflow-safe
3160     // operations if we worked out the formulas to compute the appropriate
3161     // magic constants.
3162     //
3163     // sum = a + b
3164     // if (sum+128 >u 255)  ...  -> llvm.sadd.with.overflow.i8
3165     {
3166     ConstantInt *CI2;    // I = icmp ugt (add (add A, B), CI2), CI
3167     if (I.getPredicate() == ICmpInst::ICMP_UGT &&
3168         match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
3169       if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
3170         return Res;
3171     }
3172 
3173     // The following transforms are only 'worth it' if the only user of the
3174     // subtraction is the icmp.
3175     if (Op0->hasOneUse()) {
3176       // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
3177       if (I.isEquality() && CI->isZero() &&
3178           match(Op0, m_Sub(m_Value(A), m_Value(B))))
3179         return new ICmpInst(I.getPredicate(), A, B);
3180 
3181       // (icmp sgt (sub nsw A B), -1) -> (icmp sge A, B)
3182       if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isAllOnesValue() &&
3183           match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3184         return new ICmpInst(ICmpInst::ICMP_SGE, A, B);
3185 
3186       // (icmp sgt (sub nsw A B), 0) -> (icmp sgt A, B)
3187       if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isZero() &&
3188           match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3189         return new ICmpInst(ICmpInst::ICMP_SGT, A, B);
3190 
3191       // (icmp slt (sub nsw A B), 0) -> (icmp slt A, B)
3192       if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isZero() &&
3193           match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3194         return new ICmpInst(ICmpInst::ICMP_SLT, A, B);
3195 
3196       // (icmp slt (sub nsw A B), 1) -> (icmp sle A, B)
3197       if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isOne() &&
3198           match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3199         return new ICmpInst(ICmpInst::ICMP_SLE, A, B);
3200     }
3201 
3202     // If we have an icmp le or icmp ge instruction, turn it into the
3203     // appropriate icmp lt or icmp gt instruction.  This allows us to rely on
3204     // them being folded in the code below.  The SimplifyICmpInst code has
3205     // already handled the edge cases for us, so we just assert on them.
3206     switch (I.getPredicate()) {
3207     default: break;
3208     case ICmpInst::ICMP_ULE:
3209       assert(!CI->isMaxValue(false));                 // A <=u MAX -> TRUE
3210       return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
3211                           Builder->getInt(CI->getValue()+1));
3212     case ICmpInst::ICMP_SLE:
3213       assert(!CI->isMaxValue(true));                  // A <=s MAX -> TRUE
3214       return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
3215                           Builder->getInt(CI->getValue()+1));
3216     case ICmpInst::ICMP_UGE:
3217       assert(!CI->isMinValue(false));                 // A >=u MIN -> TRUE
3218       return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
3219                           Builder->getInt(CI->getValue()-1));
3220     case ICmpInst::ICMP_SGE:
3221       assert(!CI->isMinValue(true));                  // A >=s MIN -> TRUE
3222       return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
3223                           Builder->getInt(CI->getValue()-1));
3224     }
3225 
3226     if (I.isEquality()) {
3227       ConstantInt *CI2;
3228       if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
3229           match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
3230         // (icmp eq/ne (ashr/lshr const2, A), const1)
3231         if (Instruction *Inst = FoldICmpCstShrCst(I, Op0, A, CI, CI2))
3232           return Inst;
3233       }
3234       if (match(Op0, m_Shl(m_ConstantInt(CI2), m_Value(A)))) {
3235         // (icmp eq/ne (shl const2, A), const1)
3236         if (Instruction *Inst = FoldICmpCstShlCst(I, Op0, A, CI, CI2))
3237           return Inst;
3238       }
3239     }
3240 
3241     // If this comparison is a normal comparison, it demands all
3242     // bits, if it is a sign bit comparison, it only demands the sign bit.
3243     bool UnusedBit;
3244     isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
3245   }
3246 
3247   // See if we can fold the comparison based on range information we can get
3248   // by checking whether bits are known to be zero or one in the input.
3249   if (BitWidth != 0) {
3250     APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
3251     APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
3252 
3253     if (SimplifyDemandedBits(I.getOperandUse(0),
3254                              DemandedBitsLHSMask(I, BitWidth, isSignBit),
3255                              Op0KnownZero, Op0KnownOne, 0))
3256       return &I;
3257     if (SimplifyDemandedBits(I.getOperandUse(1),
3258                              APInt::getAllOnesValue(BitWidth), Op1KnownZero,
3259                              Op1KnownOne, 0))
3260       return &I;
3261 
3262     // Given the known and unknown bits, compute a range that the LHS could be
3263     // in.  Compute the Min, Max and RHS values based on the known bits. For the
3264     // EQ and NE we use unsigned values.
3265     APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
3266     APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
3267     if (I.isSigned()) {
3268       ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
3269                                              Op0Min, Op0Max);
3270       ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
3271                                              Op1Min, Op1Max);
3272     } else {
3273       ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
3274                                                Op0Min, Op0Max);
3275       ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
3276                                                Op1Min, Op1Max);
3277     }
3278 
3279     // If Min and Max are known to be the same, then SimplifyDemandedBits
3280     // figured out that the LHS is a constant.  Just constant fold this now so
3281     // that code below can assume that Min != Max.
3282     if (!isa<Constant>(Op0) && Op0Min == Op0Max)
3283       return new ICmpInst(I.getPredicate(),
3284                           ConstantInt::get(Op0->getType(), Op0Min), Op1);
3285     if (!isa<Constant>(Op1) && Op1Min == Op1Max)
3286       return new ICmpInst(I.getPredicate(), Op0,
3287                           ConstantInt::get(Op1->getType(), Op1Min));
3288 
3289     // Based on the range information we know about the LHS, see if we can
3290     // simplify this comparison.  For example, (x&4) < 8 is always true.
3291     switch (I.getPredicate()) {
3292     default: llvm_unreachable("Unknown icmp opcode!");
3293     case ICmpInst::ICMP_EQ: {
3294       if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
3295         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3296 
3297       // If all bits are known zero except for one, then we know at most one
3298       // bit is set.   If the comparison is against zero, then this is a check
3299       // to see if *that* bit is set.
3300       APInt Op0KnownZeroInverted = ~Op0KnownZero;
3301       if (~Op1KnownZero == 0) {
3302         // If the LHS is an AND with the same constant, look through it.
3303         Value *LHS = nullptr;
3304         ConstantInt *LHSC = nullptr;
3305         if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
3306             LHSC->getValue() != Op0KnownZeroInverted)
3307           LHS = Op0;
3308 
3309         // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
3310         // then turn "((1 << x)&8) == 0" into "x != 3".
3311         // or turn "((1 << x)&7) == 0" into "x > 2".
3312         Value *X = nullptr;
3313         if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
3314           APInt ValToCheck = Op0KnownZeroInverted;
3315           if (ValToCheck.isPowerOf2()) {
3316             unsigned CmpVal = ValToCheck.countTrailingZeros();
3317             return new ICmpInst(ICmpInst::ICMP_NE, X,
3318                                 ConstantInt::get(X->getType(), CmpVal));
3319           } else if ((++ValToCheck).isPowerOf2()) {
3320             unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
3321             return new ICmpInst(ICmpInst::ICMP_UGT, X,
3322                                 ConstantInt::get(X->getType(), CmpVal));
3323           }
3324         }
3325 
3326         // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
3327         // then turn "((8 >>u x)&1) == 0" into "x != 3".
3328         const APInt *CI;
3329         if (Op0KnownZeroInverted == 1 &&
3330             match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
3331           return new ICmpInst(ICmpInst::ICMP_NE, X,
3332                               ConstantInt::get(X->getType(),
3333                                                CI->countTrailingZeros()));
3334       }
3335       break;
3336     }
3337     case ICmpInst::ICMP_NE: {
3338       if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
3339         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3340 
3341       // If all bits are known zero except for one, then we know at most one
3342       // bit is set.   If the comparison is against zero, then this is a check
3343       // to see if *that* bit is set.
3344       APInt Op0KnownZeroInverted = ~Op0KnownZero;
3345       if (~Op1KnownZero == 0) {
3346         // If the LHS is an AND with the same constant, look through it.
3347         Value *LHS = nullptr;
3348         ConstantInt *LHSC = nullptr;
3349         if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
3350             LHSC->getValue() != Op0KnownZeroInverted)
3351           LHS = Op0;
3352 
3353         // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
3354         // then turn "((1 << x)&8) != 0" into "x == 3".
3355         // or turn "((1 << x)&7) != 0" into "x < 3".
3356         Value *X = nullptr;
3357         if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
3358           APInt ValToCheck = Op0KnownZeroInverted;
3359           if (ValToCheck.isPowerOf2()) {
3360             unsigned CmpVal = ValToCheck.countTrailingZeros();
3361             return new ICmpInst(ICmpInst::ICMP_EQ, X,
3362                                 ConstantInt::get(X->getType(), CmpVal));
3363           } else if ((++ValToCheck).isPowerOf2()) {
3364             unsigned CmpVal = ValToCheck.countTrailingZeros();
3365             return new ICmpInst(ICmpInst::ICMP_ULT, X,
3366                                 ConstantInt::get(X->getType(), CmpVal));
3367           }
3368         }
3369 
3370         // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
3371         // then turn "((8 >>u x)&1) != 0" into "x == 3".
3372         const APInt *CI;
3373         if (Op0KnownZeroInverted == 1 &&
3374             match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
3375           return new ICmpInst(ICmpInst::ICMP_EQ, X,
3376                               ConstantInt::get(X->getType(),
3377                                                CI->countTrailingZeros()));
3378       }
3379       break;
3380     }
3381     case ICmpInst::ICMP_ULT:
3382       if (Op0Max.ult(Op1Min))          // A <u B -> true if max(A) < min(B)
3383         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3384       if (Op0Min.uge(Op1Max))          // A <u B -> false if min(A) >= max(B)
3385         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3386       if (Op1Min == Op0Max)            // A <u B -> A != B if max(A) == min(B)
3387         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3388       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3389         if (Op1Max == Op0Min+1)        // A <u C -> A == C-1 if min(A)+1 == C
3390           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
3391                               Builder->getInt(CI->getValue()-1));
3392 
3393         // (x <u 2147483648) -> (x >s -1)  -> true if sign bit clear
3394         if (CI->isMinValue(true))
3395           return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
3396                            Constant::getAllOnesValue(Op0->getType()));
3397       }
3398       break;
3399     case ICmpInst::ICMP_UGT:
3400       if (Op0Min.ugt(Op1Max))          // A >u B -> true if min(A) > max(B)
3401         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3402       if (Op0Max.ule(Op1Min))          // A >u B -> false if max(A) <= max(B)
3403         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3404 
3405       if (Op1Max == Op0Min)            // A >u B -> A != B if min(A) == max(B)
3406         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3407       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3408         if (Op1Min == Op0Max-1)        // A >u C -> A == C+1 if max(a)-1 == C
3409           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
3410                               Builder->getInt(CI->getValue()+1));
3411 
3412         // (x >u 2147483647) -> (x <s 0)  -> true if sign bit set
3413         if (CI->isMaxValue(true))
3414           return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
3415                               Constant::getNullValue(Op0->getType()));
3416       }
3417       break;
3418     case ICmpInst::ICMP_SLT:
3419       if (Op0Max.slt(Op1Min))          // A <s B -> true if max(A) < min(C)
3420         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3421       if (Op0Min.sge(Op1Max))          // A <s B -> false if min(A) >= max(C)
3422         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3423       if (Op1Min == Op0Max)            // A <s B -> A != B if max(A) == min(B)
3424         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3425       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3426         if (Op1Max == Op0Min+1)        // A <s C -> A == C-1 if min(A)+1 == C
3427           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
3428                               Builder->getInt(CI->getValue()-1));
3429       }
3430       break;
3431     case ICmpInst::ICMP_SGT:
3432       if (Op0Min.sgt(Op1Max))          // A >s B -> true if min(A) > max(B)
3433         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3434       if (Op0Max.sle(Op1Min))          // A >s B -> false if max(A) <= min(B)
3435         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3436 
3437       if (Op1Max == Op0Min)            // A >s B -> A != B if min(A) == max(B)
3438         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3439       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3440         if (Op1Min == Op0Max-1)        // A >s C -> A == C+1 if max(A)-1 == C
3441           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
3442                               Builder->getInt(CI->getValue()+1));
3443       }
3444       break;
3445     case ICmpInst::ICMP_SGE:
3446       assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
3447       if (Op0Min.sge(Op1Max))          // A >=s B -> true if min(A) >= max(B)
3448         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3449       if (Op0Max.slt(Op1Min))          // A >=s B -> false if max(A) < min(B)
3450         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3451       break;
3452     case ICmpInst::ICMP_SLE:
3453       assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
3454       if (Op0Max.sle(Op1Min))          // A <=s B -> true if max(A) <= min(B)
3455         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3456       if (Op0Min.sgt(Op1Max))          // A <=s B -> false if min(A) > max(B)
3457         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3458       break;
3459     case ICmpInst::ICMP_UGE:
3460       assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
3461       if (Op0Min.uge(Op1Max))          // A >=u B -> true if min(A) >= max(B)
3462         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3463       if (Op0Max.ult(Op1Min))          // A >=u B -> false if max(A) < min(B)
3464         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3465       break;
3466     case ICmpInst::ICMP_ULE:
3467       assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
3468       if (Op0Max.ule(Op1Min))          // A <=u B -> true if max(A) <= min(B)
3469         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3470       if (Op0Min.ugt(Op1Max))          // A <=u B -> false if min(A) > max(B)
3471         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3472       break;
3473     }
3474 
3475     // Turn a signed comparison into an unsigned one if both operands
3476     // are known to have the same sign.
3477     if (I.isSigned() &&
3478         ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
3479          (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
3480       return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
3481   }
3482 
3483   // Test if the ICmpInst instruction is used exclusively by a select as
3484   // part of a minimum or maximum operation. If so, refrain from doing
3485   // any other folding. This helps out other analyses which understand
3486   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
3487   // and CodeGen. And in this case, at least one of the comparison
3488   // operands has at least one user besides the compare (the select),
3489   // which would often largely negate the benefit of folding anyway.
3490   if (I.hasOneUse())
3491     if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
3492       if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
3493           (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
3494         return nullptr;
3495 
3496   // See if we are doing a comparison between a constant and an instruction that
3497   // can be folded into the comparison.
3498   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3499     // Since the RHS is a ConstantInt (CI), if the left hand side is an
3500     // instruction, see if that instruction also has constants so that the
3501     // instruction can be folded into the icmp
3502     if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3503       if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
3504         return Res;
3505   }
3506 
3507   // Handle icmp with constant (but not simple integer constant) RHS
3508   if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3509     if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3510       switch (LHSI->getOpcode()) {
3511       case Instruction::GetElementPtr:
3512           // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
3513         if (RHSC->isNullValue() &&
3514             cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
3515           return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3516                   Constant::getNullValue(LHSI->getOperand(0)->getType()));
3517         break;
3518       case Instruction::PHI:
3519         // Only fold icmp into the PHI if the phi and icmp are in the same
3520         // block.  If in the same block, we're encouraging jump threading.  If
3521         // not, we are just pessimizing the code by making an i1 phi.
3522         if (LHSI->getParent() == I.getParent())
3523           if (Instruction *NV = FoldOpIntoPhi(I))
3524             return NV;
3525         break;
3526       case Instruction::Select: {
3527         // If either operand of the select is a constant, we can fold the
3528         // comparison into the select arms, which will cause one to be
3529         // constant folded and the select turned into a bitwise or.
3530         Value *Op1 = nullptr, *Op2 = nullptr;
3531         ConstantInt *CI = nullptr;
3532         if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
3533           Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
3534           CI = dyn_cast<ConstantInt>(Op1);
3535         }
3536         if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
3537           Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
3538           CI = dyn_cast<ConstantInt>(Op2);
3539         }
3540 
3541         // We only want to perform this transformation if it will not lead to
3542         // additional code. This is true if either both sides of the select
3543         // fold to a constant (in which case the icmp is replaced with a select
3544         // which will usually simplify) or this is the only user of the
3545         // select (in which case we are trading a select+icmp for a simpler
3546         // select+icmp) or all uses of the select can be replaced based on
3547         // dominance information ("Global cases").
3548         bool Transform = false;
3549         if (Op1 && Op2)
3550           Transform = true;
3551         else if (Op1 || Op2) {
3552           // Local case
3553           if (LHSI->hasOneUse())
3554             Transform = true;
3555           // Global cases
3556           else if (CI && !CI->isZero())
3557             // When Op1 is constant try replacing select with second operand.
3558             // Otherwise Op2 is constant and try replacing select with first
3559             // operand.
3560             Transform = replacedSelectWithOperand(cast<SelectInst>(LHSI), &I,
3561                                                   Op1 ? 2 : 1);
3562         }
3563         if (Transform) {
3564           if (!Op1)
3565             Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
3566                                       RHSC, I.getName());
3567           if (!Op2)
3568             Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
3569                                       RHSC, I.getName());
3570           return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3571         }
3572         break;
3573       }
3574       case Instruction::IntToPtr:
3575         // icmp pred inttoptr(X), null -> icmp pred X, 0
3576         if (RHSC->isNullValue() &&
3577             DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
3578           return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3579                         Constant::getNullValue(LHSI->getOperand(0)->getType()));
3580         break;
3581 
3582       case Instruction::Load:
3583         // Try to optimize things like "A[i] > 4" to index computations.
3584         if (GetElementPtrInst *GEP =
3585               dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3586           if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3587             if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3588                 !cast<LoadInst>(LHSI)->isVolatile())
3589               if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3590                 return Res;
3591         }
3592         break;
3593       }
3594   }
3595 
3596   // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
3597   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
3598     if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
3599       return NI;
3600   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
3601     if (Instruction *NI = FoldGEPICmp(GEP, Op0,
3602                            ICmpInst::getSwappedPredicate(I.getPredicate()), I))
3603       return NI;
3604 
3605   // Try to optimize equality comparisons against alloca-based pointers.
3606   if (Op0->getType()->isPointerTy() && I.isEquality()) {
3607     assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?");
3608     if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op0, DL)))
3609       if (Instruction *New = FoldAllocaCmp(I, Alloca, Op1))
3610         return New;
3611     if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op1, DL)))
3612       if (Instruction *New = FoldAllocaCmp(I, Alloca, Op0))
3613         return New;
3614   }
3615 
3616   // Test to see if the operands of the icmp are casted versions of other
3617   // values.  If the ptr->ptr cast can be stripped off both arguments, we do so
3618   // now.
3619   if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
3620     if (Op0->getType()->isPointerTy() &&
3621         (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
3622       // We keep moving the cast from the left operand over to the right
3623       // operand, where it can often be eliminated completely.
3624       Op0 = CI->getOperand(0);
3625 
3626       // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
3627       // so eliminate it as well.
3628       if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
3629         Op1 = CI2->getOperand(0);
3630 
3631       // If Op1 is a constant, we can fold the cast into the constant.
3632       if (Op0->getType() != Op1->getType()) {
3633         if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
3634           Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
3635         } else {
3636           // Otherwise, cast the RHS right before the icmp
3637           Op1 = Builder->CreateBitCast(Op1, Op0->getType());
3638         }
3639       }
3640       return new ICmpInst(I.getPredicate(), Op0, Op1);
3641     }
3642   }
3643 
3644   if (isa<CastInst>(Op0)) {
3645     // Handle the special case of: icmp (cast bool to X), <cst>
3646     // This comes up when you have code like
3647     //   int X = A < B;
3648     //   if (X) ...
3649     // For generality, we handle any zero-extension of any operand comparison
3650     // with a constant or another cast from the same type.
3651     if (isa<Constant>(Op1) || isa<CastInst>(Op1))
3652       if (Instruction *R = visitICmpInstWithCastAndCast(I))
3653         return R;
3654   }
3655 
3656   // Special logic for binary operators.
3657   BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3658   BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3659   if (BO0 || BO1) {
3660     CmpInst::Predicate Pred = I.getPredicate();
3661     bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3662     if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3663       NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
3664         (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3665         (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3666     if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3667       NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3668         (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3669         (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3670 
3671     // Analyze the case when either Op0 or Op1 is an add instruction.
3672     // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
3673     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
3674     if (BO0 && BO0->getOpcode() == Instruction::Add)
3675       A = BO0->getOperand(0), B = BO0->getOperand(1);
3676     if (BO1 && BO1->getOpcode() == Instruction::Add)
3677       C = BO1->getOperand(0), D = BO1->getOperand(1);
3678 
3679     // icmp (X+cst) < 0 --> X < -cst
3680     if (NoOp0WrapProblem && ICmpInst::isSigned(Pred) && match(Op1, m_Zero()))
3681       if (ConstantInt *RHSC = dyn_cast_or_null<ConstantInt>(B))
3682         if (!RHSC->isMinValue(/*isSigned=*/true))
3683           return new ICmpInst(Pred, A, ConstantExpr::getNeg(RHSC));
3684 
3685     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3686     if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3687       return new ICmpInst(Pred, A == Op1 ? B : A,
3688                           Constant::getNullValue(Op1->getType()));
3689 
3690     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3691     if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3692       return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3693                           C == Op0 ? D : C);
3694 
3695     // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
3696     if (A && C && (A == C || A == D || B == C || B == D) &&
3697         NoOp0WrapProblem && NoOp1WrapProblem &&
3698         // Try not to increase register pressure.
3699         BO0->hasOneUse() && BO1->hasOneUse()) {
3700       // Determine Y and Z in the form icmp (X+Y), (X+Z).
3701       Value *Y, *Z;
3702       if (A == C) {
3703         // C + B == C + D  ->  B == D
3704         Y = B;
3705         Z = D;
3706       } else if (A == D) {
3707         // D + B == C + D  ->  B == C
3708         Y = B;
3709         Z = C;
3710       } else if (B == C) {
3711         // A + C == C + D  ->  A == D
3712         Y = A;
3713         Z = D;
3714       } else {
3715         assert(B == D);
3716         // A + D == C + D  ->  A == C
3717         Y = A;
3718         Z = C;
3719       }
3720       return new ICmpInst(Pred, Y, Z);
3721     }
3722 
3723     // icmp slt (X + -1), Y -> icmp sle X, Y
3724     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3725         match(B, m_AllOnes()))
3726       return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3727 
3728     // icmp sge (X + -1), Y -> icmp sgt X, Y
3729     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3730         match(B, m_AllOnes()))
3731       return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3732 
3733     // icmp sle (X + 1), Y -> icmp slt X, Y
3734     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3735         match(B, m_One()))
3736       return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3737 
3738     // icmp sgt (X + 1), Y -> icmp sge X, Y
3739     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3740         match(B, m_One()))
3741       return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3742 
3743     // icmp sgt X, (Y + -1) -> icmp sge X, Y
3744     if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT &&
3745         match(D, m_AllOnes()))
3746       return new ICmpInst(CmpInst::ICMP_SGE, Op0, C);
3747 
3748     // icmp sle X, (Y + -1) -> icmp slt X, Y
3749     if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE &&
3750         match(D, m_AllOnes()))
3751       return new ICmpInst(CmpInst::ICMP_SLT, Op0, C);
3752 
3753     // icmp sge X, (Y + 1) -> icmp sgt X, Y
3754     if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE &&
3755         match(D, m_One()))
3756       return new ICmpInst(CmpInst::ICMP_SGT, Op0, C);
3757 
3758     // icmp slt X, (Y + 1) -> icmp sle X, Y
3759     if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT &&
3760         match(D, m_One()))
3761       return new ICmpInst(CmpInst::ICMP_SLE, Op0, C);
3762 
3763     // if C1 has greater magnitude than C2:
3764     //  icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3765     //  s.t. C3 = C1 - C2
3766     //
3767     // if C2 has greater magnitude than C1:
3768     //  icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3769     //  s.t. C3 = C2 - C1
3770     if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3771         (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3772       if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3773         if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3774           const APInt &AP1 = C1->getValue();
3775           const APInt &AP2 = C2->getValue();
3776           if (AP1.isNegative() == AP2.isNegative()) {
3777             APInt AP1Abs = C1->getValue().abs();
3778             APInt AP2Abs = C2->getValue().abs();
3779             if (AP1Abs.uge(AP2Abs)) {
3780               ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3781               Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3782               return new ICmpInst(Pred, NewAdd, C);
3783             } else {
3784               ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3785               Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3786               return new ICmpInst(Pred, A, NewAdd);
3787             }
3788           }
3789         }
3790 
3791 
3792     // Analyze the case when either Op0 or Op1 is a sub instruction.
3793     // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
3794     A = nullptr; B = nullptr; C = nullptr; D = nullptr;
3795     if (BO0 && BO0->getOpcode() == Instruction::Sub)
3796       A = BO0->getOperand(0), B = BO0->getOperand(1);
3797     if (BO1 && BO1->getOpcode() == Instruction::Sub)
3798       C = BO1->getOperand(0), D = BO1->getOperand(1);
3799 
3800     // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3801     if (A == Op1 && NoOp0WrapProblem)
3802       return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
3803 
3804     // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3805     if (C == Op0 && NoOp1WrapProblem)
3806       return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3807 
3808     // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
3809     if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3810         // Try not to increase register pressure.
3811         BO0->hasOneUse() && BO1->hasOneUse())
3812       return new ICmpInst(Pred, A, C);
3813 
3814     // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3815     if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3816         // Try not to increase register pressure.
3817         BO0->hasOneUse() && BO1->hasOneUse())
3818       return new ICmpInst(Pred, D, B);
3819 
3820     // icmp (0-X) < cst --> x > -cst
3821     if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3822       Value *X;
3823       if (match(BO0, m_Neg(m_Value(X))))
3824         if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3825           if (!RHSC->isMinValue(/*isSigned=*/true))
3826             return new ICmpInst(I.getSwappedPredicate(), X,
3827                                 ConstantExpr::getNeg(RHSC));
3828     }
3829 
3830     BinaryOperator *SRem = nullptr;
3831     // icmp (srem X, Y), Y
3832     if (BO0 && BO0->getOpcode() == Instruction::SRem &&
3833         Op1 == BO0->getOperand(1))
3834       SRem = BO0;
3835     // icmp Y, (srem X, Y)
3836     else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3837              Op0 == BO1->getOperand(1))
3838       SRem = BO1;
3839     if (SRem) {
3840       // We don't check hasOneUse to avoid increasing register pressure because
3841       // the value we use is the same value this instruction was already using.
3842       switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3843         default: break;
3844         case ICmpInst::ICMP_EQ:
3845           return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3846         case ICmpInst::ICMP_NE:
3847           return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3848         case ICmpInst::ICMP_SGT:
3849         case ICmpInst::ICMP_SGE:
3850           return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3851                               Constant::getAllOnesValue(SRem->getType()));
3852         case ICmpInst::ICMP_SLT:
3853         case ICmpInst::ICMP_SLE:
3854           return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
3855                               Constant::getNullValue(SRem->getType()));
3856       }
3857     }
3858 
3859     if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
3860         BO0->hasOneUse() && BO1->hasOneUse() &&
3861         BO0->getOperand(1) == BO1->getOperand(1)) {
3862       switch (BO0->getOpcode()) {
3863       default: break;
3864       case Instruction::Add:
3865       case Instruction::Sub:
3866       case Instruction::Xor:
3867         if (I.isEquality())    // a+x icmp eq/ne b+x --> a icmp b
3868           return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3869                               BO1->getOperand(0));
3870         // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
3871         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3872           if (CI->getValue().isSignBit()) {
3873             ICmpInst::Predicate Pred = I.isSigned()
3874                                            ? I.getUnsignedPredicate()
3875                                            : I.getSignedPredicate();
3876             return new ICmpInst(Pred, BO0->getOperand(0),
3877                                 BO1->getOperand(0));
3878           }
3879 
3880           if (CI->isMaxValue(true)) {
3881             ICmpInst::Predicate Pred = I.isSigned()
3882                                            ? I.getUnsignedPredicate()
3883                                            : I.getSignedPredicate();
3884             Pred = I.getSwappedPredicate(Pred);
3885             return new ICmpInst(Pred, BO0->getOperand(0),
3886                                 BO1->getOperand(0));
3887           }
3888         }
3889         break;
3890       case Instruction::Mul:
3891         if (!I.isEquality())
3892           break;
3893 
3894         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3895           // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
3896           // Mask = -1 >> count-trailing-zeros(Cst).
3897           if (!CI->isZero() && !CI->isOne()) {
3898             const APInt &AP = CI->getValue();
3899             ConstantInt *Mask = ConstantInt::get(I.getContext(),
3900                                     APInt::getLowBitsSet(AP.getBitWidth(),
3901                                                          AP.getBitWidth() -
3902                                                     AP.countTrailingZeros()));
3903             Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
3904             Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
3905             return new ICmpInst(I.getPredicate(), And1, And2);
3906           }
3907         }
3908         break;
3909       case Instruction::UDiv:
3910       case Instruction::LShr:
3911         if (I.isSigned())
3912           break;
3913         // fall-through
3914       case Instruction::SDiv:
3915       case Instruction::AShr:
3916         if (!BO0->isExact() || !BO1->isExact())
3917           break;
3918         return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3919                             BO1->getOperand(0));
3920       case Instruction::Shl: {
3921         bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
3922         bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
3923         if (!NUW && !NSW)
3924           break;
3925         if (!NSW && I.isSigned())
3926           break;
3927         return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3928                             BO1->getOperand(0));
3929       }
3930       }
3931     }
3932 
3933     if (BO0) {
3934       // Transform  A & (L - 1) `ult` L --> L != 0
3935       auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
3936       auto BitwiseAnd =
3937           m_CombineOr(m_And(m_Value(), LSubOne), m_And(LSubOne, m_Value()));
3938 
3939       if (match(BO0, BitwiseAnd) && I.getPredicate() == ICmpInst::ICMP_ULT) {
3940         auto *Zero = Constant::getNullValue(BO0->getType());
3941         return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
3942       }
3943     }
3944   }
3945 
3946   { Value *A, *B;
3947     // Transform (A & ~B) == 0 --> (A & B) != 0
3948     // and       (A & ~B) != 0 --> (A & B) == 0
3949     // if A is a power of 2.
3950     if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
3951         match(Op1, m_Zero()) &&
3952         isKnownToBeAPowerOfTwo(A, DL, false, 0, AC, &I, DT) && I.isEquality())
3953       return new ICmpInst(I.getInversePredicate(),
3954                           Builder->CreateAnd(A, B),
3955                           Op1);
3956 
3957     // ~x < ~y --> y < x
3958     // ~x < cst --> ~cst < x
3959     if (match(Op0, m_Not(m_Value(A)))) {
3960       if (match(Op1, m_Not(m_Value(B))))
3961         return new ICmpInst(I.getPredicate(), B, A);
3962       if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3963         return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
3964     }
3965 
3966     Instruction *AddI = nullptr;
3967     if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
3968                                      m_Instruction(AddI))) &&
3969         isa<IntegerType>(A->getType())) {
3970       Value *Result;
3971       Constant *Overflow;
3972       if (OptimizeOverflowCheck(OCF_UNSIGNED_ADD, A, B, *AddI, Result,
3973                                 Overflow)) {
3974         ReplaceInstUsesWith(*AddI, Result);
3975         return ReplaceInstUsesWith(I, Overflow);
3976       }
3977     }
3978 
3979     // (zext a) * (zext b)  --> llvm.umul.with.overflow.
3980     if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3981       if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
3982         return R;
3983     }
3984     if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3985       if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
3986         return R;
3987     }
3988   }
3989 
3990   if (I.isEquality()) {
3991     Value *A, *B, *C, *D;
3992 
3993     if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
3994       if (A == Op1 || B == Op1) {    // (A^B) == A  ->  B == 0
3995         Value *OtherVal = A == Op1 ? B : A;
3996         return new ICmpInst(I.getPredicate(), OtherVal,
3997                             Constant::getNullValue(A->getType()));
3998       }
3999 
4000       if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
4001         // A^c1 == C^c2 --> A == C^(c1^c2)
4002         ConstantInt *C1, *C2;
4003         if (match(B, m_ConstantInt(C1)) &&
4004             match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
4005           Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
4006           Value *Xor = Builder->CreateXor(C, NC);
4007           return new ICmpInst(I.getPredicate(), A, Xor);
4008         }
4009 
4010         // A^B == A^D -> B == D
4011         if (A == C) return new ICmpInst(I.getPredicate(), B, D);
4012         if (A == D) return new ICmpInst(I.getPredicate(), B, C);
4013         if (B == C) return new ICmpInst(I.getPredicate(), A, D);
4014         if (B == D) return new ICmpInst(I.getPredicate(), A, C);
4015       }
4016     }
4017 
4018     if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
4019         (A == Op0 || B == Op0)) {
4020       // A == (A^B)  ->  B == 0
4021       Value *OtherVal = A == Op0 ? B : A;
4022       return new ICmpInst(I.getPredicate(), OtherVal,
4023                           Constant::getNullValue(A->getType()));
4024     }
4025 
4026     // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
4027     if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
4028         match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
4029       Value *X = nullptr, *Y = nullptr, *Z = nullptr;
4030 
4031       if (A == C) {
4032         X = B; Y = D; Z = A;
4033       } else if (A == D) {
4034         X = B; Y = C; Z = A;
4035       } else if (B == C) {
4036         X = A; Y = D; Z = B;
4037       } else if (B == D) {
4038         X = A; Y = C; Z = B;
4039       }
4040 
4041       if (X) {   // Build (X^Y) & Z
4042         Op1 = Builder->CreateXor(X, Y);
4043         Op1 = Builder->CreateAnd(Op1, Z);
4044         I.setOperand(0, Op1);
4045         I.setOperand(1, Constant::getNullValue(Op1->getType()));
4046         return &I;
4047       }
4048     }
4049 
4050     // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
4051     // and       (B & (1<<X)-1) == (zext A) --> A == (trunc B)
4052     ConstantInt *Cst1;
4053     if ((Op0->hasOneUse() &&
4054          match(Op0, m_ZExt(m_Value(A))) &&
4055          match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
4056         (Op1->hasOneUse() &&
4057          match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
4058          match(Op1, m_ZExt(m_Value(A))))) {
4059       APInt Pow2 = Cst1->getValue() + 1;
4060       if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
4061           Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
4062         return new ICmpInst(I.getPredicate(), A,
4063                             Builder->CreateTrunc(B, A->getType()));
4064     }
4065 
4066     // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
4067     // For lshr and ashr pairs.
4068     if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4069          match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
4070         (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4071          match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
4072       unsigned TypeBits = Cst1->getBitWidth();
4073       unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4074       if (ShAmt < TypeBits && ShAmt != 0) {
4075         ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
4076                                        ? ICmpInst::ICMP_UGE
4077                                        : ICmpInst::ICMP_ULT;
4078         Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
4079         APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
4080         return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
4081       }
4082     }
4083 
4084     // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
4085     if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
4086         match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
4087       unsigned TypeBits = Cst1->getBitWidth();
4088       unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4089       if (ShAmt < TypeBits && ShAmt != 0) {
4090         Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
4091         APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
4092         Value *And = Builder->CreateAnd(Xor, Builder->getInt(AndVal),
4093                                         I.getName() + ".mask");
4094         return new ICmpInst(I.getPredicate(), And,
4095                             Constant::getNullValue(Cst1->getType()));
4096       }
4097     }
4098 
4099     // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
4100     // "icmp (and X, mask), cst"
4101     uint64_t ShAmt = 0;
4102     if (Op0->hasOneUse() &&
4103         match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
4104                                            m_ConstantInt(ShAmt))))) &&
4105         match(Op1, m_ConstantInt(Cst1)) &&
4106         // Only do this when A has multiple uses.  This is most important to do
4107         // when it exposes other optimizations.
4108         !A->hasOneUse()) {
4109       unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
4110 
4111       if (ShAmt < ASize) {
4112         APInt MaskV =
4113           APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
4114         MaskV <<= ShAmt;
4115 
4116         APInt CmpV = Cst1->getValue().zext(ASize);
4117         CmpV <<= ShAmt;
4118 
4119         Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
4120         return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
4121       }
4122     }
4123   }
4124 
4125   // The 'cmpxchg' instruction returns an aggregate containing the old value and
4126   // an i1 which indicates whether or not we successfully did the swap.
4127   //
4128   // Replace comparisons between the old value and the expected value with the
4129   // indicator that 'cmpxchg' returns.
4130   //
4131   // N.B.  This transform is only valid when the 'cmpxchg' is not permitted to
4132   // spuriously fail.  In those cases, the old value may equal the expected
4133   // value but it is possible for the swap to not occur.
4134   if (I.getPredicate() == ICmpInst::ICMP_EQ)
4135     if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
4136       if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
4137         if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
4138             !ACXI->isWeak())
4139           return ExtractValueInst::Create(ACXI, 1);
4140 
4141   {
4142     Value *X; ConstantInt *Cst;
4143     // icmp X+Cst, X
4144     if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
4145       return FoldICmpAddOpCst(I, X, Cst, I.getPredicate());
4146 
4147     // icmp X, X+Cst
4148     if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
4149       return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate());
4150   }
4151   return Changed ? &I : nullptr;
4152 }
4153 
4154 /// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
4155 Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
4156                                                 Instruction *LHSI,
4157                                                 Constant *RHSC) {
4158   if (!isa<ConstantFP>(RHSC)) return nullptr;
4159   const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
4160 
4161   // Get the width of the mantissa.  We don't want to hack on conversions that
4162   // might lose information from the integer, e.g. "i64 -> float"
4163   int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
4164   if (MantissaWidth == -1) return nullptr;  // Unknown.
4165 
4166   IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
4167 
4168   bool LHSUnsigned = isa<UIToFPInst>(LHSI);
4169 
4170   if (I.isEquality()) {
4171     FCmpInst::Predicate P = I.getPredicate();
4172     bool IsExact = false;
4173     APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
4174     RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
4175 
4176     // If the floating point constant isn't an integer value, we know if we will
4177     // ever compare equal / not equal to it.
4178     if (!IsExact) {
4179       // TODO: Can never be -0.0 and other non-representable values
4180       APFloat RHSRoundInt(RHS);
4181       RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
4182       if (RHS.compare(RHSRoundInt) != APFloat::cmpEqual) {
4183         if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
4184           return ReplaceInstUsesWith(I, Builder->getFalse());
4185 
4186         assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
4187         return ReplaceInstUsesWith(I, Builder->getTrue());
4188       }
4189     }
4190 
4191     // TODO: If the constant is exactly representable, is it always OK to do
4192     // equality compares as integer?
4193   }
4194 
4195   // Check to see that the input is converted from an integer type that is small
4196   // enough that preserves all bits.  TODO: check here for "known" sign bits.
4197   // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
4198   unsigned InputSize = IntTy->getScalarSizeInBits();
4199 
4200   // Following test does NOT adjust InputSize downwards for signed inputs,
4201   // because the most negative value still requires all the mantissa bits
4202   // to distinguish it from one less than that value.
4203   if ((int)InputSize > MantissaWidth) {
4204     // Conversion would lose accuracy. Check if loss can impact comparison.
4205     int Exp = ilogb(RHS);
4206     if (Exp == APFloat::IEK_Inf) {
4207       int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics()));
4208       if (MaxExponent < (int)InputSize - !LHSUnsigned)
4209         // Conversion could create infinity.
4210         return nullptr;
4211     } else {
4212       // Note that if RHS is zero or NaN, then Exp is negative
4213       // and first condition is trivially false.
4214       if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned)
4215         // Conversion could affect comparison.
4216         return nullptr;
4217     }
4218   }
4219 
4220   // Otherwise, we can potentially simplify the comparison.  We know that it
4221   // will always come through as an integer value and we know the constant is
4222   // not a NAN (it would have been previously simplified).
4223   assert(!RHS.isNaN() && "NaN comparison not already folded!");
4224 
4225   ICmpInst::Predicate Pred;
4226   switch (I.getPredicate()) {
4227   default: llvm_unreachable("Unexpected predicate!");
4228   case FCmpInst::FCMP_UEQ:
4229   case FCmpInst::FCMP_OEQ:
4230     Pred = ICmpInst::ICMP_EQ;
4231     break;
4232   case FCmpInst::FCMP_UGT:
4233   case FCmpInst::FCMP_OGT:
4234     Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
4235     break;
4236   case FCmpInst::FCMP_UGE:
4237   case FCmpInst::FCMP_OGE:
4238     Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
4239     break;
4240   case FCmpInst::FCMP_ULT:
4241   case FCmpInst::FCMP_OLT:
4242     Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
4243     break;
4244   case FCmpInst::FCMP_ULE:
4245   case FCmpInst::FCMP_OLE:
4246     Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
4247     break;
4248   case FCmpInst::FCMP_UNE:
4249   case FCmpInst::FCMP_ONE:
4250     Pred = ICmpInst::ICMP_NE;
4251     break;
4252   case FCmpInst::FCMP_ORD:
4253     return ReplaceInstUsesWith(I, Builder->getTrue());
4254   case FCmpInst::FCMP_UNO:
4255     return ReplaceInstUsesWith(I, Builder->getFalse());
4256   }
4257 
4258   // Now we know that the APFloat is a normal number, zero or inf.
4259 
4260   // See if the FP constant is too large for the integer.  For example,
4261   // comparing an i8 to 300.0.
4262   unsigned IntWidth = IntTy->getScalarSizeInBits();
4263 
4264   if (!LHSUnsigned) {
4265     // If the RHS value is > SignedMax, fold the comparison.  This handles +INF
4266     // and large values.
4267     APFloat SMax(RHS.getSemantics());
4268     SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
4269                           APFloat::rmNearestTiesToEven);
4270     if (SMax.compare(RHS) == APFloat::cmpLessThan) {  // smax < 13123.0
4271       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_SLT ||
4272           Pred == ICmpInst::ICMP_SLE)
4273         return ReplaceInstUsesWith(I, Builder->getTrue());
4274       return ReplaceInstUsesWith(I, Builder->getFalse());
4275     }
4276   } else {
4277     // If the RHS value is > UnsignedMax, fold the comparison. This handles
4278     // +INF and large values.
4279     APFloat UMax(RHS.getSemantics());
4280     UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
4281                           APFloat::rmNearestTiesToEven);
4282     if (UMax.compare(RHS) == APFloat::cmpLessThan) {  // umax < 13123.0
4283       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_ULT ||
4284           Pred == ICmpInst::ICMP_ULE)
4285         return ReplaceInstUsesWith(I, Builder->getTrue());
4286       return ReplaceInstUsesWith(I, Builder->getFalse());
4287     }
4288   }
4289 
4290   if (!LHSUnsigned) {
4291     // See if the RHS value is < SignedMin.
4292     APFloat SMin(RHS.getSemantics());
4293     SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
4294                           APFloat::rmNearestTiesToEven);
4295     if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
4296       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
4297           Pred == ICmpInst::ICMP_SGE)
4298         return ReplaceInstUsesWith(I, Builder->getTrue());
4299       return ReplaceInstUsesWith(I, Builder->getFalse());
4300     }
4301   } else {
4302     // See if the RHS value is < UnsignedMin.
4303     APFloat SMin(RHS.getSemantics());
4304     SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
4305                           APFloat::rmNearestTiesToEven);
4306     if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
4307       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
4308           Pred == ICmpInst::ICMP_UGE)
4309         return ReplaceInstUsesWith(I, Builder->getTrue());
4310       return ReplaceInstUsesWith(I, Builder->getFalse());
4311     }
4312   }
4313 
4314   // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
4315   // [0, UMAX], but it may still be fractional.  See if it is fractional by
4316   // casting the FP value to the integer value and back, checking for equality.
4317   // Don't do this for zero, because -0.0 is not fractional.
4318   Constant *RHSInt = LHSUnsigned
4319     ? ConstantExpr::getFPToUI(RHSC, IntTy)
4320     : ConstantExpr::getFPToSI(RHSC, IntTy);
4321   if (!RHS.isZero()) {
4322     bool Equal = LHSUnsigned
4323       ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
4324       : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
4325     if (!Equal) {
4326       // If we had a comparison against a fractional value, we have to adjust
4327       // the compare predicate and sometimes the value.  RHSC is rounded towards
4328       // zero at this point.
4329       switch (Pred) {
4330       default: llvm_unreachable("Unexpected integer comparison!");
4331       case ICmpInst::ICMP_NE:  // (float)int != 4.4   --> true
4332         return ReplaceInstUsesWith(I, Builder->getTrue());
4333       case ICmpInst::ICMP_EQ:  // (float)int == 4.4   --> false
4334         return ReplaceInstUsesWith(I, Builder->getFalse());
4335       case ICmpInst::ICMP_ULE:
4336         // (float)int <= 4.4   --> int <= 4
4337         // (float)int <= -4.4  --> false
4338         if (RHS.isNegative())
4339           return ReplaceInstUsesWith(I, Builder->getFalse());
4340         break;
4341       case ICmpInst::ICMP_SLE:
4342         // (float)int <= 4.4   --> int <= 4
4343         // (float)int <= -4.4  --> int < -4
4344         if (RHS.isNegative())
4345           Pred = ICmpInst::ICMP_SLT;
4346         break;
4347       case ICmpInst::ICMP_ULT:
4348         // (float)int < -4.4   --> false
4349         // (float)int < 4.4    --> int <= 4
4350         if (RHS.isNegative())
4351           return ReplaceInstUsesWith(I, Builder->getFalse());
4352         Pred = ICmpInst::ICMP_ULE;
4353         break;
4354       case ICmpInst::ICMP_SLT:
4355         // (float)int < -4.4   --> int < -4
4356         // (float)int < 4.4    --> int <= 4
4357         if (!RHS.isNegative())
4358           Pred = ICmpInst::ICMP_SLE;
4359         break;
4360       case ICmpInst::ICMP_UGT:
4361         // (float)int > 4.4    --> int > 4
4362         // (float)int > -4.4   --> true
4363         if (RHS.isNegative())
4364           return ReplaceInstUsesWith(I, Builder->getTrue());
4365         break;
4366       case ICmpInst::ICMP_SGT:
4367         // (float)int > 4.4    --> int > 4
4368         // (float)int > -4.4   --> int >= -4
4369         if (RHS.isNegative())
4370           Pred = ICmpInst::ICMP_SGE;
4371         break;
4372       case ICmpInst::ICMP_UGE:
4373         // (float)int >= -4.4   --> true
4374         // (float)int >= 4.4    --> int > 4
4375         if (RHS.isNegative())
4376           return ReplaceInstUsesWith(I, Builder->getTrue());
4377         Pred = ICmpInst::ICMP_UGT;
4378         break;
4379       case ICmpInst::ICMP_SGE:
4380         // (float)int >= -4.4   --> int >= -4
4381         // (float)int >= 4.4    --> int > 4
4382         if (!RHS.isNegative())
4383           Pred = ICmpInst::ICMP_SGT;
4384         break;
4385       }
4386     }
4387   }
4388 
4389   // Lower this FP comparison into an appropriate integer version of the
4390   // comparison.
4391   return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
4392 }
4393 
4394 Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
4395   bool Changed = false;
4396 
4397   /// Orders the operands of the compare so that they are listed from most
4398   /// complex to least complex.  This puts constants before unary operators,
4399   /// before binary operators.
4400   if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
4401     I.swapOperands();
4402     Changed = true;
4403   }
4404 
4405   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
4406 
4407   if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1,
4408                                   I.getFastMathFlags(), DL, TLI, DT, AC, &I))
4409     return ReplaceInstUsesWith(I, V);
4410 
4411   // Simplify 'fcmp pred X, X'
4412   if (Op0 == Op1) {
4413     switch (I.getPredicate()) {
4414     default: llvm_unreachable("Unknown predicate!");
4415     case FCmpInst::FCMP_UNO:    // True if unordered: isnan(X) | isnan(Y)
4416     case FCmpInst::FCMP_ULT:    // True if unordered or less than
4417     case FCmpInst::FCMP_UGT:    // True if unordered or greater than
4418     case FCmpInst::FCMP_UNE:    // True if unordered or not equal
4419       // Canonicalize these to be 'fcmp uno %X, 0.0'.
4420       I.setPredicate(FCmpInst::FCMP_UNO);
4421       I.setOperand(1, Constant::getNullValue(Op0->getType()));
4422       return &I;
4423 
4424     case FCmpInst::FCMP_ORD:    // True if ordered (no nans)
4425     case FCmpInst::FCMP_OEQ:    // True if ordered and equal
4426     case FCmpInst::FCMP_OGE:    // True if ordered and greater than or equal
4427     case FCmpInst::FCMP_OLE:    // True if ordered and less than or equal
4428       // Canonicalize these to be 'fcmp ord %X, 0.0'.
4429       I.setPredicate(FCmpInst::FCMP_ORD);
4430       I.setOperand(1, Constant::getNullValue(Op0->getType()));
4431       return &I;
4432     }
4433   }
4434 
4435   // Test if the FCmpInst instruction is used exclusively by a select as
4436   // part of a minimum or maximum operation. If so, refrain from doing
4437   // any other folding. This helps out other analyses which understand
4438   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
4439   // and CodeGen. And in this case, at least one of the comparison
4440   // operands has at least one user besides the compare (the select),
4441   // which would often largely negate the benefit of folding anyway.
4442   if (I.hasOneUse())
4443     if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
4444       if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
4445           (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
4446         return nullptr;
4447 
4448   // Handle fcmp with constant RHS
4449   if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
4450     if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
4451       switch (LHSI->getOpcode()) {
4452       case Instruction::FPExt: {
4453         // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
4454         FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
4455         ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
4456         if (!RHSF)
4457           break;
4458 
4459         const fltSemantics *Sem;
4460         // FIXME: This shouldn't be here.
4461         if (LHSExt->getSrcTy()->isHalfTy())
4462           Sem = &APFloat::IEEEhalf;
4463         else if (LHSExt->getSrcTy()->isFloatTy())
4464           Sem = &APFloat::IEEEsingle;
4465         else if (LHSExt->getSrcTy()->isDoubleTy())
4466           Sem = &APFloat::IEEEdouble;
4467         else if (LHSExt->getSrcTy()->isFP128Ty())
4468           Sem = &APFloat::IEEEquad;
4469         else if (LHSExt->getSrcTy()->isX86_FP80Ty())
4470           Sem = &APFloat::x87DoubleExtended;
4471         else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
4472           Sem = &APFloat::PPCDoubleDouble;
4473         else
4474           break;
4475 
4476         bool Lossy;
4477         APFloat F = RHSF->getValueAPF();
4478         F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
4479 
4480         // Avoid lossy conversions and denormals. Zero is a special case
4481         // that's OK to convert.
4482         APFloat Fabs = F;
4483         Fabs.clearSign();
4484         if (!Lossy &&
4485             ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
4486                  APFloat::cmpLessThan) || Fabs.isZero()))
4487 
4488           return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4489                               ConstantFP::get(RHSC->getContext(), F));
4490         break;
4491       }
4492       case Instruction::PHI:
4493         // Only fold fcmp into the PHI if the phi and fcmp are in the same
4494         // block.  If in the same block, we're encouraging jump threading.  If
4495         // not, we are just pessimizing the code by making an i1 phi.
4496         if (LHSI->getParent() == I.getParent())
4497           if (Instruction *NV = FoldOpIntoPhi(I))
4498             return NV;
4499         break;
4500       case Instruction::SIToFP:
4501       case Instruction::UIToFP:
4502         if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
4503           return NV;
4504         break;
4505       case Instruction::FSub: {
4506         // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
4507         Value *Op;
4508         if (match(LHSI, m_FNeg(m_Value(Op))))
4509           return new FCmpInst(I.getSwappedPredicate(), Op,
4510                               ConstantExpr::getFNeg(RHSC));
4511         break;
4512       }
4513       case Instruction::Load:
4514         if (GetElementPtrInst *GEP =
4515             dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
4516           if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
4517             if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
4518                 !cast<LoadInst>(LHSI)->isVolatile())
4519               if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
4520                 return Res;
4521         }
4522         break;
4523       case Instruction::Call: {
4524         if (!RHSC->isNullValue())
4525           break;
4526 
4527         CallInst *CI = cast<CallInst>(LHSI);
4528         const Function *F = CI->getCalledFunction();
4529         if (!F)
4530           break;
4531 
4532         // Various optimization for fabs compared with zero.
4533         LibFunc::Func Func;
4534         if (F->getIntrinsicID() == Intrinsic::fabs ||
4535             (TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
4536              (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
4537               Func == LibFunc::fabsl))) {
4538           switch (I.getPredicate()) {
4539           default:
4540             break;
4541             // fabs(x) < 0 --> false
4542           case FCmpInst::FCMP_OLT:
4543             return ReplaceInstUsesWith(I, Builder->getFalse());
4544             // fabs(x) > 0 --> x != 0
4545           case FCmpInst::FCMP_OGT:
4546             return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0), RHSC);
4547             // fabs(x) <= 0 --> x == 0
4548           case FCmpInst::FCMP_OLE:
4549             return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0), RHSC);
4550             // fabs(x) >= 0 --> !isnan(x)
4551           case FCmpInst::FCMP_OGE:
4552             return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0), RHSC);
4553             // fabs(x) == 0 --> x == 0
4554             // fabs(x) != 0 --> x != 0
4555           case FCmpInst::FCMP_OEQ:
4556           case FCmpInst::FCMP_UEQ:
4557           case FCmpInst::FCMP_ONE:
4558           case FCmpInst::FCMP_UNE:
4559             return new FCmpInst(I.getPredicate(), CI->getArgOperand(0), RHSC);
4560           }
4561         }
4562       }
4563       }
4564   }
4565 
4566   // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
4567   Value *X, *Y;
4568   if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
4569     return new FCmpInst(I.getSwappedPredicate(), X, Y);
4570 
4571   // fcmp (fpext x), (fpext y) -> fcmp x, y
4572   if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
4573     if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
4574       if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
4575         return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4576                             RHSExt->getOperand(0));
4577 
4578   return Changed ? &I : nullptr;
4579 }
4580