blob: 5652248a60cea6439c0b1fa86ab3b2c29cb8fadd [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
Sanjay Patel877364f2017-05-16 21:51:04 +00001755 // A mask that only clears known zeros of a shifted value is a no-op.
1756 Value *X;
1757 const APInt *Mask;
1758 const APInt *ShAmt;
1759 if (match(Op1, m_APInt(Mask))) {
1760 // If all bits in the inverted and shifted mask are clear:
1761 // and (shl X, ShAmt), Mask --> shl X, ShAmt
1762 if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1763 (~(*Mask)).lshr(*ShAmt).isNullValue())
1764 return Op0;
1765
1766 // If all bits in the inverted and shifted mask are clear:
1767 // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1768 if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1769 (~(*Mask)).shl(*ShAmt).isNullValue())
1770 return Op0;
1771 }
1772
Duncan Sandsba286d72011-10-26 20:55:21 +00001773 // A & (-A) = A if A is a power of two or zero.
1774 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1775 match(Op1, m_Neg(m_Specific(Op0)))) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001776 if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1777 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001778 return Op0;
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001779 if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1780 Q.DT))
Duncan Sandsba286d72011-10-26 20:55:21 +00001781 return Op1;
1782 }
1783
Sanjay Patele42b4d52017-05-04 19:51:34 +00001784 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, true))
1785 return V;
Sanjay Patel9ad8fb62016-06-20 20:59:59 +00001786
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001787 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001788 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1789 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001790 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001791
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001792 // And distributes over Or. Try some generic simplifications based on this.
1793 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001794 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001795 return V;
1796
1797 // And distributes over Xor. Try some generic simplifications based on this.
1798 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001799 Q, MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001800 return V;
1801
Duncan Sandsb0579e92010-11-10 13:00:08 +00001802 // If the operation is with the result of a select instruction, check whether
1803 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001804 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001805 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1806 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001807 return V;
1808
1809 // If the operation is with the result of a phi instruction, check whether
1810 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001811 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001812 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001813 MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001814 return V;
1815
Craig Topper9f008862014-04-15 04:59:12 +00001816 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00001817}
1818
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001819Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1820 return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1821}
1822
Sanjay Patel472cc782016-01-11 22:14:42 +00001823/// Given operands for an Or, see if we can fold the result.
1824/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001825static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001826 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001827 if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1828 return C;
Duncan Sands7e800d62010-11-14 11:23:23 +00001829
Chris Lattnera71e9d62009-11-10 00:55:12 +00001830 // X | undef -> -1
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001831 if (match(Op1, m_Undef()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001832 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001833
Chris Lattnera71e9d62009-11-10 00:55:12 +00001834 // X | X = X
Duncan Sands772749a2011-01-01 20:08:02 +00001835 if (Op0 == Op1)
Chris Lattnera71e9d62009-11-10 00:55:12 +00001836 return Op0;
1837
Duncan Sandsc89ac072010-11-17 18:52:15 +00001838 // X | 0 = X
1839 if (match(Op1, m_Zero()))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001840 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001841
Duncan Sandsc89ac072010-11-17 18:52:15 +00001842 // X | -1 = -1
1843 if (match(Op1, m_AllOnes()))
1844 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001845
Chris Lattnera71e9d62009-11-10 00:55:12 +00001846 // A | ~A = ~A | A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001847 if (match(Op0, m_Not(m_Specific(Op1))) ||
1848 match(Op1, m_Not(m_Specific(Op0))))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001849 return Constant::getAllOnesValue(Op0->getType());
Duncan Sands7e800d62010-11-14 11:23:23 +00001850
Chris Lattnera71e9d62009-11-10 00:55:12 +00001851 // (A & ?) | A = A
Craig Topper9f008862014-04-15 04:59:12 +00001852 Value *A = nullptr, *B = nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001853 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001854 (A == Op1 || B == Op1))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001855 return Op1;
Duncan Sands7e800d62010-11-14 11:23:23 +00001856
Chris Lattnera71e9d62009-11-10 00:55:12 +00001857 // A | (A & ?) = A
1858 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
Duncan Sands772749a2011-01-01 20:08:02 +00001859 (A == Op0 || B == Op0))
Chris Lattnera71e9d62009-11-10 00:55:12 +00001860 return Op0;
Duncan Sands7e800d62010-11-14 11:23:23 +00001861
Benjamin Kramer5b7a4e02011-02-20 15:20:01 +00001862 // ~(A & ?) | A = -1
1863 if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1864 (A == Op1 || B == Op1))
1865 return Constant::getAllOnesValue(Op1->getType());
1866
1867 // A | ~(A & ?) = -1
1868 if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1869 (A == Op0 || B == Op0))
1870 return Constant::getAllOnesValue(Op0->getType());
1871
Sanjay Patel08892252017-04-24 18:24:36 +00001872 // (A & ~B) | (A ^ B) -> (A ^ B)
1873 // (~B & A) | (A ^ B) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001874 // (A & ~B) | (B ^ A) -> (B ^ A)
1875 // (~B & A) | (B ^ A) -> (B ^ A)
1876 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1877 (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1878 match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001879 return Op1;
1880
1881 // Commute the 'or' operands.
1882 // (A ^ B) | (A & ~B) -> (A ^ B)
1883 // (A ^ B) | (~B & A) -> (A ^ B)
Craig Topper0b650d32017-04-25 17:01:32 +00001884 // (B ^ A) | (A & ~B) -> (B ^ A)
1885 // (B ^ A) | (~B & A) -> (B ^ A)
1886 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1887 (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1888 match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
Sanjay Patel08892252017-04-24 18:24:36 +00001889 return Op0;
1890
Craig Topper479daaf2017-05-14 07:54:43 +00001891 // (A & B) | (~A ^ B) -> (~A ^ B)
1892 // (B & A) | (~A ^ B) -> (~A ^ B)
1893 // (A & B) | (B ^ ~A) -> (B ^ ~A)
1894 // (B & A) | (B ^ ~A) -> (B ^ ~A)
1895 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1896 (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1897 match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1898 return Op1;
1899
1900 // (~A ^ B) | (A & B) -> (~A ^ B)
1901 // (~A ^ B) | (B & A) -> (~A ^ B)
1902 // (B ^ ~A) | (A & B) -> (B ^ ~A)
1903 // (B ^ ~A) | (B & A) -> (B ^ ~A)
1904 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1905 (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1906 match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1907 return Op0;
1908
Sanjay Patele42b4d52017-05-04 19:51:34 +00001909 if (Value *V = simplifyAndOrOfICmps(Op0, Op1, false))
1910 return V;
David Majnemera315bd82014-09-15 08:15:28 +00001911
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001912 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001913 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1914 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00001915 return V;
Benjamin Kramer8c35fb02010-09-10 22:39:55 +00001916
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001917 // Or distributes over And. Try some generic simplifications based on this.
Duncan Sandsb8cee002012-03-13 11:42:19 +00001918 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1919 MaxRecurse))
Duncan Sandsee3ec6e2010-12-21 13:32:22 +00001920 return V;
1921
Duncan Sandsb0579e92010-11-10 13:00:08 +00001922 // If the operation is with the result of a select instruction, check whether
1923 // operating on either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001924 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001925 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
Duncan Sandsf64e6902010-12-21 09:09:15 +00001926 MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001927 return V;
1928
Nick Lewycky8561a492014-06-19 03:51:46 +00001929 // (A & C)|(B & D)
1930 Value *C = nullptr, *D = nullptr;
1931 if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1932 match(Op1, m_And(m_Value(B), m_Value(D)))) {
1933 ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1934 ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1935 if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1936 // (A & C1)|(B & C2)
1937 // If we have: ((V + N) & C1) | (V & C2)
1938 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1939 // replace with V+N.
1940 Value *V1, *V2;
1941 if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1942 match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1943 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001944 if (V1 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001945 MaskedValueIsZero(V2, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001946 return A;
Chandler Carruth66b31302015-01-04 12:03:27 +00001947 if (V2 == B &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001948 MaskedValueIsZero(V1, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001949 return A;
1950 }
1951 // Or commutes, try both ways.
1952 if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1953 match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1954 // Add commutes, try both ways.
Chandler Carruth66b31302015-01-04 12:03:27 +00001955 if (V1 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001956 MaskedValueIsZero(V2, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001957 return B;
Chandler Carruth66b31302015-01-04 12:03:27 +00001958 if (V2 == A &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001959 MaskedValueIsZero(V1, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Nick Lewycky8561a492014-06-19 03:51:46 +00001960 return B;
1961 }
1962 }
1963 }
1964
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00001965 // If the operation is with the result of a phi instruction, check whether
1966 // operating on all incoming values of the phi always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00001967 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
Duncan Sandsb8cee002012-03-13 11:42:19 +00001968 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
Duncan Sandsb0579e92010-11-10 13:00:08 +00001969 return V;
1970
Craig Topper9f008862014-04-15 04:59:12 +00001971 return nullptr;
Chris Lattnera71e9d62009-11-10 00:55:12 +00001972}
1973
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001974Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1975 return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1976}
1977
Sanjay Patel472cc782016-01-11 22:14:42 +00001978/// Given operands for a Xor, see if we can fold the result.
1979/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00001980static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00001981 unsigned MaxRecurse) {
Sanjay Patel8b5ad3f2017-04-01 19:05:11 +00001982 if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1983 return C;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001984
1985 // A ^ undef -> undef
Duncan Sandsa29ea9a2011-02-01 09:06:20 +00001986 if (match(Op1, m_Undef()))
Duncan Sands019a4182010-12-15 11:02:22 +00001987 return Op1;
Duncan Sandsc89ac072010-11-17 18:52:15 +00001988
1989 // A ^ 0 = A
1990 if (match(Op1, m_Zero()))
1991 return Op0;
1992
Eli Friedmanad3cfe72011-08-17 19:31:49 +00001993 // A ^ A = 0
1994 if (Op0 == Op1)
1995 return Constant::getNullValue(Op0->getType());
1996
Duncan Sandsc89ac072010-11-17 18:52:15 +00001997 // A ^ ~A = ~A ^ A = -1
Chris Lattner9e4aa022011-02-09 17:15:04 +00001998 if (match(Op0, m_Not(m_Specific(Op1))) ||
1999 match(Op1, m_Not(m_Specific(Op0))))
Duncan Sandsc89ac072010-11-17 18:52:15 +00002000 return Constant::getAllOnesValue(Op0->getType());
2001
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002002 // Try some generic simplifications for associative operations.
Duncan Sandsb8cee002012-03-13 11:42:19 +00002003 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
2004 MaxRecurse))
Duncan Sands6c7a52c2010-12-21 08:49:00 +00002005 return V;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002006
Duncan Sandsb238de02010-11-19 09:20:39 +00002007 // Threading Xor over selects and phi nodes is pointless, so don't bother.
2008 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
2009 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
2010 // only if B and C are equal. If B and C are equal then (since we assume
2011 // that operands have already been simplified) "select(cond, B, C)" should
2012 // have been simplified to the common value of B and C already. Analysing
2013 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
2014 // for threading over phi nodes.
Duncan Sandsc89ac072010-11-17 18:52:15 +00002015
Craig Topper9f008862014-04-15 04:59:12 +00002016 return nullptr;
Duncan Sandsc89ac072010-11-17 18:52:15 +00002017}
2018
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002019Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2020 return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2021}
2022
2023
Chris Lattner229907c2011-07-18 04:54:35 +00002024static Type *GetCompareTy(Value *Op) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00002025 return CmpInst::makeCmpResultType(Op->getType());
2026}
2027
Sanjay Patel472cc782016-01-11 22:14:42 +00002028/// Rummage around inside V looking for something equivalent to the comparison
2029/// "LHS Pred RHS". Return such a value if found, otherwise return null.
2030/// Helper function for analyzing max/min idioms.
Duncan Sandsaf327282011-05-07 16:56:49 +00002031static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2032 Value *LHS, Value *RHS) {
2033 SelectInst *SI = dyn_cast<SelectInst>(V);
2034 if (!SI)
Craig Topper9f008862014-04-15 04:59:12 +00002035 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002036 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2037 if (!Cmp)
Craig Topper9f008862014-04-15 04:59:12 +00002038 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002039 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2040 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2041 return Cmp;
2042 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2043 LHS == CmpRHS && RHS == CmpLHS)
2044 return Cmp;
Craig Topper9f008862014-04-15 04:59:12 +00002045 return nullptr;
Duncan Sandsaf327282011-05-07 16:56:49 +00002046}
2047
Dan Gohman9631d902013-02-01 00:49:06 +00002048// A significant optimization not implemented here is assuming that alloca
2049// addresses are not equal to incoming argument values. They don't *alias*,
2050// as we say, but that doesn't mean they aren't equal, so we take a
2051// conservative approach.
2052//
2053// This is inspired in part by C++11 5.10p1:
2054// "Two pointers of the same type compare equal if and only if they are both
2055// null, both point to the same function, or both represent the same
2056// address."
2057//
2058// This is pretty permissive.
2059//
2060// It's also partly due to C11 6.5.9p6:
2061// "Two pointers compare equal if and only if both are null pointers, both are
2062// pointers to the same object (including a pointer to an object and a
2063// subobject at its beginning) or function, both are pointers to one past the
2064// last element of the same array object, or one is a pointer to one past the
2065// end of one array object and the other is a pointer to the start of a
NAKAMURA Takumi065fd352013-04-08 23:05:21 +00002066// different array object that happens to immediately follow the first array
Dan Gohman9631d902013-02-01 00:49:06 +00002067// object in the address space.)
2068//
2069// C11's version is more restrictive, however there's no reason why an argument
2070// couldn't be a one-past-the-end value for a stack object in the caller and be
2071// equal to the beginning of a stack object in the callee.
2072//
2073// If the C and C++ standards are ever made sufficiently restrictive in this
2074// area, it may be possible to update LLVM's semantics accordingly and reinstate
2075// this optimization.
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002076static Constant *
2077computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2078 const DominatorTree *DT, CmpInst::Predicate Pred,
2079 const Instruction *CxtI, Value *LHS, Value *RHS) {
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002080 // First, skip past any trivial no-ops.
2081 LHS = LHS->stripPointerCasts();
2082 RHS = RHS->stripPointerCasts();
2083
2084 // A non-null pointer is not equal to a null pointer.
Sean Silva45835e72016-07-02 23:47:27 +00002085 if (llvm::isKnownNonNull(LHS) && isa<ConstantPointerNull>(RHS) &&
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002086 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2087 return ConstantInt::get(GetCompareTy(LHS),
2088 !CmpInst::isTrueWhenEqual(Pred));
2089
Chandler Carruth8059c842012-03-25 21:28:14 +00002090 // We can only fold certain predicates on pointer comparisons.
2091 switch (Pred) {
2092 default:
Craig Topper9f008862014-04-15 04:59:12 +00002093 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002094
2095 // Equality comaprisons are easy to fold.
2096 case CmpInst::ICMP_EQ:
2097 case CmpInst::ICMP_NE:
2098 break;
2099
2100 // We can only handle unsigned relational comparisons because 'inbounds' on
2101 // a GEP only protects against unsigned wrapping.
2102 case CmpInst::ICMP_UGT:
2103 case CmpInst::ICMP_UGE:
2104 case CmpInst::ICMP_ULT:
2105 case CmpInst::ICMP_ULE:
2106 // However, we have to switch them to their signed variants to handle
2107 // negative indices from the base pointer.
2108 Pred = ICmpInst::getSignedPredicate(Pred);
2109 break;
2110 }
2111
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002112 // Strip off any constant offsets so that we can reason about them.
2113 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2114 // here and compare base addresses like AliasAnalysis does, however there are
2115 // numerous hazards. AliasAnalysis and its utilities rely on special rules
2116 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2117 // doesn't need to guarantee pointer inequality when it says NoAlias.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002118 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2119 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
Chandler Carruth8059c842012-03-25 21:28:14 +00002120
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002121 // If LHS and RHS are related via constant offsets to the same base
2122 // value, we can replace it with an icmp which just compares the offsets.
2123 if (LHS == RHS)
2124 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
Chandler Carruth8059c842012-03-25 21:28:14 +00002125
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002126 // Various optimizations for (in)equality comparisons.
2127 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2128 // Different non-empty allocations that exist at the same time have
2129 // different addresses (if the program can tell). Global variables always
2130 // exist, so they always exist during the lifetime of each other and all
2131 // allocas. Two different allocas usually have different addresses...
2132 //
2133 // However, if there's an @llvm.stackrestore dynamically in between two
2134 // allocas, they may have the same address. It's tempting to reduce the
2135 // scope of the problem by only looking at *static* allocas here. That would
2136 // cover the majority of allocas while significantly reducing the likelihood
2137 // of having an @llvm.stackrestore pop up in the middle. However, it's not
2138 // actually impossible for an @llvm.stackrestore to pop up in the middle of
2139 // an entry block. Also, if we have a block that's not attached to a
2140 // function, we can't tell if it's "static" under the current definition.
2141 // Theoretically, this problem could be fixed by creating a new kind of
2142 // instruction kind specifically for static allocas. Such a new instruction
2143 // could be required to be at the top of the entry block, thus preventing it
2144 // from being subject to a @llvm.stackrestore. Instcombine could even
2145 // convert regular allocas into these special allocas. It'd be nifty.
2146 // However, until then, this problem remains open.
2147 //
2148 // So, we'll assume that two non-empty allocas have different addresses
2149 // for now.
2150 //
2151 // With all that, if the offsets are within the bounds of their allocations
2152 // (and not one-past-the-end! so we can't use inbounds!), and their
2153 // allocations aren't the same, the pointers are not equal.
2154 //
2155 // Note that it's not necessary to check for LHS being a global variable
2156 // address, due to canonicalization and constant folding.
2157 if (isa<AllocaInst>(LHS) &&
2158 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002159 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2160 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002161 uint64_t LHSSize, RHSSize;
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002162 if (LHSOffsetCI && RHSOffsetCI &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002163 getObjectSize(LHS, LHSSize, DL, TLI) &&
2164 getObjectSize(RHS, RHSSize, DL, TLI)) {
Benjamin Kramerc05aa952013-02-01 15:21:10 +00002165 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2166 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002167 if (!LHSOffsetValue.isNegative() &&
2168 !RHSOffsetValue.isNegative() &&
2169 LHSOffsetValue.ult(LHSSize) &&
2170 RHSOffsetValue.ult(RHSSize)) {
2171 return ConstantInt::get(GetCompareTy(LHS),
2172 !CmpInst::isTrueWhenEqual(Pred));
2173 }
2174 }
2175
2176 // Repeat the above check but this time without depending on DataLayout
2177 // or being able to compute a precise size.
2178 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2179 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2180 LHSOffset->isNullValue() &&
2181 RHSOffset->isNullValue())
2182 return ConstantInt::get(GetCompareTy(LHS),
2183 !CmpInst::isTrueWhenEqual(Pred));
2184 }
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002185
2186 // Even if an non-inbounds GEP occurs along the path we can still optimize
2187 // equality comparisons concerning the result. We avoid walking the whole
2188 // chain again by starting where the last calls to
2189 // stripAndComputeConstantOffsets left off and accumulate the offsets.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002190 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2191 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
Benjamin Kramer942dfe62013-09-23 14:16:38 +00002192 if (LHS == RHS)
2193 return ConstantExpr::getICmp(Pred,
2194 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2195 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
Hal Finkelafcd8db2014-12-01 23:38:06 +00002196
2197 // If one side of the equality comparison must come from a noalias call
2198 // (meaning a system memory allocation function), and the other side must
2199 // come from a pointer that cannot overlap with dynamically-allocated
2200 // memory within the lifetime of the current function (allocas, byval
2201 // arguments, globals), then determine the comparison result here.
2202 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2203 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2204 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2205
2206 // Is the set of underlying objects all noalias calls?
David Majnemer0a16c222016-08-11 21:15:00 +00002207 auto IsNAC = [](ArrayRef<Value *> Objects) {
2208 return all_of(Objects, isNoAliasCall);
Hal Finkelafcd8db2014-12-01 23:38:06 +00002209 };
2210
2211 // Is the set of underlying objects all things which must be disjoint from
Hal Finkelaa19baf2014-12-04 17:45:19 +00002212 // noalias calls. For allocas, we consider only static ones (dynamic
2213 // allocas might be transformed into calls to malloc not simultaneously
2214 // live with the compared-to allocation). For globals, we exclude symbols
2215 // that might be resolve lazily to symbols in another dynamically-loaded
2216 // library (and, thus, could be malloc'ed by the implementation).
David Majnemer0a16c222016-08-11 21:15:00 +00002217 auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2218 return all_of(Objects, [](Value *V) {
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002219 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2220 return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2221 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2222 return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
Peter Collingbourne96efdd62016-06-14 21:01:22 +00002223 GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
Sanjay Patel34ea70a2016-01-11 22:24:35 +00002224 !GV->isThreadLocal();
2225 if (const Argument *A = dyn_cast<Argument>(V))
2226 return A->hasByValAttr();
2227 return false;
2228 });
Hal Finkelafcd8db2014-12-01 23:38:06 +00002229 };
2230
2231 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2232 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2233 return ConstantInt::get(GetCompareTy(LHS),
2234 !CmpInst::isTrueWhenEqual(Pred));
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002235
2236 // Fold comparisons for non-escaping pointer even if the allocation call
2237 // cannot be elided. We cannot fold malloc comparison to null. Also, the
2238 // dynamic allocation call could be either of the operands.
2239 Value *MI = nullptr;
Sean Silva45835e72016-07-02 23:47:27 +00002240 if (isAllocLikeFn(LHS, TLI) && llvm::isKnownNonNullAt(RHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002241 MI = LHS;
Sean Silva45835e72016-07-02 23:47:27 +00002242 else if (isAllocLikeFn(RHS, TLI) && llvm::isKnownNonNullAt(LHS, CxtI, DT))
Anna Thomas43d7e1c2016-05-03 14:58:21 +00002243 MI = RHS;
2244 // FIXME: We should also fold the compare when the pointer escapes, but the
2245 // compare dominates the pointer escape
2246 if (MI && !PointerMayBeCaptured(MI, true, true))
2247 return ConstantInt::get(GetCompareTy(LHS),
2248 CmpInst::isFalseWhenEqual(Pred));
Dan Gohmanb3e2d3a2013-02-01 00:11:13 +00002249 }
2250
2251 // Otherwise, fail.
Craig Topper9f008862014-04-15 04:59:12 +00002252 return nullptr;
Chandler Carruth8059c842012-03-25 21:28:14 +00002253}
Chris Lattner01990f02012-02-24 19:01:58 +00002254
Sanjay Pateldc65a272016-12-03 17:30:22 +00002255/// Fold an icmp when its operands have i1 scalar type.
2256static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002257 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002258 Type *ITy = GetCompareTy(LHS); // The return type.
2259 Type *OpTy = LHS->getType(); // The operand type.
2260 if (!OpTy->getScalarType()->isIntegerTy(1))
2261 return nullptr;
2262
2263 switch (Pred) {
2264 default:
2265 break;
2266 case ICmpInst::ICMP_EQ:
2267 // X == 1 -> X
2268 if (match(RHS, m_One()))
2269 return LHS;
2270 break;
2271 case ICmpInst::ICMP_NE:
2272 // X != 0 -> X
2273 if (match(RHS, m_Zero()))
2274 return LHS;
2275 break;
2276 case ICmpInst::ICMP_UGT:
2277 // X >u 0 -> X
2278 if (match(RHS, m_Zero()))
2279 return LHS;
2280 break;
2281 case ICmpInst::ICMP_UGE:
2282 // X >=u 1 -> X
2283 if (match(RHS, m_One()))
2284 return LHS;
2285 if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2286 return getTrue(ITy);
2287 break;
2288 case ICmpInst::ICMP_SGE:
2289 /// For signed comparison, the values for an i1 are 0 and -1
2290 /// respectively. This maps into a truth table of:
2291 /// LHS | RHS | LHS >=s RHS | LHS implies RHS
2292 /// 0 | 0 | 1 (0 >= 0) | 1
2293 /// 0 | 1 | 1 (0 >= -1) | 1
2294 /// 1 | 0 | 0 (-1 >= 0) | 0
2295 /// 1 | 1 | 1 (-1 >= -1) | 1
2296 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2297 return getTrue(ITy);
2298 break;
2299 case ICmpInst::ICMP_SLT:
2300 // X <s 0 -> X
2301 if (match(RHS, m_Zero()))
2302 return LHS;
2303 break;
2304 case ICmpInst::ICMP_SLE:
2305 // X <=s -1 -> X
2306 if (match(RHS, m_One()))
2307 return LHS;
2308 break;
2309 case ICmpInst::ICMP_ULE:
2310 if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2311 return getTrue(ITy);
2312 break;
2313 }
2314
2315 return nullptr;
2316}
2317
2318/// Try hard to fold icmp with zero RHS because this is a common case.
2319static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002320 Value *RHS, const SimplifyQuery &Q) {
Sanjay Pateldc65a272016-12-03 17:30:22 +00002321 if (!match(RHS, m_Zero()))
2322 return nullptr;
2323
2324 Type *ITy = GetCompareTy(LHS); // The return type.
Sanjay Pateldc65a272016-12-03 17:30:22 +00002325 switch (Pred) {
2326 default:
2327 llvm_unreachable("Unknown ICmp predicate!");
2328 case ICmpInst::ICMP_ULT:
2329 return getFalse(ITy);
2330 case ICmpInst::ICMP_UGE:
2331 return getTrue(ITy);
2332 case ICmpInst::ICMP_EQ:
2333 case ICmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002334 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002335 return getFalse(ITy);
2336 break;
2337 case ICmpInst::ICMP_NE:
2338 case ICmpInst::ICMP_UGT:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00002339 if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002340 return getTrue(ITy);
2341 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002342 case ICmpInst::ICMP_SLT: {
2343 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2344 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002345 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002346 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002347 return getFalse(ITy);
2348 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002349 }
2350 case ICmpInst::ICMP_SLE: {
2351 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2352 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002353 return getTrue(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002354 if (LHSKnown.isNonNegative() &&
2355 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002356 return getFalse(ITy);
2357 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002358 }
2359 case ICmpInst::ICMP_SGE: {
2360 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2361 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002362 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002363 if (LHSKnown.isNonNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002364 return getTrue(ITy);
2365 break;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002366 }
2367 case ICmpInst::ICMP_SGT: {
2368 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2369 if (LHSKnown.isNegative())
Sanjay Pateldc65a272016-12-03 17:30:22 +00002370 return getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002371 if (LHSKnown.isNonNegative() &&
2372 isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
Sanjay Pateldc65a272016-12-03 17:30:22 +00002373 return getTrue(ITy);
2374 break;
2375 }
Craig Topper1a36b7d2017-05-15 06:39:41 +00002376 }
Sanjay Pateldc65a272016-12-03 17:30:22 +00002377
2378 return nullptr;
2379}
2380
Sanjay Patelbe332132017-01-23 18:22:26 +00002381/// Many binary operators with a constant operand have an easy-to-compute
2382/// range of outputs. This can be used to fold a comparison to always true or
2383/// always false.
2384static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2385 unsigned Width = Lower.getBitWidth();
2386 const APInt *C;
2387 switch (BO.getOpcode()) {
2388 case Instruction::Add:
Sanjay Patel56227252017-01-24 17:03:24 +00002389 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2390 // FIXME: If we have both nuw and nsw, we should reduce the range further.
2391 if (BO.hasNoUnsignedWrap()) {
2392 // 'add nuw x, C' produces [C, UINT_MAX].
2393 Lower = *C;
2394 } else if (BO.hasNoSignedWrap()) {
2395 if (C->isNegative()) {
2396 // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2397 Lower = APInt::getSignedMinValue(Width);
2398 Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2399 } else {
2400 // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2401 Lower = APInt::getSignedMinValue(Width) + *C;
2402 Upper = APInt::getSignedMaxValue(Width) + 1;
2403 }
2404 }
2405 }
Sanjay Patelbe332132017-01-23 18:22:26 +00002406 break;
2407
2408 case Instruction::And:
2409 if (match(BO.getOperand(1), m_APInt(C)))
2410 // 'and x, C' produces [0, C].
2411 Upper = *C + 1;
2412 break;
2413
2414 case Instruction::Or:
2415 if (match(BO.getOperand(1), m_APInt(C)))
2416 // 'or x, C' produces [C, UINT_MAX].
2417 Lower = *C;
2418 break;
2419
2420 case Instruction::AShr:
2421 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2422 // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2423 Lower = APInt::getSignedMinValue(Width).ashr(*C);
2424 Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2425 } else if (match(BO.getOperand(0), m_APInt(C))) {
2426 unsigned ShiftAmount = Width - 1;
2427 if (*C != 0 && BO.isExact())
2428 ShiftAmount = C->countTrailingZeros();
2429 if (C->isNegative()) {
2430 // 'ashr C, x' produces [C, C >> (Width-1)]
2431 Lower = *C;
2432 Upper = C->ashr(ShiftAmount) + 1;
2433 } else {
2434 // 'ashr C, x' produces [C >> (Width-1), C]
2435 Lower = C->ashr(ShiftAmount);
2436 Upper = *C + 1;
2437 }
2438 }
2439 break;
2440
2441 case Instruction::LShr:
2442 if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2443 // 'lshr x, C' produces [0, UINT_MAX >> C].
2444 Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2445 } else if (match(BO.getOperand(0), m_APInt(C))) {
2446 // 'lshr C, x' produces [C >> (Width-1), C].
2447 unsigned ShiftAmount = Width - 1;
2448 if (*C != 0 && BO.isExact())
2449 ShiftAmount = C->countTrailingZeros();
2450 Lower = C->lshr(ShiftAmount);
2451 Upper = *C + 1;
2452 }
2453 break;
2454
2455 case Instruction::Shl:
2456 if (match(BO.getOperand(0), m_APInt(C))) {
2457 if (BO.hasNoUnsignedWrap()) {
2458 // 'shl nuw C, x' produces [C, C << CLZ(C)]
2459 Lower = *C;
2460 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2461 } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2462 if (C->isNegative()) {
2463 // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2464 unsigned ShiftAmount = C->countLeadingOnes() - 1;
2465 Lower = C->shl(ShiftAmount);
2466 Upper = *C + 1;
2467 } else {
2468 // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2469 unsigned ShiftAmount = C->countLeadingZeros() - 1;
2470 Lower = *C;
2471 Upper = C->shl(ShiftAmount) + 1;
2472 }
2473 }
2474 }
2475 break;
2476
2477 case Instruction::SDiv:
2478 if (match(BO.getOperand(1), m_APInt(C))) {
2479 APInt IntMin = APInt::getSignedMinValue(Width);
2480 APInt IntMax = APInt::getSignedMaxValue(Width);
2481 if (C->isAllOnesValue()) {
2482 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2483 // where C != -1 and C != 0 and C != 1
2484 Lower = IntMin + 1;
2485 Upper = IntMax + 1;
2486 } else if (C->countLeadingZeros() < Width - 1) {
2487 // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2488 // where C != -1 and C != 0 and C != 1
2489 Lower = IntMin.sdiv(*C);
2490 Upper = IntMax.sdiv(*C);
2491 if (Lower.sgt(Upper))
2492 std::swap(Lower, Upper);
2493 Upper = Upper + 1;
2494 assert(Upper != Lower && "Upper part of range has wrapped!");
2495 }
2496 } else if (match(BO.getOperand(0), m_APInt(C))) {
2497 if (C->isMinSignedValue()) {
2498 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2499 Lower = *C;
2500 Upper = Lower.lshr(1) + 1;
2501 } else {
2502 // 'sdiv C, x' produces [-|C|, |C|].
2503 Upper = C->abs() + 1;
2504 Lower = (-Upper) + 1;
2505 }
2506 }
2507 break;
2508
2509 case Instruction::UDiv:
2510 if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2511 // 'udiv x, C' produces [0, UINT_MAX / C].
2512 Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2513 } else if (match(BO.getOperand(0), m_APInt(C))) {
2514 // 'udiv C, x' produces [0, C].
2515 Upper = *C + 1;
2516 }
2517 break;
2518
2519 case Instruction::SRem:
2520 if (match(BO.getOperand(1), m_APInt(C))) {
2521 // 'srem x, C' produces (-|C|, |C|).
2522 Upper = C->abs();
2523 Lower = (-Upper) + 1;
2524 }
2525 break;
2526
2527 case Instruction::URem:
2528 if (match(BO.getOperand(1), m_APInt(C)))
2529 // 'urem x, C' produces [0, C).
2530 Upper = *C;
2531 break;
2532
2533 default:
2534 break;
2535 }
2536}
2537
Sanjay Patel67bde282016-08-22 23:12:02 +00002538static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2539 Value *RHS) {
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002540 const APInt *C;
2541 if (!match(RHS, m_APInt(C)))
Sanjay Patel67bde282016-08-22 23:12:02 +00002542 return nullptr;
2543
2544 // Rule out tautological comparisons (eg., ult 0 or uge 0).
Sanjoy Das1f7b8132016-10-02 00:09:57 +00002545 ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
Sanjay Patel67bde282016-08-22 23:12:02 +00002546 if (RHS_CR.isEmptySet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002547 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002548 if (RHS_CR.isFullSet())
Sanjay Patel200e3cb2016-08-23 17:30:56 +00002549 return ConstantInt::getTrue(GetCompareTy(RHS));
2550
Sanjay Patelbe332132017-01-23 18:22:26 +00002551 // Find the range of possible values for binary operators.
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002552 unsigned Width = C->getBitWidth();
Sanjay Patel67bde282016-08-22 23:12:02 +00002553 APInt Lower = APInt(Width, 0);
2554 APInt Upper = APInt(Width, 0);
Sanjay Patelbe332132017-01-23 18:22:26 +00002555 if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2556 setLimitsForBinOp(*BO, Lower, Upper);
Sanjay Patel67bde282016-08-22 23:12:02 +00002557
2558 ConstantRange LHS_CR =
2559 Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2560
2561 if (auto *I = dyn_cast<Instruction>(LHS))
2562 if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2563 LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2564
2565 if (!LHS_CR.isFullSet()) {
2566 if (RHS_CR.contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002567 return ConstantInt::getTrue(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002568 if (RHS_CR.inverse().contains(LHS_CR))
Sanjay Patel6946e2a2016-08-23 18:00:51 +00002569 return ConstantInt::getFalse(GetCompareTy(RHS));
Sanjay Patel67bde282016-08-22 23:12:02 +00002570 }
2571
2572 return nullptr;
2573}
2574
Sanjay Patel2df38a82017-05-08 16:21:55 +00002575/// TODO: A large part of this logic is duplicated in InstCombine's
2576/// foldICmpBinOp(). We should be able to share that and avoid the code
2577/// duplication.
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002578static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002579 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002580 unsigned MaxRecurse) {
2581 Type *ITy = GetCompareTy(LHS); // The return type.
2582
2583 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2584 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2585 if (MaxRecurse && (LBO || RBO)) {
2586 // Analyze the case when either LHS or RHS is an add instruction.
2587 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2588 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2589 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2590 if (LBO && LBO->getOpcode() == Instruction::Add) {
2591 A = LBO->getOperand(0);
2592 B = LBO->getOperand(1);
2593 NoLHSWrapProblem =
2594 ICmpInst::isEquality(Pred) ||
2595 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2596 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2597 }
2598 if (RBO && RBO->getOpcode() == Instruction::Add) {
2599 C = RBO->getOperand(0);
2600 D = RBO->getOperand(1);
2601 NoRHSWrapProblem =
2602 ICmpInst::isEquality(Pred) ||
2603 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2604 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2605 }
2606
2607 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2608 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2609 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2610 Constant::getNullValue(RHS->getType()), Q,
2611 MaxRecurse - 1))
2612 return V;
2613
2614 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2615 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2616 if (Value *V =
2617 SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2618 C == LHS ? D : C, Q, MaxRecurse - 1))
2619 return V;
2620
2621 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2622 if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2623 NoRHSWrapProblem) {
2624 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2625 Value *Y, *Z;
2626 if (A == C) {
2627 // C + B == C + D -> B == D
2628 Y = B;
2629 Z = D;
2630 } else if (A == D) {
2631 // D + B == C + D -> B == C
2632 Y = B;
2633 Z = C;
2634 } else if (B == C) {
2635 // A + C == C + D -> A == D
2636 Y = A;
2637 Z = D;
2638 } else {
2639 assert(B == D);
2640 // A + D == C + D -> A == C
2641 Y = A;
2642 Z = C;
2643 }
2644 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2645 return V;
2646 }
2647 }
2648
2649 {
2650 Value *Y = nullptr;
2651 // icmp pred (or X, Y), X
2652 if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2653 if (Pred == ICmpInst::ICMP_ULT)
2654 return getFalse(ITy);
2655 if (Pred == ICmpInst::ICMP_UGE)
2656 return getTrue(ITy);
2657
2658 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002659 KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2660 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2661 if (RHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002662 return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002663 if (RHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002664 return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2665 }
2666 }
2667 // icmp pred X, (or X, Y)
2668 if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2669 if (Pred == ICmpInst::ICMP_ULE)
2670 return getTrue(ITy);
2671 if (Pred == ICmpInst::ICMP_UGT)
2672 return getFalse(ITy);
2673
2674 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
Craig Topper1a36b7d2017-05-15 06:39:41 +00002675 KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2676 KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2677 if (LHSKnown.isNonNegative() && YKnown.isNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002678 return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
Craig Topper1a36b7d2017-05-15 06:39:41 +00002679 if (LHSKnown.isNegative() || YKnown.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002680 return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2681 }
2682 }
2683 }
2684
2685 // icmp pred (and X, Y), X
2686 if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2687 m_And(m_Specific(RHS), m_Value())))) {
2688 if (Pred == ICmpInst::ICMP_UGT)
2689 return getFalse(ITy);
2690 if (Pred == ICmpInst::ICMP_ULE)
2691 return getTrue(ITy);
2692 }
2693 // icmp pred X, (and X, Y)
2694 if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2695 m_And(m_Specific(LHS), m_Value())))) {
2696 if (Pred == ICmpInst::ICMP_UGE)
2697 return getTrue(ITy);
2698 if (Pred == ICmpInst::ICMP_ULT)
2699 return getFalse(ITy);
2700 }
2701
2702 // 0 - (zext X) pred C
2703 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2704 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2705 if (RHSC->getValue().isStrictlyPositive()) {
2706 if (Pred == ICmpInst::ICMP_SLT)
2707 return ConstantInt::getTrue(RHSC->getContext());
2708 if (Pred == ICmpInst::ICMP_SGE)
2709 return ConstantInt::getFalse(RHSC->getContext());
2710 if (Pred == ICmpInst::ICMP_EQ)
2711 return ConstantInt::getFalse(RHSC->getContext());
2712 if (Pred == ICmpInst::ICMP_NE)
2713 return ConstantInt::getTrue(RHSC->getContext());
2714 }
2715 if (RHSC->getValue().isNonNegative()) {
2716 if (Pred == ICmpInst::ICMP_SLE)
2717 return ConstantInt::getTrue(RHSC->getContext());
2718 if (Pred == ICmpInst::ICMP_SGT)
2719 return ConstantInt::getFalse(RHSC->getContext());
2720 }
2721 }
2722 }
2723
2724 // icmp pred (urem X, Y), Y
2725 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002726 switch (Pred) {
2727 default:
2728 break;
2729 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002730 case ICmpInst::ICMP_SGE: {
2731 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2732 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002733 break;
2734 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002735 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002736 case ICmpInst::ICMP_EQ:
2737 case ICmpInst::ICMP_UGT:
2738 case ICmpInst::ICMP_UGE:
2739 return getFalse(ITy);
2740 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002741 case ICmpInst::ICMP_SLE: {
2742 KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2743 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002744 break;
2745 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002746 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002747 case ICmpInst::ICMP_NE:
2748 case ICmpInst::ICMP_ULT:
2749 case ICmpInst::ICMP_ULE:
2750 return getTrue(ITy);
2751 }
2752 }
2753
2754 // icmp pred X, (urem Y, X)
2755 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002756 switch (Pred) {
2757 default:
2758 break;
2759 case ICmpInst::ICMP_SGT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002760 case ICmpInst::ICMP_SGE: {
2761 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2762 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002763 break;
2764 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002765 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002766 case ICmpInst::ICMP_NE:
2767 case ICmpInst::ICMP_UGT:
2768 case ICmpInst::ICMP_UGE:
2769 return getTrue(ITy);
2770 case ICmpInst::ICMP_SLT:
Craig Topper1a36b7d2017-05-15 06:39:41 +00002771 case ICmpInst::ICMP_SLE: {
2772 KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2773 if (!Known.isNonNegative())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002774 break;
2775 LLVM_FALLTHROUGH;
Craig Topper1a36b7d2017-05-15 06:39:41 +00002776 }
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002777 case ICmpInst::ICMP_EQ:
2778 case ICmpInst::ICMP_ULT:
2779 case ICmpInst::ICMP_ULE:
2780 return getFalse(ITy);
2781 }
2782 }
2783
2784 // x >> y <=u x
2785 // x udiv y <=u x.
2786 if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2787 match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2788 // icmp pred (X op Y), X
2789 if (Pred == ICmpInst::ICMP_UGT)
2790 return getFalse(ITy);
2791 if (Pred == ICmpInst::ICMP_ULE)
2792 return getTrue(ITy);
2793 }
2794
2795 // x >=u x >> y
2796 // x >=u x udiv y.
2797 if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2798 match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2799 // icmp pred X, (X op Y)
2800 if (Pred == ICmpInst::ICMP_ULT)
2801 return getFalse(ITy);
2802 if (Pred == ICmpInst::ICMP_UGE)
2803 return getTrue(ITy);
2804 }
2805
2806 // handle:
2807 // CI2 << X == CI
2808 // CI2 << X != CI
2809 //
2810 // where CI2 is a power of 2 and CI isn't
2811 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2812 const APInt *CI2Val, *CIVal = &CI->getValue();
2813 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2814 CI2Val->isPowerOf2()) {
2815 if (!CIVal->isPowerOf2()) {
2816 // CI2 << X can equal zero in some circumstances,
2817 // this simplification is unsafe if CI is zero.
2818 //
2819 // We know it is safe if:
2820 // - The shift is nsw, we can't shift out the one bit.
2821 // - The shift is nuw, we can't shift out the one bit.
2822 // - CI2 is one
2823 // - CI isn't zero
2824 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2825 *CI2Val == 1 || !CI->isZero()) {
2826 if (Pred == ICmpInst::ICMP_EQ)
2827 return ConstantInt::getFalse(RHS->getContext());
2828 if (Pred == ICmpInst::ICMP_NE)
2829 return ConstantInt::getTrue(RHS->getContext());
2830 }
2831 }
Craig Topperbcfd2d12017-04-20 16:56:25 +00002832 if (CIVal->isSignMask() && *CI2Val == 1) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002833 if (Pred == ICmpInst::ICMP_UGT)
2834 return ConstantInt::getFalse(RHS->getContext());
2835 if (Pred == ICmpInst::ICMP_ULE)
2836 return ConstantInt::getTrue(RHS->getContext());
2837 }
2838 }
2839 }
2840
2841 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2842 LBO->getOperand(1) == RBO->getOperand(1)) {
2843 switch (LBO->getOpcode()) {
2844 default:
2845 break;
2846 case Instruction::UDiv:
2847 case Instruction::LShr:
Sanjay Patela23b1412017-05-15 19:16:49 +00002848 if (ICmpInst::isSigned(Pred) || !LBO->isExact() || !RBO->isExact())
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002849 break;
Sanjay Patela23b1412017-05-15 19:16:49 +00002850 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2851 RBO->getOperand(0), Q, MaxRecurse - 1))
2852 return V;
2853 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002854 case Instruction::SDiv:
Sanjay Patela23b1412017-05-15 19:16:49 +00002855 if (!ICmpInst::isEquality(Pred) || !LBO->isExact() || !RBO->isExact())
2856 break;
2857 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2858 RBO->getOperand(0), Q, MaxRecurse - 1))
2859 return V;
2860 break;
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002861 case Instruction::AShr:
2862 if (!LBO->isExact() || !RBO->isExact())
2863 break;
2864 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2865 RBO->getOperand(0), Q, MaxRecurse - 1))
2866 return V;
2867 break;
2868 case Instruction::Shl: {
2869 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2870 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2871 if (!NUW && !NSW)
2872 break;
2873 if (!NSW && ICmpInst::isSigned(Pred))
2874 break;
2875 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2876 RBO->getOperand(0), Q, MaxRecurse - 1))
2877 return V;
2878 break;
2879 }
2880 }
2881 }
2882 return nullptr;
2883}
2884
Sanjay Patel35289c62016-12-10 17:40:47 +00002885/// Simplify integer comparisons where at least one operand of the compare
2886/// matches an integer min/max idiom.
2887static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00002888 Value *RHS, const SimplifyQuery &Q,
Sanjay Patel35289c62016-12-10 17:40:47 +00002889 unsigned MaxRecurse) {
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00002890 Type *ITy = GetCompareTy(LHS); // The return type.
2891 Value *A, *B;
2892 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2893 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2894
2895 // Signed variants on "max(a,b)>=a -> true".
2896 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2897 if (A != RHS)
2898 std::swap(A, B); // smax(A, B) pred A.
2899 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2900 // We analyze this as smax(A, B) pred A.
2901 P = Pred;
2902 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2903 (A == LHS || B == LHS)) {
2904 if (A != LHS)
2905 std::swap(A, B); // A pred smax(A, B).
2906 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2907 // We analyze this as smax(A, B) swapped-pred A.
2908 P = CmpInst::getSwappedPredicate(Pred);
2909 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2910 (A == RHS || B == RHS)) {
2911 if (A != RHS)
2912 std::swap(A, B); // smin(A, B) pred A.
2913 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2914 // We analyze this as smax(-A, -B) swapped-pred -A.
2915 // Note that we do not need to actually form -A or -B thanks to EqP.
2916 P = CmpInst::getSwappedPredicate(Pred);
2917 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2918 (A == LHS || B == LHS)) {
2919 if (A != LHS)
2920 std::swap(A, B); // A pred smin(A, B).
2921 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2922 // We analyze this as smax(-A, -B) pred -A.
2923 // Note that we do not need to actually form -A or -B thanks to EqP.
2924 P = Pred;
2925 }
2926 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2927 // Cases correspond to "max(A, B) p A".
2928 switch (P) {
2929 default:
2930 break;
2931 case CmpInst::ICMP_EQ:
2932 case CmpInst::ICMP_SLE:
2933 // Equivalent to "A EqP B". This may be the same as the condition tested
2934 // in the max/min; if so, we can just return that.
2935 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2936 return V;
2937 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2938 return V;
2939 // Otherwise, see if "A EqP B" simplifies.
2940 if (MaxRecurse)
2941 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2942 return V;
2943 break;
2944 case CmpInst::ICMP_NE:
2945 case CmpInst::ICMP_SGT: {
2946 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2947 // Equivalent to "A InvEqP B". This may be the same as the condition
2948 // tested in the max/min; if so, we can just return that.
2949 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2950 return V;
2951 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2952 return V;
2953 // Otherwise, see if "A InvEqP B" simplifies.
2954 if (MaxRecurse)
2955 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2956 return V;
2957 break;
2958 }
2959 case CmpInst::ICMP_SGE:
2960 // Always true.
2961 return getTrue(ITy);
2962 case CmpInst::ICMP_SLT:
2963 // Always false.
2964 return getFalse(ITy);
2965 }
2966 }
2967
2968 // Unsigned variants on "max(a,b)>=a -> true".
2969 P = CmpInst::BAD_ICMP_PREDICATE;
2970 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2971 if (A != RHS)
2972 std::swap(A, B); // umax(A, B) pred A.
2973 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2974 // We analyze this as umax(A, B) pred A.
2975 P = Pred;
2976 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2977 (A == LHS || B == LHS)) {
2978 if (A != LHS)
2979 std::swap(A, B); // A pred umax(A, B).
2980 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2981 // We analyze this as umax(A, B) swapped-pred A.
2982 P = CmpInst::getSwappedPredicate(Pred);
2983 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2984 (A == RHS || B == RHS)) {
2985 if (A != RHS)
2986 std::swap(A, B); // umin(A, B) pred A.
2987 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2988 // We analyze this as umax(-A, -B) swapped-pred -A.
2989 // Note that we do not need to actually form -A or -B thanks to EqP.
2990 P = CmpInst::getSwappedPredicate(Pred);
2991 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2992 (A == LHS || B == LHS)) {
2993 if (A != LHS)
2994 std::swap(A, B); // A pred umin(A, B).
2995 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2996 // We analyze this as umax(-A, -B) pred -A.
2997 // Note that we do not need to actually form -A or -B thanks to EqP.
2998 P = Pred;
2999 }
3000 if (P != CmpInst::BAD_ICMP_PREDICATE) {
3001 // Cases correspond to "max(A, B) p A".
3002 switch (P) {
3003 default:
3004 break;
3005 case CmpInst::ICMP_EQ:
3006 case CmpInst::ICMP_ULE:
3007 // Equivalent to "A EqP B". This may be the same as the condition tested
3008 // in the max/min; if so, we can just return that.
3009 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3010 return V;
3011 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3012 return V;
3013 // Otherwise, see if "A EqP B" simplifies.
3014 if (MaxRecurse)
3015 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3016 return V;
3017 break;
3018 case CmpInst::ICMP_NE:
3019 case CmpInst::ICMP_UGT: {
3020 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3021 // Equivalent to "A InvEqP B". This may be the same as the condition
3022 // tested in the max/min; if so, we can just return that.
3023 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3024 return V;
3025 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3026 return V;
3027 // Otherwise, see if "A InvEqP B" simplifies.
3028 if (MaxRecurse)
3029 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3030 return V;
3031 break;
3032 }
3033 case CmpInst::ICMP_UGE:
3034 // Always true.
3035 return getTrue(ITy);
3036 case CmpInst::ICMP_ULT:
3037 // Always false.
3038 return getFalse(ITy);
3039 }
3040 }
3041
3042 // Variants on "max(x,y) >= min(x,z)".
3043 Value *C, *D;
3044 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3045 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3046 (A == C || A == D || B == C || B == D)) {
3047 // max(x, ?) pred min(x, ?).
3048 if (Pred == CmpInst::ICMP_SGE)
3049 // Always true.
3050 return getTrue(ITy);
3051 if (Pred == CmpInst::ICMP_SLT)
3052 // Always false.
3053 return getFalse(ITy);
3054 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3055 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3056 (A == C || A == D || B == C || B == D)) {
3057 // min(x, ?) pred max(x, ?).
3058 if (Pred == CmpInst::ICMP_SLE)
3059 // Always true.
3060 return getTrue(ITy);
3061 if (Pred == CmpInst::ICMP_SGT)
3062 // Always false.
3063 return getFalse(ITy);
3064 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3065 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3066 (A == C || A == D || B == C || B == D)) {
3067 // max(x, ?) pred min(x, ?).
3068 if (Pred == CmpInst::ICMP_UGE)
3069 // Always true.
3070 return getTrue(ITy);
3071 if (Pred == CmpInst::ICMP_ULT)
3072 // Always false.
3073 return getFalse(ITy);
3074 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3075 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3076 (A == C || A == D || B == C || B == D)) {
3077 // min(x, ?) pred max(x, ?).
3078 if (Pred == CmpInst::ICMP_ULE)
3079 // Always true.
3080 return getTrue(ITy);
3081 if (Pred == CmpInst::ICMP_UGT)
3082 // Always false.
3083 return getFalse(ITy);
3084 }
3085
3086 return nullptr;
3087}
3088
Sanjay Patel472cc782016-01-11 22:14:42 +00003089/// Given operands for an ICmpInst, see if we can fold the result.
3090/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003091static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003092 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattner084a1b52009-11-09 22:57:59 +00003093 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003094 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
Duncan Sands7e800d62010-11-14 11:23:23 +00003095
Chris Lattnera71e9d62009-11-10 00:55:12 +00003096 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnercdfb80d2009-11-09 23:06:58 +00003097 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003098 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Chris Lattnera71e9d62009-11-10 00:55:12 +00003099
3100 // If we have a constant, make sure it is on the RHS.
3101 std::swap(LHS, RHS);
3102 Pred = CmpInst::getSwappedPredicate(Pred);
3103 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003104
Chris Lattner229907c2011-07-18 04:54:35 +00003105 Type *ITy = GetCompareTy(LHS); // The return type.
Duncan Sands7e800d62010-11-14 11:23:23 +00003106
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003107 // icmp X, X -> true/false
Chris Lattner3afc0722010-03-03 19:46:03 +00003108 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
3109 // because X could be 0.
Duncan Sands772749a2011-01-01 20:08:02 +00003110 if (LHS == RHS || isa<UndefValue>(RHS))
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003111 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
Duncan Sands7e800d62010-11-14 11:23:23 +00003112
Sanjay Pateldc65a272016-12-03 17:30:22 +00003113 if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3114 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003115
Sanjay Pateldc65a272016-12-03 17:30:22 +00003116 if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3117 return V;
Duncan Sandsd3951082011-01-25 09:38:29 +00003118
Sanjay Patel67bde282016-08-22 23:12:02 +00003119 if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3120 return V;
Duncan Sands8d25a7c2011-01-13 08:56:29 +00003121
Chen Li7452d952015-09-26 03:26:47 +00003122 // If both operands have range metadata, use the metadata
3123 // to simplify the comparison.
3124 if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
Craig Topper0c198612017-04-10 19:37:10 +00003125 auto RHS_Instr = cast<Instruction>(RHS);
3126 auto LHS_Instr = cast<Instruction>(LHS);
Chen Li7452d952015-09-26 03:26:47 +00003127
3128 if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3129 LHS_Instr->getMetadata(LLVMContext::MD_range)) {
Sanjoy Dasa7e13782015-10-24 05:37:35 +00003130 auto RHS_CR = getConstantRangeFromMetadata(
3131 *RHS_Instr->getMetadata(LLVMContext::MD_range));
3132 auto LHS_CR = getConstantRangeFromMetadata(
3133 *LHS_Instr->getMetadata(LLVMContext::MD_range));
Chen Li7452d952015-09-26 03:26:47 +00003134
3135 auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3136 if (Satisfied_CR.contains(LHS_CR))
3137 return ConstantInt::getTrue(RHS->getContext());
3138
3139 auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3140 CmpInst::getInversePredicate(Pred), RHS_CR);
3141 if (InversedSatisfied_CR.contains(LHS_CR))
3142 return ConstantInt::getFalse(RHS->getContext());
3143 }
3144 }
3145
Duncan Sands8fb2c382011-01-20 13:21:55 +00003146 // Compare of cast, for example (zext X) != 0 -> X != 0
3147 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3148 Instruction *LI = cast<CastInst>(LHS);
3149 Value *SrcOp = LI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003150 Type *SrcTy = SrcOp->getType();
3151 Type *DstTy = LI->getType();
Duncan Sands8fb2c382011-01-20 13:21:55 +00003152
3153 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3154 // if the integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003155 if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3156 Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
Duncan Sands8fb2c382011-01-20 13:21:55 +00003157 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3158 // Transfer the cast to the constant.
3159 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3160 ConstantExpr::getIntToPtr(RHSC, SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003161 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003162 return V;
3163 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3164 if (RI->getOperand(0)->getType() == SrcTy)
3165 // Compare without the cast.
3166 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003167 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003168 return V;
3169 }
3170 }
3171
3172 if (isa<ZExtInst>(LHS)) {
3173 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3174 // same type.
3175 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3176 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3177 // Compare X and Y. Note that signed predicates become unsigned.
3178 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003179 SrcOp, RI->getOperand(0), Q,
Duncan Sands8fb2c382011-01-20 13:21:55 +00003180 MaxRecurse-1))
3181 return V;
3182 }
3183 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3184 // too. If not, then try to deduce the result of the comparison.
3185 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3186 // Compute the constant that would happen if we truncated to SrcTy then
3187 // reextended to DstTy.
3188 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3189 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3190
3191 // If the re-extended constant didn't change then this is effectively
3192 // also a case of comparing two zero-extended values.
3193 if (RExt == CI && MaxRecurse)
3194 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003195 SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003196 return V;
3197
3198 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3199 // there. Use this to work out the result of the comparison.
3200 if (RExt != CI) {
3201 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003202 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003203 // LHS <u RHS.
3204 case ICmpInst::ICMP_EQ:
3205 case ICmpInst::ICMP_UGT:
3206 case ICmpInst::ICMP_UGE:
3207 return ConstantInt::getFalse(CI->getContext());
3208
3209 case ICmpInst::ICMP_NE:
3210 case ICmpInst::ICMP_ULT:
3211 case ICmpInst::ICMP_ULE:
3212 return ConstantInt::getTrue(CI->getContext());
3213
3214 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
3215 // is non-negative then LHS <s RHS.
3216 case ICmpInst::ICMP_SGT:
3217 case ICmpInst::ICMP_SGE:
3218 return CI->getValue().isNegative() ?
3219 ConstantInt::getTrue(CI->getContext()) :
3220 ConstantInt::getFalse(CI->getContext());
3221
3222 case ICmpInst::ICMP_SLT:
3223 case ICmpInst::ICMP_SLE:
3224 return CI->getValue().isNegative() ?
3225 ConstantInt::getFalse(CI->getContext()) :
3226 ConstantInt::getTrue(CI->getContext());
3227 }
3228 }
3229 }
3230 }
3231
3232 if (isa<SExtInst>(LHS)) {
3233 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3234 // same type.
3235 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3236 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3237 // Compare X and Y. Note that the predicate does not change.
3238 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003239 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003240 return V;
3241 }
3242 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3243 // too. If not, then try to deduce the result of the comparison.
3244 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3245 // Compute the constant that would happen if we truncated to SrcTy then
3246 // reextended to DstTy.
3247 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3248 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3249
3250 // If the re-extended constant didn't change then this is effectively
3251 // also a case of comparing two sign-extended values.
3252 if (RExt == CI && MaxRecurse)
Duncan Sandsb8cee002012-03-13 11:42:19 +00003253 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003254 return V;
3255
3256 // Otherwise the upper bits of LHS are all equal, while RHS has varying
3257 // bits there. Use this to work out the result of the comparison.
3258 if (RExt != CI) {
3259 switch (Pred) {
Craig Toppera2886c22012-02-07 05:05:23 +00003260 default: llvm_unreachable("Unknown ICmp predicate!");
Duncan Sands8fb2c382011-01-20 13:21:55 +00003261 case ICmpInst::ICMP_EQ:
3262 return ConstantInt::getFalse(CI->getContext());
3263 case ICmpInst::ICMP_NE:
3264 return ConstantInt::getTrue(CI->getContext());
3265
3266 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
3267 // LHS >s RHS.
3268 case ICmpInst::ICMP_SGT:
3269 case ICmpInst::ICMP_SGE:
3270 return CI->getValue().isNegative() ?
3271 ConstantInt::getTrue(CI->getContext()) :
3272 ConstantInt::getFalse(CI->getContext());
3273 case ICmpInst::ICMP_SLT:
3274 case ICmpInst::ICMP_SLE:
3275 return CI->getValue().isNegative() ?
3276 ConstantInt::getFalse(CI->getContext()) :
3277 ConstantInt::getTrue(CI->getContext());
3278
3279 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
3280 // LHS >u RHS.
3281 case ICmpInst::ICMP_UGT:
3282 case ICmpInst::ICMP_UGE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003283 // Comparison is true iff the LHS <s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003284 if (MaxRecurse)
3285 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3286 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003287 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003288 return V;
3289 break;
3290 case ICmpInst::ICMP_ULT:
3291 case ICmpInst::ICMP_ULE:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00003292 // Comparison is true iff the LHS >=s 0.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003293 if (MaxRecurse)
3294 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3295 Constant::getNullValue(SrcTy),
Duncan Sandsb8cee002012-03-13 11:42:19 +00003296 Q, MaxRecurse-1))
Duncan Sands8fb2c382011-01-20 13:21:55 +00003297 return V;
3298 break;
3299 }
3300 }
3301 }
3302 }
3303 }
3304
James Molloy1d88d6f2015-10-22 13:18:42 +00003305 // icmp eq|ne X, Y -> false|true if X != Y
3306 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003307 isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
James Molloy1d88d6f2015-10-22 13:18:42 +00003308 LLVMContext &Ctx = LHS->getType()->getContext();
3309 return Pred == ICmpInst::ICMP_NE ?
3310 ConstantInt::getTrue(Ctx) : ConstantInt::getFalse(Ctx);
3311 }
Junmo Park53470fc2016-04-05 21:14:31 +00003312
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003313 if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3314 return V;
Duncan Sandsd114ab32011-02-13 17:15:40 +00003315
Sanjay Patel35289c62016-12-10 17:40:47 +00003316 if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
Sanjay Patel9d5b5e32016-12-03 18:03:53 +00003317 return V;
Duncan Sandsa2287852011-05-04 16:05:05 +00003318
Chandler Carruth8059c842012-03-25 21:28:14 +00003319 // Simplify comparisons of related pointers using a powerful, recursive
3320 // GEP-walk when we have target data available..
Dan Gohman18c77a12013-01-31 02:50:36 +00003321 if (LHS->getType()->isPointerTy())
Anna Thomas43d7e1c2016-05-03 14:58:21 +00003322 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI, LHS, RHS))
Chandler Carruth8059c842012-03-25 21:28:14 +00003323 return C;
David Majnemerdc8767a2016-08-07 07:58:10 +00003324 if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3325 if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3326 if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3327 Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3328 Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3329 Q.DL.getTypeSizeInBits(CRHS->getType()))
3330 if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI,
3331 CLHS->getPointerOperand(),
3332 CRHS->getPointerOperand()))
3333 return C;
Chandler Carruth8059c842012-03-25 21:28:14 +00003334
Nick Lewycky3db143e2012-02-26 02:09:49 +00003335 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3336 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3337 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3338 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3339 (ICmpInst::isEquality(Pred) ||
3340 (GLHS->isInBounds() && GRHS->isInBounds() &&
3341 Pred == ICmpInst::getSignedPredicate(Pred)))) {
3342 // The bases are equal and the indices are constant. Build a constant
3343 // expression GEP with the same indices and a null base pointer to see
3344 // what constant folding can make out of it.
3345 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3346 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003347 Constant *NewLHS = ConstantExpr::getGetElementPtr(
3348 GLHS->getSourceElementType(), Null, IndicesLHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003349
3350 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
David Blaikie4a2e73b2015-04-02 18:55:32 +00003351 Constant *NewRHS = ConstantExpr::getGetElementPtr(
3352 GLHS->getSourceElementType(), Null, IndicesRHS);
Nick Lewycky3db143e2012-02-26 02:09:49 +00003353 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3354 }
3355 }
3356 }
3357
David Majnemer5854e9f2014-11-16 02:20:08 +00003358 // If a bit is known to be zero for A and known to be one for B,
3359 // then A and B cannot be equal.
3360 if (ICmpInst::isEquality(Pred)) {
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003361 const APInt *RHSVal;
3362 if (match(RHS, m_APInt(RHSVal))) {
3363 unsigned BitWidth = RHSVal->getBitWidth();
Craig Topperb45eabc2017-04-26 16:39:58 +00003364 KnownBits LHSKnown(BitWidth);
3365 computeKnownBits(LHS, LHSKnown, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
3366 if (LHSKnown.Zero.intersects(*RHSVal) ||
3367 !LHSKnown.One.isSubsetOf(*RHSVal))
Sanjay Patelbcaf6f32016-08-04 17:48:04 +00003368 return Pred == ICmpInst::ICMP_EQ ? ConstantInt::getFalse(ITy)
3369 : ConstantInt::getTrue(ITy);
David Majnemer5854e9f2014-11-16 02:20:08 +00003370 }
3371 }
3372
Duncan Sandsf532d312010-11-07 16:12:23 +00003373 // If the comparison is with the result of a select instruction, check whether
3374 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003375 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003376 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003377 return V;
3378
3379 // If the comparison is with the result of a phi instruction, check whether
3380 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003381 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003382 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003383 return V;
Duncan Sandsf532d312010-11-07 16:12:23 +00003384
Craig Topper9f008862014-04-15 04:59:12 +00003385 return nullptr;
Chris Lattner084a1b52009-11-09 22:57:59 +00003386}
3387
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003388Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003389 const SimplifyQuery &Q) {
3390 return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3391}
3392
Sanjay Patel472cc782016-01-11 22:14:42 +00003393/// Given operands for an FCmpInst, see if we can fold the result.
3394/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003395static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003396 FastMathFlags FMF, const SimplifyQuery &Q,
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003397 unsigned MaxRecurse) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003398 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3399 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3400
Chris Lattnera71e9d62009-11-10 00:55:12 +00003401 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
Chris Lattnerc1f19072009-11-09 23:28:39 +00003402 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003403 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
Duncan Sands7e800d62010-11-14 11:23:23 +00003404
Chris Lattnera71e9d62009-11-10 00:55:12 +00003405 // If we have a constant, make sure it is on the RHS.
3406 std::swap(LHS, RHS);
3407 Pred = CmpInst::getSwappedPredicate(Pred);
3408 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003409
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003410 // Fold trivial predicates.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003411 Type *RetTy = GetCompareTy(LHS);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003412 if (Pred == FCmpInst::FCMP_FALSE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003413 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003414 if (Pred == FCmpInst::FCMP_TRUE)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003415 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003416
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003417 // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3418 if (FMF.noNaNs()) {
3419 if (Pred == FCmpInst::FCMP_UNO)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003420 return getFalse(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003421 if (Pred == FCmpInst::FCMP_ORD)
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003422 return getTrue(RetTy);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003423 }
3424
Mehdi Aminieb242a52015-03-09 03:20:25 +00003425 // fcmp pred x, undef and fcmp pred undef, x
3426 // fold to true if unordered, false if ordered
3427 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3428 // Choosing NaN for the undef will always make unordered comparison succeed
3429 // and ordered comparison fail.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003430 return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
Mehdi Aminieb242a52015-03-09 03:20:25 +00003431 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003432
3433 // fcmp x,x -> true/false. Not all compares are foldable.
Duncan Sands772749a2011-01-01 20:08:02 +00003434 if (LHS == RHS) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003435 if (CmpInst::isTrueWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003436 return getTrue(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003437 if (CmpInst::isFalseWhenEqual(Pred))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003438 return getFalse(RetTy);
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003439 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003440
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003441 // Handle fcmp with constant RHS
David Majnemer3ee5f342016-04-13 06:55:52 +00003442 const ConstantFP *CFP = nullptr;
3443 if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3444 if (RHS->getType()->isVectorTy())
3445 CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3446 else
3447 CFP = dyn_cast<ConstantFP>(RHSC);
3448 }
3449 if (CFP) {
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003450 // If the constant is a nan, see if we can fold the comparison based on it.
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003451 if (CFP->getValueAPF().isNaN()) {
3452 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003453 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003454 assert(FCmpInst::isUnordered(Pred) &&
3455 "Comparison must be either ordered or unordered!");
3456 // True if unordered.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003457 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003458 }
3459 // Check whether the constant is an infinity.
3460 if (CFP->getValueAPF().isInfinity()) {
3461 if (CFP->getValueAPF().isNegative()) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003462 switch (Pred) {
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003463 case FCmpInst::FCMP_OLT:
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003464 // No value is ordered and less than negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003465 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003466 case FCmpInst::FCMP_UGE:
3467 // All values are unordered with or at least negative infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003468 return getTrue(RetTy);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003469 default:
3470 break;
3471 }
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003472 } else {
3473 switch (Pred) {
3474 case FCmpInst::FCMP_OGT:
3475 // No value is ordered and greater than infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003476 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003477 case FCmpInst::FCMP_ULE:
3478 // All values are unordered with and at most infinity.
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003479 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003480 default:
3481 break;
3482 }
3483 }
3484 }
3485 if (CFP->getValueAPF().isZero()) {
3486 switch (Pred) {
3487 case FCmpInst::FCMP_UGE:
David Majnemer3ee5f342016-04-13 06:55:52 +00003488 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003489 return getTrue(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003490 break;
3491 case FCmpInst::FCMP_OLT:
3492 // X < 0
David Majnemer3ee5f342016-04-13 06:55:52 +00003493 if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
Andrea Di Biagiobff3fd62016-09-02 15:55:25 +00003494 return getFalse(RetTy);
Mehdi Amini383d7ae2015-02-13 07:38:04 +00003495 break;
3496 default:
3497 break;
3498 }
Chris Lattnerccfdceb2009-11-09 23:55:12 +00003499 }
3500 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003501
Duncan Sandsa620bd12010-11-07 16:46:25 +00003502 // If the comparison is with the result of a select instruction, check whether
3503 // comparing with either branch of the select always yields the same value.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003504 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003505 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003506 return V;
3507
3508 // If the comparison is with the result of a phi instruction, check whether
3509 // doing the compare with each incoming phi value yields a common result.
Duncan Sandsf64e6902010-12-21 09:09:15 +00003510 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
Duncan Sandsb8cee002012-03-13 11:42:19 +00003511 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
Duncan Sandsfc5ad3f02010-11-09 17:25:51 +00003512 return V;
Duncan Sandsa620bd12010-11-07 16:46:25 +00003513
Craig Topper9f008862014-04-15 04:59:12 +00003514 return nullptr;
Chris Lattnerc1f19072009-11-09 23:28:39 +00003515}
3516
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003517Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003518 FastMathFlags FMF, const SimplifyQuery &Q) {
3519 return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00003520}
3521
Sanjay Patel472cc782016-01-11 22:14:42 +00003522/// See if V simplifies when its operand Op is replaced with RepOp.
David Majnemer3f0fb982015-06-06 22:40:21 +00003523static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003524 const SimplifyQuery &Q,
David Majnemer3f0fb982015-06-06 22:40:21 +00003525 unsigned MaxRecurse) {
3526 // Trivial replacement.
3527 if (V == Op)
3528 return RepOp;
3529
3530 auto *I = dyn_cast<Instruction>(V);
3531 if (!I)
3532 return nullptr;
3533
3534 // If this is a binary operator, try to simplify it with the replaced op.
3535 if (auto *B = dyn_cast<BinaryOperator>(I)) {
3536 // Consider:
3537 // %cmp = icmp eq i32 %x, 2147483647
3538 // %add = add nsw i32 %x, 1
3539 // %sel = select i1 %cmp, i32 -2147483648, i32 %add
3540 //
3541 // We can't replace %sel with %add unless we strip away the flags.
3542 if (isa<OverflowingBinaryOperator>(B))
3543 if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3544 return nullptr;
3545 if (isa<PossiblyExactOperator>(B))
3546 if (B->isExact())
3547 return nullptr;
3548
3549 if (MaxRecurse) {
3550 if (B->getOperand(0) == Op)
3551 return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3552 MaxRecurse - 1);
3553 if (B->getOperand(1) == Op)
3554 return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3555 MaxRecurse - 1);
3556 }
3557 }
3558
3559 // Same for CmpInsts.
3560 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3561 if (MaxRecurse) {
3562 if (C->getOperand(0) == Op)
3563 return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3564 MaxRecurse - 1);
3565 if (C->getOperand(1) == Op)
3566 return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3567 MaxRecurse - 1);
3568 }
3569 }
3570
3571 // TODO: We could hand off more cases to instsimplify here.
3572
3573 // If all operands are constant after substituting Op for RepOp then we can
3574 // constant fold the instruction.
3575 if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3576 // Build a list of all constant operands.
3577 SmallVector<Constant *, 8> ConstOps;
3578 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3579 if (I->getOperand(i) == Op)
3580 ConstOps.push_back(CRepOp);
3581 else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3582 ConstOps.push_back(COp);
3583 else
3584 break;
3585 }
3586
3587 // All operands were constants, fold it.
3588 if (ConstOps.size() == I->getNumOperands()) {
3589 if (CmpInst *C = dyn_cast<CmpInst>(I))
3590 return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3591 ConstOps[1], Q.DL, Q.TLI);
3592
3593 if (LoadInst *LI = dyn_cast<LoadInst>(I))
3594 if (!LI->isVolatile())
Eduard Burtescu14239212016-01-22 01:17:26 +00003595 return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
David Majnemer3f0fb982015-06-06 22:40:21 +00003596
Manuel Jacobe9024592016-01-21 06:33:22 +00003597 return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
David Majnemer3f0fb982015-06-06 22:40:21 +00003598 }
3599 }
3600
3601 return nullptr;
3602}
3603
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003604/// Try to simplify a select instruction when its condition operand is an
3605/// integer comparison where one operand of the compare is a constant.
3606static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3607 const APInt *Y, bool TrueWhenUnset) {
3608 const APInt *C;
3609
3610 // (X & Y) == 0 ? X & ~Y : X --> X
3611 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3612 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3613 *Y == ~*C)
3614 return TrueWhenUnset ? FalseVal : TrueVal;
3615
3616 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3617 // (X & Y) != 0 ? X : X & ~Y --> X
3618 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3619 *Y == ~*C)
3620 return TrueWhenUnset ? FalseVal : TrueVal;
3621
3622 if (Y->isPowerOf2()) {
3623 // (X & Y) == 0 ? X | Y : X --> X | Y
3624 // (X & Y) != 0 ? X | Y : X --> X
3625 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3626 *Y == *C)
3627 return TrueWhenUnset ? TrueVal : FalseVal;
3628
3629 // (X & Y) == 0 ? X : X | Y --> X
3630 // (X & Y) != 0 ? X : X | Y --> X | Y
3631 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3632 *Y == *C)
3633 return TrueWhenUnset ? TrueVal : FalseVal;
3634 }
Matt Arsenault82606662017-01-11 00:57:54 +00003635
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003636 return nullptr;
3637}
3638
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003639/// An alternative way to test if a bit is set or not uses sgt/slt instead of
3640/// eq/ne.
3641static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *TrueVal,
3642 Value *FalseVal,
3643 bool TrueWhenUnset) {
3644 unsigned BitWidth = TrueVal->getType()->getScalarSizeInBits();
Sanjay Patele9fc79b2016-07-21 21:56:00 +00003645 if (!BitWidth)
3646 return nullptr;
Matt Arsenault82606662017-01-11 00:57:54 +00003647
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003648 APInt MinSignedValue;
3649 Value *X;
3650 if (match(CmpLHS, m_Trunc(m_Value(X))) && (X == TrueVal || X == FalseVal)) {
3651 // icmp slt (trunc X), 0 <--> icmp ne (and X, C), 0
3652 // icmp sgt (trunc X), -1 <--> icmp eq (and X, C), 0
3653 unsigned DestSize = CmpLHS->getType()->getScalarSizeInBits();
3654 MinSignedValue = APInt::getSignedMinValue(DestSize).zext(BitWidth);
3655 } else {
3656 // icmp slt X, 0 <--> icmp ne (and X, C), 0
3657 // icmp sgt X, -1 <--> icmp eq (and X, C), 0
3658 X = CmpLHS;
3659 MinSignedValue = APInt::getSignedMinValue(BitWidth);
3660 }
3661
3662 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, &MinSignedValue,
3663 TrueWhenUnset))
3664 return V;
3665
3666 return nullptr;
3667}
3668
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003669/// Try to simplify a select instruction when its condition operand is an
3670/// integer comparison.
3671static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003672 Value *FalseVal, const SimplifyQuery &Q,
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003673 unsigned MaxRecurse) {
3674 ICmpInst::Predicate Pred;
3675 Value *CmpLHS, *CmpRHS;
3676 if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3677 return nullptr;
3678
Sanjay Patel5f3c7032016-07-20 23:40:01 +00003679 // FIXME: This code is nearly duplicated in InstCombine. Using/refactoring
3680 // decomposeBitTestICmp() might help.
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003681 if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3682 Value *X;
3683 const APInt *Y;
3684 if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3685 if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3686 Pred == ICmpInst::ICMP_EQ))
3687 return V;
3688 } else if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, m_Zero())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003689 // Comparing signed-less-than 0 checks if the sign bit is set.
3690 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3691 false))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003692 return V;
3693 } else if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, m_AllOnes())) {
Sanjay Patela3bfb4e2016-07-21 21:26:45 +00003694 // Comparing signed-greater-than -1 checks if the sign bit is not set.
3695 if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3696 true))
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003697 return V;
3698 }
3699
3700 if (CondVal->hasOneUse()) {
3701 const APInt *C;
3702 if (match(CmpRHS, m_APInt(C))) {
3703 // X < MIN ? T : F --> F
3704 if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3705 return FalseVal;
3706 // X < MIN ? T : F --> F
3707 if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3708 return FalseVal;
3709 // X > MAX ? T : F --> F
3710 if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3711 return FalseVal;
3712 // X > MAX ? T : F --> F
3713 if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3714 return FalseVal;
3715 }
3716 }
3717
3718 // If we have an equality comparison, then we know the value in one of the
3719 // arms of the select. See if substituting this value into the arm and
3720 // simplifying the result yields the same value as the other arm.
3721 if (Pred == ICmpInst::ICMP_EQ) {
3722 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3723 TrueVal ||
3724 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3725 TrueVal)
3726 return FalseVal;
3727 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3728 FalseVal ||
3729 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3730 FalseVal)
3731 return FalseVal;
3732 } else if (Pred == ICmpInst::ICMP_NE) {
3733 if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3734 FalseVal ||
3735 SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3736 FalseVal)
3737 return TrueVal;
3738 if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3739 TrueVal ||
3740 SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3741 TrueVal)
3742 return TrueVal;
3743 }
3744
3745 return nullptr;
3746}
3747
Sanjay Patel472cc782016-01-11 22:14:42 +00003748/// Given operands for a SelectInst, see if we can fold the result.
3749/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003750static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003751 Value *FalseVal, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003752 unsigned MaxRecurse) {
Chris Lattnerc707fa92010-04-20 05:32:14 +00003753 // select true, X, Y -> X
3754 // select false, X, Y -> Y
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003755 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3756 if (CB->isAllOnesValue())
3757 return TrueVal;
3758 if (CB->isNullValue())
3759 return FalseVal;
3760 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003761
Chris Lattnerc707fa92010-04-20 05:32:14 +00003762 // select C, X, X -> X
Duncan Sands772749a2011-01-01 20:08:02 +00003763 if (TrueVal == FalseVal)
Chris Lattnerc707fa92010-04-20 05:32:14 +00003764 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003765
Chris Lattnerc707fa92010-04-20 05:32:14 +00003766 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
Daniel Berlin4d0fe642017-04-28 19:55:38 +00003767 if (isa<Constant>(FalseVal))
3768 return FalseVal;
3769 return TrueVal;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003770 }
Dan Gohman54664ed2011-07-01 01:03:43 +00003771 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3772 return FalseVal;
3773 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3774 return TrueVal;
Duncan Sands7e800d62010-11-14 11:23:23 +00003775
Sanjay Patel5f5eb582016-07-18 20:56:53 +00003776 if (Value *V =
3777 simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3778 return V;
David Majnemerc6a5e1d2014-11-27 06:32:46 +00003779
Craig Topper9f008862014-04-15 04:59:12 +00003780 return nullptr;
Chris Lattnerc707fa92010-04-20 05:32:14 +00003781}
3782
Duncan Sandsb8cee002012-03-13 11:42:19 +00003783Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003784 const SimplifyQuery &Q) {
3785 return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003786}
3787
Sanjay Patel472cc782016-01-11 22:14:42 +00003788/// Given operands for an GetElementPtrInst, see if we can fold the result.
3789/// If not, this returns null.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003790static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003791 const SimplifyQuery &Q, unsigned) {
Duncan Sands8a0f4862010-11-22 13:42:49 +00003792 // The type of the GEP pointer operand.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003793 unsigned AS =
3794 cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
Duncan Sands8a0f4862010-11-22 13:42:49 +00003795
Chris Lattner8574aba2009-11-27 00:29:05 +00003796 // getelementptr P -> P.
Jay Foadb992a632011-07-19 15:07:52 +00003797 if (Ops.size() == 1)
Chris Lattner8574aba2009-11-27 00:29:05 +00003798 return Ops[0];
3799
Nico Weber48c82402014-08-27 20:06:19 +00003800 // Compute the (pointer) type returned by the GEP instruction.
David Blaikie4a2e73b2015-04-02 18:55:32 +00003801 Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
Nico Weber48c82402014-08-27 20:06:19 +00003802 Type *GEPTy = PointerType::get(LastType, AS);
3803 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3804 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Davide Italianoa9f047a2017-04-19 14:23:42 +00003805 else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3806 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
Nico Weber48c82402014-08-27 20:06:19 +00003807
3808 if (isa<UndefValue>(Ops[0]))
Duncan Sands8a0f4862010-11-22 13:42:49 +00003809 return UndefValue::get(GEPTy);
Chris Lattner8574aba2009-11-27 00:29:05 +00003810
Jay Foadb992a632011-07-19 15:07:52 +00003811 if (Ops.size() == 2) {
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003812 // getelementptr P, 0 -> P.
Benjamin Kramer5e1794e2014-01-24 17:09:53 +00003813 if (match(Ops[1], m_Zero()))
3814 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003815
David Blaikie4a2e73b2015-04-02 18:55:32 +00003816 Type *Ty = SrcTy;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003817 if (Ty->isSized()) {
Nico Weber48c82402014-08-27 20:06:19 +00003818 Value *P;
3819 uint64_t C;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003820 uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
Nico Weber48c82402014-08-27 20:06:19 +00003821 // getelementptr P, N -> P if P points to a type of zero size.
3822 if (TyAllocSize == 0)
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003823 return Ops[0];
Nico Weber48c82402014-08-27 20:06:19 +00003824
3825 // The following transforms are only safe if the ptrtoint cast
3826 // doesn't truncate the pointers.
3827 if (Ops[1]->getType()->getScalarSizeInBits() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003828 Q.DL.getPointerSizeInBits(AS)) {
Nico Weber48c82402014-08-27 20:06:19 +00003829 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3830 if (match(P, m_Zero()))
3831 return Constant::getNullValue(GEPTy);
3832 Value *Temp;
3833 if (match(P, m_PtrToInt(m_Value(Temp))))
David Majnemer11ca2972014-08-27 20:08:34 +00003834 if (Temp->getType() == GEPTy)
3835 return Temp;
Nico Weber48c82402014-08-27 20:06:19 +00003836 return nullptr;
3837 };
3838
3839 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3840 if (TyAllocSize == 1 &&
3841 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3842 if (Value *R = PtrToIntOrZero(P))
3843 return R;
3844
3845 // getelementptr V, (ashr (sub P, V), C) -> Q
3846 // if P points to a type of size 1 << C.
3847 if (match(Ops[1],
3848 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3849 m_ConstantInt(C))) &&
3850 TyAllocSize == 1ULL << C)
3851 if (Value *R = PtrToIntOrZero(P))
3852 return R;
3853
3854 // getelementptr V, (sdiv (sub P, V), C) -> Q
3855 // if P points to a type of size C.
3856 if (match(Ops[1],
3857 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3858 m_SpecificInt(TyAllocSize))))
3859 if (Value *R = PtrToIntOrZero(P))
3860 return R;
3861 }
Duncan Sandscf4bceb2010-11-21 13:53:09 +00003862 }
3863 }
Duncan Sands7e800d62010-11-14 11:23:23 +00003864
David Majnemerd1501372016-08-07 07:58:12 +00003865 if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3866 all_of(Ops.slice(1).drop_back(1),
3867 [](Value *Idx) { return match(Idx, m_Zero()); })) {
3868 unsigned PtrWidth =
3869 Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3870 if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3871 APInt BasePtrOffset(PtrWidth, 0);
3872 Value *StrippedBasePtr =
3873 Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3874 BasePtrOffset);
3875
David Majnemer5c5df622016-08-16 06:13:46 +00003876 // gep (gep V, C), (sub 0, V) -> C
David Majnemerd1501372016-08-07 07:58:12 +00003877 if (match(Ops.back(),
3878 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3879 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3880 return ConstantExpr::getIntToPtr(CI, GEPTy);
3881 }
David Majnemer5c5df622016-08-16 06:13:46 +00003882 // gep (gep V, C), (xor V, -1) -> C-1
3883 if (match(Ops.back(),
3884 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3885 auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3886 return ConstantExpr::getIntToPtr(CI, GEPTy);
3887 }
David Majnemerd1501372016-08-07 07:58:12 +00003888 }
3889 }
3890
Chris Lattner8574aba2009-11-27 00:29:05 +00003891 // Check to see if this is constant foldable.
Jay Foadb992a632011-07-19 15:07:52 +00003892 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Chris Lattner8574aba2009-11-27 00:29:05 +00003893 if (!isa<Constant>(Ops[i]))
Craig Topper9f008862014-04-15 04:59:12 +00003894 return nullptr;
Duncan Sands7e800d62010-11-14 11:23:23 +00003895
David Blaikie4a2e73b2015-04-02 18:55:32 +00003896 return ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3897 Ops.slice(1));
Chris Lattner8574aba2009-11-27 00:29:05 +00003898}
3899
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00003900Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003901 const SimplifyQuery &Q) {
3902 return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
Duncan Sandsb8cee002012-03-13 11:42:19 +00003903}
3904
Sanjay Patel472cc782016-01-11 22:14:42 +00003905/// Given operands for an InsertValueInst, see if we can fold the result.
3906/// If not, this returns null.
Duncan Sandsb8cee002012-03-13 11:42:19 +00003907static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003908 ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
Duncan Sandsb8cee002012-03-13 11:42:19 +00003909 unsigned) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003910 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3911 if (Constant *CVal = dyn_cast<Constant>(Val))
3912 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3913
3914 // insertvalue x, undef, n -> x
3915 if (match(Val, m_Undef()))
3916 return Agg;
3917
3918 // insertvalue x, (extractvalue y, n), n
3919 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
Benjamin Kramer4b79c212011-09-05 18:16:19 +00003920 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3921 EV->getIndices() == Idxs) {
Duncan Sandsfd26a952011-09-05 06:52:48 +00003922 // insertvalue undef, (extractvalue y, n), n -> y
3923 if (match(Agg, m_Undef()))
3924 return EV->getAggregateOperand();
3925
3926 // insertvalue y, (extractvalue y, n), n -> y
3927 if (Agg == EV->getAggregateOperand())
3928 return Agg;
3929 }
3930
Craig Topper9f008862014-04-15 04:59:12 +00003931 return nullptr;
Duncan Sandsfd26a952011-09-05 06:52:48 +00003932}
3933
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003934Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3935 ArrayRef<unsigned> Idxs,
3936 const SimplifyQuery &Q) {
3937 return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3938}
3939
Sanjay Patel472cc782016-01-11 22:14:42 +00003940/// Given operands for an ExtractValueInst, see if we can fold the result.
3941/// If not, this returns null.
David Majnemer25a796e2015-07-13 01:15:46 +00003942static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003943 const SimplifyQuery &, unsigned) {
David Majnemer25a796e2015-07-13 01:15:46 +00003944 if (auto *CAgg = dyn_cast<Constant>(Agg))
3945 return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3946
3947 // extractvalue x, (insertvalue y, elt, n), n -> elt
3948 unsigned NumIdxs = Idxs.size();
3949 for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3950 IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3951 ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3952 unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3953 unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3954 if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3955 Idxs.slice(0, NumCommonIdxs)) {
3956 if (NumIdxs == NumInsertValueIdxs)
3957 return IVI->getInsertedValueOperand();
3958 break;
3959 }
3960 }
3961
3962 return nullptr;
3963}
3964
3965Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003966 const SimplifyQuery &Q) {
3967 return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
3968}
3969
Sanjay Patel472cc782016-01-11 22:14:42 +00003970/// Given operands for an ExtractElementInst, see if we can fold the result.
3971/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003972static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
David Majnemer599ca442015-07-13 01:15:53 +00003973 unsigned) {
3974 if (auto *CVec = dyn_cast<Constant>(Vec)) {
3975 if (auto *CIdx = dyn_cast<Constant>(Idx))
3976 return ConstantFoldExtractElementInstruction(CVec, CIdx);
3977
3978 // The index is not relevant if our vector is a splat.
3979 if (auto *Splat = CVec->getSplatValue())
3980 return Splat;
3981
3982 if (isa<UndefValue>(Vec))
3983 return UndefValue::get(Vec->getType()->getVectorElementType());
3984 }
3985
3986 // If extracting a specified index from the vector, see if we can recursively
3987 // find a previously computed scalar that was inserted into the vector.
David Majnemer8e335ca2015-08-18 22:18:22 +00003988 if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3989 if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
David Majnemer599ca442015-07-13 01:15:53 +00003990 return Elt;
David Majnemer599ca442015-07-13 01:15:53 +00003991
3992 return nullptr;
3993}
3994
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00003995Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
3996 const SimplifyQuery &Q) {
3997 return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
3998}
3999
Sanjay Patel472cc782016-01-11 22:14:42 +00004000/// See if we can fold the given phi. If not, returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004001static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004002 // If all of the PHI's incoming values are the same then replace the PHI node
4003 // with the common value.
Craig Topper9f008862014-04-15 04:59:12 +00004004 Value *CommonValue = nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004005 bool HasUndefInput = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00004006 for (Value *Incoming : PN->incoming_values()) {
Duncan Sands7412f6e2010-11-17 04:30:22 +00004007 // If the incoming value is the phi node itself, it can safely be skipped.
4008 if (Incoming == PN) continue;
4009 if (isa<UndefValue>(Incoming)) {
4010 // Remember that we saw an undef value, but otherwise ignore them.
4011 HasUndefInput = true;
4012 continue;
4013 }
4014 if (CommonValue && Incoming != CommonValue)
Craig Topper9f008862014-04-15 04:59:12 +00004015 return nullptr; // Not the same, bail out.
Duncan Sands7412f6e2010-11-17 04:30:22 +00004016 CommonValue = Incoming;
4017 }
4018
4019 // If CommonValue is null then all of the incoming values were either undef or
4020 // equal to the phi node itself.
4021 if (!CommonValue)
4022 return UndefValue::get(PN->getType());
4023
4024 // If we have a PHI node like phi(X, undef, X), where X is defined by some
4025 // instruction, we cannot return X as the result of the PHI node unless it
4026 // dominates the PHI block.
4027 if (HasUndefInput)
Craig Topper9f008862014-04-15 04:59:12 +00004028 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
Duncan Sands7412f6e2010-11-17 04:30:22 +00004029
4030 return CommonValue;
4031}
4032
David Majnemer6774d612016-07-26 17:58:05 +00004033static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004034 Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer126de5d2016-07-25 03:39:21 +00004035 if (auto *C = dyn_cast<Constant>(Op))
David Majnemer6774d612016-07-26 17:58:05 +00004036 return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
Duncan Sands395ac42d2012-03-13 14:07:05 +00004037
David Majnemer6774d612016-07-26 17:58:05 +00004038 if (auto *CI = dyn_cast<CastInst>(Op)) {
4039 auto *Src = CI->getOperand(0);
4040 Type *SrcTy = Src->getType();
4041 Type *MidTy = CI->getType();
4042 Type *DstTy = Ty;
4043 if (Src->getType() == Ty) {
4044 auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4045 auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4046 Type *SrcIntPtrTy =
4047 SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4048 Type *MidIntPtrTy =
4049 MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4050 Type *DstIntPtrTy =
4051 DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4052 if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4053 SrcIntPtrTy, MidIntPtrTy,
4054 DstIntPtrTy) == Instruction::BitCast)
4055 return Src;
4056 }
4057 }
David Majnemera90a6212016-07-26 05:52:29 +00004058
4059 // bitcast x -> x
David Majnemer6774d612016-07-26 17:58:05 +00004060 if (CastOpc == Instruction::BitCast)
4061 if (Op->getType() == Ty)
4062 return Op;
David Majnemera90a6212016-07-26 05:52:29 +00004063
4064 return nullptr;
4065}
4066
David Majnemer6774d612016-07-26 17:58:05 +00004067Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004068 const SimplifyQuery &Q) {
4069 return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4070}
4071
Sanjay Patela3c297d2017-04-19 16:48:22 +00004072/// For the given destination element of a shuffle, peek through shuffles to
4073/// match a root vector source operand that contains that element in the same
4074/// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4075static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
Zvi Rackover558f86b2017-05-08 15:46:58 +00004076 int MaskVal, Value *RootVec,
Sanjay Patela3c297d2017-04-19 16:48:22 +00004077 unsigned MaxRecurse) {
4078 if (!MaxRecurse--)
4079 return nullptr;
4080
4081 // Bail out if any mask value is undefined. That kind of shuffle may be
4082 // simplified further based on demanded bits or other folds.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004083 if (MaskVal == -1)
4084 return nullptr;
4085
4086 // The mask value chooses which source operand we need to look at next.
Sanjay Patela3c297d2017-04-19 16:48:22 +00004087 int InVecNumElts = Op0->getType()->getVectorNumElements();
Zvi Rackover558f86b2017-05-08 15:46:58 +00004088 int RootElt = MaskVal;
4089 Value *SourceOp = Op0;
4090 if (MaskVal >= InVecNumElts) {
Sanjay Patela3c297d2017-04-19 16:48:22 +00004091 RootElt = MaskVal - InVecNumElts;
4092 SourceOp = Op1;
4093 }
4094
4095 // If the source operand is a shuffle itself, look through it to find the
4096 // matching root vector.
4097 if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4098 return foldIdentityShuffles(
4099 DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
Zvi Rackover558f86b2017-05-08 15:46:58 +00004100 SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004101 }
4102
4103 // TODO: Look through bitcasts? What if the bitcast changes the vector element
4104 // size?
4105
4106 // The source operand is not a shuffle. Initialize the root vector value for
4107 // this shuffle if that has not been done yet.
4108 if (!RootVec)
4109 RootVec = SourceOp;
4110
4111 // Give up as soon as a source operand does not match the existing root value.
4112 if (RootVec != SourceOp)
4113 return nullptr;
4114
4115 // The element must be coming from the same lane in the source vector
4116 // (although it may have crossed lanes in intermediate shuffles).
4117 if (RootElt != DestElt)
4118 return nullptr;
4119
4120 return RootVec;
4121}
4122
Zvi Rackover8f460652017-04-03 22:05:30 +00004123static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004124 Type *RetTy, const SimplifyQuery &Q,
Zvi Rackover8f460652017-04-03 22:05:30 +00004125 unsigned MaxRecurse) {
Zvi Rackover4086e132017-04-30 06:06:26 +00004126 if (isa<UndefValue>(Mask))
4127 return UndefValue::get(RetTy);
4128
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004129 Type *InVecTy = Op0->getType();
Zvi Rackover8f460652017-04-03 22:05:30 +00004130 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004131 unsigned InVecNumElts = InVecTy->getVectorNumElements();
Zvi Rackover8f460652017-04-03 22:05:30 +00004132
Zvi Rackover0411e462017-04-30 06:10:54 +00004133 SmallVector<int, 32> Indices;
4134 ShuffleVectorInst::getShuffleMask(Mask, Indices);
4135 assert(MaskNumElts == Indices.size() &&
4136 "Size of Indices not same as number of mask elements?");
4137
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004138 // Canonicalization: If mask does not select elements from an input vector,
4139 // replace that input vector with undef.
Zvi Rackover8f460652017-04-03 22:05:30 +00004140 bool MaskSelects0 = false, MaskSelects1 = false;
4141 for (unsigned i = 0; i != MaskNumElts; ++i) {
Zvi Rackover0411e462017-04-30 06:10:54 +00004142 if (Indices[i] == -1)
Zvi Rackover8f460652017-04-03 22:05:30 +00004143 continue;
Zvi Rackover0411e462017-04-30 06:10:54 +00004144 if ((unsigned)Indices[i] < InVecNumElts)
Zvi Rackover8f460652017-04-03 22:05:30 +00004145 MaskSelects0 = true;
4146 else
4147 MaskSelects1 = true;
4148 }
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004149 if (!MaskSelects0)
4150 Op0 = UndefValue::get(InVecTy);
4151 if (!MaskSelects1)
4152 Op1 = UndefValue::get(InVecTy);
4153
4154 auto *Op0Const = dyn_cast<Constant>(Op0);
4155 auto *Op1Const = dyn_cast<Constant>(Op1);
4156
4157 // If all operands are constant, constant fold the shuffle.
4158 if (Op0Const && Op1Const)
4159 return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4160
4161 // Canonicalization: if only one input vector is constant, it shall be the
4162 // second one.
4163 if (Op0Const && !Op1Const) {
4164 std::swap(Op0, Op1);
Zvi Rackoverdfbd3d72017-05-08 12:40:18 +00004165 ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004166 }
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004167
4168 // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4169 // value type is same as the input vectors' type.
4170 if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
Zvi Rackover973ff7c2017-05-07 18:16:37 +00004171 if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
Zvi Rackover30efd24d2017-04-11 21:37:02 +00004172 OpShuf->getMask()->getSplatValue())
4173 return Op0;
Zvi Rackover8f460652017-04-03 22:05:30 +00004174
Sanjay Patela3c297d2017-04-19 16:48:22 +00004175 // Don't fold a shuffle with undef mask elements. This may get folded in a
4176 // better way using demanded bits or other analysis.
4177 // TODO: Should we allow this?
Zvi Rackover0411e462017-04-30 06:10:54 +00004178 if (find(Indices, -1) != Indices.end())
4179 return nullptr;
Sanjay Patela3c297d2017-04-19 16:48:22 +00004180
4181 // Check if every element of this shuffle can be mapped back to the
4182 // corresponding element of a single root vector. If so, we don't need this
4183 // shuffle. This handles simple identity shuffles as well as chains of
4184 // shuffles that may widen/narrow and/or move elements across lanes and back.
4185 Value *RootVec = nullptr;
4186 for (unsigned i = 0; i != MaskNumElts; ++i) {
4187 // Note that recursion is limited for each vector element, so if any element
4188 // exceeds the limit, this will fail to simplify.
Zvi Rackover558f86b2017-05-08 15:46:58 +00004189 RootVec =
4190 foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
Sanjay Patela3c297d2017-04-19 16:48:22 +00004191
4192 // We can't replace a widening/narrowing shuffle with one of its operands.
4193 if (!RootVec || RootVec->getType() != RetTy)
4194 return nullptr;
4195 }
4196 return RootVec;
Zvi Rackover8f460652017-04-03 22:05:30 +00004197}
4198
4199/// Given operands for a ShuffleVectorInst, fold the result or return null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004200Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4201 Type *RetTy, const SimplifyQuery &Q) {
4202 return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
Zvi Rackover8f460652017-04-03 22:05:30 +00004203}
4204
Chris Lattnera71e9d62009-11-10 00:55:12 +00004205//=== Helper functions for higher up the class hierarchy.
Chris Lattnerc1f19072009-11-09 23:28:39 +00004206
Sanjay Patel472cc782016-01-11 22:14:42 +00004207/// Given operands for a BinaryOperator, see if we can fold the result.
4208/// If not, this returns null.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004209static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004210 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chris Lattnera71e9d62009-11-10 00:55:12 +00004211 switch (Opcode) {
Chris Lattner9e4aa022011-02-09 17:15:04 +00004212 case Instruction::Add:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004213 return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004214 case Instruction::FAdd:
4215 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004216 case Instruction::Sub:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004217 return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004218 case Instruction::FSub:
4219 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004220 case Instruction::Mul:
4221 return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
Michael Ilsemand2b05e52012-12-12 00:29:16 +00004222 case Instruction::FMul:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004223 return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4224 case Instruction::SDiv:
4225 return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4226 case Instruction::UDiv:
4227 return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004228 case Instruction::FDiv:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004229 return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4230 case Instruction::SRem:
4231 return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4232 case Instruction::URem:
4233 return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004234 case Instruction::FRem:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004235 return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004236 case Instruction::Shl:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004237 return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004238 case Instruction::LShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004239 return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
Chris Lattner9e4aa022011-02-09 17:15:04 +00004240 case Instruction::AShr:
Sanjay Patel1fd16f02017-04-01 18:40:30 +00004241 return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4242 case Instruction::And:
4243 return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4244 case Instruction::Or:
4245 return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4246 case Instruction::Xor:
4247 return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
Chris Lattnera71e9d62009-11-10 00:55:12 +00004248 default:
Craig Topper8ef20ea2017-04-06 18:59:08 +00004249 llvm_unreachable("Unexpected opcode");
Chris Lattnera71e9d62009-11-10 00:55:12 +00004250 }
4251}
Chris Lattnerc1f19072009-11-09 23:28:39 +00004252
Sanjay Patel472cc782016-01-11 22:14:42 +00004253/// Given operands for a BinaryOperator, see if we can fold the result.
4254/// If not, this returns null.
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004255/// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4256/// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4257static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004258 const FastMathFlags &FMF, const SimplifyQuery &Q,
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004259 unsigned MaxRecurse) {
4260 switch (Opcode) {
4261 case Instruction::FAdd:
4262 return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4263 case Instruction::FSub:
4264 return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4265 case Instruction::FMul:
4266 return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
Zia Ansari394cef82016-12-08 23:27:40 +00004267 case Instruction::FDiv:
4268 return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004269 default:
4270 return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4271 }
4272}
4273
Duncan Sands7e800d62010-11-14 11:23:23 +00004274Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004275 const SimplifyQuery &Q) {
4276 return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4277}
4278
Michael Zolotukhin4e8598e2015-02-06 20:02:51 +00004279Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
Daniel Berline8d74dc2017-04-26 04:10:00 +00004280 FastMathFlags FMF, const SimplifyQuery &Q) {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004281 return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4282}
4283
Sanjay Patel472cc782016-01-11 22:14:42 +00004284/// Given operands for a CmpInst, see if we can fold the result.
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004285static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004286 const SimplifyQuery &Q, unsigned MaxRecurse) {
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004287 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
Duncan Sandsb8cee002012-03-13 11:42:19 +00004288 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00004289 return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
Duncan Sandsf3b1bf12010-11-10 18:23:01 +00004290}
4291
4292Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004293 const SimplifyQuery &Q) {
4294 return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4295}
4296
Michael Ilseman54857292013-02-07 19:26:05 +00004297static bool IsIdempotent(Intrinsic::ID ID) {
4298 switch (ID) {
4299 default: return false;
4300
4301 // Unary idempotent: f(f(x)) = f(x)
4302 case Intrinsic::fabs:
4303 case Intrinsic::floor:
4304 case Intrinsic::ceil:
4305 case Intrinsic::trunc:
4306 case Intrinsic::rint:
4307 case Intrinsic::nearbyint:
Hal Finkel171817e2013-08-07 22:49:12 +00004308 case Intrinsic::round:
Michael Ilseman54857292013-02-07 19:26:05 +00004309 return true;
4310 }
4311}
4312
Peter Collingbourne7dd8dbf2016-04-22 21:18:02 +00004313static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4314 const DataLayout &DL) {
4315 GlobalValue *PtrSym;
4316 APInt PtrOffset;
4317 if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4318 return nullptr;
4319
4320 Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4321 Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4322 Type *Int32PtrTy = Int32Ty->getPointerTo();
4323 Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4324
4325 auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4326 if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4327 return nullptr;
4328
4329 uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4330 if (OffsetInt % 4 != 0)
4331 return nullptr;
4332
4333 Constant *C = ConstantExpr::getGetElementPtr(
4334 Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4335 ConstantInt::get(Int64Ty, OffsetInt / 4));
4336 Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4337 if (!Loaded)
4338 return nullptr;
4339
4340 auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4341 if (!LoadedCE)
4342 return nullptr;
4343
4344 if (LoadedCE->getOpcode() == Instruction::Trunc) {
4345 LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4346 if (!LoadedCE)
4347 return nullptr;
4348 }
4349
4350 if (LoadedCE->getOpcode() != Instruction::Sub)
4351 return nullptr;
4352
4353 auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4354 if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4355 return nullptr;
4356 auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4357
4358 Constant *LoadedRHS = LoadedCE->getOperand(1);
4359 GlobalValue *LoadedRHSSym;
4360 APInt LoadedRHSOffset;
4361 if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4362 DL) ||
4363 PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4364 return nullptr;
4365
4366 return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4367}
4368
David Majnemer17a95aa2016-07-14 06:58:37 +00004369static bool maskIsAllZeroOrUndef(Value *Mask) {
4370 auto *ConstMask = dyn_cast<Constant>(Mask);
4371 if (!ConstMask)
4372 return false;
4373 if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4374 return true;
4375 for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4376 ++I) {
4377 if (auto *MaskElt = ConstMask->getAggregateElement(I))
4378 if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4379 continue;
4380 return false;
4381 }
4382 return true;
4383}
4384
Michael Ilseman54857292013-02-07 19:26:05 +00004385template <typename IterTy>
David Majnemer15032582015-05-22 03:56:46 +00004386static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004387 const SimplifyQuery &Q, unsigned MaxRecurse) {
David Majnemer15032582015-05-22 03:56:46 +00004388 Intrinsic::ID IID = F->getIntrinsicID();
4389 unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
Michael Ilseman54857292013-02-07 19:26:05 +00004390
4391 // Unary Ops
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004392 if (NumOperands == 1) {
Matt Arsenault82606662017-01-11 00:57:54 +00004393 // Perform idempotent optimizations
4394 if (IsIdempotent(IID)) {
4395 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4396 if (II->getIntrinsicID() == IID)
4397 return II;
4398 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004399 }
4400
4401 switch (IID) {
4402 case Intrinsic::fabs: {
4403 if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4404 return *ArgBegin;
Marcello Maggioni0616b5f2017-01-14 07:28:47 +00004405 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004406 }
4407 default:
Matt Arsenault82606662017-01-11 00:57:54 +00004408 return nullptr;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00004409 }
4410 }
Michael Ilseman54857292013-02-07 19:26:05 +00004411
Matt Arsenault82606662017-01-11 00:57:54 +00004412 // Binary Ops
4413 if (NumOperands == 2) {
4414 Value *LHS = *ArgBegin;
4415 Value *RHS = *(ArgBegin + 1);
4416 Type *ReturnType = F->getReturnType();
4417
4418 switch (IID) {
4419 case Intrinsic::usub_with_overflow:
4420 case Intrinsic::ssub_with_overflow: {
4421 // X - X -> { 0, false }
4422 if (LHS == RHS)
4423 return Constant::getNullValue(ReturnType);
4424
4425 // X - undef -> undef
4426 // undef - X -> undef
4427 if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4428 return UndefValue::get(ReturnType);
4429
4430 return nullptr;
4431 }
4432 case Intrinsic::uadd_with_overflow:
4433 case Intrinsic::sadd_with_overflow: {
4434 // X + undef -> undef
4435 if (isa<UndefValue>(RHS))
4436 return UndefValue::get(ReturnType);
4437
4438 return nullptr;
4439 }
4440 case Intrinsic::umul_with_overflow:
4441 case Intrinsic::smul_with_overflow: {
4442 // X * 0 -> { 0, false }
4443 if (match(RHS, m_Zero()))
4444 return Constant::getNullValue(ReturnType);
4445
4446 // X * undef -> { 0, false }
4447 if (match(RHS, m_Undef()))
4448 return Constant::getNullValue(ReturnType);
4449
4450 return nullptr;
4451 }
4452 case Intrinsic::load_relative: {
4453 Constant *C0 = dyn_cast<Constant>(LHS);
4454 Constant *C1 = dyn_cast<Constant>(RHS);
4455 if (C0 && C1)
4456 return SimplifyRelativeLoad(C0, C1, Q.DL);
4457 return nullptr;
4458 }
4459 default:
4460 return nullptr;
4461 }
4462 }
4463
4464 // Simplify calls to llvm.masked.load.*
4465 switch (IID) {
4466 case Intrinsic::masked_load: {
4467 Value *MaskArg = ArgBegin[2];
4468 Value *PassthruArg = ArgBegin[3];
4469 // If the mask is all zeros or undef, the "passthru" argument is the result.
4470 if (maskIsAllZeroOrUndef(MaskArg))
4471 return PassthruArg;
4472 return nullptr;
4473 }
4474 default:
4475 return nullptr;
4476 }
Michael Ilseman54857292013-02-07 19:26:05 +00004477}
4478
Chandler Carruth9dc35582012-12-28 11:30:55 +00004479template <typename IterTy>
Chandler Carruthf6182152012-12-28 14:23:29 +00004480static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004481 const SimplifyQuery &Q, unsigned MaxRecurse) {
Chandler Carruthf6182152012-12-28 14:23:29 +00004482 Type *Ty = V->getType();
Chandler Carruth9dc35582012-12-28 11:30:55 +00004483 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4484 Ty = PTy->getElementType();
4485 FunctionType *FTy = cast<FunctionType>(Ty);
4486
Dan Gohman85977e62011-11-04 18:32:42 +00004487 // call undef -> undef
David Majnemerbb53d232016-06-25 07:37:30 +00004488 // call null -> undef
4489 if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
Chandler Carruth9dc35582012-12-28 11:30:55 +00004490 return UndefValue::get(FTy->getReturnType());
Dan Gohman85977e62011-11-04 18:32:42 +00004491
Chandler Carruthf6182152012-12-28 14:23:29 +00004492 Function *F = dyn_cast<Function>(V);
4493 if (!F)
Craig Topper9f008862014-04-15 04:59:12 +00004494 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004495
David Majnemer15032582015-05-22 03:56:46 +00004496 if (F->isIntrinsic())
4497 if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
Michael Ilseman54857292013-02-07 19:26:05 +00004498 return Ret;
4499
Chandler Carruthf6182152012-12-28 14:23:29 +00004500 if (!canConstantFoldCallTo(F))
Craig Topper9f008862014-04-15 04:59:12 +00004501 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004502
4503 SmallVector<Constant *, 4> ConstantArgs;
4504 ConstantArgs.reserve(ArgEnd - ArgBegin);
4505 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4506 Constant *C = dyn_cast<Constant>(*I);
4507 if (!C)
Craig Topper9f008862014-04-15 04:59:12 +00004508 return nullptr;
Chandler Carruthf6182152012-12-28 14:23:29 +00004509 ConstantArgs.push_back(C);
4510 }
4511
4512 return ConstantFoldCall(F, ConstantArgs, Q.TLI);
Dan Gohman85977e62011-11-04 18:32:42 +00004513}
4514
Chandler Carruthf6182152012-12-28 14:23:29 +00004515Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004516 User::op_iterator ArgEnd, const SimplifyQuery &Q) {
4517 return ::SimplifyCall(V, ArgBegin, ArgEnd, Q, RecursionLimit);
4518}
4519
Chandler Carruthf6182152012-12-28 14:23:29 +00004520Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004521 const SimplifyQuery &Q) {
4522 return ::SimplifyCall(V, Args.begin(), Args.end(), Q, RecursionLimit);
Chandler Carruth9dc35582012-12-28 11:30:55 +00004523}
4524
Sanjay Patel472cc782016-01-11 22:14:42 +00004525/// See if we can compute a simplified version of this instruction.
4526/// If not, this returns null.
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004527
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004528Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004529 OptimizationRemarkEmitter *ORE) {
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004530 const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004531 Value *Result;
4532
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004533 switch (I->getOpcode()) {
4534 default:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004535 Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004536 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004537 case Instruction::FAdd:
4538 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004539 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004540 break;
Chris Lattner3d9823b2009-11-27 17:42:22 +00004541 case Instruction::Add:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004542 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4543 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004544 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004545 break;
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004546 case Instruction::FSub:
4547 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004548 I->getFastMathFlags(), Q);
Michael Ilsemanbb6f6912012-12-12 00:27:46 +00004549 break;
Duncan Sands0a2c41682010-12-15 14:07:39 +00004550 case Instruction::Sub:
4551 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4552 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004553 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands0a2c41682010-12-15 14:07:39 +00004554 break;
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004555 case Instruction::FMul:
4556 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004557 I->getFastMathFlags(), Q);
Michael Ilsemanbe9137a2012-11-27 00:46:26 +00004558 break;
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004559 case Instruction::Mul:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004560 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsd0eb6d32010-12-21 14:00:22 +00004561 break;
Duncan Sands771e82a2011-01-28 16:51:11 +00004562 case Instruction::SDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004563 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004564 break;
4565 case Instruction::UDiv:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004566 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands771e82a2011-01-28 16:51:11 +00004567 break;
Frits van Bommelc2549662011-01-29 15:26:31 +00004568 case Instruction::FDiv:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004569 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004570 I->getFastMathFlags(), Q);
Frits van Bommelc2549662011-01-29 15:26:31 +00004571 break;
Duncan Sandsa3e36992011-05-02 16:27:02 +00004572 case Instruction::SRem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004573 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004574 break;
4575 case Instruction::URem:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004576 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004577 break;
4578 case Instruction::FRem:
Mehdi Aminicd3ca6f2015-02-23 18:30:25 +00004579 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004580 I->getFastMathFlags(), Q);
Duncan Sandsa3e36992011-05-02 16:27:02 +00004581 break;
Duncan Sands7f60dc12011-01-14 00:37:45 +00004582 case Instruction::Shl:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004583 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4584 cast<BinaryOperator>(I)->hasNoSignedWrap(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004585 cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004586 break;
4587 case Instruction::LShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004588 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004589 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004590 break;
4591 case Instruction::AShr:
Chris Lattner9e4aa022011-02-09 17:15:04 +00004592 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004593 cast<BinaryOperator>(I)->isExact(), Q);
Duncan Sands7f60dc12011-01-14 00:37:45 +00004594 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004595 case Instruction::And:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004596 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004597 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004598 case Instruction::Or:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004599 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004600 break;
Duncan Sandsc89ac072010-11-17 18:52:15 +00004601 case Instruction::Xor:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004602 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
Duncan Sandsc89ac072010-11-17 18:52:15 +00004603 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004604 case Instruction::ICmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004605 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4606 I->getOperand(0), I->getOperand(1), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004607 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004608 case Instruction::FCmp:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004609 Result =
4610 SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4611 I->getOperand(1), I->getFastMathFlags(), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004612 break;
Chris Lattnerc707fa92010-04-20 05:32:14 +00004613 case Instruction::Select:
Duncan Sands64e41cf2010-11-17 08:35:29 +00004614 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004615 I->getOperand(2), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004616 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004617 case Instruction::GetElementPtr: {
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004618 SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
Manuel Jacob20c6d5b2016-01-17 22:46:43 +00004619 Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004620 Ops, Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004621 break;
Chris Lattner8574aba2009-11-27 00:29:05 +00004622 }
Duncan Sandsfd26a952011-09-05 06:52:48 +00004623 case Instruction::InsertValue: {
4624 InsertValueInst *IV = cast<InsertValueInst>(I);
4625 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4626 IV->getInsertedValueOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004627 IV->getIndices(), Q);
Duncan Sandsfd26a952011-09-05 06:52:48 +00004628 break;
4629 }
David Majnemer25a796e2015-07-13 01:15:46 +00004630 case Instruction::ExtractValue: {
4631 auto *EVI = cast<ExtractValueInst>(I);
4632 Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004633 EVI->getIndices(), Q);
David Majnemer25a796e2015-07-13 01:15:46 +00004634 break;
4635 }
David Majnemer599ca442015-07-13 01:15:53 +00004636 case Instruction::ExtractElement: {
4637 auto *EEI = cast<ExtractElementInst>(I);
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004638 Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4639 EEI->getIndexOperand(), Q);
David Majnemer599ca442015-07-13 01:15:53 +00004640 break;
4641 }
Zvi Rackover8f460652017-04-03 22:05:30 +00004642 case Instruction::ShuffleVector: {
4643 auto *SVI = cast<ShuffleVectorInst>(I);
4644 Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004645 SVI->getMask(), SVI->getType(), Q);
Zvi Rackover8f460652017-04-03 22:05:30 +00004646 break;
4647 }
Duncan Sands4581ddc2010-11-14 13:30:18 +00004648 case Instruction::PHI:
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004649 Result = SimplifyPHINode(cast<PHINode>(I), Q);
Duncan Sands64e41cf2010-11-17 08:35:29 +00004650 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004651 case Instruction::Call: {
4652 CallSite CS(cast<CallInst>(I));
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004653 Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(), Q);
Dan Gohman85977e62011-11-04 18:32:42 +00004654 break;
Chandler Carruth9dc35582012-12-28 11:30:55 +00004655 }
David Majnemer6774d612016-07-26 17:58:05 +00004656#define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4657#include "llvm/IR/Instruction.def"
4658#undef HANDLE_CAST_INST
Daniel Berlin5e3fcb12017-04-26 04:09:56 +00004659 Result =
4660 SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
David Majnemera90a6212016-07-26 05:52:29 +00004661 break;
Craig Topper81c03a72017-04-12 22:54:24 +00004662 case Instruction::Alloca:
4663 // No simplifications for Alloca and it can't be constant folded.
4664 Result = nullptr;
4665 break;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004666 }
Duncan Sands64e41cf2010-11-17 08:35:29 +00004667
Hal Finkelf2199b22015-10-23 20:37:08 +00004668 // In general, it is possible for computeKnownBits to determine all bits in a
4669 // value even when the operands are not all constants.
Sanjay Patel8ca30ab2016-11-27 21:07:28 +00004670 if (!Result && I->getType()->isIntOrIntVectorTy()) {
Hal Finkelf2199b22015-10-23 20:37:08 +00004671 unsigned BitWidth = I->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +00004672 KnownBits Known(BitWidth);
4673 computeKnownBits(I, Known, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
Craig Topper8189a872017-05-03 23:12:29 +00004674 if (Known.isConstant())
4675 Result = ConstantInt::get(I->getType(), Known.getConstant());
Hal Finkelf2199b22015-10-23 20:37:08 +00004676 }
4677
Duncan Sands64e41cf2010-11-17 08:35:29 +00004678 /// If called on unreachable code, the above logic may report that the
4679 /// instruction simplified to itself. Make life easier for users by
Duncan Sands019a4182010-12-15 11:02:22 +00004680 /// detecting that case here, returning a safe value instead.
4681 return Result == I ? UndefValue::get(I->getType()) : Result;
Chris Lattnerfb7f87d2009-11-10 01:08:51 +00004682}
4683
Sanjay Patelf44bd382016-01-20 18:59:48 +00004684/// \brief Implementation of recursive simplification through an instruction's
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004685/// uses.
Chris Lattner852d6d62009-11-10 22:26:15 +00004686///
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004687/// This is the common implementation of the recursive simplification routines.
4688/// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4689/// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4690/// instructions to process and attempt to simplify it using
4691/// InstructionSimplify.
4692///
4693/// This routine returns 'true' only when *it* simplifies something. The passed
4694/// in simplified value does not count toward this.
4695static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004696 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004697 const DominatorTree *DT,
4698 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004699 bool Simplified = false;
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004700 SmallSetVector<Instruction *, 8> Worklist;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004701 const DataLayout &DL = I->getModule()->getDataLayout();
Duncan Sands7e800d62010-11-14 11:23:23 +00004702
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004703 // If we have an explicit value to collapse to, do that round of the
4704 // simplification loop by hand initially.
4705 if (SimpleV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00004706 for (User *U : I->users())
4707 if (U != I)
4708 Worklist.insert(cast<Instruction>(U));
Duncan Sands7e800d62010-11-14 11:23:23 +00004709
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004710 // Replace the instruction with its simplified value.
4711 I->replaceAllUsesWith(SimpleV);
Chris Lattner19eff2a2010-07-15 06:36:08 +00004712
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004713 // Gracefully handle edge cases where the instruction is not wired into any
4714 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004715 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4716 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004717 I->eraseFromParent();
4718 } else {
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004719 Worklist.insert(I);
Chris Lattner852d6d62009-11-10 22:26:15 +00004720 }
Duncan Sands7e800d62010-11-14 11:23:23 +00004721
Chandler Carruth77e8bfb2012-03-24 22:34:26 +00004722 // Note that we must test the size on each iteration, the worklist can grow.
4723 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4724 I = Worklist[Idx];
Duncan Sands7e800d62010-11-14 11:23:23 +00004725
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004726 // See if this instruction simplifies.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004727 SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004728 if (!SimpleV)
4729 continue;
4730
4731 Simplified = true;
4732
4733 // Stash away all the uses of the old instruction so we can check them for
4734 // recursive simplifications after a RAUW. This is cheaper than checking all
4735 // uses of To on the recursive step in most cases.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004736 for (User *U : I->users())
4737 Worklist.insert(cast<Instruction>(U));
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004738
4739 // Replace the instruction with its simplified value.
4740 I->replaceAllUsesWith(SimpleV);
4741
4742 // Gracefully handle edge cases where the instruction is not wired into any
4743 // parent block.
David Majnemer909793f2016-08-04 04:24:02 +00004744 if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4745 !I->mayHaveSideEffects())
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004746 I->eraseFromParent();
4747 }
4748 return Simplified;
4749}
4750
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004751bool llvm::recursivelySimplifyInstruction(Instruction *I,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004752 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004753 const DominatorTree *DT,
4754 AssumptionCache *AC) {
4755 return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004756}
4757
4758bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004759 const TargetLibraryInfo *TLI,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004760 const DominatorTree *DT,
4761 AssumptionCache *AC) {
Chandler Carruthcf1b5852012-03-24 21:11:24 +00004762 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4763 assert(SimpleV && "Must provide a simplified value.");
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004764 return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
Chris Lattner852d6d62009-11-10 22:26:15 +00004765}
Daniel Berlin4d0fe642017-04-28 19:55:38 +00004766
4767namespace llvm {
4768const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
4769 auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
4770 auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
4771 auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
4772 auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
4773 auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
4774 auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
4775 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4776}
4777
4778const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
4779 const DataLayout &DL) {
4780 return {DL, &AR.TLI, &AR.DT, &AR.AC};
4781}
4782
4783template <class T, class... TArgs>
4784const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
4785 Function &F) {
4786 auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
4787 auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
4788 auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
4789 return {F.getParent()->getDataLayout(), TLI, DT, AC};
4790}
4791template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
4792 Function &);
4793}