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 "InstCombineInternal.h" 15 #include "llvm/ADT/APSInt.h" 16 #include "llvm/ADT/SetVector.h" 17 #include "llvm/ADT/Statistic.h" 18 #include "llvm/Analysis/ConstantFolding.h" 19 #include "llvm/Analysis/InstructionSimplify.h" 20 #include "llvm/Analysis/MemoryBuiltins.h" 21 #include "llvm/IR/ConstantRange.h" 22 #include "llvm/IR/DataLayout.h" 23 #include "llvm/IR/GetElementPtrTypeIterator.h" 24 #include "llvm/IR/IntrinsicInst.h" 25 #include "llvm/IR/PatternMatch.h" 26 #include "llvm/Support/CommandLine.h" 27 #include "llvm/Support/Debug.h" 28 #include "llvm/Analysis/TargetLibraryInfo.h" 29 #include "llvm/Analysis/VectorUtils.h" 30 31 using namespace llvm; 32 using namespace PatternMatch; 33 34 #define DEBUG_TYPE "instcombine" 35 36 // How many times is a select replaced by one of its operands? 37 STATISTIC(NumSel, "Number of select opts"); 38 39 // Initialization Routines 40 41 static ConstantInt *getOne(Constant *C) { 42 return ConstantInt::get(cast<IntegerType>(C->getType()), 1); 43 } 44 45 static ConstantInt *ExtractElement(Constant *V, Constant *Idx) { 46 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx)); 47 } 48 49 static bool HasAddOverflow(ConstantInt *Result, 50 ConstantInt *In1, ConstantInt *In2, 51 bool IsSigned) { 52 if (!IsSigned) 53 return Result->getValue().ult(In1->getValue()); 54 55 if (In2->isNegative()) 56 return Result->getValue().sgt(In1->getValue()); 57 return Result->getValue().slt(In1->getValue()); 58 } 59 60 /// AddWithOverflow - Compute Result = In1+In2, returning true if the result 61 /// overflowed for this type. 62 static bool AddWithOverflow(Constant *&Result, Constant *In1, 63 Constant *In2, bool IsSigned = false) { 64 Result = ConstantExpr::getAdd(In1, In2); 65 66 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) { 67 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) { 68 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i); 69 if (HasAddOverflow(ExtractElement(Result, Idx), 70 ExtractElement(In1, Idx), 71 ExtractElement(In2, Idx), 72 IsSigned)) 73 return true; 74 } 75 return false; 76 } 77 78 return HasAddOverflow(cast<ConstantInt>(Result), 79 cast<ConstantInt>(In1), cast<ConstantInt>(In2), 80 IsSigned); 81 } 82 83 static bool HasSubOverflow(ConstantInt *Result, 84 ConstantInt *In1, ConstantInt *In2, 85 bool IsSigned) { 86 if (!IsSigned) 87 return Result->getValue().ugt(In1->getValue()); 88 89 if (In2->isNegative()) 90 return Result->getValue().slt(In1->getValue()); 91 92 return Result->getValue().sgt(In1->getValue()); 93 } 94 95 /// SubWithOverflow - Compute Result = In1-In2, returning true if the result 96 /// overflowed for this type. 97 static bool SubWithOverflow(Constant *&Result, Constant *In1, 98 Constant *In2, bool IsSigned = false) { 99 Result = ConstantExpr::getSub(In1, In2); 100 101 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) { 102 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) { 103 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i); 104 if (HasSubOverflow(ExtractElement(Result, Idx), 105 ExtractElement(In1, Idx), 106 ExtractElement(In2, Idx), 107 IsSigned)) 108 return true; 109 } 110 return false; 111 } 112 113 return HasSubOverflow(cast<ConstantInt>(Result), 114 cast<ConstantInt>(In1), cast<ConstantInt>(In2), 115 IsSigned); 116 } 117 118 /// isSignBitCheck - Given an exploded icmp instruction, return true if the 119 /// comparison only checks the sign bit. If it only checks the sign bit, set 120 /// TrueIfSigned if the result of the comparison is true when the input value is 121 /// signed. 122 static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS, 123 bool &TrueIfSigned) { 124 switch (pred) { 125 case ICmpInst::ICMP_SLT: // True if LHS s< 0 126 TrueIfSigned = true; 127 return RHS->isZero(); 128 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1 129 TrueIfSigned = true; 130 return RHS->isAllOnesValue(); 131 case ICmpInst::ICMP_SGT: // True if LHS s> -1 132 TrueIfSigned = false; 133 return RHS->isAllOnesValue(); 134 case ICmpInst::ICMP_UGT: 135 // True if LHS u> RHS and RHS == high-bit-mask - 1 136 TrueIfSigned = true; 137 return RHS->isMaxValue(true); 138 case ICmpInst::ICMP_UGE: 139 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc) 140 TrueIfSigned = true; 141 return RHS->getValue().isSignBit(); 142 default: 143 return false; 144 } 145 } 146 147 /// Returns true if the exploded icmp can be expressed as a signed comparison 148 /// to zero and updates the predicate accordingly. 149 /// The signedness of the comparison is preserved. 150 static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) { 151 if (!ICmpInst::isSigned(pred)) 152 return false; 153 154 if (RHS->isZero()) 155 return ICmpInst::isRelational(pred); 156 157 if (RHS->isOne()) { 158 if (pred == ICmpInst::ICMP_SLT) { 159 pred = ICmpInst::ICMP_SLE; 160 return true; 161 } 162 } else if (RHS->isAllOnesValue()) { 163 if (pred == ICmpInst::ICMP_SGT) { 164 pred = ICmpInst::ICMP_SGE; 165 return true; 166 } 167 } 168 169 return false; 170 } 171 172 // isHighOnes - Return true if the constant is of the form 1+0+. 173 // This is the same as lowones(~X). 174 static bool isHighOnes(const ConstantInt *CI) { 175 return (~CI->getValue() + 1).isPowerOf2(); 176 } 177 178 /// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a 179 /// set of known zero and one bits, compute the maximum and minimum values that 180 /// could have the specified known zero and known one bits, returning them in 181 /// min/max. 182 static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero, 183 const APInt& KnownOne, 184 APInt& Min, APInt& Max) { 185 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() && 186 KnownZero.getBitWidth() == Min.getBitWidth() && 187 KnownZero.getBitWidth() == Max.getBitWidth() && 188 "KnownZero, KnownOne and Min, Max must have equal bitwidth."); 189 APInt UnknownBits = ~(KnownZero|KnownOne); 190 191 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign 192 // bit if it is unknown. 193 Min = KnownOne; 194 Max = KnownOne|UnknownBits; 195 196 if (UnknownBits.isNegative()) { // Sign bit is unknown 197 Min.setBit(Min.getBitWidth()-1); 198 Max.clearBit(Max.getBitWidth()-1); 199 } 200 } 201 202 // ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and 203 // a set of known zero and one bits, compute the maximum and minimum values that 204 // could have the specified known zero and known one bits, returning them in 205 // min/max. 206 static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero, 207 const APInt &KnownOne, 208 APInt &Min, APInt &Max) { 209 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() && 210 KnownZero.getBitWidth() == Min.getBitWidth() && 211 KnownZero.getBitWidth() == Max.getBitWidth() && 212 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth."); 213 APInt UnknownBits = ~(KnownZero|KnownOne); 214 215 // The minimum value is when the unknown bits are all zeros. 216 Min = KnownOne; 217 // The maximum value is when the unknown bits are all ones. 218 Max = KnownOne|UnknownBits; 219 } 220 221 /// FoldCmpLoadFromIndexedGlobal - Called we see this pattern: 222 /// cmp pred (load (gep GV, ...)), cmpcst 223 /// where GV is a global variable with a constant initializer. Try to simplify 224 /// this into some simple computation that does not need the load. For example 225 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3". 226 /// 227 /// If AndCst is non-null, then the loaded value is masked with that constant 228 /// before doing the comparison. This handles cases like "A[i]&4 == 0". 229 Instruction *InstCombiner:: 230 FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV, 231 CmpInst &ICI, ConstantInt *AndCst) { 232 Constant *Init = GV->getInitializer(); 233 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init)) 234 return nullptr; 235 236 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements(); 237 if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays. 238 239 // There are many forms of this optimization we can handle, for now, just do 240 // the simple index into a single-dimensional array. 241 // 242 // Require: GEP GV, 0, i {{, constant indices}} 243 if (GEP->getNumOperands() < 3 || 244 !isa<ConstantInt>(GEP->getOperand(1)) || 245 !cast<ConstantInt>(GEP->getOperand(1))->isZero() || 246 isa<Constant>(GEP->getOperand(2))) 247 return nullptr; 248 249 // Check that indices after the variable are constants and in-range for the 250 // type they index. Collect the indices. This is typically for arrays of 251 // structs. 252 SmallVector<unsigned, 4> LaterIndices; 253 254 Type *EltTy = Init->getType()->getArrayElementType(); 255 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) { 256 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i)); 257 if (!Idx) return nullptr; // Variable index. 258 259 uint64_t IdxVal = Idx->getZExtValue(); 260 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index. 261 262 if (StructType *STy = dyn_cast<StructType>(EltTy)) 263 EltTy = STy->getElementType(IdxVal); 264 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) { 265 if (IdxVal >= ATy->getNumElements()) return nullptr; 266 EltTy = ATy->getElementType(); 267 } else { 268 return nullptr; // Unknown type. 269 } 270 271 LaterIndices.push_back(IdxVal); 272 } 273 274 enum { Overdefined = -3, Undefined = -2 }; 275 276 // Variables for our state machines. 277 278 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form 279 // "i == 47 | i == 87", where 47 is the first index the condition is true for, 280 // and 87 is the second (and last) index. FirstTrueElement is -2 when 281 // undefined, otherwise set to the first true element. SecondTrueElement is 282 // -2 when undefined, -3 when overdefined and >= 0 when that index is true. 283 int FirstTrueElement = Undefined, SecondTrueElement = Undefined; 284 285 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the 286 // form "i != 47 & i != 87". Same state transitions as for true elements. 287 int FirstFalseElement = Undefined, SecondFalseElement = Undefined; 288 289 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these 290 /// define a state machine that triggers for ranges of values that the index 291 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'. 292 /// This is -2 when undefined, -3 when overdefined, and otherwise the last 293 /// index in the range (inclusive). We use -2 for undefined here because we 294 /// use relative comparisons and don't want 0-1 to match -1. 295 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined; 296 297 // MagicBitvector - This is a magic bitvector where we set a bit if the 298 // comparison is true for element 'i'. If there are 64 elements or less in 299 // the array, this will fully represent all the comparison results. 300 uint64_t MagicBitvector = 0; 301 302 // Scan the array and see if one of our patterns matches. 303 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1)); 304 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) { 305 Constant *Elt = Init->getAggregateElement(i); 306 if (!Elt) return nullptr; 307 308 // If this is indexing an array of structures, get the structure element. 309 if (!LaterIndices.empty()) 310 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices); 311 312 // If the element is masked, handle it. 313 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst); 314 315 // Find out if the comparison would be true or false for the i'th element. 316 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt, 317 CompareRHS, DL, TLI); 318 // If the result is undef for this element, ignore it. 319 if (isa<UndefValue>(C)) { 320 // Extend range state machines to cover this element in case there is an 321 // undef in the middle of the range. 322 if (TrueRangeEnd == (int)i-1) 323 TrueRangeEnd = i; 324 if (FalseRangeEnd == (int)i-1) 325 FalseRangeEnd = i; 326 continue; 327 } 328 329 // If we can't compute the result for any of the elements, we have to give 330 // up evaluating the entire conditional. 331 if (!isa<ConstantInt>(C)) return nullptr; 332 333 // Otherwise, we know if the comparison is true or false for this element, 334 // update our state machines. 335 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero(); 336 337 // State machine for single/double/range index comparison. 338 if (IsTrueForElt) { 339 // Update the TrueElement state machine. 340 if (FirstTrueElement == Undefined) 341 FirstTrueElement = TrueRangeEnd = i; // First true element. 342 else { 343 // Update double-compare state machine. 344 if (SecondTrueElement == Undefined) 345 SecondTrueElement = i; 346 else 347 SecondTrueElement = Overdefined; 348 349 // Update range state machine. 350 if (TrueRangeEnd == (int)i-1) 351 TrueRangeEnd = i; 352 else 353 TrueRangeEnd = Overdefined; 354 } 355 } else { 356 // Update the FalseElement state machine. 357 if (FirstFalseElement == Undefined) 358 FirstFalseElement = FalseRangeEnd = i; // First false element. 359 else { 360 // Update double-compare state machine. 361 if (SecondFalseElement == Undefined) 362 SecondFalseElement = i; 363 else 364 SecondFalseElement = Overdefined; 365 366 // Update range state machine. 367 if (FalseRangeEnd == (int)i-1) 368 FalseRangeEnd = i; 369 else 370 FalseRangeEnd = Overdefined; 371 } 372 } 373 374 // If this element is in range, update our magic bitvector. 375 if (i < 64 && IsTrueForElt) 376 MagicBitvector |= 1ULL << i; 377 378 // If all of our states become overdefined, bail out early. Since the 379 // predicate is expensive, only check it every 8 elements. This is only 380 // really useful for really huge arrays. 381 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined && 382 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined && 383 FalseRangeEnd == Overdefined) 384 return nullptr; 385 } 386 387 // Now that we've scanned the entire array, emit our new comparison(s). We 388 // order the state machines in complexity of the generated code. 389 Value *Idx = GEP->getOperand(2); 390 391 // If the index is larger than the pointer size of the target, truncate the 392 // index down like the GEP would do implicitly. We don't have to do this for 393 // an inbounds GEP because the index can't be out of range. 394 if (!GEP->isInBounds()) { 395 Type *IntPtrTy = DL.getIntPtrType(GEP->getType()); 396 unsigned PtrSize = IntPtrTy->getIntegerBitWidth(); 397 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize) 398 Idx = Builder->CreateTrunc(Idx, IntPtrTy); 399 } 400 401 // If the comparison is only true for one or two elements, emit direct 402 // comparisons. 403 if (SecondTrueElement != Overdefined) { 404 // None true -> false. 405 if (FirstTrueElement == Undefined) 406 return replaceInstUsesWith(ICI, Builder->getFalse()); 407 408 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement); 409 410 // True for one element -> 'i == 47'. 411 if (SecondTrueElement == Undefined) 412 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx); 413 414 // True for two elements -> 'i == 47 | i == 72'. 415 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx); 416 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement); 417 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx); 418 return BinaryOperator::CreateOr(C1, C2); 419 } 420 421 // If the comparison is only false for one or two elements, emit direct 422 // comparisons. 423 if (SecondFalseElement != Overdefined) { 424 // None false -> true. 425 if (FirstFalseElement == Undefined) 426 return replaceInstUsesWith(ICI, Builder->getTrue()); 427 428 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement); 429 430 // False for one element -> 'i != 47'. 431 if (SecondFalseElement == Undefined) 432 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx); 433 434 // False for two elements -> 'i != 47 & i != 72'. 435 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx); 436 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement); 437 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx); 438 return BinaryOperator::CreateAnd(C1, C2); 439 } 440 441 // If the comparison can be replaced with a range comparison for the elements 442 // where it is true, emit the range check. 443 if (TrueRangeEnd != Overdefined) { 444 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare"); 445 446 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1). 447 if (FirstTrueElement) { 448 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement); 449 Idx = Builder->CreateAdd(Idx, Offs); 450 } 451 452 Value *End = ConstantInt::get(Idx->getType(), 453 TrueRangeEnd-FirstTrueElement+1); 454 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End); 455 } 456 457 // False range check. 458 if (FalseRangeEnd != Overdefined) { 459 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare"); 460 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse). 461 if (FirstFalseElement) { 462 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement); 463 Idx = Builder->CreateAdd(Idx, Offs); 464 } 465 466 Value *End = ConstantInt::get(Idx->getType(), 467 FalseRangeEnd-FirstFalseElement); 468 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End); 469 } 470 471 // If a magic bitvector captures the entire comparison state 472 // of this load, replace it with computation that does: 473 // ((magic_cst >> i) & 1) != 0 474 { 475 Type *Ty = nullptr; 476 477 // Look for an appropriate type: 478 // - The type of Idx if the magic fits 479 // - The smallest fitting legal type if we have a DataLayout 480 // - Default to i32 481 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth()) 482 Ty = Idx->getType(); 483 else 484 Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount); 485 486 if (Ty) { 487 Value *V = Builder->CreateIntCast(Idx, Ty, false); 488 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V); 489 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V); 490 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0)); 491 } 492 } 493 494 return nullptr; 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) { 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 // Okay, we know we have a single variable index, which must be a 563 // pointer/array/vector index. If there is no offset, life is simple, return 564 // the index. 565 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType()); 566 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth(); 567 if (Offset == 0) { 568 // Cast to intptrty in case a truncation occurs. If an extension is needed, 569 // we don't need to bother extending: the extension won't affect where the 570 // computation crosses zero. 571 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) { 572 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy); 573 } 574 return VariableIdx; 575 } 576 577 // Otherwise, there is an index. The computation we will do will be modulo 578 // the pointer size, so get it. 579 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth); 580 581 Offset &= PtrSizeMask; 582 VariableScale &= PtrSizeMask; 583 584 // To do this transformation, any constant index must be a multiple of the 585 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i", 586 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a 587 // multiple of the variable scale. 588 int64_t NewOffs = Offset / (int64_t)VariableScale; 589 if (Offset != NewOffs*(int64_t)VariableScale) 590 return nullptr; 591 592 // Okay, we can do this evaluation. Start by converting the index to intptr. 593 if (VariableIdx->getType() != IntPtrTy) 594 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy, 595 true /*Signed*/); 596 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs); 597 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset"); 598 } 599 600 /// Returns true if we can rewrite Start as a GEP with pointer Base 601 /// and some integer offset. The nodes that need to be re-written 602 /// for this transformation will be added to Explored. 603 static bool canRewriteGEPAsOffset(Value *Start, Value *Base, 604 const DataLayout &DL, 605 SetVector<Value *> &Explored) { 606 SmallVector<Value *, 16> WorkList(1, Start); 607 Explored.insert(Base); 608 609 // The following traversal gives us an order which can be used 610 // when doing the final transformation. Since in the final 611 // transformation we create the PHI replacement instructions first, 612 // we don't have to get them in any particular order. 613 // 614 // However, for other instructions we will have to traverse the 615 // operands of an instruction first, which means that we have to 616 // do a post-order traversal. 617 while (!WorkList.empty()) { 618 SetVector<PHINode *> PHIs; 619 620 while (!WorkList.empty()) { 621 if (Explored.size() >= 100) 622 return false; 623 624 Value *V = WorkList.back(); 625 626 if (Explored.count(V) != 0) { 627 WorkList.pop_back(); 628 continue; 629 } 630 631 if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) && 632 !isa<GEPOperator>(V) && !isa<PHINode>(V)) 633 // We've found some value that we can't explore which is different from 634 // the base. Therefore we can't do this transformation. 635 return false; 636 637 if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) { 638 auto *CI = dyn_cast<CastInst>(V); 639 if (!CI->isNoopCast(DL)) 640 return false; 641 642 if (Explored.count(CI->getOperand(0)) == 0) 643 WorkList.push_back(CI->getOperand(0)); 644 } 645 646 if (auto *GEP = dyn_cast<GEPOperator>(V)) { 647 // We're limiting the GEP to having one index. This will preserve 648 // the original pointer type. We could handle more cases in the 649 // future. 650 if (GEP->getNumIndices() != 1 || !GEP->isInBounds() || 651 GEP->getType() != Start->getType()) 652 return false; 653 654 if (Explored.count(GEP->getOperand(0)) == 0) 655 WorkList.push_back(GEP->getOperand(0)); 656 } 657 658 if (WorkList.back() == V) { 659 WorkList.pop_back(); 660 // We've finished visiting this node, mark it as such. 661 Explored.insert(V); 662 } 663 664 if (auto *PN = dyn_cast<PHINode>(V)) { 665 // We cannot transform PHIs on unsplittable basic blocks. 666 if (isa<CatchSwitchInst>(PN->getParent()->getTerminator())) 667 return false; 668 Explored.insert(PN); 669 PHIs.insert(PN); 670 } 671 } 672 673 // Explore the PHI nodes further. 674 for (auto *PN : PHIs) 675 for (Value *Op : PN->incoming_values()) 676 if (Explored.count(Op) == 0) 677 WorkList.push_back(Op); 678 } 679 680 // Make sure that we can do this. Since we can't insert GEPs in a basic 681 // block before a PHI node, we can't easily do this transformation if 682 // we have PHI node users of transformed instructions. 683 for (Value *Val : Explored) { 684 for (Value *Use : Val->uses()) { 685 686 auto *PHI = dyn_cast<PHINode>(Use); 687 auto *Inst = dyn_cast<Instruction>(Val); 688 689 if (Inst == Base || Inst == PHI || !Inst || !PHI || 690 Explored.count(PHI) == 0) 691 continue; 692 693 if (PHI->getParent() == Inst->getParent()) 694 return false; 695 } 696 } 697 return true; 698 } 699 700 // Sets the appropriate insert point on Builder where we can add 701 // a replacement Instruction for V (if that is possible). 702 static void setInsertionPoint(IRBuilder<> &Builder, Value *V, 703 bool Before = true) { 704 if (auto *PHI = dyn_cast<PHINode>(V)) { 705 Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt()); 706 return; 707 } 708 if (auto *I = dyn_cast<Instruction>(V)) { 709 if (!Before) 710 I = &*std::next(I->getIterator()); 711 Builder.SetInsertPoint(I); 712 return; 713 } 714 if (auto *A = dyn_cast<Argument>(V)) { 715 // Set the insertion point in the entry block. 716 BasicBlock &Entry = A->getParent()->getEntryBlock(); 717 Builder.SetInsertPoint(&*Entry.getFirstInsertionPt()); 718 return; 719 } 720 // Otherwise, this is a constant and we don't need to set a new 721 // insertion point. 722 assert(isa<Constant>(V) && "Setting insertion point for unknown value!"); 723 } 724 725 /// Returns a re-written value of Start as an indexed GEP using Base as a 726 /// pointer. 727 static Value *rewriteGEPAsOffset(Value *Start, Value *Base, 728 const DataLayout &DL, 729 SetVector<Value *> &Explored) { 730 // Perform all the substitutions. This is a bit tricky because we can 731 // have cycles in our use-def chains. 732 // 1. Create the PHI nodes without any incoming values. 733 // 2. Create all the other values. 734 // 3. Add the edges for the PHI nodes. 735 // 4. Emit GEPs to get the original pointers. 736 // 5. Remove the original instructions. 737 Type *IndexType = IntegerType::get( 738 Base->getContext(), DL.getPointerTypeSizeInBits(Start->getType())); 739 740 DenseMap<Value *, Value *> NewInsts; 741 NewInsts[Base] = ConstantInt::getNullValue(IndexType); 742 743 // Create the new PHI nodes, without adding any incoming values. 744 for (Value *Val : Explored) { 745 if (Val == Base) 746 continue; 747 // Create empty phi nodes. This avoids cyclic dependencies when creating 748 // the remaining instructions. 749 if (auto *PHI = dyn_cast<PHINode>(Val)) 750 NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(), 751 PHI->getName() + ".idx", PHI); 752 } 753 IRBuilder<> Builder(Base->getContext()); 754 755 // Create all the other instructions. 756 for (Value *Val : Explored) { 757 758 if (NewInsts.find(Val) != NewInsts.end()) 759 continue; 760 761 if (auto *CI = dyn_cast<CastInst>(Val)) { 762 NewInsts[CI] = NewInsts[CI->getOperand(0)]; 763 continue; 764 } 765 if (auto *GEP = dyn_cast<GEPOperator>(Val)) { 766 Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)] 767 : GEP->getOperand(1); 768 setInsertionPoint(Builder, GEP); 769 // Indices might need to be sign extended. GEPs will magically do 770 // this, but we need to do it ourselves here. 771 if (Index->getType()->getScalarSizeInBits() != 772 NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) { 773 Index = Builder.CreateSExtOrTrunc( 774 Index, NewInsts[GEP->getOperand(0)]->getType(), 775 GEP->getOperand(0)->getName() + ".sext"); 776 } 777 778 auto *Op = NewInsts[GEP->getOperand(0)]; 779 if (isa<ConstantInt>(Op) && dyn_cast<ConstantInt>(Op)->isZero()) 780 NewInsts[GEP] = Index; 781 else 782 NewInsts[GEP] = Builder.CreateNSWAdd( 783 Op, Index, GEP->getOperand(0)->getName() + ".add"); 784 continue; 785 } 786 if (isa<PHINode>(Val)) 787 continue; 788 789 llvm_unreachable("Unexpected instruction type"); 790 } 791 792 // Add the incoming values to the PHI nodes. 793 for (Value *Val : Explored) { 794 if (Val == Base) 795 continue; 796 // All the instructions have been created, we can now add edges to the 797 // phi nodes. 798 if (auto *PHI = dyn_cast<PHINode>(Val)) { 799 PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]); 800 for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) { 801 Value *NewIncoming = PHI->getIncomingValue(I); 802 803 if (NewInsts.find(NewIncoming) != NewInsts.end()) 804 NewIncoming = NewInsts[NewIncoming]; 805 806 NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I)); 807 } 808 } 809 } 810 811 for (Value *Val : Explored) { 812 if (Val == Base) 813 continue; 814 815 // Depending on the type, for external users we have to emit 816 // a GEP or a GEP + ptrtoint. 817 setInsertionPoint(Builder, Val, false); 818 819 // If required, create an inttoptr instruction for Base. 820 Value *NewBase = Base; 821 if (!Base->getType()->isPointerTy()) 822 NewBase = Builder.CreateBitOrPointerCast(Base, Start->getType(), 823 Start->getName() + "to.ptr"); 824 825 Value *GEP = Builder.CreateInBoundsGEP( 826 Start->getType()->getPointerElementType(), NewBase, 827 makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr"); 828 829 if (!Val->getType()->isPointerTy()) { 830 Value *Cast = Builder.CreatePointerCast(GEP, Val->getType(), 831 Val->getName() + ".conv"); 832 GEP = Cast; 833 } 834 Val->replaceAllUsesWith(GEP); 835 } 836 837 return NewInsts[Start]; 838 } 839 840 /// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express 841 /// the input Value as a constant indexed GEP. Returns a pair containing 842 /// the GEPs Pointer and Index. 843 static std::pair<Value *, Value *> 844 getAsConstantIndexedAddress(Value *V, const DataLayout &DL) { 845 Type *IndexType = IntegerType::get(V->getContext(), 846 DL.getPointerTypeSizeInBits(V->getType())); 847 848 Constant *Index = ConstantInt::getNullValue(IndexType); 849 while (true) { 850 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) { 851 // We accept only inbouds GEPs here to exclude the possibility of 852 // overflow. 853 if (!GEP->isInBounds()) 854 break; 855 if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 && 856 GEP->getType() == V->getType()) { 857 V = GEP->getOperand(0); 858 Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1)); 859 Index = ConstantExpr::getAdd( 860 Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType)); 861 continue; 862 } 863 break; 864 } 865 if (auto *CI = dyn_cast<IntToPtrInst>(V)) { 866 if (!CI->isNoopCast(DL)) 867 break; 868 V = CI->getOperand(0); 869 continue; 870 } 871 if (auto *CI = dyn_cast<PtrToIntInst>(V)) { 872 if (!CI->isNoopCast(DL)) 873 break; 874 V = CI->getOperand(0); 875 continue; 876 } 877 break; 878 } 879 return {V, Index}; 880 } 881 882 // Converts (CMP GEPLHS, RHS) if this change would make RHS a constant. 883 // We can look through PHIs, GEPs and casts in order to determine a 884 // common base between GEPLHS and RHS. 885 static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS, 886 ICmpInst::Predicate Cond, 887 const DataLayout &DL) { 888 if (!GEPLHS->hasAllConstantIndices()) 889 return nullptr; 890 891 Value *PtrBase, *Index; 892 std::tie(PtrBase, Index) = getAsConstantIndexedAddress(GEPLHS, DL); 893 894 // The set of nodes that will take part in this transformation. 895 SetVector<Value *> Nodes; 896 897 if (!canRewriteGEPAsOffset(RHS, PtrBase, DL, Nodes)) 898 return nullptr; 899 900 // We know we can re-write this as 901 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) 902 // Since we've only looked through inbouds GEPs we know that we 903 // can't have overflow on either side. We can therefore re-write 904 // this as: 905 // OFFSET1 cmp OFFSET2 906 Value *NewRHS = rewriteGEPAsOffset(RHS, PtrBase, DL, Nodes); 907 908 // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written 909 // GEP having PtrBase as the pointer base, and has returned in NewRHS the 910 // offset. Since Index is the offset of LHS to the base pointer, we will now 911 // compare the offsets instead of comparing the pointers. 912 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS); 913 } 914 915 /// FoldGEPICmp - Fold comparisons between a GEP instruction and something 916 /// else. At this point we know that the GEP is on the LHS of the comparison. 917 Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS, 918 ICmpInst::Predicate Cond, 919 Instruction &I) { 920 // Don't transform signed compares of GEPs into index compares. Even if the 921 // GEP is inbounds, the final add of the base pointer can have signed overflow 922 // and would change the result of the icmp. 923 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be 924 // the maximum signed value for the pointer type. 925 if (ICmpInst::isSigned(Cond)) 926 return nullptr; 927 928 // Look through bitcasts and addrspacecasts. We do not however want to remove 929 // 0 GEPs. 930 if (!isa<GetElementPtrInst>(RHS)) 931 RHS = RHS->stripPointerCasts(); 932 933 Value *PtrBase = GEPLHS->getOperand(0); 934 if (PtrBase == RHS && GEPLHS->isInBounds()) { 935 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0). 936 // This transformation (ignoring the base and scales) is valid because we 937 // know pointers can't overflow since the gep is inbounds. See if we can 938 // output an optimized form. 939 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this, DL); 940 941 // If not, synthesize the offset the hard way. 942 if (!Offset) 943 Offset = EmitGEPOffset(GEPLHS); 944 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset, 945 Constant::getNullValue(Offset->getType())); 946 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) { 947 // If the base pointers are different, but the indices are the same, just 948 // compare the base pointer. 949 if (PtrBase != GEPRHS->getOperand(0)) { 950 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands(); 951 IndicesTheSame &= GEPLHS->getOperand(0)->getType() == 952 GEPRHS->getOperand(0)->getType(); 953 if (IndicesTheSame) 954 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i) 955 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) { 956 IndicesTheSame = false; 957 break; 958 } 959 960 // If all indices are the same, just compare the base pointers. 961 if (IndicesTheSame) 962 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0)); 963 964 // If we're comparing GEPs with two base pointers that only differ in type 965 // and both GEPs have only constant indices or just one use, then fold 966 // the compare with the adjusted indices. 967 if (GEPLHS->isInBounds() && GEPRHS->isInBounds() && 968 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) && 969 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) && 970 PtrBase->stripPointerCasts() == 971 GEPRHS->getOperand(0)->stripPointerCasts()) { 972 Value *LOffset = EmitGEPOffset(GEPLHS); 973 Value *ROffset = EmitGEPOffset(GEPRHS); 974 975 // If we looked through an addrspacecast between different sized address 976 // spaces, the LHS and RHS pointers are different sized 977 // integers. Truncate to the smaller one. 978 Type *LHSIndexTy = LOffset->getType(); 979 Type *RHSIndexTy = ROffset->getType(); 980 if (LHSIndexTy != RHSIndexTy) { 981 if (LHSIndexTy->getPrimitiveSizeInBits() < 982 RHSIndexTy->getPrimitiveSizeInBits()) { 983 ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy); 984 } else 985 LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy); 986 } 987 988 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond), 989 LOffset, ROffset); 990 return replaceInstUsesWith(I, Cmp); 991 } 992 993 // Otherwise, the base pointers are different and the indices are 994 // different. Try convert this to an indexed compare by looking through 995 // PHIs/casts. 996 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL); 997 } 998 999 // If one of the GEPs has all zero indices, recurse. 1000 if (GEPLHS->hasAllZeroIndices()) 1001 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0), 1002 ICmpInst::getSwappedPredicate(Cond), I); 1003 1004 // If the other GEP has all zero indices, recurse. 1005 if (GEPRHS->hasAllZeroIndices()) 1006 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I); 1007 1008 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds(); 1009 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) { 1010 // If the GEPs only differ by one index, compare it. 1011 unsigned NumDifferences = 0; // Keep track of # differences. 1012 unsigned DiffOperand = 0; // The operand that differs. 1013 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i) 1014 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) { 1015 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() != 1016 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) { 1017 // Irreconcilable differences. 1018 NumDifferences = 2; 1019 break; 1020 } else { 1021 if (NumDifferences++) break; 1022 DiffOperand = i; 1023 } 1024 } 1025 1026 if (NumDifferences == 0) // SAME GEP? 1027 return replaceInstUsesWith(I, // No comparison is needed here. 1028 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond))); 1029 1030 else if (NumDifferences == 1 && GEPsInBounds) { 1031 Value *LHSV = GEPLHS->getOperand(DiffOperand); 1032 Value *RHSV = GEPRHS->getOperand(DiffOperand); 1033 // Make sure we do a signed comparison here. 1034 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV); 1035 } 1036 } 1037 1038 // Only lower this if the icmp is the only user of the GEP or if we expect 1039 // the result to fold to a constant! 1040 if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) && 1041 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) { 1042 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2) 1043 Value *L = EmitGEPOffset(GEPLHS); 1044 Value *R = EmitGEPOffset(GEPRHS); 1045 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R); 1046 } 1047 } 1048 1049 // Try convert this to an indexed compare by looking through PHIs/casts as a 1050 // last resort. 1051 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL); 1052 } 1053 1054 Instruction *InstCombiner::FoldAllocaCmp(ICmpInst &ICI, AllocaInst *Alloca, 1055 Value *Other) { 1056 assert(ICI.isEquality() && "Cannot fold non-equality comparison."); 1057 1058 // It would be tempting to fold away comparisons between allocas and any 1059 // pointer not based on that alloca (e.g. an argument). However, even 1060 // though such pointers cannot alias, they can still compare equal. 1061 // 1062 // But LLVM doesn't specify where allocas get their memory, so if the alloca 1063 // doesn't escape we can argue that it's impossible to guess its value, and we 1064 // can therefore act as if any such guesses are wrong. 1065 // 1066 // The code below checks that the alloca doesn't escape, and that it's only 1067 // used in a comparison once (the current instruction). The 1068 // single-comparison-use condition ensures that we're trivially folding all 1069 // comparisons against the alloca consistently, and avoids the risk of 1070 // erroneously folding a comparison of the pointer with itself. 1071 1072 unsigned MaxIter = 32; // Break cycles and bound to constant-time. 1073 1074 SmallVector<Use *, 32> Worklist; 1075 for (Use &U : Alloca->uses()) { 1076 if (Worklist.size() >= MaxIter) 1077 return nullptr; 1078 Worklist.push_back(&U); 1079 } 1080 1081 unsigned NumCmps = 0; 1082 while (!Worklist.empty()) { 1083 assert(Worklist.size() <= MaxIter); 1084 Use *U = Worklist.pop_back_val(); 1085 Value *V = U->getUser(); 1086 --MaxIter; 1087 1088 if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) || 1089 isa<SelectInst>(V)) { 1090 // Track the uses. 1091 } else if (isa<LoadInst>(V)) { 1092 // Loading from the pointer doesn't escape it. 1093 continue; 1094 } else if (auto *SI = dyn_cast<StoreInst>(V)) { 1095 // Storing *to* the pointer is fine, but storing the pointer escapes it. 1096 if (SI->getValueOperand() == U->get()) 1097 return nullptr; 1098 continue; 1099 } else if (isa<ICmpInst>(V)) { 1100 if (NumCmps++) 1101 return nullptr; // Found more than one cmp. 1102 continue; 1103 } else if (auto *Intrin = dyn_cast<IntrinsicInst>(V)) { 1104 switch (Intrin->getIntrinsicID()) { 1105 // These intrinsics don't escape or compare the pointer. Memset is safe 1106 // because we don't allow ptrtoint. Memcpy and memmove are safe because 1107 // we don't allow stores, so src cannot point to V. 1108 case Intrinsic::lifetime_start: case Intrinsic::lifetime_end: 1109 case Intrinsic::dbg_declare: case Intrinsic::dbg_value: 1110 case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset: 1111 continue; 1112 default: 1113 return nullptr; 1114 } 1115 } else { 1116 return nullptr; 1117 } 1118 for (Use &U : V->uses()) { 1119 if (Worklist.size() >= MaxIter) 1120 return nullptr; 1121 Worklist.push_back(&U); 1122 } 1123 } 1124 1125 Type *CmpTy = CmpInst::makeCmpResultType(Other->getType()); 1126 return replaceInstUsesWith( 1127 ICI, 1128 ConstantInt::get(CmpTy, !CmpInst::isTrueWhenEqual(ICI.getPredicate()))); 1129 } 1130 1131 /// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X". 1132 Instruction *InstCombiner::FoldICmpAddOpCst(Instruction &ICI, 1133 Value *X, ConstantInt *CI, 1134 ICmpInst::Predicate Pred) { 1135 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0, 1136 // so the values can never be equal. Similarly for all other "or equals" 1137 // operators. 1138 1139 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255 1140 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253 1141 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0 1142 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) { 1143 Value *R = 1144 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI); 1145 return new ICmpInst(ICmpInst::ICMP_UGT, X, R); 1146 } 1147 1148 // (X+1) >u X --> X <u (0-1) --> X != 255 1149 // (X+2) >u X --> X <u (0-2) --> X <u 254 1150 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0 1151 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE) 1152 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI)); 1153 1154 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits(); 1155 ConstantInt *SMax = ConstantInt::get(X->getContext(), 1156 APInt::getSignedMaxValue(BitWidth)); 1157 1158 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127 1159 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125 1160 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0 1161 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1 1162 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126 1163 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127 1164 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) 1165 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI)); 1166 1167 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127 1168 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126 1169 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1 1170 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2 1171 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126 1172 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128 1173 1174 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE); 1175 Constant *C = Builder->getInt(CI->getValue()-1); 1176 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C)); 1177 } 1178 1179 /// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS 1180 /// and CmpRHS are both known to be integer constants. 1181 Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI, 1182 ConstantInt *DivRHS) { 1183 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1)); 1184 const APInt &CmpRHSV = CmpRHS->getValue(); 1185 1186 // FIXME: If the operand types don't match the type of the divide 1187 // then don't attempt this transform. The code below doesn't have the 1188 // logic to deal with a signed divide and an unsigned compare (and 1189 // vice versa). This is because (x /s C1) <s C2 produces different 1190 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even 1191 // (x /u C1) <u C2. Simply casting the operands and result won't 1192 // work. :( The if statement below tests that condition and bails 1193 // if it finds it. 1194 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv; 1195 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned()) 1196 return nullptr; 1197 if (DivRHS->isZero()) 1198 return nullptr; // The ProdOV computation fails on divide by zero. 1199 if (DivIsSigned && DivRHS->isAllOnesValue()) 1200 return nullptr; // The overflow computation also screws up here 1201 if (DivRHS->isOne()) { 1202 // This eliminates some funny cases with INT_MIN. 1203 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X. 1204 return &ICI; 1205 } 1206 1207 // Compute Prod = CI * DivRHS. We are essentially solving an equation 1208 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and 1209 // C2 (CI). By solving for X we can turn this into a range check 1210 // instead of computing a divide. 1211 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS); 1212 1213 // Determine if the product overflows by seeing if the product is 1214 // not equal to the divide. Make sure we do the same kind of divide 1215 // as in the LHS instruction that we're folding. 1216 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) : 1217 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS; 1218 1219 // Get the ICmp opcode 1220 ICmpInst::Predicate Pred = ICI.getPredicate(); 1221 1222 /// If the division is known to be exact, then there is no remainder from the 1223 /// divide, so the covered range size is unit, otherwise it is the divisor. 1224 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS; 1225 1226 // Figure out the interval that is being checked. For example, a comparison 1227 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5). 1228 // Compute this interval based on the constants involved and the signedness of 1229 // the compare/divide. This computes a half-open interval, keeping track of 1230 // whether either value in the interval overflows. After analysis each 1231 // overflow variable is set to 0 if it's corresponding bound variable is valid 1232 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end. 1233 int LoOverflow = 0, HiOverflow = 0; 1234 Constant *LoBound = nullptr, *HiBound = nullptr; 1235 1236 if (!DivIsSigned) { // udiv 1237 // e.g. X/5 op 3 --> [15, 20) 1238 LoBound = Prod; 1239 HiOverflow = LoOverflow = ProdOV; 1240 if (!HiOverflow) { 1241 // If this is not an exact divide, then many values in the range collapse 1242 // to the same result value. 1243 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false); 1244 } 1245 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0. 1246 if (CmpRHSV == 0) { // (X / pos) op 0 1247 // Can't overflow. e.g. X/2 op 0 --> [-1, 2) 1248 LoBound = ConstantExpr::getNeg(SubOne(RangeSize)); 1249 HiBound = RangeSize; 1250 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos 1251 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20) 1252 HiOverflow = LoOverflow = ProdOV; 1253 if (!HiOverflow) 1254 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true); 1255 } else { // (X / pos) op neg 1256 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14) 1257 HiBound = AddOne(Prod); 1258 LoOverflow = HiOverflow = ProdOV ? -1 : 0; 1259 if (!LoOverflow) { 1260 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize)); 1261 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0; 1262 } 1263 } 1264 } else if (DivRHS->isNegative()) { // Divisor is < 0. 1265 if (DivI->isExact()) 1266 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize)); 1267 if (CmpRHSV == 0) { // (X / neg) op 0 1268 // e.g. X/-5 op 0 --> [-4, 5) 1269 LoBound = AddOne(RangeSize); 1270 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize)); 1271 if (HiBound == DivRHS) { // -INTMIN = INTMIN 1272 HiOverflow = 1; // [INTMIN+1, overflow) 1273 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN 1274 } 1275 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos 1276 // e.g. X/-5 op 3 --> [-19, -14) 1277 HiBound = AddOne(Prod); 1278 HiOverflow = LoOverflow = ProdOV ? -1 : 0; 1279 if (!LoOverflow) 1280 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0; 1281 } else { // (X / neg) op neg 1282 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20) 1283 LoOverflow = HiOverflow = ProdOV; 1284 if (!HiOverflow) 1285 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true); 1286 } 1287 1288 // Dividing by a negative swaps the condition. LT <-> GT 1289 Pred = ICmpInst::getSwappedPredicate(Pred); 1290 } 1291 1292 Value *X = DivI->getOperand(0); 1293 switch (Pred) { 1294 default: llvm_unreachable("Unhandled icmp opcode!"); 1295 case ICmpInst::ICMP_EQ: 1296 if (LoOverflow && HiOverflow) 1297 return replaceInstUsesWith(ICI, Builder->getFalse()); 1298 if (HiOverflow) 1299 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE : 1300 ICmpInst::ICMP_UGE, X, LoBound); 1301 if (LoOverflow) 1302 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT : 1303 ICmpInst::ICMP_ULT, X, HiBound); 1304 return replaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound, 1305 DivIsSigned, true)); 1306 case ICmpInst::ICMP_NE: 1307 if (LoOverflow && HiOverflow) 1308 return replaceInstUsesWith(ICI, Builder->getTrue()); 1309 if (HiOverflow) 1310 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT : 1311 ICmpInst::ICMP_ULT, X, LoBound); 1312 if (LoOverflow) 1313 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE : 1314 ICmpInst::ICMP_UGE, X, HiBound); 1315 return replaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound, 1316 DivIsSigned, false)); 1317 case ICmpInst::ICMP_ULT: 1318 case ICmpInst::ICMP_SLT: 1319 if (LoOverflow == +1) // Low bound is greater than input range. 1320 return replaceInstUsesWith(ICI, Builder->getTrue()); 1321 if (LoOverflow == -1) // Low bound is less than input range. 1322 return replaceInstUsesWith(ICI, Builder->getFalse()); 1323 return new ICmpInst(Pred, X, LoBound); 1324 case ICmpInst::ICMP_UGT: 1325 case ICmpInst::ICMP_SGT: 1326 if (HiOverflow == +1) // High bound greater than input range. 1327 return replaceInstUsesWith(ICI, Builder->getFalse()); 1328 if (HiOverflow == -1) // High bound less than input range. 1329 return replaceInstUsesWith(ICI, Builder->getTrue()); 1330 if (Pred == ICmpInst::ICMP_UGT) 1331 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound); 1332 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound); 1333 } 1334 } 1335 1336 /// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)". 1337 Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr, 1338 ConstantInt *ShAmt) { 1339 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue(); 1340 1341 // Check that the shift amount is in range. If not, don't perform 1342 // undefined shifts. When the shift is visited it will be 1343 // simplified. 1344 uint32_t TypeBits = CmpRHSV.getBitWidth(); 1345 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits); 1346 if (ShAmtVal >= TypeBits || ShAmtVal == 0) 1347 return nullptr; 1348 1349 if (!ICI.isEquality()) { 1350 // If we have an unsigned comparison and an ashr, we can't simplify this. 1351 // Similarly for signed comparisons with lshr. 1352 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr)) 1353 return nullptr; 1354 1355 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv 1356 // by a power of 2. Since we already have logic to simplify these, 1357 // transform to div and then simplify the resultant comparison. 1358 if (Shr->getOpcode() == Instruction::AShr && 1359 (!Shr->isExact() || ShAmtVal == TypeBits - 1)) 1360 return nullptr; 1361 1362 // Revisit the shift (to delete it). 1363 Worklist.Add(Shr); 1364 1365 Constant *DivCst = 1366 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal)); 1367 1368 Value *Tmp = 1369 Shr->getOpcode() == Instruction::AShr ? 1370 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) : 1371 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()); 1372 1373 ICI.setOperand(0, Tmp); 1374 1375 // If the builder folded the binop, just return it. 1376 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp); 1377 if (!TheDiv) 1378 return &ICI; 1379 1380 // Otherwise, fold this div/compare. 1381 assert(TheDiv->getOpcode() == Instruction::SDiv || 1382 TheDiv->getOpcode() == Instruction::UDiv); 1383 1384 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst)); 1385 assert(Res && "This div/cst should have folded!"); 1386 return Res; 1387 } 1388 1389 // If we are comparing against bits always shifted out, the 1390 // comparison cannot succeed. 1391 APInt Comp = CmpRHSV << ShAmtVal; 1392 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp); 1393 if (Shr->getOpcode() == Instruction::LShr) 1394 Comp = Comp.lshr(ShAmtVal); 1395 else 1396 Comp = Comp.ashr(ShAmtVal); 1397 1398 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero. 1399 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE; 1400 Constant *Cst = Builder->getInt1(IsICMP_NE); 1401 return replaceInstUsesWith(ICI, Cst); 1402 } 1403 1404 // Otherwise, check to see if the bits shifted out are known to be zero. 1405 // If so, we can compare against the unshifted value: 1406 // (X & 4) >> 1 == 2 --> (X & 4) == 4. 1407 if (Shr->hasOneUse() && Shr->isExact()) 1408 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS); 1409 1410 if (Shr->hasOneUse()) { 1411 // Otherwise strength reduce the shift into an and. 1412 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal)); 1413 Constant *Mask = Builder->getInt(Val); 1414 1415 Value *And = Builder->CreateAnd(Shr->getOperand(0), 1416 Mask, Shr->getName()+".mask"); 1417 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS); 1418 } 1419 return nullptr; 1420 } 1421 1422 /// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" -> 1423 /// (icmp eq/ne A, Log2(const2/const1)) -> 1424 /// (icmp eq/ne A, Log2(const2) - Log2(const1)). 1425 Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A, 1426 ConstantInt *CI1, 1427 ConstantInt *CI2) { 1428 assert(I.isEquality() && "Cannot fold icmp gt/lt"); 1429 1430 auto getConstant = [&I, this](bool IsTrue) { 1431 if (I.getPredicate() == I.ICMP_NE) 1432 IsTrue = !IsTrue; 1433 return replaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue)); 1434 }; 1435 1436 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) { 1437 if (I.getPredicate() == I.ICMP_NE) 1438 Pred = CmpInst::getInversePredicate(Pred); 1439 return new ICmpInst(Pred, LHS, RHS); 1440 }; 1441 1442 APInt AP1 = CI1->getValue(); 1443 APInt AP2 = CI2->getValue(); 1444 1445 // Don't bother doing any work for cases which InstSimplify handles. 1446 if (AP2 == 0) 1447 return nullptr; 1448 bool IsAShr = isa<AShrOperator>(Op); 1449 if (IsAShr) { 1450 if (AP2.isAllOnesValue()) 1451 return nullptr; 1452 if (AP2.isNegative() != AP1.isNegative()) 1453 return nullptr; 1454 if (AP2.sgt(AP1)) 1455 return nullptr; 1456 } 1457 1458 if (!AP1) 1459 // 'A' must be large enough to shift out the highest set bit. 1460 return getICmp(I.ICMP_UGT, A, 1461 ConstantInt::get(A->getType(), AP2.logBase2())); 1462 1463 if (AP1 == AP2) 1464 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType())); 1465 1466 int Shift; 1467 if (IsAShr && AP1.isNegative()) 1468 Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes(); 1469 else 1470 Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros(); 1471 1472 if (Shift > 0) { 1473 if (IsAShr && AP1 == AP2.ashr(Shift)) { 1474 // There are multiple solutions if we are comparing against -1 and the LHS 1475 // of the ashr is not a power of two. 1476 if (AP1.isAllOnesValue() && !AP2.isPowerOf2()) 1477 return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift)); 1478 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift)); 1479 } else if (AP1 == AP2.lshr(Shift)) { 1480 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift)); 1481 } 1482 } 1483 // Shifting const2 will never be equal to const1. 1484 return getConstant(false); 1485 } 1486 1487 /// FoldICmpCstShlCst - Handle "(icmp eq/ne (shl const2, A), const1)" -> 1488 /// (icmp eq/ne A, TrailingZeros(const1) - TrailingZeros(const2)). 1489 Instruction *InstCombiner::FoldICmpCstShlCst(ICmpInst &I, Value *Op, Value *A, 1490 ConstantInt *CI1, 1491 ConstantInt *CI2) { 1492 assert(I.isEquality() && "Cannot fold icmp gt/lt"); 1493 1494 auto getConstant = [&I, this](bool IsTrue) { 1495 if (I.getPredicate() == I.ICMP_NE) 1496 IsTrue = !IsTrue; 1497 return replaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue)); 1498 }; 1499 1500 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) { 1501 if (I.getPredicate() == I.ICMP_NE) 1502 Pred = CmpInst::getInversePredicate(Pred); 1503 return new ICmpInst(Pred, LHS, RHS); 1504 }; 1505 1506 APInt AP1 = CI1->getValue(); 1507 APInt AP2 = CI2->getValue(); 1508 1509 // Don't bother doing any work for cases which InstSimplify handles. 1510 if (AP2 == 0) 1511 return nullptr; 1512 1513 unsigned AP2TrailingZeros = AP2.countTrailingZeros(); 1514 1515 if (!AP1 && AP2TrailingZeros != 0) 1516 return getICmp(I.ICMP_UGE, A, 1517 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros)); 1518 1519 if (AP1 == AP2) 1520 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType())); 1521 1522 // Get the distance between the lowest bits that are set. 1523 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros; 1524 1525 if (Shift > 0 && AP2.shl(Shift) == AP1) 1526 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift)); 1527 1528 // Shifting const2 will never be equal to const1. 1529 return getConstant(false); 1530 } 1531 1532 /// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)". 1533 /// 1534 Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI, 1535 Instruction *LHSI, 1536 ConstantInt *RHS) { 1537 const APInt &RHSV = RHS->getValue(); 1538 1539 switch (LHSI->getOpcode()) { 1540 case Instruction::Trunc: 1541 if (RHS->isOne() && RHSV.getBitWidth() > 1) { 1542 // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1 1543 Value *V = nullptr; 1544 if (ICI.getPredicate() == ICmpInst::ICMP_SLT && 1545 match(LHSI->getOperand(0), m_Signum(m_Value(V)))) 1546 return new ICmpInst(ICmpInst::ICMP_SLT, V, 1547 ConstantInt::get(V->getType(), 1)); 1548 } 1549 if (ICI.isEquality() && LHSI->hasOneUse()) { 1550 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all 1551 // of the high bits truncated out of x are known. 1552 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(), 1553 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits(); 1554 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0); 1555 computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne, 0, &ICI); 1556 1557 // If all the high bits are known, we can do this xform. 1558 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) { 1559 // Pull in the high bits from known-ones set. 1560 APInt NewRHS = RHS->getValue().zext(SrcBits); 1561 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits); 1562 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0), 1563 Builder->getInt(NewRHS)); 1564 } 1565 } 1566 break; 1567 1568 case Instruction::Xor: // (icmp pred (xor X, XorCst), CI) 1569 if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) { 1570 // If this is a comparison that tests the signbit (X < 0) or (x > -1), 1571 // fold the xor. 1572 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) || 1573 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) { 1574 Value *CompareVal = LHSI->getOperand(0); 1575 1576 // If the sign bit of the XorCst is not set, there is no change to 1577 // the operation, just stop using the Xor. 1578 if (!XorCst->isNegative()) { 1579 ICI.setOperand(0, CompareVal); 1580 Worklist.Add(LHSI); 1581 return &ICI; 1582 } 1583 1584 // Was the old condition true if the operand is positive? 1585 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT; 1586 1587 // If so, the new one isn't. 1588 isTrueIfPositive ^= true; 1589 1590 if (isTrueIfPositive) 1591 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal, 1592 SubOne(RHS)); 1593 else 1594 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal, 1595 AddOne(RHS)); 1596 } 1597 1598 if (LHSI->hasOneUse()) { 1599 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit)) 1600 if (!ICI.isEquality() && XorCst->getValue().isSignBit()) { 1601 const APInt &SignBit = XorCst->getValue(); 1602 ICmpInst::Predicate Pred = ICI.isSigned() 1603 ? ICI.getUnsignedPredicate() 1604 : ICI.getSignedPredicate(); 1605 return new ICmpInst(Pred, LHSI->getOperand(0), 1606 Builder->getInt(RHSV ^ SignBit)); 1607 } 1608 1609 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A) 1610 if (!ICI.isEquality() && XorCst->isMaxValue(true)) { 1611 const APInt &NotSignBit = XorCst->getValue(); 1612 ICmpInst::Predicate Pred = ICI.isSigned() 1613 ? ICI.getUnsignedPredicate() 1614 : ICI.getSignedPredicate(); 1615 Pred = ICI.getSwappedPredicate(Pred); 1616 return new ICmpInst(Pred, LHSI->getOperand(0), 1617 Builder->getInt(RHSV ^ NotSignBit)); 1618 } 1619 } 1620 1621 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C) 1622 // iff -C is a power of 2 1623 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && 1624 XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2()) 1625 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst); 1626 1627 // (icmp ult (xor X, C), -C) -> (icmp uge X, C) 1628 // iff -C is a power of 2 1629 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && 1630 XorCst->getValue() == -RHSV && RHSV.isPowerOf2()) 1631 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst); 1632 } 1633 break; 1634 case Instruction::And: // (icmp pred (and X, AndCst), RHS) 1635 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) && 1636 LHSI->getOperand(0)->hasOneUse()) { 1637 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1)); 1638 1639 // If the LHS is an AND of a truncating cast, we can widen the 1640 // and/compare to be the input width without changing the value 1641 // produced, eliminating a cast. 1642 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) { 1643 // We can do this transformation if either the AND constant does not 1644 // have its sign bit set or if it is an equality comparison. 1645 // Extending a relational comparison when we're checking the sign 1646 // bit would not work. 1647 if (ICI.isEquality() || 1648 (!AndCst->isNegative() && RHSV.isNonNegative())) { 1649 Value *NewAnd = 1650 Builder->CreateAnd(Cast->getOperand(0), 1651 ConstantExpr::getZExt(AndCst, Cast->getSrcTy())); 1652 NewAnd->takeName(LHSI); 1653 return new ICmpInst(ICI.getPredicate(), NewAnd, 1654 ConstantExpr::getZExt(RHS, Cast->getSrcTy())); 1655 } 1656 } 1657 1658 // If the LHS is an AND of a zext, and we have an equality compare, we can 1659 // shrink the and/compare to the smaller type, eliminating the cast. 1660 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) { 1661 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy()); 1662 // Make sure we don't compare the upper bits, SimplifyDemandedBits 1663 // should fold the icmp to true/false in that case. 1664 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) { 1665 Value *NewAnd = 1666 Builder->CreateAnd(Cast->getOperand(0), 1667 ConstantExpr::getTrunc(AndCst, Ty)); 1668 NewAnd->takeName(LHSI); 1669 return new ICmpInst(ICI.getPredicate(), NewAnd, 1670 ConstantExpr::getTrunc(RHS, Ty)); 1671 } 1672 } 1673 1674 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare 1675 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This 1676 // happens a LOT in code produced by the C front-end, for bitfield 1677 // access. 1678 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0)); 1679 if (Shift && !Shift->isShift()) 1680 Shift = nullptr; 1681 1682 ConstantInt *ShAmt; 1683 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr; 1684 1685 // This seemingly simple opportunity to fold away a shift turns out to 1686 // be rather complicated. See PR17827 1687 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details. 1688 if (ShAmt) { 1689 bool CanFold = false; 1690 unsigned ShiftOpcode = Shift->getOpcode(); 1691 if (ShiftOpcode == Instruction::AShr) { 1692 // There may be some constraints that make this possible, 1693 // but nothing simple has been discovered yet. 1694 CanFold = false; 1695 } else if (ShiftOpcode == Instruction::Shl) { 1696 // For a left shift, we can fold if the comparison is not signed. 1697 // We can also fold a signed comparison if the mask value and 1698 // comparison value are not negative. These constraints may not be 1699 // obvious, but we can prove that they are correct using an SMT 1700 // solver. 1701 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative())) 1702 CanFold = true; 1703 } else if (ShiftOpcode == Instruction::LShr) { 1704 // For a logical right shift, we can fold if the comparison is not 1705 // signed. We can also fold a signed comparison if the shifted mask 1706 // value and the shifted comparison value are not negative. 1707 // These constraints may not be obvious, but we can prove that they 1708 // are correct using an SMT solver. 1709 if (!ICI.isSigned()) 1710 CanFold = true; 1711 else { 1712 ConstantInt *ShiftedAndCst = 1713 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt)); 1714 ConstantInt *ShiftedRHSCst = 1715 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt)); 1716 1717 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative()) 1718 CanFold = true; 1719 } 1720 } 1721 1722 if (CanFold) { 1723 Constant *NewCst; 1724 if (ShiftOpcode == Instruction::Shl) 1725 NewCst = ConstantExpr::getLShr(RHS, ShAmt); 1726 else 1727 NewCst = ConstantExpr::getShl(RHS, ShAmt); 1728 1729 // Check to see if we are shifting out any of the bits being 1730 // compared. 1731 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) { 1732 // If we shifted bits out, the fold is not going to work out. 1733 // As a special case, check to see if this means that the 1734 // result is always true or false now. 1735 if (ICI.getPredicate() == ICmpInst::ICMP_EQ) 1736 return replaceInstUsesWith(ICI, Builder->getFalse()); 1737 if (ICI.getPredicate() == ICmpInst::ICMP_NE) 1738 return replaceInstUsesWith(ICI, Builder->getTrue()); 1739 } else { 1740 ICI.setOperand(1, NewCst); 1741 Constant *NewAndCst; 1742 if (ShiftOpcode == Instruction::Shl) 1743 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt); 1744 else 1745 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt); 1746 LHSI->setOperand(1, NewAndCst); 1747 LHSI->setOperand(0, Shift->getOperand(0)); 1748 Worklist.Add(Shift); // Shift is dead. 1749 return &ICI; 1750 } 1751 } 1752 } 1753 1754 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is 1755 // preferable because it allows the C<<Y expression to be hoisted out 1756 // of a loop if Y is invariant and X is not. 1757 if (Shift && Shift->hasOneUse() && RHSV == 0 && 1758 ICI.isEquality() && !Shift->isArithmeticShift() && 1759 !isa<Constant>(Shift->getOperand(0))) { 1760 // Compute C << Y. 1761 Value *NS; 1762 if (Shift->getOpcode() == Instruction::LShr) { 1763 NS = Builder->CreateShl(AndCst, Shift->getOperand(1)); 1764 } else { 1765 // Insert a logical shift. 1766 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1)); 1767 } 1768 1769 // Compute X & (C << Y). 1770 Value *NewAnd = 1771 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName()); 1772 1773 ICI.setOperand(0, NewAnd); 1774 return &ICI; 1775 } 1776 1777 // (icmp pred (and (or (lshr X, Y), X), 1), 0) --> 1778 // (icmp pred (and X, (or (shl 1, Y), 1), 0)) 1779 // 1780 // iff pred isn't signed 1781 { 1782 Value *X, *Y, *LShr; 1783 if (!ICI.isSigned() && RHSV == 0) { 1784 if (match(LHSI->getOperand(1), m_One())) { 1785 Constant *One = cast<Constant>(LHSI->getOperand(1)); 1786 Value *Or = LHSI->getOperand(0); 1787 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) && 1788 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) { 1789 unsigned UsesRemoved = 0; 1790 if (LHSI->hasOneUse()) 1791 ++UsesRemoved; 1792 if (Or->hasOneUse()) 1793 ++UsesRemoved; 1794 if (LShr->hasOneUse()) 1795 ++UsesRemoved; 1796 Value *NewOr = nullptr; 1797 // Compute X & ((1 << Y) | 1) 1798 if (auto *C = dyn_cast<Constant>(Y)) { 1799 if (UsesRemoved >= 1) 1800 NewOr = 1801 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One); 1802 } else { 1803 if (UsesRemoved >= 3) 1804 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y, 1805 LShr->getName(), 1806 /*HasNUW=*/true), 1807 One, Or->getName()); 1808 } 1809 if (NewOr) { 1810 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName()); 1811 ICI.setOperand(0, NewAnd); 1812 return &ICI; 1813 } 1814 } 1815 } 1816 } 1817 } 1818 1819 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any 1820 // bit set in (X & AndCst) will produce a result greater than RHSV. 1821 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) { 1822 unsigned NTZ = AndCst->getValue().countTrailingZeros(); 1823 if ((NTZ < AndCst->getBitWidth()) && 1824 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV)) 1825 return new ICmpInst(ICmpInst::ICMP_NE, LHSI, 1826 Constant::getNullValue(RHS->getType())); 1827 } 1828 } 1829 1830 // Try to optimize things like "A[i]&42 == 0" to index computations. 1831 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) { 1832 if (GetElementPtrInst *GEP = 1833 dyn_cast<GetElementPtrInst>(LI->getOperand(0))) 1834 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0))) 1835 if (GV->isConstant() && GV->hasDefinitiveInitializer() && 1836 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) { 1837 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1)); 1838 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C)) 1839 return Res; 1840 } 1841 } 1842 1843 // X & -C == -C -> X > u ~C 1844 // X & -C != -C -> X <= u ~C 1845 // iff C is a power of 2 1846 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2()) 1847 return new ICmpInst( 1848 ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT 1849 : ICmpInst::ICMP_ULE, 1850 LHSI->getOperand(0), SubOne(RHS)); 1851 1852 // (icmp eq (and %A, C), 0) -> (icmp sgt (trunc %A), -1) 1853 // iff C is a power of 2 1854 if (ICI.isEquality() && LHSI->hasOneUse() && match(RHS, m_Zero())) { 1855 if (auto *CI = dyn_cast<ConstantInt>(LHSI->getOperand(1))) { 1856 const APInt &AI = CI->getValue(); 1857 int32_t ExactLogBase2 = AI.exactLogBase2(); 1858 if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) { 1859 Type *NTy = IntegerType::get(ICI.getContext(), ExactLogBase2 + 1); 1860 Value *Trunc = Builder->CreateTrunc(LHSI->getOperand(0), NTy); 1861 return new ICmpInst(ICI.getPredicate() == ICmpInst::ICMP_EQ 1862 ? ICmpInst::ICMP_SGE 1863 : ICmpInst::ICMP_SLT, 1864 Trunc, Constant::getNullValue(NTy)); 1865 } 1866 } 1867 } 1868 break; 1869 1870 case Instruction::Or: { 1871 if (RHS->isOne()) { 1872 // icmp slt signum(V) 1 --> icmp slt V, 1 1873 Value *V = nullptr; 1874 if (ICI.getPredicate() == ICmpInst::ICMP_SLT && 1875 match(LHSI, m_Signum(m_Value(V)))) 1876 return new ICmpInst(ICmpInst::ICMP_SLT, V, 1877 ConstantInt::get(V->getType(), 1)); 1878 } 1879 1880 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse()) 1881 break; 1882 Value *P, *Q; 1883 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) { 1884 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0 1885 // -> and (icmp eq P, null), (icmp eq Q, null). 1886 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P, 1887 Constant::getNullValue(P->getType())); 1888 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q, 1889 Constant::getNullValue(Q->getType())); 1890 Instruction *Op; 1891 if (ICI.getPredicate() == ICmpInst::ICMP_EQ) 1892 Op = BinaryOperator::CreateAnd(ICIP, ICIQ); 1893 else 1894 Op = BinaryOperator::CreateOr(ICIP, ICIQ); 1895 return Op; 1896 } 1897 break; 1898 } 1899 1900 case Instruction::Mul: { // (icmp pred (mul X, Val), CI) 1901 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1)); 1902 if (!Val) break; 1903 1904 // If this is a signed comparison to 0 and the mul is sign preserving, 1905 // use the mul LHS operand instead. 1906 ICmpInst::Predicate pred = ICI.getPredicate(); 1907 if (isSignTest(pred, RHS) && !Val->isZero() && 1908 cast<BinaryOperator>(LHSI)->hasNoSignedWrap()) 1909 return new ICmpInst(Val->isNegative() ? 1910 ICmpInst::getSwappedPredicate(pred) : pred, 1911 LHSI->getOperand(0), 1912 Constant::getNullValue(RHS->getType())); 1913 1914 break; 1915 } 1916 1917 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI) 1918 uint32_t TypeBits = RHSV.getBitWidth(); 1919 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1)); 1920 if (!ShAmt) { 1921 Value *X; 1922 // (1 << X) pred P2 -> X pred Log2(P2) 1923 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) { 1924 bool RHSVIsPowerOf2 = RHSV.isPowerOf2(); 1925 ICmpInst::Predicate Pred = ICI.getPredicate(); 1926 if (ICI.isUnsigned()) { 1927 if (!RHSVIsPowerOf2) { 1928 // (1 << X) < 30 -> X <= 4 1929 // (1 << X) <= 30 -> X <= 4 1930 // (1 << X) >= 30 -> X > 4 1931 // (1 << X) > 30 -> X > 4 1932 if (Pred == ICmpInst::ICMP_ULT) 1933 Pred = ICmpInst::ICMP_ULE; 1934 else if (Pred == ICmpInst::ICMP_UGE) 1935 Pred = ICmpInst::ICMP_UGT; 1936 } 1937 unsigned RHSLog2 = RHSV.logBase2(); 1938 1939 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31 1940 // (1 << X) < 2147483648 -> X < 31 -> X != 31 1941 if (RHSLog2 == TypeBits-1) { 1942 if (Pred == ICmpInst::ICMP_UGE) 1943 Pred = ICmpInst::ICMP_EQ; 1944 else if (Pred == ICmpInst::ICMP_ULT) 1945 Pred = ICmpInst::ICMP_NE; 1946 } 1947 1948 return new ICmpInst(Pred, X, 1949 ConstantInt::get(RHS->getType(), RHSLog2)); 1950 } else if (ICI.isSigned()) { 1951 if (RHSV.isAllOnesValue()) { 1952 // (1 << X) <= -1 -> X == 31 1953 if (Pred == ICmpInst::ICMP_SLE) 1954 return new ICmpInst(ICmpInst::ICMP_EQ, X, 1955 ConstantInt::get(RHS->getType(), TypeBits-1)); 1956 1957 // (1 << X) > -1 -> X != 31 1958 if (Pred == ICmpInst::ICMP_SGT) 1959 return new ICmpInst(ICmpInst::ICMP_NE, X, 1960 ConstantInt::get(RHS->getType(), TypeBits-1)); 1961 } else if (!RHSV) { 1962 // (1 << X) < 0 -> X == 31 1963 // (1 << X) <= 0 -> X == 31 1964 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) 1965 return new ICmpInst(ICmpInst::ICMP_EQ, X, 1966 ConstantInt::get(RHS->getType(), TypeBits-1)); 1967 1968 // (1 << X) >= 0 -> X != 31 1969 // (1 << X) > 0 -> X != 31 1970 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE) 1971 return new ICmpInst(ICmpInst::ICMP_NE, X, 1972 ConstantInt::get(RHS->getType(), TypeBits-1)); 1973 } 1974 } else if (ICI.isEquality()) { 1975 if (RHSVIsPowerOf2) 1976 return new ICmpInst( 1977 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2())); 1978 } 1979 } 1980 break; 1981 } 1982 1983 // Check that the shift amount is in range. If not, don't perform 1984 // undefined shifts. When the shift is visited it will be 1985 // simplified. 1986 if (ShAmt->uge(TypeBits)) 1987 break; 1988 1989 if (ICI.isEquality()) { 1990 // If we are comparing against bits always shifted out, the 1991 // comparison cannot succeed. 1992 Constant *Comp = 1993 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt), 1994 ShAmt); 1995 if (Comp != RHS) {// Comparing against a bit that we know is zero. 1996 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE; 1997 Constant *Cst = Builder->getInt1(IsICMP_NE); 1998 return replaceInstUsesWith(ICI, Cst); 1999 } 2000 2001 // If the shift is NUW, then it is just shifting out zeros, no need for an 2002 // AND. 2003 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap()) 2004 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0), 2005 ConstantExpr::getLShr(RHS, ShAmt)); 2006 2007 // If the shift is NSW and we compare to 0, then it is just shifting out 2008 // sign bits, no need for an AND either. 2009 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0) 2010 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0), 2011 ConstantExpr::getLShr(RHS, ShAmt)); 2012 2013 if (LHSI->hasOneUse()) { 2014 // Otherwise strength reduce the shift into an and. 2015 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits); 2016 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits, 2017 TypeBits - ShAmtVal)); 2018 2019 Value *And = 2020 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask"); 2021 return new ICmpInst(ICI.getPredicate(), And, 2022 ConstantExpr::getLShr(RHS, ShAmt)); 2023 } 2024 } 2025 2026 // If this is a signed comparison to 0 and the shift is sign preserving, 2027 // use the shift LHS operand instead. 2028 ICmpInst::Predicate pred = ICI.getPredicate(); 2029 if (isSignTest(pred, RHS) && 2030 cast<BinaryOperator>(LHSI)->hasNoSignedWrap()) 2031 return new ICmpInst(pred, 2032 LHSI->getOperand(0), 2033 Constant::getNullValue(RHS->getType())); 2034 2035 // Otherwise, if this is a comparison of the sign bit, simplify to and/test. 2036 bool TrueIfSigned = false; 2037 if (LHSI->hasOneUse() && 2038 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) { 2039 // (X << 31) <s 0 --> (X&1) != 0 2040 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(), 2041 APInt::getOneBitSet(TypeBits, 2042 TypeBits-ShAmt->getZExtValue()-1)); 2043 Value *And = 2044 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask"); 2045 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ, 2046 And, Constant::getNullValue(And->getType())); 2047 } 2048 2049 // Transform (icmp pred iM (shl iM %v, N), CI) 2050 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N)) 2051 // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N. 2052 // This enables to get rid of the shift in favor of a trunc which can be 2053 // free on the target. It has the additional benefit of comparing to a 2054 // smaller constant, which will be target friendly. 2055 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1); 2056 if (LHSI->hasOneUse() && 2057 Amt != 0 && RHSV.countTrailingZeros() >= Amt) { 2058 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt); 2059 Constant *NCI = ConstantExpr::getTrunc( 2060 ConstantExpr::getAShr(RHS, 2061 ConstantInt::get(RHS->getType(), Amt)), 2062 NTy); 2063 return new ICmpInst(ICI.getPredicate(), 2064 Builder->CreateTrunc(LHSI->getOperand(0), NTy), 2065 NCI); 2066 } 2067 2068 break; 2069 } 2070 2071 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI) 2072 case Instruction::AShr: { 2073 // Handle equality comparisons of shift-by-constant. 2074 BinaryOperator *BO = cast<BinaryOperator>(LHSI); 2075 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) { 2076 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt)) 2077 return Res; 2078 } 2079 2080 // Handle exact shr's. 2081 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) { 2082 if (RHSV.isMinValue()) 2083 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS); 2084 } 2085 break; 2086 } 2087 2088 case Instruction::SDiv: 2089 case Instruction::UDiv: 2090 // Fold: icmp pred ([us]div X, C1), C2 -> range test 2091 // Fold this div into the comparison, producing a range check. 2092 // Determine, based on the divide type, what the range is being 2093 // checked. If there is an overflow on the low or high side, remember 2094 // it, otherwise compute the range [low, hi) bounding the new value. 2095 // See: InsertRangeTest above for the kinds of replacements possible. 2096 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1))) 2097 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI), 2098 DivRHS)) 2099 return R; 2100 break; 2101 2102 case Instruction::Sub: { 2103 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0)); 2104 if (!LHSC) break; 2105 const APInt &LHSV = LHSC->getValue(); 2106 2107 // C1-X <u C2 -> (X|(C2-1)) == C1 2108 // iff C1 & (C2-1) == C2-1 2109 // C2 is a power of 2 2110 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() && 2111 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1)) 2112 return new ICmpInst(ICmpInst::ICMP_EQ, 2113 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1), 2114 LHSC); 2115 2116 // C1-X >u C2 -> (X|C2) != C1 2117 // iff C1 & C2 == C2 2118 // C2+1 is a power of 2 2119 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() && 2120 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV) 2121 return new ICmpInst(ICmpInst::ICMP_NE, 2122 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC); 2123 break; 2124 } 2125 2126 case Instruction::Add: 2127 // Fold: icmp pred (add X, C1), C2 2128 if (!ICI.isEquality()) { 2129 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1)); 2130 if (!LHSC) break; 2131 const APInt &LHSV = LHSC->getValue(); 2132 2133 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV) 2134 .subtract(LHSV); 2135 2136 if (ICI.isSigned()) { 2137 if (CR.getLower().isSignBit()) { 2138 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0), 2139 Builder->getInt(CR.getUpper())); 2140 } else if (CR.getUpper().isSignBit()) { 2141 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0), 2142 Builder->getInt(CR.getLower())); 2143 } 2144 } else { 2145 if (CR.getLower().isMinValue()) { 2146 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), 2147 Builder->getInt(CR.getUpper())); 2148 } else if (CR.getUpper().isMinValue()) { 2149 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), 2150 Builder->getInt(CR.getLower())); 2151 } 2152 } 2153 2154 // X-C1 <u C2 -> (X & -C2) == C1 2155 // iff C1 & (C2-1) == 0 2156 // C2 is a power of 2 2157 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() && 2158 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0) 2159 return new ICmpInst(ICmpInst::ICMP_EQ, 2160 Builder->CreateAnd(LHSI->getOperand(0), -RHSV), 2161 ConstantExpr::getNeg(LHSC)); 2162 2163 // X-C1 >u C2 -> (X & ~C2) != C1 2164 // iff C1 & C2 == 0 2165 // C2+1 is a power of 2 2166 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() && 2167 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0) 2168 return new ICmpInst(ICmpInst::ICMP_NE, 2169 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV), 2170 ConstantExpr::getNeg(LHSC)); 2171 } 2172 break; 2173 } 2174 2175 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS. 2176 if (ICI.isEquality()) { 2177 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE; 2178 2179 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and 2180 // the second operand is a constant, simplify a bit. 2181 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) { 2182 switch (BO->getOpcode()) { 2183 case Instruction::SRem: 2184 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one. 2185 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){ 2186 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue(); 2187 if (V.sgt(1) && V.isPowerOf2()) { 2188 Value *NewRem = 2189 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1), 2190 BO->getName()); 2191 return new ICmpInst(ICI.getPredicate(), NewRem, 2192 Constant::getNullValue(BO->getType())); 2193 } 2194 } 2195 break; 2196 case Instruction::Add: 2197 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants. 2198 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) { 2199 if (BO->hasOneUse()) 2200 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), 2201 ConstantExpr::getSub(RHS, BOp1C)); 2202 } else if (RHSV == 0) { 2203 // Replace ((add A, B) != 0) with (A != -B) if A or B is 2204 // efficiently invertible, or if the add has just this one use. 2205 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1); 2206 2207 if (Value *NegVal = dyn_castNegVal(BOp1)) 2208 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal); 2209 if (Value *NegVal = dyn_castNegVal(BOp0)) 2210 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1); 2211 if (BO->hasOneUse()) { 2212 Value *Neg = Builder->CreateNeg(BOp1); 2213 Neg->takeName(BO); 2214 return new ICmpInst(ICI.getPredicate(), BOp0, Neg); 2215 } 2216 } 2217 break; 2218 case Instruction::Xor: 2219 if (BO->hasOneUse()) { 2220 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) { 2221 // For the xor case, we can xor two constants together, eliminating 2222 // the explicit xor. 2223 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), 2224 ConstantExpr::getXor(RHS, BOC)); 2225 } else if (RHSV == 0) { 2226 // Replace ((xor A, B) != 0) with (A != B) 2227 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), 2228 BO->getOperand(1)); 2229 } 2230 } 2231 break; 2232 case Instruction::Sub: 2233 if (BO->hasOneUse()) { 2234 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) { 2235 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants. 2236 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1), 2237 ConstantExpr::getSub(BOp0C, RHS)); 2238 } else if (RHSV == 0) { 2239 // Replace ((sub A, B) != 0) with (A != B) 2240 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), 2241 BO->getOperand(1)); 2242 } 2243 } 2244 break; 2245 case Instruction::Or: 2246 // If bits are being or'd in that are not present in the constant we 2247 // are comparing against, then the comparison could never succeed! 2248 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) { 2249 Constant *NotCI = ConstantExpr::getNot(RHS); 2250 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue()) 2251 return replaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE)); 2252 2253 // Comparing if all bits outside of a constant mask are set? 2254 // Replace (X | C) == -1 with (X & ~C) == ~C. 2255 // This removes the -1 constant. 2256 if (BO->hasOneUse() && RHS->isAllOnesValue()) { 2257 Constant *NotBOC = ConstantExpr::getNot(BOC); 2258 Value *And = Builder->CreateAnd(BO->getOperand(0), NotBOC); 2259 return new ICmpInst(ICI.getPredicate(), And, NotBOC); 2260 } 2261 } 2262 break; 2263 2264 case Instruction::And: 2265 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) { 2266 // If bits are being compared against that are and'd out, then the 2267 // comparison can never succeed! 2268 if ((RHSV & ~BOC->getValue()) != 0) 2269 return replaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE)); 2270 2271 // If we have ((X & C) == C), turn it into ((X & C) != 0). 2272 if (RHS == BOC && RHSV.isPowerOf2()) 2273 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ : 2274 ICmpInst::ICMP_NE, LHSI, 2275 Constant::getNullValue(RHS->getType())); 2276 2277 // Don't perform the following transforms if the AND has multiple uses 2278 if (!BO->hasOneUse()) 2279 break; 2280 2281 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0 2282 if (BOC->getValue().isSignBit()) { 2283 Value *X = BO->getOperand(0); 2284 Constant *Zero = Constant::getNullValue(X->getType()); 2285 ICmpInst::Predicate pred = isICMP_NE ? 2286 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE; 2287 return new ICmpInst(pred, X, Zero); 2288 } 2289 2290 // ((X & ~7) == 0) --> X < 8 2291 if (RHSV == 0 && isHighOnes(BOC)) { 2292 Value *X = BO->getOperand(0); 2293 Constant *NegX = ConstantExpr::getNeg(BOC); 2294 ICmpInst::Predicate pred = isICMP_NE ? 2295 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT; 2296 return new ICmpInst(pred, X, NegX); 2297 } 2298 } 2299 break; 2300 case Instruction::Mul: 2301 if (RHSV == 0 && BO->hasNoSignedWrap()) { 2302 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) { 2303 // The trivial case (mul X, 0) is handled by InstSimplify 2304 // General case : (mul X, C) != 0 iff X != 0 2305 // (mul X, C) == 0 iff X == 0 2306 if (!BOC->isZero()) 2307 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), 2308 Constant::getNullValue(RHS->getType())); 2309 } 2310 } 2311 break; 2312 default: break; 2313 } 2314 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) { 2315 // Handle icmp {eq|ne} <intrinsic>, intcst. 2316 switch (II->getIntrinsicID()) { 2317 case Intrinsic::bswap: 2318 Worklist.Add(II); 2319 ICI.setOperand(0, II->getArgOperand(0)); 2320 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap())); 2321 return &ICI; 2322 case Intrinsic::ctlz: 2323 case Intrinsic::cttz: 2324 // ctz(A) == bitwidth(a) -> A == 0 and likewise for != 2325 if (RHSV == RHS->getType()->getBitWidth()) { 2326 Worklist.Add(II); 2327 ICI.setOperand(0, II->getArgOperand(0)); 2328 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0)); 2329 return &ICI; 2330 } 2331 break; 2332 case Intrinsic::ctpop: 2333 // popcount(A) == 0 -> A == 0 and likewise for != 2334 if (RHS->isZero()) { 2335 Worklist.Add(II); 2336 ICI.setOperand(0, II->getArgOperand(0)); 2337 ICI.setOperand(1, RHS); 2338 return &ICI; 2339 } 2340 break; 2341 default: 2342 break; 2343 } 2344 } 2345 } 2346 return nullptr; 2347 } 2348 2349 /// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst). 2350 /// We only handle extending casts so far. 2351 /// 2352 Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) { 2353 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0)); 2354 Value *LHSCIOp = LHSCI->getOperand(0); 2355 Type *SrcTy = LHSCIOp->getType(); 2356 Type *DestTy = LHSCI->getType(); 2357 Value *RHSCIOp; 2358 2359 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the 2360 // integer type is the same size as the pointer type. 2361 if (LHSCI->getOpcode() == Instruction::PtrToInt && 2362 DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) { 2363 Value *RHSOp = nullptr; 2364 if (PtrToIntOperator *RHSC = dyn_cast<PtrToIntOperator>(ICI.getOperand(1))) { 2365 Value *RHSCIOp = RHSC->getOperand(0); 2366 if (RHSCIOp->getType()->getPointerAddressSpace() == 2367 LHSCIOp->getType()->getPointerAddressSpace()) { 2368 RHSOp = RHSC->getOperand(0); 2369 // If the pointer types don't match, insert a bitcast. 2370 if (LHSCIOp->getType() != RHSOp->getType()) 2371 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType()); 2372 } 2373 } else if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) 2374 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy); 2375 2376 if (RHSOp) 2377 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp); 2378 } 2379 2380 // The code below only handles extension cast instructions, so far. 2381 // Enforce this. 2382 if (LHSCI->getOpcode() != Instruction::ZExt && 2383 LHSCI->getOpcode() != Instruction::SExt) 2384 return nullptr; 2385 2386 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt; 2387 bool isSignedCmp = ICI.isSigned(); 2388 2389 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) { 2390 // Not an extension from the same type? 2391 RHSCIOp = CI->getOperand(0); 2392 if (RHSCIOp->getType() != LHSCIOp->getType()) 2393 return nullptr; 2394 2395 // If the signedness of the two casts doesn't agree (i.e. one is a sext 2396 // and the other is a zext), then we can't handle this. 2397 if (CI->getOpcode() != LHSCI->getOpcode()) 2398 return nullptr; 2399 2400 // Deal with equality cases early. 2401 if (ICI.isEquality()) 2402 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp); 2403 2404 // A signed comparison of sign extended values simplifies into a 2405 // signed comparison. 2406 if (isSignedCmp && isSignedExt) 2407 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp); 2408 2409 // The other three cases all fold into an unsigned comparison. 2410 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp); 2411 } 2412 2413 // If we aren't dealing with a constant on the RHS, exit early 2414 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1)); 2415 if (!CI) 2416 return nullptr; 2417 2418 // Compute the constant that would happen if we truncated to SrcTy then 2419 // reextended to DestTy. 2420 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy); 2421 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(), 2422 Res1, DestTy); 2423 2424 // If the re-extended constant didn't change... 2425 if (Res2 == CI) { 2426 // Deal with equality cases early. 2427 if (ICI.isEquality()) 2428 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1); 2429 2430 // A signed comparison of sign extended values simplifies into a 2431 // signed comparison. 2432 if (isSignedExt && isSignedCmp) 2433 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1); 2434 2435 // The other three cases all fold into an unsigned comparison. 2436 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1); 2437 } 2438 2439 // The re-extended constant changed so the constant cannot be represented 2440 // in the shorter type. Consequently, we cannot emit a simple comparison. 2441 // All the cases that fold to true or false will have already been handled 2442 // by SimplifyICmpInst, so only deal with the tricky case. 2443 2444 if (isSignedCmp || !isSignedExt) 2445 return nullptr; 2446 2447 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases 2448 // should have been folded away previously and not enter in here. 2449 2450 // We're performing an unsigned comp with a sign extended value. 2451 // This is true if the input is >= 0. [aka >s -1] 2452 Constant *NegOne = Constant::getAllOnesValue(SrcTy); 2453 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName()); 2454 2455 // Finally, return the value computed. 2456 if (ICI.getPredicate() == ICmpInst::ICMP_ULT) 2457 return replaceInstUsesWith(ICI, Result); 2458 2459 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!"); 2460 return BinaryOperator::CreateNot(Result); 2461 } 2462 2463 /// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form: 2464 /// I = icmp ugt (add (add A, B), CI2), CI1 2465 /// If this is of the form: 2466 /// sum = a + b 2467 /// if (sum+128 >u 255) 2468 /// Then replace it with llvm.sadd.with.overflow.i8. 2469 /// 2470 static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B, 2471 ConstantInt *CI2, ConstantInt *CI1, 2472 InstCombiner &IC) { 2473 // The transformation we're trying to do here is to transform this into an 2474 // llvm.sadd.with.overflow. To do this, we have to replace the original add 2475 // with a narrower add, and discard the add-with-constant that is part of the 2476 // range check (if we can't eliminate it, this isn't profitable). 2477 2478 // In order to eliminate the add-with-constant, the compare can be its only 2479 // use. 2480 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0)); 2481 if (!AddWithCst->hasOneUse()) return nullptr; 2482 2483 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow. 2484 if (!CI2->getValue().isPowerOf2()) return nullptr; 2485 unsigned NewWidth = CI2->getValue().countTrailingZeros(); 2486 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr; 2487 2488 // The width of the new add formed is 1 more than the bias. 2489 ++NewWidth; 2490 2491 // Check to see that CI1 is an all-ones value with NewWidth bits. 2492 if (CI1->getBitWidth() == NewWidth || 2493 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth)) 2494 return nullptr; 2495 2496 // This is only really a signed overflow check if the inputs have been 2497 // sign-extended; check for that condition. For example, if CI2 is 2^31 and 2498 // the operands of the add are 64 bits wide, we need at least 33 sign bits. 2499 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1; 2500 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits || 2501 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits) 2502 return nullptr; 2503 2504 // In order to replace the original add with a narrower 2505 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant 2506 // and truncates that discard the high bits of the add. Verify that this is 2507 // the case. 2508 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0)); 2509 for (User *U : OrigAdd->users()) { 2510 if (U == AddWithCst) continue; 2511 2512 // Only accept truncates for now. We would really like a nice recursive 2513 // predicate like SimplifyDemandedBits, but which goes downwards the use-def 2514 // chain to see which bits of a value are actually demanded. If the 2515 // original add had another add which was then immediately truncated, we 2516 // could still do the transformation. 2517 TruncInst *TI = dyn_cast<TruncInst>(U); 2518 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth) 2519 return nullptr; 2520 } 2521 2522 // If the pattern matches, truncate the inputs to the narrower type and 2523 // use the sadd_with_overflow intrinsic to efficiently compute both the 2524 // result and the overflow bit. 2525 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth); 2526 Value *F = Intrinsic::getDeclaration(I.getModule(), 2527 Intrinsic::sadd_with_overflow, NewType); 2528 2529 InstCombiner::BuilderTy *Builder = IC.Builder; 2530 2531 // Put the new code above the original add, in case there are any uses of the 2532 // add between the add and the compare. 2533 Builder->SetInsertPoint(OrigAdd); 2534 2535 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc"); 2536 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc"); 2537 CallInst *Call = Builder->CreateCall(F, {TruncA, TruncB}, "sadd"); 2538 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result"); 2539 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType()); 2540 2541 // The inner add was the result of the narrow add, zero extended to the 2542 // wider type. Replace it with the result computed by the intrinsic. 2543 IC.replaceInstUsesWith(*OrigAdd, ZExt); 2544 2545 // The original icmp gets replaced with the overflow value. 2546 return ExtractValueInst::Create(Call, 1, "sadd.overflow"); 2547 } 2548 2549 bool InstCombiner::OptimizeOverflowCheck(OverflowCheckFlavor OCF, Value *LHS, 2550 Value *RHS, Instruction &OrigI, 2551 Value *&Result, Constant *&Overflow) { 2552 if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS)) 2553 std::swap(LHS, RHS); 2554 2555 auto SetResult = [&](Value *OpResult, Constant *OverflowVal, bool ReuseName) { 2556 Result = OpResult; 2557 Overflow = OverflowVal; 2558 if (ReuseName) 2559 Result->takeName(&OrigI); 2560 return true; 2561 }; 2562 2563 // If the overflow check was an add followed by a compare, the insertion point 2564 // may be pointing to the compare. We want to insert the new instructions 2565 // before the add in case there are uses of the add between the add and the 2566 // compare. 2567 Builder->SetInsertPoint(&OrigI); 2568 2569 switch (OCF) { 2570 case OCF_INVALID: 2571 llvm_unreachable("bad overflow check kind!"); 2572 2573 case OCF_UNSIGNED_ADD: { 2574 OverflowResult OR = computeOverflowForUnsignedAdd(LHS, RHS, &OrigI); 2575 if (OR == OverflowResult::NeverOverflows) 2576 return SetResult(Builder->CreateNUWAdd(LHS, RHS), Builder->getFalse(), 2577 true); 2578 2579 if (OR == OverflowResult::AlwaysOverflows) 2580 return SetResult(Builder->CreateAdd(LHS, RHS), Builder->getTrue(), true); 2581 } 2582 // FALL THROUGH uadd into sadd 2583 case OCF_SIGNED_ADD: { 2584 // X + 0 -> {X, false} 2585 if (match(RHS, m_Zero())) 2586 return SetResult(LHS, Builder->getFalse(), false); 2587 2588 // We can strength reduce this signed add into a regular add if we can prove 2589 // that it will never overflow. 2590 if (OCF == OCF_SIGNED_ADD) 2591 if (WillNotOverflowSignedAdd(LHS, RHS, OrigI)) 2592 return SetResult(Builder->CreateNSWAdd(LHS, RHS), Builder->getFalse(), 2593 true); 2594 break; 2595 } 2596 2597 case OCF_UNSIGNED_SUB: 2598 case OCF_SIGNED_SUB: { 2599 // X - 0 -> {X, false} 2600 if (match(RHS, m_Zero())) 2601 return SetResult(LHS, Builder->getFalse(), false); 2602 2603 if (OCF == OCF_SIGNED_SUB) { 2604 if (WillNotOverflowSignedSub(LHS, RHS, OrigI)) 2605 return SetResult(Builder->CreateNSWSub(LHS, RHS), Builder->getFalse(), 2606 true); 2607 } else { 2608 if (WillNotOverflowUnsignedSub(LHS, RHS, OrigI)) 2609 return SetResult(Builder->CreateNUWSub(LHS, RHS), Builder->getFalse(), 2610 true); 2611 } 2612 break; 2613 } 2614 2615 case OCF_UNSIGNED_MUL: { 2616 OverflowResult OR = computeOverflowForUnsignedMul(LHS, RHS, &OrigI); 2617 if (OR == OverflowResult::NeverOverflows) 2618 return SetResult(Builder->CreateNUWMul(LHS, RHS), Builder->getFalse(), 2619 true); 2620 if (OR == OverflowResult::AlwaysOverflows) 2621 return SetResult(Builder->CreateMul(LHS, RHS), Builder->getTrue(), true); 2622 } // FALL THROUGH 2623 case OCF_SIGNED_MUL: 2624 // X * undef -> undef 2625 if (isa<UndefValue>(RHS)) 2626 return SetResult(RHS, UndefValue::get(Builder->getInt1Ty()), false); 2627 2628 // X * 0 -> {0, false} 2629 if (match(RHS, m_Zero())) 2630 return SetResult(RHS, Builder->getFalse(), false); 2631 2632 // X * 1 -> {X, false} 2633 if (match(RHS, m_One())) 2634 return SetResult(LHS, Builder->getFalse(), false); 2635 2636 if (OCF == OCF_SIGNED_MUL) 2637 if (WillNotOverflowSignedMul(LHS, RHS, OrigI)) 2638 return SetResult(Builder->CreateNSWMul(LHS, RHS), Builder->getFalse(), 2639 true); 2640 break; 2641 } 2642 2643 return false; 2644 } 2645 2646 /// \brief Recognize and process idiom involving test for multiplication 2647 /// overflow. 2648 /// 2649 /// The caller has matched a pattern of the form: 2650 /// I = cmp u (mul(zext A, zext B), V 2651 /// The function checks if this is a test for overflow and if so replaces 2652 /// multiplication with call to 'mul.with.overflow' intrinsic. 2653 /// 2654 /// \param I Compare instruction. 2655 /// \param MulVal Result of 'mult' instruction. It is one of the arguments of 2656 /// the compare instruction. Must be of integer type. 2657 /// \param OtherVal The other argument of compare instruction. 2658 /// \returns Instruction which must replace the compare instruction, NULL if no 2659 /// replacement required. 2660 static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal, 2661 Value *OtherVal, InstCombiner &IC) { 2662 // Don't bother doing this transformation for pointers, don't do it for 2663 // vectors. 2664 if (!isa<IntegerType>(MulVal->getType())) 2665 return nullptr; 2666 2667 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal); 2668 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal); 2669 auto *MulInstr = dyn_cast<Instruction>(MulVal); 2670 if (!MulInstr) 2671 return nullptr; 2672 assert(MulInstr->getOpcode() == Instruction::Mul); 2673 2674 auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)), 2675 *RHS = cast<ZExtOperator>(MulInstr->getOperand(1)); 2676 assert(LHS->getOpcode() == Instruction::ZExt); 2677 assert(RHS->getOpcode() == Instruction::ZExt); 2678 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0); 2679 2680 // Calculate type and width of the result produced by mul.with.overflow. 2681 Type *TyA = A->getType(), *TyB = B->getType(); 2682 unsigned WidthA = TyA->getPrimitiveSizeInBits(), 2683 WidthB = TyB->getPrimitiveSizeInBits(); 2684 unsigned MulWidth; 2685 Type *MulType; 2686 if (WidthB > WidthA) { 2687 MulWidth = WidthB; 2688 MulType = TyB; 2689 } else { 2690 MulWidth = WidthA; 2691 MulType = TyA; 2692 } 2693 2694 // In order to replace the original mul with a narrower mul.with.overflow, 2695 // all uses must ignore upper bits of the product. The number of used low 2696 // bits must be not greater than the width of mul.with.overflow. 2697 if (MulVal->hasNUsesOrMore(2)) 2698 for (User *U : MulVal->users()) { 2699 if (U == &I) 2700 continue; 2701 if (TruncInst *TI = dyn_cast<TruncInst>(U)) { 2702 // Check if truncation ignores bits above MulWidth. 2703 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits(); 2704 if (TruncWidth > MulWidth) 2705 return nullptr; 2706 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) { 2707 // Check if AND ignores bits above MulWidth. 2708 if (BO->getOpcode() != Instruction::And) 2709 return nullptr; 2710 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) { 2711 const APInt &CVal = CI->getValue(); 2712 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth) 2713 return nullptr; 2714 } 2715 } else { 2716 // Other uses prohibit this transformation. 2717 return nullptr; 2718 } 2719 } 2720 2721 // Recognize patterns 2722 switch (I.getPredicate()) { 2723 case ICmpInst::ICMP_EQ: 2724 case ICmpInst::ICMP_NE: 2725 // Recognize pattern: 2726 // mulval = mul(zext A, zext B) 2727 // cmp eq/neq mulval, zext trunc mulval 2728 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal)) 2729 if (Zext->hasOneUse()) { 2730 Value *ZextArg = Zext->getOperand(0); 2731 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg)) 2732 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth) 2733 break; //Recognized 2734 } 2735 2736 // Recognize pattern: 2737 // mulval = mul(zext A, zext B) 2738 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits. 2739 ConstantInt *CI; 2740 Value *ValToMask; 2741 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) { 2742 if (ValToMask != MulVal) 2743 return nullptr; 2744 const APInt &CVal = CI->getValue() + 1; 2745 if (CVal.isPowerOf2()) { 2746 unsigned MaskWidth = CVal.logBase2(); 2747 if (MaskWidth == MulWidth) 2748 break; // Recognized 2749 } 2750 } 2751 return nullptr; 2752 2753 case ICmpInst::ICMP_UGT: 2754 // Recognize pattern: 2755 // mulval = mul(zext A, zext B) 2756 // cmp ugt mulval, max 2757 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 2758 APInt MaxVal = APInt::getMaxValue(MulWidth); 2759 MaxVal = MaxVal.zext(CI->getBitWidth()); 2760 if (MaxVal.eq(CI->getValue())) 2761 break; // Recognized 2762 } 2763 return nullptr; 2764 2765 case ICmpInst::ICMP_UGE: 2766 // Recognize pattern: 2767 // mulval = mul(zext A, zext B) 2768 // cmp uge mulval, max+1 2769 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 2770 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth); 2771 if (MaxVal.eq(CI->getValue())) 2772 break; // Recognized 2773 } 2774 return nullptr; 2775 2776 case ICmpInst::ICMP_ULE: 2777 // Recognize pattern: 2778 // mulval = mul(zext A, zext B) 2779 // cmp ule mulval, max 2780 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 2781 APInt MaxVal = APInt::getMaxValue(MulWidth); 2782 MaxVal = MaxVal.zext(CI->getBitWidth()); 2783 if (MaxVal.eq(CI->getValue())) 2784 break; // Recognized 2785 } 2786 return nullptr; 2787 2788 case ICmpInst::ICMP_ULT: 2789 // Recognize pattern: 2790 // mulval = mul(zext A, zext B) 2791 // cmp ule mulval, max + 1 2792 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 2793 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth); 2794 if (MaxVal.eq(CI->getValue())) 2795 break; // Recognized 2796 } 2797 return nullptr; 2798 2799 default: 2800 return nullptr; 2801 } 2802 2803 InstCombiner::BuilderTy *Builder = IC.Builder; 2804 Builder->SetInsertPoint(MulInstr); 2805 2806 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B) 2807 Value *MulA = A, *MulB = B; 2808 if (WidthA < MulWidth) 2809 MulA = Builder->CreateZExt(A, MulType); 2810 if (WidthB < MulWidth) 2811 MulB = Builder->CreateZExt(B, MulType); 2812 Value *F = Intrinsic::getDeclaration(I.getModule(), 2813 Intrinsic::umul_with_overflow, MulType); 2814 CallInst *Call = Builder->CreateCall(F, {MulA, MulB}, "umul"); 2815 IC.Worklist.Add(MulInstr); 2816 2817 // If there are uses of mul result other than the comparison, we know that 2818 // they are truncation or binary AND. Change them to use result of 2819 // mul.with.overflow and adjust properly mask/size. 2820 if (MulVal->hasNUsesOrMore(2)) { 2821 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value"); 2822 for (User *U : MulVal->users()) { 2823 if (U == &I || U == OtherVal) 2824 continue; 2825 if (TruncInst *TI = dyn_cast<TruncInst>(U)) { 2826 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth) 2827 IC.replaceInstUsesWith(*TI, Mul); 2828 else 2829 TI->setOperand(0, Mul); 2830 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) { 2831 assert(BO->getOpcode() == Instruction::And); 2832 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask) 2833 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1)); 2834 APInt ShortMask = CI->getValue().trunc(MulWidth); 2835 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask); 2836 Instruction *Zext = 2837 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType())); 2838 IC.Worklist.Add(Zext); 2839 IC.replaceInstUsesWith(*BO, Zext); 2840 } else { 2841 llvm_unreachable("Unexpected Binary operation"); 2842 } 2843 IC.Worklist.Add(cast<Instruction>(U)); 2844 } 2845 } 2846 if (isa<Instruction>(OtherVal)) 2847 IC.Worklist.Add(cast<Instruction>(OtherVal)); 2848 2849 // The original icmp gets replaced with the overflow value, maybe inverted 2850 // depending on predicate. 2851 bool Inverse = false; 2852 switch (I.getPredicate()) { 2853 case ICmpInst::ICMP_NE: 2854 break; 2855 case ICmpInst::ICMP_EQ: 2856 Inverse = true; 2857 break; 2858 case ICmpInst::ICMP_UGT: 2859 case ICmpInst::ICMP_UGE: 2860 if (I.getOperand(0) == MulVal) 2861 break; 2862 Inverse = true; 2863 break; 2864 case ICmpInst::ICMP_ULT: 2865 case ICmpInst::ICMP_ULE: 2866 if (I.getOperand(1) == MulVal) 2867 break; 2868 Inverse = true; 2869 break; 2870 default: 2871 llvm_unreachable("Unexpected predicate"); 2872 } 2873 if (Inverse) { 2874 Value *Res = Builder->CreateExtractValue(Call, 1); 2875 return BinaryOperator::CreateNot(Res); 2876 } 2877 2878 return ExtractValueInst::Create(Call, 1); 2879 } 2880 2881 // DemandedBitsLHSMask - When performing a comparison against a constant, 2882 // it is possible that not all the bits in the LHS are demanded. This helper 2883 // method computes the mask that IS demanded. 2884 static APInt DemandedBitsLHSMask(ICmpInst &I, 2885 unsigned BitWidth, bool isSignCheck) { 2886 if (isSignCheck) 2887 return APInt::getSignBit(BitWidth); 2888 2889 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1)); 2890 if (!CI) return APInt::getAllOnesValue(BitWidth); 2891 const APInt &RHS = CI->getValue(); 2892 2893 switch (I.getPredicate()) { 2894 // For a UGT comparison, we don't care about any bits that 2895 // correspond to the trailing ones of the comparand. The value of these 2896 // bits doesn't impact the outcome of the comparison, because any value 2897 // greater than the RHS must differ in a bit higher than these due to carry. 2898 case ICmpInst::ICMP_UGT: { 2899 unsigned trailingOnes = RHS.countTrailingOnes(); 2900 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes); 2901 return ~lowBitsSet; 2902 } 2903 2904 // Similarly, for a ULT comparison, we don't care about the trailing zeros. 2905 // Any value less than the RHS must differ in a higher bit because of carries. 2906 case ICmpInst::ICMP_ULT: { 2907 unsigned trailingZeros = RHS.countTrailingZeros(); 2908 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros); 2909 return ~lowBitsSet; 2910 } 2911 2912 default: 2913 return APInt::getAllOnesValue(BitWidth); 2914 } 2915 } 2916 2917 /// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst 2918 /// should be swapped. 2919 /// The decision is based on how many times these two operands are reused 2920 /// as subtract operands and their positions in those instructions. 2921 /// The rational is that several architectures use the same instruction for 2922 /// both subtract and cmp, thus it is better if the order of those operands 2923 /// match. 2924 /// \return true if Op0 and Op1 should be swapped. 2925 static bool swapMayExposeCSEOpportunities(const Value * Op0, 2926 const Value * Op1) { 2927 // Filter out pointer value as those cannot appears directly in subtract. 2928 // FIXME: we may want to go through inttoptrs or bitcasts. 2929 if (Op0->getType()->isPointerTy()) 2930 return false; 2931 // Count every uses of both Op0 and Op1 in a subtract. 2932 // Each time Op0 is the first operand, count -1: swapping is bad, the 2933 // subtract has already the same layout as the compare. 2934 // Each time Op0 is the second operand, count +1: swapping is good, the 2935 // subtract has a different layout as the compare. 2936 // At the end, if the benefit is greater than 0, Op0 should come second to 2937 // expose more CSE opportunities. 2938 int GlobalSwapBenefits = 0; 2939 for (const User *U : Op0->users()) { 2940 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U); 2941 if (!BinOp || BinOp->getOpcode() != Instruction::Sub) 2942 continue; 2943 // If Op0 is the first argument, this is not beneficial to swap the 2944 // arguments. 2945 int LocalSwapBenefits = -1; 2946 unsigned Op1Idx = 1; 2947 if (BinOp->getOperand(Op1Idx) == Op0) { 2948 Op1Idx = 0; 2949 LocalSwapBenefits = 1; 2950 } 2951 if (BinOp->getOperand(Op1Idx) != Op1) 2952 continue; 2953 GlobalSwapBenefits += LocalSwapBenefits; 2954 } 2955 return GlobalSwapBenefits > 0; 2956 } 2957 2958 /// \brief Check that one use is in the same block as the definition and all 2959 /// other uses are in blocks dominated by a given block 2960 /// 2961 /// \param DI Definition 2962 /// \param UI Use 2963 /// \param DB Block that must dominate all uses of \p DI outside 2964 /// the parent block 2965 /// \return true when \p UI is the only use of \p DI in the parent block 2966 /// and all other uses of \p DI are in blocks dominated by \p DB. 2967 /// 2968 bool InstCombiner::dominatesAllUses(const Instruction *DI, 2969 const Instruction *UI, 2970 const BasicBlock *DB) const { 2971 assert(DI && UI && "Instruction not defined\n"); 2972 // ignore incomplete definitions 2973 if (!DI->getParent()) 2974 return false; 2975 // DI and UI must be in the same block 2976 if (DI->getParent() != UI->getParent()) 2977 return false; 2978 // Protect from self-referencing blocks 2979 if (DI->getParent() == DB) 2980 return false; 2981 // DominatorTree available? 2982 if (!DT) 2983 return false; 2984 for (const User *U : DI->users()) { 2985 auto *Usr = cast<Instruction>(U); 2986 if (Usr != UI && !DT->dominates(DB, Usr->getParent())) 2987 return false; 2988 } 2989 return true; 2990 } 2991 2992 /// 2993 /// true when the instruction sequence within a block is select-cmp-br. 2994 /// 2995 static bool isChainSelectCmpBranch(const SelectInst *SI) { 2996 const BasicBlock *BB = SI->getParent(); 2997 if (!BB) 2998 return false; 2999 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator()); 3000 if (!BI || BI->getNumSuccessors() != 2) 3001 return false; 3002 auto *IC = dyn_cast<ICmpInst>(BI->getCondition()); 3003 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI)) 3004 return false; 3005 return true; 3006 } 3007 3008 /// 3009 /// \brief True when a select result is replaced by one of its operands 3010 /// in select-icmp sequence. This will eventually result in the elimination 3011 /// of the select. 3012 /// 3013 /// \param SI Select instruction 3014 /// \param Icmp Compare instruction 3015 /// \param SIOpd Operand that replaces the select 3016 /// 3017 /// Notes: 3018 /// - The replacement is global and requires dominator information 3019 /// - The caller is responsible for the actual replacement 3020 /// 3021 /// Example: 3022 /// 3023 /// entry: 3024 /// %4 = select i1 %3, %C* %0, %C* null 3025 /// %5 = icmp eq %C* %4, null 3026 /// br i1 %5, label %9, label %7 3027 /// ... 3028 /// ; <label>:7 ; preds = %entry 3029 /// %8 = getelementptr inbounds %C* %4, i64 0, i32 0 3030 /// ... 3031 /// 3032 /// can be transformed to 3033 /// 3034 /// %5 = icmp eq %C* %0, null 3035 /// %6 = select i1 %3, i1 %5, i1 true 3036 /// br i1 %6, label %9, label %7 3037 /// ... 3038 /// ; <label>:7 ; preds = %entry 3039 /// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0! 3040 /// 3041 /// Similar when the first operand of the select is a constant or/and 3042 /// the compare is for not equal rather than equal. 3043 /// 3044 /// NOTE: The function is only called when the select and compare constants 3045 /// are equal, the optimization can work only for EQ predicates. This is not a 3046 /// major restriction since a NE compare should be 'normalized' to an equal 3047 /// compare, which usually happens in the combiner and test case 3048 /// select-cmp-br.ll 3049 /// checks for it. 3050 bool InstCombiner::replacedSelectWithOperand(SelectInst *SI, 3051 const ICmpInst *Icmp, 3052 const unsigned SIOpd) { 3053 assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!"); 3054 if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) { 3055 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1); 3056 // The check for the unique predecessor is not the best that can be 3057 // done. But it protects efficiently against cases like when SI's 3058 // home block has two successors, Succ and Succ1, and Succ1 predecessor 3059 // of Succ. Then SI can't be replaced by SIOpd because the use that gets 3060 // replaced can be reached on either path. So the uniqueness check 3061 // guarantees that the path all uses of SI (outside SI's parent) are on 3062 // is disjoint from all other paths out of SI. But that information 3063 // is more expensive to compute, and the trade-off here is in favor 3064 // of compile-time. 3065 if (Succ->getUniquePredecessor() && dominatesAllUses(SI, Icmp, Succ)) { 3066 NumSel++; 3067 SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent()); 3068 return true; 3069 } 3070 } 3071 return false; 3072 } 3073 3074 Instruction *InstCombiner::visitICmpInst(ICmpInst &I) { 3075 bool Changed = false; 3076 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 3077 unsigned Op0Cplxity = getComplexity(Op0); 3078 unsigned Op1Cplxity = getComplexity(Op1); 3079 3080 /// Orders the operands of the compare so that they are listed from most 3081 /// complex to least complex. This puts constants before unary operators, 3082 /// before binary operators. 3083 if (Op0Cplxity < Op1Cplxity || 3084 (Op0Cplxity == Op1Cplxity && 3085 swapMayExposeCSEOpportunities(Op0, Op1))) { 3086 I.swapOperands(); 3087 std::swap(Op0, Op1); 3088 Changed = true; 3089 } 3090 3091 if (Value *V = 3092 SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AC, &I)) 3093 return replaceInstUsesWith(I, V); 3094 3095 // comparing -val or val with non-zero is the same as just comparing val 3096 // ie, abs(val) != 0 -> val != 0 3097 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero())) 3098 { 3099 Value *Cond, *SelectTrue, *SelectFalse; 3100 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue), 3101 m_Value(SelectFalse)))) { 3102 if (Value *V = dyn_castNegVal(SelectTrue)) { 3103 if (V == SelectFalse) 3104 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1); 3105 } 3106 else if (Value *V = dyn_castNegVal(SelectFalse)) { 3107 if (V == SelectTrue) 3108 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1); 3109 } 3110 } 3111 } 3112 3113 Type *Ty = Op0->getType(); 3114 3115 // icmp's with boolean values can always be turned into bitwise operations 3116 if (Ty->isIntegerTy(1)) { 3117 switch (I.getPredicate()) { 3118 default: llvm_unreachable("Invalid icmp instruction!"); 3119 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B) 3120 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp"); 3121 return BinaryOperator::CreateNot(Xor); 3122 } 3123 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B 3124 return BinaryOperator::CreateXor(Op0, Op1); 3125 3126 case ICmpInst::ICMP_UGT: 3127 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult 3128 // FALL THROUGH 3129 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B 3130 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp"); 3131 return BinaryOperator::CreateAnd(Not, Op1); 3132 } 3133 case ICmpInst::ICMP_SGT: 3134 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt 3135 // FALL THROUGH 3136 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B 3137 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp"); 3138 return BinaryOperator::CreateAnd(Not, Op0); 3139 } 3140 case ICmpInst::ICMP_UGE: 3141 std::swap(Op0, Op1); // Change icmp uge -> icmp ule 3142 // FALL THROUGH 3143 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B 3144 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp"); 3145 return BinaryOperator::CreateOr(Not, Op1); 3146 } 3147 case ICmpInst::ICMP_SGE: 3148 std::swap(Op0, Op1); // Change icmp sge -> icmp sle 3149 // FALL THROUGH 3150 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B 3151 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp"); 3152 return BinaryOperator::CreateOr(Not, Op0); 3153 } 3154 } 3155 } 3156 3157 unsigned BitWidth = 0; 3158 if (Ty->isIntOrIntVectorTy()) 3159 BitWidth = Ty->getScalarSizeInBits(); 3160 else // Get pointer size. 3161 BitWidth = DL.getTypeSizeInBits(Ty->getScalarType()); 3162 3163 bool isSignBit = false; 3164 3165 // See if we are doing a comparison with a constant. 3166 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) { 3167 Value *A = nullptr, *B = nullptr; 3168 3169 // Match the following pattern, which is a common idiom when writing 3170 // overflow-safe integer arithmetic function. The source performs an 3171 // addition in wider type, and explicitly checks for overflow using 3172 // comparisons against INT_MIN and INT_MAX. Simplify this by using the 3173 // sadd_with_overflow intrinsic. 3174 // 3175 // TODO: This could probably be generalized to handle other overflow-safe 3176 // operations if we worked out the formulas to compute the appropriate 3177 // magic constants. 3178 // 3179 // sum = a + b 3180 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8 3181 { 3182 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI 3183 if (I.getPredicate() == ICmpInst::ICMP_UGT && 3184 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2)))) 3185 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this)) 3186 return Res; 3187 } 3188 3189 // (icmp sgt smin(PosA, B) 0) -> (icmp sgt B 0) 3190 if (CI->isZero() && I.getPredicate() == ICmpInst::ICMP_SGT) 3191 if (auto *SI = dyn_cast<SelectInst>(Op0)) { 3192 SelectPatternResult SPR = matchSelectPattern(SI, A, B); 3193 if (SPR.Flavor == SPF_SMIN) { 3194 if (isKnownPositive(A, DL)) 3195 return new ICmpInst(I.getPredicate(), B, CI); 3196 if (isKnownPositive(B, DL)) 3197 return new ICmpInst(I.getPredicate(), A, CI); 3198 } 3199 } 3200 3201 3202 // The following transforms are only 'worth it' if the only user of the 3203 // subtraction is the icmp. 3204 if (Op0->hasOneUse()) { 3205 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B) 3206 if (I.isEquality() && CI->isZero() && 3207 match(Op0, m_Sub(m_Value(A), m_Value(B)))) 3208 return new ICmpInst(I.getPredicate(), A, B); 3209 3210 // (icmp sgt (sub nsw A B), -1) -> (icmp sge A, B) 3211 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isAllOnesValue() && 3212 match(Op0, m_NSWSub(m_Value(A), m_Value(B)))) 3213 return new ICmpInst(ICmpInst::ICMP_SGE, A, B); 3214 3215 // (icmp sgt (sub nsw A B), 0) -> (icmp sgt A, B) 3216 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isZero() && 3217 match(Op0, m_NSWSub(m_Value(A), m_Value(B)))) 3218 return new ICmpInst(ICmpInst::ICMP_SGT, A, B); 3219 3220 // (icmp slt (sub nsw A B), 0) -> (icmp slt A, B) 3221 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isZero() && 3222 match(Op0, m_NSWSub(m_Value(A), m_Value(B)))) 3223 return new ICmpInst(ICmpInst::ICMP_SLT, A, B); 3224 3225 // (icmp slt (sub nsw A B), 1) -> (icmp sle A, B) 3226 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isOne() && 3227 match(Op0, m_NSWSub(m_Value(A), m_Value(B)))) 3228 return new ICmpInst(ICmpInst::ICMP_SLE, A, B); 3229 } 3230 3231 // If we have an icmp le or icmp ge instruction, turn it into the 3232 // appropriate icmp lt or icmp gt instruction. This allows us to rely on 3233 // them being folded in the code below. The SimplifyICmpInst code has 3234 // already handled the edge cases for us, so we just assert on them. 3235 switch (I.getPredicate()) { 3236 default: break; 3237 case ICmpInst::ICMP_ULE: 3238 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE 3239 return new ICmpInst(ICmpInst::ICMP_ULT, Op0, 3240 Builder->getInt(CI->getValue()+1)); 3241 case ICmpInst::ICMP_SLE: 3242 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE 3243 return new ICmpInst(ICmpInst::ICMP_SLT, Op0, 3244 Builder->getInt(CI->getValue()+1)); 3245 case ICmpInst::ICMP_UGE: 3246 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE 3247 return new ICmpInst(ICmpInst::ICMP_UGT, Op0, 3248 Builder->getInt(CI->getValue()-1)); 3249 case ICmpInst::ICMP_SGE: 3250 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE 3251 return new ICmpInst(ICmpInst::ICMP_SGT, Op0, 3252 Builder->getInt(CI->getValue()-1)); 3253 } 3254 3255 if (I.isEquality()) { 3256 ConstantInt *CI2; 3257 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) || 3258 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) { 3259 // (icmp eq/ne (ashr/lshr const2, A), const1) 3260 if (Instruction *Inst = FoldICmpCstShrCst(I, Op0, A, CI, CI2)) 3261 return Inst; 3262 } 3263 if (match(Op0, m_Shl(m_ConstantInt(CI2), m_Value(A)))) { 3264 // (icmp eq/ne (shl const2, A), const1) 3265 if (Instruction *Inst = FoldICmpCstShlCst(I, Op0, A, CI, CI2)) 3266 return Inst; 3267 } 3268 } 3269 3270 // If this comparison is a normal comparison, it demands all 3271 // bits, if it is a sign bit comparison, it only demands the sign bit. 3272 bool UnusedBit; 3273 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit); 3274 } 3275 3276 // See if we can fold the comparison based on range information we can get 3277 // by checking whether bits are known to be zero or one in the input. 3278 if (BitWidth != 0) { 3279 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0); 3280 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0); 3281 3282 if (SimplifyDemandedBits(I.getOperandUse(0), 3283 DemandedBitsLHSMask(I, BitWidth, isSignBit), 3284 Op0KnownZero, Op0KnownOne, 0)) 3285 return &I; 3286 if (SimplifyDemandedBits(I.getOperandUse(1), 3287 APInt::getAllOnesValue(BitWidth), Op1KnownZero, 3288 Op1KnownOne, 0)) 3289 return &I; 3290 3291 // Given the known and unknown bits, compute a range that the LHS could be 3292 // in. Compute the Min, Max and RHS values based on the known bits. For the 3293 // EQ and NE we use unsigned values. 3294 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0); 3295 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0); 3296 if (I.isSigned()) { 3297 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne, 3298 Op0Min, Op0Max); 3299 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne, 3300 Op1Min, Op1Max); 3301 } else { 3302 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne, 3303 Op0Min, Op0Max); 3304 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne, 3305 Op1Min, Op1Max); 3306 } 3307 3308 // If Min and Max are known to be the same, then SimplifyDemandedBits 3309 // figured out that the LHS is a constant. Just constant fold this now so 3310 // that code below can assume that Min != Max. 3311 if (!isa<Constant>(Op0) && Op0Min == Op0Max) 3312 return new ICmpInst(I.getPredicate(), 3313 ConstantInt::get(Op0->getType(), Op0Min), Op1); 3314 if (!isa<Constant>(Op1) && Op1Min == Op1Max) 3315 return new ICmpInst(I.getPredicate(), Op0, 3316 ConstantInt::get(Op1->getType(), Op1Min)); 3317 3318 // Based on the range information we know about the LHS, see if we can 3319 // simplify this comparison. For example, (x&4) < 8 is always true. 3320 switch (I.getPredicate()) { 3321 default: llvm_unreachable("Unknown icmp opcode!"); 3322 case ICmpInst::ICMP_EQ: { 3323 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max)) 3324 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3325 3326 // If all bits are known zero except for one, then we know at most one 3327 // bit is set. If the comparison is against zero, then this is a check 3328 // to see if *that* bit is set. 3329 APInt Op0KnownZeroInverted = ~Op0KnownZero; 3330 if (~Op1KnownZero == 0) { 3331 // If the LHS is an AND with the same constant, look through it. 3332 Value *LHS = nullptr; 3333 ConstantInt *LHSC = nullptr; 3334 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) || 3335 LHSC->getValue() != Op0KnownZeroInverted) 3336 LHS = Op0; 3337 3338 // If the LHS is 1 << x, and we know the result is a power of 2 like 8, 3339 // then turn "((1 << x)&8) == 0" into "x != 3". 3340 // or turn "((1 << x)&7) == 0" into "x > 2". 3341 Value *X = nullptr; 3342 if (match(LHS, m_Shl(m_One(), m_Value(X)))) { 3343 APInt ValToCheck = Op0KnownZeroInverted; 3344 if (ValToCheck.isPowerOf2()) { 3345 unsigned CmpVal = ValToCheck.countTrailingZeros(); 3346 return new ICmpInst(ICmpInst::ICMP_NE, X, 3347 ConstantInt::get(X->getType(), CmpVal)); 3348 } else if ((++ValToCheck).isPowerOf2()) { 3349 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1; 3350 return new ICmpInst(ICmpInst::ICMP_UGT, X, 3351 ConstantInt::get(X->getType(), CmpVal)); 3352 } 3353 } 3354 3355 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1, 3356 // then turn "((8 >>u x)&1) == 0" into "x != 3". 3357 const APInt *CI; 3358 if (Op0KnownZeroInverted == 1 && 3359 match(LHS, m_LShr(m_Power2(CI), m_Value(X)))) 3360 return new ICmpInst(ICmpInst::ICMP_NE, X, 3361 ConstantInt::get(X->getType(), 3362 CI->countTrailingZeros())); 3363 } 3364 break; 3365 } 3366 case ICmpInst::ICMP_NE: { 3367 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max)) 3368 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3369 3370 // If all bits are known zero except for one, then we know at most one 3371 // bit is set. If the comparison is against zero, then this is a check 3372 // to see if *that* bit is set. 3373 APInt Op0KnownZeroInverted = ~Op0KnownZero; 3374 if (~Op1KnownZero == 0) { 3375 // If the LHS is an AND with the same constant, look through it. 3376 Value *LHS = nullptr; 3377 ConstantInt *LHSC = nullptr; 3378 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) || 3379 LHSC->getValue() != Op0KnownZeroInverted) 3380 LHS = Op0; 3381 3382 // If the LHS is 1 << x, and we know the result is a power of 2 like 8, 3383 // then turn "((1 << x)&8) != 0" into "x == 3". 3384 // or turn "((1 << x)&7) != 0" into "x < 3". 3385 Value *X = nullptr; 3386 if (match(LHS, m_Shl(m_One(), m_Value(X)))) { 3387 APInt ValToCheck = Op0KnownZeroInverted; 3388 if (ValToCheck.isPowerOf2()) { 3389 unsigned CmpVal = ValToCheck.countTrailingZeros(); 3390 return new ICmpInst(ICmpInst::ICMP_EQ, X, 3391 ConstantInt::get(X->getType(), CmpVal)); 3392 } else if ((++ValToCheck).isPowerOf2()) { 3393 unsigned CmpVal = ValToCheck.countTrailingZeros(); 3394 return new ICmpInst(ICmpInst::ICMP_ULT, X, 3395 ConstantInt::get(X->getType(), CmpVal)); 3396 } 3397 } 3398 3399 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1, 3400 // then turn "((8 >>u x)&1) != 0" into "x == 3". 3401 const APInt *CI; 3402 if (Op0KnownZeroInverted == 1 && 3403 match(LHS, m_LShr(m_Power2(CI), m_Value(X)))) 3404 return new ICmpInst(ICmpInst::ICMP_EQ, X, 3405 ConstantInt::get(X->getType(), 3406 CI->countTrailingZeros())); 3407 } 3408 break; 3409 } 3410 case ICmpInst::ICMP_ULT: 3411 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B) 3412 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3413 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B) 3414 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3415 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B) 3416 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 3417 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) { 3418 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C 3419 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 3420 Builder->getInt(CI->getValue()-1)); 3421 3422 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear 3423 if (CI->isMinValue(true)) 3424 return new ICmpInst(ICmpInst::ICMP_SGT, Op0, 3425 Constant::getAllOnesValue(Op0->getType())); 3426 } 3427 break; 3428 case ICmpInst::ICMP_UGT: 3429 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B) 3430 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3431 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B) 3432 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3433 3434 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B) 3435 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 3436 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) { 3437 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C 3438 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 3439 Builder->getInt(CI->getValue()+1)); 3440 3441 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set 3442 if (CI->isMaxValue(true)) 3443 return new ICmpInst(ICmpInst::ICMP_SLT, Op0, 3444 Constant::getNullValue(Op0->getType())); 3445 } 3446 break; 3447 case ICmpInst::ICMP_SLT: 3448 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C) 3449 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3450 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C) 3451 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3452 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B) 3453 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 3454 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) { 3455 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C 3456 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 3457 Builder->getInt(CI->getValue()-1)); 3458 } 3459 break; 3460 case ICmpInst::ICMP_SGT: 3461 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B) 3462 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3463 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B) 3464 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3465 3466 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B) 3467 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 3468 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) { 3469 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C 3470 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 3471 Builder->getInt(CI->getValue()+1)); 3472 } 3473 break; 3474 case ICmpInst::ICMP_SGE: 3475 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!"); 3476 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B) 3477 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3478 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B) 3479 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3480 break; 3481 case ICmpInst::ICMP_SLE: 3482 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!"); 3483 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B) 3484 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3485 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B) 3486 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3487 break; 3488 case ICmpInst::ICMP_UGE: 3489 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!"); 3490 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B) 3491 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3492 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B) 3493 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3494 break; 3495 case ICmpInst::ICMP_ULE: 3496 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!"); 3497 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B) 3498 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3499 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B) 3500 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3501 break; 3502 } 3503 3504 // Turn a signed comparison into an unsigned one if both operands 3505 // are known to have the same sign. 3506 if (I.isSigned() && 3507 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) || 3508 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative()))) 3509 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1); 3510 } 3511 3512 // Test if the ICmpInst instruction is used exclusively by a select as 3513 // part of a minimum or maximum operation. If so, refrain from doing 3514 // any other folding. This helps out other analyses which understand 3515 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution 3516 // and CodeGen. And in this case, at least one of the comparison 3517 // operands has at least one user besides the compare (the select), 3518 // which would often largely negate the benefit of folding anyway. 3519 if (I.hasOneUse()) 3520 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin())) 3521 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) || 3522 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1)) 3523 return nullptr; 3524 3525 // See if we are doing a comparison between a constant and an instruction that 3526 // can be folded into the comparison. 3527 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) { 3528 // Since the RHS is a ConstantInt (CI), if the left hand side is an 3529 // instruction, see if that instruction also has constants so that the 3530 // instruction can be folded into the icmp 3531 if (Instruction *LHSI = dyn_cast<Instruction>(Op0)) 3532 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI)) 3533 return Res; 3534 } 3535 3536 // Handle icmp with constant (but not simple integer constant) RHS 3537 if (Constant *RHSC = dyn_cast<Constant>(Op1)) { 3538 if (Instruction *LHSI = dyn_cast<Instruction>(Op0)) 3539 switch (LHSI->getOpcode()) { 3540 case Instruction::GetElementPtr: 3541 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null 3542 if (RHSC->isNullValue() && 3543 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices()) 3544 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0), 3545 Constant::getNullValue(LHSI->getOperand(0)->getType())); 3546 break; 3547 case Instruction::PHI: 3548 // Only fold icmp into the PHI if the phi and icmp are in the same 3549 // block. If in the same block, we're encouraging jump threading. If 3550 // not, we are just pessimizing the code by making an i1 phi. 3551 if (LHSI->getParent() == I.getParent()) 3552 if (Instruction *NV = FoldOpIntoPhi(I)) 3553 return NV; 3554 break; 3555 case Instruction::Select: { 3556 // If either operand of the select is a constant, we can fold the 3557 // comparison into the select arms, which will cause one to be 3558 // constant folded and the select turned into a bitwise or. 3559 Value *Op1 = nullptr, *Op2 = nullptr; 3560 ConstantInt *CI = nullptr; 3561 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) { 3562 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC); 3563 CI = dyn_cast<ConstantInt>(Op1); 3564 } 3565 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) { 3566 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC); 3567 CI = dyn_cast<ConstantInt>(Op2); 3568 } 3569 3570 // We only want to perform this transformation if it will not lead to 3571 // additional code. This is true if either both sides of the select 3572 // fold to a constant (in which case the icmp is replaced with a select 3573 // which will usually simplify) or this is the only user of the 3574 // select (in which case we are trading a select+icmp for a simpler 3575 // select+icmp) or all uses of the select can be replaced based on 3576 // dominance information ("Global cases"). 3577 bool Transform = false; 3578 if (Op1 && Op2) 3579 Transform = true; 3580 else if (Op1 || Op2) { 3581 // Local case 3582 if (LHSI->hasOneUse()) 3583 Transform = true; 3584 // Global cases 3585 else if (CI && !CI->isZero()) 3586 // When Op1 is constant try replacing select with second operand. 3587 // Otherwise Op2 is constant and try replacing select with first 3588 // operand. 3589 Transform = replacedSelectWithOperand(cast<SelectInst>(LHSI), &I, 3590 Op1 ? 2 : 1); 3591 } 3592 if (Transform) { 3593 if (!Op1) 3594 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1), 3595 RHSC, I.getName()); 3596 if (!Op2) 3597 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2), 3598 RHSC, I.getName()); 3599 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2); 3600 } 3601 break; 3602 } 3603 case Instruction::IntToPtr: 3604 // icmp pred inttoptr(X), null -> icmp pred X, 0 3605 if (RHSC->isNullValue() && 3606 DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType()) 3607 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0), 3608 Constant::getNullValue(LHSI->getOperand(0)->getType())); 3609 break; 3610 3611 case Instruction::Load: 3612 // Try to optimize things like "A[i] > 4" to index computations. 3613 if (GetElementPtrInst *GEP = 3614 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) { 3615 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0))) 3616 if (GV->isConstant() && GV->hasDefinitiveInitializer() && 3617 !cast<LoadInst>(LHSI)->isVolatile()) 3618 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I)) 3619 return Res; 3620 } 3621 break; 3622 } 3623 } 3624 3625 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now. 3626 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0)) 3627 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I)) 3628 return NI; 3629 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1)) 3630 if (Instruction *NI = FoldGEPICmp(GEP, Op0, 3631 ICmpInst::getSwappedPredicate(I.getPredicate()), I)) 3632 return NI; 3633 3634 // Try to optimize equality comparisons against alloca-based pointers. 3635 if (Op0->getType()->isPointerTy() && I.isEquality()) { 3636 assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?"); 3637 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op0, DL))) 3638 if (Instruction *New = FoldAllocaCmp(I, Alloca, Op1)) 3639 return New; 3640 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op1, DL))) 3641 if (Instruction *New = FoldAllocaCmp(I, Alloca, Op0)) 3642 return New; 3643 } 3644 3645 // Test to see if the operands of the icmp are casted versions of other 3646 // values. If the ptr->ptr cast can be stripped off both arguments, we do so 3647 // now. 3648 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) { 3649 if (Op0->getType()->isPointerTy() && 3650 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) { 3651 // We keep moving the cast from the left operand over to the right 3652 // operand, where it can often be eliminated completely. 3653 Op0 = CI->getOperand(0); 3654 3655 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast 3656 // so eliminate it as well. 3657 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1)) 3658 Op1 = CI2->getOperand(0); 3659 3660 // If Op1 is a constant, we can fold the cast into the constant. 3661 if (Op0->getType() != Op1->getType()) { 3662 if (Constant *Op1C = dyn_cast<Constant>(Op1)) { 3663 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType()); 3664 } else { 3665 // Otherwise, cast the RHS right before the icmp 3666 Op1 = Builder->CreateBitCast(Op1, Op0->getType()); 3667 } 3668 } 3669 return new ICmpInst(I.getPredicate(), Op0, Op1); 3670 } 3671 } 3672 3673 if (isa<CastInst>(Op0)) { 3674 // Handle the special case of: icmp (cast bool to X), <cst> 3675 // This comes up when you have code like 3676 // int X = A < B; 3677 // if (X) ... 3678 // For generality, we handle any zero-extension of any operand comparison 3679 // with a constant or another cast from the same type. 3680 if (isa<Constant>(Op1) || isa<CastInst>(Op1)) 3681 if (Instruction *R = visitICmpInstWithCastAndCast(I)) 3682 return R; 3683 } 3684 3685 // Special logic for binary operators. 3686 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0); 3687 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1); 3688 if (BO0 || BO1) { 3689 CmpInst::Predicate Pred = I.getPredicate(); 3690 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false; 3691 if (BO0 && isa<OverflowingBinaryOperator>(BO0)) 3692 NoOp0WrapProblem = ICmpInst::isEquality(Pred) || 3693 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) || 3694 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap()); 3695 if (BO1 && isa<OverflowingBinaryOperator>(BO1)) 3696 NoOp1WrapProblem = ICmpInst::isEquality(Pred) || 3697 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) || 3698 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap()); 3699 3700 // Analyze the case when either Op0 or Op1 is an add instruction. 3701 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null). 3702 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr; 3703 if (BO0 && BO0->getOpcode() == Instruction::Add) { 3704 A = BO0->getOperand(0); 3705 B = BO0->getOperand(1); 3706 } 3707 if (BO1 && BO1->getOpcode() == Instruction::Add) { 3708 C = BO1->getOperand(0); 3709 D = BO1->getOperand(1); 3710 } 3711 3712 // icmp (X+cst) < 0 --> X < -cst 3713 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred) && match(Op1, m_Zero())) 3714 if (ConstantInt *RHSC = dyn_cast_or_null<ConstantInt>(B)) 3715 if (!RHSC->isMinValue(/*isSigned=*/true)) 3716 return new ICmpInst(Pred, A, ConstantExpr::getNeg(RHSC)); 3717 3718 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow. 3719 if ((A == Op1 || B == Op1) && NoOp0WrapProblem) 3720 return new ICmpInst(Pred, A == Op1 ? B : A, 3721 Constant::getNullValue(Op1->getType())); 3722 3723 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow. 3724 if ((C == Op0 || D == Op0) && NoOp1WrapProblem) 3725 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()), 3726 C == Op0 ? D : C); 3727 3728 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow. 3729 if (A && C && (A == C || A == D || B == C || B == D) && 3730 NoOp0WrapProblem && NoOp1WrapProblem && 3731 // Try not to increase register pressure. 3732 BO0->hasOneUse() && BO1->hasOneUse()) { 3733 // Determine Y and Z in the form icmp (X+Y), (X+Z). 3734 Value *Y, *Z; 3735 if (A == C) { 3736 // C + B == C + D -> B == D 3737 Y = B; 3738 Z = D; 3739 } else if (A == D) { 3740 // D + B == C + D -> B == C 3741 Y = B; 3742 Z = C; 3743 } else if (B == C) { 3744 // A + C == C + D -> A == D 3745 Y = A; 3746 Z = D; 3747 } else { 3748 assert(B == D); 3749 // A + D == C + D -> A == C 3750 Y = A; 3751 Z = C; 3752 } 3753 return new ICmpInst(Pred, Y, Z); 3754 } 3755 3756 // icmp slt (X + -1), Y -> icmp sle X, Y 3757 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT && 3758 match(B, m_AllOnes())) 3759 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1); 3760 3761 // icmp sge (X + -1), Y -> icmp sgt X, Y 3762 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE && 3763 match(B, m_AllOnes())) 3764 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1); 3765 3766 // icmp sle (X + 1), Y -> icmp slt X, Y 3767 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE && 3768 match(B, m_One())) 3769 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1); 3770 3771 // icmp sgt (X + 1), Y -> icmp sge X, Y 3772 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT && 3773 match(B, m_One())) 3774 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1); 3775 3776 // icmp sgt X, (Y + -1) -> icmp sge X, Y 3777 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT && 3778 match(D, m_AllOnes())) 3779 return new ICmpInst(CmpInst::ICMP_SGE, Op0, C); 3780 3781 // icmp sle X, (Y + -1) -> icmp slt X, Y 3782 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE && 3783 match(D, m_AllOnes())) 3784 return new ICmpInst(CmpInst::ICMP_SLT, Op0, C); 3785 3786 // icmp sge X, (Y + 1) -> icmp sgt X, Y 3787 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE && 3788 match(D, m_One())) 3789 return new ICmpInst(CmpInst::ICMP_SGT, Op0, C); 3790 3791 // icmp slt X, (Y + 1) -> icmp sle X, Y 3792 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT && 3793 match(D, m_One())) 3794 return new ICmpInst(CmpInst::ICMP_SLE, Op0, C); 3795 3796 // if C1 has greater magnitude than C2: 3797 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y 3798 // s.t. C3 = C1 - C2 3799 // 3800 // if C2 has greater magnitude than C1: 3801 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3) 3802 // s.t. C3 = C2 - C1 3803 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem && 3804 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned()) 3805 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B)) 3806 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) { 3807 const APInt &AP1 = C1->getValue(); 3808 const APInt &AP2 = C2->getValue(); 3809 if (AP1.isNegative() == AP2.isNegative()) { 3810 APInt AP1Abs = C1->getValue().abs(); 3811 APInt AP2Abs = C2->getValue().abs(); 3812 if (AP1Abs.uge(AP2Abs)) { 3813 ConstantInt *C3 = Builder->getInt(AP1 - AP2); 3814 Value *NewAdd = Builder->CreateNSWAdd(A, C3); 3815 return new ICmpInst(Pred, NewAdd, C); 3816 } else { 3817 ConstantInt *C3 = Builder->getInt(AP2 - AP1); 3818 Value *NewAdd = Builder->CreateNSWAdd(C, C3); 3819 return new ICmpInst(Pred, A, NewAdd); 3820 } 3821 } 3822 } 3823 3824 3825 // Analyze the case when either Op0 or Op1 is a sub instruction. 3826 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null). 3827 A = nullptr; 3828 B = nullptr; 3829 C = nullptr; 3830 D = nullptr; 3831 if (BO0 && BO0->getOpcode() == Instruction::Sub) { 3832 A = BO0->getOperand(0); 3833 B = BO0->getOperand(1); 3834 } 3835 if (BO1 && BO1->getOpcode() == Instruction::Sub) { 3836 C = BO1->getOperand(0); 3837 D = BO1->getOperand(1); 3838 } 3839 3840 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow. 3841 if (A == Op1 && NoOp0WrapProblem) 3842 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B); 3843 3844 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow. 3845 if (C == Op0 && NoOp1WrapProblem) 3846 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType())); 3847 3848 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow. 3849 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem && 3850 // Try not to increase register pressure. 3851 BO0->hasOneUse() && BO1->hasOneUse()) 3852 return new ICmpInst(Pred, A, C); 3853 3854 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow. 3855 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem && 3856 // Try not to increase register pressure. 3857 BO0->hasOneUse() && BO1->hasOneUse()) 3858 return new ICmpInst(Pred, D, B); 3859 3860 // icmp (0-X) < cst --> x > -cst 3861 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) { 3862 Value *X; 3863 if (match(BO0, m_Neg(m_Value(X)))) 3864 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1)) 3865 if (!RHSC->isMinValue(/*isSigned=*/true)) 3866 return new ICmpInst(I.getSwappedPredicate(), X, 3867 ConstantExpr::getNeg(RHSC)); 3868 } 3869 3870 BinaryOperator *SRem = nullptr; 3871 // icmp (srem X, Y), Y 3872 if (BO0 && BO0->getOpcode() == Instruction::SRem && 3873 Op1 == BO0->getOperand(1)) 3874 SRem = BO0; 3875 // icmp Y, (srem X, Y) 3876 else if (BO1 && BO1->getOpcode() == Instruction::SRem && 3877 Op0 == BO1->getOperand(1)) 3878 SRem = BO1; 3879 if (SRem) { 3880 // We don't check hasOneUse to avoid increasing register pressure because 3881 // the value we use is the same value this instruction was already using. 3882 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) { 3883 default: break; 3884 case ICmpInst::ICMP_EQ: 3885 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 3886 case ICmpInst::ICMP_NE: 3887 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 3888 case ICmpInst::ICMP_SGT: 3889 case ICmpInst::ICMP_SGE: 3890 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1), 3891 Constant::getAllOnesValue(SRem->getType())); 3892 case ICmpInst::ICMP_SLT: 3893 case ICmpInst::ICMP_SLE: 3894 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1), 3895 Constant::getNullValue(SRem->getType())); 3896 } 3897 } 3898 3899 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() && 3900 BO0->hasOneUse() && BO1->hasOneUse() && 3901 BO0->getOperand(1) == BO1->getOperand(1)) { 3902 switch (BO0->getOpcode()) { 3903 default: break; 3904 case Instruction::Add: 3905 case Instruction::Sub: 3906 case Instruction::Xor: 3907 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b 3908 return new ICmpInst(I.getPredicate(), BO0->getOperand(0), 3909 BO1->getOperand(0)); 3910 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b 3911 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) { 3912 if (CI->getValue().isSignBit()) { 3913 ICmpInst::Predicate Pred = I.isSigned() 3914 ? I.getUnsignedPredicate() 3915 : I.getSignedPredicate(); 3916 return new ICmpInst(Pred, BO0->getOperand(0), 3917 BO1->getOperand(0)); 3918 } 3919 3920 if (BO0->getOpcode() == Instruction::Xor && CI->isMaxValue(true)) { 3921 ICmpInst::Predicate Pred = I.isSigned() 3922 ? I.getUnsignedPredicate() 3923 : I.getSignedPredicate(); 3924 Pred = I.getSwappedPredicate(Pred); 3925 return new ICmpInst(Pred, BO0->getOperand(0), 3926 BO1->getOperand(0)); 3927 } 3928 } 3929 break; 3930 case Instruction::Mul: 3931 if (!I.isEquality()) 3932 break; 3933 3934 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) { 3935 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask 3936 // Mask = -1 >> count-trailing-zeros(Cst). 3937 if (!CI->isZero() && !CI->isOne()) { 3938 const APInt &AP = CI->getValue(); 3939 ConstantInt *Mask = ConstantInt::get(I.getContext(), 3940 APInt::getLowBitsSet(AP.getBitWidth(), 3941 AP.getBitWidth() - 3942 AP.countTrailingZeros())); 3943 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask); 3944 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask); 3945 return new ICmpInst(I.getPredicate(), And1, And2); 3946 } 3947 } 3948 break; 3949 case Instruction::UDiv: 3950 case Instruction::LShr: 3951 if (I.isSigned()) 3952 break; 3953 // fall-through 3954 case Instruction::SDiv: 3955 case Instruction::AShr: 3956 if (!BO0->isExact() || !BO1->isExact()) 3957 break; 3958 return new ICmpInst(I.getPredicate(), BO0->getOperand(0), 3959 BO1->getOperand(0)); 3960 case Instruction::Shl: { 3961 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap(); 3962 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap(); 3963 if (!NUW && !NSW) 3964 break; 3965 if (!NSW && I.isSigned()) 3966 break; 3967 return new ICmpInst(I.getPredicate(), BO0->getOperand(0), 3968 BO1->getOperand(0)); 3969 } 3970 } 3971 } 3972 3973 if (BO0) { 3974 // Transform A & (L - 1) `ult` L --> L != 0 3975 auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes()); 3976 auto BitwiseAnd = 3977 m_CombineOr(m_And(m_Value(), LSubOne), m_And(LSubOne, m_Value())); 3978 3979 if (match(BO0, BitwiseAnd) && I.getPredicate() == ICmpInst::ICMP_ULT) { 3980 auto *Zero = Constant::getNullValue(BO0->getType()); 3981 return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero); 3982 } 3983 } 3984 } 3985 3986 { Value *A, *B; 3987 // Transform (A & ~B) == 0 --> (A & B) != 0 3988 // and (A & ~B) != 0 --> (A & B) == 0 3989 // if A is a power of 2. 3990 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) && 3991 match(Op1, m_Zero()) && 3992 isKnownToBeAPowerOfTwo(A, DL, false, 0, AC, &I, DT) && I.isEquality()) 3993 return new ICmpInst(I.getInversePredicate(), 3994 Builder->CreateAnd(A, B), 3995 Op1); 3996 3997 // ~x < ~y --> y < x 3998 // ~x < cst --> ~cst < x 3999 if (match(Op0, m_Not(m_Value(A)))) { 4000 if (match(Op1, m_Not(m_Value(B)))) 4001 return new ICmpInst(I.getPredicate(), B, A); 4002 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1)) 4003 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A); 4004 } 4005 4006 Instruction *AddI = nullptr; 4007 if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B), 4008 m_Instruction(AddI))) && 4009 isa<IntegerType>(A->getType())) { 4010 Value *Result; 4011 Constant *Overflow; 4012 if (OptimizeOverflowCheck(OCF_UNSIGNED_ADD, A, B, *AddI, Result, 4013 Overflow)) { 4014 replaceInstUsesWith(*AddI, Result); 4015 return replaceInstUsesWith(I, Overflow); 4016 } 4017 } 4018 4019 // (zext a) * (zext b) --> llvm.umul.with.overflow. 4020 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) { 4021 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this)) 4022 return R; 4023 } 4024 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) { 4025 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this)) 4026 return R; 4027 } 4028 } 4029 4030 if (I.isEquality()) { 4031 Value *A, *B, *C, *D; 4032 4033 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) { 4034 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0 4035 Value *OtherVal = A == Op1 ? B : A; 4036 return new ICmpInst(I.getPredicate(), OtherVal, 4037 Constant::getNullValue(A->getType())); 4038 } 4039 4040 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) { 4041 // A^c1 == C^c2 --> A == C^(c1^c2) 4042 ConstantInt *C1, *C2; 4043 if (match(B, m_ConstantInt(C1)) && 4044 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) { 4045 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue()); 4046 Value *Xor = Builder->CreateXor(C, NC); 4047 return new ICmpInst(I.getPredicate(), A, Xor); 4048 } 4049 4050 // A^B == A^D -> B == D 4051 if (A == C) return new ICmpInst(I.getPredicate(), B, D); 4052 if (A == D) return new ICmpInst(I.getPredicate(), B, C); 4053 if (B == C) return new ICmpInst(I.getPredicate(), A, D); 4054 if (B == D) return new ICmpInst(I.getPredicate(), A, C); 4055 } 4056 } 4057 4058 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) && 4059 (A == Op0 || B == Op0)) { 4060 // A == (A^B) -> B == 0 4061 Value *OtherVal = A == Op0 ? B : A; 4062 return new ICmpInst(I.getPredicate(), OtherVal, 4063 Constant::getNullValue(A->getType())); 4064 } 4065 4066 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0 4067 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) && 4068 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) { 4069 Value *X = nullptr, *Y = nullptr, *Z = nullptr; 4070 4071 if (A == C) { 4072 X = B; Y = D; Z = A; 4073 } else if (A == D) { 4074 X = B; Y = C; Z = A; 4075 } else if (B == C) { 4076 X = A; Y = D; Z = B; 4077 } else if (B == D) { 4078 X = A; Y = C; Z = B; 4079 } 4080 4081 if (X) { // Build (X^Y) & Z 4082 Op1 = Builder->CreateXor(X, Y); 4083 Op1 = Builder->CreateAnd(Op1, Z); 4084 I.setOperand(0, Op1); 4085 I.setOperand(1, Constant::getNullValue(Op1->getType())); 4086 return &I; 4087 } 4088 } 4089 4090 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B) 4091 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B) 4092 ConstantInt *Cst1; 4093 if ((Op0->hasOneUse() && 4094 match(Op0, m_ZExt(m_Value(A))) && 4095 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) || 4096 (Op1->hasOneUse() && 4097 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) && 4098 match(Op1, m_ZExt(m_Value(A))))) { 4099 APInt Pow2 = Cst1->getValue() + 1; 4100 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) && 4101 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth()) 4102 return new ICmpInst(I.getPredicate(), A, 4103 Builder->CreateTrunc(B, A->getType())); 4104 } 4105 4106 // (A >> C) == (B >> C) --> (A^B) u< (1 << C) 4107 // For lshr and ashr pairs. 4108 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) && 4109 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) || 4110 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) && 4111 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) { 4112 unsigned TypeBits = Cst1->getBitWidth(); 4113 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits); 4114 if (ShAmt < TypeBits && ShAmt != 0) { 4115 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE 4116 ? ICmpInst::ICMP_UGE 4117 : ICmpInst::ICMP_ULT; 4118 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted"); 4119 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt); 4120 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal)); 4121 } 4122 } 4123 4124 // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0 4125 if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) && 4126 match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) { 4127 unsigned TypeBits = Cst1->getBitWidth(); 4128 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits); 4129 if (ShAmt < TypeBits && ShAmt != 0) { 4130 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted"); 4131 APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt); 4132 Value *And = Builder->CreateAnd(Xor, Builder->getInt(AndVal), 4133 I.getName() + ".mask"); 4134 return new ICmpInst(I.getPredicate(), And, 4135 Constant::getNullValue(Cst1->getType())); 4136 } 4137 } 4138 4139 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to 4140 // "icmp (and X, mask), cst" 4141 uint64_t ShAmt = 0; 4142 if (Op0->hasOneUse() && 4143 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A), 4144 m_ConstantInt(ShAmt))))) && 4145 match(Op1, m_ConstantInt(Cst1)) && 4146 // Only do this when A has multiple uses. This is most important to do 4147 // when it exposes other optimizations. 4148 !A->hasOneUse()) { 4149 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits(); 4150 4151 if (ShAmt < ASize) { 4152 APInt MaskV = 4153 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits()); 4154 MaskV <<= ShAmt; 4155 4156 APInt CmpV = Cst1->getValue().zext(ASize); 4157 CmpV <<= ShAmt; 4158 4159 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV)); 4160 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV)); 4161 } 4162 } 4163 } 4164 4165 // The 'cmpxchg' instruction returns an aggregate containing the old value and 4166 // an i1 which indicates whether or not we successfully did the swap. 4167 // 4168 // Replace comparisons between the old value and the expected value with the 4169 // indicator that 'cmpxchg' returns. 4170 // 4171 // N.B. This transform is only valid when the 'cmpxchg' is not permitted to 4172 // spuriously fail. In those cases, the old value may equal the expected 4173 // value but it is possible for the swap to not occur. 4174 if (I.getPredicate() == ICmpInst::ICMP_EQ) 4175 if (auto *EVI = dyn_cast<ExtractValueInst>(Op0)) 4176 if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand())) 4177 if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 && 4178 !ACXI->isWeak()) 4179 return ExtractValueInst::Create(ACXI, 1); 4180 4181 { 4182 Value *X; ConstantInt *Cst; 4183 // icmp X+Cst, X 4184 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X) 4185 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate()); 4186 4187 // icmp X, X+Cst 4188 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X) 4189 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate()); 4190 } 4191 return Changed ? &I : nullptr; 4192 } 4193 4194 /// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible. 4195 Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I, 4196 Instruction *LHSI, 4197 Constant *RHSC) { 4198 if (!isa<ConstantFP>(RHSC)) return nullptr; 4199 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF(); 4200 4201 // Get the width of the mantissa. We don't want to hack on conversions that 4202 // might lose information from the integer, e.g. "i64 -> float" 4203 int MantissaWidth = LHSI->getType()->getFPMantissaWidth(); 4204 if (MantissaWidth == -1) return nullptr; // Unknown. 4205 4206 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType()); 4207 4208 bool LHSUnsigned = isa<UIToFPInst>(LHSI); 4209 4210 if (I.isEquality()) { 4211 FCmpInst::Predicate P = I.getPredicate(); 4212 bool IsExact = false; 4213 APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned); 4214 RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact); 4215 4216 // If the floating point constant isn't an integer value, we know if we will 4217 // ever compare equal / not equal to it. 4218 if (!IsExact) { 4219 // TODO: Can never be -0.0 and other non-representable values 4220 APFloat RHSRoundInt(RHS); 4221 RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven); 4222 if (RHS.compare(RHSRoundInt) != APFloat::cmpEqual) { 4223 if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ) 4224 return replaceInstUsesWith(I, Builder->getFalse()); 4225 4226 assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE); 4227 return replaceInstUsesWith(I, Builder->getTrue()); 4228 } 4229 } 4230 4231 // TODO: If the constant is exactly representable, is it always OK to do 4232 // equality compares as integer? 4233 } 4234 4235 // Check to see that the input is converted from an integer type that is small 4236 // enough that preserves all bits. TODO: check here for "known" sign bits. 4237 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e. 4238 unsigned InputSize = IntTy->getScalarSizeInBits(); 4239 4240 // Following test does NOT adjust InputSize downwards for signed inputs, 4241 // because the most negative value still requires all the mantissa bits 4242 // to distinguish it from one less than that value. 4243 if ((int)InputSize > MantissaWidth) { 4244 // Conversion would lose accuracy. Check if loss can impact comparison. 4245 int Exp = ilogb(RHS); 4246 if (Exp == APFloat::IEK_Inf) { 4247 int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics())); 4248 if (MaxExponent < (int)InputSize - !LHSUnsigned) 4249 // Conversion could create infinity. 4250 return nullptr; 4251 } else { 4252 // Note that if RHS is zero or NaN, then Exp is negative 4253 // and first condition is trivially false. 4254 if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned) 4255 // Conversion could affect comparison. 4256 return nullptr; 4257 } 4258 } 4259 4260 // Otherwise, we can potentially simplify the comparison. We know that it 4261 // will always come through as an integer value and we know the constant is 4262 // not a NAN (it would have been previously simplified). 4263 assert(!RHS.isNaN() && "NaN comparison not already folded!"); 4264 4265 ICmpInst::Predicate Pred; 4266 switch (I.getPredicate()) { 4267 default: llvm_unreachable("Unexpected predicate!"); 4268 case FCmpInst::FCMP_UEQ: 4269 case FCmpInst::FCMP_OEQ: 4270 Pred = ICmpInst::ICMP_EQ; 4271 break; 4272 case FCmpInst::FCMP_UGT: 4273 case FCmpInst::FCMP_OGT: 4274 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT; 4275 break; 4276 case FCmpInst::FCMP_UGE: 4277 case FCmpInst::FCMP_OGE: 4278 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE; 4279 break; 4280 case FCmpInst::FCMP_ULT: 4281 case FCmpInst::FCMP_OLT: 4282 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT; 4283 break; 4284 case FCmpInst::FCMP_ULE: 4285 case FCmpInst::FCMP_OLE: 4286 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE; 4287 break; 4288 case FCmpInst::FCMP_UNE: 4289 case FCmpInst::FCMP_ONE: 4290 Pred = ICmpInst::ICMP_NE; 4291 break; 4292 case FCmpInst::FCMP_ORD: 4293 return replaceInstUsesWith(I, Builder->getTrue()); 4294 case FCmpInst::FCMP_UNO: 4295 return replaceInstUsesWith(I, Builder->getFalse()); 4296 } 4297 4298 // Now we know that the APFloat is a normal number, zero or inf. 4299 4300 // See if the FP constant is too large for the integer. For example, 4301 // comparing an i8 to 300.0. 4302 unsigned IntWidth = IntTy->getScalarSizeInBits(); 4303 4304 if (!LHSUnsigned) { 4305 // If the RHS value is > SignedMax, fold the comparison. This handles +INF 4306 // and large values. 4307 APFloat SMax(RHS.getSemantics()); 4308 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true, 4309 APFloat::rmNearestTiesToEven); 4310 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0 4311 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT || 4312 Pred == ICmpInst::ICMP_SLE) 4313 return replaceInstUsesWith(I, Builder->getTrue()); 4314 return replaceInstUsesWith(I, Builder->getFalse()); 4315 } 4316 } else { 4317 // If the RHS value is > UnsignedMax, fold the comparison. This handles 4318 // +INF and large values. 4319 APFloat UMax(RHS.getSemantics()); 4320 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false, 4321 APFloat::rmNearestTiesToEven); 4322 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0 4323 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT || 4324 Pred == ICmpInst::ICMP_ULE) 4325 return replaceInstUsesWith(I, Builder->getTrue()); 4326 return replaceInstUsesWith(I, Builder->getFalse()); 4327 } 4328 } 4329 4330 if (!LHSUnsigned) { 4331 // See if the RHS value is < SignedMin. 4332 APFloat SMin(RHS.getSemantics()); 4333 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true, 4334 APFloat::rmNearestTiesToEven); 4335 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0 4336 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT || 4337 Pred == ICmpInst::ICMP_SGE) 4338 return replaceInstUsesWith(I, Builder->getTrue()); 4339 return replaceInstUsesWith(I, Builder->getFalse()); 4340 } 4341 } else { 4342 // See if the RHS value is < UnsignedMin. 4343 APFloat SMin(RHS.getSemantics()); 4344 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true, 4345 APFloat::rmNearestTiesToEven); 4346 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0 4347 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT || 4348 Pred == ICmpInst::ICMP_UGE) 4349 return replaceInstUsesWith(I, Builder->getTrue()); 4350 return replaceInstUsesWith(I, Builder->getFalse()); 4351 } 4352 } 4353 4354 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or 4355 // [0, UMAX], but it may still be fractional. See if it is fractional by 4356 // casting the FP value to the integer value and back, checking for equality. 4357 // Don't do this for zero, because -0.0 is not fractional. 4358 Constant *RHSInt = LHSUnsigned 4359 ? ConstantExpr::getFPToUI(RHSC, IntTy) 4360 : ConstantExpr::getFPToSI(RHSC, IntTy); 4361 if (!RHS.isZero()) { 4362 bool Equal = LHSUnsigned 4363 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC 4364 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC; 4365 if (!Equal) { 4366 // If we had a comparison against a fractional value, we have to adjust 4367 // the compare predicate and sometimes the value. RHSC is rounded towards 4368 // zero at this point. 4369 switch (Pred) { 4370 default: llvm_unreachable("Unexpected integer comparison!"); 4371 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true 4372 return replaceInstUsesWith(I, Builder->getTrue()); 4373 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false 4374 return replaceInstUsesWith(I, Builder->getFalse()); 4375 case ICmpInst::ICMP_ULE: 4376 // (float)int <= 4.4 --> int <= 4 4377 // (float)int <= -4.4 --> false 4378 if (RHS.isNegative()) 4379 return replaceInstUsesWith(I, Builder->getFalse()); 4380 break; 4381 case ICmpInst::ICMP_SLE: 4382 // (float)int <= 4.4 --> int <= 4 4383 // (float)int <= -4.4 --> int < -4 4384 if (RHS.isNegative()) 4385 Pred = ICmpInst::ICMP_SLT; 4386 break; 4387 case ICmpInst::ICMP_ULT: 4388 // (float)int < -4.4 --> false 4389 // (float)int < 4.4 --> int <= 4 4390 if (RHS.isNegative()) 4391 return replaceInstUsesWith(I, Builder->getFalse()); 4392 Pred = ICmpInst::ICMP_ULE; 4393 break; 4394 case ICmpInst::ICMP_SLT: 4395 // (float)int < -4.4 --> int < -4 4396 // (float)int < 4.4 --> int <= 4 4397 if (!RHS.isNegative()) 4398 Pred = ICmpInst::ICMP_SLE; 4399 break; 4400 case ICmpInst::ICMP_UGT: 4401 // (float)int > 4.4 --> int > 4 4402 // (float)int > -4.4 --> true 4403 if (RHS.isNegative()) 4404 return replaceInstUsesWith(I, Builder->getTrue()); 4405 break; 4406 case ICmpInst::ICMP_SGT: 4407 // (float)int > 4.4 --> int > 4 4408 // (float)int > -4.4 --> int >= -4 4409 if (RHS.isNegative()) 4410 Pred = ICmpInst::ICMP_SGE; 4411 break; 4412 case ICmpInst::ICMP_UGE: 4413 // (float)int >= -4.4 --> true 4414 // (float)int >= 4.4 --> int > 4 4415 if (RHS.isNegative()) 4416 return replaceInstUsesWith(I, Builder->getTrue()); 4417 Pred = ICmpInst::ICMP_UGT; 4418 break; 4419 case ICmpInst::ICMP_SGE: 4420 // (float)int >= -4.4 --> int >= -4 4421 // (float)int >= 4.4 --> int > 4 4422 if (!RHS.isNegative()) 4423 Pred = ICmpInst::ICMP_SGT; 4424 break; 4425 } 4426 } 4427 } 4428 4429 // Lower this FP comparison into an appropriate integer version of the 4430 // comparison. 4431 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt); 4432 } 4433 4434 Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) { 4435 bool Changed = false; 4436 4437 /// Orders the operands of the compare so that they are listed from most 4438 /// complex to least complex. This puts constants before unary operators, 4439 /// before binary operators. 4440 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) { 4441 I.swapOperands(); 4442 Changed = true; 4443 } 4444 4445 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 4446 4447 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, 4448 I.getFastMathFlags(), DL, TLI, DT, AC, &I)) 4449 return replaceInstUsesWith(I, V); 4450 4451 // Simplify 'fcmp pred X, X' 4452 if (Op0 == Op1) { 4453 switch (I.getPredicate()) { 4454 default: llvm_unreachable("Unknown predicate!"); 4455 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y) 4456 case FCmpInst::FCMP_ULT: // True if unordered or less than 4457 case FCmpInst::FCMP_UGT: // True if unordered or greater than 4458 case FCmpInst::FCMP_UNE: // True if unordered or not equal 4459 // Canonicalize these to be 'fcmp uno %X, 0.0'. 4460 I.setPredicate(FCmpInst::FCMP_UNO); 4461 I.setOperand(1, Constant::getNullValue(Op0->getType())); 4462 return &I; 4463 4464 case FCmpInst::FCMP_ORD: // True if ordered (no nans) 4465 case FCmpInst::FCMP_OEQ: // True if ordered and equal 4466 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal 4467 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal 4468 // Canonicalize these to be 'fcmp ord %X, 0.0'. 4469 I.setPredicate(FCmpInst::FCMP_ORD); 4470 I.setOperand(1, Constant::getNullValue(Op0->getType())); 4471 return &I; 4472 } 4473 } 4474 4475 // Test if the FCmpInst instruction is used exclusively by a select as 4476 // part of a minimum or maximum operation. If so, refrain from doing 4477 // any other folding. This helps out other analyses which understand 4478 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution 4479 // and CodeGen. And in this case, at least one of the comparison 4480 // operands has at least one user besides the compare (the select), 4481 // which would often largely negate the benefit of folding anyway. 4482 if (I.hasOneUse()) 4483 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin())) 4484 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) || 4485 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1)) 4486 return nullptr; 4487 4488 // Handle fcmp with constant RHS 4489 if (Constant *RHSC = dyn_cast<Constant>(Op1)) { 4490 if (Instruction *LHSI = dyn_cast<Instruction>(Op0)) 4491 switch (LHSI->getOpcode()) { 4492 case Instruction::FPExt: { 4493 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless 4494 FPExtInst *LHSExt = cast<FPExtInst>(LHSI); 4495 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC); 4496 if (!RHSF) 4497 break; 4498 4499 const fltSemantics *Sem; 4500 // FIXME: This shouldn't be here. 4501 if (LHSExt->getSrcTy()->isHalfTy()) 4502 Sem = &APFloat::IEEEhalf; 4503 else if (LHSExt->getSrcTy()->isFloatTy()) 4504 Sem = &APFloat::IEEEsingle; 4505 else if (LHSExt->getSrcTy()->isDoubleTy()) 4506 Sem = &APFloat::IEEEdouble; 4507 else if (LHSExt->getSrcTy()->isFP128Ty()) 4508 Sem = &APFloat::IEEEquad; 4509 else if (LHSExt->getSrcTy()->isX86_FP80Ty()) 4510 Sem = &APFloat::x87DoubleExtended; 4511 else if (LHSExt->getSrcTy()->isPPC_FP128Ty()) 4512 Sem = &APFloat::PPCDoubleDouble; 4513 else 4514 break; 4515 4516 bool Lossy; 4517 APFloat F = RHSF->getValueAPF(); 4518 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy); 4519 4520 // Avoid lossy conversions and denormals. Zero is a special case 4521 // that's OK to convert. 4522 APFloat Fabs = F; 4523 Fabs.clearSign(); 4524 if (!Lossy && 4525 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) != 4526 APFloat::cmpLessThan) || Fabs.isZero())) 4527 4528 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0), 4529 ConstantFP::get(RHSC->getContext(), F)); 4530 break; 4531 } 4532 case Instruction::PHI: 4533 // Only fold fcmp into the PHI if the phi and fcmp are in the same 4534 // block. If in the same block, we're encouraging jump threading. If 4535 // not, we are just pessimizing the code by making an i1 phi. 4536 if (LHSI->getParent() == I.getParent()) 4537 if (Instruction *NV = FoldOpIntoPhi(I)) 4538 return NV; 4539 break; 4540 case Instruction::SIToFP: 4541 case Instruction::UIToFP: 4542 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC)) 4543 return NV; 4544 break; 4545 case Instruction::FSub: { 4546 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C 4547 Value *Op; 4548 if (match(LHSI, m_FNeg(m_Value(Op)))) 4549 return new FCmpInst(I.getSwappedPredicate(), Op, 4550 ConstantExpr::getFNeg(RHSC)); 4551 break; 4552 } 4553 case Instruction::Load: 4554 if (GetElementPtrInst *GEP = 4555 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) { 4556 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0))) 4557 if (GV->isConstant() && GV->hasDefinitiveInitializer() && 4558 !cast<LoadInst>(LHSI)->isVolatile()) 4559 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I)) 4560 return Res; 4561 } 4562 break; 4563 case Instruction::Call: { 4564 if (!RHSC->isNullValue()) 4565 break; 4566 4567 CallInst *CI = cast<CallInst>(LHSI); 4568 Intrinsic::ID IID = getIntrinsicIDForCall(CI, TLI); 4569 if (IID != Intrinsic::fabs) 4570 break; 4571 4572 // Various optimization for fabs compared with zero. 4573 switch (I.getPredicate()) { 4574 default: 4575 break; 4576 // fabs(x) < 0 --> false 4577 case FCmpInst::FCMP_OLT: 4578 llvm_unreachable("handled by SimplifyFCmpInst"); 4579 // fabs(x) > 0 --> x != 0 4580 case FCmpInst::FCMP_OGT: 4581 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0), RHSC); 4582 // fabs(x) <= 0 --> x == 0 4583 case FCmpInst::FCMP_OLE: 4584 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0), RHSC); 4585 // fabs(x) >= 0 --> !isnan(x) 4586 case FCmpInst::FCMP_OGE: 4587 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0), RHSC); 4588 // fabs(x) == 0 --> x == 0 4589 // fabs(x) != 0 --> x != 0 4590 case FCmpInst::FCMP_OEQ: 4591 case FCmpInst::FCMP_UEQ: 4592 case FCmpInst::FCMP_ONE: 4593 case FCmpInst::FCMP_UNE: 4594 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0), RHSC); 4595 } 4596 } 4597 } 4598 } 4599 4600 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y 4601 Value *X, *Y; 4602 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y)))) 4603 return new FCmpInst(I.getSwappedPredicate(), X, Y); 4604 4605 // fcmp (fpext x), (fpext y) -> fcmp x, y 4606 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0)) 4607 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1)) 4608 if (LHSExt->getSrcTy() == RHSExt->getSrcTy()) 4609 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0), 4610 RHSExt->getOperand(0)); 4611 4612 return Changed ? &I : nullptr; 4613 } 4614