lib/Transforms/InstCombine/InstCombineCompares.cpp

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