blob: 6a1ec0f84e5decbc461e7b3e877416046186e880 [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"
Chris Lattner084a1b52009-11-09 22:57:59 +000026#include "llvm/Analysis/ConstantFolding.h"
Daniel Berlin4d0fe642017-04-28 19:55:38 +000027#include "llvm/Analysis/LoopAnalysisManager.h"
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +000028#include "llvm/Analysis/MemoryBuiltins.h"
Sanjay Patel54656ca2017-02-06 18:26:06 +000029#include "llvm/Analysis/OptimizationDiagnosticInfo.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.
Eli Friedmanc8cbd062012-03-13 01:06:07 +0000106 if (DT) {
107 if (!DT->isReachableFromEntry(P->getParent()))
108 return true;
109 if (!DT->isReachableFromEntry(I->getParent()))
110 return false;
111 return DT->dominates(I, P);
112 }
Duncan Sands5ffc2982010-11-16 12:16:38 +0000113
David Majnemer8a1c45d2015-12-12 05:38:55 +0000114 // Otherwise, if the instruction is in the entry block and is not an invoke,
115 // then it obviously dominates all phi nodes.
Duncan Sands5ffc2982010-11-16 12:16:38 +0000116 if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
David Majnemer8a1c45d2015-12-12 05:38:55 +0000117 !isa<InvokeInst>(I))
Duncan Sands5ffc2982010-11-16 12:16:38 +0000118 return true;
119
120 return false;
121}
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000122
Sanjay Patel472cc782016-01-11 22:14:42 +0000123/// Simplify "A op (B op' C)" by distributing op over op', turning it into
124/// "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000125/// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
126/// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
127/// Returns the simplified value, or null if no simplification was performed.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000128static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000129 Instruction::BinaryOps OpcodeToExpand, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +0000130 unsigned MaxRecurse) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000131 // Recursion is always used, so bail out at once if we already hit the limit.
132 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000133 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000134
135 // Check whether the expression has the form "(A op' B) op C".
136 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
137 if (Op0->getOpcode() == OpcodeToExpand) {
138 // It does! Try turning it into "(A op C) op' (B op C)".
139 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
140 // Do "A op C" and "B op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000141 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
142 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000143 // They do! Return "L op' R" if it simplifies or is already available.
144 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000145 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
146 && L == B && R == A)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000147 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000148 return LHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000149 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000150 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000151 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000152 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000153 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000154 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000155 }
156 }
157
158 // Check whether the expression has the form "A op (B op' C)".
159 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
160 if (Op1->getOpcode() == OpcodeToExpand) {
161 // It does! Try turning it into "(A op B) op' (A op C)".
162 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
163 // Do "A op B" and "A op C" both simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000164 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
165 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000166 // They do! Return "L op' R" if it simplifies or is already available.
167 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000168 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
169 && L == C && R == B)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000170 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000171 return RHS;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000172 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000173 // Otherwise return "L op' R" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000174 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000175 ++NumExpand;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000176 return V;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000177 }
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000178 }
179 }
180
Craig Topper9f008862014-04-15 04:59:12 +0000181 return nullptr;
Duncan Sandsee3ec6e2010-12-21 13:32:22 +0000182}
183
Sanjay Patel472cc782016-01-11 22:14:42 +0000184/// Generic simplifications for associative binary operations.
185/// Returns the simpler value, or null if none was found.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000186static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000187 Value *LHS, Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000188 unsigned MaxRecurse) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000189 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
190
191 // Recursion is always used, so bail out at once if we already hit the limit.
192 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000193 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000194
195 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
196 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
197
198 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
199 if (Op0 && Op0->getOpcode() == Opcode) {
200 Value *A = Op0->getOperand(0);
201 Value *B = Op0->getOperand(1);
202 Value *C = RHS;
203
204 // Does "B op C" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000205 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000206 // It does! Return "A op V" if it simplifies or is already available.
207 // If V equals B then "A op V" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000208 if (V == B) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000209 // Otherwise return "A op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000210 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000211 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000212 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000213 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000214 }
215 }
216
217 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
218 if (Op1 && Op1->getOpcode() == Opcode) {
219 Value *A = LHS;
220 Value *B = Op1->getOperand(0);
221 Value *C = Op1->getOperand(1);
222
223 // Does "A op B" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000224 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000225 // It does! Return "V op C" if it simplifies or is already available.
226 // If V equals B then "V op C" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000227 if (V == B) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000228 // Otherwise return "V op C" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000229 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000230 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000231 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000232 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000233 }
234 }
235
236 // The remaining transforms require commutativity as well as associativity.
237 if (!Instruction::isCommutative(Opcode))
Craig Topper9f008862014-04-15 04:59:12 +0000238 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000239
240 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
241 if (Op0 && Op0->getOpcode() == Opcode) {
242 Value *A = Op0->getOperand(0);
243 Value *B = Op0->getOperand(1);
244 Value *C = RHS;
245
246 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000247 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000248 // It does! Return "V op B" if it simplifies or is already available.
249 // If V equals A then "V op B" is just the LHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000250 if (V == A) return LHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000251 // Otherwise return "V op B" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000252 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000253 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000254 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000255 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000256 }
257 }
258
259 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
260 if (Op1 && Op1->getOpcode() == Opcode) {
261 Value *A = LHS;
262 Value *B = Op1->getOperand(0);
263 Value *C = Op1->getOperand(1);
264
265 // Does "C op A" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000266 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000267 // It does! Return "B op V" if it simplifies or is already available.
268 // If V equals C then "B op V" is just the RHS.
Duncan Sands772749a2011-01-01 20:08:02 +0000269 if (V == C) return RHS;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000270 // Otherwise return "B op V" if it simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000271 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
Duncan Sands3547d2e2010-12-22 09:40:51 +0000272 ++NumReassoc;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000273 return W;
Duncan Sands3547d2e2010-12-22 09:40:51 +0000274 }
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000275 }
276 }
277
Craig Topper9f008862014-04-15 04:59:12 +0000278 return nullptr;
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000279}
280
Sanjay Patel472cc782016-01-11 22:14:42 +0000281/// In the case of a binary operation with a select instruction as an operand,
282/// try to simplify the binop by seeing whether evaluating it on both branches
283/// of the select results in the same value. Returns the common value if so,
284/// otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000285static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000286 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000287 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000288 // Recursion is always used, so bail out at once if we already hit the limit.
289 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000290 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000291
Duncan Sandsb0579e92010-11-10 13:00:08 +0000292 SelectInst *SI;
293 if (isa<SelectInst>(LHS)) {
294 SI = cast<SelectInst>(LHS);
295 } else {
296 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
297 SI = cast<SelectInst>(RHS);
298 }
299
300 // Evaluate the BinOp on the true and false branches of the select.
301 Value *TV;
302 Value *FV;
303 if (SI == LHS) {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000304 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
305 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000306 } else {
Duncan Sandsb8cee002012-03-13 11:42:19 +0000307 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
308 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
Duncan Sandsb0579e92010-11-10 13:00:08 +0000309 }
310
Duncan Sandse3c53952011-01-01 16:12:09 +0000311 // If they simplified to the same value, then return the common value.
Duncan Sands772749a2011-01-01 20:08:02 +0000312 // If they both failed to simplify then return null.
313 if (TV == FV)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000314 return TV;
315
316 // If one branch simplified to undef, return the other one.
317 if (TV && isa<UndefValue>(TV))
318 return FV;
319 if (FV && isa<UndefValue>(FV))
320 return TV;
321
322 // If applying the operation did not change the true and false select values,
323 // then the result of the binop is the select itself.
Duncan Sands772749a2011-01-01 20:08:02 +0000324 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
Duncan Sandsb0579e92010-11-10 13:00:08 +0000325 return SI;
326
327 // If one branch simplified and the other did not, and the simplified
328 // value is equal to the unsimplified one, return the simplified value.
329 // For example, select (cond, X, X & Z) & Z -> X & Z.
330 if ((FV && !TV) || (TV && !FV)) {
331 // Check that the simplified value has the form "X op Y" where "op" is the
332 // same as the original operation.
333 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
334 if (Simplified && Simplified->getOpcode() == Opcode) {
335 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
336 // We already know that "op" is the same as for the simplified value. See
337 // if the operands match too. If so, return the simplified value.
338 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
339 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
340 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
Duncan Sands772749a2011-01-01 20:08:02 +0000341 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
342 Simplified->getOperand(1) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000343 return Simplified;
344 if (Simplified->isCommutative() &&
Duncan Sands772749a2011-01-01 20:08:02 +0000345 Simplified->getOperand(1) == UnsimplifiedLHS &&
346 Simplified->getOperand(0) == UnsimplifiedRHS)
Duncan Sandsb0579e92010-11-10 13:00:08 +0000347 return Simplified;
348 }
349 }
350
Craig Topper9f008862014-04-15 04:59:12 +0000351 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000352}
353
Sanjay Patel472cc782016-01-11 22:14:42 +0000354/// In the case of a comparison with a select instruction, try to simplify the
355/// comparison by seeing whether both branches of the select result in the same
356/// value. Returns the common value if so, otherwise returns null.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000357static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000358 Value *RHS, const SimplifyQuery &Q,
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000359 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000360 // Recursion is always used, so bail out at once if we already hit the limit.
361 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000362 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000363
Duncan Sandsb0579e92010-11-10 13:00:08 +0000364 // Make sure the select is on the LHS.
365 if (!isa<SelectInst>(LHS)) {
366 std::swap(LHS, RHS);
367 Pred = CmpInst::getSwappedPredicate(Pred);
368 }
369 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
370 SelectInst *SI = cast<SelectInst>(LHS);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000371 Value *Cond = SI->getCondition();
372 Value *TV = SI->getTrueValue();
373 Value *FV = SI->getFalseValue();
Duncan Sandsb0579e92010-11-10 13:00:08 +0000374
Duncan Sands06504022011-02-03 09:37:39 +0000375 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
Duncan Sandsb0579e92010-11-10 13:00:08 +0000376 // Does "cmp TV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000377 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000378 if (TCmp == Cond) {
379 // It not only simplified, it simplified to the select condition. Replace
380 // it with 'true'.
381 TCmp = getTrue(Cond->getType());
382 } else if (!TCmp) {
383 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
384 // condition then we can replace it with 'true'. Otherwise give up.
385 if (!isSameCompare(Cond, Pred, TV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000386 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000387 TCmp = getTrue(Cond->getType());
Duncan Sands06504022011-02-03 09:37:39 +0000388 }
389
Duncan Sands3d5692a2011-10-30 19:56:36 +0000390 // Does "cmp FV, RHS" simplify?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000391 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
Duncan Sands3d5692a2011-10-30 19:56:36 +0000392 if (FCmp == Cond) {
393 // It not only simplified, it simplified to the select condition. Replace
394 // it with 'false'.
395 FCmp = getFalse(Cond->getType());
396 } else if (!FCmp) {
397 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
398 // condition then we can replace it with 'false'. Otherwise give up.
399 if (!isSameCompare(Cond, Pred, FV, RHS))
Craig Topper9f008862014-04-15 04:59:12 +0000400 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000401 FCmp = getFalse(Cond->getType());
402 }
403
404 // If both sides simplified to the same value, then use it as the result of
405 // the original comparison.
406 if (TCmp == FCmp)
407 return TCmp;
Duncan Sands26641d72012-02-10 14:31:24 +0000408
409 // The remaining cases only make sense if the select condition has the same
410 // type as the result of the comparison, so bail out if this is not so.
411 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
Craig Topper9f008862014-04-15 04:59:12 +0000412 return nullptr;
Duncan Sands3d5692a2011-10-30 19:56:36 +0000413 // If the false value simplified to false, then the result of the compare
414 // is equal to "Cond && TCmp". This also catches the case when the false
415 // value simplified to false and the true value to true, returning "Cond".
416 if (match(FCmp, m_Zero()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000417 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000418 return V;
419 // If the true value simplified to true, then the result of the compare
420 // is equal to "Cond || FCmp".
421 if (match(TCmp, m_One()))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000422 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000423 return V;
424 // Finally, if the false value simplified to true and the true value to
425 // false, then the result of the compare is equal to "!Cond".
426 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
427 if (Value *V =
428 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
Duncan Sandsb8cee002012-03-13 11:42:19 +0000429 Q, MaxRecurse))
Duncan Sands3d5692a2011-10-30 19:56:36 +0000430 return V;
431
Craig Topper9f008862014-04-15 04:59:12 +0000432 return nullptr;
Duncan Sandsb0579e92010-11-10 13:00:08 +0000433}
434
Sanjay Patel472cc782016-01-11 22:14:42 +0000435/// In the case of a binary operation with an operand that is a PHI instruction,
436/// try to simplify the binop by seeing whether evaluating it on the incoming
437/// phi values yields the same result for every value. If so returns the common
438/// value, otherwise returns null.
Craig Topper60dd9cd2017-04-07 05:57:51 +0000439static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000440 Value *RHS, const SimplifyQuery &Q,
Craig Topper60dd9cd2017-04-07 05:57:51 +0000441 unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000442 // Recursion is always used, so bail out at once if we already hit the limit.
443 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000444 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000445
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000446 PHINode *PI;
447 if (isa<PHINode>(LHS)) {
448 PI = cast<PHINode>(LHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000449 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000450 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000451 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000452 } else {
453 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
454 PI = cast<PHINode>(RHS);
Duncan Sands5ffc2982010-11-16 12:16:38 +0000455 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000456 if (!ValueDominatesPHI(LHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000457 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000458 }
459
460 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000461 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000462 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000463 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000464 if (Incoming == PI) continue;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000465 Value *V = PI == LHS ?
Duncan Sandsb8cee002012-03-13 11:42:19 +0000466 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
467 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000468 // If the operation failed to simplify, or simplified to a different value
469 // to previously, then give up.
470 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000471 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000472 CommonValue = V;
473 }
474
475 return CommonValue;
476}
477
Sanjay Patel472cc782016-01-11 22:14:42 +0000478/// In the case of a comparison with a PHI instruction, try to simplify the
479/// comparison by seeing whether comparing with all of the incoming phi values
480/// yields the same result every time. If so returns the common result,
481/// otherwise returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000482static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000483 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf64e6902010-12-21 09:09:15 +0000484 // Recursion is always used, so bail out at once if we already hit the limit.
485 if (!MaxRecurse--)
Craig Topper9f008862014-04-15 04:59:12 +0000486 return nullptr;
Duncan Sandsf64e6902010-12-21 09:09:15 +0000487
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000488 // Make sure the phi is on the LHS.
489 if (!isa<PHINode>(LHS)) {
490 std::swap(LHS, RHS);
491 Pred = CmpInst::getSwappedPredicate(Pred);
492 }
493 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
494 PHINode *PI = cast<PHINode>(LHS);
495
Duncan Sands5ffc2982010-11-16 12:16:38 +0000496 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000497 if (!ValueDominatesPHI(RHS, PI, Q.DT))
Craig Topper9f008862014-04-15 04:59:12 +0000498 return nullptr;
Duncan Sands5ffc2982010-11-16 12:16:38 +0000499
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000500 // Evaluate the BinOp on the incoming phi values.
Craig Topper9f008862014-04-15 04:59:12 +0000501 Value *CommonValue = nullptr;
Pete Cooper833f34d2015-05-12 20:05:31 +0000502 for (Value *Incoming : PI->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +0000503 // If the incoming value is the phi node itself, it can safely be skipped.
Duncan Sandsf12ba1d2010-11-15 17:52:45 +0000504 if (Incoming == PI) continue;
Duncan Sandsb8cee002012-03-13 11:42:19 +0000505 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000506 // If the operation failed to simplify, or simplified to a different value
507 // to previously, then give up.
508 if (!V || (CommonValue && V != CommonValue))
Craig Topper9f008862014-04-15 04:59:12 +0000509 return nullptr;
Duncan Sandsf3b1bf12010-11-10 18:23:01 +0000510 CommonValue = V;
511 }
512
513 return CommonValue;
514}
515
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000516static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
517 Value *&Op0, Value *&Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000518 const SimplifyQuery &Q) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000519 if (auto *CLHS = dyn_cast<Constant>(Op0)) {
520 if (auto *CRHS = dyn_cast<Constant>(Op1))
521 return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
522
523 // Canonicalize the constant to the RHS if this is a commutative operation.
524 if (Instruction::isCommutative(Opcode))
525 std::swap(Op0, Op1);
526 }
527 return nullptr;
528}
529
Sanjay Patel472cc782016-01-11 22:14:42 +0000530/// Given operands for an Add, see if we can fold the result.
531/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000532static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000533 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000534 if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
535 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +0000536
Duncan Sands0a2c41682010-12-15 14:07:39 +0000537 // X + undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000538 if (match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000539 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +0000540
Duncan Sands0a2c41682010-12-15 14:07:39 +0000541 // X + 0 -> X
542 if (match(Op1, m_Zero()))
543 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +0000544
Duncan Sands0a2c41682010-12-15 14:07:39 +0000545 // X + (Y - X) -> Y
546 // (Y - X) + X -> Y
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000547 // Eg: X + -X -> 0
Craig Topper9f008862014-04-15 04:59:12 +0000548 Value *Y = nullptr;
Duncan Sands772749a2011-01-01 20:08:02 +0000549 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
550 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000551 return Y;
552
553 // X + ~X -> -1 since ~X = -X-1
Sanjay Patelfe672552017-02-18 21:59:09 +0000554 Type *Ty = Op0->getType();
Duncan Sands772749a2011-01-01 20:08:02 +0000555 if (match(Op0, m_Not(m_Specific(Op1))) ||
556 match(Op1, m_Not(m_Specific(Op0))))
Sanjay Patelfe672552017-02-18 21:59:09 +0000557 return Constant::getAllOnesValue(Ty);
558
Craig Topperbcfd2d12017-04-20 16:56:25 +0000559 // add nsw/nuw (xor Y, signmask), signmask --> Y
Sanjay Patelfe672552017-02-18 21:59:09 +0000560 // The no-wrapping add guarantees that the top bit will be set by the add.
561 // Therefore, the xor must be clearing the already set sign bit of Y.
Craig Topperbcfd2d12017-04-20 16:56:25 +0000562 if ((isNSW || isNUW) && match(Op1, m_SignMask()) &&
563 match(Op0, m_Xor(m_Value(Y), m_SignMask())))
Sanjay Patelfe672552017-02-18 21:59:09 +0000564 return Y;
Duncan Sandsb238de02010-11-19 09:20:39 +0000565
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000566 /// i1 add -> xor.
Craig Topperaa5f5242017-04-06 05:28:41 +0000567 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000568 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000569 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000570
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000571 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000572 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
Duncan Sands6c7a52c2010-12-21 08:49:00 +0000573 MaxRecurse))
574 return V;
575
Duncan Sandsb238de02010-11-19 09:20:39 +0000576 // Threading Add over selects and phi nodes is pointless, so don't bother.
577 // Threading over the select in "A + select(cond, B, C)" means evaluating
578 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
579 // only if B and C are equal. If B and C are equal then (since we assume
580 // that operands have already been simplified) "select(cond, B, C)" should
581 // have been simplified to the common value of B and C already. Analysing
582 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
583 // for threading over phi nodes.
584
Craig Topper9f008862014-04-15 04:59:12 +0000585 return nullptr;
Chris Lattner3d9823b2009-11-27 17:42:22 +0000586}
587
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000588Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000589 const SimplifyQuery &Query) {
590 return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, Query, RecursionLimit);
591}
592
Chandler Carrutha0796552012-03-12 11:19:31 +0000593/// \brief Compute the base pointer and cumulative constant offsets for V.
594///
595/// This strips all constant offsets off of V, leaving it the base pointer, and
596/// accumulates the total constant offset applied in the returned constant. It
597/// returns 0 if V is not a pointer, and returns the constant '0' if there are
598/// no constant offsets applied.
Dan Gohman36fa8392013-01-31 02:45:26 +0000599///
600/// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
601/// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
602/// folding.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000603static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000604 bool AllowNonInbounds = false) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000605 assert(V->getType()->getScalarType()->isPointerTy());
Chandler Carrutha0796552012-03-12 11:19:31 +0000606
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000607 Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000608 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
Chandler Carrutha0796552012-03-12 11:19:31 +0000609
610 // Even though we don't look through PHI nodes, we could be called on an
611 // instruction in an unreachable block, which may be on a cycle.
612 SmallPtrSet<Value *, 4> Visited;
613 Visited.insert(V);
614 do {
615 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Benjamin Kramer942dfe62013-09-23 14:16:38 +0000616 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000617 !GEP->accumulateConstantOffset(DL, Offset))
Chandler Carrutha0796552012-03-12 11:19:31 +0000618 break;
Chandler Carrutha0796552012-03-12 11:19:31 +0000619 V = GEP->getPointerOperand();
620 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
Matt Arsenault2f9cce22013-08-03 01:03:12 +0000621 V = cast<Operator>(V)->getOperand(0);
Chandler Carrutha0796552012-03-12 11:19:31 +0000622 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000623 if (GA->isInterposable())
Chandler Carrutha0796552012-03-12 11:19:31 +0000624 break;
625 V = GA->getAliasee();
626 } else {
Hal Finkel2cac58f2016-07-11 03:37:59 +0000627 if (auto CS = CallSite(V))
628 if (Value *RV = CS.getReturnedArgOperand()) {
629 V = RV;
630 continue;
631 }
Chandler Carrutha0796552012-03-12 11:19:31 +0000632 break;
633 }
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000634 assert(V->getType()->getScalarType()->isPointerTy() &&
635 "Unexpected operand type!");
David Blaikie70573dc2014-11-19 07:49:26 +0000636 } while (Visited.insert(V).second);
Chandler Carrutha0796552012-03-12 11:19:31 +0000637
Benjamin Kramerc05aa952013-02-01 15:21:10 +0000638 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
639 if (V->getType()->isVectorTy())
640 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
641 OffsetIntPtr);
642 return OffsetIntPtr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000643}
644
645/// \brief Compute the constant difference between two pointer values.
646/// If the difference is not a constant, returns zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000647static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
648 Value *RHS) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000649 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
650 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carrutha0796552012-03-12 11:19:31 +0000651
652 // If LHS and RHS are not related via constant offsets to the same base
653 // value, there is nothing we can do here.
654 if (LHS != RHS)
Craig Topper9f008862014-04-15 04:59:12 +0000655 return nullptr;
Chandler Carrutha0796552012-03-12 11:19:31 +0000656
657 // Otherwise, the difference of LHS - RHS can be computed as:
658 // LHS - RHS
659 // = (LHSOffset + Base) - (RHSOffset + Base)
660 // = LHSOffset - RHSOffset
661 return ConstantExpr::getSub(LHSOffset, RHSOffset);
662}
663
Sanjay Patel472cc782016-01-11 22:14:42 +0000664/// Given operands for a Sub, see if we can fold the result.
665/// If not, this returns null.
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000666static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000667 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000668 if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
669 return C;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000670
671 // X - undef -> undef
672 // undef - X -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000673 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
Duncan Sands0a2c41682010-12-15 14:07:39 +0000674 return UndefValue::get(Op0->getType());
675
676 // X - 0 -> X
677 if (match(Op1, m_Zero()))
678 return Op0;
679
680 // X - X -> 0
Duncan Sands772749a2011-01-01 20:08:02 +0000681 if (Op0 == Op1)
Duncan Sands0a2c41682010-12-15 14:07:39 +0000682 return Constant::getNullValue(Op0->getType());
683
Sanjay Patelefd88852016-10-19 21:23:45 +0000684 // Is this a negation?
685 if (match(Op0, m_Zero())) {
686 // 0 - X -> 0 if the sub is NUW.
687 if (isNUW)
688 return Op0;
689
690 unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +0000691 KnownBits Known(BitWidth);
692 computeKnownBits(Op1, Known, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
693 if (Known.Zero.isMaxSignedValue()) {
Sanjay Patelefd88852016-10-19 21:23:45 +0000694 // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
695 // Op1 must be 0 because negating the minimum signed value is undefined.
696 if (isNSW)
697 return Op0;
698
699 // 0 - X -> X if X is 0 or the minimum signed value.
700 return Op1;
701 }
702 }
David Majnemercd4fbcd2014-07-31 04:49:18 +0000703
Duncan Sands99589d02011-01-18 11:50:19 +0000704 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
705 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
Dinesh Dwivedi99281a02014-06-26 08:57:33 +0000706 Value *X = nullptr, *Y = nullptr, *Z = Op1;
Duncan Sands99589d02011-01-18 11:50:19 +0000707 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
708 // See if "V === Y - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000709 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000710 // It does! Now see if "X + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000711 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000712 // It does, we successfully reassociated!
713 ++NumReassoc;
714 return W;
715 }
716 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000717 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000718 // It does! Now see if "Y + V" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000719 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000720 // It does, we successfully reassociated!
721 ++NumReassoc;
722 return W;
723 }
724 }
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000725
Duncan Sands99589d02011-01-18 11:50:19 +0000726 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
727 // For example, X - (X + 1) -> -1
728 X = Op0;
729 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
730 // See if "V === X - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000731 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000732 // It does! Now see if "V - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000733 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000734 // It does, we successfully reassociated!
735 ++NumReassoc;
736 return W;
737 }
738 // See if "V === X - Z" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000739 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000740 // It does! Now see if "V - Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000741 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
Duncan Sands99589d02011-01-18 11:50:19 +0000742 // It does, we successfully reassociated!
743 ++NumReassoc;
744 return W;
745 }
746 }
747
748 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
749 // For example, X - (X - Y) -> Y.
750 Z = Op0;
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000751 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
752 // See if "V === Z - X" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000753 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000754 // It does! Now see if "V + Y" simplifies.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000755 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
Duncan Sandsd6f1a952011-01-14 15:26:10 +0000756 // It does, we successfully reassociated!
757 ++NumReassoc;
758 return W;
759 }
760
Duncan Sands395ac42d2012-03-13 14:07:05 +0000761 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
762 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
763 match(Op1, m_Trunc(m_Value(Y))))
764 if (X->getType() == Y->getType())
765 // See if "V === X - Y" simplifies.
766 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
767 // It does! Now see if "trunc V" simplifies.
David Majnemer6774d612016-07-26 17:58:05 +0000768 if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
769 Q, MaxRecurse - 1))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000770 // It does, return the simplified "trunc V".
771 return W;
772
773 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
Dan Gohman18c77a12013-01-31 02:50:36 +0000774 if (match(Op0, m_PtrToInt(m_Value(X))) &&
Duncan Sands395ac42d2012-03-13 14:07:05 +0000775 match(Op1, m_PtrToInt(m_Value(Y))))
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000776 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
Duncan Sands395ac42d2012-03-13 14:07:05 +0000777 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
778
Duncan Sands99589d02011-01-18 11:50:19 +0000779 // i1 sub -> xor.
Craig Topperaa5f5242017-04-06 05:28:41 +0000780 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000781 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sands99589d02011-01-18 11:50:19 +0000782 return V;
783
Duncan Sands0a2c41682010-12-15 14:07:39 +0000784 // Threading Sub over selects and phi nodes is pointless, so don't bother.
785 // Threading over the select in "A - select(cond, B, C)" means evaluating
786 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
787 // only if B and C are equal. If B and C are equal then (since we assume
788 // that operands have already been simplified) "select(cond, B, C)" should
789 // have been simplified to the common value of B and C already. Analysing
790 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
791 // for threading over phi nodes.
792
Craig Topper9f008862014-04-15 04:59:12 +0000793 return nullptr;
Duncan Sands0a2c41682010-12-15 14:07:39 +0000794}
795
Duncan Sandsed6d6c32010-12-20 14:47:04 +0000796Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000797 const SimplifyQuery &Q) {
798 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
799}
800
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000801/// Given operands for an FAdd, see if we can fold the result. If not, this
802/// returns null.
803static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000804 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000805 if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
806 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000807
808 // fadd X, -0 ==> X
809 if (match(Op1, m_NegZero()))
810 return Op0;
811
812 // fadd X, 0 ==> X, when we know X is not -0
813 if (match(Op1, m_Zero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000814 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000815 return Op0;
816
817 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
818 // where nnan and ninf have to occur at least once somewhere in this
819 // expression
Craig Topper9f008862014-04-15 04:59:12 +0000820 Value *SubOp = nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000821 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
822 SubOp = Op1;
823 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
824 SubOp = Op0;
825 if (SubOp) {
826 Instruction *FSub = cast<Instruction>(SubOp);
827 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
828 (FMF.noInfs() || FSub->hasNoInfs()))
829 return Constant::getNullValue(Op0->getType());
830 }
831
Craig Topper9f008862014-04-15 04:59:12 +0000832 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000833}
834
835/// Given operands for an FSub, see if we can fold the result. If not, this
836/// returns null.
837static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000838 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000839 if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
840 return C;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000841
842 // fsub X, 0 ==> X
843 if (match(Op1, m_Zero()))
844 return Op0;
845
846 // fsub X, -0 ==> X, when we know X is not -0
847 if (match(Op1, m_NegZero()) &&
David Majnemer3ee5f342016-04-13 06:55:52 +0000848 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000849 return Op0;
850
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000851 // fsub -0.0, (fsub -0.0, X) ==> X
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000852 Value *X;
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000853 if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
854 return X;
855
856 // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
Benjamin Kramer6bb15022016-02-29 12:18:25 +0000857 if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
Benjamin Kramerf5b2a472016-02-29 11:12:23 +0000858 match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
859 return X;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000860
Benjamin Kramer228680d2015-06-14 21:01:20 +0000861 // fsub nnan x, x ==> 0.0
862 if (FMF.noNaNs() && Op0 == Op1)
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000863 return Constant::getNullValue(Op0->getType());
864
Craig Topper9f008862014-04-15 04:59:12 +0000865 return nullptr;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000866}
867
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000868/// Given the operands for an FMul, see if we can fold the result
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000869static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000870 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000871 if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
872 return C;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000873
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000874 // fmul X, 1.0 ==> X
875 if (match(Op1, m_FPOne()))
876 return Op0;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000877
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000878 // fmul nnan nsz X, 0 ==> 0
879 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
880 return Op1;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000881
Sanjay Patel1fd16f02017-04-01 18:40:30 +0000882 return nullptr;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +0000883}
884
Sanjay Patel472cc782016-01-11 22:14:42 +0000885/// Given operands for a Mul, see if we can fold the result.
886/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000887static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000888 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +0000889 if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
890 return C;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000891
892 // X * undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +0000893 if (match(Op1, m_Undef()))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000894 return Constant::getNullValue(Op0->getType());
895
896 // X * 0 -> 0
897 if (match(Op1, m_Zero()))
898 return Op1;
899
900 // X * 1 -> X
901 if (match(Op1, m_One()))
902 return Op0;
903
Duncan Sandsb67edc62011-01-30 18:03:50 +0000904 // (X / Y) * Y -> X if the division is exact.
Craig Topper9f008862014-04-15 04:59:12 +0000905 Value *X = nullptr;
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000906 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
907 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
908 return X;
Duncan Sandsb67edc62011-01-30 18:03:50 +0000909
Nick Lewyckyb89d9a42011-01-29 19:55:23 +0000910 // i1 mul -> and.
Craig Topper2f1e1c32017-04-06 17:33:37 +0000911 if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000912 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
Duncan Sandsfecc6422010-12-21 15:03:43 +0000913 return V;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000914
915 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +0000916 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000917 MaxRecurse))
918 return V;
919
920 // Mul distributes over Add. Try some generic simplifications based on this.
921 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
Duncan Sandsb8cee002012-03-13 11:42:19 +0000922 Q, MaxRecurse))
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000923 return V;
924
925 // If the operation is with the result of a select instruction, check whether
926 // operating on either branch of the select always yields the same value.
927 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000928 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000929 MaxRecurse))
930 return V;
931
932 // If the operation is with the result of a phi instruction, check whether
933 // operating on all incoming values of the phi always yields the same value.
934 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +0000935 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000936 MaxRecurse))
937 return V;
938
Craig Topper9f008862014-04-15 04:59:12 +0000939 return nullptr;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +0000940}
941
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000942Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000943 const SimplifyQuery &Q) {
944 return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
945}
946
Michael Ilsemanbb6f6912012-12-12 00:27:46 +0000947
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000948Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
949 const SimplifyQuery &Q) {
950 return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
951}
952
Chandler Carruth66b31302015-01-04 12:03:27 +0000953Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000954 const SimplifyQuery &Q) {
955 return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
956}
957
Daniel Berlin5e3fcb12017-04-26 04:09:56 +0000958Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
959 return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
960}
961
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000962/// Check for common or similar folds of integer division or integer remainder.
963static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
964 Type *Ty = Op0->getType();
965
966 // X / undef -> undef
967 // X % undef -> undef
968 if (match(Op1, m_Undef()))
969 return Op1;
970
971 // X / 0 -> undef
972 // X % 0 -> undef
973 // We don't need to preserve faults!
974 if (match(Op1, m_Zero()))
975 return UndefValue::get(Ty);
976
Sanjay Patel2b1f6f42017-03-09 16:20:52 +0000977 // If any element of a constant divisor vector is zero, the whole op is undef.
978 auto *Op1C = dyn_cast<Constant>(Op1);
979 if (Op1C && Ty->isVectorTy()) {
980 unsigned NumElts = Ty->getVectorNumElements();
981 for (unsigned i = 0; i != NumElts; ++i) {
982 Constant *Elt = Op1C->getAggregateElement(i);
983 if (Elt && Elt->isNullValue())
984 return UndefValue::get(Ty);
985 }
986 }
987
Sanjay Patel0cb2ee92017-03-06 19:08:35 +0000988 // undef / X -> 0
989 // undef % X -> 0
990 if (match(Op0, m_Undef()))
991 return Constant::getNullValue(Ty);
992
993 // 0 / X -> 0
994 // 0 % X -> 0
995 if (match(Op0, m_Zero()))
996 return Op0;
997
998 // X / X -> 1
999 // X % X -> 0
1000 if (Op0 == Op1)
1001 return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
1002
1003 // X / 1 -> X
1004 // X % 1 -> 0
Sanjay Patel962a8432017-03-09 21:56:03 +00001005 // If this is a boolean op (single-bit element type), we can't have
1006 // division-by-zero or remainder-by-zero, so assume the divisor is 1.
1007 if (match(Op1, m_One()) || Ty->getScalarType()->isIntegerTy(1))
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001008 return IsDiv ? Op0 : Constant::getNullValue(Ty);
1009
1010 return nullptr;
1011}
1012
Sanjay Patel472cc782016-01-11 22:14:42 +00001013/// Given operands for an SDiv or UDiv, see if we can fold the result.
1014/// If not, this returns null.
Anders Carlsson36c6d232011-02-05 18:33:43 +00001015static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001016 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001017 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1018 return C;
Duncan Sands771e82a2011-01-28 16:51:11 +00001019
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001020 if (Value *V = simplifyDivRem(Op0, Op1, true))
1021 return V;
1022
Duncan Sands65995fa2011-01-28 18:50:50 +00001023 bool isSigned = Opcode == Instruction::SDiv;
1024
Duncan Sands771e82a2011-01-28 16:51:11 +00001025 // (X * Y) / Y -> X if the multiplication does not overflow.
Craig Topper9f008862014-04-15 04:59:12 +00001026 Value *X = nullptr, *Y = nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001027 if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1028 if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
Duncan Sands7cb61e52011-10-27 19:16:21 +00001029 OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
Duncan Sands5747aba2011-02-02 20:52:00 +00001030 // If the Mul knows it does not overflow, then we are good to go.
1031 if ((isSigned && Mul->hasNoSignedWrap()) ||
1032 (!isSigned && Mul->hasNoUnsignedWrap()))
1033 return X;
Duncan Sands771e82a2011-01-28 16:51:11 +00001034 // If X has the form X = A / Y then X * Y cannot overflow.
1035 if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1036 if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1037 return X;
1038 }
1039
Duncan Sands65995fa2011-01-28 18:50:50 +00001040 // (X rem Y) / Y -> 0
1041 if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1042 (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1043 return Constant::getNullValue(Op0->getType());
1044
David Majnemercb9d5962014-10-11 10:20:01 +00001045 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1046 ConstantInt *C1, *C2;
1047 if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1048 match(Op1, m_ConstantInt(C2))) {
1049 bool Overflow;
Craig Topper9b71a402017-04-19 21:09:45 +00001050 (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
David Majnemercb9d5962014-10-11 10:20:01 +00001051 if (Overflow)
1052 return Constant::getNullValue(Op0->getType());
1053 }
1054
Duncan Sands65995fa2011-01-28 18:50:50 +00001055 // If the operation is with the result of a select instruction, check whether
1056 // operating on either branch of the select always yields the same value.
1057 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001058 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001059 return V;
1060
1061 // If the operation is with the result of a phi instruction, check whether
1062 // operating on all incoming values of the phi always yields the same value.
1063 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001064 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands65995fa2011-01-28 18:50:50 +00001065 return V;
1066
Craig Topper9f008862014-04-15 04:59:12 +00001067 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001068}
1069
Sanjay Patel472cc782016-01-11 22:14:42 +00001070/// Given operands for an SDiv, see if we can fold the result.
1071/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001072static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001073 unsigned MaxRecurse) {
1074 if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001075 return V;
1076
Craig Topper9f008862014-04-15 04:59:12 +00001077 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001078}
1079
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001080Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1081 return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1082}
1083
Sanjay Patel472cc782016-01-11 22:14:42 +00001084/// Given operands for a UDiv, see if we can fold the result.
1085/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001086static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001087 unsigned MaxRecurse) {
1088 if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
Duncan Sands771e82a2011-01-28 16:51:11 +00001089 return V;
1090
David Majnemer63da0c22017-01-06 22:58:02 +00001091 // udiv %V, C -> 0 if %V < C
1092 if (MaxRecurse) {
1093 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1094 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1095 if (C->isAllOnesValue()) {
1096 return Constant::getNullValue(Op0->getType());
1097 }
1098 }
1099 }
1100
Craig Topper9f008862014-04-15 04:59:12 +00001101 return nullptr;
Duncan Sands771e82a2011-01-28 16:51:11 +00001102}
1103
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001104Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1105 return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1106}
1107
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001108static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001109 const SimplifyQuery &Q, unsigned) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001110 if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
1111 return C;
1112
Frits van Bommelc2549662011-01-29 15:26:31 +00001113 // undef / X -> undef (the undef could be a snan).
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001114 if (match(Op0, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001115 return Op0;
1116
1117 // X / undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001118 if (match(Op1, m_Undef()))
Frits van Bommelc2549662011-01-29 15:26:31 +00001119 return Op1;
1120
Zia Ansari394cef82016-12-08 23:27:40 +00001121 // X / 1.0 -> X
1122 if (match(Op1, m_FPOne()))
1123 return Op0;
1124
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001125 // 0 / X -> 0
1126 // Requires that NaNs are off (X could be zero) and signed zeroes are
1127 // ignored (X could be positive or negative, so the output sign is unknown).
1128 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1129 return Op0;
1130
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001131 if (FMF.noNaNs()) {
1132 // X / X -> 1.0 is legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001133 if (Op0 == Op1)
1134 return ConstantFP::get(Op0->getType(), 1.0);
1135
1136 // -X / X -> -1.0 and
Benjamin Kramer1ee59cb2015-06-16 14:57:29 +00001137 // X / -X -> -1.0 are legal when NaNs are ignored.
Benjamin Kramer4f052462015-06-14 18:53:58 +00001138 // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
1139 if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
1140 BinaryOperator::getFNegArgument(Op0) == Op1) ||
1141 (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
1142 BinaryOperator::getFNegArgument(Op1) == Op0))
1143 return ConstantFP::get(Op0->getType(), -1.0);
1144 }
1145
Craig Topper9f008862014-04-15 04:59:12 +00001146 return nullptr;
Frits van Bommelc2549662011-01-29 15:26:31 +00001147}
1148
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001149Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001150 const SimplifyQuery &Q) {
1151 return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
1152}
1153
Sanjay Patel472cc782016-01-11 22:14:42 +00001154/// Given operands for an SRem or URem, see if we can fold the result.
1155/// If not, this returns null.
Duncan Sandsa3e36992011-05-02 16:27:02 +00001156static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001157 const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001158 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1159 return C;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001160
Sanjay Patel0cb2ee92017-03-06 19:08:35 +00001161 if (Value *V = simplifyDivRem(Op0, Op1, false))
1162 return V;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001163
David Majnemerb435a422014-09-17 04:16:35 +00001164 // (X % Y) % Y -> X % Y
1165 if ((Opcode == Instruction::SRem &&
1166 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1167 (Opcode == Instruction::URem &&
1168 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
David Majnemerac717f02014-09-17 03:34:34 +00001169 return Op0;
David Majnemerac717f02014-09-17 03:34:34 +00001170
Duncan Sandsa3e36992011-05-02 16:27:02 +00001171 // If the operation is with the result of a select instruction, check whether
1172 // operating on either branch of the select always yields the same value.
1173 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001174 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001175 return V;
1176
1177 // If the operation is with the result of a phi instruction, check whether
1178 // operating on all incoming values of the phi always yields the same value.
1179 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001180 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001181 return V;
1182
Craig Topper9f008862014-04-15 04:59:12 +00001183 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001184}
1185
Sanjay Patel472cc782016-01-11 22:14:42 +00001186/// Given operands for an SRem, see if we can fold the result.
1187/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001188static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001189 unsigned MaxRecurse) {
1190 if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001191 return V;
1192
Craig Topper9f008862014-04-15 04:59:12 +00001193 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001194}
1195
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001196Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1197 return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1198}
1199
Sanjay Patel472cc782016-01-11 22:14:42 +00001200/// Given operands for a URem, see if we can fold the result.
1201/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001202static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001203 unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001204 if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001205 return V;
1206
David Majnemer8c0e62f2017-01-06 21:23:51 +00001207 // urem %V, C -> %V if %V < C
1208 if (MaxRecurse) {
1209 if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1210 ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1211 if (C->isAllOnesValue()) {
1212 return Op0;
1213 }
1214 }
1215 }
1216
Craig Topper9f008862014-04-15 04:59:12 +00001217 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001218}
1219
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001220Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1221 return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1222}
1223
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001224static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001225 const SimplifyQuery &Q, unsigned) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001226 if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
1227 return C;
1228
Duncan Sandsa3e36992011-05-02 16:27:02 +00001229 // undef % X -> undef (the undef could be a snan).
1230 if (match(Op0, m_Undef()))
1231 return Op0;
1232
1233 // X % undef -> undef
1234 if (match(Op1, m_Undef()))
1235 return Op1;
1236
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001237 // 0 % X -> 0
1238 // Requires that NaNs are off (X could be zero) and signed zeroes are
1239 // ignored (X could be positive or negative, so the output sign is unknown).
1240 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1241 return Op0;
1242
Craig Topper9f008862014-04-15 04:59:12 +00001243 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001244}
1245
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00001246Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001247 const SimplifyQuery &Q) {
1248 return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
1249}
1250
Sanjay Patel472cc782016-01-11 22:14:42 +00001251/// Returns true if a shift by \c Amount always yields undef.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001252static bool isUndefShift(Value *Amount) {
1253 Constant *C = dyn_cast<Constant>(Amount);
1254 if (!C)
1255 return false;
1256
1257 // X shift by undef -> undef because it may shift by the bitwidth.
1258 if (isa<UndefValue>(C))
1259 return true;
1260
1261 // Shifting by the bitwidth or more is undefined.
1262 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1263 if (CI->getValue().getLimitedValue() >=
1264 CI->getType()->getScalarSizeInBits())
1265 return true;
1266
1267 // If all lanes of a vector shift are undefined the whole shift is.
1268 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1269 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1270 if (!isUndefShift(C->getAggregateElement(I)))
1271 return false;
1272 return true;
1273 }
1274
1275 return false;
1276}
1277
Sanjay Patel472cc782016-01-11 22:14:42 +00001278/// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1279/// If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001280static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001281 Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001282 if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1283 return C;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001284
Duncan Sands571fd9a2011-01-14 14:44:12 +00001285 // 0 shift by X -> 0
Duncan Sands7f60dc12011-01-14 00:37:45 +00001286 if (match(Op0, m_Zero()))
1287 return Op0;
1288
Duncan Sands571fd9a2011-01-14 14:44:12 +00001289 // X shift by 0 -> X
Duncan Sands7f60dc12011-01-14 00:37:45 +00001290 if (match(Op1, m_Zero()))
1291 return Op0;
1292
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00001293 // Fold undefined shifts.
1294 if (isUndefShift(Op1))
1295 return UndefValue::get(Op0->getType());
Duncan Sands7f60dc12011-01-14 00:37:45 +00001296
Duncan Sands571fd9a2011-01-14 14:44:12 +00001297 // If the operation is with the result of a select instruction, check whether
1298 // operating on either branch of the select always yields the same value.
1299 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001300 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001301 return V;
1302
1303 // If the operation is with the result of a phi instruction, check whether
1304 // operating on all incoming values of the phi always yields the same value.
1305 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001306 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001307 return V;
1308
Sanjay Patel6786bc52016-05-10 20:46:54 +00001309 // If any bits in the shift amount make that value greater than or equal to
1310 // the number of bits in the type, the shift is undefined.
1311 unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +00001312 KnownBits Known(BitWidth);
1313 computeKnownBits(Op1, Known, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1314 if (Known.One.getLimitedValue() >= BitWidth)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001315 return UndefValue::get(Op0->getType());
1316
1317 // If all valid bits in the shift amount are known zero, the first operand is
1318 // unchanged.
1319 unsigned NumValidShiftBits = Log2_32_Ceil(BitWidth);
Craig Topper8df66c62017-05-12 17:20:30 +00001320 if (Known.countMinTrailingZeros() >= NumValidShiftBits)
Sanjay Patel6786bc52016-05-10 20:46:54 +00001321 return Op0;
1322
Craig Topper9f008862014-04-15 04:59:12 +00001323 return nullptr;
Duncan Sands571fd9a2011-01-14 14:44:12 +00001324}
1325
David Majnemerbf7550e2014-11-05 00:59:59 +00001326/// \brief Given operands for an Shl, LShr or AShr, see if we can
1327/// fold the result. If not, this returns null.
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001328static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001329 Value *Op1, bool isExact, const SimplifyQuery &Q,
David Majnemerbf7550e2014-11-05 00:59:59 +00001330 unsigned MaxRecurse) {
1331 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1332 return V;
1333
1334 // X >> X -> 0
1335 if (Op0 == Op1)
1336 return Constant::getNullValue(Op0->getType());
1337
David Majnemer65c52ae2014-12-17 01:54:33 +00001338 // undef >> X -> 0
1339 // undef >> X -> undef (if it's exact)
1340 if (match(Op0, m_Undef()))
1341 return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1342
David Majnemerbf7550e2014-11-05 00:59:59 +00001343 // The low bit cannot be shifted out of an exact shift if it is set.
1344 if (isExact) {
1345 unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +00001346 KnownBits Op0Known(BitWidth);
1347 computeKnownBits(Op0, Op0Known, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
1348 if (Op0Known.One[0])
David Majnemerbf7550e2014-11-05 00:59:59 +00001349 return Op0;
1350 }
1351
1352 return nullptr;
1353}
1354
Sanjay Patel472cc782016-01-11 22:14:42 +00001355/// Given operands for an Shl, see if we can fold the result.
1356/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001357static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001358 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsb8cee002012-03-13 11:42:19 +00001359 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001360 return V;
1361
1362 // undef << X -> 0
David Majnemer65c52ae2014-12-17 01:54:33 +00001363 // undef << X -> undef if (if it's NSW/NUW)
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001364 if (match(Op0, m_Undef()))
David Majnemer65c52ae2014-12-17 01:54:33 +00001365 return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
Duncan Sands571fd9a2011-01-14 14:44:12 +00001366
Chris Lattner9e4aa022011-02-09 17:15:04 +00001367 // (X >> A) << A -> X
1368 Value *X;
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001369 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001370 return X;
Craig Topper9f008862014-04-15 04:59:12 +00001371 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001372}
1373
Chris Lattner9e4aa022011-02-09 17:15:04 +00001374Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001375 const SimplifyQuery &Q) {
1376 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1377}
1378
Sanjay Patel472cc782016-01-11 22:14:42 +00001379/// Given operands for an LShr, see if we can fold the result.
1380/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001381static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001382 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001383 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1384 MaxRecurse))
1385 return V;
David Majnemera80fed72013-07-09 22:01:22 +00001386
Chris Lattner9e4aa022011-02-09 17:15:04 +00001387 // (X << A) >> A -> X
1388 Value *X;
David Majnemer4f438372014-11-04 17:38:50 +00001389 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001390 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001391
Craig Topper9f008862014-04-15 04:59:12 +00001392 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001393}
1394
Chris Lattner9e4aa022011-02-09 17:15:04 +00001395Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001396 const SimplifyQuery &Q) {
1397 return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1398}
1399
Sanjay Patel472cc782016-01-11 22:14:42 +00001400/// Given operands for an AShr, see if we can fold the result.
1401/// If not, this returns null.
Chris Lattner9e4aa022011-02-09 17:15:04 +00001402static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001403 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemerbf7550e2014-11-05 00:59:59 +00001404 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1405 MaxRecurse))
Duncan Sands571fd9a2011-01-14 14:44:12 +00001406 return V;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001407
1408 // all ones >>a X -> all ones
1409 if (match(Op0, m_AllOnes()))
1410 return Op0;
1411
Chris Lattner9e4aa022011-02-09 17:15:04 +00001412 // (X << A) >> A -> X
1413 Value *X;
David Majnemer2de97fc2014-11-04 17:47:13 +00001414 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
Chris Lattner9e4aa022011-02-09 17:15:04 +00001415 return X;
Duncan Sandsd114ab32011-02-13 17:15:40 +00001416
Suyog Sarda68862412014-07-17 06:28:15 +00001417 // Arithmetic shifting an all-sign-bit value is a no-op.
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001418 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
Suyog Sarda68862412014-07-17 06:28:15 +00001419 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1420 return Op0;
1421
Craig Topper9f008862014-04-15 04:59:12 +00001422 return nullptr;
Duncan Sands7f60dc12011-01-14 00:37:45 +00001423}
1424
Chris Lattner9e4aa022011-02-09 17:15:04 +00001425Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001426 const SimplifyQuery &Q) {
1427 return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1428}
1429
David Majnemer1af36e52014-12-06 10:51:40 +00001430static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1431 ICmpInst *UnsignedICmp, bool IsAnd) {
1432 Value *X, *Y;
1433
1434 ICmpInst::Predicate EqPred;
David Majnemerd5b3aa42014-12-08 18:30:43 +00001435 if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1436 !ICmpInst::isEquality(EqPred))
David Majnemer1af36e52014-12-06 10:51:40 +00001437 return nullptr;
1438
1439 ICmpInst::Predicate UnsignedPred;
1440 if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1441 ICmpInst::isUnsigned(UnsignedPred))
1442 ;
1443 else if (match(UnsignedICmp,
1444 m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1445 ICmpInst::isUnsigned(UnsignedPred))
1446 UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1447 else
1448 return nullptr;
1449
1450 // X < Y && Y != 0 --> X < Y
1451 // X < Y || Y != 0 --> Y != 0
1452 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1453 return IsAnd ? UnsignedICmp : ZeroICmp;
1454
1455 // X >= Y || Y != 0 --> true
1456 // X >= Y || Y == 0 --> X >= Y
1457 if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1458 if (EqPred == ICmpInst::ICMP_NE)
1459 return getTrue(UnsignedICmp->getType());
1460 return UnsignedICmp;
1461 }
1462
David Majnemerd5b3aa42014-12-08 18:30:43 +00001463 // X < Y && Y == 0 --> false
1464 if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1465 IsAnd)
1466 return getFalse(UnsignedICmp->getType());
1467
David Majnemer1af36e52014-12-06 10:51:40 +00001468 return nullptr;
1469}
1470
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001471/// Commuted variants are assumed to be handled by calling this function again
1472/// with the parameters swapped.
1473static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1474 ICmpInst::Predicate Pred0, Pred1;
1475 Value *A ,*B;
Sanjay Patel53697752016-12-06 22:09:52 +00001476 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1477 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001478 return nullptr;
1479
1480 // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1481 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1482 // can eliminate Op1 from this 'and'.
1483 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1484 return Op0;
1485
1486 // Check for any combination of predicates that are guaranteed to be disjoint.
1487 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1488 (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1489 (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1490 (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1491 return getFalse(Op0->getType());
1492
1493 return nullptr;
1494}
1495
1496/// Commuted variants are assumed to be handled by calling this function again
1497/// with the parameters swapped.
Sanjay Patel142cb832017-05-04 18:19:17 +00001498static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1499 ICmpInst::Predicate Pred0, Pred1;
1500 Value *A ,*B;
1501 if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1502 !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1503 return nullptr;
1504
1505 // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1506 // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1507 // can eliminate Op0 from this 'or'.
1508 if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1509 return Op1;
1510
1511 // Check for any combination of predicates that cover the entire range of
1512 // possibilities.
1513 if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1514 (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1515 (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1516 (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1517 return getTrue(Op0->getType());
1518
1519 return nullptr;
1520}
1521
Sanjay Patel599e65b2017-05-07 15:11:40 +00001522/// Test if a pair of compares with a shared operand and 2 constants has an
1523/// empty set intersection, full set union, or if one compare is a superset of
1524/// the other.
1525static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1526 bool IsAnd) {
1527 // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1528 if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1529 return nullptr;
1530
1531 const APInt *C0, *C1;
1532 if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1533 !match(Cmp1->getOperand(1), m_APInt(C1)))
1534 return nullptr;
1535
1536 auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1537 auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1538
Sanjay Patel67454472017-05-08 16:35:02 +00001539 // For and-of-compares, check if the intersection is empty:
Sanjay Patel599e65b2017-05-07 15:11:40 +00001540 // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1541 if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1542 return getFalse(Cmp0->getType());
1543
1544 // For or-of-compares, check if the union is full:
1545 // (icmp X, C0) || (icmp X, C1) --> full set --> true
1546 if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1547 return getTrue(Cmp0->getType());
1548
1549 // Is one range a superset of the other?
1550 // If this is and-of-compares, take the smaller set:
1551 // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1552 // If this is or-of-compares, take the larger set:
1553 // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1554 if (Range0.contains(Range1))
1555 return IsAnd ? Cmp1 : Cmp0;
1556 if (Range1.contains(Range0))
1557 return IsAnd ? Cmp0 : Cmp1;
1558
1559 return nullptr;
1560}
1561
Sanjay Patel142cb832017-05-04 18:19:17 +00001562/// Commuted variants are assumed to be handled by calling this function again
1563/// with the parameters swapped.
Sanjay Patele42b4d52017-05-04 19:51:34 +00001564static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
David Majnemer1af36e52014-12-06 10:51:40 +00001565 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1566 return X;
1567
Sanjay Patel9b1b2de2016-12-06 19:05:46 +00001568 if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1569 return X;
1570
Sanjay Patel599e65b2017-05-07 15:11:40 +00001571 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
1572 return X;
1573
1574 // (icmp (add V, C0), C1) & (icmp V, C0)
Sanjay Patelb2332e12016-09-20 14:36:14 +00001575 Type *ITy = Op0->getType();
1576 ICmpInst::Predicate Pred0, Pred1;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001577 const APInt *C0, *C1;
Sanjay Patelb2332e12016-09-20 14:36:14 +00001578 Value *V;
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001579 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
Sanjay Patelf8ee0e02016-06-19 17:20:27 +00001580 return nullptr;
David Majnemera315bd82014-09-15 08:15:28 +00001581
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001582 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
David Majnemera315bd82014-09-15 08:15:28 +00001583 return nullptr;
1584
David Majnemera315bd82014-09-15 08:15:28 +00001585 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001586 if (AddInst->getOperand(1) != Op1->getOperand(1))
1587 return nullptr;
1588
David Majnemera315bd82014-09-15 08:15:28 +00001589 bool isNSW = AddInst->hasNoSignedWrap();
1590 bool isNUW = AddInst->hasNoUnsignedWrap();
1591
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001592 const APInt Delta = *C1 - *C0;
1593 if (C0->isStrictlyPositive()) {
David Majnemera315bd82014-09-15 08:15:28 +00001594 if (Delta == 2) {
1595 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1596 return getFalse(ITy);
1597 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1598 return getFalse(ITy);
1599 }
1600 if (Delta == 1) {
1601 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1602 return getFalse(ITy);
1603 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1604 return getFalse(ITy);
1605 }
1606 }
Sanjay Patel1b312ad2016-09-28 13:53:13 +00001607 if (C0->getBoolValue() && isNUW) {
David Majnemera315bd82014-09-15 08:15:28 +00001608 if (Delta == 2)
1609 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1610 return getFalse(ITy);
1611 if (Delta == 1)
1612 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1613 return getFalse(ITy);
1614 }
1615
1616 return nullptr;
1617}
1618
Sanjay Patel142cb832017-05-04 18:19:17 +00001619/// Commuted variants are assumed to be handled by calling this function again
1620/// with the parameters swapped.
Sanjay Patele42b4d52017-05-04 19:51:34 +00001621static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
Sanjay Patel142cb832017-05-04 18:19:17 +00001622 if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1623 return X;
1624
1625 if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1626 return X;
1627
Sanjay Patel599e65b2017-05-07 15:11:40 +00001628 if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1629 return X;
1630
Sanjay Patel142cb832017-05-04 18:19:17 +00001631 // (icmp (add V, C0), C1) | (icmp V, C0)
1632 ICmpInst::Predicate Pred0, Pred1;
1633 const APInt *C0, *C1;
1634 Value *V;
1635 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1636 return nullptr;
1637
1638 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1639 return nullptr;
1640
1641 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1642 if (AddInst->getOperand(1) != Op1->getOperand(1))
1643 return nullptr;
1644
1645 Type *ITy = Op0->getType();
1646 bool isNSW = AddInst->hasNoSignedWrap();
1647 bool isNUW = AddInst->hasNoUnsignedWrap();
1648
1649 const APInt Delta = *C1 - *C0;
1650 if (C0->isStrictlyPositive()) {
1651 if (Delta == 2) {
1652 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1653 return getTrue(ITy);
1654 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1655 return getTrue(ITy);
1656 }
1657 if (Delta == 1) {
1658 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1659 return getTrue(ITy);
1660 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1661 return getTrue(ITy);
1662 }
1663 }
1664 if (C0->getBoolValue() && isNUW) {
1665 if (Delta == 2)
1666 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1667 return getTrue(ITy);
1668 if (Delta == 1)
1669 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1670 return getTrue(ITy);
1671 }
1672
1673 return nullptr;
1674}
1675
Sanjay Patele42b4d52017-05-04 19:51:34 +00001676static Value *simplifyPossiblyCastedAndOrOfICmps(ICmpInst *Cmp0, ICmpInst *Cmp1,
1677 bool IsAnd, CastInst *Cast) {
1678 Value *V =
1679 IsAnd ? simplifyAndOfICmps(Cmp0, Cmp1) : simplifyOrOfICmps(Cmp0, Cmp1);
1680 if (!V)
1681 return nullptr;
1682 if (!Cast)
1683 return V;
1684
1685 // If we looked through casts, we can only handle a constant simplification
1686 // because we are not allowed to create a cast instruction here.
1687 if (auto *C = dyn_cast<Constant>(V))
1688 return ConstantExpr::getCast(Cast->getOpcode(), C, Cast->getType());
1689
1690 return nullptr;
1691}
1692
1693static Value *simplifyAndOrOfICmps(Value *Op0, Value *Op1, bool IsAnd) {
1694 // Look through casts of the 'and' operands to find compares.
1695 auto *Cast0 = dyn_cast<CastInst>(Op0);
1696 auto *Cast1 = dyn_cast<CastInst>(Op1);
1697 if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1698 Cast0->getSrcTy() == Cast1->getSrcTy()) {
1699 Op0 = Cast0->getOperand(0);
1700 Op1 = Cast1->getOperand(0);
1701 }
1702
1703 auto *Cmp0 = dyn_cast<ICmpInst>(Op0);
1704 auto *Cmp1 = dyn_cast<ICmpInst>(Op1);
1705 if (!Cmp0 || !Cmp1)
1706 return nullptr;
1707
1708 if (Value *V = simplifyPossiblyCastedAndOrOfICmps(Cmp0, Cmp1, IsAnd, Cast0))
1709 return V;
1710 if (Value *V = simplifyPossiblyCastedAndOrOfICmps(Cmp1, Cmp0, IsAnd, Cast0))
1711 return V;
1712
1713 return nullptr;
1714}
1715
Sanjay Patel472cc782016-01-11 22:14:42 +00001716/// Given operands for an And, see if we can fold the result.
1717/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001718static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Chad Rosierc24b86f2011-12-01 03:08:23 +00001719 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001720 if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1721 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001722
Chris Lattnera71e9d62009-11-10 00:55:12 +00001723 // X & undef -> 0
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001724 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001725 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001726
Chris Lattnera71e9d62009-11-10 00:55:12 +00001727 // X & X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001728 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001729 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001730
Duncan Sandsc89ac072010-11-17 18:52:15 +00001731 // X & 0 = 0
1732 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001733 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001734
Duncan Sandsc89ac072010-11-17 18:52:15 +00001735 // X & -1 = X
1736 if (match(Op1, m_AllOnes()))
1737 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001738
Chris Lattnera71e9d62009-11-10 00:55:12 +00001739 // A & ~A = ~A & A = 0
Chris Lattner9e4aa022011-02-09 17:15:04 +00001740 if (match(Op0, m_Not(m_Specific(Op1))) ||
1741 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001742 return Constant::getNullValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001743
Chris Lattnera71e9d62009-11-10 00:55:12 +00001744 // (A | ?) & A = A
Craig Topper9f008862014-04-15 04:59:12 +00001745 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001746 if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001747 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001748 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001749
Chris Lattnera71e9d62009-11-10 00:55:12 +00001750 // A & (A | ?) = A
1751 if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001752 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001753 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001754
Duncan Sandsba286d72011-10-26 20:55:21 +00001755 // A & (-A) = A if A is a power of two or zero.
1756 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1757 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001758 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1759 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001760 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001761 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1762 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001763 return Op1;
1764 }
1765
Sanjay Patele42b4d52017-05-04 19:51:34 +00001766 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, true))
1767 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001768
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001769 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001770 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1771 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001772 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001773
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001774 // And distributes over Or. Try some generic simplifications based on this.
1775 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001776 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001777 return V;
1778
1779 // And distributes over Xor. Try some generic simplifications based on this.
1780 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001781 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001782 return V;
1783
Duncan Sandsb0579e92010-11-10 13:00:08 +00001784 // If the operation is with the result of a select instruction, check whether
1785 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001786 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001787 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1788 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001789 return V;
1790
1791 // If the operation is with the result of a phi instruction, check whether
1792 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001793 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001794 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001795 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001796 return V;
1797
Craig Topper9f008862014-04-15 04:59:12 +00001798 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001799}
1800
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001801Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1802 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1803}
1804
Sanjay Patel472cc782016-01-11 22:14:42 +00001805/// Given operands for an Or, see if we can fold the result.
1806/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001807static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001808 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001809 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1810 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001811
Chris Lattnera71e9d62009-11-10 00:55:12 +00001812 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001813 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001814 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001815
Chris Lattnera71e9d62009-11-10 00:55:12 +00001816 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001817 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001818 return Op0;
1819
Duncan Sandsc89ac072010-11-17 18:52:15 +00001820 // X | 0 = X
1821 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001822 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001823
Duncan Sandsc89ac072010-11-17 18:52:15 +00001824 // X | -1 = -1
1825 if (match(Op1, m_AllOnes()))
1826 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001827
Chris Lattnera71e9d62009-11-10 00:55:12 +00001828 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001829 if (match(Op0, m_Not(m_Specific(Op1))) ||
1830 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001831 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001832
Chris Lattnera71e9d62009-11-10 00:55:12 +00001833 // (A & ?) | A = A
Craig Topper9f008862014-04-15 04:59:12 +00001834 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001835 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001836 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001837 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001838
Chris Lattnera71e9d62009-11-10 00:55:12 +00001839 // A | (A & ?) = A
1840 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001841 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001842 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001843
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001844 // ~(A & ?) | A = -1
1845 if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1846 (A == Op1 || B == Op1))
1847 return Constant::getAllOnesValue(Op1->getType());
1848
1849 // A | ~(A & ?) = -1
1850 if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1851 (A == Op0 || B == Op0))
1852 return Constant::getAllOnesValue(Op0->getType());
1853
Sanjay Patel08892252017-04-24 18:24:36 +00001854 // (A & ~B) | (A ^ B) -> (A ^ B)
1855 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001856 // (A & ~B) | (B ^ A) -> (B ^ A)
1857 // (~B & A) | (B ^ A) -> (B ^ A)
1858 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1859 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1860 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001861 return Op1;
1862
1863 // Commute the 'or' operands.
1864 // (A ^ B) | (A & ~B) -> (A ^ B)
1865 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001866 // (B ^ A) | (A & ~B) -> (B ^ A)
1867 // (B ^ A) | (~B & A) -> (B ^ A)
1868 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1869 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1870 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001871 return Op0;
1872
Craig Topper479daaf2017-05-14 07:54:43 +00001873 // (A & B) | (~A ^ B) -> (~A ^ B)
1874 // (B & A) | (~A ^ B) -> (~A ^ B)
1875 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1876 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1877 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1878 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1879 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1880 return Op1;
1881
1882 // (~A ^ B) | (A & B) -> (~A ^ B)
1883 // (~A ^ B) | (B & A) -> (~A ^ B)
1884 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1885 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1886 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1887 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1888 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1889 return Op0;
1890
Sanjay Patele42b4d52017-05-04 19:51:34 +00001891 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, false))
1892 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001893
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001894 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001895 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1896 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001897 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001898
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001899 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001900 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1901 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001902 return V;
1903
Duncan Sandsb0579e92010-11-10 13:00:08 +00001904 // If the operation is with the result of a select instruction, check whether
1905 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001906 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001907 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001908 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001909 return V;
1910
Nick Lewycky8561a492014-06-19 03:51:46 +00001911 // (A & C)|(B & D)
1912 Value *C = nullptr, *D = nullptr;
1913 if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1914 match(Op1, m_And(m_Value(B), m_Value(D)))) {
1915 ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1916 ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1917 if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1918 // (A & C1)|(B & C2)
1919 // If we have: ((V + N) & C1) | (V & C2)
1920 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1921 // replace with V+N.
1922 Value *V1, *V2;
1923 if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1924 match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1925 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001926 if (V1 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001927 MaskedValueIsZero(V2, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001928 return A;
Chandler Carruth66b31302015-01-04 12:03:27 +00001929 if (V2 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001930 MaskedValueIsZero(V1, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001931 return A;
1932 }
1933 // Or commutes, try both ways.
1934 if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1935 match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1936 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001937 if (V1 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001938 MaskedValueIsZero(V2, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001939 return B;
Chandler Carruth66b31302015-01-04 12:03:27 +00001940 if (V2 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001941 MaskedValueIsZero(V1, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001942 return B;
1943 }
1944 }
1945 }
1946
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001947 // If the operation is with the result of a phi instruction, check whether
1948 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001949 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001950 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001951 return V;
1952
Craig Topper9f008862014-04-15 04:59:12 +00001953 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001954}
1955
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001956Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1957 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1958}
1959
Sanjay Patel472cc782016-01-11 22:14:42 +00001960/// Given operands for a Xor, see if we can fold the result.
1961/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001962static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001963 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001964 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1965 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001966
1967 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001968 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001969 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001970
1971 // A ^ 0 = A
1972 if (match(Op1, m_Zero()))
1973 return Op0;
1974
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001975 // A ^ A = 0
1976 if (Op0 == Op1)
1977 return Constant::getNullValue(Op0->getType());
1978
Duncan Sandsc89ac072010-11-17 18:52:15 +00001979 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001980 if (match(Op0, m_Not(m_Specific(Op1))) ||
1981 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00001982 return Constant::getAllOnesValue(Op0->getType());
1983
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001984 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001985 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1986 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001987 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001988
Duncan Sandsb238de02010-11-19 09:20:39 +00001989 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1990 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1991 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1992 // only if B and C are equal. If B and C are equal then (since we assume
1993 // that operands have already been simplified) "select(cond, B, C)" should
1994 // have been simplified to the common value of B and C already. Analysing
1995 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
1996 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00001997
Craig Topper9f008862014-04-15 04:59:12 +00001998 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001999}
2000
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002001Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2002 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2003}
2004
2005
Chris Lattner229907c2011-07-18 04:54:35 +00002006static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002007 return CmpInst::makeCmpResultType(Op->getType());
2008}
2009
Sanjay Patel472cc782016-01-11 22:14:42 +00002010/// Rummage around inside V looking for something equivalent to the comparison
2011/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2012/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002013static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2014 Value *LHS, Value *RHS) {
2015 SelectInst *SI = dyn_cast<SelectInst>(V);
2016 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002017 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002018 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2019 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002020 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002021 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2022 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2023 return Cmp;
2024 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2025 LHS == CmpRHS && RHS == CmpLHS)
2026 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002027 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002028}
2029
Dan Gohman9631d902013-02-01 00:49:06 +00002030// A significant optimization not implemented here is assuming that alloca
2031// addresses are not equal to incoming argument values. They don't *alias*,
2032// as we say, but that doesn't mean they aren't equal, so we take a
2033// conservative approach.
2034//
2035// This is inspired in part by C++11 5.10p1:
2036// "Two pointers of the same type compare equal if and only if they are both
2037// null, both point to the same function, or both represent the same
2038// address."
2039//
2040// This is pretty permissive.
2041//
2042// It's also partly due to C11 6.5.9p6:
2043// "Two pointers compare equal if and only if both are null pointers, both are
2044// pointers to the same object (including a pointer to an object and a
2045// subobject at its beginning) or function, both are pointers to one past the
2046// last element of the same array object, or one is a pointer to one past the
2047// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002048// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002049// object in the address space.)
2050//
2051// C11's version is more restrictive, however there's no reason why an argument
2052// couldn't be a one-past-the-end value for a stack object in the caller and be
2053// equal to the beginning of a stack object in the callee.
2054//
2055// If the C and C++ standards are ever made sufficiently restrictive in this
2056// area, it may be possible to update LLVM's semantics accordingly and reinstate
2057// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002058static Constant *
2059computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2060 const DominatorTree *DT, CmpInst::Predicate Pred,
2061 const Instruction *CxtI, Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002062 // First, skip past any trivial no-ops.
2063 LHS = LHS->stripPointerCasts();
2064 RHS = RHS->stripPointerCasts();
2065
2066 // A non-null pointer is not equal to a null pointer.
Sean Silva45835e72016-07-02 23:47:27 +00002067 if (llvm::isKnownNonNull(LHS) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002068 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2069 return ConstantInt::get(GetCompareTy(LHS),
2070 !CmpInst::isTrueWhenEqual(Pred));
2071
Chandler Carruth8059c842012-03-25 21:28:14 +00002072 // We can only fold certain predicates on pointer comparisons.
2073 switch (Pred) {
2074 default:
Craig Topper9f008862014-04-15 04:59:12 +00002075 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002076
2077 // Equality comaprisons are easy to fold.
2078 case CmpInst::ICMP_EQ:
2079 case CmpInst::ICMP_NE:
2080 break;
2081
2082 // We can only handle unsigned relational comparisons because 'inbounds' on
2083 // a GEP only protects against unsigned wrapping.
2084 case CmpInst::ICMP_UGT:
2085 case CmpInst::ICMP_UGE:
2086 case CmpInst::ICMP_ULT:
2087 case CmpInst::ICMP_ULE:
2088 // However, we have to switch them to their signed variants to handle
2089 // negative indices from the base pointer.
2090 Pred = ICmpInst::getSignedPredicate(Pred);
2091 break;
2092 }
2093
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002094 // Strip off any constant offsets so that we can reason about them.
2095 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2096 // here and compare base addresses like AliasAnalysis does, however there are
2097 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2098 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2099 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002100 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2101 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002102
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002103 // If LHS and RHS are related via constant offsets to the same base
2104 // value, we can replace it with an icmp which just compares the offsets.
2105 if (LHS == RHS)
2106 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002107
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002108 // Various optimizations for (in)equality comparisons.
2109 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2110 // Different non-empty allocations that exist at the same time have
2111 // different addresses (if the program can tell). Global variables always
2112 // exist, so they always exist during the lifetime of each other and all
2113 // allocas. Two different allocas usually have different addresses...
2114 //
2115 // However, if there's an @llvm.stackrestore dynamically in between two
2116 // allocas, they may have the same address. It's tempting to reduce the
2117 // scope of the problem by only looking at *static* allocas here. That would
2118 // cover the majority of allocas while significantly reducing the likelihood
2119 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2120 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2121 // an entry block. Also, if we have a block that's not attached to a
2122 // function, we can't tell if it's "static" under the current definition.
2123 // Theoretically, this problem could be fixed by creating a new kind of
2124 // instruction kind specifically for static allocas. Such a new instruction
2125 // could be required to be at the top of the entry block, thus preventing it
2126 // from being subject to a @llvm.stackrestore. Instcombine could even
2127 // convert regular allocas into these special allocas. It'd be nifty.
2128 // However, until then, this problem remains open.
2129 //
2130 // So, we'll assume that two non-empty allocas have different addresses
2131 // for now.
2132 //
2133 // With all that, if the offsets are within the bounds of their allocations
2134 // (and not one-past-the-end! so we can't use inbounds!), and their
2135 // allocations aren't the same, the pointers are not equal.
2136 //
2137 // Note that it's not necessary to check for LHS being a global variable
2138 // address, due to canonicalization and constant folding.
2139 if (isa<AllocaInst>(LHS) &&
2140 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002141 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2142 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002143 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002144 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002145 getObjectSize(LHS, LHSSize, DL, TLI) &&
2146 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002147 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2148 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002149 if (!LHSOffsetValue.isNegative() &&
2150 !RHSOffsetValue.isNegative() &&
2151 LHSOffsetValue.ult(LHSSize) &&
2152 RHSOffsetValue.ult(RHSSize)) {
2153 return ConstantInt::get(GetCompareTy(LHS),
2154 !CmpInst::isTrueWhenEqual(Pred));
2155 }
2156 }
2157
2158 // Repeat the above check but this time without depending on DataLayout
2159 // or being able to compute a precise size.
2160 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2161 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2162 LHSOffset->isNullValue() &&
2163 RHSOffset->isNullValue())
2164 return ConstantInt::get(GetCompareTy(LHS),
2165 !CmpInst::isTrueWhenEqual(Pred));
2166 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002167
2168 // Even if an non-inbounds GEP occurs along the path we can still optimize
2169 // equality comparisons concerning the result. We avoid walking the whole
2170 // chain again by starting where the last calls to
2171 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002172 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2173 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002174 if (LHS == RHS)
2175 return ConstantExpr::getICmp(Pred,
2176 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2177 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002178
2179 // If one side of the equality comparison must come from a noalias call
2180 // (meaning a system memory allocation function), and the other side must
2181 // come from a pointer that cannot overlap with dynamically-allocated
2182 // memory within the lifetime of the current function (allocas, byval
2183 // arguments, globals), then determine the comparison result here.
2184 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2185 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2186 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2187
2188 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002189 auto IsNAC = [](ArrayRef<Value *> Objects) {
2190 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002191 };
2192
2193 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002194 // noalias calls. For allocas, we consider only static ones (dynamic
2195 // allocas might be transformed into calls to malloc not simultaneously
2196 // live with the compared-to allocation). For globals, we exclude symbols
2197 // that might be resolve lazily to symbols in another dynamically-loaded
2198 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002199 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2200 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002201 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2202 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2203 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2204 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002205 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002206 !GV->isThreadLocal();
2207 if (const Argument *A = dyn_cast<Argument>(V))
2208 return A->hasByValAttr();
2209 return false;
2210 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002211 };
2212
2213 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2214 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2215 return ConstantInt::get(GetCompareTy(LHS),
2216 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002217
2218 // Fold comparisons for non-escaping pointer even if the allocation call
2219 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2220 // dynamic allocation call could be either of the operands.
2221 Value *MI = nullptr;
Sean Silva45835e72016-07-02 23:47:27 +00002222 if (isAllocLikeFn(LHS, TLI) && llvm::isKnownNonNullAt(RHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002223 MI = LHS;
Sean Silva45835e72016-07-02 23:47:27 +00002224 else if (isAllocLikeFn(RHS, TLI) && llvm::isKnownNonNullAt(LHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002225 MI = RHS;
2226 // FIXME: We should also fold the compare when the pointer escapes, but the
2227 // compare dominates the pointer escape
2228 if (MI && !PointerMayBeCaptured(MI, true, true))
2229 return ConstantInt::get(GetCompareTy(LHS),
2230 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002231 }
2232
2233 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002234 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002235}
Chris Lattner01990f02012-02-24 19:01:58 +00002236
Sanjay Pateldc65a272016-12-03 17:30:22 +00002237/// Fold an icmp when its operands have i1 scalar type.
2238static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002239 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002240 Type *ITy = GetCompareTy(LHS); // The return type.
2241 Type *OpTy = LHS->getType(); // The operand type.
2242 if (!OpTy->getScalarType()->isIntegerTy(1))
2243 return nullptr;
2244
2245 switch (Pred) {
2246 default:
2247 break;
2248 case ICmpInst::ICMP_EQ:
2249 // X == 1 -> X
2250 if (match(RHS, m_One()))
2251 return LHS;
2252 break;
2253 case ICmpInst::ICMP_NE:
2254 // X != 0 -> X
2255 if (match(RHS, m_Zero()))
2256 return LHS;
2257 break;
2258 case ICmpInst::ICMP_UGT:
2259 // X >u 0 -> X
2260 if (match(RHS, m_Zero()))
2261 return LHS;
2262 break;
2263 case ICmpInst::ICMP_UGE:
2264 // X >=u 1 -> X
2265 if (match(RHS, m_One()))
2266 return LHS;
2267 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2268 return getTrue(ITy);
2269 break;
2270 case ICmpInst::ICMP_SGE:
2271 /// For signed comparison, the values for an i1 are 0 and -1
2272 /// respectively. This maps into a truth table of:
2273 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2274 /// 0 | 0 | 1 (0 >= 0) | 1
2275 /// 0 | 1 | 1 (0 >= -1) | 1
2276 /// 1 | 0 | 0 (-1 >= 0) | 0
2277 /// 1 | 1 | 1 (-1 >= -1) | 1
2278 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2279 return getTrue(ITy);
2280 break;
2281 case ICmpInst::ICMP_SLT:
2282 // X <s 0 -> X
2283 if (match(RHS, m_Zero()))
2284 return LHS;
2285 break;
2286 case ICmpInst::ICMP_SLE:
2287 // X <=s -1 -> X
2288 if (match(RHS, m_One()))
2289 return LHS;
2290 break;
2291 case ICmpInst::ICMP_ULE:
2292 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2293 return getTrue(ITy);
2294 break;
2295 }
2296
2297 return nullptr;
2298}
2299
2300/// Try hard to fold icmp with zero RHS because this is a common case.
2301static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002302 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002303 if (!match(RHS, m_Zero()))
2304 return nullptr;
2305
2306 Type *ITy = GetCompareTy(LHS); // The return type.
2307 bool LHSKnownNonNegative, LHSKnownNegative;
2308 switch (Pred) {
2309 default:
2310 llvm_unreachable("Unknown ICmp predicate!");
2311 case ICmpInst::ICMP_ULT:
2312 return getFalse(ITy);
2313 case ICmpInst::ICMP_UGE:
2314 return getTrue(ITy);
2315 case ICmpInst::ICMP_EQ:
2316 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002317 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002318 return getFalse(ITy);
2319 break;
2320 case ICmpInst::ICMP_NE:
2321 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002322 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002323 return getTrue(ITy);
2324 break;
2325 case ICmpInst::ICMP_SLT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002326 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2327 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002328 if (LHSKnownNegative)
2329 return getTrue(ITy);
2330 if (LHSKnownNonNegative)
2331 return getFalse(ITy);
2332 break;
2333 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002334 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2335 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002336 if (LHSKnownNegative)
2337 return getTrue(ITy);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002338 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002339 return getFalse(ITy);
2340 break;
2341 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002342 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2343 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002344 if (LHSKnownNegative)
2345 return getFalse(ITy);
2346 if (LHSKnownNonNegative)
2347 return getTrue(ITy);
2348 break;
2349 case ICmpInst::ICMP_SGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002350 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2351 Q.CxtI, Q.DT);
Sanjay Pateldc65a272016-12-03 17:30:22 +00002352 if (LHSKnownNegative)
2353 return getFalse(ITy);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002354 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002355 return getTrue(ITy);
2356 break;
2357 }
2358
2359 return nullptr;
2360}
2361
Sanjay Patelbe332132017-01-23 18:22:26 +00002362/// Many binary operators with a constant operand have an easy-to-compute
2363/// range of outputs. This can be used to fold a comparison to always true or
2364/// always false.
2365static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2366 unsigned Width = Lower.getBitWidth();
2367 const APInt *C;
2368 switch (BO.getOpcode()) {
2369 case Instruction::Add:
Sanjay Patel56227252017-01-24 17:03:24 +00002370 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2371 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2372 if (BO.hasNoUnsignedWrap()) {
2373 // 'add nuw x, C' produces [C, UINT_MAX].
2374 Lower = *C;
2375 } else if (BO.hasNoSignedWrap()) {
2376 if (C->isNegative()) {
2377 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2378 Lower = APInt::getSignedMinValue(Width);
2379 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2380 } else {
2381 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2382 Lower = APInt::getSignedMinValue(Width) + *C;
2383 Upper = APInt::getSignedMaxValue(Width) + 1;
2384 }
2385 }
2386 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002387 break;
2388
2389 case Instruction::And:
2390 if (match(BO.getOperand(1), m_APInt(C)))
2391 // 'and x, C' produces [0, C].
2392 Upper = *C + 1;
2393 break;
2394
2395 case Instruction::Or:
2396 if (match(BO.getOperand(1), m_APInt(C)))
2397 // 'or x, C' produces [C, UINT_MAX].
2398 Lower = *C;
2399 break;
2400
2401 case Instruction::AShr:
2402 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2403 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2404 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2405 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2406 } else if (match(BO.getOperand(0), m_APInt(C))) {
2407 unsigned ShiftAmount = Width - 1;
2408 if (*C != 0 && BO.isExact())
2409 ShiftAmount = C->countTrailingZeros();
2410 if (C->isNegative()) {
2411 // 'ashr C, x' produces [C, C >> (Width-1)]
2412 Lower = *C;
2413 Upper = C->ashr(ShiftAmount) + 1;
2414 } else {
2415 // 'ashr C, x' produces [C >> (Width-1), C]
2416 Lower = C->ashr(ShiftAmount);
2417 Upper = *C + 1;
2418 }
2419 }
2420 break;
2421
2422 case Instruction::LShr:
2423 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2424 // 'lshr x, C' produces [0, UINT_MAX >> C].
2425 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2426 } else if (match(BO.getOperand(0), m_APInt(C))) {
2427 // 'lshr C, x' produces [C >> (Width-1), C].
2428 unsigned ShiftAmount = Width - 1;
2429 if (*C != 0 && BO.isExact())
2430 ShiftAmount = C->countTrailingZeros();
2431 Lower = C->lshr(ShiftAmount);
2432 Upper = *C + 1;
2433 }
2434 break;
2435
2436 case Instruction::Shl:
2437 if (match(BO.getOperand(0), m_APInt(C))) {
2438 if (BO.hasNoUnsignedWrap()) {
2439 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2440 Lower = *C;
2441 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2442 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2443 if (C->isNegative()) {
2444 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2445 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2446 Lower = C->shl(ShiftAmount);
2447 Upper = *C + 1;
2448 } else {
2449 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2450 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2451 Lower = *C;
2452 Upper = C->shl(ShiftAmount) + 1;
2453 }
2454 }
2455 }
2456 break;
2457
2458 case Instruction::SDiv:
2459 if (match(BO.getOperand(1), m_APInt(C))) {
2460 APInt IntMin = APInt::getSignedMinValue(Width);
2461 APInt IntMax = APInt::getSignedMaxValue(Width);
2462 if (C->isAllOnesValue()) {
2463 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2464 // where C != -1 and C != 0 and C != 1
2465 Lower = IntMin + 1;
2466 Upper = IntMax + 1;
2467 } else if (C->countLeadingZeros() < Width - 1) {
2468 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2469 // where C != -1 and C != 0 and C != 1
2470 Lower = IntMin.sdiv(*C);
2471 Upper = IntMax.sdiv(*C);
2472 if (Lower.sgt(Upper))
2473 std::swap(Lower, Upper);
2474 Upper = Upper + 1;
2475 assert(Upper != Lower && "Upper part of range has wrapped!");
2476 }
2477 } else if (match(BO.getOperand(0), m_APInt(C))) {
2478 if (C->isMinSignedValue()) {
2479 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2480 Lower = *C;
2481 Upper = Lower.lshr(1) + 1;
2482 } else {
2483 // 'sdiv C, x' produces [-|C|, |C|].
2484 Upper = C->abs() + 1;
2485 Lower = (-Upper) + 1;
2486 }
2487 }
2488 break;
2489
2490 case Instruction::UDiv:
2491 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2492 // 'udiv x, C' produces [0, UINT_MAX / C].
2493 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2494 } else if (match(BO.getOperand(0), m_APInt(C))) {
2495 // 'udiv C, x' produces [0, C].
2496 Upper = *C + 1;
2497 }
2498 break;
2499
2500 case Instruction::SRem:
2501 if (match(BO.getOperand(1), m_APInt(C))) {
2502 // 'srem x, C' produces (-|C|, |C|).
2503 Upper = C->abs();
2504 Lower = (-Upper) + 1;
2505 }
2506 break;
2507
2508 case Instruction::URem:
2509 if (match(BO.getOperand(1), m_APInt(C)))
2510 // 'urem x, C' produces [0, C).
2511 Upper = *C;
2512 break;
2513
2514 default:
2515 break;
2516 }
2517}
2518
Sanjay Patel67bde282016-08-22 23:12:02 +00002519static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2520 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002521 const APInt *C;
2522 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002523 return nullptr;
2524
2525 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002526 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002527 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002528 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002529 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002530 return ConstantInt::getTrue(GetCompareTy(RHS));
2531
Sanjay Patelbe332132017-01-23 18:22:26 +00002532 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002533 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002534 APInt Lower = APInt(Width, 0);
2535 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002536 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2537 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002538
2539 ConstantRange LHS_CR =
2540 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2541
2542 if (auto *I = dyn_cast<Instruction>(LHS))
2543 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2544 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2545
2546 if (!LHS_CR.isFullSet()) {
2547 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002548 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002549 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002550 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002551 }
2552
2553 return nullptr;
2554}
2555
Sanjay Patel2df38a82017-05-08 16:21:55 +00002556/// TODO: A large part of this logic is duplicated in InstCombine's
2557/// foldICmpBinOp(). We should be able to share that and avoid the code
2558/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002559static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002560 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002561 unsigned MaxRecurse) {
2562 Type *ITy = GetCompareTy(LHS); // The return type.
2563
2564 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2565 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2566 if (MaxRecurse && (LBO || RBO)) {
2567 // Analyze the case when either LHS or RHS is an add instruction.
2568 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2569 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2570 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2571 if (LBO && LBO->getOpcode() == Instruction::Add) {
2572 A = LBO->getOperand(0);
2573 B = LBO->getOperand(1);
2574 NoLHSWrapProblem =
2575 ICmpInst::isEquality(Pred) ||
2576 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2577 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2578 }
2579 if (RBO && RBO->getOpcode() == Instruction::Add) {
2580 C = RBO->getOperand(0);
2581 D = RBO->getOperand(1);
2582 NoRHSWrapProblem =
2583 ICmpInst::isEquality(Pred) ||
2584 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2585 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2586 }
2587
2588 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2589 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2590 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2591 Constant::getNullValue(RHS->getType()), Q,
2592 MaxRecurse - 1))
2593 return V;
2594
2595 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2596 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2597 if (Value *V =
2598 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2599 C == LHS ? D : C, Q, MaxRecurse - 1))
2600 return V;
2601
2602 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2603 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2604 NoRHSWrapProblem) {
2605 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2606 Value *Y, *Z;
2607 if (A == C) {
2608 // C + B == C + D -> B == D
2609 Y = B;
2610 Z = D;
2611 } else if (A == D) {
2612 // D + B == C + D -> B == C
2613 Y = B;
2614 Z = C;
2615 } else if (B == C) {
2616 // A + C == C + D -> A == D
2617 Y = A;
2618 Z = D;
2619 } else {
2620 assert(B == D);
2621 // A + D == C + D -> A == C
2622 Y = A;
2623 Z = C;
2624 }
2625 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2626 return V;
2627 }
2628 }
2629
2630 {
2631 Value *Y = nullptr;
2632 // icmp pred (or X, Y), X
2633 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2634 if (Pred == ICmpInst::ICMP_ULT)
2635 return getFalse(ITy);
2636 if (Pred == ICmpInst::ICMP_UGE)
2637 return getTrue(ITy);
2638
2639 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
2640 bool RHSKnownNonNegative, RHSKnownNegative;
2641 bool YKnownNonNegative, YKnownNegative;
2642 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, Q.DL, 0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002643 Q.AC, Q.CxtI, Q.DT);
2644 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002645 Q.CxtI, Q.DT);
2646 if (RHSKnownNonNegative && YKnownNegative)
2647 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
2648 if (RHSKnownNegative || YKnownNonNegative)
2649 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2650 }
2651 }
2652 // icmp pred X, (or X, Y)
2653 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2654 if (Pred == ICmpInst::ICMP_ULE)
2655 return getTrue(ITy);
2656 if (Pred == ICmpInst::ICMP_UGT)
2657 return getFalse(ITy);
2658
2659 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
2660 bool LHSKnownNonNegative, LHSKnownNegative;
2661 bool YKnownNonNegative, YKnownNegative;
2662 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002663 Q.AC, Q.CxtI, Q.DT);
2664 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002665 Q.CxtI, Q.DT);
2666 if (LHSKnownNonNegative && YKnownNegative)
2667 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
2668 if (LHSKnownNegative || YKnownNonNegative)
2669 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2670 }
2671 }
2672 }
2673
2674 // icmp pred (and X, Y), X
2675 if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2676 m_And(m_Specific(RHS), m_Value())))) {
2677 if (Pred == ICmpInst::ICMP_UGT)
2678 return getFalse(ITy);
2679 if (Pred == ICmpInst::ICMP_ULE)
2680 return getTrue(ITy);
2681 }
2682 // icmp pred X, (and X, Y)
2683 if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2684 m_And(m_Specific(LHS), m_Value())))) {
2685 if (Pred == ICmpInst::ICMP_UGE)
2686 return getTrue(ITy);
2687 if (Pred == ICmpInst::ICMP_ULT)
2688 return getFalse(ITy);
2689 }
2690
2691 // 0 - (zext X) pred C
2692 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2693 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2694 if (RHSC->getValue().isStrictlyPositive()) {
2695 if (Pred == ICmpInst::ICMP_SLT)
2696 return ConstantInt::getTrue(RHSC->getContext());
2697 if (Pred == ICmpInst::ICMP_SGE)
2698 return ConstantInt::getFalse(RHSC->getContext());
2699 if (Pred == ICmpInst::ICMP_EQ)
2700 return ConstantInt::getFalse(RHSC->getContext());
2701 if (Pred == ICmpInst::ICMP_NE)
2702 return ConstantInt::getTrue(RHSC->getContext());
2703 }
2704 if (RHSC->getValue().isNonNegative()) {
2705 if (Pred == ICmpInst::ICMP_SLE)
2706 return ConstantInt::getTrue(RHSC->getContext());
2707 if (Pred == ICmpInst::ICMP_SGT)
2708 return ConstantInt::getFalse(RHSC->getContext());
2709 }
2710 }
2711 }
2712
2713 // icmp pred (urem X, Y), Y
2714 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2715 bool KnownNonNegative, KnownNegative;
2716 switch (Pred) {
2717 default:
2718 break;
2719 case ICmpInst::ICMP_SGT:
2720 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002721 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2722 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002723 if (!KnownNonNegative)
2724 break;
2725 LLVM_FALLTHROUGH;
2726 case ICmpInst::ICMP_EQ:
2727 case ICmpInst::ICMP_UGT:
2728 case ICmpInst::ICMP_UGE:
2729 return getFalse(ITy);
2730 case ICmpInst::ICMP_SLT:
2731 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002732 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2733 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002734 if (!KnownNonNegative)
2735 break;
2736 LLVM_FALLTHROUGH;
2737 case ICmpInst::ICMP_NE:
2738 case ICmpInst::ICMP_ULT:
2739 case ICmpInst::ICMP_ULE:
2740 return getTrue(ITy);
2741 }
2742 }
2743
2744 // icmp pred X, (urem Y, X)
2745 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2746 bool KnownNonNegative, KnownNegative;
2747 switch (Pred) {
2748 default:
2749 break;
2750 case ICmpInst::ICMP_SGT:
2751 case ICmpInst::ICMP_SGE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002752 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2753 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002754 if (!KnownNonNegative)
2755 break;
2756 LLVM_FALLTHROUGH;
2757 case ICmpInst::ICMP_NE:
2758 case ICmpInst::ICMP_UGT:
2759 case ICmpInst::ICMP_UGE:
2760 return getTrue(ITy);
2761 case ICmpInst::ICMP_SLT:
2762 case ICmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002763 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2764 Q.CxtI, Q.DT);
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002765 if (!KnownNonNegative)
2766 break;
2767 LLVM_FALLTHROUGH;
2768 case ICmpInst::ICMP_EQ:
2769 case ICmpInst::ICMP_ULT:
2770 case ICmpInst::ICMP_ULE:
2771 return getFalse(ITy);
2772 }
2773 }
2774
2775 // x >> y <=u x
2776 // x udiv y <=u x.
2777 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2778 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2779 // icmp pred (X op Y), X
2780 if (Pred == ICmpInst::ICMP_UGT)
2781 return getFalse(ITy);
2782 if (Pred == ICmpInst::ICMP_ULE)
2783 return getTrue(ITy);
2784 }
2785
2786 // x >=u x >> y
2787 // x >=u x udiv y.
2788 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2789 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2790 // icmp pred X, (X op Y)
2791 if (Pred == ICmpInst::ICMP_ULT)
2792 return getFalse(ITy);
2793 if (Pred == ICmpInst::ICMP_UGE)
2794 return getTrue(ITy);
2795 }
2796
2797 // handle:
2798 // CI2 << X == CI
2799 // CI2 << X != CI
2800 //
2801 // where CI2 is a power of 2 and CI isn't
2802 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2803 const APInt *CI2Val, *CIVal = &CI->getValue();
2804 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2805 CI2Val->isPowerOf2()) {
2806 if (!CIVal->isPowerOf2()) {
2807 // CI2 << X can equal zero in some circumstances,
2808 // this simplification is unsafe if CI is zero.
2809 //
2810 // We know it is safe if:
2811 // - The shift is nsw, we can't shift out the one bit.
2812 // - The shift is nuw, we can't shift out the one bit.
2813 // - CI2 is one
2814 // - CI isn't zero
2815 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2816 *CI2Val == 1 || !CI->isZero()) {
2817 if (Pred == ICmpInst::ICMP_EQ)
2818 return ConstantInt::getFalse(RHS->getContext());
2819 if (Pred == ICmpInst::ICMP_NE)
2820 return ConstantInt::getTrue(RHS->getContext());
2821 }
2822 }
Craig Topperbcfd2d12017-04-20 16:56:25 +00002823 if (CIVal->isSignMask() && *CI2Val == 1) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002824 if (Pred == ICmpInst::ICMP_UGT)
2825 return ConstantInt::getFalse(RHS->getContext());
2826 if (Pred == ICmpInst::ICMP_ULE)
2827 return ConstantInt::getTrue(RHS->getContext());
2828 }
2829 }
2830 }
2831
2832 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2833 LBO->getOperand(1) == RBO->getOperand(1)) {
2834 switch (LBO->getOpcode()) {
2835 default:
2836 break;
2837 case Instruction::UDiv:
2838 case Instruction::LShr:
2839 if (ICmpInst::isSigned(Pred))
2840 break;
2841 LLVM_FALLTHROUGH;
2842 case Instruction::SDiv:
2843 case Instruction::AShr:
2844 if (!LBO->isExact() || !RBO->isExact())
2845 break;
2846 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2847 RBO->getOperand(0), Q, MaxRecurse - 1))
2848 return V;
2849 break;
2850 case Instruction::Shl: {
2851 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2852 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2853 if (!NUW && !NSW)
2854 break;
2855 if (!NSW && ICmpInst::isSigned(Pred))
2856 break;
2857 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2858 RBO->getOperand(0), Q, MaxRecurse - 1))
2859 return V;
2860 break;
2861 }
2862 }
2863 }
2864 return nullptr;
2865}
2866
Sanjay Patel35289c62016-12-10 17:40:47 +00002867/// Simplify integer comparisons where at least one operand of the compare
2868/// matches an integer min/max idiom.
2869static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002870 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00002871 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002872 Type *ITy = GetCompareTy(LHS); // The return type.
2873 Value *A, *B;
2874 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2875 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2876
2877 // Signed variants on "max(a,b)>=a -> true".
2878 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2879 if (A != RHS)
2880 std::swap(A, B); // smax(A, B) pred A.
2881 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2882 // We analyze this as smax(A, B) pred A.
2883 P = Pred;
2884 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2885 (A == LHS || B == LHS)) {
2886 if (A != LHS)
2887 std::swap(A, B); // A pred smax(A, B).
2888 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2889 // We analyze this as smax(A, B) swapped-pred A.
2890 P = CmpInst::getSwappedPredicate(Pred);
2891 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2892 (A == RHS || B == RHS)) {
2893 if (A != RHS)
2894 std::swap(A, B); // smin(A, B) pred A.
2895 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2896 // We analyze this as smax(-A, -B) swapped-pred -A.
2897 // Note that we do not need to actually form -A or -B thanks to EqP.
2898 P = CmpInst::getSwappedPredicate(Pred);
2899 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2900 (A == LHS || B == LHS)) {
2901 if (A != LHS)
2902 std::swap(A, B); // A pred smin(A, B).
2903 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2904 // We analyze this as smax(-A, -B) pred -A.
2905 // Note that we do not need to actually form -A or -B thanks to EqP.
2906 P = Pred;
2907 }
2908 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2909 // Cases correspond to "max(A, B) p A".
2910 switch (P) {
2911 default:
2912 break;
2913 case CmpInst::ICMP_EQ:
2914 case CmpInst::ICMP_SLE:
2915 // Equivalent to "A EqP B". This may be the same as the condition tested
2916 // in the max/min; if so, we can just return that.
2917 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2918 return V;
2919 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2920 return V;
2921 // Otherwise, see if "A EqP B" simplifies.
2922 if (MaxRecurse)
2923 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2924 return V;
2925 break;
2926 case CmpInst::ICMP_NE:
2927 case CmpInst::ICMP_SGT: {
2928 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2929 // Equivalent to "A InvEqP B". This may be the same as the condition
2930 // tested in the max/min; if so, we can just return that.
2931 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2932 return V;
2933 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2934 return V;
2935 // Otherwise, see if "A InvEqP B" simplifies.
2936 if (MaxRecurse)
2937 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2938 return V;
2939 break;
2940 }
2941 case CmpInst::ICMP_SGE:
2942 // Always true.
2943 return getTrue(ITy);
2944 case CmpInst::ICMP_SLT:
2945 // Always false.
2946 return getFalse(ITy);
2947 }
2948 }
2949
2950 // Unsigned variants on "max(a,b)>=a -> true".
2951 P = CmpInst::BAD_ICMP_PREDICATE;
2952 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2953 if (A != RHS)
2954 std::swap(A, B); // umax(A, B) pred A.
2955 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2956 // We analyze this as umax(A, B) pred A.
2957 P = Pred;
2958 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2959 (A == LHS || B == LHS)) {
2960 if (A != LHS)
2961 std::swap(A, B); // A pred umax(A, B).
2962 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2963 // We analyze this as umax(A, B) swapped-pred A.
2964 P = CmpInst::getSwappedPredicate(Pred);
2965 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2966 (A == RHS || B == RHS)) {
2967 if (A != RHS)
2968 std::swap(A, B); // umin(A, B) pred A.
2969 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2970 // We analyze this as umax(-A, -B) swapped-pred -A.
2971 // Note that we do not need to actually form -A or -B thanks to EqP.
2972 P = CmpInst::getSwappedPredicate(Pred);
2973 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2974 (A == LHS || B == LHS)) {
2975 if (A != LHS)
2976 std::swap(A, B); // A pred umin(A, B).
2977 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2978 // We analyze this as umax(-A, -B) pred -A.
2979 // Note that we do not need to actually form -A or -B thanks to EqP.
2980 P = Pred;
2981 }
2982 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2983 // Cases correspond to "max(A, B) p A".
2984 switch (P) {
2985 default:
2986 break;
2987 case CmpInst::ICMP_EQ:
2988 case CmpInst::ICMP_ULE:
2989 // Equivalent to "A EqP B". This may be the same as the condition tested
2990 // in the max/min; if so, we can just return that.
2991 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2992 return V;
2993 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2994 return V;
2995 // Otherwise, see if "A EqP B" simplifies.
2996 if (MaxRecurse)
2997 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2998 return V;
2999 break;
3000 case CmpInst::ICMP_NE:
3001 case CmpInst::ICMP_UGT: {
3002 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3003 // Equivalent to "A InvEqP B". This may be the same as the condition
3004 // tested in the max/min; if so, we can just return that.
3005 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3006 return V;
3007 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3008 return V;
3009 // Otherwise, see if "A InvEqP B" simplifies.
3010 if (MaxRecurse)
3011 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3012 return V;
3013 break;
3014 }
3015 case CmpInst::ICMP_UGE:
3016 // Always true.
3017 return getTrue(ITy);
3018 case CmpInst::ICMP_ULT:
3019 // Always false.
3020 return getFalse(ITy);
3021 }
3022 }
3023
3024 // Variants on "max(x,y) >= min(x,z)".
3025 Value *C, *D;
3026 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3027 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3028 (A == C || A == D || B == C || B == D)) {
3029 // max(x, ?) pred min(x, ?).
3030 if (Pred == CmpInst::ICMP_SGE)
3031 // Always true.
3032 return getTrue(ITy);
3033 if (Pred == CmpInst::ICMP_SLT)
3034 // Always false.
3035 return getFalse(ITy);
3036 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3037 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3038 (A == C || A == D || B == C || B == D)) {
3039 // min(x, ?) pred max(x, ?).
3040 if (Pred == CmpInst::ICMP_SLE)
3041 // Always true.
3042 return getTrue(ITy);
3043 if (Pred == CmpInst::ICMP_SGT)
3044 // Always false.
3045 return getFalse(ITy);
3046 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3047 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3048 (A == C || A == D || B == C || B == D)) {
3049 // max(x, ?) pred min(x, ?).
3050 if (Pred == CmpInst::ICMP_UGE)
3051 // Always true.
3052 return getTrue(ITy);
3053 if (Pred == CmpInst::ICMP_ULT)
3054 // Always false.
3055 return getFalse(ITy);
3056 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3057 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3058 (A == C || A == D || B == C || B == D)) {
3059 // min(x, ?) pred max(x, ?).
3060 if (Pred == CmpInst::ICMP_ULE)
3061 // Always true.
3062 return getTrue(ITy);
3063 if (Pred == CmpInst::ICMP_UGT)
3064 // Always false.
3065 return getFalse(ITy);
3066 }
3067
3068 return nullptr;
3069}
3070
Sanjay Patel472cc782016-01-11 22:14:42 +00003071/// Given operands for an ICmpInst, see if we can fold the result.
3072/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003073static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003074 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003075 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003076 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003077
Chris Lattnera71e9d62009-11-10 00:55:12 +00003078 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003079 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003080 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003081
3082 // If we have a constant, make sure it is on the RHS.
3083 std::swap(LHS, RHS);
3084 Pred = CmpInst::getSwappedPredicate(Pred);
3085 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003086
Chris Lattner229907c2011-07-18 04:54:35 +00003087 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003088
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003089 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00003090 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
3091 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00003092 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003093 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003094
Sanjay Pateldc65a272016-12-03 17:30:22 +00003095 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3096 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003097
Sanjay Pateldc65a272016-12-03 17:30:22 +00003098 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3099 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003100
Sanjay Patel67bde282016-08-22 23:12:02 +00003101 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3102 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003103
Chen Li7452d952015-09-26 03:26:47 +00003104 // If both operands have range metadata, use the metadata
3105 // to simplify the comparison.
3106 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003107 auto RHS_Instr = cast<Instruction>(RHS);
3108 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003109
3110 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3111 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003112 auto RHS_CR = getConstantRangeFromMetadata(
3113 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3114 auto LHS_CR = getConstantRangeFromMetadata(
3115 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003116
3117 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3118 if (Satisfied_CR.contains(LHS_CR))
3119 return ConstantInt::getTrue(RHS->getContext());
3120
3121 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3122 CmpInst::getInversePredicate(Pred), RHS_CR);
3123 if (InversedSatisfied_CR.contains(LHS_CR))
3124 return ConstantInt::getFalse(RHS->getContext());
3125 }
3126 }
3127
Duncan Sands8fb2c382011-01-20 13:21:55 +00003128 // Compare of cast, for example (zext X) != 0 -> X != 0
3129 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3130 Instruction *LI = cast<CastInst>(LHS);
3131 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003132 Type *SrcTy = SrcOp->getType();
3133 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003134
3135 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3136 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003137 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3138 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003139 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3140 // Transfer the cast to the constant.
3141 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3142 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003143 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003144 return V;
3145 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3146 if (RI->getOperand(0)->getType() == SrcTy)
3147 // Compare without the cast.
3148 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003149 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003150 return V;
3151 }
3152 }
3153
3154 if (isa<ZExtInst>(LHS)) {
3155 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3156 // same type.
3157 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3158 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3159 // Compare X and Y. Note that signed predicates become unsigned.
3160 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003161 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003162 MaxRecurse-1))
3163 return V;
3164 }
3165 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3166 // too. If not, then try to deduce the result of the comparison.
3167 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3168 // Compute the constant that would happen if we truncated to SrcTy then
3169 // reextended to DstTy.
3170 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3171 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3172
3173 // If the re-extended constant didn't change then this is effectively
3174 // also a case of comparing two zero-extended values.
3175 if (RExt == CI && MaxRecurse)
3176 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003177 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003178 return V;
3179
3180 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3181 // there. Use this to work out the result of the comparison.
3182 if (RExt != CI) {
3183 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003184 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003185 // LHS <u RHS.
3186 case ICmpInst::ICMP_EQ:
3187 case ICmpInst::ICMP_UGT:
3188 case ICmpInst::ICMP_UGE:
3189 return ConstantInt::getFalse(CI->getContext());
3190
3191 case ICmpInst::ICMP_NE:
3192 case ICmpInst::ICMP_ULT:
3193 case ICmpInst::ICMP_ULE:
3194 return ConstantInt::getTrue(CI->getContext());
3195
3196 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3197 // is non-negative then LHS <s RHS.
3198 case ICmpInst::ICMP_SGT:
3199 case ICmpInst::ICMP_SGE:
3200 return CI->getValue().isNegative() ?
3201 ConstantInt::getTrue(CI->getContext()) :
3202 ConstantInt::getFalse(CI->getContext());
3203
3204 case ICmpInst::ICMP_SLT:
3205 case ICmpInst::ICMP_SLE:
3206 return CI->getValue().isNegative() ?
3207 ConstantInt::getFalse(CI->getContext()) :
3208 ConstantInt::getTrue(CI->getContext());
3209 }
3210 }
3211 }
3212 }
3213
3214 if (isa<SExtInst>(LHS)) {
3215 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3216 // same type.
3217 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3218 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3219 // Compare X and Y. Note that the predicate does not change.
3220 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003221 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003222 return V;
3223 }
3224 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3225 // too. If not, then try to deduce the result of the comparison.
3226 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3227 // Compute the constant that would happen if we truncated to SrcTy then
3228 // reextended to DstTy.
3229 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3230 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3231
3232 // If the re-extended constant didn't change then this is effectively
3233 // also a case of comparing two sign-extended values.
3234 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003235 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003236 return V;
3237
3238 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3239 // bits there. Use this to work out the result of the comparison.
3240 if (RExt != CI) {
3241 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003242 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003243 case ICmpInst::ICMP_EQ:
3244 return ConstantInt::getFalse(CI->getContext());
3245 case ICmpInst::ICMP_NE:
3246 return ConstantInt::getTrue(CI->getContext());
3247
3248 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3249 // LHS >s RHS.
3250 case ICmpInst::ICMP_SGT:
3251 case ICmpInst::ICMP_SGE:
3252 return CI->getValue().isNegative() ?
3253 ConstantInt::getTrue(CI->getContext()) :
3254 ConstantInt::getFalse(CI->getContext());
3255 case ICmpInst::ICMP_SLT:
3256 case ICmpInst::ICMP_SLE:
3257 return CI->getValue().isNegative() ?
3258 ConstantInt::getFalse(CI->getContext()) :
3259 ConstantInt::getTrue(CI->getContext());
3260
3261 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3262 // LHS >u RHS.
3263 case ICmpInst::ICMP_UGT:
3264 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003265 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003266 if (MaxRecurse)
3267 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3268 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003269 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003270 return V;
3271 break;
3272 case ICmpInst::ICMP_ULT:
3273 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003274 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003275 if (MaxRecurse)
3276 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3277 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003278 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003279 return V;
3280 break;
3281 }
3282 }
3283 }
3284 }
3285 }
3286
James Molloy1d88d6f2015-10-22 13:18:42 +00003287 // icmp eq|ne X, Y -> false|true if X != Y
3288 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003289 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
James Molloy1d88d6f2015-10-22 13:18:42 +00003290 LLVMContext &Ctx = LHS->getType()->getContext();
3291 return Pred == ICmpInst::ICMP_NE ?
3292 ConstantInt::getTrue(Ctx) : ConstantInt::getFalse(Ctx);
3293 }
Junmo Park53470fc2016-04-05 21:14:31 +00003294
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003295 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3296 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003297
Sanjay Patel35289c62016-12-10 17:40:47 +00003298 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003299 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003300
Chandler Carruth8059c842012-03-25 21:28:14 +00003301 // Simplify comparisons of related pointers using a powerful, recursive
3302 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003303 if (LHS->getType()->isPointerTy())
Anna Thomas43d7e1c2016-05-03 14:58:21 +00003304 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI, LHS, RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003305 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003306 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3307 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3308 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3309 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3310 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3311 Q.DL.getTypeSizeInBits(CRHS->getType()))
3312 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI,
3313 CLHS->getPointerOperand(),
3314 CRHS->getPointerOperand()))
3315 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003316
Nick Lewycky3db143e2012-02-26 02:09:49 +00003317 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3318 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3319 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3320 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3321 (ICmpInst::isEquality(Pred) ||
3322 (GLHS->isInBounds() && GRHS->isInBounds() &&
3323 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3324 // The bases are equal and the indices are constant. Build a constant
3325 // expression GEP with the same indices and a null base pointer to see
3326 // what constant folding can make out of it.
3327 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3328 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003329 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3330 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003331
3332 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003333 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3334 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003335 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3336 }
3337 }
3338 }
3339
David Majnemer5854e9f2014-11-16 02:20:08 +00003340 // If a bit is known to be zero for A and known to be one for B,
3341 // then A and B cannot be equal.
3342 if (ICmpInst::isEquality(Pred)) {
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003343 const APInt *RHSVal;
3344 if (match(RHS, m_APInt(RHSVal))) {
3345 unsigned BitWidth = RHSVal->getBitWidth();
Craig Topperb45eabc2017-04-26 16:39:58 +00003346 KnownBits LHSKnown(BitWidth);
3347 computeKnownBits(LHS, LHSKnown, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
3348 if (LHSKnown.Zero.intersects(*RHSVal) ||
3349 !LHSKnown.One.isSubsetOf(*RHSVal))
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003350 return Pred == ICmpInst::ICMP_EQ ? ConstantInt::getFalse(ITy)
3351 : ConstantInt::getTrue(ITy);
David Majnemer5854e9f2014-11-16 02:20:08 +00003352 }
3353 }
3354
Duncan Sandsf532d312010-11-07 16:12:23 +00003355 // If the comparison is with the result of a select instruction, check whether
3356 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003357 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003358 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003359 return V;
3360
3361 // If the comparison is with the result of a phi instruction, check whether
3362 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003363 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003364 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003365 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003366
Craig Topper9f008862014-04-15 04:59:12 +00003367 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003368}
3369
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003370Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003371 const SimplifyQuery &Q) {
3372 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3373}
3374
Sanjay Patel472cc782016-01-11 22:14:42 +00003375/// Given operands for an FCmpInst, see if we can fold the result.
3376/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003377static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003378 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003379 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003380 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3381 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3382
Chris Lattnera71e9d62009-11-10 00:55:12 +00003383 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003384 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003385 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003386
Chris Lattnera71e9d62009-11-10 00:55:12 +00003387 // If we have a constant, make sure it is on the RHS.
3388 std::swap(LHS, RHS);
3389 Pred = CmpInst::getSwappedPredicate(Pred);
3390 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003391
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003392 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003393 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003394 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003395 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003396 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003397 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003398
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003399 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3400 if (FMF.noNaNs()) {
3401 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003402 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003403 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003404 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003405 }
3406
Mehdi Aminieb242a52015-03-09 03:20:25 +00003407 // fcmp pred x, undef and fcmp pred undef, x
3408 // fold to true if unordered, false if ordered
3409 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3410 // Choosing NaN for the undef will always make unordered comparison succeed
3411 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003412 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003413 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003414
3415 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003416 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003417 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003418 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003419 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003420 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003421 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003422
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003423 // Handle fcmp with constant RHS
David Majnemer3ee5f342016-04-13 06:55:52 +00003424 const ConstantFP *CFP = nullptr;
3425 if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3426 if (RHS->getType()->isVectorTy())
3427 CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3428 else
3429 CFP = dyn_cast<ConstantFP>(RHSC);
3430 }
3431 if (CFP) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003432 // If the constant is a nan, see if we can fold the comparison based on it.
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003433 if (CFP->getValueAPF().isNaN()) {
3434 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003435 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003436 assert(FCmpInst::isUnordered(Pred) &&
3437 "Comparison must be either ordered or unordered!");
3438 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003439 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003440 }
3441 // Check whether the constant is an infinity.
3442 if (CFP->getValueAPF().isInfinity()) {
3443 if (CFP->getValueAPF().isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003444 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003445 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003446 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003447 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003448 case FCmpInst::FCMP_UGE:
3449 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003450 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003451 default:
3452 break;
3453 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003454 } else {
3455 switch (Pred) {
3456 case FCmpInst::FCMP_OGT:
3457 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003458 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003459 case FCmpInst::FCMP_ULE:
3460 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003461 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003462 default:
3463 break;
3464 }
3465 }
3466 }
3467 if (CFP->getValueAPF().isZero()) {
3468 switch (Pred) {
3469 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003470 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003471 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003472 break;
3473 case FCmpInst::FCMP_OLT:
3474 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003475 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003476 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003477 break;
3478 default:
3479 break;
3480 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003481 }
3482 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003483
Duncan Sandsa620bd12010-11-07 16:46:25 +00003484 // If the comparison is with the result of a select instruction, check whether
3485 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003486 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003487 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003488 return V;
3489
3490 // If the comparison is with the result of a phi instruction, check whether
3491 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003492 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003493 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003494 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003495
Craig Topper9f008862014-04-15 04:59:12 +00003496 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003497}
3498
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003499Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003500 FastMathFlags FMF, const SimplifyQuery &Q) {
3501 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003502}
3503
Sanjay Patel472cc782016-01-11 22:14:42 +00003504/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003505static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003506 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003507 unsigned MaxRecurse) {
3508 // Trivial replacement.
3509 if (V == Op)
3510 return RepOp;
3511
3512 auto *I = dyn_cast<Instruction>(V);
3513 if (!I)
3514 return nullptr;
3515
3516 // If this is a binary operator, try to simplify it with the replaced op.
3517 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3518 // Consider:
3519 // %cmp = icmp eq i32 %x, 2147483647
3520 // %add = add nsw i32 %x, 1
3521 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3522 //
3523 // We can't replace %sel with %add unless we strip away the flags.
3524 if (isa<OverflowingBinaryOperator>(B))
3525 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3526 return nullptr;
3527 if (isa<PossiblyExactOperator>(B))
3528 if (B->isExact())
3529 return nullptr;
3530
3531 if (MaxRecurse) {
3532 if (B->getOperand(0) == Op)
3533 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3534 MaxRecurse - 1);
3535 if (B->getOperand(1) == Op)
3536 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3537 MaxRecurse - 1);
3538 }
3539 }
3540
3541 // Same for CmpInsts.
3542 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3543 if (MaxRecurse) {
3544 if (C->getOperand(0) == Op)
3545 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3546 MaxRecurse - 1);
3547 if (C->getOperand(1) == Op)
3548 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3549 MaxRecurse - 1);
3550 }
3551 }
3552
3553 // TODO: We could hand off more cases to instsimplify here.
3554
3555 // If all operands are constant after substituting Op for RepOp then we can
3556 // constant fold the instruction.
3557 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3558 // Build a list of all constant operands.
3559 SmallVector<Constant *, 8> ConstOps;
3560 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3561 if (I->getOperand(i) == Op)
3562 ConstOps.push_back(CRepOp);
3563 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3564 ConstOps.push_back(COp);
3565 else
3566 break;
3567 }
3568
3569 // All operands were constants, fold it.
3570 if (ConstOps.size() == I->getNumOperands()) {
3571 if (CmpInst *C = dyn_cast<CmpInst>(I))
3572 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3573 ConstOps[1], Q.DL, Q.TLI);
3574
3575 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3576 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003577 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003578
Manuel Jacobe9024592016-01-21 06:33:22 +00003579 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003580 }
3581 }
3582
3583 return nullptr;
3584}
3585
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003586/// Try to simplify a select instruction when its condition operand is an
3587/// integer comparison where one operand of the compare is a constant.
3588static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3589 const APInt *Y, bool TrueWhenUnset) {
3590 const APInt *C;
3591
3592 // (X & Y) == 0 ? X & ~Y : X --> X
3593 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3594 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3595 *Y == ~*C)
3596 return TrueWhenUnset ? FalseVal : TrueVal;
3597
3598 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3599 // (X & Y) != 0 ? X : X & ~Y --> X
3600 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3601 *Y == ~*C)
3602 return TrueWhenUnset ? FalseVal : TrueVal;
3603
3604 if (Y->isPowerOf2()) {
3605 // (X & Y) == 0 ? X | Y : X --> X | Y
3606 // (X & Y) != 0 ? X | Y : X --> X
3607 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3608 *Y == *C)
3609 return TrueWhenUnset ? TrueVal : FalseVal;
3610
3611 // (X & Y) == 0 ? X : X | Y --> X
3612 // (X & Y) != 0 ? X : X | Y --> X | Y
3613 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3614 *Y == *C)
3615 return TrueWhenUnset ? TrueVal : FalseVal;
3616 }
Matt Arsenault82606662017-01-11 00:57:54 +00003617
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003618 return nullptr;
3619}
3620
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003621/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3622/// eq/ne.
3623static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *TrueVal,
3624 Value *FalseVal,
3625 bool TrueWhenUnset) {
3626 unsigned BitWidth = TrueVal->getType()->getScalarSizeInBits();
Sanjay Patele9fc79b2016-07-21 21:56:00 +00003627 if (!BitWidth)
3628 return nullptr;
Matt Arsenault82606662017-01-11 00:57:54 +00003629
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003630 APInt MinSignedValue;
3631 Value *X;
3632 if (match(CmpLHS, m_Trunc(m_Value(X))) && (X == TrueVal || X == FalseVal)) {
3633 // icmp slt (trunc X), 0 <--> icmp ne (and X, C), 0
3634 // icmp sgt (trunc X), -1 <--> icmp eq (and X, C), 0
3635 unsigned DestSize = CmpLHS->getType()->getScalarSizeInBits();
3636 MinSignedValue = APInt::getSignedMinValue(DestSize).zext(BitWidth);
3637 } else {
3638 // icmp slt X, 0 <--> icmp ne (and X, C), 0
3639 // icmp sgt X, -1 <--> icmp eq (and X, C), 0
3640 X = CmpLHS;
3641 MinSignedValue = APInt::getSignedMinValue(BitWidth);
3642 }
3643
3644 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, &MinSignedValue,
3645 TrueWhenUnset))
3646 return V;
3647
3648 return nullptr;
3649}
3650
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003651/// Try to simplify a select instruction when its condition operand is an
3652/// integer comparison.
3653static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003654 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003655 unsigned MaxRecurse) {
3656 ICmpInst::Predicate Pred;
3657 Value *CmpLHS, *CmpRHS;
3658 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3659 return nullptr;
3660
Sanjay Patel5f3c7032016-07-20 23:40:01 +00003661 // FIXME: This code is nearly duplicated in InstCombine. Using/refactoring
3662 // decomposeBitTestICmp() might help.
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003663 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3664 Value *X;
3665 const APInt *Y;
3666 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3667 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3668 Pred == ICmpInst::ICMP_EQ))
3669 return V;
3670 } else if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, m_Zero())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003671 // Comparing signed-less-than 0 checks if the sign bit is set.
3672 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3673 false))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003674 return V;
3675 } else if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, m_AllOnes())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003676 // Comparing signed-greater-than -1 checks if the sign bit is not set.
3677 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3678 true))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003679 return V;
3680 }
3681
3682 if (CondVal->hasOneUse()) {
3683 const APInt *C;
3684 if (match(CmpRHS, m_APInt(C))) {
3685 // X < MIN ? T : F --> F
3686 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3687 return FalseVal;
3688 // X < MIN ? T : F --> F
3689 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3690 return FalseVal;
3691 // X > MAX ? T : F --> F
3692 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3693 return FalseVal;
3694 // X > MAX ? T : F --> F
3695 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3696 return FalseVal;
3697 }
3698 }
3699
3700 // If we have an equality comparison, then we know the value in one of the
3701 // arms of the select. See if substituting this value into the arm and
3702 // simplifying the result yields the same value as the other arm.
3703 if (Pred == ICmpInst::ICMP_EQ) {
3704 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3705 TrueVal ||
3706 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3707 TrueVal)
3708 return FalseVal;
3709 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3710 FalseVal ||
3711 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3712 FalseVal)
3713 return FalseVal;
3714 } else if (Pred == ICmpInst::ICMP_NE) {
3715 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3716 FalseVal ||
3717 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3718 FalseVal)
3719 return TrueVal;
3720 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3721 TrueVal ||
3722 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3723 TrueVal)
3724 return TrueVal;
3725 }
3726
3727 return nullptr;
3728}
3729
Sanjay Patel472cc782016-01-11 22:14:42 +00003730/// Given operands for a SelectInst, see if we can fold the result.
3731/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003732static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003733 Value *FalseVal, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003734 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003735 // select true, X, Y -> X
3736 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003737 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3738 if (CB->isAllOnesValue())
3739 return TrueVal;
3740 if (CB->isNullValue())
3741 return FalseVal;
3742 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003743
Chris Lattnerc707fa92010-04-20 05:32:14 +00003744 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003745 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003746 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003747
Chris Lattnerc707fa92010-04-20 05:32:14 +00003748 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
Daniel Berlin4d0fe642017-04-28 19:55:38 +00003749 if (isa<Constant>(FalseVal))
3750 return FalseVal;
3751 return TrueVal;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003752 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003753 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3754 return FalseVal;
3755 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3756 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003757
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003758 if (Value *V =
3759 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3760 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003761
Craig Topper9f008862014-04-15 04:59:12 +00003762 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003763}
3764
Duncan Sandsb8cee002012-03-13 11:42:19 +00003765Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003766 const SimplifyQuery &Q) {
3767 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003768}
3769
Sanjay Patel472cc782016-01-11 22:14:42 +00003770/// Given operands for an GetElementPtrInst, see if we can fold the result.
3771/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003772static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003773 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003774 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003775 unsigned AS =
3776 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003777
Chris Lattner8574aba2009-11-27 00:29:05 +00003778 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003779 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003780 return Ops[0];
3781
Nico Weber48c82402014-08-27 20:06:19 +00003782 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003783 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003784 Type *GEPTy = PointerType::get(LastType, AS);
3785 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3786 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003787 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3788 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003789
3790 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003791 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003792
Jay Foadb992a632011-07-19 15:07:52 +00003793 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003794 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003795 if (match(Ops[1], m_Zero()))
3796 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003797
David Blaikie4a2e73b2015-04-02 18:55:32 +00003798 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003799 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003800 Value *P;
3801 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003802 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003803 // getelementptr P, N -> P if P points to a type of zero size.
3804 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003805 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003806
3807 // The following transforms are only safe if the ptrtoint cast
3808 // doesn't truncate the pointers.
3809 if (Ops[1]->getType()->getScalarSizeInBits() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003810 Q.DL.getPointerSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003811 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3812 if (match(P, m_Zero()))
3813 return Constant::getNullValue(GEPTy);
3814 Value *Temp;
3815 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003816 if (Temp->getType() == GEPTy)
3817 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003818 return nullptr;
3819 };
3820
3821 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3822 if (TyAllocSize == 1 &&
3823 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3824 if (Value *R = PtrToIntOrZero(P))
3825 return R;
3826
3827 // getelementptr V, (ashr (sub P, V), C) -> Q
3828 // if P points to a type of size 1 << C.
3829 if (match(Ops[1],
3830 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3831 m_ConstantInt(C))) &&
3832 TyAllocSize == 1ULL << C)
3833 if (Value *R = PtrToIntOrZero(P))
3834 return R;
3835
3836 // getelementptr V, (sdiv (sub P, V), C) -> Q
3837 // if P points to a type of size C.
3838 if (match(Ops[1],
3839 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3840 m_SpecificInt(TyAllocSize))))
3841 if (Value *R = PtrToIntOrZero(P))
3842 return R;
3843 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003844 }
3845 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003846
David Majnemerd1501372016-08-07 07:58:12 +00003847 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3848 all_of(Ops.slice(1).drop_back(1),
3849 [](Value *Idx) { return match(Idx, m_Zero()); })) {
3850 unsigned PtrWidth =
3851 Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3852 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3853 APInt BasePtrOffset(PtrWidth, 0);
3854 Value *StrippedBasePtr =
3855 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3856 BasePtrOffset);
3857
David Majnemer5c5df622016-08-16 06:13:46 +00003858 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003859 if (match(Ops.back(),
3860 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3861 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3862 return ConstantExpr::getIntToPtr(CI, GEPTy);
3863 }
David Majnemer5c5df622016-08-16 06:13:46 +00003864 // gep (gep V, C), (xor V, -1) -> C-1
3865 if (match(Ops.back(),
3866 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3867 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3868 return ConstantExpr::getIntToPtr(CI, GEPTy);
3869 }
David Majnemerd1501372016-08-07 07:58:12 +00003870 }
3871 }
3872
Chris Lattner8574aba2009-11-27 00:29:05 +00003873 // Check to see if this is constant foldable.
Jay Foadb992a632011-07-19 15:07:52 +00003874 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Chris Lattner8574aba2009-11-27 00:29:05 +00003875 if (!isa<Constant>(Ops[i]))
Craig Topper9f008862014-04-15 04:59:12 +00003876 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003877
David Blaikie4a2e73b2015-04-02 18:55:32 +00003878 return ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3879 Ops.slice(1));
Chris Lattner8574aba2009-11-27 00:29:05 +00003880}
3881
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003882Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003883 const SimplifyQuery &Q) {
3884 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003885}
3886
Sanjay Patel472cc782016-01-11 22:14:42 +00003887/// Given operands for an InsertValueInst, see if we can fold the result.
3888/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003889static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003890 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003891 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003892 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3893 if (Constant *CVal = dyn_cast<Constant>(Val))
3894 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3895
3896 // insertvalue x, undef, n -> x
3897 if (match(Val, m_Undef()))
3898 return Agg;
3899
3900 // insertvalue x, (extractvalue y, n), n
3901 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003902 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3903 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003904 // insertvalue undef, (extractvalue y, n), n -> y
3905 if (match(Agg, m_Undef()))
3906 return EV->getAggregateOperand();
3907
3908 // insertvalue y, (extractvalue y, n), n -> y
3909 if (Agg == EV->getAggregateOperand())
3910 return Agg;
3911 }
3912
Craig Topper9f008862014-04-15 04:59:12 +00003913 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003914}
3915
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003916Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3917 ArrayRef<unsigned> Idxs,
3918 const SimplifyQuery &Q) {
3919 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3920}
3921
Sanjay Patel472cc782016-01-11 22:14:42 +00003922/// Given operands for an ExtractValueInst, see if we can fold the result.
3923/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003924static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003925 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00003926 if (auto *CAgg = dyn_cast<Constant>(Agg))
3927 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3928
3929 // extractvalue x, (insertvalue y, elt, n), n -> elt
3930 unsigned NumIdxs = Idxs.size();
3931 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3932 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3933 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3934 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3935 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3936 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3937 Idxs.slice(0, NumCommonIdxs)) {
3938 if (NumIdxs == NumInsertValueIdxs)
3939 return IVI->getInsertedValueOperand();
3940 break;
3941 }
3942 }
3943
3944 return nullptr;
3945}
3946
3947Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003948 const SimplifyQuery &Q) {
3949 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
3950}
3951
Sanjay Patel472cc782016-01-11 22:14:42 +00003952/// Given operands for an ExtractElementInst, see if we can fold the result.
3953/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003954static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00003955 unsigned) {
3956 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3957 if (auto *CIdx = dyn_cast<Constant>(Idx))
3958 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3959
3960 // The index is not relevant if our vector is a splat.
3961 if (auto *Splat = CVec->getSplatValue())
3962 return Splat;
3963
3964 if (isa<UndefValue>(Vec))
3965 return UndefValue::get(Vec->getType()->getVectorElementType());
3966 }
3967
3968 // If extracting a specified index from the vector, see if we can recursively
3969 // find a previously computed scalar that was inserted into the vector.
David Majnemer8e335ca2015-08-18 22:18:22 +00003970 if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3971 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
David Majnemer599ca442015-07-13 01:15:53 +00003972 return Elt;
David Majnemer599ca442015-07-13 01:15:53 +00003973
3974 return nullptr;
3975}
3976
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003977Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
3978 const SimplifyQuery &Q) {
3979 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
3980}
3981
Sanjay Patel472cc782016-01-11 22:14:42 +00003982/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003983static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003984 // If all of the PHI's incoming values are the same then replace the PHI node
3985 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00003986 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00003987 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00003988 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00003989 // If the incoming value is the phi node itself, it can safely be skipped.
3990 if (Incoming == PN) continue;
3991 if (isa<UndefValue>(Incoming)) {
3992 // Remember that we saw an undef value, but otherwise ignore them.
3993 HasUndefInput = true;
3994 continue;
3995 }
3996 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00003997 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00003998 CommonValue = Incoming;
3999 }
4000
4001 // If CommonValue is null then all of the incoming values were either undef or
4002 // equal to the phi node itself.
4003 if (!CommonValue)
4004 return UndefValue::get(PN->getType());
4005
4006 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4007 // instruction, we cannot return X as the result of the PHI node unless it
4008 // dominates the PHI block.
4009 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00004010 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004011
4012 return CommonValue;
4013}
4014
David Majnemer6774d612016-07-26 17:58:05 +00004015static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004016 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004017 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004018 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004019
David Majnemer6774d612016-07-26 17:58:05 +00004020 if (auto *CI = dyn_cast<CastInst>(Op)) {
4021 auto *Src = CI->getOperand(0);
4022 Type *SrcTy = Src->getType();
4023 Type *MidTy = CI->getType();
4024 Type *DstTy = Ty;
4025 if (Src->getType() == Ty) {
4026 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4027 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4028 Type *SrcIntPtrTy =
4029 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4030 Type *MidIntPtrTy =
4031 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4032 Type *DstIntPtrTy =
4033 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4034 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4035 SrcIntPtrTy, MidIntPtrTy,
4036 DstIntPtrTy) == Instruction::BitCast)
4037 return Src;
4038 }
4039 }
David Majnemera90a6212016-07-26 05:52:29 +00004040
4041 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004042 if (CastOpc == Instruction::BitCast)
4043 if (Op->getType() == Ty)
4044 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004045
4046 return nullptr;
4047}
4048
David Majnemer6774d612016-07-26 17:58:05 +00004049Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004050 const SimplifyQuery &Q) {
4051 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4052}
4053
Sanjay Patela3c297d2017-04-19 16:48:22 +00004054/// For the given destination element of a shuffle, peek through shuffles to
4055/// match a root vector source operand that contains that element in the same
4056/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4057static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004058 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004059 unsigned MaxRecurse) {
4060 if (!MaxRecurse--)
4061 return nullptr;
4062
4063 // Bail out if any mask value is undefined. That kind of shuffle may be
4064 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004065 if (MaskVal == -1)
4066 return nullptr;
4067
4068 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004069 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004070 int RootElt = MaskVal;
4071 Value *SourceOp = Op0;
4072 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004073 RootElt = MaskVal - InVecNumElts;
4074 SourceOp = Op1;
4075 }
4076
4077 // If the source operand is a shuffle itself, look through it to find the
4078 // matching root vector.
4079 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4080 return foldIdentityShuffles(
4081 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004082 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004083 }
4084
4085 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4086 // size?
4087
4088 // The source operand is not a shuffle. Initialize the root vector value for
4089 // this shuffle if that has not been done yet.
4090 if (!RootVec)
4091 RootVec = SourceOp;
4092
4093 // Give up as soon as a source operand does not match the existing root value.
4094 if (RootVec != SourceOp)
4095 return nullptr;
4096
4097 // The element must be coming from the same lane in the source vector
4098 // (although it may have crossed lanes in intermediate shuffles).
4099 if (RootElt != DestElt)
4100 return nullptr;
4101
4102 return RootVec;
4103}
4104
Zvi Rackover8f460652017-04-03 22:05:30 +00004105static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004106 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004107 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004108 if (isa<UndefValue>(Mask))
4109 return UndefValue::get(RetTy);
4110
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004111 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004112 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004113 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004114
Zvi Rackover0411e462017-04-30 06:10:54 +00004115 SmallVector<int, 32> Indices;
4116 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4117 assert(MaskNumElts == Indices.size() &&
4118 "Size of Indices not same as number of mask elements?");
4119
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004120 // Canonicalization: If mask does not select elements from an input vector,
4121 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004122 bool MaskSelects0 = false, MaskSelects1 = false;
4123 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004124 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004125 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004126 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004127 MaskSelects0 = true;
4128 else
4129 MaskSelects1 = true;
4130 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004131 if (!MaskSelects0)
4132 Op0 = UndefValue::get(InVecTy);
4133 if (!MaskSelects1)
4134 Op1 = UndefValue::get(InVecTy);
4135
4136 auto *Op0Const = dyn_cast<Constant>(Op0);
4137 auto *Op1Const = dyn_cast<Constant>(Op1);
4138
4139 // If all operands are constant, constant fold the shuffle.
4140 if (Op0Const && Op1Const)
4141 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4142
4143 // Canonicalization: if only one input vector is constant, it shall be the
4144 // second one.
4145 if (Op0Const && !Op1Const) {
4146 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004147 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004148 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004149
4150 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4151 // value type is same as the input vectors' type.
4152 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004153 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004154 OpShuf->getMask()->getSplatValue())
4155 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004156
Sanjay Patela3c297d2017-04-19 16:48:22 +00004157 // Don't fold a shuffle with undef mask elements. This may get folded in a
4158 // better way using demanded bits or other analysis.
4159 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004160 if (find(Indices, -1) != Indices.end())
4161 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004162
4163 // Check if every element of this shuffle can be mapped back to the
4164 // corresponding element of a single root vector. If so, we don't need this
4165 // shuffle. This handles simple identity shuffles as well as chains of
4166 // shuffles that may widen/narrow and/or move elements across lanes and back.
4167 Value *RootVec = nullptr;
4168 for (unsigned i = 0; i != MaskNumElts; ++i) {
4169 // Note that recursion is limited for each vector element, so if any element
4170 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004171 RootVec =
4172 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004173
4174 // We can't replace a widening/narrowing shuffle with one of its operands.
4175 if (!RootVec || RootVec->getType() != RetTy)
4176 return nullptr;
4177 }
4178 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004179}
4180
4181/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004182Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4183 Type *RetTy, const SimplifyQuery &Q) {
4184 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004185}
4186
Chris Lattnera71e9d62009-11-10 00:55:12 +00004187//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004188
Sanjay Patel472cc782016-01-11 22:14:42 +00004189/// Given operands for a BinaryOperator, see if we can fold the result.
4190/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004191static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004192 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004193 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004194 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004195 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004196 case Instruction::FAdd:
4197 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004198 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004199 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004200 case Instruction::FSub:
4201 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004202 case Instruction::Mul:
4203 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004204 case Instruction::FMul:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004205 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4206 case Instruction::SDiv:
4207 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4208 case Instruction::UDiv:
4209 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004210 case Instruction::FDiv:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004211 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4212 case Instruction::SRem:
4213 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4214 case Instruction::URem:
4215 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004216 case Instruction::FRem:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004217 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004218 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004219 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004220 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004221 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004222 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004223 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4224 case Instruction::And:
4225 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4226 case Instruction::Or:
4227 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4228 case Instruction::Xor:
4229 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004230 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004231 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004232 }
4233}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004234
Sanjay Patel472cc782016-01-11 22:14:42 +00004235/// Given operands for a BinaryOperator, see if we can fold the result.
4236/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004237/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4238/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4239static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004240 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004241 unsigned MaxRecurse) {
4242 switch (Opcode) {
4243 case Instruction::FAdd:
4244 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4245 case Instruction::FSub:
4246 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4247 case Instruction::FMul:
4248 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004249 case Instruction::FDiv:
4250 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004251 default:
4252 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4253 }
4254}
4255
Duncan Sands7e800d62010-11-14 11:23:23 +00004256Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004257 const SimplifyQuery &Q) {
4258 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4259}
4260
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004261Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004262 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004263 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4264}
4265
Sanjay Patel472cc782016-01-11 22:14:42 +00004266/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004267static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004268 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004269 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004270 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004271 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004272}
4273
4274Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004275 const SimplifyQuery &Q) {
4276 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4277}
4278
Michael Ilseman54857292013-02-07 19:26:05 +00004279static bool IsIdempotent(Intrinsic::ID ID) {
4280 switch (ID) {
4281 default: return false;
4282
4283 // Unary idempotent: f(f(x)) = f(x)
4284 case Intrinsic::fabs:
4285 case Intrinsic::floor:
4286 case Intrinsic::ceil:
4287 case Intrinsic::trunc:
4288 case Intrinsic::rint:
4289 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004290 case Intrinsic::round:
Michael Ilseman54857292013-02-07 19:26:05 +00004291 return true;
4292 }
4293}
4294
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004295static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4296 const DataLayout &DL) {
4297 GlobalValue *PtrSym;
4298 APInt PtrOffset;
4299 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4300 return nullptr;
4301
4302 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4303 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4304 Type *Int32PtrTy = Int32Ty->getPointerTo();
4305 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4306
4307 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4308 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4309 return nullptr;
4310
4311 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4312 if (OffsetInt % 4 != 0)
4313 return nullptr;
4314
4315 Constant *C = ConstantExpr::getGetElementPtr(
4316 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4317 ConstantInt::get(Int64Ty, OffsetInt / 4));
4318 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4319 if (!Loaded)
4320 return nullptr;
4321
4322 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4323 if (!LoadedCE)
4324 return nullptr;
4325
4326 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4327 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4328 if (!LoadedCE)
4329 return nullptr;
4330 }
4331
4332 if (LoadedCE->getOpcode() != Instruction::Sub)
4333 return nullptr;
4334
4335 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4336 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4337 return nullptr;
4338 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4339
4340 Constant *LoadedRHS = LoadedCE->getOperand(1);
4341 GlobalValue *LoadedRHSSym;
4342 APInt LoadedRHSOffset;
4343 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4344 DL) ||
4345 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4346 return nullptr;
4347
4348 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4349}
4350
David Majnemer17a95aa2016-07-14 06:58:37 +00004351static bool maskIsAllZeroOrUndef(Value *Mask) {
4352 auto *ConstMask = dyn_cast<Constant>(Mask);
4353 if (!ConstMask)
4354 return false;
4355 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4356 return true;
4357 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4358 ++I) {
4359 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4360 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4361 continue;
4362 return false;
4363 }
4364 return true;
4365}
4366
Michael Ilseman54857292013-02-07 19:26:05 +00004367template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004368static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004369 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004370 Intrinsic::ID IID = F->getIntrinsicID();
4371 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004372
4373 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004374 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004375 // Perform idempotent optimizations
4376 if (IsIdempotent(IID)) {
4377 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4378 if (II->getIntrinsicID() == IID)
4379 return II;
4380 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004381 }
4382
4383 switch (IID) {
4384 case Intrinsic::fabs: {
4385 if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4386 return *ArgBegin;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004387 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004388 }
4389 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004390 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004391 }
4392 }
Michael Ilseman54857292013-02-07 19:26:05 +00004393
Matt Arsenault82606662017-01-11 00:57:54 +00004394 // Binary Ops
4395 if (NumOperands == 2) {
4396 Value *LHS = *ArgBegin;
4397 Value *RHS = *(ArgBegin + 1);
4398 Type *ReturnType = F->getReturnType();
4399
4400 switch (IID) {
4401 case Intrinsic::usub_with_overflow:
4402 case Intrinsic::ssub_with_overflow: {
4403 // X - X -> { 0, false }
4404 if (LHS == RHS)
4405 return Constant::getNullValue(ReturnType);
4406
4407 // X - undef -> undef
4408 // undef - X -> undef
4409 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4410 return UndefValue::get(ReturnType);
4411
4412 return nullptr;
4413 }
4414 case Intrinsic::uadd_with_overflow:
4415 case Intrinsic::sadd_with_overflow: {
4416 // X + undef -> undef
4417 if (isa<UndefValue>(RHS))
4418 return UndefValue::get(ReturnType);
4419
4420 return nullptr;
4421 }
4422 case Intrinsic::umul_with_overflow:
4423 case Intrinsic::smul_with_overflow: {
4424 // X * 0 -> { 0, false }
4425 if (match(RHS, m_Zero()))
4426 return Constant::getNullValue(ReturnType);
4427
4428 // X * undef -> { 0, false }
4429 if (match(RHS, m_Undef()))
4430 return Constant::getNullValue(ReturnType);
4431
4432 return nullptr;
4433 }
4434 case Intrinsic::load_relative: {
4435 Constant *C0 = dyn_cast<Constant>(LHS);
4436 Constant *C1 = dyn_cast<Constant>(RHS);
4437 if (C0 && C1)
4438 return SimplifyRelativeLoad(C0, C1, Q.DL);
4439 return nullptr;
4440 }
4441 default:
4442 return nullptr;
4443 }
4444 }
4445
4446 // Simplify calls to llvm.masked.load.*
4447 switch (IID) {
4448 case Intrinsic::masked_load: {
4449 Value *MaskArg = ArgBegin[2];
4450 Value *PassthruArg = ArgBegin[3];
4451 // If the mask is all zeros or undef, the "passthru" argument is the result.
4452 if (maskIsAllZeroOrUndef(MaskArg))
4453 return PassthruArg;
4454 return nullptr;
4455 }
4456 default:
4457 return nullptr;
4458 }
Michael Ilseman54857292013-02-07 19:26:05 +00004459}
4460
Chandler Carruth9dc35582012-12-28 11:30:55 +00004461template <typename IterTy>
Chandler Carruthf6182152012-12-28 14:23:29 +00004462static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004463 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004464 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004465 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4466 Ty = PTy->getElementType();
4467 FunctionType *FTy = cast<FunctionType>(Ty);
4468
Dan Gohman85977e62011-11-04 18:32:42 +00004469 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004470 // call null -> undef
4471 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004472 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004473
Chandler Carruthf6182152012-12-28 14:23:29 +00004474 Function *F = dyn_cast<Function>(V);
4475 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004476 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004477
David Majnemer15032582015-05-22 03:56:46 +00004478 if (F->isIntrinsic())
4479 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004480 return Ret;
4481
Chandler Carruthf6182152012-12-28 14:23:29 +00004482 if (!canConstantFoldCallTo(F))
Craig Topper9f008862014-04-15 04:59:12 +00004483 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004484
4485 SmallVector<Constant *, 4> ConstantArgs;
4486 ConstantArgs.reserve(ArgEnd - ArgBegin);
4487 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4488 Constant *C = dyn_cast<Constant>(*I);
4489 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004490 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004491 ConstantArgs.push_back(C);
4492 }
4493
4494 return ConstantFoldCall(F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004495}
4496
Chandler Carruthf6182152012-12-28 14:23:29 +00004497Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004498 User::op_iterator ArgEnd, const SimplifyQuery &Q) {
4499 return ::SimplifyCall(V, ArgBegin, ArgEnd, Q, RecursionLimit);
4500}
4501
Chandler Carruthf6182152012-12-28 14:23:29 +00004502Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004503 const SimplifyQuery &Q) {
4504 return ::SimplifyCall(V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004505}
4506
Sanjay Patel472cc782016-01-11 22:14:42 +00004507/// See if we can compute a simplified version of this instruction.
4508/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004509
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004510Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004511 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004512 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004513 Value *Result;
4514
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004515 switch (I->getOpcode()) {
4516 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004517 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004518 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004519 case Instruction::FAdd:
4520 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004521 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004522 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004523 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004524 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4525 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004526 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004527 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004528 case Instruction::FSub:
4529 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004530 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004531 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004532 case Instruction::Sub:
4533 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4534 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004535 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004536 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004537 case Instruction::FMul:
4538 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004539 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004540 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004541 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004542 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004543 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004544 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004545 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004546 break;
4547 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004548 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004549 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004550 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004551 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004552 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00004553 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004554 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004555 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004556 break;
4557 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004558 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004559 break;
4560 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004561 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004562 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004563 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004564 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004565 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4566 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004567 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004568 break;
4569 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004570 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004571 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004572 break;
4573 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004574 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004575 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004576 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004577 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004578 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004579 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004580 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004581 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004582 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004583 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004584 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004585 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004586 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004587 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4588 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004589 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004590 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004591 Result =
4592 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4593 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004594 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004595 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004596 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004597 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004598 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004599 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004600 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004601 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004602 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004603 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004604 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004605 case Instruction::InsertValue: {
4606 InsertValueInst *IV = cast<InsertValueInst>(I);
4607 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4608 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004609 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004610 break;
4611 }
David Majnemer25a796e2015-07-13 01:15:46 +00004612 case Instruction::ExtractValue: {
4613 auto *EVI = cast<ExtractValueInst>(I);
4614 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004615 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00004616 break;
4617 }
David Majnemer599ca442015-07-13 01:15:53 +00004618 case Instruction::ExtractElement: {
4619 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004620 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4621 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00004622 break;
4623 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004624 case Instruction::ShuffleVector: {
4625 auto *SVI = cast<ShuffleVectorInst>(I);
4626 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004627 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00004628 break;
4629 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004630 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004631 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004632 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004633 case Instruction::Call: {
4634 CallSite CS(cast<CallInst>(I));
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004635 Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(), Q);
Dan Gohman85977e62011-11-04 18:32:42 +00004636 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004637 }
David Majnemer6774d612016-07-26 17:58:05 +00004638#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4639#include "llvm/IR/Instruction.def"
4640#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004641 Result =
4642 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00004643 break;
Craig Topper81c03a72017-04-12 22:54:24 +00004644 case Instruction::Alloca:
4645 // No simplifications for Alloca and it can't be constant folded.
4646 Result = nullptr;
4647 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004648 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004649
Hal Finkelf2199b22015-10-23 20:37:08 +00004650 // In general, it is possible for computeKnownBits to determine all bits in a
4651 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004652 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Hal Finkelf2199b22015-10-23 20:37:08 +00004653 unsigned BitWidth = I->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +00004654 KnownBits Known(BitWidth);
4655 computeKnownBits(I, Known, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00004656 if (Known.isConstant())
4657 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00004658 }
4659
Duncan Sands64e41cf2010-11-17 08:35:29 +00004660 /// If called on unreachable code, the above logic may report that the
4661 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004662 /// detecting that case here, returning a safe value instead.
4663 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004664}
4665
Sanjay Patelf44bd382016-01-20 18:59:48 +00004666/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004667/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004668///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004669/// This is the common implementation of the recursive simplification routines.
4670/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4671/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4672/// instructions to process and attempt to simplify it using
4673/// InstructionSimplify.
4674///
4675/// This routine returns 'true' only when *it* simplifies something. The passed
4676/// in simplified value does not count toward this.
4677static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004678 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004679 const DominatorTree *DT,
4680 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004681 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004682 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004683 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004684
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004685 // If we have an explicit value to collapse to, do that round of the
4686 // simplification loop by hand initially.
4687 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004688 for (User *U : I->users())
4689 if (U != I)
4690 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004691
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004692 // Replace the instruction with its simplified value.
4693 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004694
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004695 // Gracefully handle edge cases where the instruction is not wired into any
4696 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004697 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4698 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004699 I->eraseFromParent();
4700 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004701 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004702 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004703
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004704 // Note that we must test the size on each iteration, the worklist can grow.
4705 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4706 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004707
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004708 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004709 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004710 if (!SimpleV)
4711 continue;
4712
4713 Simplified = true;
4714
4715 // Stash away all the uses of the old instruction so we can check them for
4716 // recursive simplifications after a RAUW. This is cheaper than checking all
4717 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004718 for (User *U : I->users())
4719 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004720
4721 // Replace the instruction with its simplified value.
4722 I->replaceAllUsesWith(SimpleV);
4723
4724 // Gracefully handle edge cases where the instruction is not wired into any
4725 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004726 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4727 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004728 I->eraseFromParent();
4729 }
4730 return Simplified;
4731}
4732
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004733bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004734 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004735 const DominatorTree *DT,
4736 AssumptionCache *AC) {
4737 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004738}
4739
4740bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004741 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004742 const DominatorTree *DT,
4743 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004744 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4745 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004746 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004747}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004748
4749namespace llvm {
4750const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
4751 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
4752 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
4753 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
4754 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
4755 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
4756 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
4757 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4758}
4759
4760const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
4761 const DataLayout &DL) {
4762 return {DL, &AR.TLI, &AR.DT, &AR.AC};
4763}
4764
4765template <class T, class... TArgs>
4766const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
4767 Function &F) {
4768 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
4769 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
4770 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
4771 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4772}
4773template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
4774 Function &);
4775}