blob: 18e8486e446bbc0cb3a7d350c6b78480d22314f0 [file] [log] [blame]
Chris Lattner2188e402010-01-04 07:37:31 +00001//===- InstCombineCompares.cpp --------------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the visitICmp and visitFCmp functions.
11//
12//===----------------------------------------------------------------------===//
13
Chandler Carrutha9174582015-01-22 05:25:13 +000014#include "InstCombineInternal.h"
Matt Arsenault55e73122015-01-06 15:50:59 +000015#include "llvm/ADT/APSInt.h"
Silviu Barangaf29dfd32016-01-15 15:52:05 +000016#include "llvm/ADT/SetVector.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000017#include "llvm/ADT/Statistic.h"
Eli Friedman911e12f2011-07-20 21:57:23 +000018#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner2188e402010-01-04 07:37:31 +000019#include "llvm/Analysis/InstructionSimplify.h"
20#include "llvm/Analysis/MemoryBuiltins.h"
Mehdi Aminib550cb12016-04-18 09:17:29 +000021#include "llvm/Analysis/TargetLibraryInfo.h"
22#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000023#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/DataLayout.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000025#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000027#include "llvm/IR/PatternMatch.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000028#include "llvm/Support/Debug.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000029
Chris Lattner2188e402010-01-04 07:37:31 +000030using namespace llvm;
31using namespace PatternMatch;
32
Chandler Carruth964daaa2014-04-22 02:55:47 +000033#define DEBUG_TYPE "instcombine"
34
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000035// How many times is a select replaced by one of its operands?
36STATISTIC(NumSel, "Number of select opts");
37
38// Initialization Routines
39
Chris Lattner98457102011-02-10 05:23:05 +000040static ConstantInt *getOne(Constant *C) {
41 return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
42}
43
Chris Lattner2188e402010-01-04 07:37:31 +000044static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
45 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
46}
47
48static bool HasAddOverflow(ConstantInt *Result,
49 ConstantInt *In1, ConstantInt *In2,
50 bool IsSigned) {
Chris Lattnerb1a15122011-07-15 06:08:15 +000051 if (!IsSigned)
Chris Lattner2188e402010-01-04 07:37:31 +000052 return Result->getValue().ult(In1->getValue());
Chris Lattnerb1a15122011-07-15 06:08:15 +000053
54 if (In2->isNegative())
55 return Result->getValue().sgt(In1->getValue());
56 return Result->getValue().slt(In1->getValue());
Chris Lattner2188e402010-01-04 07:37:31 +000057}
58
Sanjay Patel5f0217f2016-06-05 16:46:18 +000059/// Compute Result = In1+In2, returning true if the result overflowed for this
60/// type.
Chris Lattner2188e402010-01-04 07:37:31 +000061static bool AddWithOverflow(Constant *&Result, Constant *In1,
62 Constant *In2, bool IsSigned = false) {
63 Result = ConstantExpr::getAdd(In1, In2);
64
Chris Lattner229907c2011-07-18 04:54:35 +000065 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner2188e402010-01-04 07:37:31 +000066 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
67 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
68 if (HasAddOverflow(ExtractElement(Result, Idx),
69 ExtractElement(In1, Idx),
70 ExtractElement(In2, Idx),
71 IsSigned))
72 return true;
73 }
74 return false;
75 }
76
77 return HasAddOverflow(cast<ConstantInt>(Result),
78 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
79 IsSigned);
80}
81
82static bool HasSubOverflow(ConstantInt *Result,
83 ConstantInt *In1, ConstantInt *In2,
84 bool IsSigned) {
Chris Lattnerb1a15122011-07-15 06:08:15 +000085 if (!IsSigned)
Chris Lattner2188e402010-01-04 07:37:31 +000086 return Result->getValue().ugt(In1->getValue());
Jim Grosbach129c52a2011-09-30 18:09:53 +000087
Chris Lattnerb1a15122011-07-15 06:08:15 +000088 if (In2->isNegative())
89 return Result->getValue().slt(In1->getValue());
90
91 return Result->getValue().sgt(In1->getValue());
Chris Lattner2188e402010-01-04 07:37:31 +000092}
93
Sanjay Patel5f0217f2016-06-05 16:46:18 +000094/// Compute Result = In1-In2, returning true if the result overflowed for this
95/// type.
Chris Lattner2188e402010-01-04 07:37:31 +000096static bool SubWithOverflow(Constant *&Result, Constant *In1,
97 Constant *In2, bool IsSigned = false) {
98 Result = ConstantExpr::getSub(In1, In2);
99
Chris Lattner229907c2011-07-18 04:54:35 +0000100 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner2188e402010-01-04 07:37:31 +0000101 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
102 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
103 if (HasSubOverflow(ExtractElement(Result, Idx),
104 ExtractElement(In1, Idx),
105 ExtractElement(In2, Idx),
106 IsSigned))
107 return true;
108 }
109 return false;
110 }
111
112 return HasSubOverflow(cast<ConstantInt>(Result),
113 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
114 IsSigned);
115}
116
Balaram Makam569eaec2016-05-04 21:32:14 +0000117/// Given an icmp instruction, return true if any use of this comparison is a
118/// branch on sign bit comparison.
119static bool isBranchOnSignBitCheck(ICmpInst &I, bool isSignBit) {
120 for (auto *U : I.users())
121 if (isa<BranchInst>(U))
122 return isSignBit;
123 return false;
124}
125
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000126/// Given an exploded icmp instruction, return true if the comparison only
127/// checks the sign bit. If it only checks the sign bit, set TrueIfSigned if the
128/// result of the comparison is true when the input value is signed.
Sanjay Patel79263662016-08-21 15:07:45 +0000129static bool isSignBitCheck(ICmpInst::Predicate Pred, const APInt &RHS,
Chris Lattner2188e402010-01-04 07:37:31 +0000130 bool &TrueIfSigned) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000131 switch (Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +0000132 case ICmpInst::ICMP_SLT: // True if LHS s< 0
133 TrueIfSigned = true;
Sanjay Patel79263662016-08-21 15:07:45 +0000134 return RHS == 0;
Chris Lattner2188e402010-01-04 07:37:31 +0000135 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
136 TrueIfSigned = true;
Sanjay Patel79263662016-08-21 15:07:45 +0000137 return RHS.isAllOnesValue();
Chris Lattner2188e402010-01-04 07:37:31 +0000138 case ICmpInst::ICMP_SGT: // True if LHS s> -1
139 TrueIfSigned = false;
Sanjay Patel79263662016-08-21 15:07:45 +0000140 return RHS.isAllOnesValue();
Chris Lattner2188e402010-01-04 07:37:31 +0000141 case ICmpInst::ICMP_UGT:
142 // True if LHS u> RHS and RHS == high-bit-mask - 1
143 TrueIfSigned = true;
Sanjay Patel79263662016-08-21 15:07:45 +0000144 return RHS.isMaxSignedValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000145 case ICmpInst::ICMP_UGE:
Chris Lattner2188e402010-01-04 07:37:31 +0000146 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
147 TrueIfSigned = true;
Sanjay Patel79263662016-08-21 15:07:45 +0000148 return RHS.isSignBit();
Chris Lattner2188e402010-01-04 07:37:31 +0000149 default:
150 return false;
151 }
152}
153
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000154/// Returns true if the exploded icmp can be expressed as a signed comparison
155/// to zero and updates the predicate accordingly.
156/// The signedness of the comparison is preserved.
Sanjay Patel5b112842016-08-18 14:59:14 +0000157/// TODO: Refactor with decomposeBitTestICmp()?
158static bool isSignTest(ICmpInst::Predicate &Pred, const APInt &C) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000159 if (!ICmpInst::isSigned(Pred))
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000160 return false;
161
Sanjay Patel5b112842016-08-18 14:59:14 +0000162 if (C == 0)
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000163 return ICmpInst::isRelational(Pred);
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000164
Sanjay Patel5b112842016-08-18 14:59:14 +0000165 if (C == 1) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000166 if (Pred == ICmpInst::ICMP_SLT) {
167 Pred = ICmpInst::ICMP_SLE;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000168 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000169 }
Sanjay Patel5b112842016-08-18 14:59:14 +0000170 } else if (C.isAllOnesValue()) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000171 if (Pred == ICmpInst::ICMP_SGT) {
172 Pred = ICmpInst::ICMP_SGE;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000173 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000174 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000175 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000176
177 return false;
178}
179
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000180/// Given a signed integer type and a set of known zero and one bits, compute
181/// the maximum and minimum values that could have the specified known zero and
182/// known one bits, returning them in Min/Max.
183static void ComputeSignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
184 const APInt &KnownOne,
185 APInt &Min, APInt &Max) {
Chris Lattner2188e402010-01-04 07:37:31 +0000186 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
187 KnownZero.getBitWidth() == Min.getBitWidth() &&
188 KnownZero.getBitWidth() == Max.getBitWidth() &&
189 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
190 APInt UnknownBits = ~(KnownZero|KnownOne);
191
192 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
193 // bit if it is unknown.
194 Min = KnownOne;
195 Max = KnownOne|UnknownBits;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000196
Chris Lattner2188e402010-01-04 07:37:31 +0000197 if (UnknownBits.isNegative()) { // Sign bit is unknown
Jay Foad25a5e4c2010-12-01 08:53:58 +0000198 Min.setBit(Min.getBitWidth()-1);
199 Max.clearBit(Max.getBitWidth()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000200 }
201}
202
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000203/// Given an unsigned integer type and a set of known zero and one bits, compute
204/// the maximum and minimum values that could have the specified known zero and
205/// known one bits, returning them in Min/Max.
Chris Lattner2188e402010-01-04 07:37:31 +0000206static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
207 const APInt &KnownOne,
208 APInt &Min, APInt &Max) {
209 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
210 KnownZero.getBitWidth() == Min.getBitWidth() &&
211 KnownZero.getBitWidth() == Max.getBitWidth() &&
212 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
213 APInt UnknownBits = ~(KnownZero|KnownOne);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000214
Chris Lattner2188e402010-01-04 07:37:31 +0000215 // The minimum value is when the unknown bits are all zeros.
216 Min = KnownOne;
217 // The maximum value is when the unknown bits are all ones.
218 Max = KnownOne|UnknownBits;
219}
220
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000221/// This is called when we see this pattern:
Chris Lattner2188e402010-01-04 07:37:31 +0000222/// cmp pred (load (gep GV, ...)), cmpcst
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000223/// where GV is a global variable with a constant initializer. Try to simplify
224/// this into some simple computation that does not need the load. For example
Chris Lattner2188e402010-01-04 07:37:31 +0000225/// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
226///
227/// If AndCst is non-null, then the loaded value is masked with that constant
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000228/// before doing the comparison. This handles cases like "A[i]&4 == 0".
Sanjay Patel43395062016-07-21 18:07:40 +0000229Instruction *InstCombiner::foldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP,
230 GlobalVariable *GV,
231 CmpInst &ICI,
232 ConstantInt *AndCst) {
Chris Lattnerfe741762012-01-31 02:55:06 +0000233 Constant *Init = GV->getInitializer();
234 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
Craig Topperf40110f2014-04-25 05:29:35 +0000235 return nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000236
Chris Lattnerfe741762012-01-31 02:55:06 +0000237 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
Craig Topperf40110f2014-04-25 05:29:35 +0000238 if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000239
Chris Lattner2188e402010-01-04 07:37:31 +0000240 // There are many forms of this optimization we can handle, for now, just do
241 // the simple index into a single-dimensional array.
242 //
243 // Require: GEP GV, 0, i {{, constant indices}}
244 if (GEP->getNumOperands() < 3 ||
245 !isa<ConstantInt>(GEP->getOperand(1)) ||
246 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
247 isa<Constant>(GEP->getOperand(2)))
Craig Topperf40110f2014-04-25 05:29:35 +0000248 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000249
250 // Check that indices after the variable are constants and in-range for the
251 // type they index. Collect the indices. This is typically for arrays of
252 // structs.
253 SmallVector<unsigned, 4> LaterIndices;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000254
Chris Lattnerfe741762012-01-31 02:55:06 +0000255 Type *EltTy = Init->getType()->getArrayElementType();
Chris Lattner2188e402010-01-04 07:37:31 +0000256 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
257 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000258 if (!Idx) return nullptr; // Variable index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000259
Chris Lattner2188e402010-01-04 07:37:31 +0000260 uint64_t IdxVal = Idx->getZExtValue();
Craig Topperf40110f2014-04-25 05:29:35 +0000261 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000262
Chris Lattner229907c2011-07-18 04:54:35 +0000263 if (StructType *STy = dyn_cast<StructType>(EltTy))
Chris Lattner2188e402010-01-04 07:37:31 +0000264 EltTy = STy->getElementType(IdxVal);
Chris Lattner229907c2011-07-18 04:54:35 +0000265 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
Craig Topperf40110f2014-04-25 05:29:35 +0000266 if (IdxVal >= ATy->getNumElements()) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000267 EltTy = ATy->getElementType();
268 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000269 return nullptr; // Unknown type.
Chris Lattner2188e402010-01-04 07:37:31 +0000270 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000271
Chris Lattner2188e402010-01-04 07:37:31 +0000272 LaterIndices.push_back(IdxVal);
273 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000274
Chris Lattner2188e402010-01-04 07:37:31 +0000275 enum { Overdefined = -3, Undefined = -2 };
276
277 // Variables for our state machines.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000278
Chris Lattner2188e402010-01-04 07:37:31 +0000279 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
280 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
281 // and 87 is the second (and last) index. FirstTrueElement is -2 when
282 // undefined, otherwise set to the first true element. SecondTrueElement is
283 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
284 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
285
286 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
287 // form "i != 47 & i != 87". Same state transitions as for true elements.
288 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000289
Chris Lattner2188e402010-01-04 07:37:31 +0000290 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
291 /// define a state machine that triggers for ranges of values that the index
292 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
293 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
294 /// index in the range (inclusive). We use -2 for undefined here because we
295 /// use relative comparisons and don't want 0-1 to match -1.
296 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000297
Chris Lattner2188e402010-01-04 07:37:31 +0000298 // MagicBitvector - This is a magic bitvector where we set a bit if the
299 // comparison is true for element 'i'. If there are 64 elements or less in
300 // the array, this will fully represent all the comparison results.
301 uint64_t MagicBitvector = 0;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000302
Chris Lattner2188e402010-01-04 07:37:31 +0000303 // Scan the array and see if one of our patterns matches.
304 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
Chris Lattnerfe741762012-01-31 02:55:06 +0000305 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
306 Constant *Elt = Init->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +0000307 if (!Elt) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000308
Chris Lattner2188e402010-01-04 07:37:31 +0000309 // If this is indexing an array of structures, get the structure element.
310 if (!LaterIndices.empty())
Jay Foad57aa6362011-07-13 10:26:04 +0000311 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000312
Chris Lattner2188e402010-01-04 07:37:31 +0000313 // If the element is masked, handle it.
314 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000315
Chris Lattner2188e402010-01-04 07:37:31 +0000316 // Find out if the comparison would be true or false for the i'th element.
317 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
Justin Bogner99798402016-08-05 01:06:44 +0000318 CompareRHS, DL, &TLI);
Chris Lattner2188e402010-01-04 07:37:31 +0000319 // If the result is undef for this element, ignore it.
320 if (isa<UndefValue>(C)) {
321 // Extend range state machines to cover this element in case there is an
322 // undef in the middle of the range.
323 if (TrueRangeEnd == (int)i-1)
324 TrueRangeEnd = i;
325 if (FalseRangeEnd == (int)i-1)
326 FalseRangeEnd = i;
327 continue;
328 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000329
Chris Lattner2188e402010-01-04 07:37:31 +0000330 // If we can't compute the result for any of the elements, we have to give
331 // up evaluating the entire conditional.
Craig Topperf40110f2014-04-25 05:29:35 +0000332 if (!isa<ConstantInt>(C)) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000333
Chris Lattner2188e402010-01-04 07:37:31 +0000334 // Otherwise, we know if the comparison is true or false for this element,
335 // update our state machines.
336 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000337
Chris Lattner2188e402010-01-04 07:37:31 +0000338 // State machine for single/double/range index comparison.
339 if (IsTrueForElt) {
340 // Update the TrueElement state machine.
341 if (FirstTrueElement == Undefined)
342 FirstTrueElement = TrueRangeEnd = i; // First true element.
343 else {
344 // Update double-compare state machine.
345 if (SecondTrueElement == Undefined)
346 SecondTrueElement = i;
347 else
348 SecondTrueElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000349
Chris Lattner2188e402010-01-04 07:37:31 +0000350 // Update range state machine.
351 if (TrueRangeEnd == (int)i-1)
352 TrueRangeEnd = i;
353 else
354 TrueRangeEnd = Overdefined;
355 }
356 } else {
357 // Update the FalseElement state machine.
358 if (FirstFalseElement == Undefined)
359 FirstFalseElement = FalseRangeEnd = i; // First false element.
360 else {
361 // Update double-compare state machine.
362 if (SecondFalseElement == Undefined)
363 SecondFalseElement = i;
364 else
365 SecondFalseElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000366
Chris Lattner2188e402010-01-04 07:37:31 +0000367 // Update range state machine.
368 if (FalseRangeEnd == (int)i-1)
369 FalseRangeEnd = i;
370 else
371 FalseRangeEnd = Overdefined;
372 }
373 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000374
Chris Lattner2188e402010-01-04 07:37:31 +0000375 // If this element is in range, update our magic bitvector.
376 if (i < 64 && IsTrueForElt)
377 MagicBitvector |= 1ULL << i;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000378
Chris Lattner2188e402010-01-04 07:37:31 +0000379 // If all of our states become overdefined, bail out early. Since the
380 // predicate is expensive, only check it every 8 elements. This is only
381 // really useful for really huge arrays.
382 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
383 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
384 FalseRangeEnd == Overdefined)
Craig Topperf40110f2014-04-25 05:29:35 +0000385 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000386 }
387
388 // Now that we've scanned the entire array, emit our new comparison(s). We
389 // order the state machines in complexity of the generated code.
390 Value *Idx = GEP->getOperand(2);
391
Matt Arsenault5aeae182013-08-19 21:40:31 +0000392 // If the index is larger than the pointer size of the target, truncate the
393 // index down like the GEP would do implicitly. We don't have to do this for
394 // an inbounds GEP because the index can't be out of range.
Matt Arsenault84680622013-09-30 21:11:01 +0000395 if (!GEP->isInBounds()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000396 Type *IntPtrTy = DL.getIntPtrType(GEP->getType());
Matt Arsenault84680622013-09-30 21:11:01 +0000397 unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
398 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
399 Idx = Builder->CreateTrunc(Idx, IntPtrTy);
400 }
Matt Arsenault5aeae182013-08-19 21:40:31 +0000401
Chris Lattner2188e402010-01-04 07:37:31 +0000402 // If the comparison is only true for one or two elements, emit direct
403 // comparisons.
404 if (SecondTrueElement != Overdefined) {
405 // None true -> false.
406 if (FirstTrueElement == Undefined)
Sanjay Patel4b198802016-02-01 22:23:39 +0000407 return replaceInstUsesWith(ICI, Builder->getFalse());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000408
Chris Lattner2188e402010-01-04 07:37:31 +0000409 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000410
Chris Lattner2188e402010-01-04 07:37:31 +0000411 // True for one element -> 'i == 47'.
412 if (SecondTrueElement == Undefined)
413 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000414
Chris Lattner2188e402010-01-04 07:37:31 +0000415 // True for two elements -> 'i == 47 | i == 72'.
416 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
417 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
418 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
419 return BinaryOperator::CreateOr(C1, C2);
420 }
421
422 // If the comparison is only false for one or two elements, emit direct
423 // comparisons.
424 if (SecondFalseElement != Overdefined) {
425 // None false -> true.
426 if (FirstFalseElement == Undefined)
Sanjay Patel4b198802016-02-01 22:23:39 +0000427 return replaceInstUsesWith(ICI, Builder->getTrue());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000428
Chris Lattner2188e402010-01-04 07:37:31 +0000429 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
430
431 // False for one element -> 'i != 47'.
432 if (SecondFalseElement == Undefined)
433 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000434
Chris Lattner2188e402010-01-04 07:37:31 +0000435 // False for two elements -> 'i != 47 & i != 72'.
436 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
437 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
438 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
439 return BinaryOperator::CreateAnd(C1, C2);
440 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000441
Chris Lattner2188e402010-01-04 07:37:31 +0000442 // If the comparison can be replaced with a range comparison for the elements
443 // where it is true, emit the range check.
444 if (TrueRangeEnd != Overdefined) {
445 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
Jim Grosbach129c52a2011-09-30 18:09:53 +0000446
Chris Lattner2188e402010-01-04 07:37:31 +0000447 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
448 if (FirstTrueElement) {
449 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
450 Idx = Builder->CreateAdd(Idx, Offs);
451 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000452
Chris Lattner2188e402010-01-04 07:37:31 +0000453 Value *End = ConstantInt::get(Idx->getType(),
454 TrueRangeEnd-FirstTrueElement+1);
455 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
456 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000457
Chris Lattner2188e402010-01-04 07:37:31 +0000458 // False range check.
459 if (FalseRangeEnd != Overdefined) {
460 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
461 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
462 if (FirstFalseElement) {
463 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
464 Idx = Builder->CreateAdd(Idx, Offs);
465 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000466
Chris Lattner2188e402010-01-04 07:37:31 +0000467 Value *End = ConstantInt::get(Idx->getType(),
468 FalseRangeEnd-FirstFalseElement);
469 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
470 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000471
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000472 // If a magic bitvector captures the entire comparison state
Chris Lattner2188e402010-01-04 07:37:31 +0000473 // of this load, replace it with computation that does:
474 // ((magic_cst >> i) & 1) != 0
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000475 {
Craig Topperf40110f2014-04-25 05:29:35 +0000476 Type *Ty = nullptr;
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000477
478 // Look for an appropriate type:
479 // - The type of Idx if the magic fits
480 // - The smallest fitting legal type if we have a DataLayout
481 // - Default to i32
482 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
483 Ty = Idx->getType();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000484 else
485 Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000486
Craig Topperf40110f2014-04-25 05:29:35 +0000487 if (Ty) {
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000488 Value *V = Builder->CreateIntCast(Idx, Ty, false);
489 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
490 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
491 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
492 }
Chris Lattner2188e402010-01-04 07:37:31 +0000493 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000494
Craig Topperf40110f2014-04-25 05:29:35 +0000495 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000496}
497
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000498/// Return a value that can be used to compare the *offset* implied by a GEP to
499/// zero. For example, if we have &A[i], we want to return 'i' for
500/// "icmp ne i, 0". Note that, in general, indices can be complex, and scales
501/// are involved. The above expression would also be legal to codegen as
502/// "icmp ne (i*4), 0" (assuming A is a pointer to i32).
503/// This latter form is less amenable to optimization though, and we are allowed
Chris Lattner2188e402010-01-04 07:37:31 +0000504/// to generate the first by knowing that pointer arithmetic doesn't overflow.
505///
506/// If we can't emit an optimized form for this expression, this returns null.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000507///
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000508static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC,
509 const DataLayout &DL) {
Chris Lattner2188e402010-01-04 07:37:31 +0000510 gep_type_iterator GTI = gep_type_begin(GEP);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000511
Chris Lattner2188e402010-01-04 07:37:31 +0000512 // Check to see if this gep only has a single variable index. If so, and if
513 // any constant indices are a multiple of its scale, then we can compute this
514 // in terms of the scale of the variable index. For example, if the GEP
515 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
516 // because the expression will cross zero at the same point.
517 unsigned i, e = GEP->getNumOperands();
518 int64_t Offset = 0;
519 for (i = 1; i != e; ++i, ++GTI) {
520 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
521 // Compute the aggregate offset of constant indices.
522 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000523
Chris Lattner2188e402010-01-04 07:37:31 +0000524 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000525 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000526 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000527 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000528 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000529 Offset += Size*CI->getSExtValue();
530 }
531 } else {
532 // Found our variable index.
533 break;
534 }
535 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000536
Chris Lattner2188e402010-01-04 07:37:31 +0000537 // If there are no variable indices, we must have a constant offset, just
538 // evaluate it the general way.
Craig Topperf40110f2014-04-25 05:29:35 +0000539 if (i == e) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000540
Chris Lattner2188e402010-01-04 07:37:31 +0000541 Value *VariableIdx = GEP->getOperand(i);
542 // Determine the scale factor of the variable element. For example, this is
543 // 4 if the variable index is into an array of i32.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000544 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000545
Chris Lattner2188e402010-01-04 07:37:31 +0000546 // Verify that there are no other variable indices. If so, emit the hard way.
547 for (++i, ++GTI; i != e; ++i, ++GTI) {
548 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000549 if (!CI) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000550
Chris Lattner2188e402010-01-04 07:37:31 +0000551 // Compute the aggregate offset of constant indices.
552 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000553
Chris Lattner2188e402010-01-04 07:37:31 +0000554 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000555 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000556 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000557 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000558 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000559 Offset += Size*CI->getSExtValue();
560 }
561 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000562
Chris Lattner2188e402010-01-04 07:37:31 +0000563 // Okay, we know we have a single variable index, which must be a
564 // pointer/array/vector index. If there is no offset, life is simple, return
565 // the index.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000566 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
Matt Arsenault745101d2013-08-21 19:53:10 +0000567 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
Chris Lattner2188e402010-01-04 07:37:31 +0000568 if (Offset == 0) {
569 // Cast to intptrty in case a truncation occurs. If an extension is needed,
570 // we don't need to bother extending: the extension won't affect where the
571 // computation crosses zero.
Eli Friedman1754a252011-05-18 23:11:30 +0000572 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
Eli Friedman1754a252011-05-18 23:11:30 +0000573 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
574 }
Chris Lattner2188e402010-01-04 07:37:31 +0000575 return VariableIdx;
576 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000577
Chris Lattner2188e402010-01-04 07:37:31 +0000578 // Otherwise, there is an index. The computation we will do will be modulo
579 // the pointer size, so get it.
580 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000581
Chris Lattner2188e402010-01-04 07:37:31 +0000582 Offset &= PtrSizeMask;
583 VariableScale &= PtrSizeMask;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000584
Chris Lattner2188e402010-01-04 07:37:31 +0000585 // To do this transformation, any constant index must be a multiple of the
586 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
587 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
588 // multiple of the variable scale.
589 int64_t NewOffs = Offset / (int64_t)VariableScale;
590 if (Offset != NewOffs*(int64_t)VariableScale)
Craig Topperf40110f2014-04-25 05:29:35 +0000591 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000592
Chris Lattner2188e402010-01-04 07:37:31 +0000593 // Okay, we can do this evaluation. Start by converting the index to intptr.
Chris Lattner2188e402010-01-04 07:37:31 +0000594 if (VariableIdx->getType() != IntPtrTy)
Eli Friedman1754a252011-05-18 23:11:30 +0000595 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
596 true /*Signed*/);
Chris Lattner2188e402010-01-04 07:37:31 +0000597 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
Eli Friedman1754a252011-05-18 23:11:30 +0000598 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
Chris Lattner2188e402010-01-04 07:37:31 +0000599}
600
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000601/// Returns true if we can rewrite Start as a GEP with pointer Base
602/// and some integer offset. The nodes that need to be re-written
603/// for this transformation will be added to Explored.
604static bool canRewriteGEPAsOffset(Value *Start, Value *Base,
605 const DataLayout &DL,
606 SetVector<Value *> &Explored) {
607 SmallVector<Value *, 16> WorkList(1, Start);
608 Explored.insert(Base);
609
610 // The following traversal gives us an order which can be used
611 // when doing the final transformation. Since in the final
612 // transformation we create the PHI replacement instructions first,
613 // we don't have to get them in any particular order.
614 //
615 // However, for other instructions we will have to traverse the
616 // operands of an instruction first, which means that we have to
617 // do a post-order traversal.
618 while (!WorkList.empty()) {
619 SetVector<PHINode *> PHIs;
620
621 while (!WorkList.empty()) {
622 if (Explored.size() >= 100)
623 return false;
624
625 Value *V = WorkList.back();
626
627 if (Explored.count(V) != 0) {
628 WorkList.pop_back();
629 continue;
630 }
631
632 if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) &&
633 !isa<GEPOperator>(V) && !isa<PHINode>(V))
634 // We've found some value that we can't explore which is different from
635 // the base. Therefore we can't do this transformation.
636 return false;
637
638 if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) {
639 auto *CI = dyn_cast<CastInst>(V);
640 if (!CI->isNoopCast(DL))
641 return false;
642
643 if (Explored.count(CI->getOperand(0)) == 0)
644 WorkList.push_back(CI->getOperand(0));
645 }
646
647 if (auto *GEP = dyn_cast<GEPOperator>(V)) {
648 // We're limiting the GEP to having one index. This will preserve
649 // the original pointer type. We could handle more cases in the
650 // future.
651 if (GEP->getNumIndices() != 1 || !GEP->isInBounds() ||
652 GEP->getType() != Start->getType())
653 return false;
654
655 if (Explored.count(GEP->getOperand(0)) == 0)
656 WorkList.push_back(GEP->getOperand(0));
657 }
658
659 if (WorkList.back() == V) {
660 WorkList.pop_back();
661 // We've finished visiting this node, mark it as such.
662 Explored.insert(V);
663 }
664
665 if (auto *PN = dyn_cast<PHINode>(V)) {
David Majnemercdf28732016-03-19 04:39:52 +0000666 // We cannot transform PHIs on unsplittable basic blocks.
667 if (isa<CatchSwitchInst>(PN->getParent()->getTerminator()))
668 return false;
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000669 Explored.insert(PN);
670 PHIs.insert(PN);
671 }
672 }
673
674 // Explore the PHI nodes further.
675 for (auto *PN : PHIs)
676 for (Value *Op : PN->incoming_values())
677 if (Explored.count(Op) == 0)
678 WorkList.push_back(Op);
679 }
680
681 // Make sure that we can do this. Since we can't insert GEPs in a basic
682 // block before a PHI node, we can't easily do this transformation if
683 // we have PHI node users of transformed instructions.
684 for (Value *Val : Explored) {
685 for (Value *Use : Val->uses()) {
686
687 auto *PHI = dyn_cast<PHINode>(Use);
688 auto *Inst = dyn_cast<Instruction>(Val);
689
690 if (Inst == Base || Inst == PHI || !Inst || !PHI ||
691 Explored.count(PHI) == 0)
692 continue;
693
694 if (PHI->getParent() == Inst->getParent())
695 return false;
696 }
697 }
698 return true;
699}
700
701// Sets the appropriate insert point on Builder where we can add
702// a replacement Instruction for V (if that is possible).
703static void setInsertionPoint(IRBuilder<> &Builder, Value *V,
704 bool Before = true) {
705 if (auto *PHI = dyn_cast<PHINode>(V)) {
706 Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt());
707 return;
708 }
709 if (auto *I = dyn_cast<Instruction>(V)) {
710 if (!Before)
711 I = &*std::next(I->getIterator());
712 Builder.SetInsertPoint(I);
713 return;
714 }
715 if (auto *A = dyn_cast<Argument>(V)) {
716 // Set the insertion point in the entry block.
717 BasicBlock &Entry = A->getParent()->getEntryBlock();
718 Builder.SetInsertPoint(&*Entry.getFirstInsertionPt());
719 return;
720 }
721 // Otherwise, this is a constant and we don't need to set a new
722 // insertion point.
723 assert(isa<Constant>(V) && "Setting insertion point for unknown value!");
724}
725
726/// Returns a re-written value of Start as an indexed GEP using Base as a
727/// pointer.
728static Value *rewriteGEPAsOffset(Value *Start, Value *Base,
729 const DataLayout &DL,
730 SetVector<Value *> &Explored) {
731 // Perform all the substitutions. This is a bit tricky because we can
732 // have cycles in our use-def chains.
733 // 1. Create the PHI nodes without any incoming values.
734 // 2. Create all the other values.
735 // 3. Add the edges for the PHI nodes.
736 // 4. Emit GEPs to get the original pointers.
737 // 5. Remove the original instructions.
738 Type *IndexType = IntegerType::get(
739 Base->getContext(), DL.getPointerTypeSizeInBits(Start->getType()));
740
741 DenseMap<Value *, Value *> NewInsts;
742 NewInsts[Base] = ConstantInt::getNullValue(IndexType);
743
744 // Create the new PHI nodes, without adding any incoming values.
745 for (Value *Val : Explored) {
746 if (Val == Base)
747 continue;
748 // Create empty phi nodes. This avoids cyclic dependencies when creating
749 // the remaining instructions.
750 if (auto *PHI = dyn_cast<PHINode>(Val))
751 NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(),
752 PHI->getName() + ".idx", PHI);
753 }
754 IRBuilder<> Builder(Base->getContext());
755
756 // Create all the other instructions.
757 for (Value *Val : Explored) {
758
759 if (NewInsts.find(Val) != NewInsts.end())
760 continue;
761
762 if (auto *CI = dyn_cast<CastInst>(Val)) {
763 NewInsts[CI] = NewInsts[CI->getOperand(0)];
764 continue;
765 }
766 if (auto *GEP = dyn_cast<GEPOperator>(Val)) {
767 Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)]
768 : GEP->getOperand(1);
769 setInsertionPoint(Builder, GEP);
770 // Indices might need to be sign extended. GEPs will magically do
771 // this, but we need to do it ourselves here.
772 if (Index->getType()->getScalarSizeInBits() !=
773 NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) {
774 Index = Builder.CreateSExtOrTrunc(
775 Index, NewInsts[GEP->getOperand(0)]->getType(),
776 GEP->getOperand(0)->getName() + ".sext");
777 }
778
779 auto *Op = NewInsts[GEP->getOperand(0)];
780 if (isa<ConstantInt>(Op) && dyn_cast<ConstantInt>(Op)->isZero())
781 NewInsts[GEP] = Index;
782 else
783 NewInsts[GEP] = Builder.CreateNSWAdd(
784 Op, Index, GEP->getOperand(0)->getName() + ".add");
785 continue;
786 }
787 if (isa<PHINode>(Val))
788 continue;
789
790 llvm_unreachable("Unexpected instruction type");
791 }
792
793 // Add the incoming values to the PHI nodes.
794 for (Value *Val : Explored) {
795 if (Val == Base)
796 continue;
797 // All the instructions have been created, we can now add edges to the
798 // phi nodes.
799 if (auto *PHI = dyn_cast<PHINode>(Val)) {
800 PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]);
801 for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) {
802 Value *NewIncoming = PHI->getIncomingValue(I);
803
804 if (NewInsts.find(NewIncoming) != NewInsts.end())
805 NewIncoming = NewInsts[NewIncoming];
806
807 NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I));
808 }
809 }
810 }
811
812 for (Value *Val : Explored) {
813 if (Val == Base)
814 continue;
815
816 // Depending on the type, for external users we have to emit
817 // a GEP or a GEP + ptrtoint.
818 setInsertionPoint(Builder, Val, false);
819
820 // If required, create an inttoptr instruction for Base.
821 Value *NewBase = Base;
822 if (!Base->getType()->isPointerTy())
823 NewBase = Builder.CreateBitOrPointerCast(Base, Start->getType(),
824 Start->getName() + "to.ptr");
825
826 Value *GEP = Builder.CreateInBoundsGEP(
827 Start->getType()->getPointerElementType(), NewBase,
828 makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr");
829
830 if (!Val->getType()->isPointerTy()) {
831 Value *Cast = Builder.CreatePointerCast(GEP, Val->getType(),
832 Val->getName() + ".conv");
833 GEP = Cast;
834 }
835 Val->replaceAllUsesWith(GEP);
836 }
837
838 return NewInsts[Start];
839}
840
841/// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express
842/// the input Value as a constant indexed GEP. Returns a pair containing
843/// the GEPs Pointer and Index.
844static std::pair<Value *, Value *>
845getAsConstantIndexedAddress(Value *V, const DataLayout &DL) {
846 Type *IndexType = IntegerType::get(V->getContext(),
847 DL.getPointerTypeSizeInBits(V->getType()));
848
849 Constant *Index = ConstantInt::getNullValue(IndexType);
850 while (true) {
851 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
852 // We accept only inbouds GEPs here to exclude the possibility of
853 // overflow.
854 if (!GEP->isInBounds())
855 break;
856 if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 &&
857 GEP->getType() == V->getType()) {
858 V = GEP->getOperand(0);
859 Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1));
860 Index = ConstantExpr::getAdd(
861 Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType));
862 continue;
863 }
864 break;
865 }
866 if (auto *CI = dyn_cast<IntToPtrInst>(V)) {
867 if (!CI->isNoopCast(DL))
868 break;
869 V = CI->getOperand(0);
870 continue;
871 }
872 if (auto *CI = dyn_cast<PtrToIntInst>(V)) {
873 if (!CI->isNoopCast(DL))
874 break;
875 V = CI->getOperand(0);
876 continue;
877 }
878 break;
879 }
880 return {V, Index};
881}
882
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000883/// Converts (CMP GEPLHS, RHS) if this change would make RHS a constant.
884/// We can look through PHIs, GEPs and casts in order to determine a common base
885/// between GEPLHS and RHS.
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000886static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS,
887 ICmpInst::Predicate Cond,
888 const DataLayout &DL) {
889 if (!GEPLHS->hasAllConstantIndices())
890 return nullptr;
891
892 Value *PtrBase, *Index;
893 std::tie(PtrBase, Index) = getAsConstantIndexedAddress(GEPLHS, DL);
894
895 // The set of nodes that will take part in this transformation.
896 SetVector<Value *> Nodes;
897
898 if (!canRewriteGEPAsOffset(RHS, PtrBase, DL, Nodes))
899 return nullptr;
900
901 // We know we can re-write this as
902 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)
903 // Since we've only looked through inbouds GEPs we know that we
904 // can't have overflow on either side. We can therefore re-write
905 // this as:
906 // OFFSET1 cmp OFFSET2
907 Value *NewRHS = rewriteGEPAsOffset(RHS, PtrBase, DL, Nodes);
908
909 // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written
910 // GEP having PtrBase as the pointer base, and has returned in NewRHS the
911 // offset. Since Index is the offset of LHS to the base pointer, we will now
912 // compare the offsets instead of comparing the pointers.
913 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS);
914}
915
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000916/// Fold comparisons between a GEP instruction and something else. At this point
917/// we know that the GEP is on the LHS of the comparison.
Sanjay Patel43395062016-07-21 18:07:40 +0000918Instruction *InstCombiner::foldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
Chris Lattner2188e402010-01-04 07:37:31 +0000919 ICmpInst::Predicate Cond,
920 Instruction &I) {
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000921 // Don't transform signed compares of GEPs into index compares. Even if the
922 // GEP is inbounds, the final add of the base pointer can have signed overflow
923 // and would change the result of the icmp.
924 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
Benjamin Kramerc7a22fe2012-02-21 13:40:06 +0000925 // the maximum signed value for the pointer type.
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000926 if (ICmpInst::isSigned(Cond))
Craig Topperf40110f2014-04-25 05:29:35 +0000927 return nullptr;
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000928
Matt Arsenault44f60d02014-06-09 19:20:29 +0000929 // Look through bitcasts and addrspacecasts. We do not however want to remove
930 // 0 GEPs.
931 if (!isa<GetElementPtrInst>(RHS))
932 RHS = RHS->stripPointerCasts();
Chris Lattner2188e402010-01-04 07:37:31 +0000933
934 Value *PtrBase = GEPLHS->getOperand(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000935 if (PtrBase == RHS && GEPLHS->isInBounds()) {
Chris Lattner2188e402010-01-04 07:37:31 +0000936 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
937 // This transformation (ignoring the base and scales) is valid because we
938 // know pointers can't overflow since the gep is inbounds. See if we can
939 // output an optimized form.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000940 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this, DL);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000941
Chris Lattner2188e402010-01-04 07:37:31 +0000942 // If not, synthesize the offset the hard way.
Craig Topperf40110f2014-04-25 05:29:35 +0000943 if (!Offset)
Chris Lattner2188e402010-01-04 07:37:31 +0000944 Offset = EmitGEPOffset(GEPLHS);
945 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
946 Constant::getNullValue(Offset->getType()));
947 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
948 // If the base pointers are different, but the indices are the same, just
949 // compare the base pointer.
950 if (PtrBase != GEPRHS->getOperand(0)) {
951 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
952 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
953 GEPRHS->getOperand(0)->getType();
954 if (IndicesTheSame)
955 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
956 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
957 IndicesTheSame = false;
958 break;
959 }
960
961 // If all indices are the same, just compare the base pointers.
962 if (IndicesTheSame)
David Majnemer5953d372013-06-29 10:28:04 +0000963 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +0000964
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000965 // If we're comparing GEPs with two base pointers that only differ in type
966 // and both GEPs have only constant indices or just one use, then fold
967 // the compare with the adjusted indices.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000968 if (GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000969 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
970 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
971 PtrBase->stripPointerCasts() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000972 GEPRHS->getOperand(0)->stripPointerCasts()) {
Matt Arsenault44f60d02014-06-09 19:20:29 +0000973 Value *LOffset = EmitGEPOffset(GEPLHS);
974 Value *ROffset = EmitGEPOffset(GEPRHS);
975
976 // If we looked through an addrspacecast between different sized address
977 // spaces, the LHS and RHS pointers are different sized
978 // integers. Truncate to the smaller one.
979 Type *LHSIndexTy = LOffset->getType();
980 Type *RHSIndexTy = ROffset->getType();
981 if (LHSIndexTy != RHSIndexTy) {
982 if (LHSIndexTy->getPrimitiveSizeInBits() <
983 RHSIndexTy->getPrimitiveSizeInBits()) {
984 ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy);
985 } else
986 LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy);
987 }
988
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000989 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
Matt Arsenault44f60d02014-06-09 19:20:29 +0000990 LOffset, ROffset);
Sanjay Patel4b198802016-02-01 22:23:39 +0000991 return replaceInstUsesWith(I, Cmp);
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000992 }
993
Chris Lattner2188e402010-01-04 07:37:31 +0000994 // Otherwise, the base pointers are different and the indices are
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000995 // different. Try convert this to an indexed compare by looking through
996 // PHIs/casts.
997 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
Chris Lattner2188e402010-01-04 07:37:31 +0000998 }
999
1000 // If one of the GEPs has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +00001001 if (GEPLHS->hasAllZeroIndices())
Sanjay Patel43395062016-07-21 18:07:40 +00001002 return foldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
David Majnemer92a8a7d2013-06-29 09:45:35 +00001003 ICmpInst::getSwappedPredicate(Cond), I);
Chris Lattner2188e402010-01-04 07:37:31 +00001004
1005 // If the other GEP has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +00001006 if (GEPRHS->hasAllZeroIndices())
Sanjay Patel43395062016-07-21 18:07:40 +00001007 return foldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
Chris Lattner2188e402010-01-04 07:37:31 +00001008
Stuart Hastings66a82b92011-05-14 05:55:10 +00001009 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
Chris Lattner2188e402010-01-04 07:37:31 +00001010 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
1011 // If the GEPs only differ by one index, compare it.
1012 unsigned NumDifferences = 0; // Keep track of # differences.
1013 unsigned DiffOperand = 0; // The operand that differs.
1014 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
1015 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
1016 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
1017 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
1018 // Irreconcilable differences.
1019 NumDifferences = 2;
1020 break;
1021 } else {
1022 if (NumDifferences++) break;
1023 DiffOperand = i;
1024 }
1025 }
1026
Rafael Espindolaa7bbc0b2013-06-06 17:03:05 +00001027 if (NumDifferences == 0) // SAME GEP?
Sanjay Patel4b198802016-02-01 22:23:39 +00001028 return replaceInstUsesWith(I, // No comparison is needed here.
Jakub Staszakbddea112013-06-06 20:18:46 +00001029 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
Chris Lattner2188e402010-01-04 07:37:31 +00001030
Stuart Hastings66a82b92011-05-14 05:55:10 +00001031 else if (NumDifferences == 1 && GEPsInBounds) {
Chris Lattner2188e402010-01-04 07:37:31 +00001032 Value *LHSV = GEPLHS->getOperand(DiffOperand);
1033 Value *RHSV = GEPRHS->getOperand(DiffOperand);
1034 // Make sure we do a signed comparison here.
1035 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
1036 }
1037 }
1038
1039 // Only lower this if the icmp is the only user of the GEP or if we expect
1040 // the result to fold to a constant!
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001041 if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
Chris Lattner2188e402010-01-04 07:37:31 +00001042 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
1043 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
1044 Value *L = EmitGEPOffset(GEPLHS);
1045 Value *R = EmitGEPOffset(GEPRHS);
1046 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
1047 }
1048 }
Silviu Barangaf29dfd32016-01-15 15:52:05 +00001049
1050 // Try convert this to an indexed compare by looking through PHIs/casts as a
1051 // last resort.
1052 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
Chris Lattner2188e402010-01-04 07:37:31 +00001053}
1054
Pete Cooper980a9352016-08-12 17:13:28 +00001055Instruction *InstCombiner::foldAllocaCmp(ICmpInst &ICI,
1056 const AllocaInst *Alloca,
1057 const Value *Other) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001058 assert(ICI.isEquality() && "Cannot fold non-equality comparison.");
1059
1060 // It would be tempting to fold away comparisons between allocas and any
1061 // pointer not based on that alloca (e.g. an argument). However, even
1062 // though such pointers cannot alias, they can still compare equal.
1063 //
1064 // But LLVM doesn't specify where allocas get their memory, so if the alloca
1065 // doesn't escape we can argue that it's impossible to guess its value, and we
1066 // can therefore act as if any such guesses are wrong.
1067 //
1068 // The code below checks that the alloca doesn't escape, and that it's only
1069 // used in a comparison once (the current instruction). The
1070 // single-comparison-use condition ensures that we're trivially folding all
1071 // comparisons against the alloca consistently, and avoids the risk of
1072 // erroneously folding a comparison of the pointer with itself.
1073
1074 unsigned MaxIter = 32; // Break cycles and bound to constant-time.
1075
Pete Cooper980a9352016-08-12 17:13:28 +00001076 SmallVector<const Use *, 32> Worklist;
1077 for (const Use &U : Alloca->uses()) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001078 if (Worklist.size() >= MaxIter)
1079 return nullptr;
1080 Worklist.push_back(&U);
1081 }
1082
1083 unsigned NumCmps = 0;
1084 while (!Worklist.empty()) {
1085 assert(Worklist.size() <= MaxIter);
Pete Cooper980a9352016-08-12 17:13:28 +00001086 const Use *U = Worklist.pop_back_val();
1087 const Value *V = U->getUser();
Hans Wennborgf1f36512015-10-07 00:20:07 +00001088 --MaxIter;
1089
1090 if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) ||
1091 isa<SelectInst>(V)) {
1092 // Track the uses.
1093 } else if (isa<LoadInst>(V)) {
1094 // Loading from the pointer doesn't escape it.
1095 continue;
Pete Cooper980a9352016-08-12 17:13:28 +00001096 } else if (const auto *SI = dyn_cast<StoreInst>(V)) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001097 // Storing *to* the pointer is fine, but storing the pointer escapes it.
1098 if (SI->getValueOperand() == U->get())
1099 return nullptr;
1100 continue;
1101 } else if (isa<ICmpInst>(V)) {
1102 if (NumCmps++)
1103 return nullptr; // Found more than one cmp.
1104 continue;
Pete Cooper980a9352016-08-12 17:13:28 +00001105 } else if (const auto *Intrin = dyn_cast<IntrinsicInst>(V)) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001106 switch (Intrin->getIntrinsicID()) {
1107 // These intrinsics don't escape or compare the pointer. Memset is safe
1108 // because we don't allow ptrtoint. Memcpy and memmove are safe because
1109 // we don't allow stores, so src cannot point to V.
1110 case Intrinsic::lifetime_start: case Intrinsic::lifetime_end:
1111 case Intrinsic::dbg_declare: case Intrinsic::dbg_value:
1112 case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset:
1113 continue;
1114 default:
1115 return nullptr;
1116 }
1117 } else {
1118 return nullptr;
1119 }
Pete Cooper980a9352016-08-12 17:13:28 +00001120 for (const Use &U : V->uses()) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001121 if (Worklist.size() >= MaxIter)
1122 return nullptr;
1123 Worklist.push_back(&U);
1124 }
1125 }
1126
1127 Type *CmpTy = CmpInst::makeCmpResultType(Other->getType());
Sanjay Patel4b198802016-02-01 22:23:39 +00001128 return replaceInstUsesWith(
Hans Wennborgf1f36512015-10-07 00:20:07 +00001129 ICI,
1130 ConstantInt::get(CmpTy, !CmpInst::isTrueWhenEqual(ICI.getPredicate())));
1131}
1132
Sanjay Patel5f0217f2016-06-05 16:46:18 +00001133/// Fold "icmp pred (X+CI), X".
Sanjay Patel43395062016-07-21 18:07:40 +00001134Instruction *InstCombiner::foldICmpAddOpConst(Instruction &ICI,
1135 Value *X, ConstantInt *CI,
1136 ICmpInst::Predicate Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +00001137 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001138 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner2188e402010-01-04 07:37:31 +00001139 // operators.
Jim Grosbach129c52a2011-09-30 18:09:53 +00001140
Chris Lattner8c92b572010-01-08 17:48:19 +00001141 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner2188e402010-01-04 07:37:31 +00001142 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
1143 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
1144 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00001145 Value *R =
Chris Lattner8c92b572010-01-08 17:48:19 +00001146 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
Chris Lattner2188e402010-01-04 07:37:31 +00001147 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
1148 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001149
Chris Lattner2188e402010-01-04 07:37:31 +00001150 // (X+1) >u X --> X <u (0-1) --> X != 255
1151 // (X+2) >u X --> X <u (0-2) --> X <u 254
1152 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandse5220012011-02-17 07:46:37 +00001153 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Chris Lattner2188e402010-01-04 07:37:31 +00001154 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001155
Chris Lattner2188e402010-01-04 07:37:31 +00001156 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
1157 ConstantInt *SMax = ConstantInt::get(X->getContext(),
1158 APInt::getSignedMaxValue(BitWidth));
1159
1160 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
1161 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
1162 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
1163 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
1164 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
1165 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandse5220012011-02-17 07:46:37 +00001166 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Chris Lattner2188e402010-01-04 07:37:31 +00001167 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001168
Chris Lattner2188e402010-01-04 07:37:31 +00001169 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
1170 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
1171 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
1172 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
1173 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
1174 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach129c52a2011-09-30 18:09:53 +00001175
Chris Lattner2188e402010-01-04 07:37:31 +00001176 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Jakub Staszakbddea112013-06-06 20:18:46 +00001177 Constant *C = Builder->getInt(CI->getValue()-1);
Chris Lattner2188e402010-01-04 07:37:31 +00001178 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
1179}
1180
Sanjay Patel5f0217f2016-06-05 16:46:18 +00001181/// Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001182/// (icmp eq/ne A, Log2(const2/const1)) ->
1183/// (icmp eq/ne A, Log2(const2) - Log2(const1)).
Sanjay Patel43395062016-07-21 18:07:40 +00001184Instruction *InstCombiner::foldICmpCstShrConst(ICmpInst &I, Value *Op, Value *A,
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001185 ConstantInt *CI1,
1186 ConstantInt *CI2) {
1187 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1188
1189 auto getConstant = [&I, this](bool IsTrue) {
1190 if (I.getPredicate() == I.ICMP_NE)
1191 IsTrue = !IsTrue;
Sanjay Patel4b198802016-02-01 22:23:39 +00001192 return replaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001193 };
1194
1195 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1196 if (I.getPredicate() == I.ICMP_NE)
1197 Pred = CmpInst::getInversePredicate(Pred);
1198 return new ICmpInst(Pred, LHS, RHS);
1199 };
1200
Benjamin Kramer46e38f32016-06-08 10:01:20 +00001201 const APInt &AP1 = CI1->getValue();
1202 const APInt &AP2 = CI2->getValue();
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001203
David Majnemer2abb8182014-10-25 07:13:13 +00001204 // Don't bother doing any work for cases which InstSimplify handles.
1205 if (AP2 == 0)
1206 return nullptr;
1207 bool IsAShr = isa<AShrOperator>(Op);
1208 if (IsAShr) {
1209 if (AP2.isAllOnesValue())
1210 return nullptr;
1211 if (AP2.isNegative() != AP1.isNegative())
1212 return nullptr;
1213 if (AP2.sgt(AP1))
1214 return nullptr;
1215 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001216
David Majnemerd2056022014-10-21 19:51:55 +00001217 if (!AP1)
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001218 // 'A' must be large enough to shift out the highest set bit.
1219 return getICmp(I.ICMP_UGT, A,
1220 ConstantInt::get(A->getType(), AP2.logBase2()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001221
David Majnemerd2056022014-10-21 19:51:55 +00001222 if (AP1 == AP2)
1223 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001224
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001225 int Shift;
David Majnemerd2056022014-10-21 19:51:55 +00001226 if (IsAShr && AP1.isNegative())
David Majnemere5977eb2015-09-19 00:48:26 +00001227 Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes();
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001228 else
David Majnemere5977eb2015-09-19 00:48:26 +00001229 Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros();
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001230
David Majnemerd2056022014-10-21 19:51:55 +00001231 if (Shift > 0) {
David Majnemere5977eb2015-09-19 00:48:26 +00001232 if (IsAShr && AP1 == AP2.ashr(Shift)) {
1233 // There are multiple solutions if we are comparing against -1 and the LHS
David Majnemer47ce0b82015-09-19 00:48:31 +00001234 // of the ashr is not a power of two.
David Majnemere5977eb2015-09-19 00:48:26 +00001235 if (AP1.isAllOnesValue() && !AP2.isPowerOf2())
1236 return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift));
David Majnemerd2056022014-10-21 19:51:55 +00001237 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
David Majnemere5977eb2015-09-19 00:48:26 +00001238 } else if (AP1 == AP2.lshr(Shift)) {
1239 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1240 }
David Majnemerd2056022014-10-21 19:51:55 +00001241 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001242 // Shifting const2 will never be equal to const1.
1243 return getConstant(false);
1244}
Chris Lattner2188e402010-01-04 07:37:31 +00001245
Sanjay Patel5f0217f2016-06-05 16:46:18 +00001246/// Handle "(icmp eq/ne (shl const2, A), const1)" ->
David Majnemer59939ac2014-10-19 08:23:08 +00001247/// (icmp eq/ne A, TrailingZeros(const1) - TrailingZeros(const2)).
Sanjay Patel43395062016-07-21 18:07:40 +00001248Instruction *InstCombiner::foldICmpCstShlConst(ICmpInst &I, Value *Op, Value *A,
1249 ConstantInt *CI1,
1250 ConstantInt *CI2) {
David Majnemer59939ac2014-10-19 08:23:08 +00001251 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1252
1253 auto getConstant = [&I, this](bool IsTrue) {
1254 if (I.getPredicate() == I.ICMP_NE)
1255 IsTrue = !IsTrue;
Sanjay Patel4b198802016-02-01 22:23:39 +00001256 return replaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
David Majnemer59939ac2014-10-19 08:23:08 +00001257 };
1258
1259 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1260 if (I.getPredicate() == I.ICMP_NE)
1261 Pred = CmpInst::getInversePredicate(Pred);
1262 return new ICmpInst(Pred, LHS, RHS);
1263 };
1264
Benjamin Kramer46e38f32016-06-08 10:01:20 +00001265 const APInt &AP1 = CI1->getValue();
1266 const APInt &AP2 = CI2->getValue();
David Majnemer59939ac2014-10-19 08:23:08 +00001267
David Majnemer2abb8182014-10-25 07:13:13 +00001268 // Don't bother doing any work for cases which InstSimplify handles.
1269 if (AP2 == 0)
1270 return nullptr;
David Majnemer59939ac2014-10-19 08:23:08 +00001271
1272 unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1273
1274 if (!AP1 && AP2TrailingZeros != 0)
1275 return getICmp(I.ICMP_UGE, A,
1276 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
1277
1278 if (AP1 == AP2)
1279 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1280
1281 // Get the distance between the lowest bits that are set.
1282 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1283
1284 if (Shift > 0 && AP2.shl(Shift) == AP1)
1285 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1286
1287 // Shifting const2 will never be equal to const1.
1288 return getConstant(false);
1289}
1290
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001291/// Fold icmp (trunc X, Y), C.
1292Instruction *InstCombiner::foldICmpTruncConstant(ICmpInst &Cmp,
1293 Instruction *Trunc,
1294 const APInt *C) {
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001295 ICmpInst::Predicate Pred = Cmp.getPredicate();
1296 Value *X = Trunc->getOperand(0);
Sanjay Patel40e8ca42016-08-18 20:28:54 +00001297 if (*C == 1 && C->getBitWidth() > 1) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001298 // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1
1299 Value *V = nullptr;
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001300 if (Pred == ICmpInst::ICMP_SLT && match(X, m_Signum(m_Value(V))))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001301 return new ICmpInst(ICmpInst::ICMP_SLT, V,
1302 ConstantInt::get(V->getType(), 1));
1303 }
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001304
1305 if (Cmp.isEquality() && Trunc->hasOneUse()) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001306 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1307 // of the high bits truncated out of x are known.
Sanjay Patel40e8ca42016-08-18 20:28:54 +00001308 unsigned DstBits = Trunc->getType()->getScalarSizeInBits(),
1309 SrcBits = X->getType()->getScalarSizeInBits();
Sanjay Patela3f4f082016-08-16 17:54:36 +00001310 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001311 computeKnownBits(X, KnownZero, KnownOne, 0, &Cmp);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001312
1313 // If all the high bits are known, we can do this xform.
1314 if ((KnownZero | KnownOne).countLeadingOnes() >= SrcBits - DstBits) {
1315 // Pull in the high bits from known-ones set.
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001316 APInt NewRHS = C->zext(SrcBits);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001317 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits - DstBits);
Sanjay Patel40e8ca42016-08-18 20:28:54 +00001318 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), NewRHS));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001319 }
1320 }
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001321
Sanjay Patela3f4f082016-08-16 17:54:36 +00001322 return nullptr;
1323}
1324
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001325/// Fold icmp (xor X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001326Instruction *InstCombiner::foldICmpXorConstant(ICmpInst &Cmp,
1327 BinaryOperator *Xor,
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001328 const APInt *C) {
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001329 Value *X = Xor->getOperand(0);
1330 Value *Y = Xor->getOperand(1);
Sanjay Pateldaffec912016-08-17 19:45:18 +00001331 const APInt *XorC;
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001332 if (!match(Y, m_APInt(XorC)))
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001333 return nullptr;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001334
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001335 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1336 // fold the xor.
1337 ICmpInst::Predicate Pred = Cmp.getPredicate();
1338 if ((Pred == ICmpInst::ICMP_SLT && *C == 0) ||
1339 (Pred == ICmpInst::ICMP_SGT && C->isAllOnesValue())) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001340
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001341 // If the sign bit of the XorCst is not set, there is no change to
1342 // the operation, just stop using the Xor.
Sanjay Pateldaffec912016-08-17 19:45:18 +00001343 if (!XorC->isNegative()) {
1344 Cmp.setOperand(0, X);
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001345 Worklist.Add(Xor);
1346 return &Cmp;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001347 }
1348
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001349 // Was the old condition true if the operand is positive?
1350 bool isTrueIfPositive = Pred == ICmpInst::ICMP_SGT;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001351
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001352 // If so, the new one isn't.
1353 isTrueIfPositive ^= true;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001354
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001355 Constant *CmpConstant = cast<Constant>(Cmp.getOperand(1));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001356 if (isTrueIfPositive)
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001357 return new ICmpInst(ICmpInst::ICMP_SGT, X, SubOne(CmpConstant));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001358 else
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001359 return new ICmpInst(ICmpInst::ICMP_SLT, X, AddOne(CmpConstant));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001360 }
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001361
1362 if (Xor->hasOneUse()) {
Sanjay Pateldaffec912016-08-17 19:45:18 +00001363 // (icmp u/s (xor X SignBit), C) -> (icmp s/u X, (xor C SignBit))
1364 if (!Cmp.isEquality() && XorC->isSignBit()) {
1365 Pred = Cmp.isSigned() ? Cmp.getUnsignedPredicate()
1366 : Cmp.getSignedPredicate();
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001367 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), *C ^ *XorC));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001368 }
1369
Sanjay Pateldaffec912016-08-17 19:45:18 +00001370 // (icmp u/s (xor X ~SignBit), C) -> (icmp s/u X, (xor C ~SignBit))
1371 if (!Cmp.isEquality() && XorC->isMaxSignedValue()) {
1372 Pred = Cmp.isSigned() ? Cmp.getUnsignedPredicate()
1373 : Cmp.getSignedPredicate();
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001374 Pred = Cmp.getSwappedPredicate(Pred);
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001375 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), *C ^ *XorC));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001376 }
1377 }
1378
1379 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1380 // iff -C is a power of 2
Sanjay Pateldaffec912016-08-17 19:45:18 +00001381 if (Pred == ICmpInst::ICMP_UGT && *XorC == ~(*C) && (*C + 1).isPowerOf2())
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001382 return new ICmpInst(ICmpInst::ICMP_ULT, X, Y);
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001383
1384 // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1385 // iff -C is a power of 2
Sanjay Pateldaffec912016-08-17 19:45:18 +00001386 if (Pred == ICmpInst::ICMP_ULT && *XorC == -(*C) && C->isPowerOf2())
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001387 return new ICmpInst(ICmpInst::ICMP_UGE, X, Y);
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001388
Sanjay Patela3f4f082016-08-16 17:54:36 +00001389 return nullptr;
1390}
1391
Sanjay Patelc9196c42016-08-22 21:24:29 +00001392Instruction *InstCombiner::foldICmpAndConstant(ICmpInst &ICI,
1393 BinaryOperator *LHSI,
Sanjay Patela3f4f082016-08-16 17:54:36 +00001394 const APInt *RHSV) {
1395 // FIXME: This check restricts all folds under here to scalar types.
1396 ConstantInt *RHS = dyn_cast<ConstantInt>(ICI.getOperand(1));
1397 if (!RHS)
1398 return nullptr;
1399
1400 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1401 LHSI->getOperand(0)->hasOneUse()) {
1402 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
1403
1404 // If the LHS is an AND of a truncating cast, we can widen the
1405 // and/compare to be the input width without changing the value
1406 // produced, eliminating a cast.
1407 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1408 // We can do this transformation if either the AND constant does not
1409 // have its sign bit set or if it is an equality comparison.
1410 // Extending a relational comparison when we're checking the sign
1411 // bit would not work.
1412 if (ICI.isEquality() ||
1413 (!AndCst->isNegative() && RHSV->isNonNegative())) {
1414 Value *NewAnd =
1415 Builder->CreateAnd(Cast->getOperand(0),
1416 ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
1417 NewAnd->takeName(LHSI);
1418 return new ICmpInst(ICI.getPredicate(), NewAnd,
1419 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
1420 }
1421 }
1422
1423 // If the LHS is an AND of a zext, and we have an equality compare, we can
1424 // shrink the and/compare to the smaller type, eliminating the cast.
1425 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
1426 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
1427 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1428 // should fold the icmp to true/false in that case.
1429 if (ICI.isEquality() && RHSV->getActiveBits() <= Ty->getBitWidth()) {
1430 Value *NewAnd = Builder->CreateAnd(Cast->getOperand(0),
1431 ConstantExpr::getTrunc(AndCst, Ty));
1432 NewAnd->takeName(LHSI);
1433 return new ICmpInst(ICI.getPredicate(), NewAnd,
1434 ConstantExpr::getTrunc(RHS, Ty));
1435 }
1436 }
1437
1438 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1439 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1440 // happens a LOT in code produced by the C front-end, for bitfield
1441 // access.
1442 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1443 if (Shift && !Shift->isShift())
1444 Shift = nullptr;
1445
1446 ConstantInt *ShAmt;
1447 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
1448
1449 // This seemingly simple opportunity to fold away a shift turns out to
1450 // be rather complicated. See PR17827
1451 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
1452 if (ShAmt) {
1453 bool CanFold = false;
1454 unsigned ShiftOpcode = Shift->getOpcode();
1455 if (ShiftOpcode == Instruction::AShr) {
1456 // There may be some constraints that make this possible,
1457 // but nothing simple has been discovered yet.
1458 CanFold = false;
1459 } else if (ShiftOpcode == Instruction::Shl) {
1460 // For a left shift, we can fold if the comparison is not signed.
1461 // We can also fold a signed comparison if the mask value and
1462 // comparison value are not negative. These constraints may not be
1463 // obvious, but we can prove that they are correct using an SMT
1464 // solver.
1465 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
1466 CanFold = true;
1467 } else if (ShiftOpcode == Instruction::LShr) {
1468 // For a logical right shift, we can fold if the comparison is not
1469 // signed. We can also fold a signed comparison if the shifted mask
1470 // value and the shifted comparison value are not negative.
1471 // These constraints may not be obvious, but we can prove that they
1472 // are correct using an SMT solver.
1473 if (!ICI.isSigned())
1474 CanFold = true;
1475 else {
1476 ConstantInt *ShiftedAndCst =
1477 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1478 ConstantInt *ShiftedRHSCst =
1479 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1480
1481 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1482 CanFold = true;
1483 }
1484 }
1485
1486 if (CanFold) {
1487 Constant *NewCst;
1488 if (ShiftOpcode == Instruction::Shl)
1489 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1490 else
1491 NewCst = ConstantExpr::getShl(RHS, ShAmt);
1492
1493 // Check to see if we are shifting out any of the bits being
1494 // compared.
1495 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
1496 // If we shifted bits out, the fold is not going to work out.
1497 // As a special case, check to see if this means that the
1498 // result is always true or false now.
1499 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1500 return replaceInstUsesWith(ICI, Builder->getFalse());
1501 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
1502 return replaceInstUsesWith(ICI, Builder->getTrue());
1503 } else {
1504 ICI.setOperand(1, NewCst);
1505 Constant *NewAndCst;
1506 if (ShiftOpcode == Instruction::Shl)
1507 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
1508 else
1509 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1510 LHSI->setOperand(1, NewAndCst);
1511 LHSI->setOperand(0, Shift->getOperand(0));
1512 Worklist.Add(Shift); // Shift is dead.
1513 return &ICI;
1514 }
1515 }
1516 }
1517
1518 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1519 // preferable because it allows the C<<Y expression to be hoisted out
1520 // of a loop if Y is invariant and X is not.
1521 if (Shift && Shift->hasOneUse() && *RHSV == 0 && ICI.isEquality() &&
1522 !Shift->isArithmeticShift() && !isa<Constant>(Shift->getOperand(0))) {
1523 // Compute C << Y.
1524 Value *NS;
1525 if (Shift->getOpcode() == Instruction::LShr) {
1526 NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
1527 } else {
1528 // Insert a logical shift.
1529 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
1530 }
1531
1532 // Compute X & (C << Y).
1533 Value *NewAnd =
1534 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
1535
1536 ICI.setOperand(0, NewAnd);
1537 return &ICI;
1538 }
1539
1540 // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1541 // (icmp pred (and X, (or (shl 1, Y), 1), 0))
1542 //
1543 // iff pred isn't signed
1544 {
1545 Value *X, *Y, *LShr;
1546 if (!ICI.isSigned() && *RHSV == 0) {
1547 if (match(LHSI->getOperand(1), m_One())) {
1548 Constant *One = cast<Constant>(LHSI->getOperand(1));
1549 Value *Or = LHSI->getOperand(0);
1550 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1551 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1552 unsigned UsesRemoved = 0;
1553 if (LHSI->hasOneUse())
1554 ++UsesRemoved;
1555 if (Or->hasOneUse())
1556 ++UsesRemoved;
1557 if (LShr->hasOneUse())
1558 ++UsesRemoved;
1559 Value *NewOr = nullptr;
1560 // Compute X & ((1 << Y) | 1)
1561 if (auto *C = dyn_cast<Constant>(Y)) {
1562 if (UsesRemoved >= 1)
1563 NewOr =
1564 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1565 } else {
1566 if (UsesRemoved >= 3)
1567 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1568 LShr->getName(),
1569 /*HasNUW=*/true),
1570 One, Or->getName());
1571 }
1572 if (NewOr) {
1573 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1574 ICI.setOperand(0, NewAnd);
1575 return &ICI;
1576 }
1577 }
1578 }
1579 }
1580 }
1581
1582 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1583 // bit set in (X & AndCst) will produce a result greater than RHSV.
1584 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
1585 unsigned NTZ = AndCst->getValue().countTrailingZeros();
1586 if ((NTZ < AndCst->getBitWidth()) &&
1587 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(*RHSV))
1588 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1589 Constant::getNullValue(RHS->getType()));
1590 }
1591 }
1592
1593 // Try to optimize things like "A[i]&42 == 0" to index computations.
1594 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1595 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1596 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1597 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1598 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1599 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1600 if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, ICI, C))
1601 return Res;
1602 }
1603 }
1604
1605 // X & -C == -C -> X > u ~C
1606 // X & -C != -C -> X <= u ~C
1607 // iff C is a power of 2
1608 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-(*RHSV)).isPowerOf2())
1609 return new ICmpInst(ICI.getPredicate() == ICmpInst::ICMP_EQ
1610 ? ICmpInst::ICMP_UGT
1611 : ICmpInst::ICMP_ULE,
1612 LHSI->getOperand(0), SubOne(RHS));
1613
1614 // (icmp eq (and %A, C), 0) -> (icmp sgt (trunc %A), -1)
1615 // iff C is a power of 2
1616 if (ICI.isEquality() && LHSI->hasOneUse() && match(RHS, m_Zero())) {
1617 if (auto *CI = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1618 const APInt &AI = CI->getValue();
1619 int32_t ExactLogBase2 = AI.exactLogBase2();
1620 if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1621 Type *NTy = IntegerType::get(ICI.getContext(), ExactLogBase2 + 1);
1622 Value *Trunc = Builder->CreateTrunc(LHSI->getOperand(0), NTy);
1623 return new ICmpInst(ICI.getPredicate() == ICmpInst::ICMP_EQ
1624 ? ICmpInst::ICMP_SGE
1625 : ICmpInst::ICMP_SLT,
1626 Trunc, Constant::getNullValue(NTy));
1627 }
1628 }
1629 }
1630 return nullptr;
1631}
1632
Sanjay Patel943e92e2016-08-17 16:30:43 +00001633/// Fold icmp (or X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001634Instruction *InstCombiner::foldICmpOrConstant(ICmpInst &Cmp, BinaryOperator *Or,
Sanjay Patel943e92e2016-08-17 16:30:43 +00001635 const APInt *C) {
Sanjay Patel943e92e2016-08-17 16:30:43 +00001636 ICmpInst::Predicate Pred = Cmp.getPredicate();
1637 if (*C == 1) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001638 // icmp slt signum(V) 1 --> icmp slt V, 1
1639 Value *V = nullptr;
Sanjay Patel943e92e2016-08-17 16:30:43 +00001640 if (Pred == ICmpInst::ICMP_SLT && match(Or, m_Signum(m_Value(V))))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001641 return new ICmpInst(ICmpInst::ICMP_SLT, V,
1642 ConstantInt::get(V->getType(), 1));
1643 }
1644
Sanjay Patel943e92e2016-08-17 16:30:43 +00001645 if (!Cmp.isEquality() || *C != 0 || !Or->hasOneUse())
Sanjay Patela3f4f082016-08-16 17:54:36 +00001646 return nullptr;
1647
1648 Value *P, *Q;
Sanjay Patel943e92e2016-08-17 16:30:43 +00001649 if (match(Or, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001650 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1651 // -> and (icmp eq P, null), (icmp eq Q, null).
Reid Klecknera871d382016-08-19 16:53:18 +00001652 Value *CmpP =
1653 Builder->CreateICmp(Pred, P, ConstantInt::getNullValue(P->getType()));
1654 Value *CmpQ =
1655 Builder->CreateICmp(Pred, Q, ConstantInt::getNullValue(Q->getType()));
Sanjay Patel943e92e2016-08-17 16:30:43 +00001656 auto LogicOpc = Pred == ICmpInst::Predicate::ICMP_EQ ? Instruction::And
1657 : Instruction::Or;
1658 return BinaryOperator::Create(LogicOpc, CmpP, CmpQ);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001659 }
Sanjay Patel943e92e2016-08-17 16:30:43 +00001660
Sanjay Patela3f4f082016-08-16 17:54:36 +00001661 return nullptr;
1662}
1663
Sanjay Patel63478072016-08-18 15:44:44 +00001664/// Fold icmp (mul X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001665Instruction *InstCombiner::foldICmpMulConstant(ICmpInst &Cmp,
1666 BinaryOperator *Mul,
Sanjay Patel63478072016-08-18 15:44:44 +00001667 const APInt *C) {
1668 const APInt *MulC;
1669 if (!match(Mul->getOperand(1), m_APInt(MulC)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001670 return nullptr;
1671
Sanjay Patel63478072016-08-18 15:44:44 +00001672 // If this is a test of the sign bit and the multiply is sign-preserving with
1673 // a constant operand, use the multiply LHS operand instead.
1674 ICmpInst::Predicate Pred = Cmp.getPredicate();
Sanjay Patelc9196c42016-08-22 21:24:29 +00001675 if (isSignTest(Pred, *C) && Mul->hasNoSignedWrap()) {
Sanjay Patel63478072016-08-18 15:44:44 +00001676 if (MulC->isNegative())
1677 Pred = ICmpInst::getSwappedPredicate(Pred);
1678 return new ICmpInst(Pred, Mul->getOperand(0),
1679 Constant::getNullValue(Mul->getType()));
1680 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001681
1682 return nullptr;
1683}
1684
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001685/// Fold icmp (shl 1, Y), C.
1686static Instruction *foldICmpShlOne(ICmpInst &Cmp, Instruction *Shl,
1687 const APInt *C) {
1688 Value *Y;
1689 if (!match(Shl, m_Shl(m_One(), m_Value(Y))))
1690 return nullptr;
1691
1692 Type *ShiftType = Shl->getType();
1693 uint32_t TypeBits = C->getBitWidth();
1694 bool CIsPowerOf2 = C->isPowerOf2();
1695 ICmpInst::Predicate Pred = Cmp.getPredicate();
1696 if (Cmp.isUnsigned()) {
1697 // (1 << Y) pred C -> Y pred Log2(C)
1698 if (!CIsPowerOf2) {
1699 // (1 << Y) < 30 -> Y <= 4
1700 // (1 << Y) <= 30 -> Y <= 4
1701 // (1 << Y) >= 30 -> Y > 4
1702 // (1 << Y) > 30 -> Y > 4
1703 if (Pred == ICmpInst::ICMP_ULT)
1704 Pred = ICmpInst::ICMP_ULE;
1705 else if (Pred == ICmpInst::ICMP_UGE)
1706 Pred = ICmpInst::ICMP_UGT;
1707 }
1708
1709 // (1 << Y) >= 2147483648 -> Y >= 31 -> Y == 31
1710 // (1 << Y) < 2147483648 -> Y < 31 -> Y != 31
1711 unsigned CLog2 = C->logBase2();
1712 if (CLog2 == TypeBits - 1) {
1713 if (Pred == ICmpInst::ICMP_UGE)
1714 Pred = ICmpInst::ICMP_EQ;
1715 else if (Pred == ICmpInst::ICMP_ULT)
1716 Pred = ICmpInst::ICMP_NE;
1717 }
1718 return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, CLog2));
1719 } else if (Cmp.isSigned()) {
1720 Constant *BitWidthMinusOne = ConstantInt::get(ShiftType, TypeBits - 1);
1721 if (C->isAllOnesValue()) {
1722 // (1 << Y) <= -1 -> Y == 31
1723 if (Pred == ICmpInst::ICMP_SLE)
1724 return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
1725
1726 // (1 << Y) > -1 -> Y != 31
1727 if (Pred == ICmpInst::ICMP_SGT)
1728 return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
1729 } else if (!(*C)) {
1730 // (1 << Y) < 0 -> Y == 31
1731 // (1 << Y) <= 0 -> Y == 31
1732 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1733 return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
1734
1735 // (1 << Y) >= 0 -> Y != 31
1736 // (1 << Y) > 0 -> Y != 31
1737 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1738 return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
1739 }
1740 } else if (Cmp.isEquality() && CIsPowerOf2) {
1741 return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, C->logBase2()));
1742 }
1743
1744 return nullptr;
1745}
1746
Sanjay Patel38b75062016-08-19 17:20:37 +00001747/// Fold icmp (shl X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001748Instruction *InstCombiner::foldICmpShlConstant(ICmpInst &Cmp,
1749 BinaryOperator *Shl,
Sanjay Patel38b75062016-08-19 17:20:37 +00001750 const APInt *C) {
Sanjay Patelfa7de602016-08-19 22:33:26 +00001751 const APInt *ShiftAmt;
1752 if (!match(Shl->getOperand(1), m_APInt(ShiftAmt)))
Sanjay Patel38b75062016-08-19 17:20:37 +00001753 return foldICmpShlOne(Cmp, Shl, C);
Sanjay Patela867afe2016-08-19 16:12:16 +00001754
Sanjay Patel38b75062016-08-19 17:20:37 +00001755 // Check that the shift amount is in range. If not, don't perform undefined
1756 // shifts. When the shift is visited it will be simplified.
1757 unsigned TypeBits = C->getBitWidth();
Sanjay Patelfa7de602016-08-19 22:33:26 +00001758 if (ShiftAmt->uge(TypeBits))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001759 return nullptr;
1760
Sanjay Patele38e79c2016-08-19 17:34:05 +00001761 ICmpInst::Predicate Pred = Cmp.getPredicate();
1762 Value *X = Shl->getOperand(0);
Sanjay Patel38b75062016-08-19 17:20:37 +00001763 if (Cmp.isEquality()) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001764 // If the shift is NUW, then it is just shifting out zeros, no need for an
1765 // AND.
Sanjay Patelfa7de602016-08-19 22:33:26 +00001766 Constant *LShrC = ConstantInt::get(Shl->getType(), C->lshr(*ShiftAmt));
Sanjay Patelc9196c42016-08-22 21:24:29 +00001767 if (Shl->hasNoUnsignedWrap())
Sanjay Patelfa7de602016-08-19 22:33:26 +00001768 return new ICmpInst(Pred, X, LShrC);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001769
1770 // If the shift is NSW and we compare to 0, then it is just shifting out
1771 // sign bits, no need for an AND either.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001772 if (Shl->hasNoSignedWrap() && *C == 0)
Sanjay Patelfa7de602016-08-19 22:33:26 +00001773 return new ICmpInst(Pred, X, LShrC);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001774
Sanjay Patel38b75062016-08-19 17:20:37 +00001775 if (Shl->hasOneUse()) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001776 // Otherwise strength reduce the shift into an and.
Sanjay Patelfa7de602016-08-19 22:33:26 +00001777 Constant *Mask = ConstantInt::get(Shl->getType(),
1778 APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt->getZExtValue()));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001779
Sanjay Patele38e79c2016-08-19 17:34:05 +00001780 Value *And = Builder->CreateAnd(X, Mask, Shl->getName() + ".mask");
Sanjay Patelfa7de602016-08-19 22:33:26 +00001781 return new ICmpInst(Pred, And, LShrC);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001782 }
1783 }
1784
1785 // If this is a signed comparison to 0 and the shift is sign preserving,
Sanjay Patele38e79c2016-08-19 17:34:05 +00001786 // use the shift LHS operand instead; isSignTest may change 'Pred', so only
1787 // do that if we're sure to not continue on in this function.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001788 if (Shl->hasNoSignedWrap() && isSignTest(Pred, *C))
Sanjay Patel7e09f132016-08-21 16:28:22 +00001789 return new ICmpInst(Pred, X, Constant::getNullValue(X->getType()));
1790
Sanjay Patela3f4f082016-08-16 17:54:36 +00001791 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1792 bool TrueIfSigned = false;
Sanjay Patel79263662016-08-21 15:07:45 +00001793 if (Shl->hasOneUse() && isSignBitCheck(Pred, *C, TrueIfSigned)) {
Sanjay Patel7ffcde72016-08-21 16:35:34 +00001794 // (X << 31) <s 0 --> (X & 1) != 0
Sanjay Patela3f4f082016-08-16 17:54:36 +00001795 Constant *Mask = ConstantInt::get(
Sanjay Patele38e79c2016-08-19 17:34:05 +00001796 X->getType(),
Sanjay Patelfa7de602016-08-19 22:33:26 +00001797 APInt::getOneBitSet(TypeBits, TypeBits - ShiftAmt->getZExtValue() - 1));
Sanjay Patele38e79c2016-08-19 17:34:05 +00001798 Value *And = Builder->CreateAnd(X, Mask, Shl->getName() + ".mask");
Sanjay Patela3f4f082016-08-16 17:54:36 +00001799 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1800 And, Constant::getNullValue(And->getType()));
1801 }
1802
Sanjay Patel643d21a2016-08-21 17:10:07 +00001803 // Transform (icmp pred iM (shl iM %v, N), C)
1804 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (C>>N))
1805 // Transform the shl to a trunc if (trunc (C>>N)) has no loss and M-N.
1806 // This enables us to get rid of the shift in favor of a trunc which can be
Sanjay Patela3f4f082016-08-16 17:54:36 +00001807 // free on the target. It has the additional benefit of comparing to a
1808 // smaller constant, which will be target friendly.
Sanjay Patelfa7de602016-08-19 22:33:26 +00001809 unsigned Amt = ShiftAmt->getLimitedValue(TypeBits - 1);
Sanjay Patel38b75062016-08-19 17:20:37 +00001810 if (Shl->hasOneUse() && Amt != 0 && C->countTrailingZeros() >= Amt) {
Sanjay Patel643d21a2016-08-21 17:10:07 +00001811 Type *TruncTy = IntegerType::get(Cmp.getContext(), TypeBits - Amt);
1812 if (X->getType()->isVectorTy())
1813 TruncTy = VectorType::get(TruncTy, X->getType()->getVectorNumElements());
1814 Constant *NewC =
1815 ConstantInt::get(TruncTy, C->ashr(*ShiftAmt).trunc(TypeBits - Amt));
1816 return new ICmpInst(Pred, Builder->CreateTrunc(X, TruncTy), NewC);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001817 }
1818
1819 return nullptr;
1820}
1821
Sanjay Patela3920492016-08-22 20:45:06 +00001822/// Fold icmp ({al}shr X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001823Instruction *InstCombiner::foldICmpShrConstant(ICmpInst &Cmp,
1824 BinaryOperator *Shr,
1825 const APInt *C) {
Sanjay Patela3920492016-08-22 20:45:06 +00001826 // An exact shr only shifts out zero bits, so:
1827 // icmp eq/ne (shr X, Y), 0 --> icmp eq/ne X, 0
Sanjay Pateld64e9882016-08-23 22:05:55 +00001828 Value *X = Shr->getOperand(0);
Sanjay Patelc9196c42016-08-22 21:24:29 +00001829 CmpInst::Predicate Pred = Cmp.getPredicate();
1830 if (Cmp.isEquality() && Shr->isExact() && Shr->hasOneUse() && *C == 0)
Sanjay Pateld64e9882016-08-23 22:05:55 +00001831 return new ICmpInst(Pred, X, Cmp.getOperand(1));
Sanjay Patela3920492016-08-22 20:45:06 +00001832
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001833 const APInt *ShiftAmt;
1834 if (!match(Shr->getOperand(1), m_APInt(ShiftAmt)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001835 return nullptr;
1836
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001837 // Check that the shift amount is in range. If not, don't perform undefined
1838 // shifts. When the shift is visited it will be simplified.
1839 unsigned TypeBits = C->getBitWidth();
1840 unsigned ShAmtVal = ShiftAmt->getLimitedValue(TypeBits);
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001841 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
1842 return nullptr;
1843
Sanjay Pateld64e9882016-08-23 22:05:55 +00001844 bool IsAShr = Shr->getOpcode() == Instruction::AShr;
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001845 if (!Cmp.isEquality()) {
1846 // If we have an unsigned comparison and an ashr, we can't simplify this.
1847 // Similarly for signed comparisons with lshr.
Sanjay Pateld64e9882016-08-23 22:05:55 +00001848 if (Cmp.isSigned() != IsAShr)
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001849 return nullptr;
1850
1851 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
1852 // by a power of 2. Since we already have logic to simplify these,
1853 // transform to div and then simplify the resultant comparison.
Sanjay Pateld64e9882016-08-23 22:05:55 +00001854 if (IsAShr && (!Shr->isExact() || ShAmtVal == TypeBits - 1))
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001855 return nullptr;
1856
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001857 // FIXME: This check restricts this fold to scalar types.
1858 ConstantInt *ShAmt = dyn_cast<ConstantInt>(Shr->getOperand(1));
1859 if (!ShAmt)
1860 return nullptr;
1861
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001862 // Revisit the shift (to delete it).
1863 Worklist.Add(Shr);
1864
1865 Constant *DivCst = ConstantInt::get(
1866 Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
1867
Sanjay Pateld64e9882016-08-23 22:05:55 +00001868 Value *Tmp = IsAShr ? Builder->CreateSDiv(X, DivCst, "", Shr->isExact())
1869 : Builder->CreateUDiv(X, DivCst, "", Shr->isExact());
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001870
1871 Cmp.setOperand(0, Tmp);
1872
1873 // If the builder folded the binop, just return it.
1874 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
1875 if (!TheDiv)
1876 return &Cmp;
1877
1878 // Otherwise, fold this div/compare.
1879 assert(TheDiv->getOpcode() == Instruction::SDiv ||
1880 TheDiv->getOpcode() == Instruction::UDiv);
1881
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001882 Instruction *Res = foldICmpDivConstant(Cmp, TheDiv, C);
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001883 assert(Res && "This div/cst should have folded!");
Sanjay Patela3920492016-08-22 20:45:06 +00001884 return Res;
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001885 }
1886
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001887 // Handle equality comparisons of shift-by-constant.
1888
Sanjay Patel8e297742016-08-24 13:55:55 +00001889 // If the comparison constant changes with the shift, the comparison cannot
1890 // succeed (bits of the comparison constant cannot match the shifted value).
1891 // This should be known by InstSimplify and already be folded to true/false.
1892 assert(((IsAShr && C->shl(ShAmtVal).ashr(ShAmtVal) == *C) ||
1893 (!IsAShr && C->shl(ShAmtVal).lshr(ShAmtVal) == *C)) &&
1894 "Expected icmp+shr simplify did not occur.");
1895
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001896 // Check if the bits shifted out are known to be zero. If so, we can compare
1897 // against the unshifted value:
1898 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001899 Constant *ShiftedCmpRHS = ConstantInt::get(Shr->getType(), *C << ShAmtVal);
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001900 if (Shr->hasOneUse()) {
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001901 if (Shr->isExact())
1902 return new ICmpInst(Pred, X, ShiftedCmpRHS);
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001903
Sanjay Pateld398d4a2016-08-24 22:22:06 +00001904 // Otherwise strength reduce the shift into an 'and'.
1905 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
1906 Constant *Mask = ConstantInt::get(Shr->getType(), Val);
Sanjay Pateld64e9882016-08-23 22:05:55 +00001907 Value *And = Builder->CreateAnd(X, Mask, Shr->getName() + ".mask");
Sanjay Pateldcac0df2016-08-23 21:25:13 +00001908 return new ICmpInst(Pred, And, ShiftedCmpRHS);
1909 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001910
1911 return nullptr;
1912}
1913
Sanjay Patel12a41052016-08-18 17:37:26 +00001914/// Fold icmp (udiv X, Y), C.
1915Instruction *InstCombiner::foldICmpUDivConstant(ICmpInst &Cmp,
Sanjay Patelc9196c42016-08-22 21:24:29 +00001916 BinaryOperator *UDiv,
Sanjay Patel12a41052016-08-18 17:37:26 +00001917 const APInt *C) {
Sanjay Patelfa5ca2b2016-08-18 17:55:59 +00001918 const APInt *C2;
1919 if (!match(UDiv->getOperand(0), m_APInt(C2)))
1920 return nullptr;
1921
1922 assert(C2 != 0 && "udiv 0, X should have been simplified already.");
1923
1924 // (icmp ugt (udiv C2, Y), C) -> (icmp ule Y, C2/(C+1))
1925 Value *Y = UDiv->getOperand(1);
1926 if (Cmp.getPredicate() == ICmpInst::ICMP_UGT) {
1927 assert(!C->isMaxValue() &&
1928 "icmp ugt X, UINT_MAX should have been simplified already.");
1929 return new ICmpInst(ICmpInst::ICMP_ULE, Y,
1930 ConstantInt::get(Y->getType(), C2->udiv(*C + 1)));
1931 }
1932
1933 // (icmp ult (udiv C2, Y), C) -> (icmp ugt Y, C2/C)
1934 if (Cmp.getPredicate() == ICmpInst::ICMP_ULT) {
1935 assert(C != 0 && "icmp ult X, 0 should have been simplified already.");
1936 return new ICmpInst(ICmpInst::ICMP_UGT, Y,
1937 ConstantInt::get(Y->getType(), C2->udiv(*C)));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001938 }
1939
1940 return nullptr;
1941}
1942
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001943/// Fold icmp ({su}div X, Y), C.
1944Instruction *InstCombiner::foldICmpDivConstant(ICmpInst &Cmp,
1945 BinaryOperator *Div,
1946 const APInt *C) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001947 // FIXME: This check restricts all folds under here to scalar types.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001948 ConstantInt *RHS = dyn_cast<ConstantInt>(Cmp.getOperand(1));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001949 if (!RHS)
1950 return nullptr;
1951
1952 // Fold: icmp pred ([us]div X, C1), C2 -> range test
1953 // Fold this div into the comparison, producing a range check.
1954 // Determine, based on the divide type, what the range is being
1955 // checked. If there is an overflow on the low or high side, remember
1956 // it, otherwise compute the range [low, hi) bounding the new value.
1957 // See: InsertRangeTest above for the kinds of replacements possible.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001958 ConstantInt *DivRHS = dyn_cast<ConstantInt>(Div->getOperand(1));
Sanjay Patel16554142016-08-24 23:03:36 +00001959 if (!DivRHS)
1960 return nullptr;
1961
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001962 ConstantInt *CmpRHS = cast<ConstantInt>(Cmp.getOperand(1));
Sanjay Patel16554142016-08-24 23:03:36 +00001963
1964 // FIXME: If the operand types don't match the type of the divide
1965 // then don't attempt this transform. The code below doesn't have the
1966 // logic to deal with a signed divide and an unsigned compare (and
1967 // vice versa). This is because (x /s C1) <s C2 produces different
1968 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
1969 // (x /u C1) <u C2. Simply casting the operands and result won't
1970 // work. :( The if statement below tests that condition and bails
1971 // if it finds it.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001972 bool DivIsSigned = Div->getOpcode() == Instruction::SDiv;
1973 if (!Cmp.isEquality() && DivIsSigned != Cmp.isSigned())
Sanjay Patel16554142016-08-24 23:03:36 +00001974 return nullptr;
1975 if (DivRHS->isZero())
1976 return nullptr; // The ProdOV computation fails on divide by zero.
1977 if (DivIsSigned && DivRHS->isAllOnesValue())
1978 return nullptr; // The overflow computation also screws up here
1979 if (DivRHS->isOne()) {
1980 // This eliminates some funny cases with INT_MIN.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001981 Cmp.setOperand(0, Div->getOperand(0)); // X/1 == X.
1982 return &Cmp;
Sanjay Patel16554142016-08-24 23:03:36 +00001983 }
1984
1985 // Compute Prod = CI * DivRHS. We are essentially solving an equation
1986 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
1987 // C2 (CI). By solving for X we can turn this into a range check
1988 // instead of computing a divide.
1989 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
1990
1991 // Determine if the product overflows by seeing if the product is
1992 // not equal to the divide. Make sure we do the same kind of divide
1993 // as in the LHS instruction that we're folding.
1994 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
1995 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
1996
1997 // Get the ICmp opcode
Sanjay Patelf7ba0892016-08-26 15:53:01 +00001998 ICmpInst::Predicate Pred = Cmp.getPredicate();
Sanjay Patel16554142016-08-24 23:03:36 +00001999
2000 // If the division is known to be exact, then there is no remainder from the
2001 // divide, so the covered range size is unit, otherwise it is the divisor.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002002 ConstantInt *RangeSize = Div->isExact() ? getOne(Prod) : DivRHS;
Sanjay Patel16554142016-08-24 23:03:36 +00002003
2004 // Figure out the interval that is being checked. For example, a comparison
2005 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
2006 // Compute this interval based on the constants involved and the signedness of
2007 // the compare/divide. This computes a half-open interval, keeping track of
2008 // whether either value in the interval overflows. After analysis each
2009 // overflow variable is set to 0 if it's corresponding bound variable is valid
2010 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
2011 int LoOverflow = 0, HiOverflow = 0;
2012 Constant *LoBound = nullptr, *HiBound = nullptr;
2013
2014 if (!DivIsSigned) { // udiv
2015 // e.g. X/5 op 3 --> [15, 20)
2016 LoBound = Prod;
2017 HiOverflow = LoOverflow = ProdOV;
2018 if (!HiOverflow) {
2019 // If this is not an exact divide, then many values in the range collapse
2020 // to the same result value.
2021 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
2022 }
2023 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002024 if (*C == 0) { // (X / pos) op 0
Sanjay Patel16554142016-08-24 23:03:36 +00002025 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
2026 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
2027 HiBound = RangeSize;
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002028 } else if (C->isStrictlyPositive()) { // (X / pos) op pos
Sanjay Patel16554142016-08-24 23:03:36 +00002029 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
2030 HiOverflow = LoOverflow = ProdOV;
2031 if (!HiOverflow)
2032 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
2033 } else { // (X / pos) op neg
2034 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
2035 HiBound = AddOne(Prod);
2036 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
2037 if (!LoOverflow) {
2038 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
2039 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
2040 }
2041 }
2042 } else if (DivRHS->isNegative()) { // Divisor is < 0.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002043 if (Div->isExact())
Sanjay Patel16554142016-08-24 23:03:36 +00002044 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002045 if (*C == 0) { // (X / neg) op 0
Sanjay Patel16554142016-08-24 23:03:36 +00002046 // e.g. X/-5 op 0 --> [-4, 5)
2047 LoBound = AddOne(RangeSize);
2048 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
2049 if (HiBound == DivRHS) { // -INTMIN = INTMIN
2050 HiOverflow = 1; // [INTMIN+1, overflow)
2051 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN
2052 }
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002053 } else if (C->isStrictlyPositive()) { // (X / neg) op pos
Sanjay Patel16554142016-08-24 23:03:36 +00002054 // e.g. X/-5 op 3 --> [-19, -14)
2055 HiBound = AddOne(Prod);
2056 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
2057 if (!LoOverflow)
2058 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
2059 } else { // (X / neg) op neg
2060 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
2061 LoOverflow = HiOverflow = ProdOV;
2062 if (!HiOverflow)
2063 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
2064 }
2065
2066 // Dividing by a negative swaps the condition. LT <-> GT
2067 Pred = ICmpInst::getSwappedPredicate(Pred);
2068 }
2069
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002070 Value *X = Div->getOperand(0);
Sanjay Patel16554142016-08-24 23:03:36 +00002071 switch (Pred) {
2072 default: llvm_unreachable("Unhandled icmp opcode!");
2073 case ICmpInst::ICMP_EQ:
2074 if (LoOverflow && HiOverflow)
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002075 return replaceInstUsesWith(Cmp, Builder->getFalse());
Sanjay Patel16554142016-08-24 23:03:36 +00002076 if (HiOverflow)
2077 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
2078 ICmpInst::ICMP_UGE, X, LoBound);
2079 if (LoOverflow)
2080 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
2081 ICmpInst::ICMP_ULT, X, HiBound);
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002082 return replaceInstUsesWith(Cmp, InsertRangeTest(X, LoBound, HiBound,
Sanjay Patel16554142016-08-24 23:03:36 +00002083 DivIsSigned, true));
2084 case ICmpInst::ICMP_NE:
2085 if (LoOverflow && HiOverflow)
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002086 return replaceInstUsesWith(Cmp, Builder->getTrue());
Sanjay Patel16554142016-08-24 23:03:36 +00002087 if (HiOverflow)
2088 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
2089 ICmpInst::ICMP_ULT, X, LoBound);
2090 if (LoOverflow)
2091 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
2092 ICmpInst::ICMP_UGE, X, HiBound);
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002093 return replaceInstUsesWith(Cmp, InsertRangeTest(X, LoBound, HiBound,
Sanjay Patel16554142016-08-24 23:03:36 +00002094 DivIsSigned, false));
2095 case ICmpInst::ICMP_ULT:
2096 case ICmpInst::ICMP_SLT:
2097 if (LoOverflow == +1) // Low bound is greater than input range.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002098 return replaceInstUsesWith(Cmp, Builder->getTrue());
Sanjay Patel16554142016-08-24 23:03:36 +00002099 if (LoOverflow == -1) // Low bound is less than input range.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002100 return replaceInstUsesWith(Cmp, Builder->getFalse());
Sanjay Patel16554142016-08-24 23:03:36 +00002101 return new ICmpInst(Pred, X, LoBound);
2102 case ICmpInst::ICMP_UGT:
2103 case ICmpInst::ICMP_SGT:
2104 if (HiOverflow == +1) // High bound greater than input range.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002105 return replaceInstUsesWith(Cmp, Builder->getFalse());
Sanjay Patel16554142016-08-24 23:03:36 +00002106 if (HiOverflow == -1) // High bound less than input range.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002107 return replaceInstUsesWith(Cmp, Builder->getTrue());
Sanjay Patel16554142016-08-24 23:03:36 +00002108 if (Pred == ICmpInst::ICMP_UGT)
2109 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
2110 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
2111 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00002112
2113 return nullptr;
2114}
2115
Sanjay Patelb9aa67b2016-08-16 21:26:10 +00002116/// Fold icmp (sub X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00002117Instruction *InstCombiner::foldICmpSubConstant(ICmpInst &Cmp,
2118 BinaryOperator *Sub,
Sanjay Patelb9aa67b2016-08-16 21:26:10 +00002119 const APInt *C) {
Sanjay Patele47df1a2016-08-16 21:53:19 +00002120 const APInt *C2;
2121 if (!match(Sub->getOperand(0), m_APInt(C2)) || !Sub->hasOneUse())
Sanjay Patela3f4f082016-08-16 17:54:36 +00002122 return nullptr;
2123
Sanjay Patelb9aa67b2016-08-16 21:26:10 +00002124 // C-X <u C2 -> (X|(C2-1)) == C
2125 // iff C & (C2-1) == C2-1
Sanjay Patela3f4f082016-08-16 17:54:36 +00002126 // C2 is a power of 2
Sanjay Patele47df1a2016-08-16 21:53:19 +00002127 if (Cmp.getPredicate() == ICmpInst::ICMP_ULT && C->isPowerOf2() &&
2128 (*C2 & (*C - 1)) == (*C - 1))
Sanjay Patela3f4f082016-08-16 17:54:36 +00002129 return new ICmpInst(ICmpInst::ICMP_EQ,
Sanjay Patele47df1a2016-08-16 21:53:19 +00002130 Builder->CreateOr(Sub->getOperand(1), *C - 1),
2131 Sub->getOperand(0));
Sanjay Patela3f4f082016-08-16 17:54:36 +00002132
Sanjay Patelb9aa67b2016-08-16 21:26:10 +00002133 // C-X >u C2 -> (X|C2) != C
2134 // iff C & C2 == C2
Sanjay Patela3f4f082016-08-16 17:54:36 +00002135 // C2+1 is a power of 2
Sanjay Patele47df1a2016-08-16 21:53:19 +00002136 if (Cmp.getPredicate() == ICmpInst::ICMP_UGT && (*C + 1).isPowerOf2() &&
2137 (*C2 & *C) == *C)
Sanjay Patela3f4f082016-08-16 17:54:36 +00002138 return new ICmpInst(ICmpInst::ICMP_NE,
Sanjay Patele47df1a2016-08-16 21:53:19 +00002139 Builder->CreateOr(Sub->getOperand(1), *C),
2140 Sub->getOperand(0));
Sanjay Patela3f4f082016-08-16 17:54:36 +00002141
2142 return nullptr;
2143}
2144
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002145/// Fold icmp (add X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00002146Instruction *InstCombiner::foldICmpAddConstant(ICmpInst &Cmp,
2147 BinaryOperator *Add,
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002148 const APInt *C) {
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002149 Value *Y = Add->getOperand(1);
2150 const APInt *C2;
2151 if (Cmp.isEquality() || !match(Y, m_APInt(C2)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00002152 return nullptr;
2153
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002154 // Fold icmp pred (add X, C2), C.
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002155 Value *X = Add->getOperand(0);
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002156 Type *Ty = Add->getType();
2157 auto CR = Cmp.makeConstantRange(Cmp.getPredicate(), *C).subtract(*C2);
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002158 const APInt &Upper = CR.getUpper();
2159 const APInt &Lower = CR.getLower();
2160 if (Cmp.isSigned()) {
2161 if (Lower.isSignBit())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002162 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, Upper));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002163 if (Upper.isSignBit())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002164 return new ICmpInst(ICmpInst::ICMP_SGE, X, ConstantInt::get(Ty, Lower));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002165 } else {
2166 if (Lower.isMinValue())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002167 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, Upper));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002168 if (Upper.isMinValue())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002169 return new ICmpInst(ICmpInst::ICMP_UGE, X, ConstantInt::get(Ty, Lower));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002170 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00002171
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002172 if (!Add->hasOneUse())
2173 return nullptr;
Sanjay Patela3f4f082016-08-16 17:54:36 +00002174
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002175 // X+C <u C2 -> (X & -C2) == C
2176 // iff C & (C2-1) == 0
2177 // C2 is a power of 2
2178 if (Cmp.getPredicate() == ICmpInst::ICMP_ULT && C->isPowerOf2() &&
2179 (*C2 & (*C - 1)) == 0)
2180 return new ICmpInst(ICmpInst::ICMP_EQ, Builder->CreateAnd(X, -(*C)),
2181 ConstantExpr::getNeg(cast<Constant>(Y)));
2182
2183 // X+C >u C2 -> (X & ~C2) != C
2184 // iff C & C2 == 0
2185 // C2+1 is a power of 2
2186 if (Cmp.getPredicate() == ICmpInst::ICMP_UGT && (*C + 1).isPowerOf2() &&
2187 (*C2 & *C) == 0)
2188 return new ICmpInst(ICmpInst::ICMP_NE, Builder->CreateAnd(X, ~(*C)),
2189 ConstantExpr::getNeg(cast<Constant>(Y)));
2190
Sanjay Patela3f4f082016-08-16 17:54:36 +00002191 return nullptr;
2192}
2193
Sanjay Patel1e5b2d12016-08-16 16:08:11 +00002194/// Try to fold integer comparisons with a constant operand: icmp Pred X, C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00002195Instruction *InstCombiner::foldICmpWithConstant(ICmpInst &Cmp) {
2196 const APInt *C;
2197 if (!match(Cmp.getOperand(1), m_APInt(C)))
Sanjay Patel1e5b2d12016-08-16 16:08:11 +00002198 return nullptr;
2199
Sanjay Patelc9196c42016-08-22 21:24:29 +00002200 BinaryOperator *BO;
2201 if (match(Cmp.getOperand(0), m_BinOp(BO))) {
2202 switch (BO->getOpcode()) {
2203 case Instruction::Xor:
2204 if (Instruction *I = foldICmpXorConstant(Cmp, BO, C))
2205 return I;
2206 break;
2207 case Instruction::And:
2208 if (Instruction *I = foldICmpAndConstant(Cmp, BO, C))
2209 return I;
2210 break;
2211 case Instruction::Or:
2212 if (Instruction *I = foldICmpOrConstant(Cmp, BO, C))
2213 return I;
2214 break;
2215 case Instruction::Mul:
2216 if (Instruction *I = foldICmpMulConstant(Cmp, BO, C))
2217 return I;
2218 break;
2219 case Instruction::Shl:
2220 if (Instruction *I = foldICmpShlConstant(Cmp, BO, C))
2221 return I;
2222 break;
2223 case Instruction::LShr:
2224 case Instruction::AShr:
2225 if (Instruction *I = foldICmpShrConstant(Cmp, BO, C))
2226 return I;
2227 break;
2228 case Instruction::UDiv:
2229 if (Instruction *I = foldICmpUDivConstant(Cmp, BO, C))
2230 return I;
2231 LLVM_FALLTHROUGH;
2232 case Instruction::SDiv:
2233 if (Instruction *I = foldICmpDivConstant(Cmp, BO, C))
2234 return I;
2235 break;
2236 case Instruction::Sub:
2237 if (Instruction *I = foldICmpSubConstant(Cmp, BO, C))
2238 return I;
2239 break;
2240 case Instruction::Add:
2241 if (Instruction *I = foldICmpAddConstant(Cmp, BO, C))
2242 return I;
2243 break;
2244 default:
2245 break;
2246 }
Chris Lattner2188e402010-01-04 07:37:31 +00002247 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002248
Sanjay Patelc9196c42016-08-22 21:24:29 +00002249 Instruction *LHSI;
2250 if (match(Cmp.getOperand(0), m_Instruction(LHSI)) &&
2251 LHSI->getOpcode() == Instruction::Trunc)
2252 if (Instruction *I = foldICmpTruncConstant(Cmp, LHSI, C))
2253 return I;
2254
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002255 return nullptr;
2256}
Jim Grosbach129c52a2011-09-30 18:09:53 +00002257
Sanjay Patelab50a932016-08-02 22:38:33 +00002258/// Simplify icmp_eq and icmp_ne instructions with binary operator LHS and
2259/// integer constant RHS.
2260Instruction *InstCombiner::foldICmpEqualityWithConstant(ICmpInst &ICI) {
Sanjay Patelab50a932016-08-02 22:38:33 +00002261 BinaryOperator *BO;
Sanjay Patel43aeb002016-08-03 18:59:03 +00002262 const APInt *RHSV;
2263 // FIXME: Some of these folds could work with arbitrary constants, but this
2264 // match is limited to scalars and vector splat constants.
Sanjay Patelab50a932016-08-02 22:38:33 +00002265 if (!ICI.isEquality() || !match(ICI.getOperand(0), m_BinOp(BO)) ||
Sanjay Patel43aeb002016-08-03 18:59:03 +00002266 !match(ICI.getOperand(1), m_APInt(RHSV)))
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002267 return nullptr;
2268
Sanjay Patel43aeb002016-08-03 18:59:03 +00002269 Constant *RHS = cast<Constant>(ICI.getOperand(1));
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002270 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Sanjay Patel51a767c2016-08-03 17:23:08 +00002271 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002272
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002273 switch (BO->getOpcode()) {
2274 case Instruction::SRem:
2275 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
Sanjay Patel2e9675f2016-08-03 19:48:40 +00002276 if (*RHSV == 0 && BO->hasOneUse()) {
2277 const APInt *BOC;
2278 if (match(BOp1, m_APInt(BOC)) && BOC->sgt(1) && BOC->isPowerOf2()) {
Sanjay Patel51a767c2016-08-03 17:23:08 +00002279 Value *NewRem = Builder->CreateURem(BOp0, BOp1, BO->getName());
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002280 return new ICmpInst(ICI.getPredicate(), NewRem,
2281 Constant::getNullValue(BO->getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002282 }
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002283 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002284 break;
Sanjay Patel00a324e2016-08-03 22:08:44 +00002285 case Instruction::Add: {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002286 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
Sanjay Patel00a324e2016-08-03 22:08:44 +00002287 const APInt *BOC;
2288 if (match(BOp1, m_APInt(BOC))) {
2289 if (BO->hasOneUse()) {
2290 Constant *SubC = ConstantExpr::getSub(RHS, cast<Constant>(BOp1));
2291 return new ICmpInst(ICI.getPredicate(), BOp0, SubC);
2292 }
Sanjay Patel43aeb002016-08-03 18:59:03 +00002293 } else if (*RHSV == 0) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002294 // Replace ((add A, B) != 0) with (A != -B) if A or B is
2295 // efficiently invertible, or if the add has just this one use.
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002296 if (Value *NegVal = dyn_castNegVal(BOp1))
2297 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
2298 if (Value *NegVal = dyn_castNegVal(BOp0))
2299 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
2300 if (BO->hasOneUse()) {
2301 Value *Neg = Builder->CreateNeg(BOp1);
2302 Neg->takeName(BO);
2303 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
2304 }
2305 }
2306 break;
Sanjay Patel00a324e2016-08-03 22:08:44 +00002307 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002308 case Instruction::Xor:
2309 if (BO->hasOneUse()) {
Sanjay Patel51a767c2016-08-03 17:23:08 +00002310 if (Constant *BOC = dyn_cast<Constant>(BOp1)) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002311 // For the xor case, we can xor two constants together, eliminating
2312 // the explicit xor.
Sanjay Patel51a767c2016-08-03 17:23:08 +00002313 return new ICmpInst(ICI.getPredicate(), BOp0,
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002314 ConstantExpr::getXor(RHS, BOC));
Sanjay Patel43aeb002016-08-03 18:59:03 +00002315 } else if (*RHSV == 0) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002316 // Replace ((xor A, B) != 0) with (A != B)
Sanjay Patel51a767c2016-08-03 17:23:08 +00002317 return new ICmpInst(ICI.getPredicate(), BOp0, BOp1);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002318 }
2319 }
2320 break;
2321 case Instruction::Sub:
2322 if (BO->hasOneUse()) {
Sanjay Patel9d591d12016-08-04 15:19:25 +00002323 const APInt *BOC;
2324 if (match(BOp0, m_APInt(BOC))) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002325 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
Sanjay Patel9d591d12016-08-04 15:19:25 +00002326 Constant *SubC = ConstantExpr::getSub(cast<Constant>(BOp0), RHS);
2327 return new ICmpInst(ICI.getPredicate(), BOp1, SubC);
Sanjay Patel43aeb002016-08-03 18:59:03 +00002328 } else if (*RHSV == 0) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002329 // Replace ((sub A, B) != 0) with (A != B)
Sanjay Patel51a767c2016-08-03 17:23:08 +00002330 return new ICmpInst(ICI.getPredicate(), BOp0, BOp1);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002331 }
2332 }
2333 break;
Sanjay Patelb3de75d2016-08-04 19:12:12 +00002334 case Instruction::Or: {
2335 const APInt *BOC;
2336 if (match(BOp1, m_APInt(BOC)) && BO->hasOneUse() && RHS->isAllOnesValue()) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002337 // Comparing if all bits outside of a constant mask are set?
2338 // Replace (X | C) == -1 with (X & ~C) == ~C.
2339 // This removes the -1 constant.
Sanjay Patelb3de75d2016-08-04 19:12:12 +00002340 Constant *NotBOC = ConstantExpr::getNot(cast<Constant>(BOp1));
2341 Value *And = Builder->CreateAnd(BOp0, NotBOC);
2342 return new ICmpInst(ICI.getPredicate(), And, NotBOC);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002343 }
2344 break;
Sanjay Patelb3de75d2016-08-04 19:12:12 +00002345 }
Sanjay Pateld938e882016-08-04 20:05:02 +00002346 case Instruction::And: {
2347 const APInt *BOC;
2348 if (match(BOp1, m_APInt(BOC))) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002349 // If we have ((X & C) == C), turn it into ((X & C) != 0).
Sanjay Pateld938e882016-08-04 20:05:02 +00002350 if (RHSV == BOC && RHSV->isPowerOf2())
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002351 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE,
Sanjay Patelab50a932016-08-02 22:38:33 +00002352 BO, Constant::getNullValue(RHS->getType()));
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002353
2354 // Don't perform the following transforms if the AND has multiple uses
2355 if (!BO->hasOneUse())
2356 break;
2357
2358 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
Sanjay Pateld938e882016-08-04 20:05:02 +00002359 if (BOC->isSignBit()) {
Sanjay Patel51a767c2016-08-03 17:23:08 +00002360 Constant *Zero = Constant::getNullValue(BOp0->getType());
2361 ICmpInst::Predicate Pred =
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002362 isICMP_NE ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
Sanjay Patel51a767c2016-08-03 17:23:08 +00002363 return new ICmpInst(Pred, BOp0, Zero);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002364 }
2365
2366 // ((X & ~7) == 0) --> X < 8
Sanjay Pateld938e882016-08-04 20:05:02 +00002367 if (*RHSV == 0 && (~(*BOC) + 1).isPowerOf2()) {
2368 Constant *NegBOC = ConstantExpr::getNeg(cast<Constant>(BOp1));
Sanjay Patel51a767c2016-08-03 17:23:08 +00002369 ICmpInst::Predicate Pred =
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002370 isICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
Sanjay Pateld938e882016-08-04 20:05:02 +00002371 return new ICmpInst(Pred, BOp0, NegBOC);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002372 }
2373 }
2374 break;
Sanjay Pateld938e882016-08-04 20:05:02 +00002375 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002376 case Instruction::Mul:
Sanjay Patel43aeb002016-08-03 18:59:03 +00002377 if (*RHSV == 0 && BO->hasNoSignedWrap()) {
Sanjay Patel3bade132016-08-04 22:19:27 +00002378 const APInt *BOC;
2379 if (match(BOp1, m_APInt(BOC)) && *BOC != 0) {
2380 // The trivial case (mul X, 0) is handled by InstSimplify.
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002381 // General case : (mul X, C) != 0 iff X != 0
2382 // (mul X, C) == 0 iff X == 0
Sanjay Patel3bade132016-08-04 22:19:27 +00002383 return new ICmpInst(ICI.getPredicate(), BOp0,
2384 Constant::getNullValue(RHS->getType()));
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002385 }
2386 }
2387 break;
Sanjay Patel6ebd5852016-07-23 00:28:39 +00002388 case Instruction::UDiv:
Sanjay Patel43aeb002016-08-03 18:59:03 +00002389 if (*RHSV == 0) {
Sanjay Patel6ebd5852016-07-23 00:28:39 +00002390 // (icmp eq/ne (udiv A, B), 0) -> (icmp ugt/ule i32 B, A)
2391 ICmpInst::Predicate Pred =
2392 isICMP_NE ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT;
Sanjay Patel51a767c2016-08-03 17:23:08 +00002393 return new ICmpInst(Pred, BOp1, BOp0);
Sanjay Patel6ebd5852016-07-23 00:28:39 +00002394 }
2395 break;
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002396 default:
2397 break;
2398 }
2399 return nullptr;
2400}
2401
Sanjay Patel1271bf92016-07-23 13:06:49 +00002402Instruction *InstCombiner::foldICmpIntrinsicWithConstant(ICmpInst &ICI) {
2403 IntrinsicInst *II = dyn_cast<IntrinsicInst>(ICI.getOperand(0));
2404 const APInt *Op1C;
2405 if (!II || !ICI.isEquality() || !match(ICI.getOperand(1), m_APInt(Op1C)))
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002406 return nullptr;
2407
2408 // Handle icmp {eq|ne} <intrinsic>, intcst.
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002409 switch (II->getIntrinsicID()) {
2410 case Intrinsic::bswap:
2411 Worklist.Add(II);
2412 ICI.setOperand(0, II->getArgOperand(0));
Sanjay Patel1271bf92016-07-23 13:06:49 +00002413 ICI.setOperand(1, Builder->getInt(Op1C->byteSwap()));
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002414 return &ICI;
2415 case Intrinsic::ctlz:
2416 case Intrinsic::cttz:
Amaury Sechet6bea6742016-08-04 05:27:20 +00002417 // ctz(A) == bitwidth(A) -> A == 0 and likewise for !=
Sanjay Patel1271bf92016-07-23 13:06:49 +00002418 if (*Op1C == Op1C->getBitWidth()) {
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002419 Worklist.Add(II);
2420 ICI.setOperand(0, II->getArgOperand(0));
Sanjay Patel1271bf92016-07-23 13:06:49 +00002421 ICI.setOperand(1, ConstantInt::getNullValue(II->getType()));
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002422 return &ICI;
Chris Lattner2188e402010-01-04 07:37:31 +00002423 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002424 break;
Amaury Sechet6bea6742016-08-04 05:27:20 +00002425 case Intrinsic::ctpop: {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002426 // popcount(A) == 0 -> A == 0 and likewise for !=
Amaury Sechet6bea6742016-08-04 05:27:20 +00002427 // popcount(A) == bitwidth(A) -> A == -1 and likewise for !=
2428 bool IsZero = *Op1C == 0;
2429 if (IsZero || *Op1C == Op1C->getBitWidth()) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002430 Worklist.Add(II);
2431 ICI.setOperand(0, II->getArgOperand(0));
Amaury Sechet6bea6742016-08-04 05:27:20 +00002432 auto *NewOp = IsZero
2433 ? ConstantInt::getNullValue(II->getType())
2434 : ConstantInt::getAllOnesValue(II->getType());
2435 ICI.setOperand(1, NewOp);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002436 return &ICI;
2437 }
Amaury Sechet6bea6742016-08-04 05:27:20 +00002438 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002439 break;
2440 default:
2441 break;
Chris Lattner2188e402010-01-04 07:37:31 +00002442 }
Craig Topperf40110f2014-04-25 05:29:35 +00002443 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002444}
2445
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002446/// Handle icmp (cast x to y), (cast/cst). We only handle extending casts so
2447/// far.
Sanjay Patel43395062016-07-21 18:07:40 +00002448Instruction *InstCombiner::foldICmpWithCastAndCast(ICmpInst &ICmp) {
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002449 const CastInst *LHSCI = cast<CastInst>(ICmp.getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00002450 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00002451 Type *SrcTy = LHSCIOp->getType();
2452 Type *DestTy = LHSCI->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00002453 Value *RHSCIOp;
2454
Jim Grosbach129c52a2011-09-30 18:09:53 +00002455 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner2188e402010-01-04 07:37:31 +00002456 // integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002457 if (LHSCI->getOpcode() == Instruction::PtrToInt &&
2458 DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
Craig Topperf40110f2014-04-25 05:29:35 +00002459 Value *RHSOp = nullptr;
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002460 if (auto *RHSC = dyn_cast<PtrToIntOperator>(ICmp.getOperand(1))) {
Michael Liaod266b922015-02-13 04:51:26 +00002461 Value *RHSCIOp = RHSC->getOperand(0);
2462 if (RHSCIOp->getType()->getPointerAddressSpace() ==
2463 LHSCIOp->getType()->getPointerAddressSpace()) {
2464 RHSOp = RHSC->getOperand(0);
2465 // If the pointer types don't match, insert a bitcast.
2466 if (LHSCIOp->getType() != RHSOp->getType())
2467 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
2468 }
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002469 } else if (auto *RHSC = dyn_cast<Constant>(ICmp.getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002470 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002471 }
Chris Lattner2188e402010-01-04 07:37:31 +00002472
2473 if (RHSOp)
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002474 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, RHSOp);
Chris Lattner2188e402010-01-04 07:37:31 +00002475 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002476
Chris Lattner2188e402010-01-04 07:37:31 +00002477 // The code below only handles extension cast instructions, so far.
2478 // Enforce this.
2479 if (LHSCI->getOpcode() != Instruction::ZExt &&
2480 LHSCI->getOpcode() != Instruction::SExt)
Craig Topperf40110f2014-04-25 05:29:35 +00002481 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002482
2483 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002484 bool isSignedCmp = ICmp.isSigned();
Chris Lattner2188e402010-01-04 07:37:31 +00002485
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002486 if (auto *CI = dyn_cast<CastInst>(ICmp.getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002487 // Not an extension from the same type?
2488 RHSCIOp = CI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002489 if (RHSCIOp->getType() != LHSCIOp->getType())
Craig Topperf40110f2014-04-25 05:29:35 +00002490 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002491
Chris Lattner2188e402010-01-04 07:37:31 +00002492 // If the signedness of the two casts doesn't agree (i.e. one is a sext
2493 // and the other is a zext), then we can't handle this.
2494 if (CI->getOpcode() != LHSCI->getOpcode())
Craig Topperf40110f2014-04-25 05:29:35 +00002495 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002496
2497 // Deal with equality cases early.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002498 if (ICmp.isEquality())
2499 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, RHSCIOp);
Chris Lattner2188e402010-01-04 07:37:31 +00002500
2501 // A signed comparison of sign extended values simplifies into a
2502 // signed comparison.
2503 if (isSignedCmp && isSignedExt)
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002504 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, RHSCIOp);
Chris Lattner2188e402010-01-04 07:37:31 +00002505
2506 // The other three cases all fold into an unsigned comparison.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002507 return new ICmpInst(ICmp.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
Chris Lattner2188e402010-01-04 07:37:31 +00002508 }
2509
Sanjay Patel4c204232016-06-04 20:39:22 +00002510 // If we aren't dealing with a constant on the RHS, exit early.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002511 auto *C = dyn_cast<Constant>(ICmp.getOperand(1));
2512 if (!C)
Craig Topperf40110f2014-04-25 05:29:35 +00002513 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002514
2515 // Compute the constant that would happen if we truncated to SrcTy then
Sanjay Patelc774f8c2016-06-04 21:20:44 +00002516 // re-extended to DestTy.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002517 Constant *Res1 = ConstantExpr::getTrunc(C, SrcTy);
Sanjay Patelc774f8c2016-06-04 21:20:44 +00002518 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(), Res1, DestTy);
Chris Lattner2188e402010-01-04 07:37:31 +00002519
2520 // If the re-extended constant didn't change...
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002521 if (Res2 == C) {
Chris Lattner2188e402010-01-04 07:37:31 +00002522 // Deal with equality cases early.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002523 if (ICmp.isEquality())
2524 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, Res1);
Chris Lattner2188e402010-01-04 07:37:31 +00002525
2526 // A signed comparison of sign extended values simplifies into a
2527 // signed comparison.
2528 if (isSignedExt && isSignedCmp)
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002529 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, Res1);
Chris Lattner2188e402010-01-04 07:37:31 +00002530
2531 // The other three cases all fold into an unsigned comparison.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002532 return new ICmpInst(ICmp.getUnsignedPredicate(), LHSCIOp, Res1);
Chris Lattner2188e402010-01-04 07:37:31 +00002533 }
2534
Sanjay Patel6a333c32016-06-06 16:56:57 +00002535 // The re-extended constant changed, partly changed (in the case of a vector),
2536 // or could not be determined to be equal (in the case of a constant
2537 // expression), so the constant cannot be represented in the shorter type.
2538 // Consequently, we cannot emit a simple comparison.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002539 // All the cases that fold to true or false will have already been handled
2540 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner2188e402010-01-04 07:37:31 +00002541
Sanjay Patel6a333c32016-06-06 16:56:57 +00002542 if (isSignedCmp || !isSignedExt || !isa<ConstantInt>(C))
Craig Topperf40110f2014-04-25 05:29:35 +00002543 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002544
2545 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
2546 // should have been folded away previously and not enter in here.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002547
2548 // We're performing an unsigned comp with a sign extended value.
2549 // This is true if the input is >= 0. [aka >s -1]
2550 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002551 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICmp.getName());
Chris Lattner2188e402010-01-04 07:37:31 +00002552
2553 // Finally, return the value computed.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002554 if (ICmp.getPredicate() == ICmpInst::ICMP_ULT)
2555 return replaceInstUsesWith(ICmp, Result);
Chris Lattner2188e402010-01-04 07:37:31 +00002556
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00002557 assert(ICmp.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner2188e402010-01-04 07:37:31 +00002558 return BinaryOperator::CreateNot(Result);
2559}
2560
Sanjay Patel5f0217f2016-06-05 16:46:18 +00002561/// The caller has matched a pattern of the form:
Chris Lattneree61c1d2010-12-19 17:52:50 +00002562/// I = icmp ugt (add (add A, B), CI2), CI1
Chris Lattnerc56c8452010-12-19 18:22:06 +00002563/// If this is of the form:
2564/// sum = a + b
2565/// if (sum+128 >u 255)
2566/// Then replace it with llvm.sadd.with.overflow.i8.
2567///
Chris Lattneree61c1d2010-12-19 17:52:50 +00002568static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2569 ConstantInt *CI2, ConstantInt *CI1,
Chris Lattnerce2995a2010-12-19 18:38:44 +00002570 InstCombiner &IC) {
Chris Lattnerf29562d2010-12-19 17:59:02 +00002571 // The transformation we're trying to do here is to transform this into an
2572 // llvm.sadd.with.overflow. To do this, we have to replace the original add
2573 // with a narrower add, and discard the add-with-constant that is part of the
2574 // range check (if we can't eliminate it, this isn't profitable).
Jim Grosbach129c52a2011-09-30 18:09:53 +00002575
Chris Lattnerf29562d2010-12-19 17:59:02 +00002576 // In order to eliminate the add-with-constant, the compare can be its only
2577 // use.
Chris Lattnerc56c8452010-12-19 18:22:06 +00002578 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
Craig Topperf40110f2014-04-25 05:29:35 +00002579 if (!AddWithCst->hasOneUse()) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002580
Chris Lattnerc56c8452010-12-19 18:22:06 +00002581 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
Craig Topperf40110f2014-04-25 05:29:35 +00002582 if (!CI2->getValue().isPowerOf2()) return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002583 unsigned NewWidth = CI2->getValue().countTrailingZeros();
Craig Topperf40110f2014-04-25 05:29:35 +00002584 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002585
Chris Lattnerc56c8452010-12-19 18:22:06 +00002586 // The width of the new add formed is 1 more than the bias.
2587 ++NewWidth;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002588
Chris Lattnerc56c8452010-12-19 18:22:06 +00002589 // Check to see that CI1 is an all-ones value with NewWidth bits.
2590 if (CI1->getBitWidth() == NewWidth ||
2591 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
Craig Topperf40110f2014-04-25 05:29:35 +00002592 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002593
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002594 // This is only really a signed overflow check if the inputs have been
2595 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2596 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2597 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
Hal Finkel60db0582014-09-07 18:57:58 +00002598 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
2599 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
Craig Topperf40110f2014-04-25 05:29:35 +00002600 return nullptr;
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002601
Jim Grosbach129c52a2011-09-30 18:09:53 +00002602 // In order to replace the original add with a narrower
Chris Lattnerc56c8452010-12-19 18:22:06 +00002603 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2604 // and truncates that discard the high bits of the add. Verify that this is
2605 // the case.
2606 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
Chandler Carruthcdf47882014-03-09 03:16:01 +00002607 for (User *U : OrigAdd->users()) {
2608 if (U == AddWithCst) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002609
Chris Lattnerc56c8452010-12-19 18:22:06 +00002610 // Only accept truncates for now. We would really like a nice recursive
2611 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2612 // chain to see which bits of a value are actually demanded. If the
2613 // original add had another add which was then immediately truncated, we
2614 // could still do the transformation.
Chandler Carruthcdf47882014-03-09 03:16:01 +00002615 TruncInst *TI = dyn_cast<TruncInst>(U);
Craig Topperf40110f2014-04-25 05:29:35 +00002616 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2617 return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002618 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002619
Chris Lattneree61c1d2010-12-19 17:52:50 +00002620 // If the pattern matches, truncate the inputs to the narrower type and
2621 // use the sadd_with_overflow intrinsic to efficiently compute both the
2622 // result and the overflow bit.
Jay Foadb804a2b2011-07-12 14:06:48 +00002623 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
Sanjay Patelaf674fb2015-12-14 17:24:23 +00002624 Value *F = Intrinsic::getDeclaration(I.getModule(),
2625 Intrinsic::sadd_with_overflow, NewType);
Chris Lattner79874562010-12-19 18:35:09 +00002626
Chris Lattnerce2995a2010-12-19 18:38:44 +00002627 InstCombiner::BuilderTy *Builder = IC.Builder;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002628
Chris Lattner79874562010-12-19 18:35:09 +00002629 // Put the new code above the original add, in case there are any uses of the
2630 // add between the add and the compare.
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002631 Builder->SetInsertPoint(OrigAdd);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002632
Chris Lattner79874562010-12-19 18:35:09 +00002633 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2634 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
David Blaikieff6409d2015-05-18 22:13:54 +00002635 CallInst *Call = Builder->CreateCall(F, {TruncA, TruncB}, "sadd");
Chris Lattner79874562010-12-19 18:35:09 +00002636 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2637 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002638
Chris Lattneree61c1d2010-12-19 17:52:50 +00002639 // The inner add was the result of the narrow add, zero extended to the
2640 // wider type. Replace it with the result computed by the intrinsic.
Sanjay Patel4b198802016-02-01 22:23:39 +00002641 IC.replaceInstUsesWith(*OrigAdd, ZExt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002642
Chris Lattner79874562010-12-19 18:35:09 +00002643 // The original icmp gets replaced with the overflow value.
2644 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
Chris Lattneree61c1d2010-12-19 17:52:50 +00002645}
Chris Lattner2188e402010-01-04 07:37:31 +00002646
Sanjoy Dasb0984472015-04-08 04:27:22 +00002647bool InstCombiner::OptimizeOverflowCheck(OverflowCheckFlavor OCF, Value *LHS,
2648 Value *RHS, Instruction &OrigI,
2649 Value *&Result, Constant *&Overflow) {
Sanjoy Das827529e2015-08-11 21:33:55 +00002650 if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
2651 std::swap(LHS, RHS);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002652
2653 auto SetResult = [&](Value *OpResult, Constant *OverflowVal, bool ReuseName) {
2654 Result = OpResult;
2655 Overflow = OverflowVal;
2656 if (ReuseName)
2657 Result->takeName(&OrigI);
2658 return true;
2659 };
2660
Sanjoy Das6f5dca72015-08-28 19:09:31 +00002661 // If the overflow check was an add followed by a compare, the insertion point
2662 // may be pointing to the compare. We want to insert the new instructions
2663 // before the add in case there are uses of the add between the add and the
2664 // compare.
2665 Builder->SetInsertPoint(&OrigI);
2666
Sanjoy Dasb0984472015-04-08 04:27:22 +00002667 switch (OCF) {
2668 case OCF_INVALID:
2669 llvm_unreachable("bad overflow check kind!");
2670
2671 case OCF_UNSIGNED_ADD: {
2672 OverflowResult OR = computeOverflowForUnsignedAdd(LHS, RHS, &OrigI);
2673 if (OR == OverflowResult::NeverOverflows)
2674 return SetResult(Builder->CreateNUWAdd(LHS, RHS), Builder->getFalse(),
2675 true);
2676
2677 if (OR == OverflowResult::AlwaysOverflows)
2678 return SetResult(Builder->CreateAdd(LHS, RHS), Builder->getTrue(), true);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002679
2680 // Fall through uadd into sadd
2681 LLVM_FALLTHROUGH;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002682 }
Sanjoy Dasb0984472015-04-08 04:27:22 +00002683 case OCF_SIGNED_ADD: {
David Majnemer27e89ba2015-05-21 23:04:21 +00002684 // X + 0 -> {X, false}
2685 if (match(RHS, m_Zero()))
2686 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002687
2688 // We can strength reduce this signed add into a regular add if we can prove
2689 // that it will never overflow.
2690 if (OCF == OCF_SIGNED_ADD)
2691 if (WillNotOverflowSignedAdd(LHS, RHS, OrigI))
2692 return SetResult(Builder->CreateNSWAdd(LHS, RHS), Builder->getFalse(),
2693 true);
Sanjoy Das72cb5e12015-06-05 18:04:42 +00002694 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002695 }
2696
2697 case OCF_UNSIGNED_SUB:
2698 case OCF_SIGNED_SUB: {
David Majnemer27e89ba2015-05-21 23:04:21 +00002699 // X - 0 -> {X, false}
2700 if (match(RHS, m_Zero()))
2701 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002702
2703 if (OCF == OCF_SIGNED_SUB) {
2704 if (WillNotOverflowSignedSub(LHS, RHS, OrigI))
2705 return SetResult(Builder->CreateNSWSub(LHS, RHS), Builder->getFalse(),
2706 true);
2707 } else {
2708 if (WillNotOverflowUnsignedSub(LHS, RHS, OrigI))
2709 return SetResult(Builder->CreateNUWSub(LHS, RHS), Builder->getFalse(),
2710 true);
2711 }
2712 break;
2713 }
2714
2715 case OCF_UNSIGNED_MUL: {
2716 OverflowResult OR = computeOverflowForUnsignedMul(LHS, RHS, &OrigI);
2717 if (OR == OverflowResult::NeverOverflows)
2718 return SetResult(Builder->CreateNUWMul(LHS, RHS), Builder->getFalse(),
2719 true);
2720 if (OR == OverflowResult::AlwaysOverflows)
2721 return SetResult(Builder->CreateMul(LHS, RHS), Builder->getTrue(), true);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002722 LLVM_FALLTHROUGH;
2723 }
Sanjoy Dasb0984472015-04-08 04:27:22 +00002724 case OCF_SIGNED_MUL:
2725 // X * undef -> undef
2726 if (isa<UndefValue>(RHS))
David Majnemer27e89ba2015-05-21 23:04:21 +00002727 return SetResult(RHS, UndefValue::get(Builder->getInt1Ty()), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002728
David Majnemer27e89ba2015-05-21 23:04:21 +00002729 // X * 0 -> {0, false}
2730 if (match(RHS, m_Zero()))
2731 return SetResult(RHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002732
David Majnemer27e89ba2015-05-21 23:04:21 +00002733 // X * 1 -> {X, false}
2734 if (match(RHS, m_One()))
2735 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002736
2737 if (OCF == OCF_SIGNED_MUL)
2738 if (WillNotOverflowSignedMul(LHS, RHS, OrigI))
2739 return SetResult(Builder->CreateNSWMul(LHS, RHS), Builder->getFalse(),
2740 true);
Sanjoy Dasc80dad62015-06-05 18:04:46 +00002741 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002742 }
2743
2744 return false;
2745}
2746
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002747/// \brief Recognize and process idiom involving test for multiplication
2748/// overflow.
2749///
2750/// The caller has matched a pattern of the form:
2751/// I = cmp u (mul(zext A, zext B), V
2752/// The function checks if this is a test for overflow and if so replaces
2753/// multiplication with call to 'mul.with.overflow' intrinsic.
2754///
2755/// \param I Compare instruction.
2756/// \param MulVal Result of 'mult' instruction. It is one of the arguments of
2757/// the compare instruction. Must be of integer type.
2758/// \param OtherVal The other argument of compare instruction.
2759/// \returns Instruction which must replace the compare instruction, NULL if no
2760/// replacement required.
2761static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2762 Value *OtherVal, InstCombiner &IC) {
Benjamin Kramerc96a7f82014-06-24 10:47:52 +00002763 // Don't bother doing this transformation for pointers, don't do it for
2764 // vectors.
2765 if (!isa<IntegerType>(MulVal->getType()))
2766 return nullptr;
2767
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002768 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2769 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
David Majnemerdaa24b92015-09-05 20:44:56 +00002770 auto *MulInstr = dyn_cast<Instruction>(MulVal);
2771 if (!MulInstr)
2772 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002773 assert(MulInstr->getOpcode() == Instruction::Mul);
2774
David Majnemer634ca232014-11-01 23:46:05 +00002775 auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
2776 *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002777 assert(LHS->getOpcode() == Instruction::ZExt);
2778 assert(RHS->getOpcode() == Instruction::ZExt);
2779 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2780
2781 // Calculate type and width of the result produced by mul.with.overflow.
2782 Type *TyA = A->getType(), *TyB = B->getType();
2783 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2784 WidthB = TyB->getPrimitiveSizeInBits();
2785 unsigned MulWidth;
2786 Type *MulType;
2787 if (WidthB > WidthA) {
2788 MulWidth = WidthB;
2789 MulType = TyB;
2790 } else {
2791 MulWidth = WidthA;
2792 MulType = TyA;
2793 }
2794
2795 // In order to replace the original mul with a narrower mul.with.overflow,
2796 // all uses must ignore upper bits of the product. The number of used low
2797 // bits must be not greater than the width of mul.with.overflow.
2798 if (MulVal->hasNUsesOrMore(2))
2799 for (User *U : MulVal->users()) {
2800 if (U == &I)
2801 continue;
2802 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2803 // Check if truncation ignores bits above MulWidth.
2804 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2805 if (TruncWidth > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002806 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002807 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2808 // Check if AND ignores bits above MulWidth.
2809 if (BO->getOpcode() != Instruction::And)
Craig Topperf40110f2014-04-25 05:29:35 +00002810 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002811 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2812 const APInt &CVal = CI->getValue();
2813 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002814 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002815 }
2816 } else {
2817 // Other uses prohibit this transformation.
Craig Topperf40110f2014-04-25 05:29:35 +00002818 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002819 }
2820 }
2821
2822 // Recognize patterns
2823 switch (I.getPredicate()) {
2824 case ICmpInst::ICMP_EQ:
2825 case ICmpInst::ICMP_NE:
2826 // Recognize pattern:
2827 // mulval = mul(zext A, zext B)
2828 // cmp eq/neq mulval, zext trunc mulval
2829 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2830 if (Zext->hasOneUse()) {
2831 Value *ZextArg = Zext->getOperand(0);
2832 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2833 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2834 break; //Recognized
2835 }
2836
2837 // Recognize pattern:
2838 // mulval = mul(zext A, zext B)
2839 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2840 ConstantInt *CI;
2841 Value *ValToMask;
2842 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2843 if (ValToMask != MulVal)
Craig Topperf40110f2014-04-25 05:29:35 +00002844 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002845 const APInt &CVal = CI->getValue() + 1;
2846 if (CVal.isPowerOf2()) {
2847 unsigned MaskWidth = CVal.logBase2();
2848 if (MaskWidth == MulWidth)
2849 break; // Recognized
2850 }
2851 }
Craig Topperf40110f2014-04-25 05:29:35 +00002852 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002853
2854 case ICmpInst::ICMP_UGT:
2855 // Recognize pattern:
2856 // mulval = mul(zext A, zext B)
2857 // cmp ugt mulval, max
2858 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2859 APInt MaxVal = APInt::getMaxValue(MulWidth);
2860 MaxVal = MaxVal.zext(CI->getBitWidth());
2861 if (MaxVal.eq(CI->getValue()))
2862 break; // Recognized
2863 }
Craig Topperf40110f2014-04-25 05:29:35 +00002864 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002865
2866 case ICmpInst::ICMP_UGE:
2867 // Recognize pattern:
2868 // mulval = mul(zext A, zext B)
2869 // cmp uge mulval, max+1
2870 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2871 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2872 if (MaxVal.eq(CI->getValue()))
2873 break; // Recognized
2874 }
Craig Topperf40110f2014-04-25 05:29:35 +00002875 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002876
2877 case ICmpInst::ICMP_ULE:
2878 // Recognize pattern:
2879 // mulval = mul(zext A, zext B)
2880 // cmp ule mulval, max
2881 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2882 APInt MaxVal = APInt::getMaxValue(MulWidth);
2883 MaxVal = MaxVal.zext(CI->getBitWidth());
2884 if (MaxVal.eq(CI->getValue()))
2885 break; // Recognized
2886 }
Craig Topperf40110f2014-04-25 05:29:35 +00002887 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002888
2889 case ICmpInst::ICMP_ULT:
2890 // Recognize pattern:
2891 // mulval = mul(zext A, zext B)
2892 // cmp ule mulval, max + 1
2893 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002894 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002895 if (MaxVal.eq(CI->getValue()))
2896 break; // Recognized
2897 }
Craig Topperf40110f2014-04-25 05:29:35 +00002898 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002899
2900 default:
Craig Topperf40110f2014-04-25 05:29:35 +00002901 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002902 }
2903
2904 InstCombiner::BuilderTy *Builder = IC.Builder;
2905 Builder->SetInsertPoint(MulInstr);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002906
2907 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2908 Value *MulA = A, *MulB = B;
2909 if (WidthA < MulWidth)
2910 MulA = Builder->CreateZExt(A, MulType);
2911 if (WidthB < MulWidth)
2912 MulB = Builder->CreateZExt(B, MulType);
Sanjay Patelaf674fb2015-12-14 17:24:23 +00002913 Value *F = Intrinsic::getDeclaration(I.getModule(),
2914 Intrinsic::umul_with_overflow, MulType);
David Blaikieff6409d2015-05-18 22:13:54 +00002915 CallInst *Call = Builder->CreateCall(F, {MulA, MulB}, "umul");
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002916 IC.Worklist.Add(MulInstr);
2917
2918 // If there are uses of mul result other than the comparison, we know that
2919 // they are truncation or binary AND. Change them to use result of
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002920 // mul.with.overflow and adjust properly mask/size.
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002921 if (MulVal->hasNUsesOrMore(2)) {
2922 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2923 for (User *U : MulVal->users()) {
2924 if (U == &I || U == OtherVal)
2925 continue;
2926 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2927 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
Sanjay Patel4b198802016-02-01 22:23:39 +00002928 IC.replaceInstUsesWith(*TI, Mul);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002929 else
2930 TI->setOperand(0, Mul);
2931 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2932 assert(BO->getOpcode() == Instruction::And);
2933 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2934 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2935 APInt ShortMask = CI->getValue().trunc(MulWidth);
2936 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2937 Instruction *Zext =
2938 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2939 IC.Worklist.Add(Zext);
Sanjay Patel4b198802016-02-01 22:23:39 +00002940 IC.replaceInstUsesWith(*BO, Zext);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002941 } else {
2942 llvm_unreachable("Unexpected Binary operation");
2943 }
2944 IC.Worklist.Add(cast<Instruction>(U));
2945 }
2946 }
2947 if (isa<Instruction>(OtherVal))
2948 IC.Worklist.Add(cast<Instruction>(OtherVal));
2949
2950 // The original icmp gets replaced with the overflow value, maybe inverted
2951 // depending on predicate.
2952 bool Inverse = false;
2953 switch (I.getPredicate()) {
2954 case ICmpInst::ICMP_NE:
2955 break;
2956 case ICmpInst::ICMP_EQ:
2957 Inverse = true;
2958 break;
2959 case ICmpInst::ICMP_UGT:
2960 case ICmpInst::ICMP_UGE:
2961 if (I.getOperand(0) == MulVal)
2962 break;
2963 Inverse = true;
2964 break;
2965 case ICmpInst::ICMP_ULT:
2966 case ICmpInst::ICMP_ULE:
2967 if (I.getOperand(1) == MulVal)
2968 break;
2969 Inverse = true;
2970 break;
2971 default:
2972 llvm_unreachable("Unexpected predicate");
2973 }
2974 if (Inverse) {
2975 Value *Res = Builder->CreateExtractValue(Call, 1);
2976 return BinaryOperator::CreateNot(Res);
2977 }
2978
2979 return ExtractValueInst::Create(Call, 1);
2980}
2981
Sanjay Patel5f0217f2016-06-05 16:46:18 +00002982/// When performing a comparison against a constant, it is possible that not all
2983/// the bits in the LHS are demanded. This helper method computes the mask that
2984/// IS demanded.
Owen Andersond490c2d2011-01-11 00:36:45 +00002985static APInt DemandedBitsLHSMask(ICmpInst &I,
2986 unsigned BitWidth, bool isSignCheck) {
2987 if (isSignCheck)
2988 return APInt::getSignBit(BitWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002989
Owen Andersond490c2d2011-01-11 00:36:45 +00002990 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2991 if (!CI) return APInt::getAllOnesValue(BitWidth);
Owen Anderson0022a4b2011-01-11 18:26:37 +00002992 const APInt &RHS = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002993
Owen Andersond490c2d2011-01-11 00:36:45 +00002994 switch (I.getPredicate()) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002995 // For a UGT comparison, we don't care about any bits that
Owen Andersond490c2d2011-01-11 00:36:45 +00002996 // correspond to the trailing ones of the comparand. The value of these
2997 // bits doesn't impact the outcome of the comparison, because any value
2998 // greater than the RHS must differ in a bit higher than these due to carry.
2999 case ICmpInst::ICMP_UGT: {
3000 unsigned trailingOnes = RHS.countTrailingOnes();
3001 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
3002 return ~lowBitsSet;
3003 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003004
Owen Andersond490c2d2011-01-11 00:36:45 +00003005 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
3006 // Any value less than the RHS must differ in a higher bit because of carries.
3007 case ICmpInst::ICMP_ULT: {
3008 unsigned trailingZeros = RHS.countTrailingZeros();
3009 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
3010 return ~lowBitsSet;
3011 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003012
Owen Andersond490c2d2011-01-11 00:36:45 +00003013 default:
3014 return APInt::getAllOnesValue(BitWidth);
3015 }
Owen Andersond490c2d2011-01-11 00:36:45 +00003016}
Chris Lattner2188e402010-01-04 07:37:31 +00003017
Quentin Colombet5ab55552013-09-09 20:56:48 +00003018/// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
3019/// should be swapped.
Alp Tokercb402912014-01-24 17:20:08 +00003020/// The decision is based on how many times these two operands are reused
Quentin Colombet5ab55552013-09-09 20:56:48 +00003021/// as subtract operands and their positions in those instructions.
3022/// The rational is that several architectures use the same instruction for
3023/// both subtract and cmp, thus it is better if the order of those operands
3024/// match.
3025/// \return true if Op0 and Op1 should be swapped.
3026static bool swapMayExposeCSEOpportunities(const Value * Op0,
3027 const Value * Op1) {
3028 // Filter out pointer value as those cannot appears directly in subtract.
3029 // FIXME: we may want to go through inttoptrs or bitcasts.
3030 if (Op0->getType()->isPointerTy())
3031 return false;
3032 // Count every uses of both Op0 and Op1 in a subtract.
3033 // Each time Op0 is the first operand, count -1: swapping is bad, the
3034 // subtract has already the same layout as the compare.
3035 // Each time Op0 is the second operand, count +1: swapping is good, the
Alp Tokercb402912014-01-24 17:20:08 +00003036 // subtract has a different layout as the compare.
Quentin Colombet5ab55552013-09-09 20:56:48 +00003037 // At the end, if the benefit is greater than 0, Op0 should come second to
3038 // expose more CSE opportunities.
3039 int GlobalSwapBenefits = 0;
Chandler Carruthcdf47882014-03-09 03:16:01 +00003040 for (const User *U : Op0->users()) {
3041 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
Quentin Colombet5ab55552013-09-09 20:56:48 +00003042 if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
3043 continue;
3044 // If Op0 is the first argument, this is not beneficial to swap the
3045 // arguments.
3046 int LocalSwapBenefits = -1;
3047 unsigned Op1Idx = 1;
3048 if (BinOp->getOperand(Op1Idx) == Op0) {
3049 Op1Idx = 0;
3050 LocalSwapBenefits = 1;
3051 }
3052 if (BinOp->getOperand(Op1Idx) != Op1)
3053 continue;
3054 GlobalSwapBenefits += LocalSwapBenefits;
3055 }
3056 return GlobalSwapBenefits > 0;
3057}
3058
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003059/// \brief Check that one use is in the same block as the definition and all
3060/// other uses are in blocks dominated by a given block
3061///
3062/// \param DI Definition
3063/// \param UI Use
3064/// \param DB Block that must dominate all uses of \p DI outside
3065/// the parent block
3066/// \return true when \p UI is the only use of \p DI in the parent block
3067/// and all other uses of \p DI are in blocks dominated by \p DB.
3068///
3069bool InstCombiner::dominatesAllUses(const Instruction *DI,
3070 const Instruction *UI,
3071 const BasicBlock *DB) const {
3072 assert(DI && UI && "Instruction not defined\n");
3073 // ignore incomplete definitions
3074 if (!DI->getParent())
3075 return false;
3076 // DI and UI must be in the same block
3077 if (DI->getParent() != UI->getParent())
3078 return false;
3079 // Protect from self-referencing blocks
3080 if (DI->getParent() == DB)
3081 return false;
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003082 for (const User *U : DI->users()) {
3083 auto *Usr = cast<Instruction>(U);
Justin Bogner99798402016-08-05 01:06:44 +00003084 if (Usr != UI && !DT.dominates(DB, Usr->getParent()))
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003085 return false;
3086 }
3087 return true;
3088}
3089
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003090/// Return true when the instruction sequence within a block is select-cmp-br.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003091static bool isChainSelectCmpBranch(const SelectInst *SI) {
3092 const BasicBlock *BB = SI->getParent();
3093 if (!BB)
3094 return false;
3095 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
3096 if (!BI || BI->getNumSuccessors() != 2)
3097 return false;
3098 auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
3099 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
3100 return false;
3101 return true;
3102}
3103
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003104/// \brief True when a select result is replaced by one of its operands
3105/// in select-icmp sequence. This will eventually result in the elimination
3106/// of the select.
3107///
3108/// \param SI Select instruction
3109/// \param Icmp Compare instruction
3110/// \param SIOpd Operand that replaces the select
3111///
3112/// Notes:
3113/// - The replacement is global and requires dominator information
3114/// - The caller is responsible for the actual replacement
3115///
3116/// Example:
3117///
3118/// entry:
3119/// %4 = select i1 %3, %C* %0, %C* null
3120/// %5 = icmp eq %C* %4, null
3121/// br i1 %5, label %9, label %7
3122/// ...
3123/// ; <label>:7 ; preds = %entry
3124/// %8 = getelementptr inbounds %C* %4, i64 0, i32 0
3125/// ...
3126///
3127/// can be transformed to
3128///
3129/// %5 = icmp eq %C* %0, null
3130/// %6 = select i1 %3, i1 %5, i1 true
3131/// br i1 %6, label %9, label %7
3132/// ...
3133/// ; <label>:7 ; preds = %entry
3134/// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0!
3135///
3136/// Similar when the first operand of the select is a constant or/and
3137/// the compare is for not equal rather than equal.
3138///
3139/// NOTE: The function is only called when the select and compare constants
3140/// are equal, the optimization can work only for EQ predicates. This is not a
3141/// major restriction since a NE compare should be 'normalized' to an equal
3142/// compare, which usually happens in the combiner and test case
3143/// select-cmp-br.ll
3144/// checks for it.
3145bool InstCombiner::replacedSelectWithOperand(SelectInst *SI,
3146 const ICmpInst *Icmp,
3147 const unsigned SIOpd) {
David Majnemer83484fd2014-11-22 06:09:28 +00003148 assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003149 if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
3150 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
3151 // The check for the unique predecessor is not the best that can be
3152 // done. But it protects efficiently against cases like when SI's
3153 // home block has two successors, Succ and Succ1, and Succ1 predecessor
3154 // of Succ. Then SI can't be replaced by SIOpd because the use that gets
3155 // replaced can be reached on either path. So the uniqueness check
3156 // guarantees that the path all uses of SI (outside SI's parent) are on
3157 // is disjoint from all other paths out of SI. But that information
3158 // is more expensive to compute, and the trade-off here is in favor
3159 // of compile-time.
3160 if (Succ->getUniquePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
3161 NumSel++;
3162 SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
3163 return true;
3164 }
3165 }
3166 return false;
3167}
3168
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003169/// If we have an icmp le or icmp ge instruction with a constant operand, turn
3170/// it into the appropriate icmp lt or icmp gt instruction. This transform
3171/// allows them to be folded in visitICmpInst.
Sanjay Patele9b2c322016-05-17 00:57:57 +00003172static ICmpInst *canonicalizeCmpWithConstant(ICmpInst &I) {
3173 ICmpInst::Predicate Pred = I.getPredicate();
3174 if (Pred != ICmpInst::ICMP_SLE && Pred != ICmpInst::ICMP_SGE &&
3175 Pred != ICmpInst::ICMP_ULE && Pred != ICmpInst::ICMP_UGE)
3176 return nullptr;
3177
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003178 Value *Op0 = I.getOperand(0);
3179 Value *Op1 = I.getOperand(1);
Sanjay Patele9b2c322016-05-17 00:57:57 +00003180 auto *Op1C = dyn_cast<Constant>(Op1);
3181 if (!Op1C)
3182 return nullptr;
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003183
Sanjay Patele9b2c322016-05-17 00:57:57 +00003184 // Check if the constant operand can be safely incremented/decremented without
3185 // overflowing/underflowing. For scalars, SimplifyICmpInst has already handled
3186 // the edge cases for us, so we just assert on them. For vectors, we must
3187 // handle the edge cases.
3188 Type *Op1Type = Op1->getType();
3189 bool IsSigned = I.isSigned();
3190 bool IsLE = (Pred == ICmpInst::ICMP_SLE || Pred == ICmpInst::ICMP_ULE);
Sanjay Patel18254932016-05-17 01:12:31 +00003191 auto *CI = dyn_cast<ConstantInt>(Op1C);
3192 if (CI) {
Sanjay Patele9b2c322016-05-17 00:57:57 +00003193 // A <= MAX -> TRUE ; A >= MIN -> TRUE
3194 assert(IsLE ? !CI->isMaxValue(IsSigned) : !CI->isMinValue(IsSigned));
3195 } else if (Op1Type->isVectorTy()) {
Sanjay Patelb79ab272016-05-13 15:10:46 +00003196 // TODO? If the edge cases for vectors were guaranteed to be handled as they
Sanjay Patele9b2c322016-05-17 00:57:57 +00003197 // are for scalar, we could remove the min/max checks. However, to do that,
3198 // we would have to use insertelement/shufflevector to replace edge values.
3199 unsigned NumElts = Op1Type->getVectorNumElements();
3200 for (unsigned i = 0; i != NumElts; ++i) {
3201 Constant *Elt = Op1C->getAggregateElement(i);
Benjamin Kramerca9a0fe2016-05-17 12:08:55 +00003202 if (!Elt)
3203 return nullptr;
3204
Sanjay Patele9b2c322016-05-17 00:57:57 +00003205 if (isa<UndefValue>(Elt))
3206 continue;
3207 // Bail out if we can't determine if this constant is min/max or if we
3208 // know that this constant is min/max.
3209 auto *CI = dyn_cast<ConstantInt>(Elt);
3210 if (!CI || (IsLE ? CI->isMaxValue(IsSigned) : CI->isMinValue(IsSigned)))
3211 return nullptr;
Sanjay Patelb79ab272016-05-13 15:10:46 +00003212 }
Sanjay Patele9b2c322016-05-17 00:57:57 +00003213 } else {
3214 // ConstantExpr?
3215 return nullptr;
Sanjay Patelb79ab272016-05-13 15:10:46 +00003216 }
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003217
Sanjay Patele9b2c322016-05-17 00:57:57 +00003218 // Increment or decrement the constant and set the new comparison predicate:
3219 // ULE -> ULT ; UGE -> UGT ; SLE -> SLT ; SGE -> SGT
Sanjay Patel22b01fe2016-05-17 20:20:40 +00003220 Constant *OneOrNegOne = ConstantInt::get(Op1Type, IsLE ? 1 : -1, true);
Sanjay Patele9b2c322016-05-17 00:57:57 +00003221 CmpInst::Predicate NewPred = IsLE ? ICmpInst::ICMP_ULT: ICmpInst::ICMP_UGT;
3222 NewPred = IsSigned ? ICmpInst::getSignedPredicate(NewPred) : NewPred;
3223 return new ICmpInst(NewPred, Op0, ConstantExpr::getAdd(Op1C, OneOrNegOne));
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003224}
3225
Chris Lattner2188e402010-01-04 07:37:31 +00003226Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
3227 bool Changed = false;
Chris Lattner9306ffa2010-02-01 19:54:45 +00003228 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Quentin Colombet5ab55552013-09-09 20:56:48 +00003229 unsigned Op0Cplxity = getComplexity(Op0);
3230 unsigned Op1Cplxity = getComplexity(Op1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003231
Chris Lattner2188e402010-01-04 07:37:31 +00003232 /// Orders the operands of the compare so that they are listed from most
3233 /// complex to least complex. This puts constants before unary operators,
3234 /// before binary operators.
Quentin Colombet5ab55552013-09-09 20:56:48 +00003235 if (Op0Cplxity < Op1Cplxity ||
Sanjay Patel4c204232016-06-04 20:39:22 +00003236 (Op0Cplxity == Op1Cplxity && swapMayExposeCSEOpportunities(Op0, Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003237 I.swapOperands();
Chris Lattner9306ffa2010-02-01 19:54:45 +00003238 std::swap(Op0, Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00003239 Changed = true;
3240 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003241
Jingyue Wu5e34ce32015-06-25 20:14:47 +00003242 if (Value *V =
Justin Bogner99798402016-08-05 01:06:44 +00003243 SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, &TLI, &DT, &AC, &I))
Sanjay Patel4b198802016-02-01 22:23:39 +00003244 return replaceInstUsesWith(I, V);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003245
Pete Cooperbc5c5242011-12-01 03:58:40 +00003246 // comparing -val or val with non-zero is the same as just comparing val
Pete Cooperfdddc272011-12-01 19:13:26 +00003247 // ie, abs(val) != 0 -> val != 0
Sanjay Patel4c204232016-06-04 20:39:22 +00003248 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero())) {
Pete Cooperfdddc272011-12-01 19:13:26 +00003249 Value *Cond, *SelectTrue, *SelectFalse;
3250 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooperbc5c5242011-12-01 03:58:40 +00003251 m_Value(SelectFalse)))) {
Pete Cooperfdddc272011-12-01 19:13:26 +00003252 if (Value *V = dyn_castNegVal(SelectTrue)) {
3253 if (V == SelectFalse)
3254 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
3255 }
3256 else if (Value *V = dyn_castNegVal(SelectFalse)) {
3257 if (V == SelectTrue)
3258 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooperbc5c5242011-12-01 03:58:40 +00003259 }
3260 }
3261 }
3262
Chris Lattner229907c2011-07-18 04:54:35 +00003263 Type *Ty = Op0->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00003264
3265 // icmp's with boolean values can always be turned into bitwise operations
Sanjay Patela6fbc822016-06-05 17:49:45 +00003266 if (Ty->getScalarType()->isIntegerTy(1)) {
Chris Lattner2188e402010-01-04 07:37:31 +00003267 switch (I.getPredicate()) {
3268 default: llvm_unreachable("Invalid icmp instruction!");
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003269 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
3270 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName() + "tmp");
Chris Lattner2188e402010-01-04 07:37:31 +00003271 return BinaryOperator::CreateNot(Xor);
3272 }
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003273 case ICmpInst::ICMP_NE: // icmp ne i1 A, B -> A^B
Chris Lattner2188e402010-01-04 07:37:31 +00003274 return BinaryOperator::CreateXor(Op0, Op1);
3275
3276 case ICmpInst::ICMP_UGT:
3277 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
Justin Bognercd1d5aa2016-08-17 20:30:52 +00003278 LLVM_FALLTHROUGH;
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003279 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
3280 Value *Not = Builder->CreateNot(Op0, I.getName() + "tmp");
Chris Lattner2188e402010-01-04 07:37:31 +00003281 return BinaryOperator::CreateAnd(Not, Op1);
3282 }
3283 case ICmpInst::ICMP_SGT:
3284 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
Justin Bognercd1d5aa2016-08-17 20:30:52 +00003285 LLVM_FALLTHROUGH;
Chris Lattner2188e402010-01-04 07:37:31 +00003286 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003287 Value *Not = Builder->CreateNot(Op1, I.getName() + "tmp");
Chris Lattner2188e402010-01-04 07:37:31 +00003288 return BinaryOperator::CreateAnd(Not, Op0);
3289 }
3290 case ICmpInst::ICMP_UGE:
3291 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
Justin Bognercd1d5aa2016-08-17 20:30:52 +00003292 LLVM_FALLTHROUGH;
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003293 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
3294 Value *Not = Builder->CreateNot(Op0, I.getName() + "tmp");
Chris Lattner2188e402010-01-04 07:37:31 +00003295 return BinaryOperator::CreateOr(Not, Op1);
3296 }
3297 case ICmpInst::ICMP_SGE:
3298 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
Justin Bognercd1d5aa2016-08-17 20:30:52 +00003299 LLVM_FALLTHROUGH;
Sanjay Patel5f0217f2016-06-05 16:46:18 +00003300 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
3301 Value *Not = Builder->CreateNot(Op1, I.getName() + "tmp");
Chris Lattner2188e402010-01-04 07:37:31 +00003302 return BinaryOperator::CreateOr(Not, Op0);
3303 }
3304 }
3305 }
3306
Sanjay Patele9b2c322016-05-17 00:57:57 +00003307 if (ICmpInst *NewICmp = canonicalizeCmpWithConstant(I))
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003308 return NewICmp;
3309
Chris Lattner2188e402010-01-04 07:37:31 +00003310 unsigned BitWidth = 0;
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003311 if (Ty->isIntOrIntVectorTy())
Chris Lattner2188e402010-01-04 07:37:31 +00003312 BitWidth = Ty->getScalarSizeInBits();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003313 else // Get pointer size.
3314 BitWidth = DL.getTypeSizeInBits(Ty->getScalarType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00003315
Chris Lattner2188e402010-01-04 07:37:31 +00003316 bool isSignBit = false;
3317
3318 // See if we are doing a comparison with a constant.
3319 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Craig Topperf40110f2014-04-25 05:29:35 +00003320 Value *A = nullptr, *B = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003321
Owen Anderson1294ea72010-12-17 18:08:00 +00003322 // Match the following pattern, which is a common idiom when writing
3323 // overflow-safe integer arithmetic function. The source performs an
3324 // addition in wider type, and explicitly checks for overflow using
3325 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
3326 // sadd_with_overflow intrinsic.
Chris Lattneree61c1d2010-12-19 17:52:50 +00003327 //
3328 // TODO: This could probably be generalized to handle other overflow-safe
Jim Grosbach129c52a2011-09-30 18:09:53 +00003329 // operations if we worked out the formulas to compute the appropriate
Owen Anderson1294ea72010-12-17 18:08:00 +00003330 // magic constants.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003331 //
Chris Lattneree61c1d2010-12-19 17:52:50 +00003332 // sum = a + b
3333 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
Owen Anderson1294ea72010-12-17 18:08:00 +00003334 {
Chris Lattneree61c1d2010-12-19 17:52:50 +00003335 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
Owen Anderson1294ea72010-12-17 18:08:00 +00003336 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
Chris Lattneree61c1d2010-12-19 17:52:50 +00003337 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Chris Lattnerce2995a2010-12-19 18:38:44 +00003338 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
Chris Lattneree61c1d2010-12-19 17:52:50 +00003339 return Res;
Owen Anderson1294ea72010-12-17 18:08:00 +00003340 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003341
Philip Reamesec8a8b52016-03-09 21:05:07 +00003342 // (icmp sgt smin(PosA, B) 0) -> (icmp sgt B 0)
3343 if (CI->isZero() && I.getPredicate() == ICmpInst::ICMP_SGT)
3344 if (auto *SI = dyn_cast<SelectInst>(Op0)) {
3345 SelectPatternResult SPR = matchSelectPattern(SI, A, B);
3346 if (SPR.Flavor == SPF_SMIN) {
Philip Reames8f12eba2016-03-09 21:31:47 +00003347 if (isKnownPositive(A, DL))
Philip Reamesec8a8b52016-03-09 21:05:07 +00003348 return new ICmpInst(I.getPredicate(), B, CI);
Philip Reames8f12eba2016-03-09 21:31:47 +00003349 if (isKnownPositive(B, DL))
Philip Reamesec8a8b52016-03-09 21:05:07 +00003350 return new ICmpInst(I.getPredicate(), A, CI);
3351 }
3352 }
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00003353
Philip Reamesec8a8b52016-03-09 21:05:07 +00003354
David Majnemera0afb552015-01-14 19:26:56 +00003355 // The following transforms are only 'worth it' if the only user of the
3356 // subtraction is the icmp.
3357 if (Op0->hasOneUse()) {
3358 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
3359 if (I.isEquality() && CI->isZero() &&
3360 match(Op0, m_Sub(m_Value(A), m_Value(B))))
3361 return new ICmpInst(I.getPredicate(), A, B);
3362
3363 // (icmp sgt (sub nsw A B), -1) -> (icmp sge A, B)
3364 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isAllOnesValue() &&
3365 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3366 return new ICmpInst(ICmpInst::ICMP_SGE, A, B);
3367
3368 // (icmp sgt (sub nsw A B), 0) -> (icmp sgt A, B)
3369 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isZero() &&
3370 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3371 return new ICmpInst(ICmpInst::ICMP_SGT, A, B);
3372
3373 // (icmp slt (sub nsw A B), 0) -> (icmp slt A, B)
3374 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isZero() &&
3375 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3376 return new ICmpInst(ICmpInst::ICMP_SLT, A, B);
3377
3378 // (icmp slt (sub nsw A B), 1) -> (icmp sle A, B)
3379 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isOne() &&
3380 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3381 return new ICmpInst(ICmpInst::ICMP_SLE, A, B);
Chris Lattner2188e402010-01-04 07:37:31 +00003382 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003383
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00003384 if (I.isEquality()) {
3385 ConstantInt *CI2;
3386 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
3387 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
David Majnemer59939ac2014-10-19 08:23:08 +00003388 // (icmp eq/ne (ashr/lshr const2, A), const1)
Sanjay Patel43395062016-07-21 18:07:40 +00003389 if (Instruction *Inst = foldICmpCstShrConst(I, Op0, A, CI, CI2))
David Majnemer2abb8182014-10-25 07:13:13 +00003390 return Inst;
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00003391 }
David Majnemer59939ac2014-10-19 08:23:08 +00003392 if (match(Op0, m_Shl(m_ConstantInt(CI2), m_Value(A)))) {
3393 // (icmp eq/ne (shl const2, A), const1)
Sanjay Patel43395062016-07-21 18:07:40 +00003394 if (Instruction *Inst = foldICmpCstShlConst(I, Op0, A, CI, CI2))
David Majnemer2abb8182014-10-25 07:13:13 +00003395 return Inst;
David Majnemer59939ac2014-10-19 08:23:08 +00003396 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00003397 }
3398
Chris Lattner2188e402010-01-04 07:37:31 +00003399 // If this comparison is a normal comparison, it demands all
3400 // bits, if it is a sign bit comparison, it only demands the sign bit.
3401 bool UnusedBit;
Sanjay Patel79263662016-08-21 15:07:45 +00003402 isSignBit = isSignBitCheck(I.getPredicate(), CI->getValue(), UnusedBit);
Balaram Makam569eaec2016-05-04 21:32:14 +00003403
3404 // Canonicalize icmp instructions based on dominating conditions.
3405 BasicBlock *Parent = I.getParent();
3406 BasicBlock *Dom = Parent->getSinglePredecessor();
3407 auto *BI = Dom ? dyn_cast<BranchInst>(Dom->getTerminator()) : nullptr;
3408 ICmpInst::Predicate Pred;
3409 BasicBlock *TrueBB, *FalseBB;
3410 ConstantInt *CI2;
3411 if (BI && match(BI, m_Br(m_ICmp(Pred, m_Specific(Op0), m_ConstantInt(CI2)),
3412 TrueBB, FalseBB)) &&
3413 TrueBB != FalseBB) {
3414 ConstantRange CR = ConstantRange::makeAllowedICmpRegion(I.getPredicate(),
3415 CI->getValue());
3416 ConstantRange DominatingCR =
3417 (Parent == TrueBB)
3418 ? ConstantRange::makeExactICmpRegion(Pred, CI2->getValue())
3419 : ConstantRange::makeExactICmpRegion(
3420 CmpInst::getInversePredicate(Pred), CI2->getValue());
3421 ConstantRange Intersection = DominatingCR.intersectWith(CR);
3422 ConstantRange Difference = DominatingCR.difference(CR);
3423 if (Intersection.isEmptySet())
3424 return replaceInstUsesWith(I, Builder->getFalse());
3425 if (Difference.isEmptySet())
3426 return replaceInstUsesWith(I, Builder->getTrue());
3427 // Canonicalizing a sign bit comparison that gets used in a branch,
3428 // pessimizes codegen by generating branch on zero instruction instead
3429 // of a test and branch. So we avoid canonicalizing in such situations
3430 // because test and branch instruction has better branch displacement
3431 // than compare and branch instruction.
3432 if (!isBranchOnSignBitCheck(I, isSignBit) && !I.isEquality()) {
3433 if (auto *AI = Intersection.getSingleElement())
3434 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Builder->getInt(*AI));
3435 if (auto *AD = Difference.getSingleElement())
3436 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Builder->getInt(*AD));
3437 }
3438 }
Chris Lattner2188e402010-01-04 07:37:31 +00003439 }
3440
3441 // See if we can fold the comparison based on range information we can get
3442 // by checking whether bits are known to be zero or one in the input.
3443 if (BitWidth != 0) {
3444 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
3445 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
3446
3447 if (SimplifyDemandedBits(I.getOperandUse(0),
Owen Andersond490c2d2011-01-11 00:36:45 +00003448 DemandedBitsLHSMask(I, BitWidth, isSignBit),
Chris Lattner2188e402010-01-04 07:37:31 +00003449 Op0KnownZero, Op0KnownOne, 0))
3450 return &I;
3451 if (SimplifyDemandedBits(I.getOperandUse(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003452 APInt::getAllOnesValue(BitWidth), Op1KnownZero,
3453 Op1KnownOne, 0))
Chris Lattner2188e402010-01-04 07:37:31 +00003454 return &I;
3455
3456 // Given the known and unknown bits, compute a range that the LHS could be
3457 // in. Compute the Min, Max and RHS values based on the known bits. For the
3458 // EQ and NE we use unsigned values.
3459 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
3460 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
3461 if (I.isSigned()) {
3462 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
3463 Op0Min, Op0Max);
3464 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
3465 Op1Min, Op1Max);
3466 } else {
3467 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
3468 Op0Min, Op0Max);
3469 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
3470 Op1Min, Op1Max);
3471 }
3472
3473 // If Min and Max are known to be the same, then SimplifyDemandedBits
3474 // figured out that the LHS is a constant. Just constant fold this now so
3475 // that code below can assume that Min != Max.
3476 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
3477 return new ICmpInst(I.getPredicate(),
Nick Lewycky92db8e82011-03-06 03:36:19 +00003478 ConstantInt::get(Op0->getType(), Op0Min), Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00003479 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
3480 return new ICmpInst(I.getPredicate(), Op0,
Nick Lewycky92db8e82011-03-06 03:36:19 +00003481 ConstantInt::get(Op1->getType(), Op1Min));
Chris Lattner2188e402010-01-04 07:37:31 +00003482
3483 // Based on the range information we know about the LHS, see if we can
Nick Lewycky6b4454192011-02-28 06:20:05 +00003484 // simplify this comparison. For example, (x&4) < 8 is always true.
Chris Lattner2188e402010-01-04 07:37:31 +00003485 switch (I.getPredicate()) {
3486 default: llvm_unreachable("Unknown icmp opcode!");
Chris Lattnerf7e89612010-11-21 06:44:42 +00003487 case ICmpInst::ICMP_EQ: {
Chris Lattner2188e402010-01-04 07:37:31 +00003488 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Sanjay Patel4b198802016-02-01 22:23:39 +00003489 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00003490
Chris Lattnerf7e89612010-11-21 06:44:42 +00003491 // If all bits are known zero except for one, then we know at most one
3492 // bit is set. If the comparison is against zero, then this is a check
3493 // to see if *that* bit is set.
3494 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003495 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00003496 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00003497 Value *LHS = nullptr;
3498 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003499 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
3500 LHSC->getValue() != Op0KnownZeroInverted)
3501 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003502
Chris Lattnerf7e89612010-11-21 06:44:42 +00003503 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
Chris Lattnere5afa152010-11-23 02:42:04 +00003504 // then turn "((1 << x)&8) == 0" into "x != 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003505 // or turn "((1 << x)&7) == 0" into "x > 2".
Craig Topperf40110f2014-04-25 05:29:35 +00003506 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003507 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003508 APInt ValToCheck = Op0KnownZeroInverted;
3509 if (ValToCheck.isPowerOf2()) {
3510 unsigned CmpVal = ValToCheck.countTrailingZeros();
3511 return new ICmpInst(ICmpInst::ICMP_NE, X,
3512 ConstantInt::get(X->getType(), CmpVal));
3513 } else if ((++ValToCheck).isPowerOf2()) {
3514 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
3515 return new ICmpInst(ICmpInst::ICMP_UGT, X,
3516 ConstantInt::get(X->getType(), CmpVal));
3517 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00003518 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003519
Chris Lattnerf7e89612010-11-21 06:44:42 +00003520 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
Chris Lattnere5afa152010-11-23 02:42:04 +00003521 // then turn "((8 >>u x)&1) == 0" into "x != 3".
Chris Lattner98457102011-02-10 05:23:05 +00003522 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003523 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00003524 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00003525 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattner98457102011-02-10 05:23:05 +00003526 ConstantInt::get(X->getType(),
3527 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00003528 }
Chris Lattner2188e402010-01-04 07:37:31 +00003529 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003530 }
3531 case ICmpInst::ICMP_NE: {
Chris Lattner2188e402010-01-04 07:37:31 +00003532 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Sanjay Patel4b198802016-02-01 22:23:39 +00003533 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00003534
Chris Lattnerf7e89612010-11-21 06:44:42 +00003535 // If all bits are known zero except for one, then we know at most one
3536 // bit is set. If the comparison is against zero, then this is a check
3537 // to see if *that* bit is set.
3538 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003539 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00003540 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00003541 Value *LHS = nullptr;
3542 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003543 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
3544 LHSC->getValue() != Op0KnownZeroInverted)
3545 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003546
Chris Lattnerf7e89612010-11-21 06:44:42 +00003547 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
Chris Lattnere5afa152010-11-23 02:42:04 +00003548 // then turn "((1 << x)&8) != 0" into "x == 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003549 // or turn "((1 << x)&7) != 0" into "x < 3".
Craig Topperf40110f2014-04-25 05:29:35 +00003550 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003551 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003552 APInt ValToCheck = Op0KnownZeroInverted;
3553 if (ValToCheck.isPowerOf2()) {
3554 unsigned CmpVal = ValToCheck.countTrailingZeros();
3555 return new ICmpInst(ICmpInst::ICMP_EQ, X,
3556 ConstantInt::get(X->getType(), CmpVal));
3557 } else if ((++ValToCheck).isPowerOf2()) {
3558 unsigned CmpVal = ValToCheck.countTrailingZeros();
3559 return new ICmpInst(ICmpInst::ICMP_ULT, X,
3560 ConstantInt::get(X->getType(), CmpVal));
3561 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00003562 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003563
Chris Lattnerf7e89612010-11-21 06:44:42 +00003564 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
Chris Lattnere5afa152010-11-23 02:42:04 +00003565 // then turn "((8 >>u x)&1) != 0" into "x == 3".
Chris Lattner98457102011-02-10 05:23:05 +00003566 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003567 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00003568 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00003569 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattner98457102011-02-10 05:23:05 +00003570 ConstantInt::get(X->getType(),
3571 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00003572 }
Chris Lattner2188e402010-01-04 07:37:31 +00003573 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003574 }
Chris Lattner2188e402010-01-04 07:37:31 +00003575 case ICmpInst::ICMP_ULT:
3576 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003577 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003578 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003579 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003580 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
3581 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3582 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3583 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
3584 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003585 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00003586
3587 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
3588 if (CI->isMinValue(true))
3589 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
3590 Constant::getAllOnesValue(Op0->getType()));
3591 }
3592 break;
Sanjay Patel57b12d32016-08-19 15:40:44 +00003593 case ICmpInst::ICMP_UGT: {
Chris Lattner2188e402010-01-04 07:37:31 +00003594 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003595 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Sanjay Patel57b12d32016-08-19 15:40:44 +00003596
Chris Lattner2188e402010-01-04 07:37:31 +00003597 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003598 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003599
3600 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
3601 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
Sanjay Patel57b12d32016-08-19 15:40:44 +00003602
3603 const APInt *CmpC;
3604 if (match(Op1, m_APInt(CmpC))) {
3605 // A >u C -> A == C+1 if max(a)-1 == C
3606 if (*CmpC == Op0Max - 1)
Chris Lattner2188e402010-01-04 07:37:31 +00003607 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Sanjay Patel57b12d32016-08-19 15:40:44 +00003608 ConstantInt::get(Op1->getType(), *CmpC + 1));
Chris Lattner2188e402010-01-04 07:37:31 +00003609
3610 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
Sanjay Patel57b12d32016-08-19 15:40:44 +00003611 if (CmpC->isMaxSignedValue())
Chris Lattner2188e402010-01-04 07:37:31 +00003612 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
3613 Constant::getNullValue(Op0->getType()));
3614 }
3615 break;
Sanjay Patel57b12d32016-08-19 15:40:44 +00003616 }
Chris Lattner2188e402010-01-04 07:37:31 +00003617 case ICmpInst::ICMP_SLT:
3618 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
Sanjay Patel4b198802016-02-01 22:23:39 +00003619 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003620 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
Sanjay Patel4b198802016-02-01 22:23:39 +00003621 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003622 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
3623 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3624 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3625 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
3626 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003627 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00003628 }
3629 break;
3630 case ICmpInst::ICMP_SGT:
3631 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003632 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003633 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003634 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003635
3636 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
3637 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3638 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3639 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
3640 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003641 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00003642 }
3643 break;
3644 case ICmpInst::ICMP_SGE:
3645 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
3646 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003647 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003648 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003649 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003650 break;
3651 case ICmpInst::ICMP_SLE:
3652 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
3653 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003654 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003655 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003656 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003657 break;
3658 case ICmpInst::ICMP_UGE:
3659 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
3660 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003661 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003662 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003663 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003664 break;
3665 case ICmpInst::ICMP_ULE:
3666 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
3667 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003668 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003669 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003670 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003671 break;
3672 }
3673
3674 // Turn a signed comparison into an unsigned one if both operands
3675 // are known to have the same sign.
3676 if (I.isSigned() &&
3677 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
3678 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
3679 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
3680 }
3681
3682 // Test if the ICmpInst instruction is used exclusively by a select as
3683 // part of a minimum or maximum operation. If so, refrain from doing
3684 // any other folding. This helps out other analyses which understand
3685 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
3686 // and CodeGen. And in this case, at least one of the comparison
3687 // operands has at least one user besides the compare (the select),
3688 // which would often largely negate the benefit of folding anyway.
3689 if (I.hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00003690 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
Chris Lattner2188e402010-01-04 07:37:31 +00003691 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
3692 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
Craig Topperf40110f2014-04-25 05:29:35 +00003693 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003694
3695 // See if we are doing a comparison between a constant and an instruction that
3696 // can be folded into the comparison.
Sanjay Patel1271bf92016-07-23 13:06:49 +00003697
Sanjay Patel1e5b2d12016-08-16 16:08:11 +00003698 if (Instruction *Res = foldICmpWithConstant(I))
3699 return Res;
Chris Lattner2188e402010-01-04 07:37:31 +00003700
Sanjay Patelab50a932016-08-02 22:38:33 +00003701 if (Instruction *Res = foldICmpEqualityWithConstant(I))
3702 return Res;
3703
Sanjay Patel1271bf92016-07-23 13:06:49 +00003704 if (Instruction *Res = foldICmpIntrinsicWithConstant(I))
3705 return Res;
3706
Chris Lattner2188e402010-01-04 07:37:31 +00003707 // Handle icmp with constant (but not simple integer constant) RHS
3708 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3709 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3710 switch (LHSI->getOpcode()) {
3711 case Instruction::GetElementPtr:
3712 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
3713 if (RHSC->isNullValue() &&
3714 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
3715 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3716 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3717 break;
3718 case Instruction::PHI:
3719 // Only fold icmp into the PHI if the phi and icmp are in the same
3720 // block. If in the same block, we're encouraging jump threading. If
3721 // not, we are just pessimizing the code by making an i1 phi.
3722 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00003723 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00003724 return NV;
3725 break;
3726 case Instruction::Select: {
3727 // If either operand of the select is a constant, we can fold the
3728 // comparison into the select arms, which will cause one to be
3729 // constant folded and the select turned into a bitwise or.
Craig Topperf40110f2014-04-25 05:29:35 +00003730 Value *Op1 = nullptr, *Op2 = nullptr;
Hans Wennborg083ca9b2015-10-06 23:24:35 +00003731 ConstantInt *CI = nullptr;
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003732 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003733 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003734 CI = dyn_cast<ConstantInt>(Op1);
3735 }
3736 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003737 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003738 CI = dyn_cast<ConstantInt>(Op2);
3739 }
Chris Lattner2188e402010-01-04 07:37:31 +00003740
3741 // We only want to perform this transformation if it will not lead to
3742 // additional code. This is true if either both sides of the select
3743 // fold to a constant (in which case the icmp is replaced with a select
3744 // which will usually simplify) or this is the only user of the
3745 // select (in which case we are trading a select+icmp for a simpler
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003746 // select+icmp) or all uses of the select can be replaced based on
3747 // dominance information ("Global cases").
3748 bool Transform = false;
3749 if (Op1 && Op2)
3750 Transform = true;
3751 else if (Op1 || Op2) {
3752 // Local case
3753 if (LHSI->hasOneUse())
3754 Transform = true;
3755 // Global cases
3756 else if (CI && !CI->isZero())
3757 // When Op1 is constant try replacing select with second operand.
3758 // Otherwise Op2 is constant and try replacing select with first
3759 // operand.
3760 Transform = replacedSelectWithOperand(cast<SelectInst>(LHSI), &I,
3761 Op1 ? 2 : 1);
3762 }
3763 if (Transform) {
Chris Lattner2188e402010-01-04 07:37:31 +00003764 if (!Op1)
3765 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
3766 RHSC, I.getName());
3767 if (!Op2)
3768 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
3769 RHSC, I.getName());
3770 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3771 }
3772 break;
3773 }
Chris Lattner2188e402010-01-04 07:37:31 +00003774 case Instruction::IntToPtr:
3775 // icmp pred inttoptr(X), null -> icmp pred X, 0
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003776 if (RHSC->isNullValue() &&
3777 DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
Chris Lattner2188e402010-01-04 07:37:31 +00003778 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3779 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3780 break;
3781
3782 case Instruction::Load:
3783 // Try to optimize things like "A[i] > 4" to index computations.
3784 if (GetElementPtrInst *GEP =
3785 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3786 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3787 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3788 !cast<LoadInst>(LHSI)->isVolatile())
Sanjay Patel43395062016-07-21 18:07:40 +00003789 if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
Chris Lattner2188e402010-01-04 07:37:31 +00003790 return Res;
3791 }
3792 break;
3793 }
3794 }
3795
3796 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
3797 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
Sanjay Patel43395062016-07-21 18:07:40 +00003798 if (Instruction *NI = foldGEPICmp(GEP, Op1, I.getPredicate(), I))
Chris Lattner2188e402010-01-04 07:37:31 +00003799 return NI;
3800 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
Sanjay Patel43395062016-07-21 18:07:40 +00003801 if (Instruction *NI = foldGEPICmp(GEP, Op0,
Chris Lattner2188e402010-01-04 07:37:31 +00003802 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
3803 return NI;
3804
Hans Wennborgf1f36512015-10-07 00:20:07 +00003805 // Try to optimize equality comparisons against alloca-based pointers.
3806 if (Op0->getType()->isPointerTy() && I.isEquality()) {
3807 assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?");
3808 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op0, DL)))
Sanjay Patel43395062016-07-21 18:07:40 +00003809 if (Instruction *New = foldAllocaCmp(I, Alloca, Op1))
Hans Wennborgf1f36512015-10-07 00:20:07 +00003810 return New;
3811 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op1, DL)))
Sanjay Patel43395062016-07-21 18:07:40 +00003812 if (Instruction *New = foldAllocaCmp(I, Alloca, Op0))
Hans Wennborgf1f36512015-10-07 00:20:07 +00003813 return New;
3814 }
3815
Chris Lattner2188e402010-01-04 07:37:31 +00003816 // Test to see if the operands of the icmp are casted versions of other
3817 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
3818 // now.
3819 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00003820 if (Op0->getType()->isPointerTy() &&
3821 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003822 // We keep moving the cast from the left operand over to the right
3823 // operand, where it can often be eliminated completely.
3824 Op0 = CI->getOperand(0);
3825
3826 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
3827 // so eliminate it as well.
3828 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
3829 Op1 = CI2->getOperand(0);
3830
3831 // If Op1 is a constant, we can fold the cast into the constant.
3832 if (Op0->getType() != Op1->getType()) {
3833 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
3834 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
3835 } else {
3836 // Otherwise, cast the RHS right before the icmp
3837 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
3838 }
3839 }
3840 return new ICmpInst(I.getPredicate(), Op0, Op1);
3841 }
3842 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003843
Chris Lattner2188e402010-01-04 07:37:31 +00003844 if (isa<CastInst>(Op0)) {
3845 // Handle the special case of: icmp (cast bool to X), <cst>
3846 // This comes up when you have code like
3847 // int X = A < B;
3848 // if (X) ...
3849 // For generality, we handle any zero-extension of any operand comparison
3850 // with a constant or another cast from the same type.
3851 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
Sanjay Patel43395062016-07-21 18:07:40 +00003852 if (Instruction *R = foldICmpWithCastAndCast(I))
Chris Lattner2188e402010-01-04 07:37:31 +00003853 return R;
3854 }
Chris Lattner2188e402010-01-04 07:37:31 +00003855
Duncan Sandse5220012011-02-17 07:46:37 +00003856 // Special logic for binary operators.
3857 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3858 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3859 if (BO0 || BO1) {
3860 CmpInst::Predicate Pred = I.getPredicate();
3861 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3862 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3863 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
3864 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3865 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3866 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3867 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3868 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3869 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3870
3871 // Analyze the case when either Op0 or Op1 is an add instruction.
3872 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
Craig Topperf40110f2014-04-25 05:29:35 +00003873 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
Richard Trieu7a083812016-02-18 22:09:30 +00003874 if (BO0 && BO0->getOpcode() == Instruction::Add) {
3875 A = BO0->getOperand(0);
3876 B = BO0->getOperand(1);
3877 }
3878 if (BO1 && BO1->getOpcode() == Instruction::Add) {
3879 C = BO1->getOperand(0);
3880 D = BO1->getOperand(1);
3881 }
Duncan Sandse5220012011-02-17 07:46:37 +00003882
David Majnemer549f4f22014-11-01 09:09:51 +00003883 // icmp (X+cst) < 0 --> X < -cst
3884 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred) && match(Op1, m_Zero()))
3885 if (ConstantInt *RHSC = dyn_cast_or_null<ConstantInt>(B))
3886 if (!RHSC->isMinValue(/*isSigned=*/true))
3887 return new ICmpInst(Pred, A, ConstantExpr::getNeg(RHSC));
3888
Duncan Sandse5220012011-02-17 07:46:37 +00003889 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3890 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3891 return new ICmpInst(Pred, A == Op1 ? B : A,
3892 Constant::getNullValue(Op1->getType()));
3893
3894 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3895 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3896 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3897 C == Op0 ? D : C);
3898
Duncan Sands84653b32011-02-18 16:25:37 +00003899 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003900 if (A && C && (A == C || A == D || B == C || B == D) &&
3901 NoOp0WrapProblem && NoOp1WrapProblem &&
3902 // Try not to increase register pressure.
3903 BO0->hasOneUse() && BO1->hasOneUse()) {
3904 // Determine Y and Z in the form icmp (X+Y), (X+Z).
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003905 Value *Y, *Z;
3906 if (A == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003907 // C + B == C + D -> B == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003908 Y = B;
3909 Z = D;
3910 } else if (A == D) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003911 // D + B == C + D -> B == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003912 Y = B;
3913 Z = C;
3914 } else if (B == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003915 // A + C == C + D -> A == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003916 Y = A;
3917 Z = D;
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003918 } else {
3919 assert(B == D);
3920 // A + D == C + D -> A == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003921 Y = A;
3922 Z = C;
3923 }
Duncan Sandse5220012011-02-17 07:46:37 +00003924 return new ICmpInst(Pred, Y, Z);
3925 }
3926
David Majnemerb81cd632013-04-11 20:05:46 +00003927 // icmp slt (X + -1), Y -> icmp sle X, Y
3928 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3929 match(B, m_AllOnes()))
3930 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3931
3932 // icmp sge (X + -1), Y -> icmp sgt X, Y
3933 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3934 match(B, m_AllOnes()))
3935 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3936
3937 // icmp sle (X + 1), Y -> icmp slt X, Y
3938 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3939 match(B, m_One()))
3940 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3941
3942 // icmp sgt (X + 1), Y -> icmp sge X, Y
3943 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3944 match(B, m_One()))
3945 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3946
Michael Liaoc65d3862015-10-19 22:08:14 +00003947 // icmp sgt X, (Y + -1) -> icmp sge X, Y
3948 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT &&
3949 match(D, m_AllOnes()))
3950 return new ICmpInst(CmpInst::ICMP_SGE, Op0, C);
3951
3952 // icmp sle X, (Y + -1) -> icmp slt X, Y
3953 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE &&
3954 match(D, m_AllOnes()))
3955 return new ICmpInst(CmpInst::ICMP_SLT, Op0, C);
3956
3957 // icmp sge X, (Y + 1) -> icmp sgt X, Y
3958 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE &&
3959 match(D, m_One()))
3960 return new ICmpInst(CmpInst::ICMP_SGT, Op0, C);
3961
3962 // icmp slt X, (Y + 1) -> icmp sle X, Y
3963 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT &&
3964 match(D, m_One()))
3965 return new ICmpInst(CmpInst::ICMP_SLE, Op0, C);
3966
David Majnemerb81cd632013-04-11 20:05:46 +00003967 // if C1 has greater magnitude than C2:
3968 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3969 // s.t. C3 = C1 - C2
3970 //
3971 // if C2 has greater magnitude than C1:
3972 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3973 // s.t. C3 = C2 - C1
3974 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3975 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3976 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3977 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3978 const APInt &AP1 = C1->getValue();
3979 const APInt &AP2 = C2->getValue();
3980 if (AP1.isNegative() == AP2.isNegative()) {
3981 APInt AP1Abs = C1->getValue().abs();
3982 APInt AP2Abs = C2->getValue().abs();
3983 if (AP1Abs.uge(AP2Abs)) {
3984 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3985 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3986 return new ICmpInst(Pred, NewAdd, C);
3987 } else {
3988 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3989 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3990 return new ICmpInst(Pred, A, NewAdd);
3991 }
3992 }
3993 }
3994
3995
Duncan Sandse5220012011-02-17 07:46:37 +00003996 // Analyze the case when either Op0 or Op1 is a sub instruction.
3997 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
Richard Trieu7a083812016-02-18 22:09:30 +00003998 A = nullptr;
3999 B = nullptr;
4000 C = nullptr;
4001 D = nullptr;
4002 if (BO0 && BO0->getOpcode() == Instruction::Sub) {
4003 A = BO0->getOperand(0);
4004 B = BO0->getOperand(1);
4005 }
4006 if (BO1 && BO1->getOpcode() == Instruction::Sub) {
4007 C = BO1->getOperand(0);
4008 D = BO1->getOperand(1);
4009 }
Duncan Sandse5220012011-02-17 07:46:37 +00004010
Duncan Sands84653b32011-02-18 16:25:37 +00004011 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
4012 if (A == Op1 && NoOp0WrapProblem)
4013 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
4014
4015 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
4016 if (C == Op0 && NoOp1WrapProblem)
4017 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
4018
4019 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00004020 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
4021 // Try not to increase register pressure.
4022 BO0->hasOneUse() && BO1->hasOneUse())
4023 return new ICmpInst(Pred, A, C);
4024
Duncan Sands84653b32011-02-18 16:25:37 +00004025 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
4026 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
4027 // Try not to increase register pressure.
4028 BO0->hasOneUse() && BO1->hasOneUse())
4029 return new ICmpInst(Pred, D, B);
4030
David Majnemer186c9422014-05-15 00:02:20 +00004031 // icmp (0-X) < cst --> x > -cst
4032 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
4033 Value *X;
4034 if (match(BO0, m_Neg(m_Value(X))))
4035 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
4036 if (!RHSC->isMinValue(/*isSigned=*/true))
4037 return new ICmpInst(I.getSwappedPredicate(), X,
4038 ConstantExpr::getNeg(RHSC));
4039 }
4040
Craig Topperf40110f2014-04-25 05:29:35 +00004041 BinaryOperator *SRem = nullptr;
Nick Lewyckyafc80982011-03-08 06:29:47 +00004042 // icmp (srem X, Y), Y
Nick Lewycky25cc3382011-03-05 04:28:48 +00004043 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
4044 Op1 == BO0->getOperand(1))
4045 SRem = BO0;
Nick Lewyckyafc80982011-03-08 06:29:47 +00004046 // icmp Y, (srem X, Y)
Nick Lewycky25cc3382011-03-05 04:28:48 +00004047 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
4048 Op0 == BO1->getOperand(1))
4049 SRem = BO1;
4050 if (SRem) {
4051 // We don't check hasOneUse to avoid increasing register pressure because
4052 // the value we use is the same value this instruction was already using.
4053 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
4054 default: break;
4055 case ICmpInst::ICMP_EQ:
Sanjay Patel4b198802016-02-01 22:23:39 +00004056 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00004057 case ICmpInst::ICMP_NE:
Sanjay Patel4b198802016-02-01 22:23:39 +00004058 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00004059 case ICmpInst::ICMP_SGT:
4060 case ICmpInst::ICMP_SGE:
4061 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
4062 Constant::getAllOnesValue(SRem->getType()));
4063 case ICmpInst::ICMP_SLT:
4064 case ICmpInst::ICMP_SLE:
4065 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
4066 Constant::getNullValue(SRem->getType()));
4067 }
4068 }
4069
Duncan Sandse5220012011-02-17 07:46:37 +00004070 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
4071 BO0->hasOneUse() && BO1->hasOneUse() &&
4072 BO0->getOperand(1) == BO1->getOperand(1)) {
4073 switch (BO0->getOpcode()) {
4074 default: break;
4075 case Instruction::Add:
4076 case Instruction::Sub:
4077 case Instruction::Xor:
4078 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
4079 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
4080 BO1->getOperand(0));
4081 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
4082 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
4083 if (CI->getValue().isSignBit()) {
4084 ICmpInst::Predicate Pred = I.isSigned()
4085 ? I.getUnsignedPredicate()
4086 : I.getSignedPredicate();
4087 return new ICmpInst(Pred, BO0->getOperand(0),
4088 BO1->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00004089 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004090
David Majnemerf8853ae2016-02-01 17:37:56 +00004091 if (BO0->getOpcode() == Instruction::Xor && CI->isMaxValue(true)) {
Duncan Sandse5220012011-02-17 07:46:37 +00004092 ICmpInst::Predicate Pred = I.isSigned()
4093 ? I.getUnsignedPredicate()
4094 : I.getSignedPredicate();
4095 Pred = I.getSwappedPredicate(Pred);
4096 return new ICmpInst(Pred, BO0->getOperand(0),
4097 BO1->getOperand(0));
4098 }
Chris Lattner2188e402010-01-04 07:37:31 +00004099 }
Duncan Sandse5220012011-02-17 07:46:37 +00004100 break;
4101 case Instruction::Mul:
4102 if (!I.isEquality())
4103 break;
4104
4105 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
4106 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
4107 // Mask = -1 >> count-trailing-zeros(Cst).
4108 if (!CI->isZero() && !CI->isOne()) {
4109 const APInt &AP = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004110 ConstantInt *Mask = ConstantInt::get(I.getContext(),
Duncan Sandse5220012011-02-17 07:46:37 +00004111 APInt::getLowBitsSet(AP.getBitWidth(),
4112 AP.getBitWidth() -
4113 AP.countTrailingZeros()));
4114 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
4115 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
4116 return new ICmpInst(I.getPredicate(), And1, And2);
4117 }
4118 }
4119 break;
Nick Lewycky9719a712011-03-05 05:19:11 +00004120 case Instruction::UDiv:
4121 case Instruction::LShr:
4122 if (I.isSigned())
4123 break;
Justin Bognerb03fd122016-08-17 05:10:15 +00004124 LLVM_FALLTHROUGH;
Nick Lewycky9719a712011-03-05 05:19:11 +00004125 case Instruction::SDiv:
4126 case Instruction::AShr:
Eli Friedman8a20e662011-05-05 21:59:18 +00004127 if (!BO0->isExact() || !BO1->isExact())
Nick Lewycky9719a712011-03-05 05:19:11 +00004128 break;
4129 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
4130 BO1->getOperand(0));
4131 case Instruction::Shl: {
4132 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
4133 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
4134 if (!NUW && !NSW)
4135 break;
4136 if (!NSW && I.isSigned())
4137 break;
4138 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
4139 BO1->getOperand(0));
4140 }
Chris Lattner2188e402010-01-04 07:37:31 +00004141 }
4142 }
Sanjoy Dasc86c1622015-08-21 22:22:37 +00004143
4144 if (BO0) {
4145 // Transform A & (L - 1) `ult` L --> L != 0
4146 auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
4147 auto BitwiseAnd =
4148 m_CombineOr(m_And(m_Value(), LSubOne), m_And(LSubOne, m_Value()));
4149
4150 if (match(BO0, BitwiseAnd) && I.getPredicate() == ICmpInst::ICMP_ULT) {
4151 auto *Zero = Constant::getNullValue(BO0->getType());
4152 return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
4153 }
4154 }
Chris Lattner2188e402010-01-04 07:37:31 +00004155 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004156
Chris Lattner2188e402010-01-04 07:37:31 +00004157 { Value *A, *B;
David Majnemer1a08acc2013-04-12 17:25:07 +00004158 // Transform (A & ~B) == 0 --> (A & B) != 0
4159 // and (A & ~B) != 0 --> (A & B) == 0
4160 // if A is a power of 2.
4161 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
Chandler Carruth66b31302015-01-04 12:03:27 +00004162 match(Op1, m_Zero()) &&
Justin Bogner99798402016-08-05 01:06:44 +00004163 isKnownToBeAPowerOfTwo(A, DL, false, 0, &AC, &I, &DT) && I.isEquality())
David Majnemer1a08acc2013-04-12 17:25:07 +00004164 return new ICmpInst(I.getInversePredicate(),
4165 Builder->CreateAnd(A, B),
4166 Op1);
4167
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00004168 // ~x < ~y --> y < x
4169 // ~x < cst --> ~cst < x
4170 if (match(Op0, m_Not(m_Value(A)))) {
4171 if (match(Op1, m_Not(m_Value(B))))
4172 return new ICmpInst(I.getPredicate(), B, A);
Chris Lattner497459d2011-01-15 05:42:47 +00004173 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00004174 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
4175 }
Chris Lattner5e0c0c72010-12-19 19:37:52 +00004176
Sanjoy Dasb6c59142015-04-10 21:07:09 +00004177 Instruction *AddI = nullptr;
4178 if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
4179 m_Instruction(AddI))) &&
4180 isa<IntegerType>(A->getType())) {
4181 Value *Result;
4182 Constant *Overflow;
4183 if (OptimizeOverflowCheck(OCF_UNSIGNED_ADD, A, B, *AddI, Result,
4184 Overflow)) {
Sanjay Patel4b198802016-02-01 22:23:39 +00004185 replaceInstUsesWith(*AddI, Result);
4186 return replaceInstUsesWith(I, Overflow);
Sanjoy Dasb6c59142015-04-10 21:07:09 +00004187 }
4188 }
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004189
4190 // (zext a) * (zext b) --> llvm.umul.with.overflow.
4191 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
4192 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
4193 return R;
4194 }
4195 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
4196 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
4197 return R;
4198 }
Chris Lattner2188e402010-01-04 07:37:31 +00004199 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004200
Chris Lattner2188e402010-01-04 07:37:31 +00004201 if (I.isEquality()) {
4202 Value *A, *B, *C, *D;
Duncan Sands84653b32011-02-18 16:25:37 +00004203
Chris Lattner2188e402010-01-04 07:37:31 +00004204 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
4205 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
4206 Value *OtherVal = A == Op1 ? B : A;
4207 return new ICmpInst(I.getPredicate(), OtherVal,
4208 Constant::getNullValue(A->getType()));
4209 }
4210
4211 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
4212 // A^c1 == C^c2 --> A == C^(c1^c2)
4213 ConstantInt *C1, *C2;
4214 if (match(B, m_ConstantInt(C1)) &&
4215 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
Jakub Staszakbddea112013-06-06 20:18:46 +00004216 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
Benjamin Kramer547b6c52011-09-27 20:39:19 +00004217 Value *Xor = Builder->CreateXor(C, NC);
Chris Lattner2188e402010-01-04 07:37:31 +00004218 return new ICmpInst(I.getPredicate(), A, Xor);
4219 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004220
Chris Lattner2188e402010-01-04 07:37:31 +00004221 // A^B == A^D -> B == D
4222 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
4223 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
4224 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
4225 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
4226 }
4227 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004228
Chris Lattner2188e402010-01-04 07:37:31 +00004229 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
4230 (A == Op0 || B == Op0)) {
4231 // A == (A^B) -> B == 0
4232 Value *OtherVal = A == Op0 ? B : A;
4233 return new ICmpInst(I.getPredicate(), OtherVal,
4234 Constant::getNullValue(A->getType()));
4235 }
4236
Chris Lattner2188e402010-01-04 07:37:31 +00004237 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
Jim Grosbach129c52a2011-09-30 18:09:53 +00004238 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
Chris Lattner31b106d2011-04-26 20:02:45 +00004239 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
Craig Topperf40110f2014-04-25 05:29:35 +00004240 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004241
Chris Lattner2188e402010-01-04 07:37:31 +00004242 if (A == C) {
4243 X = B; Y = D; Z = A;
4244 } else if (A == D) {
4245 X = B; Y = C; Z = A;
4246 } else if (B == C) {
4247 X = A; Y = D; Z = B;
4248 } else if (B == D) {
4249 X = A; Y = C; Z = B;
4250 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004251
Chris Lattner2188e402010-01-04 07:37:31 +00004252 if (X) { // Build (X^Y) & Z
Benjamin Kramer547b6c52011-09-27 20:39:19 +00004253 Op1 = Builder->CreateXor(X, Y);
4254 Op1 = Builder->CreateAnd(Op1, Z);
Chris Lattner2188e402010-01-04 07:37:31 +00004255 I.setOperand(0, Op1);
4256 I.setOperand(1, Constant::getNullValue(Op1->getType()));
4257 return &I;
4258 }
4259 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004260
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00004261 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
Benjamin Kramer21501452012-06-11 08:01:25 +00004262 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00004263 ConstantInt *Cst1;
Benjamin Kramer21501452012-06-11 08:01:25 +00004264 if ((Op0->hasOneUse() &&
4265 match(Op0, m_ZExt(m_Value(A))) &&
4266 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
4267 (Op1->hasOneUse() &&
4268 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
4269 match(Op1, m_ZExt(m_Value(A))))) {
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00004270 APInt Pow2 = Cst1->getValue() + 1;
4271 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
4272 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
4273 return new ICmpInst(I.getPredicate(), A,
4274 Builder->CreateTrunc(B, A->getType()));
4275 }
4276
Benjamin Kramer03f3e242013-11-16 16:00:48 +00004277 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
4278 // For lshr and ashr pairs.
4279 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4280 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
4281 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4282 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
4283 unsigned TypeBits = Cst1->getBitWidth();
4284 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4285 if (ShAmt < TypeBits && ShAmt != 0) {
4286 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
4287 ? ICmpInst::ICMP_UGE
4288 : ICmpInst::ICMP_ULT;
4289 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
4290 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
4291 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
4292 }
4293 }
4294
Benjamin Kramer7fa8c432015-03-26 17:12:06 +00004295 // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
4296 if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
4297 match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
4298 unsigned TypeBits = Cst1->getBitWidth();
4299 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4300 if (ShAmt < TypeBits && ShAmt != 0) {
4301 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
4302 APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
4303 Value *And = Builder->CreateAnd(Xor, Builder->getInt(AndVal),
4304 I.getName() + ".mask");
4305 return new ICmpInst(I.getPredicate(), And,
4306 Constant::getNullValue(Cst1->getType()));
4307 }
4308 }
4309
Chris Lattner1b06c712011-04-26 20:18:20 +00004310 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
4311 // "icmp (and X, mask), cst"
4312 uint64_t ShAmt = 0;
Chris Lattner1b06c712011-04-26 20:18:20 +00004313 if (Op0->hasOneUse() &&
4314 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
4315 m_ConstantInt(ShAmt))))) &&
4316 match(Op1, m_ConstantInt(Cst1)) &&
4317 // Only do this when A has multiple uses. This is most important to do
4318 // when it exposes other optimizations.
4319 !A->hasOneUse()) {
4320 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004321
Chris Lattner1b06c712011-04-26 20:18:20 +00004322 if (ShAmt < ASize) {
4323 APInt MaskV =
4324 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
4325 MaskV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004326
Chris Lattner1b06c712011-04-26 20:18:20 +00004327 APInt CmpV = Cst1->getValue().zext(ASize);
4328 CmpV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004329
Chris Lattner1b06c712011-04-26 20:18:20 +00004330 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
4331 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
4332 }
4333 }
Chris Lattner2188e402010-01-04 07:37:31 +00004334 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004335
David Majnemerc1eca5a2014-11-06 23:23:30 +00004336 // The 'cmpxchg' instruction returns an aggregate containing the old value and
4337 // an i1 which indicates whether or not we successfully did the swap.
4338 //
4339 // Replace comparisons between the old value and the expected value with the
4340 // indicator that 'cmpxchg' returns.
4341 //
4342 // N.B. This transform is only valid when the 'cmpxchg' is not permitted to
4343 // spuriously fail. In those cases, the old value may equal the expected
4344 // value but it is possible for the swap to not occur.
4345 if (I.getPredicate() == ICmpInst::ICMP_EQ)
4346 if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
4347 if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
4348 if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
4349 !ACXI->isWeak())
4350 return ExtractValueInst::Create(ACXI, 1);
4351
Chris Lattner2188e402010-01-04 07:37:31 +00004352 {
4353 Value *X; ConstantInt *Cst;
4354 // icmp X+Cst, X
4355 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
Sanjay Patel43395062016-07-21 18:07:40 +00004356 return foldICmpAddOpConst(I, X, Cst, I.getPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00004357
4358 // icmp X, X+Cst
4359 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
Sanjay Patel43395062016-07-21 18:07:40 +00004360 return foldICmpAddOpConst(I, X, Cst, I.getSwappedPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00004361 }
Craig Topperf40110f2014-04-25 05:29:35 +00004362 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004363}
4364
Sanjay Patel5f0217f2016-06-05 16:46:18 +00004365/// Fold fcmp ([us]itofp x, cst) if possible.
Sanjay Patel43395062016-07-21 18:07:40 +00004366Instruction *InstCombiner::foldFCmpIntToFPConst(FCmpInst &I, Instruction *LHSI,
Chris Lattner2188e402010-01-04 07:37:31 +00004367 Constant *RHSC) {
Craig Topperf40110f2014-04-25 05:29:35 +00004368 if (!isa<ConstantFP>(RHSC)) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004369 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004370
Chris Lattner2188e402010-01-04 07:37:31 +00004371 // Get the width of the mantissa. We don't want to hack on conversions that
4372 // might lose information from the integer, e.g. "i64 -> float"
4373 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
Craig Topperf40110f2014-04-25 05:29:35 +00004374 if (MantissaWidth == -1) return nullptr; // Unknown.
Jim Grosbach129c52a2011-09-30 18:09:53 +00004375
Matt Arsenault55e73122015-01-06 15:50:59 +00004376 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
4377
Chris Lattner2188e402010-01-04 07:37:31 +00004378 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004379
Matt Arsenault55e73122015-01-06 15:50:59 +00004380 if (I.isEquality()) {
4381 FCmpInst::Predicate P = I.getPredicate();
4382 bool IsExact = false;
4383 APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
4384 RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
4385
4386 // If the floating point constant isn't an integer value, we know if we will
4387 // ever compare equal / not equal to it.
4388 if (!IsExact) {
4389 // TODO: Can never be -0.0 and other non-representable values
4390 APFloat RHSRoundInt(RHS);
4391 RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
4392 if (RHS.compare(RHSRoundInt) != APFloat::cmpEqual) {
4393 if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
Sanjay Patel4b198802016-02-01 22:23:39 +00004394 return replaceInstUsesWith(I, Builder->getFalse());
Matt Arsenault55e73122015-01-06 15:50:59 +00004395
4396 assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
Sanjay Patel4b198802016-02-01 22:23:39 +00004397 return replaceInstUsesWith(I, Builder->getTrue());
Matt Arsenault55e73122015-01-06 15:50:59 +00004398 }
4399 }
4400
4401 // TODO: If the constant is exactly representable, is it always OK to do
4402 // equality compares as integer?
4403 }
4404
Arch D. Robison8ed08542015-09-15 17:51:59 +00004405 // Check to see that the input is converted from an integer type that is small
4406 // enough that preserves all bits. TODO: check here for "known" sign bits.
4407 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
4408 unsigned InputSize = IntTy->getScalarSizeInBits();
Matt Arsenault55e73122015-01-06 15:50:59 +00004409
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00004410 // Following test does NOT adjust InputSize downwards for signed inputs,
4411 // because the most negative value still requires all the mantissa bits
Arch D. Robison8ed08542015-09-15 17:51:59 +00004412 // to distinguish it from one less than that value.
4413 if ((int)InputSize > MantissaWidth) {
4414 // Conversion would lose accuracy. Check if loss can impact comparison.
4415 int Exp = ilogb(RHS);
4416 if (Exp == APFloat::IEK_Inf) {
4417 int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics()));
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00004418 if (MaxExponent < (int)InputSize - !LHSUnsigned)
Arch D. Robison8ed08542015-09-15 17:51:59 +00004419 // Conversion could create infinity.
4420 return nullptr;
4421 } else {
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00004422 // Note that if RHS is zero or NaN, then Exp is negative
Arch D. Robison8ed08542015-09-15 17:51:59 +00004423 // and first condition is trivially false.
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00004424 if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned)
Arch D. Robison8ed08542015-09-15 17:51:59 +00004425 // Conversion could affect comparison.
4426 return nullptr;
4427 }
4428 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004429
Chris Lattner2188e402010-01-04 07:37:31 +00004430 // Otherwise, we can potentially simplify the comparison. We know that it
4431 // will always come through as an integer value and we know the constant is
4432 // not a NAN (it would have been previously simplified).
4433 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00004434
Chris Lattner2188e402010-01-04 07:37:31 +00004435 ICmpInst::Predicate Pred;
4436 switch (I.getPredicate()) {
4437 default: llvm_unreachable("Unexpected predicate!");
4438 case FCmpInst::FCMP_UEQ:
4439 case FCmpInst::FCMP_OEQ:
4440 Pred = ICmpInst::ICMP_EQ;
4441 break;
4442 case FCmpInst::FCMP_UGT:
4443 case FCmpInst::FCMP_OGT:
4444 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
4445 break;
4446 case FCmpInst::FCMP_UGE:
4447 case FCmpInst::FCMP_OGE:
4448 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
4449 break;
4450 case FCmpInst::FCMP_ULT:
4451 case FCmpInst::FCMP_OLT:
4452 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
4453 break;
4454 case FCmpInst::FCMP_ULE:
4455 case FCmpInst::FCMP_OLE:
4456 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
4457 break;
4458 case FCmpInst::FCMP_UNE:
4459 case FCmpInst::FCMP_ONE:
4460 Pred = ICmpInst::ICMP_NE;
4461 break;
4462 case FCmpInst::FCMP_ORD:
Sanjay Patel4b198802016-02-01 22:23:39 +00004463 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004464 case FCmpInst::FCMP_UNO:
Sanjay Patel4b198802016-02-01 22:23:39 +00004465 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004466 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004467
Chris Lattner2188e402010-01-04 07:37:31 +00004468 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach129c52a2011-09-30 18:09:53 +00004469
Chris Lattner2188e402010-01-04 07:37:31 +00004470 // See if the FP constant is too large for the integer. For example,
4471 // comparing an i8 to 300.0.
4472 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004473
Chris Lattner2188e402010-01-04 07:37:31 +00004474 if (!LHSUnsigned) {
4475 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
4476 // and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00004477 APFloat SMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00004478 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
4479 APFloat::rmNearestTiesToEven);
4480 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
4481 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
4482 Pred == ICmpInst::ICMP_SLE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004483 return replaceInstUsesWith(I, Builder->getTrue());
4484 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004485 }
4486 } else {
4487 // If the RHS value is > UnsignedMax, fold the comparison. This handles
4488 // +INF and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00004489 APFloat UMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00004490 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
4491 APFloat::rmNearestTiesToEven);
4492 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
4493 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
4494 Pred == ICmpInst::ICMP_ULE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004495 return replaceInstUsesWith(I, Builder->getTrue());
4496 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004497 }
4498 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004499
Chris Lattner2188e402010-01-04 07:37:31 +00004500 if (!LHSUnsigned) {
4501 // See if the RHS value is < SignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00004502 APFloat SMin(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00004503 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
4504 APFloat::rmNearestTiesToEven);
4505 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
4506 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
4507 Pred == ICmpInst::ICMP_SGE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004508 return replaceInstUsesWith(I, Builder->getTrue());
4509 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004510 }
Devang Patel698452b2012-02-13 23:05:18 +00004511 } else {
4512 // See if the RHS value is < UnsignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00004513 APFloat SMin(RHS.getSemantics());
Devang Patel698452b2012-02-13 23:05:18 +00004514 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
4515 APFloat::rmNearestTiesToEven);
4516 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
4517 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
4518 Pred == ICmpInst::ICMP_UGE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004519 return replaceInstUsesWith(I, Builder->getTrue());
4520 return replaceInstUsesWith(I, Builder->getFalse());
Devang Patel698452b2012-02-13 23:05:18 +00004521 }
Chris Lattner2188e402010-01-04 07:37:31 +00004522 }
4523
4524 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
4525 // [0, UMAX], but it may still be fractional. See if it is fractional by
4526 // casting the FP value to the integer value and back, checking for equality.
4527 // Don't do this for zero, because -0.0 is not fractional.
4528 Constant *RHSInt = LHSUnsigned
4529 ? ConstantExpr::getFPToUI(RHSC, IntTy)
4530 : ConstantExpr::getFPToSI(RHSC, IntTy);
4531 if (!RHS.isZero()) {
4532 bool Equal = LHSUnsigned
4533 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
4534 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
4535 if (!Equal) {
4536 // If we had a comparison against a fractional value, we have to adjust
4537 // the compare predicate and sometimes the value. RHSC is rounded towards
4538 // zero at this point.
4539 switch (Pred) {
4540 default: llvm_unreachable("Unexpected integer comparison!");
4541 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Sanjay Patel4b198802016-02-01 22:23:39 +00004542 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004543 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Sanjay Patel4b198802016-02-01 22:23:39 +00004544 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004545 case ICmpInst::ICMP_ULE:
4546 // (float)int <= 4.4 --> int <= 4
4547 // (float)int <= -4.4 --> false
4548 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004549 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004550 break;
4551 case ICmpInst::ICMP_SLE:
4552 // (float)int <= 4.4 --> int <= 4
4553 // (float)int <= -4.4 --> int < -4
4554 if (RHS.isNegative())
4555 Pred = ICmpInst::ICMP_SLT;
4556 break;
4557 case ICmpInst::ICMP_ULT:
4558 // (float)int < -4.4 --> false
4559 // (float)int < 4.4 --> int <= 4
4560 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004561 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004562 Pred = ICmpInst::ICMP_ULE;
4563 break;
4564 case ICmpInst::ICMP_SLT:
4565 // (float)int < -4.4 --> int < -4
4566 // (float)int < 4.4 --> int <= 4
4567 if (!RHS.isNegative())
4568 Pred = ICmpInst::ICMP_SLE;
4569 break;
4570 case ICmpInst::ICMP_UGT:
4571 // (float)int > 4.4 --> int > 4
4572 // (float)int > -4.4 --> true
4573 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004574 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004575 break;
4576 case ICmpInst::ICMP_SGT:
4577 // (float)int > 4.4 --> int > 4
4578 // (float)int > -4.4 --> int >= -4
4579 if (RHS.isNegative())
4580 Pred = ICmpInst::ICMP_SGE;
4581 break;
4582 case ICmpInst::ICMP_UGE:
4583 // (float)int >= -4.4 --> true
4584 // (float)int >= 4.4 --> int > 4
Bob Wilson61f3ad52012-08-07 22:35:16 +00004585 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004586 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004587 Pred = ICmpInst::ICMP_UGT;
4588 break;
4589 case ICmpInst::ICMP_SGE:
4590 // (float)int >= -4.4 --> int >= -4
4591 // (float)int >= 4.4 --> int > 4
4592 if (!RHS.isNegative())
4593 Pred = ICmpInst::ICMP_SGT;
4594 break;
4595 }
4596 }
4597 }
4598
4599 // Lower this FP comparison into an appropriate integer version of the
4600 // comparison.
4601 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
4602}
4603
4604Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
4605 bool Changed = false;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004606
Chris Lattner2188e402010-01-04 07:37:31 +00004607 /// Orders the operands of the compare so that they are listed from most
4608 /// complex to least complex. This puts constants before unary operators,
4609 /// before binary operators.
4610 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
4611 I.swapOperands();
4612 Changed = true;
4613 }
4614
4615 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004616
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004617 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1,
Justin Bogner99798402016-08-05 01:06:44 +00004618 I.getFastMathFlags(), DL, &TLI, &DT, &AC, &I))
Sanjay Patel4b198802016-02-01 22:23:39 +00004619 return replaceInstUsesWith(I, V);
Chris Lattner2188e402010-01-04 07:37:31 +00004620
4621 // Simplify 'fcmp pred X, X'
4622 if (Op0 == Op1) {
4623 switch (I.getPredicate()) {
4624 default: llvm_unreachable("Unknown predicate!");
4625 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
4626 case FCmpInst::FCMP_ULT: // True if unordered or less than
4627 case FCmpInst::FCMP_UGT: // True if unordered or greater than
4628 case FCmpInst::FCMP_UNE: // True if unordered or not equal
4629 // Canonicalize these to be 'fcmp uno %X, 0.0'.
4630 I.setPredicate(FCmpInst::FCMP_UNO);
4631 I.setOperand(1, Constant::getNullValue(Op0->getType()));
4632 return &I;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004633
Chris Lattner2188e402010-01-04 07:37:31 +00004634 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
4635 case FCmpInst::FCMP_OEQ: // True if ordered and equal
4636 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
4637 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
4638 // Canonicalize these to be 'fcmp ord %X, 0.0'.
4639 I.setPredicate(FCmpInst::FCMP_ORD);
4640 I.setOperand(1, Constant::getNullValue(Op0->getType()));
4641 return &I;
4642 }
4643 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004644
James Molloy2b21a7c2015-05-20 18:41:25 +00004645 // Test if the FCmpInst instruction is used exclusively by a select as
4646 // part of a minimum or maximum operation. If so, refrain from doing
4647 // any other folding. This helps out other analyses which understand
4648 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
4649 // and CodeGen. And in this case, at least one of the comparison
4650 // operands has at least one user besides the compare (the select),
4651 // which would often largely negate the benefit of folding anyway.
4652 if (I.hasOneUse())
4653 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
4654 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
4655 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
4656 return nullptr;
4657
Chris Lattner2188e402010-01-04 07:37:31 +00004658 // Handle fcmp with constant RHS
4659 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
4660 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
4661 switch (LHSI->getOpcode()) {
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004662 case Instruction::FPExt: {
4663 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
4664 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
4665 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
4666 if (!RHSF)
4667 break;
4668
4669 const fltSemantics *Sem;
4670 // FIXME: This shouldn't be here.
Dan Gohman518cda42011-12-17 00:04:22 +00004671 if (LHSExt->getSrcTy()->isHalfTy())
4672 Sem = &APFloat::IEEEhalf;
4673 else if (LHSExt->getSrcTy()->isFloatTy())
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004674 Sem = &APFloat::IEEEsingle;
4675 else if (LHSExt->getSrcTy()->isDoubleTy())
4676 Sem = &APFloat::IEEEdouble;
4677 else if (LHSExt->getSrcTy()->isFP128Ty())
4678 Sem = &APFloat::IEEEquad;
4679 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
4680 Sem = &APFloat::x87DoubleExtended;
Ulrich Weigand6a9bb512012-10-30 12:33:18 +00004681 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
4682 Sem = &APFloat::PPCDoubleDouble;
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004683 else
4684 break;
4685
4686 bool Lossy;
4687 APFloat F = RHSF->getValueAPF();
4688 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
4689
Jim Grosbach24ff8342011-09-30 18:45:50 +00004690 // Avoid lossy conversions and denormals. Zero is a special case
4691 // that's OK to convert.
Jim Grosbach011dafb2011-09-30 19:58:46 +00004692 APFloat Fabs = F;
4693 Fabs.clearSign();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004694 if (!Lossy &&
Jim Grosbach011dafb2011-09-30 19:58:46 +00004695 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
4696 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbach24ff8342011-09-30 18:45:50 +00004697
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004698 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4699 ConstantFP::get(RHSC->getContext(), F));
4700 break;
4701 }
Chris Lattner2188e402010-01-04 07:37:31 +00004702 case Instruction::PHI:
4703 // Only fold fcmp into the PHI if the phi and fcmp are in the same
4704 // block. If in the same block, we're encouraging jump threading. If
4705 // not, we are just pessimizing the code by making an i1 phi.
4706 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00004707 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00004708 return NV;
4709 break;
4710 case Instruction::SIToFP:
4711 case Instruction::UIToFP:
Sanjay Patel43395062016-07-21 18:07:40 +00004712 if (Instruction *NV = foldFCmpIntToFPConst(I, LHSI, RHSC))
Chris Lattner2188e402010-01-04 07:37:31 +00004713 return NV;
4714 break;
Benjamin Kramera8c5d082011-03-31 10:12:15 +00004715 case Instruction::FSub: {
4716 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
4717 Value *Op;
4718 if (match(LHSI, m_FNeg(m_Value(Op))))
4719 return new FCmpInst(I.getSwappedPredicate(), Op,
4720 ConstantExpr::getFNeg(RHSC));
4721 break;
4722 }
Dan Gohman94732022010-02-24 06:46:09 +00004723 case Instruction::Load:
4724 if (GetElementPtrInst *GEP =
4725 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
4726 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
4727 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
4728 !cast<LoadInst>(LHSI)->isVolatile())
Sanjay Patel43395062016-07-21 18:07:40 +00004729 if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
Dan Gohman94732022010-02-24 06:46:09 +00004730 return Res;
4731 }
4732 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004733 case Instruction::Call: {
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004734 if (!RHSC->isNullValue())
4735 break;
4736
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004737 CallInst *CI = cast<CallInst>(LHSI);
Justin Bogner99798402016-08-05 01:06:44 +00004738 Intrinsic::ID IID = getIntrinsicForCallSite(CI, &TLI);
David Majnemer2e02ba72016-04-15 17:21:03 +00004739 if (IID != Intrinsic::fabs)
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004740 break;
4741
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004742 // Various optimization for fabs compared with zero.
David Majnemer2e02ba72016-04-15 17:21:03 +00004743 switch (I.getPredicate()) {
4744 default:
4745 break;
4746 // fabs(x) < 0 --> false
4747 case FCmpInst::FCMP_OLT:
4748 llvm_unreachable("handled by SimplifyFCmpInst");
4749 // fabs(x) > 0 --> x != 0
4750 case FCmpInst::FCMP_OGT:
4751 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0), RHSC);
4752 // fabs(x) <= 0 --> x == 0
4753 case FCmpInst::FCMP_OLE:
4754 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0), RHSC);
4755 // fabs(x) >= 0 --> !isnan(x)
4756 case FCmpInst::FCMP_OGE:
4757 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0), RHSC);
4758 // fabs(x) == 0 --> x == 0
4759 // fabs(x) != 0 --> x != 0
4760 case FCmpInst::FCMP_OEQ:
4761 case FCmpInst::FCMP_UEQ:
4762 case FCmpInst::FCMP_ONE:
4763 case FCmpInst::FCMP_UNE:
4764 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004765 }
4766 }
Chris Lattner2188e402010-01-04 07:37:31 +00004767 }
Chris Lattner2188e402010-01-04 07:37:31 +00004768 }
4769
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00004770 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramerd159d942011-03-31 10:12:22 +00004771 Value *X, *Y;
4772 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00004773 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramerd159d942011-03-31 10:12:22 +00004774
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00004775 // fcmp (fpext x), (fpext y) -> fcmp x, y
4776 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
4777 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
4778 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
4779 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4780 RHSExt->getOperand(0));
4781
Craig Topperf40110f2014-04-25 05:29:35 +00004782 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004783}