lib/Transforms/InstCombine/InstCombineCompares.cpp

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