blob: 05afc4f55012a45eb099a38be707db46f611151f [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"
Sanjay Patel54656ca2017-02-06 18:26:06 +000030#include "llvm/Analysis/OptimizationDiagnosticInfo.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000031#include "llvm/Analysis/ValueTracking.h"
David Majnemer599ca442015-07-13 01:15:53 +000032#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000033#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000034#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000035#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000036#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000037#include "llvm/IR/GlobalAlias.h"
38#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000039#include "llvm/IR/PatternMatch.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000040#include "llvm/IR/ValueHandle.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000041#include "llvm/Support/KnownBits.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000042#include <algorithm>
Chris Lattner084a1b52009-11-09 22:57:59 +000043using namespace llvm;
Chris Lattnera71e9d62009-11-10 00:55:12 +000044using namespace llvm::PatternMatch;
Chris Lattner084a1b52009-11-09 22:57:59 +000045
Chandler Carruthf1221bd2014-04-22 02:48:03 +000046#define DEBUG_TYPE "instsimplify"
47
Chris Lattner9e4aa022011-02-09 17:15:04 +000048enum { RecursionLimit = 3 };
Duncan Sandsf3b1bf12010-11-10 18:23:01 +000049
Duncan Sands3547d2e2010-12-22 09:40:51 +000050STATISTIC(NumExpand, "Number of expansions");
Duncan Sands3547d2e2010-12-22 09:40:51 +000051STATISTIC(NumReassoc, "Number of reassociations");
52
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000053static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
54static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000055 unsigned);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +000056static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000057 const SimplifyQuery &, unsigned);
58static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000059 unsigned);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +000060static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000061 const SimplifyQuery &Q, unsigned MaxRecurse);
62static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
63static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
David Majnemer6774d612016-07-26 17:58:05 +000064static Value *SimplifyCastInst(unsigned, Value *, Type *,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000065 const SimplifyQuery &, unsigned);
Duncan Sands5ffc2982010-11-16 12:16:38 +000066
Sanjay Patel35ed2412017-04-16 17:43:11 +000067/// For a boolean type or a vector of boolean type, return false or a vector
68/// with every element false.
Duncan Sandsc1c92712011-07-26 15:03:53 +000069static Constant *getFalse(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +000070 return ConstantInt::getFalse(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +000071}
72
Sanjay Patel35ed2412017-04-16 17:43:11 +000073/// For a boolean type or a vector of boolean type, return true or a vector
74/// with every element true.
Duncan Sandsc1c92712011-07-26 15:03:53 +000075static Constant *getTrue(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +000076 return ConstantInt::getTrue(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +000077}
78
Duncan Sands3d5692a2011-10-30 19:56:36 +000079/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
80static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
81 Value *RHS) {
82 CmpInst *Cmp = dyn_cast<CmpInst>(V);
83 if (!Cmp)
84 return false;
85 CmpInst::Predicate CPred = Cmp->getPredicate();
86 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
87 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
88 return true;
89 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
90 CRHS == LHS;
91}
92
Sanjay Patel472cc782016-01-11 22:14:42 +000093/// Does the given value dominate the specified phi node?
Duncan Sands5ffc2982010-11-16 12:16:38 +000094static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
95 Instruction *I = dyn_cast<Instruction>(V);
96 if (!I)
97 // Arguments and constants dominate all instructions.
98 return true;
99
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000100 // If we are processing instructions (and/or basic blocks) that have not been
101 // fully added to a function, the parent nodes may still be null. Simply
102 // return the conservative answer in these cases.
103 if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
104 return false;
105
Duncan Sands5ffc2982010-11-16 12:16:38 +0000106 // If we have a DominatorTree then do a precise test.
Daniel Berlin71ff6632017-05-31 01:47:24 +0000107 if (DT)
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000108 return DT->dominates(I, P);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000109
David Majnemer8a1c45d2015-12-12 05:38:55 +0000110 // Otherwise, if the instruction is in the entry block and is not an invoke,
111 // then it obviously dominates all phi nodes.
Duncan Sands5ffc2982010-11-16 12:16:38 +0000112 if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000113 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000114 return true;
115
116 return false;
117}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000118
Sanjay Patel472cc782016-01-11 22:14:42 +0000119/// Simplify "A op (B op' C)" by distributing op over op', turning it into
120/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000121/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
122/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
123/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000124static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
Craig Topper9c913bf2017-05-19 16:56:53 +0000125 Instruction::BinaryOps OpcodeToExpand,
126 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000127 // Recursion is always used, so bail out at once if we already hit the limit.
128 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000129 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000130
131 // Check whether the expression has the form "(A op' B) op C".
132 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
133 if (Op0->getOpcode() == OpcodeToExpand) {
134 // It does! Try turning it into "(A op C) op' (B op C)".
135 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
136 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000137 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
138 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000139 // They do! Return "L op' R" if it simplifies or is already available.
140 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000141 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
142 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000143 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000144 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000145 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000146 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000147 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000148 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000149 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000150 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000151 }
152 }
153
154 // Check whether the expression has the form "A op (B op' C)".
155 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
156 if (Op1->getOpcode() == OpcodeToExpand) {
157 // It does! Try turning it into "(A op B) op' (A op C)".
158 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
159 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000160 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
161 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000162 // They do! Return "L op' R" if it simplifies or is already available.
163 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000164 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
165 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000166 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000167 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000168 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000169 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000170 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000171 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000172 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000173 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000174 }
175 }
176
Craig Topper9f008862014-04-15 04:59:12 +0000177 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000178}
179
Sanjay Patel472cc782016-01-11 22:14:42 +0000180/// Generic simplifications for associative binary operations.
181/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000182static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
Craig Topper9c913bf2017-05-19 16:56:53 +0000183 Value *LHS, Value *RHS,
184 const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000185 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000186 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
187
188 // Recursion is always used, so bail out at once if we already hit the limit.
189 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000190 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000191
192 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
193 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
194
195 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
196 if (Op0 && Op0->getOpcode() == Opcode) {
197 Value *A = Op0->getOperand(0);
198 Value *B = Op0->getOperand(1);
199 Value *C = RHS;
200
201 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000202 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000203 // It does! Return "A op V" if it simplifies or is already available.
204 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000205 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000206 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000207 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000208 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000209 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000210 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000211 }
212 }
213
214 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
215 if (Op1 && Op1->getOpcode() == Opcode) {
216 Value *A = LHS;
217 Value *B = Op1->getOperand(0);
218 Value *C = Op1->getOperand(1);
219
220 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000221 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000222 // It does! Return "V op C" if it simplifies or is already available.
223 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000224 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000225 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000226 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000227 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000228 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000229 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000230 }
231 }
232
233 // The remaining transforms require commutativity as well as associativity.
234 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000235 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000236
237 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
238 if (Op0 && Op0->getOpcode() == Opcode) {
239 Value *A = Op0->getOperand(0);
240 Value *B = Op0->getOperand(1);
241 Value *C = RHS;
242
243 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000244 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000245 // It does! Return "V op B" if it simplifies or is already available.
246 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000247 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000248 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000249 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000250 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000251 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000252 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000253 }
254 }
255
256 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
257 if (Op1 && Op1->getOpcode() == Opcode) {
258 Value *A = LHS;
259 Value *B = Op1->getOperand(0);
260 Value *C = Op1->getOperand(1);
261
262 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000263 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000264 // It does! Return "B op V" if it simplifies or is already available.
265 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000266 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000267 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000268 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000269 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000270 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000271 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000272 }
273 }
274
Craig Topper9f008862014-04-15 04:59:12 +0000275 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000276}
277
Sanjay Patel472cc782016-01-11 22:14:42 +0000278/// In the case of a binary operation with a select instruction as an operand,
279/// try to simplify the binop by seeing whether evaluating it on both branches
280/// of the select results in the same value. Returns the common value if so,
281/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000282static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000283 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000284 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000285 // Recursion is always used, so bail out at once if we already hit the limit.
286 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000287 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000288
Duncan Sandsb0579e92010-11-10 13:00:08 +0000289 SelectInst *SI;
290 if (isa<SelectInst>(LHS)) {
291 SI = cast<SelectInst>(LHS);
292 } else {
293 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
294 SI = cast<SelectInst>(RHS);
295 }
296
297 // Evaluate the BinOp on the true and false branches of the select.
298 Value *TV;
299 Value *FV;
300 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000301 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
302 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000303 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000304 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
305 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000306 }
307
Duncan Sandse3c53952011-01-01 16:12:09 +0000308 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000309 // If they both failed to simplify then return null.
310 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000311 return TV;
312
313 // If one branch simplified to undef, return the other one.
314 if (TV && isa<UndefValue>(TV))
315 return FV;
316 if (FV && isa<UndefValue>(FV))
317 return TV;
318
319 // If applying the operation did not change the true and false select values,
320 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000321 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000322 return SI;
323
324 // If one branch simplified and the other did not, and the simplified
325 // value is equal to the unsimplified one, return the simplified value.
326 // For example, select (cond, X, X & Z) & Z -> X & Z.
327 if ((FV && !TV) || (TV && !FV)) {
328 // Check that the simplified value has the form "X op Y" where "op" is the
329 // same as the original operation.
330 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
331 if (Simplified && Simplified->getOpcode() == Opcode) {
332 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
333 // We already know that "op" is the same as for the simplified value. See
334 // if the operands match too. If so, return the simplified value.
335 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
336 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
337 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000338 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
339 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000340 return Simplified;
341 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000342 Simplified->getOperand(1) == UnsimplifiedLHS &&
343 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000344 return Simplified;
345 }
346 }
347
Craig Topper9f008862014-04-15 04:59:12 +0000348 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000349}
350
Sanjay Patel472cc782016-01-11 22:14:42 +0000351/// In the case of a comparison with a select instruction, try to simplify the
352/// comparison by seeing whether both branches of the select result in the same
353/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000354static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000355 Value *RHS, const SimplifyQuery &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000356 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000357 // Recursion is always used, so bail out at once if we already hit the limit.
358 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000359 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000360
Duncan Sandsb0579e92010-11-10 13:00:08 +0000361 // Make sure the select is on the LHS.
362 if (!isa<SelectInst>(LHS)) {
363 std::swap(LHS, RHS);
364 Pred = CmpInst::getSwappedPredicate(Pred);
365 }
366 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
367 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000368 Value *Cond = SI->getCondition();
369 Value *TV = SI->getTrueValue();
370 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000371
Duncan Sands06504022011-02-03 09:37:39 +0000372 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000373 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000374 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000375 if (TCmp == Cond) {
376 // It not only simplified, it simplified to the select condition. Replace
377 // it with 'true'.
378 TCmp = getTrue(Cond->getType());
379 } else if (!TCmp) {
380 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
381 // condition then we can replace it with 'true'. Otherwise give up.
382 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000383 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000384 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000385 }
386
Duncan Sands3d5692a2011-10-30 19:56:36 +0000387 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000388 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000389 if (FCmp == Cond) {
390 // It not only simplified, it simplified to the select condition. Replace
391 // it with 'false'.
392 FCmp = getFalse(Cond->getType());
393 } else if (!FCmp) {
394 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
395 // condition then we can replace it with 'false'. Otherwise give up.
396 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000397 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000398 FCmp = getFalse(Cond->getType());
399 }
400
401 // If both sides simplified to the same value, then use it as the result of
402 // the original comparison.
403 if (TCmp == FCmp)
404 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000405
406 // The remaining cases only make sense if the select condition has the same
407 // type as the result of the comparison, so bail out if this is not so.
408 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000409 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000410 // If the false value simplified to false, then the result of the compare
411 // is equal to "Cond && TCmp". This also catches the case when the false
412 // value simplified to false and the true value to true, returning "Cond".
413 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000414 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000415 return V;
416 // If the true value simplified to true, then the result of the compare
417 // is equal to "Cond || FCmp".
418 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000419 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000420 return V;
421 // Finally, if the false value simplified to true and the true value to
422 // false, then the result of the compare is equal to "!Cond".
423 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
424 if (Value *V =
425 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000426 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000427 return V;
428
Craig Topper9f008862014-04-15 04:59:12 +0000429 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000430}
431
Sanjay Patel472cc782016-01-11 22:14:42 +0000432/// In the case of a binary operation with an operand that is a PHI instruction,
433/// try to simplify the binop by seeing whether evaluating it on the incoming
434/// phi values yields the same result for every value. If so returns the common
435/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000436static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000437 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000438 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000439 // Recursion is always used, so bail out at once if we already hit the limit.
440 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000441 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000442
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000443 PHINode *PI;
444 if (isa<PHINode>(LHS)) {
445 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000446 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000447 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000448 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000449 } else {
450 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
451 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000452 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000453 if (!ValueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000454 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000455 }
456
457 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000458 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000459 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000460 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000461 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000462 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000463 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
464 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000465 // If the operation failed to simplify, or simplified to a different value
466 // to previously, then give up.
467 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000468 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000469 CommonValue = V;
470 }
471
472 return CommonValue;
473}
474
Sanjay Patel472cc782016-01-11 22:14:42 +0000475/// In the case of a comparison with a PHI instruction, try to simplify the
476/// comparison by seeing whether comparing with all of the incoming phi values
477/// yields the same result every time. If so returns the common result,
478/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000479static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000480 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000481 // Recursion is always used, so bail out at once if we already hit the limit.
482 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000483 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000484
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000485 // Make sure the phi is on the LHS.
486 if (!isa<PHINode>(LHS)) {
487 std::swap(LHS, RHS);
488 Pred = CmpInst::getSwappedPredicate(Pred);
489 }
490 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
491 PHINode *PI = cast<PHINode>(LHS);
492
Duncan Sands5ffc2982010-11-16 12:16:38 +0000493 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000494 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000495 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000496
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000497 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000498 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000499 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000500 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000501 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000502 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000503 // If the operation failed to simplify, or simplified to a different value
504 // to previously, then give up.
505 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000506 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000507 CommonValue = V;
508 }
509
510 return CommonValue;
511}
512
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000513static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
514 Value *&Op0, Value *&Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000515 const SimplifyQuery &Q) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000516 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
517 if (auto *CRHS = dyn_cast<Constant>(Op1))
518 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
519
520 // Canonicalize the constant to the RHS if this is a commutative operation.
521 if (Instruction::isCommutative(Opcode))
522 std::swap(Op0, Op1);
523 }
524 return nullptr;
525}
526
Sanjay Patel472cc782016-01-11 22:14:42 +0000527/// Given operands for an Add, see if we can fold the result.
528/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000529static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000530 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000531 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
532 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000533
Duncan Sands0a2c41682010-12-15 14:07:39 +0000534 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000535 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000536 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000537
Duncan Sands0a2c41682010-12-15 14:07:39 +0000538 // X + 0 -> X
539 if (match(Op1, m_Zero()))
540 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000541
Duncan Sands0a2c41682010-12-15 14:07:39 +0000542 // X + (Y - X) -> Y
543 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000544 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000545 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000546 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
547 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000548 return Y;
549
550 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000551 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000552 if (match(Op0, m_Not(m_Specific(Op1))) ||
553 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000554 return Constant::getAllOnesValue(Ty);
555
Craig Topperbcfd2d12017-04-20 16:56:25 +0000556 // add nsw/nuw (xor Y, signmask), signmask --> Y
Sanjay Patelfe672552017-02-18 21:59:09 +0000557 // The no-wrapping add guarantees that the top bit will be set by the add.
558 // Therefore, the xor must be clearing the already set sign bit of Y.
Craig Topperbcfd2d12017-04-20 16:56:25 +0000559 if ((isNSW || isNUW) && match(Op1, m_SignMask()) &&
560 match(Op0, m_Xor(m_Value(Y), m_SignMask())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000561 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000562
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000563 /// i1 add -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000564 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000565 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000566 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000567
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000568 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000569 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000570 MaxRecurse))
571 return V;
572
Duncan Sandsb238de02010-11-19 09:20:39 +0000573 // Threading Add over selects and phi nodes is pointless, so don't bother.
574 // Threading over the select in "A + select(cond, B, C)" means evaluating
575 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
576 // only if B and C are equal. If B and C are equal then (since we assume
577 // that operands have already been simplified) "select(cond, B, C)" should
578 // have been simplified to the common value of B and C already. Analysing
579 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
580 // for threading over phi nodes.
581
Craig Topper9f008862014-04-15 04:59:12 +0000582 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000583}
584
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000585Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000586 const SimplifyQuery &Query) {
587 return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, Query, RecursionLimit);
588}
589
Chandler Carrutha0796552012-03-12 11:19:31 +0000590/// \brief Compute the base pointer and cumulative constant offsets for V.
591///
592/// This strips all constant offsets off of V, leaving it the base pointer, and
593/// accumulates the total constant offset applied in the returned constant. It
594/// returns 0 if V is not a pointer, and returns the constant '0' if there are
595/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000596///
597/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
598/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
599/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000600static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000601 bool AllowNonInbounds = false) {
Craig Topper95d23472017-07-09 07:04:00 +0000602 assert(V->getType()->isPtrOrPtrVectorTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000603
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000604 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000605 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000606
607 // Even though we don't look through PHI nodes, we could be called on an
608 // instruction in an unreachable block, which may be on a cycle.
609 SmallPtrSet<Value *, 4> Visited;
610 Visited.insert(V);
611 do {
612 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000613 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000614 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000615 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000616 V = GEP->getPointerOperand();
617 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000618 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000619 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000620 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000621 break;
622 V = GA->getAliasee();
623 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000624 if (auto CS = CallSite(V))
625 if (Value *RV = CS.getReturnedArgOperand()) {
626 V = RV;
627 continue;
628 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000629 break;
630 }
Craig Topper95d23472017-07-09 07:04:00 +0000631 assert(V->getType()->isPtrOrPtrVectorTy() && "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000632 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000633
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000634 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
635 if (V->getType()->isVectorTy())
636 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
637 OffsetIntPtr);
638 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000639}
640
641/// \brief Compute the constant difference between two pointer values.
642/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000643static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
644 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000645 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
646 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000647
648 // If LHS and RHS are not related via constant offsets to the same base
649 // value, there is nothing we can do here.
650 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000651 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000652
653 // Otherwise, the difference of LHS - RHS can be computed as:
654 // LHS - RHS
655 // = (LHSOffset + Base) - (RHSOffset + Base)
656 // = LHSOffset - RHSOffset
657 return ConstantExpr::getSub(LHSOffset, RHSOffset);
658}
659
Sanjay Patel472cc782016-01-11 22:14:42 +0000660/// Given operands for a Sub, see if we can fold the result.
661/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000662static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000663 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000664 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
665 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000666
667 // X - undef -> undef
668 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000669 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000670 return UndefValue::get(Op0->getType());
671
672 // X - 0 -> X
673 if (match(Op1, m_Zero()))
674 return Op0;
675
676 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000677 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000678 return Constant::getNullValue(Op0->getType());
679
Sanjay Patelefd88852016-10-19 21:23:45 +0000680 // Is this a negation?
681 if (match(Op0, m_Zero())) {
682 // 0 - X -> 0 if the sub is NUW.
683 if (isNUW)
684 return Op0;
685
Craig Topper8205a1a2017-05-24 16:53:07 +0000686 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +0000687 if (Known.Zero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000688 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
689 // Op1 must be 0 because negating the minimum signed value is undefined.
690 if (isNSW)
691 return Op0;
692
693 // 0 - X -> X if X is 0 or the minimum signed value.
694 return Op1;
695 }
696 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000697
Duncan Sands99589d02011-01-18 11:50:19 +0000698 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
699 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000700 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000701 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
702 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000703 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000704 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000705 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000706 // It does, we successfully reassociated!
707 ++NumReassoc;
708 return W;
709 }
710 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000711 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000712 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000713 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000714 // It does, we successfully reassociated!
715 ++NumReassoc;
716 return W;
717 }
718 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000719
Duncan Sands99589d02011-01-18 11:50:19 +0000720 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
721 // For example, X - (X + 1) -> -1
722 X = Op0;
723 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
724 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000725 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000726 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000727 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000728 // It does, we successfully reassociated!
729 ++NumReassoc;
730 return W;
731 }
732 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000733 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000734 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000735 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000736 // It does, we successfully reassociated!
737 ++NumReassoc;
738 return W;
739 }
740 }
741
742 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
743 // For example, X - (X - Y) -> Y.
744 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000745 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
746 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000747 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000748 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000749 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000750 // It does, we successfully reassociated!
751 ++NumReassoc;
752 return W;
753 }
754
Duncan Sands395ac42d2012-03-13 14:07:05 +0000755 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
756 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
757 match(Op1, m_Trunc(m_Value(Y))))
758 if (X->getType() == Y->getType())
759 // See if "V === X - Y" simplifies.
760 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
761 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000762 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
763 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000764 // It does, return the simplified "trunc V".
765 return W;
766
767 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000768 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000769 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000770 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000771 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
772
Duncan Sands99589d02011-01-18 11:50:19 +0000773 // i1 sub -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000774 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000775 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000776 return V;
777
Duncan Sands0a2c41682010-12-15 14:07:39 +0000778 // Threading Sub over selects and phi nodes is pointless, so don't bother.
779 // Threading over the select in "A - select(cond, B, C)" means evaluating
780 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
781 // only if B and C are equal. If B and C are equal then (since we assume
782 // that operands have already been simplified) "select(cond, B, C)" should
783 // have been simplified to the common value of B and C already. Analysing
784 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
785 // for threading over phi nodes.
786
Craig Topper9f008862014-04-15 04:59:12 +0000787 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000788}
789
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000790Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000791 const SimplifyQuery &Q) {
792 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
793}
794
Sanjay Patel472cc782016-01-11 22:14:42 +0000795/// Given operands for a Mul, see if we can fold the result.
796/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000797static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000798 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000799 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
800 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000801
802 // X * undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000803 if (match(Op1, m_Undef()))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000804 return Constant::getNullValue(Op0->getType());
805
806 // X * 0 -> 0
807 if (match(Op1, m_Zero()))
808 return Op1;
809
810 // X * 1 -> X
811 if (match(Op1, m_One()))
812 return Op0;
813
Duncan Sandsb67edc62011-01-30 18:03:50 +0000814 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000815 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000816 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
817 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
818 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000819
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000820 // i1 mul -> and.
Craig Topperfde47232017-07-09 07:04:03 +0000821 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000822 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000823 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000824
825 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000826 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000827 MaxRecurse))
828 return V;
829
830 // Mul distributes over Add. Try some generic simplifications based on this.
831 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000832 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000833 return V;
834
835 // If the operation is with the result of a select instruction, check whether
836 // operating on either branch of the select always yields the same value.
837 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000838 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000839 MaxRecurse))
840 return V;
841
842 // If the operation is with the result of a phi instruction, check whether
843 // operating on all incoming values of the phi always yields the same value.
844 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000845 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000846 MaxRecurse))
847 return V;
848
Craig Topper9f008862014-04-15 04:59:12 +0000849 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000850}
851
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000852Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
853 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
854}
855
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000856/// Check for common or similar folds of integer division or integer remainder.
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000857/// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000858static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
859 Type *Ty = Op0->getType();
860
861 // X / undef -> undef
862 // X % undef -> undef
863 if (match(Op1, m_Undef()))
864 return Op1;
865
866 // X / 0 -> undef
867 // X % 0 -> undef
868 // We don't need to preserve faults!
869 if (match(Op1, m_Zero()))
870 return UndefValue::get(Ty);
871
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000872 // If any element of a constant divisor vector is zero, the whole op is undef.
873 auto *Op1C = dyn_cast<Constant>(Op1);
874 if (Op1C && Ty->isVectorTy()) {
875 unsigned NumElts = Ty->getVectorNumElements();
876 for (unsigned i = 0; i != NumElts; ++i) {
877 Constant *Elt = Op1C->getAggregateElement(i);
878 if (Elt && Elt->isNullValue())
879 return UndefValue::get(Ty);
880 }
881 }
882
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000883 // undef / X -> 0
884 // undef % X -> 0
885 if (match(Op0, m_Undef()))
886 return Constant::getNullValue(Ty);
887
888 // 0 / X -> 0
889 // 0 % X -> 0
890 if (match(Op0, m_Zero()))
891 return Op0;
892
893 // X / X -> 1
894 // X % X -> 0
895 if (Op0 == Op1)
896 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
897
898 // X / 1 -> X
899 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +0000900 // If this is a boolean op (single-bit element type), we can't have
901 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
Craig Topperfde47232017-07-09 07:04:03 +0000902 if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000903 return IsDiv ? Op0 : Constant::getNullValue(Ty);
904
905 return nullptr;
906}
907
Sanjay Patelcca8f782017-09-14 14:09:11 +0000908/// Given a predicate and two operands, return true if the comparison is true.
909/// This is a helper for div/rem simplification where we return some other value
910/// when we can prove a relationship between the operands.
911static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
912 const SimplifyQuery &Q, unsigned MaxRecurse) {
913 Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
914 Constant *C = dyn_cast_or_null<Constant>(V);
915 return (C && C->isAllOnesValue());
916}
917
918/// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
919/// to simplify X % Y to X.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000920static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
Sanjay Patelcca8f782017-09-14 14:09:11 +0000921 unsigned MaxRecurse, bool IsSigned) {
922 // Recursion is always used, so bail out at once if we already hit the limit.
923 if (!MaxRecurse--)
924 return false;
925
926 if (IsSigned) {
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000927 // |X| / |Y| --> 0
928 //
929 // We require that 1 operand is a simple constant. That could be extended to
930 // 2 variables if we computed the sign bit for each.
931 //
932 // Make sure that a constant is not the minimum signed value because taking
933 // the abs() of that is undefined.
934 Type *Ty = X->getType();
935 const APInt *C;
936 if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
937 // Is the variable divisor magnitude always greater than the constant
938 // dividend magnitude?
939 // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
940 Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
941 Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
942 if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
943 isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
944 return true;
945 }
946 if (match(Y, m_APInt(C))) {
947 // Special-case: we can't take the abs() of a minimum signed value. If
948 // that's the divisor, then all we have to do is prove that the dividend
949 // is also not the minimum signed value.
950 if (C->isMinSignedValue())
951 return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
952
953 // Is the variable dividend magnitude always less than the constant
954 // divisor magnitude?
955 // |X| < |C| --> X > -abs(C) and X < abs(C)
956 Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
957 Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
958 if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
959 isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
960 return true;
961 }
Sanjay Patelcca8f782017-09-14 14:09:11 +0000962 return false;
963 }
964
965 // IsSigned == false.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000966 // Is the dividend unsigned less than the divisor?
967 return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
Sanjay Patelcca8f782017-09-14 14:09:11 +0000968}
969
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000970/// These are simplifications common to SDiv and UDiv.
971static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000972 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000973 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
974 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +0000975
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000976 if (Value *V = simplifyDivRem(Op0, Op1, true))
977 return V;
978
Sanjay Patelcca8f782017-09-14 14:09:11 +0000979 bool IsSigned = Opcode == Instruction::SDiv;
Duncan Sands65995fa2011-01-28 18:50:50 +0000980
Duncan Sands771e82a2011-01-28 16:51:11 +0000981 // (X * Y) / Y -> X if the multiplication does not overflow.
Craig Topper9f008862014-04-15 04:59:12 +0000982 Value *X = nullptr, *Y = nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +0000983 if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
984 if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
Duncan Sands7cb61e52011-10-27 19:16:21 +0000985 OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
Duncan Sands5747aba2011-02-02 20:52:00 +0000986 // If the Mul knows it does not overflow, then we are good to go.
Sanjay Patelcca8f782017-09-14 14:09:11 +0000987 if ((IsSigned && Mul->hasNoSignedWrap()) ||
988 (!IsSigned && Mul->hasNoUnsignedWrap()))
Duncan Sands5747aba2011-02-02 20:52:00 +0000989 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +0000990 // If X has the form X = A / Y then X * Y cannot overflow.
991 if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
992 if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
993 return X;
994 }
995
Duncan Sands65995fa2011-01-28 18:50:50 +0000996 // (X rem Y) / Y -> 0
Sanjay Patelcca8f782017-09-14 14:09:11 +0000997 if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
998 (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
Duncan Sands65995fa2011-01-28 18:50:50 +0000999 return Constant::getNullValue(Op0->getType());
1000
David Majnemercb9d5962014-10-11 10:20:01 +00001001 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1002 ConstantInt *C1, *C2;
Sanjay Patelcca8f782017-09-14 14:09:11 +00001003 if (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
David Majnemercb9d5962014-10-11 10:20:01 +00001004 match(Op1, m_ConstantInt(C2))) {
1005 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001006 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001007 if (Overflow)
1008 return Constant::getNullValue(Op0->getType());
1009 }
1010
Duncan Sands65995fa2011-01-28 18:50:50 +00001011 // If the operation is with the result of a select instruction, check whether
1012 // operating on either branch of the select always yields the same value.
1013 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001014 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001015 return V;
1016
1017 // If the operation is with the result of a phi instruction, check whether
1018 // operating on all incoming values of the phi always yields the same value.
1019 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001020 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001021 return V;
1022
Sanjay Patelcca8f782017-09-14 14:09:11 +00001023 if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1024 return Constant::getNullValue(Op0->getType());
1025
Craig Topper9f008862014-04-15 04:59:12 +00001026 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001027}
1028
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001029/// These are simplifications common to SRem and URem.
1030static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001031 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001032 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1033 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001034
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001035 if (Value *V = simplifyDivRem(Op0, Op1, false))
1036 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001037
David Majnemerb435a422014-09-17 04:16:35 +00001038 // (X % Y) % Y -> X % Y
1039 if ((Opcode == Instruction::SRem &&
1040 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1041 (Opcode == Instruction::URem &&
1042 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001043 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001044
Duncan Sandsa3e36992011-05-02 16:27:02 +00001045 // If the operation is with the result of a select instruction, check whether
1046 // operating on either branch of the select always yields the same value.
1047 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001048 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001049 return V;
1050
1051 // If the operation is with the result of a phi instruction, check whether
1052 // operating on all incoming values of the phi always yields the same value.
1053 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001054 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001055 return V;
1056
Sanjay Patelcca8f782017-09-14 14:09:11 +00001057 // If X / Y == 0, then X % Y == X.
1058 if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1059 return Op0;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001060
1061 return nullptr;
1062}
1063
1064/// Given operands for an SDiv, see if we can fold the result.
1065/// If not, this returns null.
1066static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1067 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001068 return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001069}
1070
1071Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1072 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1073}
1074
1075/// Given operands for a UDiv, see if we can fold the result.
1076/// If not, this returns null.
1077static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1078 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001079 return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001080}
1081
1082Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1083 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1084}
1085
Sanjay Patel472cc782016-01-11 22:14:42 +00001086/// Given operands for an SRem, see if we can fold the result.
1087/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001088static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001089 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001090 return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001091}
1092
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001093Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1094 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1095}
1096
Sanjay Patel472cc782016-01-11 22:14:42 +00001097/// Given operands for a URem, see if we can fold the result.
1098/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001099static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001100 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001101 return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001102}
1103
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001104Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1105 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1106}
1107
Sanjay Patel472cc782016-01-11 22:14:42 +00001108/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001109static bool isUndefShift(Value *Amount) {
1110 Constant *C = dyn_cast<Constant>(Amount);
1111 if (!C)
1112 return false;
1113
1114 // X shift by undef -> undef because it may shift by the bitwidth.
1115 if (isa<UndefValue>(C))
1116 return true;
1117
1118 // Shifting by the bitwidth or more is undefined.
1119 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1120 if (CI->getValue().getLimitedValue() >=
1121 CI->getType()->getScalarSizeInBits())
1122 return true;
1123
1124 // If all lanes of a vector shift are undefined the whole shift is.
1125 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1126 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1127 if (!isUndefShift(C->getAggregateElement(I)))
1128 return false;
1129 return true;
1130 }
1131
1132 return false;
1133}
1134
Sanjay Patel472cc782016-01-11 22:14:42 +00001135/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1136/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001137static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001138 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001139 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1140 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001141
Duncan Sands571fd9a2011-01-14 14:44:12 +00001142 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001143 if (match(Op0, m_Zero()))
1144 return Op0;
1145
Duncan Sands571fd9a2011-01-14 14:44:12 +00001146 // X shift by 0 -> X
Duncan Sands7f60dc12011-01-14 00:37:45 +00001147 if (match(Op1, m_Zero()))
1148 return Op0;
1149
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001150 // Fold undefined shifts.
1151 if (isUndefShift(Op1))
1152 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001153
Duncan Sands571fd9a2011-01-14 14:44:12 +00001154 // If the operation is with the result of a select instruction, check whether
1155 // operating on either branch of the select always yields the same value.
1156 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001157 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001158 return V;
1159
1160 // If the operation is with the result of a phi instruction, check whether
1161 // operating on all incoming values of the phi always yields the same value.
1162 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001163 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001164 return V;
1165
Sanjay Patel6786bc52016-05-10 20:46:54 +00001166 // If any bits in the shift amount make that value greater than or equal to
1167 // the number of bits in the type, the shift is undefined.
Craig Topper8205a1a2017-05-24 16:53:07 +00001168 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1169 if (Known.One.getLimitedValue() >= Known.getBitWidth())
Sanjay Patel6786bc52016-05-10 20:46:54 +00001170 return UndefValue::get(Op0->getType());
1171
1172 // If all valid bits in the shift amount are known zero, the first operand is
1173 // unchanged.
Craig Topper8205a1a2017-05-24 16:53:07 +00001174 unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
Craig Topper8df66c62017-05-12 17:20:30 +00001175 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001176 return Op0;
1177
Craig Topper9f008862014-04-15 04:59:12 +00001178 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001179}
1180
David Majnemerbf7550e2014-11-05 00:59:59 +00001181/// \brief Given operands for an Shl, LShr or AShr, see if we can
1182/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001183static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001184 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001185 unsigned MaxRecurse) {
1186 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1187 return V;
1188
1189 // X >> X -> 0
1190 if (Op0 == Op1)
1191 return Constant::getNullValue(Op0->getType());
1192
David Majnemer65c52ae2014-12-17 01:54:33 +00001193 // undef >> X -> 0
1194 // undef >> X -> undef (if it's exact)
1195 if (match(Op0, m_Undef()))
1196 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1197
David Majnemerbf7550e2014-11-05 00:59:59 +00001198 // The low bit cannot be shifted out of an exact shift if it is set.
1199 if (isExact) {
Craig Topper8205a1a2017-05-24 16:53:07 +00001200 KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +00001201 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001202 return Op0;
1203 }
1204
1205 return nullptr;
1206}
1207
Sanjay Patel472cc782016-01-11 22:14:42 +00001208/// Given operands for an Shl, see if we can fold the result.
1209/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001210static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001211 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001212 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001213 return V;
1214
1215 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001216 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001217 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001218 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001219
Chris Lattner9e4aa022011-02-09 17:15:04 +00001220 // (X >> A) << A -> X
1221 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001222 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001223 return X;
Craig Topper9f008862014-04-15 04:59:12 +00001224 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001225}
1226
Chris Lattner9e4aa022011-02-09 17:15:04 +00001227Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001228 const SimplifyQuery &Q) {
1229 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1230}
1231
Sanjay Patel472cc782016-01-11 22:14:42 +00001232/// Given operands for an LShr, see if we can fold the result.
1233/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001234static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001235 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001236 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1237 MaxRecurse))
1238 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001239
Chris Lattner9e4aa022011-02-09 17:15:04 +00001240 // (X << A) >> A -> X
1241 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001242 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001243 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001244
Craig Topper9f008862014-04-15 04:59:12 +00001245 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001246}
1247
Chris Lattner9e4aa022011-02-09 17:15:04 +00001248Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001249 const SimplifyQuery &Q) {
1250 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1251}
1252
Sanjay Patel472cc782016-01-11 22:14:42 +00001253/// Given operands for an AShr, see if we can fold the result.
1254/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001255static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001256 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001257 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1258 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001259 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001260
1261 // all ones >>a X -> all ones
1262 if (match(Op0, m_AllOnes()))
1263 return Op0;
1264
Chris Lattner9e4aa022011-02-09 17:15:04 +00001265 // (X << A) >> A -> X
1266 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001267 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001268 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001269
Suyog Sarda68862412014-07-17 06:28:15 +00001270 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001271 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001272 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1273 return Op0;
1274
Craig Topper9f008862014-04-15 04:59:12 +00001275 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001276}
1277
Chris Lattner9e4aa022011-02-09 17:15:04 +00001278Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001279 const SimplifyQuery &Q) {
1280 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1281}
1282
Craig Topper348314d2017-05-26 22:42:34 +00001283/// Commuted variants are assumed to be handled by calling this function again
1284/// with the parameters swapped.
David Majnemer1af36e52014-12-06 10:51:40 +00001285static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1286 ICmpInst *UnsignedICmp, bool IsAnd) {
1287 Value *X, *Y;
1288
1289 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001290 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1291 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001292 return nullptr;
1293
1294 ICmpInst::Predicate UnsignedPred;
1295 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1296 ICmpInst::isUnsigned(UnsignedPred))
1297 ;
1298 else if (match(UnsignedICmp,
1299 m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1300 ICmpInst::isUnsigned(UnsignedPred))
1301 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1302 else
1303 return nullptr;
1304
1305 // X < Y && Y != 0 --> X < Y
1306 // X < Y || Y != 0 --> Y != 0
1307 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1308 return IsAnd ? UnsignedICmp : ZeroICmp;
1309
1310 // X >= Y || Y != 0 --> true
1311 // X >= Y || Y == 0 --> X >= Y
1312 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1313 if (EqPred == ICmpInst::ICMP_NE)
1314 return getTrue(UnsignedICmp->getType());
1315 return UnsignedICmp;
1316 }
1317
David Majnemerd5b3aa42014-12-08 18:30:43 +00001318 // X < Y && Y == 0 --> false
1319 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1320 IsAnd)
1321 return getFalse(UnsignedICmp->getType());
1322
David Majnemer1af36e52014-12-06 10:51:40 +00001323 return nullptr;
1324}
1325
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001326/// Commuted variants are assumed to be handled by calling this function again
1327/// with the parameters swapped.
1328static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1329 ICmpInst::Predicate Pred0, Pred1;
1330 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001331 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1332 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001333 return nullptr;
1334
1335 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1336 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1337 // can eliminate Op1 from this 'and'.
1338 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1339 return Op0;
1340
1341 // Check for any combination of predicates that are guaranteed to be disjoint.
1342 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1343 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1344 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1345 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1346 return getFalse(Op0->getType());
1347
1348 return nullptr;
1349}
1350
1351/// Commuted variants are assumed to be handled by calling this function again
1352/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001353static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1354 ICmpInst::Predicate Pred0, Pred1;
1355 Value *A ,*B;
1356 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1357 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1358 return nullptr;
1359
1360 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1361 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1362 // can eliminate Op0 from this 'or'.
1363 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1364 return Op1;
1365
1366 // Check for any combination of predicates that cover the entire range of
1367 // possibilities.
1368 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1369 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1370 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1371 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1372 return getTrue(Op0->getType());
1373
1374 return nullptr;
1375}
1376
Sanjay Patel599e65b2017-05-07 15:11:40 +00001377/// Test if a pair of compares with a shared operand and 2 constants has an
1378/// empty set intersection, full set union, or if one compare is a superset of
1379/// the other.
1380static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1381 bool IsAnd) {
1382 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1383 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1384 return nullptr;
1385
1386 const APInt *C0, *C1;
1387 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1388 !match(Cmp1->getOperand(1), m_APInt(C1)))
1389 return nullptr;
1390
1391 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1392 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1393
Sanjay Patel67454472017-05-08 16:35:02 +00001394 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001395 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1396 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1397 return getFalse(Cmp0->getType());
1398
1399 // For or-of-compares, check if the union is full:
1400 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1401 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1402 return getTrue(Cmp0->getType());
1403
1404 // Is one range a superset of the other?
1405 // If this is and-of-compares, take the smaller set:
1406 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1407 // If this is or-of-compares, take the larger set:
1408 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1409 if (Range0.contains(Range1))
1410 return IsAnd ? Cmp1 : Cmp0;
1411 if (Range1.contains(Range0))
1412 return IsAnd ? Cmp0 : Cmp1;
1413
1414 return nullptr;
1415}
1416
Craig Topper348314d2017-05-26 22:42:34 +00001417static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel599e65b2017-05-07 15:11:40 +00001418 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001419 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001420 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001421 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001422 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001423 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001424
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001425 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001426 return nullptr;
1427
David Majnemera315bd82014-09-15 08:15:28 +00001428 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001429 if (AddInst->getOperand(1) != Op1->getOperand(1))
1430 return nullptr;
1431
Craig Topper9bce1ad2017-05-26 19:04:02 +00001432 Type *ITy = Op0->getType();
David Majnemera315bd82014-09-15 08:15:28 +00001433 bool isNSW = AddInst->hasNoSignedWrap();
1434 bool isNUW = AddInst->hasNoUnsignedWrap();
1435
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001436 const APInt Delta = *C1 - *C0;
1437 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001438 if (Delta == 2) {
1439 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1440 return getFalse(ITy);
1441 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1442 return getFalse(ITy);
1443 }
1444 if (Delta == 1) {
1445 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1446 return getFalse(ITy);
1447 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1448 return getFalse(ITy);
1449 }
1450 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001451 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001452 if (Delta == 2)
1453 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1454 return getFalse(ITy);
1455 if (Delta == 1)
1456 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1457 return getFalse(ITy);
1458 }
1459
1460 return nullptr;
1461}
1462
Craig Topper348314d2017-05-26 22:42:34 +00001463static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1464 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1465 return X;
1466 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
Sanjay Patel142cb832017-05-04 18:19:17 +00001467 return X;
1468
Craig Topper348314d2017-05-26 22:42:34 +00001469 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1470 return X;
1471 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
Sanjay Patel142cb832017-05-04 18:19:17 +00001472 return X;
1473
Craig Topper348314d2017-05-26 22:42:34 +00001474 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
Sanjay Patel599e65b2017-05-07 15:11:40 +00001475 return X;
1476
Craig Topper348314d2017-05-26 22:42:34 +00001477 if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1))
1478 return X;
1479 if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0))
1480 return X;
1481
1482 return nullptr;
1483}
1484
1485static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001486 // (icmp (add V, C0), C1) | (icmp V, C0)
1487 ICmpInst::Predicate Pred0, Pred1;
1488 const APInt *C0, *C1;
1489 Value *V;
1490 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1491 return nullptr;
1492
1493 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1494 return nullptr;
1495
1496 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1497 if (AddInst->getOperand(1) != Op1->getOperand(1))
1498 return nullptr;
1499
1500 Type *ITy = Op0->getType();
1501 bool isNSW = AddInst->hasNoSignedWrap();
1502 bool isNUW = AddInst->hasNoUnsignedWrap();
1503
1504 const APInt Delta = *C1 - *C0;
1505 if (C0->isStrictlyPositive()) {
1506 if (Delta == 2) {
1507 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1508 return getTrue(ITy);
1509 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1510 return getTrue(ITy);
1511 }
1512 if (Delta == 1) {
1513 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1514 return getTrue(ITy);
1515 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1516 return getTrue(ITy);
1517 }
1518 }
1519 if (C0->getBoolValue() && isNUW) {
1520 if (Delta == 2)
1521 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1522 return getTrue(ITy);
1523 if (Delta == 1)
1524 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1525 return getTrue(ITy);
1526 }
1527
1528 return nullptr;
1529}
1530
Craig Topper348314d2017-05-26 22:42:34 +00001531static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1532 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1533 return X;
1534 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1535 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001536
Craig Topper348314d2017-05-26 22:42:34 +00001537 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1538 return X;
1539 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1540 return X;
1541
1542 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1543 return X;
1544
1545 if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1))
1546 return X;
1547 if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0))
1548 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001549
1550 return nullptr;
1551}
1552
1553static Value *simplifyAndOrOfICmps(Value *Op0, Value *Op1, bool IsAnd) {
1554 // Look through casts of the 'and' operands to find compares.
1555 auto *Cast0 = dyn_cast<CastInst>(Op0);
1556 auto *Cast1 = dyn_cast<CastInst>(Op1);
1557 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1558 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1559 Op0 = Cast0->getOperand(0);
1560 Op1 = Cast1->getOperand(0);
1561 }
1562
1563 auto *Cmp0 = dyn_cast<ICmpInst>(Op0);
1564 auto *Cmp1 = dyn_cast<ICmpInst>(Op1);
1565 if (!Cmp0 || !Cmp1)
1566 return nullptr;
1567
Craig Topper348314d2017-05-26 22:42:34 +00001568 Value *V =
1569 IsAnd ? simplifyAndOfICmps(Cmp0, Cmp1) : simplifyOrOfICmps(Cmp0, Cmp1);
1570 if (!V)
1571 return nullptr;
1572 if (!Cast0)
Sanjay Patele42b4d52017-05-04 19:51:34 +00001573 return V;
Craig Topper348314d2017-05-26 22:42:34 +00001574
1575 // If we looked through casts, we can only handle a constant simplification
1576 // because we are not allowed to create a cast instruction here.
1577 if (auto *C = dyn_cast<Constant>(V))
1578 return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
Sanjay Patele42b4d52017-05-04 19:51:34 +00001579
1580 return nullptr;
1581}
1582
Sanjay Patel472cc782016-01-11 22:14:42 +00001583/// Given operands for an And, see if we can fold the result.
1584/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001585static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001586 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001587 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1588 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001589
Chris Lattnera71e9d62009-11-10 00:55:12 +00001590 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001591 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001592 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001593
Chris Lattnera71e9d62009-11-10 00:55:12 +00001594 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001595 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001596 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001597
Duncan Sandsc89ac072010-11-17 18:52:15 +00001598 // X & 0 = 0
1599 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001600 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001601
Duncan Sandsc89ac072010-11-17 18:52:15 +00001602 // X & -1 = X
1603 if (match(Op1, m_AllOnes()))
1604 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001605
Chris Lattnera71e9d62009-11-10 00:55:12 +00001606 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001607 if (match(Op0, m_Not(m_Specific(Op1))) ||
1608 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001609 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001610
Chris Lattnera71e9d62009-11-10 00:55:12 +00001611 // (A | ?) & A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001612 if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001613 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001614
Chris Lattnera71e9d62009-11-10 00:55:12 +00001615 // A & (A | ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001616 if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001617 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001618
Sanjay Patel877364f2017-05-16 21:51:04 +00001619 // A mask that only clears known zeros of a shifted value is a no-op.
1620 Value *X;
1621 const APInt *Mask;
1622 const APInt *ShAmt;
1623 if (match(Op1, m_APInt(Mask))) {
1624 // If all bits in the inverted and shifted mask are clear:
1625 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1626 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1627 (~(*Mask)).lshr(*ShAmt).isNullValue())
1628 return Op0;
1629
1630 // If all bits in the inverted and shifted mask are clear:
1631 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1632 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1633 (~(*Mask)).shl(*ShAmt).isNullValue())
1634 return Op0;
1635 }
1636
Duncan Sandsba286d72011-10-26 20:55:21 +00001637 // A & (-A) = A if A is a power of two or zero.
1638 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1639 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001640 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1641 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001642 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001643 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1644 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001645 return Op1;
1646 }
1647
Sanjay Patele42b4d52017-05-04 19:51:34 +00001648 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, true))
1649 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001650
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001651 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001652 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1653 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001654 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001655
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001656 // And distributes over Or. Try some generic simplifications based on this.
1657 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001658 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001659 return V;
1660
1661 // And distributes over Xor. Try some generic simplifications based on this.
1662 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001663 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001664 return V;
1665
Duncan Sandsb0579e92010-11-10 13:00:08 +00001666 // If the operation is with the result of a select instruction, check whether
1667 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001668 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001669 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1670 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001671 return V;
1672
1673 // If the operation is with the result of a phi instruction, check whether
1674 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001675 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001676 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001677 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001678 return V;
1679
Craig Topper9f008862014-04-15 04:59:12 +00001680 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001681}
1682
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001683Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1684 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1685}
1686
Sanjay Patel472cc782016-01-11 22:14:42 +00001687/// Given operands for an Or, see if we can fold the result.
1688/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001689static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001690 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001691 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1692 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001693
Chris Lattnera71e9d62009-11-10 00:55:12 +00001694 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001695 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001696 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001697
Chris Lattnera71e9d62009-11-10 00:55:12 +00001698 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001699 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001700 return Op0;
1701
Duncan Sandsc89ac072010-11-17 18:52:15 +00001702 // X | 0 = X
1703 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001704 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001705
Duncan Sandsc89ac072010-11-17 18:52:15 +00001706 // X | -1 = -1
1707 if (match(Op1, m_AllOnes()))
1708 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001709
Chris Lattnera71e9d62009-11-10 00:55:12 +00001710 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001711 if (match(Op0, m_Not(m_Specific(Op1))) ||
1712 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001713 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001714
Chris Lattnera71e9d62009-11-10 00:55:12 +00001715 // (A & ?) | A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001716 if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001717 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001718
Chris Lattnera71e9d62009-11-10 00:55:12 +00001719 // A | (A & ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001720 if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001721 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001722
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001723 // ~(A & ?) | A = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001724 if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001725 return Constant::getAllOnesValue(Op1->getType());
1726
1727 // A | ~(A & ?) = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001728 if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001729 return Constant::getAllOnesValue(Op0->getType());
1730
Craig Topperdad7d8d2017-07-16 06:57:41 +00001731 Value *A, *B;
Sanjay Patel08892252017-04-24 18:24:36 +00001732 // (A & ~B) | (A ^ B) -> (A ^ B)
1733 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001734 // (A & ~B) | (B ^ A) -> (B ^ A)
1735 // (~B & A) | (B ^ A) -> (B ^ A)
1736 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1737 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1738 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001739 return Op1;
1740
1741 // Commute the 'or' operands.
1742 // (A ^ B) | (A & ~B) -> (A ^ B)
1743 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001744 // (B ^ A) | (A & ~B) -> (B ^ A)
1745 // (B ^ A) | (~B & A) -> (B ^ A)
1746 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1747 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1748 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001749 return Op0;
1750
Craig Topper479daaf2017-05-14 07:54:43 +00001751 // (A & B) | (~A ^ B) -> (~A ^ B)
1752 // (B & A) | (~A ^ B) -> (~A ^ B)
1753 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1754 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1755 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1756 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1757 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1758 return Op1;
1759
1760 // (~A ^ B) | (A & B) -> (~A ^ B)
1761 // (~A ^ B) | (B & A) -> (~A ^ B)
1762 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1763 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1764 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1765 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1766 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1767 return Op0;
1768
Sanjay Patele42b4d52017-05-04 19:51:34 +00001769 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, false))
1770 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001771
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001772 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001773 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1774 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001775 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001776
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001777 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001778 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1779 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001780 return V;
1781
Duncan Sandsb0579e92010-11-10 13:00:08 +00001782 // If the operation is with the result of a select instruction, check whether
1783 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001784 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001785 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001786 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001787 return V;
1788
Craig Topper50500d52017-05-26 05:16:20 +00001789 // (A & C1)|(B & C2)
Craig Topper1da22c32017-05-26 19:03:53 +00001790 const APInt *C1, *C2;
1791 if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
1792 match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
1793 if (*C1 == ~*C2) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001794 // (A & C1)|(B & C2)
1795 // If we have: ((V + N) & C1) | (V & C2)
1796 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1797 // replace with V+N.
Craig Topperc8bebb12017-05-26 19:03:59 +00001798 Value *N;
Craig Topper1da22c32017-05-26 19:03:53 +00001799 if (C2->isMask() && // C2 == 0+1+
Craig Topperc8bebb12017-05-26 19:03:59 +00001800 match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001801 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00001802 if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001803 return A;
1804 }
1805 // Or commutes, try both ways.
Craig Topper1da22c32017-05-26 19:03:53 +00001806 if (C1->isMask() &&
Craig Topperc8bebb12017-05-26 19:03:59 +00001807 match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001808 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00001809 if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001810 return B;
1811 }
1812 }
1813 }
1814
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001815 // If the operation is with the result of a phi instruction, check whether
1816 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001817 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001818 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001819 return V;
1820
Craig Topper9f008862014-04-15 04:59:12 +00001821 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001822}
1823
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001824Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1825 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1826}
1827
Sanjay Patel472cc782016-01-11 22:14:42 +00001828/// Given operands for a Xor, see if we can fold the result.
1829/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001830static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001831 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001832 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1833 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001834
1835 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001836 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001837 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001838
1839 // A ^ 0 = A
1840 if (match(Op1, m_Zero()))
1841 return Op0;
1842
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001843 // A ^ A = 0
1844 if (Op0 == Op1)
1845 return Constant::getNullValue(Op0->getType());
1846
Duncan Sandsc89ac072010-11-17 18:52:15 +00001847 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001848 if (match(Op0, m_Not(m_Specific(Op1))) ||
1849 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00001850 return Constant::getAllOnesValue(Op0->getType());
1851
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001852 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001853 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1854 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001855 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001856
Duncan Sandsb238de02010-11-19 09:20:39 +00001857 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1858 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1859 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1860 // only if B and C are equal. If B and C are equal then (since we assume
1861 // that operands have already been simplified) "select(cond, B, C)" should
1862 // have been simplified to the common value of B and C already. Analysing
1863 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
1864 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00001865
Craig Topper9f008862014-04-15 04:59:12 +00001866 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001867}
1868
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001869Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1870 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
1871}
1872
1873
Chris Lattner229907c2011-07-18 04:54:35 +00001874static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00001875 return CmpInst::makeCmpResultType(Op->getType());
1876}
1877
Sanjay Patel472cc782016-01-11 22:14:42 +00001878/// Rummage around inside V looking for something equivalent to the comparison
1879/// "LHS Pred RHS". Return such a value if found, otherwise return null.
1880/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00001881static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
1882 Value *LHS, Value *RHS) {
1883 SelectInst *SI = dyn_cast<SelectInst>(V);
1884 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00001885 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00001886 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1887 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00001888 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00001889 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
1890 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
1891 return Cmp;
1892 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
1893 LHS == CmpRHS && RHS == CmpLHS)
1894 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00001895 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00001896}
1897
Dan Gohman9631d902013-02-01 00:49:06 +00001898// A significant optimization not implemented here is assuming that alloca
1899// addresses are not equal to incoming argument values. They don't *alias*,
1900// as we say, but that doesn't mean they aren't equal, so we take a
1901// conservative approach.
1902//
1903// This is inspired in part by C++11 5.10p1:
1904// "Two pointers of the same type compare equal if and only if they are both
1905// null, both point to the same function, or both represent the same
1906// address."
1907//
1908// This is pretty permissive.
1909//
1910// It's also partly due to C11 6.5.9p6:
1911// "Two pointers compare equal if and only if both are null pointers, both are
1912// pointers to the same object (including a pointer to an object and a
1913// subobject at its beginning) or function, both are pointers to one past the
1914// last element of the same array object, or one is a pointer to one past the
1915// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00001916// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00001917// object in the address space.)
1918//
1919// C11's version is more restrictive, however there's no reason why an argument
1920// couldn't be a one-past-the-end value for a stack object in the caller and be
1921// equal to the beginning of a stack object in the callee.
1922//
1923// If the C and C++ standards are ever made sufficiently restrictive in this
1924// area, it may be possible to update LLVM's semantics accordingly and reinstate
1925// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00001926static Constant *
1927computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
1928 const DominatorTree *DT, CmpInst::Predicate Pred,
Nuno Lopes404f1062017-09-09 18:23:11 +00001929 AssumptionCache *AC, const Instruction *CxtI,
1930 Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00001931 // First, skip past any trivial no-ops.
1932 LHS = LHS->stripPointerCasts();
1933 RHS = RHS->stripPointerCasts();
1934
1935 // A non-null pointer is not equal to a null pointer.
Nuno Lopes404f1062017-09-09 18:23:11 +00001936 if (llvm::isKnownNonZero(LHS, DL) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00001937 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
1938 return ConstantInt::get(GetCompareTy(LHS),
1939 !CmpInst::isTrueWhenEqual(Pred));
1940
Chandler Carruth8059c842012-03-25 21:28:14 +00001941 // We can only fold certain predicates on pointer comparisons.
1942 switch (Pred) {
1943 default:
Craig Topper9f008862014-04-15 04:59:12 +00001944 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00001945
1946 // Equality comaprisons are easy to fold.
1947 case CmpInst::ICMP_EQ:
1948 case CmpInst::ICMP_NE:
1949 break;
1950
1951 // We can only handle unsigned relational comparisons because 'inbounds' on
1952 // a GEP only protects against unsigned wrapping.
1953 case CmpInst::ICMP_UGT:
1954 case CmpInst::ICMP_UGE:
1955 case CmpInst::ICMP_ULT:
1956 case CmpInst::ICMP_ULE:
1957 // However, we have to switch them to their signed variants to handle
1958 // negative indices from the base pointer.
1959 Pred = ICmpInst::getSignedPredicate(Pred);
1960 break;
1961 }
1962
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00001963 // Strip off any constant offsets so that we can reason about them.
1964 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
1965 // here and compare base addresses like AliasAnalysis does, however there are
1966 // numerous hazards. AliasAnalysis and its utilities rely on special rules
1967 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
1968 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001969 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
1970 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00001971
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00001972 // If LHS and RHS are related via constant offsets to the same base
1973 // value, we can replace it with an icmp which just compares the offsets.
1974 if (LHS == RHS)
1975 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00001976
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00001977 // Various optimizations for (in)equality comparisons.
1978 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
1979 // Different non-empty allocations that exist at the same time have
1980 // different addresses (if the program can tell). Global variables always
1981 // exist, so they always exist during the lifetime of each other and all
1982 // allocas. Two different allocas usually have different addresses...
1983 //
1984 // However, if there's an @llvm.stackrestore dynamically in between two
1985 // allocas, they may have the same address. It's tempting to reduce the
1986 // scope of the problem by only looking at *static* allocas here. That would
1987 // cover the majority of allocas while significantly reducing the likelihood
1988 // of having an @llvm.stackrestore pop up in the middle. However, it's not
1989 // actually impossible for an @llvm.stackrestore to pop up in the middle of
1990 // an entry block. Also, if we have a block that's not attached to a
1991 // function, we can't tell if it's "static" under the current definition.
1992 // Theoretically, this problem could be fixed by creating a new kind of
1993 // instruction kind specifically for static allocas. Such a new instruction
1994 // could be required to be at the top of the entry block, thus preventing it
1995 // from being subject to a @llvm.stackrestore. Instcombine could even
1996 // convert regular allocas into these special allocas. It'd be nifty.
1997 // However, until then, this problem remains open.
1998 //
1999 // So, we'll assume that two non-empty allocas have different addresses
2000 // for now.
2001 //
2002 // With all that, if the offsets are within the bounds of their allocations
2003 // (and not one-past-the-end! so we can't use inbounds!), and their
2004 // allocations aren't the same, the pointers are not equal.
2005 //
2006 // Note that it's not necessary to check for LHS being a global variable
2007 // address, due to canonicalization and constant folding.
2008 if (isa<AllocaInst>(LHS) &&
2009 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002010 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2011 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002012 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002013 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002014 getObjectSize(LHS, LHSSize, DL, TLI) &&
2015 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002016 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2017 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002018 if (!LHSOffsetValue.isNegative() &&
2019 !RHSOffsetValue.isNegative() &&
2020 LHSOffsetValue.ult(LHSSize) &&
2021 RHSOffsetValue.ult(RHSSize)) {
2022 return ConstantInt::get(GetCompareTy(LHS),
2023 !CmpInst::isTrueWhenEqual(Pred));
2024 }
2025 }
2026
2027 // Repeat the above check but this time without depending on DataLayout
2028 // or being able to compute a precise size.
2029 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2030 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2031 LHSOffset->isNullValue() &&
2032 RHSOffset->isNullValue())
2033 return ConstantInt::get(GetCompareTy(LHS),
2034 !CmpInst::isTrueWhenEqual(Pred));
2035 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002036
2037 // Even if an non-inbounds GEP occurs along the path we can still optimize
2038 // equality comparisons concerning the result. We avoid walking the whole
2039 // chain again by starting where the last calls to
2040 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002041 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2042 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002043 if (LHS == RHS)
2044 return ConstantExpr::getICmp(Pred,
2045 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2046 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002047
2048 // If one side of the equality comparison must come from a noalias call
2049 // (meaning a system memory allocation function), and the other side must
2050 // come from a pointer that cannot overlap with dynamically-allocated
2051 // memory within the lifetime of the current function (allocas, byval
2052 // arguments, globals), then determine the comparison result here.
2053 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2054 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2055 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2056
2057 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002058 auto IsNAC = [](ArrayRef<Value *> Objects) {
2059 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002060 };
2061
2062 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002063 // noalias calls. For allocas, we consider only static ones (dynamic
2064 // allocas might be transformed into calls to malloc not simultaneously
2065 // live with the compared-to allocation). For globals, we exclude symbols
2066 // that might be resolve lazily to symbols in another dynamically-loaded
2067 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002068 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2069 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002070 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2071 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2072 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2073 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002074 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002075 !GV->isThreadLocal();
2076 if (const Argument *A = dyn_cast<Argument>(V))
2077 return A->hasByValAttr();
2078 return false;
2079 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002080 };
2081
2082 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2083 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2084 return ConstantInt::get(GetCompareTy(LHS),
2085 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002086
2087 // Fold comparisons for non-escaping pointer even if the allocation call
2088 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2089 // dynamic allocation call could be either of the operands.
2090 Value *MI = nullptr;
Nuno Lopes404f1062017-09-09 18:23:11 +00002091 if (isAllocLikeFn(LHS, TLI) &&
2092 llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002093 MI = LHS;
Nuno Lopes404f1062017-09-09 18:23:11 +00002094 else if (isAllocLikeFn(RHS, TLI) &&
2095 llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002096 MI = RHS;
2097 // FIXME: We should also fold the compare when the pointer escapes, but the
2098 // compare dominates the pointer escape
2099 if (MI && !PointerMayBeCaptured(MI, true, true))
2100 return ConstantInt::get(GetCompareTy(LHS),
2101 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002102 }
2103
2104 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002105 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002106}
Chris Lattner01990f02012-02-24 19:01:58 +00002107
Sanjay Pateldc65a272016-12-03 17:30:22 +00002108/// Fold an icmp when its operands have i1 scalar type.
2109static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002110 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002111 Type *ITy = GetCompareTy(LHS); // The return type.
2112 Type *OpTy = LHS->getType(); // The operand type.
Craig Topperfde47232017-07-09 07:04:03 +00002113 if (!OpTy->isIntOrIntVectorTy(1))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002114 return nullptr;
2115
Sanjay Patele2787b92017-05-17 20:27:55 +00002116 // A boolean compared to true/false can be simplified in 14 out of the 20
2117 // (10 predicates * 2 constants) possible combinations. Cases not handled here
2118 // require a 'not' of the LHS, so those must be transformed in InstCombine.
2119 if (match(RHS, m_Zero())) {
2120 switch (Pred) {
2121 case CmpInst::ICMP_NE: // X != 0 -> X
2122 case CmpInst::ICMP_UGT: // X >u 0 -> X
2123 case CmpInst::ICMP_SLT: // X <s 0 -> X
2124 return LHS;
2125
2126 case CmpInst::ICMP_ULT: // X <u 0 -> false
2127 case CmpInst::ICMP_SGT: // X >s 0 -> false
2128 return getFalse(ITy);
2129
2130 case CmpInst::ICMP_UGE: // X >=u 0 -> true
2131 case CmpInst::ICMP_SLE: // X <=s 0 -> true
2132 return getTrue(ITy);
2133
2134 default: break;
2135 }
2136 } else if (match(RHS, m_One())) {
2137 switch (Pred) {
2138 case CmpInst::ICMP_EQ: // X == 1 -> X
2139 case CmpInst::ICMP_UGE: // X >=u 1 -> X
2140 case CmpInst::ICMP_SLE: // X <=s -1 -> X
2141 return LHS;
2142
2143 case CmpInst::ICMP_UGT: // X >u 1 -> false
2144 case CmpInst::ICMP_SLT: // X <s -1 -> false
2145 return getFalse(ITy);
2146
2147 case CmpInst::ICMP_ULE: // X <=u 1 -> true
2148 case CmpInst::ICMP_SGE: // X >=s -1 -> true
2149 return getTrue(ITy);
2150
2151 default: break;
2152 }
2153 }
2154
Sanjay Pateldc65a272016-12-03 17:30:22 +00002155 switch (Pred) {
2156 default:
2157 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002158 case ICmpInst::ICMP_UGE:
Sanjay Pateldc65a272016-12-03 17:30:22 +00002159 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2160 return getTrue(ITy);
2161 break;
2162 case ICmpInst::ICMP_SGE:
2163 /// For signed comparison, the values for an i1 are 0 and -1
2164 /// respectively. This maps into a truth table of:
2165 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2166 /// 0 | 0 | 1 (0 >= 0) | 1
2167 /// 0 | 1 | 1 (0 >= -1) | 1
2168 /// 1 | 0 | 0 (-1 >= 0) | 0
2169 /// 1 | 1 | 1 (-1 >= -1) | 1
2170 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2171 return getTrue(ITy);
2172 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002173 case ICmpInst::ICMP_ULE:
2174 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2175 return getTrue(ITy);
2176 break;
2177 }
2178
2179 return nullptr;
2180}
2181
2182/// Try hard to fold icmp with zero RHS because this is a common case.
2183static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002184 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002185 if (!match(RHS, m_Zero()))
2186 return nullptr;
2187
2188 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002189 switch (Pred) {
2190 default:
2191 llvm_unreachable("Unknown ICmp predicate!");
2192 case ICmpInst::ICMP_ULT:
2193 return getFalse(ITy);
2194 case ICmpInst::ICMP_UGE:
2195 return getTrue(ITy);
2196 case ICmpInst::ICMP_EQ:
2197 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002198 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002199 return getFalse(ITy);
2200 break;
2201 case ICmpInst::ICMP_NE:
2202 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002203 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002204 return getTrue(ITy);
2205 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002206 case ICmpInst::ICMP_SLT: {
2207 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2208 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002209 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002210 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002211 return getFalse(ITy);
2212 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002213 }
2214 case ICmpInst::ICMP_SLE: {
2215 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2216 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002217 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002218 if (LHSKnown.isNonNegative() &&
2219 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002220 return getFalse(ITy);
2221 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002222 }
2223 case ICmpInst::ICMP_SGE: {
2224 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2225 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002226 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002227 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002228 return getTrue(ITy);
2229 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002230 }
2231 case ICmpInst::ICMP_SGT: {
2232 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2233 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002234 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002235 if (LHSKnown.isNonNegative() &&
2236 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002237 return getTrue(ITy);
2238 break;
2239 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002240 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002241
2242 return nullptr;
2243}
2244
Sanjay Patelbe332132017-01-23 18:22:26 +00002245/// Many binary operators with a constant operand have an easy-to-compute
2246/// range of outputs. This can be used to fold a comparison to always true or
2247/// always false.
2248static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2249 unsigned Width = Lower.getBitWidth();
2250 const APInt *C;
2251 switch (BO.getOpcode()) {
2252 case Instruction::Add:
Craig Topper73ba1c82017-06-07 07:40:37 +00002253 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patel56227252017-01-24 17:03:24 +00002254 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2255 if (BO.hasNoUnsignedWrap()) {
2256 // 'add nuw x, C' produces [C, UINT_MAX].
2257 Lower = *C;
2258 } else if (BO.hasNoSignedWrap()) {
2259 if (C->isNegative()) {
2260 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2261 Lower = APInt::getSignedMinValue(Width);
2262 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2263 } else {
2264 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2265 Lower = APInt::getSignedMinValue(Width) + *C;
2266 Upper = APInt::getSignedMaxValue(Width) + 1;
2267 }
2268 }
2269 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002270 break;
2271
2272 case Instruction::And:
2273 if (match(BO.getOperand(1), m_APInt(C)))
2274 // 'and x, C' produces [0, C].
2275 Upper = *C + 1;
2276 break;
2277
2278 case Instruction::Or:
2279 if (match(BO.getOperand(1), m_APInt(C)))
2280 // 'or x, C' produces [C, UINT_MAX].
2281 Lower = *C;
2282 break;
2283
2284 case Instruction::AShr:
2285 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2286 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2287 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2288 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2289 } else if (match(BO.getOperand(0), m_APInt(C))) {
2290 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002291 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002292 ShiftAmount = C->countTrailingZeros();
2293 if (C->isNegative()) {
2294 // 'ashr C, x' produces [C, C >> (Width-1)]
2295 Lower = *C;
2296 Upper = C->ashr(ShiftAmount) + 1;
2297 } else {
2298 // 'ashr C, x' produces [C >> (Width-1), C]
2299 Lower = C->ashr(ShiftAmount);
2300 Upper = *C + 1;
2301 }
2302 }
2303 break;
2304
2305 case Instruction::LShr:
2306 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2307 // 'lshr x, C' produces [0, UINT_MAX >> C].
2308 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2309 } else if (match(BO.getOperand(0), m_APInt(C))) {
2310 // 'lshr C, x' produces [C >> (Width-1), C].
2311 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002312 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002313 ShiftAmount = C->countTrailingZeros();
2314 Lower = C->lshr(ShiftAmount);
2315 Upper = *C + 1;
2316 }
2317 break;
2318
2319 case Instruction::Shl:
2320 if (match(BO.getOperand(0), m_APInt(C))) {
2321 if (BO.hasNoUnsignedWrap()) {
2322 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2323 Lower = *C;
2324 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2325 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2326 if (C->isNegative()) {
2327 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2328 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2329 Lower = C->shl(ShiftAmount);
2330 Upper = *C + 1;
2331 } else {
2332 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2333 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2334 Lower = *C;
2335 Upper = C->shl(ShiftAmount) + 1;
2336 }
2337 }
2338 }
2339 break;
2340
2341 case Instruction::SDiv:
2342 if (match(BO.getOperand(1), m_APInt(C))) {
2343 APInt IntMin = APInt::getSignedMinValue(Width);
2344 APInt IntMax = APInt::getSignedMaxValue(Width);
2345 if (C->isAllOnesValue()) {
2346 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2347 // where C != -1 and C != 0 and C != 1
2348 Lower = IntMin + 1;
2349 Upper = IntMax + 1;
2350 } else if (C->countLeadingZeros() < Width - 1) {
2351 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2352 // where C != -1 and C != 0 and C != 1
2353 Lower = IntMin.sdiv(*C);
2354 Upper = IntMax.sdiv(*C);
2355 if (Lower.sgt(Upper))
2356 std::swap(Lower, Upper);
2357 Upper = Upper + 1;
2358 assert(Upper != Lower && "Upper part of range has wrapped!");
2359 }
2360 } else if (match(BO.getOperand(0), m_APInt(C))) {
2361 if (C->isMinSignedValue()) {
2362 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2363 Lower = *C;
2364 Upper = Lower.lshr(1) + 1;
2365 } else {
2366 // 'sdiv C, x' produces [-|C|, |C|].
2367 Upper = C->abs() + 1;
2368 Lower = (-Upper) + 1;
2369 }
2370 }
2371 break;
2372
2373 case Instruction::UDiv:
Craig Topper73ba1c82017-06-07 07:40:37 +00002374 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002375 // 'udiv x, C' produces [0, UINT_MAX / C].
2376 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2377 } else if (match(BO.getOperand(0), m_APInt(C))) {
2378 // 'udiv C, x' produces [0, C].
2379 Upper = *C + 1;
2380 }
2381 break;
2382
2383 case Instruction::SRem:
2384 if (match(BO.getOperand(1), m_APInt(C))) {
2385 // 'srem x, C' produces (-|C|, |C|).
2386 Upper = C->abs();
2387 Lower = (-Upper) + 1;
2388 }
2389 break;
2390
2391 case Instruction::URem:
2392 if (match(BO.getOperand(1), m_APInt(C)))
2393 // 'urem x, C' produces [0, C).
2394 Upper = *C;
2395 break;
2396
2397 default:
2398 break;
2399 }
2400}
2401
Sanjay Patel67bde282016-08-22 23:12:02 +00002402static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2403 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002404 const APInt *C;
2405 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002406 return nullptr;
2407
2408 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002409 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002410 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002411 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002412 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002413 return ConstantInt::getTrue(GetCompareTy(RHS));
2414
Sanjay Patelbe332132017-01-23 18:22:26 +00002415 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002416 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002417 APInt Lower = APInt(Width, 0);
2418 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002419 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2420 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002421
2422 ConstantRange LHS_CR =
2423 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2424
2425 if (auto *I = dyn_cast<Instruction>(LHS))
2426 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2427 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2428
2429 if (!LHS_CR.isFullSet()) {
2430 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002431 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002432 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002433 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002434 }
2435
2436 return nullptr;
2437}
2438
Sanjay Patel2df38a82017-05-08 16:21:55 +00002439/// TODO: A large part of this logic is duplicated in InstCombine's
2440/// foldICmpBinOp(). We should be able to share that and avoid the code
2441/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002442static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002443 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002444 unsigned MaxRecurse) {
2445 Type *ITy = GetCompareTy(LHS); // The return type.
2446
2447 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2448 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2449 if (MaxRecurse && (LBO || RBO)) {
2450 // Analyze the case when either LHS or RHS is an add instruction.
2451 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2452 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2453 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2454 if (LBO && LBO->getOpcode() == Instruction::Add) {
2455 A = LBO->getOperand(0);
2456 B = LBO->getOperand(1);
2457 NoLHSWrapProblem =
2458 ICmpInst::isEquality(Pred) ||
2459 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2460 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2461 }
2462 if (RBO && RBO->getOpcode() == Instruction::Add) {
2463 C = RBO->getOperand(0);
2464 D = RBO->getOperand(1);
2465 NoRHSWrapProblem =
2466 ICmpInst::isEquality(Pred) ||
2467 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2468 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2469 }
2470
2471 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2472 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2473 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2474 Constant::getNullValue(RHS->getType()), Q,
2475 MaxRecurse - 1))
2476 return V;
2477
2478 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2479 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2480 if (Value *V =
2481 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2482 C == LHS ? D : C, Q, MaxRecurse - 1))
2483 return V;
2484
2485 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2486 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2487 NoRHSWrapProblem) {
2488 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2489 Value *Y, *Z;
2490 if (A == C) {
2491 // C + B == C + D -> B == D
2492 Y = B;
2493 Z = D;
2494 } else if (A == D) {
2495 // D + B == C + D -> B == C
2496 Y = B;
2497 Z = C;
2498 } else if (B == C) {
2499 // A + C == C + D -> A == D
2500 Y = A;
2501 Z = D;
2502 } else {
2503 assert(B == D);
2504 // A + D == C + D -> A == C
2505 Y = A;
2506 Z = C;
2507 }
2508 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2509 return V;
2510 }
2511 }
2512
2513 {
2514 Value *Y = nullptr;
2515 // icmp pred (or X, Y), X
2516 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2517 if (Pred == ICmpInst::ICMP_ULT)
2518 return getFalse(ITy);
2519 if (Pred == ICmpInst::ICMP_UGE)
2520 return getTrue(ITy);
2521
2522 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002523 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2524 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2525 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002526 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002527 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002528 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2529 }
2530 }
2531 // icmp pred X, (or X, Y)
2532 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2533 if (Pred == ICmpInst::ICMP_ULE)
2534 return getTrue(ITy);
2535 if (Pred == ICmpInst::ICMP_UGT)
2536 return getFalse(ITy);
2537
2538 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002539 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2540 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2541 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002542 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002543 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002544 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2545 }
2546 }
2547 }
2548
2549 // icmp pred (and X, Y), X
Craig Topper72ee6942017-06-24 06:24:01 +00002550 if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002551 if (Pred == ICmpInst::ICMP_UGT)
2552 return getFalse(ITy);
2553 if (Pred == ICmpInst::ICMP_ULE)
2554 return getTrue(ITy);
2555 }
2556 // icmp pred X, (and X, Y)
Craig Topper72ee6942017-06-24 06:24:01 +00002557 if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002558 if (Pred == ICmpInst::ICMP_UGE)
2559 return getTrue(ITy);
2560 if (Pred == ICmpInst::ICMP_ULT)
2561 return getFalse(ITy);
2562 }
2563
2564 // 0 - (zext X) pred C
2565 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2566 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2567 if (RHSC->getValue().isStrictlyPositive()) {
2568 if (Pred == ICmpInst::ICMP_SLT)
2569 return ConstantInt::getTrue(RHSC->getContext());
2570 if (Pred == ICmpInst::ICMP_SGE)
2571 return ConstantInt::getFalse(RHSC->getContext());
2572 if (Pred == ICmpInst::ICMP_EQ)
2573 return ConstantInt::getFalse(RHSC->getContext());
2574 if (Pred == ICmpInst::ICMP_NE)
2575 return ConstantInt::getTrue(RHSC->getContext());
2576 }
2577 if (RHSC->getValue().isNonNegative()) {
2578 if (Pred == ICmpInst::ICMP_SLE)
2579 return ConstantInt::getTrue(RHSC->getContext());
2580 if (Pred == ICmpInst::ICMP_SGT)
2581 return ConstantInt::getFalse(RHSC->getContext());
2582 }
2583 }
2584 }
2585
2586 // icmp pred (urem X, Y), Y
2587 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002588 switch (Pred) {
2589 default:
2590 break;
2591 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002592 case ICmpInst::ICMP_SGE: {
2593 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2594 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002595 break;
2596 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002597 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002598 case ICmpInst::ICMP_EQ:
2599 case ICmpInst::ICMP_UGT:
2600 case ICmpInst::ICMP_UGE:
2601 return getFalse(ITy);
2602 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002603 case ICmpInst::ICMP_SLE: {
2604 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2605 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002606 break;
2607 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002608 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002609 case ICmpInst::ICMP_NE:
2610 case ICmpInst::ICMP_ULT:
2611 case ICmpInst::ICMP_ULE:
2612 return getTrue(ITy);
2613 }
2614 }
2615
2616 // icmp pred X, (urem Y, X)
2617 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002618 switch (Pred) {
2619 default:
2620 break;
2621 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002622 case ICmpInst::ICMP_SGE: {
2623 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2624 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002625 break;
2626 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002627 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002628 case ICmpInst::ICMP_NE:
2629 case ICmpInst::ICMP_UGT:
2630 case ICmpInst::ICMP_UGE:
2631 return getTrue(ITy);
2632 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002633 case ICmpInst::ICMP_SLE: {
2634 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2635 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002636 break;
2637 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002638 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002639 case ICmpInst::ICMP_EQ:
2640 case ICmpInst::ICMP_ULT:
2641 case ICmpInst::ICMP_ULE:
2642 return getFalse(ITy);
2643 }
2644 }
2645
2646 // x >> y <=u x
2647 // x udiv y <=u x.
2648 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2649 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2650 // icmp pred (X op Y), X
2651 if (Pred == ICmpInst::ICMP_UGT)
2652 return getFalse(ITy);
2653 if (Pred == ICmpInst::ICMP_ULE)
2654 return getTrue(ITy);
2655 }
2656
2657 // x >=u x >> y
2658 // x >=u x udiv y.
2659 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2660 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2661 // icmp pred X, (X op Y)
2662 if (Pred == ICmpInst::ICMP_ULT)
2663 return getFalse(ITy);
2664 if (Pred == ICmpInst::ICMP_UGE)
2665 return getTrue(ITy);
2666 }
2667
2668 // handle:
2669 // CI2 << X == CI
2670 // CI2 << X != CI
2671 //
2672 // where CI2 is a power of 2 and CI isn't
2673 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2674 const APInt *CI2Val, *CIVal = &CI->getValue();
2675 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2676 CI2Val->isPowerOf2()) {
2677 if (!CIVal->isPowerOf2()) {
2678 // CI2 << X can equal zero in some circumstances,
2679 // this simplification is unsafe if CI is zero.
2680 //
2681 // We know it is safe if:
2682 // - The shift is nsw, we can't shift out the one bit.
2683 // - The shift is nuw, we can't shift out the one bit.
2684 // - CI2 is one
2685 // - CI isn't zero
2686 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
Craig Topper73ba1c82017-06-07 07:40:37 +00002687 CI2Val->isOneValue() || !CI->isZero()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002688 if (Pred == ICmpInst::ICMP_EQ)
2689 return ConstantInt::getFalse(RHS->getContext());
2690 if (Pred == ICmpInst::ICMP_NE)
2691 return ConstantInt::getTrue(RHS->getContext());
2692 }
2693 }
Craig Topper73ba1c82017-06-07 07:40:37 +00002694 if (CIVal->isSignMask() && CI2Val->isOneValue()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002695 if (Pred == ICmpInst::ICMP_UGT)
2696 return ConstantInt::getFalse(RHS->getContext());
2697 if (Pred == ICmpInst::ICMP_ULE)
2698 return ConstantInt::getTrue(RHS->getContext());
2699 }
2700 }
2701 }
2702
2703 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2704 LBO->getOperand(1) == RBO->getOperand(1)) {
2705 switch (LBO->getOpcode()) {
2706 default:
2707 break;
2708 case Instruction::UDiv:
2709 case Instruction::LShr:
Sanjay Patela23b1412017-05-15 19:16:49 +00002710 if (ICmpInst::isSigned(Pred) || !LBO->isExact() || !RBO->isExact())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002711 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00002712 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2713 RBO->getOperand(0), Q, MaxRecurse - 1))
2714 return V;
2715 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002716 case Instruction::SDiv:
Sanjay Patela23b1412017-05-15 19:16:49 +00002717 if (!ICmpInst::isEquality(Pred) || !LBO->isExact() || !RBO->isExact())
2718 break;
2719 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2720 RBO->getOperand(0), Q, MaxRecurse - 1))
2721 return V;
2722 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002723 case Instruction::AShr:
2724 if (!LBO->isExact() || !RBO->isExact())
2725 break;
2726 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2727 RBO->getOperand(0), Q, MaxRecurse - 1))
2728 return V;
2729 break;
2730 case Instruction::Shl: {
2731 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2732 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2733 if (!NUW && !NSW)
2734 break;
2735 if (!NSW && ICmpInst::isSigned(Pred))
2736 break;
2737 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2738 RBO->getOperand(0), Q, MaxRecurse - 1))
2739 return V;
2740 break;
2741 }
2742 }
2743 }
2744 return nullptr;
2745}
2746
Sanjay Patel35289c62016-12-10 17:40:47 +00002747/// Simplify integer comparisons where at least one operand of the compare
2748/// matches an integer min/max idiom.
2749static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002750 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00002751 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002752 Type *ITy = GetCompareTy(LHS); // The return type.
2753 Value *A, *B;
2754 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2755 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2756
2757 // Signed variants on "max(a,b)>=a -> true".
2758 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2759 if (A != RHS)
2760 std::swap(A, B); // smax(A, B) pred A.
2761 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2762 // We analyze this as smax(A, B) pred A.
2763 P = Pred;
2764 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2765 (A == LHS || B == LHS)) {
2766 if (A != LHS)
2767 std::swap(A, B); // A pred smax(A, B).
2768 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2769 // We analyze this as smax(A, B) swapped-pred A.
2770 P = CmpInst::getSwappedPredicate(Pred);
2771 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2772 (A == RHS || B == RHS)) {
2773 if (A != RHS)
2774 std::swap(A, B); // smin(A, B) pred A.
2775 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2776 // We analyze this as smax(-A, -B) swapped-pred -A.
2777 // Note that we do not need to actually form -A or -B thanks to EqP.
2778 P = CmpInst::getSwappedPredicate(Pred);
2779 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2780 (A == LHS || B == LHS)) {
2781 if (A != LHS)
2782 std::swap(A, B); // A pred smin(A, B).
2783 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2784 // We analyze this as smax(-A, -B) pred -A.
2785 // Note that we do not need to actually form -A or -B thanks to EqP.
2786 P = Pred;
2787 }
2788 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2789 // Cases correspond to "max(A, B) p A".
2790 switch (P) {
2791 default:
2792 break;
2793 case CmpInst::ICMP_EQ:
2794 case CmpInst::ICMP_SLE:
2795 // Equivalent to "A EqP B". This may be the same as the condition tested
2796 // in the max/min; if so, we can just return that.
2797 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2798 return V;
2799 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2800 return V;
2801 // Otherwise, see if "A EqP B" simplifies.
2802 if (MaxRecurse)
2803 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2804 return V;
2805 break;
2806 case CmpInst::ICMP_NE:
2807 case CmpInst::ICMP_SGT: {
2808 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2809 // Equivalent to "A InvEqP B". This may be the same as the condition
2810 // tested in the max/min; if so, we can just return that.
2811 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2812 return V;
2813 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2814 return V;
2815 // Otherwise, see if "A InvEqP B" simplifies.
2816 if (MaxRecurse)
2817 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2818 return V;
2819 break;
2820 }
2821 case CmpInst::ICMP_SGE:
2822 // Always true.
2823 return getTrue(ITy);
2824 case CmpInst::ICMP_SLT:
2825 // Always false.
2826 return getFalse(ITy);
2827 }
2828 }
2829
2830 // Unsigned variants on "max(a,b)>=a -> true".
2831 P = CmpInst::BAD_ICMP_PREDICATE;
2832 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2833 if (A != RHS)
2834 std::swap(A, B); // umax(A, B) pred A.
2835 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2836 // We analyze this as umax(A, B) pred A.
2837 P = Pred;
2838 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2839 (A == LHS || B == LHS)) {
2840 if (A != LHS)
2841 std::swap(A, B); // A pred umax(A, B).
2842 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2843 // We analyze this as umax(A, B) swapped-pred A.
2844 P = CmpInst::getSwappedPredicate(Pred);
2845 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2846 (A == RHS || B == RHS)) {
2847 if (A != RHS)
2848 std::swap(A, B); // umin(A, B) pred A.
2849 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2850 // We analyze this as umax(-A, -B) swapped-pred -A.
2851 // Note that we do not need to actually form -A or -B thanks to EqP.
2852 P = CmpInst::getSwappedPredicate(Pred);
2853 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2854 (A == LHS || B == LHS)) {
2855 if (A != LHS)
2856 std::swap(A, B); // A pred umin(A, B).
2857 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2858 // We analyze this as umax(-A, -B) pred -A.
2859 // Note that we do not need to actually form -A or -B thanks to EqP.
2860 P = Pred;
2861 }
2862 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2863 // Cases correspond to "max(A, B) p A".
2864 switch (P) {
2865 default:
2866 break;
2867 case CmpInst::ICMP_EQ:
2868 case CmpInst::ICMP_ULE:
2869 // Equivalent to "A EqP B". This may be the same as the condition tested
2870 // in the max/min; if so, we can just return that.
2871 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2872 return V;
2873 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2874 return V;
2875 // Otherwise, see if "A EqP B" simplifies.
2876 if (MaxRecurse)
2877 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2878 return V;
2879 break;
2880 case CmpInst::ICMP_NE:
2881 case CmpInst::ICMP_UGT: {
2882 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2883 // Equivalent to "A InvEqP B". This may be the same as the condition
2884 // tested in the max/min; if so, we can just return that.
2885 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2886 return V;
2887 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2888 return V;
2889 // Otherwise, see if "A InvEqP B" simplifies.
2890 if (MaxRecurse)
2891 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2892 return V;
2893 break;
2894 }
2895 case CmpInst::ICMP_UGE:
2896 // Always true.
2897 return getTrue(ITy);
2898 case CmpInst::ICMP_ULT:
2899 // Always false.
2900 return getFalse(ITy);
2901 }
2902 }
2903
2904 // Variants on "max(x,y) >= min(x,z)".
2905 Value *C, *D;
2906 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
2907 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
2908 (A == C || A == D || B == C || B == D)) {
2909 // max(x, ?) pred min(x, ?).
2910 if (Pred == CmpInst::ICMP_SGE)
2911 // Always true.
2912 return getTrue(ITy);
2913 if (Pred == CmpInst::ICMP_SLT)
2914 // Always false.
2915 return getFalse(ITy);
2916 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2917 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
2918 (A == C || A == D || B == C || B == D)) {
2919 // min(x, ?) pred max(x, ?).
2920 if (Pred == CmpInst::ICMP_SLE)
2921 // Always true.
2922 return getTrue(ITy);
2923 if (Pred == CmpInst::ICMP_SGT)
2924 // Always false.
2925 return getFalse(ITy);
2926 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
2927 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
2928 (A == C || A == D || B == C || B == D)) {
2929 // max(x, ?) pred min(x, ?).
2930 if (Pred == CmpInst::ICMP_UGE)
2931 // Always true.
2932 return getTrue(ITy);
2933 if (Pred == CmpInst::ICMP_ULT)
2934 // Always false.
2935 return getFalse(ITy);
2936 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2937 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
2938 (A == C || A == D || B == C || B == D)) {
2939 // min(x, ?) pred max(x, ?).
2940 if (Pred == CmpInst::ICMP_ULE)
2941 // Always true.
2942 return getTrue(ITy);
2943 if (Pred == CmpInst::ICMP_UGT)
2944 // Always false.
2945 return getFalse(ITy);
2946 }
2947
2948 return nullptr;
2949}
2950
Sanjay Patel472cc782016-01-11 22:14:42 +00002951/// Given operands for an ICmpInst, see if we can fold the result.
2952/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00002953static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002954 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00002955 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00002956 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00002957
Chris Lattnera71e9d62009-11-10 00:55:12 +00002958 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00002959 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002960 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00002961
2962 // If we have a constant, make sure it is on the RHS.
2963 std::swap(LHS, RHS);
2964 Pred = CmpInst::getSwappedPredicate(Pred);
2965 }
Duncan Sands7e800d62010-11-14 11:23:23 +00002966
Chris Lattner229907c2011-07-18 04:54:35 +00002967 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00002968
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002969 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00002970 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
2971 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00002972 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002973 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00002974
Sanjay Pateldc65a272016-12-03 17:30:22 +00002975 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
2976 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00002977
Sanjay Pateldc65a272016-12-03 17:30:22 +00002978 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
2979 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00002980
Sanjay Patel67bde282016-08-22 23:12:02 +00002981 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
2982 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00002983
Chen Li7452d952015-09-26 03:26:47 +00002984 // If both operands have range metadata, use the metadata
2985 // to simplify the comparison.
2986 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00002987 auto RHS_Instr = cast<Instruction>(RHS);
2988 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00002989
2990 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
2991 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00002992 auto RHS_CR = getConstantRangeFromMetadata(
2993 *RHS_Instr->getMetadata(LLVMContext::MD_range));
2994 auto LHS_CR = getConstantRangeFromMetadata(
2995 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00002996
2997 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
2998 if (Satisfied_CR.contains(LHS_CR))
2999 return ConstantInt::getTrue(RHS->getContext());
3000
3001 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3002 CmpInst::getInversePredicate(Pred), RHS_CR);
3003 if (InversedSatisfied_CR.contains(LHS_CR))
3004 return ConstantInt::getFalse(RHS->getContext());
3005 }
3006 }
3007
Duncan Sands8fb2c382011-01-20 13:21:55 +00003008 // Compare of cast, for example (zext X) != 0 -> X != 0
3009 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3010 Instruction *LI = cast<CastInst>(LHS);
3011 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003012 Type *SrcTy = SrcOp->getType();
3013 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003014
3015 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3016 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003017 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3018 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003019 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3020 // Transfer the cast to the constant.
3021 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3022 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003023 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003024 return V;
3025 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3026 if (RI->getOperand(0)->getType() == SrcTy)
3027 // Compare without the cast.
3028 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003029 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003030 return V;
3031 }
3032 }
3033
3034 if (isa<ZExtInst>(LHS)) {
3035 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3036 // same type.
3037 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3038 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3039 // Compare X and Y. Note that signed predicates become unsigned.
3040 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003041 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003042 MaxRecurse-1))
3043 return V;
3044 }
3045 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3046 // too. If not, then try to deduce the result of the comparison.
3047 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3048 // Compute the constant that would happen if we truncated to SrcTy then
3049 // reextended to DstTy.
3050 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3051 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3052
3053 // If the re-extended constant didn't change then this is effectively
3054 // also a case of comparing two zero-extended values.
3055 if (RExt == CI && MaxRecurse)
3056 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003057 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003058 return V;
3059
3060 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3061 // there. Use this to work out the result of the comparison.
3062 if (RExt != CI) {
3063 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003064 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003065 // LHS <u RHS.
3066 case ICmpInst::ICMP_EQ:
3067 case ICmpInst::ICMP_UGT:
3068 case ICmpInst::ICMP_UGE:
3069 return ConstantInt::getFalse(CI->getContext());
3070
3071 case ICmpInst::ICMP_NE:
3072 case ICmpInst::ICMP_ULT:
3073 case ICmpInst::ICMP_ULE:
3074 return ConstantInt::getTrue(CI->getContext());
3075
3076 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3077 // is non-negative then LHS <s RHS.
3078 case ICmpInst::ICMP_SGT:
3079 case ICmpInst::ICMP_SGE:
3080 return CI->getValue().isNegative() ?
3081 ConstantInt::getTrue(CI->getContext()) :
3082 ConstantInt::getFalse(CI->getContext());
3083
3084 case ICmpInst::ICMP_SLT:
3085 case ICmpInst::ICMP_SLE:
3086 return CI->getValue().isNegative() ?
3087 ConstantInt::getFalse(CI->getContext()) :
3088 ConstantInt::getTrue(CI->getContext());
3089 }
3090 }
3091 }
3092 }
3093
3094 if (isa<SExtInst>(LHS)) {
3095 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3096 // same type.
3097 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3098 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3099 // Compare X and Y. Note that the predicate does not change.
3100 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003101 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003102 return V;
3103 }
3104 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3105 // too. If not, then try to deduce the result of the comparison.
3106 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3107 // Compute the constant that would happen if we truncated to SrcTy then
3108 // reextended to DstTy.
3109 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3110 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3111
3112 // If the re-extended constant didn't change then this is effectively
3113 // also a case of comparing two sign-extended values.
3114 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003115 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003116 return V;
3117
3118 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3119 // bits there. Use this to work out the result of the comparison.
3120 if (RExt != CI) {
3121 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003122 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003123 case ICmpInst::ICMP_EQ:
3124 return ConstantInt::getFalse(CI->getContext());
3125 case ICmpInst::ICMP_NE:
3126 return ConstantInt::getTrue(CI->getContext());
3127
3128 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3129 // LHS >s RHS.
3130 case ICmpInst::ICMP_SGT:
3131 case ICmpInst::ICMP_SGE:
3132 return CI->getValue().isNegative() ?
3133 ConstantInt::getTrue(CI->getContext()) :
3134 ConstantInt::getFalse(CI->getContext());
3135 case ICmpInst::ICMP_SLT:
3136 case ICmpInst::ICMP_SLE:
3137 return CI->getValue().isNegative() ?
3138 ConstantInt::getFalse(CI->getContext()) :
3139 ConstantInt::getTrue(CI->getContext());
3140
3141 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3142 // LHS >u RHS.
3143 case ICmpInst::ICMP_UGT:
3144 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003145 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003146 if (MaxRecurse)
3147 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3148 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003149 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003150 return V;
3151 break;
3152 case ICmpInst::ICMP_ULT:
3153 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003154 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003155 if (MaxRecurse)
3156 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3157 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003158 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003159 return V;
3160 break;
3161 }
3162 }
3163 }
3164 }
3165 }
3166
James Molloy1d88d6f2015-10-22 13:18:42 +00003167 // icmp eq|ne X, Y -> false|true if X != Y
Craig Topperc2790ec2017-06-06 07:13:04 +00003168 if (ICmpInst::isEquality(Pred) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003169 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
Craig Topper2dfb4802017-06-06 07:13:13 +00003170 return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
James Molloy1d88d6f2015-10-22 13:18:42 +00003171 }
Junmo Park53470fc2016-04-05 21:14:31 +00003172
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003173 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3174 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003175
Sanjay Patel35289c62016-12-10 17:40:47 +00003176 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003177 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003178
Chandler Carruth8059c842012-03-25 21:28:14 +00003179 // Simplify comparisons of related pointers using a powerful, recursive
3180 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003181 if (LHS->getType()->isPointerTy())
Nuno Lopes404f1062017-09-09 18:23:11 +00003182 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI, LHS,
3183 RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003184 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003185 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3186 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3187 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3188 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3189 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3190 Q.DL.getTypeSizeInBits(CRHS->getType()))
Nuno Lopes404f1062017-09-09 18:23:11 +00003191 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
David Majnemerdc8767a2016-08-07 07:58:10 +00003192 CLHS->getPointerOperand(),
3193 CRHS->getPointerOperand()))
3194 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003195
Nick Lewycky3db143e2012-02-26 02:09:49 +00003196 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3197 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3198 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3199 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3200 (ICmpInst::isEquality(Pred) ||
3201 (GLHS->isInBounds() && GRHS->isInBounds() &&
3202 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3203 // The bases are equal and the indices are constant. Build a constant
3204 // expression GEP with the same indices and a null base pointer to see
3205 // what constant folding can make out of it.
3206 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3207 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003208 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3209 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003210
3211 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003212 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3213 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003214 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3215 }
3216 }
3217 }
3218
Duncan Sandsf532d312010-11-07 16:12:23 +00003219 // If the comparison is with the result of a select instruction, check whether
3220 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003221 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003222 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003223 return V;
3224
3225 // If the comparison is with the result of a phi instruction, check whether
3226 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003227 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003228 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003229 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003230
Craig Topper9f008862014-04-15 04:59:12 +00003231 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003232}
3233
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003234Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003235 const SimplifyQuery &Q) {
3236 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3237}
3238
Sanjay Patel472cc782016-01-11 22:14:42 +00003239/// Given operands for an FCmpInst, see if we can fold the result.
3240/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003241static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003242 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003243 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003244 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3245 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3246
Chris Lattnera71e9d62009-11-10 00:55:12 +00003247 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003248 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003249 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003250
Chris Lattnera71e9d62009-11-10 00:55:12 +00003251 // If we have a constant, make sure it is on the RHS.
3252 std::swap(LHS, RHS);
3253 Pred = CmpInst::getSwappedPredicate(Pred);
3254 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003255
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003256 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003257 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003258 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003259 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003260 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003261 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003262
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003263 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3264 if (FMF.noNaNs()) {
3265 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003266 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003267 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003268 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003269 }
3270
Mehdi Aminieb242a52015-03-09 03:20:25 +00003271 // fcmp pred x, undef and fcmp pred undef, x
3272 // fold to true if unordered, false if ordered
3273 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3274 // Choosing NaN for the undef will always make unordered comparison succeed
3275 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003276 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003277 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003278
3279 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003280 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003281 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003282 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003283 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003284 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003285 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003286
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003287 // Handle fcmp with constant RHS
David Majnemer3ee5f342016-04-13 06:55:52 +00003288 const ConstantFP *CFP = nullptr;
3289 if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3290 if (RHS->getType()->isVectorTy())
3291 CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3292 else
3293 CFP = dyn_cast<ConstantFP>(RHSC);
3294 }
3295 if (CFP) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003296 // If the constant is a nan, see if we can fold the comparison based on it.
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003297 if (CFP->getValueAPF().isNaN()) {
3298 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003299 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003300 assert(FCmpInst::isUnordered(Pred) &&
3301 "Comparison must be either ordered or unordered!");
3302 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003303 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003304 }
3305 // Check whether the constant is an infinity.
3306 if (CFP->getValueAPF().isInfinity()) {
3307 if (CFP->getValueAPF().isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003308 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003309 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003310 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003311 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003312 case FCmpInst::FCMP_UGE:
3313 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003314 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003315 default:
3316 break;
3317 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003318 } else {
3319 switch (Pred) {
3320 case FCmpInst::FCMP_OGT:
3321 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003322 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003323 case FCmpInst::FCMP_ULE:
3324 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003325 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003326 default:
3327 break;
3328 }
3329 }
3330 }
3331 if (CFP->getValueAPF().isZero()) {
3332 switch (Pred) {
3333 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003334 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003335 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003336 break;
3337 case FCmpInst::FCMP_OLT:
3338 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003339 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003340 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003341 break;
3342 default:
3343 break;
3344 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003345 }
3346 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003347
Duncan Sandsa620bd12010-11-07 16:46:25 +00003348 // If the comparison is with the result of a select instruction, check whether
3349 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003350 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003351 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003352 return V;
3353
3354 // If the comparison is with the result of a phi instruction, check whether
3355 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003356 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003357 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003358 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003359
Craig Topper9f008862014-04-15 04:59:12 +00003360 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003361}
3362
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003363Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003364 FastMathFlags FMF, const SimplifyQuery &Q) {
3365 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003366}
3367
Sanjay Patel472cc782016-01-11 22:14:42 +00003368/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003369static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003370 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003371 unsigned MaxRecurse) {
3372 // Trivial replacement.
3373 if (V == Op)
3374 return RepOp;
3375
Tim Northover997f5f12017-05-22 21:28:08 +00003376 // We cannot replace a constant, and shouldn't even try.
3377 if (isa<Constant>(Op))
3378 return nullptr;
3379
David Majnemer3f0fb982015-06-06 22:40:21 +00003380 auto *I = dyn_cast<Instruction>(V);
3381 if (!I)
3382 return nullptr;
3383
3384 // If this is a binary operator, try to simplify it with the replaced op.
3385 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3386 // Consider:
3387 // %cmp = icmp eq i32 %x, 2147483647
3388 // %add = add nsw i32 %x, 1
3389 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3390 //
3391 // We can't replace %sel with %add unless we strip away the flags.
3392 if (isa<OverflowingBinaryOperator>(B))
3393 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3394 return nullptr;
3395 if (isa<PossiblyExactOperator>(B))
3396 if (B->isExact())
3397 return nullptr;
3398
3399 if (MaxRecurse) {
3400 if (B->getOperand(0) == Op)
3401 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3402 MaxRecurse - 1);
3403 if (B->getOperand(1) == Op)
3404 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3405 MaxRecurse - 1);
3406 }
3407 }
3408
3409 // Same for CmpInsts.
3410 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3411 if (MaxRecurse) {
3412 if (C->getOperand(0) == Op)
3413 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3414 MaxRecurse - 1);
3415 if (C->getOperand(1) == Op)
3416 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3417 MaxRecurse - 1);
3418 }
3419 }
3420
3421 // TODO: We could hand off more cases to instsimplify here.
3422
3423 // If all operands are constant after substituting Op for RepOp then we can
3424 // constant fold the instruction.
3425 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3426 // Build a list of all constant operands.
3427 SmallVector<Constant *, 8> ConstOps;
3428 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3429 if (I->getOperand(i) == Op)
3430 ConstOps.push_back(CRepOp);
3431 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3432 ConstOps.push_back(COp);
3433 else
3434 break;
3435 }
3436
3437 // All operands were constants, fold it.
3438 if (ConstOps.size() == I->getNumOperands()) {
3439 if (CmpInst *C = dyn_cast<CmpInst>(I))
3440 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3441 ConstOps[1], Q.DL, Q.TLI);
3442
3443 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3444 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003445 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003446
Manuel Jacobe9024592016-01-21 06:33:22 +00003447 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003448 }
3449 }
3450
3451 return nullptr;
3452}
3453
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003454/// Try to simplify a select instruction when its condition operand is an
3455/// integer comparison where one operand of the compare is a constant.
3456static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3457 const APInt *Y, bool TrueWhenUnset) {
3458 const APInt *C;
3459
3460 // (X & Y) == 0 ? X & ~Y : X --> X
3461 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3462 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3463 *Y == ~*C)
3464 return TrueWhenUnset ? FalseVal : TrueVal;
3465
3466 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3467 // (X & Y) != 0 ? X : X & ~Y --> X
3468 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3469 *Y == ~*C)
3470 return TrueWhenUnset ? FalseVal : TrueVal;
3471
3472 if (Y->isPowerOf2()) {
3473 // (X & Y) == 0 ? X | Y : X --> X | Y
3474 // (X & Y) != 0 ? X | Y : X --> X
3475 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3476 *Y == *C)
3477 return TrueWhenUnset ? TrueVal : FalseVal;
3478
3479 // (X & Y) == 0 ? X : X | Y --> X
3480 // (X & Y) != 0 ? X : X | Y --> X | Y
3481 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3482 *Y == *C)
3483 return TrueWhenUnset ? TrueVal : FalseVal;
3484 }
Matt Arsenault82606662017-01-11 00:57:54 +00003485
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003486 return nullptr;
3487}
3488
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003489/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3490/// eq/ne.
Craig Topper0aa3a192017-08-14 21:39:51 +00003491static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3492 ICmpInst::Predicate Pred,
3493 Value *TrueVal, Value *FalseVal) {
3494 Value *X;
3495 APInt Mask;
3496 if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3497 return nullptr;
3498
Craig Topper0aa3a192017-08-14 21:39:51 +00003499 return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3500 Pred == ICmpInst::ICMP_EQ);
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003501}
3502
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003503/// Try to simplify a select instruction when its condition operand is an
3504/// integer comparison.
3505static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003506 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003507 unsigned MaxRecurse) {
3508 ICmpInst::Predicate Pred;
3509 Value *CmpLHS, *CmpRHS;
3510 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3511 return nullptr;
3512
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003513 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3514 Value *X;
3515 const APInt *Y;
3516 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3517 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3518 Pred == ICmpInst::ICMP_EQ))
3519 return V;
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003520 }
3521
Craig Topper0aa3a192017-08-14 21:39:51 +00003522 // Check for other compares that behave like bit test.
3523 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3524 TrueVal, FalseVal))
3525 return V;
3526
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003527 if (CondVal->hasOneUse()) {
3528 const APInt *C;
3529 if (match(CmpRHS, m_APInt(C))) {
3530 // X < MIN ? T : F --> F
3531 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3532 return FalseVal;
3533 // X < MIN ? T : F --> F
3534 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3535 return FalseVal;
3536 // X > MAX ? T : F --> F
3537 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3538 return FalseVal;
3539 // X > MAX ? T : F --> F
3540 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3541 return FalseVal;
3542 }
3543 }
3544
3545 // If we have an equality comparison, then we know the value in one of the
3546 // arms of the select. See if substituting this value into the arm and
3547 // simplifying the result yields the same value as the other arm.
3548 if (Pred == ICmpInst::ICMP_EQ) {
3549 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3550 TrueVal ||
3551 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3552 TrueVal)
3553 return FalseVal;
3554 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3555 FalseVal ||
3556 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3557 FalseVal)
3558 return FalseVal;
3559 } else if (Pred == ICmpInst::ICMP_NE) {
3560 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3561 FalseVal ||
3562 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3563 FalseVal)
3564 return TrueVal;
3565 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3566 TrueVal ||
3567 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3568 TrueVal)
3569 return TrueVal;
3570 }
3571
3572 return nullptr;
3573}
3574
Sanjay Patel472cc782016-01-11 22:14:42 +00003575/// Given operands for a SelectInst, see if we can fold the result.
3576/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003577static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003578 Value *FalseVal, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003579 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003580 // select true, X, Y -> X
3581 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003582 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3583 if (CB->isAllOnesValue())
3584 return TrueVal;
3585 if (CB->isNullValue())
3586 return FalseVal;
3587 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003588
Chris Lattnerc707fa92010-04-20 05:32:14 +00003589 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003590 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003591 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003592
Chris Lattnerc707fa92010-04-20 05:32:14 +00003593 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
Daniel Berlin4d0fe642017-04-28 19:55:38 +00003594 if (isa<Constant>(FalseVal))
3595 return FalseVal;
3596 return TrueVal;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003597 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003598 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3599 return FalseVal;
3600 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3601 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003602
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003603 if (Value *V =
3604 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3605 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003606
Craig Topper9f008862014-04-15 04:59:12 +00003607 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003608}
3609
Duncan Sandsb8cee002012-03-13 11:42:19 +00003610Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003611 const SimplifyQuery &Q) {
3612 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003613}
3614
Sanjay Patel472cc782016-01-11 22:14:42 +00003615/// Given operands for an GetElementPtrInst, see if we can fold the result.
3616/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003617static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003618 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003619 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003620 unsigned AS =
3621 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003622
Chris Lattner8574aba2009-11-27 00:29:05 +00003623 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003624 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003625 return Ops[0];
3626
Nico Weber48c82402014-08-27 20:06:19 +00003627 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003628 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003629 Type *GEPTy = PointerType::get(LastType, AS);
3630 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3631 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003632 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3633 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003634
3635 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003636 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003637
Jay Foadb992a632011-07-19 15:07:52 +00003638 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003639 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003640 if (match(Ops[1], m_Zero()))
3641 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003642
David Blaikie4a2e73b2015-04-02 18:55:32 +00003643 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003644 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003645 Value *P;
3646 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003647 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003648 // getelementptr P, N -> P if P points to a type of zero size.
3649 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003650 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003651
3652 // The following transforms are only safe if the ptrtoint cast
3653 // doesn't truncate the pointers.
3654 if (Ops[1]->getType()->getScalarSizeInBits() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003655 Q.DL.getPointerSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003656 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3657 if (match(P, m_Zero()))
3658 return Constant::getNullValue(GEPTy);
3659 Value *Temp;
3660 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003661 if (Temp->getType() == GEPTy)
3662 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003663 return nullptr;
3664 };
3665
3666 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3667 if (TyAllocSize == 1 &&
3668 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3669 if (Value *R = PtrToIntOrZero(P))
3670 return R;
3671
3672 // getelementptr V, (ashr (sub P, V), C) -> Q
3673 // if P points to a type of size 1 << C.
3674 if (match(Ops[1],
3675 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3676 m_ConstantInt(C))) &&
3677 TyAllocSize == 1ULL << C)
3678 if (Value *R = PtrToIntOrZero(P))
3679 return R;
3680
3681 // getelementptr V, (sdiv (sub P, V), C) -> Q
3682 // if P points to a type of size C.
3683 if (match(Ops[1],
3684 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3685 m_SpecificInt(TyAllocSize))))
3686 if (Value *R = PtrToIntOrZero(P))
3687 return R;
3688 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003689 }
3690 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003691
David Majnemerd1501372016-08-07 07:58:12 +00003692 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3693 all_of(Ops.slice(1).drop_back(1),
3694 [](Value *Idx) { return match(Idx, m_Zero()); })) {
3695 unsigned PtrWidth =
3696 Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3697 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3698 APInt BasePtrOffset(PtrWidth, 0);
3699 Value *StrippedBasePtr =
3700 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3701 BasePtrOffset);
3702
David Majnemer5c5df622016-08-16 06:13:46 +00003703 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003704 if (match(Ops.back(),
3705 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3706 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3707 return ConstantExpr::getIntToPtr(CI, GEPTy);
3708 }
David Majnemer5c5df622016-08-16 06:13:46 +00003709 // gep (gep V, C), (xor V, -1) -> C-1
3710 if (match(Ops.back(),
3711 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3712 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3713 return ConstantExpr::getIntToPtr(CI, GEPTy);
3714 }
David Majnemerd1501372016-08-07 07:58:12 +00003715 }
3716 }
3717
Chris Lattner8574aba2009-11-27 00:29:05 +00003718 // Check to see if this is constant foldable.
Craig Topperda8037f2017-06-04 22:41:56 +00003719 if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
3720 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003721
Joey Gouly61eaa632017-06-06 10:17:14 +00003722 auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3723 Ops.slice(1));
3724 if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
3725 return CEFolded;
3726 return CE;
Chris Lattner8574aba2009-11-27 00:29:05 +00003727}
3728
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003729Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003730 const SimplifyQuery &Q) {
3731 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003732}
3733
Sanjay Patel472cc782016-01-11 22:14:42 +00003734/// Given operands for an InsertValueInst, see if we can fold the result.
3735/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003736static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003737 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003738 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003739 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3740 if (Constant *CVal = dyn_cast<Constant>(Val))
3741 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3742
3743 // insertvalue x, undef, n -> x
3744 if (match(Val, m_Undef()))
3745 return Agg;
3746
3747 // insertvalue x, (extractvalue y, n), n
3748 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003749 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3750 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003751 // insertvalue undef, (extractvalue y, n), n -> y
3752 if (match(Agg, m_Undef()))
3753 return EV->getAggregateOperand();
3754
3755 // insertvalue y, (extractvalue y, n), n -> y
3756 if (Agg == EV->getAggregateOperand())
3757 return Agg;
3758 }
3759
Craig Topper9f008862014-04-15 04:59:12 +00003760 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003761}
3762
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003763Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3764 ArrayRef<unsigned> Idxs,
3765 const SimplifyQuery &Q) {
3766 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3767}
3768
Sanjay Patel472cc782016-01-11 22:14:42 +00003769/// Given operands for an ExtractValueInst, see if we can fold the result.
3770/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003771static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003772 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00003773 if (auto *CAgg = dyn_cast<Constant>(Agg))
3774 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3775
3776 // extractvalue x, (insertvalue y, elt, n), n -> elt
3777 unsigned NumIdxs = Idxs.size();
3778 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3779 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3780 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3781 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3782 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3783 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3784 Idxs.slice(0, NumCommonIdxs)) {
3785 if (NumIdxs == NumInsertValueIdxs)
3786 return IVI->getInsertedValueOperand();
3787 break;
3788 }
3789 }
3790
3791 return nullptr;
3792}
3793
3794Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003795 const SimplifyQuery &Q) {
3796 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
3797}
3798
Sanjay Patel472cc782016-01-11 22:14:42 +00003799/// Given operands for an ExtractElementInst, see if we can fold the result.
3800/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003801static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00003802 unsigned) {
3803 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3804 if (auto *CIdx = dyn_cast<Constant>(Idx))
3805 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3806
3807 // The index is not relevant if our vector is a splat.
3808 if (auto *Splat = CVec->getSplatValue())
3809 return Splat;
3810
3811 if (isa<UndefValue>(Vec))
3812 return UndefValue::get(Vec->getType()->getVectorElementType());
3813 }
3814
3815 // If extracting a specified index from the vector, see if we can recursively
3816 // find a previously computed scalar that was inserted into the vector.
David Majnemer8e335ca2015-08-18 22:18:22 +00003817 if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3818 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
David Majnemer599ca442015-07-13 01:15:53 +00003819 return Elt;
David Majnemer599ca442015-07-13 01:15:53 +00003820
3821 return nullptr;
3822}
3823
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003824Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
3825 const SimplifyQuery &Q) {
3826 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
3827}
3828
Sanjay Patel472cc782016-01-11 22:14:42 +00003829/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003830static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003831 // If all of the PHI's incoming values are the same then replace the PHI node
3832 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00003833 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00003834 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00003835 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003836 // If the incoming value is the phi node itself, it can safely be skipped.
3837 if (Incoming == PN) continue;
3838 if (isa<UndefValue>(Incoming)) {
3839 // Remember that we saw an undef value, but otherwise ignore them.
3840 HasUndefInput = true;
3841 continue;
3842 }
3843 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00003844 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00003845 CommonValue = Incoming;
3846 }
3847
3848 // If CommonValue is null then all of the incoming values were either undef or
3849 // equal to the phi node itself.
3850 if (!CommonValue)
3851 return UndefValue::get(PN->getType());
3852
3853 // If we have a PHI node like phi(X, undef, X), where X is defined by some
3854 // instruction, we cannot return X as the result of the PHI node unless it
3855 // dominates the PHI block.
3856 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00003857 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00003858
3859 return CommonValue;
3860}
3861
David Majnemer6774d612016-07-26 17:58:05 +00003862static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003863 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00003864 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00003865 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00003866
David Majnemer6774d612016-07-26 17:58:05 +00003867 if (auto *CI = dyn_cast<CastInst>(Op)) {
3868 auto *Src = CI->getOperand(0);
3869 Type *SrcTy = Src->getType();
3870 Type *MidTy = CI->getType();
3871 Type *DstTy = Ty;
3872 if (Src->getType() == Ty) {
3873 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
3874 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
3875 Type *SrcIntPtrTy =
3876 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
3877 Type *MidIntPtrTy =
3878 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
3879 Type *DstIntPtrTy =
3880 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
3881 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
3882 SrcIntPtrTy, MidIntPtrTy,
3883 DstIntPtrTy) == Instruction::BitCast)
3884 return Src;
3885 }
3886 }
David Majnemera90a6212016-07-26 05:52:29 +00003887
3888 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00003889 if (CastOpc == Instruction::BitCast)
3890 if (Op->getType() == Ty)
3891 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00003892
3893 return nullptr;
3894}
3895
David Majnemer6774d612016-07-26 17:58:05 +00003896Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003897 const SimplifyQuery &Q) {
3898 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
3899}
3900
Sanjay Patela3c297d2017-04-19 16:48:22 +00003901/// For the given destination element of a shuffle, peek through shuffles to
3902/// match a root vector source operand that contains that element in the same
3903/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
3904static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00003905 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00003906 unsigned MaxRecurse) {
3907 if (!MaxRecurse--)
3908 return nullptr;
3909
3910 // Bail out if any mask value is undefined. That kind of shuffle may be
3911 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00003912 if (MaskVal == -1)
3913 return nullptr;
3914
3915 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00003916 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00003917 int RootElt = MaskVal;
3918 Value *SourceOp = Op0;
3919 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00003920 RootElt = MaskVal - InVecNumElts;
3921 SourceOp = Op1;
3922 }
3923
3924 // If the source operand is a shuffle itself, look through it to find the
3925 // matching root vector.
3926 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
3927 return foldIdentityShuffles(
3928 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00003929 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00003930 }
3931
3932 // TODO: Look through bitcasts? What if the bitcast changes the vector element
3933 // size?
3934
3935 // The source operand is not a shuffle. Initialize the root vector value for
3936 // this shuffle if that has not been done yet.
3937 if (!RootVec)
3938 RootVec = SourceOp;
3939
3940 // Give up as soon as a source operand does not match the existing root value.
3941 if (RootVec != SourceOp)
3942 return nullptr;
3943
3944 // The element must be coming from the same lane in the source vector
3945 // (although it may have crossed lanes in intermediate shuffles).
3946 if (RootElt != DestElt)
3947 return nullptr;
3948
3949 return RootVec;
3950}
3951
Zvi Rackover8f460652017-04-03 22:05:30 +00003952static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003953 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00003954 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00003955 if (isa<UndefValue>(Mask))
3956 return UndefValue::get(RetTy);
3957
Zvi Rackover30efd24d2017-04-11 21:37:02 +00003958 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00003959 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00003960 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00003961
Zvi Rackover0411e462017-04-30 06:10:54 +00003962 SmallVector<int, 32> Indices;
3963 ShuffleVectorInst::getShuffleMask(Mask, Indices);
3964 assert(MaskNumElts == Indices.size() &&
3965 "Size of Indices not same as number of mask elements?");
3966
Zvi Rackover973ff7c2017-05-07 18:16:37 +00003967 // Canonicalization: If mask does not select elements from an input vector,
3968 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00003969 bool MaskSelects0 = false, MaskSelects1 = false;
3970 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00003971 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00003972 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00003973 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00003974 MaskSelects0 = true;
3975 else
3976 MaskSelects1 = true;
3977 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00003978 if (!MaskSelects0)
3979 Op0 = UndefValue::get(InVecTy);
3980 if (!MaskSelects1)
3981 Op1 = UndefValue::get(InVecTy);
3982
3983 auto *Op0Const = dyn_cast<Constant>(Op0);
3984 auto *Op1Const = dyn_cast<Constant>(Op1);
3985
3986 // If all operands are constant, constant fold the shuffle.
3987 if (Op0Const && Op1Const)
3988 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
3989
3990 // Canonicalization: if only one input vector is constant, it shall be the
3991 // second one.
3992 if (Op0Const && !Op1Const) {
3993 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00003994 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00003995 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00003996
3997 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
3998 // value type is same as the input vectors' type.
3999 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004000 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004001 OpShuf->getMask()->getSplatValue())
4002 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004003
Sanjay Patela3c297d2017-04-19 16:48:22 +00004004 // Don't fold a shuffle with undef mask elements. This may get folded in a
4005 // better way using demanded bits or other analysis.
4006 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004007 if (find(Indices, -1) != Indices.end())
4008 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004009
4010 // Check if every element of this shuffle can be mapped back to the
4011 // corresponding element of a single root vector. If so, we don't need this
4012 // shuffle. This handles simple identity shuffles as well as chains of
4013 // shuffles that may widen/narrow and/or move elements across lanes and back.
4014 Value *RootVec = nullptr;
4015 for (unsigned i = 0; i != MaskNumElts; ++i) {
4016 // Note that recursion is limited for each vector element, so if any element
4017 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004018 RootVec =
4019 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004020
4021 // We can't replace a widening/narrowing shuffle with one of its operands.
4022 if (!RootVec || RootVec->getType() != RetTy)
4023 return nullptr;
4024 }
4025 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004026}
4027
4028/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004029Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4030 Type *RetTy, const SimplifyQuery &Q) {
4031 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004032}
4033
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004034/// Given operands for an FAdd, see if we can fold the result. If not, this
4035/// returns null.
4036static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4037 const SimplifyQuery &Q, unsigned MaxRecurse) {
4038 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4039 return C;
4040
4041 // fadd X, -0 ==> X
4042 if (match(Op1, m_NegZero()))
4043 return Op0;
4044
4045 // fadd X, 0 ==> X, when we know X is not -0
4046 if (match(Op1, m_Zero()) &&
4047 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4048 return Op0;
4049
4050 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
4051 // where nnan and ninf have to occur at least once somewhere in this
4052 // expression
4053 Value *SubOp = nullptr;
4054 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
4055 SubOp = Op1;
4056 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
4057 SubOp = Op0;
4058 if (SubOp) {
4059 Instruction *FSub = cast<Instruction>(SubOp);
4060 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
4061 (FMF.noInfs() || FSub->hasNoInfs()))
4062 return Constant::getNullValue(Op0->getType());
4063 }
4064
4065 return nullptr;
4066}
4067
4068/// Given operands for an FSub, see if we can fold the result. If not, this
4069/// returns null.
4070static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4071 const SimplifyQuery &Q, unsigned MaxRecurse) {
4072 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
4073 return C;
4074
4075 // fsub X, 0 ==> X
4076 if (match(Op1, m_Zero()))
4077 return Op0;
4078
4079 // fsub X, -0 ==> X, when we know X is not -0
4080 if (match(Op1, m_NegZero()) &&
4081 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4082 return Op0;
4083
4084 // fsub -0.0, (fsub -0.0, X) ==> X
4085 Value *X;
4086 if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
4087 return X;
4088
4089 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
4090 if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
4091 match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
4092 return X;
4093
4094 // fsub nnan x, x ==> 0.0
4095 if (FMF.noNaNs() && Op0 == Op1)
4096 return Constant::getNullValue(Op0->getType());
4097
4098 return nullptr;
4099}
4100
4101/// Given the operands for an FMul, see if we can fold the result
4102static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4103 const SimplifyQuery &Q, unsigned MaxRecurse) {
4104 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
4105 return C;
4106
4107 // fmul X, 1.0 ==> X
4108 if (match(Op1, m_FPOne()))
4109 return Op0;
4110
4111 // fmul nnan nsz X, 0 ==> 0
4112 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
4113 return Op1;
4114
4115 return nullptr;
4116}
4117
4118Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4119 const SimplifyQuery &Q) {
4120 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
4121}
4122
4123
4124Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4125 const SimplifyQuery &Q) {
4126 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
4127}
4128
4129Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4130 const SimplifyQuery &Q) {
4131 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
4132}
4133
4134static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4135 const SimplifyQuery &Q, unsigned) {
4136 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
4137 return C;
4138
4139 // undef / X -> undef (the undef could be a snan).
4140 if (match(Op0, m_Undef()))
4141 return Op0;
4142
4143 // X / undef -> undef
4144 if (match(Op1, m_Undef()))
4145 return Op1;
4146
4147 // X / 1.0 -> X
4148 if (match(Op1, m_FPOne()))
4149 return Op0;
4150
4151 // 0 / X -> 0
4152 // Requires that NaNs are off (X could be zero) and signed zeroes are
4153 // ignored (X could be positive or negative, so the output sign is unknown).
4154 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
4155 return Op0;
4156
4157 if (FMF.noNaNs()) {
4158 // X / X -> 1.0 is legal when NaNs are ignored.
4159 if (Op0 == Op1)
4160 return ConstantFP::get(Op0->getType(), 1.0);
4161
4162 // -X / X -> -1.0 and
4163 // X / -X -> -1.0 are legal when NaNs are ignored.
4164 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
4165 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
4166 BinaryOperator::getFNegArgument(Op0) == Op1) ||
4167 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
4168 BinaryOperator::getFNegArgument(Op1) == Op0))
4169 return ConstantFP::get(Op0->getType(), -1.0);
4170 }
4171
4172 return nullptr;
4173}
4174
4175Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4176 const SimplifyQuery &Q) {
4177 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
4178}
4179
4180static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4181 const SimplifyQuery &Q, unsigned) {
4182 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
4183 return C;
4184
4185 // undef % X -> undef (the undef could be a snan).
4186 if (match(Op0, m_Undef()))
4187 return Op0;
4188
4189 // X % undef -> undef
4190 if (match(Op1, m_Undef()))
4191 return Op1;
4192
4193 // 0 % X -> 0
4194 // Requires that NaNs are off (X could be zero) and signed zeroes are
4195 // ignored (X could be positive or negative, so the output sign is unknown).
4196 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
4197 return Op0;
4198
4199 return nullptr;
4200}
4201
4202Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4203 const SimplifyQuery &Q) {
4204 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
4205}
4206
Chris Lattnera71e9d62009-11-10 00:55:12 +00004207//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004208
Sanjay Patel472cc782016-01-11 22:14:42 +00004209/// Given operands for a BinaryOperator, see if we can fold the result.
4210/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004211static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004212 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004213 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004214 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004215 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004216 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004217 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004218 case Instruction::Mul:
4219 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004220 case Instruction::SDiv:
4221 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4222 case Instruction::UDiv:
4223 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004224 case Instruction::SRem:
4225 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4226 case Instruction::URem:
4227 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004228 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004229 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004230 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004231 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004232 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004233 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4234 case Instruction::And:
4235 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4236 case Instruction::Or:
4237 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4238 case Instruction::Xor:
4239 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004240 case Instruction::FAdd:
4241 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4242 case Instruction::FSub:
4243 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4244 case Instruction::FMul:
4245 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4246 case Instruction::FDiv:
4247 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4248 case Instruction::FRem:
4249 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004250 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004251 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004252 }
4253}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004254
Sanjay Patel472cc782016-01-11 22:14:42 +00004255/// Given operands for a BinaryOperator, see if we can fold the result.
4256/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004257/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4258/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4259static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004260 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004261 unsigned MaxRecurse) {
4262 switch (Opcode) {
4263 case Instruction::FAdd:
4264 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4265 case Instruction::FSub:
4266 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4267 case Instruction::FMul:
4268 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004269 case Instruction::FDiv:
4270 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004271 default:
4272 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4273 }
4274}
4275
Duncan Sands7e800d62010-11-14 11:23:23 +00004276Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004277 const SimplifyQuery &Q) {
4278 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4279}
4280
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004281Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004282 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004283 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4284}
4285
Sanjay Patel472cc782016-01-11 22:14:42 +00004286/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004287static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004288 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004289 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004290 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004291 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004292}
4293
4294Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004295 const SimplifyQuery &Q) {
4296 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4297}
4298
Michael Ilseman54857292013-02-07 19:26:05 +00004299static bool IsIdempotent(Intrinsic::ID ID) {
4300 switch (ID) {
4301 default: return false;
4302
4303 // Unary idempotent: f(f(x)) = f(x)
4304 case Intrinsic::fabs:
4305 case Intrinsic::floor:
4306 case Intrinsic::ceil:
4307 case Intrinsic::trunc:
4308 case Intrinsic::rint:
4309 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004310 case Intrinsic::round:
Matt Arsenault3ced3d92017-09-07 01:21:43 +00004311 case Intrinsic::canonicalize:
Michael Ilseman54857292013-02-07 19:26:05 +00004312 return true;
4313 }
4314}
4315
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004316static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4317 const DataLayout &DL) {
4318 GlobalValue *PtrSym;
4319 APInt PtrOffset;
4320 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4321 return nullptr;
4322
4323 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4324 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4325 Type *Int32PtrTy = Int32Ty->getPointerTo();
4326 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4327
4328 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4329 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4330 return nullptr;
4331
4332 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4333 if (OffsetInt % 4 != 0)
4334 return nullptr;
4335
4336 Constant *C = ConstantExpr::getGetElementPtr(
4337 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4338 ConstantInt::get(Int64Ty, OffsetInt / 4));
4339 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4340 if (!Loaded)
4341 return nullptr;
4342
4343 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4344 if (!LoadedCE)
4345 return nullptr;
4346
4347 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4348 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4349 if (!LoadedCE)
4350 return nullptr;
4351 }
4352
4353 if (LoadedCE->getOpcode() != Instruction::Sub)
4354 return nullptr;
4355
4356 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4357 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4358 return nullptr;
4359 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4360
4361 Constant *LoadedRHS = LoadedCE->getOperand(1);
4362 GlobalValue *LoadedRHSSym;
4363 APInt LoadedRHSOffset;
4364 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4365 DL) ||
4366 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4367 return nullptr;
4368
4369 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4370}
4371
David Majnemer17a95aa2016-07-14 06:58:37 +00004372static bool maskIsAllZeroOrUndef(Value *Mask) {
4373 auto *ConstMask = dyn_cast<Constant>(Mask);
4374 if (!ConstMask)
4375 return false;
4376 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4377 return true;
4378 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4379 ++I) {
4380 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4381 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4382 continue;
4383 return false;
4384 }
4385 return true;
4386}
4387
Michael Ilseman54857292013-02-07 19:26:05 +00004388template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004389static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004390 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004391 Intrinsic::ID IID = F->getIntrinsicID();
4392 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004393
4394 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004395 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004396 // Perform idempotent optimizations
4397 if (IsIdempotent(IID)) {
4398 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4399 if (II->getIntrinsicID() == IID)
4400 return II;
4401 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004402 }
4403
4404 switch (IID) {
4405 case Intrinsic::fabs: {
4406 if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4407 return *ArgBegin;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004408 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004409 }
4410 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004411 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004412 }
4413 }
Michael Ilseman54857292013-02-07 19:26:05 +00004414
Matt Arsenault82606662017-01-11 00:57:54 +00004415 // Binary Ops
4416 if (NumOperands == 2) {
4417 Value *LHS = *ArgBegin;
4418 Value *RHS = *(ArgBegin + 1);
4419 Type *ReturnType = F->getReturnType();
4420
4421 switch (IID) {
4422 case Intrinsic::usub_with_overflow:
4423 case Intrinsic::ssub_with_overflow: {
4424 // X - X -> { 0, false }
4425 if (LHS == RHS)
4426 return Constant::getNullValue(ReturnType);
4427
4428 // X - undef -> undef
4429 // undef - X -> undef
4430 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4431 return UndefValue::get(ReturnType);
4432
4433 return nullptr;
4434 }
4435 case Intrinsic::uadd_with_overflow:
4436 case Intrinsic::sadd_with_overflow: {
4437 // X + undef -> undef
Craig Topper77e07cc2017-05-24 17:05:28 +00004438 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
Matt Arsenault82606662017-01-11 00:57:54 +00004439 return UndefValue::get(ReturnType);
4440
4441 return nullptr;
4442 }
4443 case Intrinsic::umul_with_overflow:
4444 case Intrinsic::smul_with_overflow: {
Craig Topper77e07cc2017-05-24 17:05:28 +00004445 // 0 * X -> { 0, false }
Matt Arsenault82606662017-01-11 00:57:54 +00004446 // X * 0 -> { 0, false }
Craig Topper77e07cc2017-05-24 17:05:28 +00004447 if (match(LHS, m_Zero()) || match(RHS, m_Zero()))
Matt Arsenault82606662017-01-11 00:57:54 +00004448 return Constant::getNullValue(ReturnType);
4449
Craig Topper77e07cc2017-05-24 17:05:28 +00004450 // undef * X -> { 0, false }
Matt Arsenault82606662017-01-11 00:57:54 +00004451 // X * undef -> { 0, false }
Craig Topper77e07cc2017-05-24 17:05:28 +00004452 if (match(LHS, m_Undef()) || match(RHS, m_Undef()))
Matt Arsenault82606662017-01-11 00:57:54 +00004453 return Constant::getNullValue(ReturnType);
4454
4455 return nullptr;
4456 }
4457 case Intrinsic::load_relative: {
4458 Constant *C0 = dyn_cast<Constant>(LHS);
4459 Constant *C1 = dyn_cast<Constant>(RHS);
4460 if (C0 && C1)
4461 return SimplifyRelativeLoad(C0, C1, Q.DL);
4462 return nullptr;
4463 }
4464 default:
4465 return nullptr;
4466 }
4467 }
4468
4469 // Simplify calls to llvm.masked.load.*
4470 switch (IID) {
4471 case Intrinsic::masked_load: {
4472 Value *MaskArg = ArgBegin[2];
4473 Value *PassthruArg = ArgBegin[3];
4474 // If the mask is all zeros or undef, the "passthru" argument is the result.
4475 if (maskIsAllZeroOrUndef(MaskArg))
4476 return PassthruArg;
4477 return nullptr;
4478 }
4479 default:
4480 return nullptr;
4481 }
Michael Ilseman54857292013-02-07 19:26:05 +00004482}
4483
Chandler Carruth9dc35582012-12-28 11:30:55 +00004484template <typename IterTy>
Andrew Kaylor647025f2017-06-09 23:18:11 +00004485static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
4486 IterTy ArgEnd, const SimplifyQuery &Q,
4487 unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004488 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004489 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4490 Ty = PTy->getElementType();
4491 FunctionType *FTy = cast<FunctionType>(Ty);
4492
Dan Gohman85977e62011-11-04 18:32:42 +00004493 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004494 // call null -> undef
4495 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004496 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004497
Chandler Carruthf6182152012-12-28 14:23:29 +00004498 Function *F = dyn_cast<Function>(V);
4499 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004500 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004501
David Majnemer15032582015-05-22 03:56:46 +00004502 if (F->isIntrinsic())
4503 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004504 return Ret;
4505
Andrew Kaylor647025f2017-06-09 23:18:11 +00004506 if (!canConstantFoldCallTo(CS, F))
Craig Topper9f008862014-04-15 04:59:12 +00004507 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004508
4509 SmallVector<Constant *, 4> ConstantArgs;
4510 ConstantArgs.reserve(ArgEnd - ArgBegin);
4511 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4512 Constant *C = dyn_cast<Constant>(*I);
4513 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004514 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004515 ConstantArgs.push_back(C);
4516 }
4517
Andrew Kaylor647025f2017-06-09 23:18:11 +00004518 return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004519}
4520
Andrew Kaylor647025f2017-06-09 23:18:11 +00004521Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4522 User::op_iterator ArgBegin, User::op_iterator ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004523 const SimplifyQuery &Q) {
Andrew Kaylor647025f2017-06-09 23:18:11 +00004524 return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
4525}
4526
4527Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4528 ArrayRef<Value *> Args, const SimplifyQuery &Q) {
4529 return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004530}
4531
Sanjay Patel472cc782016-01-11 22:14:42 +00004532/// See if we can compute a simplified version of this instruction.
4533/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004534
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004535Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004536 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004537 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004538 Value *Result;
4539
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004540 switch (I->getOpcode()) {
4541 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004542 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004543 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004544 case Instruction::FAdd:
4545 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004546 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004547 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004548 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004549 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4550 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004551 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004552 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004553 case Instruction::FSub:
4554 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004555 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004556 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004557 case Instruction::Sub:
4558 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4559 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004560 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004561 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004562 case Instruction::FMul:
4563 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004564 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004565 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004566 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004567 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004568 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004569 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004570 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004571 break;
4572 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004573 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004574 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004575 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004576 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004577 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00004578 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004579 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004580 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004581 break;
4582 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004583 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004584 break;
4585 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004586 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004587 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004588 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004589 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004590 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4591 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004592 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004593 break;
4594 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004595 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004596 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004597 break;
4598 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004599 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004600 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004601 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004602 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004603 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004604 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004605 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004606 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004607 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004608 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004609 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004610 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004611 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004612 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4613 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004614 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004615 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004616 Result =
4617 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4618 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004619 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004620 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004621 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004622 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004623 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004624 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004625 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004626 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004627 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004628 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004629 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004630 case Instruction::InsertValue: {
4631 InsertValueInst *IV = cast<InsertValueInst>(I);
4632 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4633 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004634 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004635 break;
4636 }
David Majnemer25a796e2015-07-13 01:15:46 +00004637 case Instruction::ExtractValue: {
4638 auto *EVI = cast<ExtractValueInst>(I);
4639 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004640 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00004641 break;
4642 }
David Majnemer599ca442015-07-13 01:15:53 +00004643 case Instruction::ExtractElement: {
4644 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004645 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4646 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00004647 break;
4648 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004649 case Instruction::ShuffleVector: {
4650 auto *SVI = cast<ShuffleVectorInst>(I);
4651 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004652 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00004653 break;
4654 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004655 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004656 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004657 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004658 case Instruction::Call: {
4659 CallSite CS(cast<CallInst>(I));
Andrew Kaylor647025f2017-06-09 23:18:11 +00004660 Result = SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
4661 Q);
Dan Gohman85977e62011-11-04 18:32:42 +00004662 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004663 }
David Majnemer6774d612016-07-26 17:58:05 +00004664#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4665#include "llvm/IR/Instruction.def"
4666#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004667 Result =
4668 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00004669 break;
Craig Topper81c03a72017-04-12 22:54:24 +00004670 case Instruction::Alloca:
4671 // No simplifications for Alloca and it can't be constant folded.
4672 Result = nullptr;
4673 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004674 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004675
Hal Finkelf2199b22015-10-23 20:37:08 +00004676 // In general, it is possible for computeKnownBits to determine all bits in a
4677 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004678 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Craig Topper8205a1a2017-05-24 16:53:07 +00004679 KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00004680 if (Known.isConstant())
4681 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00004682 }
4683
Duncan Sands64e41cf2010-11-17 08:35:29 +00004684 /// If called on unreachable code, the above logic may report that the
4685 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004686 /// detecting that case here, returning a safe value instead.
4687 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004688}
4689
Sanjay Patelf44bd382016-01-20 18:59:48 +00004690/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004691/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004692///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004693/// This is the common implementation of the recursive simplification routines.
4694/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4695/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4696/// instructions to process and attempt to simplify it using
4697/// InstructionSimplify.
4698///
4699/// This routine returns 'true' only when *it* simplifies something. The passed
4700/// in simplified value does not count toward this.
4701static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004702 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004703 const DominatorTree *DT,
4704 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004705 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004706 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004707 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004708
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004709 // If we have an explicit value to collapse to, do that round of the
4710 // simplification loop by hand initially.
4711 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004712 for (User *U : I->users())
4713 if (U != I)
4714 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004715
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004716 // Replace the instruction with its simplified value.
4717 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004718
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004719 // Gracefully handle edge cases where the instruction is not wired into any
4720 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004721 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4722 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004723 I->eraseFromParent();
4724 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004725 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004726 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004727
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004728 // Note that we must test the size on each iteration, the worklist can grow.
4729 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4730 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004731
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004732 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004733 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004734 if (!SimpleV)
4735 continue;
4736
4737 Simplified = true;
4738
4739 // Stash away all the uses of the old instruction so we can check them for
4740 // recursive simplifications after a RAUW. This is cheaper than checking all
4741 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004742 for (User *U : I->users())
4743 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004744
4745 // Replace the instruction with its simplified value.
4746 I->replaceAllUsesWith(SimpleV);
4747
4748 // Gracefully handle edge cases where the instruction is not wired into any
4749 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004750 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4751 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004752 I->eraseFromParent();
4753 }
4754 return Simplified;
4755}
4756
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004757bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004758 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004759 const DominatorTree *DT,
4760 AssumptionCache *AC) {
4761 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004762}
4763
4764bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004765 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004766 const DominatorTree *DT,
4767 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004768 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4769 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004770 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004771}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004772
4773namespace llvm {
4774const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
4775 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
4776 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
4777 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
4778 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
4779 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
4780 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
4781 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4782}
4783
4784const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
4785 const DataLayout &DL) {
4786 return {DL, &AR.TLI, &AR.DT, &AR.AC};
4787}
4788
4789template <class T, class... TArgs>
4790const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
4791 Function &F) {
4792 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
4793 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
4794 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
4795 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4796}
4797template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
4798 Function &);
4799}