blob: 0e522cb4e495c6e3f1ed2cb3d0b29f61d4b2bbea [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 Patel472cc782016-01-11 22:14:42 +000078/// For a boolean type, or a vector of boolean type, return false, or
Duncan Sandsc1c92712011-07-26 15:03:53 +000079/// a vector with every element false, as appropriate for the type.
80static Constant *getFalse(Type *Ty) {
Nick Lewyckye659b842011-12-01 02:39:36 +000081 assert(Ty->getScalarType()->isIntegerTy(1) &&
Duncan Sandsc1c92712011-07-26 15:03:53 +000082 "Expected i1 type or a vector of i1!");
83 return Constant::getNullValue(Ty);
84}
85
Sanjay Patel472cc782016-01-11 22:14:42 +000086/// For a boolean type, or a vector of boolean type, return true, or
Duncan Sandsc1c92712011-07-26 15:03:53 +000087/// a vector with every element true, as appropriate for the type.
88static Constant *getTrue(Type *Ty) {
Nick Lewyckye659b842011-12-01 02:39:36 +000089 assert(Ty->getScalarType()->isIntegerTy(1) &&
Duncan Sandsc1c92712011-07-26 15:03:53 +000090 "Expected i1 type or a vector of i1!");
91 return Constant::getAllOnesValue(Ty);
92}
93
Duncan Sands3d5692a2011-10-30 19:56:36 +000094/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
95static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
96 Value *RHS) {
97 CmpInst *Cmp = dyn_cast<CmpInst>(V);
98 if (!Cmp)
99 return false;
100 CmpInst::Predicate CPred = Cmp->getPredicate();
101 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
102 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
103 return true;
104 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
105 CRHS == LHS;
106}
107
Sanjay Patel472cc782016-01-11 22:14:42 +0000108/// Does the given value dominate the specified phi node?
Duncan Sands5ffc2982010-11-16 12:16:38 +0000109static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
110 Instruction *I = dyn_cast<Instruction>(V);
111 if (!I)
112 // Arguments and constants dominate all instructions.
113 return true;
114
Chandler Carruth3ffccb32012-03-21 10:58:47 +0000115 // If we are processing instructions (and/or basic blocks) that have not been
116 // fully added to a function, the parent nodes may still be null. Simply
117 // return the conservative answer in these cases.
118 if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
119 return false;
120
Duncan Sands5ffc2982010-11-16 12:16:38 +0000121 // If we have a DominatorTree then do a precise test.
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000122 if (DT) {
123 if (!DT->isReachableFromEntry(P->getParent()))
124 return true;
125 if (!DT->isReachableFromEntry(I->getParent()))
126 return false;
127 return DT->dominates(I, P);
128 }
Duncan Sands5ffc2982010-11-16 12:16:38 +0000129
David Majnemer8a1c45d2015-12-12 05:38:55 +0000130 // Otherwise, if the instruction is in the entry block and is not an invoke,
131 // then it obviously dominates all phi nodes.
Duncan Sands5ffc2982010-11-16 12:16:38 +0000132 if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000133 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000134 return true;
135
136 return false;
137}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000138
Sanjay Patel472cc782016-01-11 22:14:42 +0000139/// Simplify "A op (B op' C)" by distributing op over op', turning it into
140/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000141/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
142/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
143/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000144static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
145 Instruction::BinaryOps OpcodeToExpand, const Query &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +0000146 unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000147 // Recursion is always used, so bail out at once if we already hit the limit.
148 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000149 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000150
151 // Check whether the expression has the form "(A op' B) op C".
152 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
153 if (Op0->getOpcode() == OpcodeToExpand) {
154 // It does! Try turning it into "(A op C) op' (B op C)".
155 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
156 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000157 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
158 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000159 // They do! Return "L op' R" if it simplifies or is already available.
160 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000161 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
162 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000163 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000164 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000165 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000166 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000167 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000168 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000169 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000170 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000171 }
172 }
173
174 // Check whether the expression has the form "A op (B op' C)".
175 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
176 if (Op1->getOpcode() == OpcodeToExpand) {
177 // It does! Try turning it into "(A op B) op' (A op C)".
178 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
179 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000180 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
181 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000182 // They do! Return "L op' R" if it simplifies or is already available.
183 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000184 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
185 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000186 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000187 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000188 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000189 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000190 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000191 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000192 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000193 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000194 }
195 }
196
Craig Topper9f008862014-04-15 04:59:12 +0000197 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000198}
199
Sanjay Patel472cc782016-01-11 22:14:42 +0000200/// Generic simplifications for associative binary operations.
201/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000202static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
203 Value *LHS, Value *RHS, const Query &Q,
204 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000205 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
206
207 // Recursion is always used, so bail out at once if we already hit the limit.
208 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000209 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000210
211 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
212 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
213
214 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
215 if (Op0 && Op0->getOpcode() == Opcode) {
216 Value *A = Op0->getOperand(0);
217 Value *B = Op0->getOperand(1);
218 Value *C = RHS;
219
220 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000221 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000222 // It does! Return "A op V" if it simplifies or is already available.
223 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000224 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000225 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000226 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000227 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000228 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000229 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000230 }
231 }
232
233 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
234 if (Op1 && Op1->getOpcode() == Opcode) {
235 Value *A = LHS;
236 Value *B = Op1->getOperand(0);
237 Value *C = Op1->getOperand(1);
238
239 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000240 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000241 // It does! Return "V op C" if it simplifies or is already available.
242 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000243 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000244 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000245 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000246 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000247 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000248 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000249 }
250 }
251
252 // The remaining transforms require commutativity as well as associativity.
253 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000254 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000255
256 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
257 if (Op0 && Op0->getOpcode() == Opcode) {
258 Value *A = Op0->getOperand(0);
259 Value *B = Op0->getOperand(1);
260 Value *C = RHS;
261
262 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000263 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000264 // It does! Return "V op B" if it simplifies or is already available.
265 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000266 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000267 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000268 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000269 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000270 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000271 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000272 }
273 }
274
275 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
276 if (Op1 && Op1->getOpcode() == Opcode) {
277 Value *A = LHS;
278 Value *B = Op1->getOperand(0);
279 Value *C = Op1->getOperand(1);
280
281 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000282 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000283 // It does! Return "B op V" if it simplifies or is already available.
284 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000285 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000286 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000287 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000288 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000289 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000290 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000291 }
292 }
293
Craig Topper9f008862014-04-15 04:59:12 +0000294 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000295}
296
Sanjay Patel472cc782016-01-11 22:14:42 +0000297/// In the case of a binary operation with a select instruction as an operand,
298/// try to simplify the binop by seeing whether evaluating it on both branches
299/// of the select results in the same value. Returns the common value if so,
300/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000301static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
302 Value *RHS, const Query &Q,
303 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000304 // Recursion is always used, so bail out at once if we already hit the limit.
305 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000306 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000307
Duncan Sandsb0579e92010-11-10 13:00:08 +0000308 SelectInst *SI;
309 if (isa<SelectInst>(LHS)) {
310 SI = cast<SelectInst>(LHS);
311 } else {
312 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
313 SI = cast<SelectInst>(RHS);
314 }
315
316 // Evaluate the BinOp on the true and false branches of the select.
317 Value *TV;
318 Value *FV;
319 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000320 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
321 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000322 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000323 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
324 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000325 }
326
Duncan Sandse3c53952011-01-01 16:12:09 +0000327 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000328 // If they both failed to simplify then return null.
329 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000330 return TV;
331
332 // If one branch simplified to undef, return the other one.
333 if (TV && isa<UndefValue>(TV))
334 return FV;
335 if (FV && isa<UndefValue>(FV))
336 return TV;
337
338 // If applying the operation did not change the true and false select values,
339 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000340 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000341 return SI;
342
343 // If one branch simplified and the other did not, and the simplified
344 // value is equal to the unsimplified one, return the simplified value.
345 // For example, select (cond, X, X & Z) & Z -> X & Z.
346 if ((FV && !TV) || (TV && !FV)) {
347 // Check that the simplified value has the form "X op Y" where "op" is the
348 // same as the original operation.
349 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
350 if (Simplified && Simplified->getOpcode() == Opcode) {
351 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
352 // We already know that "op" is the same as for the simplified value. See
353 // if the operands match too. If so, return the simplified value.
354 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
355 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
356 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000357 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
358 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000359 return Simplified;
360 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000361 Simplified->getOperand(1) == UnsimplifiedLHS &&
362 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000363 return Simplified;
364 }
365 }
366
Craig Topper9f008862014-04-15 04:59:12 +0000367 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000368}
369
Sanjay Patel472cc782016-01-11 22:14:42 +0000370/// In the case of a comparison with a select instruction, try to simplify the
371/// comparison by seeing whether both branches of the select result in the same
372/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000373static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000374 Value *RHS, const Query &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000375 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000376 // Recursion is always used, so bail out at once if we already hit the limit.
377 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000378 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000379
Duncan Sandsb0579e92010-11-10 13:00:08 +0000380 // Make sure the select is on the LHS.
381 if (!isa<SelectInst>(LHS)) {
382 std::swap(LHS, RHS);
383 Pred = CmpInst::getSwappedPredicate(Pred);
384 }
385 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
386 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000387 Value *Cond = SI->getCondition();
388 Value *TV = SI->getTrueValue();
389 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000390
Duncan Sands06504022011-02-03 09:37:39 +0000391 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000392 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000393 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000394 if (TCmp == Cond) {
395 // It not only simplified, it simplified to the select condition. Replace
396 // it with 'true'.
397 TCmp = getTrue(Cond->getType());
398 } else if (!TCmp) {
399 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
400 // condition then we can replace it with 'true'. Otherwise give up.
401 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000402 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000403 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000404 }
405
Duncan Sands3d5692a2011-10-30 19:56:36 +0000406 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000407 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000408 if (FCmp == Cond) {
409 // It not only simplified, it simplified to the select condition. Replace
410 // it with 'false'.
411 FCmp = getFalse(Cond->getType());
412 } else if (!FCmp) {
413 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
414 // condition then we can replace it with 'false'. Otherwise give up.
415 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000416 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000417 FCmp = getFalse(Cond->getType());
418 }
419
420 // If both sides simplified to the same value, then use it as the result of
421 // the original comparison.
422 if (TCmp == FCmp)
423 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000424
425 // The remaining cases only make sense if the select condition has the same
426 // type as the result of the comparison, so bail out if this is not so.
427 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000428 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000429 // If the false value simplified to false, then the result of the compare
430 // is equal to "Cond && TCmp". This also catches the case when the false
431 // value simplified to false and the true value to true, returning "Cond".
432 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000433 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000434 return V;
435 // If the true value simplified to true, then the result of the compare
436 // is equal to "Cond || FCmp".
437 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000438 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000439 return V;
440 // Finally, if the false value simplified to true and the true value to
441 // false, then the result of the compare is equal to "!Cond".
442 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
443 if (Value *V =
444 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000445 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000446 return V;
447
Craig Topper9f008862014-04-15 04:59:12 +0000448 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000449}
450
Sanjay Patel472cc782016-01-11 22:14:42 +0000451/// In the case of a binary operation with an operand that is a PHI instruction,
452/// try to simplify the binop by seeing whether evaluating it on the incoming
453/// phi values yields the same result for every value. If so returns the common
454/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000455static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
456 Value *RHS, const Query &Q,
457 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000458 // Recursion is always used, so bail out at once if we already hit the limit.
459 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000460 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000461
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000462 PHINode *PI;
463 if (isa<PHINode>(LHS)) {
464 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000465 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000466 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000467 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000468 } else {
469 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
470 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000471 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000472 if (!ValueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000473 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000474 }
475
476 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000477 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000478 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000479 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000480 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000481 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000482 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
483 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000484 // If the operation failed to simplify, or simplified to a different value
485 // to previously, then give up.
486 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000487 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000488 CommonValue = V;
489 }
490
491 return CommonValue;
492}
493
Sanjay Patel472cc782016-01-11 22:14:42 +0000494/// In the case of a comparison with a PHI instruction, try to simplify the
495/// comparison by seeing whether comparing with all of the incoming phi values
496/// yields the same result every time. If so returns the common result,
497/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000498static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000499 const Query &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000500 // Recursion is always used, so bail out at once if we already hit the limit.
501 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000502 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000503
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000504 // Make sure the phi is on the LHS.
505 if (!isa<PHINode>(LHS)) {
506 std::swap(LHS, RHS);
507 Pred = CmpInst::getSwappedPredicate(Pred);
508 }
509 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
510 PHINode *PI = cast<PHINode>(LHS);
511
Duncan Sands5ffc2982010-11-16 12:16:38 +0000512 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000513 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000514 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000515
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000516 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000517 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000518 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000519 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000520 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000521 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000522 // If the operation failed to simplify, or simplified to a different value
523 // to previously, then give up.
524 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000525 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000526 CommonValue = V;
527 }
528
529 return CommonValue;
530}
531
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000532static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
533 Value *&Op0, Value *&Op1,
534 const Query &Q) {
535 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
536 if (auto *CRHS = dyn_cast<Constant>(Op1))
537 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
538
539 // Canonicalize the constant to the RHS if this is a commutative operation.
540 if (Instruction::isCommutative(Opcode))
541 std::swap(Op0, Op1);
542 }
543 return nullptr;
544}
545
Sanjay Patel472cc782016-01-11 22:14:42 +0000546/// Given operands for an Add, see if we can fold the result.
547/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000548static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000549 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000550 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
551 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000552
Duncan Sands0a2c41682010-12-15 14:07:39 +0000553 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000554 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000555 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000556
Duncan Sands0a2c41682010-12-15 14:07:39 +0000557 // X + 0 -> X
558 if (match(Op1, m_Zero()))
559 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000560
Duncan Sands0a2c41682010-12-15 14:07:39 +0000561 // X + (Y - X) -> Y
562 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000563 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000564 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000565 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
566 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000567 return Y;
568
569 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000570 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000571 if (match(Op0, m_Not(m_Specific(Op1))) ||
572 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000573 return Constant::getAllOnesValue(Ty);
574
575 // add nsw/nuw (xor Y, signbit), signbit --> Y
576 // The no-wrapping add guarantees that the top bit will be set by the add.
577 // Therefore, the xor must be clearing the already set sign bit of Y.
Craig Topper3a40a392017-03-30 22:21:16 +0000578 if ((isNSW || isNUW) && match(Op1, m_SignBit()) &&
579 match(Op0, m_Xor(m_Value(Y), m_SignBit())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000580 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000581
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000582 /// i1 add -> xor.
Craig Topperaa5f5242017-04-06 05:28:41 +0000583 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000584 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000585 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000586
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000587 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000588 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000589 MaxRecurse))
590 return V;
591
Duncan Sandsb238de02010-11-19 09:20:39 +0000592 // Threading Add over selects and phi nodes is pointless, so don't bother.
593 // Threading over the select in "A + select(cond, B, C)" means evaluating
594 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
595 // only if B and C are equal. If B and C are equal then (since we assume
596 // that operands have already been simplified) "select(cond, B, C)" should
597 // have been simplified to the common value of B and C already. Analysing
598 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
599 // for threading over phi nodes.
600
Craig Topper9f008862014-04-15 04:59:12 +0000601 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000602}
603
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000604Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000605 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000606 const DominatorTree *DT, AssumptionCache *AC,
607 const Instruction *CxtI) {
608 return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, Query(DL, TLI, DT, AC, CxtI),
Chandler Carruth66b31302015-01-04 12:03:27 +0000609 RecursionLimit);
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000610}
611
Chandler Carrutha0796552012-03-12 11:19:31 +0000612/// \brief Compute the base pointer and cumulative constant offsets for V.
613///
614/// This strips all constant offsets off of V, leaving it the base pointer, and
615/// accumulates the total constant offset applied in the returned constant. It
616/// returns 0 if V is not a pointer, and returns the constant '0' if there are
617/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000618///
619/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
620/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
621/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000622static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000623 bool AllowNonInbounds = false) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000624 assert(V->getType()->getScalarType()->isPointerTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000625
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000626 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000627 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000628
629 // Even though we don't look through PHI nodes, we could be called on an
630 // instruction in an unreachable block, which may be on a cycle.
631 SmallPtrSet<Value *, 4> Visited;
632 Visited.insert(V);
633 do {
634 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000635 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000636 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000637 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000638 V = GEP->getPointerOperand();
639 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000640 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000641 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000642 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000643 break;
644 V = GA->getAliasee();
645 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000646 if (auto CS = CallSite(V))
647 if (Value *RV = CS.getReturnedArgOperand()) {
648 V = RV;
649 continue;
650 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000651 break;
652 }
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000653 assert(V->getType()->getScalarType()->isPointerTy() &&
654 "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000655 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000656
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000657 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
658 if (V->getType()->isVectorTy())
659 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
660 OffsetIntPtr);
661 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000662}
663
664/// \brief Compute the constant difference between two pointer values.
665/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000666static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
667 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000668 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
669 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000670
671 // If LHS and RHS are not related via constant offsets to the same base
672 // value, there is nothing we can do here.
673 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000674 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000675
676 // Otherwise, the difference of LHS - RHS can be computed as:
677 // LHS - RHS
678 // = (LHSOffset + Base) - (RHSOffset + Base)
679 // = LHSOffset - RHSOffset
680 return ConstantExpr::getSub(LHSOffset, RHSOffset);
681}
682
Sanjay Patel472cc782016-01-11 22:14:42 +0000683/// Given operands for a Sub, see if we can fold the result.
684/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000685static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000686 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000687 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
688 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000689
690 // X - undef -> undef
691 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000692 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000693 return UndefValue::get(Op0->getType());
694
695 // X - 0 -> X
696 if (match(Op1, m_Zero()))
697 return Op0;
698
699 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000700 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000701 return Constant::getNullValue(Op0->getType());
702
Sanjay Patelefd88852016-10-19 21:23:45 +0000703 // Is this a negation?
704 if (match(Op0, m_Zero())) {
705 // 0 - X -> 0 if the sub is NUW.
706 if (isNUW)
707 return Op0;
708
709 unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
710 APInt KnownZero(BitWidth, 0);
711 APInt KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000712 computeKnownBits(Op1, KnownZero, KnownOne, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topper6856d342017-03-30 22:10:54 +0000713 if (KnownZero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000714 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
715 // Op1 must be 0 because negating the minimum signed value is undefined.
716 if (isNSW)
717 return Op0;
718
719 // 0 - X -> X if X is 0 or the minimum signed value.
720 return Op1;
721 }
722 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000723
Duncan Sands99589d02011-01-18 11:50:19 +0000724 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
725 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000726 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000727 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
728 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000729 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000730 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000731 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000732 // It does, we successfully reassociated!
733 ++NumReassoc;
734 return W;
735 }
736 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000737 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000738 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000739 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000740 // It does, we successfully reassociated!
741 ++NumReassoc;
742 return W;
743 }
744 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000745
Duncan Sands99589d02011-01-18 11:50:19 +0000746 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
747 // For example, X - (X + 1) -> -1
748 X = Op0;
749 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
750 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000751 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000752 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000753 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000754 // It does, we successfully reassociated!
755 ++NumReassoc;
756 return W;
757 }
758 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000759 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000760 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000761 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000762 // It does, we successfully reassociated!
763 ++NumReassoc;
764 return W;
765 }
766 }
767
768 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
769 // For example, X - (X - Y) -> Y.
770 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000771 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
772 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000773 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000774 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000775 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000776 // It does, we successfully reassociated!
777 ++NumReassoc;
778 return W;
779 }
780
Duncan Sands395ac42d2012-03-13 14:07:05 +0000781 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
782 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
783 match(Op1, m_Trunc(m_Value(Y))))
784 if (X->getType() == Y->getType())
785 // See if "V === X - Y" simplifies.
786 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
787 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000788 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
789 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000790 // It does, return the simplified "trunc V".
791 return W;
792
793 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000794 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000795 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000796 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000797 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
798
Duncan Sands99589d02011-01-18 11:50:19 +0000799 // i1 sub -> xor.
Craig Topperaa5f5242017-04-06 05:28:41 +0000800 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000801 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000802 return V;
803
Duncan Sands0a2c41682010-12-15 14:07:39 +0000804 // Threading Sub over selects and phi nodes is pointless, so don't bother.
805 // Threading over the select in "A - select(cond, B, C)" means evaluating
806 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
807 // only if B and C are equal. If B and C are equal then (since we assume
808 // that operands have already been simplified) "select(cond, B, C)" should
809 // have been simplified to the common value of B and C already. Analysing
810 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
811 // for threading over phi nodes.
812
Craig Topper9f008862014-04-15 04:59:12 +0000813 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000814}
815
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000816Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000817 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000818 const DominatorTree *DT, AssumptionCache *AC,
819 const Instruction *CxtI) {
820 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Query(DL, TLI, DT, AC, CxtI),
Chandler Carruth66b31302015-01-04 12:03:27 +0000821 RecursionLimit);
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000822}
823
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000824/// Given operands for an FAdd, see if we can fold the result. If not, this
825/// returns null.
826static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
827 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000828 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
829 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000830
831 // fadd X, -0 ==> X
832 if (match(Op1, m_NegZero()))
833 return Op0;
834
835 // fadd X, 0 ==> X, when we know X is not -0
836 if (match(Op1, m_Zero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000837 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000838 return Op0;
839
840 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
841 // where nnan and ninf have to occur at least once somewhere in this
842 // expression
Craig Topper9f008862014-04-15 04:59:12 +0000843 Value *SubOp = nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000844 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
845 SubOp = Op1;
846 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
847 SubOp = Op0;
848 if (SubOp) {
849 Instruction *FSub = cast<Instruction>(SubOp);
850 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
851 (FMF.noInfs() || FSub->hasNoInfs()))
852 return Constant::getNullValue(Op0->getType());
853 }
854
Craig Topper9f008862014-04-15 04:59:12 +0000855 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000856}
857
858/// Given operands for an FSub, see if we can fold the result. If not, this
859/// returns null.
860static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
861 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000862 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
863 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000864
865 // fsub X, 0 ==> X
866 if (match(Op1, m_Zero()))
867 return Op0;
868
869 // fsub X, -0 ==> X, when we know X is not -0
870 if (match(Op1, m_NegZero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000871 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000872 return Op0;
873
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000874 // fsub -0.0, (fsub -0.0, X) ==> X
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000875 Value *X;
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000876 if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
877 return X;
878
879 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Benjamin Kramer6bb15022016-02-29 12:18:25 +0000880 if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000881 match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
882 return X;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000883
Benjamin Kramer228680d2015-06-14 21:01:20 +0000884 // fsub nnan x, x ==> 0.0
885 if (FMF.noNaNs() && Op0 == Op1)
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000886 return Constant::getNullValue(Op0->getType());
887
Craig Topper9f008862014-04-15 04:59:12 +0000888 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000889}
890
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000891/// Given the operands for an FMul, see if we can fold the result
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000892static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
893 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000894 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
895 return C;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000896
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000897 // fmul X, 1.0 ==> X
898 if (match(Op1, m_FPOne()))
899 return Op0;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000900
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000901 // fmul nnan nsz X, 0 ==> 0
902 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
903 return Op1;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000904
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000905 return nullptr;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000906}
907
Sanjay Patel472cc782016-01-11 22:14:42 +0000908/// Given operands for a Mul, see if we can fold the result.
909/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000910static Value *SimplifyMulInst(Value *Op0, Value *Op1, const Query &Q,
911 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000912 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
913 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000914
915 // X * undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000916 if (match(Op1, m_Undef()))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000917 return Constant::getNullValue(Op0->getType());
918
919 // X * 0 -> 0
920 if (match(Op1, m_Zero()))
921 return Op1;
922
923 // X * 1 -> X
924 if (match(Op1, m_One()))
925 return Op0;
926
Duncan Sandsb67edc62011-01-30 18:03:50 +0000927 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000928 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000929 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
930 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
931 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000932
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000933 // i1 mul -> and.
Craig Topper2f1e1c32017-04-06 17:33:37 +0000934 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000935 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000936 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000937
938 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000939 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000940 MaxRecurse))
941 return V;
942
943 // Mul distributes over Add. Try some generic simplifications based on this.
944 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000945 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000946 return V;
947
948 // If the operation is with the result of a select instruction, check whether
949 // operating on either branch of the select always yields the same value.
950 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000951 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000952 MaxRecurse))
953 return V;
954
955 // If the operation is with the result of a phi instruction, check whether
956 // operating on all incoming values of the phi always yields the same value.
957 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000958 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000959 MaxRecurse))
960 return V;
961
Craig Topper9f008862014-04-15 04:59:12 +0000962 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000963}
964
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000965Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000966 const DataLayout &DL,
Chandler Carruth66b31302015-01-04 12:03:27 +0000967 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000968 const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth66b31302015-01-04 12:03:27 +0000969 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000970 return ::SimplifyFAddInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000971 RecursionLimit);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000972}
973
974Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000975 const DataLayout &DL,
Chandler Carruth66b31302015-01-04 12:03:27 +0000976 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000977 const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth66b31302015-01-04 12:03:27 +0000978 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000979 return ::SimplifyFSubInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000980 RecursionLimit);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000981}
982
Chandler Carruth66b31302015-01-04 12:03:27 +0000983Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000984 const DataLayout &DL,
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000985 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000986 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +0000987 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000988 return ::SimplifyFMulInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000989 RecursionLimit);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000990}
991
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000992Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +0000993 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000994 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +0000995 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000996 return ::SimplifyMulInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +0000997 RecursionLimit);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000998}
999
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001000/// Check for common or similar folds of integer division or integer remainder.
1001static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
1002 Type *Ty = Op0->getType();
1003
1004 // X / undef -> undef
1005 // X % undef -> undef
1006 if (match(Op1, m_Undef()))
1007 return Op1;
1008
1009 // X / 0 -> undef
1010 // X % 0 -> undef
1011 // We don't need to preserve faults!
1012 if (match(Op1, m_Zero()))
1013 return UndefValue::get(Ty);
1014
Sanjay Patel2b1f6f42017-03-09 16:20:52 +00001015 // If any element of a constant divisor vector is zero, the whole op is undef.
1016 auto *Op1C = dyn_cast<Constant>(Op1);
1017 if (Op1C && Ty->isVectorTy()) {
1018 unsigned NumElts = Ty->getVectorNumElements();
1019 for (unsigned i = 0; i != NumElts; ++i) {
1020 Constant *Elt = Op1C->getAggregateElement(i);
1021 if (Elt && Elt->isNullValue())
1022 return UndefValue::get(Ty);
1023 }
1024 }
1025
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001026 // undef / X -> 0
1027 // undef % X -> 0
1028 if (match(Op0, m_Undef()))
1029 return Constant::getNullValue(Ty);
1030
1031 // 0 / X -> 0
1032 // 0 % X -> 0
1033 if (match(Op0, m_Zero()))
1034 return Op0;
1035
1036 // X / X -> 1
1037 // X % X -> 0
1038 if (Op0 == Op1)
1039 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
1040
1041 // X / 1 -> X
1042 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +00001043 // If this is a boolean op (single-bit element type), we can't have
1044 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
1045 if (match(Op1, m_One()) || Ty->getScalarType()->isIntegerTy(1))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001046 return IsDiv ? Op0 : Constant::getNullValue(Ty);
1047
1048 return nullptr;
1049}
1050
Sanjay Patel472cc782016-01-11 22:14:42 +00001051/// Given operands for an SDiv or UDiv, see if we can fold the result.
1052/// If not, this returns null.
Anders Carlsson36c6d232011-02-05 18:33:43 +00001053static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001054 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001055 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1056 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001057
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001058 if (Value *V = simplifyDivRem(Op0, Op1, true))
1059 return V;
1060
Duncan Sands65995fa2011-01-28 18:50:50 +00001061 bool isSigned = Opcode == Instruction::SDiv;
1062
Duncan Sands771e82a2011-01-28 16:51:11 +00001063 // (X * Y) / Y -> X if the multiplication does not overflow.
Craig Topper9f008862014-04-15 04:59:12 +00001064 Value *X = nullptr, *Y = nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001065 if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1066 if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
Duncan Sands7cb61e52011-10-27 19:16:21 +00001067 OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
Duncan Sands5747aba2011-02-02 20:52:00 +00001068 // If the Mul knows it does not overflow, then we are good to go.
1069 if ((isSigned && Mul->hasNoSignedWrap()) ||
1070 (!isSigned && Mul->hasNoUnsignedWrap()))
1071 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001072 // If X has the form X = A / Y then X * Y cannot overflow.
1073 if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1074 if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1075 return X;
1076 }
1077
Duncan Sands65995fa2011-01-28 18:50:50 +00001078 // (X rem Y) / Y -> 0
1079 if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1080 (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1081 return Constant::getNullValue(Op0->getType());
1082
David Majnemercb9d5962014-10-11 10:20:01 +00001083 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1084 ConstantInt *C1, *C2;
1085 if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1086 match(Op1, m_ConstantInt(C2))) {
1087 bool Overflow;
1088 C1->getValue().umul_ov(C2->getValue(), Overflow);
1089 if (Overflow)
1090 return Constant::getNullValue(Op0->getType());
1091 }
1092
Duncan Sands65995fa2011-01-28 18:50:50 +00001093 // If the operation is with the result of a select instruction, check whether
1094 // operating on either branch of the select always yields the same value.
1095 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001096 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001097 return V;
1098
1099 // If the operation is with the result of a phi instruction, check whether
1100 // operating on all incoming values of the phi always yields the same value.
1101 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001102 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001103 return V;
1104
Craig Topper9f008862014-04-15 04:59:12 +00001105 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001106}
1107
Sanjay Patel472cc782016-01-11 22:14:42 +00001108/// Given operands for an SDiv, see if we can fold the result.
1109/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001110static Value *SimplifySDivInst(Value *Op0, Value *Op1, const Query &Q,
1111 unsigned MaxRecurse) {
1112 if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001113 return V;
1114
Craig Topper9f008862014-04-15 04:59:12 +00001115 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001116}
1117
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001118Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001119 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001120 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001121 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001122 return ::SimplifySDivInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001123 RecursionLimit);
Duncan Sands771e82a2011-01-28 16:51:11 +00001124}
1125
Sanjay Patel472cc782016-01-11 22:14:42 +00001126/// Given operands for a UDiv, see if we can fold the result.
1127/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001128static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const Query &Q,
1129 unsigned MaxRecurse) {
1130 if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001131 return V;
1132
David Majnemer63da0c22017-01-06 22:58:02 +00001133 // udiv %V, C -> 0 if %V < C
1134 if (MaxRecurse) {
1135 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1136 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1137 if (C->isAllOnesValue()) {
1138 return Constant::getNullValue(Op0->getType());
1139 }
1140 }
1141 }
1142
Craig Topper9f008862014-04-15 04:59:12 +00001143 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001144}
1145
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001146Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001147 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001148 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001149 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001150 return ::SimplifyUDivInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001151 RecursionLimit);
Duncan Sands771e82a2011-01-28 16:51:11 +00001152}
1153
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001154static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
1155 const Query &Q, unsigned) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001156 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
1157 return C;
1158
Frits van Bommelc2549662011-01-29 15:26:31 +00001159 // undef / X -> undef (the undef could be a snan).
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001160 if (match(Op0, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001161 return Op0;
1162
1163 // X / undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001164 if (match(Op1, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001165 return Op1;
1166
Zia Ansari394cef82016-12-08 23:27:40 +00001167 // X / 1.0 -> X
1168 if (match(Op1, m_FPOne()))
1169 return Op0;
1170
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001171 // 0 / X -> 0
1172 // Requires that NaNs are off (X could be zero) and signed zeroes are
1173 // ignored (X could be positive or negative, so the output sign is unknown).
1174 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1175 return Op0;
1176
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001177 if (FMF.noNaNs()) {
1178 // X / X -> 1.0 is legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001179 if (Op0 == Op1)
1180 return ConstantFP::get(Op0->getType(), 1.0);
1181
1182 // -X / X -> -1.0 and
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001183 // X / -X -> -1.0 are legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001184 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
1185 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
1186 BinaryOperator::getFNegArgument(Op0) == Op1) ||
1187 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
1188 BinaryOperator::getFNegArgument(Op1) == Op0))
1189 return ConstantFP::get(Op0->getType(), -1.0);
1190 }
1191
Craig Topper9f008862014-04-15 04:59:12 +00001192 return nullptr;
Frits van Bommelc2549662011-01-29 15:26:31 +00001193}
1194
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001195Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001196 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001197 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001198 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001199 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001200 return ::SimplifyFDivInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001201 RecursionLimit);
Frits van Bommelc2549662011-01-29 15:26:31 +00001202}
1203
Sanjay Patel472cc782016-01-11 22:14:42 +00001204/// Given operands for an SRem or URem, see if we can fold the result.
1205/// If not, this returns null.
Duncan Sandsa3e36992011-05-02 16:27:02 +00001206static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001207 const Query &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001208 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1209 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001210
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001211 if (Value *V = simplifyDivRem(Op0, Op1, false))
1212 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001213
David Majnemerb435a422014-09-17 04:16:35 +00001214 // (X % Y) % Y -> X % Y
1215 if ((Opcode == Instruction::SRem &&
1216 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1217 (Opcode == Instruction::URem &&
1218 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001219 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001220
Duncan Sandsa3e36992011-05-02 16:27:02 +00001221 // If the operation is with the result of a select instruction, check whether
1222 // operating on either branch of the select always yields the same value.
1223 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001224 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001225 return V;
1226
1227 // If the operation is with the result of a phi instruction, check whether
1228 // operating on all incoming values of the phi always yields the same value.
1229 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001230 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001231 return V;
1232
Craig Topper9f008862014-04-15 04:59:12 +00001233 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001234}
1235
Sanjay Patel472cc782016-01-11 22:14:42 +00001236/// Given operands for an SRem, see if we can fold the result.
1237/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001238static Value *SimplifySRemInst(Value *Op0, Value *Op1, const Query &Q,
1239 unsigned MaxRecurse) {
1240 if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001241 return V;
1242
Craig Topper9f008862014-04-15 04:59:12 +00001243 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001244}
1245
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001246Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001247 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001248 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001249 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001250 return ::SimplifySRemInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001251 RecursionLimit);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001252}
1253
Sanjay Patel472cc782016-01-11 22:14:42 +00001254/// Given operands for a URem, see if we can fold the result.
1255/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001256static Value *SimplifyURemInst(Value *Op0, Value *Op1, const Query &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001257 unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001258 if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001259 return V;
1260
David Majnemer8c0e62f2017-01-06 21:23:51 +00001261 // urem %V, C -> %V if %V < C
1262 if (MaxRecurse) {
1263 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1264 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1265 if (C->isAllOnesValue()) {
1266 return Op0;
1267 }
1268 }
1269 }
1270
Craig Topper9f008862014-04-15 04:59:12 +00001271 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001272}
1273
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001274Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001275 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001276 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001277 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001278 return ::SimplifyURemInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001279 RecursionLimit);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001280}
1281
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001282static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001283 const Query &Q, unsigned) {
1284 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
1285 return C;
1286
Duncan Sandsa3e36992011-05-02 16:27:02 +00001287 // undef % X -> undef (the undef could be a snan).
1288 if (match(Op0, m_Undef()))
1289 return Op0;
1290
1291 // X % undef -> undef
1292 if (match(Op1, m_Undef()))
1293 return Op1;
1294
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001295 // 0 % X -> 0
1296 // Requires that NaNs are off (X could be zero) and signed zeroes are
1297 // ignored (X could be positive or negative, so the output sign is unknown).
1298 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1299 return Op0;
1300
Craig Topper9f008862014-04-15 04:59:12 +00001301 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001302}
1303
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001304Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001305 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001306 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001307 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001308 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001309 return ::SimplifyFRemInst(Op0, Op1, FMF, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001310 RecursionLimit);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001311}
1312
Sanjay Patel472cc782016-01-11 22:14:42 +00001313/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001314static bool isUndefShift(Value *Amount) {
1315 Constant *C = dyn_cast<Constant>(Amount);
1316 if (!C)
1317 return false;
1318
1319 // X shift by undef -> undef because it may shift by the bitwidth.
1320 if (isa<UndefValue>(C))
1321 return true;
1322
1323 // Shifting by the bitwidth or more is undefined.
1324 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1325 if (CI->getValue().getLimitedValue() >=
1326 CI->getType()->getScalarSizeInBits())
1327 return true;
1328
1329 // If all lanes of a vector shift are undefined the whole shift is.
1330 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1331 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1332 if (!isUndefShift(C->getAggregateElement(I)))
1333 return false;
1334 return true;
1335 }
1336
1337 return false;
1338}
1339
Sanjay Patel472cc782016-01-11 22:14:42 +00001340/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1341/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001342static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
1343 Value *Op1, const Query &Q, unsigned MaxRecurse) {
1344 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1345 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001346
Duncan Sands571fd9a2011-01-14 14:44:12 +00001347 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001348 if (match(Op0, m_Zero()))
1349 return Op0;
1350
Duncan Sands571fd9a2011-01-14 14:44:12 +00001351 // X shift by 0 -> X
Duncan Sands7f60dc12011-01-14 00:37:45 +00001352 if (match(Op1, m_Zero()))
1353 return Op0;
1354
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001355 // Fold undefined shifts.
1356 if (isUndefShift(Op1))
1357 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001358
Duncan Sands571fd9a2011-01-14 14:44:12 +00001359 // If the operation is with the result of a select instruction, check whether
1360 // operating on either branch of the select always yields the same value.
1361 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001362 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001363 return V;
1364
1365 // If the operation is with the result of a phi instruction, check whether
1366 // operating on all incoming values of the phi always yields the same value.
1367 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001368 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001369 return V;
1370
Sanjay Patel6786bc52016-05-10 20:46:54 +00001371 // If any bits in the shift amount make that value greater than or equal to
1372 // the number of bits in the type, the shift is undefined.
1373 unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
1374 APInt KnownZero(BitWidth, 0);
1375 APInt KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001376 computeKnownBits(Op1, KnownZero, KnownOne, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Sanjay Patel6786bc52016-05-10 20:46:54 +00001377 if (KnownOne.getLimitedValue() >= BitWidth)
1378 return UndefValue::get(Op0->getType());
1379
1380 // If all valid bits in the shift amount are known zero, the first operand is
1381 // unchanged.
1382 unsigned NumValidShiftBits = Log2_32_Ceil(BitWidth);
1383 APInt ShiftAmountMask = APInt::getLowBitsSet(BitWidth, NumValidShiftBits);
1384 if ((KnownZero & ShiftAmountMask) == ShiftAmountMask)
1385 return Op0;
1386
Craig Topper9f008862014-04-15 04:59:12 +00001387 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001388}
1389
David Majnemerbf7550e2014-11-05 00:59:59 +00001390/// \brief Given operands for an Shl, LShr or AShr, see if we can
1391/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001392static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
1393 Value *Op1, bool isExact, const Query &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001394 unsigned MaxRecurse) {
1395 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1396 return V;
1397
1398 // X >> X -> 0
1399 if (Op0 == Op1)
1400 return Constant::getNullValue(Op0->getType());
1401
David Majnemer65c52ae2014-12-17 01:54:33 +00001402 // undef >> X -> 0
1403 // undef >> X -> undef (if it's exact)
1404 if (match(Op0, m_Undef()))
1405 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1406
David Majnemerbf7550e2014-11-05 00:59:59 +00001407 // The low bit cannot be shifted out of an exact shift if it is set.
1408 if (isExact) {
1409 unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
1410 APInt Op0KnownZero(BitWidth, 0);
1411 APInt Op0KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001412 computeKnownBits(Op0, Op0KnownZero, Op0KnownOne, Q.DL, /*Depth=*/0, Q.AC,
1413 Q.CxtI, Q.DT);
David Majnemerbf7550e2014-11-05 00:59:59 +00001414 if (Op0KnownOne[0])
1415 return Op0;
1416 }
1417
1418 return nullptr;
1419}
1420
Sanjay Patel472cc782016-01-11 22:14:42 +00001421/// Given operands for an Shl, see if we can fold the result.
1422/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001423static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001424 const Query &Q, unsigned MaxRecurse) {
1425 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001426 return V;
1427
1428 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001429 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001430 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001431 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001432
Chris Lattner9e4aa022011-02-09 17:15:04 +00001433 // (X >> A) << A -> X
1434 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001435 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001436 return X;
Craig Topper9f008862014-04-15 04:59:12 +00001437 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001438}
1439
Chris Lattner9e4aa022011-02-09 17:15:04 +00001440Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001441 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001442 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001443 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001444 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00001445 RecursionLimit);
Duncan Sands7f60dc12011-01-14 00:37:45 +00001446}
1447
Sanjay Patel472cc782016-01-11 22:14:42 +00001448/// Given operands for an LShr, see if we can fold the result.
1449/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001450static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001451 const Query &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001452 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1453 MaxRecurse))
1454 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001455
Chris Lattner9e4aa022011-02-09 17:15:04 +00001456 // (X << A) >> A -> X
1457 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001458 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001459 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001460
Craig Topper9f008862014-04-15 04:59:12 +00001461 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001462}
1463
Chris Lattner9e4aa022011-02-09 17:15:04 +00001464Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001465 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001466 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001467 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001468 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001469 return ::SimplifyLShrInst(Op0, Op1, isExact, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00001470 RecursionLimit);
Duncan Sands7f60dc12011-01-14 00:37:45 +00001471}
1472
Sanjay Patel472cc782016-01-11 22:14:42 +00001473/// Given operands for an AShr, see if we can fold the result.
1474/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001475static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001476 const Query &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001477 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1478 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001479 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001480
1481 // all ones >>a X -> all ones
1482 if (match(Op0, m_AllOnes()))
1483 return Op0;
1484
Chris Lattner9e4aa022011-02-09 17:15:04 +00001485 // (X << A) >> A -> X
1486 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001487 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001488 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001489
Suyog Sarda68862412014-07-17 06:28:15 +00001490 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001491 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001492 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1493 return Op0;
1494
Craig Topper9f008862014-04-15 04:59:12 +00001495 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001496}
1497
Chris Lattner9e4aa022011-02-09 17:15:04 +00001498Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001499 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001500 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001501 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001502 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001503 return ::SimplifyAShrInst(Op0, Op1, isExact, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00001504 RecursionLimit);
Duncan Sands7f60dc12011-01-14 00:37:45 +00001505}
1506
David Majnemer1af36e52014-12-06 10:51:40 +00001507static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1508 ICmpInst *UnsignedICmp, bool IsAnd) {
1509 Value *X, *Y;
1510
1511 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001512 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1513 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001514 return nullptr;
1515
1516 ICmpInst::Predicate UnsignedPred;
1517 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1518 ICmpInst::isUnsigned(UnsignedPred))
1519 ;
1520 else if (match(UnsignedICmp,
1521 m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1522 ICmpInst::isUnsigned(UnsignedPred))
1523 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1524 else
1525 return nullptr;
1526
1527 // X < Y && Y != 0 --> X < Y
1528 // X < Y || Y != 0 --> Y != 0
1529 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1530 return IsAnd ? UnsignedICmp : ZeroICmp;
1531
1532 // X >= Y || Y != 0 --> true
1533 // X >= Y || Y == 0 --> X >= Y
1534 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1535 if (EqPred == ICmpInst::ICMP_NE)
1536 return getTrue(UnsignedICmp->getType());
1537 return UnsignedICmp;
1538 }
1539
David Majnemerd5b3aa42014-12-08 18:30:43 +00001540 // X < Y && Y == 0 --> false
1541 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1542 IsAnd)
1543 return getFalse(UnsignedICmp->getType());
1544
David Majnemer1af36e52014-12-06 10:51:40 +00001545 return nullptr;
1546}
1547
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001548/// Commuted variants are assumed to be handled by calling this function again
1549/// with the parameters swapped.
1550static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1551 ICmpInst::Predicate Pred0, Pred1;
1552 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001553 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1554 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001555 return nullptr;
1556
1557 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1558 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1559 // can eliminate Op1 from this 'and'.
1560 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1561 return Op0;
1562
1563 // Check for any combination of predicates that are guaranteed to be disjoint.
1564 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1565 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1566 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1567 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1568 return getFalse(Op0->getType());
1569
1570 return nullptr;
1571}
1572
1573/// Commuted variants are assumed to be handled by calling this function again
1574/// with the parameters swapped.
David Majnemera315bd82014-09-15 08:15:28 +00001575static Value *SimplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
David Majnemer1af36e52014-12-06 10:51:40 +00001576 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1577 return X;
1578
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001579 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1580 return X;
1581
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001582 // Look for this pattern: (icmp V, C0) & (icmp V, C1)).
Sanjay Patelb2332e12016-09-20 14:36:14 +00001583 Type *ITy = Op0->getType();
1584 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001585 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001586 Value *V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001587 if (match(Op0, m_ICmp(Pred0, m_Value(V), m_APInt(C0))) &&
1588 match(Op1, m_ICmp(Pred1, m_Specific(V), m_APInt(C1)))) {
1589 // Make a constant range that's the intersection of the two icmp ranges.
1590 // If the intersection is empty, we know that the result is false.
1591 auto Range0 = ConstantRange::makeAllowedICmpRegion(Pred0, *C0);
1592 auto Range1 = ConstantRange::makeAllowedICmpRegion(Pred1, *C1);
1593 if (Range0.intersectWith(Range1).isEmptySet())
1594 return getFalse(ITy);
1595 }
1596
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001597 // (icmp (add V, C0), C1) & (icmp V, C0)
1598 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001599 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001600
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001601 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001602 return nullptr;
1603
David Majnemera315bd82014-09-15 08:15:28 +00001604 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001605 if (AddInst->getOperand(1) != Op1->getOperand(1))
1606 return nullptr;
1607
David Majnemera315bd82014-09-15 08:15:28 +00001608 bool isNSW = AddInst->hasNoSignedWrap();
1609 bool isNUW = AddInst->hasNoUnsignedWrap();
1610
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001611 const APInt Delta = *C1 - *C0;
1612 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001613 if (Delta == 2) {
1614 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1615 return getFalse(ITy);
1616 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1617 return getFalse(ITy);
1618 }
1619 if (Delta == 1) {
1620 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1621 return getFalse(ITy);
1622 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1623 return getFalse(ITy);
1624 }
1625 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001626 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001627 if (Delta == 2)
1628 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1629 return getFalse(ITy);
1630 if (Delta == 1)
1631 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1632 return getFalse(ITy);
1633 }
1634
1635 return nullptr;
1636}
1637
Sanjay Patel472cc782016-01-11 22:14:42 +00001638/// Given operands for an And, see if we can fold the result.
1639/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001640static Value *SimplifyAndInst(Value *Op0, Value *Op1, const Query &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001641 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001642 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1643 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001644
Chris Lattnera71e9d62009-11-10 00:55:12 +00001645 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001646 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001647 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001648
Chris Lattnera71e9d62009-11-10 00:55:12 +00001649 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001650 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001651 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001652
Duncan Sandsc89ac072010-11-17 18:52:15 +00001653 // X & 0 = 0
1654 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001655 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001656
Duncan Sandsc89ac072010-11-17 18:52:15 +00001657 // X & -1 = X
1658 if (match(Op1, m_AllOnes()))
1659 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001660
Chris Lattnera71e9d62009-11-10 00:55:12 +00001661 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001662 if (match(Op0, m_Not(m_Specific(Op1))) ||
1663 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001664 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001665
Chris Lattnera71e9d62009-11-10 00:55:12 +00001666 // (A | ?) & A = A
Craig Topper9f008862014-04-15 04:59:12 +00001667 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001668 if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001669 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001670 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001671
Chris Lattnera71e9d62009-11-10 00:55:12 +00001672 // A & (A | ?) = A
1673 if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001674 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001675 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001676
Duncan Sandsba286d72011-10-26 20:55:21 +00001677 // A & (-A) = A if A is a power of two or zero.
1678 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1679 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001680 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1681 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001682 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001683 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1684 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001685 return Op1;
1686 }
1687
David Majnemera315bd82014-09-15 08:15:28 +00001688 if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1689 if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1690 if (Value *V = SimplifyAndOfICmps(ICILHS, ICIRHS))
1691 return V;
1692 if (Value *V = SimplifyAndOfICmps(ICIRHS, ICILHS))
1693 return V;
1694 }
1695 }
1696
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001697 // The compares may be hidden behind casts. Look through those and try the
1698 // same folds as above.
1699 auto *Cast0 = dyn_cast<CastInst>(Op0);
1700 auto *Cast1 = dyn_cast<CastInst>(Op1);
1701 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1702 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1703 auto *Cmp0 = dyn_cast<ICmpInst>(Cast0->getOperand(0));
1704 auto *Cmp1 = dyn_cast<ICmpInst>(Cast1->getOperand(0));
1705 if (Cmp0 && Cmp1) {
1706 Instruction::CastOps CastOpc = Cast0->getOpcode();
1707 Type *ResultType = Cast0->getType();
1708 if (auto *V = dyn_cast_or_null<Constant>(SimplifyAndOfICmps(Cmp0, Cmp1)))
1709 return ConstantExpr::getCast(CastOpc, V, ResultType);
1710 if (auto *V = dyn_cast_or_null<Constant>(SimplifyAndOfICmps(Cmp1, Cmp0)))
1711 return ConstantExpr::getCast(CastOpc, V, ResultType);
1712 }
1713 }
1714
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001715 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001716 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1717 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001718 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001719
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001720 // And distributes over Or. Try some generic simplifications based on this.
1721 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001722 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001723 return V;
1724
1725 // And distributes over Xor. Try some generic simplifications based on this.
1726 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001727 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001728 return V;
1729
Duncan Sandsb0579e92010-11-10 13:00:08 +00001730 // If the operation is with the result of a select instruction, check whether
1731 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001732 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001733 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1734 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001735 return V;
1736
1737 // If the operation is with the result of a phi instruction, check whether
1738 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001739 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001740 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001741 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001742 return V;
1743
Craig Topper9f008862014-04-15 04:59:12 +00001744 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001745}
1746
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001747Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001748 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001749 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001750 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001751 return ::SimplifyAndInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001752 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001753}
1754
Sanjay Pateld0ccdb42016-12-06 18:09:37 +00001755/// Commuted variants are assumed to be handled by calling this function again
1756/// with the parameters swapped.
1757static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1758 ICmpInst::Predicate Pred0, Pred1;
1759 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001760 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1761 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Pateld0ccdb42016-12-06 18:09:37 +00001762 return nullptr;
1763
1764 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1765 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1766 // can eliminate Op0 from this 'or'.
1767 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1768 return Op1;
1769
1770 // Check for any combination of predicates that cover the entire range of
1771 // possibilities.
1772 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1773 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1774 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1775 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1776 return getTrue(Op0->getType());
1777
1778 return nullptr;
1779}
1780
1781/// Commuted variants are assumed to be handled by calling this function again
1782/// with the parameters swapped.
David Majnemera315bd82014-09-15 08:15:28 +00001783static Value *SimplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
David Majnemer1af36e52014-12-06 10:51:40 +00001784 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1785 return X;
1786
Sanjay Pateld0ccdb42016-12-06 18:09:37 +00001787 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1788 return X;
1789
Sanjay Patel220a8732016-09-28 14:27:21 +00001790 // (icmp (add V, C0), C1) | (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001791 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel220a8732016-09-28 14:27:21 +00001792 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001793 Value *V;
Sanjay Patel220a8732016-09-28 14:27:21 +00001794 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelb2332e12016-09-20 14:36:14 +00001795 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001796
Sanjay Patel220a8732016-09-28 14:27:21 +00001797 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1798 return nullptr;
1799
1800 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1801 if (AddInst->getOperand(1) != Op1->getOperand(1))
David Majnemera315bd82014-09-15 08:15:28 +00001802 return nullptr;
1803
1804 Type *ITy = Op0->getType();
David Majnemera315bd82014-09-15 08:15:28 +00001805 bool isNSW = AddInst->hasNoSignedWrap();
1806 bool isNUW = AddInst->hasNoUnsignedWrap();
1807
Sanjay Patel220a8732016-09-28 14:27:21 +00001808 const APInt Delta = *C1 - *C0;
1809 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001810 if (Delta == 2) {
1811 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1812 return getTrue(ITy);
1813 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1814 return getTrue(ITy);
1815 }
1816 if (Delta == 1) {
1817 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1818 return getTrue(ITy);
1819 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1820 return getTrue(ITy);
1821 }
1822 }
Sanjay Patel220a8732016-09-28 14:27:21 +00001823 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001824 if (Delta == 2)
1825 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1826 return getTrue(ITy);
1827 if (Delta == 1)
1828 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1829 return getTrue(ITy);
1830 }
1831
1832 return nullptr;
1833}
1834
Sanjay Patel472cc782016-01-11 22:14:42 +00001835/// Given operands for an Or, see if we can fold the result.
1836/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001837static Value *SimplifyOrInst(Value *Op0, Value *Op1, const Query &Q,
1838 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001839 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1840 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001841
Chris Lattnera71e9d62009-11-10 00:55:12 +00001842 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001843 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001844 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001845
Chris Lattnera71e9d62009-11-10 00:55:12 +00001846 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001847 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001848 return Op0;
1849
Duncan Sandsc89ac072010-11-17 18:52:15 +00001850 // X | 0 = X
1851 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001852 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001853
Duncan Sandsc89ac072010-11-17 18:52:15 +00001854 // X | -1 = -1
1855 if (match(Op1, m_AllOnes()))
1856 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001857
Chris Lattnera71e9d62009-11-10 00:55:12 +00001858 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001859 if (match(Op0, m_Not(m_Specific(Op1))) ||
1860 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001861 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001862
Chris Lattnera71e9d62009-11-10 00:55:12 +00001863 // (A & ?) | A = A
Craig Topper9f008862014-04-15 04:59:12 +00001864 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001865 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001866 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001867 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001868
Chris Lattnera71e9d62009-11-10 00:55:12 +00001869 // A | (A & ?) = A
1870 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001871 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001872 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001873
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001874 // ~(A & ?) | A = -1
1875 if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1876 (A == Op1 || B == Op1))
1877 return Constant::getAllOnesValue(Op1->getType());
1878
1879 // A | ~(A & ?) = -1
1880 if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1881 (A == Op0 || B == Op0))
1882 return Constant::getAllOnesValue(Op0->getType());
1883
David Majnemera315bd82014-09-15 08:15:28 +00001884 if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1885 if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1886 if (Value *V = SimplifyOrOfICmps(ICILHS, ICIRHS))
1887 return V;
1888 if (Value *V = SimplifyOrOfICmps(ICIRHS, ICILHS))
1889 return V;
1890 }
1891 }
1892
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001893 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001894 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1895 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001896 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001897
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001898 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001899 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1900 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001901 return V;
1902
Duncan Sandsb0579e92010-11-10 13:00:08 +00001903 // If the operation is with the result of a select instruction, check whether
1904 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001905 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001906 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001907 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001908 return V;
1909
Nick Lewycky8561a492014-06-19 03:51:46 +00001910 // (A & C)|(B & D)
1911 Value *C = nullptr, *D = nullptr;
1912 if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1913 match(Op1, m_And(m_Value(B), m_Value(D)))) {
1914 ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1915 ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1916 if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1917 // (A & C1)|(B & C2)
1918 // If we have: ((V + N) & C1) | (V & C2)
1919 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1920 // replace with V+N.
1921 Value *V1, *V2;
1922 if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1923 match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1924 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001925 if (V1 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001926 MaskedValueIsZero(V2, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001927 return A;
Chandler Carruth66b31302015-01-04 12:03:27 +00001928 if (V2 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001929 MaskedValueIsZero(V1, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001930 return A;
1931 }
1932 // Or commutes, try both ways.
1933 if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1934 match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1935 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001936 if (V1 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001937 MaskedValueIsZero(V2, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001938 return B;
Chandler Carruth66b31302015-01-04 12:03:27 +00001939 if (V2 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001940 MaskedValueIsZero(V1, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001941 return B;
1942 }
1943 }
1944 }
1945
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001946 // If the operation is with the result of a phi instruction, check whether
1947 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001948 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001949 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001950 return V;
1951
Craig Topper9f008862014-04-15 04:59:12 +00001952 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001953}
1954
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001955Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001956 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001957 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00001958 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001959 return ::SimplifyOrInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00001960 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001961}
Chris Lattnera71e9d62009-11-10 00:55:12 +00001962
Sanjay Patel472cc782016-01-11 22:14:42 +00001963/// Given operands for a Xor, see if we can fold the result.
1964/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001965static Value *SimplifyXorInst(Value *Op0, Value *Op1, const Query &Q,
1966 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001967 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1968 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001969
1970 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001971 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001972 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001973
1974 // A ^ 0 = A
1975 if (match(Op1, m_Zero()))
1976 return Op0;
1977
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001978 // A ^ A = 0
1979 if (Op0 == Op1)
1980 return Constant::getNullValue(Op0->getType());
1981
Duncan Sandsc89ac072010-11-17 18:52:15 +00001982 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001983 if (match(Op0, m_Not(m_Specific(Op1))) ||
1984 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00001985 return Constant::getAllOnesValue(Op0->getType());
1986
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001987 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001988 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1989 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001990 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001991
Duncan Sandsb238de02010-11-19 09:20:39 +00001992 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1993 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1994 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1995 // only if B and C are equal. If B and C are equal then (since we assume
1996 // that operands have already been simplified) "select(cond, B, C)" should
1997 // have been simplified to the common value of B and C already. Analysing
1998 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
1999 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00002000
Craig Topper9f008862014-04-15 04:59:12 +00002001 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002002}
2003
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002004Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00002005 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002006 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00002007 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002008 return ::SimplifyXorInst(Op0, Op1, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00002009 RecursionLimit);
Duncan Sandsc89ac072010-11-17 18:52:15 +00002010}
2011
Chris Lattner229907c2011-07-18 04:54:35 +00002012static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002013 return CmpInst::makeCmpResultType(Op->getType());
2014}
2015
Sanjay Patel472cc782016-01-11 22:14:42 +00002016/// Rummage around inside V looking for something equivalent to the comparison
2017/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2018/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002019static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2020 Value *LHS, Value *RHS) {
2021 SelectInst *SI = dyn_cast<SelectInst>(V);
2022 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002023 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002024 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2025 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002026 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002027 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2028 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2029 return Cmp;
2030 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2031 LHS == CmpRHS && RHS == CmpLHS)
2032 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002033 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002034}
2035
Dan Gohman9631d902013-02-01 00:49:06 +00002036// A significant optimization not implemented here is assuming that alloca
2037// addresses are not equal to incoming argument values. They don't *alias*,
2038// as we say, but that doesn't mean they aren't equal, so we take a
2039// conservative approach.
2040//
2041// This is inspired in part by C++11 5.10p1:
2042// "Two pointers of the same type compare equal if and only if they are both
2043// null, both point to the same function, or both represent the same
2044// address."
2045//
2046// This is pretty permissive.
2047//
2048// It's also partly due to C11 6.5.9p6:
2049// "Two pointers compare equal if and only if both are null pointers, both are
2050// pointers to the same object (including a pointer to an object and a
2051// subobject at its beginning) or function, both are pointers to one past the
2052// last element of the same array object, or one is a pointer to one past the
2053// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002054// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002055// object in the address space.)
2056//
2057// C11's version is more restrictive, however there's no reason why an argument
2058// couldn't be a one-past-the-end value for a stack object in the caller and be
2059// equal to the beginning of a stack object in the callee.
2060//
2061// If the C and C++ standards are ever made sufficiently restrictive in this
2062// area, it may be possible to update LLVM's semantics accordingly and reinstate
2063// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002064static Constant *
2065computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2066 const DominatorTree *DT, CmpInst::Predicate Pred,
2067 const Instruction *CxtI, Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002068 // First, skip past any trivial no-ops.
2069 LHS = LHS->stripPointerCasts();
2070 RHS = RHS->stripPointerCasts();
2071
2072 // A non-null pointer is not equal to a null pointer.
Sean Silva45835e72016-07-02 23:47:27 +00002073 if (llvm::isKnownNonNull(LHS) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002074 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2075 return ConstantInt::get(GetCompareTy(LHS),
2076 !CmpInst::isTrueWhenEqual(Pred));
2077
Chandler Carruth8059c842012-03-25 21:28:14 +00002078 // We can only fold certain predicates on pointer comparisons.
2079 switch (Pred) {
2080 default:
Craig Topper9f008862014-04-15 04:59:12 +00002081 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002082
2083 // Equality comaprisons are easy to fold.
2084 case CmpInst::ICMP_EQ:
2085 case CmpInst::ICMP_NE:
2086 break;
2087
2088 // We can only handle unsigned relational comparisons because 'inbounds' on
2089 // a GEP only protects against unsigned wrapping.
2090 case CmpInst::ICMP_UGT:
2091 case CmpInst::ICMP_UGE:
2092 case CmpInst::ICMP_ULT:
2093 case CmpInst::ICMP_ULE:
2094 // However, we have to switch them to their signed variants to handle
2095 // negative indices from the base pointer.
2096 Pred = ICmpInst::getSignedPredicate(Pred);
2097 break;
2098 }
2099
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002100 // Strip off any constant offsets so that we can reason about them.
2101 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2102 // here and compare base addresses like AliasAnalysis does, however there are
2103 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2104 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2105 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002106 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2107 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002108
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002109 // If LHS and RHS are related via constant offsets to the same base
2110 // value, we can replace it with an icmp which just compares the offsets.
2111 if (LHS == RHS)
2112 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002113
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002114 // Various optimizations for (in)equality comparisons.
2115 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2116 // Different non-empty allocations that exist at the same time have
2117 // different addresses (if the program can tell). Global variables always
2118 // exist, so they always exist during the lifetime of each other and all
2119 // allocas. Two different allocas usually have different addresses...
2120 //
2121 // However, if there's an @llvm.stackrestore dynamically in between two
2122 // allocas, they may have the same address. It's tempting to reduce the
2123 // scope of the problem by only looking at *static* allocas here. That would
2124 // cover the majority of allocas while significantly reducing the likelihood
2125 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2126 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2127 // an entry block. Also, if we have a block that's not attached to a
2128 // function, we can't tell if it's "static" under the current definition.
2129 // Theoretically, this problem could be fixed by creating a new kind of
2130 // instruction kind specifically for static allocas. Such a new instruction
2131 // could be required to be at the top of the entry block, thus preventing it
2132 // from being subject to a @llvm.stackrestore. Instcombine could even
2133 // convert regular allocas into these special allocas. It'd be nifty.
2134 // However, until then, this problem remains open.
2135 //
2136 // So, we'll assume that two non-empty allocas have different addresses
2137 // for now.
2138 //
2139 // With all that, if the offsets are within the bounds of their allocations
2140 // (and not one-past-the-end! so we can't use inbounds!), and their
2141 // allocations aren't the same, the pointers are not equal.
2142 //
2143 // Note that it's not necessary to check for LHS being a global variable
2144 // address, due to canonicalization and constant folding.
2145 if (isa<AllocaInst>(LHS) &&
2146 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002147 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2148 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002149 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002150 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002151 getObjectSize(LHS, LHSSize, DL, TLI) &&
2152 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002153 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2154 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002155 if (!LHSOffsetValue.isNegative() &&
2156 !RHSOffsetValue.isNegative() &&
2157 LHSOffsetValue.ult(LHSSize) &&
2158 RHSOffsetValue.ult(RHSSize)) {
2159 return ConstantInt::get(GetCompareTy(LHS),
2160 !CmpInst::isTrueWhenEqual(Pred));
2161 }
2162 }
2163
2164 // Repeat the above check but this time without depending on DataLayout
2165 // or being able to compute a precise size.
2166 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2167 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2168 LHSOffset->isNullValue() &&
2169 RHSOffset->isNullValue())
2170 return ConstantInt::get(GetCompareTy(LHS),
2171 !CmpInst::isTrueWhenEqual(Pred));
2172 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002173
2174 // Even if an non-inbounds GEP occurs along the path we can still optimize
2175 // equality comparisons concerning the result. We avoid walking the whole
2176 // chain again by starting where the last calls to
2177 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002178 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2179 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002180 if (LHS == RHS)
2181 return ConstantExpr::getICmp(Pred,
2182 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2183 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002184
2185 // If one side of the equality comparison must come from a noalias call
2186 // (meaning a system memory allocation function), and the other side must
2187 // come from a pointer that cannot overlap with dynamically-allocated
2188 // memory within the lifetime of the current function (allocas, byval
2189 // arguments, globals), then determine the comparison result here.
2190 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2191 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2192 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2193
2194 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002195 auto IsNAC = [](ArrayRef<Value *> Objects) {
2196 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002197 };
2198
2199 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002200 // noalias calls. For allocas, we consider only static ones (dynamic
2201 // allocas might be transformed into calls to malloc not simultaneously
2202 // live with the compared-to allocation). For globals, we exclude symbols
2203 // that might be resolve lazily to symbols in another dynamically-loaded
2204 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002205 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2206 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002207 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2208 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2209 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2210 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002211 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002212 !GV->isThreadLocal();
2213 if (const Argument *A = dyn_cast<Argument>(V))
2214 return A->hasByValAttr();
2215 return false;
2216 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002217 };
2218
2219 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2220 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2221 return ConstantInt::get(GetCompareTy(LHS),
2222 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002223
2224 // Fold comparisons for non-escaping pointer even if the allocation call
2225 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2226 // dynamic allocation call could be either of the operands.
2227 Value *MI = nullptr;
Sean Silva45835e72016-07-02 23:47:27 +00002228 if (isAllocLikeFn(LHS, TLI) && llvm::isKnownNonNullAt(RHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002229 MI = LHS;
Sean Silva45835e72016-07-02 23:47:27 +00002230 else if (isAllocLikeFn(RHS, TLI) && llvm::isKnownNonNullAt(LHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002231 MI = RHS;
2232 // FIXME: We should also fold the compare when the pointer escapes, but the
2233 // compare dominates the pointer escape
2234 if (MI && !PointerMayBeCaptured(MI, true, true))
2235 return ConstantInt::get(GetCompareTy(LHS),
2236 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002237 }
2238
2239 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002240 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002241}
Chris Lattner01990f02012-02-24 19:01:58 +00002242
Sanjay Pateldc65a272016-12-03 17:30:22 +00002243/// Fold an icmp when its operands have i1 scalar type.
2244static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
2245 Value *RHS, const Query &Q) {
2246 Type *ITy = GetCompareTy(LHS); // The return type.
2247 Type *OpTy = LHS->getType(); // The operand type.
2248 if (!OpTy->getScalarType()->isIntegerTy(1))
2249 return nullptr;
2250
2251 switch (Pred) {
2252 default:
2253 break;
2254 case ICmpInst::ICMP_EQ:
2255 // X == 1 -> X
2256 if (match(RHS, m_One()))
2257 return LHS;
2258 break;
2259 case ICmpInst::ICMP_NE:
2260 // X != 0 -> X
2261 if (match(RHS, m_Zero()))
2262 return LHS;
2263 break;
2264 case ICmpInst::ICMP_UGT:
2265 // X >u 0 -> X
2266 if (match(RHS, m_Zero()))
2267 return LHS;
2268 break;
2269 case ICmpInst::ICMP_UGE:
2270 // X >=u 1 -> X
2271 if (match(RHS, m_One()))
2272 return LHS;
2273 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2274 return getTrue(ITy);
2275 break;
2276 case ICmpInst::ICMP_SGE:
2277 /// For signed comparison, the values for an i1 are 0 and -1
2278 /// respectively. This maps into a truth table of:
2279 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2280 /// 0 | 0 | 1 (0 >= 0) | 1
2281 /// 0 | 1 | 1 (0 >= -1) | 1
2282 /// 1 | 0 | 0 (-1 >= 0) | 0
2283 /// 1 | 1 | 1 (-1 >= -1) | 1
2284 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2285 return getTrue(ITy);
2286 break;
2287 case ICmpInst::ICMP_SLT:
2288 // X <s 0 -> X
2289 if (match(RHS, m_Zero()))
2290 return LHS;
2291 break;
2292 case ICmpInst::ICMP_SLE:
2293 // X <=s -1 -> X
2294 if (match(RHS, m_One()))
2295 return LHS;
2296 break;
2297 case ICmpInst::ICMP_ULE:
2298 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2299 return getTrue(ITy);
2300 break;
2301 }
2302
2303 return nullptr;
2304}
2305
2306/// Try hard to fold icmp with zero RHS because this is a common case.
2307static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
2308 Value *RHS, const Query &Q) {
2309 if (!match(RHS, m_Zero()))
2310 return nullptr;
2311
2312 Type *ITy = GetCompareTy(LHS); // The return type.
2313 bool LHSKnownNonNegative, LHSKnownNegative;
2314 switch (Pred) {
2315 default:
2316 llvm_unreachable("Unknown ICmp predicate!");
2317 case ICmpInst::ICMP_ULT:
2318 return getFalse(ITy);
2319 case ICmpInst::ICMP_UGE:
2320 return getTrue(ITy);
2321 case ICmpInst::ICMP_EQ:
2322 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002323 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002324 return getFalse(ITy);
2325 break;
2326 case ICmpInst::ICMP_NE:
2327 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002328 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002329 return getTrue(ITy);
2330 break;
2331 case ICmpInst::ICMP_SLT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002332 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2333 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002334 if (LHSKnownNegative)
2335 return getTrue(ITy);
2336 if (LHSKnownNonNegative)
2337 return getFalse(ITy);
2338 break;
2339 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002340 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2341 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002342 if (LHSKnownNegative)
2343 return getTrue(ITy);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002344 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002345 return getFalse(ITy);
2346 break;
2347 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002348 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2349 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002350 if (LHSKnownNegative)
2351 return getFalse(ITy);
2352 if (LHSKnownNonNegative)
2353 return getTrue(ITy);
2354 break;
2355 case ICmpInst::ICMP_SGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002356 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2357 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002358 if (LHSKnownNegative)
2359 return getFalse(ITy);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002360 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002361 return getTrue(ITy);
2362 break;
2363 }
2364
2365 return nullptr;
2366}
2367
Sanjay Patelbe332132017-01-23 18:22:26 +00002368/// Many binary operators with a constant operand have an easy-to-compute
2369/// range of outputs. This can be used to fold a comparison to always true or
2370/// always false.
2371static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2372 unsigned Width = Lower.getBitWidth();
2373 const APInt *C;
2374 switch (BO.getOpcode()) {
2375 case Instruction::Add:
Sanjay Patel56227252017-01-24 17:03:24 +00002376 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2377 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2378 if (BO.hasNoUnsignedWrap()) {
2379 // 'add nuw x, C' produces [C, UINT_MAX].
2380 Lower = *C;
2381 } else if (BO.hasNoSignedWrap()) {
2382 if (C->isNegative()) {
2383 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2384 Lower = APInt::getSignedMinValue(Width);
2385 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2386 } else {
2387 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2388 Lower = APInt::getSignedMinValue(Width) + *C;
2389 Upper = APInt::getSignedMaxValue(Width) + 1;
2390 }
2391 }
2392 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002393 break;
2394
2395 case Instruction::And:
2396 if (match(BO.getOperand(1), m_APInt(C)))
2397 // 'and x, C' produces [0, C].
2398 Upper = *C + 1;
2399 break;
2400
2401 case Instruction::Or:
2402 if (match(BO.getOperand(1), m_APInt(C)))
2403 // 'or x, C' produces [C, UINT_MAX].
2404 Lower = *C;
2405 break;
2406
2407 case Instruction::AShr:
2408 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2409 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2410 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2411 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2412 } else if (match(BO.getOperand(0), m_APInt(C))) {
2413 unsigned ShiftAmount = Width - 1;
2414 if (*C != 0 && BO.isExact())
2415 ShiftAmount = C->countTrailingZeros();
2416 if (C->isNegative()) {
2417 // 'ashr C, x' produces [C, C >> (Width-1)]
2418 Lower = *C;
2419 Upper = C->ashr(ShiftAmount) + 1;
2420 } else {
2421 // 'ashr C, x' produces [C >> (Width-1), C]
2422 Lower = C->ashr(ShiftAmount);
2423 Upper = *C + 1;
2424 }
2425 }
2426 break;
2427
2428 case Instruction::LShr:
2429 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2430 // 'lshr x, C' produces [0, UINT_MAX >> C].
2431 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2432 } else if (match(BO.getOperand(0), m_APInt(C))) {
2433 // 'lshr C, x' produces [C >> (Width-1), C].
2434 unsigned ShiftAmount = Width - 1;
2435 if (*C != 0 && BO.isExact())
2436 ShiftAmount = C->countTrailingZeros();
2437 Lower = C->lshr(ShiftAmount);
2438 Upper = *C + 1;
2439 }
2440 break;
2441
2442 case Instruction::Shl:
2443 if (match(BO.getOperand(0), m_APInt(C))) {
2444 if (BO.hasNoUnsignedWrap()) {
2445 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2446 Lower = *C;
2447 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2448 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2449 if (C->isNegative()) {
2450 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2451 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2452 Lower = C->shl(ShiftAmount);
2453 Upper = *C + 1;
2454 } else {
2455 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2456 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2457 Lower = *C;
2458 Upper = C->shl(ShiftAmount) + 1;
2459 }
2460 }
2461 }
2462 break;
2463
2464 case Instruction::SDiv:
2465 if (match(BO.getOperand(1), m_APInt(C))) {
2466 APInt IntMin = APInt::getSignedMinValue(Width);
2467 APInt IntMax = APInt::getSignedMaxValue(Width);
2468 if (C->isAllOnesValue()) {
2469 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2470 // where C != -1 and C != 0 and C != 1
2471 Lower = IntMin + 1;
2472 Upper = IntMax + 1;
2473 } else if (C->countLeadingZeros() < Width - 1) {
2474 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2475 // where C != -1 and C != 0 and C != 1
2476 Lower = IntMin.sdiv(*C);
2477 Upper = IntMax.sdiv(*C);
2478 if (Lower.sgt(Upper))
2479 std::swap(Lower, Upper);
2480 Upper = Upper + 1;
2481 assert(Upper != Lower && "Upper part of range has wrapped!");
2482 }
2483 } else if (match(BO.getOperand(0), m_APInt(C))) {
2484 if (C->isMinSignedValue()) {
2485 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2486 Lower = *C;
2487 Upper = Lower.lshr(1) + 1;
2488 } else {
2489 // 'sdiv C, x' produces [-|C|, |C|].
2490 Upper = C->abs() + 1;
2491 Lower = (-Upper) + 1;
2492 }
2493 }
2494 break;
2495
2496 case Instruction::UDiv:
2497 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2498 // 'udiv x, C' produces [0, UINT_MAX / C].
2499 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2500 } else if (match(BO.getOperand(0), m_APInt(C))) {
2501 // 'udiv C, x' produces [0, C].
2502 Upper = *C + 1;
2503 }
2504 break;
2505
2506 case Instruction::SRem:
2507 if (match(BO.getOperand(1), m_APInt(C))) {
2508 // 'srem x, C' produces (-|C|, |C|).
2509 Upper = C->abs();
2510 Lower = (-Upper) + 1;
2511 }
2512 break;
2513
2514 case Instruction::URem:
2515 if (match(BO.getOperand(1), m_APInt(C)))
2516 // 'urem x, C' produces [0, C).
2517 Upper = *C;
2518 break;
2519
2520 default:
2521 break;
2522 }
2523}
2524
Sanjay Patel67bde282016-08-22 23:12:02 +00002525static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2526 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002527 const APInt *C;
2528 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002529 return nullptr;
2530
2531 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002532 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002533 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002534 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002535 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002536 return ConstantInt::getTrue(GetCompareTy(RHS));
2537
Sanjay Patelbe332132017-01-23 18:22:26 +00002538 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002539 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002540 APInt Lower = APInt(Width, 0);
2541 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002542 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2543 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002544
2545 ConstantRange LHS_CR =
2546 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2547
2548 if (auto *I = dyn_cast<Instruction>(LHS))
2549 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2550 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2551
2552 if (!LHS_CR.isFullSet()) {
2553 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002554 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002555 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002556 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002557 }
2558
2559 return nullptr;
2560}
2561
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002562static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
2563 Value *RHS, const Query &Q,
2564 unsigned MaxRecurse) {
2565 Type *ITy = GetCompareTy(LHS); // The return type.
2566
2567 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2568 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2569 if (MaxRecurse && (LBO || RBO)) {
2570 // Analyze the case when either LHS or RHS is an add instruction.
2571 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2572 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2573 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2574 if (LBO && LBO->getOpcode() == Instruction::Add) {
2575 A = LBO->getOperand(0);
2576 B = LBO->getOperand(1);
2577 NoLHSWrapProblem =
2578 ICmpInst::isEquality(Pred) ||
2579 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2580 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2581 }
2582 if (RBO && RBO->getOpcode() == Instruction::Add) {
2583 C = RBO->getOperand(0);
2584 D = RBO->getOperand(1);
2585 NoRHSWrapProblem =
2586 ICmpInst::isEquality(Pred) ||
2587 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2588 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2589 }
2590
2591 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2592 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2593 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2594 Constant::getNullValue(RHS->getType()), Q,
2595 MaxRecurse - 1))
2596 return V;
2597
2598 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2599 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2600 if (Value *V =
2601 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2602 C == LHS ? D : C, Q, MaxRecurse - 1))
2603 return V;
2604
2605 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2606 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2607 NoRHSWrapProblem) {
2608 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2609 Value *Y, *Z;
2610 if (A == C) {
2611 // C + B == C + D -> B == D
2612 Y = B;
2613 Z = D;
2614 } else if (A == D) {
2615 // D + B == C + D -> B == C
2616 Y = B;
2617 Z = C;
2618 } else if (B == C) {
2619 // A + C == C + D -> A == D
2620 Y = A;
2621 Z = D;
2622 } else {
2623 assert(B == D);
2624 // A + D == C + D -> A == C
2625 Y = A;
2626 Z = C;
2627 }
2628 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2629 return V;
2630 }
2631 }
2632
2633 {
2634 Value *Y = nullptr;
2635 // icmp pred (or X, Y), X
2636 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2637 if (Pred == ICmpInst::ICMP_ULT)
2638 return getFalse(ITy);
2639 if (Pred == ICmpInst::ICMP_UGE)
2640 return getTrue(ITy);
2641
2642 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
2643 bool RHSKnownNonNegative, RHSKnownNegative;
2644 bool YKnownNonNegative, YKnownNegative;
2645 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, Q.DL, 0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002646 Q.AC, Q.CxtI, Q.DT);
2647 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002648 Q.CxtI, Q.DT);
2649 if (RHSKnownNonNegative && YKnownNegative)
2650 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
2651 if (RHSKnownNegative || YKnownNonNegative)
2652 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2653 }
2654 }
2655 // icmp pred X, (or X, Y)
2656 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2657 if (Pred == ICmpInst::ICMP_ULE)
2658 return getTrue(ITy);
2659 if (Pred == ICmpInst::ICMP_UGT)
2660 return getFalse(ITy);
2661
2662 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
2663 bool LHSKnownNonNegative, LHSKnownNegative;
2664 bool YKnownNonNegative, YKnownNegative;
2665 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002666 Q.AC, Q.CxtI, Q.DT);
2667 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002668 Q.CxtI, Q.DT);
2669 if (LHSKnownNonNegative && YKnownNegative)
2670 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
2671 if (LHSKnownNegative || YKnownNonNegative)
2672 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2673 }
2674 }
2675 }
2676
2677 // icmp pred (and X, Y), X
2678 if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2679 m_And(m_Specific(RHS), m_Value())))) {
2680 if (Pred == ICmpInst::ICMP_UGT)
2681 return getFalse(ITy);
2682 if (Pred == ICmpInst::ICMP_ULE)
2683 return getTrue(ITy);
2684 }
2685 // icmp pred X, (and X, Y)
2686 if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2687 m_And(m_Specific(LHS), m_Value())))) {
2688 if (Pred == ICmpInst::ICMP_UGE)
2689 return getTrue(ITy);
2690 if (Pred == ICmpInst::ICMP_ULT)
2691 return getFalse(ITy);
2692 }
2693
2694 // 0 - (zext X) pred C
2695 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2696 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2697 if (RHSC->getValue().isStrictlyPositive()) {
2698 if (Pred == ICmpInst::ICMP_SLT)
2699 return ConstantInt::getTrue(RHSC->getContext());
2700 if (Pred == ICmpInst::ICMP_SGE)
2701 return ConstantInt::getFalse(RHSC->getContext());
2702 if (Pred == ICmpInst::ICMP_EQ)
2703 return ConstantInt::getFalse(RHSC->getContext());
2704 if (Pred == ICmpInst::ICMP_NE)
2705 return ConstantInt::getTrue(RHSC->getContext());
2706 }
2707 if (RHSC->getValue().isNonNegative()) {
2708 if (Pred == ICmpInst::ICMP_SLE)
2709 return ConstantInt::getTrue(RHSC->getContext());
2710 if (Pred == ICmpInst::ICMP_SGT)
2711 return ConstantInt::getFalse(RHSC->getContext());
2712 }
2713 }
2714 }
2715
2716 // icmp pred (urem X, Y), Y
2717 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2718 bool KnownNonNegative, KnownNegative;
2719 switch (Pred) {
2720 default:
2721 break;
2722 case ICmpInst::ICMP_SGT:
2723 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002724 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2725 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002726 if (!KnownNonNegative)
2727 break;
2728 LLVM_FALLTHROUGH;
2729 case ICmpInst::ICMP_EQ:
2730 case ICmpInst::ICMP_UGT:
2731 case ICmpInst::ICMP_UGE:
2732 return getFalse(ITy);
2733 case ICmpInst::ICMP_SLT:
2734 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002735 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2736 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002737 if (!KnownNonNegative)
2738 break;
2739 LLVM_FALLTHROUGH;
2740 case ICmpInst::ICMP_NE:
2741 case ICmpInst::ICMP_ULT:
2742 case ICmpInst::ICMP_ULE:
2743 return getTrue(ITy);
2744 }
2745 }
2746
2747 // icmp pred X, (urem Y, X)
2748 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2749 bool KnownNonNegative, KnownNegative;
2750 switch (Pred) {
2751 default:
2752 break;
2753 case ICmpInst::ICMP_SGT:
2754 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002755 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2756 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002757 if (!KnownNonNegative)
2758 break;
2759 LLVM_FALLTHROUGH;
2760 case ICmpInst::ICMP_NE:
2761 case ICmpInst::ICMP_UGT:
2762 case ICmpInst::ICMP_UGE:
2763 return getTrue(ITy);
2764 case ICmpInst::ICMP_SLT:
2765 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002766 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2767 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002768 if (!KnownNonNegative)
2769 break;
2770 LLVM_FALLTHROUGH;
2771 case ICmpInst::ICMP_EQ:
2772 case ICmpInst::ICMP_ULT:
2773 case ICmpInst::ICMP_ULE:
2774 return getFalse(ITy);
2775 }
2776 }
2777
2778 // x >> y <=u x
2779 // x udiv y <=u x.
2780 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2781 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2782 // icmp pred (X op Y), X
2783 if (Pred == ICmpInst::ICMP_UGT)
2784 return getFalse(ITy);
2785 if (Pred == ICmpInst::ICMP_ULE)
2786 return getTrue(ITy);
2787 }
2788
2789 // x >=u x >> y
2790 // x >=u x udiv y.
2791 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2792 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2793 // icmp pred X, (X op Y)
2794 if (Pred == ICmpInst::ICMP_ULT)
2795 return getFalse(ITy);
2796 if (Pred == ICmpInst::ICMP_UGE)
2797 return getTrue(ITy);
2798 }
2799
2800 // handle:
2801 // CI2 << X == CI
2802 // CI2 << X != CI
2803 //
2804 // where CI2 is a power of 2 and CI isn't
2805 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2806 const APInt *CI2Val, *CIVal = &CI->getValue();
2807 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2808 CI2Val->isPowerOf2()) {
2809 if (!CIVal->isPowerOf2()) {
2810 // CI2 << X can equal zero in some circumstances,
2811 // this simplification is unsafe if CI is zero.
2812 //
2813 // We know it is safe if:
2814 // - The shift is nsw, we can't shift out the one bit.
2815 // - The shift is nuw, we can't shift out the one bit.
2816 // - CI2 is one
2817 // - CI isn't zero
2818 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2819 *CI2Val == 1 || !CI->isZero()) {
2820 if (Pred == ICmpInst::ICMP_EQ)
2821 return ConstantInt::getFalse(RHS->getContext());
2822 if (Pred == ICmpInst::ICMP_NE)
2823 return ConstantInt::getTrue(RHS->getContext());
2824 }
2825 }
2826 if (CIVal->isSignBit() && *CI2Val == 1) {
2827 if (Pred == ICmpInst::ICMP_UGT)
2828 return ConstantInt::getFalse(RHS->getContext());
2829 if (Pred == ICmpInst::ICMP_ULE)
2830 return ConstantInt::getTrue(RHS->getContext());
2831 }
2832 }
2833 }
2834
2835 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2836 LBO->getOperand(1) == RBO->getOperand(1)) {
2837 switch (LBO->getOpcode()) {
2838 default:
2839 break;
2840 case Instruction::UDiv:
2841 case Instruction::LShr:
2842 if (ICmpInst::isSigned(Pred))
2843 break;
2844 LLVM_FALLTHROUGH;
2845 case Instruction::SDiv:
2846 case Instruction::AShr:
2847 if (!LBO->isExact() || !RBO->isExact())
2848 break;
2849 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2850 RBO->getOperand(0), Q, MaxRecurse - 1))
2851 return V;
2852 break;
2853 case Instruction::Shl: {
2854 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2855 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2856 if (!NUW && !NSW)
2857 break;
2858 if (!NSW && ICmpInst::isSigned(Pred))
2859 break;
2860 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2861 RBO->getOperand(0), Q, MaxRecurse - 1))
2862 return V;
2863 break;
2864 }
2865 }
2866 }
2867 return nullptr;
2868}
2869
Sanjay Patel35289c62016-12-10 17:40:47 +00002870/// Simplify integer comparisons where at least one operand of the compare
2871/// matches an integer min/max idiom.
2872static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
2873 Value *RHS, const Query &Q,
2874 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002875 Type *ITy = GetCompareTy(LHS); // The return type.
2876 Value *A, *B;
2877 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2878 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2879
2880 // Signed variants on "max(a,b)>=a -> true".
2881 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2882 if (A != RHS)
2883 std::swap(A, B); // smax(A, B) pred A.
2884 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2885 // We analyze this as smax(A, B) pred A.
2886 P = Pred;
2887 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2888 (A == LHS || B == LHS)) {
2889 if (A != LHS)
2890 std::swap(A, B); // A pred smax(A, B).
2891 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2892 // We analyze this as smax(A, B) swapped-pred A.
2893 P = CmpInst::getSwappedPredicate(Pred);
2894 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2895 (A == RHS || B == RHS)) {
2896 if (A != RHS)
2897 std::swap(A, B); // smin(A, B) pred A.
2898 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2899 // We analyze this as smax(-A, -B) swapped-pred -A.
2900 // Note that we do not need to actually form -A or -B thanks to EqP.
2901 P = CmpInst::getSwappedPredicate(Pred);
2902 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2903 (A == LHS || B == LHS)) {
2904 if (A != LHS)
2905 std::swap(A, B); // A pred smin(A, B).
2906 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2907 // We analyze this as smax(-A, -B) pred -A.
2908 // Note that we do not need to actually form -A or -B thanks to EqP.
2909 P = Pred;
2910 }
2911 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2912 // Cases correspond to "max(A, B) p A".
2913 switch (P) {
2914 default:
2915 break;
2916 case CmpInst::ICMP_EQ:
2917 case CmpInst::ICMP_SLE:
2918 // Equivalent to "A EqP B". This may be the same as the condition tested
2919 // in the max/min; if so, we can just return that.
2920 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2921 return V;
2922 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2923 return V;
2924 // Otherwise, see if "A EqP B" simplifies.
2925 if (MaxRecurse)
2926 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2927 return V;
2928 break;
2929 case CmpInst::ICMP_NE:
2930 case CmpInst::ICMP_SGT: {
2931 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2932 // Equivalent to "A InvEqP B". This may be the same as the condition
2933 // tested in the max/min; if so, we can just return that.
2934 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2935 return V;
2936 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2937 return V;
2938 // Otherwise, see if "A InvEqP B" simplifies.
2939 if (MaxRecurse)
2940 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2941 return V;
2942 break;
2943 }
2944 case CmpInst::ICMP_SGE:
2945 // Always true.
2946 return getTrue(ITy);
2947 case CmpInst::ICMP_SLT:
2948 // Always false.
2949 return getFalse(ITy);
2950 }
2951 }
2952
2953 // Unsigned variants on "max(a,b)>=a -> true".
2954 P = CmpInst::BAD_ICMP_PREDICATE;
2955 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2956 if (A != RHS)
2957 std::swap(A, B); // umax(A, B) pred A.
2958 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2959 // We analyze this as umax(A, B) pred A.
2960 P = Pred;
2961 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2962 (A == LHS || B == LHS)) {
2963 if (A != LHS)
2964 std::swap(A, B); // A pred umax(A, B).
2965 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2966 // We analyze this as umax(A, B) swapped-pred A.
2967 P = CmpInst::getSwappedPredicate(Pred);
2968 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2969 (A == RHS || B == RHS)) {
2970 if (A != RHS)
2971 std::swap(A, B); // umin(A, B) pred A.
2972 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2973 // We analyze this as umax(-A, -B) swapped-pred -A.
2974 // Note that we do not need to actually form -A or -B thanks to EqP.
2975 P = CmpInst::getSwappedPredicate(Pred);
2976 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2977 (A == LHS || B == LHS)) {
2978 if (A != LHS)
2979 std::swap(A, B); // A pred umin(A, B).
2980 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2981 // We analyze this as umax(-A, -B) pred -A.
2982 // Note that we do not need to actually form -A or -B thanks to EqP.
2983 P = Pred;
2984 }
2985 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2986 // Cases correspond to "max(A, B) p A".
2987 switch (P) {
2988 default:
2989 break;
2990 case CmpInst::ICMP_EQ:
2991 case CmpInst::ICMP_ULE:
2992 // Equivalent to "A EqP B". This may be the same as the condition tested
2993 // in the max/min; if so, we can just return that.
2994 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2995 return V;
2996 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2997 return V;
2998 // Otherwise, see if "A EqP B" simplifies.
2999 if (MaxRecurse)
3000 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3001 return V;
3002 break;
3003 case CmpInst::ICMP_NE:
3004 case CmpInst::ICMP_UGT: {
3005 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3006 // Equivalent to "A InvEqP B". This may be the same as the condition
3007 // tested in the max/min; if so, we can just return that.
3008 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3009 return V;
3010 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3011 return V;
3012 // Otherwise, see if "A InvEqP B" simplifies.
3013 if (MaxRecurse)
3014 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3015 return V;
3016 break;
3017 }
3018 case CmpInst::ICMP_UGE:
3019 // Always true.
3020 return getTrue(ITy);
3021 case CmpInst::ICMP_ULT:
3022 // Always false.
3023 return getFalse(ITy);
3024 }
3025 }
3026
3027 // Variants on "max(x,y) >= min(x,z)".
3028 Value *C, *D;
3029 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3030 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3031 (A == C || A == D || B == C || B == D)) {
3032 // max(x, ?) pred min(x, ?).
3033 if (Pred == CmpInst::ICMP_SGE)
3034 // Always true.
3035 return getTrue(ITy);
3036 if (Pred == CmpInst::ICMP_SLT)
3037 // Always false.
3038 return getFalse(ITy);
3039 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3040 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3041 (A == C || A == D || B == C || B == D)) {
3042 // min(x, ?) pred max(x, ?).
3043 if (Pred == CmpInst::ICMP_SLE)
3044 // Always true.
3045 return getTrue(ITy);
3046 if (Pred == CmpInst::ICMP_SGT)
3047 // Always false.
3048 return getFalse(ITy);
3049 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3050 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3051 (A == C || A == D || B == C || B == D)) {
3052 // max(x, ?) pred min(x, ?).
3053 if (Pred == CmpInst::ICMP_UGE)
3054 // Always true.
3055 return getTrue(ITy);
3056 if (Pred == CmpInst::ICMP_ULT)
3057 // Always false.
3058 return getFalse(ITy);
3059 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3060 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3061 (A == C || A == D || B == C || B == D)) {
3062 // min(x, ?) pred max(x, ?).
3063 if (Pred == CmpInst::ICMP_ULE)
3064 // Always true.
3065 return getTrue(ITy);
3066 if (Pred == CmpInst::ICMP_UGT)
3067 // Always false.
3068 return getFalse(ITy);
3069 }
3070
3071 return nullptr;
3072}
3073
Sanjay Patel472cc782016-01-11 22:14:42 +00003074/// Given operands for an ICmpInst, see if we can fold the result.
3075/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003076static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003077 const Query &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003078 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003079 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003080
Chris Lattnera71e9d62009-11-10 00:55:12 +00003081 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003082 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003083 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003084
3085 // If we have a constant, make sure it is on the RHS.
3086 std::swap(LHS, RHS);
3087 Pred = CmpInst::getSwappedPredicate(Pred);
3088 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003089
Chris Lattner229907c2011-07-18 04:54:35 +00003090 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003091
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003092 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00003093 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
3094 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00003095 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003096 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003097
Sanjay Pateldc65a272016-12-03 17:30:22 +00003098 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3099 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003100
Sanjay Pateldc65a272016-12-03 17:30:22 +00003101 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3102 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003103
Sanjay Patel67bde282016-08-22 23:12:02 +00003104 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3105 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003106
Chen Li7452d952015-09-26 03:26:47 +00003107 // If both operands have range metadata, use the metadata
3108 // to simplify the comparison.
3109 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003110 auto RHS_Instr = cast<Instruction>(RHS);
3111 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003112
3113 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3114 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003115 auto RHS_CR = getConstantRangeFromMetadata(
3116 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3117 auto LHS_CR = getConstantRangeFromMetadata(
3118 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003119
3120 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3121 if (Satisfied_CR.contains(LHS_CR))
3122 return ConstantInt::getTrue(RHS->getContext());
3123
3124 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3125 CmpInst::getInversePredicate(Pred), RHS_CR);
3126 if (InversedSatisfied_CR.contains(LHS_CR))
3127 return ConstantInt::getFalse(RHS->getContext());
3128 }
3129 }
3130
Duncan Sands8fb2c382011-01-20 13:21:55 +00003131 // Compare of cast, for example (zext X) != 0 -> X != 0
3132 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3133 Instruction *LI = cast<CastInst>(LHS);
3134 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003135 Type *SrcTy = SrcOp->getType();
3136 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003137
3138 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3139 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003140 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3141 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003142 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3143 // Transfer the cast to the constant.
3144 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3145 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003146 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003147 return V;
3148 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3149 if (RI->getOperand(0)->getType() == SrcTy)
3150 // Compare without the cast.
3151 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003152 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003153 return V;
3154 }
3155 }
3156
3157 if (isa<ZExtInst>(LHS)) {
3158 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3159 // same type.
3160 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3161 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3162 // Compare X and Y. Note that signed predicates become unsigned.
3163 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003164 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003165 MaxRecurse-1))
3166 return V;
3167 }
3168 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3169 // too. If not, then try to deduce the result of the comparison.
3170 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3171 // Compute the constant that would happen if we truncated to SrcTy then
3172 // reextended to DstTy.
3173 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3174 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3175
3176 // If the re-extended constant didn't change then this is effectively
3177 // also a case of comparing two zero-extended values.
3178 if (RExt == CI && MaxRecurse)
3179 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003180 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003181 return V;
3182
3183 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3184 // there. Use this to work out the result of the comparison.
3185 if (RExt != CI) {
3186 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003187 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003188 // LHS <u RHS.
3189 case ICmpInst::ICMP_EQ:
3190 case ICmpInst::ICMP_UGT:
3191 case ICmpInst::ICMP_UGE:
3192 return ConstantInt::getFalse(CI->getContext());
3193
3194 case ICmpInst::ICMP_NE:
3195 case ICmpInst::ICMP_ULT:
3196 case ICmpInst::ICMP_ULE:
3197 return ConstantInt::getTrue(CI->getContext());
3198
3199 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3200 // is non-negative then LHS <s RHS.
3201 case ICmpInst::ICMP_SGT:
3202 case ICmpInst::ICMP_SGE:
3203 return CI->getValue().isNegative() ?
3204 ConstantInt::getTrue(CI->getContext()) :
3205 ConstantInt::getFalse(CI->getContext());
3206
3207 case ICmpInst::ICMP_SLT:
3208 case ICmpInst::ICMP_SLE:
3209 return CI->getValue().isNegative() ?
3210 ConstantInt::getFalse(CI->getContext()) :
3211 ConstantInt::getTrue(CI->getContext());
3212 }
3213 }
3214 }
3215 }
3216
3217 if (isa<SExtInst>(LHS)) {
3218 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3219 // same type.
3220 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3221 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3222 // Compare X and Y. Note that the predicate does not change.
3223 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003224 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003225 return V;
3226 }
3227 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3228 // too. If not, then try to deduce the result of the comparison.
3229 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3230 // Compute the constant that would happen if we truncated to SrcTy then
3231 // reextended to DstTy.
3232 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3233 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3234
3235 // If the re-extended constant didn't change then this is effectively
3236 // also a case of comparing two sign-extended values.
3237 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003238 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003239 return V;
3240
3241 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3242 // bits there. Use this to work out the result of the comparison.
3243 if (RExt != CI) {
3244 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003245 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003246 case ICmpInst::ICMP_EQ:
3247 return ConstantInt::getFalse(CI->getContext());
3248 case ICmpInst::ICMP_NE:
3249 return ConstantInt::getTrue(CI->getContext());
3250
3251 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3252 // LHS >s RHS.
3253 case ICmpInst::ICMP_SGT:
3254 case ICmpInst::ICMP_SGE:
3255 return CI->getValue().isNegative() ?
3256 ConstantInt::getTrue(CI->getContext()) :
3257 ConstantInt::getFalse(CI->getContext());
3258 case ICmpInst::ICMP_SLT:
3259 case ICmpInst::ICMP_SLE:
3260 return CI->getValue().isNegative() ?
3261 ConstantInt::getFalse(CI->getContext()) :
3262 ConstantInt::getTrue(CI->getContext());
3263
3264 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3265 // LHS >u RHS.
3266 case ICmpInst::ICMP_UGT:
3267 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003268 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003269 if (MaxRecurse)
3270 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3271 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003272 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003273 return V;
3274 break;
3275 case ICmpInst::ICMP_ULT:
3276 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003277 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003278 if (MaxRecurse)
3279 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3280 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003281 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003282 return V;
3283 break;
3284 }
3285 }
3286 }
3287 }
3288 }
3289
James Molloy1d88d6f2015-10-22 13:18:42 +00003290 // icmp eq|ne X, Y -> false|true if X != Y
3291 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003292 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
James Molloy1d88d6f2015-10-22 13:18:42 +00003293 LLVMContext &Ctx = LHS->getType()->getContext();
3294 return Pred == ICmpInst::ICMP_NE ?
3295 ConstantInt::getTrue(Ctx) : ConstantInt::getFalse(Ctx);
3296 }
Junmo Park53470fc2016-04-05 21:14:31 +00003297
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003298 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3299 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003300
Sanjay Patel35289c62016-12-10 17:40:47 +00003301 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003302 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003303
Chandler Carruth8059c842012-03-25 21:28:14 +00003304 // Simplify comparisons of related pointers using a powerful, recursive
3305 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003306 if (LHS->getType()->isPointerTy())
Anna Thomas43d7e1c2016-05-03 14:58:21 +00003307 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI, LHS, RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003308 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003309 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3310 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3311 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3312 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3313 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3314 Q.DL.getTypeSizeInBits(CRHS->getType()))
3315 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI,
3316 CLHS->getPointerOperand(),
3317 CRHS->getPointerOperand()))
3318 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003319
Nick Lewycky3db143e2012-02-26 02:09:49 +00003320 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3321 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3322 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3323 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3324 (ICmpInst::isEquality(Pred) ||
3325 (GLHS->isInBounds() && GRHS->isInBounds() &&
3326 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3327 // The bases are equal and the indices are constant. Build a constant
3328 // expression GEP with the same indices and a null base pointer to see
3329 // what constant folding can make out of it.
3330 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3331 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003332 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3333 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003334
3335 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003336 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3337 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003338 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3339 }
3340 }
3341 }
3342
David Majnemer5854e9f2014-11-16 02:20:08 +00003343 // If a bit is known to be zero for A and known to be one for B,
3344 // then A and B cannot be equal.
3345 if (ICmpInst::isEquality(Pred)) {
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003346 const APInt *RHSVal;
3347 if (match(RHS, m_APInt(RHSVal))) {
3348 unsigned BitWidth = RHSVal->getBitWidth();
David Majnemer5854e9f2014-11-16 02:20:08 +00003349 APInt LHSKnownZero(BitWidth, 0);
3350 APInt LHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003351 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, Q.DL, /*Depth=*/0, Q.AC,
David Majnemer5854e9f2014-11-16 02:20:08 +00003352 Q.CxtI, Q.DT);
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003353 if (((LHSKnownZero & *RHSVal) != 0) || ((LHSKnownOne & ~(*RHSVal)) != 0))
3354 return Pred == ICmpInst::ICMP_EQ ? ConstantInt::getFalse(ITy)
3355 : ConstantInt::getTrue(ITy);
David Majnemer5854e9f2014-11-16 02:20:08 +00003356 }
3357 }
3358
Duncan Sandsf532d312010-11-07 16:12:23 +00003359 // If the comparison is with the result of a select instruction, check whether
3360 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003361 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003362 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003363 return V;
3364
3365 // If the comparison is with the result of a phi instruction, check whether
3366 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003367 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003368 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003369 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003370
Craig Topper9f008862014-04-15 04:59:12 +00003371 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003372}
3373
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003374Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003375 const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00003376 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003377 const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth85dbea92015-12-24 09:08:08 +00003378 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003379 return ::SimplifyICmpInst(Predicate, LHS, RHS, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003380 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003381}
3382
Sanjay Patel472cc782016-01-11 22:14:42 +00003383/// Given operands for an FCmpInst, see if we can fold the result.
3384/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003385static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003386 FastMathFlags FMF, const Query &Q,
3387 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003388 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3389 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3390
Chris Lattnera71e9d62009-11-10 00:55:12 +00003391 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003392 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003393 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003394
Chris Lattnera71e9d62009-11-10 00:55:12 +00003395 // If we have a constant, make sure it is on the RHS.
3396 std::swap(LHS, RHS);
3397 Pred = CmpInst::getSwappedPredicate(Pred);
3398 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003399
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003400 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003401 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003402 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003403 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003404 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003405 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003406
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003407 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3408 if (FMF.noNaNs()) {
3409 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003410 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003411 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003412 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003413 }
3414
Mehdi Aminieb242a52015-03-09 03:20:25 +00003415 // fcmp pred x, undef and fcmp pred undef, x
3416 // fold to true if unordered, false if ordered
3417 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3418 // Choosing NaN for the undef will always make unordered comparison succeed
3419 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003420 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003421 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003422
3423 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003424 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003425 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003426 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003427 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003428 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003429 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003430
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003431 // Handle fcmp with constant RHS
David Majnemer3ee5f342016-04-13 06:55:52 +00003432 const ConstantFP *CFP = nullptr;
3433 if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3434 if (RHS->getType()->isVectorTy())
3435 CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3436 else
3437 CFP = dyn_cast<ConstantFP>(RHSC);
3438 }
3439 if (CFP) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003440 // If the constant is a nan, see if we can fold the comparison based on it.
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003441 if (CFP->getValueAPF().isNaN()) {
3442 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003443 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003444 assert(FCmpInst::isUnordered(Pred) &&
3445 "Comparison must be either ordered or unordered!");
3446 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003447 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003448 }
3449 // Check whether the constant is an infinity.
3450 if (CFP->getValueAPF().isInfinity()) {
3451 if (CFP->getValueAPF().isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003452 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003453 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003454 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003455 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003456 case FCmpInst::FCMP_UGE:
3457 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003458 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003459 default:
3460 break;
3461 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003462 } else {
3463 switch (Pred) {
3464 case FCmpInst::FCMP_OGT:
3465 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003466 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003467 case FCmpInst::FCMP_ULE:
3468 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003469 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003470 default:
3471 break;
3472 }
3473 }
3474 }
3475 if (CFP->getValueAPF().isZero()) {
3476 switch (Pred) {
3477 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003478 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003479 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003480 break;
3481 case FCmpInst::FCMP_OLT:
3482 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003483 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003484 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003485 break;
3486 default:
3487 break;
3488 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003489 }
3490 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003491
Duncan Sandsa620bd12010-11-07 16:46:25 +00003492 // If the comparison is with the result of a select instruction, check whether
3493 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003494 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003495 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003496 return V;
3497
3498 // If the comparison is with the result of a phi instruction, check whether
3499 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003500 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003501 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003502 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003503
Craig Topper9f008862014-04-15 04:59:12 +00003504 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003505}
3506
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003507Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003508 FastMathFlags FMF, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00003509 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003510 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00003511 const Instruction *CxtI) {
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003512 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003513 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003514}
3515
Sanjay Patel472cc782016-01-11 22:14:42 +00003516/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003517static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
3518 const Query &Q,
3519 unsigned MaxRecurse) {
3520 // Trivial replacement.
3521 if (V == Op)
3522 return RepOp;
3523
3524 auto *I = dyn_cast<Instruction>(V);
3525 if (!I)
3526 return nullptr;
3527
3528 // If this is a binary operator, try to simplify it with the replaced op.
3529 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3530 // Consider:
3531 // %cmp = icmp eq i32 %x, 2147483647
3532 // %add = add nsw i32 %x, 1
3533 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3534 //
3535 // We can't replace %sel with %add unless we strip away the flags.
3536 if (isa<OverflowingBinaryOperator>(B))
3537 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3538 return nullptr;
3539 if (isa<PossiblyExactOperator>(B))
3540 if (B->isExact())
3541 return nullptr;
3542
3543 if (MaxRecurse) {
3544 if (B->getOperand(0) == Op)
3545 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3546 MaxRecurse - 1);
3547 if (B->getOperand(1) == Op)
3548 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3549 MaxRecurse - 1);
3550 }
3551 }
3552
3553 // Same for CmpInsts.
3554 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3555 if (MaxRecurse) {
3556 if (C->getOperand(0) == Op)
3557 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3558 MaxRecurse - 1);
3559 if (C->getOperand(1) == Op)
3560 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3561 MaxRecurse - 1);
3562 }
3563 }
3564
3565 // TODO: We could hand off more cases to instsimplify here.
3566
3567 // If all operands are constant after substituting Op for RepOp then we can
3568 // constant fold the instruction.
3569 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3570 // Build a list of all constant operands.
3571 SmallVector<Constant *, 8> ConstOps;
3572 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3573 if (I->getOperand(i) == Op)
3574 ConstOps.push_back(CRepOp);
3575 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3576 ConstOps.push_back(COp);
3577 else
3578 break;
3579 }
3580
3581 // All operands were constants, fold it.
3582 if (ConstOps.size() == I->getNumOperands()) {
3583 if (CmpInst *C = dyn_cast<CmpInst>(I))
3584 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3585 ConstOps[1], Q.DL, Q.TLI);
3586
3587 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3588 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003589 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003590
Manuel Jacobe9024592016-01-21 06:33:22 +00003591 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003592 }
3593 }
3594
3595 return nullptr;
3596}
3597
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003598/// Try to simplify a select instruction when its condition operand is an
3599/// integer comparison where one operand of the compare is a constant.
3600static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3601 const APInt *Y, bool TrueWhenUnset) {
3602 const APInt *C;
3603
3604 // (X & Y) == 0 ? X & ~Y : X --> X
3605 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3606 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3607 *Y == ~*C)
3608 return TrueWhenUnset ? FalseVal : TrueVal;
3609
3610 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3611 // (X & Y) != 0 ? X : X & ~Y --> X
3612 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3613 *Y == ~*C)
3614 return TrueWhenUnset ? FalseVal : TrueVal;
3615
3616 if (Y->isPowerOf2()) {
3617 // (X & Y) == 0 ? X | Y : X --> X | Y
3618 // (X & Y) != 0 ? X | Y : X --> X
3619 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3620 *Y == *C)
3621 return TrueWhenUnset ? TrueVal : FalseVal;
3622
3623 // (X & Y) == 0 ? X : X | Y --> X
3624 // (X & Y) != 0 ? X : X | Y --> X | Y
3625 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3626 *Y == *C)
3627 return TrueWhenUnset ? TrueVal : FalseVal;
3628 }
Matt Arsenault82606662017-01-11 00:57:54 +00003629
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003630 return nullptr;
3631}
3632
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003633/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3634/// eq/ne.
3635static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *TrueVal,
3636 Value *FalseVal,
3637 bool TrueWhenUnset) {
3638 unsigned BitWidth = TrueVal->getType()->getScalarSizeInBits();
Sanjay Patele9fc79b2016-07-21 21:56:00 +00003639 if (!BitWidth)
3640 return nullptr;
Matt Arsenault82606662017-01-11 00:57:54 +00003641
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003642 APInt MinSignedValue;
3643 Value *X;
3644 if (match(CmpLHS, m_Trunc(m_Value(X))) && (X == TrueVal || X == FalseVal)) {
3645 // icmp slt (trunc X), 0 <--> icmp ne (and X, C), 0
3646 // icmp sgt (trunc X), -1 <--> icmp eq (and X, C), 0
3647 unsigned DestSize = CmpLHS->getType()->getScalarSizeInBits();
3648 MinSignedValue = APInt::getSignedMinValue(DestSize).zext(BitWidth);
3649 } else {
3650 // icmp slt X, 0 <--> icmp ne (and X, C), 0
3651 // icmp sgt X, -1 <--> icmp eq (and X, C), 0
3652 X = CmpLHS;
3653 MinSignedValue = APInt::getSignedMinValue(BitWidth);
3654 }
3655
3656 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, &MinSignedValue,
3657 TrueWhenUnset))
3658 return V;
3659
3660 return nullptr;
3661}
3662
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003663/// Try to simplify a select instruction when its condition operand is an
3664/// integer comparison.
3665static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
3666 Value *FalseVal, const Query &Q,
3667 unsigned MaxRecurse) {
3668 ICmpInst::Predicate Pred;
3669 Value *CmpLHS, *CmpRHS;
3670 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3671 return nullptr;
3672
Sanjay Patel5f3c7032016-07-20 23:40:01 +00003673 // FIXME: This code is nearly duplicated in InstCombine. Using/refactoring
3674 // decomposeBitTestICmp() might help.
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003675 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3676 Value *X;
3677 const APInt *Y;
3678 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3679 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3680 Pred == ICmpInst::ICMP_EQ))
3681 return V;
3682 } else if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, m_Zero())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003683 // Comparing signed-less-than 0 checks if the sign bit is set.
3684 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3685 false))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003686 return V;
3687 } else if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, m_AllOnes())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003688 // Comparing signed-greater-than -1 checks if the sign bit is not set.
3689 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3690 true))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003691 return V;
3692 }
3693
3694 if (CondVal->hasOneUse()) {
3695 const APInt *C;
3696 if (match(CmpRHS, m_APInt(C))) {
3697 // X < MIN ? T : F --> F
3698 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3699 return FalseVal;
3700 // X < MIN ? T : F --> F
3701 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3702 return FalseVal;
3703 // X > MAX ? T : F --> F
3704 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3705 return FalseVal;
3706 // X > MAX ? T : F --> F
3707 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3708 return FalseVal;
3709 }
3710 }
3711
3712 // If we have an equality comparison, then we know the value in one of the
3713 // arms of the select. See if substituting this value into the arm and
3714 // simplifying the result yields the same value as the other arm.
3715 if (Pred == ICmpInst::ICMP_EQ) {
3716 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3717 TrueVal ||
3718 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3719 TrueVal)
3720 return FalseVal;
3721 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3722 FalseVal ||
3723 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3724 FalseVal)
3725 return FalseVal;
3726 } else if (Pred == ICmpInst::ICMP_NE) {
3727 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3728 FalseVal ||
3729 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3730 FalseVal)
3731 return TrueVal;
3732 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3733 TrueVal ||
3734 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3735 TrueVal)
3736 return TrueVal;
3737 }
3738
3739 return nullptr;
3740}
3741
Sanjay Patel472cc782016-01-11 22:14:42 +00003742/// Given operands for a SelectInst, see if we can fold the result.
3743/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003744static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
3745 Value *FalseVal, const Query &Q,
3746 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003747 // select true, X, Y -> X
3748 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003749 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3750 if (CB->isAllOnesValue())
3751 return TrueVal;
3752 if (CB->isNullValue())
3753 return FalseVal;
3754 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003755
Chris Lattnerc707fa92010-04-20 05:32:14 +00003756 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003757 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003758 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003759
Chris Lattnerc707fa92010-04-20 05:32:14 +00003760 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
3761 if (isa<Constant>(TrueVal))
3762 return TrueVal;
3763 return FalseVal;
3764 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003765 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3766 return FalseVal;
3767 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3768 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003769
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003770 if (Value *V =
3771 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3772 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003773
Craig Topper9f008862014-04-15 04:59:12 +00003774 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003775}
3776
Duncan Sandsb8cee002012-03-13 11:42:19 +00003777Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003778 const DataLayout &DL,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003779 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003780 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00003781 const Instruction *CxtI) {
3782 return ::SimplifySelectInst(Cond, TrueVal, FalseVal,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003783 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003784}
3785
Sanjay Patel472cc782016-01-11 22:14:42 +00003786/// Given operands for an GetElementPtrInst, see if we can fold the result.
3787/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003788static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3789 const Query &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003790 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003791 unsigned AS =
3792 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003793
Chris Lattner8574aba2009-11-27 00:29:05 +00003794 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003795 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003796 return Ops[0];
3797
Nico Weber48c82402014-08-27 20:06:19 +00003798 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003799 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003800 Type *GEPTy = PointerType::get(LastType, AS);
3801 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3802 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3803
3804 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003805 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003806
Jay Foadb992a632011-07-19 15:07:52 +00003807 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003808 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003809 if (match(Ops[1], m_Zero()))
3810 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003811
David Blaikie4a2e73b2015-04-02 18:55:32 +00003812 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003813 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003814 Value *P;
3815 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003816 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003817 // getelementptr P, N -> P if P points to a type of zero size.
3818 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003819 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003820
3821 // The following transforms are only safe if the ptrtoint cast
3822 // doesn't truncate the pointers.
3823 if (Ops[1]->getType()->getScalarSizeInBits() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003824 Q.DL.getPointerSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003825 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3826 if (match(P, m_Zero()))
3827 return Constant::getNullValue(GEPTy);
3828 Value *Temp;
3829 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003830 if (Temp->getType() == GEPTy)
3831 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003832 return nullptr;
3833 };
3834
3835 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3836 if (TyAllocSize == 1 &&
3837 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3838 if (Value *R = PtrToIntOrZero(P))
3839 return R;
3840
3841 // getelementptr V, (ashr (sub P, V), C) -> Q
3842 // if P points to a type of size 1 << C.
3843 if (match(Ops[1],
3844 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3845 m_ConstantInt(C))) &&
3846 TyAllocSize == 1ULL << C)
3847 if (Value *R = PtrToIntOrZero(P))
3848 return R;
3849
3850 // getelementptr V, (sdiv (sub P, V), C) -> Q
3851 // if P points to a type of size C.
3852 if (match(Ops[1],
3853 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3854 m_SpecificInt(TyAllocSize))))
3855 if (Value *R = PtrToIntOrZero(P))
3856 return R;
3857 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003858 }
3859 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003860
David Majnemerd1501372016-08-07 07:58:12 +00003861 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3862 all_of(Ops.slice(1).drop_back(1),
3863 [](Value *Idx) { return match(Idx, m_Zero()); })) {
3864 unsigned PtrWidth =
3865 Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3866 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3867 APInt BasePtrOffset(PtrWidth, 0);
3868 Value *StrippedBasePtr =
3869 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3870 BasePtrOffset);
3871
David Majnemer5c5df622016-08-16 06:13:46 +00003872 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003873 if (match(Ops.back(),
3874 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3875 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3876 return ConstantExpr::getIntToPtr(CI, GEPTy);
3877 }
David Majnemer5c5df622016-08-16 06:13:46 +00003878 // gep (gep V, C), (xor V, -1) -> C-1
3879 if (match(Ops.back(),
3880 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3881 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3882 return ConstantExpr::getIntToPtr(CI, GEPTy);
3883 }
David Majnemerd1501372016-08-07 07:58:12 +00003884 }
3885 }
3886
Chris Lattner8574aba2009-11-27 00:29:05 +00003887 // Check to see if this is constant foldable.
Jay Foadb992a632011-07-19 15:07:52 +00003888 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Chris Lattner8574aba2009-11-27 00:29:05 +00003889 if (!isa<Constant>(Ops[i]))
Craig Topper9f008862014-04-15 04:59:12 +00003890 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003891
David Blaikie4a2e73b2015-04-02 18:55:32 +00003892 return ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3893 Ops.slice(1));
Chris Lattner8574aba2009-11-27 00:29:05 +00003894}
3895
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003896Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3897 const DataLayout &DL,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003898 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003899 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00003900 const Instruction *CxtI) {
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003901 return ::SimplifyGEPInst(SrcTy, Ops,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003902 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003903}
3904
Sanjay Patel472cc782016-01-11 22:14:42 +00003905/// Given operands for an InsertValueInst, see if we can fold the result.
3906/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003907static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3908 ArrayRef<unsigned> Idxs, const Query &Q,
3909 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003910 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3911 if (Constant *CVal = dyn_cast<Constant>(Val))
3912 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3913
3914 // insertvalue x, undef, n -> x
3915 if (match(Val, m_Undef()))
3916 return Agg;
3917
3918 // insertvalue x, (extractvalue y, n), n
3919 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003920 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3921 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003922 // insertvalue undef, (extractvalue y, n), n -> y
3923 if (match(Agg, m_Undef()))
3924 return EV->getAggregateOperand();
3925
3926 // insertvalue y, (extractvalue y, n), n -> y
3927 if (Agg == EV->getAggregateOperand())
3928 return Agg;
3929 }
3930
Craig Topper9f008862014-04-15 04:59:12 +00003931 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003932}
3933
Chandler Carruth66b31302015-01-04 12:03:27 +00003934Value *llvm::SimplifyInsertValueInst(
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003935 Value *Agg, Value *Val, ArrayRef<unsigned> Idxs, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003936 const TargetLibraryInfo *TLI, const DominatorTree *DT, AssumptionCache *AC,
Chandler Carruth66b31302015-01-04 12:03:27 +00003937 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003938 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003939 RecursionLimit);
3940}
3941
Sanjay Patel472cc782016-01-11 22:14:42 +00003942/// Given operands for an ExtractValueInst, see if we can fold the result.
3943/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003944static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3945 const Query &, unsigned) {
3946 if (auto *CAgg = dyn_cast<Constant>(Agg))
3947 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3948
3949 // extractvalue x, (insertvalue y, elt, n), n -> elt
3950 unsigned NumIdxs = Idxs.size();
3951 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3952 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3953 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3954 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3955 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3956 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3957 Idxs.slice(0, NumCommonIdxs)) {
3958 if (NumIdxs == NumInsertValueIdxs)
3959 return IVI->getInsertedValueOperand();
3960 break;
3961 }
3962 }
3963
3964 return nullptr;
3965}
3966
3967Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3968 const DataLayout &DL,
3969 const TargetLibraryInfo *TLI,
3970 const DominatorTree *DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003971 AssumptionCache *AC,
David Majnemer25a796e2015-07-13 01:15:46 +00003972 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003973 return ::SimplifyExtractValueInst(Agg, Idxs, Query(DL, TLI, DT, AC, CxtI),
David Majnemer25a796e2015-07-13 01:15:46 +00003974 RecursionLimit);
3975}
3976
Sanjay Patel472cc782016-01-11 22:14:42 +00003977/// Given operands for an ExtractElementInst, see if we can fold the result.
3978/// If not, this returns null.
David Majnemer599ca442015-07-13 01:15:53 +00003979static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const Query &,
3980 unsigned) {
3981 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3982 if (auto *CIdx = dyn_cast<Constant>(Idx))
3983 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3984
3985 // The index is not relevant if our vector is a splat.
3986 if (auto *Splat = CVec->getSplatValue())
3987 return Splat;
3988
3989 if (isa<UndefValue>(Vec))
3990 return UndefValue::get(Vec->getType()->getVectorElementType());
3991 }
3992
3993 // If extracting a specified index from the vector, see if we can recursively
3994 // find a previously computed scalar that was inserted into the vector.
David Majnemer8e335ca2015-08-18 22:18:22 +00003995 if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3996 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
David Majnemer599ca442015-07-13 01:15:53 +00003997 return Elt;
David Majnemer599ca442015-07-13 01:15:53 +00003998
3999 return nullptr;
4000}
4001
4002Value *llvm::SimplifyExtractElementInst(
4003 Value *Vec, Value *Idx, const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004004 const DominatorTree *DT, AssumptionCache *AC, const Instruction *CxtI) {
4005 return ::SimplifyExtractElementInst(Vec, Idx, Query(DL, TLI, DT, AC, CxtI),
David Majnemer599ca442015-07-13 01:15:53 +00004006 RecursionLimit);
4007}
4008
Sanjay Patel472cc782016-01-11 22:14:42 +00004009/// See if we can fold the given phi. If not, returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00004010static Value *SimplifyPHINode(PHINode *PN, const Query &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004011 // If all of the PHI's incoming values are the same then replace the PHI node
4012 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00004013 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004014 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00004015 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004016 // If the incoming value is the phi node itself, it can safely be skipped.
4017 if (Incoming == PN) continue;
4018 if (isa<UndefValue>(Incoming)) {
4019 // Remember that we saw an undef value, but otherwise ignore them.
4020 HasUndefInput = true;
4021 continue;
4022 }
4023 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00004024 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00004025 CommonValue = Incoming;
4026 }
4027
4028 // If CommonValue is null then all of the incoming values were either undef or
4029 // equal to the phi node itself.
4030 if (!CommonValue)
4031 return UndefValue::get(PN->getType());
4032
4033 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4034 // instruction, we cannot return X as the result of the PHI node unless it
4035 // dominates the PHI block.
4036 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00004037 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004038
4039 return CommonValue;
4040}
4041
David Majnemer6774d612016-07-26 17:58:05 +00004042static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
4043 Type *Ty, const Query &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004044 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004045 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004046
David Majnemer6774d612016-07-26 17:58:05 +00004047 if (auto *CI = dyn_cast<CastInst>(Op)) {
4048 auto *Src = CI->getOperand(0);
4049 Type *SrcTy = Src->getType();
4050 Type *MidTy = CI->getType();
4051 Type *DstTy = Ty;
4052 if (Src->getType() == Ty) {
4053 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4054 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4055 Type *SrcIntPtrTy =
4056 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4057 Type *MidIntPtrTy =
4058 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4059 Type *DstIntPtrTy =
4060 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4061 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4062 SrcIntPtrTy, MidIntPtrTy,
4063 DstIntPtrTy) == Instruction::BitCast)
4064 return Src;
4065 }
4066 }
David Majnemera90a6212016-07-26 05:52:29 +00004067
4068 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004069 if (CastOpc == Instruction::BitCast)
4070 if (Op->getType() == Ty)
4071 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004072
4073 return nullptr;
4074}
4075
David Majnemer6774d612016-07-26 17:58:05 +00004076Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
4077 const DataLayout &DL,
4078 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004079 const DominatorTree *DT, AssumptionCache *AC,
David Majnemer6774d612016-07-26 17:58:05 +00004080 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004081 return ::SimplifyCastInst(CastOpc, Op, Ty, Query(DL, TLI, DT, AC, CxtI),
David Majnemer6774d612016-07-26 17:58:05 +00004082 RecursionLimit);
David Majnemera90a6212016-07-26 05:52:29 +00004083}
4084
Zvi Rackover8f460652017-04-03 22:05:30 +00004085static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4086 Type *RetTy, const Query &Q,
4087 unsigned MaxRecurse) {
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004088 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004089 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004090 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004091
4092 auto *Op0Const = dyn_cast<Constant>(Op0);
4093 auto *Op1Const = dyn_cast<Constant>(Op1);
4094
4095 // If all operands are constant, constant fold the shuffle.
4096 if (Op0Const && Op1Const)
4097 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4098
4099 // If only one of the operands is constant, constant fold the shuffle if the
4100 // mask does not select elements from the variable operand.
4101 bool MaskSelects0 = false, MaskSelects1 = false;
4102 for (unsigned i = 0; i != MaskNumElts; ++i) {
4103 int Idx = ShuffleVectorInst::getMaskValue(Mask, i);
4104 if (Idx == -1)
4105 continue;
4106 if ((unsigned)Idx < InVecNumElts)
4107 MaskSelects0 = true;
4108 else
4109 MaskSelects1 = true;
4110 }
4111 if (!MaskSelects0 && Op1Const)
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004112 return ConstantFoldShuffleVectorInstruction(UndefValue::get(InVecTy),
Zvi Rackover8f460652017-04-03 22:05:30 +00004113 Op1Const, Mask);
4114 if (!MaskSelects1 && Op0Const)
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004115 return ConstantFoldShuffleVectorInstruction(Op0Const,
4116 UndefValue::get(InVecTy), Mask);
4117
4118 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4119 // value type is same as the input vectors' type.
4120 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
4121 if (!MaskSelects1 && RetTy == InVecTy &&
4122 OpShuf->getMask()->getSplatValue())
4123 return Op0;
4124 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op1))
4125 if (!MaskSelects0 && RetTy == InVecTy &&
4126 OpShuf->getMask()->getSplatValue())
4127 return Op1;
Zvi Rackover8f460652017-04-03 22:05:30 +00004128
4129 return nullptr;
4130}
4131
4132/// Given operands for a ShuffleVectorInst, fold the result or return null.
4133Value *llvm::SimplifyShuffleVectorInst(
4134 Value *Op0, Value *Op1, Constant *Mask, Type *RetTy,
4135 const DataLayout &DL, const TargetLibraryInfo *TLI, const DominatorTree *DT,
4136 AssumptionCache *AC, const Instruction *CxtI) {
4137 return ::SimplifyShuffleVectorInst(
4138 Op0, Op1, Mask, RetTy, Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
4139}
4140
Chris Lattnera71e9d62009-11-10 00:55:12 +00004141//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004142
Sanjay Patel472cc782016-01-11 22:14:42 +00004143/// Given operands for a BinaryOperator, see if we can fold the result.
4144/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004145static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +00004146 const Query &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004147 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004148 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004149 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004150 case Instruction::FAdd:
4151 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004152 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004153 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004154 case Instruction::FSub:
4155 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004156 case Instruction::Mul:
4157 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004158 case Instruction::FMul:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004159 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4160 case Instruction::SDiv:
4161 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4162 case Instruction::UDiv:
4163 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004164 case Instruction::FDiv:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004165 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4166 case Instruction::SRem:
4167 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4168 case Instruction::URem:
4169 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004170 case Instruction::FRem:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004171 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004172 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004173 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004174 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004175 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004176 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004177 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4178 case Instruction::And:
4179 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4180 case Instruction::Or:
4181 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4182 case Instruction::Xor:
4183 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004184 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004185 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004186 }
4187}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004188
Sanjay Patel472cc782016-01-11 22:14:42 +00004189/// Given operands for a BinaryOperator, see if we can fold the result.
4190/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004191/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4192/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4193static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4194 const FastMathFlags &FMF, const Query &Q,
4195 unsigned MaxRecurse) {
4196 switch (Opcode) {
4197 case Instruction::FAdd:
4198 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4199 case Instruction::FSub:
4200 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4201 case Instruction::FMul:
4202 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004203 case Instruction::FDiv:
4204 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004205 default:
4206 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4207 }
4208}
4209
Duncan Sands7e800d62010-11-14 11:23:23 +00004210Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004211 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004212 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00004213 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004214 return ::SimplifyBinOp(Opcode, LHS, RHS, Query(DL, TLI, DT, AC, CxtI),
Hal Finkel60db0582014-09-07 18:57:58 +00004215 RecursionLimit);
Chris Lattnerc1f19072009-11-09 23:28:39 +00004216}
4217
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004218Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004219 const FastMathFlags &FMF, const DataLayout &DL,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004220 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004221 const DominatorTree *DT, AssumptionCache *AC,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004222 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004223 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Query(DL, TLI, DT, AC, CxtI),
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004224 RecursionLimit);
4225}
4226
Sanjay Patel472cc782016-01-11 22:14:42 +00004227/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004228static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Duncan Sandsb8cee002012-03-13 11:42:19 +00004229 const Query &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004230 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004231 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004232 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004233}
4234
4235Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004236 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004237 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00004238 const Instruction *CxtI) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004239 return ::SimplifyCmpInst(Predicate, LHS, RHS, Query(DL, TLI, DT, AC, CxtI),
Duncan Sandsb8cee002012-03-13 11:42:19 +00004240 RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004241}
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004242
Michael Ilseman54857292013-02-07 19:26:05 +00004243static bool IsIdempotent(Intrinsic::ID ID) {
4244 switch (ID) {
4245 default: return false;
4246
4247 // Unary idempotent: f(f(x)) = f(x)
4248 case Intrinsic::fabs:
4249 case Intrinsic::floor:
4250 case Intrinsic::ceil:
4251 case Intrinsic::trunc:
4252 case Intrinsic::rint:
4253 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004254 case Intrinsic::round:
Michael Ilseman54857292013-02-07 19:26:05 +00004255 return true;
4256 }
4257}
4258
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004259static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4260 const DataLayout &DL) {
4261 GlobalValue *PtrSym;
4262 APInt PtrOffset;
4263 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4264 return nullptr;
4265
4266 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4267 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4268 Type *Int32PtrTy = Int32Ty->getPointerTo();
4269 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4270
4271 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4272 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4273 return nullptr;
4274
4275 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4276 if (OffsetInt % 4 != 0)
4277 return nullptr;
4278
4279 Constant *C = ConstantExpr::getGetElementPtr(
4280 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4281 ConstantInt::get(Int64Ty, OffsetInt / 4));
4282 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4283 if (!Loaded)
4284 return nullptr;
4285
4286 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4287 if (!LoadedCE)
4288 return nullptr;
4289
4290 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4291 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4292 if (!LoadedCE)
4293 return nullptr;
4294 }
4295
4296 if (LoadedCE->getOpcode() != Instruction::Sub)
4297 return nullptr;
4298
4299 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4300 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4301 return nullptr;
4302 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4303
4304 Constant *LoadedRHS = LoadedCE->getOperand(1);
4305 GlobalValue *LoadedRHSSym;
4306 APInt LoadedRHSOffset;
4307 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4308 DL) ||
4309 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4310 return nullptr;
4311
4312 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4313}
4314
David Majnemer17a95aa2016-07-14 06:58:37 +00004315static bool maskIsAllZeroOrUndef(Value *Mask) {
4316 auto *ConstMask = dyn_cast<Constant>(Mask);
4317 if (!ConstMask)
4318 return false;
4319 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4320 return true;
4321 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4322 ++I) {
4323 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4324 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4325 continue;
4326 return false;
4327 }
4328 return true;
4329}
4330
Michael Ilseman54857292013-02-07 19:26:05 +00004331template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004332static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Michael Ilseman54857292013-02-07 19:26:05 +00004333 const Query &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004334 Intrinsic::ID IID = F->getIntrinsicID();
4335 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004336
4337 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004338 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004339 // Perform idempotent optimizations
4340 if (IsIdempotent(IID)) {
4341 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4342 if (II->getIntrinsicID() == IID)
4343 return II;
4344 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004345 }
4346
4347 switch (IID) {
4348 case Intrinsic::fabs: {
4349 if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4350 return *ArgBegin;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004351 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004352 }
4353 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004354 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004355 }
4356 }
Michael Ilseman54857292013-02-07 19:26:05 +00004357
Matt Arsenault82606662017-01-11 00:57:54 +00004358 // Binary Ops
4359 if (NumOperands == 2) {
4360 Value *LHS = *ArgBegin;
4361 Value *RHS = *(ArgBegin + 1);
4362 Type *ReturnType = F->getReturnType();
4363
4364 switch (IID) {
4365 case Intrinsic::usub_with_overflow:
4366 case Intrinsic::ssub_with_overflow: {
4367 // X - X -> { 0, false }
4368 if (LHS == RHS)
4369 return Constant::getNullValue(ReturnType);
4370
4371 // X - undef -> undef
4372 // undef - X -> undef
4373 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4374 return UndefValue::get(ReturnType);
4375
4376 return nullptr;
4377 }
4378 case Intrinsic::uadd_with_overflow:
4379 case Intrinsic::sadd_with_overflow: {
4380 // X + undef -> undef
4381 if (isa<UndefValue>(RHS))
4382 return UndefValue::get(ReturnType);
4383
4384 return nullptr;
4385 }
4386 case Intrinsic::umul_with_overflow:
4387 case Intrinsic::smul_with_overflow: {
4388 // X * 0 -> { 0, false }
4389 if (match(RHS, m_Zero()))
4390 return Constant::getNullValue(ReturnType);
4391
4392 // X * undef -> { 0, false }
4393 if (match(RHS, m_Undef()))
4394 return Constant::getNullValue(ReturnType);
4395
4396 return nullptr;
4397 }
4398 case Intrinsic::load_relative: {
4399 Constant *C0 = dyn_cast<Constant>(LHS);
4400 Constant *C1 = dyn_cast<Constant>(RHS);
4401 if (C0 && C1)
4402 return SimplifyRelativeLoad(C0, C1, Q.DL);
4403 return nullptr;
4404 }
4405 default:
4406 return nullptr;
4407 }
4408 }
4409
4410 // Simplify calls to llvm.masked.load.*
4411 switch (IID) {
4412 case Intrinsic::masked_load: {
4413 Value *MaskArg = ArgBegin[2];
4414 Value *PassthruArg = ArgBegin[3];
4415 // If the mask is all zeros or undef, the "passthru" argument is the result.
4416 if (maskIsAllZeroOrUndef(MaskArg))
4417 return PassthruArg;
4418 return nullptr;
4419 }
4420 default:
4421 return nullptr;
4422 }
Michael Ilseman54857292013-02-07 19:26:05 +00004423}
4424
Chandler Carruth9dc35582012-12-28 11:30:55 +00004425template <typename IterTy>
Chandler Carruthf6182152012-12-28 14:23:29 +00004426static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
Chandler Carruth9dc35582012-12-28 11:30:55 +00004427 const Query &Q, unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004428 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004429 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4430 Ty = PTy->getElementType();
4431 FunctionType *FTy = cast<FunctionType>(Ty);
4432
Dan Gohman85977e62011-11-04 18:32:42 +00004433 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004434 // call null -> undef
4435 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004436 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004437
Chandler Carruthf6182152012-12-28 14:23:29 +00004438 Function *F = dyn_cast<Function>(V);
4439 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004440 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004441
David Majnemer15032582015-05-22 03:56:46 +00004442 if (F->isIntrinsic())
4443 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004444 return Ret;
4445
Chandler Carruthf6182152012-12-28 14:23:29 +00004446 if (!canConstantFoldCallTo(F))
Craig Topper9f008862014-04-15 04:59:12 +00004447 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004448
4449 SmallVector<Constant *, 4> ConstantArgs;
4450 ConstantArgs.reserve(ArgEnd - ArgBegin);
4451 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4452 Constant *C = dyn_cast<Constant>(*I);
4453 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004454 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004455 ConstantArgs.push_back(C);
4456 }
4457
4458 return ConstantFoldCall(F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004459}
4460
Chandler Carruthf6182152012-12-28 14:23:29 +00004461Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004462 User::op_iterator ArgEnd, const DataLayout &DL,
Chandler Carruth66b31302015-01-04 12:03:27 +00004463 const TargetLibraryInfo *TLI, const DominatorTree *DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004464 AssumptionCache *AC, const Instruction *CxtI) {
4465 return ::SimplifyCall(V, ArgBegin, ArgEnd, Query(DL, TLI, DT, AC, CxtI),
Chandler Carruth9dc35582012-12-28 11:30:55 +00004466 RecursionLimit);
4467}
4468
Chandler Carruthf6182152012-12-28 14:23:29 +00004469Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004470 const DataLayout &DL, const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004471 const DominatorTree *DT, AssumptionCache *AC,
Hal Finkel60db0582014-09-07 18:57:58 +00004472 const Instruction *CxtI) {
4473 return ::SimplifyCall(V, Args.begin(), Args.end(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004474 Query(DL, TLI, DT, AC, CxtI), RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004475}
4476
Sanjay Patel472cc782016-01-11 22:14:42 +00004477/// See if we can compute a simplified version of this instruction.
4478/// If not, this returns null.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004479Value *llvm::SimplifyInstruction(Instruction *I, const DataLayout &DL,
Chad Rosierc24b86f2011-12-01 03:08:23 +00004480 const TargetLibraryInfo *TLI,
Sanjay Patel54656ca2017-02-06 18:26:06 +00004481 const DominatorTree *DT, AssumptionCache *AC,
4482 OptimizationRemarkEmitter *ORE) {
Duncan Sands64e41cf2010-11-17 08:35:29 +00004483 Value *Result;
4484
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004485 switch (I->getOpcode()) {
4486 default:
Rafael Espindola37dc9e12014-02-21 00:06:31 +00004487 Result = ConstantFoldInstruction(I, DL, TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004488 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004489 case Instruction::FAdd:
4490 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004491 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004492 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004493 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004494 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4495 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Chandler Carruth66b31302015-01-04 12:03:27 +00004496 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004497 TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004498 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004499 case Instruction::FSub:
4500 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004501 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004502 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004503 case Instruction::Sub:
4504 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4505 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Chandler Carruth66b31302015-01-04 12:03:27 +00004506 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004507 TLI, DT, AC, I);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004508 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004509 case Instruction::FMul:
4510 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004511 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004512 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004513 case Instruction::Mul:
Chandler Carruth66b31302015-01-04 12:03:27 +00004514 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004515 SimplifyMulInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004516 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004517 case Instruction::SDiv:
Chandler Carruth66b31302015-01-04 12:03:27 +00004518 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004519 AC, I);
Duncan Sands771e82a2011-01-28 16:51:11 +00004520 break;
4521 case Instruction::UDiv:
Chandler Carruth66b31302015-01-04 12:03:27 +00004522 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004523 AC, I);
Duncan Sands771e82a2011-01-28 16:51:11 +00004524 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004525 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004526 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004527 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Frits van Bommelc2549662011-01-29 15:26:31 +00004528 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004529 case Instruction::SRem:
Chandler Carruth66b31302015-01-04 12:03:27 +00004530 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004531 AC, I);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004532 break;
4533 case Instruction::URem:
Chandler Carruth66b31302015-01-04 12:03:27 +00004534 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004535 AC, I);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004536 break;
4537 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004538 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004539 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004540 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004541 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004542 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4543 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Chandler Carruth66b31302015-01-04 12:03:27 +00004544 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004545 TLI, DT, AC, I);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004546 break;
4547 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004548 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Chandler Carruth66b31302015-01-04 12:03:27 +00004549 cast<BinaryOperator>(I)->isExact(), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004550 AC, I);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004551 break;
4552 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004553 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Chandler Carruth66b31302015-01-04 12:03:27 +00004554 cast<BinaryOperator>(I)->isExact(), DL, TLI, DT,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004555 AC, I);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004556 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004557 case Instruction::And:
Chandler Carruth66b31302015-01-04 12:03:27 +00004558 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004559 SimplifyAndInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004560 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004561 case Instruction::Or:
Chandler Carruth66b31302015-01-04 12:03:27 +00004562 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004563 SimplifyOrInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004564 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004565 case Instruction::Xor:
Chandler Carruth66b31302015-01-04 12:03:27 +00004566 Result =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004567 SimplifyXorInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004568 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004569 case Instruction::ICmp:
Chandler Carruth66b31302015-01-04 12:03:27 +00004570 Result =
4571 SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(), I->getOperand(0),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004572 I->getOperand(1), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004573 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004574 case Instruction::FCmp:
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004575 Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(),
4576 I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004577 I->getFastMathFlags(), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004578 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004579 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004580 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004581 I->getOperand(2), DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004582 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004583 case Instruction::GetElementPtr: {
4584 SmallVector<Value*, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004585 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004586 Ops, DL, TLI, DT, AC, I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004587 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004588 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004589 case Instruction::InsertValue: {
4590 InsertValueInst *IV = cast<InsertValueInst>(I);
4591 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4592 IV->getInsertedValueOperand(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004593 IV->getIndices(), DL, TLI, DT, AC, I);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004594 break;
4595 }
David Majnemer25a796e2015-07-13 01:15:46 +00004596 case Instruction::ExtractValue: {
4597 auto *EVI = cast<ExtractValueInst>(I);
4598 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004599 EVI->getIndices(), DL, TLI, DT, AC, I);
David Majnemer25a796e2015-07-13 01:15:46 +00004600 break;
4601 }
David Majnemer599ca442015-07-13 01:15:53 +00004602 case Instruction::ExtractElement: {
4603 auto *EEI = cast<ExtractElementInst>(I);
4604 Result = SimplifyExtractElementInst(
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004605 EEI->getVectorOperand(), EEI->getIndexOperand(), DL, TLI, DT, AC, I);
David Majnemer599ca442015-07-13 01:15:53 +00004606 break;
4607 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004608 case Instruction::ShuffleVector: {
4609 auto *SVI = cast<ShuffleVectorInst>(I);
4610 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
4611 SVI->getMask(), SVI->getType(), DL, TLI,
4612 DT, AC, I);
4613 break;
4614 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004615 case Instruction::PHI:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004616 Result = SimplifyPHINode(cast<PHINode>(I), Query(DL, TLI, DT, AC, I));
Duncan Sands64e41cf2010-11-17 08:35:29 +00004617 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004618 case Instruction::Call: {
4619 CallSite CS(cast<CallInst>(I));
Chandler Carruth66b31302015-01-04 12:03:27 +00004620 Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(), DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004621 TLI, DT, AC, I);
Dan Gohman85977e62011-11-04 18:32:42 +00004622 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004623 }
David Majnemer6774d612016-07-26 17:58:05 +00004624#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4625#include "llvm/IR/Instruction.def"
4626#undef HANDLE_CAST_INST
4627 Result = SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004628 DL, TLI, DT, AC, I);
David Majnemera90a6212016-07-26 05:52:29 +00004629 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004630 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004631
Hal Finkelf2199b22015-10-23 20:37:08 +00004632 // In general, it is possible for computeKnownBits to determine all bits in a
4633 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004634 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Hal Finkelf2199b22015-10-23 20:37:08 +00004635 unsigned BitWidth = I->getType()->getScalarSizeInBits();
4636 APInt KnownZero(BitWidth, 0);
4637 APInt KnownOne(BitWidth, 0);
Sanjay Patel54656ca2017-02-06 18:26:06 +00004638 computeKnownBits(I, KnownZero, KnownOne, DL, /*Depth*/0, AC, I, DT, ORE);
Hal Finkelf2199b22015-10-23 20:37:08 +00004639 if ((KnownZero | KnownOne).isAllOnesValue())
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004640 Result = ConstantInt::get(I->getType(), KnownOne);
Hal Finkelf2199b22015-10-23 20:37:08 +00004641 }
4642
Duncan Sands64e41cf2010-11-17 08:35:29 +00004643 /// If called on unreachable code, the above logic may report that the
4644 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004645 /// detecting that case here, returning a safe value instead.
4646 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004647}
4648
Sanjay Patelf44bd382016-01-20 18:59:48 +00004649/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004650/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004651///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004652/// This is the common implementation of the recursive simplification routines.
4653/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4654/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4655/// instructions to process and attempt to simplify it using
4656/// InstructionSimplify.
4657///
4658/// This routine returns 'true' only when *it* simplifies something. The passed
4659/// in simplified value does not count toward this.
4660static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004661 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004662 const DominatorTree *DT,
4663 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004664 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004665 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004666 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004667
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004668 // If we have an explicit value to collapse to, do that round of the
4669 // simplification loop by hand initially.
4670 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004671 for (User *U : I->users())
4672 if (U != I)
4673 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004674
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004675 // Replace the instruction with its simplified value.
4676 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004677
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004678 // Gracefully handle edge cases where the instruction is not wired into any
4679 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004680 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4681 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004682 I->eraseFromParent();
4683 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004684 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004685 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004686
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004687 // Note that we must test the size on each iteration, the worklist can grow.
4688 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4689 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004690
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004691 // See if this instruction simplifies.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004692 SimpleV = SimplifyInstruction(I, DL, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004693 if (!SimpleV)
4694 continue;
4695
4696 Simplified = true;
4697
4698 // Stash away all the uses of the old instruction so we can check them for
4699 // recursive simplifications after a RAUW. This is cheaper than checking all
4700 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004701 for (User *U : I->users())
4702 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004703
4704 // Replace the instruction with its simplified value.
4705 I->replaceAllUsesWith(SimpleV);
4706
4707 // Gracefully handle edge cases where the instruction is not wired into any
4708 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004709 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4710 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004711 I->eraseFromParent();
4712 }
4713 return Simplified;
4714}
4715
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004716bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004717 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004718 const DominatorTree *DT,
4719 AssumptionCache *AC) {
4720 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004721}
4722
4723bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004724 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004725 const DominatorTree *DT,
4726 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004727 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4728 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004729 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004730}