blob: ed3ba7778a039ebb370a706fc760f3ca18cd70f0 [file] [log] [blame]
Chris Lattner084a1b52009-11-09 22:57:59 +00001//===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattner084a1b52009-11-09 22:57:59 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This file implements routines for folding instructions into simpler forms
Duncan Sandsa0219882010-11-23 10:50:08 +000010// that do not require creating new instructions. This does constant folding
11// ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
12// returning a constant ("and i32 %x, 0" -> "0") or an already existing value
Duncan Sandsed6d6c32010-12-20 14:47:04 +000013// ("and i32 %x, %x" -> "%x"). All operands are assumed to have already been
14// simplified: This is usually true and assuming it simplifies the logic (if
15// they have not been simplified then results are correct but maybe suboptimal).
Chris Lattner084a1b52009-11-09 22:57:59 +000016//
17//===----------------------------------------------------------------------===//
18
19#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/SetVector.h"
21#include "llvm/ADT/Statistic.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000022#include "llvm/Analysis/AliasAnalysis.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000023#include "llvm/Analysis/AssumptionCache.h"
Anna Thomas43d7e1c2016-05-03 14:58:21 +000024#include "llvm/Analysis/CaptureTracking.h"
Craig Topper0aa3a192017-08-14 21:39:51 +000025#include "llvm/Analysis/CmpInstAnalysis.h"
Chris Lattner084a1b52009-11-09 22:57:59 +000026#include "llvm/Analysis/ConstantFolding.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000027#include "llvm/Analysis/LoopAnalysisManager.h"
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +000028#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000029#include "llvm/Analysis/ValueTracking.h"
David Majnemer599ca442015-07-13 01:15:53 +000030#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000031#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000032#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000033#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000034#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000035#include "llvm/IR/GlobalAlias.h"
36#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000037#include "llvm/IR/PatternMatch.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000038#include "llvm/IR/ValueHandle.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000039#include "llvm/Support/KnownBits.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000040#include <algorithm>
Chris Lattner084a1b52009-11-09 22:57:59 +000041using namespace llvm;
Chris Lattnera71e9d62009-11-10 00:55:12 +000042using namespace llvm::PatternMatch;
Chris Lattner084a1b52009-11-09 22:57:59 +000043
Chandler Carruthf1221bd2014-04-22 02:48:03 +000044#define DEBUG_TYPE "instsimplify"
45
Chris Lattner9e4aa022011-02-09 17:15:04 +000046enum { RecursionLimit = 3 };
Duncan Sandsf3b1bf12010-11-10 18:23:01 +000047
Duncan Sands3547d2e2010-12-22 09:40:51 +000048STATISTIC(NumExpand, "Number of expansions");
Duncan Sands3547d2e2010-12-22 09:40:51 +000049STATISTIC(NumReassoc, "Number of reassociations");
50
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000051static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
52static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000053 unsigned);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +000054static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000055 const SimplifyQuery &, unsigned);
56static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000057 unsigned);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +000058static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000059 const SimplifyQuery &Q, unsigned MaxRecurse);
60static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
61static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
David Majnemer6774d612016-07-26 17:58:05 +000062static Value *SimplifyCastInst(unsigned, Value *, Type *,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000063 const SimplifyQuery &, unsigned);
George Burgess IV8e807bf2018-04-24 00:25:01 +000064static Value *SimplifyGEPInst(Type *, ArrayRef<Value *>, const SimplifyQuery &,
65 unsigned);
Duncan Sands5ffc2982010-11-16 12:16:38 +000066
David Bolvanskyf9476082018-07-28 06:55:51 +000067static Value *foldSelectWithBinaryOp(Value *Cond, Value *TrueVal,
68 Value *FalseVal) {
69 BinaryOperator::BinaryOps BinOpCode;
70 if (auto *BO = dyn_cast<BinaryOperator>(Cond))
71 BinOpCode = BO->getOpcode();
72 else
73 return nullptr;
74
David Bolvansky16d8a692018-07-31 14:17:15 +000075 CmpInst::Predicate ExpectedPred, Pred1, Pred2;
David Bolvanskyf9476082018-07-28 06:55:51 +000076 if (BinOpCode == BinaryOperator::Or) {
77 ExpectedPred = ICmpInst::ICMP_NE;
78 } else if (BinOpCode == BinaryOperator::And) {
79 ExpectedPred = ICmpInst::ICMP_EQ;
80 } else
81 return nullptr;
82
David Bolvansky16d8a692018-07-31 14:17:15 +000083 // %A = icmp eq %TV, %FV
84 // %B = icmp eq %X, %Y (and one of these is a select operand)
85 // %C = and %A, %B
86 // %D = select %C, %TV, %FV
87 // -->
88 // %FV
89
90 // %A = icmp ne %TV, %FV
91 // %B = icmp ne %X, %Y (and one of these is a select operand)
92 // %C = or %A, %B
93 // %D = select %C, %TV, %FV
94 // -->
95 // %TV
96 Value *X, *Y;
97 if (!match(Cond, m_c_BinOp(m_c_ICmp(Pred1, m_Specific(TrueVal),
98 m_Specific(FalseVal)),
99 m_ICmp(Pred2, m_Value(X), m_Value(Y)))) ||
David Bolvanskyf9476082018-07-28 06:55:51 +0000100 Pred1 != Pred2 || Pred1 != ExpectedPred)
101 return nullptr;
102
David Bolvansky16d8a692018-07-31 14:17:15 +0000103 if (X == TrueVal || X == FalseVal || Y == TrueVal || Y == FalseVal)
104 return BinOpCode == BinaryOperator::Or ? TrueVal : FalseVal;
105
106 return nullptr;
David Bolvanskyf9476082018-07-28 06:55:51 +0000107}
108
Sanjay Patel35ed2412017-04-16 17:43:11 +0000109/// For a boolean type or a vector of boolean type, return false or a vector
110/// with every element false.
Duncan Sandsc1c92712011-07-26 15:03:53 +0000111static Constant *getFalse(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +0000112 return ConstantInt::getFalse(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +0000113}
114
Sanjay Patel35ed2412017-04-16 17:43:11 +0000115/// For a boolean type or a vector of boolean type, return true or a vector
116/// with every element true.
Duncan Sandsc1c92712011-07-26 15:03:53 +0000117static Constant *getTrue(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +0000118 return ConstantInt::getTrue(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +0000119}
120
Duncan Sands3d5692a2011-10-30 19:56:36 +0000121/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
122static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
123 Value *RHS) {
124 CmpInst *Cmp = dyn_cast<CmpInst>(V);
125 if (!Cmp)
126 return false;
127 CmpInst::Predicate CPred = Cmp->getPredicate();
128 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
129 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
130 return true;
131 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
132 CRHS == LHS;
133}
134
Sanjay Patel472cc782016-01-11 22:14:42 +0000135/// Does the given value dominate the specified phi node?
Sanjay Patel5da361a2018-04-10 18:38:19 +0000136static bool valueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
Duncan Sands5ffc2982010-11-16 12:16:38 +0000137 Instruction *I = dyn_cast<Instruction>(V);
138 if (!I)
139 // Arguments and constants dominate all instructions.
140 return true;
141
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000142 // If we are processing instructions (and/or basic blocks) that have not been
143 // fully added to a function, the parent nodes may still be null. Simply
144 // return the conservative answer in these cases.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000145 if (!I->getParent() || !P->getParent() || !I->getFunction())
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000146 return false;
147
Duncan Sands5ffc2982010-11-16 12:16:38 +0000148 // If we have a DominatorTree then do a precise test.
Daniel Berlin71ff6632017-05-31 01:47:24 +0000149 if (DT)
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000150 return DT->dominates(I, P);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000151
David Majnemer8a1c45d2015-12-12 05:38:55 +0000152 // Otherwise, if the instruction is in the entry block and is not an invoke,
153 // then it obviously dominates all phi nodes.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000154 if (I->getParent() == &I->getFunction()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000155 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000156 return true;
157
158 return false;
159}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000160
Sanjay Patel472cc782016-01-11 22:14:42 +0000161/// Simplify "A op (B op' C)" by distributing op over op', turning it into
162/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000163/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
164/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
165/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000166static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
Craig Topper9c913bf2017-05-19 16:56:53 +0000167 Instruction::BinaryOps OpcodeToExpand,
168 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000169 // Recursion is always used, so bail out at once if we already hit the limit.
170 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000171 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000172
173 // Check whether the expression has the form "(A op' B) op C".
174 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
175 if (Op0->getOpcode() == OpcodeToExpand) {
176 // It does! Try turning it into "(A op C) op' (B op C)".
177 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
178 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000179 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
180 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000181 // They do! Return "L op' R" if it simplifies or is already available.
182 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000183 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
184 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000185 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000186 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000187 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000188 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000189 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000190 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000191 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000192 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000193 }
194 }
195
196 // Check whether the expression has the form "A op (B op' C)".
197 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
198 if (Op1->getOpcode() == OpcodeToExpand) {
199 // It does! Try turning it into "(A op B) op' (A op C)".
200 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
201 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000202 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
203 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000204 // They do! Return "L op' R" if it simplifies or is already available.
205 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000206 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
207 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000208 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000209 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000210 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000211 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000212 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000213 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000214 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000215 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000216 }
217 }
218
Craig Topper9f008862014-04-15 04:59:12 +0000219 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000220}
221
Sanjay Patel472cc782016-01-11 22:14:42 +0000222/// Generic simplifications for associative binary operations.
223/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000224static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
Craig Topper9c913bf2017-05-19 16:56:53 +0000225 Value *LHS, Value *RHS,
226 const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000227 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000228 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
229
230 // Recursion is always used, so bail out at once if we already hit the limit.
231 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000232 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000233
234 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
235 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
236
237 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
238 if (Op0 && Op0->getOpcode() == Opcode) {
239 Value *A = Op0->getOperand(0);
240 Value *B = Op0->getOperand(1);
241 Value *C = RHS;
242
243 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000244 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000245 // It does! Return "A op V" if it simplifies or is already available.
246 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000247 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000248 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000249 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000250 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000251 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000252 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000253 }
254 }
255
256 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
257 if (Op1 && Op1->getOpcode() == Opcode) {
258 Value *A = LHS;
259 Value *B = Op1->getOperand(0);
260 Value *C = Op1->getOperand(1);
261
262 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000263 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000264 // It does! Return "V op C" if it simplifies or is already available.
265 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000266 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000267 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000268 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000269 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000270 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000271 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000272 }
273 }
274
275 // The remaining transforms require commutativity as well as associativity.
276 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000277 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000278
279 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
280 if (Op0 && Op0->getOpcode() == Opcode) {
281 Value *A = Op0->getOperand(0);
282 Value *B = Op0->getOperand(1);
283 Value *C = RHS;
284
285 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000286 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000287 // It does! Return "V op B" if it simplifies or is already available.
288 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000289 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000290 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000291 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000292 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000293 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000294 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000295 }
296 }
297
298 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
299 if (Op1 && Op1->getOpcode() == Opcode) {
300 Value *A = LHS;
301 Value *B = Op1->getOperand(0);
302 Value *C = Op1->getOperand(1);
303
304 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000305 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000306 // It does! Return "B op V" if it simplifies or is already available.
307 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000308 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000309 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000310 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000311 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000312 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000313 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000314 }
315 }
316
Craig Topper9f008862014-04-15 04:59:12 +0000317 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000318}
319
Sanjay Patel472cc782016-01-11 22:14:42 +0000320/// In the case of a binary operation with a select instruction as an operand,
321/// try to simplify the binop by seeing whether evaluating it on both branches
322/// of the select results in the same value. Returns the common value if so,
323/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000324static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000325 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000326 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000327 // Recursion is always used, so bail out at once if we already hit the limit.
328 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000329 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000330
Duncan Sandsb0579e92010-11-10 13:00:08 +0000331 SelectInst *SI;
332 if (isa<SelectInst>(LHS)) {
333 SI = cast<SelectInst>(LHS);
334 } else {
335 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
336 SI = cast<SelectInst>(RHS);
337 }
338
339 // Evaluate the BinOp on the true and false branches of the select.
340 Value *TV;
341 Value *FV;
342 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000343 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
344 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000345 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000346 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
347 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000348 }
349
Duncan Sandse3c53952011-01-01 16:12:09 +0000350 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000351 // If they both failed to simplify then return null.
352 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000353 return TV;
354
355 // If one branch simplified to undef, return the other one.
356 if (TV && isa<UndefValue>(TV))
357 return FV;
358 if (FV && isa<UndefValue>(FV))
359 return TV;
360
361 // If applying the operation did not change the true and false select values,
362 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000363 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000364 return SI;
365
366 // If one branch simplified and the other did not, and the simplified
367 // value is equal to the unsimplified one, return the simplified value.
368 // For example, select (cond, X, X & Z) & Z -> X & Z.
369 if ((FV && !TV) || (TV && !FV)) {
370 // Check that the simplified value has the form "X op Y" where "op" is the
371 // same as the original operation.
372 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
Zachary Turner260fe3e2017-12-14 22:07:03 +0000373 if (Simplified && Simplified->getOpcode() == unsigned(Opcode)) {
Duncan Sandsb0579e92010-11-10 13:00:08 +0000374 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
375 // We already know that "op" is the same as for the simplified value. See
376 // if the operands match too. If so, return the simplified value.
377 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
378 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
379 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000380 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
381 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000382 return Simplified;
383 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000384 Simplified->getOperand(1) == UnsimplifiedLHS &&
385 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000386 return Simplified;
387 }
388 }
389
Craig Topper9f008862014-04-15 04:59:12 +0000390 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000391}
392
Sanjay Patel472cc782016-01-11 22:14:42 +0000393/// In the case of a comparison with a select instruction, try to simplify the
394/// comparison by seeing whether both branches of the select result in the same
395/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000396static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000397 Value *RHS, const SimplifyQuery &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000398 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000399 // Recursion is always used, so bail out at once if we already hit the limit.
400 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000401 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000402
Duncan Sandsb0579e92010-11-10 13:00:08 +0000403 // Make sure the select is on the LHS.
404 if (!isa<SelectInst>(LHS)) {
405 std::swap(LHS, RHS);
406 Pred = CmpInst::getSwappedPredicate(Pred);
407 }
408 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
409 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000410 Value *Cond = SI->getCondition();
411 Value *TV = SI->getTrueValue();
412 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000413
Duncan Sands06504022011-02-03 09:37:39 +0000414 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000415 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000416 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000417 if (TCmp == Cond) {
418 // It not only simplified, it simplified to the select condition. Replace
419 // it with 'true'.
420 TCmp = getTrue(Cond->getType());
421 } else if (!TCmp) {
422 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
423 // condition then we can replace it with 'true'. Otherwise give up.
424 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000425 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000426 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000427 }
428
Duncan Sands3d5692a2011-10-30 19:56:36 +0000429 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000430 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000431 if (FCmp == Cond) {
432 // It not only simplified, it simplified to the select condition. Replace
433 // it with 'false'.
434 FCmp = getFalse(Cond->getType());
435 } else if (!FCmp) {
436 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
437 // condition then we can replace it with 'false'. Otherwise give up.
438 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000439 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000440 FCmp = getFalse(Cond->getType());
441 }
442
443 // If both sides simplified to the same value, then use it as the result of
444 // the original comparison.
445 if (TCmp == FCmp)
446 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000447
448 // The remaining cases only make sense if the select condition has the same
449 // type as the result of the comparison, so bail out if this is not so.
450 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000451 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000452 // If the false value simplified to false, then the result of the compare
453 // is equal to "Cond && TCmp". This also catches the case when the false
454 // value simplified to false and the true value to true, returning "Cond".
455 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000456 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000457 return V;
458 // If the true value simplified to true, then the result of the compare
459 // is equal to "Cond || FCmp".
460 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000461 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000462 return V;
463 // Finally, if the false value simplified to true and the true value to
464 // false, then the result of the compare is equal to "!Cond".
465 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
466 if (Value *V =
467 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000468 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000469 return V;
470
Craig Topper9f008862014-04-15 04:59:12 +0000471 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000472}
473
Sanjay Patel472cc782016-01-11 22:14:42 +0000474/// In the case of a binary operation with an operand that is a PHI instruction,
475/// try to simplify the binop by seeing whether evaluating it on the incoming
476/// phi values yields the same result for every value. If so returns the common
477/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000478static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000479 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000480 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000481 // Recursion is always used, so bail out at once if we already hit the limit.
482 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000483 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000484
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000485 PHINode *PI;
486 if (isa<PHINode>(LHS)) {
487 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000488 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000489 if (!valueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000490 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000491 } else {
492 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
493 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000494 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000495 if (!valueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000496 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000497 }
498
499 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000500 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000501 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000502 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000503 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000504 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000505 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
506 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000507 // If the operation failed to simplify, or simplified to a different value
508 // to previously, then give up.
509 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000510 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000511 CommonValue = V;
512 }
513
514 return CommonValue;
515}
516
Sanjay Patel472cc782016-01-11 22:14:42 +0000517/// In the case of a comparison with a PHI instruction, try to simplify the
518/// comparison by seeing whether comparing with all of the incoming phi values
519/// yields the same result every time. If so returns the common result,
520/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000521static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000522 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000523 // Recursion is always used, so bail out at once if we already hit the limit.
524 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000525 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000526
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000527 // Make sure the phi is on the LHS.
528 if (!isa<PHINode>(LHS)) {
529 std::swap(LHS, RHS);
530 Pred = CmpInst::getSwappedPredicate(Pred);
531 }
532 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
533 PHINode *PI = cast<PHINode>(LHS);
534
Duncan Sands5ffc2982010-11-16 12:16:38 +0000535 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000536 if (!valueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000537 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000538
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000539 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000540 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000541 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000542 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000543 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000544 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000545 // If the operation failed to simplify, or simplified to a different value
546 // to previously, then give up.
547 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000548 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000549 CommonValue = V;
550 }
551
552 return CommonValue;
553}
554
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000555static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
556 Value *&Op0, Value *&Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000557 const SimplifyQuery &Q) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000558 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
559 if (auto *CRHS = dyn_cast<Constant>(Op1))
560 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
561
562 // Canonicalize the constant to the RHS if this is a commutative operation.
563 if (Instruction::isCommutative(Opcode))
564 std::swap(Op0, Op1);
565 }
566 return nullptr;
567}
568
Sanjay Patel472cc782016-01-11 22:14:42 +0000569/// Given operands for an Add, see if we can fold the result.
570/// If not, this returns null.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000571static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000572 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000573 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
574 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000575
Duncan Sands0a2c41682010-12-15 14:07:39 +0000576 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000577 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000578 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000579
Duncan Sands0a2c41682010-12-15 14:07:39 +0000580 // X + 0 -> X
581 if (match(Op1, m_Zero()))
582 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000583
Chen Zhengfdf13ef2018-07-12 03:06:04 +0000584 // If two operands are negative, return 0.
585 if (isKnownNegation(Op0, Op1))
586 return Constant::getNullValue(Op0->getType());
587
Duncan Sands0a2c41682010-12-15 14:07:39 +0000588 // X + (Y - X) -> Y
589 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000590 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000591 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000592 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
593 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000594 return Y;
595
596 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000597 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000598 if (match(Op0, m_Not(m_Specific(Op1))) ||
599 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000600 return Constant::getAllOnesValue(Ty);
601
Craig Topperbcfd2d12017-04-20 16:56:25 +0000602 // add nsw/nuw (xor Y, signmask), signmask --> Y
Sanjay Patelfe672552017-02-18 21:59:09 +0000603 // The no-wrapping add guarantees that the top bit will be set by the add.
604 // Therefore, the xor must be clearing the already set sign bit of Y.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000605 if ((IsNSW || IsNUW) && match(Op1, m_SignMask()) &&
Craig Topperbcfd2d12017-04-20 16:56:25 +0000606 match(Op0, m_Xor(m_Value(Y), m_SignMask())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000607 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000608
Roman Lebedevb060ce42018-06-08 15:44:47 +0000609 // add nuw %x, -1 -> -1, because %x can only be 0.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000610 if (IsNUW && match(Op1, m_AllOnes()))
Roman Lebedevb060ce42018-06-08 15:44:47 +0000611 return Op1; // Which is -1.
612
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000613 /// i1 add -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000614 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000615 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000616 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000617
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000618 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000619 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000620 MaxRecurse))
621 return V;
622
Duncan Sandsb238de02010-11-19 09:20:39 +0000623 // Threading Add over selects and phi nodes is pointless, so don't bother.
624 // Threading over the select in "A + select(cond, B, C)" means evaluating
625 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
626 // only if B and C are equal. If B and C are equal then (since we assume
627 // that operands have already been simplified) "select(cond, B, C)" should
628 // have been simplified to the common value of B and C already. Analysing
629 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
630 // for threading over phi nodes.
631
Craig Topper9f008862014-04-15 04:59:12 +0000632 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000633}
634
Roman Lebedevf87321a2018-06-08 15:44:53 +0000635Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000636 const SimplifyQuery &Query) {
Roman Lebedevf87321a2018-06-08 15:44:53 +0000637 return ::SimplifyAddInst(Op0, Op1, IsNSW, IsNUW, Query, RecursionLimit);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000638}
639
Adrian Prantl5f8f34e42018-05-01 15:54:18 +0000640/// Compute the base pointer and cumulative constant offsets for V.
Chandler Carrutha0796552012-03-12 11:19:31 +0000641///
642/// This strips all constant offsets off of V, leaving it the base pointer, and
643/// accumulates the total constant offset applied in the returned constant. It
644/// returns 0 if V is not a pointer, and returns the constant '0' if there are
645/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000646///
647/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
648/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
649/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000650static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000651 bool AllowNonInbounds = false) {
Craig Topper95d23472017-07-09 07:04:00 +0000652 assert(V->getType()->isPtrOrPtrVectorTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000653
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000654 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000655 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000656
657 // Even though we don't look through PHI nodes, we could be called on an
658 // instruction in an unreachable block, which may be on a cycle.
659 SmallPtrSet<Value *, 4> Visited;
660 Visited.insert(V);
661 do {
662 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000663 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000664 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000665 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000666 V = GEP->getPointerOperand();
667 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000668 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000669 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000670 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000671 break;
672 V = GA->getAliasee();
673 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000674 if (auto CS = CallSite(V))
675 if (Value *RV = CS.getReturnedArgOperand()) {
676 V = RV;
677 continue;
678 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000679 break;
680 }
Craig Topper95d23472017-07-09 07:04:00 +0000681 assert(V->getType()->isPtrOrPtrVectorTy() && "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000682 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000683
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000684 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
685 if (V->getType()->isVectorTy())
686 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
687 OffsetIntPtr);
688 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000689}
690
Adrian Prantl5f8f34e42018-05-01 15:54:18 +0000691/// Compute the constant difference between two pointer values.
Chandler Carrutha0796552012-03-12 11:19:31 +0000692/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000693static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
694 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000695 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
696 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000697
698 // If LHS and RHS are not related via constant offsets to the same base
699 // value, there is nothing we can do here.
700 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000701 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000702
703 // Otherwise, the difference of LHS - RHS can be computed as:
704 // LHS - RHS
705 // = (LHSOffset + Base) - (RHSOffset + Base)
706 // = LHSOffset - RHSOffset
707 return ConstantExpr::getSub(LHSOffset, RHSOffset);
708}
709
Sanjay Patel472cc782016-01-11 22:14:42 +0000710/// Given operands for a Sub, see if we can fold the result.
711/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000712static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000713 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000714 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
715 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000716
717 // X - undef -> undef
718 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000719 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000720 return UndefValue::get(Op0->getType());
721
722 // X - 0 -> X
723 if (match(Op1, m_Zero()))
724 return Op0;
725
726 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000727 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000728 return Constant::getNullValue(Op0->getType());
729
Sanjay Patelefd88852016-10-19 21:23:45 +0000730 // Is this a negation?
731 if (match(Op0, m_Zero())) {
732 // 0 - X -> 0 if the sub is NUW.
733 if (isNUW)
Sanjay Patel30be6652018-04-22 17:07:44 +0000734 return Constant::getNullValue(Op0->getType());
Sanjay Patelefd88852016-10-19 21:23:45 +0000735
Craig Topper8205a1a2017-05-24 16:53:07 +0000736 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +0000737 if (Known.Zero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000738 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
739 // Op1 must be 0 because negating the minimum signed value is undefined.
740 if (isNSW)
Sanjay Patel30be6652018-04-22 17:07:44 +0000741 return Constant::getNullValue(Op0->getType());
Sanjay Patelefd88852016-10-19 21:23:45 +0000742
743 // 0 - X -> X if X is 0 or the minimum signed value.
744 return Op1;
745 }
746 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000747
Duncan Sands99589d02011-01-18 11:50:19 +0000748 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
749 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000750 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000751 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
752 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000753 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000754 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000755 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000756 // It does, we successfully reassociated!
757 ++NumReassoc;
758 return W;
759 }
760 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000761 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000762 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000763 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000764 // It does, we successfully reassociated!
765 ++NumReassoc;
766 return W;
767 }
768 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000769
Duncan Sands99589d02011-01-18 11:50:19 +0000770 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
771 // For example, X - (X + 1) -> -1
772 X = Op0;
773 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
774 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000775 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000776 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000777 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000778 // It does, we successfully reassociated!
779 ++NumReassoc;
780 return W;
781 }
782 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000783 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000784 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000785 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000786 // It does, we successfully reassociated!
787 ++NumReassoc;
788 return W;
789 }
790 }
791
792 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
793 // For example, X - (X - Y) -> Y.
794 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000795 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
796 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000797 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000798 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000799 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000800 // It does, we successfully reassociated!
801 ++NumReassoc;
802 return W;
803 }
804
Duncan Sands395ac42d2012-03-13 14:07:05 +0000805 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
806 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
807 match(Op1, m_Trunc(m_Value(Y))))
808 if (X->getType() == Y->getType())
809 // See if "V === X - Y" simplifies.
810 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
811 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000812 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
813 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000814 // It does, return the simplified "trunc V".
815 return W;
816
817 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000818 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000819 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000820 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000821 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
822
Duncan Sands99589d02011-01-18 11:50:19 +0000823 // i1 sub -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000824 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000825 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000826 return V;
827
Duncan Sands0a2c41682010-12-15 14:07:39 +0000828 // Threading Sub over selects and phi nodes is pointless, so don't bother.
829 // Threading over the select in "A - select(cond, B, C)" means evaluating
830 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
831 // only if B and C are equal. If B and C are equal then (since we assume
832 // that operands have already been simplified) "select(cond, B, C)" should
833 // have been simplified to the common value of B and C already. Analysing
834 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
835 // for threading over phi nodes.
836
Craig Topper9f008862014-04-15 04:59:12 +0000837 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000838}
839
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000840Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000841 const SimplifyQuery &Q) {
842 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
843}
844
Sanjay Patel472cc782016-01-11 22:14:42 +0000845/// Given operands for a Mul, see if we can fold the result.
846/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000847static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000848 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000849 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
850 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000851
852 // X * undef -> 0
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000853 // X * 0 -> 0
Sanjay Patel30be6652018-04-22 17:07:44 +0000854 if (match(Op1, m_CombineOr(m_Undef(), m_Zero())))
855 return Constant::getNullValue(Op0->getType());
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000856
857 // X * 1 -> X
858 if (match(Op1, m_One()))
859 return Op0;
860
Duncan Sandsb67edc62011-01-30 18:03:50 +0000861 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000862 Value *X = nullptr;
Florian Hahn19f9e322018-08-17 14:39:04 +0000863 if (Q.IIQ.UseInstrInfo &&
864 (match(Op0,
865 m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
866 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0)))))) // Y * (X / Y)
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000867 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000868
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000869 // i1 mul -> and.
Craig Topperfde47232017-07-09 07:04:03 +0000870 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000871 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000872 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000873
874 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000875 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000876 MaxRecurse))
877 return V;
878
Dmitry Venikovd2257be2018-01-02 05:47:42 +0000879 // Mul distributes over Add. Try some generic simplifications based on this.
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000880 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000881 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000882 return V;
883
884 // If the operation is with the result of a select instruction, check whether
885 // operating on either branch of the select always yields the same value.
886 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000887 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000888 MaxRecurse))
889 return V;
890
891 // If the operation is with the result of a phi instruction, check whether
892 // operating on all incoming values of the phi always yields the same value.
893 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000894 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000895 MaxRecurse))
896 return V;
897
Craig Topper9f008862014-04-15 04:59:12 +0000898 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000899}
900
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000901Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
902 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
903}
904
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000905/// Check for common or similar folds of integer division or integer remainder.
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000906/// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000907static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
908 Type *Ty = Op0->getType();
909
910 // X / undef -> undef
911 // X % undef -> undef
912 if (match(Op1, m_Undef()))
913 return Op1;
914
915 // X / 0 -> undef
916 // X % 0 -> undef
917 // We don't need to preserve faults!
918 if (match(Op1, m_Zero()))
919 return UndefValue::get(Ty);
920
Zvi Rackover51f0d642018-01-24 17:22:00 +0000921 // If any element of a constant divisor vector is zero or undef, the whole op
922 // is undef.
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000923 auto *Op1C = dyn_cast<Constant>(Op1);
924 if (Op1C && Ty->isVectorTy()) {
925 unsigned NumElts = Ty->getVectorNumElements();
926 for (unsigned i = 0; i != NumElts; ++i) {
927 Constant *Elt = Op1C->getAggregateElement(i);
Zvi Rackover51f0d642018-01-24 17:22:00 +0000928 if (Elt && (Elt->isNullValue() || isa<UndefValue>(Elt)))
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000929 return UndefValue::get(Ty);
930 }
931 }
932
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000933 // undef / X -> 0
934 // undef % X -> 0
935 if (match(Op0, m_Undef()))
936 return Constant::getNullValue(Ty);
937
938 // 0 / X -> 0
939 // 0 % X -> 0
940 if (match(Op0, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +0000941 return Constant::getNullValue(Op0->getType());
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000942
943 // X / X -> 1
944 // X % X -> 0
945 if (Op0 == Op1)
946 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
947
948 // X / 1 -> X
949 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +0000950 // If this is a boolean op (single-bit element type), we can't have
951 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
Sanjay Patel1e911fa2018-06-25 18:51:21 +0000952 // Similarly, if we're zero-extending a boolean divisor, then assume it's a 1.
953 Value *X;
954 if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1) ||
955 (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000956 return IsDiv ? Op0 : Constant::getNullValue(Ty);
957
958 return nullptr;
959}
960
Sanjay Patelcca8f782017-09-14 14:09:11 +0000961/// Given a predicate and two operands, return true if the comparison is true.
962/// This is a helper for div/rem simplification where we return some other value
963/// when we can prove a relationship between the operands.
964static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
965 const SimplifyQuery &Q, unsigned MaxRecurse) {
966 Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
967 Constant *C = dyn_cast_or_null<Constant>(V);
968 return (C && C->isAllOnesValue());
969}
970
971/// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
972/// to simplify X % Y to X.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000973static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
Sanjay Patelcca8f782017-09-14 14:09:11 +0000974 unsigned MaxRecurse, bool IsSigned) {
975 // Recursion is always used, so bail out at once if we already hit the limit.
976 if (!MaxRecurse--)
977 return false;
978
979 if (IsSigned) {
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000980 // |X| / |Y| --> 0
981 //
982 // We require that 1 operand is a simple constant. That could be extended to
983 // 2 variables if we computed the sign bit for each.
984 //
985 // Make sure that a constant is not the minimum signed value because taking
986 // the abs() of that is undefined.
987 Type *Ty = X->getType();
988 const APInt *C;
989 if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
990 // Is the variable divisor magnitude always greater than the constant
991 // dividend magnitude?
992 // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
993 Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
994 Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
995 if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
996 isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
997 return true;
998 }
999 if (match(Y, m_APInt(C))) {
1000 // Special-case: we can't take the abs() of a minimum signed value. If
1001 // that's the divisor, then all we have to do is prove that the dividend
1002 // is also not the minimum signed value.
1003 if (C->isMinSignedValue())
1004 return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
1005
1006 // Is the variable dividend magnitude always less than the constant
1007 // divisor magnitude?
1008 // |X| < |C| --> X > -abs(C) and X < abs(C)
1009 Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
1010 Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
1011 if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
1012 isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
1013 return true;
1014 }
Sanjay Patelcca8f782017-09-14 14:09:11 +00001015 return false;
1016 }
1017
1018 // IsSigned == false.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +00001019 // Is the dividend unsigned less than the divisor?
1020 return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
Sanjay Patelcca8f782017-09-14 14:09:11 +00001021}
1022
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001023/// These are simplifications common to SDiv and UDiv.
1024static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001025 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001026 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1027 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001028
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001029 if (Value *V = simplifyDivRem(Op0, Op1, true))
1030 return V;
1031
Sanjay Patelcca8f782017-09-14 14:09:11 +00001032 bool IsSigned = Opcode == Instruction::SDiv;
Duncan Sands65995fa2011-01-28 18:50:50 +00001033
Duncan Sands771e82a2011-01-28 16:51:11 +00001034 // (X * Y) / Y -> X if the multiplication does not overflow.
Sanjay Patel33cb8452018-01-19 16:12:55 +00001035 Value *X;
1036 if (match(Op0, m_c_Mul(m_Value(X), m_Specific(Op1)))) {
1037 auto *Mul = cast<OverflowingBinaryOperator>(Op0);
1038 // If the Mul does not overflow, then we are good to go.
Florian Hahn19f9e322018-08-17 14:39:04 +00001039 if ((IsSigned && Q.IIQ.hasNoSignedWrap(Mul)) ||
1040 (!IsSigned && Q.IIQ.hasNoUnsignedWrap(Mul)))
Duncan Sands5747aba2011-02-02 20:52:00 +00001041 return X;
Sanjay Patel33cb8452018-01-19 16:12:55 +00001042 // If X has the form X = A / Y, then X * Y cannot overflow.
1043 if ((IsSigned && match(X, m_SDiv(m_Value(), m_Specific(Op1)))) ||
1044 (!IsSigned && match(X, m_UDiv(m_Value(), m_Specific(Op1)))))
1045 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001046 }
1047
Duncan Sands65995fa2011-01-28 18:50:50 +00001048 // (X rem Y) / Y -> 0
Sanjay Patelcca8f782017-09-14 14:09:11 +00001049 if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1050 (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
Duncan Sands65995fa2011-01-28 18:50:50 +00001051 return Constant::getNullValue(Op0->getType());
1052
David Majnemercb9d5962014-10-11 10:20:01 +00001053 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1054 ConstantInt *C1, *C2;
Sanjay Patelcca8f782017-09-14 14:09:11 +00001055 if (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
David Majnemercb9d5962014-10-11 10:20:01 +00001056 match(Op1, m_ConstantInt(C2))) {
1057 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001058 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001059 if (Overflow)
1060 return Constant::getNullValue(Op0->getType());
1061 }
1062
Duncan Sands65995fa2011-01-28 18:50:50 +00001063 // If the operation is with the result of a select instruction, check whether
1064 // operating on either branch of the select always yields the same value.
1065 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001066 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001067 return V;
1068
1069 // If the operation is with the result of a phi instruction, check whether
1070 // operating on all incoming values of the phi always yields the same value.
1071 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001072 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001073 return V;
1074
Sanjay Patelcca8f782017-09-14 14:09:11 +00001075 if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1076 return Constant::getNullValue(Op0->getType());
1077
Craig Topper9f008862014-04-15 04:59:12 +00001078 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001079}
1080
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001081/// These are simplifications common to SRem and URem.
1082static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001083 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001084 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1085 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001086
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001087 if (Value *V = simplifyDivRem(Op0, Op1, false))
1088 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001089
David Majnemerb435a422014-09-17 04:16:35 +00001090 // (X % Y) % Y -> X % Y
1091 if ((Opcode == Instruction::SRem &&
1092 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1093 (Opcode == Instruction::URem &&
1094 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001095 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001096
Anton Bikineev82f61152018-01-23 09:27:47 +00001097 // (X << Y) % X -> 0
Florian Hahn19f9e322018-08-17 14:39:04 +00001098 if (Q.IIQ.UseInstrInfo &&
1099 ((Opcode == Instruction::SRem &&
1100 match(Op0, m_NSWShl(m_Specific(Op1), m_Value()))) ||
1101 (Opcode == Instruction::URem &&
1102 match(Op0, m_NUWShl(m_Specific(Op1), m_Value())))))
Anton Bikineev82f61152018-01-23 09:27:47 +00001103 return Constant::getNullValue(Op0->getType());
1104
Duncan Sandsa3e36992011-05-02 16:27:02 +00001105 // If the operation is with the result of a select instruction, check whether
1106 // operating on either branch of the select always yields the same value.
1107 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001108 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001109 return V;
1110
1111 // If the operation is with the result of a phi instruction, check whether
1112 // operating on all incoming values of the phi always yields the same value.
1113 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001114 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001115 return V;
1116
Sanjay Patelcca8f782017-09-14 14:09:11 +00001117 // If X / Y == 0, then X % Y == X.
1118 if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1119 return Op0;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001120
1121 return nullptr;
1122}
1123
1124/// Given operands for an SDiv, see if we can fold the result.
1125/// If not, this returns null.
1126static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1127 unsigned MaxRecurse) {
Chen Zheng69bb0642018-07-21 12:27:54 +00001128 // If two operands are negated and no signed overflow, return -1.
1129 if (isKnownNegation(Op0, Op1, /*NeedNSW=*/true))
1130 return Constant::getAllOnesValue(Op0->getType());
1131
Sanjay Patelcca8f782017-09-14 14:09:11 +00001132 return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001133}
1134
1135Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1136 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1137}
1138
1139/// Given operands for a UDiv, see if we can fold the result.
1140/// If not, this returns null.
1141static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1142 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001143 return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001144}
1145
1146Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1147 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1148}
1149
Sanjay Patel472cc782016-01-11 22:14:42 +00001150/// Given operands for an SRem, see if we can fold the result.
1151/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001152static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001153 unsigned MaxRecurse) {
Sanjay Patel2b7e3102018-06-26 15:32:54 +00001154 // If the divisor is 0, the result is undefined, so assume the divisor is -1.
1155 // srem Op0, (sext i1 X) --> srem Op0, -1 --> 0
1156 Value *X;
1157 if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
1158 return ConstantInt::getNullValue(Op0->getType());
1159
Chen Zhengf801d0f2018-07-20 13:00:47 +00001160 // If the two operands are negated, return 0.
1161 if (isKnownNegation(Op0, Op1))
Chen Zheng69bb0642018-07-21 12:27:54 +00001162 return ConstantInt::getNullValue(Op0->getType());
Chen Zhengf801d0f2018-07-20 13:00:47 +00001163
Sanjay Patelcca8f782017-09-14 14:09:11 +00001164 return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001165}
1166
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001167Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1168 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1169}
1170
Sanjay Patel472cc782016-01-11 22:14:42 +00001171/// Given operands for a URem, see if we can fold the result.
1172/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001173static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001174 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001175 return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001176}
1177
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001178Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1179 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1180}
1181
Sanjay Patel472cc782016-01-11 22:14:42 +00001182/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001183static bool isUndefShift(Value *Amount) {
1184 Constant *C = dyn_cast<Constant>(Amount);
1185 if (!C)
1186 return false;
1187
1188 // X shift by undef -> undef because it may shift by the bitwidth.
1189 if (isa<UndefValue>(C))
1190 return true;
1191
1192 // Shifting by the bitwidth or more is undefined.
1193 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1194 if (CI->getValue().getLimitedValue() >=
1195 CI->getType()->getScalarSizeInBits())
1196 return true;
1197
1198 // If all lanes of a vector shift are undefined the whole shift is.
1199 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1200 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1201 if (!isUndefShift(C->getAggregateElement(I)))
1202 return false;
1203 return true;
1204 }
1205
1206 return false;
1207}
1208
Sanjay Patel472cc782016-01-11 22:14:42 +00001209/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1210/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001211static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001212 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001213 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1214 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001215
Duncan Sands571fd9a2011-01-14 14:44:12 +00001216 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001217 if (match(Op0, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +00001218 return Constant::getNullValue(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001219
Duncan Sands571fd9a2011-01-14 14:44:12 +00001220 // X shift by 0 -> X
Sanjay Patelad0bfb82018-06-26 17:31:38 +00001221 // Shift-by-sign-extended bool must be shift-by-0 because shift-by-all-ones
1222 // would be poison.
1223 Value *X;
1224 if (match(Op1, m_Zero()) ||
1225 (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
Duncan Sands7f60dc12011-01-14 00:37:45 +00001226 return Op0;
1227
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001228 // Fold undefined shifts.
1229 if (isUndefShift(Op1))
1230 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001231
Duncan Sands571fd9a2011-01-14 14:44:12 +00001232 // If the operation is with the result of a select instruction, check whether
1233 // operating on either branch of the select always yields the same value.
1234 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001235 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001236 return V;
1237
1238 // If the operation is with the result of a phi instruction, check whether
1239 // operating on all incoming values of the phi always yields the same value.
1240 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001241 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001242 return V;
1243
Sanjay Patel6786bc52016-05-10 20:46:54 +00001244 // If any bits in the shift amount make that value greater than or equal to
1245 // the number of bits in the type, the shift is undefined.
Craig Topper8205a1a2017-05-24 16:53:07 +00001246 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1247 if (Known.One.getLimitedValue() >= Known.getBitWidth())
Sanjay Patel6786bc52016-05-10 20:46:54 +00001248 return UndefValue::get(Op0->getType());
1249
1250 // If all valid bits in the shift amount are known zero, the first operand is
1251 // unchanged.
Craig Topper8205a1a2017-05-24 16:53:07 +00001252 unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
Craig Topper8df66c62017-05-12 17:20:30 +00001253 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001254 return Op0;
1255
Craig Topper9f008862014-04-15 04:59:12 +00001256 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001257}
1258
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001259/// Given operands for an Shl, LShr or AShr, see if we can
David Majnemerbf7550e2014-11-05 00:59:59 +00001260/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001261static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001262 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001263 unsigned MaxRecurse) {
1264 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1265 return V;
1266
1267 // X >> X -> 0
1268 if (Op0 == Op1)
1269 return Constant::getNullValue(Op0->getType());
1270
David Majnemer65c52ae2014-12-17 01:54:33 +00001271 // undef >> X -> 0
1272 // undef >> X -> undef (if it's exact)
1273 if (match(Op0, m_Undef()))
1274 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1275
David Majnemerbf7550e2014-11-05 00:59:59 +00001276 // The low bit cannot be shifted out of an exact shift if it is set.
1277 if (isExact) {
Craig Topper8205a1a2017-05-24 16:53:07 +00001278 KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +00001279 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001280 return Op0;
1281 }
1282
1283 return nullptr;
1284}
1285
Sanjay Patel472cc782016-01-11 22:14:42 +00001286/// Given operands for an Shl, see if we can fold the result.
1287/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001288static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001289 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001290 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001291 return V;
1292
1293 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001294 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001295 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001296 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001297
Chris Lattner9e4aa022011-02-09 17:15:04 +00001298 // (X >> A) << A -> X
1299 Value *X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001300 if (Q.IIQ.UseInstrInfo &&
1301 match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001302 return X;
Roman Lebedev26838022018-06-07 20:03:45 +00001303
1304 // shl nuw i8 C, %x -> C iff C has sign bit set.
1305 if (isNUW && match(Op0, m_Negative()))
1306 return Op0;
1307 // NOTE: could use computeKnownBits() / LazyValueInfo,
1308 // but the cost-benefit analysis suggests it isn't worth it.
1309
Craig Topper9f008862014-04-15 04:59:12 +00001310 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001311}
1312
Chris Lattner9e4aa022011-02-09 17:15:04 +00001313Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001314 const SimplifyQuery &Q) {
1315 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1316}
1317
Sanjay Patel472cc782016-01-11 22:14:42 +00001318/// Given operands for an LShr, see if we can fold the result.
1319/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001320static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001321 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001322 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1323 MaxRecurse))
1324 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001325
Chris Lattner9e4aa022011-02-09 17:15:04 +00001326 // (X << A) >> A -> X
1327 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001328 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001329 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001330
Hiroshi Inoue02f79ea2018-08-01 04:40:32 +00001331 // ((X << A) | Y) >> A -> X if effective width of Y is not larger than A.
1332 // We can return X as we do in the above case since OR alters no bits in X.
1333 // SimplifyDemandedBits in InstCombine can do more general optimization for
1334 // bit manipulation. This pattern aims to provide opportunities for other
1335 // optimizers by supporting a simple but common case in InstSimplify.
1336 Value *Y;
1337 const APInt *ShRAmt, *ShLAmt;
1338 if (match(Op1, m_APInt(ShRAmt)) &&
1339 match(Op0, m_c_Or(m_NUWShl(m_Value(X), m_APInt(ShLAmt)), m_Value(Y))) &&
1340 *ShRAmt == *ShLAmt) {
1341 const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1342 const unsigned Width = Op0->getType()->getScalarSizeInBits();
1343 const unsigned EffWidthY = Width - YKnown.countMinLeadingZeros();
Benjamin Kramerbae6aab2018-08-12 11:43:03 +00001344 if (ShRAmt->uge(EffWidthY))
Hiroshi Inoue02f79ea2018-08-01 04:40:32 +00001345 return X;
1346 }
1347
Craig Topper9f008862014-04-15 04:59:12 +00001348 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001349}
1350
Chris Lattner9e4aa022011-02-09 17:15:04 +00001351Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001352 const SimplifyQuery &Q) {
1353 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1354}
1355
Sanjay Patel472cc782016-01-11 22:14:42 +00001356/// Given operands for an AShr, see if we can fold the result.
1357/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001358static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001359 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001360 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1361 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001362 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001363
Sanjay Pateladf6e882018-02-18 18:05:08 +00001364 // all ones >>a X -> -1
1365 // Do not return Op0 because it may contain undef elements if it's a vector.
Duncan Sands7f60dc12011-01-14 00:37:45 +00001366 if (match(Op0, m_AllOnes()))
Sanjay Pateladf6e882018-02-18 18:05:08 +00001367 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001368
Chris Lattner9e4aa022011-02-09 17:15:04 +00001369 // (X << A) >> A -> X
1370 Value *X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001371 if (Q.IIQ.UseInstrInfo && match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001372 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001373
Suyog Sarda68862412014-07-17 06:28:15 +00001374 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001375 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001376 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1377 return Op0;
1378
Craig Topper9f008862014-04-15 04:59:12 +00001379 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001380}
1381
Chris Lattner9e4aa022011-02-09 17:15:04 +00001382Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001383 const SimplifyQuery &Q) {
1384 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1385}
1386
Craig Topper348314d2017-05-26 22:42:34 +00001387/// Commuted variants are assumed to be handled by calling this function again
1388/// with the parameters swapped.
David Majnemer1af36e52014-12-06 10:51:40 +00001389static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1390 ICmpInst *UnsignedICmp, bool IsAnd) {
1391 Value *X, *Y;
1392
1393 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001394 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1395 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001396 return nullptr;
1397
1398 ICmpInst::Predicate UnsignedPred;
1399 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1400 ICmpInst::isUnsigned(UnsignedPred))
1401 ;
1402 else if (match(UnsignedICmp,
Sanjay Patel0c57de42018-06-20 14:22:49 +00001403 m_ICmp(UnsignedPred, m_Specific(Y), m_Value(X))) &&
David Majnemer1af36e52014-12-06 10:51:40 +00001404 ICmpInst::isUnsigned(UnsignedPred))
1405 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1406 else
1407 return nullptr;
1408
1409 // X < Y && Y != 0 --> X < Y
1410 // X < Y || Y != 0 --> Y != 0
1411 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1412 return IsAnd ? UnsignedICmp : ZeroICmp;
1413
1414 // X >= Y || Y != 0 --> true
1415 // X >= Y || Y == 0 --> X >= Y
1416 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1417 if (EqPred == ICmpInst::ICMP_NE)
1418 return getTrue(UnsignedICmp->getType());
1419 return UnsignedICmp;
1420 }
1421
David Majnemerd5b3aa42014-12-08 18:30:43 +00001422 // X < Y && Y == 0 --> false
1423 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1424 IsAnd)
1425 return getFalse(UnsignedICmp->getType());
1426
David Majnemer1af36e52014-12-06 10:51:40 +00001427 return nullptr;
1428}
1429
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001430/// Commuted variants are assumed to be handled by calling this function again
1431/// with the parameters swapped.
1432static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1433 ICmpInst::Predicate Pred0, Pred1;
1434 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001435 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1436 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001437 return nullptr;
1438
1439 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1440 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1441 // can eliminate Op1 from this 'and'.
1442 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1443 return Op0;
1444
1445 // Check for any combination of predicates that are guaranteed to be disjoint.
1446 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1447 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1448 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1449 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1450 return getFalse(Op0->getType());
1451
1452 return nullptr;
1453}
1454
1455/// Commuted variants are assumed to be handled by calling this function again
1456/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001457static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1458 ICmpInst::Predicate Pred0, Pred1;
1459 Value *A ,*B;
1460 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1461 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1462 return nullptr;
1463
1464 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1465 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1466 // can eliminate Op0 from this 'or'.
1467 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1468 return Op1;
1469
1470 // Check for any combination of predicates that cover the entire range of
1471 // possibilities.
1472 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1473 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1474 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1475 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1476 return getTrue(Op0->getType());
1477
1478 return nullptr;
1479}
1480
Sanjay Patel599e65b2017-05-07 15:11:40 +00001481/// Test if a pair of compares with a shared operand and 2 constants has an
1482/// empty set intersection, full set union, or if one compare is a superset of
1483/// the other.
1484static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1485 bool IsAnd) {
1486 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1487 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1488 return nullptr;
1489
1490 const APInt *C0, *C1;
1491 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1492 !match(Cmp1->getOperand(1), m_APInt(C1)))
1493 return nullptr;
1494
1495 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1496 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1497
Sanjay Patel67454472017-05-08 16:35:02 +00001498 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001499 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1500 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1501 return getFalse(Cmp0->getType());
1502
1503 // For or-of-compares, check if the union is full:
1504 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1505 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1506 return getTrue(Cmp0->getType());
1507
1508 // Is one range a superset of the other?
1509 // If this is and-of-compares, take the smaller set:
1510 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1511 // If this is or-of-compares, take the larger set:
1512 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1513 if (Range0.contains(Range1))
1514 return IsAnd ? Cmp1 : Cmp0;
1515 if (Range1.contains(Range0))
1516 return IsAnd ? Cmp0 : Cmp1;
1517
1518 return nullptr;
1519}
1520
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001521static Value *simplifyAndOrOfICmpsWithZero(ICmpInst *Cmp0, ICmpInst *Cmp1,
1522 bool IsAnd) {
1523 ICmpInst::Predicate P0 = Cmp0->getPredicate(), P1 = Cmp1->getPredicate();
1524 if (!match(Cmp0->getOperand(1), m_Zero()) ||
1525 !match(Cmp1->getOperand(1), m_Zero()) || P0 != P1)
1526 return nullptr;
1527
1528 if ((IsAnd && P0 != ICmpInst::ICMP_NE) || (!IsAnd && P1 != ICmpInst::ICMP_EQ))
1529 return nullptr;
1530
Sanjay Patel4158eff2018-01-13 15:44:44 +00001531 // We have either "(X == 0 || Y == 0)" or "(X != 0 && Y != 0)".
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001532 Value *X = Cmp0->getOperand(0);
1533 Value *Y = Cmp1->getOperand(0);
1534
1535 // If one of the compares is a masked version of a (not) null check, then
Sanjay Patel4158eff2018-01-13 15:44:44 +00001536 // that compare implies the other, so we eliminate the other. Optionally, look
1537 // through a pointer-to-int cast to match a null check of a pointer type.
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001538
Sanjay Patel9568f422018-01-14 15:58:18 +00001539 // (X == 0) || (([ptrtoint] X & ?) == 0) --> ([ptrtoint] X & ?) == 0
1540 // (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
Sanjay Patel4158eff2018-01-13 15:44:44 +00001543 if (match(Y, m_c_And(m_Specific(X), m_Value())) ||
1544 match(Y, m_c_And(m_PtrToInt(m_Specific(X)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001545 return Cmp1;
1546
Sanjay Patel9568f422018-01-14 15:58:18 +00001547 // (([ptrtoint] Y & ?) == 0) || (Y == 0) --> ([ptrtoint] Y & ?) == 0
1548 // ((? & [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
Sanjay Patel4158eff2018-01-13 15:44:44 +00001551 if (match(X, m_c_And(m_Specific(Y), m_Value())) ||
1552 match(X, m_c_And(m_PtrToInt(m_Specific(Y)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001553 return Cmp0;
1554
1555 return nullptr;
1556}
1557
Florian Hahn19f9e322018-08-17 14:39:04 +00001558static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1,
1559 const InstrInfoQuery &IIQ) {
Sanjay Patel599e65b2017-05-07 15:11:40 +00001560 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001561 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001562 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001563 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001564 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001565 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001566
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001567 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001568 return nullptr;
1569
Florian Hahn19f9e322018-08-17 14:39:04 +00001570 auto *AddInst = cast<OverflowingBinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001571 if (AddInst->getOperand(1) != Op1->getOperand(1))
1572 return nullptr;
1573
Craig Topper9bce1ad2017-05-26 19:04:02 +00001574 Type *ITy = Op0->getType();
Florian Hahn19f9e322018-08-17 14:39:04 +00001575 bool isNSW = IIQ.hasNoSignedWrap(AddInst);
1576 bool isNUW = IIQ.hasNoUnsignedWrap(AddInst);
David Majnemera315bd82014-09-15 08:15:28 +00001577
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001578 const APInt Delta = *C1 - *C0;
1579 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001580 if (Delta == 2) {
1581 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1582 return getFalse(ITy);
1583 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1584 return getFalse(ITy);
1585 }
1586 if (Delta == 1) {
1587 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1588 return getFalse(ITy);
1589 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1590 return getFalse(ITy);
1591 }
1592 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001593 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001594 if (Delta == 2)
1595 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1596 return getFalse(ITy);
1597 if (Delta == 1)
1598 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1599 return getFalse(ITy);
1600 }
1601
1602 return nullptr;
1603}
1604
Florian Hahn19f9e322018-08-17 14:39:04 +00001605static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1,
1606 const InstrInfoQuery &IIQ) {
Craig Topper348314d2017-05-26 22:42:34 +00001607 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1608 return X;
1609 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
Sanjay Patel142cb832017-05-04 18:19:17 +00001610 return X;
1611
Craig Topper348314d2017-05-26 22:42:34 +00001612 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1613 return X;
1614 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
Sanjay Patel142cb832017-05-04 18:19:17 +00001615 return X;
1616
Craig Topper348314d2017-05-26 22:42:34 +00001617 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
Sanjay Patel599e65b2017-05-07 15:11:40 +00001618 return X;
1619
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001620 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, true))
1621 return X;
1622
Florian Hahn19f9e322018-08-17 14:39:04 +00001623 if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001624 return X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001625 if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001626 return X;
1627
1628 return nullptr;
1629}
1630
Florian Hahn19f9e322018-08-17 14:39:04 +00001631static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1,
1632 const InstrInfoQuery &IIQ) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001633 // (icmp (add V, C0), C1) | (icmp V, C0)
1634 ICmpInst::Predicate Pred0, Pred1;
1635 const APInt *C0, *C1;
1636 Value *V;
1637 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1638 return nullptr;
1639
1640 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1641 return nullptr;
1642
1643 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1644 if (AddInst->getOperand(1) != Op1->getOperand(1))
1645 return nullptr;
1646
1647 Type *ITy = Op0->getType();
Florian Hahn19f9e322018-08-17 14:39:04 +00001648 bool isNSW = IIQ.hasNoSignedWrap(AddInst);
1649 bool isNUW = IIQ.hasNoUnsignedWrap(AddInst);
Sanjay Patel142cb832017-05-04 18:19:17 +00001650
1651 const APInt Delta = *C1 - *C0;
1652 if (C0->isStrictlyPositive()) {
1653 if (Delta == 2) {
1654 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1655 return getTrue(ITy);
1656 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1657 return getTrue(ITy);
1658 }
1659 if (Delta == 1) {
1660 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1661 return getTrue(ITy);
1662 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1663 return getTrue(ITy);
1664 }
1665 }
1666 if (C0->getBoolValue() && isNUW) {
1667 if (Delta == 2)
1668 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1669 return getTrue(ITy);
1670 if (Delta == 1)
1671 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1672 return getTrue(ITy);
1673 }
1674
1675 return nullptr;
1676}
1677
Florian Hahn19f9e322018-08-17 14:39:04 +00001678static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1,
1679 const InstrInfoQuery &IIQ) {
Craig Topper348314d2017-05-26 22:42:34 +00001680 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1681 return X;
1682 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1683 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001684
Craig Topper348314d2017-05-26 22:42:34 +00001685 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1686 return X;
1687 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1688 return X;
1689
1690 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1691 return X;
1692
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001693 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, false))
1694 return X;
1695
Florian Hahn19f9e322018-08-17 14:39:04 +00001696 if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001697 return X;
Florian Hahn19f9e322018-08-17 14:39:04 +00001698 if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0, IIQ))
Craig Topper348314d2017-05-26 22:42:34 +00001699 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001700
1701 return nullptr;
1702}
1703
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001704static Value *simplifyAndOrOfFCmps(const TargetLibraryInfo *TLI,
1705 FCmpInst *LHS, FCmpInst *RHS, bool IsAnd) {
Sanjay Pateleb731b02017-11-19 15:34:27 +00001706 Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1707 Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1708 if (LHS0->getType() != RHS0->getType())
1709 return nullptr;
1710
1711 FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1712 if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1713 (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1714 // (fcmp ord NNAN, X) & (fcmp ord X, Y) --> fcmp ord X, Y
1715 // (fcmp ord NNAN, X) & (fcmp ord Y, X) --> fcmp ord Y, X
1716 // (fcmp ord X, NNAN) & (fcmp ord X, Y) --> fcmp ord X, Y
1717 // (fcmp ord X, NNAN) & (fcmp ord Y, X) --> fcmp ord Y, X
1718 // (fcmp uno NNAN, X) | (fcmp uno X, Y) --> fcmp uno X, Y
1719 // (fcmp uno NNAN, X) | (fcmp uno Y, X) --> fcmp uno Y, X
1720 // (fcmp uno X, NNAN) | (fcmp uno X, Y) --> fcmp uno X, Y
1721 // (fcmp uno X, NNAN) | (fcmp uno Y, X) --> fcmp uno Y, X
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001722 if ((isKnownNeverNaN(LHS0, TLI) && (LHS1 == RHS0 || LHS1 == RHS1)) ||
1723 (isKnownNeverNaN(LHS1, TLI) && (LHS0 == RHS0 || LHS0 == RHS1)))
Sanjay Pateleb731b02017-11-19 15:34:27 +00001724 return RHS;
1725
1726 // (fcmp ord X, Y) & (fcmp ord NNAN, X) --> fcmp ord X, Y
1727 // (fcmp ord Y, X) & (fcmp ord NNAN, X) --> fcmp ord Y, X
1728 // (fcmp ord X, Y) & (fcmp ord X, NNAN) --> fcmp ord X, Y
1729 // (fcmp ord Y, X) & (fcmp ord X, NNAN) --> fcmp ord Y, X
1730 // (fcmp uno X, Y) | (fcmp uno NNAN, X) --> fcmp uno X, Y
1731 // (fcmp uno Y, X) | (fcmp uno NNAN, X) --> fcmp uno Y, X
1732 // (fcmp uno X, Y) | (fcmp uno X, NNAN) --> fcmp uno X, Y
1733 // (fcmp uno Y, X) | (fcmp uno X, NNAN) --> fcmp uno Y, X
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001734 if ((isKnownNeverNaN(RHS0, TLI) && (RHS1 == LHS0 || RHS1 == LHS1)) ||
1735 (isKnownNeverNaN(RHS1, TLI) && (RHS0 == LHS0 || RHS0 == LHS1)))
Sanjay Pateleb731b02017-11-19 15:34:27 +00001736 return LHS;
1737 }
1738
1739 return nullptr;
1740}
1741
Florian Hahn19f9e322018-08-17 14:39:04 +00001742static Value *simplifyAndOrOfCmps(const SimplifyQuery &Q,
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00001743 Value *Op0, Value *Op1, bool IsAnd) {
Sanjay Patele42b4d52017-05-04 19:51:34 +00001744 // Look through casts of the 'and' operands to find compares.
1745 auto *Cast0 = dyn_cast<CastInst>(Op0);
1746 auto *Cast1 = dyn_cast<CastInst>(Op1);
1747 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1748 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1749 Op0 = Cast0->getOperand(0);
1750 Op1 = Cast1->getOperand(0);
1751 }
1752
Sanjay Pateleb731b02017-11-19 15:34:27 +00001753 Value *V = nullptr;
1754 auto *ICmp0 = dyn_cast<ICmpInst>(Op0);
1755 auto *ICmp1 = dyn_cast<ICmpInst>(Op1);
1756 if (ICmp0 && ICmp1)
Florian Hahn19f9e322018-08-17 14:39:04 +00001757 V = IsAnd ? simplifyAndOfICmps(ICmp0, ICmp1, Q.IIQ)
1758 : simplifyOrOfICmps(ICmp0, ICmp1, Q.IIQ);
Sanjay Patele42b4d52017-05-04 19:51:34 +00001759
Sanjay Pateleb731b02017-11-19 15:34:27 +00001760 auto *FCmp0 = dyn_cast<FCmpInst>(Op0);
1761 auto *FCmp1 = dyn_cast<FCmpInst>(Op1);
1762 if (FCmp0 && FCmp1)
Florian Hahn19f9e322018-08-17 14:39:04 +00001763 V = simplifyAndOrOfFCmps(Q.TLI, FCmp0, FCmp1, IsAnd);
Sanjay Pateleb731b02017-11-19 15:34:27 +00001764
Craig Topper348314d2017-05-26 22:42:34 +00001765 if (!V)
1766 return nullptr;
1767 if (!Cast0)
Sanjay Patele42b4d52017-05-04 19:51:34 +00001768 return V;
Craig Topper348314d2017-05-26 22:42:34 +00001769
1770 // If we looked through casts, we can only handle a constant simplification
1771 // because we are not allowed to create a cast instruction here.
1772 if (auto *C = dyn_cast<Constant>(V))
1773 return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
Sanjay Patele42b4d52017-05-04 19:51:34 +00001774
1775 return nullptr;
1776}
1777
Sanjay Patel472cc782016-01-11 22:14:42 +00001778/// Given operands for an And, see if we can fold the result.
1779/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001780static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001781 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001782 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1783 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001784
Chris Lattnera71e9d62009-11-10 00:55:12 +00001785 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001786 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001787 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001788
Chris Lattnera71e9d62009-11-10 00:55:12 +00001789 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001790 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001791 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001792
Duncan Sandsc89ac072010-11-17 18:52:15 +00001793 // X & 0 = 0
1794 if (match(Op1, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +00001795 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001796
Duncan Sandsc89ac072010-11-17 18:52:15 +00001797 // X & -1 = X
1798 if (match(Op1, m_AllOnes()))
1799 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001800
Chris Lattnera71e9d62009-11-10 00:55:12 +00001801 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001802 if (match(Op0, m_Not(m_Specific(Op1))) ||
1803 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001804 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001805
Chris Lattnera71e9d62009-11-10 00:55:12 +00001806 // (A | ?) & A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001807 if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001808 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001809
Chris Lattnera71e9d62009-11-10 00:55:12 +00001810 // A & (A | ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001811 if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001812 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001813
Sanjay Patel877364f2017-05-16 21:51:04 +00001814 // A mask that only clears known zeros of a shifted value is a no-op.
1815 Value *X;
1816 const APInt *Mask;
1817 const APInt *ShAmt;
1818 if (match(Op1, m_APInt(Mask))) {
1819 // If all bits in the inverted and shifted mask are clear:
1820 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1821 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1822 (~(*Mask)).lshr(*ShAmt).isNullValue())
1823 return Op0;
1824
1825 // If all bits in the inverted and shifted mask are clear:
1826 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1827 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1828 (~(*Mask)).shl(*ShAmt).isNullValue())
1829 return Op0;
1830 }
1831
Duncan Sandsba286d72011-10-26 20:55:21 +00001832 // A & (-A) = A if A is a power of two or zero.
1833 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1834 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001835 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1836 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001837 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001838 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1839 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001840 return Op1;
1841 }
1842
Florian Hahn19f9e322018-08-17 14:39:04 +00001843 if (Value *V = simplifyAndOrOfCmps(Q, Op0, Op1, true))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001844 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001845
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001846 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001847 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1848 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001849 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001850
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001851 // And distributes over Or. Try some generic simplifications based on this.
1852 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001853 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001854 return V;
1855
1856 // And distributes over Xor. Try some generic simplifications based on this.
1857 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001858 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001859 return V;
1860
Duncan Sandsb0579e92010-11-10 13:00:08 +00001861 // If the operation is with the result of a select instruction, check whether
1862 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001863 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001864 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1865 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001866 return V;
1867
1868 // If the operation is with the result of a phi instruction, check whether
1869 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001870 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001871 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001872 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001873 return V;
1874
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001875 // Assuming the effective width of Y is not larger than A, i.e. all bits
1876 // from X and Y are disjoint in (X << A) | Y,
1877 // if the mask of this AND op covers all bits of X or Y, while it covers
1878 // no bits from the other, we can bypass this AND op. E.g.,
1879 // ((X << A) | Y) & Mask -> Y,
1880 // if Mask = ((1 << effective_width_of(Y)) - 1)
1881 // ((X << A) | Y) & Mask -> X << A,
1882 // if Mask = ((1 << effective_width_of(X)) - 1) << A
1883 // SimplifyDemandedBits in InstCombine can optimize the general case.
1884 // This pattern aims to help other passes for a common case.
1885 Value *Y, *XShifted;
1886 if (match(Op1, m_APInt(Mask)) &&
1887 match(Op0, m_c_Or(m_CombineAnd(m_NUWShl(m_Value(X), m_APInt(ShAmt)),
1888 m_Value(XShifted)),
1889 m_Value(Y)))) {
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001890 const unsigned Width = Op0->getType()->getScalarSizeInBits();
Benjamin Kramerbae6aab2018-08-12 11:43:03 +00001891 const unsigned ShftCnt = ShAmt->getLimitedValue(Width);
1892 const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001893 const unsigned EffWidthY = Width - YKnown.countMinLeadingZeros();
1894 if (EffWidthY <= ShftCnt) {
1895 const KnownBits XKnown = computeKnownBits(X, Q.DL, 0, Q.AC, Q.CxtI,
1896 Q.DT);
1897 const unsigned EffWidthX = Width - XKnown.countMinLeadingZeros();
1898 const APInt EffBitsY = APInt::getLowBitsSet(Width, EffWidthY);
1899 const APInt EffBitsX = APInt::getLowBitsSet(Width, EffWidthX) << ShftCnt;
1900 // If the mask is extracting all bits from X or Y as is, we can skip
1901 // this AND op.
1902 if (EffBitsY.isSubsetOf(*Mask) && !EffBitsX.intersects(*Mask))
1903 return Y;
1904 if (EffBitsX.isSubsetOf(*Mask) && !EffBitsY.intersects(*Mask))
1905 return XShifted;
1906 }
1907 }
1908
Craig Topper9f008862014-04-15 04:59:12 +00001909 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001910}
1911
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001912Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1913 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1914}
1915
Sanjay Patel472cc782016-01-11 22:14:42 +00001916/// Given operands for an Or, see if we can fold the result.
1917/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001918static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001919 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001920 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1921 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001922
Chris Lattnera71e9d62009-11-10 00:55:12 +00001923 // X | undef -> -1
Sanjay Pateladf6e882018-02-18 18:05:08 +00001924 // X | -1 = -1
1925 // Do not return Op1 because it may contain undef elements if it's a vector.
1926 if (match(Op1, m_Undef()) || match(Op1, m_AllOnes()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001927 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001928
Chris Lattnera71e9d62009-11-10 00:55:12 +00001929 // X | X = X
Duncan Sandsc89ac072010-11-17 18:52:15 +00001930 // X | 0 = X
Sanjay Pateladf6e882018-02-18 18:05:08 +00001931 if (Op0 == Op1 || match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001932 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001933
Chris Lattnera71e9d62009-11-10 00:55:12 +00001934 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001935 if (match(Op0, m_Not(m_Specific(Op1))) ||
1936 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001937 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001938
Chris Lattnera71e9d62009-11-10 00:55:12 +00001939 // (A & ?) | A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001940 if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001941 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001942
Chris Lattnera71e9d62009-11-10 00:55:12 +00001943 // A | (A & ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001944 if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001945 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001946
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001947 // ~(A & ?) | A = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001948 if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001949 return Constant::getAllOnesValue(Op1->getType());
1950
1951 // A | ~(A & ?) = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001952 if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001953 return Constant::getAllOnesValue(Op0->getType());
1954
Craig Topperdad7d8d2017-07-16 06:57:41 +00001955 Value *A, *B;
Sanjay Patel08892252017-04-24 18:24:36 +00001956 // (A & ~B) | (A ^ B) -> (A ^ B)
1957 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001958 // (A & ~B) | (B ^ A) -> (B ^ A)
1959 // (~B & A) | (B ^ A) -> (B ^ A)
1960 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1961 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1962 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001963 return Op1;
1964
1965 // Commute the 'or' operands.
1966 // (A ^ B) | (A & ~B) -> (A ^ B)
1967 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001968 // (B ^ A) | (A & ~B) -> (B ^ A)
1969 // (B ^ A) | (~B & A) -> (B ^ A)
1970 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1971 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1972 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001973 return Op0;
1974
Craig Topper479daaf2017-05-14 07:54:43 +00001975 // (A & B) | (~A ^ B) -> (~A ^ B)
1976 // (B & A) | (~A ^ B) -> (~A ^ B)
1977 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1978 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1979 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1980 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1981 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1982 return Op1;
1983
1984 // (~A ^ B) | (A & B) -> (~A ^ B)
1985 // (~A ^ B) | (B & A) -> (~A ^ B)
1986 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1987 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1988 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1989 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1990 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1991 return Op0;
1992
Florian Hahn19f9e322018-08-17 14:39:04 +00001993 if (Value *V = simplifyAndOrOfCmps(Q, Op0, Op1, false))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001994 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001995
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001996 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001997 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1998 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001999 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00002000
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00002001 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00002002 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
2003 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00002004 return V;
2005
Duncan Sandsb0579e92010-11-10 13:00:08 +00002006 // If the operation is with the result of a select instruction, check whether
2007 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00002008 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00002009 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00002010 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002011 return V;
2012
Craig Topper50500d52017-05-26 05:16:20 +00002013 // (A & C1)|(B & C2)
Craig Topper1da22c32017-05-26 19:03:53 +00002014 const APInt *C1, *C2;
2015 if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
2016 match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
2017 if (*C1 == ~*C2) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002018 // (A & C1)|(B & C2)
2019 // If we have: ((V + N) & C1) | (V & C2)
2020 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
2021 // replace with V+N.
Craig Topperc8bebb12017-05-26 19:03:59 +00002022 Value *N;
Craig Topper1da22c32017-05-26 19:03:53 +00002023 if (C2->isMask() && // C2 == 0+1+
Craig Topperc8bebb12017-05-26 19:03:59 +00002024 match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002025 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00002026 if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00002027 return A;
2028 }
2029 // Or commutes, try both ways.
Craig Topper1da22c32017-05-26 19:03:53 +00002030 if (C1->isMask() &&
Craig Topperc8bebb12017-05-26 19:03:59 +00002031 match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002032 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00002033 if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00002034 return B;
2035 }
2036 }
2037 }
2038
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002039 // If the operation is with the result of a phi instruction, check whether
2040 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00002041 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00002042 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00002043 return V;
2044
Craig Topper9f008862014-04-15 04:59:12 +00002045 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00002046}
2047
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002048Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2049 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
2050}
2051
Sanjay Patel472cc782016-01-11 22:14:42 +00002052/// Given operands for a Xor, see if we can fold the result.
2053/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002054static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00002055 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00002056 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
2057 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002058
2059 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00002060 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00002061 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002062
2063 // A ^ 0 = A
2064 if (match(Op1, m_Zero()))
2065 return Op0;
2066
Eli Friedmanad3cfe72011-08-17 19:31:49 +00002067 // A ^ A = 0
2068 if (Op0 == Op1)
2069 return Constant::getNullValue(Op0->getType());
2070
Duncan Sandsc89ac072010-11-17 18:52:15 +00002071 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00002072 if (match(Op0, m_Not(m_Specific(Op1))) ||
2073 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00002074 return Constant::getAllOnesValue(Op0->getType());
2075
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002076 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00002077 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
2078 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002079 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002080
Duncan Sandsb238de02010-11-19 09:20:39 +00002081 // Threading Xor over selects and phi nodes is pointless, so don't bother.
2082 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
2083 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
2084 // only if B and C are equal. If B and C are equal then (since we assume
2085 // that operands have already been simplified) "select(cond, B, C)" should
2086 // have been simplified to the common value of B and C already. Analysing
2087 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
2088 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00002089
Craig Topper9f008862014-04-15 04:59:12 +00002090 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002091}
2092
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002093Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2094 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2095}
2096
2097
Chris Lattner229907c2011-07-18 04:54:35 +00002098static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002099 return CmpInst::makeCmpResultType(Op->getType());
2100}
2101
Sanjay Patel472cc782016-01-11 22:14:42 +00002102/// Rummage around inside V looking for something equivalent to the comparison
2103/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2104/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002105static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2106 Value *LHS, Value *RHS) {
2107 SelectInst *SI = dyn_cast<SelectInst>(V);
2108 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002109 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002110 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2111 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002112 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002113 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2114 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2115 return Cmp;
2116 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2117 LHS == CmpRHS && RHS == CmpLHS)
2118 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002119 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002120}
2121
Dan Gohman9631d902013-02-01 00:49:06 +00002122// A significant optimization not implemented here is assuming that alloca
2123// addresses are not equal to incoming argument values. They don't *alias*,
2124// as we say, but that doesn't mean they aren't equal, so we take a
2125// conservative approach.
2126//
2127// This is inspired in part by C++11 5.10p1:
2128// "Two pointers of the same type compare equal if and only if they are both
2129// null, both point to the same function, or both represent the same
2130// address."
2131//
2132// This is pretty permissive.
2133//
2134// It's also partly due to C11 6.5.9p6:
2135// "Two pointers compare equal if and only if both are null pointers, both are
2136// pointers to the same object (including a pointer to an object and a
2137// subobject at its beginning) or function, both are pointers to one past the
2138// last element of the same array object, or one is a pointer to one past the
2139// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002140// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002141// object in the address space.)
2142//
2143// C11's version is more restrictive, however there's no reason why an argument
2144// couldn't be a one-past-the-end value for a stack object in the caller and be
2145// equal to the beginning of a stack object in the callee.
2146//
2147// If the C and C++ standards are ever made sufficiently restrictive in this
2148// area, it may be possible to update LLVM's semantics accordingly and reinstate
2149// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002150static Constant *
2151computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2152 const DominatorTree *DT, CmpInst::Predicate Pred,
Nuno Lopes404f1062017-09-09 18:23:11 +00002153 AssumptionCache *AC, const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +00002154 const InstrInfoQuery &IIQ, Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002155 // First, skip past any trivial no-ops.
2156 LHS = LHS->stripPointerCasts();
2157 RHS = RHS->stripPointerCasts();
2158
2159 // A non-null pointer is not equal to a null pointer.
Florian Hahn19f9e322018-08-17 14:39:04 +00002160 if (llvm::isKnownNonZero(LHS, DL, 0, nullptr, nullptr, nullptr,
2161 IIQ.UseInstrInfo) &&
2162 isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002163 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2164 return ConstantInt::get(GetCompareTy(LHS),
2165 !CmpInst::isTrueWhenEqual(Pred));
2166
Chandler Carruth8059c842012-03-25 21:28:14 +00002167 // We can only fold certain predicates on pointer comparisons.
2168 switch (Pred) {
2169 default:
Craig Topper9f008862014-04-15 04:59:12 +00002170 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002171
2172 // Equality comaprisons are easy to fold.
2173 case CmpInst::ICMP_EQ:
2174 case CmpInst::ICMP_NE:
2175 break;
2176
2177 // We can only handle unsigned relational comparisons because 'inbounds' on
2178 // a GEP only protects against unsigned wrapping.
2179 case CmpInst::ICMP_UGT:
2180 case CmpInst::ICMP_UGE:
2181 case CmpInst::ICMP_ULT:
2182 case CmpInst::ICMP_ULE:
2183 // However, we have to switch them to their signed variants to handle
2184 // negative indices from the base pointer.
2185 Pred = ICmpInst::getSignedPredicate(Pred);
2186 break;
2187 }
2188
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002189 // Strip off any constant offsets so that we can reason about them.
2190 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2191 // here and compare base addresses like AliasAnalysis does, however there are
2192 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2193 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2194 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002195 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2196 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002197
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002198 // If LHS and RHS are related via constant offsets to the same base
2199 // value, we can replace it with an icmp which just compares the offsets.
2200 if (LHS == RHS)
2201 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002202
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002203 // Various optimizations for (in)equality comparisons.
2204 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2205 // Different non-empty allocations that exist at the same time have
2206 // different addresses (if the program can tell). Global variables always
2207 // exist, so they always exist during the lifetime of each other and all
2208 // allocas. Two different allocas usually have different addresses...
2209 //
2210 // However, if there's an @llvm.stackrestore dynamically in between two
2211 // allocas, they may have the same address. It's tempting to reduce the
2212 // scope of the problem by only looking at *static* allocas here. That would
2213 // cover the majority of allocas while significantly reducing the likelihood
2214 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2215 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2216 // an entry block. Also, if we have a block that's not attached to a
2217 // function, we can't tell if it's "static" under the current definition.
2218 // Theoretically, this problem could be fixed by creating a new kind of
2219 // instruction kind specifically for static allocas. Such a new instruction
2220 // could be required to be at the top of the entry block, thus preventing it
2221 // from being subject to a @llvm.stackrestore. Instcombine could even
2222 // convert regular allocas into these special allocas. It'd be nifty.
2223 // However, until then, this problem remains open.
2224 //
2225 // So, we'll assume that two non-empty allocas have different addresses
2226 // for now.
2227 //
2228 // With all that, if the offsets are within the bounds of their allocations
2229 // (and not one-past-the-end! so we can't use inbounds!), and their
2230 // allocations aren't the same, the pointers are not equal.
2231 //
2232 // Note that it's not necessary to check for LHS being a global variable
2233 // address, due to canonicalization and constant folding.
2234 if (isa<AllocaInst>(LHS) &&
2235 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002236 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2237 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002238 uint64_t LHSSize, RHSSize;
Manoj Gupta77eeac32018-07-09 22:27:23 +00002239 ObjectSizeOpts Opts;
2240 Opts.NullIsUnknownSize =
2241 NullPointerIsDefined(cast<AllocaInst>(LHS)->getFunction());
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002242 if (LHSOffsetCI && RHSOffsetCI &&
Manoj Gupta77eeac32018-07-09 22:27:23 +00002243 getObjectSize(LHS, LHSSize, DL, TLI, Opts) &&
2244 getObjectSize(RHS, RHSSize, DL, TLI, Opts)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002245 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2246 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002247 if (!LHSOffsetValue.isNegative() &&
2248 !RHSOffsetValue.isNegative() &&
2249 LHSOffsetValue.ult(LHSSize) &&
2250 RHSOffsetValue.ult(RHSSize)) {
2251 return ConstantInt::get(GetCompareTy(LHS),
2252 !CmpInst::isTrueWhenEqual(Pred));
2253 }
2254 }
2255
2256 // Repeat the above check but this time without depending on DataLayout
2257 // or being able to compute a precise size.
2258 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2259 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2260 LHSOffset->isNullValue() &&
2261 RHSOffset->isNullValue())
2262 return ConstantInt::get(GetCompareTy(LHS),
2263 !CmpInst::isTrueWhenEqual(Pred));
2264 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002265
2266 // Even if an non-inbounds GEP occurs along the path we can still optimize
2267 // equality comparisons concerning the result. We avoid walking the whole
2268 // chain again by starting where the last calls to
2269 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002270 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2271 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002272 if (LHS == RHS)
2273 return ConstantExpr::getICmp(Pred,
2274 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2275 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002276
2277 // If one side of the equality comparison must come from a noalias call
2278 // (meaning a system memory allocation function), and the other side must
2279 // come from a pointer that cannot overlap with dynamically-allocated
2280 // memory within the lifetime of the current function (allocas, byval
2281 // arguments, globals), then determine the comparison result here.
2282 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2283 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2284 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2285
2286 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002287 auto IsNAC = [](ArrayRef<Value *> Objects) {
2288 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002289 };
2290
2291 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002292 // noalias calls. For allocas, we consider only static ones (dynamic
2293 // allocas might be transformed into calls to malloc not simultaneously
2294 // live with the compared-to allocation). For globals, we exclude symbols
2295 // that might be resolve lazily to symbols in another dynamically-loaded
2296 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002297 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2298 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002299 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2300 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2301 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2302 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002303 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002304 !GV->isThreadLocal();
2305 if (const Argument *A = dyn_cast<Argument>(V))
2306 return A->hasByValAttr();
2307 return false;
2308 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002309 };
2310
2311 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2312 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2313 return ConstantInt::get(GetCompareTy(LHS),
2314 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002315
2316 // Fold comparisons for non-escaping pointer even if the allocation call
2317 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2318 // dynamic allocation call could be either of the operands.
2319 Value *MI = nullptr;
Nuno Lopes404f1062017-09-09 18:23:11 +00002320 if (isAllocLikeFn(LHS, TLI) &&
2321 llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002322 MI = LHS;
Nuno Lopes404f1062017-09-09 18:23:11 +00002323 else if (isAllocLikeFn(RHS, TLI) &&
2324 llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002325 MI = RHS;
2326 // FIXME: We should also fold the compare when the pointer escapes, but the
2327 // compare dominates the pointer escape
2328 if (MI && !PointerMayBeCaptured(MI, true, true))
2329 return ConstantInt::get(GetCompareTy(LHS),
2330 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002331 }
2332
2333 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002334 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002335}
Chris Lattner01990f02012-02-24 19:01:58 +00002336
Sanjay Pateldc65a272016-12-03 17:30:22 +00002337/// Fold an icmp when its operands have i1 scalar type.
2338static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002339 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002340 Type *ITy = GetCompareTy(LHS); // The return type.
2341 Type *OpTy = LHS->getType(); // The operand type.
Craig Topperfde47232017-07-09 07:04:03 +00002342 if (!OpTy->isIntOrIntVectorTy(1))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002343 return nullptr;
2344
Sanjay Patele2787b92017-05-17 20:27:55 +00002345 // A boolean compared to true/false can be simplified in 14 out of the 20
2346 // (10 predicates * 2 constants) possible combinations. Cases not handled here
2347 // require a 'not' of the LHS, so those must be transformed in InstCombine.
2348 if (match(RHS, m_Zero())) {
2349 switch (Pred) {
2350 case CmpInst::ICMP_NE: // X != 0 -> X
2351 case CmpInst::ICMP_UGT: // X >u 0 -> X
2352 case CmpInst::ICMP_SLT: // X <s 0 -> X
2353 return LHS;
2354
2355 case CmpInst::ICMP_ULT: // X <u 0 -> false
2356 case CmpInst::ICMP_SGT: // X >s 0 -> false
2357 return getFalse(ITy);
2358
2359 case CmpInst::ICMP_UGE: // X >=u 0 -> true
2360 case CmpInst::ICMP_SLE: // X <=s 0 -> true
2361 return getTrue(ITy);
2362
2363 default: break;
2364 }
2365 } else if (match(RHS, m_One())) {
2366 switch (Pred) {
2367 case CmpInst::ICMP_EQ: // X == 1 -> X
2368 case CmpInst::ICMP_UGE: // X >=u 1 -> X
2369 case CmpInst::ICMP_SLE: // X <=s -1 -> X
2370 return LHS;
2371
2372 case CmpInst::ICMP_UGT: // X >u 1 -> false
2373 case CmpInst::ICMP_SLT: // X <s -1 -> false
2374 return getFalse(ITy);
2375
2376 case CmpInst::ICMP_ULE: // X <=u 1 -> true
2377 case CmpInst::ICMP_SGE: // X >=s -1 -> true
2378 return getTrue(ITy);
2379
2380 default: break;
2381 }
2382 }
2383
Sanjay Pateldc65a272016-12-03 17:30:22 +00002384 switch (Pred) {
2385 default:
2386 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002387 case ICmpInst::ICMP_UGE:
Sanjay Pateldc65a272016-12-03 17:30:22 +00002388 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2389 return getTrue(ITy);
2390 break;
2391 case ICmpInst::ICMP_SGE:
2392 /// For signed comparison, the values for an i1 are 0 and -1
2393 /// respectively. This maps into a truth table of:
2394 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2395 /// 0 | 0 | 1 (0 >= 0) | 1
2396 /// 0 | 1 | 1 (0 >= -1) | 1
2397 /// 1 | 0 | 0 (-1 >= 0) | 0
2398 /// 1 | 1 | 1 (-1 >= -1) | 1
2399 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2400 return getTrue(ITy);
2401 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002402 case ICmpInst::ICMP_ULE:
2403 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2404 return getTrue(ITy);
2405 break;
2406 }
2407
2408 return nullptr;
2409}
2410
2411/// Try hard to fold icmp with zero RHS because this is a common case.
2412static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002413 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002414 if (!match(RHS, m_Zero()))
2415 return nullptr;
2416
2417 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002418 switch (Pred) {
2419 default:
2420 llvm_unreachable("Unknown ICmp predicate!");
2421 case ICmpInst::ICMP_ULT:
2422 return getFalse(ITy);
2423 case ICmpInst::ICMP_UGE:
2424 return getTrue(ITy);
2425 case ICmpInst::ICMP_EQ:
2426 case ICmpInst::ICMP_ULE:
Florian Hahn19f9e322018-08-17 14:39:04 +00002427 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002428 return getFalse(ITy);
2429 break;
2430 case ICmpInst::ICMP_NE:
2431 case ICmpInst::ICMP_UGT:
Florian Hahn19f9e322018-08-17 14:39:04 +00002432 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002433 return getTrue(ITy);
2434 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002435 case ICmpInst::ICMP_SLT: {
2436 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2437 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002438 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002439 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002440 return getFalse(ITy);
2441 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002442 }
2443 case ICmpInst::ICMP_SLE: {
2444 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2445 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002446 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002447 if (LHSKnown.isNonNegative() &&
2448 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002449 return getFalse(ITy);
2450 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002451 }
2452 case ICmpInst::ICMP_SGE: {
2453 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2454 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002455 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002456 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002457 return getTrue(ITy);
2458 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002459 }
2460 case ICmpInst::ICMP_SGT: {
2461 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2462 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002463 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002464 if (LHSKnown.isNonNegative() &&
2465 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002466 return getTrue(ITy);
2467 break;
2468 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002469 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002470
2471 return nullptr;
2472}
2473
Sanjay Patelbe332132017-01-23 18:22:26 +00002474/// Many binary operators with a constant operand have an easy-to-compute
2475/// range of outputs. This can be used to fold a comparison to always true or
2476/// always false.
Florian Hahn19f9e322018-08-17 14:39:04 +00002477static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper,
2478 const InstrInfoQuery &IIQ) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002479 unsigned Width = Lower.getBitWidth();
2480 const APInt *C;
2481 switch (BO.getOpcode()) {
2482 case Instruction::Add:
Craig Topper73ba1c82017-06-07 07:40:37 +00002483 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patel56227252017-01-24 17:03:24 +00002484 // FIXME: If we have both nuw and nsw, we should reduce the range further.
Florian Hahn19f9e322018-08-17 14:39:04 +00002485 if (IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(&BO))) {
Sanjay Patel56227252017-01-24 17:03:24 +00002486 // 'add nuw x, C' produces [C, UINT_MAX].
2487 Lower = *C;
Florian Hahn19f9e322018-08-17 14:39:04 +00002488 } else if (IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(&BO))) {
Sanjay Patel56227252017-01-24 17:03:24 +00002489 if (C->isNegative()) {
2490 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2491 Lower = APInt::getSignedMinValue(Width);
2492 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2493 } else {
2494 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2495 Lower = APInt::getSignedMinValue(Width) + *C;
2496 Upper = APInt::getSignedMaxValue(Width) + 1;
2497 }
2498 }
2499 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002500 break;
2501
2502 case Instruction::And:
2503 if (match(BO.getOperand(1), m_APInt(C)))
2504 // 'and x, C' produces [0, C].
2505 Upper = *C + 1;
2506 break;
2507
2508 case Instruction::Or:
2509 if (match(BO.getOperand(1), m_APInt(C)))
2510 // 'or x, C' produces [C, UINT_MAX].
2511 Lower = *C;
2512 break;
2513
2514 case Instruction::AShr:
2515 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2516 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2517 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2518 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2519 } else if (match(BO.getOperand(0), m_APInt(C))) {
2520 unsigned ShiftAmount = Width - 1;
Florian Hahn19f9e322018-08-17 14:39:04 +00002521 if (!C->isNullValue() && IIQ.isExact(&BO))
Sanjay Patelbe332132017-01-23 18:22:26 +00002522 ShiftAmount = C->countTrailingZeros();
2523 if (C->isNegative()) {
2524 // 'ashr C, x' produces [C, C >> (Width-1)]
2525 Lower = *C;
2526 Upper = C->ashr(ShiftAmount) + 1;
2527 } else {
2528 // 'ashr C, x' produces [C >> (Width-1), C]
2529 Lower = C->ashr(ShiftAmount);
2530 Upper = *C + 1;
2531 }
2532 }
2533 break;
2534
2535 case Instruction::LShr:
2536 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2537 // 'lshr x, C' produces [0, UINT_MAX >> C].
2538 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2539 } else if (match(BO.getOperand(0), m_APInt(C))) {
2540 // 'lshr C, x' produces [C >> (Width-1), C].
2541 unsigned ShiftAmount = Width - 1;
Florian Hahn19f9e322018-08-17 14:39:04 +00002542 if (!C->isNullValue() && IIQ.isExact(&BO))
Sanjay Patelbe332132017-01-23 18:22:26 +00002543 ShiftAmount = C->countTrailingZeros();
2544 Lower = C->lshr(ShiftAmount);
2545 Upper = *C + 1;
2546 }
2547 break;
2548
2549 case Instruction::Shl:
2550 if (match(BO.getOperand(0), m_APInt(C))) {
Florian Hahn19f9e322018-08-17 14:39:04 +00002551 if (IIQ.hasNoUnsignedWrap(&BO)) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002552 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2553 Lower = *C;
2554 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2555 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2556 if (C->isNegative()) {
2557 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2558 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2559 Lower = C->shl(ShiftAmount);
2560 Upper = *C + 1;
2561 } else {
2562 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2563 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2564 Lower = *C;
2565 Upper = C->shl(ShiftAmount) + 1;
2566 }
2567 }
2568 }
2569 break;
2570
2571 case Instruction::SDiv:
2572 if (match(BO.getOperand(1), m_APInt(C))) {
2573 APInt IntMin = APInt::getSignedMinValue(Width);
2574 APInt IntMax = APInt::getSignedMaxValue(Width);
2575 if (C->isAllOnesValue()) {
2576 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2577 // where C != -1 and C != 0 and C != 1
2578 Lower = IntMin + 1;
2579 Upper = IntMax + 1;
2580 } else if (C->countLeadingZeros() < Width - 1) {
2581 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2582 // where C != -1 and C != 0 and C != 1
2583 Lower = IntMin.sdiv(*C);
2584 Upper = IntMax.sdiv(*C);
2585 if (Lower.sgt(Upper))
2586 std::swap(Lower, Upper);
2587 Upper = Upper + 1;
2588 assert(Upper != Lower && "Upper part of range has wrapped!");
2589 }
2590 } else if (match(BO.getOperand(0), m_APInt(C))) {
2591 if (C->isMinSignedValue()) {
2592 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2593 Lower = *C;
2594 Upper = Lower.lshr(1) + 1;
2595 } else {
2596 // 'sdiv C, x' produces [-|C|, |C|].
2597 Upper = C->abs() + 1;
2598 Lower = (-Upper) + 1;
2599 }
2600 }
2601 break;
2602
2603 case Instruction::UDiv:
Craig Topper73ba1c82017-06-07 07:40:37 +00002604 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002605 // 'udiv x, C' produces [0, UINT_MAX / C].
2606 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2607 } else if (match(BO.getOperand(0), m_APInt(C))) {
2608 // 'udiv C, x' produces [0, C].
2609 Upper = *C + 1;
2610 }
2611 break;
2612
2613 case Instruction::SRem:
2614 if (match(BO.getOperand(1), m_APInt(C))) {
2615 // 'srem x, C' produces (-|C|, |C|).
2616 Upper = C->abs();
2617 Lower = (-Upper) + 1;
2618 }
2619 break;
2620
2621 case Instruction::URem:
2622 if (match(BO.getOperand(1), m_APInt(C)))
2623 // 'urem x, C' produces [0, C).
2624 Upper = *C;
2625 break;
2626
2627 default:
2628 break;
2629 }
2630}
2631
Nikita Popov221f3fc2018-12-17 17:45:18 +00002632/// Some intrinsics with a constant operand have an easy-to-compute range of
2633/// outputs. This can be used to fold a comparison to always true or always
2634/// false.
2635static void setLimitsForIntrinsic(IntrinsicInst &II, APInt &Lower,
2636 APInt &Upper) {
2637 unsigned Width = Lower.getBitWidth();
2638 const APInt *C;
2639 switch (II.getIntrinsicID()) {
2640 case Intrinsic::uadd_sat:
2641 // uadd.sat(x, C) produces [C, UINT_MAX].
2642 if (match(II.getOperand(0), m_APInt(C)) ||
2643 match(II.getOperand(1), m_APInt(C)))
2644 Lower = *C;
2645 break;
2646 case Intrinsic::sadd_sat:
2647 if (match(II.getOperand(0), m_APInt(C)) ||
2648 match(II.getOperand(1), m_APInt(C))) {
2649 if (C->isNegative()) {
2650 // sadd.sat(x, -C) produces [SINT_MIN, SINT_MAX + (-C)].
2651 Lower = APInt::getSignedMinValue(Width);
2652 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2653 } else {
2654 // sadd.sat(x, +C) produces [SINT_MIN + C, SINT_MAX].
2655 Lower = APInt::getSignedMinValue(Width) + *C;
2656 Upper = APInt::getSignedMaxValue(Width) + 1;
2657 }
2658 }
2659 break;
2660 case Intrinsic::usub_sat:
2661 // usub.sat(C, x) produces [0, C].
2662 if (match(II.getOperand(0), m_APInt(C)))
2663 Upper = *C + 1;
2664 // usub.sat(x, C) produces [0, UINT_MAX - C].
2665 else if (match(II.getOperand(1), m_APInt(C)))
2666 Upper = APInt::getMaxValue(Width) - *C + 1;
2667 break;
2668 case Intrinsic::ssub_sat:
2669 if (match(II.getOperand(0), m_APInt(C))) {
2670 if (C->isNegative()) {
2671 // ssub.sat(-C, x) produces [SINT_MIN, -SINT_MIN + (-C)].
2672 Lower = APInt::getSignedMinValue(Width);
2673 Upper = *C - APInt::getSignedMinValue(Width) + 1;
2674 } else {
2675 // ssub.sat(+C, x) produces [-SINT_MAX + C, SINT_MAX].
2676 Lower = *C - APInt::getSignedMaxValue(Width);
2677 Upper = APInt::getSignedMaxValue(Width) + 1;
2678 }
2679 } else if (match(II.getOperand(1), m_APInt(C))) {
2680 if (C->isNegative()) {
2681 // ssub.sat(x, -C) produces [SINT_MIN - (-C), SINT_MAX]:
2682 Lower = APInt::getSignedMinValue(Width) - *C;
2683 Upper = APInt::getSignedMaxValue(Width) + 1;
2684 } else {
2685 // ssub.sat(x, +C) produces [SINT_MIN, SINT_MAX - C].
2686 Lower = APInt::getSignedMinValue(Width);
2687 Upper = APInt::getSignedMaxValue(Width) - *C + 1;
2688 }
2689 }
2690 break;
2691 default:
2692 break;
2693 }
2694}
2695
Sanjay Patel67bde282016-08-22 23:12:02 +00002696static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
Florian Hahn19f9e322018-08-17 14:39:04 +00002697 Value *RHS, const InstrInfoQuery &IIQ) {
Roman Lebedev0c43d722018-03-15 16:17:40 +00002698 Type *ITy = GetCompareTy(RHS); // The return type.
2699
Roman Lebedev6aca3352018-03-15 16:17:46 +00002700 Value *X;
2701 // Sign-bit checks can be optimized to true/false after unsigned
2702 // floating-point casts:
2703 // icmp slt (bitcast (uitofp X)), 0 --> false
2704 // icmp sgt (bitcast (uitofp X)), -1 --> true
2705 if (match(LHS, m_BitCast(m_UIToFP(m_Value(X))))) {
2706 if (Pred == ICmpInst::ICMP_SLT && match(RHS, m_Zero()))
2707 return ConstantInt::getFalse(ITy);
2708 if (Pred == ICmpInst::ICMP_SGT && match(RHS, m_AllOnes()))
2709 return ConstantInt::getTrue(ITy);
2710 }
2711
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002712 const APInt *C;
2713 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002714 return nullptr;
2715
2716 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002717 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002718 if (RHS_CR.isEmptySet())
Roman Lebedev0c43d722018-03-15 16:17:40 +00002719 return ConstantInt::getFalse(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002720 if (RHS_CR.isFullSet())
Roman Lebedev0c43d722018-03-15 16:17:40 +00002721 return ConstantInt::getTrue(ITy);
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002722
Sanjay Patelbe332132017-01-23 18:22:26 +00002723 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002724 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002725 APInt Lower = APInt(Width, 0);
2726 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002727 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
Florian Hahn19f9e322018-08-17 14:39:04 +00002728 setLimitsForBinOp(*BO, Lower, Upper, IIQ);
Nikita Popov221f3fc2018-12-17 17:45:18 +00002729 else if (auto *II = dyn_cast<IntrinsicInst>(LHS))
2730 setLimitsForIntrinsic(*II, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002731
2732 ConstantRange LHS_CR =
2733 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2734
2735 if (auto *I = dyn_cast<Instruction>(LHS))
Florian Hahn19f9e322018-08-17 14:39:04 +00002736 if (auto *Ranges = IIQ.getMetadata(I, LLVMContext::MD_range))
Sanjay Patel67bde282016-08-22 23:12:02 +00002737 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2738
2739 if (!LHS_CR.isFullSet()) {
2740 if (RHS_CR.contains(LHS_CR))
Roman Lebedev0c43d722018-03-15 16:17:40 +00002741 return ConstantInt::getTrue(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002742 if (RHS_CR.inverse().contains(LHS_CR))
Roman Lebedev0c43d722018-03-15 16:17:40 +00002743 return ConstantInt::getFalse(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002744 }
2745
2746 return nullptr;
2747}
2748
Sanjay Patel2df38a82017-05-08 16:21:55 +00002749/// TODO: A large part of this logic is duplicated in InstCombine's
2750/// foldICmpBinOp(). We should be able to share that and avoid the code
2751/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002752static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002753 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002754 unsigned MaxRecurse) {
2755 Type *ITy = GetCompareTy(LHS); // The return type.
2756
2757 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2758 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2759 if (MaxRecurse && (LBO || RBO)) {
2760 // Analyze the case when either LHS or RHS is an add instruction.
2761 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2762 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2763 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2764 if (LBO && LBO->getOpcode() == Instruction::Add) {
2765 A = LBO->getOperand(0);
2766 B = LBO->getOperand(1);
2767 NoLHSWrapProblem =
2768 ICmpInst::isEquality(Pred) ||
Florian Hahn19f9e322018-08-17 14:39:04 +00002769 (CmpInst::isUnsigned(Pred) &&
2770 Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(LBO))) ||
2771 (CmpInst::isSigned(Pred) &&
2772 Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(LBO)));
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002773 }
2774 if (RBO && RBO->getOpcode() == Instruction::Add) {
2775 C = RBO->getOperand(0);
2776 D = RBO->getOperand(1);
2777 NoRHSWrapProblem =
2778 ICmpInst::isEquality(Pred) ||
Florian Hahn19f9e322018-08-17 14:39:04 +00002779 (CmpInst::isUnsigned(Pred) &&
2780 Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(RBO))) ||
2781 (CmpInst::isSigned(Pred) &&
2782 Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(RBO)));
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002783 }
2784
2785 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2786 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2787 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2788 Constant::getNullValue(RHS->getType()), Q,
2789 MaxRecurse - 1))
2790 return V;
2791
2792 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2793 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2794 if (Value *V =
2795 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2796 C == LHS ? D : C, Q, MaxRecurse - 1))
2797 return V;
2798
2799 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2800 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2801 NoRHSWrapProblem) {
2802 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2803 Value *Y, *Z;
2804 if (A == C) {
2805 // C + B == C + D -> B == D
2806 Y = B;
2807 Z = D;
2808 } else if (A == D) {
2809 // D + B == C + D -> B == C
2810 Y = B;
2811 Z = C;
2812 } else if (B == C) {
2813 // A + C == C + D -> A == D
2814 Y = A;
2815 Z = D;
2816 } else {
2817 assert(B == D);
2818 // A + D == C + D -> A == C
2819 Y = A;
2820 Z = C;
2821 }
2822 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2823 return V;
2824 }
2825 }
2826
2827 {
2828 Value *Y = nullptr;
2829 // icmp pred (or X, Y), X
2830 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2831 if (Pred == ICmpInst::ICMP_ULT)
2832 return getFalse(ITy);
2833 if (Pred == ICmpInst::ICMP_UGE)
2834 return getTrue(ITy);
2835
2836 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002837 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2838 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2839 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002840 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002841 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002842 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2843 }
2844 }
2845 // icmp pred X, (or X, Y)
2846 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2847 if (Pred == ICmpInst::ICMP_ULE)
2848 return getTrue(ITy);
2849 if (Pred == ICmpInst::ICMP_UGT)
2850 return getFalse(ITy);
2851
2852 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002853 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2854 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2855 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002856 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002857 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002858 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2859 }
2860 }
2861 }
2862
2863 // icmp pred (and X, Y), X
Craig Topper72ee6942017-06-24 06:24:01 +00002864 if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002865 if (Pred == ICmpInst::ICMP_UGT)
2866 return getFalse(ITy);
2867 if (Pred == ICmpInst::ICMP_ULE)
2868 return getTrue(ITy);
2869 }
2870 // icmp pred X, (and X, Y)
Craig Topper72ee6942017-06-24 06:24:01 +00002871 if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002872 if (Pred == ICmpInst::ICMP_UGE)
2873 return getTrue(ITy);
2874 if (Pred == ICmpInst::ICMP_ULT)
2875 return getFalse(ITy);
2876 }
2877
2878 // 0 - (zext X) pred C
2879 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2880 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2881 if (RHSC->getValue().isStrictlyPositive()) {
2882 if (Pred == ICmpInst::ICMP_SLT)
2883 return ConstantInt::getTrue(RHSC->getContext());
2884 if (Pred == ICmpInst::ICMP_SGE)
2885 return ConstantInt::getFalse(RHSC->getContext());
2886 if (Pred == ICmpInst::ICMP_EQ)
2887 return ConstantInt::getFalse(RHSC->getContext());
2888 if (Pred == ICmpInst::ICMP_NE)
2889 return ConstantInt::getTrue(RHSC->getContext());
2890 }
2891 if (RHSC->getValue().isNonNegative()) {
2892 if (Pred == ICmpInst::ICMP_SLE)
2893 return ConstantInt::getTrue(RHSC->getContext());
2894 if (Pred == ICmpInst::ICMP_SGT)
2895 return ConstantInt::getFalse(RHSC->getContext());
2896 }
2897 }
2898 }
2899
2900 // icmp pred (urem X, Y), Y
2901 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002902 switch (Pred) {
2903 default:
2904 break;
2905 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002906 case ICmpInst::ICMP_SGE: {
2907 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2908 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002909 break;
2910 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002911 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002912 case ICmpInst::ICMP_EQ:
2913 case ICmpInst::ICMP_UGT:
2914 case ICmpInst::ICMP_UGE:
2915 return getFalse(ITy);
2916 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002917 case ICmpInst::ICMP_SLE: {
2918 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2919 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002920 break;
2921 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002922 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002923 case ICmpInst::ICMP_NE:
2924 case ICmpInst::ICMP_ULT:
2925 case ICmpInst::ICMP_ULE:
2926 return getTrue(ITy);
2927 }
2928 }
2929
2930 // icmp pred X, (urem Y, X)
2931 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002932 switch (Pred) {
2933 default:
2934 break;
2935 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002936 case ICmpInst::ICMP_SGE: {
2937 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2938 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002939 break;
2940 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002941 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002942 case ICmpInst::ICMP_NE:
2943 case ICmpInst::ICMP_UGT:
2944 case ICmpInst::ICMP_UGE:
2945 return getTrue(ITy);
2946 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002947 case ICmpInst::ICMP_SLE: {
2948 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2949 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002950 break;
2951 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002952 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002953 case ICmpInst::ICMP_EQ:
2954 case ICmpInst::ICMP_ULT:
2955 case ICmpInst::ICMP_ULE:
2956 return getFalse(ITy);
2957 }
2958 }
2959
2960 // x >> y <=u x
2961 // x udiv y <=u x.
2962 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2963 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2964 // icmp pred (X op Y), X
2965 if (Pred == ICmpInst::ICMP_UGT)
2966 return getFalse(ITy);
2967 if (Pred == ICmpInst::ICMP_ULE)
2968 return getTrue(ITy);
2969 }
2970
2971 // x >=u x >> y
2972 // x >=u x udiv y.
2973 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2974 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2975 // icmp pred X, (X op Y)
2976 if (Pred == ICmpInst::ICMP_ULT)
2977 return getFalse(ITy);
2978 if (Pred == ICmpInst::ICMP_UGE)
2979 return getTrue(ITy);
2980 }
2981
2982 // handle:
2983 // CI2 << X == CI
2984 // CI2 << X != CI
2985 //
2986 // where CI2 is a power of 2 and CI isn't
2987 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2988 const APInt *CI2Val, *CIVal = &CI->getValue();
2989 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2990 CI2Val->isPowerOf2()) {
2991 if (!CIVal->isPowerOf2()) {
2992 // CI2 << X can equal zero in some circumstances,
2993 // this simplification is unsafe if CI is zero.
2994 //
2995 // We know it is safe if:
2996 // - The shift is nsw, we can't shift out the one bit.
2997 // - The shift is nuw, we can't shift out the one bit.
2998 // - CI2 is one
2999 // - CI isn't zero
Florian Hahn19f9e322018-08-17 14:39:04 +00003000 if (Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(LBO)) ||
3001 Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(LBO)) ||
Craig Topper73ba1c82017-06-07 07:40:37 +00003002 CI2Val->isOneValue() || !CI->isZero()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003003 if (Pred == ICmpInst::ICMP_EQ)
3004 return ConstantInt::getFalse(RHS->getContext());
3005 if (Pred == ICmpInst::ICMP_NE)
3006 return ConstantInt::getTrue(RHS->getContext());
3007 }
3008 }
Craig Topper73ba1c82017-06-07 07:40:37 +00003009 if (CIVal->isSignMask() && CI2Val->isOneValue()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003010 if (Pred == ICmpInst::ICMP_UGT)
3011 return ConstantInt::getFalse(RHS->getContext());
3012 if (Pred == ICmpInst::ICMP_ULE)
3013 return ConstantInt::getTrue(RHS->getContext());
3014 }
3015 }
3016 }
3017
3018 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
3019 LBO->getOperand(1) == RBO->getOperand(1)) {
3020 switch (LBO->getOpcode()) {
3021 default:
3022 break;
3023 case Instruction::UDiv:
3024 case Instruction::LShr:
Florian Hahn19f9e322018-08-17 14:39:04 +00003025 if (ICmpInst::isSigned(Pred) || !Q.IIQ.isExact(LBO) ||
3026 !Q.IIQ.isExact(RBO))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003027 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00003028 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3029 RBO->getOperand(0), Q, MaxRecurse - 1))
3030 return V;
3031 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003032 case Instruction::SDiv:
Florian Hahn19f9e322018-08-17 14:39:04 +00003033 if (!ICmpInst::isEquality(Pred) || !Q.IIQ.isExact(LBO) ||
3034 !Q.IIQ.isExact(RBO))
Sanjay Patela23b1412017-05-15 19:16:49 +00003035 break;
3036 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3037 RBO->getOperand(0), Q, MaxRecurse - 1))
3038 return V;
3039 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003040 case Instruction::AShr:
Florian Hahn19f9e322018-08-17 14:39:04 +00003041 if (!Q.IIQ.isExact(LBO) || !Q.IIQ.isExact(RBO))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003042 break;
3043 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3044 RBO->getOperand(0), Q, MaxRecurse - 1))
3045 return V;
3046 break;
3047 case Instruction::Shl: {
Florian Hahn19f9e322018-08-17 14:39:04 +00003048 bool NUW = Q.IIQ.hasNoUnsignedWrap(LBO) && Q.IIQ.hasNoUnsignedWrap(RBO);
3049 bool NSW = Q.IIQ.hasNoSignedWrap(LBO) && Q.IIQ.hasNoSignedWrap(RBO);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003050 if (!NUW && !NSW)
3051 break;
3052 if (!NSW && ICmpInst::isSigned(Pred))
3053 break;
3054 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3055 RBO->getOperand(0), Q, MaxRecurse - 1))
3056 return V;
3057 break;
3058 }
3059 }
3060 }
3061 return nullptr;
3062}
3063
Sanjay Patel746ebb42018-11-01 14:07:39 +00003064static Value *simplifyICmpWithAbsNabs(CmpInst::Predicate Pred, Value *Op0,
3065 Value *Op1) {
3066 // We need a comparison with a constant.
3067 const APInt *C;
3068 if (!match(Op1, m_APInt(C)))
3069 return nullptr;
3070
3071 // matchSelectPattern returns the negation part of an abs pattern in SP1.
3072 // If the negate has an NSW flag, abs(INT_MIN) is undefined. Without that
3073 // constraint, we can't make a contiguous range for the result of abs.
3074 ICmpInst::Predicate AbsPred = ICmpInst::BAD_ICMP_PREDICATE;
3075 Value *SP0, *SP1;
3076 SelectPatternFlavor SPF = matchSelectPattern(Op0, SP0, SP1).Flavor;
3077 if (SPF == SelectPatternFlavor::SPF_ABS &&
3078 cast<Instruction>(SP1)->hasNoSignedWrap())
3079 // The result of abs(X) is >= 0 (with nsw).
3080 AbsPred = ICmpInst::ICMP_SGE;
3081 if (SPF == SelectPatternFlavor::SPF_NABS)
3082 // The result of -abs(X) is <= 0.
3083 AbsPred = ICmpInst::ICMP_SLE;
3084
3085 if (AbsPred == ICmpInst::BAD_ICMP_PREDICATE)
3086 return nullptr;
3087
3088 // If there is no intersection between abs/nabs and the range of this icmp,
3089 // the icmp must be false. If the abs/nabs range is a subset of the icmp
3090 // range, the icmp must be true.
3091 APInt Zero = APInt::getNullValue(C->getBitWidth());
3092 ConstantRange AbsRange = ConstantRange::makeExactICmpRegion(AbsPred, Zero);
3093 ConstantRange CmpRange = ConstantRange::makeExactICmpRegion(Pred, *C);
3094 if (AbsRange.intersectWith(CmpRange).isEmptySet())
3095 return getFalse(GetCompareTy(Op0));
3096 if (CmpRange.contains(AbsRange))
3097 return getTrue(GetCompareTy(Op0));
3098
3099 return nullptr;
3100}
3101
Sanjay Patel35289c62016-12-10 17:40:47 +00003102/// Simplify integer comparisons where at least one operand of the compare
3103/// matches an integer min/max idiom.
3104static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003105 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00003106 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003107 Type *ITy = GetCompareTy(LHS); // The return type.
3108 Value *A, *B;
3109 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
3110 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
3111
3112 // Signed variants on "max(a,b)>=a -> true".
3113 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3114 if (A != RHS)
3115 std::swap(A, B); // smax(A, B) pred A.
3116 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3117 // We analyze this as smax(A, B) pred A.
3118 P = Pred;
3119 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
3120 (A == LHS || B == LHS)) {
3121 if (A != LHS)
3122 std::swap(A, B); // A pred smax(A, B).
3123 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3124 // We analyze this as smax(A, B) swapped-pred A.
3125 P = CmpInst::getSwappedPredicate(Pred);
3126 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3127 (A == RHS || B == RHS)) {
3128 if (A != RHS)
3129 std::swap(A, B); // smin(A, B) pred A.
3130 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3131 // We analyze this as smax(-A, -B) swapped-pred -A.
3132 // Note that we do not need to actually form -A or -B thanks to EqP.
3133 P = CmpInst::getSwappedPredicate(Pred);
3134 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
3135 (A == LHS || B == LHS)) {
3136 if (A != LHS)
3137 std::swap(A, B); // A pred smin(A, B).
3138 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3139 // We analyze this as smax(-A, -B) pred -A.
3140 // Note that we do not need to actually form -A or -B thanks to EqP.
3141 P = Pred;
3142 }
3143 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3144 // Cases correspond to "max(A, B) p A".
3145 switch (P) {
3146 default:
3147 break;
3148 case CmpInst::ICMP_EQ:
3149 case CmpInst::ICMP_SLE:
3150 // Equivalent to "A EqP B". This may be the same as the condition tested
3151 // in the max/min; if so, we can just return that.
3152 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3153 return V;
3154 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3155 return V;
3156 // Otherwise, see if "A EqP B" simplifies.
3157 if (MaxRecurse)
3158 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3159 return V;
3160 break;
3161 case CmpInst::ICMP_NE:
3162 case CmpInst::ICMP_SGT: {
3163 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3164 // Equivalent to "A InvEqP B". This may be the same as the condition
3165 // tested in the max/min; if so, we can just return that.
3166 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3167 return V;
3168 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3169 return V;
3170 // Otherwise, see if "A InvEqP B" simplifies.
3171 if (MaxRecurse)
3172 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3173 return V;
3174 break;
3175 }
3176 case CmpInst::ICMP_SGE:
3177 // Always true.
3178 return getTrue(ITy);
3179 case CmpInst::ICMP_SLT:
3180 // Always false.
3181 return getFalse(ITy);
3182 }
3183 }
3184
3185 // Unsigned variants on "max(a,b)>=a -> true".
3186 P = CmpInst::BAD_ICMP_PREDICATE;
3187 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3188 if (A != RHS)
3189 std::swap(A, B); // umax(A, B) pred A.
3190 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3191 // We analyze this as umax(A, B) pred A.
3192 P = Pred;
3193 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
3194 (A == LHS || B == LHS)) {
3195 if (A != LHS)
3196 std::swap(A, B); // A pred umax(A, B).
3197 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3198 // We analyze this as umax(A, B) swapped-pred A.
3199 P = CmpInst::getSwappedPredicate(Pred);
3200 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3201 (A == RHS || B == RHS)) {
3202 if (A != RHS)
3203 std::swap(A, B); // umin(A, B) pred A.
3204 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3205 // We analyze this as umax(-A, -B) swapped-pred -A.
3206 // Note that we do not need to actually form -A or -B thanks to EqP.
3207 P = CmpInst::getSwappedPredicate(Pred);
3208 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
3209 (A == LHS || B == LHS)) {
3210 if (A != LHS)
3211 std::swap(A, B); // A pred umin(A, B).
3212 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3213 // We analyze this as umax(-A, -B) pred -A.
3214 // Note that we do not need to actually form -A or -B thanks to EqP.
3215 P = Pred;
3216 }
3217 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3218 // Cases correspond to "max(A, B) p A".
3219 switch (P) {
3220 default:
3221 break;
3222 case CmpInst::ICMP_EQ:
3223 case CmpInst::ICMP_ULE:
3224 // Equivalent to "A EqP B". This may be the same as the condition tested
3225 // in the max/min; if so, we can just return that.
3226 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3227 return V;
3228 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3229 return V;
3230 // Otherwise, see if "A EqP B" simplifies.
3231 if (MaxRecurse)
3232 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3233 return V;
3234 break;
3235 case CmpInst::ICMP_NE:
3236 case CmpInst::ICMP_UGT: {
3237 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3238 // Equivalent to "A InvEqP B". This may be the same as the condition
3239 // tested in the max/min; if so, we can just return that.
3240 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3241 return V;
3242 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3243 return V;
3244 // Otherwise, see if "A InvEqP B" simplifies.
3245 if (MaxRecurse)
3246 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3247 return V;
3248 break;
3249 }
3250 case CmpInst::ICMP_UGE:
3251 // Always true.
3252 return getTrue(ITy);
3253 case CmpInst::ICMP_ULT:
3254 // Always false.
3255 return getFalse(ITy);
3256 }
3257 }
3258
3259 // Variants on "max(x,y) >= min(x,z)".
3260 Value *C, *D;
3261 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3262 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3263 (A == C || A == D || B == C || B == D)) {
3264 // max(x, ?) pred min(x, ?).
3265 if (Pred == CmpInst::ICMP_SGE)
3266 // Always true.
3267 return getTrue(ITy);
3268 if (Pred == CmpInst::ICMP_SLT)
3269 // Always false.
3270 return getFalse(ITy);
3271 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3272 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3273 (A == C || A == D || B == C || B == D)) {
3274 // min(x, ?) pred max(x, ?).
3275 if (Pred == CmpInst::ICMP_SLE)
3276 // Always true.
3277 return getTrue(ITy);
3278 if (Pred == CmpInst::ICMP_SGT)
3279 // Always false.
3280 return getFalse(ITy);
3281 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3282 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3283 (A == C || A == D || B == C || B == D)) {
3284 // max(x, ?) pred min(x, ?).
3285 if (Pred == CmpInst::ICMP_UGE)
3286 // Always true.
3287 return getTrue(ITy);
3288 if (Pred == CmpInst::ICMP_ULT)
3289 // Always false.
3290 return getFalse(ITy);
3291 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3292 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3293 (A == C || A == D || B == C || B == D)) {
3294 // min(x, ?) pred max(x, ?).
3295 if (Pred == CmpInst::ICMP_ULE)
3296 // Always true.
3297 return getTrue(ITy);
3298 if (Pred == CmpInst::ICMP_UGT)
3299 // Always false.
3300 return getFalse(ITy);
3301 }
3302
3303 return nullptr;
3304}
3305
Sanjay Patel472cc782016-01-11 22:14:42 +00003306/// Given operands for an ICmpInst, see if we can fold the result.
3307/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003308static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003309 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003310 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003311 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003312
Chris Lattnera71e9d62009-11-10 00:55:12 +00003313 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003314 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003315 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003316
3317 // If we have a constant, make sure it is on the RHS.
3318 std::swap(LHS, RHS);
3319 Pred = CmpInst::getSwappedPredicate(Pred);
3320 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003321
Chris Lattner229907c2011-07-18 04:54:35 +00003322 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003323
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003324 // icmp X, X -> true/false
Sanjay Patel30be6652018-04-22 17:07:44 +00003325 // icmp X, undef -> true/false because undef could be X.
Duncan Sands772749a2011-01-01 20:08:02 +00003326 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003327 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003328
Sanjay Pateldc65a272016-12-03 17:30:22 +00003329 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3330 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003331
Sanjay Pateldc65a272016-12-03 17:30:22 +00003332 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3333 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003334
Florian Hahn19f9e322018-08-17 14:39:04 +00003335 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS, Q.IIQ))
Sanjay Patel67bde282016-08-22 23:12:02 +00003336 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003337
Chen Li7452d952015-09-26 03:26:47 +00003338 // If both operands have range metadata, use the metadata
3339 // to simplify the comparison.
3340 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003341 auto RHS_Instr = cast<Instruction>(RHS);
3342 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003343
Florian Hahn19f9e322018-08-17 14:39:04 +00003344 if (Q.IIQ.getMetadata(RHS_Instr, LLVMContext::MD_range) &&
3345 Q.IIQ.getMetadata(LHS_Instr, LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003346 auto RHS_CR = getConstantRangeFromMetadata(
3347 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3348 auto LHS_CR = getConstantRangeFromMetadata(
3349 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003350
3351 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3352 if (Satisfied_CR.contains(LHS_CR))
3353 return ConstantInt::getTrue(RHS->getContext());
3354
3355 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3356 CmpInst::getInversePredicate(Pred), RHS_CR);
3357 if (InversedSatisfied_CR.contains(LHS_CR))
3358 return ConstantInt::getFalse(RHS->getContext());
3359 }
3360 }
3361
Duncan Sands8fb2c382011-01-20 13:21:55 +00003362 // Compare of cast, for example (zext X) != 0 -> X != 0
3363 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3364 Instruction *LI = cast<CastInst>(LHS);
3365 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003366 Type *SrcTy = SrcOp->getType();
3367 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003368
3369 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3370 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003371 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3372 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003373 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3374 // Transfer the cast to the constant.
3375 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3376 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003377 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003378 return V;
3379 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3380 if (RI->getOperand(0)->getType() == SrcTy)
3381 // Compare without the cast.
3382 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003383 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003384 return V;
3385 }
3386 }
3387
3388 if (isa<ZExtInst>(LHS)) {
3389 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3390 // same type.
3391 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3392 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3393 // Compare X and Y. Note that signed predicates become unsigned.
3394 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003395 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003396 MaxRecurse-1))
3397 return V;
3398 }
3399 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3400 // too. If not, then try to deduce the result of the comparison.
3401 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3402 // Compute the constant that would happen if we truncated to SrcTy then
3403 // reextended to DstTy.
3404 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3405 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3406
3407 // If the re-extended constant didn't change then this is effectively
3408 // also a case of comparing two zero-extended values.
3409 if (RExt == CI && MaxRecurse)
3410 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003411 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003412 return V;
3413
3414 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3415 // there. Use this to work out the result of the comparison.
3416 if (RExt != CI) {
3417 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003418 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003419 // LHS <u RHS.
3420 case ICmpInst::ICMP_EQ:
3421 case ICmpInst::ICMP_UGT:
3422 case ICmpInst::ICMP_UGE:
3423 return ConstantInt::getFalse(CI->getContext());
3424
3425 case ICmpInst::ICMP_NE:
3426 case ICmpInst::ICMP_ULT:
3427 case ICmpInst::ICMP_ULE:
3428 return ConstantInt::getTrue(CI->getContext());
3429
3430 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3431 // is non-negative then LHS <s RHS.
3432 case ICmpInst::ICMP_SGT:
3433 case ICmpInst::ICMP_SGE:
3434 return CI->getValue().isNegative() ?
3435 ConstantInt::getTrue(CI->getContext()) :
3436 ConstantInt::getFalse(CI->getContext());
3437
3438 case ICmpInst::ICMP_SLT:
3439 case ICmpInst::ICMP_SLE:
3440 return CI->getValue().isNegative() ?
3441 ConstantInt::getFalse(CI->getContext()) :
3442 ConstantInt::getTrue(CI->getContext());
3443 }
3444 }
3445 }
3446 }
3447
3448 if (isa<SExtInst>(LHS)) {
3449 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3450 // same type.
3451 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3452 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3453 // Compare X and Y. Note that the predicate does not change.
3454 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003455 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003456 return V;
3457 }
3458 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3459 // too. If not, then try to deduce the result of the comparison.
3460 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3461 // Compute the constant that would happen if we truncated to SrcTy then
3462 // reextended to DstTy.
3463 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3464 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3465
3466 // If the re-extended constant didn't change then this is effectively
3467 // also a case of comparing two sign-extended values.
3468 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003469 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003470 return V;
3471
3472 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3473 // bits there. Use this to work out the result of the comparison.
3474 if (RExt != CI) {
3475 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003476 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003477 case ICmpInst::ICMP_EQ:
3478 return ConstantInt::getFalse(CI->getContext());
3479 case ICmpInst::ICMP_NE:
3480 return ConstantInt::getTrue(CI->getContext());
3481
3482 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3483 // LHS >s RHS.
3484 case ICmpInst::ICMP_SGT:
3485 case ICmpInst::ICMP_SGE:
3486 return CI->getValue().isNegative() ?
3487 ConstantInt::getTrue(CI->getContext()) :
3488 ConstantInt::getFalse(CI->getContext());
3489 case ICmpInst::ICMP_SLT:
3490 case ICmpInst::ICMP_SLE:
3491 return CI->getValue().isNegative() ?
3492 ConstantInt::getFalse(CI->getContext()) :
3493 ConstantInt::getTrue(CI->getContext());
3494
3495 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3496 // LHS >u RHS.
3497 case ICmpInst::ICMP_UGT:
3498 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003499 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003500 if (MaxRecurse)
3501 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3502 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003503 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003504 return V;
3505 break;
3506 case ICmpInst::ICMP_ULT:
3507 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003508 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003509 if (MaxRecurse)
3510 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3511 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003512 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003513 return V;
3514 break;
3515 }
3516 }
3517 }
3518 }
3519 }
3520
James Molloy1d88d6f2015-10-22 13:18:42 +00003521 // icmp eq|ne X, Y -> false|true if X != Y
Craig Topperc2790ec2017-06-06 07:13:04 +00003522 if (ICmpInst::isEquality(Pred) &&
Florian Hahn19f9e322018-08-17 14:39:04 +00003523 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo)) {
Craig Topper2dfb4802017-06-06 07:13:13 +00003524 return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
James Molloy1d88d6f2015-10-22 13:18:42 +00003525 }
Junmo Park53470fc2016-04-05 21:14:31 +00003526
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003527 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3528 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003529
Sanjay Patel35289c62016-12-10 17:40:47 +00003530 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003531 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003532
Sanjay Patel746ebb42018-11-01 14:07:39 +00003533 if (Value *V = simplifyICmpWithAbsNabs(Pred, LHS, RHS))
3534 return V;
3535
Chandler Carruth8059c842012-03-25 21:28:14 +00003536 // Simplify comparisons of related pointers using a powerful, recursive
3537 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003538 if (LHS->getType()->isPointerTy())
Florian Hahn19f9e322018-08-17 14:39:04 +00003539 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
3540 Q.IIQ, LHS, RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003541 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003542 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3543 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3544 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3545 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3546 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3547 Q.DL.getTypeSizeInBits(CRHS->getType()))
Nuno Lopes404f1062017-09-09 18:23:11 +00003548 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +00003549 Q.IIQ, CLHS->getPointerOperand(),
David Majnemerdc8767a2016-08-07 07:58:10 +00003550 CRHS->getPointerOperand()))
3551 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003552
Nick Lewycky3db143e2012-02-26 02:09:49 +00003553 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3554 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3555 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3556 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3557 (ICmpInst::isEquality(Pred) ||
3558 (GLHS->isInBounds() && GRHS->isInBounds() &&
3559 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3560 // The bases are equal and the indices are constant. Build a constant
3561 // expression GEP with the same indices and a null base pointer to see
3562 // what constant folding can make out of it.
3563 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3564 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003565 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3566 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003567
3568 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003569 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3570 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003571 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3572 }
3573 }
3574 }
3575
Duncan Sandsf532d312010-11-07 16:12:23 +00003576 // If the comparison is with the result of a select instruction, check whether
3577 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003578 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003579 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003580 return V;
3581
3582 // If the comparison is with the result of a phi instruction, check whether
3583 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003584 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003585 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003586 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003587
Craig Topper9f008862014-04-15 04:59:12 +00003588 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003589}
3590
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003591Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003592 const SimplifyQuery &Q) {
3593 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3594}
3595
Sanjay Patel472cc782016-01-11 22:14:42 +00003596/// Given operands for an FCmpInst, see if we can fold the result.
3597/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003598static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003599 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003600 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003601 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3602 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3603
Chris Lattnera71e9d62009-11-10 00:55:12 +00003604 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003605 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003606 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003607
Chris Lattnera71e9d62009-11-10 00:55:12 +00003608 // If we have a constant, make sure it is on the RHS.
3609 std::swap(LHS, RHS);
3610 Pred = CmpInst::getSwappedPredicate(Pred);
3611 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003612
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003613 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003614 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003615 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003616 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003617 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003618 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003619
Sanjay Patelf3ae9cc2018-08-21 14:45:13 +00003620 // Fold (un)ordered comparison if we can determine there are no NaNs.
3621 if (Pred == FCmpInst::FCMP_UNO || Pred == FCmpInst::FCMP_ORD)
3622 if (FMF.noNaNs() ||
3623 (isKnownNeverNaN(LHS, Q.TLI) && isKnownNeverNaN(RHS, Q.TLI)))
3624 return ConstantInt::get(RetTy, Pred == FCmpInst::FCMP_ORD);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003625
Sanjay Patel46b083e2018-03-02 18:36:08 +00003626 // NaN is unordered; NaN is not ordered.
3627 assert((FCmpInst::isOrdered(Pred) || FCmpInst::isUnordered(Pred)) &&
3628 "Comparison must be either ordered or unordered");
3629 if (match(RHS, m_NaN()))
3630 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3631
Mehdi Aminieb242a52015-03-09 03:20:25 +00003632 // fcmp pred x, undef and fcmp pred undef, x
3633 // fold to true if unordered, false if ordered
3634 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3635 // Choosing NaN for the undef will always make unordered comparison succeed
3636 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003637 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003638 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003639
3640 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003641 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003642 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003643 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003644 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003645 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003646 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003647
Sanjay Patel4ca99682017-11-27 16:37:09 +00003648 // Handle fcmp with constant RHS.
3649 const APFloat *C;
3650 if (match(RHS, m_APFloat(C))) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003651 // Check whether the constant is an infinity.
Sanjay Patel4ca99682017-11-27 16:37:09 +00003652 if (C->isInfinity()) {
3653 if (C->isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003654 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003655 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003656 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003657 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003658 case FCmpInst::FCMP_UGE:
3659 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003660 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003661 default:
3662 break;
3663 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003664 } else {
3665 switch (Pred) {
3666 case FCmpInst::FCMP_OGT:
3667 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003668 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003669 case FCmpInst::FCMP_ULE:
3670 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003671 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003672 default:
3673 break;
3674 }
3675 }
3676 }
Sanjay Patel4ca99682017-11-27 16:37:09 +00003677 if (C->isZero()) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003678 switch (Pred) {
Sanjay Patel85cba3b2018-10-31 14:57:23 +00003679 case FCmpInst::FCMP_OGE:
3680 if (FMF.noNaNs() && CannotBeOrderedLessThanZero(LHS, Q.TLI))
3681 return getTrue(RetTy);
3682 break;
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003683 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003684 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003685 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003686 break;
Sanjay Pateld4dc30c2018-10-31 15:35:46 +00003687 case FCmpInst::FCMP_ULT:
3688 if (FMF.noNaNs() && CannotBeOrderedLessThanZero(LHS, Q.TLI))
3689 return getFalse(RetTy);
3690 break;
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003691 case FCmpInst::FCMP_OLT:
David Majnemer3ee5f342016-04-13 06:55:52 +00003692 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003693 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003694 break;
3695 default:
3696 break;
3697 }
Florian Hahn30932a32017-12-01 12:34:16 +00003698 } else if (C->isNegative()) {
3699 assert(!C->isNaN() && "Unexpected NaN constant!");
3700 // TODO: We can catch more cases by using a range check rather than
3701 // relying on CannotBeOrderedLessThanZero.
3702 switch (Pred) {
3703 case FCmpInst::FCMP_UGE:
3704 case FCmpInst::FCMP_UGT:
3705 case FCmpInst::FCMP_UNE:
3706 // (X >= 0) implies (X > C) when (C < 0)
3707 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3708 return getTrue(RetTy);
3709 break;
3710 case FCmpInst::FCMP_OEQ:
3711 case FCmpInst::FCMP_OLE:
3712 case FCmpInst::FCMP_OLT:
3713 // (X >= 0) implies !(X < C) when (C < 0)
3714 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3715 return getFalse(RetTy);
3716 break;
3717 default:
3718 break;
3719 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003720 }
3721 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003722
Duncan Sandsa620bd12010-11-07 16:46:25 +00003723 // If the comparison is with the result of a select instruction, check whether
3724 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003725 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003726 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003727 return V;
3728
3729 // If the comparison is with the result of a phi instruction, check whether
3730 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003731 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003732 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003733 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003734
Craig Topper9f008862014-04-15 04:59:12 +00003735 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003736}
3737
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003738Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003739 FastMathFlags FMF, const SimplifyQuery &Q) {
3740 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003741}
3742
Sanjay Patel472cc782016-01-11 22:14:42 +00003743/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003744static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003745 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003746 unsigned MaxRecurse) {
3747 // Trivial replacement.
3748 if (V == Op)
3749 return RepOp;
3750
Tim Northover997f5f12017-05-22 21:28:08 +00003751 // We cannot replace a constant, and shouldn't even try.
3752 if (isa<Constant>(Op))
3753 return nullptr;
3754
David Majnemer3f0fb982015-06-06 22:40:21 +00003755 auto *I = dyn_cast<Instruction>(V);
3756 if (!I)
3757 return nullptr;
3758
3759 // If this is a binary operator, try to simplify it with the replaced op.
3760 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3761 // Consider:
3762 // %cmp = icmp eq i32 %x, 2147483647
3763 // %add = add nsw i32 %x, 1
3764 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3765 //
3766 // We can't replace %sel with %add unless we strip away the flags.
3767 if (isa<OverflowingBinaryOperator>(B))
Florian Hahn19f9e322018-08-17 14:39:04 +00003768 if (Q.IIQ.hasNoSignedWrap(B) || Q.IIQ.hasNoUnsignedWrap(B))
David Majnemer3f0fb982015-06-06 22:40:21 +00003769 return nullptr;
Florian Hahn19f9e322018-08-17 14:39:04 +00003770 if (isa<PossiblyExactOperator>(B) && Q.IIQ.isExact(B))
3771 return nullptr;
David Majnemer3f0fb982015-06-06 22:40:21 +00003772
3773 if (MaxRecurse) {
3774 if (B->getOperand(0) == Op)
3775 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3776 MaxRecurse - 1);
3777 if (B->getOperand(1) == Op)
3778 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3779 MaxRecurse - 1);
3780 }
3781 }
3782
3783 // Same for CmpInsts.
3784 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3785 if (MaxRecurse) {
3786 if (C->getOperand(0) == Op)
3787 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3788 MaxRecurse - 1);
3789 if (C->getOperand(1) == Op)
3790 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3791 MaxRecurse - 1);
3792 }
3793 }
3794
George Burgess IV8e807bf2018-04-24 00:25:01 +00003795 // Same for GEPs.
3796 if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
3797 if (MaxRecurse) {
3798 SmallVector<Value *, 8> NewOps(GEP->getNumOperands());
3799 transform(GEP->operands(), NewOps.begin(),
3800 [&](Value *V) { return V == Op ? RepOp : V; });
3801 return SimplifyGEPInst(GEP->getSourceElementType(), NewOps, Q,
3802 MaxRecurse - 1);
3803 }
3804 }
3805
David Majnemer3f0fb982015-06-06 22:40:21 +00003806 // TODO: We could hand off more cases to instsimplify here.
3807
3808 // If all operands are constant after substituting Op for RepOp then we can
3809 // constant fold the instruction.
3810 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3811 // Build a list of all constant operands.
3812 SmallVector<Constant *, 8> ConstOps;
3813 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3814 if (I->getOperand(i) == Op)
3815 ConstOps.push_back(CRepOp);
3816 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3817 ConstOps.push_back(COp);
3818 else
3819 break;
3820 }
3821
3822 // All operands were constants, fold it.
3823 if (ConstOps.size() == I->getNumOperands()) {
3824 if (CmpInst *C = dyn_cast<CmpInst>(I))
3825 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3826 ConstOps[1], Q.DL, Q.TLI);
3827
3828 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3829 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003830 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003831
Manuel Jacobe9024592016-01-21 06:33:22 +00003832 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003833 }
3834 }
3835
3836 return nullptr;
3837}
3838
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003839/// Try to simplify a select instruction when its condition operand is an
3840/// integer comparison where one operand of the compare is a constant.
3841static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3842 const APInt *Y, bool TrueWhenUnset) {
3843 const APInt *C;
3844
3845 // (X & Y) == 0 ? X & ~Y : X --> X
3846 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3847 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3848 *Y == ~*C)
3849 return TrueWhenUnset ? FalseVal : TrueVal;
3850
3851 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3852 // (X & Y) != 0 ? X : X & ~Y --> X
3853 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3854 *Y == ~*C)
3855 return TrueWhenUnset ? FalseVal : TrueVal;
3856
3857 if (Y->isPowerOf2()) {
3858 // (X & Y) == 0 ? X | Y : X --> X | Y
3859 // (X & Y) != 0 ? X | Y : X --> X
3860 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3861 *Y == *C)
3862 return TrueWhenUnset ? TrueVal : FalseVal;
3863
3864 // (X & Y) == 0 ? X : X | Y --> X
3865 // (X & Y) != 0 ? X : X | Y --> X | Y
3866 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3867 *Y == *C)
3868 return TrueWhenUnset ? TrueVal : FalseVal;
3869 }
Matt Arsenault82606662017-01-11 00:57:54 +00003870
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003871 return nullptr;
3872}
3873
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003874/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3875/// eq/ne.
Craig Topper0aa3a192017-08-14 21:39:51 +00003876static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3877 ICmpInst::Predicate Pred,
3878 Value *TrueVal, Value *FalseVal) {
3879 Value *X;
3880 APInt Mask;
3881 if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3882 return nullptr;
3883
Craig Topper0aa3a192017-08-14 21:39:51 +00003884 return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3885 Pred == ICmpInst::ICMP_EQ);
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003886}
3887
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003888/// Try to simplify a select instruction when its condition operand is an
3889/// integer comparison.
3890static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003891 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003892 unsigned MaxRecurse) {
3893 ICmpInst::Predicate Pred;
3894 Value *CmpLHS, *CmpRHS;
3895 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3896 return nullptr;
3897
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003898 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3899 Value *X;
3900 const APInt *Y;
3901 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3902 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3903 Pred == ICmpInst::ICMP_EQ))
3904 return V;
Sanjay Patele98ec772018-11-15 14:53:37 +00003905
3906 // Test for zero-shift-guard-ops around funnel shifts. These are used to
3907 // avoid UB from oversized shifts in raw IR rotate patterns, but the
3908 // intrinsics do not have that problem.
3909 Value *ShAmt;
3910 auto isFsh = m_CombineOr(m_Intrinsic<Intrinsic::fshl>(m_Value(X), m_Value(),
3911 m_Value(ShAmt)),
3912 m_Intrinsic<Intrinsic::fshr>(m_Value(), m_Value(X),
3913 m_Value(ShAmt)));
3914 // (ShAmt != 0) ? fshl(X, *, ShAmt) : X --> fshl(X, *, ShAmt)
3915 // (ShAmt != 0) ? fshr(*, X, ShAmt) : X --> fshr(*, X, ShAmt)
3916 // (ShAmt == 0) ? fshl(X, *, ShAmt) : X --> X
3917 // (ShAmt == 0) ? fshr(*, X, ShAmt) : X --> X
3918 if (match(TrueVal, isFsh) && FalseVal == X && CmpLHS == ShAmt)
3919 return Pred == ICmpInst::ICMP_NE ? TrueVal : X;
3920
3921 // (ShAmt == 0) ? X : fshl(X, *, ShAmt) --> fshl(X, *, ShAmt)
3922 // (ShAmt == 0) ? X : fshr(*, X, ShAmt) --> fshr(*, X, ShAmt)
3923 // (ShAmt != 0) ? X : fshl(X, *, ShAmt) --> X
3924 // (ShAmt != 0) ? X : fshr(*, X, ShAmt) --> X
3925 if (match(FalseVal, isFsh) && TrueVal == X && CmpLHS == ShAmt)
3926 return Pred == ICmpInst::ICMP_EQ ? FalseVal : X;
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003927 }
3928
Craig Topper0aa3a192017-08-14 21:39:51 +00003929 // Check for other compares that behave like bit test.
3930 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3931 TrueVal, FalseVal))
3932 return V;
3933
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003934 // If we have an equality comparison, then we know the value in one of the
3935 // arms of the select. See if substituting this value into the arm and
3936 // simplifying the result yields the same value as the other arm.
3937 if (Pred == ICmpInst::ICMP_EQ) {
3938 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3939 TrueVal ||
3940 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3941 TrueVal)
3942 return FalseVal;
3943 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3944 FalseVal ||
3945 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3946 FalseVal)
3947 return FalseVal;
3948 } else if (Pred == ICmpInst::ICMP_NE) {
3949 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3950 FalseVal ||
3951 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3952 FalseVal)
3953 return TrueVal;
3954 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3955 TrueVal ||
3956 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3957 TrueVal)
3958 return TrueVal;
3959 }
3960
3961 return nullptr;
3962}
3963
Sanjay Patel14401072018-11-05 21:51:39 +00003964/// Try to simplify a select instruction when its condition operand is a
3965/// floating-point comparison.
3966static Value *simplifySelectWithFCmp(Value *Cond, Value *T, Value *F) {
3967 FCmpInst::Predicate Pred;
3968 if (!match(Cond, m_FCmp(Pred, m_Specific(T), m_Specific(F))) &&
3969 !match(Cond, m_FCmp(Pred, m_Specific(F), m_Specific(T))))
3970 return nullptr;
3971
3972 // TODO: The transform may not be valid with -0.0. An incomplete way of
3973 // testing for that possibility is to check if at least one operand is a
3974 // non-zero constant.
3975 const APFloat *C;
3976 if ((match(T, m_APFloat(C)) && C->isNonZero()) ||
3977 (match(F, m_APFloat(C)) && C->isNonZero())) {
3978 // (T == F) ? T : F --> F
3979 // (F == T) ? T : F --> F
3980 if (Pred == FCmpInst::FCMP_OEQ)
3981 return F;
3982
3983 // (T != F) ? T : F --> T
3984 // (F != T) ? T : F --> T
3985 if (Pred == FCmpInst::FCMP_UNE)
3986 return T;
3987 }
3988
3989 return nullptr;
3990}
3991
Sanjay Patel472cc782016-01-11 22:14:42 +00003992/// Given operands for a SelectInst, see if we can fold the result.
3993/// If not, this returns null.
Sanjay Patelac395202018-02-17 14:50:13 +00003994static Value *SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3995 const SimplifyQuery &Q, unsigned MaxRecurse) {
3996 if (auto *CondC = dyn_cast<Constant>(Cond)) {
3997 if (auto *TrueC = dyn_cast<Constant>(TrueVal))
3998 if (auto *FalseC = dyn_cast<Constant>(FalseVal))
3999 return ConstantFoldSelectInstruction(CondC, TrueC, FalseC);
4000
4001 // select undef, X, Y -> X or Y
4002 if (isa<UndefValue>(CondC))
4003 return isa<Constant>(FalseVal) ? FalseVal : TrueVal;
4004
4005 // TODO: Vector constants with undef elements don't simplify.
4006
4007 // select true, X, Y -> X
4008 if (CondC->isAllOnesValue())
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00004009 return TrueVal;
Sanjay Patelac395202018-02-17 14:50:13 +00004010 // select false, X, Y -> Y
4011 if (CondC->isNullValue())
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00004012 return FalseVal;
4013 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004014
Sanjay Patelac395202018-02-17 14:50:13 +00004015 // select ?, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00004016 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00004017 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00004018
Sanjay Patelac395202018-02-17 14:50:13 +00004019 if (isa<UndefValue>(TrueVal)) // select ?, undef, X -> X
Dan Gohman54664ed2011-07-01 01:03:43 +00004020 return FalseVal;
Sanjay Patelac395202018-02-17 14:50:13 +00004021 if (isa<UndefValue>(FalseVal)) // select ?, X, undef -> X
Dan Gohman54664ed2011-07-01 01:03:43 +00004022 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00004023
Sanjay Patel5f5eb582016-07-18 20:56:53 +00004024 if (Value *V =
Sanjay Patelac395202018-02-17 14:50:13 +00004025 simplifySelectWithICmpCond(Cond, TrueVal, FalseVal, Q, MaxRecurse))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00004026 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00004027
Sanjay Patel14401072018-11-05 21:51:39 +00004028 if (Value *V = simplifySelectWithFCmp(Cond, TrueVal, FalseVal))
4029 return V;
4030
David Bolvanskyf9476082018-07-28 06:55:51 +00004031 if (Value *V = foldSelectWithBinaryOp(Cond, TrueVal, FalseVal))
4032 return V;
4033
Sanjay Patel7d82d372018-12-02 13:26:03 +00004034 Optional<bool> Imp = isImpliedByDomCondition(Cond, Q.CxtI, Q.DL);
4035 if (Imp)
4036 return *Imp ? TrueVal : FalseVal;
Sanjay Pateld8022702018-11-29 18:44:39 +00004037
Craig Topper9f008862014-04-15 04:59:12 +00004038 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004039}
4040
Duncan Sandsb8cee002012-03-13 11:42:19 +00004041Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004042 const SimplifyQuery &Q) {
4043 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00004044}
4045
Sanjay Patel472cc782016-01-11 22:14:42 +00004046/// Given operands for an GetElementPtrInst, see if we can fold the result.
4047/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00004048static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004049 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00004050 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00004051 unsigned AS =
4052 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00004053
Chris Lattner8574aba2009-11-27 00:29:05 +00004054 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00004055 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00004056 return Ops[0];
4057
Nico Weber48c82402014-08-27 20:06:19 +00004058 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00004059 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00004060 Type *GEPTy = PointerType::get(LastType, AS);
4061 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
4062 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00004063 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
4064 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00004065
4066 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00004067 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00004068
Jay Foadb992a632011-07-19 15:07:52 +00004069 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00004070 // getelementptr P, 0 -> P.
Matthew Simpsonc1c4ad62018-03-15 16:00:29 +00004071 if (match(Ops[1], m_Zero()) && Ops[0]->getType() == GEPTy)
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00004072 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00004073
David Blaikie4a2e73b2015-04-02 18:55:32 +00004074 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004075 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00004076 Value *P;
4077 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004078 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00004079 // getelementptr P, N -> P if P points to a type of zero size.
Matthew Simpsonc1c4ad62018-03-15 16:00:29 +00004080 if (TyAllocSize == 0 && Ops[0]->getType() == GEPTy)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00004081 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00004082
4083 // The following transforms are only safe if the ptrtoint cast
4084 // doesn't truncate the pointers.
4085 if (Ops[1]->getType()->getScalarSizeInBits() ==
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00004086 Q.DL.getIndexSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00004087 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
4088 if (match(P, m_Zero()))
4089 return Constant::getNullValue(GEPTy);
4090 Value *Temp;
4091 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00004092 if (Temp->getType() == GEPTy)
4093 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00004094 return nullptr;
4095 };
4096
4097 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
4098 if (TyAllocSize == 1 &&
4099 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
4100 if (Value *R = PtrToIntOrZero(P))
4101 return R;
4102
4103 // getelementptr V, (ashr (sub P, V), C) -> Q
4104 // if P points to a type of size 1 << C.
4105 if (match(Ops[1],
4106 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
4107 m_ConstantInt(C))) &&
4108 TyAllocSize == 1ULL << C)
4109 if (Value *R = PtrToIntOrZero(P))
4110 return R;
4111
4112 // getelementptr V, (sdiv (sub P, V), C) -> Q
4113 // if P points to a type of size C.
4114 if (match(Ops[1],
4115 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
4116 m_SpecificInt(TyAllocSize))))
4117 if (Value *R = PtrToIntOrZero(P))
4118 return R;
4119 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00004120 }
4121 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004122
David Majnemerd1501372016-08-07 07:58:12 +00004123 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
4124 all_of(Ops.slice(1).drop_back(1),
4125 [](Value *Idx) { return match(Idx, m_Zero()); })) {
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00004126 unsigned IdxWidth =
4127 Q.DL.getIndexSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
4128 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == IdxWidth) {
4129 APInt BasePtrOffset(IdxWidth, 0);
David Majnemerd1501372016-08-07 07:58:12 +00004130 Value *StrippedBasePtr =
4131 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
4132 BasePtrOffset);
4133
David Majnemer5c5df622016-08-16 06:13:46 +00004134 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00004135 if (match(Ops.back(),
4136 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
4137 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
4138 return ConstantExpr::getIntToPtr(CI, GEPTy);
4139 }
David Majnemer5c5df622016-08-16 06:13:46 +00004140 // gep (gep V, C), (xor V, -1) -> C-1
4141 if (match(Ops.back(),
4142 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
4143 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
4144 return ConstantExpr::getIntToPtr(CI, GEPTy);
4145 }
David Majnemerd1501372016-08-07 07:58:12 +00004146 }
4147 }
4148
Chris Lattner8574aba2009-11-27 00:29:05 +00004149 // Check to see if this is constant foldable.
Craig Topperda8037f2017-06-04 22:41:56 +00004150 if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
4151 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00004152
Joey Gouly61eaa632017-06-06 10:17:14 +00004153 auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
4154 Ops.slice(1));
4155 if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
4156 return CEFolded;
4157 return CE;
Chris Lattner8574aba2009-11-27 00:29:05 +00004158}
4159
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004160Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004161 const SimplifyQuery &Q) {
4162 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00004163}
4164
Sanjay Patel472cc782016-01-11 22:14:42 +00004165/// Given operands for an InsertValueInst, see if we can fold the result.
4166/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00004167static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004168 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00004169 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00004170 if (Constant *CAgg = dyn_cast<Constant>(Agg))
4171 if (Constant *CVal = dyn_cast<Constant>(Val))
4172 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
4173
4174 // insertvalue x, undef, n -> x
4175 if (match(Val, m_Undef()))
4176 return Agg;
4177
4178 // insertvalue x, (extractvalue y, n), n
4179 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00004180 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
4181 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00004182 // insertvalue undef, (extractvalue y, n), n -> y
4183 if (match(Agg, m_Undef()))
4184 return EV->getAggregateOperand();
4185
4186 // insertvalue y, (extractvalue y, n), n -> y
4187 if (Agg == EV->getAggregateOperand())
4188 return Agg;
4189 }
4190
Craig Topper9f008862014-04-15 04:59:12 +00004191 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00004192}
4193
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004194Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
4195 ArrayRef<unsigned> Idxs,
4196 const SimplifyQuery &Q) {
4197 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
4198}
4199
Igor Laevskye0edb662017-12-13 11:21:18 +00004200Value *llvm::SimplifyInsertElementInst(Value *Vec, Value *Val, Value *Idx,
4201 const SimplifyQuery &Q) {
4202 // Try to constant fold.
4203 auto *VecC = dyn_cast<Constant>(Vec);
4204 auto *ValC = dyn_cast<Constant>(Val);
4205 auto *IdxC = dyn_cast<Constant>(Idx);
4206 if (VecC && ValC && IdxC)
4207 return ConstantFoldInsertElementInstruction(VecC, ValC, IdxC);
4208
4209 // Fold into undef if index is out of bounds.
4210 if (auto *CI = dyn_cast<ConstantInt>(Idx)) {
4211 uint64_t NumElements = cast<VectorType>(Vec->getType())->getNumElements();
Igor Laevskye0edb662017-12-13 11:21:18 +00004212 if (CI->uge(NumElements))
4213 return UndefValue::get(Vec->getType());
4214 }
4215
Philip Reamese499bc32017-12-30 05:54:22 +00004216 // If index is undef, it might be out of bounds (see above case)
4217 if (isa<UndefValue>(Idx))
4218 return UndefValue::get(Vec->getType());
Igor Laevskye0edb662017-12-13 11:21:18 +00004219
4220 return nullptr;
4221}
4222
Sanjay Patel472cc782016-01-11 22:14:42 +00004223/// Given operands for an ExtractValueInst, see if we can fold the result.
4224/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00004225static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004226 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00004227 if (auto *CAgg = dyn_cast<Constant>(Agg))
4228 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
4229
4230 // extractvalue x, (insertvalue y, elt, n), n -> elt
4231 unsigned NumIdxs = Idxs.size();
4232 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
4233 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
4234 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
4235 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
4236 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
4237 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
4238 Idxs.slice(0, NumCommonIdxs)) {
4239 if (NumIdxs == NumInsertValueIdxs)
4240 return IVI->getInsertedValueOperand();
4241 break;
4242 }
4243 }
4244
4245 return nullptr;
4246}
4247
4248Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004249 const SimplifyQuery &Q) {
4250 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
4251}
4252
Sanjay Patel472cc782016-01-11 22:14:42 +00004253/// Given operands for an ExtractElementInst, see if we can fold the result.
4254/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004255static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00004256 unsigned) {
4257 if (auto *CVec = dyn_cast<Constant>(Vec)) {
4258 if (auto *CIdx = dyn_cast<Constant>(Idx))
4259 return ConstantFoldExtractElementInstruction(CVec, CIdx);
4260
4261 // The index is not relevant if our vector is a splat.
4262 if (auto *Splat = CVec->getSplatValue())
4263 return Splat;
4264
4265 if (isa<UndefValue>(Vec))
4266 return UndefValue::get(Vec->getType()->getVectorElementType());
4267 }
4268
4269 // If extracting a specified index from the vector, see if we can recursively
4270 // find a previously computed scalar that was inserted into the vector.
Philip Reamese499bc32017-12-30 05:54:22 +00004271 if (auto *IdxC = dyn_cast<ConstantInt>(Idx)) {
4272 if (IdxC->getValue().uge(Vec->getType()->getVectorNumElements()))
4273 // definitely out of bounds, thus undefined result
4274 return UndefValue::get(Vec->getType()->getVectorElementType());
4275 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
4276 return Elt;
4277 }
David Majnemer599ca442015-07-13 01:15:53 +00004278
Zvi Rackover2e6e88f2017-12-06 17:51:46 +00004279 // An undef extract index can be arbitrarily chosen to be an out-of-range
4280 // index value, which would result in the instruction being undef.
4281 if (isa<UndefValue>(Idx))
4282 return UndefValue::get(Vec->getType()->getVectorElementType());
4283
David Majnemer599ca442015-07-13 01:15:53 +00004284 return nullptr;
4285}
4286
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004287Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
4288 const SimplifyQuery &Q) {
4289 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
4290}
4291
Sanjay Patel472cc782016-01-11 22:14:42 +00004292/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004293static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004294 // If all of the PHI's incoming values are the same then replace the PHI node
4295 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00004296 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004297 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00004298 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004299 // If the incoming value is the phi node itself, it can safely be skipped.
4300 if (Incoming == PN) continue;
4301 if (isa<UndefValue>(Incoming)) {
4302 // Remember that we saw an undef value, but otherwise ignore them.
4303 HasUndefInput = true;
4304 continue;
4305 }
4306 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00004307 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00004308 CommonValue = Incoming;
4309 }
4310
4311 // If CommonValue is null then all of the incoming values were either undef or
4312 // equal to the phi node itself.
4313 if (!CommonValue)
4314 return UndefValue::get(PN->getType());
4315
4316 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4317 // instruction, we cannot return X as the result of the PHI node unless it
4318 // dominates the PHI block.
4319 if (HasUndefInput)
Sanjay Patel5da361a2018-04-10 18:38:19 +00004320 return valueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004321
4322 return CommonValue;
4323}
4324
David Majnemer6774d612016-07-26 17:58:05 +00004325static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004326 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004327 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004328 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004329
David Majnemer6774d612016-07-26 17:58:05 +00004330 if (auto *CI = dyn_cast<CastInst>(Op)) {
4331 auto *Src = CI->getOperand(0);
4332 Type *SrcTy = Src->getType();
4333 Type *MidTy = CI->getType();
4334 Type *DstTy = Ty;
4335 if (Src->getType() == Ty) {
4336 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4337 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4338 Type *SrcIntPtrTy =
4339 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4340 Type *MidIntPtrTy =
4341 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4342 Type *DstIntPtrTy =
4343 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4344 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4345 SrcIntPtrTy, MidIntPtrTy,
4346 DstIntPtrTy) == Instruction::BitCast)
4347 return Src;
4348 }
4349 }
David Majnemera90a6212016-07-26 05:52:29 +00004350
4351 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004352 if (CastOpc == Instruction::BitCast)
4353 if (Op->getType() == Ty)
4354 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004355
4356 return nullptr;
4357}
4358
David Majnemer6774d612016-07-26 17:58:05 +00004359Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004360 const SimplifyQuery &Q) {
4361 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4362}
4363
Sanjay Patela3c297d2017-04-19 16:48:22 +00004364/// For the given destination element of a shuffle, peek through shuffles to
4365/// match a root vector source operand that contains that element in the same
4366/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4367static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004368 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004369 unsigned MaxRecurse) {
4370 if (!MaxRecurse--)
4371 return nullptr;
4372
4373 // Bail out if any mask value is undefined. That kind of shuffle may be
4374 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004375 if (MaskVal == -1)
4376 return nullptr;
4377
4378 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004379 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004380 int RootElt = MaskVal;
4381 Value *SourceOp = Op0;
4382 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004383 RootElt = MaskVal - InVecNumElts;
4384 SourceOp = Op1;
4385 }
4386
4387 // If the source operand is a shuffle itself, look through it to find the
4388 // matching root vector.
4389 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4390 return foldIdentityShuffles(
4391 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004392 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004393 }
4394
4395 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4396 // size?
4397
4398 // The source operand is not a shuffle. Initialize the root vector value for
4399 // this shuffle if that has not been done yet.
4400 if (!RootVec)
4401 RootVec = SourceOp;
4402
4403 // Give up as soon as a source operand does not match the existing root value.
4404 if (RootVec != SourceOp)
4405 return nullptr;
4406
4407 // The element must be coming from the same lane in the source vector
4408 // (although it may have crossed lanes in intermediate shuffles).
4409 if (RootElt != DestElt)
4410 return nullptr;
4411
4412 return RootVec;
4413}
4414
Zvi Rackover8f460652017-04-03 22:05:30 +00004415static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004416 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004417 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004418 if (isa<UndefValue>(Mask))
4419 return UndefValue::get(RetTy);
4420
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004421 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004422 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004423 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004424
Zvi Rackover0411e462017-04-30 06:10:54 +00004425 SmallVector<int, 32> Indices;
4426 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4427 assert(MaskNumElts == Indices.size() &&
4428 "Size of Indices not same as number of mask elements?");
4429
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004430 // Canonicalization: If mask does not select elements from an input vector,
4431 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004432 bool MaskSelects0 = false, MaskSelects1 = false;
4433 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004434 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004435 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004436 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004437 MaskSelects0 = true;
4438 else
4439 MaskSelects1 = true;
4440 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004441 if (!MaskSelects0)
4442 Op0 = UndefValue::get(InVecTy);
4443 if (!MaskSelects1)
4444 Op1 = UndefValue::get(InVecTy);
4445
4446 auto *Op0Const = dyn_cast<Constant>(Op0);
4447 auto *Op1Const = dyn_cast<Constant>(Op1);
4448
4449 // If all operands are constant, constant fold the shuffle.
4450 if (Op0Const && Op1Const)
4451 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4452
4453 // Canonicalization: if only one input vector is constant, it shall be the
4454 // second one.
4455 if (Op0Const && !Op1Const) {
4456 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004457 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004458 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004459
4460 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4461 // value type is same as the input vectors' type.
4462 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004463 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004464 OpShuf->getMask()->getSplatValue())
4465 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004466
Sanjay Patela3c297d2017-04-19 16:48:22 +00004467 // Don't fold a shuffle with undef mask elements. This may get folded in a
4468 // better way using demanded bits or other analysis.
4469 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004470 if (find(Indices, -1) != Indices.end())
4471 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004472
4473 // Check if every element of this shuffle can be mapped back to the
4474 // corresponding element of a single root vector. If so, we don't need this
4475 // shuffle. This handles simple identity shuffles as well as chains of
4476 // shuffles that may widen/narrow and/or move elements across lanes and back.
4477 Value *RootVec = nullptr;
4478 for (unsigned i = 0; i != MaskNumElts; ++i) {
4479 // Note that recursion is limited for each vector element, so if any element
4480 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004481 RootVec =
4482 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004483
4484 // We can't replace a widening/narrowing shuffle with one of its operands.
4485 if (!RootVec || RootVec->getType() != RetTy)
4486 return nullptr;
4487 }
4488 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004489}
4490
4491/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004492Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4493 Type *RetTy, const SimplifyQuery &Q) {
4494 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004495}
4496
Sanjay Patele2359422018-03-21 19:31:53 +00004497static Constant *propagateNaN(Constant *In) {
4498 // If the input is a vector with undef elements, just return a default NaN.
4499 if (!In->isNaN())
4500 return ConstantFP::getNaN(In->getType());
4501
4502 // Propagate the existing NaN constant when possible.
4503 // TODO: Should we quiet a signaling NaN?
4504 return In;
4505}
4506
4507static Constant *simplifyFPBinop(Value *Op0, Value *Op1) {
4508 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4509 return ConstantFP::getNaN(Op0->getType());
4510
4511 if (match(Op0, m_NaN()))
4512 return propagateNaN(cast<Constant>(Op0));
4513 if (match(Op1, m_NaN()))
4514 return propagateNaN(cast<Constant>(Op1));
4515
4516 return nullptr;
4517}
4518
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004519/// Given operands for an FAdd, see if we can fold the result. If not, this
4520/// returns null.
4521static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4522 const SimplifyQuery &Q, unsigned MaxRecurse) {
4523 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4524 return C;
4525
Sanjay Patele2359422018-03-21 19:31:53 +00004526 if (Constant *C = simplifyFPBinop(Op0, Op1))
4527 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004528
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004529 // fadd X, -0 ==> X
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004530 if (match(Op1, m_NegZeroFP()))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004531 return Op0;
4532
4533 // fadd X, 0 ==> X, when we know X is not -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004534 if (match(Op1, m_PosZeroFP()) &&
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004535 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4536 return Op0;
4537
Sanjay Patel11f7f992018-03-14 21:23:27 +00004538 // With nnan: (+/-0.0 - X) + X --> 0.0 (and commuted variant)
4539 // We don't have to explicitly exclude infinities (ninf): INF + -INF == NaN.
4540 // Negative zeros are allowed because we always end up with positive zero:
4541 // X = -0.0: (-0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4542 // X = -0.0: ( 0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4543 // X = 0.0: (-0.0 - ( 0.0)) + ( 0.0) == (-0.0) + ( 0.0) == 0.0
4544 // X = 0.0: ( 0.0 - ( 0.0)) + ( 0.0) == ( 0.0) + ( 0.0) == 0.0
Sanjay Patela4f42f22018-03-15 14:29:27 +00004545 if (FMF.noNaNs() && (match(Op0, m_FSub(m_AnyZeroFP(), m_Specific(Op1))) ||
4546 match(Op1, m_FSub(m_AnyZeroFP(), m_Specific(Op0)))))
Sanjay Patel11f7f992018-03-14 21:23:27 +00004547 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004548
Sanjay Patel9b073472018-08-07 20:32:55 +00004549 // (X - Y) + Y --> X
4550 // Y + (X - Y) --> X
4551 Value *X;
4552 if (FMF.noSignedZeros() && FMF.allowReassoc() &&
4553 (match(Op0, m_FSub(m_Value(X), m_Specific(Op1))) ||
4554 match(Op1, m_FSub(m_Value(X), m_Specific(Op0)))))
4555 return X;
4556
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004557 return nullptr;
4558}
4559
4560/// Given operands for an FSub, see if we can fold the result. If not, this
4561/// returns null.
4562static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4563 const SimplifyQuery &Q, unsigned MaxRecurse) {
4564 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
4565 return C;
4566
Sanjay Patele2359422018-03-21 19:31:53 +00004567 if (Constant *C = simplifyFPBinop(Op0, Op1))
4568 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004569
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004570 // fsub X, +0 ==> X
4571 if (match(Op1, m_PosZeroFP()))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004572 return Op0;
4573
4574 // fsub X, -0 ==> X, when we know X is not -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004575 if (match(Op1, m_NegZeroFP()) &&
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004576 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4577 return Op0;
4578
4579 // fsub -0.0, (fsub -0.0, X) ==> X
4580 Value *X;
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004581 if (match(Op0, m_NegZeroFP()) &&
4582 match(Op1, m_FSub(m_NegZeroFP(), m_Value(X))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004583 return X;
4584
4585 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Sanjay Patela4f42f22018-03-15 14:29:27 +00004586 if (FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()) &&
4587 match(Op1, m_FSub(m_AnyZeroFP(), m_Value(X))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004588 return X;
4589
4590 // fsub nnan x, x ==> 0.0
4591 if (FMF.noNaNs() && Op0 == Op1)
4592 return Constant::getNullValue(Op0->getType());
4593
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004594 // Y - (Y - X) --> X
Sanjay Patel4364d602018-08-07 20:23:49 +00004595 // (X + Y) - Y --> X
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004596 if (FMF.noSignedZeros() && FMF.allowReassoc() &&
Sanjay Patel4364d602018-08-07 20:23:49 +00004597 (match(Op1, m_FSub(m_Specific(Op0), m_Value(X))) ||
4598 match(Op0, m_c_FAdd(m_Specific(Op1), m_Value(X)))))
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004599 return X;
4600
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004601 return nullptr;
4602}
4603
4604/// Given the operands for an FMul, see if we can fold the result
4605static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4606 const SimplifyQuery &Q, unsigned MaxRecurse) {
4607 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
4608 return C;
4609
Sanjay Patele2359422018-03-21 19:31:53 +00004610 if (Constant *C = simplifyFPBinop(Op0, Op1))
4611 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004612
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004613 // fmul X, 1.0 ==> X
4614 if (match(Op1, m_FPOne()))
4615 return Op0;
4616
4617 // fmul nnan nsz X, 0 ==> 0
Sanjay Patela4f42f22018-03-15 14:29:27 +00004618 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZeroFP()))
4619 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004620
Sanjay Patel95ec4a42018-03-18 14:12:25 +00004621 // sqrt(X) * sqrt(X) --> X, if we can:
4622 // 1. Remove the intermediate rounding (reassociate).
4623 // 2. Ignore non-zero negative numbers because sqrt would produce NAN.
4624 // 3. Ignore -0.0 because sqrt(-0.0) == -0.0, but -0.0 * -0.0 == 0.0.
Sanjay Pateldb53d182018-02-23 22:20:13 +00004625 Value *X;
Sanjay Patel95ec4a42018-03-18 14:12:25 +00004626 if (Op0 == Op1 && match(Op0, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) &&
4627 FMF.allowReassoc() && FMF.noNaNs() && FMF.noSignedZeros())
Sanjay Pateldb53d182018-02-23 22:20:13 +00004628 return X;
4629
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004630 return nullptr;
4631}
4632
4633Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4634 const SimplifyQuery &Q) {
4635 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
4636}
4637
4638
4639Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4640 const SimplifyQuery &Q) {
4641 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
4642}
4643
4644Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4645 const SimplifyQuery &Q) {
4646 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
4647}
4648
4649static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4650 const SimplifyQuery &Q, unsigned) {
4651 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
4652 return C;
4653
Sanjay Patele2359422018-03-21 19:31:53 +00004654 if (Constant *C = simplifyFPBinop(Op0, Op1))
4655 return C;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004656
4657 // X / 1.0 -> X
4658 if (match(Op1, m_FPOne()))
4659 return Op0;
4660
4661 // 0 / X -> 0
4662 // Requires that NaNs are off (X could be zero) and signed zeroes are
4663 // ignored (X could be positive or negative, so the output sign is unknown).
Sanjay Patela4f42f22018-03-15 14:29:27 +00004664 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()))
4665 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004666
4667 if (FMF.noNaNs()) {
4668 // X / X -> 1.0 is legal when NaNs are ignored.
Sanjay Patel83f05662018-01-30 00:18:37 +00004669 // We can ignore infinities because INF/INF is NaN.
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004670 if (Op0 == Op1)
4671 return ConstantFP::get(Op0->getType(), 1.0);
4672
Sanjay Patel83f05662018-01-30 00:18:37 +00004673 // (X * Y) / Y --> X if we can reassociate to the above form.
4674 Value *X;
4675 if (FMF.allowReassoc() && match(Op0, m_c_FMul(m_Value(X), m_Specific(Op1))))
4676 return X;
4677
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004678 // -X / X -> -1.0 and
4679 // X / -X -> -1.0 are legal when NaNs are ignored.
4680 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
Cameron McInallybea59672018-10-09 21:48:00 +00004681 if (match(Op0, m_FNegNSZ(m_Specific(Op1))) ||
4682 match(Op1, m_FNegNSZ(m_Specific(Op0))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004683 return ConstantFP::get(Op0->getType(), -1.0);
4684 }
4685
4686 return nullptr;
4687}
4688
4689Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4690 const SimplifyQuery &Q) {
4691 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
4692}
4693
4694static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4695 const SimplifyQuery &Q, unsigned) {
4696 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
4697 return C;
4698
Sanjay Patele2359422018-03-21 19:31:53 +00004699 if (Constant *C = simplifyFPBinop(Op0, Op1))
4700 return C;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004701
Sanjay Patel8f063d02018-03-15 14:04:31 +00004702 // Unlike fdiv, the result of frem always matches the sign of the dividend.
4703 // The constant match may include undef elements in a vector, so return a full
4704 // zero constant as the result.
4705 if (FMF.noNaNs()) {
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004706 // +0 % X -> 0
4707 if (match(Op0, m_PosZeroFP()))
Sanjay Patel8f063d02018-03-15 14:04:31 +00004708 return ConstantFP::getNullValue(Op0->getType());
4709 // -0 % X -> -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004710 if (match(Op0, m_NegZeroFP()))
Sanjay Patel8f063d02018-03-15 14:04:31 +00004711 return ConstantFP::getNegativeZero(Op0->getType());
4712 }
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004713
4714 return nullptr;
4715}
4716
4717Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4718 const SimplifyQuery &Q) {
4719 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
4720}
4721
Chris Lattnera71e9d62009-11-10 00:55:12 +00004722//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004723
Sanjay Patel472cc782016-01-11 22:14:42 +00004724/// Given operands for a BinaryOperator, see if we can fold the result.
4725/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004726static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004727 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004728 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004729 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004730 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004731 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004732 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004733 case Instruction::Mul:
4734 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004735 case Instruction::SDiv:
4736 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4737 case Instruction::UDiv:
4738 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004739 case Instruction::SRem:
4740 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4741 case Instruction::URem:
4742 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004743 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004744 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004745 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004746 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004747 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004748 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4749 case Instruction::And:
4750 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4751 case Instruction::Or:
4752 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4753 case Instruction::Xor:
4754 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004755 case Instruction::FAdd:
4756 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4757 case Instruction::FSub:
4758 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4759 case Instruction::FMul:
4760 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4761 case Instruction::FDiv:
4762 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4763 case Instruction::FRem:
4764 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004765 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004766 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004767 }
4768}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004769
Sanjay Patel472cc782016-01-11 22:14:42 +00004770/// Given operands for a BinaryOperator, see if we can fold the result.
4771/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004772/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4773/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4774static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004775 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004776 unsigned MaxRecurse) {
4777 switch (Opcode) {
4778 case Instruction::FAdd:
4779 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4780 case Instruction::FSub:
4781 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4782 case Instruction::FMul:
4783 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004784 case Instruction::FDiv:
4785 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004786 default:
4787 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4788 }
4789}
4790
Duncan Sands7e800d62010-11-14 11:23:23 +00004791Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004792 const SimplifyQuery &Q) {
4793 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4794}
4795
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004796Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004797 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004798 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4799}
4800
Sanjay Patel472cc782016-01-11 22:14:42 +00004801/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004802static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004803 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004804 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004805 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004806 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004807}
4808
4809Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004810 const SimplifyQuery &Q) {
4811 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4812}
4813
Michael Ilseman54857292013-02-07 19:26:05 +00004814static bool IsIdempotent(Intrinsic::ID ID) {
4815 switch (ID) {
4816 default: return false;
4817
4818 // Unary idempotent: f(f(x)) = f(x)
4819 case Intrinsic::fabs:
4820 case Intrinsic::floor:
4821 case Intrinsic::ceil:
4822 case Intrinsic::trunc:
4823 case Intrinsic::rint:
4824 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004825 case Intrinsic::round:
Matt Arsenault3ced3d92017-09-07 01:21:43 +00004826 case Intrinsic::canonicalize:
Michael Ilseman54857292013-02-07 19:26:05 +00004827 return true;
4828 }
4829}
4830
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004831static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4832 const DataLayout &DL) {
4833 GlobalValue *PtrSym;
4834 APInt PtrOffset;
4835 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4836 return nullptr;
4837
4838 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4839 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4840 Type *Int32PtrTy = Int32Ty->getPointerTo();
4841 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4842
4843 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4844 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4845 return nullptr;
4846
4847 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4848 if (OffsetInt % 4 != 0)
4849 return nullptr;
4850
4851 Constant *C = ConstantExpr::getGetElementPtr(
4852 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4853 ConstantInt::get(Int64Ty, OffsetInt / 4));
4854 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4855 if (!Loaded)
4856 return nullptr;
4857
4858 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4859 if (!LoadedCE)
4860 return nullptr;
4861
4862 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4863 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4864 if (!LoadedCE)
4865 return nullptr;
4866 }
4867
4868 if (LoadedCE->getOpcode() != Instruction::Sub)
4869 return nullptr;
4870
4871 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4872 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4873 return nullptr;
4874 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4875
4876 Constant *LoadedRHS = LoadedCE->getOperand(1);
4877 GlobalValue *LoadedRHSSym;
4878 APInt LoadedRHSOffset;
4879 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4880 DL) ||
4881 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4882 return nullptr;
4883
4884 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4885}
4886
David Majnemer17a95aa2016-07-14 06:58:37 +00004887static bool maskIsAllZeroOrUndef(Value *Mask) {
4888 auto *ConstMask = dyn_cast<Constant>(Mask);
4889 if (!ConstMask)
4890 return false;
4891 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4892 return true;
4893 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4894 ++I) {
4895 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4896 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4897 continue;
4898 return false;
4899 }
4900 return true;
4901}
4902
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004903static Value *simplifyUnaryIntrinsic(Function *F, Value *Op0,
4904 const SimplifyQuery &Q) {
4905 // Idempotent functions return the same result when called repeatedly.
David Majnemer15032582015-05-22 03:56:46 +00004906 Intrinsic::ID IID = F->getIntrinsicID();
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004907 if (IsIdempotent(IID))
4908 if (auto *II = dyn_cast<IntrinsicInst>(Op0))
4909 if (II->getIntrinsicID() == IID)
4910 return II;
Michael Ilseman54857292013-02-07 19:26:05 +00004911
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004912 Value *X;
4913 switch (IID) {
4914 case Intrinsic::fabs:
4915 if (SignBitMustBeZero(Op0, Q.TLI)) return Op0;
4916 break;
4917 case Intrinsic::bswap:
4918 // bswap(bswap(x)) -> x
4919 if (match(Op0, m_BSwap(m_Value(X)))) return X;
4920 break;
4921 case Intrinsic::bitreverse:
4922 // bitreverse(bitreverse(x)) -> x
4923 if (match(Op0, m_BitReverse(m_Value(X)))) return X;
4924 break;
4925 case Intrinsic::exp:
4926 // exp(log(x)) -> x
4927 if (Q.CxtI->hasAllowReassoc() &&
4928 match(Op0, m_Intrinsic<Intrinsic::log>(m_Value(X)))) return X;
4929 break;
4930 case Intrinsic::exp2:
4931 // exp2(log2(x)) -> x
4932 if (Q.CxtI->hasAllowReassoc() &&
4933 match(Op0, m_Intrinsic<Intrinsic::log2>(m_Value(X)))) return X;
4934 break;
4935 case Intrinsic::log:
4936 // log(exp(x)) -> x
4937 if (Q.CxtI->hasAllowReassoc() &&
4938 match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X)))) return X;
4939 break;
4940 case Intrinsic::log2:
4941 // log2(exp2(x)) -> x
4942 if (Q.CxtI->hasAllowReassoc() &&
4943 match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X)))) return X;
4944 break;
4945 default:
4946 break;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004947 }
Michael Ilseman54857292013-02-07 19:26:05 +00004948
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004949 return nullptr;
4950}
Matt Arsenault82606662017-01-11 00:57:54 +00004951
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004952static Value *simplifyBinaryIntrinsic(Function *F, Value *Op0, Value *Op1,
4953 const SimplifyQuery &Q) {
4954 Intrinsic::ID IID = F->getIntrinsicID();
4955 Type *ReturnType = F->getReturnType();
4956 switch (IID) {
4957 case Intrinsic::usub_with_overflow:
4958 case Intrinsic::ssub_with_overflow:
4959 // X - X -> { 0, false }
4960 if (Op0 == Op1)
4961 return Constant::getNullValue(ReturnType);
4962 // X - undef -> undef
4963 // undef - X -> undef
4964 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4965 return UndefValue::get(ReturnType);
4966 break;
4967 case Intrinsic::uadd_with_overflow:
4968 case Intrinsic::sadd_with_overflow:
4969 // X + undef -> undef
4970 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4971 return UndefValue::get(ReturnType);
4972 break;
4973 case Intrinsic::umul_with_overflow:
4974 case Intrinsic::smul_with_overflow:
4975 // 0 * X -> { 0, false }
4976 // X * 0 -> { 0, false }
4977 if (match(Op0, m_Zero()) || match(Op1, m_Zero()))
4978 return Constant::getNullValue(ReturnType);
4979 // undef * X -> { 0, false }
4980 // X * undef -> { 0, false }
4981 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
4982 return Constant::getNullValue(ReturnType);
4983 break;
Sanjay Pateleea21da2018-11-20 17:20:26 +00004984 case Intrinsic::uadd_sat:
4985 // sat(MAX + X) -> MAX
4986 // sat(X + MAX) -> MAX
4987 if (match(Op0, m_AllOnes()) || match(Op1, m_AllOnes()))
4988 return Constant::getAllOnesValue(ReturnType);
4989 LLVM_FALLTHROUGH;
4990 case Intrinsic::sadd_sat:
4991 // sat(X + undef) -> -1
4992 // sat(undef + X) -> -1
4993 // For unsigned: Assume undef is MAX, thus we saturate to MAX (-1).
4994 // For signed: Assume undef is ~X, in which case X + ~X = -1.
4995 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
4996 return Constant::getAllOnesValue(ReturnType);
4997
4998 // X + 0 -> X
4999 if (match(Op1, m_Zero()))
5000 return Op0;
5001 // 0 + X -> X
5002 if (match(Op0, m_Zero()))
5003 return Op1;
5004 break;
5005 case Intrinsic::usub_sat:
5006 // sat(0 - X) -> 0, sat(X - MAX) -> 0
5007 if (match(Op0, m_Zero()) || match(Op1, m_AllOnes()))
5008 return Constant::getNullValue(ReturnType);
5009 LLVM_FALLTHROUGH;
5010 case Intrinsic::ssub_sat:
5011 // X - X -> 0, X - undef -> 0, undef - X -> 0
5012 if (Op0 == Op1 || match(Op0, m_Undef()) || match(Op1, m_Undef()))
5013 return Constant::getNullValue(ReturnType);
5014 // X - 0 -> X
5015 if (match(Op1, m_Zero()))
5016 return Op0;
5017 break;
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005018 case Intrinsic::load_relative:
5019 if (auto *C0 = dyn_cast<Constant>(Op0))
5020 if (auto *C1 = dyn_cast<Constant>(Op1))
Matt Arsenault82606662017-01-11 00:57:54 +00005021 return SimplifyRelativeLoad(C0, C1, Q.DL);
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005022 break;
5023 case Intrinsic::powi:
5024 if (auto *Power = dyn_cast<ConstantInt>(Op1)) {
5025 // powi(x, 0) -> 1.0
5026 if (Power->isZero())
5027 return ConstantFP::get(Op0->getType(), 1.0);
5028 // powi(x, 1) -> x
5029 if (Power->isOne())
5030 return Op0;
Matt Arsenault82606662017-01-11 00:57:54 +00005031 }
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005032 break;
5033 case Intrinsic::maxnum:
Thomas Livelyc3392502018-10-19 19:01:26 +00005034 case Intrinsic::minnum:
5035 case Intrinsic::maximum:
5036 case Intrinsic::minimum: {
Sanjay Patel28c7e412018-08-01 23:05:55 +00005037 // If the arguments are the same, this is a no-op.
5038 if (Op0 == Op1) return Op0;
5039
Thomas Livelyc3392502018-10-19 19:01:26 +00005040 // If one argument is undef, return the other argument.
5041 if (match(Op0, m_Undef()))
5042 return Op1;
5043 if (match(Op1, m_Undef()))
5044 return Op0;
5045
5046 // If one argument is NaN, return other or NaN appropriately.
5047 bool PropagateNaN = IID == Intrinsic::minimum || IID == Intrinsic::maximum;
5048 if (match(Op0, m_NaN()))
5049 return PropagateNaN ? Op0 : Op1;
5050 if (match(Op1, m_NaN()))
5051 return PropagateNaN ? Op1 : Op0;
Sanjay Patel3f6e9a72018-08-02 14:33:40 +00005052
Sanjay Patel948ff872018-08-07 14:36:27 +00005053 // Min/max of the same operation with common operand:
5054 // m(m(X, Y)), X --> m(X, Y) (4 commuted variants)
5055 if (auto *M0 = dyn_cast<IntrinsicInst>(Op0))
5056 if (M0->getIntrinsicID() == IID &&
5057 (M0->getOperand(0) == Op1 || M0->getOperand(1) == Op1))
5058 return Op0;
5059 if (auto *M1 = dyn_cast<IntrinsicInst>(Op1))
5060 if (M1->getIntrinsicID() == IID &&
5061 (M1->getOperand(0) == Op0 || M1->getOperand(1) == Op0))
5062 return Op1;
5063
Thomas Livelyc3392502018-10-19 19:01:26 +00005064 // min(X, -Inf) --> -Inf (and commuted variant)
5065 // max(X, +Inf) --> +Inf (and commuted variant)
5066 bool UseNegInf = IID == Intrinsic::minnum || IID == Intrinsic::minimum;
Sanjay Patelc6944f72018-08-09 22:20:44 +00005067 const APFloat *C;
5068 if ((match(Op0, m_APFloat(C)) && C->isInfinity() &&
5069 C->isNegative() == UseNegInf) ||
5070 (match(Op1, m_APFloat(C)) && C->isInfinity() &&
5071 C->isNegative() == UseNegInf))
5072 return ConstantFP::getInfinity(ReturnType, UseNegInf);
5073
5074 // TODO: minnum(nnan x, inf) -> x
5075 // TODO: minnum(nnan ninf x, flt_max) -> x
5076 // TODO: maxnum(nnan x, -inf) -> x
5077 // TODO: maxnum(nnan ninf x, -flt_max) -> x
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005078 break;
Sanjay Patelc6944f72018-08-09 22:20:44 +00005079 }
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005080 default:
5081 break;
Matt Arsenault82606662017-01-11 00:57:54 +00005082 }
5083
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005084 return nullptr;
5085}
5086
5087template <typename IterTy>
5088static Value *simplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
5089 const SimplifyQuery &Q) {
5090 // Intrinsics with no operands have some kind of side effect. Don't simplify.
5091 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
5092 if (NumOperands == 0)
5093 return nullptr;
5094
5095 Intrinsic::ID IID = F->getIntrinsicID();
5096 if (NumOperands == 1)
5097 return simplifyUnaryIntrinsic(F, ArgBegin[0], Q);
5098
5099 if (NumOperands == 2)
5100 return simplifyBinaryIntrinsic(F, ArgBegin[0], ArgBegin[1], Q);
5101
5102 // Handle intrinsics with 3 or more arguments.
Matt Arsenault82606662017-01-11 00:57:54 +00005103 switch (IID) {
5104 case Intrinsic::masked_load: {
5105 Value *MaskArg = ArgBegin[2];
5106 Value *PassthruArg = ArgBegin[3];
5107 // If the mask is all zeros or undef, the "passthru" argument is the result.
5108 if (maskIsAllZeroOrUndef(MaskArg))
5109 return PassthruArg;
5110 return nullptr;
5111 }
Sanjay Patel54421ce2018-07-29 16:36:38 +00005112 case Intrinsic::fshl:
5113 case Intrinsic::fshr: {
Sanjay Patel14ab9172018-11-20 17:34:59 +00005114 Value *Op0 = ArgBegin[0], *Op1 = ArgBegin[1], *ShAmtArg = ArgBegin[2];
5115
5116 // If both operands are undef, the result is undef.
5117 if (match(Op0, m_Undef()) && match(Op1, m_Undef()))
5118 return UndefValue::get(F->getReturnType());
5119
5120 // If shift amount is undef, assume it is zero.
5121 if (match(ShAmtArg, m_Undef()))
5122 return ArgBegin[IID == Intrinsic::fshl ? 0 : 1];
5123
Sanjay Patel54421ce2018-07-29 16:36:38 +00005124 const APInt *ShAmtC;
5125 if (match(ShAmtArg, m_APInt(ShAmtC))) {
5126 // If there's effectively no shift, return the 1st arg or 2nd arg.
5127 // TODO: For vectors, we could check each element of a non-splat constant.
5128 APInt BitWidth = APInt(ShAmtC->getBitWidth(), ShAmtC->getBitWidth());
5129 if (ShAmtC->urem(BitWidth).isNullValue())
5130 return ArgBegin[IID == Intrinsic::fshl ? 0 : 1];
5131 }
5132 return nullptr;
5133 }
Matt Arsenault82606662017-01-11 00:57:54 +00005134 default:
5135 return nullptr;
5136 }
Michael Ilseman54857292013-02-07 19:26:05 +00005137}
5138
Chandler Carruth9dc35582012-12-28 11:30:55 +00005139template <typename IterTy>
Andrew Kaylor647025f2017-06-09 23:18:11 +00005140static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
5141 IterTy ArgEnd, const SimplifyQuery &Q,
5142 unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00005143 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00005144 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
5145 Ty = PTy->getElementType();
5146 FunctionType *FTy = cast<FunctionType>(Ty);
5147
Dan Gohman85977e62011-11-04 18:32:42 +00005148 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00005149 // call null -> undef
5150 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00005151 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00005152
Chandler Carruthf6182152012-12-28 14:23:29 +00005153 Function *F = dyn_cast<Function>(V);
5154 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00005155 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00005156
David Majnemer15032582015-05-22 03:56:46 +00005157 if (F->isIntrinsic())
Sanjay Patelf52eeb12018-07-29 14:42:08 +00005158 if (Value *Ret = simplifyIntrinsic(F, ArgBegin, ArgEnd, Q))
Michael Ilseman54857292013-02-07 19:26:05 +00005159 return Ret;
5160
Andrew Kaylor647025f2017-06-09 23:18:11 +00005161 if (!canConstantFoldCallTo(CS, F))
Craig Topper9f008862014-04-15 04:59:12 +00005162 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00005163
5164 SmallVector<Constant *, 4> ConstantArgs;
5165 ConstantArgs.reserve(ArgEnd - ArgBegin);
5166 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
5167 Constant *C = dyn_cast<Constant>(*I);
5168 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00005169 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00005170 ConstantArgs.push_back(C);
5171 }
5172
Andrew Kaylor647025f2017-06-09 23:18:11 +00005173 return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00005174}
5175
Andrew Kaylor647025f2017-06-09 23:18:11 +00005176Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
5177 User::op_iterator ArgBegin, User::op_iterator ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005178 const SimplifyQuery &Q) {
Andrew Kaylor647025f2017-06-09 23:18:11 +00005179 return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
5180}
5181
5182Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
5183 ArrayRef<Value *> Args, const SimplifyQuery &Q) {
5184 return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00005185}
5186
Philip Reames7a6db4f2017-12-27 00:16:12 +00005187Value *llvm::SimplifyCall(ImmutableCallSite ICS, const SimplifyQuery &Q) {
5188 CallSite CS(const_cast<Instruction*>(ICS.getInstruction()));
5189 return ::SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
5190 Q, RecursionLimit);
5191}
5192
Sanjay Patel472cc782016-01-11 22:14:42 +00005193/// See if we can compute a simplified version of this instruction.
5194/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005195
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005196Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005197 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005198 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005199 Value *Result;
5200
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005201 switch (I->getOpcode()) {
5202 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005203 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005204 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00005205 case Instruction::FAdd:
5206 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005207 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00005208 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00005209 case Instruction::Add:
Florian Hahn19f9e322018-08-17 14:39:04 +00005210 Result =
5211 SimplifyAddInst(I->getOperand(0), I->getOperand(1),
5212 Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
5213 Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005214 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00005215 case Instruction::FSub:
5216 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005217 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00005218 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00005219 case Instruction::Sub:
Florian Hahn19f9e322018-08-17 14:39:04 +00005220 Result =
5221 SimplifySubInst(I->getOperand(0), I->getOperand(1),
5222 Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
5223 Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00005224 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00005225 case Instruction::FMul:
5226 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005227 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00005228 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00005229 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005230 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00005231 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00005232 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005233 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00005234 break;
5235 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005236 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00005237 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00005238 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00005239 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005240 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00005241 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00005242 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005243 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00005244 break;
5245 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005246 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00005247 break;
5248 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00005249 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005250 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00005251 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00005252 case Instruction::Shl:
Florian Hahn19f9e322018-08-17 14:39:04 +00005253 Result =
5254 SimplifyShlInst(I->getOperand(0), I->getOperand(1),
5255 Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
5256 Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00005257 break;
5258 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00005259 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Florian Hahn19f9e322018-08-17 14:39:04 +00005260 Q.IIQ.isExact(cast<BinaryOperator>(I)), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00005261 break;
5262 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00005263 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Florian Hahn19f9e322018-08-17 14:39:04 +00005264 Q.IIQ.isExact(cast<BinaryOperator>(I)), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00005265 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005266 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005267 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005268 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005269 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005270 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005271 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00005272 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005273 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00005274 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005275 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005276 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
5277 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005278 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005279 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005280 Result =
5281 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
5282 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005283 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00005284 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00005285 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005286 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005287 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00005288 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005289 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00005290 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005291 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005292 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00005293 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00005294 case Instruction::InsertValue: {
5295 InsertValueInst *IV = cast<InsertValueInst>(I);
5296 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
5297 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005298 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00005299 break;
5300 }
Igor Laevskye0edb662017-12-13 11:21:18 +00005301 case Instruction::InsertElement: {
5302 auto *IE = cast<InsertElementInst>(I);
5303 Result = SimplifyInsertElementInst(IE->getOperand(0), IE->getOperand(1),
5304 IE->getOperand(2), Q);
5305 break;
5306 }
David Majnemer25a796e2015-07-13 01:15:46 +00005307 case Instruction::ExtractValue: {
5308 auto *EVI = cast<ExtractValueInst>(I);
5309 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005310 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00005311 break;
5312 }
David Majnemer599ca442015-07-13 01:15:53 +00005313 case Instruction::ExtractElement: {
5314 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005315 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
5316 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00005317 break;
5318 }
Zvi Rackover8f460652017-04-03 22:05:30 +00005319 case Instruction::ShuffleVector: {
5320 auto *SVI = cast<ShuffleVectorInst>(I);
5321 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005322 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00005323 break;
5324 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00005325 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005326 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005327 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00005328 case Instruction::Call: {
5329 CallSite CS(cast<CallInst>(I));
Philip Reames7a6db4f2017-12-27 00:16:12 +00005330 Result = SimplifyCall(CS, Q);
Dan Gohman85977e62011-11-04 18:32:42 +00005331 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00005332 }
David Majnemer6774d612016-07-26 17:58:05 +00005333#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
5334#include "llvm/IR/Instruction.def"
5335#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005336 Result =
5337 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00005338 break;
Craig Topper81c03a72017-04-12 22:54:24 +00005339 case Instruction::Alloca:
5340 // No simplifications for Alloca and it can't be constant folded.
5341 Result = nullptr;
5342 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005343 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00005344
Hal Finkelf2199b22015-10-23 20:37:08 +00005345 // In general, it is possible for computeKnownBits to determine all bits in a
5346 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00005347 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Craig Topper8205a1a2017-05-24 16:53:07 +00005348 KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00005349 if (Known.isConstant())
5350 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00005351 }
5352
Duncan Sands64e41cf2010-11-17 08:35:29 +00005353 /// If called on unreachable code, the above logic may report that the
5354 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00005355 /// detecting that case here, returning a safe value instead.
5356 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005357}
5358
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00005359/// Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005360/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00005361///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005362/// This is the common implementation of the recursive simplification routines.
5363/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
5364/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
5365/// instructions to process and attempt to simplify it using
5366/// InstructionSimplify.
5367///
5368/// This routine returns 'true' only when *it* simplifies something. The passed
5369/// in simplified value does not count toward this.
5370static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005371 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005372 const DominatorTree *DT,
5373 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005374 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005375 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005376 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00005377
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005378 // If we have an explicit value to collapse to, do that round of the
5379 // simplification loop by hand initially.
5380 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00005381 for (User *U : I->users())
5382 if (U != I)
5383 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00005384
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005385 // Replace the instruction with its simplified value.
5386 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00005387
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005388 // Gracefully handle edge cases where the instruction is not wired into any
5389 // parent block.
Chandler Carruth9ae926b2018-08-26 09:51:22 +00005390 if (I->getParent() && !I->isEHPad() && !I->isTerminator() &&
David Majnemer909793f2016-08-04 04:24:02 +00005391 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005392 I->eraseFromParent();
5393 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005394 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00005395 }
Duncan Sands7e800d62010-11-14 11:23:23 +00005396
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005397 // Note that we must test the size on each iteration, the worklist can grow.
5398 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
5399 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00005400
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005401 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005402 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005403 if (!SimpleV)
5404 continue;
5405
5406 Simplified = true;
5407
5408 // Stash away all the uses of the old instruction so we can check them for
5409 // recursive simplifications after a RAUW. This is cheaper than checking all
5410 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005411 for (User *U : I->users())
5412 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005413
5414 // Replace the instruction with its simplified value.
5415 I->replaceAllUsesWith(SimpleV);
5416
5417 // Gracefully handle edge cases where the instruction is not wired into any
5418 // parent block.
Chandler Carruth9ae926b2018-08-26 09:51:22 +00005419 if (I->getParent() && !I->isEHPad() && !I->isTerminator() &&
David Majnemer909793f2016-08-04 04:24:02 +00005420 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005421 I->eraseFromParent();
5422 }
5423 return Simplified;
5424}
5425
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005426bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005427 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005428 const DominatorTree *DT,
5429 AssumptionCache *AC) {
5430 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005431}
5432
5433bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005434 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005435 const DominatorTree *DT,
5436 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005437 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
5438 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005439 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00005440}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005441
5442namespace llvm {
5443const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
5444 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
5445 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
5446 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
5447 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
5448 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
5449 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
5450 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5451}
5452
5453const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
5454 const DataLayout &DL) {
5455 return {DL, &AR.TLI, &AR.DT, &AR.AC};
5456}
5457
5458template <class T, class... TArgs>
5459const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
5460 Function &F) {
5461 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
5462 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
5463 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
5464 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5465}
5466template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
5467 Function &);
5468}