blob: e81d7672b88b89cdc973d810b4f195af32d04fd6 [file] [log] [blame]
Chris Lattner084a1b52009-11-09 22:57:59 +00001//===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements routines for folding instructions into simpler forms
Duncan Sandsa0219882010-11-23 10:50:08 +000011// that do not require creating new instructions. This does constant folding
12// ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
13// returning a constant ("and i32 %x, 0" -> "0") or an already existing value
Duncan Sandsed6d6c32010-12-20 14:47:04 +000014// ("and i32 %x, %x" -> "%x"). All operands are assumed to have already been
15// simplified: This is usually true and assuming it simplifies the logic (if
16// they have not been simplified then results are correct but maybe suboptimal).
Chris Lattner084a1b52009-11-09 22:57:59 +000017//
18//===----------------------------------------------------------------------===//
19
20#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SetVector.h"
22#include "llvm/ADT/Statistic.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000023#include "llvm/Analysis/AliasAnalysis.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000024#include "llvm/Analysis/AssumptionCache.h"
Anna Thomas43d7e1c2016-05-03 14:58:21 +000025#include "llvm/Analysis/CaptureTracking.h"
Craig Topper0aa3a192017-08-14 21:39:51 +000026#include "llvm/Analysis/CmpInstAnalysis.h"
Chris Lattner084a1b52009-11-09 22:57:59 +000027#include "llvm/Analysis/ConstantFolding.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000028#include "llvm/Analysis/LoopAnalysisManager.h"
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +000029#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000030#include "llvm/Analysis/ValueTracking.h"
David Majnemer599ca442015-07-13 01:15:53 +000031#include "llvm/Analysis/VectorUtils.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000032#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000034#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000035#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000036#include "llvm/IR/GlobalAlias.h"
37#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000038#include "llvm/IR/PatternMatch.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000039#include "llvm/IR/ValueHandle.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000040#include "llvm/Support/KnownBits.h"
Hal Finkelafcd8db2014-12-01 23:38:06 +000041#include <algorithm>
Chris Lattner084a1b52009-11-09 22:57:59 +000042using namespace llvm;
Chris Lattnera71e9d62009-11-10 00:55:12 +000043using namespace llvm::PatternMatch;
Chris Lattner084a1b52009-11-09 22:57:59 +000044
Chandler Carruthf1221bd2014-04-22 02:48:03 +000045#define DEBUG_TYPE "instsimplify"
46
Chris Lattner9e4aa022011-02-09 17:15:04 +000047enum { RecursionLimit = 3 };
Duncan Sandsf3b1bf12010-11-10 18:23:01 +000048
Duncan Sands3547d2e2010-12-22 09:40:51 +000049STATISTIC(NumExpand, "Number of expansions");
Duncan Sands3547d2e2010-12-22 09:40:51 +000050STATISTIC(NumReassoc, "Number of reassociations");
51
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000052static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
53static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000054 unsigned);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +000055static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000056 const SimplifyQuery &, unsigned);
57static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
Chad Rosierc24b86f2011-12-01 03:08:23 +000058 unsigned);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +000059static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000060 const SimplifyQuery &Q, unsigned MaxRecurse);
61static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
62static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
David Majnemer6774d612016-07-26 17:58:05 +000063static Value *SimplifyCastInst(unsigned, Value *, Type *,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +000064 const SimplifyQuery &, unsigned);
Duncan Sands5ffc2982010-11-16 12:16:38 +000065
Sanjay Patel35ed2412017-04-16 17:43:11 +000066/// For a boolean type or a vector of boolean type, return false or a vector
67/// with every element false.
Duncan Sandsc1c92712011-07-26 15:03:53 +000068static Constant *getFalse(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +000069 return ConstantInt::getFalse(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +000070}
71
Sanjay Patel35ed2412017-04-16 17:43:11 +000072/// For a boolean type or a vector of boolean type, return true or a vector
73/// with every element true.
Duncan Sandsc1c92712011-07-26 15:03:53 +000074static Constant *getTrue(Type *Ty) {
Sanjay Patel35ed2412017-04-16 17:43:11 +000075 return ConstantInt::getTrue(Ty);
Duncan Sandsc1c92712011-07-26 15:03:53 +000076}
77
Duncan Sands3d5692a2011-10-30 19:56:36 +000078/// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
79static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
80 Value *RHS) {
81 CmpInst *Cmp = dyn_cast<CmpInst>(V);
82 if (!Cmp)
83 return false;
84 CmpInst::Predicate CPred = Cmp->getPredicate();
85 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
86 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
87 return true;
88 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
89 CRHS == LHS;
90}
91
Sanjay Patel472cc782016-01-11 22:14:42 +000092/// Does the given value dominate the specified phi node?
Duncan Sands5ffc2982010-11-16 12:16:38 +000093static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
94 Instruction *I = dyn_cast<Instruction>(V);
95 if (!I)
96 // Arguments and constants dominate all instructions.
97 return true;
98
Chandler Carruth3ffccb32012-03-21 10:58:47 +000099 // If we are processing instructions (and/or basic blocks) that have not been
100 // fully added to a function, the parent nodes may still be null. Simply
101 // return the conservative answer in these cases.
102 if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
103 return false;
104
Duncan Sands5ffc2982010-11-16 12:16:38 +0000105 // If we have a DominatorTree then do a precise test.
Daniel Berlin71ff6632017-05-31 01:47:24 +0000106 if (DT)
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000107 return DT->dominates(I, P);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000108
David Majnemer8a1c45d2015-12-12 05:38:55 +0000109 // Otherwise, if the instruction is in the entry block and is not an invoke,
110 // then it obviously dominates all phi nodes.
Duncan Sands5ffc2982010-11-16 12:16:38 +0000111 if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000112 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000113 return true;
114
115 return false;
116}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000117
Sanjay Patel472cc782016-01-11 22:14:42 +0000118/// Simplify "A op (B op' C)" by distributing op over op', turning it into
119/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000120/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
121/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
122/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000123static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
Craig Topper9c913bf2017-05-19 16:56:53 +0000124 Instruction::BinaryOps OpcodeToExpand,
125 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000126 // Recursion is always used, so bail out at once if we already hit the limit.
127 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000128 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000129
130 // Check whether the expression has the form "(A op' B) op C".
131 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
132 if (Op0->getOpcode() == OpcodeToExpand) {
133 // It does! Try turning it into "(A op C) op' (B op C)".
134 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
135 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000136 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
137 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000138 // They do! Return "L op' R" if it simplifies or is already available.
139 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000140 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
141 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000142 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000143 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000144 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000145 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000146 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000147 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000148 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000149 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000150 }
151 }
152
153 // Check whether the expression has the form "A op (B op' C)".
154 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
155 if (Op1->getOpcode() == OpcodeToExpand) {
156 // It does! Try turning it into "(A op B) op' (A op C)".
157 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
158 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000159 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
160 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000161 // They do! Return "L op' R" if it simplifies or is already available.
162 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000163 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
164 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000165 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000166 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000167 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000168 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000169 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000170 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000171 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000172 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000173 }
174 }
175
Craig Topper9f008862014-04-15 04:59:12 +0000176 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000177}
178
Sanjay Patel472cc782016-01-11 22:14:42 +0000179/// Generic simplifications for associative binary operations.
180/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000181static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
Craig Topper9c913bf2017-05-19 16:56:53 +0000182 Value *LHS, Value *RHS,
183 const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000184 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000185 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
186
187 // Recursion is always used, so bail out at once if we already hit the limit.
188 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000189 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000190
191 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
192 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
193
194 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
195 if (Op0 && Op0->getOpcode() == Opcode) {
196 Value *A = Op0->getOperand(0);
197 Value *B = Op0->getOperand(1);
198 Value *C = RHS;
199
200 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000201 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000202 // It does! Return "A op V" if it simplifies or is already available.
203 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000204 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000205 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000206 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000207 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000208 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000209 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000210 }
211 }
212
213 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
214 if (Op1 && Op1->getOpcode() == Opcode) {
215 Value *A = LHS;
216 Value *B = Op1->getOperand(0);
217 Value *C = Op1->getOperand(1);
218
219 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000220 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000221 // It does! Return "V op C" if it simplifies or is already available.
222 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000223 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000224 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000225 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000226 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000227 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000228 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000229 }
230 }
231
232 // The remaining transforms require commutativity as well as associativity.
233 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000234 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000235
236 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
237 if (Op0 && Op0->getOpcode() == Opcode) {
238 Value *A = Op0->getOperand(0);
239 Value *B = Op0->getOperand(1);
240 Value *C = RHS;
241
242 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000243 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000244 // It does! Return "V op B" if it simplifies or is already available.
245 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000246 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000247 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000248 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000249 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000250 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000251 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000252 }
253 }
254
255 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
256 if (Op1 && Op1->getOpcode() == Opcode) {
257 Value *A = LHS;
258 Value *B = Op1->getOperand(0);
259 Value *C = Op1->getOperand(1);
260
261 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000262 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000263 // It does! Return "B op V" if it simplifies or is already available.
264 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000265 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000266 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000267 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000268 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000269 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000270 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000271 }
272 }
273
Craig Topper9f008862014-04-15 04:59:12 +0000274 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000275}
276
Sanjay Patel472cc782016-01-11 22:14:42 +0000277/// In the case of a binary operation with a select instruction as an operand,
278/// try to simplify the binop by seeing whether evaluating it on both branches
279/// of the select results in the same value. Returns the common value if so,
280/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000281static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000282 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000283 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000284 // Recursion is always used, so bail out at once if we already hit the limit.
285 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000286 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000287
Duncan Sandsb0579e92010-11-10 13:00:08 +0000288 SelectInst *SI;
289 if (isa<SelectInst>(LHS)) {
290 SI = cast<SelectInst>(LHS);
291 } else {
292 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
293 SI = cast<SelectInst>(RHS);
294 }
295
296 // Evaluate the BinOp on the true and false branches of the select.
297 Value *TV;
298 Value *FV;
299 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000300 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
301 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000302 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000303 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
304 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000305 }
306
Duncan Sandse3c53952011-01-01 16:12:09 +0000307 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000308 // If they both failed to simplify then return null.
309 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000310 return TV;
311
312 // If one branch simplified to undef, return the other one.
313 if (TV && isa<UndefValue>(TV))
314 return FV;
315 if (FV && isa<UndefValue>(FV))
316 return TV;
317
318 // If applying the operation did not change the true and false select values,
319 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000320 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000321 return SI;
322
323 // If one branch simplified and the other did not, and the simplified
324 // value is equal to the unsimplified one, return the simplified value.
325 // For example, select (cond, X, X & Z) & Z -> X & Z.
326 if ((FV && !TV) || (TV && !FV)) {
327 // Check that the simplified value has the form "X op Y" where "op" is the
328 // same as the original operation.
329 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
Zachary Turner260fe3e2017-12-14 22:07:03 +0000330 if (Simplified && Simplified->getOpcode() == unsigned(Opcode)) {
Duncan Sandsb0579e92010-11-10 13:00:08 +0000331 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
332 // We already know that "op" is the same as for the simplified value. See
333 // if the operands match too. If so, return the simplified value.
334 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
335 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
336 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000337 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
338 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000339 return Simplified;
340 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000341 Simplified->getOperand(1) == UnsimplifiedLHS &&
342 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000343 return Simplified;
344 }
345 }
346
Craig Topper9f008862014-04-15 04:59:12 +0000347 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000348}
349
Sanjay Patel472cc782016-01-11 22:14:42 +0000350/// In the case of a comparison with a select instruction, try to simplify the
351/// comparison by seeing whether both branches of the select result in the same
352/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000353static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000354 Value *RHS, const SimplifyQuery &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000355 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000356 // Recursion is always used, so bail out at once if we already hit the limit.
357 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000358 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000359
Duncan Sandsb0579e92010-11-10 13:00:08 +0000360 // Make sure the select is on the LHS.
361 if (!isa<SelectInst>(LHS)) {
362 std::swap(LHS, RHS);
363 Pred = CmpInst::getSwappedPredicate(Pred);
364 }
365 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
366 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000367 Value *Cond = SI->getCondition();
368 Value *TV = SI->getTrueValue();
369 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000370
Duncan Sands06504022011-02-03 09:37:39 +0000371 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000372 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000373 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000374 if (TCmp == Cond) {
375 // It not only simplified, it simplified to the select condition. Replace
376 // it with 'true'.
377 TCmp = getTrue(Cond->getType());
378 } else if (!TCmp) {
379 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
380 // condition then we can replace it with 'true'. Otherwise give up.
381 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000382 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000383 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000384 }
385
Duncan Sands3d5692a2011-10-30 19:56:36 +0000386 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000387 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000388 if (FCmp == Cond) {
389 // It not only simplified, it simplified to the select condition. Replace
390 // it with 'false'.
391 FCmp = getFalse(Cond->getType());
392 } else if (!FCmp) {
393 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
394 // condition then we can replace it with 'false'. Otherwise give up.
395 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000396 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000397 FCmp = getFalse(Cond->getType());
398 }
399
400 // If both sides simplified to the same value, then use it as the result of
401 // the original comparison.
402 if (TCmp == FCmp)
403 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000404
405 // The remaining cases only make sense if the select condition has the same
406 // type as the result of the comparison, so bail out if this is not so.
407 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000408 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000409 // If the false value simplified to false, then the result of the compare
410 // is equal to "Cond && TCmp". This also catches the case when the false
411 // value simplified to false and the true value to true, returning "Cond".
412 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000413 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000414 return V;
415 // If the true value simplified to true, then the result of the compare
416 // is equal to "Cond || FCmp".
417 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000418 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000419 return V;
420 // Finally, if the false value simplified to true and the true value to
421 // false, then the result of the compare is equal to "!Cond".
422 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
423 if (Value *V =
424 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000425 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000426 return V;
427
Craig Topper9f008862014-04-15 04:59:12 +0000428 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000429}
430
Sanjay Patel472cc782016-01-11 22:14:42 +0000431/// In the case of a binary operation with an operand that is a PHI instruction,
432/// try to simplify the binop by seeing whether evaluating it on the incoming
433/// phi values yields the same result for every value. If so returns the common
434/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000435static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000436 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000437 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000438 // Recursion is always used, so bail out at once if we already hit the limit.
439 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000440 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000441
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000442 PHINode *PI;
443 if (isa<PHINode>(LHS)) {
444 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000445 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000446 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000447 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000448 } else {
449 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
450 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000451 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000452 if (!ValueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000453 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000454 }
455
456 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000457 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000458 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000459 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000460 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000461 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000462 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
463 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000464 // If the operation failed to simplify, or simplified to a different value
465 // to previously, then give up.
466 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000467 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000468 CommonValue = V;
469 }
470
471 return CommonValue;
472}
473
Sanjay Patel472cc782016-01-11 22:14:42 +0000474/// In the case of a comparison with a PHI instruction, try to simplify the
475/// comparison by seeing whether comparing with all of the incoming phi values
476/// yields the same result every time. If so returns the common result,
477/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000478static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000479 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000480 // Recursion is always used, so bail out at once if we already hit the limit.
481 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000482 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000483
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000484 // Make sure the phi is on the LHS.
485 if (!isa<PHINode>(LHS)) {
486 std::swap(LHS, RHS);
487 Pred = CmpInst::getSwappedPredicate(Pred);
488 }
489 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
490 PHINode *PI = cast<PHINode>(LHS);
491
Duncan Sands5ffc2982010-11-16 12:16:38 +0000492 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000493 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000494 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000495
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000496 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000497 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000498 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000499 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000500 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000501 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000502 // If the operation failed to simplify, or simplified to a different value
503 // to previously, then give up.
504 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000505 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000506 CommonValue = V;
507 }
508
509 return CommonValue;
510}
511
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000512static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
513 Value *&Op0, Value *&Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000514 const SimplifyQuery &Q) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000515 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
516 if (auto *CRHS = dyn_cast<Constant>(Op1))
517 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
518
519 // Canonicalize the constant to the RHS if this is a commutative operation.
520 if (Instruction::isCommutative(Opcode))
521 std::swap(Op0, Op1);
522 }
523 return nullptr;
524}
525
Sanjay Patel472cc782016-01-11 22:14:42 +0000526/// Given operands for an Add, see if we can fold the result.
527/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000528static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000529 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000530 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
531 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000532
Duncan Sands0a2c41682010-12-15 14:07:39 +0000533 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000534 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000535 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000536
Duncan Sands0a2c41682010-12-15 14:07:39 +0000537 // X + 0 -> X
538 if (match(Op1, m_Zero()))
539 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000540
Duncan Sands0a2c41682010-12-15 14:07:39 +0000541 // X + (Y - X) -> Y
542 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000543 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000544 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000545 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
546 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000547 return Y;
548
549 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000550 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000551 if (match(Op0, m_Not(m_Specific(Op1))) ||
552 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000553 return Constant::getAllOnesValue(Ty);
554
Craig Topperbcfd2d12017-04-20 16:56:25 +0000555 // add nsw/nuw (xor Y, signmask), signmask --> Y
Sanjay Patelfe672552017-02-18 21:59:09 +0000556 // The no-wrapping add guarantees that the top bit will be set by the add.
557 // Therefore, the xor must be clearing the already set sign bit of Y.
Craig Topperbcfd2d12017-04-20 16:56:25 +0000558 if ((isNSW || isNUW) && match(Op1, m_SignMask()) &&
559 match(Op0, m_Xor(m_Value(Y), m_SignMask())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000560 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000561
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000562 /// i1 add -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000563 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000564 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000565 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000566
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000567 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000568 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000569 MaxRecurse))
570 return V;
571
Duncan Sandsb238de02010-11-19 09:20:39 +0000572 // Threading Add over selects and phi nodes is pointless, so don't bother.
573 // Threading over the select in "A + select(cond, B, C)" means evaluating
574 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
575 // only if B and C are equal. If B and C are equal then (since we assume
576 // that operands have already been simplified) "select(cond, B, C)" should
577 // have been simplified to the common value of B and C already. Analysing
578 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
579 // for threading over phi nodes.
580
Craig Topper9f008862014-04-15 04:59:12 +0000581 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000582}
583
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000584Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000585 const SimplifyQuery &Query) {
586 return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, Query, RecursionLimit);
587}
588
Chandler Carrutha0796552012-03-12 11:19:31 +0000589/// \brief Compute the base pointer and cumulative constant offsets for V.
590///
591/// This strips all constant offsets off of V, leaving it the base pointer, and
592/// accumulates the total constant offset applied in the returned constant. It
593/// returns 0 if V is not a pointer, and returns the constant '0' if there are
594/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000595///
596/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
597/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
598/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000599static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000600 bool AllowNonInbounds = false) {
Craig Topper95d23472017-07-09 07:04:00 +0000601 assert(V->getType()->isPtrOrPtrVectorTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000602
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000603 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000604 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000605
606 // Even though we don't look through PHI nodes, we could be called on an
607 // instruction in an unreachable block, which may be on a cycle.
608 SmallPtrSet<Value *, 4> Visited;
609 Visited.insert(V);
610 do {
611 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000612 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000613 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000614 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000615 V = GEP->getPointerOperand();
616 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000617 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000618 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000619 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000620 break;
621 V = GA->getAliasee();
622 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000623 if (auto CS = CallSite(V))
624 if (Value *RV = CS.getReturnedArgOperand()) {
625 V = RV;
626 continue;
627 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000628 break;
629 }
Craig Topper95d23472017-07-09 07:04:00 +0000630 assert(V->getType()->isPtrOrPtrVectorTy() && "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000631 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000632
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000633 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
634 if (V->getType()->isVectorTy())
635 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
636 OffsetIntPtr);
637 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000638}
639
640/// \brief Compute the constant difference between two pointer values.
641/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000642static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
643 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000644 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
645 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000646
647 // If LHS and RHS are not related via constant offsets to the same base
648 // value, there is nothing we can do here.
649 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000650 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000651
652 // Otherwise, the difference of LHS - RHS can be computed as:
653 // LHS - RHS
654 // = (LHSOffset + Base) - (RHSOffset + Base)
655 // = LHSOffset - RHSOffset
656 return ConstantExpr::getSub(LHSOffset, RHSOffset);
657}
658
Sanjay Patel472cc782016-01-11 22:14:42 +0000659/// Given operands for a Sub, see if we can fold the result.
660/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000661static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000662 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000663 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
664 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000665
666 // X - undef -> undef
667 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000668 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000669 return UndefValue::get(Op0->getType());
670
671 // X - 0 -> X
672 if (match(Op1, m_Zero()))
673 return Op0;
674
675 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000676 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000677 return Constant::getNullValue(Op0->getType());
678
Sanjay Patelefd88852016-10-19 21:23:45 +0000679 // Is this a negation?
680 if (match(Op0, m_Zero())) {
681 // 0 - X -> 0 if the sub is NUW.
682 if (isNUW)
683 return Op0;
684
Craig Topper8205a1a2017-05-24 16:53:07 +0000685 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +0000686 if (Known.Zero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000687 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
688 // Op1 must be 0 because negating the minimum signed value is undefined.
689 if (isNSW)
690 return Op0;
691
692 // 0 - X -> X if X is 0 or the minimum signed value.
693 return Op1;
694 }
695 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000696
Duncan Sands99589d02011-01-18 11:50:19 +0000697 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
698 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000699 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000700 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
701 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000702 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000703 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000704 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000705 // It does, we successfully reassociated!
706 ++NumReassoc;
707 return W;
708 }
709 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000710 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000711 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000712 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000713 // It does, we successfully reassociated!
714 ++NumReassoc;
715 return W;
716 }
717 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000718
Duncan Sands99589d02011-01-18 11:50:19 +0000719 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
720 // For example, X - (X + 1) -> -1
721 X = Op0;
722 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
723 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000724 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000725 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000726 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000727 // It does, we successfully reassociated!
728 ++NumReassoc;
729 return W;
730 }
731 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000732 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000733 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000734 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000735 // It does, we successfully reassociated!
736 ++NumReassoc;
737 return W;
738 }
739 }
740
741 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
742 // For example, X - (X - Y) -> Y.
743 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000744 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
745 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000746 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000747 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000748 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000749 // It does, we successfully reassociated!
750 ++NumReassoc;
751 return W;
752 }
753
Duncan Sands395ac42d2012-03-13 14:07:05 +0000754 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
755 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
756 match(Op1, m_Trunc(m_Value(Y))))
757 if (X->getType() == Y->getType())
758 // See if "V === X - Y" simplifies.
759 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
760 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000761 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
762 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000763 // It does, return the simplified "trunc V".
764 return W;
765
766 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000767 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000768 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000769 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000770 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
771
Duncan Sands99589d02011-01-18 11:50:19 +0000772 // i1 sub -> xor.
Craig Topperfde47232017-07-09 07:04:03 +0000773 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000774 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000775 return V;
776
Duncan Sands0a2c41682010-12-15 14:07:39 +0000777 // Threading Sub over selects and phi nodes is pointless, so don't bother.
778 // Threading over the select in "A - select(cond, B, C)" means evaluating
779 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
780 // only if B and C are equal. If B and C are equal then (since we assume
781 // that operands have already been simplified) "select(cond, B, C)" should
782 // have been simplified to the common value of B and C already. Analysing
783 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
784 // for threading over phi nodes.
785
Craig Topper9f008862014-04-15 04:59:12 +0000786 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000787}
788
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000789Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000790 const SimplifyQuery &Q) {
791 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
792}
793
Sanjay Patel472cc782016-01-11 22:14:42 +0000794/// Given operands for a Mul, see if we can fold the result.
795/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000796static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000797 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000798 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
799 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000800
801 // X * undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000802 if (match(Op1, m_Undef()))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000803 return Constant::getNullValue(Op0->getType());
804
805 // X * 0 -> 0
806 if (match(Op1, m_Zero()))
807 return Op1;
808
809 // X * 1 -> X
810 if (match(Op1, m_One()))
811 return Op0;
812
Duncan Sandsb67edc62011-01-30 18:03:50 +0000813 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000814 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000815 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
816 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
817 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000818
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000819 // i1 mul -> and.
Craig Topperfde47232017-07-09 07:04:03 +0000820 if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000821 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000822 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000823
824 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000825 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000826 MaxRecurse))
827 return V;
828
Dmitry Venikovd2257be2018-01-02 05:47:42 +0000829 // Mul distributes over Add. Try some generic simplifications based on this.
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000830 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000831 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000832 return V;
833
834 // If the operation is with the result of a select instruction, check whether
835 // operating on either branch of the select always yields the same value.
836 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000837 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000838 MaxRecurse))
839 return V;
840
841 // If the operation is with the result of a phi instruction, check whether
842 // operating on all incoming values of the phi always yields the same value.
843 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000844 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000845 MaxRecurse))
846 return V;
847
Craig Topper9f008862014-04-15 04:59:12 +0000848 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000849}
850
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000851Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
852 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
853}
854
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000855/// Check for common or similar folds of integer division or integer remainder.
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000856/// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000857static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
858 Type *Ty = Op0->getType();
859
860 // X / undef -> undef
861 // X % undef -> undef
862 if (match(Op1, m_Undef()))
863 return Op1;
864
865 // X / 0 -> undef
866 // X % 0 -> undef
867 // We don't need to preserve faults!
868 if (match(Op1, m_Zero()))
869 return UndefValue::get(Ty);
870
Zvi Rackover51f0d642018-01-24 17:22:00 +0000871 // If any element of a constant divisor vector is zero or undef, the whole op
872 // is undef.
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000873 auto *Op1C = dyn_cast<Constant>(Op1);
874 if (Op1C && Ty->isVectorTy()) {
875 unsigned NumElts = Ty->getVectorNumElements();
876 for (unsigned i = 0; i != NumElts; ++i) {
877 Constant *Elt = Op1C->getAggregateElement(i);
Zvi Rackover51f0d642018-01-24 17:22:00 +0000878 if (Elt && (Elt->isNullValue() || isa<UndefValue>(Elt)))
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000879 return UndefValue::get(Ty);
880 }
881 }
882
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000883 // undef / X -> 0
884 // undef % X -> 0
885 if (match(Op0, m_Undef()))
886 return Constant::getNullValue(Ty);
887
888 // 0 / X -> 0
889 // 0 % X -> 0
890 if (match(Op0, m_Zero()))
891 return Op0;
892
893 // X / X -> 1
894 // X % X -> 0
895 if (Op0 == Op1)
896 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
897
898 // X / 1 -> X
899 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +0000900 // If this is a boolean op (single-bit element type), we can't have
901 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
Craig Topperfde47232017-07-09 07:04:03 +0000902 if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000903 return IsDiv ? Op0 : Constant::getNullValue(Ty);
904
905 return nullptr;
906}
907
Sanjay Patelcca8f782017-09-14 14:09:11 +0000908/// Given a predicate and two operands, return true if the comparison is true.
909/// This is a helper for div/rem simplification where we return some other value
910/// when we can prove a relationship between the operands.
911static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
912 const SimplifyQuery &Q, unsigned MaxRecurse) {
913 Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
914 Constant *C = dyn_cast_or_null<Constant>(V);
915 return (C && C->isAllOnesValue());
916}
917
918/// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
919/// to simplify X % Y to X.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000920static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
Sanjay Patelcca8f782017-09-14 14:09:11 +0000921 unsigned MaxRecurse, bool IsSigned) {
922 // Recursion is always used, so bail out at once if we already hit the limit.
923 if (!MaxRecurse--)
924 return false;
925
926 if (IsSigned) {
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000927 // |X| / |Y| --> 0
928 //
929 // We require that 1 operand is a simple constant. That could be extended to
930 // 2 variables if we computed the sign bit for each.
931 //
932 // Make sure that a constant is not the minimum signed value because taking
933 // the abs() of that is undefined.
934 Type *Ty = X->getType();
935 const APInt *C;
936 if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
937 // Is the variable divisor magnitude always greater than the constant
938 // dividend magnitude?
939 // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
940 Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
941 Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
942 if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
943 isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
944 return true;
945 }
946 if (match(Y, m_APInt(C))) {
947 // Special-case: we can't take the abs() of a minimum signed value. If
948 // that's the divisor, then all we have to do is prove that the dividend
949 // is also not the minimum signed value.
950 if (C->isMinSignedValue())
951 return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
952
953 // Is the variable dividend magnitude always less than the constant
954 // divisor magnitude?
955 // |X| < |C| --> X > -abs(C) and X < abs(C)
956 Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
957 Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
958 if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
959 isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
960 return true;
961 }
Sanjay Patelcca8f782017-09-14 14:09:11 +0000962 return false;
963 }
964
965 // IsSigned == false.
Sanjay Patel0d4fd5b2017-09-14 14:59:07 +0000966 // Is the dividend unsigned less than the divisor?
967 return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
Sanjay Patelcca8f782017-09-14 14:09:11 +0000968}
969
Sanjay Patelfa877fd2017-09-11 13:34:27 +0000970/// These are simplifications common to SDiv and UDiv.
971static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000972 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000973 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
974 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +0000975
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000976 if (Value *V = simplifyDivRem(Op0, Op1, true))
977 return V;
978
Sanjay Patelcca8f782017-09-14 14:09:11 +0000979 bool IsSigned = Opcode == Instruction::SDiv;
Duncan Sands65995fa2011-01-28 18:50:50 +0000980
Duncan Sands771e82a2011-01-28 16:51:11 +0000981 // (X * Y) / Y -> X if the multiplication does not overflow.
Sanjay Patel33cb8452018-01-19 16:12:55 +0000982 Value *X;
983 if (match(Op0, m_c_Mul(m_Value(X), m_Specific(Op1)))) {
984 auto *Mul = cast<OverflowingBinaryOperator>(Op0);
985 // If the Mul does not overflow, then we are good to go.
Sanjay Patelcca8f782017-09-14 14:09:11 +0000986 if ((IsSigned && Mul->hasNoSignedWrap()) ||
987 (!IsSigned && Mul->hasNoUnsignedWrap()))
Duncan Sands5747aba2011-02-02 20:52:00 +0000988 return X;
Sanjay Patel33cb8452018-01-19 16:12:55 +0000989 // If X has the form X = A / Y, then X * Y cannot overflow.
990 if ((IsSigned && match(X, m_SDiv(m_Value(), m_Specific(Op1)))) ||
991 (!IsSigned && match(X, m_UDiv(m_Value(), m_Specific(Op1)))))
992 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +0000993 }
994
Duncan Sands65995fa2011-01-28 18:50:50 +0000995 // (X rem Y) / Y -> 0
Sanjay Patelcca8f782017-09-14 14:09:11 +0000996 if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
997 (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
Duncan Sands65995fa2011-01-28 18:50:50 +0000998 return Constant::getNullValue(Op0->getType());
999
David Majnemercb9d5962014-10-11 10:20:01 +00001000 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1001 ConstantInt *C1, *C2;
Sanjay Patelcca8f782017-09-14 14:09:11 +00001002 if (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
David Majnemercb9d5962014-10-11 10:20:01 +00001003 match(Op1, m_ConstantInt(C2))) {
1004 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001005 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001006 if (Overflow)
1007 return Constant::getNullValue(Op0->getType());
1008 }
1009
Duncan Sands65995fa2011-01-28 18:50:50 +00001010 // If the operation is with the result of a select instruction, check whether
1011 // operating on either branch of the select always yields the same value.
1012 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001013 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001014 return V;
1015
1016 // If the operation is with the result of a phi instruction, check whether
1017 // operating on all incoming values of the phi always yields the same value.
1018 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001019 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001020 return V;
1021
Sanjay Patelcca8f782017-09-14 14:09:11 +00001022 if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1023 return Constant::getNullValue(Op0->getType());
1024
Craig Topper9f008862014-04-15 04:59:12 +00001025 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001026}
1027
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001028/// These are simplifications common to SRem and URem.
1029static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001030 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001031 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1032 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001033
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001034 if (Value *V = simplifyDivRem(Op0, Op1, false))
1035 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001036
David Majnemerb435a422014-09-17 04:16:35 +00001037 // (X % Y) % Y -> X % Y
1038 if ((Opcode == Instruction::SRem &&
1039 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1040 (Opcode == Instruction::URem &&
1041 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001042 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001043
Anton Bikineev82f61152018-01-23 09:27:47 +00001044 // (X << Y) % X -> 0
1045 if ((Opcode == Instruction::SRem &&
1046 match(Op0, m_NSWShl(m_Specific(Op1), m_Value()))) ||
1047 (Opcode == Instruction::URem &&
1048 match(Op0, m_NUWShl(m_Specific(Op1), m_Value()))))
1049 return Constant::getNullValue(Op0->getType());
1050
Duncan Sandsa3e36992011-05-02 16:27:02 +00001051 // If the operation is with the result of a select instruction, check whether
1052 // operating on either branch of the select always yields the same value.
1053 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001054 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001055 return V;
1056
1057 // If the operation is with the result of a phi instruction, check whether
1058 // operating on all incoming values of the phi always yields the same value.
1059 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001060 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001061 return V;
1062
Sanjay Patelcca8f782017-09-14 14:09:11 +00001063 // If X / Y == 0, then X % Y == X.
1064 if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1065 return Op0;
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001066
1067 return nullptr;
1068}
1069
1070/// Given operands for an SDiv, see if we can fold the result.
1071/// If not, this returns null.
1072static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1073 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001074 return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001075}
1076
1077Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1078 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1079}
1080
1081/// Given operands for a UDiv, see if we can fold the result.
1082/// If not, this returns null.
1083static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1084 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001085 return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00001086}
1087
1088Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1089 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1090}
1091
Sanjay Patel472cc782016-01-11 22:14:42 +00001092/// Given operands for an SRem, see if we can fold the result.
1093/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001094static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001095 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001096 return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001097}
1098
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001099Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1100 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1101}
1102
Sanjay Patel472cc782016-01-11 22:14:42 +00001103/// Given operands for a URem, see if we can fold the result.
1104/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001105static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001106 unsigned MaxRecurse) {
Sanjay Patelcca8f782017-09-14 14:09:11 +00001107 return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001108}
1109
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001110Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1111 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1112}
1113
Sanjay Patel472cc782016-01-11 22:14:42 +00001114/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001115static bool isUndefShift(Value *Amount) {
1116 Constant *C = dyn_cast<Constant>(Amount);
1117 if (!C)
1118 return false;
1119
1120 // X shift by undef -> undef because it may shift by the bitwidth.
1121 if (isa<UndefValue>(C))
1122 return true;
1123
1124 // Shifting by the bitwidth or more is undefined.
1125 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1126 if (CI->getValue().getLimitedValue() >=
1127 CI->getType()->getScalarSizeInBits())
1128 return true;
1129
1130 // If all lanes of a vector shift are undefined the whole shift is.
1131 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1132 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1133 if (!isUndefShift(C->getAggregateElement(I)))
1134 return false;
1135 return true;
1136 }
1137
1138 return false;
1139}
1140
Sanjay Patel472cc782016-01-11 22:14:42 +00001141/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1142/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001143static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001144 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001145 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1146 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001147
Duncan Sands571fd9a2011-01-14 14:44:12 +00001148 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001149 if (match(Op0, m_Zero()))
1150 return Op0;
1151
Duncan Sands571fd9a2011-01-14 14:44:12 +00001152 // X shift by 0 -> X
Duncan Sands7f60dc12011-01-14 00:37:45 +00001153 if (match(Op1, m_Zero()))
1154 return Op0;
1155
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001156 // Fold undefined shifts.
1157 if (isUndefShift(Op1))
1158 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001159
Duncan Sands571fd9a2011-01-14 14:44:12 +00001160 // If the operation is with the result of a select instruction, check whether
1161 // operating on either branch of the select always yields the same value.
1162 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001163 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001164 return V;
1165
1166 // If the operation is with the result of a phi instruction, check whether
1167 // operating on all incoming values of the phi always yields the same value.
1168 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001169 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001170 return V;
1171
Sanjay Patel6786bc52016-05-10 20:46:54 +00001172 // If any bits in the shift amount make that value greater than or equal to
1173 // the number of bits in the type, the shift is undefined.
Craig Topper8205a1a2017-05-24 16:53:07 +00001174 KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1175 if (Known.One.getLimitedValue() >= Known.getBitWidth())
Sanjay Patel6786bc52016-05-10 20:46:54 +00001176 return UndefValue::get(Op0->getType());
1177
1178 // If all valid bits in the shift amount are known zero, the first operand is
1179 // unchanged.
Craig Topper8205a1a2017-05-24 16:53:07 +00001180 unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
Craig Topper8df66c62017-05-12 17:20:30 +00001181 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001182 return Op0;
1183
Craig Topper9f008862014-04-15 04:59:12 +00001184 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001185}
1186
David Majnemerbf7550e2014-11-05 00:59:59 +00001187/// \brief Given operands for an Shl, LShr or AShr, see if we can
1188/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001189static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001190 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001191 unsigned MaxRecurse) {
1192 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1193 return V;
1194
1195 // X >> X -> 0
1196 if (Op0 == Op1)
1197 return Constant::getNullValue(Op0->getType());
1198
David Majnemer65c52ae2014-12-17 01:54:33 +00001199 // undef >> X -> 0
1200 // undef >> X -> undef (if it's exact)
1201 if (match(Op0, m_Undef()))
1202 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1203
David Majnemerbf7550e2014-11-05 00:59:59 +00001204 // The low bit cannot be shifted out of an exact shift if it is set.
1205 if (isExact) {
Craig Topper8205a1a2017-05-24 16:53:07 +00001206 KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
Craig Topperb45eabc2017-04-26 16:39:58 +00001207 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001208 return Op0;
1209 }
1210
1211 return nullptr;
1212}
1213
Sanjay Patel472cc782016-01-11 22:14:42 +00001214/// Given operands for an Shl, see if we can fold the result.
1215/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001216static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001217 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001218 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001219 return V;
1220
1221 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001222 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001223 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001224 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001225
Chris Lattner9e4aa022011-02-09 17:15:04 +00001226 // (X >> A) << A -> X
1227 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001228 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001229 return X;
Craig Topper9f008862014-04-15 04:59:12 +00001230 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001231}
1232
Chris Lattner9e4aa022011-02-09 17:15:04 +00001233Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001234 const SimplifyQuery &Q) {
1235 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1236}
1237
Sanjay Patel472cc782016-01-11 22:14:42 +00001238/// Given operands for an LShr, see if we can fold the result.
1239/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001240static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001241 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001242 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1243 MaxRecurse))
1244 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001245
Chris Lattner9e4aa022011-02-09 17:15:04 +00001246 // (X << A) >> A -> X
1247 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001248 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001249 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001250
Craig Topper9f008862014-04-15 04:59:12 +00001251 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001252}
1253
Chris Lattner9e4aa022011-02-09 17:15:04 +00001254Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001255 const SimplifyQuery &Q) {
1256 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1257}
1258
Sanjay Patel472cc782016-01-11 22:14:42 +00001259/// Given operands for an AShr, see if we can fold the result.
1260/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001261static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001262 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001263 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1264 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001265 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001266
1267 // all ones >>a X -> all ones
1268 if (match(Op0, m_AllOnes()))
1269 return Op0;
1270
Chris Lattner9e4aa022011-02-09 17:15:04 +00001271 // (X << A) >> A -> X
1272 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001273 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001274 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001275
Suyog Sarda68862412014-07-17 06:28:15 +00001276 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001277 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001278 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1279 return Op0;
1280
Craig Topper9f008862014-04-15 04:59:12 +00001281 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001282}
1283
Chris Lattner9e4aa022011-02-09 17:15:04 +00001284Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001285 const SimplifyQuery &Q) {
1286 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1287}
1288
Craig Topper348314d2017-05-26 22:42:34 +00001289/// Commuted variants are assumed to be handled by calling this function again
1290/// with the parameters swapped.
David Majnemer1af36e52014-12-06 10:51:40 +00001291static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1292 ICmpInst *UnsignedICmp, bool IsAnd) {
1293 Value *X, *Y;
1294
1295 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001296 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1297 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001298 return nullptr;
1299
1300 ICmpInst::Predicate UnsignedPred;
1301 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1302 ICmpInst::isUnsigned(UnsignedPred))
1303 ;
1304 else if (match(UnsignedICmp,
1305 m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1306 ICmpInst::isUnsigned(UnsignedPred))
1307 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1308 else
1309 return nullptr;
1310
1311 // X < Y && Y != 0 --> X < Y
1312 // X < Y || Y != 0 --> Y != 0
1313 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1314 return IsAnd ? UnsignedICmp : ZeroICmp;
1315
1316 // X >= Y || Y != 0 --> true
1317 // X >= Y || Y == 0 --> X >= Y
1318 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1319 if (EqPred == ICmpInst::ICMP_NE)
1320 return getTrue(UnsignedICmp->getType());
1321 return UnsignedICmp;
1322 }
1323
David Majnemerd5b3aa42014-12-08 18:30:43 +00001324 // X < Y && Y == 0 --> false
1325 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1326 IsAnd)
1327 return getFalse(UnsignedICmp->getType());
1328
David Majnemer1af36e52014-12-06 10:51:40 +00001329 return nullptr;
1330}
1331
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001332/// Commuted variants are assumed to be handled by calling this function again
1333/// with the parameters swapped.
1334static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1335 ICmpInst::Predicate Pred0, Pred1;
1336 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001337 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1338 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001339 return nullptr;
1340
1341 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1342 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1343 // can eliminate Op1 from this 'and'.
1344 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1345 return Op0;
1346
1347 // Check for any combination of predicates that are guaranteed to be disjoint.
1348 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1349 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1350 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1351 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1352 return getFalse(Op0->getType());
1353
1354 return nullptr;
1355}
1356
1357/// Commuted variants are assumed to be handled by calling this function again
1358/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001359static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1360 ICmpInst::Predicate Pred0, Pred1;
1361 Value *A ,*B;
1362 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1363 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1364 return nullptr;
1365
1366 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1367 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1368 // can eliminate Op0 from this 'or'.
1369 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1370 return Op1;
1371
1372 // Check for any combination of predicates that cover the entire range of
1373 // possibilities.
1374 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1375 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1376 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1377 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1378 return getTrue(Op0->getType());
1379
1380 return nullptr;
1381}
1382
Sanjay Patel599e65b2017-05-07 15:11:40 +00001383/// Test if a pair of compares with a shared operand and 2 constants has an
1384/// empty set intersection, full set union, or if one compare is a superset of
1385/// the other.
1386static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1387 bool IsAnd) {
1388 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1389 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1390 return nullptr;
1391
1392 const APInt *C0, *C1;
1393 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1394 !match(Cmp1->getOperand(1), m_APInt(C1)))
1395 return nullptr;
1396
1397 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1398 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1399
Sanjay Patel67454472017-05-08 16:35:02 +00001400 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001401 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1402 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1403 return getFalse(Cmp0->getType());
1404
1405 // For or-of-compares, check if the union is full:
1406 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1407 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1408 return getTrue(Cmp0->getType());
1409
1410 // Is one range a superset of the other?
1411 // If this is and-of-compares, take the smaller set:
1412 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1413 // If this is or-of-compares, take the larger set:
1414 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1415 if (Range0.contains(Range1))
1416 return IsAnd ? Cmp1 : Cmp0;
1417 if (Range1.contains(Range0))
1418 return IsAnd ? Cmp0 : Cmp1;
1419
1420 return nullptr;
1421}
1422
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001423static Value *simplifyAndOrOfICmpsWithZero(ICmpInst *Cmp0, ICmpInst *Cmp1,
1424 bool IsAnd) {
1425 ICmpInst::Predicate P0 = Cmp0->getPredicate(), P1 = Cmp1->getPredicate();
1426 if (!match(Cmp0->getOperand(1), m_Zero()) ||
1427 !match(Cmp1->getOperand(1), m_Zero()) || P0 != P1)
1428 return nullptr;
1429
1430 if ((IsAnd && P0 != ICmpInst::ICMP_NE) || (!IsAnd && P1 != ICmpInst::ICMP_EQ))
1431 return nullptr;
1432
Sanjay Patel4158eff2018-01-13 15:44:44 +00001433 // We have either "(X == 0 || Y == 0)" or "(X != 0 && Y != 0)".
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001434 Value *X = Cmp0->getOperand(0);
1435 Value *Y = Cmp1->getOperand(0);
1436
1437 // If one of the compares is a masked version of a (not) null check, then
Sanjay Patel4158eff2018-01-13 15:44:44 +00001438 // that compare implies the other, so we eliminate the other. Optionally, look
1439 // through a pointer-to-int cast to match a null check of a pointer type.
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001440
Sanjay Patel9568f422018-01-14 15:58:18 +00001441 // (X == 0) || (([ptrtoint] X & ?) == 0) --> ([ptrtoint] X & ?) == 0
1442 // (X == 0) || ((? & [ptrtoint] X) == 0) --> (? & [ptrtoint] X) == 0
1443 // (X != 0) && (([ptrtoint] X & ?) != 0) --> ([ptrtoint] X & ?) != 0
1444 // (X != 0) && ((? & [ptrtoint] X) != 0) --> (? & [ptrtoint] X) != 0
Sanjay Patel4158eff2018-01-13 15:44:44 +00001445 if (match(Y, m_c_And(m_Specific(X), m_Value())) ||
1446 match(Y, m_c_And(m_PtrToInt(m_Specific(X)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001447 return Cmp1;
1448
Sanjay Patel9568f422018-01-14 15:58:18 +00001449 // (([ptrtoint] Y & ?) == 0) || (Y == 0) --> ([ptrtoint] Y & ?) == 0
1450 // ((? & [ptrtoint] Y) == 0) || (Y == 0) --> (? & [ptrtoint] Y) == 0
1451 // (([ptrtoint] Y & ?) != 0) && (Y != 0) --> ([ptrtoint] Y & ?) != 0
1452 // ((? & [ptrtoint] Y) != 0) && (Y != 0) --> (? & [ptrtoint] Y) != 0
Sanjay Patel4158eff2018-01-13 15:44:44 +00001453 if (match(X, m_c_And(m_Specific(Y), m_Value())) ||
1454 match(X, m_c_And(m_PtrToInt(m_Specific(Y)), m_Value())))
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001455 return Cmp0;
1456
1457 return nullptr;
1458}
1459
Craig Topper348314d2017-05-26 22:42:34 +00001460static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel599e65b2017-05-07 15:11:40 +00001461 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001462 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001463 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001464 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001465 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001466 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001467
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001468 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001469 return nullptr;
1470
David Majnemera315bd82014-09-15 08:15:28 +00001471 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001472 if (AddInst->getOperand(1) != Op1->getOperand(1))
1473 return nullptr;
1474
Craig Topper9bce1ad2017-05-26 19:04:02 +00001475 Type *ITy = Op0->getType();
David Majnemera315bd82014-09-15 08:15:28 +00001476 bool isNSW = AddInst->hasNoSignedWrap();
1477 bool isNUW = AddInst->hasNoUnsignedWrap();
1478
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001479 const APInt Delta = *C1 - *C0;
1480 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001481 if (Delta == 2) {
1482 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1483 return getFalse(ITy);
1484 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1485 return getFalse(ITy);
1486 }
1487 if (Delta == 1) {
1488 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1489 return getFalse(ITy);
1490 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1491 return getFalse(ITy);
1492 }
1493 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001494 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001495 if (Delta == 2)
1496 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1497 return getFalse(ITy);
1498 if (Delta == 1)
1499 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1500 return getFalse(ITy);
1501 }
1502
1503 return nullptr;
1504}
1505
Craig Topper348314d2017-05-26 22:42:34 +00001506static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1507 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1508 return X;
1509 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
Sanjay Patel142cb832017-05-04 18:19:17 +00001510 return X;
1511
Craig Topper348314d2017-05-26 22:42:34 +00001512 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1513 return X;
1514 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
Sanjay Patel142cb832017-05-04 18:19:17 +00001515 return X;
1516
Craig Topper348314d2017-05-26 22:42:34 +00001517 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
Sanjay Patel599e65b2017-05-07 15:11:40 +00001518 return X;
1519
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001520 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, true))
1521 return X;
1522
Craig Topper348314d2017-05-26 22:42:34 +00001523 if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1))
1524 return X;
1525 if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0))
1526 return X;
1527
1528 return nullptr;
1529}
1530
1531static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001532 // (icmp (add V, C0), C1) | (icmp V, C0)
1533 ICmpInst::Predicate Pred0, Pred1;
1534 const APInt *C0, *C1;
1535 Value *V;
1536 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1537 return nullptr;
1538
1539 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1540 return nullptr;
1541
1542 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1543 if (AddInst->getOperand(1) != Op1->getOperand(1))
1544 return nullptr;
1545
1546 Type *ITy = Op0->getType();
1547 bool isNSW = AddInst->hasNoSignedWrap();
1548 bool isNUW = AddInst->hasNoUnsignedWrap();
1549
1550 const APInt Delta = *C1 - *C0;
1551 if (C0->isStrictlyPositive()) {
1552 if (Delta == 2) {
1553 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1554 return getTrue(ITy);
1555 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1556 return getTrue(ITy);
1557 }
1558 if (Delta == 1) {
1559 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1560 return getTrue(ITy);
1561 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1562 return getTrue(ITy);
1563 }
1564 }
1565 if (C0->getBoolValue() && isNUW) {
1566 if (Delta == 2)
1567 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1568 return getTrue(ITy);
1569 if (Delta == 1)
1570 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1571 return getTrue(ITy);
1572 }
1573
1574 return nullptr;
1575}
1576
Craig Topper348314d2017-05-26 22:42:34 +00001577static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1578 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1579 return X;
1580 if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1581 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001582
Craig Topper348314d2017-05-26 22:42:34 +00001583 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1584 return X;
1585 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1586 return X;
1587
1588 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1589 return X;
1590
Sanjay Patel6ef6aa92018-01-11 23:27:37 +00001591 if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, false))
1592 return X;
1593
Craig Topper348314d2017-05-26 22:42:34 +00001594 if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1))
1595 return X;
1596 if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0))
1597 return X;
Sanjay Patele42b4d52017-05-04 19:51:34 +00001598
1599 return nullptr;
1600}
1601
Sanjay Pateleb731b02017-11-19 15:34:27 +00001602static Value *simplifyAndOrOfFCmps(FCmpInst *LHS, FCmpInst *RHS, bool IsAnd) {
1603 Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1604 Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1605 if (LHS0->getType() != RHS0->getType())
1606 return nullptr;
1607
1608 FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1609 if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1610 (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1611 // (fcmp ord NNAN, X) & (fcmp ord X, Y) --> fcmp ord X, Y
1612 // (fcmp ord NNAN, X) & (fcmp ord Y, X) --> fcmp ord Y, X
1613 // (fcmp ord X, NNAN) & (fcmp ord X, Y) --> fcmp ord X, Y
1614 // (fcmp ord X, NNAN) & (fcmp ord Y, X) --> fcmp ord Y, X
1615 // (fcmp uno NNAN, X) | (fcmp uno X, Y) --> fcmp uno X, Y
1616 // (fcmp uno NNAN, X) | (fcmp uno Y, X) --> fcmp uno Y, X
1617 // (fcmp uno X, NNAN) | (fcmp uno X, Y) --> fcmp uno X, Y
1618 // (fcmp uno X, NNAN) | (fcmp uno Y, X) --> fcmp uno Y, X
1619 if ((isKnownNeverNaN(LHS0) && (LHS1 == RHS0 || LHS1 == RHS1)) ||
1620 (isKnownNeverNaN(LHS1) && (LHS0 == RHS0 || LHS0 == RHS1)))
1621 return RHS;
1622
1623 // (fcmp ord X, Y) & (fcmp ord NNAN, X) --> fcmp ord X, Y
1624 // (fcmp ord Y, X) & (fcmp ord NNAN, X) --> fcmp ord Y, X
1625 // (fcmp ord X, Y) & (fcmp ord X, NNAN) --> fcmp ord X, Y
1626 // (fcmp ord Y, X) & (fcmp ord X, NNAN) --> fcmp ord Y, X
1627 // (fcmp uno X, Y) | (fcmp uno NNAN, X) --> fcmp uno X, Y
1628 // (fcmp uno Y, X) | (fcmp uno NNAN, X) --> fcmp uno Y, X
1629 // (fcmp uno X, Y) | (fcmp uno X, NNAN) --> fcmp uno X, Y
1630 // (fcmp uno Y, X) | (fcmp uno X, NNAN) --> fcmp uno Y, X
1631 if ((isKnownNeverNaN(RHS0) && (RHS1 == LHS0 || RHS1 == LHS1)) ||
1632 (isKnownNeverNaN(RHS1) && (RHS0 == LHS0 || RHS0 == LHS1)))
1633 return LHS;
1634 }
1635
1636 return nullptr;
1637}
1638
1639static Value *simplifyAndOrOfCmps(Value *Op0, Value *Op1, bool IsAnd) {
Sanjay Patele42b4d52017-05-04 19:51:34 +00001640 // Look through casts of the 'and' operands to find compares.
1641 auto *Cast0 = dyn_cast<CastInst>(Op0);
1642 auto *Cast1 = dyn_cast<CastInst>(Op1);
1643 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1644 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1645 Op0 = Cast0->getOperand(0);
1646 Op1 = Cast1->getOperand(0);
1647 }
1648
Sanjay Pateleb731b02017-11-19 15:34:27 +00001649 Value *V = nullptr;
1650 auto *ICmp0 = dyn_cast<ICmpInst>(Op0);
1651 auto *ICmp1 = dyn_cast<ICmpInst>(Op1);
1652 if (ICmp0 && ICmp1)
1653 V = IsAnd ? simplifyAndOfICmps(ICmp0, ICmp1) :
1654 simplifyOrOfICmps(ICmp0, ICmp1);
Sanjay Patele42b4d52017-05-04 19:51:34 +00001655
Sanjay Pateleb731b02017-11-19 15:34:27 +00001656 auto *FCmp0 = dyn_cast<FCmpInst>(Op0);
1657 auto *FCmp1 = dyn_cast<FCmpInst>(Op1);
1658 if (FCmp0 && FCmp1)
1659 V = simplifyAndOrOfFCmps(FCmp0, FCmp1, IsAnd);
1660
Craig Topper348314d2017-05-26 22:42:34 +00001661 if (!V)
1662 return nullptr;
1663 if (!Cast0)
Sanjay Patele42b4d52017-05-04 19:51:34 +00001664 return V;
Craig Topper348314d2017-05-26 22:42:34 +00001665
1666 // If we looked through casts, we can only handle a constant simplification
1667 // because we are not allowed to create a cast instruction here.
1668 if (auto *C = dyn_cast<Constant>(V))
1669 return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
Sanjay Patele42b4d52017-05-04 19:51:34 +00001670
1671 return nullptr;
1672}
1673
Sanjay Patel472cc782016-01-11 22:14:42 +00001674/// Given operands for an And, see if we can fold the result.
1675/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001676static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001677 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001678 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1679 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001680
Chris Lattnera71e9d62009-11-10 00:55:12 +00001681 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001682 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001683 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001684
Chris Lattnera71e9d62009-11-10 00:55:12 +00001685 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001686 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001687 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001688
Duncan Sandsc89ac072010-11-17 18:52:15 +00001689 // X & 0 = 0
1690 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001691 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001692
Duncan Sandsc89ac072010-11-17 18:52:15 +00001693 // X & -1 = X
1694 if (match(Op1, m_AllOnes()))
1695 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001696
Chris Lattnera71e9d62009-11-10 00:55:12 +00001697 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001698 if (match(Op0, m_Not(m_Specific(Op1))) ||
1699 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001700 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001701
Chris Lattnera71e9d62009-11-10 00:55:12 +00001702 // (A | ?) & A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001703 if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001704 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001705
Chris Lattnera71e9d62009-11-10 00:55:12 +00001706 // A & (A | ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001707 if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001708 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001709
Sanjay Patel877364f2017-05-16 21:51:04 +00001710 // A mask that only clears known zeros of a shifted value is a no-op.
1711 Value *X;
1712 const APInt *Mask;
1713 const APInt *ShAmt;
1714 if (match(Op1, m_APInt(Mask))) {
1715 // If all bits in the inverted and shifted mask are clear:
1716 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1717 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1718 (~(*Mask)).lshr(*ShAmt).isNullValue())
1719 return Op0;
1720
1721 // If all bits in the inverted and shifted mask are clear:
1722 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1723 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1724 (~(*Mask)).shl(*ShAmt).isNullValue())
1725 return Op0;
1726 }
1727
Duncan Sandsba286d72011-10-26 20:55:21 +00001728 // A & (-A) = A if A is a power of two or zero.
1729 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1730 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001731 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1732 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001733 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001734 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1735 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001736 return Op1;
1737 }
1738
Sanjay Pateleb731b02017-11-19 15:34:27 +00001739 if (Value *V = simplifyAndOrOfCmps(Op0, Op1, true))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001740 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001741
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001742 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001743 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1744 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001745 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001746
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001747 // And distributes over Or. Try some generic simplifications based on this.
1748 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001749 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001750 return V;
1751
1752 // And distributes over Xor. Try some generic simplifications based on this.
1753 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001754 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001755 return V;
1756
Duncan Sandsb0579e92010-11-10 13:00:08 +00001757 // If the operation is with the result of a select instruction, check whether
1758 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001759 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001760 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1761 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001762 return V;
1763
1764 // If the operation is with the result of a phi instruction, check whether
1765 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001766 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001767 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001768 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001769 return V;
1770
Craig Topper9f008862014-04-15 04:59:12 +00001771 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001772}
1773
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001774Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1775 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1776}
1777
Sanjay Patel472cc782016-01-11 22:14:42 +00001778/// Given operands for an Or, see if we can fold the result.
1779/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001780static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001781 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001782 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1783 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001784
Chris Lattnera71e9d62009-11-10 00:55:12 +00001785 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001786 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001787 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001788
Chris Lattnera71e9d62009-11-10 00:55:12 +00001789 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001790 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001791 return Op0;
1792
Duncan Sandsc89ac072010-11-17 18:52:15 +00001793 // X | 0 = X
1794 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001795 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001796
Duncan Sandsc89ac072010-11-17 18:52:15 +00001797 // X | -1 = -1
1798 if (match(Op1, m_AllOnes()))
1799 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001800
Chris Lattnera71e9d62009-11-10 00:55:12 +00001801 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001802 if (match(Op0, m_Not(m_Specific(Op1))) ||
1803 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001804 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001805
Chris Lattnera71e9d62009-11-10 00:55:12 +00001806 // (A & ?) | A = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001807 if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001808 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001809
Chris Lattnera71e9d62009-11-10 00:55:12 +00001810 // A | (A & ?) = A
Craig Topperdad7d8d2017-07-16 06:57:41 +00001811 if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001812 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001813
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001814 // ~(A & ?) | A = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001815 if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001816 return Constant::getAllOnesValue(Op1->getType());
1817
1818 // A | ~(A & ?) = -1
Craig Topperdad7d8d2017-07-16 06:57:41 +00001819 if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001820 return Constant::getAllOnesValue(Op0->getType());
1821
Craig Topperdad7d8d2017-07-16 06:57:41 +00001822 Value *A, *B;
Sanjay Patel08892252017-04-24 18:24:36 +00001823 // (A & ~B) | (A ^ B) -> (A ^ B)
1824 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001825 // (A & ~B) | (B ^ A) -> (B ^ A)
1826 // (~B & A) | (B ^ A) -> (B ^ A)
1827 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1828 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1829 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001830 return Op1;
1831
1832 // Commute the 'or' operands.
1833 // (A ^ B) | (A & ~B) -> (A ^ B)
1834 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001835 // (B ^ A) | (A & ~B) -> (B ^ A)
1836 // (B ^ A) | (~B & A) -> (B ^ A)
1837 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1838 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1839 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001840 return Op0;
1841
Craig Topper479daaf2017-05-14 07:54:43 +00001842 // (A & B) | (~A ^ B) -> (~A ^ B)
1843 // (B & A) | (~A ^ B) -> (~A ^ B)
1844 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1845 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1846 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1847 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1848 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1849 return Op1;
1850
1851 // (~A ^ B) | (A & B) -> (~A ^ B)
1852 // (~A ^ B) | (B & A) -> (~A ^ B)
1853 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1854 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1855 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1856 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1857 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1858 return Op0;
1859
Sanjay Pateleb731b02017-11-19 15:34:27 +00001860 if (Value *V = simplifyAndOrOfCmps(Op0, Op1, false))
Sanjay Patele42b4d52017-05-04 19:51:34 +00001861 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001862
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001863 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001864 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1865 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001866 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001867
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001868 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001869 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1870 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001871 return V;
1872
Duncan Sandsb0579e92010-11-10 13:00:08 +00001873 // If the operation is with the result of a select instruction, check whether
1874 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001875 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001876 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001877 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001878 return V;
1879
Craig Topper50500d52017-05-26 05:16:20 +00001880 // (A & C1)|(B & C2)
Craig Topper1da22c32017-05-26 19:03:53 +00001881 const APInt *C1, *C2;
1882 if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
1883 match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
1884 if (*C1 == ~*C2) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001885 // (A & C1)|(B & C2)
1886 // If we have: ((V + N) & C1) | (V & C2)
1887 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1888 // replace with V+N.
Craig Topperc8bebb12017-05-26 19:03:59 +00001889 Value *N;
Craig Topper1da22c32017-05-26 19:03:53 +00001890 if (C2->isMask() && // C2 == 0+1+
Craig Topperc8bebb12017-05-26 19:03:59 +00001891 match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001892 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00001893 if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001894 return A;
1895 }
1896 // Or commutes, try both ways.
Craig Topper1da22c32017-05-26 19:03:53 +00001897 if (C1->isMask() &&
Craig Topperc8bebb12017-05-26 19:03:59 +00001898 match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
Nick Lewycky8561a492014-06-19 03:51:46 +00001899 // Add commutes, try both ways.
Craig Topperc8bebb12017-05-26 19:03:59 +00001900 if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001901 return B;
1902 }
1903 }
1904 }
1905
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001906 // If the operation is with the result of a phi instruction, check whether
1907 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001908 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001909 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001910 return V;
1911
Craig Topper9f008862014-04-15 04:59:12 +00001912 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001913}
1914
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001915Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1916 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1917}
1918
Sanjay Patel472cc782016-01-11 22:14:42 +00001919/// Given operands for a Xor, see if we can fold the result.
1920/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001921static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001922 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001923 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1924 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001925
1926 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001927 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001928 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001929
1930 // A ^ 0 = A
1931 if (match(Op1, m_Zero()))
1932 return Op0;
1933
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001934 // A ^ A = 0
1935 if (Op0 == Op1)
1936 return Constant::getNullValue(Op0->getType());
1937
Duncan Sandsc89ac072010-11-17 18:52:15 +00001938 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001939 if (match(Op0, m_Not(m_Specific(Op1))) ||
1940 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00001941 return Constant::getAllOnesValue(Op0->getType());
1942
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001943 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001944 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1945 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001946 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001947
Duncan Sandsb238de02010-11-19 09:20:39 +00001948 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1949 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1950 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1951 // only if B and C are equal. If B and C are equal then (since we assume
1952 // that operands have already been simplified) "select(cond, B, C)" should
1953 // have been simplified to the common value of B and C already. Analysing
1954 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
1955 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00001956
Craig Topper9f008862014-04-15 04:59:12 +00001957 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001958}
1959
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001960Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1961 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
1962}
1963
1964
Chris Lattner229907c2011-07-18 04:54:35 +00001965static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00001966 return CmpInst::makeCmpResultType(Op->getType());
1967}
1968
Sanjay Patel472cc782016-01-11 22:14:42 +00001969/// Rummage around inside V looking for something equivalent to the comparison
1970/// "LHS Pred RHS". Return such a value if found, otherwise return null.
1971/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00001972static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
1973 Value *LHS, Value *RHS) {
1974 SelectInst *SI = dyn_cast<SelectInst>(V);
1975 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00001976 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00001977 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1978 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00001979 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00001980 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
1981 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
1982 return Cmp;
1983 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
1984 LHS == CmpRHS && RHS == CmpLHS)
1985 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00001986 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00001987}
1988
Dan Gohman9631d902013-02-01 00:49:06 +00001989// A significant optimization not implemented here is assuming that alloca
1990// addresses are not equal to incoming argument values. They don't *alias*,
1991// as we say, but that doesn't mean they aren't equal, so we take a
1992// conservative approach.
1993//
1994// This is inspired in part by C++11 5.10p1:
1995// "Two pointers of the same type compare equal if and only if they are both
1996// null, both point to the same function, or both represent the same
1997// address."
1998//
1999// This is pretty permissive.
2000//
2001// It's also partly due to C11 6.5.9p6:
2002// "Two pointers compare equal if and only if both are null pointers, both are
2003// pointers to the same object (including a pointer to an object and a
2004// subobject at its beginning) or function, both are pointers to one past the
2005// last element of the same array object, or one is a pointer to one past the
2006// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002007// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002008// object in the address space.)
2009//
2010// C11's version is more restrictive, however there's no reason why an argument
2011// couldn't be a one-past-the-end value for a stack object in the caller and be
2012// equal to the beginning of a stack object in the callee.
2013//
2014// If the C and C++ standards are ever made sufficiently restrictive in this
2015// area, it may be possible to update LLVM's semantics accordingly and reinstate
2016// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002017static Constant *
2018computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2019 const DominatorTree *DT, CmpInst::Predicate Pred,
Nuno Lopes404f1062017-09-09 18:23:11 +00002020 AssumptionCache *AC, const Instruction *CxtI,
2021 Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002022 // First, skip past any trivial no-ops.
2023 LHS = LHS->stripPointerCasts();
2024 RHS = RHS->stripPointerCasts();
2025
2026 // A non-null pointer is not equal to a null pointer.
Nuno Lopes404f1062017-09-09 18:23:11 +00002027 if (llvm::isKnownNonZero(LHS, DL) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002028 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2029 return ConstantInt::get(GetCompareTy(LHS),
2030 !CmpInst::isTrueWhenEqual(Pred));
2031
Chandler Carruth8059c842012-03-25 21:28:14 +00002032 // We can only fold certain predicates on pointer comparisons.
2033 switch (Pred) {
2034 default:
Craig Topper9f008862014-04-15 04:59:12 +00002035 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002036
2037 // Equality comaprisons are easy to fold.
2038 case CmpInst::ICMP_EQ:
2039 case CmpInst::ICMP_NE:
2040 break;
2041
2042 // We can only handle unsigned relational comparisons because 'inbounds' on
2043 // a GEP only protects against unsigned wrapping.
2044 case CmpInst::ICMP_UGT:
2045 case CmpInst::ICMP_UGE:
2046 case CmpInst::ICMP_ULT:
2047 case CmpInst::ICMP_ULE:
2048 // However, we have to switch them to their signed variants to handle
2049 // negative indices from the base pointer.
2050 Pred = ICmpInst::getSignedPredicate(Pred);
2051 break;
2052 }
2053
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002054 // Strip off any constant offsets so that we can reason about them.
2055 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2056 // here and compare base addresses like AliasAnalysis does, however there are
2057 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2058 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2059 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002060 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2061 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002062
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002063 // If LHS and RHS are related via constant offsets to the same base
2064 // value, we can replace it with an icmp which just compares the offsets.
2065 if (LHS == RHS)
2066 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002067
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002068 // Various optimizations for (in)equality comparisons.
2069 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2070 // Different non-empty allocations that exist at the same time have
2071 // different addresses (if the program can tell). Global variables always
2072 // exist, so they always exist during the lifetime of each other and all
2073 // allocas. Two different allocas usually have different addresses...
2074 //
2075 // However, if there's an @llvm.stackrestore dynamically in between two
2076 // allocas, they may have the same address. It's tempting to reduce the
2077 // scope of the problem by only looking at *static* allocas here. That would
2078 // cover the majority of allocas while significantly reducing the likelihood
2079 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2080 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2081 // an entry block. Also, if we have a block that's not attached to a
2082 // function, we can't tell if it's "static" under the current definition.
2083 // Theoretically, this problem could be fixed by creating a new kind of
2084 // instruction kind specifically for static allocas. Such a new instruction
2085 // could be required to be at the top of the entry block, thus preventing it
2086 // from being subject to a @llvm.stackrestore. Instcombine could even
2087 // convert regular allocas into these special allocas. It'd be nifty.
2088 // However, until then, this problem remains open.
2089 //
2090 // So, we'll assume that two non-empty allocas have different addresses
2091 // for now.
2092 //
2093 // With all that, if the offsets are within the bounds of their allocations
2094 // (and not one-past-the-end! so we can't use inbounds!), and their
2095 // allocations aren't the same, the pointers are not equal.
2096 //
2097 // Note that it's not necessary to check for LHS being a global variable
2098 // address, due to canonicalization and constant folding.
2099 if (isa<AllocaInst>(LHS) &&
2100 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002101 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2102 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002103 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002104 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002105 getObjectSize(LHS, LHSSize, DL, TLI) &&
2106 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002107 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2108 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002109 if (!LHSOffsetValue.isNegative() &&
2110 !RHSOffsetValue.isNegative() &&
2111 LHSOffsetValue.ult(LHSSize) &&
2112 RHSOffsetValue.ult(RHSSize)) {
2113 return ConstantInt::get(GetCompareTy(LHS),
2114 !CmpInst::isTrueWhenEqual(Pred));
2115 }
2116 }
2117
2118 // Repeat the above check but this time without depending on DataLayout
2119 // or being able to compute a precise size.
2120 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2121 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2122 LHSOffset->isNullValue() &&
2123 RHSOffset->isNullValue())
2124 return ConstantInt::get(GetCompareTy(LHS),
2125 !CmpInst::isTrueWhenEqual(Pred));
2126 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002127
2128 // Even if an non-inbounds GEP occurs along the path we can still optimize
2129 // equality comparisons concerning the result. We avoid walking the whole
2130 // chain again by starting where the last calls to
2131 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002132 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2133 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002134 if (LHS == RHS)
2135 return ConstantExpr::getICmp(Pred,
2136 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2137 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002138
2139 // If one side of the equality comparison must come from a noalias call
2140 // (meaning a system memory allocation function), and the other side must
2141 // come from a pointer that cannot overlap with dynamically-allocated
2142 // memory within the lifetime of the current function (allocas, byval
2143 // arguments, globals), then determine the comparison result here.
2144 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2145 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2146 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2147
2148 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002149 auto IsNAC = [](ArrayRef<Value *> Objects) {
2150 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002151 };
2152
2153 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002154 // noalias calls. For allocas, we consider only static ones (dynamic
2155 // allocas might be transformed into calls to malloc not simultaneously
2156 // live with the compared-to allocation). For globals, we exclude symbols
2157 // that might be resolve lazily to symbols in another dynamically-loaded
2158 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002159 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2160 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002161 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2162 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2163 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2164 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002165 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002166 !GV->isThreadLocal();
2167 if (const Argument *A = dyn_cast<Argument>(V))
2168 return A->hasByValAttr();
2169 return false;
2170 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002171 };
2172
2173 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2174 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2175 return ConstantInt::get(GetCompareTy(LHS),
2176 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002177
2178 // Fold comparisons for non-escaping pointer even if the allocation call
2179 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2180 // dynamic allocation call could be either of the operands.
2181 Value *MI = nullptr;
Nuno Lopes404f1062017-09-09 18:23:11 +00002182 if (isAllocLikeFn(LHS, TLI) &&
2183 llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002184 MI = LHS;
Nuno Lopes404f1062017-09-09 18:23:11 +00002185 else if (isAllocLikeFn(RHS, TLI) &&
2186 llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002187 MI = RHS;
2188 // FIXME: We should also fold the compare when the pointer escapes, but the
2189 // compare dominates the pointer escape
2190 if (MI && !PointerMayBeCaptured(MI, true, true))
2191 return ConstantInt::get(GetCompareTy(LHS),
2192 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002193 }
2194
2195 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002196 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002197}
Chris Lattner01990f02012-02-24 19:01:58 +00002198
Sanjay Pateldc65a272016-12-03 17:30:22 +00002199/// Fold an icmp when its operands have i1 scalar type.
2200static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002201 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002202 Type *ITy = GetCompareTy(LHS); // The return type.
2203 Type *OpTy = LHS->getType(); // The operand type.
Craig Topperfde47232017-07-09 07:04:03 +00002204 if (!OpTy->isIntOrIntVectorTy(1))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002205 return nullptr;
2206
Sanjay Patele2787b92017-05-17 20:27:55 +00002207 // A boolean compared to true/false can be simplified in 14 out of the 20
2208 // (10 predicates * 2 constants) possible combinations. Cases not handled here
2209 // require a 'not' of the LHS, so those must be transformed in InstCombine.
2210 if (match(RHS, m_Zero())) {
2211 switch (Pred) {
2212 case CmpInst::ICMP_NE: // X != 0 -> X
2213 case CmpInst::ICMP_UGT: // X >u 0 -> X
2214 case CmpInst::ICMP_SLT: // X <s 0 -> X
2215 return LHS;
2216
2217 case CmpInst::ICMP_ULT: // X <u 0 -> false
2218 case CmpInst::ICMP_SGT: // X >s 0 -> false
2219 return getFalse(ITy);
2220
2221 case CmpInst::ICMP_UGE: // X >=u 0 -> true
2222 case CmpInst::ICMP_SLE: // X <=s 0 -> true
2223 return getTrue(ITy);
2224
2225 default: break;
2226 }
2227 } else if (match(RHS, m_One())) {
2228 switch (Pred) {
2229 case CmpInst::ICMP_EQ: // X == 1 -> X
2230 case CmpInst::ICMP_UGE: // X >=u 1 -> X
2231 case CmpInst::ICMP_SLE: // X <=s -1 -> X
2232 return LHS;
2233
2234 case CmpInst::ICMP_UGT: // X >u 1 -> false
2235 case CmpInst::ICMP_SLT: // X <s -1 -> false
2236 return getFalse(ITy);
2237
2238 case CmpInst::ICMP_ULE: // X <=u 1 -> true
2239 case CmpInst::ICMP_SGE: // X >=s -1 -> true
2240 return getTrue(ITy);
2241
2242 default: break;
2243 }
2244 }
2245
Sanjay Pateldc65a272016-12-03 17:30:22 +00002246 switch (Pred) {
2247 default:
2248 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002249 case ICmpInst::ICMP_UGE:
Sanjay Pateldc65a272016-12-03 17:30:22 +00002250 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2251 return getTrue(ITy);
2252 break;
2253 case ICmpInst::ICMP_SGE:
2254 /// For signed comparison, the values for an i1 are 0 and -1
2255 /// respectively. This maps into a truth table of:
2256 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2257 /// 0 | 0 | 1 (0 >= 0) | 1
2258 /// 0 | 1 | 1 (0 >= -1) | 1
2259 /// 1 | 0 | 0 (-1 >= 0) | 0
2260 /// 1 | 1 | 1 (-1 >= -1) | 1
2261 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2262 return getTrue(ITy);
2263 break;
Sanjay Pateldc65a272016-12-03 17:30:22 +00002264 case ICmpInst::ICMP_ULE:
2265 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2266 return getTrue(ITy);
2267 break;
2268 }
2269
2270 return nullptr;
2271}
2272
2273/// Try hard to fold icmp with zero RHS because this is a common case.
2274static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002275 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002276 if (!match(RHS, m_Zero()))
2277 return nullptr;
2278
2279 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002280 switch (Pred) {
2281 default:
2282 llvm_unreachable("Unknown ICmp predicate!");
2283 case ICmpInst::ICMP_ULT:
2284 return getFalse(ITy);
2285 case ICmpInst::ICMP_UGE:
2286 return getTrue(ITy);
2287 case ICmpInst::ICMP_EQ:
2288 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002289 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002290 return getFalse(ITy);
2291 break;
2292 case ICmpInst::ICMP_NE:
2293 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002294 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002295 return getTrue(ITy);
2296 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002297 case ICmpInst::ICMP_SLT: {
2298 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2299 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002300 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002301 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002302 return getFalse(ITy);
2303 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002304 }
2305 case ICmpInst::ICMP_SLE: {
2306 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2307 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002308 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002309 if (LHSKnown.isNonNegative() &&
2310 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002311 return getFalse(ITy);
2312 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002313 }
2314 case ICmpInst::ICMP_SGE: {
2315 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2316 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002317 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002318 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002319 return getTrue(ITy);
2320 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002321 }
2322 case ICmpInst::ICMP_SGT: {
2323 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2324 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002325 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002326 if (LHSKnown.isNonNegative() &&
2327 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002328 return getTrue(ITy);
2329 break;
2330 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002331 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002332
2333 return nullptr;
2334}
2335
Sanjay Patelbe332132017-01-23 18:22:26 +00002336/// Many binary operators with a constant operand have an easy-to-compute
2337/// range of outputs. This can be used to fold a comparison to always true or
2338/// always false.
2339static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2340 unsigned Width = Lower.getBitWidth();
2341 const APInt *C;
2342 switch (BO.getOpcode()) {
2343 case Instruction::Add:
Craig Topper73ba1c82017-06-07 07:40:37 +00002344 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patel56227252017-01-24 17:03:24 +00002345 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2346 if (BO.hasNoUnsignedWrap()) {
2347 // 'add nuw x, C' produces [C, UINT_MAX].
2348 Lower = *C;
2349 } else if (BO.hasNoSignedWrap()) {
2350 if (C->isNegative()) {
2351 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2352 Lower = APInt::getSignedMinValue(Width);
2353 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2354 } else {
2355 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2356 Lower = APInt::getSignedMinValue(Width) + *C;
2357 Upper = APInt::getSignedMaxValue(Width) + 1;
2358 }
2359 }
2360 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002361 break;
2362
2363 case Instruction::And:
2364 if (match(BO.getOperand(1), m_APInt(C)))
2365 // 'and x, C' produces [0, C].
2366 Upper = *C + 1;
2367 break;
2368
2369 case Instruction::Or:
2370 if (match(BO.getOperand(1), m_APInt(C)))
2371 // 'or x, C' produces [C, UINT_MAX].
2372 Lower = *C;
2373 break;
2374
2375 case Instruction::AShr:
2376 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2377 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2378 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2379 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2380 } else if (match(BO.getOperand(0), m_APInt(C))) {
2381 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002382 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002383 ShiftAmount = C->countTrailingZeros();
2384 if (C->isNegative()) {
2385 // 'ashr C, x' produces [C, C >> (Width-1)]
2386 Lower = *C;
2387 Upper = C->ashr(ShiftAmount) + 1;
2388 } else {
2389 // 'ashr C, x' produces [C >> (Width-1), C]
2390 Lower = C->ashr(ShiftAmount);
2391 Upper = *C + 1;
2392 }
2393 }
2394 break;
2395
2396 case Instruction::LShr:
2397 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2398 // 'lshr x, C' produces [0, UINT_MAX >> C].
2399 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2400 } else if (match(BO.getOperand(0), m_APInt(C))) {
2401 // 'lshr C, x' produces [C >> (Width-1), C].
2402 unsigned ShiftAmount = Width - 1;
Craig Topper73ba1c82017-06-07 07:40:37 +00002403 if (!C->isNullValue() && BO.isExact())
Sanjay Patelbe332132017-01-23 18:22:26 +00002404 ShiftAmount = C->countTrailingZeros();
2405 Lower = C->lshr(ShiftAmount);
2406 Upper = *C + 1;
2407 }
2408 break;
2409
2410 case Instruction::Shl:
2411 if (match(BO.getOperand(0), m_APInt(C))) {
2412 if (BO.hasNoUnsignedWrap()) {
2413 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2414 Lower = *C;
2415 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2416 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2417 if (C->isNegative()) {
2418 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2419 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2420 Lower = C->shl(ShiftAmount);
2421 Upper = *C + 1;
2422 } else {
2423 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2424 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2425 Lower = *C;
2426 Upper = C->shl(ShiftAmount) + 1;
2427 }
2428 }
2429 }
2430 break;
2431
2432 case Instruction::SDiv:
2433 if (match(BO.getOperand(1), m_APInt(C))) {
2434 APInt IntMin = APInt::getSignedMinValue(Width);
2435 APInt IntMax = APInt::getSignedMaxValue(Width);
2436 if (C->isAllOnesValue()) {
2437 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2438 // where C != -1 and C != 0 and C != 1
2439 Lower = IntMin + 1;
2440 Upper = IntMax + 1;
2441 } else if (C->countLeadingZeros() < Width - 1) {
2442 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2443 // where C != -1 and C != 0 and C != 1
2444 Lower = IntMin.sdiv(*C);
2445 Upper = IntMax.sdiv(*C);
2446 if (Lower.sgt(Upper))
2447 std::swap(Lower, Upper);
2448 Upper = Upper + 1;
2449 assert(Upper != Lower && "Upper part of range has wrapped!");
2450 }
2451 } else if (match(BO.getOperand(0), m_APInt(C))) {
2452 if (C->isMinSignedValue()) {
2453 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2454 Lower = *C;
2455 Upper = Lower.lshr(1) + 1;
2456 } else {
2457 // 'sdiv C, x' produces [-|C|, |C|].
2458 Upper = C->abs() + 1;
2459 Lower = (-Upper) + 1;
2460 }
2461 }
2462 break;
2463
2464 case Instruction::UDiv:
Craig Topper73ba1c82017-06-07 07:40:37 +00002465 if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
Sanjay Patelbe332132017-01-23 18:22:26 +00002466 // 'udiv x, C' produces [0, UINT_MAX / C].
2467 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2468 } else if (match(BO.getOperand(0), m_APInt(C))) {
2469 // 'udiv C, x' produces [0, C].
2470 Upper = *C + 1;
2471 }
2472 break;
2473
2474 case Instruction::SRem:
2475 if (match(BO.getOperand(1), m_APInt(C))) {
2476 // 'srem x, C' produces (-|C|, |C|).
2477 Upper = C->abs();
2478 Lower = (-Upper) + 1;
2479 }
2480 break;
2481
2482 case Instruction::URem:
2483 if (match(BO.getOperand(1), m_APInt(C)))
2484 // 'urem x, C' produces [0, C).
2485 Upper = *C;
2486 break;
2487
2488 default:
2489 break;
2490 }
2491}
2492
Sanjay Patel67bde282016-08-22 23:12:02 +00002493static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2494 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002495 const APInt *C;
2496 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002497 return nullptr;
2498
2499 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002500 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002501 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002502 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002503 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002504 return ConstantInt::getTrue(GetCompareTy(RHS));
2505
Sanjay Patelbe332132017-01-23 18:22:26 +00002506 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002507 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002508 APInt Lower = APInt(Width, 0);
2509 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002510 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2511 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002512
2513 ConstantRange LHS_CR =
2514 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2515
2516 if (auto *I = dyn_cast<Instruction>(LHS))
2517 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2518 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2519
2520 if (!LHS_CR.isFullSet()) {
2521 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002522 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002523 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002524 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002525 }
2526
2527 return nullptr;
2528}
2529
Sanjay Patel2df38a82017-05-08 16:21:55 +00002530/// TODO: A large part of this logic is duplicated in InstCombine's
2531/// foldICmpBinOp(). We should be able to share that and avoid the code
2532/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002533static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002534 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002535 unsigned MaxRecurse) {
2536 Type *ITy = GetCompareTy(LHS); // The return type.
2537
2538 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2539 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2540 if (MaxRecurse && (LBO || RBO)) {
2541 // Analyze the case when either LHS or RHS is an add instruction.
2542 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2543 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2544 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2545 if (LBO && LBO->getOpcode() == Instruction::Add) {
2546 A = LBO->getOperand(0);
2547 B = LBO->getOperand(1);
2548 NoLHSWrapProblem =
2549 ICmpInst::isEquality(Pred) ||
2550 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2551 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2552 }
2553 if (RBO && RBO->getOpcode() == Instruction::Add) {
2554 C = RBO->getOperand(0);
2555 D = RBO->getOperand(1);
2556 NoRHSWrapProblem =
2557 ICmpInst::isEquality(Pred) ||
2558 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2559 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2560 }
2561
2562 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2563 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2564 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2565 Constant::getNullValue(RHS->getType()), Q,
2566 MaxRecurse - 1))
2567 return V;
2568
2569 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2570 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2571 if (Value *V =
2572 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2573 C == LHS ? D : C, Q, MaxRecurse - 1))
2574 return V;
2575
2576 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2577 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2578 NoRHSWrapProblem) {
2579 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2580 Value *Y, *Z;
2581 if (A == C) {
2582 // C + B == C + D -> B == D
2583 Y = B;
2584 Z = D;
2585 } else if (A == D) {
2586 // D + B == C + D -> B == C
2587 Y = B;
2588 Z = C;
2589 } else if (B == C) {
2590 // A + C == C + D -> A == D
2591 Y = A;
2592 Z = D;
2593 } else {
2594 assert(B == D);
2595 // A + D == C + D -> A == C
2596 Y = A;
2597 Z = C;
2598 }
2599 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2600 return V;
2601 }
2602 }
2603
2604 {
2605 Value *Y = nullptr;
2606 // icmp pred (or X, Y), X
2607 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2608 if (Pred == ICmpInst::ICMP_ULT)
2609 return getFalse(ITy);
2610 if (Pred == ICmpInst::ICMP_UGE)
2611 return getTrue(ITy);
2612
2613 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002614 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2615 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2616 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002617 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002618 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002619 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2620 }
2621 }
2622 // icmp pred X, (or X, Y)
2623 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2624 if (Pred == ICmpInst::ICMP_ULE)
2625 return getTrue(ITy);
2626 if (Pred == ICmpInst::ICMP_UGT)
2627 return getFalse(ITy);
2628
2629 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002630 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2631 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2632 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002633 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002634 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002635 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2636 }
2637 }
2638 }
2639
2640 // icmp pred (and X, Y), X
Craig Topper72ee6942017-06-24 06:24:01 +00002641 if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002642 if (Pred == ICmpInst::ICMP_UGT)
2643 return getFalse(ITy);
2644 if (Pred == ICmpInst::ICMP_ULE)
2645 return getTrue(ITy);
2646 }
2647 // icmp pred X, (and X, Y)
Craig Topper72ee6942017-06-24 06:24:01 +00002648 if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002649 if (Pred == ICmpInst::ICMP_UGE)
2650 return getTrue(ITy);
2651 if (Pred == ICmpInst::ICMP_ULT)
2652 return getFalse(ITy);
2653 }
2654
2655 // 0 - (zext X) pred C
2656 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2657 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2658 if (RHSC->getValue().isStrictlyPositive()) {
2659 if (Pred == ICmpInst::ICMP_SLT)
2660 return ConstantInt::getTrue(RHSC->getContext());
2661 if (Pred == ICmpInst::ICMP_SGE)
2662 return ConstantInt::getFalse(RHSC->getContext());
2663 if (Pred == ICmpInst::ICMP_EQ)
2664 return ConstantInt::getFalse(RHSC->getContext());
2665 if (Pred == ICmpInst::ICMP_NE)
2666 return ConstantInt::getTrue(RHSC->getContext());
2667 }
2668 if (RHSC->getValue().isNonNegative()) {
2669 if (Pred == ICmpInst::ICMP_SLE)
2670 return ConstantInt::getTrue(RHSC->getContext());
2671 if (Pred == ICmpInst::ICMP_SGT)
2672 return ConstantInt::getFalse(RHSC->getContext());
2673 }
2674 }
2675 }
2676
2677 // icmp pred (urem X, Y), Y
2678 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002679 switch (Pred) {
2680 default:
2681 break;
2682 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002683 case ICmpInst::ICMP_SGE: {
2684 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2685 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002686 break;
2687 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002688 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002689 case ICmpInst::ICMP_EQ:
2690 case ICmpInst::ICMP_UGT:
2691 case ICmpInst::ICMP_UGE:
2692 return getFalse(ITy);
2693 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002694 case ICmpInst::ICMP_SLE: {
2695 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2696 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002697 break;
2698 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002699 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002700 case ICmpInst::ICMP_NE:
2701 case ICmpInst::ICMP_ULT:
2702 case ICmpInst::ICMP_ULE:
2703 return getTrue(ITy);
2704 }
2705 }
2706
2707 // icmp pred X, (urem Y, X)
2708 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002709 switch (Pred) {
2710 default:
2711 break;
2712 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002713 case ICmpInst::ICMP_SGE: {
2714 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2715 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002716 break;
2717 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002718 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002719 case ICmpInst::ICMP_NE:
2720 case ICmpInst::ICMP_UGT:
2721 case ICmpInst::ICMP_UGE:
2722 return getTrue(ITy);
2723 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002724 case ICmpInst::ICMP_SLE: {
2725 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2726 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002727 break;
2728 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002729 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002730 case ICmpInst::ICMP_EQ:
2731 case ICmpInst::ICMP_ULT:
2732 case ICmpInst::ICMP_ULE:
2733 return getFalse(ITy);
2734 }
2735 }
2736
2737 // x >> y <=u x
2738 // x udiv y <=u x.
2739 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2740 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2741 // icmp pred (X op Y), X
2742 if (Pred == ICmpInst::ICMP_UGT)
2743 return getFalse(ITy);
2744 if (Pred == ICmpInst::ICMP_ULE)
2745 return getTrue(ITy);
2746 }
2747
2748 // x >=u x >> y
2749 // x >=u x udiv y.
2750 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2751 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2752 // icmp pred X, (X op Y)
2753 if (Pred == ICmpInst::ICMP_ULT)
2754 return getFalse(ITy);
2755 if (Pred == ICmpInst::ICMP_UGE)
2756 return getTrue(ITy);
2757 }
2758
2759 // handle:
2760 // CI2 << X == CI
2761 // CI2 << X != CI
2762 //
2763 // where CI2 is a power of 2 and CI isn't
2764 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2765 const APInt *CI2Val, *CIVal = &CI->getValue();
2766 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2767 CI2Val->isPowerOf2()) {
2768 if (!CIVal->isPowerOf2()) {
2769 // CI2 << X can equal zero in some circumstances,
2770 // this simplification is unsafe if CI is zero.
2771 //
2772 // We know it is safe if:
2773 // - The shift is nsw, we can't shift out the one bit.
2774 // - The shift is nuw, we can't shift out the one bit.
2775 // - CI2 is one
2776 // - CI isn't zero
2777 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
Craig Topper73ba1c82017-06-07 07:40:37 +00002778 CI2Val->isOneValue() || !CI->isZero()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002779 if (Pred == ICmpInst::ICMP_EQ)
2780 return ConstantInt::getFalse(RHS->getContext());
2781 if (Pred == ICmpInst::ICMP_NE)
2782 return ConstantInt::getTrue(RHS->getContext());
2783 }
2784 }
Craig Topper73ba1c82017-06-07 07:40:37 +00002785 if (CIVal->isSignMask() && CI2Val->isOneValue()) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002786 if (Pred == ICmpInst::ICMP_UGT)
2787 return ConstantInt::getFalse(RHS->getContext());
2788 if (Pred == ICmpInst::ICMP_ULE)
2789 return ConstantInt::getTrue(RHS->getContext());
2790 }
2791 }
2792 }
2793
2794 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2795 LBO->getOperand(1) == RBO->getOperand(1)) {
2796 switch (LBO->getOpcode()) {
2797 default:
2798 break;
2799 case Instruction::UDiv:
2800 case Instruction::LShr:
Sanjay Patela23b1412017-05-15 19:16:49 +00002801 if (ICmpInst::isSigned(Pred) || !LBO->isExact() || !RBO->isExact())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002802 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00002803 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2804 RBO->getOperand(0), Q, MaxRecurse - 1))
2805 return V;
2806 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002807 case Instruction::SDiv:
Sanjay Patela23b1412017-05-15 19:16:49 +00002808 if (!ICmpInst::isEquality(Pred) || !LBO->isExact() || !RBO->isExact())
2809 break;
2810 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2811 RBO->getOperand(0), Q, MaxRecurse - 1))
2812 return V;
2813 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002814 case Instruction::AShr:
2815 if (!LBO->isExact() || !RBO->isExact())
2816 break;
2817 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2818 RBO->getOperand(0), Q, MaxRecurse - 1))
2819 return V;
2820 break;
2821 case Instruction::Shl: {
2822 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2823 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2824 if (!NUW && !NSW)
2825 break;
2826 if (!NSW && ICmpInst::isSigned(Pred))
2827 break;
2828 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2829 RBO->getOperand(0), Q, MaxRecurse - 1))
2830 return V;
2831 break;
2832 }
2833 }
2834 }
2835 return nullptr;
2836}
2837
Sanjay Patel35289c62016-12-10 17:40:47 +00002838/// Simplify integer comparisons where at least one operand of the compare
2839/// matches an integer min/max idiom.
2840static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002841 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00002842 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002843 Type *ITy = GetCompareTy(LHS); // The return type.
2844 Value *A, *B;
2845 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2846 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2847
2848 // Signed variants on "max(a,b)>=a -> true".
2849 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2850 if (A != RHS)
2851 std::swap(A, B); // smax(A, B) pred A.
2852 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2853 // We analyze this as smax(A, B) pred A.
2854 P = Pred;
2855 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2856 (A == LHS || B == LHS)) {
2857 if (A != LHS)
2858 std::swap(A, B); // A pred smax(A, B).
2859 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2860 // We analyze this as smax(A, B) swapped-pred A.
2861 P = CmpInst::getSwappedPredicate(Pred);
2862 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2863 (A == RHS || B == RHS)) {
2864 if (A != RHS)
2865 std::swap(A, B); // smin(A, B) pred A.
2866 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2867 // We analyze this as smax(-A, -B) swapped-pred -A.
2868 // Note that we do not need to actually form -A or -B thanks to EqP.
2869 P = CmpInst::getSwappedPredicate(Pred);
2870 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2871 (A == LHS || B == LHS)) {
2872 if (A != LHS)
2873 std::swap(A, B); // A pred smin(A, B).
2874 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2875 // We analyze this as smax(-A, -B) pred -A.
2876 // Note that we do not need to actually form -A or -B thanks to EqP.
2877 P = Pred;
2878 }
2879 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2880 // Cases correspond to "max(A, B) p A".
2881 switch (P) {
2882 default:
2883 break;
2884 case CmpInst::ICMP_EQ:
2885 case CmpInst::ICMP_SLE:
2886 // Equivalent to "A EqP B". This may be the same as the condition tested
2887 // in the max/min; if so, we can just return that.
2888 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2889 return V;
2890 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2891 return V;
2892 // Otherwise, see if "A EqP B" simplifies.
2893 if (MaxRecurse)
2894 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2895 return V;
2896 break;
2897 case CmpInst::ICMP_NE:
2898 case CmpInst::ICMP_SGT: {
2899 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2900 // Equivalent to "A InvEqP B". This may be the same as the condition
2901 // tested in the max/min; if so, we can just return that.
2902 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2903 return V;
2904 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2905 return V;
2906 // Otherwise, see if "A InvEqP B" simplifies.
2907 if (MaxRecurse)
2908 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2909 return V;
2910 break;
2911 }
2912 case CmpInst::ICMP_SGE:
2913 // Always true.
2914 return getTrue(ITy);
2915 case CmpInst::ICMP_SLT:
2916 // Always false.
2917 return getFalse(ITy);
2918 }
2919 }
2920
2921 // Unsigned variants on "max(a,b)>=a -> true".
2922 P = CmpInst::BAD_ICMP_PREDICATE;
2923 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2924 if (A != RHS)
2925 std::swap(A, B); // umax(A, B) pred A.
2926 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2927 // We analyze this as umax(A, B) pred A.
2928 P = Pred;
2929 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2930 (A == LHS || B == LHS)) {
2931 if (A != LHS)
2932 std::swap(A, B); // A pred umax(A, B).
2933 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2934 // We analyze this as umax(A, B) swapped-pred A.
2935 P = CmpInst::getSwappedPredicate(Pred);
2936 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2937 (A == RHS || B == RHS)) {
2938 if (A != RHS)
2939 std::swap(A, B); // umin(A, B) pred A.
2940 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2941 // We analyze this as umax(-A, -B) swapped-pred -A.
2942 // Note that we do not need to actually form -A or -B thanks to EqP.
2943 P = CmpInst::getSwappedPredicate(Pred);
2944 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2945 (A == LHS || B == LHS)) {
2946 if (A != LHS)
2947 std::swap(A, B); // A pred umin(A, B).
2948 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2949 // We analyze this as umax(-A, -B) pred -A.
2950 // Note that we do not need to actually form -A or -B thanks to EqP.
2951 P = Pred;
2952 }
2953 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2954 // Cases correspond to "max(A, B) p A".
2955 switch (P) {
2956 default:
2957 break;
2958 case CmpInst::ICMP_EQ:
2959 case CmpInst::ICMP_ULE:
2960 // Equivalent to "A EqP B". This may be the same as the condition tested
2961 // in the max/min; if so, we can just return that.
2962 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2963 return V;
2964 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2965 return V;
2966 // Otherwise, see if "A EqP B" simplifies.
2967 if (MaxRecurse)
2968 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2969 return V;
2970 break;
2971 case CmpInst::ICMP_NE:
2972 case CmpInst::ICMP_UGT: {
2973 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2974 // Equivalent to "A InvEqP B". This may be the same as the condition
2975 // tested in the max/min; if so, we can just return that.
2976 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2977 return V;
2978 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2979 return V;
2980 // Otherwise, see if "A InvEqP B" simplifies.
2981 if (MaxRecurse)
2982 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2983 return V;
2984 break;
2985 }
2986 case CmpInst::ICMP_UGE:
2987 // Always true.
2988 return getTrue(ITy);
2989 case CmpInst::ICMP_ULT:
2990 // Always false.
2991 return getFalse(ITy);
2992 }
2993 }
2994
2995 // Variants on "max(x,y) >= min(x,z)".
2996 Value *C, *D;
2997 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
2998 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
2999 (A == C || A == D || B == C || B == D)) {
3000 // max(x, ?) pred min(x, ?).
3001 if (Pred == CmpInst::ICMP_SGE)
3002 // Always true.
3003 return getTrue(ITy);
3004 if (Pred == CmpInst::ICMP_SLT)
3005 // Always false.
3006 return getFalse(ITy);
3007 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3008 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3009 (A == C || A == D || B == C || B == D)) {
3010 // min(x, ?) pred max(x, ?).
3011 if (Pred == CmpInst::ICMP_SLE)
3012 // Always true.
3013 return getTrue(ITy);
3014 if (Pred == CmpInst::ICMP_SGT)
3015 // Always false.
3016 return getFalse(ITy);
3017 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3018 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3019 (A == C || A == D || B == C || B == D)) {
3020 // max(x, ?) pred min(x, ?).
3021 if (Pred == CmpInst::ICMP_UGE)
3022 // Always true.
3023 return getTrue(ITy);
3024 if (Pred == CmpInst::ICMP_ULT)
3025 // Always false.
3026 return getFalse(ITy);
3027 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3028 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3029 (A == C || A == D || B == C || B == D)) {
3030 // min(x, ?) pred max(x, ?).
3031 if (Pred == CmpInst::ICMP_ULE)
3032 // Always true.
3033 return getTrue(ITy);
3034 if (Pred == CmpInst::ICMP_UGT)
3035 // Always false.
3036 return getFalse(ITy);
3037 }
3038
3039 return nullptr;
3040}
3041
Sanjay Patel472cc782016-01-11 22:14:42 +00003042/// Given operands for an ICmpInst, see if we can fold the result.
3043/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003044static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003045 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003046 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003047 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003048
Chris Lattnera71e9d62009-11-10 00:55:12 +00003049 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003050 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003051 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003052
3053 // If we have a constant, make sure it is on the RHS.
3054 std::swap(LHS, RHS);
3055 Pred = CmpInst::getSwappedPredicate(Pred);
3056 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003057
Chris Lattner229907c2011-07-18 04:54:35 +00003058 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003059
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003060 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00003061 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
3062 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00003063 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003064 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003065
Sanjay Pateldc65a272016-12-03 17:30:22 +00003066 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3067 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003068
Sanjay Pateldc65a272016-12-03 17:30:22 +00003069 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3070 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003071
Sanjay Patel67bde282016-08-22 23:12:02 +00003072 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3073 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003074
Chen Li7452d952015-09-26 03:26:47 +00003075 // If both operands have range metadata, use the metadata
3076 // to simplify the comparison.
3077 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003078 auto RHS_Instr = cast<Instruction>(RHS);
3079 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003080
3081 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3082 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003083 auto RHS_CR = getConstantRangeFromMetadata(
3084 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3085 auto LHS_CR = getConstantRangeFromMetadata(
3086 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003087
3088 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3089 if (Satisfied_CR.contains(LHS_CR))
3090 return ConstantInt::getTrue(RHS->getContext());
3091
3092 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3093 CmpInst::getInversePredicate(Pred), RHS_CR);
3094 if (InversedSatisfied_CR.contains(LHS_CR))
3095 return ConstantInt::getFalse(RHS->getContext());
3096 }
3097 }
3098
Duncan Sands8fb2c382011-01-20 13:21:55 +00003099 // Compare of cast, for example (zext X) != 0 -> X != 0
3100 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3101 Instruction *LI = cast<CastInst>(LHS);
3102 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003103 Type *SrcTy = SrcOp->getType();
3104 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003105
3106 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3107 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003108 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3109 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003110 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3111 // Transfer the cast to the constant.
3112 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3113 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003114 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003115 return V;
3116 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3117 if (RI->getOperand(0)->getType() == SrcTy)
3118 // Compare without the cast.
3119 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003120 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003121 return V;
3122 }
3123 }
3124
3125 if (isa<ZExtInst>(LHS)) {
3126 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3127 // same type.
3128 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3129 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3130 // Compare X and Y. Note that signed predicates become unsigned.
3131 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003132 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003133 MaxRecurse-1))
3134 return V;
3135 }
3136 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3137 // too. If not, then try to deduce the result of the comparison.
3138 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3139 // Compute the constant that would happen if we truncated to SrcTy then
3140 // reextended to DstTy.
3141 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3142 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3143
3144 // If the re-extended constant didn't change then this is effectively
3145 // also a case of comparing two zero-extended values.
3146 if (RExt == CI && MaxRecurse)
3147 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003148 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003149 return V;
3150
3151 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3152 // there. Use this to work out the result of the comparison.
3153 if (RExt != CI) {
3154 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003155 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003156 // LHS <u RHS.
3157 case ICmpInst::ICMP_EQ:
3158 case ICmpInst::ICMP_UGT:
3159 case ICmpInst::ICMP_UGE:
3160 return ConstantInt::getFalse(CI->getContext());
3161
3162 case ICmpInst::ICMP_NE:
3163 case ICmpInst::ICMP_ULT:
3164 case ICmpInst::ICMP_ULE:
3165 return ConstantInt::getTrue(CI->getContext());
3166
3167 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3168 // is non-negative then LHS <s RHS.
3169 case ICmpInst::ICMP_SGT:
3170 case ICmpInst::ICMP_SGE:
3171 return CI->getValue().isNegative() ?
3172 ConstantInt::getTrue(CI->getContext()) :
3173 ConstantInt::getFalse(CI->getContext());
3174
3175 case ICmpInst::ICMP_SLT:
3176 case ICmpInst::ICMP_SLE:
3177 return CI->getValue().isNegative() ?
3178 ConstantInt::getFalse(CI->getContext()) :
3179 ConstantInt::getTrue(CI->getContext());
3180 }
3181 }
3182 }
3183 }
3184
3185 if (isa<SExtInst>(LHS)) {
3186 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3187 // same type.
3188 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3189 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3190 // Compare X and Y. Note that the predicate does not change.
3191 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003192 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003193 return V;
3194 }
3195 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3196 // too. If not, then try to deduce the result of the comparison.
3197 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3198 // Compute the constant that would happen if we truncated to SrcTy then
3199 // reextended to DstTy.
3200 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3201 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3202
3203 // If the re-extended constant didn't change then this is effectively
3204 // also a case of comparing two sign-extended values.
3205 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003206 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003207 return V;
3208
3209 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3210 // bits there. Use this to work out the result of the comparison.
3211 if (RExt != CI) {
3212 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003213 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003214 case ICmpInst::ICMP_EQ:
3215 return ConstantInt::getFalse(CI->getContext());
3216 case ICmpInst::ICMP_NE:
3217 return ConstantInt::getTrue(CI->getContext());
3218
3219 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3220 // LHS >s RHS.
3221 case ICmpInst::ICMP_SGT:
3222 case ICmpInst::ICMP_SGE:
3223 return CI->getValue().isNegative() ?
3224 ConstantInt::getTrue(CI->getContext()) :
3225 ConstantInt::getFalse(CI->getContext());
3226 case ICmpInst::ICMP_SLT:
3227 case ICmpInst::ICMP_SLE:
3228 return CI->getValue().isNegative() ?
3229 ConstantInt::getFalse(CI->getContext()) :
3230 ConstantInt::getTrue(CI->getContext());
3231
3232 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3233 // LHS >u RHS.
3234 case ICmpInst::ICMP_UGT:
3235 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003236 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003237 if (MaxRecurse)
3238 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3239 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003240 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003241 return V;
3242 break;
3243 case ICmpInst::ICMP_ULT:
3244 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003245 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003246 if (MaxRecurse)
3247 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3248 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003249 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003250 return V;
3251 break;
3252 }
3253 }
3254 }
3255 }
3256 }
3257
James Molloy1d88d6f2015-10-22 13:18:42 +00003258 // icmp eq|ne X, Y -> false|true if X != Y
Craig Topperc2790ec2017-06-06 07:13:04 +00003259 if (ICmpInst::isEquality(Pred) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003260 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
Craig Topper2dfb4802017-06-06 07:13:13 +00003261 return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
James Molloy1d88d6f2015-10-22 13:18:42 +00003262 }
Junmo Park53470fc2016-04-05 21:14:31 +00003263
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003264 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3265 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003266
Sanjay Patel35289c62016-12-10 17:40:47 +00003267 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003268 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003269
Chandler Carruth8059c842012-03-25 21:28:14 +00003270 // Simplify comparisons of related pointers using a powerful, recursive
3271 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003272 if (LHS->getType()->isPointerTy())
Nuno Lopes404f1062017-09-09 18:23:11 +00003273 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI, LHS,
3274 RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003275 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003276 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3277 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3278 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3279 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3280 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3281 Q.DL.getTypeSizeInBits(CRHS->getType()))
Nuno Lopes404f1062017-09-09 18:23:11 +00003282 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
David Majnemerdc8767a2016-08-07 07:58:10 +00003283 CLHS->getPointerOperand(),
3284 CRHS->getPointerOperand()))
3285 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003286
Nick Lewycky3db143e2012-02-26 02:09:49 +00003287 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3288 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3289 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3290 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3291 (ICmpInst::isEquality(Pred) ||
3292 (GLHS->isInBounds() && GRHS->isInBounds() &&
3293 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3294 // The bases are equal and the indices are constant. Build a constant
3295 // expression GEP with the same indices and a null base pointer to see
3296 // what constant folding can make out of it.
3297 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3298 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003299 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3300 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003301
3302 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003303 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3304 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003305 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3306 }
3307 }
3308 }
3309
Duncan Sandsf532d312010-11-07 16:12:23 +00003310 // If the comparison is with the result of a select instruction, check whether
3311 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003312 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003313 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003314 return V;
3315
3316 // If the comparison is with the result of a phi instruction, check whether
3317 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003318 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003319 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003320 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003321
Craig Topper9f008862014-04-15 04:59:12 +00003322 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003323}
3324
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003325Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003326 const SimplifyQuery &Q) {
3327 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3328}
3329
Sanjay Patel472cc782016-01-11 22:14:42 +00003330/// Given operands for an FCmpInst, see if we can fold the result.
3331/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003332static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003333 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003334 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003335 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3336 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3337
Chris Lattnera71e9d62009-11-10 00:55:12 +00003338 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003339 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003340 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003341
Chris Lattnera71e9d62009-11-10 00:55:12 +00003342 // If we have a constant, make sure it is on the RHS.
3343 std::swap(LHS, RHS);
3344 Pred = CmpInst::getSwappedPredicate(Pred);
3345 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003346
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003347 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003348 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003349 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003350 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003351 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003352 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003353
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003354 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3355 if (FMF.noNaNs()) {
3356 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003357 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003358 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003359 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003360 }
3361
Mehdi Aminieb242a52015-03-09 03:20:25 +00003362 // fcmp pred x, undef and fcmp pred undef, x
3363 // fold to true if unordered, false if ordered
3364 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3365 // Choosing NaN for the undef will always make unordered comparison succeed
3366 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003367 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003368 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003369
3370 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003371 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003372 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003373 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003374 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003375 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003376 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003377
Sanjay Patel4ca99682017-11-27 16:37:09 +00003378 // Handle fcmp with constant RHS.
3379 const APFloat *C;
3380 if (match(RHS, m_APFloat(C))) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003381 // If the constant is a nan, see if we can fold the comparison based on it.
Sanjay Patel4ca99682017-11-27 16:37:09 +00003382 if (C->isNaN()) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003383 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003384 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003385 assert(FCmpInst::isUnordered(Pred) &&
3386 "Comparison must be either ordered or unordered!");
3387 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003388 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003389 }
3390 // Check whether the constant is an infinity.
Sanjay Patel4ca99682017-11-27 16:37:09 +00003391 if (C->isInfinity()) {
3392 if (C->isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003393 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003394 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003395 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003396 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003397 case FCmpInst::FCMP_UGE:
3398 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003399 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003400 default:
3401 break;
3402 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003403 } else {
3404 switch (Pred) {
3405 case FCmpInst::FCMP_OGT:
3406 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003407 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003408 case FCmpInst::FCMP_ULE:
3409 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003410 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003411 default:
3412 break;
3413 }
3414 }
3415 }
Sanjay Patel4ca99682017-11-27 16:37:09 +00003416 if (C->isZero()) {
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003417 switch (Pred) {
3418 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003419 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003420 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003421 break;
3422 case FCmpInst::FCMP_OLT:
3423 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003424 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003425 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003426 break;
3427 default:
3428 break;
3429 }
Florian Hahn30932a32017-12-01 12:34:16 +00003430 } else if (C->isNegative()) {
3431 assert(!C->isNaN() && "Unexpected NaN constant!");
3432 // TODO: We can catch more cases by using a range check rather than
3433 // relying on CannotBeOrderedLessThanZero.
3434 switch (Pred) {
3435 case FCmpInst::FCMP_UGE:
3436 case FCmpInst::FCMP_UGT:
3437 case FCmpInst::FCMP_UNE:
3438 // (X >= 0) implies (X > C) when (C < 0)
3439 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3440 return getTrue(RetTy);
3441 break;
3442 case FCmpInst::FCMP_OEQ:
3443 case FCmpInst::FCMP_OLE:
3444 case FCmpInst::FCMP_OLT:
3445 // (X >= 0) implies !(X < C) when (C < 0)
3446 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3447 return getFalse(RetTy);
3448 break;
3449 default:
3450 break;
3451 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003452 }
3453 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003454
Duncan Sandsa620bd12010-11-07 16:46:25 +00003455 // If the comparison is with the result of a select instruction, check whether
3456 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003457 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003458 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003459 return V;
3460
3461 // If the comparison is with the result of a phi instruction, check whether
3462 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003463 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003464 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003465 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003466
Craig Topper9f008862014-04-15 04:59:12 +00003467 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003468}
3469
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003470Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003471 FastMathFlags FMF, const SimplifyQuery &Q) {
3472 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003473}
3474
Sanjay Patel472cc782016-01-11 22:14:42 +00003475/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003476static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003477 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003478 unsigned MaxRecurse) {
3479 // Trivial replacement.
3480 if (V == Op)
3481 return RepOp;
3482
Tim Northover997f5f12017-05-22 21:28:08 +00003483 // We cannot replace a constant, and shouldn't even try.
3484 if (isa<Constant>(Op))
3485 return nullptr;
3486
David Majnemer3f0fb982015-06-06 22:40:21 +00003487 auto *I = dyn_cast<Instruction>(V);
3488 if (!I)
3489 return nullptr;
3490
3491 // If this is a binary operator, try to simplify it with the replaced op.
3492 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3493 // Consider:
3494 // %cmp = icmp eq i32 %x, 2147483647
3495 // %add = add nsw i32 %x, 1
3496 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3497 //
3498 // We can't replace %sel with %add unless we strip away the flags.
3499 if (isa<OverflowingBinaryOperator>(B))
3500 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3501 return nullptr;
3502 if (isa<PossiblyExactOperator>(B))
3503 if (B->isExact())
3504 return nullptr;
3505
3506 if (MaxRecurse) {
3507 if (B->getOperand(0) == Op)
3508 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3509 MaxRecurse - 1);
3510 if (B->getOperand(1) == Op)
3511 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3512 MaxRecurse - 1);
3513 }
3514 }
3515
3516 // Same for CmpInsts.
3517 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3518 if (MaxRecurse) {
3519 if (C->getOperand(0) == Op)
3520 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3521 MaxRecurse - 1);
3522 if (C->getOperand(1) == Op)
3523 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3524 MaxRecurse - 1);
3525 }
3526 }
3527
3528 // TODO: We could hand off more cases to instsimplify here.
3529
3530 // If all operands are constant after substituting Op for RepOp then we can
3531 // constant fold the instruction.
3532 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3533 // Build a list of all constant operands.
3534 SmallVector<Constant *, 8> ConstOps;
3535 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3536 if (I->getOperand(i) == Op)
3537 ConstOps.push_back(CRepOp);
3538 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3539 ConstOps.push_back(COp);
3540 else
3541 break;
3542 }
3543
3544 // All operands were constants, fold it.
3545 if (ConstOps.size() == I->getNumOperands()) {
3546 if (CmpInst *C = dyn_cast<CmpInst>(I))
3547 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3548 ConstOps[1], Q.DL, Q.TLI);
3549
3550 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3551 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003552 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003553
Manuel Jacobe9024592016-01-21 06:33:22 +00003554 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003555 }
3556 }
3557
3558 return nullptr;
3559}
3560
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003561/// Try to simplify a select instruction when its condition operand is an
3562/// integer comparison where one operand of the compare is a constant.
3563static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3564 const APInt *Y, bool TrueWhenUnset) {
3565 const APInt *C;
3566
3567 // (X & Y) == 0 ? X & ~Y : X --> X
3568 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3569 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3570 *Y == ~*C)
3571 return TrueWhenUnset ? FalseVal : TrueVal;
3572
3573 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3574 // (X & Y) != 0 ? X : X & ~Y --> X
3575 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3576 *Y == ~*C)
3577 return TrueWhenUnset ? FalseVal : TrueVal;
3578
3579 if (Y->isPowerOf2()) {
3580 // (X & Y) == 0 ? X | Y : X --> X | Y
3581 // (X & Y) != 0 ? X | Y : X --> X
3582 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3583 *Y == *C)
3584 return TrueWhenUnset ? TrueVal : FalseVal;
3585
3586 // (X & Y) == 0 ? X : X | Y --> X
3587 // (X & Y) != 0 ? X : X | Y --> X | Y
3588 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3589 *Y == *C)
3590 return TrueWhenUnset ? TrueVal : FalseVal;
3591 }
Matt Arsenault82606662017-01-11 00:57:54 +00003592
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003593 return nullptr;
3594}
3595
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003596/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3597/// eq/ne.
Craig Topper0aa3a192017-08-14 21:39:51 +00003598static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3599 ICmpInst::Predicate Pred,
3600 Value *TrueVal, Value *FalseVal) {
3601 Value *X;
3602 APInt Mask;
3603 if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3604 return nullptr;
3605
Craig Topper0aa3a192017-08-14 21:39:51 +00003606 return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3607 Pred == ICmpInst::ICMP_EQ);
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003608}
3609
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003610/// Try to simplify a select instruction when its condition operand is an
3611/// integer comparison.
3612static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003613 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003614 unsigned MaxRecurse) {
3615 ICmpInst::Predicate Pred;
3616 Value *CmpLHS, *CmpRHS;
3617 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3618 return nullptr;
3619
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003620 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3621 Value *X;
3622 const APInt *Y;
3623 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3624 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3625 Pred == ICmpInst::ICMP_EQ))
3626 return V;
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003627 }
3628
Craig Topper0aa3a192017-08-14 21:39:51 +00003629 // Check for other compares that behave like bit test.
3630 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3631 TrueVal, FalseVal))
3632 return V;
3633
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003634 if (CondVal->hasOneUse()) {
3635 const APInt *C;
3636 if (match(CmpRHS, m_APInt(C))) {
3637 // X < MIN ? T : F --> F
3638 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3639 return FalseVal;
3640 // X < MIN ? T : F --> F
3641 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3642 return FalseVal;
3643 // X > MAX ? T : F --> F
3644 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3645 return FalseVal;
3646 // X > MAX ? T : F --> F
3647 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3648 return FalseVal;
3649 }
3650 }
3651
3652 // If we have an equality comparison, then we know the value in one of the
3653 // arms of the select. See if substituting this value into the arm and
3654 // simplifying the result yields the same value as the other arm.
3655 if (Pred == ICmpInst::ICMP_EQ) {
3656 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3657 TrueVal ||
3658 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3659 TrueVal)
3660 return FalseVal;
3661 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3662 FalseVal ||
3663 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3664 FalseVal)
3665 return FalseVal;
3666 } else if (Pred == ICmpInst::ICMP_NE) {
3667 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3668 FalseVal ||
3669 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3670 FalseVal)
3671 return TrueVal;
3672 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3673 TrueVal ||
3674 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3675 TrueVal)
3676 return TrueVal;
3677 }
3678
3679 return nullptr;
3680}
3681
Sanjay Patel472cc782016-01-11 22:14:42 +00003682/// Given operands for a SelectInst, see if we can fold the result.
3683/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003684static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003685 Value *FalseVal, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003686 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003687 // select true, X, Y -> X
3688 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003689 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
Haicheng Wu25f6c192017-10-02 23:43:52 +00003690 if (Constant *CT = dyn_cast<Constant>(TrueVal))
3691 if (Constant *CF = dyn_cast<Constant>(FalseVal))
3692 return ConstantFoldSelectInstruction(CB, CT, CF);
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003693 if (CB->isAllOnesValue())
3694 return TrueVal;
3695 if (CB->isNullValue())
3696 return FalseVal;
3697 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003698
Chris Lattnerc707fa92010-04-20 05:32:14 +00003699 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003700 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003701 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003702
Chris Lattnerc707fa92010-04-20 05:32:14 +00003703 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
Daniel Berlin4d0fe642017-04-28 19:55:38 +00003704 if (isa<Constant>(FalseVal))
3705 return FalseVal;
3706 return TrueVal;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003707 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003708 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3709 return FalseVal;
3710 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3711 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003712
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003713 if (Value *V =
3714 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3715 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003716
Craig Topper9f008862014-04-15 04:59:12 +00003717 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003718}
3719
Duncan Sandsb8cee002012-03-13 11:42:19 +00003720Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003721 const SimplifyQuery &Q) {
3722 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003723}
3724
Sanjay Patel472cc782016-01-11 22:14:42 +00003725/// Given operands for an GetElementPtrInst, see if we can fold the result.
3726/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003727static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003728 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003729 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003730 unsigned AS =
3731 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003732
Chris Lattner8574aba2009-11-27 00:29:05 +00003733 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003734 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003735 return Ops[0];
3736
Nico Weber48c82402014-08-27 20:06:19 +00003737 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003738 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003739 Type *GEPTy = PointerType::get(LastType, AS);
3740 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3741 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003742 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3743 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003744
3745 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003746 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003747
Jay Foadb992a632011-07-19 15:07:52 +00003748 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003749 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003750 if (match(Ops[1], m_Zero()))
3751 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003752
David Blaikie4a2e73b2015-04-02 18:55:32 +00003753 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003754 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003755 Value *P;
3756 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003757 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003758 // getelementptr P, N -> P if P points to a type of zero size.
3759 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003760 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003761
3762 // The following transforms are only safe if the ptrtoint cast
3763 // doesn't truncate the pointers.
3764 if (Ops[1]->getType()->getScalarSizeInBits() ==
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003765 Q.DL.getIndexSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003766 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3767 if (match(P, m_Zero()))
3768 return Constant::getNullValue(GEPTy);
3769 Value *Temp;
3770 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003771 if (Temp->getType() == GEPTy)
3772 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003773 return nullptr;
3774 };
3775
3776 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3777 if (TyAllocSize == 1 &&
3778 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3779 if (Value *R = PtrToIntOrZero(P))
3780 return R;
3781
3782 // getelementptr V, (ashr (sub P, V), C) -> Q
3783 // if P points to a type of size 1 << C.
3784 if (match(Ops[1],
3785 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3786 m_ConstantInt(C))) &&
3787 TyAllocSize == 1ULL << C)
3788 if (Value *R = PtrToIntOrZero(P))
3789 return R;
3790
3791 // getelementptr V, (sdiv (sub P, V), C) -> Q
3792 // if P points to a type of size C.
3793 if (match(Ops[1],
3794 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3795 m_SpecificInt(TyAllocSize))))
3796 if (Value *R = PtrToIntOrZero(P))
3797 return R;
3798 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003799 }
3800 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003801
David Majnemerd1501372016-08-07 07:58:12 +00003802 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3803 all_of(Ops.slice(1).drop_back(1),
3804 [](Value *Idx) { return match(Idx, m_Zero()); })) {
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003805 unsigned IdxWidth =
3806 Q.DL.getIndexSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3807 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == IdxWidth) {
3808 APInt BasePtrOffset(IdxWidth, 0);
David Majnemerd1501372016-08-07 07:58:12 +00003809 Value *StrippedBasePtr =
3810 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3811 BasePtrOffset);
3812
David Majnemer5c5df622016-08-16 06:13:46 +00003813 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003814 if (match(Ops.back(),
3815 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3816 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3817 return ConstantExpr::getIntToPtr(CI, GEPTy);
3818 }
David Majnemer5c5df622016-08-16 06:13:46 +00003819 // gep (gep V, C), (xor V, -1) -> C-1
3820 if (match(Ops.back(),
3821 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3822 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3823 return ConstantExpr::getIntToPtr(CI, GEPTy);
3824 }
David Majnemerd1501372016-08-07 07:58:12 +00003825 }
3826 }
3827
Chris Lattner8574aba2009-11-27 00:29:05 +00003828 // Check to see if this is constant foldable.
Craig Topperda8037f2017-06-04 22:41:56 +00003829 if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
3830 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003831
Joey Gouly61eaa632017-06-06 10:17:14 +00003832 auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3833 Ops.slice(1));
3834 if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
3835 return CEFolded;
3836 return CE;
Chris Lattner8574aba2009-11-27 00:29:05 +00003837}
3838
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003839Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003840 const SimplifyQuery &Q) {
3841 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003842}
3843
Sanjay Patel472cc782016-01-11 22:14:42 +00003844/// Given operands for an InsertValueInst, see if we can fold the result.
3845/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003846static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003847 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003848 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003849 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3850 if (Constant *CVal = dyn_cast<Constant>(Val))
3851 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3852
3853 // insertvalue x, undef, n -> x
3854 if (match(Val, m_Undef()))
3855 return Agg;
3856
3857 // insertvalue x, (extractvalue y, n), n
3858 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003859 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3860 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003861 // insertvalue undef, (extractvalue y, n), n -> y
3862 if (match(Agg, m_Undef()))
3863 return EV->getAggregateOperand();
3864
3865 // insertvalue y, (extractvalue y, n), n -> y
3866 if (Agg == EV->getAggregateOperand())
3867 return Agg;
3868 }
3869
Craig Topper9f008862014-04-15 04:59:12 +00003870 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003871}
3872
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003873Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3874 ArrayRef<unsigned> Idxs,
3875 const SimplifyQuery &Q) {
3876 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3877}
3878
Igor Laevskye0edb662017-12-13 11:21:18 +00003879Value *llvm::SimplifyInsertElementInst(Value *Vec, Value *Val, Value *Idx,
3880 const SimplifyQuery &Q) {
3881 // Try to constant fold.
3882 auto *VecC = dyn_cast<Constant>(Vec);
3883 auto *ValC = dyn_cast<Constant>(Val);
3884 auto *IdxC = dyn_cast<Constant>(Idx);
3885 if (VecC && ValC && IdxC)
3886 return ConstantFoldInsertElementInstruction(VecC, ValC, IdxC);
3887
3888 // Fold into undef if index is out of bounds.
3889 if (auto *CI = dyn_cast<ConstantInt>(Idx)) {
3890 uint64_t NumElements = cast<VectorType>(Vec->getType())->getNumElements();
Igor Laevskye0edb662017-12-13 11:21:18 +00003891 if (CI->uge(NumElements))
3892 return UndefValue::get(Vec->getType());
3893 }
3894
Philip Reamese499bc32017-12-30 05:54:22 +00003895 // If index is undef, it might be out of bounds (see above case)
3896 if (isa<UndefValue>(Idx))
3897 return UndefValue::get(Vec->getType());
Igor Laevskye0edb662017-12-13 11:21:18 +00003898
3899 return nullptr;
3900}
3901
Sanjay Patel472cc782016-01-11 22:14:42 +00003902/// Given operands for an ExtractValueInst, see if we can fold the result.
3903/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003904static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003905 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00003906 if (auto *CAgg = dyn_cast<Constant>(Agg))
3907 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3908
3909 // extractvalue x, (insertvalue y, elt, n), n -> elt
3910 unsigned NumIdxs = Idxs.size();
3911 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3912 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3913 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3914 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3915 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3916 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3917 Idxs.slice(0, NumCommonIdxs)) {
3918 if (NumIdxs == NumInsertValueIdxs)
3919 return IVI->getInsertedValueOperand();
3920 break;
3921 }
3922 }
3923
3924 return nullptr;
3925}
3926
3927Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003928 const SimplifyQuery &Q) {
3929 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
3930}
3931
Sanjay Patel472cc782016-01-11 22:14:42 +00003932/// Given operands for an ExtractElementInst, see if we can fold the result.
3933/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003934static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00003935 unsigned) {
3936 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3937 if (auto *CIdx = dyn_cast<Constant>(Idx))
3938 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3939
3940 // The index is not relevant if our vector is a splat.
3941 if (auto *Splat = CVec->getSplatValue())
3942 return Splat;
3943
3944 if (isa<UndefValue>(Vec))
3945 return UndefValue::get(Vec->getType()->getVectorElementType());
3946 }
3947
3948 // If extracting a specified index from the vector, see if we can recursively
3949 // find a previously computed scalar that was inserted into the vector.
Philip Reamese499bc32017-12-30 05:54:22 +00003950 if (auto *IdxC = dyn_cast<ConstantInt>(Idx)) {
3951 if (IdxC->getValue().uge(Vec->getType()->getVectorNumElements()))
3952 // definitely out of bounds, thus undefined result
3953 return UndefValue::get(Vec->getType()->getVectorElementType());
3954 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
3955 return Elt;
3956 }
David Majnemer599ca442015-07-13 01:15:53 +00003957
Zvi Rackover2e6e88f2017-12-06 17:51:46 +00003958 // An undef extract index can be arbitrarily chosen to be an out-of-range
3959 // index value, which would result in the instruction being undef.
3960 if (isa<UndefValue>(Idx))
3961 return UndefValue::get(Vec->getType()->getVectorElementType());
3962
David Majnemer599ca442015-07-13 01:15:53 +00003963 return nullptr;
3964}
3965
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003966Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
3967 const SimplifyQuery &Q) {
3968 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
3969}
3970
Sanjay Patel472cc782016-01-11 22:14:42 +00003971/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003972static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003973 // If all of the PHI's incoming values are the same then replace the PHI node
3974 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00003975 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00003976 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00003977 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003978 // If the incoming value is the phi node itself, it can safely be skipped.
3979 if (Incoming == PN) continue;
3980 if (isa<UndefValue>(Incoming)) {
3981 // Remember that we saw an undef value, but otherwise ignore them.
3982 HasUndefInput = true;
3983 continue;
3984 }
3985 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00003986 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00003987 CommonValue = Incoming;
3988 }
3989
3990 // If CommonValue is null then all of the incoming values were either undef or
3991 // equal to the phi node itself.
3992 if (!CommonValue)
3993 return UndefValue::get(PN->getType());
3994
3995 // If we have a PHI node like phi(X, undef, X), where X is defined by some
3996 // instruction, we cannot return X as the result of the PHI node unless it
3997 // dominates the PHI block.
3998 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00003999 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004000
4001 return CommonValue;
4002}
4003
David Majnemer6774d612016-07-26 17:58:05 +00004004static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004005 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004006 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004007 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004008
David Majnemer6774d612016-07-26 17:58:05 +00004009 if (auto *CI = dyn_cast<CastInst>(Op)) {
4010 auto *Src = CI->getOperand(0);
4011 Type *SrcTy = Src->getType();
4012 Type *MidTy = CI->getType();
4013 Type *DstTy = Ty;
4014 if (Src->getType() == Ty) {
4015 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4016 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4017 Type *SrcIntPtrTy =
4018 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4019 Type *MidIntPtrTy =
4020 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4021 Type *DstIntPtrTy =
4022 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4023 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4024 SrcIntPtrTy, MidIntPtrTy,
4025 DstIntPtrTy) == Instruction::BitCast)
4026 return Src;
4027 }
4028 }
David Majnemera90a6212016-07-26 05:52:29 +00004029
4030 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004031 if (CastOpc == Instruction::BitCast)
4032 if (Op->getType() == Ty)
4033 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004034
4035 return nullptr;
4036}
4037
David Majnemer6774d612016-07-26 17:58:05 +00004038Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004039 const SimplifyQuery &Q) {
4040 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4041}
4042
Sanjay Patela3c297d2017-04-19 16:48:22 +00004043/// For the given destination element of a shuffle, peek through shuffles to
4044/// match a root vector source operand that contains that element in the same
4045/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4046static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004047 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004048 unsigned MaxRecurse) {
4049 if (!MaxRecurse--)
4050 return nullptr;
4051
4052 // Bail out if any mask value is undefined. That kind of shuffle may be
4053 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004054 if (MaskVal == -1)
4055 return nullptr;
4056
4057 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004058 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004059 int RootElt = MaskVal;
4060 Value *SourceOp = Op0;
4061 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004062 RootElt = MaskVal - InVecNumElts;
4063 SourceOp = Op1;
4064 }
4065
4066 // If the source operand is a shuffle itself, look through it to find the
4067 // matching root vector.
4068 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4069 return foldIdentityShuffles(
4070 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004071 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004072 }
4073
4074 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4075 // size?
4076
4077 // The source operand is not a shuffle. Initialize the root vector value for
4078 // this shuffle if that has not been done yet.
4079 if (!RootVec)
4080 RootVec = SourceOp;
4081
4082 // Give up as soon as a source operand does not match the existing root value.
4083 if (RootVec != SourceOp)
4084 return nullptr;
4085
4086 // The element must be coming from the same lane in the source vector
4087 // (although it may have crossed lanes in intermediate shuffles).
4088 if (RootElt != DestElt)
4089 return nullptr;
4090
4091 return RootVec;
4092}
4093
Zvi Rackover8f460652017-04-03 22:05:30 +00004094static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004095 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004096 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004097 if (isa<UndefValue>(Mask))
4098 return UndefValue::get(RetTy);
4099
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004100 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004101 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004102 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004103
Zvi Rackover0411e462017-04-30 06:10:54 +00004104 SmallVector<int, 32> Indices;
4105 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4106 assert(MaskNumElts == Indices.size() &&
4107 "Size of Indices not same as number of mask elements?");
4108
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004109 // Canonicalization: If mask does not select elements from an input vector,
4110 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004111 bool MaskSelects0 = false, MaskSelects1 = false;
4112 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004113 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004114 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004115 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004116 MaskSelects0 = true;
4117 else
4118 MaskSelects1 = true;
4119 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004120 if (!MaskSelects0)
4121 Op0 = UndefValue::get(InVecTy);
4122 if (!MaskSelects1)
4123 Op1 = UndefValue::get(InVecTy);
4124
4125 auto *Op0Const = dyn_cast<Constant>(Op0);
4126 auto *Op1Const = dyn_cast<Constant>(Op1);
4127
4128 // If all operands are constant, constant fold the shuffle.
4129 if (Op0Const && Op1Const)
4130 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4131
4132 // Canonicalization: if only one input vector is constant, it shall be the
4133 // second one.
4134 if (Op0Const && !Op1Const) {
4135 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004136 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004137 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004138
4139 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4140 // value type is same as the input vectors' type.
4141 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004142 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004143 OpShuf->getMask()->getSplatValue())
4144 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004145
Sanjay Patela3c297d2017-04-19 16:48:22 +00004146 // Don't fold a shuffle with undef mask elements. This may get folded in a
4147 // better way using demanded bits or other analysis.
4148 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004149 if (find(Indices, -1) != Indices.end())
4150 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004151
4152 // Check if every element of this shuffle can be mapped back to the
4153 // corresponding element of a single root vector. If so, we don't need this
4154 // shuffle. This handles simple identity shuffles as well as chains of
4155 // shuffles that may widen/narrow and/or move elements across lanes and back.
4156 Value *RootVec = nullptr;
4157 for (unsigned i = 0; i != MaskNumElts; ++i) {
4158 // Note that recursion is limited for each vector element, so if any element
4159 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004160 RootVec =
4161 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004162
4163 // We can't replace a widening/narrowing shuffle with one of its operands.
4164 if (!RootVec || RootVec->getType() != RetTy)
4165 return nullptr;
4166 }
4167 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004168}
4169
4170/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004171Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4172 Type *RetTy, const SimplifyQuery &Q) {
4173 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004174}
4175
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004176/// Given operands for an FAdd, see if we can fold the result. If not, this
4177/// returns null.
4178static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4179 const SimplifyQuery &Q, unsigned MaxRecurse) {
4180 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4181 return C;
4182
4183 // fadd X, -0 ==> X
4184 if (match(Op1, m_NegZero()))
4185 return Op0;
4186
4187 // fadd X, 0 ==> X, when we know X is not -0
4188 if (match(Op1, m_Zero()) &&
4189 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4190 return Op0;
4191
4192 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
4193 // where nnan and ninf have to occur at least once somewhere in this
4194 // expression
4195 Value *SubOp = nullptr;
4196 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
4197 SubOp = Op1;
4198 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
4199 SubOp = Op0;
4200 if (SubOp) {
4201 Instruction *FSub = cast<Instruction>(SubOp);
4202 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
4203 (FMF.noInfs() || FSub->hasNoInfs()))
4204 return Constant::getNullValue(Op0->getType());
4205 }
4206
4207 return nullptr;
4208}
4209
4210/// Given operands for an FSub, see if we can fold the result. If not, this
4211/// returns null.
4212static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4213 const SimplifyQuery &Q, unsigned MaxRecurse) {
4214 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
4215 return C;
4216
4217 // fsub X, 0 ==> X
4218 if (match(Op1, m_Zero()))
4219 return Op0;
4220
4221 // fsub X, -0 ==> X, when we know X is not -0
4222 if (match(Op1, m_NegZero()) &&
4223 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4224 return Op0;
4225
4226 // fsub -0.0, (fsub -0.0, X) ==> X
4227 Value *X;
4228 if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
4229 return X;
4230
4231 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
4232 if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
4233 match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
4234 return X;
4235
4236 // fsub nnan x, x ==> 0.0
4237 if (FMF.noNaNs() && Op0 == Op1)
4238 return Constant::getNullValue(Op0->getType());
4239
4240 return nullptr;
4241}
4242
4243/// Given the operands for an FMul, see if we can fold the result
4244static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4245 const SimplifyQuery &Q, unsigned MaxRecurse) {
4246 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
4247 return C;
4248
4249 // fmul X, 1.0 ==> X
4250 if (match(Op1, m_FPOne()))
4251 return Op0;
4252
4253 // fmul nnan nsz X, 0 ==> 0
4254 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
4255 return Op1;
4256
4257 return nullptr;
4258}
4259
4260Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4261 const SimplifyQuery &Q) {
4262 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
4263}
4264
4265
4266Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4267 const SimplifyQuery &Q) {
4268 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
4269}
4270
4271Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4272 const SimplifyQuery &Q) {
4273 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
4274}
4275
4276static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4277 const SimplifyQuery &Q, unsigned) {
4278 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
4279 return C;
4280
4281 // undef / X -> undef (the undef could be a snan).
4282 if (match(Op0, m_Undef()))
4283 return Op0;
4284
4285 // X / undef -> undef
4286 if (match(Op1, m_Undef()))
4287 return Op1;
4288
4289 // X / 1.0 -> X
4290 if (match(Op1, m_FPOne()))
4291 return Op0;
4292
4293 // 0 / X -> 0
4294 // Requires that NaNs are off (X could be zero) and signed zeroes are
4295 // ignored (X could be positive or negative, so the output sign is unknown).
4296 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
4297 return Op0;
4298
4299 if (FMF.noNaNs()) {
4300 // X / X -> 1.0 is legal when NaNs are ignored.
Sanjay Patel83f05662018-01-30 00:18:37 +00004301 // We can ignore infinities because INF/INF is NaN.
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004302 if (Op0 == Op1)
4303 return ConstantFP::get(Op0->getType(), 1.0);
4304
Sanjay Patel83f05662018-01-30 00:18:37 +00004305 // (X * Y) / Y --> X if we can reassociate to the above form.
4306 Value *X;
4307 if (FMF.allowReassoc() && match(Op0, m_c_FMul(m_Value(X), m_Specific(Op1))))
4308 return X;
4309
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004310 // -X / X -> -1.0 and
4311 // X / -X -> -1.0 are legal when NaNs are ignored.
4312 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
4313 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
4314 BinaryOperator::getFNegArgument(Op0) == Op1) ||
4315 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
4316 BinaryOperator::getFNegArgument(Op1) == Op0))
4317 return ConstantFP::get(Op0->getType(), -1.0);
4318 }
4319
4320 return nullptr;
4321}
4322
4323Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4324 const SimplifyQuery &Q) {
4325 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
4326}
4327
4328static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4329 const SimplifyQuery &Q, unsigned) {
4330 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
4331 return C;
4332
4333 // undef % X -> undef (the undef could be a snan).
4334 if (match(Op0, m_Undef()))
4335 return Op0;
4336
4337 // X % undef -> undef
4338 if (match(Op1, m_Undef()))
4339 return Op1;
4340
4341 // 0 % X -> 0
4342 // Requires that NaNs are off (X could be zero) and signed zeroes are
4343 // ignored (X could be positive or negative, so the output sign is unknown).
4344 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
4345 return Op0;
4346
4347 return nullptr;
4348}
4349
4350Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4351 const SimplifyQuery &Q) {
4352 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
4353}
4354
Chris Lattnera71e9d62009-11-10 00:55:12 +00004355//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004356
Sanjay Patel472cc782016-01-11 22:14:42 +00004357/// Given operands for a BinaryOperator, see if we can fold the result.
4358/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004359static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004360 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004361 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004362 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004363 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004364 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004365 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004366 case Instruction::Mul:
4367 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004368 case Instruction::SDiv:
4369 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4370 case Instruction::UDiv:
4371 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004372 case Instruction::SRem:
4373 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4374 case Instruction::URem:
4375 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004376 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004377 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004378 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004379 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004380 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004381 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4382 case Instruction::And:
4383 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4384 case Instruction::Or:
4385 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4386 case Instruction::Xor:
4387 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Sanjay Patelfa877fd2017-09-11 13:34:27 +00004388 case Instruction::FAdd:
4389 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4390 case Instruction::FSub:
4391 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4392 case Instruction::FMul:
4393 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4394 case Instruction::FDiv:
4395 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4396 case Instruction::FRem:
4397 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004398 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004399 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004400 }
4401}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004402
Sanjay Patel472cc782016-01-11 22:14:42 +00004403/// Given operands for a BinaryOperator, see if we can fold the result.
4404/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004405/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4406/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4407static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004408 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004409 unsigned MaxRecurse) {
4410 switch (Opcode) {
4411 case Instruction::FAdd:
4412 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4413 case Instruction::FSub:
4414 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4415 case Instruction::FMul:
4416 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004417 case Instruction::FDiv:
4418 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004419 default:
4420 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4421 }
4422}
4423
Duncan Sands7e800d62010-11-14 11:23:23 +00004424Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004425 const SimplifyQuery &Q) {
4426 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4427}
4428
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004429Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004430 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004431 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4432}
4433
Sanjay Patel472cc782016-01-11 22:14:42 +00004434/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004435static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004436 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004437 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004438 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004439 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004440}
4441
4442Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004443 const SimplifyQuery &Q) {
4444 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4445}
4446
Michael Ilseman54857292013-02-07 19:26:05 +00004447static bool IsIdempotent(Intrinsic::ID ID) {
4448 switch (ID) {
4449 default: return false;
4450
4451 // Unary idempotent: f(f(x)) = f(x)
4452 case Intrinsic::fabs:
4453 case Intrinsic::floor:
4454 case Intrinsic::ceil:
4455 case Intrinsic::trunc:
4456 case Intrinsic::rint:
4457 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004458 case Intrinsic::round:
Matt Arsenault3ced3d92017-09-07 01:21:43 +00004459 case Intrinsic::canonicalize:
Michael Ilseman54857292013-02-07 19:26:05 +00004460 return true;
4461 }
4462}
4463
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004464static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4465 const DataLayout &DL) {
4466 GlobalValue *PtrSym;
4467 APInt PtrOffset;
4468 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4469 return nullptr;
4470
4471 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4472 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4473 Type *Int32PtrTy = Int32Ty->getPointerTo();
4474 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4475
4476 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4477 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4478 return nullptr;
4479
4480 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4481 if (OffsetInt % 4 != 0)
4482 return nullptr;
4483
4484 Constant *C = ConstantExpr::getGetElementPtr(
4485 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4486 ConstantInt::get(Int64Ty, OffsetInt / 4));
4487 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4488 if (!Loaded)
4489 return nullptr;
4490
4491 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4492 if (!LoadedCE)
4493 return nullptr;
4494
4495 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4496 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4497 if (!LoadedCE)
4498 return nullptr;
4499 }
4500
4501 if (LoadedCE->getOpcode() != Instruction::Sub)
4502 return nullptr;
4503
4504 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4505 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4506 return nullptr;
4507 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4508
4509 Constant *LoadedRHS = LoadedCE->getOperand(1);
4510 GlobalValue *LoadedRHSSym;
4511 APInt LoadedRHSOffset;
4512 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4513 DL) ||
4514 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4515 return nullptr;
4516
4517 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4518}
4519
David Majnemer17a95aa2016-07-14 06:58:37 +00004520static bool maskIsAllZeroOrUndef(Value *Mask) {
4521 auto *ConstMask = dyn_cast<Constant>(Mask);
4522 if (!ConstMask)
4523 return false;
4524 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4525 return true;
4526 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4527 ++I) {
4528 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4529 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4530 continue;
4531 return false;
4532 }
4533 return true;
4534}
4535
Michael Ilseman54857292013-02-07 19:26:05 +00004536template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004537static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004538 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004539 Intrinsic::ID IID = F->getIntrinsicID();
4540 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004541
4542 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004543 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004544 // Perform idempotent optimizations
4545 if (IsIdempotent(IID)) {
4546 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4547 if (II->getIntrinsicID() == IID)
4548 return II;
4549 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004550 }
4551
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004552 Value *IIOperand = *ArgBegin;
4553 Value *X;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004554 switch (IID) {
4555 case Intrinsic::fabs: {
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004556 if (SignBitMustBeZero(IIOperand, Q.TLI))
4557 return IIOperand;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004558 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004559 }
Philip Reames5000ba62017-12-27 01:14:30 +00004560 case Intrinsic::bswap: {
Philip Reames5000ba62017-12-27 01:14:30 +00004561 // bswap(bswap(x)) -> x
4562 if (match(IIOperand, m_BSwap(m_Value(X))))
4563 return X;
4564 return nullptr;
4565 }
4566 case Intrinsic::bitreverse: {
Philip Reames5000ba62017-12-27 01:14:30 +00004567 // bitreverse(bitreverse(x)) -> x
4568 if (match(IIOperand, m_BitReverse(m_Value(X))))
4569 return X;
4570 return nullptr;
4571 }
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004572 case Intrinsic::exp: {
4573 // exp(log(x)) -> x
Sanjay Patel246d76922018-02-12 23:51:23 +00004574 if (Q.CxtI->hasAllowReassoc() &&
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004575 match(IIOperand, m_Intrinsic<Intrinsic::log>(m_Value(X))))
4576 return X;
4577 return nullptr;
4578 }
4579 case Intrinsic::exp2: {
4580 // exp2(log2(x)) -> x
Sanjay Patel246d76922018-02-12 23:51:23 +00004581 if (Q.CxtI->hasAllowReassoc() &&
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004582 match(IIOperand, m_Intrinsic<Intrinsic::log2>(m_Value(X))))
4583 return X;
4584 return nullptr;
4585 }
4586 case Intrinsic::log: {
4587 // log(exp(x)) -> x
Sanjay Patel246d76922018-02-12 23:51:23 +00004588 if (Q.CxtI->hasAllowReassoc() &&
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004589 match(IIOperand, m_Intrinsic<Intrinsic::exp>(m_Value(X))))
4590 return X;
4591 return nullptr;
4592 }
4593 case Intrinsic::log2: {
4594 // log2(exp2(x)) -> x
Sanjay Patel246d76922018-02-12 23:51:23 +00004595 if (Q.CxtI->hasAllowReassoc() &&
Dmitry Venikov3d8cd342018-01-03 14:37:42 +00004596 match(IIOperand, m_Intrinsic<Intrinsic::exp2>(m_Value(X)))) {
4597 return X;
4598 }
4599 return nullptr;
4600 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004601 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004602 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004603 }
4604 }
Michael Ilseman54857292013-02-07 19:26:05 +00004605
Matt Arsenault82606662017-01-11 00:57:54 +00004606 // Binary Ops
4607 if (NumOperands == 2) {
4608 Value *LHS = *ArgBegin;
4609 Value *RHS = *(ArgBegin + 1);
4610 Type *ReturnType = F->getReturnType();
4611
4612 switch (IID) {
4613 case Intrinsic::usub_with_overflow:
4614 case Intrinsic::ssub_with_overflow: {
4615 // X - X -> { 0, false }
4616 if (LHS == RHS)
4617 return Constant::getNullValue(ReturnType);
4618
4619 // X - undef -> undef
4620 // undef - X -> undef
4621 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4622 return UndefValue::get(ReturnType);
4623
4624 return nullptr;
4625 }
4626 case Intrinsic::uadd_with_overflow:
4627 case Intrinsic::sadd_with_overflow: {
4628 // X + undef -> undef
Craig Topper77e07cc2017-05-24 17:05:28 +00004629 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
Matt Arsenault82606662017-01-11 00:57:54 +00004630 return UndefValue::get(ReturnType);
4631
4632 return nullptr;
4633 }
4634 case Intrinsic::umul_with_overflow:
4635 case Intrinsic::smul_with_overflow: {
Craig Topper77e07cc2017-05-24 17:05:28 +00004636 // 0 * X -> { 0, false }
Matt Arsenault82606662017-01-11 00:57:54 +00004637 // X * 0 -> { 0, false }
Craig Topper77e07cc2017-05-24 17:05:28 +00004638 if (match(LHS, m_Zero()) || match(RHS, m_Zero()))
Matt Arsenault82606662017-01-11 00:57:54 +00004639 return Constant::getNullValue(ReturnType);
4640
Craig Topper77e07cc2017-05-24 17:05:28 +00004641 // undef * X -> { 0, false }
Matt Arsenault82606662017-01-11 00:57:54 +00004642 // X * undef -> { 0, false }
Craig Topper77e07cc2017-05-24 17:05:28 +00004643 if (match(LHS, m_Undef()) || match(RHS, m_Undef()))
Matt Arsenault82606662017-01-11 00:57:54 +00004644 return Constant::getNullValue(ReturnType);
4645
4646 return nullptr;
4647 }
4648 case Intrinsic::load_relative: {
4649 Constant *C0 = dyn_cast<Constant>(LHS);
4650 Constant *C1 = dyn_cast<Constant>(RHS);
4651 if (C0 && C1)
4652 return SimplifyRelativeLoad(C0, C1, Q.DL);
4653 return nullptr;
4654 }
Philip Reames5000ba62017-12-27 01:14:30 +00004655 case Intrinsic::powi:
4656 if (ConstantInt *Power = dyn_cast<ConstantInt>(RHS)) {
4657 // powi(x, 0) -> 1.0
4658 if (Power->isZero())
4659 return ConstantFP::get(LHS->getType(), 1.0);
4660 // powi(x, 1) -> x
4661 if (Power->isOne())
4662 return LHS;
4663 }
4664 return nullptr;
Matt Arsenault82606662017-01-11 00:57:54 +00004665 default:
4666 return nullptr;
4667 }
4668 }
4669
4670 // Simplify calls to llvm.masked.load.*
4671 switch (IID) {
4672 case Intrinsic::masked_load: {
4673 Value *MaskArg = ArgBegin[2];
4674 Value *PassthruArg = ArgBegin[3];
4675 // If the mask is all zeros or undef, the "passthru" argument is the result.
4676 if (maskIsAllZeroOrUndef(MaskArg))
4677 return PassthruArg;
4678 return nullptr;
4679 }
4680 default:
4681 return nullptr;
4682 }
Michael Ilseman54857292013-02-07 19:26:05 +00004683}
4684
Chandler Carruth9dc35582012-12-28 11:30:55 +00004685template <typename IterTy>
Andrew Kaylor647025f2017-06-09 23:18:11 +00004686static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
4687 IterTy ArgEnd, const SimplifyQuery &Q,
4688 unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004689 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004690 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4691 Ty = PTy->getElementType();
4692 FunctionType *FTy = cast<FunctionType>(Ty);
4693
Dan Gohman85977e62011-11-04 18:32:42 +00004694 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004695 // call null -> undef
4696 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004697 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004698
Chandler Carruthf6182152012-12-28 14:23:29 +00004699 Function *F = dyn_cast<Function>(V);
4700 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004701 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004702
David Majnemer15032582015-05-22 03:56:46 +00004703 if (F->isIntrinsic())
4704 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004705 return Ret;
4706
Andrew Kaylor647025f2017-06-09 23:18:11 +00004707 if (!canConstantFoldCallTo(CS, F))
Craig Topper9f008862014-04-15 04:59:12 +00004708 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004709
4710 SmallVector<Constant *, 4> ConstantArgs;
4711 ConstantArgs.reserve(ArgEnd - ArgBegin);
4712 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4713 Constant *C = dyn_cast<Constant>(*I);
4714 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004715 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004716 ConstantArgs.push_back(C);
4717 }
4718
Andrew Kaylor647025f2017-06-09 23:18:11 +00004719 return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004720}
4721
Andrew Kaylor647025f2017-06-09 23:18:11 +00004722Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4723 User::op_iterator ArgBegin, User::op_iterator ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004724 const SimplifyQuery &Q) {
Andrew Kaylor647025f2017-06-09 23:18:11 +00004725 return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
4726}
4727
4728Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4729 ArrayRef<Value *> Args, const SimplifyQuery &Q) {
4730 return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004731}
4732
Philip Reames7a6db4f2017-12-27 00:16:12 +00004733Value *llvm::SimplifyCall(ImmutableCallSite ICS, const SimplifyQuery &Q) {
4734 CallSite CS(const_cast<Instruction*>(ICS.getInstruction()));
4735 return ::SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
4736 Q, RecursionLimit);
4737}
4738
Sanjay Patel472cc782016-01-11 22:14:42 +00004739/// See if we can compute a simplified version of this instruction.
4740/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004741
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004742Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004743 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004744 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004745 Value *Result;
4746
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004747 switch (I->getOpcode()) {
4748 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004749 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004750 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004751 case Instruction::FAdd:
4752 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004753 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004754 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004755 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004756 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4757 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004758 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004759 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004760 case Instruction::FSub:
4761 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004762 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004763 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004764 case Instruction::Sub:
4765 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4766 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004767 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004768 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004769 case Instruction::FMul:
4770 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004771 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004772 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004773 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004774 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004775 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004776 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004777 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004778 break;
4779 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004780 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004781 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004782 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004783 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004784 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00004785 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004786 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004787 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004788 break;
4789 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004790 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004791 break;
4792 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004793 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004794 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004795 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004796 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004797 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4798 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004799 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004800 break;
4801 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004802 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004803 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004804 break;
4805 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004806 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004807 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004808 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004809 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004810 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004811 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004812 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004813 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004814 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004815 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004816 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004817 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004818 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004819 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4820 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004821 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004822 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004823 Result =
4824 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4825 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004826 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004827 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004828 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004829 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004830 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004831 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004832 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004833 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004834 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004835 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004836 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004837 case Instruction::InsertValue: {
4838 InsertValueInst *IV = cast<InsertValueInst>(I);
4839 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4840 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004841 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004842 break;
4843 }
Igor Laevskye0edb662017-12-13 11:21:18 +00004844 case Instruction::InsertElement: {
4845 auto *IE = cast<InsertElementInst>(I);
4846 Result = SimplifyInsertElementInst(IE->getOperand(0), IE->getOperand(1),
4847 IE->getOperand(2), Q);
4848 break;
4849 }
David Majnemer25a796e2015-07-13 01:15:46 +00004850 case Instruction::ExtractValue: {
4851 auto *EVI = cast<ExtractValueInst>(I);
4852 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004853 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00004854 break;
4855 }
David Majnemer599ca442015-07-13 01:15:53 +00004856 case Instruction::ExtractElement: {
4857 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004858 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4859 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00004860 break;
4861 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004862 case Instruction::ShuffleVector: {
4863 auto *SVI = cast<ShuffleVectorInst>(I);
4864 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004865 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00004866 break;
4867 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004868 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004869 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004870 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004871 case Instruction::Call: {
4872 CallSite CS(cast<CallInst>(I));
Philip Reames7a6db4f2017-12-27 00:16:12 +00004873 Result = SimplifyCall(CS, Q);
Dan Gohman85977e62011-11-04 18:32:42 +00004874 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004875 }
David Majnemer6774d612016-07-26 17:58:05 +00004876#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4877#include "llvm/IR/Instruction.def"
4878#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004879 Result =
4880 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00004881 break;
Craig Topper81c03a72017-04-12 22:54:24 +00004882 case Instruction::Alloca:
4883 // No simplifications for Alloca and it can't be constant folded.
4884 Result = nullptr;
4885 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004886 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004887
Hal Finkelf2199b22015-10-23 20:37:08 +00004888 // In general, it is possible for computeKnownBits to determine all bits in a
4889 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004890 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Craig Topper8205a1a2017-05-24 16:53:07 +00004891 KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00004892 if (Known.isConstant())
4893 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00004894 }
4895
Duncan Sands64e41cf2010-11-17 08:35:29 +00004896 /// If called on unreachable code, the above logic may report that the
4897 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004898 /// detecting that case here, returning a safe value instead.
4899 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004900}
4901
Sanjay Patelf44bd382016-01-20 18:59:48 +00004902/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004903/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004904///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004905/// This is the common implementation of the recursive simplification routines.
4906/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4907/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4908/// instructions to process and attempt to simplify it using
4909/// InstructionSimplify.
4910///
4911/// This routine returns 'true' only when *it* simplifies something. The passed
4912/// in simplified value does not count toward this.
4913static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004914 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004915 const DominatorTree *DT,
4916 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004917 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004918 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004919 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004920
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004921 // If we have an explicit value to collapse to, do that round of the
4922 // simplification loop by hand initially.
4923 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004924 for (User *U : I->users())
4925 if (U != I)
4926 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004927
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004928 // Replace the instruction with its simplified value.
4929 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004930
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004931 // Gracefully handle edge cases where the instruction is not wired into any
4932 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004933 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4934 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004935 I->eraseFromParent();
4936 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004937 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004938 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004939
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004940 // Note that we must test the size on each iteration, the worklist can grow.
4941 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4942 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004943
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004944 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004945 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004946 if (!SimpleV)
4947 continue;
4948
4949 Simplified = true;
4950
4951 // Stash away all the uses of the old instruction so we can check them for
4952 // recursive simplifications after a RAUW. This is cheaper than checking all
4953 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004954 for (User *U : I->users())
4955 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004956
4957 // Replace the instruction with its simplified value.
4958 I->replaceAllUsesWith(SimpleV);
4959
4960 // Gracefully handle edge cases where the instruction is not wired into any
4961 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004962 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4963 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004964 I->eraseFromParent();
4965 }
4966 return Simplified;
4967}
4968
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004969bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004970 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004971 const DominatorTree *DT,
4972 AssumptionCache *AC) {
4973 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004974}
4975
4976bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004977 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004978 const DominatorTree *DT,
4979 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004980 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4981 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004982 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004983}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004984
4985namespace llvm {
4986const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
4987 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
4988 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
4989 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
4990 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
4991 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
4992 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
4993 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4994}
4995
4996const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
4997 const DataLayout &DL) {
4998 return {DL, &AR.TLI, &AR.DT, &AR.AC};
4999}
5000
5001template <class T, class... TArgs>
5002const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
5003 Function &F) {
5004 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
5005 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
5006 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
5007 return {F.getParent()->getDataLayout(), TLI, DT, AC};
5008}
5009template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
5010 Function &);
5011}