blob: 5265fe0b2019e22f65ad76694b25d571f0a23f0b [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"
Anna Thomas43d7e1c2016-05-03 14:58:21 +000024#include "llvm/Analysis/CaptureTracking.h"
Chris Lattner084a1b52009-11-09 22:57:59 +000025#include "llvm/Analysis/ConstantFolding.h"
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +000026#include "llvm/Analysis/MemoryBuiltins.h"
Sanjay Patel54656ca2017-02-06 18:26:06 +000027#include "llvm/Analysis/OptimizationDiagnosticInfo.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000028#include "llvm/Analysis/ValueTracking.h"
David Majnemer599ca442015-07-13 01:15:53 +000029#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000030#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000031#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000032#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000033#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000034#include "llvm/IR/GlobalAlias.h"
35#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000036#include "llvm/IR/PatternMatch.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000037#include "llvm/IR/ValueHandle.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000038#include <algorithm>
Chris Lattner084a1b52009-11-09 22:57:59 +000039using namespace llvm;
Chris Lattnera71e9d62009-11-10 00:55:12 +000040using namespace llvm::PatternMatch;
Chris Lattner084a1b52009-11-09 22:57:59 +000041
Chandler Carruthf1221bd2014-04-22 02:48:03 +000042#define DEBUG_TYPE "instsimplify"
43
Chris Lattner9e4aa022011-02-09 17:15:04 +000044enum { RecursionLimit = 3 };
Duncan Sandsf3b1bf12010-11-10 18:23:01 +000045
Duncan Sands3547d2e2010-12-22 09:40:51 +000046STATISTIC(NumExpand, "Number of expansions");
Duncan Sands3547d2e2010-12-22 09:40:51 +000047STATISTIC(NumReassoc, "Number of reassociations");
48
Benjamin Kramercfd8d902014-09-12 08:56:53 +000049namespace {
Duncan Sandsb8cee002012-03-13 11:42:19 +000050struct Query {
Mehdi Aminia28d91d2015-03-10 02:37:25 +000051 const DataLayout &DL;
Duncan Sandsb8cee002012-03-13 11:42:19 +000052 const TargetLibraryInfo *TLI;
53 const DominatorTree *DT;
Daniel Jasperaec2fa32016-12-19 08:22:17 +000054 AssumptionCache *AC;
Hal Finkel60db0582014-09-07 18:57:58 +000055 const Instruction *CxtI;
Duncan Sandsb8cee002012-03-13 11:42:19 +000056
Mehdi Aminia28d91d2015-03-10 02:37:25 +000057 Query(const DataLayout &DL, const TargetLibraryInfo *tli,
Daniel Jasperaec2fa32016-12-19 08:22:17 +000058 const DominatorTree *dt, AssumptionCache *ac = nullptr,
59 const Instruction *cxti = nullptr)
60 : DL(DL), TLI(tli), DT(dt), AC(ac), CxtI(cxti) {}
Duncan Sandsb8cee002012-03-13 11:42:19 +000061};
Benjamin Kramercfd8d902014-09-12 08:56:53 +000062} // end anonymous namespace
Duncan Sandsb8cee002012-03-13 11:42:19 +000063
64static Value *SimplifyAndInst(Value *, Value *, const Query &, unsigned);
65static Value *SimplifyBinOp(unsigned, Value *, Value *, const Query &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000066 unsigned);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +000067static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
68 const Query &, unsigned);
Duncan Sandsb8cee002012-03-13 11:42:19 +000069static Value *SimplifyCmpInst(unsigned, Value *, Value *, const Query &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000070 unsigned);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +000071static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
72 const Query &Q, unsigned MaxRecurse);
Duncan Sandsb8cee002012-03-13 11:42:19 +000073static Value *SimplifyOrInst(Value *, Value *, const Query &, unsigned);
74static Value *SimplifyXorInst(Value *, Value *, const Query &, unsigned);
David Majnemer6774d612016-07-26 17:58:05 +000075static Value *SimplifyCastInst(unsigned, Value *, Type *,
76 const Query &, unsigned);
Duncan Sands5ffc2982010-11-16 12:16:38 +000077
Sanjay Patel35ed2412017-04-16 17:43:11 +000078/// For a boolean type or a vector of boolean type, return false or a vector
79/// with every element false.
Duncan Sandsc1c92712011-07-26 15:03:53 +000080static Constant *getFalse(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +000081 return ConstantInt::getFalse(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +000082}
83
Sanjay Patel35ed2412017-04-16 17:43:11 +000084/// For a boolean type or a vector of boolean type, return true or a vector
85/// with every element true.
Duncan Sandsc1c92712011-07-26 15:03:53 +000086static Constant *getTrue(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +000087 return ConstantInt::getTrue(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +000088}
89
Duncan Sands3d5692a2011-10-30 19:56:36 +000090/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
91static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
92 Value *RHS) {
93 CmpInst *Cmp = dyn_cast<CmpInst>(V);
94 if (!Cmp)
95 return false;
96 CmpInst::Predicate CPred = Cmp->getPredicate();
97 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
98 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
99 return true;
100 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
101 CRHS == LHS;
102}
103
Sanjay Patel472cc782016-01-11 22:14:42 +0000104/// Does the given value dominate the specified phi node?
Duncan Sands5ffc2982010-11-16 12:16:38 +0000105static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
106 Instruction *I = dyn_cast<Instruction>(V);
107 if (!I)
108 // Arguments and constants dominate all instructions.
109 return true;
110
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000111 // If we are processing instructions (and/or basic blocks) that have not been
112 // fully added to a function, the parent nodes may still be null. Simply
113 // return the conservative answer in these cases.
114 if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
115 return false;
116
Duncan Sands5ffc2982010-11-16 12:16:38 +0000117 // If we have a DominatorTree then do a precise test.
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000118 if (DT) {
119 if (!DT->isReachableFromEntry(P->getParent()))
120 return true;
121 if (!DT->isReachableFromEntry(I->getParent()))
122 return false;
123 return DT->dominates(I, P);
124 }
Duncan Sands5ffc2982010-11-16 12:16:38 +0000125
David Majnemer8a1c45d2015-12-12 05:38:55 +0000126 // Otherwise, if the instruction is in the entry block and is not an invoke,
127 // then it obviously dominates all phi nodes.
Duncan Sands5ffc2982010-11-16 12:16:38 +0000128 if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000129 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000130 return true;
131
132 return false;
133}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000134
Sanjay Patel472cc782016-01-11 22:14:42 +0000135/// Simplify "A op (B op' C)" by distributing op over op', turning it into
136/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000137/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
138/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
139/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000140static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
141 Instruction::BinaryOps OpcodeToExpand, const Query &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +0000142 unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000143 // Recursion is always used, so bail out at once if we already hit the limit.
144 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000145 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000146
147 // Check whether the expression has the form "(A op' B) op C".
148 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
149 if (Op0->getOpcode() == OpcodeToExpand) {
150 // It does! Try turning it into "(A op C) op' (B op C)".
151 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
152 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000153 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
154 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000155 // They do! Return "L op' R" if it simplifies or is already available.
156 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000157 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
158 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000159 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000160 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000161 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000162 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000163 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000164 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000165 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000166 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000167 }
168 }
169
170 // Check whether the expression has the form "A op (B op' C)".
171 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
172 if (Op1->getOpcode() == OpcodeToExpand) {
173 // It does! Try turning it into "(A op B) op' (A op C)".
174 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
175 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000176 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
177 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000178 // They do! Return "L op' R" if it simplifies or is already available.
179 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000180 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
181 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000182 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000183 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000184 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000185 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000186 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000187 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000188 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000189 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000190 }
191 }
192
Craig Topper9f008862014-04-15 04:59:12 +0000193 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000194}
195
Sanjay Patel472cc782016-01-11 22:14:42 +0000196/// Generic simplifications for associative binary operations.
197/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000198static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
199 Value *LHS, Value *RHS, const Query &Q,
200 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000201 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
202
203 // Recursion is always used, so bail out at once if we already hit the limit.
204 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000205 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000206
207 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
208 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
209
210 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
211 if (Op0 && Op0->getOpcode() == Opcode) {
212 Value *A = Op0->getOperand(0);
213 Value *B = Op0->getOperand(1);
214 Value *C = RHS;
215
216 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000217 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000218 // It does! Return "A op V" if it simplifies or is already available.
219 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000220 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000221 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000222 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000223 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000224 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000225 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000226 }
227 }
228
229 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
230 if (Op1 && Op1->getOpcode() == Opcode) {
231 Value *A = LHS;
232 Value *B = Op1->getOperand(0);
233 Value *C = Op1->getOperand(1);
234
235 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000236 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000237 // It does! Return "V op C" if it simplifies or is already available.
238 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000239 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000240 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000241 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000242 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000243 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000244 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000245 }
246 }
247
248 // The remaining transforms require commutativity as well as associativity.
249 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000250 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000251
252 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
253 if (Op0 && Op0->getOpcode() == Opcode) {
254 Value *A = Op0->getOperand(0);
255 Value *B = Op0->getOperand(1);
256 Value *C = RHS;
257
258 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000259 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000260 // It does! Return "V op B" if it simplifies or is already available.
261 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000262 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000263 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000264 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000265 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000266 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000267 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000268 }
269 }
270
271 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
272 if (Op1 && Op1->getOpcode() == Opcode) {
273 Value *A = LHS;
274 Value *B = Op1->getOperand(0);
275 Value *C = Op1->getOperand(1);
276
277 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000278 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000279 // It does! Return "B op V" if it simplifies or is already available.
280 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000281 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000282 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000283 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000284 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000285 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000286 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000287 }
288 }
289
Craig Topper9f008862014-04-15 04:59:12 +0000290 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000291}
292
Sanjay Patel472cc782016-01-11 22:14:42 +0000293/// In the case of a binary operation with a select instruction as an operand,
294/// try to simplify the binop by seeing whether evaluating it on both branches
295/// of the select results in the same value. Returns the common value if so,
296/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000297static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
298 Value *RHS, const Query &Q,
299 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000300 // Recursion is always used, so bail out at once if we already hit the limit.
301 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000302 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000303
Duncan Sandsb0579e92010-11-10 13:00:08 +0000304 SelectInst *SI;
305 if (isa<SelectInst>(LHS)) {
306 SI = cast<SelectInst>(LHS);
307 } else {
308 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
309 SI = cast<SelectInst>(RHS);
310 }
311
312 // Evaluate the BinOp on the true and false branches of the select.
313 Value *TV;
314 Value *FV;
315 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000316 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
317 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000318 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000319 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
320 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000321 }
322
Duncan Sandse3c53952011-01-01 16:12:09 +0000323 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000324 // If they both failed to simplify then return null.
325 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000326 return TV;
327
328 // If one branch simplified to undef, return the other one.
329 if (TV && isa<UndefValue>(TV))
330 return FV;
331 if (FV && isa<UndefValue>(FV))
332 return TV;
333
334 // If applying the operation did not change the true and false select values,
335 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000336 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000337 return SI;
338
339 // If one branch simplified and the other did not, and the simplified
340 // value is equal to the unsimplified one, return the simplified value.
341 // For example, select (cond, X, X & Z) & Z -> X & Z.
342 if ((FV && !TV) || (TV && !FV)) {
343 // Check that the simplified value has the form "X op Y" where "op" is the
344 // same as the original operation.
345 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
346 if (Simplified && Simplified->getOpcode() == Opcode) {
347 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
348 // We already know that "op" is the same as for the simplified value. See
349 // if the operands match too. If so, return the simplified value.
350 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
351 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
352 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000353 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
354 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000355 return Simplified;
356 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000357 Simplified->getOperand(1) == UnsimplifiedLHS &&
358 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000359 return Simplified;
360 }
361 }
362
Craig Topper9f008862014-04-15 04:59:12 +0000363 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000364}
365
Sanjay Patel472cc782016-01-11 22:14:42 +0000366/// In the case of a comparison with a select instruction, try to simplify the
367/// comparison by seeing whether both branches of the select result in the same
368/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000369static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000370 Value *RHS, const Query &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000371 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000372 // Recursion is always used, so bail out at once if we already hit the limit.
373 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000374 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000375
Duncan Sandsb0579e92010-11-10 13:00:08 +0000376 // Make sure the select is on the LHS.
377 if (!isa<SelectInst>(LHS)) {
378 std::swap(LHS, RHS);
379 Pred = CmpInst::getSwappedPredicate(Pred);
380 }
381 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
382 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000383 Value *Cond = SI->getCondition();
384 Value *TV = SI->getTrueValue();
385 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000386
Duncan Sands06504022011-02-03 09:37:39 +0000387 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000388 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000389 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000390 if (TCmp == Cond) {
391 // It not only simplified, it simplified to the select condition. Replace
392 // it with 'true'.
393 TCmp = getTrue(Cond->getType());
394 } else if (!TCmp) {
395 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
396 // condition then we can replace it with 'true'. Otherwise give up.
397 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000398 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000399 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000400 }
401
Duncan Sands3d5692a2011-10-30 19:56:36 +0000402 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000403 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000404 if (FCmp == Cond) {
405 // It not only simplified, it simplified to the select condition. Replace
406 // it with 'false'.
407 FCmp = getFalse(Cond->getType());
408 } else if (!FCmp) {
409 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
410 // condition then we can replace it with 'false'. Otherwise give up.
411 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000412 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000413 FCmp = getFalse(Cond->getType());
414 }
415
416 // If both sides simplified to the same value, then use it as the result of
417 // the original comparison.
418 if (TCmp == FCmp)
419 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000420
421 // The remaining cases only make sense if the select condition has the same
422 // type as the result of the comparison, so bail out if this is not so.
423 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000424 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000425 // If the false value simplified to false, then the result of the compare
426 // is equal to "Cond && TCmp". This also catches the case when the false
427 // value simplified to false and the true value to true, returning "Cond".
428 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000429 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000430 return V;
431 // If the true value simplified to true, then the result of the compare
432 // is equal to "Cond || FCmp".
433 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000434 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000435 return V;
436 // Finally, if the false value simplified to true and the true value to
437 // false, then the result of the compare is equal to "!Cond".
438 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
439 if (Value *V =
440 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000441 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000442 return V;
443
Craig Topper9f008862014-04-15 04:59:12 +0000444 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000445}
446
Sanjay Patel472cc782016-01-11 22:14:42 +0000447/// In the case of a binary operation with an operand that is a PHI instruction,
448/// try to simplify the binop by seeing whether evaluating it on the incoming
449/// phi values yields the same result for every value. If so returns the common
450/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000451static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
452 Value *RHS, const Query &Q,
453 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000454 // Recursion is always used, so bail out at once if we already hit the limit.
455 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000456 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000457
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000458 PHINode *PI;
459 if (isa<PHINode>(LHS)) {
460 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000461 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000462 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000463 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000464 } else {
465 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
466 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000467 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000468 if (!ValueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000469 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000470 }
471
472 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000473 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000474 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000475 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000476 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000477 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000478 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
479 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000480 // If the operation failed to simplify, or simplified to a different value
481 // to previously, then give up.
482 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000483 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000484 CommonValue = V;
485 }
486
487 return CommonValue;
488}
489
Sanjay Patel472cc782016-01-11 22:14:42 +0000490/// In the case of a comparison with a PHI instruction, try to simplify the
491/// comparison by seeing whether comparing with all of the incoming phi values
492/// yields the same result every time. If so returns the common result,
493/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000494static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000495 const Query &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000496 // Recursion is always used, so bail out at once if we already hit the limit.
497 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000498 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000499
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000500 // Make sure the phi is on the LHS.
501 if (!isa<PHINode>(LHS)) {
502 std::swap(LHS, RHS);
503 Pred = CmpInst::getSwappedPredicate(Pred);
504 }
505 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
506 PHINode *PI = cast<PHINode>(LHS);
507
Duncan Sands5ffc2982010-11-16 12:16:38 +0000508 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000509 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000510 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000511
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000512 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000513 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000514 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000515 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000516 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000517 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000518 // If the operation failed to simplify, or simplified to a different value
519 // to previously, then give up.
520 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000521 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000522 CommonValue = V;
523 }
524
525 return CommonValue;
526}
527
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000528static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
529 Value *&Op0, Value *&Op1,
530 const Query &Q) {
531 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
532 if (auto *CRHS = dyn_cast<Constant>(Op1))
533 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
534
535 // Canonicalize the constant to the RHS if this is a commutative operation.
536 if (Instruction::isCommutative(Opcode))
537 std::swap(Op0, Op1);
538 }
539 return nullptr;
540}
541
Sanjay Patel472cc782016-01-11 22:14:42 +0000542/// Given operands for an Add, see if we can fold the result.
543/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000544static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000545 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000546 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
547 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000548
Duncan Sands0a2c41682010-12-15 14:07:39 +0000549 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000550 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000551 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000552
Duncan Sands0a2c41682010-12-15 14:07:39 +0000553 // X + 0 -> X
554 if (match(Op1, m_Zero()))
555 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000556
Duncan Sands0a2c41682010-12-15 14:07:39 +0000557 // X + (Y - X) -> Y
558 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000559 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000560 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000561 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
562 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000563 return Y;
564
565 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000566 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000567 if (match(Op0, m_Not(m_Specific(Op1))) ||
568 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000569 return Constant::getAllOnesValue(Ty);
570
571 // add nsw/nuw (xor Y, signbit), signbit --> Y
572 // The no-wrapping add guarantees that the top bit will be set by the add.
573 // Therefore, the xor must be clearing the already set sign bit of Y.
Craig Topper3a40a392017-03-30 22:21:16 +0000574 if ((isNSW || isNUW) && match(Op1, m_SignBit()) &&
575 match(Op0, m_Xor(m_Value(Y), m_SignBit())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000576 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000577
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000578 /// i1 add -> xor.
Craig Topperaa5f5242017-04-06 05:28:41 +0000579 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000580 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000581 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000582
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000583 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000584 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000585 MaxRecurse))
586 return V;
587
Duncan Sandsb238de02010-11-19 09:20:39 +0000588 // Threading Add over selects and phi nodes is pointless, so don't bother.
589 // Threading over the select in "A + select(cond, B, C)" means evaluating
590 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
591 // only if B and C are equal. If B and C are equal then (since we assume
592 // that operands have already been simplified) "select(cond, B, C)" should
593 // have been simplified to the common value of B and C already. Analysing
594 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
595 // for threading over phi nodes.
596
Craig Topper9f008862014-04-15 04:59:12 +0000597 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000598}
599
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000600Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000601 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000602 const DominatorTree *DT, AssumptionCache *AC,
603 const Instruction *CxtI) {
604 return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, Query(DL, TLI, DT, AC, CxtI),
Chandler Carruth66b31302015-01-04 12:03:27 +0000605 RecursionLimit);
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000606}
607
Chandler Carrutha0796552012-03-12 11:19:31 +0000608/// \brief Compute the base pointer and cumulative constant offsets for V.
609///
610/// This strips all constant offsets off of V, leaving it the base pointer, and
611/// accumulates the total constant offset applied in the returned constant. It
612/// returns 0 if V is not a pointer, and returns the constant '0' if there are
613/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000614///
615/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
616/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
617/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000618static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000619 bool AllowNonInbounds = false) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000620 assert(V->getType()->getScalarType()->isPointerTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000621
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000622 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000623 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000624
625 // Even though we don't look through PHI nodes, we could be called on an
626 // instruction in an unreachable block, which may be on a cycle.
627 SmallPtrSet<Value *, 4> Visited;
628 Visited.insert(V);
629 do {
630 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000631 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000632 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000633 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000634 V = GEP->getPointerOperand();
635 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000636 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000637 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000638 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000639 break;
640 V = GA->getAliasee();
641 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000642 if (auto CS = CallSite(V))
643 if (Value *RV = CS.getReturnedArgOperand()) {
644 V = RV;
645 continue;
646 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000647 break;
648 }
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000649 assert(V->getType()->getScalarType()->isPointerTy() &&
650 "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000651 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000652
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000653 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
654 if (V->getType()->isVectorTy())
655 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
656 OffsetIntPtr);
657 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000658}
659
660/// \brief Compute the constant difference between two pointer values.
661/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000662static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
663 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000664 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
665 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000666
667 // If LHS and RHS are not related via constant offsets to the same base
668 // value, there is nothing we can do here.
669 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000670 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000671
672 // Otherwise, the difference of LHS - RHS can be computed as:
673 // LHS - RHS
674 // = (LHSOffset + Base) - (RHSOffset + Base)
675 // = LHSOffset - RHSOffset
676 return ConstantExpr::getSub(LHSOffset, RHSOffset);
677}
678
Sanjay Patel472cc782016-01-11 22:14:42 +0000679/// Given operands for a Sub, see if we can fold the result.
680/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000681static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000682 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000683 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
684 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000685
686 // X - undef -> undef
687 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000688 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000689 return UndefValue::get(Op0->getType());
690
691 // X - 0 -> X
692 if (match(Op1, m_Zero()))
693 return Op0;
694
695 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000696 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000697 return Constant::getNullValue(Op0->getType());
698
Sanjay Patelefd88852016-10-19 21:23:45 +0000699 // Is this a negation?
700 if (match(Op0, m_Zero())) {
701 // 0 - X -> 0 if the sub is NUW.
702 if (isNUW)
703 return Op0;
704
705 unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
706 APInt KnownZero(BitWidth, 0);
707 APInt KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000708 computeKnownBits(Op1, KnownZero, KnownOne, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topper6856d342017-03-30 22:10:54 +0000709 if (KnownZero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000710 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
711 // Op1 must be 0 because negating the minimum signed value is undefined.
712 if (isNSW)
713 return Op0;
714
715 // 0 - X -> X if X is 0 or the minimum signed value.
716 return Op1;
717 }
718 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000719
Duncan Sands99589d02011-01-18 11:50:19 +0000720 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
721 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000722 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000723 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
724 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000725 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000726 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000727 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, 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 "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000735 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000736 // It does, we successfully reassociated!
737 ++NumReassoc;
738 return W;
739 }
740 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000741
Duncan Sands99589d02011-01-18 11:50:19 +0000742 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
743 // For example, X - (X + 1) -> -1
744 X = Op0;
745 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
746 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000747 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000748 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000749 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000750 // It does, we successfully reassociated!
751 ++NumReassoc;
752 return W;
753 }
754 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000755 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000756 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000757 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000758 // It does, we successfully reassociated!
759 ++NumReassoc;
760 return W;
761 }
762 }
763
764 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
765 // For example, X - (X - Y) -> Y.
766 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000767 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
768 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000769 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000770 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000771 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000772 // It does, we successfully reassociated!
773 ++NumReassoc;
774 return W;
775 }
776
Duncan Sands395ac42d2012-03-13 14:07:05 +0000777 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
778 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
779 match(Op1, m_Trunc(m_Value(Y))))
780 if (X->getType() == Y->getType())
781 // See if "V === X - Y" simplifies.
782 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
783 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000784 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
785 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000786 // It does, return the simplified "trunc V".
787 return W;
788
789 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000790 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000791 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000792 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000793 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
794
Duncan Sands99589d02011-01-18 11:50:19 +0000795 // i1 sub -> xor.
Craig Topperaa5f5242017-04-06 05:28:41 +0000796 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000797 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000798 return V;
799
Duncan Sands0a2c41682010-12-15 14:07:39 +0000800 // Threading Sub over selects and phi nodes is pointless, so don't bother.
801 // Threading over the select in "A - select(cond, B, C)" means evaluating
802 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
803 // only if B and C are equal. If B and C are equal then (since we assume
804 // that operands have already been simplified) "select(cond, B, C)" should
805 // have been simplified to the common value of B and C already. Analysing
806 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
807 // for threading over phi nodes.
808
Craig Topper9f008862014-04-15 04:59:12 +0000809 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000810}
811
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000812Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000813 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000814 const DominatorTree *DT, AssumptionCache *AC,
815 const Instruction *CxtI) {
816 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Query(DL, TLI, DT, AC, CxtI),
Chandler Carruth66b31302015-01-04 12:03:27 +0000817 RecursionLimit);
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000818}
819
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000820/// Given operands for an FAdd, see if we can fold the result. If not, this
821/// returns null.
822static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
823 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000824 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
825 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000826
827 // fadd X, -0 ==> X
828 if (match(Op1, m_NegZero()))
829 return Op0;
830
831 // fadd X, 0 ==> X, when we know X is not -0
832 if (match(Op1, m_Zero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000833 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000834 return Op0;
835
836 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
837 // where nnan and ninf have to occur at least once somewhere in this
838 // expression
Craig Topper9f008862014-04-15 04:59:12 +0000839 Value *SubOp = nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000840 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
841 SubOp = Op1;
842 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
843 SubOp = Op0;
844 if (SubOp) {
845 Instruction *FSub = cast<Instruction>(SubOp);
846 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
847 (FMF.noInfs() || FSub->hasNoInfs()))
848 return Constant::getNullValue(Op0->getType());
849 }
850
Craig Topper9f008862014-04-15 04:59:12 +0000851 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000852}
853
854/// Given operands for an FSub, see if we can fold the result. If not, this
855/// returns null.
856static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
857 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000858 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
859 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000860
861 // fsub X, 0 ==> X
862 if (match(Op1, m_Zero()))
863 return Op0;
864
865 // fsub X, -0 ==> X, when we know X is not -0
866 if (match(Op1, m_NegZero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000867 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000868 return Op0;
869
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000870 // fsub -0.0, (fsub -0.0, X) ==> X
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000871 Value *X;
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000872 if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
873 return X;
874
875 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Benjamin Kramer6bb15022016-02-29 12:18:25 +0000876 if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000877 match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
878 return X;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000879
Benjamin Kramer228680d2015-06-14 21:01:20 +0000880 // fsub nnan x, x ==> 0.0
881 if (FMF.noNaNs() && Op0 == Op1)
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000882 return Constant::getNullValue(Op0->getType());
883
Craig Topper9f008862014-04-15 04:59:12 +0000884 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000885}
886
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000887/// Given the operands for an FMul, see if we can fold the result
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000888static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
889 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000890 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
891 return C;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000892
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000893 // fmul X, 1.0 ==> X
894 if (match(Op1, m_FPOne()))
895 return Op0;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000896
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000897 // fmul nnan nsz X, 0 ==> 0
898 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
899 return Op1;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000900
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000901 return nullptr;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000902}
903
Sanjay Patel472cc782016-01-11 22:14:42 +0000904/// Given operands for a Mul, see if we can fold the result.
905/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000906static Value *SimplifyMulInst(Value *Op0, Value *Op1, const Query &Q,
907 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000908 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
909 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000910
911 // X * undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000912 if (match(Op1, m_Undef()))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000913 return Constant::getNullValue(Op0->getType());
914
915 // X * 0 -> 0
916 if (match(Op1, m_Zero()))
917 return Op1;
918
919 // X * 1 -> X
920 if (match(Op1, m_One()))
921 return Op0;
922
Duncan Sandsb67edc62011-01-30 18:03:50 +0000923 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000924 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000925 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
926 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
927 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000928
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000929 // i1 mul -> and.
Craig Topper2f1e1c32017-04-06 17:33:37 +0000930 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000931 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000932 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000933
934 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000935 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000936 MaxRecurse))
937 return V;
938
939 // Mul distributes over Add. Try some generic simplifications based on this.
940 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000941 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000942 return V;
943
944 // If the operation is with the result of a select instruction, check whether
945 // operating on either branch of the select always yields the same value.
946 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000947 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000948 MaxRecurse))
949 return V;
950
951 // If the operation is with the result of a phi instruction, check whether
952 // operating on all incoming values of the phi always yields the same value.
953 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000954 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000955 MaxRecurse))
956 return V;
957
Craig Topper9f008862014-04-15 04:59:12 +0000958 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000959}
960
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000961Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000962 const DataLayout &DL,
Chandler Carruth66b31302015-01-04 12:03:27 +0000963 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000964 const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth66b31302015-01-04 12:03:27 +0000965 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000966 return ::SimplifyFAddInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000967 RecursionLimit);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000968}
969
970Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000971 const DataLayout &DL,
Chandler Carruth66b31302015-01-04 12:03:27 +0000972 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000973 const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth66b31302015-01-04 12:03:27 +0000974 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000975 return ::SimplifyFSubInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000976 RecursionLimit);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000977}
978
Chandler Carruth66b31302015-01-04 12:03:27 +0000979Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000980 const DataLayout &DL,
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000981 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000982 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +0000983 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000984 return ::SimplifyFMulInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000985 RecursionLimit);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000986}
987
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000988Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +0000989 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000990 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +0000991 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000992 return ::SimplifyMulInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000993 RecursionLimit);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000994}
995
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000996/// Check for common or similar folds of integer division or integer remainder.
997static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
998 Type *Ty = Op0->getType();
999
1000 // X / undef -> undef
1001 // X % undef -> undef
1002 if (match(Op1, m_Undef()))
1003 return Op1;
1004
1005 // X / 0 -> undef
1006 // X % 0 -> undef
1007 // We don't need to preserve faults!
1008 if (match(Op1, m_Zero()))
1009 return UndefValue::get(Ty);
1010
Sanjay Patel2b1f6f42017-03-09 16:20:52 +00001011 // If any element of a constant divisor vector is zero, the whole op is undef.
1012 auto *Op1C = dyn_cast<Constant>(Op1);
1013 if (Op1C && Ty->isVectorTy()) {
1014 unsigned NumElts = Ty->getVectorNumElements();
1015 for (unsigned i = 0; i != NumElts; ++i) {
1016 Constant *Elt = Op1C->getAggregateElement(i);
1017 if (Elt && Elt->isNullValue())
1018 return UndefValue::get(Ty);
1019 }
1020 }
1021
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001022 // undef / X -> 0
1023 // undef % X -> 0
1024 if (match(Op0, m_Undef()))
1025 return Constant::getNullValue(Ty);
1026
1027 // 0 / X -> 0
1028 // 0 % X -> 0
1029 if (match(Op0, m_Zero()))
1030 return Op0;
1031
1032 // X / X -> 1
1033 // X % X -> 0
1034 if (Op0 == Op1)
1035 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
1036
1037 // X / 1 -> X
1038 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +00001039 // If this is a boolean op (single-bit element type), we can't have
1040 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
1041 if (match(Op1, m_One()) || Ty->getScalarType()->isIntegerTy(1))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001042 return IsDiv ? Op0 : Constant::getNullValue(Ty);
1043
1044 return nullptr;
1045}
1046
Sanjay Patel472cc782016-01-11 22:14:42 +00001047/// Given operands for an SDiv or UDiv, see if we can fold the result.
1048/// If not, this returns null.
Anders Carlsson36c6d232011-02-05 18:33:43 +00001049static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001050 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001051 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1052 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001053
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001054 if (Value *V = simplifyDivRem(Op0, Op1, true))
1055 return V;
1056
Duncan Sands65995fa2011-01-28 18:50:50 +00001057 bool isSigned = Opcode == Instruction::SDiv;
1058
Duncan Sands771e82a2011-01-28 16:51:11 +00001059 // (X * Y) / Y -> X if the multiplication does not overflow.
Craig Topper9f008862014-04-15 04:59:12 +00001060 Value *X = nullptr, *Y = nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001061 if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1062 if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
Duncan Sands7cb61e52011-10-27 19:16:21 +00001063 OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
Duncan Sands5747aba2011-02-02 20:52:00 +00001064 // If the Mul knows it does not overflow, then we are good to go.
1065 if ((isSigned && Mul->hasNoSignedWrap()) ||
1066 (!isSigned && Mul->hasNoUnsignedWrap()))
1067 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001068 // If X has the form X = A / Y then X * Y cannot overflow.
1069 if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1070 if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1071 return X;
1072 }
1073
Duncan Sands65995fa2011-01-28 18:50:50 +00001074 // (X rem Y) / Y -> 0
1075 if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1076 (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1077 return Constant::getNullValue(Op0->getType());
1078
David Majnemercb9d5962014-10-11 10:20:01 +00001079 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1080 ConstantInt *C1, *C2;
1081 if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1082 match(Op1, m_ConstantInt(C2))) {
1083 bool Overflow;
1084 C1->getValue().umul_ov(C2->getValue(), Overflow);
1085 if (Overflow)
1086 return Constant::getNullValue(Op0->getType());
1087 }
1088
Duncan Sands65995fa2011-01-28 18:50:50 +00001089 // If the operation is with the result of a select instruction, check whether
1090 // operating on either branch of the select always yields the same value.
1091 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001092 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001093 return V;
1094
1095 // If the operation is with the result of a phi instruction, check whether
1096 // operating on all incoming values of the phi always yields the same value.
1097 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001098 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001099 return V;
1100
Craig Topper9f008862014-04-15 04:59:12 +00001101 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001102}
1103
Sanjay Patel472cc782016-01-11 22:14:42 +00001104/// Given operands for an SDiv, see if we can fold the result.
1105/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001106static Value *SimplifySDivInst(Value *Op0, Value *Op1, const Query &Q,
1107 unsigned MaxRecurse) {
1108 if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001109 return V;
1110
Craig Topper9f008862014-04-15 04:59:12 +00001111 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001112}
1113
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001114Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001115 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001116 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001117 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001118 return ::SimplifySDivInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001119 RecursionLimit);
Duncan Sands771e82a2011-01-28 16:51:11 +00001120}
1121
Sanjay Patel472cc782016-01-11 22:14:42 +00001122/// Given operands for a UDiv, see if we can fold the result.
1123/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001124static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const Query &Q,
1125 unsigned MaxRecurse) {
1126 if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001127 return V;
1128
David Majnemer63da0c22017-01-06 22:58:02 +00001129 // udiv %V, C -> 0 if %V < C
1130 if (MaxRecurse) {
1131 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1132 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1133 if (C->isAllOnesValue()) {
1134 return Constant::getNullValue(Op0->getType());
1135 }
1136 }
1137 }
1138
Craig Topper9f008862014-04-15 04:59:12 +00001139 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001140}
1141
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001142Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001143 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001144 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001145 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001146 return ::SimplifyUDivInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001147 RecursionLimit);
Duncan Sands771e82a2011-01-28 16:51:11 +00001148}
1149
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001150static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
1151 const Query &Q, unsigned) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001152 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
1153 return C;
1154
Frits van Bommelc2549662011-01-29 15:26:31 +00001155 // undef / X -> undef (the undef could be a snan).
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001156 if (match(Op0, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001157 return Op0;
1158
1159 // X / undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001160 if (match(Op1, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001161 return Op1;
1162
Zia Ansari394cef82016-12-08 23:27:40 +00001163 // X / 1.0 -> X
1164 if (match(Op1, m_FPOne()))
1165 return Op0;
1166
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001167 // 0 / X -> 0
1168 // Requires that NaNs are off (X could be zero) and signed zeroes are
1169 // ignored (X could be positive or negative, so the output sign is unknown).
1170 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1171 return Op0;
1172
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001173 if (FMF.noNaNs()) {
1174 // X / X -> 1.0 is legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001175 if (Op0 == Op1)
1176 return ConstantFP::get(Op0->getType(), 1.0);
1177
1178 // -X / X -> -1.0 and
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001179 // X / -X -> -1.0 are legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001180 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
1181 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
1182 BinaryOperator::getFNegArgument(Op0) == Op1) ||
1183 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
1184 BinaryOperator::getFNegArgument(Op1) == Op0))
1185 return ConstantFP::get(Op0->getType(), -1.0);
1186 }
1187
Craig Topper9f008862014-04-15 04:59:12 +00001188 return nullptr;
Frits van Bommelc2549662011-01-29 15:26:31 +00001189}
1190
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001191Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001192 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001193 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001194 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001195 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001196 return ::SimplifyFDivInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001197 RecursionLimit);
Frits van Bommelc2549662011-01-29 15:26:31 +00001198}
1199
Sanjay Patel472cc782016-01-11 22:14:42 +00001200/// Given operands for an SRem or URem, see if we can fold the result.
1201/// If not, this returns null.
Duncan Sandsa3e36992011-05-02 16:27:02 +00001202static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001203 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001204 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1205 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001206
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001207 if (Value *V = simplifyDivRem(Op0, Op1, false))
1208 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001209
David Majnemerb435a422014-09-17 04:16:35 +00001210 // (X % Y) % Y -> X % Y
1211 if ((Opcode == Instruction::SRem &&
1212 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1213 (Opcode == Instruction::URem &&
1214 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001215 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001216
Duncan Sandsa3e36992011-05-02 16:27:02 +00001217 // If the operation is with the result of a select instruction, check whether
1218 // operating on either branch of the select always yields the same value.
1219 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001220 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001221 return V;
1222
1223 // If the operation is with the result of a phi instruction, check whether
1224 // operating on all incoming values of the phi always yields the same value.
1225 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001226 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001227 return V;
1228
Craig Topper9f008862014-04-15 04:59:12 +00001229 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001230}
1231
Sanjay Patel472cc782016-01-11 22:14:42 +00001232/// Given operands for an SRem, see if we can fold the result.
1233/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001234static Value *SimplifySRemInst(Value *Op0, Value *Op1, const Query &Q,
1235 unsigned MaxRecurse) {
1236 if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001237 return V;
1238
Craig Topper9f008862014-04-15 04:59:12 +00001239 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001240}
1241
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001242Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001243 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001244 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001245 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001246 return ::SimplifySRemInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001247 RecursionLimit);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001248}
1249
Sanjay Patel472cc782016-01-11 22:14:42 +00001250/// Given operands for a URem, see if we can fold the result.
1251/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001252static Value *SimplifyURemInst(Value *Op0, Value *Op1, const Query &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001253 unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001254 if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001255 return V;
1256
David Majnemer8c0e62f2017-01-06 21:23:51 +00001257 // urem %V, C -> %V if %V < C
1258 if (MaxRecurse) {
1259 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1260 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1261 if (C->isAllOnesValue()) {
1262 return Op0;
1263 }
1264 }
1265 }
1266
Craig Topper9f008862014-04-15 04:59:12 +00001267 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001268}
1269
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001270Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001271 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001272 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001273 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001274 return ::SimplifyURemInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001275 RecursionLimit);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001276}
1277
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001278static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001279 const Query &Q, unsigned) {
1280 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
1281 return C;
1282
Duncan Sandsa3e36992011-05-02 16:27:02 +00001283 // undef % X -> undef (the undef could be a snan).
1284 if (match(Op0, m_Undef()))
1285 return Op0;
1286
1287 // X % undef -> undef
1288 if (match(Op1, m_Undef()))
1289 return Op1;
1290
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001291 // 0 % X -> 0
1292 // Requires that NaNs are off (X could be zero) and signed zeroes are
1293 // ignored (X could be positive or negative, so the output sign is unknown).
1294 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1295 return Op0;
1296
Craig Topper9f008862014-04-15 04:59:12 +00001297 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001298}
1299
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001300Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001301 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001302 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001303 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001304 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001305 return ::SimplifyFRemInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001306 RecursionLimit);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001307}
1308
Sanjay Patel472cc782016-01-11 22:14:42 +00001309/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001310static bool isUndefShift(Value *Amount) {
1311 Constant *C = dyn_cast<Constant>(Amount);
1312 if (!C)
1313 return false;
1314
1315 // X shift by undef -> undef because it may shift by the bitwidth.
1316 if (isa<UndefValue>(C))
1317 return true;
1318
1319 // Shifting by the bitwidth or more is undefined.
1320 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1321 if (CI->getValue().getLimitedValue() >=
1322 CI->getType()->getScalarSizeInBits())
1323 return true;
1324
1325 // If all lanes of a vector shift are undefined the whole shift is.
1326 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1327 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1328 if (!isUndefShift(C->getAggregateElement(I)))
1329 return false;
1330 return true;
1331 }
1332
1333 return false;
1334}
1335
Sanjay Patel472cc782016-01-11 22:14:42 +00001336/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1337/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001338static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
1339 Value *Op1, const Query &Q, unsigned MaxRecurse) {
1340 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1341 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001342
Duncan Sands571fd9a2011-01-14 14:44:12 +00001343 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001344 if (match(Op0, m_Zero()))
1345 return Op0;
1346
Duncan Sands571fd9a2011-01-14 14:44:12 +00001347 // X shift by 0 -> X
Duncan Sands7f60dc12011-01-14 00:37:45 +00001348 if (match(Op1, m_Zero()))
1349 return Op0;
1350
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001351 // Fold undefined shifts.
1352 if (isUndefShift(Op1))
1353 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001354
Duncan Sands571fd9a2011-01-14 14:44:12 +00001355 // If the operation is with the result of a select instruction, check whether
1356 // operating on either branch of the select always yields the same value.
1357 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001358 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001359 return V;
1360
1361 // If the operation is with the result of a phi instruction, check whether
1362 // operating on all incoming values of the phi always yields the same value.
1363 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001364 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001365 return V;
1366
Sanjay Patel6786bc52016-05-10 20:46:54 +00001367 // If any bits in the shift amount make that value greater than or equal to
1368 // the number of bits in the type, the shift is undefined.
1369 unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
1370 APInt KnownZero(BitWidth, 0);
1371 APInt KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001372 computeKnownBits(Op1, KnownZero, KnownOne, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Sanjay Patel6786bc52016-05-10 20:46:54 +00001373 if (KnownOne.getLimitedValue() >= BitWidth)
1374 return UndefValue::get(Op0->getType());
1375
1376 // If all valid bits in the shift amount are known zero, the first operand is
1377 // unchanged.
1378 unsigned NumValidShiftBits = Log2_32_Ceil(BitWidth);
1379 APInt ShiftAmountMask = APInt::getLowBitsSet(BitWidth, NumValidShiftBits);
1380 if ((KnownZero & ShiftAmountMask) == ShiftAmountMask)
1381 return Op0;
1382
Craig Topper9f008862014-04-15 04:59:12 +00001383 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001384}
1385
David Majnemerbf7550e2014-11-05 00:59:59 +00001386/// \brief Given operands for an Shl, LShr or AShr, see if we can
1387/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001388static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
1389 Value *Op1, bool isExact, const Query &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001390 unsigned MaxRecurse) {
1391 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1392 return V;
1393
1394 // X >> X -> 0
1395 if (Op0 == Op1)
1396 return Constant::getNullValue(Op0->getType());
1397
David Majnemer65c52ae2014-12-17 01:54:33 +00001398 // undef >> X -> 0
1399 // undef >> X -> undef (if it's exact)
1400 if (match(Op0, m_Undef()))
1401 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1402
David Majnemerbf7550e2014-11-05 00:59:59 +00001403 // The low bit cannot be shifted out of an exact shift if it is set.
1404 if (isExact) {
1405 unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
1406 APInt Op0KnownZero(BitWidth, 0);
1407 APInt Op0KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001408 computeKnownBits(Op0, Op0KnownZero, Op0KnownOne, Q.DL, /*Depth=*/0, Q.AC,
1409 Q.CxtI, Q.DT);
David Majnemerbf7550e2014-11-05 00:59:59 +00001410 if (Op0KnownOne[0])
1411 return Op0;
1412 }
1413
1414 return nullptr;
1415}
1416
Sanjay Patel472cc782016-01-11 22:14:42 +00001417/// Given operands for an Shl, see if we can fold the result.
1418/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001419static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001420 const Query &Q, unsigned MaxRecurse) {
1421 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001422 return V;
1423
1424 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001425 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001426 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001427 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001428
Chris Lattner9e4aa022011-02-09 17:15:04 +00001429 // (X >> A) << A -> X
1430 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001431 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001432 return X;
Craig Topper9f008862014-04-15 04:59:12 +00001433 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001434}
1435
Chris Lattner9e4aa022011-02-09 17:15:04 +00001436Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001437 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001438 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001439 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001440 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00001441 RecursionLimit);
Duncan Sands7f60dc12011-01-14 00:37:45 +00001442}
1443
Sanjay Patel472cc782016-01-11 22:14:42 +00001444/// Given operands for an LShr, see if we can fold the result.
1445/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001446static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001447 const Query &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001448 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1449 MaxRecurse))
1450 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001451
Chris Lattner9e4aa022011-02-09 17:15:04 +00001452 // (X << A) >> A -> X
1453 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001454 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001455 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001456
Craig Topper9f008862014-04-15 04:59:12 +00001457 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001458}
1459
Chris Lattner9e4aa022011-02-09 17:15:04 +00001460Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001461 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001462 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001463 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001464 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001465 return ::SimplifyLShrInst(Op0, Op1, isExact, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00001466 RecursionLimit);
Duncan Sands7f60dc12011-01-14 00:37:45 +00001467}
1468
Sanjay Patel472cc782016-01-11 22:14:42 +00001469/// Given operands for an AShr, see if we can fold the result.
1470/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001471static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001472 const Query &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001473 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1474 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001475 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001476
1477 // all ones >>a X -> all ones
1478 if (match(Op0, m_AllOnes()))
1479 return Op0;
1480
Chris Lattner9e4aa022011-02-09 17:15:04 +00001481 // (X << A) >> A -> X
1482 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001483 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001484 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001485
Suyog Sarda68862412014-07-17 06:28:15 +00001486 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001487 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001488 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1489 return Op0;
1490
Craig Topper9f008862014-04-15 04:59:12 +00001491 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001492}
1493
Chris Lattner9e4aa022011-02-09 17:15:04 +00001494Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001495 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001496 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001497 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001498 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001499 return ::SimplifyAShrInst(Op0, Op1, isExact, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00001500 RecursionLimit);
Duncan Sands7f60dc12011-01-14 00:37:45 +00001501}
1502
David Majnemer1af36e52014-12-06 10:51:40 +00001503static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1504 ICmpInst *UnsignedICmp, bool IsAnd) {
1505 Value *X, *Y;
1506
1507 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001508 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1509 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001510 return nullptr;
1511
1512 ICmpInst::Predicate UnsignedPred;
1513 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1514 ICmpInst::isUnsigned(UnsignedPred))
1515 ;
1516 else if (match(UnsignedICmp,
1517 m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1518 ICmpInst::isUnsigned(UnsignedPred))
1519 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1520 else
1521 return nullptr;
1522
1523 // X < Y && Y != 0 --> X < Y
1524 // X < Y || Y != 0 --> Y != 0
1525 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1526 return IsAnd ? UnsignedICmp : ZeroICmp;
1527
1528 // X >= Y || Y != 0 --> true
1529 // X >= Y || Y == 0 --> X >= Y
1530 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1531 if (EqPred == ICmpInst::ICMP_NE)
1532 return getTrue(UnsignedICmp->getType());
1533 return UnsignedICmp;
1534 }
1535
David Majnemerd5b3aa42014-12-08 18:30:43 +00001536 // X < Y && Y == 0 --> false
1537 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1538 IsAnd)
1539 return getFalse(UnsignedICmp->getType());
1540
David Majnemer1af36e52014-12-06 10:51:40 +00001541 return nullptr;
1542}
1543
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001544/// Commuted variants are assumed to be handled by calling this function again
1545/// with the parameters swapped.
1546static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1547 ICmpInst::Predicate Pred0, Pred1;
1548 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001549 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1550 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001551 return nullptr;
1552
1553 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1554 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1555 // can eliminate Op1 from this 'and'.
1556 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1557 return Op0;
1558
1559 // Check for any combination of predicates that are guaranteed to be disjoint.
1560 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1561 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1562 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1563 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1564 return getFalse(Op0->getType());
1565
1566 return nullptr;
1567}
1568
1569/// Commuted variants are assumed to be handled by calling this function again
1570/// with the parameters swapped.
David Majnemera315bd82014-09-15 08:15:28 +00001571static Value *SimplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
David Majnemer1af36e52014-12-06 10:51:40 +00001572 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1573 return X;
1574
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001575 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1576 return X;
1577
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001578 // Look for this pattern: (icmp V, C0) & (icmp V, C1)).
Sanjay Patelb2332e12016-09-20 14:36:14 +00001579 Type *ITy = Op0->getType();
1580 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001581 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001582 Value *V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001583 if (match(Op0, m_ICmp(Pred0, m_Value(V), m_APInt(C0))) &&
1584 match(Op1, m_ICmp(Pred1, m_Specific(V), m_APInt(C1)))) {
1585 // Make a constant range that's the intersection of the two icmp ranges.
1586 // If the intersection is empty, we know that the result is false.
1587 auto Range0 = ConstantRange::makeAllowedICmpRegion(Pred0, *C0);
1588 auto Range1 = ConstantRange::makeAllowedICmpRegion(Pred1, *C1);
1589 if (Range0.intersectWith(Range1).isEmptySet())
1590 return getFalse(ITy);
1591 }
1592
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001593 // (icmp (add V, C0), C1) & (icmp V, C0)
1594 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001595 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001596
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001597 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001598 return nullptr;
1599
David Majnemera315bd82014-09-15 08:15:28 +00001600 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001601 if (AddInst->getOperand(1) != Op1->getOperand(1))
1602 return nullptr;
1603
David Majnemera315bd82014-09-15 08:15:28 +00001604 bool isNSW = AddInst->hasNoSignedWrap();
1605 bool isNUW = AddInst->hasNoUnsignedWrap();
1606
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001607 const APInt Delta = *C1 - *C0;
1608 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001609 if (Delta == 2) {
1610 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1611 return getFalse(ITy);
1612 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1613 return getFalse(ITy);
1614 }
1615 if (Delta == 1) {
1616 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1617 return getFalse(ITy);
1618 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1619 return getFalse(ITy);
1620 }
1621 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001622 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001623 if (Delta == 2)
1624 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1625 return getFalse(ITy);
1626 if (Delta == 1)
1627 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1628 return getFalse(ITy);
1629 }
1630
1631 return nullptr;
1632}
1633
Sanjay Patel472cc782016-01-11 22:14:42 +00001634/// Given operands for an And, see if we can fold the result.
1635/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001636static Value *SimplifyAndInst(Value *Op0, Value *Op1, const Query &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001637 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001638 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1639 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001640
Chris Lattnera71e9d62009-11-10 00:55:12 +00001641 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001642 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001643 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001644
Chris Lattnera71e9d62009-11-10 00:55:12 +00001645 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001646 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001647 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001648
Duncan Sandsc89ac072010-11-17 18:52:15 +00001649 // X & 0 = 0
1650 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001651 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001652
Duncan Sandsc89ac072010-11-17 18:52:15 +00001653 // X & -1 = X
1654 if (match(Op1, m_AllOnes()))
1655 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001656
Chris Lattnera71e9d62009-11-10 00:55:12 +00001657 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001658 if (match(Op0, m_Not(m_Specific(Op1))) ||
1659 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001660 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001661
Chris Lattnera71e9d62009-11-10 00:55:12 +00001662 // (A | ?) & A = A
Craig Topper9f008862014-04-15 04:59:12 +00001663 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001664 if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001665 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001666 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001667
Chris Lattnera71e9d62009-11-10 00:55:12 +00001668 // A & (A | ?) = A
1669 if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001670 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001671 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001672
Duncan Sandsba286d72011-10-26 20:55:21 +00001673 // A & (-A) = A if A is a power of two or zero.
1674 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1675 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001676 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1677 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001678 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001679 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1680 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001681 return Op1;
1682 }
1683
David Majnemera315bd82014-09-15 08:15:28 +00001684 if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1685 if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1686 if (Value *V = SimplifyAndOfICmps(ICILHS, ICIRHS))
1687 return V;
1688 if (Value *V = SimplifyAndOfICmps(ICIRHS, ICILHS))
1689 return V;
1690 }
1691 }
1692
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001693 // The compares may be hidden behind casts. Look through those and try the
1694 // same folds as above.
1695 auto *Cast0 = dyn_cast<CastInst>(Op0);
1696 auto *Cast1 = dyn_cast<CastInst>(Op1);
1697 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1698 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1699 auto *Cmp0 = dyn_cast<ICmpInst>(Cast0->getOperand(0));
1700 auto *Cmp1 = dyn_cast<ICmpInst>(Cast1->getOperand(0));
1701 if (Cmp0 && Cmp1) {
1702 Instruction::CastOps CastOpc = Cast0->getOpcode();
1703 Type *ResultType = Cast0->getType();
1704 if (auto *V = dyn_cast_or_null<Constant>(SimplifyAndOfICmps(Cmp0, Cmp1)))
1705 return ConstantExpr::getCast(CastOpc, V, ResultType);
1706 if (auto *V = dyn_cast_or_null<Constant>(SimplifyAndOfICmps(Cmp1, Cmp0)))
1707 return ConstantExpr::getCast(CastOpc, V, ResultType);
1708 }
1709 }
1710
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001711 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001712 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1713 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001714 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001715
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001716 // And distributes over Or. Try some generic simplifications based on this.
1717 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001718 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001719 return V;
1720
1721 // And distributes over Xor. Try some generic simplifications based on this.
1722 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001723 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001724 return V;
1725
Duncan Sandsb0579e92010-11-10 13:00:08 +00001726 // If the operation is with the result of a select instruction, check whether
1727 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001728 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001729 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1730 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001731 return V;
1732
1733 // If the operation is with the result of a phi instruction, check whether
1734 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001735 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001736 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001737 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001738 return V;
1739
Craig Topper9f008862014-04-15 04:59:12 +00001740 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001741}
1742
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001743Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001744 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001745 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001746 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001747 return ::SimplifyAndInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001748 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001749}
1750
Sanjay Pateld0ccdb42016-12-06 18:09:37 +00001751/// Commuted variants are assumed to be handled by calling this function again
1752/// with the parameters swapped.
1753static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1754 ICmpInst::Predicate Pred0, Pred1;
1755 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001756 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1757 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Pateld0ccdb42016-12-06 18:09:37 +00001758 return nullptr;
1759
1760 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1761 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1762 // can eliminate Op0 from this 'or'.
1763 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1764 return Op1;
1765
1766 // Check for any combination of predicates that cover the entire range of
1767 // possibilities.
1768 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1769 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1770 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1771 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1772 return getTrue(Op0->getType());
1773
1774 return nullptr;
1775}
1776
1777/// Commuted variants are assumed to be handled by calling this function again
1778/// with the parameters swapped.
David Majnemera315bd82014-09-15 08:15:28 +00001779static Value *SimplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
David Majnemer1af36e52014-12-06 10:51:40 +00001780 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1781 return X;
1782
Sanjay Pateld0ccdb42016-12-06 18:09:37 +00001783 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1784 return X;
1785
Sanjay Patel220a8732016-09-28 14:27:21 +00001786 // (icmp (add V, C0), C1) | (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001787 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel220a8732016-09-28 14:27:21 +00001788 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001789 Value *V;
Sanjay Patel220a8732016-09-28 14:27:21 +00001790 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelb2332e12016-09-20 14:36:14 +00001791 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001792
Sanjay Patel220a8732016-09-28 14:27:21 +00001793 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1794 return nullptr;
1795
1796 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1797 if (AddInst->getOperand(1) != Op1->getOperand(1))
David Majnemera315bd82014-09-15 08:15:28 +00001798 return nullptr;
1799
1800 Type *ITy = Op0->getType();
David Majnemera315bd82014-09-15 08:15:28 +00001801 bool isNSW = AddInst->hasNoSignedWrap();
1802 bool isNUW = AddInst->hasNoUnsignedWrap();
1803
Sanjay Patel220a8732016-09-28 14:27:21 +00001804 const APInt Delta = *C1 - *C0;
1805 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001806 if (Delta == 2) {
1807 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1808 return getTrue(ITy);
1809 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1810 return getTrue(ITy);
1811 }
1812 if (Delta == 1) {
1813 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1814 return getTrue(ITy);
1815 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1816 return getTrue(ITy);
1817 }
1818 }
Sanjay Patel220a8732016-09-28 14:27:21 +00001819 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001820 if (Delta == 2)
1821 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1822 return getTrue(ITy);
1823 if (Delta == 1)
1824 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1825 return getTrue(ITy);
1826 }
1827
1828 return nullptr;
1829}
1830
Sanjay Patel472cc782016-01-11 22:14:42 +00001831/// Given operands for an Or, see if we can fold the result.
1832/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001833static Value *SimplifyOrInst(Value *Op0, Value *Op1, const Query &Q,
1834 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001835 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1836 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001837
Chris Lattnera71e9d62009-11-10 00:55:12 +00001838 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001839 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001840 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001841
Chris Lattnera71e9d62009-11-10 00:55:12 +00001842 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001843 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001844 return Op0;
1845
Duncan Sandsc89ac072010-11-17 18:52:15 +00001846 // X | 0 = X
1847 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001848 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001849
Duncan Sandsc89ac072010-11-17 18:52:15 +00001850 // X | -1 = -1
1851 if (match(Op1, m_AllOnes()))
1852 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001853
Chris Lattnera71e9d62009-11-10 00:55:12 +00001854 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001855 if (match(Op0, m_Not(m_Specific(Op1))) ||
1856 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001857 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001858
Chris Lattnera71e9d62009-11-10 00:55:12 +00001859 // (A & ?) | A = A
Craig Topper9f008862014-04-15 04:59:12 +00001860 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001861 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001862 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001863 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001864
Chris Lattnera71e9d62009-11-10 00:55:12 +00001865 // A | (A & ?) = A
1866 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001867 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001868 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001869
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001870 // ~(A & ?) | A = -1
1871 if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1872 (A == Op1 || B == Op1))
1873 return Constant::getAllOnesValue(Op1->getType());
1874
1875 // A | ~(A & ?) = -1
1876 if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1877 (A == Op0 || B == Op0))
1878 return Constant::getAllOnesValue(Op0->getType());
1879
David Majnemera315bd82014-09-15 08:15:28 +00001880 if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1881 if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1882 if (Value *V = SimplifyOrOfICmps(ICILHS, ICIRHS))
1883 return V;
1884 if (Value *V = SimplifyOrOfICmps(ICIRHS, ICILHS))
1885 return V;
1886 }
1887 }
1888
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001889 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001890 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1891 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001892 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001893
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001894 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001895 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1896 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001897 return V;
1898
Duncan Sandsb0579e92010-11-10 13:00:08 +00001899 // If the operation is with the result of a select instruction, check whether
1900 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001901 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001902 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001903 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001904 return V;
1905
Nick Lewycky8561a492014-06-19 03:51:46 +00001906 // (A & C)|(B & D)
1907 Value *C = nullptr, *D = nullptr;
1908 if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1909 match(Op1, m_And(m_Value(B), m_Value(D)))) {
1910 ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1911 ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1912 if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1913 // (A & C1)|(B & C2)
1914 // If we have: ((V + N) & C1) | (V & C2)
1915 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1916 // replace with V+N.
1917 Value *V1, *V2;
1918 if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1919 match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1920 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001921 if (V1 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001922 MaskedValueIsZero(V2, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001923 return A;
Chandler Carruth66b31302015-01-04 12:03:27 +00001924 if (V2 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001925 MaskedValueIsZero(V1, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001926 return A;
1927 }
1928 // Or commutes, try both ways.
1929 if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1930 match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1931 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001932 if (V1 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001933 MaskedValueIsZero(V2, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001934 return B;
Chandler Carruth66b31302015-01-04 12:03:27 +00001935 if (V2 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001936 MaskedValueIsZero(V1, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001937 return B;
1938 }
1939 }
1940 }
1941
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001942 // If the operation is with the result of a phi instruction, check whether
1943 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001944 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001945 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001946 return V;
1947
Craig Topper9f008862014-04-15 04:59:12 +00001948 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001949}
1950
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001951Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001952 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001953 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001954 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001955 return ::SimplifyOrInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001956 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001957}
Chris Lattnera71e9d62009-11-10 00:55:12 +00001958
Sanjay Patel472cc782016-01-11 22:14:42 +00001959/// Given operands for a Xor, see if we can fold the result.
1960/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001961static Value *SimplifyXorInst(Value *Op0, Value *Op1, const Query &Q,
1962 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001963 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1964 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001965
1966 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001967 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001968 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001969
1970 // A ^ 0 = A
1971 if (match(Op1, m_Zero()))
1972 return Op0;
1973
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001974 // A ^ A = 0
1975 if (Op0 == Op1)
1976 return Constant::getNullValue(Op0->getType());
1977
Duncan Sandsc89ac072010-11-17 18:52:15 +00001978 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001979 if (match(Op0, m_Not(m_Specific(Op1))) ||
1980 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00001981 return Constant::getAllOnesValue(Op0->getType());
1982
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001983 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001984 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1985 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001986 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001987
Duncan Sandsb238de02010-11-19 09:20:39 +00001988 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1989 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1990 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1991 // only if B and C are equal. If B and C are equal then (since we assume
1992 // that operands have already been simplified) "select(cond, B, C)" should
1993 // have been simplified to the common value of B and C already. Analysing
1994 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
1995 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00001996
Craig Topper9f008862014-04-15 04:59:12 +00001997 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001998}
1999
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002000Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00002001 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002002 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00002003 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002004 return ::SimplifyXorInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00002005 RecursionLimit);
Duncan Sandsc89ac072010-11-17 18:52:15 +00002006}
2007
Chris Lattner229907c2011-07-18 04:54:35 +00002008static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002009 return CmpInst::makeCmpResultType(Op->getType());
2010}
2011
Sanjay Patel472cc782016-01-11 22:14:42 +00002012/// Rummage around inside V looking for something equivalent to the comparison
2013/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2014/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002015static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2016 Value *LHS, Value *RHS) {
2017 SelectInst *SI = dyn_cast<SelectInst>(V);
2018 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002019 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002020 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2021 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002022 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002023 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2024 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2025 return Cmp;
2026 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2027 LHS == CmpRHS && RHS == CmpLHS)
2028 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002029 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002030}
2031
Dan Gohman9631d902013-02-01 00:49:06 +00002032// A significant optimization not implemented here is assuming that alloca
2033// addresses are not equal to incoming argument values. They don't *alias*,
2034// as we say, but that doesn't mean they aren't equal, so we take a
2035// conservative approach.
2036//
2037// This is inspired in part by C++11 5.10p1:
2038// "Two pointers of the same type compare equal if and only if they are both
2039// null, both point to the same function, or both represent the same
2040// address."
2041//
2042// This is pretty permissive.
2043//
2044// It's also partly due to C11 6.5.9p6:
2045// "Two pointers compare equal if and only if both are null pointers, both are
2046// pointers to the same object (including a pointer to an object and a
2047// subobject at its beginning) or function, both are pointers to one past the
2048// last element of the same array object, or one is a pointer to one past the
2049// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002050// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002051// object in the address space.)
2052//
2053// C11's version is more restrictive, however there's no reason why an argument
2054// couldn't be a one-past-the-end value for a stack object in the caller and be
2055// equal to the beginning of a stack object in the callee.
2056//
2057// If the C and C++ standards are ever made sufficiently restrictive in this
2058// area, it may be possible to update LLVM's semantics accordingly and reinstate
2059// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002060static Constant *
2061computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2062 const DominatorTree *DT, CmpInst::Predicate Pred,
2063 const Instruction *CxtI, Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002064 // First, skip past any trivial no-ops.
2065 LHS = LHS->stripPointerCasts();
2066 RHS = RHS->stripPointerCasts();
2067
2068 // A non-null pointer is not equal to a null pointer.
Sean Silva45835e72016-07-02 23:47:27 +00002069 if (llvm::isKnownNonNull(LHS) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002070 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2071 return ConstantInt::get(GetCompareTy(LHS),
2072 !CmpInst::isTrueWhenEqual(Pred));
2073
Chandler Carruth8059c842012-03-25 21:28:14 +00002074 // We can only fold certain predicates on pointer comparisons.
2075 switch (Pred) {
2076 default:
Craig Topper9f008862014-04-15 04:59:12 +00002077 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002078
2079 // Equality comaprisons are easy to fold.
2080 case CmpInst::ICMP_EQ:
2081 case CmpInst::ICMP_NE:
2082 break;
2083
2084 // We can only handle unsigned relational comparisons because 'inbounds' on
2085 // a GEP only protects against unsigned wrapping.
2086 case CmpInst::ICMP_UGT:
2087 case CmpInst::ICMP_UGE:
2088 case CmpInst::ICMP_ULT:
2089 case CmpInst::ICMP_ULE:
2090 // However, we have to switch them to their signed variants to handle
2091 // negative indices from the base pointer.
2092 Pred = ICmpInst::getSignedPredicate(Pred);
2093 break;
2094 }
2095
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002096 // Strip off any constant offsets so that we can reason about them.
2097 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2098 // here and compare base addresses like AliasAnalysis does, however there are
2099 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2100 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2101 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002102 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2103 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002104
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002105 // If LHS and RHS are related via constant offsets to the same base
2106 // value, we can replace it with an icmp which just compares the offsets.
2107 if (LHS == RHS)
2108 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002109
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002110 // Various optimizations for (in)equality comparisons.
2111 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2112 // Different non-empty allocations that exist at the same time have
2113 // different addresses (if the program can tell). Global variables always
2114 // exist, so they always exist during the lifetime of each other and all
2115 // allocas. Two different allocas usually have different addresses...
2116 //
2117 // However, if there's an @llvm.stackrestore dynamically in between two
2118 // allocas, they may have the same address. It's tempting to reduce the
2119 // scope of the problem by only looking at *static* allocas here. That would
2120 // cover the majority of allocas while significantly reducing the likelihood
2121 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2122 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2123 // an entry block. Also, if we have a block that's not attached to a
2124 // function, we can't tell if it's "static" under the current definition.
2125 // Theoretically, this problem could be fixed by creating a new kind of
2126 // instruction kind specifically for static allocas. Such a new instruction
2127 // could be required to be at the top of the entry block, thus preventing it
2128 // from being subject to a @llvm.stackrestore. Instcombine could even
2129 // convert regular allocas into these special allocas. It'd be nifty.
2130 // However, until then, this problem remains open.
2131 //
2132 // So, we'll assume that two non-empty allocas have different addresses
2133 // for now.
2134 //
2135 // With all that, if the offsets are within the bounds of their allocations
2136 // (and not one-past-the-end! so we can't use inbounds!), and their
2137 // allocations aren't the same, the pointers are not equal.
2138 //
2139 // Note that it's not necessary to check for LHS being a global variable
2140 // address, due to canonicalization and constant folding.
2141 if (isa<AllocaInst>(LHS) &&
2142 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002143 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2144 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002145 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002146 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002147 getObjectSize(LHS, LHSSize, DL, TLI) &&
2148 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002149 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2150 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002151 if (!LHSOffsetValue.isNegative() &&
2152 !RHSOffsetValue.isNegative() &&
2153 LHSOffsetValue.ult(LHSSize) &&
2154 RHSOffsetValue.ult(RHSSize)) {
2155 return ConstantInt::get(GetCompareTy(LHS),
2156 !CmpInst::isTrueWhenEqual(Pred));
2157 }
2158 }
2159
2160 // Repeat the above check but this time without depending on DataLayout
2161 // or being able to compute a precise size.
2162 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2163 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2164 LHSOffset->isNullValue() &&
2165 RHSOffset->isNullValue())
2166 return ConstantInt::get(GetCompareTy(LHS),
2167 !CmpInst::isTrueWhenEqual(Pred));
2168 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002169
2170 // Even if an non-inbounds GEP occurs along the path we can still optimize
2171 // equality comparisons concerning the result. We avoid walking the whole
2172 // chain again by starting where the last calls to
2173 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002174 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2175 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002176 if (LHS == RHS)
2177 return ConstantExpr::getICmp(Pred,
2178 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2179 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002180
2181 // If one side of the equality comparison must come from a noalias call
2182 // (meaning a system memory allocation function), and the other side must
2183 // come from a pointer that cannot overlap with dynamically-allocated
2184 // memory within the lifetime of the current function (allocas, byval
2185 // arguments, globals), then determine the comparison result here.
2186 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2187 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2188 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2189
2190 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002191 auto IsNAC = [](ArrayRef<Value *> Objects) {
2192 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002193 };
2194
2195 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002196 // noalias calls. For allocas, we consider only static ones (dynamic
2197 // allocas might be transformed into calls to malloc not simultaneously
2198 // live with the compared-to allocation). For globals, we exclude symbols
2199 // that might be resolve lazily to symbols in another dynamically-loaded
2200 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002201 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2202 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002203 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2204 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2205 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2206 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002207 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002208 !GV->isThreadLocal();
2209 if (const Argument *A = dyn_cast<Argument>(V))
2210 return A->hasByValAttr();
2211 return false;
2212 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002213 };
2214
2215 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2216 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2217 return ConstantInt::get(GetCompareTy(LHS),
2218 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002219
2220 // Fold comparisons for non-escaping pointer even if the allocation call
2221 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2222 // dynamic allocation call could be either of the operands.
2223 Value *MI = nullptr;
Sean Silva45835e72016-07-02 23:47:27 +00002224 if (isAllocLikeFn(LHS, TLI) && llvm::isKnownNonNullAt(RHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002225 MI = LHS;
Sean Silva45835e72016-07-02 23:47:27 +00002226 else if (isAllocLikeFn(RHS, TLI) && llvm::isKnownNonNullAt(LHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002227 MI = RHS;
2228 // FIXME: We should also fold the compare when the pointer escapes, but the
2229 // compare dominates the pointer escape
2230 if (MI && !PointerMayBeCaptured(MI, true, true))
2231 return ConstantInt::get(GetCompareTy(LHS),
2232 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002233 }
2234
2235 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002236 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002237}
Chris Lattner01990f02012-02-24 19:01:58 +00002238
Sanjay Pateldc65a272016-12-03 17:30:22 +00002239/// Fold an icmp when its operands have i1 scalar type.
2240static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
2241 Value *RHS, const Query &Q) {
2242 Type *ITy = GetCompareTy(LHS); // The return type.
2243 Type *OpTy = LHS->getType(); // The operand type.
2244 if (!OpTy->getScalarType()->isIntegerTy(1))
2245 return nullptr;
2246
2247 switch (Pred) {
2248 default:
2249 break;
2250 case ICmpInst::ICMP_EQ:
2251 // X == 1 -> X
2252 if (match(RHS, m_One()))
2253 return LHS;
2254 break;
2255 case ICmpInst::ICMP_NE:
2256 // X != 0 -> X
2257 if (match(RHS, m_Zero()))
2258 return LHS;
2259 break;
2260 case ICmpInst::ICMP_UGT:
2261 // X >u 0 -> X
2262 if (match(RHS, m_Zero()))
2263 return LHS;
2264 break;
2265 case ICmpInst::ICMP_UGE:
2266 // X >=u 1 -> X
2267 if (match(RHS, m_One()))
2268 return LHS;
2269 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2270 return getTrue(ITy);
2271 break;
2272 case ICmpInst::ICMP_SGE:
2273 /// For signed comparison, the values for an i1 are 0 and -1
2274 /// respectively. This maps into a truth table of:
2275 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2276 /// 0 | 0 | 1 (0 >= 0) | 1
2277 /// 0 | 1 | 1 (0 >= -1) | 1
2278 /// 1 | 0 | 0 (-1 >= 0) | 0
2279 /// 1 | 1 | 1 (-1 >= -1) | 1
2280 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2281 return getTrue(ITy);
2282 break;
2283 case ICmpInst::ICMP_SLT:
2284 // X <s 0 -> X
2285 if (match(RHS, m_Zero()))
2286 return LHS;
2287 break;
2288 case ICmpInst::ICMP_SLE:
2289 // X <=s -1 -> X
2290 if (match(RHS, m_One()))
2291 return LHS;
2292 break;
2293 case ICmpInst::ICMP_ULE:
2294 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2295 return getTrue(ITy);
2296 break;
2297 }
2298
2299 return nullptr;
2300}
2301
2302/// Try hard to fold icmp with zero RHS because this is a common case.
2303static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
2304 Value *RHS, const Query &Q) {
2305 if (!match(RHS, m_Zero()))
2306 return nullptr;
2307
2308 Type *ITy = GetCompareTy(LHS); // The return type.
2309 bool LHSKnownNonNegative, LHSKnownNegative;
2310 switch (Pred) {
2311 default:
2312 llvm_unreachable("Unknown ICmp predicate!");
2313 case ICmpInst::ICMP_ULT:
2314 return getFalse(ITy);
2315 case ICmpInst::ICMP_UGE:
2316 return getTrue(ITy);
2317 case ICmpInst::ICMP_EQ:
2318 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002319 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002320 return getFalse(ITy);
2321 break;
2322 case ICmpInst::ICMP_NE:
2323 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002324 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002325 return getTrue(ITy);
2326 break;
2327 case ICmpInst::ICMP_SLT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002328 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2329 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002330 if (LHSKnownNegative)
2331 return getTrue(ITy);
2332 if (LHSKnownNonNegative)
2333 return getFalse(ITy);
2334 break;
2335 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002336 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2337 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002338 if (LHSKnownNegative)
2339 return getTrue(ITy);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002340 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002341 return getFalse(ITy);
2342 break;
2343 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002344 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2345 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002346 if (LHSKnownNegative)
2347 return getFalse(ITy);
2348 if (LHSKnownNonNegative)
2349 return getTrue(ITy);
2350 break;
2351 case ICmpInst::ICMP_SGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002352 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2353 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002354 if (LHSKnownNegative)
2355 return getFalse(ITy);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002356 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002357 return getTrue(ITy);
2358 break;
2359 }
2360
2361 return nullptr;
2362}
2363
Sanjay Patelbe332132017-01-23 18:22:26 +00002364/// Many binary operators with a constant operand have an easy-to-compute
2365/// range of outputs. This can be used to fold a comparison to always true or
2366/// always false.
2367static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2368 unsigned Width = Lower.getBitWidth();
2369 const APInt *C;
2370 switch (BO.getOpcode()) {
2371 case Instruction::Add:
Sanjay Patel56227252017-01-24 17:03:24 +00002372 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2373 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2374 if (BO.hasNoUnsignedWrap()) {
2375 // 'add nuw x, C' produces [C, UINT_MAX].
2376 Lower = *C;
2377 } else if (BO.hasNoSignedWrap()) {
2378 if (C->isNegative()) {
2379 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2380 Lower = APInt::getSignedMinValue(Width);
2381 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2382 } else {
2383 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2384 Lower = APInt::getSignedMinValue(Width) + *C;
2385 Upper = APInt::getSignedMaxValue(Width) + 1;
2386 }
2387 }
2388 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002389 break;
2390
2391 case Instruction::And:
2392 if (match(BO.getOperand(1), m_APInt(C)))
2393 // 'and x, C' produces [0, C].
2394 Upper = *C + 1;
2395 break;
2396
2397 case Instruction::Or:
2398 if (match(BO.getOperand(1), m_APInt(C)))
2399 // 'or x, C' produces [C, UINT_MAX].
2400 Lower = *C;
2401 break;
2402
2403 case Instruction::AShr:
2404 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2405 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2406 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2407 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2408 } else if (match(BO.getOperand(0), m_APInt(C))) {
2409 unsigned ShiftAmount = Width - 1;
2410 if (*C != 0 && BO.isExact())
2411 ShiftAmount = C->countTrailingZeros();
2412 if (C->isNegative()) {
2413 // 'ashr C, x' produces [C, C >> (Width-1)]
2414 Lower = *C;
2415 Upper = C->ashr(ShiftAmount) + 1;
2416 } else {
2417 // 'ashr C, x' produces [C >> (Width-1), C]
2418 Lower = C->ashr(ShiftAmount);
2419 Upper = *C + 1;
2420 }
2421 }
2422 break;
2423
2424 case Instruction::LShr:
2425 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2426 // 'lshr x, C' produces [0, UINT_MAX >> C].
2427 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2428 } else if (match(BO.getOperand(0), m_APInt(C))) {
2429 // 'lshr C, x' produces [C >> (Width-1), C].
2430 unsigned ShiftAmount = Width - 1;
2431 if (*C != 0 && BO.isExact())
2432 ShiftAmount = C->countTrailingZeros();
2433 Lower = C->lshr(ShiftAmount);
2434 Upper = *C + 1;
2435 }
2436 break;
2437
2438 case Instruction::Shl:
2439 if (match(BO.getOperand(0), m_APInt(C))) {
2440 if (BO.hasNoUnsignedWrap()) {
2441 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2442 Lower = *C;
2443 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2444 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2445 if (C->isNegative()) {
2446 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2447 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2448 Lower = C->shl(ShiftAmount);
2449 Upper = *C + 1;
2450 } else {
2451 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2452 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2453 Lower = *C;
2454 Upper = C->shl(ShiftAmount) + 1;
2455 }
2456 }
2457 }
2458 break;
2459
2460 case Instruction::SDiv:
2461 if (match(BO.getOperand(1), m_APInt(C))) {
2462 APInt IntMin = APInt::getSignedMinValue(Width);
2463 APInt IntMax = APInt::getSignedMaxValue(Width);
2464 if (C->isAllOnesValue()) {
2465 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2466 // where C != -1 and C != 0 and C != 1
2467 Lower = IntMin + 1;
2468 Upper = IntMax + 1;
2469 } else if (C->countLeadingZeros() < Width - 1) {
2470 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2471 // where C != -1 and C != 0 and C != 1
2472 Lower = IntMin.sdiv(*C);
2473 Upper = IntMax.sdiv(*C);
2474 if (Lower.sgt(Upper))
2475 std::swap(Lower, Upper);
2476 Upper = Upper + 1;
2477 assert(Upper != Lower && "Upper part of range has wrapped!");
2478 }
2479 } else if (match(BO.getOperand(0), m_APInt(C))) {
2480 if (C->isMinSignedValue()) {
2481 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2482 Lower = *C;
2483 Upper = Lower.lshr(1) + 1;
2484 } else {
2485 // 'sdiv C, x' produces [-|C|, |C|].
2486 Upper = C->abs() + 1;
2487 Lower = (-Upper) + 1;
2488 }
2489 }
2490 break;
2491
2492 case Instruction::UDiv:
2493 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2494 // 'udiv x, C' produces [0, UINT_MAX / C].
2495 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2496 } else if (match(BO.getOperand(0), m_APInt(C))) {
2497 // 'udiv C, x' produces [0, C].
2498 Upper = *C + 1;
2499 }
2500 break;
2501
2502 case Instruction::SRem:
2503 if (match(BO.getOperand(1), m_APInt(C))) {
2504 // 'srem x, C' produces (-|C|, |C|).
2505 Upper = C->abs();
2506 Lower = (-Upper) + 1;
2507 }
2508 break;
2509
2510 case Instruction::URem:
2511 if (match(BO.getOperand(1), m_APInt(C)))
2512 // 'urem x, C' produces [0, C).
2513 Upper = *C;
2514 break;
2515
2516 default:
2517 break;
2518 }
2519}
2520
Sanjay Patel67bde282016-08-22 23:12:02 +00002521static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2522 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002523 const APInt *C;
2524 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002525 return nullptr;
2526
2527 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002528 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002529 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002530 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002531 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002532 return ConstantInt::getTrue(GetCompareTy(RHS));
2533
Sanjay Patelbe332132017-01-23 18:22:26 +00002534 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002535 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002536 APInt Lower = APInt(Width, 0);
2537 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002538 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2539 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002540
2541 ConstantRange LHS_CR =
2542 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2543
2544 if (auto *I = dyn_cast<Instruction>(LHS))
2545 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2546 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2547
2548 if (!LHS_CR.isFullSet()) {
2549 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002550 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002551 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002552 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002553 }
2554
2555 return nullptr;
2556}
2557
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002558static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
2559 Value *RHS, const Query &Q,
2560 unsigned MaxRecurse) {
2561 Type *ITy = GetCompareTy(LHS); // The return type.
2562
2563 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2564 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2565 if (MaxRecurse && (LBO || RBO)) {
2566 // Analyze the case when either LHS or RHS is an add instruction.
2567 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2568 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2569 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2570 if (LBO && LBO->getOpcode() == Instruction::Add) {
2571 A = LBO->getOperand(0);
2572 B = LBO->getOperand(1);
2573 NoLHSWrapProblem =
2574 ICmpInst::isEquality(Pred) ||
2575 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2576 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2577 }
2578 if (RBO && RBO->getOpcode() == Instruction::Add) {
2579 C = RBO->getOperand(0);
2580 D = RBO->getOperand(1);
2581 NoRHSWrapProblem =
2582 ICmpInst::isEquality(Pred) ||
2583 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2584 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2585 }
2586
2587 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2588 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2589 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2590 Constant::getNullValue(RHS->getType()), Q,
2591 MaxRecurse - 1))
2592 return V;
2593
2594 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2595 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2596 if (Value *V =
2597 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2598 C == LHS ? D : C, Q, MaxRecurse - 1))
2599 return V;
2600
2601 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2602 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2603 NoRHSWrapProblem) {
2604 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2605 Value *Y, *Z;
2606 if (A == C) {
2607 // C + B == C + D -> B == D
2608 Y = B;
2609 Z = D;
2610 } else if (A == D) {
2611 // D + B == C + D -> B == C
2612 Y = B;
2613 Z = C;
2614 } else if (B == C) {
2615 // A + C == C + D -> A == D
2616 Y = A;
2617 Z = D;
2618 } else {
2619 assert(B == D);
2620 // A + D == C + D -> A == C
2621 Y = A;
2622 Z = C;
2623 }
2624 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2625 return V;
2626 }
2627 }
2628
2629 {
2630 Value *Y = nullptr;
2631 // icmp pred (or X, Y), X
2632 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2633 if (Pred == ICmpInst::ICMP_ULT)
2634 return getFalse(ITy);
2635 if (Pred == ICmpInst::ICMP_UGE)
2636 return getTrue(ITy);
2637
2638 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
2639 bool RHSKnownNonNegative, RHSKnownNegative;
2640 bool YKnownNonNegative, YKnownNegative;
2641 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, Q.DL, 0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002642 Q.AC, Q.CxtI, Q.DT);
2643 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002644 Q.CxtI, Q.DT);
2645 if (RHSKnownNonNegative && YKnownNegative)
2646 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
2647 if (RHSKnownNegative || YKnownNonNegative)
2648 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2649 }
2650 }
2651 // icmp pred X, (or X, Y)
2652 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2653 if (Pred == ICmpInst::ICMP_ULE)
2654 return getTrue(ITy);
2655 if (Pred == ICmpInst::ICMP_UGT)
2656 return getFalse(ITy);
2657
2658 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
2659 bool LHSKnownNonNegative, LHSKnownNegative;
2660 bool YKnownNonNegative, YKnownNegative;
2661 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002662 Q.AC, Q.CxtI, Q.DT);
2663 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002664 Q.CxtI, Q.DT);
2665 if (LHSKnownNonNegative && YKnownNegative)
2666 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
2667 if (LHSKnownNegative || YKnownNonNegative)
2668 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2669 }
2670 }
2671 }
2672
2673 // icmp pred (and X, Y), X
2674 if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2675 m_And(m_Specific(RHS), m_Value())))) {
2676 if (Pred == ICmpInst::ICMP_UGT)
2677 return getFalse(ITy);
2678 if (Pred == ICmpInst::ICMP_ULE)
2679 return getTrue(ITy);
2680 }
2681 // icmp pred X, (and X, Y)
2682 if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2683 m_And(m_Specific(LHS), m_Value())))) {
2684 if (Pred == ICmpInst::ICMP_UGE)
2685 return getTrue(ITy);
2686 if (Pred == ICmpInst::ICMP_ULT)
2687 return getFalse(ITy);
2688 }
2689
2690 // 0 - (zext X) pred C
2691 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2692 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2693 if (RHSC->getValue().isStrictlyPositive()) {
2694 if (Pred == ICmpInst::ICMP_SLT)
2695 return ConstantInt::getTrue(RHSC->getContext());
2696 if (Pred == ICmpInst::ICMP_SGE)
2697 return ConstantInt::getFalse(RHSC->getContext());
2698 if (Pred == ICmpInst::ICMP_EQ)
2699 return ConstantInt::getFalse(RHSC->getContext());
2700 if (Pred == ICmpInst::ICMP_NE)
2701 return ConstantInt::getTrue(RHSC->getContext());
2702 }
2703 if (RHSC->getValue().isNonNegative()) {
2704 if (Pred == ICmpInst::ICMP_SLE)
2705 return ConstantInt::getTrue(RHSC->getContext());
2706 if (Pred == ICmpInst::ICMP_SGT)
2707 return ConstantInt::getFalse(RHSC->getContext());
2708 }
2709 }
2710 }
2711
2712 // icmp pred (urem X, Y), Y
2713 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2714 bool KnownNonNegative, KnownNegative;
2715 switch (Pred) {
2716 default:
2717 break;
2718 case ICmpInst::ICMP_SGT:
2719 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002720 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2721 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002722 if (!KnownNonNegative)
2723 break;
2724 LLVM_FALLTHROUGH;
2725 case ICmpInst::ICMP_EQ:
2726 case ICmpInst::ICMP_UGT:
2727 case ICmpInst::ICMP_UGE:
2728 return getFalse(ITy);
2729 case ICmpInst::ICMP_SLT:
2730 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002731 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2732 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002733 if (!KnownNonNegative)
2734 break;
2735 LLVM_FALLTHROUGH;
2736 case ICmpInst::ICMP_NE:
2737 case ICmpInst::ICMP_ULT:
2738 case ICmpInst::ICMP_ULE:
2739 return getTrue(ITy);
2740 }
2741 }
2742
2743 // icmp pred X, (urem Y, X)
2744 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2745 bool KnownNonNegative, KnownNegative;
2746 switch (Pred) {
2747 default:
2748 break;
2749 case ICmpInst::ICMP_SGT:
2750 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002751 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2752 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002753 if (!KnownNonNegative)
2754 break;
2755 LLVM_FALLTHROUGH;
2756 case ICmpInst::ICMP_NE:
2757 case ICmpInst::ICMP_UGT:
2758 case ICmpInst::ICMP_UGE:
2759 return getTrue(ITy);
2760 case ICmpInst::ICMP_SLT:
2761 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002762 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2763 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002764 if (!KnownNonNegative)
2765 break;
2766 LLVM_FALLTHROUGH;
2767 case ICmpInst::ICMP_EQ:
2768 case ICmpInst::ICMP_ULT:
2769 case ICmpInst::ICMP_ULE:
2770 return getFalse(ITy);
2771 }
2772 }
2773
2774 // x >> y <=u x
2775 // x udiv y <=u x.
2776 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2777 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2778 // icmp pred (X op Y), X
2779 if (Pred == ICmpInst::ICMP_UGT)
2780 return getFalse(ITy);
2781 if (Pred == ICmpInst::ICMP_ULE)
2782 return getTrue(ITy);
2783 }
2784
2785 // x >=u x >> y
2786 // x >=u x udiv y.
2787 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2788 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2789 // icmp pred X, (X op Y)
2790 if (Pred == ICmpInst::ICMP_ULT)
2791 return getFalse(ITy);
2792 if (Pred == ICmpInst::ICMP_UGE)
2793 return getTrue(ITy);
2794 }
2795
2796 // handle:
2797 // CI2 << X == CI
2798 // CI2 << X != CI
2799 //
2800 // where CI2 is a power of 2 and CI isn't
2801 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2802 const APInt *CI2Val, *CIVal = &CI->getValue();
2803 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2804 CI2Val->isPowerOf2()) {
2805 if (!CIVal->isPowerOf2()) {
2806 // CI2 << X can equal zero in some circumstances,
2807 // this simplification is unsafe if CI is zero.
2808 //
2809 // We know it is safe if:
2810 // - The shift is nsw, we can't shift out the one bit.
2811 // - The shift is nuw, we can't shift out the one bit.
2812 // - CI2 is one
2813 // - CI isn't zero
2814 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2815 *CI2Val == 1 || !CI->isZero()) {
2816 if (Pred == ICmpInst::ICMP_EQ)
2817 return ConstantInt::getFalse(RHS->getContext());
2818 if (Pred == ICmpInst::ICMP_NE)
2819 return ConstantInt::getTrue(RHS->getContext());
2820 }
2821 }
2822 if (CIVal->isSignBit() && *CI2Val == 1) {
2823 if (Pred == ICmpInst::ICMP_UGT)
2824 return ConstantInt::getFalse(RHS->getContext());
2825 if (Pred == ICmpInst::ICMP_ULE)
2826 return ConstantInt::getTrue(RHS->getContext());
2827 }
2828 }
2829 }
2830
2831 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2832 LBO->getOperand(1) == RBO->getOperand(1)) {
2833 switch (LBO->getOpcode()) {
2834 default:
2835 break;
2836 case Instruction::UDiv:
2837 case Instruction::LShr:
2838 if (ICmpInst::isSigned(Pred))
2839 break;
2840 LLVM_FALLTHROUGH;
2841 case Instruction::SDiv:
2842 case Instruction::AShr:
2843 if (!LBO->isExact() || !RBO->isExact())
2844 break;
2845 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2846 RBO->getOperand(0), Q, MaxRecurse - 1))
2847 return V;
2848 break;
2849 case Instruction::Shl: {
2850 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2851 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2852 if (!NUW && !NSW)
2853 break;
2854 if (!NSW && ICmpInst::isSigned(Pred))
2855 break;
2856 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2857 RBO->getOperand(0), Q, MaxRecurse - 1))
2858 return V;
2859 break;
2860 }
2861 }
2862 }
2863 return nullptr;
2864}
2865
Sanjay Patel35289c62016-12-10 17:40:47 +00002866/// Simplify integer comparisons where at least one operand of the compare
2867/// matches an integer min/max idiom.
2868static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
2869 Value *RHS, const Query &Q,
2870 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002871 Type *ITy = GetCompareTy(LHS); // The return type.
2872 Value *A, *B;
2873 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2874 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2875
2876 // Signed variants on "max(a,b)>=a -> true".
2877 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2878 if (A != RHS)
2879 std::swap(A, B); // smax(A, B) pred A.
2880 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2881 // We analyze this as smax(A, B) pred A.
2882 P = Pred;
2883 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2884 (A == LHS || B == LHS)) {
2885 if (A != LHS)
2886 std::swap(A, B); // A pred smax(A, B).
2887 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2888 // We analyze this as smax(A, B) swapped-pred A.
2889 P = CmpInst::getSwappedPredicate(Pred);
2890 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2891 (A == RHS || B == RHS)) {
2892 if (A != RHS)
2893 std::swap(A, B); // smin(A, B) pred A.
2894 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2895 // We analyze this as smax(-A, -B) swapped-pred -A.
2896 // Note that we do not need to actually form -A or -B thanks to EqP.
2897 P = CmpInst::getSwappedPredicate(Pred);
2898 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2899 (A == LHS || B == LHS)) {
2900 if (A != LHS)
2901 std::swap(A, B); // A pred smin(A, B).
2902 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2903 // We analyze this as smax(-A, -B) pred -A.
2904 // Note that we do not need to actually form -A or -B thanks to EqP.
2905 P = Pred;
2906 }
2907 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2908 // Cases correspond to "max(A, B) p A".
2909 switch (P) {
2910 default:
2911 break;
2912 case CmpInst::ICMP_EQ:
2913 case CmpInst::ICMP_SLE:
2914 // Equivalent to "A EqP B". This may be the same as the condition tested
2915 // in the max/min; if so, we can just return that.
2916 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2917 return V;
2918 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2919 return V;
2920 // Otherwise, see if "A EqP B" simplifies.
2921 if (MaxRecurse)
2922 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2923 return V;
2924 break;
2925 case CmpInst::ICMP_NE:
2926 case CmpInst::ICMP_SGT: {
2927 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2928 // Equivalent to "A InvEqP B". This may be the same as the condition
2929 // tested in the max/min; if so, we can just return that.
2930 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2931 return V;
2932 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2933 return V;
2934 // Otherwise, see if "A InvEqP B" simplifies.
2935 if (MaxRecurse)
2936 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2937 return V;
2938 break;
2939 }
2940 case CmpInst::ICMP_SGE:
2941 // Always true.
2942 return getTrue(ITy);
2943 case CmpInst::ICMP_SLT:
2944 // Always false.
2945 return getFalse(ITy);
2946 }
2947 }
2948
2949 // Unsigned variants on "max(a,b)>=a -> true".
2950 P = CmpInst::BAD_ICMP_PREDICATE;
2951 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2952 if (A != RHS)
2953 std::swap(A, B); // umax(A, B) pred A.
2954 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2955 // We analyze this as umax(A, B) pred A.
2956 P = Pred;
2957 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2958 (A == LHS || B == LHS)) {
2959 if (A != LHS)
2960 std::swap(A, B); // A pred umax(A, B).
2961 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2962 // We analyze this as umax(A, B) swapped-pred A.
2963 P = CmpInst::getSwappedPredicate(Pred);
2964 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2965 (A == RHS || B == RHS)) {
2966 if (A != RHS)
2967 std::swap(A, B); // umin(A, B) pred A.
2968 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2969 // We analyze this as umax(-A, -B) swapped-pred -A.
2970 // Note that we do not need to actually form -A or -B thanks to EqP.
2971 P = CmpInst::getSwappedPredicate(Pred);
2972 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2973 (A == LHS || B == LHS)) {
2974 if (A != LHS)
2975 std::swap(A, B); // A pred umin(A, B).
2976 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2977 // We analyze this as umax(-A, -B) pred -A.
2978 // Note that we do not need to actually form -A or -B thanks to EqP.
2979 P = Pred;
2980 }
2981 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2982 // Cases correspond to "max(A, B) p A".
2983 switch (P) {
2984 default:
2985 break;
2986 case CmpInst::ICMP_EQ:
2987 case CmpInst::ICMP_ULE:
2988 // Equivalent to "A EqP B". This may be the same as the condition tested
2989 // in the max/min; if so, we can just return that.
2990 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2991 return V;
2992 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2993 return V;
2994 // Otherwise, see if "A EqP B" simplifies.
2995 if (MaxRecurse)
2996 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2997 return V;
2998 break;
2999 case CmpInst::ICMP_NE:
3000 case CmpInst::ICMP_UGT: {
3001 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3002 // Equivalent to "A InvEqP B". This may be the same as the condition
3003 // tested in the max/min; if so, we can just return that.
3004 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3005 return V;
3006 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3007 return V;
3008 // Otherwise, see if "A InvEqP B" simplifies.
3009 if (MaxRecurse)
3010 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3011 return V;
3012 break;
3013 }
3014 case CmpInst::ICMP_UGE:
3015 // Always true.
3016 return getTrue(ITy);
3017 case CmpInst::ICMP_ULT:
3018 // Always false.
3019 return getFalse(ITy);
3020 }
3021 }
3022
3023 // Variants on "max(x,y) >= min(x,z)".
3024 Value *C, *D;
3025 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3026 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3027 (A == C || A == D || B == C || B == D)) {
3028 // max(x, ?) pred min(x, ?).
3029 if (Pred == CmpInst::ICMP_SGE)
3030 // Always true.
3031 return getTrue(ITy);
3032 if (Pred == CmpInst::ICMP_SLT)
3033 // Always false.
3034 return getFalse(ITy);
3035 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3036 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3037 (A == C || A == D || B == C || B == D)) {
3038 // min(x, ?) pred max(x, ?).
3039 if (Pred == CmpInst::ICMP_SLE)
3040 // Always true.
3041 return getTrue(ITy);
3042 if (Pred == CmpInst::ICMP_SGT)
3043 // Always false.
3044 return getFalse(ITy);
3045 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3046 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3047 (A == C || A == D || B == C || B == D)) {
3048 // max(x, ?) pred min(x, ?).
3049 if (Pred == CmpInst::ICMP_UGE)
3050 // Always true.
3051 return getTrue(ITy);
3052 if (Pred == CmpInst::ICMP_ULT)
3053 // Always false.
3054 return getFalse(ITy);
3055 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3056 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3057 (A == C || A == D || B == C || B == D)) {
3058 // min(x, ?) pred max(x, ?).
3059 if (Pred == CmpInst::ICMP_ULE)
3060 // Always true.
3061 return getTrue(ITy);
3062 if (Pred == CmpInst::ICMP_UGT)
3063 // Always false.
3064 return getFalse(ITy);
3065 }
3066
3067 return nullptr;
3068}
3069
Sanjay Patel472cc782016-01-11 22:14:42 +00003070/// Given operands for an ICmpInst, see if we can fold the result.
3071/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003072static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003073 const Query &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003074 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003075 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003076
Chris Lattnera71e9d62009-11-10 00:55:12 +00003077 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003078 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003079 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003080
3081 // If we have a constant, make sure it is on the RHS.
3082 std::swap(LHS, RHS);
3083 Pred = CmpInst::getSwappedPredicate(Pred);
3084 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003085
Chris Lattner229907c2011-07-18 04:54:35 +00003086 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003087
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003088 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00003089 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
3090 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00003091 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003092 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003093
Sanjay Pateldc65a272016-12-03 17:30:22 +00003094 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3095 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003096
Sanjay Pateldc65a272016-12-03 17:30:22 +00003097 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3098 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003099
Sanjay Patel67bde282016-08-22 23:12:02 +00003100 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3101 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003102
Chen Li7452d952015-09-26 03:26:47 +00003103 // If both operands have range metadata, use the metadata
3104 // to simplify the comparison.
3105 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003106 auto RHS_Instr = cast<Instruction>(RHS);
3107 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003108
3109 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3110 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003111 auto RHS_CR = getConstantRangeFromMetadata(
3112 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3113 auto LHS_CR = getConstantRangeFromMetadata(
3114 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003115
3116 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3117 if (Satisfied_CR.contains(LHS_CR))
3118 return ConstantInt::getTrue(RHS->getContext());
3119
3120 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3121 CmpInst::getInversePredicate(Pred), RHS_CR);
3122 if (InversedSatisfied_CR.contains(LHS_CR))
3123 return ConstantInt::getFalse(RHS->getContext());
3124 }
3125 }
3126
Duncan Sands8fb2c382011-01-20 13:21:55 +00003127 // Compare of cast, for example (zext X) != 0 -> X != 0
3128 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3129 Instruction *LI = cast<CastInst>(LHS);
3130 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003131 Type *SrcTy = SrcOp->getType();
3132 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003133
3134 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3135 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003136 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3137 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003138 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3139 // Transfer the cast to the constant.
3140 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3141 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003142 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003143 return V;
3144 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3145 if (RI->getOperand(0)->getType() == SrcTy)
3146 // Compare without the cast.
3147 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003148 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003149 return V;
3150 }
3151 }
3152
3153 if (isa<ZExtInst>(LHS)) {
3154 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3155 // same type.
3156 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3157 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3158 // Compare X and Y. Note that signed predicates become unsigned.
3159 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003160 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003161 MaxRecurse-1))
3162 return V;
3163 }
3164 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3165 // too. If not, then try to deduce the result of the comparison.
3166 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3167 // Compute the constant that would happen if we truncated to SrcTy then
3168 // reextended to DstTy.
3169 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3170 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3171
3172 // If the re-extended constant didn't change then this is effectively
3173 // also a case of comparing two zero-extended values.
3174 if (RExt == CI && MaxRecurse)
3175 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003176 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003177 return V;
3178
3179 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3180 // there. Use this to work out the result of the comparison.
3181 if (RExt != CI) {
3182 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003183 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003184 // LHS <u RHS.
3185 case ICmpInst::ICMP_EQ:
3186 case ICmpInst::ICMP_UGT:
3187 case ICmpInst::ICMP_UGE:
3188 return ConstantInt::getFalse(CI->getContext());
3189
3190 case ICmpInst::ICMP_NE:
3191 case ICmpInst::ICMP_ULT:
3192 case ICmpInst::ICMP_ULE:
3193 return ConstantInt::getTrue(CI->getContext());
3194
3195 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3196 // is non-negative then LHS <s RHS.
3197 case ICmpInst::ICMP_SGT:
3198 case ICmpInst::ICMP_SGE:
3199 return CI->getValue().isNegative() ?
3200 ConstantInt::getTrue(CI->getContext()) :
3201 ConstantInt::getFalse(CI->getContext());
3202
3203 case ICmpInst::ICMP_SLT:
3204 case ICmpInst::ICMP_SLE:
3205 return CI->getValue().isNegative() ?
3206 ConstantInt::getFalse(CI->getContext()) :
3207 ConstantInt::getTrue(CI->getContext());
3208 }
3209 }
3210 }
3211 }
3212
3213 if (isa<SExtInst>(LHS)) {
3214 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3215 // same type.
3216 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3217 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3218 // Compare X and Y. Note that the predicate does not change.
3219 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003220 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003221 return V;
3222 }
3223 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3224 // too. If not, then try to deduce the result of the comparison.
3225 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3226 // Compute the constant that would happen if we truncated to SrcTy then
3227 // reextended to DstTy.
3228 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3229 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3230
3231 // If the re-extended constant didn't change then this is effectively
3232 // also a case of comparing two sign-extended values.
3233 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003234 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003235 return V;
3236
3237 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3238 // bits there. Use this to work out the result of the comparison.
3239 if (RExt != CI) {
3240 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003241 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003242 case ICmpInst::ICMP_EQ:
3243 return ConstantInt::getFalse(CI->getContext());
3244 case ICmpInst::ICMP_NE:
3245 return ConstantInt::getTrue(CI->getContext());
3246
3247 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3248 // LHS >s RHS.
3249 case ICmpInst::ICMP_SGT:
3250 case ICmpInst::ICMP_SGE:
3251 return CI->getValue().isNegative() ?
3252 ConstantInt::getTrue(CI->getContext()) :
3253 ConstantInt::getFalse(CI->getContext());
3254 case ICmpInst::ICMP_SLT:
3255 case ICmpInst::ICMP_SLE:
3256 return CI->getValue().isNegative() ?
3257 ConstantInt::getFalse(CI->getContext()) :
3258 ConstantInt::getTrue(CI->getContext());
3259
3260 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3261 // LHS >u RHS.
3262 case ICmpInst::ICMP_UGT:
3263 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003264 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003265 if (MaxRecurse)
3266 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3267 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003268 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003269 return V;
3270 break;
3271 case ICmpInst::ICMP_ULT:
3272 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003273 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003274 if (MaxRecurse)
3275 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3276 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003277 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003278 return V;
3279 break;
3280 }
3281 }
3282 }
3283 }
3284 }
3285
James Molloy1d88d6f2015-10-22 13:18:42 +00003286 // icmp eq|ne X, Y -> false|true if X != Y
3287 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003288 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
James Molloy1d88d6f2015-10-22 13:18:42 +00003289 LLVMContext &Ctx = LHS->getType()->getContext();
3290 return Pred == ICmpInst::ICMP_NE ?
3291 ConstantInt::getTrue(Ctx) : ConstantInt::getFalse(Ctx);
3292 }
Junmo Park53470fc2016-04-05 21:14:31 +00003293
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003294 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3295 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003296
Sanjay Patel35289c62016-12-10 17:40:47 +00003297 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003298 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003299
Chandler Carruth8059c842012-03-25 21:28:14 +00003300 // Simplify comparisons of related pointers using a powerful, recursive
3301 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003302 if (LHS->getType()->isPointerTy())
Anna Thomas43d7e1c2016-05-03 14:58:21 +00003303 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI, LHS, RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003304 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003305 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3306 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3307 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3308 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3309 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3310 Q.DL.getTypeSizeInBits(CRHS->getType()))
3311 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI,
3312 CLHS->getPointerOperand(),
3313 CRHS->getPointerOperand()))
3314 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003315
Nick Lewycky3db143e2012-02-26 02:09:49 +00003316 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3317 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3318 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3319 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3320 (ICmpInst::isEquality(Pred) ||
3321 (GLHS->isInBounds() && GRHS->isInBounds() &&
3322 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3323 // The bases are equal and the indices are constant. Build a constant
3324 // expression GEP with the same indices and a null base pointer to see
3325 // what constant folding can make out of it.
3326 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3327 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003328 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3329 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003330
3331 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003332 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3333 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003334 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3335 }
3336 }
3337 }
3338
David Majnemer5854e9f2014-11-16 02:20:08 +00003339 // If a bit is known to be zero for A and known to be one for B,
3340 // then A and B cannot be equal.
3341 if (ICmpInst::isEquality(Pred)) {
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003342 const APInt *RHSVal;
3343 if (match(RHS, m_APInt(RHSVal))) {
3344 unsigned BitWidth = RHSVal->getBitWidth();
David Majnemer5854e9f2014-11-16 02:20:08 +00003345 APInt LHSKnownZero(BitWidth, 0);
3346 APInt LHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003347 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, Q.DL, /*Depth=*/0, Q.AC,
David Majnemer5854e9f2014-11-16 02:20:08 +00003348 Q.CxtI, Q.DT);
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003349 if (((LHSKnownZero & *RHSVal) != 0) || ((LHSKnownOne & ~(*RHSVal)) != 0))
3350 return Pred == ICmpInst::ICMP_EQ ? ConstantInt::getFalse(ITy)
3351 : ConstantInt::getTrue(ITy);
David Majnemer5854e9f2014-11-16 02:20:08 +00003352 }
3353 }
3354
Duncan Sandsf532d312010-11-07 16:12:23 +00003355 // If the comparison is with the result of a select instruction, check whether
3356 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003357 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003358 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003359 return V;
3360
3361 // If the comparison is with the result of a phi instruction, check whether
3362 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003363 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003364 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003365 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003366
Craig Topper9f008862014-04-15 04:59:12 +00003367 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003368}
3369
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003370Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003371 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00003372 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003373 const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth85dbea92015-12-24 09:08:08 +00003374 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003375 return ::SimplifyICmpInst(Predicate, LHS, RHS, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003376 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003377}
3378
Sanjay Patel472cc782016-01-11 22:14:42 +00003379/// Given operands for an FCmpInst, see if we can fold the result.
3380/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003381static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003382 FastMathFlags FMF, const Query &Q,
3383 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003384 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3385 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3386
Chris Lattnera71e9d62009-11-10 00:55:12 +00003387 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003388 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003389 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003390
Chris Lattnera71e9d62009-11-10 00:55:12 +00003391 // If we have a constant, make sure it is on the RHS.
3392 std::swap(LHS, RHS);
3393 Pred = CmpInst::getSwappedPredicate(Pred);
3394 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003395
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003396 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003397 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003398 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003399 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003400 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003401 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003402
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003403 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3404 if (FMF.noNaNs()) {
3405 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003406 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003407 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003408 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003409 }
3410
Mehdi Aminieb242a52015-03-09 03:20:25 +00003411 // fcmp pred x, undef and fcmp pred undef, x
3412 // fold to true if unordered, false if ordered
3413 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3414 // Choosing NaN for the undef will always make unordered comparison succeed
3415 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003416 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003417 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003418
3419 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003420 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003421 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003422 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003423 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003424 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003425 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003426
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003427 // Handle fcmp with constant RHS
David Majnemer3ee5f342016-04-13 06:55:52 +00003428 const ConstantFP *CFP = nullptr;
3429 if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3430 if (RHS->getType()->isVectorTy())
3431 CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3432 else
3433 CFP = dyn_cast<ConstantFP>(RHSC);
3434 }
3435 if (CFP) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003436 // If the constant is a nan, see if we can fold the comparison based on it.
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003437 if (CFP->getValueAPF().isNaN()) {
3438 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003439 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003440 assert(FCmpInst::isUnordered(Pred) &&
3441 "Comparison must be either ordered or unordered!");
3442 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003443 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003444 }
3445 // Check whether the constant is an infinity.
3446 if (CFP->getValueAPF().isInfinity()) {
3447 if (CFP->getValueAPF().isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003448 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003449 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003450 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003451 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003452 case FCmpInst::FCMP_UGE:
3453 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003454 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003455 default:
3456 break;
3457 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003458 } else {
3459 switch (Pred) {
3460 case FCmpInst::FCMP_OGT:
3461 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003462 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003463 case FCmpInst::FCMP_ULE:
3464 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003465 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003466 default:
3467 break;
3468 }
3469 }
3470 }
3471 if (CFP->getValueAPF().isZero()) {
3472 switch (Pred) {
3473 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003474 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003475 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003476 break;
3477 case FCmpInst::FCMP_OLT:
3478 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003479 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003480 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003481 break;
3482 default:
3483 break;
3484 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003485 }
3486 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003487
Duncan Sandsa620bd12010-11-07 16:46:25 +00003488 // If the comparison is with the result of a select instruction, check whether
3489 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003490 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003491 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003492 return V;
3493
3494 // If the comparison is with the result of a phi instruction, check whether
3495 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003496 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003497 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003498 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003499
Craig Topper9f008862014-04-15 04:59:12 +00003500 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003501}
3502
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003503Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003504 FastMathFlags FMF, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00003505 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003506 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00003507 const Instruction *CxtI) {
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003508 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003509 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003510}
3511
Sanjay Patel472cc782016-01-11 22:14:42 +00003512/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003513static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
3514 const Query &Q,
3515 unsigned MaxRecurse) {
3516 // Trivial replacement.
3517 if (V == Op)
3518 return RepOp;
3519
3520 auto *I = dyn_cast<Instruction>(V);
3521 if (!I)
3522 return nullptr;
3523
3524 // If this is a binary operator, try to simplify it with the replaced op.
3525 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3526 // Consider:
3527 // %cmp = icmp eq i32 %x, 2147483647
3528 // %add = add nsw i32 %x, 1
3529 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3530 //
3531 // We can't replace %sel with %add unless we strip away the flags.
3532 if (isa<OverflowingBinaryOperator>(B))
3533 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3534 return nullptr;
3535 if (isa<PossiblyExactOperator>(B))
3536 if (B->isExact())
3537 return nullptr;
3538
3539 if (MaxRecurse) {
3540 if (B->getOperand(0) == Op)
3541 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3542 MaxRecurse - 1);
3543 if (B->getOperand(1) == Op)
3544 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3545 MaxRecurse - 1);
3546 }
3547 }
3548
3549 // Same for CmpInsts.
3550 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3551 if (MaxRecurse) {
3552 if (C->getOperand(0) == Op)
3553 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3554 MaxRecurse - 1);
3555 if (C->getOperand(1) == Op)
3556 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3557 MaxRecurse - 1);
3558 }
3559 }
3560
3561 // TODO: We could hand off more cases to instsimplify here.
3562
3563 // If all operands are constant after substituting Op for RepOp then we can
3564 // constant fold the instruction.
3565 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3566 // Build a list of all constant operands.
3567 SmallVector<Constant *, 8> ConstOps;
3568 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3569 if (I->getOperand(i) == Op)
3570 ConstOps.push_back(CRepOp);
3571 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3572 ConstOps.push_back(COp);
3573 else
3574 break;
3575 }
3576
3577 // All operands were constants, fold it.
3578 if (ConstOps.size() == I->getNumOperands()) {
3579 if (CmpInst *C = dyn_cast<CmpInst>(I))
3580 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3581 ConstOps[1], Q.DL, Q.TLI);
3582
3583 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3584 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003585 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003586
Manuel Jacobe9024592016-01-21 06:33:22 +00003587 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003588 }
3589 }
3590
3591 return nullptr;
3592}
3593
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003594/// Try to simplify a select instruction when its condition operand is an
3595/// integer comparison where one operand of the compare is a constant.
3596static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3597 const APInt *Y, bool TrueWhenUnset) {
3598 const APInt *C;
3599
3600 // (X & Y) == 0 ? X & ~Y : X --> X
3601 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3602 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3603 *Y == ~*C)
3604 return TrueWhenUnset ? FalseVal : TrueVal;
3605
3606 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3607 // (X & Y) != 0 ? X : X & ~Y --> X
3608 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3609 *Y == ~*C)
3610 return TrueWhenUnset ? FalseVal : TrueVal;
3611
3612 if (Y->isPowerOf2()) {
3613 // (X & Y) == 0 ? X | Y : X --> X | Y
3614 // (X & Y) != 0 ? X | Y : X --> X
3615 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3616 *Y == *C)
3617 return TrueWhenUnset ? TrueVal : FalseVal;
3618
3619 // (X & Y) == 0 ? X : X | Y --> X
3620 // (X & Y) != 0 ? X : X | Y --> X | Y
3621 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3622 *Y == *C)
3623 return TrueWhenUnset ? TrueVal : FalseVal;
3624 }
Matt Arsenault82606662017-01-11 00:57:54 +00003625
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003626 return nullptr;
3627}
3628
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003629/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3630/// eq/ne.
3631static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *TrueVal,
3632 Value *FalseVal,
3633 bool TrueWhenUnset) {
3634 unsigned BitWidth = TrueVal->getType()->getScalarSizeInBits();
Sanjay Patele9fc79b2016-07-21 21:56:00 +00003635 if (!BitWidth)
3636 return nullptr;
Matt Arsenault82606662017-01-11 00:57:54 +00003637
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003638 APInt MinSignedValue;
3639 Value *X;
3640 if (match(CmpLHS, m_Trunc(m_Value(X))) && (X == TrueVal || X == FalseVal)) {
3641 // icmp slt (trunc X), 0 <--> icmp ne (and X, C), 0
3642 // icmp sgt (trunc X), -1 <--> icmp eq (and X, C), 0
3643 unsigned DestSize = CmpLHS->getType()->getScalarSizeInBits();
3644 MinSignedValue = APInt::getSignedMinValue(DestSize).zext(BitWidth);
3645 } else {
3646 // icmp slt X, 0 <--> icmp ne (and X, C), 0
3647 // icmp sgt X, -1 <--> icmp eq (and X, C), 0
3648 X = CmpLHS;
3649 MinSignedValue = APInt::getSignedMinValue(BitWidth);
3650 }
3651
3652 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, &MinSignedValue,
3653 TrueWhenUnset))
3654 return V;
3655
3656 return nullptr;
3657}
3658
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003659/// Try to simplify a select instruction when its condition operand is an
3660/// integer comparison.
3661static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
3662 Value *FalseVal, const Query &Q,
3663 unsigned MaxRecurse) {
3664 ICmpInst::Predicate Pred;
3665 Value *CmpLHS, *CmpRHS;
3666 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3667 return nullptr;
3668
Sanjay Patel5f3c7032016-07-20 23:40:01 +00003669 // FIXME: This code is nearly duplicated in InstCombine. Using/refactoring
3670 // decomposeBitTestICmp() might help.
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003671 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3672 Value *X;
3673 const APInt *Y;
3674 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3675 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3676 Pred == ICmpInst::ICMP_EQ))
3677 return V;
3678 } else if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, m_Zero())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003679 // Comparing signed-less-than 0 checks if the sign bit is set.
3680 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3681 false))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003682 return V;
3683 } else if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, m_AllOnes())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003684 // Comparing signed-greater-than -1 checks if the sign bit is not set.
3685 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3686 true))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003687 return V;
3688 }
3689
3690 if (CondVal->hasOneUse()) {
3691 const APInt *C;
3692 if (match(CmpRHS, m_APInt(C))) {
3693 // X < MIN ? T : F --> F
3694 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3695 return FalseVal;
3696 // X < MIN ? T : F --> F
3697 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3698 return FalseVal;
3699 // X > MAX ? T : F --> F
3700 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3701 return FalseVal;
3702 // X > MAX ? T : F --> F
3703 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3704 return FalseVal;
3705 }
3706 }
3707
3708 // If we have an equality comparison, then we know the value in one of the
3709 // arms of the select. See if substituting this value into the arm and
3710 // simplifying the result yields the same value as the other arm.
3711 if (Pred == ICmpInst::ICMP_EQ) {
3712 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3713 TrueVal ||
3714 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3715 TrueVal)
3716 return FalseVal;
3717 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3718 FalseVal ||
3719 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3720 FalseVal)
3721 return FalseVal;
3722 } else if (Pred == ICmpInst::ICMP_NE) {
3723 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3724 FalseVal ||
3725 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3726 FalseVal)
3727 return TrueVal;
3728 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3729 TrueVal ||
3730 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3731 TrueVal)
3732 return TrueVal;
3733 }
3734
3735 return nullptr;
3736}
3737
Sanjay Patel472cc782016-01-11 22:14:42 +00003738/// Given operands for a SelectInst, see if we can fold the result.
3739/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003740static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
3741 Value *FalseVal, const Query &Q,
3742 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003743 // select true, X, Y -> X
3744 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003745 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3746 if (CB->isAllOnesValue())
3747 return TrueVal;
3748 if (CB->isNullValue())
3749 return FalseVal;
3750 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003751
Chris Lattnerc707fa92010-04-20 05:32:14 +00003752 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003753 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003754 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003755
Chris Lattnerc707fa92010-04-20 05:32:14 +00003756 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
3757 if (isa<Constant>(TrueVal))
3758 return TrueVal;
3759 return FalseVal;
3760 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003761 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3762 return FalseVal;
3763 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3764 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003765
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003766 if (Value *V =
3767 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3768 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003769
Craig Topper9f008862014-04-15 04:59:12 +00003770 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003771}
3772
Duncan Sandsb8cee002012-03-13 11:42:19 +00003773Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003774 const DataLayout &DL,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003775 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003776 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00003777 const Instruction *CxtI) {
3778 return ::SimplifySelectInst(Cond, TrueVal, FalseVal,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003779 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003780}
3781
Sanjay Patel472cc782016-01-11 22:14:42 +00003782/// Given operands for an GetElementPtrInst, see if we can fold the result.
3783/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003784static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3785 const Query &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003786 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003787 unsigned AS =
3788 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003789
Chris Lattner8574aba2009-11-27 00:29:05 +00003790 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003791 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003792 return Ops[0];
3793
Nico Weber48c82402014-08-27 20:06:19 +00003794 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003795 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003796 Type *GEPTy = PointerType::get(LastType, AS);
3797 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3798 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003799 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3800 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003801
3802 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003803 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003804
Jay Foadb992a632011-07-19 15:07:52 +00003805 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003806 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003807 if (match(Ops[1], m_Zero()))
3808 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003809
David Blaikie4a2e73b2015-04-02 18:55:32 +00003810 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003811 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003812 Value *P;
3813 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003814 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003815 // getelementptr P, N -> P if P points to a type of zero size.
3816 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003817 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003818
3819 // The following transforms are only safe if the ptrtoint cast
3820 // doesn't truncate the pointers.
3821 if (Ops[1]->getType()->getScalarSizeInBits() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003822 Q.DL.getPointerSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003823 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3824 if (match(P, m_Zero()))
3825 return Constant::getNullValue(GEPTy);
3826 Value *Temp;
3827 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003828 if (Temp->getType() == GEPTy)
3829 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003830 return nullptr;
3831 };
3832
3833 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3834 if (TyAllocSize == 1 &&
3835 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3836 if (Value *R = PtrToIntOrZero(P))
3837 return R;
3838
3839 // getelementptr V, (ashr (sub P, V), C) -> Q
3840 // if P points to a type of size 1 << C.
3841 if (match(Ops[1],
3842 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3843 m_ConstantInt(C))) &&
3844 TyAllocSize == 1ULL << C)
3845 if (Value *R = PtrToIntOrZero(P))
3846 return R;
3847
3848 // getelementptr V, (sdiv (sub P, V), C) -> Q
3849 // if P points to a type of size C.
3850 if (match(Ops[1],
3851 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3852 m_SpecificInt(TyAllocSize))))
3853 if (Value *R = PtrToIntOrZero(P))
3854 return R;
3855 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003856 }
3857 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003858
David Majnemerd1501372016-08-07 07:58:12 +00003859 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3860 all_of(Ops.slice(1).drop_back(1),
3861 [](Value *Idx) { return match(Idx, m_Zero()); })) {
3862 unsigned PtrWidth =
3863 Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3864 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3865 APInt BasePtrOffset(PtrWidth, 0);
3866 Value *StrippedBasePtr =
3867 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3868 BasePtrOffset);
3869
David Majnemer5c5df622016-08-16 06:13:46 +00003870 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003871 if (match(Ops.back(),
3872 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3873 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3874 return ConstantExpr::getIntToPtr(CI, GEPTy);
3875 }
David Majnemer5c5df622016-08-16 06:13:46 +00003876 // gep (gep V, C), (xor V, -1) -> C-1
3877 if (match(Ops.back(),
3878 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3879 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3880 return ConstantExpr::getIntToPtr(CI, GEPTy);
3881 }
David Majnemerd1501372016-08-07 07:58:12 +00003882 }
3883 }
3884
Chris Lattner8574aba2009-11-27 00:29:05 +00003885 // Check to see if this is constant foldable.
Jay Foadb992a632011-07-19 15:07:52 +00003886 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Chris Lattner8574aba2009-11-27 00:29:05 +00003887 if (!isa<Constant>(Ops[i]))
Craig Topper9f008862014-04-15 04:59:12 +00003888 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003889
David Blaikie4a2e73b2015-04-02 18:55:32 +00003890 return ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3891 Ops.slice(1));
Chris Lattner8574aba2009-11-27 00:29:05 +00003892}
3893
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003894Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3895 const DataLayout &DL,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003896 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003897 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00003898 const Instruction *CxtI) {
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003899 return ::SimplifyGEPInst(SrcTy, Ops,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003900 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003901}
3902
Sanjay Patel472cc782016-01-11 22:14:42 +00003903/// Given operands for an InsertValueInst, see if we can fold the result.
3904/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003905static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3906 ArrayRef<unsigned> Idxs, const Query &Q,
3907 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003908 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3909 if (Constant *CVal = dyn_cast<Constant>(Val))
3910 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3911
3912 // insertvalue x, undef, n -> x
3913 if (match(Val, m_Undef()))
3914 return Agg;
3915
3916 // insertvalue x, (extractvalue y, n), n
3917 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003918 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3919 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003920 // insertvalue undef, (extractvalue y, n), n -> y
3921 if (match(Agg, m_Undef()))
3922 return EV->getAggregateOperand();
3923
3924 // insertvalue y, (extractvalue y, n), n -> y
3925 if (Agg == EV->getAggregateOperand())
3926 return Agg;
3927 }
3928
Craig Topper9f008862014-04-15 04:59:12 +00003929 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003930}
3931
Chandler Carruth66b31302015-01-04 12:03:27 +00003932Value *llvm::SimplifyInsertValueInst(
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003933 Value *Agg, Value *Val, ArrayRef<unsigned> Idxs, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003934 const TargetLibraryInfo *TLI, const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth66b31302015-01-04 12:03:27 +00003935 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003936 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003937 RecursionLimit);
3938}
3939
Sanjay Patel472cc782016-01-11 22:14:42 +00003940/// Given operands for an ExtractValueInst, see if we can fold the result.
3941/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003942static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3943 const Query &, unsigned) {
3944 if (auto *CAgg = dyn_cast<Constant>(Agg))
3945 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3946
3947 // extractvalue x, (insertvalue y, elt, n), n -> elt
3948 unsigned NumIdxs = Idxs.size();
3949 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3950 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3951 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3952 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3953 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3954 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3955 Idxs.slice(0, NumCommonIdxs)) {
3956 if (NumIdxs == NumInsertValueIdxs)
3957 return IVI->getInsertedValueOperand();
3958 break;
3959 }
3960 }
3961
3962 return nullptr;
3963}
3964
3965Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3966 const DataLayout &DL,
3967 const TargetLibraryInfo *TLI,
3968 const DominatorTree *DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003969 AssumptionCache *AC,
David Majnemer25a796e2015-07-13 01:15:46 +00003970 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003971 return ::SimplifyExtractValueInst(Agg, Idxs, Query(DL, TLI, DT, AC, CxtI),
David Majnemer25a796e2015-07-13 01:15:46 +00003972 RecursionLimit);
3973}
3974
Sanjay Patel472cc782016-01-11 22:14:42 +00003975/// Given operands for an ExtractElementInst, see if we can fold the result.
3976/// If not, this returns null.
David Majnemer599ca442015-07-13 01:15:53 +00003977static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const Query &,
3978 unsigned) {
3979 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3980 if (auto *CIdx = dyn_cast<Constant>(Idx))
3981 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3982
3983 // The index is not relevant if our vector is a splat.
3984 if (auto *Splat = CVec->getSplatValue())
3985 return Splat;
3986
3987 if (isa<UndefValue>(Vec))
3988 return UndefValue::get(Vec->getType()->getVectorElementType());
3989 }
3990
3991 // If extracting a specified index from the vector, see if we can recursively
3992 // find a previously computed scalar that was inserted into the vector.
David Majnemer8e335ca2015-08-18 22:18:22 +00003993 if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3994 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
David Majnemer599ca442015-07-13 01:15:53 +00003995 return Elt;
David Majnemer599ca442015-07-13 01:15:53 +00003996
3997 return nullptr;
3998}
3999
4000Value *llvm::SimplifyExtractElementInst(
4001 Value *Vec, Value *Idx, const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004002 const DominatorTree *DT, AssumptionCache *AC, const Instruction *CxtI) {
4003 return ::SimplifyExtractElementInst(Vec, Idx, Query(DL, TLI, DT, AC, CxtI),
David Majnemer599ca442015-07-13 01:15:53 +00004004 RecursionLimit);
4005}
4006
Sanjay Patel472cc782016-01-11 22:14:42 +00004007/// See if we can fold the given phi. If not, returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00004008static Value *SimplifyPHINode(PHINode *PN, const Query &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004009 // If all of the PHI's incoming values are the same then replace the PHI node
4010 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00004011 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004012 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00004013 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004014 // If the incoming value is the phi node itself, it can safely be skipped.
4015 if (Incoming == PN) continue;
4016 if (isa<UndefValue>(Incoming)) {
4017 // Remember that we saw an undef value, but otherwise ignore them.
4018 HasUndefInput = true;
4019 continue;
4020 }
4021 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00004022 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00004023 CommonValue = Incoming;
4024 }
4025
4026 // If CommonValue is null then all of the incoming values were either undef or
4027 // equal to the phi node itself.
4028 if (!CommonValue)
4029 return UndefValue::get(PN->getType());
4030
4031 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4032 // instruction, we cannot return X as the result of the PHI node unless it
4033 // dominates the PHI block.
4034 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00004035 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004036
4037 return CommonValue;
4038}
4039
David Majnemer6774d612016-07-26 17:58:05 +00004040static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
4041 Type *Ty, const Query &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004042 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004043 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004044
David Majnemer6774d612016-07-26 17:58:05 +00004045 if (auto *CI = dyn_cast<CastInst>(Op)) {
4046 auto *Src = CI->getOperand(0);
4047 Type *SrcTy = Src->getType();
4048 Type *MidTy = CI->getType();
4049 Type *DstTy = Ty;
4050 if (Src->getType() == Ty) {
4051 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4052 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4053 Type *SrcIntPtrTy =
4054 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4055 Type *MidIntPtrTy =
4056 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4057 Type *DstIntPtrTy =
4058 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4059 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4060 SrcIntPtrTy, MidIntPtrTy,
4061 DstIntPtrTy) == Instruction::BitCast)
4062 return Src;
4063 }
4064 }
David Majnemera90a6212016-07-26 05:52:29 +00004065
4066 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004067 if (CastOpc == Instruction::BitCast)
4068 if (Op->getType() == Ty)
4069 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004070
4071 return nullptr;
4072}
4073
David Majnemer6774d612016-07-26 17:58:05 +00004074Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
4075 const DataLayout &DL,
4076 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004077 const DominatorTree *DT, AssumptionCache *AC,
David Majnemer6774d612016-07-26 17:58:05 +00004078 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004079 return ::SimplifyCastInst(CastOpc, Op, Ty, Query(DL, TLI, DT, AC, CxtI),
David Majnemer6774d612016-07-26 17:58:05 +00004080 RecursionLimit);
David Majnemera90a6212016-07-26 05:52:29 +00004081}
4082
Zvi Rackover8f460652017-04-03 22:05:30 +00004083static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4084 Type *RetTy, const Query &Q,
4085 unsigned MaxRecurse) {
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004086 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004087 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004088 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004089
4090 auto *Op0Const = dyn_cast<Constant>(Op0);
4091 auto *Op1Const = dyn_cast<Constant>(Op1);
4092
4093 // If all operands are constant, constant fold the shuffle.
4094 if (Op0Const && Op1Const)
4095 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4096
4097 // If only one of the operands is constant, constant fold the shuffle if the
4098 // mask does not select elements from the variable operand.
4099 bool MaskSelects0 = false, MaskSelects1 = false;
4100 for (unsigned i = 0; i != MaskNumElts; ++i) {
4101 int Idx = ShuffleVectorInst::getMaskValue(Mask, i);
4102 if (Idx == -1)
4103 continue;
4104 if ((unsigned)Idx < InVecNumElts)
4105 MaskSelects0 = true;
4106 else
4107 MaskSelects1 = true;
4108 }
4109 if (!MaskSelects0 && Op1Const)
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004110 return ConstantFoldShuffleVectorInstruction(UndefValue::get(InVecTy),
Zvi Rackover8f460652017-04-03 22:05:30 +00004111 Op1Const, Mask);
4112 if (!MaskSelects1 && Op0Const)
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004113 return ConstantFoldShuffleVectorInstruction(Op0Const,
4114 UndefValue::get(InVecTy), Mask);
4115
4116 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4117 // value type is same as the input vectors' type.
4118 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
4119 if (!MaskSelects1 && RetTy == InVecTy &&
4120 OpShuf->getMask()->getSplatValue())
4121 return Op0;
4122 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op1))
4123 if (!MaskSelects0 && RetTy == InVecTy &&
4124 OpShuf->getMask()->getSplatValue())
4125 return Op1;
Zvi Rackover8f460652017-04-03 22:05:30 +00004126
4127 return nullptr;
4128}
4129
4130/// Given operands for a ShuffleVectorInst, fold the result or return null.
4131Value *llvm::SimplifyShuffleVectorInst(
4132 Value *Op0, Value *Op1, Constant *Mask, Type *RetTy,
4133 const DataLayout &DL, const TargetLibraryInfo *TLI, const DominatorTree *DT,
4134 AssumptionCache *AC, const Instruction *CxtI) {
4135 return ::SimplifyShuffleVectorInst(
4136 Op0, Op1, Mask, RetTy, Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
4137}
4138
Chris Lattnera71e9d62009-11-10 00:55:12 +00004139//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004140
Sanjay Patel472cc782016-01-11 22:14:42 +00004141/// Given operands for a BinaryOperator, see if we can fold the result.
4142/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004143static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +00004144 const Query &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004145 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004146 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004147 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004148 case Instruction::FAdd:
4149 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004150 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004151 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004152 case Instruction::FSub:
4153 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004154 case Instruction::Mul:
4155 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004156 case Instruction::FMul:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004157 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4158 case Instruction::SDiv:
4159 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4160 case Instruction::UDiv:
4161 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004162 case Instruction::FDiv:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004163 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4164 case Instruction::SRem:
4165 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4166 case Instruction::URem:
4167 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004168 case Instruction::FRem:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004169 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004170 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004171 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004172 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004173 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004174 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004175 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4176 case Instruction::And:
4177 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4178 case Instruction::Or:
4179 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4180 case Instruction::Xor:
4181 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004182 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004183 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004184 }
4185}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004186
Sanjay Patel472cc782016-01-11 22:14:42 +00004187/// Given operands for a BinaryOperator, see if we can fold the result.
4188/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004189/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4190/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4191static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4192 const FastMathFlags &FMF, const Query &Q,
4193 unsigned MaxRecurse) {
4194 switch (Opcode) {
4195 case Instruction::FAdd:
4196 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4197 case Instruction::FSub:
4198 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4199 case Instruction::FMul:
4200 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004201 case Instruction::FDiv:
4202 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004203 default:
4204 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4205 }
4206}
4207
Duncan Sands7e800d62010-11-14 11:23:23 +00004208Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004209 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004210 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00004211 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004212 return ::SimplifyBinOp(Opcode, LHS, RHS, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00004213 RecursionLimit);
Chris Lattnerc1f19072009-11-09 23:28:39 +00004214}
4215
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004216Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004217 const FastMathFlags &FMF, const DataLayout &DL,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004218 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004219 const DominatorTree *DT, AssumptionCache *AC,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004220 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004221 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Query(DL, TLI, DT, AC, CxtI),
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004222 RecursionLimit);
4223}
4224
Sanjay Patel472cc782016-01-11 22:14:42 +00004225/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004226static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +00004227 const Query &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004228 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004229 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004230 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004231}
4232
4233Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004234 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004235 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00004236 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004237 return ::SimplifyCmpInst(Predicate, LHS, RHS, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00004238 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004239}
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004240
Michael Ilseman54857292013-02-07 19:26:05 +00004241static bool IsIdempotent(Intrinsic::ID ID) {
4242 switch (ID) {
4243 default: return false;
4244
4245 // Unary idempotent: f(f(x)) = f(x)
4246 case Intrinsic::fabs:
4247 case Intrinsic::floor:
4248 case Intrinsic::ceil:
4249 case Intrinsic::trunc:
4250 case Intrinsic::rint:
4251 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004252 case Intrinsic::round:
Michael Ilseman54857292013-02-07 19:26:05 +00004253 return true;
4254 }
4255}
4256
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004257static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4258 const DataLayout &DL) {
4259 GlobalValue *PtrSym;
4260 APInt PtrOffset;
4261 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4262 return nullptr;
4263
4264 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4265 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4266 Type *Int32PtrTy = Int32Ty->getPointerTo();
4267 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4268
4269 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4270 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4271 return nullptr;
4272
4273 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4274 if (OffsetInt % 4 != 0)
4275 return nullptr;
4276
4277 Constant *C = ConstantExpr::getGetElementPtr(
4278 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4279 ConstantInt::get(Int64Ty, OffsetInt / 4));
4280 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4281 if (!Loaded)
4282 return nullptr;
4283
4284 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4285 if (!LoadedCE)
4286 return nullptr;
4287
4288 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4289 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4290 if (!LoadedCE)
4291 return nullptr;
4292 }
4293
4294 if (LoadedCE->getOpcode() != Instruction::Sub)
4295 return nullptr;
4296
4297 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4298 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4299 return nullptr;
4300 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4301
4302 Constant *LoadedRHS = LoadedCE->getOperand(1);
4303 GlobalValue *LoadedRHSSym;
4304 APInt LoadedRHSOffset;
4305 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4306 DL) ||
4307 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4308 return nullptr;
4309
4310 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4311}
4312
David Majnemer17a95aa2016-07-14 06:58:37 +00004313static bool maskIsAllZeroOrUndef(Value *Mask) {
4314 auto *ConstMask = dyn_cast<Constant>(Mask);
4315 if (!ConstMask)
4316 return false;
4317 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4318 return true;
4319 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4320 ++I) {
4321 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4322 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4323 continue;
4324 return false;
4325 }
4326 return true;
4327}
4328
Michael Ilseman54857292013-02-07 19:26:05 +00004329template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004330static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Michael Ilseman54857292013-02-07 19:26:05 +00004331 const Query &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004332 Intrinsic::ID IID = F->getIntrinsicID();
4333 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004334
4335 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004336 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004337 // Perform idempotent optimizations
4338 if (IsIdempotent(IID)) {
4339 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4340 if (II->getIntrinsicID() == IID)
4341 return II;
4342 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004343 }
4344
4345 switch (IID) {
4346 case Intrinsic::fabs: {
4347 if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4348 return *ArgBegin;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004349 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004350 }
4351 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004352 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004353 }
4354 }
Michael Ilseman54857292013-02-07 19:26:05 +00004355
Matt Arsenault82606662017-01-11 00:57:54 +00004356 // Binary Ops
4357 if (NumOperands == 2) {
4358 Value *LHS = *ArgBegin;
4359 Value *RHS = *(ArgBegin + 1);
4360 Type *ReturnType = F->getReturnType();
4361
4362 switch (IID) {
4363 case Intrinsic::usub_with_overflow:
4364 case Intrinsic::ssub_with_overflow: {
4365 // X - X -> { 0, false }
4366 if (LHS == RHS)
4367 return Constant::getNullValue(ReturnType);
4368
4369 // X - undef -> undef
4370 // undef - X -> undef
4371 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4372 return UndefValue::get(ReturnType);
4373
4374 return nullptr;
4375 }
4376 case Intrinsic::uadd_with_overflow:
4377 case Intrinsic::sadd_with_overflow: {
4378 // X + undef -> undef
4379 if (isa<UndefValue>(RHS))
4380 return UndefValue::get(ReturnType);
4381
4382 return nullptr;
4383 }
4384 case Intrinsic::umul_with_overflow:
4385 case Intrinsic::smul_with_overflow: {
4386 // X * 0 -> { 0, false }
4387 if (match(RHS, m_Zero()))
4388 return Constant::getNullValue(ReturnType);
4389
4390 // X * undef -> { 0, false }
4391 if (match(RHS, m_Undef()))
4392 return Constant::getNullValue(ReturnType);
4393
4394 return nullptr;
4395 }
4396 case Intrinsic::load_relative: {
4397 Constant *C0 = dyn_cast<Constant>(LHS);
4398 Constant *C1 = dyn_cast<Constant>(RHS);
4399 if (C0 && C1)
4400 return SimplifyRelativeLoad(C0, C1, Q.DL);
4401 return nullptr;
4402 }
4403 default:
4404 return nullptr;
4405 }
4406 }
4407
4408 // Simplify calls to llvm.masked.load.*
4409 switch (IID) {
4410 case Intrinsic::masked_load: {
4411 Value *MaskArg = ArgBegin[2];
4412 Value *PassthruArg = ArgBegin[3];
4413 // If the mask is all zeros or undef, the "passthru" argument is the result.
4414 if (maskIsAllZeroOrUndef(MaskArg))
4415 return PassthruArg;
4416 return nullptr;
4417 }
4418 default:
4419 return nullptr;
4420 }
Michael Ilseman54857292013-02-07 19:26:05 +00004421}
4422
Chandler Carruth9dc35582012-12-28 11:30:55 +00004423template <typename IterTy>
Chandler Carruthf6182152012-12-28 14:23:29 +00004424static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
Chandler Carruth9dc35582012-12-28 11:30:55 +00004425 const Query &Q, unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004426 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004427 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4428 Ty = PTy->getElementType();
4429 FunctionType *FTy = cast<FunctionType>(Ty);
4430
Dan Gohman85977e62011-11-04 18:32:42 +00004431 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004432 // call null -> undef
4433 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004434 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004435
Chandler Carruthf6182152012-12-28 14:23:29 +00004436 Function *F = dyn_cast<Function>(V);
4437 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004438 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004439
David Majnemer15032582015-05-22 03:56:46 +00004440 if (F->isIntrinsic())
4441 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004442 return Ret;
4443
Chandler Carruthf6182152012-12-28 14:23:29 +00004444 if (!canConstantFoldCallTo(F))
Craig Topper9f008862014-04-15 04:59:12 +00004445 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004446
4447 SmallVector<Constant *, 4> ConstantArgs;
4448 ConstantArgs.reserve(ArgEnd - ArgBegin);
4449 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4450 Constant *C = dyn_cast<Constant>(*I);
4451 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004452 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004453 ConstantArgs.push_back(C);
4454 }
4455
4456 return ConstantFoldCall(F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004457}
4458
Chandler Carruthf6182152012-12-28 14:23:29 +00004459Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004460 User::op_iterator ArgEnd, const DataLayout &DL,
Chandler Carruth66b31302015-01-04 12:03:27 +00004461 const TargetLibraryInfo *TLI, const DominatorTree *DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004462 AssumptionCache *AC, const Instruction *CxtI) {
4463 return ::SimplifyCall(V, ArgBegin, ArgEnd, Query(DL, TLI, DT, AC, CxtI),
Chandler Carruth9dc35582012-12-28 11:30:55 +00004464 RecursionLimit);
4465}
4466
Chandler Carruthf6182152012-12-28 14:23:29 +00004467Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004468 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004469 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00004470 const Instruction *CxtI) {
4471 return ::SimplifyCall(V, Args.begin(), Args.end(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004472 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004473}
4474
Sanjay Patel472cc782016-01-11 22:14:42 +00004475/// See if we can compute a simplified version of this instruction.
4476/// If not, this returns null.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004477Value *llvm::SimplifyInstruction(Instruction *I, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00004478 const TargetLibraryInfo *TLI,
Sanjay Patel54656ca2017-02-06 18:26:06 +00004479 const DominatorTree *DT, AssumptionCache *AC,
4480 OptimizationRemarkEmitter *ORE) {
Duncan Sands64e41cf2010-11-17 08:35:29 +00004481 Value *Result;
4482
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004483 switch (I->getOpcode()) {
4484 default:
Rafael Espindola37dc9e12014-02-21 00:06:31 +00004485 Result = ConstantFoldInstruction(I, DL, TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004486 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004487 case Instruction::FAdd:
4488 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004489 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004490 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004491 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004492 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4493 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Chandler Carruth66b31302015-01-04 12:03:27 +00004494 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004495 TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004496 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004497 case Instruction::FSub:
4498 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004499 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004500 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004501 case Instruction::Sub:
4502 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4503 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Chandler Carruth66b31302015-01-04 12:03:27 +00004504 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004505 TLI, DT, AC, I);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004506 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004507 case Instruction::FMul:
4508 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004509 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004510 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004511 case Instruction::Mul:
Chandler Carruth66b31302015-01-04 12:03:27 +00004512 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004513 SimplifyMulInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004514 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004515 case Instruction::SDiv:
Chandler Carruth66b31302015-01-04 12:03:27 +00004516 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004517 AC, I);
Duncan Sands771e82a2011-01-28 16:51:11 +00004518 break;
4519 case Instruction::UDiv:
Chandler Carruth66b31302015-01-04 12:03:27 +00004520 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004521 AC, I);
Duncan Sands771e82a2011-01-28 16:51:11 +00004522 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004523 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004524 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004525 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Frits van Bommelc2549662011-01-29 15:26:31 +00004526 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004527 case Instruction::SRem:
Chandler Carruth66b31302015-01-04 12:03:27 +00004528 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004529 AC, I);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004530 break;
4531 case Instruction::URem:
Chandler Carruth66b31302015-01-04 12:03:27 +00004532 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004533 AC, I);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004534 break;
4535 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004536 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004537 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004538 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004539 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004540 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4541 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Chandler Carruth66b31302015-01-04 12:03:27 +00004542 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004543 TLI, DT, AC, I);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004544 break;
4545 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004546 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Chandler Carruth66b31302015-01-04 12:03:27 +00004547 cast<BinaryOperator>(I)->isExact(), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004548 AC, I);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004549 break;
4550 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004551 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Chandler Carruth66b31302015-01-04 12:03:27 +00004552 cast<BinaryOperator>(I)->isExact(), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004553 AC, I);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004554 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004555 case Instruction::And:
Chandler Carruth66b31302015-01-04 12:03:27 +00004556 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004557 SimplifyAndInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004558 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004559 case Instruction::Or:
Chandler Carruth66b31302015-01-04 12:03:27 +00004560 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004561 SimplifyOrInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004562 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004563 case Instruction::Xor:
Chandler Carruth66b31302015-01-04 12:03:27 +00004564 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004565 SimplifyXorInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004566 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004567 case Instruction::ICmp:
Chandler Carruth66b31302015-01-04 12:03:27 +00004568 Result =
4569 SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(), I->getOperand(0),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004570 I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004571 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004572 case Instruction::FCmp:
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004573 Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(),
4574 I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004575 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004576 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004577 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004578 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004579 I->getOperand(2), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004580 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004581 case Instruction::GetElementPtr: {
4582 SmallVector<Value*, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004583 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004584 Ops, DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004585 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004586 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004587 case Instruction::InsertValue: {
4588 InsertValueInst *IV = cast<InsertValueInst>(I);
4589 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4590 IV->getInsertedValueOperand(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004591 IV->getIndices(), DL, TLI, DT, AC, I);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004592 break;
4593 }
David Majnemer25a796e2015-07-13 01:15:46 +00004594 case Instruction::ExtractValue: {
4595 auto *EVI = cast<ExtractValueInst>(I);
4596 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004597 EVI->getIndices(), DL, TLI, DT, AC, I);
David Majnemer25a796e2015-07-13 01:15:46 +00004598 break;
4599 }
David Majnemer599ca442015-07-13 01:15:53 +00004600 case Instruction::ExtractElement: {
4601 auto *EEI = cast<ExtractElementInst>(I);
4602 Result = SimplifyExtractElementInst(
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004603 EEI->getVectorOperand(), EEI->getIndexOperand(), DL, TLI, DT, AC, I);
David Majnemer599ca442015-07-13 01:15:53 +00004604 break;
4605 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004606 case Instruction::ShuffleVector: {
4607 auto *SVI = cast<ShuffleVectorInst>(I);
4608 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
4609 SVI->getMask(), SVI->getType(), DL, TLI,
4610 DT, AC, I);
4611 break;
4612 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004613 case Instruction::PHI:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004614 Result = SimplifyPHINode(cast<PHINode>(I), Query(DL, TLI, DT, AC, I));
Duncan Sands64e41cf2010-11-17 08:35:29 +00004615 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004616 case Instruction::Call: {
4617 CallSite CS(cast<CallInst>(I));
Chandler Carruth66b31302015-01-04 12:03:27 +00004618 Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004619 TLI, DT, AC, I);
Dan Gohman85977e62011-11-04 18:32:42 +00004620 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004621 }
David Majnemer6774d612016-07-26 17:58:05 +00004622#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4623#include "llvm/IR/Instruction.def"
4624#undef HANDLE_CAST_INST
4625 Result = SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004626 DL, TLI, DT, AC, I);
David Majnemera90a6212016-07-26 05:52:29 +00004627 break;
Craig Topper81c03a72017-04-12 22:54:24 +00004628 case Instruction::Alloca:
4629 // No simplifications for Alloca and it can't be constant folded.
4630 Result = nullptr;
4631 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004632 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004633
Hal Finkelf2199b22015-10-23 20:37:08 +00004634 // In general, it is possible for computeKnownBits to determine all bits in a
4635 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004636 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Hal Finkelf2199b22015-10-23 20:37:08 +00004637 unsigned BitWidth = I->getType()->getScalarSizeInBits();
4638 APInt KnownZero(BitWidth, 0);
4639 APInt KnownOne(BitWidth, 0);
Sanjay Patel54656ca2017-02-06 18:26:06 +00004640 computeKnownBits(I, KnownZero, KnownOne, DL, /*Depth*/0, AC, I, DT, ORE);
Hal Finkelf2199b22015-10-23 20:37:08 +00004641 if ((KnownZero | KnownOne).isAllOnesValue())
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004642 Result = ConstantInt::get(I->getType(), KnownOne);
Hal Finkelf2199b22015-10-23 20:37:08 +00004643 }
4644
Duncan Sands64e41cf2010-11-17 08:35:29 +00004645 /// If called on unreachable code, the above logic may report that the
4646 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004647 /// detecting that case here, returning a safe value instead.
4648 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004649}
4650
Sanjay Patelf44bd382016-01-20 18:59:48 +00004651/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004652/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004653///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004654/// This is the common implementation of the recursive simplification routines.
4655/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4656/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4657/// instructions to process and attempt to simplify it using
4658/// InstructionSimplify.
4659///
4660/// This routine returns 'true' only when *it* simplifies something. The passed
4661/// in simplified value does not count toward this.
4662static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004663 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004664 const DominatorTree *DT,
4665 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004666 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004667 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004668 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004669
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004670 // If we have an explicit value to collapse to, do that round of the
4671 // simplification loop by hand initially.
4672 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004673 for (User *U : I->users())
4674 if (U != I)
4675 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004676
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004677 // Replace the instruction with its simplified value.
4678 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004679
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004680 // Gracefully handle edge cases where the instruction is not wired into any
4681 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004682 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4683 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004684 I->eraseFromParent();
4685 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004686 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004687 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004688
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004689 // Note that we must test the size on each iteration, the worklist can grow.
4690 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4691 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004692
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004693 // See if this instruction simplifies.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004694 SimpleV = SimplifyInstruction(I, DL, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004695 if (!SimpleV)
4696 continue;
4697
4698 Simplified = true;
4699
4700 // Stash away all the uses of the old instruction so we can check them for
4701 // recursive simplifications after a RAUW. This is cheaper than checking all
4702 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004703 for (User *U : I->users())
4704 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004705
4706 // Replace the instruction with its simplified value.
4707 I->replaceAllUsesWith(SimpleV);
4708
4709 // Gracefully handle edge cases where the instruction is not wired into any
4710 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004711 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4712 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004713 I->eraseFromParent();
4714 }
4715 return Simplified;
4716}
4717
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004718bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004719 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004720 const DominatorTree *DT,
4721 AssumptionCache *AC) {
4722 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004723}
4724
4725bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004726 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004727 const DominatorTree *DT,
4728 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004729 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4730 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004731 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004732}