1 //===- InstCombineCompares.cpp --------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the visitICmp and visitFCmp functions.
12 //===----------------------------------------------------------------------===//
14 #include "InstCombine.h"
15 #include "llvm/Analysis/ConstantFolding.h"
16 #include "llvm/Analysis/InstructionSimplify.h"
17 #include "llvm/Analysis/MemoryBuiltins.h"
18 #include "llvm/IR/ConstantRange.h"
19 #include "llvm/IR/DataLayout.h"
20 #include "llvm/IR/GetElementPtrTypeIterator.h"
21 #include "llvm/IR/IntrinsicInst.h"
22 #include "llvm/IR/PatternMatch.h"
23 #include "llvm/Target/TargetLibraryInfo.h"
25 using namespace PatternMatch;
27 #define DEBUG_TYPE "instcombine"
29 static ConstantInt *getOne(Constant *C) {
30 return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
33 static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
34 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
37 static bool HasAddOverflow(ConstantInt *Result,
38 ConstantInt *In1, ConstantInt *In2,
41 return Result->getValue().ult(In1->getValue());
43 if (In2->isNegative())
44 return Result->getValue().sgt(In1->getValue());
45 return Result->getValue().slt(In1->getValue());
48 /// AddWithOverflow - Compute Result = In1+In2, returning true if the result
49 /// overflowed for this type.
50 static bool AddWithOverflow(Constant *&Result, Constant *In1,
51 Constant *In2, bool IsSigned = false) {
52 Result = ConstantExpr::getAdd(In1, In2);
54 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
55 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
56 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
57 if (HasAddOverflow(ExtractElement(Result, Idx),
58 ExtractElement(In1, Idx),
59 ExtractElement(In2, Idx),
66 return HasAddOverflow(cast<ConstantInt>(Result),
67 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
71 static bool HasSubOverflow(ConstantInt *Result,
72 ConstantInt *In1, ConstantInt *In2,
75 return Result->getValue().ugt(In1->getValue());
77 if (In2->isNegative())
78 return Result->getValue().slt(In1->getValue());
80 return Result->getValue().sgt(In1->getValue());
83 /// SubWithOverflow - Compute Result = In1-In2, returning true if the result
84 /// overflowed for this type.
85 static bool SubWithOverflow(Constant *&Result, Constant *In1,
86 Constant *In2, bool IsSigned = false) {
87 Result = ConstantExpr::getSub(In1, In2);
89 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
90 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
91 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
92 if (HasSubOverflow(ExtractElement(Result, Idx),
93 ExtractElement(In1, Idx),
94 ExtractElement(In2, Idx),
101 return HasSubOverflow(cast<ConstantInt>(Result),
102 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
106 /// isSignBitCheck - Given an exploded icmp instruction, return true if the
107 /// comparison only checks the sign bit. If it only checks the sign bit, set
108 /// TrueIfSigned if the result of the comparison is true when the input value is
110 static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
111 bool &TrueIfSigned) {
113 case ICmpInst::ICMP_SLT: // True if LHS s< 0
115 return RHS->isZero();
116 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
118 return RHS->isAllOnesValue();
119 case ICmpInst::ICMP_SGT: // True if LHS s> -1
120 TrueIfSigned = false;
121 return RHS->isAllOnesValue();
122 case ICmpInst::ICMP_UGT:
123 // True if LHS u> RHS and RHS == high-bit-mask - 1
125 return RHS->isMaxValue(true);
126 case ICmpInst::ICMP_UGE:
127 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
129 return RHS->getValue().isSignBit();
135 /// Returns true if the exploded icmp can be expressed as a signed comparison
136 /// to zero and updates the predicate accordingly.
137 /// The signedness of the comparison is preserved.
138 static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
139 if (!ICmpInst::isSigned(pred))
143 return ICmpInst::isRelational(pred);
146 if (pred == ICmpInst::ICMP_SLT) {
147 pred = ICmpInst::ICMP_SLE;
150 } else if (RHS->isAllOnesValue()) {
151 if (pred == ICmpInst::ICMP_SGT) {
152 pred = ICmpInst::ICMP_SGE;
160 // isHighOnes - Return true if the constant is of the form 1+0+.
161 // This is the same as lowones(~X).
162 static bool isHighOnes(const ConstantInt *CI) {
163 return (~CI->getValue() + 1).isPowerOf2();
166 /// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
167 /// set of known zero and one bits, compute the maximum and minimum values that
168 /// could have the specified known zero and known one bits, returning them in
170 static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
171 const APInt& KnownOne,
172 APInt& Min, APInt& Max) {
173 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
174 KnownZero.getBitWidth() == Min.getBitWidth() &&
175 KnownZero.getBitWidth() == Max.getBitWidth() &&
176 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
177 APInt UnknownBits = ~(KnownZero|KnownOne);
179 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
180 // bit if it is unknown.
182 Max = KnownOne|UnknownBits;
184 if (UnknownBits.isNegative()) { // Sign bit is unknown
185 Min.setBit(Min.getBitWidth()-1);
186 Max.clearBit(Max.getBitWidth()-1);
190 // ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
191 // a set of known zero and one bits, compute the maximum and minimum values that
192 // could have the specified known zero and known one bits, returning them in
194 static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
195 const APInt &KnownOne,
196 APInt &Min, APInt &Max) {
197 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
198 KnownZero.getBitWidth() == Min.getBitWidth() &&
199 KnownZero.getBitWidth() == Max.getBitWidth() &&
200 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
201 APInt UnknownBits = ~(KnownZero|KnownOne);
203 // The minimum value is when the unknown bits are all zeros.
205 // The maximum value is when the unknown bits are all ones.
206 Max = KnownOne|UnknownBits;
211 /// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
212 /// cmp pred (load (gep GV, ...)), cmpcst
213 /// where GV is a global variable with a constant initializer. Try to simplify
214 /// this into some simple computation that does not need the load. For example
215 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
217 /// If AndCst is non-null, then the loaded value is masked with that constant
218 /// before doing the comparison. This handles cases like "A[i]&4 == 0".
219 Instruction *InstCombiner::
220 FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
221 CmpInst &ICI, ConstantInt *AndCst) {
222 // We need TD information to know the pointer size unless this is inbounds.
223 if (!GEP->isInBounds() && !DL)
226 Constant *Init = GV->getInitializer();
227 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
230 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
231 if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays.
233 // There are many forms of this optimization we can handle, for now, just do
234 // the simple index into a single-dimensional array.
236 // Require: GEP GV, 0, i {{, constant indices}}
237 if (GEP->getNumOperands() < 3 ||
238 !isa<ConstantInt>(GEP->getOperand(1)) ||
239 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
240 isa<Constant>(GEP->getOperand(2)))
243 // Check that indices after the variable are constants and in-range for the
244 // type they index. Collect the indices. This is typically for arrays of
246 SmallVector<unsigned, 4> LaterIndices;
248 Type *EltTy = Init->getType()->getArrayElementType();
249 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
250 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
251 if (!Idx) return nullptr; // Variable index.
253 uint64_t IdxVal = Idx->getZExtValue();
254 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
256 if (StructType *STy = dyn_cast<StructType>(EltTy))
257 EltTy = STy->getElementType(IdxVal);
258 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
259 if (IdxVal >= ATy->getNumElements()) return nullptr;
260 EltTy = ATy->getElementType();
262 return nullptr; // Unknown type.
265 LaterIndices.push_back(IdxVal);
268 enum { Overdefined = -3, Undefined = -2 };
270 // Variables for our state machines.
272 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
273 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
274 // and 87 is the second (and last) index. FirstTrueElement is -2 when
275 // undefined, otherwise set to the first true element. SecondTrueElement is
276 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
277 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
279 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
280 // form "i != 47 & i != 87". Same state transitions as for true elements.
281 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
283 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
284 /// define a state machine that triggers for ranges of values that the index
285 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
286 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
287 /// index in the range (inclusive). We use -2 for undefined here because we
288 /// use relative comparisons and don't want 0-1 to match -1.
289 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
291 // MagicBitvector - This is a magic bitvector where we set a bit if the
292 // comparison is true for element 'i'. If there are 64 elements or less in
293 // the array, this will fully represent all the comparison results.
294 uint64_t MagicBitvector = 0;
297 // Scan the array and see if one of our patterns matches.
298 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
299 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
300 Constant *Elt = Init->getAggregateElement(i);
301 if (!Elt) return nullptr;
303 // If this is indexing an array of structures, get the structure element.
304 if (!LaterIndices.empty())
305 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
307 // If the element is masked, handle it.
308 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
310 // Find out if the comparison would be true or false for the i'th element.
311 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
312 CompareRHS, DL, TLI);
313 // If the result is undef for this element, ignore it.
314 if (isa<UndefValue>(C)) {
315 // Extend range state machines to cover this element in case there is an
316 // undef in the middle of the range.
317 if (TrueRangeEnd == (int)i-1)
319 if (FalseRangeEnd == (int)i-1)
324 // If we can't compute the result for any of the elements, we have to give
325 // up evaluating the entire conditional.
326 if (!isa<ConstantInt>(C)) return nullptr;
328 // Otherwise, we know if the comparison is true or false for this element,
329 // update our state machines.
330 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
332 // State machine for single/double/range index comparison.
334 // Update the TrueElement state machine.
335 if (FirstTrueElement == Undefined)
336 FirstTrueElement = TrueRangeEnd = i; // First true element.
338 // Update double-compare state machine.
339 if (SecondTrueElement == Undefined)
340 SecondTrueElement = i;
342 SecondTrueElement = Overdefined;
344 // Update range state machine.
345 if (TrueRangeEnd == (int)i-1)
348 TrueRangeEnd = Overdefined;
351 // Update the FalseElement state machine.
352 if (FirstFalseElement == Undefined)
353 FirstFalseElement = FalseRangeEnd = i; // First false element.
355 // Update double-compare state machine.
356 if (SecondFalseElement == Undefined)
357 SecondFalseElement = i;
359 SecondFalseElement = Overdefined;
361 // Update range state machine.
362 if (FalseRangeEnd == (int)i-1)
365 FalseRangeEnd = Overdefined;
370 // If this element is in range, update our magic bitvector.
371 if (i < 64 && IsTrueForElt)
372 MagicBitvector |= 1ULL << i;
374 // If all of our states become overdefined, bail out early. Since the
375 // predicate is expensive, only check it every 8 elements. This is only
376 // really useful for really huge arrays.
377 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
378 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
379 FalseRangeEnd == Overdefined)
383 // Now that we've scanned the entire array, emit our new comparison(s). We
384 // order the state machines in complexity of the generated code.
385 Value *Idx = GEP->getOperand(2);
387 // If the index is larger than the pointer size of the target, truncate the
388 // index down like the GEP would do implicitly. We don't have to do this for
389 // an inbounds GEP because the index can't be out of range.
390 if (!GEP->isInBounds()) {
391 Type *IntPtrTy = DL->getIntPtrType(GEP->getType());
392 unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
393 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
394 Idx = Builder->CreateTrunc(Idx, IntPtrTy);
397 // If the comparison is only true for one or two elements, emit direct
399 if (SecondTrueElement != Overdefined) {
400 // None true -> false.
401 if (FirstTrueElement == Undefined)
402 return ReplaceInstUsesWith(ICI, Builder->getFalse());
404 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
406 // True for one element -> 'i == 47'.
407 if (SecondTrueElement == Undefined)
408 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
410 // True for two elements -> 'i == 47 | i == 72'.
411 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
412 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
413 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
414 return BinaryOperator::CreateOr(C1, C2);
417 // If the comparison is only false for one or two elements, emit direct
419 if (SecondFalseElement != Overdefined) {
420 // None false -> true.
421 if (FirstFalseElement == Undefined)
422 return ReplaceInstUsesWith(ICI, Builder->getTrue());
424 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
426 // False for one element -> 'i != 47'.
427 if (SecondFalseElement == Undefined)
428 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
430 // False for two elements -> 'i != 47 & i != 72'.
431 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
432 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
433 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
434 return BinaryOperator::CreateAnd(C1, C2);
437 // If the comparison can be replaced with a range comparison for the elements
438 // where it is true, emit the range check.
439 if (TrueRangeEnd != Overdefined) {
440 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
442 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
443 if (FirstTrueElement) {
444 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
445 Idx = Builder->CreateAdd(Idx, Offs);
448 Value *End = ConstantInt::get(Idx->getType(),
449 TrueRangeEnd-FirstTrueElement+1);
450 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
453 // False range check.
454 if (FalseRangeEnd != Overdefined) {
455 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
456 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
457 if (FirstFalseElement) {
458 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
459 Idx = Builder->CreateAdd(Idx, Offs);
462 Value *End = ConstantInt::get(Idx->getType(),
463 FalseRangeEnd-FirstFalseElement);
464 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
468 // If a magic bitvector captures the entire comparison state
469 // of this load, replace it with computation that does:
470 // ((magic_cst >> i) & 1) != 0
474 // Look for an appropriate type:
475 // - The type of Idx if the magic fits
476 // - The smallest fitting legal type if we have a DataLayout
478 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
481 Ty = DL->getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
482 else if (ArrayElementCount <= 32)
483 Ty = Type::getInt32Ty(Init->getContext());
486 Value *V = Builder->CreateIntCast(Idx, Ty, false);
487 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
488 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
489 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
497 /// EvaluateGEPOffsetExpression - Return a value that can be used to compare
498 /// the *offset* implied by a GEP to zero. For example, if we have &A[i], we
499 /// want to return 'i' for "icmp ne i, 0". Note that, in general, indices can
500 /// be complex, and scales are involved. The above expression would also be
501 /// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
502 /// This later form is less amenable to optimization though, and we are allowed
503 /// to generate the first by knowing that pointer arithmetic doesn't overflow.
505 /// If we can't emit an optimized form for this expression, this returns null.
507 static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC) {
508 const DataLayout &DL = *IC.getDataLayout();
509 gep_type_iterator GTI = gep_type_begin(GEP);
511 // Check to see if this gep only has a single variable index. If so, and if
512 // any constant indices are a multiple of its scale, then we can compute this
513 // in terms of the scale of the variable index. For example, if the GEP
514 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
515 // because the expression will cross zero at the same point.
516 unsigned i, e = GEP->getNumOperands();
518 for (i = 1; i != e; ++i, ++GTI) {
519 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
520 // Compute the aggregate offset of constant indices.
521 if (CI->isZero()) continue;
523 // Handle a struct index, which adds its field offset to the pointer.
524 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
525 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
527 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
528 Offset += Size*CI->getSExtValue();
531 // Found our variable index.
536 // If there are no variable indices, we must have a constant offset, just
537 // evaluate it the general way.
538 if (i == e) return nullptr;
540 Value *VariableIdx = GEP->getOperand(i);
541 // Determine the scale factor of the variable element. For example, this is
542 // 4 if the variable index is into an array of i32.
543 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
545 // Verify that there are no other variable indices. If so, emit the hard way.
546 for (++i, ++GTI; i != e; ++i, ++GTI) {
547 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
548 if (!CI) return nullptr;
550 // Compute the aggregate offset of constant indices.
551 if (CI->isZero()) continue;
553 // Handle a struct index, which adds its field offset to the pointer.
554 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
555 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
557 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
558 Offset += Size*CI->getSExtValue();
564 // Okay, we know we have a single variable index, which must be a
565 // pointer/array/vector index. If there is no offset, life is simple, return
567 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
568 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
570 // Cast to intptrty in case a truncation occurs. If an extension is needed,
571 // we don't need to bother extending: the extension won't affect where the
572 // computation crosses zero.
573 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
574 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
579 // Otherwise, there is an index. The computation we will do will be modulo
580 // the pointer size, so get it.
581 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
583 Offset &= PtrSizeMask;
584 VariableScale &= PtrSizeMask;
586 // To do this transformation, any constant index must be a multiple of the
587 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
588 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
589 // multiple of the variable scale.
590 int64_t NewOffs = Offset / (int64_t)VariableScale;
591 if (Offset != NewOffs*(int64_t)VariableScale)
594 // Okay, we can do this evaluation. Start by converting the index to intptr.
595 if (VariableIdx->getType() != IntPtrTy)
596 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
598 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
599 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
602 /// FoldGEPICmp - Fold comparisons between a GEP instruction and something
603 /// else. At this point we know that the GEP is on the LHS of the comparison.
604 Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
605 ICmpInst::Predicate Cond,
607 // Don't transform signed compares of GEPs into index compares. Even if the
608 // GEP is inbounds, the final add of the base pointer can have signed overflow
609 // and would change the result of the icmp.
610 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
611 // the maximum signed value for the pointer type.
612 if (ICmpInst::isSigned(Cond))
615 // Look through bitcasts and addrspacecasts. We do not however want to remove
617 if (!isa<GetElementPtrInst>(RHS))
618 RHS = RHS->stripPointerCasts();
620 Value *PtrBase = GEPLHS->getOperand(0);
621 if (DL && PtrBase == RHS && GEPLHS->isInBounds()) {
622 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
623 // This transformation (ignoring the base and scales) is valid because we
624 // know pointers can't overflow since the gep is inbounds. See if we can
625 // output an optimized form.
626 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this);
628 // If not, synthesize the offset the hard way.
630 Offset = EmitGEPOffset(GEPLHS);
631 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
632 Constant::getNullValue(Offset->getType()));
633 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
634 // If the base pointers are different, but the indices are the same, just
635 // compare the base pointer.
636 if (PtrBase != GEPRHS->getOperand(0)) {
637 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
638 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
639 GEPRHS->getOperand(0)->getType();
641 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
642 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
643 IndicesTheSame = false;
647 // If all indices are the same, just compare the base pointers.
649 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
651 // If we're comparing GEPs with two base pointers that only differ in type
652 // and both GEPs have only constant indices or just one use, then fold
653 // the compare with the adjusted indices.
654 if (DL && GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
655 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
656 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
657 PtrBase->stripPointerCasts() ==
658 GEPRHS->getOperand(0)->stripPointerCasts()) {
659 Value *LOffset = EmitGEPOffset(GEPLHS);
660 Value *ROffset = EmitGEPOffset(GEPRHS);
662 // If we looked through an addrspacecast between different sized address
663 // spaces, the LHS and RHS pointers are different sized
664 // integers. Truncate to the smaller one.
665 Type *LHSIndexTy = LOffset->getType();
666 Type *RHSIndexTy = ROffset->getType();
667 if (LHSIndexTy != RHSIndexTy) {
668 if (LHSIndexTy->getPrimitiveSizeInBits() <
669 RHSIndexTy->getPrimitiveSizeInBits()) {
670 ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy);
672 LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy);
675 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
677 return ReplaceInstUsesWith(I, Cmp);
680 // Otherwise, the base pointers are different and the indices are
681 // different, bail out.
685 // If one of the GEPs has all zero indices, recurse.
686 if (GEPLHS->hasAllZeroIndices())
687 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
688 ICmpInst::getSwappedPredicate(Cond), I);
690 // If the other GEP has all zero indices, recurse.
691 if (GEPRHS->hasAllZeroIndices())
692 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
694 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
695 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
696 // If the GEPs only differ by one index, compare it.
697 unsigned NumDifferences = 0; // Keep track of # differences.
698 unsigned DiffOperand = 0; // The operand that differs.
699 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
700 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
701 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
702 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
703 // Irreconcilable differences.
707 if (NumDifferences++) break;
712 if (NumDifferences == 0) // SAME GEP?
713 return ReplaceInstUsesWith(I, // No comparison is needed here.
714 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
716 else if (NumDifferences == 1 && GEPsInBounds) {
717 Value *LHSV = GEPLHS->getOperand(DiffOperand);
718 Value *RHSV = GEPRHS->getOperand(DiffOperand);
719 // Make sure we do a signed comparison here.
720 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
724 // Only lower this if the icmp is the only user of the GEP or if we expect
725 // the result to fold to a constant!
728 (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
729 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
730 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
731 Value *L = EmitGEPOffset(GEPLHS);
732 Value *R = EmitGEPOffset(GEPRHS);
733 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
739 /// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
740 Instruction *InstCombiner::FoldICmpAddOpCst(Instruction &ICI,
741 Value *X, ConstantInt *CI,
742 ICmpInst::Predicate Pred) {
743 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
744 // so the values can never be equal. Similarly for all other "or equals"
747 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
748 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
749 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
750 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
752 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
753 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
756 // (X+1) >u X --> X <u (0-1) --> X != 255
757 // (X+2) >u X --> X <u (0-2) --> X <u 254
758 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
759 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
760 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
762 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
763 ConstantInt *SMax = ConstantInt::get(X->getContext(),
764 APInt::getSignedMaxValue(BitWidth));
766 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
767 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
768 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
769 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
770 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
771 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
772 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
773 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
775 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
776 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
777 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
778 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
779 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
780 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
782 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
783 Constant *C = Builder->getInt(CI->getValue()-1);
784 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
787 /// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
788 /// and CmpRHS are both known to be integer constants.
789 Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
790 ConstantInt *DivRHS) {
791 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
792 const APInt &CmpRHSV = CmpRHS->getValue();
794 // FIXME: If the operand types don't match the type of the divide
795 // then don't attempt this transform. The code below doesn't have the
796 // logic to deal with a signed divide and an unsigned compare (and
797 // vice versa). This is because (x /s C1) <s C2 produces different
798 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
799 // (x /u C1) <u C2. Simply casting the operands and result won't
800 // work. :( The if statement below tests that condition and bails
802 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
803 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
805 if (DivRHS->isZero())
806 return nullptr; // The ProdOV computation fails on divide by zero.
807 if (DivIsSigned && DivRHS->isAllOnesValue())
808 return nullptr; // The overflow computation also screws up here
809 if (DivRHS->isOne()) {
810 // This eliminates some funny cases with INT_MIN.
811 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
815 // Compute Prod = CI * DivRHS. We are essentially solving an equation
816 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
817 // C2 (CI). By solving for X we can turn this into a range check
818 // instead of computing a divide.
819 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
821 // Determine if the product overflows by seeing if the product is
822 // not equal to the divide. Make sure we do the same kind of divide
823 // as in the LHS instruction that we're folding.
824 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
825 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
827 // Get the ICmp opcode
828 ICmpInst::Predicate Pred = ICI.getPredicate();
830 /// If the division is known to be exact, then there is no remainder from the
831 /// divide, so the covered range size is unit, otherwise it is the divisor.
832 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
834 // Figure out the interval that is being checked. For example, a comparison
835 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
836 // Compute this interval based on the constants involved and the signedness of
837 // the compare/divide. This computes a half-open interval, keeping track of
838 // whether either value in the interval overflows. After analysis each
839 // overflow variable is set to 0 if it's corresponding bound variable is valid
840 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
841 int LoOverflow = 0, HiOverflow = 0;
842 Constant *LoBound = nullptr, *HiBound = nullptr;
844 if (!DivIsSigned) { // udiv
845 // e.g. X/5 op 3 --> [15, 20)
847 HiOverflow = LoOverflow = ProdOV;
849 // If this is not an exact divide, then many values in the range collapse
850 // to the same result value.
851 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
854 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
855 if (CmpRHSV == 0) { // (X / pos) op 0
856 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
857 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
859 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
860 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
861 HiOverflow = LoOverflow = ProdOV;
863 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
864 } else { // (X / pos) op neg
865 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
866 HiBound = AddOne(Prod);
867 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
869 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
870 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
873 } else if (DivRHS->isNegative()) { // Divisor is < 0.
875 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
876 if (CmpRHSV == 0) { // (X / neg) op 0
877 // e.g. X/-5 op 0 --> [-4, 5)
878 LoBound = AddOne(RangeSize);
879 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
880 if (HiBound == DivRHS) { // -INTMIN = INTMIN
881 HiOverflow = 1; // [INTMIN+1, overflow)
882 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN
884 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
885 // e.g. X/-5 op 3 --> [-19, -14)
886 HiBound = AddOne(Prod);
887 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
889 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
890 } else { // (X / neg) op neg
891 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
892 LoOverflow = HiOverflow = ProdOV;
894 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
897 // Dividing by a negative swaps the condition. LT <-> GT
898 Pred = ICmpInst::getSwappedPredicate(Pred);
901 Value *X = DivI->getOperand(0);
903 default: llvm_unreachable("Unhandled icmp opcode!");
904 case ICmpInst::ICMP_EQ:
905 if (LoOverflow && HiOverflow)
906 return ReplaceInstUsesWith(ICI, Builder->getFalse());
908 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
909 ICmpInst::ICMP_UGE, X, LoBound);
911 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
912 ICmpInst::ICMP_ULT, X, HiBound);
913 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
915 case ICmpInst::ICMP_NE:
916 if (LoOverflow && HiOverflow)
917 return ReplaceInstUsesWith(ICI, Builder->getTrue());
919 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
920 ICmpInst::ICMP_ULT, X, LoBound);
922 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
923 ICmpInst::ICMP_UGE, X, HiBound);
924 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
925 DivIsSigned, false));
926 case ICmpInst::ICMP_ULT:
927 case ICmpInst::ICMP_SLT:
928 if (LoOverflow == +1) // Low bound is greater than input range.
929 return ReplaceInstUsesWith(ICI, Builder->getTrue());
930 if (LoOverflow == -1) // Low bound is less than input range.
931 return ReplaceInstUsesWith(ICI, Builder->getFalse());
932 return new ICmpInst(Pred, X, LoBound);
933 case ICmpInst::ICMP_UGT:
934 case ICmpInst::ICMP_SGT:
935 if (HiOverflow == +1) // High bound greater than input range.
936 return ReplaceInstUsesWith(ICI, Builder->getFalse());
937 if (HiOverflow == -1) // High bound less than input range.
938 return ReplaceInstUsesWith(ICI, Builder->getTrue());
939 if (Pred == ICmpInst::ICMP_UGT)
940 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
941 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
945 /// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
946 Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
947 ConstantInt *ShAmt) {
948 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
950 // Check that the shift amount is in range. If not, don't perform
951 // undefined shifts. When the shift is visited it will be
953 uint32_t TypeBits = CmpRHSV.getBitWidth();
954 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
955 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
958 if (!ICI.isEquality()) {
959 // If we have an unsigned comparison and an ashr, we can't simplify this.
960 // Similarly for signed comparisons with lshr.
961 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
964 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
965 // by a power of 2. Since we already have logic to simplify these,
966 // transform to div and then simplify the resultant comparison.
967 if (Shr->getOpcode() == Instruction::AShr &&
968 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
971 // Revisit the shift (to delete it).
975 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
978 Shr->getOpcode() == Instruction::AShr ?
979 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
980 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
982 ICI.setOperand(0, Tmp);
984 // If the builder folded the binop, just return it.
985 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
989 // Otherwise, fold this div/compare.
990 assert(TheDiv->getOpcode() == Instruction::SDiv ||
991 TheDiv->getOpcode() == Instruction::UDiv);
993 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
994 assert(Res && "This div/cst should have folded!");
999 // If we are comparing against bits always shifted out, the
1000 // comparison cannot succeed.
1001 APInt Comp = CmpRHSV << ShAmtVal;
1002 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
1003 if (Shr->getOpcode() == Instruction::LShr)
1004 Comp = Comp.lshr(ShAmtVal);
1006 Comp = Comp.ashr(ShAmtVal);
1008 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1009 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1010 Constant *Cst = Builder->getInt1(IsICMP_NE);
1011 return ReplaceInstUsesWith(ICI, Cst);
1014 // Otherwise, check to see if the bits shifted out are known to be zero.
1015 // If so, we can compare against the unshifted value:
1016 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
1017 if (Shr->hasOneUse() && Shr->isExact())
1018 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
1020 if (Shr->hasOneUse()) {
1021 // Otherwise strength reduce the shift into an and.
1022 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
1023 Constant *Mask = Builder->getInt(Val);
1025 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1026 Mask, Shr->getName()+".mask");
1027 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1032 /// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
1033 /// (icmp eq/ne A, Log2(const2/const1)) ->
1034 /// (icmp eq/ne A, Log2(const2) - Log2(const1)).
1035 Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
1038 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1040 auto getConstant = [&I, this](bool IsTrue) {
1041 if (I.getPredicate() == I.ICMP_NE)
1043 return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1046 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1047 if (I.getPredicate() == I.ICMP_NE)
1048 Pred = CmpInst::getInversePredicate(Pred);
1049 return new ICmpInst(Pred, LHS, RHS);
1052 APInt AP1 = CI1->getValue();
1053 APInt AP2 = CI2->getValue();
1057 // Both Constants are 0.
1058 return getConstant(true);
1061 if (cast<BinaryOperator>(Op)->isExact())
1062 return getConstant(false);
1064 if (AP2.isNegative()) {
1065 // MSB is set, so a lshr with a large enough 'A' would be undefined.
1066 return getConstant(false);
1069 // 'A' must be large enough to shift out the highest set bit.
1070 return getICmp(I.ICMP_UGT, A,
1071 ConstantInt::get(A->getType(), AP2.logBase2()));
1075 // Shifting 0 by any value gives 0.
1076 return getConstant(false);
1079 bool IsAShr = isa<AShrOperator>(Op);
1081 if (AP1.isAllOnesValue() && IsAShr) {
1082 // Arithmatic shift of -1 is always -1.
1083 return getConstant(true);
1085 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1088 bool IsNegative = false;
1090 if (AP1.isNegative() != AP2.isNegative()) {
1091 // Arithmetic shift will never change the sign.
1092 return getConstant(false);
1094 // Both the constants are negative, take their positive to calculate log.
1095 if (AP1.isNegative()) {
1097 // Right-shifting won't increase the magnitude.
1098 return getConstant(false);
1103 if (!IsNegative && AP1.ugt(AP2))
1104 // Right-shifting will not increase the value.
1105 return getConstant(false);
1107 // Get the distance between the highest bit that's set.
1110 Shift = (-AP2).logBase2() - (-AP1).logBase2();
1112 Shift = AP2.logBase2() - AP1.logBase2();
1114 if (IsAShr ? AP1 == AP2.ashr(Shift) : AP1 == AP2.lshr(Shift))
1115 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1117 // Shifting const2 will never be equal to const1.
1118 return getConstant(false);
1121 /// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1123 Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1126 const APInt &RHSV = RHS->getValue();
1128 switch (LHSI->getOpcode()) {
1129 case Instruction::Trunc:
1130 if (ICI.isEquality() && LHSI->hasOneUse()) {
1131 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1132 // of the high bits truncated out of x are known.
1133 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1134 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
1135 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
1136 computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne, 0, &ICI);
1138 // If all the high bits are known, we can do this xform.
1139 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1140 // Pull in the high bits from known-ones set.
1141 APInt NewRHS = RHS->getValue().zext(SrcBits);
1142 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
1143 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1144 Builder->getInt(NewRHS));
1149 case Instruction::Xor: // (icmp pred (xor X, XorCst), CI)
1150 if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1151 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1153 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1154 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1155 Value *CompareVal = LHSI->getOperand(0);
1157 // If the sign bit of the XorCst is not set, there is no change to
1158 // the operation, just stop using the Xor.
1159 if (!XorCst->isNegative()) {
1160 ICI.setOperand(0, CompareVal);
1165 // Was the old condition true if the operand is positive?
1166 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
1168 // If so, the new one isn't.
1169 isTrueIfPositive ^= true;
1171 if (isTrueIfPositive)
1172 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1175 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1179 if (LHSI->hasOneUse()) {
1180 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
1181 if (!ICI.isEquality() && XorCst->getValue().isSignBit()) {
1182 const APInt &SignBit = XorCst->getValue();
1183 ICmpInst::Predicate Pred = ICI.isSigned()
1184 ? ICI.getUnsignedPredicate()
1185 : ICI.getSignedPredicate();
1186 return new ICmpInst(Pred, LHSI->getOperand(0),
1187 Builder->getInt(RHSV ^ SignBit));
1190 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
1191 if (!ICI.isEquality() && XorCst->isMaxValue(true)) {
1192 const APInt &NotSignBit = XorCst->getValue();
1193 ICmpInst::Predicate Pred = ICI.isSigned()
1194 ? ICI.getUnsignedPredicate()
1195 : ICI.getSignedPredicate();
1196 Pred = ICI.getSwappedPredicate(Pred);
1197 return new ICmpInst(Pred, LHSI->getOperand(0),
1198 Builder->getInt(RHSV ^ NotSignBit));
1202 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1203 // iff -C is a power of 2
1204 if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
1205 XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1206 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst);
1208 // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1209 // iff -C is a power of 2
1210 if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
1211 XorCst->getValue() == -RHSV && RHSV.isPowerOf2())
1212 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst);
1215 case Instruction::And: // (icmp pred (and X, AndCst), RHS)
1216 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1217 LHSI->getOperand(0)->hasOneUse()) {
1218 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
1220 // If the LHS is an AND of a truncating cast, we can widen the
1221 // and/compare to be the input width without changing the value
1222 // produced, eliminating a cast.
1223 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1224 // We can do this transformation if either the AND constant does not
1225 // have its sign bit set or if it is an equality comparison.
1226 // Extending a relational comparison when we're checking the sign
1227 // bit would not work.
1228 if (ICI.isEquality() ||
1229 (!AndCst->isNegative() && RHSV.isNonNegative())) {
1231 Builder->CreateAnd(Cast->getOperand(0),
1232 ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
1233 NewAnd->takeName(LHSI);
1234 return new ICmpInst(ICI.getPredicate(), NewAnd,
1235 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
1239 // If the LHS is an AND of a zext, and we have an equality compare, we can
1240 // shrink the and/compare to the smaller type, eliminating the cast.
1241 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
1242 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
1243 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1244 // should fold the icmp to true/false in that case.
1245 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1247 Builder->CreateAnd(Cast->getOperand(0),
1248 ConstantExpr::getTrunc(AndCst, Ty));
1249 NewAnd->takeName(LHSI);
1250 return new ICmpInst(ICI.getPredicate(), NewAnd,
1251 ConstantExpr::getTrunc(RHS, Ty));
1255 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1256 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1257 // happens a LOT in code produced by the C front-end, for bitfield
1259 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1260 if (Shift && !Shift->isShift())
1264 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
1266 // This seemingly simple opportunity to fold away a shift turns out to
1267 // be rather complicated. See PR17827
1268 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
1270 bool CanFold = false;
1271 unsigned ShiftOpcode = Shift->getOpcode();
1272 if (ShiftOpcode == Instruction::AShr) {
1273 // There may be some constraints that make this possible,
1274 // but nothing simple has been discovered yet.
1276 } else if (ShiftOpcode == Instruction::Shl) {
1277 // For a left shift, we can fold if the comparison is not signed.
1278 // We can also fold a signed comparison if the mask value and
1279 // comparison value are not negative. These constraints may not be
1280 // obvious, but we can prove that they are correct using an SMT
1282 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
1284 } else if (ShiftOpcode == Instruction::LShr) {
1285 // For a logical right shift, we can fold if the comparison is not
1286 // signed. We can also fold a signed comparison if the shifted mask
1287 // value and the shifted comparison value are not negative.
1288 // These constraints may not be obvious, but we can prove that they
1289 // are correct using an SMT solver.
1290 if (!ICI.isSigned())
1293 ConstantInt *ShiftedAndCst =
1294 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1295 ConstantInt *ShiftedRHSCst =
1296 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1298 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1305 if (ShiftOpcode == Instruction::Shl)
1306 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1308 NewCst = ConstantExpr::getShl(RHS, ShAmt);
1310 // Check to see if we are shifting out any of the bits being
1312 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
1313 // If we shifted bits out, the fold is not going to work out.
1314 // As a special case, check to see if this means that the
1315 // result is always true or false now.
1316 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1317 return ReplaceInstUsesWith(ICI, Builder->getFalse());
1318 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
1319 return ReplaceInstUsesWith(ICI, Builder->getTrue());
1321 ICI.setOperand(1, NewCst);
1322 Constant *NewAndCst;
1323 if (ShiftOpcode == Instruction::Shl)
1324 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
1326 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1327 LHSI->setOperand(1, NewAndCst);
1328 LHSI->setOperand(0, Shift->getOperand(0));
1329 Worklist.Add(Shift); // Shift is dead.
1335 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1336 // preferable because it allows the C<<Y expression to be hoisted out
1337 // of a loop if Y is invariant and X is not.
1338 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1339 ICI.isEquality() && !Shift->isArithmeticShift() &&
1340 !isa<Constant>(Shift->getOperand(0))) {
1343 if (Shift->getOpcode() == Instruction::LShr) {
1344 NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
1346 // Insert a logical shift.
1347 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
1350 // Compute X & (C << Y).
1352 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
1354 ICI.setOperand(0, NewAnd);
1358 // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1359 // (icmp pred (and X, (or (shl 1, Y), 1), 0))
1361 // iff pred isn't signed
1363 Value *X, *Y, *LShr;
1364 if (!ICI.isSigned() && RHSV == 0) {
1365 if (match(LHSI->getOperand(1), m_One())) {
1366 Constant *One = cast<Constant>(LHSI->getOperand(1));
1367 Value *Or = LHSI->getOperand(0);
1368 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1369 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1370 unsigned UsesRemoved = 0;
1371 if (LHSI->hasOneUse())
1373 if (Or->hasOneUse())
1375 if (LShr->hasOneUse())
1377 Value *NewOr = nullptr;
1378 // Compute X & ((1 << Y) | 1)
1379 if (auto *C = dyn_cast<Constant>(Y)) {
1380 if (UsesRemoved >= 1)
1382 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1384 if (UsesRemoved >= 3)
1385 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1388 One, Or->getName());
1391 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1392 ICI.setOperand(0, NewAnd);
1400 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1401 // bit set in (X & AndCst) will produce a result greater than RHSV.
1402 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
1403 unsigned NTZ = AndCst->getValue().countTrailingZeros();
1404 if ((NTZ < AndCst->getBitWidth()) &&
1405 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV))
1406 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1407 Constant::getNullValue(RHS->getType()));
1411 // Try to optimize things like "A[i]&42 == 0" to index computations.
1412 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1413 if (GetElementPtrInst *GEP =
1414 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1415 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1416 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1417 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1418 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1419 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1424 // X & -C == -C -> X > u ~C
1425 // X & -C != -C -> X <= u ~C
1426 // iff C is a power of 2
1427 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1428 return new ICmpInst(
1429 ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1430 : ICmpInst::ICMP_ULE,
1431 LHSI->getOperand(0), SubOne(RHS));
1434 case Instruction::Or: {
1435 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1438 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1439 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1440 // -> and (icmp eq P, null), (icmp eq Q, null).
1441 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1442 Constant::getNullValue(P->getType()));
1443 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1444 Constant::getNullValue(Q->getType()));
1446 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1447 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1449 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1455 case Instruction::Mul: { // (icmp pred (mul X, Val), CI)
1456 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1459 // If this is a signed comparison to 0 and the mul is sign preserving,
1460 // use the mul LHS operand instead.
1461 ICmpInst::Predicate pred = ICI.getPredicate();
1462 if (isSignTest(pred, RHS) && !Val->isZero() &&
1463 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1464 return new ICmpInst(Val->isNegative() ?
1465 ICmpInst::getSwappedPredicate(pred) : pred,
1466 LHSI->getOperand(0),
1467 Constant::getNullValue(RHS->getType()));
1472 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
1473 uint32_t TypeBits = RHSV.getBitWidth();
1474 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1477 // (1 << X) pred P2 -> X pred Log2(P2)
1478 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1479 bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1480 ICmpInst::Predicate Pred = ICI.getPredicate();
1481 if (ICI.isUnsigned()) {
1482 if (!RHSVIsPowerOf2) {
1483 // (1 << X) < 30 -> X <= 4
1484 // (1 << X) <= 30 -> X <= 4
1485 // (1 << X) >= 30 -> X > 4
1486 // (1 << X) > 30 -> X > 4
1487 if (Pred == ICmpInst::ICMP_ULT)
1488 Pred = ICmpInst::ICMP_ULE;
1489 else if (Pred == ICmpInst::ICMP_UGE)
1490 Pred = ICmpInst::ICMP_UGT;
1492 unsigned RHSLog2 = RHSV.logBase2();
1494 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
1495 // (1 << X) < 2147483648 -> X < 31 -> X != 31
1496 if (RHSLog2 == TypeBits-1) {
1497 if (Pred == ICmpInst::ICMP_UGE)
1498 Pred = ICmpInst::ICMP_EQ;
1499 else if (Pred == ICmpInst::ICMP_ULT)
1500 Pred = ICmpInst::ICMP_NE;
1503 return new ICmpInst(Pred, X,
1504 ConstantInt::get(RHS->getType(), RHSLog2));
1505 } else if (ICI.isSigned()) {
1506 if (RHSV.isAllOnesValue()) {
1507 // (1 << X) <= -1 -> X == 31
1508 if (Pred == ICmpInst::ICMP_SLE)
1509 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1510 ConstantInt::get(RHS->getType(), TypeBits-1));
1512 // (1 << X) > -1 -> X != 31
1513 if (Pred == ICmpInst::ICMP_SGT)
1514 return new ICmpInst(ICmpInst::ICMP_NE, X,
1515 ConstantInt::get(RHS->getType(), TypeBits-1));
1517 // (1 << X) < 0 -> X == 31
1518 // (1 << X) <= 0 -> X == 31
1519 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1520 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1521 ConstantInt::get(RHS->getType(), TypeBits-1));
1523 // (1 << X) >= 0 -> X != 31
1524 // (1 << X) > 0 -> X != 31
1525 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1526 return new ICmpInst(ICmpInst::ICMP_NE, X,
1527 ConstantInt::get(RHS->getType(), TypeBits-1));
1529 } else if (ICI.isEquality()) {
1531 return new ICmpInst(
1532 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
1538 // Check that the shift amount is in range. If not, don't perform
1539 // undefined shifts. When the shift is visited it will be
1541 if (ShAmt->uge(TypeBits))
1544 if (ICI.isEquality()) {
1545 // If we are comparing against bits always shifted out, the
1546 // comparison cannot succeed.
1548 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1550 if (Comp != RHS) {// Comparing against a bit that we know is zero.
1551 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1552 Constant *Cst = Builder->getInt1(IsICMP_NE);
1553 return ReplaceInstUsesWith(ICI, Cst);
1556 // If the shift is NUW, then it is just shifting out zeros, no need for an
1558 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1559 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1560 ConstantExpr::getLShr(RHS, ShAmt));
1562 // If the shift is NSW and we compare to 0, then it is just shifting out
1563 // sign bits, no need for an AND either.
1564 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
1565 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1566 ConstantExpr::getLShr(RHS, ShAmt));
1568 if (LHSI->hasOneUse()) {
1569 // Otherwise strength reduce the shift into an and.
1570 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
1571 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
1572 TypeBits - ShAmtVal));
1575 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1576 return new ICmpInst(ICI.getPredicate(), And,
1577 ConstantExpr::getLShr(RHS, ShAmt));
1581 // If this is a signed comparison to 0 and the shift is sign preserving,
1582 // use the shift LHS operand instead.
1583 ICmpInst::Predicate pred = ICI.getPredicate();
1584 if (isSignTest(pred, RHS) &&
1585 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1586 return new ICmpInst(pred,
1587 LHSI->getOperand(0),
1588 Constant::getNullValue(RHS->getType()));
1590 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1591 bool TrueIfSigned = false;
1592 if (LHSI->hasOneUse() &&
1593 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1594 // (X << 31) <s 0 --> (X&1) != 0
1595 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
1596 APInt::getOneBitSet(TypeBits,
1597 TypeBits-ShAmt->getZExtValue()-1));
1599 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1600 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1601 And, Constant::getNullValue(And->getType()));
1604 // Transform (icmp pred iM (shl iM %v, N), CI)
1605 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1606 // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
1607 // This enables to get rid of the shift in favor of a trunc which can be
1608 // free on the target. It has the additional benefit of comparing to a
1609 // smaller constant, which will be target friendly.
1610 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
1611 if (LHSI->hasOneUse() &&
1612 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
1613 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1614 Constant *NCI = ConstantExpr::getTrunc(
1615 ConstantExpr::getAShr(RHS,
1616 ConstantInt::get(RHS->getType(), Amt)),
1618 return new ICmpInst(ICI.getPredicate(),
1619 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
1626 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
1627 case Instruction::AShr: {
1628 // Handle equality comparisons of shift-by-constant.
1629 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1630 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1631 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
1635 // Handle exact shr's.
1636 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1637 if (RHSV.isMinValue())
1638 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1643 case Instruction::SDiv:
1644 case Instruction::UDiv:
1645 // Fold: icmp pred ([us]div X, C1), C2 -> range test
1646 // Fold this div into the comparison, producing a range check.
1647 // Determine, based on the divide type, what the range is being
1648 // checked. If there is an overflow on the low or high side, remember
1649 // it, otherwise compute the range [low, hi) bounding the new value.
1650 // See: InsertRangeTest above for the kinds of replacements possible.
1651 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1652 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1657 case Instruction::Sub: {
1658 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
1660 const APInt &LHSV = LHSC->getValue();
1662 // C1-X <u C2 -> (X|(C2-1)) == C1
1663 // iff C1 & (C2-1) == C2-1
1664 // C2 is a power of 2
1665 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1666 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
1667 return new ICmpInst(ICmpInst::ICMP_EQ,
1668 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
1671 // C1-X >u C2 -> (X|C2) != C1
1672 // iff C1 & C2 == C2
1673 // C2+1 is a power of 2
1674 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1675 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
1676 return new ICmpInst(ICmpInst::ICMP_NE,
1677 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
1681 case Instruction::Add:
1682 // Fold: icmp pred (add X, C1), C2
1683 if (!ICI.isEquality()) {
1684 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1686 const APInt &LHSV = LHSC->getValue();
1688 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1691 if (ICI.isSigned()) {
1692 if (CR.getLower().isSignBit()) {
1693 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
1694 Builder->getInt(CR.getUpper()));
1695 } else if (CR.getUpper().isSignBit()) {
1696 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
1697 Builder->getInt(CR.getLower()));
1700 if (CR.getLower().isMinValue()) {
1701 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
1702 Builder->getInt(CR.getUpper()));
1703 } else if (CR.getUpper().isMinValue()) {
1704 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
1705 Builder->getInt(CR.getLower()));
1709 // X-C1 <u C2 -> (X & -C2) == C1
1710 // iff C1 & (C2-1) == 0
1711 // C2 is a power of 2
1712 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1713 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
1714 return new ICmpInst(ICmpInst::ICMP_EQ,
1715 Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
1716 ConstantExpr::getNeg(LHSC));
1718 // X-C1 >u C2 -> (X & ~C2) != C1
1720 // C2+1 is a power of 2
1721 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1722 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
1723 return new ICmpInst(ICmpInst::ICMP_NE,
1724 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
1725 ConstantExpr::getNeg(LHSC));
1730 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1731 if (ICI.isEquality()) {
1732 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1734 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
1735 // the second operand is a constant, simplify a bit.
1736 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1737 switch (BO->getOpcode()) {
1738 case Instruction::SRem:
1739 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1740 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1741 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
1742 if (V.sgt(1) && V.isPowerOf2()) {
1744 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1746 return new ICmpInst(ICI.getPredicate(), NewRem,
1747 Constant::getNullValue(BO->getType()));
1751 case Instruction::Add:
1752 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1753 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1754 if (BO->hasOneUse())
1755 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1756 ConstantExpr::getSub(RHS, BOp1C));
1757 } else if (RHSV == 0) {
1758 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1759 // efficiently invertible, or if the add has just this one use.
1760 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
1762 if (Value *NegVal = dyn_castNegVal(BOp1))
1763 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
1764 if (Value *NegVal = dyn_castNegVal(BOp0))
1765 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
1766 if (BO->hasOneUse()) {
1767 Value *Neg = Builder->CreateNeg(BOp1);
1769 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1773 case Instruction::Xor:
1774 // For the xor case, we can xor two constants together, eliminating
1775 // the explicit xor.
1776 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1777 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1778 ConstantExpr::getXor(RHS, BOC));
1779 } else if (RHSV == 0) {
1780 // Replace ((xor A, B) != 0) with (A != B)
1781 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1785 case Instruction::Sub:
1786 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1787 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1788 if (BO->hasOneUse())
1789 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1790 ConstantExpr::getSub(BOp0C, RHS));
1791 } else if (RHSV == 0) {
1792 // Replace ((sub A, B) != 0) with (A != B)
1793 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1797 case Instruction::Or:
1798 // If bits are being or'd in that are not present in the constant we
1799 // are comparing against, then the comparison could never succeed!
1800 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1801 Constant *NotCI = ConstantExpr::getNot(RHS);
1802 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
1803 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
1807 case Instruction::And:
1808 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1809 // If bits are being compared against that are and'd out, then the
1810 // comparison can never succeed!
1811 if ((RHSV & ~BOC->getValue()) != 0)
1812 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
1814 // If we have ((X & C) == C), turn it into ((X & C) != 0).
1815 if (RHS == BOC && RHSV.isPowerOf2())
1816 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1817 ICmpInst::ICMP_NE, LHSI,
1818 Constant::getNullValue(RHS->getType()));
1820 // Don't perform the following transforms if the AND has multiple uses
1821 if (!BO->hasOneUse())
1824 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1825 if (BOC->getValue().isSignBit()) {
1826 Value *X = BO->getOperand(0);
1827 Constant *Zero = Constant::getNullValue(X->getType());
1828 ICmpInst::Predicate pred = isICMP_NE ?
1829 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1830 return new ICmpInst(pred, X, Zero);
1833 // ((X & ~7) == 0) --> X < 8
1834 if (RHSV == 0 && isHighOnes(BOC)) {
1835 Value *X = BO->getOperand(0);
1836 Constant *NegX = ConstantExpr::getNeg(BOC);
1837 ICmpInst::Predicate pred = isICMP_NE ?
1838 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1839 return new ICmpInst(pred, X, NegX);
1843 case Instruction::Mul:
1844 if (RHSV == 0 && BO->hasNoSignedWrap()) {
1845 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1846 // The trivial case (mul X, 0) is handled by InstSimplify
1847 // General case : (mul X, C) != 0 iff X != 0
1848 // (mul X, C) == 0 iff X == 0
1850 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1851 Constant::getNullValue(RHS->getType()));
1857 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1858 // Handle icmp {eq|ne} <intrinsic>, intcst.
1859 switch (II->getIntrinsicID()) {
1860 case Intrinsic::bswap:
1862 ICI.setOperand(0, II->getArgOperand(0));
1863 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
1865 case Intrinsic::ctlz:
1866 case Intrinsic::cttz:
1867 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
1868 if (RHSV == RHS->getType()->getBitWidth()) {
1870 ICI.setOperand(0, II->getArgOperand(0));
1871 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1875 case Intrinsic::ctpop:
1876 // popcount(A) == 0 -> A == 0 and likewise for !=
1877 if (RHS->isZero()) {
1879 ICI.setOperand(0, II->getArgOperand(0));
1880 ICI.setOperand(1, RHS);
1892 /// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1893 /// We only handle extending casts so far.
1895 Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1896 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1897 Value *LHSCIOp = LHSCI->getOperand(0);
1898 Type *SrcTy = LHSCIOp->getType();
1899 Type *DestTy = LHSCI->getType();
1902 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
1903 // integer type is the same size as the pointer type.
1904 if (DL && LHSCI->getOpcode() == Instruction::PtrToInt &&
1905 DL->getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
1906 Value *RHSOp = nullptr;
1907 if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) {
1908 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
1909 } else if (PtrToIntInst *RHSC = dyn_cast<PtrToIntInst>(ICI.getOperand(1))) {
1910 RHSOp = RHSC->getOperand(0);
1911 // If the pointer types don't match, insert a bitcast.
1912 if (LHSCIOp->getType() != RHSOp->getType())
1913 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1917 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1920 // The code below only handles extension cast instructions, so far.
1922 if (LHSCI->getOpcode() != Instruction::ZExt &&
1923 LHSCI->getOpcode() != Instruction::SExt)
1926 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1927 bool isSignedCmp = ICI.isSigned();
1929 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1930 // Not an extension from the same type?
1931 RHSCIOp = CI->getOperand(0);
1932 if (RHSCIOp->getType() != LHSCIOp->getType())
1935 // If the signedness of the two casts doesn't agree (i.e. one is a sext
1936 // and the other is a zext), then we can't handle this.
1937 if (CI->getOpcode() != LHSCI->getOpcode())
1940 // Deal with equality cases early.
1941 if (ICI.isEquality())
1942 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1944 // A signed comparison of sign extended values simplifies into a
1945 // signed comparison.
1946 if (isSignedCmp && isSignedExt)
1947 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1949 // The other three cases all fold into an unsigned comparison.
1950 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1953 // If we aren't dealing with a constant on the RHS, exit early
1954 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1958 // Compute the constant that would happen if we truncated to SrcTy then
1959 // reextended to DestTy.
1960 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1961 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
1964 // If the re-extended constant didn't change...
1966 // Deal with equality cases early.
1967 if (ICI.isEquality())
1968 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1970 // A signed comparison of sign extended values simplifies into a
1971 // signed comparison.
1972 if (isSignedExt && isSignedCmp)
1973 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1975 // The other three cases all fold into an unsigned comparison.
1976 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
1979 // The re-extended constant changed so the constant cannot be represented
1980 // in the shorter type. Consequently, we cannot emit a simple comparison.
1981 // All the cases that fold to true or false will have already been handled
1982 // by SimplifyICmpInst, so only deal with the tricky case.
1984 if (isSignedCmp || !isSignedExt)
1987 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
1988 // should have been folded away previously and not enter in here.
1990 // We're performing an unsigned comp with a sign extended value.
1991 // This is true if the input is >= 0. [aka >s -1]
1992 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
1993 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
1995 // Finally, return the value computed.
1996 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
1997 return ReplaceInstUsesWith(ICI, Result);
1999 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
2000 return BinaryOperator::CreateNot(Result);
2003 /// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
2004 /// I = icmp ugt (add (add A, B), CI2), CI1
2005 /// If this is of the form:
2007 /// if (sum+128 >u 255)
2008 /// Then replace it with llvm.sadd.with.overflow.i8.
2010 static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2011 ConstantInt *CI2, ConstantInt *CI1,
2013 // The transformation we're trying to do here is to transform this into an
2014 // llvm.sadd.with.overflow. To do this, we have to replace the original add
2015 // with a narrower add, and discard the add-with-constant that is part of the
2016 // range check (if we can't eliminate it, this isn't profitable).
2018 // In order to eliminate the add-with-constant, the compare can be its only
2020 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
2021 if (!AddWithCst->hasOneUse()) return nullptr;
2023 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
2024 if (!CI2->getValue().isPowerOf2()) return nullptr;
2025 unsigned NewWidth = CI2->getValue().countTrailingZeros();
2026 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
2028 // The width of the new add formed is 1 more than the bias.
2031 // Check to see that CI1 is an all-ones value with NewWidth bits.
2032 if (CI1->getBitWidth() == NewWidth ||
2033 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
2036 // This is only really a signed overflow check if the inputs have been
2037 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2038 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2039 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
2040 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
2041 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
2044 // In order to replace the original add with a narrower
2045 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2046 // and truncates that discard the high bits of the add. Verify that this is
2048 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
2049 for (User *U : OrigAdd->users()) {
2050 if (U == AddWithCst) continue;
2052 // Only accept truncates for now. We would really like a nice recursive
2053 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2054 // chain to see which bits of a value are actually demanded. If the
2055 // original add had another add which was then immediately truncated, we
2056 // could still do the transformation.
2057 TruncInst *TI = dyn_cast<TruncInst>(U);
2058 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2062 // If the pattern matches, truncate the inputs to the narrower type and
2063 // use the sadd_with_overflow intrinsic to efficiently compute both the
2064 // result and the overflow bit.
2065 Module *M = I.getParent()->getParent()->getParent();
2067 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
2068 Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
2071 InstCombiner::BuilderTy *Builder = IC.Builder;
2073 // Put the new code above the original add, in case there are any uses of the
2074 // add between the add and the compare.
2075 Builder->SetInsertPoint(OrigAdd);
2077 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2078 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
2079 CallInst *Call = Builder->CreateCall2(F, TruncA, TruncB, "sadd");
2080 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2081 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
2083 // The inner add was the result of the narrow add, zero extended to the
2084 // wider type. Replace it with the result computed by the intrinsic.
2085 IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
2087 // The original icmp gets replaced with the overflow value.
2088 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
2091 static Instruction *ProcessUAddIdiom(Instruction &I, Value *OrigAddV,
2093 // Don't bother doing this transformation for pointers, don't do it for
2095 if (!isa<IntegerType>(OrigAddV->getType())) return nullptr;
2097 // If the add is a constant expr, then we don't bother transforming it.
2098 Instruction *OrigAdd = dyn_cast<Instruction>(OrigAddV);
2099 if (!OrigAdd) return nullptr;
2101 Value *LHS = OrigAdd->getOperand(0), *RHS = OrigAdd->getOperand(1);
2103 // Put the new code above the original add, in case there are any uses of the
2104 // add between the add and the compare.
2105 InstCombiner::BuilderTy *Builder = IC.Builder;
2106 Builder->SetInsertPoint(OrigAdd);
2108 Module *M = I.getParent()->getParent()->getParent();
2109 Type *Ty = LHS->getType();
2110 Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
2111 CallInst *Call = Builder->CreateCall2(F, LHS, RHS, "uadd");
2112 Value *Add = Builder->CreateExtractValue(Call, 0);
2114 IC.ReplaceInstUsesWith(*OrigAdd, Add);
2116 // The original icmp gets replaced with the overflow value.
2117 return ExtractValueInst::Create(Call, 1, "uadd.overflow");
2120 /// \brief Recognize and process idiom involving test for multiplication
2123 /// The caller has matched a pattern of the form:
2124 /// I = cmp u (mul(zext A, zext B), V
2125 /// The function checks if this is a test for overflow and if so replaces
2126 /// multiplication with call to 'mul.with.overflow' intrinsic.
2128 /// \param I Compare instruction.
2129 /// \param MulVal Result of 'mult' instruction. It is one of the arguments of
2130 /// the compare instruction. Must be of integer type.
2131 /// \param OtherVal The other argument of compare instruction.
2132 /// \returns Instruction which must replace the compare instruction, NULL if no
2133 /// replacement required.
2134 static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2135 Value *OtherVal, InstCombiner &IC) {
2136 // Don't bother doing this transformation for pointers, don't do it for
2138 if (!isa<IntegerType>(MulVal->getType()))
2141 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2142 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
2143 Instruction *MulInstr = cast<Instruction>(MulVal);
2144 assert(MulInstr->getOpcode() == Instruction::Mul);
2146 Instruction *LHS = cast<Instruction>(MulInstr->getOperand(0)),
2147 *RHS = cast<Instruction>(MulInstr->getOperand(1));
2148 assert(LHS->getOpcode() == Instruction::ZExt);
2149 assert(RHS->getOpcode() == Instruction::ZExt);
2150 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2152 // Calculate type and width of the result produced by mul.with.overflow.
2153 Type *TyA = A->getType(), *TyB = B->getType();
2154 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2155 WidthB = TyB->getPrimitiveSizeInBits();
2158 if (WidthB > WidthA) {
2166 // In order to replace the original mul with a narrower mul.with.overflow,
2167 // all uses must ignore upper bits of the product. The number of used low
2168 // bits must be not greater than the width of mul.with.overflow.
2169 if (MulVal->hasNUsesOrMore(2))
2170 for (User *U : MulVal->users()) {
2173 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2174 // Check if truncation ignores bits above MulWidth.
2175 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2176 if (TruncWidth > MulWidth)
2178 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2179 // Check if AND ignores bits above MulWidth.
2180 if (BO->getOpcode() != Instruction::And)
2182 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2183 const APInt &CVal = CI->getValue();
2184 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
2188 // Other uses prohibit this transformation.
2193 // Recognize patterns
2194 switch (I.getPredicate()) {
2195 case ICmpInst::ICMP_EQ:
2196 case ICmpInst::ICMP_NE:
2197 // Recognize pattern:
2198 // mulval = mul(zext A, zext B)
2199 // cmp eq/neq mulval, zext trunc mulval
2200 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2201 if (Zext->hasOneUse()) {
2202 Value *ZextArg = Zext->getOperand(0);
2203 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2204 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2208 // Recognize pattern:
2209 // mulval = mul(zext A, zext B)
2210 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2213 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2214 if (ValToMask != MulVal)
2216 const APInt &CVal = CI->getValue() + 1;
2217 if (CVal.isPowerOf2()) {
2218 unsigned MaskWidth = CVal.logBase2();
2219 if (MaskWidth == MulWidth)
2220 break; // Recognized
2225 case ICmpInst::ICMP_UGT:
2226 // Recognize pattern:
2227 // mulval = mul(zext A, zext B)
2228 // cmp ugt mulval, max
2229 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2230 APInt MaxVal = APInt::getMaxValue(MulWidth);
2231 MaxVal = MaxVal.zext(CI->getBitWidth());
2232 if (MaxVal.eq(CI->getValue()))
2233 break; // Recognized
2237 case ICmpInst::ICMP_UGE:
2238 // Recognize pattern:
2239 // mulval = mul(zext A, zext B)
2240 // cmp uge mulval, max+1
2241 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2242 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2243 if (MaxVal.eq(CI->getValue()))
2244 break; // Recognized
2248 case ICmpInst::ICMP_ULE:
2249 // Recognize pattern:
2250 // mulval = mul(zext A, zext B)
2251 // cmp ule mulval, max
2252 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2253 APInt MaxVal = APInt::getMaxValue(MulWidth);
2254 MaxVal = MaxVal.zext(CI->getBitWidth());
2255 if (MaxVal.eq(CI->getValue()))
2256 break; // Recognized
2260 case ICmpInst::ICMP_ULT:
2261 // Recognize pattern:
2262 // mulval = mul(zext A, zext B)
2263 // cmp ule mulval, max + 1
2264 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2265 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2266 if (MaxVal.eq(CI->getValue()))
2267 break; // Recognized
2275 InstCombiner::BuilderTy *Builder = IC.Builder;
2276 Builder->SetInsertPoint(MulInstr);
2277 Module *M = I.getParent()->getParent()->getParent();
2279 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2280 Value *MulA = A, *MulB = B;
2281 if (WidthA < MulWidth)
2282 MulA = Builder->CreateZExt(A, MulType);
2283 if (WidthB < MulWidth)
2284 MulB = Builder->CreateZExt(B, MulType);
2286 Intrinsic::getDeclaration(M, Intrinsic::umul_with_overflow, MulType);
2287 CallInst *Call = Builder->CreateCall2(F, MulA, MulB, "umul");
2288 IC.Worklist.Add(MulInstr);
2290 // If there are uses of mul result other than the comparison, we know that
2291 // they are truncation or binary AND. Change them to use result of
2292 // mul.with.overflow and adjust properly mask/size.
2293 if (MulVal->hasNUsesOrMore(2)) {
2294 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2295 for (User *U : MulVal->users()) {
2296 if (U == &I || U == OtherVal)
2298 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2299 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
2300 IC.ReplaceInstUsesWith(*TI, Mul);
2302 TI->setOperand(0, Mul);
2303 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2304 assert(BO->getOpcode() == Instruction::And);
2305 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2306 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2307 APInt ShortMask = CI->getValue().trunc(MulWidth);
2308 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2310 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2311 IC.Worklist.Add(Zext);
2312 IC.ReplaceInstUsesWith(*BO, Zext);
2314 llvm_unreachable("Unexpected Binary operation");
2316 IC.Worklist.Add(cast<Instruction>(U));
2319 if (isa<Instruction>(OtherVal))
2320 IC.Worklist.Add(cast<Instruction>(OtherVal));
2322 // The original icmp gets replaced with the overflow value, maybe inverted
2323 // depending on predicate.
2324 bool Inverse = false;
2325 switch (I.getPredicate()) {
2326 case ICmpInst::ICMP_NE:
2328 case ICmpInst::ICMP_EQ:
2331 case ICmpInst::ICMP_UGT:
2332 case ICmpInst::ICMP_UGE:
2333 if (I.getOperand(0) == MulVal)
2337 case ICmpInst::ICMP_ULT:
2338 case ICmpInst::ICMP_ULE:
2339 if (I.getOperand(1) == MulVal)
2344 llvm_unreachable("Unexpected predicate");
2347 Value *Res = Builder->CreateExtractValue(Call, 1);
2348 return BinaryOperator::CreateNot(Res);
2351 return ExtractValueInst::Create(Call, 1);
2354 // DemandedBitsLHSMask - When performing a comparison against a constant,
2355 // it is possible that not all the bits in the LHS are demanded. This helper
2356 // method computes the mask that IS demanded.
2357 static APInt DemandedBitsLHSMask(ICmpInst &I,
2358 unsigned BitWidth, bool isSignCheck) {
2360 return APInt::getSignBit(BitWidth);
2362 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2363 if (!CI) return APInt::getAllOnesValue(BitWidth);
2364 const APInt &RHS = CI->getValue();
2366 switch (I.getPredicate()) {
2367 // For a UGT comparison, we don't care about any bits that
2368 // correspond to the trailing ones of the comparand. The value of these
2369 // bits doesn't impact the outcome of the comparison, because any value
2370 // greater than the RHS must differ in a bit higher than these due to carry.
2371 case ICmpInst::ICMP_UGT: {
2372 unsigned trailingOnes = RHS.countTrailingOnes();
2373 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2377 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2378 // Any value less than the RHS must differ in a higher bit because of carries.
2379 case ICmpInst::ICMP_ULT: {
2380 unsigned trailingZeros = RHS.countTrailingZeros();
2381 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2386 return APInt::getAllOnesValue(BitWidth);
2391 /// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
2392 /// should be swapped.
2393 /// The decision is based on how many times these two operands are reused
2394 /// as subtract operands and their positions in those instructions.
2395 /// The rational is that several architectures use the same instruction for
2396 /// both subtract and cmp, thus it is better if the order of those operands
2398 /// \return true if Op0 and Op1 should be swapped.
2399 static bool swapMayExposeCSEOpportunities(const Value * Op0,
2400 const Value * Op1) {
2401 // Filter out pointer value as those cannot appears directly in subtract.
2402 // FIXME: we may want to go through inttoptrs or bitcasts.
2403 if (Op0->getType()->isPointerTy())
2405 // Count every uses of both Op0 and Op1 in a subtract.
2406 // Each time Op0 is the first operand, count -1: swapping is bad, the
2407 // subtract has already the same layout as the compare.
2408 // Each time Op0 is the second operand, count +1: swapping is good, the
2409 // subtract has a different layout as the compare.
2410 // At the end, if the benefit is greater than 0, Op0 should come second to
2411 // expose more CSE opportunities.
2412 int GlobalSwapBenefits = 0;
2413 for (const User *U : Op0->users()) {
2414 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
2415 if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
2417 // If Op0 is the first argument, this is not beneficial to swap the
2419 int LocalSwapBenefits = -1;
2420 unsigned Op1Idx = 1;
2421 if (BinOp->getOperand(Op1Idx) == Op0) {
2423 LocalSwapBenefits = 1;
2425 if (BinOp->getOperand(Op1Idx) != Op1)
2427 GlobalSwapBenefits += LocalSwapBenefits;
2429 return GlobalSwapBenefits > 0;
2432 /// \brief Check that one use is in the same block as the definition and all
2433 /// other uses are in blocks dominated by a given block
2435 /// \param DI Definition
2437 /// \param DB Block that must dominate all uses of \p DI outside
2438 /// the parent block
2439 /// \return true when \p UI is the only use of \p DI in the parent block
2440 /// and all other uses of \p DI are in blocks dominated by \p DB.
2442 bool InstCombiner::dominatesAllUses(const Instruction *DI,
2443 const Instruction *UI,
2444 const BasicBlock *DB) const {
2445 assert(DI && UI && "Instruction not defined\n");
2446 if (DI->getParent() != UI->getParent())
2448 // DominatorTree available?
2451 for (const User *U : DI->users()) {
2452 auto *Usr = cast<Instruction>(U);
2453 if (Usr != UI && !DT->dominates(DB, Usr->getParent()))
2460 /// true when the instruction sequence within a block is select-cmp-br.
2462 static bool isChainSelectCmpBranch(const SelectInst *SI) {
2463 const BasicBlock *BB = SI->getParent();
2466 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
2467 if (!BI || BI->getNumSuccessors() != 2)
2469 auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
2470 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
2476 /// \brief True when a select result is replaced by one of its operands
2477 /// in select-icmp sequence. This will eventually result in the elimination
2480 /// \param SI Select instruction
2481 /// \param Icmp Compare instruction
2482 /// \param CI1 'true' when first select operand is equal to RHSC of Icmp
2483 /// \param CI2 'true' when second select operand is equal to RHSC of Icmp
2486 /// - The replacement is global and requires dominator information
2487 /// - The caller is responsible for the actual replacement
2492 /// %4 = select i1 %3, %C* %0, %C* null
2493 /// %5 = icmp eq %C* %4, null
2494 /// br i1 %5, label %9, label %7
2496 /// ; <label>:7 ; preds = %entry
2497 /// %8 = getelementptr inbounds %C* %4, i64 0, i32 0
2500 /// can be transformed to
2502 /// %5 = icmp eq %C* %0, null
2503 /// %6 = select i1 %3, i1 %5, i1 true
2504 /// br i1 %6, label %9, label %7
2506 /// ; <label>:7 ; preds = %entry
2507 /// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0!
2509 /// Similar when the first operand of the select is a constant or/and
2510 /// the compare is for not equal rather than equal.
2512 /// FIXME: Currently the function considers equal compares only. It should be
2513 /// possbile to extend it to not equal compares also.
2515 bool InstCombiner::replacedSelectWithOperand(SelectInst *SI,
2516 const ICmpInst *Icmp,
2517 const ConstantInt *CI1,
2518 const ConstantInt *CI2) {
2519 if (isChainSelectCmpBranch(SI) &&
2520 Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
2521 // Code sequence is select - icmp.eq - br
2522 unsigned ReplaceWithOpd = 0;
2523 if (CI1 && !CI1->isZero())
2524 // The first constant operand of the select and the RHS of
2525 // the compare match, so try to substitute
2526 // the select results with its second operand
2528 // %4 = select i1 %3, %C* null, %C* %0
2529 // %5 = icmp eq %C* %4, null
2530 // ==> could replace select with second operand
2532 else if (CI2 && !CI2->isZero())
2533 // Similar when the second operand of the select is a constant
2535 // %4 = select i1 %3, %C* %0, %C* null
2536 // %5 = icmp eq %C* %4, null
2537 // ==> could replace select with first operand
2539 if (ReplaceWithOpd) {
2540 // Replace select with operand on else path for EQ compares.
2541 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
2542 if (InstCombiner::dominatesAllUses(SI, Icmp, Succ)) {
2543 SI->replaceAllUsesWith(SI->getOperand(ReplaceWithOpd));
2551 Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
2552 bool Changed = false;
2553 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2554 unsigned Op0Cplxity = getComplexity(Op0);
2555 unsigned Op1Cplxity = getComplexity(Op1);
2557 /// Orders the operands of the compare so that they are listed from most
2558 /// complex to least complex. This puts constants before unary operators,
2559 /// before binary operators.
2560 if (Op0Cplxity < Op1Cplxity ||
2561 (Op0Cplxity == Op1Cplxity &&
2562 swapMayExposeCSEOpportunities(Op0, Op1))) {
2564 std::swap(Op0, Op1);
2568 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AT))
2569 return ReplaceInstUsesWith(I, V);
2571 // comparing -val or val with non-zero is the same as just comparing val
2572 // ie, abs(val) != 0 -> val != 0
2573 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
2575 Value *Cond, *SelectTrue, *SelectFalse;
2576 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
2577 m_Value(SelectFalse)))) {
2578 if (Value *V = dyn_castNegVal(SelectTrue)) {
2579 if (V == SelectFalse)
2580 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2582 else if (Value *V = dyn_castNegVal(SelectFalse)) {
2583 if (V == SelectTrue)
2584 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2589 Type *Ty = Op0->getType();
2591 // icmp's with boolean values can always be turned into bitwise operations
2592 if (Ty->isIntegerTy(1)) {
2593 switch (I.getPredicate()) {
2594 default: llvm_unreachable("Invalid icmp instruction!");
2595 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
2596 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
2597 return BinaryOperator::CreateNot(Xor);
2599 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
2600 return BinaryOperator::CreateXor(Op0, Op1);
2602 case ICmpInst::ICMP_UGT:
2603 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
2605 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
2606 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2607 return BinaryOperator::CreateAnd(Not, Op1);
2609 case ICmpInst::ICMP_SGT:
2610 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
2612 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
2613 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2614 return BinaryOperator::CreateAnd(Not, Op0);
2616 case ICmpInst::ICMP_UGE:
2617 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
2619 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
2620 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2621 return BinaryOperator::CreateOr(Not, Op1);
2623 case ICmpInst::ICMP_SGE:
2624 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
2626 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
2627 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2628 return BinaryOperator::CreateOr(Not, Op0);
2633 unsigned BitWidth = 0;
2634 if (Ty->isIntOrIntVectorTy())
2635 BitWidth = Ty->getScalarSizeInBits();
2636 else if (DL) // Pointers require DL info to get their size.
2637 BitWidth = DL->getTypeSizeInBits(Ty->getScalarType());
2639 bool isSignBit = false;
2641 // See if we are doing a comparison with a constant.
2642 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2643 Value *A = nullptr, *B = nullptr;
2645 // Match the following pattern, which is a common idiom when writing
2646 // overflow-safe integer arithmetic function. The source performs an
2647 // addition in wider type, and explicitly checks for overflow using
2648 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
2649 // sadd_with_overflow intrinsic.
2651 // TODO: This could probably be generalized to handle other overflow-safe
2652 // operations if we worked out the formulas to compute the appropriate
2656 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
2658 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
2659 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
2660 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
2661 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
2665 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
2666 if (I.isEquality() && CI->isZero() &&
2667 match(Op0, m_Sub(m_Value(A), m_Value(B)))) {
2668 // (icmp cond A B) if cond is equality
2669 return new ICmpInst(I.getPredicate(), A, B);
2672 // If we have an icmp le or icmp ge instruction, turn it into the
2673 // appropriate icmp lt or icmp gt instruction. This allows us to rely on
2674 // them being folded in the code below. The SimplifyICmpInst code has
2675 // already handled the edge cases for us, so we just assert on them.
2676 switch (I.getPredicate()) {
2678 case ICmpInst::ICMP_ULE:
2679 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE
2680 return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
2681 Builder->getInt(CI->getValue()+1));
2682 case ICmpInst::ICMP_SLE:
2683 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE
2684 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2685 Builder->getInt(CI->getValue()+1));
2686 case ICmpInst::ICMP_UGE:
2687 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE
2688 return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
2689 Builder->getInt(CI->getValue()-1));
2690 case ICmpInst::ICMP_SGE:
2691 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE
2692 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2693 Builder->getInt(CI->getValue()-1));
2696 // (icmp eq/ne (ashr/lshr const2, A), const1)
2697 if (I.isEquality()) {
2699 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
2700 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
2701 return FoldICmpCstShrCst(I, Op0, A, CI, CI2);
2705 // If this comparison is a normal comparison, it demands all
2706 // bits, if it is a sign bit comparison, it only demands the sign bit.
2708 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
2711 // See if we can fold the comparison based on range information we can get
2712 // by checking whether bits are known to be zero or one in the input.
2713 if (BitWidth != 0) {
2714 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
2715 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2717 if (SimplifyDemandedBits(I.getOperandUse(0),
2718 DemandedBitsLHSMask(I, BitWidth, isSignBit),
2719 Op0KnownZero, Op0KnownOne, 0))
2721 if (SimplifyDemandedBits(I.getOperandUse(1),
2722 APInt::getAllOnesValue(BitWidth),
2723 Op1KnownZero, Op1KnownOne, 0))
2726 // Given the known and unknown bits, compute a range that the LHS could be
2727 // in. Compute the Min, Max and RHS values based on the known bits. For the
2728 // EQ and NE we use unsigned values.
2729 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2730 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2732 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2734 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2737 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2739 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2743 // If Min and Max are known to be the same, then SimplifyDemandedBits
2744 // figured out that the LHS is a constant. Just constant fold this now so
2745 // that code below can assume that Min != Max.
2746 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2747 return new ICmpInst(I.getPredicate(),
2748 ConstantInt::get(Op0->getType(), Op0Min), Op1);
2749 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2750 return new ICmpInst(I.getPredicate(), Op0,
2751 ConstantInt::get(Op1->getType(), Op1Min));
2753 // Based on the range information we know about the LHS, see if we can
2754 // simplify this comparison. For example, (x&4) < 8 is always true.
2755 switch (I.getPredicate()) {
2756 default: llvm_unreachable("Unknown icmp opcode!");
2757 case ICmpInst::ICMP_EQ: {
2758 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
2759 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2761 // If all bits are known zero except for one, then we know at most one
2762 // bit is set. If the comparison is against zero, then this is a check
2763 // to see if *that* bit is set.
2764 APInt Op0KnownZeroInverted = ~Op0KnownZero;
2765 if (~Op1KnownZero == 0) {
2766 // If the LHS is an AND with the same constant, look through it.
2767 Value *LHS = nullptr;
2768 ConstantInt *LHSC = nullptr;
2769 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2770 LHSC->getValue() != Op0KnownZeroInverted)
2773 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
2774 // then turn "((1 << x)&8) == 0" into "x != 3".
2775 // or turn "((1 << x)&7) == 0" into "x > 2".
2777 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2778 APInt ValToCheck = Op0KnownZeroInverted;
2779 if (ValToCheck.isPowerOf2()) {
2780 unsigned CmpVal = ValToCheck.countTrailingZeros();
2781 return new ICmpInst(ICmpInst::ICMP_NE, X,
2782 ConstantInt::get(X->getType(), CmpVal));
2783 } else if ((++ValToCheck).isPowerOf2()) {
2784 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
2785 return new ICmpInst(ICmpInst::ICMP_UGT, X,
2786 ConstantInt::get(X->getType(), CmpVal));
2790 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
2791 // then turn "((8 >>u x)&1) == 0" into "x != 3".
2793 if (Op0KnownZeroInverted == 1 &&
2794 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
2795 return new ICmpInst(ICmpInst::ICMP_NE, X,
2796 ConstantInt::get(X->getType(),
2797 CI->countTrailingZeros()));
2802 case ICmpInst::ICMP_NE: {
2803 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
2804 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2806 // If all bits are known zero except for one, then we know at most one
2807 // bit is set. If the comparison is against zero, then this is a check
2808 // to see if *that* bit is set.
2809 APInt Op0KnownZeroInverted = ~Op0KnownZero;
2810 if (~Op1KnownZero == 0) {
2811 // If the LHS is an AND with the same constant, look through it.
2812 Value *LHS = nullptr;
2813 ConstantInt *LHSC = nullptr;
2814 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2815 LHSC->getValue() != Op0KnownZeroInverted)
2818 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
2819 // then turn "((1 << x)&8) != 0" into "x == 3".
2820 // or turn "((1 << x)&7) != 0" into "x < 3".
2822 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2823 APInt ValToCheck = Op0KnownZeroInverted;
2824 if (ValToCheck.isPowerOf2()) {
2825 unsigned CmpVal = ValToCheck.countTrailingZeros();
2826 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2827 ConstantInt::get(X->getType(), CmpVal));
2828 } else if ((++ValToCheck).isPowerOf2()) {
2829 unsigned CmpVal = ValToCheck.countTrailingZeros();
2830 return new ICmpInst(ICmpInst::ICMP_ULT, X,
2831 ConstantInt::get(X->getType(), CmpVal));
2835 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
2836 // then turn "((8 >>u x)&1) != 0" into "x == 3".
2838 if (Op0KnownZeroInverted == 1 &&
2839 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
2840 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2841 ConstantInt::get(X->getType(),
2842 CI->countTrailingZeros()));
2847 case ICmpInst::ICMP_ULT:
2848 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
2849 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2850 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
2851 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2852 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
2853 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2854 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2855 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
2856 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2857 Builder->getInt(CI->getValue()-1));
2859 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
2860 if (CI->isMinValue(true))
2861 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2862 Constant::getAllOnesValue(Op0->getType()));
2865 case ICmpInst::ICMP_UGT:
2866 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
2867 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2868 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
2869 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2871 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
2872 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2873 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2874 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
2875 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2876 Builder->getInt(CI->getValue()+1));
2878 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
2879 if (CI->isMaxValue(true))
2880 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2881 Constant::getNullValue(Op0->getType()));
2884 case ICmpInst::ICMP_SLT:
2885 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
2886 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2887 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
2888 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2889 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
2890 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2891 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2892 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
2893 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2894 Builder->getInt(CI->getValue()-1));
2897 case ICmpInst::ICMP_SGT:
2898 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
2899 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2900 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
2901 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2903 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
2904 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2905 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2906 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
2907 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2908 Builder->getInt(CI->getValue()+1));
2911 case ICmpInst::ICMP_SGE:
2912 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
2913 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
2914 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2915 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
2916 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2918 case ICmpInst::ICMP_SLE:
2919 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
2920 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
2921 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2922 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
2923 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2925 case ICmpInst::ICMP_UGE:
2926 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
2927 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
2928 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2929 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
2930 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2932 case ICmpInst::ICMP_ULE:
2933 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
2934 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
2935 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2936 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
2937 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2941 // Turn a signed comparison into an unsigned one if both operands
2942 // are known to have the same sign.
2944 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
2945 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
2946 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
2949 // Test if the ICmpInst instruction is used exclusively by a select as
2950 // part of a minimum or maximum operation. If so, refrain from doing
2951 // any other folding. This helps out other analyses which understand
2952 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
2953 // and CodeGen. And in this case, at least one of the comparison
2954 // operands has at least one user besides the compare (the select),
2955 // which would often largely negate the benefit of folding anyway.
2957 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
2958 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
2959 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
2962 // See if we are doing a comparison between a constant and an instruction that
2963 // can be folded into the comparison.
2964 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2965 // Since the RHS is a ConstantInt (CI), if the left hand side is an
2966 // instruction, see if that instruction also has constants so that the
2967 // instruction can be folded into the icmp
2968 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2969 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
2973 // Handle icmp with constant (but not simple integer constant) RHS
2974 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2975 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2976 switch (LHSI->getOpcode()) {
2977 case Instruction::GetElementPtr:
2978 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2979 if (RHSC->isNullValue() &&
2980 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2981 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2982 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2984 case Instruction::PHI:
2985 // Only fold icmp into the PHI if the phi and icmp are in the same
2986 // block. If in the same block, we're encouraging jump threading. If
2987 // not, we are just pessimizing the code by making an i1 phi.
2988 if (LHSI->getParent() == I.getParent())
2989 if (Instruction *NV = FoldOpIntoPhi(I))
2992 case Instruction::Select: {
2993 // If either operand of the select is a constant, we can fold the
2994 // comparison into the select arms, which will cause one to be
2995 // constant folded and the select turned into a bitwise or.
2996 Value *Op1 = nullptr, *Op2 = nullptr;
2997 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1)))
2998 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2999 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2)))
3000 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
3002 // We only want to perform this transformation if it will not lead to
3003 // additional code. This is true if either both sides of the select
3004 // fold to a constant (in which case the icmp is replaced with a select
3005 // which will usually simplify) or this is the only user of the
3006 // select (in which case we are trading a select+icmp for a simpler
3007 // select+icmp) or all uses of the select can be replaced based on
3008 // dominance information ("Global cases").
3009 bool Transform = false;
3012 else if (Op1 || Op2) {
3013 if (LHSI->hasOneUse())
3017 Transform = replacedSelectWithOperand(
3018 cast<SelectInst>(LHSI), &I, dyn_cast_or_null<ConstantInt>(Op1),
3019 dyn_cast_or_null<ConstantInt>(Op2));
3023 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
3026 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
3028 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3032 case Instruction::IntToPtr:
3033 // icmp pred inttoptr(X), null -> icmp pred X, 0
3034 if (RHSC->isNullValue() && DL &&
3035 DL->getIntPtrType(RHSC->getType()) ==
3036 LHSI->getOperand(0)->getType())
3037 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3038 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3041 case Instruction::Load:
3042 // Try to optimize things like "A[i] > 4" to index computations.
3043 if (GetElementPtrInst *GEP =
3044 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3045 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3046 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3047 !cast<LoadInst>(LHSI)->isVolatile())
3048 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3055 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
3056 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
3057 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
3059 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
3060 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
3061 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
3064 // Test to see if the operands of the icmp are casted versions of other
3065 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
3067 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
3068 if (Op0->getType()->isPointerTy() &&
3069 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
3070 // We keep moving the cast from the left operand over to the right
3071 // operand, where it can often be eliminated completely.
3072 Op0 = CI->getOperand(0);
3074 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
3075 // so eliminate it as well.
3076 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
3077 Op1 = CI2->getOperand(0);
3079 // If Op1 is a constant, we can fold the cast into the constant.
3080 if (Op0->getType() != Op1->getType()) {
3081 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
3082 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
3084 // Otherwise, cast the RHS right before the icmp
3085 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
3088 return new ICmpInst(I.getPredicate(), Op0, Op1);
3092 if (isa<CastInst>(Op0)) {
3093 // Handle the special case of: icmp (cast bool to X), <cst>
3094 // This comes up when you have code like
3097 // For generality, we handle any zero-extension of any operand comparison
3098 // with a constant or another cast from the same type.
3099 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
3100 if (Instruction *R = visitICmpInstWithCastAndCast(I))
3104 // Special logic for binary operators.
3105 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3106 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3108 CmpInst::Predicate Pred = I.getPredicate();
3109 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3110 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3111 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
3112 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3113 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3114 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3115 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3116 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3117 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3119 // Analyze the case when either Op0 or Op1 is an add instruction.
3120 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
3121 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
3122 if (BO0 && BO0->getOpcode() == Instruction::Add)
3123 A = BO0->getOperand(0), B = BO0->getOperand(1);
3124 if (BO1 && BO1->getOpcode() == Instruction::Add)
3125 C = BO1->getOperand(0), D = BO1->getOperand(1);
3127 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3128 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3129 return new ICmpInst(Pred, A == Op1 ? B : A,
3130 Constant::getNullValue(Op1->getType()));
3132 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3133 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3134 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3137 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
3138 if (A && C && (A == C || A == D || B == C || B == D) &&
3139 NoOp0WrapProblem && NoOp1WrapProblem &&
3140 // Try not to increase register pressure.
3141 BO0->hasOneUse() && BO1->hasOneUse()) {
3142 // Determine Y and Z in the form icmp (X+Y), (X+Z).
3145 // C + B == C + D -> B == D
3148 } else if (A == D) {
3149 // D + B == C + D -> B == C
3152 } else if (B == C) {
3153 // A + C == C + D -> A == D
3158 // A + D == C + D -> A == C
3162 return new ICmpInst(Pred, Y, Z);
3165 // icmp slt (X + -1), Y -> icmp sle X, Y
3166 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3167 match(B, m_AllOnes()))
3168 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3170 // icmp sge (X + -1), Y -> icmp sgt X, Y
3171 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3172 match(B, m_AllOnes()))
3173 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3175 // icmp sle (X + 1), Y -> icmp slt X, Y
3176 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3178 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3180 // icmp sgt (X + 1), Y -> icmp sge X, Y
3181 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3183 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3185 // if C1 has greater magnitude than C2:
3186 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3187 // s.t. C3 = C1 - C2
3189 // if C2 has greater magnitude than C1:
3190 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3191 // s.t. C3 = C2 - C1
3192 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3193 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3194 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3195 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3196 const APInt &AP1 = C1->getValue();
3197 const APInt &AP2 = C2->getValue();
3198 if (AP1.isNegative() == AP2.isNegative()) {
3199 APInt AP1Abs = C1->getValue().abs();
3200 APInt AP2Abs = C2->getValue().abs();
3201 if (AP1Abs.uge(AP2Abs)) {
3202 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3203 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3204 return new ICmpInst(Pred, NewAdd, C);
3206 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3207 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3208 return new ICmpInst(Pred, A, NewAdd);
3214 // Analyze the case when either Op0 or Op1 is a sub instruction.
3215 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
3216 A = nullptr; B = nullptr; C = nullptr; D = nullptr;
3217 if (BO0 && BO0->getOpcode() == Instruction::Sub)
3218 A = BO0->getOperand(0), B = BO0->getOperand(1);
3219 if (BO1 && BO1->getOpcode() == Instruction::Sub)
3220 C = BO1->getOperand(0), D = BO1->getOperand(1);
3222 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3223 if (A == Op1 && NoOp0WrapProblem)
3224 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
3226 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3227 if (C == Op0 && NoOp1WrapProblem)
3228 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3230 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
3231 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3232 // Try not to increase register pressure.
3233 BO0->hasOneUse() && BO1->hasOneUse())
3234 return new ICmpInst(Pred, A, C);
3236 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3237 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3238 // Try not to increase register pressure.
3239 BO0->hasOneUse() && BO1->hasOneUse())
3240 return new ICmpInst(Pred, D, B);
3242 // icmp (0-X) < cst --> x > -cst
3243 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3245 if (match(BO0, m_Neg(m_Value(X))))
3246 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3247 if (!RHSC->isMinValue(/*isSigned=*/true))
3248 return new ICmpInst(I.getSwappedPredicate(), X,
3249 ConstantExpr::getNeg(RHSC));
3252 BinaryOperator *SRem = nullptr;
3253 // icmp (srem X, Y), Y
3254 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
3255 Op1 == BO0->getOperand(1))
3257 // icmp Y, (srem X, Y)
3258 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3259 Op0 == BO1->getOperand(1))
3262 // We don't check hasOneUse to avoid increasing register pressure because
3263 // the value we use is the same value this instruction was already using.
3264 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3266 case ICmpInst::ICMP_EQ:
3267 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3268 case ICmpInst::ICMP_NE:
3269 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3270 case ICmpInst::ICMP_SGT:
3271 case ICmpInst::ICMP_SGE:
3272 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3273 Constant::getAllOnesValue(SRem->getType()));
3274 case ICmpInst::ICMP_SLT:
3275 case ICmpInst::ICMP_SLE:
3276 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
3277 Constant::getNullValue(SRem->getType()));
3281 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
3282 BO0->hasOneUse() && BO1->hasOneUse() &&
3283 BO0->getOperand(1) == BO1->getOperand(1)) {
3284 switch (BO0->getOpcode()) {
3286 case Instruction::Add:
3287 case Instruction::Sub:
3288 case Instruction::Xor:
3289 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
3290 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3291 BO1->getOperand(0));
3292 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
3293 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3294 if (CI->getValue().isSignBit()) {
3295 ICmpInst::Predicate Pred = I.isSigned()
3296 ? I.getUnsignedPredicate()
3297 : I.getSignedPredicate();
3298 return new ICmpInst(Pred, BO0->getOperand(0),
3299 BO1->getOperand(0));
3302 if (CI->isMaxValue(true)) {
3303 ICmpInst::Predicate Pred = I.isSigned()
3304 ? I.getUnsignedPredicate()
3305 : I.getSignedPredicate();
3306 Pred = I.getSwappedPredicate(Pred);
3307 return new ICmpInst(Pred, BO0->getOperand(0),
3308 BO1->getOperand(0));
3312 case Instruction::Mul:
3313 if (!I.isEquality())
3316 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3317 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
3318 // Mask = -1 >> count-trailing-zeros(Cst).
3319 if (!CI->isZero() && !CI->isOne()) {
3320 const APInt &AP = CI->getValue();
3321 ConstantInt *Mask = ConstantInt::get(I.getContext(),
3322 APInt::getLowBitsSet(AP.getBitWidth(),
3324 AP.countTrailingZeros()));
3325 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
3326 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
3327 return new ICmpInst(I.getPredicate(), And1, And2);
3331 case Instruction::UDiv:
3332 case Instruction::LShr:
3336 case Instruction::SDiv:
3337 case Instruction::AShr:
3338 if (!BO0->isExact() || !BO1->isExact())
3340 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3341 BO1->getOperand(0));
3342 case Instruction::Shl: {
3343 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
3344 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
3347 if (!NSW && I.isSigned())
3349 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3350 BO1->getOperand(0));
3357 // Transform (A & ~B) == 0 --> (A & B) != 0
3358 // and (A & ~B) != 0 --> (A & B) == 0
3359 // if A is a power of 2.
3360 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
3361 match(Op1, m_Zero()) && isKnownToBeAPowerOfTwo(A, false,
3364 return new ICmpInst(I.getInversePredicate(),
3365 Builder->CreateAnd(A, B),
3368 // ~x < ~y --> y < x
3369 // ~x < cst --> ~cst < x
3370 if (match(Op0, m_Not(m_Value(A)))) {
3371 if (match(Op1, m_Not(m_Value(B))))
3372 return new ICmpInst(I.getPredicate(), B, A);
3373 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3374 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
3377 // (a+b) <u a --> llvm.uadd.with.overflow.
3378 // (a+b) <u b --> llvm.uadd.with.overflow.
3379 if (I.getPredicate() == ICmpInst::ICMP_ULT &&
3380 match(Op0, m_Add(m_Value(A), m_Value(B))) &&
3381 (Op1 == A || Op1 == B))
3382 if (Instruction *R = ProcessUAddIdiom(I, Op0, *this))
3385 // a >u (a+b) --> llvm.uadd.with.overflow.
3386 // b >u (a+b) --> llvm.uadd.with.overflow.
3387 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
3388 match(Op1, m_Add(m_Value(A), m_Value(B))) &&
3389 (Op0 == A || Op0 == B))
3390 if (Instruction *R = ProcessUAddIdiom(I, Op1, *this))
3393 // (zext a) * (zext b) --> llvm.umul.with.overflow.
3394 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3395 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
3398 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3399 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
3404 if (I.isEquality()) {
3405 Value *A, *B, *C, *D;
3407 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
3408 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
3409 Value *OtherVal = A == Op1 ? B : A;
3410 return new ICmpInst(I.getPredicate(), OtherVal,
3411 Constant::getNullValue(A->getType()));
3414 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
3415 // A^c1 == C^c2 --> A == C^(c1^c2)
3416 ConstantInt *C1, *C2;
3417 if (match(B, m_ConstantInt(C1)) &&
3418 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
3419 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
3420 Value *Xor = Builder->CreateXor(C, NC);
3421 return new ICmpInst(I.getPredicate(), A, Xor);
3424 // A^B == A^D -> B == D
3425 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
3426 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
3427 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
3428 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
3432 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
3433 (A == Op0 || B == Op0)) {
3434 // A == (A^B) -> B == 0
3435 Value *OtherVal = A == Op0 ? B : A;
3436 return new ICmpInst(I.getPredicate(), OtherVal,
3437 Constant::getNullValue(A->getType()));
3440 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
3441 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
3442 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
3443 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
3446 X = B; Y = D; Z = A;
3447 } else if (A == D) {
3448 X = B; Y = C; Z = A;
3449 } else if (B == C) {
3450 X = A; Y = D; Z = B;
3451 } else if (B == D) {
3452 X = A; Y = C; Z = B;
3455 if (X) { // Build (X^Y) & Z
3456 Op1 = Builder->CreateXor(X, Y);
3457 Op1 = Builder->CreateAnd(Op1, Z);
3458 I.setOperand(0, Op1);
3459 I.setOperand(1, Constant::getNullValue(Op1->getType()));
3464 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
3465 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
3467 if ((Op0->hasOneUse() &&
3468 match(Op0, m_ZExt(m_Value(A))) &&
3469 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
3470 (Op1->hasOneUse() &&
3471 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
3472 match(Op1, m_ZExt(m_Value(A))))) {
3473 APInt Pow2 = Cst1->getValue() + 1;
3474 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
3475 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
3476 return new ICmpInst(I.getPredicate(), A,
3477 Builder->CreateTrunc(B, A->getType()));
3480 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
3481 // For lshr and ashr pairs.
3482 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3483 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
3484 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3485 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
3486 unsigned TypeBits = Cst1->getBitWidth();
3487 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3488 if (ShAmt < TypeBits && ShAmt != 0) {
3489 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
3490 ? ICmpInst::ICMP_UGE
3491 : ICmpInst::ICMP_ULT;
3492 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
3493 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
3494 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
3498 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
3499 // "icmp (and X, mask), cst"
3501 if (Op0->hasOneUse() &&
3502 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
3503 m_ConstantInt(ShAmt))))) &&
3504 match(Op1, m_ConstantInt(Cst1)) &&
3505 // Only do this when A has multiple uses. This is most important to do
3506 // when it exposes other optimizations.
3508 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
3510 if (ShAmt < ASize) {
3512 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
3515 APInt CmpV = Cst1->getValue().zext(ASize);
3518 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
3519 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
3525 Value *X; ConstantInt *Cst;
3527 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
3528 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate());
3531 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
3532 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate());
3534 return Changed ? &I : nullptr;
3537 /// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
3539 Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
3542 if (!isa<ConstantFP>(RHSC)) return nullptr;
3543 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
3545 // Get the width of the mantissa. We don't want to hack on conversions that
3546 // might lose information from the integer, e.g. "i64 -> float"
3547 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
3548 if (MantissaWidth == -1) return nullptr; // Unknown.
3550 // Check to see that the input is converted from an integer type that is small
3551 // enough that preserves all bits. TODO: check here for "known" sign bits.
3552 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
3553 unsigned InputSize = LHSI->getOperand(0)->getType()->getScalarSizeInBits();
3555 // If this is a uitofp instruction, we need an extra bit to hold the sign.
3556 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
3560 // If the conversion would lose info, don't hack on this.
3561 if ((int)InputSize > MantissaWidth)
3564 // Otherwise, we can potentially simplify the comparison. We know that it
3565 // will always come through as an integer value and we know the constant is
3566 // not a NAN (it would have been previously simplified).
3567 assert(!RHS.isNaN() && "NaN comparison not already folded!");
3569 ICmpInst::Predicate Pred;
3570 switch (I.getPredicate()) {
3571 default: llvm_unreachable("Unexpected predicate!");
3572 case FCmpInst::FCMP_UEQ:
3573 case FCmpInst::FCMP_OEQ:
3574 Pred = ICmpInst::ICMP_EQ;
3576 case FCmpInst::FCMP_UGT:
3577 case FCmpInst::FCMP_OGT:
3578 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
3580 case FCmpInst::FCMP_UGE:
3581 case FCmpInst::FCMP_OGE:
3582 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
3584 case FCmpInst::FCMP_ULT:
3585 case FCmpInst::FCMP_OLT:
3586 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
3588 case FCmpInst::FCMP_ULE:
3589 case FCmpInst::FCMP_OLE:
3590 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
3592 case FCmpInst::FCMP_UNE:
3593 case FCmpInst::FCMP_ONE:
3594 Pred = ICmpInst::ICMP_NE;
3596 case FCmpInst::FCMP_ORD:
3597 return ReplaceInstUsesWith(I, Builder->getTrue());
3598 case FCmpInst::FCMP_UNO:
3599 return ReplaceInstUsesWith(I, Builder->getFalse());
3602 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
3604 // Now we know that the APFloat is a normal number, zero or inf.
3606 // See if the FP constant is too large for the integer. For example,
3607 // comparing an i8 to 300.0.
3608 unsigned IntWidth = IntTy->getScalarSizeInBits();
3611 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
3612 // and large values.
3613 APFloat SMax(RHS.getSemantics());
3614 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
3615 APFloat::rmNearestTiesToEven);
3616 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
3617 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
3618 Pred == ICmpInst::ICMP_SLE)
3619 return ReplaceInstUsesWith(I, Builder->getTrue());
3620 return ReplaceInstUsesWith(I, Builder->getFalse());
3623 // If the RHS value is > UnsignedMax, fold the comparison. This handles
3624 // +INF and large values.
3625 APFloat UMax(RHS.getSemantics());
3626 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
3627 APFloat::rmNearestTiesToEven);
3628 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
3629 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
3630 Pred == ICmpInst::ICMP_ULE)
3631 return ReplaceInstUsesWith(I, Builder->getTrue());
3632 return ReplaceInstUsesWith(I, Builder->getFalse());
3637 // See if the RHS value is < SignedMin.
3638 APFloat SMin(RHS.getSemantics());
3639 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
3640 APFloat::rmNearestTiesToEven);
3641 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
3642 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
3643 Pred == ICmpInst::ICMP_SGE)
3644 return ReplaceInstUsesWith(I, Builder->getTrue());
3645 return ReplaceInstUsesWith(I, Builder->getFalse());
3648 // See if the RHS value is < UnsignedMin.
3649 APFloat SMin(RHS.getSemantics());
3650 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
3651 APFloat::rmNearestTiesToEven);
3652 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
3653 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
3654 Pred == ICmpInst::ICMP_UGE)
3655 return ReplaceInstUsesWith(I, Builder->getTrue());
3656 return ReplaceInstUsesWith(I, Builder->getFalse());
3660 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
3661 // [0, UMAX], but it may still be fractional. See if it is fractional by
3662 // casting the FP value to the integer value and back, checking for equality.
3663 // Don't do this for zero, because -0.0 is not fractional.
3664 Constant *RHSInt = LHSUnsigned
3665 ? ConstantExpr::getFPToUI(RHSC, IntTy)
3666 : ConstantExpr::getFPToSI(RHSC, IntTy);
3667 if (!RHS.isZero()) {
3668 bool Equal = LHSUnsigned
3669 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
3670 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
3672 // If we had a comparison against a fractional value, we have to adjust
3673 // the compare predicate and sometimes the value. RHSC is rounded towards
3674 // zero at this point.
3676 default: llvm_unreachable("Unexpected integer comparison!");
3677 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
3678 return ReplaceInstUsesWith(I, Builder->getTrue());
3679 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
3680 return ReplaceInstUsesWith(I, Builder->getFalse());
3681 case ICmpInst::ICMP_ULE:
3682 // (float)int <= 4.4 --> int <= 4
3683 // (float)int <= -4.4 --> false
3684 if (RHS.isNegative())
3685 return ReplaceInstUsesWith(I, Builder->getFalse());
3687 case ICmpInst::ICMP_SLE:
3688 // (float)int <= 4.4 --> int <= 4
3689 // (float)int <= -4.4 --> int < -4
3690 if (RHS.isNegative())
3691 Pred = ICmpInst::ICMP_SLT;
3693 case ICmpInst::ICMP_ULT:
3694 // (float)int < -4.4 --> false
3695 // (float)int < 4.4 --> int <= 4
3696 if (RHS.isNegative())
3697 return ReplaceInstUsesWith(I, Builder->getFalse());
3698 Pred = ICmpInst::ICMP_ULE;
3700 case ICmpInst::ICMP_SLT:
3701 // (float)int < -4.4 --> int < -4
3702 // (float)int < 4.4 --> int <= 4
3703 if (!RHS.isNegative())
3704 Pred = ICmpInst::ICMP_SLE;
3706 case ICmpInst::ICMP_UGT:
3707 // (float)int > 4.4 --> int > 4
3708 // (float)int > -4.4 --> true
3709 if (RHS.isNegative())
3710 return ReplaceInstUsesWith(I, Builder->getTrue());
3712 case ICmpInst::ICMP_SGT:
3713 // (float)int > 4.4 --> int > 4
3714 // (float)int > -4.4 --> int >= -4
3715 if (RHS.isNegative())
3716 Pred = ICmpInst::ICMP_SGE;
3718 case ICmpInst::ICMP_UGE:
3719 // (float)int >= -4.4 --> true
3720 // (float)int >= 4.4 --> int > 4
3721 if (RHS.isNegative())
3722 return ReplaceInstUsesWith(I, Builder->getTrue());
3723 Pred = ICmpInst::ICMP_UGT;
3725 case ICmpInst::ICMP_SGE:
3726 // (float)int >= -4.4 --> int >= -4
3727 // (float)int >= 4.4 --> int > 4
3728 if (!RHS.isNegative())
3729 Pred = ICmpInst::ICMP_SGT;
3735 // Lower this FP comparison into an appropriate integer version of the
3737 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
3740 Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
3741 bool Changed = false;
3743 /// Orders the operands of the compare so that they are listed from most
3744 /// complex to least complex. This puts constants before unary operators,
3745 /// before binary operators.
3746 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
3751 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3753 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AT))
3754 return ReplaceInstUsesWith(I, V);
3756 // Simplify 'fcmp pred X, X'
3758 switch (I.getPredicate()) {
3759 default: llvm_unreachable("Unknown predicate!");
3760 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
3761 case FCmpInst::FCMP_ULT: // True if unordered or less than
3762 case FCmpInst::FCMP_UGT: // True if unordered or greater than
3763 case FCmpInst::FCMP_UNE: // True if unordered or not equal
3764 // Canonicalize these to be 'fcmp uno %X, 0.0'.
3765 I.setPredicate(FCmpInst::FCMP_UNO);
3766 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3769 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
3770 case FCmpInst::FCMP_OEQ: // True if ordered and equal
3771 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
3772 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
3773 // Canonicalize these to be 'fcmp ord %X, 0.0'.
3774 I.setPredicate(FCmpInst::FCMP_ORD);
3775 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3780 // Handle fcmp with constant RHS
3781 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3782 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3783 switch (LHSI->getOpcode()) {
3784 case Instruction::FPExt: {
3785 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
3786 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
3787 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
3791 const fltSemantics *Sem;
3792 // FIXME: This shouldn't be here.
3793 if (LHSExt->getSrcTy()->isHalfTy())
3794 Sem = &APFloat::IEEEhalf;
3795 else if (LHSExt->getSrcTy()->isFloatTy())
3796 Sem = &APFloat::IEEEsingle;
3797 else if (LHSExt->getSrcTy()->isDoubleTy())
3798 Sem = &APFloat::IEEEdouble;
3799 else if (LHSExt->getSrcTy()->isFP128Ty())
3800 Sem = &APFloat::IEEEquad;
3801 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
3802 Sem = &APFloat::x87DoubleExtended;
3803 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
3804 Sem = &APFloat::PPCDoubleDouble;
3809 APFloat F = RHSF->getValueAPF();
3810 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
3812 // Avoid lossy conversions and denormals. Zero is a special case
3813 // that's OK to convert.
3817 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
3818 APFloat::cmpLessThan) || Fabs.isZero()))
3820 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3821 ConstantFP::get(RHSC->getContext(), F));
3824 case Instruction::PHI:
3825 // Only fold fcmp into the PHI if the phi and fcmp are in the same
3826 // block. If in the same block, we're encouraging jump threading. If
3827 // not, we are just pessimizing the code by making an i1 phi.
3828 if (LHSI->getParent() == I.getParent())
3829 if (Instruction *NV = FoldOpIntoPhi(I))
3832 case Instruction::SIToFP:
3833 case Instruction::UIToFP:
3834 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
3837 case Instruction::FSub: {
3838 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
3840 if (match(LHSI, m_FNeg(m_Value(Op))))
3841 return new FCmpInst(I.getSwappedPredicate(), Op,
3842 ConstantExpr::getFNeg(RHSC));
3845 case Instruction::Load:
3846 if (GetElementPtrInst *GEP =
3847 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3848 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3849 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3850 !cast<LoadInst>(LHSI)->isVolatile())
3851 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3855 case Instruction::Call: {
3856 CallInst *CI = cast<CallInst>(LHSI);
3858 // Various optimization for fabs compared with zero.
3859 if (RHSC->isNullValue() && CI->getCalledFunction() &&
3860 TLI->getLibFunc(CI->getCalledFunction()->getName(), Func) &&
3862 if (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
3863 Func == LibFunc::fabsl) {
3864 switch (I.getPredicate()) {
3866 // fabs(x) < 0 --> false
3867 case FCmpInst::FCMP_OLT:
3868 return ReplaceInstUsesWith(I, Builder->getFalse());
3869 // fabs(x) > 0 --> x != 0
3870 case FCmpInst::FCMP_OGT:
3871 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0),
3873 // fabs(x) <= 0 --> x == 0
3874 case FCmpInst::FCMP_OLE:
3875 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0),
3877 // fabs(x) >= 0 --> !isnan(x)
3878 case FCmpInst::FCMP_OGE:
3879 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0),
3881 // fabs(x) == 0 --> x == 0
3882 // fabs(x) != 0 --> x != 0
3883 case FCmpInst::FCMP_OEQ:
3884 case FCmpInst::FCMP_UEQ:
3885 case FCmpInst::FCMP_ONE:
3886 case FCmpInst::FCMP_UNE:
3887 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0),
3896 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
3898 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
3899 return new FCmpInst(I.getSwappedPredicate(), X, Y);
3901 // fcmp (fpext x), (fpext y) -> fcmp x, y
3902 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
3903 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
3904 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
3905 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3906 RHSExt->getOperand(0));
3908 return Changed ? &I : nullptr;