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/DataLayout.h"
19 #include "llvm/IR/IntrinsicInst.h"
20 #include "llvm/Support/ConstantRange.h"
21 #include "llvm/Support/GetElementPtrTypeIterator.h"
22 #include "llvm/Support/PatternMatch.h"
23 #include "llvm/Target/TargetLibraryInfo.h"
25 using namespace PatternMatch;
27 static ConstantInt *getOne(Constant *C) {
28 return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
31 /// AddOne - Add one to a ConstantInt
32 static Constant *AddOne(Constant *C) {
33 return ConstantExpr::getAdd(C, ConstantInt::get(C->getType(), 1));
35 /// SubOne - Subtract one from a ConstantInt
36 static Constant *SubOne(Constant *C) {
37 return ConstantExpr::getSub(C, ConstantInt::get(C->getType(), 1));
40 static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
41 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
44 static bool HasAddOverflow(ConstantInt *Result,
45 ConstantInt *In1, ConstantInt *In2,
48 return Result->getValue().ult(In1->getValue());
50 if (In2->isNegative())
51 return Result->getValue().sgt(In1->getValue());
52 return Result->getValue().slt(In1->getValue());
55 /// AddWithOverflow - Compute Result = In1+In2, returning true if the result
56 /// overflowed for this type.
57 static bool AddWithOverflow(Constant *&Result, Constant *In1,
58 Constant *In2, bool IsSigned = false) {
59 Result = ConstantExpr::getAdd(In1, In2);
61 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
62 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
63 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
64 if (HasAddOverflow(ExtractElement(Result, Idx),
65 ExtractElement(In1, Idx),
66 ExtractElement(In2, Idx),
73 return HasAddOverflow(cast<ConstantInt>(Result),
74 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
78 static bool HasSubOverflow(ConstantInt *Result,
79 ConstantInt *In1, ConstantInt *In2,
82 return Result->getValue().ugt(In1->getValue());
84 if (In2->isNegative())
85 return Result->getValue().slt(In1->getValue());
87 return Result->getValue().sgt(In1->getValue());
90 /// SubWithOverflow - Compute Result = In1-In2, returning true if the result
91 /// overflowed for this type.
92 static bool SubWithOverflow(Constant *&Result, Constant *In1,
93 Constant *In2, bool IsSigned = false) {
94 Result = ConstantExpr::getSub(In1, In2);
96 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
97 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
98 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
99 if (HasSubOverflow(ExtractElement(Result, Idx),
100 ExtractElement(In1, Idx),
101 ExtractElement(In2, Idx),
108 return HasSubOverflow(cast<ConstantInt>(Result),
109 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
113 /// isSignBitCheck - Given an exploded icmp instruction, return true if the
114 /// comparison only checks the sign bit. If it only checks the sign bit, set
115 /// TrueIfSigned if the result of the comparison is true when the input value is
117 static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
118 bool &TrueIfSigned) {
120 case ICmpInst::ICMP_SLT: // True if LHS s< 0
122 return RHS->isZero();
123 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
125 return RHS->isAllOnesValue();
126 case ICmpInst::ICMP_SGT: // True if LHS s> -1
127 TrueIfSigned = false;
128 return RHS->isAllOnesValue();
129 case ICmpInst::ICMP_UGT:
130 // True if LHS u> RHS and RHS == high-bit-mask - 1
132 return RHS->isMaxValue(true);
133 case ICmpInst::ICMP_UGE:
134 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
136 return RHS->getValue().isSignBit();
142 // isHighOnes - Return true if the constant is of the form 1+0+.
143 // This is the same as lowones(~X).
144 static bool isHighOnes(const ConstantInt *CI) {
145 return (~CI->getValue() + 1).isPowerOf2();
148 /// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
149 /// set of known zero and one bits, compute the maximum and minimum values that
150 /// could have the specified known zero and known one bits, returning them in
152 static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
153 const APInt& KnownOne,
154 APInt& Min, APInt& Max) {
155 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
156 KnownZero.getBitWidth() == Min.getBitWidth() &&
157 KnownZero.getBitWidth() == Max.getBitWidth() &&
158 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
159 APInt UnknownBits = ~(KnownZero|KnownOne);
161 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
162 // bit if it is unknown.
164 Max = KnownOne|UnknownBits;
166 if (UnknownBits.isNegative()) { // Sign bit is unknown
167 Min.setBit(Min.getBitWidth()-1);
168 Max.clearBit(Max.getBitWidth()-1);
172 // ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
173 // a set of known zero and one bits, compute the maximum and minimum values that
174 // could have the specified known zero and known one bits, returning them in
176 static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
177 const APInt &KnownOne,
178 APInt &Min, APInt &Max) {
179 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
180 KnownZero.getBitWidth() == Min.getBitWidth() &&
181 KnownZero.getBitWidth() == Max.getBitWidth() &&
182 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
183 APInt UnknownBits = ~(KnownZero|KnownOne);
185 // The minimum value is when the unknown bits are all zeros.
187 // The maximum value is when the unknown bits are all ones.
188 Max = KnownOne|UnknownBits;
193 /// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
194 /// cmp pred (load (gep GV, ...)), cmpcst
195 /// where GV is a global variable with a constant initializer. Try to simplify
196 /// this into some simple computation that does not need the load. For example
197 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
199 /// If AndCst is non-null, then the loaded value is masked with that constant
200 /// before doing the comparison. This handles cases like "A[i]&4 == 0".
201 Instruction *InstCombiner::
202 FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
203 CmpInst &ICI, ConstantInt *AndCst) {
204 // We need TD information to know the pointer size unless this is inbounds.
205 if (!GEP->isInBounds() && TD == 0) return 0;
207 Constant *Init = GV->getInitializer();
208 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
211 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
212 if (ArrayElementCount > 1024) return 0; // Don't blow up on huge arrays.
214 // There are many forms of this optimization we can handle, for now, just do
215 // the simple index into a single-dimensional array.
217 // Require: GEP GV, 0, i {{, constant indices}}
218 if (GEP->getNumOperands() < 3 ||
219 !isa<ConstantInt>(GEP->getOperand(1)) ||
220 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
221 isa<Constant>(GEP->getOperand(2)))
224 // Check that indices after the variable are constants and in-range for the
225 // type they index. Collect the indices. This is typically for arrays of
227 SmallVector<unsigned, 4> LaterIndices;
229 Type *EltTy = Init->getType()->getArrayElementType();
230 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
231 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
232 if (Idx == 0) return 0; // Variable index.
234 uint64_t IdxVal = Idx->getZExtValue();
235 if ((unsigned)IdxVal != IdxVal) return 0; // Too large array index.
237 if (StructType *STy = dyn_cast<StructType>(EltTy))
238 EltTy = STy->getElementType(IdxVal);
239 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
240 if (IdxVal >= ATy->getNumElements()) return 0;
241 EltTy = ATy->getElementType();
243 return 0; // Unknown type.
246 LaterIndices.push_back(IdxVal);
249 enum { Overdefined = -3, Undefined = -2 };
251 // Variables for our state machines.
253 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
254 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
255 // and 87 is the second (and last) index. FirstTrueElement is -2 when
256 // undefined, otherwise set to the first true element. SecondTrueElement is
257 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
258 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
260 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
261 // form "i != 47 & i != 87". Same state transitions as for true elements.
262 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
264 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
265 /// define a state machine that triggers for ranges of values that the index
266 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
267 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
268 /// index in the range (inclusive). We use -2 for undefined here because we
269 /// use relative comparisons and don't want 0-1 to match -1.
270 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
272 // MagicBitvector - This is a magic bitvector where we set a bit if the
273 // comparison is true for element 'i'. If there are 64 elements or less in
274 // the array, this will fully represent all the comparison results.
275 uint64_t MagicBitvector = 0;
278 // Scan the array and see if one of our patterns matches.
279 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
280 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
281 Constant *Elt = Init->getAggregateElement(i);
282 if (Elt == 0) return 0;
284 // If this is indexing an array of structures, get the structure element.
285 if (!LaterIndices.empty())
286 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
288 // If the element is masked, handle it.
289 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
291 // Find out if the comparison would be true or false for the i'th element.
292 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
293 CompareRHS, TD, TLI);
294 // If the result is undef for this element, ignore it.
295 if (isa<UndefValue>(C)) {
296 // Extend range state machines to cover this element in case there is an
297 // undef in the middle of the range.
298 if (TrueRangeEnd == (int)i-1)
300 if (FalseRangeEnd == (int)i-1)
305 // If we can't compute the result for any of the elements, we have to give
306 // up evaluating the entire conditional.
307 if (!isa<ConstantInt>(C)) return 0;
309 // Otherwise, we know if the comparison is true or false for this element,
310 // update our state machines.
311 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
313 // State machine for single/double/range index comparison.
315 // Update the TrueElement state machine.
316 if (FirstTrueElement == Undefined)
317 FirstTrueElement = TrueRangeEnd = i; // First true element.
319 // Update double-compare state machine.
320 if (SecondTrueElement == Undefined)
321 SecondTrueElement = i;
323 SecondTrueElement = Overdefined;
325 // Update range state machine.
326 if (TrueRangeEnd == (int)i-1)
329 TrueRangeEnd = Overdefined;
332 // Update the FalseElement state machine.
333 if (FirstFalseElement == Undefined)
334 FirstFalseElement = FalseRangeEnd = i; // First false element.
336 // Update double-compare state machine.
337 if (SecondFalseElement == Undefined)
338 SecondFalseElement = i;
340 SecondFalseElement = Overdefined;
342 // Update range state machine.
343 if (FalseRangeEnd == (int)i-1)
346 FalseRangeEnd = Overdefined;
351 // If this element is in range, update our magic bitvector.
352 if (i < 64 && IsTrueForElt)
353 MagicBitvector |= 1ULL << i;
355 // If all of our states become overdefined, bail out early. Since the
356 // predicate is expensive, only check it every 8 elements. This is only
357 // really useful for really huge arrays.
358 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
359 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
360 FalseRangeEnd == Overdefined)
364 // Now that we've scanned the entire array, emit our new comparison(s). We
365 // order the state machines in complexity of the generated code.
366 Value *Idx = GEP->getOperand(2);
368 // If the index is larger than the pointer size of the target, truncate the
369 // index down like the GEP would do implicitly. We don't have to do this for
370 // an inbounds GEP because the index can't be out of range.
371 if (!GEP->isInBounds() &&
372 Idx->getType()->getPrimitiveSizeInBits() > TD->getPointerSizeInBits())
373 Idx = Builder->CreateTrunc(Idx, TD->getIntPtrType(Idx->getContext()));
375 // If the comparison is only true for one or two elements, emit direct
377 if (SecondTrueElement != Overdefined) {
378 // None true -> false.
379 if (FirstTrueElement == Undefined)
380 return ReplaceInstUsesWith(ICI, ConstantInt::getFalse(GEP->getContext()));
382 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
384 // True for one element -> 'i == 47'.
385 if (SecondTrueElement == Undefined)
386 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
388 // True for two elements -> 'i == 47 | i == 72'.
389 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
390 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
391 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
392 return BinaryOperator::CreateOr(C1, C2);
395 // If the comparison is only false for one or two elements, emit direct
397 if (SecondFalseElement != Overdefined) {
398 // None false -> true.
399 if (FirstFalseElement == Undefined)
400 return ReplaceInstUsesWith(ICI, ConstantInt::getTrue(GEP->getContext()));
402 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
404 // False for one element -> 'i != 47'.
405 if (SecondFalseElement == Undefined)
406 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
408 // False for two elements -> 'i != 47 & i != 72'.
409 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
410 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
411 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
412 return BinaryOperator::CreateAnd(C1, C2);
415 // If the comparison can be replaced with a range comparison for the elements
416 // where it is true, emit the range check.
417 if (TrueRangeEnd != Overdefined) {
418 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
420 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
421 if (FirstTrueElement) {
422 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
423 Idx = Builder->CreateAdd(Idx, Offs);
426 Value *End = ConstantInt::get(Idx->getType(),
427 TrueRangeEnd-FirstTrueElement+1);
428 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
431 // False range check.
432 if (FalseRangeEnd != Overdefined) {
433 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
434 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
435 if (FirstFalseElement) {
436 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
437 Idx = Builder->CreateAdd(Idx, Offs);
440 Value *End = ConstantInt::get(Idx->getType(),
441 FalseRangeEnd-FirstFalseElement);
442 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
446 // If a magic bitvector captures the entire comparison state
447 // of this load, replace it with computation that does:
448 // ((magic_cst >> i) & 1) != 0
452 // Look for an appropriate type:
453 // - The type of Idx if the magic fits
454 // - The smallest fitting legal type if we have a DataLayout
456 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
459 Ty = TD->getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
460 else if (ArrayElementCount <= 32)
461 Ty = Type::getInt32Ty(Init->getContext());
464 Value *V = Builder->CreateIntCast(Idx, Ty, false);
465 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
466 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
467 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
475 /// EvaluateGEPOffsetExpression - Return a value that can be used to compare
476 /// the *offset* implied by a GEP to zero. For example, if we have &A[i], we
477 /// want to return 'i' for "icmp ne i, 0". Note that, in general, indices can
478 /// be complex, and scales are involved. The above expression would also be
479 /// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
480 /// This later form is less amenable to optimization though, and we are allowed
481 /// to generate the first by knowing that pointer arithmetic doesn't overflow.
483 /// If we can't emit an optimized form for this expression, this returns null.
485 static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC) {
486 DataLayout &TD = *IC.getDataLayout();
487 gep_type_iterator GTI = gep_type_begin(GEP);
489 // Check to see if this gep only has a single variable index. If so, and if
490 // any constant indices are a multiple of its scale, then we can compute this
491 // in terms of the scale of the variable index. For example, if the GEP
492 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
493 // because the expression will cross zero at the same point.
494 unsigned i, e = GEP->getNumOperands();
496 for (i = 1; i != e; ++i, ++GTI) {
497 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
498 // Compute the aggregate offset of constant indices.
499 if (CI->isZero()) continue;
501 // Handle a struct index, which adds its field offset to the pointer.
502 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
503 Offset += TD.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
505 uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
506 Offset += Size*CI->getSExtValue();
509 // Found our variable index.
514 // If there are no variable indices, we must have a constant offset, just
515 // evaluate it the general way.
516 if (i == e) return 0;
518 Value *VariableIdx = GEP->getOperand(i);
519 // Determine the scale factor of the variable element. For example, this is
520 // 4 if the variable index is into an array of i32.
521 uint64_t VariableScale = TD.getTypeAllocSize(GTI.getIndexedType());
523 // Verify that there are no other variable indices. If so, emit the hard way.
524 for (++i, ++GTI; i != e; ++i, ++GTI) {
525 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
528 // Compute the aggregate offset of constant indices.
529 if (CI->isZero()) continue;
531 // Handle a struct index, which adds its field offset to the pointer.
532 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
533 Offset += TD.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
535 uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
536 Offset += Size*CI->getSExtValue();
540 // Okay, we know we have a single variable index, which must be a
541 // pointer/array/vector index. If there is no offset, life is simple, return
543 unsigned IntPtrWidth = TD.getPointerSizeInBits();
545 // Cast to intptrty in case a truncation occurs. If an extension is needed,
546 // we don't need to bother extending: the extension won't affect where the
547 // computation crosses zero.
548 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
549 Type *IntPtrTy = TD.getIntPtrType(VariableIdx->getContext());
550 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
555 // Otherwise, there is an index. The computation we will do will be modulo
556 // the pointer size, so get it.
557 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
559 Offset &= PtrSizeMask;
560 VariableScale &= PtrSizeMask;
562 // To do this transformation, any constant index must be a multiple of the
563 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
564 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
565 // multiple of the variable scale.
566 int64_t NewOffs = Offset / (int64_t)VariableScale;
567 if (Offset != NewOffs*(int64_t)VariableScale)
570 // Okay, we can do this evaluation. Start by converting the index to intptr.
571 Type *IntPtrTy = TD.getIntPtrType(VariableIdx->getContext());
572 if (VariableIdx->getType() != IntPtrTy)
573 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
575 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
576 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
579 /// FoldGEPICmp - Fold comparisons between a GEP instruction and something
580 /// else. At this point we know that the GEP is on the LHS of the comparison.
581 Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
582 ICmpInst::Predicate Cond,
584 // Don't transform signed compares of GEPs into index compares. Even if the
585 // GEP is inbounds, the final add of the base pointer can have signed overflow
586 // and would change the result of the icmp.
587 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
588 // the maximum signed value for the pointer type.
589 if (ICmpInst::isSigned(Cond))
592 // Look through bitcasts.
593 if (BitCastInst *BCI = dyn_cast<BitCastInst>(RHS))
594 RHS = BCI->getOperand(0);
596 Value *PtrBase = GEPLHS->getOperand(0);
597 if (TD && PtrBase == RHS && GEPLHS->isInBounds()) {
598 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
599 // This transformation (ignoring the base and scales) is valid because we
600 // know pointers can't overflow since the gep is inbounds. See if we can
601 // output an optimized form.
602 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this);
604 // If not, synthesize the offset the hard way.
606 Offset = EmitGEPOffset(GEPLHS);
607 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
608 Constant::getNullValue(Offset->getType()));
609 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
610 // If the base pointers are different, but the indices are the same, just
611 // compare the base pointer.
612 if (PtrBase != GEPRHS->getOperand(0)) {
613 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
614 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
615 GEPRHS->getOperand(0)->getType();
617 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
618 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
619 IndicesTheSame = false;
623 // If all indices are the same, just compare the base pointers.
625 return new ICmpInst(ICmpInst::getSignedPredicate(Cond),
626 GEPLHS->getOperand(0), GEPRHS->getOperand(0));
628 // If we're comparing GEPs with two base pointers that only differ in type
629 // and both GEPs have only constant indices or just one use, then fold
630 // the compare with the adjusted indices.
631 if (TD && GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
632 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
633 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
634 PtrBase->stripPointerCasts() ==
635 GEPRHS->getOperand(0)->stripPointerCasts()) {
636 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
637 EmitGEPOffset(GEPLHS),
638 EmitGEPOffset(GEPRHS));
639 return ReplaceInstUsesWith(I, Cmp);
642 // Otherwise, the base pointers are different and the indices are
643 // different, bail out.
647 // If one of the GEPs has all zero indices, recurse.
648 bool AllZeros = true;
649 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
650 if (!isa<Constant>(GEPLHS->getOperand(i)) ||
651 !cast<Constant>(GEPLHS->getOperand(i))->isNullValue()) {
656 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
657 ICmpInst::getSwappedPredicate(Cond), I);
659 // If the other GEP has all zero indices, recurse.
661 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
662 if (!isa<Constant>(GEPRHS->getOperand(i)) ||
663 !cast<Constant>(GEPRHS->getOperand(i))->isNullValue()) {
668 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
670 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
671 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
672 // If the GEPs only differ by one index, compare it.
673 unsigned NumDifferences = 0; // Keep track of # differences.
674 unsigned DiffOperand = 0; // The operand that differs.
675 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
676 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
677 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
678 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
679 // Irreconcilable differences.
683 if (NumDifferences++) break;
688 if (NumDifferences == 0) // SAME GEP?
689 return ReplaceInstUsesWith(I, // No comparison is needed here.
690 ConstantInt::get(Type::getInt1Ty(I.getContext()),
691 ICmpInst::isTrueWhenEqual(Cond)));
693 else if (NumDifferences == 1 && GEPsInBounds) {
694 Value *LHSV = GEPLHS->getOperand(DiffOperand);
695 Value *RHSV = GEPRHS->getOperand(DiffOperand);
696 // Make sure we do a signed comparison here.
697 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
701 // Only lower this if the icmp is the only user of the GEP or if we expect
702 // the result to fold to a constant!
705 (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
706 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
707 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
708 Value *L = EmitGEPOffset(GEPLHS);
709 Value *R = EmitGEPOffset(GEPRHS);
710 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
716 /// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
717 Instruction *InstCombiner::FoldICmpAddOpCst(ICmpInst &ICI,
718 Value *X, ConstantInt *CI,
719 ICmpInst::Predicate Pred,
721 // If we have X+0, exit early (simplifying logic below) and let it get folded
722 // elsewhere. icmp X+0, X -> icmp X, X
724 bool isTrue = ICmpInst::isTrueWhenEqual(Pred);
725 return ReplaceInstUsesWith(ICI, ConstantInt::get(ICI.getType(), isTrue));
728 // (X+4) == X -> false.
729 if (Pred == ICmpInst::ICMP_EQ)
730 return ReplaceInstUsesWith(ICI, ConstantInt::getFalse(X->getContext()));
732 // (X+4) != X -> true.
733 if (Pred == ICmpInst::ICMP_NE)
734 return ReplaceInstUsesWith(ICI, ConstantInt::getTrue(X->getContext()));
736 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
737 // so the values can never be equal. Similarly for all other "or equals"
740 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
741 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
742 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
743 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
745 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
746 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
749 // (X+1) >u X --> X <u (0-1) --> X != 255
750 // (X+2) >u X --> X <u (0-2) --> X <u 254
751 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
752 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
753 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
755 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
756 ConstantInt *SMax = ConstantInt::get(X->getContext(),
757 APInt::getSignedMaxValue(BitWidth));
759 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
760 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
761 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
762 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
763 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
764 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
765 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
766 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
768 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
769 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
770 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
771 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
772 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
773 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
775 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
776 Constant *C = ConstantInt::get(X->getContext(), CI->getValue()-1);
777 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
780 /// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
781 /// and CmpRHS are both known to be integer constants.
782 Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
783 ConstantInt *DivRHS) {
784 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
785 const APInt &CmpRHSV = CmpRHS->getValue();
787 // FIXME: If the operand types don't match the type of the divide
788 // then don't attempt this transform. The code below doesn't have the
789 // logic to deal with a signed divide and an unsigned compare (and
790 // vice versa). This is because (x /s C1) <s C2 produces different
791 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
792 // (x /u C1) <u C2. Simply casting the operands and result won't
793 // work. :( The if statement below tests that condition and bails
795 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
796 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
798 if (DivRHS->isZero())
799 return 0; // The ProdOV computation fails on divide by zero.
800 if (DivIsSigned && DivRHS->isAllOnesValue())
801 return 0; // The overflow computation also screws up here
802 if (DivRHS->isOne()) {
803 // This eliminates some funny cases with INT_MIN.
804 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
808 // Compute Prod = CI * DivRHS. We are essentially solving an equation
809 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
810 // C2 (CI). By solving for X we can turn this into a range check
811 // instead of computing a divide.
812 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
814 // Determine if the product overflows by seeing if the product is
815 // not equal to the divide. Make sure we do the same kind of divide
816 // as in the LHS instruction that we're folding.
817 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
818 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
820 // Get the ICmp opcode
821 ICmpInst::Predicate Pred = ICI.getPredicate();
823 /// If the division is known to be exact, then there is no remainder from the
824 /// divide, so the covered range size is unit, otherwise it is the divisor.
825 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
827 // Figure out the interval that is being checked. For example, a comparison
828 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
829 // Compute this interval based on the constants involved and the signedness of
830 // the compare/divide. This computes a half-open interval, keeping track of
831 // whether either value in the interval overflows. After analysis each
832 // overflow variable is set to 0 if it's corresponding bound variable is valid
833 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
834 int LoOverflow = 0, HiOverflow = 0;
835 Constant *LoBound = 0, *HiBound = 0;
837 if (!DivIsSigned) { // udiv
838 // e.g. X/5 op 3 --> [15, 20)
840 HiOverflow = LoOverflow = ProdOV;
842 // If this is not an exact divide, then many values in the range collapse
843 // to the same result value.
844 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
847 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
848 if (CmpRHSV == 0) { // (X / pos) op 0
849 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
850 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
852 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
853 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
854 HiOverflow = LoOverflow = ProdOV;
856 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
857 } else { // (X / pos) op neg
858 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
859 HiBound = AddOne(Prod);
860 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
862 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
863 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
866 } else if (DivRHS->isNegative()) { // Divisor is < 0.
868 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
869 if (CmpRHSV == 0) { // (X / neg) op 0
870 // e.g. X/-5 op 0 --> [-4, 5)
871 LoBound = AddOne(RangeSize);
872 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
873 if (HiBound == DivRHS) { // -INTMIN = INTMIN
874 HiOverflow = 1; // [INTMIN+1, overflow)
875 HiBound = 0; // e.g. X/INTMIN = 0 --> X > INTMIN
877 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
878 // e.g. X/-5 op 3 --> [-19, -14)
879 HiBound = AddOne(Prod);
880 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
882 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
883 } else { // (X / neg) op neg
884 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
885 LoOverflow = HiOverflow = ProdOV;
887 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
890 // Dividing by a negative swaps the condition. LT <-> GT
891 Pred = ICmpInst::getSwappedPredicate(Pred);
894 Value *X = DivI->getOperand(0);
896 default: llvm_unreachable("Unhandled icmp opcode!");
897 case ICmpInst::ICMP_EQ:
898 if (LoOverflow && HiOverflow)
899 return ReplaceInstUsesWith(ICI, ConstantInt::getFalse(ICI.getContext()));
901 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
902 ICmpInst::ICMP_UGE, X, LoBound);
904 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
905 ICmpInst::ICMP_ULT, X, HiBound);
906 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
908 case ICmpInst::ICMP_NE:
909 if (LoOverflow && HiOverflow)
910 return ReplaceInstUsesWith(ICI, ConstantInt::getTrue(ICI.getContext()));
912 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
913 ICmpInst::ICMP_ULT, X, LoBound);
915 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
916 ICmpInst::ICMP_UGE, X, HiBound);
917 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
918 DivIsSigned, false));
919 case ICmpInst::ICMP_ULT:
920 case ICmpInst::ICMP_SLT:
921 if (LoOverflow == +1) // Low bound is greater than input range.
922 return ReplaceInstUsesWith(ICI, ConstantInt::getTrue(ICI.getContext()));
923 if (LoOverflow == -1) // Low bound is less than input range.
924 return ReplaceInstUsesWith(ICI, ConstantInt::getFalse(ICI.getContext()));
925 return new ICmpInst(Pred, X, LoBound);
926 case ICmpInst::ICMP_UGT:
927 case ICmpInst::ICMP_SGT:
928 if (HiOverflow == +1) // High bound greater than input range.
929 return ReplaceInstUsesWith(ICI, ConstantInt::getFalse(ICI.getContext()));
930 if (HiOverflow == -1) // High bound less than input range.
931 return ReplaceInstUsesWith(ICI, ConstantInt::getTrue(ICI.getContext()));
932 if (Pred == ICmpInst::ICMP_UGT)
933 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
934 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
938 /// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
939 Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
940 ConstantInt *ShAmt) {
941 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
943 // Check that the shift amount is in range. If not, don't perform
944 // undefined shifts. When the shift is visited it will be
946 uint32_t TypeBits = CmpRHSV.getBitWidth();
947 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
948 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
951 if (!ICI.isEquality()) {
952 // If we have an unsigned comparison and an ashr, we can't simplify this.
953 // Similarly for signed comparisons with lshr.
954 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
957 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
958 // by a power of 2. Since we already have logic to simplify these,
959 // transform to div and then simplify the resultant comparison.
960 if (Shr->getOpcode() == Instruction::AShr &&
961 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
964 // Revisit the shift (to delete it).
968 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
971 Shr->getOpcode() == Instruction::AShr ?
972 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
973 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
975 ICI.setOperand(0, Tmp);
977 // If the builder folded the binop, just return it.
978 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
982 // Otherwise, fold this div/compare.
983 assert(TheDiv->getOpcode() == Instruction::SDiv ||
984 TheDiv->getOpcode() == Instruction::UDiv);
986 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
987 assert(Res && "This div/cst should have folded!");
992 // If we are comparing against bits always shifted out, the
993 // comparison cannot succeed.
994 APInt Comp = CmpRHSV << ShAmtVal;
995 ConstantInt *ShiftedCmpRHS = ConstantInt::get(ICI.getContext(), Comp);
996 if (Shr->getOpcode() == Instruction::LShr)
997 Comp = Comp.lshr(ShAmtVal);
999 Comp = Comp.ashr(ShAmtVal);
1001 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1002 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1003 Constant *Cst = ConstantInt::get(Type::getInt1Ty(ICI.getContext()),
1005 return ReplaceInstUsesWith(ICI, Cst);
1008 // Otherwise, check to see if the bits shifted out are known to be zero.
1009 // If so, we can compare against the unshifted value:
1010 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
1011 if (Shr->hasOneUse() && Shr->isExact())
1012 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
1014 if (Shr->hasOneUse()) {
1015 // Otherwise strength reduce the shift into an and.
1016 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
1017 Constant *Mask = ConstantInt::get(ICI.getContext(), Val);
1019 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1020 Mask, Shr->getName()+".mask");
1021 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1027 /// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1029 Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1032 const APInt &RHSV = RHS->getValue();
1034 switch (LHSI->getOpcode()) {
1035 case Instruction::Trunc:
1036 if (ICI.isEquality() && LHSI->hasOneUse()) {
1037 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1038 // of the high bits truncated out of x are known.
1039 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1040 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
1041 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
1042 ComputeMaskedBits(LHSI->getOperand(0), KnownZero, KnownOne);
1044 // If all the high bits are known, we can do this xform.
1045 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1046 // Pull in the high bits from known-ones set.
1047 APInt NewRHS = RHS->getValue().zext(SrcBits);
1048 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
1049 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1050 ConstantInt::get(ICI.getContext(), NewRHS));
1055 case Instruction::Xor: // (icmp pred (xor X, XorCST), CI)
1056 if (ConstantInt *XorCST = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1057 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1059 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1060 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1061 Value *CompareVal = LHSI->getOperand(0);
1063 // If the sign bit of the XorCST is not set, there is no change to
1064 // the operation, just stop using the Xor.
1065 if (!XorCST->isNegative()) {
1066 ICI.setOperand(0, CompareVal);
1071 // Was the old condition true if the operand is positive?
1072 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
1074 // If so, the new one isn't.
1075 isTrueIfPositive ^= true;
1077 if (isTrueIfPositive)
1078 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1081 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1085 if (LHSI->hasOneUse()) {
1086 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
1087 if (!ICI.isEquality() && XorCST->getValue().isSignBit()) {
1088 const APInt &SignBit = XorCST->getValue();
1089 ICmpInst::Predicate Pred = ICI.isSigned()
1090 ? ICI.getUnsignedPredicate()
1091 : ICI.getSignedPredicate();
1092 return new ICmpInst(Pred, LHSI->getOperand(0),
1093 ConstantInt::get(ICI.getContext(),
1097 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
1098 if (!ICI.isEquality() && XorCST->isMaxValue(true)) {
1099 const APInt &NotSignBit = XorCST->getValue();
1100 ICmpInst::Predicate Pred = ICI.isSigned()
1101 ? ICI.getUnsignedPredicate()
1102 : ICI.getSignedPredicate();
1103 Pred = ICI.getSwappedPredicate(Pred);
1104 return new ICmpInst(Pred, LHSI->getOperand(0),
1105 ConstantInt::get(ICI.getContext(),
1106 RHSV ^ NotSignBit));
1111 case Instruction::And: // (icmp pred (and X, AndCST), RHS)
1112 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1113 LHSI->getOperand(0)->hasOneUse()) {
1114 ConstantInt *AndCST = cast<ConstantInt>(LHSI->getOperand(1));
1116 // If the LHS is an AND of a truncating cast, we can widen the
1117 // and/compare to be the input width without changing the value
1118 // produced, eliminating a cast.
1119 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1120 // We can do this transformation if either the AND constant does not
1121 // have its sign bit set or if it is an equality comparison.
1122 // Extending a relational comparison when we're checking the sign
1123 // bit would not work.
1124 if (ICI.isEquality() ||
1125 (!AndCST->isNegative() && RHSV.isNonNegative())) {
1127 Builder->CreateAnd(Cast->getOperand(0),
1128 ConstantExpr::getZExt(AndCST, Cast->getSrcTy()));
1129 NewAnd->takeName(LHSI);
1130 return new ICmpInst(ICI.getPredicate(), NewAnd,
1131 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
1135 // If the LHS is an AND of a zext, and we have an equality compare, we can
1136 // shrink the and/compare to the smaller type, eliminating the cast.
1137 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
1138 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
1139 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1140 // should fold the icmp to true/false in that case.
1141 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1143 Builder->CreateAnd(Cast->getOperand(0),
1144 ConstantExpr::getTrunc(AndCST, Ty));
1145 NewAnd->takeName(LHSI);
1146 return new ICmpInst(ICI.getPredicate(), NewAnd,
1147 ConstantExpr::getTrunc(RHS, Ty));
1151 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1152 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1153 // happens a LOT in code produced by the C front-end, for bitfield
1155 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1156 if (Shift && !Shift->isShift())
1160 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : 0;
1161 Type *Ty = Shift ? Shift->getType() : 0; // Type of the shift.
1162 Type *AndTy = AndCST->getType(); // Type of the and.
1164 // We can fold this as long as we can't shift unknown bits
1165 // into the mask. This can only happen with signed shift
1166 // rights, as they sign-extend.
1168 bool CanFold = Shift->isLogicalShift();
1170 // To test for the bad case of the signed shr, see if any
1171 // of the bits shifted in could be tested after the mask.
1172 uint32_t TyBits = Ty->getPrimitiveSizeInBits();
1173 int ShAmtVal = TyBits - ShAmt->getLimitedValue(TyBits);
1175 uint32_t BitWidth = AndTy->getPrimitiveSizeInBits();
1176 if ((APInt::getHighBitsSet(BitWidth, BitWidth-ShAmtVal) &
1177 AndCST->getValue()) == 0)
1183 if (Shift->getOpcode() == Instruction::Shl)
1184 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1186 NewCst = ConstantExpr::getShl(RHS, ShAmt);
1188 // Check to see if we are shifting out any of the bits being
1190 if (ConstantExpr::get(Shift->getOpcode(),
1191 NewCst, ShAmt) != RHS) {
1192 // If we shifted bits out, the fold is not going to work out.
1193 // As a special case, check to see if this means that the
1194 // result is always true or false now.
1195 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1196 return ReplaceInstUsesWith(ICI,
1197 ConstantInt::getFalse(ICI.getContext()));
1198 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
1199 return ReplaceInstUsesWith(ICI,
1200 ConstantInt::getTrue(ICI.getContext()));
1202 ICI.setOperand(1, NewCst);
1203 Constant *NewAndCST;
1204 if (Shift->getOpcode() == Instruction::Shl)
1205 NewAndCST = ConstantExpr::getLShr(AndCST, ShAmt);
1207 NewAndCST = ConstantExpr::getShl(AndCST, ShAmt);
1208 LHSI->setOperand(1, NewAndCST);
1209 LHSI->setOperand(0, Shift->getOperand(0));
1210 Worklist.Add(Shift); // Shift is dead.
1216 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1217 // preferable because it allows the C<<Y expression to be hoisted out
1218 // of a loop if Y is invariant and X is not.
1219 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1220 ICI.isEquality() && !Shift->isArithmeticShift() &&
1221 !isa<Constant>(Shift->getOperand(0))) {
1224 if (Shift->getOpcode() == Instruction::LShr) {
1225 NS = Builder->CreateShl(AndCST, Shift->getOperand(1));
1227 // Insert a logical shift.
1228 NS = Builder->CreateLShr(AndCST, Shift->getOperand(1));
1231 // Compute X & (C << Y).
1233 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
1235 ICI.setOperand(0, NewAnd);
1239 // Replace ((X & AndCST) > RHSV) with ((X & AndCST) != 0), if any
1240 // bit set in (X & AndCST) will produce a result greater than RHSV.
1241 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
1242 unsigned NTZ = AndCST->getValue().countTrailingZeros();
1243 if ((NTZ < AndCST->getBitWidth()) &&
1244 APInt::getOneBitSet(AndCST->getBitWidth(), NTZ).ugt(RHSV))
1245 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1246 Constant::getNullValue(RHS->getType()));
1250 // Try to optimize things like "A[i]&42 == 0" to index computations.
1251 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1252 if (GetElementPtrInst *GEP =
1253 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1254 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1255 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1256 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1257 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1258 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1264 case Instruction::Or: {
1265 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1268 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1269 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1270 // -> and (icmp eq P, null), (icmp eq Q, null).
1271 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1272 Constant::getNullValue(P->getType()));
1273 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1274 Constant::getNullValue(Q->getType()));
1276 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1277 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1279 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1285 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
1286 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1289 uint32_t TypeBits = RHSV.getBitWidth();
1291 // Check that the shift amount is in range. If not, don't perform
1292 // undefined shifts. When the shift is visited it will be
1294 if (ShAmt->uge(TypeBits))
1297 if (ICI.isEquality()) {
1298 // If we are comparing against bits always shifted out, the
1299 // comparison cannot succeed.
1301 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1303 if (Comp != RHS) {// Comparing against a bit that we know is zero.
1304 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1306 ConstantInt::get(Type::getInt1Ty(ICI.getContext()), IsICMP_NE);
1307 return ReplaceInstUsesWith(ICI, Cst);
1310 // If the shift is NUW, then it is just shifting out zeros, no need for an
1312 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1313 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1314 ConstantExpr::getLShr(RHS, ShAmt));
1316 if (LHSI->hasOneUse()) {
1317 // Otherwise strength reduce the shift into an and.
1318 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
1320 ConstantInt::get(ICI.getContext(), APInt::getLowBitsSet(TypeBits,
1321 TypeBits-ShAmtVal));
1324 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1325 return new ICmpInst(ICI.getPredicate(), And,
1326 ConstantExpr::getLShr(RHS, ShAmt));
1330 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1331 bool TrueIfSigned = false;
1332 if (LHSI->hasOneUse() &&
1333 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1334 // (X << 31) <s 0 --> (X&1) != 0
1335 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
1336 APInt::getOneBitSet(TypeBits,
1337 TypeBits-ShAmt->getZExtValue()-1));
1339 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1340 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1341 And, Constant::getNullValue(And->getType()));
1344 // Transform (icmp pred iM (shl iM %v, N), CI)
1345 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1346 // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
1347 // This enables to get rid of the shift in favor of a trunc which can be
1348 // free on the target. It has the additional benefit of comparing to a
1349 // smaller constant, which will be target friendly.
1350 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
1351 if (LHSI->hasOneUse() &&
1352 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
1353 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1354 Constant *NCI = ConstantExpr::getTrunc(
1355 ConstantExpr::getAShr(RHS,
1356 ConstantInt::get(RHS->getType(), Amt)),
1358 return new ICmpInst(ICI.getPredicate(),
1359 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
1366 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
1367 case Instruction::AShr: {
1368 // Handle equality comparisons of shift-by-constant.
1369 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1370 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1371 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
1375 // Handle exact shr's.
1376 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1377 if (RHSV.isMinValue())
1378 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1383 case Instruction::SDiv:
1384 case Instruction::UDiv:
1385 // Fold: icmp pred ([us]div X, C1), C2 -> range test
1386 // Fold this div into the comparison, producing a range check.
1387 // Determine, based on the divide type, what the range is being
1388 // checked. If there is an overflow on the low or high side, remember
1389 // it, otherwise compute the range [low, hi) bounding the new value.
1390 // See: InsertRangeTest above for the kinds of replacements possible.
1391 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1392 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1397 case Instruction::Add:
1398 // Fold: icmp pred (add X, C1), C2
1399 if (!ICI.isEquality()) {
1400 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1402 const APInt &LHSV = LHSC->getValue();
1404 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1407 if (ICI.isSigned()) {
1408 if (CR.getLower().isSignBit()) {
1409 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
1410 ConstantInt::get(ICI.getContext(),CR.getUpper()));
1411 } else if (CR.getUpper().isSignBit()) {
1412 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
1413 ConstantInt::get(ICI.getContext(),CR.getLower()));
1416 if (CR.getLower().isMinValue()) {
1417 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
1418 ConstantInt::get(ICI.getContext(),CR.getUpper()));
1419 } else if (CR.getUpper().isMinValue()) {
1420 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
1421 ConstantInt::get(ICI.getContext(),CR.getLower()));
1428 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1429 if (ICI.isEquality()) {
1430 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1432 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
1433 // the second operand is a constant, simplify a bit.
1434 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1435 switch (BO->getOpcode()) {
1436 case Instruction::SRem:
1437 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1438 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1439 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
1440 if (V.sgt(1) && V.isPowerOf2()) {
1442 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1444 return new ICmpInst(ICI.getPredicate(), NewRem,
1445 Constant::getNullValue(BO->getType()));
1449 case Instruction::Add:
1450 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1451 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1452 if (BO->hasOneUse())
1453 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1454 ConstantExpr::getSub(RHS, BOp1C));
1455 } else if (RHSV == 0) {
1456 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1457 // efficiently invertible, or if the add has just this one use.
1458 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
1460 if (Value *NegVal = dyn_castNegVal(BOp1))
1461 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
1462 if (Value *NegVal = dyn_castNegVal(BOp0))
1463 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
1464 if (BO->hasOneUse()) {
1465 Value *Neg = Builder->CreateNeg(BOp1);
1467 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1471 case Instruction::Xor:
1472 // For the xor case, we can xor two constants together, eliminating
1473 // the explicit xor.
1474 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1475 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1476 ConstantExpr::getXor(RHS, BOC));
1477 } else if (RHSV == 0) {
1478 // Replace ((xor A, B) != 0) with (A != B)
1479 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1483 case Instruction::Sub:
1484 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1485 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1486 if (BO->hasOneUse())
1487 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1488 ConstantExpr::getSub(BOp0C, RHS));
1489 } else if (RHSV == 0) {
1490 // Replace ((sub A, B) != 0) with (A != B)
1491 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1495 case Instruction::Or:
1496 // If bits are being or'd in that are not present in the constant we
1497 // are comparing against, then the comparison could never succeed!
1498 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1499 Constant *NotCI = ConstantExpr::getNot(RHS);
1500 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
1501 return ReplaceInstUsesWith(ICI,
1502 ConstantInt::get(Type::getInt1Ty(ICI.getContext()),
1507 case Instruction::And:
1508 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1509 // If bits are being compared against that are and'd out, then the
1510 // comparison can never succeed!
1511 if ((RHSV & ~BOC->getValue()) != 0)
1512 return ReplaceInstUsesWith(ICI,
1513 ConstantInt::get(Type::getInt1Ty(ICI.getContext()),
1516 // If we have ((X & C) == C), turn it into ((X & C) != 0).
1517 if (RHS == BOC && RHSV.isPowerOf2())
1518 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1519 ICmpInst::ICMP_NE, LHSI,
1520 Constant::getNullValue(RHS->getType()));
1522 // Don't perform the following transforms if the AND has multiple uses
1523 if (!BO->hasOneUse())
1526 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1527 if (BOC->getValue().isSignBit()) {
1528 Value *X = BO->getOperand(0);
1529 Constant *Zero = Constant::getNullValue(X->getType());
1530 ICmpInst::Predicate pred = isICMP_NE ?
1531 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1532 return new ICmpInst(pred, X, Zero);
1535 // ((X & ~7) == 0) --> X < 8
1536 if (RHSV == 0 && isHighOnes(BOC)) {
1537 Value *X = BO->getOperand(0);
1538 Constant *NegX = ConstantExpr::getNeg(BOC);
1539 ICmpInst::Predicate pred = isICMP_NE ?
1540 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1541 return new ICmpInst(pred, X, NegX);
1546 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1547 // Handle icmp {eq|ne} <intrinsic>, intcst.
1548 switch (II->getIntrinsicID()) {
1549 case Intrinsic::bswap:
1551 ICI.setOperand(0, II->getArgOperand(0));
1552 ICI.setOperand(1, ConstantInt::get(II->getContext(), RHSV.byteSwap()));
1554 case Intrinsic::ctlz:
1555 case Intrinsic::cttz:
1556 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
1557 if (RHSV == RHS->getType()->getBitWidth()) {
1559 ICI.setOperand(0, II->getArgOperand(0));
1560 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1564 case Intrinsic::ctpop:
1565 // popcount(A) == 0 -> A == 0 and likewise for !=
1566 if (RHS->isZero()) {
1568 ICI.setOperand(0, II->getArgOperand(0));
1569 ICI.setOperand(1, RHS);
1581 /// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1582 /// We only handle extending casts so far.
1584 Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1585 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1586 Value *LHSCIOp = LHSCI->getOperand(0);
1587 Type *SrcTy = LHSCIOp->getType();
1588 Type *DestTy = LHSCI->getType();
1591 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
1592 // integer type is the same size as the pointer type.
1593 if (TD && LHSCI->getOpcode() == Instruction::PtrToInt &&
1594 TD->getPointerSizeInBits() ==
1595 cast<IntegerType>(DestTy)->getBitWidth()) {
1597 if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) {
1598 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
1599 } else if (PtrToIntInst *RHSC = dyn_cast<PtrToIntInst>(ICI.getOperand(1))) {
1600 RHSOp = RHSC->getOperand(0);
1601 // If the pointer types don't match, insert a bitcast.
1602 if (LHSCIOp->getType() != RHSOp->getType())
1603 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1607 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1610 // The code below only handles extension cast instructions, so far.
1612 if (LHSCI->getOpcode() != Instruction::ZExt &&
1613 LHSCI->getOpcode() != Instruction::SExt)
1616 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1617 bool isSignedCmp = ICI.isSigned();
1619 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1620 // Not an extension from the same type?
1621 RHSCIOp = CI->getOperand(0);
1622 if (RHSCIOp->getType() != LHSCIOp->getType())
1625 // If the signedness of the two casts doesn't agree (i.e. one is a sext
1626 // and the other is a zext), then we can't handle this.
1627 if (CI->getOpcode() != LHSCI->getOpcode())
1630 // Deal with equality cases early.
1631 if (ICI.isEquality())
1632 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1634 // A signed comparison of sign extended values simplifies into a
1635 // signed comparison.
1636 if (isSignedCmp && isSignedExt)
1637 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1639 // The other three cases all fold into an unsigned comparison.
1640 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1643 // If we aren't dealing with a constant on the RHS, exit early
1644 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1648 // Compute the constant that would happen if we truncated to SrcTy then
1649 // reextended to DestTy.
1650 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1651 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
1654 // If the re-extended constant didn't change...
1656 // Deal with equality cases early.
1657 if (ICI.isEquality())
1658 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1660 // A signed comparison of sign extended values simplifies into a
1661 // signed comparison.
1662 if (isSignedExt && isSignedCmp)
1663 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1665 // The other three cases all fold into an unsigned comparison.
1666 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
1669 // The re-extended constant changed so the constant cannot be represented
1670 // in the shorter type. Consequently, we cannot emit a simple comparison.
1671 // All the cases that fold to true or false will have already been handled
1672 // by SimplifyICmpInst, so only deal with the tricky case.
1674 if (isSignedCmp || !isSignedExt)
1677 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
1678 // should have been folded away previously and not enter in here.
1680 // We're performing an unsigned comp with a sign extended value.
1681 // This is true if the input is >= 0. [aka >s -1]
1682 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
1683 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
1685 // Finally, return the value computed.
1686 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
1687 return ReplaceInstUsesWith(ICI, Result);
1689 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
1690 return BinaryOperator::CreateNot(Result);
1693 /// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
1694 /// I = icmp ugt (add (add A, B), CI2), CI1
1695 /// If this is of the form:
1697 /// if (sum+128 >u 255)
1698 /// Then replace it with llvm.sadd.with.overflow.i8.
1700 static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
1701 ConstantInt *CI2, ConstantInt *CI1,
1703 // The transformation we're trying to do here is to transform this into an
1704 // llvm.sadd.with.overflow. To do this, we have to replace the original add
1705 // with a narrower add, and discard the add-with-constant that is part of the
1706 // range check (if we can't eliminate it, this isn't profitable).
1708 // In order to eliminate the add-with-constant, the compare can be its only
1710 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
1711 if (!AddWithCst->hasOneUse()) return 0;
1713 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
1714 if (!CI2->getValue().isPowerOf2()) return 0;
1715 unsigned NewWidth = CI2->getValue().countTrailingZeros();
1716 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return 0;
1718 // The width of the new add formed is 1 more than the bias.
1721 // Check to see that CI1 is an all-ones value with NewWidth bits.
1722 if (CI1->getBitWidth() == NewWidth ||
1723 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
1726 // This is only really a signed overflow check if the inputs have been
1727 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
1728 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
1729 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
1730 if (IC.ComputeNumSignBits(A) < NeededSignBits ||
1731 IC.ComputeNumSignBits(B) < NeededSignBits)
1734 // In order to replace the original add with a narrower
1735 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
1736 // and truncates that discard the high bits of the add. Verify that this is
1738 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
1739 for (Value::use_iterator UI = OrigAdd->use_begin(), E = OrigAdd->use_end();
1741 if (*UI == AddWithCst) continue;
1743 // Only accept truncates for now. We would really like a nice recursive
1744 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
1745 // chain to see which bits of a value are actually demanded. If the
1746 // original add had another add which was then immediately truncated, we
1747 // could still do the transformation.
1748 TruncInst *TI = dyn_cast<TruncInst>(*UI);
1750 TI->getType()->getPrimitiveSizeInBits() > NewWidth) return 0;
1753 // If the pattern matches, truncate the inputs to the narrower type and
1754 // use the sadd_with_overflow intrinsic to efficiently compute both the
1755 // result and the overflow bit.
1756 Module *M = I.getParent()->getParent()->getParent();
1758 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
1759 Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
1762 InstCombiner::BuilderTy *Builder = IC.Builder;
1764 // Put the new code above the original add, in case there are any uses of the
1765 // add between the add and the compare.
1766 Builder->SetInsertPoint(OrigAdd);
1768 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
1769 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
1770 CallInst *Call = Builder->CreateCall2(F, TruncA, TruncB, "sadd");
1771 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
1772 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
1774 // The inner add was the result of the narrow add, zero extended to the
1775 // wider type. Replace it with the result computed by the intrinsic.
1776 IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
1778 // The original icmp gets replaced with the overflow value.
1779 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
1782 static Instruction *ProcessUAddIdiom(Instruction &I, Value *OrigAddV,
1784 // Don't bother doing this transformation for pointers, don't do it for
1786 if (!isa<IntegerType>(OrigAddV->getType())) return 0;
1788 // If the add is a constant expr, then we don't bother transforming it.
1789 Instruction *OrigAdd = dyn_cast<Instruction>(OrigAddV);
1790 if (OrigAdd == 0) return 0;
1792 Value *LHS = OrigAdd->getOperand(0), *RHS = OrigAdd->getOperand(1);
1794 // Put the new code above the original add, in case there are any uses of the
1795 // add between the add and the compare.
1796 InstCombiner::BuilderTy *Builder = IC.Builder;
1797 Builder->SetInsertPoint(OrigAdd);
1799 Module *M = I.getParent()->getParent()->getParent();
1800 Type *Ty = LHS->getType();
1801 Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
1802 CallInst *Call = Builder->CreateCall2(F, LHS, RHS, "uadd");
1803 Value *Add = Builder->CreateExtractValue(Call, 0);
1805 IC.ReplaceInstUsesWith(*OrigAdd, Add);
1807 // The original icmp gets replaced with the overflow value.
1808 return ExtractValueInst::Create(Call, 1, "uadd.overflow");
1811 // DemandedBitsLHSMask - When performing a comparison against a constant,
1812 // it is possible that not all the bits in the LHS are demanded. This helper
1813 // method computes the mask that IS demanded.
1814 static APInt DemandedBitsLHSMask(ICmpInst &I,
1815 unsigned BitWidth, bool isSignCheck) {
1817 return APInt::getSignBit(BitWidth);
1819 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
1820 if (!CI) return APInt::getAllOnesValue(BitWidth);
1821 const APInt &RHS = CI->getValue();
1823 switch (I.getPredicate()) {
1824 // For a UGT comparison, we don't care about any bits that
1825 // correspond to the trailing ones of the comparand. The value of these
1826 // bits doesn't impact the outcome of the comparison, because any value
1827 // greater than the RHS must differ in a bit higher than these due to carry.
1828 case ICmpInst::ICMP_UGT: {
1829 unsigned trailingOnes = RHS.countTrailingOnes();
1830 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
1834 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
1835 // Any value less than the RHS must differ in a higher bit because of carries.
1836 case ICmpInst::ICMP_ULT: {
1837 unsigned trailingZeros = RHS.countTrailingZeros();
1838 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
1843 return APInt::getAllOnesValue(BitWidth);
1848 Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
1849 bool Changed = false;
1850 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1852 /// Orders the operands of the compare so that they are listed from most
1853 /// complex to least complex. This puts constants before unary operators,
1854 /// before binary operators.
1855 if (getComplexity(Op0) < getComplexity(Op1)) {
1857 std::swap(Op0, Op1);
1861 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, TD))
1862 return ReplaceInstUsesWith(I, V);
1864 // comparing -val or val with non-zero is the same as just comparing val
1865 // ie, abs(val) != 0 -> val != 0
1866 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
1868 Value *Cond, *SelectTrue, *SelectFalse;
1869 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
1870 m_Value(SelectFalse)))) {
1871 if (Value *V = dyn_castNegVal(SelectTrue)) {
1872 if (V == SelectFalse)
1873 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
1875 else if (Value *V = dyn_castNegVal(SelectFalse)) {
1876 if (V == SelectTrue)
1877 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
1882 Type *Ty = Op0->getType();
1884 // icmp's with boolean values can always be turned into bitwise operations
1885 if (Ty->isIntegerTy(1)) {
1886 switch (I.getPredicate()) {
1887 default: llvm_unreachable("Invalid icmp instruction!");
1888 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
1889 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
1890 return BinaryOperator::CreateNot(Xor);
1892 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
1893 return BinaryOperator::CreateXor(Op0, Op1);
1895 case ICmpInst::ICMP_UGT:
1896 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
1898 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
1899 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
1900 return BinaryOperator::CreateAnd(Not, Op1);
1902 case ICmpInst::ICMP_SGT:
1903 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
1905 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
1906 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
1907 return BinaryOperator::CreateAnd(Not, Op0);
1909 case ICmpInst::ICMP_UGE:
1910 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
1912 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
1913 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
1914 return BinaryOperator::CreateOr(Not, Op1);
1916 case ICmpInst::ICMP_SGE:
1917 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
1919 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
1920 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
1921 return BinaryOperator::CreateOr(Not, Op0);
1926 unsigned BitWidth = 0;
1927 if (Ty->isIntOrIntVectorTy())
1928 BitWidth = Ty->getScalarSizeInBits();
1929 else if (TD) // Pointers require TD info to get their size.
1930 BitWidth = TD->getTypeSizeInBits(Ty->getScalarType());
1932 bool isSignBit = false;
1934 // See if we are doing a comparison with a constant.
1935 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
1936 Value *A = 0, *B = 0;
1938 // Match the following pattern, which is a common idiom when writing
1939 // overflow-safe integer arithmetic function. The source performs an
1940 // addition in wider type, and explicitly checks for overflow using
1941 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
1942 // sadd_with_overflow intrinsic.
1944 // TODO: This could probably be generalized to handle other overflow-safe
1945 // operations if we worked out the formulas to compute the appropriate
1949 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
1951 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
1952 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
1953 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
1954 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
1958 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
1959 if (I.isEquality() && CI->isZero() &&
1960 match(Op0, m_Sub(m_Value(A), m_Value(B)))) {
1961 // (icmp cond A B) if cond is equality
1962 return new ICmpInst(I.getPredicate(), A, B);
1965 // If we have an icmp le or icmp ge instruction, turn it into the
1966 // appropriate icmp lt or icmp gt instruction. This allows us to rely on
1967 // them being folded in the code below. The SimplifyICmpInst code has
1968 // already handled the edge cases for us, so we just assert on them.
1969 switch (I.getPredicate()) {
1971 case ICmpInst::ICMP_ULE:
1972 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE
1973 return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
1974 ConstantInt::get(CI->getContext(), CI->getValue()+1));
1975 case ICmpInst::ICMP_SLE:
1976 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE
1977 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
1978 ConstantInt::get(CI->getContext(), CI->getValue()+1));
1979 case ICmpInst::ICMP_UGE:
1980 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE
1981 return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
1982 ConstantInt::get(CI->getContext(), CI->getValue()-1));
1983 case ICmpInst::ICMP_SGE:
1984 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE
1985 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
1986 ConstantInt::get(CI->getContext(), CI->getValue()-1));
1989 // If this comparison is a normal comparison, it demands all
1990 // bits, if it is a sign bit comparison, it only demands the sign bit.
1992 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
1995 // See if we can fold the comparison based on range information we can get
1996 // by checking whether bits are known to be zero or one in the input.
1997 if (BitWidth != 0) {
1998 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
1999 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2001 if (SimplifyDemandedBits(I.getOperandUse(0),
2002 DemandedBitsLHSMask(I, BitWidth, isSignBit),
2003 Op0KnownZero, Op0KnownOne, 0))
2005 if (SimplifyDemandedBits(I.getOperandUse(1),
2006 APInt::getAllOnesValue(BitWidth),
2007 Op1KnownZero, Op1KnownOne, 0))
2010 // Given the known and unknown bits, compute a range that the LHS could be
2011 // in. Compute the Min, Max and RHS values based on the known bits. For the
2012 // EQ and NE we use unsigned values.
2013 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2014 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2016 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2018 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2021 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2023 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2027 // If Min and Max are known to be the same, then SimplifyDemandedBits
2028 // figured out that the LHS is a constant. Just constant fold this now so
2029 // that code below can assume that Min != Max.
2030 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2031 return new ICmpInst(I.getPredicate(),
2032 ConstantInt::get(Op0->getType(), Op0Min), Op1);
2033 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2034 return new ICmpInst(I.getPredicate(), Op0,
2035 ConstantInt::get(Op1->getType(), Op1Min));
2037 // Based on the range information we know about the LHS, see if we can
2038 // simplify this comparison. For example, (x&4) < 8 is always true.
2039 switch (I.getPredicate()) {
2040 default: llvm_unreachable("Unknown icmp opcode!");
2041 case ICmpInst::ICMP_EQ: {
2042 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
2043 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2045 // If all bits are known zero except for one, then we know at most one
2046 // bit is set. If the comparison is against zero, then this is a check
2047 // to see if *that* bit is set.
2048 APInt Op0KnownZeroInverted = ~Op0KnownZero;
2049 if (~Op1KnownZero == 0 && Op0KnownZeroInverted.isPowerOf2()) {
2050 // If the LHS is an AND with the same constant, look through it.
2052 ConstantInt *LHSC = 0;
2053 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2054 LHSC->getValue() != Op0KnownZeroInverted)
2057 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
2058 // then turn "((1 << x)&8) == 0" into "x != 3".
2060 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2061 unsigned CmpVal = Op0KnownZeroInverted.countTrailingZeros();
2062 return new ICmpInst(ICmpInst::ICMP_NE, X,
2063 ConstantInt::get(X->getType(), CmpVal));
2066 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
2067 // then turn "((8 >>u x)&1) == 0" into "x != 3".
2069 if (Op0KnownZeroInverted == 1 &&
2070 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
2071 return new ICmpInst(ICmpInst::ICMP_NE, X,
2072 ConstantInt::get(X->getType(),
2073 CI->countTrailingZeros()));
2078 case ICmpInst::ICMP_NE: {
2079 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
2080 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2082 // If all bits are known zero except for one, then we know at most one
2083 // bit is set. If the comparison is against zero, then this is a check
2084 // to see if *that* bit is set.
2085 APInt Op0KnownZeroInverted = ~Op0KnownZero;
2086 if (~Op1KnownZero == 0 && Op0KnownZeroInverted.isPowerOf2()) {
2087 // If the LHS is an AND with the same constant, look through it.
2089 ConstantInt *LHSC = 0;
2090 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2091 LHSC->getValue() != Op0KnownZeroInverted)
2094 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
2095 // then turn "((1 << x)&8) != 0" into "x == 3".
2097 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2098 unsigned CmpVal = Op0KnownZeroInverted.countTrailingZeros();
2099 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2100 ConstantInt::get(X->getType(), CmpVal));
2103 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
2104 // then turn "((8 >>u x)&1) != 0" into "x == 3".
2106 if (Op0KnownZeroInverted == 1 &&
2107 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
2108 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2109 ConstantInt::get(X->getType(),
2110 CI->countTrailingZeros()));
2115 case ICmpInst::ICMP_ULT:
2116 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
2117 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2118 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
2119 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2120 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
2121 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2122 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2123 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
2124 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2125 ConstantInt::get(CI->getContext(), CI->getValue()-1));
2127 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
2128 if (CI->isMinValue(true))
2129 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2130 Constant::getAllOnesValue(Op0->getType()));
2133 case ICmpInst::ICMP_UGT:
2134 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
2135 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2136 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
2137 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2139 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
2140 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2141 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2142 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
2143 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2144 ConstantInt::get(CI->getContext(), CI->getValue()+1));
2146 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
2147 if (CI->isMaxValue(true))
2148 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2149 Constant::getNullValue(Op0->getType()));
2152 case ICmpInst::ICMP_SLT:
2153 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
2154 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2155 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
2156 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2157 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
2158 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2159 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2160 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
2161 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2162 ConstantInt::get(CI->getContext(), CI->getValue()-1));
2165 case ICmpInst::ICMP_SGT:
2166 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
2167 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2168 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
2169 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2171 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
2172 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2173 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2174 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
2175 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2176 ConstantInt::get(CI->getContext(), CI->getValue()+1));
2179 case ICmpInst::ICMP_SGE:
2180 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
2181 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
2182 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2183 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
2184 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2186 case ICmpInst::ICMP_SLE:
2187 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
2188 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
2189 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2190 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
2191 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2193 case ICmpInst::ICMP_UGE:
2194 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
2195 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
2196 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2197 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
2198 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2200 case ICmpInst::ICMP_ULE:
2201 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
2202 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
2203 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2204 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
2205 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2209 // Turn a signed comparison into an unsigned one if both operands
2210 // are known to have the same sign.
2212 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
2213 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
2214 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
2217 // Test if the ICmpInst instruction is used exclusively by a select as
2218 // part of a minimum or maximum operation. If so, refrain from doing
2219 // any other folding. This helps out other analyses which understand
2220 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
2221 // and CodeGen. And in this case, at least one of the comparison
2222 // operands has at least one user besides the compare (the select),
2223 // which would often largely negate the benefit of folding anyway.
2225 if (SelectInst *SI = dyn_cast<SelectInst>(*I.use_begin()))
2226 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
2227 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
2230 // See if we are doing a comparison between a constant and an instruction that
2231 // can be folded into the comparison.
2232 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2233 // Since the RHS is a ConstantInt (CI), if the left hand side is an
2234 // instruction, see if that instruction also has constants so that the
2235 // instruction can be folded into the icmp
2236 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2237 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
2241 // Handle icmp with constant (but not simple integer constant) RHS
2242 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2243 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2244 switch (LHSI->getOpcode()) {
2245 case Instruction::GetElementPtr:
2246 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2247 if (RHSC->isNullValue() &&
2248 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2249 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2250 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2252 case Instruction::PHI:
2253 // Only fold icmp into the PHI if the phi and icmp are in the same
2254 // block. If in the same block, we're encouraging jump threading. If
2255 // not, we are just pessimizing the code by making an i1 phi.
2256 if (LHSI->getParent() == I.getParent())
2257 if (Instruction *NV = FoldOpIntoPhi(I))
2260 case Instruction::Select: {
2261 // If either operand of the select is a constant, we can fold the
2262 // comparison into the select arms, which will cause one to be
2263 // constant folded and the select turned into a bitwise or.
2264 Value *Op1 = 0, *Op2 = 0;
2265 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1)))
2266 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2267 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2)))
2268 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2270 // We only want to perform this transformation if it will not lead to
2271 // additional code. This is true if either both sides of the select
2272 // fold to a constant (in which case the icmp is replaced with a select
2273 // which will usually simplify) or this is the only user of the
2274 // select (in which case we are trading a select+icmp for a simpler
2276 if ((Op1 && Op2) || (LHSI->hasOneUse() && (Op1 || Op2))) {
2278 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
2281 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
2283 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
2287 case Instruction::IntToPtr:
2288 // icmp pred inttoptr(X), null -> icmp pred X, 0
2289 if (RHSC->isNullValue() && TD &&
2290 TD->getIntPtrType(RHSC->getContext()) ==
2291 LHSI->getOperand(0)->getType())
2292 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2293 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2296 case Instruction::Load:
2297 // Try to optimize things like "A[i] > 4" to index computations.
2298 if (GetElementPtrInst *GEP =
2299 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
2300 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
2301 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
2302 !cast<LoadInst>(LHSI)->isVolatile())
2303 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
2310 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
2311 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
2312 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
2314 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
2315 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
2316 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
2319 // Test to see if the operands of the icmp are casted versions of other
2320 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
2322 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
2323 if (Op0->getType()->isPointerTy() &&
2324 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
2325 // We keep moving the cast from the left operand over to the right
2326 // operand, where it can often be eliminated completely.
2327 Op0 = CI->getOperand(0);
2329 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2330 // so eliminate it as well.
2331 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
2332 Op1 = CI2->getOperand(0);
2334 // If Op1 is a constant, we can fold the cast into the constant.
2335 if (Op0->getType() != Op1->getType()) {
2336 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
2337 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
2339 // Otherwise, cast the RHS right before the icmp
2340 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
2343 return new ICmpInst(I.getPredicate(), Op0, Op1);
2347 if (isa<CastInst>(Op0)) {
2348 // Handle the special case of: icmp (cast bool to X), <cst>
2349 // This comes up when you have code like
2352 // For generality, we handle any zero-extension of any operand comparison
2353 // with a constant or another cast from the same type.
2354 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
2355 if (Instruction *R = visitICmpInstWithCastAndCast(I))
2359 // Special logic for binary operators.
2360 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
2361 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
2363 CmpInst::Predicate Pred = I.getPredicate();
2364 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
2365 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
2366 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
2367 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
2368 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
2369 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
2370 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
2371 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
2372 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
2374 // Analyze the case when either Op0 or Op1 is an add instruction.
2375 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
2376 Value *A = 0, *B = 0, *C = 0, *D = 0;
2377 if (BO0 && BO0->getOpcode() == Instruction::Add)
2378 A = BO0->getOperand(0), B = BO0->getOperand(1);
2379 if (BO1 && BO1->getOpcode() == Instruction::Add)
2380 C = BO1->getOperand(0), D = BO1->getOperand(1);
2382 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2383 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
2384 return new ICmpInst(Pred, A == Op1 ? B : A,
2385 Constant::getNullValue(Op1->getType()));
2387 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2388 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
2389 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
2392 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
2393 if (A && C && (A == C || A == D || B == C || B == D) &&
2394 NoOp0WrapProblem && NoOp1WrapProblem &&
2395 // Try not to increase register pressure.
2396 BO0->hasOneUse() && BO1->hasOneUse()) {
2397 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2400 // C + B == C + D -> B == D
2403 } else if (A == D) {
2404 // D + B == C + D -> B == C
2407 } else if (B == C) {
2408 // A + C == C + D -> A == D
2413 // A + D == C + D -> A == C
2417 return new ICmpInst(Pred, Y, Z);
2420 // Analyze the case when either Op0 or Op1 is a sub instruction.
2421 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
2422 A = 0; B = 0; C = 0; D = 0;
2423 if (BO0 && BO0->getOpcode() == Instruction::Sub)
2424 A = BO0->getOperand(0), B = BO0->getOperand(1);
2425 if (BO1 && BO1->getOpcode() == Instruction::Sub)
2426 C = BO1->getOperand(0), D = BO1->getOperand(1);
2428 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
2429 if (A == Op1 && NoOp0WrapProblem)
2430 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
2432 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
2433 if (C == Op0 && NoOp1WrapProblem)
2434 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
2436 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
2437 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
2438 // Try not to increase register pressure.
2439 BO0->hasOneUse() && BO1->hasOneUse())
2440 return new ICmpInst(Pred, A, C);
2442 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
2443 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
2444 // Try not to increase register pressure.
2445 BO0->hasOneUse() && BO1->hasOneUse())
2446 return new ICmpInst(Pred, D, B);
2448 BinaryOperator *SRem = NULL;
2449 // icmp (srem X, Y), Y
2450 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
2451 Op1 == BO0->getOperand(1))
2453 // icmp Y, (srem X, Y)
2454 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
2455 Op0 == BO1->getOperand(1))
2458 // We don't check hasOneUse to avoid increasing register pressure because
2459 // the value we use is the same value this instruction was already using.
2460 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
2462 case ICmpInst::ICMP_EQ:
2463 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2464 case ICmpInst::ICMP_NE:
2465 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2466 case ICmpInst::ICMP_SGT:
2467 case ICmpInst::ICMP_SGE:
2468 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
2469 Constant::getAllOnesValue(SRem->getType()));
2470 case ICmpInst::ICMP_SLT:
2471 case ICmpInst::ICMP_SLE:
2472 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
2473 Constant::getNullValue(SRem->getType()));
2477 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
2478 BO0->hasOneUse() && BO1->hasOneUse() &&
2479 BO0->getOperand(1) == BO1->getOperand(1)) {
2480 switch (BO0->getOpcode()) {
2482 case Instruction::Add:
2483 case Instruction::Sub:
2484 case Instruction::Xor:
2485 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
2486 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2487 BO1->getOperand(0));
2488 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
2489 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
2490 if (CI->getValue().isSignBit()) {
2491 ICmpInst::Predicate Pred = I.isSigned()
2492 ? I.getUnsignedPredicate()
2493 : I.getSignedPredicate();
2494 return new ICmpInst(Pred, BO0->getOperand(0),
2495 BO1->getOperand(0));
2498 if (CI->isMaxValue(true)) {
2499 ICmpInst::Predicate Pred = I.isSigned()
2500 ? I.getUnsignedPredicate()
2501 : I.getSignedPredicate();
2502 Pred = I.getSwappedPredicate(Pred);
2503 return new ICmpInst(Pred, BO0->getOperand(0),
2504 BO1->getOperand(0));
2508 case Instruction::Mul:
2509 if (!I.isEquality())
2512 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
2513 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
2514 // Mask = -1 >> count-trailing-zeros(Cst).
2515 if (!CI->isZero() && !CI->isOne()) {
2516 const APInt &AP = CI->getValue();
2517 ConstantInt *Mask = ConstantInt::get(I.getContext(),
2518 APInt::getLowBitsSet(AP.getBitWidth(),
2520 AP.countTrailingZeros()));
2521 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
2522 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
2523 return new ICmpInst(I.getPredicate(), And1, And2);
2527 case Instruction::UDiv:
2528 case Instruction::LShr:
2532 case Instruction::SDiv:
2533 case Instruction::AShr:
2534 if (!BO0->isExact() || !BO1->isExact())
2536 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2537 BO1->getOperand(0));
2538 case Instruction::Shl: {
2539 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
2540 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
2543 if (!NSW && I.isSigned())
2545 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2546 BO1->getOperand(0));
2553 // ~x < ~y --> y < x
2554 // ~x < cst --> ~cst < x
2555 if (match(Op0, m_Not(m_Value(A)))) {
2556 if (match(Op1, m_Not(m_Value(B))))
2557 return new ICmpInst(I.getPredicate(), B, A);
2558 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
2559 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
2562 // (a+b) <u a --> llvm.uadd.with.overflow.
2563 // (a+b) <u b --> llvm.uadd.with.overflow.
2564 if (I.getPredicate() == ICmpInst::ICMP_ULT &&
2565 match(Op0, m_Add(m_Value(A), m_Value(B))) &&
2566 (Op1 == A || Op1 == B))
2567 if (Instruction *R = ProcessUAddIdiom(I, Op0, *this))
2570 // a >u (a+b) --> llvm.uadd.with.overflow.
2571 // b >u (a+b) --> llvm.uadd.with.overflow.
2572 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
2573 match(Op1, m_Add(m_Value(A), m_Value(B))) &&
2574 (Op0 == A || Op0 == B))
2575 if (Instruction *R = ProcessUAddIdiom(I, Op1, *this))
2579 if (I.isEquality()) {
2580 Value *A, *B, *C, *D;
2582 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
2583 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
2584 Value *OtherVal = A == Op1 ? B : A;
2585 return new ICmpInst(I.getPredicate(), OtherVal,
2586 Constant::getNullValue(A->getType()));
2589 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
2590 // A^c1 == C^c2 --> A == C^(c1^c2)
2591 ConstantInt *C1, *C2;
2592 if (match(B, m_ConstantInt(C1)) &&
2593 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
2594 Constant *NC = ConstantInt::get(I.getContext(),
2595 C1->getValue() ^ C2->getValue());
2596 Value *Xor = Builder->CreateXor(C, NC);
2597 return new ICmpInst(I.getPredicate(), A, Xor);
2600 // A^B == A^D -> B == D
2601 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
2602 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
2603 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
2604 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
2608 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2609 (A == Op0 || B == Op0)) {
2610 // A == (A^B) -> B == 0
2611 Value *OtherVal = A == Op0 ? B : A;
2612 return new ICmpInst(I.getPredicate(), OtherVal,
2613 Constant::getNullValue(A->getType()));
2616 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
2617 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
2618 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
2619 Value *X = 0, *Y = 0, *Z = 0;
2622 X = B; Y = D; Z = A;
2623 } else if (A == D) {
2624 X = B; Y = C; Z = A;
2625 } else if (B == C) {
2626 X = A; Y = D; Z = B;
2627 } else if (B == D) {
2628 X = A; Y = C; Z = B;
2631 if (X) { // Build (X^Y) & Z
2632 Op1 = Builder->CreateXor(X, Y);
2633 Op1 = Builder->CreateAnd(Op1, Z);
2634 I.setOperand(0, Op1);
2635 I.setOperand(1, Constant::getNullValue(Op1->getType()));
2640 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
2641 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
2643 if ((Op0->hasOneUse() &&
2644 match(Op0, m_ZExt(m_Value(A))) &&
2645 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
2646 (Op1->hasOneUse() &&
2647 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
2648 match(Op1, m_ZExt(m_Value(A))))) {
2649 APInt Pow2 = Cst1->getValue() + 1;
2650 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
2651 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
2652 return new ICmpInst(I.getPredicate(), A,
2653 Builder->CreateTrunc(B, A->getType()));
2656 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
2657 // "icmp (and X, mask), cst"
2659 if (Op0->hasOneUse() &&
2660 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
2661 m_ConstantInt(ShAmt))))) &&
2662 match(Op1, m_ConstantInt(Cst1)) &&
2663 // Only do this when A has multiple uses. This is most important to do
2664 // when it exposes other optimizations.
2666 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
2668 if (ShAmt < ASize) {
2670 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
2673 APInt CmpV = Cst1->getValue().zext(ASize);
2676 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
2677 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
2683 Value *X; ConstantInt *Cst;
2685 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
2686 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate(), Op0);
2689 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
2690 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate(), Op1);
2692 return Changed ? &I : 0;
2700 /// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
2702 Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
2705 if (!isa<ConstantFP>(RHSC)) return 0;
2706 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
2708 // Get the width of the mantissa. We don't want to hack on conversions that
2709 // might lose information from the integer, e.g. "i64 -> float"
2710 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
2711 if (MantissaWidth == -1) return 0; // Unknown.
2713 // Check to see that the input is converted from an integer type that is small
2714 // enough that preserves all bits. TODO: check here for "known" sign bits.
2715 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
2716 unsigned InputSize = LHSI->getOperand(0)->getType()->getScalarSizeInBits();
2718 // If this is a uitofp instruction, we need an extra bit to hold the sign.
2719 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
2723 // If the conversion would lose info, don't hack on this.
2724 if ((int)InputSize > MantissaWidth)
2727 // Otherwise, we can potentially simplify the comparison. We know that it
2728 // will always come through as an integer value and we know the constant is
2729 // not a NAN (it would have been previously simplified).
2730 assert(!RHS.isNaN() && "NaN comparison not already folded!");
2732 ICmpInst::Predicate Pred;
2733 switch (I.getPredicate()) {
2734 default: llvm_unreachable("Unexpected predicate!");
2735 case FCmpInst::FCMP_UEQ:
2736 case FCmpInst::FCMP_OEQ:
2737 Pred = ICmpInst::ICMP_EQ;
2739 case FCmpInst::FCMP_UGT:
2740 case FCmpInst::FCMP_OGT:
2741 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
2743 case FCmpInst::FCMP_UGE:
2744 case FCmpInst::FCMP_OGE:
2745 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
2747 case FCmpInst::FCMP_ULT:
2748 case FCmpInst::FCMP_OLT:
2749 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
2751 case FCmpInst::FCMP_ULE:
2752 case FCmpInst::FCMP_OLE:
2753 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
2755 case FCmpInst::FCMP_UNE:
2756 case FCmpInst::FCMP_ONE:
2757 Pred = ICmpInst::ICMP_NE;
2759 case FCmpInst::FCMP_ORD:
2760 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2761 case FCmpInst::FCMP_UNO:
2762 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2765 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
2767 // Now we know that the APFloat is a normal number, zero or inf.
2769 // See if the FP constant is too large for the integer. For example,
2770 // comparing an i8 to 300.0.
2771 unsigned IntWidth = IntTy->getScalarSizeInBits();
2774 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
2775 // and large values.
2776 APFloat SMax(RHS.getSemantics(), APFloat::fcZero, false);
2777 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
2778 APFloat::rmNearestTiesToEven);
2779 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
2780 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
2781 Pred == ICmpInst::ICMP_SLE)
2782 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2783 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2786 // If the RHS value is > UnsignedMax, fold the comparison. This handles
2787 // +INF and large values.
2788 APFloat UMax(RHS.getSemantics(), APFloat::fcZero, false);
2789 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
2790 APFloat::rmNearestTiesToEven);
2791 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
2792 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
2793 Pred == ICmpInst::ICMP_ULE)
2794 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2795 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2800 // See if the RHS value is < SignedMin.
2801 APFloat SMin(RHS.getSemantics(), APFloat::fcZero, false);
2802 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
2803 APFloat::rmNearestTiesToEven);
2804 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
2805 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
2806 Pred == ICmpInst::ICMP_SGE)
2807 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2808 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2811 // See if the RHS value is < UnsignedMin.
2812 APFloat SMin(RHS.getSemantics(), APFloat::fcZero, false);
2813 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
2814 APFloat::rmNearestTiesToEven);
2815 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
2816 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
2817 Pred == ICmpInst::ICMP_UGE)
2818 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2819 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2823 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
2824 // [0, UMAX], but it may still be fractional. See if it is fractional by
2825 // casting the FP value to the integer value and back, checking for equality.
2826 // Don't do this for zero, because -0.0 is not fractional.
2827 Constant *RHSInt = LHSUnsigned
2828 ? ConstantExpr::getFPToUI(RHSC, IntTy)
2829 : ConstantExpr::getFPToSI(RHSC, IntTy);
2830 if (!RHS.isZero()) {
2831 bool Equal = LHSUnsigned
2832 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
2833 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
2835 // If we had a comparison against a fractional value, we have to adjust
2836 // the compare predicate and sometimes the value. RHSC is rounded towards
2837 // zero at this point.
2839 default: llvm_unreachable("Unexpected integer comparison!");
2840 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
2841 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2842 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
2843 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2844 case ICmpInst::ICMP_ULE:
2845 // (float)int <= 4.4 --> int <= 4
2846 // (float)int <= -4.4 --> false
2847 if (RHS.isNegative())
2848 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2850 case ICmpInst::ICMP_SLE:
2851 // (float)int <= 4.4 --> int <= 4
2852 // (float)int <= -4.4 --> int < -4
2853 if (RHS.isNegative())
2854 Pred = ICmpInst::ICMP_SLT;
2856 case ICmpInst::ICMP_ULT:
2857 // (float)int < -4.4 --> false
2858 // (float)int < 4.4 --> int <= 4
2859 if (RHS.isNegative())
2860 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getContext()));
2861 Pred = ICmpInst::ICMP_ULE;
2863 case ICmpInst::ICMP_SLT:
2864 // (float)int < -4.4 --> int < -4
2865 // (float)int < 4.4 --> int <= 4
2866 if (!RHS.isNegative())
2867 Pred = ICmpInst::ICMP_SLE;
2869 case ICmpInst::ICMP_UGT:
2870 // (float)int > 4.4 --> int > 4
2871 // (float)int > -4.4 --> true
2872 if (RHS.isNegative())
2873 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2875 case ICmpInst::ICMP_SGT:
2876 // (float)int > 4.4 --> int > 4
2877 // (float)int > -4.4 --> int >= -4
2878 if (RHS.isNegative())
2879 Pred = ICmpInst::ICMP_SGE;
2881 case ICmpInst::ICMP_UGE:
2882 // (float)int >= -4.4 --> true
2883 // (float)int >= 4.4 --> int > 4
2884 if (RHS.isNegative())
2885 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getContext()));
2886 Pred = ICmpInst::ICMP_UGT;
2888 case ICmpInst::ICMP_SGE:
2889 // (float)int >= -4.4 --> int >= -4
2890 // (float)int >= 4.4 --> int > 4
2891 if (!RHS.isNegative())
2892 Pred = ICmpInst::ICMP_SGT;
2898 // Lower this FP comparison into an appropriate integer version of the
2900 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
2903 Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
2904 bool Changed = false;
2906 /// Orders the operands of the compare so that they are listed from most
2907 /// complex to least complex. This puts constants before unary operators,
2908 /// before binary operators.
2909 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
2914 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2916 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, TD))
2917 return ReplaceInstUsesWith(I, V);
2919 // Simplify 'fcmp pred X, X'
2921 switch (I.getPredicate()) {
2922 default: llvm_unreachable("Unknown predicate!");
2923 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
2924 case FCmpInst::FCMP_ULT: // True if unordered or less than
2925 case FCmpInst::FCMP_UGT: // True if unordered or greater than
2926 case FCmpInst::FCMP_UNE: // True if unordered or not equal
2927 // Canonicalize these to be 'fcmp uno %X, 0.0'.
2928 I.setPredicate(FCmpInst::FCMP_UNO);
2929 I.setOperand(1, Constant::getNullValue(Op0->getType()));
2932 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
2933 case FCmpInst::FCMP_OEQ: // True if ordered and equal
2934 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
2935 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
2936 // Canonicalize these to be 'fcmp ord %X, 0.0'.
2937 I.setPredicate(FCmpInst::FCMP_ORD);
2938 I.setOperand(1, Constant::getNullValue(Op0->getType()));
2943 // Handle fcmp with constant RHS
2944 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2945 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2946 switch (LHSI->getOpcode()) {
2947 case Instruction::FPExt: {
2948 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
2949 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
2950 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
2954 const fltSemantics *Sem;
2955 // FIXME: This shouldn't be here.
2956 if (LHSExt->getSrcTy()->isHalfTy())
2957 Sem = &APFloat::IEEEhalf;
2958 else if (LHSExt->getSrcTy()->isFloatTy())
2959 Sem = &APFloat::IEEEsingle;
2960 else if (LHSExt->getSrcTy()->isDoubleTy())
2961 Sem = &APFloat::IEEEdouble;
2962 else if (LHSExt->getSrcTy()->isFP128Ty())
2963 Sem = &APFloat::IEEEquad;
2964 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
2965 Sem = &APFloat::x87DoubleExtended;
2966 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
2967 Sem = &APFloat::PPCDoubleDouble;
2972 APFloat F = RHSF->getValueAPF();
2973 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
2975 // Avoid lossy conversions and denormals. Zero is a special case
2976 // that's OK to convert.
2980 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
2981 APFloat::cmpLessThan) || Fabs.isZero()))
2983 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
2984 ConstantFP::get(RHSC->getContext(), F));
2987 case Instruction::PHI:
2988 // Only fold fcmp into the PHI if the phi and fcmp are in the same
2989 // block. If in the same block, we're encouraging jump threading. If
2990 // not, we are just pessimizing the code by making an i1 phi.
2991 if (LHSI->getParent() == I.getParent())
2992 if (Instruction *NV = FoldOpIntoPhi(I))
2995 case Instruction::SIToFP:
2996 case Instruction::UIToFP:
2997 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
3000 case Instruction::Select: {
3001 // If either operand of the select is a constant, we can fold the
3002 // comparison into the select arms, which will cause one to be
3003 // constant folded and the select turned into a bitwise or.
3004 Value *Op1 = 0, *Op2 = 0;
3005 if (LHSI->hasOneUse()) {
3006 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
3007 // Fold the known value into the constant operand.
3008 Op1 = ConstantExpr::getCompare(I.getPredicate(), C, RHSC);
3009 // Insert a new FCmp of the other select operand.
3010 Op2 = Builder->CreateFCmp(I.getPredicate(),
3011 LHSI->getOperand(2), RHSC, I.getName());
3012 } else if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
3013 // Fold the known value into the constant operand.
3014 Op2 = ConstantExpr::getCompare(I.getPredicate(), C, RHSC);
3015 // Insert a new FCmp of the other select operand.
3016 Op1 = Builder->CreateFCmp(I.getPredicate(), LHSI->getOperand(1),
3022 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3025 case Instruction::FSub: {
3026 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
3028 if (match(LHSI, m_FNeg(m_Value(Op))))
3029 return new FCmpInst(I.getSwappedPredicate(), Op,
3030 ConstantExpr::getFNeg(RHSC));
3033 case Instruction::Load:
3034 if (GetElementPtrInst *GEP =
3035 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3036 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3037 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3038 !cast<LoadInst>(LHSI)->isVolatile())
3039 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3043 case Instruction::Call: {
3044 CallInst *CI = cast<CallInst>(LHSI);
3046 // Various optimization for fabs compared with zero.
3047 if (RHSC->isNullValue() && CI->getCalledFunction() &&
3048 TLI->getLibFunc(CI->getCalledFunction()->getName(), Func) &&
3050 if (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
3051 Func == LibFunc::fabsl) {
3052 switch (I.getPredicate()) {
3054 // fabs(x) < 0 --> false
3055 case FCmpInst::FCMP_OLT:
3056 return ReplaceInstUsesWith(I, Builder->getFalse());
3057 // fabs(x) > 0 --> x != 0
3058 case FCmpInst::FCMP_OGT:
3059 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0),
3061 // fabs(x) <= 0 --> x == 0
3062 case FCmpInst::FCMP_OLE:
3063 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0),
3065 // fabs(x) >= 0 --> !isnan(x)
3066 case FCmpInst::FCMP_OGE:
3067 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0),
3069 // fabs(x) == 0 --> x == 0
3070 // fabs(x) != 0 --> x != 0
3071 case FCmpInst::FCMP_OEQ:
3072 case FCmpInst::FCMP_UEQ:
3073 case FCmpInst::FCMP_ONE:
3074 case FCmpInst::FCMP_UNE:
3075 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0),
3084 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
3086 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
3087 return new FCmpInst(I.getSwappedPredicate(), X, Y);
3089 // fcmp (fpext x), (fpext y) -> fcmp x, y
3090 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
3091 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
3092 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
3093 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3094 RHSExt->getOperand(0));
3096 return Changed ? &I : 0;