lib/Transforms/InstCombine/InstCombineCompares.cpp

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