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