blob: 0fb0b7d24493dd2523d1ee67bf966ce7308d9f9a [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
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000795/// Given operands for an FAdd, see if we can fold the result. If not, this
796/// returns null.
797static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000798 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000799 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
800 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000801
802 // fadd X, -0 ==> X
803 if (match(Op1, m_NegZero()))
804 return Op0;
805
806 // fadd X, 0 ==> X, when we know X is not -0
807 if (match(Op1, m_Zero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000808 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000809 return Op0;
810
811 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
812 // where nnan and ninf have to occur at least once somewhere in this
813 // expression
Craig Topper9f008862014-04-15 04:59:12 +0000814 Value *SubOp = nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000815 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
816 SubOp = Op1;
817 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
818 SubOp = Op0;
819 if (SubOp) {
820 Instruction *FSub = cast<Instruction>(SubOp);
821 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
822 (FMF.noInfs() || FSub->hasNoInfs()))
823 return Constant::getNullValue(Op0->getType());
824 }
825
Craig Topper9f008862014-04-15 04:59:12 +0000826 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000827}
828
829/// Given operands for an FSub, see if we can fold the result. If not, this
830/// returns null.
831static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000832 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000833 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
834 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000835
836 // fsub X, 0 ==> X
837 if (match(Op1, m_Zero()))
838 return Op0;
839
840 // fsub X, -0 ==> X, when we know X is not -0
841 if (match(Op1, m_NegZero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000842 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000843 return Op0;
844
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000845 // fsub -0.0, (fsub -0.0, X) ==> X
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000846 Value *X;
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000847 if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
848 return X;
849
850 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Benjamin Kramer6bb15022016-02-29 12:18:25 +0000851 if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000852 match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
853 return X;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000854
Benjamin Kramer228680d2015-06-14 21:01:20 +0000855 // fsub nnan x, x ==> 0.0
856 if (FMF.noNaNs() && Op0 == Op1)
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000857 return Constant::getNullValue(Op0->getType());
858
Craig Topper9f008862014-04-15 04:59:12 +0000859 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000860}
861
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000862/// Given the operands for an FMul, see if we can fold the result
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000863static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000864 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000865 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
866 return C;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000867
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000868 // fmul X, 1.0 ==> X
869 if (match(Op1, m_FPOne()))
870 return Op0;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000871
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000872 // fmul nnan nsz X, 0 ==> 0
873 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
874 return Op1;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000875
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000876 return nullptr;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000877}
878
Sanjay Patel472cc782016-01-11 22:14:42 +0000879/// Given operands for a Mul, see if we can fold the result.
880/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000881static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000882 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000883 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
884 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000885
886 // X * undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000887 if (match(Op1, m_Undef()))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000888 return Constant::getNullValue(Op0->getType());
889
890 // X * 0 -> 0
891 if (match(Op1, m_Zero()))
892 return Op1;
893
894 // X * 1 -> X
895 if (match(Op1, m_One()))
896 return Op0;
897
Duncan Sandsb67edc62011-01-30 18:03:50 +0000898 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000899 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000900 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
901 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
902 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000903
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000904 // i1 mul -> and.
Craig Topperfde47232017-07-09 07:04:03 +0000905 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000906 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000907 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000908
909 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000910 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000911 MaxRecurse))
912 return V;
913
914 // Mul distributes over Add. Try some generic simplifications based on this.
915 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000916 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000917 return V;
918
919 // If the operation is with the result of a select instruction, check whether
920 // operating on either branch of the select always yields the same value.
921 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000922 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000923 MaxRecurse))
924 return V;
925
926 // If the operation is with the result of a phi instruction, check whether
927 // operating on all incoming values of the phi always yields the same value.
928 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000929 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000930 MaxRecurse))
931 return V;
932
Craig Topper9f008862014-04-15 04:59:12 +0000933 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000934}
935
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000936Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000937 const SimplifyQuery &Q) {
938 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
939}
940
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000941
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000942Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
943 const SimplifyQuery &Q) {
944 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
945}
946
Chandler Carruth66b31302015-01-04 12:03:27 +0000947Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000948 const SimplifyQuery &Q) {
949 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
950}
951
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000952Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
953 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
954}
955
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000956/// Check for common or similar folds of integer division or integer remainder.
957static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
958 Type *Ty = Op0->getType();
959
960 // X / undef -> undef
961 // X % undef -> undef
962 if (match(Op1, m_Undef()))
963 return Op1;
964
965 // X / 0 -> undef
966 // X % 0 -> undef
967 // We don't need to preserve faults!
968 if (match(Op1, m_Zero()))
969 return UndefValue::get(Ty);
970
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000971 // If any element of a constant divisor vector is zero, the whole op is undef.
972 auto *Op1C = dyn_cast<Constant>(Op1);
973 if (Op1C && Ty->isVectorTy()) {
974 unsigned NumElts = Ty->getVectorNumElements();
975 for (unsigned i = 0; i != NumElts; ++i) {
976 Constant *Elt = Op1C->getAggregateElement(i);
977 if (Elt && Elt->isNullValue())
978 return UndefValue::get(Ty);
979 }
980 }
981
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000982 // undef / X -> 0
983 // undef % X -> 0
984 if (match(Op0, m_Undef()))
985 return Constant::getNullValue(Ty);
986
987 // 0 / X -> 0
988 // 0 % X -> 0
989 if (match(Op0, m_Zero()))
990 return Op0;
991
992 // X / X -> 1
993 // X % X -> 0
994 if (Op0 == Op1)
995 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
996
997 // X / 1 -> X
998 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +0000999 // If this is a boolean op (single-bit element type), we can't have
1000 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
Craig Topperfde47232017-07-09 07:04:03 +00001001 if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001002 return IsDiv ? Op0 : Constant::getNullValue(Ty);
1003
1004 return nullptr;
1005}
1006
Sanjay Patel472cc782016-01-11 22:14:42 +00001007/// Given operands for an SDiv or UDiv, see if we can fold the result.
1008/// If not, this returns null.
Anders Carlsson36c6d232011-02-05 18:33:43 +00001009static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001010 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001011 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1012 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001013
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001014 if (Value *V = simplifyDivRem(Op0, Op1, true))
1015 return V;
1016
Duncan Sands65995fa2011-01-28 18:50:50 +00001017 bool isSigned = Opcode == Instruction::SDiv;
1018
Duncan Sands771e82a2011-01-28 16:51:11 +00001019 // (X * Y) / Y -> X if the multiplication does not overflow.
Craig Topper9f008862014-04-15 04:59:12 +00001020 Value *X = nullptr, *Y = nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001021 if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1022 if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
Duncan Sands7cb61e52011-10-27 19:16:21 +00001023 OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
Duncan Sands5747aba2011-02-02 20:52:00 +00001024 // If the Mul knows it does not overflow, then we are good to go.
1025 if ((isSigned && Mul->hasNoSignedWrap()) ||
1026 (!isSigned && Mul->hasNoUnsignedWrap()))
1027 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001028 // If X has the form X = A / Y then X * Y cannot overflow.
1029 if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1030 if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1031 return X;
1032 }
1033
Duncan Sands65995fa2011-01-28 18:50:50 +00001034 // (X rem Y) / Y -> 0
1035 if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1036 (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1037 return Constant::getNullValue(Op0->getType());
1038
David Majnemercb9d5962014-10-11 10:20:01 +00001039 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1040 ConstantInt *C1, *C2;
1041 if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1042 match(Op1, m_ConstantInt(C2))) {
1043 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001044 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001045 if (Overflow)
1046 return Constant::getNullValue(Op0->getType());
1047 }
1048
Duncan Sands65995fa2011-01-28 18:50:50 +00001049 // If the operation is with the result of a select instruction, check whether
1050 // operating on either branch of the select always yields the same value.
1051 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001052 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001053 return V;
1054
1055 // If the operation is with the result of a phi instruction, check whether
1056 // operating on all incoming values of the phi always yields the same value.
1057 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001058 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001059 return V;
1060
Craig Topper9f008862014-04-15 04:59:12 +00001061 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001062}
1063
Sanjay Patel472cc782016-01-11 22:14:42 +00001064/// Given operands for an SDiv, see if we can fold the result.
1065/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001066static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001067 unsigned MaxRecurse) {
1068 if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001069 return V;
1070
Craig Topper9f008862014-04-15 04:59:12 +00001071 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001072}
1073
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001074Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1075 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1076}
1077
Sanjay Patel472cc782016-01-11 22:14:42 +00001078/// Given operands for a UDiv, see if we can fold the result.
1079/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001080static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001081 unsigned MaxRecurse) {
1082 if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001083 return V;
1084
David Majnemer63da0c22017-01-06 22:58:02 +00001085 // udiv %V, C -> 0 if %V < C
1086 if (MaxRecurse) {
1087 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1088 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1089 if (C->isAllOnesValue()) {
1090 return Constant::getNullValue(Op0->getType());
1091 }
1092 }
1093 }
1094
Craig Topper9f008862014-04-15 04:59:12 +00001095 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001096}
1097
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001098Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1099 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1100}
1101
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001102static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001103 const SimplifyQuery &Q, unsigned) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001104 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
1105 return C;
1106
Frits van Bommelc2549662011-01-29 15:26:31 +00001107 // undef / X -> undef (the undef could be a snan).
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001108 if (match(Op0, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001109 return Op0;
1110
1111 // X / undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001112 if (match(Op1, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001113 return Op1;
1114
Zia Ansari394cef82016-12-08 23:27:40 +00001115 // X / 1.0 -> X
1116 if (match(Op1, m_FPOne()))
1117 return Op0;
1118
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001119 // 0 / X -> 0
1120 // Requires that NaNs are off (X could be zero) and signed zeroes are
1121 // ignored (X could be positive or negative, so the output sign is unknown).
1122 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1123 return Op0;
1124
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001125 if (FMF.noNaNs()) {
1126 // X / X -> 1.0 is legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001127 if (Op0 == Op1)
1128 return ConstantFP::get(Op0->getType(), 1.0);
1129
1130 // -X / X -> -1.0 and
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001131 // X / -X -> -1.0 are legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001132 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
1133 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
1134 BinaryOperator::getFNegArgument(Op0) == Op1) ||
1135 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
1136 BinaryOperator::getFNegArgument(Op1) == Op0))
1137 return ConstantFP::get(Op0->getType(), -1.0);
1138 }
1139
Craig Topper9f008862014-04-15 04:59:12 +00001140 return nullptr;
Frits van Bommelc2549662011-01-29 15:26:31 +00001141}
1142
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001143Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001144 const SimplifyQuery &Q) {
1145 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
1146}
1147
Sanjay Patel472cc782016-01-11 22:14:42 +00001148/// Given operands for an SRem or URem, see if we can fold the result.
1149/// If not, this returns null.
Duncan Sandsa3e36992011-05-02 16:27:02 +00001150static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001151 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001152 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1153 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001154
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001155 if (Value *V = simplifyDivRem(Op0, Op1, false))
1156 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001157
David Majnemerb435a422014-09-17 04:16:35 +00001158 // (X % Y) % Y -> X % Y
1159 if ((Opcode == Instruction::SRem &&
1160 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1161 (Opcode == Instruction::URem &&
1162 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001163 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001164
Duncan Sandsa3e36992011-05-02 16:27:02 +00001165 // If the operation is with the result of a select instruction, check whether
1166 // operating on either branch of the select always yields the same value.
1167 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001168 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001169 return V;
1170
1171 // If the operation is with the result of a phi instruction, check whether
1172 // operating on all incoming values of the phi always yields the same value.
1173 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001174 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001175 return V;
1176
Craig Topper9f008862014-04-15 04:59:12 +00001177 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001178}
1179
Sanjay Patel472cc782016-01-11 22:14:42 +00001180/// Given operands for an SRem, see if we can fold the result.
1181/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001182static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001183 unsigned MaxRecurse) {
1184 if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001185 return V;
1186
Craig Topper9f008862014-04-15 04:59:12 +00001187 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001188}
1189
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001190Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1191 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1192}
1193
Sanjay Patel472cc782016-01-11 22:14:42 +00001194/// Given operands for a URem, see if we can fold the result.
1195/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001196static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001197 unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001198 if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001199 return V;
1200
David Majnemer8c0e62f2017-01-06 21:23:51 +00001201 // urem %V, C -> %V if %V < C
1202 if (MaxRecurse) {
1203 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1204 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1205 if (C->isAllOnesValue()) {
1206 return Op0;
1207 }
1208 }
1209 }
1210
Craig Topper9f008862014-04-15 04:59:12 +00001211 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001212}
1213
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001214Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1215 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1216}
1217
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001218static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001219 const SimplifyQuery &Q, unsigned) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001220 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
1221 return C;
1222
Duncan Sandsa3e36992011-05-02 16:27:02 +00001223 // undef % X -> undef (the undef could be a snan).
1224 if (match(Op0, m_Undef()))
1225 return Op0;
1226
1227 // X % undef -> undef
1228 if (match(Op1, m_Undef()))
1229 return Op1;
1230
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001231 // 0 % X -> 0
1232 // Requires that NaNs are off (X could be zero) and signed zeroes are
1233 // ignored (X could be positive or negative, so the output sign is unknown).
1234 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1235 return Op0;
1236
Craig Topper9f008862014-04-15 04:59:12 +00001237 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001238}
1239
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001240Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001241 const SimplifyQuery &Q) {
1242 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
1243}
1244
Sanjay Patel472cc782016-01-11 22:14:42 +00001245/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001246static bool isUndefShift(Value *Amount) {
1247 Constant *C = dyn_cast<Constant>(Amount);
1248 if (!C)
1249 return false;
1250
1251 // X shift by undef -> undef because it may shift by the bitwidth.
1252 if (isa<UndefValue>(C))
1253 return true;
1254
1255 // Shifting by the bitwidth or more is undefined.
1256 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1257 if (CI->getValue().getLimitedValue() >=
1258 CI->getType()->getScalarSizeInBits())
1259 return true;
1260
1261 // If all lanes of a vector shift are undefined the whole shift is.
1262 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1263 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1264 if (!isUndefShift(C->getAggregateElement(I)))
1265 return false;
1266 return true;
1267 }
1268
1269 return false;
1270}
1271
Sanjay Patel472cc782016-01-11 22:14:42 +00001272/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1273/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001274static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001275 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001276 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1277 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001278
Duncan Sands571fd9a2011-01-14 14:44:12 +00001279 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001280 if (match(Op0, m_Zero()))
1281 return Op0;
1282
Duncan Sands571fd9a2011-01-14 14:44:12 +00001283 // X shift by 0 -> X
Duncan Sands7f60dc12011-01-14 00:37:45 +00001284 if (match(Op1, m_Zero()))
1285 return Op0;
1286
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001287 // Fold undefined shifts.
1288 if (isUndefShift(Op1))
1289 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001290
Duncan Sands571fd9a2011-01-14 14:44:12 +00001291 // If the operation is with the result of a select instruction, check whether
1292 // operating on either branch of the select always yields the same value.
1293 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001294 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001295 return V;
1296
1297 // If the operation is with the result of a phi instruction, check whether
1298 // operating on all incoming values of the phi always yields the same value.
1299 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001300 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001301 return V;
1302
Sanjay Patel6786bc52016-05-10 20:46:54 +00001303 // If any bits in the shift amount make that value greater than or equal to
1304 // the number of bits in the type, the shift is undefined.
Craig Topper8205a1a2017-05-24 16:53:07 +00001305 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1306 if (Known.One.getLimitedValue() >= Known.getBitWidth())
Sanjay Patel6786bc52016-05-10 20:46:54 +00001307 return UndefValue::get(Op0->getType());
1308
1309 // If all valid bits in the shift amount are known zero, the first operand is
1310 // unchanged.
Craig Topper8205a1a2017-05-24 16:53:07 +00001311 unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
Craig Topper8df66c62017-05-12 17:20:30 +00001312 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001313 return Op0;
1314
Craig Topper9f008862014-04-15 04:59:12 +00001315 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001316}
1317
David Majnemerbf7550e2014-11-05 00:59:59 +00001318/// \brief Given operands for an Shl, LShr or AShr, see if we can
1319/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001320static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001321 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001322 unsigned MaxRecurse) {
1323 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1324 return V;
1325
1326 // X >> X -> 0
1327 if (Op0 == Op1)
1328 return Constant::getNullValue(Op0->getType());
1329
David Majnemer65c52ae2014-12-17 01:54:33 +00001330 // undef >> X -> 0
1331 // undef >> X -> undef (if it's exact)
1332 if (match(Op0, m_Undef()))
1333 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1334
David Majnemerbf7550e2014-11-05 00:59:59 +00001335 // The low bit cannot be shifted out of an exact shift if it is set.
1336 if (isExact) {
Craig Topper8205a1a2017-05-24 16:53:07 +00001337 KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +00001338 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001339 return Op0;
1340 }
1341
1342 return nullptr;
1343}
1344
Sanjay Patel472cc782016-01-11 22:14:42 +00001345/// Given operands for an Shl, see if we can fold the result.
1346/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001347static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001348 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001349 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001350 return V;
1351
1352 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001353 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001354 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001355 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001356
Chris Lattner9e4aa022011-02-09 17:15:04 +00001357 // (X >> A) << A -> X
1358 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001359 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001360 return X;
Craig Topper9f008862014-04-15 04:59:12 +00001361 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001362}
1363
Chris Lattner9e4aa022011-02-09 17:15:04 +00001364Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001365 const SimplifyQuery &Q) {
1366 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1367}
1368
Sanjay Patel472cc782016-01-11 22:14:42 +00001369/// Given operands for an LShr, see if we can fold the result.
1370/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001371static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001372 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001373 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1374 MaxRecurse))
1375 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001376
Chris Lattner9e4aa022011-02-09 17:15:04 +00001377 // (X << A) >> A -> X
1378 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001379 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001380 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001381
Craig Topper9f008862014-04-15 04:59:12 +00001382 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001383}
1384
Chris Lattner9e4aa022011-02-09 17:15:04 +00001385Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001386 const SimplifyQuery &Q) {
1387 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1388}
1389
Sanjay Patel472cc782016-01-11 22:14:42 +00001390/// Given operands for an AShr, see if we can fold the result.
1391/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001392static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001393 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001394 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1395 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001396 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001397
1398 // all ones >>a X -> all ones
1399 if (match(Op0, m_AllOnes()))
1400 return Op0;
1401
Chris Lattner9e4aa022011-02-09 17:15:04 +00001402 // (X << A) >> A -> X
1403 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001404 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001405 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001406
Suyog Sarda68862412014-07-17 06:28:15 +00001407 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001408 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001409 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1410 return Op0;
1411
Craig Topper9f008862014-04-15 04:59:12 +00001412 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001413}
1414
Chris Lattner9e4aa022011-02-09 17:15:04 +00001415Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001416 const SimplifyQuery &Q) {
1417 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1418}
1419
Craig Topper348314d2017-05-26 22:42:34 +00001420/// Commuted variants are assumed to be handled by calling this function again
1421/// with the parameters swapped.
David Majnemer1af36e52014-12-06 10:51:40 +00001422static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1423 ICmpInst *UnsignedICmp, bool IsAnd) {
1424 Value *X, *Y;
1425
1426 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001427 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1428 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001429 return nullptr;
1430
1431 ICmpInst::Predicate UnsignedPred;
1432 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1433 ICmpInst::isUnsigned(UnsignedPred))
1434 ;
1435 else if (match(UnsignedICmp,
1436 m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1437 ICmpInst::isUnsigned(UnsignedPred))
1438 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1439 else
1440 return nullptr;
1441
1442 // X < Y && Y != 0 --> X < Y
1443 // X < Y || Y != 0 --> Y != 0
1444 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1445 return IsAnd ? UnsignedICmp : ZeroICmp;
1446
1447 // X >= Y || Y != 0 --> true
1448 // X >= Y || Y == 0 --> X >= Y
1449 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1450 if (EqPred == ICmpInst::ICMP_NE)
1451 return getTrue(UnsignedICmp->getType());
1452 return UnsignedICmp;
1453 }
1454
David Majnemerd5b3aa42014-12-08 18:30:43 +00001455 // X < Y && Y == 0 --> false
1456 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1457 IsAnd)
1458 return getFalse(UnsignedICmp->getType());
1459
David Majnemer1af36e52014-12-06 10:51:40 +00001460 return nullptr;
1461}
1462
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001463/// Commuted variants are assumed to be handled by calling this function again
1464/// with the parameters swapped.
1465static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1466 ICmpInst::Predicate Pred0, Pred1;
1467 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001468 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1469 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001470 return nullptr;
1471
1472 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1473 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1474 // can eliminate Op1 from this 'and'.
1475 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1476 return Op0;
1477
1478 // Check for any combination of predicates that are guaranteed to be disjoint.
1479 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1480 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1481 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1482 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1483 return getFalse(Op0->getType());
1484
1485 return nullptr;
1486}
1487
1488/// Commuted variants are assumed to be handled by calling this function again
1489/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001490static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1491 ICmpInst::Predicate Pred0, Pred1;
1492 Value *A ,*B;
1493 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1494 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1495 return nullptr;
1496
1497 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1498 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1499 // can eliminate Op0 from this 'or'.
1500 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1501 return Op1;
1502
1503 // Check for any combination of predicates that cover the entire range of
1504 // possibilities.
1505 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1506 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1507 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1508 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1509 return getTrue(Op0->getType());
1510
1511 return nullptr;
1512}
1513
Sanjay Patel599e65b2017-05-07 15:11:40 +00001514/// Test if a pair of compares with a shared operand and 2 constants has an
1515/// empty set intersection, full set union, or if one compare is a superset of
1516/// the other.
1517static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1518 bool IsAnd) {
1519 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1520 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1521 return nullptr;
1522
1523 const APInt *C0, *C1;
1524 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1525 !match(Cmp1->getOperand(1), m_APInt(C1)))
1526 return nullptr;
1527
1528 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1529 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1530
Sanjay Patel67454472017-05-08 16:35:02 +00001531 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001532 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1533 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1534 return getFalse(Cmp0->getType());
1535
1536 // For or-of-compares, check if the union is full:
1537 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1538 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1539 return getTrue(Cmp0->getType());
1540
1541 // Is one range a superset of the other?
1542 // If this is and-of-compares, take the smaller set:
1543 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1544 // If this is or-of-compares, take the larger set:
1545 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1546 if (Range0.contains(Range1))
1547 return IsAnd ? Cmp1 : Cmp0;
1548 if (Range1.contains(Range0))
1549 return IsAnd ? Cmp0 : Cmp1;
1550
1551 return nullptr;
1552}
1553
Craig Topper348314d2017-05-26 22:42:34 +00001554static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel599e65b2017-05-07 15:11:40 +00001555 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001556 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001557 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001558 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001559 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001560 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001561
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001562 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001563 return nullptr;
1564
David Majnemera315bd82014-09-15 08:15:28 +00001565 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001566 if (AddInst->getOperand(1) != Op1->getOperand(1))
1567 return nullptr;
1568
Craig Topper9bce1ad2017-05-26 19:04:02 +00001569 Type *ITy = Op0->getType();
David Majnemera315bd82014-09-15 08:15:28 +00001570 bool isNSW = AddInst->hasNoSignedWrap();
1571 bool isNUW = AddInst->hasNoUnsignedWrap();
1572
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001573 const APInt Delta = *C1 - *C0;
1574 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001575 if (Delta == 2) {
1576 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1577 return getFalse(ITy);
1578 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1579 return getFalse(ITy);
1580 }
1581 if (Delta == 1) {
1582 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1583 return getFalse(ITy);
1584 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1585 return getFalse(ITy);
1586 }
1587 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001588 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001589 if (Delta == 2)
1590 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1591 return getFalse(ITy);
1592 if (Delta == 1)
1593 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1594 return getFalse(ITy);
1595 }
1596
1597 return nullptr;
1598}
1599
Craig Topper348314d2017-05-26 22:42:34 +00001600static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1601 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1602 return X;
1603 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
Sanjay Patel142cb832017-05-04 18:19:17 +00001604 return X;
1605
Craig Topper348314d2017-05-26 22:42:34 +00001606 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1607 return X;
1608 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
Sanjay Patel142cb832017-05-04 18:19:17 +00001609 return X;
1610
Craig Topper348314d2017-05-26 22:42:34 +00001611 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
Sanjay Patel599e65b2017-05-07 15:11:40 +00001612 return X;
1613
Craig Topper348314d2017-05-26 22:42:34 +00001614 if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1))
1615 return X;
1616 if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0))
1617 return X;
1618
1619 return nullptr;
1620}
1621
1622static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001623 // (icmp (add V, C0), C1) | (icmp V, C0)
1624 ICmpInst::Predicate Pred0, Pred1;
1625 const APInt *C0, *C1;
1626 Value *V;
1627 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1628 return nullptr;
1629
1630 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1631 return nullptr;
1632
1633 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1634 if (AddInst->getOperand(1) != Op1->getOperand(1))
1635 return nullptr;
1636
1637 Type *ITy = Op0->getType();
1638 bool isNSW = AddInst->hasNoSignedWrap();
1639 bool isNUW = AddInst->hasNoUnsignedWrap();
1640
1641 const APInt Delta = *C1 - *C0;
1642 if (C0->isStrictlyPositive()) {
1643 if (Delta == 2) {
1644 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1645 return getTrue(ITy);
1646 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1647 return getTrue(ITy);
1648 }
1649 if (Delta == 1) {
1650 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1651 return getTrue(ITy);
1652 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1653 return getTrue(ITy);
1654 }
1655 }
1656 if (C0->getBoolValue() && isNUW) {
1657 if (Delta == 2)
1658 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1659 return getTrue(ITy);
1660 if (Delta == 1)
1661 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1662 return getTrue(ITy);
1663 }
1664
1665 return nullptr;
1666}
1667
Craig Topper348314d2017-05-26 22:42:34 +00001668static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1669 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1670 return X;
1671 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1672 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001673
Craig Topper348314d2017-05-26 22:42:34 +00001674 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1675 return X;
1676 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1677 return X;
1678
1679 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1680 return X;
1681
1682 if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1))
1683 return X;
1684 if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0))
1685 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001686
1687 return nullptr;
1688}
1689
1690static Value *simplifyAndOrOfICmps(Value *Op0, Value *Op1, bool IsAnd) {
1691 // Look through casts of the 'and' operands to find compares.
1692 auto *Cast0 = dyn_cast<CastInst>(Op0);
1693 auto *Cast1 = dyn_cast<CastInst>(Op1);
1694 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1695 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1696 Op0 = Cast0->getOperand(0);
1697 Op1 = Cast1->getOperand(0);
1698 }
1699
1700 auto *Cmp0 = dyn_cast<ICmpInst>(Op0);
1701 auto *Cmp1 = dyn_cast<ICmpInst>(Op1);
1702 if (!Cmp0 || !Cmp1)
1703 return nullptr;
1704
Craig Topper348314d2017-05-26 22:42:34 +00001705 Value *V =
1706 IsAnd ? simplifyAndOfICmps(Cmp0, Cmp1) : simplifyOrOfICmps(Cmp0, Cmp1);
1707 if (!V)
1708 return nullptr;
1709 if (!Cast0)
Sanjay Patele42b4d52017-05-04 19:51:34 +00001710 return V;
Craig Topper348314d2017-05-26 22:42:34 +00001711
1712 // If we looked through casts, we can only handle a constant simplification
1713 // because we are not allowed to create a cast instruction here.
1714 if (auto *C = dyn_cast<Constant>(V))
1715 return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
Sanjay Patele42b4d52017-05-04 19:51:34 +00001716
1717 return nullptr;
1718}
1719
Sanjay Patel472cc782016-01-11 22:14:42 +00001720/// Given operands for an And, see if we can fold the result.
1721/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001722static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001723 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001724 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1725 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001726
Chris Lattnera71e9d62009-11-10 00:55:12 +00001727 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001728 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001729 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001730
Chris Lattnera71e9d62009-11-10 00:55:12 +00001731 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001732 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001733 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001734
Duncan Sandsc89ac072010-11-17 18:52:15 +00001735 // X & 0 = 0
1736 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001737 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001738
Duncan Sandsc89ac072010-11-17 18:52:15 +00001739 // X & -1 = X
1740 if (match(Op1, m_AllOnes()))
1741 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001742
Chris Lattnera71e9d62009-11-10 00:55:12 +00001743 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001744 if (match(Op0, m_Not(m_Specific(Op1))) ||
1745 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001746 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001747
Chris Lattnera71e9d62009-11-10 00:55:12 +00001748 // (A | ?) & A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001749 if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001750 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001751
Chris Lattnera71e9d62009-11-10 00:55:12 +00001752 // A & (A | ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001753 if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001754 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001755
Sanjay Patel877364f2017-05-16 21:51:04 +00001756 // A mask that only clears known zeros of a shifted value is a no-op.
1757 Value *X;
1758 const APInt *Mask;
1759 const APInt *ShAmt;
1760 if (match(Op1, m_APInt(Mask))) {
1761 // If all bits in the inverted and shifted mask are clear:
1762 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1763 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1764 (~(*Mask)).lshr(*ShAmt).isNullValue())
1765 return Op0;
1766
1767 // If all bits in the inverted and shifted mask are clear:
1768 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1769 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1770 (~(*Mask)).shl(*ShAmt).isNullValue())
1771 return Op0;
1772 }
1773
Duncan Sandsba286d72011-10-26 20:55:21 +00001774 // A & (-A) = A if A is a power of two or zero.
1775 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1776 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001777 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1778 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001779 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001780 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1781 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001782 return Op1;
1783 }
1784
Sanjay Patele42b4d52017-05-04 19:51:34 +00001785 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, true))
1786 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001787
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001788 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001789 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1790 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001791 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001792
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001793 // And distributes over Or. Try some generic simplifications based on this.
1794 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001795 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001796 return V;
1797
1798 // And distributes over Xor. Try some generic simplifications based on this.
1799 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001800 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001801 return V;
1802
Duncan Sandsb0579e92010-11-10 13:00:08 +00001803 // If the operation is with the result of a select instruction, check whether
1804 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001805 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001806 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1807 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001808 return V;
1809
1810 // If the operation is with the result of a phi instruction, check whether
1811 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001812 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001813 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001814 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001815 return V;
1816
Craig Topper9f008862014-04-15 04:59:12 +00001817 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001818}
1819
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001820Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1821 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1822}
1823
Sanjay Patel472cc782016-01-11 22:14:42 +00001824/// Given operands for an Or, see if we can fold the result.
1825/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001826static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001827 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001828 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1829 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001830
Chris Lattnera71e9d62009-11-10 00:55:12 +00001831 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001832 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001833 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001834
Chris Lattnera71e9d62009-11-10 00:55:12 +00001835 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001836 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001837 return Op0;
1838
Duncan Sandsc89ac072010-11-17 18:52:15 +00001839 // X | 0 = X
1840 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001841 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001842
Duncan Sandsc89ac072010-11-17 18:52:15 +00001843 // X | -1 = -1
1844 if (match(Op1, m_AllOnes()))
1845 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001846
Chris Lattnera71e9d62009-11-10 00:55:12 +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))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001850 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001851
Chris Lattnera71e9d62009-11-10 00:55:12 +00001852 // (A & ?) | A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001853 if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001854 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001855
Chris Lattnera71e9d62009-11-10 00:55:12 +00001856 // A | (A & ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001857 if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001858 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001859
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001860 // ~(A & ?) | A = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001861 if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001862 return Constant::getAllOnesValue(Op1->getType());
1863
1864 // A | ~(A & ?) = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001865 if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001866 return Constant::getAllOnesValue(Op0->getType());
1867
Craig Topperdad7d8d2017-07-16 06:57:41 +00001868 Value *A, *B;
Sanjay Patel08892252017-04-24 18:24:36 +00001869 // (A & ~B) | (A ^ B) -> (A ^ B)
1870 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001871 // (A & ~B) | (B ^ A) -> (B ^ A)
1872 // (~B & A) | (B ^ A) -> (B ^ A)
1873 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1874 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1875 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001876 return Op1;
1877
1878 // Commute the 'or' operands.
1879 // (A ^ B) | (A & ~B) -> (A ^ B)
1880 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001881 // (B ^ A) | (A & ~B) -> (B ^ A)
1882 // (B ^ A) | (~B & A) -> (B ^ A)
1883 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1884 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1885 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001886 return Op0;
1887
Craig Topper479daaf2017-05-14 07:54:43 +00001888 // (A & B) | (~A ^ B) -> (~A ^ B)
1889 // (B & A) | (~A ^ B) -> (~A ^ B)
1890 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1891 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1892 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1893 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1894 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1895 return Op1;
1896
1897 // (~A ^ B) | (A & B) -> (~A ^ B)
1898 // (~A ^ B) | (B & A) -> (~A ^ B)
1899 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1900 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1901 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1902 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1903 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1904 return Op0;
1905
Sanjay Patele42b4d52017-05-04 19:51:34 +00001906 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, false))
1907 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001908
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001909 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001910 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1911 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001912 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001913
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001914 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001915 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1916 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001917 return V;
1918
Duncan Sandsb0579e92010-11-10 13:00:08 +00001919 // If the operation is with the result of a select instruction, check whether
1920 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001921 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001922 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001923 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001924 return V;
1925
Craig Topper50500d52017-05-26 05:16:20 +00001926 // (A & C1)|(B & C2)
Craig Topper1da22c32017-05-26 19:03:53 +00001927 const APInt *C1, *C2;
1928 if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
1929 match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
1930 if (*C1 == ~*C2) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001931 // (A & C1)|(B & C2)
1932 // If we have: ((V + N) & C1) | (V & C2)
1933 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1934 // replace with V+N.
Craig Topperc8bebb12017-05-26 19:03:59 +00001935 Value *N;
Craig Topper1da22c32017-05-26 19:03:53 +00001936 if (C2->isMask() && // C2 == 0+1+
Craig Topperc8bebb12017-05-26 19:03:59 +00001937 match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001938 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00001939 if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001940 return A;
1941 }
1942 // Or commutes, try both ways.
Craig Topper1da22c32017-05-26 19:03:53 +00001943 if (C1->isMask() &&
Craig Topperc8bebb12017-05-26 19:03:59 +00001944 match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001945 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00001946 if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001947 return B;
1948 }
1949 }
1950 }
1951
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001952 // If the operation is with the result of a phi instruction, check whether
1953 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001954 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001955 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001956 return V;
1957
Craig Topper9f008862014-04-15 04:59:12 +00001958 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001959}
1960
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001961Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1962 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1963}
1964
Sanjay Patel472cc782016-01-11 22:14:42 +00001965/// Given operands for a Xor, see if we can fold the result.
1966/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001967static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001968 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001969 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1970 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001971
1972 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001973 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001974 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001975
1976 // A ^ 0 = A
1977 if (match(Op1, m_Zero()))
1978 return Op0;
1979
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001980 // A ^ A = 0
1981 if (Op0 == Op1)
1982 return Constant::getNullValue(Op0->getType());
1983
Duncan Sandsc89ac072010-11-17 18:52:15 +00001984 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001985 if (match(Op0, m_Not(m_Specific(Op1))) ||
1986 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00001987 return Constant::getAllOnesValue(Op0->getType());
1988
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001989 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001990 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1991 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001992 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001993
Duncan Sandsb238de02010-11-19 09:20:39 +00001994 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1995 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1996 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1997 // only if B and C are equal. If B and C are equal then (since we assume
1998 // that operands have already been simplified) "select(cond, B, C)" should
1999 // have been simplified to the common value of B and C already. Analysing
2000 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
2001 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00002002
Craig Topper9f008862014-04-15 04:59:12 +00002003 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002004}
2005
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002006Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2007 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2008}
2009
2010
Chris Lattner229907c2011-07-18 04:54:35 +00002011static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002012 return CmpInst::makeCmpResultType(Op->getType());
2013}
2014
Sanjay Patel472cc782016-01-11 22:14:42 +00002015/// Rummage around inside V looking for something equivalent to the comparison
2016/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2017/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002018static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2019 Value *LHS, Value *RHS) {
2020 SelectInst *SI = dyn_cast<SelectInst>(V);
2021 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002022 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002023 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2024 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002025 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002026 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2027 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2028 return Cmp;
2029 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2030 LHS == CmpRHS && RHS == CmpLHS)
2031 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002032 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002033}
2034
Dan Gohman9631d902013-02-01 00:49:06 +00002035// A significant optimization not implemented here is assuming that alloca
2036// addresses are not equal to incoming argument values. They don't *alias*,
2037// as we say, but that doesn't mean they aren't equal, so we take a
2038// conservative approach.
2039//
2040// This is inspired in part by C++11 5.10p1:
2041// "Two pointers of the same type compare equal if and only if they are both
2042// null, both point to the same function, or both represent the same
2043// address."
2044//
2045// This is pretty permissive.
2046//
2047// It's also partly due to C11 6.5.9p6:
2048// "Two pointers compare equal if and only if both are null pointers, both are
2049// pointers to the same object (including a pointer to an object and a
2050// subobject at its beginning) or function, both are pointers to one past the
2051// last element of the same array object, or one is a pointer to one past the
2052// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002053// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002054// object in the address space.)
2055//
2056// C11's version is more restrictive, however there's no reason why an argument
2057// couldn't be a one-past-the-end value for a stack object in the caller and be
2058// equal to the beginning of a stack object in the callee.
2059//
2060// If the C and C++ standards are ever made sufficiently restrictive in this
2061// area, it may be possible to update LLVM's semantics accordingly and reinstate
2062// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002063static Constant *
2064computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2065 const DominatorTree *DT, CmpInst::Predicate Pred,
Nuno Lopes404f1062017-09-09 18:23:11 +00002066 AssumptionCache *AC, const Instruction *CxtI,
2067 Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002068 // First, skip past any trivial no-ops.
2069 LHS = LHS->stripPointerCasts();
2070 RHS = RHS->stripPointerCasts();
2071
2072 // A non-null pointer is not equal to a null pointer.
Nuno Lopes404f1062017-09-09 18:23:11 +00002073 if (llvm::isKnownNonZero(LHS, DL) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002074 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2075 return ConstantInt::get(GetCompareTy(LHS),
2076 !CmpInst::isTrueWhenEqual(Pred));
2077
Chandler Carruth8059c842012-03-25 21:28:14 +00002078 // We can only fold certain predicates on pointer comparisons.
2079 switch (Pred) {
2080 default:
Craig Topper9f008862014-04-15 04:59:12 +00002081 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002082
2083 // Equality comaprisons are easy to fold.
2084 case CmpInst::ICMP_EQ:
2085 case CmpInst::ICMP_NE:
2086 break;
2087
2088 // We can only handle unsigned relational comparisons because 'inbounds' on
2089 // a GEP only protects against unsigned wrapping.
2090 case CmpInst::ICMP_UGT:
2091 case CmpInst::ICMP_UGE:
2092 case CmpInst::ICMP_ULT:
2093 case CmpInst::ICMP_ULE:
2094 // However, we have to switch them to their signed variants to handle
2095 // negative indices from the base pointer.
2096 Pred = ICmpInst::getSignedPredicate(Pred);
2097 break;
2098 }
2099
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002100 // Strip off any constant offsets so that we can reason about them.
2101 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2102 // here and compare base addresses like AliasAnalysis does, however there are
2103 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2104 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2105 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002106 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2107 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002108
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002109 // If LHS and RHS are related via constant offsets to the same base
2110 // value, we can replace it with an icmp which just compares the offsets.
2111 if (LHS == RHS)
2112 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002113
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002114 // Various optimizations for (in)equality comparisons.
2115 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2116 // Different non-empty allocations that exist at the same time have
2117 // different addresses (if the program can tell). Global variables always
2118 // exist, so they always exist during the lifetime of each other and all
2119 // allocas. Two different allocas usually have different addresses...
2120 //
2121 // However, if there's an @llvm.stackrestore dynamically in between two
2122 // allocas, they may have the same address. It's tempting to reduce the
2123 // scope of the problem by only looking at *static* allocas here. That would
2124 // cover the majority of allocas while significantly reducing the likelihood
2125 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2126 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2127 // an entry block. Also, if we have a block that's not attached to a
2128 // function, we can't tell if it's "static" under the current definition.
2129 // Theoretically, this problem could be fixed by creating a new kind of
2130 // instruction kind specifically for static allocas. Such a new instruction
2131 // could be required to be at the top of the entry block, thus preventing it
2132 // from being subject to a @llvm.stackrestore. Instcombine could even
2133 // convert regular allocas into these special allocas. It'd be nifty.
2134 // However, until then, this problem remains open.
2135 //
2136 // So, we'll assume that two non-empty allocas have different addresses
2137 // for now.
2138 //
2139 // With all that, if the offsets are within the bounds of their allocations
2140 // (and not one-past-the-end! so we can't use inbounds!), and their
2141 // allocations aren't the same, the pointers are not equal.
2142 //
2143 // Note that it's not necessary to check for LHS being a global variable
2144 // address, due to canonicalization and constant folding.
2145 if (isa<AllocaInst>(LHS) &&
2146 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002147 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2148 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002149 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002150 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002151 getObjectSize(LHS, LHSSize, DL, TLI) &&
2152 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002153 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2154 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002155 if (!LHSOffsetValue.isNegative() &&
2156 !RHSOffsetValue.isNegative() &&
2157 LHSOffsetValue.ult(LHSSize) &&
2158 RHSOffsetValue.ult(RHSSize)) {
2159 return ConstantInt::get(GetCompareTy(LHS),
2160 !CmpInst::isTrueWhenEqual(Pred));
2161 }
2162 }
2163
2164 // Repeat the above check but this time without depending on DataLayout
2165 // or being able to compute a precise size.
2166 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2167 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2168 LHSOffset->isNullValue() &&
2169 RHSOffset->isNullValue())
2170 return ConstantInt::get(GetCompareTy(LHS),
2171 !CmpInst::isTrueWhenEqual(Pred));
2172 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002173
2174 // Even if an non-inbounds GEP occurs along the path we can still optimize
2175 // equality comparisons concerning the result. We avoid walking the whole
2176 // chain again by starting where the last calls to
2177 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002178 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2179 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002180 if (LHS == RHS)
2181 return ConstantExpr::getICmp(Pred,
2182 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2183 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002184
2185 // If one side of the equality comparison must come from a noalias call
2186 // (meaning a system memory allocation function), and the other side must
2187 // come from a pointer that cannot overlap with dynamically-allocated
2188 // memory within the lifetime of the current function (allocas, byval
2189 // arguments, globals), then determine the comparison result here.
2190 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2191 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2192 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2193
2194 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002195 auto IsNAC = [](ArrayRef<Value *> Objects) {
2196 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002197 };
2198
2199 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002200 // noalias calls. For allocas, we consider only static ones (dynamic
2201 // allocas might be transformed into calls to malloc not simultaneously
2202 // live with the compared-to allocation). For globals, we exclude symbols
2203 // that might be resolve lazily to symbols in another dynamically-loaded
2204 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002205 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2206 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002207 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2208 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2209 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2210 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002211 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002212 !GV->isThreadLocal();
2213 if (const Argument *A = dyn_cast<Argument>(V))
2214 return A->hasByValAttr();
2215 return false;
2216 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002217 };
2218
2219 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2220 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2221 return ConstantInt::get(GetCompareTy(LHS),
2222 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002223
2224 // Fold comparisons for non-escaping pointer even if the allocation call
2225 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2226 // dynamic allocation call could be either of the operands.
2227 Value *MI = nullptr;
Nuno Lopes404f1062017-09-09 18:23:11 +00002228 if (isAllocLikeFn(LHS, TLI) &&
2229 llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002230 MI = LHS;
Nuno Lopes404f1062017-09-09 18:23:11 +00002231 else if (isAllocLikeFn(RHS, TLI) &&
2232 llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002233 MI = RHS;
2234 // FIXME: We should also fold the compare when the pointer escapes, but the
2235 // compare dominates the pointer escape
2236 if (MI && !PointerMayBeCaptured(MI, true, true))
2237 return ConstantInt::get(GetCompareTy(LHS),
2238 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002239 }
2240
2241 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002242 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002243}
Chris Lattner01990f02012-02-24 19:01:58 +00002244
Sanjay Pateldc65a272016-12-03 17:30:22 +00002245/// Fold an icmp when its operands have i1 scalar type.
2246static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002247 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002248 Type *ITy = GetCompareTy(LHS); // The return type.
2249 Type *OpTy = LHS->getType(); // The operand type.
Craig Topperfde47232017-07-09 07:04:03 +00002250 if (!OpTy->isIntOrIntVectorTy(1))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002251 return nullptr;
2252
Sanjay Patele2787b92017-05-17 20:27:55 +00002253 // A boolean compared to true/false can be simplified in 14 out of the 20
2254 // (10 predicates * 2 constants) possible combinations. Cases not handled here
2255 // require a 'not' of the LHS, so those must be transformed in InstCombine.
2256 if (match(RHS, m_Zero())) {
2257 switch (Pred) {
2258 case CmpInst::ICMP_NE: // X != 0 -> X
2259 case CmpInst::ICMP_UGT: // X >u 0 -> X
2260 case CmpInst::ICMP_SLT: // X <s 0 -> X
2261 return LHS;
2262
2263 case CmpInst::ICMP_ULT: // X <u 0 -> false
2264 case CmpInst::ICMP_SGT: // X >s 0 -> false
2265 return getFalse(ITy);
2266
2267 case CmpInst::ICMP_UGE: // X >=u 0 -> true
2268 case CmpInst::ICMP_SLE: // X <=s 0 -> true
2269 return getTrue(ITy);
2270
2271 default: break;
2272 }
2273 } else if (match(RHS, m_One())) {
2274 switch (Pred) {
2275 case CmpInst::ICMP_EQ: // X == 1 -> X
2276 case CmpInst::ICMP_UGE: // X >=u 1 -> X
2277 case CmpInst::ICMP_SLE: // X <=s -1 -> X
2278 return LHS;
2279
2280 case CmpInst::ICMP_UGT: // X >u 1 -> false
2281 case CmpInst::ICMP_SLT: // X <s -1 -> false
2282 return getFalse(ITy);
2283
2284 case CmpInst::ICMP_ULE: // X <=u 1 -> true
2285 case CmpInst::ICMP_SGE: // X >=s -1 -> true
2286 return getTrue(ITy);
2287
2288 default: break;
2289 }
2290 }
2291
Sanjay Pateldc65a272016-12-03 17:30:22 +00002292 switch (Pred) {
2293 default:
2294 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002295 case ICmpInst::ICMP_UGE:
Sanjay Pateldc65a272016-12-03 17:30:22 +00002296 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2297 return getTrue(ITy);
2298 break;
2299 case ICmpInst::ICMP_SGE:
2300 /// For signed comparison, the values for an i1 are 0 and -1
2301 /// respectively. This maps into a truth table of:
2302 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2303 /// 0 | 0 | 1 (0 >= 0) | 1
2304 /// 0 | 1 | 1 (0 >= -1) | 1
2305 /// 1 | 0 | 0 (-1 >= 0) | 0
2306 /// 1 | 1 | 1 (-1 >= -1) | 1
2307 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2308 return getTrue(ITy);
2309 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002310 case ICmpInst::ICMP_ULE:
2311 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2312 return getTrue(ITy);
2313 break;
2314 }
2315
2316 return nullptr;
2317}
2318
2319/// Try hard to fold icmp with zero RHS because this is a common case.
2320static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002321 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002322 if (!match(RHS, m_Zero()))
2323 return nullptr;
2324
2325 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002326 switch (Pred) {
2327 default:
2328 llvm_unreachable("Unknown ICmp predicate!");
2329 case ICmpInst::ICMP_ULT:
2330 return getFalse(ITy);
2331 case ICmpInst::ICMP_UGE:
2332 return getTrue(ITy);
2333 case ICmpInst::ICMP_EQ:
2334 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002335 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002336 return getFalse(ITy);
2337 break;
2338 case ICmpInst::ICMP_NE:
2339 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002340 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002341 return getTrue(ITy);
2342 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002343 case ICmpInst::ICMP_SLT: {
2344 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2345 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002346 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002347 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002348 return getFalse(ITy);
2349 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002350 }
2351 case ICmpInst::ICMP_SLE: {
2352 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2353 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002354 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002355 if (LHSKnown.isNonNegative() &&
2356 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002357 return getFalse(ITy);
2358 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002359 }
2360 case ICmpInst::ICMP_SGE: {
2361 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2362 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002363 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002364 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002365 return getTrue(ITy);
2366 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002367 }
2368 case ICmpInst::ICMP_SGT: {
2369 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2370 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002371 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002372 if (LHSKnown.isNonNegative() &&
2373 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002374 return getTrue(ITy);
2375 break;
2376 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002377 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002378
2379 return nullptr;
2380}
2381
Sanjay Patelbe332132017-01-23 18:22:26 +00002382/// Many binary operators with a constant operand have an easy-to-compute
2383/// range of outputs. This can be used to fold a comparison to always true or
2384/// always false.
2385static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2386 unsigned Width = Lower.getBitWidth();
2387 const APInt *C;
2388 switch (BO.getOpcode()) {
2389 case Instruction::Add:
Craig Topper73ba1c82017-06-07 07:40:37 +00002390 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patel56227252017-01-24 17:03:24 +00002391 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2392 if (BO.hasNoUnsignedWrap()) {
2393 // 'add nuw x, C' produces [C, UINT_MAX].
2394 Lower = *C;
2395 } else if (BO.hasNoSignedWrap()) {
2396 if (C->isNegative()) {
2397 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2398 Lower = APInt::getSignedMinValue(Width);
2399 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2400 } else {
2401 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2402 Lower = APInt::getSignedMinValue(Width) + *C;
2403 Upper = APInt::getSignedMaxValue(Width) + 1;
2404 }
2405 }
2406 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002407 break;
2408
2409 case Instruction::And:
2410 if (match(BO.getOperand(1), m_APInt(C)))
2411 // 'and x, C' produces [0, C].
2412 Upper = *C + 1;
2413 break;
2414
2415 case Instruction::Or:
2416 if (match(BO.getOperand(1), m_APInt(C)))
2417 // 'or x, C' produces [C, UINT_MAX].
2418 Lower = *C;
2419 break;
2420
2421 case Instruction::AShr:
2422 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2423 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2424 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2425 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2426 } else if (match(BO.getOperand(0), m_APInt(C))) {
2427 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002428 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002429 ShiftAmount = C->countTrailingZeros();
2430 if (C->isNegative()) {
2431 // 'ashr C, x' produces [C, C >> (Width-1)]
2432 Lower = *C;
2433 Upper = C->ashr(ShiftAmount) + 1;
2434 } else {
2435 // 'ashr C, x' produces [C >> (Width-1), C]
2436 Lower = C->ashr(ShiftAmount);
2437 Upper = *C + 1;
2438 }
2439 }
2440 break;
2441
2442 case Instruction::LShr:
2443 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2444 // 'lshr x, C' produces [0, UINT_MAX >> C].
2445 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2446 } else if (match(BO.getOperand(0), m_APInt(C))) {
2447 // 'lshr C, x' produces [C >> (Width-1), C].
2448 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002449 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002450 ShiftAmount = C->countTrailingZeros();
2451 Lower = C->lshr(ShiftAmount);
2452 Upper = *C + 1;
2453 }
2454 break;
2455
2456 case Instruction::Shl:
2457 if (match(BO.getOperand(0), m_APInt(C))) {
2458 if (BO.hasNoUnsignedWrap()) {
2459 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2460 Lower = *C;
2461 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2462 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2463 if (C->isNegative()) {
2464 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2465 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2466 Lower = C->shl(ShiftAmount);
2467 Upper = *C + 1;
2468 } else {
2469 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2470 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2471 Lower = *C;
2472 Upper = C->shl(ShiftAmount) + 1;
2473 }
2474 }
2475 }
2476 break;
2477
2478 case Instruction::SDiv:
2479 if (match(BO.getOperand(1), m_APInt(C))) {
2480 APInt IntMin = APInt::getSignedMinValue(Width);
2481 APInt IntMax = APInt::getSignedMaxValue(Width);
2482 if (C->isAllOnesValue()) {
2483 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2484 // where C != -1 and C != 0 and C != 1
2485 Lower = IntMin + 1;
2486 Upper = IntMax + 1;
2487 } else if (C->countLeadingZeros() < Width - 1) {
2488 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2489 // where C != -1 and C != 0 and C != 1
2490 Lower = IntMin.sdiv(*C);
2491 Upper = IntMax.sdiv(*C);
2492 if (Lower.sgt(Upper))
2493 std::swap(Lower, Upper);
2494 Upper = Upper + 1;
2495 assert(Upper != Lower && "Upper part of range has wrapped!");
2496 }
2497 } else if (match(BO.getOperand(0), m_APInt(C))) {
2498 if (C->isMinSignedValue()) {
2499 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2500 Lower = *C;
2501 Upper = Lower.lshr(1) + 1;
2502 } else {
2503 // 'sdiv C, x' produces [-|C|, |C|].
2504 Upper = C->abs() + 1;
2505 Lower = (-Upper) + 1;
2506 }
2507 }
2508 break;
2509
2510 case Instruction::UDiv:
Craig Topper73ba1c82017-06-07 07:40:37 +00002511 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002512 // 'udiv x, C' produces [0, UINT_MAX / C].
2513 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2514 } else if (match(BO.getOperand(0), m_APInt(C))) {
2515 // 'udiv C, x' produces [0, C].
2516 Upper = *C + 1;
2517 }
2518 break;
2519
2520 case Instruction::SRem:
2521 if (match(BO.getOperand(1), m_APInt(C))) {
2522 // 'srem x, C' produces (-|C|, |C|).
2523 Upper = C->abs();
2524 Lower = (-Upper) + 1;
2525 }
2526 break;
2527
2528 case Instruction::URem:
2529 if (match(BO.getOperand(1), m_APInt(C)))
2530 // 'urem x, C' produces [0, C).
2531 Upper = *C;
2532 break;
2533
2534 default:
2535 break;
2536 }
2537}
2538
Sanjay Patel67bde282016-08-22 23:12:02 +00002539static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2540 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002541 const APInt *C;
2542 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002543 return nullptr;
2544
2545 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002546 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002547 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002548 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002549 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002550 return ConstantInt::getTrue(GetCompareTy(RHS));
2551
Sanjay Patelbe332132017-01-23 18:22:26 +00002552 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002553 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002554 APInt Lower = APInt(Width, 0);
2555 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002556 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2557 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002558
2559 ConstantRange LHS_CR =
2560 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2561
2562 if (auto *I = dyn_cast<Instruction>(LHS))
2563 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2564 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2565
2566 if (!LHS_CR.isFullSet()) {
2567 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002568 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002569 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002570 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002571 }
2572
2573 return nullptr;
2574}
2575
Sanjay Patel2df38a82017-05-08 16:21:55 +00002576/// TODO: A large part of this logic is duplicated in InstCombine's
2577/// foldICmpBinOp(). We should be able to share that and avoid the code
2578/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002579static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002580 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002581 unsigned MaxRecurse) {
2582 Type *ITy = GetCompareTy(LHS); // The return type.
2583
2584 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2585 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2586 if (MaxRecurse && (LBO || RBO)) {
2587 // Analyze the case when either LHS or RHS is an add instruction.
2588 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2589 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2590 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2591 if (LBO && LBO->getOpcode() == Instruction::Add) {
2592 A = LBO->getOperand(0);
2593 B = LBO->getOperand(1);
2594 NoLHSWrapProblem =
2595 ICmpInst::isEquality(Pred) ||
2596 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2597 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2598 }
2599 if (RBO && RBO->getOpcode() == Instruction::Add) {
2600 C = RBO->getOperand(0);
2601 D = RBO->getOperand(1);
2602 NoRHSWrapProblem =
2603 ICmpInst::isEquality(Pred) ||
2604 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2605 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2606 }
2607
2608 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2609 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2610 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2611 Constant::getNullValue(RHS->getType()), Q,
2612 MaxRecurse - 1))
2613 return V;
2614
2615 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2616 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2617 if (Value *V =
2618 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2619 C == LHS ? D : C, Q, MaxRecurse - 1))
2620 return V;
2621
2622 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2623 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2624 NoRHSWrapProblem) {
2625 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2626 Value *Y, *Z;
2627 if (A == C) {
2628 // C + B == C + D -> B == D
2629 Y = B;
2630 Z = D;
2631 } else if (A == D) {
2632 // D + B == C + D -> B == C
2633 Y = B;
2634 Z = C;
2635 } else if (B == C) {
2636 // A + C == C + D -> A == D
2637 Y = A;
2638 Z = D;
2639 } else {
2640 assert(B == D);
2641 // A + D == C + D -> A == C
2642 Y = A;
2643 Z = C;
2644 }
2645 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2646 return V;
2647 }
2648 }
2649
2650 {
2651 Value *Y = nullptr;
2652 // icmp pred (or X, Y), X
2653 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2654 if (Pred == ICmpInst::ICMP_ULT)
2655 return getFalse(ITy);
2656 if (Pred == ICmpInst::ICMP_UGE)
2657 return getTrue(ITy);
2658
2659 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002660 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2661 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2662 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002663 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002664 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002665 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2666 }
2667 }
2668 // icmp pred X, (or X, Y)
2669 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2670 if (Pred == ICmpInst::ICMP_ULE)
2671 return getTrue(ITy);
2672 if (Pred == ICmpInst::ICMP_UGT)
2673 return getFalse(ITy);
2674
2675 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002676 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2677 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2678 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002679 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002680 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002681 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2682 }
2683 }
2684 }
2685
2686 // icmp pred (and X, Y), X
Craig Topper72ee6942017-06-24 06:24:01 +00002687 if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002688 if (Pred == ICmpInst::ICMP_UGT)
2689 return getFalse(ITy);
2690 if (Pred == ICmpInst::ICMP_ULE)
2691 return getTrue(ITy);
2692 }
2693 // icmp pred X, (and X, Y)
Craig Topper72ee6942017-06-24 06:24:01 +00002694 if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002695 if (Pred == ICmpInst::ICMP_UGE)
2696 return getTrue(ITy);
2697 if (Pred == ICmpInst::ICMP_ULT)
2698 return getFalse(ITy);
2699 }
2700
2701 // 0 - (zext X) pred C
2702 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2703 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2704 if (RHSC->getValue().isStrictlyPositive()) {
2705 if (Pred == ICmpInst::ICMP_SLT)
2706 return ConstantInt::getTrue(RHSC->getContext());
2707 if (Pred == ICmpInst::ICMP_SGE)
2708 return ConstantInt::getFalse(RHSC->getContext());
2709 if (Pred == ICmpInst::ICMP_EQ)
2710 return ConstantInt::getFalse(RHSC->getContext());
2711 if (Pred == ICmpInst::ICMP_NE)
2712 return ConstantInt::getTrue(RHSC->getContext());
2713 }
2714 if (RHSC->getValue().isNonNegative()) {
2715 if (Pred == ICmpInst::ICMP_SLE)
2716 return ConstantInt::getTrue(RHSC->getContext());
2717 if (Pred == ICmpInst::ICMP_SGT)
2718 return ConstantInt::getFalse(RHSC->getContext());
2719 }
2720 }
2721 }
2722
2723 // icmp pred (urem X, Y), Y
2724 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002725 switch (Pred) {
2726 default:
2727 break;
2728 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002729 case ICmpInst::ICMP_SGE: {
2730 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2731 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002732 break;
2733 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002734 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002735 case ICmpInst::ICMP_EQ:
2736 case ICmpInst::ICMP_UGT:
2737 case ICmpInst::ICMP_UGE:
2738 return getFalse(ITy);
2739 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002740 case ICmpInst::ICMP_SLE: {
2741 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2742 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002743 break;
2744 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002745 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002746 case ICmpInst::ICMP_NE:
2747 case ICmpInst::ICMP_ULT:
2748 case ICmpInst::ICMP_ULE:
2749 return getTrue(ITy);
2750 }
2751 }
2752
2753 // icmp pred X, (urem Y, X)
2754 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002755 switch (Pred) {
2756 default:
2757 break;
2758 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002759 case ICmpInst::ICMP_SGE: {
2760 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2761 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002762 break;
2763 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002764 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002765 case ICmpInst::ICMP_NE:
2766 case ICmpInst::ICMP_UGT:
2767 case ICmpInst::ICMP_UGE:
2768 return getTrue(ITy);
2769 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002770 case ICmpInst::ICMP_SLE: {
2771 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2772 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002773 break;
2774 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002775 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002776 case ICmpInst::ICMP_EQ:
2777 case ICmpInst::ICMP_ULT:
2778 case ICmpInst::ICMP_ULE:
2779 return getFalse(ITy);
2780 }
2781 }
2782
2783 // x >> y <=u x
2784 // x udiv y <=u x.
2785 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2786 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2787 // icmp pred (X op Y), X
2788 if (Pred == ICmpInst::ICMP_UGT)
2789 return getFalse(ITy);
2790 if (Pred == ICmpInst::ICMP_ULE)
2791 return getTrue(ITy);
2792 }
2793
2794 // x >=u x >> y
2795 // x >=u x udiv y.
2796 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2797 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2798 // icmp pred X, (X op Y)
2799 if (Pred == ICmpInst::ICMP_ULT)
2800 return getFalse(ITy);
2801 if (Pred == ICmpInst::ICMP_UGE)
2802 return getTrue(ITy);
2803 }
2804
2805 // handle:
2806 // CI2 << X == CI
2807 // CI2 << X != CI
2808 //
2809 // where CI2 is a power of 2 and CI isn't
2810 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2811 const APInt *CI2Val, *CIVal = &CI->getValue();
2812 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2813 CI2Val->isPowerOf2()) {
2814 if (!CIVal->isPowerOf2()) {
2815 // CI2 << X can equal zero in some circumstances,
2816 // this simplification is unsafe if CI is zero.
2817 //
2818 // We know it is safe if:
2819 // - The shift is nsw, we can't shift out the one bit.
2820 // - The shift is nuw, we can't shift out the one bit.
2821 // - CI2 is one
2822 // - CI isn't zero
2823 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
Craig Topper73ba1c82017-06-07 07:40:37 +00002824 CI2Val->isOneValue() || !CI->isZero()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002825 if (Pred == ICmpInst::ICMP_EQ)
2826 return ConstantInt::getFalse(RHS->getContext());
2827 if (Pred == ICmpInst::ICMP_NE)
2828 return ConstantInt::getTrue(RHS->getContext());
2829 }
2830 }
Craig Topper73ba1c82017-06-07 07:40:37 +00002831 if (CIVal->isSignMask() && CI2Val->isOneValue()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002832 if (Pred == ICmpInst::ICMP_UGT)
2833 return ConstantInt::getFalse(RHS->getContext());
2834 if (Pred == ICmpInst::ICMP_ULE)
2835 return ConstantInt::getTrue(RHS->getContext());
2836 }
2837 }
2838 }
2839
2840 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2841 LBO->getOperand(1) == RBO->getOperand(1)) {
2842 switch (LBO->getOpcode()) {
2843 default:
2844 break;
2845 case Instruction::UDiv:
2846 case Instruction::LShr:
Sanjay Patela23b1412017-05-15 19:16:49 +00002847 if (ICmpInst::isSigned(Pred) || !LBO->isExact() || !RBO->isExact())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002848 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00002849 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2850 RBO->getOperand(0), Q, MaxRecurse - 1))
2851 return V;
2852 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002853 case Instruction::SDiv:
Sanjay Patela23b1412017-05-15 19:16:49 +00002854 if (!ICmpInst::isEquality(Pred) || !LBO->isExact() || !RBO->isExact())
2855 break;
2856 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2857 RBO->getOperand(0), Q, MaxRecurse - 1))
2858 return V;
2859 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002860 case Instruction::AShr:
2861 if (!LBO->isExact() || !RBO->isExact())
2862 break;
2863 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2864 RBO->getOperand(0), Q, MaxRecurse - 1))
2865 return V;
2866 break;
2867 case Instruction::Shl: {
2868 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2869 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2870 if (!NUW && !NSW)
2871 break;
2872 if (!NSW && ICmpInst::isSigned(Pred))
2873 break;
2874 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2875 RBO->getOperand(0), Q, MaxRecurse - 1))
2876 return V;
2877 break;
2878 }
2879 }
2880 }
2881 return nullptr;
2882}
2883
Sanjay Patel35289c62016-12-10 17:40:47 +00002884/// Simplify integer comparisons where at least one operand of the compare
2885/// matches an integer min/max idiom.
2886static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002887 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00002888 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002889 Type *ITy = GetCompareTy(LHS); // The return type.
2890 Value *A, *B;
2891 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2892 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2893
2894 // Signed variants on "max(a,b)>=a -> true".
2895 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2896 if (A != RHS)
2897 std::swap(A, B); // smax(A, B) pred A.
2898 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2899 // We analyze this as smax(A, B) pred A.
2900 P = Pred;
2901 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2902 (A == LHS || B == LHS)) {
2903 if (A != LHS)
2904 std::swap(A, B); // A pred smax(A, B).
2905 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2906 // We analyze this as smax(A, B) swapped-pred A.
2907 P = CmpInst::getSwappedPredicate(Pred);
2908 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2909 (A == RHS || B == RHS)) {
2910 if (A != RHS)
2911 std::swap(A, B); // smin(A, B) pred A.
2912 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2913 // We analyze this as smax(-A, -B) swapped-pred -A.
2914 // Note that we do not need to actually form -A or -B thanks to EqP.
2915 P = CmpInst::getSwappedPredicate(Pred);
2916 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2917 (A == LHS || B == LHS)) {
2918 if (A != LHS)
2919 std::swap(A, B); // A pred smin(A, B).
2920 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2921 // We analyze this as smax(-A, -B) pred -A.
2922 // Note that we do not need to actually form -A or -B thanks to EqP.
2923 P = Pred;
2924 }
2925 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2926 // Cases correspond to "max(A, B) p A".
2927 switch (P) {
2928 default:
2929 break;
2930 case CmpInst::ICMP_EQ:
2931 case CmpInst::ICMP_SLE:
2932 // Equivalent to "A EqP B". This may be the same as the condition tested
2933 // in the max/min; if so, we can just return that.
2934 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2935 return V;
2936 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2937 return V;
2938 // Otherwise, see if "A EqP B" simplifies.
2939 if (MaxRecurse)
2940 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2941 return V;
2942 break;
2943 case CmpInst::ICMP_NE:
2944 case CmpInst::ICMP_SGT: {
2945 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2946 // Equivalent to "A InvEqP B". This may be the same as the condition
2947 // tested in the max/min; if so, we can just return that.
2948 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2949 return V;
2950 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2951 return V;
2952 // Otherwise, see if "A InvEqP B" simplifies.
2953 if (MaxRecurse)
2954 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2955 return V;
2956 break;
2957 }
2958 case CmpInst::ICMP_SGE:
2959 // Always true.
2960 return getTrue(ITy);
2961 case CmpInst::ICMP_SLT:
2962 // Always false.
2963 return getFalse(ITy);
2964 }
2965 }
2966
2967 // Unsigned variants on "max(a,b)>=a -> true".
2968 P = CmpInst::BAD_ICMP_PREDICATE;
2969 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2970 if (A != RHS)
2971 std::swap(A, B); // umax(A, B) pred A.
2972 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2973 // We analyze this as umax(A, B) pred A.
2974 P = Pred;
2975 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2976 (A == LHS || B == LHS)) {
2977 if (A != LHS)
2978 std::swap(A, B); // A pred umax(A, B).
2979 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2980 // We analyze this as umax(A, B) swapped-pred A.
2981 P = CmpInst::getSwappedPredicate(Pred);
2982 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2983 (A == RHS || B == RHS)) {
2984 if (A != RHS)
2985 std::swap(A, B); // umin(A, B) pred A.
2986 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2987 // We analyze this as umax(-A, -B) swapped-pred -A.
2988 // Note that we do not need to actually form -A or -B thanks to EqP.
2989 P = CmpInst::getSwappedPredicate(Pred);
2990 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2991 (A == LHS || B == LHS)) {
2992 if (A != LHS)
2993 std::swap(A, B); // A pred umin(A, B).
2994 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2995 // We analyze this as umax(-A, -B) pred -A.
2996 // Note that we do not need to actually form -A or -B thanks to EqP.
2997 P = Pred;
2998 }
2999 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3000 // Cases correspond to "max(A, B) p A".
3001 switch (P) {
3002 default:
3003 break;
3004 case CmpInst::ICMP_EQ:
3005 case CmpInst::ICMP_ULE:
3006 // Equivalent to "A EqP B". This may be the same as the condition tested
3007 // in the max/min; if so, we can just return that.
3008 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3009 return V;
3010 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3011 return V;
3012 // Otherwise, see if "A EqP B" simplifies.
3013 if (MaxRecurse)
3014 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3015 return V;
3016 break;
3017 case CmpInst::ICMP_NE:
3018 case CmpInst::ICMP_UGT: {
3019 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3020 // Equivalent to "A InvEqP B". This may be the same as the condition
3021 // tested in the max/min; if so, we can just return that.
3022 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3023 return V;
3024 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3025 return V;
3026 // Otherwise, see if "A InvEqP B" simplifies.
3027 if (MaxRecurse)
3028 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3029 return V;
3030 break;
3031 }
3032 case CmpInst::ICMP_UGE:
3033 // Always true.
3034 return getTrue(ITy);
3035 case CmpInst::ICMP_ULT:
3036 // Always false.
3037 return getFalse(ITy);
3038 }
3039 }
3040
3041 // Variants on "max(x,y) >= min(x,z)".
3042 Value *C, *D;
3043 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3044 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3045 (A == C || A == D || B == C || B == D)) {
3046 // max(x, ?) pred min(x, ?).
3047 if (Pred == CmpInst::ICMP_SGE)
3048 // Always true.
3049 return getTrue(ITy);
3050 if (Pred == CmpInst::ICMP_SLT)
3051 // Always false.
3052 return getFalse(ITy);
3053 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3054 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3055 (A == C || A == D || B == C || B == D)) {
3056 // min(x, ?) pred max(x, ?).
3057 if (Pred == CmpInst::ICMP_SLE)
3058 // Always true.
3059 return getTrue(ITy);
3060 if (Pred == CmpInst::ICMP_SGT)
3061 // Always false.
3062 return getFalse(ITy);
3063 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3064 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3065 (A == C || A == D || B == C || B == D)) {
3066 // max(x, ?) pred min(x, ?).
3067 if (Pred == CmpInst::ICMP_UGE)
3068 // Always true.
3069 return getTrue(ITy);
3070 if (Pred == CmpInst::ICMP_ULT)
3071 // Always false.
3072 return getFalse(ITy);
3073 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3074 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3075 (A == C || A == D || B == C || B == D)) {
3076 // min(x, ?) pred max(x, ?).
3077 if (Pred == CmpInst::ICMP_ULE)
3078 // Always true.
3079 return getTrue(ITy);
3080 if (Pred == CmpInst::ICMP_UGT)
3081 // Always false.
3082 return getFalse(ITy);
3083 }
3084
3085 return nullptr;
3086}
3087
Sanjay Patel472cc782016-01-11 22:14:42 +00003088/// Given operands for an ICmpInst, see if we can fold the result.
3089/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003090static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003091 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003092 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003093 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003094
Chris Lattnera71e9d62009-11-10 00:55:12 +00003095 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003096 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003097 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003098
3099 // If we have a constant, make sure it is on the RHS.
3100 std::swap(LHS, RHS);
3101 Pred = CmpInst::getSwappedPredicate(Pred);
3102 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003103
Chris Lattner229907c2011-07-18 04:54:35 +00003104 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003105
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003106 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00003107 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
3108 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00003109 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003110 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003111
Sanjay Pateldc65a272016-12-03 17:30:22 +00003112 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3113 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003114
Sanjay Pateldc65a272016-12-03 17:30:22 +00003115 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3116 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003117
Sanjay Patel67bde282016-08-22 23:12:02 +00003118 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3119 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003120
Chen Li7452d952015-09-26 03:26:47 +00003121 // If both operands have range metadata, use the metadata
3122 // to simplify the comparison.
3123 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003124 auto RHS_Instr = cast<Instruction>(RHS);
3125 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003126
3127 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3128 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003129 auto RHS_CR = getConstantRangeFromMetadata(
3130 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3131 auto LHS_CR = getConstantRangeFromMetadata(
3132 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003133
3134 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3135 if (Satisfied_CR.contains(LHS_CR))
3136 return ConstantInt::getTrue(RHS->getContext());
3137
3138 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3139 CmpInst::getInversePredicate(Pred), RHS_CR);
3140 if (InversedSatisfied_CR.contains(LHS_CR))
3141 return ConstantInt::getFalse(RHS->getContext());
3142 }
3143 }
3144
Duncan Sands8fb2c382011-01-20 13:21:55 +00003145 // Compare of cast, for example (zext X) != 0 -> X != 0
3146 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3147 Instruction *LI = cast<CastInst>(LHS);
3148 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003149 Type *SrcTy = SrcOp->getType();
3150 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003151
3152 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3153 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003154 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3155 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003156 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3157 // Transfer the cast to the constant.
3158 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3159 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003160 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003161 return V;
3162 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3163 if (RI->getOperand(0)->getType() == SrcTy)
3164 // Compare without the cast.
3165 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003166 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003167 return V;
3168 }
3169 }
3170
3171 if (isa<ZExtInst>(LHS)) {
3172 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3173 // same type.
3174 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3175 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3176 // Compare X and Y. Note that signed predicates become unsigned.
3177 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003178 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003179 MaxRecurse-1))
3180 return V;
3181 }
3182 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3183 // too. If not, then try to deduce the result of the comparison.
3184 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3185 // Compute the constant that would happen if we truncated to SrcTy then
3186 // reextended to DstTy.
3187 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3188 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3189
3190 // If the re-extended constant didn't change then this is effectively
3191 // also a case of comparing two zero-extended values.
3192 if (RExt == CI && MaxRecurse)
3193 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003194 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003195 return V;
3196
3197 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3198 // there. Use this to work out the result of the comparison.
3199 if (RExt != CI) {
3200 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003201 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003202 // LHS <u RHS.
3203 case ICmpInst::ICMP_EQ:
3204 case ICmpInst::ICMP_UGT:
3205 case ICmpInst::ICMP_UGE:
3206 return ConstantInt::getFalse(CI->getContext());
3207
3208 case ICmpInst::ICMP_NE:
3209 case ICmpInst::ICMP_ULT:
3210 case ICmpInst::ICMP_ULE:
3211 return ConstantInt::getTrue(CI->getContext());
3212
3213 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3214 // is non-negative then LHS <s RHS.
3215 case ICmpInst::ICMP_SGT:
3216 case ICmpInst::ICMP_SGE:
3217 return CI->getValue().isNegative() ?
3218 ConstantInt::getTrue(CI->getContext()) :
3219 ConstantInt::getFalse(CI->getContext());
3220
3221 case ICmpInst::ICMP_SLT:
3222 case ICmpInst::ICMP_SLE:
3223 return CI->getValue().isNegative() ?
3224 ConstantInt::getFalse(CI->getContext()) :
3225 ConstantInt::getTrue(CI->getContext());
3226 }
3227 }
3228 }
3229 }
3230
3231 if (isa<SExtInst>(LHS)) {
3232 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3233 // same type.
3234 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3235 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3236 // Compare X and Y. Note that the predicate does not change.
3237 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003238 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003239 return V;
3240 }
3241 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3242 // too. If not, then try to deduce the result of the comparison.
3243 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3244 // Compute the constant that would happen if we truncated to SrcTy then
3245 // reextended to DstTy.
3246 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3247 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3248
3249 // If the re-extended constant didn't change then this is effectively
3250 // also a case of comparing two sign-extended values.
3251 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003252 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003253 return V;
3254
3255 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3256 // bits there. Use this to work out the result of the comparison.
3257 if (RExt != CI) {
3258 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003259 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003260 case ICmpInst::ICMP_EQ:
3261 return ConstantInt::getFalse(CI->getContext());
3262 case ICmpInst::ICMP_NE:
3263 return ConstantInt::getTrue(CI->getContext());
3264
3265 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3266 // LHS >s RHS.
3267 case ICmpInst::ICMP_SGT:
3268 case ICmpInst::ICMP_SGE:
3269 return CI->getValue().isNegative() ?
3270 ConstantInt::getTrue(CI->getContext()) :
3271 ConstantInt::getFalse(CI->getContext());
3272 case ICmpInst::ICMP_SLT:
3273 case ICmpInst::ICMP_SLE:
3274 return CI->getValue().isNegative() ?
3275 ConstantInt::getFalse(CI->getContext()) :
3276 ConstantInt::getTrue(CI->getContext());
3277
3278 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3279 // LHS >u RHS.
3280 case ICmpInst::ICMP_UGT:
3281 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003282 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003283 if (MaxRecurse)
3284 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3285 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003286 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003287 return V;
3288 break;
3289 case ICmpInst::ICMP_ULT:
3290 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003291 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003292 if (MaxRecurse)
3293 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3294 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003295 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003296 return V;
3297 break;
3298 }
3299 }
3300 }
3301 }
3302 }
3303
James Molloy1d88d6f2015-10-22 13:18:42 +00003304 // icmp eq|ne X, Y -> false|true if X != Y
Craig Topperc2790ec2017-06-06 07:13:04 +00003305 if (ICmpInst::isEquality(Pred) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003306 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
Craig Topper2dfb4802017-06-06 07:13:13 +00003307 return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
James Molloy1d88d6f2015-10-22 13:18:42 +00003308 }
Junmo Park53470fc2016-04-05 21:14:31 +00003309
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003310 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3311 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003312
Sanjay Patel35289c62016-12-10 17:40:47 +00003313 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003314 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003315
Chandler Carruth8059c842012-03-25 21:28:14 +00003316 // Simplify comparisons of related pointers using a powerful, recursive
3317 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003318 if (LHS->getType()->isPointerTy())
Nuno Lopes404f1062017-09-09 18:23:11 +00003319 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI, LHS,
3320 RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003321 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003322 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3323 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3324 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3325 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3326 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3327 Q.DL.getTypeSizeInBits(CRHS->getType()))
Nuno Lopes404f1062017-09-09 18:23:11 +00003328 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
David Majnemerdc8767a2016-08-07 07:58:10 +00003329 CLHS->getPointerOperand(),
3330 CRHS->getPointerOperand()))
3331 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003332
Nick Lewycky3db143e2012-02-26 02:09:49 +00003333 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3334 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3335 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3336 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3337 (ICmpInst::isEquality(Pred) ||
3338 (GLHS->isInBounds() && GRHS->isInBounds() &&
3339 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3340 // The bases are equal and the indices are constant. Build a constant
3341 // expression GEP with the same indices and a null base pointer to see
3342 // what constant folding can make out of it.
3343 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3344 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003345 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3346 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003347
3348 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003349 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3350 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003351 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3352 }
3353 }
3354 }
3355
Duncan Sandsf532d312010-11-07 16:12:23 +00003356 // If the comparison is with the result of a select instruction, check whether
3357 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003358 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003359 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003360 return V;
3361
3362 // If the comparison is with the result of a phi instruction, check whether
3363 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003364 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003365 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003366 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003367
Craig Topper9f008862014-04-15 04:59:12 +00003368 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003369}
3370
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003371Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003372 const SimplifyQuery &Q) {
3373 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3374}
3375
Sanjay Patel472cc782016-01-11 22:14:42 +00003376/// Given operands for an FCmpInst, see if we can fold the result.
3377/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003378static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003379 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003380 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003381 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3382 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3383
Chris Lattnera71e9d62009-11-10 00:55:12 +00003384 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003385 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003386 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003387
Chris Lattnera71e9d62009-11-10 00:55:12 +00003388 // If we have a constant, make sure it is on the RHS.
3389 std::swap(LHS, RHS);
3390 Pred = CmpInst::getSwappedPredicate(Pred);
3391 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003392
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003393 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003394 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003395 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003396 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003397 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003398 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003399
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003400 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3401 if (FMF.noNaNs()) {
3402 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003403 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003404 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003405 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003406 }
3407
Mehdi Aminieb242a52015-03-09 03:20:25 +00003408 // fcmp pred x, undef and fcmp pred undef, x
3409 // fold to true if unordered, false if ordered
3410 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3411 // Choosing NaN for the undef will always make unordered comparison succeed
3412 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003413 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003414 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003415
3416 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003417 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003418 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003419 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003420 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003421 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003422 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003423
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003424 // Handle fcmp with constant RHS
David Majnemer3ee5f342016-04-13 06:55:52 +00003425 const ConstantFP *CFP = nullptr;
3426 if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3427 if (RHS->getType()->isVectorTy())
3428 CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3429 else
3430 CFP = dyn_cast<ConstantFP>(RHSC);
3431 }
3432 if (CFP) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003433 // If the constant is a nan, see if we can fold the comparison based on it.
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003434 if (CFP->getValueAPF().isNaN()) {
3435 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003436 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003437 assert(FCmpInst::isUnordered(Pred) &&
3438 "Comparison must be either ordered or unordered!");
3439 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003440 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003441 }
3442 // Check whether the constant is an infinity.
3443 if (CFP->getValueAPF().isInfinity()) {
3444 if (CFP->getValueAPF().isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003445 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003446 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003447 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003448 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003449 case FCmpInst::FCMP_UGE:
3450 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003451 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003452 default:
3453 break;
3454 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003455 } else {
3456 switch (Pred) {
3457 case FCmpInst::FCMP_OGT:
3458 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003459 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003460 case FCmpInst::FCMP_ULE:
3461 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003462 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003463 default:
3464 break;
3465 }
3466 }
3467 }
3468 if (CFP->getValueAPF().isZero()) {
3469 switch (Pred) {
3470 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003471 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003472 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003473 break;
3474 case FCmpInst::FCMP_OLT:
3475 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003476 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003477 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003478 break;
3479 default:
3480 break;
3481 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003482 }
3483 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003484
Duncan Sandsa620bd12010-11-07 16:46:25 +00003485 // If the comparison is with the result of a select instruction, check whether
3486 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003487 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003488 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003489 return V;
3490
3491 // If the comparison is with the result of a phi instruction, check whether
3492 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003493 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003494 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003495 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003496
Craig Topper9f008862014-04-15 04:59:12 +00003497 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003498}
3499
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003500Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003501 FastMathFlags FMF, const SimplifyQuery &Q) {
3502 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003503}
3504
Sanjay Patel472cc782016-01-11 22:14:42 +00003505/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003506static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003507 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003508 unsigned MaxRecurse) {
3509 // Trivial replacement.
3510 if (V == Op)
3511 return RepOp;
3512
Tim Northover997f5f12017-05-22 21:28:08 +00003513 // We cannot replace a constant, and shouldn't even try.
3514 if (isa<Constant>(Op))
3515 return nullptr;
3516
David Majnemer3f0fb982015-06-06 22:40:21 +00003517 auto *I = dyn_cast<Instruction>(V);
3518 if (!I)
3519 return nullptr;
3520
3521 // If this is a binary operator, try to simplify it with the replaced op.
3522 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3523 // Consider:
3524 // %cmp = icmp eq i32 %x, 2147483647
3525 // %add = add nsw i32 %x, 1
3526 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3527 //
3528 // We can't replace %sel with %add unless we strip away the flags.
3529 if (isa<OverflowingBinaryOperator>(B))
3530 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3531 return nullptr;
3532 if (isa<PossiblyExactOperator>(B))
3533 if (B->isExact())
3534 return nullptr;
3535
3536 if (MaxRecurse) {
3537 if (B->getOperand(0) == Op)
3538 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3539 MaxRecurse - 1);
3540 if (B->getOperand(1) == Op)
3541 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3542 MaxRecurse - 1);
3543 }
3544 }
3545
3546 // Same for CmpInsts.
3547 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3548 if (MaxRecurse) {
3549 if (C->getOperand(0) == Op)
3550 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3551 MaxRecurse - 1);
3552 if (C->getOperand(1) == Op)
3553 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3554 MaxRecurse - 1);
3555 }
3556 }
3557
3558 // TODO: We could hand off more cases to instsimplify here.
3559
3560 // If all operands are constant after substituting Op for RepOp then we can
3561 // constant fold the instruction.
3562 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3563 // Build a list of all constant operands.
3564 SmallVector<Constant *, 8> ConstOps;
3565 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3566 if (I->getOperand(i) == Op)
3567 ConstOps.push_back(CRepOp);
3568 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3569 ConstOps.push_back(COp);
3570 else
3571 break;
3572 }
3573
3574 // All operands were constants, fold it.
3575 if (ConstOps.size() == I->getNumOperands()) {
3576 if (CmpInst *C = dyn_cast<CmpInst>(I))
3577 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3578 ConstOps[1], Q.DL, Q.TLI);
3579
3580 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3581 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003582 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003583
Manuel Jacobe9024592016-01-21 06:33:22 +00003584 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003585 }
3586 }
3587
3588 return nullptr;
3589}
3590
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003591/// Try to simplify a select instruction when its condition operand is an
3592/// integer comparison where one operand of the compare is a constant.
3593static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3594 const APInt *Y, bool TrueWhenUnset) {
3595 const APInt *C;
3596
3597 // (X & Y) == 0 ? X & ~Y : X --> X
3598 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3599 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3600 *Y == ~*C)
3601 return TrueWhenUnset ? FalseVal : TrueVal;
3602
3603 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3604 // (X & Y) != 0 ? X : X & ~Y --> X
3605 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3606 *Y == ~*C)
3607 return TrueWhenUnset ? FalseVal : TrueVal;
3608
3609 if (Y->isPowerOf2()) {
3610 // (X & Y) == 0 ? X | Y : X --> X | Y
3611 // (X & Y) != 0 ? X | Y : X --> X
3612 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3613 *Y == *C)
3614 return TrueWhenUnset ? TrueVal : FalseVal;
3615
3616 // (X & Y) == 0 ? X : X | Y --> X
3617 // (X & Y) != 0 ? X : X | Y --> X | Y
3618 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3619 *Y == *C)
3620 return TrueWhenUnset ? TrueVal : FalseVal;
3621 }
Matt Arsenault82606662017-01-11 00:57:54 +00003622
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003623 return nullptr;
3624}
3625
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003626/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3627/// eq/ne.
Craig Topper0aa3a192017-08-14 21:39:51 +00003628static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3629 ICmpInst::Predicate Pred,
3630 Value *TrueVal, Value *FalseVal) {
3631 Value *X;
3632 APInt Mask;
3633 if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3634 return nullptr;
3635
Craig Topper0aa3a192017-08-14 21:39:51 +00003636 return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3637 Pred == ICmpInst::ICMP_EQ);
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003638}
3639
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003640/// Try to simplify a select instruction when its condition operand is an
3641/// integer comparison.
3642static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003643 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003644 unsigned MaxRecurse) {
3645 ICmpInst::Predicate Pred;
3646 Value *CmpLHS, *CmpRHS;
3647 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3648 return nullptr;
3649
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003650 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3651 Value *X;
3652 const APInt *Y;
3653 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3654 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3655 Pred == ICmpInst::ICMP_EQ))
3656 return V;
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003657 }
3658
Craig Topper0aa3a192017-08-14 21:39:51 +00003659 // Check for other compares that behave like bit test.
3660 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3661 TrueVal, FalseVal))
3662 return V;
3663
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003664 if (CondVal->hasOneUse()) {
3665 const APInt *C;
3666 if (match(CmpRHS, m_APInt(C))) {
3667 // X < MIN ? T : F --> F
3668 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3669 return FalseVal;
3670 // X < MIN ? T : F --> F
3671 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3672 return FalseVal;
3673 // X > MAX ? T : F --> F
3674 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3675 return FalseVal;
3676 // X > MAX ? T : F --> F
3677 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3678 return FalseVal;
3679 }
3680 }
3681
3682 // If we have an equality comparison, then we know the value in one of the
3683 // arms of the select. See if substituting this value into the arm and
3684 // simplifying the result yields the same value as the other arm.
3685 if (Pred == ICmpInst::ICMP_EQ) {
3686 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3687 TrueVal ||
3688 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3689 TrueVal)
3690 return FalseVal;
3691 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3692 FalseVal ||
3693 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3694 FalseVal)
3695 return FalseVal;
3696 } else if (Pred == ICmpInst::ICMP_NE) {
3697 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3698 FalseVal ||
3699 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3700 FalseVal)
3701 return TrueVal;
3702 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3703 TrueVal ||
3704 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3705 TrueVal)
3706 return TrueVal;
3707 }
3708
3709 return nullptr;
3710}
3711
Sanjay Patel472cc782016-01-11 22:14:42 +00003712/// Given operands for a SelectInst, see if we can fold the result.
3713/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003714static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003715 Value *FalseVal, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003716 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003717 // select true, X, Y -> X
3718 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003719 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3720 if (CB->isAllOnesValue())
3721 return TrueVal;
3722 if (CB->isNullValue())
3723 return FalseVal;
3724 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003725
Chris Lattnerc707fa92010-04-20 05:32:14 +00003726 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003727 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003728 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003729
Chris Lattnerc707fa92010-04-20 05:32:14 +00003730 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
Daniel Berlin4d0fe642017-04-28 19:55:38 +00003731 if (isa<Constant>(FalseVal))
3732 return FalseVal;
3733 return TrueVal;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003734 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003735 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3736 return FalseVal;
3737 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3738 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003739
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003740 if (Value *V =
3741 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3742 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003743
Craig Topper9f008862014-04-15 04:59:12 +00003744 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003745}
3746
Duncan Sandsb8cee002012-03-13 11:42:19 +00003747Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003748 const SimplifyQuery &Q) {
3749 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003750}
3751
Sanjay Patel472cc782016-01-11 22:14:42 +00003752/// Given operands for an GetElementPtrInst, see if we can fold the result.
3753/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003754static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003755 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003756 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003757 unsigned AS =
3758 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003759
Chris Lattner8574aba2009-11-27 00:29:05 +00003760 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003761 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003762 return Ops[0];
3763
Nico Weber48c82402014-08-27 20:06:19 +00003764 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003765 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003766 Type *GEPTy = PointerType::get(LastType, AS);
3767 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3768 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003769 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3770 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003771
3772 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003773 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003774
Jay Foadb992a632011-07-19 15:07:52 +00003775 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003776 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003777 if (match(Ops[1], m_Zero()))
3778 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003779
David Blaikie4a2e73b2015-04-02 18:55:32 +00003780 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003781 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003782 Value *P;
3783 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003784 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003785 // getelementptr P, N -> P if P points to a type of zero size.
3786 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003787 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003788
3789 // The following transforms are only safe if the ptrtoint cast
3790 // doesn't truncate the pointers.
3791 if (Ops[1]->getType()->getScalarSizeInBits() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003792 Q.DL.getPointerSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003793 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3794 if (match(P, m_Zero()))
3795 return Constant::getNullValue(GEPTy);
3796 Value *Temp;
3797 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003798 if (Temp->getType() == GEPTy)
3799 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003800 return nullptr;
3801 };
3802
3803 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3804 if (TyAllocSize == 1 &&
3805 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3806 if (Value *R = PtrToIntOrZero(P))
3807 return R;
3808
3809 // getelementptr V, (ashr (sub P, V), C) -> Q
3810 // if P points to a type of size 1 << C.
3811 if (match(Ops[1],
3812 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3813 m_ConstantInt(C))) &&
3814 TyAllocSize == 1ULL << C)
3815 if (Value *R = PtrToIntOrZero(P))
3816 return R;
3817
3818 // getelementptr V, (sdiv (sub P, V), C) -> Q
3819 // if P points to a type of size C.
3820 if (match(Ops[1],
3821 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3822 m_SpecificInt(TyAllocSize))))
3823 if (Value *R = PtrToIntOrZero(P))
3824 return R;
3825 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003826 }
3827 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003828
David Majnemerd1501372016-08-07 07:58:12 +00003829 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3830 all_of(Ops.slice(1).drop_back(1),
3831 [](Value *Idx) { return match(Idx, m_Zero()); })) {
3832 unsigned PtrWidth =
3833 Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3834 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3835 APInt BasePtrOffset(PtrWidth, 0);
3836 Value *StrippedBasePtr =
3837 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3838 BasePtrOffset);
3839
David Majnemer5c5df622016-08-16 06:13:46 +00003840 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003841 if (match(Ops.back(),
3842 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3843 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3844 return ConstantExpr::getIntToPtr(CI, GEPTy);
3845 }
David Majnemer5c5df622016-08-16 06:13:46 +00003846 // gep (gep V, C), (xor V, -1) -> C-1
3847 if (match(Ops.back(),
3848 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3849 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3850 return ConstantExpr::getIntToPtr(CI, GEPTy);
3851 }
David Majnemerd1501372016-08-07 07:58:12 +00003852 }
3853 }
3854
Chris Lattner8574aba2009-11-27 00:29:05 +00003855 // Check to see if this is constant foldable.
Craig Topperda8037f2017-06-04 22:41:56 +00003856 if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
3857 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003858
Joey Gouly61eaa632017-06-06 10:17:14 +00003859 auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3860 Ops.slice(1));
3861 if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
3862 return CEFolded;
3863 return CE;
Chris Lattner8574aba2009-11-27 00:29:05 +00003864}
3865
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003866Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003867 const SimplifyQuery &Q) {
3868 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003869}
3870
Sanjay Patel472cc782016-01-11 22:14:42 +00003871/// Given operands for an InsertValueInst, see if we can fold the result.
3872/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003873static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003874 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003875 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003876 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3877 if (Constant *CVal = dyn_cast<Constant>(Val))
3878 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3879
3880 // insertvalue x, undef, n -> x
3881 if (match(Val, m_Undef()))
3882 return Agg;
3883
3884 // insertvalue x, (extractvalue y, n), n
3885 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003886 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3887 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003888 // insertvalue undef, (extractvalue y, n), n -> y
3889 if (match(Agg, m_Undef()))
3890 return EV->getAggregateOperand();
3891
3892 // insertvalue y, (extractvalue y, n), n -> y
3893 if (Agg == EV->getAggregateOperand())
3894 return Agg;
3895 }
3896
Craig Topper9f008862014-04-15 04:59:12 +00003897 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003898}
3899
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003900Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3901 ArrayRef<unsigned> Idxs,
3902 const SimplifyQuery &Q) {
3903 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3904}
3905
Sanjay Patel472cc782016-01-11 22:14:42 +00003906/// Given operands for an ExtractValueInst, see if we can fold the result.
3907/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003908static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003909 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00003910 if (auto *CAgg = dyn_cast<Constant>(Agg))
3911 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3912
3913 // extractvalue x, (insertvalue y, elt, n), n -> elt
3914 unsigned NumIdxs = Idxs.size();
3915 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3916 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3917 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3918 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3919 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3920 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3921 Idxs.slice(0, NumCommonIdxs)) {
3922 if (NumIdxs == NumInsertValueIdxs)
3923 return IVI->getInsertedValueOperand();
3924 break;
3925 }
3926 }
3927
3928 return nullptr;
3929}
3930
3931Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003932 const SimplifyQuery &Q) {
3933 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
3934}
3935
Sanjay Patel472cc782016-01-11 22:14:42 +00003936/// Given operands for an ExtractElementInst, see if we can fold the result.
3937/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003938static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00003939 unsigned) {
3940 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3941 if (auto *CIdx = dyn_cast<Constant>(Idx))
3942 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3943
3944 // The index is not relevant if our vector is a splat.
3945 if (auto *Splat = CVec->getSplatValue())
3946 return Splat;
3947
3948 if (isa<UndefValue>(Vec))
3949 return UndefValue::get(Vec->getType()->getVectorElementType());
3950 }
3951
3952 // If extracting a specified index from the vector, see if we can recursively
3953 // find a previously computed scalar that was inserted into the vector.
David Majnemer8e335ca2015-08-18 22:18:22 +00003954 if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3955 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
David Majnemer599ca442015-07-13 01:15:53 +00003956 return Elt;
David Majnemer599ca442015-07-13 01:15:53 +00003957
3958 return nullptr;
3959}
3960
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003961Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
3962 const SimplifyQuery &Q) {
3963 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
3964}
3965
Sanjay Patel472cc782016-01-11 22:14:42 +00003966/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003967static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003968 // If all of the PHI's incoming values are the same then replace the PHI node
3969 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00003970 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00003971 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00003972 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003973 // If the incoming value is the phi node itself, it can safely be skipped.
3974 if (Incoming == PN) continue;
3975 if (isa<UndefValue>(Incoming)) {
3976 // Remember that we saw an undef value, but otherwise ignore them.
3977 HasUndefInput = true;
3978 continue;
3979 }
3980 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00003981 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00003982 CommonValue = Incoming;
3983 }
3984
3985 // If CommonValue is null then all of the incoming values were either undef or
3986 // equal to the phi node itself.
3987 if (!CommonValue)
3988 return UndefValue::get(PN->getType());
3989
3990 // If we have a PHI node like phi(X, undef, X), where X is defined by some
3991 // instruction, we cannot return X as the result of the PHI node unless it
3992 // dominates the PHI block.
3993 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00003994 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00003995
3996 return CommonValue;
3997}
3998
David Majnemer6774d612016-07-26 17:58:05 +00003999static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004000 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004001 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004002 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004003
David Majnemer6774d612016-07-26 17:58:05 +00004004 if (auto *CI = dyn_cast<CastInst>(Op)) {
4005 auto *Src = CI->getOperand(0);
4006 Type *SrcTy = Src->getType();
4007 Type *MidTy = CI->getType();
4008 Type *DstTy = Ty;
4009 if (Src->getType() == Ty) {
4010 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4011 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4012 Type *SrcIntPtrTy =
4013 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4014 Type *MidIntPtrTy =
4015 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4016 Type *DstIntPtrTy =
4017 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4018 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4019 SrcIntPtrTy, MidIntPtrTy,
4020 DstIntPtrTy) == Instruction::BitCast)
4021 return Src;
4022 }
4023 }
David Majnemera90a6212016-07-26 05:52:29 +00004024
4025 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004026 if (CastOpc == Instruction::BitCast)
4027 if (Op->getType() == Ty)
4028 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004029
4030 return nullptr;
4031}
4032
David Majnemer6774d612016-07-26 17:58:05 +00004033Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004034 const SimplifyQuery &Q) {
4035 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4036}
4037
Sanjay Patela3c297d2017-04-19 16:48:22 +00004038/// For the given destination element of a shuffle, peek through shuffles to
4039/// match a root vector source operand that contains that element in the same
4040/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4041static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004042 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004043 unsigned MaxRecurse) {
4044 if (!MaxRecurse--)
4045 return nullptr;
4046
4047 // Bail out if any mask value is undefined. That kind of shuffle may be
4048 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004049 if (MaskVal == -1)
4050 return nullptr;
4051
4052 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004053 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004054 int RootElt = MaskVal;
4055 Value *SourceOp = Op0;
4056 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004057 RootElt = MaskVal - InVecNumElts;
4058 SourceOp = Op1;
4059 }
4060
4061 // If the source operand is a shuffle itself, look through it to find the
4062 // matching root vector.
4063 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4064 return foldIdentityShuffles(
4065 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004066 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004067 }
4068
4069 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4070 // size?
4071
4072 // The source operand is not a shuffle. Initialize the root vector value for
4073 // this shuffle if that has not been done yet.
4074 if (!RootVec)
4075 RootVec = SourceOp;
4076
4077 // Give up as soon as a source operand does not match the existing root value.
4078 if (RootVec != SourceOp)
4079 return nullptr;
4080
4081 // The element must be coming from the same lane in the source vector
4082 // (although it may have crossed lanes in intermediate shuffles).
4083 if (RootElt != DestElt)
4084 return nullptr;
4085
4086 return RootVec;
4087}
4088
Zvi Rackover8f460652017-04-03 22:05:30 +00004089static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004090 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004091 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004092 if (isa<UndefValue>(Mask))
4093 return UndefValue::get(RetTy);
4094
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004095 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004096 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004097 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004098
Zvi Rackover0411e462017-04-30 06:10:54 +00004099 SmallVector<int, 32> Indices;
4100 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4101 assert(MaskNumElts == Indices.size() &&
4102 "Size of Indices not same as number of mask elements?");
4103
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004104 // Canonicalization: If mask does not select elements from an input vector,
4105 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004106 bool MaskSelects0 = false, MaskSelects1 = false;
4107 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004108 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004109 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004110 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004111 MaskSelects0 = true;
4112 else
4113 MaskSelects1 = true;
4114 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004115 if (!MaskSelects0)
4116 Op0 = UndefValue::get(InVecTy);
4117 if (!MaskSelects1)
4118 Op1 = UndefValue::get(InVecTy);
4119
4120 auto *Op0Const = dyn_cast<Constant>(Op0);
4121 auto *Op1Const = dyn_cast<Constant>(Op1);
4122
4123 // If all operands are constant, constant fold the shuffle.
4124 if (Op0Const && Op1Const)
4125 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4126
4127 // Canonicalization: if only one input vector is constant, it shall be the
4128 // second one.
4129 if (Op0Const && !Op1Const) {
4130 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004131 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004132 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004133
4134 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4135 // value type is same as the input vectors' type.
4136 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004137 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004138 OpShuf->getMask()->getSplatValue())
4139 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004140
Sanjay Patela3c297d2017-04-19 16:48:22 +00004141 // Don't fold a shuffle with undef mask elements. This may get folded in a
4142 // better way using demanded bits or other analysis.
4143 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004144 if (find(Indices, -1) != Indices.end())
4145 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004146
4147 // Check if every element of this shuffle can be mapped back to the
4148 // corresponding element of a single root vector. If so, we don't need this
4149 // shuffle. This handles simple identity shuffles as well as chains of
4150 // shuffles that may widen/narrow and/or move elements across lanes and back.
4151 Value *RootVec = nullptr;
4152 for (unsigned i = 0; i != MaskNumElts; ++i) {
4153 // Note that recursion is limited for each vector element, so if any element
4154 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004155 RootVec =
4156 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004157
4158 // We can't replace a widening/narrowing shuffle with one of its operands.
4159 if (!RootVec || RootVec->getType() != RetTy)
4160 return nullptr;
4161 }
4162 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004163}
4164
4165/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004166Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4167 Type *RetTy, const SimplifyQuery &Q) {
4168 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004169}
4170
Chris Lattnera71e9d62009-11-10 00:55:12 +00004171//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004172
Sanjay Patel472cc782016-01-11 22:14:42 +00004173/// Given operands for a BinaryOperator, see if we can fold the result.
4174/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004175static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004176 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004177 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004178 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004179 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004180 case Instruction::FAdd:
4181 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004182 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004183 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004184 case Instruction::FSub:
4185 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004186 case Instruction::Mul:
4187 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004188 case Instruction::FMul:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004189 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4190 case Instruction::SDiv:
4191 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4192 case Instruction::UDiv:
4193 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004194 case Instruction::FDiv:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004195 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4196 case Instruction::SRem:
4197 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4198 case Instruction::URem:
4199 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004200 case Instruction::FRem:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004201 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004202 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004203 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004204 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004205 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004206 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004207 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4208 case Instruction::And:
4209 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4210 case Instruction::Or:
4211 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4212 case Instruction::Xor:
4213 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004214 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004215 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004216 }
4217}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004218
Sanjay Patel472cc782016-01-11 22:14:42 +00004219/// Given operands for a BinaryOperator, see if we can fold the result.
4220/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004221/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4222/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4223static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004224 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004225 unsigned MaxRecurse) {
4226 switch (Opcode) {
4227 case Instruction::FAdd:
4228 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4229 case Instruction::FSub:
4230 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4231 case Instruction::FMul:
4232 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004233 case Instruction::FDiv:
4234 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004235 default:
4236 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4237 }
4238}
4239
Duncan Sands7e800d62010-11-14 11:23:23 +00004240Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004241 const SimplifyQuery &Q) {
4242 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4243}
4244
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004245Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004246 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004247 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4248}
4249
Sanjay Patel472cc782016-01-11 22:14:42 +00004250/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004251static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004252 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004253 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004254 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004255 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004256}
4257
4258Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004259 const SimplifyQuery &Q) {
4260 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4261}
4262
Michael Ilseman54857292013-02-07 19:26:05 +00004263static bool IsIdempotent(Intrinsic::ID ID) {
4264 switch (ID) {
4265 default: return false;
4266
4267 // Unary idempotent: f(f(x)) = f(x)
4268 case Intrinsic::fabs:
4269 case Intrinsic::floor:
4270 case Intrinsic::ceil:
4271 case Intrinsic::trunc:
4272 case Intrinsic::rint:
4273 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004274 case Intrinsic::round:
Matt Arsenault3ced3d92017-09-07 01:21:43 +00004275 case Intrinsic::canonicalize:
Michael Ilseman54857292013-02-07 19:26:05 +00004276 return true;
4277 }
4278}
4279
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004280static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4281 const DataLayout &DL) {
4282 GlobalValue *PtrSym;
4283 APInt PtrOffset;
4284 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4285 return nullptr;
4286
4287 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4288 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4289 Type *Int32PtrTy = Int32Ty->getPointerTo();
4290 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4291
4292 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4293 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4294 return nullptr;
4295
4296 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4297 if (OffsetInt % 4 != 0)
4298 return nullptr;
4299
4300 Constant *C = ConstantExpr::getGetElementPtr(
4301 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4302 ConstantInt::get(Int64Ty, OffsetInt / 4));
4303 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4304 if (!Loaded)
4305 return nullptr;
4306
4307 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4308 if (!LoadedCE)
4309 return nullptr;
4310
4311 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4312 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4313 if (!LoadedCE)
4314 return nullptr;
4315 }
4316
4317 if (LoadedCE->getOpcode() != Instruction::Sub)
4318 return nullptr;
4319
4320 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4321 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4322 return nullptr;
4323 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4324
4325 Constant *LoadedRHS = LoadedCE->getOperand(1);
4326 GlobalValue *LoadedRHSSym;
4327 APInt LoadedRHSOffset;
4328 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4329 DL) ||
4330 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4331 return nullptr;
4332
4333 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4334}
4335
David Majnemer17a95aa2016-07-14 06:58:37 +00004336static bool maskIsAllZeroOrUndef(Value *Mask) {
4337 auto *ConstMask = dyn_cast<Constant>(Mask);
4338 if (!ConstMask)
4339 return false;
4340 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4341 return true;
4342 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4343 ++I) {
4344 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4345 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4346 continue;
4347 return false;
4348 }
4349 return true;
4350}
4351
Michael Ilseman54857292013-02-07 19:26:05 +00004352template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004353static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004354 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004355 Intrinsic::ID IID = F->getIntrinsicID();
4356 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004357
4358 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004359 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004360 // Perform idempotent optimizations
4361 if (IsIdempotent(IID)) {
4362 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4363 if (II->getIntrinsicID() == IID)
4364 return II;
4365 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004366 }
4367
4368 switch (IID) {
4369 case Intrinsic::fabs: {
4370 if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4371 return *ArgBegin;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004372 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004373 }
4374 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004375 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004376 }
4377 }
Michael Ilseman54857292013-02-07 19:26:05 +00004378
Matt Arsenault82606662017-01-11 00:57:54 +00004379 // Binary Ops
4380 if (NumOperands == 2) {
4381 Value *LHS = *ArgBegin;
4382 Value *RHS = *(ArgBegin + 1);
4383 Type *ReturnType = F->getReturnType();
4384
4385 switch (IID) {
4386 case Intrinsic::usub_with_overflow:
4387 case Intrinsic::ssub_with_overflow: {
4388 // X - X -> { 0, false }
4389 if (LHS == RHS)
4390 return Constant::getNullValue(ReturnType);
4391
4392 // X - undef -> undef
4393 // undef - X -> undef
4394 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4395 return UndefValue::get(ReturnType);
4396
4397 return nullptr;
4398 }
4399 case Intrinsic::uadd_with_overflow:
4400 case Intrinsic::sadd_with_overflow: {
4401 // X + undef -> undef
Craig Topper77e07cc2017-05-24 17:05:28 +00004402 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
Matt Arsenault82606662017-01-11 00:57:54 +00004403 return UndefValue::get(ReturnType);
4404
4405 return nullptr;
4406 }
4407 case Intrinsic::umul_with_overflow:
4408 case Intrinsic::smul_with_overflow: {
Craig Topper77e07cc2017-05-24 17:05:28 +00004409 // 0 * X -> { 0, false }
Matt Arsenault82606662017-01-11 00:57:54 +00004410 // X * 0 -> { 0, false }
Craig Topper77e07cc2017-05-24 17:05:28 +00004411 if (match(LHS, m_Zero()) || match(RHS, m_Zero()))
Matt Arsenault82606662017-01-11 00:57:54 +00004412 return Constant::getNullValue(ReturnType);
4413
Craig Topper77e07cc2017-05-24 17:05:28 +00004414 // undef * X -> { 0, false }
Matt Arsenault82606662017-01-11 00:57:54 +00004415 // X * undef -> { 0, false }
Craig Topper77e07cc2017-05-24 17:05:28 +00004416 if (match(LHS, m_Undef()) || match(RHS, m_Undef()))
Matt Arsenault82606662017-01-11 00:57:54 +00004417 return Constant::getNullValue(ReturnType);
4418
4419 return nullptr;
4420 }
4421 case Intrinsic::load_relative: {
4422 Constant *C0 = dyn_cast<Constant>(LHS);
4423 Constant *C1 = dyn_cast<Constant>(RHS);
4424 if (C0 && C1)
4425 return SimplifyRelativeLoad(C0, C1, Q.DL);
4426 return nullptr;
4427 }
4428 default:
4429 return nullptr;
4430 }
4431 }
4432
4433 // Simplify calls to llvm.masked.load.*
4434 switch (IID) {
4435 case Intrinsic::masked_load: {
4436 Value *MaskArg = ArgBegin[2];
4437 Value *PassthruArg = ArgBegin[3];
4438 // If the mask is all zeros or undef, the "passthru" argument is the result.
4439 if (maskIsAllZeroOrUndef(MaskArg))
4440 return PassthruArg;
4441 return nullptr;
4442 }
4443 default:
4444 return nullptr;
4445 }
Michael Ilseman54857292013-02-07 19:26:05 +00004446}
4447
Chandler Carruth9dc35582012-12-28 11:30:55 +00004448template <typename IterTy>
Andrew Kaylor647025f2017-06-09 23:18:11 +00004449static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
4450 IterTy ArgEnd, const SimplifyQuery &Q,
4451 unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004452 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004453 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4454 Ty = PTy->getElementType();
4455 FunctionType *FTy = cast<FunctionType>(Ty);
4456
Dan Gohman85977e62011-11-04 18:32:42 +00004457 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004458 // call null -> undef
4459 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004460 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004461
Chandler Carruthf6182152012-12-28 14:23:29 +00004462 Function *F = dyn_cast<Function>(V);
4463 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004464 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004465
David Majnemer15032582015-05-22 03:56:46 +00004466 if (F->isIntrinsic())
4467 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004468 return Ret;
4469
Andrew Kaylor647025f2017-06-09 23:18:11 +00004470 if (!canConstantFoldCallTo(CS, F))
Craig Topper9f008862014-04-15 04:59:12 +00004471 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004472
4473 SmallVector<Constant *, 4> ConstantArgs;
4474 ConstantArgs.reserve(ArgEnd - ArgBegin);
4475 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4476 Constant *C = dyn_cast<Constant>(*I);
4477 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004478 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004479 ConstantArgs.push_back(C);
4480 }
4481
Andrew Kaylor647025f2017-06-09 23:18:11 +00004482 return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004483}
4484
Andrew Kaylor647025f2017-06-09 23:18:11 +00004485Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4486 User::op_iterator ArgBegin, User::op_iterator ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004487 const SimplifyQuery &Q) {
Andrew Kaylor647025f2017-06-09 23:18:11 +00004488 return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
4489}
4490
4491Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4492 ArrayRef<Value *> Args, const SimplifyQuery &Q) {
4493 return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004494}
4495
Sanjay Patel472cc782016-01-11 22:14:42 +00004496/// See if we can compute a simplified version of this instruction.
4497/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004498
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004499Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004500 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004501 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004502 Value *Result;
4503
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004504 switch (I->getOpcode()) {
4505 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004506 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004507 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004508 case Instruction::FAdd:
4509 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004510 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004511 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004512 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004513 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4514 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004515 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004516 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004517 case Instruction::FSub:
4518 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004519 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004520 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004521 case Instruction::Sub:
4522 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4523 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004524 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004525 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004526 case Instruction::FMul:
4527 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004528 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004529 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004530 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004531 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004532 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004533 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004534 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004535 break;
4536 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004537 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004538 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004539 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004540 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004541 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00004542 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004543 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004544 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004545 break;
4546 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004547 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004548 break;
4549 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004550 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004551 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004552 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004553 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004554 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4555 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004556 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004557 break;
4558 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004559 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004560 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004561 break;
4562 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004563 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004564 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004565 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004566 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004567 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004568 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004569 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004570 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004571 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004572 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004573 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004574 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004575 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004576 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4577 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004578 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004579 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004580 Result =
4581 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4582 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004583 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004584 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004585 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004586 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004587 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004588 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004589 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004590 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004591 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004592 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004593 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004594 case Instruction::InsertValue: {
4595 InsertValueInst *IV = cast<InsertValueInst>(I);
4596 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4597 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004598 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004599 break;
4600 }
David Majnemer25a796e2015-07-13 01:15:46 +00004601 case Instruction::ExtractValue: {
4602 auto *EVI = cast<ExtractValueInst>(I);
4603 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004604 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00004605 break;
4606 }
David Majnemer599ca442015-07-13 01:15:53 +00004607 case Instruction::ExtractElement: {
4608 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004609 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4610 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00004611 break;
4612 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004613 case Instruction::ShuffleVector: {
4614 auto *SVI = cast<ShuffleVectorInst>(I);
4615 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004616 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00004617 break;
4618 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004619 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004620 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004621 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004622 case Instruction::Call: {
4623 CallSite CS(cast<CallInst>(I));
Andrew Kaylor647025f2017-06-09 23:18:11 +00004624 Result = SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
4625 Q);
Dan Gohman85977e62011-11-04 18:32:42 +00004626 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004627 }
David Majnemer6774d612016-07-26 17:58:05 +00004628#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4629#include "llvm/IR/Instruction.def"
4630#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004631 Result =
4632 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00004633 break;
Craig Topper81c03a72017-04-12 22:54:24 +00004634 case Instruction::Alloca:
4635 // No simplifications for Alloca and it can't be constant folded.
4636 Result = nullptr;
4637 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004638 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004639
Hal Finkelf2199b22015-10-23 20:37:08 +00004640 // In general, it is possible for computeKnownBits to determine all bits in a
4641 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004642 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Craig Topper8205a1a2017-05-24 16:53:07 +00004643 KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00004644 if (Known.isConstant())
4645 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00004646 }
4647
Duncan Sands64e41cf2010-11-17 08:35:29 +00004648 /// If called on unreachable code, the above logic may report that the
4649 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004650 /// detecting that case here, returning a safe value instead.
4651 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004652}
4653
Sanjay Patelf44bd382016-01-20 18:59:48 +00004654/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004655/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004656///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004657/// This is the common implementation of the recursive simplification routines.
4658/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4659/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4660/// instructions to process and attempt to simplify it using
4661/// InstructionSimplify.
4662///
4663/// This routine returns 'true' only when *it* simplifies something. The passed
4664/// in simplified value does not count toward this.
4665static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004666 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004667 const DominatorTree *DT,
4668 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004669 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004670 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004671 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004672
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004673 // If we have an explicit value to collapse to, do that round of the
4674 // simplification loop by hand initially.
4675 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004676 for (User *U : I->users())
4677 if (U != I)
4678 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004679
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004680 // Replace the instruction with its simplified value.
4681 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004682
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004683 // Gracefully handle edge cases where the instruction is not wired into any
4684 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004685 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4686 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004687 I->eraseFromParent();
4688 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004689 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004690 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004691
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004692 // Note that we must test the size on each iteration, the worklist can grow.
4693 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4694 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004695
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004696 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004697 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004698 if (!SimpleV)
4699 continue;
4700
4701 Simplified = true;
4702
4703 // Stash away all the uses of the old instruction so we can check them for
4704 // recursive simplifications after a RAUW. This is cheaper than checking all
4705 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004706 for (User *U : I->users())
4707 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004708
4709 // Replace the instruction with its simplified value.
4710 I->replaceAllUsesWith(SimpleV);
4711
4712 // Gracefully handle edge cases where the instruction is not wired into any
4713 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004714 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4715 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004716 I->eraseFromParent();
4717 }
4718 return Simplified;
4719}
4720
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004721bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004722 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004723 const DominatorTree *DT,
4724 AssumptionCache *AC) {
4725 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004726}
4727
4728bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004729 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004730 const DominatorTree *DT,
4731 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004732 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4733 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004734 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004735}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004736
4737namespace llvm {
4738const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
4739 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
4740 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
4741 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
4742 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
4743 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
4744 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
4745 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4746}
4747
4748const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
4749 const DataLayout &DL) {
4750 return {DL, &AR.TLI, &AR.DT, &AR.AC};
4751}
4752
4753template <class T, class... TArgs>
4754const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
4755 Function &F) {
4756 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
4757 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
4758 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
4759 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4760}
4761template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
4762 Function &);
4763}