blob: 18036356c920d55dc32d6e5222b0d418ce2039dc [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
59/// AddWithOverflow - Compute Result = In1+In2, returning true if the result
60/// overflowed for this type.
61static 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
94/// SubWithOverflow - Compute Result = In1-In2, returning true if the result
95/// overflowed for this type.
96static 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
Chris Lattner2188e402010-01-04 07:37:31 +0000126/// isSignBitCheck - Given an exploded icmp instruction, return true if the
127/// comparison only checks the sign bit. If it only checks the sign bit, set
128/// TrueIfSigned if the result of the comparison is true when the input value is
129/// signed.
130static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
131 bool &TrueIfSigned) {
132 switch (pred) {
133 case ICmpInst::ICMP_SLT: // True if LHS s< 0
134 TrueIfSigned = true;
135 return RHS->isZero();
136 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
137 TrueIfSigned = true;
138 return RHS->isAllOnesValue();
139 case ICmpInst::ICMP_SGT: // True if LHS s> -1
140 TrueIfSigned = false;
141 return RHS->isAllOnesValue();
142 case ICmpInst::ICMP_UGT:
143 // True if LHS u> RHS and RHS == high-bit-mask - 1
144 TrueIfSigned = true;
Chris Lattnerb1a15122011-07-15 06:08:15 +0000145 return RHS->isMaxValue(true);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000146 case ICmpInst::ICMP_UGE:
Chris Lattner2188e402010-01-04 07:37:31 +0000147 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
148 TrueIfSigned = true;
149 return RHS->getValue().isSignBit();
150 default:
151 return false;
152 }
153}
154
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000155/// Returns true if the exploded icmp can be expressed as a signed comparison
156/// to zero and updates the predicate accordingly.
157/// The signedness of the comparison is preserved.
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000158static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
159 if (!ICmpInst::isSigned(pred))
160 return false;
161
162 if (RHS->isZero())
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000163 return ICmpInst::isRelational(pred);
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000164
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000165 if (RHS->isOne()) {
166 if (pred == ICmpInst::ICMP_SLT) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000167 pred = ICmpInst::ICMP_SLE;
168 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000169 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000170 } else if (RHS->isAllOnesValue()) {
171 if (pred == ICmpInst::ICMP_SGT) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000172 pred = ICmpInst::ICMP_SGE;
173 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
Chris Lattner2188e402010-01-04 07:37:31 +0000180// isHighOnes - Return true if the constant is of the form 1+0+.
181// This is the same as lowones(~X).
182static bool isHighOnes(const ConstantInt *CI) {
183 return (~CI->getValue() + 1).isPowerOf2();
184}
185
Jim Grosbach129c52a2011-09-30 18:09:53 +0000186/// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
Chris Lattner2188e402010-01-04 07:37:31 +0000187/// set of known zero and one bits, compute the maximum and minimum values that
188/// could have the specified known zero and known one bits, returning them in
189/// min/max.
190static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
191 const APInt& KnownOne,
192 APInt& Min, APInt& Max) {
193 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
194 KnownZero.getBitWidth() == Min.getBitWidth() &&
195 KnownZero.getBitWidth() == Max.getBitWidth() &&
196 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
197 APInt UnknownBits = ~(KnownZero|KnownOne);
198
199 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
200 // bit if it is unknown.
201 Min = KnownOne;
202 Max = KnownOne|UnknownBits;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000203
Chris Lattner2188e402010-01-04 07:37:31 +0000204 if (UnknownBits.isNegative()) { // Sign bit is unknown
Jay Foad25a5e4c2010-12-01 08:53:58 +0000205 Min.setBit(Min.getBitWidth()-1);
206 Max.clearBit(Max.getBitWidth()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000207 }
208}
209
210// ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
211// a set of known zero and one bits, compute the maximum and minimum values that
212// could have the specified known zero and known one bits, returning them in
213// min/max.
214static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
215 const APInt &KnownOne,
216 APInt &Min, APInt &Max) {
217 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
218 KnownZero.getBitWidth() == Min.getBitWidth() &&
219 KnownZero.getBitWidth() == Max.getBitWidth() &&
220 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
221 APInt UnknownBits = ~(KnownZero|KnownOne);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000222
Chris Lattner2188e402010-01-04 07:37:31 +0000223 // The minimum value is when the unknown bits are all zeros.
224 Min = KnownOne;
225 // The maximum value is when the unknown bits are all ones.
226 Max = KnownOne|UnknownBits;
227}
228
Chris Lattner2188e402010-01-04 07:37:31 +0000229/// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
230/// cmp pred (load (gep GV, ...)), cmpcst
231/// where GV is a global variable with a constant initializer. Try to simplify
232/// this into some simple computation that does not need the load. For example
233/// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
234///
235/// If AndCst is non-null, then the loaded value is masked with that constant
236/// before doing the comparison. This handles cases like "A[i]&4 == 0".
237Instruction *InstCombiner::
238FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
239 CmpInst &ICI, ConstantInt *AndCst) {
Chris Lattnerfe741762012-01-31 02:55:06 +0000240 Constant *Init = GV->getInitializer();
241 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
Craig Topperf40110f2014-04-25 05:29:35 +0000242 return nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000243
Chris Lattnerfe741762012-01-31 02:55:06 +0000244 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
Craig Topperf40110f2014-04-25 05:29:35 +0000245 if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000246
Chris Lattner2188e402010-01-04 07:37:31 +0000247 // There are many forms of this optimization we can handle, for now, just do
248 // the simple index into a single-dimensional array.
249 //
250 // Require: GEP GV, 0, i {{, constant indices}}
251 if (GEP->getNumOperands() < 3 ||
252 !isa<ConstantInt>(GEP->getOperand(1)) ||
253 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
254 isa<Constant>(GEP->getOperand(2)))
Craig Topperf40110f2014-04-25 05:29:35 +0000255 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000256
257 // Check that indices after the variable are constants and in-range for the
258 // type they index. Collect the indices. This is typically for arrays of
259 // structs.
260 SmallVector<unsigned, 4> LaterIndices;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000261
Chris Lattnerfe741762012-01-31 02:55:06 +0000262 Type *EltTy = Init->getType()->getArrayElementType();
Chris Lattner2188e402010-01-04 07:37:31 +0000263 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
264 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000265 if (!Idx) return nullptr; // Variable index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000266
Chris Lattner2188e402010-01-04 07:37:31 +0000267 uint64_t IdxVal = Idx->getZExtValue();
Craig Topperf40110f2014-04-25 05:29:35 +0000268 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000269
Chris Lattner229907c2011-07-18 04:54:35 +0000270 if (StructType *STy = dyn_cast<StructType>(EltTy))
Chris Lattner2188e402010-01-04 07:37:31 +0000271 EltTy = STy->getElementType(IdxVal);
Chris Lattner229907c2011-07-18 04:54:35 +0000272 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
Craig Topperf40110f2014-04-25 05:29:35 +0000273 if (IdxVal >= ATy->getNumElements()) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000274 EltTy = ATy->getElementType();
275 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000276 return nullptr; // Unknown type.
Chris Lattner2188e402010-01-04 07:37:31 +0000277 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000278
Chris Lattner2188e402010-01-04 07:37:31 +0000279 LaterIndices.push_back(IdxVal);
280 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000281
Chris Lattner2188e402010-01-04 07:37:31 +0000282 enum { Overdefined = -3, Undefined = -2 };
283
284 // Variables for our state machines.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000285
Chris Lattner2188e402010-01-04 07:37:31 +0000286 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
287 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
288 // and 87 is the second (and last) index. FirstTrueElement is -2 when
289 // undefined, otherwise set to the first true element. SecondTrueElement is
290 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
291 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
292
293 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
294 // form "i != 47 & i != 87". Same state transitions as for true elements.
295 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000296
Chris Lattner2188e402010-01-04 07:37:31 +0000297 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
298 /// define a state machine that triggers for ranges of values that the index
299 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
300 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
301 /// index in the range (inclusive). We use -2 for undefined here because we
302 /// use relative comparisons and don't want 0-1 to match -1.
303 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000304
Chris Lattner2188e402010-01-04 07:37:31 +0000305 // MagicBitvector - This is a magic bitvector where we set a bit if the
306 // comparison is true for element 'i'. If there are 64 elements or less in
307 // the array, this will fully represent all the comparison results.
308 uint64_t MagicBitvector = 0;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000309
Chris Lattner2188e402010-01-04 07:37:31 +0000310 // Scan the array and see if one of our patterns matches.
311 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
Chris Lattnerfe741762012-01-31 02:55:06 +0000312 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
313 Constant *Elt = Init->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +0000314 if (!Elt) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000315
Chris Lattner2188e402010-01-04 07:37:31 +0000316 // If this is indexing an array of structures, get the structure element.
317 if (!LaterIndices.empty())
Jay Foad57aa6362011-07-13 10:26:04 +0000318 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000319
Chris Lattner2188e402010-01-04 07:37:31 +0000320 // If the element is masked, handle it.
321 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000322
Chris Lattner2188e402010-01-04 07:37:31 +0000323 // Find out if the comparison would be true or false for the i'th element.
324 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000325 CompareRHS, DL, TLI);
Chris Lattner2188e402010-01-04 07:37:31 +0000326 // If the result is undef for this element, ignore it.
327 if (isa<UndefValue>(C)) {
328 // Extend range state machines to cover this element in case there is an
329 // undef in the middle of the range.
330 if (TrueRangeEnd == (int)i-1)
331 TrueRangeEnd = i;
332 if (FalseRangeEnd == (int)i-1)
333 FalseRangeEnd = i;
334 continue;
335 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000336
Chris Lattner2188e402010-01-04 07:37:31 +0000337 // If we can't compute the result for any of the elements, we have to give
338 // up evaluating the entire conditional.
Craig Topperf40110f2014-04-25 05:29:35 +0000339 if (!isa<ConstantInt>(C)) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000340
Chris Lattner2188e402010-01-04 07:37:31 +0000341 // Otherwise, we know if the comparison is true or false for this element,
342 // update our state machines.
343 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000344
Chris Lattner2188e402010-01-04 07:37:31 +0000345 // State machine for single/double/range index comparison.
346 if (IsTrueForElt) {
347 // Update the TrueElement state machine.
348 if (FirstTrueElement == Undefined)
349 FirstTrueElement = TrueRangeEnd = i; // First true element.
350 else {
351 // Update double-compare state machine.
352 if (SecondTrueElement == Undefined)
353 SecondTrueElement = i;
354 else
355 SecondTrueElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000356
Chris Lattner2188e402010-01-04 07:37:31 +0000357 // Update range state machine.
358 if (TrueRangeEnd == (int)i-1)
359 TrueRangeEnd = i;
360 else
361 TrueRangeEnd = Overdefined;
362 }
363 } else {
364 // Update the FalseElement state machine.
365 if (FirstFalseElement == Undefined)
366 FirstFalseElement = FalseRangeEnd = i; // First false element.
367 else {
368 // Update double-compare state machine.
369 if (SecondFalseElement == Undefined)
370 SecondFalseElement = i;
371 else
372 SecondFalseElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000373
Chris Lattner2188e402010-01-04 07:37:31 +0000374 // Update range state machine.
375 if (FalseRangeEnd == (int)i-1)
376 FalseRangeEnd = i;
377 else
378 FalseRangeEnd = Overdefined;
379 }
380 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000381
Chris Lattner2188e402010-01-04 07:37:31 +0000382 // If this element is in range, update our magic bitvector.
383 if (i < 64 && IsTrueForElt)
384 MagicBitvector |= 1ULL << i;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000385
Chris Lattner2188e402010-01-04 07:37:31 +0000386 // If all of our states become overdefined, bail out early. Since the
387 // predicate is expensive, only check it every 8 elements. This is only
388 // really useful for really huge arrays.
389 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
390 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
391 FalseRangeEnd == Overdefined)
Craig Topperf40110f2014-04-25 05:29:35 +0000392 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000393 }
394
395 // Now that we've scanned the entire array, emit our new comparison(s). We
396 // order the state machines in complexity of the generated code.
397 Value *Idx = GEP->getOperand(2);
398
Matt Arsenault5aeae182013-08-19 21:40:31 +0000399 // If the index is larger than the pointer size of the target, truncate the
400 // index down like the GEP would do implicitly. We don't have to do this for
401 // an inbounds GEP because the index can't be out of range.
Matt Arsenault84680622013-09-30 21:11:01 +0000402 if (!GEP->isInBounds()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000403 Type *IntPtrTy = DL.getIntPtrType(GEP->getType());
Matt Arsenault84680622013-09-30 21:11:01 +0000404 unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
405 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
406 Idx = Builder->CreateTrunc(Idx, IntPtrTy);
407 }
Matt Arsenault5aeae182013-08-19 21:40:31 +0000408
Chris Lattner2188e402010-01-04 07:37:31 +0000409 // If the comparison is only true for one or two elements, emit direct
410 // comparisons.
411 if (SecondTrueElement != Overdefined) {
412 // None true -> false.
413 if (FirstTrueElement == Undefined)
Sanjay Patel4b198802016-02-01 22:23:39 +0000414 return replaceInstUsesWith(ICI, Builder->getFalse());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000415
Chris Lattner2188e402010-01-04 07:37:31 +0000416 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000417
Chris Lattner2188e402010-01-04 07:37:31 +0000418 // True for one element -> 'i == 47'.
419 if (SecondTrueElement == Undefined)
420 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000421
Chris Lattner2188e402010-01-04 07:37:31 +0000422 // True for two elements -> 'i == 47 | i == 72'.
423 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
424 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
425 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
426 return BinaryOperator::CreateOr(C1, C2);
427 }
428
429 // If the comparison is only false for one or two elements, emit direct
430 // comparisons.
431 if (SecondFalseElement != Overdefined) {
432 // None false -> true.
433 if (FirstFalseElement == Undefined)
Sanjay Patel4b198802016-02-01 22:23:39 +0000434 return replaceInstUsesWith(ICI, Builder->getTrue());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000435
Chris Lattner2188e402010-01-04 07:37:31 +0000436 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
437
438 // False for one element -> 'i != 47'.
439 if (SecondFalseElement == Undefined)
440 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000441
Chris Lattner2188e402010-01-04 07:37:31 +0000442 // False for two elements -> 'i != 47 & i != 72'.
443 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
444 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
445 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
446 return BinaryOperator::CreateAnd(C1, C2);
447 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000448
Chris Lattner2188e402010-01-04 07:37:31 +0000449 // If the comparison can be replaced with a range comparison for the elements
450 // where it is true, emit the range check.
451 if (TrueRangeEnd != Overdefined) {
452 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
Jim Grosbach129c52a2011-09-30 18:09:53 +0000453
Chris Lattner2188e402010-01-04 07:37:31 +0000454 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
455 if (FirstTrueElement) {
456 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
457 Idx = Builder->CreateAdd(Idx, Offs);
458 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000459
Chris Lattner2188e402010-01-04 07:37:31 +0000460 Value *End = ConstantInt::get(Idx->getType(),
461 TrueRangeEnd-FirstTrueElement+1);
462 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
463 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000464
Chris Lattner2188e402010-01-04 07:37:31 +0000465 // False range check.
466 if (FalseRangeEnd != Overdefined) {
467 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
468 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
469 if (FirstFalseElement) {
470 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
471 Idx = Builder->CreateAdd(Idx, Offs);
472 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000473
Chris Lattner2188e402010-01-04 07:37:31 +0000474 Value *End = ConstantInt::get(Idx->getType(),
475 FalseRangeEnd-FirstFalseElement);
476 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
477 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000478
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000479 // If a magic bitvector captures the entire comparison state
Chris Lattner2188e402010-01-04 07:37:31 +0000480 // of this load, replace it with computation that does:
481 // ((magic_cst >> i) & 1) != 0
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000482 {
Craig Topperf40110f2014-04-25 05:29:35 +0000483 Type *Ty = nullptr;
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000484
485 // Look for an appropriate type:
486 // - The type of Idx if the magic fits
487 // - The smallest fitting legal type if we have a DataLayout
488 // - Default to i32
489 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
490 Ty = Idx->getType();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000491 else
492 Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000493
Craig Topperf40110f2014-04-25 05:29:35 +0000494 if (Ty) {
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000495 Value *V = Builder->CreateIntCast(Idx, Ty, false);
496 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
497 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
498 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
499 }
Chris Lattner2188e402010-01-04 07:37:31 +0000500 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000501
Craig Topperf40110f2014-04-25 05:29:35 +0000502 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000503}
504
Chris Lattner2188e402010-01-04 07:37:31 +0000505/// EvaluateGEPOffsetExpression - Return a value that can be used to compare
506/// the *offset* implied by a GEP to zero. For example, if we have &A[i], we
507/// want to return 'i' for "icmp ne i, 0". Note that, in general, indices can
508/// be complex, and scales are involved. The above expression would also be
509/// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
510/// This later form is less amenable to optimization though, and we are allowed
511/// to generate the first by knowing that pointer arithmetic doesn't overflow.
512///
513/// If we can't emit an optimized form for this expression, this returns null.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000514///
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000515static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC,
516 const DataLayout &DL) {
Chris Lattner2188e402010-01-04 07:37:31 +0000517 gep_type_iterator GTI = gep_type_begin(GEP);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000518
Chris Lattner2188e402010-01-04 07:37:31 +0000519 // Check to see if this gep only has a single variable index. If so, and if
520 // any constant indices are a multiple of its scale, then we can compute this
521 // in terms of the scale of the variable index. For example, if the GEP
522 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
523 // because the expression will cross zero at the same point.
524 unsigned i, e = GEP->getNumOperands();
525 int64_t Offset = 0;
526 for (i = 1; i != e; ++i, ++GTI) {
527 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
528 // Compute the aggregate offset of constant indices.
529 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000530
Chris Lattner2188e402010-01-04 07:37:31 +0000531 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000532 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000533 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000534 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000535 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000536 Offset += Size*CI->getSExtValue();
537 }
538 } else {
539 // Found our variable index.
540 break;
541 }
542 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000543
Chris Lattner2188e402010-01-04 07:37:31 +0000544 // If there are no variable indices, we must have a constant offset, just
545 // evaluate it the general way.
Craig Topperf40110f2014-04-25 05:29:35 +0000546 if (i == e) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000547
Chris Lattner2188e402010-01-04 07:37:31 +0000548 Value *VariableIdx = GEP->getOperand(i);
549 // Determine the scale factor of the variable element. For example, this is
550 // 4 if the variable index is into an array of i32.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000551 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000552
Chris Lattner2188e402010-01-04 07:37:31 +0000553 // Verify that there are no other variable indices. If so, emit the hard way.
554 for (++i, ++GTI; i != e; ++i, ++GTI) {
555 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000556 if (!CI) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000557
Chris Lattner2188e402010-01-04 07:37:31 +0000558 // Compute the aggregate offset of constant indices.
559 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000560
Chris Lattner2188e402010-01-04 07:37:31 +0000561 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000562 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000563 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000564 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000565 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000566 Offset += Size*CI->getSExtValue();
567 }
568 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000569
Chris Lattner2188e402010-01-04 07:37:31 +0000570 // Okay, we know we have a single variable index, which must be a
571 // pointer/array/vector index. If there is no offset, life is simple, return
572 // the index.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000573 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
Matt Arsenault745101d2013-08-21 19:53:10 +0000574 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
Chris Lattner2188e402010-01-04 07:37:31 +0000575 if (Offset == 0) {
576 // Cast to intptrty in case a truncation occurs. If an extension is needed,
577 // we don't need to bother extending: the extension won't affect where the
578 // computation crosses zero.
Eli Friedman1754a252011-05-18 23:11:30 +0000579 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
Eli Friedman1754a252011-05-18 23:11:30 +0000580 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
581 }
Chris Lattner2188e402010-01-04 07:37:31 +0000582 return VariableIdx;
583 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000584
Chris Lattner2188e402010-01-04 07:37:31 +0000585 // Otherwise, there is an index. The computation we will do will be modulo
586 // the pointer size, so get it.
587 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000588
Chris Lattner2188e402010-01-04 07:37:31 +0000589 Offset &= PtrSizeMask;
590 VariableScale &= PtrSizeMask;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000591
Chris Lattner2188e402010-01-04 07:37:31 +0000592 // To do this transformation, any constant index must be a multiple of the
593 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
594 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
595 // multiple of the variable scale.
596 int64_t NewOffs = Offset / (int64_t)VariableScale;
597 if (Offset != NewOffs*(int64_t)VariableScale)
Craig Topperf40110f2014-04-25 05:29:35 +0000598 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000599
Chris Lattner2188e402010-01-04 07:37:31 +0000600 // Okay, we can do this evaluation. Start by converting the index to intptr.
Chris Lattner2188e402010-01-04 07:37:31 +0000601 if (VariableIdx->getType() != IntPtrTy)
Eli Friedman1754a252011-05-18 23:11:30 +0000602 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
603 true /*Signed*/);
Chris Lattner2188e402010-01-04 07:37:31 +0000604 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
Eli Friedman1754a252011-05-18 23:11:30 +0000605 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
Chris Lattner2188e402010-01-04 07:37:31 +0000606}
607
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000608/// Returns true if we can rewrite Start as a GEP with pointer Base
609/// and some integer offset. The nodes that need to be re-written
610/// for this transformation will be added to Explored.
611static bool canRewriteGEPAsOffset(Value *Start, Value *Base,
612 const DataLayout &DL,
613 SetVector<Value *> &Explored) {
614 SmallVector<Value *, 16> WorkList(1, Start);
615 Explored.insert(Base);
616
617 // The following traversal gives us an order which can be used
618 // when doing the final transformation. Since in the final
619 // transformation we create the PHI replacement instructions first,
620 // we don't have to get them in any particular order.
621 //
622 // However, for other instructions we will have to traverse the
623 // operands of an instruction first, which means that we have to
624 // do a post-order traversal.
625 while (!WorkList.empty()) {
626 SetVector<PHINode *> PHIs;
627
628 while (!WorkList.empty()) {
629 if (Explored.size() >= 100)
630 return false;
631
632 Value *V = WorkList.back();
633
634 if (Explored.count(V) != 0) {
635 WorkList.pop_back();
636 continue;
637 }
638
639 if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) &&
640 !isa<GEPOperator>(V) && !isa<PHINode>(V))
641 // We've found some value that we can't explore which is different from
642 // the base. Therefore we can't do this transformation.
643 return false;
644
645 if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) {
646 auto *CI = dyn_cast<CastInst>(V);
647 if (!CI->isNoopCast(DL))
648 return false;
649
650 if (Explored.count(CI->getOperand(0)) == 0)
651 WorkList.push_back(CI->getOperand(0));
652 }
653
654 if (auto *GEP = dyn_cast<GEPOperator>(V)) {
655 // We're limiting the GEP to having one index. This will preserve
656 // the original pointer type. We could handle more cases in the
657 // future.
658 if (GEP->getNumIndices() != 1 || !GEP->isInBounds() ||
659 GEP->getType() != Start->getType())
660 return false;
661
662 if (Explored.count(GEP->getOperand(0)) == 0)
663 WorkList.push_back(GEP->getOperand(0));
664 }
665
666 if (WorkList.back() == V) {
667 WorkList.pop_back();
668 // We've finished visiting this node, mark it as such.
669 Explored.insert(V);
670 }
671
672 if (auto *PN = dyn_cast<PHINode>(V)) {
David Majnemercdf28732016-03-19 04:39:52 +0000673 // We cannot transform PHIs on unsplittable basic blocks.
674 if (isa<CatchSwitchInst>(PN->getParent()->getTerminator()))
675 return false;
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000676 Explored.insert(PN);
677 PHIs.insert(PN);
678 }
679 }
680
681 // Explore the PHI nodes further.
682 for (auto *PN : PHIs)
683 for (Value *Op : PN->incoming_values())
684 if (Explored.count(Op) == 0)
685 WorkList.push_back(Op);
686 }
687
688 // Make sure that we can do this. Since we can't insert GEPs in a basic
689 // block before a PHI node, we can't easily do this transformation if
690 // we have PHI node users of transformed instructions.
691 for (Value *Val : Explored) {
692 for (Value *Use : Val->uses()) {
693
694 auto *PHI = dyn_cast<PHINode>(Use);
695 auto *Inst = dyn_cast<Instruction>(Val);
696
697 if (Inst == Base || Inst == PHI || !Inst || !PHI ||
698 Explored.count(PHI) == 0)
699 continue;
700
701 if (PHI->getParent() == Inst->getParent())
702 return false;
703 }
704 }
705 return true;
706}
707
708// Sets the appropriate insert point on Builder where we can add
709// a replacement Instruction for V (if that is possible).
710static void setInsertionPoint(IRBuilder<> &Builder, Value *V,
711 bool Before = true) {
712 if (auto *PHI = dyn_cast<PHINode>(V)) {
713 Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt());
714 return;
715 }
716 if (auto *I = dyn_cast<Instruction>(V)) {
717 if (!Before)
718 I = &*std::next(I->getIterator());
719 Builder.SetInsertPoint(I);
720 return;
721 }
722 if (auto *A = dyn_cast<Argument>(V)) {
723 // Set the insertion point in the entry block.
724 BasicBlock &Entry = A->getParent()->getEntryBlock();
725 Builder.SetInsertPoint(&*Entry.getFirstInsertionPt());
726 return;
727 }
728 // Otherwise, this is a constant and we don't need to set a new
729 // insertion point.
730 assert(isa<Constant>(V) && "Setting insertion point for unknown value!");
731}
732
733/// Returns a re-written value of Start as an indexed GEP using Base as a
734/// pointer.
735static Value *rewriteGEPAsOffset(Value *Start, Value *Base,
736 const DataLayout &DL,
737 SetVector<Value *> &Explored) {
738 // Perform all the substitutions. This is a bit tricky because we can
739 // have cycles in our use-def chains.
740 // 1. Create the PHI nodes without any incoming values.
741 // 2. Create all the other values.
742 // 3. Add the edges for the PHI nodes.
743 // 4. Emit GEPs to get the original pointers.
744 // 5. Remove the original instructions.
745 Type *IndexType = IntegerType::get(
746 Base->getContext(), DL.getPointerTypeSizeInBits(Start->getType()));
747
748 DenseMap<Value *, Value *> NewInsts;
749 NewInsts[Base] = ConstantInt::getNullValue(IndexType);
750
751 // Create the new PHI nodes, without adding any incoming values.
752 for (Value *Val : Explored) {
753 if (Val == Base)
754 continue;
755 // Create empty phi nodes. This avoids cyclic dependencies when creating
756 // the remaining instructions.
757 if (auto *PHI = dyn_cast<PHINode>(Val))
758 NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(),
759 PHI->getName() + ".idx", PHI);
760 }
761 IRBuilder<> Builder(Base->getContext());
762
763 // Create all the other instructions.
764 for (Value *Val : Explored) {
765
766 if (NewInsts.find(Val) != NewInsts.end())
767 continue;
768
769 if (auto *CI = dyn_cast<CastInst>(Val)) {
770 NewInsts[CI] = NewInsts[CI->getOperand(0)];
771 continue;
772 }
773 if (auto *GEP = dyn_cast<GEPOperator>(Val)) {
774 Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)]
775 : GEP->getOperand(1);
776 setInsertionPoint(Builder, GEP);
777 // Indices might need to be sign extended. GEPs will magically do
778 // this, but we need to do it ourselves here.
779 if (Index->getType()->getScalarSizeInBits() !=
780 NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) {
781 Index = Builder.CreateSExtOrTrunc(
782 Index, NewInsts[GEP->getOperand(0)]->getType(),
783 GEP->getOperand(0)->getName() + ".sext");
784 }
785
786 auto *Op = NewInsts[GEP->getOperand(0)];
787 if (isa<ConstantInt>(Op) && dyn_cast<ConstantInt>(Op)->isZero())
788 NewInsts[GEP] = Index;
789 else
790 NewInsts[GEP] = Builder.CreateNSWAdd(
791 Op, Index, GEP->getOperand(0)->getName() + ".add");
792 continue;
793 }
794 if (isa<PHINode>(Val))
795 continue;
796
797 llvm_unreachable("Unexpected instruction type");
798 }
799
800 // Add the incoming values to the PHI nodes.
801 for (Value *Val : Explored) {
802 if (Val == Base)
803 continue;
804 // All the instructions have been created, we can now add edges to the
805 // phi nodes.
806 if (auto *PHI = dyn_cast<PHINode>(Val)) {
807 PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]);
808 for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) {
809 Value *NewIncoming = PHI->getIncomingValue(I);
810
811 if (NewInsts.find(NewIncoming) != NewInsts.end())
812 NewIncoming = NewInsts[NewIncoming];
813
814 NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I));
815 }
816 }
817 }
818
819 for (Value *Val : Explored) {
820 if (Val == Base)
821 continue;
822
823 // Depending on the type, for external users we have to emit
824 // a GEP or a GEP + ptrtoint.
825 setInsertionPoint(Builder, Val, false);
826
827 // If required, create an inttoptr instruction for Base.
828 Value *NewBase = Base;
829 if (!Base->getType()->isPointerTy())
830 NewBase = Builder.CreateBitOrPointerCast(Base, Start->getType(),
831 Start->getName() + "to.ptr");
832
833 Value *GEP = Builder.CreateInBoundsGEP(
834 Start->getType()->getPointerElementType(), NewBase,
835 makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr");
836
837 if (!Val->getType()->isPointerTy()) {
838 Value *Cast = Builder.CreatePointerCast(GEP, Val->getType(),
839 Val->getName() + ".conv");
840 GEP = Cast;
841 }
842 Val->replaceAllUsesWith(GEP);
843 }
844
845 return NewInsts[Start];
846}
847
848/// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express
849/// the input Value as a constant indexed GEP. Returns a pair containing
850/// the GEPs Pointer and Index.
851static std::pair<Value *, Value *>
852getAsConstantIndexedAddress(Value *V, const DataLayout &DL) {
853 Type *IndexType = IntegerType::get(V->getContext(),
854 DL.getPointerTypeSizeInBits(V->getType()));
855
856 Constant *Index = ConstantInt::getNullValue(IndexType);
857 while (true) {
858 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
859 // We accept only inbouds GEPs here to exclude the possibility of
860 // overflow.
861 if (!GEP->isInBounds())
862 break;
863 if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 &&
864 GEP->getType() == V->getType()) {
865 V = GEP->getOperand(0);
866 Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1));
867 Index = ConstantExpr::getAdd(
868 Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType));
869 continue;
870 }
871 break;
872 }
873 if (auto *CI = dyn_cast<IntToPtrInst>(V)) {
874 if (!CI->isNoopCast(DL))
875 break;
876 V = CI->getOperand(0);
877 continue;
878 }
879 if (auto *CI = dyn_cast<PtrToIntInst>(V)) {
880 if (!CI->isNoopCast(DL))
881 break;
882 V = CI->getOperand(0);
883 continue;
884 }
885 break;
886 }
887 return {V, Index};
888}
889
890// Converts (CMP GEPLHS, RHS) if this change would make RHS a constant.
891// We can look through PHIs, GEPs and casts in order to determine a
892// common base between GEPLHS and RHS.
893static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS,
894 ICmpInst::Predicate Cond,
895 const DataLayout &DL) {
896 if (!GEPLHS->hasAllConstantIndices())
897 return nullptr;
898
899 Value *PtrBase, *Index;
900 std::tie(PtrBase, Index) = getAsConstantIndexedAddress(GEPLHS, DL);
901
902 // The set of nodes that will take part in this transformation.
903 SetVector<Value *> Nodes;
904
905 if (!canRewriteGEPAsOffset(RHS, PtrBase, DL, Nodes))
906 return nullptr;
907
908 // We know we can re-write this as
909 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)
910 // Since we've only looked through inbouds GEPs we know that we
911 // can't have overflow on either side. We can therefore re-write
912 // this as:
913 // OFFSET1 cmp OFFSET2
914 Value *NewRHS = rewriteGEPAsOffset(RHS, PtrBase, DL, Nodes);
915
916 // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written
917 // GEP having PtrBase as the pointer base, and has returned in NewRHS the
918 // offset. Since Index is the offset of LHS to the base pointer, we will now
919 // compare the offsets instead of comparing the pointers.
920 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS);
921}
922
Chris Lattner2188e402010-01-04 07:37:31 +0000923/// FoldGEPICmp - Fold comparisons between a GEP instruction and something
924/// else. At this point we know that the GEP is on the LHS of the comparison.
925Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
926 ICmpInst::Predicate Cond,
927 Instruction &I) {
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000928 // Don't transform signed compares of GEPs into index compares. Even if the
929 // GEP is inbounds, the final add of the base pointer can have signed overflow
930 // and would change the result of the icmp.
931 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
Benjamin Kramerc7a22fe2012-02-21 13:40:06 +0000932 // the maximum signed value for the pointer type.
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000933 if (ICmpInst::isSigned(Cond))
Craig Topperf40110f2014-04-25 05:29:35 +0000934 return nullptr;
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000935
Matt Arsenault44f60d02014-06-09 19:20:29 +0000936 // Look through bitcasts and addrspacecasts. We do not however want to remove
937 // 0 GEPs.
938 if (!isa<GetElementPtrInst>(RHS))
939 RHS = RHS->stripPointerCasts();
Chris Lattner2188e402010-01-04 07:37:31 +0000940
941 Value *PtrBase = GEPLHS->getOperand(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000942 if (PtrBase == RHS && GEPLHS->isInBounds()) {
Chris Lattner2188e402010-01-04 07:37:31 +0000943 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
944 // This transformation (ignoring the base and scales) is valid because we
945 // know pointers can't overflow since the gep is inbounds. See if we can
946 // output an optimized form.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000947 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this, DL);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000948
Chris Lattner2188e402010-01-04 07:37:31 +0000949 // If not, synthesize the offset the hard way.
Craig Topperf40110f2014-04-25 05:29:35 +0000950 if (!Offset)
Chris Lattner2188e402010-01-04 07:37:31 +0000951 Offset = EmitGEPOffset(GEPLHS);
952 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
953 Constant::getNullValue(Offset->getType()));
954 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
955 // If the base pointers are different, but the indices are the same, just
956 // compare the base pointer.
957 if (PtrBase != GEPRHS->getOperand(0)) {
958 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
959 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
960 GEPRHS->getOperand(0)->getType();
961 if (IndicesTheSame)
962 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
963 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
964 IndicesTheSame = false;
965 break;
966 }
967
968 // If all indices are the same, just compare the base pointers.
969 if (IndicesTheSame)
David Majnemer5953d372013-06-29 10:28:04 +0000970 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +0000971
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000972 // If we're comparing GEPs with two base pointers that only differ in type
973 // and both GEPs have only constant indices or just one use, then fold
974 // the compare with the adjusted indices.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000975 if (GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000976 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
977 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
978 PtrBase->stripPointerCasts() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000979 GEPRHS->getOperand(0)->stripPointerCasts()) {
Matt Arsenault44f60d02014-06-09 19:20:29 +0000980 Value *LOffset = EmitGEPOffset(GEPLHS);
981 Value *ROffset = EmitGEPOffset(GEPRHS);
982
983 // If we looked through an addrspacecast between different sized address
984 // spaces, the LHS and RHS pointers are different sized
985 // integers. Truncate to the smaller one.
986 Type *LHSIndexTy = LOffset->getType();
987 Type *RHSIndexTy = ROffset->getType();
988 if (LHSIndexTy != RHSIndexTy) {
989 if (LHSIndexTy->getPrimitiveSizeInBits() <
990 RHSIndexTy->getPrimitiveSizeInBits()) {
991 ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy);
992 } else
993 LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy);
994 }
995
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000996 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
Matt Arsenault44f60d02014-06-09 19:20:29 +0000997 LOffset, ROffset);
Sanjay Patel4b198802016-02-01 22:23:39 +0000998 return replaceInstUsesWith(I, Cmp);
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000999 }
1000
Chris Lattner2188e402010-01-04 07:37:31 +00001001 // Otherwise, the base pointers are different and the indices are
Silviu Barangaf29dfd32016-01-15 15:52:05 +00001002 // different. Try convert this to an indexed compare by looking through
1003 // PHIs/casts.
1004 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
Chris Lattner2188e402010-01-04 07:37:31 +00001005 }
1006
1007 // If one of the GEPs has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +00001008 if (GEPLHS->hasAllZeroIndices())
Chris Lattner2188e402010-01-04 07:37:31 +00001009 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
David Majnemer92a8a7d2013-06-29 09:45:35 +00001010 ICmpInst::getSwappedPredicate(Cond), I);
Chris Lattner2188e402010-01-04 07:37:31 +00001011
1012 // If the other GEP has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +00001013 if (GEPRHS->hasAllZeroIndices())
Chris Lattner2188e402010-01-04 07:37:31 +00001014 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
1015
Stuart Hastings66a82b92011-05-14 05:55:10 +00001016 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
Chris Lattner2188e402010-01-04 07:37:31 +00001017 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
1018 // If the GEPs only differ by one index, compare it.
1019 unsigned NumDifferences = 0; // Keep track of # differences.
1020 unsigned DiffOperand = 0; // The operand that differs.
1021 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
1022 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
1023 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
1024 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
1025 // Irreconcilable differences.
1026 NumDifferences = 2;
1027 break;
1028 } else {
1029 if (NumDifferences++) break;
1030 DiffOperand = i;
1031 }
1032 }
1033
Rafael Espindolaa7bbc0b2013-06-06 17:03:05 +00001034 if (NumDifferences == 0) // SAME GEP?
Sanjay Patel4b198802016-02-01 22:23:39 +00001035 return replaceInstUsesWith(I, // No comparison is needed here.
Jakub Staszakbddea112013-06-06 20:18:46 +00001036 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
Chris Lattner2188e402010-01-04 07:37:31 +00001037
Stuart Hastings66a82b92011-05-14 05:55:10 +00001038 else if (NumDifferences == 1 && GEPsInBounds) {
Chris Lattner2188e402010-01-04 07:37:31 +00001039 Value *LHSV = GEPLHS->getOperand(DiffOperand);
1040 Value *RHSV = GEPRHS->getOperand(DiffOperand);
1041 // Make sure we do a signed comparison here.
1042 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
1043 }
1044 }
1045
1046 // Only lower this if the icmp is the only user of the GEP or if we expect
1047 // the result to fold to a constant!
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001048 if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
Chris Lattner2188e402010-01-04 07:37:31 +00001049 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
1050 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
1051 Value *L = EmitGEPOffset(GEPLHS);
1052 Value *R = EmitGEPOffset(GEPRHS);
1053 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
1054 }
1055 }
Silviu Barangaf29dfd32016-01-15 15:52:05 +00001056
1057 // Try convert this to an indexed compare by looking through PHIs/casts as a
1058 // last resort.
1059 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
Chris Lattner2188e402010-01-04 07:37:31 +00001060}
1061
Hans Wennborgf1f36512015-10-07 00:20:07 +00001062Instruction *InstCombiner::FoldAllocaCmp(ICmpInst &ICI, AllocaInst *Alloca,
1063 Value *Other) {
1064 assert(ICI.isEquality() && "Cannot fold non-equality comparison.");
1065
1066 // It would be tempting to fold away comparisons between allocas and any
1067 // pointer not based on that alloca (e.g. an argument). However, even
1068 // though such pointers cannot alias, they can still compare equal.
1069 //
1070 // But LLVM doesn't specify where allocas get their memory, so if the alloca
1071 // doesn't escape we can argue that it's impossible to guess its value, and we
1072 // can therefore act as if any such guesses are wrong.
1073 //
1074 // The code below checks that the alloca doesn't escape, and that it's only
1075 // used in a comparison once (the current instruction). The
1076 // single-comparison-use condition ensures that we're trivially folding all
1077 // comparisons against the alloca consistently, and avoids the risk of
1078 // erroneously folding a comparison of the pointer with itself.
1079
1080 unsigned MaxIter = 32; // Break cycles and bound to constant-time.
1081
1082 SmallVector<Use *, 32> Worklist;
1083 for (Use &U : Alloca->uses()) {
1084 if (Worklist.size() >= MaxIter)
1085 return nullptr;
1086 Worklist.push_back(&U);
1087 }
1088
1089 unsigned NumCmps = 0;
1090 while (!Worklist.empty()) {
1091 assert(Worklist.size() <= MaxIter);
1092 Use *U = Worklist.pop_back_val();
1093 Value *V = U->getUser();
1094 --MaxIter;
1095
1096 if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) ||
1097 isa<SelectInst>(V)) {
1098 // Track the uses.
1099 } else if (isa<LoadInst>(V)) {
1100 // Loading from the pointer doesn't escape it.
1101 continue;
1102 } else if (auto *SI = dyn_cast<StoreInst>(V)) {
1103 // Storing *to* the pointer is fine, but storing the pointer escapes it.
1104 if (SI->getValueOperand() == U->get())
1105 return nullptr;
1106 continue;
1107 } else if (isa<ICmpInst>(V)) {
1108 if (NumCmps++)
1109 return nullptr; // Found more than one cmp.
1110 continue;
1111 } else if (auto *Intrin = dyn_cast<IntrinsicInst>(V)) {
1112 switch (Intrin->getIntrinsicID()) {
1113 // These intrinsics don't escape or compare the pointer. Memset is safe
1114 // because we don't allow ptrtoint. Memcpy and memmove are safe because
1115 // we don't allow stores, so src cannot point to V.
1116 case Intrinsic::lifetime_start: case Intrinsic::lifetime_end:
1117 case Intrinsic::dbg_declare: case Intrinsic::dbg_value:
1118 case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset:
1119 continue;
1120 default:
1121 return nullptr;
1122 }
1123 } else {
1124 return nullptr;
1125 }
1126 for (Use &U : V->uses()) {
1127 if (Worklist.size() >= MaxIter)
1128 return nullptr;
1129 Worklist.push_back(&U);
1130 }
1131 }
1132
1133 Type *CmpTy = CmpInst::makeCmpResultType(Other->getType());
Sanjay Patel4b198802016-02-01 22:23:39 +00001134 return replaceInstUsesWith(
Hans Wennborgf1f36512015-10-07 00:20:07 +00001135 ICI,
1136 ConstantInt::get(CmpTy, !CmpInst::isTrueWhenEqual(ICI.getPredicate())));
1137}
1138
Chris Lattner2188e402010-01-04 07:37:31 +00001139/// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00001140Instruction *InstCombiner::FoldICmpAddOpCst(Instruction &ICI,
Chris Lattner2188e402010-01-04 07:37:31 +00001141 Value *X, ConstantInt *CI,
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00001142 ICmpInst::Predicate Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +00001143 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001144 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner2188e402010-01-04 07:37:31 +00001145 // operators.
Jim Grosbach129c52a2011-09-30 18:09:53 +00001146
Chris Lattner8c92b572010-01-08 17:48:19 +00001147 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner2188e402010-01-04 07:37:31 +00001148 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
1149 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
1150 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00001151 Value *R =
Chris Lattner8c92b572010-01-08 17:48:19 +00001152 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
Chris Lattner2188e402010-01-04 07:37:31 +00001153 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
1154 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001155
Chris Lattner2188e402010-01-04 07:37:31 +00001156 // (X+1) >u X --> X <u (0-1) --> X != 255
1157 // (X+2) >u X --> X <u (0-2) --> X <u 254
1158 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandse5220012011-02-17 07:46:37 +00001159 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Chris Lattner2188e402010-01-04 07:37:31 +00001160 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001161
Chris Lattner2188e402010-01-04 07:37:31 +00001162 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
1163 ConstantInt *SMax = ConstantInt::get(X->getContext(),
1164 APInt::getSignedMaxValue(BitWidth));
1165
1166 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
1167 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
1168 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
1169 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
1170 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
1171 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandse5220012011-02-17 07:46:37 +00001172 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Chris Lattner2188e402010-01-04 07:37:31 +00001173 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001174
Chris Lattner2188e402010-01-04 07:37:31 +00001175 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
1176 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
1177 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
1178 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
1179 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
1180 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach129c52a2011-09-30 18:09:53 +00001181
Chris Lattner2188e402010-01-04 07:37:31 +00001182 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Jakub Staszakbddea112013-06-06 20:18:46 +00001183 Constant *C = Builder->getInt(CI->getValue()-1);
Chris Lattner2188e402010-01-04 07:37:31 +00001184 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
1185}
1186
1187/// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
1188/// and CmpRHS are both known to be integer constants.
1189Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
1190 ConstantInt *DivRHS) {
1191 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
1192 const APInt &CmpRHSV = CmpRHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00001193
1194 // FIXME: If the operand types don't match the type of the divide
Chris Lattner2188e402010-01-04 07:37:31 +00001195 // then don't attempt this transform. The code below doesn't have the
1196 // logic to deal with a signed divide and an unsigned compare (and
Jim Grosbach129c52a2011-09-30 18:09:53 +00001197 // vice versa). This is because (x /s C1) <s C2 produces different
Chris Lattner2188e402010-01-04 07:37:31 +00001198 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
Jim Grosbach129c52a2011-09-30 18:09:53 +00001199 // (x /u C1) <u C2. Simply casting the operands and result won't
1200 // work. :( The if statement below tests that condition and bails
Chris Lattner98457102011-02-10 05:23:05 +00001201 // if it finds it.
Chris Lattner2188e402010-01-04 07:37:31 +00001202 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
1203 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
Craig Topperf40110f2014-04-25 05:29:35 +00001204 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001205 if (DivRHS->isZero())
Craig Topperf40110f2014-04-25 05:29:35 +00001206 return nullptr; // The ProdOV computation fails on divide by zero.
Chris Lattner2188e402010-01-04 07:37:31 +00001207 if (DivIsSigned && DivRHS->isAllOnesValue())
Craig Topperf40110f2014-04-25 05:29:35 +00001208 return nullptr; // The overflow computation also screws up here
Chris Lattner43273af2011-02-13 08:07:21 +00001209 if (DivRHS->isOne()) {
1210 // This eliminates some funny cases with INT_MIN.
1211 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
1212 return &ICI;
1213 }
Chris Lattner2188e402010-01-04 07:37:31 +00001214
1215 // Compute Prod = CI * DivRHS. We are essentially solving an equation
Jim Grosbach129c52a2011-09-30 18:09:53 +00001216 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
1217 // C2 (CI). By solving for X we can turn this into a range check
1218 // instead of computing a divide.
Chris Lattner2188e402010-01-04 07:37:31 +00001219 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
1220
1221 // Determine if the product overflows by seeing if the product is
1222 // not equal to the divide. Make sure we do the same kind of divide
Jim Grosbach129c52a2011-09-30 18:09:53 +00001223 // as in the LHS instruction that we're folding.
Chris Lattner2188e402010-01-04 07:37:31 +00001224 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
1225 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
1226
1227 // Get the ICmp opcode
1228 ICmpInst::Predicate Pred = ICI.getPredicate();
1229
Chris Lattner98457102011-02-10 05:23:05 +00001230 /// If the division is known to be exact, then there is no remainder from the
1231 /// divide, so the covered range size is unit, otherwise it is the divisor.
1232 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001233
Chris Lattner2188e402010-01-04 07:37:31 +00001234 // Figure out the interval that is being checked. For example, a comparison
Jim Grosbach129c52a2011-09-30 18:09:53 +00001235 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
Chris Lattner2188e402010-01-04 07:37:31 +00001236 // Compute this interval based on the constants involved and the signedness of
1237 // the compare/divide. This computes a half-open interval, keeping track of
1238 // whether either value in the interval overflows. After analysis each
1239 // overflow variable is set to 0 if it's corresponding bound variable is valid
1240 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
1241 int LoOverflow = 0, HiOverflow = 0;
Craig Topperf40110f2014-04-25 05:29:35 +00001242 Constant *LoBound = nullptr, *HiBound = nullptr;
Chris Lattner98457102011-02-10 05:23:05 +00001243
Chris Lattner2188e402010-01-04 07:37:31 +00001244 if (!DivIsSigned) { // udiv
1245 // e.g. X/5 op 3 --> [15, 20)
1246 LoBound = Prod;
1247 HiOverflow = LoOverflow = ProdOV;
Chris Lattner98457102011-02-10 05:23:05 +00001248 if (!HiOverflow) {
1249 // If this is not an exact divide, then many values in the range collapse
1250 // to the same result value.
1251 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
1252 }
Chris Lattner2188e402010-01-04 07:37:31 +00001253 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
1254 if (CmpRHSV == 0) { // (X / pos) op 0
1255 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
Chris Lattner98457102011-02-10 05:23:05 +00001256 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
1257 HiBound = RangeSize;
Chris Lattner2188e402010-01-04 07:37:31 +00001258 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
1259 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
1260 HiOverflow = LoOverflow = ProdOV;
1261 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +00001262 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +00001263 } else { // (X / pos) op neg
1264 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
1265 HiBound = AddOne(Prod);
1266 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
1267 if (!LoOverflow) {
Chris Lattner98457102011-02-10 05:23:05 +00001268 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +00001269 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
Chris Lattner98457102011-02-10 05:23:05 +00001270 }
Chris Lattner2188e402010-01-04 07:37:31 +00001271 }
Chris Lattnerb1a15122011-07-15 06:08:15 +00001272 } else if (DivRHS->isNegative()) { // Divisor is < 0.
Chris Lattner98457102011-02-10 05:23:05 +00001273 if (DivI->isExact())
1274 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +00001275 if (CmpRHSV == 0) { // (X / neg) op 0
1276 // e.g. X/-5 op 0 --> [-4, 5)
Chris Lattner98457102011-02-10 05:23:05 +00001277 LoBound = AddOne(RangeSize);
1278 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +00001279 if (HiBound == DivRHS) { // -INTMIN = INTMIN
1280 HiOverflow = 1; // [INTMIN+1, overflow)
Craig Topperf40110f2014-04-25 05:29:35 +00001281 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN
Chris Lattner2188e402010-01-04 07:37:31 +00001282 }
1283 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
1284 // e.g. X/-5 op 3 --> [-19, -14)
1285 HiBound = AddOne(Prod);
1286 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
1287 if (!LoOverflow)
Chris Lattner98457102011-02-10 05:23:05 +00001288 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
Chris Lattner2188e402010-01-04 07:37:31 +00001289 } else { // (X / neg) op neg
1290 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
1291 LoOverflow = HiOverflow = ProdOV;
1292 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +00001293 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +00001294 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001295
Chris Lattner2188e402010-01-04 07:37:31 +00001296 // Dividing by a negative swaps the condition. LT <-> GT
1297 Pred = ICmpInst::getSwappedPredicate(Pred);
1298 }
1299
1300 Value *X = DivI->getOperand(0);
1301 switch (Pred) {
1302 default: llvm_unreachable("Unhandled icmp opcode!");
1303 case ICmpInst::ICMP_EQ:
1304 if (LoOverflow && HiOverflow)
Sanjay Patel4b198802016-02-01 22:23:39 +00001305 return replaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner067459c2010-03-05 08:46:26 +00001306 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +00001307 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
1308 ICmpInst::ICMP_UGE, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +00001309 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +00001310 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
1311 ICmpInst::ICMP_ULT, X, HiBound);
Sanjay Patel4b198802016-02-01 22:23:39 +00001312 return replaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
Chris Lattner98457102011-02-10 05:23:05 +00001313 DivIsSigned, true));
Chris Lattner2188e402010-01-04 07:37:31 +00001314 case ICmpInst::ICMP_NE:
1315 if (LoOverflow && HiOverflow)
Sanjay Patel4b198802016-02-01 22:23:39 +00001316 return replaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner067459c2010-03-05 08:46:26 +00001317 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +00001318 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
1319 ICmpInst::ICMP_ULT, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +00001320 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +00001321 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
1322 ICmpInst::ICMP_UGE, X, HiBound);
Sanjay Patel4b198802016-02-01 22:23:39 +00001323 return replaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
Chris Lattner067459c2010-03-05 08:46:26 +00001324 DivIsSigned, false));
Chris Lattner2188e402010-01-04 07:37:31 +00001325 case ICmpInst::ICMP_ULT:
1326 case ICmpInst::ICMP_SLT:
1327 if (LoOverflow == +1) // Low bound is greater than input range.
Sanjay Patel4b198802016-02-01 22:23:39 +00001328 return replaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00001329 if (LoOverflow == -1) // Low bound is less than input range.
Sanjay Patel4b198802016-02-01 22:23:39 +00001330 return replaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00001331 return new ICmpInst(Pred, X, LoBound);
1332 case ICmpInst::ICMP_UGT:
1333 case ICmpInst::ICMP_SGT:
1334 if (HiOverflow == +1) // High bound greater than input range.
Sanjay Patel4b198802016-02-01 22:23:39 +00001335 return replaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner98457102011-02-10 05:23:05 +00001336 if (HiOverflow == -1) // High bound less than input range.
Sanjay Patel4b198802016-02-01 22:23:39 +00001337 return replaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00001338 if (Pred == ICmpInst::ICMP_UGT)
1339 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +00001340 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
Chris Lattner2188e402010-01-04 07:37:31 +00001341 }
1342}
1343
Chris Lattnerd369f572011-02-13 07:43:07 +00001344/// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
1345Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
1346 ConstantInt *ShAmt) {
Chris Lattnerd369f572011-02-13 07:43:07 +00001347 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00001348
Chris Lattnerd369f572011-02-13 07:43:07 +00001349 // Check that the shift amount is in range. If not, don't perform
1350 // undefined shifts. When the shift is visited it will be
1351 // simplified.
1352 uint32_t TypeBits = CmpRHSV.getBitWidth();
1353 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Chris Lattner43273af2011-02-13 08:07:21 +00001354 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
Craig Topperf40110f2014-04-25 05:29:35 +00001355 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001356
Chris Lattner43273af2011-02-13 08:07:21 +00001357 if (!ICI.isEquality()) {
1358 // If we have an unsigned comparison and an ashr, we can't simplify this.
1359 // Similarly for signed comparisons with lshr.
1360 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
Craig Topperf40110f2014-04-25 05:29:35 +00001361 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001362
Eli Friedman865866e2011-05-25 23:26:20 +00001363 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
1364 // by a power of 2. Since we already have logic to simplify these,
1365 // transform to div and then simplify the resultant comparison.
Chris Lattner43273af2011-02-13 08:07:21 +00001366 if (Shr->getOpcode() == Instruction::AShr &&
Eli Friedman865866e2011-05-25 23:26:20 +00001367 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
Craig Topperf40110f2014-04-25 05:29:35 +00001368 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001369
Chris Lattner43273af2011-02-13 08:07:21 +00001370 // Revisit the shift (to delete it).
1371 Worklist.Add(Shr);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001372
Chris Lattner43273af2011-02-13 08:07:21 +00001373 Constant *DivCst =
1374 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001375
Chris Lattner43273af2011-02-13 08:07:21 +00001376 Value *Tmp =
1377 Shr->getOpcode() == Instruction::AShr ?
1378 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
1379 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001380
Chris Lattner43273af2011-02-13 08:07:21 +00001381 ICI.setOperand(0, Tmp);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001382
Chris Lattner43273af2011-02-13 08:07:21 +00001383 // If the builder folded the binop, just return it.
1384 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
Craig Topperf40110f2014-04-25 05:29:35 +00001385 if (!TheDiv)
Chris Lattner43273af2011-02-13 08:07:21 +00001386 return &ICI;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001387
Chris Lattner43273af2011-02-13 08:07:21 +00001388 // Otherwise, fold this div/compare.
1389 assert(TheDiv->getOpcode() == Instruction::SDiv ||
1390 TheDiv->getOpcode() == Instruction::UDiv);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001391
Chris Lattner43273af2011-02-13 08:07:21 +00001392 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
1393 assert(Res && "This div/cst should have folded!");
1394 return Res;
1395 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001396
Chris Lattnerd369f572011-02-13 07:43:07 +00001397 // If we are comparing against bits always shifted out, the
1398 // comparison cannot succeed.
1399 APInt Comp = CmpRHSV << ShAmtVal;
Jakub Staszakbddea112013-06-06 20:18:46 +00001400 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
Chris Lattnerd369f572011-02-13 07:43:07 +00001401 if (Shr->getOpcode() == Instruction::LShr)
1402 Comp = Comp.lshr(ShAmtVal);
1403 else
1404 Comp = Comp.ashr(ShAmtVal);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001405
Chris Lattnerd369f572011-02-13 07:43:07 +00001406 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1407 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001408 Constant *Cst = Builder->getInt1(IsICMP_NE);
Sanjay Patel4b198802016-02-01 22:23:39 +00001409 return replaceInstUsesWith(ICI, Cst);
Chris Lattnerd369f572011-02-13 07:43:07 +00001410 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001411
Chris Lattnerd369f572011-02-13 07:43:07 +00001412 // Otherwise, check to see if the bits shifted out are known to be zero.
1413 // If so, we can compare against the unshifted value:
1414 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Chris Lattner9bd7fdf2011-02-13 18:30:09 +00001415 if (Shr->hasOneUse() && Shr->isExact())
Chris Lattnerd369f572011-02-13 07:43:07 +00001416 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001417
Chris Lattnerd369f572011-02-13 07:43:07 +00001418 if (Shr->hasOneUse()) {
1419 // Otherwise strength reduce the shift into an and.
1420 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
Jakub Staszakbddea112013-06-06 20:18:46 +00001421 Constant *Mask = Builder->getInt(Val);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001422
Chris Lattnerd369f572011-02-13 07:43:07 +00001423 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1424 Mask, Shr->getName()+".mask");
1425 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1426 }
Craig Topperf40110f2014-04-25 05:29:35 +00001427 return nullptr;
Chris Lattnerd369f572011-02-13 07:43:07 +00001428}
1429
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001430/// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
1431/// (icmp eq/ne A, Log2(const2/const1)) ->
1432/// (icmp eq/ne A, Log2(const2) - Log2(const1)).
1433Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
1434 ConstantInt *CI1,
1435 ConstantInt *CI2) {
1436 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1437
1438 auto getConstant = [&I, this](bool IsTrue) {
1439 if (I.getPredicate() == I.ICMP_NE)
1440 IsTrue = !IsTrue;
Sanjay Patel4b198802016-02-01 22:23:39 +00001441 return replaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001442 };
1443
1444 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1445 if (I.getPredicate() == I.ICMP_NE)
1446 Pred = CmpInst::getInversePredicate(Pred);
1447 return new ICmpInst(Pred, LHS, RHS);
1448 };
1449
1450 APInt AP1 = CI1->getValue();
1451 APInt AP2 = CI2->getValue();
1452
David Majnemer2abb8182014-10-25 07:13:13 +00001453 // Don't bother doing any work for cases which InstSimplify handles.
1454 if (AP2 == 0)
1455 return nullptr;
1456 bool IsAShr = isa<AShrOperator>(Op);
1457 if (IsAShr) {
1458 if (AP2.isAllOnesValue())
1459 return nullptr;
1460 if (AP2.isNegative() != AP1.isNegative())
1461 return nullptr;
1462 if (AP2.sgt(AP1))
1463 return nullptr;
1464 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001465
David Majnemerd2056022014-10-21 19:51:55 +00001466 if (!AP1)
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001467 // 'A' must be large enough to shift out the highest set bit.
1468 return getICmp(I.ICMP_UGT, A,
1469 ConstantInt::get(A->getType(), AP2.logBase2()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001470
David Majnemerd2056022014-10-21 19:51:55 +00001471 if (AP1 == AP2)
1472 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001473
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001474 int Shift;
David Majnemerd2056022014-10-21 19:51:55 +00001475 if (IsAShr && AP1.isNegative())
David Majnemere5977eb2015-09-19 00:48:26 +00001476 Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes();
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001477 else
David Majnemere5977eb2015-09-19 00:48:26 +00001478 Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros();
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001479
David Majnemerd2056022014-10-21 19:51:55 +00001480 if (Shift > 0) {
David Majnemere5977eb2015-09-19 00:48:26 +00001481 if (IsAShr && AP1 == AP2.ashr(Shift)) {
1482 // There are multiple solutions if we are comparing against -1 and the LHS
David Majnemer47ce0b82015-09-19 00:48:31 +00001483 // of the ashr is not a power of two.
David Majnemere5977eb2015-09-19 00:48:26 +00001484 if (AP1.isAllOnesValue() && !AP2.isPowerOf2())
1485 return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift));
David Majnemerd2056022014-10-21 19:51:55 +00001486 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
David Majnemere5977eb2015-09-19 00:48:26 +00001487 } else if (AP1 == AP2.lshr(Shift)) {
1488 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1489 }
David Majnemerd2056022014-10-21 19:51:55 +00001490 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001491 // Shifting const2 will never be equal to const1.
1492 return getConstant(false);
1493}
Chris Lattner2188e402010-01-04 07:37:31 +00001494
David Majnemer59939ac2014-10-19 08:23:08 +00001495/// FoldICmpCstShlCst - Handle "(icmp eq/ne (shl const2, A), const1)" ->
1496/// (icmp eq/ne A, TrailingZeros(const1) - TrailingZeros(const2)).
1497Instruction *InstCombiner::FoldICmpCstShlCst(ICmpInst &I, Value *Op, Value *A,
1498 ConstantInt *CI1,
1499 ConstantInt *CI2) {
1500 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1501
1502 auto getConstant = [&I, this](bool IsTrue) {
1503 if (I.getPredicate() == I.ICMP_NE)
1504 IsTrue = !IsTrue;
Sanjay Patel4b198802016-02-01 22:23:39 +00001505 return replaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
David Majnemer59939ac2014-10-19 08:23:08 +00001506 };
1507
1508 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1509 if (I.getPredicate() == I.ICMP_NE)
1510 Pred = CmpInst::getInversePredicate(Pred);
1511 return new ICmpInst(Pred, LHS, RHS);
1512 };
1513
1514 APInt AP1 = CI1->getValue();
1515 APInt AP2 = CI2->getValue();
1516
David Majnemer2abb8182014-10-25 07:13:13 +00001517 // Don't bother doing any work for cases which InstSimplify handles.
1518 if (AP2 == 0)
1519 return nullptr;
David Majnemer59939ac2014-10-19 08:23:08 +00001520
1521 unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1522
1523 if (!AP1 && AP2TrailingZeros != 0)
1524 return getICmp(I.ICMP_UGE, A,
1525 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
1526
1527 if (AP1 == AP2)
1528 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1529
1530 // Get the distance between the lowest bits that are set.
1531 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1532
1533 if (Shift > 0 && AP2.shl(Shift) == AP1)
1534 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1535
1536 // Shifting const2 will never be equal to const1.
1537 return getConstant(false);
1538}
1539
Chris Lattner2188e402010-01-04 07:37:31 +00001540/// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1541///
1542Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1543 Instruction *LHSI,
1544 ConstantInt *RHS) {
1545 const APInt &RHSV = RHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00001546
Chris Lattner2188e402010-01-04 07:37:31 +00001547 switch (LHSI->getOpcode()) {
1548 case Instruction::Trunc:
Sanjoy Dase5f48892015-09-16 20:41:29 +00001549 if (RHS->isOne() && RHSV.getBitWidth() > 1) {
1550 // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1
1551 Value *V = nullptr;
1552 if (ICI.getPredicate() == ICmpInst::ICMP_SLT &&
1553 match(LHSI->getOperand(0), m_Signum(m_Value(V))))
1554 return new ICmpInst(ICmpInst::ICMP_SLT, V,
1555 ConstantInt::get(V->getType(), 1));
1556 }
Chris Lattner2188e402010-01-04 07:37:31 +00001557 if (ICI.isEquality() && LHSI->hasOneUse()) {
1558 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1559 // of the high bits truncated out of x are known.
1560 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1561 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
Chris Lattner2188e402010-01-04 07:37:31 +00001562 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
Hal Finkel60db0582014-09-07 18:57:58 +00001563 computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne, 0, &ICI);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001564
Chris Lattner2188e402010-01-04 07:37:31 +00001565 // If all the high bits are known, we can do this xform.
1566 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1567 // Pull in the high bits from known-ones set.
Jay Foad583abbc2010-12-07 08:25:19 +00001568 APInt NewRHS = RHS->getValue().zext(SrcBits);
Eli Friedmane0a64d82012-05-11 01:32:59 +00001569 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
Chris Lattner2188e402010-01-04 07:37:31 +00001570 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001571 Builder->getInt(NewRHS));
Chris Lattner2188e402010-01-04 07:37:31 +00001572 }
1573 }
1574 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001575
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001576 case Instruction::Xor: // (icmp pred (xor X, XorCst), CI)
1577 if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001578 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1579 // fold the xor.
1580 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1581 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1582 Value *CompareVal = LHSI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001583
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001584 // If the sign bit of the XorCst is not set, there is no change to
Chris Lattner2188e402010-01-04 07:37:31 +00001585 // the operation, just stop using the Xor.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001586 if (!XorCst->isNegative()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001587 ICI.setOperand(0, CompareVal);
1588 Worklist.Add(LHSI);
1589 return &ICI;
1590 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001591
Chris Lattner2188e402010-01-04 07:37:31 +00001592 // Was the old condition true if the operand is positive?
1593 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001594
Chris Lattner2188e402010-01-04 07:37:31 +00001595 // If so, the new one isn't.
1596 isTrueIfPositive ^= true;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001597
Chris Lattner2188e402010-01-04 07:37:31 +00001598 if (isTrueIfPositive)
1599 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1600 SubOne(RHS));
1601 else
1602 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1603 AddOne(RHS));
1604 }
1605
1606 if (LHSI->hasOneUse()) {
1607 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001608 if (!ICI.isEquality() && XorCst->getValue().isSignBit()) {
1609 const APInt &SignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001610 ICmpInst::Predicate Pred = ICI.isSigned()
1611 ? ICI.getUnsignedPredicate()
1612 : ICI.getSignedPredicate();
1613 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001614 Builder->getInt(RHSV ^ SignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001615 }
1616
1617 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001618 if (!ICI.isEquality() && XorCst->isMaxValue(true)) {
1619 const APInt &NotSignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001620 ICmpInst::Predicate Pred = ICI.isSigned()
1621 ? ICI.getUnsignedPredicate()
1622 : ICI.getSignedPredicate();
1623 Pred = ICI.getSwappedPredicate(Pred);
1624 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001625 Builder->getInt(RHSV ^ NotSignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001626 }
1627 }
David Majnemer72d76272013-07-09 09:20:58 +00001628
1629 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1630 // iff -C is a power of 2
1631 if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001632 XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1633 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst);
David Majnemer72d76272013-07-09 09:20:58 +00001634
1635 // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1636 // iff -C is a power of 2
1637 if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001638 XorCst->getValue() == -RHSV && RHSV.isPowerOf2())
1639 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001640 }
1641 break;
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001642 case Instruction::And: // (icmp pred (and X, AndCst), RHS)
Chris Lattner2188e402010-01-04 07:37:31 +00001643 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1644 LHSI->getOperand(0)->hasOneUse()) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001645 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001646
Chris Lattner2188e402010-01-04 07:37:31 +00001647 // If the LHS is an AND of a truncating cast, we can widen the
1648 // and/compare to be the input width without changing the value
1649 // produced, eliminating a cast.
1650 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1651 // We can do this transformation if either the AND constant does not
Jim Grosbach129c52a2011-09-30 18:09:53 +00001652 // have its sign bit set or if it is an equality comparison.
Chris Lattner2188e402010-01-04 07:37:31 +00001653 // Extending a relational comparison when we're checking the sign
1654 // bit would not work.
Benjamin Kramer35159c12011-06-12 22:47:53 +00001655 if (ICI.isEquality() ||
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001656 (!AndCst->isNegative() && RHSV.isNonNegative())) {
Benjamin Kramer35159c12011-06-12 22:47:53 +00001657 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001658 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001659 ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
Benjamin Kramer35159c12011-06-12 22:47:53 +00001660 NewAnd->takeName(LHSI);
Chris Lattner2188e402010-01-04 07:37:31 +00001661 return new ICmpInst(ICI.getPredicate(), NewAnd,
Benjamin Kramer35159c12011-06-12 22:47:53 +00001662 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
Chris Lattner2188e402010-01-04 07:37:31 +00001663 }
1664 }
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001665
1666 // If the LHS is an AND of a zext, and we have an equality compare, we can
1667 // shrink the and/compare to the smaller type, eliminating the cast.
1668 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
Chris Lattner229907c2011-07-18 04:54:35 +00001669 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001670 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1671 // should fold the icmp to true/false in that case.
1672 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1673 Value *NewAnd =
1674 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001675 ConstantExpr::getTrunc(AndCst, Ty));
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001676 NewAnd->takeName(LHSI);
1677 return new ICmpInst(ICI.getPredicate(), NewAnd,
1678 ConstantExpr::getTrunc(RHS, Ty));
1679 }
1680 }
1681
Chris Lattner2188e402010-01-04 07:37:31 +00001682 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1683 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1684 // happens a LOT in code produced by the C front-end, for bitfield
1685 // access.
1686 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1687 if (Shift && !Shift->isShift())
Craig Topperf40110f2014-04-25 05:29:35 +00001688 Shift = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001689
Chris Lattner2188e402010-01-04 07:37:31 +00001690 ConstantInt *ShAmt;
Craig Topperf40110f2014-04-25 05:29:35 +00001691 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001692
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001693 // This seemingly simple opportunity to fold away a shift turns out to
1694 // be rather complicated. See PR17827
1695 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
Chris Lattner2188e402010-01-04 07:37:31 +00001696 if (ShAmt) {
Kay Tiong Khoo5389f742013-12-02 18:43:59 +00001697 bool CanFold = false;
1698 unsigned ShiftOpcode = Shift->getOpcode();
1699 if (ShiftOpcode == Instruction::AShr) {
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001700 // There may be some constraints that make this possible,
1701 // but nothing simple has been discovered yet.
1702 CanFold = false;
1703 } else if (ShiftOpcode == Instruction::Shl) {
1704 // For a left shift, we can fold if the comparison is not signed.
1705 // We can also fold a signed comparison if the mask value and
1706 // comparison value are not negative. These constraints may not be
1707 // obvious, but we can prove that they are correct using an SMT
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001708 // solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001709 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
Chris Lattner2188e402010-01-04 07:37:31 +00001710 CanFold = true;
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001711 } else if (ShiftOpcode == Instruction::LShr) {
1712 // For a logical right shift, we can fold if the comparison is not
1713 // signed. We can also fold a signed comparison if the shifted mask
1714 // value and the shifted comparison value are not negative.
1715 // These constraints may not be obvious, but we can prove that they
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001716 // are correct using an SMT solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001717 if (!ICI.isSigned())
1718 CanFold = true;
1719 else {
1720 ConstantInt *ShiftedAndCst =
1721 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1722 ConstantInt *ShiftedRHSCst =
1723 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1724
1725 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1726 CanFold = true;
1727 }
Chris Lattner2188e402010-01-04 07:37:31 +00001728 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001729
Chris Lattner2188e402010-01-04 07:37:31 +00001730 if (CanFold) {
1731 Constant *NewCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001732 if (ShiftOpcode == Instruction::Shl)
Chris Lattner2188e402010-01-04 07:37:31 +00001733 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1734 else
1735 NewCst = ConstantExpr::getShl(RHS, ShAmt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001736
Chris Lattner2188e402010-01-04 07:37:31 +00001737 // Check to see if we are shifting out any of the bits being
1738 // compared.
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001739 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
Chris Lattner2188e402010-01-04 07:37:31 +00001740 // If we shifted bits out, the fold is not going to work out.
1741 // As a special case, check to see if this means that the
1742 // result is always true or false now.
1743 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
Sanjay Patel4b198802016-02-01 22:23:39 +00001744 return replaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00001745 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
Sanjay Patel4b198802016-02-01 22:23:39 +00001746 return replaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00001747 } else {
1748 ICI.setOperand(1, NewCst);
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001749 Constant *NewAndCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001750 if (ShiftOpcode == Instruction::Shl)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001751 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
Chris Lattner2188e402010-01-04 07:37:31 +00001752 else
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001753 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1754 LHSI->setOperand(1, NewAndCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001755 LHSI->setOperand(0, Shift->getOperand(0));
1756 Worklist.Add(Shift); // Shift is dead.
1757 return &ICI;
1758 }
1759 }
1760 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001761
Chris Lattner2188e402010-01-04 07:37:31 +00001762 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1763 // preferable because it allows the C<<Y expression to be hoisted out
1764 // of a loop if Y is invariant and X is not.
1765 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1766 ICI.isEquality() && !Shift->isArithmeticShift() &&
1767 !isa<Constant>(Shift->getOperand(0))) {
1768 // Compute C << Y.
1769 Value *NS;
1770 if (Shift->getOpcode() == Instruction::LShr) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001771 NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001772 } else {
1773 // Insert a logical shift.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001774 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001775 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001776
Chris Lattner2188e402010-01-04 07:37:31 +00001777 // Compute X & (C << Y).
Jim Grosbach129c52a2011-09-30 18:09:53 +00001778 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001779 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001780
Chris Lattner2188e402010-01-04 07:37:31 +00001781 ICI.setOperand(0, NewAnd);
1782 return &ICI;
1783 }
Paul Redmond5917f4c2012-12-19 19:47:13 +00001784
David Majnemer0ffccf72014-08-24 09:10:57 +00001785 // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1786 // (icmp pred (and X, (or (shl 1, Y), 1), 0))
1787 //
1788 // iff pred isn't signed
1789 {
1790 Value *X, *Y, *LShr;
1791 if (!ICI.isSigned() && RHSV == 0) {
1792 if (match(LHSI->getOperand(1), m_One())) {
1793 Constant *One = cast<Constant>(LHSI->getOperand(1));
1794 Value *Or = LHSI->getOperand(0);
1795 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1796 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1797 unsigned UsesRemoved = 0;
1798 if (LHSI->hasOneUse())
1799 ++UsesRemoved;
1800 if (Or->hasOneUse())
1801 ++UsesRemoved;
1802 if (LShr->hasOneUse())
1803 ++UsesRemoved;
1804 Value *NewOr = nullptr;
1805 // Compute X & ((1 << Y) | 1)
1806 if (auto *C = dyn_cast<Constant>(Y)) {
1807 if (UsesRemoved >= 1)
1808 NewOr =
1809 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1810 } else {
1811 if (UsesRemoved >= 3)
1812 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1813 LShr->getName(),
1814 /*HasNUW=*/true),
1815 One, Or->getName());
1816 }
1817 if (NewOr) {
1818 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1819 ICI.setOperand(0, NewAnd);
1820 return &ICI;
1821 }
1822 }
1823 }
1824 }
1825 }
1826
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001827 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1828 // bit set in (X & AndCst) will produce a result greater than RHSV.
Paul Redmond5917f4c2012-12-19 19:47:13 +00001829 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001830 unsigned NTZ = AndCst->getValue().countTrailingZeros();
1831 if ((NTZ < AndCst->getBitWidth()) &&
1832 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV))
Paul Redmond5917f4c2012-12-19 19:47:13 +00001833 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1834 Constant::getNullValue(RHS->getType()));
1835 }
Chris Lattner2188e402010-01-04 07:37:31 +00001836 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001837
Chris Lattner2188e402010-01-04 07:37:31 +00001838 // Try to optimize things like "A[i]&42 == 0" to index computations.
1839 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1840 if (GetElementPtrInst *GEP =
1841 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1842 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1843 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1844 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1845 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1846 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1847 return Res;
1848 }
1849 }
David Majnemer414d4e52013-07-09 08:09:32 +00001850
1851 // X & -C == -C -> X > u ~C
1852 // X & -C != -C -> X <= u ~C
1853 // iff C is a power of 2
1854 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1855 return new ICmpInst(
1856 ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1857 : ICmpInst::ICMP_ULE,
1858 LHSI->getOperand(0), SubOne(RHS));
David Majnemerdfa3b092015-08-16 07:09:17 +00001859
1860 // (icmp eq (and %A, C), 0) -> (icmp sgt (trunc %A), -1)
1861 // iff C is a power of 2
1862 if (ICI.isEquality() && LHSI->hasOneUse() && match(RHS, m_Zero())) {
1863 if (auto *CI = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1864 const APInt &AI = CI->getValue();
1865 int32_t ExactLogBase2 = AI.exactLogBase2();
1866 if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1867 Type *NTy = IntegerType::get(ICI.getContext(), ExactLogBase2 + 1);
1868 Value *Trunc = Builder->CreateTrunc(LHSI->getOperand(0), NTy);
1869 return new ICmpInst(ICI.getPredicate() == ICmpInst::ICMP_EQ
1870 ? ICmpInst::ICMP_SGE
1871 : ICmpInst::ICMP_SLT,
1872 Trunc, Constant::getNullValue(NTy));
1873 }
1874 }
1875 }
Chris Lattner2188e402010-01-04 07:37:31 +00001876 break;
1877
1878 case Instruction::Or: {
Sanjoy Dase5f48892015-09-16 20:41:29 +00001879 if (RHS->isOne()) {
1880 // icmp slt signum(V) 1 --> icmp slt V, 1
1881 Value *V = nullptr;
1882 if (ICI.getPredicate() == ICmpInst::ICMP_SLT &&
1883 match(LHSI, m_Signum(m_Value(V))))
1884 return new ICmpInst(ICmpInst::ICMP_SLT, V,
1885 ConstantInt::get(V->getType(), 1));
1886 }
1887
Chris Lattner2188e402010-01-04 07:37:31 +00001888 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1889 break;
1890 Value *P, *Q;
1891 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1892 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1893 // -> and (icmp eq P, null), (icmp eq Q, null).
Chris Lattner2188e402010-01-04 07:37:31 +00001894 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1895 Constant::getNullValue(P->getType()));
1896 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1897 Constant::getNullValue(Q->getType()));
1898 Instruction *Op;
1899 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1900 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1901 else
1902 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1903 return Op;
1904 }
1905 break;
1906 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001907
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001908 case Instruction::Mul: { // (icmp pred (mul X, Val), CI)
1909 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1910 if (!Val) break;
1911
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001912 // If this is a signed comparison to 0 and the mul is sign preserving,
1913 // use the mul LHS operand instead.
1914 ICmpInst::Predicate pred = ICI.getPredicate();
1915 if (isSignTest(pred, RHS) && !Val->isZero() &&
1916 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1917 return new ICmpInst(Val->isNegative() ?
1918 ICmpInst::getSwappedPredicate(pred) : pred,
1919 LHSI->getOperand(0),
1920 Constant::getNullValue(RHS->getType()));
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001921
1922 break;
1923 }
1924
Chris Lattner2188e402010-01-04 07:37:31 +00001925 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
Chris Lattner2188e402010-01-04 07:37:31 +00001926 uint32_t TypeBits = RHSV.getBitWidth();
David Majnemerb889e402013-06-28 23:42:03 +00001927 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1928 if (!ShAmt) {
1929 Value *X;
1930 // (1 << X) pred P2 -> X pred Log2(P2)
1931 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1932 bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1933 ICmpInst::Predicate Pred = ICI.getPredicate();
1934 if (ICI.isUnsigned()) {
1935 if (!RHSVIsPowerOf2) {
1936 // (1 << X) < 30 -> X <= 4
1937 // (1 << X) <= 30 -> X <= 4
1938 // (1 << X) >= 30 -> X > 4
1939 // (1 << X) > 30 -> X > 4
1940 if (Pred == ICmpInst::ICMP_ULT)
1941 Pred = ICmpInst::ICMP_ULE;
1942 else if (Pred == ICmpInst::ICMP_UGE)
1943 Pred = ICmpInst::ICMP_UGT;
1944 }
1945 unsigned RHSLog2 = RHSV.logBase2();
1946
1947 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
David Majnemerb889e402013-06-28 23:42:03 +00001948 // (1 << X) < 2147483648 -> X < 31 -> X != 31
1949 if (RHSLog2 == TypeBits-1) {
1950 if (Pred == ICmpInst::ICMP_UGE)
1951 Pred = ICmpInst::ICMP_EQ;
David Majnemerb889e402013-06-28 23:42:03 +00001952 else if (Pred == ICmpInst::ICMP_ULT)
1953 Pred = ICmpInst::ICMP_NE;
1954 }
1955
1956 return new ICmpInst(Pred, X,
1957 ConstantInt::get(RHS->getType(), RHSLog2));
1958 } else if (ICI.isSigned()) {
1959 if (RHSV.isAllOnesValue()) {
1960 // (1 << X) <= -1 -> X == 31
1961 if (Pred == ICmpInst::ICMP_SLE)
1962 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1963 ConstantInt::get(RHS->getType(), TypeBits-1));
1964
1965 // (1 << X) > -1 -> X != 31
1966 if (Pred == ICmpInst::ICMP_SGT)
1967 return new ICmpInst(ICmpInst::ICMP_NE, X,
1968 ConstantInt::get(RHS->getType(), TypeBits-1));
1969 } else if (!RHSV) {
1970 // (1 << X) < 0 -> X == 31
1971 // (1 << X) <= 0 -> X == 31
1972 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1973 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1974 ConstantInt::get(RHS->getType(), TypeBits-1));
1975
1976 // (1 << X) >= 0 -> X != 31
1977 // (1 << X) > 0 -> X != 31
1978 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1979 return new ICmpInst(ICmpInst::ICMP_NE, X,
1980 ConstantInt::get(RHS->getType(), TypeBits-1));
1981 }
1982 } else if (ICI.isEquality()) {
1983 if (RHSVIsPowerOf2)
1984 return new ICmpInst(
1985 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
David Majnemerb889e402013-06-28 23:42:03 +00001986 }
1987 }
1988 break;
1989 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001990
Chris Lattner2188e402010-01-04 07:37:31 +00001991 // Check that the shift amount is in range. If not, don't perform
1992 // undefined shifts. When the shift is visited it will be
1993 // simplified.
1994 if (ShAmt->uge(TypeBits))
1995 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001996
Chris Lattner2188e402010-01-04 07:37:31 +00001997 if (ICI.isEquality()) {
1998 // If we are comparing against bits always shifted out, the
1999 // comparison cannot succeed.
2000 Constant *Comp =
2001 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
2002 ShAmt);
2003 if (Comp != RHS) {// Comparing against a bit that we know is zero.
2004 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00002005 Constant *Cst = Builder->getInt1(IsICMP_NE);
Sanjay Patel4b198802016-02-01 22:23:39 +00002006 return replaceInstUsesWith(ICI, Cst);
Chris Lattner2188e402010-01-04 07:37:31 +00002007 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002008
Chris Lattner98457102011-02-10 05:23:05 +00002009 // If the shift is NUW, then it is just shifting out zeros, no need for an
2010 // AND.
2011 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
2012 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
2013 ConstantExpr::getLShr(RHS, ShAmt));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002014
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00002015 // If the shift is NSW and we compare to 0, then it is just shifting out
2016 // sign bits, no need for an AND either.
2017 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
2018 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
2019 ConstantExpr::getLShr(RHS, ShAmt));
2020
Chris Lattner2188e402010-01-04 07:37:31 +00002021 if (LHSI->hasOneUse()) {
2022 // Otherwise strength reduce the shift into an and.
2023 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Jakub Staszakbddea112013-06-06 20:18:46 +00002024 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
2025 TypeBits - ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002026
Chris Lattner2188e402010-01-04 07:37:31 +00002027 Value *And =
2028 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
2029 return new ICmpInst(ICI.getPredicate(), And,
Chris Lattner98457102011-02-10 05:23:05 +00002030 ConstantExpr::getLShr(RHS, ShAmt));
Chris Lattner2188e402010-01-04 07:37:31 +00002031 }
2032 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002033
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00002034 // If this is a signed comparison to 0 and the shift is sign preserving,
2035 // use the shift LHS operand instead.
2036 ICmpInst::Predicate pred = ICI.getPredicate();
2037 if (isSignTest(pred, RHS) &&
2038 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
2039 return new ICmpInst(pred,
2040 LHSI->getOperand(0),
2041 Constant::getNullValue(RHS->getType()));
2042
Chris Lattner2188e402010-01-04 07:37:31 +00002043 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
2044 bool TrueIfSigned = false;
2045 if (LHSI->hasOneUse() &&
2046 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
2047 // (X << 31) <s 0 --> (X&1) != 0
Chris Lattner43273af2011-02-13 08:07:21 +00002048 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
Jim Grosbach129c52a2011-09-30 18:09:53 +00002049 APInt::getOneBitSet(TypeBits,
Chris Lattner43273af2011-02-13 08:07:21 +00002050 TypeBits-ShAmt->getZExtValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002051 Value *And =
2052 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
2053 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
2054 And, Constant::getNullValue(And->getType()));
2055 }
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00002056
2057 // Transform (icmp pred iM (shl iM %v, N), CI)
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00002058 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
2059 // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00002060 // This enables to get rid of the shift in favor of a trunc which can be
2061 // free on the target. It has the additional benefit of comparing to a
2062 // smaller constant, which will be target friendly.
2063 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00002064 if (LHSI->hasOneUse() &&
2065 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00002066 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
2067 Constant *NCI = ConstantExpr::getTrunc(
2068 ConstantExpr::getAShr(RHS,
2069 ConstantInt::get(RHS->getType(), Amt)),
2070 NTy);
2071 return new ICmpInst(ICI.getPredicate(),
2072 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
Arnaud A. de Grandmaison1fd843e2013-02-15 15:18:17 +00002073 NCI);
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00002074 }
2075
Chris Lattner2188e402010-01-04 07:37:31 +00002076 break;
2077 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002078
Chris Lattner2188e402010-01-04 07:37:31 +00002079 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
Nick Lewycky174a7052011-02-28 08:31:40 +00002080 case Instruction::AShr: {
2081 // Handle equality comparisons of shift-by-constant.
2082 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
2083 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
2084 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
Chris Lattnerd369f572011-02-13 07:43:07 +00002085 return Res;
Nick Lewycky174a7052011-02-28 08:31:40 +00002086 }
2087
2088 // Handle exact shr's.
2089 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
2090 if (RHSV.isMinValue())
2091 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
2092 }
Chris Lattner2188e402010-01-04 07:37:31 +00002093 break;
Nick Lewycky174a7052011-02-28 08:31:40 +00002094 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002095
Chris Lattner2188e402010-01-04 07:37:31 +00002096 case Instruction::UDiv:
Chad Rosier4e6cda22016-05-10 20:22:09 +00002097 if (ConstantInt *DivLHS = dyn_cast<ConstantInt>(LHSI->getOperand(0))) {
2098 Value *X = LHSI->getOperand(1);
2099 APInt C1 = RHS->getValue();
2100 APInt C2 = DivLHS->getValue();
2101 assert(C2 != 0 && "udiv 0, X should have been simplified already.");
2102 // (icmp ugt (udiv C2, X), C1) -> (icmp ule X, C2/(C1+1))
2103 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
2104 assert(!C1.isMaxValue() &&
2105 "icmp ugt X, UINT_MAX should have been simplified already.");
2106 return new ICmpInst(ICmpInst::ICMP_ULE, X,
2107 ConstantInt::get(X->getType(), C2.udiv(C1 + 1)));
2108 }
2109 // (icmp ult (udiv C2, X), C1) -> (icmp ugt X, C2/C1)
2110 if (ICI.getPredicate() == ICmpInst::ICMP_ULT) {
2111 assert(C1 != 0 && "icmp ult X, 0 should have been simplified already.");
2112 return new ICmpInst(ICmpInst::ICMP_UGT, X,
2113 ConstantInt::get(X->getType(), C2.udiv(C1)));
2114 }
2115 }
2116 // fall-through
2117 case Instruction::SDiv:
Chris Lattner2188e402010-01-04 07:37:31 +00002118 // Fold: icmp pred ([us]div X, C1), C2 -> range test
Jim Grosbach129c52a2011-09-30 18:09:53 +00002119 // Fold this div into the comparison, producing a range check.
2120 // Determine, based on the divide type, what the range is being
2121 // checked. If there is an overflow on the low or high side, remember
Chris Lattner2188e402010-01-04 07:37:31 +00002122 // it, otherwise compute the range [low, hi) bounding the new value.
2123 // See: InsertRangeTest above for the kinds of replacements possible.
2124 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
2125 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
2126 DivRHS))
2127 return R;
2128 break;
2129
David Majnemerf2a9a512013-07-09 07:50:59 +00002130 case Instruction::Sub: {
2131 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
2132 if (!LHSC) break;
2133 const APInt &LHSV = LHSC->getValue();
2134
2135 // C1-X <u C2 -> (X|(C2-1)) == C1
2136 // iff C1 & (C2-1) == C2-1
2137 // C2 is a power of 2
2138 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
2139 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
2140 return new ICmpInst(ICmpInst::ICMP_EQ,
2141 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
2142 LHSC);
2143
David Majnemereeed73b2013-07-09 09:24:35 +00002144 // C1-X >u C2 -> (X|C2) != C1
David Majnemerf2a9a512013-07-09 07:50:59 +00002145 // iff C1 & C2 == C2
2146 // C2+1 is a power of 2
2147 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
2148 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
2149 return new ICmpInst(ICmpInst::ICMP_NE,
2150 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
2151 break;
2152 }
2153
Chris Lattner2188e402010-01-04 07:37:31 +00002154 case Instruction::Add:
2155 // Fold: icmp pred (add X, C1), C2
2156 if (!ICI.isEquality()) {
2157 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
2158 if (!LHSC) break;
2159 const APInt &LHSV = LHSC->getValue();
2160
2161 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
2162 .subtract(LHSV);
2163
2164 if (ICI.isSigned()) {
2165 if (CR.getLower().isSignBit()) {
2166 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00002167 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00002168 } else if (CR.getUpper().isSignBit()) {
2169 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00002170 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00002171 }
2172 } else {
2173 if (CR.getLower().isMinValue()) {
2174 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00002175 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00002176 } else if (CR.getUpper().isMinValue()) {
2177 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00002178 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00002179 }
2180 }
David Majnemerfa90a0b2013-07-08 11:53:08 +00002181
David Majnemerbafa5372013-07-09 07:58:32 +00002182 // X-C1 <u C2 -> (X & -C2) == C1
2183 // iff C1 & (C2-1) == 0
2184 // C2 is a power of 2
David Majnemerfa90a0b2013-07-08 11:53:08 +00002185 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
David Majnemerbafa5372013-07-09 07:58:32 +00002186 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
David Majnemerfa90a0b2013-07-08 11:53:08 +00002187 return new ICmpInst(ICmpInst::ICMP_EQ,
2188 Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
2189 ConstantExpr::getNeg(LHSC));
David Majnemerbafa5372013-07-09 07:58:32 +00002190
David Majnemereeed73b2013-07-09 09:24:35 +00002191 // X-C1 >u C2 -> (X & ~C2) != C1
David Majnemerbafa5372013-07-09 07:58:32 +00002192 // iff C1 & C2 == 0
2193 // C2+1 is a power of 2
2194 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
2195 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
2196 return new ICmpInst(ICmpInst::ICMP_NE,
2197 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
2198 ConstantExpr::getNeg(LHSC));
Chris Lattner2188e402010-01-04 07:37:31 +00002199 }
2200 break;
2201 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002202
Chris Lattner2188e402010-01-04 07:37:31 +00002203 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
2204 if (ICI.isEquality()) {
2205 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002206
2207 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
Chris Lattner2188e402010-01-04 07:37:31 +00002208 // the second operand is a constant, simplify a bit.
2209 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
2210 switch (BO->getOpcode()) {
2211 case Instruction::SRem:
2212 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
2213 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
2214 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
Dan Gohman4ce1fb12010-04-08 23:03:40 +00002215 if (V.sgt(1) && V.isPowerOf2()) {
Chris Lattner2188e402010-01-04 07:37:31 +00002216 Value *NewRem =
2217 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
2218 BO->getName());
2219 return new ICmpInst(ICI.getPredicate(), NewRem,
2220 Constant::getNullValue(BO->getType()));
2221 }
2222 }
2223 break;
2224 case Instruction::Add:
2225 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
2226 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2227 if (BO->hasOneUse())
2228 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2229 ConstantExpr::getSub(RHS, BOp1C));
2230 } else if (RHSV == 0) {
2231 // Replace ((add A, B) != 0) with (A != -B) if A or B is
2232 // efficiently invertible, or if the add has just this one use.
2233 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002234
Chris Lattner2188e402010-01-04 07:37:31 +00002235 if (Value *NegVal = dyn_castNegVal(BOp1))
2236 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
Chris Lattner31b106d2011-04-26 20:02:45 +00002237 if (Value *NegVal = dyn_castNegVal(BOp0))
Chris Lattner2188e402010-01-04 07:37:31 +00002238 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
Chris Lattner31b106d2011-04-26 20:02:45 +00002239 if (BO->hasOneUse()) {
Chris Lattner2188e402010-01-04 07:37:31 +00002240 Value *Neg = Builder->CreateNeg(BOp1);
2241 Neg->takeName(BO);
2242 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
2243 }
2244 }
2245 break;
2246 case Instruction::Xor:
David Majnemer0f0abc72016-02-12 18:12:38 +00002247 if (BO->hasOneUse()) {
2248 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
2249 // For the xor case, we can xor two constants together, eliminating
2250 // the explicit xor.
2251 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2252 ConstantExpr::getXor(RHS, BOC));
2253 } else if (RHSV == 0) {
2254 // Replace ((xor A, B) != 0) with (A != B)
2255 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2256 BO->getOperand(1));
2257 }
Benjamin Kramerc9708492011-06-13 15:24:24 +00002258 }
Chris Lattner2188e402010-01-04 07:37:31 +00002259 break;
Benjamin Kramerc9708492011-06-13 15:24:24 +00002260 case Instruction::Sub:
David Majnemer0f0abc72016-02-12 18:12:38 +00002261 if (BO->hasOneUse()) {
2262 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
2263 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
Benjamin Kramerc9708492011-06-13 15:24:24 +00002264 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
David Majnemer0f0abc72016-02-12 18:12:38 +00002265 ConstantExpr::getSub(BOp0C, RHS));
2266 } else if (RHSV == 0) {
2267 // Replace ((sub A, B) != 0) with (A != B)
2268 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2269 BO->getOperand(1));
2270 }
Benjamin Kramerc9708492011-06-13 15:24:24 +00002271 }
2272 break;
Chris Lattner2188e402010-01-04 07:37:31 +00002273 case Instruction::Or:
2274 // If bits are being or'd in that are not present in the constant we
2275 // are comparing against, then the comparison could never succeed!
Eli Friedman0428a612010-07-29 18:03:33 +00002276 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002277 Constant *NotCI = ConstantExpr::getNot(RHS);
2278 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
Sanjay Patel4b198802016-02-01 22:23:39 +00002279 return replaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Sanjay Patele998b912016-04-14 20:17:40 +00002280
2281 // Comparing if all bits outside of a constant mask are set?
2282 // Replace (X | C) == -1 with (X & ~C) == ~C.
2283 // This removes the -1 constant.
2284 if (BO->hasOneUse() && RHS->isAllOnesValue()) {
2285 Constant *NotBOC = ConstantExpr::getNot(BOC);
2286 Value *And = Builder->CreateAnd(BO->getOperand(0), NotBOC);
2287 return new ICmpInst(ICI.getPredicate(), And, NotBOC);
2288 }
Chris Lattner2188e402010-01-04 07:37:31 +00002289 }
2290 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002291
Chris Lattner2188e402010-01-04 07:37:31 +00002292 case Instruction::And:
2293 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2294 // If bits are being compared against that are and'd out, then the
2295 // comparison can never succeed!
2296 if ((RHSV & ~BOC->getValue()) != 0)
Sanjay Patel4b198802016-02-01 22:23:39 +00002297 return replaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002298
Chris Lattner2188e402010-01-04 07:37:31 +00002299 // If we have ((X & C) == C), turn it into ((X & C) != 0).
2300 if (RHS == BOC && RHSV.isPowerOf2())
2301 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
2302 ICmpInst::ICMP_NE, LHSI,
2303 Constant::getNullValue(RHS->getType()));
Benjamin Kramer9eca5fe2011-07-04 20:16:36 +00002304
2305 // Don't perform the following transforms if the AND has multiple uses
2306 if (!BO->hasOneUse())
2307 break;
2308
Chris Lattner2188e402010-01-04 07:37:31 +00002309 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
2310 if (BOC->getValue().isSignBit()) {
2311 Value *X = BO->getOperand(0);
2312 Constant *Zero = Constant::getNullValue(X->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002313 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00002314 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
2315 return new ICmpInst(pred, X, Zero);
2316 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002317
Chris Lattner2188e402010-01-04 07:37:31 +00002318 // ((X & ~7) == 0) --> X < 8
2319 if (RHSV == 0 && isHighOnes(BOC)) {
2320 Value *X = BO->getOperand(0);
2321 Constant *NegX = ConstantExpr::getNeg(BOC);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002322 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00002323 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
2324 return new ICmpInst(pred, X, NegX);
2325 }
2326 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00002327 break;
2328 case Instruction::Mul:
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00002329 if (RHSV == 0 && BO->hasNoSignedWrap()) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00002330 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2331 // The trivial case (mul X, 0) is handled by InstSimplify
2332 // General case : (mul X, C) != 0 iff X != 0
2333 // (mul X, C) == 0 iff X == 0
2334 if (!BOC->isZero())
2335 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
2336 Constant::getNullValue(RHS->getType()));
2337 }
2338 }
2339 break;
Chris Lattner2188e402010-01-04 07:37:31 +00002340 default: break;
2341 }
2342 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
2343 // Handle icmp {eq|ne} <intrinsic>, intcst.
Chris Lattner54f4e392010-01-05 18:09:56 +00002344 switch (II->getIntrinsicID()) {
2345 case Intrinsic::bswap:
Chris Lattner2188e402010-01-04 07:37:31 +00002346 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00002347 ICI.setOperand(0, II->getArgOperand(0));
Jakub Staszakbddea112013-06-06 20:18:46 +00002348 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
Chris Lattner2188e402010-01-04 07:37:31 +00002349 return &ICI;
Chris Lattner54f4e392010-01-05 18:09:56 +00002350 case Intrinsic::ctlz:
2351 case Intrinsic::cttz:
2352 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
2353 if (RHSV == RHS->getType()->getBitWidth()) {
2354 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00002355 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00002356 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
2357 return &ICI;
2358 }
2359 break;
2360 case Intrinsic::ctpop:
2361 // popcount(A) == 0 -> A == 0 and likewise for !=
2362 if (RHS->isZero()) {
2363 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00002364 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00002365 ICI.setOperand(1, RHS);
2366 return &ICI;
2367 }
2368 break;
2369 default:
Duncan Sands41b4a6b2010-07-12 08:16:59 +00002370 break;
Chris Lattner2188e402010-01-04 07:37:31 +00002371 }
2372 }
2373 }
Craig Topperf40110f2014-04-25 05:29:35 +00002374 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002375}
2376
2377/// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
2378/// We only handle extending casts so far.
2379///
2380Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
2381 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
2382 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00002383 Type *SrcTy = LHSCIOp->getType();
2384 Type *DestTy = LHSCI->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00002385 Value *RHSCIOp;
2386
Jim Grosbach129c52a2011-09-30 18:09:53 +00002387 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner2188e402010-01-04 07:37:31 +00002388 // integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002389 if (LHSCI->getOpcode() == Instruction::PtrToInt &&
2390 DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
Craig Topperf40110f2014-04-25 05:29:35 +00002391 Value *RHSOp = nullptr;
Michael Liaod266b922015-02-13 04:51:26 +00002392 if (PtrToIntOperator *RHSC = dyn_cast<PtrToIntOperator>(ICI.getOperand(1))) {
2393 Value *RHSCIOp = RHSC->getOperand(0);
2394 if (RHSCIOp->getType()->getPointerAddressSpace() ==
2395 LHSCIOp->getType()->getPointerAddressSpace()) {
2396 RHSOp = RHSC->getOperand(0);
2397 // If the pointer types don't match, insert a bitcast.
2398 if (LHSCIOp->getType() != RHSOp->getType())
2399 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
2400 }
2401 } else if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1)))
Chris Lattner2188e402010-01-04 07:37:31 +00002402 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
Chris Lattner2188e402010-01-04 07:37:31 +00002403
2404 if (RHSOp)
2405 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
2406 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002407
Chris Lattner2188e402010-01-04 07:37:31 +00002408 // The code below only handles extension cast instructions, so far.
2409 // Enforce this.
2410 if (LHSCI->getOpcode() != Instruction::ZExt &&
2411 LHSCI->getOpcode() != Instruction::SExt)
Craig Topperf40110f2014-04-25 05:29:35 +00002412 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002413
2414 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
2415 bool isSignedCmp = ICI.isSigned();
2416
2417 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
2418 // Not an extension from the same type?
2419 RHSCIOp = CI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002420 if (RHSCIOp->getType() != LHSCIOp->getType())
Craig Topperf40110f2014-04-25 05:29:35 +00002421 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002422
Chris Lattner2188e402010-01-04 07:37:31 +00002423 // If the signedness of the two casts doesn't agree (i.e. one is a sext
2424 // and the other is a zext), then we can't handle this.
2425 if (CI->getOpcode() != LHSCI->getOpcode())
Craig Topperf40110f2014-04-25 05:29:35 +00002426 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002427
2428 // Deal with equality cases early.
2429 if (ICI.isEquality())
2430 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
2431
2432 // A signed comparison of sign extended values simplifies into a
2433 // signed comparison.
2434 if (isSignedCmp && isSignedExt)
2435 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
2436
2437 // The other three cases all fold into an unsigned comparison.
2438 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
2439 }
2440
2441 // If we aren't dealing with a constant on the RHS, exit early
2442 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
2443 if (!CI)
Craig Topperf40110f2014-04-25 05:29:35 +00002444 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002445
2446 // Compute the constant that would happen if we truncated to SrcTy then
2447 // reextended to DestTy.
2448 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
2449 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
2450 Res1, DestTy);
2451
2452 // If the re-extended constant didn't change...
2453 if (Res2 == CI) {
2454 // Deal with equality cases early.
2455 if (ICI.isEquality())
2456 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
2457
2458 // A signed comparison of sign extended values simplifies into a
2459 // signed comparison.
2460 if (isSignedExt && isSignedCmp)
2461 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
2462
2463 // The other three cases all fold into an unsigned comparison.
2464 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
2465 }
2466
Jim Grosbach129c52a2011-09-30 18:09:53 +00002467 // The re-extended constant changed so the constant cannot be represented
Chris Lattner2188e402010-01-04 07:37:31 +00002468 // in the shorter type. Consequently, we cannot emit a simple comparison.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002469 // All the cases that fold to true or false will have already been handled
2470 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner2188e402010-01-04 07:37:31 +00002471
Duncan Sands8fb2c382011-01-20 13:21:55 +00002472 if (isSignedCmp || !isSignedExt)
Craig Topperf40110f2014-04-25 05:29:35 +00002473 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002474
2475 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
2476 // should have been folded away previously and not enter in here.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002477
2478 // We're performing an unsigned comp with a sign extended value.
2479 // This is true if the input is >= 0. [aka >s -1]
2480 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
2481 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
Chris Lattner2188e402010-01-04 07:37:31 +00002482
2483 // Finally, return the value computed.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002484 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
Sanjay Patel4b198802016-02-01 22:23:39 +00002485 return replaceInstUsesWith(ICI, Result);
Chris Lattner2188e402010-01-04 07:37:31 +00002486
Duncan Sands8fb2c382011-01-20 13:21:55 +00002487 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner2188e402010-01-04 07:37:31 +00002488 return BinaryOperator::CreateNot(Result);
2489}
2490
Chris Lattneree61c1d2010-12-19 17:52:50 +00002491/// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
2492/// I = icmp ugt (add (add A, B), CI2), CI1
Chris Lattnerc56c8452010-12-19 18:22:06 +00002493/// If this is of the form:
2494/// sum = a + b
2495/// if (sum+128 >u 255)
2496/// Then replace it with llvm.sadd.with.overflow.i8.
2497///
Chris Lattneree61c1d2010-12-19 17:52:50 +00002498static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2499 ConstantInt *CI2, ConstantInt *CI1,
Chris Lattnerce2995a2010-12-19 18:38:44 +00002500 InstCombiner &IC) {
Chris Lattnerf29562d2010-12-19 17:59:02 +00002501 // The transformation we're trying to do here is to transform this into an
2502 // llvm.sadd.with.overflow. To do this, we have to replace the original add
2503 // with a narrower add, and discard the add-with-constant that is part of the
2504 // range check (if we can't eliminate it, this isn't profitable).
Jim Grosbach129c52a2011-09-30 18:09:53 +00002505
Chris Lattnerf29562d2010-12-19 17:59:02 +00002506 // In order to eliminate the add-with-constant, the compare can be its only
2507 // use.
Chris Lattnerc56c8452010-12-19 18:22:06 +00002508 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
Craig Topperf40110f2014-04-25 05:29:35 +00002509 if (!AddWithCst->hasOneUse()) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002510
Chris Lattnerc56c8452010-12-19 18:22:06 +00002511 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
Craig Topperf40110f2014-04-25 05:29:35 +00002512 if (!CI2->getValue().isPowerOf2()) return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002513 unsigned NewWidth = CI2->getValue().countTrailingZeros();
Craig Topperf40110f2014-04-25 05:29:35 +00002514 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002515
Chris Lattnerc56c8452010-12-19 18:22:06 +00002516 // The width of the new add formed is 1 more than the bias.
2517 ++NewWidth;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002518
Chris Lattnerc56c8452010-12-19 18:22:06 +00002519 // Check to see that CI1 is an all-ones value with NewWidth bits.
2520 if (CI1->getBitWidth() == NewWidth ||
2521 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
Craig Topperf40110f2014-04-25 05:29:35 +00002522 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002523
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002524 // This is only really a signed overflow check if the inputs have been
2525 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2526 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2527 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
Hal Finkel60db0582014-09-07 18:57:58 +00002528 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
2529 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
Craig Topperf40110f2014-04-25 05:29:35 +00002530 return nullptr;
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002531
Jim Grosbach129c52a2011-09-30 18:09:53 +00002532 // In order to replace the original add with a narrower
Chris Lattnerc56c8452010-12-19 18:22:06 +00002533 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2534 // and truncates that discard the high bits of the add. Verify that this is
2535 // the case.
2536 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
Chandler Carruthcdf47882014-03-09 03:16:01 +00002537 for (User *U : OrigAdd->users()) {
2538 if (U == AddWithCst) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002539
Chris Lattnerc56c8452010-12-19 18:22:06 +00002540 // Only accept truncates for now. We would really like a nice recursive
2541 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2542 // chain to see which bits of a value are actually demanded. If the
2543 // original add had another add which was then immediately truncated, we
2544 // could still do the transformation.
Chandler Carruthcdf47882014-03-09 03:16:01 +00002545 TruncInst *TI = dyn_cast<TruncInst>(U);
Craig Topperf40110f2014-04-25 05:29:35 +00002546 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2547 return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002548 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002549
Chris Lattneree61c1d2010-12-19 17:52:50 +00002550 // If the pattern matches, truncate the inputs to the narrower type and
2551 // use the sadd_with_overflow intrinsic to efficiently compute both the
2552 // result and the overflow bit.
Jay Foadb804a2b2011-07-12 14:06:48 +00002553 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
Sanjay Patelaf674fb2015-12-14 17:24:23 +00002554 Value *F = Intrinsic::getDeclaration(I.getModule(),
2555 Intrinsic::sadd_with_overflow, NewType);
Chris Lattner79874562010-12-19 18:35:09 +00002556
Chris Lattnerce2995a2010-12-19 18:38:44 +00002557 InstCombiner::BuilderTy *Builder = IC.Builder;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002558
Chris Lattner79874562010-12-19 18:35:09 +00002559 // Put the new code above the original add, in case there are any uses of the
2560 // add between the add and the compare.
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002561 Builder->SetInsertPoint(OrigAdd);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002562
Chris Lattner79874562010-12-19 18:35:09 +00002563 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2564 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
David Blaikieff6409d2015-05-18 22:13:54 +00002565 CallInst *Call = Builder->CreateCall(F, {TruncA, TruncB}, "sadd");
Chris Lattner79874562010-12-19 18:35:09 +00002566 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2567 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002568
Chris Lattneree61c1d2010-12-19 17:52:50 +00002569 // The inner add was the result of the narrow add, zero extended to the
2570 // wider type. Replace it with the result computed by the intrinsic.
Sanjay Patel4b198802016-02-01 22:23:39 +00002571 IC.replaceInstUsesWith(*OrigAdd, ZExt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002572
Chris Lattner79874562010-12-19 18:35:09 +00002573 // The original icmp gets replaced with the overflow value.
2574 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
Chris Lattneree61c1d2010-12-19 17:52:50 +00002575}
Chris Lattner2188e402010-01-04 07:37:31 +00002576
Sanjoy Dasb0984472015-04-08 04:27:22 +00002577bool InstCombiner::OptimizeOverflowCheck(OverflowCheckFlavor OCF, Value *LHS,
2578 Value *RHS, Instruction &OrigI,
2579 Value *&Result, Constant *&Overflow) {
Sanjoy Das827529e2015-08-11 21:33:55 +00002580 if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
2581 std::swap(LHS, RHS);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002582
2583 auto SetResult = [&](Value *OpResult, Constant *OverflowVal, bool ReuseName) {
2584 Result = OpResult;
2585 Overflow = OverflowVal;
2586 if (ReuseName)
2587 Result->takeName(&OrigI);
2588 return true;
2589 };
2590
Sanjoy Das6f5dca72015-08-28 19:09:31 +00002591 // If the overflow check was an add followed by a compare, the insertion point
2592 // may be pointing to the compare. We want to insert the new instructions
2593 // before the add in case there are uses of the add between the add and the
2594 // compare.
2595 Builder->SetInsertPoint(&OrigI);
2596
Sanjoy Dasb0984472015-04-08 04:27:22 +00002597 switch (OCF) {
2598 case OCF_INVALID:
2599 llvm_unreachable("bad overflow check kind!");
2600
2601 case OCF_UNSIGNED_ADD: {
2602 OverflowResult OR = computeOverflowForUnsignedAdd(LHS, RHS, &OrigI);
2603 if (OR == OverflowResult::NeverOverflows)
2604 return SetResult(Builder->CreateNUWAdd(LHS, RHS), Builder->getFalse(),
2605 true);
2606
2607 if (OR == OverflowResult::AlwaysOverflows)
2608 return SetResult(Builder->CreateAdd(LHS, RHS), Builder->getTrue(), true);
2609 }
2610 // FALL THROUGH uadd into sadd
2611 case OCF_SIGNED_ADD: {
David Majnemer27e89ba2015-05-21 23:04:21 +00002612 // X + 0 -> {X, false}
2613 if (match(RHS, m_Zero()))
2614 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002615
2616 // We can strength reduce this signed add into a regular add if we can prove
2617 // that it will never overflow.
2618 if (OCF == OCF_SIGNED_ADD)
2619 if (WillNotOverflowSignedAdd(LHS, RHS, OrigI))
2620 return SetResult(Builder->CreateNSWAdd(LHS, RHS), Builder->getFalse(),
2621 true);
Sanjoy Das72cb5e12015-06-05 18:04:42 +00002622 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002623 }
2624
2625 case OCF_UNSIGNED_SUB:
2626 case OCF_SIGNED_SUB: {
David Majnemer27e89ba2015-05-21 23:04:21 +00002627 // X - 0 -> {X, false}
2628 if (match(RHS, m_Zero()))
2629 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002630
2631 if (OCF == OCF_SIGNED_SUB) {
2632 if (WillNotOverflowSignedSub(LHS, RHS, OrigI))
2633 return SetResult(Builder->CreateNSWSub(LHS, RHS), Builder->getFalse(),
2634 true);
2635 } else {
2636 if (WillNotOverflowUnsignedSub(LHS, RHS, OrigI))
2637 return SetResult(Builder->CreateNUWSub(LHS, RHS), Builder->getFalse(),
2638 true);
2639 }
2640 break;
2641 }
2642
2643 case OCF_UNSIGNED_MUL: {
2644 OverflowResult OR = computeOverflowForUnsignedMul(LHS, RHS, &OrigI);
2645 if (OR == OverflowResult::NeverOverflows)
2646 return SetResult(Builder->CreateNUWMul(LHS, RHS), Builder->getFalse(),
2647 true);
2648 if (OR == OverflowResult::AlwaysOverflows)
2649 return SetResult(Builder->CreateMul(LHS, RHS), Builder->getTrue(), true);
2650 } // FALL THROUGH
2651 case OCF_SIGNED_MUL:
2652 // X * undef -> undef
2653 if (isa<UndefValue>(RHS))
David Majnemer27e89ba2015-05-21 23:04:21 +00002654 return SetResult(RHS, UndefValue::get(Builder->getInt1Ty()), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002655
David Majnemer27e89ba2015-05-21 23:04:21 +00002656 // X * 0 -> {0, false}
2657 if (match(RHS, m_Zero()))
2658 return SetResult(RHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002659
David Majnemer27e89ba2015-05-21 23:04:21 +00002660 // X * 1 -> {X, false}
2661 if (match(RHS, m_One()))
2662 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002663
2664 if (OCF == OCF_SIGNED_MUL)
2665 if (WillNotOverflowSignedMul(LHS, RHS, OrigI))
2666 return SetResult(Builder->CreateNSWMul(LHS, RHS), Builder->getFalse(),
2667 true);
Sanjoy Dasc80dad62015-06-05 18:04:46 +00002668 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002669 }
2670
2671 return false;
2672}
2673
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002674/// \brief Recognize and process idiom involving test for multiplication
2675/// overflow.
2676///
2677/// The caller has matched a pattern of the form:
2678/// I = cmp u (mul(zext A, zext B), V
2679/// The function checks if this is a test for overflow and if so replaces
2680/// multiplication with call to 'mul.with.overflow' intrinsic.
2681///
2682/// \param I Compare instruction.
2683/// \param MulVal Result of 'mult' instruction. It is one of the arguments of
2684/// the compare instruction. Must be of integer type.
2685/// \param OtherVal The other argument of compare instruction.
2686/// \returns Instruction which must replace the compare instruction, NULL if no
2687/// replacement required.
2688static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2689 Value *OtherVal, InstCombiner &IC) {
Benjamin Kramerc96a7f82014-06-24 10:47:52 +00002690 // Don't bother doing this transformation for pointers, don't do it for
2691 // vectors.
2692 if (!isa<IntegerType>(MulVal->getType()))
2693 return nullptr;
2694
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002695 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2696 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
David Majnemerdaa24b92015-09-05 20:44:56 +00002697 auto *MulInstr = dyn_cast<Instruction>(MulVal);
2698 if (!MulInstr)
2699 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002700 assert(MulInstr->getOpcode() == Instruction::Mul);
2701
David Majnemer634ca232014-11-01 23:46:05 +00002702 auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
2703 *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002704 assert(LHS->getOpcode() == Instruction::ZExt);
2705 assert(RHS->getOpcode() == Instruction::ZExt);
2706 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2707
2708 // Calculate type and width of the result produced by mul.with.overflow.
2709 Type *TyA = A->getType(), *TyB = B->getType();
2710 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2711 WidthB = TyB->getPrimitiveSizeInBits();
2712 unsigned MulWidth;
2713 Type *MulType;
2714 if (WidthB > WidthA) {
2715 MulWidth = WidthB;
2716 MulType = TyB;
2717 } else {
2718 MulWidth = WidthA;
2719 MulType = TyA;
2720 }
2721
2722 // In order to replace the original mul with a narrower mul.with.overflow,
2723 // all uses must ignore upper bits of the product. The number of used low
2724 // bits must be not greater than the width of mul.with.overflow.
2725 if (MulVal->hasNUsesOrMore(2))
2726 for (User *U : MulVal->users()) {
2727 if (U == &I)
2728 continue;
2729 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2730 // Check if truncation ignores bits above MulWidth.
2731 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2732 if (TruncWidth > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002733 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002734 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2735 // Check if AND ignores bits above MulWidth.
2736 if (BO->getOpcode() != Instruction::And)
Craig Topperf40110f2014-04-25 05:29:35 +00002737 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002738 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2739 const APInt &CVal = CI->getValue();
2740 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002741 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002742 }
2743 } else {
2744 // Other uses prohibit this transformation.
Craig Topperf40110f2014-04-25 05:29:35 +00002745 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002746 }
2747 }
2748
2749 // Recognize patterns
2750 switch (I.getPredicate()) {
2751 case ICmpInst::ICMP_EQ:
2752 case ICmpInst::ICMP_NE:
2753 // Recognize pattern:
2754 // mulval = mul(zext A, zext B)
2755 // cmp eq/neq mulval, zext trunc mulval
2756 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2757 if (Zext->hasOneUse()) {
2758 Value *ZextArg = Zext->getOperand(0);
2759 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2760 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2761 break; //Recognized
2762 }
2763
2764 // Recognize pattern:
2765 // mulval = mul(zext A, zext B)
2766 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2767 ConstantInt *CI;
2768 Value *ValToMask;
2769 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2770 if (ValToMask != MulVal)
Craig Topperf40110f2014-04-25 05:29:35 +00002771 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002772 const APInt &CVal = CI->getValue() + 1;
2773 if (CVal.isPowerOf2()) {
2774 unsigned MaskWidth = CVal.logBase2();
2775 if (MaskWidth == MulWidth)
2776 break; // Recognized
2777 }
2778 }
Craig Topperf40110f2014-04-25 05:29:35 +00002779 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002780
2781 case ICmpInst::ICMP_UGT:
2782 // Recognize pattern:
2783 // mulval = mul(zext A, zext B)
2784 // cmp ugt mulval, max
2785 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2786 APInt MaxVal = APInt::getMaxValue(MulWidth);
2787 MaxVal = MaxVal.zext(CI->getBitWidth());
2788 if (MaxVal.eq(CI->getValue()))
2789 break; // Recognized
2790 }
Craig Topperf40110f2014-04-25 05:29:35 +00002791 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002792
2793 case ICmpInst::ICMP_UGE:
2794 // Recognize pattern:
2795 // mulval = mul(zext A, zext B)
2796 // cmp uge mulval, max+1
2797 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2798 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2799 if (MaxVal.eq(CI->getValue()))
2800 break; // Recognized
2801 }
Craig Topperf40110f2014-04-25 05:29:35 +00002802 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002803
2804 case ICmpInst::ICMP_ULE:
2805 // Recognize pattern:
2806 // mulval = mul(zext A, zext B)
2807 // cmp ule mulval, max
2808 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2809 APInt MaxVal = APInt::getMaxValue(MulWidth);
2810 MaxVal = MaxVal.zext(CI->getBitWidth());
2811 if (MaxVal.eq(CI->getValue()))
2812 break; // Recognized
2813 }
Craig Topperf40110f2014-04-25 05:29:35 +00002814 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002815
2816 case ICmpInst::ICMP_ULT:
2817 // Recognize pattern:
2818 // mulval = mul(zext A, zext B)
2819 // cmp ule mulval, max + 1
2820 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002821 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002822 if (MaxVal.eq(CI->getValue()))
2823 break; // Recognized
2824 }
Craig Topperf40110f2014-04-25 05:29:35 +00002825 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002826
2827 default:
Craig Topperf40110f2014-04-25 05:29:35 +00002828 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002829 }
2830
2831 InstCombiner::BuilderTy *Builder = IC.Builder;
2832 Builder->SetInsertPoint(MulInstr);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002833
2834 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2835 Value *MulA = A, *MulB = B;
2836 if (WidthA < MulWidth)
2837 MulA = Builder->CreateZExt(A, MulType);
2838 if (WidthB < MulWidth)
2839 MulB = Builder->CreateZExt(B, MulType);
Sanjay Patelaf674fb2015-12-14 17:24:23 +00002840 Value *F = Intrinsic::getDeclaration(I.getModule(),
2841 Intrinsic::umul_with_overflow, MulType);
David Blaikieff6409d2015-05-18 22:13:54 +00002842 CallInst *Call = Builder->CreateCall(F, {MulA, MulB}, "umul");
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002843 IC.Worklist.Add(MulInstr);
2844
2845 // If there are uses of mul result other than the comparison, we know that
2846 // they are truncation or binary AND. Change them to use result of
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002847 // mul.with.overflow and adjust properly mask/size.
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002848 if (MulVal->hasNUsesOrMore(2)) {
2849 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2850 for (User *U : MulVal->users()) {
2851 if (U == &I || U == OtherVal)
2852 continue;
2853 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2854 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
Sanjay Patel4b198802016-02-01 22:23:39 +00002855 IC.replaceInstUsesWith(*TI, Mul);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002856 else
2857 TI->setOperand(0, Mul);
2858 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2859 assert(BO->getOpcode() == Instruction::And);
2860 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2861 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2862 APInt ShortMask = CI->getValue().trunc(MulWidth);
2863 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2864 Instruction *Zext =
2865 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2866 IC.Worklist.Add(Zext);
Sanjay Patel4b198802016-02-01 22:23:39 +00002867 IC.replaceInstUsesWith(*BO, Zext);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002868 } else {
2869 llvm_unreachable("Unexpected Binary operation");
2870 }
2871 IC.Worklist.Add(cast<Instruction>(U));
2872 }
2873 }
2874 if (isa<Instruction>(OtherVal))
2875 IC.Worklist.Add(cast<Instruction>(OtherVal));
2876
2877 // The original icmp gets replaced with the overflow value, maybe inverted
2878 // depending on predicate.
2879 bool Inverse = false;
2880 switch (I.getPredicate()) {
2881 case ICmpInst::ICMP_NE:
2882 break;
2883 case ICmpInst::ICMP_EQ:
2884 Inverse = true;
2885 break;
2886 case ICmpInst::ICMP_UGT:
2887 case ICmpInst::ICMP_UGE:
2888 if (I.getOperand(0) == MulVal)
2889 break;
2890 Inverse = true;
2891 break;
2892 case ICmpInst::ICMP_ULT:
2893 case ICmpInst::ICMP_ULE:
2894 if (I.getOperand(1) == MulVal)
2895 break;
2896 Inverse = true;
2897 break;
2898 default:
2899 llvm_unreachable("Unexpected predicate");
2900 }
2901 if (Inverse) {
2902 Value *Res = Builder->CreateExtractValue(Call, 1);
2903 return BinaryOperator::CreateNot(Res);
2904 }
2905
2906 return ExtractValueInst::Create(Call, 1);
2907}
2908
Owen Andersond490c2d2011-01-11 00:36:45 +00002909// DemandedBitsLHSMask - When performing a comparison against a constant,
2910// it is possible that not all the bits in the LHS are demanded. This helper
2911// method computes the mask that IS demanded.
2912static APInt DemandedBitsLHSMask(ICmpInst &I,
2913 unsigned BitWidth, bool isSignCheck) {
2914 if (isSignCheck)
2915 return APInt::getSignBit(BitWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002916
Owen Andersond490c2d2011-01-11 00:36:45 +00002917 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2918 if (!CI) return APInt::getAllOnesValue(BitWidth);
Owen Anderson0022a4b2011-01-11 18:26:37 +00002919 const APInt &RHS = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002920
Owen Andersond490c2d2011-01-11 00:36:45 +00002921 switch (I.getPredicate()) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002922 // For a UGT comparison, we don't care about any bits that
Owen Andersond490c2d2011-01-11 00:36:45 +00002923 // correspond to the trailing ones of the comparand. The value of these
2924 // bits doesn't impact the outcome of the comparison, because any value
2925 // greater than the RHS must differ in a bit higher than these due to carry.
2926 case ICmpInst::ICMP_UGT: {
2927 unsigned trailingOnes = RHS.countTrailingOnes();
2928 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2929 return ~lowBitsSet;
2930 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002931
Owen Andersond490c2d2011-01-11 00:36:45 +00002932 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2933 // Any value less than the RHS must differ in a higher bit because of carries.
2934 case ICmpInst::ICMP_ULT: {
2935 unsigned trailingZeros = RHS.countTrailingZeros();
2936 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2937 return ~lowBitsSet;
2938 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002939
Owen Andersond490c2d2011-01-11 00:36:45 +00002940 default:
2941 return APInt::getAllOnesValue(BitWidth);
2942 }
Owen Andersond490c2d2011-01-11 00:36:45 +00002943}
Chris Lattner2188e402010-01-04 07:37:31 +00002944
Quentin Colombet5ab55552013-09-09 20:56:48 +00002945/// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
2946/// should be swapped.
Alp Tokercb402912014-01-24 17:20:08 +00002947/// The decision is based on how many times these two operands are reused
Quentin Colombet5ab55552013-09-09 20:56:48 +00002948/// as subtract operands and their positions in those instructions.
2949/// The rational is that several architectures use the same instruction for
2950/// both subtract and cmp, thus it is better if the order of those operands
2951/// match.
2952/// \return true if Op0 and Op1 should be swapped.
2953static bool swapMayExposeCSEOpportunities(const Value * Op0,
2954 const Value * Op1) {
2955 // Filter out pointer value as those cannot appears directly in subtract.
2956 // FIXME: we may want to go through inttoptrs or bitcasts.
2957 if (Op0->getType()->isPointerTy())
2958 return false;
2959 // Count every uses of both Op0 and Op1 in a subtract.
2960 // Each time Op0 is the first operand, count -1: swapping is bad, the
2961 // subtract has already the same layout as the compare.
2962 // Each time Op0 is the second operand, count +1: swapping is good, the
Alp Tokercb402912014-01-24 17:20:08 +00002963 // subtract has a different layout as the compare.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002964 // At the end, if the benefit is greater than 0, Op0 should come second to
2965 // expose more CSE opportunities.
2966 int GlobalSwapBenefits = 0;
Chandler Carruthcdf47882014-03-09 03:16:01 +00002967 for (const User *U : Op0->users()) {
2968 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002969 if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
2970 continue;
2971 // If Op0 is the first argument, this is not beneficial to swap the
2972 // arguments.
2973 int LocalSwapBenefits = -1;
2974 unsigned Op1Idx = 1;
2975 if (BinOp->getOperand(Op1Idx) == Op0) {
2976 Op1Idx = 0;
2977 LocalSwapBenefits = 1;
2978 }
2979 if (BinOp->getOperand(Op1Idx) != Op1)
2980 continue;
2981 GlobalSwapBenefits += LocalSwapBenefits;
2982 }
2983 return GlobalSwapBenefits > 0;
2984}
2985
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00002986/// \brief Check that one use is in the same block as the definition and all
2987/// other uses are in blocks dominated by a given block
2988///
2989/// \param DI Definition
2990/// \param UI Use
2991/// \param DB Block that must dominate all uses of \p DI outside
2992/// the parent block
2993/// \return true when \p UI is the only use of \p DI in the parent block
2994/// and all other uses of \p DI are in blocks dominated by \p DB.
2995///
2996bool InstCombiner::dominatesAllUses(const Instruction *DI,
2997 const Instruction *UI,
2998 const BasicBlock *DB) const {
2999 assert(DI && UI && "Instruction not defined\n");
3000 // ignore incomplete definitions
3001 if (!DI->getParent())
3002 return false;
3003 // DI and UI must be in the same block
3004 if (DI->getParent() != UI->getParent())
3005 return false;
3006 // Protect from self-referencing blocks
3007 if (DI->getParent() == DB)
3008 return false;
3009 // DominatorTree available?
3010 if (!DT)
3011 return false;
3012 for (const User *U : DI->users()) {
3013 auto *Usr = cast<Instruction>(U);
3014 if (Usr != UI && !DT->dominates(DB, Usr->getParent()))
3015 return false;
3016 }
3017 return true;
3018}
3019
3020///
3021/// true when the instruction sequence within a block is select-cmp-br.
3022///
3023static bool isChainSelectCmpBranch(const SelectInst *SI) {
3024 const BasicBlock *BB = SI->getParent();
3025 if (!BB)
3026 return false;
3027 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
3028 if (!BI || BI->getNumSuccessors() != 2)
3029 return false;
3030 auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
3031 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
3032 return false;
3033 return true;
3034}
3035
3036///
3037/// \brief True when a select result is replaced by one of its operands
3038/// in select-icmp sequence. This will eventually result in the elimination
3039/// of the select.
3040///
3041/// \param SI Select instruction
3042/// \param Icmp Compare instruction
3043/// \param SIOpd Operand that replaces the select
3044///
3045/// Notes:
3046/// - The replacement is global and requires dominator information
3047/// - The caller is responsible for the actual replacement
3048///
3049/// Example:
3050///
3051/// entry:
3052/// %4 = select i1 %3, %C* %0, %C* null
3053/// %5 = icmp eq %C* %4, null
3054/// br i1 %5, label %9, label %7
3055/// ...
3056/// ; <label>:7 ; preds = %entry
3057/// %8 = getelementptr inbounds %C* %4, i64 0, i32 0
3058/// ...
3059///
3060/// can be transformed to
3061///
3062/// %5 = icmp eq %C* %0, null
3063/// %6 = select i1 %3, i1 %5, i1 true
3064/// br i1 %6, label %9, label %7
3065/// ...
3066/// ; <label>:7 ; preds = %entry
3067/// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0!
3068///
3069/// Similar when the first operand of the select is a constant or/and
3070/// the compare is for not equal rather than equal.
3071///
3072/// NOTE: The function is only called when the select and compare constants
3073/// are equal, the optimization can work only for EQ predicates. This is not a
3074/// major restriction since a NE compare should be 'normalized' to an equal
3075/// compare, which usually happens in the combiner and test case
3076/// select-cmp-br.ll
3077/// checks for it.
3078bool InstCombiner::replacedSelectWithOperand(SelectInst *SI,
3079 const ICmpInst *Icmp,
3080 const unsigned SIOpd) {
David Majnemer83484fd2014-11-22 06:09:28 +00003081 assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003082 if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
3083 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
3084 // The check for the unique predecessor is not the best that can be
3085 // done. But it protects efficiently against cases like when SI's
3086 // home block has two successors, Succ and Succ1, and Succ1 predecessor
3087 // of Succ. Then SI can't be replaced by SIOpd because the use that gets
3088 // replaced can be reached on either path. So the uniqueness check
3089 // guarantees that the path all uses of SI (outside SI's parent) are on
3090 // is disjoint from all other paths out of SI. But that information
3091 // is more expensive to compute, and the trade-off here is in favor
3092 // of compile-time.
3093 if (Succ->getUniquePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
3094 NumSel++;
3095 SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
3096 return true;
3097 }
3098 }
3099 return false;
3100}
3101
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003102/// If we have an icmp le or icmp ge instruction with a constant operand, turn
3103/// it into the appropriate icmp lt or icmp gt instruction. This transform
3104/// allows them to be folded in visitICmpInst.
Sanjay Patele9b2c322016-05-17 00:57:57 +00003105static ICmpInst *canonicalizeCmpWithConstant(ICmpInst &I) {
3106 ICmpInst::Predicate Pred = I.getPredicate();
3107 if (Pred != ICmpInst::ICMP_SLE && Pred != ICmpInst::ICMP_SGE &&
3108 Pred != ICmpInst::ICMP_ULE && Pred != ICmpInst::ICMP_UGE)
3109 return nullptr;
3110
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003111 Value *Op0 = I.getOperand(0);
3112 Value *Op1 = I.getOperand(1);
Sanjay Patele9b2c322016-05-17 00:57:57 +00003113 auto *Op1C = dyn_cast<Constant>(Op1);
3114 if (!Op1C)
3115 return nullptr;
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003116
Sanjay Patele9b2c322016-05-17 00:57:57 +00003117 // Check if the constant operand can be safely incremented/decremented without
3118 // overflowing/underflowing. For scalars, SimplifyICmpInst has already handled
3119 // the edge cases for us, so we just assert on them. For vectors, we must
3120 // handle the edge cases.
3121 Type *Op1Type = Op1->getType();
3122 bool IsSigned = I.isSigned();
3123 bool IsLE = (Pred == ICmpInst::ICMP_SLE || Pred == ICmpInst::ICMP_ULE);
Sanjay Patel18254932016-05-17 01:12:31 +00003124 auto *CI = dyn_cast<ConstantInt>(Op1C);
3125 if (CI) {
Sanjay Patele9b2c322016-05-17 00:57:57 +00003126 // A <= MAX -> TRUE ; A >= MIN -> TRUE
3127 assert(IsLE ? !CI->isMaxValue(IsSigned) : !CI->isMinValue(IsSigned));
3128 } else if (Op1Type->isVectorTy()) {
Sanjay Patelb79ab272016-05-13 15:10:46 +00003129 // TODO? If the edge cases for vectors were guaranteed to be handled as they
Sanjay Patele9b2c322016-05-17 00:57:57 +00003130 // are for scalar, we could remove the min/max checks. However, to do that,
3131 // we would have to use insertelement/shufflevector to replace edge values.
3132 unsigned NumElts = Op1Type->getVectorNumElements();
3133 for (unsigned i = 0; i != NumElts; ++i) {
3134 Constant *Elt = Op1C->getAggregateElement(i);
3135 if (isa<UndefValue>(Elt))
3136 continue;
3137 // Bail out if we can't determine if this constant is min/max or if we
3138 // know that this constant is min/max.
3139 auto *CI = dyn_cast<ConstantInt>(Elt);
3140 if (!CI || (IsLE ? CI->isMaxValue(IsSigned) : CI->isMinValue(IsSigned)))
3141 return nullptr;
Sanjay Patelb79ab272016-05-13 15:10:46 +00003142 }
Sanjay Patele9b2c322016-05-17 00:57:57 +00003143 } else {
3144 // ConstantExpr?
3145 return nullptr;
Sanjay Patelb79ab272016-05-13 15:10:46 +00003146 }
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003147
Sanjay Patele9b2c322016-05-17 00:57:57 +00003148 // Increment or decrement the constant and set the new comparison predicate:
3149 // ULE -> ULT ; UGE -> UGT ; SLE -> SLT ; SGE -> SGT
3150 Constant *OneOrNegOne = ConstantInt::get(Op1Type, IsLE ? 1 : -1);
3151 CmpInst::Predicate NewPred = IsLE ? ICmpInst::ICMP_ULT: ICmpInst::ICMP_UGT;
3152 NewPred = IsSigned ? ICmpInst::getSignedPredicate(NewPred) : NewPred;
3153 return new ICmpInst(NewPred, Op0, ConstantExpr::getAdd(Op1C, OneOrNegOne));
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003154}
3155
Chris Lattner2188e402010-01-04 07:37:31 +00003156Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
3157 bool Changed = false;
Chris Lattner9306ffa2010-02-01 19:54:45 +00003158 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Quentin Colombet5ab55552013-09-09 20:56:48 +00003159 unsigned Op0Cplxity = getComplexity(Op0);
3160 unsigned Op1Cplxity = getComplexity(Op1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003161
Chris Lattner2188e402010-01-04 07:37:31 +00003162 /// Orders the operands of the compare so that they are listed from most
3163 /// complex to least complex. This puts constants before unary operators,
3164 /// before binary operators.
Quentin Colombet5ab55552013-09-09 20:56:48 +00003165 if (Op0Cplxity < Op1Cplxity ||
3166 (Op0Cplxity == Op1Cplxity &&
3167 swapMayExposeCSEOpportunities(Op0, Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003168 I.swapOperands();
Chris Lattner9306ffa2010-02-01 19:54:45 +00003169 std::swap(Op0, Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00003170 Changed = true;
3171 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003172
Jingyue Wu5e34ce32015-06-25 20:14:47 +00003173 if (Value *V =
3174 SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AC, &I))
Sanjay Patel4b198802016-02-01 22:23:39 +00003175 return replaceInstUsesWith(I, V);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003176
Pete Cooperbc5c5242011-12-01 03:58:40 +00003177 // comparing -val or val with non-zero is the same as just comparing val
Pete Cooperfdddc272011-12-01 19:13:26 +00003178 // ie, abs(val) != 0 -> val != 0
Pete Cooperbc5c5242011-12-01 03:58:40 +00003179 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
3180 {
Pete Cooperfdddc272011-12-01 19:13:26 +00003181 Value *Cond, *SelectTrue, *SelectFalse;
3182 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooperbc5c5242011-12-01 03:58:40 +00003183 m_Value(SelectFalse)))) {
Pete Cooperfdddc272011-12-01 19:13:26 +00003184 if (Value *V = dyn_castNegVal(SelectTrue)) {
3185 if (V == SelectFalse)
3186 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
3187 }
3188 else if (Value *V = dyn_castNegVal(SelectFalse)) {
3189 if (V == SelectTrue)
3190 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooperbc5c5242011-12-01 03:58:40 +00003191 }
3192 }
3193 }
3194
Chris Lattner229907c2011-07-18 04:54:35 +00003195 Type *Ty = Op0->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00003196
3197 // icmp's with boolean values can always be turned into bitwise operations
Duncan Sands9dff9be2010-02-15 16:12:20 +00003198 if (Ty->isIntegerTy(1)) {
Chris Lattner2188e402010-01-04 07:37:31 +00003199 switch (I.getPredicate()) {
3200 default: llvm_unreachable("Invalid icmp instruction!");
3201 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
3202 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
3203 return BinaryOperator::CreateNot(Xor);
3204 }
3205 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
3206 return BinaryOperator::CreateXor(Op0, Op1);
3207
3208 case ICmpInst::ICMP_UGT:
3209 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
3210 // FALL THROUGH
3211 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
3212 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
3213 return BinaryOperator::CreateAnd(Not, Op1);
3214 }
3215 case ICmpInst::ICMP_SGT:
3216 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
3217 // FALL THROUGH
3218 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
3219 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
3220 return BinaryOperator::CreateAnd(Not, Op0);
3221 }
3222 case ICmpInst::ICMP_UGE:
3223 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
3224 // FALL THROUGH
3225 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
3226 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
3227 return BinaryOperator::CreateOr(Not, Op1);
3228 }
3229 case ICmpInst::ICMP_SGE:
3230 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
3231 // FALL THROUGH
3232 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
3233 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
3234 return BinaryOperator::CreateOr(Not, Op0);
3235 }
3236 }
3237 }
3238
Sanjay Patele9b2c322016-05-17 00:57:57 +00003239 if (ICmpInst *NewICmp = canonicalizeCmpWithConstant(I))
Sanjay Pateld5b0e542016-04-29 16:22:25 +00003240 return NewICmp;
3241
Chris Lattner2188e402010-01-04 07:37:31 +00003242 unsigned BitWidth = 0;
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003243 if (Ty->isIntOrIntVectorTy())
Chris Lattner2188e402010-01-04 07:37:31 +00003244 BitWidth = Ty->getScalarSizeInBits();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003245 else // Get pointer size.
3246 BitWidth = DL.getTypeSizeInBits(Ty->getScalarType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00003247
Chris Lattner2188e402010-01-04 07:37:31 +00003248 bool isSignBit = false;
3249
3250 // See if we are doing a comparison with a constant.
3251 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Craig Topperf40110f2014-04-25 05:29:35 +00003252 Value *A = nullptr, *B = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003253
Owen Anderson1294ea72010-12-17 18:08:00 +00003254 // Match the following pattern, which is a common idiom when writing
3255 // overflow-safe integer arithmetic function. The source performs an
3256 // addition in wider type, and explicitly checks for overflow using
3257 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
3258 // sadd_with_overflow intrinsic.
Chris Lattneree61c1d2010-12-19 17:52:50 +00003259 //
3260 // TODO: This could probably be generalized to handle other overflow-safe
Jim Grosbach129c52a2011-09-30 18:09:53 +00003261 // operations if we worked out the formulas to compute the appropriate
Owen Anderson1294ea72010-12-17 18:08:00 +00003262 // magic constants.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003263 //
Chris Lattneree61c1d2010-12-19 17:52:50 +00003264 // sum = a + b
3265 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
Owen Anderson1294ea72010-12-17 18:08:00 +00003266 {
Chris Lattneree61c1d2010-12-19 17:52:50 +00003267 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
Owen Anderson1294ea72010-12-17 18:08:00 +00003268 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
Chris Lattneree61c1d2010-12-19 17:52:50 +00003269 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Chris Lattnerce2995a2010-12-19 18:38:44 +00003270 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
Chris Lattneree61c1d2010-12-19 17:52:50 +00003271 return Res;
Owen Anderson1294ea72010-12-17 18:08:00 +00003272 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003273
Philip Reamesec8a8b52016-03-09 21:05:07 +00003274 // (icmp sgt smin(PosA, B) 0) -> (icmp sgt B 0)
3275 if (CI->isZero() && I.getPredicate() == ICmpInst::ICMP_SGT)
3276 if (auto *SI = dyn_cast<SelectInst>(Op0)) {
3277 SelectPatternResult SPR = matchSelectPattern(SI, A, B);
3278 if (SPR.Flavor == SPF_SMIN) {
Philip Reames8f12eba2016-03-09 21:31:47 +00003279 if (isKnownPositive(A, DL))
Philip Reamesec8a8b52016-03-09 21:05:07 +00003280 return new ICmpInst(I.getPredicate(), B, CI);
Philip Reames8f12eba2016-03-09 21:31:47 +00003281 if (isKnownPositive(B, DL))
Philip Reamesec8a8b52016-03-09 21:05:07 +00003282 return new ICmpInst(I.getPredicate(), A, CI);
3283 }
3284 }
3285
3286
David Majnemera0afb552015-01-14 19:26:56 +00003287 // The following transforms are only 'worth it' if the only user of the
3288 // subtraction is the icmp.
3289 if (Op0->hasOneUse()) {
3290 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
3291 if (I.isEquality() && CI->isZero() &&
3292 match(Op0, m_Sub(m_Value(A), m_Value(B))))
3293 return new ICmpInst(I.getPredicate(), A, B);
3294
3295 // (icmp sgt (sub nsw A B), -1) -> (icmp sge A, B)
3296 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isAllOnesValue() &&
3297 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3298 return new ICmpInst(ICmpInst::ICMP_SGE, A, B);
3299
3300 // (icmp sgt (sub nsw A B), 0) -> (icmp sgt A, B)
3301 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isZero() &&
3302 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3303 return new ICmpInst(ICmpInst::ICMP_SGT, A, B);
3304
3305 // (icmp slt (sub nsw A B), 0) -> (icmp slt A, B)
3306 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isZero() &&
3307 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3308 return new ICmpInst(ICmpInst::ICMP_SLT, A, B);
3309
3310 // (icmp slt (sub nsw A B), 1) -> (icmp sle A, B)
3311 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isOne() &&
3312 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
3313 return new ICmpInst(ICmpInst::ICMP_SLE, A, B);
Chris Lattner2188e402010-01-04 07:37:31 +00003314 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003315
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00003316 if (I.isEquality()) {
3317 ConstantInt *CI2;
3318 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
3319 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
David Majnemer59939ac2014-10-19 08:23:08 +00003320 // (icmp eq/ne (ashr/lshr const2, A), const1)
David Majnemer2abb8182014-10-25 07:13:13 +00003321 if (Instruction *Inst = FoldICmpCstShrCst(I, Op0, A, CI, CI2))
3322 return Inst;
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00003323 }
David Majnemer59939ac2014-10-19 08:23:08 +00003324 if (match(Op0, m_Shl(m_ConstantInt(CI2), m_Value(A)))) {
3325 // (icmp eq/ne (shl const2, A), const1)
David Majnemer2abb8182014-10-25 07:13:13 +00003326 if (Instruction *Inst = FoldICmpCstShlCst(I, Op0, A, CI, CI2))
3327 return Inst;
David Majnemer59939ac2014-10-19 08:23:08 +00003328 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00003329 }
3330
Chris Lattner2188e402010-01-04 07:37:31 +00003331 // If this comparison is a normal comparison, it demands all
3332 // bits, if it is a sign bit comparison, it only demands the sign bit.
3333 bool UnusedBit;
3334 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
Balaram Makam569eaec2016-05-04 21:32:14 +00003335
3336 // Canonicalize icmp instructions based on dominating conditions.
3337 BasicBlock *Parent = I.getParent();
3338 BasicBlock *Dom = Parent->getSinglePredecessor();
3339 auto *BI = Dom ? dyn_cast<BranchInst>(Dom->getTerminator()) : nullptr;
3340 ICmpInst::Predicate Pred;
3341 BasicBlock *TrueBB, *FalseBB;
3342 ConstantInt *CI2;
3343 if (BI && match(BI, m_Br(m_ICmp(Pred, m_Specific(Op0), m_ConstantInt(CI2)),
3344 TrueBB, FalseBB)) &&
3345 TrueBB != FalseBB) {
3346 ConstantRange CR = ConstantRange::makeAllowedICmpRegion(I.getPredicate(),
3347 CI->getValue());
3348 ConstantRange DominatingCR =
3349 (Parent == TrueBB)
3350 ? ConstantRange::makeExactICmpRegion(Pred, CI2->getValue())
3351 : ConstantRange::makeExactICmpRegion(
3352 CmpInst::getInversePredicate(Pred), CI2->getValue());
3353 ConstantRange Intersection = DominatingCR.intersectWith(CR);
3354 ConstantRange Difference = DominatingCR.difference(CR);
3355 if (Intersection.isEmptySet())
3356 return replaceInstUsesWith(I, Builder->getFalse());
3357 if (Difference.isEmptySet())
3358 return replaceInstUsesWith(I, Builder->getTrue());
3359 // Canonicalizing a sign bit comparison that gets used in a branch,
3360 // pessimizes codegen by generating branch on zero instruction instead
3361 // of a test and branch. So we avoid canonicalizing in such situations
3362 // because test and branch instruction has better branch displacement
3363 // than compare and branch instruction.
3364 if (!isBranchOnSignBitCheck(I, isSignBit) && !I.isEquality()) {
3365 if (auto *AI = Intersection.getSingleElement())
3366 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Builder->getInt(*AI));
3367 if (auto *AD = Difference.getSingleElement())
3368 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Builder->getInt(*AD));
3369 }
3370 }
Chris Lattner2188e402010-01-04 07:37:31 +00003371 }
3372
3373 // See if we can fold the comparison based on range information we can get
3374 // by checking whether bits are known to be zero or one in the input.
3375 if (BitWidth != 0) {
3376 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
3377 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
3378
3379 if (SimplifyDemandedBits(I.getOperandUse(0),
Owen Andersond490c2d2011-01-11 00:36:45 +00003380 DemandedBitsLHSMask(I, BitWidth, isSignBit),
Chris Lattner2188e402010-01-04 07:37:31 +00003381 Op0KnownZero, Op0KnownOne, 0))
3382 return &I;
3383 if (SimplifyDemandedBits(I.getOperandUse(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003384 APInt::getAllOnesValue(BitWidth), Op1KnownZero,
3385 Op1KnownOne, 0))
Chris Lattner2188e402010-01-04 07:37:31 +00003386 return &I;
3387
3388 // Given the known and unknown bits, compute a range that the LHS could be
3389 // in. Compute the Min, Max and RHS values based on the known bits. For the
3390 // EQ and NE we use unsigned values.
3391 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
3392 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
3393 if (I.isSigned()) {
3394 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
3395 Op0Min, Op0Max);
3396 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
3397 Op1Min, Op1Max);
3398 } else {
3399 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
3400 Op0Min, Op0Max);
3401 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
3402 Op1Min, Op1Max);
3403 }
3404
3405 // If Min and Max are known to be the same, then SimplifyDemandedBits
3406 // figured out that the LHS is a constant. Just constant fold this now so
3407 // that code below can assume that Min != Max.
3408 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
3409 return new ICmpInst(I.getPredicate(),
Nick Lewycky92db8e82011-03-06 03:36:19 +00003410 ConstantInt::get(Op0->getType(), Op0Min), Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00003411 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
3412 return new ICmpInst(I.getPredicate(), Op0,
Nick Lewycky92db8e82011-03-06 03:36:19 +00003413 ConstantInt::get(Op1->getType(), Op1Min));
Chris Lattner2188e402010-01-04 07:37:31 +00003414
3415 // Based on the range information we know about the LHS, see if we can
Nick Lewycky6b4454192011-02-28 06:20:05 +00003416 // simplify this comparison. For example, (x&4) < 8 is always true.
Chris Lattner2188e402010-01-04 07:37:31 +00003417 switch (I.getPredicate()) {
3418 default: llvm_unreachable("Unknown icmp opcode!");
Chris Lattnerf7e89612010-11-21 06:44:42 +00003419 case ICmpInst::ICMP_EQ: {
Chris Lattner2188e402010-01-04 07:37:31 +00003420 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Sanjay Patel4b198802016-02-01 22:23:39 +00003421 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00003422
Chris Lattnerf7e89612010-11-21 06:44:42 +00003423 // If all bits are known zero except for one, then we know at most one
3424 // bit is set. If the comparison is against zero, then this is a check
3425 // to see if *that* bit is set.
3426 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003427 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00003428 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00003429 Value *LHS = nullptr;
3430 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003431 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
3432 LHSC->getValue() != Op0KnownZeroInverted)
3433 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003434
Chris Lattnerf7e89612010-11-21 06:44:42 +00003435 // 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 +00003436 // then turn "((1 << x)&8) == 0" into "x != 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003437 // or turn "((1 << x)&7) == 0" into "x > 2".
Craig Topperf40110f2014-04-25 05:29:35 +00003438 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003439 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003440 APInt ValToCheck = Op0KnownZeroInverted;
3441 if (ValToCheck.isPowerOf2()) {
3442 unsigned CmpVal = ValToCheck.countTrailingZeros();
3443 return new ICmpInst(ICmpInst::ICMP_NE, X,
3444 ConstantInt::get(X->getType(), CmpVal));
3445 } else if ((++ValToCheck).isPowerOf2()) {
3446 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
3447 return new ICmpInst(ICmpInst::ICMP_UGT, X,
3448 ConstantInt::get(X->getType(), CmpVal));
3449 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00003450 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003451
Chris Lattnerf7e89612010-11-21 06:44:42 +00003452 // 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 +00003453 // then turn "((8 >>u x)&1) == 0" into "x != 3".
Chris Lattner98457102011-02-10 05:23:05 +00003454 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003455 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00003456 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00003457 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattner98457102011-02-10 05:23:05 +00003458 ConstantInt::get(X->getType(),
3459 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00003460 }
Chris Lattner2188e402010-01-04 07:37:31 +00003461 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003462 }
3463 case ICmpInst::ICMP_NE: {
Chris Lattner2188e402010-01-04 07:37:31 +00003464 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Sanjay Patel4b198802016-02-01 22:23:39 +00003465 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00003466
Chris Lattnerf7e89612010-11-21 06:44:42 +00003467 // If all bits are known zero except for one, then we know at most one
3468 // bit is set. If the comparison is against zero, then this is a check
3469 // to see if *that* bit is set.
3470 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003471 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00003472 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00003473 Value *LHS = nullptr;
3474 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003475 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
3476 LHSC->getValue() != Op0KnownZeroInverted)
3477 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003478
Chris Lattnerf7e89612010-11-21 06:44:42 +00003479 // 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 +00003480 // then turn "((1 << x)&8) != 0" into "x == 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003481 // or turn "((1 << x)&7) != 0" into "x < 3".
Craig Topperf40110f2014-04-25 05:29:35 +00003482 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003483 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00003484 APInt ValToCheck = Op0KnownZeroInverted;
3485 if (ValToCheck.isPowerOf2()) {
3486 unsigned CmpVal = ValToCheck.countTrailingZeros();
3487 return new ICmpInst(ICmpInst::ICMP_EQ, X,
3488 ConstantInt::get(X->getType(), CmpVal));
3489 } else if ((++ValToCheck).isPowerOf2()) {
3490 unsigned CmpVal = ValToCheck.countTrailingZeros();
3491 return new ICmpInst(ICmpInst::ICMP_ULT, X,
3492 ConstantInt::get(X->getType(), CmpVal));
3493 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00003494 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003495
Chris Lattnerf7e89612010-11-21 06:44:42 +00003496 // 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 +00003497 // then turn "((8 >>u x)&1) != 0" into "x == 3".
Chris Lattner98457102011-02-10 05:23:05 +00003498 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003499 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00003500 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00003501 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattner98457102011-02-10 05:23:05 +00003502 ConstantInt::get(X->getType(),
3503 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00003504 }
Chris Lattner2188e402010-01-04 07:37:31 +00003505 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00003506 }
Chris Lattner2188e402010-01-04 07:37:31 +00003507 case ICmpInst::ICMP_ULT:
3508 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003509 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003510 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003511 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003512 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
3513 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3514 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3515 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
3516 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003517 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00003518
3519 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
3520 if (CI->isMinValue(true))
3521 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
3522 Constant::getAllOnesValue(Op0->getType()));
3523 }
3524 break;
3525 case ICmpInst::ICMP_UGT:
3526 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003527 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003528 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003529 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003530
3531 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
3532 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3533 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3534 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
3535 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003536 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00003537
3538 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
3539 if (CI->isMaxValue(true))
3540 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
3541 Constant::getNullValue(Op0->getType()));
3542 }
3543 break;
3544 case ICmpInst::ICMP_SLT:
3545 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
Sanjay Patel4b198802016-02-01 22:23:39 +00003546 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003547 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
Sanjay Patel4b198802016-02-01 22:23:39 +00003548 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003549 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
3550 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3551 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3552 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
3553 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003554 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00003555 }
3556 break;
3557 case ICmpInst::ICMP_SGT:
3558 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003559 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003560 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003561 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003562
3563 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
3564 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3565 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3566 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
3567 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003568 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00003569 }
3570 break;
3571 case ICmpInst::ICMP_SGE:
3572 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
3573 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003574 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003575 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003576 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003577 break;
3578 case ICmpInst::ICMP_SLE:
3579 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
3580 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003581 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003582 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003583 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003584 break;
3585 case ICmpInst::ICMP_UGE:
3586 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
3587 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003588 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003589 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003590 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003591 break;
3592 case ICmpInst::ICMP_ULE:
3593 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
3594 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003595 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003596 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
Sanjay Patel4b198802016-02-01 22:23:39 +00003597 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003598 break;
3599 }
3600
3601 // Turn a signed comparison into an unsigned one if both operands
3602 // are known to have the same sign.
3603 if (I.isSigned() &&
3604 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
3605 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
3606 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
3607 }
3608
3609 // Test if the ICmpInst instruction is used exclusively by a select as
3610 // part of a minimum or maximum operation. If so, refrain from doing
3611 // any other folding. This helps out other analyses which understand
3612 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
3613 // and CodeGen. And in this case, at least one of the comparison
3614 // operands has at least one user besides the compare (the select),
3615 // which would often largely negate the benefit of folding anyway.
3616 if (I.hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00003617 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
Chris Lattner2188e402010-01-04 07:37:31 +00003618 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
3619 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
Craig Topperf40110f2014-04-25 05:29:35 +00003620 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003621
3622 // See if we are doing a comparison between a constant and an instruction that
3623 // can be folded into the comparison.
3624 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Chad Rosier131a42c2016-05-09 19:30:20 +00003625 Value *A = nullptr, *B = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003626 // Since the RHS is a ConstantInt (CI), if the left hand side is an
3627 // instruction, see if that instruction also has constants so that the
3628 // instruction can be folded into the icmp
Chris Lattner2188e402010-01-04 07:37:31 +00003629 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3630 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
3631 return Res;
Chad Rosier131a42c2016-05-09 19:30:20 +00003632
3633 // (icmp eq/ne (udiv A, B), 0) -> (icmp ugt/ule i32 B, A)
3634 if (I.isEquality() && CI->isZero() &&
3635 match(Op0, m_UDiv(m_Value(A), m_Value(B)))) {
3636 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_EQ
3637 ? ICmpInst::ICMP_UGT
3638 : ICmpInst::ICMP_ULE;
3639 return new ICmpInst(Pred, B, A);
3640 }
Chris Lattner2188e402010-01-04 07:37:31 +00003641 }
3642
3643 // Handle icmp with constant (but not simple integer constant) RHS
3644 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3645 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3646 switch (LHSI->getOpcode()) {
3647 case Instruction::GetElementPtr:
3648 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
3649 if (RHSC->isNullValue() &&
3650 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
3651 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3652 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3653 break;
3654 case Instruction::PHI:
3655 // Only fold icmp into the PHI if the phi and icmp are in the same
3656 // block. If in the same block, we're encouraging jump threading. If
3657 // not, we are just pessimizing the code by making an i1 phi.
3658 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00003659 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00003660 return NV;
3661 break;
3662 case Instruction::Select: {
3663 // If either operand of the select is a constant, we can fold the
3664 // comparison into the select arms, which will cause one to be
3665 // constant folded and the select turned into a bitwise or.
Craig Topperf40110f2014-04-25 05:29:35 +00003666 Value *Op1 = nullptr, *Op2 = nullptr;
Hans Wennborg083ca9b2015-10-06 23:24:35 +00003667 ConstantInt *CI = nullptr;
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003668 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003669 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003670 CI = dyn_cast<ConstantInt>(Op1);
3671 }
3672 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003673 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003674 CI = dyn_cast<ConstantInt>(Op2);
3675 }
Chris Lattner2188e402010-01-04 07:37:31 +00003676
3677 // We only want to perform this transformation if it will not lead to
3678 // additional code. This is true if either both sides of the select
3679 // fold to a constant (in which case the icmp is replaced with a select
3680 // which will usually simplify) or this is the only user of the
3681 // select (in which case we are trading a select+icmp for a simpler
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003682 // select+icmp) or all uses of the select can be replaced based on
3683 // dominance information ("Global cases").
3684 bool Transform = false;
3685 if (Op1 && Op2)
3686 Transform = true;
3687 else if (Op1 || Op2) {
3688 // Local case
3689 if (LHSI->hasOneUse())
3690 Transform = true;
3691 // Global cases
3692 else if (CI && !CI->isZero())
3693 // When Op1 is constant try replacing select with second operand.
3694 // Otherwise Op2 is constant and try replacing select with first
3695 // operand.
3696 Transform = replacedSelectWithOperand(cast<SelectInst>(LHSI), &I,
3697 Op1 ? 2 : 1);
3698 }
3699 if (Transform) {
Chris Lattner2188e402010-01-04 07:37:31 +00003700 if (!Op1)
3701 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
3702 RHSC, I.getName());
3703 if (!Op2)
3704 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
3705 RHSC, I.getName());
3706 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3707 }
3708 break;
3709 }
Chris Lattner2188e402010-01-04 07:37:31 +00003710 case Instruction::IntToPtr:
3711 // icmp pred inttoptr(X), null -> icmp pred X, 0
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003712 if (RHSC->isNullValue() &&
3713 DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
Chris Lattner2188e402010-01-04 07:37:31 +00003714 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3715 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3716 break;
3717
3718 case Instruction::Load:
3719 // Try to optimize things like "A[i] > 4" to index computations.
3720 if (GetElementPtrInst *GEP =
3721 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3722 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3723 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3724 !cast<LoadInst>(LHSI)->isVolatile())
3725 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3726 return Res;
3727 }
3728 break;
3729 }
3730 }
3731
3732 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
3733 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
3734 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
3735 return NI;
3736 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
3737 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
3738 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
3739 return NI;
3740
Hans Wennborgf1f36512015-10-07 00:20:07 +00003741 // Try to optimize equality comparisons against alloca-based pointers.
3742 if (Op0->getType()->isPointerTy() && I.isEquality()) {
3743 assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?");
3744 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op0, DL)))
3745 if (Instruction *New = FoldAllocaCmp(I, Alloca, Op1))
3746 return New;
3747 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op1, DL)))
3748 if (Instruction *New = FoldAllocaCmp(I, Alloca, Op0))
3749 return New;
3750 }
3751
Chris Lattner2188e402010-01-04 07:37:31 +00003752 // Test to see if the operands of the icmp are casted versions of other
3753 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
3754 // now.
3755 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00003756 if (Op0->getType()->isPointerTy() &&
3757 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003758 // We keep moving the cast from the left operand over to the right
3759 // operand, where it can often be eliminated completely.
3760 Op0 = CI->getOperand(0);
3761
3762 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
3763 // so eliminate it as well.
3764 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
3765 Op1 = CI2->getOperand(0);
3766
3767 // If Op1 is a constant, we can fold the cast into the constant.
3768 if (Op0->getType() != Op1->getType()) {
3769 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
3770 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
3771 } else {
3772 // Otherwise, cast the RHS right before the icmp
3773 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
3774 }
3775 }
3776 return new ICmpInst(I.getPredicate(), Op0, Op1);
3777 }
3778 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003779
Chris Lattner2188e402010-01-04 07:37:31 +00003780 if (isa<CastInst>(Op0)) {
3781 // Handle the special case of: icmp (cast bool to X), <cst>
3782 // This comes up when you have code like
3783 // int X = A < B;
3784 // if (X) ...
3785 // For generality, we handle any zero-extension of any operand comparison
3786 // with a constant or another cast from the same type.
3787 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
3788 if (Instruction *R = visitICmpInstWithCastAndCast(I))
3789 return R;
3790 }
Chris Lattner2188e402010-01-04 07:37:31 +00003791
Duncan Sandse5220012011-02-17 07:46:37 +00003792 // Special logic for binary operators.
3793 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3794 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3795 if (BO0 || BO1) {
3796 CmpInst::Predicate Pred = I.getPredicate();
3797 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3798 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3799 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
3800 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3801 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3802 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3803 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3804 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3805 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3806
3807 // Analyze the case when either Op0 or Op1 is an add instruction.
3808 // 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 +00003809 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
Richard Trieu7a083812016-02-18 22:09:30 +00003810 if (BO0 && BO0->getOpcode() == Instruction::Add) {
3811 A = BO0->getOperand(0);
3812 B = BO0->getOperand(1);
3813 }
3814 if (BO1 && BO1->getOpcode() == Instruction::Add) {
3815 C = BO1->getOperand(0);
3816 D = BO1->getOperand(1);
3817 }
Duncan Sandse5220012011-02-17 07:46:37 +00003818
David Majnemer549f4f22014-11-01 09:09:51 +00003819 // icmp (X+cst) < 0 --> X < -cst
3820 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred) && match(Op1, m_Zero()))
3821 if (ConstantInt *RHSC = dyn_cast_or_null<ConstantInt>(B))
3822 if (!RHSC->isMinValue(/*isSigned=*/true))
3823 return new ICmpInst(Pred, A, ConstantExpr::getNeg(RHSC));
3824
Duncan Sandse5220012011-02-17 07:46:37 +00003825 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3826 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3827 return new ICmpInst(Pred, A == Op1 ? B : A,
3828 Constant::getNullValue(Op1->getType()));
3829
3830 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3831 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3832 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3833 C == Op0 ? D : C);
3834
Duncan Sands84653b32011-02-18 16:25:37 +00003835 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003836 if (A && C && (A == C || A == D || B == C || B == D) &&
3837 NoOp0WrapProblem && NoOp1WrapProblem &&
3838 // Try not to increase register pressure.
3839 BO0->hasOneUse() && BO1->hasOneUse()) {
3840 // Determine Y and Z in the form icmp (X+Y), (X+Z).
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003841 Value *Y, *Z;
3842 if (A == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003843 // C + B == C + D -> B == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003844 Y = B;
3845 Z = D;
3846 } else if (A == D) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003847 // D + B == C + D -> B == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003848 Y = B;
3849 Z = C;
3850 } else if (B == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003851 // A + C == C + D -> A == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003852 Y = A;
3853 Z = D;
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003854 } else {
3855 assert(B == D);
3856 // A + D == C + D -> A == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003857 Y = A;
3858 Z = C;
3859 }
Duncan Sandse5220012011-02-17 07:46:37 +00003860 return new ICmpInst(Pred, Y, Z);
3861 }
3862
David Majnemerb81cd632013-04-11 20:05:46 +00003863 // icmp slt (X + -1), Y -> icmp sle X, Y
3864 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3865 match(B, m_AllOnes()))
3866 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3867
3868 // icmp sge (X + -1), Y -> icmp sgt X, Y
3869 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3870 match(B, m_AllOnes()))
3871 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3872
3873 // icmp sle (X + 1), Y -> icmp slt X, Y
3874 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3875 match(B, m_One()))
3876 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3877
3878 // icmp sgt (X + 1), Y -> icmp sge X, Y
3879 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3880 match(B, m_One()))
3881 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3882
Michael Liaoc65d3862015-10-19 22:08:14 +00003883 // icmp sgt X, (Y + -1) -> icmp sge X, Y
3884 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT &&
3885 match(D, m_AllOnes()))
3886 return new ICmpInst(CmpInst::ICMP_SGE, Op0, C);
3887
3888 // icmp sle X, (Y + -1) -> icmp slt X, Y
3889 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE &&
3890 match(D, m_AllOnes()))
3891 return new ICmpInst(CmpInst::ICMP_SLT, Op0, C);
3892
3893 // icmp sge X, (Y + 1) -> icmp sgt X, Y
3894 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE &&
3895 match(D, m_One()))
3896 return new ICmpInst(CmpInst::ICMP_SGT, Op0, C);
3897
3898 // icmp slt X, (Y + 1) -> icmp sle X, Y
3899 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT &&
3900 match(D, m_One()))
3901 return new ICmpInst(CmpInst::ICMP_SLE, Op0, C);
3902
David Majnemerb81cd632013-04-11 20:05:46 +00003903 // if C1 has greater magnitude than C2:
3904 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3905 // s.t. C3 = C1 - C2
3906 //
3907 // if C2 has greater magnitude than C1:
3908 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3909 // s.t. C3 = C2 - C1
3910 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3911 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3912 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3913 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3914 const APInt &AP1 = C1->getValue();
3915 const APInt &AP2 = C2->getValue();
3916 if (AP1.isNegative() == AP2.isNegative()) {
3917 APInt AP1Abs = C1->getValue().abs();
3918 APInt AP2Abs = C2->getValue().abs();
3919 if (AP1Abs.uge(AP2Abs)) {
3920 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3921 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3922 return new ICmpInst(Pred, NewAdd, C);
3923 } else {
3924 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3925 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3926 return new ICmpInst(Pred, A, NewAdd);
3927 }
3928 }
3929 }
3930
3931
Duncan Sandse5220012011-02-17 07:46:37 +00003932 // Analyze the case when either Op0 or Op1 is a sub instruction.
3933 // 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 +00003934 A = nullptr;
3935 B = nullptr;
3936 C = nullptr;
3937 D = nullptr;
3938 if (BO0 && BO0->getOpcode() == Instruction::Sub) {
3939 A = BO0->getOperand(0);
3940 B = BO0->getOperand(1);
3941 }
3942 if (BO1 && BO1->getOpcode() == Instruction::Sub) {
3943 C = BO1->getOperand(0);
3944 D = BO1->getOperand(1);
3945 }
Duncan Sandse5220012011-02-17 07:46:37 +00003946
Duncan Sands84653b32011-02-18 16:25:37 +00003947 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3948 if (A == Op1 && NoOp0WrapProblem)
3949 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
3950
3951 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3952 if (C == Op0 && NoOp1WrapProblem)
3953 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3954
3955 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003956 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3957 // Try not to increase register pressure.
3958 BO0->hasOneUse() && BO1->hasOneUse())
3959 return new ICmpInst(Pred, A, C);
3960
Duncan Sands84653b32011-02-18 16:25:37 +00003961 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3962 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3963 // Try not to increase register pressure.
3964 BO0->hasOneUse() && BO1->hasOneUse())
3965 return new ICmpInst(Pred, D, B);
3966
David Majnemer186c9422014-05-15 00:02:20 +00003967 // icmp (0-X) < cst --> x > -cst
3968 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3969 Value *X;
3970 if (match(BO0, m_Neg(m_Value(X))))
3971 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3972 if (!RHSC->isMinValue(/*isSigned=*/true))
3973 return new ICmpInst(I.getSwappedPredicate(), X,
3974 ConstantExpr::getNeg(RHSC));
3975 }
3976
Craig Topperf40110f2014-04-25 05:29:35 +00003977 BinaryOperator *SRem = nullptr;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003978 // icmp (srem X, Y), Y
Nick Lewycky25cc3382011-03-05 04:28:48 +00003979 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
3980 Op1 == BO0->getOperand(1))
3981 SRem = BO0;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003982 // icmp Y, (srem X, Y)
Nick Lewycky25cc3382011-03-05 04:28:48 +00003983 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3984 Op0 == BO1->getOperand(1))
3985 SRem = BO1;
3986 if (SRem) {
3987 // We don't check hasOneUse to avoid increasing register pressure because
3988 // the value we use is the same value this instruction was already using.
3989 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3990 default: break;
3991 case ICmpInst::ICMP_EQ:
Sanjay Patel4b198802016-02-01 22:23:39 +00003992 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003993 case ICmpInst::ICMP_NE:
Sanjay Patel4b198802016-02-01 22:23:39 +00003994 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003995 case ICmpInst::ICMP_SGT:
3996 case ICmpInst::ICMP_SGE:
3997 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3998 Constant::getAllOnesValue(SRem->getType()));
3999 case ICmpInst::ICMP_SLT:
4000 case ICmpInst::ICMP_SLE:
4001 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
4002 Constant::getNullValue(SRem->getType()));
4003 }
4004 }
4005
Duncan Sandse5220012011-02-17 07:46:37 +00004006 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
4007 BO0->hasOneUse() && BO1->hasOneUse() &&
4008 BO0->getOperand(1) == BO1->getOperand(1)) {
4009 switch (BO0->getOpcode()) {
4010 default: break;
4011 case Instruction::Add:
4012 case Instruction::Sub:
4013 case Instruction::Xor:
4014 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
4015 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
4016 BO1->getOperand(0));
4017 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
4018 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
4019 if (CI->getValue().isSignBit()) {
4020 ICmpInst::Predicate Pred = I.isSigned()
4021 ? I.getUnsignedPredicate()
4022 : I.getSignedPredicate();
4023 return new ICmpInst(Pred, BO0->getOperand(0),
4024 BO1->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00004025 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004026
David Majnemerf8853ae2016-02-01 17:37:56 +00004027 if (BO0->getOpcode() == Instruction::Xor && CI->isMaxValue(true)) {
Duncan Sandse5220012011-02-17 07:46:37 +00004028 ICmpInst::Predicate Pred = I.isSigned()
4029 ? I.getUnsignedPredicate()
4030 : I.getSignedPredicate();
4031 Pred = I.getSwappedPredicate(Pred);
4032 return new ICmpInst(Pred, BO0->getOperand(0),
4033 BO1->getOperand(0));
4034 }
Chris Lattner2188e402010-01-04 07:37:31 +00004035 }
Duncan Sandse5220012011-02-17 07:46:37 +00004036 break;
4037 case Instruction::Mul:
4038 if (!I.isEquality())
4039 break;
4040
4041 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
4042 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
4043 // Mask = -1 >> count-trailing-zeros(Cst).
4044 if (!CI->isZero() && !CI->isOne()) {
4045 const APInt &AP = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004046 ConstantInt *Mask = ConstantInt::get(I.getContext(),
Duncan Sandse5220012011-02-17 07:46:37 +00004047 APInt::getLowBitsSet(AP.getBitWidth(),
4048 AP.getBitWidth() -
4049 AP.countTrailingZeros()));
4050 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
4051 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
4052 return new ICmpInst(I.getPredicate(), And1, And2);
4053 }
4054 }
4055 break;
Nick Lewycky9719a712011-03-05 05:19:11 +00004056 case Instruction::UDiv:
4057 case Instruction::LShr:
4058 if (I.isSigned())
4059 break;
4060 // fall-through
4061 case Instruction::SDiv:
4062 case Instruction::AShr:
Eli Friedman8a20e662011-05-05 21:59:18 +00004063 if (!BO0->isExact() || !BO1->isExact())
Nick Lewycky9719a712011-03-05 05:19:11 +00004064 break;
4065 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
4066 BO1->getOperand(0));
4067 case Instruction::Shl: {
4068 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
4069 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
4070 if (!NUW && !NSW)
4071 break;
4072 if (!NSW && I.isSigned())
4073 break;
4074 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
4075 BO1->getOperand(0));
4076 }
Chris Lattner2188e402010-01-04 07:37:31 +00004077 }
4078 }
Sanjoy Dasc86c1622015-08-21 22:22:37 +00004079
4080 if (BO0) {
4081 // Transform A & (L - 1) `ult` L --> L != 0
4082 auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
4083 auto BitwiseAnd =
4084 m_CombineOr(m_And(m_Value(), LSubOne), m_And(LSubOne, m_Value()));
4085
4086 if (match(BO0, BitwiseAnd) && I.getPredicate() == ICmpInst::ICMP_ULT) {
4087 auto *Zero = Constant::getNullValue(BO0->getType());
4088 return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
4089 }
4090 }
Chris Lattner2188e402010-01-04 07:37:31 +00004091 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004092
Chris Lattner2188e402010-01-04 07:37:31 +00004093 { Value *A, *B;
David Majnemer1a08acc2013-04-12 17:25:07 +00004094 // Transform (A & ~B) == 0 --> (A & B) != 0
4095 // and (A & ~B) != 0 --> (A & B) == 0
4096 // if A is a power of 2.
4097 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
Chandler Carruth66b31302015-01-04 12:03:27 +00004098 match(Op1, m_Zero()) &&
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004099 isKnownToBeAPowerOfTwo(A, DL, false, 0, AC, &I, DT) && I.isEquality())
David Majnemer1a08acc2013-04-12 17:25:07 +00004100 return new ICmpInst(I.getInversePredicate(),
4101 Builder->CreateAnd(A, B),
4102 Op1);
4103
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00004104 // ~x < ~y --> y < x
4105 // ~x < cst --> ~cst < x
4106 if (match(Op0, m_Not(m_Value(A)))) {
4107 if (match(Op1, m_Not(m_Value(B))))
4108 return new ICmpInst(I.getPredicate(), B, A);
Chris Lattner497459d2011-01-15 05:42:47 +00004109 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00004110 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
4111 }
Chris Lattner5e0c0c72010-12-19 19:37:52 +00004112
Sanjoy Dasb6c59142015-04-10 21:07:09 +00004113 Instruction *AddI = nullptr;
4114 if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
4115 m_Instruction(AddI))) &&
4116 isa<IntegerType>(A->getType())) {
4117 Value *Result;
4118 Constant *Overflow;
4119 if (OptimizeOverflowCheck(OCF_UNSIGNED_ADD, A, B, *AddI, Result,
4120 Overflow)) {
Sanjay Patel4b198802016-02-01 22:23:39 +00004121 replaceInstUsesWith(*AddI, Result);
4122 return replaceInstUsesWith(I, Overflow);
Sanjoy Dasb6c59142015-04-10 21:07:09 +00004123 }
4124 }
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004125
4126 // (zext a) * (zext b) --> llvm.umul.with.overflow.
4127 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
4128 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
4129 return R;
4130 }
4131 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
4132 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
4133 return R;
4134 }
Chris Lattner2188e402010-01-04 07:37:31 +00004135 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004136
Chris Lattner2188e402010-01-04 07:37:31 +00004137 if (I.isEquality()) {
4138 Value *A, *B, *C, *D;
Duncan Sands84653b32011-02-18 16:25:37 +00004139
Chris Lattner2188e402010-01-04 07:37:31 +00004140 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
4141 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
4142 Value *OtherVal = A == Op1 ? B : A;
4143 return new ICmpInst(I.getPredicate(), OtherVal,
4144 Constant::getNullValue(A->getType()));
4145 }
4146
4147 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
4148 // A^c1 == C^c2 --> A == C^(c1^c2)
4149 ConstantInt *C1, *C2;
4150 if (match(B, m_ConstantInt(C1)) &&
4151 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
Jakub Staszakbddea112013-06-06 20:18:46 +00004152 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
Benjamin Kramer547b6c52011-09-27 20:39:19 +00004153 Value *Xor = Builder->CreateXor(C, NC);
Chris Lattner2188e402010-01-04 07:37:31 +00004154 return new ICmpInst(I.getPredicate(), A, Xor);
4155 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004156
Chris Lattner2188e402010-01-04 07:37:31 +00004157 // A^B == A^D -> B == D
4158 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
4159 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
4160 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
4161 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
4162 }
4163 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004164
Chris Lattner2188e402010-01-04 07:37:31 +00004165 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
4166 (A == Op0 || B == Op0)) {
4167 // A == (A^B) -> B == 0
4168 Value *OtherVal = A == Op0 ? B : A;
4169 return new ICmpInst(I.getPredicate(), OtherVal,
4170 Constant::getNullValue(A->getType()));
4171 }
4172
Chris Lattner2188e402010-01-04 07:37:31 +00004173 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
Jim Grosbach129c52a2011-09-30 18:09:53 +00004174 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
Chris Lattner31b106d2011-04-26 20:02:45 +00004175 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
Craig Topperf40110f2014-04-25 05:29:35 +00004176 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004177
Chris Lattner2188e402010-01-04 07:37:31 +00004178 if (A == C) {
4179 X = B; Y = D; Z = A;
4180 } else if (A == D) {
4181 X = B; Y = C; Z = A;
4182 } else if (B == C) {
4183 X = A; Y = D; Z = B;
4184 } else if (B == D) {
4185 X = A; Y = C; Z = B;
4186 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004187
Chris Lattner2188e402010-01-04 07:37:31 +00004188 if (X) { // Build (X^Y) & Z
Benjamin Kramer547b6c52011-09-27 20:39:19 +00004189 Op1 = Builder->CreateXor(X, Y);
4190 Op1 = Builder->CreateAnd(Op1, Z);
Chris Lattner2188e402010-01-04 07:37:31 +00004191 I.setOperand(0, Op1);
4192 I.setOperand(1, Constant::getNullValue(Op1->getType()));
4193 return &I;
4194 }
4195 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004196
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00004197 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
Benjamin Kramer21501452012-06-11 08:01:25 +00004198 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00004199 ConstantInt *Cst1;
Benjamin Kramer21501452012-06-11 08:01:25 +00004200 if ((Op0->hasOneUse() &&
4201 match(Op0, m_ZExt(m_Value(A))) &&
4202 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
4203 (Op1->hasOneUse() &&
4204 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
4205 match(Op1, m_ZExt(m_Value(A))))) {
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00004206 APInt Pow2 = Cst1->getValue() + 1;
4207 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
4208 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
4209 return new ICmpInst(I.getPredicate(), A,
4210 Builder->CreateTrunc(B, A->getType()));
4211 }
4212
Benjamin Kramer03f3e242013-11-16 16:00:48 +00004213 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
4214 // For lshr and ashr pairs.
4215 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4216 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
4217 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
4218 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
4219 unsigned TypeBits = Cst1->getBitWidth();
4220 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4221 if (ShAmt < TypeBits && ShAmt != 0) {
4222 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
4223 ? ICmpInst::ICMP_UGE
4224 : ICmpInst::ICMP_ULT;
4225 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
4226 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
4227 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
4228 }
4229 }
4230
Benjamin Kramer7fa8c432015-03-26 17:12:06 +00004231 // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
4232 if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
4233 match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
4234 unsigned TypeBits = Cst1->getBitWidth();
4235 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
4236 if (ShAmt < TypeBits && ShAmt != 0) {
4237 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
4238 APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
4239 Value *And = Builder->CreateAnd(Xor, Builder->getInt(AndVal),
4240 I.getName() + ".mask");
4241 return new ICmpInst(I.getPredicate(), And,
4242 Constant::getNullValue(Cst1->getType()));
4243 }
4244 }
4245
Chris Lattner1b06c712011-04-26 20:18:20 +00004246 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
4247 // "icmp (and X, mask), cst"
4248 uint64_t ShAmt = 0;
Chris Lattner1b06c712011-04-26 20:18:20 +00004249 if (Op0->hasOneUse() &&
4250 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
4251 m_ConstantInt(ShAmt))))) &&
4252 match(Op1, m_ConstantInt(Cst1)) &&
4253 // Only do this when A has multiple uses. This is most important to do
4254 // when it exposes other optimizations.
4255 !A->hasOneUse()) {
4256 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004257
Chris Lattner1b06c712011-04-26 20:18:20 +00004258 if (ShAmt < ASize) {
4259 APInt MaskV =
4260 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
4261 MaskV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004262
Chris Lattner1b06c712011-04-26 20:18:20 +00004263 APInt CmpV = Cst1->getValue().zext(ASize);
4264 CmpV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004265
Chris Lattner1b06c712011-04-26 20:18:20 +00004266 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
4267 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
4268 }
4269 }
Chris Lattner2188e402010-01-04 07:37:31 +00004270 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004271
David Majnemerc1eca5a2014-11-06 23:23:30 +00004272 // The 'cmpxchg' instruction returns an aggregate containing the old value and
4273 // an i1 which indicates whether or not we successfully did the swap.
4274 //
4275 // Replace comparisons between the old value and the expected value with the
4276 // indicator that 'cmpxchg' returns.
4277 //
4278 // N.B. This transform is only valid when the 'cmpxchg' is not permitted to
4279 // spuriously fail. In those cases, the old value may equal the expected
4280 // value but it is possible for the swap to not occur.
4281 if (I.getPredicate() == ICmpInst::ICMP_EQ)
4282 if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
4283 if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
4284 if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
4285 !ACXI->isWeak())
4286 return ExtractValueInst::Create(ACXI, 1);
4287
Chris Lattner2188e402010-01-04 07:37:31 +00004288 {
4289 Value *X; ConstantInt *Cst;
4290 // icmp X+Cst, X
4291 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00004292 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00004293
4294 // icmp X, X+Cst
4295 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00004296 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00004297 }
Craig Topperf40110f2014-04-25 05:29:35 +00004298 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004299}
4300
Chris Lattner2188e402010-01-04 07:37:31 +00004301/// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
Chris Lattner2188e402010-01-04 07:37:31 +00004302Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
4303 Instruction *LHSI,
4304 Constant *RHSC) {
Craig Topperf40110f2014-04-25 05:29:35 +00004305 if (!isa<ConstantFP>(RHSC)) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004306 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004307
Chris Lattner2188e402010-01-04 07:37:31 +00004308 // Get the width of the mantissa. We don't want to hack on conversions that
4309 // might lose information from the integer, e.g. "i64 -> float"
4310 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
Craig Topperf40110f2014-04-25 05:29:35 +00004311 if (MantissaWidth == -1) return nullptr; // Unknown.
Jim Grosbach129c52a2011-09-30 18:09:53 +00004312
Matt Arsenault55e73122015-01-06 15:50:59 +00004313 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
4314
Chris Lattner2188e402010-01-04 07:37:31 +00004315 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004316
Matt Arsenault55e73122015-01-06 15:50:59 +00004317 if (I.isEquality()) {
4318 FCmpInst::Predicate P = I.getPredicate();
4319 bool IsExact = false;
4320 APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
4321 RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
4322
4323 // If the floating point constant isn't an integer value, we know if we will
4324 // ever compare equal / not equal to it.
4325 if (!IsExact) {
4326 // TODO: Can never be -0.0 and other non-representable values
4327 APFloat RHSRoundInt(RHS);
4328 RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
4329 if (RHS.compare(RHSRoundInt) != APFloat::cmpEqual) {
4330 if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
Sanjay Patel4b198802016-02-01 22:23:39 +00004331 return replaceInstUsesWith(I, Builder->getFalse());
Matt Arsenault55e73122015-01-06 15:50:59 +00004332
4333 assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
Sanjay Patel4b198802016-02-01 22:23:39 +00004334 return replaceInstUsesWith(I, Builder->getTrue());
Matt Arsenault55e73122015-01-06 15:50:59 +00004335 }
4336 }
4337
4338 // TODO: If the constant is exactly representable, is it always OK to do
4339 // equality compares as integer?
4340 }
4341
Arch D. Robison8ed08542015-09-15 17:51:59 +00004342 // Check to see that the input is converted from an integer type that is small
4343 // enough that preserves all bits. TODO: check here for "known" sign bits.
4344 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
4345 unsigned InputSize = IntTy->getScalarSizeInBits();
Matt Arsenault55e73122015-01-06 15:50:59 +00004346
Arch D. Robison8ed08542015-09-15 17:51:59 +00004347 // Following test does NOT adjust InputSize downwards for signed inputs,
4348 // because the most negative value still requires all the mantissa bits
4349 // to distinguish it from one less than that value.
4350 if ((int)InputSize > MantissaWidth) {
4351 // Conversion would lose accuracy. Check if loss can impact comparison.
4352 int Exp = ilogb(RHS);
4353 if (Exp == APFloat::IEK_Inf) {
4354 int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics()));
4355 if (MaxExponent < (int)InputSize - !LHSUnsigned)
4356 // Conversion could create infinity.
4357 return nullptr;
4358 } else {
4359 // Note that if RHS is zero or NaN, then Exp is negative
4360 // and first condition is trivially false.
4361 if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned)
4362 // Conversion could affect comparison.
4363 return nullptr;
4364 }
4365 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004366
Chris Lattner2188e402010-01-04 07:37:31 +00004367 // Otherwise, we can potentially simplify the comparison. We know that it
4368 // will always come through as an integer value and we know the constant is
4369 // not a NAN (it would have been previously simplified).
4370 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00004371
Chris Lattner2188e402010-01-04 07:37:31 +00004372 ICmpInst::Predicate Pred;
4373 switch (I.getPredicate()) {
4374 default: llvm_unreachable("Unexpected predicate!");
4375 case FCmpInst::FCMP_UEQ:
4376 case FCmpInst::FCMP_OEQ:
4377 Pred = ICmpInst::ICMP_EQ;
4378 break;
4379 case FCmpInst::FCMP_UGT:
4380 case FCmpInst::FCMP_OGT:
4381 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
4382 break;
4383 case FCmpInst::FCMP_UGE:
4384 case FCmpInst::FCMP_OGE:
4385 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
4386 break;
4387 case FCmpInst::FCMP_ULT:
4388 case FCmpInst::FCMP_OLT:
4389 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
4390 break;
4391 case FCmpInst::FCMP_ULE:
4392 case FCmpInst::FCMP_OLE:
4393 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
4394 break;
4395 case FCmpInst::FCMP_UNE:
4396 case FCmpInst::FCMP_ONE:
4397 Pred = ICmpInst::ICMP_NE;
4398 break;
4399 case FCmpInst::FCMP_ORD:
Sanjay Patel4b198802016-02-01 22:23:39 +00004400 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004401 case FCmpInst::FCMP_UNO:
Sanjay Patel4b198802016-02-01 22:23:39 +00004402 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004403 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004404
Chris Lattner2188e402010-01-04 07:37:31 +00004405 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach129c52a2011-09-30 18:09:53 +00004406
Chris Lattner2188e402010-01-04 07:37:31 +00004407 // See if the FP constant is too large for the integer. For example,
4408 // comparing an i8 to 300.0.
4409 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004410
Chris Lattner2188e402010-01-04 07:37:31 +00004411 if (!LHSUnsigned) {
4412 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
4413 // and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00004414 APFloat SMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00004415 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
4416 APFloat::rmNearestTiesToEven);
4417 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
4418 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
4419 Pred == ICmpInst::ICMP_SLE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004420 return replaceInstUsesWith(I, Builder->getTrue());
4421 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004422 }
4423 } else {
4424 // If the RHS value is > UnsignedMax, fold the comparison. This handles
4425 // +INF and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00004426 APFloat UMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00004427 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
4428 APFloat::rmNearestTiesToEven);
4429 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
4430 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
4431 Pred == ICmpInst::ICMP_ULE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004432 return replaceInstUsesWith(I, Builder->getTrue());
4433 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004434 }
4435 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004436
Chris Lattner2188e402010-01-04 07:37:31 +00004437 if (!LHSUnsigned) {
4438 // See if the RHS value is < SignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00004439 APFloat SMin(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00004440 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
4441 APFloat::rmNearestTiesToEven);
4442 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
4443 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
4444 Pred == ICmpInst::ICMP_SGE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004445 return replaceInstUsesWith(I, Builder->getTrue());
4446 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004447 }
Devang Patel698452b2012-02-13 23:05:18 +00004448 } else {
4449 // See if the RHS value is < UnsignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00004450 APFloat SMin(RHS.getSemantics());
Devang Patel698452b2012-02-13 23:05:18 +00004451 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
4452 APFloat::rmNearestTiesToEven);
4453 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
4454 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
4455 Pred == ICmpInst::ICMP_UGE)
Sanjay Patel4b198802016-02-01 22:23:39 +00004456 return replaceInstUsesWith(I, Builder->getTrue());
4457 return replaceInstUsesWith(I, Builder->getFalse());
Devang Patel698452b2012-02-13 23:05:18 +00004458 }
Chris Lattner2188e402010-01-04 07:37:31 +00004459 }
4460
4461 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
4462 // [0, UMAX], but it may still be fractional. See if it is fractional by
4463 // casting the FP value to the integer value and back, checking for equality.
4464 // Don't do this for zero, because -0.0 is not fractional.
4465 Constant *RHSInt = LHSUnsigned
4466 ? ConstantExpr::getFPToUI(RHSC, IntTy)
4467 : ConstantExpr::getFPToSI(RHSC, IntTy);
4468 if (!RHS.isZero()) {
4469 bool Equal = LHSUnsigned
4470 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
4471 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
4472 if (!Equal) {
4473 // If we had a comparison against a fractional value, we have to adjust
4474 // the compare predicate and sometimes the value. RHSC is rounded towards
4475 // zero at this point.
4476 switch (Pred) {
4477 default: llvm_unreachable("Unexpected integer comparison!");
4478 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Sanjay Patel4b198802016-02-01 22:23:39 +00004479 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004480 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Sanjay Patel4b198802016-02-01 22:23:39 +00004481 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004482 case ICmpInst::ICMP_ULE:
4483 // (float)int <= 4.4 --> int <= 4
4484 // (float)int <= -4.4 --> false
4485 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004486 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004487 break;
4488 case ICmpInst::ICMP_SLE:
4489 // (float)int <= 4.4 --> int <= 4
4490 // (float)int <= -4.4 --> int < -4
4491 if (RHS.isNegative())
4492 Pred = ICmpInst::ICMP_SLT;
4493 break;
4494 case ICmpInst::ICMP_ULT:
4495 // (float)int < -4.4 --> false
4496 // (float)int < 4.4 --> int <= 4
4497 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004498 return replaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00004499 Pred = ICmpInst::ICMP_ULE;
4500 break;
4501 case ICmpInst::ICMP_SLT:
4502 // (float)int < -4.4 --> int < -4
4503 // (float)int < 4.4 --> int <= 4
4504 if (!RHS.isNegative())
4505 Pred = ICmpInst::ICMP_SLE;
4506 break;
4507 case ICmpInst::ICMP_UGT:
4508 // (float)int > 4.4 --> int > 4
4509 // (float)int > -4.4 --> true
4510 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004511 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004512 break;
4513 case ICmpInst::ICMP_SGT:
4514 // (float)int > 4.4 --> int > 4
4515 // (float)int > -4.4 --> int >= -4
4516 if (RHS.isNegative())
4517 Pred = ICmpInst::ICMP_SGE;
4518 break;
4519 case ICmpInst::ICMP_UGE:
4520 // (float)int >= -4.4 --> true
4521 // (float)int >= 4.4 --> int > 4
Bob Wilson61f3ad52012-08-07 22:35:16 +00004522 if (RHS.isNegative())
Sanjay Patel4b198802016-02-01 22:23:39 +00004523 return replaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00004524 Pred = ICmpInst::ICMP_UGT;
4525 break;
4526 case ICmpInst::ICMP_SGE:
4527 // (float)int >= -4.4 --> int >= -4
4528 // (float)int >= 4.4 --> int > 4
4529 if (!RHS.isNegative())
4530 Pred = ICmpInst::ICMP_SGT;
4531 break;
4532 }
4533 }
4534 }
4535
4536 // Lower this FP comparison into an appropriate integer version of the
4537 // comparison.
4538 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
4539}
4540
4541Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
4542 bool Changed = false;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004543
Chris Lattner2188e402010-01-04 07:37:31 +00004544 /// Orders the operands of the compare so that they are listed from most
4545 /// complex to least complex. This puts constants before unary operators,
4546 /// before binary operators.
4547 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
4548 I.swapOperands();
4549 Changed = true;
4550 }
4551
4552 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004553
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004554 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1,
4555 I.getFastMathFlags(), DL, TLI, DT, AC, &I))
Sanjay Patel4b198802016-02-01 22:23:39 +00004556 return replaceInstUsesWith(I, V);
Chris Lattner2188e402010-01-04 07:37:31 +00004557
4558 // Simplify 'fcmp pred X, X'
4559 if (Op0 == Op1) {
4560 switch (I.getPredicate()) {
4561 default: llvm_unreachable("Unknown predicate!");
4562 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
4563 case FCmpInst::FCMP_ULT: // True if unordered or less than
4564 case FCmpInst::FCMP_UGT: // True if unordered or greater than
4565 case FCmpInst::FCMP_UNE: // True if unordered or not equal
4566 // Canonicalize these to be 'fcmp uno %X, 0.0'.
4567 I.setPredicate(FCmpInst::FCMP_UNO);
4568 I.setOperand(1, Constant::getNullValue(Op0->getType()));
4569 return &I;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004570
Chris Lattner2188e402010-01-04 07:37:31 +00004571 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
4572 case FCmpInst::FCMP_OEQ: // True if ordered and equal
4573 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
4574 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
4575 // Canonicalize these to be 'fcmp ord %X, 0.0'.
4576 I.setPredicate(FCmpInst::FCMP_ORD);
4577 I.setOperand(1, Constant::getNullValue(Op0->getType()));
4578 return &I;
4579 }
4580 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004581
James Molloy2b21a7c2015-05-20 18:41:25 +00004582 // Test if the FCmpInst instruction is used exclusively by a select as
4583 // part of a minimum or maximum operation. If so, refrain from doing
4584 // any other folding. This helps out other analyses which understand
4585 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
4586 // and CodeGen. And in this case, at least one of the comparison
4587 // operands has at least one user besides the compare (the select),
4588 // which would often largely negate the benefit of folding anyway.
4589 if (I.hasOneUse())
4590 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
4591 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
4592 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
4593 return nullptr;
4594
Chris Lattner2188e402010-01-04 07:37:31 +00004595 // Handle fcmp with constant RHS
4596 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
4597 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
4598 switch (LHSI->getOpcode()) {
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004599 case Instruction::FPExt: {
4600 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
4601 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
4602 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
4603 if (!RHSF)
4604 break;
4605
4606 const fltSemantics *Sem;
4607 // FIXME: This shouldn't be here.
Dan Gohman518cda42011-12-17 00:04:22 +00004608 if (LHSExt->getSrcTy()->isHalfTy())
4609 Sem = &APFloat::IEEEhalf;
4610 else if (LHSExt->getSrcTy()->isFloatTy())
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004611 Sem = &APFloat::IEEEsingle;
4612 else if (LHSExt->getSrcTy()->isDoubleTy())
4613 Sem = &APFloat::IEEEdouble;
4614 else if (LHSExt->getSrcTy()->isFP128Ty())
4615 Sem = &APFloat::IEEEquad;
4616 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
4617 Sem = &APFloat::x87DoubleExtended;
Ulrich Weigand6a9bb512012-10-30 12:33:18 +00004618 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
4619 Sem = &APFloat::PPCDoubleDouble;
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004620 else
4621 break;
4622
4623 bool Lossy;
4624 APFloat F = RHSF->getValueAPF();
4625 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
4626
Jim Grosbach24ff8342011-09-30 18:45:50 +00004627 // Avoid lossy conversions and denormals. Zero is a special case
4628 // that's OK to convert.
Jim Grosbach011dafb2011-09-30 19:58:46 +00004629 APFloat Fabs = F;
4630 Fabs.clearSign();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004631 if (!Lossy &&
Jim Grosbach011dafb2011-09-30 19:58:46 +00004632 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
4633 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbach24ff8342011-09-30 18:45:50 +00004634
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004635 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4636 ConstantFP::get(RHSC->getContext(), F));
4637 break;
4638 }
Chris Lattner2188e402010-01-04 07:37:31 +00004639 case Instruction::PHI:
4640 // Only fold fcmp into the PHI if the phi and fcmp are in the same
4641 // block. If in the same block, we're encouraging jump threading. If
4642 // not, we are just pessimizing the code by making an i1 phi.
4643 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00004644 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00004645 return NV;
4646 break;
4647 case Instruction::SIToFP:
4648 case Instruction::UIToFP:
4649 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
4650 return NV;
4651 break;
Benjamin Kramera8c5d082011-03-31 10:12:15 +00004652 case Instruction::FSub: {
4653 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
4654 Value *Op;
4655 if (match(LHSI, m_FNeg(m_Value(Op))))
4656 return new FCmpInst(I.getSwappedPredicate(), Op,
4657 ConstantExpr::getFNeg(RHSC));
4658 break;
4659 }
Dan Gohman94732022010-02-24 06:46:09 +00004660 case Instruction::Load:
4661 if (GetElementPtrInst *GEP =
4662 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
4663 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
4664 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
4665 !cast<LoadInst>(LHSI)->isVolatile())
4666 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
4667 return Res;
4668 }
4669 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004670 case Instruction::Call: {
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004671 if (!RHSC->isNullValue())
4672 break;
4673
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004674 CallInst *CI = cast<CallInst>(LHSI);
David Majnemerb4b27232016-04-19 19:10:21 +00004675 Intrinsic::ID IID = getIntrinsicForCallSite(CI, TLI);
David Majnemer2e02ba72016-04-15 17:21:03 +00004676 if (IID != Intrinsic::fabs)
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004677 break;
4678
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004679 // Various optimization for fabs compared with zero.
David Majnemer2e02ba72016-04-15 17:21:03 +00004680 switch (I.getPredicate()) {
4681 default:
4682 break;
4683 // fabs(x) < 0 --> false
4684 case FCmpInst::FCMP_OLT:
4685 llvm_unreachable("handled by SimplifyFCmpInst");
4686 // fabs(x) > 0 --> x != 0
4687 case FCmpInst::FCMP_OGT:
4688 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0), RHSC);
4689 // fabs(x) <= 0 --> x == 0
4690 case FCmpInst::FCMP_OLE:
4691 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0), RHSC);
4692 // fabs(x) >= 0 --> !isnan(x)
4693 case FCmpInst::FCMP_OGE:
4694 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0), RHSC);
4695 // fabs(x) == 0 --> x == 0
4696 // fabs(x) != 0 --> x != 0
4697 case FCmpInst::FCMP_OEQ:
4698 case FCmpInst::FCMP_UEQ:
4699 case FCmpInst::FCMP_ONE:
4700 case FCmpInst::FCMP_UNE:
4701 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004702 }
4703 }
Chris Lattner2188e402010-01-04 07:37:31 +00004704 }
Chris Lattner2188e402010-01-04 07:37:31 +00004705 }
4706
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00004707 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramerd159d942011-03-31 10:12:22 +00004708 Value *X, *Y;
4709 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00004710 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramerd159d942011-03-31 10:12:22 +00004711
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00004712 // fcmp (fpext x), (fpext y) -> fcmp x, y
4713 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
4714 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
4715 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
4716 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4717 RHSExt->getOperand(0));
4718
Craig Topperf40110f2014-04-25 05:29:35 +00004719 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004720}