1 //===- InstCombineCompares.cpp --------------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file implements the visitICmp and visitFCmp functions. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "InstCombineInternal.h" 14 #include "llvm/ADT/APSInt.h" 15 #include "llvm/ADT/SetVector.h" 16 #include "llvm/ADT/Statistic.h" 17 #include "llvm/Analysis/CmpInstAnalysis.h" 18 #include "llvm/Analysis/ConstantFolding.h" 19 #include "llvm/Analysis/InstructionSimplify.h" 20 #include "llvm/IR/ConstantRange.h" 21 #include "llvm/IR/DataLayout.h" 22 #include "llvm/IR/GetElementPtrTypeIterator.h" 23 #include "llvm/IR/IntrinsicInst.h" 24 #include "llvm/IR/PatternMatch.h" 25 #include "llvm/Support/KnownBits.h" 26 #include "llvm/Transforms/InstCombine/InstCombiner.h" 27 28 using namespace llvm; 29 using namespace PatternMatch; 30 31 #define DEBUG_TYPE "instcombine" 32 33 // How many times is a select replaced by one of its operands? 34 STATISTIC(NumSel, "Number of select opts"); 35 36 37 /// Compute Result = In1+In2, returning true if the result overflowed for this 38 /// type. 39 static bool addWithOverflow(APInt &Result, const APInt &In1, 40 const APInt &In2, bool IsSigned = false) { 41 bool Overflow; 42 if (IsSigned) 43 Result = In1.sadd_ov(In2, Overflow); 44 else 45 Result = In1.uadd_ov(In2, Overflow); 46 47 return Overflow; 48 } 49 50 /// Compute Result = In1-In2, returning true if the result overflowed for this 51 /// type. 52 static bool subWithOverflow(APInt &Result, const APInt &In1, 53 const APInt &In2, bool IsSigned = false) { 54 bool Overflow; 55 if (IsSigned) 56 Result = In1.ssub_ov(In2, Overflow); 57 else 58 Result = In1.usub_ov(In2, Overflow); 59 60 return Overflow; 61 } 62 63 /// Given an icmp instruction, return true if any use of this comparison is a 64 /// branch on sign bit comparison. 65 static bool hasBranchUse(ICmpInst &I) { 66 for (auto *U : I.users()) 67 if (isa<BranchInst>(U)) 68 return true; 69 return false; 70 } 71 72 /// Returns true if the exploded icmp can be expressed as a signed comparison 73 /// to zero and updates the predicate accordingly. 74 /// The signedness of the comparison is preserved. 75 /// TODO: Refactor with decomposeBitTestICmp()? 76 static bool isSignTest(ICmpInst::Predicate &Pred, const APInt &C) { 77 if (!ICmpInst::isSigned(Pred)) 78 return false; 79 80 if (C.isZero()) 81 return ICmpInst::isRelational(Pred); 82 83 if (C.isOne()) { 84 if (Pred == ICmpInst::ICMP_SLT) { 85 Pred = ICmpInst::ICMP_SLE; 86 return true; 87 } 88 } else if (C.isAllOnes()) { 89 if (Pred == ICmpInst::ICMP_SGT) { 90 Pred = ICmpInst::ICMP_SGE; 91 return true; 92 } 93 } 94 95 return false; 96 } 97 98 /// This is called when we see this pattern: 99 /// cmp pred (load (gep GV, ...)), cmpcst 100 /// where GV is a global variable with a constant initializer. Try to simplify 101 /// this into some simple computation that does not need the load. For example 102 /// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3". 103 /// 104 /// If AndCst is non-null, then the loaded value is masked with that constant 105 /// before doing the comparison. This handles cases like "A[i]&4 == 0". 106 Instruction *InstCombinerImpl::foldCmpLoadFromIndexedGlobal( 107 LoadInst *LI, GetElementPtrInst *GEP, GlobalVariable *GV, CmpInst &ICI, 108 ConstantInt *AndCst) { 109 if (LI->isVolatile() || LI->getType() != GEP->getResultElementType() || 110 GV->getValueType() != GEP->getSourceElementType() || 111 !GV->isConstant() || !GV->hasDefinitiveInitializer()) 112 return nullptr; 113 114 Constant *Init = GV->getInitializer(); 115 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init)) 116 return nullptr; 117 118 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements(); 119 // Don't blow up on huge arrays. 120 if (ArrayElementCount > MaxArraySizeForCombine) 121 return nullptr; 122 123 // There are many forms of this optimization we can handle, for now, just do 124 // the simple index into a single-dimensional array. 125 // 126 // Require: GEP GV, 0, i {{, constant indices}} 127 if (GEP->getNumOperands() < 3 || 128 !isa<ConstantInt>(GEP->getOperand(1)) || 129 !cast<ConstantInt>(GEP->getOperand(1))->isZero() || 130 isa<Constant>(GEP->getOperand(2))) 131 return nullptr; 132 133 // Check that indices after the variable are constants and in-range for the 134 // type they index. Collect the indices. This is typically for arrays of 135 // structs. 136 SmallVector<unsigned, 4> LaterIndices; 137 138 Type *EltTy = Init->getType()->getArrayElementType(); 139 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) { 140 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i)); 141 if (!Idx) return nullptr; // Variable index. 142 143 uint64_t IdxVal = Idx->getZExtValue(); 144 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index. 145 146 if (StructType *STy = dyn_cast<StructType>(EltTy)) 147 EltTy = STy->getElementType(IdxVal); 148 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) { 149 if (IdxVal >= ATy->getNumElements()) return nullptr; 150 EltTy = ATy->getElementType(); 151 } else { 152 return nullptr; // Unknown type. 153 } 154 155 LaterIndices.push_back(IdxVal); 156 } 157 158 enum { Overdefined = -3, Undefined = -2 }; 159 160 // Variables for our state machines. 161 162 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form 163 // "i == 47 | i == 87", where 47 is the first index the condition is true for, 164 // and 87 is the second (and last) index. FirstTrueElement is -2 when 165 // undefined, otherwise set to the first true element. SecondTrueElement is 166 // -2 when undefined, -3 when overdefined and >= 0 when that index is true. 167 int FirstTrueElement = Undefined, SecondTrueElement = Undefined; 168 169 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the 170 // form "i != 47 & i != 87". Same state transitions as for true elements. 171 int FirstFalseElement = Undefined, SecondFalseElement = Undefined; 172 173 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these 174 /// define a state machine that triggers for ranges of values that the index 175 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'. 176 /// This is -2 when undefined, -3 when overdefined, and otherwise the last 177 /// index in the range (inclusive). We use -2 for undefined here because we 178 /// use relative comparisons and don't want 0-1 to match -1. 179 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined; 180 181 // MagicBitvector - This is a magic bitvector where we set a bit if the 182 // comparison is true for element 'i'. If there are 64 elements or less in 183 // the array, this will fully represent all the comparison results. 184 uint64_t MagicBitvector = 0; 185 186 // Scan the array and see if one of our patterns matches. 187 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1)); 188 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) { 189 Constant *Elt = Init->getAggregateElement(i); 190 if (!Elt) return nullptr; 191 192 // If this is indexing an array of structures, get the structure element. 193 if (!LaterIndices.empty()) 194 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices); 195 196 // If the element is masked, handle it. 197 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst); 198 199 // Find out if the comparison would be true or false for the i'th element. 200 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt, 201 CompareRHS, DL, &TLI); 202 // If the result is undef for this element, ignore it. 203 if (isa<UndefValue>(C)) { 204 // Extend range state machines to cover this element in case there is an 205 // undef in the middle of the range. 206 if (TrueRangeEnd == (int)i-1) 207 TrueRangeEnd = i; 208 if (FalseRangeEnd == (int)i-1) 209 FalseRangeEnd = i; 210 continue; 211 } 212 213 // If we can't compute the result for any of the elements, we have to give 214 // up evaluating the entire conditional. 215 if (!isa<ConstantInt>(C)) return nullptr; 216 217 // Otherwise, we know if the comparison is true or false for this element, 218 // update our state machines. 219 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero(); 220 221 // State machine for single/double/range index comparison. 222 if (IsTrueForElt) { 223 // Update the TrueElement state machine. 224 if (FirstTrueElement == Undefined) 225 FirstTrueElement = TrueRangeEnd = i; // First true element. 226 else { 227 // Update double-compare state machine. 228 if (SecondTrueElement == Undefined) 229 SecondTrueElement = i; 230 else 231 SecondTrueElement = Overdefined; 232 233 // Update range state machine. 234 if (TrueRangeEnd == (int)i-1) 235 TrueRangeEnd = i; 236 else 237 TrueRangeEnd = Overdefined; 238 } 239 } else { 240 // Update the FalseElement state machine. 241 if (FirstFalseElement == Undefined) 242 FirstFalseElement = FalseRangeEnd = i; // First false element. 243 else { 244 // Update double-compare state machine. 245 if (SecondFalseElement == Undefined) 246 SecondFalseElement = i; 247 else 248 SecondFalseElement = Overdefined; 249 250 // Update range state machine. 251 if (FalseRangeEnd == (int)i-1) 252 FalseRangeEnd = i; 253 else 254 FalseRangeEnd = Overdefined; 255 } 256 } 257 258 // If this element is in range, update our magic bitvector. 259 if (i < 64 && IsTrueForElt) 260 MagicBitvector |= 1ULL << i; 261 262 // If all of our states become overdefined, bail out early. Since the 263 // predicate is expensive, only check it every 8 elements. This is only 264 // really useful for really huge arrays. 265 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined && 266 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined && 267 FalseRangeEnd == Overdefined) 268 return nullptr; 269 } 270 271 // Now that we've scanned the entire array, emit our new comparison(s). We 272 // order the state machines in complexity of the generated code. 273 Value *Idx = GEP->getOperand(2); 274 275 // If the index is larger than the pointer size of the target, truncate the 276 // index down like the GEP would do implicitly. We don't have to do this for 277 // an inbounds GEP because the index can't be out of range. 278 if (!GEP->isInBounds()) { 279 Type *IntPtrTy = DL.getIntPtrType(GEP->getType()); 280 unsigned PtrSize = IntPtrTy->getIntegerBitWidth(); 281 if (Idx->getType()->getPrimitiveSizeInBits().getFixedSize() > PtrSize) 282 Idx = Builder.CreateTrunc(Idx, IntPtrTy); 283 } 284 285 // If inbounds keyword is not present, Idx * ElementSize can overflow. 286 // Let's assume that ElementSize is 2 and the wanted value is at offset 0. 287 // Then, there are two possible values for Idx to match offset 0: 288 // 0x00..00, 0x80..00. 289 // Emitting 'icmp eq Idx, 0' isn't correct in this case because the 290 // comparison is false if Idx was 0x80..00. 291 // We need to erase the highest countTrailingZeros(ElementSize) bits of Idx. 292 unsigned ElementSize = 293 DL.getTypeAllocSize(Init->getType()->getArrayElementType()); 294 auto MaskIdx = [&](Value* Idx){ 295 if (!GEP->isInBounds() && countTrailingZeros(ElementSize) != 0) { 296 Value *Mask = ConstantInt::get(Idx->getType(), -1); 297 Mask = Builder.CreateLShr(Mask, countTrailingZeros(ElementSize)); 298 Idx = Builder.CreateAnd(Idx, Mask); 299 } 300 return Idx; 301 }; 302 303 // If the comparison is only true for one or two elements, emit direct 304 // comparisons. 305 if (SecondTrueElement != Overdefined) { 306 Idx = MaskIdx(Idx); 307 // None true -> false. 308 if (FirstTrueElement == Undefined) 309 return replaceInstUsesWith(ICI, Builder.getFalse()); 310 311 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement); 312 313 // True for one element -> 'i == 47'. 314 if (SecondTrueElement == Undefined) 315 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx); 316 317 // True for two elements -> 'i == 47 | i == 72'. 318 Value *C1 = Builder.CreateICmpEQ(Idx, FirstTrueIdx); 319 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement); 320 Value *C2 = Builder.CreateICmpEQ(Idx, SecondTrueIdx); 321 return BinaryOperator::CreateOr(C1, C2); 322 } 323 324 // If the comparison is only false for one or two elements, emit direct 325 // comparisons. 326 if (SecondFalseElement != Overdefined) { 327 Idx = MaskIdx(Idx); 328 // None false -> true. 329 if (FirstFalseElement == Undefined) 330 return replaceInstUsesWith(ICI, Builder.getTrue()); 331 332 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement); 333 334 // False for one element -> 'i != 47'. 335 if (SecondFalseElement == Undefined) 336 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx); 337 338 // False for two elements -> 'i != 47 & i != 72'. 339 Value *C1 = Builder.CreateICmpNE(Idx, FirstFalseIdx); 340 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement); 341 Value *C2 = Builder.CreateICmpNE(Idx, SecondFalseIdx); 342 return BinaryOperator::CreateAnd(C1, C2); 343 } 344 345 // If the comparison can be replaced with a range comparison for the elements 346 // where it is true, emit the range check. 347 if (TrueRangeEnd != Overdefined) { 348 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare"); 349 Idx = MaskIdx(Idx); 350 351 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1). 352 if (FirstTrueElement) { 353 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement); 354 Idx = Builder.CreateAdd(Idx, Offs); 355 } 356 357 Value *End = ConstantInt::get(Idx->getType(), 358 TrueRangeEnd-FirstTrueElement+1); 359 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End); 360 } 361 362 // False range check. 363 if (FalseRangeEnd != Overdefined) { 364 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare"); 365 Idx = MaskIdx(Idx); 366 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse). 367 if (FirstFalseElement) { 368 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement); 369 Idx = Builder.CreateAdd(Idx, Offs); 370 } 371 372 Value *End = ConstantInt::get(Idx->getType(), 373 FalseRangeEnd-FirstFalseElement); 374 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End); 375 } 376 377 // If a magic bitvector captures the entire comparison state 378 // of this load, replace it with computation that does: 379 // ((magic_cst >> i) & 1) != 0 380 { 381 Type *Ty = nullptr; 382 383 // Look for an appropriate type: 384 // - The type of Idx if the magic fits 385 // - The smallest fitting legal type 386 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth()) 387 Ty = Idx->getType(); 388 else 389 Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount); 390 391 if (Ty) { 392 Idx = MaskIdx(Idx); 393 Value *V = Builder.CreateIntCast(Idx, Ty, false); 394 V = Builder.CreateLShr(ConstantInt::get(Ty, MagicBitvector), V); 395 V = Builder.CreateAnd(ConstantInt::get(Ty, 1), V); 396 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0)); 397 } 398 } 399 400 return nullptr; 401 } 402 403 /// Return a value that can be used to compare the *offset* implied by a GEP to 404 /// zero. For example, if we have &A[i], we want to return 'i' for 405 /// "icmp ne i, 0". Note that, in general, indices can be complex, and scales 406 /// are involved. The above expression would also be legal to codegen as 407 /// "icmp ne (i*4), 0" (assuming A is a pointer to i32). 408 /// This latter form is less amenable to optimization though, and we are allowed 409 /// to generate the first by knowing that pointer arithmetic doesn't overflow. 410 /// 411 /// If we can't emit an optimized form for this expression, this returns null. 412 /// 413 static Value *evaluateGEPOffsetExpression(User *GEP, InstCombinerImpl &IC, 414 const DataLayout &DL) { 415 gep_type_iterator GTI = gep_type_begin(GEP); 416 417 // Check to see if this gep only has a single variable index. If so, and if 418 // any constant indices are a multiple of its scale, then we can compute this 419 // in terms of the scale of the variable index. For example, if the GEP 420 // implies an offset of "12 + i*4", then we can codegen this as "3 + i", 421 // because the expression will cross zero at the same point. 422 unsigned i, e = GEP->getNumOperands(); 423 int64_t Offset = 0; 424 for (i = 1; i != e; ++i, ++GTI) { 425 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) { 426 // Compute the aggregate offset of constant indices. 427 if (CI->isZero()) continue; 428 429 // Handle a struct index, which adds its field offset to the pointer. 430 if (StructType *STy = GTI.getStructTypeOrNull()) { 431 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue()); 432 } else { 433 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType()); 434 Offset += Size*CI->getSExtValue(); 435 } 436 } else { 437 // Found our variable index. 438 break; 439 } 440 } 441 442 // If there are no variable indices, we must have a constant offset, just 443 // evaluate it the general way. 444 if (i == e) return nullptr; 445 446 Value *VariableIdx = GEP->getOperand(i); 447 // Determine the scale factor of the variable element. For example, this is 448 // 4 if the variable index is into an array of i32. 449 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType()); 450 451 // Verify that there are no other variable indices. If so, emit the hard way. 452 for (++i, ++GTI; i != e; ++i, ++GTI) { 453 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i)); 454 if (!CI) return nullptr; 455 456 // Compute the aggregate offset of constant indices. 457 if (CI->isZero()) continue; 458 459 // Handle a struct index, which adds its field offset to the pointer. 460 if (StructType *STy = GTI.getStructTypeOrNull()) { 461 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue()); 462 } else { 463 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType()); 464 Offset += Size*CI->getSExtValue(); 465 } 466 } 467 468 // Okay, we know we have a single variable index, which must be a 469 // pointer/array/vector index. If there is no offset, life is simple, return 470 // the index. 471 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType()); 472 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth(); 473 if (Offset == 0) { 474 // Cast to intptrty in case a truncation occurs. If an extension is needed, 475 // we don't need to bother extending: the extension won't affect where the 476 // computation crosses zero. 477 if (VariableIdx->getType()->getPrimitiveSizeInBits().getFixedSize() > 478 IntPtrWidth) { 479 VariableIdx = IC.Builder.CreateTrunc(VariableIdx, IntPtrTy); 480 } 481 return VariableIdx; 482 } 483 484 // Otherwise, there is an index. The computation we will do will be modulo 485 // the pointer size. 486 Offset = SignExtend64(Offset, IntPtrWidth); 487 VariableScale = SignExtend64(VariableScale, IntPtrWidth); 488 489 // To do this transformation, any constant index must be a multiple of the 490 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i", 491 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a 492 // multiple of the variable scale. 493 int64_t NewOffs = Offset / (int64_t)VariableScale; 494 if (Offset != NewOffs*(int64_t)VariableScale) 495 return nullptr; 496 497 // Okay, we can do this evaluation. Start by converting the index to intptr. 498 if (VariableIdx->getType() != IntPtrTy) 499 VariableIdx = IC.Builder.CreateIntCast(VariableIdx, IntPtrTy, 500 true /*Signed*/); 501 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs); 502 return IC.Builder.CreateAdd(VariableIdx, OffsetVal, "offset"); 503 } 504 505 /// Returns true if we can rewrite Start as a GEP with pointer Base 506 /// and some integer offset. The nodes that need to be re-written 507 /// for this transformation will be added to Explored. 508 static bool canRewriteGEPAsOffset(Type *ElemTy, Value *Start, Value *Base, 509 const DataLayout &DL, 510 SetVector<Value *> &Explored) { 511 SmallVector<Value *, 16> WorkList(1, Start); 512 Explored.insert(Base); 513 514 // The following traversal gives us an order which can be used 515 // when doing the final transformation. Since in the final 516 // transformation we create the PHI replacement instructions first, 517 // we don't have to get them in any particular order. 518 // 519 // However, for other instructions we will have to traverse the 520 // operands of an instruction first, which means that we have to 521 // do a post-order traversal. 522 while (!WorkList.empty()) { 523 SetVector<PHINode *> PHIs; 524 525 while (!WorkList.empty()) { 526 if (Explored.size() >= 100) 527 return false; 528 529 Value *V = WorkList.back(); 530 531 if (Explored.contains(V)) { 532 WorkList.pop_back(); 533 continue; 534 } 535 536 if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) && 537 !isa<GetElementPtrInst>(V) && !isa<PHINode>(V)) 538 // We've found some value that we can't explore which is different from 539 // the base. Therefore we can't do this transformation. 540 return false; 541 542 if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) { 543 auto *CI = cast<CastInst>(V); 544 if (!CI->isNoopCast(DL)) 545 return false; 546 547 if (!Explored.contains(CI->getOperand(0))) 548 WorkList.push_back(CI->getOperand(0)); 549 } 550 551 if (auto *GEP = dyn_cast<GEPOperator>(V)) { 552 // We're limiting the GEP to having one index. This will preserve 553 // the original pointer type. We could handle more cases in the 554 // future. 555 if (GEP->getNumIndices() != 1 || !GEP->isInBounds() || 556 GEP->getSourceElementType() != ElemTy) 557 return false; 558 559 if (!Explored.contains(GEP->getOperand(0))) 560 WorkList.push_back(GEP->getOperand(0)); 561 } 562 563 if (WorkList.back() == V) { 564 WorkList.pop_back(); 565 // We've finished visiting this node, mark it as such. 566 Explored.insert(V); 567 } 568 569 if (auto *PN = dyn_cast<PHINode>(V)) { 570 // We cannot transform PHIs on unsplittable basic blocks. 571 if (isa<CatchSwitchInst>(PN->getParent()->getTerminator())) 572 return false; 573 Explored.insert(PN); 574 PHIs.insert(PN); 575 } 576 } 577 578 // Explore the PHI nodes further. 579 for (auto *PN : PHIs) 580 for (Value *Op : PN->incoming_values()) 581 if (!Explored.contains(Op)) 582 WorkList.push_back(Op); 583 } 584 585 // Make sure that we can do this. Since we can't insert GEPs in a basic 586 // block before a PHI node, we can't easily do this transformation if 587 // we have PHI node users of transformed instructions. 588 for (Value *Val : Explored) { 589 for (Value *Use : Val->uses()) { 590 591 auto *PHI = dyn_cast<PHINode>(Use); 592 auto *Inst = dyn_cast<Instruction>(Val); 593 594 if (Inst == Base || Inst == PHI || !Inst || !PHI || 595 !Explored.contains(PHI)) 596 continue; 597 598 if (PHI->getParent() == Inst->getParent()) 599 return false; 600 } 601 } 602 return true; 603 } 604 605 // Sets the appropriate insert point on Builder where we can add 606 // a replacement Instruction for V (if that is possible). 607 static void setInsertionPoint(IRBuilder<> &Builder, Value *V, 608 bool Before = true) { 609 if (auto *PHI = dyn_cast<PHINode>(V)) { 610 Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt()); 611 return; 612 } 613 if (auto *I = dyn_cast<Instruction>(V)) { 614 if (!Before) 615 I = &*std::next(I->getIterator()); 616 Builder.SetInsertPoint(I); 617 return; 618 } 619 if (auto *A = dyn_cast<Argument>(V)) { 620 // Set the insertion point in the entry block. 621 BasicBlock &Entry = A->getParent()->getEntryBlock(); 622 Builder.SetInsertPoint(&*Entry.getFirstInsertionPt()); 623 return; 624 } 625 // Otherwise, this is a constant and we don't need to set a new 626 // insertion point. 627 assert(isa<Constant>(V) && "Setting insertion point for unknown value!"); 628 } 629 630 /// Returns a re-written value of Start as an indexed GEP using Base as a 631 /// pointer. 632 static Value *rewriteGEPAsOffset(Type *ElemTy, Value *Start, Value *Base, 633 const DataLayout &DL, 634 SetVector<Value *> &Explored) { 635 // Perform all the substitutions. This is a bit tricky because we can 636 // have cycles in our use-def chains. 637 // 1. Create the PHI nodes without any incoming values. 638 // 2. Create all the other values. 639 // 3. Add the edges for the PHI nodes. 640 // 4. Emit GEPs to get the original pointers. 641 // 5. Remove the original instructions. 642 Type *IndexType = IntegerType::get( 643 Base->getContext(), DL.getIndexTypeSizeInBits(Start->getType())); 644 645 DenseMap<Value *, Value *> NewInsts; 646 NewInsts[Base] = ConstantInt::getNullValue(IndexType); 647 648 // Create the new PHI nodes, without adding any incoming values. 649 for (Value *Val : Explored) { 650 if (Val == Base) 651 continue; 652 // Create empty phi nodes. This avoids cyclic dependencies when creating 653 // the remaining instructions. 654 if (auto *PHI = dyn_cast<PHINode>(Val)) 655 NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(), 656 PHI->getName() + ".idx", PHI); 657 } 658 IRBuilder<> Builder(Base->getContext()); 659 660 // Create all the other instructions. 661 for (Value *Val : Explored) { 662 663 if (NewInsts.find(Val) != NewInsts.end()) 664 continue; 665 666 if (auto *CI = dyn_cast<CastInst>(Val)) { 667 // Don't get rid of the intermediate variable here; the store can grow 668 // the map which will invalidate the reference to the input value. 669 Value *V = NewInsts[CI->getOperand(0)]; 670 NewInsts[CI] = V; 671 continue; 672 } 673 if (auto *GEP = dyn_cast<GEPOperator>(Val)) { 674 Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)] 675 : GEP->getOperand(1); 676 setInsertionPoint(Builder, GEP); 677 // Indices might need to be sign extended. GEPs will magically do 678 // this, but we need to do it ourselves here. 679 if (Index->getType()->getScalarSizeInBits() != 680 NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) { 681 Index = Builder.CreateSExtOrTrunc( 682 Index, NewInsts[GEP->getOperand(0)]->getType(), 683 GEP->getOperand(0)->getName() + ".sext"); 684 } 685 686 auto *Op = NewInsts[GEP->getOperand(0)]; 687 if (isa<ConstantInt>(Op) && cast<ConstantInt>(Op)->isZero()) 688 NewInsts[GEP] = Index; 689 else 690 NewInsts[GEP] = Builder.CreateNSWAdd( 691 Op, Index, GEP->getOperand(0)->getName() + ".add"); 692 continue; 693 } 694 if (isa<PHINode>(Val)) 695 continue; 696 697 llvm_unreachable("Unexpected instruction type"); 698 } 699 700 // Add the incoming values to the PHI nodes. 701 for (Value *Val : Explored) { 702 if (Val == Base) 703 continue; 704 // All the instructions have been created, we can now add edges to the 705 // phi nodes. 706 if (auto *PHI = dyn_cast<PHINode>(Val)) { 707 PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]); 708 for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) { 709 Value *NewIncoming = PHI->getIncomingValue(I); 710 711 if (NewInsts.find(NewIncoming) != NewInsts.end()) 712 NewIncoming = NewInsts[NewIncoming]; 713 714 NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I)); 715 } 716 } 717 } 718 719 PointerType *PtrTy = 720 ElemTy->getPointerTo(Start->getType()->getPointerAddressSpace()); 721 for (Value *Val : Explored) { 722 if (Val == Base) 723 continue; 724 725 // Depending on the type, for external users we have to emit 726 // a GEP or a GEP + ptrtoint. 727 setInsertionPoint(Builder, Val, false); 728 729 // Cast base to the expected type. 730 Value *NewVal = Builder.CreateBitOrPointerCast( 731 Base, PtrTy, Start->getName() + "to.ptr"); 732 NewVal = Builder.CreateInBoundsGEP( 733 ElemTy, NewVal, makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr"); 734 NewVal = Builder.CreateBitOrPointerCast( 735 NewVal, Val->getType(), Val->getName() + ".conv"); 736 Val->replaceAllUsesWith(NewVal); 737 } 738 739 return NewInsts[Start]; 740 } 741 742 /// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express 743 /// the input Value as a constant indexed GEP. Returns a pair containing 744 /// the GEPs Pointer and Index. 745 static std::pair<Value *, Value *> 746 getAsConstantIndexedAddress(Type *ElemTy, Value *V, const DataLayout &DL) { 747 Type *IndexType = IntegerType::get(V->getContext(), 748 DL.getIndexTypeSizeInBits(V->getType())); 749 750 Constant *Index = ConstantInt::getNullValue(IndexType); 751 while (true) { 752 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) { 753 // We accept only inbouds GEPs here to exclude the possibility of 754 // overflow. 755 if (!GEP->isInBounds()) 756 break; 757 if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 && 758 GEP->getSourceElementType() == ElemTy) { 759 V = GEP->getOperand(0); 760 Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1)); 761 Index = ConstantExpr::getAdd( 762 Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType)); 763 continue; 764 } 765 break; 766 } 767 if (auto *CI = dyn_cast<IntToPtrInst>(V)) { 768 if (!CI->isNoopCast(DL)) 769 break; 770 V = CI->getOperand(0); 771 continue; 772 } 773 if (auto *CI = dyn_cast<PtrToIntInst>(V)) { 774 if (!CI->isNoopCast(DL)) 775 break; 776 V = CI->getOperand(0); 777 continue; 778 } 779 break; 780 } 781 return {V, Index}; 782 } 783 784 /// Converts (CMP GEPLHS, RHS) if this change would make RHS a constant. 785 /// We can look through PHIs, GEPs and casts in order to determine a common base 786 /// between GEPLHS and RHS. 787 static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS, 788 ICmpInst::Predicate Cond, 789 const DataLayout &DL) { 790 // FIXME: Support vector of pointers. 791 if (GEPLHS->getType()->isVectorTy()) 792 return nullptr; 793 794 if (!GEPLHS->hasAllConstantIndices()) 795 return nullptr; 796 797 Type *ElemTy = GEPLHS->getSourceElementType(); 798 Value *PtrBase, *Index; 799 std::tie(PtrBase, Index) = getAsConstantIndexedAddress(ElemTy, GEPLHS, DL); 800 801 // The set of nodes that will take part in this transformation. 802 SetVector<Value *> Nodes; 803 804 if (!canRewriteGEPAsOffset(ElemTy, RHS, PtrBase, DL, Nodes)) 805 return nullptr; 806 807 // We know we can re-write this as 808 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) 809 // Since we've only looked through inbouds GEPs we know that we 810 // can't have overflow on either side. We can therefore re-write 811 // this as: 812 // OFFSET1 cmp OFFSET2 813 Value *NewRHS = rewriteGEPAsOffset(ElemTy, RHS, PtrBase, DL, Nodes); 814 815 // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written 816 // GEP having PtrBase as the pointer base, and has returned in NewRHS the 817 // offset. Since Index is the offset of LHS to the base pointer, we will now 818 // compare the offsets instead of comparing the pointers. 819 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS); 820 } 821 822 /// Fold comparisons between a GEP instruction and something else. At this point 823 /// we know that the GEP is on the LHS of the comparison. 824 Instruction *InstCombinerImpl::foldGEPICmp(GEPOperator *GEPLHS, Value *RHS, 825 ICmpInst::Predicate Cond, 826 Instruction &I) { 827 // Don't transform signed compares of GEPs into index compares. Even if the 828 // GEP is inbounds, the final add of the base pointer can have signed overflow 829 // and would change the result of the icmp. 830 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be 831 // the maximum signed value for the pointer type. 832 if (ICmpInst::isSigned(Cond)) 833 return nullptr; 834 835 // Look through bitcasts and addrspacecasts. We do not however want to remove 836 // 0 GEPs. 837 if (!isa<GetElementPtrInst>(RHS)) 838 RHS = RHS->stripPointerCasts(); 839 840 Value *PtrBase = GEPLHS->getOperand(0); 841 // FIXME: Support vector pointer GEPs. 842 if (PtrBase == RHS && GEPLHS->isInBounds() && 843 !GEPLHS->getType()->isVectorTy()) { 844 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0). 845 // This transformation (ignoring the base and scales) is valid because we 846 // know pointers can't overflow since the gep is inbounds. See if we can 847 // output an optimized form. 848 Value *Offset = evaluateGEPOffsetExpression(GEPLHS, *this, DL); 849 850 // If not, synthesize the offset the hard way. 851 if (!Offset) 852 Offset = EmitGEPOffset(GEPLHS); 853 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset, 854 Constant::getNullValue(Offset->getType())); 855 } 856 857 if (GEPLHS->isInBounds() && ICmpInst::isEquality(Cond) && 858 isa<Constant>(RHS) && cast<Constant>(RHS)->isNullValue() && 859 !NullPointerIsDefined(I.getFunction(), 860 RHS->getType()->getPointerAddressSpace())) { 861 // For most address spaces, an allocation can't be placed at null, but null 862 // itself is treated as a 0 size allocation in the in bounds rules. Thus, 863 // the only valid inbounds address derived from null, is null itself. 864 // Thus, we have four cases to consider: 865 // 1) Base == nullptr, Offset == 0 -> inbounds, null 866 // 2) Base == nullptr, Offset != 0 -> poison as the result is out of bounds 867 // 3) Base != nullptr, Offset == (-base) -> poison (crossing allocations) 868 // 4) Base != nullptr, Offset != (-base) -> nonnull (and possibly poison) 869 // 870 // (Note if we're indexing a type of size 0, that simply collapses into one 871 // of the buckets above.) 872 // 873 // In general, we're allowed to make values less poison (i.e. remove 874 // sources of full UB), so in this case, we just select between the two 875 // non-poison cases (1 and 4 above). 876 // 877 // For vectors, we apply the same reasoning on a per-lane basis. 878 auto *Base = GEPLHS->getPointerOperand(); 879 if (GEPLHS->getType()->isVectorTy() && Base->getType()->isPointerTy()) { 880 auto EC = cast<VectorType>(GEPLHS->getType())->getElementCount(); 881 Base = Builder.CreateVectorSplat(EC, Base); 882 } 883 return new ICmpInst(Cond, Base, 884 ConstantExpr::getPointerBitCastOrAddrSpaceCast( 885 cast<Constant>(RHS), Base->getType())); 886 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) { 887 // If the base pointers are different, but the indices are the same, just 888 // compare the base pointer. 889 if (PtrBase != GEPRHS->getOperand(0)) { 890 bool IndicesTheSame = 891 GEPLHS->getNumOperands() == GEPRHS->getNumOperands() && 892 GEPLHS->getType() == GEPRHS->getType() && 893 GEPLHS->getSourceElementType() == GEPRHS->getSourceElementType(); 894 if (IndicesTheSame) 895 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i) 896 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) { 897 IndicesTheSame = false; 898 break; 899 } 900 901 // If all indices are the same, just compare the base pointers. 902 Type *BaseType = GEPLHS->getOperand(0)->getType(); 903 if (IndicesTheSame && CmpInst::makeCmpResultType(BaseType) == I.getType()) 904 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0)); 905 906 // If we're comparing GEPs with two base pointers that only differ in type 907 // and both GEPs have only constant indices or just one use, then fold 908 // the compare with the adjusted indices. 909 // FIXME: Support vector of pointers. 910 if (GEPLHS->isInBounds() && GEPRHS->isInBounds() && 911 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) && 912 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) && 913 PtrBase->stripPointerCasts() == 914 GEPRHS->getOperand(0)->stripPointerCasts() && 915 !GEPLHS->getType()->isVectorTy()) { 916 Value *LOffset = EmitGEPOffset(GEPLHS); 917 Value *ROffset = EmitGEPOffset(GEPRHS); 918 919 // If we looked through an addrspacecast between different sized address 920 // spaces, the LHS and RHS pointers are different sized 921 // integers. Truncate to the smaller one. 922 Type *LHSIndexTy = LOffset->getType(); 923 Type *RHSIndexTy = ROffset->getType(); 924 if (LHSIndexTy != RHSIndexTy) { 925 if (LHSIndexTy->getPrimitiveSizeInBits().getFixedSize() < 926 RHSIndexTy->getPrimitiveSizeInBits().getFixedSize()) { 927 ROffset = Builder.CreateTrunc(ROffset, LHSIndexTy); 928 } else 929 LOffset = Builder.CreateTrunc(LOffset, RHSIndexTy); 930 } 931 932 Value *Cmp = Builder.CreateICmp(ICmpInst::getSignedPredicate(Cond), 933 LOffset, ROffset); 934 return replaceInstUsesWith(I, Cmp); 935 } 936 937 // Otherwise, the base pointers are different and the indices are 938 // different. Try convert this to an indexed compare by looking through 939 // PHIs/casts. 940 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL); 941 } 942 943 // If one of the GEPs has all zero indices, recurse. 944 // FIXME: Handle vector of pointers. 945 if (!GEPLHS->getType()->isVectorTy() && GEPLHS->hasAllZeroIndices()) 946 return foldGEPICmp(GEPRHS, GEPLHS->getOperand(0), 947 ICmpInst::getSwappedPredicate(Cond), I); 948 949 // If the other GEP has all zero indices, recurse. 950 // FIXME: Handle vector of pointers. 951 if (!GEPRHS->getType()->isVectorTy() && GEPRHS->hasAllZeroIndices()) 952 return foldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I); 953 954 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds(); 955 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands() && 956 GEPLHS->getSourceElementType() == GEPRHS->getSourceElementType()) { 957 // If the GEPs only differ by one index, compare it. 958 unsigned NumDifferences = 0; // Keep track of # differences. 959 unsigned DiffOperand = 0; // The operand that differs. 960 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i) 961 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) { 962 Type *LHSType = GEPLHS->getOperand(i)->getType(); 963 Type *RHSType = GEPRHS->getOperand(i)->getType(); 964 // FIXME: Better support for vector of pointers. 965 if (LHSType->getPrimitiveSizeInBits() != 966 RHSType->getPrimitiveSizeInBits() || 967 (GEPLHS->getType()->isVectorTy() && 968 (!LHSType->isVectorTy() || !RHSType->isVectorTy()))) { 969 // Irreconcilable differences. 970 NumDifferences = 2; 971 break; 972 } 973 974 if (NumDifferences++) break; 975 DiffOperand = i; 976 } 977 978 if (NumDifferences == 0) // SAME GEP? 979 return replaceInstUsesWith(I, // No comparison is needed here. 980 ConstantInt::get(I.getType(), ICmpInst::isTrueWhenEqual(Cond))); 981 982 else if (NumDifferences == 1 && GEPsInBounds) { 983 Value *LHSV = GEPLHS->getOperand(DiffOperand); 984 Value *RHSV = GEPRHS->getOperand(DiffOperand); 985 // Make sure we do a signed comparison here. 986 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV); 987 } 988 } 989 990 // Only lower this if the icmp is the only user of the GEP or if we expect 991 // the result to fold to a constant! 992 if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) && 993 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) { 994 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2) 995 Value *L = EmitGEPOffset(GEPLHS); 996 Value *R = EmitGEPOffset(GEPRHS); 997 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R); 998 } 999 } 1000 1001 // Try convert this to an indexed compare by looking through PHIs/casts as a 1002 // last resort. 1003 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL); 1004 } 1005 1006 Instruction *InstCombinerImpl::foldAllocaCmp(ICmpInst &ICI, 1007 const AllocaInst *Alloca) { 1008 assert(ICI.isEquality() && "Cannot fold non-equality comparison."); 1009 1010 // It would be tempting to fold away comparisons between allocas and any 1011 // pointer not based on that alloca (e.g. an argument). However, even 1012 // though such pointers cannot alias, they can still compare equal. 1013 // 1014 // But LLVM doesn't specify where allocas get their memory, so if the alloca 1015 // doesn't escape we can argue that it's impossible to guess its value, and we 1016 // can therefore act as if any such guesses are wrong. 1017 // 1018 // The code below checks that the alloca doesn't escape, and that it's only 1019 // used in a comparison once (the current instruction). The 1020 // single-comparison-use condition ensures that we're trivially folding all 1021 // comparisons against the alloca consistently, and avoids the risk of 1022 // erroneously folding a comparison of the pointer with itself. 1023 1024 unsigned MaxIter = 32; // Break cycles and bound to constant-time. 1025 1026 SmallVector<const Use *, 32> Worklist; 1027 for (const Use &U : Alloca->uses()) { 1028 if (Worklist.size() >= MaxIter) 1029 return nullptr; 1030 Worklist.push_back(&U); 1031 } 1032 1033 unsigned NumCmps = 0; 1034 while (!Worklist.empty()) { 1035 assert(Worklist.size() <= MaxIter); 1036 const Use *U = Worklist.pop_back_val(); 1037 const Value *V = U->getUser(); 1038 --MaxIter; 1039 1040 if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) || 1041 isa<SelectInst>(V)) { 1042 // Track the uses. 1043 } else if (isa<LoadInst>(V)) { 1044 // Loading from the pointer doesn't escape it. 1045 continue; 1046 } else if (const auto *SI = dyn_cast<StoreInst>(V)) { 1047 // Storing *to* the pointer is fine, but storing the pointer escapes it. 1048 if (SI->getValueOperand() == U->get()) 1049 return nullptr; 1050 continue; 1051 } else if (isa<ICmpInst>(V)) { 1052 if (NumCmps++) 1053 return nullptr; // Found more than one cmp. 1054 continue; 1055 } else if (const auto *Intrin = dyn_cast<IntrinsicInst>(V)) { 1056 switch (Intrin->getIntrinsicID()) { 1057 // These intrinsics don't escape or compare the pointer. Memset is safe 1058 // because we don't allow ptrtoint. Memcpy and memmove are safe because 1059 // we don't allow stores, so src cannot point to V. 1060 case Intrinsic::lifetime_start: case Intrinsic::lifetime_end: 1061 case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset: 1062 continue; 1063 default: 1064 return nullptr; 1065 } 1066 } else { 1067 return nullptr; 1068 } 1069 for (const Use &U : V->uses()) { 1070 if (Worklist.size() >= MaxIter) 1071 return nullptr; 1072 Worklist.push_back(&U); 1073 } 1074 } 1075 1076 auto *Res = ConstantInt::get(ICI.getType(), 1077 !CmpInst::isTrueWhenEqual(ICI.getPredicate())); 1078 return replaceInstUsesWith(ICI, Res); 1079 } 1080 1081 /// Fold "icmp pred (X+C), X". 1082 Instruction *InstCombinerImpl::foldICmpAddOpConst(Value *X, const APInt &C, 1083 ICmpInst::Predicate Pred) { 1084 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0, 1085 // so the values can never be equal. Similarly for all other "or equals" 1086 // operators. 1087 assert(!!C && "C should not be zero!"); 1088 1089 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255 1090 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253 1091 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0 1092 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) { 1093 Constant *R = ConstantInt::get(X->getType(), 1094 APInt::getMaxValue(C.getBitWidth()) - C); 1095 return new ICmpInst(ICmpInst::ICMP_UGT, X, R); 1096 } 1097 1098 // (X+1) >u X --> X <u (0-1) --> X != 255 1099 // (X+2) >u X --> X <u (0-2) --> X <u 254 1100 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0 1101 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE) 1102 return new ICmpInst(ICmpInst::ICMP_ULT, X, 1103 ConstantInt::get(X->getType(), -C)); 1104 1105 APInt SMax = APInt::getSignedMaxValue(C.getBitWidth()); 1106 1107 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127 1108 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125 1109 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0 1110 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1 1111 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126 1112 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127 1113 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) 1114 return new ICmpInst(ICmpInst::ICMP_SGT, X, 1115 ConstantInt::get(X->getType(), SMax - C)); 1116 1117 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127 1118 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126 1119 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1 1120 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2 1121 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126 1122 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128 1123 1124 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE); 1125 return new ICmpInst(ICmpInst::ICMP_SLT, X, 1126 ConstantInt::get(X->getType(), SMax - (C - 1))); 1127 } 1128 1129 /// Handle "(icmp eq/ne (ashr/lshr AP2, A), AP1)" -> 1130 /// (icmp eq/ne A, Log2(AP2/AP1)) -> 1131 /// (icmp eq/ne A, Log2(AP2) - Log2(AP1)). 1132 Instruction *InstCombinerImpl::foldICmpShrConstConst(ICmpInst &I, Value *A, 1133 const APInt &AP1, 1134 const APInt &AP2) { 1135 assert(I.isEquality() && "Cannot fold icmp gt/lt"); 1136 1137 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) { 1138 if (I.getPredicate() == I.ICMP_NE) 1139 Pred = CmpInst::getInversePredicate(Pred); 1140 return new ICmpInst(Pred, LHS, RHS); 1141 }; 1142 1143 // Don't bother doing any work for cases which InstSimplify handles. 1144 if (AP2.isZero()) 1145 return nullptr; 1146 1147 bool IsAShr = isa<AShrOperator>(I.getOperand(0)); 1148 if (IsAShr) { 1149 if (AP2.isAllOnes()) 1150 return nullptr; 1151 if (AP2.isNegative() != AP1.isNegative()) 1152 return nullptr; 1153 if (AP2.sgt(AP1)) 1154 return nullptr; 1155 } 1156 1157 if (!AP1) 1158 // 'A' must be large enough to shift out the highest set bit. 1159 return getICmp(I.ICMP_UGT, A, 1160 ConstantInt::get(A->getType(), AP2.logBase2())); 1161 1162 if (AP1 == AP2) 1163 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType())); 1164 1165 int Shift; 1166 if (IsAShr && AP1.isNegative()) 1167 Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes(); 1168 else 1169 Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros(); 1170 1171 if (Shift > 0) { 1172 if (IsAShr && AP1 == AP2.ashr(Shift)) { 1173 // There are multiple solutions if we are comparing against -1 and the LHS 1174 // of the ashr is not a power of two. 1175 if (AP1.isAllOnes() && !AP2.isPowerOf2()) 1176 return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift)); 1177 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift)); 1178 } else if (AP1 == AP2.lshr(Shift)) { 1179 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift)); 1180 } 1181 } 1182 1183 // Shifting const2 will never be equal to const1. 1184 // FIXME: This should always be handled by InstSimplify? 1185 auto *TorF = ConstantInt::get(I.getType(), I.getPredicate() == I.ICMP_NE); 1186 return replaceInstUsesWith(I, TorF); 1187 } 1188 1189 /// Handle "(icmp eq/ne (shl AP2, A), AP1)" -> 1190 /// (icmp eq/ne A, TrailingZeros(AP1) - TrailingZeros(AP2)). 1191 Instruction *InstCombinerImpl::foldICmpShlConstConst(ICmpInst &I, Value *A, 1192 const APInt &AP1, 1193 const APInt &AP2) { 1194 assert(I.isEquality() && "Cannot fold icmp gt/lt"); 1195 1196 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) { 1197 if (I.getPredicate() == I.ICMP_NE) 1198 Pred = CmpInst::getInversePredicate(Pred); 1199 return new ICmpInst(Pred, LHS, RHS); 1200 }; 1201 1202 // Don't bother doing any work for cases which InstSimplify handles. 1203 if (AP2.isZero()) 1204 return nullptr; 1205 1206 unsigned AP2TrailingZeros = AP2.countTrailingZeros(); 1207 1208 if (!AP1 && AP2TrailingZeros != 0) 1209 return getICmp( 1210 I.ICMP_UGE, A, 1211 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros)); 1212 1213 if (AP1 == AP2) 1214 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType())); 1215 1216 // Get the distance between the lowest bits that are set. 1217 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros; 1218 1219 if (Shift > 0 && AP2.shl(Shift) == AP1) 1220 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift)); 1221 1222 // Shifting const2 will never be equal to const1. 1223 // FIXME: This should always be handled by InstSimplify? 1224 auto *TorF = ConstantInt::get(I.getType(), I.getPredicate() == I.ICMP_NE); 1225 return replaceInstUsesWith(I, TorF); 1226 } 1227 1228 /// The caller has matched a pattern of the form: 1229 /// I = icmp ugt (add (add A, B), CI2), CI1 1230 /// If this is of the form: 1231 /// sum = a + b 1232 /// if (sum+128 >u 255) 1233 /// Then replace it with llvm.sadd.with.overflow.i8. 1234 /// 1235 static Instruction *processUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B, 1236 ConstantInt *CI2, ConstantInt *CI1, 1237 InstCombinerImpl &IC) { 1238 // The transformation we're trying to do here is to transform this into an 1239 // llvm.sadd.with.overflow. To do this, we have to replace the original add 1240 // with a narrower add, and discard the add-with-constant that is part of the 1241 // range check (if we can't eliminate it, this isn't profitable). 1242 1243 // In order to eliminate the add-with-constant, the compare can be its only 1244 // use. 1245 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0)); 1246 if (!AddWithCst->hasOneUse()) 1247 return nullptr; 1248 1249 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow. 1250 if (!CI2->getValue().isPowerOf2()) 1251 return nullptr; 1252 unsigned NewWidth = CI2->getValue().countTrailingZeros(); 1253 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) 1254 return nullptr; 1255 1256 // The width of the new add formed is 1 more than the bias. 1257 ++NewWidth; 1258 1259 // Check to see that CI1 is an all-ones value with NewWidth bits. 1260 if (CI1->getBitWidth() == NewWidth || 1261 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth)) 1262 return nullptr; 1263 1264 // This is only really a signed overflow check if the inputs have been 1265 // sign-extended; check for that condition. For example, if CI2 is 2^31 and 1266 // the operands of the add are 64 bits wide, we need at least 33 sign bits. 1267 if (IC.ComputeMaxSignificantBits(A, 0, &I) > NewWidth || 1268 IC.ComputeMaxSignificantBits(B, 0, &I) > NewWidth) 1269 return nullptr; 1270 1271 // In order to replace the original add with a narrower 1272 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant 1273 // and truncates that discard the high bits of the add. Verify that this is 1274 // the case. 1275 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0)); 1276 for (User *U : OrigAdd->users()) { 1277 if (U == AddWithCst) 1278 continue; 1279 1280 // Only accept truncates for now. We would really like a nice recursive 1281 // predicate like SimplifyDemandedBits, but which goes downwards the use-def 1282 // chain to see which bits of a value are actually demanded. If the 1283 // original add had another add which was then immediately truncated, we 1284 // could still do the transformation. 1285 TruncInst *TI = dyn_cast<TruncInst>(U); 1286 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth) 1287 return nullptr; 1288 } 1289 1290 // If the pattern matches, truncate the inputs to the narrower type and 1291 // use the sadd_with_overflow intrinsic to efficiently compute both the 1292 // result and the overflow bit. 1293 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth); 1294 Function *F = Intrinsic::getDeclaration( 1295 I.getModule(), Intrinsic::sadd_with_overflow, NewType); 1296 1297 InstCombiner::BuilderTy &Builder = IC.Builder; 1298 1299 // Put the new code above the original add, in case there are any uses of the 1300 // add between the add and the compare. 1301 Builder.SetInsertPoint(OrigAdd); 1302 1303 Value *TruncA = Builder.CreateTrunc(A, NewType, A->getName() + ".trunc"); 1304 Value *TruncB = Builder.CreateTrunc(B, NewType, B->getName() + ".trunc"); 1305 CallInst *Call = Builder.CreateCall(F, {TruncA, TruncB}, "sadd"); 1306 Value *Add = Builder.CreateExtractValue(Call, 0, "sadd.result"); 1307 Value *ZExt = Builder.CreateZExt(Add, OrigAdd->getType()); 1308 1309 // The inner add was the result of the narrow add, zero extended to the 1310 // wider type. Replace it with the result computed by the intrinsic. 1311 IC.replaceInstUsesWith(*OrigAdd, ZExt); 1312 IC.eraseInstFromFunction(*OrigAdd); 1313 1314 // The original icmp gets replaced with the overflow value. 1315 return ExtractValueInst::Create(Call, 1, "sadd.overflow"); 1316 } 1317 1318 /// If we have: 1319 /// icmp eq/ne (urem/srem %x, %y), 0 1320 /// iff %y is a power-of-two, we can replace this with a bit test: 1321 /// icmp eq/ne (and %x, (add %y, -1)), 0 1322 Instruction *InstCombinerImpl::foldIRemByPowerOfTwoToBitTest(ICmpInst &I) { 1323 // This fold is only valid for equality predicates. 1324 if (!I.isEquality()) 1325 return nullptr; 1326 ICmpInst::Predicate Pred; 1327 Value *X, *Y, *Zero; 1328 if (!match(&I, m_ICmp(Pred, m_OneUse(m_IRem(m_Value(X), m_Value(Y))), 1329 m_CombineAnd(m_Zero(), m_Value(Zero))))) 1330 return nullptr; 1331 if (!isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, 0, &I)) 1332 return nullptr; 1333 // This may increase instruction count, we don't enforce that Y is a constant. 1334 Value *Mask = Builder.CreateAdd(Y, Constant::getAllOnesValue(Y->getType())); 1335 Value *Masked = Builder.CreateAnd(X, Mask); 1336 return ICmpInst::Create(Instruction::ICmp, Pred, Masked, Zero); 1337 } 1338 1339 /// Fold equality-comparison between zero and any (maybe truncated) right-shift 1340 /// by one-less-than-bitwidth into a sign test on the original value. 1341 Instruction *InstCombinerImpl::foldSignBitTest(ICmpInst &I) { 1342 Instruction *Val; 1343 ICmpInst::Predicate Pred; 1344 if (!I.isEquality() || !match(&I, m_ICmp(Pred, m_Instruction(Val), m_Zero()))) 1345 return nullptr; 1346 1347 Value *X; 1348 Type *XTy; 1349 1350 Constant *C; 1351 if (match(Val, m_TruncOrSelf(m_Shr(m_Value(X), m_Constant(C))))) { 1352 XTy = X->getType(); 1353 unsigned XBitWidth = XTy->getScalarSizeInBits(); 1354 if (!match(C, m_SpecificInt_ICMP(ICmpInst::Predicate::ICMP_EQ, 1355 APInt(XBitWidth, XBitWidth - 1)))) 1356 return nullptr; 1357 } else if (isa<BinaryOperator>(Val) && 1358 (X = reassociateShiftAmtsOfTwoSameDirectionShifts( 1359 cast<BinaryOperator>(Val), SQ.getWithInstruction(Val), 1360 /*AnalyzeForSignBitExtraction=*/true))) { 1361 XTy = X->getType(); 1362 } else 1363 return nullptr; 1364 1365 return ICmpInst::Create(Instruction::ICmp, 1366 Pred == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_SGE 1367 : ICmpInst::ICMP_SLT, 1368 X, ConstantInt::getNullValue(XTy)); 1369 } 1370 1371 // Handle icmp pred X, 0 1372 Instruction *InstCombinerImpl::foldICmpWithZero(ICmpInst &Cmp) { 1373 CmpInst::Predicate Pred = Cmp.getPredicate(); 1374 if (!match(Cmp.getOperand(1), m_Zero())) 1375 return nullptr; 1376 1377 // (icmp sgt smin(PosA, B) 0) -> (icmp sgt B 0) 1378 if (Pred == ICmpInst::ICMP_SGT) { 1379 Value *A, *B; 1380 if (match(Cmp.getOperand(0), m_SMin(m_Value(A), m_Value(B)))) { 1381 if (isKnownPositive(A, DL, 0, &AC, &Cmp, &DT)) 1382 return new ICmpInst(Pred, B, Cmp.getOperand(1)); 1383 if (isKnownPositive(B, DL, 0, &AC, &Cmp, &DT)) 1384 return new ICmpInst(Pred, A, Cmp.getOperand(1)); 1385 } 1386 } 1387 1388 if (Instruction *New = foldIRemByPowerOfTwoToBitTest(Cmp)) 1389 return New; 1390 1391 // Given: 1392 // icmp eq/ne (urem %x, %y), 0 1393 // Iff %x has 0 or 1 bits set, and %y has at least 2 bits set, omit 'urem': 1394 // icmp eq/ne %x, 0 1395 Value *X, *Y; 1396 if (match(Cmp.getOperand(0), m_URem(m_Value(X), m_Value(Y))) && 1397 ICmpInst::isEquality(Pred)) { 1398 KnownBits XKnown = computeKnownBits(X, 0, &Cmp); 1399 KnownBits YKnown = computeKnownBits(Y, 0, &Cmp); 1400 if (XKnown.countMaxPopulation() == 1 && YKnown.countMinPopulation() >= 2) 1401 return new ICmpInst(Pred, X, Cmp.getOperand(1)); 1402 } 1403 1404 return nullptr; 1405 } 1406 1407 /// Fold icmp Pred X, C. 1408 /// TODO: This code structure does not make sense. The saturating add fold 1409 /// should be moved to some other helper and extended as noted below (it is also 1410 /// possible that code has been made unnecessary - do we canonicalize IR to 1411 /// overflow/saturating intrinsics or not?). 1412 Instruction *InstCombinerImpl::foldICmpWithConstant(ICmpInst &Cmp) { 1413 // Match the following pattern, which is a common idiom when writing 1414 // overflow-safe integer arithmetic functions. The source performs an addition 1415 // in wider type and explicitly checks for overflow using comparisons against 1416 // INT_MIN and INT_MAX. Simplify by using the sadd_with_overflow intrinsic. 1417 // 1418 // TODO: This could probably be generalized to handle other overflow-safe 1419 // operations if we worked out the formulas to compute the appropriate magic 1420 // constants. 1421 // 1422 // sum = a + b 1423 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8 1424 CmpInst::Predicate Pred = Cmp.getPredicate(); 1425 Value *Op0 = Cmp.getOperand(0), *Op1 = Cmp.getOperand(1); 1426 Value *A, *B; 1427 ConstantInt *CI, *CI2; // I = icmp ugt (add (add A, B), CI2), CI 1428 if (Pred == ICmpInst::ICMP_UGT && match(Op1, m_ConstantInt(CI)) && 1429 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2)))) 1430 if (Instruction *Res = processUGT_ADDCST_ADD(Cmp, A, B, CI2, CI, *this)) 1431 return Res; 1432 1433 // icmp(phi(C1, C2, ...), C) -> phi(icmp(C1, C), icmp(C2, C), ...). 1434 Constant *C = dyn_cast<Constant>(Op1); 1435 if (!C || C->canTrap()) 1436 return nullptr; 1437 1438 if (auto *Phi = dyn_cast<PHINode>(Op0)) 1439 if (all_of(Phi->operands(), [](Value *V) { return isa<Constant>(V); })) { 1440 Type *Ty = Cmp.getType(); 1441 Builder.SetInsertPoint(Phi); 1442 PHINode *NewPhi = 1443 Builder.CreatePHI(Ty, Phi->getNumOperands()); 1444 for (BasicBlock *Predecessor : predecessors(Phi->getParent())) { 1445 auto *Input = 1446 cast<Constant>(Phi->getIncomingValueForBlock(Predecessor)); 1447 auto *BoolInput = ConstantExpr::getCompare(Pred, Input, C); 1448 NewPhi->addIncoming(BoolInput, Predecessor); 1449 } 1450 NewPhi->takeName(&Cmp); 1451 return replaceInstUsesWith(Cmp, NewPhi); 1452 } 1453 1454 return nullptr; 1455 } 1456 1457 /// Canonicalize icmp instructions based on dominating conditions. 1458 Instruction *InstCombinerImpl::foldICmpWithDominatingICmp(ICmpInst &Cmp) { 1459 // This is a cheap/incomplete check for dominance - just match a single 1460 // predecessor with a conditional branch. 1461 BasicBlock *CmpBB = Cmp.getParent(); 1462 BasicBlock *DomBB = CmpBB->getSinglePredecessor(); 1463 if (!DomBB) 1464 return nullptr; 1465 1466 Value *DomCond; 1467 BasicBlock *TrueBB, *FalseBB; 1468 if (!match(DomBB->getTerminator(), m_Br(m_Value(DomCond), TrueBB, FalseBB))) 1469 return nullptr; 1470 1471 assert((TrueBB == CmpBB || FalseBB == CmpBB) && 1472 "Predecessor block does not point to successor?"); 1473 1474 // The branch should get simplified. Don't bother simplifying this condition. 1475 if (TrueBB == FalseBB) 1476 return nullptr; 1477 1478 // Try to simplify this compare to T/F based on the dominating condition. 1479 Optional<bool> Imp = isImpliedCondition(DomCond, &Cmp, DL, TrueBB == CmpBB); 1480 if (Imp) 1481 return replaceInstUsesWith(Cmp, ConstantInt::get(Cmp.getType(), *Imp)); 1482 1483 CmpInst::Predicate Pred = Cmp.getPredicate(); 1484 Value *X = Cmp.getOperand(0), *Y = Cmp.getOperand(1); 1485 ICmpInst::Predicate DomPred; 1486 const APInt *C, *DomC; 1487 if (match(DomCond, m_ICmp(DomPred, m_Specific(X), m_APInt(DomC))) && 1488 match(Y, m_APInt(C))) { 1489 // We have 2 compares of a variable with constants. Calculate the constant 1490 // ranges of those compares to see if we can transform the 2nd compare: 1491 // DomBB: 1492 // DomCond = icmp DomPred X, DomC 1493 // br DomCond, CmpBB, FalseBB 1494 // CmpBB: 1495 // Cmp = icmp Pred X, C 1496 ConstantRange CR = ConstantRange::makeExactICmpRegion(Pred, *C); 1497 ConstantRange DominatingCR = 1498 (CmpBB == TrueBB) ? ConstantRange::makeExactICmpRegion(DomPred, *DomC) 1499 : ConstantRange::makeExactICmpRegion( 1500 CmpInst::getInversePredicate(DomPred), *DomC); 1501 ConstantRange Intersection = DominatingCR.intersectWith(CR); 1502 ConstantRange Difference = DominatingCR.difference(CR); 1503 if (Intersection.isEmptySet()) 1504 return replaceInstUsesWith(Cmp, Builder.getFalse()); 1505 if (Difference.isEmptySet()) 1506 return replaceInstUsesWith(Cmp, Builder.getTrue()); 1507 1508 // Canonicalizing a sign bit comparison that gets used in a branch, 1509 // pessimizes codegen by generating branch on zero instruction instead 1510 // of a test and branch. So we avoid canonicalizing in such situations 1511 // because test and branch instruction has better branch displacement 1512 // than compare and branch instruction. 1513 bool UnusedBit; 1514 bool IsSignBit = isSignBitCheck(Pred, *C, UnusedBit); 1515 if (Cmp.isEquality() || (IsSignBit && hasBranchUse(Cmp))) 1516 return nullptr; 1517 1518 // Avoid an infinite loop with min/max canonicalization. 1519 // TODO: This will be unnecessary if we canonicalize to min/max intrinsics. 1520 if (Cmp.hasOneUse() && 1521 match(Cmp.user_back(), m_MaxOrMin(m_Value(), m_Value()))) 1522 return nullptr; 1523 1524 if (const APInt *EqC = Intersection.getSingleElement()) 1525 return new ICmpInst(ICmpInst::ICMP_EQ, X, Builder.getInt(*EqC)); 1526 if (const APInt *NeC = Difference.getSingleElement()) 1527 return new ICmpInst(ICmpInst::ICMP_NE, X, Builder.getInt(*NeC)); 1528 } 1529 1530 return nullptr; 1531 } 1532 1533 /// Fold icmp (trunc X, Y), C. 1534 Instruction *InstCombinerImpl::foldICmpTruncConstant(ICmpInst &Cmp, 1535 TruncInst *Trunc, 1536 const APInt &C) { 1537 ICmpInst::Predicate Pred = Cmp.getPredicate(); 1538 Value *X = Trunc->getOperand(0); 1539 if (C.isOne() && C.getBitWidth() > 1) { 1540 // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1 1541 Value *V = nullptr; 1542 if (Pred == ICmpInst::ICMP_SLT && match(X, m_Signum(m_Value(V)))) 1543 return new ICmpInst(ICmpInst::ICMP_SLT, V, 1544 ConstantInt::get(V->getType(), 1)); 1545 } 1546 1547 unsigned DstBits = Trunc->getType()->getScalarSizeInBits(), 1548 SrcBits = X->getType()->getScalarSizeInBits(); 1549 if (Cmp.isEquality() && Trunc->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 KnownBits Known = computeKnownBits(X, 0, &Cmp); 1553 1554 // If all the high bits are known, we can do this xform. 1555 if ((Known.Zero | Known.One).countLeadingOnes() >= SrcBits - DstBits) { 1556 // Pull in the high bits from known-ones set. 1557 APInt NewRHS = C.zext(SrcBits); 1558 NewRHS |= Known.One & APInt::getHighBitsSet(SrcBits, SrcBits - DstBits); 1559 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), NewRHS)); 1560 } 1561 } 1562 1563 // Look through truncated right-shift of the sign-bit for a sign-bit check: 1564 // trunc iN (ShOp >> ShAmtC) to i[N - ShAmtC] < 0 --> ShOp < 0 1565 // trunc iN (ShOp >> ShAmtC) to i[N - ShAmtC] > -1 --> ShOp > -1 1566 Value *ShOp; 1567 const APInt *ShAmtC; 1568 bool TrueIfSigned; 1569 if (isSignBitCheck(Pred, C, TrueIfSigned) && 1570 match(X, m_Shr(m_Value(ShOp), m_APInt(ShAmtC))) && 1571 DstBits == SrcBits - ShAmtC->getZExtValue()) { 1572 return TrueIfSigned 1573 ? new ICmpInst(ICmpInst::ICMP_SLT, ShOp, 1574 ConstantInt::getNullValue(X->getType())) 1575 : new ICmpInst(ICmpInst::ICMP_SGT, ShOp, 1576 ConstantInt::getAllOnesValue(X->getType())); 1577 } 1578 1579 return nullptr; 1580 } 1581 1582 /// Fold icmp (xor X, Y), C. 1583 Instruction *InstCombinerImpl::foldICmpXorConstant(ICmpInst &Cmp, 1584 BinaryOperator *Xor, 1585 const APInt &C) { 1586 Value *X = Xor->getOperand(0); 1587 Value *Y = Xor->getOperand(1); 1588 const APInt *XorC; 1589 if (!match(Y, m_APInt(XorC))) 1590 return nullptr; 1591 1592 // If this is a comparison that tests the signbit (X < 0) or (x > -1), 1593 // fold the xor. 1594 ICmpInst::Predicate Pred = Cmp.getPredicate(); 1595 bool TrueIfSigned = false; 1596 if (isSignBitCheck(Cmp.getPredicate(), C, TrueIfSigned)) { 1597 1598 // If the sign bit of the XorCst is not set, there is no change to 1599 // the operation, just stop using the Xor. 1600 if (!XorC->isNegative()) 1601 return replaceOperand(Cmp, 0, X); 1602 1603 // Emit the opposite comparison. 1604 if (TrueIfSigned) 1605 return new ICmpInst(ICmpInst::ICMP_SGT, X, 1606 ConstantInt::getAllOnesValue(X->getType())); 1607 else 1608 return new ICmpInst(ICmpInst::ICMP_SLT, X, 1609 ConstantInt::getNullValue(X->getType())); 1610 } 1611 1612 if (Xor->hasOneUse()) { 1613 // (icmp u/s (xor X SignMask), C) -> (icmp s/u X, (xor C SignMask)) 1614 if (!Cmp.isEquality() && XorC->isSignMask()) { 1615 Pred = Cmp.getFlippedSignednessPredicate(); 1616 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), C ^ *XorC)); 1617 } 1618 1619 // (icmp u/s (xor X ~SignMask), C) -> (icmp s/u X, (xor C ~SignMask)) 1620 if (!Cmp.isEquality() && XorC->isMaxSignedValue()) { 1621 Pred = Cmp.getFlippedSignednessPredicate(); 1622 Pred = Cmp.getSwappedPredicate(Pred); 1623 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), C ^ *XorC)); 1624 } 1625 } 1626 1627 // Mask constant magic can eliminate an 'xor' with unsigned compares. 1628 if (Pred == ICmpInst::ICMP_UGT) { 1629 // (xor X, ~C) >u C --> X <u ~C (when C+1 is a power of 2) 1630 if (*XorC == ~C && (C + 1).isPowerOf2()) 1631 return new ICmpInst(ICmpInst::ICMP_ULT, X, Y); 1632 // (xor X, C) >u C --> X >u C (when C+1 is a power of 2) 1633 if (*XorC == C && (C + 1).isPowerOf2()) 1634 return new ICmpInst(ICmpInst::ICMP_UGT, X, Y); 1635 } 1636 if (Pred == ICmpInst::ICMP_ULT) { 1637 // (xor X, -C) <u C --> X >u ~C (when C is a power of 2) 1638 if (*XorC == -C && C.isPowerOf2()) 1639 return new ICmpInst(ICmpInst::ICMP_UGT, X, 1640 ConstantInt::get(X->getType(), ~C)); 1641 // (xor X, C) <u C --> X >u ~C (when -C is a power of 2) 1642 if (*XorC == C && (-C).isPowerOf2()) 1643 return new ICmpInst(ICmpInst::ICMP_UGT, X, 1644 ConstantInt::get(X->getType(), ~C)); 1645 } 1646 return nullptr; 1647 } 1648 1649 /// Fold icmp (and (sh X, Y), C2), C1. 1650 Instruction *InstCombinerImpl::foldICmpAndShift(ICmpInst &Cmp, 1651 BinaryOperator *And, 1652 const APInt &C1, 1653 const APInt &C2) { 1654 BinaryOperator *Shift = dyn_cast<BinaryOperator>(And->getOperand(0)); 1655 if (!Shift || !Shift->isShift()) 1656 return nullptr; 1657 1658 // If this is: (X >> C3) & C2 != C1 (where any shift and any compare could 1659 // exist), turn it into (X & (C2 << C3)) != (C1 << C3). This happens a LOT in 1660 // code produced by the clang front-end, for bitfield access. 1661 // This seemingly simple opportunity to fold away a shift turns out to be 1662 // rather complicated. See PR17827 for details. 1663 unsigned ShiftOpcode = Shift->getOpcode(); 1664 bool IsShl = ShiftOpcode == Instruction::Shl; 1665 const APInt *C3; 1666 if (match(Shift->getOperand(1), m_APInt(C3))) { 1667 APInt NewAndCst, NewCmpCst; 1668 bool AnyCmpCstBitsShiftedOut; 1669 if (ShiftOpcode == Instruction::Shl) { 1670 // For a left shift, we can fold if the comparison is not signed. We can 1671 // also fold a signed comparison if the mask value and comparison value 1672 // are not negative. These constraints may not be obvious, but we can 1673 // prove that they are correct using an SMT solver. 1674 if (Cmp.isSigned() && (C2.isNegative() || C1.isNegative())) 1675 return nullptr; 1676 1677 NewCmpCst = C1.lshr(*C3); 1678 NewAndCst = C2.lshr(*C3); 1679 AnyCmpCstBitsShiftedOut = NewCmpCst.shl(*C3) != C1; 1680 } else if (ShiftOpcode == Instruction::LShr) { 1681 // For a logical right shift, we can fold if the comparison is not signed. 1682 // We can also fold a signed comparison if the shifted mask value and the 1683 // shifted comparison value are not negative. These constraints may not be 1684 // obvious, but we can prove that they are correct using an SMT solver. 1685 NewCmpCst = C1.shl(*C3); 1686 NewAndCst = C2.shl(*C3); 1687 AnyCmpCstBitsShiftedOut = NewCmpCst.lshr(*C3) != C1; 1688 if (Cmp.isSigned() && (NewAndCst.isNegative() || NewCmpCst.isNegative())) 1689 return nullptr; 1690 } else { 1691 // For an arithmetic shift, check that both constants don't use (in a 1692 // signed sense) the top bits being shifted out. 1693 assert(ShiftOpcode == Instruction::AShr && "Unknown shift opcode"); 1694 NewCmpCst = C1.shl(*C3); 1695 NewAndCst = C2.shl(*C3); 1696 AnyCmpCstBitsShiftedOut = NewCmpCst.ashr(*C3) != C1; 1697 if (NewAndCst.ashr(*C3) != C2) 1698 return nullptr; 1699 } 1700 1701 if (AnyCmpCstBitsShiftedOut) { 1702 // If we shifted bits out, the fold is not going to work out. As a 1703 // special case, check to see if this means that the result is always 1704 // true or false now. 1705 if (Cmp.getPredicate() == ICmpInst::ICMP_EQ) 1706 return replaceInstUsesWith(Cmp, ConstantInt::getFalse(Cmp.getType())); 1707 if (Cmp.getPredicate() == ICmpInst::ICMP_NE) 1708 return replaceInstUsesWith(Cmp, ConstantInt::getTrue(Cmp.getType())); 1709 } else { 1710 Value *NewAnd = Builder.CreateAnd( 1711 Shift->getOperand(0), ConstantInt::get(And->getType(), NewAndCst)); 1712 return new ICmpInst(Cmp.getPredicate(), 1713 NewAnd, ConstantInt::get(And->getType(), NewCmpCst)); 1714 } 1715 } 1716 1717 // Turn ((X >> Y) & C2) == 0 into (X & (C2 << Y)) == 0. The latter is 1718 // preferable because it allows the C2 << Y expression to be hoisted out of a 1719 // loop if Y is invariant and X is not. 1720 if (Shift->hasOneUse() && C1.isZero() && Cmp.isEquality() && 1721 !Shift->isArithmeticShift() && !isa<Constant>(Shift->getOperand(0))) { 1722 // Compute C2 << Y. 1723 Value *NewShift = 1724 IsShl ? Builder.CreateLShr(And->getOperand(1), Shift->getOperand(1)) 1725 : Builder.CreateShl(And->getOperand(1), Shift->getOperand(1)); 1726 1727 // Compute X & (C2 << Y). 1728 Value *NewAnd = Builder.CreateAnd(Shift->getOperand(0), NewShift); 1729 return replaceOperand(Cmp, 0, NewAnd); 1730 } 1731 1732 return nullptr; 1733 } 1734 1735 /// Fold icmp (and X, C2), C1. 1736 Instruction *InstCombinerImpl::foldICmpAndConstConst(ICmpInst &Cmp, 1737 BinaryOperator *And, 1738 const APInt &C1) { 1739 bool isICMP_NE = Cmp.getPredicate() == ICmpInst::ICMP_NE; 1740 1741 // For vectors: icmp ne (and X, 1), 0 --> trunc X to N x i1 1742 // TODO: We canonicalize to the longer form for scalars because we have 1743 // better analysis/folds for icmp, and codegen may be better with icmp. 1744 if (isICMP_NE && Cmp.getType()->isVectorTy() && C1.isZero() && 1745 match(And->getOperand(1), m_One())) 1746 return new TruncInst(And->getOperand(0), Cmp.getType()); 1747 1748 const APInt *C2; 1749 Value *X; 1750 if (!match(And, m_And(m_Value(X), m_APInt(C2)))) 1751 return nullptr; 1752 1753 // Don't perform the following transforms if the AND has multiple uses 1754 if (!And->hasOneUse()) 1755 return nullptr; 1756 1757 if (Cmp.isEquality() && C1.isZero()) { 1758 // Restrict this fold to single-use 'and' (PR10267). 1759 // Replace (and X, (1 << size(X)-1) != 0) with X s< 0 1760 if (C2->isSignMask()) { 1761 Constant *Zero = Constant::getNullValue(X->getType()); 1762 auto NewPred = isICMP_NE ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE; 1763 return new ICmpInst(NewPred, X, Zero); 1764 } 1765 1766 // Restrict this fold only for single-use 'and' (PR10267). 1767 // ((%x & C) == 0) --> %x u< (-C) iff (-C) is power of two. 1768 if ((~(*C2) + 1).isPowerOf2()) { 1769 Constant *NegBOC = 1770 ConstantExpr::getNeg(cast<Constant>(And->getOperand(1))); 1771 auto NewPred = isICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT; 1772 return new ICmpInst(NewPred, X, NegBOC); 1773 } 1774 } 1775 1776 // If the LHS is an 'and' of a truncate and we can widen the and/compare to 1777 // the input width without changing the value produced, eliminate the cast: 1778 // 1779 // icmp (and (trunc W), C2), C1 -> icmp (and W, C2'), C1' 1780 // 1781 // We can do this transformation if the constants do not have their sign bits 1782 // set or if it is an equality comparison. Extending a relational comparison 1783 // when we're checking the sign bit would not work. 1784 Value *W; 1785 if (match(And->getOperand(0), m_OneUse(m_Trunc(m_Value(W)))) && 1786 (Cmp.isEquality() || (!C1.isNegative() && !C2->isNegative()))) { 1787 // TODO: Is this a good transform for vectors? Wider types may reduce 1788 // throughput. Should this transform be limited (even for scalars) by using 1789 // shouldChangeType()? 1790 if (!Cmp.getType()->isVectorTy()) { 1791 Type *WideType = W->getType(); 1792 unsigned WideScalarBits = WideType->getScalarSizeInBits(); 1793 Constant *ZextC1 = ConstantInt::get(WideType, C1.zext(WideScalarBits)); 1794 Constant *ZextC2 = ConstantInt::get(WideType, C2->zext(WideScalarBits)); 1795 Value *NewAnd = Builder.CreateAnd(W, ZextC2, And->getName()); 1796 return new ICmpInst(Cmp.getPredicate(), NewAnd, ZextC1); 1797 } 1798 } 1799 1800 if (Instruction *I = foldICmpAndShift(Cmp, And, C1, *C2)) 1801 return I; 1802 1803 // (icmp pred (and (or (lshr A, B), A), 1), 0) --> 1804 // (icmp pred (and A, (or (shl 1, B), 1), 0)) 1805 // 1806 // iff pred isn't signed 1807 if (!Cmp.isSigned() && C1.isZero() && And->getOperand(0)->hasOneUse() && 1808 match(And->getOperand(1), m_One())) { 1809 Constant *One = cast<Constant>(And->getOperand(1)); 1810 Value *Or = And->getOperand(0); 1811 Value *A, *B, *LShr; 1812 if (match(Or, m_Or(m_Value(LShr), m_Value(A))) && 1813 match(LShr, m_LShr(m_Specific(A), m_Value(B)))) { 1814 unsigned UsesRemoved = 0; 1815 if (And->hasOneUse()) 1816 ++UsesRemoved; 1817 if (Or->hasOneUse()) 1818 ++UsesRemoved; 1819 if (LShr->hasOneUse()) 1820 ++UsesRemoved; 1821 1822 // Compute A & ((1 << B) | 1) 1823 Value *NewOr = nullptr; 1824 if (auto *C = dyn_cast<Constant>(B)) { 1825 if (UsesRemoved >= 1) 1826 NewOr = ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One); 1827 } else { 1828 if (UsesRemoved >= 3) 1829 NewOr = Builder.CreateOr(Builder.CreateShl(One, B, LShr->getName(), 1830 /*HasNUW=*/true), 1831 One, Or->getName()); 1832 } 1833 if (NewOr) { 1834 Value *NewAnd = Builder.CreateAnd(A, NewOr, And->getName()); 1835 return replaceOperand(Cmp, 0, NewAnd); 1836 } 1837 } 1838 } 1839 1840 return nullptr; 1841 } 1842 1843 /// Fold icmp (and X, Y), C. 1844 Instruction *InstCombinerImpl::foldICmpAndConstant(ICmpInst &Cmp, 1845 BinaryOperator *And, 1846 const APInt &C) { 1847 if (Instruction *I = foldICmpAndConstConst(Cmp, And, C)) 1848 return I; 1849 1850 const ICmpInst::Predicate Pred = Cmp.getPredicate(); 1851 bool TrueIfNeg; 1852 if (isSignBitCheck(Pred, C, TrueIfNeg)) { 1853 // ((X - 1) & ~X) < 0 --> X == 0 1854 // ((X - 1) & ~X) >= 0 --> X != 0 1855 Value *X; 1856 if (match(And->getOperand(0), m_Add(m_Value(X), m_AllOnes())) && 1857 match(And->getOperand(1), m_Not(m_Specific(X)))) { 1858 auto NewPred = TrueIfNeg ? CmpInst::ICMP_EQ : CmpInst::ICMP_NE; 1859 return new ICmpInst(NewPred, X, ConstantInt::getNullValue(X->getType())); 1860 } 1861 } 1862 1863 // TODO: These all require that Y is constant too, so refactor with the above. 1864 1865 // Try to optimize things like "A[i] & 42 == 0" to index computations. 1866 Value *X = And->getOperand(0); 1867 Value *Y = And->getOperand(1); 1868 if (auto *C2 = dyn_cast<ConstantInt>(Y)) 1869 if (auto *LI = dyn_cast<LoadInst>(X)) 1870 if (auto *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0))) 1871 if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0))) 1872 if (Instruction *Res = 1873 foldCmpLoadFromIndexedGlobal(LI, GEP, GV, Cmp, C2)) 1874 return Res; 1875 1876 if (!Cmp.isEquality()) 1877 return nullptr; 1878 1879 // X & -C == -C -> X > u ~C 1880 // X & -C != -C -> X <= u ~C 1881 // iff C is a power of 2 1882 if (Cmp.getOperand(1) == Y && C.isNegatedPowerOf2()) { 1883 auto NewPred = 1884 Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGT : CmpInst::ICMP_ULE; 1885 return new ICmpInst(NewPred, X, SubOne(cast<Constant>(Cmp.getOperand(1)))); 1886 } 1887 1888 return nullptr; 1889 } 1890 1891 /// Fold icmp (or X, Y), C. 1892 Instruction *InstCombinerImpl::foldICmpOrConstant(ICmpInst &Cmp, 1893 BinaryOperator *Or, 1894 const APInt &C) { 1895 ICmpInst::Predicate Pred = Cmp.getPredicate(); 1896 if (C.isOne()) { 1897 // icmp slt signum(V) 1 --> icmp slt V, 1 1898 Value *V = nullptr; 1899 if (Pred == ICmpInst::ICMP_SLT && match(Or, m_Signum(m_Value(V)))) 1900 return new ICmpInst(ICmpInst::ICMP_SLT, V, 1901 ConstantInt::get(V->getType(), 1)); 1902 } 1903 1904 Value *OrOp0 = Or->getOperand(0), *OrOp1 = Or->getOperand(1); 1905 const APInt *MaskC; 1906 if (match(OrOp1, m_APInt(MaskC)) && Cmp.isEquality()) { 1907 if (*MaskC == C && (C + 1).isPowerOf2()) { 1908 // X | C == C --> X <=u C 1909 // X | C != C --> X >u C 1910 // iff C+1 is a power of 2 (C is a bitmask of the low bits) 1911 Pred = (Pred == CmpInst::ICMP_EQ) ? CmpInst::ICMP_ULE : CmpInst::ICMP_UGT; 1912 return new ICmpInst(Pred, OrOp0, OrOp1); 1913 } 1914 1915 // More general: canonicalize 'equality with set bits mask' to 1916 // 'equality with clear bits mask'. 1917 // (X | MaskC) == C --> (X & ~MaskC) == C ^ MaskC 1918 // (X | MaskC) != C --> (X & ~MaskC) != C ^ MaskC 1919 if (Or->hasOneUse()) { 1920 Value *And = Builder.CreateAnd(OrOp0, ~(*MaskC)); 1921 Constant *NewC = ConstantInt::get(Or->getType(), C ^ (*MaskC)); 1922 return new ICmpInst(Pred, And, NewC); 1923 } 1924 } 1925 1926 // (X | (X-1)) s< 0 --> X s< 1 1927 // (X | (X-1)) s> -1 --> X s> 0 1928 Value *X; 1929 bool TrueIfSigned; 1930 if (isSignBitCheck(Pred, C, TrueIfSigned) && 1931 match(Or, m_c_Or(m_Add(m_Value(X), m_AllOnes()), m_Deferred(X)))) { 1932 auto NewPred = TrueIfSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGT; 1933 Constant *NewC = ConstantInt::get(X->getType(), TrueIfSigned ? 1 : 0); 1934 return new ICmpInst(NewPred, X, NewC); 1935 } 1936 1937 if (!Cmp.isEquality() || !C.isZero() || !Or->hasOneUse()) 1938 return nullptr; 1939 1940 Value *P, *Q; 1941 if (match(Or, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) { 1942 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0 1943 // -> and (icmp eq P, null), (icmp eq Q, null). 1944 Value *CmpP = 1945 Builder.CreateICmp(Pred, P, ConstantInt::getNullValue(P->getType())); 1946 Value *CmpQ = 1947 Builder.CreateICmp(Pred, Q, ConstantInt::getNullValue(Q->getType())); 1948 auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or; 1949 return BinaryOperator::Create(BOpc, CmpP, CmpQ); 1950 } 1951 1952 // Are we using xors to bitwise check for a pair of (in)equalities? Convert to 1953 // a shorter form that has more potential to be folded even further. 1954 Value *X1, *X2, *X3, *X4; 1955 if (match(OrOp0, m_OneUse(m_Xor(m_Value(X1), m_Value(X2)))) && 1956 match(OrOp1, m_OneUse(m_Xor(m_Value(X3), m_Value(X4))))) { 1957 // ((X1 ^ X2) || (X3 ^ X4)) == 0 --> (X1 == X2) && (X3 == X4) 1958 // ((X1 ^ X2) || (X3 ^ X4)) != 0 --> (X1 != X2) || (X3 != X4) 1959 Value *Cmp12 = Builder.CreateICmp(Pred, X1, X2); 1960 Value *Cmp34 = Builder.CreateICmp(Pred, X3, X4); 1961 auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or; 1962 return BinaryOperator::Create(BOpc, Cmp12, Cmp34); 1963 } 1964 1965 return nullptr; 1966 } 1967 1968 /// Fold icmp (mul X, Y), C. 1969 Instruction *InstCombinerImpl::foldICmpMulConstant(ICmpInst &Cmp, 1970 BinaryOperator *Mul, 1971 const APInt &C) { 1972 const APInt *MulC; 1973 if (!match(Mul->getOperand(1), m_APInt(MulC))) 1974 return nullptr; 1975 1976 // If this is a test of the sign bit and the multiply is sign-preserving with 1977 // a constant operand, use the multiply LHS operand instead. 1978 ICmpInst::Predicate Pred = Cmp.getPredicate(); 1979 if (isSignTest(Pred, C) && Mul->hasNoSignedWrap()) { 1980 if (MulC->isNegative()) 1981 Pred = ICmpInst::getSwappedPredicate(Pred); 1982 return new ICmpInst(Pred, Mul->getOperand(0), 1983 Constant::getNullValue(Mul->getType())); 1984 } 1985 1986 // If the multiply does not wrap, try to divide the compare constant by the 1987 // multiplication factor. 1988 if (Cmp.isEquality() && !MulC->isZero()) { 1989 // (mul nsw X, MulC) == C --> X == C /s MulC 1990 if (Mul->hasNoSignedWrap() && C.srem(*MulC).isZero()) { 1991 Constant *NewC = ConstantInt::get(Mul->getType(), C.sdiv(*MulC)); 1992 return new ICmpInst(Pred, Mul->getOperand(0), NewC); 1993 } 1994 // (mul nuw X, MulC) == C --> X == C /u MulC 1995 if (Mul->hasNoUnsignedWrap() && C.urem(*MulC).isZero()) { 1996 Constant *NewC = ConstantInt::get(Mul->getType(), C.udiv(*MulC)); 1997 return new ICmpInst(Pred, Mul->getOperand(0), NewC); 1998 } 1999 } 2000 2001 return nullptr; 2002 } 2003 2004 /// Fold icmp (shl 1, Y), C. 2005 static Instruction *foldICmpShlOne(ICmpInst &Cmp, Instruction *Shl, 2006 const APInt &C) { 2007 Value *Y; 2008 if (!match(Shl, m_Shl(m_One(), m_Value(Y)))) 2009 return nullptr; 2010 2011 Type *ShiftType = Shl->getType(); 2012 unsigned TypeBits = C.getBitWidth(); 2013 bool CIsPowerOf2 = C.isPowerOf2(); 2014 ICmpInst::Predicate Pred = Cmp.getPredicate(); 2015 if (Cmp.isUnsigned()) { 2016 // (1 << Y) pred C -> Y pred Log2(C) 2017 if (!CIsPowerOf2) { 2018 // (1 << Y) < 30 -> Y <= 4 2019 // (1 << Y) <= 30 -> Y <= 4 2020 // (1 << Y) >= 30 -> Y > 4 2021 // (1 << Y) > 30 -> Y > 4 2022 if (Pred == ICmpInst::ICMP_ULT) 2023 Pred = ICmpInst::ICMP_ULE; 2024 else if (Pred == ICmpInst::ICMP_UGE) 2025 Pred = ICmpInst::ICMP_UGT; 2026 } 2027 2028 // (1 << Y) >= 2147483648 -> Y >= 31 -> Y == 31 2029 // (1 << Y) < 2147483648 -> Y < 31 -> Y != 31 2030 unsigned CLog2 = C.logBase2(); 2031 if (CLog2 == TypeBits - 1) { 2032 if (Pred == ICmpInst::ICMP_UGE) 2033 Pred = ICmpInst::ICMP_EQ; 2034 else if (Pred == ICmpInst::ICMP_ULT) 2035 Pred = ICmpInst::ICMP_NE; 2036 } 2037 return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, CLog2)); 2038 } else if (Cmp.isSigned()) { 2039 Constant *BitWidthMinusOne = ConstantInt::get(ShiftType, TypeBits - 1); 2040 if (C.isAllOnes()) { 2041 // (1 << Y) <= -1 -> Y == 31 2042 if (Pred == ICmpInst::ICMP_SLE) 2043 return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne); 2044 2045 // (1 << Y) > -1 -> Y != 31 2046 if (Pred == ICmpInst::ICMP_SGT) 2047 return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne); 2048 } else if (!C) { 2049 // (1 << Y) < 0 -> Y == 31 2050 // (1 << Y) <= 0 -> Y == 31 2051 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) 2052 return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne); 2053 2054 // (1 << Y) >= 0 -> Y != 31 2055 // (1 << Y) > 0 -> Y != 31 2056 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE) 2057 return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne); 2058 } 2059 } else if (Cmp.isEquality() && CIsPowerOf2) { 2060 return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, C.logBase2())); 2061 } 2062 2063 return nullptr; 2064 } 2065 2066 /// Fold icmp (shl X, Y), C. 2067 Instruction *InstCombinerImpl::foldICmpShlConstant(ICmpInst &Cmp, 2068 BinaryOperator *Shl, 2069 const APInt &C) { 2070 const APInt *ShiftVal; 2071 if (Cmp.isEquality() && match(Shl->getOperand(0), m_APInt(ShiftVal))) 2072 return foldICmpShlConstConst(Cmp, Shl->getOperand(1), C, *ShiftVal); 2073 2074 const APInt *ShiftAmt; 2075 if (!match(Shl->getOperand(1), m_APInt(ShiftAmt))) 2076 return foldICmpShlOne(Cmp, Shl, C); 2077 2078 // Check that the shift amount is in range. If not, don't perform undefined 2079 // shifts. When the shift is visited, it will be simplified. 2080 unsigned TypeBits = C.getBitWidth(); 2081 if (ShiftAmt->uge(TypeBits)) 2082 return nullptr; 2083 2084 ICmpInst::Predicate Pred = Cmp.getPredicate(); 2085 Value *X = Shl->getOperand(0); 2086 Type *ShType = Shl->getType(); 2087 2088 // NSW guarantees that we are only shifting out sign bits from the high bits, 2089 // so we can ASHR the compare constant without needing a mask and eliminate 2090 // the shift. 2091 if (Shl->hasNoSignedWrap()) { 2092 if (Pred == ICmpInst::ICMP_SGT) { 2093 // icmp Pred (shl nsw X, ShiftAmt), C --> icmp Pred X, (C >>s ShiftAmt) 2094 APInt ShiftedC = C.ashr(*ShiftAmt); 2095 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC)); 2096 } 2097 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) && 2098 C.ashr(*ShiftAmt).shl(*ShiftAmt) == C) { 2099 APInt ShiftedC = C.ashr(*ShiftAmt); 2100 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC)); 2101 } 2102 if (Pred == ICmpInst::ICMP_SLT) { 2103 // SLE is the same as above, but SLE is canonicalized to SLT, so convert: 2104 // (X << S) <=s C is equiv to X <=s (C >> S) for all C 2105 // (X << S) <s (C + 1) is equiv to X <s (C >> S) + 1 if C <s SMAX 2106 // (X << S) <s C is equiv to X <s ((C - 1) >> S) + 1 if C >s SMIN 2107 assert(!C.isMinSignedValue() && "Unexpected icmp slt"); 2108 APInt ShiftedC = (C - 1).ashr(*ShiftAmt) + 1; 2109 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC)); 2110 } 2111 // If this is a signed comparison to 0 and the shift is sign preserving, 2112 // use the shift LHS operand instead; isSignTest may change 'Pred', so only 2113 // do that if we're sure to not continue on in this function. 2114 if (isSignTest(Pred, C)) 2115 return new ICmpInst(Pred, X, Constant::getNullValue(ShType)); 2116 } 2117 2118 // NUW guarantees that we are only shifting out zero bits from the high bits, 2119 // so we can LSHR the compare constant without needing a mask and eliminate 2120 // the shift. 2121 if (Shl->hasNoUnsignedWrap()) { 2122 if (Pred == ICmpInst::ICMP_UGT) { 2123 // icmp Pred (shl nuw X, ShiftAmt), C --> icmp Pred X, (C >>u ShiftAmt) 2124 APInt ShiftedC = C.lshr(*ShiftAmt); 2125 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC)); 2126 } 2127 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) && 2128 C.lshr(*ShiftAmt).shl(*ShiftAmt) == C) { 2129 APInt ShiftedC = C.lshr(*ShiftAmt); 2130 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC)); 2131 } 2132 if (Pred == ICmpInst::ICMP_ULT) { 2133 // ULE is the same as above, but ULE is canonicalized to ULT, so convert: 2134 // (X << S) <=u C is equiv to X <=u (C >> S) for all C 2135 // (X << S) <u (C + 1) is equiv to X <u (C >> S) + 1 if C <u ~0u 2136 // (X << S) <u C is equiv to X <u ((C - 1) >> S) + 1 if C >u 0 2137 assert(C.ugt(0) && "ult 0 should have been eliminated"); 2138 APInt ShiftedC = (C - 1).lshr(*ShiftAmt) + 1; 2139 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC)); 2140 } 2141 } 2142 2143 if (Cmp.isEquality() && Shl->hasOneUse()) { 2144 // Strength-reduce the shift into an 'and'. 2145 Constant *Mask = ConstantInt::get( 2146 ShType, 2147 APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt->getZExtValue())); 2148 Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask"); 2149 Constant *LShrC = ConstantInt::get(ShType, C.lshr(*ShiftAmt)); 2150 return new ICmpInst(Pred, And, LShrC); 2151 } 2152 2153 // Otherwise, if this is a comparison of the sign bit, simplify to and/test. 2154 bool TrueIfSigned = false; 2155 if (Shl->hasOneUse() && isSignBitCheck(Pred, C, TrueIfSigned)) { 2156 // (X << 31) <s 0 --> (X & 1) != 0 2157 Constant *Mask = ConstantInt::get( 2158 ShType, 2159 APInt::getOneBitSet(TypeBits, TypeBits - ShiftAmt->getZExtValue() - 1)); 2160 Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask"); 2161 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ, 2162 And, Constant::getNullValue(ShType)); 2163 } 2164 2165 // Simplify 'shl' inequality test into 'and' equality test. 2166 if (Cmp.isUnsigned() && Shl->hasOneUse()) { 2167 // (X l<< C2) u<=/u> C1 iff C1+1 is power of two -> X & (~C1 l>> C2) ==/!= 0 2168 if ((C + 1).isPowerOf2() && 2169 (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_UGT)) { 2170 Value *And = Builder.CreateAnd(X, (~C).lshr(ShiftAmt->getZExtValue())); 2171 return new ICmpInst(Pred == ICmpInst::ICMP_ULE ? ICmpInst::ICMP_EQ 2172 : ICmpInst::ICMP_NE, 2173 And, Constant::getNullValue(ShType)); 2174 } 2175 // (X l<< C2) u</u>= C1 iff C1 is power of two -> X & (-C1 l>> C2) ==/!= 0 2176 if (C.isPowerOf2() && 2177 (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE)) { 2178 Value *And = 2179 Builder.CreateAnd(X, (~(C - 1)).lshr(ShiftAmt->getZExtValue())); 2180 return new ICmpInst(Pred == ICmpInst::ICMP_ULT ? ICmpInst::ICMP_EQ 2181 : ICmpInst::ICMP_NE, 2182 And, Constant::getNullValue(ShType)); 2183 } 2184 } 2185 2186 // Transform (icmp pred iM (shl iM %v, N), C) 2187 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (C>>N)) 2188 // Transform the shl to a trunc if (trunc (C>>N)) has no loss and M-N. 2189 // This enables us to get rid of the shift in favor of a trunc that may be 2190 // free on the target. It has the additional benefit of comparing to a 2191 // smaller constant that may be more target-friendly. 2192 unsigned Amt = ShiftAmt->getLimitedValue(TypeBits - 1); 2193 if (Shl->hasOneUse() && Amt != 0 && C.countTrailingZeros() >= Amt && 2194 DL.isLegalInteger(TypeBits - Amt)) { 2195 Type *TruncTy = IntegerType::get(Cmp.getContext(), TypeBits - Amt); 2196 if (auto *ShVTy = dyn_cast<VectorType>(ShType)) 2197 TruncTy = VectorType::get(TruncTy, ShVTy->getElementCount()); 2198 Constant *NewC = 2199 ConstantInt::get(TruncTy, C.ashr(*ShiftAmt).trunc(TypeBits - Amt)); 2200 return new ICmpInst(Pred, Builder.CreateTrunc(X, TruncTy), NewC); 2201 } 2202 2203 return nullptr; 2204 } 2205 2206 /// Fold icmp ({al}shr X, Y), C. 2207 Instruction *InstCombinerImpl::foldICmpShrConstant(ICmpInst &Cmp, 2208 BinaryOperator *Shr, 2209 const APInt &C) { 2210 // An exact shr only shifts out zero bits, so: 2211 // icmp eq/ne (shr X, Y), 0 --> icmp eq/ne X, 0 2212 Value *X = Shr->getOperand(0); 2213 CmpInst::Predicate Pred = Cmp.getPredicate(); 2214 if (Cmp.isEquality() && Shr->isExact() && C.isZero()) 2215 return new ICmpInst(Pred, X, Cmp.getOperand(1)); 2216 2217 const APInt *ShiftVal; 2218 if (Cmp.isEquality() && match(Shr->getOperand(0), m_APInt(ShiftVal))) 2219 return foldICmpShrConstConst(Cmp, Shr->getOperand(1), C, *ShiftVal); 2220 2221 const APInt *ShiftAmt; 2222 if (!match(Shr->getOperand(1), m_APInt(ShiftAmt))) 2223 return nullptr; 2224 2225 // Check that the shift amount is in range. If not, don't perform undefined 2226 // shifts. When the shift is visited it will be simplified. 2227 unsigned TypeBits = C.getBitWidth(); 2228 unsigned ShAmtVal = ShiftAmt->getLimitedValue(TypeBits); 2229 if (ShAmtVal >= TypeBits || ShAmtVal == 0) 2230 return nullptr; 2231 2232 bool IsAShr = Shr->getOpcode() == Instruction::AShr; 2233 bool IsExact = Shr->isExact(); 2234 Type *ShrTy = Shr->getType(); 2235 // TODO: If we could guarantee that InstSimplify would handle all of the 2236 // constant-value-based preconditions in the folds below, then we could assert 2237 // those conditions rather than checking them. This is difficult because of 2238 // undef/poison (PR34838). 2239 if (IsAShr) { 2240 if (IsExact || Pred == CmpInst::ICMP_SLT || Pred == CmpInst::ICMP_ULT) { 2241 // When ShAmtC can be shifted losslessly: 2242 // icmp PRED (ashr exact X, ShAmtC), C --> icmp PRED X, (C << ShAmtC) 2243 // icmp slt/ult (ashr X, ShAmtC), C --> icmp slt/ult X, (C << ShAmtC) 2244 APInt ShiftedC = C.shl(ShAmtVal); 2245 if (ShiftedC.ashr(ShAmtVal) == C) 2246 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC)); 2247 } 2248 if (Pred == CmpInst::ICMP_SGT) { 2249 // icmp sgt (ashr X, ShAmtC), C --> icmp sgt X, ((C + 1) << ShAmtC) - 1 2250 APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1; 2251 if (!C.isMaxSignedValue() && !(C + 1).shl(ShAmtVal).isMinSignedValue() && 2252 (ShiftedC + 1).ashr(ShAmtVal) == (C + 1)) 2253 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC)); 2254 } 2255 if (Pred == CmpInst::ICMP_UGT) { 2256 // icmp ugt (ashr X, ShAmtC), C --> icmp ugt X, ((C + 1) << ShAmtC) - 1 2257 APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1; 2258 if ((ShiftedC + 1).ashr(ShAmtVal) == (C + 1)) 2259 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC)); 2260 } 2261 2262 // If the compare constant has significant bits above the lowest sign-bit, 2263 // then convert an unsigned cmp to a test of the sign-bit: 2264 // (ashr X, ShiftC) u> C --> X s< 0 2265 // (ashr X, ShiftC) u< C --> X s> -1 2266 if (C.getBitWidth() > 2 && C.getNumSignBits() <= ShAmtVal) { 2267 if (Pred == CmpInst::ICMP_UGT) { 2268 return new ICmpInst(CmpInst::ICMP_SLT, X, 2269 ConstantInt::getNullValue(ShrTy)); 2270 } 2271 if (Pred == CmpInst::ICMP_ULT) { 2272 return new ICmpInst(CmpInst::ICMP_SGT, X, 2273 ConstantInt::getAllOnesValue(ShrTy)); 2274 } 2275 } 2276 } else { 2277 if (Pred == CmpInst::ICMP_ULT || (Pred == CmpInst::ICMP_UGT && IsExact)) { 2278 // icmp ult (lshr X, ShAmtC), C --> icmp ult X, (C << ShAmtC) 2279 // icmp ugt (lshr exact X, ShAmtC), C --> icmp ugt X, (C << ShAmtC) 2280 APInt ShiftedC = C.shl(ShAmtVal); 2281 if (ShiftedC.lshr(ShAmtVal) == C) 2282 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC)); 2283 } 2284 if (Pred == CmpInst::ICMP_UGT) { 2285 // icmp ugt (lshr X, ShAmtC), C --> icmp ugt X, ((C + 1) << ShAmtC) - 1 2286 APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1; 2287 if ((ShiftedC + 1).lshr(ShAmtVal) == (C + 1)) 2288 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC)); 2289 } 2290 } 2291 2292 if (!Cmp.isEquality()) 2293 return nullptr; 2294 2295 // Handle equality comparisons of shift-by-constant. 2296 2297 // If the comparison constant changes with the shift, the comparison cannot 2298 // succeed (bits of the comparison constant cannot match the shifted value). 2299 // This should be known by InstSimplify and already be folded to true/false. 2300 assert(((IsAShr && C.shl(ShAmtVal).ashr(ShAmtVal) == C) || 2301 (!IsAShr && C.shl(ShAmtVal).lshr(ShAmtVal) == C)) && 2302 "Expected icmp+shr simplify did not occur."); 2303 2304 // If the bits shifted out are known zero, compare the unshifted value: 2305 // (X & 4) >> 1 == 2 --> (X & 4) == 4. 2306 if (Shr->isExact()) 2307 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, C << ShAmtVal)); 2308 2309 if (C.isZero()) { 2310 // == 0 is u< 1. 2311 if (Pred == CmpInst::ICMP_EQ) 2312 return new ICmpInst(CmpInst::ICMP_ULT, X, 2313 ConstantInt::get(ShrTy, (C + 1).shl(ShAmtVal))); 2314 else 2315 return new ICmpInst(CmpInst::ICMP_UGT, X, 2316 ConstantInt::get(ShrTy, (C + 1).shl(ShAmtVal) - 1)); 2317 } 2318 2319 if (Shr->hasOneUse()) { 2320 // Canonicalize the shift into an 'and': 2321 // icmp eq/ne (shr X, ShAmt), C --> icmp eq/ne (and X, HiMask), (C << ShAmt) 2322 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal)); 2323 Constant *Mask = ConstantInt::get(ShrTy, Val); 2324 Value *And = Builder.CreateAnd(X, Mask, Shr->getName() + ".mask"); 2325 return new ICmpInst(Pred, And, ConstantInt::get(ShrTy, C << ShAmtVal)); 2326 } 2327 2328 return nullptr; 2329 } 2330 2331 Instruction *InstCombinerImpl::foldICmpSRemConstant(ICmpInst &Cmp, 2332 BinaryOperator *SRem, 2333 const APInt &C) { 2334 // Match an 'is positive' or 'is negative' comparison of remainder by a 2335 // constant power-of-2 value: 2336 // (X % pow2C) sgt/slt 0 2337 const ICmpInst::Predicate Pred = Cmp.getPredicate(); 2338 if (Pred != ICmpInst::ICMP_SGT && Pred != ICmpInst::ICMP_SLT) 2339 return nullptr; 2340 2341 // TODO: The one-use check is standard because we do not typically want to 2342 // create longer instruction sequences, but this might be a special-case 2343 // because srem is not good for analysis or codegen. 2344 if (!SRem->hasOneUse()) 2345 return nullptr; 2346 2347 const APInt *DivisorC; 2348 if (!C.isZero() || !match(SRem->getOperand(1), m_Power2(DivisorC))) 2349 return nullptr; 2350 2351 // Mask off the sign bit and the modulo bits (low-bits). 2352 Type *Ty = SRem->getType(); 2353 APInt SignMask = APInt::getSignMask(Ty->getScalarSizeInBits()); 2354 Constant *MaskC = ConstantInt::get(Ty, SignMask | (*DivisorC - 1)); 2355 Value *And = Builder.CreateAnd(SRem->getOperand(0), MaskC); 2356 2357 // For 'is positive?' check that the sign-bit is clear and at least 1 masked 2358 // bit is set. Example: 2359 // (i8 X % 32) s> 0 --> (X & 159) s> 0 2360 if (Pred == ICmpInst::ICMP_SGT) 2361 return new ICmpInst(ICmpInst::ICMP_SGT, And, ConstantInt::getNullValue(Ty)); 2362 2363 // For 'is negative?' check that the sign-bit is set and at least 1 masked 2364 // bit is set. Example: 2365 // (i16 X % 4) s< 0 --> (X & 32771) u> 32768 2366 return new ICmpInst(ICmpInst::ICMP_UGT, And, ConstantInt::get(Ty, SignMask)); 2367 } 2368 2369 /// Fold icmp (udiv X, Y), C. 2370 Instruction *InstCombinerImpl::foldICmpUDivConstant(ICmpInst &Cmp, 2371 BinaryOperator *UDiv, 2372 const APInt &C) { 2373 const APInt *C2; 2374 if (!match(UDiv->getOperand(0), m_APInt(C2))) 2375 return nullptr; 2376 2377 assert(*C2 != 0 && "udiv 0, X should have been simplified already."); 2378 2379 // (icmp ugt (udiv C2, Y), C) -> (icmp ule Y, C2/(C+1)) 2380 Value *Y = UDiv->getOperand(1); 2381 if (Cmp.getPredicate() == ICmpInst::ICMP_UGT) { 2382 assert(!C.isMaxValue() && 2383 "icmp ugt X, UINT_MAX should have been simplified already."); 2384 return new ICmpInst(ICmpInst::ICMP_ULE, Y, 2385 ConstantInt::get(Y->getType(), C2->udiv(C + 1))); 2386 } 2387 2388 // (icmp ult (udiv C2, Y), C) -> (icmp ugt Y, C2/C) 2389 if (Cmp.getPredicate() == ICmpInst::ICMP_ULT) { 2390 assert(C != 0 && "icmp ult X, 0 should have been simplified already."); 2391 return new ICmpInst(ICmpInst::ICMP_UGT, Y, 2392 ConstantInt::get(Y->getType(), C2->udiv(C))); 2393 } 2394 2395 return nullptr; 2396 } 2397 2398 /// Fold icmp ({su}div X, Y), C. 2399 Instruction *InstCombinerImpl::foldICmpDivConstant(ICmpInst &Cmp, 2400 BinaryOperator *Div, 2401 const APInt &C) { 2402 // Fold: icmp pred ([us]div X, C2), C -> range test 2403 // Fold this div into the comparison, producing a range check. 2404 // Determine, based on the divide type, what the range is being 2405 // checked. If there is an overflow on the low or high side, remember 2406 // it, otherwise compute the range [low, hi) bounding the new value. 2407 // See: InsertRangeTest above for the kinds of replacements possible. 2408 const APInt *C2; 2409 if (!match(Div->getOperand(1), m_APInt(C2))) 2410 return nullptr; 2411 2412 // FIXME: If the operand types don't match the type of the divide 2413 // then don't attempt this transform. The code below doesn't have the 2414 // logic to deal with a signed divide and an unsigned compare (and 2415 // vice versa). This is because (x /s C2) <s C produces different 2416 // results than (x /s C2) <u C or (x /u C2) <s C or even 2417 // (x /u C2) <u C. Simply casting the operands and result won't 2418 // work. :( The if statement below tests that condition and bails 2419 // if it finds it. 2420 bool DivIsSigned = Div->getOpcode() == Instruction::SDiv; 2421 if (!Cmp.isEquality() && DivIsSigned != Cmp.isSigned()) 2422 return nullptr; 2423 2424 // The ProdOV computation fails on divide by 0 and divide by -1. Cases with 2425 // INT_MIN will also fail if the divisor is 1. Although folds of all these 2426 // division-by-constant cases should be present, we can not assert that they 2427 // have happened before we reach this icmp instruction. 2428 if (C2->isZero() || C2->isOne() || (DivIsSigned && C2->isAllOnes())) 2429 return nullptr; 2430 2431 // Compute Prod = C * C2. We are essentially solving an equation of 2432 // form X / C2 = C. We solve for X by multiplying C2 and C. 2433 // By solving for X, we can turn this into a range check instead of computing 2434 // a divide. 2435 APInt Prod = C * *C2; 2436 2437 // Determine if the product overflows by seeing if the product is not equal to 2438 // the divide. Make sure we do the same kind of divide as in the LHS 2439 // instruction that we're folding. 2440 bool ProdOV = (DivIsSigned ? Prod.sdiv(*C2) : Prod.udiv(*C2)) != C; 2441 2442 ICmpInst::Predicate Pred = Cmp.getPredicate(); 2443 2444 // If the division is known to be exact, then there is no remainder from the 2445 // divide, so the covered range size is unit, otherwise it is the divisor. 2446 APInt RangeSize = Div->isExact() ? APInt(C2->getBitWidth(), 1) : *C2; 2447 2448 // Figure out the interval that is being checked. For example, a comparison 2449 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5). 2450 // Compute this interval based on the constants involved and the signedness of 2451 // the compare/divide. This computes a half-open interval, keeping track of 2452 // whether either value in the interval overflows. After analysis each 2453 // overflow variable is set to 0 if it's corresponding bound variable is valid 2454 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end. 2455 int LoOverflow = 0, HiOverflow = 0; 2456 APInt LoBound, HiBound; 2457 2458 if (!DivIsSigned) { // udiv 2459 // e.g. X/5 op 3 --> [15, 20) 2460 LoBound = Prod; 2461 HiOverflow = LoOverflow = ProdOV; 2462 if (!HiOverflow) { 2463 // If this is not an exact divide, then many values in the range collapse 2464 // to the same result value. 2465 HiOverflow = addWithOverflow(HiBound, LoBound, RangeSize, false); 2466 } 2467 } else if (C2->isStrictlyPositive()) { // Divisor is > 0. 2468 if (C.isZero()) { // (X / pos) op 0 2469 // Can't overflow. e.g. X/2 op 0 --> [-1, 2) 2470 LoBound = -(RangeSize - 1); 2471 HiBound = RangeSize; 2472 } else if (C.isStrictlyPositive()) { // (X / pos) op pos 2473 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20) 2474 HiOverflow = LoOverflow = ProdOV; 2475 if (!HiOverflow) 2476 HiOverflow = addWithOverflow(HiBound, Prod, RangeSize, true); 2477 } else { // (X / pos) op neg 2478 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14) 2479 HiBound = Prod + 1; 2480 LoOverflow = HiOverflow = ProdOV ? -1 : 0; 2481 if (!LoOverflow) { 2482 APInt DivNeg = -RangeSize; 2483 LoOverflow = addWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0; 2484 } 2485 } 2486 } else if (C2->isNegative()) { // Divisor is < 0. 2487 if (Div->isExact()) 2488 RangeSize.negate(); 2489 if (C.isZero()) { // (X / neg) op 0 2490 // e.g. X/-5 op 0 --> [-4, 5) 2491 LoBound = RangeSize + 1; 2492 HiBound = -RangeSize; 2493 if (HiBound == *C2) { // -INTMIN = INTMIN 2494 HiOverflow = 1; // [INTMIN+1, overflow) 2495 HiBound = APInt(); // e.g. X/INTMIN = 0 --> X > INTMIN 2496 } 2497 } else if (C.isStrictlyPositive()) { // (X / neg) op pos 2498 // e.g. X/-5 op 3 --> [-19, -14) 2499 HiBound = Prod + 1; 2500 HiOverflow = LoOverflow = ProdOV ? -1 : 0; 2501 if (!LoOverflow) 2502 LoOverflow = addWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0; 2503 } else { // (X / neg) op neg 2504 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20) 2505 LoOverflow = HiOverflow = ProdOV; 2506 if (!HiOverflow) 2507 HiOverflow = subWithOverflow(HiBound, Prod, RangeSize, true); 2508 } 2509 2510 // Dividing by a negative swaps the condition. LT <-> GT 2511 Pred = ICmpInst::getSwappedPredicate(Pred); 2512 } 2513 2514 Value *X = Div->getOperand(0); 2515 switch (Pred) { 2516 default: llvm_unreachable("Unhandled icmp opcode!"); 2517 case ICmpInst::ICMP_EQ: 2518 if (LoOverflow && HiOverflow) 2519 return replaceInstUsesWith(Cmp, Builder.getFalse()); 2520 if (HiOverflow) 2521 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE : 2522 ICmpInst::ICMP_UGE, X, 2523 ConstantInt::get(Div->getType(), LoBound)); 2524 if (LoOverflow) 2525 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT : 2526 ICmpInst::ICMP_ULT, X, 2527 ConstantInt::get(Div->getType(), HiBound)); 2528 return replaceInstUsesWith( 2529 Cmp, insertRangeTest(X, LoBound, HiBound, DivIsSigned, true)); 2530 case ICmpInst::ICMP_NE: 2531 if (LoOverflow && HiOverflow) 2532 return replaceInstUsesWith(Cmp, Builder.getTrue()); 2533 if (HiOverflow) 2534 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT : 2535 ICmpInst::ICMP_ULT, X, 2536 ConstantInt::get(Div->getType(), LoBound)); 2537 if (LoOverflow) 2538 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE : 2539 ICmpInst::ICMP_UGE, X, 2540 ConstantInt::get(Div->getType(), HiBound)); 2541 return replaceInstUsesWith(Cmp, 2542 insertRangeTest(X, LoBound, HiBound, 2543 DivIsSigned, false)); 2544 case ICmpInst::ICMP_ULT: 2545 case ICmpInst::ICMP_SLT: 2546 if (LoOverflow == +1) // Low bound is greater than input range. 2547 return replaceInstUsesWith(Cmp, Builder.getTrue()); 2548 if (LoOverflow == -1) // Low bound is less than input range. 2549 return replaceInstUsesWith(Cmp, Builder.getFalse()); 2550 return new ICmpInst(Pred, X, ConstantInt::get(Div->getType(), LoBound)); 2551 case ICmpInst::ICMP_UGT: 2552 case ICmpInst::ICMP_SGT: 2553 if (HiOverflow == +1) // High bound greater than input range. 2554 return replaceInstUsesWith(Cmp, Builder.getFalse()); 2555 if (HiOverflow == -1) // High bound less than input range. 2556 return replaceInstUsesWith(Cmp, Builder.getTrue()); 2557 if (Pred == ICmpInst::ICMP_UGT) 2558 return new ICmpInst(ICmpInst::ICMP_UGE, X, 2559 ConstantInt::get(Div->getType(), HiBound)); 2560 return new ICmpInst(ICmpInst::ICMP_SGE, X, 2561 ConstantInt::get(Div->getType(), HiBound)); 2562 } 2563 2564 return nullptr; 2565 } 2566 2567 /// Fold icmp (sub X, Y), C. 2568 Instruction *InstCombinerImpl::foldICmpSubConstant(ICmpInst &Cmp, 2569 BinaryOperator *Sub, 2570 const APInt &C) { 2571 Value *X = Sub->getOperand(0), *Y = Sub->getOperand(1); 2572 ICmpInst::Predicate Pred = Cmp.getPredicate(); 2573 Type *Ty = Sub->getType(); 2574 2575 // (SubC - Y) == C) --> Y == (SubC - C) 2576 // (SubC - Y) != C) --> Y != (SubC - C) 2577 Constant *SubC; 2578 if (Cmp.isEquality() && match(X, m_ImmConstant(SubC))) { 2579 return new ICmpInst(Pred, Y, 2580 ConstantExpr::getSub(SubC, ConstantInt::get(Ty, C))); 2581 } 2582 2583 // (icmp P (sub nuw|nsw C2, Y), C) -> (icmp swap(P) Y, C2-C) 2584 const APInt *C2; 2585 APInt SubResult; 2586 ICmpInst::Predicate SwappedPred = Cmp.getSwappedPredicate(); 2587 bool HasNSW = Sub->hasNoSignedWrap(); 2588 bool HasNUW = Sub->hasNoUnsignedWrap(); 2589 if (match(X, m_APInt(C2)) && 2590 ((Cmp.isUnsigned() && HasNUW) || (Cmp.isSigned() && HasNSW)) && 2591 !subWithOverflow(SubResult, *C2, C, Cmp.isSigned())) 2592 return new ICmpInst(SwappedPred, Y, ConstantInt::get(Ty, SubResult)); 2593 2594 // X - Y == 0 --> X == Y. 2595 // X - Y != 0 --> X != Y. 2596 if (Cmp.isEquality() && C.isZero()) 2597 return new ICmpInst(Pred, X, Y); 2598 2599 // The following transforms are only worth it if the only user of the subtract 2600 // is the icmp. 2601 // TODO: This is an artificial restriction for all of the transforms below 2602 // that only need a single replacement icmp. 2603 if (!Sub->hasOneUse()) 2604 return nullptr; 2605 2606 if (Sub->hasNoSignedWrap()) { 2607 // (icmp sgt (sub nsw X, Y), -1) -> (icmp sge X, Y) 2608 if (Pred == ICmpInst::ICMP_SGT && C.isAllOnes()) 2609 return new ICmpInst(ICmpInst::ICMP_SGE, X, Y); 2610 2611 // (icmp sgt (sub nsw X, Y), 0) -> (icmp sgt X, Y) 2612 if (Pred == ICmpInst::ICMP_SGT && C.isZero()) 2613 return new ICmpInst(ICmpInst::ICMP_SGT, X, Y); 2614 2615 // (icmp slt (sub nsw X, Y), 0) -> (icmp slt X, Y) 2616 if (Pred == ICmpInst::ICMP_SLT && C.isZero()) 2617 return new ICmpInst(ICmpInst::ICMP_SLT, X, Y); 2618 2619 // (icmp slt (sub nsw X, Y), 1) -> (icmp sle X, Y) 2620 if (Pred == ICmpInst::ICMP_SLT && C.isOne()) 2621 return new ICmpInst(ICmpInst::ICMP_SLE, X, Y); 2622 } 2623 2624 if (!match(X, m_APInt(C2))) 2625 return nullptr; 2626 2627 // C2 - Y <u C -> (Y | (C - 1)) == C2 2628 // iff (C2 & (C - 1)) == C - 1 and C is a power of 2 2629 if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() && 2630 (*C2 & (C - 1)) == (C - 1)) 2631 return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateOr(Y, C - 1), X); 2632 2633 // C2 - Y >u C -> (Y | C) != C2 2634 // iff C2 & C == C and C + 1 is a power of 2 2635 if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == C) 2636 return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateOr(Y, C), X); 2637 2638 // We have handled special cases that reduce. 2639 // Canonicalize any remaining sub to add as: 2640 // (C2 - Y) > C --> (Y + ~C2) < ~C 2641 Value *Add = Builder.CreateAdd(Y, ConstantInt::get(Ty, ~(*C2)), "notsub", 2642 HasNUW, HasNSW); 2643 return new ICmpInst(SwappedPred, Add, ConstantInt::get(Ty, ~C)); 2644 } 2645 2646 /// Fold icmp (add X, Y), C. 2647 Instruction *InstCombinerImpl::foldICmpAddConstant(ICmpInst &Cmp, 2648 BinaryOperator *Add, 2649 const APInt &C) { 2650 Value *Y = Add->getOperand(1); 2651 const APInt *C2; 2652 if (Cmp.isEquality() || !match(Y, m_APInt(C2))) 2653 return nullptr; 2654 2655 // Fold icmp pred (add X, C2), C. 2656 Value *X = Add->getOperand(0); 2657 Type *Ty = Add->getType(); 2658 const CmpInst::Predicate Pred = Cmp.getPredicate(); 2659 2660 // If the add does not wrap, we can always adjust the compare by subtracting 2661 // the constants. Equality comparisons are handled elsewhere. SGE/SLE/UGE/ULE 2662 // are canonicalized to SGT/SLT/UGT/ULT. 2663 if ((Add->hasNoSignedWrap() && 2664 (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLT)) || 2665 (Add->hasNoUnsignedWrap() && 2666 (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULT))) { 2667 bool Overflow; 2668 APInt NewC = 2669 Cmp.isSigned() ? C.ssub_ov(*C2, Overflow) : C.usub_ov(*C2, Overflow); 2670 // If there is overflow, the result must be true or false. 2671 // TODO: Can we assert there is no overflow because InstSimplify always 2672 // handles those cases? 2673 if (!Overflow) 2674 // icmp Pred (add nsw X, C2), C --> icmp Pred X, (C - C2) 2675 return new ICmpInst(Pred, X, ConstantInt::get(Ty, NewC)); 2676 } 2677 2678 auto CR = ConstantRange::makeExactICmpRegion(Pred, C).subtract(*C2); 2679 const APInt &Upper = CR.getUpper(); 2680 const APInt &Lower = CR.getLower(); 2681 if (Cmp.isSigned()) { 2682 if (Lower.isSignMask()) 2683 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, Upper)); 2684 if (Upper.isSignMask()) 2685 return new ICmpInst(ICmpInst::ICMP_SGE, X, ConstantInt::get(Ty, Lower)); 2686 } else { 2687 if (Lower.isMinValue()) 2688 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, Upper)); 2689 if (Upper.isMinValue()) 2690 return new ICmpInst(ICmpInst::ICMP_UGE, X, ConstantInt::get(Ty, Lower)); 2691 } 2692 2693 // This set of folds is intentionally placed after folds that use no-wrapping 2694 // flags because those folds are likely better for later analysis/codegen. 2695 const APInt SMax = APInt::getSignedMaxValue(Ty->getScalarSizeInBits()); 2696 const APInt SMin = APInt::getSignedMinValue(Ty->getScalarSizeInBits()); 2697 2698 // Fold compare with offset to opposite sign compare if it eliminates offset: 2699 // (X + C2) >u C --> X <s -C2 (if C == C2 + SMAX) 2700 if (Pred == CmpInst::ICMP_UGT && C == *C2 + SMax) 2701 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, -(*C2))); 2702 2703 // (X + C2) <u C --> X >s ~C2 (if C == C2 + SMIN) 2704 if (Pred == CmpInst::ICMP_ULT && C == *C2 + SMin) 2705 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantInt::get(Ty, ~(*C2))); 2706 2707 // (X + C2) >s C --> X <u (SMAX - C) (if C == C2 - 1) 2708 if (Pred == CmpInst::ICMP_SGT && C == *C2 - 1) 2709 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, SMax - C)); 2710 2711 // (X + C2) <s C --> X >u (C ^ SMAX) (if C == C2) 2712 if (Pred == CmpInst::ICMP_SLT && C == *C2) 2713 return new ICmpInst(ICmpInst::ICMP_UGT, X, ConstantInt::get(Ty, C ^ SMax)); 2714 2715 if (!Add->hasOneUse()) 2716 return nullptr; 2717 2718 // X+C <u C2 -> (X & -C2) == C 2719 // iff C & (C2-1) == 0 2720 // C2 is a power of 2 2721 if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() && (*C2 & (C - 1)) == 0) 2722 return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateAnd(X, -C), 2723 ConstantExpr::getNeg(cast<Constant>(Y))); 2724 2725 // X+C >u C2 -> (X & ~C2) != C 2726 // iff C & C2 == 0 2727 // C2+1 is a power of 2 2728 if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == 0) 2729 return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateAnd(X, ~C), 2730 ConstantExpr::getNeg(cast<Constant>(Y))); 2731 2732 // The range test idiom can use either ult or ugt. Arbitrarily canonicalize 2733 // to the ult form. 2734 // X+C2 >u C -> X+(C2-C-1) <u ~C 2735 if (Pred == ICmpInst::ICMP_UGT) 2736 return new ICmpInst(ICmpInst::ICMP_ULT, 2737 Builder.CreateAdd(X, ConstantInt::get(Ty, *C2 - C - 1)), 2738 ConstantInt::get(Ty, ~C)); 2739 2740 return nullptr; 2741 } 2742 2743 bool InstCombinerImpl::matchThreeWayIntCompare(SelectInst *SI, Value *&LHS, 2744 Value *&RHS, ConstantInt *&Less, 2745 ConstantInt *&Equal, 2746 ConstantInt *&Greater) { 2747 // TODO: Generalize this to work with other comparison idioms or ensure 2748 // they get canonicalized into this form. 2749 2750 // select i1 (a == b), 2751 // i32 Equal, 2752 // i32 (select i1 (a < b), i32 Less, i32 Greater) 2753 // where Equal, Less and Greater are placeholders for any three constants. 2754 ICmpInst::Predicate PredA; 2755 if (!match(SI->getCondition(), m_ICmp(PredA, m_Value(LHS), m_Value(RHS))) || 2756 !ICmpInst::isEquality(PredA)) 2757 return false; 2758 Value *EqualVal = SI->getTrueValue(); 2759 Value *UnequalVal = SI->getFalseValue(); 2760 // We still can get non-canonical predicate here, so canonicalize. 2761 if (PredA == ICmpInst::ICMP_NE) 2762 std::swap(EqualVal, UnequalVal); 2763 if (!match(EqualVal, m_ConstantInt(Equal))) 2764 return false; 2765 ICmpInst::Predicate PredB; 2766 Value *LHS2, *RHS2; 2767 if (!match(UnequalVal, m_Select(m_ICmp(PredB, m_Value(LHS2), m_Value(RHS2)), 2768 m_ConstantInt(Less), m_ConstantInt(Greater)))) 2769 return false; 2770 // We can get predicate mismatch here, so canonicalize if possible: 2771 // First, ensure that 'LHS' match. 2772 if (LHS2 != LHS) { 2773 // x sgt y <--> y slt x 2774 std::swap(LHS2, RHS2); 2775 PredB = ICmpInst::getSwappedPredicate(PredB); 2776 } 2777 if (LHS2 != LHS) 2778 return false; 2779 // We also need to canonicalize 'RHS'. 2780 if (PredB == ICmpInst::ICMP_SGT && isa<Constant>(RHS2)) { 2781 // x sgt C-1 <--> x sge C <--> not(x slt C) 2782 auto FlippedStrictness = 2783 InstCombiner::getFlippedStrictnessPredicateAndConstant( 2784 PredB, cast<Constant>(RHS2)); 2785 if (!FlippedStrictness) 2786 return false; 2787 assert(FlippedStrictness->first == ICmpInst::ICMP_SGE && 2788 "basic correctness failure"); 2789 RHS2 = FlippedStrictness->second; 2790 // And kind-of perform the result swap. 2791 std::swap(Less, Greater); 2792 PredB = ICmpInst::ICMP_SLT; 2793 } 2794 return PredB == ICmpInst::ICMP_SLT && RHS == RHS2; 2795 } 2796 2797 Instruction *InstCombinerImpl::foldICmpSelectConstant(ICmpInst &Cmp, 2798 SelectInst *Select, 2799 ConstantInt *C) { 2800 2801 assert(C && "Cmp RHS should be a constant int!"); 2802 // If we're testing a constant value against the result of a three way 2803 // comparison, the result can be expressed directly in terms of the 2804 // original values being compared. Note: We could possibly be more 2805 // aggressive here and remove the hasOneUse test. The original select is 2806 // really likely to simplify or sink when we remove a test of the result. 2807 Value *OrigLHS, *OrigRHS; 2808 ConstantInt *C1LessThan, *C2Equal, *C3GreaterThan; 2809 if (Cmp.hasOneUse() && 2810 matchThreeWayIntCompare(Select, OrigLHS, OrigRHS, C1LessThan, C2Equal, 2811 C3GreaterThan)) { 2812 assert(C1LessThan && C2Equal && C3GreaterThan); 2813 2814 bool TrueWhenLessThan = 2815 ConstantExpr::getCompare(Cmp.getPredicate(), C1LessThan, C) 2816 ->isAllOnesValue(); 2817 bool TrueWhenEqual = 2818 ConstantExpr::getCompare(Cmp.getPredicate(), C2Equal, C) 2819 ->isAllOnesValue(); 2820 bool TrueWhenGreaterThan = 2821 ConstantExpr::getCompare(Cmp.getPredicate(), C3GreaterThan, C) 2822 ->isAllOnesValue(); 2823 2824 // This generates the new instruction that will replace the original Cmp 2825 // Instruction. Instead of enumerating the various combinations when 2826 // TrueWhenLessThan, TrueWhenEqual and TrueWhenGreaterThan are true versus 2827 // false, we rely on chaining of ORs and future passes of InstCombine to 2828 // simplify the OR further (i.e. a s< b || a == b becomes a s<= b). 2829 2830 // When none of the three constants satisfy the predicate for the RHS (C), 2831 // the entire original Cmp can be simplified to a false. 2832 Value *Cond = Builder.getFalse(); 2833 if (TrueWhenLessThan) 2834 Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SLT, 2835 OrigLHS, OrigRHS)); 2836 if (TrueWhenEqual) 2837 Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_EQ, 2838 OrigLHS, OrigRHS)); 2839 if (TrueWhenGreaterThan) 2840 Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SGT, 2841 OrigLHS, OrigRHS)); 2842 2843 return replaceInstUsesWith(Cmp, Cond); 2844 } 2845 return nullptr; 2846 } 2847 2848 Instruction *InstCombinerImpl::foldICmpBitCast(ICmpInst &Cmp) { 2849 auto *Bitcast = dyn_cast<BitCastInst>(Cmp.getOperand(0)); 2850 if (!Bitcast) 2851 return nullptr; 2852 2853 ICmpInst::Predicate Pred = Cmp.getPredicate(); 2854 Value *Op1 = Cmp.getOperand(1); 2855 Value *BCSrcOp = Bitcast->getOperand(0); 2856 2857 // Make sure the bitcast doesn't change the number of vector elements. 2858 if (Bitcast->getSrcTy()->getScalarSizeInBits() == 2859 Bitcast->getDestTy()->getScalarSizeInBits()) { 2860 // Zero-equality and sign-bit checks are preserved through sitofp + bitcast. 2861 Value *X; 2862 if (match(BCSrcOp, m_SIToFP(m_Value(X)))) { 2863 // icmp eq (bitcast (sitofp X)), 0 --> icmp eq X, 0 2864 // icmp ne (bitcast (sitofp X)), 0 --> icmp ne X, 0 2865 // icmp slt (bitcast (sitofp X)), 0 --> icmp slt X, 0 2866 // icmp sgt (bitcast (sitofp X)), 0 --> icmp sgt X, 0 2867 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_SLT || 2868 Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT) && 2869 match(Op1, m_Zero())) 2870 return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType())); 2871 2872 // icmp slt (bitcast (sitofp X)), 1 --> icmp slt X, 1 2873 if (Pred == ICmpInst::ICMP_SLT && match(Op1, m_One())) 2874 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), 1)); 2875 2876 // icmp sgt (bitcast (sitofp X)), -1 --> icmp sgt X, -1 2877 if (Pred == ICmpInst::ICMP_SGT && match(Op1, m_AllOnes())) 2878 return new ICmpInst(Pred, X, 2879 ConstantInt::getAllOnesValue(X->getType())); 2880 } 2881 2882 // Zero-equality checks are preserved through unsigned floating-point casts: 2883 // icmp eq (bitcast (uitofp X)), 0 --> icmp eq X, 0 2884 // icmp ne (bitcast (uitofp X)), 0 --> icmp ne X, 0 2885 if (match(BCSrcOp, m_UIToFP(m_Value(X)))) 2886 if (Cmp.isEquality() && match(Op1, m_Zero())) 2887 return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType())); 2888 2889 // If this is a sign-bit test of a bitcast of a casted FP value, eliminate 2890 // the FP extend/truncate because that cast does not change the sign-bit. 2891 // This is true for all standard IEEE-754 types and the X86 80-bit type. 2892 // The sign-bit is always the most significant bit in those types. 2893 const APInt *C; 2894 bool TrueIfSigned; 2895 if (match(Op1, m_APInt(C)) && Bitcast->hasOneUse() && 2896 InstCombiner::isSignBitCheck(Pred, *C, TrueIfSigned)) { 2897 if (match(BCSrcOp, m_FPExt(m_Value(X))) || 2898 match(BCSrcOp, m_FPTrunc(m_Value(X)))) { 2899 // (bitcast (fpext/fptrunc X)) to iX) < 0 --> (bitcast X to iY) < 0 2900 // (bitcast (fpext/fptrunc X)) to iX) > -1 --> (bitcast X to iY) > -1 2901 Type *XType = X->getType(); 2902 2903 // We can't currently handle Power style floating point operations here. 2904 if (!(XType->isPPC_FP128Ty() || BCSrcOp->getType()->isPPC_FP128Ty())) { 2905 2906 Type *NewType = Builder.getIntNTy(XType->getScalarSizeInBits()); 2907 if (auto *XVTy = dyn_cast<VectorType>(XType)) 2908 NewType = VectorType::get(NewType, XVTy->getElementCount()); 2909 Value *NewBitcast = Builder.CreateBitCast(X, NewType); 2910 if (TrueIfSigned) 2911 return new ICmpInst(ICmpInst::ICMP_SLT, NewBitcast, 2912 ConstantInt::getNullValue(NewType)); 2913 else 2914 return new ICmpInst(ICmpInst::ICMP_SGT, NewBitcast, 2915 ConstantInt::getAllOnesValue(NewType)); 2916 } 2917 } 2918 } 2919 } 2920 2921 // Test to see if the operands of the icmp are casted versions of other 2922 // values. If the ptr->ptr cast can be stripped off both arguments, do so. 2923 if (Bitcast->getType()->isPointerTy() && 2924 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) { 2925 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast 2926 // so eliminate it as well. 2927 if (auto *BC2 = dyn_cast<BitCastInst>(Op1)) 2928 Op1 = BC2->getOperand(0); 2929 2930 Op1 = Builder.CreateBitCast(Op1, BCSrcOp->getType()); 2931 return new ICmpInst(Pred, BCSrcOp, Op1); 2932 } 2933 2934 const APInt *C; 2935 if (!match(Cmp.getOperand(1), m_APInt(C)) || 2936 !Bitcast->getType()->isIntegerTy() || 2937 !Bitcast->getSrcTy()->isIntOrIntVectorTy()) 2938 return nullptr; 2939 2940 // If this is checking if all elements of a vector compare are set or not, 2941 // invert the casted vector equality compare and test if all compare 2942 // elements are clear or not. Compare against zero is generally easier for 2943 // analysis and codegen. 2944 // icmp eq/ne (bitcast (not X) to iN), -1 --> icmp eq/ne (bitcast X to iN), 0 2945 // Example: are all elements equal? --> are zero elements not equal? 2946 // TODO: Try harder to reduce compare of 2 freely invertible operands? 2947 if (Cmp.isEquality() && C->isAllOnes() && Bitcast->hasOneUse() && 2948 isFreeToInvert(BCSrcOp, BCSrcOp->hasOneUse())) { 2949 Type *ScalarTy = Bitcast->getType(); 2950 Value *Cast = Builder.CreateBitCast(Builder.CreateNot(BCSrcOp), ScalarTy); 2951 return new ICmpInst(Pred, Cast, ConstantInt::getNullValue(ScalarTy)); 2952 } 2953 2954 // If this is checking if all elements of an extended vector are clear or not, 2955 // compare in a narrow type to eliminate the extend: 2956 // icmp eq/ne (bitcast (ext X) to iN), 0 --> icmp eq/ne (bitcast X to iM), 0 2957 Value *X; 2958 if (Cmp.isEquality() && C->isZero() && Bitcast->hasOneUse() && 2959 match(BCSrcOp, m_ZExtOrSExt(m_Value(X)))) { 2960 if (auto *VecTy = dyn_cast<FixedVectorType>(X->getType())) { 2961 Type *NewType = Builder.getIntNTy(VecTy->getPrimitiveSizeInBits()); 2962 Value *NewCast = Builder.CreateBitCast(X, NewType); 2963 return new ICmpInst(Pred, NewCast, ConstantInt::getNullValue(NewType)); 2964 } 2965 } 2966 2967 // Folding: icmp <pred> iN X, C 2968 // where X = bitcast <M x iK> (shufflevector <M x iK> %vec, undef, SC)) to iN 2969 // and C is a splat of a K-bit pattern 2970 // and SC is a constant vector = <C', C', C', ..., C'> 2971 // Into: 2972 // %E = extractelement <M x iK> %vec, i32 C' 2973 // icmp <pred> iK %E, trunc(C) 2974 Value *Vec; 2975 ArrayRef<int> Mask; 2976 if (match(BCSrcOp, m_Shuffle(m_Value(Vec), m_Undef(), m_Mask(Mask)))) { 2977 // Check whether every element of Mask is the same constant 2978 if (is_splat(Mask)) { 2979 auto *VecTy = cast<VectorType>(BCSrcOp->getType()); 2980 auto *EltTy = cast<IntegerType>(VecTy->getElementType()); 2981 if (C->isSplat(EltTy->getBitWidth())) { 2982 // Fold the icmp based on the value of C 2983 // If C is M copies of an iK sized bit pattern, 2984 // then: 2985 // => %E = extractelement <N x iK> %vec, i32 Elem 2986 // icmp <pred> iK %SplatVal, <pattern> 2987 Value *Elem = Builder.getInt32(Mask[0]); 2988 Value *Extract = Builder.CreateExtractElement(Vec, Elem); 2989 Value *NewC = ConstantInt::get(EltTy, C->trunc(EltTy->getBitWidth())); 2990 return new ICmpInst(Pred, Extract, NewC); 2991 } 2992 } 2993 } 2994 return nullptr; 2995 } 2996 2997 /// Try to fold integer comparisons with a constant operand: icmp Pred X, C 2998 /// where X is some kind of instruction. 2999 Instruction *InstCombinerImpl::foldICmpInstWithConstant(ICmpInst &Cmp) { 3000 const APInt *C; 3001 if (!match(Cmp.getOperand(1), m_APInt(C))) 3002 return nullptr; 3003 3004 if (auto *BO = dyn_cast<BinaryOperator>(Cmp.getOperand(0))) { 3005 switch (BO->getOpcode()) { 3006 case Instruction::Xor: 3007 if (Instruction *I = foldICmpXorConstant(Cmp, BO, *C)) 3008 return I; 3009 break; 3010 case Instruction::And: 3011 if (Instruction *I = foldICmpAndConstant(Cmp, BO, *C)) 3012 return I; 3013 break; 3014 case Instruction::Or: 3015 if (Instruction *I = foldICmpOrConstant(Cmp, BO, *C)) 3016 return I; 3017 break; 3018 case Instruction::Mul: 3019 if (Instruction *I = foldICmpMulConstant(Cmp, BO, *C)) 3020 return I; 3021 break; 3022 case Instruction::Shl: 3023 if (Instruction *I = foldICmpShlConstant(Cmp, BO, *C)) 3024 return I; 3025 break; 3026 case Instruction::LShr: 3027 case Instruction::AShr: 3028 if (Instruction *I = foldICmpShrConstant(Cmp, BO, *C)) 3029 return I; 3030 break; 3031 case Instruction::SRem: 3032 if (Instruction *I = foldICmpSRemConstant(Cmp, BO, *C)) 3033 return I; 3034 break; 3035 case Instruction::UDiv: 3036 if (Instruction *I = foldICmpUDivConstant(Cmp, BO, *C)) 3037 return I; 3038 LLVM_FALLTHROUGH; 3039 case Instruction::SDiv: 3040 if (Instruction *I = foldICmpDivConstant(Cmp, BO, *C)) 3041 return I; 3042 break; 3043 case Instruction::Sub: 3044 if (Instruction *I = foldICmpSubConstant(Cmp, BO, *C)) 3045 return I; 3046 break; 3047 case Instruction::Add: 3048 if (Instruction *I = foldICmpAddConstant(Cmp, BO, *C)) 3049 return I; 3050 break; 3051 default: 3052 break; 3053 } 3054 // TODO: These folds could be refactored to be part of the above calls. 3055 if (Instruction *I = foldICmpBinOpEqualityWithConstant(Cmp, BO, *C)) 3056 return I; 3057 } 3058 3059 // Match against CmpInst LHS being instructions other than binary operators. 3060 3061 if (auto *SI = dyn_cast<SelectInst>(Cmp.getOperand(0))) { 3062 // For now, we only support constant integers while folding the 3063 // ICMP(SELECT)) pattern. We can extend this to support vector of integers 3064 // similar to the cases handled by binary ops above. 3065 if (ConstantInt *ConstRHS = dyn_cast<ConstantInt>(Cmp.getOperand(1))) 3066 if (Instruction *I = foldICmpSelectConstant(Cmp, SI, ConstRHS)) 3067 return I; 3068 } 3069 3070 if (auto *TI = dyn_cast<TruncInst>(Cmp.getOperand(0))) { 3071 if (Instruction *I = foldICmpTruncConstant(Cmp, TI, *C)) 3072 return I; 3073 } 3074 3075 if (auto *II = dyn_cast<IntrinsicInst>(Cmp.getOperand(0))) 3076 if (Instruction *I = foldICmpIntrinsicWithConstant(Cmp, II, *C)) 3077 return I; 3078 3079 return nullptr; 3080 } 3081 3082 /// Fold an icmp equality instruction with binary operator LHS and constant RHS: 3083 /// icmp eq/ne BO, C. 3084 Instruction *InstCombinerImpl::foldICmpBinOpEqualityWithConstant( 3085 ICmpInst &Cmp, BinaryOperator *BO, const APInt &C) { 3086 // TODO: Some of these folds could work with arbitrary constants, but this 3087 // function is limited to scalar and vector splat constants. 3088 if (!Cmp.isEquality()) 3089 return nullptr; 3090 3091 ICmpInst::Predicate Pred = Cmp.getPredicate(); 3092 bool isICMP_NE = Pred == ICmpInst::ICMP_NE; 3093 Constant *RHS = cast<Constant>(Cmp.getOperand(1)); 3094 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1); 3095 3096 switch (BO->getOpcode()) { 3097 case Instruction::SRem: 3098 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one. 3099 if (C.isZero() && BO->hasOneUse()) { 3100 const APInt *BOC; 3101 if (match(BOp1, m_APInt(BOC)) && BOC->sgt(1) && BOC->isPowerOf2()) { 3102 Value *NewRem = Builder.CreateURem(BOp0, BOp1, BO->getName()); 3103 return new ICmpInst(Pred, NewRem, 3104 Constant::getNullValue(BO->getType())); 3105 } 3106 } 3107 break; 3108 case Instruction::Add: { 3109 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants. 3110 if (Constant *BOC = dyn_cast<Constant>(BOp1)) { 3111 if (BO->hasOneUse()) 3112 return new ICmpInst(Pred, BOp0, ConstantExpr::getSub(RHS, BOC)); 3113 } else if (C.isZero()) { 3114 // Replace ((add A, B) != 0) with (A != -B) if A or B is 3115 // efficiently invertible, or if the add has just this one use. 3116 if (Value *NegVal = dyn_castNegVal(BOp1)) 3117 return new ICmpInst(Pred, BOp0, NegVal); 3118 if (Value *NegVal = dyn_castNegVal(BOp0)) 3119 return new ICmpInst(Pred, NegVal, BOp1); 3120 if (BO->hasOneUse()) { 3121 Value *Neg = Builder.CreateNeg(BOp1); 3122 Neg->takeName(BO); 3123 return new ICmpInst(Pred, BOp0, Neg); 3124 } 3125 } 3126 break; 3127 } 3128 case Instruction::Xor: 3129 if (BO->hasOneUse()) { 3130 if (Constant *BOC = dyn_cast<Constant>(BOp1)) { 3131 // For the xor case, we can xor two constants together, eliminating 3132 // the explicit xor. 3133 return new ICmpInst(Pred, BOp0, ConstantExpr::getXor(RHS, BOC)); 3134 } else if (C.isZero()) { 3135 // Replace ((xor A, B) != 0) with (A != B) 3136 return new ICmpInst(Pred, BOp0, BOp1); 3137 } 3138 } 3139 break; 3140 case Instruction::Or: { 3141 const APInt *BOC; 3142 if (match(BOp1, m_APInt(BOC)) && BO->hasOneUse() && RHS->isAllOnesValue()) { 3143 // Comparing if all bits outside of a constant mask are set? 3144 // Replace (X | C) == -1 with (X & ~C) == ~C. 3145 // This removes the -1 constant. 3146 Constant *NotBOC = ConstantExpr::getNot(cast<Constant>(BOp1)); 3147 Value *And = Builder.CreateAnd(BOp0, NotBOC); 3148 return new ICmpInst(Pred, And, NotBOC); 3149 } 3150 break; 3151 } 3152 case Instruction::And: { 3153 const APInt *BOC; 3154 if (match(BOp1, m_APInt(BOC))) { 3155 // If we have ((X & C) == C), turn it into ((X & C) != 0). 3156 if (C == *BOC && C.isPowerOf2()) 3157 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE, 3158 BO, Constant::getNullValue(RHS->getType())); 3159 } 3160 break; 3161 } 3162 case Instruction::UDiv: 3163 if (C.isZero()) { 3164 // (icmp eq/ne (udiv A, B), 0) -> (icmp ugt/ule i32 B, A) 3165 auto NewPred = isICMP_NE ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT; 3166 return new ICmpInst(NewPred, BOp1, BOp0); 3167 } 3168 break; 3169 default: 3170 break; 3171 } 3172 return nullptr; 3173 } 3174 3175 /// Fold an equality icmp with LLVM intrinsic and constant operand. 3176 Instruction *InstCombinerImpl::foldICmpEqIntrinsicWithConstant( 3177 ICmpInst &Cmp, IntrinsicInst *II, const APInt &C) { 3178 Type *Ty = II->getType(); 3179 unsigned BitWidth = C.getBitWidth(); 3180 const ICmpInst::Predicate Pred = Cmp.getPredicate(); 3181 3182 switch (II->getIntrinsicID()) { 3183 case Intrinsic::abs: 3184 // abs(A) == 0 -> A == 0 3185 // abs(A) == INT_MIN -> A == INT_MIN 3186 if (C.isZero() || C.isMinSignedValue()) 3187 return new ICmpInst(Pred, II->getArgOperand(0), ConstantInt::get(Ty, C)); 3188 break; 3189 3190 case Intrinsic::bswap: 3191 // bswap(A) == C -> A == bswap(C) 3192 return new ICmpInst(Pred, II->getArgOperand(0), 3193 ConstantInt::get(Ty, C.byteSwap())); 3194 3195 case Intrinsic::ctlz: 3196 case Intrinsic::cttz: { 3197 // ctz(A) == bitwidth(A) -> A == 0 and likewise for != 3198 if (C == BitWidth) 3199 return new ICmpInst(Pred, II->getArgOperand(0), 3200 ConstantInt::getNullValue(Ty)); 3201 3202 // ctz(A) == C -> A & Mask1 == Mask2, where Mask2 only has bit C set 3203 // and Mask1 has bits 0..C+1 set. Similar for ctl, but for high bits. 3204 // Limit to one use to ensure we don't increase instruction count. 3205 unsigned Num = C.getLimitedValue(BitWidth); 3206 if (Num != BitWidth && II->hasOneUse()) { 3207 bool IsTrailing = II->getIntrinsicID() == Intrinsic::cttz; 3208 APInt Mask1 = IsTrailing ? APInt::getLowBitsSet(BitWidth, Num + 1) 3209 : APInt::getHighBitsSet(BitWidth, Num + 1); 3210 APInt Mask2 = IsTrailing 3211 ? APInt::getOneBitSet(BitWidth, Num) 3212 : APInt::getOneBitSet(BitWidth, BitWidth - Num - 1); 3213 return new ICmpInst(Pred, Builder.CreateAnd(II->getArgOperand(0), Mask1), 3214 ConstantInt::get(Ty, Mask2)); 3215 } 3216 break; 3217 } 3218 3219 case Intrinsic::ctpop: { 3220 // popcount(A) == 0 -> A == 0 and likewise for != 3221 // popcount(A) == bitwidth(A) -> A == -1 and likewise for != 3222 bool IsZero = C.isZero(); 3223 if (IsZero || C == BitWidth) 3224 return new ICmpInst(Pred, II->getArgOperand(0), 3225 IsZero ? Constant::getNullValue(Ty) 3226 : Constant::getAllOnesValue(Ty)); 3227 3228 break; 3229 } 3230 3231 case Intrinsic::fshl: 3232 case Intrinsic::fshr: 3233 if (II->getArgOperand(0) == II->getArgOperand(1)) { 3234 // (rot X, ?) == 0/-1 --> X == 0/-1 3235 // TODO: This transform is safe to re-use undef elts in a vector, but 3236 // the constant value passed in by the caller doesn't allow that. 3237 if (C.isZero() || C.isAllOnes()) 3238 return new ICmpInst(Pred, II->getArgOperand(0), Cmp.getOperand(1)); 3239 3240 const APInt *RotAmtC; 3241 // ror(X, RotAmtC) == C --> X == rol(C, RotAmtC) 3242 // rol(X, RotAmtC) == C --> X == ror(C, RotAmtC) 3243 if (match(II->getArgOperand(2), m_APInt(RotAmtC))) 3244 return new ICmpInst(Pred, II->getArgOperand(0), 3245 II->getIntrinsicID() == Intrinsic::fshl 3246 ? ConstantInt::get(Ty, C.rotr(*RotAmtC)) 3247 : ConstantInt::get(Ty, C.rotl(*RotAmtC))); 3248 } 3249 break; 3250 3251 case Intrinsic::uadd_sat: { 3252 // uadd.sat(a, b) == 0 -> (a | b) == 0 3253 if (C.isZero()) { 3254 Value *Or = Builder.CreateOr(II->getArgOperand(0), II->getArgOperand(1)); 3255 return new ICmpInst(Pred, Or, Constant::getNullValue(Ty)); 3256 } 3257 break; 3258 } 3259 3260 case Intrinsic::usub_sat: { 3261 // usub.sat(a, b) == 0 -> a <= b 3262 if (C.isZero()) { 3263 ICmpInst::Predicate NewPred = 3264 Pred == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT; 3265 return new ICmpInst(NewPred, II->getArgOperand(0), II->getArgOperand(1)); 3266 } 3267 break; 3268 } 3269 default: 3270 break; 3271 } 3272 3273 return nullptr; 3274 } 3275 3276 /// Fold an icmp with LLVM intrinsics 3277 static Instruction *foldICmpIntrinsicWithIntrinsic(ICmpInst &Cmp) { 3278 assert(Cmp.isEquality()); 3279 3280 ICmpInst::Predicate Pred = Cmp.getPredicate(); 3281 Value *Op0 = Cmp.getOperand(0); 3282 Value *Op1 = Cmp.getOperand(1); 3283 const auto *IIOp0 = dyn_cast<IntrinsicInst>(Op0); 3284 const auto *IIOp1 = dyn_cast<IntrinsicInst>(Op1); 3285 if (!IIOp0 || !IIOp1 || IIOp0->getIntrinsicID() != IIOp1->getIntrinsicID()) 3286 return nullptr; 3287 3288 switch (IIOp0->getIntrinsicID()) { 3289 case Intrinsic::bswap: 3290 case Intrinsic::bitreverse: 3291 // If both operands are byte-swapped or bit-reversed, just compare the 3292 // original values. 3293 return new ICmpInst(Pred, IIOp0->getOperand(0), IIOp1->getOperand(0)); 3294 case Intrinsic::fshl: 3295 case Intrinsic::fshr: 3296 // If both operands are rotated by same amount, just compare the 3297 // original values. 3298 if (IIOp0->getOperand(0) != IIOp0->getOperand(1)) 3299 break; 3300 if (IIOp1->getOperand(0) != IIOp1->getOperand(1)) 3301 break; 3302 if (IIOp0->getOperand(2) != IIOp1->getOperand(2)) 3303 break; 3304 return new ICmpInst(Pred, IIOp0->getOperand(0), IIOp1->getOperand(0)); 3305 default: 3306 break; 3307 } 3308 3309 return nullptr; 3310 } 3311 3312 /// Fold an icmp with LLVM intrinsic and constant operand: icmp Pred II, C. 3313 Instruction *InstCombinerImpl::foldICmpIntrinsicWithConstant(ICmpInst &Cmp, 3314 IntrinsicInst *II, 3315 const APInt &C) { 3316 if (Cmp.isEquality()) 3317 return foldICmpEqIntrinsicWithConstant(Cmp, II, C); 3318 3319 Type *Ty = II->getType(); 3320 unsigned BitWidth = C.getBitWidth(); 3321 ICmpInst::Predicate Pred = Cmp.getPredicate(); 3322 switch (II->getIntrinsicID()) { 3323 case Intrinsic::ctpop: { 3324 // (ctpop X > BitWidth - 1) --> X == -1 3325 Value *X = II->getArgOperand(0); 3326 if (C == BitWidth - 1 && Pred == ICmpInst::ICMP_UGT) 3327 return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_EQ, X, 3328 ConstantInt::getAllOnesValue(Ty)); 3329 // (ctpop X < BitWidth) --> X != -1 3330 if (C == BitWidth && Pred == ICmpInst::ICMP_ULT) 3331 return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_NE, X, 3332 ConstantInt::getAllOnesValue(Ty)); 3333 break; 3334 } 3335 case Intrinsic::ctlz: { 3336 // ctlz(0bXXXXXXXX) > 3 -> 0bXXXXXXXX < 0b00010000 3337 if (Pred == ICmpInst::ICMP_UGT && C.ult(BitWidth)) { 3338 unsigned Num = C.getLimitedValue(); 3339 APInt Limit = APInt::getOneBitSet(BitWidth, BitWidth - Num - 1); 3340 return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_ULT, 3341 II->getArgOperand(0), ConstantInt::get(Ty, Limit)); 3342 } 3343 3344 // ctlz(0bXXXXXXXX) < 3 -> 0bXXXXXXXX > 0b00011111 3345 if (Pred == ICmpInst::ICMP_ULT && C.uge(1) && C.ule(BitWidth)) { 3346 unsigned Num = C.getLimitedValue(); 3347 APInt Limit = APInt::getLowBitsSet(BitWidth, BitWidth - Num); 3348 return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_UGT, 3349 II->getArgOperand(0), ConstantInt::get(Ty, Limit)); 3350 } 3351 break; 3352 } 3353 case Intrinsic::cttz: { 3354 // Limit to one use to ensure we don't increase instruction count. 3355 if (!II->hasOneUse()) 3356 return nullptr; 3357 3358 // cttz(0bXXXXXXXX) > 3 -> 0bXXXXXXXX & 0b00001111 == 0 3359 if (Pred == ICmpInst::ICMP_UGT && C.ult(BitWidth)) { 3360 APInt Mask = APInt::getLowBitsSet(BitWidth, C.getLimitedValue() + 1); 3361 return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_EQ, 3362 Builder.CreateAnd(II->getArgOperand(0), Mask), 3363 ConstantInt::getNullValue(Ty)); 3364 } 3365 3366 // cttz(0bXXXXXXXX) < 3 -> 0bXXXXXXXX & 0b00000111 != 0 3367 if (Pred == ICmpInst::ICMP_ULT && C.uge(1) && C.ule(BitWidth)) { 3368 APInt Mask = APInt::getLowBitsSet(BitWidth, C.getLimitedValue()); 3369 return CmpInst::Create(Instruction::ICmp, ICmpInst::ICMP_NE, 3370 Builder.CreateAnd(II->getArgOperand(0), Mask), 3371 ConstantInt::getNullValue(Ty)); 3372 } 3373 break; 3374 } 3375 default: 3376 break; 3377 } 3378 3379 return nullptr; 3380 } 3381 3382 /// Handle icmp with constant (but not simple integer constant) RHS. 3383 Instruction *InstCombinerImpl::foldICmpInstWithConstantNotInt(ICmpInst &I) { 3384 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 3385 Constant *RHSC = dyn_cast<Constant>(Op1); 3386 Instruction *LHSI = dyn_cast<Instruction>(Op0); 3387 if (!RHSC || !LHSI) 3388 return nullptr; 3389 3390 switch (LHSI->getOpcode()) { 3391 case Instruction::GetElementPtr: 3392 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null 3393 if (RHSC->isNullValue() && 3394 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices()) 3395 return new ICmpInst( 3396 I.getPredicate(), LHSI->getOperand(0), 3397 Constant::getNullValue(LHSI->getOperand(0)->getType())); 3398 break; 3399 case Instruction::PHI: 3400 // Only fold icmp into the PHI if the phi and icmp are in the same 3401 // block. If in the same block, we're encouraging jump threading. If 3402 // not, we are just pessimizing the code by making an i1 phi. 3403 if (LHSI->getParent() == I.getParent()) 3404 if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI))) 3405 return NV; 3406 break; 3407 case Instruction::Select: { 3408 // If either operand of the select is a constant, we can fold the 3409 // comparison into the select arms, which will cause one to be 3410 // constant folded and the select turned into a bitwise or. 3411 Value *Op1 = nullptr, *Op2 = nullptr; 3412 ConstantInt *CI = nullptr; 3413 3414 auto SimplifyOp = [&](Value *V) { 3415 Value *Op = nullptr; 3416 if (Constant *C = dyn_cast<Constant>(V)) { 3417 Op = ConstantExpr::getICmp(I.getPredicate(), C, RHSC); 3418 } else if (RHSC->isNullValue()) { 3419 // If null is being compared, check if it can be further simplified. 3420 Op = SimplifyICmpInst(I.getPredicate(), V, RHSC, SQ); 3421 } 3422 return Op; 3423 }; 3424 Op1 = SimplifyOp(LHSI->getOperand(1)); 3425 if (Op1) 3426 CI = dyn_cast<ConstantInt>(Op1); 3427 3428 Op2 = SimplifyOp(LHSI->getOperand(2)); 3429 if (Op2) 3430 CI = dyn_cast<ConstantInt>(Op2); 3431 3432 // We only want to perform this transformation if it will not lead to 3433 // additional code. This is true if either both sides of the select 3434 // fold to a constant (in which case the icmp is replaced with a select 3435 // which will usually simplify) or this is the only user of the 3436 // select (in which case we are trading a select+icmp for a simpler 3437 // select+icmp) or all uses of the select can be replaced based on 3438 // dominance information ("Global cases"). 3439 bool Transform = false; 3440 if (Op1 && Op2) 3441 Transform = true; 3442 else if (Op1 || Op2) { 3443 // Local case 3444 if (LHSI->hasOneUse()) 3445 Transform = true; 3446 // Global cases 3447 else if (CI && !CI->isZero()) 3448 // When Op1 is constant try replacing select with second operand. 3449 // Otherwise Op2 is constant and try replacing select with first 3450 // operand. 3451 Transform = 3452 replacedSelectWithOperand(cast<SelectInst>(LHSI), &I, Op1 ? 2 : 1); 3453 } 3454 if (Transform) { 3455 if (!Op1) 3456 Op1 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(1), RHSC, 3457 I.getName()); 3458 if (!Op2) 3459 Op2 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(2), RHSC, 3460 I.getName()); 3461 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2); 3462 } 3463 break; 3464 } 3465 case Instruction::IntToPtr: 3466 // icmp pred inttoptr(X), null -> icmp pred X, 0 3467 if (RHSC->isNullValue() && 3468 DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType()) 3469 return new ICmpInst( 3470 I.getPredicate(), LHSI->getOperand(0), 3471 Constant::getNullValue(LHSI->getOperand(0)->getType())); 3472 break; 3473 3474 case Instruction::Load: 3475 // Try to optimize things like "A[i] > 4" to index computations. 3476 if (GetElementPtrInst *GEP = 3477 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) 3478 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0))) 3479 if (Instruction *Res = 3480 foldCmpLoadFromIndexedGlobal(cast<LoadInst>(LHSI), GEP, GV, I)) 3481 return Res; 3482 break; 3483 } 3484 3485 return nullptr; 3486 } 3487 3488 /// Some comparisons can be simplified. 3489 /// In this case, we are looking for comparisons that look like 3490 /// a check for a lossy truncation. 3491 /// Folds: 3492 /// icmp SrcPred (x & Mask), x to icmp DstPred x, Mask 3493 /// Where Mask is some pattern that produces all-ones in low bits: 3494 /// (-1 >> y) 3495 /// ((-1 << y) >> y) <- non-canonical, has extra uses 3496 /// ~(-1 << y) 3497 /// ((1 << y) + (-1)) <- non-canonical, has extra uses 3498 /// The Mask can be a constant, too. 3499 /// For some predicates, the operands are commutative. 3500 /// For others, x can only be on a specific side. 3501 static Value *foldICmpWithLowBitMaskedVal(ICmpInst &I, 3502 InstCombiner::BuilderTy &Builder) { 3503 ICmpInst::Predicate SrcPred; 3504 Value *X, *M, *Y; 3505 auto m_VariableMask = m_CombineOr( 3506 m_CombineOr(m_Not(m_Shl(m_AllOnes(), m_Value())), 3507 m_Add(m_Shl(m_One(), m_Value()), m_AllOnes())), 3508 m_CombineOr(m_LShr(m_AllOnes(), m_Value()), 3509 m_LShr(m_Shl(m_AllOnes(), m_Value(Y)), m_Deferred(Y)))); 3510 auto m_Mask = m_CombineOr(m_VariableMask, m_LowBitMask()); 3511 if (!match(&I, m_c_ICmp(SrcPred, 3512 m_c_And(m_CombineAnd(m_Mask, m_Value(M)), m_Value(X)), 3513 m_Deferred(X)))) 3514 return nullptr; 3515 3516 ICmpInst::Predicate DstPred; 3517 switch (SrcPred) { 3518 case ICmpInst::Predicate::ICMP_EQ: 3519 // x & (-1 >> y) == x -> x u<= (-1 >> y) 3520 DstPred = ICmpInst::Predicate::ICMP_ULE; 3521 break; 3522 case ICmpInst::Predicate::ICMP_NE: 3523 // x & (-1 >> y) != x -> x u> (-1 >> y) 3524 DstPred = ICmpInst::Predicate::ICMP_UGT; 3525 break; 3526 case ICmpInst::Predicate::ICMP_ULT: 3527 // x & (-1 >> y) u< x -> x u> (-1 >> y) 3528 // x u> x & (-1 >> y) -> x u> (-1 >> y) 3529 DstPred = ICmpInst::Predicate::ICMP_UGT; 3530 break; 3531 case ICmpInst::Predicate::ICMP_UGE: 3532 // x & (-1 >> y) u>= x -> x u<= (-1 >> y) 3533 // x u<= x & (-1 >> y) -> x u<= (-1 >> y) 3534 DstPred = ICmpInst::Predicate::ICMP_ULE; 3535 break; 3536 case ICmpInst::Predicate::ICMP_SLT: 3537 // x & (-1 >> y) s< x -> x s> (-1 >> y) 3538 // x s> x & (-1 >> y) -> x s> (-1 >> y) 3539 if (!match(M, m_Constant())) // Can not do this fold with non-constant. 3540 return nullptr; 3541 if (!match(M, m_NonNegative())) // Must not have any -1 vector elements. 3542 return nullptr; 3543 DstPred = ICmpInst::Predicate::ICMP_SGT; 3544 break; 3545 case ICmpInst::Predicate::ICMP_SGE: 3546 // x & (-1 >> y) s>= x -> x s<= (-1 >> y) 3547 // x s<= x & (-1 >> y) -> x s<= (-1 >> y) 3548 if (!match(M, m_Constant())) // Can not do this fold with non-constant. 3549 return nullptr; 3550 if (!match(M, m_NonNegative())) // Must not have any -1 vector elements. 3551 return nullptr; 3552 DstPred = ICmpInst::Predicate::ICMP_SLE; 3553 break; 3554 case ICmpInst::Predicate::ICMP_SGT: 3555 case ICmpInst::Predicate::ICMP_SLE: 3556 return nullptr; 3557 case ICmpInst::Predicate::ICMP_UGT: 3558 case ICmpInst::Predicate::ICMP_ULE: 3559 llvm_unreachable("Instsimplify took care of commut. variant"); 3560 break; 3561 default: 3562 llvm_unreachable("All possible folds are handled."); 3563 } 3564 3565 // The mask value may be a vector constant that has undefined elements. But it 3566 // may not be safe to propagate those undefs into the new compare, so replace 3567 // those elements by copying an existing, defined, and safe scalar constant. 3568 Type *OpTy = M->getType(); 3569 auto *VecC = dyn_cast<Constant>(M); 3570 auto *OpVTy = dyn_cast<FixedVectorType>(OpTy); 3571 if (OpVTy && VecC && VecC->containsUndefOrPoisonElement()) { 3572 Constant *SafeReplacementConstant = nullptr; 3573 for (unsigned i = 0, e = OpVTy->getNumElements(); i != e; ++i) { 3574 if (!isa<UndefValue>(VecC->getAggregateElement(i))) { 3575 SafeReplacementConstant = VecC->getAggregateElement(i); 3576 break; 3577 } 3578 } 3579 assert(SafeReplacementConstant && "Failed to find undef replacement"); 3580 M = Constant::replaceUndefsWith(VecC, SafeReplacementConstant); 3581 } 3582 3583 return Builder.CreateICmp(DstPred, X, M); 3584 } 3585 3586 /// Some comparisons can be simplified. 3587 /// In this case, we are looking for comparisons that look like 3588 /// a check for a lossy signed truncation. 3589 /// Folds: (MaskedBits is a constant.) 3590 /// ((%x << MaskedBits) a>> MaskedBits) SrcPred %x 3591 /// Into: 3592 /// (add %x, (1 << (KeptBits-1))) DstPred (1 << KeptBits) 3593 /// Where KeptBits = bitwidth(%x) - MaskedBits 3594 static Value * 3595 foldICmpWithTruncSignExtendedVal(ICmpInst &I, 3596 InstCombiner::BuilderTy &Builder) { 3597 ICmpInst::Predicate SrcPred; 3598 Value *X; 3599 const APInt *C0, *C1; // FIXME: non-splats, potentially with undef. 3600 // We are ok with 'shl' having multiple uses, but 'ashr' must be one-use. 3601 if (!match(&I, m_c_ICmp(SrcPred, 3602 m_OneUse(m_AShr(m_Shl(m_Value(X), m_APInt(C0)), 3603 m_APInt(C1))), 3604 m_Deferred(X)))) 3605 return nullptr; 3606 3607 // Potential handling of non-splats: for each element: 3608 // * if both are undef, replace with constant 0. 3609 // Because (1<<0) is OK and is 1, and ((1<<0)>>1) is also OK and is 0. 3610 // * if both are not undef, and are different, bailout. 3611 // * else, only one is undef, then pick the non-undef one. 3612 3613 // The shift amount must be equal. 3614 if (*C0 != *C1) 3615 return nullptr; 3616 const APInt &MaskedBits = *C0; 3617 assert(MaskedBits != 0 && "shift by zero should be folded away already."); 3618 3619 ICmpInst::Predicate DstPred; 3620 switch (SrcPred) { 3621 case ICmpInst::Predicate::ICMP_EQ: 3622 // ((%x << MaskedBits) a>> MaskedBits) == %x 3623 // => 3624 // (add %x, (1 << (KeptBits-1))) u< (1 << KeptBits) 3625 DstPred = ICmpInst::Predicate::ICMP_ULT; 3626 break; 3627 case ICmpInst::Predicate::ICMP_NE: 3628 // ((%x << MaskedBits) a>> MaskedBits) != %x 3629 // => 3630 // (add %x, (1 << (KeptBits-1))) u>= (1 << KeptBits) 3631 DstPred = ICmpInst::Predicate::ICMP_UGE; 3632 break; 3633 // FIXME: are more folds possible? 3634 default: 3635 return nullptr; 3636 } 3637 3638 auto *XType = X->getType(); 3639 const unsigned XBitWidth = XType->getScalarSizeInBits(); 3640 const APInt BitWidth = APInt(XBitWidth, XBitWidth); 3641 assert(BitWidth.ugt(MaskedBits) && "shifts should leave some bits untouched"); 3642 3643 // KeptBits = bitwidth(%x) - MaskedBits 3644 const APInt KeptBits = BitWidth - MaskedBits; 3645 assert(KeptBits.ugt(0) && KeptBits.ult(BitWidth) && "unreachable"); 3646 // ICmpCst = (1 << KeptBits) 3647 const APInt ICmpCst = APInt(XBitWidth, 1).shl(KeptBits); 3648 assert(ICmpCst.isPowerOf2()); 3649 // AddCst = (1 << (KeptBits-1)) 3650 const APInt AddCst = ICmpCst.lshr(1); 3651 assert(AddCst.ult(ICmpCst) && AddCst.isPowerOf2()); 3652 3653 // T0 = add %x, AddCst 3654 Value *T0 = Builder.CreateAdd(X, ConstantInt::get(XType, AddCst)); 3655 // T1 = T0 DstPred ICmpCst 3656 Value *T1 = Builder.CreateICmp(DstPred, T0, ConstantInt::get(XType, ICmpCst)); 3657 3658 return T1; 3659 } 3660 3661 // Given pattern: 3662 // icmp eq/ne (and ((x shift Q), (y oppositeshift K))), 0 3663 // we should move shifts to the same hand of 'and', i.e. rewrite as 3664 // icmp eq/ne (and (x shift (Q+K)), y), 0 iff (Q+K) u< bitwidth(x) 3665 // We are only interested in opposite logical shifts here. 3666 // One of the shifts can be truncated. 3667 // If we can, we want to end up creating 'lshr' shift. 3668 static Value * 3669 foldShiftIntoShiftInAnotherHandOfAndInICmp(ICmpInst &I, const SimplifyQuery SQ, 3670 InstCombiner::BuilderTy &Builder) { 3671 if (!I.isEquality() || !match(I.getOperand(1), m_Zero()) || 3672 !I.getOperand(0)->hasOneUse()) 3673 return nullptr; 3674 3675 auto m_AnyLogicalShift = m_LogicalShift(m_Value(), m_Value()); 3676 3677 // Look for an 'and' of two logical shifts, one of which may be truncated. 3678 // We use m_TruncOrSelf() on the RHS to correctly handle commutative case. 3679 Instruction *XShift, *MaybeTruncation, *YShift; 3680 if (!match( 3681 I.getOperand(0), 3682 m_c_And(m_CombineAnd(m_AnyLogicalShift, m_Instruction(XShift)), 3683 m_CombineAnd(m_TruncOrSelf(m_CombineAnd( 3684 m_AnyLogicalShift, m_Instruction(YShift))), 3685 m_Instruction(MaybeTruncation))))) 3686 return nullptr; 3687 3688 // We potentially looked past 'trunc', but only when matching YShift, 3689 // therefore YShift must have the widest type. 3690 Instruction *WidestShift = YShift; 3691 // Therefore XShift must have the shallowest type. 3692 // Or they both have identical types if there was no truncation. 3693 Instruction *NarrowestShift = XShift; 3694 3695 Type *WidestTy = WidestShift->getType(); 3696 Type *NarrowestTy = NarrowestShift->getType(); 3697 assert(NarrowestTy == I.getOperand(0)->getType() && 3698 "We did not look past any shifts while matching XShift though."); 3699 bool HadTrunc = WidestTy != I.getOperand(0)->getType(); 3700 3701 // If YShift is a 'lshr', swap the shifts around. 3702 if (match(YShift, m_LShr(m_Value(), m_Value()))) 3703 std::swap(XShift, YShift); 3704 3705 // The shifts must be in opposite directions. 3706 auto XShiftOpcode = XShift->getOpcode(); 3707 if (XShiftOpcode == YShift->getOpcode()) 3708 return nullptr; // Do not care about same-direction shifts here. 3709 3710 Value *X, *XShAmt, *Y, *YShAmt; 3711 match(XShift, m_BinOp(m_Value(X), m_ZExtOrSelf(m_Value(XShAmt)))); 3712 match(YShift, m_BinOp(m_Value(Y), m_ZExtOrSelf(m_Value(YShAmt)))); 3713 3714 // If one of the values being shifted is a constant, then we will end with 3715 // and+icmp, and [zext+]shift instrs will be constant-folded. If they are not, 3716 // however, we will need to ensure that we won't increase instruction count. 3717 if (!isa<Constant>(X) && !isa<Constant>(Y)) { 3718 // At least one of the hands of the 'and' should be one-use shift. 3719 if (!match(I.getOperand(0), 3720 m_c_And(m_OneUse(m_AnyLogicalShift), m_Value()))) 3721 return nullptr; 3722 if (HadTrunc) { 3723 // Due to the 'trunc', we will need to widen X. For that either the old 3724 // 'trunc' or the shift amt in the non-truncated shift should be one-use. 3725 if (!MaybeTruncation->hasOneUse() && 3726 !NarrowestShift->getOperand(1)->hasOneUse()) 3727 return nullptr; 3728 } 3729 } 3730 3731 // We have two shift amounts from two different shifts. The types of those 3732 // shift amounts may not match. If that's the case let's bailout now. 3733 if (XShAmt->getType() != YShAmt->getType()) 3734 return nullptr; 3735 3736 // As input, we have the following pattern: 3737 // icmp eq/ne (and ((x shift Q), (y oppositeshift K))), 0 3738 // We want to rewrite that as: 3739 // icmp eq/ne (and (x shift (Q+K)), y), 0 iff (Q+K) u< bitwidth(x) 3740 // While we know that originally (Q+K) would not overflow 3741 // (because 2 * (N-1) u<= iN -1), we have looked past extensions of 3742 // shift amounts. so it may now overflow in smaller bitwidth. 3743 // To ensure that does not happen, we need to ensure that the total maximal 3744 // shift amount is still representable in that smaller bit width. 3745 unsigned MaximalPossibleTotalShiftAmount = 3746 (WidestTy->getScalarSizeInBits() - 1) + 3747 (NarrowestTy->getScalarSizeInBits() - 1); 3748 APInt MaximalRepresentableShiftAmount = 3749 APInt::getAllOnes(XShAmt->getType()->getScalarSizeInBits()); 3750 if (MaximalRepresentableShiftAmount.ult(MaximalPossibleTotalShiftAmount)) 3751 return nullptr; 3752 3753 // Can we fold (XShAmt+YShAmt) ? 3754 auto *NewShAmt = dyn_cast_or_null<Constant>( 3755 SimplifyAddInst(XShAmt, YShAmt, /*isNSW=*/false, 3756 /*isNUW=*/false, SQ.getWithInstruction(&I))); 3757 if (!NewShAmt) 3758 return nullptr; 3759 NewShAmt = ConstantExpr::getZExtOrBitCast(NewShAmt, WidestTy); 3760 unsigned WidestBitWidth = WidestTy->getScalarSizeInBits(); 3761 3762 // Is the new shift amount smaller than the bit width? 3763 // FIXME: could also rely on ConstantRange. 3764 if (!match(NewShAmt, 3765 m_SpecificInt_ICMP(ICmpInst::Predicate::ICMP_ULT, 3766 APInt(WidestBitWidth, WidestBitWidth)))) 3767 return nullptr; 3768 3769 // An extra legality check is needed if we had trunc-of-lshr. 3770 if (HadTrunc && match(WidestShift, m_LShr(m_Value(), m_Value()))) { 3771 auto CanFold = [NewShAmt, WidestBitWidth, NarrowestShift, SQ, 3772 WidestShift]() { 3773 // It isn't obvious whether it's worth it to analyze non-constants here. 3774 // Also, let's basically give up on non-splat cases, pessimizing vectors. 3775 // If *any* of these preconditions matches we can perform the fold. 3776 Constant *NewShAmtSplat = NewShAmt->getType()->isVectorTy() 3777 ? NewShAmt->getSplatValue() 3778 : NewShAmt; 3779 // If it's edge-case shift (by 0 or by WidestBitWidth-1) we can fold. 3780 if (NewShAmtSplat && 3781 (NewShAmtSplat->isNullValue() || 3782 NewShAmtSplat->getUniqueInteger() == WidestBitWidth - 1)) 3783 return true; 3784 // We consider *min* leading zeros so a single outlier 3785 // blocks the transform as opposed to allowing it. 3786 if (auto *C = dyn_cast<Constant>(NarrowestShift->getOperand(0))) { 3787 KnownBits Known = computeKnownBits(C, SQ.DL); 3788 unsigned MinLeadZero = Known.countMinLeadingZeros(); 3789 // If the value being shifted has at most lowest bit set we can fold. 3790 unsigned MaxActiveBits = Known.getBitWidth() - MinLeadZero; 3791 if (MaxActiveBits <= 1) 3792 return true; 3793 // Precondition: NewShAmt u<= countLeadingZeros(C) 3794 if (NewShAmtSplat && NewShAmtSplat->getUniqueInteger().ule(MinLeadZero)) 3795 return true; 3796 } 3797 if (auto *C = dyn_cast<Constant>(WidestShift->getOperand(0))) { 3798 KnownBits Known = computeKnownBits(C, SQ.DL); 3799 unsigned MinLeadZero = Known.countMinLeadingZeros(); 3800 // If the value being shifted has at most lowest bit set we can fold. 3801 unsigned MaxActiveBits = Known.getBitWidth() - MinLeadZero; 3802 if (MaxActiveBits <= 1) 3803 return true; 3804 // Precondition: ((WidestBitWidth-1)-NewShAmt) u<= countLeadingZeros(C) 3805 if (NewShAmtSplat) { 3806 APInt AdjNewShAmt = 3807 (WidestBitWidth - 1) - NewShAmtSplat->getUniqueInteger(); 3808 if (AdjNewShAmt.ule(MinLeadZero)) 3809 return true; 3810 } 3811 } 3812 return false; // Can't tell if it's ok. 3813 }; 3814 if (!CanFold()) 3815 return nullptr; 3816 } 3817 3818 // All good, we can do this fold. 3819 X = Builder.CreateZExt(X, WidestTy); 3820 Y = Builder.CreateZExt(Y, WidestTy); 3821 // The shift is the same that was for X. 3822 Value *T0 = XShiftOpcode == Instruction::BinaryOps::LShr 3823 ? Builder.CreateLShr(X, NewShAmt) 3824 : Builder.CreateShl(X, NewShAmt); 3825 Value *T1 = Builder.CreateAnd(T0, Y); 3826 return Builder.CreateICmp(I.getPredicate(), T1, 3827 Constant::getNullValue(WidestTy)); 3828 } 3829 3830 /// Fold 3831 /// (-1 u/ x) u< y 3832 /// ((x * y) ?/ x) != y 3833 /// to 3834 /// @llvm.?mul.with.overflow(x, y) plus extraction of overflow bit 3835 /// Note that the comparison is commutative, while inverted (u>=, ==) predicate 3836 /// will mean that we are looking for the opposite answer. 3837 Value *InstCombinerImpl::foldMultiplicationOverflowCheck(ICmpInst &I) { 3838 ICmpInst::Predicate Pred; 3839 Value *X, *Y; 3840 Instruction *Mul; 3841 Instruction *Div; 3842 bool NeedNegation; 3843 // Look for: (-1 u/ x) u</u>= y 3844 if (!I.isEquality() && 3845 match(&I, m_c_ICmp(Pred, 3846 m_CombineAnd(m_OneUse(m_UDiv(m_AllOnes(), m_Value(X))), 3847 m_Instruction(Div)), 3848 m_Value(Y)))) { 3849 Mul = nullptr; 3850 3851 // Are we checking that overflow does not happen, or does happen? 3852 switch (Pred) { 3853 case ICmpInst::Predicate::ICMP_ULT: 3854 NeedNegation = false; 3855 break; // OK 3856 case ICmpInst::Predicate::ICMP_UGE: 3857 NeedNegation = true; 3858 break; // OK 3859 default: 3860 return nullptr; // Wrong predicate. 3861 } 3862 } else // Look for: ((x * y) / x) !=/== y 3863 if (I.isEquality() && 3864 match(&I, 3865 m_c_ICmp(Pred, m_Value(Y), 3866 m_CombineAnd( 3867 m_OneUse(m_IDiv(m_CombineAnd(m_c_Mul(m_Deferred(Y), 3868 m_Value(X)), 3869 m_Instruction(Mul)), 3870 m_Deferred(X))), 3871 m_Instruction(Div))))) { 3872 NeedNegation = Pred == ICmpInst::Predicate::ICMP_EQ; 3873 } else 3874 return nullptr; 3875 3876 BuilderTy::InsertPointGuard Guard(Builder); 3877 // If the pattern included (x * y), we'll want to insert new instructions 3878 // right before that original multiplication so that we can replace it. 3879 bool MulHadOtherUses = Mul && !Mul->hasOneUse(); 3880 if (MulHadOtherUses) 3881 Builder.SetInsertPoint(Mul); 3882 3883 Function *F = Intrinsic::getDeclaration(I.getModule(), 3884 Div->getOpcode() == Instruction::UDiv 3885 ? Intrinsic::umul_with_overflow 3886 : Intrinsic::smul_with_overflow, 3887 X->getType()); 3888 CallInst *Call = Builder.CreateCall(F, {X, Y}, "mul"); 3889 3890 // If the multiplication was used elsewhere, to ensure that we don't leave 3891 // "duplicate" instructions, replace uses of that original multiplication 3892 // with the multiplication result from the with.overflow intrinsic. 3893 if (MulHadOtherUses) 3894 replaceInstUsesWith(*Mul, Builder.CreateExtractValue(Call, 0, "mul.val")); 3895 3896 Value *Res = Builder.CreateExtractValue(Call, 1, "mul.ov"); 3897 if (NeedNegation) // This technically increases instruction count. 3898 Res = Builder.CreateNot(Res, "mul.not.ov"); 3899 3900 // If we replaced the mul, erase it. Do this after all uses of Builder, 3901 // as the mul is used as insertion point. 3902 if (MulHadOtherUses) 3903 eraseInstFromFunction(*Mul); 3904 3905 return Res; 3906 } 3907 3908 static Instruction *foldICmpXNegX(ICmpInst &I) { 3909 CmpInst::Predicate Pred; 3910 Value *X; 3911 if (!match(&I, m_c_ICmp(Pred, m_NSWNeg(m_Value(X)), m_Deferred(X)))) 3912 return nullptr; 3913 3914 if (ICmpInst::isSigned(Pred)) 3915 Pred = ICmpInst::getSwappedPredicate(Pred); 3916 else if (ICmpInst::isUnsigned(Pred)) 3917 Pred = ICmpInst::getSignedPredicate(Pred); 3918 // else for equality-comparisons just keep the predicate. 3919 3920 return ICmpInst::Create(Instruction::ICmp, Pred, X, 3921 Constant::getNullValue(X->getType()), I.getName()); 3922 } 3923 3924 /// Try to fold icmp (binop), X or icmp X, (binop). 3925 /// TODO: A large part of this logic is duplicated in InstSimplify's 3926 /// simplifyICmpWithBinOp(). We should be able to share that and avoid the code 3927 /// duplication. 3928 Instruction *InstCombinerImpl::foldICmpBinOp(ICmpInst &I, 3929 const SimplifyQuery &SQ) { 3930 const SimplifyQuery Q = SQ.getWithInstruction(&I); 3931 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 3932 3933 // Special logic for binary operators. 3934 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0); 3935 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1); 3936 if (!BO0 && !BO1) 3937 return nullptr; 3938 3939 if (Instruction *NewICmp = foldICmpXNegX(I)) 3940 return NewICmp; 3941 3942 const CmpInst::Predicate Pred = I.getPredicate(); 3943 Value *X; 3944 3945 // Convert add-with-unsigned-overflow comparisons into a 'not' with compare. 3946 // (Op1 + X) u</u>= Op1 --> ~Op1 u</u>= X 3947 if (match(Op0, m_OneUse(m_c_Add(m_Specific(Op1), m_Value(X)))) && 3948 (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE)) 3949 return new ICmpInst(Pred, Builder.CreateNot(Op1), X); 3950 // Op0 u>/u<= (Op0 + X) --> X u>/u<= ~Op0 3951 if (match(Op1, m_OneUse(m_c_Add(m_Specific(Op0), m_Value(X)))) && 3952 (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE)) 3953 return new ICmpInst(Pred, X, Builder.CreateNot(Op0)); 3954 3955 { 3956 // Similar to above: an unsigned overflow comparison may use offset + mask: 3957 // ((Op1 + C) & C) u< Op1 --> Op1 != 0 3958 // ((Op1 + C) & C) u>= Op1 --> Op1 == 0 3959 // Op0 u> ((Op0 + C) & C) --> Op0 != 0 3960 // Op0 u<= ((Op0 + C) & C) --> Op0 == 0 3961 BinaryOperator *BO; 3962 const APInt *C; 3963 if ((Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE) && 3964 match(Op0, m_And(m_BinOp(BO), m_LowBitMask(C))) && 3965 match(BO, m_Add(m_Specific(Op1), m_SpecificIntAllowUndef(*C)))) { 3966 CmpInst::Predicate NewPred = 3967 Pred == ICmpInst::ICMP_ULT ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ; 3968 Constant *Zero = ConstantInt::getNullValue(Op1->getType()); 3969 return new ICmpInst(NewPred, Op1, Zero); 3970 } 3971 3972 if ((Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE) && 3973 match(Op1, m_And(m_BinOp(BO), m_LowBitMask(C))) && 3974 match(BO, m_Add(m_Specific(Op0), m_SpecificIntAllowUndef(*C)))) { 3975 CmpInst::Predicate NewPred = 3976 Pred == ICmpInst::ICMP_UGT ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ; 3977 Constant *Zero = ConstantInt::getNullValue(Op1->getType()); 3978 return new ICmpInst(NewPred, Op0, Zero); 3979 } 3980 } 3981 3982 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false; 3983 if (BO0 && isa<OverflowingBinaryOperator>(BO0)) 3984 NoOp0WrapProblem = 3985 ICmpInst::isEquality(Pred) || 3986 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) || 3987 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap()); 3988 if (BO1 && isa<OverflowingBinaryOperator>(BO1)) 3989 NoOp1WrapProblem = 3990 ICmpInst::isEquality(Pred) || 3991 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) || 3992 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap()); 3993 3994 // Analyze the case when either Op0 or Op1 is an add instruction. 3995 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null). 3996 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr; 3997 if (BO0 && BO0->getOpcode() == Instruction::Add) { 3998 A = BO0->getOperand(0); 3999 B = BO0->getOperand(1); 4000 } 4001 if (BO1 && BO1->getOpcode() == Instruction::Add) { 4002 C = BO1->getOperand(0); 4003 D = BO1->getOperand(1); 4004 } 4005 4006 // icmp (A+B), A -> icmp B, 0 for equalities or if there is no overflow. 4007 // icmp (A+B), B -> icmp A, 0 for equalities or if there is no overflow. 4008 if ((A == Op1 || B == Op1) && NoOp0WrapProblem) 4009 return new ICmpInst(Pred, A == Op1 ? B : A, 4010 Constant::getNullValue(Op1->getType())); 4011 4012 // icmp C, (C+D) -> icmp 0, D for equalities or if there is no overflow. 4013 // icmp D, (C+D) -> icmp 0, C for equalities or if there is no overflow. 4014 if ((C == Op0 || D == Op0) && NoOp1WrapProblem) 4015 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()), 4016 C == Op0 ? D : C); 4017 4018 // icmp (A+B), (A+D) -> icmp B, D for equalities or if there is no overflow. 4019 if (A && C && (A == C || A == D || B == C || B == D) && NoOp0WrapProblem && 4020 NoOp1WrapProblem) { 4021 // Determine Y and Z in the form icmp (X+Y), (X+Z). 4022 Value *Y, *Z; 4023 if (A == C) { 4024 // C + B == C + D -> B == D 4025 Y = B; 4026 Z = D; 4027 } else if (A == D) { 4028 // D + B == C + D -> B == C 4029 Y = B; 4030 Z = C; 4031 } else if (B == C) { 4032 // A + C == C + D -> A == D 4033 Y = A; 4034 Z = D; 4035 } else { 4036 assert(B == D); 4037 // A + D == C + D -> A == C 4038 Y = A; 4039 Z = C; 4040 } 4041 return new ICmpInst(Pred, Y, Z); 4042 } 4043 4044 // icmp slt (A + -1), Op1 -> icmp sle A, Op1 4045 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT && 4046 match(B, m_AllOnes())) 4047 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1); 4048 4049 // icmp sge (A + -1), Op1 -> icmp sgt A, Op1 4050 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE && 4051 match(B, m_AllOnes())) 4052 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1); 4053 4054 // icmp sle (A + 1), Op1 -> icmp slt A, Op1 4055 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE && match(B, m_One())) 4056 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1); 4057 4058 // icmp sgt (A + 1), Op1 -> icmp sge A, Op1 4059 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT && match(B, m_One())) 4060 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1); 4061 4062 // icmp sgt Op0, (C + -1) -> icmp sge Op0, C 4063 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT && 4064 match(D, m_AllOnes())) 4065 return new ICmpInst(CmpInst::ICMP_SGE, Op0, C); 4066 4067 // icmp sle Op0, (C + -1) -> icmp slt Op0, C 4068 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE && 4069 match(D, m_AllOnes())) 4070 return new ICmpInst(CmpInst::ICMP_SLT, Op0, C); 4071 4072 // icmp sge Op0, (C + 1) -> icmp sgt Op0, C 4073 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE && match(D, m_One())) 4074 return new ICmpInst(CmpInst::ICMP_SGT, Op0, C); 4075 4076 // icmp slt Op0, (C + 1) -> icmp sle Op0, C 4077 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT && match(D, m_One())) 4078 return new ICmpInst(CmpInst::ICMP_SLE, Op0, C); 4079 4080 // TODO: The subtraction-related identities shown below also hold, but 4081 // canonicalization from (X -nuw 1) to (X + -1) means that the combinations 4082 // wouldn't happen even if they were implemented. 4083 // 4084 // icmp ult (A - 1), Op1 -> icmp ule A, Op1 4085 // icmp uge (A - 1), Op1 -> icmp ugt A, Op1 4086 // icmp ugt Op0, (C - 1) -> icmp uge Op0, C 4087 // icmp ule Op0, (C - 1) -> icmp ult Op0, C 4088 4089 // icmp ule (A + 1), Op0 -> icmp ult A, Op1 4090 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_ULE && match(B, m_One())) 4091 return new ICmpInst(CmpInst::ICMP_ULT, A, Op1); 4092 4093 // icmp ugt (A + 1), Op0 -> icmp uge A, Op1 4094 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_UGT && match(B, m_One())) 4095 return new ICmpInst(CmpInst::ICMP_UGE, A, Op1); 4096 4097 // icmp uge Op0, (C + 1) -> icmp ugt Op0, C 4098 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_UGE && match(D, m_One())) 4099 return new ICmpInst(CmpInst::ICMP_UGT, Op0, C); 4100 4101 // icmp ult Op0, (C + 1) -> icmp ule Op0, C 4102 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_ULT && match(D, m_One())) 4103 return new ICmpInst(CmpInst::ICMP_ULE, Op0, C); 4104 4105 // if C1 has greater magnitude than C2: 4106 // icmp (A + C1), (C + C2) -> icmp (A + C3), C 4107 // s.t. C3 = C1 - C2 4108 // 4109 // if C2 has greater magnitude than C1: 4110 // icmp (A + C1), (C + C2) -> icmp A, (C + C3) 4111 // s.t. C3 = C2 - C1 4112 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem && 4113 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned()) 4114 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B)) 4115 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) { 4116 const APInt &AP1 = C1->getValue(); 4117 const APInt &AP2 = C2->getValue(); 4118 if (AP1.isNegative() == AP2.isNegative()) { 4119 APInt AP1Abs = C1->getValue().abs(); 4120 APInt AP2Abs = C2->getValue().abs(); 4121 if (AP1Abs.uge(AP2Abs)) { 4122 ConstantInt *C3 = Builder.getInt(AP1 - AP2); 4123 bool HasNUW = BO0->hasNoUnsignedWrap() && C3->getValue().ule(AP1); 4124 bool HasNSW = BO0->hasNoSignedWrap(); 4125 Value *NewAdd = Builder.CreateAdd(A, C3, "", HasNUW, HasNSW); 4126 return new ICmpInst(Pred, NewAdd, C); 4127 } else { 4128 ConstantInt *C3 = Builder.getInt(AP2 - AP1); 4129 bool HasNUW = BO1->hasNoUnsignedWrap() && C3->getValue().ule(AP2); 4130 bool HasNSW = BO1->hasNoSignedWrap(); 4131 Value *NewAdd = Builder.CreateAdd(C, C3, "", HasNUW, HasNSW); 4132 return new ICmpInst(Pred, A, NewAdd); 4133 } 4134 } 4135 } 4136 4137 // Analyze the case when either Op0 or Op1 is a sub instruction. 4138 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null). 4139 A = nullptr; 4140 B = nullptr; 4141 C = nullptr; 4142 D = nullptr; 4143 if (BO0 && BO0->getOpcode() == Instruction::Sub) { 4144 A = BO0->getOperand(0); 4145 B = BO0->getOperand(1); 4146 } 4147 if (BO1 && BO1->getOpcode() == Instruction::Sub) { 4148 C = BO1->getOperand(0); 4149 D = BO1->getOperand(1); 4150 } 4151 4152 // icmp (A-B), A -> icmp 0, B for equalities or if there is no overflow. 4153 if (A == Op1 && NoOp0WrapProblem) 4154 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B); 4155 // icmp C, (C-D) -> icmp D, 0 for equalities or if there is no overflow. 4156 if (C == Op0 && NoOp1WrapProblem) 4157 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType())); 4158 4159 // Convert sub-with-unsigned-overflow comparisons into a comparison of args. 4160 // (A - B) u>/u<= A --> B u>/u<= A 4161 if (A == Op1 && (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULE)) 4162 return new ICmpInst(Pred, B, A); 4163 // C u</u>= (C - D) --> C u</u>= D 4164 if (C == Op0 && (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_UGE)) 4165 return new ICmpInst(Pred, C, D); 4166 // (A - B) u>=/u< A --> B u>/u<= A iff B != 0 4167 if (A == Op1 && (Pred == ICmpInst::ICMP_UGE || Pred == ICmpInst::ICMP_ULT) && 4168 isKnownNonZero(B, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT)) 4169 return new ICmpInst(CmpInst::getFlippedStrictnessPredicate(Pred), B, A); 4170 // C u<=/u> (C - D) --> C u</u>= D iff B != 0 4171 if (C == Op0 && (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_UGT) && 4172 isKnownNonZero(D, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT)) 4173 return new ICmpInst(CmpInst::getFlippedStrictnessPredicate(Pred), C, D); 4174 4175 // icmp (A-B), (C-B) -> icmp A, C for equalities or if there is no overflow. 4176 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem) 4177 return new ICmpInst(Pred, A, C); 4178 4179 // icmp (A-B), (A-D) -> icmp D, B for equalities or if there is no overflow. 4180 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem) 4181 return new ICmpInst(Pred, D, B); 4182 4183 // icmp (0-X) < cst --> x > -cst 4184 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) { 4185 Value *X; 4186 if (match(BO0, m_Neg(m_Value(X)))) 4187 if (Constant *RHSC = dyn_cast<Constant>(Op1)) 4188 if (RHSC->isNotMinSignedValue()) 4189 return new ICmpInst(I.getSwappedPredicate(), X, 4190 ConstantExpr::getNeg(RHSC)); 4191 } 4192 4193 { 4194 // Try to remove shared constant multiplier from equality comparison: 4195 // X * C == Y * C (with no overflowing/aliasing) --> X == Y 4196 Value *X, *Y; 4197 const APInt *C; 4198 if (match(Op0, m_Mul(m_Value(X), m_APInt(C))) && *C != 0 && 4199 match(Op1, m_Mul(m_Value(Y), m_SpecificInt(*C))) && I.isEquality()) 4200 if (!C->countTrailingZeros() || 4201 (BO0 && BO1 && BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap()) || 4202 (BO0 && BO1 && BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap())) 4203 return new ICmpInst(Pred, X, Y); 4204 } 4205 4206 BinaryOperator *SRem = nullptr; 4207 // icmp (srem X, Y), Y 4208 if (BO0 && BO0->getOpcode() == Instruction::SRem && Op1 == BO0->getOperand(1)) 4209 SRem = BO0; 4210 // icmp Y, (srem X, Y) 4211 else if (BO1 && BO1->getOpcode() == Instruction::SRem && 4212 Op0 == BO1->getOperand(1)) 4213 SRem = BO1; 4214 if (SRem) { 4215 // We don't check hasOneUse to avoid increasing register pressure because 4216 // the value we use is the same value this instruction was already using. 4217 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) { 4218 default: 4219 break; 4220 case ICmpInst::ICMP_EQ: 4221 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 4222 case ICmpInst::ICMP_NE: 4223 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 4224 case ICmpInst::ICMP_SGT: 4225 case ICmpInst::ICMP_SGE: 4226 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1), 4227 Constant::getAllOnesValue(SRem->getType())); 4228 case ICmpInst::ICMP_SLT: 4229 case ICmpInst::ICMP_SLE: 4230 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1), 4231 Constant::getNullValue(SRem->getType())); 4232 } 4233 } 4234 4235 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() && BO0->hasOneUse() && 4236 BO1->hasOneUse() && BO0->getOperand(1) == BO1->getOperand(1)) { 4237 switch (BO0->getOpcode()) { 4238 default: 4239 break; 4240 case Instruction::Add: 4241 case Instruction::Sub: 4242 case Instruction::Xor: { 4243 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b 4244 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0)); 4245 4246 const APInt *C; 4247 if (match(BO0->getOperand(1), m_APInt(C))) { 4248 // icmp u/s (a ^ signmask), (b ^ signmask) --> icmp s/u a, b 4249 if (C->isSignMask()) { 4250 ICmpInst::Predicate NewPred = I.getFlippedSignednessPredicate(); 4251 return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0)); 4252 } 4253 4254 // icmp u/s (a ^ maxsignval), (b ^ maxsignval) --> icmp s/u' a, b 4255 if (BO0->getOpcode() == Instruction::Xor && C->isMaxSignedValue()) { 4256 ICmpInst::Predicate NewPred = I.getFlippedSignednessPredicate(); 4257 NewPred = I.getSwappedPredicate(NewPred); 4258 return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0)); 4259 } 4260 } 4261 break; 4262 } 4263 case Instruction::Mul: { 4264 if (!I.isEquality()) 4265 break; 4266 4267 const APInt *C; 4268 if (match(BO0->getOperand(1), m_APInt(C)) && !C->isZero() && 4269 !C->isOne()) { 4270 // icmp eq/ne (X * C), (Y * C) --> icmp (X & Mask), (Y & Mask) 4271 // Mask = -1 >> count-trailing-zeros(C). 4272 if (unsigned TZs = C->countTrailingZeros()) { 4273 Constant *Mask = ConstantInt::get( 4274 BO0->getType(), 4275 APInt::getLowBitsSet(C->getBitWidth(), C->getBitWidth() - TZs)); 4276 Value *And1 = Builder.CreateAnd(BO0->getOperand(0), Mask); 4277 Value *And2 = Builder.CreateAnd(BO1->getOperand(0), Mask); 4278 return new ICmpInst(Pred, And1, And2); 4279 } 4280 } 4281 break; 4282 } 4283 case Instruction::UDiv: 4284 case Instruction::LShr: 4285 if (I.isSigned() || !BO0->isExact() || !BO1->isExact()) 4286 break; 4287 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0)); 4288 4289 case Instruction::SDiv: 4290 if (!I.isEquality() || !BO0->isExact() || !BO1->isExact()) 4291 break; 4292 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0)); 4293 4294 case Instruction::AShr: 4295 if (!BO0->isExact() || !BO1->isExact()) 4296 break; 4297 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0)); 4298 4299 case Instruction::Shl: { 4300 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap(); 4301 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap(); 4302 if (!NUW && !NSW) 4303 break; 4304 if (!NSW && I.isSigned()) 4305 break; 4306 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0)); 4307 } 4308 } 4309 } 4310 4311 if (BO0) { 4312 // Transform A & (L - 1) `ult` L --> L != 0 4313 auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes()); 4314 auto BitwiseAnd = m_c_And(m_Value(), LSubOne); 4315 4316 if (match(BO0, BitwiseAnd) && Pred == ICmpInst::ICMP_ULT) { 4317 auto *Zero = Constant::getNullValue(BO0->getType()); 4318 return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero); 4319 } 4320 } 4321 4322 if (Value *V = foldMultiplicationOverflowCheck(I)) 4323 return replaceInstUsesWith(I, V); 4324 4325 if (Value *V = foldICmpWithLowBitMaskedVal(I, Builder)) 4326 return replaceInstUsesWith(I, V); 4327 4328 if (Value *V = foldICmpWithTruncSignExtendedVal(I, Builder)) 4329 return replaceInstUsesWith(I, V); 4330 4331 if (Value *V = foldShiftIntoShiftInAnotherHandOfAndInICmp(I, SQ, Builder)) 4332 return replaceInstUsesWith(I, V); 4333 4334 return nullptr; 4335 } 4336 4337 /// Fold icmp Pred min|max(X, Y), X. 4338 static Instruction *foldICmpWithMinMax(ICmpInst &Cmp) { 4339 ICmpInst::Predicate Pred = Cmp.getPredicate(); 4340 Value *Op0 = Cmp.getOperand(0); 4341 Value *X = Cmp.getOperand(1); 4342 4343 // Canonicalize minimum or maximum operand to LHS of the icmp. 4344 if (match(X, m_c_SMin(m_Specific(Op0), m_Value())) || 4345 match(X, m_c_SMax(m_Specific(Op0), m_Value())) || 4346 match(X, m_c_UMin(m_Specific(Op0), m_Value())) || 4347 match(X, m_c_UMax(m_Specific(Op0), m_Value()))) { 4348 std::swap(Op0, X); 4349 Pred = Cmp.getSwappedPredicate(); 4350 } 4351 4352 Value *Y; 4353 if (match(Op0, m_c_SMin(m_Specific(X), m_Value(Y)))) { 4354 // smin(X, Y) == X --> X s<= Y 4355 // smin(X, Y) s>= X --> X s<= Y 4356 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SGE) 4357 return new ICmpInst(ICmpInst::ICMP_SLE, X, Y); 4358 4359 // smin(X, Y) != X --> X s> Y 4360 // smin(X, Y) s< X --> X s> Y 4361 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SLT) 4362 return new ICmpInst(ICmpInst::ICMP_SGT, X, Y); 4363 4364 // These cases should be handled in InstSimplify: 4365 // smin(X, Y) s<= X --> true 4366 // smin(X, Y) s> X --> false 4367 return nullptr; 4368 } 4369 4370 if (match(Op0, m_c_SMax(m_Specific(X), m_Value(Y)))) { 4371 // smax(X, Y) == X --> X s>= Y 4372 // smax(X, Y) s<= X --> X s>= Y 4373 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SLE) 4374 return new ICmpInst(ICmpInst::ICMP_SGE, X, Y); 4375 4376 // smax(X, Y) != X --> X s< Y 4377 // smax(X, Y) s> X --> X s< Y 4378 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SGT) 4379 return new ICmpInst(ICmpInst::ICMP_SLT, X, Y); 4380 4381 // These cases should be handled in InstSimplify: 4382 // smax(X, Y) s>= X --> true 4383 // smax(X, Y) s< X --> false 4384 return nullptr; 4385 } 4386 4387 if (match(Op0, m_c_UMin(m_Specific(X), m_Value(Y)))) { 4388 // umin(X, Y) == X --> X u<= Y 4389 // umin(X, Y) u>= X --> X u<= Y 4390 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_UGE) 4391 return new ICmpInst(ICmpInst::ICMP_ULE, X, Y); 4392 4393 // umin(X, Y) != X --> X u> Y 4394 // umin(X, Y) u< X --> X u> Y 4395 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_ULT) 4396 return new ICmpInst(ICmpInst::ICMP_UGT, X, Y); 4397 4398 // These cases should be handled in InstSimplify: 4399 // umin(X, Y) u<= X --> true 4400 // umin(X, Y) u> X --> false 4401 return nullptr; 4402 } 4403 4404 if (match(Op0, m_c_UMax(m_Specific(X), m_Value(Y)))) { 4405 // umax(X, Y) == X --> X u>= Y 4406 // umax(X, Y) u<= X --> X u>= Y 4407 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_ULE) 4408 return new ICmpInst(ICmpInst::ICMP_UGE, X, Y); 4409 4410 // umax(X, Y) != X --> X u< Y 4411 // umax(X, Y) u> X --> X u< Y 4412 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_UGT) 4413 return new ICmpInst(ICmpInst::ICMP_ULT, X, Y); 4414 4415 // These cases should be handled in InstSimplify: 4416 // umax(X, Y) u>= X --> true 4417 // umax(X, Y) u< X --> false 4418 return nullptr; 4419 } 4420 4421 return nullptr; 4422 } 4423 4424 Instruction *InstCombinerImpl::foldICmpEquality(ICmpInst &I) { 4425 if (!I.isEquality()) 4426 return nullptr; 4427 4428 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 4429 const CmpInst::Predicate Pred = I.getPredicate(); 4430 Value *A, *B, *C, *D; 4431 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) { 4432 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0 4433 Value *OtherVal = A == Op1 ? B : A; 4434 return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType())); 4435 } 4436 4437 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) { 4438 // A^c1 == C^c2 --> A == C^(c1^c2) 4439 ConstantInt *C1, *C2; 4440 if (match(B, m_ConstantInt(C1)) && match(D, m_ConstantInt(C2)) && 4441 Op1->hasOneUse()) { 4442 Constant *NC = Builder.getInt(C1->getValue() ^ C2->getValue()); 4443 Value *Xor = Builder.CreateXor(C, NC); 4444 return new ICmpInst(Pred, A, Xor); 4445 } 4446 4447 // A^B == A^D -> B == D 4448 if (A == C) 4449 return new ICmpInst(Pred, B, D); 4450 if (A == D) 4451 return new ICmpInst(Pred, B, C); 4452 if (B == C) 4453 return new ICmpInst(Pred, A, D); 4454 if (B == D) 4455 return new ICmpInst(Pred, A, C); 4456 } 4457 } 4458 4459 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) && (A == Op0 || B == Op0)) { 4460 // A == (A^B) -> B == 0 4461 Value *OtherVal = A == Op0 ? B : A; 4462 return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType())); 4463 } 4464 4465 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0 4466 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) && 4467 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) { 4468 Value *X = nullptr, *Y = nullptr, *Z = nullptr; 4469 4470 if (A == C) { 4471 X = B; 4472 Y = D; 4473 Z = A; 4474 } else if (A == D) { 4475 X = B; 4476 Y = C; 4477 Z = A; 4478 } else if (B == C) { 4479 X = A; 4480 Y = D; 4481 Z = B; 4482 } else if (B == D) { 4483 X = A; 4484 Y = C; 4485 Z = B; 4486 } 4487 4488 if (X) { // Build (X^Y) & Z 4489 Op1 = Builder.CreateXor(X, Y); 4490 Op1 = Builder.CreateAnd(Op1, Z); 4491 return new ICmpInst(Pred, Op1, Constant::getNullValue(Op1->getType())); 4492 } 4493 } 4494 4495 { 4496 // Similar to above, but specialized for constant because invert is needed: 4497 // (X | C) == (Y | C) --> (X ^ Y) & ~C == 0 4498 Value *X, *Y; 4499 Constant *C; 4500 if (match(Op0, m_OneUse(m_Or(m_Value(X), m_Constant(C)))) && 4501 match(Op1, m_OneUse(m_Or(m_Value(Y), m_Specific(C))))) { 4502 Value *Xor = Builder.CreateXor(X, Y); 4503 Value *And = Builder.CreateAnd(Xor, ConstantExpr::getNot(C)); 4504 return new ICmpInst(Pred, And, Constant::getNullValue(And->getType())); 4505 } 4506 } 4507 4508 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B) 4509 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B) 4510 ConstantInt *Cst1; 4511 if ((Op0->hasOneUse() && match(Op0, m_ZExt(m_Value(A))) && 4512 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) || 4513 (Op1->hasOneUse() && match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) && 4514 match(Op1, m_ZExt(m_Value(A))))) { 4515 APInt Pow2 = Cst1->getValue() + 1; 4516 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) && 4517 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth()) 4518 return new ICmpInst(Pred, A, Builder.CreateTrunc(B, A->getType())); 4519 } 4520 4521 // (A >> C) == (B >> C) --> (A^B) u< (1 << C) 4522 // For lshr and ashr pairs. 4523 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) && 4524 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) || 4525 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) && 4526 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) { 4527 unsigned TypeBits = Cst1->getBitWidth(); 4528 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits); 4529 if (ShAmt < TypeBits && ShAmt != 0) { 4530 ICmpInst::Predicate NewPred = 4531 Pred == ICmpInst::ICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT; 4532 Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted"); 4533 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt); 4534 return new ICmpInst(NewPred, Xor, Builder.getInt(CmpVal)); 4535 } 4536 } 4537 4538 // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0 4539 if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) && 4540 match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) { 4541 unsigned TypeBits = Cst1->getBitWidth(); 4542 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits); 4543 if (ShAmt < TypeBits && ShAmt != 0) { 4544 Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted"); 4545 APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt); 4546 Value *And = Builder.CreateAnd(Xor, Builder.getInt(AndVal), 4547 I.getName() + ".mask"); 4548 return new ICmpInst(Pred, And, Constant::getNullValue(Cst1->getType())); 4549 } 4550 } 4551 4552 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to 4553 // "icmp (and X, mask), cst" 4554 uint64_t ShAmt = 0; 4555 if (Op0->hasOneUse() && 4556 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A), m_ConstantInt(ShAmt))))) && 4557 match(Op1, m_ConstantInt(Cst1)) && 4558 // Only do this when A has multiple uses. This is most important to do 4559 // when it exposes other optimizations. 4560 !A->hasOneUse()) { 4561 unsigned ASize = cast<IntegerType>(A->getType())->getPrimitiveSizeInBits(); 4562 4563 if (ShAmt < ASize) { 4564 APInt MaskV = 4565 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits()); 4566 MaskV <<= ShAmt; 4567 4568 APInt CmpV = Cst1->getValue().zext(ASize); 4569 CmpV <<= ShAmt; 4570 4571 Value *Mask = Builder.CreateAnd(A, Builder.getInt(MaskV)); 4572 return new ICmpInst(Pred, Mask, Builder.getInt(CmpV)); 4573 } 4574 } 4575 4576 if (Instruction *ICmp = foldICmpIntrinsicWithIntrinsic(I)) 4577 return ICmp; 4578 4579 // Canonicalize checking for a power-of-2-or-zero value: 4580 // (A & (A-1)) == 0 --> ctpop(A) < 2 (two commuted variants) 4581 // ((A-1) & A) != 0 --> ctpop(A) > 1 (two commuted variants) 4582 if (!match(Op0, m_OneUse(m_c_And(m_Add(m_Value(A), m_AllOnes()), 4583 m_Deferred(A)))) || 4584 !match(Op1, m_ZeroInt())) 4585 A = nullptr; 4586 4587 // (A & -A) == A --> ctpop(A) < 2 (four commuted variants) 4588 // (-A & A) != A --> ctpop(A) > 1 (four commuted variants) 4589 if (match(Op0, m_OneUse(m_c_And(m_Neg(m_Specific(Op1)), m_Specific(Op1))))) 4590 A = Op1; 4591 else if (match(Op1, 4592 m_OneUse(m_c_And(m_Neg(m_Specific(Op0)), m_Specific(Op0))))) 4593 A = Op0; 4594 4595 if (A) { 4596 Type *Ty = A->getType(); 4597 CallInst *CtPop = Builder.CreateUnaryIntrinsic(Intrinsic::ctpop, A); 4598 return Pred == ICmpInst::ICMP_EQ 4599 ? new ICmpInst(ICmpInst::ICMP_ULT, CtPop, ConstantInt::get(Ty, 2)) 4600 : new ICmpInst(ICmpInst::ICMP_UGT, CtPop, ConstantInt::get(Ty, 1)); 4601 } 4602 4603 // Match icmp eq (trunc (lshr A, BW), (ashr (trunc A), BW-1)), which checks the 4604 // top BW/2 + 1 bits are all the same. Create "A >=s INT_MIN && A <=s INT_MAX", 4605 // which we generate as "icmp ult (add A, 2^(BW-1)), 2^BW" to skip a few steps 4606 // of instcombine. 4607 unsigned BitWidth = Op0->getType()->getScalarSizeInBits(); 4608 if (match(Op0, m_AShr(m_Trunc(m_Value(A)), m_SpecificInt(BitWidth - 1))) && 4609 match(Op1, m_Trunc(m_LShr(m_Specific(A), m_SpecificInt(BitWidth)))) && 4610 A->getType()->getScalarSizeInBits() == BitWidth * 2 && 4611 (I.getOperand(0)->hasOneUse() || I.getOperand(1)->hasOneUse())) { 4612 APInt C = APInt::getOneBitSet(BitWidth * 2, BitWidth - 1); 4613 Value *Add = Builder.CreateAdd(A, ConstantInt::get(A->getType(), C)); 4614 return new ICmpInst(Pred == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_ULT 4615 : ICmpInst::ICMP_UGE, 4616 Add, ConstantInt::get(A->getType(), C.shl(1))); 4617 } 4618 4619 return nullptr; 4620 } 4621 4622 static Instruction *foldICmpWithTrunc(ICmpInst &ICmp, 4623 InstCombiner::BuilderTy &Builder) { 4624 ICmpInst::Predicate Pred = ICmp.getPredicate(); 4625 Value *Op0 = ICmp.getOperand(0), *Op1 = ICmp.getOperand(1); 4626 4627 // Try to canonicalize trunc + compare-to-constant into a mask + cmp. 4628 // The trunc masks high bits while the compare may effectively mask low bits. 4629 Value *X; 4630 const APInt *C; 4631 if (!match(Op0, m_OneUse(m_Trunc(m_Value(X)))) || !match(Op1, m_APInt(C))) 4632 return nullptr; 4633 4634 // This matches patterns corresponding to tests of the signbit as well as: 4635 // (trunc X) u< C --> (X & -C) == 0 (are all masked-high-bits clear?) 4636 // (trunc X) u> C --> (X & ~C) != 0 (are any masked-high-bits set?) 4637 APInt Mask; 4638 if (decomposeBitTestICmp(Op0, Op1, Pred, X, Mask, true /* WithTrunc */)) { 4639 Value *And = Builder.CreateAnd(X, Mask); 4640 Constant *Zero = ConstantInt::getNullValue(X->getType()); 4641 return new ICmpInst(Pred, And, Zero); 4642 } 4643 4644 unsigned SrcBits = X->getType()->getScalarSizeInBits(); 4645 if (Pred == ICmpInst::ICMP_ULT && C->isNegatedPowerOf2()) { 4646 // If C is a negative power-of-2 (high-bit mask): 4647 // (trunc X) u< C --> (X & C) != C (are any masked-high-bits clear?) 4648 Constant *MaskC = ConstantInt::get(X->getType(), C->zext(SrcBits)); 4649 Value *And = Builder.CreateAnd(X, MaskC); 4650 return new ICmpInst(ICmpInst::ICMP_NE, And, MaskC); 4651 } 4652 4653 if (Pred == ICmpInst::ICMP_UGT && (~*C).isPowerOf2()) { 4654 // If C is not-of-power-of-2 (one clear bit): 4655 // (trunc X) u> C --> (X & (C+1)) == C+1 (are all masked-high-bits set?) 4656 Constant *MaskC = ConstantInt::get(X->getType(), (*C + 1).zext(SrcBits)); 4657 Value *And = Builder.CreateAnd(X, MaskC); 4658 return new ICmpInst(ICmpInst::ICMP_EQ, And, MaskC); 4659 } 4660 4661 return nullptr; 4662 } 4663 4664 static Instruction *foldICmpWithZextOrSext(ICmpInst &ICmp, 4665 InstCombiner::BuilderTy &Builder) { 4666 assert(isa<CastInst>(ICmp.getOperand(0)) && "Expected cast for operand 0"); 4667 auto *CastOp0 = cast<CastInst>(ICmp.getOperand(0)); 4668 Value *X; 4669 if (!match(CastOp0, m_ZExtOrSExt(m_Value(X)))) 4670 return nullptr; 4671 4672 bool IsSignedExt = CastOp0->getOpcode() == Instruction::SExt; 4673 bool IsSignedCmp = ICmp.isSigned(); 4674 if (auto *CastOp1 = dyn_cast<CastInst>(ICmp.getOperand(1))) { 4675 // If the signedness of the two casts doesn't agree (i.e. one is a sext 4676 // and the other is a zext), then we can't handle this. 4677 // TODO: This is too strict. We can handle some predicates (equality?). 4678 if (CastOp0->getOpcode() != CastOp1->getOpcode()) 4679 return nullptr; 4680 4681 // Not an extension from the same type? 4682 Value *Y = CastOp1->getOperand(0); 4683 Type *XTy = X->getType(), *YTy = Y->getType(); 4684 if (XTy != YTy) { 4685 // One of the casts must have one use because we are creating a new cast. 4686 if (!CastOp0->hasOneUse() && !CastOp1->hasOneUse()) 4687 return nullptr; 4688 // Extend the narrower operand to the type of the wider operand. 4689 if (XTy->getScalarSizeInBits() < YTy->getScalarSizeInBits()) 4690 X = Builder.CreateCast(CastOp0->getOpcode(), X, YTy); 4691 else if (YTy->getScalarSizeInBits() < XTy->getScalarSizeInBits()) 4692 Y = Builder.CreateCast(CastOp0->getOpcode(), Y, XTy); 4693 else 4694 return nullptr; 4695 } 4696 4697 // (zext X) == (zext Y) --> X == Y 4698 // (sext X) == (sext Y) --> X == Y 4699 if (ICmp.isEquality()) 4700 return new ICmpInst(ICmp.getPredicate(), X, Y); 4701 4702 // A signed comparison of sign extended values simplifies into a 4703 // signed comparison. 4704 if (IsSignedCmp && IsSignedExt) 4705 return new ICmpInst(ICmp.getPredicate(), X, Y); 4706 4707 // The other three cases all fold into an unsigned comparison. 4708 return new ICmpInst(ICmp.getUnsignedPredicate(), X, Y); 4709 } 4710 4711 // Below here, we are only folding a compare with constant. 4712 auto *C = dyn_cast<Constant>(ICmp.getOperand(1)); 4713 if (!C) 4714 return nullptr; 4715 4716 // Compute the constant that would happen if we truncated to SrcTy then 4717 // re-extended to DestTy. 4718 Type *SrcTy = CastOp0->getSrcTy(); 4719 Type *DestTy = CastOp0->getDestTy(); 4720 Constant *Res1 = ConstantExpr::getTrunc(C, SrcTy); 4721 Constant *Res2 = ConstantExpr::getCast(CastOp0->getOpcode(), Res1, DestTy); 4722 4723 // If the re-extended constant didn't change... 4724 if (Res2 == C) { 4725 if (ICmp.isEquality()) 4726 return new ICmpInst(ICmp.getPredicate(), X, Res1); 4727 4728 // A signed comparison of sign extended values simplifies into a 4729 // signed comparison. 4730 if (IsSignedExt && IsSignedCmp) 4731 return new ICmpInst(ICmp.getPredicate(), X, Res1); 4732 4733 // The other three cases all fold into an unsigned comparison. 4734 return new ICmpInst(ICmp.getUnsignedPredicate(), X, Res1); 4735 } 4736 4737 // The re-extended constant changed, partly changed (in the case of a vector), 4738 // or could not be determined to be equal (in the case of a constant 4739 // expression), so the constant cannot be represented in the shorter type. 4740 // All the cases that fold to true or false will have already been handled 4741 // by SimplifyICmpInst, so only deal with the tricky case. 4742 if (IsSignedCmp || !IsSignedExt || !isa<ConstantInt>(C)) 4743 return nullptr; 4744 4745 // Is source op positive? 4746 // icmp ult (sext X), C --> icmp sgt X, -1 4747 if (ICmp.getPredicate() == ICmpInst::ICMP_ULT) 4748 return new ICmpInst(CmpInst::ICMP_SGT, X, Constant::getAllOnesValue(SrcTy)); 4749 4750 // Is source op negative? 4751 // icmp ugt (sext X), C --> icmp slt X, 0 4752 assert(ICmp.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!"); 4753 return new ICmpInst(CmpInst::ICMP_SLT, X, Constant::getNullValue(SrcTy)); 4754 } 4755 4756 /// Handle icmp (cast x), (cast or constant). 4757 Instruction *InstCombinerImpl::foldICmpWithCastOp(ICmpInst &ICmp) { 4758 // If any operand of ICmp is a inttoptr roundtrip cast then remove it as 4759 // icmp compares only pointer's value. 4760 // icmp (inttoptr (ptrtoint p1)), p2 --> icmp p1, p2. 4761 Value *SimplifiedOp0 = simplifyIntToPtrRoundTripCast(ICmp.getOperand(0)); 4762 Value *SimplifiedOp1 = simplifyIntToPtrRoundTripCast(ICmp.getOperand(1)); 4763 if (SimplifiedOp0 || SimplifiedOp1) 4764 return new ICmpInst(ICmp.getPredicate(), 4765 SimplifiedOp0 ? SimplifiedOp0 : ICmp.getOperand(0), 4766 SimplifiedOp1 ? SimplifiedOp1 : ICmp.getOperand(1)); 4767 4768 auto *CastOp0 = dyn_cast<CastInst>(ICmp.getOperand(0)); 4769 if (!CastOp0) 4770 return nullptr; 4771 if (!isa<Constant>(ICmp.getOperand(1)) && !isa<CastInst>(ICmp.getOperand(1))) 4772 return nullptr; 4773 4774 Value *Op0Src = CastOp0->getOperand(0); 4775 Type *SrcTy = CastOp0->getSrcTy(); 4776 Type *DestTy = CastOp0->getDestTy(); 4777 4778 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the 4779 // integer type is the same size as the pointer type. 4780 auto CompatibleSizes = [&](Type *SrcTy, Type *DestTy) { 4781 if (isa<VectorType>(SrcTy)) { 4782 SrcTy = cast<VectorType>(SrcTy)->getElementType(); 4783 DestTy = cast<VectorType>(DestTy)->getElementType(); 4784 } 4785 return DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth(); 4786 }; 4787 if (CastOp0->getOpcode() == Instruction::PtrToInt && 4788 CompatibleSizes(SrcTy, DestTy)) { 4789 Value *NewOp1 = nullptr; 4790 if (auto *PtrToIntOp1 = dyn_cast<PtrToIntOperator>(ICmp.getOperand(1))) { 4791 Value *PtrSrc = PtrToIntOp1->getOperand(0); 4792 if (PtrSrc->getType()->getPointerAddressSpace() == 4793 Op0Src->getType()->getPointerAddressSpace()) { 4794 NewOp1 = PtrToIntOp1->getOperand(0); 4795 // If the pointer types don't match, insert a bitcast. 4796 if (Op0Src->getType() != NewOp1->getType()) 4797 NewOp1 = Builder.CreateBitCast(NewOp1, Op0Src->getType()); 4798 } 4799 } else if (auto *RHSC = dyn_cast<Constant>(ICmp.getOperand(1))) { 4800 NewOp1 = ConstantExpr::getIntToPtr(RHSC, SrcTy); 4801 } 4802 4803 if (NewOp1) 4804 return new ICmpInst(ICmp.getPredicate(), Op0Src, NewOp1); 4805 } 4806 4807 if (Instruction *R = foldICmpWithTrunc(ICmp, Builder)) 4808 return R; 4809 4810 return foldICmpWithZextOrSext(ICmp, Builder); 4811 } 4812 4813 static bool isNeutralValue(Instruction::BinaryOps BinaryOp, Value *RHS) { 4814 switch (BinaryOp) { 4815 default: 4816 llvm_unreachable("Unsupported binary op"); 4817 case Instruction::Add: 4818 case Instruction::Sub: 4819 return match(RHS, m_Zero()); 4820 case Instruction::Mul: 4821 return match(RHS, m_One()); 4822 } 4823 } 4824 4825 OverflowResult 4826 InstCombinerImpl::computeOverflow(Instruction::BinaryOps BinaryOp, 4827 bool IsSigned, Value *LHS, Value *RHS, 4828 Instruction *CxtI) const { 4829 switch (BinaryOp) { 4830 default: 4831 llvm_unreachable("Unsupported binary op"); 4832 case Instruction::Add: 4833 if (IsSigned) 4834 return computeOverflowForSignedAdd(LHS, RHS, CxtI); 4835 else 4836 return computeOverflowForUnsignedAdd(LHS, RHS, CxtI); 4837 case Instruction::Sub: 4838 if (IsSigned) 4839 return computeOverflowForSignedSub(LHS, RHS, CxtI); 4840 else 4841 return computeOverflowForUnsignedSub(LHS, RHS, CxtI); 4842 case Instruction::Mul: 4843 if (IsSigned) 4844 return computeOverflowForSignedMul(LHS, RHS, CxtI); 4845 else 4846 return computeOverflowForUnsignedMul(LHS, RHS, CxtI); 4847 } 4848 } 4849 4850 bool InstCombinerImpl::OptimizeOverflowCheck(Instruction::BinaryOps BinaryOp, 4851 bool IsSigned, Value *LHS, 4852 Value *RHS, Instruction &OrigI, 4853 Value *&Result, 4854 Constant *&Overflow) { 4855 if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS)) 4856 std::swap(LHS, RHS); 4857 4858 // If the overflow check was an add followed by a compare, the insertion point 4859 // may be pointing to the compare. We want to insert the new instructions 4860 // before the add in case there are uses of the add between the add and the 4861 // compare. 4862 Builder.SetInsertPoint(&OrigI); 4863 4864 Type *OverflowTy = Type::getInt1Ty(LHS->getContext()); 4865 if (auto *LHSTy = dyn_cast<VectorType>(LHS->getType())) 4866 OverflowTy = VectorType::get(OverflowTy, LHSTy->getElementCount()); 4867 4868 if (isNeutralValue(BinaryOp, RHS)) { 4869 Result = LHS; 4870 Overflow = ConstantInt::getFalse(OverflowTy); 4871 return true; 4872 } 4873 4874 switch (computeOverflow(BinaryOp, IsSigned, LHS, RHS, &OrigI)) { 4875 case OverflowResult::MayOverflow: 4876 return false; 4877 case OverflowResult::AlwaysOverflowsLow: 4878 case OverflowResult::AlwaysOverflowsHigh: 4879 Result = Builder.CreateBinOp(BinaryOp, LHS, RHS); 4880 Result->takeName(&OrigI); 4881 Overflow = ConstantInt::getTrue(OverflowTy); 4882 return true; 4883 case OverflowResult::NeverOverflows: 4884 Result = Builder.CreateBinOp(BinaryOp, LHS, RHS); 4885 Result->takeName(&OrigI); 4886 Overflow = ConstantInt::getFalse(OverflowTy); 4887 if (auto *Inst = dyn_cast<Instruction>(Result)) { 4888 if (IsSigned) 4889 Inst->setHasNoSignedWrap(); 4890 else 4891 Inst->setHasNoUnsignedWrap(); 4892 } 4893 return true; 4894 } 4895 4896 llvm_unreachable("Unexpected overflow result"); 4897 } 4898 4899 /// Recognize and process idiom involving test for multiplication 4900 /// overflow. 4901 /// 4902 /// The caller has matched a pattern of the form: 4903 /// I = cmp u (mul(zext A, zext B), V 4904 /// The function checks if this is a test for overflow and if so replaces 4905 /// multiplication with call to 'mul.with.overflow' intrinsic. 4906 /// 4907 /// \param I Compare instruction. 4908 /// \param MulVal Result of 'mult' instruction. It is one of the arguments of 4909 /// the compare instruction. Must be of integer type. 4910 /// \param OtherVal The other argument of compare instruction. 4911 /// \returns Instruction which must replace the compare instruction, NULL if no 4912 /// replacement required. 4913 static Instruction *processUMulZExtIdiom(ICmpInst &I, Value *MulVal, 4914 Value *OtherVal, 4915 InstCombinerImpl &IC) { 4916 // Don't bother doing this transformation for pointers, don't do it for 4917 // vectors. 4918 if (!isa<IntegerType>(MulVal->getType())) 4919 return nullptr; 4920 4921 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal); 4922 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal); 4923 auto *MulInstr = dyn_cast<Instruction>(MulVal); 4924 if (!MulInstr) 4925 return nullptr; 4926 assert(MulInstr->getOpcode() == Instruction::Mul); 4927 4928 auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)), 4929 *RHS = cast<ZExtOperator>(MulInstr->getOperand(1)); 4930 assert(LHS->getOpcode() == Instruction::ZExt); 4931 assert(RHS->getOpcode() == Instruction::ZExt); 4932 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0); 4933 4934 // Calculate type and width of the result produced by mul.with.overflow. 4935 Type *TyA = A->getType(), *TyB = B->getType(); 4936 unsigned WidthA = TyA->getPrimitiveSizeInBits(), 4937 WidthB = TyB->getPrimitiveSizeInBits(); 4938 unsigned MulWidth; 4939 Type *MulType; 4940 if (WidthB > WidthA) { 4941 MulWidth = WidthB; 4942 MulType = TyB; 4943 } else { 4944 MulWidth = WidthA; 4945 MulType = TyA; 4946 } 4947 4948 // In order to replace the original mul with a narrower mul.with.overflow, 4949 // all uses must ignore upper bits of the product. The number of used low 4950 // bits must be not greater than the width of mul.with.overflow. 4951 if (MulVal->hasNUsesOrMore(2)) 4952 for (User *U : MulVal->users()) { 4953 if (U == &I) 4954 continue; 4955 if (TruncInst *TI = dyn_cast<TruncInst>(U)) { 4956 // Check if truncation ignores bits above MulWidth. 4957 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits(); 4958 if (TruncWidth > MulWidth) 4959 return nullptr; 4960 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) { 4961 // Check if AND ignores bits above MulWidth. 4962 if (BO->getOpcode() != Instruction::And) 4963 return nullptr; 4964 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) { 4965 const APInt &CVal = CI->getValue(); 4966 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth) 4967 return nullptr; 4968 } else { 4969 // In this case we could have the operand of the binary operation 4970 // being defined in another block, and performing the replacement 4971 // could break the dominance relation. 4972 return nullptr; 4973 } 4974 } else { 4975 // Other uses prohibit this transformation. 4976 return nullptr; 4977 } 4978 } 4979 4980 // Recognize patterns 4981 switch (I.getPredicate()) { 4982 case ICmpInst::ICMP_EQ: 4983 case ICmpInst::ICMP_NE: 4984 // Recognize pattern: 4985 // mulval = mul(zext A, zext B) 4986 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits. 4987 ConstantInt *CI; 4988 Value *ValToMask; 4989 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) { 4990 if (ValToMask != MulVal) 4991 return nullptr; 4992 const APInt &CVal = CI->getValue() + 1; 4993 if (CVal.isPowerOf2()) { 4994 unsigned MaskWidth = CVal.logBase2(); 4995 if (MaskWidth == MulWidth) 4996 break; // Recognized 4997 } 4998 } 4999 return nullptr; 5000 5001 case ICmpInst::ICMP_UGT: 5002 // Recognize pattern: 5003 // mulval = mul(zext A, zext B) 5004 // cmp ugt mulval, max 5005 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 5006 APInt MaxVal = APInt::getMaxValue(MulWidth); 5007 MaxVal = MaxVal.zext(CI->getBitWidth()); 5008 if (MaxVal.eq(CI->getValue())) 5009 break; // Recognized 5010 } 5011 return nullptr; 5012 5013 case ICmpInst::ICMP_UGE: 5014 // Recognize pattern: 5015 // mulval = mul(zext A, zext B) 5016 // cmp uge mulval, max+1 5017 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 5018 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth); 5019 if (MaxVal.eq(CI->getValue())) 5020 break; // Recognized 5021 } 5022 return nullptr; 5023 5024 case ICmpInst::ICMP_ULE: 5025 // Recognize pattern: 5026 // mulval = mul(zext A, zext B) 5027 // cmp ule mulval, max 5028 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 5029 APInt MaxVal = APInt::getMaxValue(MulWidth); 5030 MaxVal = MaxVal.zext(CI->getBitWidth()); 5031 if (MaxVal.eq(CI->getValue())) 5032 break; // Recognized 5033 } 5034 return nullptr; 5035 5036 case ICmpInst::ICMP_ULT: 5037 // Recognize pattern: 5038 // mulval = mul(zext A, zext B) 5039 // cmp ule mulval, max + 1 5040 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) { 5041 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth); 5042 if (MaxVal.eq(CI->getValue())) 5043 break; // Recognized 5044 } 5045 return nullptr; 5046 5047 default: 5048 return nullptr; 5049 } 5050 5051 InstCombiner::BuilderTy &Builder = IC.Builder; 5052 Builder.SetInsertPoint(MulInstr); 5053 5054 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B) 5055 Value *MulA = A, *MulB = B; 5056 if (WidthA < MulWidth) 5057 MulA = Builder.CreateZExt(A, MulType); 5058 if (WidthB < MulWidth) 5059 MulB = Builder.CreateZExt(B, MulType); 5060 Function *F = Intrinsic::getDeclaration( 5061 I.getModule(), Intrinsic::umul_with_overflow, MulType); 5062 CallInst *Call = Builder.CreateCall(F, {MulA, MulB}, "umul"); 5063 IC.addToWorklist(MulInstr); 5064 5065 // If there are uses of mul result other than the comparison, we know that 5066 // they are truncation or binary AND. Change them to use result of 5067 // mul.with.overflow and adjust properly mask/size. 5068 if (MulVal->hasNUsesOrMore(2)) { 5069 Value *Mul = Builder.CreateExtractValue(Call, 0, "umul.value"); 5070 for (User *U : make_early_inc_range(MulVal->users())) { 5071 if (U == &I || U == OtherVal) 5072 continue; 5073 if (TruncInst *TI = dyn_cast<TruncInst>(U)) { 5074 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth) 5075 IC.replaceInstUsesWith(*TI, Mul); 5076 else 5077 TI->setOperand(0, Mul); 5078 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) { 5079 assert(BO->getOpcode() == Instruction::And); 5080 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask) 5081 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1)); 5082 APInt ShortMask = CI->getValue().trunc(MulWidth); 5083 Value *ShortAnd = Builder.CreateAnd(Mul, ShortMask); 5084 Value *Zext = Builder.CreateZExt(ShortAnd, BO->getType()); 5085 IC.replaceInstUsesWith(*BO, Zext); 5086 } else { 5087 llvm_unreachable("Unexpected Binary operation"); 5088 } 5089 IC.addToWorklist(cast<Instruction>(U)); 5090 } 5091 } 5092 if (isa<Instruction>(OtherVal)) 5093 IC.addToWorklist(cast<Instruction>(OtherVal)); 5094 5095 // The original icmp gets replaced with the overflow value, maybe inverted 5096 // depending on predicate. 5097 bool Inverse = false; 5098 switch (I.getPredicate()) { 5099 case ICmpInst::ICMP_NE: 5100 break; 5101 case ICmpInst::ICMP_EQ: 5102 Inverse = true; 5103 break; 5104 case ICmpInst::ICMP_UGT: 5105 case ICmpInst::ICMP_UGE: 5106 if (I.getOperand(0) == MulVal) 5107 break; 5108 Inverse = true; 5109 break; 5110 case ICmpInst::ICMP_ULT: 5111 case ICmpInst::ICMP_ULE: 5112 if (I.getOperand(1) == MulVal) 5113 break; 5114 Inverse = true; 5115 break; 5116 default: 5117 llvm_unreachable("Unexpected predicate"); 5118 } 5119 if (Inverse) { 5120 Value *Res = Builder.CreateExtractValue(Call, 1); 5121 return BinaryOperator::CreateNot(Res); 5122 } 5123 5124 return ExtractValueInst::Create(Call, 1); 5125 } 5126 5127 /// When performing a comparison against a constant, it is possible that not all 5128 /// the bits in the LHS are demanded. This helper method computes the mask that 5129 /// IS demanded. 5130 static APInt getDemandedBitsLHSMask(ICmpInst &I, unsigned BitWidth) { 5131 const APInt *RHS; 5132 if (!match(I.getOperand(1), m_APInt(RHS))) 5133 return APInt::getAllOnes(BitWidth); 5134 5135 // If this is a normal comparison, it demands all bits. If it is a sign bit 5136 // comparison, it only demands the sign bit. 5137 bool UnusedBit; 5138 if (InstCombiner::isSignBitCheck(I.getPredicate(), *RHS, UnusedBit)) 5139 return APInt::getSignMask(BitWidth); 5140 5141 switch (I.getPredicate()) { 5142 // For a UGT comparison, we don't care about any bits that 5143 // correspond to the trailing ones of the comparand. The value of these 5144 // bits doesn't impact the outcome of the comparison, because any value 5145 // greater than the RHS must differ in a bit higher than these due to carry. 5146 case ICmpInst::ICMP_UGT: 5147 return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingOnes()); 5148 5149 // Similarly, for a ULT comparison, we don't care about the trailing zeros. 5150 // Any value less than the RHS must differ in a higher bit because of carries. 5151 case ICmpInst::ICMP_ULT: 5152 return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingZeros()); 5153 5154 default: 5155 return APInt::getAllOnes(BitWidth); 5156 } 5157 } 5158 5159 /// Check if the order of \p Op0 and \p Op1 as operands in an ICmpInst 5160 /// should be swapped. 5161 /// The decision is based on how many times these two operands are reused 5162 /// as subtract operands and their positions in those instructions. 5163 /// The rationale is that several architectures use the same instruction for 5164 /// both subtract and cmp. Thus, it is better if the order of those operands 5165 /// match. 5166 /// \return true if Op0 and Op1 should be swapped. 5167 static bool swapMayExposeCSEOpportunities(const Value *Op0, const Value *Op1) { 5168 // Filter out pointer values as those cannot appear directly in subtract. 5169 // FIXME: we may want to go through inttoptrs or bitcasts. 5170 if (Op0->getType()->isPointerTy()) 5171 return false; 5172 // If a subtract already has the same operands as a compare, swapping would be 5173 // bad. If a subtract has the same operands as a compare but in reverse order, 5174 // then swapping is good. 5175 int GoodToSwap = 0; 5176 for (const User *U : Op0->users()) { 5177 if (match(U, m_Sub(m_Specific(Op1), m_Specific(Op0)))) 5178 GoodToSwap++; 5179 else if (match(U, m_Sub(m_Specific(Op0), m_Specific(Op1)))) 5180 GoodToSwap--; 5181 } 5182 return GoodToSwap > 0; 5183 } 5184 5185 /// Check that one use is in the same block as the definition and all 5186 /// other uses are in blocks dominated by a given block. 5187 /// 5188 /// \param DI Definition 5189 /// \param UI Use 5190 /// \param DB Block that must dominate all uses of \p DI outside 5191 /// the parent block 5192 /// \return true when \p UI is the only use of \p DI in the parent block 5193 /// and all other uses of \p DI are in blocks dominated by \p DB. 5194 /// 5195 bool InstCombinerImpl::dominatesAllUses(const Instruction *DI, 5196 const Instruction *UI, 5197 const BasicBlock *DB) const { 5198 assert(DI && UI && "Instruction not defined\n"); 5199 // Ignore incomplete definitions. 5200 if (!DI->getParent()) 5201 return false; 5202 // DI and UI must be in the same block. 5203 if (DI->getParent() != UI->getParent()) 5204 return false; 5205 // Protect from self-referencing blocks. 5206 if (DI->getParent() == DB) 5207 return false; 5208 for (const User *U : DI->users()) { 5209 auto *Usr = cast<Instruction>(U); 5210 if (Usr != UI && !DT.dominates(DB, Usr->getParent())) 5211 return false; 5212 } 5213 return true; 5214 } 5215 5216 /// Return true when the instruction sequence within a block is select-cmp-br. 5217 static bool isChainSelectCmpBranch(const SelectInst *SI) { 5218 const BasicBlock *BB = SI->getParent(); 5219 if (!BB) 5220 return false; 5221 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator()); 5222 if (!BI || BI->getNumSuccessors() != 2) 5223 return false; 5224 auto *IC = dyn_cast<ICmpInst>(BI->getCondition()); 5225 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI)) 5226 return false; 5227 return true; 5228 } 5229 5230 /// True when a select result is replaced by one of its operands 5231 /// in select-icmp sequence. This will eventually result in the elimination 5232 /// of the select. 5233 /// 5234 /// \param SI Select instruction 5235 /// \param Icmp Compare instruction 5236 /// \param SIOpd Operand that replaces the select 5237 /// 5238 /// Notes: 5239 /// - The replacement is global and requires dominator information 5240 /// - The caller is responsible for the actual replacement 5241 /// 5242 /// Example: 5243 /// 5244 /// entry: 5245 /// %4 = select i1 %3, %C* %0, %C* null 5246 /// %5 = icmp eq %C* %4, null 5247 /// br i1 %5, label %9, label %7 5248 /// ... 5249 /// ; <label>:7 ; preds = %entry 5250 /// %8 = getelementptr inbounds %C* %4, i64 0, i32 0 5251 /// ... 5252 /// 5253 /// can be transformed to 5254 /// 5255 /// %5 = icmp eq %C* %0, null 5256 /// %6 = select i1 %3, i1 %5, i1 true 5257 /// br i1 %6, label %9, label %7 5258 /// ... 5259 /// ; <label>:7 ; preds = %entry 5260 /// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0! 5261 /// 5262 /// Similar when the first operand of the select is a constant or/and 5263 /// the compare is for not equal rather than equal. 5264 /// 5265 /// NOTE: The function is only called when the select and compare constants 5266 /// are equal, the optimization can work only for EQ predicates. This is not a 5267 /// major restriction since a NE compare should be 'normalized' to an equal 5268 /// compare, which usually happens in the combiner and test case 5269 /// select-cmp-br.ll checks for it. 5270 bool InstCombinerImpl::replacedSelectWithOperand(SelectInst *SI, 5271 const ICmpInst *Icmp, 5272 const unsigned SIOpd) { 5273 assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!"); 5274 if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) { 5275 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1); 5276 // The check for the single predecessor is not the best that can be 5277 // done. But it protects efficiently against cases like when SI's 5278 // home block has two successors, Succ and Succ1, and Succ1 predecessor 5279 // of Succ. Then SI can't be replaced by SIOpd because the use that gets 5280 // replaced can be reached on either path. So the uniqueness check 5281 // guarantees that the path all uses of SI (outside SI's parent) are on 5282 // is disjoint from all other paths out of SI. But that information 5283 // is more expensive to compute, and the trade-off here is in favor 5284 // of compile-time. It should also be noticed that we check for a single 5285 // predecessor and not only uniqueness. This to handle the situation when 5286 // Succ and Succ1 points to the same basic block. 5287 if (Succ->getSinglePredecessor() && dominatesAllUses(SI, Icmp, Succ)) { 5288 NumSel++; 5289 SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent()); 5290 return true; 5291 } 5292 } 5293 return false; 5294 } 5295 5296 /// Try to fold the comparison based on range information we can get by checking 5297 /// whether bits are known to be zero or one in the inputs. 5298 Instruction *InstCombinerImpl::foldICmpUsingKnownBits(ICmpInst &I) { 5299 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 5300 Type *Ty = Op0->getType(); 5301 ICmpInst::Predicate Pred = I.getPredicate(); 5302 5303 // Get scalar or pointer size. 5304 unsigned BitWidth = Ty->isIntOrIntVectorTy() 5305 ? Ty->getScalarSizeInBits() 5306 : DL.getPointerTypeSizeInBits(Ty->getScalarType()); 5307 5308 if (!BitWidth) 5309 return nullptr; 5310 5311 KnownBits Op0Known(BitWidth); 5312 KnownBits Op1Known(BitWidth); 5313 5314 if (SimplifyDemandedBits(&I, 0, 5315 getDemandedBitsLHSMask(I, BitWidth), 5316 Op0Known, 0)) 5317 return &I; 5318 5319 if (SimplifyDemandedBits(&I, 1, APInt::getAllOnes(BitWidth), Op1Known, 0)) 5320 return &I; 5321 5322 // Given the known and unknown bits, compute a range that the LHS could be 5323 // in. Compute the Min, Max and RHS values based on the known bits. For the 5324 // EQ and NE we use unsigned values. 5325 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0); 5326 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0); 5327 if (I.isSigned()) { 5328 Op0Min = Op0Known.getSignedMinValue(); 5329 Op0Max = Op0Known.getSignedMaxValue(); 5330 Op1Min = Op1Known.getSignedMinValue(); 5331 Op1Max = Op1Known.getSignedMaxValue(); 5332 } else { 5333 Op0Min = Op0Known.getMinValue(); 5334 Op0Max = Op0Known.getMaxValue(); 5335 Op1Min = Op1Known.getMinValue(); 5336 Op1Max = Op1Known.getMaxValue(); 5337 } 5338 5339 // If Min and Max are known to be the same, then SimplifyDemandedBits figured 5340 // out that the LHS or RHS is a constant. Constant fold this now, so that 5341 // code below can assume that Min != Max. 5342 if (!isa<Constant>(Op0) && Op0Min == Op0Max) 5343 return new ICmpInst(Pred, ConstantExpr::getIntegerValue(Ty, Op0Min), Op1); 5344 if (!isa<Constant>(Op1) && Op1Min == Op1Max) 5345 return new ICmpInst(Pred, Op0, ConstantExpr::getIntegerValue(Ty, Op1Min)); 5346 5347 // Don't break up a clamp pattern -- (min(max X, Y), Z) -- by replacing a 5348 // min/max canonical compare with some other compare. That could lead to 5349 // conflict with select canonicalization and infinite looping. 5350 // FIXME: This constraint may go away if min/max intrinsics are canonical. 5351 auto isMinMaxCmp = [&](Instruction &Cmp) { 5352 if (!Cmp.hasOneUse()) 5353 return false; 5354 Value *A, *B; 5355 SelectPatternFlavor SPF = matchSelectPattern(Cmp.user_back(), A, B).Flavor; 5356 if (!SelectPatternResult::isMinOrMax(SPF)) 5357 return false; 5358 return match(Op0, m_MaxOrMin(m_Value(), m_Value())) || 5359 match(Op1, m_MaxOrMin(m_Value(), m_Value())); 5360 }; 5361 if (!isMinMaxCmp(I)) { 5362 switch (Pred) { 5363 default: 5364 break; 5365 case ICmpInst::ICMP_ULT: { 5366 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B) 5367 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 5368 const APInt *CmpC; 5369 if (match(Op1, m_APInt(CmpC))) { 5370 // A <u C -> A == C-1 if min(A)+1 == C 5371 if (*CmpC == Op0Min + 1) 5372 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 5373 ConstantInt::get(Op1->getType(), *CmpC - 1)); 5374 // X <u C --> X == 0, if the number of zero bits in the bottom of X 5375 // exceeds the log2 of C. 5376 if (Op0Known.countMinTrailingZeros() >= CmpC->ceilLogBase2()) 5377 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 5378 Constant::getNullValue(Op1->getType())); 5379 } 5380 break; 5381 } 5382 case ICmpInst::ICMP_UGT: { 5383 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B) 5384 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 5385 const APInt *CmpC; 5386 if (match(Op1, m_APInt(CmpC))) { 5387 // A >u C -> A == C+1 if max(a)-1 == C 5388 if (*CmpC == Op0Max - 1) 5389 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 5390 ConstantInt::get(Op1->getType(), *CmpC + 1)); 5391 // X >u C --> X != 0, if the number of zero bits in the bottom of X 5392 // exceeds the log2 of C. 5393 if (Op0Known.countMinTrailingZeros() >= CmpC->getActiveBits()) 5394 return new ICmpInst(ICmpInst::ICMP_NE, Op0, 5395 Constant::getNullValue(Op1->getType())); 5396 } 5397 break; 5398 } 5399 case ICmpInst::ICMP_SLT: { 5400 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B) 5401 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 5402 const APInt *CmpC; 5403 if (match(Op1, m_APInt(CmpC))) { 5404 if (*CmpC == Op0Min + 1) // A <s C -> A == C-1 if min(A)+1 == C 5405 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 5406 ConstantInt::get(Op1->getType(), *CmpC - 1)); 5407 } 5408 break; 5409 } 5410 case ICmpInst::ICMP_SGT: { 5411 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B) 5412 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1); 5413 const APInt *CmpC; 5414 if (match(Op1, m_APInt(CmpC))) { 5415 if (*CmpC == Op0Max - 1) // A >s C -> A == C+1 if max(A)-1 == C 5416 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, 5417 ConstantInt::get(Op1->getType(), *CmpC + 1)); 5418 } 5419 break; 5420 } 5421 } 5422 } 5423 5424 // Based on the range information we know about the LHS, see if we can 5425 // simplify this comparison. For example, (x&4) < 8 is always true. 5426 switch (Pred) { 5427 default: 5428 llvm_unreachable("Unknown icmp opcode!"); 5429 case ICmpInst::ICMP_EQ: 5430 case ICmpInst::ICMP_NE: { 5431 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max)) 5432 return replaceInstUsesWith( 5433 I, ConstantInt::getBool(I.getType(), Pred == CmpInst::ICMP_NE)); 5434 5435 // If all bits are known zero except for one, then we know at most one bit 5436 // is set. If the comparison is against zero, then this is a check to see if 5437 // *that* bit is set. 5438 APInt Op0KnownZeroInverted = ~Op0Known.Zero; 5439 if (Op1Known.isZero()) { 5440 // If the LHS is an AND with the same constant, look through it. 5441 Value *LHS = nullptr; 5442 const APInt *LHSC; 5443 if (!match(Op0, m_And(m_Value(LHS), m_APInt(LHSC))) || 5444 *LHSC != Op0KnownZeroInverted) 5445 LHS = Op0; 5446 5447 Value *X; 5448 if (match(LHS, m_Shl(m_One(), m_Value(X)))) { 5449 APInt ValToCheck = Op0KnownZeroInverted; 5450 Type *XTy = X->getType(); 5451 if (ValToCheck.isPowerOf2()) { 5452 // ((1 << X) & 8) == 0 -> X != 3 5453 // ((1 << X) & 8) != 0 -> X == 3 5454 auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros()); 5455 auto NewPred = ICmpInst::getInversePredicate(Pred); 5456 return new ICmpInst(NewPred, X, CmpC); 5457 } else if ((++ValToCheck).isPowerOf2()) { 5458 // ((1 << X) & 7) == 0 -> X >= 3 5459 // ((1 << X) & 7) != 0 -> X < 3 5460 auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros()); 5461 auto NewPred = 5462 Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGE : CmpInst::ICMP_ULT; 5463 return new ICmpInst(NewPred, X, CmpC); 5464 } 5465 } 5466 5467 // Check if the LHS is 8 >>u x and the result is a power of 2 like 1. 5468 const APInt *CI; 5469 if (Op0KnownZeroInverted.isOne() && 5470 match(LHS, m_LShr(m_Power2(CI), m_Value(X)))) { 5471 // ((8 >>u X) & 1) == 0 -> X != 3 5472 // ((8 >>u X) & 1) != 0 -> X == 3 5473 unsigned CmpVal = CI->countTrailingZeros(); 5474 auto NewPred = ICmpInst::getInversePredicate(Pred); 5475 return new ICmpInst(NewPred, X, ConstantInt::get(X->getType(), CmpVal)); 5476 } 5477 } 5478 break; 5479 } 5480 case ICmpInst::ICMP_ULT: { 5481 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B) 5482 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5483 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B) 5484 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5485 break; 5486 } 5487 case ICmpInst::ICMP_UGT: { 5488 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B) 5489 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5490 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B) 5491 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5492 break; 5493 } 5494 case ICmpInst::ICMP_SLT: { 5495 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C) 5496 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5497 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C) 5498 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5499 break; 5500 } 5501 case ICmpInst::ICMP_SGT: { 5502 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B) 5503 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5504 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B) 5505 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5506 break; 5507 } 5508 case ICmpInst::ICMP_SGE: 5509 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!"); 5510 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B) 5511 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5512 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B) 5513 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5514 if (Op1Min == Op0Max) // A >=s B -> A == B if max(A) == min(B) 5515 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1); 5516 break; 5517 case ICmpInst::ICMP_SLE: 5518 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!"); 5519 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B) 5520 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5521 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B) 5522 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5523 if (Op1Max == Op0Min) // A <=s B -> A == B if min(A) == max(B) 5524 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1); 5525 break; 5526 case ICmpInst::ICMP_UGE: 5527 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!"); 5528 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B) 5529 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5530 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B) 5531 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5532 if (Op1Min == Op0Max) // A >=u B -> A == B if max(A) == min(B) 5533 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1); 5534 break; 5535 case ICmpInst::ICMP_ULE: 5536 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!"); 5537 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B) 5538 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType())); 5539 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B) 5540 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType())); 5541 if (Op1Max == Op0Min) // A <=u B -> A == B if min(A) == max(B) 5542 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1); 5543 break; 5544 } 5545 5546 // Turn a signed comparison into an unsigned one if both operands are known to 5547 // have the same sign. 5548 if (I.isSigned() && 5549 ((Op0Known.Zero.isNegative() && Op1Known.Zero.isNegative()) || 5550 (Op0Known.One.isNegative() && Op1Known.One.isNegative()))) 5551 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1); 5552 5553 return nullptr; 5554 } 5555 5556 llvm::Optional<std::pair<CmpInst::Predicate, Constant *>> 5557 InstCombiner::getFlippedStrictnessPredicateAndConstant(CmpInst::Predicate Pred, 5558 Constant *C) { 5559 assert(ICmpInst::isRelational(Pred) && ICmpInst::isIntPredicate(Pred) && 5560 "Only for relational integer predicates."); 5561 5562 Type *Type = C->getType(); 5563 bool IsSigned = ICmpInst::isSigned(Pred); 5564 5565 CmpInst::Predicate UnsignedPred = ICmpInst::getUnsignedPredicate(Pred); 5566 bool WillIncrement = 5567 UnsignedPred == ICmpInst::ICMP_ULE || UnsignedPred == ICmpInst::ICMP_UGT; 5568 5569 // Check if the constant operand can be safely incremented/decremented 5570 // without overflowing/underflowing. 5571 auto ConstantIsOk = [WillIncrement, IsSigned](ConstantInt *C) { 5572 return WillIncrement ? !C->isMaxValue(IsSigned) : !C->isMinValue(IsSigned); 5573 }; 5574 5575 Constant *SafeReplacementConstant = nullptr; 5576 if (auto *CI = dyn_cast<ConstantInt>(C)) { 5577 // Bail out if the constant can't be safely incremented/decremented. 5578 if (!ConstantIsOk(CI)) 5579 return llvm::None; 5580 } else if (auto *FVTy = dyn_cast<FixedVectorType>(Type)) { 5581 unsigned NumElts = FVTy->getNumElements(); 5582 for (unsigned i = 0; i != NumElts; ++i) { 5583 Constant *Elt = C->getAggregateElement(i); 5584 if (!Elt) 5585 return llvm::None; 5586 5587 if (isa<UndefValue>(Elt)) 5588 continue; 5589 5590 // Bail out if we can't determine if this constant is min/max or if we 5591 // know that this constant is min/max. 5592 auto *CI = dyn_cast<ConstantInt>(Elt); 5593 if (!CI || !ConstantIsOk(CI)) 5594 return llvm::None; 5595 5596 if (!SafeReplacementConstant) 5597 SafeReplacementConstant = CI; 5598 } 5599 } else { 5600 // ConstantExpr? 5601 return llvm::None; 5602 } 5603 5604 // It may not be safe to change a compare predicate in the presence of 5605 // undefined elements, so replace those elements with the first safe constant 5606 // that we found. 5607 // TODO: in case of poison, it is safe; let's replace undefs only. 5608 if (C->containsUndefOrPoisonElement()) { 5609 assert(SafeReplacementConstant && "Replacement constant not set"); 5610 C = Constant::replaceUndefsWith(C, SafeReplacementConstant); 5611 } 5612 5613 CmpInst::Predicate NewPred = CmpInst::getFlippedStrictnessPredicate(Pred); 5614 5615 // Increment or decrement the constant. 5616 Constant *OneOrNegOne = ConstantInt::get(Type, WillIncrement ? 1 : -1, true); 5617 Constant *NewC = ConstantExpr::getAdd(C, OneOrNegOne); 5618 5619 return std::make_pair(NewPred, NewC); 5620 } 5621 5622 /// If we have an icmp le or icmp ge instruction with a constant operand, turn 5623 /// it into the appropriate icmp lt or icmp gt instruction. This transform 5624 /// allows them to be folded in visitICmpInst. 5625 static ICmpInst *canonicalizeCmpWithConstant(ICmpInst &I) { 5626 ICmpInst::Predicate Pred = I.getPredicate(); 5627 if (ICmpInst::isEquality(Pred) || !ICmpInst::isIntPredicate(Pred) || 5628 InstCombiner::isCanonicalPredicate(Pred)) 5629 return nullptr; 5630 5631 Value *Op0 = I.getOperand(0); 5632 Value *Op1 = I.getOperand(1); 5633 auto *Op1C = dyn_cast<Constant>(Op1); 5634 if (!Op1C) 5635 return nullptr; 5636 5637 auto FlippedStrictness = 5638 InstCombiner::getFlippedStrictnessPredicateAndConstant(Pred, Op1C); 5639 if (!FlippedStrictness) 5640 return nullptr; 5641 5642 return new ICmpInst(FlippedStrictness->first, Op0, FlippedStrictness->second); 5643 } 5644 5645 /// If we have a comparison with a non-canonical predicate, if we can update 5646 /// all the users, invert the predicate and adjust all the users. 5647 CmpInst *InstCombinerImpl::canonicalizeICmpPredicate(CmpInst &I) { 5648 // Is the predicate already canonical? 5649 CmpInst::Predicate Pred = I.getPredicate(); 5650 if (InstCombiner::isCanonicalPredicate(Pred)) 5651 return nullptr; 5652 5653 // Can all users be adjusted to predicate inversion? 5654 if (!InstCombiner::canFreelyInvertAllUsersOf(&I, /*IgnoredUser=*/nullptr)) 5655 return nullptr; 5656 5657 // Ok, we can canonicalize comparison! 5658 // Let's first invert the comparison's predicate. 5659 I.setPredicate(CmpInst::getInversePredicate(Pred)); 5660 I.setName(I.getName() + ".not"); 5661 5662 // And, adapt users. 5663 freelyInvertAllUsersOf(&I); 5664 5665 return &I; 5666 } 5667 5668 /// Integer compare with boolean values can always be turned into bitwise ops. 5669 static Instruction *canonicalizeICmpBool(ICmpInst &I, 5670 InstCombiner::BuilderTy &Builder) { 5671 Value *A = I.getOperand(0), *B = I.getOperand(1); 5672 assert(A->getType()->isIntOrIntVectorTy(1) && "Bools only"); 5673 5674 // A boolean compared to true/false can be simplified to Op0/true/false in 5675 // 14 out of the 20 (10 predicates * 2 constants) possible combinations. 5676 // Cases not handled by InstSimplify are always 'not' of Op0. 5677 if (match(B, m_Zero())) { 5678 switch (I.getPredicate()) { 5679 case CmpInst::ICMP_EQ: // A == 0 -> !A 5680 case CmpInst::ICMP_ULE: // A <=u 0 -> !A 5681 case CmpInst::ICMP_SGE: // A >=s 0 -> !A 5682 return BinaryOperator::CreateNot(A); 5683 default: 5684 llvm_unreachable("ICmp i1 X, C not simplified as expected."); 5685 } 5686 } else if (match(B, m_One())) { 5687 switch (I.getPredicate()) { 5688 case CmpInst::ICMP_NE: // A != 1 -> !A 5689 case CmpInst::ICMP_ULT: // A <u 1 -> !A 5690 case CmpInst::ICMP_SGT: // A >s -1 -> !A 5691 return BinaryOperator::CreateNot(A); 5692 default: 5693 llvm_unreachable("ICmp i1 X, C not simplified as expected."); 5694 } 5695 } 5696 5697 switch (I.getPredicate()) { 5698 default: 5699 llvm_unreachable("Invalid icmp instruction!"); 5700 case ICmpInst::ICMP_EQ: 5701 // icmp eq i1 A, B -> ~(A ^ B) 5702 return BinaryOperator::CreateNot(Builder.CreateXor(A, B)); 5703 5704 case ICmpInst::ICMP_NE: 5705 // icmp ne i1 A, B -> A ^ B 5706 return BinaryOperator::CreateXor(A, B); 5707 5708 case ICmpInst::ICMP_UGT: 5709 // icmp ugt -> icmp ult 5710 std::swap(A, B); 5711 LLVM_FALLTHROUGH; 5712 case ICmpInst::ICMP_ULT: 5713 // icmp ult i1 A, B -> ~A & B 5714 return BinaryOperator::CreateAnd(Builder.CreateNot(A), B); 5715 5716 case ICmpInst::ICMP_SGT: 5717 // icmp sgt -> icmp slt 5718 std::swap(A, B); 5719 LLVM_FALLTHROUGH; 5720 case ICmpInst::ICMP_SLT: 5721 // icmp slt i1 A, B -> A & ~B 5722 return BinaryOperator::CreateAnd(Builder.CreateNot(B), A); 5723 5724 case ICmpInst::ICMP_UGE: 5725 // icmp uge -> icmp ule 5726 std::swap(A, B); 5727 LLVM_FALLTHROUGH; 5728 case ICmpInst::ICMP_ULE: 5729 // icmp ule i1 A, B -> ~A | B 5730 return BinaryOperator::CreateOr(Builder.CreateNot(A), B); 5731 5732 case ICmpInst::ICMP_SGE: 5733 // icmp sge -> icmp sle 5734 std::swap(A, B); 5735 LLVM_FALLTHROUGH; 5736 case ICmpInst::ICMP_SLE: 5737 // icmp sle i1 A, B -> A | ~B 5738 return BinaryOperator::CreateOr(Builder.CreateNot(B), A); 5739 } 5740 } 5741 5742 // Transform pattern like: 5743 // (1 << Y) u<= X or ~(-1 << Y) u< X or ((1 << Y)+(-1)) u< X 5744 // (1 << Y) u> X or ~(-1 << Y) u>= X or ((1 << Y)+(-1)) u>= X 5745 // Into: 5746 // (X l>> Y) != 0 5747 // (X l>> Y) == 0 5748 static Instruction *foldICmpWithHighBitMask(ICmpInst &Cmp, 5749 InstCombiner::BuilderTy &Builder) { 5750 ICmpInst::Predicate Pred, NewPred; 5751 Value *X, *Y; 5752 if (match(&Cmp, 5753 m_c_ICmp(Pred, m_OneUse(m_Shl(m_One(), m_Value(Y))), m_Value(X)))) { 5754 switch (Pred) { 5755 case ICmpInst::ICMP_ULE: 5756 NewPred = ICmpInst::ICMP_NE; 5757 break; 5758 case ICmpInst::ICMP_UGT: 5759 NewPred = ICmpInst::ICMP_EQ; 5760 break; 5761 default: 5762 return nullptr; 5763 } 5764 } else if (match(&Cmp, m_c_ICmp(Pred, 5765 m_OneUse(m_CombineOr( 5766 m_Not(m_Shl(m_AllOnes(), m_Value(Y))), 5767 m_Add(m_Shl(m_One(), m_Value(Y)), 5768 m_AllOnes()))), 5769 m_Value(X)))) { 5770 // The variant with 'add' is not canonical, (the variant with 'not' is) 5771 // we only get it because it has extra uses, and can't be canonicalized, 5772 5773 switch (Pred) { 5774 case ICmpInst::ICMP_ULT: 5775 NewPred = ICmpInst::ICMP_NE; 5776 break; 5777 case ICmpInst::ICMP_UGE: 5778 NewPred = ICmpInst::ICMP_EQ; 5779 break; 5780 default: 5781 return nullptr; 5782 } 5783 } else 5784 return nullptr; 5785 5786 Value *NewX = Builder.CreateLShr(X, Y, X->getName() + ".highbits"); 5787 Constant *Zero = Constant::getNullValue(NewX->getType()); 5788 return CmpInst::Create(Instruction::ICmp, NewPred, NewX, Zero); 5789 } 5790 5791 static Instruction *foldVectorCmp(CmpInst &Cmp, 5792 InstCombiner::BuilderTy &Builder) { 5793 const CmpInst::Predicate Pred = Cmp.getPredicate(); 5794 Value *LHS = Cmp.getOperand(0), *RHS = Cmp.getOperand(1); 5795 Value *V1, *V2; 5796 ArrayRef<int> M; 5797 if (!match(LHS, m_Shuffle(m_Value(V1), m_Undef(), m_Mask(M)))) 5798 return nullptr; 5799 5800 // If both arguments of the cmp are shuffles that use the same mask and 5801 // shuffle within a single vector, move the shuffle after the cmp: 5802 // cmp (shuffle V1, M), (shuffle V2, M) --> shuffle (cmp V1, V2), M 5803 Type *V1Ty = V1->getType(); 5804 if (match(RHS, m_Shuffle(m_Value(V2), m_Undef(), m_SpecificMask(M))) && 5805 V1Ty == V2->getType() && (LHS->hasOneUse() || RHS->hasOneUse())) { 5806 Value *NewCmp = Builder.CreateCmp(Pred, V1, V2); 5807 return new ShuffleVectorInst(NewCmp, M); 5808 } 5809 5810 // Try to canonicalize compare with splatted operand and splat constant. 5811 // TODO: We could generalize this for more than splats. See/use the code in 5812 // InstCombiner::foldVectorBinop(). 5813 Constant *C; 5814 if (!LHS->hasOneUse() || !match(RHS, m_Constant(C))) 5815 return nullptr; 5816 5817 // Length-changing splats are ok, so adjust the constants as needed: 5818 // cmp (shuffle V1, M), C --> shuffle (cmp V1, C'), M 5819 Constant *ScalarC = C->getSplatValue(/* AllowUndefs */ true); 5820 int MaskSplatIndex; 5821 if (ScalarC && match(M, m_SplatOrUndefMask(MaskSplatIndex))) { 5822 // We allow undefs in matching, but this transform removes those for safety. 5823 // Demanded elements analysis should be able to recover some/all of that. 5824 C = ConstantVector::getSplat(cast<VectorType>(V1Ty)->getElementCount(), 5825 ScalarC); 5826 SmallVector<int, 8> NewM(M.size(), MaskSplatIndex); 5827 Value *NewCmp = Builder.CreateCmp(Pred, V1, C); 5828 return new ShuffleVectorInst(NewCmp, NewM); 5829 } 5830 5831 return nullptr; 5832 } 5833 5834 // extract(uadd.with.overflow(A, B), 0) ult A 5835 // -> extract(uadd.with.overflow(A, B), 1) 5836 static Instruction *foldICmpOfUAddOv(ICmpInst &I) { 5837 CmpInst::Predicate Pred = I.getPredicate(); 5838 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 5839 5840 Value *UAddOv; 5841 Value *A, *B; 5842 auto UAddOvResultPat = m_ExtractValue<0>( 5843 m_Intrinsic<Intrinsic::uadd_with_overflow>(m_Value(A), m_Value(B))); 5844 if (match(Op0, UAddOvResultPat) && 5845 ((Pred == ICmpInst::ICMP_ULT && (Op1 == A || Op1 == B)) || 5846 (Pred == ICmpInst::ICMP_EQ && match(Op1, m_ZeroInt()) && 5847 (match(A, m_One()) || match(B, m_One()))) || 5848 (Pred == ICmpInst::ICMP_NE && match(Op1, m_AllOnes()) && 5849 (match(A, m_AllOnes()) || match(B, m_AllOnes()))))) 5850 // extract(uadd.with.overflow(A, B), 0) < A 5851 // extract(uadd.with.overflow(A, 1), 0) == 0 5852 // extract(uadd.with.overflow(A, -1), 0) != -1 5853 UAddOv = cast<ExtractValueInst>(Op0)->getAggregateOperand(); 5854 else if (match(Op1, UAddOvResultPat) && 5855 Pred == ICmpInst::ICMP_UGT && (Op0 == A || Op0 == B)) 5856 // A > extract(uadd.with.overflow(A, B), 0) 5857 UAddOv = cast<ExtractValueInst>(Op1)->getAggregateOperand(); 5858 else 5859 return nullptr; 5860 5861 return ExtractValueInst::Create(UAddOv, 1); 5862 } 5863 5864 static Instruction *foldICmpInvariantGroup(ICmpInst &I) { 5865 if (!I.getOperand(0)->getType()->isPointerTy() || 5866 NullPointerIsDefined( 5867 I.getParent()->getParent(), 5868 I.getOperand(0)->getType()->getPointerAddressSpace())) { 5869 return nullptr; 5870 } 5871 Instruction *Op; 5872 if (match(I.getOperand(0), m_Instruction(Op)) && 5873 match(I.getOperand(1), m_Zero()) && 5874 Op->isLaunderOrStripInvariantGroup()) { 5875 return ICmpInst::Create(Instruction::ICmp, I.getPredicate(), 5876 Op->getOperand(0), I.getOperand(1)); 5877 } 5878 return nullptr; 5879 } 5880 5881 /// This function folds patterns produced by lowering of reduce idioms, such as 5882 /// llvm.vector.reduce.and which are lowered into instruction chains. This code 5883 /// attempts to generate fewer number of scalar comparisons instead of vector 5884 /// comparisons when possible. 5885 static Instruction *foldReductionIdiom(ICmpInst &I, 5886 InstCombiner::BuilderTy &Builder, 5887 const DataLayout &DL) { 5888 if (I.getType()->isVectorTy()) 5889 return nullptr; 5890 ICmpInst::Predicate OuterPred, InnerPred; 5891 Value *LHS, *RHS; 5892 5893 // Match lowering of @llvm.vector.reduce.and. Turn 5894 /// %vec_ne = icmp ne <8 x i8> %lhs, %rhs 5895 /// %scalar_ne = bitcast <8 x i1> %vec_ne to i8 5896 /// %res = icmp <pred> i8 %scalar_ne, 0 5897 /// 5898 /// into 5899 /// 5900 /// %lhs.scalar = bitcast <8 x i8> %lhs to i64 5901 /// %rhs.scalar = bitcast <8 x i8> %rhs to i64 5902 /// %res = icmp <pred> i64 %lhs.scalar, %rhs.scalar 5903 /// 5904 /// for <pred> in {ne, eq}. 5905 if (!match(&I, m_ICmp(OuterPred, 5906 m_OneUse(m_BitCast(m_OneUse( 5907 m_ICmp(InnerPred, m_Value(LHS), m_Value(RHS))))), 5908 m_Zero()))) 5909 return nullptr; 5910 auto *LHSTy = dyn_cast<FixedVectorType>(LHS->getType()); 5911 if (!LHSTy || !LHSTy->getElementType()->isIntegerTy()) 5912 return nullptr; 5913 unsigned NumBits = 5914 LHSTy->getNumElements() * LHSTy->getElementType()->getIntegerBitWidth(); 5915 // TODO: Relax this to "not wider than max legal integer type"? 5916 if (!DL.isLegalInteger(NumBits)) 5917 return nullptr; 5918 5919 if (ICmpInst::isEquality(OuterPred) && InnerPred == ICmpInst::ICMP_NE) { 5920 auto *ScalarTy = Builder.getIntNTy(NumBits); 5921 LHS = Builder.CreateBitCast(LHS, ScalarTy, LHS->getName() + ".scalar"); 5922 RHS = Builder.CreateBitCast(RHS, ScalarTy, RHS->getName() + ".scalar"); 5923 return ICmpInst::Create(Instruction::ICmp, OuterPred, LHS, RHS, 5924 I.getName()); 5925 } 5926 5927 return nullptr; 5928 } 5929 5930 Instruction *InstCombinerImpl::visitICmpInst(ICmpInst &I) { 5931 bool Changed = false; 5932 const SimplifyQuery Q = SQ.getWithInstruction(&I); 5933 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 5934 unsigned Op0Cplxity = getComplexity(Op0); 5935 unsigned Op1Cplxity = getComplexity(Op1); 5936 5937 /// Orders the operands of the compare so that they are listed from most 5938 /// complex to least complex. This puts constants before unary operators, 5939 /// before binary operators. 5940 if (Op0Cplxity < Op1Cplxity || 5941 (Op0Cplxity == Op1Cplxity && swapMayExposeCSEOpportunities(Op0, Op1))) { 5942 I.swapOperands(); 5943 std::swap(Op0, Op1); 5944 Changed = true; 5945 } 5946 5947 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, Q)) 5948 return replaceInstUsesWith(I, V); 5949 5950 // Comparing -val or val with non-zero is the same as just comparing val 5951 // ie, abs(val) != 0 -> val != 0 5952 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero())) { 5953 Value *Cond, *SelectTrue, *SelectFalse; 5954 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue), 5955 m_Value(SelectFalse)))) { 5956 if (Value *V = dyn_castNegVal(SelectTrue)) { 5957 if (V == SelectFalse) 5958 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1); 5959 } 5960 else if (Value *V = dyn_castNegVal(SelectFalse)) { 5961 if (V == SelectTrue) 5962 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1); 5963 } 5964 } 5965 } 5966 5967 if (Op0->getType()->isIntOrIntVectorTy(1)) 5968 if (Instruction *Res = canonicalizeICmpBool(I, Builder)) 5969 return Res; 5970 5971 if (Instruction *Res = canonicalizeCmpWithConstant(I)) 5972 return Res; 5973 5974 if (Instruction *Res = canonicalizeICmpPredicate(I)) 5975 return Res; 5976 5977 if (Instruction *Res = foldICmpWithConstant(I)) 5978 return Res; 5979 5980 if (Instruction *Res = foldICmpWithDominatingICmp(I)) 5981 return Res; 5982 5983 if (Instruction *Res = foldICmpUsingKnownBits(I)) 5984 return Res; 5985 5986 // Test if the ICmpInst instruction is used exclusively by a select as 5987 // part of a minimum or maximum operation. If so, refrain from doing 5988 // any other folding. This helps out other analyses which understand 5989 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution 5990 // and CodeGen. And in this case, at least one of the comparison 5991 // operands has at least one user besides the compare (the select), 5992 // which would often largely negate the benefit of folding anyway. 5993 // 5994 // Do the same for the other patterns recognized by matchSelectPattern. 5995 if (I.hasOneUse()) 5996 if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) { 5997 Value *A, *B; 5998 SelectPatternResult SPR = matchSelectPattern(SI, A, B); 5999 if (SPR.Flavor != SPF_UNKNOWN) 6000 return nullptr; 6001 } 6002 6003 // Do this after checking for min/max to prevent infinite looping. 6004 if (Instruction *Res = foldICmpWithZero(I)) 6005 return Res; 6006 6007 // FIXME: We only do this after checking for min/max to prevent infinite 6008 // looping caused by a reverse canonicalization of these patterns for min/max. 6009 // FIXME: The organization of folds is a mess. These would naturally go into 6010 // canonicalizeCmpWithConstant(), but we can't move all of the above folds 6011 // down here after the min/max restriction. 6012 ICmpInst::Predicate Pred = I.getPredicate(); 6013 const APInt *C; 6014 if (match(Op1, m_APInt(C))) { 6015 // For i32: x >u 2147483647 -> x <s 0 -> true if sign bit set 6016 if (Pred == ICmpInst::ICMP_UGT && C->isMaxSignedValue()) { 6017 Constant *Zero = Constant::getNullValue(Op0->getType()); 6018 return new ICmpInst(ICmpInst::ICMP_SLT, Op0, Zero); 6019 } 6020 6021 // For i32: x <u 2147483648 -> x >s -1 -> true if sign bit clear 6022 if (Pred == ICmpInst::ICMP_ULT && C->isMinSignedValue()) { 6023 Constant *AllOnes = Constant::getAllOnesValue(Op0->getType()); 6024 return new ICmpInst(ICmpInst::ICMP_SGT, Op0, AllOnes); 6025 } 6026 } 6027 6028 // The folds in here may rely on wrapping flags and special constants, so 6029 // they can break up min/max idioms in some cases but not seemingly similar 6030 // patterns. 6031 // FIXME: It may be possible to enhance select folding to make this 6032 // unnecessary. It may also be moot if we canonicalize to min/max 6033 // intrinsics. 6034 if (Instruction *Res = foldICmpBinOp(I, Q)) 6035 return Res; 6036 6037 if (Instruction *Res = foldICmpInstWithConstant(I)) 6038 return Res; 6039 6040 // Try to match comparison as a sign bit test. Intentionally do this after 6041 // foldICmpInstWithConstant() to potentially let other folds to happen first. 6042 if (Instruction *New = foldSignBitTest(I)) 6043 return New; 6044 6045 if (Instruction *Res = foldICmpInstWithConstantNotInt(I)) 6046 return Res; 6047 6048 // Try to optimize 'icmp GEP, P' or 'icmp P, GEP'. 6049 if (auto *GEP = dyn_cast<GEPOperator>(Op0)) 6050 if (Instruction *NI = foldGEPICmp(GEP, Op1, I.getPredicate(), I)) 6051 return NI; 6052 if (auto *GEP = dyn_cast<GEPOperator>(Op1)) 6053 if (Instruction *NI = foldGEPICmp(GEP, Op0, I.getSwappedPredicate(), I)) 6054 return NI; 6055 6056 // Try to optimize equality comparisons against alloca-based pointers. 6057 if (Op0->getType()->isPointerTy() && I.isEquality()) { 6058 assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?"); 6059 if (auto *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(Op0))) 6060 if (Instruction *New = foldAllocaCmp(I, Alloca)) 6061 return New; 6062 if (auto *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(Op1))) 6063 if (Instruction *New = foldAllocaCmp(I, Alloca)) 6064 return New; 6065 } 6066 6067 if (Instruction *Res = foldICmpBitCast(I)) 6068 return Res; 6069 6070 // TODO: Hoist this above the min/max bailout. 6071 if (Instruction *R = foldICmpWithCastOp(I)) 6072 return R; 6073 6074 if (Instruction *Res = foldICmpWithMinMax(I)) 6075 return Res; 6076 6077 { 6078 Value *A, *B; 6079 // Transform (A & ~B) == 0 --> (A & B) != 0 6080 // and (A & ~B) != 0 --> (A & B) == 0 6081 // if A is a power of 2. 6082 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) && 6083 match(Op1, m_Zero()) && 6084 isKnownToBeAPowerOfTwo(A, false, 0, &I) && I.isEquality()) 6085 return new ICmpInst(I.getInversePredicate(), Builder.CreateAnd(A, B), 6086 Op1); 6087 6088 // ~X < ~Y --> Y < X 6089 // ~X < C --> X > ~C 6090 if (match(Op0, m_Not(m_Value(A)))) { 6091 if (match(Op1, m_Not(m_Value(B)))) 6092 return new ICmpInst(I.getPredicate(), B, A); 6093 6094 const APInt *C; 6095 if (match(Op1, m_APInt(C))) 6096 return new ICmpInst(I.getSwappedPredicate(), A, 6097 ConstantInt::get(Op1->getType(), ~(*C))); 6098 } 6099 6100 Instruction *AddI = nullptr; 6101 if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B), 6102 m_Instruction(AddI))) && 6103 isa<IntegerType>(A->getType())) { 6104 Value *Result; 6105 Constant *Overflow; 6106 // m_UAddWithOverflow can match patterns that do not include an explicit 6107 // "add" instruction, so check the opcode of the matched op. 6108 if (AddI->getOpcode() == Instruction::Add && 6109 OptimizeOverflowCheck(Instruction::Add, /*Signed*/ false, A, B, *AddI, 6110 Result, Overflow)) { 6111 replaceInstUsesWith(*AddI, Result); 6112 eraseInstFromFunction(*AddI); 6113 return replaceInstUsesWith(I, Overflow); 6114 } 6115 } 6116 6117 // (zext a) * (zext b) --> llvm.umul.with.overflow. 6118 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) { 6119 if (Instruction *R = processUMulZExtIdiom(I, Op0, Op1, *this)) 6120 return R; 6121 } 6122 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) { 6123 if (Instruction *R = processUMulZExtIdiom(I, Op1, Op0, *this)) 6124 return R; 6125 } 6126 } 6127 6128 if (Instruction *Res = foldICmpEquality(I)) 6129 return Res; 6130 6131 if (Instruction *Res = foldICmpOfUAddOv(I)) 6132 return Res; 6133 6134 // The 'cmpxchg' instruction returns an aggregate containing the old value and 6135 // an i1 which indicates whether or not we successfully did the swap. 6136 // 6137 // Replace comparisons between the old value and the expected value with the 6138 // indicator that 'cmpxchg' returns. 6139 // 6140 // N.B. This transform is only valid when the 'cmpxchg' is not permitted to 6141 // spuriously fail. In those cases, the old value may equal the expected 6142 // value but it is possible for the swap to not occur. 6143 if (I.getPredicate() == ICmpInst::ICMP_EQ) 6144 if (auto *EVI = dyn_cast<ExtractValueInst>(Op0)) 6145 if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand())) 6146 if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 && 6147 !ACXI->isWeak()) 6148 return ExtractValueInst::Create(ACXI, 1); 6149 6150 { 6151 Value *X; 6152 const APInt *C; 6153 // icmp X+Cst, X 6154 if (match(Op0, m_Add(m_Value(X), m_APInt(C))) && Op1 == X) 6155 return foldICmpAddOpConst(X, *C, I.getPredicate()); 6156 6157 // icmp X, X+Cst 6158 if (match(Op1, m_Add(m_Value(X), m_APInt(C))) && Op0 == X) 6159 return foldICmpAddOpConst(X, *C, I.getSwappedPredicate()); 6160 } 6161 6162 if (Instruction *Res = foldICmpWithHighBitMask(I, Builder)) 6163 return Res; 6164 6165 if (I.getType()->isVectorTy()) 6166 if (Instruction *Res = foldVectorCmp(I, Builder)) 6167 return Res; 6168 6169 if (Instruction *Res = foldICmpInvariantGroup(I)) 6170 return Res; 6171 6172 if (Instruction *Res = foldReductionIdiom(I, Builder, DL)) 6173 return Res; 6174 6175 return Changed ? &I : nullptr; 6176 } 6177 6178 /// Fold fcmp ([us]itofp x, cst) if possible. 6179 Instruction *InstCombinerImpl::foldFCmpIntToFPConst(FCmpInst &I, 6180 Instruction *LHSI, 6181 Constant *RHSC) { 6182 if (!isa<ConstantFP>(RHSC)) return nullptr; 6183 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF(); 6184 6185 // Get the width of the mantissa. We don't want to hack on conversions that 6186 // might lose information from the integer, e.g. "i64 -> float" 6187 int MantissaWidth = LHSI->getType()->getFPMantissaWidth(); 6188 if (MantissaWidth == -1) return nullptr; // Unknown. 6189 6190 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType()); 6191 6192 bool LHSUnsigned = isa<UIToFPInst>(LHSI); 6193 6194 if (I.isEquality()) { 6195 FCmpInst::Predicate P = I.getPredicate(); 6196 bool IsExact = false; 6197 APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned); 6198 RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact); 6199 6200 // If the floating point constant isn't an integer value, we know if we will 6201 // ever compare equal / not equal to it. 6202 if (!IsExact) { 6203 // TODO: Can never be -0.0 and other non-representable values 6204 APFloat RHSRoundInt(RHS); 6205 RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven); 6206 if (RHS != RHSRoundInt) { 6207 if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ) 6208 return replaceInstUsesWith(I, Builder.getFalse()); 6209 6210 assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE); 6211 return replaceInstUsesWith(I, Builder.getTrue()); 6212 } 6213 } 6214 6215 // TODO: If the constant is exactly representable, is it always OK to do 6216 // equality compares as integer? 6217 } 6218 6219 // Check to see that the input is converted from an integer type that is small 6220 // enough that preserves all bits. TODO: check here for "known" sign bits. 6221 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e. 6222 unsigned InputSize = IntTy->getScalarSizeInBits(); 6223 6224 // Following test does NOT adjust InputSize downwards for signed inputs, 6225 // because the most negative value still requires all the mantissa bits 6226 // to distinguish it from one less than that value. 6227 if ((int)InputSize > MantissaWidth) { 6228 // Conversion would lose accuracy. Check if loss can impact comparison. 6229 int Exp = ilogb(RHS); 6230 if (Exp == APFloat::IEK_Inf) { 6231 int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics())); 6232 if (MaxExponent < (int)InputSize - !LHSUnsigned) 6233 // Conversion could create infinity. 6234 return nullptr; 6235 } else { 6236 // Note that if RHS is zero or NaN, then Exp is negative 6237 // and first condition is trivially false. 6238 if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned) 6239 // Conversion could affect comparison. 6240 return nullptr; 6241 } 6242 } 6243 6244 // Otherwise, we can potentially simplify the comparison. We know that it 6245 // will always come through as an integer value and we know the constant is 6246 // not a NAN (it would have been previously simplified). 6247 assert(!RHS.isNaN() && "NaN comparison not already folded!"); 6248 6249 ICmpInst::Predicate Pred; 6250 switch (I.getPredicate()) { 6251 default: llvm_unreachable("Unexpected predicate!"); 6252 case FCmpInst::FCMP_UEQ: 6253 case FCmpInst::FCMP_OEQ: 6254 Pred = ICmpInst::ICMP_EQ; 6255 break; 6256 case FCmpInst::FCMP_UGT: 6257 case FCmpInst::FCMP_OGT: 6258 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT; 6259 break; 6260 case FCmpInst::FCMP_UGE: 6261 case FCmpInst::FCMP_OGE: 6262 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE; 6263 break; 6264 case FCmpInst::FCMP_ULT: 6265 case FCmpInst::FCMP_OLT: 6266 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT; 6267 break; 6268 case FCmpInst::FCMP_ULE: 6269 case FCmpInst::FCMP_OLE: 6270 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE; 6271 break; 6272 case FCmpInst::FCMP_UNE: 6273 case FCmpInst::FCMP_ONE: 6274 Pred = ICmpInst::ICMP_NE; 6275 break; 6276 case FCmpInst::FCMP_ORD: 6277 return replaceInstUsesWith(I, Builder.getTrue()); 6278 case FCmpInst::FCMP_UNO: 6279 return replaceInstUsesWith(I, Builder.getFalse()); 6280 } 6281 6282 // Now we know that the APFloat is a normal number, zero or inf. 6283 6284 // See if the FP constant is too large for the integer. For example, 6285 // comparing an i8 to 300.0. 6286 unsigned IntWidth = IntTy->getScalarSizeInBits(); 6287 6288 if (!LHSUnsigned) { 6289 // If the RHS value is > SignedMax, fold the comparison. This handles +INF 6290 // and large values. 6291 APFloat SMax(RHS.getSemantics()); 6292 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true, 6293 APFloat::rmNearestTiesToEven); 6294 if (SMax < RHS) { // smax < 13123.0 6295 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT || 6296 Pred == ICmpInst::ICMP_SLE) 6297 return replaceInstUsesWith(I, Builder.getTrue()); 6298 return replaceInstUsesWith(I, Builder.getFalse()); 6299 } 6300 } else { 6301 // If the RHS value is > UnsignedMax, fold the comparison. This handles 6302 // +INF and large values. 6303 APFloat UMax(RHS.getSemantics()); 6304 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false, 6305 APFloat::rmNearestTiesToEven); 6306 if (UMax < RHS) { // umax < 13123.0 6307 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT || 6308 Pred == ICmpInst::ICMP_ULE) 6309 return replaceInstUsesWith(I, Builder.getTrue()); 6310 return replaceInstUsesWith(I, Builder.getFalse()); 6311 } 6312 } 6313 6314 if (!LHSUnsigned) { 6315 // See if the RHS value is < SignedMin. 6316 APFloat SMin(RHS.getSemantics()); 6317 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true, 6318 APFloat::rmNearestTiesToEven); 6319 if (SMin > RHS) { // smin > 12312.0 6320 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT || 6321 Pred == ICmpInst::ICMP_SGE) 6322 return replaceInstUsesWith(I, Builder.getTrue()); 6323 return replaceInstUsesWith(I, Builder.getFalse()); 6324 } 6325 } else { 6326 // See if the RHS value is < UnsignedMin. 6327 APFloat UMin(RHS.getSemantics()); 6328 UMin.convertFromAPInt(APInt::getMinValue(IntWidth), false, 6329 APFloat::rmNearestTiesToEven); 6330 if (UMin > RHS) { // umin > 12312.0 6331 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT || 6332 Pred == ICmpInst::ICMP_UGE) 6333 return replaceInstUsesWith(I, Builder.getTrue()); 6334 return replaceInstUsesWith(I, Builder.getFalse()); 6335 } 6336 } 6337 6338 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or 6339 // [0, UMAX], but it may still be fractional. See if it is fractional by 6340 // casting the FP value to the integer value and back, checking for equality. 6341 // Don't do this for zero, because -0.0 is not fractional. 6342 Constant *RHSInt = LHSUnsigned 6343 ? ConstantExpr::getFPToUI(RHSC, IntTy) 6344 : ConstantExpr::getFPToSI(RHSC, IntTy); 6345 if (!RHS.isZero()) { 6346 bool Equal = LHSUnsigned 6347 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC 6348 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC; 6349 if (!Equal) { 6350 // If we had a comparison against a fractional value, we have to adjust 6351 // the compare predicate and sometimes the value. RHSC is rounded towards 6352 // zero at this point. 6353 switch (Pred) { 6354 default: llvm_unreachable("Unexpected integer comparison!"); 6355 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true 6356 return replaceInstUsesWith(I, Builder.getTrue()); 6357 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false 6358 return replaceInstUsesWith(I, Builder.getFalse()); 6359 case ICmpInst::ICMP_ULE: 6360 // (float)int <= 4.4 --> int <= 4 6361 // (float)int <= -4.4 --> false 6362 if (RHS.isNegative()) 6363 return replaceInstUsesWith(I, Builder.getFalse()); 6364 break; 6365 case ICmpInst::ICMP_SLE: 6366 // (float)int <= 4.4 --> int <= 4 6367 // (float)int <= -4.4 --> int < -4 6368 if (RHS.isNegative()) 6369 Pred = ICmpInst::ICMP_SLT; 6370 break; 6371 case ICmpInst::ICMP_ULT: 6372 // (float)int < -4.4 --> false 6373 // (float)int < 4.4 --> int <= 4 6374 if (RHS.isNegative()) 6375 return replaceInstUsesWith(I, Builder.getFalse()); 6376 Pred = ICmpInst::ICMP_ULE; 6377 break; 6378 case ICmpInst::ICMP_SLT: 6379 // (float)int < -4.4 --> int < -4 6380 // (float)int < 4.4 --> int <= 4 6381 if (!RHS.isNegative()) 6382 Pred = ICmpInst::ICMP_SLE; 6383 break; 6384 case ICmpInst::ICMP_UGT: 6385 // (float)int > 4.4 --> int > 4 6386 // (float)int > -4.4 --> true 6387 if (RHS.isNegative()) 6388 return replaceInstUsesWith(I, Builder.getTrue()); 6389 break; 6390 case ICmpInst::ICMP_SGT: 6391 // (float)int > 4.4 --> int > 4 6392 // (float)int > -4.4 --> int >= -4 6393 if (RHS.isNegative()) 6394 Pred = ICmpInst::ICMP_SGE; 6395 break; 6396 case ICmpInst::ICMP_UGE: 6397 // (float)int >= -4.4 --> true 6398 // (float)int >= 4.4 --> int > 4 6399 if (RHS.isNegative()) 6400 return replaceInstUsesWith(I, Builder.getTrue()); 6401 Pred = ICmpInst::ICMP_UGT; 6402 break; 6403 case ICmpInst::ICMP_SGE: 6404 // (float)int >= -4.4 --> int >= -4 6405 // (float)int >= 4.4 --> int > 4 6406 if (!RHS.isNegative()) 6407 Pred = ICmpInst::ICMP_SGT; 6408 break; 6409 } 6410 } 6411 } 6412 6413 // Lower this FP comparison into an appropriate integer version of the 6414 // comparison. 6415 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt); 6416 } 6417 6418 /// Fold (C / X) < 0.0 --> X < 0.0 if possible. Swap predicate if necessary. 6419 static Instruction *foldFCmpReciprocalAndZero(FCmpInst &I, Instruction *LHSI, 6420 Constant *RHSC) { 6421 // When C is not 0.0 and infinities are not allowed: 6422 // (C / X) < 0.0 is a sign-bit test of X 6423 // (C / X) < 0.0 --> X < 0.0 (if C is positive) 6424 // (C / X) < 0.0 --> X > 0.0 (if C is negative, swap the predicate) 6425 // 6426 // Proof: 6427 // Multiply (C / X) < 0.0 by X * X / C. 6428 // - X is non zero, if it is the flag 'ninf' is violated. 6429 // - C defines the sign of X * X * C. Thus it also defines whether to swap 6430 // the predicate. C is also non zero by definition. 6431 // 6432 // Thus X * X / C is non zero and the transformation is valid. [qed] 6433 6434 FCmpInst::Predicate Pred = I.getPredicate(); 6435 6436 // Check that predicates are valid. 6437 if ((Pred != FCmpInst::FCMP_OGT) && (Pred != FCmpInst::FCMP_OLT) && 6438 (Pred != FCmpInst::FCMP_OGE) && (Pred != FCmpInst::FCMP_OLE)) 6439 return nullptr; 6440 6441 // Check that RHS operand is zero. 6442 if (!match(RHSC, m_AnyZeroFP())) 6443 return nullptr; 6444 6445 // Check fastmath flags ('ninf'). 6446 if (!LHSI->hasNoInfs() || !I.hasNoInfs()) 6447 return nullptr; 6448 6449 // Check the properties of the dividend. It must not be zero to avoid a 6450 // division by zero (see Proof). 6451 const APFloat *C; 6452 if (!match(LHSI->getOperand(0), m_APFloat(C))) 6453 return nullptr; 6454 6455 if (C->isZero()) 6456 return nullptr; 6457 6458 // Get swapped predicate if necessary. 6459 if (C->isNegative()) 6460 Pred = I.getSwappedPredicate(); 6461 6462 return new FCmpInst(Pred, LHSI->getOperand(1), RHSC, "", &I); 6463 } 6464 6465 /// Optimize fabs(X) compared with zero. 6466 static Instruction *foldFabsWithFcmpZero(FCmpInst &I, InstCombinerImpl &IC) { 6467 Value *X; 6468 if (!match(I.getOperand(0), m_FAbs(m_Value(X))) || 6469 !match(I.getOperand(1), m_PosZeroFP())) 6470 return nullptr; 6471 6472 auto replacePredAndOp0 = [&IC](FCmpInst *I, FCmpInst::Predicate P, Value *X) { 6473 I->setPredicate(P); 6474 return IC.replaceOperand(*I, 0, X); 6475 }; 6476 6477 switch (I.getPredicate()) { 6478 case FCmpInst::FCMP_UGE: 6479 case FCmpInst::FCMP_OLT: 6480 // fabs(X) >= 0.0 --> true 6481 // fabs(X) < 0.0 --> false 6482 llvm_unreachable("fcmp should have simplified"); 6483 6484 case FCmpInst::FCMP_OGT: 6485 // fabs(X) > 0.0 --> X != 0.0 6486 return replacePredAndOp0(&I, FCmpInst::FCMP_ONE, X); 6487 6488 case FCmpInst::FCMP_UGT: 6489 // fabs(X) u> 0.0 --> X u!= 0.0 6490 return replacePredAndOp0(&I, FCmpInst::FCMP_UNE, X); 6491 6492 case FCmpInst::FCMP_OLE: 6493 // fabs(X) <= 0.0 --> X == 0.0 6494 return replacePredAndOp0(&I, FCmpInst::FCMP_OEQ, X); 6495 6496 case FCmpInst::FCMP_ULE: 6497 // fabs(X) u<= 0.0 --> X u== 0.0 6498 return replacePredAndOp0(&I, FCmpInst::FCMP_UEQ, X); 6499 6500 case FCmpInst::FCMP_OGE: 6501 // fabs(X) >= 0.0 --> !isnan(X) 6502 assert(!I.hasNoNaNs() && "fcmp should have simplified"); 6503 return replacePredAndOp0(&I, FCmpInst::FCMP_ORD, X); 6504 6505 case FCmpInst::FCMP_ULT: 6506 // fabs(X) u< 0.0 --> isnan(X) 6507 assert(!I.hasNoNaNs() && "fcmp should have simplified"); 6508 return replacePredAndOp0(&I, FCmpInst::FCMP_UNO, X); 6509 6510 case FCmpInst::FCMP_OEQ: 6511 case FCmpInst::FCMP_UEQ: 6512 case FCmpInst::FCMP_ONE: 6513 case FCmpInst::FCMP_UNE: 6514 case FCmpInst::FCMP_ORD: 6515 case FCmpInst::FCMP_UNO: 6516 // Look through the fabs() because it doesn't change anything but the sign. 6517 // fabs(X) == 0.0 --> X == 0.0, 6518 // fabs(X) != 0.0 --> X != 0.0 6519 // isnan(fabs(X)) --> isnan(X) 6520 // !isnan(fabs(X) --> !isnan(X) 6521 return replacePredAndOp0(&I, I.getPredicate(), X); 6522 6523 default: 6524 return nullptr; 6525 } 6526 } 6527 6528 Instruction *InstCombinerImpl::visitFCmpInst(FCmpInst &I) { 6529 bool Changed = false; 6530 6531 /// Orders the operands of the compare so that they are listed from most 6532 /// complex to least complex. This puts constants before unary operators, 6533 /// before binary operators. 6534 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) { 6535 I.swapOperands(); 6536 Changed = true; 6537 } 6538 6539 const CmpInst::Predicate Pred = I.getPredicate(); 6540 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 6541 if (Value *V = SimplifyFCmpInst(Pred, Op0, Op1, I.getFastMathFlags(), 6542 SQ.getWithInstruction(&I))) 6543 return replaceInstUsesWith(I, V); 6544 6545 // Simplify 'fcmp pred X, X' 6546 Type *OpType = Op0->getType(); 6547 assert(OpType == Op1->getType() && "fcmp with different-typed operands?"); 6548 if (Op0 == Op1) { 6549 switch (Pred) { 6550 default: break; 6551 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y) 6552 case FCmpInst::FCMP_ULT: // True if unordered or less than 6553 case FCmpInst::FCMP_UGT: // True if unordered or greater than 6554 case FCmpInst::FCMP_UNE: // True if unordered or not equal 6555 // Canonicalize these to be 'fcmp uno %X, 0.0'. 6556 I.setPredicate(FCmpInst::FCMP_UNO); 6557 I.setOperand(1, Constant::getNullValue(OpType)); 6558 return &I; 6559 6560 case FCmpInst::FCMP_ORD: // True if ordered (no nans) 6561 case FCmpInst::FCMP_OEQ: // True if ordered and equal 6562 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal 6563 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal 6564 // Canonicalize these to be 'fcmp ord %X, 0.0'. 6565 I.setPredicate(FCmpInst::FCMP_ORD); 6566 I.setOperand(1, Constant::getNullValue(OpType)); 6567 return &I; 6568 } 6569 } 6570 6571 // If we're just checking for a NaN (ORD/UNO) and have a non-NaN operand, 6572 // then canonicalize the operand to 0.0. 6573 if (Pred == CmpInst::FCMP_ORD || Pred == CmpInst::FCMP_UNO) { 6574 if (!match(Op0, m_PosZeroFP()) && isKnownNeverNaN(Op0, &TLI)) 6575 return replaceOperand(I, 0, ConstantFP::getNullValue(OpType)); 6576 6577 if (!match(Op1, m_PosZeroFP()) && isKnownNeverNaN(Op1, &TLI)) 6578 return replaceOperand(I, 1, ConstantFP::getNullValue(OpType)); 6579 } 6580 6581 // fcmp pred (fneg X), (fneg Y) -> fcmp swap(pred) X, Y 6582 Value *X, *Y; 6583 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y)))) 6584 return new FCmpInst(I.getSwappedPredicate(), X, Y, "", &I); 6585 6586 // Test if the FCmpInst instruction is used exclusively by a select as 6587 // part of a minimum or maximum operation. If so, refrain from doing 6588 // any other folding. This helps out other analyses which understand 6589 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution 6590 // and CodeGen. And in this case, at least one of the comparison 6591 // operands has at least one user besides the compare (the select), 6592 // which would often largely negate the benefit of folding anyway. 6593 if (I.hasOneUse()) 6594 if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) { 6595 Value *A, *B; 6596 SelectPatternResult SPR = matchSelectPattern(SI, A, B); 6597 if (SPR.Flavor != SPF_UNKNOWN) 6598 return nullptr; 6599 } 6600 6601 // The sign of 0.0 is ignored by fcmp, so canonicalize to +0.0: 6602 // fcmp Pred X, -0.0 --> fcmp Pred X, 0.0 6603 if (match(Op1, m_AnyZeroFP()) && !match(Op1, m_PosZeroFP())) 6604 return replaceOperand(I, 1, ConstantFP::getNullValue(OpType)); 6605 6606 // Handle fcmp with instruction LHS and constant RHS. 6607 Instruction *LHSI; 6608 Constant *RHSC; 6609 if (match(Op0, m_Instruction(LHSI)) && match(Op1, m_Constant(RHSC))) { 6610 switch (LHSI->getOpcode()) { 6611 case Instruction::PHI: 6612 // Only fold fcmp into the PHI if the phi and fcmp are in the same 6613 // block. If in the same block, we're encouraging jump threading. If 6614 // not, we are just pessimizing the code by making an i1 phi. 6615 if (LHSI->getParent() == I.getParent()) 6616 if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI))) 6617 return NV; 6618 break; 6619 case Instruction::SIToFP: 6620 case Instruction::UIToFP: 6621 if (Instruction *NV = foldFCmpIntToFPConst(I, LHSI, RHSC)) 6622 return NV; 6623 break; 6624 case Instruction::FDiv: 6625 if (Instruction *NV = foldFCmpReciprocalAndZero(I, LHSI, RHSC)) 6626 return NV; 6627 break; 6628 case Instruction::Load: 6629 if (auto *GEP = dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) 6630 if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0))) 6631 if (Instruction *Res = foldCmpLoadFromIndexedGlobal( 6632 cast<LoadInst>(LHSI), GEP, GV, I)) 6633 return Res; 6634 break; 6635 } 6636 } 6637 6638 if (Instruction *R = foldFabsWithFcmpZero(I, *this)) 6639 return R; 6640 6641 if (match(Op0, m_FNeg(m_Value(X)))) { 6642 // fcmp pred (fneg X), C --> fcmp swap(pred) X, -C 6643 Constant *C; 6644 if (match(Op1, m_Constant(C))) { 6645 Constant *NegC = ConstantExpr::getFNeg(C); 6646 return new FCmpInst(I.getSwappedPredicate(), X, NegC, "", &I); 6647 } 6648 } 6649 6650 if (match(Op0, m_FPExt(m_Value(X)))) { 6651 // fcmp (fpext X), (fpext Y) -> fcmp X, Y 6652 if (match(Op1, m_FPExt(m_Value(Y))) && X->getType() == Y->getType()) 6653 return new FCmpInst(Pred, X, Y, "", &I); 6654 6655 // fcmp (fpext X), C -> fcmp X, (fptrunc C) if fptrunc is lossless 6656 const APFloat *C; 6657 if (match(Op1, m_APFloat(C))) { 6658 const fltSemantics &FPSem = 6659 X->getType()->getScalarType()->getFltSemantics(); 6660 bool Lossy; 6661 APFloat TruncC = *C; 6662 TruncC.convert(FPSem, APFloat::rmNearestTiesToEven, &Lossy); 6663 6664 // Avoid lossy conversions and denormals. 6665 // Zero is a special case that's OK to convert. 6666 APFloat Fabs = TruncC; 6667 Fabs.clearSign(); 6668 if (!Lossy && 6669 (!(Fabs < APFloat::getSmallestNormalized(FPSem)) || Fabs.isZero())) { 6670 Constant *NewC = ConstantFP::get(X->getType(), TruncC); 6671 return new FCmpInst(Pred, X, NewC, "", &I); 6672 } 6673 } 6674 } 6675 6676 // Convert a sign-bit test of an FP value into a cast and integer compare. 6677 // TODO: Simplify if the copysign constant is 0.0 or NaN. 6678 // TODO: Handle non-zero compare constants. 6679 // TODO: Handle other predicates. 6680 const APFloat *C; 6681 if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::copysign>(m_APFloat(C), 6682 m_Value(X)))) && 6683 match(Op1, m_AnyZeroFP()) && !C->isZero() && !C->isNaN()) { 6684 Type *IntType = Builder.getIntNTy(X->getType()->getScalarSizeInBits()); 6685 if (auto *VecTy = dyn_cast<VectorType>(OpType)) 6686 IntType = VectorType::get(IntType, VecTy->getElementCount()); 6687 6688 // copysign(non-zero constant, X) < 0.0 --> (bitcast X) < 0 6689 if (Pred == FCmpInst::FCMP_OLT) { 6690 Value *IntX = Builder.CreateBitCast(X, IntType); 6691 return new ICmpInst(ICmpInst::ICMP_SLT, IntX, 6692 ConstantInt::getNullValue(IntType)); 6693 } 6694 } 6695 6696 if (I.getType()->isVectorTy()) 6697 if (Instruction *Res = foldVectorCmp(I, Builder)) 6698 return Res; 6699 6700 return Changed ? &I : nullptr; 6701 } 6702