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