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   const ICmpInst::Predicate Pred = Cmp.getPredicate();
1859   bool TrueIfNeg;
1860   if (isSignBitCheck(Pred, C, TrueIfNeg)) {
1861     // ((X - 1) & ~X) <  0 --> X == 0
1862     // ((X - 1) & ~X) >= 0 --> X != 0
1863     Value *X;
1864     if (match(And->getOperand(0), m_Add(m_Value(X), m_AllOnes())) &&
1865         match(And->getOperand(1), m_Not(m_Specific(X)))) {
1866       auto NewPred = TrueIfNeg ? CmpInst::ICMP_EQ : CmpInst::ICMP_NE;
1867       return new ICmpInst(NewPred, X, ConstantInt::getNullValue(X->getType()));
1868     }
1869   }
1870 
1871   // TODO: These all require that Y is constant too, so refactor with the above.
1872 
1873   // Try to optimize things like "A[i] & 42 == 0" to index computations.
1874   Value *X = And->getOperand(0);
1875   Value *Y = And->getOperand(1);
1876   if (auto *LI = dyn_cast<LoadInst>(X))
1877     if (auto *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1878       if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1879         if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1880             !LI->isVolatile() && isa<ConstantInt>(Y)) {
1881           ConstantInt *C2 = cast<ConstantInt>(Y);
1882           if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, Cmp, C2))
1883             return Res;
1884         }
1885 
1886   if (!Cmp.isEquality())
1887     return nullptr;
1888 
1889   // X & -C == -C -> X >  u ~C
1890   // X & -C != -C -> X <= u ~C
1891   //   iff C is a power of 2
1892   if (Cmp.getOperand(1) == Y && (-C).isPowerOf2()) {
1893     auto NewPred =
1894         Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGT : CmpInst::ICMP_ULE;
1895     return new ICmpInst(NewPred, X, SubOne(cast<Constant>(Cmp.getOperand(1))));
1896   }
1897 
1898   // (X & C2) == 0 -> (trunc X) >= 0
1899   // (X & C2) != 0 -> (trunc X) <  0
1900   //   iff C2 is a power of 2 and it masks the sign bit of a legal integer type.
1901   const APInt *C2;
1902   if (And->hasOneUse() && C.isNullValue() && match(Y, m_APInt(C2))) {
1903     int32_t ExactLogBase2 = C2->exactLogBase2();
1904     if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1905       Type *NTy = IntegerType::get(Cmp.getContext(), ExactLogBase2 + 1);
1906       if (auto *AndVTy = dyn_cast<VectorType>(And->getType()))
1907         NTy = VectorType::get(NTy, AndVTy->getElementCount());
1908       Value *Trunc = Builder.CreateTrunc(X, NTy);
1909       auto NewPred =
1910           Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_SGE : CmpInst::ICMP_SLT;
1911       return new ICmpInst(NewPred, Trunc, Constant::getNullValue(NTy));
1912     }
1913   }
1914 
1915   return nullptr;
1916 }
1917 
1918 /// Fold icmp (or X, Y), C.
1919 Instruction *InstCombinerImpl::foldICmpOrConstant(ICmpInst &Cmp,
1920                                                   BinaryOperator *Or,
1921                                                   const APInt &C) {
1922   ICmpInst::Predicate Pred = Cmp.getPredicate();
1923   if (C.isOneValue()) {
1924     // icmp slt signum(V) 1 --> icmp slt V, 1
1925     Value *V = nullptr;
1926     if (Pred == ICmpInst::ICMP_SLT && match(Or, m_Signum(m_Value(V))))
1927       return new ICmpInst(ICmpInst::ICMP_SLT, V,
1928                           ConstantInt::get(V->getType(), 1));
1929   }
1930 
1931   Value *OrOp0 = Or->getOperand(0), *OrOp1 = Or->getOperand(1);
1932   const APInt *MaskC;
1933   if (match(OrOp1, m_APInt(MaskC)) && Cmp.isEquality()) {
1934     if (*MaskC == C && (C + 1).isPowerOf2()) {
1935       // X | C == C --> X <=u C
1936       // X | C != C --> X  >u C
1937       //   iff C+1 is a power of 2 (C is a bitmask of the low bits)
1938       Pred = (Pred == CmpInst::ICMP_EQ) ? CmpInst::ICMP_ULE : CmpInst::ICMP_UGT;
1939       return new ICmpInst(Pred, OrOp0, OrOp1);
1940     }
1941 
1942     // More general: canonicalize 'equality with set bits mask' to
1943     // 'equality with clear bits mask'.
1944     // (X | MaskC) == C --> (X & ~MaskC) == C ^ MaskC
1945     // (X | MaskC) != C --> (X & ~MaskC) != C ^ MaskC
1946     if (Or->hasOneUse()) {
1947       Value *And = Builder.CreateAnd(OrOp0, ~(*MaskC));
1948       Constant *NewC = ConstantInt::get(Or->getType(), C ^ (*MaskC));
1949       return new ICmpInst(Pred, And, NewC);
1950     }
1951   }
1952 
1953   if (!Cmp.isEquality() || !C.isNullValue() || !Or->hasOneUse())
1954     return nullptr;
1955 
1956   Value *P, *Q;
1957   if (match(Or, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1958     // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1959     // -> and (icmp eq P, null), (icmp eq Q, null).
1960     Value *CmpP =
1961         Builder.CreateICmp(Pred, P, ConstantInt::getNullValue(P->getType()));
1962     Value *CmpQ =
1963         Builder.CreateICmp(Pred, Q, ConstantInt::getNullValue(Q->getType()));
1964     auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1965     return BinaryOperator::Create(BOpc, CmpP, CmpQ);
1966   }
1967 
1968   // Are we using xors to bitwise check for a pair of (in)equalities? Convert to
1969   // a shorter form that has more potential to be folded even further.
1970   Value *X1, *X2, *X3, *X4;
1971   if (match(OrOp0, m_OneUse(m_Xor(m_Value(X1), m_Value(X2)))) &&
1972       match(OrOp1, m_OneUse(m_Xor(m_Value(X3), m_Value(X4))))) {
1973     // ((X1 ^ X2) || (X3 ^ X4)) == 0 --> (X1 == X2) && (X3 == X4)
1974     // ((X1 ^ X2) || (X3 ^ X4)) != 0 --> (X1 != X2) || (X3 != X4)
1975     Value *Cmp12 = Builder.CreateICmp(Pred, X1, X2);
1976     Value *Cmp34 = Builder.CreateICmp(Pred, X3, X4);
1977     auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1978     return BinaryOperator::Create(BOpc, Cmp12, Cmp34);
1979   }
1980 
1981   return nullptr;
1982 }
1983 
1984 /// Fold icmp (mul X, Y), C.
1985 Instruction *InstCombinerImpl::foldICmpMulConstant(ICmpInst &Cmp,
1986                                                    BinaryOperator *Mul,
1987                                                    const APInt &C) {
1988   const APInt *MulC;
1989   if (!match(Mul->getOperand(1), m_APInt(MulC)))
1990     return nullptr;
1991 
1992   // If this is a test of the sign bit and the multiply is sign-preserving with
1993   // a constant operand, use the multiply LHS operand instead.
1994   ICmpInst::Predicate Pred = Cmp.getPredicate();
1995   if (isSignTest(Pred, C) && Mul->hasNoSignedWrap()) {
1996     if (MulC->isNegative())
1997       Pred = ICmpInst::getSwappedPredicate(Pred);
1998     return new ICmpInst(Pred, Mul->getOperand(0),
1999                         Constant::getNullValue(Mul->getType()));
2000   }
2001 
2002   // If the multiply does not wrap, try to divide the compare constant by the
2003   // multiplication factor.
2004   if (Cmp.isEquality() && !MulC->isNullValue()) {
2005     // (mul nsw X, MulC) == C --> X == C /s MulC
2006     if (Mul->hasNoSignedWrap() && C.srem(*MulC).isNullValue()) {
2007       Constant *NewC = ConstantInt::get(Mul->getType(), C.sdiv(*MulC));
2008       return new ICmpInst(Pred, Mul->getOperand(0), NewC);
2009     }
2010     // (mul nuw X, MulC) == C --> X == C /u MulC
2011     if (Mul->hasNoUnsignedWrap() && C.urem(*MulC).isNullValue()) {
2012       Constant *NewC = ConstantInt::get(Mul->getType(), C.udiv(*MulC));
2013       return new ICmpInst(Pred, Mul->getOperand(0), NewC);
2014     }
2015   }
2016 
2017   return nullptr;
2018 }
2019 
2020 /// Fold icmp (shl 1, Y), C.
2021 static Instruction *foldICmpShlOne(ICmpInst &Cmp, Instruction *Shl,
2022                                    const APInt &C) {
2023   Value *Y;
2024   if (!match(Shl, m_Shl(m_One(), m_Value(Y))))
2025     return nullptr;
2026 
2027   Type *ShiftType = Shl->getType();
2028   unsigned TypeBits = C.getBitWidth();
2029   bool CIsPowerOf2 = C.isPowerOf2();
2030   ICmpInst::Predicate Pred = Cmp.getPredicate();
2031   if (Cmp.isUnsigned()) {
2032     // (1 << Y) pred C -> Y pred Log2(C)
2033     if (!CIsPowerOf2) {
2034       // (1 << Y) <  30 -> Y <= 4
2035       // (1 << Y) <= 30 -> Y <= 4
2036       // (1 << Y) >= 30 -> Y >  4
2037       // (1 << Y) >  30 -> Y >  4
2038       if (Pred == ICmpInst::ICMP_ULT)
2039         Pred = ICmpInst::ICMP_ULE;
2040       else if (Pred == ICmpInst::ICMP_UGE)
2041         Pred = ICmpInst::ICMP_UGT;
2042     }
2043 
2044     // (1 << Y) >= 2147483648 -> Y >= 31 -> Y == 31
2045     // (1 << Y) <  2147483648 -> Y <  31 -> Y != 31
2046     unsigned CLog2 = C.logBase2();
2047     if (CLog2 == TypeBits - 1) {
2048       if (Pred == ICmpInst::ICMP_UGE)
2049         Pred = ICmpInst::ICMP_EQ;
2050       else if (Pred == ICmpInst::ICMP_ULT)
2051         Pred = ICmpInst::ICMP_NE;
2052     }
2053     return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, CLog2));
2054   } else if (Cmp.isSigned()) {
2055     Constant *BitWidthMinusOne = ConstantInt::get(ShiftType, TypeBits - 1);
2056     if (C.isAllOnesValue()) {
2057       // (1 << Y) <= -1 -> Y == 31
2058       if (Pred == ICmpInst::ICMP_SLE)
2059         return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
2060 
2061       // (1 << Y) >  -1 -> Y != 31
2062       if (Pred == ICmpInst::ICMP_SGT)
2063         return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
2064     } else if (!C) {
2065       // (1 << Y) <  0 -> Y == 31
2066       // (1 << Y) <= 0 -> Y == 31
2067       if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
2068         return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
2069 
2070       // (1 << Y) >= 0 -> Y != 31
2071       // (1 << Y) >  0 -> Y != 31
2072       if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
2073         return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
2074     }
2075   } else if (Cmp.isEquality() && CIsPowerOf2) {
2076     return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, C.logBase2()));
2077   }
2078 
2079   return nullptr;
2080 }
2081 
2082 /// Fold icmp (shl X, Y), C.
2083 Instruction *InstCombinerImpl::foldICmpShlConstant(ICmpInst &Cmp,
2084                                                    BinaryOperator *Shl,
2085                                                    const APInt &C) {
2086   const APInt *ShiftVal;
2087   if (Cmp.isEquality() && match(Shl->getOperand(0), m_APInt(ShiftVal)))
2088     return foldICmpShlConstConst(Cmp, Shl->getOperand(1), C, *ShiftVal);
2089 
2090   const APInt *ShiftAmt;
2091   if (!match(Shl->getOperand(1), m_APInt(ShiftAmt)))
2092     return foldICmpShlOne(Cmp, Shl, C);
2093 
2094   // Check that the shift amount is in range. If not, don't perform undefined
2095   // shifts. When the shift is visited, it will be simplified.
2096   unsigned TypeBits = C.getBitWidth();
2097   if (ShiftAmt->uge(TypeBits))
2098     return nullptr;
2099 
2100   ICmpInst::Predicate Pred = Cmp.getPredicate();
2101   Value *X = Shl->getOperand(0);
2102   Type *ShType = Shl->getType();
2103 
2104   // NSW guarantees that we are only shifting out sign bits from the high bits,
2105   // so we can ASHR the compare constant without needing a mask and eliminate
2106   // the shift.
2107   if (Shl->hasNoSignedWrap()) {
2108     if (Pred == ICmpInst::ICMP_SGT) {
2109       // icmp Pred (shl nsw X, ShiftAmt), C --> icmp Pred X, (C >>s ShiftAmt)
2110       APInt ShiftedC = C.ashr(*ShiftAmt);
2111       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2112     }
2113     if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
2114         C.ashr(*ShiftAmt).shl(*ShiftAmt) == C) {
2115       APInt ShiftedC = C.ashr(*ShiftAmt);
2116       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2117     }
2118     if (Pred == ICmpInst::ICMP_SLT) {
2119       // SLE is the same as above, but SLE is canonicalized to SLT, so convert:
2120       // (X << S) <=s C is equiv to X <=s (C >> S) for all C
2121       // (X << S) <s (C + 1) is equiv to X <s (C >> S) + 1 if C <s SMAX
2122       // (X << S) <s C is equiv to X <s ((C - 1) >> S) + 1 if C >s SMIN
2123       assert(!C.isMinSignedValue() && "Unexpected icmp slt");
2124       APInt ShiftedC = (C - 1).ashr(*ShiftAmt) + 1;
2125       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2126     }
2127     // If this is a signed comparison to 0 and the shift is sign preserving,
2128     // use the shift LHS operand instead; isSignTest may change 'Pred', so only
2129     // do that if we're sure to not continue on in this function.
2130     if (isSignTest(Pred, C))
2131       return new ICmpInst(Pred, X, Constant::getNullValue(ShType));
2132   }
2133 
2134   // NUW guarantees that we are only shifting out zero bits from the high bits,
2135   // so we can LSHR the compare constant without needing a mask and eliminate
2136   // the shift.
2137   if (Shl->hasNoUnsignedWrap()) {
2138     if (Pred == ICmpInst::ICMP_UGT) {
2139       // icmp Pred (shl nuw X, ShiftAmt), C --> icmp Pred X, (C >>u ShiftAmt)
2140       APInt ShiftedC = C.lshr(*ShiftAmt);
2141       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2142     }
2143     if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
2144         C.lshr(*ShiftAmt).shl(*ShiftAmt) == C) {
2145       APInt ShiftedC = C.lshr(*ShiftAmt);
2146       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2147     }
2148     if (Pred == ICmpInst::ICMP_ULT) {
2149       // ULE is the same as above, but ULE is canonicalized to ULT, so convert:
2150       // (X << S) <=u C is equiv to X <=u (C >> S) for all C
2151       // (X << S) <u (C + 1) is equiv to X <u (C >> S) + 1 if C <u ~0u
2152       // (X << S) <u C is equiv to X <u ((C - 1) >> S) + 1 if C >u 0
2153       assert(C.ugt(0) && "ult 0 should have been eliminated");
2154       APInt ShiftedC = (C - 1).lshr(*ShiftAmt) + 1;
2155       return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
2156     }
2157   }
2158 
2159   if (Cmp.isEquality() && Shl->hasOneUse()) {
2160     // Strength-reduce the shift into an 'and'.
2161     Constant *Mask = ConstantInt::get(
2162         ShType,
2163         APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt->getZExtValue()));
2164     Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask");
2165     Constant *LShrC = ConstantInt::get(ShType, C.lshr(*ShiftAmt));
2166     return new ICmpInst(Pred, And, LShrC);
2167   }
2168 
2169   // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
2170   bool TrueIfSigned = false;
2171   if (Shl->hasOneUse() && isSignBitCheck(Pred, C, TrueIfSigned)) {
2172     // (X << 31) <s 0  --> (X & 1) != 0
2173     Constant *Mask = ConstantInt::get(
2174         ShType,
2175         APInt::getOneBitSet(TypeBits, TypeBits - ShiftAmt->getZExtValue() - 1));
2176     Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask");
2177     return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
2178                         And, Constant::getNullValue(ShType));
2179   }
2180 
2181   // Simplify 'shl' inequality test into 'and' equality test.
2182   if (Cmp.isUnsigned() && Shl->hasOneUse()) {
2183     // (X l<< C2) u<=/u> C1 iff C1+1 is power of two -> X & (~C1 l>> C2) ==/!= 0
2184     if ((C + 1).isPowerOf2() &&
2185         (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_UGT)) {
2186       Value *And = Builder.CreateAnd(X, (~C).lshr(ShiftAmt->getZExtValue()));
2187       return new ICmpInst(Pred == ICmpInst::ICMP_ULE ? ICmpInst::ICMP_EQ
2188                                                      : ICmpInst::ICMP_NE,
2189                           And, Constant::getNullValue(ShType));
2190     }
2191     // (X l<< C2) u</u>= C1 iff C1 is power of two -> X & (-C1 l>> C2) ==/!= 0
2192     if (C.isPowerOf2() &&
2193         (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE)) {
2194       Value *And =
2195           Builder.CreateAnd(X, (~(C - 1)).lshr(ShiftAmt->getZExtValue()));
2196       return new ICmpInst(Pred == ICmpInst::ICMP_ULT ? ICmpInst::ICMP_EQ
2197                                                      : ICmpInst::ICMP_NE,
2198                           And, Constant::getNullValue(ShType));
2199     }
2200   }
2201 
2202   // Transform (icmp pred iM (shl iM %v, N), C)
2203   // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (C>>N))
2204   // Transform the shl to a trunc if (trunc (C>>N)) has no loss and M-N.
2205   // This enables us to get rid of the shift in favor of a trunc that may be
2206   // free on the target. It has the additional benefit of comparing to a
2207   // smaller constant that may be more target-friendly.
2208   unsigned Amt = ShiftAmt->getLimitedValue(TypeBits - 1);
2209   if (Shl->hasOneUse() && Amt != 0 && C.countTrailingZeros() >= Amt &&
2210       DL.isLegalInteger(TypeBits - Amt)) {
2211     Type *TruncTy = IntegerType::get(Cmp.getContext(), TypeBits - Amt);
2212     if (auto *ShVTy = dyn_cast<VectorType>(ShType))
2213       TruncTy = VectorType::get(TruncTy, ShVTy->getElementCount());
2214     Constant *NewC =
2215         ConstantInt::get(TruncTy, C.ashr(*ShiftAmt).trunc(TypeBits - Amt));
2216     return new ICmpInst(Pred, Builder.CreateTrunc(X, TruncTy), NewC);
2217   }
2218 
2219   return nullptr;
2220 }
2221 
2222 /// Fold icmp ({al}shr X, Y), C.
2223 Instruction *InstCombinerImpl::foldICmpShrConstant(ICmpInst &Cmp,
2224                                                    BinaryOperator *Shr,
2225                                                    const APInt &C) {
2226   // An exact shr only shifts out zero bits, so:
2227   // icmp eq/ne (shr X, Y), 0 --> icmp eq/ne X, 0
2228   Value *X = Shr->getOperand(0);
2229   CmpInst::Predicate Pred = Cmp.getPredicate();
2230   if (Cmp.isEquality() && Shr->isExact() && Shr->hasOneUse() &&
2231       C.isNullValue())
2232     return new ICmpInst(Pred, X, Cmp.getOperand(1));
2233 
2234   const APInt *ShiftVal;
2235   if (Cmp.isEquality() && match(Shr->getOperand(0), m_APInt(ShiftVal)))
2236     return foldICmpShrConstConst(Cmp, Shr->getOperand(1), C, *ShiftVal);
2237 
2238   const APInt *ShiftAmt;
2239   if (!match(Shr->getOperand(1), m_APInt(ShiftAmt)))
2240     return nullptr;
2241 
2242   // Check that the shift amount is in range. If not, don't perform undefined
2243   // shifts. When the shift is visited it will be simplified.
2244   unsigned TypeBits = C.getBitWidth();
2245   unsigned ShAmtVal = ShiftAmt->getLimitedValue(TypeBits);
2246   if (ShAmtVal >= TypeBits || ShAmtVal == 0)
2247     return nullptr;
2248 
2249   bool IsAShr = Shr->getOpcode() == Instruction::AShr;
2250   bool IsExact = Shr->isExact();
2251   Type *ShrTy = Shr->getType();
2252   // TODO: If we could guarantee that InstSimplify would handle all of the
2253   // constant-value-based preconditions in the folds below, then we could assert
2254   // those conditions rather than checking them. This is difficult because of
2255   // undef/poison (PR34838).
2256   if (IsAShr) {
2257     if (Pred == CmpInst::ICMP_SLT || (Pred == CmpInst::ICMP_SGT && IsExact)) {
2258       // icmp slt (ashr X, ShAmtC), C --> icmp slt X, (C << ShAmtC)
2259       // icmp sgt (ashr exact X, ShAmtC), C --> icmp sgt X, (C << ShAmtC)
2260       APInt ShiftedC = C.shl(ShAmtVal);
2261       if (ShiftedC.ashr(ShAmtVal) == C)
2262         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2263     }
2264     if (Pred == CmpInst::ICMP_SGT) {
2265       // icmp sgt (ashr X, ShAmtC), C --> icmp sgt X, ((C + 1) << ShAmtC) - 1
2266       APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1;
2267       if (!C.isMaxSignedValue() && !(C + 1).shl(ShAmtVal).isMinSignedValue() &&
2268           (ShiftedC + 1).ashr(ShAmtVal) == (C + 1))
2269         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2270     }
2271 
2272     // If the compare constant has significant bits above the lowest sign-bit,
2273     // then convert an unsigned cmp to a test of the sign-bit:
2274     // (ashr X, ShiftC) u> C --> X s< 0
2275     // (ashr X, ShiftC) u< C --> X s> -1
2276     if (C.getBitWidth() > 2 && C.getNumSignBits() <= ShAmtVal) {
2277       if (Pred == CmpInst::ICMP_UGT) {
2278         return new ICmpInst(CmpInst::ICMP_SLT, X,
2279                             ConstantInt::getNullValue(ShrTy));
2280       }
2281       if (Pred == CmpInst::ICMP_ULT) {
2282         return new ICmpInst(CmpInst::ICMP_SGT, X,
2283                             ConstantInt::getAllOnesValue(ShrTy));
2284       }
2285     }
2286   } else {
2287     if (Pred == CmpInst::ICMP_ULT || (Pred == CmpInst::ICMP_UGT && IsExact)) {
2288       // icmp ult (lshr X, ShAmtC), C --> icmp ult X, (C << ShAmtC)
2289       // icmp ugt (lshr exact X, ShAmtC), C --> icmp ugt X, (C << ShAmtC)
2290       APInt ShiftedC = C.shl(ShAmtVal);
2291       if (ShiftedC.lshr(ShAmtVal) == C)
2292         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2293     }
2294     if (Pred == CmpInst::ICMP_UGT) {
2295       // icmp ugt (lshr X, ShAmtC), C --> icmp ugt X, ((C + 1) << ShAmtC) - 1
2296       APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1;
2297       if ((ShiftedC + 1).lshr(ShAmtVal) == (C + 1))
2298         return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2299     }
2300   }
2301 
2302   if (!Cmp.isEquality())
2303     return nullptr;
2304 
2305   // Handle equality comparisons of shift-by-constant.
2306 
2307   // If the comparison constant changes with the shift, the comparison cannot
2308   // succeed (bits of the comparison constant cannot match the shifted value).
2309   // This should be known by InstSimplify and already be folded to true/false.
2310   assert(((IsAShr && C.shl(ShAmtVal).ashr(ShAmtVal) == C) ||
2311           (!IsAShr && C.shl(ShAmtVal).lshr(ShAmtVal) == C)) &&
2312          "Expected icmp+shr simplify did not occur.");
2313 
2314   // If the bits shifted out are known zero, compare the unshifted value:
2315   //  (X & 4) >> 1 == 2  --> (X & 4) == 4.
2316   if (Shr->isExact())
2317     return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, C << ShAmtVal));
2318 
2319   if (C.isNullValue()) {
2320     // == 0 is u< 1.
2321     if (Pred == CmpInst::ICMP_EQ)
2322       return new ICmpInst(CmpInst::ICMP_ULT, X,
2323                           ConstantInt::get(ShrTy, (C + 1).shl(ShAmtVal)));
2324     else
2325       return new ICmpInst(CmpInst::ICMP_UGT, X,
2326                           ConstantInt::get(ShrTy, (C + 1).shl(ShAmtVal) - 1));
2327   }
2328 
2329   if (Shr->hasOneUse()) {
2330     // Canonicalize the shift into an 'and':
2331     // icmp eq/ne (shr X, ShAmt), C --> icmp eq/ne (and X, HiMask), (C << ShAmt)
2332     APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
2333     Constant *Mask = ConstantInt::get(ShrTy, Val);
2334     Value *And = Builder.CreateAnd(X, Mask, Shr->getName() + ".mask");
2335     return new ICmpInst(Pred, And, ConstantInt::get(ShrTy, C << ShAmtVal));
2336   }
2337 
2338   return nullptr;
2339 }
2340 
2341 Instruction *InstCombinerImpl::foldICmpSRemConstant(ICmpInst &Cmp,
2342                                                     BinaryOperator *SRem,
2343                                                     const APInt &C) {
2344   // Match an 'is positive' or 'is negative' comparison of remainder by a
2345   // constant power-of-2 value:
2346   // (X % pow2C) sgt/slt 0
2347   const ICmpInst::Predicate Pred = Cmp.getPredicate();
2348   if (Pred != ICmpInst::ICMP_SGT && Pred != ICmpInst::ICMP_SLT)
2349     return nullptr;
2350 
2351   // TODO: The one-use check is standard because we do not typically want to
2352   //       create longer instruction sequences, but this might be a special-case
2353   //       because srem is not good for analysis or codegen.
2354   if (!SRem->hasOneUse())
2355     return nullptr;
2356 
2357   const APInt *DivisorC;
2358   if (!C.isNullValue() || !match(SRem->getOperand(1), m_Power2(DivisorC)))
2359     return nullptr;
2360 
2361   // Mask off the sign bit and the modulo bits (low-bits).
2362   Type *Ty = SRem->getType();
2363   APInt SignMask = APInt::getSignMask(Ty->getScalarSizeInBits());
2364   Constant *MaskC = ConstantInt::get(Ty, SignMask | (*DivisorC - 1));
2365   Value *And = Builder.CreateAnd(SRem->getOperand(0), MaskC);
2366 
2367   // For 'is positive?' check that the sign-bit is clear and at least 1 masked
2368   // bit is set. Example:
2369   // (i8 X % 32) s> 0 --> (X & 159) s> 0
2370   if (Pred == ICmpInst::ICMP_SGT)
2371     return new ICmpInst(ICmpInst::ICMP_SGT, And, ConstantInt::getNullValue(Ty));
2372 
2373   // For 'is negative?' check that the sign-bit is set and at least 1 masked
2374   // bit is set. Example:
2375   // (i16 X % 4) s< 0 --> (X & 32771) u> 32768
2376   return new ICmpInst(ICmpInst::ICMP_UGT, And, ConstantInt::get(Ty, SignMask));
2377 }
2378 
2379 /// Fold icmp (udiv X, Y), C.
2380 Instruction *InstCombinerImpl::foldICmpUDivConstant(ICmpInst &Cmp,
2381                                                     BinaryOperator *UDiv,
2382                                                     const APInt &C) {
2383   const APInt *C2;
2384   if (!match(UDiv->getOperand(0), m_APInt(C2)))
2385     return nullptr;
2386 
2387   assert(*C2 != 0 && "udiv 0, X should have been simplified already.");
2388 
2389   // (icmp ugt (udiv C2, Y), C) -> (icmp ule Y, C2/(C+1))
2390   Value *Y = UDiv->getOperand(1);
2391   if (Cmp.getPredicate() == ICmpInst::ICMP_UGT) {
2392     assert(!C.isMaxValue() &&
2393            "icmp ugt X, UINT_MAX should have been simplified already.");
2394     return new ICmpInst(ICmpInst::ICMP_ULE, Y,
2395                         ConstantInt::get(Y->getType(), C2->udiv(C + 1)));
2396   }
2397 
2398   // (icmp ult (udiv C2, Y), C) -> (icmp ugt Y, C2/C)
2399   if (Cmp.getPredicate() == ICmpInst::ICMP_ULT) {
2400     assert(C != 0 && "icmp ult X, 0 should have been simplified already.");
2401     return new ICmpInst(ICmpInst::ICMP_UGT, Y,
2402                         ConstantInt::get(Y->getType(), C2->udiv(C)));
2403   }
2404 
2405   return nullptr;
2406 }
2407 
2408 /// Fold icmp ({su}div X, Y), C.
2409 Instruction *InstCombinerImpl::foldICmpDivConstant(ICmpInst &Cmp,
2410                                                    BinaryOperator *Div,
2411                                                    const APInt &C) {
2412   // Fold: icmp pred ([us]div X, C2), C -> range test
2413   // Fold this div into the comparison, producing a range check.
2414   // Determine, based on the divide type, what the range is being
2415   // checked.  If there is an overflow on the low or high side, remember
2416   // it, otherwise compute the range [low, hi) bounding the new value.
2417   // See: InsertRangeTest above for the kinds of replacements possible.
2418   const APInt *C2;
2419   if (!match(Div->getOperand(1), m_APInt(C2)))
2420     return nullptr;
2421 
2422   // FIXME: If the operand types don't match the type of the divide
2423   // then don't attempt this transform. The code below doesn't have the
2424   // logic to deal with a signed divide and an unsigned compare (and
2425   // vice versa). This is because (x /s C2) <s C  produces different
2426   // results than (x /s C2) <u C or (x /u C2) <s C or even
2427   // (x /u C2) <u C.  Simply casting the operands and result won't
2428   // work. :(  The if statement below tests that condition and bails
2429   // if it finds it.
2430   bool DivIsSigned = Div->getOpcode() == Instruction::SDiv;
2431   if (!Cmp.isEquality() && DivIsSigned != Cmp.isSigned())
2432     return nullptr;
2433 
2434   // The ProdOV computation fails on divide by 0 and divide by -1. Cases with
2435   // INT_MIN will also fail if the divisor is 1. Although folds of all these
2436   // division-by-constant cases should be present, we can not assert that they
2437   // have happened before we reach this icmp instruction.
2438   if (C2->isNullValue() || C2->isOneValue() ||
2439       (DivIsSigned && C2->isAllOnesValue()))
2440     return nullptr;
2441 
2442   // Compute Prod = C * C2. We are essentially solving an equation of
2443   // form X / C2 = C. We solve for X by multiplying C2 and C.
2444   // By solving for X, we can turn this into a range check instead of computing
2445   // a divide.
2446   APInt Prod = C * *C2;
2447 
2448   // Determine if the product overflows by seeing if the product is not equal to
2449   // the divide. Make sure we do the same kind of divide as in the LHS
2450   // instruction that we're folding.
2451   bool ProdOV = (DivIsSigned ? Prod.sdiv(*C2) : Prod.udiv(*C2)) != C;
2452 
2453   ICmpInst::Predicate Pred = Cmp.getPredicate();
2454 
2455   // If the division is known to be exact, then there is no remainder from the
2456   // divide, so the covered range size is unit, otherwise it is the divisor.
2457   APInt RangeSize = Div->isExact() ? APInt(C2->getBitWidth(), 1) : *C2;
2458 
2459   // Figure out the interval that is being checked.  For example, a comparison
2460   // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
2461   // Compute this interval based on the constants involved and the signedness of
2462   // the compare/divide.  This computes a half-open interval, keeping track of
2463   // whether either value in the interval overflows.  After analysis each
2464   // overflow variable is set to 0 if it's corresponding bound variable is valid
2465   // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
2466   int LoOverflow = 0, HiOverflow = 0;
2467   APInt LoBound, HiBound;
2468 
2469   if (!DivIsSigned) {  // udiv
2470     // e.g. X/5 op 3  --> [15, 20)
2471     LoBound = Prod;
2472     HiOverflow = LoOverflow = ProdOV;
2473     if (!HiOverflow) {
2474       // If this is not an exact divide, then many values in the range collapse
2475       // to the same result value.
2476       HiOverflow = addWithOverflow(HiBound, LoBound, RangeSize, false);
2477     }
2478   } else if (C2->isStrictlyPositive()) { // Divisor is > 0.
2479     if (C.isNullValue()) {       // (X / pos) op 0
2480       // Can't overflow.  e.g.  X/2 op 0 --> [-1, 2)
2481       LoBound = -(RangeSize - 1);
2482       HiBound = RangeSize;
2483     } else if (C.isStrictlyPositive()) {   // (X / pos) op pos
2484       LoBound = Prod;     // e.g.   X/5 op 3 --> [15, 20)
2485       HiOverflow = LoOverflow = ProdOV;
2486       if (!HiOverflow)
2487         HiOverflow = addWithOverflow(HiBound, Prod, RangeSize, true);
2488     } else {                       // (X / pos) op neg
2489       // e.g. X/5 op -3  --> [-15-4, -15+1) --> [-19, -14)
2490       HiBound = Prod + 1;
2491       LoOverflow = HiOverflow = ProdOV ? -1 : 0;
2492       if (!LoOverflow) {
2493         APInt DivNeg = -RangeSize;
2494         LoOverflow = addWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
2495       }
2496     }
2497   } else if (C2->isNegative()) { // Divisor is < 0.
2498     if (Div->isExact())
2499       RangeSize.negate();
2500     if (C.isNullValue()) { // (X / neg) op 0
2501       // e.g. X/-5 op 0  --> [-4, 5)
2502       LoBound = RangeSize + 1;
2503       HiBound = -RangeSize;
2504       if (HiBound == *C2) {        // -INTMIN = INTMIN
2505         HiOverflow = 1;            // [INTMIN+1, overflow)
2506         HiBound = APInt();         // e.g. X/INTMIN = 0 --> X > INTMIN
2507       }
2508     } else if (C.isStrictlyPositive()) {   // (X / neg) op pos
2509       // e.g. X/-5 op 3  --> [-19, -14)
2510       HiBound = Prod + 1;
2511       HiOverflow = LoOverflow = ProdOV ? -1 : 0;
2512       if (!LoOverflow)
2513         LoOverflow = addWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
2514     } else {                       // (X / neg) op neg
2515       LoBound = Prod;       // e.g. X/-5 op -3  --> [15, 20)
2516       LoOverflow = HiOverflow = ProdOV;
2517       if (!HiOverflow)
2518         HiOverflow = subWithOverflow(HiBound, Prod, RangeSize, true);
2519     }
2520 
2521     // Dividing by a negative swaps the condition.  LT <-> GT
2522     Pred = ICmpInst::getSwappedPredicate(Pred);
2523   }
2524 
2525   Value *X = Div->getOperand(0);
2526   switch (Pred) {
2527     default: llvm_unreachable("Unhandled icmp opcode!");
2528     case ICmpInst::ICMP_EQ:
2529       if (LoOverflow && HiOverflow)
2530         return replaceInstUsesWith(Cmp, Builder.getFalse());
2531       if (HiOverflow)
2532         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
2533                             ICmpInst::ICMP_UGE, X,
2534                             ConstantInt::get(Div->getType(), LoBound));
2535       if (LoOverflow)
2536         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
2537                             ICmpInst::ICMP_ULT, X,
2538                             ConstantInt::get(Div->getType(), HiBound));
2539       return replaceInstUsesWith(
2540           Cmp, insertRangeTest(X, LoBound, HiBound, DivIsSigned, true));
2541     case ICmpInst::ICMP_NE:
2542       if (LoOverflow && HiOverflow)
2543         return replaceInstUsesWith(Cmp, Builder.getTrue());
2544       if (HiOverflow)
2545         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
2546                             ICmpInst::ICMP_ULT, X,
2547                             ConstantInt::get(Div->getType(), LoBound));
2548       if (LoOverflow)
2549         return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
2550                             ICmpInst::ICMP_UGE, X,
2551                             ConstantInt::get(Div->getType(), HiBound));
2552       return replaceInstUsesWith(Cmp,
2553                                  insertRangeTest(X, LoBound, HiBound,
2554                                                  DivIsSigned, false));
2555     case ICmpInst::ICMP_ULT:
2556     case ICmpInst::ICMP_SLT:
2557       if (LoOverflow == +1)   // Low bound is greater than input range.
2558         return replaceInstUsesWith(Cmp, Builder.getTrue());
2559       if (LoOverflow == -1)   // Low bound is less than input range.
2560         return replaceInstUsesWith(Cmp, Builder.getFalse());
2561       return new ICmpInst(Pred, X, ConstantInt::get(Div->getType(), LoBound));
2562     case ICmpInst::ICMP_UGT:
2563     case ICmpInst::ICMP_SGT:
2564       if (HiOverflow == +1)       // High bound greater than input range.
2565         return replaceInstUsesWith(Cmp, Builder.getFalse());
2566       if (HiOverflow == -1)       // High bound less than input range.
2567         return replaceInstUsesWith(Cmp, Builder.getTrue());
2568       if (Pred == ICmpInst::ICMP_UGT)
2569         return new ICmpInst(ICmpInst::ICMP_UGE, X,
2570                             ConstantInt::get(Div->getType(), HiBound));
2571       return new ICmpInst(ICmpInst::ICMP_SGE, X,
2572                           ConstantInt::get(Div->getType(), HiBound));
2573   }
2574 
2575   return nullptr;
2576 }
2577 
2578 /// Fold icmp (sub X, Y), C.
2579 Instruction *InstCombinerImpl::foldICmpSubConstant(ICmpInst &Cmp,
2580                                                    BinaryOperator *Sub,
2581                                                    const APInt &C) {
2582   Value *X = Sub->getOperand(0), *Y = Sub->getOperand(1);
2583   ICmpInst::Predicate Pred = Cmp.getPredicate();
2584   const APInt *C2;
2585   APInt SubResult;
2586 
2587   // icmp eq/ne (sub C, Y), C -> icmp eq/ne Y, 0
2588   if (match(X, m_APInt(C2)) && *C2 == C && Cmp.isEquality())
2589     return new ICmpInst(Cmp.getPredicate(), Y,
2590                         ConstantInt::get(Y->getType(), 0));
2591 
2592   // (icmp P (sub nuw|nsw C2, Y), C) -> (icmp swap(P) Y, C2-C)
2593   if (match(X, m_APInt(C2)) &&
2594       ((Cmp.isUnsigned() && Sub->hasNoUnsignedWrap()) ||
2595        (Cmp.isSigned() && Sub->hasNoSignedWrap())) &&
2596       !subWithOverflow(SubResult, *C2, C, Cmp.isSigned()))
2597     return new ICmpInst(Cmp.getSwappedPredicate(), Y,
2598                         ConstantInt::get(Y->getType(), SubResult));
2599 
2600   // The following transforms are only worth it if the only user of the subtract
2601   // is the icmp.
2602   if (!Sub->hasOneUse())
2603     return nullptr;
2604 
2605   if (Sub->hasNoSignedWrap()) {
2606     // (icmp sgt (sub nsw X, Y), -1) -> (icmp sge X, Y)
2607     if (Pred == ICmpInst::ICMP_SGT && C.isAllOnesValue())
2608       return new ICmpInst(ICmpInst::ICMP_SGE, X, Y);
2609 
2610     // (icmp sgt (sub nsw X, Y), 0) -> (icmp sgt X, Y)
2611     if (Pred == ICmpInst::ICMP_SGT && C.isNullValue())
2612       return new ICmpInst(ICmpInst::ICMP_SGT, X, Y);
2613 
2614     // (icmp slt (sub nsw X, Y), 0) -> (icmp slt X, Y)
2615     if (Pred == ICmpInst::ICMP_SLT && C.isNullValue())
2616       return new ICmpInst(ICmpInst::ICMP_SLT, X, Y);
2617 
2618     // (icmp slt (sub nsw X, Y), 1) -> (icmp sle X, Y)
2619     if (Pred == ICmpInst::ICMP_SLT && C.isOneValue())
2620       return new ICmpInst(ICmpInst::ICMP_SLE, X, Y);
2621   }
2622 
2623   if (!match(X, m_APInt(C2)))
2624     return nullptr;
2625 
2626   // C2 - Y <u C -> (Y | (C - 1)) == C2
2627   //   iff (C2 & (C - 1)) == C - 1 and C is a power of 2
2628   if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() &&
2629       (*C2 & (C - 1)) == (C - 1))
2630     return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateOr(Y, C - 1), X);
2631 
2632   // C2 - Y >u C -> (Y | C) != C2
2633   //   iff C2 & C == C and C + 1 is a power of 2
2634   if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == C)
2635     return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateOr(Y, C), X);
2636 
2637   return nullptr;
2638 }
2639 
2640 /// Fold icmp (add X, Y), C.
2641 Instruction *InstCombinerImpl::foldICmpAddConstant(ICmpInst &Cmp,
2642                                                    BinaryOperator *Add,
2643                                                    const APInt &C) {
2644   Value *Y = Add->getOperand(1);
2645   const APInt *C2;
2646   if (Cmp.isEquality() || !match(Y, m_APInt(C2)))
2647     return nullptr;
2648 
2649   // Fold icmp pred (add X, C2), C.
2650   Value *X = Add->getOperand(0);
2651   Type *Ty = Add->getType();
2652   const CmpInst::Predicate Pred = Cmp.getPredicate();
2653 
2654   // If the add does not wrap, we can always adjust the compare by subtracting
2655   // the constants. Equality comparisons are handled elsewhere. SGE/SLE/UGE/ULE
2656   // are canonicalized to SGT/SLT/UGT/ULT.
2657   if ((Add->hasNoSignedWrap() &&
2658        (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLT)) ||
2659       (Add->hasNoUnsignedWrap() &&
2660        (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULT))) {
2661     bool Overflow;
2662     APInt NewC =
2663         Cmp.isSigned() ? C.ssub_ov(*C2, Overflow) : C.usub_ov(*C2, Overflow);
2664     // If there is overflow, the result must be true or false.
2665     // TODO: Can we assert there is no overflow because InstSimplify always
2666     // handles those cases?
2667     if (!Overflow)
2668       // icmp Pred (add nsw X, C2), C --> icmp Pred X, (C - C2)
2669       return new ICmpInst(Pred, X, ConstantInt::get(Ty, NewC));
2670   }
2671 
2672   auto CR = ConstantRange::makeExactICmpRegion(Pred, C).subtract(*C2);
2673   const APInt &Upper = CR.getUpper();
2674   const APInt &Lower = CR.getLower();
2675   if (Cmp.isSigned()) {
2676     if (Lower.isSignMask())
2677       return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, Upper));
2678     if (Upper.isSignMask())
2679       return new ICmpInst(ICmpInst::ICMP_SGE, X, ConstantInt::get(Ty, Lower));
2680   } else {
2681     if (Lower.isMinValue())
2682       return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, Upper));
2683     if (Upper.isMinValue())
2684       return new ICmpInst(ICmpInst::ICMP_UGE, X, ConstantInt::get(Ty, Lower));
2685   }
2686 
2687   // This set of folds is intentionally placed after folds that use no-wrapping
2688   // flags because those folds are likely better for later analysis/codegen.
2689   const APInt SMax = APInt::getSignedMaxValue(Ty->getScalarSizeInBits());
2690   const APInt SMin = APInt::getSignedMinValue(Ty->getScalarSizeInBits());
2691 
2692   // Fold compare with offset to opposite sign compare if it eliminates offset:
2693   // (X + C2) >u C --> X <s -C2 (if C == C2 + SMAX)
2694   if (Pred == CmpInst::ICMP_UGT && C == *C2 + SMax)
2695     return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, -(*C2)));
2696 
2697   // (X + C2) <u C --> X >s ~C2 (if C == C2 + SMIN)
2698   if (Pred == CmpInst::ICMP_ULT && C == *C2 + SMin)
2699     return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantInt::get(Ty, ~(*C2)));
2700 
2701   // (X + C2) >s C --> X <u (SMAX - C) (if C == C2 - 1)
2702   if (Pred == CmpInst::ICMP_SGT && C == *C2 - 1)
2703     return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, SMax - C));
2704 
2705   // (X + C2) <s C --> X >u (C ^ SMAX) (if C == C2)
2706   if (Pred == CmpInst::ICMP_SLT && C == *C2)
2707     return new ICmpInst(ICmpInst::ICMP_UGT, X, ConstantInt::get(Ty, C ^ SMax));
2708 
2709   if (!Add->hasOneUse())
2710     return nullptr;
2711 
2712   // X+C <u C2 -> (X & -C2) == C
2713   //   iff C & (C2-1) == 0
2714   //       C2 is a power of 2
2715   if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() && (*C2 & (C - 1)) == 0)
2716     return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateAnd(X, -C),
2717                         ConstantExpr::getNeg(cast<Constant>(Y)));
2718 
2719   // X+C >u C2 -> (X & ~C2) != C
2720   //   iff C & C2 == 0
2721   //       C2+1 is a power of 2
2722   if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == 0)
2723     return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateAnd(X, ~C),
2724                         ConstantExpr::getNeg(cast<Constant>(Y)));
2725 
2726   return nullptr;
2727 }
2728 
2729 bool InstCombinerImpl::matchThreeWayIntCompare(SelectInst *SI, Value *&LHS,
2730                                                Value *&RHS, ConstantInt *&Less,
2731                                                ConstantInt *&Equal,
2732                                                ConstantInt *&Greater) {
2733   // TODO: Generalize this to work with other comparison idioms or ensure
2734   // they get canonicalized into this form.
2735 
2736   // select i1 (a == b),
2737   //        i32 Equal,
2738   //        i32 (select i1 (a < b), i32 Less, i32 Greater)
2739   // where Equal, Less and Greater are placeholders for any three constants.
2740   ICmpInst::Predicate PredA;
2741   if (!match(SI->getCondition(), m_ICmp(PredA, m_Value(LHS), m_Value(RHS))) ||
2742       !ICmpInst::isEquality(PredA))
2743     return false;
2744   Value *EqualVal = SI->getTrueValue();
2745   Value *UnequalVal = SI->getFalseValue();
2746   // We still can get non-canonical predicate here, so canonicalize.
2747   if (PredA == ICmpInst::ICMP_NE)
2748     std::swap(EqualVal, UnequalVal);
2749   if (!match(EqualVal, m_ConstantInt(Equal)))
2750     return false;
2751   ICmpInst::Predicate PredB;
2752   Value *LHS2, *RHS2;
2753   if (!match(UnequalVal, m_Select(m_ICmp(PredB, m_Value(LHS2), m_Value(RHS2)),
2754                                   m_ConstantInt(Less), m_ConstantInt(Greater))))
2755     return false;
2756   // We can get predicate mismatch here, so canonicalize if possible:
2757   // First, ensure that 'LHS' match.
2758   if (LHS2 != LHS) {
2759     // x sgt y <--> y slt x
2760     std::swap(LHS2, RHS2);
2761     PredB = ICmpInst::getSwappedPredicate(PredB);
2762   }
2763   if (LHS2 != LHS)
2764     return false;
2765   // We also need to canonicalize 'RHS'.
2766   if (PredB == ICmpInst::ICMP_SGT && isa<Constant>(RHS2)) {
2767     // x sgt C-1  <-->  x sge C  <-->  not(x slt C)
2768     auto FlippedStrictness =
2769         InstCombiner::getFlippedStrictnessPredicateAndConstant(
2770             PredB, cast<Constant>(RHS2));
2771     if (!FlippedStrictness)
2772       return false;
2773     assert(FlippedStrictness->first == ICmpInst::ICMP_SGE && "Sanity check");
2774     RHS2 = FlippedStrictness->second;
2775     // And kind-of perform the result swap.
2776     std::swap(Less, Greater);
2777     PredB = ICmpInst::ICMP_SLT;
2778   }
2779   return PredB == ICmpInst::ICMP_SLT && RHS == RHS2;
2780 }
2781 
2782 Instruction *InstCombinerImpl::foldICmpSelectConstant(ICmpInst &Cmp,
2783                                                       SelectInst *Select,
2784                                                       ConstantInt *C) {
2785 
2786   assert(C && "Cmp RHS should be a constant int!");
2787   // If we're testing a constant value against the result of a three way
2788   // comparison, the result can be expressed directly in terms of the
2789   // original values being compared.  Note: We could possibly be more
2790   // aggressive here and remove the hasOneUse test. The original select is
2791   // really likely to simplify or sink when we remove a test of the result.
2792   Value *OrigLHS, *OrigRHS;
2793   ConstantInt *C1LessThan, *C2Equal, *C3GreaterThan;
2794   if (Cmp.hasOneUse() &&
2795       matchThreeWayIntCompare(Select, OrigLHS, OrigRHS, C1LessThan, C2Equal,
2796                               C3GreaterThan)) {
2797     assert(C1LessThan && C2Equal && C3GreaterThan);
2798 
2799     bool TrueWhenLessThan =
2800         ConstantExpr::getCompare(Cmp.getPredicate(), C1LessThan, C)
2801             ->isAllOnesValue();
2802     bool TrueWhenEqual =
2803         ConstantExpr::getCompare(Cmp.getPredicate(), C2Equal, C)
2804             ->isAllOnesValue();
2805     bool TrueWhenGreaterThan =
2806         ConstantExpr::getCompare(Cmp.getPredicate(), C3GreaterThan, C)
2807             ->isAllOnesValue();
2808 
2809     // This generates the new instruction that will replace the original Cmp
2810     // Instruction. Instead of enumerating the various combinations when
2811     // TrueWhenLessThan, TrueWhenEqual and TrueWhenGreaterThan are true versus
2812     // false, we rely on chaining of ORs and future passes of InstCombine to
2813     // simplify the OR further (i.e. a s< b || a == b becomes a s<= b).
2814 
2815     // When none of the three constants satisfy the predicate for the RHS (C),
2816     // the entire original Cmp can be simplified to a false.
2817     Value *Cond = Builder.getFalse();
2818     if (TrueWhenLessThan)
2819       Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SLT,
2820                                                        OrigLHS, OrigRHS));
2821     if (TrueWhenEqual)
2822       Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_EQ,
2823                                                        OrigLHS, OrigRHS));
2824     if (TrueWhenGreaterThan)
2825       Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SGT,
2826                                                        OrigLHS, OrigRHS));
2827 
2828     return replaceInstUsesWith(Cmp, Cond);
2829   }
2830   return nullptr;
2831 }
2832 
2833 Instruction *InstCombinerImpl::foldICmpBitCast(ICmpInst &Cmp) {
2834   auto *Bitcast = dyn_cast<BitCastInst>(Cmp.getOperand(0));
2835   if (!Bitcast)
2836     return nullptr;
2837 
2838   ICmpInst::Predicate Pred = Cmp.getPredicate();
2839   Value *Op1 = Cmp.getOperand(1);
2840   Value *BCSrcOp = Bitcast->getOperand(0);
2841 
2842   // Make sure the bitcast doesn't change the number of vector elements.
2843   if (Bitcast->getSrcTy()->getScalarSizeInBits() ==
2844           Bitcast->getDestTy()->getScalarSizeInBits()) {
2845     // Zero-equality and sign-bit checks are preserved through sitofp + bitcast.
2846     Value *X;
2847     if (match(BCSrcOp, m_SIToFP(m_Value(X)))) {
2848       // icmp  eq (bitcast (sitofp X)), 0 --> icmp  eq X, 0
2849       // icmp  ne (bitcast (sitofp X)), 0 --> icmp  ne X, 0
2850       // icmp slt (bitcast (sitofp X)), 0 --> icmp slt X, 0
2851       // icmp sgt (bitcast (sitofp X)), 0 --> icmp sgt X, 0
2852       if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_SLT ||
2853            Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT) &&
2854           match(Op1, m_Zero()))
2855         return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType()));
2856 
2857       // icmp slt (bitcast (sitofp X)), 1 --> icmp slt X, 1
2858       if (Pred == ICmpInst::ICMP_SLT && match(Op1, m_One()))
2859         return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), 1));
2860 
2861       // icmp sgt (bitcast (sitofp X)), -1 --> icmp sgt X, -1
2862       if (Pred == ICmpInst::ICMP_SGT && match(Op1, m_AllOnes()))
2863         return new ICmpInst(Pred, X,
2864                             ConstantInt::getAllOnesValue(X->getType()));
2865     }
2866 
2867     // Zero-equality checks are preserved through unsigned floating-point casts:
2868     // icmp eq (bitcast (uitofp X)), 0 --> icmp eq X, 0
2869     // icmp ne (bitcast (uitofp X)), 0 --> icmp ne X, 0
2870     if (match(BCSrcOp, m_UIToFP(m_Value(X))))
2871       if (Cmp.isEquality() && match(Op1, m_Zero()))
2872         return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType()));
2873 
2874     // If this is a sign-bit test of a bitcast of a casted FP value, eliminate
2875     // the FP extend/truncate because that cast does not change the sign-bit.
2876     // This is true for all standard IEEE-754 types and the X86 80-bit type.
2877     // The sign-bit is always the most significant bit in those types.
2878     const APInt *C;
2879     bool TrueIfSigned;
2880     if (match(Op1, m_APInt(C)) && Bitcast->hasOneUse() &&
2881         InstCombiner::isSignBitCheck(Pred, *C, TrueIfSigned)) {
2882       if (match(BCSrcOp, m_FPExt(m_Value(X))) ||
2883           match(BCSrcOp, m_FPTrunc(m_Value(X)))) {
2884         // (bitcast (fpext/fptrunc X)) to iX) < 0 --> (bitcast X to iY) < 0
2885         // (bitcast (fpext/fptrunc X)) to iX) > -1 --> (bitcast X to iY) > -1
2886         Type *XType = X->getType();
2887 
2888         // We can't currently handle Power style floating point operations here.
2889         if (!(XType->isPPC_FP128Ty() || BCSrcOp->getType()->isPPC_FP128Ty())) {
2890 
2891           Type *NewType = Builder.getIntNTy(XType->getScalarSizeInBits());
2892           if (auto *XVTy = dyn_cast<VectorType>(XType))
2893             NewType = VectorType::get(NewType, XVTy->getElementCount());
2894           Value *NewBitcast = Builder.CreateBitCast(X, NewType);
2895           if (TrueIfSigned)
2896             return new ICmpInst(ICmpInst::ICMP_SLT, NewBitcast,
2897                                 ConstantInt::getNullValue(NewType));
2898           else
2899             return new ICmpInst(ICmpInst::ICMP_SGT, NewBitcast,
2900                                 ConstantInt::getAllOnesValue(NewType));
2901         }
2902       }
2903     }
2904   }
2905 
2906   // Test to see if the operands of the icmp are casted versions of other
2907   // values. If the ptr->ptr cast can be stripped off both arguments, do so.
2908   if (Bitcast->getType()->isPointerTy() &&
2909       (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
2910     // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2911     // so eliminate it as well.
2912     if (auto *BC2 = dyn_cast<BitCastInst>(Op1))
2913       Op1 = BC2->getOperand(0);
2914 
2915     Op1 = Builder.CreateBitCast(Op1, BCSrcOp->getType());
2916     return new ICmpInst(Pred, BCSrcOp, Op1);
2917   }
2918 
2919   const APInt *C;
2920   if (!match(Cmp.getOperand(1), m_APInt(C)) ||
2921       !Bitcast->getType()->isIntegerTy() ||
2922       !Bitcast->getSrcTy()->isIntOrIntVectorTy())
2923     return nullptr;
2924 
2925   // If this is checking if all elements of a vector compare are set or not,
2926   // invert the casted vector equality compare and test if all compare
2927   // elements are clear or not. Compare against zero is generally easier for
2928   // analysis and codegen.
2929   // icmp eq/ne (bitcast (not X) to iN), -1 --> icmp eq/ne (bitcast X to iN), 0
2930   // Example: are all elements equal? --> are zero elements not equal?
2931   // TODO: Try harder to reduce compare of 2 freely invertible operands?
2932   if (Cmp.isEquality() && C->isAllOnesValue() && Bitcast->hasOneUse() &&
2933       isFreeToInvert(BCSrcOp, BCSrcOp->hasOneUse())) {
2934     Type *ScalarTy = Bitcast->getType();
2935     Value *Cast = Builder.CreateBitCast(Builder.CreateNot(BCSrcOp), ScalarTy);
2936     return new ICmpInst(Pred, Cast, ConstantInt::getNullValue(ScalarTy));
2937   }
2938 
2939   // Folding: icmp <pred> iN X, C
2940   //  where X = bitcast <M x iK> (shufflevector <M x iK> %vec, undef, SC)) to iN
2941   //    and C is a splat of a K-bit pattern
2942   //    and SC is a constant vector = <C', C', C', ..., C'>
2943   // Into:
2944   //   %E = extractelement <M x iK> %vec, i32 C'
2945   //   icmp <pred> iK %E, trunc(C)
2946   Value *Vec;
2947   ArrayRef<int> Mask;
2948   if (match(BCSrcOp, m_Shuffle(m_Value(Vec), m_Undef(), m_Mask(Mask)))) {
2949     // Check whether every element of Mask is the same constant
2950     if (is_splat(Mask)) {
2951       auto *VecTy = cast<VectorType>(BCSrcOp->getType());
2952       auto *EltTy = cast<IntegerType>(VecTy->getElementType());
2953       if (C->isSplat(EltTy->getBitWidth())) {
2954         // Fold the icmp based on the value of C
2955         // If C is M copies of an iK sized bit pattern,
2956         // then:
2957         //   =>  %E = extractelement <N x iK> %vec, i32 Elem
2958         //       icmp <pred> iK %SplatVal, <pattern>
2959         Value *Elem = Builder.getInt32(Mask[0]);
2960         Value *Extract = Builder.CreateExtractElement(Vec, Elem);
2961         Value *NewC = ConstantInt::get(EltTy, C->trunc(EltTy->getBitWidth()));
2962         return new ICmpInst(Pred, Extract, NewC);
2963       }
2964     }
2965   }
2966   return nullptr;
2967 }
2968 
2969 /// Try to fold integer comparisons with a constant operand: icmp Pred X, C
2970 /// where X is some kind of instruction.
2971 Instruction *InstCombinerImpl::foldICmpInstWithConstant(ICmpInst &Cmp) {
2972   const APInt *C;
2973   if (!match(Cmp.getOperand(1), m_APInt(C)))
2974     return nullptr;
2975 
2976   if (auto *BO = dyn_cast<BinaryOperator>(Cmp.getOperand(0))) {
2977     switch (BO->getOpcode()) {
2978     case Instruction::Xor:
2979       if (Instruction *I = foldICmpXorConstant(Cmp, BO, *C))
2980         return I;
2981       break;
2982     case Instruction::And:
2983       if (Instruction *I = foldICmpAndConstant(Cmp, BO, *C))
2984         return I;
2985       break;
2986     case Instruction::Or:
2987       if (Instruction *I = foldICmpOrConstant(Cmp, BO, *C))
2988         return I;
2989       break;
2990     case Instruction::Mul:
2991       if (Instruction *I = foldICmpMulConstant(Cmp, BO, *C))
2992         return I;
2993       break;
2994     case Instruction::Shl:
2995       if (Instruction *I = foldICmpShlConstant(Cmp, BO, *C))
2996         return I;
2997       break;
2998     case Instruction::LShr:
2999     case Instruction::AShr:
3000       if (Instruction *I = foldICmpShrConstant(Cmp, BO, *C))
3001         return I;
3002       break;
3003     case Instruction::SRem:
3004       if (Instruction *I = foldICmpSRemConstant(Cmp, BO, *C))
3005         return I;
3006       break;
3007     case Instruction::UDiv:
3008       if (Instruction *I = foldICmpUDivConstant(Cmp, BO, *C))
3009         return I;
3010       LLVM_FALLTHROUGH;
3011     case Instruction::SDiv:
3012       if (Instruction *I = foldICmpDivConstant(Cmp, BO, *C))
3013         return I;
3014       break;
3015     case Instruction::Sub:
3016       if (Instruction *I = foldICmpSubConstant(Cmp, BO, *C))
3017         return I;
3018       break;
3019     case Instruction::Add:
3020       if (Instruction *I = foldICmpAddConstant(Cmp, BO, *C))
3021         return I;
3022       break;
3023     default:
3024       break;
3025     }
3026     // TODO: These folds could be refactored to be part of the above calls.
3027     if (Instruction *I = foldICmpBinOpEqualityWithConstant(Cmp, BO, *C))
3028       return I;
3029   }
3030 
3031   // Match against CmpInst LHS being instructions other than binary operators.
3032 
3033   if (auto *SI = dyn_cast<SelectInst>(Cmp.getOperand(0))) {
3034     // For now, we only support constant integers while folding the
3035     // ICMP(SELECT)) pattern. We can extend this to support vector of integers
3036     // similar to the cases handled by binary ops above.
3037     if (ConstantInt *ConstRHS = dyn_cast<ConstantInt>(Cmp.getOperand(1)))
3038       if (Instruction *I = foldICmpSelectConstant(Cmp, SI, ConstRHS))
3039         return I;
3040   }
3041 
3042   if (auto *TI = dyn_cast<TruncInst>(Cmp.getOperand(0))) {
3043     if (Instruction *I = foldICmpTruncConstant(Cmp, TI, *C))
3044       return I;
3045   }
3046 
3047   if (auto *II = dyn_cast<IntrinsicInst>(Cmp.getOperand(0)))
3048     if (Instruction *I = foldICmpIntrinsicWithConstant(Cmp, II, *C))
3049       return I;
3050 
3051   return nullptr;
3052 }
3053 
3054 /// Fold an icmp equality instruction with binary operator LHS and constant RHS:
3055 /// icmp eq/ne BO, C.
3056 Instruction *InstCombinerImpl::foldICmpBinOpEqualityWithConstant(
3057     ICmpInst &Cmp, BinaryOperator *BO, const APInt &C) {
3058   // TODO: Some of these folds could work with arbitrary constants, but this
3059   // function is limited to scalar and vector splat constants.
3060   if (!Cmp.isEquality())
3061     return nullptr;
3062 
3063   ICmpInst::Predicate Pred = Cmp.getPredicate();
3064   bool isICMP_NE = Pred == ICmpInst::ICMP_NE;
3065   Constant *RHS = cast<Constant>(Cmp.getOperand(1));
3066   Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
3067 
3068   switch (BO->getOpcode()) {
3069   case Instruction::SRem:
3070     // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
3071     if (C.isNullValue() && BO->hasOneUse()) {
3072       const APInt *BOC;
3073       if (match(BOp1, m_APInt(BOC)) && BOC->sgt(1) && BOC->isPowerOf2()) {
3074         Value *NewRem = Builder.CreateURem(BOp0, BOp1, BO->getName());
3075         return new ICmpInst(Pred, NewRem,
3076                             Constant::getNullValue(BO->getType()));
3077       }
3078     }
3079     break;
3080   case Instruction::Add: {
3081     // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
3082     if (Constant *BOC = dyn_cast<Constant>(BOp1)) {
3083       if (BO->hasOneUse())
3084         return new ICmpInst(Pred, BOp0, ConstantExpr::getSub(RHS, BOC));
3085     } else if (C.isNullValue()) {
3086       // Replace ((add A, B) != 0) with (A != -B) if A or B is
3087       // efficiently invertible, or if the add has just this one use.
3088       if (Value *NegVal = dyn_castNegVal(BOp1))
3089         return new ICmpInst(Pred, BOp0, NegVal);
3090       if (Value *NegVal = dyn_castNegVal(BOp0))
3091         return new ICmpInst(Pred, NegVal, BOp1);
3092       if (BO->hasOneUse()) {
3093         Value *Neg = Builder.CreateNeg(BOp1);
3094         Neg->takeName(BO);
3095         return new ICmpInst(Pred, BOp0, Neg);
3096       }
3097     }
3098     break;
3099   }
3100   case Instruction::Xor:
3101     if (BO->hasOneUse()) {
3102       if (Constant *BOC = dyn_cast<Constant>(BOp1)) {
3103         // For the xor case, we can xor two constants together, eliminating
3104         // the explicit xor.
3105         return new ICmpInst(Pred, BOp0, ConstantExpr::getXor(RHS, BOC));
3106       } else if (C.isNullValue()) {
3107         // Replace ((xor A, B) != 0) with (A != B)
3108         return new ICmpInst(Pred, BOp0, BOp1);
3109       }
3110     }
3111     break;
3112   case Instruction::Sub:
3113     if (BO->hasOneUse()) {
3114       // Only check for constant LHS here, as constant RHS will be canonicalized
3115       // to add and use the fold above.
3116       if (Constant *BOC = dyn_cast<Constant>(BOp0)) {
3117         // Replace ((sub BOC, B) != C) with (B != BOC-C).
3118         return new ICmpInst(Pred, BOp1, ConstantExpr::getSub(BOC, RHS));
3119       } else if (C.isNullValue()) {
3120         // Replace ((sub A, B) != 0) with (A != B).
3121         return new ICmpInst(Pred, BOp0, BOp1);
3122       }
3123     }
3124     break;
3125   case Instruction::Or: {
3126     const APInt *BOC;
3127     if (match(BOp1, m_APInt(BOC)) && BO->hasOneUse() && RHS->isAllOnesValue()) {
3128       // Comparing if all bits outside of a constant mask are set?
3129       // Replace (X | C) == -1 with (X & ~C) == ~C.
3130       // This removes the -1 constant.
3131       Constant *NotBOC = ConstantExpr::getNot(cast<Constant>(BOp1));
3132       Value *And = Builder.CreateAnd(BOp0, NotBOC);
3133       return new ICmpInst(Pred, And, NotBOC);
3134     }
3135     break;
3136   }
3137   case Instruction::And: {
3138     const APInt *BOC;
3139     if (match(BOp1, m_APInt(BOC))) {
3140       // If we have ((X & C) == C), turn it into ((X & C) != 0).
3141       if (C == *BOC && C.isPowerOf2())
3142         return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE,
3143                             BO, Constant::getNullValue(RHS->getType()));
3144     }
3145     break;
3146   }
3147   case Instruction::UDiv:
3148     if (C.isNullValue()) {
3149       // (icmp eq/ne (udiv A, B), 0) -> (icmp ugt/ule i32 B, A)
3150       auto NewPred = isICMP_NE ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT;
3151       return new ICmpInst(NewPred, BOp1, BOp0);
3152     }
3153     break;
3154   default:
3155     break;
3156   }
3157   return nullptr;
3158 }
3159 
3160 /// Fold an equality icmp with LLVM intrinsic and constant operand.
3161 Instruction *InstCombinerImpl::foldICmpEqIntrinsicWithConstant(
3162     ICmpInst &Cmp, IntrinsicInst *II, const APInt &C) {
3163   Type *Ty = II->getType();
3164   unsigned BitWidth = C.getBitWidth();
3165   switch (II->getIntrinsicID()) {
3166   case Intrinsic::abs:
3167     // abs(A) == 0  ->  A == 0
3168     // abs(A) == INT_MIN  ->  A == INT_MIN
3169     if (C.isNullValue() || C.isMinSignedValue())
3170       return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3171                           ConstantInt::get(Ty, C));
3172     break;
3173 
3174   case Intrinsic::bswap:
3175     // bswap(A) == C  ->  A == bswap(C)
3176     return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3177                         ConstantInt::get(Ty, C.byteSwap()));
3178 
3179   case Intrinsic::ctlz:
3180   case Intrinsic::cttz: {
3181     // ctz(A) == bitwidth(A)  ->  A == 0 and likewise for !=
3182     if (C == BitWidth)
3183       return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3184                           ConstantInt::getNullValue(Ty));
3185 
3186     // ctz(A) == C -> A & Mask1 == Mask2, where Mask2 only has bit C set
3187     // and Mask1 has bits 0..C+1 set. Similar for ctl, but for high bits.
3188     // Limit to one use to ensure we don't increase instruction count.
3189     unsigned Num = C.getLimitedValue(BitWidth);
3190     if (Num != BitWidth && II->hasOneUse()) {
3191       bool IsTrailing = II->getIntrinsicID() == Intrinsic::cttz;
3192       APInt Mask1 = IsTrailing ? APInt::getLowBitsSet(BitWidth, Num + 1)
3193                                : APInt::getHighBitsSet(BitWidth, Num + 1);
3194       APInt Mask2 = IsTrailing
3195         ? APInt::getOneBitSet(BitWidth, Num)
3196         : APInt::getOneBitSet(BitWidth, BitWidth - Num - 1);
3197       return new ICmpInst(Cmp.getPredicate(),
3198           Builder.CreateAnd(II->getArgOperand(0), Mask1),
3199           ConstantInt::get(Ty, Mask2));
3200     }
3201     break;
3202   }
3203 
3204   case Intrinsic::ctpop: {
3205     // popcount(A) == 0  ->  A == 0 and likewise for !=
3206     // popcount(A) == bitwidth(A)  ->  A == -1 and likewise for !=
3207     bool IsZero = C.isNullValue();
3208     if (IsZero || C == BitWidth)
3209       return new ICmpInst(Cmp.getPredicate(), II->getArgOperand(0),
3210           IsZero ? Constant::getNullValue(Ty) : Constant::getAllOnesValue(Ty));
3211 
3212     break;
3213   }
3214 
3215   case Intrinsic::uadd_sat: {
3216     // uadd.sat(a, b) == 0  ->  (a | b) == 0
3217     if (C.isNullValue()) {
3218       Value *Or = Builder.CreateOr(II->getArgOperand(0), II->getArgOperand(1));
3219       return new ICmpInst(Cmp.getPredicate(), Or, Constant::getNullValue(Ty));
3220     }
3221     break;
3222   }
3223 
3224   case Intrinsic::usub_sat: {
3225     // usub.sat(a, b) == 0  ->  a <= b
3226     if (C.isNullValue()) {
3227       ICmpInst::Predicate NewPred = Cmp.getPredicate() == ICmpInst::ICMP_EQ
3228           ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT;
3229       return new ICmpInst(NewPred, II->getArgOperand(0), II->getArgOperand(1));
3230     }
3231     break;
3232   }
3233   default:
3234     break;
3235   }
3236 
3237   return nullptr;
3238 }
3239 
3240 /// Fold an icmp with LLVM intrinsic and constant operand: icmp Pred II, C.
3241 Instruction *InstCombinerImpl::foldICmpIntrinsicWithConstant(ICmpInst &Cmp,
3242                                                              IntrinsicInst *II,
3243                                                              const APInt &C) {
3244   if (Cmp.isEquality())
3245     return foldICmpEqIntrinsicWithConstant(Cmp, II, C);
3246 
3247   Type *Ty = II->getType();
3248   unsigned BitWidth = C.getBitWidth();
3249   ICmpInst::Predicate Pred = Cmp.getPredicate();
3250   switch (II->getIntrinsicID()) {
3251   case Intrinsic::ctpop: {
3252     // (ctpop X > BitWidth - 1) --> X == -1
3253     Value *X = II->getArgOperand(0);
3254     if (C == BitWidth - 1 && Pred == ICmpInst::ICMP_UGT)
3255       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_EQ, X,
3256                              ConstantInt::getAllOnesValue(Ty));
3257     // (ctpop X < BitWidth) --> X != -1
3258     if (C == BitWidth && Pred == ICmpInst::ICMP_ULT)
3259       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_NE, X,
3260                              ConstantInt::getAllOnesValue(Ty));
3261     break;
3262   }
3263   case Intrinsic::ctlz: {
3264     // ctlz(0bXXXXXXXX) > 3 -> 0bXXXXXXXX < 0b00010000
3265     if (Pred == ICmpInst::ICMP_UGT && C.ult(BitWidth)) {
3266       unsigned Num = C.getLimitedValue();
3267       APInt Limit = APInt::getOneBitSet(BitWidth, BitWidth - Num - 1);
3268       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_ULT,
3269                              II->getArgOperand(0), ConstantInt::get(Ty, Limit));
3270     }
3271 
3272     // ctlz(0bXXXXXXXX) < 3 -> 0bXXXXXXXX > 0b00011111
3273     if (Pred == ICmpInst::ICMP_ULT && C.uge(1) && C.ule(BitWidth)) {
3274       unsigned Num = C.getLimitedValue();
3275       APInt Limit = APInt::getLowBitsSet(BitWidth, BitWidth - Num);
3276       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_UGT,
3277                              II->getArgOperand(0), ConstantInt::get(Ty, Limit));
3278     }
3279     break;
3280   }
3281   case Intrinsic::cttz: {
3282     // Limit to one use to ensure we don't increase instruction count.
3283     if (!II->hasOneUse())
3284       return nullptr;
3285 
3286     // cttz(0bXXXXXXXX) > 3 -> 0bXXXXXXXX & 0b00001111 == 0
3287     if (Pred == ICmpInst::ICMP_UGT && C.ult(BitWidth)) {
3288       APInt Mask = APInt::getLowBitsSet(BitWidth, C.getLimitedValue() + 1);
3289       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_EQ,
3290                              Builder.CreateAnd(II->getArgOperand(0), Mask),
3291                              ConstantInt::getNullValue(Ty));
3292     }
3293 
3294     // cttz(0bXXXXXXXX) < 3 -> 0bXXXXXXXX & 0b00000111 != 0
3295     if (Pred == ICmpInst::ICMP_ULT && C.uge(1) && C.ule(BitWidth)) {
3296       APInt Mask = APInt::getLowBitsSet(BitWidth, C.getLimitedValue());
3297       return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_NE,
3298                              Builder.CreateAnd(II->getArgOperand(0), Mask),
3299                              ConstantInt::getNullValue(Ty));
3300     }
3301     break;
3302   }
3303   default:
3304     break;
3305   }
3306 
3307   return nullptr;
3308 }
3309 
3310 /// Handle icmp with constant (but not simple integer constant) RHS.
3311 Instruction *InstCombinerImpl::foldICmpInstWithConstantNotInt(ICmpInst &I) {
3312   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3313   Constant *RHSC = dyn_cast<Constant>(Op1);
3314   Instruction *LHSI = dyn_cast<Instruction>(Op0);
3315   if (!RHSC || !LHSI)
3316     return nullptr;
3317 
3318   switch (LHSI->getOpcode()) {
3319   case Instruction::GetElementPtr:
3320     // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
3321     if (RHSC->isNullValue() &&
3322         cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
3323       return new ICmpInst(
3324           I.getPredicate(), LHSI->getOperand(0),
3325           Constant::getNullValue(LHSI->getOperand(0)->getType()));
3326     break;
3327   case Instruction::PHI:
3328     // Only fold icmp into the PHI if the phi and icmp are in the same
3329     // block.  If in the same block, we're encouraging jump threading.  If
3330     // not, we are just pessimizing the code by making an i1 phi.
3331     if (LHSI->getParent() == I.getParent())
3332       if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI)))
3333         return NV;
3334     break;
3335   case Instruction::Select: {
3336     // If either operand of the select is a constant, we can fold the
3337     // comparison into the select arms, which will cause one to be
3338     // constant folded and the select turned into a bitwise or.
3339     Value *Op1 = nullptr, *Op2 = nullptr;
3340     ConstantInt *CI = nullptr;
3341 
3342     auto SimplifyOp = [&](Value *V) {
3343       Value *Op = nullptr;
3344       if (Constant *C = dyn_cast<Constant>(V)) {
3345         Op = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
3346       } else if (RHSC->isNullValue()) {
3347         // If null is being compared, check if it can be further simplified.
3348         Op = SimplifyICmpInst(I.getPredicate(), V, RHSC, SQ);
3349       }
3350       return Op;
3351     };
3352     Op1 = SimplifyOp(LHSI->getOperand(1));
3353     if (Op1)
3354       CI = dyn_cast<ConstantInt>(Op1);
3355 
3356     Op2 = SimplifyOp(LHSI->getOperand(2));
3357     if (Op2)
3358       CI = dyn_cast<ConstantInt>(Op2);
3359 
3360     // We only want to perform this transformation if it will not lead to
3361     // additional code. This is true if either both sides of the select
3362     // fold to a constant (in which case the icmp is replaced with a select
3363     // which will usually simplify) or this is the only user of the
3364     // select (in which case we are trading a select+icmp for a simpler
3365     // select+icmp) or all uses of the select can be replaced based on
3366     // dominance information ("Global cases").
3367     bool Transform = false;
3368     if (Op1 && Op2)
3369       Transform = true;
3370     else if (Op1 || Op2) {
3371       // Local case
3372       if (LHSI->hasOneUse())
3373         Transform = true;
3374       // Global cases
3375       else if (CI && !CI->isZero())
3376         // When Op1 is constant try replacing select with second operand.
3377         // Otherwise Op2 is constant and try replacing select with first
3378         // operand.
3379         Transform =
3380             replacedSelectWithOperand(cast<SelectInst>(LHSI), &I, Op1 ? 2 : 1);
3381     }
3382     if (Transform) {
3383       if (!Op1)
3384         Op1 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(1), RHSC,
3385                                  I.getName());
3386       if (!Op2)
3387         Op2 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(2), RHSC,
3388                                  I.getName());
3389       return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3390     }
3391     break;
3392   }
3393   case Instruction::IntToPtr:
3394     // icmp pred inttoptr(X), null -> icmp pred X, 0
3395     if (RHSC->isNullValue() &&
3396         DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
3397       return new ICmpInst(
3398           I.getPredicate(), LHSI->getOperand(0),
3399           Constant::getNullValue(LHSI->getOperand(0)->getType()));
3400     break;
3401 
3402   case Instruction::Load:
3403     // Try to optimize things like "A[i] > 4" to index computations.
3404     if (GetElementPtrInst *GEP =
3405             dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3406       if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3407         if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3408             !cast<LoadInst>(LHSI)->isVolatile())
3409           if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
3410             return Res;
3411     }
3412     break;
3413   }
3414 
3415   return nullptr;
3416 }
3417 
3418 /// Some comparisons can be simplified.
3419 /// In this case, we are looking for comparisons that look like
3420 /// a check for a lossy truncation.
3421 /// Folds:
3422 ///   icmp SrcPred (x & Mask), x    to    icmp DstPred x, Mask
3423 /// Where Mask is some pattern that produces all-ones in low bits:
3424 ///    (-1 >> y)
3425 ///    ((-1 << y) >> y)     <- non-canonical, has extra uses
3426 ///   ~(-1 << y)
3427 ///    ((1 << y) + (-1))    <- non-canonical, has extra uses
3428 /// The Mask can be a constant, too.
3429 /// For some predicates, the operands are commutative.
3430 /// For others, x can only be on a specific side.
3431 static Value *foldICmpWithLowBitMaskedVal(ICmpInst &I,
3432                                           InstCombiner::BuilderTy &Builder) {
3433   ICmpInst::Predicate SrcPred;
3434   Value *X, *M, *Y;
3435   auto m_VariableMask = m_CombineOr(
3436       m_CombineOr(m_Not(m_Shl(m_AllOnes(), m_Value())),
3437                   m_Add(m_Shl(m_One(), m_Value()), m_AllOnes())),
3438       m_CombineOr(m_LShr(m_AllOnes(), m_Value()),
3439                   m_LShr(m_Shl(m_AllOnes(), m_Value(Y)), m_Deferred(Y))));
3440   auto m_Mask = m_CombineOr(m_VariableMask, m_LowBitMask());
3441   if (!match(&I, m_c_ICmp(SrcPred,
3442                           m_c_And(m_CombineAnd(m_Mask, m_Value(M)), m_Value(X)),
3443                           m_Deferred(X))))
3444     return nullptr;
3445 
3446   ICmpInst::Predicate DstPred;
3447   switch (SrcPred) {
3448   case ICmpInst::Predicate::ICMP_EQ:
3449     //  x & (-1 >> y) == x    ->    x u<= (-1 >> y)
3450     DstPred = ICmpInst::Predicate::ICMP_ULE;
3451     break;
3452   case ICmpInst::Predicate::ICMP_NE:
3453     //  x & (-1 >> y) != x    ->    x u> (-1 >> y)
3454     DstPred = ICmpInst::Predicate::ICMP_UGT;
3455     break;
3456   case ICmpInst::Predicate::ICMP_ULT:
3457     //  x & (-1 >> y) u< x    ->    x u> (-1 >> y)
3458     //  x u> x & (-1 >> y)    ->    x u> (-1 >> y)
3459     DstPred = ICmpInst::Predicate::ICMP_UGT;
3460     break;
3461   case ICmpInst::Predicate::ICMP_UGE:
3462     //  x & (-1 >> y) u>= x    ->    x u<= (-1 >> y)
3463     //  x u<= x & (-1 >> y)    ->    x u<= (-1 >> y)
3464     DstPred = ICmpInst::Predicate::ICMP_ULE;
3465     break;
3466   case ICmpInst::Predicate::ICMP_SLT:
3467     //  x & (-1 >> y) s< x    ->    x s> (-1 >> y)
3468     //  x s> x & (-1 >> y)    ->    x s> (-1 >> y)
3469     if (!match(M, m_Constant())) // Can not do this fold with non-constant.
3470       return nullptr;
3471     if (!match(M, m_NonNegative())) // Must not have any -1 vector elements.
3472       return nullptr;
3473     DstPred = ICmpInst::Predicate::ICMP_SGT;
3474     break;
3475   case ICmpInst::Predicate::ICMP_SGE:
3476     //  x & (-1 >> y) s>= x    ->    x s<= (-1 >> y)
3477     //  x s<= x & (-1 >> y)    ->    x s<= (-1 >> y)
3478     if (!match(M, m_Constant())) // Can not do this fold with non-constant.
3479       return nullptr;
3480     if (!match(M, m_NonNegative())) // Must not have any -1 vector elements.
3481       return nullptr;
3482     DstPred = ICmpInst::Predicate::ICMP_SLE;
3483     break;
3484   case ICmpInst::Predicate::ICMP_SGT:
3485   case ICmpInst::Predicate::ICMP_SLE:
3486     return nullptr;
3487   case ICmpInst::Predicate::ICMP_UGT:
3488   case ICmpInst::Predicate::ICMP_ULE:
3489     llvm_unreachable("Instsimplify took care of commut. variant");
3490     break;
3491   default:
3492     llvm_unreachable("All possible folds are handled.");
3493   }
3494 
3495   // The mask value may be a vector constant that has undefined elements. But it
3496   // may not be safe to propagate those undefs into the new compare, so replace
3497   // those elements by copying an existing, defined, and safe scalar constant.
3498   Type *OpTy = M->getType();
3499   auto *VecC = dyn_cast<Constant>(M);
3500   auto *OpVTy = dyn_cast<FixedVectorType>(OpTy);
3501   if (OpVTy && VecC && VecC->containsUndefOrPoisonElement()) {
3502     Constant *SafeReplacementConstant = nullptr;
3503     for (unsigned i = 0, e = OpVTy->getNumElements(); i != e; ++i) {
3504       if (!isa<UndefValue>(VecC->getAggregateElement(i))) {
3505         SafeReplacementConstant = VecC->getAggregateElement(i);
3506         break;
3507       }
3508     }
3509     assert(SafeReplacementConstant && "Failed to find undef replacement");
3510     M = Constant::replaceUndefsWith(VecC, SafeReplacementConstant);
3511   }
3512 
3513   return Builder.CreateICmp(DstPred, X, M);
3514 }
3515 
3516 /// Some comparisons can be simplified.
3517 /// In this case, we are looking for comparisons that look like
3518 /// a check for a lossy signed truncation.
3519 /// Folds:   (MaskedBits is a constant.)
3520 ///   ((%x << MaskedBits) a>> MaskedBits) SrcPred %x
3521 /// Into:
3522 ///   (add %x, (1 << (KeptBits-1))) DstPred (1 << KeptBits)
3523 /// Where  KeptBits = bitwidth(%x) - MaskedBits
3524 static Value *
3525 foldICmpWithTruncSignExtendedVal(ICmpInst &I,
3526                                  InstCombiner::BuilderTy &Builder) {
3527   ICmpInst::Predicate SrcPred;
3528   Value *X;
3529   const APInt *C0, *C1; // FIXME: non-splats, potentially with undef.
3530   // We are ok with 'shl' having multiple uses, but 'ashr' must be one-use.
3531   if (!match(&I, m_c_ICmp(SrcPred,
3532                           m_OneUse(m_AShr(m_Shl(m_Value(X), m_APInt(C0)),
3533                                           m_APInt(C1))),
3534                           m_Deferred(X))))
3535     return nullptr;
3536 
3537   // Potential handling of non-splats: for each element:
3538   //  * if both are undef, replace with constant 0.
3539   //    Because (1<<0) is OK and is 1, and ((1<<0)>>1) is also OK and is 0.
3540   //  * if both are not undef, and are different, bailout.
3541   //  * else, only one is undef, then pick the non-undef one.
3542 
3543   // The shift amount must be equal.
3544   if (*C0 != *C1)
3545     return nullptr;
3546   const APInt &MaskedBits = *C0;
3547   assert(MaskedBits != 0 && "shift by zero should be folded away already.");
3548 
3549   ICmpInst::Predicate DstPred;
3550   switch (SrcPred) {
3551   case ICmpInst::Predicate::ICMP_EQ:
3552     // ((%x << MaskedBits) a>> MaskedBits) == %x
3553     //   =>
3554     // (add %x, (1 << (KeptBits-1))) u< (1 << KeptBits)
3555     DstPred = ICmpInst::Predicate::ICMP_ULT;
3556     break;
3557   case ICmpInst::Predicate::ICMP_NE:
3558     // ((%x << MaskedBits) a>> MaskedBits) != %x
3559     //   =>
3560     // (add %x, (1 << (KeptBits-1))) u>= (1 << KeptBits)
3561     DstPred = ICmpInst::Predicate::ICMP_UGE;
3562     break;
3563   // FIXME: are more folds possible?
3564   default:
3565     return nullptr;
3566   }
3567 
3568   auto *XType = X->getType();
3569   const unsigned XBitWidth = XType->getScalarSizeInBits();
3570   const APInt BitWidth = APInt(XBitWidth, XBitWidth);
3571   assert(BitWidth.ugt(MaskedBits) && "shifts should leave some bits untouched");
3572 
3573   // KeptBits = bitwidth(%x) - MaskedBits
3574   const APInt KeptBits = BitWidth - MaskedBits;
3575   assert(KeptBits.ugt(0) && KeptBits.ult(BitWidth) && "unreachable");
3576   // ICmpCst = (1 << KeptBits)
3577   const APInt ICmpCst = APInt(XBitWidth, 1).shl(KeptBits);
3578   assert(ICmpCst.isPowerOf2());
3579   // AddCst = (1 << (KeptBits-1))
3580   const APInt AddCst = ICmpCst.lshr(1);
3581   assert(AddCst.ult(ICmpCst) && AddCst.isPowerOf2());
3582 
3583   // T0 = add %x, AddCst
3584   Value *T0 = Builder.CreateAdd(X, ConstantInt::get(XType, AddCst));
3585   // T1 = T0 DstPred ICmpCst
3586   Value *T1 = Builder.CreateICmp(DstPred, T0, ConstantInt::get(XType, ICmpCst));
3587 
3588   return T1;
3589 }
3590 
3591 // Given pattern:
3592 //   icmp eq/ne (and ((x shift Q), (y oppositeshift K))), 0
3593 // we should move shifts to the same hand of 'and', i.e. rewrite as
3594 //   icmp eq/ne (and (x shift (Q+K)), y), 0  iff (Q+K) u< bitwidth(x)
3595 // We are only interested in opposite logical shifts here.
3596 // One of the shifts can be truncated.
3597 // If we can, we want to end up creating 'lshr' shift.
3598 static Value *
3599 foldShiftIntoShiftInAnotherHandOfAndInICmp(ICmpInst &I, const SimplifyQuery SQ,
3600                                            InstCombiner::BuilderTy &Builder) {
3601   if (!I.isEquality() || !match(I.getOperand(1), m_Zero()) ||
3602       !I.getOperand(0)->hasOneUse())
3603     return nullptr;
3604 
3605   auto m_AnyLogicalShift = m_LogicalShift(m_Value(), m_Value());
3606 
3607   // Look for an 'and' of two logical shifts, one of which may be truncated.
3608   // We use m_TruncOrSelf() on the RHS to correctly handle commutative case.
3609   Instruction *XShift, *MaybeTruncation, *YShift;
3610   if (!match(
3611           I.getOperand(0),
3612           m_c_And(m_CombineAnd(m_AnyLogicalShift, m_Instruction(XShift)),
3613                   m_CombineAnd(m_TruncOrSelf(m_CombineAnd(
3614                                    m_AnyLogicalShift, m_Instruction(YShift))),
3615                                m_Instruction(MaybeTruncation)))))
3616     return nullptr;
3617 
3618   // We potentially looked past 'trunc', but only when matching YShift,
3619   // therefore YShift must have the widest type.
3620   Instruction *WidestShift = YShift;
3621   // Therefore XShift must have the shallowest type.
3622   // Or they both have identical types if there was no truncation.
3623   Instruction *NarrowestShift = XShift;
3624 
3625   Type *WidestTy = WidestShift->getType();
3626   Type *NarrowestTy = NarrowestShift->getType();
3627   assert(NarrowestTy == I.getOperand(0)->getType() &&
3628          "We did not look past any shifts while matching XShift though.");
3629   bool HadTrunc = WidestTy != I.getOperand(0)->getType();
3630 
3631   // If YShift is a 'lshr', swap the shifts around.
3632   if (match(YShift, m_LShr(m_Value(), m_Value())))
3633     std::swap(XShift, YShift);
3634 
3635   // The shifts must be in opposite directions.
3636   auto XShiftOpcode = XShift->getOpcode();
3637   if (XShiftOpcode == YShift->getOpcode())
3638     return nullptr; // Do not care about same-direction shifts here.
3639 
3640   Value *X, *XShAmt, *Y, *YShAmt;
3641   match(XShift, m_BinOp(m_Value(X), m_ZExtOrSelf(m_Value(XShAmt))));
3642   match(YShift, m_BinOp(m_Value(Y), m_ZExtOrSelf(m_Value(YShAmt))));
3643 
3644   // If one of the values being shifted is a constant, then we will end with
3645   // and+icmp, and [zext+]shift instrs will be constant-folded. If they are not,
3646   // however, we will need to ensure that we won't increase instruction count.
3647   if (!isa<Constant>(X) && !isa<Constant>(Y)) {
3648     // At least one of the hands of the 'and' should be one-use shift.
3649     if (!match(I.getOperand(0),
3650                m_c_And(m_OneUse(m_AnyLogicalShift), m_Value())))
3651       return nullptr;
3652     if (HadTrunc) {
3653       // Due to the 'trunc', we will need to widen X. For that either the old
3654       // 'trunc' or the shift amt in the non-truncated shift should be one-use.
3655       if (!MaybeTruncation->hasOneUse() &&
3656           !NarrowestShift->getOperand(1)->hasOneUse())
3657         return nullptr;
3658     }
3659   }
3660 
3661   // We have two shift amounts from two different shifts. The types of those
3662   // shift amounts may not match. If that's the case let's bailout now.
3663   if (XShAmt->getType() != YShAmt->getType())
3664     return nullptr;
3665 
3666   // As input, we have the following pattern:
3667   //   icmp eq/ne (and ((x shift Q), (y oppositeshift K))), 0
3668   // We want to rewrite that as:
3669   //   icmp eq/ne (and (x shift (Q+K)), y), 0  iff (Q+K) u< bitwidth(x)
3670   // While we know that originally (Q+K) would not overflow
3671   // (because  2 * (N-1) u<= iN -1), we have looked past extensions of
3672   // shift amounts. so it may now overflow in smaller bitwidth.
3673   // To ensure that does not happen, we need to ensure that the total maximal
3674   // shift amount is still representable in that smaller bit width.
3675   unsigned MaximalPossibleTotalShiftAmount =
3676       (WidestTy->getScalarSizeInBits() - 1) +
3677       (NarrowestTy->getScalarSizeInBits() - 1);
3678   APInt MaximalRepresentableShiftAmount =
3679       APInt::getAllOnesValue(XShAmt->getType()->getScalarSizeInBits());
3680   if (MaximalRepresentableShiftAmount.ult(MaximalPossibleTotalShiftAmount))
3681     return nullptr;
3682 
3683   // Can we fold (XShAmt+YShAmt) ?
3684   auto *NewShAmt = dyn_cast_or_null<Constant>(
3685       SimplifyAddInst(XShAmt, YShAmt, /*isNSW=*/false,
3686                       /*isNUW=*/false, SQ.getWithInstruction(&I)));
3687   if (!NewShAmt)
3688     return nullptr;
3689   NewShAmt = ConstantExpr::getZExtOrBitCast(NewShAmt, WidestTy);
3690   unsigned WidestBitWidth = WidestTy->getScalarSizeInBits();
3691 
3692   // Is the new shift amount smaller than the bit width?
3693   // FIXME: could also rely on ConstantRange.
3694   if (!match(NewShAmt,
3695              m_SpecificInt_ICMP(ICmpInst::Predicate::ICMP_ULT,
3696                                 APInt(WidestBitWidth, WidestBitWidth))))
3697     return nullptr;
3698 
3699   // An extra legality check is needed if we had trunc-of-lshr.
3700   if (HadTrunc && match(WidestShift, m_LShr(m_Value(), m_Value()))) {
3701     auto CanFold = [NewShAmt, WidestBitWidth, NarrowestShift, SQ,
3702                     WidestShift]() {
3703       // It isn't obvious whether it's worth it to analyze non-constants here.
3704       // Also, let's basically give up on non-splat cases, pessimizing vectors.
3705       // If *any* of these preconditions matches we can perform the fold.
3706       Constant *NewShAmtSplat = NewShAmt->getType()->isVectorTy()
3707                                     ? NewShAmt->getSplatValue()
3708                                     : NewShAmt;
3709       // If it's edge-case shift (by 0 or by WidestBitWidth-1) we can fold.
3710       if (NewShAmtSplat &&
3711           (NewShAmtSplat->isNullValue() ||
3712            NewShAmtSplat->getUniqueInteger() == WidestBitWidth - 1))
3713         return true;
3714       // We consider *min* leading zeros so a single outlier
3715       // blocks the transform as opposed to allowing it.
3716       if (auto *C = dyn_cast<Constant>(NarrowestShift->getOperand(0))) {
3717         KnownBits Known = computeKnownBits(C, SQ.DL);
3718         unsigned MinLeadZero = Known.countMinLeadingZeros();
3719         // If the value being shifted has at most lowest bit set we can fold.
3720         unsigned MaxActiveBits = Known.getBitWidth() - MinLeadZero;
3721         if (MaxActiveBits <= 1)
3722           return true;
3723         // Precondition:  NewShAmt u<= countLeadingZeros(C)
3724         if (NewShAmtSplat && NewShAmtSplat->getUniqueInteger().ule(MinLeadZero))
3725           return true;
3726       }
3727       if (auto *C = dyn_cast<Constant>(WidestShift->getOperand(0))) {
3728         KnownBits Known = computeKnownBits(C, SQ.DL);
3729         unsigned MinLeadZero = Known.countMinLeadingZeros();
3730         // If the value being shifted has at most lowest bit set we can fold.
3731         unsigned MaxActiveBits = Known.getBitWidth() - MinLeadZero;
3732         if (MaxActiveBits <= 1)
3733           return true;
3734         // Precondition:  ((WidestBitWidth-1)-NewShAmt) u<= countLeadingZeros(C)
3735         if (NewShAmtSplat) {
3736           APInt AdjNewShAmt =
3737               (WidestBitWidth - 1) - NewShAmtSplat->getUniqueInteger();
3738           if (AdjNewShAmt.ule(MinLeadZero))
3739             return true;
3740         }
3741       }
3742       return false; // Can't tell if it's ok.
3743     };
3744     if (!CanFold())
3745       return nullptr;
3746   }
3747 
3748   // All good, we can do this fold.
3749   X = Builder.CreateZExt(X, WidestTy);
3750   Y = Builder.CreateZExt(Y, WidestTy);
3751   // The shift is the same that was for X.
3752   Value *T0 = XShiftOpcode == Instruction::BinaryOps::LShr
3753                   ? Builder.CreateLShr(X, NewShAmt)
3754                   : Builder.CreateShl(X, NewShAmt);
3755   Value *T1 = Builder.CreateAnd(T0, Y);
3756   return Builder.CreateICmp(I.getPredicate(), T1,
3757                             Constant::getNullValue(WidestTy));
3758 }
3759 
3760 /// Fold
3761 ///   (-1 u/ x) u< y
3762 ///   ((x * y) u/ x) != y
3763 /// to
3764 ///   @llvm.umul.with.overflow(x, y) plus extraction of overflow bit
3765 /// Note that the comparison is commutative, while inverted (u>=, ==) predicate
3766 /// will mean that we are looking for the opposite answer.
3767 Value *InstCombinerImpl::foldUnsignedMultiplicationOverflowCheck(ICmpInst &I) {
3768   ICmpInst::Predicate Pred;
3769   Value *X, *Y;
3770   Instruction *Mul;
3771   bool NeedNegation;
3772   // Look for: (-1 u/ x) u</u>= y
3773   if (!I.isEquality() &&
3774       match(&I, m_c_ICmp(Pred, m_OneUse(m_UDiv(m_AllOnes(), m_Value(X))),
3775                          m_Value(Y)))) {
3776     Mul = nullptr;
3777 
3778     // Are we checking that overflow does not happen, or does happen?
3779     switch (Pred) {
3780     case ICmpInst::Predicate::ICMP_ULT:
3781       NeedNegation = false;
3782       break; // OK
3783     case ICmpInst::Predicate::ICMP_UGE:
3784       NeedNegation = true;
3785       break; // OK
3786     default:
3787       return nullptr; // Wrong predicate.
3788     }
3789   } else // Look for: ((x * y) u/ x) !=/== y
3790       if (I.isEquality() &&
3791           match(&I, m_c_ICmp(Pred, m_Value(Y),
3792                              m_OneUse(m_UDiv(m_CombineAnd(m_c_Mul(m_Deferred(Y),
3793                                                                   m_Value(X)),
3794                                                           m_Instruction(Mul)),
3795                                              m_Deferred(X)))))) {
3796     NeedNegation = Pred == ICmpInst::Predicate::ICMP_EQ;
3797   } else
3798     return nullptr;
3799 
3800   BuilderTy::InsertPointGuard Guard(Builder);
3801   // If the pattern included (x * y), we'll want to insert new instructions
3802   // right before that original multiplication so that we can replace it.
3803   bool MulHadOtherUses = Mul && !Mul->hasOneUse();
3804   if (MulHadOtherUses)
3805     Builder.SetInsertPoint(Mul);
3806 
3807   Function *F = Intrinsic::getDeclaration(
3808       I.getModule(), Intrinsic::umul_with_overflow, X->getType());
3809   CallInst *Call = Builder.CreateCall(F, {X, Y}, "umul");
3810 
3811   // If the multiplication was used elsewhere, to ensure that we don't leave
3812   // "duplicate" instructions, replace uses of that original multiplication
3813   // with the multiplication result from the with.overflow intrinsic.
3814   if (MulHadOtherUses)
3815     replaceInstUsesWith(*Mul, Builder.CreateExtractValue(Call, 0, "umul.val"));
3816 
3817   Value *Res = Builder.CreateExtractValue(Call, 1, "umul.ov");
3818   if (NeedNegation) // This technically increases instruction count.
3819     Res = Builder.CreateNot(Res, "umul.not.ov");
3820 
3821   // If we replaced the mul, erase it. Do this after all uses of Builder,
3822   // as the mul is used as insertion point.
3823   if (MulHadOtherUses)
3824     eraseInstFromFunction(*Mul);
3825 
3826   return Res;
3827 }
3828 
3829 static Instruction *foldICmpXNegX(ICmpInst &I) {
3830   CmpInst::Predicate Pred;
3831   Value *X;
3832   if (!match(&I, m_c_ICmp(Pred, m_NSWNeg(m_Value(X)), m_Deferred(X))))
3833     return nullptr;
3834 
3835   if (ICmpInst::isSigned(Pred))
3836     Pred = ICmpInst::getSwappedPredicate(Pred);
3837   else if (ICmpInst::isUnsigned(Pred))
3838     Pred = ICmpInst::getSignedPredicate(Pred);
3839   // else for equality-comparisons just keep the predicate.
3840 
3841   return ICmpInst::Create(Instruction::ICmp, Pred, X,
3842                           Constant::getNullValue(X->getType()), I.getName());
3843 }
3844 
3845 /// Try to fold icmp (binop), X or icmp X, (binop).
3846 /// TODO: A large part of this logic is duplicated in InstSimplify's
3847 /// simplifyICmpWithBinOp(). We should be able to share that and avoid the code
3848 /// duplication.
3849 Instruction *InstCombinerImpl::foldICmpBinOp(ICmpInst &I,
3850                                              const SimplifyQuery &SQ) {
3851   const SimplifyQuery Q = SQ.getWithInstruction(&I);
3852   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3853 
3854   // Special logic for binary operators.
3855   BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3856   BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3857   if (!BO0 && !BO1)
3858     return nullptr;
3859 
3860   if (Instruction *NewICmp = foldICmpXNegX(I))
3861     return NewICmp;
3862 
3863   const CmpInst::Predicate Pred = I.getPredicate();
3864   Value *X;
3865 
3866   // Convert add-with-unsigned-overflow comparisons into a 'not' with compare.
3867   // (Op1 + X) u</u>= Op1 --> ~Op1 u</u>= X
3868   if (match(Op0, m_OneUse(m_c_Add(m_Specific(Op1), m_Value(X)))) &&
3869       (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE))
3870     return new ICmpInst(Pred, Builder.CreateNot(Op1), X);
3871   // Op0 u>/u<= (Op0 + X) --> X u>/u<= ~Op0
3872   if (match(Op1, m_OneUse(m_c_Add(m_Specific(Op0), m_Value(X)))) &&
3873       (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE))
3874     return new ICmpInst(Pred, X, Builder.CreateNot(Op0));
3875 
3876   bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3877   if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3878     NoOp0WrapProblem =
3879         ICmpInst::isEquality(Pred) ||
3880         (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3881         (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3882   if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3883     NoOp1WrapProblem =
3884         ICmpInst::isEquality(Pred) ||
3885         (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3886         (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3887 
3888   // Analyze the case when either Op0 or Op1 is an add instruction.
3889   // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
3890   Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
3891   if (BO0 && BO0->getOpcode() == Instruction::Add) {
3892     A = BO0->getOperand(0);
3893     B = BO0->getOperand(1);
3894   }
3895   if (BO1 && BO1->getOpcode() == Instruction::Add) {
3896     C = BO1->getOperand(0);
3897     D = BO1->getOperand(1);
3898   }
3899 
3900   // icmp (A+B), A -> icmp B, 0 for equalities or if there is no overflow.
3901   // icmp (A+B), B -> icmp A, 0 for equalities or if there is no overflow.
3902   if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3903     return new ICmpInst(Pred, A == Op1 ? B : A,
3904                         Constant::getNullValue(Op1->getType()));
3905 
3906   // icmp C, (C+D) -> icmp 0, D for equalities or if there is no overflow.
3907   // icmp D, (C+D) -> icmp 0, C for equalities or if there is no overflow.
3908   if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3909     return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3910                         C == Op0 ? D : C);
3911 
3912   // icmp (A+B), (A+D) -> icmp B, D for equalities or if there is no overflow.
3913   if (A && C && (A == C || A == D || B == C || B == D) && NoOp0WrapProblem &&
3914       NoOp1WrapProblem) {
3915     // Determine Y and Z in the form icmp (X+Y), (X+Z).
3916     Value *Y, *Z;
3917     if (A == C) {
3918       // C + B == C + D  ->  B == D
3919       Y = B;
3920       Z = D;
3921     } else if (A == D) {
3922       // D + B == C + D  ->  B == C
3923       Y = B;
3924       Z = C;
3925     } else if (B == C) {
3926       // A + C == C + D  ->  A == D
3927       Y = A;
3928       Z = D;
3929     } else {
3930       assert(B == D);
3931       // A + D == C + D  ->  A == C
3932       Y = A;
3933       Z = C;
3934     }
3935     return new ICmpInst(Pred, Y, Z);
3936   }
3937 
3938   // icmp slt (A + -1), Op1 -> icmp sle A, Op1
3939   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3940       match(B, m_AllOnes()))
3941     return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3942 
3943   // icmp sge (A + -1), Op1 -> icmp sgt A, Op1
3944   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3945       match(B, m_AllOnes()))
3946     return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3947 
3948   // icmp sle (A + 1), Op1 -> icmp slt A, Op1
3949   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE && match(B, m_One()))
3950     return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3951 
3952   // icmp sgt (A + 1), Op1 -> icmp sge A, Op1
3953   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT && match(B, m_One()))
3954     return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3955 
3956   // icmp sgt Op0, (C + -1) -> icmp sge Op0, C
3957   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT &&
3958       match(D, m_AllOnes()))
3959     return new ICmpInst(CmpInst::ICMP_SGE, Op0, C);
3960 
3961   // icmp sle Op0, (C + -1) -> icmp slt Op0, C
3962   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE &&
3963       match(D, m_AllOnes()))
3964     return new ICmpInst(CmpInst::ICMP_SLT, Op0, C);
3965 
3966   // icmp sge Op0, (C + 1) -> icmp sgt Op0, C
3967   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE && match(D, m_One()))
3968     return new ICmpInst(CmpInst::ICMP_SGT, Op0, C);
3969 
3970   // icmp slt Op0, (C + 1) -> icmp sle Op0, C
3971   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT && match(D, m_One()))
3972     return new ICmpInst(CmpInst::ICMP_SLE, Op0, C);
3973 
3974   // TODO: The subtraction-related identities shown below also hold, but
3975   // canonicalization from (X -nuw 1) to (X + -1) means that the combinations
3976   // wouldn't happen even if they were implemented.
3977   //
3978   // icmp ult (A - 1), Op1 -> icmp ule A, Op1
3979   // icmp uge (A - 1), Op1 -> icmp ugt A, Op1
3980   // icmp ugt Op0, (C - 1) -> icmp uge Op0, C
3981   // icmp ule Op0, (C - 1) -> icmp ult Op0, C
3982 
3983   // icmp ule (A + 1), Op0 -> icmp ult A, Op1
3984   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_ULE && match(B, m_One()))
3985     return new ICmpInst(CmpInst::ICMP_ULT, A, Op1);
3986 
3987   // icmp ugt (A + 1), Op0 -> icmp uge A, Op1
3988   if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_UGT && match(B, m_One()))
3989     return new ICmpInst(CmpInst::ICMP_UGE, A, Op1);
3990 
3991   // icmp uge Op0, (C + 1) -> icmp ugt Op0, C
3992   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_UGE && match(D, m_One()))
3993     return new ICmpInst(CmpInst::ICMP_UGT, Op0, C);
3994 
3995   // icmp ult Op0, (C + 1) -> icmp ule Op0, C
3996   if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_ULT && match(D, m_One()))
3997     return new ICmpInst(CmpInst::ICMP_ULE, Op0, C);
3998 
3999   // if C1 has greater magnitude than C2:
4000   //  icmp (A + C1), (C + C2) -> icmp (A + C3), C
4001   //  s.t. C3 = C1 - C2
4002   //
4003   // if C2 has greater magnitude than C1:
4004   //  icmp (A + C1), (C + C2) -> icmp A, (C + C3)
4005   //  s.t. C3 = C2 - C1
4006   if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
4007       (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
4008     if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
4009       if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
4010         const APInt &AP1 = C1->getValue();
4011         const APInt &AP2 = C2->getValue();
4012         if (AP1.isNegative() == AP2.isNegative()) {
4013           APInt AP1Abs = C1->getValue().abs();
4014           APInt AP2Abs = C2->getValue().abs();
4015           if (AP1Abs.uge(AP2Abs)) {
4016             ConstantInt *C3 = Builder.getInt(AP1 - AP2);
4017             bool HasNUW = BO0->hasNoUnsignedWrap() && C3->getValue().ule(AP1);
4018             bool HasNSW = BO0->hasNoSignedWrap();
4019             Value *NewAdd = Builder.CreateAdd(A, C3, "", HasNUW, HasNSW);
4020             return new ICmpInst(Pred, NewAdd, C);
4021           } else {
4022             ConstantInt *C3 = Builder.getInt(AP2 - AP1);
4023             bool HasNUW = BO1->hasNoUnsignedWrap() && C3->getValue().ule(AP2);
4024             bool HasNSW = BO1->hasNoSignedWrap();
4025             Value *NewAdd = Builder.CreateAdd(C, C3, "", HasNUW, HasNSW);
4026             return new ICmpInst(Pred, A, NewAdd);
4027           }
4028         }
4029       }
4030 
4031   // Analyze the case when either Op0 or Op1 is a sub instruction.
4032   // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
4033   A = nullptr;
4034   B = nullptr;
4035   C = nullptr;
4036   D = nullptr;
4037   if (BO0 && BO0->getOpcode() == Instruction::Sub) {
4038     A = BO0->getOperand(0);
4039     B = BO0->getOperand(1);
4040   }
4041   if (BO1 && BO1->getOpcode() == Instruction::Sub) {
4042     C = BO1->getOperand(0);
4043     D = BO1->getOperand(1);
4044   }
4045 
4046   // icmp (A-B), A -> icmp 0, B for equalities or if there is no overflow.
4047   if (A == Op1 && NoOp0WrapProblem)
4048     return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
4049   // icmp C, (C-D) -> icmp D, 0 for equalities or if there is no overflow.
4050   if (C == Op0 && NoOp1WrapProblem)
4051     return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
4052 
4053   // Convert sub-with-unsigned-overflow comparisons into a comparison of args.
4054   // (A - B) u>/u<= A --> B u>/u<= A
4055   if (A == Op1 && (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE))
4056     return new ICmpInst(Pred, B, A);
4057   // C u</u>= (C - D) --> C u</u>= D
4058   if (C == Op0 && (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE))
4059     return new ICmpInst(Pred, C, D);
4060   // (A - B) u>=/u< A --> B u>/u<= A  iff B != 0
4061   if (A == Op1 && (Pred == ICmpInst::ICMP_UGE || Pred == ICmpInst::ICMP_ULT) &&
4062       isKnownNonZero(B, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
4063     return new ICmpInst(CmpInst::getFlippedStrictnessPredicate(Pred), B, A);
4064   // C u<=/u> (C - D) --> C u</u>= D  iff B != 0
4065   if (C == Op0 && (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_UGT) &&
4066       isKnownNonZero(D, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
4067     return new ICmpInst(CmpInst::getFlippedStrictnessPredicate(Pred), C, D);
4068 
4069   // icmp (A-B), (C-B) -> icmp A, C for equalities or if there is no overflow.
4070   if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem)
4071     return new ICmpInst(Pred, A, C);
4072 
4073   // icmp (A-B), (A-D) -> icmp D, B for equalities or if there is no overflow.
4074   if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem)
4075     return new ICmpInst(Pred, D, B);
4076 
4077   // icmp (0-X) < cst --> x > -cst
4078   if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
4079     Value *X;
4080     if (match(BO0, m_Neg(m_Value(X))))
4081       if (Constant *RHSC = dyn_cast<Constant>(Op1))
4082         if (RHSC->isNotMinSignedValue())
4083           return new ICmpInst(I.getSwappedPredicate(), X,
4084                               ConstantExpr::getNeg(RHSC));
4085   }
4086 
4087   {
4088     // Try to remove shared constant multiplier from equality comparison:
4089     // X * C == Y * C (with no overflowing/aliasing) --> X == Y
4090     Value *X, *Y;
4091     const APInt *C;
4092     if (match(Op0, m_Mul(m_Value(X), m_APInt(C))) && *C != 0 &&
4093         match(Op1, m_Mul(m_Value(Y), m_SpecificInt(*C))) && I.isEquality())
4094       if (!C->countTrailingZeros() ||
4095           (BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap()) ||
4096           (BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap()))
4097       return new ICmpInst(Pred, X, Y);
4098   }
4099 
4100   BinaryOperator *SRem = nullptr;
4101   // icmp (srem X, Y), Y
4102   if (BO0 && BO0->getOpcode() == Instruction::SRem && Op1 == BO0->getOperand(1))
4103     SRem = BO0;
4104   // icmp Y, (srem X, Y)
4105   else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
4106            Op0 == BO1->getOperand(1))
4107     SRem = BO1;
4108   if (SRem) {
4109     // We don't check hasOneUse to avoid increasing register pressure because
4110     // the value we use is the same value this instruction was already using.
4111     switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
4112     default:
4113       break;
4114     case ICmpInst::ICMP_EQ:
4115       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
4116     case ICmpInst::ICMP_NE:
4117       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4118     case ICmpInst::ICMP_SGT:
4119     case ICmpInst::ICMP_SGE:
4120       return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
4121                           Constant::getAllOnesValue(SRem->getType()));
4122     case ICmpInst::ICMP_SLT:
4123     case ICmpInst::ICMP_SLE:
4124       return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
4125                           Constant::getNullValue(SRem->getType()));
4126     }
4127   }
4128 
4129   if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() && BO0->hasOneUse() &&
4130       BO1->hasOneUse() && BO0->getOperand(1) == BO1->getOperand(1)) {
4131     switch (BO0->getOpcode()) {
4132     default:
4133       break;
4134     case Instruction::Add:
4135     case Instruction::Sub:
4136     case Instruction::Xor: {
4137       if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
4138         return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4139 
4140       const APInt *C;
4141       if (match(BO0->getOperand(1), m_APInt(C))) {
4142         // icmp u/s (a ^ signmask), (b ^ signmask) --> icmp s/u a, b
4143         if (C->isSignMask()) {
4144           ICmpInst::Predicate NewPred = I.getFlippedSignednessPredicate();
4145           return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0));
4146         }
4147 
4148         // icmp u/s (a ^ maxsignval), (b ^ maxsignval) --> icmp s/u' a, b
4149         if (BO0->getOpcode() == Instruction::Xor && C->isMaxSignedValue()) {
4150           ICmpInst::Predicate NewPred = I.getFlippedSignednessPredicate();
4151           NewPred = I.getSwappedPredicate(NewPred);
4152           return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0));
4153         }
4154       }
4155       break;
4156     }
4157     case Instruction::Mul: {
4158       if (!I.isEquality())
4159         break;
4160 
4161       const APInt *C;
4162       if (match(BO0->getOperand(1), m_APInt(C)) && !C->isNullValue() &&
4163           !C->isOneValue()) {
4164         // icmp eq/ne (X * C), (Y * C) --> icmp (X & Mask), (Y & Mask)
4165         // Mask = -1 >> count-trailing-zeros(C).
4166         if (unsigned TZs = C->countTrailingZeros()) {
4167           Constant *Mask = ConstantInt::get(
4168               BO0->getType(),
4169               APInt::getLowBitsSet(C->getBitWidth(), C->getBitWidth() - TZs));
4170           Value *And1 = Builder.CreateAnd(BO0->getOperand(0), Mask);
4171           Value *And2 = Builder.CreateAnd(BO1->getOperand(0), Mask);
4172           return new ICmpInst(Pred, And1, And2);
4173         }
4174       }
4175       break;
4176     }
4177     case Instruction::UDiv:
4178     case Instruction::LShr:
4179       if (I.isSigned() || !BO0->isExact() || !BO1->isExact())
4180         break;
4181       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4182 
4183     case Instruction::SDiv:
4184       if (!I.isEquality() || !BO0->isExact() || !BO1->isExact())
4185         break;
4186       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4187 
4188     case Instruction::AShr:
4189       if (!BO0->isExact() || !BO1->isExact())
4190         break;
4191       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4192 
4193     case Instruction::Shl: {
4194       bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
4195       bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
4196       if (!NUW && !NSW)
4197         break;
4198       if (!NSW && I.isSigned())
4199         break;
4200       return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
4201     }
4202     }
4203   }
4204 
4205   if (BO0) {
4206     // Transform  A & (L - 1) `ult` L --> L != 0
4207     auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
4208     auto BitwiseAnd = m_c_And(m_Value(), LSubOne);
4209 
4210     if (match(BO0, BitwiseAnd) && Pred == ICmpInst::ICMP_ULT) {
4211       auto *Zero = Constant::getNullValue(BO0->getType());
4212       return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
4213     }
4214   }
4215 
4216   if (Value *V = foldUnsignedMultiplicationOverflowCheck(I))
4217     return replaceInstUsesWith(I, V);
4218 
4219   if (Value *V = foldICmpWithLowBitMaskedVal(I, Builder))
4220     return replaceInstUsesWith(I, V);
4221 
4222   if (Value *V = foldICmpWithTruncSignExtendedVal(I, Builder))
4223     return replaceInstUsesWith(I, V);
4224 
4225   if (Value *V = foldShiftIntoShiftInAnotherHandOfAndInICmp(I, SQ, Builder))
4226     return replaceInstUsesWith(I, V);
4227 
4228   return nullptr;
4229 }
4230 
4231 /// Fold icmp Pred min|max(X, Y), X.
4232 static Instruction *foldICmpWithMinMax(ICmpInst &Cmp) {
4233   ICmpInst::Predicate Pred = Cmp.getPredicate();
4234   Value *Op0 = Cmp.getOperand(0);
4235   Value *X = Cmp.getOperand(1);
4236 
4237   // Canonicalize minimum or maximum operand to LHS of the icmp.
4238   if (match(X, m_c_SMin(m_Specific(Op0), m_Value())) ||
4239       match(X, m_c_SMax(m_Specific(Op0), m_Value())) ||
4240       match(X, m_c_UMin(m_Specific(Op0), m_Value())) ||
4241       match(X, m_c_UMax(m_Specific(Op0), m_Value()))) {
4242     std::swap(Op0, X);
4243     Pred = Cmp.getSwappedPredicate();
4244   }
4245 
4246   Value *Y;
4247   if (match(Op0, m_c_SMin(m_Specific(X), m_Value(Y)))) {
4248     // smin(X, Y)  == X --> X s<= Y
4249     // smin(X, Y) s>= X --> X s<= Y
4250     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SGE)
4251       return new ICmpInst(ICmpInst::ICMP_SLE, X, Y);
4252 
4253     // smin(X, Y) != X --> X s> Y
4254     // smin(X, Y) s< X --> X s> Y
4255     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SLT)
4256       return new ICmpInst(ICmpInst::ICMP_SGT, X, Y);
4257 
4258     // These cases should be handled in InstSimplify:
4259     // smin(X, Y) s<= X --> true
4260     // smin(X, Y) s> X --> false
4261     return nullptr;
4262   }
4263 
4264   if (match(Op0, m_c_SMax(m_Specific(X), m_Value(Y)))) {
4265     // smax(X, Y)  == X --> X s>= Y
4266     // smax(X, Y) s<= X --> X s>= Y
4267     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SLE)
4268       return new ICmpInst(ICmpInst::ICMP_SGE, X, Y);
4269 
4270     // smax(X, Y) != X --> X s< Y
4271     // smax(X, Y) s> X --> X s< Y
4272     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SGT)
4273       return new ICmpInst(ICmpInst::ICMP_SLT, X, Y);
4274 
4275     // These cases should be handled in InstSimplify:
4276     // smax(X, Y) s>= X --> true
4277     // smax(X, Y) s< X --> false
4278     return nullptr;
4279   }
4280 
4281   if (match(Op0, m_c_UMin(m_Specific(X), m_Value(Y)))) {
4282     // umin(X, Y)  == X --> X u<= Y
4283     // umin(X, Y) u>= X --> X u<= Y
4284     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_UGE)
4285       return new ICmpInst(ICmpInst::ICMP_ULE, X, Y);
4286 
4287     // umin(X, Y) != X --> X u> Y
4288     // umin(X, Y) u< X --> X u> Y
4289     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_ULT)
4290       return new ICmpInst(ICmpInst::ICMP_UGT, X, Y);
4291 
4292     // These cases should be handled in InstSimplify:
4293     // umin(X, Y) u<= X --> true
4294     // umin(X, Y) u> X --> false
4295     return nullptr;
4296   }
4297 
4298   if (match(Op0, m_c_UMax(m_Specific(X), m_Value(Y)))) {
4299     // umax(X, Y)  == X --> X u>= Y
4300     // umax(X, Y) u<= X --> X u>= Y
4301     if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_ULE)
4302       return new ICmpInst(ICmpInst::ICMP_UGE, X, Y);
4303 
4304     // umax(X, Y) != X --> X u< Y
4305     // umax(X, Y) u> X --> X u< Y
4306     if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_UGT)
4307       return new ICmpInst(ICmpInst::ICMP_ULT, X, Y);
4308 
4309     // These cases should be handled in InstSimplify:
4310     // umax(X, Y) u>= X --> true
4311     // umax(X, Y) u< X --> false
4312     return nullptr;
4313   }
4314 
4315   return nullptr;
4316 }
4317 
4318 Instruction *InstCombinerImpl::foldICmpEquality(ICmpInst &I) {
4319   if (!I.isEquality())
4320     return nullptr;
4321 
4322   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
4323   const CmpInst::Predicate Pred = I.getPredicate();
4324   Value *A, *B, *C, *D;
4325   if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
4326     if (A == Op1 || B == Op1) { // (A^B) == A  ->  B == 0
4327       Value *OtherVal = A == Op1 ? B : A;
4328       return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType()));
4329     }
4330 
4331     if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
4332       // A^c1 == C^c2 --> A == C^(c1^c2)
4333       ConstantInt *C1, *C2;
4334       if (match(B, m_ConstantInt(C1)) && match(D, m_ConstantInt(C2)) &&
4335           Op1->hasOneUse()) {
4336         Constant *NC = Builder.getInt(C1->getValue() ^ C2->getValue());
4337         Value *Xor = Builder.CreateXor(C, NC);
4338         return new ICmpInst(Pred, A, Xor);
4339       }
4340 
4341       // A^B == A^D -> B == D
4342       if (A == C)
4343         return new ICmpInst(Pred, B, D);
4344       if (A == D)
4345         return new ICmpInst(Pred, B, C);
4346       if (B == C)
4347         return new ICmpInst(Pred, A, D);
4348       if (B == D)
4349         return new ICmpInst(Pred, A, C);
4350     }
4351   }
4352 
4353   if (match(Op1, m_Xor(m_Value(A), m_Value(B))) && (A == Op0 || B == Op0)) {
4354     // A == (A^B)  ->  B == 0
4355     Value *OtherVal = A == Op0 ? B : A;
4356     return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType()));
4357   }
4358 
4359   // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
4360   if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
4361       match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
4362     Value *X = nullptr, *Y = nullptr, *Z = nullptr;
4363 
4364     if (A == C) {
4365       X = B;
4366       Y = D;
4367       Z = A;
4368     } else if (A == D) {
4369       X = B;
4370       Y = C;
4371       Z = A;
4372     } else if (B == C) {
4373       X = A;
4374       Y = D;
4375       Z = B;
4376     } else if (B == D) {
4377       X = A;
4378       Y = C;
4379       Z = B;
4380     }
4381 
4382     if (X) { // Build (X^Y) & Z
4383       Op1 = Builder.CreateXor(X, Y);
4384       Op1 = Builder.CreateAnd(Op1, Z);
4385       return new ICmpInst(Pred, Op1, Constant::getNullValue(Op1->getType()));
4386     }
4387   }
4388 
4389   // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
4390   // and       (B & (1<<X)-1) == (zext A) --> A == (trunc B)
4391   ConstantInt *Cst1;
4392   if ((Op0->hasOneUse() && match(Op0, m_ZExt(m_Value(A))) &&
4393        match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
4394       (Op1->hasOneUse() && match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
4395        match(Op1, m_ZExt(m_Value(A))))) {
4396     APInt Pow2 = Cst1->getValue() + 1;
4397     if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
4398         Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
4399       return new ICmpInst(Pred, A, Builder.CreateTrunc(B, A->getType()));
4400   }
4401 
4402   // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
4403   // For lshr and ashr pairs.
4404   if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4405        match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
4406       (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4407        match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
4408     unsigned TypeBits = Cst1->getBitWidth();
4409     unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4410     if (ShAmt < TypeBits && ShAmt != 0) {
4411       ICmpInst::Predicate NewPred =
4412           Pred == ICmpInst::ICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
4413       Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted");
4414       APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
4415       return new ICmpInst(NewPred, Xor, Builder.getInt(CmpVal));
4416     }
4417   }
4418 
4419   // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
4420   if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
4421       match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
4422     unsigned TypeBits = Cst1->getBitWidth();
4423     unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4424     if (ShAmt < TypeBits && ShAmt != 0) {
4425       Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted");
4426       APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
4427       Value *And = Builder.CreateAnd(Xor, Builder.getInt(AndVal),
4428                                       I.getName() + ".mask");
4429       return new ICmpInst(Pred, And, Constant::getNullValue(Cst1->getType()));
4430     }
4431   }
4432 
4433   // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
4434   // "icmp (and X, mask), cst"
4435   uint64_t ShAmt = 0;
4436   if (Op0->hasOneUse() &&
4437       match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A), m_ConstantInt(ShAmt))))) &&
4438       match(Op1, m_ConstantInt(Cst1)) &&
4439       // Only do this when A has multiple uses.  This is most important to do
4440       // when it exposes other optimizations.
4441       !A->hasOneUse()) {
4442     unsigned ASize = cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
4443 
4444     if (ShAmt < ASize) {
4445       APInt MaskV =
4446           APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
4447       MaskV <<= ShAmt;
4448 
4449       APInt CmpV = Cst1->getValue().zext(ASize);
4450       CmpV <<= ShAmt;
4451 
4452       Value *Mask = Builder.CreateAnd(A, Builder.getInt(MaskV));
4453       return new ICmpInst(Pred, Mask, Builder.getInt(CmpV));
4454     }
4455   }
4456 
4457   // If both operands are byte-swapped or bit-reversed, just compare the
4458   // original values.
4459   // TODO: Move this to a function similar to foldICmpIntrinsicWithConstant()
4460   // and handle more intrinsics.
4461   if ((match(Op0, m_BSwap(m_Value(A))) && match(Op1, m_BSwap(m_Value(B)))) ||
4462       (match(Op0, m_BitReverse(m_Value(A))) &&
4463        match(Op1, m_BitReverse(m_Value(B)))))
4464     return new ICmpInst(Pred, A, B);
4465 
4466   // Canonicalize checking for a power-of-2-or-zero value:
4467   // (A & (A-1)) == 0 --> ctpop(A) < 2 (two commuted variants)
4468   // ((A-1) & A) != 0 --> ctpop(A) > 1 (two commuted variants)
4469   if (!match(Op0, m_OneUse(m_c_And(m_Add(m_Value(A), m_AllOnes()),
4470                                    m_Deferred(A)))) ||
4471       !match(Op1, m_ZeroInt()))
4472     A = nullptr;
4473 
4474   // (A & -A) == A --> ctpop(A) < 2 (four commuted variants)
4475   // (-A & A) != A --> ctpop(A) > 1 (four commuted variants)
4476   if (match(Op0, m_OneUse(m_c_And(m_Neg(m_Specific(Op1)), m_Specific(Op1)))))
4477     A = Op1;
4478   else if (match(Op1,
4479                  m_OneUse(m_c_And(m_Neg(m_Specific(Op0)), m_Specific(Op0)))))
4480     A = Op0;
4481 
4482   if (A) {
4483     Type *Ty = A->getType();
4484     CallInst *CtPop = Builder.CreateUnaryIntrinsic(Intrinsic::ctpop, A);
4485     return Pred == ICmpInst::ICMP_EQ
4486         ? new ICmpInst(ICmpInst::ICMP_ULT, CtPop, ConstantInt::get(Ty, 2))
4487         : new ICmpInst(ICmpInst::ICMP_UGT, CtPop, ConstantInt::get(Ty, 1));
4488   }
4489 
4490   return nullptr;
4491 }
4492 
4493 static Instruction *foldICmpWithZextOrSext(ICmpInst &ICmp,
4494                                            InstCombiner::BuilderTy &Builder) {
4495   assert(isa<CastInst>(ICmp.getOperand(0)) && "Expected cast for operand 0");
4496   auto *CastOp0 = cast<CastInst>(ICmp.getOperand(0));
4497   Value *X;
4498   if (!match(CastOp0, m_ZExtOrSExt(m_Value(X))))
4499     return nullptr;
4500 
4501   bool IsSignedExt = CastOp0->getOpcode() == Instruction::SExt;
4502   bool IsSignedCmp = ICmp.isSigned();
4503   if (auto *CastOp1 = dyn_cast<CastInst>(ICmp.getOperand(1))) {
4504     // If the signedness of the two casts doesn't agree (i.e. one is a sext
4505     // and the other is a zext), then we can't handle this.
4506     // TODO: This is too strict. We can handle some predicates (equality?).
4507     if (CastOp0->getOpcode() != CastOp1->getOpcode())
4508       return nullptr;
4509 
4510     // Not an extension from the same type?
4511     Value *Y = CastOp1->getOperand(0);
4512     Type *XTy = X->getType(), *YTy = Y->getType();
4513     if (XTy != YTy) {
4514       // One of the casts must have one use because we are creating a new cast.
4515       if (!CastOp0->hasOneUse() && !CastOp1->hasOneUse())
4516         return nullptr;
4517       // Extend the narrower operand to the type of the wider operand.
4518       if (XTy->getScalarSizeInBits() < YTy->getScalarSizeInBits())
4519         X = Builder.CreateCast(CastOp0->getOpcode(), X, YTy);
4520       else if (YTy->getScalarSizeInBits() < XTy->getScalarSizeInBits())
4521         Y = Builder.CreateCast(CastOp0->getOpcode(), Y, XTy);
4522       else
4523         return nullptr;
4524     }
4525 
4526     // (zext X) == (zext Y) --> X == Y
4527     // (sext X) == (sext Y) --> X == Y
4528     if (ICmp.isEquality())
4529       return new ICmpInst(ICmp.getPredicate(), X, Y);
4530 
4531     // A signed comparison of sign extended values simplifies into a
4532     // signed comparison.
4533     if (IsSignedCmp && IsSignedExt)
4534       return new ICmpInst(ICmp.getPredicate(), X, Y);
4535 
4536     // The other three cases all fold into an unsigned comparison.
4537     return new ICmpInst(ICmp.getUnsignedPredicate(), X, Y);
4538   }
4539 
4540   // Below here, we are only folding a compare with constant.
4541   auto *C = dyn_cast<Constant>(ICmp.getOperand(1));
4542   if (!C)
4543     return nullptr;
4544 
4545   // Compute the constant that would happen if we truncated to SrcTy then
4546   // re-extended to DestTy.
4547   Type *SrcTy = CastOp0->getSrcTy();
4548   Type *DestTy = CastOp0->getDestTy();
4549   Constant *Res1 = ConstantExpr::getTrunc(C, SrcTy);
4550   Constant *Res2 = ConstantExpr::getCast(CastOp0->getOpcode(), Res1, DestTy);
4551 
4552   // If the re-extended constant didn't change...
4553   if (Res2 == C) {
4554     if (ICmp.isEquality())
4555       return new ICmpInst(ICmp.getPredicate(), X, Res1);
4556 
4557     // A signed comparison of sign extended values simplifies into a
4558     // signed comparison.
4559     if (IsSignedExt && IsSignedCmp)
4560       return new ICmpInst(ICmp.getPredicate(), X, Res1);
4561 
4562     // The other three cases all fold into an unsigned comparison.
4563     return new ICmpInst(ICmp.getUnsignedPredicate(), X, Res1);
4564   }
4565 
4566   // The re-extended constant changed, partly changed (in the case of a vector),
4567   // or could not be determined to be equal (in the case of a constant
4568   // expression), so the constant cannot be represented in the shorter type.
4569   // All the cases that fold to true or false will have already been handled
4570   // by SimplifyICmpInst, so only deal with the tricky case.
4571   if (IsSignedCmp || !IsSignedExt || !isa<ConstantInt>(C))
4572     return nullptr;
4573 
4574   // Is source op positive?
4575   // icmp ult (sext X), C --> icmp sgt X, -1
4576   if (ICmp.getPredicate() == ICmpInst::ICMP_ULT)
4577     return new ICmpInst(CmpInst::ICMP_SGT, X, Constant::getAllOnesValue(SrcTy));
4578 
4579   // Is source op negative?
4580   // icmp ugt (sext X), C --> icmp slt X, 0
4581   assert(ICmp.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
4582   return new ICmpInst(CmpInst::ICMP_SLT, X, Constant::getNullValue(SrcTy));
4583 }
4584 
4585 /// Handle icmp (cast x), (cast or constant).
4586 Instruction *InstCombinerImpl::foldICmpWithCastOp(ICmpInst &ICmp) {
4587   // If any operand of ICmp is a inttoptr roundtrip cast then remove it as
4588   // icmp compares only pointer's value.
4589   // icmp (inttoptr (ptrtoint p1)), p2 --> icmp p1, p2.
4590   Value *SimplifiedOp0 = simplifyIntToPtrRoundTripCast(ICmp.getOperand(0));
4591   Value *SimplifiedOp1 = simplifyIntToPtrRoundTripCast(ICmp.getOperand(1));
4592   if (SimplifiedOp0 || SimplifiedOp1)
4593     return new ICmpInst(ICmp.getPredicate(),
4594                         SimplifiedOp0 ? SimplifiedOp0 : ICmp.getOperand(0),
4595                         SimplifiedOp1 ? SimplifiedOp1 : ICmp.getOperand(1));
4596 
4597   auto *CastOp0 = dyn_cast<CastInst>(ICmp.getOperand(0));
4598   if (!CastOp0)
4599     return nullptr;
4600   if (!isa<Constant>(ICmp.getOperand(1)) && !isa<CastInst>(ICmp.getOperand(1)))
4601     return nullptr;
4602 
4603   Value *Op0Src = CastOp0->getOperand(0);
4604   Type *SrcTy = CastOp0->getSrcTy();
4605   Type *DestTy = CastOp0->getDestTy();
4606 
4607   // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
4608   // integer type is the same size as the pointer type.
4609   auto CompatibleSizes = [&](Type *SrcTy, Type *DestTy) {
4610     if (isa<VectorType>(SrcTy)) {
4611       SrcTy = cast<VectorType>(SrcTy)->getElementType();
4612       DestTy = cast<VectorType>(DestTy)->getElementType();
4613     }
4614     return DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth();
4615   };
4616   if (CastOp0->getOpcode() == Instruction::PtrToInt &&
4617       CompatibleSizes(SrcTy, DestTy)) {
4618     Value *NewOp1 = nullptr;
4619     if (auto *PtrToIntOp1 = dyn_cast<PtrToIntOperator>(ICmp.getOperand(1))) {
4620       Value *PtrSrc = PtrToIntOp1->getOperand(0);
4621       if (PtrSrc->getType()->getPointerAddressSpace() ==
4622           Op0Src->getType()->getPointerAddressSpace()) {
4623         NewOp1 = PtrToIntOp1->getOperand(0);
4624         // If the pointer types don't match, insert a bitcast.
4625         if (Op0Src->getType() != NewOp1->getType())
4626           NewOp1 = Builder.CreateBitCast(NewOp1, Op0Src->getType());
4627       }
4628     } else if (auto *RHSC = dyn_cast<Constant>(ICmp.getOperand(1))) {
4629       NewOp1 = ConstantExpr::getIntToPtr(RHSC, SrcTy);
4630     }
4631 
4632     if (NewOp1)
4633       return new ICmpInst(ICmp.getPredicate(), Op0Src, NewOp1);
4634   }
4635 
4636   return foldICmpWithZextOrSext(ICmp, Builder);
4637 }
4638 
4639 static bool isNeutralValue(Instruction::BinaryOps BinaryOp, Value *RHS) {
4640   switch (BinaryOp) {
4641     default:
4642       llvm_unreachable("Unsupported binary op");
4643     case Instruction::Add:
4644     case Instruction::Sub:
4645       return match(RHS, m_Zero());
4646     case Instruction::Mul:
4647       return match(RHS, m_One());
4648   }
4649 }
4650 
4651 OverflowResult
4652 InstCombinerImpl::computeOverflow(Instruction::BinaryOps BinaryOp,
4653                                   bool IsSigned, Value *LHS, Value *RHS,
4654                                   Instruction *CxtI) const {
4655   switch (BinaryOp) {
4656     default:
4657       llvm_unreachable("Unsupported binary op");
4658     case Instruction::Add:
4659       if (IsSigned)
4660         return computeOverflowForSignedAdd(LHS, RHS, CxtI);
4661       else
4662         return computeOverflowForUnsignedAdd(LHS, RHS, CxtI);
4663     case Instruction::Sub:
4664       if (IsSigned)
4665         return computeOverflowForSignedSub(LHS, RHS, CxtI);
4666       else
4667         return computeOverflowForUnsignedSub(LHS, RHS, CxtI);
4668     case Instruction::Mul:
4669       if (IsSigned)
4670         return computeOverflowForSignedMul(LHS, RHS, CxtI);
4671       else
4672         return computeOverflowForUnsignedMul(LHS, RHS, CxtI);
4673   }
4674 }
4675 
4676 bool InstCombinerImpl::OptimizeOverflowCheck(Instruction::BinaryOps BinaryOp,
4677                                              bool IsSigned, Value *LHS,
4678                                              Value *RHS, Instruction &OrigI,
4679                                              Value *&Result,
4680                                              Constant *&Overflow) {
4681   if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
4682     std::swap(LHS, RHS);
4683 
4684   // If the overflow check was an add followed by a compare, the insertion point
4685   // may be pointing to the compare.  We want to insert the new instructions
4686   // before the add in case there are uses of the add between the add and the
4687   // compare.
4688   Builder.SetInsertPoint(&OrigI);
4689 
4690   Type *OverflowTy = Type::getInt1Ty(LHS->getContext());
4691   if (auto *LHSTy = dyn_cast<VectorType>(LHS->getType()))
4692     OverflowTy = VectorType::get(OverflowTy, LHSTy->getElementCount());
4693 
4694   if (isNeutralValue(BinaryOp, RHS)) {
4695     Result = LHS;
4696     Overflow = ConstantInt::getFalse(OverflowTy);
4697     return true;
4698   }
4699 
4700   switch (computeOverflow(BinaryOp, IsSigned, LHS, RHS, &OrigI)) {
4701     case OverflowResult::MayOverflow:
4702       return false;
4703     case OverflowResult::AlwaysOverflowsLow:
4704     case OverflowResult::AlwaysOverflowsHigh:
4705       Result = Builder.CreateBinOp(BinaryOp, LHS, RHS);
4706       Result->takeName(&OrigI);
4707       Overflow = ConstantInt::getTrue(OverflowTy);
4708       return true;
4709     case OverflowResult::NeverOverflows:
4710       Result = Builder.CreateBinOp(BinaryOp, LHS, RHS);
4711       Result->takeName(&OrigI);
4712       Overflow = ConstantInt::getFalse(OverflowTy);
4713       if (auto *Inst = dyn_cast<Instruction>(Result)) {
4714         if (IsSigned)
4715           Inst->setHasNoSignedWrap();
4716         else
4717           Inst->setHasNoUnsignedWrap();
4718       }
4719       return true;
4720   }
4721 
4722   llvm_unreachable("Unexpected overflow result");
4723 }
4724 
4725 /// Recognize and process idiom involving test for multiplication
4726 /// overflow.
4727 ///
4728 /// The caller has matched a pattern of the form:
4729 ///   I = cmp u (mul(zext A, zext B), V
4730 /// The function checks if this is a test for overflow and if so replaces
4731 /// multiplication with call to 'mul.with.overflow' intrinsic.
4732 ///
4733 /// \param I Compare instruction.
4734 /// \param MulVal Result of 'mult' instruction.  It is one of the arguments of
4735 ///               the compare instruction.  Must be of integer type.
4736 /// \param OtherVal The other argument of compare instruction.
4737 /// \returns Instruction which must replace the compare instruction, NULL if no
4738 ///          replacement required.
4739 static Instruction *processUMulZExtIdiom(ICmpInst &I, Value *MulVal,
4740                                          Value *OtherVal,
4741                                          InstCombinerImpl &IC) {
4742   // Don't bother doing this transformation for pointers, don't do it for
4743   // vectors.
4744   if (!isa<IntegerType>(MulVal->getType()))
4745     return nullptr;
4746 
4747   assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
4748   assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
4749   auto *MulInstr = dyn_cast<Instruction>(MulVal);
4750   if (!MulInstr)
4751     return nullptr;
4752   assert(MulInstr->getOpcode() == Instruction::Mul);
4753 
4754   auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
4755        *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
4756   assert(LHS->getOpcode() == Instruction::ZExt);
4757   assert(RHS->getOpcode() == Instruction::ZExt);
4758   Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
4759 
4760   // Calculate type and width of the result produced by mul.with.overflow.
4761   Type *TyA = A->getType(), *TyB = B->getType();
4762   unsigned WidthA = TyA->getPrimitiveSizeInBits(),
4763            WidthB = TyB->getPrimitiveSizeInBits();
4764   unsigned MulWidth;
4765   Type *MulType;
4766   if (WidthB > WidthA) {
4767     MulWidth = WidthB;
4768     MulType = TyB;
4769   } else {
4770     MulWidth = WidthA;
4771     MulType = TyA;
4772   }
4773 
4774   // In order to replace the original mul with a narrower mul.with.overflow,
4775   // all uses must ignore upper bits of the product.  The number of used low
4776   // bits must be not greater than the width of mul.with.overflow.
4777   if (MulVal->hasNUsesOrMore(2))
4778     for (User *U : MulVal->users()) {
4779       if (U == &I)
4780         continue;
4781       if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
4782         // Check if truncation ignores bits above MulWidth.
4783         unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
4784         if (TruncWidth > MulWidth)
4785           return nullptr;
4786       } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
4787         // Check if AND ignores bits above MulWidth.
4788         if (BO->getOpcode() != Instruction::And)
4789           return nullptr;
4790         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
4791           const APInt &CVal = CI->getValue();
4792           if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
4793             return nullptr;
4794         } else {
4795           // In this case we could have the operand of the binary operation
4796           // being defined in another block, and performing the replacement
4797           // could break the dominance relation.
4798           return nullptr;
4799         }
4800       } else {
4801         // Other uses prohibit this transformation.
4802         return nullptr;
4803       }
4804     }
4805 
4806   // Recognize patterns
4807   switch (I.getPredicate()) {
4808   case ICmpInst::ICMP_EQ:
4809   case ICmpInst::ICMP_NE:
4810     // Recognize pattern:
4811     //   mulval = mul(zext A, zext B)
4812     //   cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
4813     ConstantInt *CI;
4814     Value *ValToMask;
4815     if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
4816       if (ValToMask != MulVal)
4817         return nullptr;
4818       const APInt &CVal = CI->getValue() + 1;
4819       if (CVal.isPowerOf2()) {
4820         unsigned MaskWidth = CVal.logBase2();
4821         if (MaskWidth == MulWidth)
4822           break; // Recognized
4823       }
4824     }
4825     return nullptr;
4826 
4827   case ICmpInst::ICMP_UGT:
4828     // Recognize pattern:
4829     //   mulval = mul(zext A, zext B)
4830     //   cmp ugt mulval, max
4831     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4832       APInt MaxVal = APInt::getMaxValue(MulWidth);
4833       MaxVal = MaxVal.zext(CI->getBitWidth());
4834       if (MaxVal.eq(CI->getValue()))
4835         break; // Recognized
4836     }
4837     return nullptr;
4838 
4839   case ICmpInst::ICMP_UGE:
4840     // Recognize pattern:
4841     //   mulval = mul(zext A, zext B)
4842     //   cmp uge mulval, max+1
4843     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4844       APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
4845       if (MaxVal.eq(CI->getValue()))
4846         break; // Recognized
4847     }
4848     return nullptr;
4849 
4850   case ICmpInst::ICMP_ULE:
4851     // Recognize pattern:
4852     //   mulval = mul(zext A, zext B)
4853     //   cmp ule mulval, max
4854     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4855       APInt MaxVal = APInt::getMaxValue(MulWidth);
4856       MaxVal = MaxVal.zext(CI->getBitWidth());
4857       if (MaxVal.eq(CI->getValue()))
4858         break; // Recognized
4859     }
4860     return nullptr;
4861 
4862   case ICmpInst::ICMP_ULT:
4863     // Recognize pattern:
4864     //   mulval = mul(zext A, zext B)
4865     //   cmp ule mulval, max + 1
4866     if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
4867       APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
4868       if (MaxVal.eq(CI->getValue()))
4869         break; // Recognized
4870     }
4871     return nullptr;
4872 
4873   default:
4874     return nullptr;
4875   }
4876 
4877   InstCombiner::BuilderTy &Builder = IC.Builder;
4878   Builder.SetInsertPoint(MulInstr);
4879 
4880   // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
4881   Value *MulA = A, *MulB = B;
4882   if (WidthA < MulWidth)
4883     MulA = Builder.CreateZExt(A, MulType);
4884   if (WidthB < MulWidth)
4885     MulB = Builder.CreateZExt(B, MulType);
4886   Function *F = Intrinsic::getDeclaration(
4887       I.getModule(), Intrinsic::umul_with_overflow, MulType);
4888   CallInst *Call = Builder.CreateCall(F, {MulA, MulB}, "umul");
4889   IC.addToWorklist(MulInstr);
4890 
4891   // If there are uses of mul result other than the comparison, we know that
4892   // they are truncation or binary AND. Change them to use result of
4893   // mul.with.overflow and adjust properly mask/size.
4894   if (MulVal->hasNUsesOrMore(2)) {
4895     Value *Mul = Builder.CreateExtractValue(Call, 0, "umul.value");
4896     for (User *U : make_early_inc_range(MulVal->users())) {
4897       if (U == &I || U == OtherVal)
4898         continue;
4899       if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
4900         if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
4901           IC.replaceInstUsesWith(*TI, Mul);
4902         else
4903           TI->setOperand(0, Mul);
4904       } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
4905         assert(BO->getOpcode() == Instruction::And);
4906         // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
4907         ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
4908         APInt ShortMask = CI->getValue().trunc(MulWidth);
4909         Value *ShortAnd = Builder.CreateAnd(Mul, ShortMask);
4910         Value *Zext = Builder.CreateZExt(ShortAnd, BO->getType());
4911         IC.replaceInstUsesWith(*BO, Zext);
4912       } else {
4913         llvm_unreachable("Unexpected Binary operation");
4914       }
4915       IC.addToWorklist(cast<Instruction>(U));
4916     }
4917   }
4918   if (isa<Instruction>(OtherVal))
4919     IC.addToWorklist(cast<Instruction>(OtherVal));
4920 
4921   // The original icmp gets replaced with the overflow value, maybe inverted
4922   // depending on predicate.
4923   bool Inverse = false;
4924   switch (I.getPredicate()) {
4925   case ICmpInst::ICMP_NE:
4926     break;
4927   case ICmpInst::ICMP_EQ:
4928     Inverse = true;
4929     break;
4930   case ICmpInst::ICMP_UGT:
4931   case ICmpInst::ICMP_UGE:
4932     if (I.getOperand(0) == MulVal)
4933       break;
4934     Inverse = true;
4935     break;
4936   case ICmpInst::ICMP_ULT:
4937   case ICmpInst::ICMP_ULE:
4938     if (I.getOperand(1) == MulVal)
4939       break;
4940     Inverse = true;
4941     break;
4942   default:
4943     llvm_unreachable("Unexpected predicate");
4944   }
4945   if (Inverse) {
4946     Value *Res = Builder.CreateExtractValue(Call, 1);
4947     return BinaryOperator::CreateNot(Res);
4948   }
4949 
4950   return ExtractValueInst::Create(Call, 1);
4951 }
4952 
4953 /// When performing a comparison against a constant, it is possible that not all
4954 /// the bits in the LHS are demanded. This helper method computes the mask that
4955 /// IS demanded.
4956 static APInt getDemandedBitsLHSMask(ICmpInst &I, unsigned BitWidth) {
4957   const APInt *RHS;
4958   if (!match(I.getOperand(1), m_APInt(RHS)))
4959     return APInt::getAllOnesValue(BitWidth);
4960 
4961   // If this is a normal comparison, it demands all bits. If it is a sign bit
4962   // comparison, it only demands the sign bit.
4963   bool UnusedBit;
4964   if (InstCombiner::isSignBitCheck(I.getPredicate(), *RHS, UnusedBit))
4965     return APInt::getSignMask(BitWidth);
4966 
4967   switch (I.getPredicate()) {
4968   // For a UGT comparison, we don't care about any bits that
4969   // correspond to the trailing ones of the comparand.  The value of these
4970   // bits doesn't impact the outcome of the comparison, because any value
4971   // greater than the RHS must differ in a bit higher than these due to carry.
4972   case ICmpInst::ICMP_UGT:
4973     return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingOnes());
4974 
4975   // Similarly, for a ULT comparison, we don't care about the trailing zeros.
4976   // Any value less than the RHS must differ in a higher bit because of carries.
4977   case ICmpInst::ICMP_ULT:
4978     return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingZeros());
4979 
4980   default:
4981     return APInt::getAllOnesValue(BitWidth);
4982   }
4983 }
4984 
4985 /// Check if the order of \p Op0 and \p Op1 as operands in an ICmpInst
4986 /// should be swapped.
4987 /// The decision is based on how many times these two operands are reused
4988 /// as subtract operands and their positions in those instructions.
4989 /// The rationale is that several architectures use the same instruction for
4990 /// both subtract and cmp. Thus, it is better if the order of those operands
4991 /// match.
4992 /// \return true if Op0 and Op1 should be swapped.
4993 static bool swapMayExposeCSEOpportunities(const Value *Op0, const Value *Op1) {
4994   // Filter out pointer values as those cannot appear directly in subtract.
4995   // FIXME: we may want to go through inttoptrs or bitcasts.
4996   if (Op0->getType()->isPointerTy())
4997     return false;
4998   // If a subtract already has the same operands as a compare, swapping would be
4999   // bad. If a subtract has the same operands as a compare but in reverse order,
5000   // then swapping is good.
5001   int GoodToSwap = 0;
5002   for (const User *U : Op0->users()) {
5003     if (match(U, m_Sub(m_Specific(Op1), m_Specific(Op0))))
5004       GoodToSwap++;
5005     else if (match(U, m_Sub(m_Specific(Op0), m_Specific(Op1))))
5006       GoodToSwap--;
5007   }
5008   return GoodToSwap > 0;
5009 }
5010 
5011 /// Check that one use is in the same block as the definition and all
5012 /// other uses are in blocks dominated by a given block.
5013 ///
5014 /// \param DI Definition
5015 /// \param UI Use
5016 /// \param DB Block that must dominate all uses of \p DI outside
5017 ///           the parent block
5018 /// \return true when \p UI is the only use of \p DI in the parent block
5019 /// and all other uses of \p DI are in blocks dominated by \p DB.
5020 ///
5021 bool InstCombinerImpl::dominatesAllUses(const Instruction *DI,
5022                                         const Instruction *UI,
5023                                         const BasicBlock *DB) const {
5024   assert(DI && UI && "Instruction not defined\n");
5025   // Ignore incomplete definitions.
5026   if (!DI->getParent())
5027     return false;
5028   // DI and UI must be in the same block.
5029   if (DI->getParent() != UI->getParent())
5030     return false;
5031   // Protect from self-referencing blocks.
5032   if (DI->getParent() == DB)
5033     return false;
5034   for (const User *U : DI->users()) {
5035     auto *Usr = cast<Instruction>(U);
5036     if (Usr != UI && !DT.dominates(DB, Usr->getParent()))
5037       return false;
5038   }
5039   return true;
5040 }
5041 
5042 /// Return true when the instruction sequence within a block is select-cmp-br.
5043 static bool isChainSelectCmpBranch(const SelectInst *SI) {
5044   const BasicBlock *BB = SI->getParent();
5045   if (!BB)
5046     return false;
5047   auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
5048   if (!BI || BI->getNumSuccessors() != 2)
5049     return false;
5050   auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
5051   if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
5052     return false;
5053   return true;
5054 }
5055 
5056 /// True when a select result is replaced by one of its operands
5057 /// in select-icmp sequence. This will eventually result in the elimination
5058 /// of the select.
5059 ///
5060 /// \param SI    Select instruction
5061 /// \param Icmp  Compare instruction
5062 /// \param SIOpd Operand that replaces the select
5063 ///
5064 /// Notes:
5065 /// - The replacement is global and requires dominator information
5066 /// - The caller is responsible for the actual replacement
5067 ///
5068 /// Example:
5069 ///
5070 /// entry:
5071 ///  %4 = select i1 %3, %C* %0, %C* null
5072 ///  %5 = icmp eq %C* %4, null
5073 ///  br i1 %5, label %9, label %7
5074 ///  ...
5075 ///  ; <label>:7                                       ; preds = %entry
5076 ///  %8 = getelementptr inbounds %C* %4, i64 0, i32 0
5077 ///  ...
5078 ///
5079 /// can be transformed to
5080 ///
5081 ///  %5 = icmp eq %C* %0, null
5082 ///  %6 = select i1 %3, i1 %5, i1 true
5083 ///  br i1 %6, label %9, label %7
5084 ///  ...
5085 ///  ; <label>:7                                       ; preds = %entry
5086 ///  %8 = getelementptr inbounds %C* %0, i64 0, i32 0  // replace by %0!
5087 ///
5088 /// Similar when the first operand of the select is a constant or/and
5089 /// the compare is for not equal rather than equal.
5090 ///
5091 /// NOTE: The function is only called when the select and compare constants
5092 /// are equal, the optimization can work only for EQ predicates. This is not a
5093 /// major restriction since a NE compare should be 'normalized' to an equal
5094 /// compare, which usually happens in the combiner and test case
5095 /// select-cmp-br.ll checks for it.
5096 bool InstCombinerImpl::replacedSelectWithOperand(SelectInst *SI,
5097                                                  const ICmpInst *Icmp,
5098                                                  const unsigned SIOpd) {
5099   assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
5100   if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
5101     BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
5102     // The check for the single predecessor is not the best that can be
5103     // done. But it protects efficiently against cases like when SI's
5104     // home block has two successors, Succ and Succ1, and Succ1 predecessor
5105     // of Succ. Then SI can't be replaced by SIOpd because the use that gets
5106     // replaced can be reached on either path. So the uniqueness check
5107     // guarantees that the path all uses of SI (outside SI's parent) are on
5108     // is disjoint from all other paths out of SI. But that information
5109     // is more expensive to compute, and the trade-off here is in favor
5110     // of compile-time. It should also be noticed that we check for a single
5111     // predecessor and not only uniqueness. This to handle the situation when
5112     // Succ and Succ1 points to the same basic block.
5113     if (Succ->getSinglePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
5114       NumSel++;
5115       SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
5116       return true;
5117     }
5118   }
5119   return false;
5120 }
5121 
5122 /// Try to fold the comparison based on range information we can get by checking
5123 /// whether bits are known to be zero or one in the inputs.
5124 Instruction *InstCombinerImpl::foldICmpUsingKnownBits(ICmpInst &I) {
5125   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
5126   Type *Ty = Op0->getType();
5127   ICmpInst::Predicate Pred = I.getPredicate();
5128 
5129   // Get scalar or pointer size.
5130   unsigned BitWidth = Ty->isIntOrIntVectorTy()
5131                           ? Ty->getScalarSizeInBits()
5132                           : DL.getPointerTypeSizeInBits(Ty->getScalarType());
5133 
5134   if (!BitWidth)
5135     return nullptr;
5136 
5137   KnownBits Op0Known(BitWidth);
5138   KnownBits Op1Known(BitWidth);
5139 
5140   if (SimplifyDemandedBits(&I, 0,
5141                            getDemandedBitsLHSMask(I, BitWidth),
5142                            Op0Known, 0))
5143     return &I;
5144 
5145   if (SimplifyDemandedBits(&I, 1, APInt::getAllOnesValue(BitWidth),
5146                            Op1Known, 0))
5147     return &I;
5148 
5149   // Given the known and unknown bits, compute a range that the LHS could be
5150   // in.  Compute the Min, Max and RHS values based on the known bits. For the
5151   // EQ and NE we use unsigned values.
5152   APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
5153   APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
5154   if (I.isSigned()) {
5155     Op0Min = Op0Known.getSignedMinValue();
5156     Op0Max = Op0Known.getSignedMaxValue();
5157     Op1Min = Op1Known.getSignedMinValue();
5158     Op1Max = Op1Known.getSignedMaxValue();
5159   } else {
5160     Op0Min = Op0Known.getMinValue();
5161     Op0Max = Op0Known.getMaxValue();
5162     Op1Min = Op1Known.getMinValue();
5163     Op1Max = Op1Known.getMaxValue();
5164   }
5165 
5166   // If Min and Max are known to be the same, then SimplifyDemandedBits figured
5167   // out that the LHS or RHS is a constant. Constant fold this now, so that
5168   // code below can assume that Min != Max.
5169   if (!isa<Constant>(Op0) && Op0Min == Op0Max)
5170     return new ICmpInst(Pred, ConstantExpr::getIntegerValue(Ty, Op0Min), Op1);
5171   if (!isa<Constant>(Op1) && Op1Min == Op1Max)
5172     return new ICmpInst(Pred, Op0, ConstantExpr::getIntegerValue(Ty, Op1Min));
5173 
5174   // Based on the range information we know about the LHS, see if we can
5175   // simplify this comparison.  For example, (x&4) < 8 is always true.
5176   switch (Pred) {
5177   default:
5178     llvm_unreachable("Unknown icmp opcode!");
5179   case ICmpInst::ICMP_EQ:
5180   case ICmpInst::ICMP_NE: {
5181     if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
5182       return replaceInstUsesWith(
5183           I, ConstantInt::getBool(I.getType(), Pred == CmpInst::ICMP_NE));
5184 
5185     // If all bits are known zero except for one, then we know at most one bit
5186     // is set. If the comparison is against zero, then this is a check to see if
5187     // *that* bit is set.
5188     APInt Op0KnownZeroInverted = ~Op0Known.Zero;
5189     if (Op1Known.isZero()) {
5190       // If the LHS is an AND with the same constant, look through it.
5191       Value *LHS = nullptr;
5192       const APInt *LHSC;
5193       if (!match(Op0, m_And(m_Value(LHS), m_APInt(LHSC))) ||
5194           *LHSC != Op0KnownZeroInverted)
5195         LHS = Op0;
5196 
5197       Value *X;
5198       if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
5199         APInt ValToCheck = Op0KnownZeroInverted;
5200         Type *XTy = X->getType();
5201         if (ValToCheck.isPowerOf2()) {
5202           // ((1 << X) & 8) == 0 -> X != 3
5203           // ((1 << X) & 8) != 0 -> X == 3
5204           auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros());
5205           auto NewPred = ICmpInst::getInversePredicate(Pred);
5206           return new ICmpInst(NewPred, X, CmpC);
5207         } else if ((++ValToCheck).isPowerOf2()) {
5208           // ((1 << X) & 7) == 0 -> X >= 3
5209           // ((1 << X) & 7) != 0 -> X  < 3
5210           auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros());
5211           auto NewPred =
5212               Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGE : CmpInst::ICMP_ULT;
5213           return new ICmpInst(NewPred, X, CmpC);
5214         }
5215       }
5216 
5217       // Check if the LHS is 8 >>u x and the result is a power of 2 like 1.
5218       const APInt *CI;
5219       if (Op0KnownZeroInverted.isOneValue() &&
5220           match(LHS, m_LShr(m_Power2(CI), m_Value(X)))) {
5221         // ((8 >>u X) & 1) == 0 -> X != 3
5222         // ((8 >>u X) & 1) != 0 -> X == 3
5223         unsigned CmpVal = CI->countTrailingZeros();
5224         auto NewPred = ICmpInst::getInversePredicate(Pred);
5225         return new ICmpInst(NewPred, X, ConstantInt::get(X->getType(), CmpVal));
5226       }
5227     }
5228     break;
5229   }
5230   case ICmpInst::ICMP_ULT: {
5231     if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
5232       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5233     if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
5234       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5235     if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
5236       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5237 
5238     const APInt *CmpC;
5239     if (match(Op1, m_APInt(CmpC))) {
5240       // A <u C -> A == C-1 if min(A)+1 == C
5241       if (*CmpC == Op0Min + 1)
5242         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5243                             ConstantInt::get(Op1->getType(), *CmpC - 1));
5244       // X <u C --> X == 0, if the number of zero bits in the bottom of X
5245       // exceeds the log2 of C.
5246       if (Op0Known.countMinTrailingZeros() >= CmpC->ceilLogBase2())
5247         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5248                             Constant::getNullValue(Op1->getType()));
5249     }
5250     break;
5251   }
5252   case ICmpInst::ICMP_UGT: {
5253     if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
5254       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5255     if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
5256       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5257     if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
5258       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5259 
5260     const APInt *CmpC;
5261     if (match(Op1, m_APInt(CmpC))) {
5262       // A >u C -> A == C+1 if max(a)-1 == C
5263       if (*CmpC == Op0Max - 1)
5264         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5265                             ConstantInt::get(Op1->getType(), *CmpC + 1));
5266       // X >u C --> X != 0, if the number of zero bits in the bottom of X
5267       // exceeds the log2 of C.
5268       if (Op0Known.countMinTrailingZeros() >= CmpC->getActiveBits())
5269         return new ICmpInst(ICmpInst::ICMP_NE, Op0,
5270                             Constant::getNullValue(Op1->getType()));
5271     }
5272     break;
5273   }
5274   case ICmpInst::ICMP_SLT: {
5275     if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
5276       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5277     if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
5278       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5279     if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
5280       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5281     const APInt *CmpC;
5282     if (match(Op1, m_APInt(CmpC))) {
5283       if (*CmpC == Op0Min + 1) // A <s C -> A == C-1 if min(A)+1 == C
5284         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5285                             ConstantInt::get(Op1->getType(), *CmpC - 1));
5286     }
5287     break;
5288   }
5289   case ICmpInst::ICMP_SGT: {
5290     if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
5291       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5292     if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
5293       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5294     if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
5295       return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
5296     const APInt *CmpC;
5297     if (match(Op1, m_APInt(CmpC))) {
5298       if (*CmpC == Op0Max - 1) // A >s C -> A == C+1 if max(A)-1 == C
5299         return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
5300                             ConstantInt::get(Op1->getType(), *CmpC + 1));
5301     }
5302     break;
5303   }
5304   case ICmpInst::ICMP_SGE:
5305     assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
5306     if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
5307       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5308     if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
5309       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5310     if (Op1Min == Op0Max) // A >=s B -> A == B if max(A) == min(B)
5311       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5312     break;
5313   case ICmpInst::ICMP_SLE:
5314     assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
5315     if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
5316       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5317     if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
5318       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5319     if (Op1Max == Op0Min) // A <=s B -> A == B if min(A) == max(B)
5320       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5321     break;
5322   case ICmpInst::ICMP_UGE:
5323     assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
5324     if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
5325       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5326     if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
5327       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5328     if (Op1Min == Op0Max) // A >=u B -> A == B if max(A) == min(B)
5329       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5330     break;
5331   case ICmpInst::ICMP_ULE:
5332     assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
5333     if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
5334       return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
5335     if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
5336       return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
5337     if (Op1Max == Op0Min) // A <=u B -> A == B if min(A) == max(B)
5338       return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
5339     break;
5340   }
5341 
5342   // Turn a signed comparison into an unsigned one if both operands are known to
5343   // have the same sign.
5344   if (I.isSigned() &&
5345       ((Op0Known.Zero.isNegative() && Op1Known.Zero.isNegative()) ||
5346        (Op0Known.One.isNegative() && Op1Known.One.isNegative())))
5347     return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
5348 
5349   return nullptr;
5350 }
5351 
5352 llvm::Optional<std::pair<CmpInst::Predicate, Constant *>>
5353 InstCombiner::getFlippedStrictnessPredicateAndConstant(CmpInst::Predicate Pred,
5354                                                        Constant *C) {
5355   assert(ICmpInst::isRelational(Pred) && ICmpInst::isIntPredicate(Pred) &&
5356          "Only for relational integer predicates.");
5357 
5358   Type *Type = C->getType();
5359   bool IsSigned = ICmpInst::isSigned(Pred);
5360 
5361   CmpInst::Predicate UnsignedPred = ICmpInst::getUnsignedPredicate(Pred);
5362   bool WillIncrement =
5363       UnsignedPred == ICmpInst::ICMP_ULE || UnsignedPred == ICmpInst::ICMP_UGT;
5364 
5365   // Check if the constant operand can be safely incremented/decremented
5366   // without overflowing/underflowing.
5367   auto ConstantIsOk = [WillIncrement, IsSigned](ConstantInt *C) {
5368     return WillIncrement ? !C->isMaxValue(IsSigned) : !C->isMinValue(IsSigned);
5369   };
5370 
5371   Constant *SafeReplacementConstant = nullptr;
5372   if (auto *CI = dyn_cast<ConstantInt>(C)) {
5373     // Bail out if the constant can't be safely incremented/decremented.
5374     if (!ConstantIsOk(CI))
5375       return llvm::None;
5376   } else if (auto *FVTy = dyn_cast<FixedVectorType>(Type)) {
5377     unsigned NumElts = FVTy->getNumElements();
5378     for (unsigned i = 0; i != NumElts; ++i) {
5379       Constant *Elt = C->getAggregateElement(i);
5380       if (!Elt)
5381         return llvm::None;
5382 
5383       if (isa<UndefValue>(Elt))
5384         continue;
5385 
5386       // Bail out if we can't determine if this constant is min/max or if we
5387       // know that this constant is min/max.
5388       auto *CI = dyn_cast<ConstantInt>(Elt);
5389       if (!CI || !ConstantIsOk(CI))
5390         return llvm::None;
5391 
5392       if (!SafeReplacementConstant)
5393         SafeReplacementConstant = CI;
5394     }
5395   } else {
5396     // ConstantExpr?
5397     return llvm::None;
5398   }
5399 
5400   // It may not be safe to change a compare predicate in the presence of
5401   // undefined elements, so replace those elements with the first safe constant
5402   // that we found.
5403   // TODO: in case of poison, it is safe; let's replace undefs only.
5404   if (C->containsUndefOrPoisonElement()) {
5405     assert(SafeReplacementConstant && "Replacement constant not set");
5406     C = Constant::replaceUndefsWith(C, SafeReplacementConstant);
5407   }
5408 
5409   CmpInst::Predicate NewPred = CmpInst::getFlippedStrictnessPredicate(Pred);
5410 
5411   // Increment or decrement the constant.
5412   Constant *OneOrNegOne = ConstantInt::get(Type, WillIncrement ? 1 : -1, true);
5413   Constant *NewC = ConstantExpr::getAdd(C, OneOrNegOne);
5414 
5415   return std::make_pair(NewPred, NewC);
5416 }
5417 
5418 /// If we have an icmp le or icmp ge instruction with a constant operand, turn
5419 /// it into the appropriate icmp lt or icmp gt instruction. This transform
5420 /// allows them to be folded in visitICmpInst.
5421 static ICmpInst *canonicalizeCmpWithConstant(ICmpInst &I) {
5422   ICmpInst::Predicate Pred = I.getPredicate();
5423   if (ICmpInst::isEquality(Pred) || !ICmpInst::isIntPredicate(Pred) ||
5424       InstCombiner::isCanonicalPredicate(Pred))
5425     return nullptr;
5426 
5427   Value *Op0 = I.getOperand(0);
5428   Value *Op1 = I.getOperand(1);
5429   auto *Op1C = dyn_cast<Constant>(Op1);
5430   if (!Op1C)
5431     return nullptr;
5432 
5433   auto FlippedStrictness =
5434       InstCombiner::getFlippedStrictnessPredicateAndConstant(Pred, Op1C);
5435   if (!FlippedStrictness)
5436     return nullptr;
5437 
5438   return new ICmpInst(FlippedStrictness->first, Op0, FlippedStrictness->second);
5439 }
5440 
5441 /// If we have a comparison with a non-canonical predicate, if we can update
5442 /// all the users, invert the predicate and adjust all the users.
5443 CmpInst *InstCombinerImpl::canonicalizeICmpPredicate(CmpInst &I) {
5444   // Is the predicate already canonical?
5445   CmpInst::Predicate Pred = I.getPredicate();
5446   if (InstCombiner::isCanonicalPredicate(Pred))
5447     return nullptr;
5448 
5449   // Can all users be adjusted to predicate inversion?
5450   if (!InstCombiner::canFreelyInvertAllUsersOf(&I, /*IgnoredUser=*/nullptr))
5451     return nullptr;
5452 
5453   // Ok, we can canonicalize comparison!
5454   // Let's first invert the comparison's predicate.
5455   I.setPredicate(CmpInst::getInversePredicate(Pred));
5456   I.setName(I.getName() + ".not");
5457 
5458   // And, adapt users.
5459   freelyInvertAllUsersOf(&I);
5460 
5461   return &I;
5462 }
5463 
5464 /// Integer compare with boolean values can always be turned into bitwise ops.
5465 static Instruction *canonicalizeICmpBool(ICmpInst &I,
5466                                          InstCombiner::BuilderTy &Builder) {
5467   Value *A = I.getOperand(0), *B = I.getOperand(1);
5468   assert(A->getType()->isIntOrIntVectorTy(1) && "Bools only");
5469 
5470   // A boolean compared to true/false can be simplified to Op0/true/false in
5471   // 14 out of the 20 (10 predicates * 2 constants) possible combinations.
5472   // Cases not handled by InstSimplify are always 'not' of Op0.
5473   if (match(B, m_Zero())) {
5474     switch (I.getPredicate()) {
5475       case CmpInst::ICMP_EQ:  // A ==   0 -> !A
5476       case CmpInst::ICMP_ULE: // A <=u  0 -> !A
5477       case CmpInst::ICMP_SGE: // A >=s  0 -> !A
5478         return BinaryOperator::CreateNot(A);
5479       default:
5480         llvm_unreachable("ICmp i1 X, C not simplified as expected.");
5481     }
5482   } else if (match(B, m_One())) {
5483     switch (I.getPredicate()) {
5484       case CmpInst::ICMP_NE:  // A !=  1 -> !A
5485       case CmpInst::ICMP_ULT: // A <u  1 -> !A
5486       case CmpInst::ICMP_SGT: // A >s -1 -> !A
5487         return BinaryOperator::CreateNot(A);
5488       default:
5489         llvm_unreachable("ICmp i1 X, C not simplified as expected.");
5490     }
5491   }
5492 
5493   switch (I.getPredicate()) {
5494   default:
5495     llvm_unreachable("Invalid icmp instruction!");
5496   case ICmpInst::ICMP_EQ:
5497     // icmp eq i1 A, B -> ~(A ^ B)
5498     return BinaryOperator::CreateNot(Builder.CreateXor(A, B));
5499 
5500   case ICmpInst::ICMP_NE:
5501     // icmp ne i1 A, B -> A ^ B
5502     return BinaryOperator::CreateXor(A, B);
5503 
5504   case ICmpInst::ICMP_UGT:
5505     // icmp ugt -> icmp ult
5506     std::swap(A, B);
5507     LLVM_FALLTHROUGH;
5508   case ICmpInst::ICMP_ULT:
5509     // icmp ult i1 A, B -> ~A & B
5510     return BinaryOperator::CreateAnd(Builder.CreateNot(A), B);
5511 
5512   case ICmpInst::ICMP_SGT:
5513     // icmp sgt -> icmp slt
5514     std::swap(A, B);
5515     LLVM_FALLTHROUGH;
5516   case ICmpInst::ICMP_SLT:
5517     // icmp slt i1 A, B -> A & ~B
5518     return BinaryOperator::CreateAnd(Builder.CreateNot(B), A);
5519 
5520   case ICmpInst::ICMP_UGE:
5521     // icmp uge -> icmp ule
5522     std::swap(A, B);
5523     LLVM_FALLTHROUGH;
5524   case ICmpInst::ICMP_ULE:
5525     // icmp ule i1 A, B -> ~A | B
5526     return BinaryOperator::CreateOr(Builder.CreateNot(A), B);
5527 
5528   case ICmpInst::ICMP_SGE:
5529     // icmp sge -> icmp sle
5530     std::swap(A, B);
5531     LLVM_FALLTHROUGH;
5532   case ICmpInst::ICMP_SLE:
5533     // icmp sle i1 A, B -> A | ~B
5534     return BinaryOperator::CreateOr(Builder.CreateNot(B), A);
5535   }
5536 }
5537 
5538 // Transform pattern like:
5539 //   (1 << Y) u<= X  or  ~(-1 << Y) u<  X  or  ((1 << Y)+(-1)) u<  X
5540 //   (1 << Y) u>  X  or  ~(-1 << Y) u>= X  or  ((1 << Y)+(-1)) u>= X
5541 // Into:
5542 //   (X l>> Y) != 0
5543 //   (X l>> Y) == 0
5544 static Instruction *foldICmpWithHighBitMask(ICmpInst &Cmp,
5545                                             InstCombiner::BuilderTy &Builder) {
5546   ICmpInst::Predicate Pred, NewPred;
5547   Value *X, *Y;
5548   if (match(&Cmp,
5549             m_c_ICmp(Pred, m_OneUse(m_Shl(m_One(), m_Value(Y))), m_Value(X)))) {
5550     switch (Pred) {
5551     case ICmpInst::ICMP_ULE:
5552       NewPred = ICmpInst::ICMP_NE;
5553       break;
5554     case ICmpInst::ICMP_UGT:
5555       NewPred = ICmpInst::ICMP_EQ;
5556       break;
5557     default:
5558       return nullptr;
5559     }
5560   } else if (match(&Cmp, m_c_ICmp(Pred,
5561                                   m_OneUse(m_CombineOr(
5562                                       m_Not(m_Shl(m_AllOnes(), m_Value(Y))),
5563                                       m_Add(m_Shl(m_One(), m_Value(Y)),
5564                                             m_AllOnes()))),
5565                                   m_Value(X)))) {
5566     // The variant with 'add' is not canonical, (the variant with 'not' is)
5567     // we only get it because it has extra uses, and can't be canonicalized,
5568 
5569     switch (Pred) {
5570     case ICmpInst::ICMP_ULT:
5571       NewPred = ICmpInst::ICMP_NE;
5572       break;
5573     case ICmpInst::ICMP_UGE:
5574       NewPred = ICmpInst::ICMP_EQ;
5575       break;
5576     default:
5577       return nullptr;
5578     }
5579   } else
5580     return nullptr;
5581 
5582   Value *NewX = Builder.CreateLShr(X, Y, X->getName() + ".highbits");
5583   Constant *Zero = Constant::getNullValue(NewX->getType());
5584   return CmpInst::Create(Instruction::ICmp, NewPred, NewX, Zero);
5585 }
5586 
5587 static Instruction *foldVectorCmp(CmpInst &Cmp,
5588                                   InstCombiner::BuilderTy &Builder) {
5589   const CmpInst::Predicate Pred = Cmp.getPredicate();
5590   Value *LHS = Cmp.getOperand(0), *RHS = Cmp.getOperand(1);
5591   Value *V1, *V2;
5592   ArrayRef<int> M;
5593   if (!match(LHS, m_Shuffle(m_Value(V1), m_Undef(), m_Mask(M))))
5594     return nullptr;
5595 
5596   // If both arguments of the cmp are shuffles that use the same mask and
5597   // shuffle within a single vector, move the shuffle after the cmp:
5598   // cmp (shuffle V1, M), (shuffle V2, M) --> shuffle (cmp V1, V2), M
5599   Type *V1Ty = V1->getType();
5600   if (match(RHS, m_Shuffle(m_Value(V2), m_Undef(), m_SpecificMask(M))) &&
5601       V1Ty == V2->getType() && (LHS->hasOneUse() || RHS->hasOneUse())) {
5602     Value *NewCmp = Builder.CreateCmp(Pred, V1, V2);
5603     return new ShuffleVectorInst(NewCmp, UndefValue::get(NewCmp->getType()), M);
5604   }
5605 
5606   // Try to canonicalize compare with splatted operand and splat constant.
5607   // TODO: We could generalize this for more than splats. See/use the code in
5608   //       InstCombiner::foldVectorBinop().
5609   Constant *C;
5610   if (!LHS->hasOneUse() || !match(RHS, m_Constant(C)))
5611     return nullptr;
5612 
5613   // Length-changing splats are ok, so adjust the constants as needed:
5614   // cmp (shuffle V1, M), C --> shuffle (cmp V1, C'), M
5615   Constant *ScalarC = C->getSplatValue(/* AllowUndefs */ true);
5616   int MaskSplatIndex;
5617   if (ScalarC && match(M, m_SplatOrUndefMask(MaskSplatIndex))) {
5618     // We allow undefs in matching, but this transform removes those for safety.
5619     // Demanded elements analysis should be able to recover some/all of that.
5620     C = ConstantVector::getSplat(cast<VectorType>(V1Ty)->getElementCount(),
5621                                  ScalarC);
5622     SmallVector<int, 8> NewM(M.size(), MaskSplatIndex);
5623     Value *NewCmp = Builder.CreateCmp(Pred, V1, C);
5624     return new ShuffleVectorInst(NewCmp, UndefValue::get(NewCmp->getType()),
5625                                  NewM);
5626   }
5627 
5628   return nullptr;
5629 }
5630 
5631 // extract(uadd.with.overflow(A, B), 0) ult A
5632 //  -> extract(uadd.with.overflow(A, B), 1)
5633 static Instruction *foldICmpOfUAddOv(ICmpInst &I) {
5634   CmpInst::Predicate Pred = I.getPredicate();
5635   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
5636 
5637   Value *UAddOv;
5638   Value *A, *B;
5639   auto UAddOvResultPat = m_ExtractValue<0>(
5640       m_Intrinsic<Intrinsic::uadd_with_overflow>(m_Value(A), m_Value(B)));
5641   if (match(Op0, UAddOvResultPat) &&
5642       ((Pred == ICmpInst::ICMP_ULT && (Op1 == A || Op1 == B)) ||
5643        (Pred == ICmpInst::ICMP_EQ && match(Op1, m_ZeroInt()) &&
5644         (match(A, m_One()) || match(B, m_One()))) ||
5645        (Pred == ICmpInst::ICMP_NE && match(Op1, m_AllOnes()) &&
5646         (match(A, m_AllOnes()) || match(B, m_AllOnes())))))
5647     // extract(uadd.with.overflow(A, B), 0) < A
5648     // extract(uadd.with.overflow(A, 1), 0) == 0
5649     // extract(uadd.with.overflow(A, -1), 0) != -1
5650     UAddOv = cast<ExtractValueInst>(Op0)->getAggregateOperand();
5651   else if (match(Op1, UAddOvResultPat) &&
5652            Pred == ICmpInst::ICMP_UGT && (Op0 == A || Op0 == B))
5653     // A > extract(uadd.with.overflow(A, B), 0)
5654     UAddOv = cast<ExtractValueInst>(Op1)->getAggregateOperand();
5655   else
5656     return nullptr;
5657 
5658   return ExtractValueInst::Create(UAddOv, 1);
5659 }
5660 
5661 Instruction *InstCombinerImpl::visitICmpInst(ICmpInst &I) {
5662   bool Changed = false;
5663   const SimplifyQuery Q = SQ.getWithInstruction(&I);
5664   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
5665   unsigned Op0Cplxity = getComplexity(Op0);
5666   unsigned Op1Cplxity = getComplexity(Op1);
5667 
5668   /// Orders the operands of the compare so that they are listed from most
5669   /// complex to least complex.  This puts constants before unary operators,
5670   /// before binary operators.
5671   if (Op0Cplxity < Op1Cplxity ||
5672       (Op0Cplxity == Op1Cplxity && swapMayExposeCSEOpportunities(Op0, Op1))) {
5673     I.swapOperands();
5674     std::swap(Op0, Op1);
5675     Changed = true;
5676   }
5677 
5678   if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, Q))
5679     return replaceInstUsesWith(I, V);
5680 
5681   // Comparing -val or val with non-zero is the same as just comparing val
5682   // ie, abs(val) != 0 -> val != 0
5683   if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero())) {
5684     Value *Cond, *SelectTrue, *SelectFalse;
5685     if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
5686                             m_Value(SelectFalse)))) {
5687       if (Value *V = dyn_castNegVal(SelectTrue)) {
5688         if (V == SelectFalse)
5689           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
5690       }
5691       else if (Value *V = dyn_castNegVal(SelectFalse)) {
5692         if (V == SelectTrue)
5693           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
5694       }
5695     }
5696   }
5697 
5698   if (Op0->getType()->isIntOrIntVectorTy(1))
5699     if (Instruction *Res = canonicalizeICmpBool(I, Builder))
5700       return Res;
5701 
5702   if (Instruction *Res = canonicalizeCmpWithConstant(I))
5703     return Res;
5704 
5705   if (Instruction *Res = canonicalizeICmpPredicate(I))
5706     return Res;
5707 
5708   if (Instruction *Res = foldICmpWithConstant(I))
5709     return Res;
5710 
5711   if (Instruction *Res = foldICmpWithDominatingICmp(I))
5712     return Res;
5713 
5714   if (Instruction *Res = foldICmpBinOp(I, Q))
5715     return Res;
5716 
5717   if (Instruction *Res = foldICmpUsingKnownBits(I))
5718     return Res;
5719 
5720   // Test if the ICmpInst instruction is used exclusively by a select as
5721   // part of a minimum or maximum operation. If so, refrain from doing
5722   // any other folding. This helps out other analyses which understand
5723   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
5724   // and CodeGen. And in this case, at least one of the comparison
5725   // operands has at least one user besides the compare (the select),
5726   // which would often largely negate the benefit of folding anyway.
5727   //
5728   // Do the same for the other patterns recognized by matchSelectPattern.
5729   if (I.hasOneUse())
5730     if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) {
5731       Value *A, *B;
5732       SelectPatternResult SPR = matchSelectPattern(SI, A, B);
5733       if (SPR.Flavor != SPF_UNKNOWN)
5734         return nullptr;
5735     }
5736 
5737   // Do this after checking for min/max to prevent infinite looping.
5738   if (Instruction *Res = foldICmpWithZero(I))
5739     return Res;
5740 
5741   // FIXME: We only do this after checking for min/max to prevent infinite
5742   // looping caused by a reverse canonicalization of these patterns for min/max.
5743   // FIXME: The organization of folds is a mess. These would naturally go into
5744   // canonicalizeCmpWithConstant(), but we can't move all of the above folds
5745   // down here after the min/max restriction.
5746   ICmpInst::Predicate Pred = I.getPredicate();
5747   const APInt *C;
5748   if (match(Op1, m_APInt(C))) {
5749     // For i32: x >u 2147483647 -> x <s 0  -> true if sign bit set
5750     if (Pred == ICmpInst::ICMP_UGT && C->isMaxSignedValue()) {
5751       Constant *Zero = Constant::getNullValue(Op0->getType());
5752       return new ICmpInst(ICmpInst::ICMP_SLT, Op0, Zero);
5753     }
5754 
5755     // For i32: x <u 2147483648 -> x >s -1  -> true if sign bit clear
5756     if (Pred == ICmpInst::ICMP_ULT && C->isMinSignedValue()) {
5757       Constant *AllOnes = Constant::getAllOnesValue(Op0->getType());
5758       return new ICmpInst(ICmpInst::ICMP_SGT, Op0, AllOnes);
5759     }
5760   }
5761 
5762   if (Instruction *Res = foldICmpInstWithConstant(I))
5763     return Res;
5764 
5765   // Try to match comparison as a sign bit test. Intentionally do this after
5766   // foldICmpInstWithConstant() to potentially let other folds to happen first.
5767   if (Instruction *New = foldSignBitTest(I))
5768     return New;
5769 
5770   if (Instruction *Res = foldICmpInstWithConstantNotInt(I))
5771     return Res;
5772 
5773   // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
5774   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
5775     if (Instruction *NI = foldGEPICmp(GEP, Op1, I.getPredicate(), I))
5776       return NI;
5777   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
5778     if (Instruction *NI = foldGEPICmp(GEP, Op0,
5779                            ICmpInst::getSwappedPredicate(I.getPredicate()), I))
5780       return NI;
5781 
5782   // Try to optimize equality comparisons against alloca-based pointers.
5783   if (Op0->getType()->isPointerTy() && I.isEquality()) {
5784     assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?");
5785     if (auto *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(Op0)))
5786       if (Instruction *New = foldAllocaCmp(I, Alloca, Op1))
5787         return New;
5788     if (auto *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(Op1)))
5789       if (Instruction *New = foldAllocaCmp(I, Alloca, Op0))
5790         return New;
5791   }
5792 
5793   if (Instruction *Res = foldICmpBitCast(I))
5794     return Res;
5795 
5796   // TODO: Hoist this above the min/max bailout.
5797   if (Instruction *R = foldICmpWithCastOp(I))
5798     return R;
5799 
5800   if (Instruction *Res = foldICmpWithMinMax(I))
5801     return Res;
5802 
5803   {
5804     Value *A, *B;
5805     // Transform (A & ~B) == 0 --> (A & B) != 0
5806     // and       (A & ~B) != 0 --> (A & B) == 0
5807     // if A is a power of 2.
5808     if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
5809         match(Op1, m_Zero()) &&
5810         isKnownToBeAPowerOfTwo(A, false, 0, &I) && I.isEquality())
5811       return new ICmpInst(I.getInversePredicate(), Builder.CreateAnd(A, B),
5812                           Op1);
5813 
5814     // ~X < ~Y --> Y < X
5815     // ~X < C -->  X > ~C
5816     if (match(Op0, m_Not(m_Value(A)))) {
5817       if (match(Op1, m_Not(m_Value(B))))
5818         return new ICmpInst(I.getPredicate(), B, A);
5819 
5820       const APInt *C;
5821       if (match(Op1, m_APInt(C)))
5822         return new ICmpInst(I.getSwappedPredicate(), A,
5823                             ConstantInt::get(Op1->getType(), ~(*C)));
5824     }
5825 
5826     Instruction *AddI = nullptr;
5827     if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
5828                                      m_Instruction(AddI))) &&
5829         isa<IntegerType>(A->getType())) {
5830       Value *Result;
5831       Constant *Overflow;
5832       // m_UAddWithOverflow can match patterns that do not include  an explicit
5833       // "add" instruction, so check the opcode of the matched op.
5834       if (AddI->getOpcode() == Instruction::Add &&
5835           OptimizeOverflowCheck(Instruction::Add, /*Signed*/ false, A, B, *AddI,
5836                                 Result, Overflow)) {
5837         replaceInstUsesWith(*AddI, Result);
5838         eraseInstFromFunction(*AddI);
5839         return replaceInstUsesWith(I, Overflow);
5840       }
5841     }
5842 
5843     // (zext a) * (zext b)  --> llvm.umul.with.overflow.
5844     if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
5845       if (Instruction *R = processUMulZExtIdiom(I, Op0, Op1, *this))
5846         return R;
5847     }
5848     if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
5849       if (Instruction *R = processUMulZExtIdiom(I, Op1, Op0, *this))
5850         return R;
5851     }
5852   }
5853 
5854   if (Instruction *Res = foldICmpEquality(I))
5855     return Res;
5856 
5857   if (Instruction *Res = foldICmpOfUAddOv(I))
5858     return Res;
5859 
5860   // The 'cmpxchg' instruction returns an aggregate containing the old value and
5861   // an i1 which indicates whether or not we successfully did the swap.
5862   //
5863   // Replace comparisons between the old value and the expected value with the
5864   // indicator that 'cmpxchg' returns.
5865   //
5866   // N.B.  This transform is only valid when the 'cmpxchg' is not permitted to
5867   // spuriously fail.  In those cases, the old value may equal the expected
5868   // value but it is possible for the swap to not occur.
5869   if (I.getPredicate() == ICmpInst::ICMP_EQ)
5870     if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
5871       if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
5872         if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
5873             !ACXI->isWeak())
5874           return ExtractValueInst::Create(ACXI, 1);
5875 
5876   {
5877     Value *X;
5878     const APInt *C;
5879     // icmp X+Cst, X
5880     if (match(Op0, m_Add(m_Value(X), m_APInt(C))) && Op1 == X)
5881       return foldICmpAddOpConst(X, *C, I.getPredicate());
5882 
5883     // icmp X, X+Cst
5884     if (match(Op1, m_Add(m_Value(X), m_APInt(C))) && Op0 == X)
5885       return foldICmpAddOpConst(X, *C, I.getSwappedPredicate());
5886   }
5887 
5888   if (Instruction *Res = foldICmpWithHighBitMask(I, Builder))
5889     return Res;
5890 
5891   if (I.getType()->isVectorTy())
5892     if (Instruction *Res = foldVectorCmp(I, Builder))
5893       return Res;
5894 
5895   return Changed ? &I : nullptr;
5896 }
5897 
5898 /// Fold fcmp ([us]itofp x, cst) if possible.
5899 Instruction *InstCombinerImpl::foldFCmpIntToFPConst(FCmpInst &I,
5900                                                     Instruction *LHSI,
5901                                                     Constant *RHSC) {
5902   if (!isa<ConstantFP>(RHSC)) return nullptr;
5903   const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
5904 
5905   // Get the width of the mantissa.  We don't want to hack on conversions that
5906   // might lose information from the integer, e.g. "i64 -> float"
5907   int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
5908   if (MantissaWidth == -1) return nullptr;  // Unknown.
5909 
5910   IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
5911 
5912   bool LHSUnsigned = isa<UIToFPInst>(LHSI);
5913 
5914   if (I.isEquality()) {
5915     FCmpInst::Predicate P = I.getPredicate();
5916     bool IsExact = false;
5917     APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
5918     RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
5919 
5920     // If the floating point constant isn't an integer value, we know if we will
5921     // ever compare equal / not equal to it.
5922     if (!IsExact) {
5923       // TODO: Can never be -0.0 and other non-representable values
5924       APFloat RHSRoundInt(RHS);
5925       RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
5926       if (RHS != RHSRoundInt) {
5927         if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
5928           return replaceInstUsesWith(I, Builder.getFalse());
5929 
5930         assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
5931         return replaceInstUsesWith(I, Builder.getTrue());
5932       }
5933     }
5934 
5935     // TODO: If the constant is exactly representable, is it always OK to do
5936     // equality compares as integer?
5937   }
5938 
5939   // Check to see that the input is converted from an integer type that is small
5940   // enough that preserves all bits.  TODO: check here for "known" sign bits.
5941   // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
5942   unsigned InputSize = IntTy->getScalarSizeInBits();
5943 
5944   // Following test does NOT adjust InputSize downwards for signed inputs,
5945   // because the most negative value still requires all the mantissa bits
5946   // to distinguish it from one less than that value.
5947   if ((int)InputSize > MantissaWidth) {
5948     // Conversion would lose accuracy. Check if loss can impact comparison.
5949     int Exp = ilogb(RHS);
5950     if (Exp == APFloat::IEK_Inf) {
5951       int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics()));
5952       if (MaxExponent < (int)InputSize - !LHSUnsigned)
5953         // Conversion could create infinity.
5954         return nullptr;
5955     } else {
5956       // Note that if RHS is zero or NaN, then Exp is negative
5957       // and first condition is trivially false.
5958       if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned)
5959         // Conversion could affect comparison.
5960         return nullptr;
5961     }
5962   }
5963 
5964   // Otherwise, we can potentially simplify the comparison.  We know that it
5965   // will always come through as an integer value and we know the constant is
5966   // not a NAN (it would have been previously simplified).
5967   assert(!RHS.isNaN() && "NaN comparison not already folded!");
5968 
5969   ICmpInst::Predicate Pred;
5970   switch (I.getPredicate()) {
5971   default: llvm_unreachable("Unexpected predicate!");
5972   case FCmpInst::FCMP_UEQ:
5973   case FCmpInst::FCMP_OEQ:
5974     Pred = ICmpInst::ICMP_EQ;
5975     break;
5976   case FCmpInst::FCMP_UGT:
5977   case FCmpInst::FCMP_OGT:
5978     Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
5979     break;
5980   case FCmpInst::FCMP_UGE:
5981   case FCmpInst::FCMP_OGE:
5982     Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
5983     break;
5984   case FCmpInst::FCMP_ULT:
5985   case FCmpInst::FCMP_OLT:
5986     Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
5987     break;
5988   case FCmpInst::FCMP_ULE:
5989   case FCmpInst::FCMP_OLE:
5990     Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
5991     break;
5992   case FCmpInst::FCMP_UNE:
5993   case FCmpInst::FCMP_ONE:
5994     Pred = ICmpInst::ICMP_NE;
5995     break;
5996   case FCmpInst::FCMP_ORD:
5997     return replaceInstUsesWith(I, Builder.getTrue());
5998   case FCmpInst::FCMP_UNO:
5999     return replaceInstUsesWith(I, Builder.getFalse());
6000   }
6001 
6002   // Now we know that the APFloat is a normal number, zero or inf.
6003 
6004   // See if the FP constant is too large for the integer.  For example,
6005   // comparing an i8 to 300.0.
6006   unsigned IntWidth = IntTy->getScalarSizeInBits();
6007 
6008   if (!LHSUnsigned) {
6009     // If the RHS value is > SignedMax, fold the comparison.  This handles +INF
6010     // and large values.
6011     APFloat SMax(RHS.getSemantics());
6012     SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
6013                           APFloat::rmNearestTiesToEven);
6014     if (SMax < RHS) { // smax < 13123.0
6015       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_SLT ||
6016           Pred == ICmpInst::ICMP_SLE)
6017         return replaceInstUsesWith(I, Builder.getTrue());
6018       return replaceInstUsesWith(I, Builder.getFalse());
6019     }
6020   } else {
6021     // If the RHS value is > UnsignedMax, fold the comparison. This handles
6022     // +INF and large values.
6023     APFloat UMax(RHS.getSemantics());
6024     UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
6025                           APFloat::rmNearestTiesToEven);
6026     if (UMax < RHS) { // umax < 13123.0
6027       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_ULT ||
6028           Pred == ICmpInst::ICMP_ULE)
6029         return replaceInstUsesWith(I, Builder.getTrue());
6030       return replaceInstUsesWith(I, Builder.getFalse());
6031     }
6032   }
6033 
6034   if (!LHSUnsigned) {
6035     // See if the RHS value is < SignedMin.
6036     APFloat SMin(RHS.getSemantics());
6037     SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
6038                           APFloat::rmNearestTiesToEven);
6039     if (SMin > RHS) { // smin > 12312.0
6040       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
6041           Pred == ICmpInst::ICMP_SGE)
6042         return replaceInstUsesWith(I, Builder.getTrue());
6043       return replaceInstUsesWith(I, Builder.getFalse());
6044     }
6045   } else {
6046     // See if the RHS value is < UnsignedMin.
6047     APFloat UMin(RHS.getSemantics());
6048     UMin.convertFromAPInt(APInt::getMinValue(IntWidth), false,
6049                           APFloat::rmNearestTiesToEven);
6050     if (UMin > RHS) { // umin > 12312.0
6051       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
6052           Pred == ICmpInst::ICMP_UGE)
6053         return replaceInstUsesWith(I, Builder.getTrue());
6054       return replaceInstUsesWith(I, Builder.getFalse());
6055     }
6056   }
6057 
6058   // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
6059   // [0, UMAX], but it may still be fractional.  See if it is fractional by
6060   // casting the FP value to the integer value and back, checking for equality.
6061   // Don't do this for zero, because -0.0 is not fractional.
6062   Constant *RHSInt = LHSUnsigned
6063     ? ConstantExpr::getFPToUI(RHSC, IntTy)
6064     : ConstantExpr::getFPToSI(RHSC, IntTy);
6065   if (!RHS.isZero()) {
6066     bool Equal = LHSUnsigned
6067       ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
6068       : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
6069     if (!Equal) {
6070       // If we had a comparison against a fractional value, we have to adjust
6071       // the compare predicate and sometimes the value.  RHSC is rounded towards
6072       // zero at this point.
6073       switch (Pred) {
6074       default: llvm_unreachable("Unexpected integer comparison!");
6075       case ICmpInst::ICMP_NE:  // (float)int != 4.4   --> true
6076         return replaceInstUsesWith(I, Builder.getTrue());
6077       case ICmpInst::ICMP_EQ:  // (float)int == 4.4   --> false
6078         return replaceInstUsesWith(I, Builder.getFalse());
6079       case ICmpInst::ICMP_ULE:
6080         // (float)int <= 4.4   --> int <= 4
6081         // (float)int <= -4.4  --> false
6082         if (RHS.isNegative())
6083           return replaceInstUsesWith(I, Builder.getFalse());
6084         break;
6085       case ICmpInst::ICMP_SLE:
6086         // (float)int <= 4.4   --> int <= 4
6087         // (float)int <= -4.4  --> int < -4
6088         if (RHS.isNegative())
6089           Pred = ICmpInst::ICMP_SLT;
6090         break;
6091       case ICmpInst::ICMP_ULT:
6092         // (float)int < -4.4   --> false
6093         // (float)int < 4.4    --> int <= 4
6094         if (RHS.isNegative())
6095           return replaceInstUsesWith(I, Builder.getFalse());
6096         Pred = ICmpInst::ICMP_ULE;
6097         break;
6098       case ICmpInst::ICMP_SLT:
6099         // (float)int < -4.4   --> int < -4
6100         // (float)int < 4.4    --> int <= 4
6101         if (!RHS.isNegative())
6102           Pred = ICmpInst::ICMP_SLE;
6103         break;
6104       case ICmpInst::ICMP_UGT:
6105         // (float)int > 4.4    --> int > 4
6106         // (float)int > -4.4   --> true
6107         if (RHS.isNegative())
6108           return replaceInstUsesWith(I, Builder.getTrue());
6109         break;
6110       case ICmpInst::ICMP_SGT:
6111         // (float)int > 4.4    --> int > 4
6112         // (float)int > -4.4   --> int >= -4
6113         if (RHS.isNegative())
6114           Pred = ICmpInst::ICMP_SGE;
6115         break;
6116       case ICmpInst::ICMP_UGE:
6117         // (float)int >= -4.4   --> true
6118         // (float)int >= 4.4    --> int > 4
6119         if (RHS.isNegative())
6120           return replaceInstUsesWith(I, Builder.getTrue());
6121         Pred = ICmpInst::ICMP_UGT;
6122         break;
6123       case ICmpInst::ICMP_SGE:
6124         // (float)int >= -4.4   --> int >= -4
6125         // (float)int >= 4.4    --> int > 4
6126         if (!RHS.isNegative())
6127           Pred = ICmpInst::ICMP_SGT;
6128         break;
6129       }
6130     }
6131   }
6132 
6133   // Lower this FP comparison into an appropriate integer version of the
6134   // comparison.
6135   return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
6136 }
6137 
6138 /// Fold (C / X) < 0.0 --> X < 0.0 if possible. Swap predicate if necessary.
6139 static Instruction *foldFCmpReciprocalAndZero(FCmpInst &I, Instruction *LHSI,
6140                                               Constant *RHSC) {
6141   // When C is not 0.0 and infinities are not allowed:
6142   // (C / X) < 0.0 is a sign-bit test of X
6143   // (C / X) < 0.0 --> X < 0.0 (if C is positive)
6144   // (C / X) < 0.0 --> X > 0.0 (if C is negative, swap the predicate)
6145   //
6146   // Proof:
6147   // Multiply (C / X) < 0.0 by X * X / C.
6148   // - X is non zero, if it is the flag 'ninf' is violated.
6149   // - C defines the sign of X * X * C. Thus it also defines whether to swap
6150   //   the predicate. C is also non zero by definition.
6151   //
6152   // Thus X * X / C is non zero and the transformation is valid. [qed]
6153 
6154   FCmpInst::Predicate Pred = I.getPredicate();
6155 
6156   // Check that predicates are valid.
6157   if ((Pred != FCmpInst::FCMP_OGT) && (Pred != FCmpInst::FCMP_OLT) &&
6158       (Pred != FCmpInst::FCMP_OGE) && (Pred != FCmpInst::FCMP_OLE))
6159     return nullptr;
6160 
6161   // Check that RHS operand is zero.
6162   if (!match(RHSC, m_AnyZeroFP()))
6163     return nullptr;
6164 
6165   // Check fastmath flags ('ninf').
6166   if (!LHSI->hasNoInfs() || !I.hasNoInfs())
6167     return nullptr;
6168 
6169   // Check the properties of the dividend. It must not be zero to avoid a
6170   // division by zero (see Proof).
6171   const APFloat *C;
6172   if (!match(LHSI->getOperand(0), m_APFloat(C)))
6173     return nullptr;
6174 
6175   if (C->isZero())
6176     return nullptr;
6177 
6178   // Get swapped predicate if necessary.
6179   if (C->isNegative())
6180     Pred = I.getSwappedPredicate();
6181 
6182   return new FCmpInst(Pred, LHSI->getOperand(1), RHSC, "", &I);
6183 }
6184 
6185 /// Optimize fabs(X) compared with zero.
6186 static Instruction *foldFabsWithFcmpZero(FCmpInst &I, InstCombinerImpl &IC) {
6187   Value *X;
6188   if (!match(I.getOperand(0), m_FAbs(m_Value(X))) ||
6189       !match(I.getOperand(1), m_PosZeroFP()))
6190     return nullptr;
6191 
6192   auto replacePredAndOp0 = [&IC](FCmpInst *I, FCmpInst::Predicate P, Value *X) {
6193     I->setPredicate(P);
6194     return IC.replaceOperand(*I, 0, X);
6195   };
6196 
6197   switch (I.getPredicate()) {
6198   case FCmpInst::FCMP_UGE:
6199   case FCmpInst::FCMP_OLT:
6200     // fabs(X) >= 0.0 --> true
6201     // fabs(X) <  0.0 --> false
6202     llvm_unreachable("fcmp should have simplified");
6203 
6204   case FCmpInst::FCMP_OGT:
6205     // fabs(X) > 0.0 --> X != 0.0
6206     return replacePredAndOp0(&I, FCmpInst::FCMP_ONE, X);
6207 
6208   case FCmpInst::FCMP_UGT:
6209     // fabs(X) u> 0.0 --> X u!= 0.0
6210     return replacePredAndOp0(&I, FCmpInst::FCMP_UNE, X);
6211 
6212   case FCmpInst::FCMP_OLE:
6213     // fabs(X) <= 0.0 --> X == 0.0
6214     return replacePredAndOp0(&I, FCmpInst::FCMP_OEQ, X);
6215 
6216   case FCmpInst::FCMP_ULE:
6217     // fabs(X) u<= 0.0 --> X u== 0.0
6218     return replacePredAndOp0(&I, FCmpInst::FCMP_UEQ, X);
6219 
6220   case FCmpInst::FCMP_OGE:
6221     // fabs(X) >= 0.0 --> !isnan(X)
6222     assert(!I.hasNoNaNs() && "fcmp should have simplified");
6223     return replacePredAndOp0(&I, FCmpInst::FCMP_ORD, X);
6224 
6225   case FCmpInst::FCMP_ULT:
6226     // fabs(X) u< 0.0 --> isnan(X)
6227     assert(!I.hasNoNaNs() && "fcmp should have simplified");
6228     return replacePredAndOp0(&I, FCmpInst::FCMP_UNO, X);
6229 
6230   case FCmpInst::FCMP_OEQ:
6231   case FCmpInst::FCMP_UEQ:
6232   case FCmpInst::FCMP_ONE:
6233   case FCmpInst::FCMP_UNE:
6234   case FCmpInst::FCMP_ORD:
6235   case FCmpInst::FCMP_UNO:
6236     // Look through the fabs() because it doesn't change anything but the sign.
6237     // fabs(X) == 0.0 --> X == 0.0,
6238     // fabs(X) != 0.0 --> X != 0.0
6239     // isnan(fabs(X)) --> isnan(X)
6240     // !isnan(fabs(X) --> !isnan(X)
6241     return replacePredAndOp0(&I, I.getPredicate(), X);
6242 
6243   default:
6244     return nullptr;
6245   }
6246 }
6247 
6248 Instruction *InstCombinerImpl::visitFCmpInst(FCmpInst &I) {
6249   bool Changed = false;
6250 
6251   /// Orders the operands of the compare so that they are listed from most
6252   /// complex to least complex.  This puts constants before unary operators,
6253   /// before binary operators.
6254   if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
6255     I.swapOperands();
6256     Changed = true;
6257   }
6258 
6259   const CmpInst::Predicate Pred = I.getPredicate();
6260   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
6261   if (Value *V = SimplifyFCmpInst(Pred, Op0, Op1, I.getFastMathFlags(),
6262                                   SQ.getWithInstruction(&I)))
6263     return replaceInstUsesWith(I, V);
6264 
6265   // Simplify 'fcmp pred X, X'
6266   Type *OpType = Op0->getType();
6267   assert(OpType == Op1->getType() && "fcmp with different-typed operands?");
6268   if (Op0 == Op1) {
6269     switch (Pred) {
6270       default: break;
6271     case FCmpInst::FCMP_UNO:    // True if unordered: isnan(X) | isnan(Y)
6272     case FCmpInst::FCMP_ULT:    // True if unordered or less than
6273     case FCmpInst::FCMP_UGT:    // True if unordered or greater than
6274     case FCmpInst::FCMP_UNE:    // True if unordered or not equal
6275       // Canonicalize these to be 'fcmp uno %X, 0.0'.
6276       I.setPredicate(FCmpInst::FCMP_UNO);
6277       I.setOperand(1, Constant::getNullValue(OpType));
6278       return &I;
6279 
6280     case FCmpInst::FCMP_ORD:    // True if ordered (no nans)
6281     case FCmpInst::FCMP_OEQ:    // True if ordered and equal
6282     case FCmpInst::FCMP_OGE:    // True if ordered and greater than or equal
6283     case FCmpInst::FCMP_OLE:    // True if ordered and less than or equal
6284       // Canonicalize these to be 'fcmp ord %X, 0.0'.
6285       I.setPredicate(FCmpInst::FCMP_ORD);
6286       I.setOperand(1, Constant::getNullValue(OpType));
6287       return &I;
6288     }
6289   }
6290 
6291   // If we're just checking for a NaN (ORD/UNO) and have a non-NaN operand,
6292   // then canonicalize the operand to 0.0.
6293   if (Pred == CmpInst::FCMP_ORD || Pred == CmpInst::FCMP_UNO) {
6294     if (!match(Op0, m_PosZeroFP()) && isKnownNeverNaN(Op0, &TLI))
6295       return replaceOperand(I, 0, ConstantFP::getNullValue(OpType));
6296 
6297     if (!match(Op1, m_PosZeroFP()) && isKnownNeverNaN(Op1, &TLI))
6298       return replaceOperand(I, 1, ConstantFP::getNullValue(OpType));
6299   }
6300 
6301   // fcmp pred (fneg X), (fneg Y) -> fcmp swap(pred) X, Y
6302   Value *X, *Y;
6303   if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
6304     return new FCmpInst(I.getSwappedPredicate(), X, Y, "", &I);
6305 
6306   // Test if the FCmpInst instruction is used exclusively by a select as
6307   // part of a minimum or maximum operation. If so, refrain from doing
6308   // any other folding. This helps out other analyses which understand
6309   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
6310   // and CodeGen. And in this case, at least one of the comparison
6311   // operands has at least one user besides the compare (the select),
6312   // which would often largely negate the benefit of folding anyway.
6313   if (I.hasOneUse())
6314     if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) {
6315       Value *A, *B;
6316       SelectPatternResult SPR = matchSelectPattern(SI, A, B);
6317       if (SPR.Flavor != SPF_UNKNOWN)
6318         return nullptr;
6319     }
6320 
6321   // The sign of 0.0 is ignored by fcmp, so canonicalize to +0.0:
6322   // fcmp Pred X, -0.0 --> fcmp Pred X, 0.0
6323   if (match(Op1, m_AnyZeroFP()) && !match(Op1, m_PosZeroFP()))
6324     return replaceOperand(I, 1, ConstantFP::getNullValue(OpType));
6325 
6326   // Handle fcmp with instruction LHS and constant RHS.
6327   Instruction *LHSI;
6328   Constant *RHSC;
6329   if (match(Op0, m_Instruction(LHSI)) && match(Op1, m_Constant(RHSC))) {
6330     switch (LHSI->getOpcode()) {
6331     case Instruction::PHI:
6332       // Only fold fcmp into the PHI if the phi and fcmp are in the same
6333       // block.  If in the same block, we're encouraging jump threading.  If
6334       // not, we are just pessimizing the code by making an i1 phi.
6335       if (LHSI->getParent() == I.getParent())
6336         if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI)))
6337           return NV;
6338       break;
6339     case Instruction::SIToFP:
6340     case Instruction::UIToFP:
6341       if (Instruction *NV = foldFCmpIntToFPConst(I, LHSI, RHSC))
6342         return NV;
6343       break;
6344     case Instruction::FDiv:
6345       if (Instruction *NV = foldFCmpReciprocalAndZero(I, LHSI, RHSC))
6346         return NV;
6347       break;
6348     case Instruction::Load:
6349       if (auto *GEP = dyn_cast<GetElementPtrInst>(LHSI->getOperand(0)))
6350         if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
6351           if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
6352               !cast<LoadInst>(LHSI)->isVolatile())
6353             if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
6354               return Res;
6355       break;
6356   }
6357   }
6358 
6359   if (Instruction *R = foldFabsWithFcmpZero(I, *this))
6360     return R;
6361 
6362   if (match(Op0, m_FNeg(m_Value(X)))) {
6363     // fcmp pred (fneg X), C --> fcmp swap(pred) X, -C
6364     Constant *C;
6365     if (match(Op1, m_Constant(C))) {
6366       Constant *NegC = ConstantExpr::getFNeg(C);
6367       return new FCmpInst(I.getSwappedPredicate(), X, NegC, "", &I);
6368     }
6369   }
6370 
6371   if (match(Op0, m_FPExt(m_Value(X)))) {
6372     // fcmp (fpext X), (fpext Y) -> fcmp X, Y
6373     if (match(Op1, m_FPExt(m_Value(Y))) && X->getType() == Y->getType())
6374       return new FCmpInst(Pred, X, Y, "", &I);
6375 
6376     // fcmp (fpext X), C -> fcmp X, (fptrunc C) if fptrunc is lossless
6377     const APFloat *C;
6378     if (match(Op1, m_APFloat(C))) {
6379       const fltSemantics &FPSem =
6380           X->getType()->getScalarType()->getFltSemantics();
6381       bool Lossy;
6382       APFloat TruncC = *C;
6383       TruncC.convert(FPSem, APFloat::rmNearestTiesToEven, &Lossy);
6384 
6385       // Avoid lossy conversions and denormals.
6386       // Zero is a special case that's OK to convert.
6387       APFloat Fabs = TruncC;
6388       Fabs.clearSign();
6389       if (!Lossy &&
6390           (!(Fabs < APFloat::getSmallestNormalized(FPSem)) || Fabs.isZero())) {
6391         Constant *NewC = ConstantFP::get(X->getType(), TruncC);
6392         return new FCmpInst(Pred, X, NewC, "", &I);
6393       }
6394     }
6395   }
6396 
6397   // Convert a sign-bit test of an FP value into a cast and integer compare.
6398   // TODO: Simplify if the copysign constant is 0.0 or NaN.
6399   // TODO: Handle non-zero compare constants.
6400   // TODO: Handle other predicates.
6401   const APFloat *C;
6402   if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::copysign>(m_APFloat(C),
6403                                                            m_Value(X)))) &&
6404       match(Op1, m_AnyZeroFP()) && !C->isZero() && !C->isNaN()) {
6405     Type *IntType = Builder.getIntNTy(X->getType()->getScalarSizeInBits());
6406     if (auto *VecTy = dyn_cast<VectorType>(OpType))
6407       IntType = VectorType::get(IntType, VecTy->getElementCount());
6408 
6409     // copysign(non-zero constant, X) < 0.0 --> (bitcast X) < 0
6410     if (Pred == FCmpInst::FCMP_OLT) {
6411       Value *IntX = Builder.CreateBitCast(X, IntType);
6412       return new ICmpInst(ICmpInst::ICMP_SLT, IntX,
6413                           ConstantInt::getNullValue(IntType));
6414     }
6415   }
6416 
6417   if (I.getType()->isVectorTy())
6418     if (Instruction *Res = foldVectorCmp(I, Builder))
6419       return Res;
6420 
6421   return Changed ? &I : nullptr;
6422 }
6423