Revert non-test parts of r188507
[oota-llvm.git] / lib / Transforms / InstCombine / InstCombineCompares.cpp
1 //===- InstCombineCompares.cpp --------------------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the visitICmp and visitFCmp functions.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "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"
24 using namespace llvm;
25 using namespace PatternMatch;
26
27 static ConstantInt *getOne(Constant *C) {
28   return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
29 }
30
31 /// AddOne - Add one to a ConstantInt
32 static Constant *AddOne(Constant *C) {
33   return ConstantExpr::getAdd(C, ConstantInt::get(C->getType(), 1));
34 }
35 /// SubOne - Subtract one from a ConstantInt
36 static Constant *SubOne(Constant *C) {
37   return ConstantExpr::getSub(C, ConstantInt::get(C->getType(), 1));
38 }
39
40 static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
41   return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
42 }
43
44 static bool HasAddOverflow(ConstantInt *Result,
45                            ConstantInt *In1, ConstantInt *In2,
46                            bool IsSigned) {
47   if (!IsSigned)
48     return Result->getValue().ult(In1->getValue());
49
50   if (In2->isNegative())
51     return Result->getValue().sgt(In1->getValue());
52   return Result->getValue().slt(In1->getValue());
53 }
54
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);
60
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),
67                          IsSigned))
68         return true;
69     }
70     return false;
71   }
72
73   return HasAddOverflow(cast<ConstantInt>(Result),
74                         cast<ConstantInt>(In1), cast<ConstantInt>(In2),
75                         IsSigned);
76 }
77
78 static bool HasSubOverflow(ConstantInt *Result,
79                            ConstantInt *In1, ConstantInt *In2,
80                            bool IsSigned) {
81   if (!IsSigned)
82     return Result->getValue().ugt(In1->getValue());
83
84   if (In2->isNegative())
85     return Result->getValue().slt(In1->getValue());
86
87   return Result->getValue().sgt(In1->getValue());
88 }
89
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);
95
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),
102                          IsSigned))
103         return true;
104     }
105     return false;
106   }
107
108   return HasSubOverflow(cast<ConstantInt>(Result),
109                         cast<ConstantInt>(In1), cast<ConstantInt>(In2),
110                         IsSigned);
111 }
112
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
116 /// signed.
117 static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
118                            bool &TrueIfSigned) {
119   switch (pred) {
120   case ICmpInst::ICMP_SLT:   // True if LHS s< 0
121     TrueIfSigned = true;
122     return RHS->isZero();
123   case ICmpInst::ICMP_SLE:   // True if LHS s<= RHS and RHS == -1
124     TrueIfSigned = true;
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
131     TrueIfSigned = true;
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)
135     TrueIfSigned = true;
136     return RHS->getValue().isSignBit();
137   default:
138     return false;
139   }
140 }
141
142 /// Returns true if the exploded icmp can be expressed as a signed comparison
143 /// to zero and updates the predicate accordingly.
144 /// The signedness of the comparison is preserved.
145 static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
146   if (!ICmpInst::isSigned(pred))
147     return false;
148
149   if (RHS->isZero())
150     return ICmpInst::isRelational(pred);
151
152   if (RHS->isOne()) {
153     if (pred == ICmpInst::ICMP_SLT) {
154       pred = ICmpInst::ICMP_SLE;
155       return true;
156     }
157   } else if (RHS->isAllOnesValue()) {
158     if (pred == ICmpInst::ICMP_SGT) {
159       pred = ICmpInst::ICMP_SGE;
160       return true;
161     }
162   }
163
164   return false;
165 }
166
167 // isHighOnes - Return true if the constant is of the form 1+0+.
168 // This is the same as lowones(~X).
169 static bool isHighOnes(const ConstantInt *CI) {
170   return (~CI->getValue() + 1).isPowerOf2();
171 }
172
173 /// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
174 /// set of known zero and one bits, compute the maximum and minimum values that
175 /// could have the specified known zero and known one bits, returning them in
176 /// min/max.
177 static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
178                                                    const APInt& KnownOne,
179                                                    APInt& Min, APInt& Max) {
180   assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
181          KnownZero.getBitWidth() == Min.getBitWidth() &&
182          KnownZero.getBitWidth() == Max.getBitWidth() &&
183          "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
184   APInt UnknownBits = ~(KnownZero|KnownOne);
185
186   // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
187   // bit if it is unknown.
188   Min = KnownOne;
189   Max = KnownOne|UnknownBits;
190
191   if (UnknownBits.isNegative()) { // Sign bit is unknown
192     Min.setBit(Min.getBitWidth()-1);
193     Max.clearBit(Max.getBitWidth()-1);
194   }
195 }
196
197 // ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
198 // a set of known zero and one bits, compute the maximum and minimum values that
199 // could have the specified known zero and known one bits, returning them in
200 // min/max.
201 static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
202                                                      const APInt &KnownOne,
203                                                      APInt &Min, APInt &Max) {
204   assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
205          KnownZero.getBitWidth() == Min.getBitWidth() &&
206          KnownZero.getBitWidth() == Max.getBitWidth() &&
207          "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
208   APInt UnknownBits = ~(KnownZero|KnownOne);
209
210   // The minimum value is when the unknown bits are all zeros.
211   Min = KnownOne;
212   // The maximum value is when the unknown bits are all ones.
213   Max = KnownOne|UnknownBits;
214 }
215
216
217
218 /// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
219 ///   cmp pred (load (gep GV, ...)), cmpcst
220 /// where GV is a global variable with a constant initializer.  Try to simplify
221 /// this into some simple computation that does not need the load.  For example
222 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
223 ///
224 /// If AndCst is non-null, then the loaded value is masked with that constant
225 /// before doing the comparison.  This handles cases like "A[i]&4 == 0".
226 Instruction *InstCombiner::
227 FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
228                              CmpInst &ICI, ConstantInt *AndCst) {
229   // We need TD information to know the pointer size unless this is inbounds.
230   if (!GEP->isInBounds() && TD == 0)
231     return 0;
232
233   Constant *Init = GV->getInitializer();
234   if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
235     return 0;
236
237   uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
238   if (ArrayElementCount > 1024) return 0;  // Don't blow up on huge arrays.
239
240   // There are many forms of this optimization we can handle, for now, just do
241   // the simple index into a single-dimensional array.
242   //
243   // Require: GEP GV, 0, i {{, constant indices}}
244   if (GEP->getNumOperands() < 3 ||
245       !isa<ConstantInt>(GEP->getOperand(1)) ||
246       !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
247       isa<Constant>(GEP->getOperand(2)))
248     return 0;
249
250   // Check that indices after the variable are constants and in-range for the
251   // type they index.  Collect the indices.  This is typically for arrays of
252   // structs.
253   SmallVector<unsigned, 4> LaterIndices;
254
255   Type *EltTy = Init->getType()->getArrayElementType();
256   for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
257     ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
258     if (Idx == 0) return 0;  // Variable index.
259
260     uint64_t IdxVal = Idx->getZExtValue();
261     if ((unsigned)IdxVal != IdxVal) return 0; // Too large array index.
262
263     if (StructType *STy = dyn_cast<StructType>(EltTy))
264       EltTy = STy->getElementType(IdxVal);
265     else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
266       if (IdxVal >= ATy->getNumElements()) return 0;
267       EltTy = ATy->getElementType();
268     } else {
269       return 0; // Unknown type.
270     }
271
272     LaterIndices.push_back(IdxVal);
273   }
274
275   enum { Overdefined = -3, Undefined = -2 };
276
277   // Variables for our state machines.
278
279   // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
280   // "i == 47 | i == 87", where 47 is the first index the condition is true for,
281   // and 87 is the second (and last) index.  FirstTrueElement is -2 when
282   // undefined, otherwise set to the first true element.  SecondTrueElement is
283   // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
284   int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
285
286   // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
287   // form "i != 47 & i != 87".  Same state transitions as for true elements.
288   int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
289
290   /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
291   /// define a state machine that triggers for ranges of values that the index
292   /// is true or false for.  This triggers on things like "abbbbc"[i] == 'b'.
293   /// This is -2 when undefined, -3 when overdefined, and otherwise the last
294   /// index in the range (inclusive).  We use -2 for undefined here because we
295   /// use relative comparisons and don't want 0-1 to match -1.
296   int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
297
298   // MagicBitvector - This is a magic bitvector where we set a bit if the
299   // comparison is true for element 'i'.  If there are 64 elements or less in
300   // the array, this will fully represent all the comparison results.
301   uint64_t MagicBitvector = 0;
302
303
304   // Scan the array and see if one of our patterns matches.
305   Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
306   for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
307     Constant *Elt = Init->getAggregateElement(i);
308     if (Elt == 0) return 0;
309
310     // If this is indexing an array of structures, get the structure element.
311     if (!LaterIndices.empty())
312       Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
313
314     // If the element is masked, handle it.
315     if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
316
317     // Find out if the comparison would be true or false for the i'th element.
318     Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
319                                                   CompareRHS, TD, TLI);
320     // If the result is undef for this element, ignore it.
321     if (isa<UndefValue>(C)) {
322       // Extend range state machines to cover this element in case there is an
323       // undef in the middle of the range.
324       if (TrueRangeEnd == (int)i-1)
325         TrueRangeEnd = i;
326       if (FalseRangeEnd == (int)i-1)
327         FalseRangeEnd = i;
328       continue;
329     }
330
331     // If we can't compute the result for any of the elements, we have to give
332     // up evaluating the entire conditional.
333     if (!isa<ConstantInt>(C)) return 0;
334
335     // Otherwise, we know if the comparison is true or false for this element,
336     // update our state machines.
337     bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
338
339     // State machine for single/double/range index comparison.
340     if (IsTrueForElt) {
341       // Update the TrueElement state machine.
342       if (FirstTrueElement == Undefined)
343         FirstTrueElement = TrueRangeEnd = i;  // First true element.
344       else {
345         // Update double-compare state machine.
346         if (SecondTrueElement == Undefined)
347           SecondTrueElement = i;
348         else
349           SecondTrueElement = Overdefined;
350
351         // Update range state machine.
352         if (TrueRangeEnd == (int)i-1)
353           TrueRangeEnd = i;
354         else
355           TrueRangeEnd = Overdefined;
356       }
357     } else {
358       // Update the FalseElement state machine.
359       if (FirstFalseElement == Undefined)
360         FirstFalseElement = FalseRangeEnd = i; // First false element.
361       else {
362         // Update double-compare state machine.
363         if (SecondFalseElement == Undefined)
364           SecondFalseElement = i;
365         else
366           SecondFalseElement = Overdefined;
367
368         // Update range state machine.
369         if (FalseRangeEnd == (int)i-1)
370           FalseRangeEnd = i;
371         else
372           FalseRangeEnd = Overdefined;
373       }
374     }
375
376
377     // If this element is in range, update our magic bitvector.
378     if (i < 64 && IsTrueForElt)
379       MagicBitvector |= 1ULL << i;
380
381     // If all of our states become overdefined, bail out early.  Since the
382     // predicate is expensive, only check it every 8 elements.  This is only
383     // really useful for really huge arrays.
384     if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
385         SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
386         FalseRangeEnd == Overdefined)
387       return 0;
388   }
389
390   // Now that we've scanned the entire array, emit our new comparison(s).  We
391   // order the state machines in complexity of the generated code.
392   Value *Idx = GEP->getOperand(2);
393
394   // If the index is larger than the pointer size of the target, truncate the
395   // index down like the GEP would do implicitly.  We don't have to do this for
396   // an inbounds GEP because the index can't be out of range.
397   if (!GEP->isInBounds() &&
398       Idx->getType()->getPrimitiveSizeInBits() > TD->getPointerSizeInBits())
399     Idx = Builder->CreateTrunc(Idx, TD->getIntPtrType(Idx->getContext()));
400
401   // If the comparison is only true for one or two elements, emit direct
402   // comparisons.
403   if (SecondTrueElement != Overdefined) {
404     // None true -> false.
405     if (FirstTrueElement == Undefined)
406       return ReplaceInstUsesWith(ICI, Builder->getFalse());
407
408     Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
409
410     // True for one element -> 'i == 47'.
411     if (SecondTrueElement == Undefined)
412       return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
413
414     // True for two elements -> 'i == 47 | i == 72'.
415     Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
416     Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
417     Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
418     return BinaryOperator::CreateOr(C1, C2);
419   }
420
421   // If the comparison is only false for one or two elements, emit direct
422   // comparisons.
423   if (SecondFalseElement != Overdefined) {
424     // None false -> true.
425     if (FirstFalseElement == Undefined)
426       return ReplaceInstUsesWith(ICI, Builder->getTrue());
427
428     Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
429
430     // False for one element -> 'i != 47'.
431     if (SecondFalseElement == Undefined)
432       return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
433
434     // False for two elements -> 'i != 47 & i != 72'.
435     Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
436     Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
437     Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
438     return BinaryOperator::CreateAnd(C1, C2);
439   }
440
441   // If the comparison can be replaced with a range comparison for the elements
442   // where it is true, emit the range check.
443   if (TrueRangeEnd != Overdefined) {
444     assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
445
446     // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
447     if (FirstTrueElement) {
448       Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
449       Idx = Builder->CreateAdd(Idx, Offs);
450     }
451
452     Value *End = ConstantInt::get(Idx->getType(),
453                                   TrueRangeEnd-FirstTrueElement+1);
454     return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
455   }
456
457   // False range check.
458   if (FalseRangeEnd != Overdefined) {
459     assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
460     // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
461     if (FirstFalseElement) {
462       Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
463       Idx = Builder->CreateAdd(Idx, Offs);
464     }
465
466     Value *End = ConstantInt::get(Idx->getType(),
467                                   FalseRangeEnd-FirstFalseElement);
468     return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
469   }
470
471
472   // If a magic bitvector captures the entire comparison state
473   // of this load, replace it with computation that does:
474   //   ((magic_cst >> i) & 1) != 0
475   {
476     Type *Ty = 0;
477
478     // Look for an appropriate type:
479     // - The type of Idx if the magic fits
480     // - The smallest fitting legal type if we have a DataLayout
481     // - Default to i32
482     if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
483       Ty = Idx->getType();
484     else if (TD)
485       Ty = TD->getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
486     else if (ArrayElementCount <= 32)
487       Ty = Type::getInt32Ty(Init->getContext());
488
489     if (Ty != 0) {
490       Value *V = Builder->CreateIntCast(Idx, Ty, false);
491       V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
492       V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
493       return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
494     }
495   }
496
497   return 0;
498 }
499
500
501 /// EvaluateGEPOffsetExpression - Return a value that can be used to compare
502 /// the *offset* implied by a GEP to zero.  For example, if we have &A[i], we
503 /// want to return 'i' for "icmp ne i, 0".  Note that, in general, indices can
504 /// be complex, and scales are involved.  The above expression would also be
505 /// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
506 /// This later form is less amenable to optimization though, and we are allowed
507 /// to generate the first by knowing that pointer arithmetic doesn't overflow.
508 ///
509 /// If we can't emit an optimized form for this expression, this returns null.
510 ///
511 static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC) {
512   DataLayout &TD = *IC.getDataLayout();
513   gep_type_iterator GTI = gep_type_begin(GEP);
514
515   // Check to see if this gep only has a single variable index.  If so, and if
516   // any constant indices are a multiple of its scale, then we can compute this
517   // in terms of the scale of the variable index.  For example, if the GEP
518   // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
519   // because the expression will cross zero at the same point.
520   unsigned i, e = GEP->getNumOperands();
521   int64_t Offset = 0;
522   for (i = 1; i != e; ++i, ++GTI) {
523     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
524       // Compute the aggregate offset of constant indices.
525       if (CI->isZero()) continue;
526
527       // Handle a struct index, which adds its field offset to the pointer.
528       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
529         Offset += TD.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
530       } else {
531         uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
532         Offset += Size*CI->getSExtValue();
533       }
534     } else {
535       // Found our variable index.
536       break;
537     }
538   }
539
540   // If there are no variable indices, we must have a constant offset, just
541   // evaluate it the general way.
542   if (i == e) return 0;
543
544   Value *VariableIdx = GEP->getOperand(i);
545   // Determine the scale factor of the variable element.  For example, this is
546   // 4 if the variable index is into an array of i32.
547   uint64_t VariableScale = TD.getTypeAllocSize(GTI.getIndexedType());
548
549   // Verify that there are no other variable indices.  If so, emit the hard way.
550   for (++i, ++GTI; i != e; ++i, ++GTI) {
551     ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
552     if (!CI) return 0;
553
554     // Compute the aggregate offset of constant indices.
555     if (CI->isZero()) continue;
556
557     // Handle a struct index, which adds its field offset to the pointer.
558     if (StructType *STy = dyn_cast<StructType>(*GTI)) {
559       Offset += TD.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
560     } else {
561       uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
562       Offset += Size*CI->getSExtValue();
563     }
564   }
565
566   // Okay, we know we have a single variable index, which must be a
567   // pointer/array/vector index.  If there is no offset, life is simple, return
568   // the index.
569   unsigned IntPtrWidth = TD.getPointerSizeInBits();
570   if (Offset == 0) {
571     // Cast to intptrty in case a truncation occurs.  If an extension is needed,
572     // we don't need to bother extending: the extension won't affect where the
573     // computation crosses zero.
574     if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
575       Type *IntPtrTy = TD.getIntPtrType(VariableIdx->getContext());
576       VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
577     }
578     return VariableIdx;
579   }
580
581   // Otherwise, there is an index.  The computation we will do will be modulo
582   // the pointer size, so get it.
583   uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
584
585   Offset &= PtrSizeMask;
586   VariableScale &= PtrSizeMask;
587
588   // To do this transformation, any constant index must be a multiple of the
589   // variable scale factor.  For example, we can evaluate "12 + 4*i" as "3 + i",
590   // but we can't evaluate "10 + 3*i" in terms of i.  Check that the offset is a
591   // multiple of the variable scale.
592   int64_t NewOffs = Offset / (int64_t)VariableScale;
593   if (Offset != NewOffs*(int64_t)VariableScale)
594     return 0;
595
596   // Okay, we can do this evaluation.  Start by converting the index to intptr.
597   Type *IntPtrTy = TD.getIntPtrType(VariableIdx->getContext());
598   if (VariableIdx->getType() != IntPtrTy)
599     VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
600                                             true /*Signed*/);
601   Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
602   return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
603 }
604
605 /// FoldGEPICmp - Fold comparisons between a GEP instruction and something
606 /// else.  At this point we know that the GEP is on the LHS of the comparison.
607 Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
608                                        ICmpInst::Predicate Cond,
609                                        Instruction &I) {
610   // Don't transform signed compares of GEPs into index compares. Even if the
611   // GEP is inbounds, the final add of the base pointer can have signed overflow
612   // and would change the result of the icmp.
613   // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
614   // the maximum signed value for the pointer type.
615   if (ICmpInst::isSigned(Cond))
616     return 0;
617
618   // Look through bitcasts.
619   if (BitCastInst *BCI = dyn_cast<BitCastInst>(RHS))
620     RHS = BCI->getOperand(0);
621
622   Value *PtrBase = GEPLHS->getOperand(0);
623   if (TD && PtrBase == RHS && GEPLHS->isInBounds()) {
624     // ((gep Ptr, OFFSET) cmp Ptr)   ---> (OFFSET cmp 0).
625     // This transformation (ignoring the base and scales) is valid because we
626     // know pointers can't overflow since the gep is inbounds.  See if we can
627     // output an optimized form.
628     Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this);
629
630     // If not, synthesize the offset the hard way.
631     if (Offset == 0)
632       Offset = EmitGEPOffset(GEPLHS);
633     return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
634                         Constant::getNullValue(Offset->getType()));
635   } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
636     // If the base pointers are different, but the indices are the same, just
637     // compare the base pointer.
638     if (PtrBase != GEPRHS->getOperand(0)) {
639       bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
640       IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
641                         GEPRHS->getOperand(0)->getType();
642       if (IndicesTheSame)
643         for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
644           if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
645             IndicesTheSame = false;
646             break;
647           }
648
649       // If all indices are the same, just compare the base pointers.
650       if (IndicesTheSame)
651         return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
652
653       // If we're comparing GEPs with two base pointers that only differ in type
654       // and both GEPs have only constant indices or just one use, then fold
655       // the compare with the adjusted indices.
656       if (TD && GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
657           (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
658           (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
659           PtrBase->stripPointerCasts() ==
660             GEPRHS->getOperand(0)->stripPointerCasts()) {
661         Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
662                                          EmitGEPOffset(GEPLHS),
663                                          EmitGEPOffset(GEPRHS));
664         return ReplaceInstUsesWith(I, Cmp);
665       }
666
667       // Otherwise, the base pointers are different and the indices are
668       // different, bail out.
669       return 0;
670     }
671
672     // If one of the GEPs has all zero indices, recurse.
673     bool AllZeros = true;
674     for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
675       if (!isa<Constant>(GEPLHS->getOperand(i)) ||
676           !cast<Constant>(GEPLHS->getOperand(i))->isNullValue()) {
677         AllZeros = false;
678         break;
679       }
680     if (AllZeros)
681       return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
682                          ICmpInst::getSwappedPredicate(Cond), I);
683
684     // If the other GEP has all zero indices, recurse.
685     AllZeros = true;
686     for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
687       if (!isa<Constant>(GEPRHS->getOperand(i)) ||
688           !cast<Constant>(GEPRHS->getOperand(i))->isNullValue()) {
689         AllZeros = false;
690         break;
691       }
692     if (AllZeros)
693       return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
694
695     bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
696     if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
697       // If the GEPs only differ by one index, compare it.
698       unsigned NumDifferences = 0;  // Keep track of # differences.
699       unsigned DiffOperand = 0;     // The operand that differs.
700       for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
701         if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
702           if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
703                    GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
704             // Irreconcilable differences.
705             NumDifferences = 2;
706             break;
707           } else {
708             if (NumDifferences++) break;
709             DiffOperand = i;
710           }
711         }
712
713       if (NumDifferences == 0)   // SAME GEP?
714         return ReplaceInstUsesWith(I, // No comparison is needed here.
715                              Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
716
717       else if (NumDifferences == 1 && GEPsInBounds) {
718         Value *LHSV = GEPLHS->getOperand(DiffOperand);
719         Value *RHSV = GEPRHS->getOperand(DiffOperand);
720         // Make sure we do a signed comparison here.
721         return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
722       }
723     }
724
725     // Only lower this if the icmp is the only user of the GEP or if we expect
726     // the result to fold to a constant!
727     if (TD &&
728         GEPsInBounds &&
729         (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
730         (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
731       // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)  --->  (OFFSET1 cmp OFFSET2)
732       Value *L = EmitGEPOffset(GEPLHS);
733       Value *R = EmitGEPOffset(GEPRHS);
734       return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
735     }
736   }
737   return 0;
738 }
739
740 /// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
741 Instruction *InstCombiner::FoldICmpAddOpCst(ICmpInst &ICI,
742                                             Value *X, ConstantInt *CI,
743                                             ICmpInst::Predicate Pred,
744                                             Value *TheAdd) {
745   // If we have X+0, exit early (simplifying logic below) and let it get folded
746   // elsewhere.   icmp X+0, X  -> icmp X, X
747   if (CI->isZero()) {
748     bool isTrue = ICmpInst::isTrueWhenEqual(Pred);
749     return ReplaceInstUsesWith(ICI, ConstantInt::get(ICI.getType(), isTrue));
750   }
751
752   // (X+4) == X -> false.
753   if (Pred == ICmpInst::ICMP_EQ)
754     return ReplaceInstUsesWith(ICI, Builder->getFalse());
755
756   // (X+4) != X -> true.
757   if (Pred == ICmpInst::ICMP_NE)
758     return ReplaceInstUsesWith(ICI, Builder->getTrue());
759
760   // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
761   // so the values can never be equal.  Similarly for all other "or equals"
762   // operators.
763
764   // (X+1) <u X        --> X >u (MAXUINT-1)        --> X == 255
765   // (X+2) <u X        --> X >u (MAXUINT-2)        --> X > 253
766   // (X+MAXUINT) <u X  --> X >u (MAXUINT-MAXUINT)  --> X != 0
767   if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
768     Value *R =
769       ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
770     return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
771   }
772
773   // (X+1) >u X        --> X <u (0-1)        --> X != 255
774   // (X+2) >u X        --> X <u (0-2)        --> X <u 254
775   // (X+MAXUINT) >u X  --> X <u (0-MAXUINT)  --> X <u 1  --> X == 0
776   if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
777     return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
778
779   unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
780   ConstantInt *SMax = ConstantInt::get(X->getContext(),
781                                        APInt::getSignedMaxValue(BitWidth));
782
783   // (X+ 1) <s X       --> X >s (MAXSINT-1)          --> X == 127
784   // (X+ 2) <s X       --> X >s (MAXSINT-2)          --> X >s 125
785   // (X+MAXSINT) <s X  --> X >s (MAXSINT-MAXSINT)    --> X >s 0
786   // (X+MINSINT) <s X  --> X >s (MAXSINT-MINSINT)    --> X >s -1
787   // (X+ -2) <s X      --> X >s (MAXSINT- -2)        --> X >s 126
788   // (X+ -1) <s X      --> X >s (MAXSINT- -1)        --> X != 127
789   if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
790     return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
791
792   // (X+ 1) >s X       --> X <s (MAXSINT-(1-1))       --> X != 127
793   // (X+ 2) >s X       --> X <s (MAXSINT-(2-1))       --> X <s 126
794   // (X+MAXSINT) >s X  --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
795   // (X+MINSINT) >s X  --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
796   // (X+ -2) >s X      --> X <s (MAXSINT-(-2-1))      --> X <s -126
797   // (X+ -1) >s X      --> X <s (MAXSINT-(-1-1))      --> X == -128
798
799   assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
800   Constant *C = Builder->getInt(CI->getValue()-1);
801   return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
802 }
803
804 /// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
805 /// and CmpRHS are both known to be integer constants.
806 Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
807                                           ConstantInt *DivRHS) {
808   ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
809   const APInt &CmpRHSV = CmpRHS->getValue();
810
811   // FIXME: If the operand types don't match the type of the divide
812   // then don't attempt this transform. The code below doesn't have the
813   // logic to deal with a signed divide and an unsigned compare (and
814   // vice versa). This is because (x /s C1) <s C2  produces different
815   // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
816   // (x /u C1) <u C2.  Simply casting the operands and result won't
817   // work. :(  The if statement below tests that condition and bails
818   // if it finds it.
819   bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
820   if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
821     return 0;
822   if (DivRHS->isZero())
823     return 0; // The ProdOV computation fails on divide by zero.
824   if (DivIsSigned && DivRHS->isAllOnesValue())
825     return 0; // The overflow computation also screws up here
826   if (DivRHS->isOne()) {
827     // This eliminates some funny cases with INT_MIN.
828     ICI.setOperand(0, DivI->getOperand(0));   // X/1 == X.
829     return &ICI;
830   }
831
832   // Compute Prod = CI * DivRHS. We are essentially solving an equation
833   // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
834   // C2 (CI). By solving for X we can turn this into a range check
835   // instead of computing a divide.
836   Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
837
838   // Determine if the product overflows by seeing if the product is
839   // not equal to the divide. Make sure we do the same kind of divide
840   // as in the LHS instruction that we're folding.
841   bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
842                  ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
843
844   // Get the ICmp opcode
845   ICmpInst::Predicate Pred = ICI.getPredicate();
846
847   /// If the division is known to be exact, then there is no remainder from the
848   /// divide, so the covered range size is unit, otherwise it is the divisor.
849   ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
850
851   // Figure out the interval that is being checked.  For example, a comparison
852   // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
853   // Compute this interval based on the constants involved and the signedness of
854   // the compare/divide.  This computes a half-open interval, keeping track of
855   // whether either value in the interval overflows.  After analysis each
856   // overflow variable is set to 0 if it's corresponding bound variable is valid
857   // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
858   int LoOverflow = 0, HiOverflow = 0;
859   Constant *LoBound = 0, *HiBound = 0;
860
861   if (!DivIsSigned) {  // udiv
862     // e.g. X/5 op 3  --> [15, 20)
863     LoBound = Prod;
864     HiOverflow = LoOverflow = ProdOV;
865     if (!HiOverflow) {
866       // If this is not an exact divide, then many values in the range collapse
867       // to the same result value.
868       HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
869     }
870
871   } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
872     if (CmpRHSV == 0) {       // (X / pos) op 0
873       // Can't overflow.  e.g.  X/2 op 0 --> [-1, 2)
874       LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
875       HiBound = RangeSize;
876     } else if (CmpRHSV.isStrictlyPositive()) {   // (X / pos) op pos
877       LoBound = Prod;     // e.g.   X/5 op 3 --> [15, 20)
878       HiOverflow = LoOverflow = ProdOV;
879       if (!HiOverflow)
880         HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
881     } else {                       // (X / pos) op neg
882       // e.g. X/5 op -3  --> [-15-4, -15+1) --> [-19, -14)
883       HiBound = AddOne(Prod);
884       LoOverflow = HiOverflow = ProdOV ? -1 : 0;
885       if (!LoOverflow) {
886         ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
887         LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
888       }
889     }
890   } else if (DivRHS->isNegative()) { // Divisor is < 0.
891     if (DivI->isExact())
892       RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
893     if (CmpRHSV == 0) {       // (X / neg) op 0
894       // e.g. X/-5 op 0  --> [-4, 5)
895       LoBound = AddOne(RangeSize);
896       HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
897       if (HiBound == DivRHS) {     // -INTMIN = INTMIN
898         HiOverflow = 1;            // [INTMIN+1, overflow)
899         HiBound = 0;               // e.g. X/INTMIN = 0 --> X > INTMIN
900       }
901     } else if (CmpRHSV.isStrictlyPositive()) {   // (X / neg) op pos
902       // e.g. X/-5 op 3  --> [-19, -14)
903       HiBound = AddOne(Prod);
904       HiOverflow = LoOverflow = ProdOV ? -1 : 0;
905       if (!LoOverflow)
906         LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
907     } else {                       // (X / neg) op neg
908       LoBound = Prod;       // e.g. X/-5 op -3  --> [15, 20)
909       LoOverflow = HiOverflow = ProdOV;
910       if (!HiOverflow)
911         HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
912     }
913
914     // Dividing by a negative swaps the condition.  LT <-> GT
915     Pred = ICmpInst::getSwappedPredicate(Pred);
916   }
917
918   Value *X = DivI->getOperand(0);
919   switch (Pred) {
920   default: llvm_unreachable("Unhandled icmp opcode!");
921   case ICmpInst::ICMP_EQ:
922     if (LoOverflow && HiOverflow)
923       return ReplaceInstUsesWith(ICI, Builder->getFalse());
924     if (HiOverflow)
925       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
926                           ICmpInst::ICMP_UGE, X, LoBound);
927     if (LoOverflow)
928       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
929                           ICmpInst::ICMP_ULT, X, HiBound);
930     return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
931                                                     DivIsSigned, true));
932   case ICmpInst::ICMP_NE:
933     if (LoOverflow && HiOverflow)
934       return ReplaceInstUsesWith(ICI, Builder->getTrue());
935     if (HiOverflow)
936       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
937                           ICmpInst::ICMP_ULT, X, LoBound);
938     if (LoOverflow)
939       return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
940                           ICmpInst::ICMP_UGE, X, HiBound);
941     return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
942                                                     DivIsSigned, false));
943   case ICmpInst::ICMP_ULT:
944   case ICmpInst::ICMP_SLT:
945     if (LoOverflow == +1)   // Low bound is greater than input range.
946       return ReplaceInstUsesWith(ICI, Builder->getTrue());
947     if (LoOverflow == -1)   // Low bound is less than input range.
948       return ReplaceInstUsesWith(ICI, Builder->getFalse());
949     return new ICmpInst(Pred, X, LoBound);
950   case ICmpInst::ICMP_UGT:
951   case ICmpInst::ICMP_SGT:
952     if (HiOverflow == +1)       // High bound greater than input range.
953       return ReplaceInstUsesWith(ICI, Builder->getFalse());
954     if (HiOverflow == -1)       // High bound less than input range.
955       return ReplaceInstUsesWith(ICI, Builder->getTrue());
956     if (Pred == ICmpInst::ICMP_UGT)
957       return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
958     return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
959   }
960 }
961
962 /// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
963 Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
964                                           ConstantInt *ShAmt) {
965   const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
966
967   // Check that the shift amount is in range.  If not, don't perform
968   // undefined shifts.  When the shift is visited it will be
969   // simplified.
970   uint32_t TypeBits = CmpRHSV.getBitWidth();
971   uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
972   if (ShAmtVal >= TypeBits || ShAmtVal == 0)
973     return 0;
974
975   if (!ICI.isEquality()) {
976     // If we have an unsigned comparison and an ashr, we can't simplify this.
977     // Similarly for signed comparisons with lshr.
978     if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
979       return 0;
980
981     // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
982     // by a power of 2.  Since we already have logic to simplify these,
983     // transform to div and then simplify the resultant comparison.
984     if (Shr->getOpcode() == Instruction::AShr &&
985         (!Shr->isExact() || ShAmtVal == TypeBits - 1))
986       return 0;
987
988     // Revisit the shift (to delete it).
989     Worklist.Add(Shr);
990
991     Constant *DivCst =
992       ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
993
994     Value *Tmp =
995       Shr->getOpcode() == Instruction::AShr ?
996       Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
997       Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
998
999     ICI.setOperand(0, Tmp);
1000
1001     // If the builder folded the binop, just return it.
1002     BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
1003     if (TheDiv == 0)
1004       return &ICI;
1005
1006     // Otherwise, fold this div/compare.
1007     assert(TheDiv->getOpcode() == Instruction::SDiv ||
1008            TheDiv->getOpcode() == Instruction::UDiv);
1009
1010     Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
1011     assert(Res && "This div/cst should have folded!");
1012     return Res;
1013   }
1014
1015
1016   // If we are comparing against bits always shifted out, the
1017   // comparison cannot succeed.
1018   APInt Comp = CmpRHSV << ShAmtVal;
1019   ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
1020   if (Shr->getOpcode() == Instruction::LShr)
1021     Comp = Comp.lshr(ShAmtVal);
1022   else
1023     Comp = Comp.ashr(ShAmtVal);
1024
1025   if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1026     bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1027     Constant *Cst = Builder->getInt1(IsICMP_NE);
1028     return ReplaceInstUsesWith(ICI, Cst);
1029   }
1030
1031   // Otherwise, check to see if the bits shifted out are known to be zero.
1032   // If so, we can compare against the unshifted value:
1033   //  (X & 4) >> 1 == 2  --> (X & 4) == 4.
1034   if (Shr->hasOneUse() && Shr->isExact())
1035     return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
1036
1037   if (Shr->hasOneUse()) {
1038     // Otherwise strength reduce the shift into an and.
1039     APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
1040     Constant *Mask = Builder->getInt(Val);
1041
1042     Value *And = Builder->CreateAnd(Shr->getOperand(0),
1043                                     Mask, Shr->getName()+".mask");
1044     return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1045   }
1046   return 0;
1047 }
1048
1049
1050 /// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1051 ///
1052 Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1053                                                           Instruction *LHSI,
1054                                                           ConstantInt *RHS) {
1055   const APInt &RHSV = RHS->getValue();
1056
1057   switch (LHSI->getOpcode()) {
1058   case Instruction::Trunc:
1059     if (ICI.isEquality() && LHSI->hasOneUse()) {
1060       // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1061       // of the high bits truncated out of x are known.
1062       unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1063              SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
1064       APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
1065       ComputeMaskedBits(LHSI->getOperand(0), KnownZero, KnownOne);
1066
1067       // If all the high bits are known, we can do this xform.
1068       if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1069         // Pull in the high bits from known-ones set.
1070         APInt NewRHS = RHS->getValue().zext(SrcBits);
1071         NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
1072         return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1073                             Builder->getInt(NewRHS));
1074       }
1075     }
1076     break;
1077
1078   case Instruction::Xor:         // (icmp pred (xor X, XorCST), CI)
1079     if (ConstantInt *XorCST = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1080       // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1081       // fold the xor.
1082       if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1083           (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1084         Value *CompareVal = LHSI->getOperand(0);
1085
1086         // If the sign bit of the XorCST is not set, there is no change to
1087         // the operation, just stop using the Xor.
1088         if (!XorCST->isNegative()) {
1089           ICI.setOperand(0, CompareVal);
1090           Worklist.Add(LHSI);
1091           return &ICI;
1092         }
1093
1094         // Was the old condition true if the operand is positive?
1095         bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
1096
1097         // If so, the new one isn't.
1098         isTrueIfPositive ^= true;
1099
1100         if (isTrueIfPositive)
1101           return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1102                               SubOne(RHS));
1103         else
1104           return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1105                               AddOne(RHS));
1106       }
1107
1108       if (LHSI->hasOneUse()) {
1109         // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
1110         if (!ICI.isEquality() && XorCST->getValue().isSignBit()) {
1111           const APInt &SignBit = XorCST->getValue();
1112           ICmpInst::Predicate Pred = ICI.isSigned()
1113                                          ? ICI.getUnsignedPredicate()
1114                                          : ICI.getSignedPredicate();
1115           return new ICmpInst(Pred, LHSI->getOperand(0),
1116                               Builder->getInt(RHSV ^ SignBit));
1117         }
1118
1119         // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
1120         if (!ICI.isEquality() && XorCST->isMaxValue(true)) {
1121           const APInt &NotSignBit = XorCST->getValue();
1122           ICmpInst::Predicate Pred = ICI.isSigned()
1123                                          ? ICI.getUnsignedPredicate()
1124                                          : ICI.getSignedPredicate();
1125           Pred = ICI.getSwappedPredicate(Pred);
1126           return new ICmpInst(Pred, LHSI->getOperand(0),
1127                               Builder->getInt(RHSV ^ NotSignBit));
1128         }
1129       }
1130
1131       // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1132       //   iff -C is a power of 2
1133       if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
1134           XorCST->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1135         return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCST);
1136
1137       // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1138       //   iff -C is a power of 2
1139       if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
1140           XorCST->getValue() == -RHSV && RHSV.isPowerOf2())
1141         return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCST);
1142     }
1143     break;
1144   case Instruction::And:         // (icmp pred (and X, AndCST), RHS)
1145     if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1146         LHSI->getOperand(0)->hasOneUse()) {
1147       ConstantInt *AndCST = cast<ConstantInt>(LHSI->getOperand(1));
1148
1149       // If the LHS is an AND of a truncating cast, we can widen the
1150       // and/compare to be the input width without changing the value
1151       // produced, eliminating a cast.
1152       if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1153         // We can do this transformation if either the AND constant does not
1154         // have its sign bit set or if it is an equality comparison.
1155         // Extending a relational comparison when we're checking the sign
1156         // bit would not work.
1157         if (ICI.isEquality() ||
1158             (!AndCST->isNegative() && RHSV.isNonNegative())) {
1159           Value *NewAnd =
1160             Builder->CreateAnd(Cast->getOperand(0),
1161                                ConstantExpr::getZExt(AndCST, Cast->getSrcTy()));
1162           NewAnd->takeName(LHSI);
1163           return new ICmpInst(ICI.getPredicate(), NewAnd,
1164                               ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
1165         }
1166       }
1167
1168       // If the LHS is an AND of a zext, and we have an equality compare, we can
1169       // shrink the and/compare to the smaller type, eliminating the cast.
1170       if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
1171         IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
1172         // Make sure we don't compare the upper bits, SimplifyDemandedBits
1173         // should fold the icmp to true/false in that case.
1174         if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1175           Value *NewAnd =
1176             Builder->CreateAnd(Cast->getOperand(0),
1177                                ConstantExpr::getTrunc(AndCST, Ty));
1178           NewAnd->takeName(LHSI);
1179           return new ICmpInst(ICI.getPredicate(), NewAnd,
1180                               ConstantExpr::getTrunc(RHS, Ty));
1181         }
1182       }
1183
1184       // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1185       // could exist), turn it into (X & (C2 << C1)) != (C3 << C1).  This
1186       // happens a LOT in code produced by the C front-end, for bitfield
1187       // access.
1188       BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1189       if (Shift && !Shift->isShift())
1190         Shift = 0;
1191
1192       ConstantInt *ShAmt;
1193       ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : 0;
1194       Type *Ty = Shift ? Shift->getType() : 0;  // Type of the shift.
1195       Type *AndTy = AndCST->getType();          // Type of the and.
1196
1197       // We can fold this as long as we can't shift unknown bits
1198       // into the mask.  This can only happen with signed shift
1199       // rights, as they sign-extend.
1200       if (ShAmt) {
1201         bool CanFold = Shift->isLogicalShift();
1202         if (!CanFold) {
1203           // To test for the bad case of the signed shr, see if any
1204           // of the bits shifted in could be tested after the mask.
1205           uint32_t TyBits = Ty->getPrimitiveSizeInBits();
1206           int ShAmtVal = TyBits - ShAmt->getLimitedValue(TyBits);
1207
1208           uint32_t BitWidth = AndTy->getPrimitiveSizeInBits();
1209           if ((APInt::getHighBitsSet(BitWidth, BitWidth-ShAmtVal) &
1210                AndCST->getValue()) == 0)
1211             CanFold = true;
1212         }
1213
1214         if (CanFold) {
1215           Constant *NewCst;
1216           if (Shift->getOpcode() == Instruction::Shl)
1217             NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1218           else
1219             NewCst = ConstantExpr::getShl(RHS, ShAmt);
1220
1221           // Check to see if we are shifting out any of the bits being
1222           // compared.
1223           if (ConstantExpr::get(Shift->getOpcode(),
1224                                        NewCst, ShAmt) != RHS) {
1225             // If we shifted bits out, the fold is not going to work out.
1226             // As a special case, check to see if this means that the
1227             // result is always true or false now.
1228             if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1229               return ReplaceInstUsesWith(ICI, Builder->getFalse());
1230             if (ICI.getPredicate() == ICmpInst::ICMP_NE)
1231               return ReplaceInstUsesWith(ICI, Builder->getTrue());
1232           } else {
1233             ICI.setOperand(1, NewCst);
1234             Constant *NewAndCST;
1235             if (Shift->getOpcode() == Instruction::Shl)
1236               NewAndCST = ConstantExpr::getLShr(AndCST, ShAmt);
1237             else
1238               NewAndCST = ConstantExpr::getShl(AndCST, ShAmt);
1239             LHSI->setOperand(1, NewAndCST);
1240             LHSI->setOperand(0, Shift->getOperand(0));
1241             Worklist.Add(Shift); // Shift is dead.
1242             return &ICI;
1243           }
1244         }
1245       }
1246
1247       // Turn ((X >> Y) & C) == 0  into  (X & (C << Y)) == 0.  The later is
1248       // preferable because it allows the C<<Y expression to be hoisted out
1249       // of a loop if Y is invariant and X is not.
1250       if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1251           ICI.isEquality() && !Shift->isArithmeticShift() &&
1252           !isa<Constant>(Shift->getOperand(0))) {
1253         // Compute C << Y.
1254         Value *NS;
1255         if (Shift->getOpcode() == Instruction::LShr) {
1256           NS = Builder->CreateShl(AndCST, Shift->getOperand(1));
1257         } else {
1258           // Insert a logical shift.
1259           NS = Builder->CreateLShr(AndCST, Shift->getOperand(1));
1260         }
1261
1262         // Compute X & (C << Y).
1263         Value *NewAnd =
1264           Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
1265
1266         ICI.setOperand(0, NewAnd);
1267         return &ICI;
1268       }
1269
1270       // Replace ((X & AndCST) > RHSV) with ((X & AndCST) != 0), if any
1271       // bit set in (X & AndCST) will produce a result greater than RHSV.
1272       if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
1273         unsigned NTZ = AndCST->getValue().countTrailingZeros();
1274         if ((NTZ < AndCST->getBitWidth()) &&
1275             APInt::getOneBitSet(AndCST->getBitWidth(), NTZ).ugt(RHSV))
1276           return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1277                               Constant::getNullValue(RHS->getType()));
1278       }
1279     }
1280
1281     // Try to optimize things like "A[i]&42 == 0" to index computations.
1282     if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1283       if (GetElementPtrInst *GEP =
1284           dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1285         if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1286           if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1287               !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1288             ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1289             if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1290               return Res;
1291           }
1292     }
1293
1294     // X & -C == -C -> X >  u ~C
1295     // X & -C != -C -> X <= u ~C
1296     //   iff C is a power of 2
1297     if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1298       return new ICmpInst(
1299           ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1300                                                   : ICmpInst::ICMP_ULE,
1301           LHSI->getOperand(0), SubOne(RHS));
1302     break;
1303
1304   case Instruction::Or: {
1305     if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1306       break;
1307     Value *P, *Q;
1308     if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1309       // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1310       // -> and (icmp eq P, null), (icmp eq Q, null).
1311       Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1312                                         Constant::getNullValue(P->getType()));
1313       Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1314                                         Constant::getNullValue(Q->getType()));
1315       Instruction *Op;
1316       if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1317         Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1318       else
1319         Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1320       return Op;
1321     }
1322     break;
1323   }
1324
1325   case Instruction::Mul: {       // (icmp pred (mul X, Val), CI)
1326     ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1327     if (!Val) break;
1328
1329     // If this is a signed comparison to 0 and the mul is sign preserving,
1330     // use the mul LHS operand instead.
1331     ICmpInst::Predicate pred = ICI.getPredicate();
1332     if (isSignTest(pred, RHS) && !Val->isZero() &&
1333         cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1334       return new ICmpInst(Val->isNegative() ?
1335                           ICmpInst::getSwappedPredicate(pred) : pred,
1336                           LHSI->getOperand(0),
1337                           Constant::getNullValue(RHS->getType()));
1338
1339     break;
1340   }
1341
1342   case Instruction::Shl: {       // (icmp pred (shl X, ShAmt), CI)
1343     uint32_t TypeBits = RHSV.getBitWidth();
1344     ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1345     if (!ShAmt) {
1346       Value *X;
1347       // (1 << X) pred P2 -> X pred Log2(P2)
1348       if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1349         bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1350         ICmpInst::Predicate Pred = ICI.getPredicate();
1351         if (ICI.isUnsigned()) {
1352           if (!RHSVIsPowerOf2) {
1353             // (1 << X) <  30 -> X <= 4
1354             // (1 << X) <= 30 -> X <= 4
1355             // (1 << X) >= 30 -> X >  4
1356             // (1 << X) >  30 -> X >  4
1357             if (Pred == ICmpInst::ICMP_ULT)
1358               Pred = ICmpInst::ICMP_ULE;
1359             else if (Pred == ICmpInst::ICMP_UGE)
1360               Pred = ICmpInst::ICMP_UGT;
1361           }
1362           unsigned RHSLog2 = RHSV.logBase2();
1363
1364           // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
1365           // (1 << X) >  2147483648 -> X >  31 -> false
1366           // (1 << X) <= 2147483648 -> X <= 31 -> true
1367           // (1 << X) <  2147483648 -> X <  31 -> X != 31
1368           if (RHSLog2 == TypeBits-1) {
1369             if (Pred == ICmpInst::ICMP_UGE)
1370               Pred = ICmpInst::ICMP_EQ;
1371             else if (Pred == ICmpInst::ICMP_UGT)
1372               return ReplaceInstUsesWith(ICI, Builder->getFalse());
1373             else if (Pred == ICmpInst::ICMP_ULE)
1374               return ReplaceInstUsesWith(ICI, Builder->getTrue());
1375             else if (Pred == ICmpInst::ICMP_ULT)
1376               Pred = ICmpInst::ICMP_NE;
1377           }
1378
1379           return new ICmpInst(Pred, X,
1380                               ConstantInt::get(RHS->getType(), RHSLog2));
1381         } else if (ICI.isSigned()) {
1382           if (RHSV.isAllOnesValue()) {
1383             // (1 << X) <= -1 -> X == 31
1384             if (Pred == ICmpInst::ICMP_SLE)
1385               return new ICmpInst(ICmpInst::ICMP_EQ, X,
1386                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1387
1388             // (1 << X) >  -1 -> X != 31
1389             if (Pred == ICmpInst::ICMP_SGT)
1390               return new ICmpInst(ICmpInst::ICMP_NE, X,
1391                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1392           } else if (!RHSV) {
1393             // (1 << X) <  0 -> X == 31
1394             // (1 << X) <= 0 -> X == 31
1395             if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1396               return new ICmpInst(ICmpInst::ICMP_EQ, X,
1397                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1398
1399             // (1 << X) >= 0 -> X != 31
1400             // (1 << X) >  0 -> X != 31
1401             if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1402               return new ICmpInst(ICmpInst::ICMP_NE, X,
1403                                   ConstantInt::get(RHS->getType(), TypeBits-1));
1404           }
1405         } else if (ICI.isEquality()) {
1406           if (RHSVIsPowerOf2)
1407             return new ICmpInst(
1408                 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
1409
1410           return ReplaceInstUsesWith(
1411               ICI, Pred == ICmpInst::ICMP_EQ ? Builder->getFalse()
1412                                              : Builder->getTrue());
1413         }
1414       }
1415       break;
1416     }
1417
1418     // Check that the shift amount is in range.  If not, don't perform
1419     // undefined shifts.  When the shift is visited it will be
1420     // simplified.
1421     if (ShAmt->uge(TypeBits))
1422       break;
1423
1424     if (ICI.isEquality()) {
1425       // If we are comparing against bits always shifted out, the
1426       // comparison cannot succeed.
1427       Constant *Comp =
1428         ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1429                                                                  ShAmt);
1430       if (Comp != RHS) {// Comparing against a bit that we know is zero.
1431         bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1432         Constant *Cst = Builder->getInt1(IsICMP_NE);
1433         return ReplaceInstUsesWith(ICI, Cst);
1434       }
1435
1436       // If the shift is NUW, then it is just shifting out zeros, no need for an
1437       // AND.
1438       if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1439         return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1440                             ConstantExpr::getLShr(RHS, ShAmt));
1441
1442       // If the shift is NSW and we compare to 0, then it is just shifting out
1443       // sign bits, no need for an AND either.
1444       if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
1445         return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1446                             ConstantExpr::getLShr(RHS, ShAmt));
1447
1448       if (LHSI->hasOneUse()) {
1449         // Otherwise strength reduce the shift into an and.
1450         uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
1451         Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
1452                                                           TypeBits - ShAmtVal));
1453
1454         Value *And =
1455           Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1456         return new ICmpInst(ICI.getPredicate(), And,
1457                             ConstantExpr::getLShr(RHS, ShAmt));
1458       }
1459     }
1460
1461     // If this is a signed comparison to 0 and the shift is sign preserving,
1462     // use the shift LHS operand instead.
1463     ICmpInst::Predicate pred = ICI.getPredicate();
1464     if (isSignTest(pred, RHS) &&
1465         cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1466       return new ICmpInst(pred,
1467                           LHSI->getOperand(0),
1468                           Constant::getNullValue(RHS->getType()));
1469
1470     // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1471     bool TrueIfSigned = false;
1472     if (LHSI->hasOneUse() &&
1473         isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1474       // (X << 31) <s 0  --> (X&1) != 0
1475       Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
1476                                         APInt::getOneBitSet(TypeBits,
1477                                             TypeBits-ShAmt->getZExtValue()-1));
1478       Value *And =
1479         Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1480       return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1481                           And, Constant::getNullValue(And->getType()));
1482     }
1483
1484     // Transform (icmp pred iM (shl iM %v, N), CI)
1485     // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1486     // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
1487     // This enables to get rid of the shift in favor of a trunc which can be
1488     // free on the target. It has the additional benefit of comparing to a
1489     // smaller constant, which will be target friendly.
1490     unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
1491     if (LHSI->hasOneUse() &&
1492         Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
1493       Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1494       Constant *NCI = ConstantExpr::getTrunc(
1495                         ConstantExpr::getAShr(RHS,
1496                           ConstantInt::get(RHS->getType(), Amt)),
1497                         NTy);
1498       return new ICmpInst(ICI.getPredicate(),
1499                           Builder->CreateTrunc(LHSI->getOperand(0), NTy),
1500                           NCI);
1501     }
1502
1503     break;
1504   }
1505
1506   case Instruction::LShr:         // (icmp pred (shr X, ShAmt), CI)
1507   case Instruction::AShr: {
1508     // Handle equality comparisons of shift-by-constant.
1509     BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1510     if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1511       if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
1512         return Res;
1513     }
1514
1515     // Handle exact shr's.
1516     if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1517       if (RHSV.isMinValue())
1518         return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1519     }
1520     break;
1521   }
1522
1523   case Instruction::SDiv:
1524   case Instruction::UDiv:
1525     // Fold: icmp pred ([us]div X, C1), C2 -> range test
1526     // Fold this div into the comparison, producing a range check.
1527     // Determine, based on the divide type, what the range is being
1528     // checked.  If there is an overflow on the low or high side, remember
1529     // it, otherwise compute the range [low, hi) bounding the new value.
1530     // See: InsertRangeTest above for the kinds of replacements possible.
1531     if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1532       if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1533                                           DivRHS))
1534         return R;
1535     break;
1536
1537   case Instruction::Sub: {
1538     ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
1539     if (!LHSC) break;
1540     const APInt &LHSV = LHSC->getValue();
1541
1542     // C1-X <u C2 -> (X|(C2-1)) == C1
1543     //   iff C1 & (C2-1) == C2-1
1544     //       C2 is a power of 2
1545     if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1546         RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
1547       return new ICmpInst(ICmpInst::ICMP_EQ,
1548                           Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
1549                           LHSC);
1550
1551     // C1-X >u C2 -> (X|C2) != C1
1552     //   iff C1 & C2 == C2
1553     //       C2+1 is a power of 2
1554     if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1555         (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
1556       return new ICmpInst(ICmpInst::ICMP_NE,
1557                           Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
1558     break;
1559   }
1560
1561   case Instruction::Add:
1562     // Fold: icmp pred (add X, C1), C2
1563     if (!ICI.isEquality()) {
1564       ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1565       if (!LHSC) break;
1566       const APInt &LHSV = LHSC->getValue();
1567
1568       ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1569                             .subtract(LHSV);
1570
1571       if (ICI.isSigned()) {
1572         if (CR.getLower().isSignBit()) {
1573           return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
1574                               Builder->getInt(CR.getUpper()));
1575         } else if (CR.getUpper().isSignBit()) {
1576           return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
1577                               Builder->getInt(CR.getLower()));
1578         }
1579       } else {
1580         if (CR.getLower().isMinValue()) {
1581           return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
1582                               Builder->getInt(CR.getUpper()));
1583         } else if (CR.getUpper().isMinValue()) {
1584           return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
1585                               Builder->getInt(CR.getLower()));
1586         }
1587       }
1588
1589       // X-C1 <u C2 -> (X & -C2) == C1
1590       //   iff C1 & (C2-1) == 0
1591       //       C2 is a power of 2
1592       if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1593           RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
1594         return new ICmpInst(ICmpInst::ICMP_EQ,
1595                             Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
1596                             ConstantExpr::getNeg(LHSC));
1597
1598       // X-C1 >u C2 -> (X & ~C2) != C1
1599       //   iff C1 & C2 == 0
1600       //       C2+1 is a power of 2
1601       if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1602           (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
1603         return new ICmpInst(ICmpInst::ICMP_NE,
1604                             Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
1605                             ConstantExpr::getNeg(LHSC));
1606     }
1607     break;
1608   }
1609
1610   // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1611   if (ICI.isEquality()) {
1612     bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
1613
1614     // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
1615     // the second operand is a constant, simplify a bit.
1616     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1617       switch (BO->getOpcode()) {
1618       case Instruction::SRem:
1619         // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1620         if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1621           const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
1622           if (V.sgt(1) && V.isPowerOf2()) {
1623             Value *NewRem =
1624               Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1625                                   BO->getName());
1626             return new ICmpInst(ICI.getPredicate(), NewRem,
1627                                 Constant::getNullValue(BO->getType()));
1628           }
1629         }
1630         break;
1631       case Instruction::Add:
1632         // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1633         if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1634           if (BO->hasOneUse())
1635             return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1636                                 ConstantExpr::getSub(RHS, BOp1C));
1637         } else if (RHSV == 0) {
1638           // Replace ((add A, B) != 0) with (A != -B) if A or B is
1639           // efficiently invertible, or if the add has just this one use.
1640           Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
1641
1642           if (Value *NegVal = dyn_castNegVal(BOp1))
1643             return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
1644           if (Value *NegVal = dyn_castNegVal(BOp0))
1645             return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
1646           if (BO->hasOneUse()) {
1647             Value *Neg = Builder->CreateNeg(BOp1);
1648             Neg->takeName(BO);
1649             return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1650           }
1651         }
1652         break;
1653       case Instruction::Xor:
1654         // For the xor case, we can xor two constants together, eliminating
1655         // the explicit xor.
1656         if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1657           return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1658                               ConstantExpr::getXor(RHS, BOC));
1659         } else if (RHSV == 0) {
1660           // Replace ((xor A, B) != 0) with (A != B)
1661           return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1662                               BO->getOperand(1));
1663         }
1664         break;
1665       case Instruction::Sub:
1666         // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1667         if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1668           if (BO->hasOneUse())
1669             return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1670                                 ConstantExpr::getSub(BOp0C, RHS));
1671         } else if (RHSV == 0) {
1672           // Replace ((sub A, B) != 0) with (A != B)
1673           return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1674                               BO->getOperand(1));
1675         }
1676         break;
1677       case Instruction::Or:
1678         // If bits are being or'd in that are not present in the constant we
1679         // are comparing against, then the comparison could never succeed!
1680         if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1681           Constant *NotCI = ConstantExpr::getNot(RHS);
1682           if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
1683             return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
1684         }
1685         break;
1686
1687       case Instruction::And:
1688         if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1689           // If bits are being compared against that are and'd out, then the
1690           // comparison can never succeed!
1691           if ((RHSV & ~BOC->getValue()) != 0)
1692             return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
1693
1694           // If we have ((X & C) == C), turn it into ((X & C) != 0).
1695           if (RHS == BOC && RHSV.isPowerOf2())
1696             return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1697                                 ICmpInst::ICMP_NE, LHSI,
1698                                 Constant::getNullValue(RHS->getType()));
1699
1700           // Don't perform the following transforms if the AND has multiple uses
1701           if (!BO->hasOneUse())
1702             break;
1703
1704           // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1705           if (BOC->getValue().isSignBit()) {
1706             Value *X = BO->getOperand(0);
1707             Constant *Zero = Constant::getNullValue(X->getType());
1708             ICmpInst::Predicate pred = isICMP_NE ?
1709               ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1710             return new ICmpInst(pred, X, Zero);
1711           }
1712
1713           // ((X & ~7) == 0) --> X < 8
1714           if (RHSV == 0 && isHighOnes(BOC)) {
1715             Value *X = BO->getOperand(0);
1716             Constant *NegX = ConstantExpr::getNeg(BOC);
1717             ICmpInst::Predicate pred = isICMP_NE ?
1718               ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1719             return new ICmpInst(pred, X, NegX);
1720           }
1721         }
1722         break;
1723       case Instruction::Mul:
1724         if (RHSV == 0 && BO->hasNoSignedWrap()) {
1725           if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1726             // The trivial case (mul X, 0) is handled by InstSimplify
1727             // General case : (mul X, C) != 0 iff X != 0
1728             //                (mul X, C) == 0 iff X == 0
1729             if (!BOC->isZero())
1730               return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1731                                   Constant::getNullValue(RHS->getType()));
1732           }
1733         }
1734         break;
1735       default: break;
1736       }
1737     } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1738       // Handle icmp {eq|ne} <intrinsic>, intcst.
1739       switch (II->getIntrinsicID()) {
1740       case Intrinsic::bswap:
1741         Worklist.Add(II);
1742         ICI.setOperand(0, II->getArgOperand(0));
1743         ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
1744         return &ICI;
1745       case Intrinsic::ctlz:
1746       case Intrinsic::cttz:
1747         // ctz(A) == bitwidth(a)  ->  A == 0 and likewise for !=
1748         if (RHSV == RHS->getType()->getBitWidth()) {
1749           Worklist.Add(II);
1750           ICI.setOperand(0, II->getArgOperand(0));
1751           ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1752           return &ICI;
1753         }
1754         break;
1755       case Intrinsic::ctpop:
1756         // popcount(A) == 0  ->  A == 0 and likewise for !=
1757         if (RHS->isZero()) {
1758           Worklist.Add(II);
1759           ICI.setOperand(0, II->getArgOperand(0));
1760           ICI.setOperand(1, RHS);
1761           return &ICI;
1762         }
1763         break;
1764       default:
1765         break;
1766       }
1767     }
1768   }
1769   return 0;
1770 }
1771
1772 /// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1773 /// We only handle extending casts so far.
1774 ///
1775 Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1776   const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1777   Value *LHSCIOp        = LHSCI->getOperand(0);
1778   Type *SrcTy     = LHSCIOp->getType();
1779   Type *DestTy    = LHSCI->getType();
1780   Value *RHSCIOp;
1781
1782   // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
1783   // integer type is the same size as the pointer type.
1784   if (TD && LHSCI->getOpcode() == Instruction::PtrToInt &&
1785       TD->getPointerSizeInBits() ==
1786          cast<IntegerType>(DestTy)->getBitWidth()) {
1787     Value *RHSOp = 0;
1788     if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) {
1789       RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
1790     } else if (PtrToIntInst *RHSC = dyn_cast<PtrToIntInst>(ICI.getOperand(1))) {
1791       RHSOp = RHSC->getOperand(0);
1792       // If the pointer types don't match, insert a bitcast.
1793       if (LHSCIOp->getType() != RHSOp->getType())
1794         RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1795     }
1796
1797     if (RHSOp)
1798       return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1799   }
1800
1801   // The code below only handles extension cast instructions, so far.
1802   // Enforce this.
1803   if (LHSCI->getOpcode() != Instruction::ZExt &&
1804       LHSCI->getOpcode() != Instruction::SExt)
1805     return 0;
1806
1807   bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1808   bool isSignedCmp = ICI.isSigned();
1809
1810   if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1811     // Not an extension from the same type?
1812     RHSCIOp = CI->getOperand(0);
1813     if (RHSCIOp->getType() != LHSCIOp->getType())
1814       return 0;
1815
1816     // If the signedness of the two casts doesn't agree (i.e. one is a sext
1817     // and the other is a zext), then we can't handle this.
1818     if (CI->getOpcode() != LHSCI->getOpcode())
1819       return 0;
1820
1821     // Deal with equality cases early.
1822     if (ICI.isEquality())
1823       return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1824
1825     // A signed comparison of sign extended values simplifies into a
1826     // signed comparison.
1827     if (isSignedCmp && isSignedExt)
1828       return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1829
1830     // The other three cases all fold into an unsigned comparison.
1831     return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1832   }
1833
1834   // If we aren't dealing with a constant on the RHS, exit early
1835   ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1836   if (!CI)
1837     return 0;
1838
1839   // Compute the constant that would happen if we truncated to SrcTy then
1840   // reextended to DestTy.
1841   Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1842   Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
1843                                                 Res1, DestTy);
1844
1845   // If the re-extended constant didn't change...
1846   if (Res2 == CI) {
1847     // Deal with equality cases early.
1848     if (ICI.isEquality())
1849       return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1850
1851     // A signed comparison of sign extended values simplifies into a
1852     // signed comparison.
1853     if (isSignedExt && isSignedCmp)
1854       return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1855
1856     // The other three cases all fold into an unsigned comparison.
1857     return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
1858   }
1859
1860   // The re-extended constant changed so the constant cannot be represented
1861   // in the shorter type. Consequently, we cannot emit a simple comparison.
1862   // All the cases that fold to true or false will have already been handled
1863   // by SimplifyICmpInst, so only deal with the tricky case.
1864
1865   if (isSignedCmp || !isSignedExt)
1866     return 0;
1867
1868   // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
1869   // should have been folded away previously and not enter in here.
1870
1871   // We're performing an unsigned comp with a sign extended value.
1872   // This is true if the input is >= 0. [aka >s -1]
1873   Constant *NegOne = Constant::getAllOnesValue(SrcTy);
1874   Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
1875
1876   // Finally, return the value computed.
1877   if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
1878     return ReplaceInstUsesWith(ICI, Result);
1879
1880   assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
1881   return BinaryOperator::CreateNot(Result);
1882 }
1883
1884 /// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
1885 ///   I = icmp ugt (add (add A, B), CI2), CI1
1886 /// If this is of the form:
1887 ///   sum = a + b
1888 ///   if (sum+128 >u 255)
1889 /// Then replace it with llvm.sadd.with.overflow.i8.
1890 ///
1891 static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
1892                                           ConstantInt *CI2, ConstantInt *CI1,
1893                                           InstCombiner &IC) {
1894   // The transformation we're trying to do here is to transform this into an
1895   // llvm.sadd.with.overflow.  To do this, we have to replace the original add
1896   // with a narrower add, and discard the add-with-constant that is part of the
1897   // range check (if we can't eliminate it, this isn't profitable).
1898
1899   // In order to eliminate the add-with-constant, the compare can be its only
1900   // use.
1901   Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
1902   if (!AddWithCst->hasOneUse()) return 0;
1903
1904   // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
1905   if (!CI2->getValue().isPowerOf2()) return 0;
1906   unsigned NewWidth = CI2->getValue().countTrailingZeros();
1907   if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return 0;
1908
1909   // The width of the new add formed is 1 more than the bias.
1910   ++NewWidth;
1911
1912   // Check to see that CI1 is an all-ones value with NewWidth bits.
1913   if (CI1->getBitWidth() == NewWidth ||
1914       CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
1915     return 0;
1916
1917   // This is only really a signed overflow check if the inputs have been
1918   // sign-extended; check for that condition. For example, if CI2 is 2^31 and
1919   // the operands of the add are 64 bits wide, we need at least 33 sign bits.
1920   unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
1921   if (IC.ComputeNumSignBits(A) < NeededSignBits ||
1922       IC.ComputeNumSignBits(B) < NeededSignBits)
1923     return 0;
1924
1925   // In order to replace the original add with a narrower
1926   // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
1927   // and truncates that discard the high bits of the add.  Verify that this is
1928   // the case.
1929   Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
1930   for (Value::use_iterator UI = OrigAdd->use_begin(), E = OrigAdd->use_end();
1931        UI != E; ++UI) {
1932     if (*UI == AddWithCst) continue;
1933
1934     // Only accept truncates for now.  We would really like a nice recursive
1935     // predicate like SimplifyDemandedBits, but which goes downwards the use-def
1936     // chain to see which bits of a value are actually demanded.  If the
1937     // original add had another add which was then immediately truncated, we
1938     // could still do the transformation.
1939     TruncInst *TI = dyn_cast<TruncInst>(*UI);
1940     if (TI == 0 ||
1941         TI->getType()->getPrimitiveSizeInBits() > NewWidth) return 0;
1942   }
1943
1944   // If the pattern matches, truncate the inputs to the narrower type and
1945   // use the sadd_with_overflow intrinsic to efficiently compute both the
1946   // result and the overflow bit.
1947   Module *M = I.getParent()->getParent()->getParent();
1948
1949   Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
1950   Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
1951                                        NewType);
1952
1953   InstCombiner::BuilderTy *Builder = IC.Builder;
1954
1955   // Put the new code above the original add, in case there are any uses of the
1956   // add between the add and the compare.
1957   Builder->SetInsertPoint(OrigAdd);
1958
1959   Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
1960   Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
1961   CallInst *Call = Builder->CreateCall2(F, TruncA, TruncB, "sadd");
1962   Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
1963   Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
1964
1965   // The inner add was the result of the narrow add, zero extended to the
1966   // wider type.  Replace it with the result computed by the intrinsic.
1967   IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
1968
1969   // The original icmp gets replaced with the overflow value.
1970   return ExtractValueInst::Create(Call, 1, "sadd.overflow");
1971 }
1972
1973 static Instruction *ProcessUAddIdiom(Instruction &I, Value *OrigAddV,
1974                                      InstCombiner &IC) {
1975   // Don't bother doing this transformation for pointers, don't do it for
1976   // vectors.
1977   if (!isa<IntegerType>(OrigAddV->getType())) return 0;
1978
1979   // If the add is a constant expr, then we don't bother transforming it.
1980   Instruction *OrigAdd = dyn_cast<Instruction>(OrigAddV);
1981   if (OrigAdd == 0) return 0;
1982
1983   Value *LHS = OrigAdd->getOperand(0), *RHS = OrigAdd->getOperand(1);
1984
1985   // Put the new code above the original add, in case there are any uses of the
1986   // add between the add and the compare.
1987   InstCombiner::BuilderTy *Builder = IC.Builder;
1988   Builder->SetInsertPoint(OrigAdd);
1989
1990   Module *M = I.getParent()->getParent()->getParent();
1991   Type *Ty = LHS->getType();
1992   Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
1993   CallInst *Call = Builder->CreateCall2(F, LHS, RHS, "uadd");
1994   Value *Add = Builder->CreateExtractValue(Call, 0);
1995
1996   IC.ReplaceInstUsesWith(*OrigAdd, Add);
1997
1998   // The original icmp gets replaced with the overflow value.
1999   return ExtractValueInst::Create(Call, 1, "uadd.overflow");
2000 }
2001
2002 // DemandedBitsLHSMask - When performing a comparison against a constant,
2003 // it is possible that not all the bits in the LHS are demanded.  This helper
2004 // method computes the mask that IS demanded.
2005 static APInt DemandedBitsLHSMask(ICmpInst &I,
2006                                  unsigned BitWidth, bool isSignCheck) {
2007   if (isSignCheck)
2008     return APInt::getSignBit(BitWidth);
2009
2010   ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2011   if (!CI) return APInt::getAllOnesValue(BitWidth);
2012   const APInt &RHS = CI->getValue();
2013
2014   switch (I.getPredicate()) {
2015   // For a UGT comparison, we don't care about any bits that
2016   // correspond to the trailing ones of the comparand.  The value of these
2017   // bits doesn't impact the outcome of the comparison, because any value
2018   // greater than the RHS must differ in a bit higher than these due to carry.
2019   case ICmpInst::ICMP_UGT: {
2020     unsigned trailingOnes = RHS.countTrailingOnes();
2021     APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2022     return ~lowBitsSet;
2023   }
2024
2025   // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2026   // Any value less than the RHS must differ in a higher bit because of carries.
2027   case ICmpInst::ICMP_ULT: {
2028     unsigned trailingZeros = RHS.countTrailingZeros();
2029     APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2030     return ~lowBitsSet;
2031   }
2032
2033   default:
2034     return APInt::getAllOnesValue(BitWidth);
2035   }
2036
2037 }
2038
2039 Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
2040   bool Changed = false;
2041   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2042
2043   /// Orders the operands of the compare so that they are listed from most
2044   /// complex to least complex.  This puts constants before unary operators,
2045   /// before binary operators.
2046   if (getComplexity(Op0) < getComplexity(Op1)) {
2047     I.swapOperands();
2048     std::swap(Op0, Op1);
2049     Changed = true;
2050   }
2051
2052   if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, TD))
2053     return ReplaceInstUsesWith(I, V);
2054
2055   // comparing -val or val with non-zero is the same as just comparing val
2056   // ie, abs(val) != 0 -> val != 0
2057   if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
2058   {
2059     Value *Cond, *SelectTrue, *SelectFalse;
2060     if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
2061                             m_Value(SelectFalse)))) {
2062       if (Value *V = dyn_castNegVal(SelectTrue)) {
2063         if (V == SelectFalse)
2064           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2065       }
2066       else if (Value *V = dyn_castNegVal(SelectFalse)) {
2067         if (V == SelectTrue)
2068           return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2069       }
2070     }
2071   }
2072
2073   Type *Ty = Op0->getType();
2074
2075   // icmp's with boolean values can always be turned into bitwise operations
2076   if (Ty->isIntegerTy(1)) {
2077     switch (I.getPredicate()) {
2078     default: llvm_unreachable("Invalid icmp instruction!");
2079     case ICmpInst::ICMP_EQ: {               // icmp eq i1 A, B -> ~(A^B)
2080       Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
2081       return BinaryOperator::CreateNot(Xor);
2082     }
2083     case ICmpInst::ICMP_NE:                  // icmp eq i1 A, B -> A^B
2084       return BinaryOperator::CreateXor(Op0, Op1);
2085
2086     case ICmpInst::ICMP_UGT:
2087       std::swap(Op0, Op1);                   // Change icmp ugt -> icmp ult
2088       // FALL THROUGH
2089     case ICmpInst::ICMP_ULT:{               // icmp ult i1 A, B -> ~A & B
2090       Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2091       return BinaryOperator::CreateAnd(Not, Op1);
2092     }
2093     case ICmpInst::ICMP_SGT:
2094       std::swap(Op0, Op1);                   // Change icmp sgt -> icmp slt
2095       // FALL THROUGH
2096     case ICmpInst::ICMP_SLT: {               // icmp slt i1 A, B -> A & ~B
2097       Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2098       return BinaryOperator::CreateAnd(Not, Op0);
2099     }
2100     case ICmpInst::ICMP_UGE:
2101       std::swap(Op0, Op1);                   // Change icmp uge -> icmp ule
2102       // FALL THROUGH
2103     case ICmpInst::ICMP_ULE: {               //  icmp ule i1 A, B -> ~A | B
2104       Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2105       return BinaryOperator::CreateOr(Not, Op1);
2106     }
2107     case ICmpInst::ICMP_SGE:
2108       std::swap(Op0, Op1);                   // Change icmp sge -> icmp sle
2109       // FALL THROUGH
2110     case ICmpInst::ICMP_SLE: {               //  icmp sle i1 A, B -> A | ~B
2111       Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2112       return BinaryOperator::CreateOr(Not, Op0);
2113     }
2114     }
2115   }
2116
2117   unsigned BitWidth = 0;
2118   if (Ty->isIntOrIntVectorTy())
2119     BitWidth = Ty->getScalarSizeInBits();
2120   else if (TD)  // Pointers require TD info to get their size.
2121     BitWidth = TD->getTypeSizeInBits(Ty->getScalarType());
2122
2123   bool isSignBit = false;
2124
2125   // See if we are doing a comparison with a constant.
2126   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2127     Value *A = 0, *B = 0;
2128
2129     // Match the following pattern, which is a common idiom when writing
2130     // overflow-safe integer arithmetic function.  The source performs an
2131     // addition in wider type, and explicitly checks for overflow using
2132     // comparisons against INT_MIN and INT_MAX.  Simplify this by using the
2133     // sadd_with_overflow intrinsic.
2134     //
2135     // TODO: This could probably be generalized to handle other overflow-safe
2136     // operations if we worked out the formulas to compute the appropriate
2137     // magic constants.
2138     //
2139     // sum = a + b
2140     // if (sum+128 >u 255)  ...  -> llvm.sadd.with.overflow.i8
2141     {
2142     ConstantInt *CI2;    // I = icmp ugt (add (add A, B), CI2), CI
2143     if (I.getPredicate() == ICmpInst::ICMP_UGT &&
2144         match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
2145       if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
2146         return Res;
2147     }
2148
2149     // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
2150     if (I.isEquality() && CI->isZero() &&
2151         match(Op0, m_Sub(m_Value(A), m_Value(B)))) {
2152       // (icmp cond A B) if cond is equality
2153       return new ICmpInst(I.getPredicate(), A, B);
2154     }
2155
2156     // If we have an icmp le or icmp ge instruction, turn it into the
2157     // appropriate icmp lt or icmp gt instruction.  This allows us to rely on
2158     // them being folded in the code below.  The SimplifyICmpInst code has
2159     // already handled the edge cases for us, so we just assert on them.
2160     switch (I.getPredicate()) {
2161     default: break;
2162     case ICmpInst::ICMP_ULE:
2163       assert(!CI->isMaxValue(false));                 // A <=u MAX -> TRUE
2164       return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
2165                           Builder->getInt(CI->getValue()+1));
2166     case ICmpInst::ICMP_SLE:
2167       assert(!CI->isMaxValue(true));                  // A <=s MAX -> TRUE
2168       return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2169                           Builder->getInt(CI->getValue()+1));
2170     case ICmpInst::ICMP_UGE:
2171       assert(!CI->isMinValue(false));                 // A >=u MIN -> TRUE
2172       return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
2173                           Builder->getInt(CI->getValue()-1));
2174     case ICmpInst::ICMP_SGE:
2175       assert(!CI->isMinValue(true));                  // A >=s MIN -> TRUE
2176       return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2177                           Builder->getInt(CI->getValue()-1));
2178     }
2179
2180     // If this comparison is a normal comparison, it demands all
2181     // bits, if it is a sign bit comparison, it only demands the sign bit.
2182     bool UnusedBit;
2183     isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
2184   }
2185
2186   // See if we can fold the comparison based on range information we can get
2187   // by checking whether bits are known to be zero or one in the input.
2188   if (BitWidth != 0) {
2189     APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
2190     APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2191
2192     if (SimplifyDemandedBits(I.getOperandUse(0),
2193                              DemandedBitsLHSMask(I, BitWidth, isSignBit),
2194                              Op0KnownZero, Op0KnownOne, 0))
2195       return &I;
2196     if (SimplifyDemandedBits(I.getOperandUse(1),
2197                              APInt::getAllOnesValue(BitWidth),
2198                              Op1KnownZero, Op1KnownOne, 0))
2199       return &I;
2200
2201     // Given the known and unknown bits, compute a range that the LHS could be
2202     // in.  Compute the Min, Max and RHS values based on the known bits. For the
2203     // EQ and NE we use unsigned values.
2204     APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2205     APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2206     if (I.isSigned()) {
2207       ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2208                                              Op0Min, Op0Max);
2209       ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2210                                              Op1Min, Op1Max);
2211     } else {
2212       ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2213                                                Op0Min, Op0Max);
2214       ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2215                                                Op1Min, Op1Max);
2216     }
2217
2218     // If Min and Max are known to be the same, then SimplifyDemandedBits
2219     // figured out that the LHS is a constant.  Just constant fold this now so
2220     // that code below can assume that Min != Max.
2221     if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2222       return new ICmpInst(I.getPredicate(),
2223                           ConstantInt::get(Op0->getType(), Op0Min), Op1);
2224     if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2225       return new ICmpInst(I.getPredicate(), Op0,
2226                           ConstantInt::get(Op1->getType(), Op1Min));
2227
2228     // Based on the range information we know about the LHS, see if we can
2229     // simplify this comparison.  For example, (x&4) < 8 is always true.
2230     switch (I.getPredicate()) {
2231     default: llvm_unreachable("Unknown icmp opcode!");
2232     case ICmpInst::ICMP_EQ: {
2233       if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
2234         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2235
2236       // If all bits are known zero except for one, then we know at most one
2237       // bit is set.   If the comparison is against zero, then this is a check
2238       // to see if *that* bit is set.
2239       APInt Op0KnownZeroInverted = ~Op0KnownZero;
2240       if (~Op1KnownZero == 0 && Op0KnownZeroInverted.isPowerOf2()) {
2241         // If the LHS is an AND with the same constant, look through it.
2242         Value *LHS = 0;
2243         ConstantInt *LHSC = 0;
2244         if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2245             LHSC->getValue() != Op0KnownZeroInverted)
2246           LHS = Op0;
2247
2248         // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
2249         // then turn "((1 << x)&8) == 0" into "x != 3".
2250         Value *X = 0;
2251         if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2252           unsigned CmpVal = Op0KnownZeroInverted.countTrailingZeros();
2253           return new ICmpInst(ICmpInst::ICMP_NE, X,
2254                               ConstantInt::get(X->getType(), CmpVal));
2255         }
2256
2257         // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
2258         // then turn "((8 >>u x)&1) == 0" into "x != 3".
2259         const APInt *CI;
2260         if (Op0KnownZeroInverted == 1 &&
2261             match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
2262           return new ICmpInst(ICmpInst::ICMP_NE, X,
2263                               ConstantInt::get(X->getType(),
2264                                                CI->countTrailingZeros()));
2265       }
2266
2267       break;
2268     }
2269     case ICmpInst::ICMP_NE: {
2270       if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
2271         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2272
2273       // If all bits are known zero except for one, then we know at most one
2274       // bit is set.   If the comparison is against zero, then this is a check
2275       // to see if *that* bit is set.
2276       APInt Op0KnownZeroInverted = ~Op0KnownZero;
2277       if (~Op1KnownZero == 0 && Op0KnownZeroInverted.isPowerOf2()) {
2278         // If the LHS is an AND with the same constant, look through it.
2279         Value *LHS = 0;
2280         ConstantInt *LHSC = 0;
2281         if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2282             LHSC->getValue() != Op0KnownZeroInverted)
2283           LHS = Op0;
2284
2285         // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
2286         // then turn "((1 << x)&8) != 0" into "x == 3".
2287         Value *X = 0;
2288         if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2289           unsigned CmpVal = Op0KnownZeroInverted.countTrailingZeros();
2290           return new ICmpInst(ICmpInst::ICMP_EQ, X,
2291                               ConstantInt::get(X->getType(), CmpVal));
2292         }
2293
2294         // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
2295         // then turn "((8 >>u x)&1) != 0" into "x == 3".
2296         const APInt *CI;
2297         if (Op0KnownZeroInverted == 1 &&
2298             match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
2299           return new ICmpInst(ICmpInst::ICMP_EQ, X,
2300                               ConstantInt::get(X->getType(),
2301                                                CI->countTrailingZeros()));
2302       }
2303
2304       break;
2305     }
2306     case ICmpInst::ICMP_ULT:
2307       if (Op0Max.ult(Op1Min))          // A <u B -> true if max(A) < min(B)
2308         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2309       if (Op0Min.uge(Op1Max))          // A <u B -> false if min(A) >= max(B)
2310         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2311       if (Op1Min == Op0Max)            // A <u B -> A != B if max(A) == min(B)
2312         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2313       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2314         if (Op1Max == Op0Min+1)        // A <u C -> A == C-1 if min(A)+1 == C
2315           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2316                               Builder->getInt(CI->getValue()-1));
2317
2318         // (x <u 2147483648) -> (x >s -1)  -> true if sign bit clear
2319         if (CI->isMinValue(true))
2320           return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2321                            Constant::getAllOnesValue(Op0->getType()));
2322       }
2323       break;
2324     case ICmpInst::ICMP_UGT:
2325       if (Op0Min.ugt(Op1Max))          // A >u B -> true if min(A) > max(B)
2326         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2327       if (Op0Max.ule(Op1Min))          // A >u B -> false if max(A) <= max(B)
2328         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2329
2330       if (Op1Max == Op0Min)            // A >u B -> A != B if min(A) == max(B)
2331         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2332       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2333         if (Op1Min == Op0Max-1)        // A >u C -> A == C+1 if max(a)-1 == C
2334           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2335                               Builder->getInt(CI->getValue()+1));
2336
2337         // (x >u 2147483647) -> (x <s 0)  -> true if sign bit set
2338         if (CI->isMaxValue(true))
2339           return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2340                               Constant::getNullValue(Op0->getType()));
2341       }
2342       break;
2343     case ICmpInst::ICMP_SLT:
2344       if (Op0Max.slt(Op1Min))          // A <s B -> true if max(A) < min(C)
2345         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2346       if (Op0Min.sge(Op1Max))          // A <s B -> false if min(A) >= max(C)
2347         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2348       if (Op1Min == Op0Max)            // A <s B -> A != B if max(A) == min(B)
2349         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2350       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2351         if (Op1Max == Op0Min+1)        // A <s C -> A == C-1 if min(A)+1 == C
2352           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2353                               Builder->getInt(CI->getValue()-1));
2354       }
2355       break;
2356     case ICmpInst::ICMP_SGT:
2357       if (Op0Min.sgt(Op1Max))          // A >s B -> true if min(A) > max(B)
2358         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2359       if (Op0Max.sle(Op1Min))          // A >s B -> false if max(A) <= min(B)
2360         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2361
2362       if (Op1Max == Op0Min)            // A >s B -> A != B if min(A) == max(B)
2363         return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2364       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2365         if (Op1Min == Op0Max-1)        // A >s C -> A == C+1 if max(A)-1 == C
2366           return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
2367                               Builder->getInt(CI->getValue()+1));
2368       }
2369       break;
2370     case ICmpInst::ICMP_SGE:
2371       assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
2372       if (Op0Min.sge(Op1Max))          // A >=s B -> true if min(A) >= max(B)
2373         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2374       if (Op0Max.slt(Op1Min))          // A >=s B -> false if max(A) < min(B)
2375         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2376       break;
2377     case ICmpInst::ICMP_SLE:
2378       assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
2379       if (Op0Max.sle(Op1Min))          // A <=s B -> true if max(A) <= min(B)
2380         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2381       if (Op0Min.sgt(Op1Max))          // A <=s B -> false if min(A) > max(B)
2382         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2383       break;
2384     case ICmpInst::ICMP_UGE:
2385       assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
2386       if (Op0Min.uge(Op1Max))          // A >=u B -> true if min(A) >= max(B)
2387         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2388       if (Op0Max.ult(Op1Min))          // A >=u B -> false if max(A) < min(B)
2389         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2390       break;
2391     case ICmpInst::ICMP_ULE:
2392       assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
2393       if (Op0Max.ule(Op1Min))          // A <=u B -> true if max(A) <= min(B)
2394         return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2395       if (Op0Min.ugt(Op1Max))          // A <=u B -> false if min(A) > max(B)
2396         return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2397       break;
2398     }
2399
2400     // Turn a signed comparison into an unsigned one if both operands
2401     // are known to have the same sign.
2402     if (I.isSigned() &&
2403         ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
2404          (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
2405       return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
2406   }
2407
2408   // Test if the ICmpInst instruction is used exclusively by a select as
2409   // part of a minimum or maximum operation. If so, refrain from doing
2410   // any other folding. This helps out other analyses which understand
2411   // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
2412   // and CodeGen. And in this case, at least one of the comparison
2413   // operands has at least one user besides the compare (the select),
2414   // which would often largely negate the benefit of folding anyway.
2415   if (I.hasOneUse())
2416     if (SelectInst *SI = dyn_cast<SelectInst>(*I.use_begin()))
2417       if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
2418           (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
2419         return 0;
2420
2421   // See if we are doing a comparison between a constant and an instruction that
2422   // can be folded into the comparison.
2423   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2424     // Since the RHS is a ConstantInt (CI), if the left hand side is an
2425     // instruction, see if that instruction also has constants so that the
2426     // instruction can be folded into the icmp
2427     if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2428       if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
2429         return Res;
2430   }
2431
2432   // Handle icmp with constant (but not simple integer constant) RHS
2433   if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2434     if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2435       switch (LHSI->getOpcode()) {
2436       case Instruction::GetElementPtr:
2437           // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2438         if (RHSC->isNullValue() &&
2439             cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2440           return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2441                   Constant::getNullValue(LHSI->getOperand(0)->getType()));
2442         break;
2443       case Instruction::PHI:
2444         // Only fold icmp into the PHI if the phi and icmp are in the same
2445         // block.  If in the same block, we're encouraging jump threading.  If
2446         // not, we are just pessimizing the code by making an i1 phi.
2447         if (LHSI->getParent() == I.getParent())
2448           if (Instruction *NV = FoldOpIntoPhi(I))
2449             return NV;
2450         break;
2451       case Instruction::Select: {
2452         // If either operand of the select is a constant, we can fold the
2453         // comparison into the select arms, which will cause one to be
2454         // constant folded and the select turned into a bitwise or.
2455         Value *Op1 = 0, *Op2 = 0;
2456         if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1)))
2457           Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2458         if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2)))
2459           Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2460
2461         // We only want to perform this transformation if it will not lead to
2462         // additional code. This is true if either both sides of the select
2463         // fold to a constant (in which case the icmp is replaced with a select
2464         // which will usually simplify) or this is the only user of the
2465         // select (in which case we are trading a select+icmp for a simpler
2466         // select+icmp).
2467         if ((Op1 && Op2) || (LHSI->hasOneUse() && (Op1 || Op2))) {
2468           if (!Op1)
2469             Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
2470                                       RHSC, I.getName());
2471           if (!Op2)
2472             Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
2473                                       RHSC, I.getName());
2474           return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
2475         }
2476         break;
2477       }
2478       case Instruction::IntToPtr:
2479         // icmp pred inttoptr(X), null -> icmp pred X, 0
2480         if (RHSC->isNullValue() && TD &&
2481             TD->getIntPtrType(RHSC->getContext()) ==
2482                LHSI->getOperand(0)->getType())
2483           return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2484                         Constant::getNullValue(LHSI->getOperand(0)->getType()));
2485         break;
2486
2487       case Instruction::Load:
2488         // Try to optimize things like "A[i] > 4" to index computations.
2489         if (GetElementPtrInst *GEP =
2490               dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
2491           if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
2492             if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
2493                 !cast<LoadInst>(LHSI)->isVolatile())
2494               if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
2495                 return Res;
2496         }
2497         break;
2498       }
2499   }
2500
2501   // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
2502   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
2503     if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
2504       return NI;
2505   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
2506     if (Instruction *NI = FoldGEPICmp(GEP, Op0,
2507                            ICmpInst::getSwappedPredicate(I.getPredicate()), I))
2508       return NI;
2509
2510   // Test to see if the operands of the icmp are casted versions of other
2511   // values.  If the ptr->ptr cast can be stripped off both arguments, we do so
2512   // now.
2513   if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
2514     if (Op0->getType()->isPointerTy() &&
2515         (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
2516       // We keep moving the cast from the left operand over to the right
2517       // operand, where it can often be eliminated completely.
2518       Op0 = CI->getOperand(0);
2519
2520       // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2521       // so eliminate it as well.
2522       if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
2523         Op1 = CI2->getOperand(0);
2524
2525       // If Op1 is a constant, we can fold the cast into the constant.
2526       if (Op0->getType() != Op1->getType()) {
2527         if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
2528           Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
2529         } else {
2530           // Otherwise, cast the RHS right before the icmp
2531           Op1 = Builder->CreateBitCast(Op1, Op0->getType());
2532         }
2533       }
2534       return new ICmpInst(I.getPredicate(), Op0, Op1);
2535     }
2536   }
2537
2538   if (isa<CastInst>(Op0)) {
2539     // Handle the special case of: icmp (cast bool to X), <cst>
2540     // This comes up when you have code like
2541     //   int X = A < B;
2542     //   if (X) ...
2543     // For generality, we handle any zero-extension of any operand comparison
2544     // with a constant or another cast from the same type.
2545     if (isa<Constant>(Op1) || isa<CastInst>(Op1))
2546       if (Instruction *R = visitICmpInstWithCastAndCast(I))
2547         return R;
2548   }
2549
2550   // Special logic for binary operators.
2551   BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
2552   BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
2553   if (BO0 || BO1) {
2554     CmpInst::Predicate Pred = I.getPredicate();
2555     bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
2556     if (BO0 && isa<OverflowingBinaryOperator>(BO0))
2557       NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
2558         (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
2559         (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
2560     if (BO1 && isa<OverflowingBinaryOperator>(BO1))
2561       NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
2562         (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
2563         (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
2564
2565     // Analyze the case when either Op0 or Op1 is an add instruction.
2566     // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
2567     Value *A = 0, *B = 0, *C = 0, *D = 0;
2568     if (BO0 && BO0->getOpcode() == Instruction::Add)
2569       A = BO0->getOperand(0), B = BO0->getOperand(1);
2570     if (BO1 && BO1->getOpcode() == Instruction::Add)
2571       C = BO1->getOperand(0), D = BO1->getOperand(1);
2572
2573     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2574     if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
2575       return new ICmpInst(Pred, A == Op1 ? B : A,
2576                           Constant::getNullValue(Op1->getType()));
2577
2578     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2579     if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
2580       return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
2581                           C == Op0 ? D : C);
2582
2583     // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
2584     if (A && C && (A == C || A == D || B == C || B == D) &&
2585         NoOp0WrapProblem && NoOp1WrapProblem &&
2586         // Try not to increase register pressure.
2587         BO0->hasOneUse() && BO1->hasOneUse()) {
2588       // Determine Y and Z in the form icmp (X+Y), (X+Z).
2589       Value *Y, *Z;
2590       if (A == C) {
2591         // C + B == C + D  ->  B == D
2592         Y = B;
2593         Z = D;
2594       } else if (A == D) {
2595         // D + B == C + D  ->  B == C
2596         Y = B;
2597         Z = C;
2598       } else if (B == C) {
2599         // A + C == C + D  ->  A == D
2600         Y = A;
2601         Z = D;
2602       } else {
2603         assert(B == D);
2604         // A + D == C + D  ->  A == C
2605         Y = A;
2606         Z = C;
2607       }
2608       return new ICmpInst(Pred, Y, Z);
2609     }
2610
2611     // icmp slt (X + -1), Y -> icmp sle X, Y
2612     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
2613         match(B, m_AllOnes()))
2614       return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
2615
2616     // icmp sge (X + -1), Y -> icmp sgt X, Y
2617     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
2618         match(B, m_AllOnes()))
2619       return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
2620
2621     // icmp sle (X + 1), Y -> icmp slt X, Y
2622     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
2623         match(B, m_One()))
2624       return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
2625
2626     // icmp sgt (X + 1), Y -> icmp sge X, Y
2627     if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
2628         match(B, m_One()))
2629       return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
2630
2631     // if C1 has greater magnitude than C2:
2632     //  icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
2633     //  s.t. C3 = C1 - C2
2634     //
2635     // if C2 has greater magnitude than C1:
2636     //  icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
2637     //  s.t. C3 = C2 - C1
2638     if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
2639         (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
2640       if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
2641         if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
2642           const APInt &AP1 = C1->getValue();
2643           const APInt &AP2 = C2->getValue();
2644           if (AP1.isNegative() == AP2.isNegative()) {
2645             APInt AP1Abs = C1->getValue().abs();
2646             APInt AP2Abs = C2->getValue().abs();
2647             if (AP1Abs.uge(AP2Abs)) {
2648               ConstantInt *C3 = Builder->getInt(AP1 - AP2);
2649               Value *NewAdd = Builder->CreateNSWAdd(A, C3);
2650               return new ICmpInst(Pred, NewAdd, C);
2651             } else {
2652               ConstantInt *C3 = Builder->getInt(AP2 - AP1);
2653               Value *NewAdd = Builder->CreateNSWAdd(C, C3);
2654               return new ICmpInst(Pred, A, NewAdd);
2655             }
2656           }
2657         }
2658
2659
2660     // Analyze the case when either Op0 or Op1 is a sub instruction.
2661     // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
2662     A = 0; B = 0; C = 0; D = 0;
2663     if (BO0 && BO0->getOpcode() == Instruction::Sub)
2664       A = BO0->getOperand(0), B = BO0->getOperand(1);
2665     if (BO1 && BO1->getOpcode() == Instruction::Sub)
2666       C = BO1->getOperand(0), D = BO1->getOperand(1);
2667
2668     // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
2669     if (A == Op1 && NoOp0WrapProblem)
2670       return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
2671
2672     // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
2673     if (C == Op0 && NoOp1WrapProblem)
2674       return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
2675
2676     // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
2677     if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
2678         // Try not to increase register pressure.
2679         BO0->hasOneUse() && BO1->hasOneUse())
2680       return new ICmpInst(Pred, A, C);
2681
2682     // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
2683     if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
2684         // Try not to increase register pressure.
2685         BO0->hasOneUse() && BO1->hasOneUse())
2686       return new ICmpInst(Pred, D, B);
2687
2688     BinaryOperator *SRem = NULL;
2689     // icmp (srem X, Y), Y
2690     if (BO0 && BO0->getOpcode() == Instruction::SRem &&
2691         Op1 == BO0->getOperand(1))
2692       SRem = BO0;
2693     // icmp Y, (srem X, Y)
2694     else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
2695              Op0 == BO1->getOperand(1))
2696       SRem = BO1;
2697     if (SRem) {
2698       // We don't check hasOneUse to avoid increasing register pressure because
2699       // the value we use is the same value this instruction was already using.
2700       switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
2701         default: break;
2702         case ICmpInst::ICMP_EQ:
2703           return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
2704         case ICmpInst::ICMP_NE:
2705           return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
2706         case ICmpInst::ICMP_SGT:
2707         case ICmpInst::ICMP_SGE:
2708           return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
2709                               Constant::getAllOnesValue(SRem->getType()));
2710         case ICmpInst::ICMP_SLT:
2711         case ICmpInst::ICMP_SLE:
2712           return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
2713                               Constant::getNullValue(SRem->getType()));
2714       }
2715     }
2716
2717     if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
2718         BO0->hasOneUse() && BO1->hasOneUse() &&
2719         BO0->getOperand(1) == BO1->getOperand(1)) {
2720       switch (BO0->getOpcode()) {
2721       default: break;
2722       case Instruction::Add:
2723       case Instruction::Sub:
2724       case Instruction::Xor:
2725         if (I.isEquality())    // a+x icmp eq/ne b+x --> a icmp b
2726           return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2727                               BO1->getOperand(0));
2728         // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
2729         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
2730           if (CI->getValue().isSignBit()) {
2731             ICmpInst::Predicate Pred = I.isSigned()
2732                                            ? I.getUnsignedPredicate()
2733                                            : I.getSignedPredicate();
2734             return new ICmpInst(Pred, BO0->getOperand(0),
2735                                 BO1->getOperand(0));
2736           }
2737
2738           if (CI->isMaxValue(true)) {
2739             ICmpInst::Predicate Pred = I.isSigned()
2740                                            ? I.getUnsignedPredicate()
2741                                            : I.getSignedPredicate();
2742             Pred = I.getSwappedPredicate(Pred);
2743             return new ICmpInst(Pred, BO0->getOperand(0),
2744                                 BO1->getOperand(0));
2745           }
2746         }
2747         break;
2748       case Instruction::Mul:
2749         if (!I.isEquality())
2750           break;
2751
2752         if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
2753           // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
2754           // Mask = -1 >> count-trailing-zeros(Cst).
2755           if (!CI->isZero() && !CI->isOne()) {
2756             const APInt &AP = CI->getValue();
2757             ConstantInt *Mask = ConstantInt::get(I.getContext(),
2758                                     APInt::getLowBitsSet(AP.getBitWidth(),
2759                                                          AP.getBitWidth() -
2760                                                     AP.countTrailingZeros()));
2761             Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
2762             Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
2763             return new ICmpInst(I.getPredicate(), And1, And2);
2764           }
2765         }
2766         break;
2767       case Instruction::UDiv:
2768       case Instruction::LShr:
2769         if (I.isSigned())
2770           break;
2771         // fall-through
2772       case Instruction::SDiv:
2773       case Instruction::AShr:
2774         if (!BO0->isExact() || !BO1->isExact())
2775           break;
2776         return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2777                             BO1->getOperand(0));
2778       case Instruction::Shl: {
2779         bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
2780         bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
2781         if (!NUW && !NSW)
2782           break;
2783         if (!NSW && I.isSigned())
2784           break;
2785         return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2786                             BO1->getOperand(0));
2787       }
2788       }
2789     }
2790   }
2791
2792   { Value *A, *B;
2793     // Transform (A & ~B) == 0 --> (A & B) != 0
2794     // and       (A & ~B) != 0 --> (A & B) == 0
2795     // if A is a power of 2.
2796     if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
2797         match(Op1, m_Zero()) && isKnownToBeAPowerOfTwo(A) && I.isEquality())
2798       return new ICmpInst(I.getInversePredicate(),
2799                           Builder->CreateAnd(A, B),
2800                           Op1);
2801
2802     // ~x < ~y --> y < x
2803     // ~x < cst --> ~cst < x
2804     if (match(Op0, m_Not(m_Value(A)))) {
2805       if (match(Op1, m_Not(m_Value(B))))
2806         return new ICmpInst(I.getPredicate(), B, A);
2807       if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
2808         return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
2809     }
2810
2811     // (a+b) <u a  --> llvm.uadd.with.overflow.
2812     // (a+b) <u b  --> llvm.uadd.with.overflow.
2813     if (I.getPredicate() == ICmpInst::ICMP_ULT &&
2814         match(Op0, m_Add(m_Value(A), m_Value(B))) &&
2815         (Op1 == A || Op1 == B))
2816       if (Instruction *R = ProcessUAddIdiom(I, Op0, *this))
2817         return R;
2818
2819     // a >u (a+b)  --> llvm.uadd.with.overflow.
2820     // b >u (a+b)  --> llvm.uadd.with.overflow.
2821     if (I.getPredicate() == ICmpInst::ICMP_UGT &&
2822         match(Op1, m_Add(m_Value(A), m_Value(B))) &&
2823         (Op0 == A || Op0 == B))
2824       if (Instruction *R = ProcessUAddIdiom(I, Op1, *this))
2825         return R;
2826   }
2827
2828   if (I.isEquality()) {
2829     Value *A, *B, *C, *D;
2830
2831     if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
2832       if (A == Op1 || B == Op1) {    // (A^B) == A  ->  B == 0
2833         Value *OtherVal = A == Op1 ? B : A;
2834         return new ICmpInst(I.getPredicate(), OtherVal,
2835                             Constant::getNullValue(A->getType()));
2836       }
2837
2838       if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
2839         // A^c1 == C^c2 --> A == C^(c1^c2)
2840         ConstantInt *C1, *C2;
2841         if (match(B, m_ConstantInt(C1)) &&
2842             match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
2843           Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
2844           Value *Xor = Builder->CreateXor(C, NC);
2845           return new ICmpInst(I.getPredicate(), A, Xor);
2846         }
2847
2848         // A^B == A^D -> B == D
2849         if (A == C) return new ICmpInst(I.getPredicate(), B, D);
2850         if (A == D) return new ICmpInst(I.getPredicate(), B, C);
2851         if (B == C) return new ICmpInst(I.getPredicate(), A, D);
2852         if (B == D) return new ICmpInst(I.getPredicate(), A, C);
2853       }
2854     }
2855
2856     if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2857         (A == Op0 || B == Op0)) {
2858       // A == (A^B)  ->  B == 0
2859       Value *OtherVal = A == Op0 ? B : A;
2860       return new ICmpInst(I.getPredicate(), OtherVal,
2861                           Constant::getNullValue(A->getType()));
2862     }
2863
2864     // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
2865     if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
2866         match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
2867       Value *X = 0, *Y = 0, *Z = 0;
2868
2869       if (A == C) {
2870         X = B; Y = D; Z = A;
2871       } else if (A == D) {
2872         X = B; Y = C; Z = A;
2873       } else if (B == C) {
2874         X = A; Y = D; Z = B;
2875       } else if (B == D) {
2876         X = A; Y = C; Z = B;
2877       }
2878
2879       if (X) {   // Build (X^Y) & Z
2880         Op1 = Builder->CreateXor(X, Y);
2881         Op1 = Builder->CreateAnd(Op1, Z);
2882         I.setOperand(0, Op1);
2883         I.setOperand(1, Constant::getNullValue(Op1->getType()));
2884         return &I;
2885       }
2886     }
2887
2888     // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
2889     // and       (B & (1<<X)-1) == (zext A) --> A == (trunc B)
2890     ConstantInt *Cst1;
2891     if ((Op0->hasOneUse() &&
2892          match(Op0, m_ZExt(m_Value(A))) &&
2893          match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
2894         (Op1->hasOneUse() &&
2895          match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
2896          match(Op1, m_ZExt(m_Value(A))))) {
2897       APInt Pow2 = Cst1->getValue() + 1;
2898       if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
2899           Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
2900         return new ICmpInst(I.getPredicate(), A,
2901                             Builder->CreateTrunc(B, A->getType()));
2902     }
2903
2904     // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
2905     // "icmp (and X, mask), cst"
2906     uint64_t ShAmt = 0;
2907     if (Op0->hasOneUse() &&
2908         match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
2909                                            m_ConstantInt(ShAmt))))) &&
2910         match(Op1, m_ConstantInt(Cst1)) &&
2911         // Only do this when A has multiple uses.  This is most important to do
2912         // when it exposes other optimizations.
2913         !A->hasOneUse()) {
2914       unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
2915
2916       if (ShAmt < ASize) {
2917         APInt MaskV =
2918           APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
2919         MaskV <<= ShAmt;
2920
2921         APInt CmpV = Cst1->getValue().zext(ASize);
2922         CmpV <<= ShAmt;
2923
2924         Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
2925         return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
2926       }
2927     }
2928   }
2929
2930   {
2931     Value *X; ConstantInt *Cst;
2932     // icmp X+Cst, X
2933     if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
2934       return FoldICmpAddOpCst(I, X, Cst, I.getPredicate(), Op0);
2935
2936     // icmp X, X+Cst
2937     if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
2938       return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate(), Op1);
2939   }
2940   return Changed ? &I : 0;
2941 }
2942
2943
2944
2945
2946
2947
2948 /// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
2949 ///
2950 Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
2951                                                 Instruction *LHSI,
2952                                                 Constant *RHSC) {
2953   if (!isa<ConstantFP>(RHSC)) return 0;
2954   const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
2955
2956   // Get the width of the mantissa.  We don't want to hack on conversions that
2957   // might lose information from the integer, e.g. "i64 -> float"
2958   int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
2959   if (MantissaWidth == -1) return 0;  // Unknown.
2960
2961   // Check to see that the input is converted from an integer type that is small
2962   // enough that preserves all bits.  TODO: check here for "known" sign bits.
2963   // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
2964   unsigned InputSize = LHSI->getOperand(0)->getType()->getScalarSizeInBits();
2965
2966   // If this is a uitofp instruction, we need an extra bit to hold the sign.
2967   bool LHSUnsigned = isa<UIToFPInst>(LHSI);
2968   if (LHSUnsigned)
2969     ++InputSize;
2970
2971   // If the conversion would lose info, don't hack on this.
2972   if ((int)InputSize > MantissaWidth)
2973     return 0;
2974
2975   // Otherwise, we can potentially simplify the comparison.  We know that it
2976   // will always come through as an integer value and we know the constant is
2977   // not a NAN (it would have been previously simplified).
2978   assert(!RHS.isNaN() && "NaN comparison not already folded!");
2979
2980   ICmpInst::Predicate Pred;
2981   switch (I.getPredicate()) {
2982   default: llvm_unreachable("Unexpected predicate!");
2983   case FCmpInst::FCMP_UEQ:
2984   case FCmpInst::FCMP_OEQ:
2985     Pred = ICmpInst::ICMP_EQ;
2986     break;
2987   case FCmpInst::FCMP_UGT:
2988   case FCmpInst::FCMP_OGT:
2989     Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
2990     break;
2991   case FCmpInst::FCMP_UGE:
2992   case FCmpInst::FCMP_OGE:
2993     Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
2994     break;
2995   case FCmpInst::FCMP_ULT:
2996   case FCmpInst::FCMP_OLT:
2997     Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
2998     break;
2999   case FCmpInst::FCMP_ULE:
3000   case FCmpInst::FCMP_OLE:
3001     Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
3002     break;
3003   case FCmpInst::FCMP_UNE:
3004   case FCmpInst::FCMP_ONE:
3005     Pred = ICmpInst::ICMP_NE;
3006     break;
3007   case FCmpInst::FCMP_ORD:
3008     return ReplaceInstUsesWith(I, Builder->getTrue());
3009   case FCmpInst::FCMP_UNO:
3010     return ReplaceInstUsesWith(I, Builder->getFalse());
3011   }
3012
3013   IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
3014
3015   // Now we know that the APFloat is a normal number, zero or inf.
3016
3017   // See if the FP constant is too large for the integer.  For example,
3018   // comparing an i8 to 300.0.
3019   unsigned IntWidth = IntTy->getScalarSizeInBits();
3020
3021   if (!LHSUnsigned) {
3022     // If the RHS value is > SignedMax, fold the comparison.  This handles +INF
3023     // and large values.
3024     APFloat SMax(RHS.getSemantics());
3025     SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
3026                           APFloat::rmNearestTiesToEven);
3027     if (SMax.compare(RHS) == APFloat::cmpLessThan) {  // smax < 13123.0
3028       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_SLT ||
3029           Pred == ICmpInst::ICMP_SLE)
3030         return ReplaceInstUsesWith(I, Builder->getTrue());
3031       return ReplaceInstUsesWith(I, Builder->getFalse());
3032     }
3033   } else {
3034     // If the RHS value is > UnsignedMax, fold the comparison. This handles
3035     // +INF and large values.
3036     APFloat UMax(RHS.getSemantics());
3037     UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
3038                           APFloat::rmNearestTiesToEven);
3039     if (UMax.compare(RHS) == APFloat::cmpLessThan) {  // umax < 13123.0
3040       if (Pred == ICmpInst::ICMP_NE  || Pred == ICmpInst::ICMP_ULT ||
3041           Pred == ICmpInst::ICMP_ULE)
3042         return ReplaceInstUsesWith(I, Builder->getTrue());
3043       return ReplaceInstUsesWith(I, Builder->getFalse());
3044     }
3045   }
3046
3047   if (!LHSUnsigned) {
3048     // See if the RHS value is < SignedMin.
3049     APFloat SMin(RHS.getSemantics());
3050     SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
3051                           APFloat::rmNearestTiesToEven);
3052     if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
3053       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
3054           Pred == ICmpInst::ICMP_SGE)
3055         return ReplaceInstUsesWith(I, Builder->getTrue());
3056       return ReplaceInstUsesWith(I, Builder->getFalse());
3057     }
3058   } else {
3059     // See if the RHS value is < UnsignedMin.
3060     APFloat SMin(RHS.getSemantics());
3061     SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
3062                           APFloat::rmNearestTiesToEven);
3063     if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
3064       if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
3065           Pred == ICmpInst::ICMP_UGE)
3066         return ReplaceInstUsesWith(I, Builder->getTrue());
3067       return ReplaceInstUsesWith(I, Builder->getFalse());
3068     }
3069   }
3070
3071   // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
3072   // [0, UMAX], but it may still be fractional.  See if it is fractional by
3073   // casting the FP value to the integer value and back, checking for equality.
3074   // Don't do this for zero, because -0.0 is not fractional.
3075   Constant *RHSInt = LHSUnsigned
3076     ? ConstantExpr::getFPToUI(RHSC, IntTy)
3077     : ConstantExpr::getFPToSI(RHSC, IntTy);
3078   if (!RHS.isZero()) {
3079     bool Equal = LHSUnsigned
3080       ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
3081       : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
3082     if (!Equal) {
3083       // If we had a comparison against a fractional value, we have to adjust
3084       // the compare predicate and sometimes the value.  RHSC is rounded towards
3085       // zero at this point.
3086       switch (Pred) {
3087       default: llvm_unreachable("Unexpected integer comparison!");
3088       case ICmpInst::ICMP_NE:  // (float)int != 4.4   --> true
3089         return ReplaceInstUsesWith(I, Builder->getTrue());
3090       case ICmpInst::ICMP_EQ:  // (float)int == 4.4   --> false
3091         return ReplaceInstUsesWith(I, Builder->getFalse());
3092       case ICmpInst::ICMP_ULE:
3093         // (float)int <= 4.4   --> int <= 4
3094         // (float)int <= -4.4  --> false
3095         if (RHS.isNegative())
3096           return ReplaceInstUsesWith(I, Builder->getFalse());
3097         break;
3098       case ICmpInst::ICMP_SLE:
3099         // (float)int <= 4.4   --> int <= 4
3100         // (float)int <= -4.4  --> int < -4
3101         if (RHS.isNegative())
3102           Pred = ICmpInst::ICMP_SLT;
3103         break;
3104       case ICmpInst::ICMP_ULT:
3105         // (float)int < -4.4   --> false
3106         // (float)int < 4.4    --> int <= 4
3107         if (RHS.isNegative())
3108           return ReplaceInstUsesWith(I, Builder->getFalse());
3109         Pred = ICmpInst::ICMP_ULE;
3110         break;
3111       case ICmpInst::ICMP_SLT:
3112         // (float)int < -4.4   --> int < -4
3113         // (float)int < 4.4    --> int <= 4
3114         if (!RHS.isNegative())
3115           Pred = ICmpInst::ICMP_SLE;
3116         break;
3117       case ICmpInst::ICMP_UGT:
3118         // (float)int > 4.4    --> int > 4
3119         // (float)int > -4.4   --> true
3120         if (RHS.isNegative())
3121           return ReplaceInstUsesWith(I, Builder->getTrue());
3122         break;
3123       case ICmpInst::ICMP_SGT:
3124         // (float)int > 4.4    --> int > 4
3125         // (float)int > -4.4   --> int >= -4
3126         if (RHS.isNegative())
3127           Pred = ICmpInst::ICMP_SGE;
3128         break;
3129       case ICmpInst::ICMP_UGE:
3130         // (float)int >= -4.4   --> true
3131         // (float)int >= 4.4    --> int > 4
3132         if (RHS.isNegative())
3133           return ReplaceInstUsesWith(I, Builder->getTrue());
3134         Pred = ICmpInst::ICMP_UGT;
3135         break;
3136       case ICmpInst::ICMP_SGE:
3137         // (float)int >= -4.4   --> int >= -4
3138         // (float)int >= 4.4    --> int > 4
3139         if (!RHS.isNegative())
3140           Pred = ICmpInst::ICMP_SGT;
3141         break;
3142       }
3143     }
3144   }
3145
3146   // Lower this FP comparison into an appropriate integer version of the
3147   // comparison.
3148   return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
3149 }
3150
3151 Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
3152   bool Changed = false;
3153
3154   /// Orders the operands of the compare so that they are listed from most
3155   /// complex to least complex.  This puts constants before unary operators,
3156   /// before binary operators.
3157   if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
3158     I.swapOperands();
3159     Changed = true;
3160   }
3161
3162   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3163
3164   if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, TD))
3165     return ReplaceInstUsesWith(I, V);
3166
3167   // Simplify 'fcmp pred X, X'
3168   if (Op0 == Op1) {
3169     switch (I.getPredicate()) {
3170     default: llvm_unreachable("Unknown predicate!");
3171     case FCmpInst::FCMP_UNO:    // True if unordered: isnan(X) | isnan(Y)
3172     case FCmpInst::FCMP_ULT:    // True if unordered or less than
3173     case FCmpInst::FCMP_UGT:    // True if unordered or greater than
3174     case FCmpInst::FCMP_UNE:    // True if unordered or not equal
3175       // Canonicalize these to be 'fcmp uno %X, 0.0'.
3176       I.setPredicate(FCmpInst::FCMP_UNO);
3177       I.setOperand(1, Constant::getNullValue(Op0->getType()));
3178       return &I;
3179
3180     case FCmpInst::FCMP_ORD:    // True if ordered (no nans)
3181     case FCmpInst::FCMP_OEQ:    // True if ordered and equal
3182     case FCmpInst::FCMP_OGE:    // True if ordered and greater than or equal
3183     case FCmpInst::FCMP_OLE:    // True if ordered and less than or equal
3184       // Canonicalize these to be 'fcmp ord %X, 0.0'.
3185       I.setPredicate(FCmpInst::FCMP_ORD);
3186       I.setOperand(1, Constant::getNullValue(Op0->getType()));
3187       return &I;
3188     }
3189   }
3190
3191   // Handle fcmp with constant RHS
3192   if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3193     if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3194       switch (LHSI->getOpcode()) {
3195       case Instruction::FPExt: {
3196         // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
3197         FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
3198         ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
3199         if (!RHSF)
3200           break;
3201
3202         const fltSemantics *Sem;
3203         // FIXME: This shouldn't be here.
3204         if (LHSExt->getSrcTy()->isHalfTy())
3205           Sem = &APFloat::IEEEhalf;
3206         else if (LHSExt->getSrcTy()->isFloatTy())
3207           Sem = &APFloat::IEEEsingle;
3208         else if (LHSExt->getSrcTy()->isDoubleTy())
3209           Sem = &APFloat::IEEEdouble;
3210         else if (LHSExt->getSrcTy()->isFP128Ty())
3211           Sem = &APFloat::IEEEquad;
3212         else if (LHSExt->getSrcTy()->isX86_FP80Ty())
3213           Sem = &APFloat::x87DoubleExtended;
3214         else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
3215           Sem = &APFloat::PPCDoubleDouble;
3216         else
3217           break;
3218
3219         bool Lossy;
3220         APFloat F = RHSF->getValueAPF();
3221         F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
3222
3223         // Avoid lossy conversions and denormals. Zero is a special case
3224         // that's OK to convert.
3225         APFloat Fabs = F;
3226         Fabs.clearSign();
3227         if (!Lossy &&
3228             ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
3229                  APFloat::cmpLessThan) || Fabs.isZero()))
3230
3231           return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3232                               ConstantFP::get(RHSC->getContext(), F));
3233         break;
3234       }
3235       case Instruction::PHI:
3236         // Only fold fcmp into the PHI if the phi and fcmp are in the same
3237         // block.  If in the same block, we're encouraging jump threading.  If
3238         // not, we are just pessimizing the code by making an i1 phi.
3239         if (LHSI->getParent() == I.getParent())
3240           if (Instruction *NV = FoldOpIntoPhi(I))
3241             return NV;
3242         break;
3243       case Instruction::SIToFP:
3244       case Instruction::UIToFP:
3245         if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
3246           return NV;
3247         break;
3248       case Instruction::Select: {
3249         // If either operand of the select is a constant, we can fold the
3250         // comparison into the select arms, which will cause one to be
3251         // constant folded and the select turned into a bitwise or.
3252         Value *Op1 = 0, *Op2 = 0;
3253         if (LHSI->hasOneUse()) {
3254           if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
3255             // Fold the known value into the constant operand.
3256             Op1 = ConstantExpr::getCompare(I.getPredicate(), C, RHSC);
3257             // Insert a new FCmp of the other select operand.
3258             Op2 = Builder->CreateFCmp(I.getPredicate(),
3259                                       LHSI->getOperand(2), RHSC, I.getName());
3260           } else if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
3261             // Fold the known value into the constant operand.
3262             Op2 = ConstantExpr::getCompare(I.getPredicate(), C, RHSC);
3263             // Insert a new FCmp of the other select operand.
3264             Op1 = Builder->CreateFCmp(I.getPredicate(), LHSI->getOperand(1),
3265                                       RHSC, I.getName());
3266           }
3267         }
3268
3269         if (Op1)
3270           return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3271         break;
3272       }
3273       case Instruction::FSub: {
3274         // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
3275         Value *Op;
3276         if (match(LHSI, m_FNeg(m_Value(Op))))
3277           return new FCmpInst(I.getSwappedPredicate(), Op,
3278                               ConstantExpr::getFNeg(RHSC));
3279         break;
3280       }
3281       case Instruction::Load:
3282         if (GetElementPtrInst *GEP =
3283             dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3284           if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3285             if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3286                 !cast<LoadInst>(LHSI)->isVolatile())
3287               if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3288                 return Res;
3289         }
3290         break;
3291       case Instruction::Call: {
3292         CallInst *CI = cast<CallInst>(LHSI);
3293         LibFunc::Func Func;
3294         // Various optimization for fabs compared with zero.
3295         if (RHSC->isNullValue() && CI->getCalledFunction() &&
3296             TLI->getLibFunc(CI->getCalledFunction()->getName(), Func) &&
3297             TLI->has(Func)) {
3298           if (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
3299               Func == LibFunc::fabsl) {
3300             switch (I.getPredicate()) {
3301             default: break;
3302             // fabs(x) < 0 --> false
3303             case FCmpInst::FCMP_OLT:
3304               return ReplaceInstUsesWith(I, Builder->getFalse());
3305             // fabs(x) > 0 --> x != 0
3306             case FCmpInst::FCMP_OGT:
3307               return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0),
3308                                   RHSC);
3309             // fabs(x) <= 0 --> x == 0
3310             case FCmpInst::FCMP_OLE:
3311               return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0),
3312                                   RHSC);
3313             // fabs(x) >= 0 --> !isnan(x)
3314             case FCmpInst::FCMP_OGE:
3315               return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0),
3316                                   RHSC);
3317             // fabs(x) == 0 --> x == 0
3318             // fabs(x) != 0 --> x != 0
3319             case FCmpInst::FCMP_OEQ:
3320             case FCmpInst::FCMP_UEQ:
3321             case FCmpInst::FCMP_ONE:
3322             case FCmpInst::FCMP_UNE:
3323               return new FCmpInst(I.getPredicate(), CI->getArgOperand(0),
3324                                   RHSC);
3325             }
3326           }
3327         }
3328       }
3329       }
3330   }
3331
3332   // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
3333   Value *X, *Y;
3334   if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
3335     return new FCmpInst(I.getSwappedPredicate(), X, Y);
3336
3337   // fcmp (fpext x), (fpext y) -> fcmp x, y
3338   if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
3339     if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
3340       if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
3341         return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3342                             RHSExt->getOperand(0));
3343
3344   return Changed ? &I : 0;
3345 }