blob: d0794364a7351cafa7c199a762f63ca4ccd4325c [file] [log] [blame]
Chris Lattner084a1b52009-11-09 22:57:59 +00001//===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements routines for folding instructions into simpler forms
Duncan Sandsa0219882010-11-23 10:50:08 +000011// that do not require creating new instructions. This does constant folding
12// ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
13// returning a constant ("and i32 %x, 0" -> "0") or an already existing value
Duncan Sandsed6d6c32010-12-20 14:47:04 +000014// ("and i32 %x, %x" -> "%x"). All operands are assumed to have already been
15// simplified: This is usually true and assuming it simplifies the logic (if
16// they have not been simplified then results are correct but maybe suboptimal).
Chris Lattner084a1b52009-11-09 22:57:59 +000017//
18//===----------------------------------------------------------------------===//
19
20#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SetVector.h"
22#include "llvm/ADT/Statistic.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000023#include "llvm/Analysis/AliasAnalysis.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000024#include "llvm/Analysis/AssumptionCache.h"
Anna Thomas43d7e1c2016-05-03 14:58:21 +000025#include "llvm/Analysis/CaptureTracking.h"
Craig Topper0aa3a192017-08-14 21:39:51 +000026#include "llvm/Analysis/CmpInstAnalysis.h"
Chris Lattner084a1b52009-11-09 22:57:59 +000027#include "llvm/Analysis/ConstantFolding.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000028#include "llvm/Analysis/LoopAnalysisManager.h"
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +000029#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000030#include "llvm/Analysis/ValueTracking.h"
David Majnemer599ca442015-07-13 01:15:53 +000031#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000032#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000034#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000035#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000036#include "llvm/IR/GlobalAlias.h"
37#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000038#include "llvm/IR/PatternMatch.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000039#include "llvm/IR/ValueHandle.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000040#include "llvm/Support/KnownBits.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000041#include <algorithm>
Chris Lattner084a1b52009-11-09 22:57:59 +000042using namespace llvm;
Chris Lattnera71e9d62009-11-10 00:55:12 +000043using namespace llvm::PatternMatch;
Chris Lattner084a1b52009-11-09 22:57:59 +000044
Chandler Carruthf1221bd2014-04-22 02:48:03 +000045#define DEBUG_TYPE "instsimplify"
46
Chris Lattner9e4aa022011-02-09 17:15:04 +000047enum { RecursionLimit = 3 };
Duncan Sandsf3b1bf12010-11-10 18:23:01 +000048
Duncan Sands3547d2e2010-12-22 09:40:51 +000049STATISTIC(NumExpand, "Number of expansions");
Duncan Sands3547d2e2010-12-22 09:40:51 +000050STATISTIC(NumReassoc, "Number of reassociations");
51
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000052static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
53static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000054 unsigned);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +000055static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000056 const SimplifyQuery &, unsigned);
57static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000058 unsigned);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +000059static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000060 const SimplifyQuery &Q, unsigned MaxRecurse);
61static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
62static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
David Majnemer6774d612016-07-26 17:58:05 +000063static Value *SimplifyCastInst(unsigned, Value *, Type *,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000064 const SimplifyQuery &, unsigned);
George Burgess IV8e807bf2018-04-24 00:25:01 +000065static Value *SimplifyGEPInst(Type *, ArrayRef<Value *>, const SimplifyQuery &,
66 unsigned);
Duncan Sands5ffc2982010-11-16 12:16:38 +000067
David Bolvanskyf9476082018-07-28 06:55:51 +000068static Value *foldSelectWithBinaryOp(Value *Cond, Value *TrueVal,
69 Value *FalseVal) {
70 BinaryOperator::BinaryOps BinOpCode;
71 if (auto *BO = dyn_cast<BinaryOperator>(Cond))
72 BinOpCode = BO->getOpcode();
73 else
74 return nullptr;
75
David Bolvansky16d8a692018-07-31 14:17:15 +000076 CmpInst::Predicate ExpectedPred, Pred1, Pred2;
David Bolvanskyf9476082018-07-28 06:55:51 +000077 if (BinOpCode == BinaryOperator::Or) {
78 ExpectedPred = ICmpInst::ICMP_NE;
79 } else if (BinOpCode == BinaryOperator::And) {
80 ExpectedPred = ICmpInst::ICMP_EQ;
81 } else
82 return nullptr;
83
David Bolvansky16d8a692018-07-31 14:17:15 +000084 // %A = icmp eq %TV, %FV
85 // %B = icmp eq %X, %Y (and one of these is a select operand)
86 // %C = and %A, %B
87 // %D = select %C, %TV, %FV
88 // -->
89 // %FV
90
91 // %A = icmp ne %TV, %FV
92 // %B = icmp ne %X, %Y (and one of these is a select operand)
93 // %C = or %A, %B
94 // %D = select %C, %TV, %FV
95 // -->
96 // %TV
97 Value *X, *Y;
98 if (!match(Cond, m_c_BinOp(m_c_ICmp(Pred1, m_Specific(TrueVal),
99 m_Specific(FalseVal)),
100 m_ICmp(Pred2, m_Value(X), m_Value(Y)))) ||
David Bolvanskyf9476082018-07-28 06:55:51 +0000101 Pred1 != Pred2 || Pred1 != ExpectedPred)
102 return nullptr;
103
David Bolvansky16d8a692018-07-31 14:17:15 +0000104 if (X == TrueVal || X == FalseVal || Y == TrueVal || Y == FalseVal)
105 return BinOpCode == BinaryOperator::Or ? TrueVal : FalseVal;
106
107 return nullptr;
David Bolvanskyf9476082018-07-28 06:55:51 +0000108}
109
Sanjay Patel35ed2412017-04-16 17:43:11 +0000110/// For a boolean type or a vector of boolean type, return false or a vector
111/// with every element false.
Duncan Sandsc1c92712011-07-26 15:03:53 +0000112static Constant *getFalse(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +0000113 return ConstantInt::getFalse(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +0000114}
115
Sanjay Patel35ed2412017-04-16 17:43:11 +0000116/// For a boolean type or a vector of boolean type, return true or a vector
117/// with every element true.
Duncan Sandsc1c92712011-07-26 15:03:53 +0000118static Constant *getTrue(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +0000119 return ConstantInt::getTrue(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +0000120}
121
Duncan Sands3d5692a2011-10-30 19:56:36 +0000122/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
123static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
124 Value *RHS) {
125 CmpInst *Cmp = dyn_cast<CmpInst>(V);
126 if (!Cmp)
127 return false;
128 CmpInst::Predicate CPred = Cmp->getPredicate();
129 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
130 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
131 return true;
132 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
133 CRHS == LHS;
134}
135
Sanjay Patel472cc782016-01-11 22:14:42 +0000136/// Does the given value dominate the specified phi node?
Sanjay Patel5da361a2018-04-10 18:38:19 +0000137static bool valueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
Duncan Sands5ffc2982010-11-16 12:16:38 +0000138 Instruction *I = dyn_cast<Instruction>(V);
139 if (!I)
140 // Arguments and constants dominate all instructions.
141 return true;
142
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000143 // If we are processing instructions (and/or basic blocks) that have not been
144 // fully added to a function, the parent nodes may still be null. Simply
145 // return the conservative answer in these cases.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000146 if (!I->getParent() || !P->getParent() || !I->getFunction())
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000147 return false;
148
Duncan Sands5ffc2982010-11-16 12:16:38 +0000149 // If we have a DominatorTree then do a precise test.
Daniel Berlin71ff6632017-05-31 01:47:24 +0000150 if (DT)
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000151 return DT->dominates(I, P);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000152
David Majnemer8a1c45d2015-12-12 05:38:55 +0000153 // Otherwise, if the instruction is in the entry block and is not an invoke,
154 // then it obviously dominates all phi nodes.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000155 if (I->getParent() == &I->getFunction()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000156 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000157 return true;
158
159 return false;
160}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000161
Sanjay Patel472cc782016-01-11 22:14:42 +0000162/// Simplify "A op (B op' C)" by distributing op over op', turning it into
163/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000164/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
165/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
166/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000167static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
Craig Topper9c913bf2017-05-19 16:56:53 +0000168 Instruction::BinaryOps OpcodeToExpand,
169 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000170 // Recursion is always used, so bail out at once if we already hit the limit.
171 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000172 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000173
174 // Check whether the expression has the form "(A op' B) op C".
175 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
176 if (Op0->getOpcode() == OpcodeToExpand) {
177 // It does! Try turning it into "(A op C) op' (B op C)".
178 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
179 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000180 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
181 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000182 // They do! Return "L op' R" if it simplifies or is already available.
183 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000184 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
185 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000186 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000187 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000188 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000189 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000190 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000191 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000192 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000193 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000194 }
195 }
196
197 // Check whether the expression has the form "A op (B op' C)".
198 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
199 if (Op1->getOpcode() == OpcodeToExpand) {
200 // It does! Try turning it into "(A op B) op' (A op C)".
201 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
202 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000203 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
204 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000205 // They do! Return "L op' R" if it simplifies or is already available.
206 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000207 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
208 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000209 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000210 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000211 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000212 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000213 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000214 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000215 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000216 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000217 }
218 }
219
Craig Topper9f008862014-04-15 04:59:12 +0000220 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000221}
222
Sanjay Patel472cc782016-01-11 22:14:42 +0000223/// Generic simplifications for associative binary operations.
224/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000225static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
Craig Topper9c913bf2017-05-19 16:56:53 +0000226 Value *LHS, Value *RHS,
227 const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000228 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000229 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
230
231 // Recursion is always used, so bail out at once if we already hit the limit.
232 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000233 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000234
235 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
236 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
237
238 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
239 if (Op0 && Op0->getOpcode() == Opcode) {
240 Value *A = Op0->getOperand(0);
241 Value *B = Op0->getOperand(1);
242 Value *C = RHS;
243
244 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000245 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000246 // It does! Return "A op V" if it simplifies or is already available.
247 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000248 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000249 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000250 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000251 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000252 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000253 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000254 }
255 }
256
257 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
258 if (Op1 && Op1->getOpcode() == Opcode) {
259 Value *A = LHS;
260 Value *B = Op1->getOperand(0);
261 Value *C = Op1->getOperand(1);
262
263 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000264 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000265 // It does! Return "V op C" if it simplifies or is already available.
266 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000267 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000268 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000269 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000270 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000271 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000272 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000273 }
274 }
275
276 // The remaining transforms require commutativity as well as associativity.
277 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000278 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000279
280 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
281 if (Op0 && Op0->getOpcode() == Opcode) {
282 Value *A = Op0->getOperand(0);
283 Value *B = Op0->getOperand(1);
284 Value *C = RHS;
285
286 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000287 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000288 // It does! Return "V op B" if it simplifies or is already available.
289 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000290 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000291 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000292 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000293 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000294 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000295 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000296 }
297 }
298
299 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
300 if (Op1 && Op1->getOpcode() == Opcode) {
301 Value *A = LHS;
302 Value *B = Op1->getOperand(0);
303 Value *C = Op1->getOperand(1);
304
305 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000306 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000307 // It does! Return "B op V" if it simplifies or is already available.
308 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000309 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000310 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000311 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000312 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000313 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000314 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000315 }
316 }
317
Craig Topper9f008862014-04-15 04:59:12 +0000318 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000319}
320
Sanjay Patel472cc782016-01-11 22:14:42 +0000321/// In the case of a binary operation with a select instruction as an operand,
322/// try to simplify the binop by seeing whether evaluating it on both branches
323/// of the select results in the same value. Returns the common value if so,
324/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000325static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000326 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000327 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000328 // Recursion is always used, so bail out at once if we already hit the limit.
329 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000330 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000331
Duncan Sandsb0579e92010-11-10 13:00:08 +0000332 SelectInst *SI;
333 if (isa<SelectInst>(LHS)) {
334 SI = cast<SelectInst>(LHS);
335 } else {
336 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
337 SI = cast<SelectInst>(RHS);
338 }
339
340 // Evaluate the BinOp on the true and false branches of the select.
341 Value *TV;
342 Value *FV;
343 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000344 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
345 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000346 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000347 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
348 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000349 }
350
Duncan Sandse3c53952011-01-01 16:12:09 +0000351 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000352 // If they both failed to simplify then return null.
353 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000354 return TV;
355
356 // If one branch simplified to undef, return the other one.
357 if (TV && isa<UndefValue>(TV))
358 return FV;
359 if (FV && isa<UndefValue>(FV))
360 return TV;
361
362 // If applying the operation did not change the true and false select values,
363 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000364 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000365 return SI;
366
367 // If one branch simplified and the other did not, and the simplified
368 // value is equal to the unsimplified one, return the simplified value.
369 // For example, select (cond, X, X & Z) & Z -> X & Z.
370 if ((FV && !TV) || (TV && !FV)) {
371 // Check that the simplified value has the form "X op Y" where "op" is the
372 // same as the original operation.
373 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
Zachary Turner260fe3e2017-12-14 22:07:03 +0000374 if (Simplified && Simplified->getOpcode() == unsigned(Opcode)) {
Duncan Sandsb0579e92010-11-10 13:00:08 +0000375 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
376 // We already know that "op" is the same as for the simplified value. See
377 // if the operands match too. If so, return the simplified value.
378 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
379 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
380 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000381 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
382 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000383 return Simplified;
384 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000385 Simplified->getOperand(1) == UnsimplifiedLHS &&
386 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000387 return Simplified;
388 }
389 }
390
Craig Topper9f008862014-04-15 04:59:12 +0000391 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000392}
393
Sanjay Patel472cc782016-01-11 22:14:42 +0000394/// In the case of a comparison with a select instruction, try to simplify the
395/// comparison by seeing whether both branches of the select result in the same
396/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000397static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000398 Value *RHS, const SimplifyQuery &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000399 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000400 // Recursion is always used, so bail out at once if we already hit the limit.
401 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000402 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000403
Duncan Sandsb0579e92010-11-10 13:00:08 +0000404 // Make sure the select is on the LHS.
405 if (!isa<SelectInst>(LHS)) {
406 std::swap(LHS, RHS);
407 Pred = CmpInst::getSwappedPredicate(Pred);
408 }
409 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
410 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000411 Value *Cond = SI->getCondition();
412 Value *TV = SI->getTrueValue();
413 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000414
Duncan Sands06504022011-02-03 09:37:39 +0000415 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000416 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000417 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000418 if (TCmp == Cond) {
419 // It not only simplified, it simplified to the select condition. Replace
420 // it with 'true'.
421 TCmp = getTrue(Cond->getType());
422 } else if (!TCmp) {
423 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
424 // condition then we can replace it with 'true'. Otherwise give up.
425 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000426 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000427 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000428 }
429
Duncan Sands3d5692a2011-10-30 19:56:36 +0000430 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000431 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000432 if (FCmp == Cond) {
433 // It not only simplified, it simplified to the select condition. Replace
434 // it with 'false'.
435 FCmp = getFalse(Cond->getType());
436 } else if (!FCmp) {
437 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
438 // condition then we can replace it with 'false'. Otherwise give up.
439 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000440 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000441 FCmp = getFalse(Cond->getType());
442 }
443
444 // If both sides simplified to the same value, then use it as the result of
445 // the original comparison.
446 if (TCmp == FCmp)
447 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000448
449 // The remaining cases only make sense if the select condition has the same
450 // type as the result of the comparison, so bail out if this is not so.
451 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000452 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000453 // If the false value simplified to false, then the result of the compare
454 // is equal to "Cond && TCmp". This also catches the case when the false
455 // value simplified to false and the true value to true, returning "Cond".
456 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000457 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000458 return V;
459 // If the true value simplified to true, then the result of the compare
460 // is equal to "Cond || FCmp".
461 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000462 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000463 return V;
464 // Finally, if the false value simplified to true and the true value to
465 // false, then the result of the compare is equal to "!Cond".
466 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
467 if (Value *V =
468 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000469 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000470 return V;
471
Craig Topper9f008862014-04-15 04:59:12 +0000472 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000473}
474
Sanjay Patel472cc782016-01-11 22:14:42 +0000475/// In the case of a binary operation with an operand that is a PHI instruction,
476/// try to simplify the binop by seeing whether evaluating it on the incoming
477/// phi values yields the same result for every value. If so returns the common
478/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000479static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000480 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000481 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000482 // Recursion is always used, so bail out at once if we already hit the limit.
483 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000484 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000485
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000486 PHINode *PI;
487 if (isa<PHINode>(LHS)) {
488 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000489 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000490 if (!valueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000491 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000492 } else {
493 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
494 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000495 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000496 if (!valueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000497 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000498 }
499
500 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000501 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000502 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000503 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000504 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000505 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000506 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
507 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000508 // If the operation failed to simplify, or simplified to a different value
509 // to previously, then give up.
510 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000511 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000512 CommonValue = V;
513 }
514
515 return CommonValue;
516}
517
Sanjay Patel472cc782016-01-11 22:14:42 +0000518/// In the case of a comparison with a PHI instruction, try to simplify the
519/// comparison by seeing whether comparing with all of the incoming phi values
520/// yields the same result every time. If so returns the common result,
521/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000522static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000523 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000524 // Recursion is always used, so bail out at once if we already hit the limit.
525 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000526 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000527
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000528 // Make sure the phi is on the LHS.
529 if (!isa<PHINode>(LHS)) {
530 std::swap(LHS, RHS);
531 Pred = CmpInst::getSwappedPredicate(Pred);
532 }
533 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
534 PHINode *PI = cast<PHINode>(LHS);
535
Duncan Sands5ffc2982010-11-16 12:16:38 +0000536 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Sanjay Patel5da361a2018-04-10 18:38:19 +0000537 if (!valueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000538 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000539
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000540 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000541 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000542 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000543 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000544 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000545 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000546 // If the operation failed to simplify, or simplified to a different value
547 // to previously, then give up.
548 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000549 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000550 CommonValue = V;
551 }
552
553 return CommonValue;
554}
555
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000556static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
557 Value *&Op0, Value *&Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000558 const SimplifyQuery &Q) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000559 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
560 if (auto *CRHS = dyn_cast<Constant>(Op1))
561 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
562
563 // Canonicalize the constant to the RHS if this is a commutative operation.
564 if (Instruction::isCommutative(Opcode))
565 std::swap(Op0, Op1);
566 }
567 return nullptr;
568}
569
Sanjay Patel472cc782016-01-11 22:14:42 +0000570/// Given operands for an Add, see if we can fold the result.
571/// If not, this returns null.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000572static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000573 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000574 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
575 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000576
Duncan Sands0a2c41682010-12-15 14:07:39 +0000577 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000578 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000579 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000580
Duncan Sands0a2c41682010-12-15 14:07:39 +0000581 // X + 0 -> X
582 if (match(Op1, m_Zero()))
583 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000584
Chen Zhengfdf13ef2018-07-12 03:06:04 +0000585 // If two operands are negative, return 0.
586 if (isKnownNegation(Op0, Op1))
587 return Constant::getNullValue(Op0->getType());
588
Duncan Sands0a2c41682010-12-15 14:07:39 +0000589 // X + (Y - X) -> Y
590 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000591 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000592 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000593 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
594 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000595 return Y;
596
597 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000598 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000599 if (match(Op0, m_Not(m_Specific(Op1))) ||
600 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000601 return Constant::getAllOnesValue(Ty);
602
Craig Topperbcfd2d12017-04-20 16:56:25 +0000603 // add nsw/nuw (xor Y, signmask), signmask --> Y
Sanjay Patelfe672552017-02-18 21:59:09 +0000604 // The no-wrapping add guarantees that the top bit will be set by the add.
605 // Therefore, the xor must be clearing the already set sign bit of Y.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000606 if ((IsNSW || IsNUW) && match(Op1, m_SignMask()) &&
Craig Topperbcfd2d12017-04-20 16:56:25 +0000607 match(Op0, m_Xor(m_Value(Y), m_SignMask())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000608 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000609
Roman Lebedevb060ce42018-06-08 15:44:47 +0000610 // add nuw %x, -1 -> -1, because %x can only be 0.
Roman Lebedevf87321a2018-06-08 15:44:53 +0000611 if (IsNUW && match(Op1, m_AllOnes()))
Roman Lebedevb060ce42018-06-08 15:44:47 +0000612 return Op1; // Which is -1.
613
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000614 /// i1 add -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000615 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000616 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000617 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000618
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000619 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000620 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000621 MaxRecurse))
622 return V;
623
Duncan Sandsb238de02010-11-19 09:20:39 +0000624 // Threading Add over selects and phi nodes is pointless, so don't bother.
625 // Threading over the select in "A + select(cond, B, C)" means evaluating
626 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
627 // only if B and C are equal. If B and C are equal then (since we assume
628 // that operands have already been simplified) "select(cond, B, C)" should
629 // have been simplified to the common value of B and C already. Analysing
630 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
631 // for threading over phi nodes.
632
Craig Topper9f008862014-04-15 04:59:12 +0000633 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000634}
635
Roman Lebedevf87321a2018-06-08 15:44:53 +0000636Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000637 const SimplifyQuery &Query) {
Roman Lebedevf87321a2018-06-08 15:44:53 +0000638 return ::SimplifyAddInst(Op0, Op1, IsNSW, IsNUW, Query, RecursionLimit);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000639}
640
Adrian Prantl5f8f34e42018-05-01 15:54:18 +0000641/// Compute the base pointer and cumulative constant offsets for V.
Chandler Carrutha0796552012-03-12 11:19:31 +0000642///
643/// This strips all constant offsets off of V, leaving it the base pointer, and
644/// accumulates the total constant offset applied in the returned constant. It
645/// returns 0 if V is not a pointer, and returns the constant '0' if there are
646/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000647///
648/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
649/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
650/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000651static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000652 bool AllowNonInbounds = false) {
Craig Topper95d23472017-07-09 07:04:00 +0000653 assert(V->getType()->isPtrOrPtrVectorTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000654
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000655 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000656 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000657
658 // Even though we don't look through PHI nodes, we could be called on an
659 // instruction in an unreachable block, which may be on a cycle.
660 SmallPtrSet<Value *, 4> Visited;
661 Visited.insert(V);
662 do {
663 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000664 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000665 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000666 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000667 V = GEP->getPointerOperand();
668 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000669 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000670 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000671 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000672 break;
673 V = GA->getAliasee();
674 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000675 if (auto CS = CallSite(V))
676 if (Value *RV = CS.getReturnedArgOperand()) {
677 V = RV;
678 continue;
679 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000680 break;
681 }
Craig Topper95d23472017-07-09 07:04:00 +0000682 assert(V->getType()->isPtrOrPtrVectorTy() && "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000683 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000684
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000685 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
686 if (V->getType()->isVectorTy())
687 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
688 OffsetIntPtr);
689 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000690}
691
Adrian Prantl5f8f34e42018-05-01 15:54:18 +0000692/// Compute the constant difference between two pointer values.
Chandler Carrutha0796552012-03-12 11:19:31 +0000693/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000694static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
695 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000696 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
697 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000698
699 // If LHS and RHS are not related via constant offsets to the same base
700 // value, there is nothing we can do here.
701 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000702 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000703
704 // Otherwise, the difference of LHS - RHS can be computed as:
705 // LHS - RHS
706 // = (LHSOffset + Base) - (RHSOffset + Base)
707 // = LHSOffset - RHSOffset
708 return ConstantExpr::getSub(LHSOffset, RHSOffset);
709}
710
Sanjay Patel472cc782016-01-11 22:14:42 +0000711/// Given operands for a Sub, see if we can fold the result.
712/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000713static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000714 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000715 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
716 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000717
718 // X - undef -> undef
719 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000720 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000721 return UndefValue::get(Op0->getType());
722
723 // X - 0 -> X
724 if (match(Op1, m_Zero()))
725 return Op0;
726
727 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000728 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000729 return Constant::getNullValue(Op0->getType());
730
Sanjay Patelefd88852016-10-19 21:23:45 +0000731 // Is this a negation?
732 if (match(Op0, m_Zero())) {
733 // 0 - X -> 0 if the sub is NUW.
734 if (isNUW)
Sanjay Patel30be6652018-04-22 17:07:44 +0000735 return Constant::getNullValue(Op0->getType());
Sanjay Patelefd88852016-10-19 21:23:45 +0000736
Craig Topper8205a1a2017-05-24 16:53:07 +0000737 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +0000738 if (Known.Zero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000739 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
740 // Op1 must be 0 because negating the minimum signed value is undefined.
741 if (isNSW)
Sanjay Patel30be6652018-04-22 17:07:44 +0000742 return Constant::getNullValue(Op0->getType());
Sanjay Patelefd88852016-10-19 21:23:45 +0000743
744 // 0 - X -> X if X is 0 or the minimum signed value.
745 return Op1;
746 }
747 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000748
Duncan Sands99589d02011-01-18 11:50:19 +0000749 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
750 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000751 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000752 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
753 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000754 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000755 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000756 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000757 // It does, we successfully reassociated!
758 ++NumReassoc;
759 return W;
760 }
761 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000762 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000763 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000764 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000765 // It does, we successfully reassociated!
766 ++NumReassoc;
767 return W;
768 }
769 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000770
Duncan Sands99589d02011-01-18 11:50:19 +0000771 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
772 // For example, X - (X + 1) -> -1
773 X = Op0;
774 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
775 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000776 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000777 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000778 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000779 // It does, we successfully reassociated!
780 ++NumReassoc;
781 return W;
782 }
783 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000784 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000785 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000786 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000787 // It does, we successfully reassociated!
788 ++NumReassoc;
789 return W;
790 }
791 }
792
793 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
794 // For example, X - (X - Y) -> Y.
795 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000796 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
797 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000798 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000799 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000800 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000801 // It does, we successfully reassociated!
802 ++NumReassoc;
803 return W;
804 }
805
Duncan Sands395ac42d2012-03-13 14:07:05 +0000806 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
807 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
808 match(Op1, m_Trunc(m_Value(Y))))
809 if (X->getType() == Y->getType())
810 // See if "V === X - Y" simplifies.
811 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
812 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000813 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
814 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000815 // It does, return the simplified "trunc V".
816 return W;
817
818 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000819 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000820 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000821 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000822 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
823
Duncan Sands99589d02011-01-18 11:50:19 +0000824 // i1 sub -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000825 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000826 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000827 return V;
828
Duncan Sands0a2c41682010-12-15 14:07:39 +0000829 // Threading Sub over selects and phi nodes is pointless, so don't bother.
830 // Threading over the select in "A - select(cond, B, C)" means evaluating
831 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
832 // only if B and C are equal. If B and C are equal then (since we assume
833 // that operands have already been simplified) "select(cond, B, C)" should
834 // have been simplified to the common value of B and C already. Analysing
835 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
836 // for threading over phi nodes.
837
Craig Topper9f008862014-04-15 04:59:12 +0000838 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000839}
840
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000841Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000842 const SimplifyQuery &Q) {
843 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
844}
845
Sanjay Patel472cc782016-01-11 22:14:42 +0000846/// Given operands for a Mul, see if we can fold the result.
847/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000848static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000849 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000850 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
851 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000852
853 // X * undef -> 0
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000854 // X * 0 -> 0
Sanjay Patel30be6652018-04-22 17:07:44 +0000855 if (match(Op1, m_CombineOr(m_Undef(), m_Zero())))
856 return Constant::getNullValue(Op0->getType());
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000857
858 // X * 1 -> X
859 if (match(Op1, m_One()))
860 return Op0;
861
Duncan Sandsb67edc62011-01-30 18:03:50 +0000862 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000863 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000864 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
865 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
866 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000867
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000868 // i1 mul -> and.
Craig Topperfde47232017-07-09 07:04:03 +0000869 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000870 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000871 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000872
873 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000874 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000875 MaxRecurse))
876 return V;
877
Dmitry Venikovd2257be2018-01-02 05:47:42 +0000878 // Mul distributes over Add. Try some generic simplifications based on this.
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000879 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000880 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000881 return V;
882
883 // If the operation is with the result of a select instruction, check whether
884 // operating on either branch of the select always yields the same value.
885 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000886 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000887 MaxRecurse))
888 return V;
889
890 // If the operation is with the result of a phi instruction, check whether
891 // operating on all incoming values of the phi always yields the same value.
892 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000893 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000894 MaxRecurse))
895 return V;
896
Craig Topper9f008862014-04-15 04:59:12 +0000897 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000898}
899
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000900Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
901 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
902}
903
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000904/// Check for common or similar folds of integer division or integer remainder.
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000905/// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000906static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
907 Type *Ty = Op0->getType();
908
909 // X / undef -> undef
910 // X % undef -> undef
911 if (match(Op1, m_Undef()))
912 return Op1;
913
914 // X / 0 -> undef
915 // X % 0 -> undef
916 // We don't need to preserve faults!
917 if (match(Op1, m_Zero()))
918 return UndefValue::get(Ty);
919
Zvi Rackover51f0d642018-01-24 17:22:00 +0000920 // If any element of a constant divisor vector is zero or undef, the whole op
921 // is undef.
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000922 auto *Op1C = dyn_cast<Constant>(Op1);
923 if (Op1C && Ty->isVectorTy()) {
924 unsigned NumElts = Ty->getVectorNumElements();
925 for (unsigned i = 0; i != NumElts; ++i) {
926 Constant *Elt = Op1C->getAggregateElement(i);
Zvi Rackover51f0d642018-01-24 17:22:00 +0000927 if (Elt && (Elt->isNullValue() || isa<UndefValue>(Elt)))
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000928 return UndefValue::get(Ty);
929 }
930 }
931
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000932 // undef / X -> 0
933 // undef % X -> 0
934 if (match(Op0, m_Undef()))
935 return Constant::getNullValue(Ty);
936
937 // 0 / X -> 0
938 // 0 % X -> 0
939 if (match(Op0, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +0000940 return Constant::getNullValue(Op0->getType());
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000941
942 // X / X -> 1
943 // X % X -> 0
944 if (Op0 == Op1)
945 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
946
947 // X / 1 -> X
948 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +0000949 // If this is a boolean op (single-bit element type), we can't have
950 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
Sanjay Patel1e911fa2018-06-25 18:51:21 +0000951 // Similarly, if we're zero-extending a boolean divisor, then assume it's a 1.
952 Value *X;
953 if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1) ||
954 (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000955 return IsDiv ? Op0 : Constant::getNullValue(Ty);
956
957 return nullptr;
958}
959
Sanjay Patelcca8f782017-09-14 14:09:11 +0000960/// Given a predicate and two operands, return true if the comparison is true.
961/// This is a helper for div/rem simplification where we return some other value
962/// when we can prove a relationship between the operands.
963static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
964 const SimplifyQuery &Q, unsigned MaxRecurse) {
965 Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
966 Constant *C = dyn_cast_or_null<Constant>(V);
967 return (C && C->isAllOnesValue());
968}
969
970/// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
971/// to simplify X % Y to X.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000972static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
Sanjay Patelcca8f782017-09-14 14:09:11 +0000973 unsigned MaxRecurse, bool IsSigned) {
974 // Recursion is always used, so bail out at once if we already hit the limit.
975 if (!MaxRecurse--)
976 return false;
977
978 if (IsSigned) {
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000979 // |X| / |Y| --> 0
980 //
981 // We require that 1 operand is a simple constant. That could be extended to
982 // 2 variables if we computed the sign bit for each.
983 //
984 // Make sure that a constant is not the minimum signed value because taking
985 // the abs() of that is undefined.
986 Type *Ty = X->getType();
987 const APInt *C;
988 if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
989 // Is the variable divisor magnitude always greater than the constant
990 // dividend magnitude?
991 // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
992 Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
993 Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
994 if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
995 isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
996 return true;
997 }
998 if (match(Y, m_APInt(C))) {
999 // Special-case: we can't take the abs() of a minimum signed value. If
1000 // that's the divisor, then all we have to do is prove that the dividend
1001 // is also not the minimum signed value.
1002 if (C->isMinSignedValue())
1003 return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
1004
1005 // Is the variable dividend magnitude always less than the constant
1006 // divisor magnitude?
1007 // |X| < |C| --> X > -abs(C) and X < abs(C)
1008 Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
1009 Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
1010 if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
1011 isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
1012 return true;
1013 }
Sanjay Patelcca8f782017-09-14 14:09:11 +00001014 return false;
1015 }
1016
1017 // IsSigned == false.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +00001018 // Is the dividend unsigned less than the divisor?
1019 return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
Sanjay Patelcca8f782017-09-14 14:09:11 +00001020}
1021
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001022/// These are simplifications common to SDiv and UDiv.
1023static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001024 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001025 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1026 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001027
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001028 if (Value *V = simplifyDivRem(Op0, Op1, true))
1029 return V;
1030
Sanjay Patelcca8f782017-09-14 14:09:11 +00001031 bool IsSigned = Opcode == Instruction::SDiv;
Duncan Sands65995fa2011-01-28 18:50:50 +00001032
Duncan Sands771e82a2011-01-28 16:51:11 +00001033 // (X * Y) / Y -> X if the multiplication does not overflow.
Sanjay Patel33cb8452018-01-19 16:12:55 +00001034 Value *X;
1035 if (match(Op0, m_c_Mul(m_Value(X), m_Specific(Op1)))) {
1036 auto *Mul = cast<OverflowingBinaryOperator>(Op0);
1037 // If the Mul does not overflow, then we are good to go.
Sanjay Patelcca8f782017-09-14 14:09:11 +00001038 if ((IsSigned && Mul->hasNoSignedWrap()) ||
1039 (!IsSigned && Mul->hasNoUnsignedWrap()))
Duncan Sands5747aba2011-02-02 20:52:00 +00001040 return X;
Sanjay Patel33cb8452018-01-19 16:12:55 +00001041 // If X has the form X = A / Y, then X * Y cannot overflow.
1042 if ((IsSigned && match(X, m_SDiv(m_Value(), m_Specific(Op1)))) ||
1043 (!IsSigned && match(X, m_UDiv(m_Value(), m_Specific(Op1)))))
1044 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001045 }
1046
Duncan Sands65995fa2011-01-28 18:50:50 +00001047 // (X rem Y) / Y -> 0
Sanjay Patelcca8f782017-09-14 14:09:11 +00001048 if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1049 (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
Duncan Sands65995fa2011-01-28 18:50:50 +00001050 return Constant::getNullValue(Op0->getType());
1051
David Majnemercb9d5962014-10-11 10:20:01 +00001052 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1053 ConstantInt *C1, *C2;
Sanjay Patelcca8f782017-09-14 14:09:11 +00001054 if (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
David Majnemercb9d5962014-10-11 10:20:01 +00001055 match(Op1, m_ConstantInt(C2))) {
1056 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001057 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001058 if (Overflow)
1059 return Constant::getNullValue(Op0->getType());
1060 }
1061
Duncan Sands65995fa2011-01-28 18:50:50 +00001062 // If the operation is with the result of a select instruction, check whether
1063 // operating on either branch of the select always yields the same value.
1064 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001065 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001066 return V;
1067
1068 // If the operation is with the result of a phi instruction, check whether
1069 // operating on all incoming values of the phi always yields the same value.
1070 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001071 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001072 return V;
1073
Sanjay Patelcca8f782017-09-14 14:09:11 +00001074 if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1075 return Constant::getNullValue(Op0->getType());
1076
Craig Topper9f008862014-04-15 04:59:12 +00001077 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001078}
1079
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001080/// These are simplifications common to SRem and URem.
1081static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001082 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001083 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1084 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001085
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001086 if (Value *V = simplifyDivRem(Op0, Op1, false))
1087 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001088
David Majnemerb435a422014-09-17 04:16:35 +00001089 // (X % Y) % Y -> X % Y
1090 if ((Opcode == Instruction::SRem &&
1091 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1092 (Opcode == Instruction::URem &&
1093 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001094 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001095
Anton Bikineev82f61152018-01-23 09:27:47 +00001096 // (X << Y) % X -> 0
1097 if ((Opcode == Instruction::SRem &&
1098 match(Op0, m_NSWShl(m_Specific(Op1), m_Value()))) ||
1099 (Opcode == Instruction::URem &&
1100 match(Op0, m_NUWShl(m_Specific(Op1), m_Value()))))
1101 return Constant::getNullValue(Op0->getType());
1102
Duncan Sandsa3e36992011-05-02 16:27:02 +00001103 // If the operation is with the result of a select instruction, check whether
1104 // operating on either branch of the select always yields the same value.
1105 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001106 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001107 return V;
1108
1109 // If the operation is with the result of a phi instruction, check whether
1110 // operating on all incoming values of the phi always yields the same value.
1111 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001112 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001113 return V;
1114
Sanjay Patelcca8f782017-09-14 14:09:11 +00001115 // If X / Y == 0, then X % Y == X.
1116 if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1117 return Op0;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001118
1119 return nullptr;
1120}
1121
1122/// Given operands for an SDiv, see if we can fold the result.
1123/// If not, this returns null.
1124static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1125 unsigned MaxRecurse) {
Chen Zheng69bb0642018-07-21 12:27:54 +00001126 // If two operands are negated and no signed overflow, return -1.
1127 if (isKnownNegation(Op0, Op1, /*NeedNSW=*/true))
1128 return Constant::getAllOnesValue(Op0->getType());
1129
Sanjay Patelcca8f782017-09-14 14:09:11 +00001130 return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001131}
1132
1133Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1134 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1135}
1136
1137/// Given operands for a UDiv, see if we can fold the result.
1138/// If not, this returns null.
1139static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1140 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001141 return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001142}
1143
1144Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1145 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1146}
1147
Sanjay Patel472cc782016-01-11 22:14:42 +00001148/// Given operands for an SRem, see if we can fold the result.
1149/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001150static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001151 unsigned MaxRecurse) {
Sanjay Patel2b7e3102018-06-26 15:32:54 +00001152 // If the divisor is 0, the result is undefined, so assume the divisor is -1.
1153 // srem Op0, (sext i1 X) --> srem Op0, -1 --> 0
1154 Value *X;
1155 if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
1156 return ConstantInt::getNullValue(Op0->getType());
1157
Chen Zhengf801d0f2018-07-20 13:00:47 +00001158 // If the two operands are negated, return 0.
1159 if (isKnownNegation(Op0, Op1))
Chen Zheng69bb0642018-07-21 12:27:54 +00001160 return ConstantInt::getNullValue(Op0->getType());
Chen Zhengf801d0f2018-07-20 13:00:47 +00001161
Sanjay Patelcca8f782017-09-14 14:09:11 +00001162 return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001163}
1164
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001165Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1166 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1167}
1168
Sanjay Patel472cc782016-01-11 22:14:42 +00001169/// Given operands for a URem, see if we can fold the result.
1170/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001171static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001172 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001173 return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001174}
1175
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001176Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1177 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1178}
1179
Sanjay Patel472cc782016-01-11 22:14:42 +00001180/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001181static bool isUndefShift(Value *Amount) {
1182 Constant *C = dyn_cast<Constant>(Amount);
1183 if (!C)
1184 return false;
1185
1186 // X shift by undef -> undef because it may shift by the bitwidth.
1187 if (isa<UndefValue>(C))
1188 return true;
1189
1190 // Shifting by the bitwidth or more is undefined.
1191 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1192 if (CI->getValue().getLimitedValue() >=
1193 CI->getType()->getScalarSizeInBits())
1194 return true;
1195
1196 // If all lanes of a vector shift are undefined the whole shift is.
1197 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1198 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1199 if (!isUndefShift(C->getAggregateElement(I)))
1200 return false;
1201 return true;
1202 }
1203
1204 return false;
1205}
1206
Sanjay Patel472cc782016-01-11 22:14:42 +00001207/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1208/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001209static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001210 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001211 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1212 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001213
Duncan Sands571fd9a2011-01-14 14:44:12 +00001214 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001215 if (match(Op0, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +00001216 return Constant::getNullValue(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001217
Duncan Sands571fd9a2011-01-14 14:44:12 +00001218 // X shift by 0 -> X
Sanjay Patelad0bfb82018-06-26 17:31:38 +00001219 // Shift-by-sign-extended bool must be shift-by-0 because shift-by-all-ones
1220 // would be poison.
1221 Value *X;
1222 if (match(Op1, m_Zero()) ||
1223 (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
Duncan Sands7f60dc12011-01-14 00:37:45 +00001224 return Op0;
1225
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001226 // Fold undefined shifts.
1227 if (isUndefShift(Op1))
1228 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001229
Duncan Sands571fd9a2011-01-14 14:44:12 +00001230 // If the operation is with the result of a select instruction, check whether
1231 // operating on either branch of the select always yields the same value.
1232 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001233 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001234 return V;
1235
1236 // If the operation is with the result of a phi instruction, check whether
1237 // operating on all incoming values of the phi always yields the same value.
1238 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001239 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001240 return V;
1241
Sanjay Patel6786bc52016-05-10 20:46:54 +00001242 // If any bits in the shift amount make that value greater than or equal to
1243 // the number of bits in the type, the shift is undefined.
Craig Topper8205a1a2017-05-24 16:53:07 +00001244 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1245 if (Known.One.getLimitedValue() >= Known.getBitWidth())
Sanjay Patel6786bc52016-05-10 20:46:54 +00001246 return UndefValue::get(Op0->getType());
1247
1248 // If all valid bits in the shift amount are known zero, the first operand is
1249 // unchanged.
Craig Topper8205a1a2017-05-24 16:53:07 +00001250 unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
Craig Topper8df66c62017-05-12 17:20:30 +00001251 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001252 return Op0;
1253
Craig Topper9f008862014-04-15 04:59:12 +00001254 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001255}
1256
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001257/// Given operands for an Shl, LShr or AShr, see if we can
David Majnemerbf7550e2014-11-05 00:59:59 +00001258/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001259static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001260 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001261 unsigned MaxRecurse) {
1262 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1263 return V;
1264
1265 // X >> X -> 0
1266 if (Op0 == Op1)
1267 return Constant::getNullValue(Op0->getType());
1268
David Majnemer65c52ae2014-12-17 01:54:33 +00001269 // undef >> X -> 0
1270 // undef >> X -> undef (if it's exact)
1271 if (match(Op0, m_Undef()))
1272 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1273
David Majnemerbf7550e2014-11-05 00:59:59 +00001274 // The low bit cannot be shifted out of an exact shift if it is set.
1275 if (isExact) {
Craig Topper8205a1a2017-05-24 16:53:07 +00001276 KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +00001277 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001278 return Op0;
1279 }
1280
1281 return nullptr;
1282}
1283
Sanjay Patel472cc782016-01-11 22:14:42 +00001284/// Given operands for an Shl, see if we can fold the result.
1285/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001286static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001287 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001288 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001289 return V;
1290
1291 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001292 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001293 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001294 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001295
Chris Lattner9e4aa022011-02-09 17:15:04 +00001296 // (X >> A) << A -> X
1297 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001298 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001299 return X;
Roman Lebedev26838022018-06-07 20:03:45 +00001300
1301 // shl nuw i8 C, %x -> C iff C has sign bit set.
1302 if (isNUW && match(Op0, m_Negative()))
1303 return Op0;
1304 // NOTE: could use computeKnownBits() / LazyValueInfo,
1305 // but the cost-benefit analysis suggests it isn't worth it.
1306
Craig Topper9f008862014-04-15 04:59:12 +00001307 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001308}
1309
Chris Lattner9e4aa022011-02-09 17:15:04 +00001310Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001311 const SimplifyQuery &Q) {
1312 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1313}
1314
Sanjay Patel472cc782016-01-11 22:14:42 +00001315/// Given operands for an LShr, see if we can fold the result.
1316/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001317static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001318 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001319 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1320 MaxRecurse))
1321 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001322
Chris Lattner9e4aa022011-02-09 17:15:04 +00001323 // (X << A) >> A -> X
1324 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001325 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001326 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001327
Hiroshi Inoue02f79ea2018-08-01 04:40:32 +00001328 // ((X << A) | Y) >> A -> X if effective width of Y is not larger than A.
1329 // We can return X as we do in the above case since OR alters no bits in X.
1330 // SimplifyDemandedBits in InstCombine can do more general optimization for
1331 // bit manipulation. This pattern aims to provide opportunities for other
1332 // optimizers by supporting a simple but common case in InstSimplify.
1333 Value *Y;
1334 const APInt *ShRAmt, *ShLAmt;
1335 if (match(Op1, m_APInt(ShRAmt)) &&
1336 match(Op0, m_c_Or(m_NUWShl(m_Value(X), m_APInt(ShLAmt)), m_Value(Y))) &&
1337 *ShRAmt == *ShLAmt) {
1338 const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1339 const unsigned Width = Op0->getType()->getScalarSizeInBits();
1340 const unsigned EffWidthY = Width - YKnown.countMinLeadingZeros();
1341 if (EffWidthY <= ShRAmt->getZExtValue())
1342 return X;
1343 }
1344
Craig Topper9f008862014-04-15 04:59:12 +00001345 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001346}
1347
Chris Lattner9e4aa022011-02-09 17:15:04 +00001348Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001349 const SimplifyQuery &Q) {
1350 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1351}
1352
Sanjay Patel472cc782016-01-11 22:14:42 +00001353/// Given operands for an AShr, see if we can fold the result.
1354/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001355static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001356 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001357 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1358 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001359 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001360
Sanjay Pateladf6e882018-02-18 18:05:08 +00001361 // all ones >>a X -> -1
1362 // Do not return Op0 because it may contain undef elements if it's a vector.
Duncan Sands7f60dc12011-01-14 00:37:45 +00001363 if (match(Op0, m_AllOnes()))
Sanjay Pateladf6e882018-02-18 18:05:08 +00001364 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001365
Chris Lattner9e4aa022011-02-09 17:15:04 +00001366 // (X << A) >> A -> X
1367 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001368 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001369 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001370
Suyog Sarda68862412014-07-17 06:28:15 +00001371 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001372 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001373 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1374 return Op0;
1375
Craig Topper9f008862014-04-15 04:59:12 +00001376 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001377}
1378
Chris Lattner9e4aa022011-02-09 17:15:04 +00001379Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001380 const SimplifyQuery &Q) {
1381 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1382}
1383
Craig Topper348314d2017-05-26 22:42:34 +00001384/// Commuted variants are assumed to be handled by calling this function again
1385/// with the parameters swapped.
David Majnemer1af36e52014-12-06 10:51:40 +00001386static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1387 ICmpInst *UnsignedICmp, bool IsAnd) {
1388 Value *X, *Y;
1389
1390 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001391 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1392 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001393 return nullptr;
1394
1395 ICmpInst::Predicate UnsignedPred;
1396 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1397 ICmpInst::isUnsigned(UnsignedPred))
1398 ;
1399 else if (match(UnsignedICmp,
Sanjay Patel0c57de42018-06-20 14:22:49 +00001400 m_ICmp(UnsignedPred, m_Specific(Y), m_Value(X))) &&
David Majnemer1af36e52014-12-06 10:51:40 +00001401 ICmpInst::isUnsigned(UnsignedPred))
1402 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1403 else
1404 return nullptr;
1405
1406 // X < Y && Y != 0 --> X < Y
1407 // X < Y || Y != 0 --> Y != 0
1408 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1409 return IsAnd ? UnsignedICmp : ZeroICmp;
1410
1411 // X >= Y || Y != 0 --> true
1412 // X >= Y || Y == 0 --> X >= Y
1413 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1414 if (EqPred == ICmpInst::ICMP_NE)
1415 return getTrue(UnsignedICmp->getType());
1416 return UnsignedICmp;
1417 }
1418
David Majnemerd5b3aa42014-12-08 18:30:43 +00001419 // X < Y && Y == 0 --> false
1420 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1421 IsAnd)
1422 return getFalse(UnsignedICmp->getType());
1423
David Majnemer1af36e52014-12-06 10:51:40 +00001424 return nullptr;
1425}
1426
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001427/// Commuted variants are assumed to be handled by calling this function again
1428/// with the parameters swapped.
1429static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1430 ICmpInst::Predicate Pred0, Pred1;
1431 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001432 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1433 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001434 return nullptr;
1435
1436 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1437 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1438 // can eliminate Op1 from this 'and'.
1439 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1440 return Op0;
1441
1442 // Check for any combination of predicates that are guaranteed to be disjoint.
1443 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1444 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1445 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1446 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1447 return getFalse(Op0->getType());
1448
1449 return nullptr;
1450}
1451
1452/// Commuted variants are assumed to be handled by calling this function again
1453/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001454static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1455 ICmpInst::Predicate Pred0, Pred1;
1456 Value *A ,*B;
1457 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1458 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1459 return nullptr;
1460
1461 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1462 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1463 // can eliminate Op0 from this 'or'.
1464 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1465 return Op1;
1466
1467 // Check for any combination of predicates that cover the entire range of
1468 // possibilities.
1469 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1470 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1471 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1472 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1473 return getTrue(Op0->getType());
1474
1475 return nullptr;
1476}
1477
Sanjay Patel599e65b2017-05-07 15:11:40 +00001478/// Test if a pair of compares with a shared operand and 2 constants has an
1479/// empty set intersection, full set union, or if one compare is a superset of
1480/// the other.
1481static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1482 bool IsAnd) {
1483 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1484 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1485 return nullptr;
1486
1487 const APInt *C0, *C1;
1488 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1489 !match(Cmp1->getOperand(1), m_APInt(C1)))
1490 return nullptr;
1491
1492 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1493 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1494
Sanjay Patel67454472017-05-08 16:35:02 +00001495 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001496 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1497 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1498 return getFalse(Cmp0->getType());
1499
1500 // For or-of-compares, check if the union is full:
1501 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1502 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1503 return getTrue(Cmp0->getType());
1504
1505 // Is one range a superset of the other?
1506 // If this is and-of-compares, take the smaller set:
1507 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1508 // If this is or-of-compares, take the larger set:
1509 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1510 if (Range0.contains(Range1))
1511 return IsAnd ? Cmp1 : Cmp0;
1512 if (Range1.contains(Range0))
1513 return IsAnd ? Cmp0 : Cmp1;
1514
1515 return nullptr;
1516}
1517
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001518static Value *simplifyAndOrOfICmpsWithZero(ICmpInst *Cmp0, ICmpInst *Cmp1,
1519 bool IsAnd) {
1520 ICmpInst::Predicate P0 = Cmp0->getPredicate(), P1 = Cmp1->getPredicate();
1521 if (!match(Cmp0->getOperand(1), m_Zero()) ||
1522 !match(Cmp1->getOperand(1), m_Zero()) || P0 != P1)
1523 return nullptr;
1524
1525 if ((IsAnd && P0 != ICmpInst::ICMP_NE) || (!IsAnd && P1 != ICmpInst::ICMP_EQ))
1526 return nullptr;
1527
Sanjay Patel4158eff2018-01-13 15:44:44 +00001528 // We have either "(X == 0 || Y == 0)" or "(X != 0 && Y != 0)".
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001529 Value *X = Cmp0->getOperand(0);
1530 Value *Y = Cmp1->getOperand(0);
1531
1532 // If one of the compares is a masked version of a (not) null check, then
Sanjay Patel4158eff2018-01-13 15:44:44 +00001533 // that compare implies the other, so we eliminate the other. Optionally, look
1534 // through a pointer-to-int cast to match a null check of a pointer type.
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001535
Sanjay Patel9568f422018-01-14 15:58:18 +00001536 // (X == 0) || (([ptrtoint] X & ?) == 0) --> ([ptrtoint] X & ?) == 0
1537 // (X == 0) || ((? & [ptrtoint] X) == 0) --> (? & [ptrtoint] X) == 0
1538 // (X != 0) && (([ptrtoint] X & ?) != 0) --> ([ptrtoint] X & ?) != 0
1539 // (X != 0) && ((? & [ptrtoint] X) != 0) --> (? & [ptrtoint] X) != 0
Sanjay Patel4158eff2018-01-13 15:44:44 +00001540 if (match(Y, m_c_And(m_Specific(X), m_Value())) ||
1541 match(Y, m_c_And(m_PtrToInt(m_Specific(X)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001542 return Cmp1;
1543
Sanjay Patel9568f422018-01-14 15:58:18 +00001544 // (([ptrtoint] Y & ?) == 0) || (Y == 0) --> ([ptrtoint] Y & ?) == 0
1545 // ((? & [ptrtoint] Y) == 0) || (Y == 0) --> (? & [ptrtoint] Y) == 0
1546 // (([ptrtoint] Y & ?) != 0) && (Y != 0) --> ([ptrtoint] Y & ?) != 0
1547 // ((? & [ptrtoint] Y) != 0) && (Y != 0) --> (? & [ptrtoint] Y) != 0
Sanjay Patel4158eff2018-01-13 15:44:44 +00001548 if (match(X, m_c_And(m_Specific(Y), m_Value())) ||
1549 match(X, m_c_And(m_PtrToInt(m_Specific(Y)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001550 return Cmp0;
1551
1552 return nullptr;
1553}
1554
Craig Topper348314d2017-05-26 22:42:34 +00001555static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel599e65b2017-05-07 15:11:40 +00001556 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001557 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001558 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001559 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001560 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001561 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001562
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001563 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001564 return nullptr;
1565
David Majnemera315bd82014-09-15 08:15:28 +00001566 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001567 if (AddInst->getOperand(1) != Op1->getOperand(1))
1568 return nullptr;
1569
Craig Topper9bce1ad2017-05-26 19:04:02 +00001570 Type *ITy = Op0->getType();
David Majnemera315bd82014-09-15 08:15:28 +00001571 bool isNSW = AddInst->hasNoSignedWrap();
1572 bool isNUW = AddInst->hasNoUnsignedWrap();
1573
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001574 const APInt Delta = *C1 - *C0;
1575 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001576 if (Delta == 2) {
1577 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1578 return getFalse(ITy);
1579 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1580 return getFalse(ITy);
1581 }
1582 if (Delta == 1) {
1583 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1584 return getFalse(ITy);
1585 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1586 return getFalse(ITy);
1587 }
1588 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001589 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001590 if (Delta == 2)
1591 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1592 return getFalse(ITy);
1593 if (Delta == 1)
1594 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1595 return getFalse(ITy);
1596 }
1597
1598 return nullptr;
1599}
1600
Craig Topper348314d2017-05-26 22:42:34 +00001601static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1602 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1603 return X;
1604 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
Sanjay Patel142cb832017-05-04 18:19:17 +00001605 return X;
1606
Craig Topper348314d2017-05-26 22:42:34 +00001607 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1608 return X;
1609 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
Sanjay Patel142cb832017-05-04 18:19:17 +00001610 return X;
1611
Craig Topper348314d2017-05-26 22:42:34 +00001612 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
Sanjay Patel599e65b2017-05-07 15:11:40 +00001613 return X;
1614
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001615 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, true))
1616 return X;
1617
Craig Topper348314d2017-05-26 22:42:34 +00001618 if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1))
1619 return X;
1620 if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0))
1621 return X;
1622
1623 return nullptr;
1624}
1625
1626static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001627 // (icmp (add V, C0), C1) | (icmp V, C0)
1628 ICmpInst::Predicate Pred0, Pred1;
1629 const APInt *C0, *C1;
1630 Value *V;
1631 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1632 return nullptr;
1633
1634 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1635 return nullptr;
1636
1637 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1638 if (AddInst->getOperand(1) != Op1->getOperand(1))
1639 return nullptr;
1640
1641 Type *ITy = Op0->getType();
1642 bool isNSW = AddInst->hasNoSignedWrap();
1643 bool isNUW = AddInst->hasNoUnsignedWrap();
1644
1645 const APInt Delta = *C1 - *C0;
1646 if (C0->isStrictlyPositive()) {
1647 if (Delta == 2) {
1648 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1649 return getTrue(ITy);
1650 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1651 return getTrue(ITy);
1652 }
1653 if (Delta == 1) {
1654 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1655 return getTrue(ITy);
1656 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1657 return getTrue(ITy);
1658 }
1659 }
1660 if (C0->getBoolValue() && isNUW) {
1661 if (Delta == 2)
1662 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1663 return getTrue(ITy);
1664 if (Delta == 1)
1665 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1666 return getTrue(ITy);
1667 }
1668
1669 return nullptr;
1670}
1671
Craig Topper348314d2017-05-26 22:42:34 +00001672static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1673 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1674 return X;
1675 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1676 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001677
Craig Topper348314d2017-05-26 22:42:34 +00001678 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1679 return X;
1680 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1681 return X;
1682
1683 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1684 return X;
1685
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001686 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, false))
1687 return X;
1688
Craig Topper348314d2017-05-26 22:42:34 +00001689 if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1))
1690 return X;
1691 if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0))
1692 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001693
1694 return nullptr;
1695}
1696
Sanjay Pateleb731b02017-11-19 15:34:27 +00001697static Value *simplifyAndOrOfFCmps(FCmpInst *LHS, FCmpInst *RHS, bool IsAnd) {
1698 Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1699 Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1700 if (LHS0->getType() != RHS0->getType())
1701 return nullptr;
1702
1703 FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1704 if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1705 (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1706 // (fcmp ord NNAN, X) & (fcmp ord X, Y) --> fcmp ord X, Y
1707 // (fcmp ord NNAN, X) & (fcmp ord Y, X) --> fcmp ord Y, X
1708 // (fcmp ord X, NNAN) & (fcmp ord X, Y) --> fcmp ord X, Y
1709 // (fcmp ord X, NNAN) & (fcmp ord Y, X) --> fcmp ord Y, X
1710 // (fcmp uno NNAN, X) | (fcmp uno X, Y) --> fcmp uno X, Y
1711 // (fcmp uno NNAN, X) | (fcmp uno Y, X) --> fcmp uno Y, X
1712 // (fcmp uno X, NNAN) | (fcmp uno X, Y) --> fcmp uno X, Y
1713 // (fcmp uno X, NNAN) | (fcmp uno Y, X) --> fcmp uno Y, X
1714 if ((isKnownNeverNaN(LHS0) && (LHS1 == RHS0 || LHS1 == RHS1)) ||
1715 (isKnownNeverNaN(LHS1) && (LHS0 == RHS0 || LHS0 == RHS1)))
1716 return RHS;
1717
1718 // (fcmp ord X, Y) & (fcmp ord NNAN, X) --> fcmp ord X, Y
1719 // (fcmp ord Y, X) & (fcmp ord NNAN, X) --> fcmp ord Y, X
1720 // (fcmp ord X, Y) & (fcmp ord X, NNAN) --> fcmp ord X, Y
1721 // (fcmp ord Y, X) & (fcmp ord X, NNAN) --> fcmp ord Y, X
1722 // (fcmp uno X, Y) | (fcmp uno NNAN, X) --> fcmp uno X, Y
1723 // (fcmp uno Y, X) | (fcmp uno NNAN, X) --> fcmp uno Y, X
1724 // (fcmp uno X, Y) | (fcmp uno X, NNAN) --> fcmp uno X, Y
1725 // (fcmp uno Y, X) | (fcmp uno X, NNAN) --> fcmp uno Y, X
1726 if ((isKnownNeverNaN(RHS0) && (RHS1 == LHS0 || RHS1 == LHS1)) ||
1727 (isKnownNeverNaN(RHS1) && (RHS0 == LHS0 || RHS0 == LHS1)))
1728 return LHS;
1729 }
1730
1731 return nullptr;
1732}
1733
1734static Value *simplifyAndOrOfCmps(Value *Op0, Value *Op1, bool IsAnd) {
Sanjay Patele42b4d52017-05-04 19:51:34 +00001735 // Look through casts of the 'and' operands to find compares.
1736 auto *Cast0 = dyn_cast<CastInst>(Op0);
1737 auto *Cast1 = dyn_cast<CastInst>(Op1);
1738 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1739 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1740 Op0 = Cast0->getOperand(0);
1741 Op1 = Cast1->getOperand(0);
1742 }
1743
Sanjay Pateleb731b02017-11-19 15:34:27 +00001744 Value *V = nullptr;
1745 auto *ICmp0 = dyn_cast<ICmpInst>(Op0);
1746 auto *ICmp1 = dyn_cast<ICmpInst>(Op1);
1747 if (ICmp0 && ICmp1)
1748 V = IsAnd ? simplifyAndOfICmps(ICmp0, ICmp1) :
1749 simplifyOrOfICmps(ICmp0, ICmp1);
Sanjay Patele42b4d52017-05-04 19:51:34 +00001750
Sanjay Pateleb731b02017-11-19 15:34:27 +00001751 auto *FCmp0 = dyn_cast<FCmpInst>(Op0);
1752 auto *FCmp1 = dyn_cast<FCmpInst>(Op1);
1753 if (FCmp0 && FCmp1)
1754 V = simplifyAndOrOfFCmps(FCmp0, FCmp1, IsAnd);
1755
Craig Topper348314d2017-05-26 22:42:34 +00001756 if (!V)
1757 return nullptr;
1758 if (!Cast0)
Sanjay Patele42b4d52017-05-04 19:51:34 +00001759 return V;
Craig Topper348314d2017-05-26 22:42:34 +00001760
1761 // If we looked through casts, we can only handle a constant simplification
1762 // because we are not allowed to create a cast instruction here.
1763 if (auto *C = dyn_cast<Constant>(V))
1764 return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
Sanjay Patele42b4d52017-05-04 19:51:34 +00001765
1766 return nullptr;
1767}
1768
Sanjay Patel472cc782016-01-11 22:14:42 +00001769/// Given operands for an And, see if we can fold the result.
1770/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001771static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001772 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001773 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1774 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001775
Chris Lattnera71e9d62009-11-10 00:55:12 +00001776 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001777 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001778 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001779
Chris Lattnera71e9d62009-11-10 00:55:12 +00001780 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001781 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001782 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001783
Duncan Sandsc89ac072010-11-17 18:52:15 +00001784 // X & 0 = 0
1785 if (match(Op1, m_Zero()))
Sanjay Patel30be6652018-04-22 17:07:44 +00001786 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001787
Duncan Sandsc89ac072010-11-17 18:52:15 +00001788 // X & -1 = X
1789 if (match(Op1, m_AllOnes()))
1790 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001791
Chris Lattnera71e9d62009-11-10 00:55:12 +00001792 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001793 if (match(Op0, m_Not(m_Specific(Op1))) ||
1794 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001795 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001796
Chris Lattnera71e9d62009-11-10 00:55:12 +00001797 // (A | ?) & A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001798 if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001799 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001800
Chris Lattnera71e9d62009-11-10 00:55:12 +00001801 // A & (A | ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001802 if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001803 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001804
Sanjay Patel877364f2017-05-16 21:51:04 +00001805 // A mask that only clears known zeros of a shifted value is a no-op.
1806 Value *X;
1807 const APInt *Mask;
1808 const APInt *ShAmt;
1809 if (match(Op1, m_APInt(Mask))) {
1810 // If all bits in the inverted and shifted mask are clear:
1811 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1812 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1813 (~(*Mask)).lshr(*ShAmt).isNullValue())
1814 return Op0;
1815
1816 // If all bits in the inverted and shifted mask are clear:
1817 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1818 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1819 (~(*Mask)).shl(*ShAmt).isNullValue())
1820 return Op0;
1821 }
1822
Duncan Sandsba286d72011-10-26 20:55:21 +00001823 // A & (-A) = A if A is a power of two or zero.
1824 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1825 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001826 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1827 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001828 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001829 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1830 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001831 return Op1;
1832 }
1833
Sanjay Pateleb731b02017-11-19 15:34:27 +00001834 if (Value *V = simplifyAndOrOfCmps(Op0, Op1, true))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001835 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001836
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001837 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001838 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1839 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001840 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001841
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001842 // And distributes over Or. Try some generic simplifications based on this.
1843 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001844 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001845 return V;
1846
1847 // And distributes over Xor. Try some generic simplifications based on this.
1848 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001849 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001850 return V;
1851
Duncan Sandsb0579e92010-11-10 13:00:08 +00001852 // If the operation is with the result of a select instruction, check whether
1853 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001854 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001855 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1856 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001857 return V;
1858
1859 // If the operation is with the result of a phi instruction, check whether
1860 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001861 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001862 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001863 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001864 return V;
1865
Hiroshi Inoue73f8b252018-08-03 05:39:48 +00001866 // Assuming the effective width of Y is not larger than A, i.e. all bits
1867 // from X and Y are disjoint in (X << A) | Y,
1868 // if the mask of this AND op covers all bits of X or Y, while it covers
1869 // no bits from the other, we can bypass this AND op. E.g.,
1870 // ((X << A) | Y) & Mask -> Y,
1871 // if Mask = ((1 << effective_width_of(Y)) - 1)
1872 // ((X << A) | Y) & Mask -> X << A,
1873 // if Mask = ((1 << effective_width_of(X)) - 1) << A
1874 // SimplifyDemandedBits in InstCombine can optimize the general case.
1875 // This pattern aims to help other passes for a common case.
1876 Value *Y, *XShifted;
1877 if (match(Op1, m_APInt(Mask)) &&
1878 match(Op0, m_c_Or(m_CombineAnd(m_NUWShl(m_Value(X), m_APInt(ShAmt)),
1879 m_Value(XShifted)),
1880 m_Value(Y)))) {
1881 const unsigned ShftCnt = ShAmt->getZExtValue();
1882 const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1883 const unsigned Width = Op0->getType()->getScalarSizeInBits();
1884 const unsigned EffWidthY = Width - YKnown.countMinLeadingZeros();
1885 if (EffWidthY <= ShftCnt) {
1886 const KnownBits XKnown = computeKnownBits(X, Q.DL, 0, Q.AC, Q.CxtI,
1887 Q.DT);
1888 const unsigned EffWidthX = Width - XKnown.countMinLeadingZeros();
1889 const APInt EffBitsY = APInt::getLowBitsSet(Width, EffWidthY);
1890 const APInt EffBitsX = APInt::getLowBitsSet(Width, EffWidthX) << ShftCnt;
1891 // If the mask is extracting all bits from X or Y as is, we can skip
1892 // this AND op.
1893 if (EffBitsY.isSubsetOf(*Mask) && !EffBitsX.intersects(*Mask))
1894 return Y;
1895 if (EffBitsX.isSubsetOf(*Mask) && !EffBitsY.intersects(*Mask))
1896 return XShifted;
1897 }
1898 }
1899
Craig Topper9f008862014-04-15 04:59:12 +00001900 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001901}
1902
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001903Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1904 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1905}
1906
Sanjay Patel472cc782016-01-11 22:14:42 +00001907/// Given operands for an Or, see if we can fold the result.
1908/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001909static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001910 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001911 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1912 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001913
Chris Lattnera71e9d62009-11-10 00:55:12 +00001914 // X | undef -> -1
Sanjay Pateladf6e882018-02-18 18:05:08 +00001915 // X | -1 = -1
1916 // Do not return Op1 because it may contain undef elements if it's a vector.
1917 if (match(Op1, m_Undef()) || match(Op1, m_AllOnes()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001918 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001919
Chris Lattnera71e9d62009-11-10 00:55:12 +00001920 // X | X = X
Duncan Sandsc89ac072010-11-17 18:52:15 +00001921 // X | 0 = X
Sanjay Pateladf6e882018-02-18 18:05:08 +00001922 if (Op0 == Op1 || match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001923 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001924
Chris Lattnera71e9d62009-11-10 00:55:12 +00001925 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001926 if (match(Op0, m_Not(m_Specific(Op1))) ||
1927 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001928 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001929
Chris Lattnera71e9d62009-11-10 00:55:12 +00001930 // (A & ?) | A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001931 if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001932 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001933
Chris Lattnera71e9d62009-11-10 00:55:12 +00001934 // A | (A & ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001935 if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001936 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001937
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001938 // ~(A & ?) | A = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001939 if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001940 return Constant::getAllOnesValue(Op1->getType());
1941
1942 // A | ~(A & ?) = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001943 if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001944 return Constant::getAllOnesValue(Op0->getType());
1945
Craig Topperdad7d8d2017-07-16 06:57:41 +00001946 Value *A, *B;
Sanjay Patel08892252017-04-24 18:24:36 +00001947 // (A & ~B) | (A ^ B) -> (A ^ B)
1948 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001949 // (A & ~B) | (B ^ A) -> (B ^ A)
1950 // (~B & A) | (B ^ A) -> (B ^ A)
1951 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1952 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1953 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001954 return Op1;
1955
1956 // Commute the 'or' operands.
1957 // (A ^ B) | (A & ~B) -> (A ^ B)
1958 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001959 // (B ^ A) | (A & ~B) -> (B ^ A)
1960 // (B ^ A) | (~B & A) -> (B ^ A)
1961 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1962 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1963 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001964 return Op0;
1965
Craig Topper479daaf2017-05-14 07:54:43 +00001966 // (A & B) | (~A ^ B) -> (~A ^ B)
1967 // (B & A) | (~A ^ B) -> (~A ^ B)
1968 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1969 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1970 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1971 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1972 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1973 return Op1;
1974
1975 // (~A ^ B) | (A & B) -> (~A ^ B)
1976 // (~A ^ B) | (B & A) -> (~A ^ B)
1977 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1978 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1979 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1980 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1981 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1982 return Op0;
1983
Sanjay Pateleb731b02017-11-19 15:34:27 +00001984 if (Value *V = simplifyAndOrOfCmps(Op0, Op1, false))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001985 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001986
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001987 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001988 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1989 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001990 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001991
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001992 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001993 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1994 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001995 return V;
1996
Duncan Sandsb0579e92010-11-10 13:00:08 +00001997 // If the operation is with the result of a select instruction, check whether
1998 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001999 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00002000 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00002001 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002002 return V;
2003
Craig Topper50500d52017-05-26 05:16:20 +00002004 // (A & C1)|(B & C2)
Craig Topper1da22c32017-05-26 19:03:53 +00002005 const APInt *C1, *C2;
2006 if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
2007 match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
2008 if (*C1 == ~*C2) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002009 // (A & C1)|(B & C2)
2010 // If we have: ((V + N) & C1) | (V & C2)
2011 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
2012 // replace with V+N.
Craig Topperc8bebb12017-05-26 19:03:59 +00002013 Value *N;
Craig Topper1da22c32017-05-26 19:03:53 +00002014 if (C2->isMask() && // C2 == 0+1+
Craig Topperc8bebb12017-05-26 19:03:59 +00002015 match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002016 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00002017 if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00002018 return A;
2019 }
2020 // Or commutes, try both ways.
Craig Topper1da22c32017-05-26 19:03:53 +00002021 if (C1->isMask() &&
Craig Topperc8bebb12017-05-26 19:03:59 +00002022 match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00002023 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00002024 if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00002025 return B;
2026 }
2027 }
2028 }
2029
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002030 // If the operation is with the result of a phi instruction, check whether
2031 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00002032 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00002033 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00002034 return V;
2035
Craig Topper9f008862014-04-15 04:59:12 +00002036 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00002037}
2038
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002039Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2040 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
2041}
2042
Sanjay Patel472cc782016-01-11 22:14:42 +00002043/// Given operands for a Xor, see if we can fold the result.
2044/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002045static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00002046 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00002047 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
2048 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002049
2050 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00002051 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00002052 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002053
2054 // A ^ 0 = A
2055 if (match(Op1, m_Zero()))
2056 return Op0;
2057
Eli Friedmanad3cfe72011-08-17 19:31:49 +00002058 // A ^ A = 0
2059 if (Op0 == Op1)
2060 return Constant::getNullValue(Op0->getType());
2061
Duncan Sandsc89ac072010-11-17 18:52:15 +00002062 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00002063 if (match(Op0, m_Not(m_Specific(Op1))) ||
2064 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00002065 return Constant::getAllOnesValue(Op0->getType());
2066
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002067 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00002068 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
2069 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002070 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002071
Duncan Sandsb238de02010-11-19 09:20:39 +00002072 // Threading Xor over selects and phi nodes is pointless, so don't bother.
2073 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
2074 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
2075 // only if B and C are equal. If B and C are equal then (since we assume
2076 // that operands have already been simplified) "select(cond, B, C)" should
2077 // have been simplified to the common value of B and C already. Analysing
2078 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
2079 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00002080
Craig Topper9f008862014-04-15 04:59:12 +00002081 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002082}
2083
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002084Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2085 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2086}
2087
2088
Chris Lattner229907c2011-07-18 04:54:35 +00002089static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002090 return CmpInst::makeCmpResultType(Op->getType());
2091}
2092
Sanjay Patel472cc782016-01-11 22:14:42 +00002093/// Rummage around inside V looking for something equivalent to the comparison
2094/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2095/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002096static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2097 Value *LHS, Value *RHS) {
2098 SelectInst *SI = dyn_cast<SelectInst>(V);
2099 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002100 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002101 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2102 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002103 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002104 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2105 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2106 return Cmp;
2107 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2108 LHS == CmpRHS && RHS == CmpLHS)
2109 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002110 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002111}
2112
Dan Gohman9631d902013-02-01 00:49:06 +00002113// A significant optimization not implemented here is assuming that alloca
2114// addresses are not equal to incoming argument values. They don't *alias*,
2115// as we say, but that doesn't mean they aren't equal, so we take a
2116// conservative approach.
2117//
2118// This is inspired in part by C++11 5.10p1:
2119// "Two pointers of the same type compare equal if and only if they are both
2120// null, both point to the same function, or both represent the same
2121// address."
2122//
2123// This is pretty permissive.
2124//
2125// It's also partly due to C11 6.5.9p6:
2126// "Two pointers compare equal if and only if both are null pointers, both are
2127// pointers to the same object (including a pointer to an object and a
2128// subobject at its beginning) or function, both are pointers to one past the
2129// last element of the same array object, or one is a pointer to one past the
2130// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002131// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002132// object in the address space.)
2133//
2134// C11's version is more restrictive, however there's no reason why an argument
2135// couldn't be a one-past-the-end value for a stack object in the caller and be
2136// equal to the beginning of a stack object in the callee.
2137//
2138// If the C and C++ standards are ever made sufficiently restrictive in this
2139// area, it may be possible to update LLVM's semantics accordingly and reinstate
2140// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002141static Constant *
2142computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2143 const DominatorTree *DT, CmpInst::Predicate Pred,
Nuno Lopes404f1062017-09-09 18:23:11 +00002144 AssumptionCache *AC, const Instruction *CxtI,
2145 Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002146 // First, skip past any trivial no-ops.
2147 LHS = LHS->stripPointerCasts();
2148 RHS = RHS->stripPointerCasts();
2149
2150 // A non-null pointer is not equal to a null pointer.
Nuno Lopes404f1062017-09-09 18:23:11 +00002151 if (llvm::isKnownNonZero(LHS, DL) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002152 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2153 return ConstantInt::get(GetCompareTy(LHS),
2154 !CmpInst::isTrueWhenEqual(Pred));
2155
Chandler Carruth8059c842012-03-25 21:28:14 +00002156 // We can only fold certain predicates on pointer comparisons.
2157 switch (Pred) {
2158 default:
Craig Topper9f008862014-04-15 04:59:12 +00002159 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002160
2161 // Equality comaprisons are easy to fold.
2162 case CmpInst::ICMP_EQ:
2163 case CmpInst::ICMP_NE:
2164 break;
2165
2166 // We can only handle unsigned relational comparisons because 'inbounds' on
2167 // a GEP only protects against unsigned wrapping.
2168 case CmpInst::ICMP_UGT:
2169 case CmpInst::ICMP_UGE:
2170 case CmpInst::ICMP_ULT:
2171 case CmpInst::ICMP_ULE:
2172 // However, we have to switch them to their signed variants to handle
2173 // negative indices from the base pointer.
2174 Pred = ICmpInst::getSignedPredicate(Pred);
2175 break;
2176 }
2177
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002178 // Strip off any constant offsets so that we can reason about them.
2179 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2180 // here and compare base addresses like AliasAnalysis does, however there are
2181 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2182 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2183 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002184 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2185 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002186
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002187 // If LHS and RHS are related via constant offsets to the same base
2188 // value, we can replace it with an icmp which just compares the offsets.
2189 if (LHS == RHS)
2190 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002191
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002192 // Various optimizations for (in)equality comparisons.
2193 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2194 // Different non-empty allocations that exist at the same time have
2195 // different addresses (if the program can tell). Global variables always
2196 // exist, so they always exist during the lifetime of each other and all
2197 // allocas. Two different allocas usually have different addresses...
2198 //
2199 // However, if there's an @llvm.stackrestore dynamically in between two
2200 // allocas, they may have the same address. It's tempting to reduce the
2201 // scope of the problem by only looking at *static* allocas here. That would
2202 // cover the majority of allocas while significantly reducing the likelihood
2203 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2204 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2205 // an entry block. Also, if we have a block that's not attached to a
2206 // function, we can't tell if it's "static" under the current definition.
2207 // Theoretically, this problem could be fixed by creating a new kind of
2208 // instruction kind specifically for static allocas. Such a new instruction
2209 // could be required to be at the top of the entry block, thus preventing it
2210 // from being subject to a @llvm.stackrestore. Instcombine could even
2211 // convert regular allocas into these special allocas. It'd be nifty.
2212 // However, until then, this problem remains open.
2213 //
2214 // So, we'll assume that two non-empty allocas have different addresses
2215 // for now.
2216 //
2217 // With all that, if the offsets are within the bounds of their allocations
2218 // (and not one-past-the-end! so we can't use inbounds!), and their
2219 // allocations aren't the same, the pointers are not equal.
2220 //
2221 // Note that it's not necessary to check for LHS being a global variable
2222 // address, due to canonicalization and constant folding.
2223 if (isa<AllocaInst>(LHS) &&
2224 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002225 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2226 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002227 uint64_t LHSSize, RHSSize;
Manoj Gupta77eeac32018-07-09 22:27:23 +00002228 ObjectSizeOpts Opts;
2229 Opts.NullIsUnknownSize =
2230 NullPointerIsDefined(cast<AllocaInst>(LHS)->getFunction());
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002231 if (LHSOffsetCI && RHSOffsetCI &&
Manoj Gupta77eeac32018-07-09 22:27:23 +00002232 getObjectSize(LHS, LHSSize, DL, TLI, Opts) &&
2233 getObjectSize(RHS, RHSSize, DL, TLI, Opts)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002234 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2235 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002236 if (!LHSOffsetValue.isNegative() &&
2237 !RHSOffsetValue.isNegative() &&
2238 LHSOffsetValue.ult(LHSSize) &&
2239 RHSOffsetValue.ult(RHSSize)) {
2240 return ConstantInt::get(GetCompareTy(LHS),
2241 !CmpInst::isTrueWhenEqual(Pred));
2242 }
2243 }
2244
2245 // Repeat the above check but this time without depending on DataLayout
2246 // or being able to compute a precise size.
2247 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2248 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2249 LHSOffset->isNullValue() &&
2250 RHSOffset->isNullValue())
2251 return ConstantInt::get(GetCompareTy(LHS),
2252 !CmpInst::isTrueWhenEqual(Pred));
2253 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002254
2255 // Even if an non-inbounds GEP occurs along the path we can still optimize
2256 // equality comparisons concerning the result. We avoid walking the whole
2257 // chain again by starting where the last calls to
2258 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002259 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2260 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002261 if (LHS == RHS)
2262 return ConstantExpr::getICmp(Pred,
2263 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2264 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002265
2266 // If one side of the equality comparison must come from a noalias call
2267 // (meaning a system memory allocation function), and the other side must
2268 // come from a pointer that cannot overlap with dynamically-allocated
2269 // memory within the lifetime of the current function (allocas, byval
2270 // arguments, globals), then determine the comparison result here.
2271 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2272 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2273 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2274
2275 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002276 auto IsNAC = [](ArrayRef<Value *> Objects) {
2277 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002278 };
2279
2280 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002281 // noalias calls. For allocas, we consider only static ones (dynamic
2282 // allocas might be transformed into calls to malloc not simultaneously
2283 // live with the compared-to allocation). For globals, we exclude symbols
2284 // that might be resolve lazily to symbols in another dynamically-loaded
2285 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002286 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2287 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002288 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2289 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2290 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2291 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002292 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002293 !GV->isThreadLocal();
2294 if (const Argument *A = dyn_cast<Argument>(V))
2295 return A->hasByValAttr();
2296 return false;
2297 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002298 };
2299
2300 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2301 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2302 return ConstantInt::get(GetCompareTy(LHS),
2303 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002304
2305 // Fold comparisons for non-escaping pointer even if the allocation call
2306 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2307 // dynamic allocation call could be either of the operands.
2308 Value *MI = nullptr;
Nuno Lopes404f1062017-09-09 18:23:11 +00002309 if (isAllocLikeFn(LHS, TLI) &&
2310 llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002311 MI = LHS;
Nuno Lopes404f1062017-09-09 18:23:11 +00002312 else if (isAllocLikeFn(RHS, TLI) &&
2313 llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002314 MI = RHS;
2315 // FIXME: We should also fold the compare when the pointer escapes, but the
2316 // compare dominates the pointer escape
2317 if (MI && !PointerMayBeCaptured(MI, true, true))
2318 return ConstantInt::get(GetCompareTy(LHS),
2319 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002320 }
2321
2322 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002323 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002324}
Chris Lattner01990f02012-02-24 19:01:58 +00002325
Sanjay Pateldc65a272016-12-03 17:30:22 +00002326/// Fold an icmp when its operands have i1 scalar type.
2327static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002328 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002329 Type *ITy = GetCompareTy(LHS); // The return type.
2330 Type *OpTy = LHS->getType(); // The operand type.
Craig Topperfde47232017-07-09 07:04:03 +00002331 if (!OpTy->isIntOrIntVectorTy(1))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002332 return nullptr;
2333
Sanjay Patele2787b92017-05-17 20:27:55 +00002334 // A boolean compared to true/false can be simplified in 14 out of the 20
2335 // (10 predicates * 2 constants) possible combinations. Cases not handled here
2336 // require a 'not' of the LHS, so those must be transformed in InstCombine.
2337 if (match(RHS, m_Zero())) {
2338 switch (Pred) {
2339 case CmpInst::ICMP_NE: // X != 0 -> X
2340 case CmpInst::ICMP_UGT: // X >u 0 -> X
2341 case CmpInst::ICMP_SLT: // X <s 0 -> X
2342 return LHS;
2343
2344 case CmpInst::ICMP_ULT: // X <u 0 -> false
2345 case CmpInst::ICMP_SGT: // X >s 0 -> false
2346 return getFalse(ITy);
2347
2348 case CmpInst::ICMP_UGE: // X >=u 0 -> true
2349 case CmpInst::ICMP_SLE: // X <=s 0 -> true
2350 return getTrue(ITy);
2351
2352 default: break;
2353 }
2354 } else if (match(RHS, m_One())) {
2355 switch (Pred) {
2356 case CmpInst::ICMP_EQ: // X == 1 -> X
2357 case CmpInst::ICMP_UGE: // X >=u 1 -> X
2358 case CmpInst::ICMP_SLE: // X <=s -1 -> X
2359 return LHS;
2360
2361 case CmpInst::ICMP_UGT: // X >u 1 -> false
2362 case CmpInst::ICMP_SLT: // X <s -1 -> false
2363 return getFalse(ITy);
2364
2365 case CmpInst::ICMP_ULE: // X <=u 1 -> true
2366 case CmpInst::ICMP_SGE: // X >=s -1 -> true
2367 return getTrue(ITy);
2368
2369 default: break;
2370 }
2371 }
2372
Sanjay Pateldc65a272016-12-03 17:30:22 +00002373 switch (Pred) {
2374 default:
2375 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002376 case ICmpInst::ICMP_UGE:
Sanjay Pateldc65a272016-12-03 17:30:22 +00002377 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2378 return getTrue(ITy);
2379 break;
2380 case ICmpInst::ICMP_SGE:
2381 /// For signed comparison, the values for an i1 are 0 and -1
2382 /// respectively. This maps into a truth table of:
2383 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2384 /// 0 | 0 | 1 (0 >= 0) | 1
2385 /// 0 | 1 | 1 (0 >= -1) | 1
2386 /// 1 | 0 | 0 (-1 >= 0) | 0
2387 /// 1 | 1 | 1 (-1 >= -1) | 1
2388 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2389 return getTrue(ITy);
2390 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002391 case ICmpInst::ICMP_ULE:
2392 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2393 return getTrue(ITy);
2394 break;
2395 }
2396
2397 return nullptr;
2398}
2399
2400/// Try hard to fold icmp with zero RHS because this is a common case.
2401static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002402 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002403 if (!match(RHS, m_Zero()))
2404 return nullptr;
2405
2406 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002407 switch (Pred) {
2408 default:
2409 llvm_unreachable("Unknown ICmp predicate!");
2410 case ICmpInst::ICMP_ULT:
2411 return getFalse(ITy);
2412 case ICmpInst::ICMP_UGE:
2413 return getTrue(ITy);
2414 case ICmpInst::ICMP_EQ:
2415 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002416 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002417 return getFalse(ITy);
2418 break;
2419 case ICmpInst::ICMP_NE:
2420 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002421 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002422 return getTrue(ITy);
2423 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002424 case ICmpInst::ICMP_SLT: {
2425 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2426 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002427 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002428 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002429 return getFalse(ITy);
2430 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002431 }
2432 case ICmpInst::ICMP_SLE: {
2433 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2434 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002435 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002436 if (LHSKnown.isNonNegative() &&
2437 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002438 return getFalse(ITy);
2439 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002440 }
2441 case ICmpInst::ICMP_SGE: {
2442 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2443 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002444 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002445 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002446 return getTrue(ITy);
2447 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002448 }
2449 case ICmpInst::ICMP_SGT: {
2450 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2451 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002452 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002453 if (LHSKnown.isNonNegative() &&
2454 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002455 return getTrue(ITy);
2456 break;
2457 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002458 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002459
2460 return nullptr;
2461}
2462
Sanjay Patelbe332132017-01-23 18:22:26 +00002463/// Many binary operators with a constant operand have an easy-to-compute
2464/// range of outputs. This can be used to fold a comparison to always true or
2465/// always false.
2466static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2467 unsigned Width = Lower.getBitWidth();
2468 const APInt *C;
2469 switch (BO.getOpcode()) {
2470 case Instruction::Add:
Craig Topper73ba1c82017-06-07 07:40:37 +00002471 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patel56227252017-01-24 17:03:24 +00002472 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2473 if (BO.hasNoUnsignedWrap()) {
2474 // 'add nuw x, C' produces [C, UINT_MAX].
2475 Lower = *C;
2476 } else if (BO.hasNoSignedWrap()) {
2477 if (C->isNegative()) {
2478 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2479 Lower = APInt::getSignedMinValue(Width);
2480 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2481 } else {
2482 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2483 Lower = APInt::getSignedMinValue(Width) + *C;
2484 Upper = APInt::getSignedMaxValue(Width) + 1;
2485 }
2486 }
2487 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002488 break;
2489
2490 case Instruction::And:
2491 if (match(BO.getOperand(1), m_APInt(C)))
2492 // 'and x, C' produces [0, C].
2493 Upper = *C + 1;
2494 break;
2495
2496 case Instruction::Or:
2497 if (match(BO.getOperand(1), m_APInt(C)))
2498 // 'or x, C' produces [C, UINT_MAX].
2499 Lower = *C;
2500 break;
2501
2502 case Instruction::AShr:
2503 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2504 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2505 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2506 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2507 } else if (match(BO.getOperand(0), m_APInt(C))) {
2508 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002509 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002510 ShiftAmount = C->countTrailingZeros();
2511 if (C->isNegative()) {
2512 // 'ashr C, x' produces [C, C >> (Width-1)]
2513 Lower = *C;
2514 Upper = C->ashr(ShiftAmount) + 1;
2515 } else {
2516 // 'ashr C, x' produces [C >> (Width-1), C]
2517 Lower = C->ashr(ShiftAmount);
2518 Upper = *C + 1;
2519 }
2520 }
2521 break;
2522
2523 case Instruction::LShr:
2524 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2525 // 'lshr x, C' produces [0, UINT_MAX >> C].
2526 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2527 } else if (match(BO.getOperand(0), m_APInt(C))) {
2528 // 'lshr C, x' produces [C >> (Width-1), C].
2529 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002530 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002531 ShiftAmount = C->countTrailingZeros();
2532 Lower = C->lshr(ShiftAmount);
2533 Upper = *C + 1;
2534 }
2535 break;
2536
2537 case Instruction::Shl:
2538 if (match(BO.getOperand(0), m_APInt(C))) {
2539 if (BO.hasNoUnsignedWrap()) {
2540 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2541 Lower = *C;
2542 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2543 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2544 if (C->isNegative()) {
2545 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2546 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2547 Lower = C->shl(ShiftAmount);
2548 Upper = *C + 1;
2549 } else {
2550 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2551 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2552 Lower = *C;
2553 Upper = C->shl(ShiftAmount) + 1;
2554 }
2555 }
2556 }
2557 break;
2558
2559 case Instruction::SDiv:
2560 if (match(BO.getOperand(1), m_APInt(C))) {
2561 APInt IntMin = APInt::getSignedMinValue(Width);
2562 APInt IntMax = APInt::getSignedMaxValue(Width);
2563 if (C->isAllOnesValue()) {
2564 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2565 // where C != -1 and C != 0 and C != 1
2566 Lower = IntMin + 1;
2567 Upper = IntMax + 1;
2568 } else if (C->countLeadingZeros() < Width - 1) {
2569 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2570 // where C != -1 and C != 0 and C != 1
2571 Lower = IntMin.sdiv(*C);
2572 Upper = IntMax.sdiv(*C);
2573 if (Lower.sgt(Upper))
2574 std::swap(Lower, Upper);
2575 Upper = Upper + 1;
2576 assert(Upper != Lower && "Upper part of range has wrapped!");
2577 }
2578 } else if (match(BO.getOperand(0), m_APInt(C))) {
2579 if (C->isMinSignedValue()) {
2580 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2581 Lower = *C;
2582 Upper = Lower.lshr(1) + 1;
2583 } else {
2584 // 'sdiv C, x' produces [-|C|, |C|].
2585 Upper = C->abs() + 1;
2586 Lower = (-Upper) + 1;
2587 }
2588 }
2589 break;
2590
2591 case Instruction::UDiv:
Craig Topper73ba1c82017-06-07 07:40:37 +00002592 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002593 // 'udiv x, C' produces [0, UINT_MAX / C].
2594 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2595 } else if (match(BO.getOperand(0), m_APInt(C))) {
2596 // 'udiv C, x' produces [0, C].
2597 Upper = *C + 1;
2598 }
2599 break;
2600
2601 case Instruction::SRem:
2602 if (match(BO.getOperand(1), m_APInt(C))) {
2603 // 'srem x, C' produces (-|C|, |C|).
2604 Upper = C->abs();
2605 Lower = (-Upper) + 1;
2606 }
2607 break;
2608
2609 case Instruction::URem:
2610 if (match(BO.getOperand(1), m_APInt(C)))
2611 // 'urem x, C' produces [0, C).
2612 Upper = *C;
2613 break;
2614
2615 default:
2616 break;
2617 }
2618}
2619
Sanjay Patel67bde282016-08-22 23:12:02 +00002620static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2621 Value *RHS) {
Roman Lebedev0c43d722018-03-15 16:17:40 +00002622 Type *ITy = GetCompareTy(RHS); // The return type.
2623
Roman Lebedev6aca3352018-03-15 16:17:46 +00002624 Value *X;
2625 // Sign-bit checks can be optimized to true/false after unsigned
2626 // floating-point casts:
2627 // icmp slt (bitcast (uitofp X)), 0 --> false
2628 // icmp sgt (bitcast (uitofp X)), -1 --> true
2629 if (match(LHS, m_BitCast(m_UIToFP(m_Value(X))))) {
2630 if (Pred == ICmpInst::ICMP_SLT && match(RHS, m_Zero()))
2631 return ConstantInt::getFalse(ITy);
2632 if (Pred == ICmpInst::ICMP_SGT && match(RHS, m_AllOnes()))
2633 return ConstantInt::getTrue(ITy);
2634 }
2635
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002636 const APInt *C;
2637 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002638 return nullptr;
2639
2640 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002641 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002642 if (RHS_CR.isEmptySet())
Roman Lebedev0c43d722018-03-15 16:17:40 +00002643 return ConstantInt::getFalse(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002644 if (RHS_CR.isFullSet())
Roman Lebedev0c43d722018-03-15 16:17:40 +00002645 return ConstantInt::getTrue(ITy);
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002646
Sanjay Patelbe332132017-01-23 18:22:26 +00002647 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002648 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002649 APInt Lower = APInt(Width, 0);
2650 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002651 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2652 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002653
2654 ConstantRange LHS_CR =
2655 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2656
2657 if (auto *I = dyn_cast<Instruction>(LHS))
2658 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2659 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2660
2661 if (!LHS_CR.isFullSet()) {
2662 if (RHS_CR.contains(LHS_CR))
Roman Lebedev0c43d722018-03-15 16:17:40 +00002663 return ConstantInt::getTrue(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002664 if (RHS_CR.inverse().contains(LHS_CR))
Roman Lebedev0c43d722018-03-15 16:17:40 +00002665 return ConstantInt::getFalse(ITy);
Sanjay Patel67bde282016-08-22 23:12:02 +00002666 }
2667
2668 return nullptr;
2669}
2670
Sanjay Patel2df38a82017-05-08 16:21:55 +00002671/// TODO: A large part of this logic is duplicated in InstCombine's
2672/// foldICmpBinOp(). We should be able to share that and avoid the code
2673/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002674static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002675 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002676 unsigned MaxRecurse) {
2677 Type *ITy = GetCompareTy(LHS); // The return type.
2678
2679 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2680 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2681 if (MaxRecurse && (LBO || RBO)) {
2682 // Analyze the case when either LHS or RHS is an add instruction.
2683 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2684 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2685 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2686 if (LBO && LBO->getOpcode() == Instruction::Add) {
2687 A = LBO->getOperand(0);
2688 B = LBO->getOperand(1);
2689 NoLHSWrapProblem =
2690 ICmpInst::isEquality(Pred) ||
2691 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2692 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2693 }
2694 if (RBO && RBO->getOpcode() == Instruction::Add) {
2695 C = RBO->getOperand(0);
2696 D = RBO->getOperand(1);
2697 NoRHSWrapProblem =
2698 ICmpInst::isEquality(Pred) ||
2699 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2700 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2701 }
2702
2703 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2704 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2705 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2706 Constant::getNullValue(RHS->getType()), Q,
2707 MaxRecurse - 1))
2708 return V;
2709
2710 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2711 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2712 if (Value *V =
2713 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2714 C == LHS ? D : C, Q, MaxRecurse - 1))
2715 return V;
2716
2717 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2718 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2719 NoRHSWrapProblem) {
2720 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2721 Value *Y, *Z;
2722 if (A == C) {
2723 // C + B == C + D -> B == D
2724 Y = B;
2725 Z = D;
2726 } else if (A == D) {
2727 // D + B == C + D -> B == C
2728 Y = B;
2729 Z = C;
2730 } else if (B == C) {
2731 // A + C == C + D -> A == D
2732 Y = A;
2733 Z = D;
2734 } else {
2735 assert(B == D);
2736 // A + D == C + D -> A == C
2737 Y = A;
2738 Z = C;
2739 }
2740 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2741 return V;
2742 }
2743 }
2744
2745 {
2746 Value *Y = nullptr;
2747 // icmp pred (or X, Y), X
2748 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2749 if (Pred == ICmpInst::ICMP_ULT)
2750 return getFalse(ITy);
2751 if (Pred == ICmpInst::ICMP_UGE)
2752 return getTrue(ITy);
2753
2754 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002755 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2756 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2757 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002758 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002759 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002760 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2761 }
2762 }
2763 // icmp pred X, (or X, Y)
2764 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2765 if (Pred == ICmpInst::ICMP_ULE)
2766 return getTrue(ITy);
2767 if (Pred == ICmpInst::ICMP_UGT)
2768 return getFalse(ITy);
2769
2770 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002771 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2772 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2773 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002774 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002775 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002776 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2777 }
2778 }
2779 }
2780
2781 // icmp pred (and X, Y), X
Craig Topper72ee6942017-06-24 06:24:01 +00002782 if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002783 if (Pred == ICmpInst::ICMP_UGT)
2784 return getFalse(ITy);
2785 if (Pred == ICmpInst::ICMP_ULE)
2786 return getTrue(ITy);
2787 }
2788 // icmp pred X, (and X, Y)
Craig Topper72ee6942017-06-24 06:24:01 +00002789 if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002790 if (Pred == ICmpInst::ICMP_UGE)
2791 return getTrue(ITy);
2792 if (Pred == ICmpInst::ICMP_ULT)
2793 return getFalse(ITy);
2794 }
2795
2796 // 0 - (zext X) pred C
2797 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2798 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2799 if (RHSC->getValue().isStrictlyPositive()) {
2800 if (Pred == ICmpInst::ICMP_SLT)
2801 return ConstantInt::getTrue(RHSC->getContext());
2802 if (Pred == ICmpInst::ICMP_SGE)
2803 return ConstantInt::getFalse(RHSC->getContext());
2804 if (Pred == ICmpInst::ICMP_EQ)
2805 return ConstantInt::getFalse(RHSC->getContext());
2806 if (Pred == ICmpInst::ICMP_NE)
2807 return ConstantInt::getTrue(RHSC->getContext());
2808 }
2809 if (RHSC->getValue().isNonNegative()) {
2810 if (Pred == ICmpInst::ICMP_SLE)
2811 return ConstantInt::getTrue(RHSC->getContext());
2812 if (Pred == ICmpInst::ICMP_SGT)
2813 return ConstantInt::getFalse(RHSC->getContext());
2814 }
2815 }
2816 }
2817
2818 // icmp pred (urem X, Y), Y
2819 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002820 switch (Pred) {
2821 default:
2822 break;
2823 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002824 case ICmpInst::ICMP_SGE: {
2825 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2826 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002827 break;
2828 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002829 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002830 case ICmpInst::ICMP_EQ:
2831 case ICmpInst::ICMP_UGT:
2832 case ICmpInst::ICMP_UGE:
2833 return getFalse(ITy);
2834 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002835 case ICmpInst::ICMP_SLE: {
2836 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2837 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002838 break;
2839 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002840 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002841 case ICmpInst::ICMP_NE:
2842 case ICmpInst::ICMP_ULT:
2843 case ICmpInst::ICMP_ULE:
2844 return getTrue(ITy);
2845 }
2846 }
2847
2848 // icmp pred X, (urem Y, X)
2849 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002850 switch (Pred) {
2851 default:
2852 break;
2853 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002854 case ICmpInst::ICMP_SGE: {
2855 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2856 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002857 break;
2858 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002859 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002860 case ICmpInst::ICMP_NE:
2861 case ICmpInst::ICMP_UGT:
2862 case ICmpInst::ICMP_UGE:
2863 return getTrue(ITy);
2864 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002865 case ICmpInst::ICMP_SLE: {
2866 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2867 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002868 break;
2869 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002870 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002871 case ICmpInst::ICMP_EQ:
2872 case ICmpInst::ICMP_ULT:
2873 case ICmpInst::ICMP_ULE:
2874 return getFalse(ITy);
2875 }
2876 }
2877
2878 // x >> y <=u x
2879 // x udiv y <=u x.
2880 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2881 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2882 // icmp pred (X op Y), X
2883 if (Pred == ICmpInst::ICMP_UGT)
2884 return getFalse(ITy);
2885 if (Pred == ICmpInst::ICMP_ULE)
2886 return getTrue(ITy);
2887 }
2888
2889 // x >=u x >> y
2890 // x >=u x udiv y.
2891 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2892 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2893 // icmp pred X, (X op Y)
2894 if (Pred == ICmpInst::ICMP_ULT)
2895 return getFalse(ITy);
2896 if (Pred == ICmpInst::ICMP_UGE)
2897 return getTrue(ITy);
2898 }
2899
2900 // handle:
2901 // CI2 << X == CI
2902 // CI2 << X != CI
2903 //
2904 // where CI2 is a power of 2 and CI isn't
2905 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2906 const APInt *CI2Val, *CIVal = &CI->getValue();
2907 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2908 CI2Val->isPowerOf2()) {
2909 if (!CIVal->isPowerOf2()) {
2910 // CI2 << X can equal zero in some circumstances,
2911 // this simplification is unsafe if CI is zero.
2912 //
2913 // We know it is safe if:
2914 // - The shift is nsw, we can't shift out the one bit.
2915 // - The shift is nuw, we can't shift out the one bit.
2916 // - CI2 is one
2917 // - CI isn't zero
2918 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
Craig Topper73ba1c82017-06-07 07:40:37 +00002919 CI2Val->isOneValue() || !CI->isZero()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002920 if (Pred == ICmpInst::ICMP_EQ)
2921 return ConstantInt::getFalse(RHS->getContext());
2922 if (Pred == ICmpInst::ICMP_NE)
2923 return ConstantInt::getTrue(RHS->getContext());
2924 }
2925 }
Craig Topper73ba1c82017-06-07 07:40:37 +00002926 if (CIVal->isSignMask() && CI2Val->isOneValue()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002927 if (Pred == ICmpInst::ICMP_UGT)
2928 return ConstantInt::getFalse(RHS->getContext());
2929 if (Pred == ICmpInst::ICMP_ULE)
2930 return ConstantInt::getTrue(RHS->getContext());
2931 }
2932 }
2933 }
2934
2935 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2936 LBO->getOperand(1) == RBO->getOperand(1)) {
2937 switch (LBO->getOpcode()) {
2938 default:
2939 break;
2940 case Instruction::UDiv:
2941 case Instruction::LShr:
Sanjay Patela23b1412017-05-15 19:16:49 +00002942 if (ICmpInst::isSigned(Pred) || !LBO->isExact() || !RBO->isExact())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002943 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00002944 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2945 RBO->getOperand(0), Q, MaxRecurse - 1))
2946 return V;
2947 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002948 case Instruction::SDiv:
Sanjay Patela23b1412017-05-15 19:16:49 +00002949 if (!ICmpInst::isEquality(Pred) || !LBO->isExact() || !RBO->isExact())
2950 break;
2951 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2952 RBO->getOperand(0), Q, MaxRecurse - 1))
2953 return V;
2954 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002955 case Instruction::AShr:
2956 if (!LBO->isExact() || !RBO->isExact())
2957 break;
2958 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2959 RBO->getOperand(0), Q, MaxRecurse - 1))
2960 return V;
2961 break;
2962 case Instruction::Shl: {
2963 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2964 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2965 if (!NUW && !NSW)
2966 break;
2967 if (!NSW && ICmpInst::isSigned(Pred))
2968 break;
2969 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2970 RBO->getOperand(0), Q, MaxRecurse - 1))
2971 return V;
2972 break;
2973 }
2974 }
2975 }
2976 return nullptr;
2977}
2978
Sanjay Patel35289c62016-12-10 17:40:47 +00002979/// Simplify integer comparisons where at least one operand of the compare
2980/// matches an integer min/max idiom.
2981static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002982 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00002983 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002984 Type *ITy = GetCompareTy(LHS); // The return type.
2985 Value *A, *B;
2986 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2987 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2988
2989 // Signed variants on "max(a,b)>=a -> true".
2990 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2991 if (A != RHS)
2992 std::swap(A, B); // smax(A, B) pred A.
2993 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2994 // We analyze this as smax(A, B) pred A.
2995 P = Pred;
2996 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2997 (A == LHS || B == LHS)) {
2998 if (A != LHS)
2999 std::swap(A, B); // A pred smax(A, B).
3000 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3001 // We analyze this as smax(A, B) swapped-pred A.
3002 P = CmpInst::getSwappedPredicate(Pred);
3003 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3004 (A == RHS || B == RHS)) {
3005 if (A != RHS)
3006 std::swap(A, B); // smin(A, B) pred A.
3007 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3008 // We analyze this as smax(-A, -B) swapped-pred -A.
3009 // Note that we do not need to actually form -A or -B thanks to EqP.
3010 P = CmpInst::getSwappedPredicate(Pred);
3011 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
3012 (A == LHS || B == LHS)) {
3013 if (A != LHS)
3014 std::swap(A, B); // A pred smin(A, B).
3015 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3016 // We analyze this as smax(-A, -B) pred -A.
3017 // Note that we do not need to actually form -A or -B thanks to EqP.
3018 P = Pred;
3019 }
3020 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3021 // Cases correspond to "max(A, B) p A".
3022 switch (P) {
3023 default:
3024 break;
3025 case CmpInst::ICMP_EQ:
3026 case CmpInst::ICMP_SLE:
3027 // Equivalent to "A EqP B". This may be the same as the condition tested
3028 // in the max/min; if so, we can just return that.
3029 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3030 return V;
3031 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3032 return V;
3033 // Otherwise, see if "A EqP B" simplifies.
3034 if (MaxRecurse)
3035 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3036 return V;
3037 break;
3038 case CmpInst::ICMP_NE:
3039 case CmpInst::ICMP_SGT: {
3040 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3041 // Equivalent to "A InvEqP B". This may be the same as the condition
3042 // tested in the max/min; if so, we can just return that.
3043 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3044 return V;
3045 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3046 return V;
3047 // Otherwise, see if "A InvEqP B" simplifies.
3048 if (MaxRecurse)
3049 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3050 return V;
3051 break;
3052 }
3053 case CmpInst::ICMP_SGE:
3054 // Always true.
3055 return getTrue(ITy);
3056 case CmpInst::ICMP_SLT:
3057 // Always false.
3058 return getFalse(ITy);
3059 }
3060 }
3061
3062 // Unsigned variants on "max(a,b)>=a -> true".
3063 P = CmpInst::BAD_ICMP_PREDICATE;
3064 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3065 if (A != RHS)
3066 std::swap(A, B); // umax(A, B) pred A.
3067 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3068 // We analyze this as umax(A, B) pred A.
3069 P = Pred;
3070 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
3071 (A == LHS || B == LHS)) {
3072 if (A != LHS)
3073 std::swap(A, B); // A pred umax(A, B).
3074 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3075 // We analyze this as umax(A, B) swapped-pred A.
3076 P = CmpInst::getSwappedPredicate(Pred);
3077 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3078 (A == RHS || B == RHS)) {
3079 if (A != RHS)
3080 std::swap(A, B); // umin(A, B) pred A.
3081 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3082 // We analyze this as umax(-A, -B) swapped-pred -A.
3083 // Note that we do not need to actually form -A or -B thanks to EqP.
3084 P = CmpInst::getSwappedPredicate(Pred);
3085 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
3086 (A == LHS || B == LHS)) {
3087 if (A != LHS)
3088 std::swap(A, B); // A pred umin(A, B).
3089 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3090 // We analyze this as umax(-A, -B) pred -A.
3091 // Note that we do not need to actually form -A or -B thanks to EqP.
3092 P = Pred;
3093 }
3094 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3095 // Cases correspond to "max(A, B) p A".
3096 switch (P) {
3097 default:
3098 break;
3099 case CmpInst::ICMP_EQ:
3100 case CmpInst::ICMP_ULE:
3101 // Equivalent to "A EqP B". This may be the same as the condition tested
3102 // in the max/min; if so, we can just return that.
3103 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3104 return V;
3105 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3106 return V;
3107 // Otherwise, see if "A EqP B" simplifies.
3108 if (MaxRecurse)
3109 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3110 return V;
3111 break;
3112 case CmpInst::ICMP_NE:
3113 case CmpInst::ICMP_UGT: {
3114 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3115 // Equivalent to "A InvEqP B". This may be the same as the condition
3116 // tested in the max/min; if so, we can just return that.
3117 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3118 return V;
3119 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3120 return V;
3121 // Otherwise, see if "A InvEqP B" simplifies.
3122 if (MaxRecurse)
3123 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3124 return V;
3125 break;
3126 }
3127 case CmpInst::ICMP_UGE:
3128 // Always true.
3129 return getTrue(ITy);
3130 case CmpInst::ICMP_ULT:
3131 // Always false.
3132 return getFalse(ITy);
3133 }
3134 }
3135
3136 // Variants on "max(x,y) >= min(x,z)".
3137 Value *C, *D;
3138 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3139 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3140 (A == C || A == D || B == C || B == D)) {
3141 // max(x, ?) pred min(x, ?).
3142 if (Pred == CmpInst::ICMP_SGE)
3143 // Always true.
3144 return getTrue(ITy);
3145 if (Pred == CmpInst::ICMP_SLT)
3146 // Always false.
3147 return getFalse(ITy);
3148 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3149 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3150 (A == C || A == D || B == C || B == D)) {
3151 // min(x, ?) pred max(x, ?).
3152 if (Pred == CmpInst::ICMP_SLE)
3153 // Always true.
3154 return getTrue(ITy);
3155 if (Pred == CmpInst::ICMP_SGT)
3156 // Always false.
3157 return getFalse(ITy);
3158 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3159 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3160 (A == C || A == D || B == C || B == D)) {
3161 // max(x, ?) pred min(x, ?).
3162 if (Pred == CmpInst::ICMP_UGE)
3163 // Always true.
3164 return getTrue(ITy);
3165 if (Pred == CmpInst::ICMP_ULT)
3166 // Always false.
3167 return getFalse(ITy);
3168 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3169 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3170 (A == C || A == D || B == C || B == D)) {
3171 // min(x, ?) pred max(x, ?).
3172 if (Pred == CmpInst::ICMP_ULE)
3173 // Always true.
3174 return getTrue(ITy);
3175 if (Pred == CmpInst::ICMP_UGT)
3176 // Always false.
3177 return getFalse(ITy);
3178 }
3179
3180 return nullptr;
3181}
3182
Sanjay Patel472cc782016-01-11 22:14:42 +00003183/// Given operands for an ICmpInst, see if we can fold the result.
3184/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003185static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003186 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003187 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003188 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003189
Chris Lattnera71e9d62009-11-10 00:55:12 +00003190 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003191 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003192 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003193
3194 // If we have a constant, make sure it is on the RHS.
3195 std::swap(LHS, RHS);
3196 Pred = CmpInst::getSwappedPredicate(Pred);
3197 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003198
Chris Lattner229907c2011-07-18 04:54:35 +00003199 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003200
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003201 // icmp X, X -> true/false
Sanjay Patel30be6652018-04-22 17:07:44 +00003202 // icmp X, undef -> true/false because undef could be X.
Duncan Sands772749a2011-01-01 20:08:02 +00003203 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003204 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003205
Sanjay Pateldc65a272016-12-03 17:30:22 +00003206 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3207 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003208
Sanjay Pateldc65a272016-12-03 17:30:22 +00003209 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3210 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003211
Sanjay Patel67bde282016-08-22 23:12:02 +00003212 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3213 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003214
Chen Li7452d952015-09-26 03:26:47 +00003215 // If both operands have range metadata, use the metadata
3216 // to simplify the comparison.
3217 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003218 auto RHS_Instr = cast<Instruction>(RHS);
3219 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003220
3221 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3222 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003223 auto RHS_CR = getConstantRangeFromMetadata(
3224 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3225 auto LHS_CR = getConstantRangeFromMetadata(
3226 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003227
3228 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3229 if (Satisfied_CR.contains(LHS_CR))
3230 return ConstantInt::getTrue(RHS->getContext());
3231
3232 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3233 CmpInst::getInversePredicate(Pred), RHS_CR);
3234 if (InversedSatisfied_CR.contains(LHS_CR))
3235 return ConstantInt::getFalse(RHS->getContext());
3236 }
3237 }
3238
Duncan Sands8fb2c382011-01-20 13:21:55 +00003239 // Compare of cast, for example (zext X) != 0 -> X != 0
3240 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3241 Instruction *LI = cast<CastInst>(LHS);
3242 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003243 Type *SrcTy = SrcOp->getType();
3244 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003245
3246 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3247 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003248 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3249 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003250 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3251 // Transfer the cast to the constant.
3252 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3253 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003254 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003255 return V;
3256 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3257 if (RI->getOperand(0)->getType() == SrcTy)
3258 // Compare without the cast.
3259 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003260 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003261 return V;
3262 }
3263 }
3264
3265 if (isa<ZExtInst>(LHS)) {
3266 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3267 // same type.
3268 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3269 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3270 // Compare X and Y. Note that signed predicates become unsigned.
3271 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003272 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003273 MaxRecurse-1))
3274 return V;
3275 }
3276 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3277 // too. If not, then try to deduce the result of the comparison.
3278 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3279 // Compute the constant that would happen if we truncated to SrcTy then
3280 // reextended to DstTy.
3281 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3282 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3283
3284 // If the re-extended constant didn't change then this is effectively
3285 // also a case of comparing two zero-extended values.
3286 if (RExt == CI && MaxRecurse)
3287 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003288 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003289 return V;
3290
3291 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3292 // there. Use this to work out the result of the comparison.
3293 if (RExt != CI) {
3294 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003295 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003296 // LHS <u RHS.
3297 case ICmpInst::ICMP_EQ:
3298 case ICmpInst::ICMP_UGT:
3299 case ICmpInst::ICMP_UGE:
3300 return ConstantInt::getFalse(CI->getContext());
3301
3302 case ICmpInst::ICMP_NE:
3303 case ICmpInst::ICMP_ULT:
3304 case ICmpInst::ICMP_ULE:
3305 return ConstantInt::getTrue(CI->getContext());
3306
3307 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3308 // is non-negative then LHS <s RHS.
3309 case ICmpInst::ICMP_SGT:
3310 case ICmpInst::ICMP_SGE:
3311 return CI->getValue().isNegative() ?
3312 ConstantInt::getTrue(CI->getContext()) :
3313 ConstantInt::getFalse(CI->getContext());
3314
3315 case ICmpInst::ICMP_SLT:
3316 case ICmpInst::ICMP_SLE:
3317 return CI->getValue().isNegative() ?
3318 ConstantInt::getFalse(CI->getContext()) :
3319 ConstantInt::getTrue(CI->getContext());
3320 }
3321 }
3322 }
3323 }
3324
3325 if (isa<SExtInst>(LHS)) {
3326 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3327 // same type.
3328 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3329 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3330 // Compare X and Y. Note that the predicate does not change.
3331 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003332 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003333 return V;
3334 }
3335 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3336 // too. If not, then try to deduce the result of the comparison.
3337 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3338 // Compute the constant that would happen if we truncated to SrcTy then
3339 // reextended to DstTy.
3340 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3341 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3342
3343 // If the re-extended constant didn't change then this is effectively
3344 // also a case of comparing two sign-extended values.
3345 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003346 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003347 return V;
3348
3349 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3350 // bits there. Use this to work out the result of the comparison.
3351 if (RExt != CI) {
3352 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003353 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003354 case ICmpInst::ICMP_EQ:
3355 return ConstantInt::getFalse(CI->getContext());
3356 case ICmpInst::ICMP_NE:
3357 return ConstantInt::getTrue(CI->getContext());
3358
3359 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3360 // LHS >s RHS.
3361 case ICmpInst::ICMP_SGT:
3362 case ICmpInst::ICMP_SGE:
3363 return CI->getValue().isNegative() ?
3364 ConstantInt::getTrue(CI->getContext()) :
3365 ConstantInt::getFalse(CI->getContext());
3366 case ICmpInst::ICMP_SLT:
3367 case ICmpInst::ICMP_SLE:
3368 return CI->getValue().isNegative() ?
3369 ConstantInt::getFalse(CI->getContext()) :
3370 ConstantInt::getTrue(CI->getContext());
3371
3372 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3373 // LHS >u RHS.
3374 case ICmpInst::ICMP_UGT:
3375 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003376 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003377 if (MaxRecurse)
3378 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3379 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003380 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003381 return V;
3382 break;
3383 case ICmpInst::ICMP_ULT:
3384 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003385 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003386 if (MaxRecurse)
3387 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3388 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003389 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003390 return V;
3391 break;
3392 }
3393 }
3394 }
3395 }
3396 }
3397
James Molloy1d88d6f2015-10-22 13:18:42 +00003398 // icmp eq|ne X, Y -> false|true if X != Y
Craig Topperc2790ec2017-06-06 07:13:04 +00003399 if (ICmpInst::isEquality(Pred) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003400 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
Craig Topper2dfb4802017-06-06 07:13:13 +00003401 return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
James Molloy1d88d6f2015-10-22 13:18:42 +00003402 }
Junmo Park53470fc2016-04-05 21:14:31 +00003403
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003404 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3405 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003406
Sanjay Patel35289c62016-12-10 17:40:47 +00003407 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003408 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003409
Chandler Carruth8059c842012-03-25 21:28:14 +00003410 // Simplify comparisons of related pointers using a powerful, recursive
3411 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003412 if (LHS->getType()->isPointerTy())
Nuno Lopes404f1062017-09-09 18:23:11 +00003413 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI, LHS,
3414 RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003415 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003416 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3417 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3418 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3419 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3420 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3421 Q.DL.getTypeSizeInBits(CRHS->getType()))
Nuno Lopes404f1062017-09-09 18:23:11 +00003422 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
David Majnemerdc8767a2016-08-07 07:58:10 +00003423 CLHS->getPointerOperand(),
3424 CRHS->getPointerOperand()))
3425 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003426
Nick Lewycky3db143e2012-02-26 02:09:49 +00003427 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3428 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3429 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3430 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3431 (ICmpInst::isEquality(Pred) ||
3432 (GLHS->isInBounds() && GRHS->isInBounds() &&
3433 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3434 // The bases are equal and the indices are constant. Build a constant
3435 // expression GEP with the same indices and a null base pointer to see
3436 // what constant folding can make out of it.
3437 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3438 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003439 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3440 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003441
3442 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003443 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3444 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003445 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3446 }
3447 }
3448 }
3449
Duncan Sandsf532d312010-11-07 16:12:23 +00003450 // If the comparison is with the result of a select instruction, check whether
3451 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003452 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003453 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003454 return V;
3455
3456 // If the comparison is with the result of a phi instruction, check whether
3457 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003458 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003459 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003460 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003461
Craig Topper9f008862014-04-15 04:59:12 +00003462 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003463}
3464
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003465Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003466 const SimplifyQuery &Q) {
3467 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3468}
3469
Sanjay Patel472cc782016-01-11 22:14:42 +00003470/// Given operands for an FCmpInst, see if we can fold the result.
3471/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003472static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003473 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003474 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003475 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3476 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3477
Chris Lattnera71e9d62009-11-10 00:55:12 +00003478 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003479 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003480 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003481
Chris Lattnera71e9d62009-11-10 00:55:12 +00003482 // If we have a constant, make sure it is on the RHS.
3483 std::swap(LHS, RHS);
3484 Pred = CmpInst::getSwappedPredicate(Pred);
3485 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003486
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003487 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003488 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003489 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003490 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003491 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003492 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003493
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003494 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3495 if (FMF.noNaNs()) {
3496 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003497 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003498 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003499 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003500 }
3501
Sanjay Patel46b083e2018-03-02 18:36:08 +00003502 // NaN is unordered; NaN is not ordered.
3503 assert((FCmpInst::isOrdered(Pred) || FCmpInst::isUnordered(Pred)) &&
3504 "Comparison must be either ordered or unordered");
3505 if (match(RHS, m_NaN()))
3506 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3507
Mehdi Aminieb242a52015-03-09 03:20:25 +00003508 // fcmp pred x, undef and fcmp pred undef, x
3509 // fold to true if unordered, false if ordered
3510 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3511 // Choosing NaN for the undef will always make unordered comparison succeed
3512 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003513 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003514 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003515
3516 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003517 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003518 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003519 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003520 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003521 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003522 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003523
Sanjay Patel4ca99682017-11-27 16:37:09 +00003524 // Handle fcmp with constant RHS.
3525 const APFloat *C;
3526 if (match(RHS, m_APFloat(C))) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003527 // Check whether the constant is an infinity.
Sanjay Patel4ca99682017-11-27 16:37:09 +00003528 if (C->isInfinity()) {
3529 if (C->isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003530 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003531 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003532 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003533 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003534 case FCmpInst::FCMP_UGE:
3535 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003536 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003537 default:
3538 break;
3539 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003540 } else {
3541 switch (Pred) {
3542 case FCmpInst::FCMP_OGT:
3543 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003544 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003545 case FCmpInst::FCMP_ULE:
3546 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003547 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003548 default:
3549 break;
3550 }
3551 }
3552 }
Sanjay Patel4ca99682017-11-27 16:37:09 +00003553 if (C->isZero()) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003554 switch (Pred) {
3555 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003556 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003557 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003558 break;
3559 case FCmpInst::FCMP_OLT:
3560 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003561 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003562 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003563 break;
3564 default:
3565 break;
3566 }
Florian Hahn30932a32017-12-01 12:34:16 +00003567 } else if (C->isNegative()) {
3568 assert(!C->isNaN() && "Unexpected NaN constant!");
3569 // TODO: We can catch more cases by using a range check rather than
3570 // relying on CannotBeOrderedLessThanZero.
3571 switch (Pred) {
3572 case FCmpInst::FCMP_UGE:
3573 case FCmpInst::FCMP_UGT:
3574 case FCmpInst::FCMP_UNE:
3575 // (X >= 0) implies (X > C) when (C < 0)
3576 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3577 return getTrue(RetTy);
3578 break;
3579 case FCmpInst::FCMP_OEQ:
3580 case FCmpInst::FCMP_OLE:
3581 case FCmpInst::FCMP_OLT:
3582 // (X >= 0) implies !(X < C) when (C < 0)
3583 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3584 return getFalse(RetTy);
3585 break;
3586 default:
3587 break;
3588 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003589 }
3590 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003591
Duncan Sandsa620bd12010-11-07 16:46:25 +00003592 // If the comparison is with the result of a select instruction, check whether
3593 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003594 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003595 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003596 return V;
3597
3598 // If the comparison is with the result of a phi instruction, check whether
3599 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003600 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003601 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003602 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003603
Craig Topper9f008862014-04-15 04:59:12 +00003604 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003605}
3606
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003607Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003608 FastMathFlags FMF, const SimplifyQuery &Q) {
3609 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003610}
3611
Sanjay Patel472cc782016-01-11 22:14:42 +00003612/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003613static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003614 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003615 unsigned MaxRecurse) {
3616 // Trivial replacement.
3617 if (V == Op)
3618 return RepOp;
3619
Tim Northover997f5f12017-05-22 21:28:08 +00003620 // We cannot replace a constant, and shouldn't even try.
3621 if (isa<Constant>(Op))
3622 return nullptr;
3623
David Majnemer3f0fb982015-06-06 22:40:21 +00003624 auto *I = dyn_cast<Instruction>(V);
3625 if (!I)
3626 return nullptr;
3627
3628 // If this is a binary operator, try to simplify it with the replaced op.
3629 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3630 // Consider:
3631 // %cmp = icmp eq i32 %x, 2147483647
3632 // %add = add nsw i32 %x, 1
3633 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3634 //
3635 // We can't replace %sel with %add unless we strip away the flags.
3636 if (isa<OverflowingBinaryOperator>(B))
3637 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3638 return nullptr;
3639 if (isa<PossiblyExactOperator>(B))
3640 if (B->isExact())
3641 return nullptr;
3642
3643 if (MaxRecurse) {
3644 if (B->getOperand(0) == Op)
3645 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3646 MaxRecurse - 1);
3647 if (B->getOperand(1) == Op)
3648 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3649 MaxRecurse - 1);
3650 }
3651 }
3652
3653 // Same for CmpInsts.
3654 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3655 if (MaxRecurse) {
3656 if (C->getOperand(0) == Op)
3657 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3658 MaxRecurse - 1);
3659 if (C->getOperand(1) == Op)
3660 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3661 MaxRecurse - 1);
3662 }
3663 }
3664
George Burgess IV8e807bf2018-04-24 00:25:01 +00003665 // Same for GEPs.
3666 if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
3667 if (MaxRecurse) {
3668 SmallVector<Value *, 8> NewOps(GEP->getNumOperands());
3669 transform(GEP->operands(), NewOps.begin(),
3670 [&](Value *V) { return V == Op ? RepOp : V; });
3671 return SimplifyGEPInst(GEP->getSourceElementType(), NewOps, Q,
3672 MaxRecurse - 1);
3673 }
3674 }
3675
David Majnemer3f0fb982015-06-06 22:40:21 +00003676 // TODO: We could hand off more cases to instsimplify here.
3677
3678 // If all operands are constant after substituting Op for RepOp then we can
3679 // constant fold the instruction.
3680 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3681 // Build a list of all constant operands.
3682 SmallVector<Constant *, 8> ConstOps;
3683 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3684 if (I->getOperand(i) == Op)
3685 ConstOps.push_back(CRepOp);
3686 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3687 ConstOps.push_back(COp);
3688 else
3689 break;
3690 }
3691
3692 // All operands were constants, fold it.
3693 if (ConstOps.size() == I->getNumOperands()) {
3694 if (CmpInst *C = dyn_cast<CmpInst>(I))
3695 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3696 ConstOps[1], Q.DL, Q.TLI);
3697
3698 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3699 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003700 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003701
Manuel Jacobe9024592016-01-21 06:33:22 +00003702 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003703 }
3704 }
3705
3706 return nullptr;
3707}
3708
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003709/// Try to simplify a select instruction when its condition operand is an
3710/// integer comparison where one operand of the compare is a constant.
3711static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3712 const APInt *Y, bool TrueWhenUnset) {
3713 const APInt *C;
3714
3715 // (X & Y) == 0 ? X & ~Y : X --> X
3716 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3717 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3718 *Y == ~*C)
3719 return TrueWhenUnset ? FalseVal : TrueVal;
3720
3721 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3722 // (X & Y) != 0 ? X : X & ~Y --> X
3723 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3724 *Y == ~*C)
3725 return TrueWhenUnset ? FalseVal : TrueVal;
3726
3727 if (Y->isPowerOf2()) {
3728 // (X & Y) == 0 ? X | Y : X --> X | Y
3729 // (X & Y) != 0 ? X | Y : X --> X
3730 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3731 *Y == *C)
3732 return TrueWhenUnset ? TrueVal : FalseVal;
3733
3734 // (X & Y) == 0 ? X : X | Y --> X
3735 // (X & Y) != 0 ? X : X | Y --> X | Y
3736 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3737 *Y == *C)
3738 return TrueWhenUnset ? TrueVal : FalseVal;
3739 }
Matt Arsenault82606662017-01-11 00:57:54 +00003740
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003741 return nullptr;
3742}
3743
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003744/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3745/// eq/ne.
Craig Topper0aa3a192017-08-14 21:39:51 +00003746static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3747 ICmpInst::Predicate Pred,
3748 Value *TrueVal, Value *FalseVal) {
3749 Value *X;
3750 APInt Mask;
3751 if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3752 return nullptr;
3753
Craig Topper0aa3a192017-08-14 21:39:51 +00003754 return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3755 Pred == ICmpInst::ICMP_EQ);
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003756}
3757
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003758/// Try to simplify a select instruction when its condition operand is an
3759/// integer comparison.
3760static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003761 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003762 unsigned MaxRecurse) {
3763 ICmpInst::Predicate Pred;
3764 Value *CmpLHS, *CmpRHS;
3765 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3766 return nullptr;
3767
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003768 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3769 Value *X;
3770 const APInt *Y;
3771 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3772 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3773 Pred == ICmpInst::ICMP_EQ))
3774 return V;
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003775 }
3776
Craig Topper0aa3a192017-08-14 21:39:51 +00003777 // Check for other compares that behave like bit test.
3778 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3779 TrueVal, FalseVal))
3780 return V;
3781
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003782 // If we have an equality comparison, then we know the value in one of the
3783 // arms of the select. See if substituting this value into the arm and
3784 // simplifying the result yields the same value as the other arm.
3785 if (Pred == ICmpInst::ICMP_EQ) {
3786 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3787 TrueVal ||
3788 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3789 TrueVal)
3790 return FalseVal;
3791 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3792 FalseVal ||
3793 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3794 FalseVal)
3795 return FalseVal;
3796 } else if (Pred == ICmpInst::ICMP_NE) {
3797 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3798 FalseVal ||
3799 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3800 FalseVal)
3801 return TrueVal;
3802 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3803 TrueVal ||
3804 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3805 TrueVal)
3806 return TrueVal;
3807 }
3808
3809 return nullptr;
3810}
3811
Sanjay Patel472cc782016-01-11 22:14:42 +00003812/// Given operands for a SelectInst, see if we can fold the result.
3813/// If not, this returns null.
Sanjay Patelac395202018-02-17 14:50:13 +00003814static Value *SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3815 const SimplifyQuery &Q, unsigned MaxRecurse) {
3816 if (auto *CondC = dyn_cast<Constant>(Cond)) {
3817 if (auto *TrueC = dyn_cast<Constant>(TrueVal))
3818 if (auto *FalseC = dyn_cast<Constant>(FalseVal))
3819 return ConstantFoldSelectInstruction(CondC, TrueC, FalseC);
3820
3821 // select undef, X, Y -> X or Y
3822 if (isa<UndefValue>(CondC))
3823 return isa<Constant>(FalseVal) ? FalseVal : TrueVal;
3824
3825 // TODO: Vector constants with undef elements don't simplify.
3826
3827 // select true, X, Y -> X
3828 if (CondC->isAllOnesValue())
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003829 return TrueVal;
Sanjay Patelac395202018-02-17 14:50:13 +00003830 // select false, X, Y -> Y
3831 if (CondC->isNullValue())
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003832 return FalseVal;
3833 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003834
Sanjay Patelac395202018-02-17 14:50:13 +00003835 // select ?, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003836 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003837 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003838
Sanjay Patelac395202018-02-17 14:50:13 +00003839 if (isa<UndefValue>(TrueVal)) // select ?, undef, X -> X
Dan Gohman54664ed2011-07-01 01:03:43 +00003840 return FalseVal;
Sanjay Patelac395202018-02-17 14:50:13 +00003841 if (isa<UndefValue>(FalseVal)) // select ?, X, undef -> X
Dan Gohman54664ed2011-07-01 01:03:43 +00003842 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003843
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003844 if (Value *V =
Sanjay Patelac395202018-02-17 14:50:13 +00003845 simplifySelectWithICmpCond(Cond, TrueVal, FalseVal, Q, MaxRecurse))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003846 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003847
David Bolvanskyf9476082018-07-28 06:55:51 +00003848 if (Value *V = foldSelectWithBinaryOp(Cond, TrueVal, FalseVal))
3849 return V;
3850
Craig Topper9f008862014-04-15 04:59:12 +00003851 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003852}
3853
Duncan Sandsb8cee002012-03-13 11:42:19 +00003854Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003855 const SimplifyQuery &Q) {
3856 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003857}
3858
Sanjay Patel472cc782016-01-11 22:14:42 +00003859/// Given operands for an GetElementPtrInst, see if we can fold the result.
3860/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003861static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003862 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003863 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003864 unsigned AS =
3865 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003866
Chris Lattner8574aba2009-11-27 00:29:05 +00003867 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003868 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003869 return Ops[0];
3870
Nico Weber48c82402014-08-27 20:06:19 +00003871 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003872 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003873 Type *GEPTy = PointerType::get(LastType, AS);
3874 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3875 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003876 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3877 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003878
3879 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003880 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003881
Jay Foadb992a632011-07-19 15:07:52 +00003882 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003883 // getelementptr P, 0 -> P.
Matthew Simpsonc1c4ad62018-03-15 16:00:29 +00003884 if (match(Ops[1], m_Zero()) && Ops[0]->getType() == GEPTy)
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003885 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003886
David Blaikie4a2e73b2015-04-02 18:55:32 +00003887 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003888 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003889 Value *P;
3890 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003891 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003892 // getelementptr P, N -> P if P points to a type of zero size.
Matthew Simpsonc1c4ad62018-03-15 16:00:29 +00003893 if (TyAllocSize == 0 && Ops[0]->getType() == GEPTy)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003894 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003895
3896 // The following transforms are only safe if the ptrtoint cast
3897 // doesn't truncate the pointers.
3898 if (Ops[1]->getType()->getScalarSizeInBits() ==
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003899 Q.DL.getIndexSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003900 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3901 if (match(P, m_Zero()))
3902 return Constant::getNullValue(GEPTy);
3903 Value *Temp;
3904 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003905 if (Temp->getType() == GEPTy)
3906 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003907 return nullptr;
3908 };
3909
3910 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3911 if (TyAllocSize == 1 &&
3912 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3913 if (Value *R = PtrToIntOrZero(P))
3914 return R;
3915
3916 // getelementptr V, (ashr (sub P, V), C) -> Q
3917 // if P points to a type of size 1 << C.
3918 if (match(Ops[1],
3919 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3920 m_ConstantInt(C))) &&
3921 TyAllocSize == 1ULL << C)
3922 if (Value *R = PtrToIntOrZero(P))
3923 return R;
3924
3925 // getelementptr V, (sdiv (sub P, V), C) -> Q
3926 // if P points to a type of size C.
3927 if (match(Ops[1],
3928 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3929 m_SpecificInt(TyAllocSize))))
3930 if (Value *R = PtrToIntOrZero(P))
3931 return R;
3932 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003933 }
3934 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003935
David Majnemerd1501372016-08-07 07:58:12 +00003936 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3937 all_of(Ops.slice(1).drop_back(1),
3938 [](Value *Idx) { return match(Idx, m_Zero()); })) {
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003939 unsigned IdxWidth =
3940 Q.DL.getIndexSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3941 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == IdxWidth) {
3942 APInt BasePtrOffset(IdxWidth, 0);
David Majnemerd1501372016-08-07 07:58:12 +00003943 Value *StrippedBasePtr =
3944 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3945 BasePtrOffset);
3946
David Majnemer5c5df622016-08-16 06:13:46 +00003947 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003948 if (match(Ops.back(),
3949 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3950 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3951 return ConstantExpr::getIntToPtr(CI, GEPTy);
3952 }
David Majnemer5c5df622016-08-16 06:13:46 +00003953 // gep (gep V, C), (xor V, -1) -> C-1
3954 if (match(Ops.back(),
3955 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3956 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3957 return ConstantExpr::getIntToPtr(CI, GEPTy);
3958 }
David Majnemerd1501372016-08-07 07:58:12 +00003959 }
3960 }
3961
Chris Lattner8574aba2009-11-27 00:29:05 +00003962 // Check to see if this is constant foldable.
Craig Topperda8037f2017-06-04 22:41:56 +00003963 if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
3964 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003965
Joey Gouly61eaa632017-06-06 10:17:14 +00003966 auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3967 Ops.slice(1));
3968 if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
3969 return CEFolded;
3970 return CE;
Chris Lattner8574aba2009-11-27 00:29:05 +00003971}
3972
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003973Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003974 const SimplifyQuery &Q) {
3975 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003976}
3977
Sanjay Patel472cc782016-01-11 22:14:42 +00003978/// Given operands for an InsertValueInst, see if we can fold the result.
3979/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003980static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003981 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003982 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003983 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3984 if (Constant *CVal = dyn_cast<Constant>(Val))
3985 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3986
3987 // insertvalue x, undef, n -> x
3988 if (match(Val, m_Undef()))
3989 return Agg;
3990
3991 // insertvalue x, (extractvalue y, n), n
3992 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003993 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3994 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003995 // insertvalue undef, (extractvalue y, n), n -> y
3996 if (match(Agg, m_Undef()))
3997 return EV->getAggregateOperand();
3998
3999 // insertvalue y, (extractvalue y, n), n -> y
4000 if (Agg == EV->getAggregateOperand())
4001 return Agg;
4002 }
4003
Craig Topper9f008862014-04-15 04:59:12 +00004004 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00004005}
4006
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004007Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
4008 ArrayRef<unsigned> Idxs,
4009 const SimplifyQuery &Q) {
4010 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
4011}
4012
Igor Laevskye0edb662017-12-13 11:21:18 +00004013Value *llvm::SimplifyInsertElementInst(Value *Vec, Value *Val, Value *Idx,
4014 const SimplifyQuery &Q) {
4015 // Try to constant fold.
4016 auto *VecC = dyn_cast<Constant>(Vec);
4017 auto *ValC = dyn_cast<Constant>(Val);
4018 auto *IdxC = dyn_cast<Constant>(Idx);
4019 if (VecC && ValC && IdxC)
4020 return ConstantFoldInsertElementInstruction(VecC, ValC, IdxC);
4021
4022 // Fold into undef if index is out of bounds.
4023 if (auto *CI = dyn_cast<ConstantInt>(Idx)) {
4024 uint64_t NumElements = cast<VectorType>(Vec->getType())->getNumElements();
Igor Laevskye0edb662017-12-13 11:21:18 +00004025 if (CI->uge(NumElements))
4026 return UndefValue::get(Vec->getType());
4027 }
4028
Philip Reamese499bc32017-12-30 05:54:22 +00004029 // If index is undef, it might be out of bounds (see above case)
4030 if (isa<UndefValue>(Idx))
4031 return UndefValue::get(Vec->getType());
Igor Laevskye0edb662017-12-13 11:21:18 +00004032
4033 return nullptr;
4034}
4035
Sanjay Patel472cc782016-01-11 22:14:42 +00004036/// Given operands for an ExtractValueInst, see if we can fold the result.
4037/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00004038static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004039 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00004040 if (auto *CAgg = dyn_cast<Constant>(Agg))
4041 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
4042
4043 // extractvalue x, (insertvalue y, elt, n), n -> elt
4044 unsigned NumIdxs = Idxs.size();
4045 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
4046 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
4047 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
4048 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
4049 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
4050 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
4051 Idxs.slice(0, NumCommonIdxs)) {
4052 if (NumIdxs == NumInsertValueIdxs)
4053 return IVI->getInsertedValueOperand();
4054 break;
4055 }
4056 }
4057
4058 return nullptr;
4059}
4060
4061Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004062 const SimplifyQuery &Q) {
4063 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
4064}
4065
Sanjay Patel472cc782016-01-11 22:14:42 +00004066/// Given operands for an ExtractElementInst, see if we can fold the result.
4067/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004068static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00004069 unsigned) {
4070 if (auto *CVec = dyn_cast<Constant>(Vec)) {
4071 if (auto *CIdx = dyn_cast<Constant>(Idx))
4072 return ConstantFoldExtractElementInstruction(CVec, CIdx);
4073
4074 // The index is not relevant if our vector is a splat.
4075 if (auto *Splat = CVec->getSplatValue())
4076 return Splat;
4077
4078 if (isa<UndefValue>(Vec))
4079 return UndefValue::get(Vec->getType()->getVectorElementType());
4080 }
4081
4082 // If extracting a specified index from the vector, see if we can recursively
4083 // find a previously computed scalar that was inserted into the vector.
Philip Reamese499bc32017-12-30 05:54:22 +00004084 if (auto *IdxC = dyn_cast<ConstantInt>(Idx)) {
4085 if (IdxC->getValue().uge(Vec->getType()->getVectorNumElements()))
4086 // definitely out of bounds, thus undefined result
4087 return UndefValue::get(Vec->getType()->getVectorElementType());
4088 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
4089 return Elt;
4090 }
David Majnemer599ca442015-07-13 01:15:53 +00004091
Zvi Rackover2e6e88f2017-12-06 17:51:46 +00004092 // An undef extract index can be arbitrarily chosen to be an out-of-range
4093 // index value, which would result in the instruction being undef.
4094 if (isa<UndefValue>(Idx))
4095 return UndefValue::get(Vec->getType()->getVectorElementType());
4096
David Majnemer599ca442015-07-13 01:15:53 +00004097 return nullptr;
4098}
4099
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004100Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
4101 const SimplifyQuery &Q) {
4102 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
4103}
4104
Sanjay Patel472cc782016-01-11 22:14:42 +00004105/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004106static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004107 // If all of the PHI's incoming values are the same then replace the PHI node
4108 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00004109 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004110 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00004111 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004112 // If the incoming value is the phi node itself, it can safely be skipped.
4113 if (Incoming == PN) continue;
4114 if (isa<UndefValue>(Incoming)) {
4115 // Remember that we saw an undef value, but otherwise ignore them.
4116 HasUndefInput = true;
4117 continue;
4118 }
4119 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00004120 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00004121 CommonValue = Incoming;
4122 }
4123
4124 // If CommonValue is null then all of the incoming values were either undef or
4125 // equal to the phi node itself.
4126 if (!CommonValue)
4127 return UndefValue::get(PN->getType());
4128
4129 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4130 // instruction, we cannot return X as the result of the PHI node unless it
4131 // dominates the PHI block.
4132 if (HasUndefInput)
Sanjay Patel5da361a2018-04-10 18:38:19 +00004133 return valueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004134
4135 return CommonValue;
4136}
4137
David Majnemer6774d612016-07-26 17:58:05 +00004138static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004139 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004140 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004141 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004142
David Majnemer6774d612016-07-26 17:58:05 +00004143 if (auto *CI = dyn_cast<CastInst>(Op)) {
4144 auto *Src = CI->getOperand(0);
4145 Type *SrcTy = Src->getType();
4146 Type *MidTy = CI->getType();
4147 Type *DstTy = Ty;
4148 if (Src->getType() == Ty) {
4149 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4150 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4151 Type *SrcIntPtrTy =
4152 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4153 Type *MidIntPtrTy =
4154 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4155 Type *DstIntPtrTy =
4156 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4157 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4158 SrcIntPtrTy, MidIntPtrTy,
4159 DstIntPtrTy) == Instruction::BitCast)
4160 return Src;
4161 }
4162 }
David Majnemera90a6212016-07-26 05:52:29 +00004163
4164 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004165 if (CastOpc == Instruction::BitCast)
4166 if (Op->getType() == Ty)
4167 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004168
4169 return nullptr;
4170}
4171
David Majnemer6774d612016-07-26 17:58:05 +00004172Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004173 const SimplifyQuery &Q) {
4174 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4175}
4176
Sanjay Patela3c297d2017-04-19 16:48:22 +00004177/// For the given destination element of a shuffle, peek through shuffles to
4178/// match a root vector source operand that contains that element in the same
4179/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4180static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004181 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004182 unsigned MaxRecurse) {
4183 if (!MaxRecurse--)
4184 return nullptr;
4185
4186 // Bail out if any mask value is undefined. That kind of shuffle may be
4187 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004188 if (MaskVal == -1)
4189 return nullptr;
4190
4191 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004192 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004193 int RootElt = MaskVal;
4194 Value *SourceOp = Op0;
4195 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004196 RootElt = MaskVal - InVecNumElts;
4197 SourceOp = Op1;
4198 }
4199
4200 // If the source operand is a shuffle itself, look through it to find the
4201 // matching root vector.
4202 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4203 return foldIdentityShuffles(
4204 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004205 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004206 }
4207
4208 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4209 // size?
4210
4211 // The source operand is not a shuffle. Initialize the root vector value for
4212 // this shuffle if that has not been done yet.
4213 if (!RootVec)
4214 RootVec = SourceOp;
4215
4216 // Give up as soon as a source operand does not match the existing root value.
4217 if (RootVec != SourceOp)
4218 return nullptr;
4219
4220 // The element must be coming from the same lane in the source vector
4221 // (although it may have crossed lanes in intermediate shuffles).
4222 if (RootElt != DestElt)
4223 return nullptr;
4224
4225 return RootVec;
4226}
4227
Zvi Rackover8f460652017-04-03 22:05:30 +00004228static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004229 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004230 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004231 if (isa<UndefValue>(Mask))
4232 return UndefValue::get(RetTy);
4233
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004234 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004235 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004236 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004237
Zvi Rackover0411e462017-04-30 06:10:54 +00004238 SmallVector<int, 32> Indices;
4239 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4240 assert(MaskNumElts == Indices.size() &&
4241 "Size of Indices not same as number of mask elements?");
4242
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004243 // Canonicalization: If mask does not select elements from an input vector,
4244 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004245 bool MaskSelects0 = false, MaskSelects1 = false;
4246 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004247 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004248 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004249 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004250 MaskSelects0 = true;
4251 else
4252 MaskSelects1 = true;
4253 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004254 if (!MaskSelects0)
4255 Op0 = UndefValue::get(InVecTy);
4256 if (!MaskSelects1)
4257 Op1 = UndefValue::get(InVecTy);
4258
4259 auto *Op0Const = dyn_cast<Constant>(Op0);
4260 auto *Op1Const = dyn_cast<Constant>(Op1);
4261
4262 // If all operands are constant, constant fold the shuffle.
4263 if (Op0Const && Op1Const)
4264 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4265
4266 // Canonicalization: if only one input vector is constant, it shall be the
4267 // second one.
4268 if (Op0Const && !Op1Const) {
4269 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004270 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004271 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004272
4273 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4274 // value type is same as the input vectors' type.
4275 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004276 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004277 OpShuf->getMask()->getSplatValue())
4278 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004279
Sanjay Patela3c297d2017-04-19 16:48:22 +00004280 // Don't fold a shuffle with undef mask elements. This may get folded in a
4281 // better way using demanded bits or other analysis.
4282 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004283 if (find(Indices, -1) != Indices.end())
4284 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004285
4286 // Check if every element of this shuffle can be mapped back to the
4287 // corresponding element of a single root vector. If so, we don't need this
4288 // shuffle. This handles simple identity shuffles as well as chains of
4289 // shuffles that may widen/narrow and/or move elements across lanes and back.
4290 Value *RootVec = nullptr;
4291 for (unsigned i = 0; i != MaskNumElts; ++i) {
4292 // Note that recursion is limited for each vector element, so if any element
4293 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004294 RootVec =
4295 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004296
4297 // We can't replace a widening/narrowing shuffle with one of its operands.
4298 if (!RootVec || RootVec->getType() != RetTy)
4299 return nullptr;
4300 }
4301 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004302}
4303
4304/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004305Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4306 Type *RetTy, const SimplifyQuery &Q) {
4307 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004308}
4309
Sanjay Patele2359422018-03-21 19:31:53 +00004310static Constant *propagateNaN(Constant *In) {
4311 // If the input is a vector with undef elements, just return a default NaN.
4312 if (!In->isNaN())
4313 return ConstantFP::getNaN(In->getType());
4314
4315 // Propagate the existing NaN constant when possible.
4316 // TODO: Should we quiet a signaling NaN?
4317 return In;
4318}
4319
4320static Constant *simplifyFPBinop(Value *Op0, Value *Op1) {
4321 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4322 return ConstantFP::getNaN(Op0->getType());
4323
4324 if (match(Op0, m_NaN()))
4325 return propagateNaN(cast<Constant>(Op0));
4326 if (match(Op1, m_NaN()))
4327 return propagateNaN(cast<Constant>(Op1));
4328
4329 return nullptr;
4330}
4331
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004332/// Given operands for an FAdd, see if we can fold the result. If not, this
4333/// returns null.
4334static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4335 const SimplifyQuery &Q, unsigned MaxRecurse) {
4336 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4337 return C;
4338
Sanjay Patele2359422018-03-21 19:31:53 +00004339 if (Constant *C = simplifyFPBinop(Op0, Op1))
4340 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004341
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004342 // fadd X, -0 ==> X
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004343 if (match(Op1, m_NegZeroFP()))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004344 return Op0;
4345
4346 // fadd X, 0 ==> X, when we know X is not -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004347 if (match(Op1, m_PosZeroFP()) &&
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004348 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4349 return Op0;
4350
Sanjay Patel11f7f992018-03-14 21:23:27 +00004351 // With nnan: (+/-0.0 - X) + X --> 0.0 (and commuted variant)
4352 // We don't have to explicitly exclude infinities (ninf): INF + -INF == NaN.
4353 // Negative zeros are allowed because we always end up with positive zero:
4354 // X = -0.0: (-0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4355 // X = -0.0: ( 0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4356 // X = 0.0: (-0.0 - ( 0.0)) + ( 0.0) == (-0.0) + ( 0.0) == 0.0
4357 // X = 0.0: ( 0.0 - ( 0.0)) + ( 0.0) == ( 0.0) + ( 0.0) == 0.0
Sanjay Patela4f42f22018-03-15 14:29:27 +00004358 if (FMF.noNaNs() && (match(Op0, m_FSub(m_AnyZeroFP(), m_Specific(Op1))) ||
4359 match(Op1, m_FSub(m_AnyZeroFP(), m_Specific(Op0)))))
Sanjay Patel11f7f992018-03-14 21:23:27 +00004360 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004361
4362 return nullptr;
4363}
4364
4365/// Given operands for an FSub, see if we can fold the result. If not, this
4366/// returns null.
4367static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4368 const SimplifyQuery &Q, unsigned MaxRecurse) {
4369 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
4370 return C;
4371
Sanjay Patele2359422018-03-21 19:31:53 +00004372 if (Constant *C = simplifyFPBinop(Op0, Op1))
4373 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004374
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004375 // fsub X, +0 ==> X
4376 if (match(Op1, m_PosZeroFP()))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004377 return Op0;
4378
4379 // fsub X, -0 ==> X, when we know X is not -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004380 if (match(Op1, m_NegZeroFP()) &&
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004381 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4382 return Op0;
4383
4384 // fsub -0.0, (fsub -0.0, X) ==> X
4385 Value *X;
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004386 if (match(Op0, m_NegZeroFP()) &&
4387 match(Op1, m_FSub(m_NegZeroFP(), m_Value(X))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004388 return X;
4389
4390 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Sanjay Patela4f42f22018-03-15 14:29:27 +00004391 if (FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()) &&
4392 match(Op1, m_FSub(m_AnyZeroFP(), m_Value(X))))
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004393 return X;
4394
4395 // fsub nnan x, x ==> 0.0
4396 if (FMF.noNaNs() && Op0 == Op1)
4397 return Constant::getNullValue(Op0->getType());
4398
Sanjay Patelf7a8fb22018-08-07 20:14:27 +00004399 // Y - (Y - X) --> X
4400 if (FMF.noSignedZeros() && FMF.allowReassoc() &&
4401 match(Op1, m_FSub(m_Specific(Op0), m_Value(X))))
4402 return X;
4403
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004404 return nullptr;
4405}
4406
4407/// Given the operands for an FMul, see if we can fold the result
4408static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4409 const SimplifyQuery &Q, unsigned MaxRecurse) {
4410 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
4411 return C;
4412
Sanjay Patele2359422018-03-21 19:31:53 +00004413 if (Constant *C = simplifyFPBinop(Op0, Op1))
4414 return C;
Sanjay Patel42227162018-03-10 16:51:28 +00004415
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004416 // fmul X, 1.0 ==> X
4417 if (match(Op1, m_FPOne()))
4418 return Op0;
4419
4420 // fmul nnan nsz X, 0 ==> 0
Sanjay Patela4f42f22018-03-15 14:29:27 +00004421 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZeroFP()))
4422 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004423
Sanjay Patel95ec4a42018-03-18 14:12:25 +00004424 // sqrt(X) * sqrt(X) --> X, if we can:
4425 // 1. Remove the intermediate rounding (reassociate).
4426 // 2. Ignore non-zero negative numbers because sqrt would produce NAN.
4427 // 3. Ignore -0.0 because sqrt(-0.0) == -0.0, but -0.0 * -0.0 == 0.0.
Sanjay Pateldb53d182018-02-23 22:20:13 +00004428 Value *X;
Sanjay Patel95ec4a42018-03-18 14:12:25 +00004429 if (Op0 == Op1 && match(Op0, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) &&
4430 FMF.allowReassoc() && FMF.noNaNs() && FMF.noSignedZeros())
Sanjay Pateldb53d182018-02-23 22:20:13 +00004431 return X;
4432
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004433 return nullptr;
4434}
4435
4436Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4437 const SimplifyQuery &Q) {
4438 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
4439}
4440
4441
4442Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4443 const SimplifyQuery &Q) {
4444 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
4445}
4446
4447Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4448 const SimplifyQuery &Q) {
4449 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
4450}
4451
4452static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4453 const SimplifyQuery &Q, unsigned) {
4454 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
4455 return C;
4456
Sanjay Patele2359422018-03-21 19:31:53 +00004457 if (Constant *C = simplifyFPBinop(Op0, Op1))
4458 return C;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004459
4460 // X / 1.0 -> X
4461 if (match(Op1, m_FPOne()))
4462 return Op0;
4463
4464 // 0 / X -> 0
4465 // Requires that NaNs are off (X could be zero) and signed zeroes are
4466 // ignored (X could be positive or negative, so the output sign is unknown).
Sanjay Patela4f42f22018-03-15 14:29:27 +00004467 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()))
4468 return ConstantFP::getNullValue(Op0->getType());
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004469
4470 if (FMF.noNaNs()) {
4471 // X / X -> 1.0 is legal when NaNs are ignored.
Sanjay Patel83f05662018-01-30 00:18:37 +00004472 // We can ignore infinities because INF/INF is NaN.
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004473 if (Op0 == Op1)
4474 return ConstantFP::get(Op0->getType(), 1.0);
4475
Sanjay Patel83f05662018-01-30 00:18:37 +00004476 // (X * Y) / Y --> X if we can reassociate to the above form.
4477 Value *X;
4478 if (FMF.allowReassoc() && match(Op0, m_c_FMul(m_Value(X), m_Specific(Op1))))
4479 return X;
4480
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004481 // -X / X -> -1.0 and
4482 // X / -X -> -1.0 are legal when NaNs are ignored.
4483 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
4484 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
4485 BinaryOperator::getFNegArgument(Op0) == Op1) ||
4486 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
4487 BinaryOperator::getFNegArgument(Op1) == Op0))
4488 return ConstantFP::get(Op0->getType(), -1.0);
4489 }
4490
4491 return nullptr;
4492}
4493
4494Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4495 const SimplifyQuery &Q) {
4496 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
4497}
4498
4499static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4500 const SimplifyQuery &Q, unsigned) {
4501 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
4502 return C;
4503
Sanjay Patele2359422018-03-21 19:31:53 +00004504 if (Constant *C = simplifyFPBinop(Op0, Op1))
4505 return C;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004506
Sanjay Patel8f063d02018-03-15 14:04:31 +00004507 // Unlike fdiv, the result of frem always matches the sign of the dividend.
4508 // The constant match may include undef elements in a vector, so return a full
4509 // zero constant as the result.
4510 if (FMF.noNaNs()) {
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004511 // +0 % X -> 0
4512 if (match(Op0, m_PosZeroFP()))
Sanjay Patel8f063d02018-03-15 14:04:31 +00004513 return ConstantFP::getNullValue(Op0->getType());
4514 // -0 % X -> -0
Sanjay Patel93e64dd2018-03-25 21:16:33 +00004515 if (match(Op0, m_NegZeroFP()))
Sanjay Patel8f063d02018-03-15 14:04:31 +00004516 return ConstantFP::getNegativeZero(Op0->getType());
4517 }
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004518
4519 return nullptr;
4520}
4521
4522Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4523 const SimplifyQuery &Q) {
4524 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
4525}
4526
Chris Lattnera71e9d62009-11-10 00:55:12 +00004527//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004528
Sanjay Patel472cc782016-01-11 22:14:42 +00004529/// Given operands for a BinaryOperator, see if we can fold the result.
4530/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004531static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004532 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004533 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004534 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004535 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004536 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004537 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004538 case Instruction::Mul:
4539 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004540 case Instruction::SDiv:
4541 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4542 case Instruction::UDiv:
4543 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004544 case Instruction::SRem:
4545 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4546 case Instruction::URem:
4547 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004548 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004549 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004550 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004551 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004552 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004553 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4554 case Instruction::And:
4555 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4556 case Instruction::Or:
4557 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4558 case Instruction::Xor:
4559 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004560 case Instruction::FAdd:
4561 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4562 case Instruction::FSub:
4563 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4564 case Instruction::FMul:
4565 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4566 case Instruction::FDiv:
4567 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4568 case Instruction::FRem:
4569 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004570 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004571 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004572 }
4573}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004574
Sanjay Patel472cc782016-01-11 22:14:42 +00004575/// Given operands for a BinaryOperator, see if we can fold the result.
4576/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004577/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4578/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4579static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004580 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004581 unsigned MaxRecurse) {
4582 switch (Opcode) {
4583 case Instruction::FAdd:
4584 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4585 case Instruction::FSub:
4586 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4587 case Instruction::FMul:
4588 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004589 case Instruction::FDiv:
4590 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004591 default:
4592 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4593 }
4594}
4595
Duncan Sands7e800d62010-11-14 11:23:23 +00004596Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004597 const SimplifyQuery &Q) {
4598 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4599}
4600
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004601Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004602 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004603 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4604}
4605
Sanjay Patel472cc782016-01-11 22:14:42 +00004606/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004607static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004608 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004609 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004610 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004611 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004612}
4613
4614Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004615 const SimplifyQuery &Q) {
4616 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4617}
4618
Michael Ilseman54857292013-02-07 19:26:05 +00004619static bool IsIdempotent(Intrinsic::ID ID) {
4620 switch (ID) {
4621 default: return false;
4622
4623 // Unary idempotent: f(f(x)) = f(x)
4624 case Intrinsic::fabs:
4625 case Intrinsic::floor:
4626 case Intrinsic::ceil:
4627 case Intrinsic::trunc:
4628 case Intrinsic::rint:
4629 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004630 case Intrinsic::round:
Matt Arsenault3ced3d92017-09-07 01:21:43 +00004631 case Intrinsic::canonicalize:
Michael Ilseman54857292013-02-07 19:26:05 +00004632 return true;
4633 }
4634}
4635
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004636static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4637 const DataLayout &DL) {
4638 GlobalValue *PtrSym;
4639 APInt PtrOffset;
4640 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4641 return nullptr;
4642
4643 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4644 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4645 Type *Int32PtrTy = Int32Ty->getPointerTo();
4646 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4647
4648 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4649 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4650 return nullptr;
4651
4652 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4653 if (OffsetInt % 4 != 0)
4654 return nullptr;
4655
4656 Constant *C = ConstantExpr::getGetElementPtr(
4657 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4658 ConstantInt::get(Int64Ty, OffsetInt / 4));
4659 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4660 if (!Loaded)
4661 return nullptr;
4662
4663 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4664 if (!LoadedCE)
4665 return nullptr;
4666
4667 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4668 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4669 if (!LoadedCE)
4670 return nullptr;
4671 }
4672
4673 if (LoadedCE->getOpcode() != Instruction::Sub)
4674 return nullptr;
4675
4676 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4677 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4678 return nullptr;
4679 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4680
4681 Constant *LoadedRHS = LoadedCE->getOperand(1);
4682 GlobalValue *LoadedRHSSym;
4683 APInt LoadedRHSOffset;
4684 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4685 DL) ||
4686 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4687 return nullptr;
4688
4689 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4690}
4691
David Majnemer17a95aa2016-07-14 06:58:37 +00004692static bool maskIsAllZeroOrUndef(Value *Mask) {
4693 auto *ConstMask = dyn_cast<Constant>(Mask);
4694 if (!ConstMask)
4695 return false;
4696 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4697 return true;
4698 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4699 ++I) {
4700 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4701 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4702 continue;
4703 return false;
4704 }
4705 return true;
4706}
4707
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004708static Value *simplifyUnaryIntrinsic(Function *F, Value *Op0,
4709 const SimplifyQuery &Q) {
4710 // Idempotent functions return the same result when called repeatedly.
David Majnemer15032582015-05-22 03:56:46 +00004711 Intrinsic::ID IID = F->getIntrinsicID();
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004712 if (IsIdempotent(IID))
4713 if (auto *II = dyn_cast<IntrinsicInst>(Op0))
4714 if (II->getIntrinsicID() == IID)
4715 return II;
Michael Ilseman54857292013-02-07 19:26:05 +00004716
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004717 Value *X;
4718 switch (IID) {
4719 case Intrinsic::fabs:
4720 if (SignBitMustBeZero(Op0, Q.TLI)) return Op0;
4721 break;
4722 case Intrinsic::bswap:
4723 // bswap(bswap(x)) -> x
4724 if (match(Op0, m_BSwap(m_Value(X)))) return X;
4725 break;
4726 case Intrinsic::bitreverse:
4727 // bitreverse(bitreverse(x)) -> x
4728 if (match(Op0, m_BitReverse(m_Value(X)))) return X;
4729 break;
4730 case Intrinsic::exp:
4731 // exp(log(x)) -> x
4732 if (Q.CxtI->hasAllowReassoc() &&
4733 match(Op0, m_Intrinsic<Intrinsic::log>(m_Value(X)))) return X;
4734 break;
4735 case Intrinsic::exp2:
4736 // exp2(log2(x)) -> x
4737 if (Q.CxtI->hasAllowReassoc() &&
4738 match(Op0, m_Intrinsic<Intrinsic::log2>(m_Value(X)))) return X;
4739 break;
4740 case Intrinsic::log:
4741 // log(exp(x)) -> x
4742 if (Q.CxtI->hasAllowReassoc() &&
4743 match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X)))) return X;
4744 break;
4745 case Intrinsic::log2:
4746 // log2(exp2(x)) -> x
4747 if (Q.CxtI->hasAllowReassoc() &&
4748 match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X)))) return X;
4749 break;
4750 default:
4751 break;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004752 }
Michael Ilseman54857292013-02-07 19:26:05 +00004753
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004754 return nullptr;
4755}
Matt Arsenault82606662017-01-11 00:57:54 +00004756
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004757static Value *simplifyBinaryIntrinsic(Function *F, Value *Op0, Value *Op1,
4758 const SimplifyQuery &Q) {
4759 Intrinsic::ID IID = F->getIntrinsicID();
4760 Type *ReturnType = F->getReturnType();
4761 switch (IID) {
4762 case Intrinsic::usub_with_overflow:
4763 case Intrinsic::ssub_with_overflow:
4764 // X - X -> { 0, false }
4765 if (Op0 == Op1)
4766 return Constant::getNullValue(ReturnType);
4767 // X - undef -> undef
4768 // undef - X -> undef
4769 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4770 return UndefValue::get(ReturnType);
4771 break;
4772 case Intrinsic::uadd_with_overflow:
4773 case Intrinsic::sadd_with_overflow:
4774 // X + undef -> undef
4775 if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4776 return UndefValue::get(ReturnType);
4777 break;
4778 case Intrinsic::umul_with_overflow:
4779 case Intrinsic::smul_with_overflow:
4780 // 0 * X -> { 0, false }
4781 // X * 0 -> { 0, false }
4782 if (match(Op0, m_Zero()) || match(Op1, m_Zero()))
4783 return Constant::getNullValue(ReturnType);
4784 // undef * X -> { 0, false }
4785 // X * undef -> { 0, false }
4786 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
4787 return Constant::getNullValue(ReturnType);
4788 break;
4789 case Intrinsic::load_relative:
4790 if (auto *C0 = dyn_cast<Constant>(Op0))
4791 if (auto *C1 = dyn_cast<Constant>(Op1))
Matt Arsenault82606662017-01-11 00:57:54 +00004792 return SimplifyRelativeLoad(C0, C1, Q.DL);
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004793 break;
4794 case Intrinsic::powi:
4795 if (auto *Power = dyn_cast<ConstantInt>(Op1)) {
4796 // powi(x, 0) -> 1.0
4797 if (Power->isZero())
4798 return ConstantFP::get(Op0->getType(), 1.0);
4799 // powi(x, 1) -> x
4800 if (Power->isOne())
4801 return Op0;
Matt Arsenault82606662017-01-11 00:57:54 +00004802 }
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004803 break;
4804 case Intrinsic::maxnum:
4805 case Intrinsic::minnum:
Sanjay Patel28c7e412018-08-01 23:05:55 +00004806 // If the arguments are the same, this is a no-op.
4807 if (Op0 == Op1) return Op0;
4808
Sanjay Patel3f6e9a72018-08-02 14:33:40 +00004809 // If one argument is NaN or undef, return the other argument.
4810 if (match(Op0, m_CombineOr(m_NaN(), m_Undef()))) return Op1;
4811 if (match(Op1, m_CombineOr(m_NaN(), m_Undef()))) return Op0;
4812
Sanjay Patel948ff872018-08-07 14:36:27 +00004813 // Min/max of the same operation with common operand:
4814 // m(m(X, Y)), X --> m(X, Y) (4 commuted variants)
4815 if (auto *M0 = dyn_cast<IntrinsicInst>(Op0))
4816 if (M0->getIntrinsicID() == IID &&
4817 (M0->getOperand(0) == Op1 || M0->getOperand(1) == Op1))
4818 return Op0;
4819 if (auto *M1 = dyn_cast<IntrinsicInst>(Op1))
4820 if (M1->getIntrinsicID() == IID &&
4821 (M1->getOperand(0) == Op0 || M1->getOperand(1) == Op0))
4822 return Op1;
4823
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004824 break;
4825 default:
4826 break;
Matt Arsenault82606662017-01-11 00:57:54 +00004827 }
4828
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004829 return nullptr;
4830}
4831
4832template <typename IterTy>
4833static Value *simplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
4834 const SimplifyQuery &Q) {
4835 // Intrinsics with no operands have some kind of side effect. Don't simplify.
4836 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
4837 if (NumOperands == 0)
4838 return nullptr;
4839
4840 Intrinsic::ID IID = F->getIntrinsicID();
4841 if (NumOperands == 1)
4842 return simplifyUnaryIntrinsic(F, ArgBegin[0], Q);
4843
4844 if (NumOperands == 2)
4845 return simplifyBinaryIntrinsic(F, ArgBegin[0], ArgBegin[1], Q);
4846
4847 // Handle intrinsics with 3 or more arguments.
Matt Arsenault82606662017-01-11 00:57:54 +00004848 switch (IID) {
4849 case Intrinsic::masked_load: {
4850 Value *MaskArg = ArgBegin[2];
4851 Value *PassthruArg = ArgBegin[3];
4852 // If the mask is all zeros or undef, the "passthru" argument is the result.
4853 if (maskIsAllZeroOrUndef(MaskArg))
4854 return PassthruArg;
4855 return nullptr;
4856 }
Sanjay Patel54421ce2018-07-29 16:36:38 +00004857 case Intrinsic::fshl:
4858 case Intrinsic::fshr: {
4859 Value *ShAmtArg = ArgBegin[2];
4860 const APInt *ShAmtC;
4861 if (match(ShAmtArg, m_APInt(ShAmtC))) {
4862 // If there's effectively no shift, return the 1st arg or 2nd arg.
4863 // TODO: For vectors, we could check each element of a non-splat constant.
4864 APInt BitWidth = APInt(ShAmtC->getBitWidth(), ShAmtC->getBitWidth());
4865 if (ShAmtC->urem(BitWidth).isNullValue())
4866 return ArgBegin[IID == Intrinsic::fshl ? 0 : 1];
4867 }
4868 return nullptr;
4869 }
Matt Arsenault82606662017-01-11 00:57:54 +00004870 default:
4871 return nullptr;
4872 }
Michael Ilseman54857292013-02-07 19:26:05 +00004873}
4874
Chandler Carruth9dc35582012-12-28 11:30:55 +00004875template <typename IterTy>
Andrew Kaylor647025f2017-06-09 23:18:11 +00004876static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
4877 IterTy ArgEnd, const SimplifyQuery &Q,
4878 unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004879 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004880 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4881 Ty = PTy->getElementType();
4882 FunctionType *FTy = cast<FunctionType>(Ty);
4883
Dan Gohman85977e62011-11-04 18:32:42 +00004884 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004885 // call null -> undef
4886 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004887 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004888
Chandler Carruthf6182152012-12-28 14:23:29 +00004889 Function *F = dyn_cast<Function>(V);
4890 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004891 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004892
David Majnemer15032582015-05-22 03:56:46 +00004893 if (F->isIntrinsic())
Sanjay Patelf52eeb12018-07-29 14:42:08 +00004894 if (Value *Ret = simplifyIntrinsic(F, ArgBegin, ArgEnd, Q))
Michael Ilseman54857292013-02-07 19:26:05 +00004895 return Ret;
4896
Andrew Kaylor647025f2017-06-09 23:18:11 +00004897 if (!canConstantFoldCallTo(CS, F))
Craig Topper9f008862014-04-15 04:59:12 +00004898 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004899
4900 SmallVector<Constant *, 4> ConstantArgs;
4901 ConstantArgs.reserve(ArgEnd - ArgBegin);
4902 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4903 Constant *C = dyn_cast<Constant>(*I);
4904 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004905 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004906 ConstantArgs.push_back(C);
4907 }
4908
Andrew Kaylor647025f2017-06-09 23:18:11 +00004909 return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004910}
4911
Andrew Kaylor647025f2017-06-09 23:18:11 +00004912Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4913 User::op_iterator ArgBegin, User::op_iterator ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004914 const SimplifyQuery &Q) {
Andrew Kaylor647025f2017-06-09 23:18:11 +00004915 return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
4916}
4917
4918Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4919 ArrayRef<Value *> Args, const SimplifyQuery &Q) {
4920 return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004921}
4922
Philip Reames7a6db4f2017-12-27 00:16:12 +00004923Value *llvm::SimplifyCall(ImmutableCallSite ICS, const SimplifyQuery &Q) {
4924 CallSite CS(const_cast<Instruction*>(ICS.getInstruction()));
4925 return ::SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
4926 Q, RecursionLimit);
4927}
4928
Sanjay Patel472cc782016-01-11 22:14:42 +00004929/// See if we can compute a simplified version of this instruction.
4930/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004931
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004932Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004933 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004934 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004935 Value *Result;
4936
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004937 switch (I->getOpcode()) {
4938 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004939 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004940 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004941 case Instruction::FAdd:
4942 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004943 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004944 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004945 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004946 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4947 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004948 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004949 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004950 case Instruction::FSub:
4951 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004952 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004953 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004954 case Instruction::Sub:
4955 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4956 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004957 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004958 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004959 case Instruction::FMul:
4960 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004961 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004962 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004963 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004964 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004965 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004966 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004967 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004968 break;
4969 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004970 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004971 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004972 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004973 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004974 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00004975 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004976 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004977 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004978 break;
4979 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004980 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004981 break;
4982 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004983 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004984 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004985 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004986 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004987 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4988 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004989 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004990 break;
4991 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004992 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004993 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004994 break;
4995 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004996 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004997 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004998 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004999 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005000 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005001 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005002 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005003 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005004 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00005005 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005006 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00005007 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005008 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005009 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
5010 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005011 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005012 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005013 Result =
5014 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
5015 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005016 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00005017 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00005018 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005019 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005020 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00005021 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005022 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00005023 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005024 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005025 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00005026 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00005027 case Instruction::InsertValue: {
5028 InsertValueInst *IV = cast<InsertValueInst>(I);
5029 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
5030 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005031 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00005032 break;
5033 }
Igor Laevskye0edb662017-12-13 11:21:18 +00005034 case Instruction::InsertElement: {
5035 auto *IE = cast<InsertElementInst>(I);
5036 Result = SimplifyInsertElementInst(IE->getOperand(0), IE->getOperand(1),
5037 IE->getOperand(2), Q);
5038 break;
5039 }
David Majnemer25a796e2015-07-13 01:15:46 +00005040 case Instruction::ExtractValue: {
5041 auto *EVI = cast<ExtractValueInst>(I);
5042 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005043 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00005044 break;
5045 }
David Majnemer599ca442015-07-13 01:15:53 +00005046 case Instruction::ExtractElement: {
5047 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005048 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
5049 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00005050 break;
5051 }
Zvi Rackover8f460652017-04-03 22:05:30 +00005052 case Instruction::ShuffleVector: {
5053 auto *SVI = cast<ShuffleVectorInst>(I);
5054 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005055 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00005056 break;
5057 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00005058 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005059 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00005060 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00005061 case Instruction::Call: {
5062 CallSite CS(cast<CallInst>(I));
Philip Reames7a6db4f2017-12-27 00:16:12 +00005063 Result = SimplifyCall(CS, Q);
Dan Gohman85977e62011-11-04 18:32:42 +00005064 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00005065 }
David Majnemer6774d612016-07-26 17:58:05 +00005066#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
5067#include "llvm/IR/Instruction.def"
5068#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00005069 Result =
5070 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00005071 break;
Craig Topper81c03a72017-04-12 22:54:24 +00005072 case Instruction::Alloca:
5073 // No simplifications for Alloca and it can't be constant folded.
5074 Result = nullptr;
5075 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005076 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00005077
Hal Finkelf2199b22015-10-23 20:37:08 +00005078 // In general, it is possible for computeKnownBits to determine all bits in a
5079 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00005080 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Craig Topper8205a1a2017-05-24 16:53:07 +00005081 KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00005082 if (Known.isConstant())
5083 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00005084 }
5085
Duncan Sands64e41cf2010-11-17 08:35:29 +00005086 /// If called on unreachable code, the above logic may report that the
5087 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00005088 /// detecting that case here, returning a safe value instead.
5089 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00005090}
5091
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00005092/// Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005093/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00005094///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005095/// This is the common implementation of the recursive simplification routines.
5096/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
5097/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
5098/// instructions to process and attempt to simplify it using
5099/// InstructionSimplify.
5100///
5101/// This routine returns 'true' only when *it* simplifies something. The passed
5102/// in simplified value does not count toward this.
5103static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005104 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005105 const DominatorTree *DT,
5106 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005107 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005108 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005109 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00005110
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005111 // If we have an explicit value to collapse to, do that round of the
5112 // simplification loop by hand initially.
5113 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00005114 for (User *U : I->users())
5115 if (U != I)
5116 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00005117
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005118 // Replace the instruction with its simplified value.
5119 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00005120
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005121 // Gracefully handle edge cases where the instruction is not wired into any
5122 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00005123 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
5124 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005125 I->eraseFromParent();
5126 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005127 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00005128 }
Duncan Sands7e800d62010-11-14 11:23:23 +00005129
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00005130 // Note that we must test the size on each iteration, the worklist can grow.
5131 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
5132 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00005133
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005134 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005135 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005136 if (!SimpleV)
5137 continue;
5138
5139 Simplified = true;
5140
5141 // Stash away all the uses of the old instruction so we can check them for
5142 // recursive simplifications after a RAUW. This is cheaper than checking all
5143 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005144 for (User *U : I->users())
5145 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005146
5147 // Replace the instruction with its simplified value.
5148 I->replaceAllUsesWith(SimpleV);
5149
5150 // Gracefully handle edge cases where the instruction is not wired into any
5151 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00005152 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
5153 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005154 I->eraseFromParent();
5155 }
5156 return Simplified;
5157}
5158
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005159bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005160 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005161 const DominatorTree *DT,
5162 AssumptionCache *AC) {
5163 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005164}
5165
5166bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005167 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005168 const DominatorTree *DT,
5169 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00005170 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
5171 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00005172 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00005173}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00005174
5175namespace llvm {
5176const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
5177 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
5178 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
5179 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
5180 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
5181 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
5182 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
5183 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5184}
5185
5186const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
5187 const DataLayout &DL) {
5188 return {DL, &AR.TLI, &AR.DT, &AR.AC};
5189}
5190
5191template <class T, class... TArgs>
5192const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
5193 Function &F) {
5194 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
5195 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
5196 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
5197 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5198}
5199template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
5200 Function &);
5201}