blob: 35aaf96d15bb5aa5adec3b900333c60d8c909303 [file] [log] [blame]
Chris Lattner084a1b52009-11-09 22:57:59 +00001//===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
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 routines for folding instructions into simpler forms
Duncan Sandsa0219882010-11-23 10:50:08 +000011// that do not require creating new instructions. This does constant folding
12// ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
13// returning a constant ("and i32 %x, 0" -> "0") or an already existing value
Duncan Sandsed6d6c32010-12-20 14:47:04 +000014// ("and i32 %x, %x" -> "%x"). All operands are assumed to have already been
15// simplified: This is usually true and assuming it simplifies the logic (if
16// they have not been simplified then results are correct but maybe suboptimal).
Chris Lattner084a1b52009-11-09 22:57:59 +000017//
18//===----------------------------------------------------------------------===//
19
20#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SetVector.h"
22#include "llvm/ADT/Statistic.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000023#include "llvm/Analysis/AliasAnalysis.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000024#include "llvm/Analysis/AssumptionCache.h"
Anna Thomas43d7e1c2016-05-03 14:58:21 +000025#include "llvm/Analysis/CaptureTracking.h"
Craig Topper0aa3a192017-08-14 21:39:51 +000026#include "llvm/Analysis/CmpInstAnalysis.h"
Chris Lattner084a1b52009-11-09 22:57:59 +000027#include "llvm/Analysis/ConstantFolding.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000028#include "llvm/Analysis/LoopAnalysisManager.h"
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +000029#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000030#include "llvm/Analysis/ValueTracking.h"
David Majnemer599ca442015-07-13 01:15:53 +000031#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000032#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000034#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000035#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000036#include "llvm/IR/GlobalAlias.h"
37#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000038#include "llvm/IR/PatternMatch.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000039#include "llvm/IR/ValueHandle.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000040#include "llvm/Support/KnownBits.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000041#include <algorithm>
Chris Lattner084a1b52009-11-09 22:57:59 +000042using namespace llvm;
Chris Lattnera71e9d62009-11-10 00:55:12 +000043using namespace llvm::PatternMatch;
Chris Lattner084a1b52009-11-09 22:57:59 +000044
Chandler Carruthf1221bd2014-04-22 02:48:03 +000045#define DEBUG_TYPE "instsimplify"
46
Chris Lattner9e4aa022011-02-09 17:15:04 +000047enum { RecursionLimit = 3 };
Duncan Sandsf3b1bf12010-11-10 18:23:01 +000048
Duncan Sands3547d2e2010-12-22 09:40:51 +000049STATISTIC(NumExpand, "Number of expansions");
Duncan Sands3547d2e2010-12-22 09:40:51 +000050STATISTIC(NumReassoc, "Number of reassociations");
51
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000052static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
53static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000054 unsigned);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +000055static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000056 const SimplifyQuery &, unsigned);
57static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000058 unsigned);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +000059static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000060 const SimplifyQuery &Q, unsigned MaxRecurse);
61static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
62static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
David Majnemer6774d612016-07-26 17:58:05 +000063static Value *SimplifyCastInst(unsigned, Value *, Type *,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000064 const SimplifyQuery &, unsigned);
George Burgess IV8e807bf2018-04-24 00:25:01 +000065static Value *SimplifyGEPInst(Type *, ArrayRef<Value *>, const SimplifyQuery &,
66 unsigned);
Duncan Sands5ffc2982010-11-16 12:16:38 +000067
David Bolvanskyf9476082018-07-28 06:55:51 +000068static Value *foldSelectWithBinaryOp(Value *Cond, Value *TrueVal,
69 Value *FalseVal) {
70 BinaryOperator::BinaryOps BinOpCode;
71 if (auto *BO = dyn_cast<BinaryOperator>(Cond))
72 BinOpCode = BO->getOpcode();
73 else
74 return nullptr;
75
David Bolvansky16d8a692018-07-31 14:17:15 +000076 CmpInst::Predicate ExpectedPred, Pred1, Pred2;
David Bolvanskyf9476082018-07-28 06:55:51 +000077 if (BinOpCode == BinaryOperator::Or) {
78 ExpectedPred = ICmpInst::ICMP_NE;
79 } else if (BinOpCode == BinaryOperator::And) {
80 ExpectedPred = ICmpInst::ICMP_EQ;
81 } else
82 return nullptr;
83
David Bolvansky16d8a692018-07-31 14:17:15 +000084 // %A = icmp eq %TV, %FV
85 // %B = icmp eq %X, %Y (and one of these is a select operand)
86 // %C = and %A, %B
87 // %D = select %C, %TV, %FV
88 // -->
89 // %FV
90
91 // %A = icmp ne %TV, %FV
92 // %B = icmp ne %X, %Y (and one of these is a select operand)
93 // %C = or %A, %B
94 // %D = select %C, %TV, %FV
95 // -->
96 // %TV
97 Value *X, *Y;
98 if (!match(Cond, m_c_BinOp(m_c_ICmp(Pred1, m_Specific(TrueVal),
99 m_Specific(FalseVal)),
100 m_ICmp(Pred2, m_Value(X), m_Value(Y)))) ||
David Bolvanskyf9476082018-07-28 06:55:51 +0000101 Pred1 != Pred2 || Pred1 != ExpectedPred)
102 return nullptr;
103
David Bolvansky16d8a692018-07-31 14:17:15 +0000104 if (X == TrueVal || X == FalseVal || Y == TrueVal || Y == FalseVal)
105 return BinOpCode == BinaryOperator::Or ? TrueVal : FalseVal;
106
107 return nullptr;
David Bolvanskyf9476082018-07-28 06:55:51 +0000108}
109
Sanjay Patel35ed2412017-04-16 17:43:11 +0000110/// For a boolean type or a vector of boolean type, return false or a vector
111/// with every element false.
Duncan Sandsc1c92712011-07-26 15:03:53 +0000112static Constant *getFalse(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +0000113 return ConstantInt::getFalse(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +0000114}
115
Sanjay Patel35ed2412017-04-16 17:43:11 +0000116/// For a boolean type or a vector of boolean type, return true or a vector
117/// with every element true.
Duncan Sandsc1c92712011-07-26 15:03:53 +0000118static Constant *getTrue(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +0000119 return ConstantInt::getTrue(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +0000120}
121
Duncan Sands3d5692a2011-10-30 19:56:36 +0000122/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
123static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
124 Value *RHS) {
125 CmpInst *Cmp = dyn_cast<CmpInst>(V);
126 if (!Cmp)
127 return false;
128 CmpInst::Predicate CPred = Cmp->getPredicate();
129 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
130 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
131 return true;
132 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
133 CRHS == LHS;
134}
135
Sanjay Patel472cc782016-01-11 22:14:42 +0000136/// Does the given value dominate the specified phi node?
Sanjay Patel5da361a2018-04-10 18:38:19 +0000137static bool valueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
Duncan Sands5ffc2982010-11-16 12:16:38 +0000138 Instruction *I = dyn_cast<Instruction>(V);
139 if (!I)
140 // Arguments and constants dominate all instructions.
141 return true;
142
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000143 // If we are processing instructions (and/or basic blocks) that have not been
144 // fully added to a function, the parent nodes may still be null. Simply
145 // return the conservative answer in these cases.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000146 if (!I->getParent() || !P->getParent() || !I->getFunction())
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000147 return false;
148
Duncan Sands5ffc2982010-11-16 12:16:38 +0000149 // If we have a DominatorTree then do a precise test.
Daniel Berlin71ff6632017-05-31 01:47:24 +0000150 if (DT)
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000151 return DT->dominates(I, P);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000152
David Majnemer8a1c45d2015-12-12 05:38:55 +0000153 // Otherwise, if the instruction is in the entry block and is not an invoke,
154 // then it obviously dominates all phi nodes.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000155 if (I->getParent() == &I->getFunction()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000156 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000157 return true;
158
159 return false;
160}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000161
Sanjay Patel472cc782016-01-11 22:14:42 +0000162/// Simplify "A op (B op' C)" by distributing op over op', turning it into
163/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000164/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
165/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
166/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000167static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
Craig Topper9c913bf2017-05-19 16:56:53 +0000168 Instruction::BinaryOps OpcodeToExpand,
169 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000170 // Recursion is always used, so bail out at once if we already hit the limit.
171 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000172 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000173
174 // Check whether the expression has the form "(A op' B) op C".
175 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
176 if (Op0->getOpcode() == OpcodeToExpand) {
177 // It does! Try turning it into "(A op C) op' (B op C)".
178 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
179 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000180 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
181 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000182 // They do! Return "L op' R" if it simplifies or is already available.
183 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000184 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
185 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000186 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000187 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000188 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000189 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000190 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000191 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000192 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000193 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000194 }
195 }
196
197 // Check whether the expression has the form "A op (B op' C)".
198 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
199 if (Op1->getOpcode() == OpcodeToExpand) {
200 // It does! Try turning it into "(A op B) op' (A op C)".
201 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
202 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000203 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
204 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000205 // They do! Return "L op' R" if it simplifies or is already available.
206 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000207 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
208 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000209 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000210 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000211 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000212 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000213 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000214 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000215 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000216 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000217 }
218 }
219
Craig Topper9f008862014-04-15 04:59:12 +0000220 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000221}
222
Sanjay Patel472cc782016-01-11 22:14:42 +0000223/// Generic simplifications for associative binary operations.
224/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000225static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
Craig Topper9c913bf2017-05-19 16:56:53 +0000226 Value *LHS, Value *RHS,
227 const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000228 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000229 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
230
231 // Recursion is always used, so bail out at once if we already hit the limit.
232 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000233 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000234
235 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
236 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
237
238 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
239 if (Op0 && Op0->getOpcode() == Opcode) {
240 Value *A = Op0->getOperand(0);
241 Value *B = Op0->getOperand(1);
242 Value *C = RHS;
243
244 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000245 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000246 // It does! Return "A op V" if it simplifies or is already available.
247 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000248 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000249 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000250 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000251 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000252 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000253 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000254 }
255 }
256
257 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
258 if (Op1 && Op1->getOpcode() == Opcode) {
259 Value *A = LHS;
260 Value *B = Op1->getOperand(0);
261 Value *C = Op1->getOperand(1);
262
263 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000264 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000265 // It does! Return "V op C" if it simplifies or is already available.
266 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000267 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000268 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000269 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000270 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000271 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000272 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000273 }
274 }
275
276 // The remaining transforms require commutativity as well as associativity.
277 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000278 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000279
280 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
281 if (Op0 && Op0->getOpcode() == Opcode) {
282 Value *A = Op0->getOperand(0);
283 Value *B = Op0->getOperand(1);
284 Value *C = RHS;
285
286 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000287 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000288 // It does! Return "V op B" if it simplifies or is already available.
289 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000290 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000291 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000292 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000293 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000294 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000295 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000296 }
297 }
298
299 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
300 if (Op1 && Op1->getOpcode() == Opcode) {
301 Value *A = LHS;
302 Value *B = Op1->getOperand(0);
303 Value *C = Op1->getOperand(1);
304
305 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000306 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000307 // It does! Return "B op V" if it simplifies or is already available.
308 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000309 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000310 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000311 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000312 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000313 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000314 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000315 }
316 }
317
Craig Topper9f008862014-04-15 04:59:12 +0000318 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000319}
320
Sanjay Patel472cc782016-01-11 22:14:42 +0000321/// In the case of a binary operation with a select instruction as an operand,
322/// try to simplify the binop by seeing whether evaluating it on both branches
323/// of the select results in the same value. Returns the common value if so,
324/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000325static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000326 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000327 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000328 // Recursion is always used, so bail out at once if we already hit the limit.
329 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000330 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000331
Duncan Sandsb0579e92010-11-10 13:00:08 +0000332 SelectInst *SI;
333 if (isa<SelectInst>(LHS)) {
334 SI = cast<SelectInst>(LHS);
335 } else {
336 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
337 SI = cast<SelectInst>(RHS);
338 }
339
340 // Evaluate the BinOp on the true and false branches of the select.
341 Value *TV;
342 Value *FV;
343 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000344 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
345 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000346 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000347 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
348 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000349 }
350
Duncan Sandse3c53952011-01-01 16:12:09 +0000351 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000352 // If they both failed to simplify then return null.
353 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000354 return TV;
355
356 // If one branch simplified to undef, return the other one.
357 if (TV && isa<UndefValue>(TV))
358 return FV;
359 if (FV && isa<UndefValue>(FV))
360 return TV;
361
362 // If applying the operation did not change the true and false select values,
363 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000364 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000365 return SI;
366
367 // If one branch simplified and the other did not, and the simplified
368 // value is equal to the unsimplified one, return the simplified value.
369 // For example, select (cond, X, X & Z) & Z -> X & Z.
370 if ((FV && !TV) || (TV && !FV)) {
371 // Check that the simplified value has the form "X op Y" where "op" is the
372 // same as the original operation.
373 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
Zachary Turner260fe3e2017-12-14 22:07:03 +0000374 if (Simplified && Simplified->getOpcode() == unsigned(Opcode)) {
Duncan Sandsb0579e92010-11-10 13:00:08 +0000375 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
376 // We already know that "op" is the same as for the simplified value. See
377 // if the operands match too. If so, return the simplified value.
378 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
379 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
380 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000381 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
382 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000383 return Simplified;
384 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000385 Simplified->getOperand(1) == UnsimplifiedLHS &&
386 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000387 return Simplified;
388 }
389 }
390
Craig Topper9f008862014-04-15 04:59:12 +0000391 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000392}
393
Sanjay Patel472cc782016-01-11 22:14:42 +0000394/// In the case of a comparison with a select instruction, try to simplify the
395/// comparison by seeing whether both branches of the select result in the same
396/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000397static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000398 Value *RHS, const SimplifyQuery &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000399 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000400 // Recursion is always used, so bail out at once if we already hit the limit.
401 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000402 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000403
Duncan Sandsb0579e92010-11-10 13:00:08 +0000404 // Make sure the select is on the LHS.
405 if (!isa<SelectInst>(LHS)) {
406 std::swap(LHS, RHS);
407 Pred = CmpInst::getSwappedPredicate(Pred);
408 }
409 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
410 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000411 Value *Cond = SI->getCondition();
412 Value *TV = SI->getTrueValue();
413 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000414
Duncan Sands06504022011-02-03 09:37:39 +0000415 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000416 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000417 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000418 if (TCmp == Cond) {
419 // It not only simplified, it simplified to the select condition. Replace
420 // it with 'true'.
421 TCmp = getTrue(Cond->getType());
422 } else if (!TCmp) {
423 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
424 // condition then we can replace it with 'true'. Otherwise give up.
425 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000426 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000427 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000428 }
429
Duncan Sands3d5692a2011-10-30 19:56:36 +0000430 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000431 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000432 if (FCmp == Cond) {
433 // It not only simplified, it simplified to the select condition. Replace
434 // it with 'false'.
435 FCmp = getFalse(Cond->getType());
436 } else if (!FCmp) {
437 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
438 // condition then we can replace it with 'false'. Otherwise give up.
439 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000440 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000441 FCmp = getFalse(Cond->getType());
442 }
443
444 // If both sides simplified to the same value, then use it as the result of
445 // the original comparison.
446 if (TCmp == FCmp)
447 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000448
449 // The remaining cases only make sense if the select condition has the same
450 // type as the result of the comparison, so bail out if this is not so.
451 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000452 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000453 // If the false value simplified to false, then the result of the compare
454 // is equal to "Cond && TCmp". This also catches the case when the false
455 // value simplified to false and the true value to true, returning "Cond".
456 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000457 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000458 return V;
459 // If the true value simplified to true, then the result of the compare
460 // is equal to "Cond || FCmp".
461 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000462 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000463 return V;
464 // Finally, if the false value simplified to true and the true value to
465 // false, then the result of the compare is equal to "!Cond".
466 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
467 if (Value *V =
468 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000469 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000470 return V;
471
Craig Topper9f008862014-04-15 04:59:12 +0000472 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000473}
474
Sanjay Patel472cc782016-01-11 22:14:42 +0000475/// In the case of a binary operation with an operand that is a PHI instruction,
476/// try to simplify the binop by seeing whether evaluating it on the incoming
477/// phi values yields the same result for every value. If so returns the common
478/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000479static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000480 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000481 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000482 // Recursion is always used, so bail out at once if we already hit the limit.
483 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000484 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000485
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000486 PHINode *PI;
487 if (isa<PHINode>(LHS)) {
488 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000489 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000490 if (!valueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000491 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000492 } else {
493 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
494 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000495 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000496 if (!valueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000497 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000498 }
499
500 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000501 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000502 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000503 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000504 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000505 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000506 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
507 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000508 // If the operation failed to simplify, or simplified to a different value
509 // to previously, then give up.
510 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000511 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000512 CommonValue = V;
513 }
514
515 return CommonValue;
516}
517
Sanjay Patel472cc782016-01-11 22:14:42 +0000518/// In the case of a comparison with a PHI instruction, try to simplify the
519/// comparison by seeing whether comparing with all of the incoming phi values
520/// yields the same result every time. If so returns the common result,
521/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000522static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000523 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000524 // Recursion is always used, so bail out at once if we already hit the limit.
525 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000526 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000527
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000528 // Make sure the phi is on the LHS.
529 if (!isa<PHINode>(LHS)) {
530 std::swap(LHS, RHS);
531 Pred = CmpInst::getSwappedPredicate(Pred);
532 }
533 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
534 PHINode *PI = cast<PHINode>(LHS);
535
Duncan Sands5ffc2982010-11-16 12:16:38 +0000536 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000537 if (!valueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000538 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000539
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000540 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000541 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000542 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000543 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000544 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000545 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000546 // If the operation failed to simplify, or simplified to a different value
547 // to previously, then give up.
548 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000549 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000550 CommonValue = V;
551 }
552
553 return CommonValue;
554}
555
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000556static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
557 Value *&Op0, Value *&Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000558 const SimplifyQuery &Q) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000559 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
560 if (auto *CRHS = dyn_cast<Constant>(Op1))
561 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
562
563 // Canonicalize the constant to the RHS if this is a commutative operation.
564 if (Instruction::isCommutative(Opcode))
565 std::swap(Op0, Op1);
566 }
567 return nullptr;
568}
569
Sanjay Patel472cc782016-01-11 22:14:42 +0000570/// Given operands for an Add, see if we can fold the result.
571/// If not, this returns null.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000572static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000573 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000574 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
575 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000576
Duncan Sands0a2c41682010-12-15 14:07:39 +0000577 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000578 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000579 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000580
Duncan Sands0a2c41682010-12-15 14:07:39 +0000581 // X + 0 -> X
582 if (match(Op1, m_Zero()))
583 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000584
Chen Zhengfdf13ef2018-07-12 03:06:04 +0000585 // If two operands are negative, return 0.
586 if (isKnownNegation(Op0, Op1))
587 return Constant::getNullValue(Op0->getType());
588
Duncan Sands0a2c41682010-12-15 14:07:39 +0000589 // X + (Y - X) -> Y
590 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000591 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000592 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000593 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
594 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000595 return Y;
596
597 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000598 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000599 if (match(Op0, m_Not(m_Specific(Op1))) ||
600 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000601 return Constant::getAllOnesValue(Ty);
602
Craig Topperbcfd2d12017-04-20 16:56:25 +0000603 // add nsw/nuw (xor Y, signmask), signmask --> Y
Sanjay Patelfe672552017-02-18 21:59:09 +0000604 // The no-wrapping add guarantees that the top bit will be set by the add.
605 // Therefore, the xor must be clearing the already set sign bit of Y.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000606 if ((IsNSW || IsNUW) && match(Op1, m_SignMask()) &&
Craig Topperbcfd2d12017-04-20 16:56:25 +0000607 match(Op0, m_Xor(m_Value(Y), m_SignMask())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000608 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000609
Roman Lebedevb060ce42018-06-08 15:44:47 +0000610 // add nuw %x, -1 -> -1, because %x can only be 0.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000611 if (IsNUW && match(Op1, m_AllOnes()))
Roman Lebedevb060ce42018-06-08 15:44:47 +0000612 return Op1; // Which is -1.
613
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000614 /// i1 add -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000615 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000616 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000617 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000618
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000619 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000620 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000621 MaxRecurse))
622 return V;
623
Duncan Sandsb238de02010-11-19 09:20:39 +0000624 // Threading Add over selects and phi nodes is pointless, so don't bother.
625 // Threading over the select in "A + select(cond, B, C)" means evaluating
626 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
627 // only if B and C are equal. If B and C are equal then (since we assume
628 // that operands have already been simplified) "select(cond, B, C)" should
629 // have been simplified to the common value of B and C already. Analysing
630 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
631 // for threading over phi nodes.
632
Craig Topper9f008862014-04-15 04:59:12 +0000633 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000634}
635
Roman Lebedevf87321a2018-06-08 15:44:53 +0000636Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000637 const SimplifyQuery &Query) {
Roman Lebedevf87321a2018-06-08 15:44:53 +0000638 return ::SimplifyAddInst(Op0, Op1, IsNSW, IsNUW, Query, RecursionLimit);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000639}
640
Adrian Prantl5f8f34e42018-05-01 15:54:18 +0000641/// Compute the base pointer and cumulative constant offsets for V.
Chandler Carrutha0796552012-03-12 11:19:31 +0000642///
643/// This strips all constant offsets off of V, leaving it the base pointer, and
644/// accumulates the total constant offset applied in the returned constant. It
645/// returns 0 if V is not a pointer, and returns the constant '0' if there are
646/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000647///
648/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
649/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
650/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000651static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000652 bool AllowNonInbounds = false) {
Craig Topper95d23472017-07-09 07:04:00 +0000653 assert(V->getType()->isPtrOrPtrVectorTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000654
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000655 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000656 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000657
658 // Even though we don't look through PHI nodes, we could be called on an
659 // instruction in an unreachable block, which may be on a cycle.
660 SmallPtrSet<Value *, 4> Visited;
661 Visited.insert(V);
662 do {
663 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000664 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000665 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000666 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000667 V = GEP->getPointerOperand();
668 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000669 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000670 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000671 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000672 break;
673 V = GA->getAliasee();
674 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000675 if (auto CS = CallSite(V))
676 if (Value *RV = CS.getReturnedArgOperand()) {
677 V = RV;
678 continue;
679 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000680 break;
681 }
Craig Topper95d23472017-07-09 07:04:00 +0000682 assert(V->getType()->isPtrOrPtrVectorTy() && "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000683 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000684
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000685 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
686 if (V->getType()->isVectorTy())
687 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
688 OffsetIntPtr);
689 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000690}
691
Adrian Prantl5f8f34e42018-05-01 15:54:18 +0000692/// Compute the constant difference between two pointer values.
Chandler Carrutha0796552012-03-12 11:19:31 +0000693/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000694static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
695 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000696 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
697 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000698
699 // If LHS and RHS are not related via constant offsets to the same base
700 // value, there is nothing we can do here.
701 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000702 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000703
704 // Otherwise, the difference of LHS - RHS can be computed as:
705 // LHS - RHS
706 // = (LHSOffset + Base) - (RHSOffset + Base)
707 // = LHSOffset - RHSOffset
708 return ConstantExpr::getSub(LHSOffset, RHSOffset);
709}
710
Sanjay Patel472cc782016-01-11 22:14:42 +0000711/// Given operands for a Sub, see if we can fold the result.
712/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000713static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000714 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000715 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
716 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000717
718 // X - undef -> undef
719 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000720 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000721 return UndefValue::get(Op0->getType());
722
723 // X - 0 -> X
724 if (match(Op1, m_Zero()))
725 return Op0;
726
727 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000728 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000729 return Constant::getNullValue(Op0->getType());
730
Sanjay Patelefd88852016-10-19 21:23:45 +0000731 // Is this a negation?
732 if (match(Op0, m_Zero())) {
733 // 0 - X -> 0 if the sub is NUW.
734 if (isNUW)
Sanjay Patel30be6652018-04-22 17:07:44 +0000735 return Constant::getNullValue(Op0->getType());
Sanjay Patelefd88852016-10-19 21:23:45 +0000736
Craig Topper8205a1a2017-05-24 16:53:07 +0000737 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +0000738 if (Known.Zero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000739 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
740 // Op1 must be 0 because negating the minimum signed value is undefined.
741 if (isNSW)
Sanjay Patel30be6652018-04-22 17:07:44 +0000742 return Constant::getNullValue(Op0->getType());
Sanjay Patelefd88852016-10-19 21:23:45 +0000743
744 // 0 - X -> X if X is 0 or the minimum signed value.
745 return Op1;
746 }
747 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000748
Duncan Sands99589d02011-01-18 11:50:19 +0000749 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
750 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000751 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000752 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
753 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000754 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000755 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000756 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000757 // It does, we successfully reassociated!
758 ++NumReassoc;
759 return W;
760 }
761 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000762 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000763 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000764 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000765 // It does, we successfully reassociated!
766 ++NumReassoc;
767 return W;
768 }
769 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000770
Duncan Sands99589d02011-01-18 11:50:19 +0000771 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
772 // For example, X - (X + 1) -> -1
773 X = Op0;
774 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
775 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000776 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000777 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000778 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000779 // It does, we successfully reassociated!
780 ++NumReassoc;
781 return W;
782 }
783 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000784 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000785 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000786 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000787 // It does, we successfully reassociated!
788 ++NumReassoc;
789 return W;
790 }
791 }
792
793 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
794 // For example, X - (X - Y) -> Y.
795 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000796 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
797 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000798 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000799 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000800 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000801 // It does, we successfully reassociated!
802 ++NumReassoc;
803 return W;
804 }
805
Duncan Sands395ac42d2012-03-13 14:07:05 +0000806 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
807 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
808 match(Op1, m_Trunc(m_Value(Y))))
809 if (X->getType() == Y->getType())
810 // See if "V === X - Y" simplifies.
811 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
812 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000813 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
814 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000815 // It does, return the simplified "trunc V".
816 return W;
817
818 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000819 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000820 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000821 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000822 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
823
Duncan Sands99589d02011-01-18 11:50:19 +0000824 // i1 sub -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000825 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000826 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000827 return V;
828
Duncan Sands0a2c41682010-12-15 14:07:39 +0000829 // Threading Sub over selects and phi nodes is pointless, so don't bother.
830 // Threading over the select in "A - select(cond, B, C)" means evaluating
831 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
832 // only if B and C are equal. If B and C are equal then (since we assume
833 // that operands have already been simplified) "select(cond, B, C)" should
834 // have been simplified to the common value of B and C already. Analysing
835 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
836 // for threading over phi nodes.
837
Craig Topper9f008862014-04-15 04:59:12 +0000838 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000839}
840
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000841Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000842 const SimplifyQuery &Q) {
843 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
844}
845
Sanjay Patel472cc782016-01-11 22:14:42 +0000846/// Given operands for a Mul, see if we can fold the result.
847/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000848static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000849 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000850 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
851 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000852
853 // X * undef -> 0
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000854 // X * 0 -> 0
Sanjay Patel30be6652018-04-22 17:07:44 +0000855 if (match(Op1, m_CombineOr(m_Undef(), m_Zero())))
856 return Constant::getNullValue(Op0->getType());
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000857
858 // X * 1 -> X
859 if (match(Op1, m_One()))
860 return Op0;
861
Duncan Sandsb67edc62011-01-30 18:03:50 +0000862 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000863 Value *X = nullptr;
Florian Hahn19f9e322018-08-17 14:39:04 +0000864 if (Q.IIQ.UseInstrInfo &&
865 (match(Op0,
866 m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
867 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0)))))) // Y * (X / Y)
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000868 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000869
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000870 // i1 mul -> and.
Craig Topperfde47232017-07-09 07:04:03 +0000871 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000872 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000873 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000874
875 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000876 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000877 MaxRecurse))
878 return V;
879
Dmitry Venikovd2257be2018-01-02 05:47:42 +0000880 // Mul distributes over Add. Try some generic simplifications based on this.
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000881 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000882 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000883 return V;
884
885 // If the operation is with the result of a select instruction, check whether
886 // operating on either branch of the select always yields the same value.
887 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000888 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000889 MaxRecurse))
890 return V;
891
892 // If the operation is with the result of a phi instruction, check whether
893 // operating on all incoming values of the phi always yields the same value.
894 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000895 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000896 MaxRecurse))
897 return V;
898
Craig Topper9f008862014-04-15 04:59:12 +0000899 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000900}
901
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000902Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
903 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
904}
905
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000906/// Check for common or similar folds of integer division or integer remainder.
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000907/// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000908static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
909 Type *Ty = Op0->getType();
910
911 // X / undef -> undef
912 // X % undef -> undef
913 if (match(Op1, m_Undef()))
914 return Op1;
915
916 // X / 0 -> undef
917 // X % 0 -> undef
918 // We don't need to preserve faults!
919 if (match(Op1, m_Zero()))
920 return UndefValue::get(Ty);
921
Zvi Rackover51f0d642018-01-24 17:22:00 +0000922 // If any element of a constant divisor vector is zero or undef, the whole op
923 // is undef.
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000924 auto *Op1C = dyn_cast<Constant>(Op1);
925 if (Op1C && Ty->isVectorTy()) {
926 unsigned NumElts = Ty->getVectorNumElements();
927 for (unsigned i = 0; i != NumElts; ++i) {
928 Constant *Elt = Op1C->getAggregateElement(i);
Zvi Rackover51f0d642018-01-24 17:22:00 +0000929 if (Elt && (Elt->isNullValue() || isa<UndefValue>(Elt)))
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000930 return UndefValue::get(Ty);
931 }
932 }
933
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000934 // undef / X -> 0
935 // undef % X -> 0
936 if (match(Op0, m_Undef()))
937 return Constant::getNullValue(Ty);
938
939 // 0 / X -> 0
940 // 0 % X -> 0
941 if (match(Op0, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +0000942 return Constant::getNullValue(Op0->getType());
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000943
944 // X / X -> 1
945 // X % X -> 0
946 if (Op0 == Op1)
947 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
948
949 // X / 1 -> X
950 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +0000951 // If this is a boolean op (single-bit element type), we can't have
952 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
Sanjay Patel1e911fa2018-06-25 18:51:21 +0000953 // Similarly, if we're zero-extending a boolean divisor, then assume it's a 1.
954 Value *X;
955 if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1) ||
956 (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000957 return IsDiv ? Op0 : Constant::getNullValue(Ty);
958
959 return nullptr;
960}
961
Sanjay Patelcca8f782017-09-14 14:09:11 +0000962/// Given a predicate and two operands, return true if the comparison is true.
963/// This is a helper for div/rem simplification where we return some other value
964/// when we can prove a relationship between the operands.
965static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
966 const SimplifyQuery &Q, unsigned MaxRecurse) {
967 Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
968 Constant *C = dyn_cast_or_null<Constant>(V);
969 return (C && C->isAllOnesValue());
970}
971
972/// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
973/// to simplify X % Y to X.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000974static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
Sanjay Patelcca8f782017-09-14 14:09:11 +0000975 unsigned MaxRecurse, bool IsSigned) {
976 // Recursion is always used, so bail out at once if we already hit the limit.
977 if (!MaxRecurse--)
978 return false;
979
980 if (IsSigned) {
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000981 // |X| / |Y| --> 0
982 //
983 // We require that 1 operand is a simple constant. That could be extended to
984 // 2 variables if we computed the sign bit for each.
985 //
986 // Make sure that a constant is not the minimum signed value because taking
987 // the abs() of that is undefined.
988 Type *Ty = X->getType();
989 const APInt *C;
990 if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
991 // Is the variable divisor magnitude always greater than the constant
992 // dividend magnitude?
993 // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
994 Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
995 Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
996 if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
997 isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
998 return true;
999 }
1000 if (match(Y, m_APInt(C))) {
1001 // Special-case: we can't take the abs() of a minimum signed value. If
1002 // that's the divisor, then all we have to do is prove that the dividend
1003 // is also not the minimum signed value.
1004 if (C->isMinSignedValue())
1005 return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
1006
1007 // Is the variable dividend magnitude always less than the constant
1008 // divisor magnitude?
1009 // |X| < |C| --> X > -abs(C) and X < abs(C)
1010 Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
1011 Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
1012 if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
1013 isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
1014 return true;
1015 }
Sanjay Patelcca8f782017-09-14 14:09:11 +00001016 return false;
1017 }
1018
1019 // IsSigned == false.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +00001020 // Is the dividend unsigned less than the divisor?
1021 return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
Sanjay Patelcca8f782017-09-14 14:09:11 +00001022}
1023
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001024/// These are simplifications common to SDiv and UDiv.
1025static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001026 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001027 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1028 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001029
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001030 if (Value *V = simplifyDivRem(Op0, Op1, true))
1031 return V;
1032
Sanjay Patelcca8f782017-09-14 14:09:11 +00001033 bool IsSigned = Opcode == Instruction::SDiv;
Duncan Sands65995fa2011-01-28 18:50:50 +00001034
Duncan Sands771e82a2011-01-28 16:51:11 +00001035 // (X * Y) / Y -> X if the multiplication does not overflow.
Sanjay Patel33cb8452018-01-19 16:12:55 +00001036 Value *X;
1037 if (match(Op0, m_c_Mul(m_Value(X), m_Specific(Op1)))) {
1038 auto *Mul = cast<OverflowingBinaryOperator>(Op0);
1039 // If the Mul does not overflow, then we are good to go.
Florian Hahn19f9e322018-08-17 14:39:04 +00001040 if ((IsSigned && Q.IIQ.hasNoSignedWrap(Mul)) ||
1041 (!IsSigned && Q.IIQ.hasNoUnsignedWrap(Mul)))
Duncan Sands5747aba2011-02-02 20:52:00 +00001042 return X;
Sanjay Patel33cb8452018-01-19 16:12:55 +00001043 // If X has the form X = A / Y, then X * Y cannot overflow.
1044 if ((IsSigned && match(X, m_SDiv(m_Value(), m_Specific(Op1)))) ||
1045 (!IsSigned && match(X, m_UDiv(m_Value(), m_Specific(Op1)))))
1046 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001047 }
1048
Duncan Sands65995fa2011-01-28 18:50:50 +00001049 // (X rem Y) / Y -> 0
Sanjay Patelcca8f782017-09-14 14:09:11 +00001050 if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1051 (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
Duncan Sands65995fa2011-01-28 18:50:50 +00001052 return Constant::getNullValue(Op0->getType());
1053
David Majnemercb9d5962014-10-11 10:20:01 +00001054 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1055 ConstantInt *C1, *C2;
Sanjay Patelcca8f782017-09-14 14:09:11 +00001056 if (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
David Majnemercb9d5962014-10-11 10:20:01 +00001057 match(Op1, m_ConstantInt(C2))) {
1058 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001059 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001060 if (Overflow)
1061 return Constant::getNullValue(Op0->getType());
1062 }
1063
Duncan Sands65995fa2011-01-28 18:50:50 +00001064 // If the operation is with the result of a select instruction, check whether
1065 // operating on either branch of the select always yields the same value.
1066 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001067 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001068 return V;
1069
1070 // If the operation is with the result of a phi instruction, check whether
1071 // operating on all incoming values of the phi always yields the same value.
1072 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001073 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001074 return V;
1075
Sanjay Patelcca8f782017-09-14 14:09:11 +00001076 if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1077 return Constant::getNullValue(Op0->getType());
1078
Craig Topper9f008862014-04-15 04:59:12 +00001079 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001080}
1081
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001082/// These are simplifications common to SRem and URem.
1083static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001084 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001085 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1086 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001087
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001088 if (Value *V = simplifyDivRem(Op0, Op1, false))
1089 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001090
David Majnemerb435a422014-09-17 04:16:35 +00001091 // (X % Y) % Y -> X % Y
1092 if ((Opcode == Instruction::SRem &&
1093 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1094 (Opcode == Instruction::URem &&
1095 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001096 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001097
Anton Bikineev82f61152018-01-23 09:27:47 +00001098 // (X << Y) % X -> 0
Florian Hahn19f9e322018-08-17 14:39:04 +00001099 if (Q.IIQ.UseInstrInfo &&
1100 ((Opcode == Instruction::SRem &&
1101 match(Op0, m_NSWShl(m_Specific(Op1), m_Value()))) ||
1102 (Opcode == Instruction::URem &&
1103 match(Op0, m_NUWShl(m_Specific(Op1), m_Value())))))
Anton Bikineev82f61152018-01-23 09:27:47 +00001104 return Constant::getNullValue(Op0->getType());
1105
Duncan Sandsa3e36992011-05-02 16:27:02 +00001106 // If the operation is with the result of a select instruction, check whether
1107 // operating on either branch of the select always yields the same value.
1108 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001109 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001110 return V;
1111
1112 // If the operation is with the result of a phi instruction, check whether
1113 // operating on all incoming values of the phi always yields the same value.
1114 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001115 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001116 return V;
1117
Sanjay Patelcca8f782017-09-14 14:09:11 +00001118 // If X / Y == 0, then X % Y == X.
1119 if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1120 return Op0;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001121
1122 return nullptr;
1123}
1124
1125/// Given operands for an SDiv, see if we can fold the result.
1126/// If not, this returns null.
1127static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1128 unsigned MaxRecurse) {
Chen Zheng69bb0642018-07-21 12:27:54 +00001129 // If two operands are negated and no signed overflow, return -1.
1130 if (isKnownNegation(Op0, Op1, /*NeedNSW=*/true))
1131 return Constant::getAllOnesValue(Op0->getType());
1132
Sanjay Patelcca8f782017-09-14 14:09:11 +00001133 return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001134}
1135
1136Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1137 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1138}
1139
1140/// Given operands for a UDiv, see if we can fold the result.
1141/// If not, this returns null.
1142static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1143 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001144 return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001145}
1146
1147Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1148 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1149}
1150
Sanjay Patel472cc782016-01-11 22:14:42 +00001151/// Given operands for an SRem, see if we can fold the result.
1152/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001153static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001154 unsigned MaxRecurse) {
Sanjay Patel2b7e3102018-06-26 15:32:54 +00001155 // If the divisor is 0, the result is undefined, so assume the divisor is -1.
1156 // srem Op0, (sext i1 X) --> srem Op0, -1 --> 0
1157 Value *X;
1158 if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
1159 return ConstantInt::getNullValue(Op0->getType());
1160
Chen Zhengf801d0f2018-07-20 13:00:47 +00001161 // If the two operands are negated, return 0.
1162 if (isKnownNegation(Op0, Op1))
Chen Zheng69bb0642018-07-21 12:27:54 +00001163 return ConstantInt::getNullValue(Op0->getType());
Chen Zhengf801d0f2018-07-20 13:00:47 +00001164
Sanjay Patelcca8f782017-09-14 14:09:11 +00001165 return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001166}
1167
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001168Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1169 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1170}
1171
Sanjay Patel472cc782016-01-11 22:14:42 +00001172/// Given operands for a URem, see if we can fold the result.
1173/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001174static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001175 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001176 return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001177}
1178
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001179Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1180 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1181}
1182
Sanjay Patel472cc782016-01-11 22:14:42 +00001183/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001184static bool isUndefShift(Value *Amount) {
1185 Constant *C = dyn_cast<Constant>(Amount);
1186 if (!C)
1187 return false;
1188
1189 // X shift by undef -> undef because it may shift by the bitwidth.
1190 if (isa<UndefValue>(C))
1191 return true;
1192
1193 // Shifting by the bitwidth or more is undefined.
1194 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1195 if (CI->getValue().getLimitedValue() >=
1196 CI->getType()->getScalarSizeInBits())
1197 return true;
1198
1199 // If all lanes of a vector shift are undefined the whole shift is.
1200 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1201 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1202 if (!isUndefShift(C->getAggregateElement(I)))
1203 return false;
1204 return true;
1205 }
1206
1207 return false;
1208}
1209
Sanjay Patel472cc782016-01-11 22:14:42 +00001210/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1211/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001212static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001213 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001214 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1215 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001216
Duncan Sands571fd9a2011-01-14 14:44:12 +00001217 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001218 if (match(Op0, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +00001219 return Constant::getNullValue(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001220
Duncan Sands571fd9a2011-01-14 14:44:12 +00001221 // X shift by 0 -> X
Sanjay Patelad0bfb82018-06-26 17:31:38 +00001222 // Shift-by-sign-extended bool must be shift-by-0 because shift-by-all-ones
1223 // would be poison.
1224 Value *X;
1225 if (match(Op1, m_Zero()) ||
1226 (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
Duncan Sands7f60dc12011-01-14 00:37:45 +00001227 return Op0;
1228
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001229 // Fold undefined shifts.
1230 if (isUndefShift(Op1))
1231 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001232
Duncan Sands571fd9a2011-01-14 14:44:12 +00001233 // If the operation is with the result of a select instruction, check whether
1234 // operating on either branch of the select always yields the same value.
1235 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001236 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001237 return V;
1238
1239 // If the operation is with the result of a phi instruction, check whether
1240 // operating on all incoming values of the phi always yields the same value.
1241 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001242 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001243 return V;
1244
Sanjay Patel6786bc52016-05-10 20:46:54 +00001245 // If any bits in the shift amount make that value greater than or equal to
1246 // the number of bits in the type, the shift is undefined.
Craig Topper8205a1a2017-05-24 16:53:07 +00001247 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1248 if (Known.One.getLimitedValue() >= Known.getBitWidth())
Sanjay Patel6786bc52016-05-10 20:46:54 +00001249 return UndefValue::get(Op0->getType());
1250
1251 // If all valid bits in the shift amount are known zero, the first operand is
1252 // unchanged.
Craig Topper8205a1a2017-05-24 16:53:07 +00001253 unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
Craig Topper8df66c62017-05-12 17:20:30 +00001254 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001255 return Op0;
1256
Craig Topper9f008862014-04-15 04:59:12 +00001257 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001258}
1259
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001260/// Given operands for an Shl, LShr or AShr, see if we can
David Majnemerbf7550e2014-11-05 00:59:59 +00001261/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001262static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001263 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001264 unsigned MaxRecurse) {
1265 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1266 return V;
1267
1268 // X >> X -> 0
1269 if (Op0 == Op1)
1270 return Constant::getNullValue(Op0->getType());
1271
David Majnemer65c52ae2014-12-17 01:54:33 +00001272 // undef >> X -> 0
1273 // undef >> X -> undef (if it's exact)
1274 if (match(Op0, m_Undef()))
1275 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1276
David Majnemerbf7550e2014-11-05 00:59:59 +00001277 // The low bit cannot be shifted out of an exact shift if it is set.
1278 if (isExact) {
Craig Topper8205a1a2017-05-24 16:53:07 +00001279 KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +00001280 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001281 return Op0;
1282 }
1283
1284 return nullptr;
1285}
1286
Sanjay Patel472cc782016-01-11 22:14:42 +00001287/// Given operands for an Shl, see if we can fold the result.
1288/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001289static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001290 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001291 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001292 return V;
1293
1294 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001295 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001296 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001297 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001298
Chris Lattner9e4aa022011-02-09 17:15:04 +00001299 // (X >> A) << A -> X
1300 Value *X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001301 if (Q.IIQ.UseInstrInfo &&
1302 match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001303 return X;
Roman Lebedev26838022018-06-07 20:03:45 +00001304
1305 // shl nuw i8 C, %x -> C iff C has sign bit set.
1306 if (isNUW && match(Op0, m_Negative()))
1307 return Op0;
1308 // NOTE: could use computeKnownBits() / LazyValueInfo,
1309 // but the cost-benefit analysis suggests it isn't worth it.
1310
Craig Topper9f008862014-04-15 04:59:12 +00001311 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001312}
1313
Chris Lattner9e4aa022011-02-09 17:15:04 +00001314Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001315 const SimplifyQuery &Q) {
1316 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1317}
1318
Sanjay Patel472cc782016-01-11 22:14:42 +00001319/// Given operands for an LShr, see if we can fold the result.
1320/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001321static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001322 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001323 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1324 MaxRecurse))
1325 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001326
Chris Lattner9e4aa022011-02-09 17:15:04 +00001327 // (X << A) >> A -> X
1328 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001329 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001330 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001331
Hiroshi Inoue02f79ea2018-08-01 04:40:32 +00001332 // ((X << A) | Y) >> A -> X if effective width of Y is not larger than A.
1333 // We can return X as we do in the above case since OR alters no bits in X.
1334 // SimplifyDemandedBits in InstCombine can do more general optimization for
1335 // bit manipulation. This pattern aims to provide opportunities for other
1336 // optimizers by supporting a simple but common case in InstSimplify.
1337 Value *Y;
1338 const APInt *ShRAmt, *ShLAmt;
1339 if (match(Op1, m_APInt(ShRAmt)) &&
1340 match(Op0, m_c_Or(m_NUWShl(m_Value(X), m_APInt(ShLAmt)), m_Value(Y))) &&
1341 *ShRAmt == *ShLAmt) {
1342 const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1343 const unsigned Width = Op0->getType()->getScalarSizeInBits();
1344 const unsigned EffWidthY = Width - YKnown.countMinLeadingZeros();
Benjamin Kramerbae6aab2018-08-12 11:43:03 +00001345 if (ShRAmt->uge(EffWidthY))
Hiroshi Inoue02f79ea2018-08-01 04:40:32 +00001346 return X;
1347 }
1348
Craig Topper9f008862014-04-15 04:59:12 +00001349 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001350}
1351
Chris Lattner9e4aa022011-02-09 17:15:04 +00001352Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001353 const SimplifyQuery &Q) {
1354 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1355}
1356
Sanjay Patel472cc782016-01-11 22:14:42 +00001357/// Given operands for an AShr, see if we can fold the result.
1358/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001359static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001360 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001361 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1362 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001363 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001364
Sanjay Pateladf6e882018-02-18 18:05:08 +00001365 // all ones >>a X -> -1
1366 // Do not return Op0 because it may contain undef elements if it's a vector.
Duncan Sands7f60dc12011-01-14 00:37:45 +00001367 if (match(Op0, m_AllOnes()))
Sanjay Pateladf6e882018-02-18 18:05:08 +00001368 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001369
Chris Lattner9e4aa022011-02-09 17:15:04 +00001370 // (X << A) >> A -> X
1371 Value *X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001372 if (Q.IIQ.UseInstrInfo && match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001373 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001374
Suyog Sarda68862412014-07-17 06:28:15 +00001375 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001376 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001377 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1378 return Op0;
1379
Craig Topper9f008862014-04-15 04:59:12 +00001380 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001381}
1382
Chris Lattner9e4aa022011-02-09 17:15:04 +00001383Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001384 const SimplifyQuery &Q) {
1385 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1386}
1387
Craig Topper348314d2017-05-26 22:42:34 +00001388/// Commuted variants are assumed to be handled by calling this function again
1389/// with the parameters swapped.
David Majnemer1af36e52014-12-06 10:51:40 +00001390static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1391 ICmpInst *UnsignedICmp, bool IsAnd) {
1392 Value *X, *Y;
1393
1394 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001395 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1396 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001397 return nullptr;
1398
1399 ICmpInst::Predicate UnsignedPred;
1400 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1401 ICmpInst::isUnsigned(UnsignedPred))
1402 ;
1403 else if (match(UnsignedICmp,
Sanjay Patel0c57de42018-06-20 14:22:49 +00001404 m_ICmp(UnsignedPred, m_Specific(Y), m_Value(X))) &&
David Majnemer1af36e52014-12-06 10:51:40 +00001405 ICmpInst::isUnsigned(UnsignedPred))
1406 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1407 else
1408 return nullptr;
1409
1410 // X < Y && Y != 0 --> X < Y
1411 // X < Y || Y != 0 --> Y != 0
1412 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1413 return IsAnd ? UnsignedICmp : ZeroICmp;
1414
1415 // X >= Y || Y != 0 --> true
1416 // X >= Y || Y == 0 --> X >= Y
1417 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1418 if (EqPred == ICmpInst::ICMP_NE)
1419 return getTrue(UnsignedICmp->getType());
1420 return UnsignedICmp;
1421 }
1422
David Majnemerd5b3aa42014-12-08 18:30:43 +00001423 // X < Y && Y == 0 --> false
1424 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1425 IsAnd)
1426 return getFalse(UnsignedICmp->getType());
1427
David Majnemer1af36e52014-12-06 10:51:40 +00001428 return nullptr;
1429}
1430
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001431/// Commuted variants are assumed to be handled by calling this function again
1432/// with the parameters swapped.
1433static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1434 ICmpInst::Predicate Pred0, Pred1;
1435 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001436 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1437 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001438 return nullptr;
1439
1440 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1441 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1442 // can eliminate Op1 from this 'and'.
1443 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1444 return Op0;
1445
1446 // Check for any combination of predicates that are guaranteed to be disjoint.
1447 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1448 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1449 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1450 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1451 return getFalse(Op0->getType());
1452
1453 return nullptr;
1454}
1455
1456/// Commuted variants are assumed to be handled by calling this function again
1457/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001458static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1459 ICmpInst::Predicate Pred0, Pred1;
1460 Value *A ,*B;
1461 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1462 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1463 return nullptr;
1464
1465 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1466 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1467 // can eliminate Op0 from this 'or'.
1468 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1469 return Op1;
1470
1471 // Check for any combination of predicates that cover the entire range of
1472 // possibilities.
1473 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1474 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1475 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1476 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1477 return getTrue(Op0->getType());
1478
1479 return nullptr;
1480}
1481
Sanjay Patel599e65b2017-05-07 15:11:40 +00001482/// Test if a pair of compares with a shared operand and 2 constants has an
1483/// empty set intersection, full set union, or if one compare is a superset of
1484/// the other.
1485static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1486 bool IsAnd) {
1487 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1488 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1489 return nullptr;
1490
1491 const APInt *C0, *C1;
1492 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1493 !match(Cmp1->getOperand(1), m_APInt(C1)))
1494 return nullptr;
1495
1496 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1497 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1498
Sanjay Patel67454472017-05-08 16:35:02 +00001499 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001500 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1501 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1502 return getFalse(Cmp0->getType());
1503
1504 // For or-of-compares, check if the union is full:
1505 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1506 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1507 return getTrue(Cmp0->getType());
1508
1509 // Is one range a superset of the other?
1510 // If this is and-of-compares, take the smaller set:
1511 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1512 // If this is or-of-compares, take the larger set:
1513 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1514 if (Range0.contains(Range1))
1515 return IsAnd ? Cmp1 : Cmp0;
1516 if (Range1.contains(Range0))
1517 return IsAnd ? Cmp0 : Cmp1;
1518
1519 return nullptr;
1520}
1521
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001522static Value *simplifyAndOrOfICmpsWithZero(ICmpInst *Cmp0, ICmpInst *Cmp1,
1523 bool IsAnd) {
1524 ICmpInst::Predicate P0 = Cmp0->getPredicate(), P1 = Cmp1->getPredicate();
1525 if (!match(Cmp0->getOperand(1), m_Zero()) ||
1526 !match(Cmp1->getOperand(1), m_Zero()) || P0 != P1)
1527 return nullptr;
1528
1529 if ((IsAnd && P0 != ICmpInst::ICMP_NE) || (!IsAnd && P1 != ICmpInst::ICMP_EQ))
1530 return nullptr;
1531
Sanjay Patel4158eff2018-01-13 15:44:44 +00001532 // We have either "(X == 0 || Y == 0)" or "(X != 0 && Y != 0)".
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001533 Value *X = Cmp0->getOperand(0);
1534 Value *Y = Cmp1->getOperand(0);
1535
1536 // If one of the compares is a masked version of a (not) null check, then
Sanjay Patel4158eff2018-01-13 15:44:44 +00001537 // that compare implies the other, so we eliminate the other. Optionally, look
1538 // through a pointer-to-int cast to match a null check of a pointer type.
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001539
Sanjay Patel9568f422018-01-14 15:58:18 +00001540 // (X == 0) || (([ptrtoint] X & ?) == 0) --> ([ptrtoint] X & ?) == 0
1541 // (X == 0) || ((? & [ptrtoint] X) == 0) --> (? & [ptrtoint] X) == 0
1542 // (X != 0) && (([ptrtoint] X & ?) != 0) --> ([ptrtoint] X & ?) != 0
1543 // (X != 0) && ((? & [ptrtoint] X) != 0) --> (? & [ptrtoint] X) != 0
Sanjay Patel4158eff2018-01-13 15:44:44 +00001544 if (match(Y, m_c_And(m_Specific(X), m_Value())) ||
1545 match(Y, m_c_And(m_PtrToInt(m_Specific(X)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001546 return Cmp1;
1547
Sanjay Patel9568f422018-01-14 15:58:18 +00001548 // (([ptrtoint] Y & ?) == 0) || (Y == 0) --> ([ptrtoint] Y & ?) == 0
1549 // ((? & [ptrtoint] Y) == 0) || (Y == 0) --> (? & [ptrtoint] Y) == 0
1550 // (([ptrtoint] Y & ?) != 0) && (Y != 0) --> ([ptrtoint] Y & ?) != 0
1551 // ((? & [ptrtoint] Y) != 0) && (Y != 0) --> (? & [ptrtoint] Y) != 0
Sanjay Patel4158eff2018-01-13 15:44:44 +00001552 if (match(X, m_c_And(m_Specific(Y), m_Value())) ||
1553 match(X, m_c_And(m_PtrToInt(m_Specific(Y)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001554 return Cmp0;
1555
1556 return nullptr;
1557}
1558
Florian Hahn19f9e322018-08-17 14:39:04 +00001559static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1,
1560 const InstrInfoQuery &IIQ) {
Sanjay Patel599e65b2017-05-07 15:11:40 +00001561 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001562 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001563 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001564 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001565 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001566 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001567
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001568 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001569 return nullptr;
1570
Florian Hahn19f9e322018-08-17 14:39:04 +00001571 auto *AddInst = cast<OverflowingBinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001572 if (AddInst->getOperand(1) != Op1->getOperand(1))
1573 return nullptr;
1574
Craig Topper9bce1ad2017-05-26 19:04:02 +00001575 Type *ITy = Op0->getType();
Florian Hahn19f9e322018-08-17 14:39:04 +00001576 bool isNSW = IIQ.hasNoSignedWrap(AddInst);
1577 bool isNUW = IIQ.hasNoUnsignedWrap(AddInst);
David Majnemera315bd82014-09-15 08:15:28 +00001578
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001579 const APInt Delta = *C1 - *C0;
1580 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001581 if (Delta == 2) {
1582 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1583 return getFalse(ITy);
1584 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1585 return getFalse(ITy);
1586 }
1587 if (Delta == 1) {
1588 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1589 return getFalse(ITy);
1590 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1591 return getFalse(ITy);
1592 }
1593 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001594 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001595 if (Delta == 2)
1596 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1597 return getFalse(ITy);
1598 if (Delta == 1)
1599 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1600 return getFalse(ITy);
1601 }
1602
1603 return nullptr;
1604}
1605
Florian Hahn19f9e322018-08-17 14:39:04 +00001606static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1,
1607 const InstrInfoQuery &IIQ) {
Craig Topper348314d2017-05-26 22:42:34 +00001608 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1609 return X;
1610 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
Sanjay Patel142cb832017-05-04 18:19:17 +00001611 return X;
1612
Craig Topper348314d2017-05-26 22:42:34 +00001613 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1614 return X;
1615 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
Sanjay Patel142cb832017-05-04 18:19:17 +00001616 return X;
1617
Craig Topper348314d2017-05-26 22:42:34 +00001618 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
Sanjay Patel599e65b2017-05-07 15:11:40 +00001619 return X;
1620
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001621 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, true))
1622 return X;
1623
Florian Hahn19f9e322018-08-17 14:39:04 +00001624 if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001625 return X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001626 if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001627 return X;
1628
1629 return nullptr;
1630}
1631
Florian Hahn19f9e322018-08-17 14:39:04 +00001632static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1,
1633 const InstrInfoQuery &IIQ) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001634 // (icmp (add V, C0), C1) | (icmp V, C0)
1635 ICmpInst::Predicate Pred0, Pred1;
1636 const APInt *C0, *C1;
1637 Value *V;
1638 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1639 return nullptr;
1640
1641 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1642 return nullptr;
1643
1644 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1645 if (AddInst->getOperand(1) != Op1->getOperand(1))
1646 return nullptr;
1647
1648 Type *ITy = Op0->getType();
Florian Hahn19f9e322018-08-17 14:39:04 +00001649 bool isNSW = IIQ.hasNoSignedWrap(AddInst);
1650 bool isNUW = IIQ.hasNoUnsignedWrap(AddInst);
Sanjay Patel142cb832017-05-04 18:19:17 +00001651
1652 const APInt Delta = *C1 - *C0;
1653 if (C0->isStrictlyPositive()) {
1654 if (Delta == 2) {
1655 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1656 return getTrue(ITy);
1657 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1658 return getTrue(ITy);
1659 }
1660 if (Delta == 1) {
1661 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1662 return getTrue(ITy);
1663 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1664 return getTrue(ITy);
1665 }
1666 }
1667 if (C0->getBoolValue() && isNUW) {
1668 if (Delta == 2)
1669 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1670 return getTrue(ITy);
1671 if (Delta == 1)
1672 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1673 return getTrue(ITy);
1674 }
1675
1676 return nullptr;
1677}
1678
Florian Hahn19f9e322018-08-17 14:39:04 +00001679static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1,
1680 const InstrInfoQuery &IIQ) {
Craig Topper348314d2017-05-26 22:42:34 +00001681 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1682 return X;
1683 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1684 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001685
Craig Topper348314d2017-05-26 22:42:34 +00001686 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1687 return X;
1688 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1689 return X;
1690
1691 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1692 return X;
1693
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001694 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, false))
1695 return X;
1696
Florian Hahn19f9e322018-08-17 14:39:04 +00001697 if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001698 return X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001699 if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001700 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001701
1702 return nullptr;
1703}
1704
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001705static Value *simplifyAndOrOfFCmps(const TargetLibraryInfo *TLI,
1706 FCmpInst *LHS, FCmpInst *RHS, bool IsAnd) {
Sanjay Pateleb731b02017-11-19 15:34:27 +00001707 Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1708 Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1709 if (LHS0->getType() != RHS0->getType())
1710 return nullptr;
1711
1712 FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1713 if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1714 (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1715 // (fcmp ord NNAN, X) & (fcmp ord X, Y) --> fcmp ord X, Y
1716 // (fcmp ord NNAN, X) & (fcmp ord Y, X) --> fcmp ord Y, X
1717 // (fcmp ord X, NNAN) & (fcmp ord X, Y) --> fcmp ord X, Y
1718 // (fcmp ord X, NNAN) & (fcmp ord Y, X) --> fcmp ord Y, X
1719 // (fcmp uno NNAN, X) | (fcmp uno X, Y) --> fcmp uno X, Y
1720 // (fcmp uno NNAN, X) | (fcmp uno Y, X) --> fcmp uno Y, X
1721 // (fcmp uno X, NNAN) | (fcmp uno X, Y) --> fcmp uno X, Y
1722 // (fcmp uno X, NNAN) | (fcmp uno Y, X) --> fcmp uno Y, X
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001723 if ((isKnownNeverNaN(LHS0, TLI) && (LHS1 == RHS0 || LHS1 == RHS1)) ||
1724 (isKnownNeverNaN(LHS1, TLI) && (LHS0 == RHS0 || LHS0 == RHS1)))
Sanjay Pateleb731b02017-11-19 15:34:27 +00001725 return RHS;
1726
1727 // (fcmp ord X, Y) & (fcmp ord NNAN, X) --> fcmp ord X, Y
1728 // (fcmp ord Y, X) & (fcmp ord NNAN, X) --> fcmp ord Y, X
1729 // (fcmp ord X, Y) & (fcmp ord X, NNAN) --> fcmp ord X, Y
1730 // (fcmp ord Y, X) & (fcmp ord X, NNAN) --> fcmp ord Y, X
1731 // (fcmp uno X, Y) | (fcmp uno NNAN, X) --> fcmp uno X, Y
1732 // (fcmp uno Y, X) | (fcmp uno NNAN, X) --> fcmp uno Y, X
1733 // (fcmp uno X, Y) | (fcmp uno X, NNAN) --> fcmp uno X, Y
1734 // (fcmp uno Y, X) | (fcmp uno X, NNAN) --> fcmp uno Y, X
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001735 if ((isKnownNeverNaN(RHS0, TLI) && (RHS1 == LHS0 || RHS1 == LHS1)) ||
1736 (isKnownNeverNaN(RHS1, TLI) && (RHS0 == LHS0 || RHS0 == LHS1)))
Sanjay Pateleb731b02017-11-19 15:34:27 +00001737 return LHS;
1738 }
1739
1740 return nullptr;
1741}
1742
Florian Hahn19f9e322018-08-17 14:39:04 +00001743static Value *simplifyAndOrOfCmps(const SimplifyQuery &Q,
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001744 Value *Op0, Value *Op1, bool IsAnd) {
Sanjay Patele42b4d52017-05-04 19:51:34 +00001745 // Look through casts of the 'and' operands to find compares.
1746 auto *Cast0 = dyn_cast<CastInst>(Op0);
1747 auto *Cast1 = dyn_cast<CastInst>(Op1);
1748 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1749 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1750 Op0 = Cast0->getOperand(0);
1751 Op1 = Cast1->getOperand(0);
1752 }
1753
Sanjay Pateleb731b02017-11-19 15:34:27 +00001754 Value *V = nullptr;
1755 auto *ICmp0 = dyn_cast<ICmpInst>(Op0);
1756 auto *ICmp1 = dyn_cast<ICmpInst>(Op1);
1757 if (ICmp0 && ICmp1)
Florian Hahn19f9e322018-08-17 14:39:04 +00001758 V = IsAnd ? simplifyAndOfICmps(ICmp0, ICmp1, Q.IIQ)
1759 : simplifyOrOfICmps(ICmp0, ICmp1, Q.IIQ);
Sanjay Patele42b4d52017-05-04 19:51:34 +00001760
Sanjay Pateleb731b02017-11-19 15:34:27 +00001761 auto *FCmp0 = dyn_cast<FCmpInst>(Op0);
1762 auto *FCmp1 = dyn_cast<FCmpInst>(Op1);
1763 if (FCmp0 && FCmp1)
Florian Hahn19f9e322018-08-17 14:39:04 +00001764 V = simplifyAndOrOfFCmps(Q.TLI, FCmp0, FCmp1, IsAnd);
Sanjay Pateleb731b02017-11-19 15:34:27 +00001765
Craig Topper348314d2017-05-26 22:42:34 +00001766 if (!V)
1767 return nullptr;
1768 if (!Cast0)
Sanjay Patele42b4d52017-05-04 19:51:34 +00001769 return V;
Craig Topper348314d2017-05-26 22:42:34 +00001770
1771 // If we looked through casts, we can only handle a constant simplification
1772 // because we are not allowed to create a cast instruction here.
1773 if (auto *C = dyn_cast<Constant>(V))
1774 return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
Sanjay Patele42b4d52017-05-04 19:51:34 +00001775
1776 return nullptr;
1777}
1778
Sanjay Patel472cc782016-01-11 22:14:42 +00001779/// Given operands for an And, see if we can fold the result.
1780/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001781static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001782 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001783 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1784 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001785
Chris Lattnera71e9d62009-11-10 00:55:12 +00001786 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001787 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001788 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001789
Chris Lattnera71e9d62009-11-10 00:55:12 +00001790 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001791 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001792 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001793
Duncan Sandsc89ac072010-11-17 18:52:15 +00001794 // X & 0 = 0
1795 if (match(Op1, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +00001796 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001797
Duncan Sandsc89ac072010-11-17 18:52:15 +00001798 // X & -1 = X
1799 if (match(Op1, m_AllOnes()))
1800 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001801
Chris Lattnera71e9d62009-11-10 00:55:12 +00001802 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001803 if (match(Op0, m_Not(m_Specific(Op1))) ||
1804 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001805 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001806
Chris Lattnera71e9d62009-11-10 00:55:12 +00001807 // (A | ?) & A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001808 if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001809 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001810
Chris Lattnera71e9d62009-11-10 00:55:12 +00001811 // A & (A | ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001812 if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001813 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001814
Sanjay Patel877364f2017-05-16 21:51:04 +00001815 // A mask that only clears known zeros of a shifted value is a no-op.
1816 Value *X;
1817 const APInt *Mask;
1818 const APInt *ShAmt;
1819 if (match(Op1, m_APInt(Mask))) {
1820 // If all bits in the inverted and shifted mask are clear:
1821 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1822 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1823 (~(*Mask)).lshr(*ShAmt).isNullValue())
1824 return Op0;
1825
1826 // If all bits in the inverted and shifted mask are clear:
1827 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1828 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1829 (~(*Mask)).shl(*ShAmt).isNullValue())
1830 return Op0;
1831 }
1832
Duncan Sandsba286d72011-10-26 20:55:21 +00001833 // A & (-A) = A if A is a power of two or zero.
1834 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1835 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001836 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1837 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001838 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001839 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1840 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001841 return Op1;
1842 }
1843
Florian Hahn19f9e322018-08-17 14:39:04 +00001844 if (Value *V = simplifyAndOrOfCmps(Q, Op0, Op1, true))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001845 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001846
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001847 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001848 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1849 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001850 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001851
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001852 // And distributes over Or. Try some generic simplifications based on this.
1853 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001854 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001855 return V;
1856
1857 // And distributes over Xor. Try some generic simplifications based on this.
1858 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001859 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001860 return V;
1861
Duncan Sandsb0579e92010-11-10 13:00:08 +00001862 // If the operation is with the result of a select instruction, check whether
1863 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001864 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001865 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1866 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001867 return V;
1868
1869 // If the operation is with the result of a phi instruction, check whether
1870 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001871 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001872 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001873 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001874 return V;
1875
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001876 // Assuming the effective width of Y is not larger than A, i.e. all bits
1877 // from X and Y are disjoint in (X << A) | Y,
1878 // if the mask of this AND op covers all bits of X or Y, while it covers
1879 // no bits from the other, we can bypass this AND op. E.g.,
1880 // ((X << A) | Y) & Mask -> Y,
1881 // if Mask = ((1 << effective_width_of(Y)) - 1)
1882 // ((X << A) | Y) & Mask -> X << A,
1883 // if Mask = ((1 << effective_width_of(X)) - 1) << A
1884 // SimplifyDemandedBits in InstCombine can optimize the general case.
1885 // This pattern aims to help other passes for a common case.
1886 Value *Y, *XShifted;
1887 if (match(Op1, m_APInt(Mask)) &&
1888 match(Op0, m_c_Or(m_CombineAnd(m_NUWShl(m_Value(X), m_APInt(ShAmt)),
1889 m_Value(XShifted)),
1890 m_Value(Y)))) {
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001891 const unsigned Width = Op0->getType()->getScalarSizeInBits();
Benjamin Kramerbae6aab2018-08-12 11:43:03 +00001892 const unsigned ShftCnt = ShAmt->getLimitedValue(Width);
1893 const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001894 const unsigned EffWidthY = Width - YKnown.countMinLeadingZeros();
1895 if (EffWidthY <= ShftCnt) {
1896 const KnownBits XKnown = computeKnownBits(X, Q.DL, 0, Q.AC, Q.CxtI,
1897 Q.DT);
1898 const unsigned EffWidthX = Width - XKnown.countMinLeadingZeros();
1899 const APInt EffBitsY = APInt::getLowBitsSet(Width, EffWidthY);
1900 const APInt EffBitsX = APInt::getLowBitsSet(Width, EffWidthX) << ShftCnt;
1901 // If the mask is extracting all bits from X or Y as is, we can skip
1902 // this AND op.
1903 if (EffBitsY.isSubsetOf(*Mask) && !EffBitsX.intersects(*Mask))
1904 return Y;
1905 if (EffBitsX.isSubsetOf(*Mask) && !EffBitsY.intersects(*Mask))
1906 return XShifted;
1907 }
1908 }
1909
Craig Topper9f008862014-04-15 04:59:12 +00001910 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001911}
1912
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001913Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1914 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1915}
1916
Sanjay Patel472cc782016-01-11 22:14:42 +00001917/// Given operands for an Or, see if we can fold the result.
1918/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001919static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001920 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001921 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1922 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001923
Chris Lattnera71e9d62009-11-10 00:55:12 +00001924 // X | undef -> -1
Sanjay Pateladf6e882018-02-18 18:05:08 +00001925 // X | -1 = -1
1926 // Do not return Op1 because it may contain undef elements if it's a vector.
1927 if (match(Op1, m_Undef()) || match(Op1, m_AllOnes()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001928 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001929
Chris Lattnera71e9d62009-11-10 00:55:12 +00001930 // X | X = X
Duncan Sandsc89ac072010-11-17 18:52:15 +00001931 // X | 0 = X
Sanjay Pateladf6e882018-02-18 18:05:08 +00001932 if (Op0 == Op1 || match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001933 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001934
Chris Lattnera71e9d62009-11-10 00:55:12 +00001935 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001936 if (match(Op0, m_Not(m_Specific(Op1))) ||
1937 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001938 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001939
Chris Lattnera71e9d62009-11-10 00:55:12 +00001940 // (A & ?) | A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001941 if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001942 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001943
Chris Lattnera71e9d62009-11-10 00:55:12 +00001944 // A | (A & ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001945 if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001946 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001947
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001948 // ~(A & ?) | A = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001949 if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001950 return Constant::getAllOnesValue(Op1->getType());
1951
1952 // A | ~(A & ?) = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001953 if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001954 return Constant::getAllOnesValue(Op0->getType());
1955
Craig Topperdad7d8d2017-07-16 06:57:41 +00001956 Value *A, *B;
Sanjay Patel08892252017-04-24 18:24:36 +00001957 // (A & ~B) | (A ^ B) -> (A ^ B)
1958 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001959 // (A & ~B) | (B ^ A) -> (B ^ A)
1960 // (~B & A) | (B ^ A) -> (B ^ A)
1961 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1962 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1963 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001964 return Op1;
1965
1966 // Commute the 'or' operands.
1967 // (A ^ B) | (A & ~B) -> (A ^ B)
1968 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001969 // (B ^ A) | (A & ~B) -> (B ^ A)
1970 // (B ^ A) | (~B & A) -> (B ^ A)
1971 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1972 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1973 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001974 return Op0;
1975
Craig Topper479daaf2017-05-14 07:54:43 +00001976 // (A & B) | (~A ^ B) -> (~A ^ B)
1977 // (B & A) | (~A ^ B) -> (~A ^ B)
1978 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1979 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1980 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1981 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1982 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1983 return Op1;
1984
1985 // (~A ^ B) | (A & B) -> (~A ^ B)
1986 // (~A ^ B) | (B & A) -> (~A ^ B)
1987 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1988 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1989 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1990 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1991 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1992 return Op0;
1993
Florian Hahn19f9e322018-08-17 14:39:04 +00001994 if (Value *V = simplifyAndOrOfCmps(Q, Op0, Op1, false))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001995 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001996
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001997 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001998 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1999 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002000 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00002001
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00002002 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00002003 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
2004 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00002005 return V;
2006
Duncan Sandsb0579e92010-11-10 13:00:08 +00002007 // If the operation is with the result of a select instruction, check whether
2008 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00002009 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00002010 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00002011 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002012 return V;
2013
Craig Topper50500d52017-05-26 05:16:20 +00002014 // (A & C1)|(B & C2)
Craig Topper1da22c32017-05-26 19:03:53 +00002015 const APInt *C1, *C2;
2016 if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
2017 match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
2018 if (*C1 == ~*C2) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002019 // (A & C1)|(B & C2)
2020 // If we have: ((V + N) & C1) | (V & C2)
2021 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
2022 // replace with V+N.
Craig Topperc8bebb12017-05-26 19:03:59 +00002023 Value *N;
Craig Topper1da22c32017-05-26 19:03:53 +00002024 if (C2->isMask() && // C2 == 0+1+
Craig Topperc8bebb12017-05-26 19:03:59 +00002025 match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002026 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00002027 if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00002028 return A;
2029 }
2030 // Or commutes, try both ways.
Craig Topper1da22c32017-05-26 19:03:53 +00002031 if (C1->isMask() &&
Craig Topperc8bebb12017-05-26 19:03:59 +00002032 match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002033 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00002034 if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00002035 return B;
2036 }
2037 }
2038 }
2039
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002040 // If the operation is with the result of a phi instruction, check whether
2041 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00002042 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00002043 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00002044 return V;
2045
Craig Topper9f008862014-04-15 04:59:12 +00002046 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00002047}
2048
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002049Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2050 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
2051}
2052
Sanjay Patel472cc782016-01-11 22:14:42 +00002053/// Given operands for a Xor, see if we can fold the result.
2054/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002055static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00002056 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00002057 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
2058 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002059
2060 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00002061 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00002062 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002063
2064 // A ^ 0 = A
2065 if (match(Op1, m_Zero()))
2066 return Op0;
2067
Eli Friedmanad3cfe72011-08-17 19:31:49 +00002068 // A ^ A = 0
2069 if (Op0 == Op1)
2070 return Constant::getNullValue(Op0->getType());
2071
Duncan Sandsc89ac072010-11-17 18:52:15 +00002072 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00002073 if (match(Op0, m_Not(m_Specific(Op1))) ||
2074 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00002075 return Constant::getAllOnesValue(Op0->getType());
2076
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002077 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00002078 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
2079 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002080 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002081
Duncan Sandsb238de02010-11-19 09:20:39 +00002082 // Threading Xor over selects and phi nodes is pointless, so don't bother.
2083 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
2084 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
2085 // only if B and C are equal. If B and C are equal then (since we assume
2086 // that operands have already been simplified) "select(cond, B, C)" should
2087 // have been simplified to the common value of B and C already. Analysing
2088 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
2089 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00002090
Craig Topper9f008862014-04-15 04:59:12 +00002091 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002092}
2093
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002094Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2095 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2096}
2097
2098
Chris Lattner229907c2011-07-18 04:54:35 +00002099static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002100 return CmpInst::makeCmpResultType(Op->getType());
2101}
2102
Sanjay Patel472cc782016-01-11 22:14:42 +00002103/// Rummage around inside V looking for something equivalent to the comparison
2104/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2105/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002106static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2107 Value *LHS, Value *RHS) {
2108 SelectInst *SI = dyn_cast<SelectInst>(V);
2109 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002110 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002111 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2112 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002113 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002114 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2115 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2116 return Cmp;
2117 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2118 LHS == CmpRHS && RHS == CmpLHS)
2119 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002120 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002121}
2122
Dan Gohman9631d902013-02-01 00:49:06 +00002123// A significant optimization not implemented here is assuming that alloca
2124// addresses are not equal to incoming argument values. They don't *alias*,
2125// as we say, but that doesn't mean they aren't equal, so we take a
2126// conservative approach.
2127//
2128// This is inspired in part by C++11 5.10p1:
2129// "Two pointers of the same type compare equal if and only if they are both
2130// null, both point to the same function, or both represent the same
2131// address."
2132//
2133// This is pretty permissive.
2134//
2135// It's also partly due to C11 6.5.9p6:
2136// "Two pointers compare equal if and only if both are null pointers, both are
2137// pointers to the same object (including a pointer to an object and a
2138// subobject at its beginning) or function, both are pointers to one past the
2139// last element of the same array object, or one is a pointer to one past the
2140// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002141// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002142// object in the address space.)
2143//
2144// C11's version is more restrictive, however there's no reason why an argument
2145// couldn't be a one-past-the-end value for a stack object in the caller and be
2146// equal to the beginning of a stack object in the callee.
2147//
2148// If the C and C++ standards are ever made sufficiently restrictive in this
2149// area, it may be possible to update LLVM's semantics accordingly and reinstate
2150// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002151static Constant *
2152computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2153 const DominatorTree *DT, CmpInst::Predicate Pred,
Nuno Lopes404f1062017-09-09 18:23:11 +00002154 AssumptionCache *AC, const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +00002155 const InstrInfoQuery &IIQ, Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002156 // First, skip past any trivial no-ops.
2157 LHS = LHS->stripPointerCasts();
2158 RHS = RHS->stripPointerCasts();
2159
2160 // A non-null pointer is not equal to a null pointer.
Florian Hahn19f9e322018-08-17 14:39:04 +00002161 if (llvm::isKnownNonZero(LHS, DL, 0, nullptr, nullptr, nullptr,
2162 IIQ.UseInstrInfo) &&
2163 isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002164 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2165 return ConstantInt::get(GetCompareTy(LHS),
2166 !CmpInst::isTrueWhenEqual(Pred));
2167
Chandler Carruth8059c842012-03-25 21:28:14 +00002168 // We can only fold certain predicates on pointer comparisons.
2169 switch (Pred) {
2170 default:
Craig Topper9f008862014-04-15 04:59:12 +00002171 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002172
2173 // Equality comaprisons are easy to fold.
2174 case CmpInst::ICMP_EQ:
2175 case CmpInst::ICMP_NE:
2176 break;
2177
2178 // We can only handle unsigned relational comparisons because 'inbounds' on
2179 // a GEP only protects against unsigned wrapping.
2180 case CmpInst::ICMP_UGT:
2181 case CmpInst::ICMP_UGE:
2182 case CmpInst::ICMP_ULT:
2183 case CmpInst::ICMP_ULE:
2184 // However, we have to switch them to their signed variants to handle
2185 // negative indices from the base pointer.
2186 Pred = ICmpInst::getSignedPredicate(Pred);
2187 break;
2188 }
2189
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002190 // Strip off any constant offsets so that we can reason about them.
2191 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2192 // here and compare base addresses like AliasAnalysis does, however there are
2193 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2194 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2195 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002196 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2197 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002198
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002199 // If LHS and RHS are related via constant offsets to the same base
2200 // value, we can replace it with an icmp which just compares the offsets.
2201 if (LHS == RHS)
2202 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002203
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002204 // Various optimizations for (in)equality comparisons.
2205 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2206 // Different non-empty allocations that exist at the same time have
2207 // different addresses (if the program can tell). Global variables always
2208 // exist, so they always exist during the lifetime of each other and all
2209 // allocas. Two different allocas usually have different addresses...
2210 //
2211 // However, if there's an @llvm.stackrestore dynamically in between two
2212 // allocas, they may have the same address. It's tempting to reduce the
2213 // scope of the problem by only looking at *static* allocas here. That would
2214 // cover the majority of allocas while significantly reducing the likelihood
2215 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2216 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2217 // an entry block. Also, if we have a block that's not attached to a
2218 // function, we can't tell if it's "static" under the current definition.
2219 // Theoretically, this problem could be fixed by creating a new kind of
2220 // instruction kind specifically for static allocas. Such a new instruction
2221 // could be required to be at the top of the entry block, thus preventing it
2222 // from being subject to a @llvm.stackrestore. Instcombine could even
2223 // convert regular allocas into these special allocas. It'd be nifty.
2224 // However, until then, this problem remains open.
2225 //
2226 // So, we'll assume that two non-empty allocas have different addresses
2227 // for now.
2228 //
2229 // With all that, if the offsets are within the bounds of their allocations
2230 // (and not one-past-the-end! so we can't use inbounds!), and their
2231 // allocations aren't the same, the pointers are not equal.
2232 //
2233 // Note that it's not necessary to check for LHS being a global variable
2234 // address, due to canonicalization and constant folding.
2235 if (isa<AllocaInst>(LHS) &&
2236 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002237 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2238 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002239 uint64_t LHSSize, RHSSize;
Manoj Gupta77eeac32018-07-09 22:27:23 +00002240 ObjectSizeOpts Opts;
2241 Opts.NullIsUnknownSize =
2242 NullPointerIsDefined(cast<AllocaInst>(LHS)->getFunction());
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002243 if (LHSOffsetCI && RHSOffsetCI &&
Manoj Gupta77eeac32018-07-09 22:27:23 +00002244 getObjectSize(LHS, LHSSize, DL, TLI, Opts) &&
2245 getObjectSize(RHS, RHSSize, DL, TLI, Opts)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002246 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2247 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002248 if (!LHSOffsetValue.isNegative() &&
2249 !RHSOffsetValue.isNegative() &&
2250 LHSOffsetValue.ult(LHSSize) &&
2251 RHSOffsetValue.ult(RHSSize)) {
2252 return ConstantInt::get(GetCompareTy(LHS),
2253 !CmpInst::isTrueWhenEqual(Pred));
2254 }
2255 }
2256
2257 // Repeat the above check but this time without depending on DataLayout
2258 // or being able to compute a precise size.
2259 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2260 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2261 LHSOffset->isNullValue() &&
2262 RHSOffset->isNullValue())
2263 return ConstantInt::get(GetCompareTy(LHS),
2264 !CmpInst::isTrueWhenEqual(Pred));
2265 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002266
2267 // Even if an non-inbounds GEP occurs along the path we can still optimize
2268 // equality comparisons concerning the result. We avoid walking the whole
2269 // chain again by starting where the last calls to
2270 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002271 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2272 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002273 if (LHS == RHS)
2274 return ConstantExpr::getICmp(Pred,
2275 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2276 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002277
2278 // If one side of the equality comparison must come from a noalias call
2279 // (meaning a system memory allocation function), and the other side must
2280 // come from a pointer that cannot overlap with dynamically-allocated
2281 // memory within the lifetime of the current function (allocas, byval
2282 // arguments, globals), then determine the comparison result here.
2283 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2284 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2285 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2286
2287 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002288 auto IsNAC = [](ArrayRef<Value *> Objects) {
2289 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002290 };
2291
2292 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002293 // noalias calls. For allocas, we consider only static ones (dynamic
2294 // allocas might be transformed into calls to malloc not simultaneously
2295 // live with the compared-to allocation). For globals, we exclude symbols
2296 // that might be resolve lazily to symbols in another dynamically-loaded
2297 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002298 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2299 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002300 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2301 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2302 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2303 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002304 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002305 !GV->isThreadLocal();
2306 if (const Argument *A = dyn_cast<Argument>(V))
2307 return A->hasByValAttr();
2308 return false;
2309 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002310 };
2311
2312 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2313 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2314 return ConstantInt::get(GetCompareTy(LHS),
2315 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002316
2317 // Fold comparisons for non-escaping pointer even if the allocation call
2318 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2319 // dynamic allocation call could be either of the operands.
2320 Value *MI = nullptr;
Nuno Lopes404f1062017-09-09 18:23:11 +00002321 if (isAllocLikeFn(LHS, TLI) &&
2322 llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002323 MI = LHS;
Nuno Lopes404f1062017-09-09 18:23:11 +00002324 else if (isAllocLikeFn(RHS, TLI) &&
2325 llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002326 MI = RHS;
2327 // FIXME: We should also fold the compare when the pointer escapes, but the
2328 // compare dominates the pointer escape
2329 if (MI && !PointerMayBeCaptured(MI, true, true))
2330 return ConstantInt::get(GetCompareTy(LHS),
2331 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002332 }
2333
2334 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002335 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002336}
Chris Lattner01990f02012-02-24 19:01:58 +00002337
Sanjay Pateldc65a272016-12-03 17:30:22 +00002338/// Fold an icmp when its operands have i1 scalar type.
2339static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002340 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002341 Type *ITy = GetCompareTy(LHS); // The return type.
2342 Type *OpTy = LHS->getType(); // The operand type.
Craig Topperfde47232017-07-09 07:04:03 +00002343 if (!OpTy->isIntOrIntVectorTy(1))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002344 return nullptr;
2345
Sanjay Patele2787b92017-05-17 20:27:55 +00002346 // A boolean compared to true/false can be simplified in 14 out of the 20
2347 // (10 predicates * 2 constants) possible combinations. Cases not handled here
2348 // require a 'not' of the LHS, so those must be transformed in InstCombine.
2349 if (match(RHS, m_Zero())) {
2350 switch (Pred) {
2351 case CmpInst::ICMP_NE: // X != 0 -> X
2352 case CmpInst::ICMP_UGT: // X >u 0 -> X
2353 case CmpInst::ICMP_SLT: // X <s 0 -> X
2354 return LHS;
2355
2356 case CmpInst::ICMP_ULT: // X <u 0 -> false
2357 case CmpInst::ICMP_SGT: // X >s 0 -> false
2358 return getFalse(ITy);
2359
2360 case CmpInst::ICMP_UGE: // X >=u 0 -> true
2361 case CmpInst::ICMP_SLE: // X <=s 0 -> true
2362 return getTrue(ITy);
2363
2364 default: break;
2365 }
2366 } else if (match(RHS, m_One())) {
2367 switch (Pred) {
2368 case CmpInst::ICMP_EQ: // X == 1 -> X
2369 case CmpInst::ICMP_UGE: // X >=u 1 -> X
2370 case CmpInst::ICMP_SLE: // X <=s -1 -> X
2371 return LHS;
2372
2373 case CmpInst::ICMP_UGT: // X >u 1 -> false
2374 case CmpInst::ICMP_SLT: // X <s -1 -> false
2375 return getFalse(ITy);
2376
2377 case CmpInst::ICMP_ULE: // X <=u 1 -> true
2378 case CmpInst::ICMP_SGE: // X >=s -1 -> true
2379 return getTrue(ITy);
2380
2381 default: break;
2382 }
2383 }
2384
Sanjay Pateldc65a272016-12-03 17:30:22 +00002385 switch (Pred) {
2386 default:
2387 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002388 case ICmpInst::ICMP_UGE:
Sanjay Pateldc65a272016-12-03 17:30:22 +00002389 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2390 return getTrue(ITy);
2391 break;
2392 case ICmpInst::ICMP_SGE:
2393 /// For signed comparison, the values for an i1 are 0 and -1
2394 /// respectively. This maps into a truth table of:
2395 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2396 /// 0 | 0 | 1 (0 >= 0) | 1
2397 /// 0 | 1 | 1 (0 >= -1) | 1
2398 /// 1 | 0 | 0 (-1 >= 0) | 0
2399 /// 1 | 1 | 1 (-1 >= -1) | 1
2400 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2401 return getTrue(ITy);
2402 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002403 case ICmpInst::ICMP_ULE:
2404 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2405 return getTrue(ITy);
2406 break;
2407 }
2408
2409 return nullptr;
2410}
2411
2412/// Try hard to fold icmp with zero RHS because this is a common case.
2413static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002414 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002415 if (!match(RHS, m_Zero()))
2416 return nullptr;
2417
2418 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002419 switch (Pred) {
2420 default:
2421 llvm_unreachable("Unknown ICmp predicate!");
2422 case ICmpInst::ICMP_ULT:
2423 return getFalse(ITy);
2424 case ICmpInst::ICMP_UGE:
2425 return getTrue(ITy);
2426 case ICmpInst::ICMP_EQ:
2427 case ICmpInst::ICMP_ULE:
Florian Hahn19f9e322018-08-17 14:39:04 +00002428 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002429 return getFalse(ITy);
2430 break;
2431 case ICmpInst::ICMP_NE:
2432 case ICmpInst::ICMP_UGT:
Florian Hahn19f9e322018-08-17 14:39:04 +00002433 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002434 return getTrue(ITy);
2435 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002436 case ICmpInst::ICMP_SLT: {
2437 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2438 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002439 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002440 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002441 return getFalse(ITy);
2442 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002443 }
2444 case ICmpInst::ICMP_SLE: {
2445 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2446 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002447 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002448 if (LHSKnown.isNonNegative() &&
2449 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002450 return getFalse(ITy);
2451 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002452 }
2453 case ICmpInst::ICMP_SGE: {
2454 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2455 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002456 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002457 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002458 return getTrue(ITy);
2459 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002460 }
2461 case ICmpInst::ICMP_SGT: {
2462 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2463 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002464 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002465 if (LHSKnown.isNonNegative() &&
2466 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002467 return getTrue(ITy);
2468 break;
2469 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002470 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002471
2472 return nullptr;
2473}
2474
Sanjay Patelbe332132017-01-23 18:22:26 +00002475/// Many binary operators with a constant operand have an easy-to-compute
2476/// range of outputs. This can be used to fold a comparison to always true or
2477/// always false.
Florian Hahn19f9e322018-08-17 14:39:04 +00002478static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper,
2479 const InstrInfoQuery &IIQ) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002480 unsigned Width = Lower.getBitWidth();
2481 const APInt *C;
2482 switch (BO.getOpcode()) {
2483 case Instruction::Add:
Craig Topper73ba1c82017-06-07 07:40:37 +00002484 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patel56227252017-01-24 17:03:24 +00002485 // FIXME: If we have both nuw and nsw, we should reduce the range further.
Florian Hahn19f9e322018-08-17 14:39:04 +00002486 if (IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(&BO))) {
Sanjay Patel56227252017-01-24 17:03:24 +00002487 // 'add nuw x, C' produces [C, UINT_MAX].
2488 Lower = *C;
Florian Hahn19f9e322018-08-17 14:39:04 +00002489 } else if (IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(&BO))) {
Sanjay Patel56227252017-01-24 17:03:24 +00002490 if (C->isNegative()) {
2491 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2492 Lower = APInt::getSignedMinValue(Width);
2493 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2494 } else {
2495 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2496 Lower = APInt::getSignedMinValue(Width) + *C;
2497 Upper = APInt::getSignedMaxValue(Width) + 1;
2498 }
2499 }
2500 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002501 break;
2502
2503 case Instruction::And:
2504 if (match(BO.getOperand(1), m_APInt(C)))
2505 // 'and x, C' produces [0, C].
2506 Upper = *C + 1;
2507 break;
2508
2509 case Instruction::Or:
2510 if (match(BO.getOperand(1), m_APInt(C)))
2511 // 'or x, C' produces [C, UINT_MAX].
2512 Lower = *C;
2513 break;
2514
2515 case Instruction::AShr:
2516 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2517 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2518 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2519 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2520 } else if (match(BO.getOperand(0), m_APInt(C))) {
2521 unsigned ShiftAmount = Width - 1;
Florian Hahn19f9e322018-08-17 14:39:04 +00002522 if (!C->isNullValue() && IIQ.isExact(&BO))
Sanjay Patelbe332132017-01-23 18:22:26 +00002523 ShiftAmount = C->countTrailingZeros();
2524 if (C->isNegative()) {
2525 // 'ashr C, x' produces [C, C >> (Width-1)]
2526 Lower = *C;
2527 Upper = C->ashr(ShiftAmount) + 1;
2528 } else {
2529 // 'ashr C, x' produces [C >> (Width-1), C]
2530 Lower = C->ashr(ShiftAmount);
2531 Upper = *C + 1;
2532 }
2533 }
2534 break;
2535
2536 case Instruction::LShr:
2537 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2538 // 'lshr x, C' produces [0, UINT_MAX >> C].
2539 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2540 } else if (match(BO.getOperand(0), m_APInt(C))) {
2541 // 'lshr C, x' produces [C >> (Width-1), C].
2542 unsigned ShiftAmount = Width - 1;
Florian Hahn19f9e322018-08-17 14:39:04 +00002543 if (!C->isNullValue() && IIQ.isExact(&BO))
Sanjay Patelbe332132017-01-23 18:22:26 +00002544 ShiftAmount = C->countTrailingZeros();
2545 Lower = C->lshr(ShiftAmount);
2546 Upper = *C + 1;
2547 }
2548 break;
2549
2550 case Instruction::Shl:
2551 if (match(BO.getOperand(0), m_APInt(C))) {
Florian Hahn19f9e322018-08-17 14:39:04 +00002552 if (IIQ.hasNoUnsignedWrap(&BO)) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002553 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2554 Lower = *C;
2555 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2556 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2557 if (C->isNegative()) {
2558 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2559 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2560 Lower = C->shl(ShiftAmount);
2561 Upper = *C + 1;
2562 } else {
2563 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2564 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2565 Lower = *C;
2566 Upper = C->shl(ShiftAmount) + 1;
2567 }
2568 }
2569 }
2570 break;
2571
2572 case Instruction::SDiv:
2573 if (match(BO.getOperand(1), m_APInt(C))) {
2574 APInt IntMin = APInt::getSignedMinValue(Width);
2575 APInt IntMax = APInt::getSignedMaxValue(Width);
2576 if (C->isAllOnesValue()) {
2577 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2578 // where C != -1 and C != 0 and C != 1
2579 Lower = IntMin + 1;
2580 Upper = IntMax + 1;
2581 } else if (C->countLeadingZeros() < Width - 1) {
2582 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2583 // where C != -1 and C != 0 and C != 1
2584 Lower = IntMin.sdiv(*C);
2585 Upper = IntMax.sdiv(*C);
2586 if (Lower.sgt(Upper))
2587 std::swap(Lower, Upper);
2588 Upper = Upper + 1;
2589 assert(Upper != Lower && "Upper part of range has wrapped!");
2590 }
2591 } else if (match(BO.getOperand(0), m_APInt(C))) {
2592 if (C->isMinSignedValue()) {
2593 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2594 Lower = *C;
2595 Upper = Lower.lshr(1) + 1;
2596 } else {
2597 // 'sdiv C, x' produces [-|C|, |C|].
2598 Upper = C->abs() + 1;
2599 Lower = (-Upper) + 1;
2600 }
2601 }
2602 break;
2603
2604 case Instruction::UDiv:
Craig Topper73ba1c82017-06-07 07:40:37 +00002605 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002606 // 'udiv x, C' produces [0, UINT_MAX / C].
2607 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2608 } else if (match(BO.getOperand(0), m_APInt(C))) {
2609 // 'udiv C, x' produces [0, C].
2610 Upper = *C + 1;
2611 }
2612 break;
2613
2614 case Instruction::SRem:
2615 if (match(BO.getOperand(1), m_APInt(C))) {
2616 // 'srem x, C' produces (-|C|, |C|).
2617 Upper = C->abs();
2618 Lower = (-Upper) + 1;
2619 }
2620 break;
2621
2622 case Instruction::URem:
2623 if (match(BO.getOperand(1), m_APInt(C)))
2624 // 'urem x, C' produces [0, C).
2625 Upper = *C;
2626 break;
2627
2628 default:
2629 break;
2630 }
2631}
2632
Sanjay Patel67bde282016-08-22 23:12:02 +00002633static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
Florian Hahn19f9e322018-08-17 14:39:04 +00002634 Value *RHS, const InstrInfoQuery &IIQ) {
Roman Lebedev0c43d722018-03-15 16:17:40 +00002635 Type *ITy = GetCompareTy(RHS); // The return type.
2636
Roman Lebedev6aca3352018-03-15 16:17:46 +00002637 Value *X;
2638 // Sign-bit checks can be optimized to true/false after unsigned
2639 // floating-point casts:
2640 // icmp slt (bitcast (uitofp X)), 0 --> false
2641 // icmp sgt (bitcast (uitofp X)), -1 --> true
2642 if (match(LHS, m_BitCast(m_UIToFP(m_Value(X))))) {
2643 if (Pred == ICmpInst::ICMP_SLT && match(RHS, m_Zero()))
2644 return ConstantInt::getFalse(ITy);
2645 if (Pred == ICmpInst::ICMP_SGT && match(RHS, m_AllOnes()))
2646 return ConstantInt::getTrue(ITy);
2647 }
2648
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002649 const APInt *C;
2650 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002651 return nullptr;
2652
2653 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002654 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002655 if (RHS_CR.isEmptySet())
Roman Lebedev0c43d722018-03-15 16:17:40 +00002656 return ConstantInt::getFalse(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002657 if (RHS_CR.isFullSet())
Roman Lebedev0c43d722018-03-15 16:17:40 +00002658 return ConstantInt::getTrue(ITy);
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002659
Sanjay Patelbe332132017-01-23 18:22:26 +00002660 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002661 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002662 APInt Lower = APInt(Width, 0);
2663 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002664 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
Florian Hahn19f9e322018-08-17 14:39:04 +00002665 setLimitsForBinOp(*BO, Lower, Upper, IIQ);
Sanjay Patel67bde282016-08-22 23:12:02 +00002666
2667 ConstantRange LHS_CR =
2668 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2669
2670 if (auto *I = dyn_cast<Instruction>(LHS))
Florian Hahn19f9e322018-08-17 14:39:04 +00002671 if (auto *Ranges = IIQ.getMetadata(I, LLVMContext::MD_range))
Sanjay Patel67bde282016-08-22 23:12:02 +00002672 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2673
2674 if (!LHS_CR.isFullSet()) {
2675 if (RHS_CR.contains(LHS_CR))
Roman Lebedev0c43d722018-03-15 16:17:40 +00002676 return ConstantInt::getTrue(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002677 if (RHS_CR.inverse().contains(LHS_CR))
Roman Lebedev0c43d722018-03-15 16:17:40 +00002678 return ConstantInt::getFalse(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002679 }
2680
2681 return nullptr;
2682}
2683
Sanjay Patel2df38a82017-05-08 16:21:55 +00002684/// TODO: A large part of this logic is duplicated in InstCombine's
2685/// foldICmpBinOp(). We should be able to share that and avoid the code
2686/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002687static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002688 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002689 unsigned MaxRecurse) {
2690 Type *ITy = GetCompareTy(LHS); // The return type.
2691
2692 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2693 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2694 if (MaxRecurse && (LBO || RBO)) {
2695 // Analyze the case when either LHS or RHS is an add instruction.
2696 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2697 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2698 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2699 if (LBO && LBO->getOpcode() == Instruction::Add) {
2700 A = LBO->getOperand(0);
2701 B = LBO->getOperand(1);
2702 NoLHSWrapProblem =
2703 ICmpInst::isEquality(Pred) ||
Florian Hahn19f9e322018-08-17 14:39:04 +00002704 (CmpInst::isUnsigned(Pred) &&
2705 Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(LBO))) ||
2706 (CmpInst::isSigned(Pred) &&
2707 Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(LBO)));
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002708 }
2709 if (RBO && RBO->getOpcode() == Instruction::Add) {
2710 C = RBO->getOperand(0);
2711 D = RBO->getOperand(1);
2712 NoRHSWrapProblem =
2713 ICmpInst::isEquality(Pred) ||
Florian Hahn19f9e322018-08-17 14:39:04 +00002714 (CmpInst::isUnsigned(Pred) &&
2715 Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(RBO))) ||
2716 (CmpInst::isSigned(Pred) &&
2717 Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(RBO)));
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002718 }
2719
2720 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2721 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2722 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2723 Constant::getNullValue(RHS->getType()), Q,
2724 MaxRecurse - 1))
2725 return V;
2726
2727 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2728 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2729 if (Value *V =
2730 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2731 C == LHS ? D : C, Q, MaxRecurse - 1))
2732 return V;
2733
2734 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2735 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2736 NoRHSWrapProblem) {
2737 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2738 Value *Y, *Z;
2739 if (A == C) {
2740 // C + B == C + D -> B == D
2741 Y = B;
2742 Z = D;
2743 } else if (A == D) {
2744 // D + B == C + D -> B == C
2745 Y = B;
2746 Z = C;
2747 } else if (B == C) {
2748 // A + C == C + D -> A == D
2749 Y = A;
2750 Z = D;
2751 } else {
2752 assert(B == D);
2753 // A + D == C + D -> A == C
2754 Y = A;
2755 Z = C;
2756 }
2757 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2758 return V;
2759 }
2760 }
2761
2762 {
2763 Value *Y = nullptr;
2764 // icmp pred (or X, Y), X
2765 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2766 if (Pred == ICmpInst::ICMP_ULT)
2767 return getFalse(ITy);
2768 if (Pred == ICmpInst::ICMP_UGE)
2769 return getTrue(ITy);
2770
2771 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002772 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2773 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2774 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002775 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002776 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002777 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2778 }
2779 }
2780 // icmp pred X, (or X, Y)
2781 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2782 if (Pred == ICmpInst::ICMP_ULE)
2783 return getTrue(ITy);
2784 if (Pred == ICmpInst::ICMP_UGT)
2785 return getFalse(ITy);
2786
2787 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002788 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2789 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2790 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002791 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002792 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002793 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2794 }
2795 }
2796 }
2797
2798 // icmp pred (and X, Y), X
Craig Topper72ee6942017-06-24 06:24:01 +00002799 if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002800 if (Pred == ICmpInst::ICMP_UGT)
2801 return getFalse(ITy);
2802 if (Pred == ICmpInst::ICMP_ULE)
2803 return getTrue(ITy);
2804 }
2805 // icmp pred X, (and X, Y)
Craig Topper72ee6942017-06-24 06:24:01 +00002806 if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002807 if (Pred == ICmpInst::ICMP_UGE)
2808 return getTrue(ITy);
2809 if (Pred == ICmpInst::ICMP_ULT)
2810 return getFalse(ITy);
2811 }
2812
2813 // 0 - (zext X) pred C
2814 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2815 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2816 if (RHSC->getValue().isStrictlyPositive()) {
2817 if (Pred == ICmpInst::ICMP_SLT)
2818 return ConstantInt::getTrue(RHSC->getContext());
2819 if (Pred == ICmpInst::ICMP_SGE)
2820 return ConstantInt::getFalse(RHSC->getContext());
2821 if (Pred == ICmpInst::ICMP_EQ)
2822 return ConstantInt::getFalse(RHSC->getContext());
2823 if (Pred == ICmpInst::ICMP_NE)
2824 return ConstantInt::getTrue(RHSC->getContext());
2825 }
2826 if (RHSC->getValue().isNonNegative()) {
2827 if (Pred == ICmpInst::ICMP_SLE)
2828 return ConstantInt::getTrue(RHSC->getContext());
2829 if (Pred == ICmpInst::ICMP_SGT)
2830 return ConstantInt::getFalse(RHSC->getContext());
2831 }
2832 }
2833 }
2834
2835 // icmp pred (urem X, Y), Y
2836 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002837 switch (Pred) {
2838 default:
2839 break;
2840 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002841 case ICmpInst::ICMP_SGE: {
2842 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2843 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002844 break;
2845 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002846 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002847 case ICmpInst::ICMP_EQ:
2848 case ICmpInst::ICMP_UGT:
2849 case ICmpInst::ICMP_UGE:
2850 return getFalse(ITy);
2851 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002852 case ICmpInst::ICMP_SLE: {
2853 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2854 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002855 break;
2856 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002857 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002858 case ICmpInst::ICMP_NE:
2859 case ICmpInst::ICMP_ULT:
2860 case ICmpInst::ICMP_ULE:
2861 return getTrue(ITy);
2862 }
2863 }
2864
2865 // icmp pred X, (urem Y, X)
2866 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002867 switch (Pred) {
2868 default:
2869 break;
2870 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002871 case ICmpInst::ICMP_SGE: {
2872 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2873 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002874 break;
2875 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002876 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002877 case ICmpInst::ICMP_NE:
2878 case ICmpInst::ICMP_UGT:
2879 case ICmpInst::ICMP_UGE:
2880 return getTrue(ITy);
2881 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002882 case ICmpInst::ICMP_SLE: {
2883 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2884 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002885 break;
2886 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002887 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002888 case ICmpInst::ICMP_EQ:
2889 case ICmpInst::ICMP_ULT:
2890 case ICmpInst::ICMP_ULE:
2891 return getFalse(ITy);
2892 }
2893 }
2894
2895 // x >> y <=u x
2896 // x udiv y <=u x.
2897 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2898 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2899 // icmp pred (X op Y), X
2900 if (Pred == ICmpInst::ICMP_UGT)
2901 return getFalse(ITy);
2902 if (Pred == ICmpInst::ICMP_ULE)
2903 return getTrue(ITy);
2904 }
2905
2906 // x >=u x >> y
2907 // x >=u x udiv y.
2908 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2909 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2910 // icmp pred X, (X op Y)
2911 if (Pred == ICmpInst::ICMP_ULT)
2912 return getFalse(ITy);
2913 if (Pred == ICmpInst::ICMP_UGE)
2914 return getTrue(ITy);
2915 }
2916
2917 // handle:
2918 // CI2 << X == CI
2919 // CI2 << X != CI
2920 //
2921 // where CI2 is a power of 2 and CI isn't
2922 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2923 const APInt *CI2Val, *CIVal = &CI->getValue();
2924 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2925 CI2Val->isPowerOf2()) {
2926 if (!CIVal->isPowerOf2()) {
2927 // CI2 << X can equal zero in some circumstances,
2928 // this simplification is unsafe if CI is zero.
2929 //
2930 // We know it is safe if:
2931 // - The shift is nsw, we can't shift out the one bit.
2932 // - The shift is nuw, we can't shift out the one bit.
2933 // - CI2 is one
2934 // - CI isn't zero
Florian Hahn19f9e322018-08-17 14:39:04 +00002935 if (Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(LBO)) ||
2936 Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(LBO)) ||
Craig Topper73ba1c82017-06-07 07:40:37 +00002937 CI2Val->isOneValue() || !CI->isZero()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002938 if (Pred == ICmpInst::ICMP_EQ)
2939 return ConstantInt::getFalse(RHS->getContext());
2940 if (Pred == ICmpInst::ICMP_NE)
2941 return ConstantInt::getTrue(RHS->getContext());
2942 }
2943 }
Craig Topper73ba1c82017-06-07 07:40:37 +00002944 if (CIVal->isSignMask() && CI2Val->isOneValue()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002945 if (Pred == ICmpInst::ICMP_UGT)
2946 return ConstantInt::getFalse(RHS->getContext());
2947 if (Pred == ICmpInst::ICMP_ULE)
2948 return ConstantInt::getTrue(RHS->getContext());
2949 }
2950 }
2951 }
2952
2953 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2954 LBO->getOperand(1) == RBO->getOperand(1)) {
2955 switch (LBO->getOpcode()) {
2956 default:
2957 break;
2958 case Instruction::UDiv:
2959 case Instruction::LShr:
Florian Hahn19f9e322018-08-17 14:39:04 +00002960 if (ICmpInst::isSigned(Pred) || !Q.IIQ.isExact(LBO) ||
2961 !Q.IIQ.isExact(RBO))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002962 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00002963 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2964 RBO->getOperand(0), Q, MaxRecurse - 1))
2965 return V;
2966 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002967 case Instruction::SDiv:
Florian Hahn19f9e322018-08-17 14:39:04 +00002968 if (!ICmpInst::isEquality(Pred) || !Q.IIQ.isExact(LBO) ||
2969 !Q.IIQ.isExact(RBO))
Sanjay Patela23b1412017-05-15 19:16:49 +00002970 break;
2971 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2972 RBO->getOperand(0), Q, MaxRecurse - 1))
2973 return V;
2974 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002975 case Instruction::AShr:
Florian Hahn19f9e322018-08-17 14:39:04 +00002976 if (!Q.IIQ.isExact(LBO) || !Q.IIQ.isExact(RBO))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002977 break;
2978 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2979 RBO->getOperand(0), Q, MaxRecurse - 1))
2980 return V;
2981 break;
2982 case Instruction::Shl: {
Florian Hahn19f9e322018-08-17 14:39:04 +00002983 bool NUW = Q.IIQ.hasNoUnsignedWrap(LBO) && Q.IIQ.hasNoUnsignedWrap(RBO);
2984 bool NSW = Q.IIQ.hasNoSignedWrap(LBO) && Q.IIQ.hasNoSignedWrap(RBO);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002985 if (!NUW && !NSW)
2986 break;
2987 if (!NSW && ICmpInst::isSigned(Pred))
2988 break;
2989 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2990 RBO->getOperand(0), Q, MaxRecurse - 1))
2991 return V;
2992 break;
2993 }
2994 }
2995 }
2996 return nullptr;
2997}
2998
Sanjay Patel35289c62016-12-10 17:40:47 +00002999/// Simplify integer comparisons where at least one operand of the compare
3000/// matches an integer min/max idiom.
3001static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003002 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00003003 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003004 Type *ITy = GetCompareTy(LHS); // The return type.
3005 Value *A, *B;
3006 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
3007 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
3008
3009 // Signed variants on "max(a,b)>=a -> true".
3010 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3011 if (A != RHS)
3012 std::swap(A, B); // smax(A, B) pred A.
3013 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3014 // We analyze this as smax(A, B) pred A.
3015 P = Pred;
3016 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
3017 (A == LHS || B == LHS)) {
3018 if (A != LHS)
3019 std::swap(A, B); // A pred smax(A, B).
3020 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3021 // We analyze this as smax(A, B) swapped-pred A.
3022 P = CmpInst::getSwappedPredicate(Pred);
3023 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3024 (A == RHS || B == RHS)) {
3025 if (A != RHS)
3026 std::swap(A, B); // smin(A, B) pred A.
3027 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3028 // We analyze this as smax(-A, -B) swapped-pred -A.
3029 // Note that we do not need to actually form -A or -B thanks to EqP.
3030 P = CmpInst::getSwappedPredicate(Pred);
3031 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
3032 (A == LHS || B == LHS)) {
3033 if (A != LHS)
3034 std::swap(A, B); // A pred smin(A, B).
3035 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3036 // We analyze this as smax(-A, -B) pred -A.
3037 // Note that we do not need to actually form -A or -B thanks to EqP.
3038 P = Pred;
3039 }
3040 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3041 // Cases correspond to "max(A, B) p A".
3042 switch (P) {
3043 default:
3044 break;
3045 case CmpInst::ICMP_EQ:
3046 case CmpInst::ICMP_SLE:
3047 // Equivalent to "A EqP B". This may be the same as the condition tested
3048 // in the max/min; if so, we can just return that.
3049 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3050 return V;
3051 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3052 return V;
3053 // Otherwise, see if "A EqP B" simplifies.
3054 if (MaxRecurse)
3055 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3056 return V;
3057 break;
3058 case CmpInst::ICMP_NE:
3059 case CmpInst::ICMP_SGT: {
3060 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3061 // Equivalent to "A InvEqP B". This may be the same as the condition
3062 // tested in the max/min; if so, we can just return that.
3063 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3064 return V;
3065 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3066 return V;
3067 // Otherwise, see if "A InvEqP B" simplifies.
3068 if (MaxRecurse)
3069 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3070 return V;
3071 break;
3072 }
3073 case CmpInst::ICMP_SGE:
3074 // Always true.
3075 return getTrue(ITy);
3076 case CmpInst::ICMP_SLT:
3077 // Always false.
3078 return getFalse(ITy);
3079 }
3080 }
3081
3082 // Unsigned variants on "max(a,b)>=a -> true".
3083 P = CmpInst::BAD_ICMP_PREDICATE;
3084 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3085 if (A != RHS)
3086 std::swap(A, B); // umax(A, B) pred A.
3087 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3088 // We analyze this as umax(A, B) pred A.
3089 P = Pred;
3090 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
3091 (A == LHS || B == LHS)) {
3092 if (A != LHS)
3093 std::swap(A, B); // A pred umax(A, B).
3094 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3095 // We analyze this as umax(A, B) swapped-pred A.
3096 P = CmpInst::getSwappedPredicate(Pred);
3097 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3098 (A == RHS || B == RHS)) {
3099 if (A != RHS)
3100 std::swap(A, B); // umin(A, B) pred A.
3101 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3102 // We analyze this as umax(-A, -B) swapped-pred -A.
3103 // Note that we do not need to actually form -A or -B thanks to EqP.
3104 P = CmpInst::getSwappedPredicate(Pred);
3105 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
3106 (A == LHS || B == LHS)) {
3107 if (A != LHS)
3108 std::swap(A, B); // A pred umin(A, B).
3109 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3110 // We analyze this as umax(-A, -B) pred -A.
3111 // Note that we do not need to actually form -A or -B thanks to EqP.
3112 P = Pred;
3113 }
3114 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3115 // Cases correspond to "max(A, B) p A".
3116 switch (P) {
3117 default:
3118 break;
3119 case CmpInst::ICMP_EQ:
3120 case CmpInst::ICMP_ULE:
3121 // Equivalent to "A EqP B". This may be the same as the condition tested
3122 // in the max/min; if so, we can just return that.
3123 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3124 return V;
3125 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3126 return V;
3127 // Otherwise, see if "A EqP B" simplifies.
3128 if (MaxRecurse)
3129 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3130 return V;
3131 break;
3132 case CmpInst::ICMP_NE:
3133 case CmpInst::ICMP_UGT: {
3134 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3135 // Equivalent to "A InvEqP B". This may be the same as the condition
3136 // tested in the max/min; if so, we can just return that.
3137 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3138 return V;
3139 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3140 return V;
3141 // Otherwise, see if "A InvEqP B" simplifies.
3142 if (MaxRecurse)
3143 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3144 return V;
3145 break;
3146 }
3147 case CmpInst::ICMP_UGE:
3148 // Always true.
3149 return getTrue(ITy);
3150 case CmpInst::ICMP_ULT:
3151 // Always false.
3152 return getFalse(ITy);
3153 }
3154 }
3155
3156 // Variants on "max(x,y) >= min(x,z)".
3157 Value *C, *D;
3158 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3159 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3160 (A == C || A == D || B == C || B == D)) {
3161 // max(x, ?) pred min(x, ?).
3162 if (Pred == CmpInst::ICMP_SGE)
3163 // Always true.
3164 return getTrue(ITy);
3165 if (Pred == CmpInst::ICMP_SLT)
3166 // Always false.
3167 return getFalse(ITy);
3168 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3169 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3170 (A == C || A == D || B == C || B == D)) {
3171 // min(x, ?) pred max(x, ?).
3172 if (Pred == CmpInst::ICMP_SLE)
3173 // Always true.
3174 return getTrue(ITy);
3175 if (Pred == CmpInst::ICMP_SGT)
3176 // Always false.
3177 return getFalse(ITy);
3178 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3179 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3180 (A == C || A == D || B == C || B == D)) {
3181 // max(x, ?) pred min(x, ?).
3182 if (Pred == CmpInst::ICMP_UGE)
3183 // Always true.
3184 return getTrue(ITy);
3185 if (Pred == CmpInst::ICMP_ULT)
3186 // Always false.
3187 return getFalse(ITy);
3188 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3189 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3190 (A == C || A == D || B == C || B == D)) {
3191 // min(x, ?) pred max(x, ?).
3192 if (Pred == CmpInst::ICMP_ULE)
3193 // Always true.
3194 return getTrue(ITy);
3195 if (Pred == CmpInst::ICMP_UGT)
3196 // Always false.
3197 return getFalse(ITy);
3198 }
3199
3200 return nullptr;
3201}
3202
Sanjay Patel472cc782016-01-11 22:14:42 +00003203/// Given operands for an ICmpInst, see if we can fold the result.
3204/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003205static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003206 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003207 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003208 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003209
Chris Lattnera71e9d62009-11-10 00:55:12 +00003210 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003211 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003212 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003213
3214 // If we have a constant, make sure it is on the RHS.
3215 std::swap(LHS, RHS);
3216 Pred = CmpInst::getSwappedPredicate(Pred);
3217 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003218
Chris Lattner229907c2011-07-18 04:54:35 +00003219 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003220
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003221 // icmp X, X -> true/false
Sanjay Patel30be6652018-04-22 17:07:44 +00003222 // icmp X, undef -> true/false because undef could be X.
Duncan Sands772749a2011-01-01 20:08:02 +00003223 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003224 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003225
Sanjay Pateldc65a272016-12-03 17:30:22 +00003226 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3227 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003228
Sanjay Pateldc65a272016-12-03 17:30:22 +00003229 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3230 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003231
Florian Hahn19f9e322018-08-17 14:39:04 +00003232 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS, Q.IIQ))
Sanjay Patel67bde282016-08-22 23:12:02 +00003233 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003234
Chen Li7452d952015-09-26 03:26:47 +00003235 // If both operands have range metadata, use the metadata
3236 // to simplify the comparison.
3237 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003238 auto RHS_Instr = cast<Instruction>(RHS);
3239 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003240
Florian Hahn19f9e322018-08-17 14:39:04 +00003241 if (Q.IIQ.getMetadata(RHS_Instr, LLVMContext::MD_range) &&
3242 Q.IIQ.getMetadata(LHS_Instr, LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003243 auto RHS_CR = getConstantRangeFromMetadata(
3244 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3245 auto LHS_CR = getConstantRangeFromMetadata(
3246 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003247
3248 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3249 if (Satisfied_CR.contains(LHS_CR))
3250 return ConstantInt::getTrue(RHS->getContext());
3251
3252 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3253 CmpInst::getInversePredicate(Pred), RHS_CR);
3254 if (InversedSatisfied_CR.contains(LHS_CR))
3255 return ConstantInt::getFalse(RHS->getContext());
3256 }
3257 }
3258
Duncan Sands8fb2c382011-01-20 13:21:55 +00003259 // Compare of cast, for example (zext X) != 0 -> X != 0
3260 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3261 Instruction *LI = cast<CastInst>(LHS);
3262 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003263 Type *SrcTy = SrcOp->getType();
3264 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003265
3266 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3267 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003268 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3269 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003270 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3271 // Transfer the cast to the constant.
3272 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3273 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003274 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003275 return V;
3276 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3277 if (RI->getOperand(0)->getType() == SrcTy)
3278 // Compare without the cast.
3279 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003280 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003281 return V;
3282 }
3283 }
3284
3285 if (isa<ZExtInst>(LHS)) {
3286 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3287 // same type.
3288 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3289 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3290 // Compare X and Y. Note that signed predicates become unsigned.
3291 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003292 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003293 MaxRecurse-1))
3294 return V;
3295 }
3296 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3297 // too. If not, then try to deduce the result of the comparison.
3298 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3299 // Compute the constant that would happen if we truncated to SrcTy then
3300 // reextended to DstTy.
3301 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3302 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3303
3304 // If the re-extended constant didn't change then this is effectively
3305 // also a case of comparing two zero-extended values.
3306 if (RExt == CI && MaxRecurse)
3307 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003308 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003309 return V;
3310
3311 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3312 // there. Use this to work out the result of the comparison.
3313 if (RExt != CI) {
3314 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003315 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003316 // LHS <u RHS.
3317 case ICmpInst::ICMP_EQ:
3318 case ICmpInst::ICMP_UGT:
3319 case ICmpInst::ICMP_UGE:
3320 return ConstantInt::getFalse(CI->getContext());
3321
3322 case ICmpInst::ICMP_NE:
3323 case ICmpInst::ICMP_ULT:
3324 case ICmpInst::ICMP_ULE:
3325 return ConstantInt::getTrue(CI->getContext());
3326
3327 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3328 // is non-negative then LHS <s RHS.
3329 case ICmpInst::ICMP_SGT:
3330 case ICmpInst::ICMP_SGE:
3331 return CI->getValue().isNegative() ?
3332 ConstantInt::getTrue(CI->getContext()) :
3333 ConstantInt::getFalse(CI->getContext());
3334
3335 case ICmpInst::ICMP_SLT:
3336 case ICmpInst::ICMP_SLE:
3337 return CI->getValue().isNegative() ?
3338 ConstantInt::getFalse(CI->getContext()) :
3339 ConstantInt::getTrue(CI->getContext());
3340 }
3341 }
3342 }
3343 }
3344
3345 if (isa<SExtInst>(LHS)) {
3346 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3347 // same type.
3348 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3349 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3350 // Compare X and Y. Note that the predicate does not change.
3351 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003352 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003353 return V;
3354 }
3355 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3356 // too. If not, then try to deduce the result of the comparison.
3357 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3358 // Compute the constant that would happen if we truncated to SrcTy then
3359 // reextended to DstTy.
3360 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3361 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3362
3363 // If the re-extended constant didn't change then this is effectively
3364 // also a case of comparing two sign-extended values.
3365 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003366 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003367 return V;
3368
3369 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3370 // bits there. Use this to work out the result of the comparison.
3371 if (RExt != CI) {
3372 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003373 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003374 case ICmpInst::ICMP_EQ:
3375 return ConstantInt::getFalse(CI->getContext());
3376 case ICmpInst::ICMP_NE:
3377 return ConstantInt::getTrue(CI->getContext());
3378
3379 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3380 // LHS >s RHS.
3381 case ICmpInst::ICMP_SGT:
3382 case ICmpInst::ICMP_SGE:
3383 return CI->getValue().isNegative() ?
3384 ConstantInt::getTrue(CI->getContext()) :
3385 ConstantInt::getFalse(CI->getContext());
3386 case ICmpInst::ICMP_SLT:
3387 case ICmpInst::ICMP_SLE:
3388 return CI->getValue().isNegative() ?
3389 ConstantInt::getFalse(CI->getContext()) :
3390 ConstantInt::getTrue(CI->getContext());
3391
3392 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3393 // LHS >u RHS.
3394 case ICmpInst::ICMP_UGT:
3395 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003396 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003397 if (MaxRecurse)
3398 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3399 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003400 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003401 return V;
3402 break;
3403 case ICmpInst::ICMP_ULT:
3404 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003405 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003406 if (MaxRecurse)
3407 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3408 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003409 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003410 return V;
3411 break;
3412 }
3413 }
3414 }
3415 }
3416 }
3417
James Molloy1d88d6f2015-10-22 13:18:42 +00003418 // icmp eq|ne X, Y -> false|true if X != Y
Craig Topperc2790ec2017-06-06 07:13:04 +00003419 if (ICmpInst::isEquality(Pred) &&
Florian Hahn19f9e322018-08-17 14:39:04 +00003420 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo)) {
Craig Topper2dfb4802017-06-06 07:13:13 +00003421 return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
James Molloy1d88d6f2015-10-22 13:18:42 +00003422 }
Junmo Park53470fc2016-04-05 21:14:31 +00003423
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003424 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3425 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003426
Sanjay Patel35289c62016-12-10 17:40:47 +00003427 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003428 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003429
Chandler Carruth8059c842012-03-25 21:28:14 +00003430 // Simplify comparisons of related pointers using a powerful, recursive
3431 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003432 if (LHS->getType()->isPointerTy())
Florian Hahn19f9e322018-08-17 14:39:04 +00003433 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
3434 Q.IIQ, LHS, RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003435 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003436 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3437 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3438 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3439 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3440 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3441 Q.DL.getTypeSizeInBits(CRHS->getType()))
Nuno Lopes404f1062017-09-09 18:23:11 +00003442 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +00003443 Q.IIQ, CLHS->getPointerOperand(),
David Majnemerdc8767a2016-08-07 07:58:10 +00003444 CRHS->getPointerOperand()))
3445 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003446
Nick Lewycky3db143e2012-02-26 02:09:49 +00003447 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3448 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3449 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3450 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3451 (ICmpInst::isEquality(Pred) ||
3452 (GLHS->isInBounds() && GRHS->isInBounds() &&
3453 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3454 // The bases are equal and the indices are constant. Build a constant
3455 // expression GEP with the same indices and a null base pointer to see
3456 // what constant folding can make out of it.
3457 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3458 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003459 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3460 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003461
3462 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003463 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3464 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003465 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3466 }
3467 }
3468 }
3469
Duncan Sandsf532d312010-11-07 16:12:23 +00003470 // If the comparison is with the result of a select instruction, check whether
3471 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003472 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003473 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003474 return V;
3475
3476 // If the comparison is with the result of a phi instruction, check whether
3477 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003478 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003479 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003480 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003481
Craig Topper9f008862014-04-15 04:59:12 +00003482 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003483}
3484
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003485Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003486 const SimplifyQuery &Q) {
3487 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3488}
3489
Sanjay Patel472cc782016-01-11 22:14:42 +00003490/// Given operands for an FCmpInst, see if we can fold the result.
3491/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003492static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003493 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003494 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003495 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3496 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3497
Chris Lattnera71e9d62009-11-10 00:55:12 +00003498 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003499 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003500 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003501
Chris Lattnera71e9d62009-11-10 00:55:12 +00003502 // If we have a constant, make sure it is on the RHS.
3503 std::swap(LHS, RHS);
3504 Pred = CmpInst::getSwappedPredicate(Pred);
3505 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003506
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003507 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003508 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003509 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003510 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003511 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003512 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003513
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003514 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3515 if (FMF.noNaNs()) {
3516 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003517 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003518 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003519 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003520 }
3521
Sanjay Patel46b083e2018-03-02 18:36:08 +00003522 // NaN is unordered; NaN is not ordered.
3523 assert((FCmpInst::isOrdered(Pred) || FCmpInst::isUnordered(Pred)) &&
3524 "Comparison must be either ordered or unordered");
3525 if (match(RHS, m_NaN()))
3526 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3527
Mehdi Aminieb242a52015-03-09 03:20:25 +00003528 // fcmp pred x, undef and fcmp pred undef, x
3529 // fold to true if unordered, false if ordered
3530 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3531 // Choosing NaN for the undef will always make unordered comparison succeed
3532 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003533 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003534 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003535
3536 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003537 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003538 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003539 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003540 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003541 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003542 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003543
Sanjay Patel4ca99682017-11-27 16:37:09 +00003544 // Handle fcmp with constant RHS.
3545 const APFloat *C;
3546 if (match(RHS, m_APFloat(C))) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003547 // Check whether the constant is an infinity.
Sanjay Patel4ca99682017-11-27 16:37:09 +00003548 if (C->isInfinity()) {
3549 if (C->isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003550 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003551 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003552 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003553 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003554 case FCmpInst::FCMP_UGE:
3555 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003556 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003557 default:
3558 break;
3559 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003560 } else {
3561 switch (Pred) {
3562 case FCmpInst::FCMP_OGT:
3563 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003564 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003565 case FCmpInst::FCMP_ULE:
3566 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003567 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003568 default:
3569 break;
3570 }
3571 }
3572 }
Sanjay Patel4ca99682017-11-27 16:37:09 +00003573 if (C->isZero()) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003574 switch (Pred) {
3575 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003576 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003577 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003578 break;
3579 case FCmpInst::FCMP_OLT:
3580 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003581 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003582 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003583 break;
3584 default:
3585 break;
3586 }
Florian Hahn30932a32017-12-01 12:34:16 +00003587 } else if (C->isNegative()) {
3588 assert(!C->isNaN() && "Unexpected NaN constant!");
3589 // TODO: We can catch more cases by using a range check rather than
3590 // relying on CannotBeOrderedLessThanZero.
3591 switch (Pred) {
3592 case FCmpInst::FCMP_UGE:
3593 case FCmpInst::FCMP_UGT:
3594 case FCmpInst::FCMP_UNE:
3595 // (X >= 0) implies (X > C) when (C < 0)
3596 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3597 return getTrue(RetTy);
3598 break;
3599 case FCmpInst::FCMP_OEQ:
3600 case FCmpInst::FCMP_OLE:
3601 case FCmpInst::FCMP_OLT:
3602 // (X >= 0) implies !(X < C) when (C < 0)
3603 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3604 return getFalse(RetTy);
3605 break;
3606 default:
3607 break;
3608 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003609 }
3610 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003611
Duncan Sandsa620bd12010-11-07 16:46:25 +00003612 // If the comparison is with the result of a select instruction, check whether
3613 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003614 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003615 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003616 return V;
3617
3618 // If the comparison is with the result of a phi instruction, check whether
3619 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003620 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003621 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003622 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003623
Craig Topper9f008862014-04-15 04:59:12 +00003624 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003625}
3626
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003627Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003628 FastMathFlags FMF, const SimplifyQuery &Q) {
3629 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003630}
3631
Sanjay Patel472cc782016-01-11 22:14:42 +00003632/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003633static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003634 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003635 unsigned MaxRecurse) {
3636 // Trivial replacement.
3637 if (V == Op)
3638 return RepOp;
3639
Tim Northover997f5f12017-05-22 21:28:08 +00003640 // We cannot replace a constant, and shouldn't even try.
3641 if (isa<Constant>(Op))
3642 return nullptr;
3643
David Majnemer3f0fb982015-06-06 22:40:21 +00003644 auto *I = dyn_cast<Instruction>(V);
3645 if (!I)
3646 return nullptr;
3647
3648 // If this is a binary operator, try to simplify it with the replaced op.
3649 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3650 // Consider:
3651 // %cmp = icmp eq i32 %x, 2147483647
3652 // %add = add nsw i32 %x, 1
3653 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3654 //
3655 // We can't replace %sel with %add unless we strip away the flags.
3656 if (isa<OverflowingBinaryOperator>(B))
Florian Hahn19f9e322018-08-17 14:39:04 +00003657 if (Q.IIQ.hasNoSignedWrap(B) || Q.IIQ.hasNoUnsignedWrap(B))
David Majnemer3f0fb982015-06-06 22:40:21 +00003658 return nullptr;
Florian Hahn19f9e322018-08-17 14:39:04 +00003659 if (isa<PossiblyExactOperator>(B) && Q.IIQ.isExact(B))
3660 return nullptr;
David Majnemer3f0fb982015-06-06 22:40:21 +00003661
3662 if (MaxRecurse) {
3663 if (B->getOperand(0) == Op)
3664 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3665 MaxRecurse - 1);
3666 if (B->getOperand(1) == Op)
3667 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3668 MaxRecurse - 1);
3669 }
3670 }
3671
3672 // Same for CmpInsts.
3673 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3674 if (MaxRecurse) {
3675 if (C->getOperand(0) == Op)
3676 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3677 MaxRecurse - 1);
3678 if (C->getOperand(1) == Op)
3679 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3680 MaxRecurse - 1);
3681 }
3682 }
3683
George Burgess IV8e807bf2018-04-24 00:25:01 +00003684 // Same for GEPs.
3685 if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
3686 if (MaxRecurse) {
3687 SmallVector<Value *, 8> NewOps(GEP->getNumOperands());
3688 transform(GEP->operands(), NewOps.begin(),
3689 [&](Value *V) { return V == Op ? RepOp : V; });
3690 return SimplifyGEPInst(GEP->getSourceElementType(), NewOps, Q,
3691 MaxRecurse - 1);
3692 }
3693 }
3694
David Majnemer3f0fb982015-06-06 22:40:21 +00003695 // TODO: We could hand off more cases to instsimplify here.
3696
3697 // If all operands are constant after substituting Op for RepOp then we can
3698 // constant fold the instruction.
3699 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3700 // Build a list of all constant operands.
3701 SmallVector<Constant *, 8> ConstOps;
3702 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3703 if (I->getOperand(i) == Op)
3704 ConstOps.push_back(CRepOp);
3705 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3706 ConstOps.push_back(COp);
3707 else
3708 break;
3709 }
3710
3711 // All operands were constants, fold it.
3712 if (ConstOps.size() == I->getNumOperands()) {
3713 if (CmpInst *C = dyn_cast<CmpInst>(I))
3714 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3715 ConstOps[1], Q.DL, Q.TLI);
3716
3717 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3718 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003719 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003720
Manuel Jacobe9024592016-01-21 06:33:22 +00003721 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003722 }
3723 }
3724
3725 return nullptr;
3726}
3727
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003728/// Try to simplify a select instruction when its condition operand is an
3729/// integer comparison where one operand of the compare is a constant.
3730static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3731 const APInt *Y, bool TrueWhenUnset) {
3732 const APInt *C;
3733
3734 // (X & Y) == 0 ? X & ~Y : X --> X
3735 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3736 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3737 *Y == ~*C)
3738 return TrueWhenUnset ? FalseVal : TrueVal;
3739
3740 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3741 // (X & Y) != 0 ? X : X & ~Y --> X
3742 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3743 *Y == ~*C)
3744 return TrueWhenUnset ? FalseVal : TrueVal;
3745
3746 if (Y->isPowerOf2()) {
3747 // (X & Y) == 0 ? X | Y : X --> X | Y
3748 // (X & Y) != 0 ? X | Y : X --> X
3749 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3750 *Y == *C)
3751 return TrueWhenUnset ? TrueVal : FalseVal;
3752
3753 // (X & Y) == 0 ? X : X | Y --> X
3754 // (X & Y) != 0 ? X : X | Y --> X | Y
3755 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3756 *Y == *C)
3757 return TrueWhenUnset ? TrueVal : FalseVal;
3758 }
Matt Arsenault82606662017-01-11 00:57:54 +00003759
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003760 return nullptr;
3761}
3762
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003763/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3764/// eq/ne.
Craig Topper0aa3a192017-08-14 21:39:51 +00003765static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3766 ICmpInst::Predicate Pred,
3767 Value *TrueVal, Value *FalseVal) {
3768 Value *X;
3769 APInt Mask;
3770 if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3771 return nullptr;
3772
Craig Topper0aa3a192017-08-14 21:39:51 +00003773 return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3774 Pred == ICmpInst::ICMP_EQ);
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003775}
3776
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003777/// Try to simplify a select instruction when its condition operand is an
3778/// integer comparison.
3779static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003780 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003781 unsigned MaxRecurse) {
3782 ICmpInst::Predicate Pred;
3783 Value *CmpLHS, *CmpRHS;
3784 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3785 return nullptr;
3786
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003787 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3788 Value *X;
3789 const APInt *Y;
3790 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3791 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3792 Pred == ICmpInst::ICMP_EQ))
3793 return V;
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003794 }
3795
Craig Topper0aa3a192017-08-14 21:39:51 +00003796 // Check for other compares that behave like bit test.
3797 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3798 TrueVal, FalseVal))
3799 return V;
3800
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003801 // If we have an equality comparison, then we know the value in one of the
3802 // arms of the select. See if substituting this value into the arm and
3803 // simplifying the result yields the same value as the other arm.
3804 if (Pred == ICmpInst::ICMP_EQ) {
3805 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3806 TrueVal ||
3807 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3808 TrueVal)
3809 return FalseVal;
3810 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3811 FalseVal ||
3812 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3813 FalseVal)
3814 return FalseVal;
3815 } else if (Pred == ICmpInst::ICMP_NE) {
3816 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3817 FalseVal ||
3818 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3819 FalseVal)
3820 return TrueVal;
3821 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3822 TrueVal ||
3823 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3824 TrueVal)
3825 return TrueVal;
3826 }
3827
3828 return nullptr;
3829}
3830
Sanjay Patel472cc782016-01-11 22:14:42 +00003831/// Given operands for a SelectInst, see if we can fold the result.
3832/// If not, this returns null.
Sanjay Patelac395202018-02-17 14:50:13 +00003833static Value *SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3834 const SimplifyQuery &Q, unsigned MaxRecurse) {
3835 if (auto *CondC = dyn_cast<Constant>(Cond)) {
3836 if (auto *TrueC = dyn_cast<Constant>(TrueVal))
3837 if (auto *FalseC = dyn_cast<Constant>(FalseVal))
3838 return ConstantFoldSelectInstruction(CondC, TrueC, FalseC);
3839
3840 // select undef, X, Y -> X or Y
3841 if (isa<UndefValue>(CondC))
3842 return isa<Constant>(FalseVal) ? FalseVal : TrueVal;
3843
3844 // TODO: Vector constants with undef elements don't simplify.
3845
3846 // select true, X, Y -> X
3847 if (CondC->isAllOnesValue())
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003848 return TrueVal;
Sanjay Patelac395202018-02-17 14:50:13 +00003849 // select false, X, Y -> Y
3850 if (CondC->isNullValue())
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003851 return FalseVal;
3852 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003853
Sanjay Patelac395202018-02-17 14:50:13 +00003854 // select ?, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003855 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003856 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003857
Sanjay Patelac395202018-02-17 14:50:13 +00003858 if (isa<UndefValue>(TrueVal)) // select ?, undef, X -> X
Dan Gohman54664ed2011-07-01 01:03:43 +00003859 return FalseVal;
Sanjay Patelac395202018-02-17 14:50:13 +00003860 if (isa<UndefValue>(FalseVal)) // select ?, X, undef -> X
Dan Gohman54664ed2011-07-01 01:03:43 +00003861 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003862
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003863 if (Value *V =
Sanjay Patelac395202018-02-17 14:50:13 +00003864 simplifySelectWithICmpCond(Cond, TrueVal, FalseVal, Q, MaxRecurse))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003865 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003866
David Bolvanskyf9476082018-07-28 06:55:51 +00003867 if (Value *V = foldSelectWithBinaryOp(Cond, TrueVal, FalseVal))
3868 return V;
3869
Craig Topper9f008862014-04-15 04:59:12 +00003870 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003871}
3872
Duncan Sandsb8cee002012-03-13 11:42:19 +00003873Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003874 const SimplifyQuery &Q) {
3875 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003876}
3877
Sanjay Patel472cc782016-01-11 22:14:42 +00003878/// Given operands for an GetElementPtrInst, see if we can fold the result.
3879/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003880static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003881 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003882 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003883 unsigned AS =
3884 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003885
Chris Lattner8574aba2009-11-27 00:29:05 +00003886 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003887 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003888 return Ops[0];
3889
Nico Weber48c82402014-08-27 20:06:19 +00003890 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003891 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003892 Type *GEPTy = PointerType::get(LastType, AS);
3893 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3894 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003895 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3896 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003897
3898 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003899 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003900
Jay Foadb992a632011-07-19 15:07:52 +00003901 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003902 // getelementptr P, 0 -> P.
Matthew Simpsonc1c4ad62018-03-15 16:00:29 +00003903 if (match(Ops[1], m_Zero()) && Ops[0]->getType() == GEPTy)
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003904 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003905
David Blaikie4a2e73b2015-04-02 18:55:32 +00003906 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003907 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003908 Value *P;
3909 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003910 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003911 // getelementptr P, N -> P if P points to a type of zero size.
Matthew Simpsonc1c4ad62018-03-15 16:00:29 +00003912 if (TyAllocSize == 0 && Ops[0]->getType() == GEPTy)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003913 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003914
3915 // The following transforms are only safe if the ptrtoint cast
3916 // doesn't truncate the pointers.
3917 if (Ops[1]->getType()->getScalarSizeInBits() ==
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003918 Q.DL.getIndexSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003919 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3920 if (match(P, m_Zero()))
3921 return Constant::getNullValue(GEPTy);
3922 Value *Temp;
3923 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003924 if (Temp->getType() == GEPTy)
3925 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003926 return nullptr;
3927 };
3928
3929 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3930 if (TyAllocSize == 1 &&
3931 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3932 if (Value *R = PtrToIntOrZero(P))
3933 return R;
3934
3935 // getelementptr V, (ashr (sub P, V), C) -> Q
3936 // if P points to a type of size 1 << C.
3937 if (match(Ops[1],
3938 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3939 m_ConstantInt(C))) &&
3940 TyAllocSize == 1ULL << C)
3941 if (Value *R = PtrToIntOrZero(P))
3942 return R;
3943
3944 // getelementptr V, (sdiv (sub P, V), C) -> Q
3945 // if P points to a type of size C.
3946 if (match(Ops[1],
3947 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3948 m_SpecificInt(TyAllocSize))))
3949 if (Value *R = PtrToIntOrZero(P))
3950 return R;
3951 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003952 }
3953 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003954
David Majnemerd1501372016-08-07 07:58:12 +00003955 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3956 all_of(Ops.slice(1).drop_back(1),
3957 [](Value *Idx) { return match(Idx, m_Zero()); })) {
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003958 unsigned IdxWidth =
3959 Q.DL.getIndexSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3960 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == IdxWidth) {
3961 APInt BasePtrOffset(IdxWidth, 0);
David Majnemerd1501372016-08-07 07:58:12 +00003962 Value *StrippedBasePtr =
3963 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3964 BasePtrOffset);
3965
David Majnemer5c5df622016-08-16 06:13:46 +00003966 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003967 if (match(Ops.back(),
3968 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3969 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3970 return ConstantExpr::getIntToPtr(CI, GEPTy);
3971 }
David Majnemer5c5df622016-08-16 06:13:46 +00003972 // gep (gep V, C), (xor V, -1) -> C-1
3973 if (match(Ops.back(),
3974 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3975 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3976 return ConstantExpr::getIntToPtr(CI, GEPTy);
3977 }
David Majnemerd1501372016-08-07 07:58:12 +00003978 }
3979 }
3980
Chris Lattner8574aba2009-11-27 00:29:05 +00003981 // Check to see if this is constant foldable.
Craig Topperda8037f2017-06-04 22:41:56 +00003982 if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
3983 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003984
Joey Gouly61eaa632017-06-06 10:17:14 +00003985 auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3986 Ops.slice(1));
3987 if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
3988 return CEFolded;
3989 return CE;
Chris Lattner8574aba2009-11-27 00:29:05 +00003990}
3991
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003992Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003993 const SimplifyQuery &Q) {
3994 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003995}
3996
Sanjay Patel472cc782016-01-11 22:14:42 +00003997/// Given operands for an InsertValueInst, see if we can fold the result.
3998/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003999static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004000 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00004001 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00004002 if (Constant *CAgg = dyn_cast<Constant>(Agg))
4003 if (Constant *CVal = dyn_cast<Constant>(Val))
4004 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
4005
4006 // insertvalue x, undef, n -> x
4007 if (match(Val, m_Undef()))
4008 return Agg;
4009
4010 // insertvalue x, (extractvalue y, n), n
4011 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00004012 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
4013 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00004014 // insertvalue undef, (extractvalue y, n), n -> y
4015 if (match(Agg, m_Undef()))
4016 return EV->getAggregateOperand();
4017
4018 // insertvalue y, (extractvalue y, n), n -> y
4019 if (Agg == EV->getAggregateOperand())
4020 return Agg;
4021 }
4022
Craig Topper9f008862014-04-15 04:59:12 +00004023 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00004024}
4025
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004026Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
4027 ArrayRef<unsigned> Idxs,
4028 const SimplifyQuery &Q) {
4029 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
4030}
4031
Igor Laevskye0edb662017-12-13 11:21:18 +00004032Value *llvm::SimplifyInsertElementInst(Value *Vec, Value *Val, Value *Idx,
4033 const SimplifyQuery &Q) {
4034 // Try to constant fold.
4035 auto *VecC = dyn_cast<Constant>(Vec);
4036 auto *ValC = dyn_cast<Constant>(Val);
4037 auto *IdxC = dyn_cast<Constant>(Idx);
4038 if (VecC && ValC && IdxC)
4039 return ConstantFoldInsertElementInstruction(VecC, ValC, IdxC);
4040
4041 // Fold into undef if index is out of bounds.
4042 if (auto *CI = dyn_cast<ConstantInt>(Idx)) {
4043 uint64_t NumElements = cast<VectorType>(Vec->getType())->getNumElements();
Igor Laevskye0edb662017-12-13 11:21:18 +00004044 if (CI->uge(NumElements))
4045 return UndefValue::get(Vec->getType());
4046 }
4047
Philip Reamese499bc32017-12-30 05:54:22 +00004048 // If index is undef, it might be out of bounds (see above case)
4049 if (isa<UndefValue>(Idx))
4050 return UndefValue::get(Vec->getType());
Igor Laevskye0edb662017-12-13 11:21:18 +00004051
4052 return nullptr;
4053}
4054
Sanjay Patel472cc782016-01-11 22:14:42 +00004055/// Given operands for an ExtractValueInst, see if we can fold the result.
4056/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00004057static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004058 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00004059 if (auto *CAgg = dyn_cast<Constant>(Agg))
4060 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
4061
4062 // extractvalue x, (insertvalue y, elt, n), n -> elt
4063 unsigned NumIdxs = Idxs.size();
4064 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
4065 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
4066 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
4067 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
4068 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
4069 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
4070 Idxs.slice(0, NumCommonIdxs)) {
4071 if (NumIdxs == NumInsertValueIdxs)
4072 return IVI->getInsertedValueOperand();
4073 break;
4074 }
4075 }
4076
4077 return nullptr;
4078}
4079
4080Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004081 const SimplifyQuery &Q) {
4082 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
4083}
4084
Sanjay Patel472cc782016-01-11 22:14:42 +00004085/// Given operands for an ExtractElementInst, see if we can fold the result.
4086/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004087static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00004088 unsigned) {
4089 if (auto *CVec = dyn_cast<Constant>(Vec)) {
4090 if (auto *CIdx = dyn_cast<Constant>(Idx))
4091 return ConstantFoldExtractElementInstruction(CVec, CIdx);
4092
4093 // The index is not relevant if our vector is a splat.
4094 if (auto *Splat = CVec->getSplatValue())
4095 return Splat;
4096
4097 if (isa<UndefValue>(Vec))
4098 return UndefValue::get(Vec->getType()->getVectorElementType());
4099 }
4100
4101 // If extracting a specified index from the vector, see if we can recursively
4102 // find a previously computed scalar that was inserted into the vector.
Philip Reamese499bc32017-12-30 05:54:22 +00004103 if (auto *IdxC = dyn_cast<ConstantInt>(Idx)) {
4104 if (IdxC->getValue().uge(Vec->getType()->getVectorNumElements()))
4105 // definitely out of bounds, thus undefined result
4106 return UndefValue::get(Vec->getType()->getVectorElementType());
4107 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
4108 return Elt;
4109 }
David Majnemer599ca442015-07-13 01:15:53 +00004110
Zvi Rackover2e6e88f2017-12-06 17:51:46 +00004111 // An undef extract index can be arbitrarily chosen to be an out-of-range
4112 // index value, which would result in the instruction being undef.
4113 if (isa<UndefValue>(Idx))
4114 return UndefValue::get(Vec->getType()->getVectorElementType());
4115
David Majnemer599ca442015-07-13 01:15:53 +00004116 return nullptr;
4117}
4118
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004119Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
4120 const SimplifyQuery &Q) {
4121 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
4122}
4123
Sanjay Patel472cc782016-01-11 22:14:42 +00004124/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004125static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004126 // If all of the PHI's incoming values are the same then replace the PHI node
4127 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00004128 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004129 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00004130 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004131 // If the incoming value is the phi node itself, it can safely be skipped.
4132 if (Incoming == PN) continue;
4133 if (isa<UndefValue>(Incoming)) {
4134 // Remember that we saw an undef value, but otherwise ignore them.
4135 HasUndefInput = true;
4136 continue;
4137 }
4138 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00004139 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00004140 CommonValue = Incoming;
4141 }
4142
4143 // If CommonValue is null then all of the incoming values were either undef or
4144 // equal to the phi node itself.
4145 if (!CommonValue)
4146 return UndefValue::get(PN->getType());
4147
4148 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4149 // instruction, we cannot return X as the result of the PHI node unless it
4150 // dominates the PHI block.
4151 if (HasUndefInput)
Sanjay Patel5da361a2018-04-10 18:38:19 +00004152 return valueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004153
4154 return CommonValue;
4155}
4156
David Majnemer6774d612016-07-26 17:58:05 +00004157static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004158 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004159 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004160 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004161
David Majnemer6774d612016-07-26 17:58:05 +00004162 if (auto *CI = dyn_cast<CastInst>(Op)) {
4163 auto *Src = CI->getOperand(0);
4164 Type *SrcTy = Src->getType();
4165 Type *MidTy = CI->getType();
4166 Type *DstTy = Ty;
4167 if (Src->getType() == Ty) {
4168 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4169 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4170 Type *SrcIntPtrTy =
4171 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4172 Type *MidIntPtrTy =
4173 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4174 Type *DstIntPtrTy =
4175 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4176 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4177 SrcIntPtrTy, MidIntPtrTy,
4178 DstIntPtrTy) == Instruction::BitCast)
4179 return Src;
4180 }
4181 }
David Majnemera90a6212016-07-26 05:52:29 +00004182
4183 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004184 if (CastOpc == Instruction::BitCast)
4185 if (Op->getType() == Ty)
4186 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004187
4188 return nullptr;
4189}
4190
David Majnemer6774d612016-07-26 17:58:05 +00004191Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004192 const SimplifyQuery &Q) {
4193 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4194}
4195
Sanjay Patela3c297d2017-04-19 16:48:22 +00004196/// For the given destination element of a shuffle, peek through shuffles to
4197/// match a root vector source operand that contains that element in the same
4198/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4199static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004200 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004201 unsigned MaxRecurse) {
4202 if (!MaxRecurse--)
4203 return nullptr;
4204
4205 // Bail out if any mask value is undefined. That kind of shuffle may be
4206 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004207 if (MaskVal == -1)
4208 return nullptr;
4209
4210 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004211 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004212 int RootElt = MaskVal;
4213 Value *SourceOp = Op0;
4214 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004215 RootElt = MaskVal - InVecNumElts;
4216 SourceOp = Op1;
4217 }
4218
4219 // If the source operand is a shuffle itself, look through it to find the
4220 // matching root vector.
4221 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4222 return foldIdentityShuffles(
4223 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004224 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004225 }
4226
4227 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4228 // size?
4229
4230 // The source operand is not a shuffle. Initialize the root vector value for
4231 // this shuffle if that has not been done yet.
4232 if (!RootVec)
4233 RootVec = SourceOp;
4234
4235 // Give up as soon as a source operand does not match the existing root value.
4236 if (RootVec != SourceOp)
4237 return nullptr;
4238
4239 // The element must be coming from the same lane in the source vector
4240 // (although it may have crossed lanes in intermediate shuffles).
4241 if (RootElt != DestElt)
4242 return nullptr;
4243
4244 return RootVec;
4245}
4246
Zvi Rackover8f460652017-04-03 22:05:30 +00004247static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004248 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004249 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004250 if (isa<UndefValue>(Mask))
4251 return UndefValue::get(RetTy);
4252
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004253 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004254 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004255 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004256
Zvi Rackover0411e462017-04-30 06:10:54 +00004257 SmallVector<int, 32> Indices;
4258 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4259 assert(MaskNumElts == Indices.size() &&
4260 "Size of Indices not same as number of mask elements?");
4261
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004262 // Canonicalization: If mask does not select elements from an input vector,
4263 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004264 bool MaskSelects0 = false, MaskSelects1 = false;
4265 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004266 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004267 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004268 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004269 MaskSelects0 = true;
4270 else
4271 MaskSelects1 = true;
4272 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004273 if (!MaskSelects0)
4274 Op0 = UndefValue::get(InVecTy);
4275 if (!MaskSelects1)
4276 Op1 = UndefValue::get(InVecTy);
4277
4278 auto *Op0Const = dyn_cast<Constant>(Op0);
4279 auto *Op1Const = dyn_cast<Constant>(Op1);
4280
4281 // If all operands are constant, constant fold the shuffle.
4282 if (Op0Const && Op1Const)
4283 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4284
4285 // Canonicalization: if only one input vector is constant, it shall be the
4286 // second one.
4287 if (Op0Const && !Op1Const) {
4288 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004289 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004290 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004291
4292 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4293 // value type is same as the input vectors' type.
4294 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004295 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004296 OpShuf->getMask()->getSplatValue())
4297 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004298
Sanjay Patela3c297d2017-04-19 16:48:22 +00004299 // Don't fold a shuffle with undef mask elements. This may get folded in a
4300 // better way using demanded bits or other analysis.
4301 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004302 if (find(Indices, -1) != Indices.end())
4303 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004304
4305 // Check if every element of this shuffle can be mapped back to the
4306 // corresponding element of a single root vector. If so, we don't need this
4307 // shuffle. This handles simple identity shuffles as well as chains of
4308 // shuffles that may widen/narrow and/or move elements across lanes and back.
4309 Value *RootVec = nullptr;
4310 for (unsigned i = 0; i != MaskNumElts; ++i) {
4311 // Note that recursion is limited for each vector element, so if any element
4312 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004313 RootVec =
4314 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004315
4316 // We can't replace a widening/narrowing shuffle with one of its operands.
4317 if (!RootVec || RootVec->getType() != RetTy)
4318 return nullptr;
4319 }
4320 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004321}
4322
4323/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004324Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4325 Type *RetTy, const SimplifyQuery &Q) {
4326 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004327}
4328
Sanjay Patele2359422018-03-21 19:31:53 +00004329static Constant *propagateNaN(Constant *In) {
4330 // If the input is a vector with undef elements, just return a default NaN.
4331 if (!In->isNaN())
4332 return ConstantFP::getNaN(In->getType());
4333
4334 // Propagate the existing NaN constant when possible.
4335 // TODO: Should we quiet a signaling NaN?
4336 return In;
4337}
4338
4339static Constant *simplifyFPBinop(Value *Op0, Value *Op1) {
4340 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4341 return ConstantFP::getNaN(Op0->getType());
4342
4343 if (match(Op0, m_NaN()))
4344 return propagateNaN(cast<Constant>(Op0));
4345 if (match(Op1, m_NaN()))
4346 return propagateNaN(cast<Constant>(Op1));
4347
4348 return nullptr;
4349}
4350
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004351/// Given operands for an FAdd, see if we can fold the result. If not, this
4352/// returns null.
4353static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4354 const SimplifyQuery &Q, unsigned MaxRecurse) {
4355 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4356 return C;
4357
Sanjay Patele2359422018-03-21 19:31:53 +00004358 if (Constant *C = simplifyFPBinop(Op0, Op1))
4359 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004360
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004361 // fadd X, -0 ==> X
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004362 if (match(Op1, m_NegZeroFP()))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004363 return Op0;
4364
4365 // fadd X, 0 ==> X, when we know X is not -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004366 if (match(Op1, m_PosZeroFP()) &&
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004367 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4368 return Op0;
4369
Sanjay Patel11f7f992018-03-14 21:23:27 +00004370 // With nnan: (+/-0.0 - X) + X --> 0.0 (and commuted variant)
4371 // We don't have to explicitly exclude infinities (ninf): INF + -INF == NaN.
4372 // Negative zeros are allowed because we always end up with positive zero:
4373 // X = -0.0: (-0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4374 // X = -0.0: ( 0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4375 // X = 0.0: (-0.0 - ( 0.0)) + ( 0.0) == (-0.0) + ( 0.0) == 0.0
4376 // X = 0.0: ( 0.0 - ( 0.0)) + ( 0.0) == ( 0.0) + ( 0.0) == 0.0
Sanjay Patela4f42f22018-03-15 14:29:27 +00004377 if (FMF.noNaNs() && (match(Op0, m_FSub(m_AnyZeroFP(), m_Specific(Op1))) ||
4378 match(Op1, m_FSub(m_AnyZeroFP(), m_Specific(Op0)))))
Sanjay Patel11f7f992018-03-14 21:23:27 +00004379 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004380
Sanjay Patel9b073472018-08-07 20:32:55 +00004381 // (X - Y) + Y --> X
4382 // Y + (X - Y) --> X
4383 Value *X;
4384 if (FMF.noSignedZeros() && FMF.allowReassoc() &&
4385 (match(Op0, m_FSub(m_Value(X), m_Specific(Op1))) ||
4386 match(Op1, m_FSub(m_Value(X), m_Specific(Op0)))))
4387 return X;
4388
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004389 return nullptr;
4390}
4391
4392/// Given operands for an FSub, see if we can fold the result. If not, this
4393/// returns null.
4394static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4395 const SimplifyQuery &Q, unsigned MaxRecurse) {
4396 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
4397 return C;
4398
Sanjay Patele2359422018-03-21 19:31:53 +00004399 if (Constant *C = simplifyFPBinop(Op0, Op1))
4400 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004401
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004402 // fsub X, +0 ==> X
4403 if (match(Op1, m_PosZeroFP()))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004404 return Op0;
4405
4406 // fsub X, -0 ==> X, when we know X is not -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004407 if (match(Op1, m_NegZeroFP()) &&
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004408 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4409 return Op0;
4410
4411 // fsub -0.0, (fsub -0.0, X) ==> X
4412 Value *X;
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004413 if (match(Op0, m_NegZeroFP()) &&
4414 match(Op1, m_FSub(m_NegZeroFP(), m_Value(X))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004415 return X;
4416
4417 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Sanjay Patela4f42f22018-03-15 14:29:27 +00004418 if (FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()) &&
4419 match(Op1, m_FSub(m_AnyZeroFP(), m_Value(X))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004420 return X;
4421
4422 // fsub nnan x, x ==> 0.0
4423 if (FMF.noNaNs() && Op0 == Op1)
4424 return Constant::getNullValue(Op0->getType());
4425
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004426 // Y - (Y - X) --> X
Sanjay Patel4364d602018-08-07 20:23:49 +00004427 // (X + Y) - Y --> X
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004428 if (FMF.noSignedZeros() && FMF.allowReassoc() &&
Sanjay Patel4364d602018-08-07 20:23:49 +00004429 (match(Op1, m_FSub(m_Specific(Op0), m_Value(X))) ||
4430 match(Op0, m_c_FAdd(m_Specific(Op1), m_Value(X)))))
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004431 return X;
4432
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004433 return nullptr;
4434}
4435
4436/// Given the operands for an FMul, see if we can fold the result
4437static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4438 const SimplifyQuery &Q, unsigned MaxRecurse) {
4439 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
4440 return C;
4441
Sanjay Patele2359422018-03-21 19:31:53 +00004442 if (Constant *C = simplifyFPBinop(Op0, Op1))
4443 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004444
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004445 // fmul X, 1.0 ==> X
4446 if (match(Op1, m_FPOne()))
4447 return Op0;
4448
4449 // fmul nnan nsz X, 0 ==> 0
Sanjay Patela4f42f22018-03-15 14:29:27 +00004450 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZeroFP()))
4451 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004452
Sanjay Patel95ec4a42018-03-18 14:12:25 +00004453 // sqrt(X) * sqrt(X) --> X, if we can:
4454 // 1. Remove the intermediate rounding (reassociate).
4455 // 2. Ignore non-zero negative numbers because sqrt would produce NAN.
4456 // 3. Ignore -0.0 because sqrt(-0.0) == -0.0, but -0.0 * -0.0 == 0.0.
Sanjay Pateldb53d182018-02-23 22:20:13 +00004457 Value *X;
Sanjay Patel95ec4a42018-03-18 14:12:25 +00004458 if (Op0 == Op1 && match(Op0, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) &&
4459 FMF.allowReassoc() && FMF.noNaNs() && FMF.noSignedZeros())
Sanjay Pateldb53d182018-02-23 22:20:13 +00004460 return X;
4461
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004462 return nullptr;
4463}
4464
4465Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4466 const SimplifyQuery &Q) {
4467 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
4468}
4469
4470
4471Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4472 const SimplifyQuery &Q) {
4473 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
4474}
4475
4476Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4477 const SimplifyQuery &Q) {
4478 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
4479}
4480
4481static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4482 const SimplifyQuery &Q, unsigned) {
4483 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
4484 return C;
4485
Sanjay Patele2359422018-03-21 19:31:53 +00004486 if (Constant *C = simplifyFPBinop(Op0, Op1))
4487 return C;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004488
4489 // X / 1.0 -> X
4490 if (match(Op1, m_FPOne()))
4491 return Op0;
4492
4493 // 0 / X -> 0
4494 // Requires that NaNs are off (X could be zero) and signed zeroes are
4495 // ignored (X could be positive or negative, so the output sign is unknown).
Sanjay Patela4f42f22018-03-15 14:29:27 +00004496 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()))
4497 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004498
4499 if (FMF.noNaNs()) {
4500 // X / X -> 1.0 is legal when NaNs are ignored.
Sanjay Patel83f05662018-01-30 00:18:37 +00004501 // We can ignore infinities because INF/INF is NaN.
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004502 if (Op0 == Op1)
4503 return ConstantFP::get(Op0->getType(), 1.0);
4504
Sanjay Patel83f05662018-01-30 00:18:37 +00004505 // (X * Y) / Y --> X if we can reassociate to the above form.
4506 Value *X;
4507 if (FMF.allowReassoc() && match(Op0, m_c_FMul(m_Value(X), m_Specific(Op1))))
4508 return X;
4509
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004510 // -X / X -> -1.0 and
4511 // X / -X -> -1.0 are legal when NaNs are ignored.
4512 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
4513 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
4514 BinaryOperator::getFNegArgument(Op0) == Op1) ||
4515 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
4516 BinaryOperator::getFNegArgument(Op1) == Op0))
4517 return ConstantFP::get(Op0->getType(), -1.0);
4518 }
4519
4520 return nullptr;
4521}
4522
4523Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4524 const SimplifyQuery &Q) {
4525 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
4526}
4527
4528static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4529 const SimplifyQuery &Q, unsigned) {
4530 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
4531 return C;
4532
Sanjay Patele2359422018-03-21 19:31:53 +00004533 if (Constant *C = simplifyFPBinop(Op0, Op1))
4534 return C;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004535
Sanjay Patel8f063d02018-03-15 14:04:31 +00004536 // Unlike fdiv, the result of frem always matches the sign of the dividend.
4537 // The constant match may include undef elements in a vector, so return a full
4538 // zero constant as the result.
4539 if (FMF.noNaNs()) {
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004540 // +0 % X -> 0
4541 if (match(Op0, m_PosZeroFP()))
Sanjay Patel8f063d02018-03-15 14:04:31 +00004542 return ConstantFP::getNullValue(Op0->getType());
4543 // -0 % X -> -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004544 if (match(Op0, m_NegZeroFP()))
Sanjay Patel8f063d02018-03-15 14:04:31 +00004545 return ConstantFP::getNegativeZero(Op0->getType());
4546 }
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004547
4548 return nullptr;
4549}
4550
4551Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4552 const SimplifyQuery &Q) {
4553 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
4554}
4555
Chris Lattnera71e9d62009-11-10 00:55:12 +00004556//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004557
Sanjay Patel472cc782016-01-11 22:14:42 +00004558/// Given operands for a BinaryOperator, see if we can fold the result.
4559/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004560static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004561 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004562 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004563 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004564 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004565 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004566 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004567 case Instruction::Mul:
4568 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004569 case Instruction::SDiv:
4570 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4571 case Instruction::UDiv:
4572 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004573 case Instruction::SRem:
4574 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4575 case Instruction::URem:
4576 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004577 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004578 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004579 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004580 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004581 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004582 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4583 case Instruction::And:
4584 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4585 case Instruction::Or:
4586 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4587 case Instruction::Xor:
4588 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004589 case Instruction::FAdd:
4590 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4591 case Instruction::FSub:
4592 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4593 case Instruction::FMul:
4594 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4595 case Instruction::FDiv:
4596 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4597 case Instruction::FRem:
4598 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004599 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004600 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004601 }
4602}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004603
Sanjay Patel472cc782016-01-11 22:14:42 +00004604/// Given operands for a BinaryOperator, see if we can fold the result.
4605/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004606/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4607/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4608static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004609 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004610 unsigned MaxRecurse) {
4611 switch (Opcode) {
4612 case Instruction::FAdd:
4613 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4614 case Instruction::FSub:
4615 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4616 case Instruction::FMul:
4617 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004618 case Instruction::FDiv:
4619 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004620 default:
4621 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4622 }
4623}
4624
Duncan Sands7e800d62010-11-14 11:23:23 +00004625Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004626 const SimplifyQuery &Q) {
4627 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4628}
4629
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004630Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004631 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004632 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4633}
4634
Sanjay Patel472cc782016-01-11 22:14:42 +00004635/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004636static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004637 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004638 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004639 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004640 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004641}
4642
4643Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004644 const SimplifyQuery &Q) {
4645 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4646}
4647
Michael Ilseman54857292013-02-07 19:26:05 +00004648static bool IsIdempotent(Intrinsic::ID ID) {
4649 switch (ID) {
4650 default: return false;
4651
4652 // Unary idempotent: f(f(x)) = f(x)
4653 case Intrinsic::fabs:
4654 case Intrinsic::floor:
4655 case Intrinsic::ceil:
4656 case Intrinsic::trunc:
4657 case Intrinsic::rint:
4658 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004659 case Intrinsic::round:
Matt Arsenault3ced3d92017-09-07 01:21:43 +00004660 case Intrinsic::canonicalize:
Michael Ilseman54857292013-02-07 19:26:05 +00004661 return true;
4662 }
4663}
4664
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004665static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4666 const DataLayout &DL) {
4667 GlobalValue *PtrSym;
4668 APInt PtrOffset;
4669 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4670 return nullptr;
4671
4672 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4673 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4674 Type *Int32PtrTy = Int32Ty->getPointerTo();
4675 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4676
4677 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4678 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4679 return nullptr;
4680
4681 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4682 if (OffsetInt % 4 != 0)
4683 return nullptr;
4684
4685 Constant *C = ConstantExpr::getGetElementPtr(
4686 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4687 ConstantInt::get(Int64Ty, OffsetInt / 4));
4688 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4689 if (!Loaded)
4690 return nullptr;
4691
4692 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4693 if (!LoadedCE)
4694 return nullptr;
4695
4696 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4697 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4698 if (!LoadedCE)
4699 return nullptr;
4700 }
4701
4702 if (LoadedCE->getOpcode() != Instruction::Sub)
4703 return nullptr;
4704
4705 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4706 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4707 return nullptr;
4708 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4709
4710 Constant *LoadedRHS = LoadedCE->getOperand(1);
4711 GlobalValue *LoadedRHSSym;
4712 APInt LoadedRHSOffset;
4713 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4714 DL) ||
4715 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4716 return nullptr;
4717
4718 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4719}
4720
David Majnemer17a95aa2016-07-14 06:58:37 +00004721static bool maskIsAllZeroOrUndef(Value *Mask) {
4722 auto *ConstMask = dyn_cast<Constant>(Mask);
4723 if (!ConstMask)
4724 return false;
4725 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4726 return true;
4727 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4728 ++I) {
4729 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4730 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4731 continue;
4732 return false;
4733 }
4734 return true;
4735}
4736
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004737static Value *simplifyUnaryIntrinsic(Function *F, Value *Op0,
4738 const SimplifyQuery &Q) {
4739 // Idempotent functions return the same result when called repeatedly.
David Majnemer15032582015-05-22 03:56:46 +00004740 Intrinsic::ID IID = F->getIntrinsicID();
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004741 if (IsIdempotent(IID))
4742 if (auto *II = dyn_cast<IntrinsicInst>(Op0))
4743 if (II->getIntrinsicID() == IID)
4744 return II;
Michael Ilseman54857292013-02-07 19:26:05 +00004745
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004746 Value *X;
4747 switch (IID) {
4748 case Intrinsic::fabs:
4749 if (SignBitMustBeZero(Op0, Q.TLI)) return Op0;
4750 break;
4751 case Intrinsic::bswap:
4752 // bswap(bswap(x)) -> x
4753 if (match(Op0, m_BSwap(m_Value(X)))) return X;
4754 break;
4755 case Intrinsic::bitreverse:
4756 // bitreverse(bitreverse(x)) -> x
4757 if (match(Op0, m_BitReverse(m_Value(X)))) return X;
4758 break;
4759 case Intrinsic::exp:
4760 // exp(log(x)) -> x
4761 if (Q.CxtI->hasAllowReassoc() &&
4762 match(Op0, m_Intrinsic<Intrinsic::log>(m_Value(X)))) return X;
4763 break;
4764 case Intrinsic::exp2:
4765 // exp2(log2(x)) -> x
4766 if (Q.CxtI->hasAllowReassoc() &&
4767 match(Op0, m_Intrinsic<Intrinsic::log2>(m_Value(X)))) return X;
4768 break;
4769 case Intrinsic::log:
4770 // log(exp(x)) -> x
4771 if (Q.CxtI->hasAllowReassoc() &&
4772 match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X)))) return X;
4773 break;
4774 case Intrinsic::log2:
4775 // log2(exp2(x)) -> x
4776 if (Q.CxtI->hasAllowReassoc() &&
4777 match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X)))) return X;
4778 break;
4779 default:
4780 break;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004781 }
Michael Ilseman54857292013-02-07 19:26:05 +00004782
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004783 return nullptr;
4784}
Matt Arsenault82606662017-01-11 00:57:54 +00004785
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004786static Value *simplifyBinaryIntrinsic(Function *F, Value *Op0, Value *Op1,
4787 const SimplifyQuery &Q) {
4788 Intrinsic::ID IID = F->getIntrinsicID();
4789 Type *ReturnType = F->getReturnType();
4790 switch (IID) {
4791 case Intrinsic::usub_with_overflow:
4792 case Intrinsic::ssub_with_overflow:
4793 // X - X -> { 0, false }
4794 if (Op0 == Op1)
4795 return Constant::getNullValue(ReturnType);
4796 // X - undef -> undef
4797 // undef - X -> undef
4798 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4799 return UndefValue::get(ReturnType);
4800 break;
4801 case Intrinsic::uadd_with_overflow:
4802 case Intrinsic::sadd_with_overflow:
4803 // X + undef -> undef
4804 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4805 return UndefValue::get(ReturnType);
4806 break;
4807 case Intrinsic::umul_with_overflow:
4808 case Intrinsic::smul_with_overflow:
4809 // 0 * X -> { 0, false }
4810 // X * 0 -> { 0, false }
4811 if (match(Op0, m_Zero()) || match(Op1, m_Zero()))
4812 return Constant::getNullValue(ReturnType);
4813 // undef * X -> { 0, false }
4814 // X * undef -> { 0, false }
4815 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
4816 return Constant::getNullValue(ReturnType);
4817 break;
4818 case Intrinsic::load_relative:
4819 if (auto *C0 = dyn_cast<Constant>(Op0))
4820 if (auto *C1 = dyn_cast<Constant>(Op1))
Matt Arsenault82606662017-01-11 00:57:54 +00004821 return SimplifyRelativeLoad(C0, C1, Q.DL);
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004822 break;
4823 case Intrinsic::powi:
4824 if (auto *Power = dyn_cast<ConstantInt>(Op1)) {
4825 // powi(x, 0) -> 1.0
4826 if (Power->isZero())
4827 return ConstantFP::get(Op0->getType(), 1.0);
4828 // powi(x, 1) -> x
4829 if (Power->isOne())
4830 return Op0;
Matt Arsenault82606662017-01-11 00:57:54 +00004831 }
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004832 break;
4833 case Intrinsic::maxnum:
Sanjay Patelc6944f72018-08-09 22:20:44 +00004834 case Intrinsic::minnum: {
Sanjay Patel28c7e412018-08-01 23:05:55 +00004835 // If the arguments are the same, this is a no-op.
4836 if (Op0 == Op1) return Op0;
4837
Sanjay Patel3f6e9a72018-08-02 14:33:40 +00004838 // If one argument is NaN or undef, return the other argument.
4839 if (match(Op0, m_CombineOr(m_NaN(), m_Undef()))) return Op1;
4840 if (match(Op1, m_CombineOr(m_NaN(), m_Undef()))) return Op0;
4841
Sanjay Patel948ff872018-08-07 14:36:27 +00004842 // Min/max of the same operation with common operand:
4843 // m(m(X, Y)), X --> m(X, Y) (4 commuted variants)
4844 if (auto *M0 = dyn_cast<IntrinsicInst>(Op0))
4845 if (M0->getIntrinsicID() == IID &&
4846 (M0->getOperand(0) == Op1 || M0->getOperand(1) == Op1))
4847 return Op0;
4848 if (auto *M1 = dyn_cast<IntrinsicInst>(Op1))
4849 if (M1->getIntrinsicID() == IID &&
4850 (M1->getOperand(0) == Op0 || M1->getOperand(1) == Op0))
4851 return Op1;
4852
Sanjay Patelc6944f72018-08-09 22:20:44 +00004853 // minnum(X, -Inf) --> -Inf (and commuted variant)
4854 // maxnum(X, +Inf) --> +Inf (and commuted variant)
4855 bool UseNegInf = IID == Intrinsic::minnum;
4856 const APFloat *C;
4857 if ((match(Op0, m_APFloat(C)) && C->isInfinity() &&
4858 C->isNegative() == UseNegInf) ||
4859 (match(Op1, m_APFloat(C)) && C->isInfinity() &&
4860 C->isNegative() == UseNegInf))
4861 return ConstantFP::getInfinity(ReturnType, UseNegInf);
4862
4863 // TODO: minnum(nnan x, inf) -> x
4864 // TODO: minnum(nnan ninf x, flt_max) -> x
4865 // TODO: maxnum(nnan x, -inf) -> x
4866 // TODO: maxnum(nnan ninf x, -flt_max) -> x
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004867 break;
Sanjay Patelc6944f72018-08-09 22:20:44 +00004868 }
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004869 default:
4870 break;
Matt Arsenault82606662017-01-11 00:57:54 +00004871 }
4872
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004873 return nullptr;
4874}
4875
4876template <typename IterTy>
4877static Value *simplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
4878 const SimplifyQuery &Q) {
4879 // Intrinsics with no operands have some kind of side effect. Don't simplify.
4880 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
4881 if (NumOperands == 0)
4882 return nullptr;
4883
4884 Intrinsic::ID IID = F->getIntrinsicID();
4885 if (NumOperands == 1)
4886 return simplifyUnaryIntrinsic(F, ArgBegin[0], Q);
4887
4888 if (NumOperands == 2)
4889 return simplifyBinaryIntrinsic(F, ArgBegin[0], ArgBegin[1], Q);
4890
4891 // Handle intrinsics with 3 or more arguments.
Matt Arsenault82606662017-01-11 00:57:54 +00004892 switch (IID) {
4893 case Intrinsic::masked_load: {
4894 Value *MaskArg = ArgBegin[2];
4895 Value *PassthruArg = ArgBegin[3];
4896 // If the mask is all zeros or undef, the "passthru" argument is the result.
4897 if (maskIsAllZeroOrUndef(MaskArg))
4898 return PassthruArg;
4899 return nullptr;
4900 }
Sanjay Patel54421ce2018-07-29 16:36:38 +00004901 case Intrinsic::fshl:
4902 case Intrinsic::fshr: {
4903 Value *ShAmtArg = ArgBegin[2];
4904 const APInt *ShAmtC;
4905 if (match(ShAmtArg, m_APInt(ShAmtC))) {
4906 // If there's effectively no shift, return the 1st arg or 2nd arg.
4907 // TODO: For vectors, we could check each element of a non-splat constant.
4908 APInt BitWidth = APInt(ShAmtC->getBitWidth(), ShAmtC->getBitWidth());
4909 if (ShAmtC->urem(BitWidth).isNullValue())
4910 return ArgBegin[IID == Intrinsic::fshl ? 0 : 1];
4911 }
4912 return nullptr;
4913 }
Matt Arsenault82606662017-01-11 00:57:54 +00004914 default:
4915 return nullptr;
4916 }
Michael Ilseman54857292013-02-07 19:26:05 +00004917}
4918
Chandler Carruth9dc35582012-12-28 11:30:55 +00004919template <typename IterTy>
Andrew Kaylor647025f2017-06-09 23:18:11 +00004920static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
4921 IterTy ArgEnd, const SimplifyQuery &Q,
4922 unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004923 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004924 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4925 Ty = PTy->getElementType();
4926 FunctionType *FTy = cast<FunctionType>(Ty);
4927
Dan Gohman85977e62011-11-04 18:32:42 +00004928 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004929 // call null -> undef
4930 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004931 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004932
Chandler Carruthf6182152012-12-28 14:23:29 +00004933 Function *F = dyn_cast<Function>(V);
4934 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004935 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004936
David Majnemer15032582015-05-22 03:56:46 +00004937 if (F->isIntrinsic())
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004938 if (Value *Ret = simplifyIntrinsic(F, ArgBegin, ArgEnd, Q))
Michael Ilseman54857292013-02-07 19:26:05 +00004939 return Ret;
4940
Andrew Kaylor647025f2017-06-09 23:18:11 +00004941 if (!canConstantFoldCallTo(CS, F))
Craig Topper9f008862014-04-15 04:59:12 +00004942 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004943
4944 SmallVector<Constant *, 4> ConstantArgs;
4945 ConstantArgs.reserve(ArgEnd - ArgBegin);
4946 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4947 Constant *C = dyn_cast<Constant>(*I);
4948 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004949 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004950 ConstantArgs.push_back(C);
4951 }
4952
Andrew Kaylor647025f2017-06-09 23:18:11 +00004953 return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004954}
4955
Andrew Kaylor647025f2017-06-09 23:18:11 +00004956Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4957 User::op_iterator ArgBegin, User::op_iterator ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004958 const SimplifyQuery &Q) {
Andrew Kaylor647025f2017-06-09 23:18:11 +00004959 return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
4960}
4961
4962Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4963 ArrayRef<Value *> Args, const SimplifyQuery &Q) {
4964 return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004965}
4966
Philip Reames7a6db4f2017-12-27 00:16:12 +00004967Value *llvm::SimplifyCall(ImmutableCallSite ICS, const SimplifyQuery &Q) {
4968 CallSite CS(const_cast<Instruction*>(ICS.getInstruction()));
4969 return ::SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
4970 Q, RecursionLimit);
4971}
4972
Sanjay Patel472cc782016-01-11 22:14:42 +00004973/// See if we can compute a simplified version of this instruction.
4974/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004975
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004976Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004977 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004978 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004979 Value *Result;
4980
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004981 switch (I->getOpcode()) {
4982 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004983 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004984 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004985 case Instruction::FAdd:
4986 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004987 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004988 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004989 case Instruction::Add:
Florian Hahn19f9e322018-08-17 14:39:04 +00004990 Result =
4991 SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4992 Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
4993 Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004994 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004995 case Instruction::FSub:
4996 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004997 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004998 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004999 case Instruction::Sub:
Florian Hahn19f9e322018-08-17 14:39:04 +00005000 Result =
5001 SimplifySubInst(I->getOperand(0), I->getOperand(1),
5002 Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
5003 Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00005004 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00005005 case Instruction::FMul:
5006 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005007 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00005008 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00005009 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005010 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00005011 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00005012 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005013 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00005014 break;
5015 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005016 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00005017 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00005018 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00005019 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005020 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00005021 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00005022 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005023 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00005024 break;
5025 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005026 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00005027 break;
5028 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00005029 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005030 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00005031 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00005032 case Instruction::Shl:
Florian Hahn19f9e322018-08-17 14:39:04 +00005033 Result =
5034 SimplifyShlInst(I->getOperand(0), I->getOperand(1),
5035 Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
5036 Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00005037 break;
5038 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00005039 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Florian Hahn19f9e322018-08-17 14:39:04 +00005040 Q.IIQ.isExact(cast<BinaryOperator>(I)), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00005041 break;
5042 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00005043 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Florian Hahn19f9e322018-08-17 14:39:04 +00005044 Q.IIQ.isExact(cast<BinaryOperator>(I)), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00005045 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005046 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005047 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005048 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005049 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005050 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005051 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00005052 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005053 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00005054 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005055 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005056 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
5057 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005058 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005059 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005060 Result =
5061 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
5062 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005063 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00005064 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00005065 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005066 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005067 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00005068 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005069 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00005070 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005071 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005072 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00005073 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00005074 case Instruction::InsertValue: {
5075 InsertValueInst *IV = cast<InsertValueInst>(I);
5076 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
5077 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005078 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00005079 break;
5080 }
Igor Laevskye0edb662017-12-13 11:21:18 +00005081 case Instruction::InsertElement: {
5082 auto *IE = cast<InsertElementInst>(I);
5083 Result = SimplifyInsertElementInst(IE->getOperand(0), IE->getOperand(1),
5084 IE->getOperand(2), Q);
5085 break;
5086 }
David Majnemer25a796e2015-07-13 01:15:46 +00005087 case Instruction::ExtractValue: {
5088 auto *EVI = cast<ExtractValueInst>(I);
5089 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005090 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00005091 break;
5092 }
David Majnemer599ca442015-07-13 01:15:53 +00005093 case Instruction::ExtractElement: {
5094 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005095 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
5096 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00005097 break;
5098 }
Zvi Rackover8f460652017-04-03 22:05:30 +00005099 case Instruction::ShuffleVector: {
5100 auto *SVI = cast<ShuffleVectorInst>(I);
5101 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005102 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00005103 break;
5104 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00005105 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005106 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005107 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00005108 case Instruction::Call: {
5109 CallSite CS(cast<CallInst>(I));
Philip Reames7a6db4f2017-12-27 00:16:12 +00005110 Result = SimplifyCall(CS, Q);
Dan Gohman85977e62011-11-04 18:32:42 +00005111 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00005112 }
David Majnemer6774d612016-07-26 17:58:05 +00005113#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
5114#include "llvm/IR/Instruction.def"
5115#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005116 Result =
5117 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00005118 break;
Craig Topper81c03a72017-04-12 22:54:24 +00005119 case Instruction::Alloca:
5120 // No simplifications for Alloca and it can't be constant folded.
5121 Result = nullptr;
5122 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005123 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00005124
Hal Finkelf2199b22015-10-23 20:37:08 +00005125 // In general, it is possible for computeKnownBits to determine all bits in a
5126 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00005127 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Craig Topper8205a1a2017-05-24 16:53:07 +00005128 KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00005129 if (Known.isConstant())
5130 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00005131 }
5132
Duncan Sands64e41cf2010-11-17 08:35:29 +00005133 /// If called on unreachable code, the above logic may report that the
5134 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00005135 /// detecting that case here, returning a safe value instead.
5136 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005137}
5138
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00005139/// Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005140/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00005141///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005142/// This is the common implementation of the recursive simplification routines.
5143/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
5144/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
5145/// instructions to process and attempt to simplify it using
5146/// InstructionSimplify.
5147///
5148/// This routine returns 'true' only when *it* simplifies something. The passed
5149/// in simplified value does not count toward this.
5150static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005151 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005152 const DominatorTree *DT,
5153 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005154 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005155 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005156 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00005157
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005158 // If we have an explicit value to collapse to, do that round of the
5159 // simplification loop by hand initially.
5160 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00005161 for (User *U : I->users())
5162 if (U != I)
5163 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00005164
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005165 // Replace the instruction with its simplified value.
5166 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00005167
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005168 // Gracefully handle edge cases where the instruction is not wired into any
5169 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00005170 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
5171 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005172 I->eraseFromParent();
5173 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005174 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00005175 }
Duncan Sands7e800d62010-11-14 11:23:23 +00005176
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005177 // Note that we must test the size on each iteration, the worklist can grow.
5178 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
5179 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00005180
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005181 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005182 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005183 if (!SimpleV)
5184 continue;
5185
5186 Simplified = true;
5187
5188 // Stash away all the uses of the old instruction so we can check them for
5189 // recursive simplifications after a RAUW. This is cheaper than checking all
5190 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005191 for (User *U : I->users())
5192 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005193
5194 // Replace the instruction with its simplified value.
5195 I->replaceAllUsesWith(SimpleV);
5196
5197 // Gracefully handle edge cases where the instruction is not wired into any
5198 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00005199 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
5200 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005201 I->eraseFromParent();
5202 }
5203 return Simplified;
5204}
5205
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005206bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005207 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005208 const DominatorTree *DT,
5209 AssumptionCache *AC) {
5210 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005211}
5212
5213bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005214 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005215 const DominatorTree *DT,
5216 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005217 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
5218 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005219 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00005220}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005221
5222namespace llvm {
5223const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
5224 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
5225 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
5226 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
5227 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
5228 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
5229 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
5230 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5231}
5232
5233const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
5234 const DataLayout &DL) {
5235 return {DL, &AR.TLI, &AR.DT, &AR.AC};
5236}
5237
5238template <class T, class... TArgs>
5239const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
5240 Function &F) {
5241 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
5242 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
5243 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
5244 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5245}
5246template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
5247 Function &);
5248}