1 //===- InstCombineCompares.cpp --------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the visitICmp and visitFCmp functions.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "InstCombineInternal.h"
14 #include "llvm/ADT/APSInt.h"
15 #include "llvm/ADT/SetVector.h"
16 #include "llvm/ADT/Statistic.h"
17 #include "llvm/Analysis/ConstantFolding.h"
18 #include "llvm/Analysis/InstructionSimplify.h"
19 #include "llvm/Analysis/TargetLibraryInfo.h"
20 #include "llvm/IR/ConstantRange.h"
21 #include "llvm/IR/DataLayout.h"
22 #include "llvm/IR/GetElementPtrTypeIterator.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/PatternMatch.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/KnownBits.h"
27 #include "llvm/Transforms/InstCombine/InstCombiner.h"
28 
29 using namespace llvm;
30 using namespace PatternMatch;
31 
32 #define DEBUG_TYPE "instcombine"
33 
34 // How many times is a select replaced by one of its operands?
35 STATISTIC(NumSel, "Number of select opts");
36 
37 
38 /// Compute Result = In1+In2, returning true if the result overflowed for this
39 /// type.
40 static bool addWithOverflow(APInt &Result, const APInt &In1,
41                             const APInt &In2, bool IsSigned = false) {
42   bool Overflow;
43   if (IsSigned)
44     Result = In1.sadd_ov(In2, Overflow);
45   else
46     Result = In1.uadd_ov(In2, Overflow);
47 
48   return Overflow;
49 }
50 
51 /// Compute Result = In1-In2, returning true if the result overflowed for this
52 /// type.
53 static bool subWithOverflow(APInt &Result, const APInt &In1,
54                             const APInt &In2, bool IsSigned = false) {
55   bool Overflow;
56   if (IsSigned)
57     Result = In1.ssub_ov(In2, Overflow);
58   else
59     Result = In1.usub_ov(In2, Overflow);
60 
61   return Overflow;
62 }
63 
64 /// Given an icmp instruction, return true if any use of this comparison is a
65 /// branch on sign bit comparison.
66 static bool hasBranchUse(ICmpInst &I) {
67   for (auto *U : I.users())
68     if (isa<BranchInst>(U))
69       return true;
70   return false;
71 }
72 
73 /// Returns true if the exploded icmp can be expressed as a signed comparison
74 /// to zero and updates the predicate accordingly.
75 /// The signedness of the comparison is preserved.
76 /// TODO: Refactor with decomposeBitTestICmp()?
77 static bool isSignTest(ICmpInst::Predicate &Pred, const APInt &C) {
78   if (!ICmpInst::isSigned(Pred))
79     return false;
80 
81   if (C.isNullValue())
82     return ICmpInst::isRelational(Pred);
83 
84   if (C.isOneValue()) {
85     if (Pred == ICmpInst::ICMP_SLT) {
86       Pred = ICmpInst::ICMP_SLE;
87       return true;
88     }
89   } else if (C.isAllOnesValue()) {
90     if (Pred == ICmpInst::ICMP_SGT) {
91       Pred = ICmpInst::ICMP_SGE;
92       return true;
93     }
94   }
95 
96   return false;
97 }
98 
99 /// This is called when we see this pattern:
100 ///   cmp pred (load (gep GV, ...)), cmpcst
101 /// where GV is a global variable with a constant initializer. Try to simplify
102 /// this into some simple computation that does not need the load. For example
103 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
104 ///
105 /// If AndCst is non-null, then the loaded value is masked with that constant
106 /// before doing the comparison. This handles cases like "A[i]&4 == 0".
107 Instruction *
108 InstCombinerImpl::foldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP,
109                                                GlobalVariable *GV, CmpInst &ICI,
110                                                ConstantInt *AndCst) {
111   Constant *Init = GV->getInitializer();
112   if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
113     return nullptr;
114 
115   uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
116   // Don't blow up on huge arrays.
117   if (ArrayElementCount > MaxArraySizeForCombine)
118     return nullptr;
119 
120   // There are many forms of this optimization we can handle, for now, just do
121   // the simple index into a single-dimensional array.
122   //
123   // Require: GEP GV, 0, i {{, constant indices}}
124   if (GEP->getNumOperands() < 3 ||
125       !isa<ConstantInt>(GEP->getOperand(1)) ||
126       !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
127       isa<Constant>(GEP->getOperand(2)))
128     return nullptr;
129 
130   // Check that indices after the variable are constants and in-range for the
131   // type they index.  Collect the indices.  This is typically for arrays of
132   // structs.
133   SmallVector<unsigned, 4> LaterIndices;
134 
135   Type *EltTy = Init->getType()->getArrayElementType();
136   for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
137     ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
138     if (!Idx) return nullptr;  // Variable index.
139 
140     uint64_t IdxVal = Idx->getZExtValue();
141     if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
142 
143     if (StructType *STy = dyn_cast<StructType>(EltTy))
144       EltTy = STy->getElementType(IdxVal);
145     else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
146       if (IdxVal >= ATy->getNumElements()) return nullptr;
147       EltTy = ATy->getElementType();
148     } else {
149       return nullptr; // Unknown type.
150     }
151 
152     LaterIndices.push_back(IdxVal);
153   }
154 
155   enum { Overdefined = -3, Undefined = -2 };
156 
157   // Variables for our state machines.
158 
159   // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
160   // "i == 47 | i == 87", where 47 is the first index the condition is true for,
161   // and 87 is the second (and last) index.  FirstTrueElement is -2 when
162   // undefined, otherwise set to the first true element.  SecondTrueElement is
163   // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
164   int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
165 
166   // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
167   // form "i != 47 & i != 87".  Same state transitions as for true elements.
168   int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
169 
170   /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
171   /// define a state machine that triggers for ranges of values that the index
172   /// is true or false for.  This triggers on things like "abbbbc"[i] == 'b'.
173   /// This is -2 when undefined, -3 when overdefined, and otherwise the last
174   /// index in the range (inclusive).  We use -2 for undefined here because we
175   /// use relative comparisons and don't want 0-1 to match -1.
176   int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
177 
178   // MagicBitvector - This is a magic bitvector where we set a bit if the
179   // comparison is true for element 'i'.  If there are 64 elements or less in
180   // the array, this will fully represent all the comparison results.
181   uint64_t MagicBitvector = 0;
182 
183   // Scan the array and see if one of our patterns matches.
184   Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
185   for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
186     Constant *Elt = Init->getAggregateElement(i);
187     if (!Elt) return nullptr;
188 
189     // If this is indexing an array of structures, get the structure element.
190     if (!LaterIndices.empty())
191       Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
192 
193     // If the element is masked, handle it.
194     if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
195 
196     // Find out if the comparison would be true or false for the i'th element.
197     Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
198                                                   CompareRHS, DL, &TLI);
199     // If the result is undef for this element, ignore it.
200     if (isa<UndefValue>(C)) {
201       // Extend range state machines to cover this element in case there is an
202       // undef in the middle of the range.
203       if (TrueRangeEnd == (int)i-1)
204         TrueRangeEnd = i;
205       if (FalseRangeEnd == (int)i-1)
206         FalseRangeEnd = i;
207       continue;
208     }
209 
210     // If we can't compute the result for any of the elements, we have to give
211     // up evaluating the entire conditional.
212     if (!isa<ConstantInt>(C)) return nullptr;
213 
214     // Otherwise, we know if the comparison is true or false for this element,
215     // update our state machines.
216     bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
217 
218     // State machine for single/double/range index comparison.
219     if (IsTrueForElt) {
220       // Update the TrueElement state machine.
221       if (FirstTrueElement == Undefined)
222         FirstTrueElement = TrueRangeEnd = i;  // First true element.
223       else {
224         // Update double-compare state machine.
225         if (SecondTrueElement == Undefined)
226           SecondTrueElement = i;
227         else
228           SecondTrueElement = Overdefined;
229 
230         // Update range state machine.
231         if (TrueRangeEnd == (int)i-1)
232           TrueRangeEnd = i;
233         else
234           TrueRangeEnd = Overdefined;
235       }
236     } else {
237       // Update the FalseElement state machine.
238       if (FirstFalseElement == Undefined)
239         FirstFalseElement = FalseRangeEnd = i; // First false element.
240       else {
241         // Update double-compare state machine.
242         if (SecondFalseElement == Undefined)
243           SecondFalseElement = i;
244         else
245           SecondFalseElement = Overdefined;
246 
247         // Update range state machine.
248         if (FalseRangeEnd == (int)i-1)
249           FalseRangeEnd = i;
250         else
251           FalseRangeEnd = Overdefined;
252       }
253     }
254 
255     // If this element is in range, update our magic bitvector.
256     if (i < 64 && IsTrueForElt)
257       MagicBitvector |= 1ULL << i;
258 
259     // If all of our states become overdefined, bail out early.  Since the
260     // predicate is expensive, only check it every 8 elements.  This is only
261     // really useful for really huge arrays.
262     if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
263         SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
264         FalseRangeEnd == Overdefined)
265       return nullptr;
266   }
267 
268   // Now that we've scanned the entire array, emit our new comparison(s).  We
269   // order the state machines in complexity of the generated code.
270   Value *Idx = GEP->getOperand(2);
271 
272   // If the index is larger than the pointer size of the target, truncate the
273   // index down like the GEP would do implicitly.  We don't have to do this for
274   // an inbounds GEP because the index can't be out of range.
275   if (!GEP->isInBounds()) {
276     Type *IntPtrTy = DL.getIntPtrType(GEP->getType());
277     unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
278     if (Idx->getType()->getPrimitiveSizeInBits().getFixedSize() > PtrSize)
279       Idx = Builder.CreateTrunc(Idx, IntPtrTy);
280   }
281 
282   // If inbounds keyword is not present, Idx * ElementSize can overflow.
283   // Let's assume that ElementSize is 2 and the wanted value is at offset 0.
284   // Then, there are two possible values for Idx to match offset 0:
285   // 0x00..00, 0x80..00.
286   // Emitting 'icmp eq Idx, 0' isn't correct in this case because the
287   // comparison is false if Idx was 0x80..00.
288   // We need to erase the highest countTrailingZeros(ElementSize) bits of Idx.
289   unsigned ElementSize =
290       DL.getTypeAllocSize(Init->getType()->getArrayElementType());
291   auto MaskIdx = [&](Value* Idx){
292     if (!GEP->isInBounds() && countTrailingZeros(ElementSize) != 0) {
293       Value *Mask = ConstantInt::get(Idx->getType(), -1);
294       Mask = Builder.CreateLShr(Mask, countTrailingZeros(ElementSize));
295       Idx = Builder.CreateAnd(Idx, Mask);
296     }
297     return Idx;
298   };
299 
300   // If the comparison is only true for one or two elements, emit direct
301   // comparisons.
302   if (SecondTrueElement != Overdefined) {
303     Idx = MaskIdx(Idx);
304     // None true -> false.
305     if (FirstTrueElement == Undefined)
306       return replaceInstUsesWith(ICI, Builder.getFalse());
307 
308     Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
309 
310     // True for one element -> 'i == 47'.
311     if (SecondTrueElement == Undefined)
312       return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
313 
314     // True for two elements -> 'i == 47 | i == 72'.
315     Value *C1 = Builder.CreateICmpEQ(Idx, FirstTrueIdx);
316     Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
317     Value *C2 = Builder.CreateICmpEQ(Idx, SecondTrueIdx);
318     return BinaryOperator::CreateOr(C1, C2);
319   }
320 
321   // If the comparison is only false for one or two elements, emit direct
322   // comparisons.
323   if (SecondFalseElement != Overdefined) {
324     Idx = MaskIdx(Idx);
325     // None false -> true.
326     if (FirstFalseElement == Undefined)
327       return replaceInstUsesWith(ICI, Builder.getTrue());
328 
329     Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
330 
331     // False for one element -> 'i != 47'.
332     if (SecondFalseElement == Undefined)
333       return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
334 
335     // False for two elements -> 'i != 47 & i != 72'.
336     Value *C1 = Builder.CreateICmpNE(Idx, FirstFalseIdx);
337     Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
338     Value *C2 = Builder.CreateICmpNE(Idx, SecondFalseIdx);
339     return BinaryOperator::CreateAnd(C1, C2);
340   }
341 
342   // If the comparison can be replaced with a range comparison for the elements
343   // where it is true, emit the range check.
344   if (TrueRangeEnd != Overdefined) {
345     assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
346     Idx = MaskIdx(Idx);
347 
348     // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
349     if (FirstTrueElement) {
350       Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
351       Idx = Builder.CreateAdd(Idx, Offs);
352     }
353 
354     Value *End = ConstantInt::get(Idx->getType(),
355                                   TrueRangeEnd-FirstTrueElement+1);
356     return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
357   }
358 
359   // False range check.
360   if (FalseRangeEnd != Overdefined) {
361     assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
362     Idx = MaskIdx(Idx);
363     // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
364     if (FirstFalseElement) {
365       Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
366       Idx = Builder.CreateAdd(Idx, Offs);
367     }
368 
369     Value *End = ConstantInt::get(Idx->getType(),
370                                   FalseRangeEnd-FirstFalseElement);
371     return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
372   }
373 
374   // If a magic bitvector captures the entire comparison state
375   // of this load, replace it with computation that does:
376   //   ((magic_cst >> i) & 1) != 0
377   {
378     Type *Ty = nullptr;
379 
380     // Look for an appropriate type:
381     // - The type of Idx if the magic fits
382     // - The smallest fitting legal type
383     if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
384       Ty = Idx->getType();
385     else
386       Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
387 
388     if (Ty) {
389       Idx = MaskIdx(Idx);
390       Value *V = Builder.CreateIntCast(Idx, Ty, false);
391       V = Builder.CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
392       V = Builder.CreateAnd(ConstantInt::get(Ty, 1), V);
393       return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
394     }
395   }
396 
397   return nullptr;
398 }
399 
400 /// Return a value that can be used to compare the *offset* implied by a GEP to
401 /// zero. For example, if we have &A[i], we want to return 'i' for
402 /// "icmp ne i, 0". Note that, in general, indices can be complex, and scales
403 /// are involved. The above expression would also be legal to codegen as
404 /// "icmp ne (i*4), 0" (assuming A is a pointer to i32).
405 /// This latter form is less amenable to optimization though, and we are allowed
406 /// to generate the first by knowing that pointer arithmetic doesn't overflow.
407 ///
408 /// If we can't emit an optimized form for this expression, this returns null.
409 ///
410 static Value *evaluateGEPOffsetExpression(User *GEP, InstCombinerImpl &IC,
411                                           const DataLayout &DL) {
412   gep_type_iterator GTI = gep_type_begin(GEP);
413 
414   // Check to see if this gep only has a single variable index.  If so, and if
415   // any constant indices are a multiple of its scale, then we can compute this
416   // in terms of the scale of the variable index.  For example, if the GEP
417   // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
418   // because the expression will cross zero at the same point.
419   unsigned i, e = GEP->getNumOperands();
420   int64_t Offset = 0;
421   for (i = 1; i != e; ++i, ++GTI) {
422     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
423       // Compute the aggregate offset of constant indices.
424       if (CI->isZero()) continue;
425 
426       // Handle a struct index, which adds its field offset to the pointer.
427       if (StructType *STy = GTI.getStructTypeOrNull()) {
428         Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
429       } else {
430         uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
431         Offset += Size*CI->getSExtValue();
432       }
433     } else {
434       // Found our variable index.
435       break;
436     }
437   }
438 
439   // If there are no variable indices, we must have a constant offset, just
440   // evaluate it the general way.
441   if (i == e) return nullptr;
442 
443   Value *VariableIdx = GEP->getOperand(i);
444   // Determine the scale factor of the variable element.  For example, this is
445   // 4 if the variable index is into an array of i32.
446   uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
447 
448   // Verify that there are no other variable indices.  If so, emit the hard way.
449   for (++i, ++GTI; i != e; ++i, ++GTI) {
450     ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
451     if (!CI) return nullptr;
452 
453     // Compute the aggregate offset of constant indices.
454     if (CI->isZero()) continue;
455 
456     // Handle a struct index, which adds its field offset to the pointer.
457     if (StructType *STy = GTI.getStructTypeOrNull()) {
458       Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
459     } else {
460       uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
461       Offset += Size*CI->getSExtValue();
462     }
463   }
464 
465   // Okay, we know we have a single variable index, which must be a
466   // pointer/array/vector index.  If there is no offset, life is simple, return
467   // the index.
468   Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
469   unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
470   if (Offset == 0) {
471     // Cast to intptrty in case a truncation occurs.  If an extension is needed,
472     // we don't need to bother extending: the extension won't affect where the
473     // computation crosses zero.
474     if (VariableIdx->getType()->getPrimitiveSizeInBits().getFixedSize() >
475         IntPtrWidth) {
476       VariableIdx = IC.Builder.CreateTrunc(VariableIdx, IntPtrTy);
477     }
478     return VariableIdx;
479   }
480 
481   // Otherwise, there is an index.  The computation we will do will be modulo
482   // the pointer size.
483   Offset = SignExtend64(Offset, IntPtrWidth);
484   VariableScale = SignExtend64(VariableScale, IntPtrWidth);
485 
486   // To do this transformation, any constant index must be a multiple of the
487   // variable scale factor.  For example, we can evaluate "12 + 4*i" as "3 + i",
488   // but we can't evaluate "10 + 3*i" in terms of i.  Check that the offset is a
489   // multiple of the variable scale.
490   int64_t NewOffs = Offset / (int64_t)VariableScale;
491   if (Offset != NewOffs*(int64_t)VariableScale)
492     return nullptr;
493 
494   // Okay, we can do this evaluation.  Start by converting the index to intptr.
495   if (VariableIdx->getType() != IntPtrTy)
496     VariableIdx = IC.Builder.CreateIntCast(VariableIdx, IntPtrTy,
497                                             true /*Signed*/);
498   Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
499   return IC.Builder.CreateAdd(VariableIdx, OffsetVal, "offset");
500 }
501 
502 /// Returns true if we can rewrite Start as a GEP with pointer Base
503 /// and some integer offset. The nodes that need to be re-written
504 /// for this transformation will be added to Explored.
505 static bool canRewriteGEPAsOffset(Value *Start, Value *Base,
506                                   const DataLayout &DL,
507                                   SetVector<Value *> &Explored) {
508   SmallVector<Value *, 16> WorkList(1, Start);
509   Explored.insert(Base);
510 
511   // The following traversal gives us an order which can be used
512   // when doing the final transformation. Since in the final
513   // transformation we create the PHI replacement instructions first,
514   // we don't have to get them in any particular order.
515   //
516   // However, for other instructions we will have to traverse the
517   // operands of an instruction first, which means that we have to
518   // do a post-order traversal.
519   while (!WorkList.empty()) {
520     SetVector<PHINode *> PHIs;
521 
522     while (!WorkList.empty()) {
523       if (Explored.size() >= 100)
524         return false;
525 
526       Value *V = WorkList.back();
527 
528       if (Explored.contains(V)) {
529         WorkList.pop_back();
530         continue;
531       }
532 
533       if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) &&
534           !isa<GetElementPtrInst>(V) && !isa<PHINode>(V))
535         // We've found some value that we can't explore which is different from
536         // the base. Therefore we can't do this transformation.
537         return false;
538 
539       if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) {
540         auto *CI = cast<CastInst>(V);
541         if (!CI->isNoopCast(DL))
542           return false;
543 
544         if (Explored.count(CI->getOperand(0)) == 0)
545           WorkList.push_back(CI->getOperand(0));
546       }
547 
548       if (auto *GEP = dyn_cast<GEPOperator>(V)) {
549         // We're limiting the GEP to having one index. This will preserve
550         // the original pointer type. We could handle more cases in the
551         // future.
552         if (GEP->getNumIndices() != 1 || !GEP->isInBounds() ||
553             GEP->getType() != Start->getType())
554           return false;
555 
556         if (Explored.count(GEP->getOperand(0)) == 0)
557           WorkList.push_back(GEP->getOperand(0));
558       }
559 
560       if (WorkList.back() == V) {
561         WorkList.pop_back();
562         // We've finished visiting this node, mark it as such.
563         Explored.insert(V);
564       }
565 
566       if (auto *PN = dyn_cast<PHINode>(V)) {
567         // We cannot transform PHIs on unsplittable basic blocks.
568         if (isa<CatchSwitchInst>(PN->getParent()->getTerminator()))
569           return false;
570         Explored.insert(PN);
571         PHIs.insert(PN);
572       }
573     }
574 
575     // Explore the PHI nodes further.
576     for (auto *PN : PHIs)
577       for (Value *Op : PN->incoming_values())
578         if (Explored.count(Op) == 0)
579           WorkList.push_back(Op);
580   }
581 
582   // Make sure that we can do this. Since we can't insert GEPs in a basic
583   // block before a PHI node, we can't easily do this transformation if
584   // we have PHI node users of transformed instructions.
585   for (Value *Val : Explored) {
586     for (Value *Use : Val->uses()) {
587 
588       auto *PHI = dyn_cast<PHINode>(Use);
589       auto *Inst = dyn_cast<Instruction>(Val);
590 
591       if (Inst == Base || Inst == PHI || !Inst || !PHI ||
592           Explored.count(PHI) == 0)
593         continue;
594 
595       if (PHI->getParent() == Inst->getParent())
596         return false;
597     }
598   }
599   return true;
600 }
601 
602 // Sets the appropriate insert point on Builder where we can add
603 // a replacement Instruction for V (if that is possible).
604 static void setInsertionPoint(IRBuilder<> &Builder, Value *V,
605                               bool Before = true) {
606   if (auto *PHI = dyn_cast<PHINode>(V)) {
607     Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt());
608     return;
609   }
610   if (auto *I = dyn_cast<Instruction>(V)) {
611     if (!Before)
612       I = &*std::next(I->getIterator());
613     Builder.SetInsertPoint(I);
614     return;
615   }
616   if (auto *A = dyn_cast<Argument>(V)) {
617     // Set the insertion point in the entry block.
618     BasicBlock &Entry = A->getParent()->getEntryBlock();
619     Builder.SetInsertPoint(&*Entry.getFirstInsertionPt());
620     return;
621   }
622   // Otherwise, this is a constant and we don't need to set a new
623   // insertion point.
624   assert(isa<Constant>(V) && "Setting insertion point for unknown value!");
625 }
626 
627 /// Returns a re-written value of Start as an indexed GEP using Base as a
628 /// pointer.
629 static Value *rewriteGEPAsOffset(Value *Start, Value *Base,
630                                  const DataLayout &DL,
631                                  SetVector<Value *> &Explored) {
632   // Perform all the substitutions. This is a bit tricky because we can
633   // have cycles in our use-def chains.
634   // 1. Create the PHI nodes without any incoming values.
635   // 2. Create all the other values.
636   // 3. Add the edges for the PHI nodes.
637   // 4. Emit GEPs to get the original pointers.
638   // 5. Remove the original instructions.
639   Type *IndexType = IntegerType::get(
640       Base->getContext(), DL.getIndexTypeSizeInBits(Start->getType()));
641 
642   DenseMap<Value *, Value *> NewInsts;
643   NewInsts[Base] = ConstantInt::getNullValue(IndexType);
644 
645   // Create the new PHI nodes, without adding any incoming values.
646   for (Value *Val : Explored) {
647     if (Val == Base)
648       continue;
649     // Create empty phi nodes. This avoids cyclic dependencies when creating
650     // the remaining instructions.
651     if (auto *PHI = dyn_cast<PHINode>(Val))
652       NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(),
653                                       PHI->getName() + ".idx", PHI);
654   }
655   IRBuilder<> Builder(Base->getContext());
656 
657   // Create all the other instructions.
658   for (Value *Val : Explored) {
659 
660     if (NewInsts.find(Val) != NewInsts.end())
661       continue;
662 
663     if (auto *CI = dyn_cast<CastInst>(Val)) {
664       // Don't get rid of the intermediate variable here; the store can grow
665       // the map which will invalidate the reference to the input value.
666       Value *V = NewInsts[CI->getOperand(0)];
667       NewInsts[CI] = V;
668       continue;
669     }
670     if (auto *GEP = dyn_cast<GEPOperator>(Val)) {
671       Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)]
672                                                   : GEP->getOperand(1);
673       setInsertionPoint(Builder, GEP);
674       // Indices might need to be sign extended. GEPs will magically do
675       // this, but we need to do it ourselves here.
676       if (Index->getType()->getScalarSizeInBits() !=
677           NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) {
678         Index = Builder.CreateSExtOrTrunc(
679             Index, NewInsts[GEP->getOperand(0)]->getType(),
680             GEP->getOperand(0)->getName() + ".sext");
681       }
682 
683       auto *Op = NewInsts[GEP->getOperand(0)];
684       if (isa<ConstantInt>(Op) && cast<ConstantInt>(Op)->isZero())
685         NewInsts[GEP] = Index;
686       else
687         NewInsts[GEP] = Builder.CreateNSWAdd(
688             Op, Index, GEP->getOperand(0)->getName() + ".add");
689       continue;
690     }
691     if (isa<PHINode>(Val))
692       continue;
693 
694     llvm_unreachable("Unexpected instruction type");
695   }
696 
697   // Add the incoming values to the PHI nodes.
698   for (Value *Val : Explored) {
699     if (Val == Base)
700       continue;
701     // All the instructions have been created, we can now add edges to the
702     // phi nodes.
703     if (auto *PHI = dyn_cast<PHINode>(Val)) {
704       PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]);
705       for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) {
706         Value *NewIncoming = PHI->getIncomingValue(I);
707 
708         if (NewInsts.find(NewIncoming) != NewInsts.end())
709           NewIncoming = NewInsts[NewIncoming];
710 
711         NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I));
712       }
713     }
714   }
715 
716   for (Value *Val : Explored) {
717     if (Val == Base)
718       continue;
719 
720     // Depending on the type, for external users we have to emit
721     // a GEP or a GEP + ptrtoint.
722     setInsertionPoint(Builder, Val, false);
723 
724     // If required, create an inttoptr instruction for Base.
725     Value *NewBase = Base;
726     if (!Base->getType()->isPointerTy())
727       NewBase = Builder.CreateBitOrPointerCast(Base, Start->getType(),
728                                                Start->getName() + "to.ptr");
729 
730     Value *GEP = Builder.CreateInBoundsGEP(
731         Start->getType()->getPointerElementType(), NewBase,
732         makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr");
733 
734     if (!Val->getType()->isPointerTy()) {
735       Value *Cast = Builder.CreatePointerCast(GEP, Val->getType(),
736                                               Val->getName() + ".conv");
737       GEP = Cast;
738     }
739     Val->replaceAllUsesWith(GEP);
740   }
741 
742   return NewInsts[Start];
743 }
744 
745 /// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express
746 /// the input Value as a constant indexed GEP. Returns a pair containing
747 /// the GEPs Pointer and Index.
748 static std::pair<Value *, Value *>
749 getAsConstantIndexedAddress(Value *V, const DataLayout &DL) {
750   Type *IndexType = IntegerType::get(V->getContext(),
751                                      DL.getIndexTypeSizeInBits(V->getType()));
752 
753   Constant *Index = ConstantInt::getNullValue(IndexType);
754   while (true) {
755     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
756       // We accept only inbouds GEPs here to exclude the possibility of
757       // overflow.
758       if (!GEP->isInBounds())
759         break;
760       if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 &&
761           GEP->getType() == V->getType()) {
762         V = GEP->getOperand(0);
763         Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1));
764         Index = ConstantExpr::getAdd(
765             Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType));
766         continue;
767       }
768       break;
769     }
770     if (auto *CI = dyn_cast<IntToPtrInst>(V)) {
771       if (!CI->isNoopCast(DL))
772         break;
773       V = CI->getOperand(0);
774       continue;
775     }
776     if (auto *CI = dyn_cast<PtrToIntInst>(V)) {
777       if (!CI->isNoopCast(DL))
778         break;
779       V = CI->getOperand(0);
780       continue;
781     }
782     break;
783   }
784   return {V, Index};
785 }
786 
787 /// Converts (CMP GEPLHS, RHS) if this change would make RHS a constant.
788 /// We can look through PHIs, GEPs and casts in order to determine a common base
789 /// between GEPLHS and RHS.
790 static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS,
791                                               ICmpInst::Predicate Cond,
792                                               const DataLayout &DL) {
793   // FIXME: Support vector of pointers.
794   if (GEPLHS->getType()->isVectorTy())
795     return nullptr;
796 
797   if (!GEPLHS->hasAllConstantIndices())
798     return nullptr;
799 
800   // Make sure the pointers have the same type.
801   if (GEPLHS->getType() != RHS->getType())
802     return nullptr;
803 
804   Value *PtrBase, *Index;
805   std::tie(PtrBase, Index) = getAsConstantIndexedAddress(GEPLHS, DL);
806 
807   // The set of nodes that will take part in this transformation.
808   SetVector<Value *> Nodes;
809 
810   if (!canRewriteGEPAsOffset(RHS, PtrBase, DL, Nodes))
811     return nullptr;
812 
813   // We know we can re-write this as
814   //  ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)
815   // Since we've only looked through inbouds GEPs we know that we
816   // can't have overflow on either side. We can therefore re-write
817   // this as:
818   //   OFFSET1 cmp OFFSET2
819   Value *NewRHS = rewriteGEPAsOffset(RHS, PtrBase, DL, Nodes);
820 
821   // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written
822   // GEP having PtrBase as the pointer base, and has returned in NewRHS the
823   // offset. Since Index is the offset of LHS to the base pointer, we will now
824   // compare the offsets instead of comparing the pointers.
825   return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS);
826 }
827 
828 /// Fold comparisons between a GEP instruction and something else. At this point
829 /// we know that the GEP is on the LHS of the comparison.
830 Instruction *InstCombinerImpl::foldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
831                                            ICmpInst::Predicate Cond,
832                                            Instruction &I) {
833   // Don't transform signed compares of GEPs into index compares. Even if the
834   // GEP is inbounds, the final add of the base pointer can have signed overflow
835   // and would change the result of the icmp.
836   // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
837   // the maximum signed value for the pointer type.
838   if (ICmpInst::isSigned(Cond))
839     return nullptr;
840 
841   // Look through bitcasts and addrspacecasts. We do not however want to remove
842   // 0 GEPs.
843   if (!isa<GetElementPtrInst>(RHS))
844     RHS = RHS->stripPointerCasts();
845 
846   Value *PtrBase = GEPLHS->getOperand(0);
847   // FIXME: Support vector pointer GEPs.
848   if (PtrBase == RHS && GEPLHS->isInBounds() &&
849       !GEPLHS->getType()->isVectorTy()) {
850     // ((gep Ptr, OFFSET) cmp Ptr)   ---> (OFFSET cmp 0).
851     // This transformation (ignoring the base and scales) is valid because we
852     // know pointers can't overflow since the gep is inbounds.  See if we can
853     // output an optimized form.
854     Value *Offset = evaluateGEPOffsetExpression(GEPLHS, *this, DL);
855 
856     // If not, synthesize the offset the hard way.
857     if (!Offset)
858       Offset = EmitGEPOffset(GEPLHS);
859     return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
860                         Constant::getNullValue(Offset->getType()));
861   }
862 
863   if (GEPLHS->isInBounds() && ICmpInst::isEquality(Cond) &&
864       isa<Constant>(RHS) && cast<Constant>(RHS)->isNullValue() &&
865       !NullPointerIsDefined(I.getFunction(),
866                             RHS->getType()->getPointerAddressSpace())) {
867     // For most address spaces, an allocation can't be placed at null, but null
868     // itself is treated as a 0 size allocation in the in bounds rules.  Thus,
869     // the only valid inbounds address derived from null, is null itself.
870     // Thus, we have four cases to consider:
871     // 1) Base == nullptr, Offset == 0 -> inbounds, null
872     // 2) Base == nullptr, Offset != 0 -> poison as the result is out of bounds
873     // 3) Base != nullptr, Offset == (-base) -> poison (crossing allocations)
874     // 4) Base != nullptr, Offset != (-base) -> nonnull (and possibly poison)
875     //
876     // (Note if we're indexing a type of size 0, that simply collapses into one
877     //  of the buckets above.)
878     //
879     // In general, we're allowed to make values less poison (i.e. remove
880     //   sources of full UB), so in this case, we just select between the two
881     //   non-poison cases (1 and 4 above).
882     //
883     // For vectors, we apply the same reasoning on a per-lane basis.
884     auto *Base = GEPLHS->getPointerOperand();
885     if (GEPLHS->getType()->isVectorTy() && Base->getType()->isPointerTy()) {
886       auto EC = cast<VectorType>(GEPLHS->getType())->getElementCount();
887       Base = Builder.CreateVectorSplat(EC, Base);
888     }
889     return new ICmpInst(Cond, Base,
890                         ConstantExpr::getPointerBitCastOrAddrSpaceCast(
891                             cast<Constant>(RHS), Base->getType()));
892   } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
893     // If the base pointers are different, but the indices are the same, just
894     // compare the base pointer.
895     if (PtrBase != GEPRHS->getOperand(0)) {
896       bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
897       IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
898                         GEPRHS->getOperand(0)->getType();
899       if (IndicesTheSame)
900         for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
901           if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
902             IndicesTheSame = false;
903             break;
904           }
905 
906       // If all indices are the same, just compare the base pointers.
907       Type *BaseType = GEPLHS->getOperand(0)->getType();
908       if (IndicesTheSame && CmpInst::makeCmpResultType(BaseType) == I.getType())
909         return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
910 
911       // If we're comparing GEPs with two base pointers that only differ in type
912       // and both GEPs have only constant indices or just one use, then fold
913       // the compare with the adjusted indices.
914       // FIXME: Support vector of pointers.
915       if (GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
916           (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
917           (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
918           PtrBase->stripPointerCasts() ==
919               GEPRHS->getOperand(0)->stripPointerCasts() &&
920           !GEPLHS->getType()->isVectorTy()) {
921         Value *LOffset = EmitGEPOffset(GEPLHS);
922         Value *ROffset = EmitGEPOffset(GEPRHS);
923 
924         // If we looked through an addrspacecast between different sized address
925         // spaces, the LHS and RHS pointers are different sized
926         // integers. Truncate to the smaller one.
927         Type *LHSIndexTy = LOffset->getType();
928         Type *RHSIndexTy = ROffset->getType();
929         if (LHSIndexTy != RHSIndexTy) {
930           if (LHSIndexTy->getPrimitiveSizeInBits().getFixedSize() <
931               RHSIndexTy->getPrimitiveSizeInBits().getFixedSize()) {
932             ROffset = Builder.CreateTrunc(ROffset, LHSIndexTy);
933           } else
934             LOffset = Builder.CreateTrunc(LOffset, RHSIndexTy);
935         }
936 
937         Value *Cmp = Builder.CreateICmp(ICmpInst::getSignedPredicate(Cond),
938                                         LOffset, ROffset);
939         return replaceInstUsesWith(I, Cmp);
940       }
941 
942       // Otherwise, the base pointers are different and the indices are
943       // different. Try convert this to an indexed compare by looking through
944       // PHIs/casts.
945       return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
946     }
947 
948     // If one of the GEPs has all zero indices, recurse.
949     // FIXME: Handle vector of pointers.
950     if (!GEPLHS->getType()->isVectorTy() && GEPLHS->hasAllZeroIndices())
951       return foldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
952                          ICmpInst::getSwappedPredicate(Cond), I);
953 
954     // If the other GEP has all zero indices, recurse.
955     // FIXME: Handle vector of pointers.
956     if (!GEPRHS->getType()->isVectorTy() && GEPRHS->hasAllZeroIndices())
957       return foldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
958 
959     bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
960     if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
961       // If the GEPs only differ by one index, compare it.
962       unsigned NumDifferences = 0;  // Keep track of # differences.
963       unsigned DiffOperand = 0;     // The operand that differs.
964       for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
965         if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
966           Type *LHSType = GEPLHS->getOperand(i)->getType();
967           Type *RHSType = GEPRHS->getOperand(i)->getType();
968           // FIXME: Better support for vector of pointers.
969           if (LHSType->getPrimitiveSizeInBits() !=
970                    RHSType->getPrimitiveSizeInBits() ||
971               (GEPLHS->getType()->isVectorTy() &&
972                (!LHSType->isVectorTy() || !RHSType->isVectorTy()))) {
973             // Irreconcilable differences.
974             NumDifferences = 2;
975             break;
976           }
977 
978           if (NumDifferences++) break;
979           DiffOperand = i;
980         }
981 
982       if (NumDifferences == 0)   // SAME GEP?
983         return replaceInstUsesWith(I, // No comparison is needed here.
984           ConstantInt::get(I.getType(), ICmpInst::isTrueWhenEqual(Cond)));
985 
986       else if (NumDifferences == 1 && GEPsInBounds) {
987         Value *LHSV = GEPLHS->getOperand(DiffOperand);
988         Value *RHSV = GEPRHS->getOperand(DiffOperand);
989         // Make sure we do a signed comparison here.
990         return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
991       }
992     }
993 
994     // Only lower this if the icmp is the only user of the GEP or if we expect
995     // the result to fold to a constant!
996     if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
997         (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
998       // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)  --->  (OFFSET1 cmp OFFSET2)
999       Value *L = EmitGEPOffset(GEPLHS);
1000       Value *R = EmitGEPOffset(GEPRHS);
1001       return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
1002     }
1003   }
1004 
1005   // Try convert this to an indexed compare by looking through PHIs/casts as a
1006   // last resort.
1007   return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
1008 }
1009 
1010 Instruction *InstCombinerImpl::foldAllocaCmp(ICmpInst &ICI,
1011                                              const AllocaInst *Alloca,
1012                                              const Value *Other) {
1013   assert(ICI.isEquality() && "Cannot fold non-equality comparison.");
1014 
1015   // It would be tempting to fold away comparisons between allocas and any
1016   // pointer not based on that alloca (e.g. an argument). However, even
1017   // though such pointers cannot alias, they can still compare equal.
1018   //
1019   // But LLVM doesn't specify where allocas get their memory, so if the alloca
1020   // doesn't escape we can argue that it's impossible to guess its value, and we
1021   // can therefore act as if any such guesses are wrong.
1022   //
1023   // The code below checks that the alloca doesn't escape, and that it's only
1024   // used in a comparison once (the current instruction). The
1025   // single-comparison-use condition ensures that we're trivially folding all
1026   // comparisons against the alloca consistently, and avoids the risk of
1027   // erroneously folding a comparison of the pointer with itself.
1028 
1029   unsigned MaxIter = 32; // Break cycles and bound to constant-time.
1030 
1031   SmallVector<const Use *, 32> Worklist;
1032   for (const Use &U : Alloca->uses()) {
1033     if (Worklist.size() >= MaxIter)
1034       return nullptr;
1035     Worklist.push_back(&U);
1036   }
1037 
1038   unsigned NumCmps = 0;
1039   while (!Worklist.empty()) {
1040     assert(Worklist.size() <= MaxIter);
1041     const Use *U = Worklist.pop_back_val();
1042     const Value *V = U->getUser();
1043     --MaxIter;
1044 
1045     if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) ||
1046         isa<SelectInst>(V)) {
1047       // Track the uses.
1048     } else if (isa<LoadInst>(V)) {
1049       // Loading from the pointer doesn't escape it.
1050       continue;
1051     } else if (const auto *SI = dyn_cast<StoreInst>(V)) {
1052       // Storing *to* the pointer is fine, but storing the pointer escapes it.
1053       if (SI->getValueOperand() == U->get())
1054         return nullptr;
1055       continue;
1056     } else if (isa<ICmpInst>(V)) {
1057       if (NumCmps++)
1058         return nullptr; // Found more than one cmp.
1059       continue;
1060     } else if (const auto *Intrin = dyn_cast<IntrinsicInst>(V)) {
1061       switch (Intrin->getIntrinsicID()) {
1062         // These intrinsics don't escape or compare the pointer. Memset is safe
1063         // because we don't allow ptrtoint. Memcpy and memmove are safe because
1064         // we don't allow stores, so src cannot point to V.
1065         case Intrinsic::lifetime_start: case Intrinsic::lifetime_end:
1066         case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset:
1067           continue;
1068         default:
1069           return nullptr;
1070       }
1071     } else {
1072       return nullptr;
1073     }
1074     for (const Use &U : V->uses()) {
1075       if (Worklist.size() >= MaxIter)
1076         return nullptr;
1077       Worklist.push_back(&U);
1078     }
1079   }
1080 
1081   Type *CmpTy = CmpInst::makeCmpResultType(Other->getType());
1082   return replaceInstUsesWith(
1083       ICI,
1084       ConstantInt::get(CmpTy, !CmpInst::isTrueWhenEqual(ICI.getPredicate())));
1085 }
1086 
1087 /// Fold "icmp pred (X+C), X".
1088 Instruction *InstCombinerImpl::foldICmpAddOpConst(Value *X, const APInt &C,
1089                                                   ICmpInst::Predicate Pred) {
1090   // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
1091   // so the values can never be equal.  Similarly for all other "or equals"
1092   // operators.
1093   assert(!!C && "C should not be zero!");
1094 
1095   // (X+1) <u X        --> X >u (MAXUINT-1)        --> X == 255
1096   // (X+2) <u X        --> X >u (MAXUINT-2)        --> X > 253
1097   // (X+MAXUINT) <u X  --> X >u (MAXUINT-MAXUINT)  --> X != 0
1098   if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
1099     Constant *R = ConstantInt::get(X->getType(),
1100                                    APInt::getMaxValue(C.getBitWidth()) - C);
1101     return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
1102   }
1103 
1104   // (X+1) >u X        --> X <u (0-1)        --> X != 255
1105   // (X+2) >u X        --> X <u (0-2)        --> X <u 254
1106   // (X+MAXUINT) >u X  --> X <u (0-MAXUINT)  --> X <u 1  --> X == 0
1107   if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
1108     return new ICmpInst(ICmpInst::ICMP_ULT, X,
1109                         ConstantInt::get(X->getType(), -C));
1110 
1111   APInt SMax = APInt::getSignedMaxValue(C.getBitWidth());
1112 
1113   // (X+ 1) <s X       --> X >s (MAXSINT-1)          --> X == 127
1114   // (X+ 2) <s X       --> X >s (MAXSINT-2)          --> X >s 125
1115   // (X+MAXSINT) <s X  --> X >s (MAXSINT-MAXSINT)    --> X >s 0
1116   // (X+MINSINT) <s X  --> X >s (MAXSINT-MINSINT)    --> X >s -1
1117   // (X+ -2) <s X      --> X >s (MAXSINT- -2)        --> X >s 126
1118   // (X+ -1) <s X      --> X >s (MAXSINT- -1)        --> X != 127
1119   if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1120     return new ICmpInst(ICmpInst::ICMP_SGT, X,
1121                         ConstantInt::get(X->getType(), SMax - C));
1122 
1123   // (X+ 1) >s X       --> X <s (MAXSINT-(1-1))       --> X != 127
1124   // (X+ 2) >s X       --> X <s (MAXSINT-(2-1))       --> X <s 126
1125   // (X+MAXSINT) >s X  --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
1126   // (X+MINSINT) >s X  --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
1127   // (X+ -2) >s X      --> X <s (MAXSINT-(-2-1))      --> X <s -126
1128   // (X+ -1) >s X      --> X <s (MAXSINT-(-1-1))      --> X == -128
1129 
1130   assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
1131   return new ICmpInst(ICmpInst::ICMP_SLT, X,
1132                       ConstantInt::get(X->getType(), SMax - (C - 1)));
1133 }
1134 
1135 /// Handle "(icmp eq/ne (ashr/lshr AP2, A), AP1)" ->
1136 /// (icmp eq/ne A, Log2(AP2/AP1)) ->
1137 /// (icmp eq/ne A, Log2(AP2) - Log2(AP1)).
1138 Instruction *InstCombinerImpl::foldICmpShrConstConst(ICmpInst &I, Value *A,
1139                                                      const APInt &AP1,
1140                                                      const APInt &AP2) {
1141   assert(I.isEquality() && "Cannot fold icmp gt/lt");
1142 
1143   auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1144     if (I.getPredicate() == I.ICMP_NE)
1145       Pred = CmpInst::getInversePredicate(Pred);
1146     return new ICmpInst(Pred, LHS, RHS);
1147   };
1148 
1149   // Don't bother doing any work for cases which InstSimplify handles.
1150   if (AP2.isNullValue())
1151     return nullptr;
1152 
1153   bool IsAShr = isa<AShrOperator>(I.getOperand(0));
1154   if (IsAShr) {
1155     if (AP2.isAllOnesValue())
1156       return nullptr;
1157     if (AP2.isNegative() != AP1.isNegative())
1158       return nullptr;
1159     if (AP2.sgt(AP1))
1160       return nullptr;
1161   }
1162 
1163   if (!AP1)
1164     // 'A' must be large enough to shift out the highest set bit.
1165     return getICmp(I.ICMP_UGT, A,
1166                    ConstantInt::get(A->getType(), AP2.logBase2()));
1167 
1168   if (AP1 == AP2)
1169     return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1170 
1171   int Shift;
1172   if (IsAShr && AP1.isNegative())
1173     Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes();
1174   else
1175     Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros();
1176 
1177   if (Shift > 0) {
1178     if (IsAShr && AP1 == AP2.ashr(Shift)) {
1179       // There are multiple solutions if we are comparing against -1 and the LHS
1180       // of the ashr is not a power of two.
1181       if (AP1.isAllOnesValue() && !AP2.isPowerOf2())
1182         return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift));
1183       return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1184     } else if (AP1 == AP2.lshr(Shift)) {
1185       return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1186     }
1187   }
1188 
1189   // Shifting const2 will never be equal to const1.
1190   // FIXME: This should always be handled by InstSimplify?
1191   auto *TorF = ConstantInt::get(I.getType(), I.getPredicate() == I.ICMP_NE);
1192   return replaceInstUsesWith(I, TorF);
1193 }
1194 
1195 /// Handle "(icmp eq/ne (shl AP2, A), AP1)" ->
1196 /// (icmp eq/ne A, TrailingZeros(AP1) - TrailingZeros(AP2)).
1197 Instruction *InstCombinerImpl::foldICmpShlConstConst(ICmpInst &I, Value *A,
1198                                                      const APInt &AP1,
1199                                                      const APInt &AP2) {
1200   assert(I.isEquality() && "Cannot fold icmp gt/lt");
1201 
1202   auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1203     if (I.getPredicate() == I.ICMP_NE)
1204       Pred = CmpInst::getInversePredicate(Pred);
1205     return new ICmpInst(Pred, LHS, RHS);
1206   };
1207 
1208   // Don't bother doing any work for cases which InstSimplify handles.
1209   if (AP2.isNullValue())
1210     return nullptr;
1211 
1212   unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1213 
1214   if (!AP1 && AP2TrailingZeros != 0)
1215     return getICmp(
1216         I.ICMP_UGE, A,
1217         ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
1218 
1219   if (AP1 == AP2)
1220     return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1221 
1222   // Get the distance between the lowest bits that are set.
1223   int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1224 
1225   if (Shift > 0 && AP2.shl(Shift) == AP1)
1226     return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1227 
1228   // Shifting const2 will never be equal to const1.
1229   // FIXME: This should always be handled by InstSimplify?
1230   auto *TorF = ConstantInt::get(I.getType(), I.getPredicate() == I.ICMP_NE);
1231   return replaceInstUsesWith(I, TorF);
1232 }
1233 
1234 /// The caller has matched a pattern of the form:
1235 ///   I = icmp ugt (add (add A, B), CI2), CI1
1236 /// If this is of the form:
1237 ///   sum = a + b
1238 ///   if (sum+128 >u 255)
1239 /// Then replace it with llvm.sadd.with.overflow.i8.
1240 ///
1241 static Instruction *processUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
1242                                           ConstantInt *CI2, ConstantInt *CI1,
1243                                           InstCombinerImpl &IC) {
1244   // The transformation we're trying to do here is to transform this into an
1245   // llvm.sadd.with.overflow.  To do this, we have to replace the original add
1246   // with a narrower add, and discard the add-with-constant that is part of the
1247   // range check (if we can't eliminate it, this isn't profitable).
1248 
1249   // In order to eliminate the add-with-constant, the compare can be its only
1250   // use.
1251   Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
1252   if (!AddWithCst->hasOneUse())
1253     return nullptr;
1254 
1255   // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
1256   if (!CI2->getValue().isPowerOf2())
1257     return nullptr;
1258   unsigned NewWidth = CI2->getValue().countTrailingZeros();
1259   if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31)
1260     return nullptr;
1261 
1262   // The width of the new add formed is 1 more than the bias.
1263   ++NewWidth;
1264 
1265   // Check to see that CI1 is an all-ones value with NewWidth bits.
1266   if (CI1->getBitWidth() == NewWidth ||
1267       CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
1268     return nullptr;
1269 
1270   // This is only really a signed overflow check if the inputs have been
1271   // sign-extended; check for that condition. For example, if CI2 is 2^31 and
1272   // the operands of the add are 64 bits wide, we need at least 33 sign bits.
1273   unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
1274   if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
1275       IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
1276     return nullptr;
1277 
1278   // In order to replace the original add with a narrower
1279   // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
1280   // and truncates that discard the high bits of the add.  Verify that this is
1281   // the case.
1282   Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
1283   for (User *U : OrigAdd->users()) {
1284     if (U == AddWithCst)
1285       continue;
1286 
1287     // Only accept truncates for now.  We would really like a nice recursive
1288     // predicate like SimplifyDemandedBits, but which goes downwards the use-def
1289     // chain to see which bits of a value are actually demanded.  If the
1290     // original add had another add which was then immediately truncated, we
1291     // could still do the transformation.
1292     TruncInst *TI = dyn_cast<TruncInst>(U);
1293     if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
1294       return nullptr;
1295   }
1296 
1297   // If the pattern matches, truncate the inputs to the narrower type and
1298   // use the sadd_with_overflow intrinsic to efficiently compute both the
1299   // result and the overflow bit.
1300   Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
1301   Function *F = Intrinsic::getDeclaration(
1302       I.getModule(), Intrinsic::sadd_with_overflow, NewType);
1303 
1304   InstCombiner::BuilderTy &Builder = IC.Builder;
1305 
1306   // Put the new code above the original add, in case there are any uses of the
1307   // add between the add and the compare.
1308   Builder.SetInsertPoint(OrigAdd);
1309 
1310   Value *TruncA = Builder.CreateTrunc(A, NewType, A->getName() + ".trunc");
1311   Value *TruncB = Builder.CreateTrunc(B, NewType, B->getName() + ".trunc");
1312   CallInst *Call = Builder.CreateCall(F, {TruncA, TruncB}, "sadd");
1313   Value *Add = Builder.CreateExtractValue(Call, 0, "sadd.result");
1314   Value *ZExt = Builder.CreateZExt(Add, OrigAdd->getType());
1315 
1316   // The inner add was the result of the narrow add, zero extended to the
1317   // wider type.  Replace it with the result computed by the intrinsic.
1318   IC.replaceInstUsesWith(*OrigAdd, ZExt);
1319   IC.eraseInstFromFunction(*OrigAdd);
1320 
1321   // The original icmp gets replaced with the overflow value.
1322   return ExtractValueInst::Create(Call, 1, "sadd.overflow");
1323 }
1324 
1325 /// If we have:
1326 ///   icmp eq/ne (urem/srem %x, %y), 0
1327 /// iff %y is a power-of-two, we can replace this with a bit test:
1328 ///   icmp eq/ne (and %x, (add %y, -1)), 0
1329 Instruction *InstCombinerImpl::foldIRemByPowerOfTwoToBitTest(ICmpInst &I) {
1330   // This fold is only valid for equality predicates.
1331   if (!I.isEquality())
1332     return nullptr;
1333   ICmpInst::Predicate Pred;
1334   Value *X, *Y, *Zero;
1335   if (!match(&I, m_ICmp(Pred, m_OneUse(m_IRem(m_Value(X), m_Value(Y))),
1336                         m_CombineAnd(m_Zero(), m_Value(Zero)))))
1337     return nullptr;
1338   if (!isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, 0, &I))
1339     return nullptr;
1340   // This may increase instruction count, we don't enforce that Y is a constant.
1341   Value *Mask = Builder.CreateAdd(Y, Constant::getAllOnesValue(Y->getType()));
1342   Value *Masked = Builder.CreateAnd(X, Mask);
1343   return ICmpInst::Create(Instruction::ICmp, Pred, Masked, Zero);
1344 }
1345 
1346 /// Fold equality-comparison between zero and any (maybe truncated) right-shift
1347 /// by one-less-than-bitwidth into a sign test on the original value.
1348 Instruction *InstCombinerImpl::foldSignBitTest(ICmpInst &I) {
1349   Instruction *Val;
1350   ICmpInst::Predicate Pred;
1351   if (!I.isEquality() || !match(&I, m_ICmp(Pred, m_Instruction(Val), m_Zero())))
1352     return nullptr;
1353 
1354   Value *X;
1355   Type *XTy;
1356 
1357   Constant *C;
1358   if (match(Val, m_TruncOrSelf(m_Shr(m_Value(X), m_Constant(C))))) {
1359     XTy = X->getType();
1360     unsigned XBitWidth = XTy->getScalarSizeInBits();
1361     if (!match(C, m_SpecificInt_ICMP(ICmpInst::Predicate::ICMP_EQ,
1362                                      APInt(XBitWidth, XBitWidth - 1))))
1363       return nullptr;
1364   } else if (isa<BinaryOperator>(Val) &&
1365              (X = reassociateShiftAmtsOfTwoSameDirectionShifts(
1366                   cast<BinaryOperator>(Val), SQ.getWithInstruction(Val),
1367                   /*AnalyzeForSignBitExtraction=*/true))) {
1368     XTy = X->getType();
1369   } else
1370     return nullptr;
1371 
1372   return ICmpInst::Create(Instruction::ICmp,
1373                           Pred == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_SGE
1374                                                     : ICmpInst::ICMP_SLT,
1375                           X, ConstantInt::getNullValue(XTy));
1376 }
1377 
1378 // Handle  icmp pred X, 0
1379 Instruction *InstCombinerImpl::foldICmpWithZero(ICmpInst &Cmp) {
1380   CmpInst::Predicate Pred = Cmp.getPredicate();
1381   if (!match(Cmp.getOperand(1), m_Zero()))
1382     return nullptr;
1383 
1384   // (icmp sgt smin(PosA, B) 0) -> (icmp sgt B 0)
1385   if (Pred == ICmpInst::ICMP_SGT) {
1386     Value *A, *B;
1387     SelectPatternResult SPR = matchSelectPattern(Cmp.getOperand(0), A, B);
1388     if (SPR.Flavor == SPF_SMIN) {
1389       if (isKnownPositive(A, DL, 0, &AC, &Cmp, &DT))
1390         return new ICmpInst(Pred, B, Cmp.getOperand(1));
1391       if (isKnownPositive(B, DL, 0, &AC, &Cmp, &DT))
1392         return new ICmpInst(Pred, A, Cmp.getOperand(1));
1393     }
1394   }
1395 
1396   if (Instruction *New = foldIRemByPowerOfTwoToBitTest(Cmp))
1397     return New;
1398 
1399   // Given:
1400   //   icmp eq/ne (urem %x, %y), 0
1401   // Iff %x has 0 or 1 bits set, and %y has at least 2 bits set, omit 'urem':
1402   //   icmp eq/ne %x, 0
1403   Value *X, *Y;
1404   if (match(Cmp.getOperand(0), m_URem(m_Value(X), m_Value(Y))) &&
1405       ICmpInst::isEquality(Pred)) {
1406     KnownBits XKnown = computeKnownBits(X, 0, &Cmp);
1407     KnownBits YKnown = computeKnownBits(Y, 0, &Cmp);
1408     if (XKnown.countMaxPopulation() == 1 && YKnown.countMinPopulation() >= 2)
1409       return new ICmpInst(Pred, X, Cmp.getOperand(1));
1410   }
1411 
1412   return nullptr;
1413 }
1414 
1415 /// Fold icmp Pred X, C.
1416 /// TODO: This code structure does not make sense. The saturating add fold
1417 /// should be moved to some other helper and extended as noted below (it is also
1418 /// possible that code has been made unnecessary - do we canonicalize IR to
1419 /// overflow/saturating intrinsics or not?).
1420 Instruction *InstCombinerImpl::foldICmpWithConstant(ICmpInst &Cmp) {
1421   // Match the following pattern, which is a common idiom when writing
1422   // overflow-safe integer arithmetic functions. The source performs an addition
1423   // in wider type and explicitly checks for overflow using comparisons against
1424   // INT_MIN and INT_MAX. Simplify by using the sadd_with_overflow intrinsic.
1425   //
1426   // TODO: This could probably be generalized to handle other overflow-safe
1427   // operations if we worked out the formulas to compute the appropriate magic
1428   // constants.
1429   //
1430   // sum = a + b
1431   // if (sum+128 >u 255)  ...  -> llvm.sadd.with.overflow.i8
1432   CmpInst::Predicate Pred = Cmp.getPredicate();
1433   Value *Op0 = Cmp.getOperand(0), *Op1 = Cmp.getOperand(1);
1434   Value *A, *B;
1435   ConstantInt *CI, *CI2; // I = icmp ugt (add (add A, B), CI2), CI
1436   if (Pred == ICmpInst::ICMP_UGT && match(Op1, m_ConstantInt(CI)) &&
1437       match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
1438     if (Instruction *Res = processUGT_ADDCST_ADD(Cmp, A, B, CI2, CI, *this))
1439       return Res;
1440 
1441   // icmp(phi(C1, C2, ...), C) -> phi(icmp(C1, C), icmp(C2, C), ...).
1442   Constant *C = dyn_cast<Constant>(Op1);
1443   if (!C || C->canTrap())
1444     return nullptr;
1445 
1446   if (auto *Phi = dyn_cast<PHINode>(Op0))
1447     if (all_of(Phi->operands(), [](Value *V) { return isa<Constant>(V); })) {
1448       Type *Ty = Cmp.getType();
1449       Builder.SetInsertPoint(Phi);
1450       PHINode *NewPhi =
1451           Builder.CreatePHI(Ty, Phi->getNumOperands());
1452       for (BasicBlock *Predecessor : predecessors(Phi->getParent())) {
1453         auto *Input =
1454             cast<Constant>(Phi->getIncomingValueForBlock(Predecessor));
1455         auto *BoolInput = ConstantExpr::getCompare(Pred, Input, C);
1456         NewPhi->addIncoming(BoolInput, Predecessor);
1457       }
1458       NewPhi->takeName(&Cmp);
1459       return replaceInstUsesWith(Cmp, NewPhi);
1460     }
1461 
1462   return nullptr;
1463 }
1464 
1465 /// Canonicalize icmp instructions based on dominating conditions.
1466 Instruction *InstCombinerImpl::foldICmpWithDominatingICmp(ICmpInst &Cmp) {
1467   // This is a cheap/incomplete check for dominance - just match a single
1468   // predecessor with a conditional branch.
1469   BasicBlock *CmpBB = Cmp.getParent();
1470   BasicBlock *DomBB = CmpBB->getSinglePredecessor();
1471   if (!DomBB)
1472     return nullptr;
1473 
1474   Value *DomCond;
1475   BasicBlock *TrueBB, *FalseBB;
1476   if (!match(DomBB->getTerminator(), m_Br(m_Value(DomCond), TrueBB, FalseBB)))
1477     return nullptr;
1478 
1479   assert((TrueBB == CmpBB || FalseBB == CmpBB) &&
1480          "Predecessor block does not point to successor?");
1481 
1482   // The branch should get simplified. Don't bother simplifying this condition.
1483   if (TrueBB == FalseBB)
1484     return nullptr;
1485 
1486   // Try to simplify this compare to T/F based on the dominating condition.
1487   Optional<bool> Imp = isImpliedCondition(DomCond, &Cmp, DL, TrueBB == CmpBB);
1488   if (Imp)
1489     return replaceInstUsesWith(Cmp, ConstantInt::get(Cmp.getType(), *Imp));
1490 
1491   CmpInst::Predicate Pred = Cmp.getPredicate();
1492   Value *X = Cmp.getOperand(0), *Y = Cmp.getOperand(1);
1493   ICmpInst::Predicate DomPred;
1494   const APInt *C, *DomC;
1495   if (match(DomCond, m_ICmp(DomPred, m_Specific(X), m_APInt(DomC))) &&
1496       match(Y, m_APInt(C))) {
1497     // We have 2 compares of a variable with constants. Calculate the constant
1498     // ranges of those compares to see if we can transform the 2nd compare:
1499     // DomBB:
1500     //   DomCond = icmp DomPred X, DomC
1501     //   br DomCond, CmpBB, FalseBB
1502     // CmpBB:
1503     //   Cmp = icmp Pred X, C
1504     ConstantRange CR = ConstantRange::makeExactICmpRegion(Pred, *C);
1505     ConstantRange DominatingCR =
1506         (CmpBB == TrueBB) ? ConstantRange::makeExactICmpRegion(DomPred, *DomC)
1507                           : ConstantRange::makeExactICmpRegion(
1508                                 CmpInst::getInversePredicate(DomPred), *DomC);
1509     ConstantRange Intersection = DominatingCR.intersectWith(CR);
1510     ConstantRange Difference = DominatingCR.difference(CR);
1511     if (Intersection.isEmptySet())
1512       return replaceInstUsesWith(Cmp, Builder.getFalse());
1513     if (Difference.isEmptySet())
1514       return replaceInstUsesWith(Cmp, Builder.getTrue());
1515 
1516     // Canonicalizing a sign bit comparison that gets used in a branch,
1517     // pessimizes codegen by generating branch on zero instruction instead
1518     // of a test and branch. So we avoid canonicalizing in such situations
1519     // because test and branch instruction has better branch displacement
1520     // than compare and branch instruction.
1521     bool UnusedBit;
1522     bool IsSignBit = isSignBitCheck(Pred, *C, UnusedBit);
1523     if (Cmp.isEquality() || (IsSignBit && hasBranchUse(Cmp)))
1524       return nullptr;
1525 
1526     // Avoid an infinite loop with min/max canonicalization.
1527     // TODO: This will be unnecessary if we canonicalize to min/max intrinsics.
1528     if (Cmp.hasOneUse() &&
1529         match(Cmp.user_back(), m_MaxOrMin(m_Value(), m_Value())))
1530       return nullptr;
1531 
1532     if (const APInt *EqC = Intersection.getSingleElement())
1533       return new ICmpInst(ICmpInst::ICMP_EQ, X, Builder.getInt(*EqC));
1534     if (const APInt *NeC = Difference.getSingleElement())
1535       return new ICmpInst(ICmpInst::ICMP_NE, X, Builder.getInt(*NeC));
1536   }
1537 
1538   return nullptr;
1539 }
1540 
1541 /// Fold icmp (trunc X, Y), C.
1542 Instruction *InstCombinerImpl::foldICmpTruncConstant(ICmpInst &Cmp,
1543                                                      TruncInst *Trunc,
1544                                                      const APInt &C) {
1545   ICmpInst::Predicate Pred = Cmp.getPredicate();
1546   Value *X = Trunc->getOperand(0);
1547   if (C.isOneValue() && C.getBitWidth() > 1) {
1548     // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1
1549     Value *V = nullptr;
1550     if (Pred == ICmpInst::ICMP_SLT && match(X, m_Signum(m_Value(V))))
1551       return new ICmpInst(ICmpInst::ICMP_SLT, V,
1552                           ConstantInt::get(V->getType(), 1));
1553   }
1554 
1555   unsigned DstBits = Trunc->getType()->getScalarSizeInBits(),
1556            SrcBits = X->getType()->getScalarSizeInBits();
1557   if (Cmp.isEquality() && Trunc->hasOneUse()) {
1558     // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1559     // of the high bits truncated out of x are known.
1560     KnownBits Known = computeKnownBits(X, 0, &Cmp);
1561 
1562     // If all the high bits are known, we can do this xform.
1563     if ((Known.Zero | Known.One).countLeadingOnes() >= SrcBits - DstBits) {
1564       // Pull in the high bits from known-ones set.
1565       APInt NewRHS = C.zext(SrcBits);
1566       NewRHS |= Known.One & APInt::getHighBitsSet(SrcBits, SrcBits - DstBits);
1567       return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), NewRHS));
1568     }
1569   }
1570 
1571   // Look through truncated right-shift of the sign-bit for a sign-bit check:
1572   // trunc iN (ShOp >> ShAmtC) to i[N - ShAmtC] < 0  --> ShOp <  0
1573   // trunc iN (ShOp >> ShAmtC) to i[N - ShAmtC] > -1 --> ShOp > -1
1574   Value *ShOp;
1575   const APInt *ShAmtC;
1576   bool TrueIfSigned;
1577   if (isSignBitCheck(Pred, C, TrueIfSigned) &&
1578       match(X, m_Shr(m_Value(ShOp), m_APInt(ShAmtC))) &&
1579       DstBits == SrcBits - ShAmtC->getZExtValue()) {
1580     return TrueIfSigned
1581                ? new ICmpInst(ICmpInst::ICMP_SLT, ShOp,
1582                               ConstantInt::getNullValue(X->getType()))
1583                : new ICmpInst(ICmpInst::ICMP_SGT, ShOp,
1584                               ConstantInt::getAllOnesValue(X->getType()));
1585   }
1586 
1587   return nullptr;
1588 }
1589 
1590 /// Fold icmp (xor X, Y), C.
1591 Instruction *InstCombinerImpl::foldICmpXorConstant(ICmpInst &Cmp,
1592                                                    BinaryOperator *Xor,
1593                                                    const APInt &C) {
1594   Value *X = Xor->getOperand(0);
1595   Value *Y = Xor->getOperand(1);
1596   const APInt *XorC;
1597   if (!match(Y, m_APInt(XorC)))
1598     return nullptr;
1599 
1600   // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1601   // fold the xor.
1602   ICmpInst::Predicate Pred = Cmp.getPredicate();
1603   bool TrueIfSigned = false;
1604   if (isSignBitCheck(Cmp.getPredicate(), C, TrueIfSigned)) {
1605 
1606     // If the sign bit of the XorCst is not set, there is no change to
1607     // the operation, just stop using the Xor.
1608     if (!XorC->isNegative())
1609       return replaceOperand(Cmp, 0, X);
1610 
1611     // Emit the opposite comparison.
1612     if (TrueIfSigned)
1613       return new ICmpInst(ICmpInst::ICMP_SGT, X,
1614                           ConstantInt::getAllOnesValue(X->getType()));
1615     else
1616       return new ICmpInst(ICmpInst::ICMP_SLT, X,
1617                           ConstantInt::getNullValue(X->getType()));
1618   }
1619 
1620   if (Xor->hasOneUse()) {
1621     // (icmp u/s (xor X SignMask), C) -> (icmp s/u X, (xor C SignMask))
1622     if (!Cmp.isEquality() && XorC->isSignMask()) {
1623       Pred = Cmp.getFlippedSignednessPredicate();
1624       return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), C ^ *XorC));
1625     }
1626 
1627     // (icmp u/s (xor X ~SignMask), C) -> (icmp s/u X, (xor C ~SignMask))
1628     if (!Cmp.isEquality() && XorC->isMaxSignedValue()) {
1629       Pred = Cmp.getFlippedSignednessPredicate();
1630       Pred = Cmp.getSwappedPredicate(Pred);
1631       return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), C ^ *XorC));
1632     }
1633   }
1634 
1635   // Mask constant magic can eliminate an 'xor' with unsigned compares.
1636   if (Pred == ICmpInst::ICMP_UGT) {
1637     // (xor X, ~C) >u C --> X <u ~C (when C+1 is a power of 2)
1638     if (*XorC == ~C && (C + 1).isPowerOf2())
1639       return new ICmpInst(ICmpInst::ICMP_ULT, X, Y);
1640     // (xor X, C) >u C --> X >u C (when C+1 is a power of 2)
1641     if (*XorC == C && (C + 1).isPowerOf2())
1642       return new ICmpInst(ICmpInst::ICMP_UGT, X, Y);
1643   }
1644   if (Pred == ICmpInst::ICMP_ULT) {
1645     // (xor X, -C) <u C --> X >u ~C (when C is a power of 2)
1646     if (*XorC == -C && C.isPowerOf2())
1647       return new ICmpInst(ICmpInst::ICMP_UGT, X,
1648                           ConstantInt::get(X->getType(), ~C));
1649     // (xor X, C) <u C --> X >u ~C (when -C is a power of 2)
1650     if (*XorC == C && (-C).isPowerOf2())
1651       return new ICmpInst(ICmpInst::ICMP_UGT, X,
1652                           ConstantInt::get(X->getType(), ~C));
1653   }
1654   return nullptr;
1655 }
1656 
1657 /// Fold icmp (and (sh X, Y), C2), C1.
1658 Instruction *InstCombinerImpl::foldICmpAndShift(ICmpInst &Cmp,
1659                                                 BinaryOperator *And,
1660                                                 const APInt &C1,
1661                                                 const APInt &C2) {
1662   BinaryOperator *Shift = dyn_cast<BinaryOperator>(And->getOperand(0));
1663   if (!Shift || !Shift->isShift())
1664     return nullptr;
1665 
1666   // If this is: (X >> C3) & C2 != C1 (where any shift and any compare could
1667   // exist), turn it into (X & (C2 << C3)) != (C1 << C3). This happens a LOT in
1668   // code produced by the clang front-end, for bitfield access.
1669   // This seemingly simple opportunity to fold away a shift turns out to be
1670   // rather complicated. See PR17827 for details.
1671   unsigned ShiftOpcode = Shift->getOpcode();
1672   bool IsShl = ShiftOpcode == Instruction::Shl;
1673   const APInt *C3;
1674   if (match(Shift->getOperand(1), m_APInt(C3))) {
1675     APInt NewAndCst, NewCmpCst;
1676     bool AnyCmpCstBitsShiftedOut;
1677     if (ShiftOpcode == Instruction::Shl) {
1678       // For a left shift, we can fold if the comparison is not signed. We can
1679       // also fold a signed comparison if the mask value and comparison value
1680       // are not negative. These constraints may not be obvious, but we can
1681       // prove that they are correct using an SMT solver.
1682       if (Cmp.isSigned() && (C2.isNegative() || C1.isNegative()))
1683         return nullptr;
1684 
1685       NewCmpCst = C1.lshr(*C3);
1686       NewAndCst = C2.lshr(*C3);
1687       AnyCmpCstBitsShiftedOut = NewCmpCst.shl(*C3) != C1;
1688     } else if (ShiftOpcode == Instruction::LShr) {
1689       // For a logical right shift, we can fold if the comparison is not signed.
1690       // We can also fold a signed comparison if the shifted mask value and the
1691       // shifted comparison value are not negative. These constraints may not be
1692       // obvious, but we can prove that they are correct using an SMT solver.
1693       NewCmpCst = C1.shl(*C3);
1694       NewAndCst = C2.shl(*C3);
1695       AnyCmpCstBitsShiftedOut = NewCmpCst.lshr(*C3) != C1;
1696       if (Cmp.isSigned() && (NewAndCst.isNegative() || NewCmpCst.isNegative()))
1697         return nullptr;
1698     } else {
1699       // For an arithmetic shift, check that both constants don't use (in a
1700       // signed sense) the top bits being shifted out.
1701       assert(ShiftOpcode == Instruction::AShr && "Unknown shift opcode");
1702       NewCmpCst = C1.shl(*C3);
1703       NewAndCst = C2.shl(*C3);
1704       AnyCmpCstBitsShiftedOut = NewCmpCst.ashr(*C3) != C1;
1705       if (NewAndCst.ashr(*C3) != C2)
1706         return nullptr;
1707     }
1708 
1709     if (AnyCmpCstBitsShiftedOut) {
1710       // If we shifted bits out, the fold is not going to work out. As a
1711       // special case, check to see if this means that the result is always
1712       // true or false now.
1713       if (Cmp.getPredicate() == ICmpInst::ICMP_EQ)
1714         return replaceInstUsesWith(Cmp, ConstantInt::getFalse(Cmp.getType()));
1715       if (Cmp.getPredicate() == ICmpInst::ICMP_NE)
1716         return replaceInstUsesWith(Cmp, ConstantInt::getTrue(Cmp.getType()));
1717     } else {
1718       Value *NewAnd = Builder.CreateAnd(
1719           Shift->getOperand(0), ConstantInt::get(And->getType(), NewAndCst));
1720       return new ICmpInst(Cmp.getPredicate(),
1721           NewAnd, ConstantInt::get(And->getType(), NewCmpCst));
1722     }
1723   }
1724 
1725   // Turn ((X >> Y) & C2) == 0  into  (X & (C2 << Y)) == 0.  The latter is
1726   // preferable because it allows the C2 << Y expression to be hoisted out of a
1727   // loop if Y is invariant and X is not.
1728   if (Shift->hasOneUse() && C1.isNullValue() && Cmp.isEquality() &&
1729       !Shift->isArithmeticShift() && !isa<Constant>(Shift->getOperand(0))) {
1730     // Compute C2 << Y.
1731     Value *NewShift =
1732         IsShl ? Builder.CreateLShr(And->getOperand(1), Shift->getOperand(1))
1733               : Builder.CreateShl(And->getOperand(1), Shift->getOperand(1));
1734 
1735     // Compute X & (C2 << Y).
1736     Value *NewAnd = Builder.CreateAnd(Shift->getOperand(0), NewShift);
1737     return replaceOperand(Cmp, 0, NewAnd);
1738   }
1739 
1740   return nullptr;
1741 }
1742 
1743 /// Fold icmp (and X, C2), C1.
1744 Instruction *InstCombinerImpl::foldICmpAndConstConst(ICmpInst &Cmp,
1745                                                      BinaryOperator *And,
1746                                                      const APInt &C1) {
1747   bool isICMP_NE = Cmp.getPredicate() == ICmpInst::ICMP_NE;
1748 
1749   // For vectors: icmp ne (and X, 1), 0 --> trunc X to N x i1
1750   // TODO: We canonicalize to the longer form for scalars because we have
1751   // better analysis/folds for icmp, and codegen may be better with icmp.
1752   if (isICMP_NE && Cmp.getType()->isVectorTy() && C1.isNullValue() &&
1753       match(And->getOperand(1), m_One()))
1754     return new TruncInst(And->getOperand(0), Cmp.getType());
1755 
1756   const APInt *C2;
1757   Value *X;
1758   if (!match(And, m_And(m_Value(X), m_APInt(C2))))
1759     return nullptr;
1760 
1761   // Don't perform the following transforms if the AND has multiple uses
1762   if (!And->hasOneUse())
1763     return nullptr;
1764 
1765   if (Cmp.isEquality() && C1.isNullValue()) {
1766     // Restrict this fold to single-use 'and' (PR10267).
1767     // Replace (and X, (1 << size(X)-1) != 0) with X s< 0
1768     if (C2->isSignMask()) {
1769       Constant *Zero = Constant::getNullValue(X->getType());
1770       auto NewPred = isICMP_NE ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1771       return new ICmpInst(NewPred, X, Zero);
1772     }
1773 
1774     // Restrict this fold only for single-use 'and' (PR10267).
1775     // ((%x & C) == 0) --> %x u< (-C)  iff (-C) is power of two.
1776     if ((~(*C2) + 1).isPowerOf2()) {
1777       Constant *NegBOC =
1778           ConstantExpr::getNeg(cast<Constant>(And->getOperand(1)));
1779       auto NewPred = isICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1780       return new ICmpInst(NewPred, X, NegBOC);
1781     }
1782   }
1783 
1784   // If the LHS is an 'and' of a truncate and we can widen the and/compare to
1785   // the input width without changing the value produced, eliminate the cast:
1786   //
1787   // icmp (and (trunc W), C2), C1 -> icmp (and W, C2'), C1'
1788   //
1789   // We can do this transformation if the constants do not have their sign bits
1790   // set or if it is an equality comparison. Extending a relational comparison
1791   // when we're checking the sign bit would not work.
1792   Value *W;
1793   if (match(And->getOperand(0), m_OneUse(m_Trunc(m_Value(W)))) &&
1794       (Cmp.isEquality() || (!C1.isNegative() && !C2->isNegative()))) {
1795     // TODO: Is this a good transform for vectors? Wider types may reduce
1796     // throughput. Should this transform be limited (even for scalars) by using
1797     // shouldChangeType()?
1798     if (!Cmp.getType()->isVectorTy()) {
1799       Type *WideType = W->getType();
1800       unsigned WideScalarBits = WideType->getScalarSizeInBits();
1801       Constant *ZextC1 = ConstantInt::get(WideType, C1.zext(WideScalarBits));
1802       Constant *ZextC2 = ConstantInt::get(WideType, C2->zext(WideScalarBits));
1803       Value *NewAnd = Builder.CreateAnd(W, ZextC2, And->getName());
1804       return new ICmpInst(Cmp.getPredicate(), NewAnd, ZextC1);
1805     }
1806   }
1807 
1808   if (Instruction *I = foldICmpAndShift(Cmp, And, C1, *C2))
1809     return I;
1810 
1811   // (icmp pred (and (or (lshr A, B), A), 1), 0) -->
1812   // (icmp pred (and A, (or (shl 1, B), 1), 0))
1813   //
1814   // iff pred isn't signed
1815   if (!Cmp.isSigned() && C1.isNullValue() && And->getOperand(0)->hasOneUse() &&
1816       match(And->getOperand(1), m_One())) {
1817     Constant *One = cast<Constant>(And->getOperand(1));
1818     Value *Or = And->getOperand(0);
1819     Value *A, *B, *LShr;
1820     if (match(Or, m_Or(m_Value(LShr), m_Value(A))) &&
1821         match(LShr, m_LShr(m_Specific(A), m_Value(B)))) {
1822       unsigned UsesRemoved = 0;
1823       if (And->hasOneUse())
1824         ++UsesRemoved;
1825       if (Or->hasOneUse())
1826         ++UsesRemoved;
1827       if (LShr->hasOneUse())
1828         ++UsesRemoved;
1829 
1830       // Compute A & ((1 << B) | 1)
1831       Value *NewOr = nullptr;
1832       if (auto *C = dyn_cast<Constant>(B)) {
1833         if (UsesRemoved >= 1)
1834           NewOr = ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1835       } else {
1836         if (UsesRemoved >= 3)
1837           NewOr = Builder.CreateOr(Builder.CreateShl(One, B, LShr->getName(),
1838                                                      /*HasNUW=*/true),
1839                                    One, Or->getName());
1840       }
1841       if (NewOr) {
1842         Value *NewAnd = Builder.CreateAnd(A, NewOr, And->getName());
1843         return replaceOperand(Cmp, 0, NewAnd);
1844       }
1845     }
1846   }
1847 
1848   return nullptr;
1849 }
1850 
1851 /// Fold icmp (and X, Y), C.
1852 Instruction *InstCombinerImpl::foldICmpAndConstant(ICmpInst &Cmp,
1853                                                    BinaryOperator *And,
1854                                                    const APInt &C) {
1855   if (Instruction *I = foldICmpAndConstConst(Cmp, And, C))
1856     return I;
1857 
1858   // TODO: These all require that Y is constant too, so refactor with the above.
1859 
1860   // Try to optimize things like "A[i] & 42 == 0" to index computations.
1861   Value *X = And->getOperand(0);
1862   Value *Y = And->getOperand(1);
1863   if (auto *LI = dyn_cast<LoadInst>(X))
1864     if (auto *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1865       if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1866         if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1867             !LI->isVolatile() && isa<ConstantInt>(Y)) {
1868           ConstantInt *C2 = cast<ConstantInt>(Y);
1869           if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, Cmp, C2))
1870             return Res;
1871         }
1872 
1873   if (!Cmp.isEquality())
1874     return nullptr;
1875 
1876   // X & -C == -C -> X >  u ~C
1877   // X & -C != -C -> X <= u ~C
1878   //   iff C is a power of 2
1879   if (Cmp.getOperand(1) == Y && (-C).isPowerOf2()) {
1880     auto NewPred = Cmp.getPredicate() == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGT
1881                                                           : CmpInst::ICMP_ULE;
1882     return new ICmpInst(NewPred, X, SubOne(cast<Constant>(Cmp.getOperand(1))));
1883   }
1884 
1885   // (X & C2) == 0 -> (trunc X) >= 0
1886   // (X & C2) != 0 -> (trunc X) <  0
1887   //   iff C2 is a power of 2 and it masks the sign bit of a legal integer type.
1888   const APInt *C2;
1889   if (And->hasOneUse() && C.isNullValue() && match(Y, m_APInt(C2))) {
1890     int32_t ExactLogBase2 = C2->exactLogBase2();
1891     if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1892       Type *NTy = IntegerType::get(Cmp.getContext(), ExactLogBase2 + 1);
1893       if (auto *AndVTy = dyn_cast<VectorType>(And->getType()))
1894         NTy = VectorType::get(NTy, AndVTy->getElementCount());
1895       Value *Trunc = Builder.CreateTrunc(X, NTy);
1896       auto NewPred = Cmp.getPredicate() == CmpInst::ICMP_EQ ? CmpInst::ICMP_SGE
1897                                                             : CmpInst::ICMP_SLT;
1898       return new ICmpInst(NewPred, Trunc, Constant::getNullValue(NTy));
1899     }
1900   }
1901 
1902   return nullptr;
1903 }
1904 
1905 /// Fold icmp (or X, Y), C.
1906 Instruction *InstCombinerImpl::foldICmpOrConstant(ICmpInst &Cmp,
1907                                                   BinaryOperator *Or,
1908                                                   const APInt &C) {
1909   ICmpInst::Predicate Pred = Cmp.getPredicate();
1910   if (C.isOneValue()) {
1911     // icmp slt signum(V) 1 --> icmp slt V, 1
1912     Value *V = nullptr;
1913     if (Pred == ICmpInst::ICMP_SLT && match(Or, m_Signum(m_Value(V))))
1914       return new ICmpInst(ICmpInst::ICMP_SLT, V,
1915                           ConstantInt::get(V->getType(), 1));
1916   }
1917 
1918   Value *OrOp0 = Or->getOperand(0), *OrOp1 = Or->getOperand(1);
1919   const APInt *MaskC;
1920   if (match(OrOp1, m_APInt(MaskC)) && Cmp.isEquality()) {
1921     if (*MaskC == C && (C + 1).isPowerOf2()) {
1922       // X | C == C --> X <=u C
1923       // X | C != C --> X  >u C
1924       //   iff C+1 is a power of 2 (C is a bitmask of the low bits)
1925       Pred = (Pred == CmpInst::ICMP_EQ) ? CmpInst::ICMP_ULE : CmpInst::ICMP_UGT;
1926       return new ICmpInst(Pred, OrOp0, OrOp1);
1927     }
1928 
1929     // More general: canonicalize 'equality with set bits mask' to
1930     // 'equality with clear bits mask'.
1931     // (X | MaskC) == C --> (X & ~MaskC) == C ^ MaskC
1932     // (X | MaskC) != C --> (X & ~MaskC) != C ^ MaskC
1933     if (Or->hasOneUse()) {
1934       Value *And = Builder.CreateAnd(OrOp0, ~(*MaskC));
1935       Constant *NewC = ConstantInt::get(Or->getType(), C ^ (*MaskC));
1936       return new ICmpInst(Pred, And, NewC);
1937     }
1938   }
1939 
1940   if (!Cmp.isEquality() || !C.isNullValue() || !Or->hasOneUse())
1941     return nullptr;
1942 
1943   Value *P, *Q;
1944   if (match(Or, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1945     // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1946     // -> and (icmp eq P, null), (icmp eq Q, null).
1947     Value *CmpP =
1948         Builder.CreateICmp(Pred, P, ConstantInt::getNullValue(P->getType()));
1949     Value *CmpQ =
1950         Builder.CreateICmp(Pred, Q, ConstantInt::getNullValue(Q->getType()));
1951     auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1952     return BinaryOperator::Create(BOpc, CmpP, CmpQ);
1953   }
1954 
1955   // Are we using xors to bitwise check for a pair of (in)equalities? Convert to
1956   // a shorter form that has more potential to be folded even further.
1957   Value *X1, *X2, *X3, *X4;
1958   if (match(OrOp0, m_OneUse(m_Xor(m_Value(X1), m_Value(X2)))) &&
1959       match(OrOp1, m_OneUse(m_Xor(m_Value(X3), m_Value(X4))))) {
1960     // ((X1 ^ X2) || (X3 ^ X4)) == 0 --> (X1 == X2) && (X3 == X4)
1961     // ((X1 ^ X2) || (X3 ^ X4)) != 0 --> (X1 != X2) || (X3 != X4)
1962     Value *Cmp12 = Builder.CreateICmp(Pred, X1, X2);
1963     Value *Cmp34 = Builder.CreateICmp(Pred, X3, X4);
1964     auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1965     return BinaryOperator::Create(BOpc, Cmp12, Cmp34);
1966   }
1967 
1968   return nullptr;
1969 }
1970 
1971 /// Fold icmp (mul X, Y), C.
1972 Instruction *InstCombinerImpl::foldICmpMulConstant(ICmpInst &Cmp,
1973                                                    BinaryOperator *Mul,
1974                                                    const APInt &C) {
1975   const APInt *MulC;
1976   if (!match(Mul->getOperand(1), m_APInt(MulC)))
1977     return nullptr;
1978 
1979   // If this is a test of the sign bit and the multiply is sign-preserving with
1980   // a constant operand, use the multiply LHS operand instead.
1981   ICmpInst::Predicate Pred = Cmp.getPredicate();
1982   if (isSignTest(Pred, C) && Mul->hasNoSignedWrap()) {
1983     if (MulC->isNegative())
1984       Pred = ICmpInst::getSwappedPredicate(Pred);
1985     return new ICmpInst(Pred, Mul->getOperand(0),
1986                         Constant::getNullValue(Mul->getType()));
1987   }
1988 
1989   // If the multiply does not wrap, try to divide the compare constant by the
1990   // multiplication factor.
1991   if (Cmp.isEquality() && !MulC->isNullValue()) {
1992     // (mul nsw X, MulC) == C --> X == C /s MulC
1993     if (Mul->hasNoSignedWrap() && C.srem(*MulC).isNullValue()) {
1994       Constant *NewC = ConstantInt::get(Mul->getType(), C.sdiv(*MulC));
1995       return new ICmpInst(Pred, Mul->getOperand(0), NewC);
1996     }
1997     // (mul nuw X, MulC) == C --> X == C /u MulC
1998     if (Mul->hasNoUnsignedWrap() && C.urem(*MulC).isNullValue()) {
1999       Constant *NewC = ConstantInt::get(Mul->getType(), C.udiv(*MulC));
2000       return new ICmpInst(Pred, Mul->getOperand(0), NewC);
2001     }
2002   }
2003 
2004   return nullptr;
2005 }
2006 
2007 /// Fold icmp (shl 1, Y), C.
2008 static Instruction *foldICmpShlOne(ICmpInst &Cmp, Instruction *Shl,
2009                                    const APInt &C) {
2010   Value *Y;
2011   if (!match(Shl, m_Shl(m_One(), m_Value(Y))))
2012     return nullptr;
2013 
2014   Type *ShiftType = Shl->getType();
2015   unsigned TypeBits = C.getBitWidth();
2016   bool CIsPowerOf2 = C.isPowerOf2();
2017   ICmpInst::Predicate Pred = Cmp.getPredicate();
2018   if (Cmp.isUnsigned()) {
2019     // (1 << Y) pred C -> Y pred Log2(C)
2020     if (!CIsPowerOf2) {
2021       // (1 << Y) <  30 -> Y <= 4
2022       // (1 << Y) <= 30 -> Y <= 4
2023       // (1 << Y) >= 30 -> Y >  4
2024       // (1 << Y) >  30 -> Y >  4
2025       if (Pred == ICmpInst::ICMP_ULT)
2026         Pred = ICmpInst::ICMP_ULE;
2027       else if (Pred == ICmpInst::ICMP_UGE)
2028         Pred = ICmpInst::ICMP_UGT;
2029     }
2030 
2031     // (1 << Y) >= 2147483648 -> Y >= 31 -> Y == 31
2032     // (1 << Y) <  2147483648 -> Y <  31 -> Y != 31
2033     unsigned CLog2 = C.logBase2();
2034     if (CLog2 == TypeBits - 1) {
2035       if (Pred == ICmpInst::ICMP_UGE)
2036         Pred = ICmpInst::ICMP_EQ;
2037       else if (Pred == ICmpInst::ICMP_ULT)
2038         Pred = ICmpInst::ICMP_NE;
2039     }
2040     return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, CLog2));
2041   } else if (Cmp.isSigned()) {
2042     Constant *BitWidthMinusOne = ConstantInt::get(ShiftType, TypeBits - 1);
2043     if (C.isAllOnesValue()) {
2044       // (1 << Y) <= -1 -> Y == 31
2045       if (Pred == ICmpInst::ICMP_SLE)
2046         return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
2047 
2048       // (1 << Y) >  -1 -> Y != 31
2049       if (Pred == ICmpInst::ICMP_SGT)
2050         return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
2051     } else if (!C) {
2052       // (1 << Y) <  0 -> Y == 31
2053       // (1 << Y) <= 0 -> Y == 31
2054       if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
2055         return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
2056 
2057       // (1 << Y) >= 0 -> Y != 31
2058       // (1 << Y) >  0 -> Y != 31
2059       if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
2060         return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
2061     }
2062   } else if (Cmp.isEquality() && CIsPowerOf2) {
2063     return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, C.logBase2()));
2064   }
2065 
2066   return nullptr;
2067 }
2068 
2069 /// Fold icmp (shl X, Y), C.
2070 Instruction *InstCombinerImpl::foldICmpShlConstant(ICmpInst &Cmp,
2071                                                    BinaryOperator *Shl,
2072                                                    const APInt &C) {
2073   const APInt *ShiftVal;
2074   if (Cmp.isEquality() && match(Shl->getOperand(0), m_APInt(ShiftVal)))
2075     return foldICmpShlConstConst(Cmp, Shl->getOperand(1), C, *ShiftVal);
2076 
2077   const APInt *ShiftAmt;
2078   if (!match(Shl->getOperand(1), m_APInt(ShiftAmt)))
2079     return foldICmpShlOne(Cmp, Shl, C);
2080 
2081   // Check that the shift amount is in range. If not, don't perform undefined
2082   // shifts. When the shift is visited, it will be simplified.
2083   unsigned TypeBits = C.getBitWidth();
2084   if (ShiftAmt->uge(TypeBits))
2085     return nullptr;
2086 
2087   ICmpInst::Predicate Pred = Cmp.getPredicate();
2088   Value *X = Shl->getOperand(0);
2089   Type *ShType = Shl->getType();
2090 
2091   // NSW guarantees that we are only shifting out sign bits from the high bits,
2092   // so we can ASHR the compare constant without needing a mask and eliminate
2093   // the shift.
2094   if (Shl->hasNoSignedWrap()) {
2095     if (Pred == ICmpInst::ICMP_SGT) {
2096       // icmp Pred (shl nsw X, ShiftAmt), C --> icmp Pred X, (C >>s ShiftAmt)
2097       APInt ShiftedC = C.ashr(*ShiftAmt);
2098       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2099     }
2100     if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
2101         C.ashr(*ShiftAmt).shl(*ShiftAmt) == C) {
2102       APInt ShiftedC = C.ashr(*ShiftAmt);
2103       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2104     }
2105     if (Pred == ICmpInst::ICMP_SLT) {
2106       // SLE is the same as above, but SLE is canonicalized to SLT, so convert:
2107       // (X << S) <=s C is equiv to X <=s (C >> S) for all C
2108       // (X << S) <s (C + 1) is equiv to X <s (C >> S) + 1 if C <s SMAX
2109       // (X << S) <s C is equiv to X <s ((C - 1) >> S) + 1 if C >s SMIN
2110       assert(!C.isMinSignedValue() && "Unexpected icmp slt");
2111       APInt ShiftedC = (C - 1).ashr(*ShiftAmt) + 1;
2112       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2113     }
2114     // If this is a signed comparison to 0 and the shift is sign preserving,
2115     // use the shift LHS operand instead; isSignTest may change 'Pred', so only
2116     // do that if we're sure to not continue on in this function.
2117     if (isSignTest(Pred, C))
2118       return new ICmpInst(Pred, X, Constant::getNullValue(ShType));
2119   }
2120 
2121   // NUW guarantees that we are only shifting out zero bits from the high bits,
2122   // so we can LSHR the compare constant without needing a mask and eliminate
2123   // the shift.
2124   if (Shl->hasNoUnsignedWrap()) {
2125     if (Pred == ICmpInst::ICMP_UGT) {
2126       // icmp Pred (shl nuw X, ShiftAmt), C --> icmp Pred X, (C >>u ShiftAmt)
2127       APInt ShiftedC = C.lshr(*ShiftAmt);
2128       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2129     }
2130     if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
2131         C.lshr(*ShiftAmt).shl(*ShiftAmt) == C) {
2132       APInt ShiftedC = C.lshr(*ShiftAmt);
2133       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2134     }
2135     if (Pred == ICmpInst::ICMP_ULT) {
2136       // ULE is the same as above, but ULE is canonicalized to ULT, so convert:
2137       // (X << S) <=u C is equiv to X <=u (C >> S) for all C
2138       // (X << S) <u (C + 1) is equiv to X <u (C >> S) + 1 if C <u ~0u
2139       // (X << S) <u C is equiv to X <u ((C - 1) >> S) + 1 if C >u 0
2140       assert(C.ugt(0) && "ult 0 should have been eliminated");
2141       APInt ShiftedC = (C - 1).lshr(*ShiftAmt) + 1;
2142       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2143     }
2144   }
2145 
2146   if (Cmp.isEquality() && Shl->hasOneUse()) {
2147     // Strength-reduce the shift into an 'and'.
2148     Constant *Mask = ConstantInt::get(
2149         ShType,
2150         APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt->getZExtValue()));
2151     Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask");
2152     Constant *LShrC = ConstantInt::get(ShType, C.lshr(*ShiftAmt));
2153     return new ICmpInst(Pred, And, LShrC);
2154   }
2155 
2156   // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
2157   bool TrueIfSigned = false;
2158   if (Shl->hasOneUse() && isSignBitCheck(Pred, C, TrueIfSigned)) {
2159     // (X << 31) <s 0  --> (X & 1) != 0
2160     Constant *Mask = ConstantInt::get(
2161         ShType,
2162         APInt::getOneBitSet(TypeBits, TypeBits - ShiftAmt->getZExtValue() - 1));
2163     Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask");
2164     return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
2165                         And, Constant::getNullValue(ShType));
2166   }
2167 
2168   // Simplify 'shl' inequality test into 'and' equality test.
2169   if (Cmp.isUnsigned() && Shl->hasOneUse()) {
2170     // (X l<< C2) u<=/u> C1 iff C1+1 is power of two -> X & (~C1 l>> C2) ==/!= 0
2171     if ((C + 1).isPowerOf2() &&
2172         (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_UGT)) {
2173       Value *And = Builder.CreateAnd(X, (~C).lshr(ShiftAmt->getZExtValue()));
2174       return new ICmpInst(Pred == ICmpInst::ICMP_ULE ? ICmpInst::ICMP_EQ
2175                                                      : ICmpInst::ICMP_NE,
2176                           And, Constant::getNullValue(ShType));
2177     }
2178     // (X l<< C2) u</u>= C1 iff C1 is power of two -> X & (-C1 l>> C2) ==/!= 0
2179     if (C.isPowerOf2() &&
2180         (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE)) {
2181       Value *And =
2182           Builder.CreateAnd(X, (~(C - 1)).lshr(ShiftAmt->getZExtValue()));
2183       return new ICmpInst(Pred == ICmpInst::ICMP_ULT ? ICmpInst::ICMP_EQ
2184                                                      : ICmpInst::ICMP_NE,
2185                           And, Constant::getNullValue(ShType));
2186     }
2187   }
2188 
2189   // Transform (icmp pred iM (shl iM %v, N), C)
2190   // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (C>>N))
2191   // Transform the shl to a trunc if (trunc (C>>N)) has no loss and M-N.
2192   // This enables us to get rid of the shift in favor of a trunc that may be
2193   // free on the target. It has the additional benefit of comparing to a
2194   // smaller constant that may be more target-friendly.
2195   unsigned Amt = ShiftAmt->getLimitedValue(TypeBits - 1);
2196   if (Shl->hasOneUse() && Amt != 0 && C.countTrailingZeros() >= Amt &&
2197       DL.isLegalInteger(TypeBits - Amt)) {
2198     Type *TruncTy = IntegerType::get(Cmp.getContext(), TypeBits - Amt);
2199     if (auto *ShVTy = dyn_cast<VectorType>(ShType))
2200       TruncTy = VectorType::get(TruncTy, ShVTy->getElementCount());
2201     Constant *NewC =
2202         ConstantInt::get(TruncTy, C.ashr(*ShiftAmt).trunc(TypeBits - Amt));
2203     return new ICmpInst(Pred, Builder.CreateTrunc(X, TruncTy), NewC);
2204   }
2205 
2206   return nullptr;
2207 }
2208 
2209 /// Fold icmp ({al}shr X, Y), C.
2210 Instruction *InstCombinerImpl::foldICmpShrConstant(ICmpInst &Cmp,
2211                                                    BinaryOperator *Shr,
2212                                                    const APInt &C) {
2213   // An exact shr only shifts out zero bits, so:
2214   // icmp eq/ne (shr X, Y), 0 --> icmp eq/ne X, 0
2215   Value *X = Shr->getOperand(0);
2216   CmpInst::Predicate Pred = Cmp.getPredicate();
2217   if (Cmp.isEquality() && Shr->isExact() && Shr->hasOneUse() &&
2218       C.isNullValue())
2219     return new ICmpInst(Pred, X, Cmp.getOperand(1));
2220 
2221   const APInt *ShiftVal;
2222   if (Cmp.isEquality() && match(Shr->getOperand(0), m_APInt(ShiftVal)))
2223     return foldICmpShrConstConst(Cmp, Shr->getOperand(1), C, *ShiftVal);
2224 
2225   const APInt *ShiftAmt;
2226   if (!match(Shr->getOperand(1), m_APInt(ShiftAmt)))
2227     return nullptr;
2228 
2229   // Check that the shift amount is in range. If not, don't perform undefined
2230   // shifts. When the shift is visited it will be simplified.
2231   unsigned TypeBits = C.getBitWidth();
2232   unsigned ShAmtVal = ShiftAmt->getLimitedValue(TypeBits);
2233   if (ShAmtVal >= TypeBits || ShAmtVal == 0)
2234     return nullptr;
2235 
2236   bool IsAShr = Shr->getOpcode() == Instruction::AShr;
2237   bool IsExact = Shr->isExact();
2238   Type *ShrTy = Shr->getType();
2239   // TODO: If we could guarantee that InstSimplify would handle all of the
2240   // constant-value-based preconditions in the folds below, then we could assert
2241   // those conditions rather than checking them. This is difficult because of
2242   // undef/poison (PR34838).
2243   if (IsAShr) {
2244     if (Pred == CmpInst::ICMP_SLT || (Pred == CmpInst::ICMP_SGT && IsExact)) {
2245       // icmp slt (ashr X, ShAmtC), C --> icmp slt X, (C << ShAmtC)
2246       // icmp sgt (ashr exact X, ShAmtC), C --> icmp sgt X, (C << ShAmtC)
2247       APInt ShiftedC = C.shl(ShAmtVal);
2248       if (ShiftedC.ashr(ShAmtVal) == C)
2249         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2250     }
2251     if (Pred == CmpInst::ICMP_SGT) {
2252       // icmp sgt (ashr X, ShAmtC), C --> icmp sgt X, ((C + 1) << ShAmtC) - 1
2253       APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1;
2254       if (!C.isMaxSignedValue() && !(C + 1).shl(ShAmtVal).isMinSignedValue() &&
2255           (ShiftedC + 1).ashr(ShAmtVal) == (C + 1))
2256         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2257     }
2258 
2259     // If the compare constant has significant bits above the lowest sign-bit,
2260     // then convert an unsigned cmp to a test of the sign-bit:
2261     // (ashr X, ShiftC) u> C --> X s< 0
2262     // (ashr X, ShiftC) u< C --> X s> -1
2263     if (C.getBitWidth() > 2 && C.getNumSignBits() <= ShAmtVal) {
2264       if (Pred == CmpInst::ICMP_UGT) {
2265         return new ICmpInst(CmpInst::ICMP_SLT, X,
2266                             ConstantInt::getNullValue(ShrTy));
2267       }
2268       if (Pred == CmpInst::ICMP_ULT) {
2269         return new ICmpInst(CmpInst::ICMP_SGT, X,
2270                             ConstantInt::getAllOnesValue(ShrTy));
2271       }
2272     }
2273   } else {
2274     if (Pred == CmpInst::ICMP_ULT || (Pred == CmpInst::ICMP_UGT && IsExact)) {
2275       // icmp ult (lshr X, ShAmtC), C --> icmp ult X, (C << ShAmtC)
2276       // icmp ugt (lshr exact X, ShAmtC), C --> icmp ugt X, (C << ShAmtC)
2277       APInt ShiftedC = C.shl(ShAmtVal);
2278       if (ShiftedC.lshr(ShAmtVal) == C)
2279         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2280     }
2281     if (Pred == CmpInst::ICMP_UGT) {
2282       // icmp ugt (lshr X, ShAmtC), C --> icmp ugt X, ((C + 1) << ShAmtC) - 1
2283       APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1;
2284       if ((ShiftedC + 1).lshr(ShAmtVal) == (C + 1))
2285         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2286     }
2287   }
2288 
2289   if (!Cmp.isEquality())
2290     return nullptr;
2291 
2292   // Handle equality comparisons of shift-by-constant.
2293 
2294   // If the comparison constant changes with the shift, the comparison cannot
2295   // succeed (bits of the comparison constant cannot match the shifted value).
2296   // This should be known by InstSimplify and already be folded to true/false.
2297   assert(((IsAShr && C.shl(ShAmtVal).ashr(ShAmtVal) == C) ||
2298           (!IsAShr && C.shl(ShAmtVal).lshr(ShAmtVal) == C)) &&
2299          "Expected icmp+shr simplify did not occur.");
2300 
2301   // If the bits shifted out are known zero, compare the unshifted value:
2302   //  (X & 4) >> 1 == 2  --> (X & 4) == 4.
2303   if (Shr->isExact())
2304     return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, C << ShAmtVal));
2305 
2306   if (C.isNullValue()) {
2307     // == 0 is u< 1.
2308     if (Pred == CmpInst::ICMP_EQ)
2309       return new ICmpInst(CmpInst::ICMP_ULT, X,
2310                           ConstantInt::get(ShrTy, (C + 1).shl(ShAmtVal)));
2311     else
2312       return new ICmpInst(CmpInst::ICMP_UGT, X,
2313                           ConstantInt::get(ShrTy, (C + 1).shl(ShAmtVal) - 1));
2314   }
2315 
2316   if (Shr->hasOneUse()) {
2317     // Canonicalize the shift into an 'and':
2318     // icmp eq/ne (shr X, ShAmt), C --> icmp eq/ne (and X, HiMask), (C << ShAmt)
2319     APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
2320     Constant *Mask = ConstantInt::get(ShrTy, Val);
2321     Value *And = Builder.CreateAnd(X, Mask, Shr->getName() + ".mask");
2322     return new ICmpInst(Pred, And, ConstantInt::get(ShrTy, C << ShAmtVal));
2323   }
2324 
2325   return nullptr;
2326 }
2327 
2328 Instruction *InstCombinerImpl::foldICmpSRemConstant(ICmpInst &Cmp,
2329                                                     BinaryOperator *SRem,
2330                                                     const APInt &C) {
2331   // Match an 'is positive' or 'is negative' comparison of remainder by a
2332   // constant power-of-2 value:
2333   // (X % pow2C) sgt/slt 0
2334   const ICmpInst::Predicate Pred = Cmp.getPredicate();
2335   if (Pred != ICmpInst::ICMP_SGT && Pred != ICmpInst::ICMP_SLT)
2336     return nullptr;
2337 
2338   // TODO: The one-use check is standard because we do not typically want to
2339   //       create longer instruction sequences, but this might be a special-case
2340   //       because srem is not good for analysis or codegen.
2341   if (!SRem->hasOneUse())
2342     return nullptr;
2343 
2344   const APInt *DivisorC;
2345   if (!C.isNullValue() || !match(SRem->getOperand(1), m_Power2(DivisorC)))
2346     return nullptr;
2347 
2348   // Mask off the sign bit and the modulo bits (low-bits).
2349   Type *Ty = SRem->getType();
2350   APInt SignMask = APInt::getSignMask(Ty->getScalarSizeInBits());
2351   Constant *MaskC = ConstantInt::get(Ty, SignMask | (*DivisorC - 1));
2352   Value *And = Builder.CreateAnd(SRem->getOperand(0), MaskC);
2353 
2354   // For 'is positive?' check that the sign-bit is clear and at least 1 masked
2355   // bit is set. Example:
2356   // (i8 X % 32) s> 0 --> (X & 159) s> 0
2357   if (Pred == ICmpInst::ICMP_SGT)
2358     return new ICmpInst(ICmpInst::ICMP_SGT, And, ConstantInt::getNullValue(Ty));
2359 
2360   // For 'is negative?' check that the sign-bit is set and at least 1 masked
2361   // bit is set. Example:
2362   // (i16 X % 4) s< 0 --> (X & 32771) u> 32768
2363   return new ICmpInst(ICmpInst::ICMP_UGT, And, ConstantInt::get(Ty, SignMask));
2364 }
2365 
2366 /// Fold icmp (udiv X, Y), C.
2367 Instruction *InstCombinerImpl::foldICmpUDivConstant(ICmpInst &Cmp,
2368                                                     BinaryOperator *UDiv,
2369                                                     const APInt &C) {
2370   const APInt *C2;
2371   if (!match(UDiv->getOperand(0), m_APInt(C2)))
2372     return nullptr;
2373 
2374   assert(*C2 != 0 && "udiv 0, X should have been simplified already.");
2375 
2376   // (icmp ugt (udiv C2, Y), C) -> (icmp ule Y, C2/(C+1))
2377   Value *Y = UDiv->getOperand(1);
2378   if (Cmp.getPredicate() == ICmpInst::ICMP_UGT) {
2379     assert(!C.isMaxValue() &&
2380            "icmp ugt X, UINT_MAX should have been simplified already.");
2381     return new ICmpInst(ICmpInst::ICMP_ULE, Y,
2382                         ConstantInt::get(Y->getType(), C2->udiv(C + 1)));
2383   }
2384 
2385   // (icmp ult (udiv C2, Y), C) -> (icmp ugt Y, C2/C)
2386   if (Cmp.getPredicate() == ICmpInst::ICMP_ULT) {
2387     assert(C != 0 && "icmp ult X, 0 should have been simplified already.");
2388     return new ICmpInst(ICmpInst::ICMP_UGT, Y,
2389                         ConstantInt::get(Y->getType(), C2->udiv(C)));
2390   }
2391 
2392   return nullptr;
2393 }
2394 
2395 /// Fold icmp ({su}div X, Y), C.
2396 Instruction *InstCombinerImpl::foldICmpDivConstant(ICmpInst &Cmp,
2397                                                    BinaryOperator *Div,
2398                                                    const APInt &C) {
2399   // Fold: icmp pred ([us]div X, C2), C -> range test
2400   // Fold this div into the comparison, producing a range check.
2401   // Determine, based on the divide type, what the range is being
2402   // checked.  If there is an overflow on the low or high side, remember
2403   // it, otherwise compute the range [low, hi) bounding the new value.
2404   // See: InsertRangeTest above for the kinds of replacements possible.
2405   const APInt *C2;
2406   if (!match(Div->getOperand(1), m_APInt(C2)))
2407     return nullptr;
2408 
2409   // FIXME: If the operand types don't match the type of the divide
2410   // then don't attempt this transform. The code below doesn't have the
2411   // logic to deal with a signed divide and an unsigned compare (and
2412   // vice versa). This is because (x /s C2) <s C  produces different
2413   // results than (x /s C2) <u C or (x /u C2) <s C or even
2414   // (x /u C2) <u C.  Simply casting the operands and result won't
2415   // work. :(  The if statement below tests that condition and bails
2416   // if it finds it.
2417   bool DivIsSigned = Div->getOpcode() == Instruction::SDiv;
2418   if (!Cmp.isEquality() && DivIsSigned != Cmp.isSigned())
2419     return nullptr;
2420 
2421   // The ProdOV computation fails on divide by 0 and divide by -1. Cases with
2422   // INT_MIN will also fail if the divisor is 1. Although folds of all these
2423   // division-by-constant cases should be present, we can not assert that they
2424   // have happened before we reach this icmp instruction.
2425   if (C2->isNullValue() || C2->isOneValue() ||
2426       (DivIsSigned && C2->isAllOnesValue()))
2427     return nullptr;
2428 
2429   // Compute Prod = C * C2. We are essentially solving an equation of
2430   // form X / C2 = C. We solve for X by multiplying C2 and C.
2431   // By solving for X, we can turn this into a range check instead of computing
2432   // a divide.
2433   APInt Prod = C * *C2;
2434 
2435   // Determine if the product overflows by seeing if the product is not equal to
2436   // the divide. Make sure we do the same kind of divide as in the LHS
2437   // instruction that we're folding.
2438   bool ProdOV = (DivIsSigned ? Prod.sdiv(*C2) : Prod.udiv(*C2)) != C;
2439 
2440   ICmpInst::Predicate Pred = Cmp.getPredicate();
2441 
2442   // If the division is known to be exact, then there is no remainder from the
2443   // divide, so the covered range size is unit, otherwise it is the divisor.
2444   APInt RangeSize = Div->isExact() ? APInt(C2->getBitWidth(), 1) : *C2;
2445 
2446   // Figure out the interval that is being checked.  For example, a comparison
2447   // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
2448   // Compute this interval based on the constants involved and the signedness of
2449   // the compare/divide.  This computes a half-open interval, keeping track of
2450   // whether either value in the interval overflows.  After analysis each
2451   // overflow variable is set to 0 if it's corresponding bound variable is valid
2452   // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
2453   int LoOverflow = 0, HiOverflow = 0;
2454   APInt LoBound, HiBound;
2455 
2456   if (!DivIsSigned) {  // udiv
2457     // e.g. X/5 op 3  --> [15, 20)
2458     LoBound = Prod;
2459     HiOverflow = LoOverflow = ProdOV;
2460     if (!HiOverflow) {
2461       // If this is not an exact divide, then many values in the range collapse
2462       // to the same result value.
2463       HiOverflow = addWithOverflow(HiBound, LoBound, RangeSize, false);
2464     }
2465   } else if (C2->isStrictlyPositive()) { // Divisor is > 0.
2466     if (C.isNullValue()) {       // (X / pos) op 0
2467       // Can't overflow.  e.g.  X/2 op 0 --> [-1, 2)
2468       LoBound = -(RangeSize - 1);
2469       HiBound = RangeSize;
2470     } else if (C.isStrictlyPositive()) {   // (X / pos) op pos
2471       LoBound = Prod;     // e.g.   X/5 op 3 --> [15, 20)
2472       HiOverflow = LoOverflow = ProdOV;
2473       if (!HiOverflow)
2474         HiOverflow = addWithOverflow(HiBound, Prod, RangeSize, true);
2475     } else {                       // (X / pos) op neg
2476       // e.g. X/5 op -3  --> [-15-4, -15+1) --> [-19, -14)
2477       HiBound = Prod + 1;
2478       LoOverflow = HiOverflow = ProdOV ? -1 : 0;
2479       if (!LoOverflow) {
2480         APInt DivNeg = -RangeSize;
2481         LoOverflow = addWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
2482       }
2483     }
2484   } else if (C2->isNegative()) { // Divisor is < 0.
2485     if (Div->isExact())
2486       RangeSize.negate();
2487     if (C.isNullValue()) { // (X / neg) op 0
2488       // e.g. X/-5 op 0  --> [-4, 5)
2489       LoBound = RangeSize + 1;
2490       HiBound = -RangeSize;
2491       if (HiBound == *C2) {        // -INTMIN = INTMIN
2492         HiOverflow = 1;            // [INTMIN+1, overflow)
2493         HiBound = APInt();         // e.g. X/INTMIN = 0 --> X > INTMIN
2494       }
2495     } else if (C.isStrictlyPositive()) {   // (X / neg) op pos
2496       // e.g. X/-5 op 3  --> [-19, -14)
2497       HiBound = Prod + 1;
2498       HiOverflow = LoOverflow = ProdOV ? -1 : 0;
2499       if (!LoOverflow)
2500         LoOverflow = addWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
2501     } else {                       // (X / neg) op neg
2502       LoBound = Prod;       // e.g. X/-5 op -3  --> [15, 20)
2503       LoOverflow = HiOverflow = ProdOV;
2504       if (!HiOverflow)
2505         HiOverflow = subWithOverflow(HiBound, Prod, RangeSize, true);
2506     }
2507 
2508     // Dividing by a negative swaps the condition.  LT <-> GT
2509     Pred = ICmpInst::getSwappedPredicate(Pred);
2510   }
2511 
2512   Value *X = Div->getOperand(0);
2513   switch (Pred) {
2514     default: llvm_unreachable("Unhandled icmp opcode!");
2515     case ICmpInst::ICMP_EQ:
2516       if (LoOverflow && HiOverflow)
2517         return replaceInstUsesWith(Cmp, Builder.getFalse());
2518       if (HiOverflow)
2519         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
2520                             ICmpInst::ICMP_UGE, X,
2521                             ConstantInt::get(Div->getType(), LoBound));
2522       if (LoOverflow)
2523         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
2524                             ICmpInst::ICMP_ULT, X,
2525                             ConstantInt::get(Div->getType(), HiBound));
2526       return replaceInstUsesWith(
2527           Cmp, insertRangeTest(X, LoBound, HiBound, DivIsSigned, true));
2528     case ICmpInst::ICMP_NE:
2529       if (LoOverflow && HiOverflow)
2530         return replaceInstUsesWith(Cmp, Builder.getTrue());
2531       if (HiOverflow)
2532         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
2533                             ICmpInst::ICMP_ULT, X,
2534                             ConstantInt::get(Div->getType(), LoBound));
2535       if (LoOverflow)
2536         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
2537                             ICmpInst::ICMP_UGE, X,
2538                             ConstantInt::get(Div->getType(), HiBound));
2539       return replaceInstUsesWith(Cmp,
2540                                  insertRangeTest(X, LoBound, HiBound,
2541                                                  DivIsSigned, false));
2542     case ICmpInst::ICMP_ULT:
2543     case ICmpInst::ICMP_SLT:
2544       if (LoOverflow == +1)   // Low bound is greater than input range.
2545         return replaceInstUsesWith(Cmp, Builder.getTrue());
2546       if (LoOverflow == -1)   // Low bound is less than input range.
2547         return replaceInstUsesWith(Cmp, Builder.getFalse());
2548       return new ICmpInst(Pred, X, ConstantInt::get(Div->getType(), LoBound));
2549     case ICmpInst::ICMP_UGT:
2550     case ICmpInst::ICMP_SGT:
2551       if (HiOverflow == +1)       // High bound greater than input range.
2552         return replaceInstUsesWith(Cmp, Builder.getFalse());
2553       if (HiOverflow == -1)       // High bound less than input range.
2554         return replaceInstUsesWith(Cmp, Builder.getTrue());
2555       if (Pred == ICmpInst::ICMP_UGT)
2556         return new ICmpInst(ICmpInst::ICMP_UGE, X,
2557                             ConstantInt::get(Div->getType(), HiBound));
2558       return new ICmpInst(ICmpInst::ICMP_SGE, X,
2559                           ConstantInt::get(Div->getType(), HiBound));
2560   }
2561 
2562   return nullptr;
2563 }
2564 
2565 /// Fold icmp (sub X, Y), C.
2566 Instruction *InstCombinerImpl::foldICmpSubConstant(ICmpInst &Cmp,
2567                                                    BinaryOperator *Sub,
2568                                                    const APInt &C) {
2569   Value *X = Sub->getOperand(0), *Y = Sub->getOperand(1);
2570   ICmpInst::Predicate Pred = Cmp.getPredicate();
2571   const APInt *C2;
2572   APInt SubResult;
2573 
2574   // icmp eq/ne (sub C, Y), C -> icmp eq/ne Y, 0
2575   if (match(X, m_APInt(C2)) && *C2 == C && Cmp.isEquality())
2576     return new ICmpInst(Cmp.getPredicate(), Y,
2577                         ConstantInt::get(Y->getType(), 0));
2578 
2579   // (icmp P (sub nuw|nsw C2, Y), C) -> (icmp swap(P) Y, C2-C)
2580   if (match(X, m_APInt(C2)) &&
2581       ((Cmp.isUnsigned() && Sub->hasNoUnsignedWrap()) ||
2582        (Cmp.isSigned() && Sub->hasNoSignedWrap())) &&
2583       !subWithOverflow(SubResult, *C2, C, Cmp.isSigned()))
2584     return new ICmpInst(Cmp.getSwappedPredicate(), Y,
2585                         ConstantInt::get(Y->getType(), SubResult));
2586 
2587   // The following transforms are only worth it if the only user of the subtract
2588   // is the icmp.
2589   if (!Sub->hasOneUse())
2590     return nullptr;
2591 
2592   if (Sub->hasNoSignedWrap()) {
2593     // (icmp sgt (sub nsw X, Y), -1) -> (icmp sge X, Y)
2594     if (Pred == ICmpInst::ICMP_SGT && C.isAllOnesValue())
2595       return new ICmpInst(ICmpInst::ICMP_SGE, X, Y);
2596 
2597     // (icmp sgt (sub nsw X, Y), 0) -> (icmp sgt X, Y)
2598     if (Pred == ICmpInst::ICMP_SGT && C.isNullValue())
2599       return new ICmpInst(ICmpInst::ICMP_SGT, X, Y);
2600 
2601     // (icmp slt (sub nsw X, Y), 0) -> (icmp slt X, Y)
2602     if (Pred == ICmpInst::ICMP_SLT && C.isNullValue())
2603       return new ICmpInst(ICmpInst::ICMP_SLT, X, Y);
2604 
2605     // (icmp slt (sub nsw X, Y), 1) -> (icmp sle X, Y)
2606     if (Pred == ICmpInst::ICMP_SLT && C.isOneValue())
2607       return new ICmpInst(ICmpInst::ICMP_SLE, X, Y);
2608   }
2609 
2610   if (!match(X, m_APInt(C2)))
2611     return nullptr;
2612 
2613   // C2 - Y <u C -> (Y | (C - 1)) == C2
2614   //   iff (C2 & (C - 1)) == C - 1 and C is a power of 2
2615   if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() &&
2616       (*C2 & (C - 1)) == (C - 1))
2617     return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateOr(Y, C - 1), X);
2618 
2619   // C2 - Y >u C -> (Y | C) != C2
2620   //   iff C2 & C == C and C + 1 is a power of 2
2621   if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == C)
2622     return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateOr(Y, C), X);
2623 
2624   return nullptr;
2625 }
2626 
2627 /// Fold icmp (add X, Y), C.
2628 Instruction *InstCombinerImpl::foldICmpAddConstant(ICmpInst &Cmp,
2629                                                    BinaryOperator *Add,
2630                                                    const APInt &C) {
2631   Value *Y = Add->getOperand(1);
2632   const APInt *C2;
2633   if (Cmp.isEquality() || !match(Y, m_APInt(C2)))
2634     return nullptr;
2635 
2636   // Fold icmp pred (add X, C2), C.
2637   Value *X = Add->getOperand(0);
2638   Type *Ty = Add->getType();
2639   CmpInst::Predicate Pred = Cmp.getPredicate();
2640 
2641   // Fold an unsigned compare with offset to signed compare:
2642   // (X + C2) >u C --> X <s -C2 (if C == C2 + SMAX)
2643   // TODO: Find the signed predicate siblings.
2644   if (Pred == CmpInst::ICMP_UGT &&
2645       C == *C2 + APInt::getSignedMaxValue(Ty->getScalarSizeInBits()))
2646     return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, -(*C2)));
2647 
2648   // (X + C2) <u C --> X >s ~C2 (if C == C2 + SMIN)
2649   if (Pred == CmpInst::ICMP_ULT &&
2650       C == *C2 + APInt::getSignedMinValue(Ty->getScalarSizeInBits()))
2651     return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantInt::get(Ty, ~(*C2)));
2652 
2653   // If the add does not wrap, we can always adjust the compare by subtracting
2654   // the constants. Equality comparisons are handled elsewhere. SGE/SLE/UGE/ULE
2655   // are canonicalized to SGT/SLT/UGT/ULT.
2656   if ((Add->hasNoSignedWrap() &&
2657        (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLT)) ||
2658       (Add->hasNoUnsignedWrap() &&
2659        (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULT))) {
2660     bool Overflow;
2661     APInt NewC =
2662         Cmp.isSigned() ? C.ssub_ov(*C2, Overflow) : C.usub_ov(*C2, Overflow);
2663     // If there is overflow, the result must be true or false.
2664     // TODO: Can we assert there is no overflow because InstSimplify always
2665     // handles those cases?
2666     if (!Overflow)
2667       // icmp Pred (add nsw X, C2), C --> icmp Pred X, (C - C2)
2668       return new ICmpInst(Pred, X, ConstantInt::get(Ty, NewC));
2669   }
2670 
2671   auto CR = ConstantRange::makeExactICmpRegion(Pred, C).subtract(*C2);
2672   const APInt &Upper = CR.getUpper();
2673   const APInt &Lower = CR.getLower();
2674   if (Cmp.isSigned()) {
2675     if (Lower.isSignMask())
2676       return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, Upper));
2677     if (Upper.isSignMask())
2678       return new ICmpInst(ICmpInst::ICMP_SGE, X, ConstantInt::get(Ty, Lower));
2679   } else {
2680     if (Lower.isMinValue())
2681       return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, Upper));
2682     if (Upper.isMinValue())
2683       return new ICmpInst(ICmpInst::ICMP_UGE, X, ConstantInt::get(Ty, Lower));
2684   }
2685 
2686   if (!Add->hasOneUse())
2687     return nullptr;
2688 
2689   // X+C <u C2 -> (X & -C2) == C
2690   //   iff C & (C2-1) == 0
2691   //       C2 is a power of 2
2692   if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() && (*C2 & (C - 1)) == 0)
2693     return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateAnd(X, -C),
2694                         ConstantExpr::getNeg(cast<Constant>(Y)));
2695 
2696   // X+C >u C2 -> (X & ~C2) != C
2697   //   iff C & C2 == 0
2698   //       C2+1 is a power of 2
2699   if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == 0)
2700     return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateAnd(X, ~C),
2701                         ConstantExpr::getNeg(cast<Constant>(Y)));
2702 
2703   return nullptr;
2704 }
2705 
2706 bool InstCombinerImpl::matchThreeWayIntCompare(SelectInst *SI, Value *&LHS,
2707                                                Value *&RHS, ConstantInt *&Less,
2708                                                ConstantInt *&Equal,
2709                                                ConstantInt *&Greater) {
2710   // TODO: Generalize this to work with other comparison idioms or ensure
2711   // they get canonicalized into this form.
2712 
2713   // select i1 (a == b),
2714   //        i32 Equal,
2715   //        i32 (select i1 (a < b), i32 Less, i32 Greater)
2716   // where Equal, Less and Greater are placeholders for any three constants.
2717   ICmpInst::Predicate PredA;
2718   if (!match(SI->getCondition(), m_ICmp(PredA, m_Value(LHS), m_Value(RHS))) ||
2719       !ICmpInst::isEquality(PredA))
2720     return false;
2721   Value *EqualVal = SI->getTrueValue();
2722   Value *UnequalVal = SI->getFalseValue();
2723   // We still can get non-canonical predicate here, so canonicalize.
2724   if (PredA == ICmpInst::ICMP_NE)
2725     std::swap(EqualVal, UnequalVal);
2726   if (!match(EqualVal, m_ConstantInt(Equal)))
2727     return false;
2728   ICmpInst::Predicate PredB;
2729   Value *LHS2, *RHS2;
2730   if (!match(UnequalVal, m_Select(m_ICmp(PredB, m_Value(LHS2), m_Value(RHS2)),
2731                                   m_ConstantInt(Less), m_ConstantInt(Greater))))
2732     return false;
2733   // We can get predicate mismatch here, so canonicalize if possible:
2734   // First, ensure that 'LHS' match.
2735   if (LHS2 != LHS) {
2736     // x sgt y <--> y slt x
2737     std::swap(LHS2, RHS2);
2738     PredB = ICmpInst::getSwappedPredicate(PredB);
2739   }
2740   if (LHS2 != LHS)
2741     return false;
2742   // We also need to canonicalize 'RHS'.
2743   if (PredB == ICmpInst::ICMP_SGT && isa<Constant>(RHS2)) {
2744     // x sgt C-1  <-->  x sge C  <-->  not(x slt C)
2745     auto FlippedStrictness =
2746         InstCombiner::getFlippedStrictnessPredicateAndConstant(
2747             PredB, cast<Constant>(RHS2));
2748     if (!FlippedStrictness)
2749       return false;
2750     assert(FlippedStrictness->first == ICmpInst::ICMP_SGE && "Sanity check");
2751     RHS2 = FlippedStrictness->second;
2752     // And kind-of perform the result swap.
2753     std::swap(Less, Greater);
2754     PredB = ICmpInst::ICMP_SLT;
2755   }
2756   return PredB == ICmpInst::ICMP_SLT && RHS == RHS2;
2757 }
2758 
2759 Instruction *InstCombinerImpl::foldICmpSelectConstant(ICmpInst &Cmp,
2760                                                       SelectInst *Select,
2761                                                       ConstantInt *C) {
2762 
2763   assert(C && "Cmp RHS should be a constant int!");
2764   // If we're testing a constant value against the result of a three way
2765   // comparison, the result can be expressed directly in terms of the
2766   // original values being compared.  Note: We could possibly be more
2767   // aggressive here and remove the hasOneUse test. The original select is
2768   // really likely to simplify or sink when we remove a test of the result.
2769   Value *OrigLHS, *OrigRHS;
2770   ConstantInt *C1LessThan, *C2Equal, *C3GreaterThan;
2771   if (Cmp.hasOneUse() &&
2772       matchThreeWayIntCompare(Select, OrigLHS, OrigRHS, C1LessThan, C2Equal,
2773                               C3GreaterThan)) {
2774     assert(C1LessThan && C2Equal && C3GreaterThan);
2775 
2776     bool TrueWhenLessThan =
2777         ConstantExpr::getCompare(Cmp.getPredicate(), C1LessThan, C)
2778             ->isAllOnesValue();
2779     bool TrueWhenEqual =
2780         ConstantExpr::getCompare(Cmp.getPredicate(), C2Equal, C)
2781             ->isAllOnesValue();
2782     bool TrueWhenGreaterThan =
2783         ConstantExpr::getCompare(Cmp.getPredicate(), C3GreaterThan, C)
2784             ->isAllOnesValue();
2785 
2786     // This generates the new instruction that will replace the original Cmp
2787     // Instruction. Instead of enumerating the various combinations when
2788     // TrueWhenLessThan, TrueWhenEqual and TrueWhenGreaterThan are true versus
2789     // false, we rely on chaining of ORs and future passes of InstCombine to
2790     // simplify the OR further (i.e. a s< b || a == b becomes a s<= b).
2791 
2792     // When none of the three constants satisfy the predicate for the RHS (C),
2793     // the entire original Cmp can be simplified to a false.
2794     Value *Cond = Builder.getFalse();
2795     if (TrueWhenLessThan)
2796       Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SLT,
2797                                                        OrigLHS, OrigRHS));
2798     if (TrueWhenEqual)
2799       Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_EQ,
2800                                                        OrigLHS, OrigRHS));
2801     if (TrueWhenGreaterThan)
2802       Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SGT,
2803                                                        OrigLHS, OrigRHS));
2804 
2805     return replaceInstUsesWith(Cmp, Cond);
2806   }
2807   return nullptr;
2808 }
2809 
2810 static Instruction *foldICmpBitCast(ICmpInst &Cmp,
2811                                     InstCombiner::BuilderTy &Builder) {
2812   auto *Bitcast = dyn_cast<BitCastInst>(Cmp.getOperand(0));
2813   if (!Bitcast)
2814     return nullptr;
2815 
2816   ICmpInst::Predicate Pred = Cmp.getPredicate();
2817   Value *Op1 = Cmp.getOperand(1);
2818   Value *BCSrcOp = Bitcast->getOperand(0);
2819 
2820   // Make sure the bitcast doesn't change the number of vector elements.
2821   if (Bitcast->getSrcTy()->getScalarSizeInBits() ==
2822           Bitcast->getDestTy()->getScalarSizeInBits()) {
2823     // Zero-equality and sign-bit checks are preserved through sitofp + bitcast.
2824     Value *X;
2825     if (match(BCSrcOp, m_SIToFP(m_Value(X)))) {
2826       // icmp  eq (bitcast (sitofp X)), 0 --> icmp  eq X, 0
2827       // icmp  ne (bitcast (sitofp X)), 0 --> icmp  ne X, 0
2828       // icmp slt (bitcast (sitofp X)), 0 --> icmp slt X, 0
2829       // icmp sgt (bitcast (sitofp X)), 0 --> icmp sgt X, 0
2830       if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_SLT ||
2831            Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT) &&
2832           match(Op1, m_Zero()))
2833         return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType()));
2834 
2835       // icmp slt (bitcast (sitofp X)), 1 --> icmp slt X, 1
2836       if (Pred == ICmpInst::ICMP_SLT && match(Op1, m_One()))
2837         return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), 1));
2838 
2839       // icmp sgt (bitcast (sitofp X)), -1 --> icmp sgt X, -1
2840       if (Pred == ICmpInst::ICMP_SGT && match(Op1, m_AllOnes()))
2841         return new ICmpInst(Pred, X,
2842                             ConstantInt::getAllOnesValue(X->getType()));
2843     }
2844 
2845     // Zero-equality checks are preserved through unsigned floating-point casts:
2846     // icmp eq (bitcast (uitofp X)), 0 --> icmp eq X, 0
2847     // icmp ne (bitcast (uitofp X)), 0 --> icmp ne X, 0
2848     if (match(BCSrcOp, m_UIToFP(m_Value(X))))
2849       if (Cmp.isEquality() && match(Op1, m_Zero()))
2850         return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType()));
2851 
2852     // If this is a sign-bit test of a bitcast of a casted FP value, eliminate
2853     // the FP extend/truncate because that cast does not change the sign-bit.
2854     // This is true for all standard IEEE-754 types and the X86 80-bit type.
2855     // The sign-bit is always the most significant bit in those types.
2856     const APInt *C;
2857     bool TrueIfSigned;
2858     if (match(Op1, m_APInt(C)) && Bitcast->hasOneUse() &&
2859         InstCombiner::isSignBitCheck(Pred, *C, TrueIfSigned)) {
2860       if (match(BCSrcOp, m_FPExt(m_Value(X))) ||
2861           match(BCSrcOp, m_FPTrunc(m_Value(X)))) {
2862         // (bitcast (fpext/fptrunc X)) to iX) < 0 --> (bitcast X to iY) < 0
2863         // (bitcast (fpext/fptrunc X)) to iX) > -1 --> (bitcast X to iY) > -1
2864         Type *XType = X->getType();
2865 
2866         // We can't currently handle Power style floating point operations here.
2867         if (!(XType->isPPC_FP128Ty() || BCSrcOp->getType()->isPPC_FP128Ty())) {
2868 
2869           Type *NewType = Builder.getIntNTy(XType->getScalarSizeInBits());
2870           if (auto *XVTy = dyn_cast<VectorType>(XType))
2871             NewType = VectorType::get(NewType, XVTy->getElementCount());
2872           Value *NewBitcast = Builder.CreateBitCast(X, NewType);
2873           if (TrueIfSigned)
2874             return new ICmpInst(ICmpInst::ICMP_SLT, NewBitcast,
2875                                 ConstantInt::getNullValue(NewType));
2876           else
2877             return new ICmpInst(ICmpInst::ICMP_SGT, NewBitcast,
2878                                 ConstantInt::getAllOnesValue(NewType));
2879         }
2880       }
2881     }
2882   }
2883 
2884   // Test to see if the operands of the icmp are casted versions of other
2885   // values. If the ptr->ptr cast can be stripped off both arguments, do so.
2886   if (Bitcast->getType()->isPointerTy() &&
2887       (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
2888     // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2889     // so eliminate it as well.
2890     if (auto *BC2 = dyn_cast<BitCastInst>(Op1))
2891       Op1 = BC2->getOperand(0);
2892 
2893     Op1 = Builder.CreateBitCast(Op1, BCSrcOp->getType());
2894     return new ICmpInst(Pred, BCSrcOp, Op1);
2895   }
2896 
2897   // Folding: icmp <pred> iN X, C
2898   //  where X = bitcast <M x iK> (shufflevector <M x iK> %vec, undef, SC)) to iN
2899   //    and C is a splat of a K-bit pattern
2900   //    and SC is a constant vector = <C', C', C', ..., C'>
2901   // Into:
2902   //   %E = extractelement <M x iK> %vec, i32 C'
2903   //   icmp <pred> iK %E, trunc(C)
2904   const APInt *C;
2905   if (!match(Cmp.getOperand(1), m_APInt(C)) ||
2906       !Bitcast->getType()->isIntegerTy() ||
2907       !Bitcast->getSrcTy()->isIntOrIntVectorTy())
2908     return nullptr;
2909 
2910   Value *Vec;
2911   ArrayRef<int> Mask;
2912   if (match(BCSrcOp, m_Shuffle(m_Value(Vec), m_Undef(), m_Mask(Mask)))) {
2913     // Check whether every element of Mask is the same constant
2914     if (is_splat(Mask)) {
2915       auto *VecTy = cast<VectorType>(BCSrcOp->getType());
2916       auto *EltTy = cast<IntegerType>(VecTy->getElementType());
2917       if (C->isSplat(EltTy->getBitWidth())) {
2918         // Fold the icmp based on the value of C
2919         // If C is M copies of an iK sized bit pattern,
2920         // then:
2921         //   =>  %E = extractelement <N x iK> %vec, i32 Elem
2922         //       icmp <pred> iK %SplatVal, <pattern>
2923         Value *Elem = Builder.getInt32(Mask[0]);
2924         Value *Extract = Builder.CreateExtractElement(Vec, Elem);
2925         Value *NewC = ConstantInt::get(EltTy, C->trunc(EltTy->getBitWidth()));
2926         return new ICmpInst(Pred, Extract, NewC);
2927       }
2928     }
2929   }
2930   return nullptr;
2931 }
2932 
2933 /// Try to fold integer comparisons with a constant operand: icmp Pred X, C
2934 /// where X is some kind of instruction.
2935 Instruction *InstCombinerImpl::foldICmpInstWithConstant(ICmpInst &Cmp) {
2936   const APInt *C;
2937   if (!match(Cmp.getOperand(1), m_APInt(C)))
2938     return nullptr;
2939 
2940   if (auto *BO = dyn_cast<BinaryOperator>(Cmp.getOperand(0))) {
2941     switch (BO->getOpcode()) {
2942     case Instruction::Xor:
2943       if (Instruction *I = foldICmpXorConstant(Cmp, BO, *C))
2944         return I;
2945       break;
2946     case Instruction::And:
2947       if (Instruction *I = foldICmpAndConstant(Cmp, BO, *C))
2948         return I;
2949       break;
2950     case Instruction::Or:
2951       if (Instruction *I = foldICmpOrConstant(Cmp, BO, *C))
2952         return I;
2953       break;
2954     case Instruction::Mul:
2955       if (Instruction *I = foldICmpMulConstant(Cmp, BO, *C))
2956         return I;
2957       break;
2958     case Instruction::Shl:
2959       if (Instruction *I = foldICmpShlConstant(Cmp, BO, *C))
2960         return I;
2961       break;
2962     case Instruction::LShr:
2963     case Instruction::AShr:
2964       if (Instruction *I = foldICmpShrConstant(Cmp, BO, *C))
2965         return I;
2966       break;
2967     case Instruction::SRem:
2968       if (Instruction *I = foldICmpSRemConstant(Cmp, BO, *C))
2969         return I;
2970       break;
2971     case Instruction::UDiv:
2972       if (Instruction *I = foldICmpUDivConstant(Cmp, BO, *C))
2973         return I;
2974       LLVM_FALLTHROUGH;
2975     case Instruction::SDiv:
2976       if (Instruction *I = foldICmpDivConstant(Cmp, BO, *C))
2977         return I;
2978       break;
2979     case Instruction::Sub:
2980       if (Instruction *I = foldICmpSubConstant(Cmp, BO, *C))
2981         return I;
2982       break;
2983     case Instruction::Add:
2984       if (Instruction *I = foldICmpAddConstant(Cmp, BO, *C))
2985         return I;
2986       break;
2987     default:
2988       break;
2989     }
2990     // TODO: These folds could be refactored to be part of the above calls.
2991     if (Instruction *I = foldICmpBinOpEqualityWithConstant(Cmp, BO, *C))
2992       return I;
2993   }
2994 
2995   // Match against CmpInst LHS being instructions other than binary operators.
2996 
2997   if (auto *SI = dyn_cast<SelectInst>(Cmp.getOperand(0))) {
2998     // For now, we only support constant integers while folding the
2999     // ICMP(SELECT)) pattern. We can extend this to support vector of integers
3000     // similar to the cases handled by binary ops above.
3001     if (ConstantInt *ConstRHS = dyn_cast<ConstantInt>(Cmp.getOperand(1)))
3002       if (Instruction *I = foldICmpSelectConstant(Cmp, SI, ConstRHS))
3003         return I;
3004   }
3005 
3006   if (auto *TI = dyn_cast<TruncInst>(Cmp.getOperand(0))) {
3007     if (Instruction *I = foldICmpTruncConstant(Cmp, TI, *C))
3008       return I;
3009   }
3010 
3011   if (auto *II = dyn_cast<IntrinsicInst>(Cmp.getOperand(0)))
3012     if (Instruction *I = foldICmpIntrinsicWithConstant(Cmp, II, *C))
3013       return I;
3014 
3015   return nullptr;
3016 }
3017 
3018 /// Fold an icmp equality instruction with binary operator LHS and constant RHS:
3019 /// icmp eq/ne BO, C.
3020 Instruction *InstCombinerImpl::foldICmpBinOpEqualityWithConstant(
3021     ICmpInst &Cmp, BinaryOperator *BO, const APInt &C) {
3022   // TODO: Some of these folds could work with arbitrary constants, but this
3023   // function is limited to scalar and vector splat constants.
3024   if (!Cmp.isEquality())
3025     return nullptr;
3026 
3027   ICmpInst::Predicate Pred = Cmp.getPredicate();
3028   bool isICMP_NE = Pred == ICmpInst::ICMP_NE;
3029   Constant *RHS = cast<Constant>(Cmp.getOperand(1));
3030   Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
3031 
3032   switch (BO->getOpcode()) {
3033   case Instruction::SRem:
3034     // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
3035     if (C.isNullValue() && BO->hasOneUse()) {
3036       const APInt *BOC;
3037       if (match(BOp1, m_APInt(BOC)) && BOC->sgt(1) && BOC->isPowerOf2()) {
3038         Value *NewRem = Builder.CreateURem(BOp0, BOp1, BO->getName());
3039         return new ICmpInst(Pred, NewRem,
3040                             Constant::getNullValue(BO->getType()));
3041       }
3042     }
3043     break;
3044   case Instruction::Add: {
3045     // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
3046     if (Constant *BOC = dyn_cast<Constant>(BOp1)) {
3047       if (BO->hasOneUse())
3048         return new ICmpInst(Pred, BOp0, ConstantExpr::getSub(RHS, BOC));
3049     } else if (C.isNullValue()) {
3050       // Replace ((add A, B) != 0) with (A != -B) if A or B is
3051       // efficiently invertible, or if the add has just this one use.
3052       if (Value *NegVal = dyn_castNegVal(BOp1))
3053         return new ICmpInst(Pred, BOp0, NegVal);
3054       if (Value *NegVal = dyn_castNegVal(BOp0))
3055         return new ICmpInst(Pred, NegVal, BOp1);
3056       if (BO->hasOneUse()) {
3057         Value *Neg = Builder.CreateNeg(BOp1);
3058         Neg->takeName(BO);
3059         return new ICmpInst(Pred, BOp0, Neg);
3060       }
3061     }
3062     break;
3063   }
3064   case Instruction::Xor:
3065     if (BO->hasOneUse()) {
3066       if (Constant *BOC = dyn_cast<Constant>(BOp1)) {
3067         // For the xor case, we can xor two constants together, eliminating
3068         // the explicit xor.
3069         return new ICmpInst(Pred, BOp0, ConstantExpr::getXor(RHS, BOC));
3070       } else if (C.isNullValue()) {
3071         // Replace ((xor A, B) != 0) with (A != B)
3072         return new ICmpInst(Pred, BOp0, BOp1);
3073       }
3074     }
3075     break;
3076   case Instruction::Sub:
3077     if (BO->hasOneUse()) {
3078       // Only check for constant LHS here, as constant RHS will be canonicalized
3079       // to add and use the fold above.
3080       if (Constant *BOC = dyn_cast<Constant>(BOp0)) {
3081         // Replace ((sub BOC, B) != C) with (B != BOC-C).
3082         return new ICmpInst(Pred, BOp1, ConstantExpr::getSub(BOC, RHS));
3083       } else if (C.isNullValue()) {
3084         // Replace ((sub A, B) != 0) with (A != B).
3085         return new ICmpInst(Pred, BOp0, BOp1);
3086       }
3087     }
3088     break;
3089   case Instruction::Or: {
3090     const APInt *BOC;
3091     if (match(BOp1, m_APInt(BOC)) && BO->hasOneUse() && RHS->isAllOnesValue()) {
3092       // Comparing if all bits outside of a constant mask are set?
3093       // Replace (X | C) == -1 with (X & ~C) == ~C.
3094       // This removes the -1 constant.
3095       Constant *NotBOC = ConstantExpr::getNot(cast<Constant>(BOp1));
3096       Value *And = Builder.CreateAnd(BOp0, NotBOC);
3097       return new ICmpInst(Pred, And, NotBOC);
3098     }
3099     break;
3100   }
3101   case Instruction::And: {
3102     const APInt *BOC;
3103     if (match(BOp1, m_APInt(BOC))) {
3104       // If we have ((X & C) == C), turn it into ((X & C) != 0).
3105       if (C == *BOC && C.isPowerOf2())
3106         return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE,
3107                             BO, Constant::getNullValue(RHS->getType()));
3108     }
3109     break;
3110   }
3111   case Instruction::UDiv:
3112     if (C.isNullValue()) {
3113       // (icmp eq/ne (udiv A, B), 0) -> (icmp ugt/ule i32 B, A)
3114       auto NewPred = isICMP_NE ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT;
3115       return new ICmpInst(NewPred, BOp1, BOp0);
3116     }
3117     break;
3118   default:
3119     break;
3120   }
3121   return nullptr;
3122 }
3123 
3124 /// Fold an equality icmp with LLVM intrinsic and constant operand.
3125 Instruction *InstCombinerImpl::foldICmpEqIntrinsicWithConstant(
3126     ICmpInst &Cmp, IntrinsicInst *II, const APInt &C) {
3127   Type *Ty = II->getType();
3128   unsigned BitWidth = C.getBitWidth();
3129   switch (II->getIntrinsicID()) {
3130   case Intrinsic::abs:
3131     // abs(A) == 0  ->  A == 0
3132     // abs(A) == INT_MIN  ->  A == INT_MIN
3133     if (C.isNullValue() || C.isMinSignedValue())
3134       return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3135                           ConstantInt::get(Ty, C));
3136     break;
3137 
3138   case Intrinsic::bswap:
3139     // bswap(A) == C  ->  A == bswap(C)
3140     return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3141                         ConstantInt::get(Ty, C.byteSwap()));
3142 
3143   case Intrinsic::ctlz:
3144   case Intrinsic::cttz: {
3145     // ctz(A) == bitwidth(A)  ->  A == 0 and likewise for !=
3146     if (C == BitWidth)
3147       return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3148                           ConstantInt::getNullValue(Ty));
3149 
3150     // ctz(A) == C -> A & Mask1 == Mask2, where Mask2 only has bit C set
3151     // and Mask1 has bits 0..C+1 set. Similar for ctl, but for high bits.
3152     // Limit to one use to ensure we don't increase instruction count.
3153     unsigned Num = C.getLimitedValue(BitWidth);
3154     if (Num != BitWidth && II->hasOneUse()) {
3155       bool IsTrailing = II->getIntrinsicID() == Intrinsic::cttz;
3156       APInt Mask1 = IsTrailing ? APInt::getLowBitsSet(BitWidth, Num + 1)
3157                                : APInt::getHighBitsSet(BitWidth, Num + 1);
3158       APInt Mask2 = IsTrailing
3159         ? APInt::getOneBitSet(BitWidth, Num)
3160         : APInt::getOneBitSet(BitWidth, BitWidth - Num - 1);
3161       return new ICmpInst(Cmp.getPredicate(),
3162           Builder.CreateAnd(II->getArgOperand(0), Mask1),
3163           ConstantInt::get(Ty, Mask2));
3164     }
3165     break;
3166   }
3167 
3168   case Intrinsic::ctpop: {
3169     // popcount(A) == 0  ->  A == 0 and likewise for !=
3170     // popcount(A) == bitwidth(A)  ->  A == -1 and likewise for !=
3171     bool IsZero = C.isNullValue();
3172     if (IsZero || C == BitWidth)
3173       return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3174           IsZero ? Constant::getNullValue(Ty) : Constant::getAllOnesValue(Ty));
3175 
3176     break;
3177   }
3178 
3179   case Intrinsic::uadd_sat: {
3180     // uadd.sat(a, b) == 0  ->  (a | b) == 0
3181     if (C.isNullValue()) {
3182       Value *Or = Builder.CreateOr(II->getArgOperand(0), II->getArgOperand(1));
3183       return new ICmpInst(Cmp.getPredicate(), Or, Constant::getNullValue(Ty));
3184     }
3185     break;
3186   }
3187 
3188   case Intrinsic::usub_sat: {
3189     // usub.sat(a, b) == 0  ->  a <= b
3190     if (C.isNullValue()) {
3191       ICmpInst::Predicate NewPred = Cmp.getPredicate() == ICmpInst::ICMP_EQ
3192           ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT;
3193       return new ICmpInst(NewPred, II->getArgOperand(0), II->getArgOperand(1));
3194     }
3195     break;
3196   }
3197   default:
3198     break;
3199   }
3200 
3201   return nullptr;
3202 }
3203 
3204 /// Fold an icmp with LLVM intrinsic and constant operand: icmp Pred II, C.
3205 Instruction *InstCombinerImpl::foldICmpIntrinsicWithConstant(ICmpInst &Cmp,
3206                                                              IntrinsicInst *II,
3207                                                              const APInt &C) {
3208   if (Cmp.isEquality())
3209     return foldICmpEqIntrinsicWithConstant(Cmp, II, C);
3210 
3211   Type *Ty = II->getType();
3212   unsigned BitWidth = C.getBitWidth();
3213   ICmpInst::Predicate Pred = Cmp.getPredicate();
3214   switch (II->getIntrinsicID()) {
3215   case Intrinsic::ctpop: {
3216     // (ctpop X > BitWidth - 1) --> X == -1
3217     Value *X = II->getArgOperand(0);
3218     if (C == BitWidth - 1 && Pred == ICmpInst::ICMP_UGT)
3219       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_EQ, X,
3220                              ConstantInt::getAllOnesValue(Ty));
3221     // (ctpop X < BitWidth) --> X != -1
3222     if (C == BitWidth && Pred == ICmpInst::ICMP_ULT)
3223       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_NE, X,
3224                              ConstantInt::getAllOnesValue(Ty));
3225     break;
3226   }
3227   case Intrinsic::ctlz: {
3228     // ctlz(0bXXXXXXXX) > 3 -> 0bXXXXXXXX < 0b00010000
3229     if (Pred == ICmpInst::ICMP_UGT && C.ult(BitWidth)) {
3230       unsigned Num = C.getLimitedValue();
3231       APInt Limit = APInt::getOneBitSet(BitWidth, BitWidth - Num - 1);
3232       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_ULT,
3233                              II->getArgOperand(0), ConstantInt::get(Ty, Limit));
3234     }
3235 
3236     // ctlz(0bXXXXXXXX) < 3 -> 0bXXXXXXXX > 0b00011111
3237     if (Pred == ICmpInst::ICMP_ULT && C.uge(1) && C.ule(BitWidth)) {
3238       unsigned Num = C.getLimitedValue();
3239       APInt Limit = APInt::getLowBitsSet(BitWidth, BitWidth - Num);
3240       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_UGT,
3241                              II->getArgOperand(0), ConstantInt::get(Ty, Limit));
3242     }
3243     break;
3244   }
3245   case Intrinsic::cttz: {
3246     // Limit to one use to ensure we don't increase instruction count.
3247     if (!II->hasOneUse())
3248       return nullptr;
3249 
3250     // cttz(0bXXXXXXXX) > 3 -> 0bXXXXXXXX & 0b00001111 == 0
3251     if (Pred == ICmpInst::ICMP_UGT && C.ult(BitWidth)) {
3252       APInt Mask = APInt::getLowBitsSet(BitWidth, C.getLimitedValue() + 1);
3253       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_EQ,
3254                              Builder.CreateAnd(II->getArgOperand(0), Mask),
3255                              ConstantInt::getNullValue(Ty));
3256     }
3257 
3258     // cttz(0bXXXXXXXX) < 3 -> 0bXXXXXXXX & 0b00000111 != 0
3259     if (Pred == ICmpInst::ICMP_ULT && C.uge(1) && C.ule(BitWidth)) {
3260       APInt Mask = APInt::getLowBitsSet(BitWidth, C.getLimitedValue());
3261       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_NE,
3262                              Builder.CreateAnd(II->getArgOperand(0), Mask),
3263                              ConstantInt::getNullValue(Ty));
3264     }
3265     break;
3266   }
3267   default:
3268     break;
3269   }
3270 
3271   return nullptr;
3272 }
3273 
3274 /// Handle icmp with constant (but not simple integer constant) RHS.
3275 Instruction *InstCombinerImpl::foldICmpInstWithConstantNotInt(ICmpInst &I) {
3276   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3277   Constant *RHSC = dyn_cast<Constant>(Op1);
3278   Instruction *LHSI = dyn_cast<Instruction>(Op0);
3279   if (!RHSC || !LHSI)
3280     return nullptr;
3281 
3282   switch (LHSI->getOpcode()) {
3283   case Instruction::GetElementPtr:
3284     // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
3285     if (RHSC->isNullValue() &&
3286         cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
3287       return new ICmpInst(
3288           I.getPredicate(), LHSI->getOperand(0),
3289           Constant::getNullValue(LHSI->getOperand(0)->getType()));
3290     break;
3291   case Instruction::PHI:
3292     // Only fold icmp into the PHI if the phi and icmp are in the same
3293     // block.  If in the same block, we're encouraging jump threading.  If
3294     // not, we are just pessimizing the code by making an i1 phi.
3295     if (LHSI->getParent() == I.getParent())
3296       if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI)))
3297         return NV;
3298     break;
3299   case Instruction::Select: {
3300     // If either operand of the select is a constant, we can fold the
3301     // comparison into the select arms, which will cause one to be
3302     // constant folded and the select turned into a bitwise or.
3303     Value *Op1 = nullptr, *Op2 = nullptr;
3304     ConstantInt *CI = nullptr;
3305 
3306     auto SimplifyOp = [&](Value *V) {
3307       Value *Op = nullptr;
3308       if (Constant *C = dyn_cast<Constant>(V)) {
3309         Op = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
3310       } else if (RHSC->isNullValue()) {
3311         // If null is being compared, check if it can be further simplified.
3312         Op = SimplifyICmpInst(I.getPredicate(), V, RHSC, SQ);
3313       }
3314       return Op;
3315     };
3316     Op1 = SimplifyOp(LHSI->getOperand(1));
3317     if (Op1)
3318       CI = dyn_cast<ConstantInt>(Op1);
3319 
3320     Op2 = SimplifyOp(LHSI->getOperand(2));
3321     if (Op2)
3322       CI = dyn_cast<ConstantInt>(Op2);
3323 
3324     // We only want to perform this transformation if it will not lead to
3325     // additional code. This is true if either both sides of the select
3326     // fold to a constant (in which case the icmp is replaced with a select
3327     // which will usually simplify) or this is the only user of the
3328     // select (in which case we are trading a select+icmp for a simpler
3329     // select+icmp) or all uses of the select can be replaced based on
3330     // dominance information ("Global cases").
3331     bool Transform = false;
3332     if (Op1 && Op2)
3333       Transform = true;
3334     else if (Op1 || Op2) {
3335       // Local case
3336       if (LHSI->hasOneUse())
3337         Transform = true;
3338       // Global cases
3339       else if (CI && !CI->isZero())
3340         // When Op1 is constant try replacing select with second operand.
3341         // Otherwise Op2 is constant and try replacing select with first
3342         // operand.
3343         Transform =
3344             replacedSelectWithOperand(cast<SelectInst>(LHSI), &I, Op1 ? 2 : 1);
3345     }
3346     if (Transform) {
3347       if (!Op1)
3348         Op1 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(1), RHSC,
3349                                  I.getName());
3350       if (!Op2)
3351         Op2 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(2), RHSC,
3352                                  I.getName());
3353       return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3354     }
3355     break;
3356   }
3357   case Instruction::IntToPtr:
3358     // icmp pred inttoptr(X), null -> icmp pred X, 0
3359     if (RHSC->isNullValue() &&
3360         DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
3361       return new ICmpInst(
3362           I.getPredicate(), LHSI->getOperand(0),
3363           Constant::getNullValue(LHSI->getOperand(0)->getType()));
3364     break;
3365 
3366   case Instruction::Load:
3367     // Try to optimize things like "A[i] > 4" to index computations.
3368     if (GetElementPtrInst *GEP =
3369             dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3370       if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3371         if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3372             !cast<LoadInst>(LHSI)->isVolatile())
3373           if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
3374             return Res;
3375     }
3376     break;
3377   }
3378 
3379   return nullptr;
3380 }
3381 
3382 /// Some comparisons can be simplified.
3383 /// In this case, we are looking for comparisons that look like
3384 /// a check for a lossy truncation.
3385 /// Folds:
3386 ///   icmp SrcPred (x & Mask), x    to    icmp DstPred x, Mask
3387 /// Where Mask is some pattern that produces all-ones in low bits:
3388 ///    (-1 >> y)
3389 ///    ((-1 << y) >> y)     <- non-canonical, has extra uses
3390 ///   ~(-1 << y)
3391 ///    ((1 << y) + (-1))    <- non-canonical, has extra uses
3392 /// The Mask can be a constant, too.
3393 /// For some predicates, the operands are commutative.
3394 /// For others, x can only be on a specific side.
3395 static Value *foldICmpWithLowBitMaskedVal(ICmpInst &I,
3396                                           InstCombiner::BuilderTy &Builder) {
3397   ICmpInst::Predicate SrcPred;
3398   Value *X, *M, *Y;
3399   auto m_VariableMask = m_CombineOr(
3400       m_CombineOr(m_Not(m_Shl(m_AllOnes(), m_Value())),
3401                   m_Add(m_Shl(m_One(), m_Value()), m_AllOnes())),
3402       m_CombineOr(m_LShr(m_AllOnes(), m_Value()),
3403                   m_LShr(m_Shl(m_AllOnes(), m_Value(Y)), m_Deferred(Y))));
3404   auto m_Mask = m_CombineOr(m_VariableMask, m_LowBitMask());
3405   if (!match(&I, m_c_ICmp(SrcPred,
3406                           m_c_And(m_CombineAnd(m_Mask, m_Value(M)), m_Value(X)),
3407                           m_Deferred(X))))
3408     return nullptr;
3409 
3410   ICmpInst::Predicate DstPred;
3411   switch (SrcPred) {
3412   case ICmpInst::Predicate::ICMP_EQ:
3413     //  x & (-1 >> y) == x    ->    x u<= (-1 >> y)
3414     DstPred = ICmpInst::Predicate::ICMP_ULE;
3415     break;
3416   case ICmpInst::Predicate::ICMP_NE:
3417     //  x & (-1 >> y) != x    ->    x u> (-1 >> y)
3418     DstPred = ICmpInst::Predicate::ICMP_UGT;
3419     break;
3420   case ICmpInst::Predicate::ICMP_ULT:
3421     //  x & (-1 >> y) u< x    ->    x u> (-1 >> y)
3422     //  x u> x & (-1 >> y)    ->    x u> (-1 >> y)
3423     DstPred = ICmpInst::Predicate::ICMP_UGT;
3424     break;
3425   case ICmpInst::Predicate::ICMP_UGE:
3426     //  x & (-1 >> y) u>= x    ->    x u<= (-1 >> y)
3427     //  x u<= x & (-1 >> y)    ->    x u<= (-1 >> y)
3428     DstPred = ICmpInst::Predicate::ICMP_ULE;
3429     break;
3430   case ICmpInst::Predicate::ICMP_SLT:
3431     //  x & (-1 >> y) s< x    ->    x s> (-1 >> y)
3432     //  x s> x & (-1 >> y)    ->    x s> (-1 >> y)
3433     if (!match(M, m_Constant())) // Can not do this fold with non-constant.
3434       return nullptr;
3435     if (!match(M, m_NonNegative())) // Must not have any -1 vector elements.
3436       return nullptr;
3437     DstPred = ICmpInst::Predicate::ICMP_SGT;
3438     break;
3439   case ICmpInst::Predicate::ICMP_SGE:
3440     //  x & (-1 >> y) s>= x    ->    x s<= (-1 >> y)
3441     //  x s<= x & (-1 >> y)    ->    x s<= (-1 >> y)
3442     if (!match(M, m_Constant())) // Can not do this fold with non-constant.
3443       return nullptr;
3444     if (!match(M, m_NonNegative())) // Must not have any -1 vector elements.
3445       return nullptr;
3446     DstPred = ICmpInst::Predicate::ICMP_SLE;
3447     break;
3448   case ICmpInst::Predicate::ICMP_SGT:
3449   case ICmpInst::Predicate::ICMP_SLE:
3450     return nullptr;
3451   case ICmpInst::Predicate::ICMP_UGT:
3452   case ICmpInst::Predicate::ICMP_ULE:
3453     llvm_unreachable("Instsimplify took care of commut. variant");
3454     break;
3455   default:
3456     llvm_unreachable("All possible folds are handled.");
3457   }
3458 
3459   // The mask value may be a vector constant that has undefined elements. But it
3460   // may not be safe to propagate those undefs into the new compare, so replace
3461   // those elements by copying an existing, defined, and safe scalar constant.
3462   Type *OpTy = M->getType();
3463   auto *VecC = dyn_cast<Constant>(M);
3464   auto *OpVTy = dyn_cast<FixedVectorType>(OpTy);
3465   if (OpVTy && VecC && VecC->containsUndefOrPoisonElement()) {
3466     Constant *SafeReplacementConstant = nullptr;
3467     for (unsigned i = 0, e = OpVTy->getNumElements(); i != e; ++i) {
3468       if (!isa<UndefValue>(VecC->getAggregateElement(i))) {
3469         SafeReplacementConstant = VecC->getAggregateElement(i);
3470         break;
3471       }
3472     }
3473     assert(SafeReplacementConstant && "Failed to find undef replacement");
3474     M = Constant::replaceUndefsWith(VecC, SafeReplacementConstant);
3475   }
3476 
3477   return Builder.CreateICmp(DstPred, X, M);
3478 }
3479 
3480 /// Some comparisons can be simplified.
3481 /// In this case, we are looking for comparisons that look like
3482 /// a check for a lossy signed truncation.
3483 /// Folds:   (MaskedBits is a constant.)
3484 ///   ((%x << MaskedBits) a>> MaskedBits) SrcPred %x
3485 /// Into:
3486 ///   (add %x, (1 << (KeptBits-1))) DstPred (1 << KeptBits)
3487 /// Where  KeptBits = bitwidth(%x) - MaskedBits
3488 static Value *
3489 foldICmpWithTruncSignExtendedVal(ICmpInst &I,
3490                                  InstCombiner::BuilderTy &Builder) {
3491   ICmpInst::Predicate SrcPred;
3492   Value *X;
3493   const APInt *C0, *C1; // FIXME: non-splats, potentially with undef.
3494   // We are ok with 'shl' having multiple uses, but 'ashr' must be one-use.
3495   if (!match(&I, m_c_ICmp(SrcPred,
3496                           m_OneUse(m_AShr(m_Shl(m_Value(X), m_APInt(C0)),
3497                                           m_APInt(C1))),
3498                           m_Deferred(X))))
3499     return nullptr;
3500 
3501   // Potential handling of non-splats: for each element:
3502   //  * if both are undef, replace with constant 0.
3503   //    Because (1<<0) is OK and is 1, and ((1<<0)>>1) is also OK and is 0.
3504   //  * if both are not undef, and are different, bailout.
3505   //  * else, only one is undef, then pick the non-undef one.
3506 
3507   // The shift amount must be equal.
3508   if (*C0 != *C1)
3509     return nullptr;
3510   const APInt &MaskedBits = *C0;
3511   assert(MaskedBits != 0 && "shift by zero should be folded away already.");
3512 
3513   ICmpInst::Predicate DstPred;
3514   switch (SrcPred) {
3515   case ICmpInst::Predicate::ICMP_EQ:
3516     // ((%x << MaskedBits) a>> MaskedBits) == %x
3517     //   =>
3518     // (add %x, (1 << (KeptBits-1))) u< (1 << KeptBits)
3519     DstPred = ICmpInst::Predicate::ICMP_ULT;
3520     break;
3521   case ICmpInst::Predicate::ICMP_NE:
3522     // ((%x << MaskedBits) a>> MaskedBits) != %x
3523     //   =>
3524     // (add %x, (1 << (KeptBits-1))) u>= (1 << KeptBits)
3525     DstPred = ICmpInst::Predicate::ICMP_UGE;
3526     break;
3527   // FIXME: are more folds possible?
3528   default:
3529     return nullptr;
3530   }
3531 
3532   auto *XType = X->getType();
3533   const unsigned XBitWidth = XType->getScalarSizeInBits();
3534   const APInt BitWidth = APInt(XBitWidth, XBitWidth);
3535   assert(BitWidth.ugt(MaskedBits) && "shifts should leave some bits untouched");
3536 
3537   // KeptBits = bitwidth(%x) - MaskedBits
3538   const APInt KeptBits = BitWidth - MaskedBits;
3539   assert(KeptBits.ugt(0) && KeptBits.ult(BitWidth) && "unreachable");
3540   // ICmpCst = (1 << KeptBits)
3541   const APInt ICmpCst = APInt(XBitWidth, 1).shl(KeptBits);
3542   assert(ICmpCst.isPowerOf2());
3543   // AddCst = (1 << (KeptBits-1))
3544   const APInt AddCst = ICmpCst.lshr(1);
3545   assert(AddCst.ult(ICmpCst) && AddCst.isPowerOf2());
3546 
3547   // T0 = add %x, AddCst
3548   Value *T0 = Builder.CreateAdd(X, ConstantInt::get(XType, AddCst));
3549   // T1 = T0 DstPred ICmpCst
3550   Value *T1 = Builder.CreateICmp(DstPred, T0, ConstantInt::get(XType, ICmpCst));
3551 
3552   return T1;
3553 }
3554 
3555 // Given pattern:
3556 //   icmp eq/ne (and ((x shift Q), (y oppositeshift K))), 0
3557 // we should move shifts to the same hand of 'and', i.e. rewrite as
3558 //   icmp eq/ne (and (x shift (Q+K)), y), 0  iff (Q+K) u< bitwidth(x)
3559 // We are only interested in opposite logical shifts here.
3560 // One of the shifts can be truncated.
3561 // If we can, we want to end up creating 'lshr' shift.
3562 static Value *
3563 foldShiftIntoShiftInAnotherHandOfAndInICmp(ICmpInst &I, const SimplifyQuery SQ,
3564                                            InstCombiner::BuilderTy &Builder) {
3565   if (!I.isEquality() || !match(I.getOperand(1), m_Zero()) ||
3566       !I.getOperand(0)->hasOneUse())
3567     return nullptr;
3568 
3569   auto m_AnyLogicalShift = m_LogicalShift(m_Value(), m_Value());
3570 
3571   // Look for an 'and' of two logical shifts, one of which may be truncated.
3572   // We use m_TruncOrSelf() on the RHS to correctly handle commutative case.
3573   Instruction *XShift, *MaybeTruncation, *YShift;
3574   if (!match(
3575           I.getOperand(0),
3576           m_c_And(m_CombineAnd(m_AnyLogicalShift, m_Instruction(XShift)),
3577                   m_CombineAnd(m_TruncOrSelf(m_CombineAnd(
3578                                    m_AnyLogicalShift, m_Instruction(YShift))),
3579                                m_Instruction(MaybeTruncation)))))
3580     return nullptr;
3581 
3582   // We potentially looked past 'trunc', but only when matching YShift,
3583   // therefore YShift must have the widest type.
3584   Instruction *WidestShift = YShift;
3585   // Therefore XShift must have the shallowest type.
3586   // Or they both have identical types if there was no truncation.
3587   Instruction *NarrowestShift = XShift;
3588 
3589   Type *WidestTy = WidestShift->getType();
3590   Type *NarrowestTy = NarrowestShift->getType();
3591   assert(NarrowestTy == I.getOperand(0)->getType() &&
3592          "We did not look past any shifts while matching XShift though.");
3593   bool HadTrunc = WidestTy != I.getOperand(0)->getType();
3594 
3595   // If YShift is a 'lshr', swap the shifts around.
3596   if (match(YShift, m_LShr(m_Value(), m_Value())))
3597     std::swap(XShift, YShift);
3598 
3599   // The shifts must be in opposite directions.
3600   auto XShiftOpcode = XShift->getOpcode();
3601   if (XShiftOpcode == YShift->getOpcode())
3602     return nullptr; // Do not care about same-direction shifts here.
3603 
3604   Value *X, *XShAmt, *Y, *YShAmt;
3605   match(XShift, m_BinOp(m_Value(X), m_ZExtOrSelf(m_Value(XShAmt))));
3606   match(YShift, m_BinOp(m_Value(Y), m_ZExtOrSelf(m_Value(YShAmt))));
3607 
3608   // If one of the values being shifted is a constant, then we will end with
3609   // and+icmp, and [zext+]shift instrs will be constant-folded. If they are not,
3610   // however, we will need to ensure that we won't increase instruction count.
3611   if (!isa<Constant>(X) && !isa<Constant>(Y)) {
3612     // At least one of the hands of the 'and' should be one-use shift.
3613     if (!match(I.getOperand(0),
3614                m_c_And(m_OneUse(m_AnyLogicalShift), m_Value())))
3615       return nullptr;
3616     if (HadTrunc) {
3617       // Due to the 'trunc', we will need to widen X. For that either the old
3618       // 'trunc' or the shift amt in the non-truncated shift should be one-use.
3619       if (!MaybeTruncation->hasOneUse() &&
3620           !NarrowestShift->getOperand(1)->hasOneUse())
3621         return nullptr;
3622     }
3623   }
3624 
3625   // We have two shift amounts from two different shifts. The types of those
3626   // shift amounts may not match. If that's the case let's bailout now.
3627   if (XShAmt->getType() != YShAmt->getType())
3628     return nullptr;
3629 
3630   // As input, we have the following pattern:
3631   //   icmp eq/ne (and ((x shift Q), (y oppositeshift K))), 0
3632   // We want to rewrite that as:
3633   //   icmp eq/ne (and (x shift (Q+K)), y), 0  iff (Q+K) u< bitwidth(x)
3634   // While we know that originally (Q+K) would not overflow
3635   // (because  2 * (N-1) u<= iN -1), we have looked past extensions of
3636   // shift amounts. so it may now overflow in smaller bitwidth.
3637   // To ensure that does not happen, we need to ensure that the total maximal
3638   // shift amount is still representable in that smaller bit width.
3639   unsigned MaximalPossibleTotalShiftAmount =
3640       (WidestTy->getScalarSizeInBits() - 1) +
3641       (NarrowestTy->getScalarSizeInBits() - 1);
3642   APInt MaximalRepresentableShiftAmount =
3643       APInt::getAllOnesValue(XShAmt->getType()->getScalarSizeInBits());
3644   if (MaximalRepresentableShiftAmount.ult(MaximalPossibleTotalShiftAmount))
3645     return nullptr;
3646 
3647   // Can we fold (XShAmt+YShAmt) ?
3648   auto *NewShAmt = dyn_cast_or_null<Constant>(
3649       SimplifyAddInst(XShAmt, YShAmt, /*isNSW=*/false,
3650                       /*isNUW=*/false, SQ.getWithInstruction(&I)));
3651   if (!NewShAmt)
3652     return nullptr;
3653   NewShAmt = ConstantExpr::getZExtOrBitCast(NewShAmt, WidestTy);
3654   unsigned WidestBitWidth = WidestTy->getScalarSizeInBits();
3655 
3656   // Is the new shift amount smaller than the bit width?
3657   // FIXME: could also rely on ConstantRange.
3658   if (!match(NewShAmt,
3659              m_SpecificInt_ICMP(ICmpInst::Predicate::ICMP_ULT,
3660                                 APInt(WidestBitWidth, WidestBitWidth))))
3661     return nullptr;
3662 
3663   // An extra legality check is needed if we had trunc-of-lshr.
3664   if (HadTrunc && match(WidestShift, m_LShr(m_Value(), m_Value()))) {
3665     auto CanFold = [NewShAmt, WidestBitWidth, NarrowestShift, SQ,
3666                     WidestShift]() {
3667       // It isn't obvious whether it's worth it to analyze non-constants here.
3668       // Also, let's basically give up on non-splat cases, pessimizing vectors.
3669       // If *any* of these preconditions matches we can perform the fold.
3670       Constant *NewShAmtSplat = NewShAmt->getType()->isVectorTy()
3671                                     ? NewShAmt->getSplatValue()
3672                                     : NewShAmt;
3673       // If it's edge-case shift (by 0 or by WidestBitWidth-1) we can fold.
3674       if (NewShAmtSplat &&
3675           (NewShAmtSplat->isNullValue() ||
3676            NewShAmtSplat->getUniqueInteger() == WidestBitWidth - 1))
3677         return true;
3678       // We consider *min* leading zeros so a single outlier
3679       // blocks the transform as opposed to allowing it.
3680       if (auto *C = dyn_cast<Constant>(NarrowestShift->getOperand(0))) {
3681         KnownBits Known = computeKnownBits(C, SQ.DL);
3682         unsigned MinLeadZero = Known.countMinLeadingZeros();
3683         // If the value being shifted has at most lowest bit set we can fold.
3684         unsigned MaxActiveBits = Known.getBitWidth() - MinLeadZero;
3685         if (MaxActiveBits <= 1)
3686           return true;
3687         // Precondition:  NewShAmt u<= countLeadingZeros(C)
3688         if (NewShAmtSplat && NewShAmtSplat->getUniqueInteger().ule(MinLeadZero))
3689           return true;
3690       }
3691       if (auto *C = dyn_cast<Constant>(WidestShift->getOperand(0))) {
3692         KnownBits Known = computeKnownBits(C, SQ.DL);
3693         unsigned MinLeadZero = Known.countMinLeadingZeros();
3694         // If the value being shifted has at most lowest bit set we can fold.
3695         unsigned MaxActiveBits = Known.getBitWidth() - MinLeadZero;
3696         if (MaxActiveBits <= 1)
3697           return true;
3698         // Precondition:  ((WidestBitWidth-1)-NewShAmt) u<= countLeadingZeros(C)
3699         if (NewShAmtSplat) {
3700           APInt AdjNewShAmt =
3701               (WidestBitWidth - 1) - NewShAmtSplat->getUniqueInteger();
3702           if (AdjNewShAmt.ule(MinLeadZero))
3703             return true;
3704         }
3705       }
3706       return false; // Can't tell if it's ok.
3707     };
3708     if (!CanFold())
3709       return nullptr;
3710   }
3711 
3712   // All good, we can do this fold.
3713   X = Builder.CreateZExt(X, WidestTy);
3714   Y = Builder.CreateZExt(Y, WidestTy);
3715   // The shift is the same that was for X.
3716   Value *T0 = XShiftOpcode == Instruction::BinaryOps::LShr
3717                   ? Builder.CreateLShr(X, NewShAmt)
3718                   : Builder.CreateShl(X, NewShAmt);
3719   Value *T1 = Builder.CreateAnd(T0, Y);
3720   return Builder.CreateICmp(I.getPredicate(), T1,
3721                             Constant::getNullValue(WidestTy));
3722 }
3723 
3724 /// Fold
3725 ///   (-1 u/ x) u< y
3726 ///   ((x * y) u/ x) != y
3727 /// to
3728 ///   @llvm.umul.with.overflow(x, y) plus extraction of overflow bit
3729 /// Note that the comparison is commutative, while inverted (u>=, ==) predicate
3730 /// will mean that we are looking for the opposite answer.
3731 Value *InstCombinerImpl::foldUnsignedMultiplicationOverflowCheck(ICmpInst &I) {
3732   ICmpInst::Predicate Pred;
3733   Value *X, *Y;
3734   Instruction *Mul;
3735   bool NeedNegation;
3736   // Look for: (-1 u/ x) u</u>= y
3737   if (!I.isEquality() &&
3738       match(&I, m_c_ICmp(Pred, m_OneUse(m_UDiv(m_AllOnes(), m_Value(X))),
3739                          m_Value(Y)))) {
3740     Mul = nullptr;
3741 
3742     // Are we checking that overflow does not happen, or does happen?
3743     switch (Pred) {
3744     case ICmpInst::Predicate::ICMP_ULT:
3745       NeedNegation = false;
3746       break; // OK
3747     case ICmpInst::Predicate::ICMP_UGE:
3748       NeedNegation = true;
3749       break; // OK
3750     default:
3751       return nullptr; // Wrong predicate.
3752     }
3753   } else // Look for: ((x * y) u/ x) !=/== y
3754       if (I.isEquality() &&
3755           match(&I, m_c_ICmp(Pred, m_Value(Y),
3756                              m_OneUse(m_UDiv(m_CombineAnd(m_c_Mul(m_Deferred(Y),
3757                                                                   m_Value(X)),
3758                                                           m_Instruction(Mul)),
3759                                              m_Deferred(X)))))) {
3760     NeedNegation = Pred == ICmpInst::Predicate::ICMP_EQ;
3761   } else
3762     return nullptr;
3763 
3764   BuilderTy::InsertPointGuard Guard(Builder);
3765   // If the pattern included (x * y), we'll want to insert new instructions
3766   // right before that original multiplication so that we can replace it.
3767   bool MulHadOtherUses = Mul && !Mul->hasOneUse();
3768   if (MulHadOtherUses)
3769     Builder.SetInsertPoint(Mul);
3770 
3771   Function *F = Intrinsic::getDeclaration(
3772       I.getModule(), Intrinsic::umul_with_overflow, X->getType());
3773   CallInst *Call = Builder.CreateCall(F, {X, Y}, "umul");
3774 
3775   // If the multiplication was used elsewhere, to ensure that we don't leave
3776   // "duplicate" instructions, replace uses of that original multiplication
3777   // with the multiplication result from the with.overflow intrinsic.
3778   if (MulHadOtherUses)
3779     replaceInstUsesWith(*Mul, Builder.CreateExtractValue(Call, 0, "umul.val"));
3780 
3781   Value *Res = Builder.CreateExtractValue(Call, 1, "umul.ov");
3782   if (NeedNegation) // This technically increases instruction count.
3783     Res = Builder.CreateNot(Res, "umul.not.ov");
3784 
3785   // If we replaced the mul, erase it. Do this after all uses of Builder,
3786   // as the mul is used as insertion point.
3787   if (MulHadOtherUses)
3788     eraseInstFromFunction(*Mul);
3789 
3790   return Res;
3791 }
3792 
3793 static Instruction *foldICmpXNegX(ICmpInst &I) {
3794   CmpInst::Predicate Pred;
3795   Value *X;
3796   if (!match(&I, m_c_ICmp(Pred, m_NSWNeg(m_Value(X)), m_Deferred(X))))
3797     return nullptr;
3798 
3799   if (ICmpInst::isSigned(Pred))
3800     Pred = ICmpInst::getSwappedPredicate(Pred);
3801   else if (ICmpInst::isUnsigned(Pred))
3802     Pred = ICmpInst::getSignedPredicate(Pred);
3803   // else for equality-comparisons just keep the predicate.
3804 
3805   return ICmpInst::Create(Instruction::ICmp, Pred, X,
3806                           Constant::getNullValue(X->getType()), I.getName());
3807 }
3808 
3809 /// Try to fold icmp (binop), X or icmp X, (binop).
3810 /// TODO: A large part of this logic is duplicated in InstSimplify's
3811 /// simplifyICmpWithBinOp(). We should be able to share that and avoid the code
3812 /// duplication.
3813 Instruction *InstCombinerImpl::foldICmpBinOp(ICmpInst &I,
3814                                              const SimplifyQuery &SQ) {
3815   const SimplifyQuery Q = SQ.getWithInstruction(&I);
3816   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3817 
3818   // Special logic for binary operators.
3819   BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3820   BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3821   if (!BO0 && !BO1)
3822     return nullptr;
3823 
3824   if (Instruction *NewICmp = foldICmpXNegX(I))
3825     return NewICmp;
3826 
3827   const CmpInst::Predicate Pred = I.getPredicate();
3828   Value *X;
3829 
3830   // Convert add-with-unsigned-overflow comparisons into a 'not' with compare.
3831   // (Op1 + X) u</u>= Op1 --> ~Op1 u</u>= X
3832   if (match(Op0, m_OneUse(m_c_Add(m_Specific(Op1), m_Value(X)))) &&
3833       (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE))
3834     return new ICmpInst(Pred, Builder.CreateNot(Op1), X);
3835   // Op0 u>/u<= (Op0 + X) --> X u>/u<= ~Op0
3836   if (match(Op1, m_OneUse(m_c_Add(m_Specific(Op0), m_Value(X)))) &&
3837       (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE))
3838     return new ICmpInst(Pred, X, Builder.CreateNot(Op0));
3839 
3840   bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3841   if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3842     NoOp0WrapProblem =
3843         ICmpInst::isEquality(Pred) ||
3844         (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3845         (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3846   if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3847     NoOp1WrapProblem =
3848         ICmpInst::isEquality(Pred) ||
3849         (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3850         (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3851 
3852   // Analyze the case when either Op0 or Op1 is an add instruction.
3853   // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
3854   Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
3855   if (BO0 && BO0->getOpcode() == Instruction::Add) {
3856     A = BO0->getOperand(0);
3857     B = BO0->getOperand(1);
3858   }
3859   if (BO1 && BO1->getOpcode() == Instruction::Add) {
3860     C = BO1->getOperand(0);
3861     D = BO1->getOperand(1);
3862   }
3863 
3864   // icmp (A+B), A -> icmp B, 0 for equalities or if there is no overflow.
3865   // icmp (A+B), B -> icmp A, 0 for equalities or if there is no overflow.
3866   if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3867     return new ICmpInst(Pred, A == Op1 ? B : A,
3868                         Constant::getNullValue(Op1->getType()));
3869 
3870   // icmp C, (C+D) -> icmp 0, D for equalities or if there is no overflow.
3871   // icmp D, (C+D) -> icmp 0, C for equalities or if there is no overflow.
3872   if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3873     return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3874                         C == Op0 ? D : C);
3875 
3876   // icmp (A+B), (A+D) -> icmp B, D for equalities or if there is no overflow.
3877   if (A && C && (A == C || A == D || B == C || B == D) && NoOp0WrapProblem &&
3878       NoOp1WrapProblem) {
3879     // Determine Y and Z in the form icmp (X+Y), (X+Z).
3880     Value *Y, *Z;
3881     if (A == C) {
3882       // C + B == C + D  ->  B == D
3883       Y = B;
3884       Z = D;
3885     } else if (A == D) {
3886       // D + B == C + D  ->  B == C
3887       Y = B;
3888       Z = C;
3889     } else if (B == C) {
3890       // A + C == C + D  ->  A == D
3891       Y = A;
3892       Z = D;
3893     } else {
3894       assert(B == D);
3895       // A + D == C + D  ->  A == C
3896       Y = A;
3897       Z = C;
3898     }
3899     return new ICmpInst(Pred, Y, Z);
3900   }
3901 
3902   // icmp slt (A + -1), Op1 -> icmp sle A, Op1
3903   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3904       match(B, m_AllOnes()))
3905     return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3906 
3907   // icmp sge (A + -1), Op1 -> icmp sgt A, Op1
3908   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3909       match(B, m_AllOnes()))
3910     return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3911 
3912   // icmp sle (A + 1), Op1 -> icmp slt A, Op1
3913   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE && match(B, m_One()))
3914     return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3915 
3916   // icmp sgt (A + 1), Op1 -> icmp sge A, Op1
3917   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT && match(B, m_One()))
3918     return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3919 
3920   // icmp sgt Op0, (C + -1) -> icmp sge Op0, C
3921   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT &&
3922       match(D, m_AllOnes()))
3923     return new ICmpInst(CmpInst::ICMP_SGE, Op0, C);
3924 
3925   // icmp sle Op0, (C + -1) -> icmp slt Op0, C
3926   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE &&
3927       match(D, m_AllOnes()))
3928     return new ICmpInst(CmpInst::ICMP_SLT, Op0, C);
3929 
3930   // icmp sge Op0, (C + 1) -> icmp sgt Op0, C
3931   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE && match(D, m_One()))
3932     return new ICmpInst(CmpInst::ICMP_SGT, Op0, C);
3933 
3934   // icmp slt Op0, (C + 1) -> icmp sle Op0, C
3935   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT && match(D, m_One()))
3936     return new ICmpInst(CmpInst::ICMP_SLE, Op0, C);
3937 
3938   // TODO: The subtraction-related identities shown below also hold, but
3939   // canonicalization from (X -nuw 1) to (X + -1) means that the combinations
3940   // wouldn't happen even if they were implemented.
3941   //
3942   // icmp ult (A - 1), Op1 -> icmp ule A, Op1
3943   // icmp uge (A - 1), Op1 -> icmp ugt A, Op1
3944   // icmp ugt Op0, (C - 1) -> icmp uge Op0, C
3945   // icmp ule Op0, (C - 1) -> icmp ult Op0, C
3946 
3947   // icmp ule (A + 1), Op0 -> icmp ult A, Op1
3948   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_ULE && match(B, m_One()))
3949     return new ICmpInst(CmpInst::ICMP_ULT, A, Op1);
3950 
3951   // icmp ugt (A + 1), Op0 -> icmp uge A, Op1
3952   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_UGT && match(B, m_One()))
3953     return new ICmpInst(CmpInst::ICMP_UGE, A, Op1);
3954 
3955   // icmp uge Op0, (C + 1) -> icmp ugt Op0, C
3956   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_UGE && match(D, m_One()))
3957     return new ICmpInst(CmpInst::ICMP_UGT, Op0, C);
3958 
3959   // icmp ult Op0, (C + 1) -> icmp ule Op0, C
3960   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_ULT && match(D, m_One()))
3961     return new ICmpInst(CmpInst::ICMP_ULE, Op0, C);
3962 
3963   // if C1 has greater magnitude than C2:
3964   //  icmp (A + C1), (C + C2) -> icmp (A + C3), C
3965   //  s.t. C3 = C1 - C2
3966   //
3967   // if C2 has greater magnitude than C1:
3968   //  icmp (A + C1), (C + C2) -> icmp A, (C + C3)
3969   //  s.t. C3 = C2 - C1
3970   if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3971       (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3972     if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3973       if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3974         const APInt &AP1 = C1->getValue();
3975         const APInt &AP2 = C2->getValue();
3976         if (AP1.isNegative() == AP2.isNegative()) {
3977           APInt AP1Abs = C1->getValue().abs();
3978           APInt AP2Abs = C2->getValue().abs();
3979           if (AP1Abs.uge(AP2Abs)) {
3980             ConstantInt *C3 = Builder.getInt(AP1 - AP2);
3981             bool HasNUW = BO0->hasNoUnsignedWrap() && C3->getValue().ule(AP1);
3982             bool HasNSW = BO0->hasNoSignedWrap();
3983             Value *NewAdd = Builder.CreateAdd(A, C3, "", HasNUW, HasNSW);
3984             return new ICmpInst(Pred, NewAdd, C);
3985           } else {
3986             ConstantInt *C3 = Builder.getInt(AP2 - AP1);
3987             bool HasNUW = BO1->hasNoUnsignedWrap() && C3->getValue().ule(AP2);
3988             bool HasNSW = BO1->hasNoSignedWrap();
3989             Value *NewAdd = Builder.CreateAdd(C, C3, "", HasNUW, HasNSW);
3990             return new ICmpInst(Pred, A, NewAdd);
3991           }
3992         }
3993       }
3994 
3995   // Analyze the case when either Op0 or Op1 is a sub instruction.
3996   // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
3997   A = nullptr;
3998   B = nullptr;
3999   C = nullptr;
4000   D = nullptr;
4001   if (BO0 && BO0->getOpcode() == Instruction::Sub) {
4002     A = BO0->getOperand(0);
4003     B = BO0->getOperand(1);
4004   }
4005   if (BO1 && BO1->getOpcode() == Instruction::Sub) {
4006     C = BO1->getOperand(0);
4007     D = BO1->getOperand(1);
4008   }
4009 
4010   // icmp (A-B), A -> icmp 0, B for equalities or if there is no overflow.
4011   if (A == Op1 && NoOp0WrapProblem)
4012     return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
4013   // icmp C, (C-D) -> icmp D, 0 for equalities or if there is no overflow.
4014   if (C == Op0 && NoOp1WrapProblem)
4015     return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
4016 
4017   // Convert sub-with-unsigned-overflow comparisons into a comparison of args.
4018   // (A - B) u>/u<= A --> B u>/u<= A
4019   if (A == Op1 && (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE))
4020     return new ICmpInst(Pred, B, A);
4021   // C u</u>= (C - D) --> C u</u>= D
4022   if (C == Op0 && (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE))
4023     return new ICmpInst(Pred, C, D);
4024   // (A - B) u>=/u< A --> B u>/u<= A  iff B != 0
4025   if (A == Op1 && (Pred == ICmpInst::ICMP_UGE || Pred == ICmpInst::ICMP_ULT) &&
4026       isKnownNonZero(B, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
4027     return new ICmpInst(CmpInst::getFlippedStrictnessPredicate(Pred), B, A);
4028   // C u<=/u> (C - D) --> C u</u>= D  iff B != 0
4029   if (C == Op0 && (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_UGT) &&
4030       isKnownNonZero(D, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
4031     return new ICmpInst(CmpInst::getFlippedStrictnessPredicate(Pred), C, D);
4032 
4033   // icmp (A-B), (C-B) -> icmp A, C for equalities or if there is no overflow.
4034   if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem)
4035     return new ICmpInst(Pred, A, C);
4036 
4037   // icmp (A-B), (A-D) -> icmp D, B for equalities or if there is no overflow.
4038   if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem)
4039     return new ICmpInst(Pred, D, B);
4040 
4041   // icmp (0-X) < cst --> x > -cst
4042   if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
4043     Value *X;
4044     if (match(BO0, m_Neg(m_Value(X))))
4045       if (Constant *RHSC = dyn_cast<Constant>(Op1))
4046         if (RHSC->isNotMinSignedValue())
4047           return new ICmpInst(I.getSwappedPredicate(), X,
4048                               ConstantExpr::getNeg(RHSC));
4049   }
4050 
4051   {
4052     // Try to remove shared constant multiplier from equality comparison:
4053     // X * C == Y * C (with no overflowing/aliasing) --> X == Y
4054     Value *X, *Y;
4055     const APInt *C;
4056     if (match(Op0, m_Mul(m_Value(X), m_APInt(C))) && *C != 0 &&
4057         match(Op1, m_Mul(m_Value(Y), m_SpecificInt(*C))) && I.isEquality())
4058       if (!C->countTrailingZeros() ||
4059           (BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap()) ||
4060           (BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap()))
4061       return new ICmpInst(Pred, X, Y);
4062   }
4063 
4064   BinaryOperator *SRem = nullptr;
4065   // icmp (srem X, Y), Y
4066   if (BO0 && BO0->getOpcode() == Instruction::SRem && Op1 == BO0->getOperand(1))
4067     SRem = BO0;
4068   // icmp Y, (srem X, Y)
4069   else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
4070            Op0 == BO1->getOperand(1))
4071     SRem = BO1;
4072   if (SRem) {
4073     // We don't check hasOneUse to avoid increasing register pressure because
4074     // the value we use is the same value this instruction was already using.
4075     switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
4076     default:
4077       break;
4078     case ICmpInst::ICMP_EQ:
4079       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
4080     case ICmpInst::ICMP_NE:
4081       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4082     case ICmpInst::ICMP_SGT:
4083     case ICmpInst::ICMP_SGE:
4084       return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
4085                           Constant::getAllOnesValue(SRem->getType()));
4086     case ICmpInst::ICMP_SLT:
4087     case ICmpInst::ICMP_SLE:
4088       return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
4089                           Constant::getNullValue(SRem->getType()));
4090     }
4091   }
4092 
4093   if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() && BO0->hasOneUse() &&
4094       BO1->hasOneUse() && BO0->getOperand(1) == BO1->getOperand(1)) {
4095     switch (BO0->getOpcode()) {
4096     default:
4097       break;
4098     case Instruction::Add:
4099     case Instruction::Sub:
4100     case Instruction::Xor: {
4101       if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
4102         return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4103 
4104       const APInt *C;
4105       if (match(BO0->getOperand(1), m_APInt(C))) {
4106         // icmp u/s (a ^ signmask), (b ^ signmask) --> icmp s/u a, b
4107         if (C->isSignMask()) {
4108           ICmpInst::Predicate NewPred = I.getFlippedSignednessPredicate();
4109           return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0));
4110         }
4111 
4112         // icmp u/s (a ^ maxsignval), (b ^ maxsignval) --> icmp s/u' a, b
4113         if (BO0->getOpcode() == Instruction::Xor && C->isMaxSignedValue()) {
4114           ICmpInst::Predicate NewPred = I.getFlippedSignednessPredicate();
4115           NewPred = I.getSwappedPredicate(NewPred);
4116           return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0));
4117         }
4118       }
4119       break;
4120     }
4121     case Instruction::Mul: {
4122       if (!I.isEquality())
4123         break;
4124 
4125       const APInt *C;
4126       if (match(BO0->getOperand(1), m_APInt(C)) && !C->isNullValue() &&
4127           !C->isOneValue()) {
4128         // icmp eq/ne (X * C), (Y * C) --> icmp (X & Mask), (Y & Mask)
4129         // Mask = -1 >> count-trailing-zeros(C).
4130         if (unsigned TZs = C->countTrailingZeros()) {
4131           Constant *Mask = ConstantInt::get(
4132               BO0->getType(),
4133               APInt::getLowBitsSet(C->getBitWidth(), C->getBitWidth() - TZs));
4134           Value *And1 = Builder.CreateAnd(BO0->getOperand(0), Mask);
4135           Value *And2 = Builder.CreateAnd(BO1->getOperand(0), Mask);
4136           return new ICmpInst(Pred, And1, And2);
4137         }
4138       }
4139       break;
4140     }
4141     case Instruction::UDiv:
4142     case Instruction::LShr:
4143       if (I.isSigned() || !BO0->isExact() || !BO1->isExact())
4144         break;
4145       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4146 
4147     case Instruction::SDiv:
4148       if (!I.isEquality() || !BO0->isExact() || !BO1->isExact())
4149         break;
4150       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4151 
4152     case Instruction::AShr:
4153       if (!BO0->isExact() || !BO1->isExact())
4154         break;
4155       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4156 
4157     case Instruction::Shl: {
4158       bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
4159       bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
4160       if (!NUW && !NSW)
4161         break;
4162       if (!NSW && I.isSigned())
4163         break;
4164       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4165     }
4166     }
4167   }
4168 
4169   if (BO0) {
4170     // Transform  A & (L - 1) `ult` L --> L != 0
4171     auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
4172     auto BitwiseAnd = m_c_And(m_Value(), LSubOne);
4173 
4174     if (match(BO0, BitwiseAnd) && Pred == ICmpInst::ICMP_ULT) {
4175       auto *Zero = Constant::getNullValue(BO0->getType());
4176       return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
4177     }
4178   }
4179 
4180   if (Value *V = foldUnsignedMultiplicationOverflowCheck(I))
4181     return replaceInstUsesWith(I, V);
4182 
4183   if (Value *V = foldICmpWithLowBitMaskedVal(I, Builder))
4184     return replaceInstUsesWith(I, V);
4185 
4186   if (Value *V = foldICmpWithTruncSignExtendedVal(I, Builder))
4187     return replaceInstUsesWith(I, V);
4188 
4189   if (Value *V = foldShiftIntoShiftInAnotherHandOfAndInICmp(I, SQ, Builder))
4190     return replaceInstUsesWith(I, V);
4191 
4192   return nullptr;
4193 }
4194 
4195 /// Fold icmp Pred min|max(X, Y), X.
4196 static Instruction *foldICmpWithMinMax(ICmpInst &Cmp) {
4197   ICmpInst::Predicate Pred = Cmp.getPredicate();
4198   Value *Op0 = Cmp.getOperand(0);
4199   Value *X = Cmp.getOperand(1);
4200 
4201   // Canonicalize minimum or maximum operand to LHS of the icmp.
4202   if (match(X, m_c_SMin(m_Specific(Op0), m_Value())) ||
4203       match(X, m_c_SMax(m_Specific(Op0), m_Value())) ||
4204       match(X, m_c_UMin(m_Specific(Op0), m_Value())) ||
4205       match(X, m_c_UMax(m_Specific(Op0), m_Value()))) {
4206     std::swap(Op0, X);
4207     Pred = Cmp.getSwappedPredicate();
4208   }
4209 
4210   Value *Y;
4211   if (match(Op0, m_c_SMin(m_Specific(X), m_Value(Y)))) {
4212     // smin(X, Y)  == X --> X s<= Y
4213     // smin(X, Y) s>= X --> X s<= Y
4214     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SGE)
4215       return new ICmpInst(ICmpInst::ICMP_SLE, X, Y);
4216 
4217     // smin(X, Y) != X --> X s> Y
4218     // smin(X, Y) s< X --> X s> Y
4219     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SLT)
4220       return new ICmpInst(ICmpInst::ICMP_SGT, X, Y);
4221 
4222     // These cases should be handled in InstSimplify:
4223     // smin(X, Y) s<= X --> true
4224     // smin(X, Y) s> X --> false
4225     return nullptr;
4226   }
4227 
4228   if (match(Op0, m_c_SMax(m_Specific(X), m_Value(Y)))) {
4229     // smax(X, Y)  == X --> X s>= Y
4230     // smax(X, Y) s<= X --> X s>= Y
4231     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SLE)
4232       return new ICmpInst(ICmpInst::ICMP_SGE, X, Y);
4233 
4234     // smax(X, Y) != X --> X s< Y
4235     // smax(X, Y) s> X --> X s< Y
4236     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SGT)
4237       return new ICmpInst(ICmpInst::ICMP_SLT, X, Y);
4238 
4239     // These cases should be handled in InstSimplify:
4240     // smax(X, Y) s>= X --> true
4241     // smax(X, Y) s< X --> false
4242     return nullptr;
4243   }
4244 
4245   if (match(Op0, m_c_UMin(m_Specific(X), m_Value(Y)))) {
4246     // umin(X, Y)  == X --> X u<= Y
4247     // umin(X, Y) u>= X --> X u<= Y
4248     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_UGE)
4249       return new ICmpInst(ICmpInst::ICMP_ULE, X, Y);
4250 
4251     // umin(X, Y) != X --> X u> Y
4252     // umin(X, Y) u< X --> X u> Y
4253     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_ULT)
4254       return new ICmpInst(ICmpInst::ICMP_UGT, X, Y);
4255 
4256     // These cases should be handled in InstSimplify:
4257     // umin(X, Y) u<= X --> true
4258     // umin(X, Y) u> X --> false
4259     return nullptr;
4260   }
4261 
4262   if (match(Op0, m_c_UMax(m_Specific(X), m_Value(Y)))) {
4263     // umax(X, Y)  == X --> X u>= Y
4264     // umax(X, Y) u<= X --> X u>= Y
4265     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_ULE)
4266       return new ICmpInst(ICmpInst::ICMP_UGE, X, Y);
4267 
4268     // umax(X, Y) != X --> X u< Y
4269     // umax(X, Y) u> X --> X u< Y
4270     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_UGT)
4271       return new ICmpInst(ICmpInst::ICMP_ULT, X, Y);
4272 
4273     // These cases should be handled in InstSimplify:
4274     // umax(X, Y) u>= X --> true
4275     // umax(X, Y) u< X --> false
4276     return nullptr;
4277   }
4278 
4279   return nullptr;
4280 }
4281 
4282 Instruction *InstCombinerImpl::foldICmpEquality(ICmpInst &I) {
4283   if (!I.isEquality())
4284     return nullptr;
4285 
4286   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
4287   const CmpInst::Predicate Pred = I.getPredicate();
4288   Value *A, *B, *C, *D;
4289   if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
4290     if (A == Op1 || B == Op1) { // (A^B) == A  ->  B == 0
4291       Value *OtherVal = A == Op1 ? B : A;
4292       return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType()));
4293     }
4294 
4295     if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
4296       // A^c1 == C^c2 --> A == C^(c1^c2)
4297       ConstantInt *C1, *C2;
4298       if (match(B, m_ConstantInt(C1)) && match(D, m_ConstantInt(C2)) &&
4299           Op1->hasOneUse()) {
4300         Constant *NC = Builder.getInt(C1->getValue() ^ C2->getValue());
4301         Value *Xor = Builder.CreateXor(C, NC);
4302         return new ICmpInst(Pred, A, Xor);
4303       }
4304 
4305       // A^B == A^D -> B == D
4306       if (A == C)
4307         return new ICmpInst(Pred, B, D);
4308       if (A == D)
4309         return new ICmpInst(Pred, B, C);
4310       if (B == C)
4311         return new ICmpInst(Pred, A, D);
4312       if (B == D)
4313         return new ICmpInst(Pred, A, C);
4314     }
4315   }
4316 
4317   if (match(Op1, m_Xor(m_Value(A), m_Value(B))) && (A == Op0 || B == Op0)) {
4318     // A == (A^B)  ->  B == 0
4319     Value *OtherVal = A == Op0 ? B : A;
4320     return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType()));
4321   }
4322 
4323   // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
4324   if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
4325       match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
4326     Value *X = nullptr, *Y = nullptr, *Z = nullptr;
4327 
4328     if (A == C) {
4329       X = B;
4330       Y = D;
4331       Z = A;
4332     } else if (A == D) {
4333       X = B;
4334       Y = C;
4335       Z = A;
4336     } else if (B == C) {
4337       X = A;
4338       Y = D;
4339       Z = B;
4340     } else if (B == D) {
4341       X = A;
4342       Y = C;
4343       Z = B;
4344     }
4345 
4346     if (X) { // Build (X^Y) & Z
4347       Op1 = Builder.CreateXor(X, Y);
4348       Op1 = Builder.CreateAnd(Op1, Z);
4349       return new ICmpInst(Pred, Op1, Constant::getNullValue(Op1->getType()));
4350     }
4351   }
4352 
4353   // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
4354   // and       (B & (1<<X)-1) == (zext A) --> A == (trunc B)
4355   ConstantInt *Cst1;
4356   if ((Op0->hasOneUse() && match(Op0, m_ZExt(m_Value(A))) &&
4357        match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
4358       (Op1->hasOneUse() && match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
4359        match(Op1, m_ZExt(m_Value(A))))) {
4360     APInt Pow2 = Cst1->getValue() + 1;
4361     if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
4362         Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
4363       return new ICmpInst(Pred, A, Builder.CreateTrunc(B, A->getType()));
4364   }
4365 
4366   // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
4367   // For lshr and ashr pairs.
4368   if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4369        match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
4370       (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4371        match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
4372     unsigned TypeBits = Cst1->getBitWidth();
4373     unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4374     if (ShAmt < TypeBits && ShAmt != 0) {
4375       ICmpInst::Predicate NewPred =
4376           Pred == ICmpInst::ICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
4377       Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted");
4378       APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
4379       return new ICmpInst(NewPred, Xor, Builder.getInt(CmpVal));
4380     }
4381   }
4382 
4383   // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
4384   if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
4385       match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
4386     unsigned TypeBits = Cst1->getBitWidth();
4387     unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4388     if (ShAmt < TypeBits && ShAmt != 0) {
4389       Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted");
4390       APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
4391       Value *And = Builder.CreateAnd(Xor, Builder.getInt(AndVal),
4392                                       I.getName() + ".mask");
4393       return new ICmpInst(Pred, And, Constant::getNullValue(Cst1->getType()));
4394     }
4395   }
4396 
4397   // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
4398   // "icmp (and X, mask), cst"
4399   uint64_t ShAmt = 0;
4400   if (Op0->hasOneUse() &&
4401       match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A), m_ConstantInt(ShAmt))))) &&
4402       match(Op1, m_ConstantInt(Cst1)) &&
4403       // Only do this when A has multiple uses.  This is most important to do
4404       // when it exposes other optimizations.
4405       !A->hasOneUse()) {
4406     unsigned ASize = cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
4407 
4408     if (ShAmt < ASize) {
4409       APInt MaskV =
4410           APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
4411       MaskV <<= ShAmt;
4412 
4413       APInt CmpV = Cst1->getValue().zext(ASize);
4414       CmpV <<= ShAmt;
4415 
4416       Value *Mask = Builder.CreateAnd(A, Builder.getInt(MaskV));
4417       return new ICmpInst(Pred, Mask, Builder.getInt(CmpV));
4418     }
4419   }
4420 
4421   // If both operands are byte-swapped or bit-reversed, just compare the
4422   // original values.
4423   // TODO: Move this to a function similar to foldICmpIntrinsicWithConstant()
4424   // and handle more intrinsics.
4425   if ((match(Op0, m_BSwap(m_Value(A))) && match(Op1, m_BSwap(m_Value(B)))) ||
4426       (match(Op0, m_BitReverse(m_Value(A))) &&
4427        match(Op1, m_BitReverse(m_Value(B)))))
4428     return new ICmpInst(Pred, A, B);
4429 
4430   // Canonicalize checking for a power-of-2-or-zero value:
4431   // (A & (A-1)) == 0 --> ctpop(A) < 2 (two commuted variants)
4432   // ((A-1) & A) != 0 --> ctpop(A) > 1 (two commuted variants)
4433   if (!match(Op0, m_OneUse(m_c_And(m_Add(m_Value(A), m_AllOnes()),
4434                                    m_Deferred(A)))) ||
4435       !match(Op1, m_ZeroInt()))
4436     A = nullptr;
4437 
4438   // (A & -A) == A --> ctpop(A) < 2 (four commuted variants)
4439   // (-A & A) != A --> ctpop(A) > 1 (four commuted variants)
4440   if (match(Op0, m_OneUse(m_c_And(m_Neg(m_Specific(Op1)), m_Specific(Op1)))))
4441     A = Op1;
4442   else if (match(Op1,
4443                  m_OneUse(m_c_And(m_Neg(m_Specific(Op0)), m_Specific(Op0)))))
4444     A = Op0;
4445 
4446   if (A) {
4447     Type *Ty = A->getType();
4448     CallInst *CtPop = Builder.CreateUnaryIntrinsic(Intrinsic::ctpop, A);
4449     return Pred == ICmpInst::ICMP_EQ
4450         ? new ICmpInst(ICmpInst::ICMP_ULT, CtPop, ConstantInt::get(Ty, 2))
4451         : new ICmpInst(ICmpInst::ICMP_UGT, CtPop, ConstantInt::get(Ty, 1));
4452   }
4453 
4454   return nullptr;
4455 }
4456 
4457 static Instruction *foldICmpWithZextOrSext(ICmpInst &ICmp,
4458                                            InstCombiner::BuilderTy &Builder) {
4459   assert(isa<CastInst>(ICmp.getOperand(0)) && "Expected cast for operand 0");
4460   auto *CastOp0 = cast<CastInst>(ICmp.getOperand(0));
4461   Value *X;
4462   if (!match(CastOp0, m_ZExtOrSExt(m_Value(X))))
4463     return nullptr;
4464 
4465   bool IsSignedExt = CastOp0->getOpcode() == Instruction::SExt;
4466   bool IsSignedCmp = ICmp.isSigned();
4467   if (auto *CastOp1 = dyn_cast<CastInst>(ICmp.getOperand(1))) {
4468     // If the signedness of the two casts doesn't agree (i.e. one is a sext
4469     // and the other is a zext), then we can't handle this.
4470     // TODO: This is too strict. We can handle some predicates (equality?).
4471     if (CastOp0->getOpcode() != CastOp1->getOpcode())
4472       return nullptr;
4473 
4474     // Not an extension from the same type?
4475     Value *Y = CastOp1->getOperand(0);
4476     Type *XTy = X->getType(), *YTy = Y->getType();
4477     if (XTy != YTy) {
4478       // One of the casts must have one use because we are creating a new cast.
4479       if (!CastOp0->hasOneUse() && !CastOp1->hasOneUse())
4480         return nullptr;
4481       // Extend the narrower operand to the type of the wider operand.
4482       if (XTy->getScalarSizeInBits() < YTy->getScalarSizeInBits())
4483         X = Builder.CreateCast(CastOp0->getOpcode(), X, YTy);
4484       else if (YTy->getScalarSizeInBits() < XTy->getScalarSizeInBits())
4485         Y = Builder.CreateCast(CastOp0->getOpcode(), Y, XTy);
4486       else
4487         return nullptr;
4488     }
4489 
4490     // (zext X) == (zext Y) --> X == Y
4491     // (sext X) == (sext Y) --> X == Y
4492     if (ICmp.isEquality())
4493       return new ICmpInst(ICmp.getPredicate(), X, Y);
4494 
4495     // A signed comparison of sign extended values simplifies into a
4496     // signed comparison.
4497     if (IsSignedCmp && IsSignedExt)
4498       return new ICmpInst(ICmp.getPredicate(), X, Y);
4499 
4500     // The other three cases all fold into an unsigned comparison.
4501     return new ICmpInst(ICmp.getUnsignedPredicate(), X, Y);
4502   }
4503 
4504   // Below here, we are only folding a compare with constant.
4505   auto *C = dyn_cast<Constant>(ICmp.getOperand(1));
4506   if (!C)
4507     return nullptr;
4508 
4509   // Compute the constant that would happen if we truncated to SrcTy then
4510   // re-extended to DestTy.
4511   Type *SrcTy = CastOp0->getSrcTy();
4512   Type *DestTy = CastOp0->getDestTy();
4513   Constant *Res1 = ConstantExpr::getTrunc(C, SrcTy);
4514   Constant *Res2 = ConstantExpr::getCast(CastOp0->getOpcode(), Res1, DestTy);
4515 
4516   // If the re-extended constant didn't change...
4517   if (Res2 == C) {
4518     if (ICmp.isEquality())
4519       return new ICmpInst(ICmp.getPredicate(), X, Res1);
4520 
4521     // A signed comparison of sign extended values simplifies into a
4522     // signed comparison.
4523     if (IsSignedExt && IsSignedCmp)
4524       return new ICmpInst(ICmp.getPredicate(), X, Res1);
4525 
4526     // The other three cases all fold into an unsigned comparison.
4527     return new ICmpInst(ICmp.getUnsignedPredicate(), X, Res1);
4528   }
4529 
4530   // The re-extended constant changed, partly changed (in the case of a vector),
4531   // or could not be determined to be equal (in the case of a constant
4532   // expression), so the constant cannot be represented in the shorter type.
4533   // All the cases that fold to true or false will have already been handled
4534   // by SimplifyICmpInst, so only deal with the tricky case.
4535   if (IsSignedCmp || !IsSignedExt || !isa<ConstantInt>(C))
4536     return nullptr;
4537 
4538   // Is source op positive?
4539   // icmp ult (sext X), C --> icmp sgt X, -1
4540   if (ICmp.getPredicate() == ICmpInst::ICMP_ULT)
4541     return new ICmpInst(CmpInst::ICMP_SGT, X, Constant::getAllOnesValue(SrcTy));
4542 
4543   // Is source op negative?
4544   // icmp ugt (sext X), C --> icmp slt X, 0
4545   assert(ICmp.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
4546   return new ICmpInst(CmpInst::ICMP_SLT, X, Constant::getNullValue(SrcTy));
4547 }
4548 
4549 /// Handle icmp (cast x), (cast or constant).
4550 Instruction *InstCombinerImpl::foldICmpWithCastOp(ICmpInst &ICmp) {
4551   auto *CastOp0 = dyn_cast<CastInst>(ICmp.getOperand(0));
4552   if (!CastOp0)
4553     return nullptr;
4554   if (!isa<Constant>(ICmp.getOperand(1)) && !isa<CastInst>(ICmp.getOperand(1)))
4555     return nullptr;
4556 
4557   Value *Op0Src = CastOp0->getOperand(0);
4558   Type *SrcTy = CastOp0->getSrcTy();
4559   Type *DestTy = CastOp0->getDestTy();
4560 
4561   // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
4562   // integer type is the same size as the pointer type.
4563   auto CompatibleSizes = [&](Type *SrcTy, Type *DestTy) {
4564     if (isa<VectorType>(SrcTy)) {
4565       SrcTy = cast<VectorType>(SrcTy)->getElementType();
4566       DestTy = cast<VectorType>(DestTy)->getElementType();
4567     }
4568     return DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth();
4569   };
4570   if (CastOp0->getOpcode() == Instruction::PtrToInt &&
4571       CompatibleSizes(SrcTy, DestTy)) {
4572     Value *NewOp1 = nullptr;
4573     if (auto *PtrToIntOp1 = dyn_cast<PtrToIntOperator>(ICmp.getOperand(1))) {
4574       Value *PtrSrc = PtrToIntOp1->getOperand(0);
4575       if (PtrSrc->getType()->getPointerAddressSpace() ==
4576           Op0Src->getType()->getPointerAddressSpace()) {
4577         NewOp1 = PtrToIntOp1->getOperand(0);
4578         // If the pointer types don't match, insert a bitcast.
4579         if (Op0Src->getType() != NewOp1->getType())
4580           NewOp1 = Builder.CreateBitCast(NewOp1, Op0Src->getType());
4581       }
4582     } else if (auto *RHSC = dyn_cast<Constant>(ICmp.getOperand(1))) {
4583       NewOp1 = ConstantExpr::getIntToPtr(RHSC, SrcTy);
4584     }
4585 
4586     if (NewOp1)
4587       return new ICmpInst(ICmp.getPredicate(), Op0Src, NewOp1);
4588   }
4589 
4590   return foldICmpWithZextOrSext(ICmp, Builder);
4591 }
4592 
4593 static bool isNeutralValue(Instruction::BinaryOps BinaryOp, Value *RHS) {
4594   switch (BinaryOp) {
4595     default:
4596       llvm_unreachable("Unsupported binary op");
4597     case Instruction::Add:
4598     case Instruction::Sub:
4599       return match(RHS, m_Zero());
4600     case Instruction::Mul:
4601       return match(RHS, m_One());
4602   }
4603 }
4604 
4605 OverflowResult
4606 InstCombinerImpl::computeOverflow(Instruction::BinaryOps BinaryOp,
4607                                   bool IsSigned, Value *LHS, Value *RHS,
4608                                   Instruction *CxtI) const {
4609   switch (BinaryOp) {
4610     default:
4611       llvm_unreachable("Unsupported binary op");
4612     case Instruction::Add:
4613       if (IsSigned)
4614         return computeOverflowForSignedAdd(LHS, RHS, CxtI);
4615       else
4616         return computeOverflowForUnsignedAdd(LHS, RHS, CxtI);
4617     case Instruction::Sub:
4618       if (IsSigned)
4619         return computeOverflowForSignedSub(LHS, RHS, CxtI);
4620       else
4621         return computeOverflowForUnsignedSub(LHS, RHS, CxtI);
4622     case Instruction::Mul:
4623       if (IsSigned)
4624         return computeOverflowForSignedMul(LHS, RHS, CxtI);
4625       else
4626         return computeOverflowForUnsignedMul(LHS, RHS, CxtI);
4627   }
4628 }
4629 
4630 bool InstCombinerImpl::OptimizeOverflowCheck(Instruction::BinaryOps BinaryOp,
4631                                              bool IsSigned, Value *LHS,
4632                                              Value *RHS, Instruction &OrigI,
4633                                              Value *&Result,
4634                                              Constant *&Overflow) {
4635   if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
4636     std::swap(LHS, RHS);
4637 
4638   // If the overflow check was an add followed by a compare, the insertion point
4639   // may be pointing to the compare.  We want to insert the new instructions
4640   // before the add in case there are uses of the add between the add and the
4641   // compare.
4642   Builder.SetInsertPoint(&OrigI);
4643 
4644   Type *OverflowTy = Type::getInt1Ty(LHS->getContext());
4645   if (auto *LHSTy = dyn_cast<VectorType>(LHS->getType()))
4646     OverflowTy = VectorType::get(OverflowTy, LHSTy->getElementCount());
4647 
4648   if (isNeutralValue(BinaryOp, RHS)) {
4649     Result = LHS;
4650     Overflow = ConstantInt::getFalse(OverflowTy);
4651     return true;
4652   }
4653 
4654   switch (computeOverflow(BinaryOp, IsSigned, LHS, RHS, &OrigI)) {
4655     case OverflowResult::MayOverflow:
4656       return false;
4657     case OverflowResult::AlwaysOverflowsLow:
4658     case OverflowResult::AlwaysOverflowsHigh:
4659       Result = Builder.CreateBinOp(BinaryOp, LHS, RHS);
4660       Result->takeName(&OrigI);
4661       Overflow = ConstantInt::getTrue(OverflowTy);
4662       return true;
4663     case OverflowResult::NeverOverflows:
4664       Result = Builder.CreateBinOp(BinaryOp, LHS, RHS);
4665       Result->takeName(&OrigI);
4666       Overflow = ConstantInt::getFalse(OverflowTy);
4667       if (auto *Inst = dyn_cast<Instruction>(Result)) {
4668         if (IsSigned)
4669           Inst->setHasNoSignedWrap();
4670         else
4671           Inst->setHasNoUnsignedWrap();
4672       }
4673       return true;
4674   }
4675 
4676   llvm_unreachable("Unexpected overflow result");
4677 }
4678 
4679 /// Recognize and process idiom involving test for multiplication
4680 /// overflow.
4681 ///
4682 /// The caller has matched a pattern of the form:
4683 ///   I = cmp u (mul(zext A, zext B), V
4684 /// The function checks if this is a test for overflow and if so replaces
4685 /// multiplication with call to 'mul.with.overflow' intrinsic.
4686 ///
4687 /// \param I Compare instruction.
4688 /// \param MulVal Result of 'mult' instruction.  It is one of the arguments of
4689 ///               the compare instruction.  Must be of integer type.
4690 /// \param OtherVal The other argument of compare instruction.
4691 /// \returns Instruction which must replace the compare instruction, NULL if no
4692 ///          replacement required.
4693 static Instruction *processUMulZExtIdiom(ICmpInst &I, Value *MulVal,
4694                                          Value *OtherVal,
4695                                          InstCombinerImpl &IC) {
4696   // Don't bother doing this transformation for pointers, don't do it for
4697   // vectors.
4698   if (!isa<IntegerType>(MulVal->getType()))
4699     return nullptr;
4700 
4701   assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
4702   assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
4703   auto *MulInstr = dyn_cast<Instruction>(MulVal);
4704   if (!MulInstr)
4705     return nullptr;
4706   assert(MulInstr->getOpcode() == Instruction::Mul);
4707 
4708   auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
4709        *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
4710   assert(LHS->getOpcode() == Instruction::ZExt);
4711   assert(RHS->getOpcode() == Instruction::ZExt);
4712   Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
4713 
4714   // Calculate type and width of the result produced by mul.with.overflow.
4715   Type *TyA = A->getType(), *TyB = B->getType();
4716   unsigned WidthA = TyA->getPrimitiveSizeInBits(),
4717            WidthB = TyB->getPrimitiveSizeInBits();
4718   unsigned MulWidth;
4719   Type *MulType;
4720   if (WidthB > WidthA) {
4721     MulWidth = WidthB;
4722     MulType = TyB;
4723   } else {
4724     MulWidth = WidthA;
4725     MulType = TyA;
4726   }
4727 
4728   // In order to replace the original mul with a narrower mul.with.overflow,
4729   // all uses must ignore upper bits of the product.  The number of used low
4730   // bits must be not greater than the width of mul.with.overflow.
4731   if (MulVal->hasNUsesOrMore(2))
4732     for (User *U : MulVal->users()) {
4733       if (U == &I)
4734         continue;
4735       if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
4736         // Check if truncation ignores bits above MulWidth.
4737         unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
4738         if (TruncWidth > MulWidth)
4739           return nullptr;
4740       } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
4741         // Check if AND ignores bits above MulWidth.
4742         if (BO->getOpcode() != Instruction::And)
4743           return nullptr;
4744         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
4745           const APInt &CVal = CI->getValue();
4746           if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
4747             return nullptr;
4748         } else {
4749           // In this case we could have the operand of the binary operation
4750           // being defined in another block, and performing the replacement
4751           // could break the dominance relation.
4752           return nullptr;
4753         }
4754       } else {
4755         // Other uses prohibit this transformation.
4756         return nullptr;
4757       }
4758     }
4759 
4760   // Recognize patterns
4761   switch (I.getPredicate()) {
4762   case ICmpInst::ICMP_EQ:
4763   case ICmpInst::ICMP_NE:
4764     // Recognize pattern:
4765     //   mulval = mul(zext A, zext B)
4766     //   cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
4767     ConstantInt *CI;
4768     Value *ValToMask;
4769     if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
4770       if (ValToMask != MulVal)
4771         return nullptr;
4772       const APInt &CVal = CI->getValue() + 1;
4773       if (CVal.isPowerOf2()) {
4774         unsigned MaskWidth = CVal.logBase2();
4775         if (MaskWidth == MulWidth)
4776           break; // Recognized
4777       }
4778     }
4779     return nullptr;
4780 
4781   case ICmpInst::ICMP_UGT:
4782     // Recognize pattern:
4783     //   mulval = mul(zext A, zext B)
4784     //   cmp ugt mulval, max
4785     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4786       APInt MaxVal = APInt::getMaxValue(MulWidth);
4787       MaxVal = MaxVal.zext(CI->getBitWidth());
4788       if (MaxVal.eq(CI->getValue()))
4789         break; // Recognized
4790     }
4791     return nullptr;
4792 
4793   case ICmpInst::ICMP_UGE:
4794     // Recognize pattern:
4795     //   mulval = mul(zext A, zext B)
4796     //   cmp uge mulval, max+1
4797     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4798       APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
4799       if (MaxVal.eq(CI->getValue()))
4800         break; // Recognized
4801     }
4802     return nullptr;
4803 
4804   case ICmpInst::ICMP_ULE:
4805     // Recognize pattern:
4806     //   mulval = mul(zext A, zext B)
4807     //   cmp ule mulval, max
4808     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4809       APInt MaxVal = APInt::getMaxValue(MulWidth);
4810       MaxVal = MaxVal.zext(CI->getBitWidth());
4811       if (MaxVal.eq(CI->getValue()))
4812         break; // Recognized
4813     }
4814     return nullptr;
4815 
4816   case ICmpInst::ICMP_ULT:
4817     // Recognize pattern:
4818     //   mulval = mul(zext A, zext B)
4819     //   cmp ule mulval, max + 1
4820     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4821       APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
4822       if (MaxVal.eq(CI->getValue()))
4823         break; // Recognized
4824     }
4825     return nullptr;
4826 
4827   default:
4828     return nullptr;
4829   }
4830 
4831   InstCombiner::BuilderTy &Builder = IC.Builder;
4832   Builder.SetInsertPoint(MulInstr);
4833 
4834   // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
4835   Value *MulA = A, *MulB = B;
4836   if (WidthA < MulWidth)
4837     MulA = Builder.CreateZExt(A, MulType);
4838   if (WidthB < MulWidth)
4839     MulB = Builder.CreateZExt(B, MulType);
4840   Function *F = Intrinsic::getDeclaration(
4841       I.getModule(), Intrinsic::umul_with_overflow, MulType);
4842   CallInst *Call = Builder.CreateCall(F, {MulA, MulB}, "umul");
4843   IC.addToWorklist(MulInstr);
4844 
4845   // If there are uses of mul result other than the comparison, we know that
4846   // they are truncation or binary AND. Change them to use result of
4847   // mul.with.overflow and adjust properly mask/size.
4848   if (MulVal->hasNUsesOrMore(2)) {
4849     Value *Mul = Builder.CreateExtractValue(Call, 0, "umul.value");
4850     for (User *U : make_early_inc_range(MulVal->users())) {
4851       if (U == &I || U == OtherVal)
4852         continue;
4853       if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
4854         if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
4855           IC.replaceInstUsesWith(*TI, Mul);
4856         else
4857           TI->setOperand(0, Mul);
4858       } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
4859         assert(BO->getOpcode() == Instruction::And);
4860         // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
4861         ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
4862         APInt ShortMask = CI->getValue().trunc(MulWidth);
4863         Value *ShortAnd = Builder.CreateAnd(Mul, ShortMask);
4864         Value *Zext = Builder.CreateZExt(ShortAnd, BO->getType());
4865         IC.replaceInstUsesWith(*BO, Zext);
4866       } else {
4867         llvm_unreachable("Unexpected Binary operation");
4868       }
4869       IC.addToWorklist(cast<Instruction>(U));
4870     }
4871   }
4872   if (isa<Instruction>(OtherVal))
4873     IC.addToWorklist(cast<Instruction>(OtherVal));
4874 
4875   // The original icmp gets replaced with the overflow value, maybe inverted
4876   // depending on predicate.
4877   bool Inverse = false;
4878   switch (I.getPredicate()) {
4879   case ICmpInst::ICMP_NE:
4880     break;
4881   case ICmpInst::ICMP_EQ:
4882     Inverse = true;
4883     break;
4884   case ICmpInst::ICMP_UGT:
4885   case ICmpInst::ICMP_UGE:
4886     if (I.getOperand(0) == MulVal)
4887       break;
4888     Inverse = true;
4889     break;
4890   case ICmpInst::ICMP_ULT:
4891   case ICmpInst::ICMP_ULE:
4892     if (I.getOperand(1) == MulVal)
4893       break;
4894     Inverse = true;
4895     break;
4896   default:
4897     llvm_unreachable("Unexpected predicate");
4898   }
4899   if (Inverse) {
4900     Value *Res = Builder.CreateExtractValue(Call, 1);
4901     return BinaryOperator::CreateNot(Res);
4902   }
4903 
4904   return ExtractValueInst::Create(Call, 1);
4905 }
4906 
4907 /// When performing a comparison against a constant, it is possible that not all
4908 /// the bits in the LHS are demanded. This helper method computes the mask that
4909 /// IS demanded.
4910 static APInt getDemandedBitsLHSMask(ICmpInst &I, unsigned BitWidth) {
4911   const APInt *RHS;
4912   if (!match(I.getOperand(1), m_APInt(RHS)))
4913     return APInt::getAllOnesValue(BitWidth);
4914 
4915   // If this is a normal comparison, it demands all bits. If it is a sign bit
4916   // comparison, it only demands the sign bit.
4917   bool UnusedBit;
4918   if (InstCombiner::isSignBitCheck(I.getPredicate(), *RHS, UnusedBit))
4919     return APInt::getSignMask(BitWidth);
4920 
4921   switch (I.getPredicate()) {
4922   // For a UGT comparison, we don't care about any bits that
4923   // correspond to the trailing ones of the comparand.  The value of these
4924   // bits doesn't impact the outcome of the comparison, because any value
4925   // greater than the RHS must differ in a bit higher than these due to carry.
4926   case ICmpInst::ICMP_UGT:
4927     return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingOnes());
4928 
4929   // Similarly, for a ULT comparison, we don't care about the trailing zeros.
4930   // Any value less than the RHS must differ in a higher bit because of carries.
4931   case ICmpInst::ICMP_ULT:
4932     return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingZeros());
4933 
4934   default:
4935     return APInt::getAllOnesValue(BitWidth);
4936   }
4937 }
4938 
4939 /// Check if the order of \p Op0 and \p Op1 as operands in an ICmpInst
4940 /// should be swapped.
4941 /// The decision is based on how many times these two operands are reused
4942 /// as subtract operands and their positions in those instructions.
4943 /// The rationale is that several architectures use the same instruction for
4944 /// both subtract and cmp. Thus, it is better if the order of those operands
4945 /// match.
4946 /// \return true if Op0 and Op1 should be swapped.
4947 static bool swapMayExposeCSEOpportunities(const Value *Op0, const Value *Op1) {
4948   // Filter out pointer values as those cannot appear directly in subtract.
4949   // FIXME: we may want to go through inttoptrs or bitcasts.
4950   if (Op0->getType()->isPointerTy())
4951     return false;
4952   // If a subtract already has the same operands as a compare, swapping would be
4953   // bad. If a subtract has the same operands as a compare but in reverse order,
4954   // then swapping is good.
4955   int GoodToSwap = 0;
4956   for (const User *U : Op0->users()) {
4957     if (match(U, m_Sub(m_Specific(Op1), m_Specific(Op0))))
4958       GoodToSwap++;
4959     else if (match(U, m_Sub(m_Specific(Op0), m_Specific(Op1))))
4960       GoodToSwap--;
4961   }
4962   return GoodToSwap > 0;
4963 }
4964 
4965 /// Check that one use is in the same block as the definition and all
4966 /// other uses are in blocks dominated by a given block.
4967 ///
4968 /// \param DI Definition
4969 /// \param UI Use
4970 /// \param DB Block that must dominate all uses of \p DI outside
4971 ///           the parent block
4972 /// \return true when \p UI is the only use of \p DI in the parent block
4973 /// and all other uses of \p DI are in blocks dominated by \p DB.
4974 ///
4975 bool InstCombinerImpl::dominatesAllUses(const Instruction *DI,
4976                                         const Instruction *UI,
4977                                         const BasicBlock *DB) const {
4978   assert(DI && UI && "Instruction not defined\n");
4979   // Ignore incomplete definitions.
4980   if (!DI->getParent())
4981     return false;
4982   // DI and UI must be in the same block.
4983   if (DI->getParent() != UI->getParent())
4984     return false;
4985   // Protect from self-referencing blocks.
4986   if (DI->getParent() == DB)
4987     return false;
4988   for (const User *U : DI->users()) {
4989     auto *Usr = cast<Instruction>(U);
4990     if (Usr != UI && !DT.dominates(DB, Usr->getParent()))
4991       return false;
4992   }
4993   return true;
4994 }
4995 
4996 /// Return true when the instruction sequence within a block is select-cmp-br.
4997 static bool isChainSelectCmpBranch(const SelectInst *SI) {
4998   const BasicBlock *BB = SI->getParent();
4999   if (!BB)
5000     return false;
5001   auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
5002   if (!BI || BI->getNumSuccessors() != 2)
5003     return false;
5004   auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
5005   if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
5006     return false;
5007   return true;
5008 }
5009 
5010 /// True when a select result is replaced by one of its operands
5011 /// in select-icmp sequence. This will eventually result in the elimination
5012 /// of the select.
5013 ///
5014 /// \param SI    Select instruction
5015 /// \param Icmp  Compare instruction
5016 /// \param SIOpd Operand that replaces the select
5017 ///
5018 /// Notes:
5019 /// - The replacement is global and requires dominator information
5020 /// - The caller is responsible for the actual replacement
5021 ///
5022 /// Example:
5023 ///
5024 /// entry:
5025 ///  %4 = select i1 %3, %C* %0, %C* null
5026 ///  %5 = icmp eq %C* %4, null
5027 ///  br i1 %5, label %9, label %7
5028 ///  ...
5029 ///  ; <label>:7                                       ; preds = %entry
5030 ///  %8 = getelementptr inbounds %C* %4, i64 0, i32 0
5031 ///  ...
5032 ///
5033 /// can be transformed to
5034 ///
5035 ///  %5 = icmp eq %C* %0, null
5036 ///  %6 = select i1 %3, i1 %5, i1 true
5037 ///  br i1 %6, label %9, label %7
5038 ///  ...
5039 ///  ; <label>:7                                       ; preds = %entry
5040 ///  %8 = getelementptr inbounds %C* %0, i64 0, i32 0  // replace by %0!
5041 ///
5042 /// Similar when the first operand of the select is a constant or/and
5043 /// the compare is for not equal rather than equal.
5044 ///
5045 /// NOTE: The function is only called when the select and compare constants
5046 /// are equal, the optimization can work only for EQ predicates. This is not a
5047 /// major restriction since a NE compare should be 'normalized' to an equal
5048 /// compare, which usually happens in the combiner and test case
5049 /// select-cmp-br.ll checks for it.
5050 bool InstCombinerImpl::replacedSelectWithOperand(SelectInst *SI,
5051                                                  const ICmpInst *Icmp,
5052                                                  const unsigned SIOpd) {
5053   assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
5054   if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
5055     BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
5056     // The check for the single predecessor is not the best that can be
5057     // done. But it protects efficiently against cases like when SI's
5058     // home block has two successors, Succ and Succ1, and Succ1 predecessor
5059     // of Succ. Then SI can't be replaced by SIOpd because the use that gets
5060     // replaced can be reached on either path. So the uniqueness check
5061     // guarantees that the path all uses of SI (outside SI's parent) are on
5062     // is disjoint from all other paths out of SI. But that information
5063     // is more expensive to compute, and the trade-off here is in favor
5064     // of compile-time. It should also be noticed that we check for a single
5065     // predecessor and not only uniqueness. This to handle the situation when
5066     // Succ and Succ1 points to the same basic block.
5067     if (Succ->getSinglePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
5068       NumSel++;
5069       SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
5070       return true;
5071     }
5072   }
5073   return false;
5074 }
5075 
5076 /// Try to fold the comparison based on range information we can get by checking
5077 /// whether bits are known to be zero or one in the inputs.
5078 Instruction *InstCombinerImpl::foldICmpUsingKnownBits(ICmpInst &I) {
5079   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
5080   Type *Ty = Op0->getType();
5081   ICmpInst::Predicate Pred = I.getPredicate();
5082 
5083   // Get scalar or pointer size.
5084   unsigned BitWidth = Ty->isIntOrIntVectorTy()
5085                           ? Ty->getScalarSizeInBits()
5086                           : DL.getPointerTypeSizeInBits(Ty->getScalarType());
5087 
5088   if (!BitWidth)
5089     return nullptr;
5090 
5091   KnownBits Op0Known(BitWidth);
5092   KnownBits Op1Known(BitWidth);
5093 
5094   if (SimplifyDemandedBits(&I, 0,
5095                            getDemandedBitsLHSMask(I, BitWidth),
5096                            Op0Known, 0))
5097     return &I;
5098 
5099   if (SimplifyDemandedBits(&I, 1, APInt::getAllOnesValue(BitWidth),
5100                            Op1Known, 0))
5101     return &I;
5102 
5103   // Given the known and unknown bits, compute a range that the LHS could be
5104   // in.  Compute the Min, Max and RHS values based on the known bits. For the
5105   // EQ and NE we use unsigned values.
5106   APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
5107   APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
5108   if (I.isSigned()) {
5109     Op0Min = Op0Known.getSignedMinValue();
5110     Op0Max = Op0Known.getSignedMaxValue();
5111     Op1Min = Op1Known.getSignedMinValue();
5112     Op1Max = Op1Known.getSignedMaxValue();
5113   } else {
5114     Op0Min = Op0Known.getMinValue();
5115     Op0Max = Op0Known.getMaxValue();
5116     Op1Min = Op1Known.getMinValue();
5117     Op1Max = Op1Known.getMaxValue();
5118   }
5119 
5120   // If Min and Max are known to be the same, then SimplifyDemandedBits figured
5121   // out that the LHS or RHS is a constant. Constant fold this now, so that
5122   // code below can assume that Min != Max.
5123   if (!isa<Constant>(Op0) && Op0Min == Op0Max)
5124     return new ICmpInst(Pred, ConstantExpr::getIntegerValue(Ty, Op0Min), Op1);
5125   if (!isa<Constant>(Op1) && Op1Min == Op1Max)
5126     return new ICmpInst(Pred, Op0, ConstantExpr::getIntegerValue(Ty, Op1Min));
5127 
5128   // Based on the range information we know about the LHS, see if we can
5129   // simplify this comparison.  For example, (x&4) < 8 is always true.
5130   switch (Pred) {
5131   default:
5132     llvm_unreachable("Unknown icmp opcode!");
5133   case ICmpInst::ICMP_EQ:
5134   case ICmpInst::ICMP_NE: {
5135     if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
5136       return replaceInstUsesWith(
5137           I, ConstantInt::getBool(I.getType(), Pred == CmpInst::ICMP_NE));
5138 
5139     // If all bits are known zero except for one, then we know at most one bit
5140     // is set. If the comparison is against zero, then this is a check to see if
5141     // *that* bit is set.
5142     APInt Op0KnownZeroInverted = ~Op0Known.Zero;
5143     if (Op1Known.isZero()) {
5144       // If the LHS is an AND with the same constant, look through it.
5145       Value *LHS = nullptr;
5146       const APInt *LHSC;
5147       if (!match(Op0, m_And(m_Value(LHS), m_APInt(LHSC))) ||
5148           *LHSC != Op0KnownZeroInverted)
5149         LHS = Op0;
5150 
5151       Value *X;
5152       if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
5153         APInt ValToCheck = Op0KnownZeroInverted;
5154         Type *XTy = X->getType();
5155         if (ValToCheck.isPowerOf2()) {
5156           // ((1 << X) & 8) == 0 -> X != 3
5157           // ((1 << X) & 8) != 0 -> X == 3
5158           auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros());
5159           auto NewPred = ICmpInst::getInversePredicate(Pred);
5160           return new ICmpInst(NewPred, X, CmpC);
5161         } else if ((++ValToCheck).isPowerOf2()) {
5162           // ((1 << X) & 7) == 0 -> X >= 3
5163           // ((1 << X) & 7) != 0 -> X  < 3
5164           auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros());
5165           auto NewPred =
5166               Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGE : CmpInst::ICMP_ULT;
5167           return new ICmpInst(NewPred, X, CmpC);
5168         }
5169       }
5170 
5171       // Check if the LHS is 8 >>u x and the result is a power of 2 like 1.
5172       const APInt *CI;
5173       if (Op0KnownZeroInverted.isOneValue() &&
5174           match(LHS, m_LShr(m_Power2(CI), m_Value(X)))) {
5175         // ((8 >>u X) & 1) == 0 -> X != 3
5176         // ((8 >>u X) & 1) != 0 -> X == 3
5177         unsigned CmpVal = CI->countTrailingZeros();
5178         auto NewPred = ICmpInst::getInversePredicate(Pred);
5179         return new ICmpInst(NewPred, X, ConstantInt::get(X->getType(), CmpVal));
5180       }
5181     }
5182     break;
5183   }
5184   case ICmpInst::ICMP_ULT: {
5185     if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
5186       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5187     if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
5188       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5189     if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
5190       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5191 
5192     const APInt *CmpC;
5193     if (match(Op1, m_APInt(CmpC))) {
5194       // A <u C -> A == C-1 if min(A)+1 == C
5195       if (*CmpC == Op0Min + 1)
5196         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5197                             ConstantInt::get(Op1->getType(), *CmpC - 1));
5198       // X <u C --> X == 0, if the number of zero bits in the bottom of X
5199       // exceeds the log2 of C.
5200       if (Op0Known.countMinTrailingZeros() >= CmpC->ceilLogBase2())
5201         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5202                             Constant::getNullValue(Op1->getType()));
5203     }
5204     break;
5205   }
5206   case ICmpInst::ICMP_UGT: {
5207     if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
5208       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5209     if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
5210       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5211     if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
5212       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5213 
5214     const APInt *CmpC;
5215     if (match(Op1, m_APInt(CmpC))) {
5216       // A >u C -> A == C+1 if max(a)-1 == C
5217       if (*CmpC == Op0Max - 1)
5218         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5219                             ConstantInt::get(Op1->getType(), *CmpC + 1));
5220       // X >u C --> X != 0, if the number of zero bits in the bottom of X
5221       // exceeds the log2 of C.
5222       if (Op0Known.countMinTrailingZeros() >= CmpC->getActiveBits())
5223         return new ICmpInst(ICmpInst::ICMP_NE, Op0,
5224                             Constant::getNullValue(Op1->getType()));
5225     }
5226     break;
5227   }
5228   case ICmpInst::ICMP_SLT: {
5229     if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
5230       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5231     if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
5232       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5233     if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
5234       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5235     const APInt *CmpC;
5236     if (match(Op1, m_APInt(CmpC))) {
5237       if (*CmpC == Op0Min + 1) // A <s C -> A == C-1 if min(A)+1 == C
5238         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5239                             ConstantInt::get(Op1->getType(), *CmpC - 1));
5240     }
5241     break;
5242   }
5243   case ICmpInst::ICMP_SGT: {
5244     if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
5245       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5246     if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
5247       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5248     if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
5249       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5250     const APInt *CmpC;
5251     if (match(Op1, m_APInt(CmpC))) {
5252       if (*CmpC == Op0Max - 1) // A >s C -> A == C+1 if max(A)-1 == C
5253         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5254                             ConstantInt::get(Op1->getType(), *CmpC + 1));
5255     }
5256     break;
5257   }
5258   case ICmpInst::ICMP_SGE:
5259     assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
5260     if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
5261       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5262     if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
5263       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5264     if (Op1Min == Op0Max) // A >=s B -> A == B if max(A) == min(B)
5265       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5266     break;
5267   case ICmpInst::ICMP_SLE:
5268     assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
5269     if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
5270       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5271     if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
5272       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5273     if (Op1Max == Op0Min) // A <=s B -> A == B if min(A) == max(B)
5274       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5275     break;
5276   case ICmpInst::ICMP_UGE:
5277     assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
5278     if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
5279       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5280     if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
5281       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5282     if (Op1Min == Op0Max) // A >=u B -> A == B if max(A) == min(B)
5283       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5284     break;
5285   case ICmpInst::ICMP_ULE:
5286     assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
5287     if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
5288       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5289     if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
5290       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5291     if (Op1Max == Op0Min) // A <=u B -> A == B if min(A) == max(B)
5292       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5293     break;
5294   }
5295 
5296   // Turn a signed comparison into an unsigned one if both operands are known to
5297   // have the same sign.
5298   if (I.isSigned() &&
5299       ((Op0Known.Zero.isNegative() && Op1Known.Zero.isNegative()) ||
5300        (Op0Known.One.isNegative() && Op1Known.One.isNegative())))
5301     return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
5302 
5303   return nullptr;
5304 }
5305 
5306 llvm::Optional<std::pair<CmpInst::Predicate, Constant *>>
5307 InstCombiner::getFlippedStrictnessPredicateAndConstant(CmpInst::Predicate Pred,
5308                                                        Constant *C) {
5309   assert(ICmpInst::isRelational(Pred) && ICmpInst::isIntPredicate(Pred) &&
5310          "Only for relational integer predicates.");
5311 
5312   Type *Type = C->getType();
5313   bool IsSigned = ICmpInst::isSigned(Pred);
5314 
5315   CmpInst::Predicate UnsignedPred = ICmpInst::getUnsignedPredicate(Pred);
5316   bool WillIncrement =
5317       UnsignedPred == ICmpInst::ICMP_ULE || UnsignedPred == ICmpInst::ICMP_UGT;
5318 
5319   // Check if the constant operand can be safely incremented/decremented
5320   // without overflowing/underflowing.
5321   auto ConstantIsOk = [WillIncrement, IsSigned](ConstantInt *C) {
5322     return WillIncrement ? !C->isMaxValue(IsSigned) : !C->isMinValue(IsSigned);
5323   };
5324 
5325   Constant *SafeReplacementConstant = nullptr;
5326   if (auto *CI = dyn_cast<ConstantInt>(C)) {
5327     // Bail out if the constant can't be safely incremented/decremented.
5328     if (!ConstantIsOk(CI))
5329       return llvm::None;
5330   } else if (auto *FVTy = dyn_cast<FixedVectorType>(Type)) {
5331     unsigned NumElts = FVTy->getNumElements();
5332     for (unsigned i = 0; i != NumElts; ++i) {
5333       Constant *Elt = C->getAggregateElement(i);
5334       if (!Elt)
5335         return llvm::None;
5336 
5337       if (isa<UndefValue>(Elt))
5338         continue;
5339 
5340       // Bail out if we can't determine if this constant is min/max or if we
5341       // know that this constant is min/max.
5342       auto *CI = dyn_cast<ConstantInt>(Elt);
5343       if (!CI || !ConstantIsOk(CI))
5344         return llvm::None;
5345 
5346       if (!SafeReplacementConstant)
5347         SafeReplacementConstant = CI;
5348     }
5349   } else {
5350     // ConstantExpr?
5351     return llvm::None;
5352   }
5353 
5354   // It may not be safe to change a compare predicate in the presence of
5355   // undefined elements, so replace those elements with the first safe constant
5356   // that we found.
5357   // TODO: in case of poison, it is safe; let's replace undefs only.
5358   if (C->containsUndefOrPoisonElement()) {
5359     assert(SafeReplacementConstant && "Replacement constant not set");
5360     C = Constant::replaceUndefsWith(C, SafeReplacementConstant);
5361   }
5362 
5363   CmpInst::Predicate NewPred = CmpInst::getFlippedStrictnessPredicate(Pred);
5364 
5365   // Increment or decrement the constant.
5366   Constant *OneOrNegOne = ConstantInt::get(Type, WillIncrement ? 1 : -1, true);
5367   Constant *NewC = ConstantExpr::getAdd(C, OneOrNegOne);
5368 
5369   return std::make_pair(NewPred, NewC);
5370 }
5371 
5372 /// If we have an icmp le or icmp ge instruction with a constant operand, turn
5373 /// it into the appropriate icmp lt or icmp gt instruction. This transform
5374 /// allows them to be folded in visitICmpInst.
5375 static ICmpInst *canonicalizeCmpWithConstant(ICmpInst &I) {
5376   ICmpInst::Predicate Pred = I.getPredicate();
5377   if (ICmpInst::isEquality(Pred) || !ICmpInst::isIntPredicate(Pred) ||
5378       InstCombiner::isCanonicalPredicate(Pred))
5379     return nullptr;
5380 
5381   Value *Op0 = I.getOperand(0);
5382   Value *Op1 = I.getOperand(1);
5383   auto *Op1C = dyn_cast<Constant>(Op1);
5384   if (!Op1C)
5385     return nullptr;
5386 
5387   auto FlippedStrictness =
5388       InstCombiner::getFlippedStrictnessPredicateAndConstant(Pred, Op1C);
5389   if (!FlippedStrictness)
5390     return nullptr;
5391 
5392   return new ICmpInst(FlippedStrictness->first, Op0, FlippedStrictness->second);
5393 }
5394 
5395 /// If we have a comparison with a non-canonical predicate, if we can update
5396 /// all the users, invert the predicate and adjust all the users.
5397 CmpInst *InstCombinerImpl::canonicalizeICmpPredicate(CmpInst &I) {
5398   // Is the predicate already canonical?
5399   CmpInst::Predicate Pred = I.getPredicate();
5400   if (InstCombiner::isCanonicalPredicate(Pred))
5401     return nullptr;
5402 
5403   // Can all users be adjusted to predicate inversion?
5404   if (!InstCombiner::canFreelyInvertAllUsersOf(&I, /*IgnoredUser=*/nullptr))
5405     return nullptr;
5406 
5407   // Ok, we can canonicalize comparison!
5408   // Let's first invert the comparison's predicate.
5409   I.setPredicate(CmpInst::getInversePredicate(Pred));
5410   I.setName(I.getName() + ".not");
5411 
5412   // And, adapt users.
5413   freelyInvertAllUsersOf(&I);
5414 
5415   return &I;
5416 }
5417 
5418 /// Integer compare with boolean values can always be turned into bitwise ops.
5419 static Instruction *canonicalizeICmpBool(ICmpInst &I,
5420                                          InstCombiner::BuilderTy &Builder) {
5421   Value *A = I.getOperand(0), *B = I.getOperand(1);
5422   assert(A->getType()->isIntOrIntVectorTy(1) && "Bools only");
5423 
5424   // A boolean compared to true/false can be simplified to Op0/true/false in
5425   // 14 out of the 20 (10 predicates * 2 constants) possible combinations.
5426   // Cases not handled by InstSimplify are always 'not' of Op0.
5427   if (match(B, m_Zero())) {
5428     switch (I.getPredicate()) {
5429       case CmpInst::ICMP_EQ:  // A ==   0 -> !A
5430       case CmpInst::ICMP_ULE: // A <=u  0 -> !A
5431       case CmpInst::ICMP_SGE: // A >=s  0 -> !A
5432         return BinaryOperator::CreateNot(A);
5433       default:
5434         llvm_unreachable("ICmp i1 X, C not simplified as expected.");
5435     }
5436   } else if (match(B, m_One())) {
5437     switch (I.getPredicate()) {
5438       case CmpInst::ICMP_NE:  // A !=  1 -> !A
5439       case CmpInst::ICMP_ULT: // A <u  1 -> !A
5440       case CmpInst::ICMP_SGT: // A >s -1 -> !A
5441         return BinaryOperator::CreateNot(A);
5442       default:
5443         llvm_unreachable("ICmp i1 X, C not simplified as expected.");
5444     }
5445   }
5446 
5447   switch (I.getPredicate()) {
5448   default:
5449     llvm_unreachable("Invalid icmp instruction!");
5450   case ICmpInst::ICMP_EQ:
5451     // icmp eq i1 A, B -> ~(A ^ B)
5452     return BinaryOperator::CreateNot(Builder.CreateXor(A, B));
5453 
5454   case ICmpInst::ICMP_NE:
5455     // icmp ne i1 A, B -> A ^ B
5456     return BinaryOperator::CreateXor(A, B);
5457 
5458   case ICmpInst::ICMP_UGT:
5459     // icmp ugt -> icmp ult
5460     std::swap(A, B);
5461     LLVM_FALLTHROUGH;
5462   case ICmpInst::ICMP_ULT:
5463     // icmp ult i1 A, B -> ~A & B
5464     return BinaryOperator::CreateAnd(Builder.CreateNot(A), B);
5465 
5466   case ICmpInst::ICMP_SGT:
5467     // icmp sgt -> icmp slt
5468     std::swap(A, B);
5469     LLVM_FALLTHROUGH;
5470   case ICmpInst::ICMP_SLT:
5471     // icmp slt i1 A, B -> A & ~B
5472     return BinaryOperator::CreateAnd(Builder.CreateNot(B), A);
5473 
5474   case ICmpInst::ICMP_UGE:
5475     // icmp uge -> icmp ule
5476     std::swap(A, B);
5477     LLVM_FALLTHROUGH;
5478   case ICmpInst::ICMP_ULE:
5479     // icmp ule i1 A, B -> ~A | B
5480     return BinaryOperator::CreateOr(Builder.CreateNot(A), B);
5481 
5482   case ICmpInst::ICMP_SGE:
5483     // icmp sge -> icmp sle
5484     std::swap(A, B);
5485     LLVM_FALLTHROUGH;
5486   case ICmpInst::ICMP_SLE:
5487     // icmp sle i1 A, B -> A | ~B
5488     return BinaryOperator::CreateOr(Builder.CreateNot(B), A);
5489   }
5490 }
5491 
5492 // Transform pattern like:
5493 //   (1 << Y) u<= X  or  ~(-1 << Y) u<  X  or  ((1 << Y)+(-1)) u<  X
5494 //   (1 << Y) u>  X  or  ~(-1 << Y) u>= X  or  ((1 << Y)+(-1)) u>= X
5495 // Into:
5496 //   (X l>> Y) != 0
5497 //   (X l>> Y) == 0
5498 static Instruction *foldICmpWithHighBitMask(ICmpInst &Cmp,
5499                                             InstCombiner::BuilderTy &Builder) {
5500   ICmpInst::Predicate Pred, NewPred;
5501   Value *X, *Y;
5502   if (match(&Cmp,
5503             m_c_ICmp(Pred, m_OneUse(m_Shl(m_One(), m_Value(Y))), m_Value(X)))) {
5504     switch (Pred) {
5505     case ICmpInst::ICMP_ULE:
5506       NewPred = ICmpInst::ICMP_NE;
5507       break;
5508     case ICmpInst::ICMP_UGT:
5509       NewPred = ICmpInst::ICMP_EQ;
5510       break;
5511     default:
5512       return nullptr;
5513     }
5514   } else if (match(&Cmp, m_c_ICmp(Pred,
5515                                   m_OneUse(m_CombineOr(
5516                                       m_Not(m_Shl(m_AllOnes(), m_Value(Y))),
5517                                       m_Add(m_Shl(m_One(), m_Value(Y)),
5518                                             m_AllOnes()))),
5519                                   m_Value(X)))) {
5520     // The variant with 'add' is not canonical, (the variant with 'not' is)
5521     // we only get it because it has extra uses, and can't be canonicalized,
5522 
5523     switch (Pred) {
5524     case ICmpInst::ICMP_ULT:
5525       NewPred = ICmpInst::ICMP_NE;
5526       break;
5527     case ICmpInst::ICMP_UGE:
5528       NewPred = ICmpInst::ICMP_EQ;
5529       break;
5530     default:
5531       return nullptr;
5532     }
5533   } else
5534     return nullptr;
5535 
5536   Value *NewX = Builder.CreateLShr(X, Y, X->getName() + ".highbits");
5537   Constant *Zero = Constant::getNullValue(NewX->getType());
5538   return CmpInst::Create(Instruction::ICmp, NewPred, NewX, Zero);
5539 }
5540 
5541 static Instruction *foldVectorCmp(CmpInst &Cmp,
5542                                   InstCombiner::BuilderTy &Builder) {
5543   const CmpInst::Predicate Pred = Cmp.getPredicate();
5544   Value *LHS = Cmp.getOperand(0), *RHS = Cmp.getOperand(1);
5545   Value *V1, *V2;
5546   ArrayRef<int> M;
5547   if (!match(LHS, m_Shuffle(m_Value(V1), m_Undef(), m_Mask(M))))
5548     return nullptr;
5549 
5550   // If both arguments of the cmp are shuffles that use the same mask and
5551   // shuffle within a single vector, move the shuffle after the cmp:
5552   // cmp (shuffle V1, M), (shuffle V2, M) --> shuffle (cmp V1, V2), M
5553   Type *V1Ty = V1->getType();
5554   if (match(RHS, m_Shuffle(m_Value(V2), m_Undef(), m_SpecificMask(M))) &&
5555       V1Ty == V2->getType() && (LHS->hasOneUse() || RHS->hasOneUse())) {
5556     Value *NewCmp = Builder.CreateCmp(Pred, V1, V2);
5557     return new ShuffleVectorInst(NewCmp, UndefValue::get(NewCmp->getType()), M);
5558   }
5559 
5560   // Try to canonicalize compare with splatted operand and splat constant.
5561   // TODO: We could generalize this for more than splats. See/use the code in
5562   //       InstCombiner::foldVectorBinop().
5563   Constant *C;
5564   if (!LHS->hasOneUse() || !match(RHS, m_Constant(C)))
5565     return nullptr;
5566 
5567   // Length-changing splats are ok, so adjust the constants as needed:
5568   // cmp (shuffle V1, M), C --> shuffle (cmp V1, C'), M
5569   Constant *ScalarC = C->getSplatValue(/* AllowUndefs */ true);
5570   int MaskSplatIndex;
5571   if (ScalarC && match(M, m_SplatOrUndefMask(MaskSplatIndex))) {
5572     // We allow undefs in matching, but this transform removes those for safety.
5573     // Demanded elements analysis should be able to recover some/all of that.
5574     C = ConstantVector::getSplat(cast<VectorType>(V1Ty)->getElementCount(),
5575                                  ScalarC);
5576     SmallVector<int, 8> NewM(M.size(), MaskSplatIndex);
5577     Value *NewCmp = Builder.CreateCmp(Pred, V1, C);
5578     return new ShuffleVectorInst(NewCmp, UndefValue::get(NewCmp->getType()),
5579                                  NewM);
5580   }
5581 
5582   return nullptr;
5583 }
5584 
5585 // extract(uadd.with.overflow(A, B), 0) ult A
5586 //  -> extract(uadd.with.overflow(A, B), 1)
5587 static Instruction *foldICmpOfUAddOv(ICmpInst &I) {
5588   CmpInst::Predicate Pred = I.getPredicate();
5589   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
5590 
5591   Value *UAddOv;
5592   Value *A, *B;
5593   auto UAddOvResultPat = m_ExtractValue<0>(
5594       m_Intrinsic<Intrinsic::uadd_with_overflow>(m_Value(A), m_Value(B)));
5595   if (match(Op0, UAddOvResultPat) &&
5596       ((Pred == ICmpInst::ICMP_ULT && (Op1 == A || Op1 == B)) ||
5597        (Pred == ICmpInst::ICMP_EQ && match(Op1, m_ZeroInt()) &&
5598         (match(A, m_One()) || match(B, m_One()))) ||
5599        (Pred == ICmpInst::ICMP_NE && match(Op1, m_AllOnes()) &&
5600         (match(A, m_AllOnes()) || match(B, m_AllOnes())))))
5601     // extract(uadd.with.overflow(A, B), 0) < A
5602     // extract(uadd.with.overflow(A, 1), 0) == 0
5603     // extract(uadd.with.overflow(A, -1), 0) != -1
5604     UAddOv = cast<ExtractValueInst>(Op0)->getAggregateOperand();
5605   else if (match(Op1, UAddOvResultPat) &&
5606            Pred == ICmpInst::ICMP_UGT && (Op0 == A || Op0 == B))
5607     // A > extract(uadd.with.overflow(A, B), 0)
5608     UAddOv = cast<ExtractValueInst>(Op1)->getAggregateOperand();
5609   else
5610     return nullptr;
5611 
5612   return ExtractValueInst::Create(UAddOv, 1);
5613 }
5614 
5615 Instruction *InstCombinerImpl::visitICmpInst(ICmpInst &I) {
5616   bool Changed = false;
5617   const SimplifyQuery Q = SQ.getWithInstruction(&I);
5618   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
5619   unsigned Op0Cplxity = getComplexity(Op0);
5620   unsigned Op1Cplxity = getComplexity(Op1);
5621 
5622   /// Orders the operands of the compare so that they are listed from most
5623   /// complex to least complex.  This puts constants before unary operators,
5624   /// before binary operators.
5625   if (Op0Cplxity < Op1Cplxity ||
5626       (Op0Cplxity == Op1Cplxity && swapMayExposeCSEOpportunities(Op0, Op1))) {
5627     I.swapOperands();
5628     std::swap(Op0, Op1);
5629     Changed = true;
5630   }
5631 
5632   if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, Q))
5633     return replaceInstUsesWith(I, V);
5634 
5635   // Comparing -val or val with non-zero is the same as just comparing val
5636   // ie, abs(val) != 0 -> val != 0
5637   if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero())) {
5638     Value *Cond, *SelectTrue, *SelectFalse;
5639     if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
5640                             m_Value(SelectFalse)))) {
5641       if (Value *V = dyn_castNegVal(SelectTrue)) {
5642         if (V == SelectFalse)
5643           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
5644       }
5645       else if (Value *V = dyn_castNegVal(SelectFalse)) {
5646         if (V == SelectTrue)
5647           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
5648       }
5649     }
5650   }
5651 
5652   if (Op0->getType()->isIntOrIntVectorTy(1))
5653     if (Instruction *Res = canonicalizeICmpBool(I, Builder))
5654       return Res;
5655 
5656   if (Instruction *Res = canonicalizeCmpWithConstant(I))
5657     return Res;
5658 
5659   if (Instruction *Res = canonicalizeICmpPredicate(I))
5660     return Res;
5661 
5662   if (Instruction *Res = foldICmpWithConstant(I))
5663     return Res;
5664 
5665   if (Instruction *Res = foldICmpWithDominatingICmp(I))
5666     return Res;
5667 
5668   if (Instruction *Res = foldICmpBinOp(I, Q))
5669     return Res;
5670 
5671   if (Instruction *Res = foldICmpUsingKnownBits(I))
5672     return Res;
5673 
5674   // Test if the ICmpInst instruction is used exclusively by a select as
5675   // part of a minimum or maximum operation. If so, refrain from doing
5676   // any other folding. This helps out other analyses which understand
5677   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
5678   // and CodeGen. And in this case, at least one of the comparison
5679   // operands has at least one user besides the compare (the select),
5680   // which would often largely negate the benefit of folding anyway.
5681   //
5682   // Do the same for the other patterns recognized by matchSelectPattern.
5683   if (I.hasOneUse())
5684     if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) {
5685       Value *A, *B;
5686       SelectPatternResult SPR = matchSelectPattern(SI, A, B);
5687       if (SPR.Flavor != SPF_UNKNOWN)
5688         return nullptr;
5689     }
5690 
5691   // Do this after checking for min/max to prevent infinite looping.
5692   if (Instruction *Res = foldICmpWithZero(I))
5693     return Res;
5694 
5695   // FIXME: We only do this after checking for min/max to prevent infinite
5696   // looping caused by a reverse canonicalization of these patterns for min/max.
5697   // FIXME: The organization of folds is a mess. These would naturally go into
5698   // canonicalizeCmpWithConstant(), but we can't move all of the above folds
5699   // down here after the min/max restriction.
5700   ICmpInst::Predicate Pred = I.getPredicate();
5701   const APInt *C;
5702   if (match(Op1, m_APInt(C))) {
5703     // For i32: x >u 2147483647 -> x <s 0  -> true if sign bit set
5704     if (Pred == ICmpInst::ICMP_UGT && C->isMaxSignedValue()) {
5705       Constant *Zero = Constant::getNullValue(Op0->getType());
5706       return new ICmpInst(ICmpInst::ICMP_SLT, Op0, Zero);
5707     }
5708 
5709     // For i32: x <u 2147483648 -> x >s -1  -> true if sign bit clear
5710     if (Pred == ICmpInst::ICMP_ULT && C->isMinSignedValue()) {
5711       Constant *AllOnes = Constant::getAllOnesValue(Op0->getType());
5712       return new ICmpInst(ICmpInst::ICMP_SGT, Op0, AllOnes);
5713     }
5714   }
5715 
5716   if (Instruction *Res = foldICmpInstWithConstant(I))
5717     return Res;
5718 
5719   // Try to match comparison as a sign bit test. Intentionally do this after
5720   // foldICmpInstWithConstant() to potentially let other folds to happen first.
5721   if (Instruction *New = foldSignBitTest(I))
5722     return New;
5723 
5724   if (Instruction *Res = foldICmpInstWithConstantNotInt(I))
5725     return Res;
5726 
5727   // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
5728   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
5729     if (Instruction *NI = foldGEPICmp(GEP, Op1, I.getPredicate(), I))
5730       return NI;
5731   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
5732     if (Instruction *NI = foldGEPICmp(GEP, Op0,
5733                            ICmpInst::getSwappedPredicate(I.getPredicate()), I))
5734       return NI;
5735 
5736   // Try to optimize equality comparisons against alloca-based pointers.
5737   if (Op0->getType()->isPointerTy() && I.isEquality()) {
5738     assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?");
5739     if (auto *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(Op0)))
5740       if (Instruction *New = foldAllocaCmp(I, Alloca, Op1))
5741         return New;
5742     if (auto *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(Op1)))
5743       if (Instruction *New = foldAllocaCmp(I, Alloca, Op0))
5744         return New;
5745   }
5746 
5747   if (Instruction *Res = foldICmpBitCast(I, Builder))
5748     return Res;
5749 
5750   // TODO: Hoist this above the min/max bailout.
5751   if (Instruction *R = foldICmpWithCastOp(I))
5752     return R;
5753 
5754   if (Instruction *Res = foldICmpWithMinMax(I))
5755     return Res;
5756 
5757   {
5758     Value *A, *B;
5759     // Transform (A & ~B) == 0 --> (A & B) != 0
5760     // and       (A & ~B) != 0 --> (A & B) == 0
5761     // if A is a power of 2.
5762     if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
5763         match(Op1, m_Zero()) &&
5764         isKnownToBeAPowerOfTwo(A, false, 0, &I) && I.isEquality())
5765       return new ICmpInst(I.getInversePredicate(), Builder.CreateAnd(A, B),
5766                           Op1);
5767 
5768     // ~X < ~Y --> Y < X
5769     // ~X < C -->  X > ~C
5770     if (match(Op0, m_Not(m_Value(A)))) {
5771       if (match(Op1, m_Not(m_Value(B))))
5772         return new ICmpInst(I.getPredicate(), B, A);
5773 
5774       const APInt *C;
5775       if (match(Op1, m_APInt(C)))
5776         return new ICmpInst(I.getSwappedPredicate(), A,
5777                             ConstantInt::get(Op1->getType(), ~(*C)));
5778     }
5779 
5780     Instruction *AddI = nullptr;
5781     if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
5782                                      m_Instruction(AddI))) &&
5783         isa<IntegerType>(A->getType())) {
5784       Value *Result;
5785       Constant *Overflow;
5786       // m_UAddWithOverflow can match patterns that do not include  an explicit
5787       // "add" instruction, so check the opcode of the matched op.
5788       if (AddI->getOpcode() == Instruction::Add &&
5789           OptimizeOverflowCheck(Instruction::Add, /*Signed*/ false, A, B, *AddI,
5790                                 Result, Overflow)) {
5791         replaceInstUsesWith(*AddI, Result);
5792         eraseInstFromFunction(*AddI);
5793         return replaceInstUsesWith(I, Overflow);
5794       }
5795     }
5796 
5797     // (zext a) * (zext b)  --> llvm.umul.with.overflow.
5798     if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
5799       if (Instruction *R = processUMulZExtIdiom(I, Op0, Op1, *this))
5800         return R;
5801     }
5802     if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
5803       if (Instruction *R = processUMulZExtIdiom(I, Op1, Op0, *this))
5804         return R;
5805     }
5806   }
5807 
5808   if (Instruction *Res = foldICmpEquality(I))
5809     return Res;
5810 
5811   if (Instruction *Res = foldICmpOfUAddOv(I))
5812     return Res;
5813 
5814   // The 'cmpxchg' instruction returns an aggregate containing the old value and
5815   // an i1 which indicates whether or not we successfully did the swap.
5816   //
5817   // Replace comparisons between the old value and the expected value with the
5818   // indicator that 'cmpxchg' returns.
5819   //
5820   // N.B.  This transform is only valid when the 'cmpxchg' is not permitted to
5821   // spuriously fail.  In those cases, the old value may equal the expected
5822   // value but it is possible for the swap to not occur.
5823   if (I.getPredicate() == ICmpInst::ICMP_EQ)
5824     if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
5825       if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
5826         if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
5827             !ACXI->isWeak())
5828           return ExtractValueInst::Create(ACXI, 1);
5829 
5830   {
5831     Value *X;
5832     const APInt *C;
5833     // icmp X+Cst, X
5834     if (match(Op0, m_Add(m_Value(X), m_APInt(C))) && Op1 == X)
5835       return foldICmpAddOpConst(X, *C, I.getPredicate());
5836 
5837     // icmp X, X+Cst
5838     if (match(Op1, m_Add(m_Value(X), m_APInt(C))) && Op0 == X)
5839       return foldICmpAddOpConst(X, *C, I.getSwappedPredicate());
5840   }
5841 
5842   if (Instruction *Res = foldICmpWithHighBitMask(I, Builder))
5843     return Res;
5844 
5845   if (I.getType()->isVectorTy())
5846     if (Instruction *Res = foldVectorCmp(I, Builder))
5847       return Res;
5848 
5849   return Changed ? &I : nullptr;
5850 }
5851 
5852 /// Fold fcmp ([us]itofp x, cst) if possible.
5853 Instruction *InstCombinerImpl::foldFCmpIntToFPConst(FCmpInst &I,
5854                                                     Instruction *LHSI,
5855                                                     Constant *RHSC) {
5856   if (!isa<ConstantFP>(RHSC)) return nullptr;
5857   const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
5858 
5859   // Get the width of the mantissa.  We don't want to hack on conversions that
5860   // might lose information from the integer, e.g. "i64 -> float"
5861   int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
5862   if (MantissaWidth == -1) return nullptr;  // Unknown.
5863 
5864   IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
5865 
5866   bool LHSUnsigned = isa<UIToFPInst>(LHSI);
5867 
5868   if (I.isEquality()) {
5869     FCmpInst::Predicate P = I.getPredicate();
5870     bool IsExact = false;
5871     APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
5872     RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
5873 
5874     // If the floating point constant isn't an integer value, we know if we will
5875     // ever compare equal / not equal to it.
5876     if (!IsExact) {
5877       // TODO: Can never be -0.0 and other non-representable values
5878       APFloat RHSRoundInt(RHS);
5879       RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
5880       if (RHS != RHSRoundInt) {
5881         if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
5882           return replaceInstUsesWith(I, Builder.getFalse());
5883 
5884         assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
5885         return replaceInstUsesWith(I, Builder.getTrue());
5886       }
5887     }
5888 
5889     // TODO: If the constant is exactly representable, is it always OK to do
5890     // equality compares as integer?
5891   }
5892 
5893   // Check to see that the input is converted from an integer type that is small
5894   // enough that preserves all bits.  TODO: check here for "known" sign bits.
5895   // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
5896   unsigned InputSize = IntTy->getScalarSizeInBits();
5897 
5898   // Following test does NOT adjust InputSize downwards for signed inputs,
5899   // because the most negative value still requires all the mantissa bits
5900   // to distinguish it from one less than that value.
5901   if ((int)InputSize > MantissaWidth) {
5902     // Conversion would lose accuracy. Check if loss can impact comparison.
5903     int Exp = ilogb(RHS);
5904     if (Exp == APFloat::IEK_Inf) {
5905       int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics()));
5906       if (MaxExponent < (int)InputSize - !LHSUnsigned)
5907         // Conversion could create infinity.
5908         return nullptr;
5909     } else {
5910       // Note that if RHS is zero or NaN, then Exp is negative
5911       // and first condition is trivially false.
5912       if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned)
5913         // Conversion could affect comparison.
5914         return nullptr;
5915     }
5916   }
5917 
5918   // Otherwise, we can potentially simplify the comparison.  We know that it
5919   // will always come through as an integer value and we know the constant is
5920   // not a NAN (it would have been previously simplified).
5921   assert(!RHS.isNaN() && "NaN comparison not already folded!");
5922 
5923   ICmpInst::Predicate Pred;
5924   switch (I.getPredicate()) {
5925   default: llvm_unreachable("Unexpected predicate!");
5926   case FCmpInst::FCMP_UEQ:
5927   case FCmpInst::FCMP_OEQ:
5928     Pred = ICmpInst::ICMP_EQ;
5929     break;
5930   case FCmpInst::FCMP_UGT:
5931   case FCmpInst::FCMP_OGT:
5932     Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
5933     break;
5934   case FCmpInst::FCMP_UGE:
5935   case FCmpInst::FCMP_OGE:
5936     Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
5937     break;
5938   case FCmpInst::FCMP_ULT:
5939   case FCmpInst::FCMP_OLT:
5940     Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
5941     break;
5942   case FCmpInst::FCMP_ULE:
5943   case FCmpInst::FCMP_OLE:
5944     Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
5945     break;
5946   case FCmpInst::FCMP_UNE:
5947   case FCmpInst::FCMP_ONE:
5948     Pred = ICmpInst::ICMP_NE;
5949     break;
5950   case FCmpInst::FCMP_ORD:
5951     return replaceInstUsesWith(I, Builder.getTrue());
5952   case FCmpInst::FCMP_UNO:
5953     return replaceInstUsesWith(I, Builder.getFalse());
5954   }
5955 
5956   // Now we know that the APFloat is a normal number, zero or inf.
5957 
5958   // See if the FP constant is too large for the integer.  For example,
5959   // comparing an i8 to 300.0.
5960   unsigned IntWidth = IntTy->getScalarSizeInBits();
5961 
5962   if (!LHSUnsigned) {
5963     // If the RHS value is > SignedMax, fold the comparison.  This handles +INF
5964     // and large values.
5965     APFloat SMax(RHS.getSemantics());
5966     SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
5967                           APFloat::rmNearestTiesToEven);
5968     if (SMax < RHS) { // smax < 13123.0
5969       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_SLT ||
5970           Pred == ICmpInst::ICMP_SLE)
5971         return replaceInstUsesWith(I, Builder.getTrue());
5972       return replaceInstUsesWith(I, Builder.getFalse());
5973     }
5974   } else {
5975     // If the RHS value is > UnsignedMax, fold the comparison. This handles
5976     // +INF and large values.
5977     APFloat UMax(RHS.getSemantics());
5978     UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
5979                           APFloat::rmNearestTiesToEven);
5980     if (UMax < RHS) { // umax < 13123.0
5981       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_ULT ||
5982           Pred == ICmpInst::ICMP_ULE)
5983         return replaceInstUsesWith(I, Builder.getTrue());
5984       return replaceInstUsesWith(I, Builder.getFalse());
5985     }
5986   }
5987 
5988   if (!LHSUnsigned) {
5989     // See if the RHS value is < SignedMin.
5990     APFloat SMin(RHS.getSemantics());
5991     SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
5992                           APFloat::rmNearestTiesToEven);
5993     if (SMin > RHS) { // smin > 12312.0
5994       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
5995           Pred == ICmpInst::ICMP_SGE)
5996         return replaceInstUsesWith(I, Builder.getTrue());
5997       return replaceInstUsesWith(I, Builder.getFalse());
5998     }
5999   } else {
6000     // See if the RHS value is < UnsignedMin.
6001     APFloat UMin(RHS.getSemantics());
6002     UMin.convertFromAPInt(APInt::getMinValue(IntWidth), false,
6003                           APFloat::rmNearestTiesToEven);
6004     if (UMin > RHS) { // umin > 12312.0
6005       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
6006           Pred == ICmpInst::ICMP_UGE)
6007         return replaceInstUsesWith(I, Builder.getTrue());
6008       return replaceInstUsesWith(I, Builder.getFalse());
6009     }
6010   }
6011 
6012   // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
6013   // [0, UMAX], but it may still be fractional.  See if it is fractional by
6014   // casting the FP value to the integer value and back, checking for equality.
6015   // Don't do this for zero, because -0.0 is not fractional.
6016   Constant *RHSInt = LHSUnsigned
6017     ? ConstantExpr::getFPToUI(RHSC, IntTy)
6018     : ConstantExpr::getFPToSI(RHSC, IntTy);
6019   if (!RHS.isZero()) {
6020     bool Equal = LHSUnsigned
6021       ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
6022       : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
6023     if (!Equal) {
6024       // If we had a comparison against a fractional value, we have to adjust
6025       // the compare predicate and sometimes the value.  RHSC is rounded towards
6026       // zero at this point.
6027       switch (Pred) {
6028       default: llvm_unreachable("Unexpected integer comparison!");
6029       case ICmpInst::ICMP_NE:  // (float)int != 4.4   --> true
6030         return replaceInstUsesWith(I, Builder.getTrue());
6031       case ICmpInst::ICMP_EQ:  // (float)int == 4.4   --> false
6032         return replaceInstUsesWith(I, Builder.getFalse());
6033       case ICmpInst::ICMP_ULE:
6034         // (float)int <= 4.4   --> int <= 4
6035         // (float)int <= -4.4  --> false
6036         if (RHS.isNegative())
6037           return replaceInstUsesWith(I, Builder.getFalse());
6038         break;
6039       case ICmpInst::ICMP_SLE:
6040         // (float)int <= 4.4   --> int <= 4
6041         // (float)int <= -4.4  --> int < -4
6042         if (RHS.isNegative())
6043           Pred = ICmpInst::ICMP_SLT;
6044         break;
6045       case ICmpInst::ICMP_ULT:
6046         // (float)int < -4.4   --> false
6047         // (float)int < 4.4    --> int <= 4
6048         if (RHS.isNegative())
6049           return replaceInstUsesWith(I, Builder.getFalse());
6050         Pred = ICmpInst::ICMP_ULE;
6051         break;
6052       case ICmpInst::ICMP_SLT:
6053         // (float)int < -4.4   --> int < -4
6054         // (float)int < 4.4    --> int <= 4
6055         if (!RHS.isNegative())
6056           Pred = ICmpInst::ICMP_SLE;
6057         break;
6058       case ICmpInst::ICMP_UGT:
6059         // (float)int > 4.4    --> int > 4
6060         // (float)int > -4.4   --> true
6061         if (RHS.isNegative())
6062           return replaceInstUsesWith(I, Builder.getTrue());
6063         break;
6064       case ICmpInst::ICMP_SGT:
6065         // (float)int > 4.4    --> int > 4
6066         // (float)int > -4.4   --> int >= -4
6067         if (RHS.isNegative())
6068           Pred = ICmpInst::ICMP_SGE;
6069         break;
6070       case ICmpInst::ICMP_UGE:
6071         // (float)int >= -4.4   --> true
6072         // (float)int >= 4.4    --> int > 4
6073         if (RHS.isNegative())
6074           return replaceInstUsesWith(I, Builder.getTrue());
6075         Pred = ICmpInst::ICMP_UGT;
6076         break;
6077       case ICmpInst::ICMP_SGE:
6078         // (float)int >= -4.4   --> int >= -4
6079         // (float)int >= 4.4    --> int > 4
6080         if (!RHS.isNegative())
6081           Pred = ICmpInst::ICMP_SGT;
6082         break;
6083       }
6084     }
6085   }
6086 
6087   // Lower this FP comparison into an appropriate integer version of the
6088   // comparison.
6089   return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
6090 }
6091 
6092 /// Fold (C / X) < 0.0 --> X < 0.0 if possible. Swap predicate if necessary.
6093 static Instruction *foldFCmpReciprocalAndZero(FCmpInst &I, Instruction *LHSI,
6094                                               Constant *RHSC) {
6095   // When C is not 0.0 and infinities are not allowed:
6096   // (C / X) < 0.0 is a sign-bit test of X
6097   // (C / X) < 0.0 --> X < 0.0 (if C is positive)
6098   // (C / X) < 0.0 --> X > 0.0 (if C is negative, swap the predicate)
6099   //
6100   // Proof:
6101   // Multiply (C / X) < 0.0 by X * X / C.
6102   // - X is non zero, if it is the flag 'ninf' is violated.
6103   // - C defines the sign of X * X * C. Thus it also defines whether to swap
6104   //   the predicate. C is also non zero by definition.
6105   //
6106   // Thus X * X / C is non zero and the transformation is valid. [qed]
6107 
6108   FCmpInst::Predicate Pred = I.getPredicate();
6109 
6110   // Check that predicates are valid.
6111   if ((Pred != FCmpInst::FCMP_OGT) && (Pred != FCmpInst::FCMP_OLT) &&
6112       (Pred != FCmpInst::FCMP_OGE) && (Pred != FCmpInst::FCMP_OLE))
6113     return nullptr;
6114 
6115   // Check that RHS operand is zero.
6116   if (!match(RHSC, m_AnyZeroFP()))
6117     return nullptr;
6118 
6119   // Check fastmath flags ('ninf').
6120   if (!LHSI->hasNoInfs() || !I.hasNoInfs())
6121     return nullptr;
6122 
6123   // Check the properties of the dividend. It must not be zero to avoid a
6124   // division by zero (see Proof).
6125   const APFloat *C;
6126   if (!match(LHSI->getOperand(0), m_APFloat(C)))
6127     return nullptr;
6128 
6129   if (C->isZero())
6130     return nullptr;
6131 
6132   // Get swapped predicate if necessary.
6133   if (C->isNegative())
6134     Pred = I.getSwappedPredicate();
6135 
6136   return new FCmpInst(Pred, LHSI->getOperand(1), RHSC, "", &I);
6137 }
6138 
6139 /// Optimize fabs(X) compared with zero.
6140 static Instruction *foldFabsWithFcmpZero(FCmpInst &I, InstCombinerImpl &IC) {
6141   Value *X;
6142   if (!match(I.getOperand(0), m_FAbs(m_Value(X))) ||
6143       !match(I.getOperand(1), m_PosZeroFP()))
6144     return nullptr;
6145 
6146   auto replacePredAndOp0 = [&IC](FCmpInst *I, FCmpInst::Predicate P, Value *X) {
6147     I->setPredicate(P);
6148     return IC.replaceOperand(*I, 0, X);
6149   };
6150 
6151   switch (I.getPredicate()) {
6152   case FCmpInst::FCMP_UGE:
6153   case FCmpInst::FCMP_OLT:
6154     // fabs(X) >= 0.0 --> true
6155     // fabs(X) <  0.0 --> false
6156     llvm_unreachable("fcmp should have simplified");
6157 
6158   case FCmpInst::FCMP_OGT:
6159     // fabs(X) > 0.0 --> X != 0.0
6160     return replacePredAndOp0(&I, FCmpInst::FCMP_ONE, X);
6161 
6162   case FCmpInst::FCMP_UGT:
6163     // fabs(X) u> 0.0 --> X u!= 0.0
6164     return replacePredAndOp0(&I, FCmpInst::FCMP_UNE, X);
6165 
6166   case FCmpInst::FCMP_OLE:
6167     // fabs(X) <= 0.0 --> X == 0.0
6168     return replacePredAndOp0(&I, FCmpInst::FCMP_OEQ, X);
6169 
6170   case FCmpInst::FCMP_ULE:
6171     // fabs(X) u<= 0.0 --> X u== 0.0
6172     return replacePredAndOp0(&I, FCmpInst::FCMP_UEQ, X);
6173 
6174   case FCmpInst::FCMP_OGE:
6175     // fabs(X) >= 0.0 --> !isnan(X)
6176     assert(!I.hasNoNaNs() && "fcmp should have simplified");
6177     return replacePredAndOp0(&I, FCmpInst::FCMP_ORD, X);
6178 
6179   case FCmpInst::FCMP_ULT:
6180     // fabs(X) u< 0.0 --> isnan(X)
6181     assert(!I.hasNoNaNs() && "fcmp should have simplified");
6182     return replacePredAndOp0(&I, FCmpInst::FCMP_UNO, X);
6183 
6184   case FCmpInst::FCMP_OEQ:
6185   case FCmpInst::FCMP_UEQ:
6186   case FCmpInst::FCMP_ONE:
6187   case FCmpInst::FCMP_UNE:
6188   case FCmpInst::FCMP_ORD:
6189   case FCmpInst::FCMP_UNO:
6190     // Look through the fabs() because it doesn't change anything but the sign.
6191     // fabs(X) == 0.0 --> X == 0.0,
6192     // fabs(X) != 0.0 --> X != 0.0
6193     // isnan(fabs(X)) --> isnan(X)
6194     // !isnan(fabs(X) --> !isnan(X)
6195     return replacePredAndOp0(&I, I.getPredicate(), X);
6196 
6197   default:
6198     return nullptr;
6199   }
6200 }
6201 
6202 Instruction *InstCombinerImpl::visitFCmpInst(FCmpInst &I) {
6203   bool Changed = false;
6204 
6205   /// Orders the operands of the compare so that they are listed from most
6206   /// complex to least complex.  This puts constants before unary operators,
6207   /// before binary operators.
6208   if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
6209     I.swapOperands();
6210     Changed = true;
6211   }
6212 
6213   const CmpInst::Predicate Pred = I.getPredicate();
6214   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
6215   if (Value *V = SimplifyFCmpInst(Pred, Op0, Op1, I.getFastMathFlags(),
6216                                   SQ.getWithInstruction(&I)))
6217     return replaceInstUsesWith(I, V);
6218 
6219   // Simplify 'fcmp pred X, X'
6220   Type *OpType = Op0->getType();
6221   assert(OpType == Op1->getType() && "fcmp with different-typed operands?");
6222   if (Op0 == Op1) {
6223     switch (Pred) {
6224       default: break;
6225     case FCmpInst::FCMP_UNO:    // True if unordered: isnan(X) | isnan(Y)
6226     case FCmpInst::FCMP_ULT:    // True if unordered or less than
6227     case FCmpInst::FCMP_UGT:    // True if unordered or greater than
6228     case FCmpInst::FCMP_UNE:    // True if unordered or not equal
6229       // Canonicalize these to be 'fcmp uno %X, 0.0'.
6230       I.setPredicate(FCmpInst::FCMP_UNO);
6231       I.setOperand(1, Constant::getNullValue(OpType));
6232       return &I;
6233 
6234     case FCmpInst::FCMP_ORD:    // True if ordered (no nans)
6235     case FCmpInst::FCMP_OEQ:    // True if ordered and equal
6236     case FCmpInst::FCMP_OGE:    // True if ordered and greater than or equal
6237     case FCmpInst::FCMP_OLE:    // True if ordered and less than or equal
6238       // Canonicalize these to be 'fcmp ord %X, 0.0'.
6239       I.setPredicate(FCmpInst::FCMP_ORD);
6240       I.setOperand(1, Constant::getNullValue(OpType));
6241       return &I;
6242     }
6243   }
6244 
6245   // If we're just checking for a NaN (ORD/UNO) and have a non-NaN operand,
6246   // then canonicalize the operand to 0.0.
6247   if (Pred == CmpInst::FCMP_ORD || Pred == CmpInst::FCMP_UNO) {
6248     if (!match(Op0, m_PosZeroFP()) && isKnownNeverNaN(Op0, &TLI))
6249       return replaceOperand(I, 0, ConstantFP::getNullValue(OpType));
6250 
6251     if (!match(Op1, m_PosZeroFP()) && isKnownNeverNaN(Op1, &TLI))
6252       return replaceOperand(I, 1, ConstantFP::getNullValue(OpType));
6253   }
6254 
6255   // fcmp pred (fneg X), (fneg Y) -> fcmp swap(pred) X, Y
6256   Value *X, *Y;
6257   if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
6258     return new FCmpInst(I.getSwappedPredicate(), X, Y, "", &I);
6259 
6260   // Test if the FCmpInst instruction is used exclusively by a select as
6261   // part of a minimum or maximum operation. If so, refrain from doing
6262   // any other folding. This helps out other analyses which understand
6263   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
6264   // and CodeGen. And in this case, at least one of the comparison
6265   // operands has at least one user besides the compare (the select),
6266   // which would often largely negate the benefit of folding anyway.
6267   if (I.hasOneUse())
6268     if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) {
6269       Value *A, *B;
6270       SelectPatternResult SPR = matchSelectPattern(SI, A, B);
6271       if (SPR.Flavor != SPF_UNKNOWN)
6272         return nullptr;
6273     }
6274 
6275   // The sign of 0.0 is ignored by fcmp, so canonicalize to +0.0:
6276   // fcmp Pred X, -0.0 --> fcmp Pred X, 0.0
6277   if (match(Op1, m_AnyZeroFP()) && !match(Op1, m_PosZeroFP()))
6278     return replaceOperand(I, 1, ConstantFP::getNullValue(OpType));
6279 
6280   // Handle fcmp with instruction LHS and constant RHS.
6281   Instruction *LHSI;
6282   Constant *RHSC;
6283   if (match(Op0, m_Instruction(LHSI)) && match(Op1, m_Constant(RHSC))) {
6284     switch (LHSI->getOpcode()) {
6285     case Instruction::PHI:
6286       // Only fold fcmp into the PHI if the phi and fcmp are in the same
6287       // block.  If in the same block, we're encouraging jump threading.  If
6288       // not, we are just pessimizing the code by making an i1 phi.
6289       if (LHSI->getParent() == I.getParent())
6290         if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI)))
6291           return NV;
6292       break;
6293     case Instruction::SIToFP:
6294     case Instruction::UIToFP:
6295       if (Instruction *NV = foldFCmpIntToFPConst(I, LHSI, RHSC))
6296         return NV;
6297       break;
6298     case Instruction::FDiv:
6299       if (Instruction *NV = foldFCmpReciprocalAndZero(I, LHSI, RHSC))
6300         return NV;
6301       break;
6302     case Instruction::Load:
6303       if (auto *GEP = dyn_cast<GetElementPtrInst>(LHSI->getOperand(0)))
6304         if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
6305           if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
6306               !cast<LoadInst>(LHSI)->isVolatile())
6307             if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
6308               return Res;
6309       break;
6310   }
6311   }
6312 
6313   if (Instruction *R = foldFabsWithFcmpZero(I, *this))
6314     return R;
6315 
6316   if (match(Op0, m_FNeg(m_Value(X)))) {
6317     // fcmp pred (fneg X), C --> fcmp swap(pred) X, -C
6318     Constant *C;
6319     if (match(Op1, m_Constant(C))) {
6320       Constant *NegC = ConstantExpr::getFNeg(C);
6321       return new FCmpInst(I.getSwappedPredicate(), X, NegC, "", &I);
6322     }
6323   }
6324 
6325   if (match(Op0, m_FPExt(m_Value(X)))) {
6326     // fcmp (fpext X), (fpext Y) -> fcmp X, Y
6327     if (match(Op1, m_FPExt(m_Value(Y))) && X->getType() == Y->getType())
6328       return new FCmpInst(Pred, X, Y, "", &I);
6329 
6330     // fcmp (fpext X), C -> fcmp X, (fptrunc C) if fptrunc is lossless
6331     const APFloat *C;
6332     if (match(Op1, m_APFloat(C))) {
6333       const fltSemantics &FPSem =
6334           X->getType()->getScalarType()->getFltSemantics();
6335       bool Lossy;
6336       APFloat TruncC = *C;
6337       TruncC.convert(FPSem, APFloat::rmNearestTiesToEven, &Lossy);
6338 
6339       // Avoid lossy conversions and denormals.
6340       // Zero is a special case that's OK to convert.
6341       APFloat Fabs = TruncC;
6342       Fabs.clearSign();
6343       if (!Lossy &&
6344           (!(Fabs < APFloat::getSmallestNormalized(FPSem)) || Fabs.isZero())) {
6345         Constant *NewC = ConstantFP::get(X->getType(), TruncC);
6346         return new FCmpInst(Pred, X, NewC, "", &I);
6347       }
6348     }
6349   }
6350 
6351   // Convert a sign-bit test of an FP value into a cast and integer compare.
6352   // TODO: Simplify if the copysign constant is 0.0 or NaN.
6353   // TODO: Handle non-zero compare constants.
6354   // TODO: Handle other predicates.
6355   const APFloat *C;
6356   if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::copysign>(m_APFloat(C),
6357                                                            m_Value(X)))) &&
6358       match(Op1, m_AnyZeroFP()) && !C->isZero() && !C->isNaN()) {
6359     Type *IntType = Builder.getIntNTy(X->getType()->getScalarSizeInBits());
6360     if (auto *VecTy = dyn_cast<VectorType>(OpType))
6361       IntType = VectorType::get(IntType, VecTy->getElementCount());
6362 
6363     // copysign(non-zero constant, X) < 0.0 --> (bitcast X) < 0
6364     if (Pred == FCmpInst::FCMP_OLT) {
6365       Value *IntX = Builder.CreateBitCast(X, IntType);
6366       return new ICmpInst(ICmpInst::ICMP_SLT, IntX,
6367                           ConstantInt::getNullValue(IntType));
6368     }
6369   }
6370 
6371   if (I.getType()->isVectorTy())
6372     if (Instruction *Res = foldVectorCmp(I, Builder))
6373       return Res;
6374 
6375   return Changed ? &I : nullptr;
6376 }
6377