1 //===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements routines for folding instructions into simpler forms
11 // 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
14 // ("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).
18 //===----------------------------------------------------------------------===//
20 #include "llvm/Analysis/InstructionSimplify.h"
21 #include "llvm/ADT/SetVector.h"
22 #include "llvm/ADT/Statistic.h"
23 #include "llvm/Analysis/AliasAnalysis.h"
24 #include "llvm/Analysis/ConstantFolding.h"
25 #include "llvm/Analysis/MemoryBuiltins.h"
26 #include "llvm/Analysis/ValueTracking.h"
27 #include "llvm/IR/ConstantRange.h"
28 #include "llvm/IR/DataLayout.h"
29 #include "llvm/IR/Dominators.h"
30 #include "llvm/IR/GetElementPtrTypeIterator.h"
31 #include "llvm/IR/GlobalAlias.h"
32 #include "llvm/IR/Operator.h"
33 #include "llvm/IR/PatternMatch.h"
34 #include "llvm/IR/ValueHandle.h"
37 using namespace llvm::PatternMatch;
39 #define DEBUG_TYPE "instsimplify"
41 enum { RecursionLimit = 3 };
43 STATISTIC(NumExpand, "Number of expansions");
44 STATISTIC(NumReassoc, "Number of reassociations");
49 const TargetLibraryInfo *TLI;
50 const DominatorTree *DT;
51 AssumptionTracker *AT;
52 const Instruction *CxtI;
54 Query(const DataLayout *DL, const TargetLibraryInfo *tli,
55 const DominatorTree *dt, AssumptionTracker *at = nullptr,
56 const Instruction *cxti = nullptr)
57 : DL(DL), TLI(tli), DT(dt), AT(at), CxtI(cxti) {}
59 } // end anonymous namespace
61 static Value *SimplifyAndInst(Value *, Value *, const Query &, unsigned);
62 static Value *SimplifyBinOp(unsigned, Value *, Value *, const Query &,
64 static Value *SimplifyCmpInst(unsigned, Value *, Value *, const Query &,
66 static Value *SimplifyOrInst(Value *, Value *, const Query &, unsigned);
67 static Value *SimplifyXorInst(Value *, Value *, const Query &, unsigned);
68 static Value *SimplifyTruncInst(Value *, Type *, const Query &, unsigned);
70 /// getFalse - For a boolean type, or a vector of boolean type, return false, or
71 /// a vector with every element false, as appropriate for the type.
72 static Constant *getFalse(Type *Ty) {
73 assert(Ty->getScalarType()->isIntegerTy(1) &&
74 "Expected i1 type or a vector of i1!");
75 return Constant::getNullValue(Ty);
78 /// getTrue - For a boolean type, or a vector of boolean type, return true, or
79 /// a vector with every element true, as appropriate for the type.
80 static Constant *getTrue(Type *Ty) {
81 assert(Ty->getScalarType()->isIntegerTy(1) &&
82 "Expected i1 type or a vector of i1!");
83 return Constant::getAllOnesValue(Ty);
86 /// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
87 static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
89 CmpInst *Cmp = dyn_cast<CmpInst>(V);
92 CmpInst::Predicate CPred = Cmp->getPredicate();
93 Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
94 if (CPred == Pred && CLHS == LHS && CRHS == RHS)
96 return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
100 /// ValueDominatesPHI - Does the given value dominate the specified phi node?
101 static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
102 Instruction *I = dyn_cast<Instruction>(V);
104 // Arguments and constants dominate all instructions.
107 // If we are processing instructions (and/or basic blocks) that have not been
108 // fully added to a function, the parent nodes may still be null. Simply
109 // return the conservative answer in these cases.
110 if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
113 // If we have a DominatorTree then do a precise test.
115 if (!DT->isReachableFromEntry(P->getParent()))
117 if (!DT->isReachableFromEntry(I->getParent()))
119 return DT->dominates(I, P);
122 // Otherwise, if the instruction is in the entry block, and is not an invoke,
123 // then it obviously dominates all phi nodes.
124 if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
131 /// ExpandBinOp - Simplify "A op (B op' C)" by distributing op over op', turning
132 /// it into "(A op B) op' (A op C)". Here "op" is given by Opcode and "op'" is
133 /// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
134 /// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
135 /// Returns the simplified value, or null if no simplification was performed.
136 static Value *ExpandBinOp(unsigned Opcode, Value *LHS, Value *RHS,
137 unsigned OpcToExpand, const Query &Q,
138 unsigned MaxRecurse) {
139 Instruction::BinaryOps OpcodeToExpand = (Instruction::BinaryOps)OpcToExpand;
140 // Recursion is always used, so bail out at once if we already hit the limit.
144 // Check whether the expression has the form "(A op' B) op C".
145 if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
146 if (Op0->getOpcode() == OpcodeToExpand) {
147 // It does! Try turning it into "(A op C) op' (B op C)".
148 Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
149 // Do "A op C" and "B op C" both simplify?
150 if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
151 if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
152 // They do! Return "L op' R" if it simplifies or is already available.
153 // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
154 if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
155 && L == B && R == A)) {
159 // Otherwise return "L op' R" if it simplifies.
160 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
167 // Check whether the expression has the form "A op (B op' C)".
168 if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
169 if (Op1->getOpcode() == OpcodeToExpand) {
170 // It does! Try turning it into "(A op B) op' (A op C)".
171 Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
172 // Do "A op B" and "A op C" both simplify?
173 if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
174 if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
175 // They do! Return "L op' R" if it simplifies or is already available.
176 // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
177 if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
178 && L == C && R == B)) {
182 // Otherwise return "L op' R" if it simplifies.
183 if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
193 /// SimplifyAssociativeBinOp - Generic simplifications for associative binary
194 /// operations. Returns the simpler value, or null if none was found.
195 static Value *SimplifyAssociativeBinOp(unsigned Opc, Value *LHS, Value *RHS,
196 const Query &Q, unsigned MaxRecurse) {
197 Instruction::BinaryOps Opcode = (Instruction::BinaryOps)Opc;
198 assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
200 // Recursion is always used, so bail out at once if we already hit the limit.
204 BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
205 BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
207 // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
208 if (Op0 && Op0->getOpcode() == Opcode) {
209 Value *A = Op0->getOperand(0);
210 Value *B = Op0->getOperand(1);
213 // Does "B op C" simplify?
214 if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
215 // It does! Return "A op V" if it simplifies or is already available.
216 // If V equals B then "A op V" is just the LHS.
217 if (V == B) return LHS;
218 // Otherwise return "A op V" if it simplifies.
219 if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
226 // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
227 if (Op1 && Op1->getOpcode() == Opcode) {
229 Value *B = Op1->getOperand(0);
230 Value *C = Op1->getOperand(1);
232 // Does "A op B" simplify?
233 if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
234 // It does! Return "V op C" if it simplifies or is already available.
235 // If V equals B then "V op C" is just the RHS.
236 if (V == B) return RHS;
237 // Otherwise return "V op C" if it simplifies.
238 if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
245 // The remaining transforms require commutativity as well as associativity.
246 if (!Instruction::isCommutative(Opcode))
249 // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
250 if (Op0 && Op0->getOpcode() == Opcode) {
251 Value *A = Op0->getOperand(0);
252 Value *B = Op0->getOperand(1);
255 // Does "C op A" simplify?
256 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
257 // It does! Return "V op B" if it simplifies or is already available.
258 // If V equals A then "V op B" is just the LHS.
259 if (V == A) return LHS;
260 // Otherwise return "V op B" if it simplifies.
261 if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
268 // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
269 if (Op1 && Op1->getOpcode() == Opcode) {
271 Value *B = Op1->getOperand(0);
272 Value *C = Op1->getOperand(1);
274 // Does "C op A" simplify?
275 if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
276 // It does! Return "B op V" if it simplifies or is already available.
277 // If V equals C then "B op V" is just the RHS.
278 if (V == C) return RHS;
279 // Otherwise return "B op V" if it simplifies.
280 if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
290 /// ThreadBinOpOverSelect - In the case of a binary operation with a select
291 /// instruction as an operand, try to simplify the binop by seeing whether
292 /// evaluating it on both branches of the select results in the same value.
293 /// Returns the common value if so, otherwise returns null.
294 static Value *ThreadBinOpOverSelect(unsigned Opcode, Value *LHS, Value *RHS,
295 const Query &Q, unsigned MaxRecurse) {
296 // Recursion is always used, so bail out at once if we already hit the limit.
301 if (isa<SelectInst>(LHS)) {
302 SI = cast<SelectInst>(LHS);
304 assert(isa<SelectInst>(RHS) && "No select instruction operand!");
305 SI = cast<SelectInst>(RHS);
308 // Evaluate the BinOp on the true and false branches of the select.
312 TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
313 FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
315 TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
316 FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
319 // If they simplified to the same value, then return the common value.
320 // If they both failed to simplify then return null.
324 // If one branch simplified to undef, return the other one.
325 if (TV && isa<UndefValue>(TV))
327 if (FV && isa<UndefValue>(FV))
330 // If applying the operation did not change the true and false select values,
331 // then the result of the binop is the select itself.
332 if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
335 // If one branch simplified and the other did not, and the simplified
336 // value is equal to the unsimplified one, return the simplified value.
337 // For example, select (cond, X, X & Z) & Z -> X & Z.
338 if ((FV && !TV) || (TV && !FV)) {
339 // Check that the simplified value has the form "X op Y" where "op" is the
340 // same as the original operation.
341 Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
342 if (Simplified && Simplified->getOpcode() == Opcode) {
343 // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
344 // We already know that "op" is the same as for the simplified value. See
345 // if the operands match too. If so, return the simplified value.
346 Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
347 Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
348 Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
349 if (Simplified->getOperand(0) == UnsimplifiedLHS &&
350 Simplified->getOperand(1) == UnsimplifiedRHS)
352 if (Simplified->isCommutative() &&
353 Simplified->getOperand(1) == UnsimplifiedLHS &&
354 Simplified->getOperand(0) == UnsimplifiedRHS)
362 /// ThreadCmpOverSelect - In the case of a comparison with a select instruction,
363 /// try to simplify the comparison by seeing whether both branches of the select
364 /// result in the same value. Returns the common value if so, otherwise returns
366 static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
367 Value *RHS, const Query &Q,
368 unsigned MaxRecurse) {
369 // Recursion is always used, so bail out at once if we already hit the limit.
373 // Make sure the select is on the LHS.
374 if (!isa<SelectInst>(LHS)) {
376 Pred = CmpInst::getSwappedPredicate(Pred);
378 assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
379 SelectInst *SI = cast<SelectInst>(LHS);
380 Value *Cond = SI->getCondition();
381 Value *TV = SI->getTrueValue();
382 Value *FV = SI->getFalseValue();
384 // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
385 // Does "cmp TV, RHS" simplify?
386 Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
388 // It not only simplified, it simplified to the select condition. Replace
390 TCmp = getTrue(Cond->getType());
392 // It didn't simplify. However if "cmp TV, RHS" is equal to the select
393 // condition then we can replace it with 'true'. Otherwise give up.
394 if (!isSameCompare(Cond, Pred, TV, RHS))
396 TCmp = getTrue(Cond->getType());
399 // Does "cmp FV, RHS" simplify?
400 Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
402 // It not only simplified, it simplified to the select condition. Replace
404 FCmp = getFalse(Cond->getType());
406 // It didn't simplify. However if "cmp FV, RHS" is equal to the select
407 // condition then we can replace it with 'false'. Otherwise give up.
408 if (!isSameCompare(Cond, Pred, FV, RHS))
410 FCmp = getFalse(Cond->getType());
413 // If both sides simplified to the same value, then use it as the result of
414 // the original comparison.
418 // The remaining cases only make sense if the select condition has the same
419 // type as the result of the comparison, so bail out if this is not so.
420 if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
422 // If the false value simplified to false, then the result of the compare
423 // is equal to "Cond && TCmp". This also catches the case when the false
424 // value simplified to false and the true value to true, returning "Cond".
425 if (match(FCmp, m_Zero()))
426 if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
428 // If the true value simplified to true, then the result of the compare
429 // is equal to "Cond || FCmp".
430 if (match(TCmp, m_One()))
431 if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
433 // Finally, if the false value simplified to true and the true value to
434 // false, then the result of the compare is equal to "!Cond".
435 if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
437 SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
444 /// ThreadBinOpOverPHI - In the case of a binary operation with an operand that
445 /// is a PHI instruction, try to simplify the binop by seeing whether evaluating
446 /// it on the incoming phi values yields the same result for every value. If so
447 /// returns the common value, otherwise returns null.
448 static Value *ThreadBinOpOverPHI(unsigned Opcode, Value *LHS, Value *RHS,
449 const Query &Q, unsigned MaxRecurse) {
450 // Recursion is always used, so bail out at once if we already hit the limit.
455 if (isa<PHINode>(LHS)) {
456 PI = cast<PHINode>(LHS);
457 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
458 if (!ValueDominatesPHI(RHS, PI, Q.DT))
461 assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
462 PI = cast<PHINode>(RHS);
463 // Bail out if LHS and the phi may be mutually interdependent due to a loop.
464 if (!ValueDominatesPHI(LHS, PI, Q.DT))
468 // Evaluate the BinOp on the incoming phi values.
469 Value *CommonValue = nullptr;
470 for (unsigned i = 0, e = PI->getNumIncomingValues(); i != e; ++i) {
471 Value *Incoming = PI->getIncomingValue(i);
472 // If the incoming value is the phi node itself, it can safely be skipped.
473 if (Incoming == PI) continue;
474 Value *V = PI == LHS ?
475 SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
476 SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
477 // If the operation failed to simplify, or simplified to a different value
478 // to previously, then give up.
479 if (!V || (CommonValue && V != CommonValue))
487 /// ThreadCmpOverPHI - In the case of a comparison with a PHI instruction, try
488 /// try to simplify the comparison by seeing whether comparing with all of the
489 /// incoming phi values yields the same result every time. If so returns the
490 /// common result, otherwise returns null.
491 static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
492 const Query &Q, unsigned MaxRecurse) {
493 // Recursion is always used, so bail out at once if we already hit the limit.
497 // Make sure the phi is on the LHS.
498 if (!isa<PHINode>(LHS)) {
500 Pred = CmpInst::getSwappedPredicate(Pred);
502 assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
503 PHINode *PI = cast<PHINode>(LHS);
505 // Bail out if RHS and the phi may be mutually interdependent due to a loop.
506 if (!ValueDominatesPHI(RHS, PI, Q.DT))
509 // Evaluate the BinOp on the incoming phi values.
510 Value *CommonValue = nullptr;
511 for (unsigned i = 0, e = PI->getNumIncomingValues(); i != e; ++i) {
512 Value *Incoming = PI->getIncomingValue(i);
513 // If the incoming value is the phi node itself, it can safely be skipped.
514 if (Incoming == PI) continue;
515 Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
516 // If the operation failed to simplify, or simplified to a different value
517 // to previously, then give up.
518 if (!V || (CommonValue && V != CommonValue))
526 /// SimplifyAddInst - Given operands for an Add, see if we can
527 /// fold the result. If not, this returns null.
528 static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
529 const Query &Q, unsigned MaxRecurse) {
530 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
531 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
532 Constant *Ops[] = { CLHS, CRHS };
533 return ConstantFoldInstOperands(Instruction::Add, CLHS->getType(), Ops,
537 // Canonicalize the constant to the RHS.
541 // X + undef -> undef
542 if (match(Op1, m_Undef()))
546 if (match(Op1, m_Zero()))
553 if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
554 match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
557 // X + ~X -> -1 since ~X = -X-1
558 if (match(Op0, m_Not(m_Specific(Op1))) ||
559 match(Op1, m_Not(m_Specific(Op0))))
560 return Constant::getAllOnesValue(Op0->getType());
563 if (MaxRecurse && Op0->getType()->isIntegerTy(1))
564 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
567 // Try some generic simplifications for associative operations.
568 if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
572 // Threading Add over selects and phi nodes is pointless, so don't bother.
573 // Threading over the select in "A + select(cond, B, C)" means evaluating
574 // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
575 // only if B and C are equal. If B and C are equal then (since we assume
576 // that operands have already been simplified) "select(cond, B, C)" should
577 // have been simplified to the common value of B and C already. Analysing
578 // "A+B" and "A+C" thus gains nothing, but costs compile time. Similarly
579 // for threading over phi nodes.
584 Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
585 const DataLayout *DL, const TargetLibraryInfo *TLI,
586 const DominatorTree *DT, AssumptionTracker *AT,
587 const Instruction *CxtI) {
588 return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW,
589 Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
592 /// \brief Compute the base pointer and cumulative constant offsets for V.
594 /// This strips all constant offsets off of V, leaving it the base pointer, and
595 /// accumulates the total constant offset applied in the returned constant. It
596 /// returns 0 if V is not a pointer, and returns the constant '0' if there are
597 /// no constant offsets applied.
599 /// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
600 /// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
602 static Constant *stripAndComputeConstantOffsets(const DataLayout *DL,
604 bool AllowNonInbounds = false) {
605 assert(V->getType()->getScalarType()->isPointerTy());
607 // Without DataLayout, just be conservative for now. Theoretically, more could
608 // be done in this case.
610 return ConstantInt::get(IntegerType::get(V->getContext(), 64), 0);
612 Type *IntPtrTy = DL->getIntPtrType(V->getType())->getScalarType();
613 APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
615 // Even though we don't look through PHI nodes, we could be called on an
616 // instruction in an unreachable block, which may be on a cycle.
617 SmallPtrSet<Value *, 4> Visited;
620 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
621 if ((!AllowNonInbounds && !GEP->isInBounds()) ||
622 !GEP->accumulateConstantOffset(*DL, Offset))
624 V = GEP->getPointerOperand();
625 } else if (Operator::getOpcode(V) == Instruction::BitCast) {
626 V = cast<Operator>(V)->getOperand(0);
627 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
628 if (GA->mayBeOverridden())
630 V = GA->getAliasee();
634 assert(V->getType()->getScalarType()->isPointerTy() &&
635 "Unexpected operand type!");
636 } while (Visited.insert(V).second);
638 Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
639 if (V->getType()->isVectorTy())
640 return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
645 /// \brief Compute the constant difference between two pointer values.
646 /// If the difference is not a constant, returns zero.
647 static Constant *computePointerDifference(const DataLayout *DL,
648 Value *LHS, Value *RHS) {
649 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
650 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
652 // If LHS and RHS are not related via constant offsets to the same base
653 // value, there is nothing we can do here.
657 // Otherwise, the difference of LHS - RHS can be computed as:
659 // = (LHSOffset + Base) - (RHSOffset + Base)
660 // = LHSOffset - RHSOffset
661 return ConstantExpr::getSub(LHSOffset, RHSOffset);
664 /// SimplifySubInst - Given operands for a Sub, see if we can
665 /// fold the result. If not, this returns null.
666 static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
667 const Query &Q, unsigned MaxRecurse) {
668 if (Constant *CLHS = dyn_cast<Constant>(Op0))
669 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
670 Constant *Ops[] = { CLHS, CRHS };
671 return ConstantFoldInstOperands(Instruction::Sub, CLHS->getType(),
675 // X - undef -> undef
676 // undef - X -> undef
677 if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
678 return UndefValue::get(Op0->getType());
681 if (match(Op1, m_Zero()))
686 return Constant::getNullValue(Op0->getType());
688 // 0 - X -> 0 if the sub is NUW.
689 if (isNUW && match(Op0, m_Zero()))
692 // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
693 // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
694 Value *X = nullptr, *Y = nullptr, *Z = Op1;
695 if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
696 // See if "V === Y - Z" simplifies.
697 if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
698 // It does! Now see if "X + V" simplifies.
699 if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
700 // It does, we successfully reassociated!
704 // See if "V === X - Z" simplifies.
705 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
706 // It does! Now see if "Y + V" simplifies.
707 if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
708 // It does, we successfully reassociated!
714 // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
715 // For example, X - (X + 1) -> -1
717 if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
718 // See if "V === X - Y" simplifies.
719 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
720 // It does! Now see if "V - Z" simplifies.
721 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
722 // It does, we successfully reassociated!
726 // See if "V === X - Z" simplifies.
727 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
728 // It does! Now see if "V - Y" simplifies.
729 if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
730 // It does, we successfully reassociated!
736 // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
737 // For example, X - (X - Y) -> Y.
739 if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
740 // See if "V === Z - X" simplifies.
741 if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
742 // It does! Now see if "V + Y" simplifies.
743 if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
744 // It does, we successfully reassociated!
749 // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
750 if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
751 match(Op1, m_Trunc(m_Value(Y))))
752 if (X->getType() == Y->getType())
753 // See if "V === X - Y" simplifies.
754 if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
755 // It does! Now see if "trunc V" simplifies.
756 if (Value *W = SimplifyTruncInst(V, Op0->getType(), Q, MaxRecurse-1))
757 // It does, return the simplified "trunc V".
760 // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
761 if (match(Op0, m_PtrToInt(m_Value(X))) &&
762 match(Op1, m_PtrToInt(m_Value(Y))))
763 if (Constant *Result = computePointerDifference(Q.DL, X, Y))
764 return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
767 if (MaxRecurse && Op0->getType()->isIntegerTy(1))
768 if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
771 // Threading Sub over selects and phi nodes is pointless, so don't bother.
772 // Threading over the select in "A - select(cond, B, C)" means evaluating
773 // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
774 // only if B and C are equal. If B and C are equal then (since we assume
775 // that operands have already been simplified) "select(cond, B, C)" should
776 // have been simplified to the common value of B and C already. Analysing
777 // "A-B" and "A-C" thus gains nothing, but costs compile time. Similarly
778 // for threading over phi nodes.
783 Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
784 const DataLayout *DL, const TargetLibraryInfo *TLI,
785 const DominatorTree *DT, AssumptionTracker *AT,
786 const Instruction *CxtI) {
787 return ::SimplifySubInst(Op0, Op1, isNSW, isNUW,
788 Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
791 /// Given operands for an FAdd, see if we can fold the result. If not, this
793 static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
794 const Query &Q, unsigned MaxRecurse) {
795 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
796 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
797 Constant *Ops[] = { CLHS, CRHS };
798 return ConstantFoldInstOperands(Instruction::FAdd, CLHS->getType(),
802 // Canonicalize the constant to the RHS.
807 if (match(Op1, m_NegZero()))
810 // fadd X, 0 ==> X, when we know X is not -0
811 if (match(Op1, m_Zero()) &&
812 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0)))
815 // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
816 // where nnan and ninf have to occur at least once somewhere in this
818 Value *SubOp = nullptr;
819 if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
821 else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
824 Instruction *FSub = cast<Instruction>(SubOp);
825 if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
826 (FMF.noInfs() || FSub->hasNoInfs()))
827 return Constant::getNullValue(Op0->getType());
833 /// Given operands for an FSub, see if we can fold the result. If not, this
835 static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
836 const Query &Q, unsigned MaxRecurse) {
837 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
838 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
839 Constant *Ops[] = { CLHS, CRHS };
840 return ConstantFoldInstOperands(Instruction::FSub, CLHS->getType(),
846 if (match(Op1, m_Zero()))
849 // fsub X, -0 ==> X, when we know X is not -0
850 if (match(Op1, m_NegZero()) &&
851 (FMF.noSignedZeros() || CannotBeNegativeZero(Op0)))
854 // fsub 0, (fsub -0.0, X) ==> X
856 if (match(Op0, m_AnyZero())) {
857 if (match(Op1, m_FSub(m_NegZero(), m_Value(X))))
859 if (FMF.noSignedZeros() && match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
863 // fsub nnan ninf x, x ==> 0.0
864 if (FMF.noNaNs() && FMF.noInfs() && Op0 == Op1)
865 return Constant::getNullValue(Op0->getType());
870 /// Given the operands for an FMul, see if we can fold the result
871 static Value *SimplifyFMulInst(Value *Op0, Value *Op1,
874 unsigned MaxRecurse) {
875 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
876 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
877 Constant *Ops[] = { CLHS, CRHS };
878 return ConstantFoldInstOperands(Instruction::FMul, CLHS->getType(),
882 // Canonicalize the constant to the RHS.
887 if (match(Op1, m_FPOne()))
890 // fmul nnan nsz X, 0 ==> 0
891 if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
897 /// SimplifyMulInst - Given operands for a Mul, see if we can
898 /// fold the result. If not, this returns null.
899 static Value *SimplifyMulInst(Value *Op0, Value *Op1, const Query &Q,
900 unsigned MaxRecurse) {
901 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
902 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
903 Constant *Ops[] = { CLHS, CRHS };
904 return ConstantFoldInstOperands(Instruction::Mul, CLHS->getType(),
908 // Canonicalize the constant to the RHS.
913 if (match(Op1, m_Undef()))
914 return Constant::getNullValue(Op0->getType());
917 if (match(Op1, m_Zero()))
921 if (match(Op1, m_One()))
924 // (X / Y) * Y -> X if the division is exact.
926 if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
927 match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0))))) // Y * (X / Y)
931 if (MaxRecurse && Op0->getType()->isIntegerTy(1))
932 if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
935 // Try some generic simplifications for associative operations.
936 if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
940 // Mul distributes over Add. Try some generic simplifications based on this.
941 if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
945 // If the operation is with the result of a select instruction, check whether
946 // operating on either branch of the select always yields the same value.
947 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
948 if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
952 // If the operation is with the result of a phi instruction, check whether
953 // operating on all incoming values of the phi always yields the same value.
954 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
955 if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
962 Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
963 const DataLayout *DL, const TargetLibraryInfo *TLI,
964 const DominatorTree *DT, AssumptionTracker *AT,
965 const Instruction *CxtI) {
966 return ::SimplifyFAddInst(Op0, Op1, FMF, Query (DL, TLI, DT, AT, CxtI),
970 Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
971 const DataLayout *DL, const TargetLibraryInfo *TLI,
972 const DominatorTree *DT, AssumptionTracker *AT,
973 const Instruction *CxtI) {
974 return ::SimplifyFSubInst(Op0, Op1, FMF, Query (DL, TLI, DT, AT, CxtI),
978 Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1,
980 const DataLayout *DL,
981 const TargetLibraryInfo *TLI,
982 const DominatorTree *DT,
983 AssumptionTracker *AT,
984 const Instruction *CxtI) {
985 return ::SimplifyFMulInst(Op0, Op1, FMF, Query (DL, TLI, DT, AT, CxtI),
989 Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const DataLayout *DL,
990 const TargetLibraryInfo *TLI,
991 const DominatorTree *DT, AssumptionTracker *AT,
992 const Instruction *CxtI) {
993 return ::SimplifyMulInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
997 /// SimplifyDiv - Given operands for an SDiv or UDiv, see if we can
998 /// fold the result. If not, this returns null.
999 static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1000 const Query &Q, unsigned MaxRecurse) {
1001 if (Constant *C0 = dyn_cast<Constant>(Op0)) {
1002 if (Constant *C1 = dyn_cast<Constant>(Op1)) {
1003 Constant *Ops[] = { C0, C1 };
1004 return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, Q.DL, Q.TLI);
1008 bool isSigned = Opcode == Instruction::SDiv;
1010 // X / undef -> undef
1011 if (match(Op1, m_Undef()))
1015 if (match(Op0, m_Undef()))
1016 return Constant::getNullValue(Op0->getType());
1018 // 0 / X -> 0, we don't need to preserve faults!
1019 if (match(Op0, m_Zero()))
1023 if (match(Op1, m_One()))
1026 if (Op0->getType()->isIntegerTy(1))
1027 // It can't be division by zero, hence it must be division by one.
1032 return ConstantInt::get(Op0->getType(), 1);
1034 // (X * Y) / Y -> X if the multiplication does not overflow.
1035 Value *X = nullptr, *Y = nullptr;
1036 if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1037 if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
1038 OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
1039 // If the Mul knows it does not overflow, then we are good to go.
1040 if ((isSigned && Mul->hasNoSignedWrap()) ||
1041 (!isSigned && Mul->hasNoUnsignedWrap()))
1043 // If X has the form X = A / Y then X * Y cannot overflow.
1044 if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1045 if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1049 // (X rem Y) / Y -> 0
1050 if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1051 (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1052 return Constant::getNullValue(Op0->getType());
1054 // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1055 ConstantInt *C1, *C2;
1056 if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1057 match(Op1, m_ConstantInt(C2))) {
1059 C1->getValue().umul_ov(C2->getValue(), Overflow);
1061 return Constant::getNullValue(Op0->getType());
1064 // If the operation is with the result of a select instruction, check whether
1065 // operating on either branch of the select always yields the same value.
1066 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1067 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1070 // If the operation is with the result of a phi instruction, check whether
1071 // operating on all incoming values of the phi always yields the same value.
1072 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1073 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1079 /// SimplifySDivInst - Given operands for an SDiv, see if we can
1080 /// fold the result. If not, this returns null.
1081 static Value *SimplifySDivInst(Value *Op0, Value *Op1, const Query &Q,
1082 unsigned MaxRecurse) {
1083 if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
1089 Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const DataLayout *DL,
1090 const TargetLibraryInfo *TLI,
1091 const DominatorTree *DT,
1092 AssumptionTracker *AT,
1093 const Instruction *CxtI) {
1094 return ::SimplifySDivInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1098 /// SimplifyUDivInst - Given operands for a UDiv, see if we can
1099 /// fold the result. If not, this returns null.
1100 static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const Query &Q,
1101 unsigned MaxRecurse) {
1102 if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
1108 Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const DataLayout *DL,
1109 const TargetLibraryInfo *TLI,
1110 const DominatorTree *DT,
1111 AssumptionTracker *AT,
1112 const Instruction *CxtI) {
1113 return ::SimplifyUDivInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1117 static Value *SimplifyFDivInst(Value *Op0, Value *Op1, const Query &Q,
1119 // undef / X -> undef (the undef could be a snan).
1120 if (match(Op0, m_Undef()))
1123 // X / undef -> undef
1124 if (match(Op1, m_Undef()))
1130 Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, const DataLayout *DL,
1131 const TargetLibraryInfo *TLI,
1132 const DominatorTree *DT,
1133 AssumptionTracker *AT,
1134 const Instruction *CxtI) {
1135 return ::SimplifyFDivInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1139 /// SimplifyRem - Given operands for an SRem or URem, see if we can
1140 /// fold the result. If not, this returns null.
1141 static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1142 const Query &Q, unsigned MaxRecurse) {
1143 if (Constant *C0 = dyn_cast<Constant>(Op0)) {
1144 if (Constant *C1 = dyn_cast<Constant>(Op1)) {
1145 Constant *Ops[] = { C0, C1 };
1146 return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, Q.DL, Q.TLI);
1150 // X % undef -> undef
1151 if (match(Op1, m_Undef()))
1155 if (match(Op0, m_Undef()))
1156 return Constant::getNullValue(Op0->getType());
1158 // 0 % X -> 0, we don't need to preserve faults!
1159 if (match(Op0, m_Zero()))
1162 // X % 0 -> undef, we don't need to preserve faults!
1163 if (match(Op1, m_Zero()))
1164 return UndefValue::get(Op0->getType());
1167 if (match(Op1, m_One()))
1168 return Constant::getNullValue(Op0->getType());
1170 if (Op0->getType()->isIntegerTy(1))
1171 // It can't be remainder by zero, hence it must be remainder by one.
1172 return Constant::getNullValue(Op0->getType());
1176 return Constant::getNullValue(Op0->getType());
1178 // (X % Y) % Y -> X % Y
1179 if ((Opcode == Instruction::SRem &&
1180 match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1181 (Opcode == Instruction::URem &&
1182 match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1185 // If the operation is with the result of a select instruction, check whether
1186 // operating on either branch of the select always yields the same value.
1187 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1188 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1191 // If the operation is with the result of a phi instruction, check whether
1192 // operating on all incoming values of the phi always yields the same value.
1193 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1194 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1200 /// SimplifySRemInst - Given operands for an SRem, see if we can
1201 /// fold the result. If not, this returns null.
1202 static Value *SimplifySRemInst(Value *Op0, Value *Op1, const Query &Q,
1203 unsigned MaxRecurse) {
1204 if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
1210 Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const DataLayout *DL,
1211 const TargetLibraryInfo *TLI,
1212 const DominatorTree *DT,
1213 AssumptionTracker *AT,
1214 const Instruction *CxtI) {
1215 return ::SimplifySRemInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1219 /// SimplifyURemInst - Given operands for a URem, see if we can
1220 /// fold the result. If not, this returns null.
1221 static Value *SimplifyURemInst(Value *Op0, Value *Op1, const Query &Q,
1222 unsigned MaxRecurse) {
1223 if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
1229 Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const DataLayout *DL,
1230 const TargetLibraryInfo *TLI,
1231 const DominatorTree *DT,
1232 AssumptionTracker *AT,
1233 const Instruction *CxtI) {
1234 return ::SimplifyURemInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1238 static Value *SimplifyFRemInst(Value *Op0, Value *Op1, const Query &,
1240 // undef % X -> undef (the undef could be a snan).
1241 if (match(Op0, m_Undef()))
1244 // X % undef -> undef
1245 if (match(Op1, m_Undef()))
1251 Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, const DataLayout *DL,
1252 const TargetLibraryInfo *TLI,
1253 const DominatorTree *DT,
1254 AssumptionTracker *AT,
1255 const Instruction *CxtI) {
1256 return ::SimplifyFRemInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1260 /// isUndefShift - Returns true if a shift by \c Amount always yields undef.
1261 static bool isUndefShift(Value *Amount) {
1262 Constant *C = dyn_cast<Constant>(Amount);
1266 // X shift by undef -> undef because it may shift by the bitwidth.
1267 if (isa<UndefValue>(C))
1270 // Shifting by the bitwidth or more is undefined.
1271 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1272 if (CI->getValue().getLimitedValue() >=
1273 CI->getType()->getScalarSizeInBits())
1276 // If all lanes of a vector shift are undefined the whole shift is.
1277 if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1278 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1279 if (!isUndefShift(C->getAggregateElement(I)))
1287 /// SimplifyShift - Given operands for an Shl, LShr or AShr, see if we can
1288 /// fold the result. If not, this returns null.
1289 static Value *SimplifyShift(unsigned Opcode, Value *Op0, Value *Op1,
1290 const Query &Q, unsigned MaxRecurse) {
1291 if (Constant *C0 = dyn_cast<Constant>(Op0)) {
1292 if (Constant *C1 = dyn_cast<Constant>(Op1)) {
1293 Constant *Ops[] = { C0, C1 };
1294 return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, Q.DL, Q.TLI);
1298 // 0 shift by X -> 0
1299 if (match(Op0, m_Zero()))
1302 // X shift by 0 -> X
1303 if (match(Op1, m_Zero()))
1306 // Fold undefined shifts.
1307 if (isUndefShift(Op1))
1308 return UndefValue::get(Op0->getType());
1310 // If the operation is with the result of a select instruction, check whether
1311 // operating on either branch of the select always yields the same value.
1312 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1313 if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1316 // If the operation is with the result of a phi instruction, check whether
1317 // operating on all incoming values of the phi always yields the same value.
1318 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1319 if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1325 /// \brief Given operands for an Shl, LShr or AShr, see if we can
1326 /// fold the result. If not, this returns null.
1327 static Value *SimplifyRightShift(unsigned Opcode, Value *Op0, Value *Op1,
1328 bool isExact, const Query &Q,
1329 unsigned MaxRecurse) {
1330 if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1335 return Constant::getNullValue(Op0->getType());
1337 // The low bit cannot be shifted out of an exact shift if it is set.
1339 unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
1340 APInt Op0KnownZero(BitWidth, 0);
1341 APInt Op0KnownOne(BitWidth, 0);
1342 computeKnownBits(Op0, Op0KnownZero, Op0KnownOne, Q.DL, /*Depth=*/0, Q.AT, Q.CxtI,
1351 /// SimplifyShlInst - Given operands for an Shl, see if we can
1352 /// fold the result. If not, this returns null.
1353 static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1354 const Query &Q, unsigned MaxRecurse) {
1355 if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
1359 if (match(Op0, m_Undef()))
1360 return Constant::getNullValue(Op0->getType());
1362 // (X >> A) << A -> X
1364 if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
1369 Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1370 const DataLayout *DL, const TargetLibraryInfo *TLI,
1371 const DominatorTree *DT, AssumptionTracker *AT,
1372 const Instruction *CxtI) {
1373 return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Query (DL, TLI, DT, AT, CxtI),
1377 /// SimplifyLShrInst - Given operands for an LShr, see if we can
1378 /// fold the result. If not, this returns null.
1379 static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1380 const Query &Q, unsigned MaxRecurse) {
1381 if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1386 if (match(Op0, m_Undef()))
1387 return Constant::getNullValue(Op0->getType());
1389 // (X << A) >> A -> X
1391 if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
1397 Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1398 const DataLayout *DL,
1399 const TargetLibraryInfo *TLI,
1400 const DominatorTree *DT,
1401 AssumptionTracker *AT,
1402 const Instruction *CxtI) {
1403 return ::SimplifyLShrInst(Op0, Op1, isExact, Query (DL, TLI, DT, AT, CxtI),
1407 /// SimplifyAShrInst - Given operands for an AShr, see if we can
1408 /// fold the result. If not, this returns null.
1409 static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1410 const Query &Q, unsigned MaxRecurse) {
1411 if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1415 // all ones >>a X -> all ones
1416 if (match(Op0, m_AllOnes()))
1419 // undef >>a X -> all ones
1420 if (match(Op0, m_Undef()))
1421 return Constant::getAllOnesValue(Op0->getType());
1423 // (X << A) >> A -> X
1425 if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
1428 // Arithmetic shifting an all-sign-bit value is a no-op.
1429 unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AT, Q.CxtI, Q.DT);
1430 if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1436 Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1437 const DataLayout *DL,
1438 const TargetLibraryInfo *TLI,
1439 const DominatorTree *DT,
1440 AssumptionTracker *AT,
1441 const Instruction *CxtI) {
1442 return ::SimplifyAShrInst(Op0, Op1, isExact, Query (DL, TLI, DT, AT, CxtI),
1446 // Simplify (and (icmp ...) (icmp ...)) to true when we can tell that the range
1447 // of possible values cannot be satisfied.
1448 static Value *SimplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1449 ICmpInst::Predicate Pred0, Pred1;
1450 ConstantInt *CI1, *CI2;
1452 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_ConstantInt(CI1)),
1453 m_ConstantInt(CI2))))
1456 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Specific(CI1))))
1459 Type *ITy = Op0->getType();
1461 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1462 bool isNSW = AddInst->hasNoSignedWrap();
1463 bool isNUW = AddInst->hasNoUnsignedWrap();
1465 const APInt &CI1V = CI1->getValue();
1466 const APInt &CI2V = CI2->getValue();
1467 const APInt Delta = CI2V - CI1V;
1468 if (CI1V.isStrictlyPositive()) {
1470 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1471 return getFalse(ITy);
1472 if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1473 return getFalse(ITy);
1476 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1477 return getFalse(ITy);
1478 if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1479 return getFalse(ITy);
1482 if (CI1V.getBoolValue() && isNUW) {
1484 if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1485 return getFalse(ITy);
1487 if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1488 return getFalse(ITy);
1494 /// SimplifyAndInst - Given operands for an And, see if we can
1495 /// fold the result. If not, this returns null.
1496 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const Query &Q,
1497 unsigned MaxRecurse) {
1498 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1499 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1500 Constant *Ops[] = { CLHS, CRHS };
1501 return ConstantFoldInstOperands(Instruction::And, CLHS->getType(),
1505 // Canonicalize the constant to the RHS.
1506 std::swap(Op0, Op1);
1510 if (match(Op1, m_Undef()))
1511 return Constant::getNullValue(Op0->getType());
1518 if (match(Op1, m_Zero()))
1522 if (match(Op1, m_AllOnes()))
1525 // A & ~A = ~A & A = 0
1526 if (match(Op0, m_Not(m_Specific(Op1))) ||
1527 match(Op1, m_Not(m_Specific(Op0))))
1528 return Constant::getNullValue(Op0->getType());
1531 Value *A = nullptr, *B = nullptr;
1532 if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1533 (A == Op1 || B == Op1))
1537 if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
1538 (A == Op0 || B == Op0))
1541 // A & (-A) = A if A is a power of two or zero.
1542 if (match(Op0, m_Neg(m_Specific(Op1))) ||
1543 match(Op1, m_Neg(m_Specific(Op0)))) {
1544 if (isKnownToBeAPowerOfTwo(Op0, /*OrZero*/true, 0, Q.AT, Q.CxtI, Q.DT))
1546 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/true, 0, Q.AT, Q.CxtI, Q.DT))
1550 if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1551 if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1552 if (Value *V = SimplifyAndOfICmps(ICILHS, ICIRHS))
1554 if (Value *V = SimplifyAndOfICmps(ICIRHS, ICILHS))
1559 // Try some generic simplifications for associative operations.
1560 if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1564 // And distributes over Or. Try some generic simplifications based on this.
1565 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1569 // And distributes over Xor. Try some generic simplifications based on this.
1570 if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
1574 // If the operation is with the result of a select instruction, check whether
1575 // operating on either branch of the select always yields the same value.
1576 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1577 if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1581 // If the operation is with the result of a phi instruction, check whether
1582 // operating on all incoming values of the phi always yields the same value.
1583 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1584 if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
1591 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const DataLayout *DL,
1592 const TargetLibraryInfo *TLI,
1593 const DominatorTree *DT, AssumptionTracker *AT,
1594 const Instruction *CxtI) {
1595 return ::SimplifyAndInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1599 // Simplify (or (icmp ...) (icmp ...)) to true when we can tell that the union
1600 // contains all possible values.
1601 static Value *SimplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1602 ICmpInst::Predicate Pred0, Pred1;
1603 ConstantInt *CI1, *CI2;
1605 if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_ConstantInt(CI1)),
1606 m_ConstantInt(CI2))))
1609 if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Specific(CI1))))
1612 Type *ITy = Op0->getType();
1614 auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1615 bool isNSW = AddInst->hasNoSignedWrap();
1616 bool isNUW = AddInst->hasNoUnsignedWrap();
1618 const APInt &CI1V = CI1->getValue();
1619 const APInt &CI2V = CI2->getValue();
1620 const APInt Delta = CI2V - CI1V;
1621 if (CI1V.isStrictlyPositive()) {
1623 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1624 return getTrue(ITy);
1625 if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1626 return getTrue(ITy);
1629 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1630 return getTrue(ITy);
1631 if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1632 return getTrue(ITy);
1635 if (CI1V.getBoolValue() && isNUW) {
1637 if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1638 return getTrue(ITy);
1640 if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1641 return getTrue(ITy);
1647 /// SimplifyOrInst - Given operands for an Or, see if we can
1648 /// fold the result. If not, this returns null.
1649 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const Query &Q,
1650 unsigned MaxRecurse) {
1651 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1652 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1653 Constant *Ops[] = { CLHS, CRHS };
1654 return ConstantFoldInstOperands(Instruction::Or, CLHS->getType(),
1658 // Canonicalize the constant to the RHS.
1659 std::swap(Op0, Op1);
1663 if (match(Op1, m_Undef()))
1664 return Constant::getAllOnesValue(Op0->getType());
1671 if (match(Op1, m_Zero()))
1675 if (match(Op1, m_AllOnes()))
1678 // A | ~A = ~A | A = -1
1679 if (match(Op0, m_Not(m_Specific(Op1))) ||
1680 match(Op1, m_Not(m_Specific(Op0))))
1681 return Constant::getAllOnesValue(Op0->getType());
1684 Value *A = nullptr, *B = nullptr;
1685 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1686 (A == Op1 || B == Op1))
1690 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1691 (A == Op0 || B == Op0))
1694 // ~(A & ?) | A = -1
1695 if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1696 (A == Op1 || B == Op1))
1697 return Constant::getAllOnesValue(Op1->getType());
1699 // A | ~(A & ?) = -1
1700 if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1701 (A == Op0 || B == Op0))
1702 return Constant::getAllOnesValue(Op0->getType());
1704 if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1705 if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1706 if (Value *V = SimplifyOrOfICmps(ICILHS, ICIRHS))
1708 if (Value *V = SimplifyOrOfICmps(ICIRHS, ICILHS))
1713 // Try some generic simplifications for associative operations.
1714 if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1718 // Or distributes over And. Try some generic simplifications based on this.
1719 if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1723 // If the operation is with the result of a select instruction, check whether
1724 // operating on either branch of the select always yields the same value.
1725 if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1726 if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
1731 Value *C = nullptr, *D = nullptr;
1732 if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1733 match(Op1, m_And(m_Value(B), m_Value(D)))) {
1734 ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1735 ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1736 if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1737 // (A & C1)|(B & C2)
1738 // If we have: ((V + N) & C1) | (V & C2)
1739 // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1740 // replace with V+N.
1742 if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1743 match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1744 // Add commutes, try both ways.
1745 if (V1 == B && MaskedValueIsZero(V2, C2->getValue(), Q.DL,
1746 0, Q.AT, Q.CxtI, Q.DT))
1748 if (V2 == B && MaskedValueIsZero(V1, C2->getValue(), Q.DL,
1749 0, Q.AT, Q.CxtI, Q.DT))
1752 // Or commutes, try both ways.
1753 if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1754 match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1755 // Add commutes, try both ways.
1756 if (V1 == A && MaskedValueIsZero(V2, C1->getValue(), Q.DL,
1757 0, Q.AT, Q.CxtI, Q.DT))
1759 if (V2 == A && MaskedValueIsZero(V1, C1->getValue(), Q.DL,
1760 0, Q.AT, Q.CxtI, Q.DT))
1766 // If the operation is with the result of a phi instruction, check whether
1767 // operating on all incoming values of the phi always yields the same value.
1768 if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1769 if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
1775 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const DataLayout *DL,
1776 const TargetLibraryInfo *TLI,
1777 const DominatorTree *DT, AssumptionTracker *AT,
1778 const Instruction *CxtI) {
1779 return ::SimplifyOrInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1783 /// SimplifyXorInst - Given operands for a Xor, see if we can
1784 /// fold the result. If not, this returns null.
1785 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const Query &Q,
1786 unsigned MaxRecurse) {
1787 if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1788 if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1789 Constant *Ops[] = { CLHS, CRHS };
1790 return ConstantFoldInstOperands(Instruction::Xor, CLHS->getType(),
1794 // Canonicalize the constant to the RHS.
1795 std::swap(Op0, Op1);
1798 // A ^ undef -> undef
1799 if (match(Op1, m_Undef()))
1803 if (match(Op1, m_Zero()))
1808 return Constant::getNullValue(Op0->getType());
1810 // A ^ ~A = ~A ^ A = -1
1811 if (match(Op0, m_Not(m_Specific(Op1))) ||
1812 match(Op1, m_Not(m_Specific(Op0))))
1813 return Constant::getAllOnesValue(Op0->getType());
1815 // Try some generic simplifications for associative operations.
1816 if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1820 // Threading Xor over selects and phi nodes is pointless, so don't bother.
1821 // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1822 // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1823 // only if B and C are equal. If B and C are equal then (since we assume
1824 // that operands have already been simplified) "select(cond, B, C)" should
1825 // have been simplified to the common value of B and C already. Analysing
1826 // "A^B" and "A^C" thus gains nothing, but costs compile time. Similarly
1827 // for threading over phi nodes.
1832 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const DataLayout *DL,
1833 const TargetLibraryInfo *TLI,
1834 const DominatorTree *DT, AssumptionTracker *AT,
1835 const Instruction *CxtI) {
1836 return ::SimplifyXorInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1840 static Type *GetCompareTy(Value *Op) {
1841 return CmpInst::makeCmpResultType(Op->getType());
1844 /// ExtractEquivalentCondition - Rummage around inside V looking for something
1845 /// equivalent to the comparison "LHS Pred RHS". Return such a value if found,
1846 /// otherwise return null. Helper function for analyzing max/min idioms.
1847 static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
1848 Value *LHS, Value *RHS) {
1849 SelectInst *SI = dyn_cast<SelectInst>(V);
1852 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1855 Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
1856 if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
1858 if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
1859 LHS == CmpRHS && RHS == CmpLHS)
1864 // A significant optimization not implemented here is assuming that alloca
1865 // addresses are not equal to incoming argument values. They don't *alias*,
1866 // as we say, but that doesn't mean they aren't equal, so we take a
1867 // conservative approach.
1869 // This is inspired in part by C++11 5.10p1:
1870 // "Two pointers of the same type compare equal if and only if they are both
1871 // null, both point to the same function, or both represent the same
1874 // This is pretty permissive.
1876 // It's also partly due to C11 6.5.9p6:
1877 // "Two pointers compare equal if and only if both are null pointers, both are
1878 // pointers to the same object (including a pointer to an object and a
1879 // subobject at its beginning) or function, both are pointers to one past the
1880 // last element of the same array object, or one is a pointer to one past the
1881 // end of one array object and the other is a pointer to the start of a
1882 // different array object that happens to immediately follow the first array
1883 // object in the address space.)
1885 // C11's version is more restrictive, however there's no reason why an argument
1886 // couldn't be a one-past-the-end value for a stack object in the caller and be
1887 // equal to the beginning of a stack object in the callee.
1889 // If the C and C++ standards are ever made sufficiently restrictive in this
1890 // area, it may be possible to update LLVM's semantics accordingly and reinstate
1891 // this optimization.
1892 static Constant *computePointerICmp(const DataLayout *DL,
1893 const TargetLibraryInfo *TLI,
1894 CmpInst::Predicate Pred,
1895 Value *LHS, Value *RHS) {
1896 // First, skip past any trivial no-ops.
1897 LHS = LHS->stripPointerCasts();
1898 RHS = RHS->stripPointerCasts();
1900 // A non-null pointer is not equal to a null pointer.
1901 if (llvm::isKnownNonNull(LHS, TLI) && isa<ConstantPointerNull>(RHS) &&
1902 (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
1903 return ConstantInt::get(GetCompareTy(LHS),
1904 !CmpInst::isTrueWhenEqual(Pred));
1906 // We can only fold certain predicates on pointer comparisons.
1911 // Equality comaprisons are easy to fold.
1912 case CmpInst::ICMP_EQ:
1913 case CmpInst::ICMP_NE:
1916 // We can only handle unsigned relational comparisons because 'inbounds' on
1917 // a GEP only protects against unsigned wrapping.
1918 case CmpInst::ICMP_UGT:
1919 case CmpInst::ICMP_UGE:
1920 case CmpInst::ICMP_ULT:
1921 case CmpInst::ICMP_ULE:
1922 // However, we have to switch them to their signed variants to handle
1923 // negative indices from the base pointer.
1924 Pred = ICmpInst::getSignedPredicate(Pred);
1928 // Strip off any constant offsets so that we can reason about them.
1929 // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
1930 // here and compare base addresses like AliasAnalysis does, however there are
1931 // numerous hazards. AliasAnalysis and its utilities rely on special rules
1932 // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
1933 // doesn't need to guarantee pointer inequality when it says NoAlias.
1934 Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
1935 Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
1937 // If LHS and RHS are related via constant offsets to the same base
1938 // value, we can replace it with an icmp which just compares the offsets.
1940 return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
1942 // Various optimizations for (in)equality comparisons.
1943 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
1944 // Different non-empty allocations that exist at the same time have
1945 // different addresses (if the program can tell). Global variables always
1946 // exist, so they always exist during the lifetime of each other and all
1947 // allocas. Two different allocas usually have different addresses...
1949 // However, if there's an @llvm.stackrestore dynamically in between two
1950 // allocas, they may have the same address. It's tempting to reduce the
1951 // scope of the problem by only looking at *static* allocas here. That would
1952 // cover the majority of allocas while significantly reducing the likelihood
1953 // of having an @llvm.stackrestore pop up in the middle. However, it's not
1954 // actually impossible for an @llvm.stackrestore to pop up in the middle of
1955 // an entry block. Also, if we have a block that's not attached to a
1956 // function, we can't tell if it's "static" under the current definition.
1957 // Theoretically, this problem could be fixed by creating a new kind of
1958 // instruction kind specifically for static allocas. Such a new instruction
1959 // could be required to be at the top of the entry block, thus preventing it
1960 // from being subject to a @llvm.stackrestore. Instcombine could even
1961 // convert regular allocas into these special allocas. It'd be nifty.
1962 // However, until then, this problem remains open.
1964 // So, we'll assume that two non-empty allocas have different addresses
1967 // With all that, if the offsets are within the bounds of their allocations
1968 // (and not one-past-the-end! so we can't use inbounds!), and their
1969 // allocations aren't the same, the pointers are not equal.
1971 // Note that it's not necessary to check for LHS being a global variable
1972 // address, due to canonicalization and constant folding.
1973 if (isa<AllocaInst>(LHS) &&
1974 (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
1975 ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
1976 ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
1977 uint64_t LHSSize, RHSSize;
1978 if (LHSOffsetCI && RHSOffsetCI &&
1979 getObjectSize(LHS, LHSSize, DL, TLI) &&
1980 getObjectSize(RHS, RHSSize, DL, TLI)) {
1981 const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
1982 const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
1983 if (!LHSOffsetValue.isNegative() &&
1984 !RHSOffsetValue.isNegative() &&
1985 LHSOffsetValue.ult(LHSSize) &&
1986 RHSOffsetValue.ult(RHSSize)) {
1987 return ConstantInt::get(GetCompareTy(LHS),
1988 !CmpInst::isTrueWhenEqual(Pred));
1992 // Repeat the above check but this time without depending on DataLayout
1993 // or being able to compute a precise size.
1994 if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
1995 !cast<PointerType>(RHS->getType())->isEmptyTy() &&
1996 LHSOffset->isNullValue() &&
1997 RHSOffset->isNullValue())
1998 return ConstantInt::get(GetCompareTy(LHS),
1999 !CmpInst::isTrueWhenEqual(Pred));
2002 // Even if an non-inbounds GEP occurs along the path we can still optimize
2003 // equality comparisons concerning the result. We avoid walking the whole
2004 // chain again by starting where the last calls to
2005 // stripAndComputeConstantOffsets left off and accumulate the offsets.
2006 Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2007 Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
2009 return ConstantExpr::getICmp(Pred,
2010 ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2011 ConstantExpr::getAdd(RHSOffset, RHSNoBound));
2013 // If one side of the equality comparison must come from a noalias call
2014 // (meaning a system memory allocation function), and the other side must
2015 // come from a pointer that cannot overlap with dynamically-allocated
2016 // memory within the lifetime of the current function (allocas, byval
2017 // arguments, globals), then determine the comparison result here.
2018 SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2019 GetUnderlyingObjects(LHS, LHSUObjs, DL);
2020 GetUnderlyingObjects(RHS, RHSUObjs, DL);
2022 // Is the set of underlying objects all noalias calls?
2023 auto IsNAC = [](SmallVectorImpl<Value *> &Objects) {
2024 return std::all_of(Objects.begin(), Objects.end(),
2025 [](Value *V){ return isNoAliasCall(V); });
2028 // Is the set of underlying objects all things which must be disjoint from
2030 auto IsAllocDisjoint = [](SmallVectorImpl<Value *> &Objects) {
2031 return std::all_of(Objects.begin(), Objects.end(),
2033 if (isa<AllocaInst>(V) || isa<GlobalValue>(V))
2035 if (const Argument *A = dyn_cast<Argument>(V))
2036 return A->hasByValAttr();
2041 if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2042 (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2043 return ConstantInt::get(GetCompareTy(LHS),
2044 !CmpInst::isTrueWhenEqual(Pred));
2051 /// SimplifyICmpInst - Given operands for an ICmpInst, see if we can
2052 /// fold the result. If not, this returns null.
2053 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2054 const Query &Q, unsigned MaxRecurse) {
2055 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
2056 assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
2058 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
2059 if (Constant *CRHS = dyn_cast<Constant>(RHS))
2060 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
2062 // If we have a constant, make sure it is on the RHS.
2063 std::swap(LHS, RHS);
2064 Pred = CmpInst::getSwappedPredicate(Pred);
2067 Type *ITy = GetCompareTy(LHS); // The return type.
2068 Type *OpTy = LHS->getType(); // The operand type.
2070 // icmp X, X -> true/false
2071 // X icmp undef -> true/false. For example, icmp ugt %X, undef -> false
2072 // because X could be 0.
2073 if (LHS == RHS || isa<UndefValue>(RHS))
2074 return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
2076 // Special case logic when the operands have i1 type.
2077 if (OpTy->getScalarType()->isIntegerTy(1)) {
2080 case ICmpInst::ICMP_EQ:
2082 if (match(RHS, m_One()))
2085 case ICmpInst::ICMP_NE:
2087 if (match(RHS, m_Zero()))
2090 case ICmpInst::ICMP_UGT:
2092 if (match(RHS, m_Zero()))
2095 case ICmpInst::ICMP_UGE:
2097 if (match(RHS, m_One()))
2100 case ICmpInst::ICMP_SLT:
2102 if (match(RHS, m_Zero()))
2105 case ICmpInst::ICMP_SLE:
2107 if (match(RHS, m_One()))
2113 // If we are comparing with zero then try hard since this is a common case.
2114 if (match(RHS, m_Zero())) {
2115 bool LHSKnownNonNegative, LHSKnownNegative;
2117 default: llvm_unreachable("Unknown ICmp predicate!");
2118 case ICmpInst::ICMP_ULT:
2119 return getFalse(ITy);
2120 case ICmpInst::ICMP_UGE:
2121 return getTrue(ITy);
2122 case ICmpInst::ICMP_EQ:
2123 case ICmpInst::ICMP_ULE:
2124 if (isKnownNonZero(LHS, Q.DL, 0, Q.AT, Q.CxtI, Q.DT))
2125 return getFalse(ITy);
2127 case ICmpInst::ICMP_NE:
2128 case ICmpInst::ICMP_UGT:
2129 if (isKnownNonZero(LHS, Q.DL, 0, Q.AT, Q.CxtI, Q.DT))
2130 return getTrue(ITy);
2132 case ICmpInst::ICMP_SLT:
2133 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2134 0, Q.AT, Q.CxtI, Q.DT);
2135 if (LHSKnownNegative)
2136 return getTrue(ITy);
2137 if (LHSKnownNonNegative)
2138 return getFalse(ITy);
2140 case ICmpInst::ICMP_SLE:
2141 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2142 0, Q.AT, Q.CxtI, Q.DT);
2143 if (LHSKnownNegative)
2144 return getTrue(ITy);
2145 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL,
2146 0, Q.AT, Q.CxtI, Q.DT))
2147 return getFalse(ITy);
2149 case ICmpInst::ICMP_SGE:
2150 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2151 0, Q.AT, Q.CxtI, Q.DT);
2152 if (LHSKnownNegative)
2153 return getFalse(ITy);
2154 if (LHSKnownNonNegative)
2155 return getTrue(ITy);
2157 case ICmpInst::ICMP_SGT:
2158 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2159 0, Q.AT, Q.CxtI, Q.DT);
2160 if (LHSKnownNegative)
2161 return getFalse(ITy);
2162 if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL,
2163 0, Q.AT, Q.CxtI, Q.DT))
2164 return getTrue(ITy);
2169 // See if we are doing a comparison with a constant integer.
2170 if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2171 // Rule out tautological comparisons (eg., ult 0 or uge 0).
2172 ConstantRange RHS_CR = ICmpInst::makeConstantRange(Pred, CI->getValue());
2173 if (RHS_CR.isEmptySet())
2174 return ConstantInt::getFalse(CI->getContext());
2175 if (RHS_CR.isFullSet())
2176 return ConstantInt::getTrue(CI->getContext());
2178 // Many binary operators with constant RHS have easy to compute constant
2179 // range. Use them to check whether the comparison is a tautology.
2180 unsigned Width = CI->getBitWidth();
2181 APInt Lower = APInt(Width, 0);
2182 APInt Upper = APInt(Width, 0);
2184 if (match(LHS, m_URem(m_Value(), m_ConstantInt(CI2)))) {
2185 // 'urem x, CI2' produces [0, CI2).
2186 Upper = CI2->getValue();
2187 } else if (match(LHS, m_SRem(m_Value(), m_ConstantInt(CI2)))) {
2188 // 'srem x, CI2' produces (-|CI2|, |CI2|).
2189 Upper = CI2->getValue().abs();
2190 Lower = (-Upper) + 1;
2191 } else if (match(LHS, m_UDiv(m_ConstantInt(CI2), m_Value()))) {
2192 // 'udiv CI2, x' produces [0, CI2].
2193 Upper = CI2->getValue() + 1;
2194 } else if (match(LHS, m_UDiv(m_Value(), m_ConstantInt(CI2)))) {
2195 // 'udiv x, CI2' produces [0, UINT_MAX / CI2].
2196 APInt NegOne = APInt::getAllOnesValue(Width);
2198 Upper = NegOne.udiv(CI2->getValue()) + 1;
2199 } else if (match(LHS, m_SDiv(m_ConstantInt(CI2), m_Value()))) {
2200 if (CI2->isMinSignedValue()) {
2201 // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2202 Lower = CI2->getValue();
2203 Upper = Lower.lshr(1) + 1;
2205 // 'sdiv CI2, x' produces [-|CI2|, |CI2|].
2206 Upper = CI2->getValue().abs() + 1;
2207 Lower = (-Upper) + 1;
2209 } else if (match(LHS, m_SDiv(m_Value(), m_ConstantInt(CI2)))) {
2210 APInt IntMin = APInt::getSignedMinValue(Width);
2211 APInt IntMax = APInt::getSignedMaxValue(Width);
2212 APInt Val = CI2->getValue();
2213 if (Val.isAllOnesValue()) {
2214 // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2215 // where CI2 != -1 and CI2 != 0 and CI2 != 1
2218 } else if (Val.countLeadingZeros() < Width - 1) {
2219 // 'sdiv x, CI2' produces [INT_MIN / CI2, INT_MAX / CI2]
2220 // where CI2 != -1 and CI2 != 0 and CI2 != 1
2221 Lower = IntMin.sdiv(Val);
2222 Upper = IntMax.sdiv(Val);
2223 if (Lower.sgt(Upper))
2224 std::swap(Lower, Upper);
2226 assert(Upper != Lower && "Upper part of range has wrapped!");
2228 } else if (match(LHS, m_NUWShl(m_ConstantInt(CI2), m_Value()))) {
2229 // 'shl nuw CI2, x' produces [CI2, CI2 << CLZ(CI2)]
2230 Lower = CI2->getValue();
2231 Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2232 } else if (match(LHS, m_NSWShl(m_ConstantInt(CI2), m_Value()))) {
2233 if (CI2->isNegative()) {
2234 // 'shl nsw CI2, x' produces [CI2 << CLO(CI2)-1, CI2]
2235 unsigned ShiftAmount = CI2->getValue().countLeadingOnes() - 1;
2236 Lower = CI2->getValue().shl(ShiftAmount);
2237 Upper = CI2->getValue() + 1;
2239 // 'shl nsw CI2, x' produces [CI2, CI2 << CLZ(CI2)-1]
2240 unsigned ShiftAmount = CI2->getValue().countLeadingZeros() - 1;
2241 Lower = CI2->getValue();
2242 Upper = CI2->getValue().shl(ShiftAmount) + 1;
2244 } else if (match(LHS, m_LShr(m_Value(), m_ConstantInt(CI2)))) {
2245 // 'lshr x, CI2' produces [0, UINT_MAX >> CI2].
2246 APInt NegOne = APInt::getAllOnesValue(Width);
2247 if (CI2->getValue().ult(Width))
2248 Upper = NegOne.lshr(CI2->getValue()) + 1;
2249 } else if (match(LHS, m_LShr(m_ConstantInt(CI2), m_Value()))) {
2250 // 'lshr CI2, x' produces [CI2 >> (Width-1), CI2].
2251 unsigned ShiftAmount = Width - 1;
2252 if (!CI2->isZero() && cast<BinaryOperator>(LHS)->isExact())
2253 ShiftAmount = CI2->getValue().countTrailingZeros();
2254 Lower = CI2->getValue().lshr(ShiftAmount);
2255 Upper = CI2->getValue() + 1;
2256 } else if (match(LHS, m_AShr(m_Value(), m_ConstantInt(CI2)))) {
2257 // 'ashr x, CI2' produces [INT_MIN >> CI2, INT_MAX >> CI2].
2258 APInt IntMin = APInt::getSignedMinValue(Width);
2259 APInt IntMax = APInt::getSignedMaxValue(Width);
2260 if (CI2->getValue().ult(Width)) {
2261 Lower = IntMin.ashr(CI2->getValue());
2262 Upper = IntMax.ashr(CI2->getValue()) + 1;
2264 } else if (match(LHS, m_AShr(m_ConstantInt(CI2), m_Value()))) {
2265 unsigned ShiftAmount = Width - 1;
2266 if (!CI2->isZero() && cast<BinaryOperator>(LHS)->isExact())
2267 ShiftAmount = CI2->getValue().countTrailingZeros();
2268 if (CI2->isNegative()) {
2269 // 'ashr CI2, x' produces [CI2, CI2 >> (Width-1)]
2270 Lower = CI2->getValue();
2271 Upper = CI2->getValue().ashr(ShiftAmount) + 1;
2273 // 'ashr CI2, x' produces [CI2 >> (Width-1), CI2]
2274 Lower = CI2->getValue().ashr(ShiftAmount);
2275 Upper = CI2->getValue() + 1;
2277 } else if (match(LHS, m_Or(m_Value(), m_ConstantInt(CI2)))) {
2278 // 'or x, CI2' produces [CI2, UINT_MAX].
2279 Lower = CI2->getValue();
2280 } else if (match(LHS, m_And(m_Value(), m_ConstantInt(CI2)))) {
2281 // 'and x, CI2' produces [0, CI2].
2282 Upper = CI2->getValue() + 1;
2284 if (Lower != Upper) {
2285 ConstantRange LHS_CR = ConstantRange(Lower, Upper);
2286 if (RHS_CR.contains(LHS_CR))
2287 return ConstantInt::getTrue(RHS->getContext());
2288 if (RHS_CR.inverse().contains(LHS_CR))
2289 return ConstantInt::getFalse(RHS->getContext());
2293 // Compare of cast, for example (zext X) != 0 -> X != 0
2294 if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
2295 Instruction *LI = cast<CastInst>(LHS);
2296 Value *SrcOp = LI->getOperand(0);
2297 Type *SrcTy = SrcOp->getType();
2298 Type *DstTy = LI->getType();
2300 // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
2301 // if the integer type is the same size as the pointer type.
2302 if (MaxRecurse && Q.DL && isa<PtrToIntInst>(LI) &&
2303 Q.DL->getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
2304 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
2305 // Transfer the cast to the constant.
2306 if (Value *V = SimplifyICmpInst(Pred, SrcOp,
2307 ConstantExpr::getIntToPtr(RHSC, SrcTy),
2310 } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
2311 if (RI->getOperand(0)->getType() == SrcTy)
2312 // Compare without the cast.
2313 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
2319 if (isa<ZExtInst>(LHS)) {
2320 // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
2322 if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
2323 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
2324 // Compare X and Y. Note that signed predicates become unsigned.
2325 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
2326 SrcOp, RI->getOperand(0), Q,
2330 // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
2331 // too. If not, then try to deduce the result of the comparison.
2332 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2333 // Compute the constant that would happen if we truncated to SrcTy then
2334 // reextended to DstTy.
2335 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
2336 Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
2338 // If the re-extended constant didn't change then this is effectively
2339 // also a case of comparing two zero-extended values.
2340 if (RExt == CI && MaxRecurse)
2341 if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
2342 SrcOp, Trunc, Q, MaxRecurse-1))
2345 // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
2346 // there. Use this to work out the result of the comparison.
2349 default: llvm_unreachable("Unknown ICmp predicate!");
2351 case ICmpInst::ICMP_EQ:
2352 case ICmpInst::ICMP_UGT:
2353 case ICmpInst::ICMP_UGE:
2354 return ConstantInt::getFalse(CI->getContext());
2356 case ICmpInst::ICMP_NE:
2357 case ICmpInst::ICMP_ULT:
2358 case ICmpInst::ICMP_ULE:
2359 return ConstantInt::getTrue(CI->getContext());
2361 // LHS is non-negative. If RHS is negative then LHS >s LHS. If RHS
2362 // is non-negative then LHS <s RHS.
2363 case ICmpInst::ICMP_SGT:
2364 case ICmpInst::ICMP_SGE:
2365 return CI->getValue().isNegative() ?
2366 ConstantInt::getTrue(CI->getContext()) :
2367 ConstantInt::getFalse(CI->getContext());
2369 case ICmpInst::ICMP_SLT:
2370 case ICmpInst::ICMP_SLE:
2371 return CI->getValue().isNegative() ?
2372 ConstantInt::getFalse(CI->getContext()) :
2373 ConstantInt::getTrue(CI->getContext());
2379 if (isa<SExtInst>(LHS)) {
2380 // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
2382 if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
2383 if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
2384 // Compare X and Y. Note that the predicate does not change.
2385 if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
2389 // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
2390 // too. If not, then try to deduce the result of the comparison.
2391 else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2392 // Compute the constant that would happen if we truncated to SrcTy then
2393 // reextended to DstTy.
2394 Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
2395 Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
2397 // If the re-extended constant didn't change then this is effectively
2398 // also a case of comparing two sign-extended values.
2399 if (RExt == CI && MaxRecurse)
2400 if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
2403 // Otherwise the upper bits of LHS are all equal, while RHS has varying
2404 // bits there. Use this to work out the result of the comparison.
2407 default: llvm_unreachable("Unknown ICmp predicate!");
2408 case ICmpInst::ICMP_EQ:
2409 return ConstantInt::getFalse(CI->getContext());
2410 case ICmpInst::ICMP_NE:
2411 return ConstantInt::getTrue(CI->getContext());
2413 // If RHS is non-negative then LHS <s RHS. If RHS is negative then
2415 case ICmpInst::ICMP_SGT:
2416 case ICmpInst::ICMP_SGE:
2417 return CI->getValue().isNegative() ?
2418 ConstantInt::getTrue(CI->getContext()) :
2419 ConstantInt::getFalse(CI->getContext());
2420 case ICmpInst::ICMP_SLT:
2421 case ICmpInst::ICMP_SLE:
2422 return CI->getValue().isNegative() ?
2423 ConstantInt::getFalse(CI->getContext()) :
2424 ConstantInt::getTrue(CI->getContext());
2426 // If LHS is non-negative then LHS <u RHS. If LHS is negative then
2428 case ICmpInst::ICMP_UGT:
2429 case ICmpInst::ICMP_UGE:
2430 // Comparison is true iff the LHS <s 0.
2432 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
2433 Constant::getNullValue(SrcTy),
2437 case ICmpInst::ICMP_ULT:
2438 case ICmpInst::ICMP_ULE:
2439 // Comparison is true iff the LHS >=s 0.
2441 if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
2442 Constant::getNullValue(SrcTy),
2452 // Special logic for binary operators.
2453 BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2454 BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2455 if (MaxRecurse && (LBO || RBO)) {
2456 // Analyze the case when either LHS or RHS is an add instruction.
2457 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2458 // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2459 bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2460 if (LBO && LBO->getOpcode() == Instruction::Add) {
2461 A = LBO->getOperand(0); B = LBO->getOperand(1);
2462 NoLHSWrapProblem = ICmpInst::isEquality(Pred) ||
2463 (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2464 (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2466 if (RBO && RBO->getOpcode() == Instruction::Add) {
2467 C = RBO->getOperand(0); D = RBO->getOperand(1);
2468 NoRHSWrapProblem = ICmpInst::isEquality(Pred) ||
2469 (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2470 (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2473 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2474 if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2475 if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2476 Constant::getNullValue(RHS->getType()),
2480 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2481 if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2482 if (Value *V = SimplifyICmpInst(Pred,
2483 Constant::getNullValue(LHS->getType()),
2484 C == LHS ? D : C, Q, MaxRecurse-1))
2487 // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2488 if (A && C && (A == C || A == D || B == C || B == D) &&
2489 NoLHSWrapProblem && NoRHSWrapProblem) {
2490 // Determine Y and Z in the form icmp (X+Y), (X+Z).
2493 // C + B == C + D -> B == D
2496 } else if (A == D) {
2497 // D + B == C + D -> B == C
2500 } else if (B == C) {
2501 // A + C == C + D -> A == D
2506 // A + D == C + D -> A == C
2510 if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse-1))
2515 // icmp pred (or X, Y), X
2516 if (LBO && match(LBO, m_CombineOr(m_Or(m_Value(), m_Specific(RHS)),
2517 m_Or(m_Specific(RHS), m_Value())))) {
2518 if (Pred == ICmpInst::ICMP_ULT)
2519 return getFalse(ITy);
2520 if (Pred == ICmpInst::ICMP_UGE)
2521 return getTrue(ITy);
2523 // icmp pred X, (or X, Y)
2524 if (RBO && match(RBO, m_CombineOr(m_Or(m_Value(), m_Specific(LHS)),
2525 m_Or(m_Specific(LHS), m_Value())))) {
2526 if (Pred == ICmpInst::ICMP_ULE)
2527 return getTrue(ITy);
2528 if (Pred == ICmpInst::ICMP_UGT)
2529 return getFalse(ITy);
2532 // icmp pred (and X, Y), X
2533 if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2534 m_And(m_Specific(RHS), m_Value())))) {
2535 if (Pred == ICmpInst::ICMP_UGT)
2536 return getFalse(ITy);
2537 if (Pred == ICmpInst::ICMP_ULE)
2538 return getTrue(ITy);
2540 // icmp pred X, (and X, Y)
2541 if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2542 m_And(m_Specific(LHS), m_Value())))) {
2543 if (Pred == ICmpInst::ICMP_UGE)
2544 return getTrue(ITy);
2545 if (Pred == ICmpInst::ICMP_ULT)
2546 return getFalse(ITy);
2549 // 0 - (zext X) pred C
2550 if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2551 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2552 if (RHSC->getValue().isStrictlyPositive()) {
2553 if (Pred == ICmpInst::ICMP_SLT)
2554 return ConstantInt::getTrue(RHSC->getContext());
2555 if (Pred == ICmpInst::ICMP_SGE)
2556 return ConstantInt::getFalse(RHSC->getContext());
2557 if (Pred == ICmpInst::ICMP_EQ)
2558 return ConstantInt::getFalse(RHSC->getContext());
2559 if (Pred == ICmpInst::ICMP_NE)
2560 return ConstantInt::getTrue(RHSC->getContext());
2562 if (RHSC->getValue().isNonNegative()) {
2563 if (Pred == ICmpInst::ICMP_SLE)
2564 return ConstantInt::getTrue(RHSC->getContext());
2565 if (Pred == ICmpInst::ICMP_SGT)
2566 return ConstantInt::getFalse(RHSC->getContext());
2571 // icmp pred (urem X, Y), Y
2572 if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2573 bool KnownNonNegative, KnownNegative;
2577 case ICmpInst::ICMP_SGT:
2578 case ICmpInst::ICMP_SGE:
2579 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL,
2580 0, Q.AT, Q.CxtI, Q.DT);
2581 if (!KnownNonNegative)
2584 case ICmpInst::ICMP_EQ:
2585 case ICmpInst::ICMP_UGT:
2586 case ICmpInst::ICMP_UGE:
2587 return getFalse(ITy);
2588 case ICmpInst::ICMP_SLT:
2589 case ICmpInst::ICMP_SLE:
2590 ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL,
2591 0, Q.AT, Q.CxtI, Q.DT);
2592 if (!KnownNonNegative)
2595 case ICmpInst::ICMP_NE:
2596 case ICmpInst::ICMP_ULT:
2597 case ICmpInst::ICMP_ULE:
2598 return getTrue(ITy);
2602 // icmp pred X, (urem Y, X)
2603 if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2604 bool KnownNonNegative, KnownNegative;
2608 case ICmpInst::ICMP_SGT:
2609 case ICmpInst::ICMP_SGE:
2610 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL,
2611 0, Q.AT, Q.CxtI, Q.DT);
2612 if (!KnownNonNegative)
2615 case ICmpInst::ICMP_NE:
2616 case ICmpInst::ICMP_UGT:
2617 case ICmpInst::ICMP_UGE:
2618 return getTrue(ITy);
2619 case ICmpInst::ICMP_SLT:
2620 case ICmpInst::ICMP_SLE:
2621 ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL,
2622 0, Q.AT, Q.CxtI, Q.DT);
2623 if (!KnownNonNegative)
2626 case ICmpInst::ICMP_EQ:
2627 case ICmpInst::ICMP_ULT:
2628 case ICmpInst::ICMP_ULE:
2629 return getFalse(ITy);
2634 if (LBO && match(LBO, m_UDiv(m_Specific(RHS), m_Value()))) {
2635 // icmp pred (X /u Y), X
2636 if (Pred == ICmpInst::ICMP_UGT)
2637 return getFalse(ITy);
2638 if (Pred == ICmpInst::ICMP_ULE)
2639 return getTrue(ITy);
2646 // where CI2 is a power of 2 and CI isn't
2647 if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2648 const APInt *CI2Val, *CIVal = &CI->getValue();
2649 if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2650 CI2Val->isPowerOf2()) {
2651 if (!CIVal->isPowerOf2()) {
2652 // CI2 << X can equal zero in some circumstances,
2653 // this simplification is unsafe if CI is zero.
2655 // We know it is safe if:
2656 // - The shift is nsw, we can't shift out the one bit.
2657 // - The shift is nuw, we can't shift out the one bit.
2660 if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2661 *CI2Val == 1 || !CI->isZero()) {
2662 if (Pred == ICmpInst::ICMP_EQ)
2663 return ConstantInt::getFalse(RHS->getContext());
2664 if (Pred == ICmpInst::ICMP_NE)
2665 return ConstantInt::getTrue(RHS->getContext());
2668 if (CIVal->isSignBit() && *CI2Val == 1) {
2669 if (Pred == ICmpInst::ICMP_UGT)
2670 return ConstantInt::getFalse(RHS->getContext());
2671 if (Pred == ICmpInst::ICMP_ULE)
2672 return ConstantInt::getTrue(RHS->getContext());
2677 if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2678 LBO->getOperand(1) == RBO->getOperand(1)) {
2679 switch (LBO->getOpcode()) {
2681 case Instruction::UDiv:
2682 case Instruction::LShr:
2683 if (ICmpInst::isSigned(Pred))
2686 case Instruction::SDiv:
2687 case Instruction::AShr:
2688 if (!LBO->isExact() || !RBO->isExact())
2690 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2691 RBO->getOperand(0), Q, MaxRecurse-1))
2694 case Instruction::Shl: {
2695 bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2696 bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2699 if (!NSW && ICmpInst::isSigned(Pred))
2701 if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2702 RBO->getOperand(0), Q, MaxRecurse-1))
2709 // Simplify comparisons involving max/min.
2711 CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2712 CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2714 // Signed variants on "max(a,b)>=a -> true".
2715 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2716 if (A != RHS) std::swap(A, B); // smax(A, B) pred A.
2717 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2718 // We analyze this as smax(A, B) pred A.
2720 } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2721 (A == LHS || B == LHS)) {
2722 if (A != LHS) std::swap(A, B); // A pred smax(A, B).
2723 EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2724 // We analyze this as smax(A, B) swapped-pred A.
2725 P = CmpInst::getSwappedPredicate(Pred);
2726 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2727 (A == RHS || B == RHS)) {
2728 if (A != RHS) std::swap(A, B); // smin(A, B) pred A.
2729 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2730 // We analyze this as smax(-A, -B) swapped-pred -A.
2731 // Note that we do not need to actually form -A or -B thanks to EqP.
2732 P = CmpInst::getSwappedPredicate(Pred);
2733 } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2734 (A == LHS || B == LHS)) {
2735 if (A != LHS) std::swap(A, B); // A pred smin(A, B).
2736 EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2737 // We analyze this as smax(-A, -B) pred -A.
2738 // Note that we do not need to actually form -A or -B thanks to EqP.
2741 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2742 // Cases correspond to "max(A, B) p A".
2746 case CmpInst::ICMP_EQ:
2747 case CmpInst::ICMP_SLE:
2748 // Equivalent to "A EqP B". This may be the same as the condition tested
2749 // in the max/min; if so, we can just return that.
2750 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2752 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2754 // Otherwise, see if "A EqP B" simplifies.
2756 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse-1))
2759 case CmpInst::ICMP_NE:
2760 case CmpInst::ICMP_SGT: {
2761 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2762 // Equivalent to "A InvEqP B". This may be the same as the condition
2763 // tested in the max/min; if so, we can just return that.
2764 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2766 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2768 // Otherwise, see if "A InvEqP B" simplifies.
2770 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse-1))
2774 case CmpInst::ICMP_SGE:
2776 return getTrue(ITy);
2777 case CmpInst::ICMP_SLT:
2779 return getFalse(ITy);
2783 // Unsigned variants on "max(a,b)>=a -> true".
2784 P = CmpInst::BAD_ICMP_PREDICATE;
2785 if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2786 if (A != RHS) std::swap(A, B); // umax(A, B) pred A.
2787 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2788 // We analyze this as umax(A, B) pred A.
2790 } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2791 (A == LHS || B == LHS)) {
2792 if (A != LHS) std::swap(A, B); // A pred umax(A, B).
2793 EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2794 // We analyze this as umax(A, B) swapped-pred A.
2795 P = CmpInst::getSwappedPredicate(Pred);
2796 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2797 (A == RHS || B == RHS)) {
2798 if (A != RHS) std::swap(A, B); // umin(A, B) pred A.
2799 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2800 // We analyze this as umax(-A, -B) swapped-pred -A.
2801 // Note that we do not need to actually form -A or -B thanks to EqP.
2802 P = CmpInst::getSwappedPredicate(Pred);
2803 } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2804 (A == LHS || B == LHS)) {
2805 if (A != LHS) std::swap(A, B); // A pred umin(A, B).
2806 EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2807 // We analyze this as umax(-A, -B) pred -A.
2808 // Note that we do not need to actually form -A or -B thanks to EqP.
2811 if (P != CmpInst::BAD_ICMP_PREDICATE) {
2812 // Cases correspond to "max(A, B) p A".
2816 case CmpInst::ICMP_EQ:
2817 case CmpInst::ICMP_ULE:
2818 // Equivalent to "A EqP B". This may be the same as the condition tested
2819 // in the max/min; if so, we can just return that.
2820 if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2822 if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2824 // Otherwise, see if "A EqP B" simplifies.
2826 if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse-1))
2829 case CmpInst::ICMP_NE:
2830 case CmpInst::ICMP_UGT: {
2831 CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2832 // Equivalent to "A InvEqP B". This may be the same as the condition
2833 // tested in the max/min; if so, we can just return that.
2834 if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2836 if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2838 // Otherwise, see if "A InvEqP B" simplifies.
2840 if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse-1))
2844 case CmpInst::ICMP_UGE:
2846 return getTrue(ITy);
2847 case CmpInst::ICMP_ULT:
2849 return getFalse(ITy);
2853 // Variants on "max(x,y) >= min(x,z)".
2855 if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
2856 match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
2857 (A == C || A == D || B == C || B == D)) {
2858 // max(x, ?) pred min(x, ?).
2859 if (Pred == CmpInst::ICMP_SGE)
2861 return getTrue(ITy);
2862 if (Pred == CmpInst::ICMP_SLT)
2864 return getFalse(ITy);
2865 } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2866 match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
2867 (A == C || A == D || B == C || B == D)) {
2868 // min(x, ?) pred max(x, ?).
2869 if (Pred == CmpInst::ICMP_SLE)
2871 return getTrue(ITy);
2872 if (Pred == CmpInst::ICMP_SGT)
2874 return getFalse(ITy);
2875 } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
2876 match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
2877 (A == C || A == D || B == C || B == D)) {
2878 // max(x, ?) pred min(x, ?).
2879 if (Pred == CmpInst::ICMP_UGE)
2881 return getTrue(ITy);
2882 if (Pred == CmpInst::ICMP_ULT)
2884 return getFalse(ITy);
2885 } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2886 match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
2887 (A == C || A == D || B == C || B == D)) {
2888 // min(x, ?) pred max(x, ?).
2889 if (Pred == CmpInst::ICMP_ULE)
2891 return getTrue(ITy);
2892 if (Pred == CmpInst::ICMP_UGT)
2894 return getFalse(ITy);
2897 // Simplify comparisons of related pointers using a powerful, recursive
2898 // GEP-walk when we have target data available..
2899 if (LHS->getType()->isPointerTy())
2900 if (Constant *C = computePointerICmp(Q.DL, Q.TLI, Pred, LHS, RHS))
2903 if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
2904 if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
2905 if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
2906 GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
2907 (ICmpInst::isEquality(Pred) ||
2908 (GLHS->isInBounds() && GRHS->isInBounds() &&
2909 Pred == ICmpInst::getSignedPredicate(Pred)))) {
2910 // The bases are equal and the indices are constant. Build a constant
2911 // expression GEP with the same indices and a null base pointer to see
2912 // what constant folding can make out of it.
2913 Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
2914 SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
2915 Constant *NewLHS = ConstantExpr::getGetElementPtr(Null, IndicesLHS);
2917 SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
2918 Constant *NewRHS = ConstantExpr::getGetElementPtr(Null, IndicesRHS);
2919 return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
2924 // If a bit is known to be zero for A and known to be one for B,
2925 // then A and B cannot be equal.
2926 if (ICmpInst::isEquality(Pred)) {
2927 if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2928 uint32_t BitWidth = CI->getBitWidth();
2929 APInt LHSKnownZero(BitWidth, 0);
2930 APInt LHSKnownOne(BitWidth, 0);
2931 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, Q.DL, /*Depth=*/0, Q.AT,
2933 const APInt &RHSVal = CI->getValue();
2934 if (((LHSKnownZero & RHSVal) != 0) || ((LHSKnownOne & ~RHSVal) != 0))
2935 return Pred == ICmpInst::ICMP_EQ
2936 ? ConstantInt::getFalse(CI->getContext())
2937 : ConstantInt::getTrue(CI->getContext());
2941 // If the comparison is with the result of a select instruction, check whether
2942 // comparing with either branch of the select always yields the same value.
2943 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
2944 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
2947 // If the comparison is with the result of a phi instruction, check whether
2948 // doing the compare with each incoming phi value yields a common result.
2949 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
2950 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
2956 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2957 const DataLayout *DL,
2958 const TargetLibraryInfo *TLI,
2959 const DominatorTree *DT,
2960 AssumptionTracker *AT,
2961 Instruction *CxtI) {
2962 return ::SimplifyICmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
2966 /// SimplifyFCmpInst - Given operands for an FCmpInst, see if we can
2967 /// fold the result. If not, this returns null.
2968 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2969 const Query &Q, unsigned MaxRecurse) {
2970 CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
2971 assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
2973 if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
2974 if (Constant *CRHS = dyn_cast<Constant>(RHS))
2975 return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
2977 // If we have a constant, make sure it is on the RHS.
2978 std::swap(LHS, RHS);
2979 Pred = CmpInst::getSwappedPredicate(Pred);
2982 // Fold trivial predicates.
2983 if (Pred == FCmpInst::FCMP_FALSE)
2984 return ConstantInt::get(GetCompareTy(LHS), 0);
2985 if (Pred == FCmpInst::FCMP_TRUE)
2986 return ConstantInt::get(GetCompareTy(LHS), 1);
2988 if (isa<UndefValue>(RHS)) // fcmp pred X, undef -> undef
2989 return UndefValue::get(GetCompareTy(LHS));
2991 // fcmp x,x -> true/false. Not all compares are foldable.
2993 if (CmpInst::isTrueWhenEqual(Pred))
2994 return ConstantInt::get(GetCompareTy(LHS), 1);
2995 if (CmpInst::isFalseWhenEqual(Pred))
2996 return ConstantInt::get(GetCompareTy(LHS), 0);
2999 // Handle fcmp with constant RHS
3000 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3001 // If the constant is a nan, see if we can fold the comparison based on it.
3002 if (ConstantFP *CFP = dyn_cast<ConstantFP>(RHSC)) {
3003 if (CFP->getValueAPF().isNaN()) {
3004 if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
3005 return ConstantInt::getFalse(CFP->getContext());
3006 assert(FCmpInst::isUnordered(Pred) &&
3007 "Comparison must be either ordered or unordered!");
3008 // True if unordered.
3009 return ConstantInt::getTrue(CFP->getContext());
3011 // Check whether the constant is an infinity.
3012 if (CFP->getValueAPF().isInfinity()) {
3013 if (CFP->getValueAPF().isNegative()) {
3015 case FCmpInst::FCMP_OLT:
3016 // No value is ordered and less than negative infinity.
3017 return ConstantInt::getFalse(CFP->getContext());
3018 case FCmpInst::FCMP_UGE:
3019 // All values are unordered with or at least negative infinity.
3020 return ConstantInt::getTrue(CFP->getContext());
3026 case FCmpInst::FCMP_OGT:
3027 // No value is ordered and greater than infinity.
3028 return ConstantInt::getFalse(CFP->getContext());
3029 case FCmpInst::FCMP_ULE:
3030 // All values are unordered with and at most infinity.
3031 return ConstantInt::getTrue(CFP->getContext());
3040 // If the comparison is with the result of a select instruction, check whether
3041 // comparing with either branch of the select always yields the same value.
3042 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3043 if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3046 // If the comparison is with the result of a phi instruction, check whether
3047 // doing the compare with each incoming phi value yields a common result.
3048 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3049 if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3055 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3056 const DataLayout *DL,
3057 const TargetLibraryInfo *TLI,
3058 const DominatorTree *DT,
3059 AssumptionTracker *AT,
3060 const Instruction *CxtI) {
3061 return ::SimplifyFCmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3065 /// SimplifySelectInst - Given operands for a SelectInst, see if we can fold
3066 /// the result. If not, this returns null.
3067 static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
3068 Value *FalseVal, const Query &Q,
3069 unsigned MaxRecurse) {
3070 // select true, X, Y -> X
3071 // select false, X, Y -> Y
3072 if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3073 if (CB->isAllOnesValue())
3075 if (CB->isNullValue())
3079 // select C, X, X -> X
3080 if (TrueVal == FalseVal)
3083 if (isa<UndefValue>(CondVal)) { // select undef, X, Y -> X or Y
3084 if (isa<Constant>(TrueVal))
3088 if (isa<UndefValue>(TrueVal)) // select C, undef, X -> X
3090 if (isa<UndefValue>(FalseVal)) // select C, X, undef -> X
3093 if (const auto *ICI = dyn_cast<ICmpInst>(CondVal)) {
3096 if (ICI->isEquality() &&
3097 match(ICI->getOperand(0), m_And(m_Value(X), m_APInt(Y))) &&
3098 match(ICI->getOperand(1), m_Zero())) {
3099 ICmpInst::Predicate Pred = ICI->getPredicate();
3101 // (X & Y) == 0 ? X & ~Y : X --> X
3102 // (X & Y) != 0 ? X & ~Y : X --> X & ~Y
3103 if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3105 return Pred == ICmpInst::ICMP_EQ ? FalseVal : TrueVal;
3106 // (X & Y) == 0 ? X : X & ~Y --> X & ~Y
3107 // (X & Y) != 0 ? X : X & ~Y --> X
3108 if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3110 return Pred == ICmpInst::ICMP_EQ ? FalseVal : TrueVal;
3112 if (Y->isPowerOf2()) {
3113 // (X & Y) == 0 ? X | Y : X --> X | Y
3114 // (X & Y) != 0 ? X | Y : X --> X
3115 if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3117 return Pred == ICmpInst::ICMP_EQ ? TrueVal : FalseVal;
3118 // (X & Y) == 0 ? X : X | Y --> X
3119 // (X & Y) != 0 ? X : X | Y --> X | Y
3120 if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3122 return Pred == ICmpInst::ICMP_EQ ? TrueVal : FalseVal;
3130 Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3131 const DataLayout *DL,
3132 const TargetLibraryInfo *TLI,
3133 const DominatorTree *DT,
3134 AssumptionTracker *AT,
3135 const Instruction *CxtI) {
3136 return ::SimplifySelectInst(Cond, TrueVal, FalseVal,
3137 Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
3140 /// SimplifyGEPInst - Given operands for an GetElementPtrInst, see if we can
3141 /// fold the result. If not, this returns null.
3142 static Value *SimplifyGEPInst(ArrayRef<Value *> Ops, const Query &Q, unsigned) {
3143 // The type of the GEP pointer operand.
3144 PointerType *PtrTy = cast<PointerType>(Ops[0]->getType()->getScalarType());
3145 unsigned AS = PtrTy->getAddressSpace();
3147 // getelementptr P -> P.
3148 if (Ops.size() == 1)
3151 // Compute the (pointer) type returned by the GEP instruction.
3152 Type *LastType = GetElementPtrInst::getIndexedType(PtrTy, Ops.slice(1));
3153 Type *GEPTy = PointerType::get(LastType, AS);
3154 if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3155 GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3157 if (isa<UndefValue>(Ops[0]))
3158 return UndefValue::get(GEPTy);
3160 if (Ops.size() == 2) {
3161 // getelementptr P, 0 -> P.
3162 if (match(Ops[1], m_Zero()))
3165 Type *Ty = PtrTy->getElementType();
3166 if (Q.DL && Ty->isSized()) {
3169 uint64_t TyAllocSize = Q.DL->getTypeAllocSize(Ty);
3170 // getelementptr P, N -> P if P points to a type of zero size.
3171 if (TyAllocSize == 0)
3174 // The following transforms are only safe if the ptrtoint cast
3175 // doesn't truncate the pointers.
3176 if (Ops[1]->getType()->getScalarSizeInBits() ==
3177 Q.DL->getPointerSizeInBits(AS)) {
3178 auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3179 if (match(P, m_Zero()))
3180 return Constant::getNullValue(GEPTy);
3182 if (match(P, m_PtrToInt(m_Value(Temp))))
3183 if (Temp->getType() == GEPTy)
3188 // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3189 if (TyAllocSize == 1 &&
3190 match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3191 if (Value *R = PtrToIntOrZero(P))
3194 // getelementptr V, (ashr (sub P, V), C) -> Q
3195 // if P points to a type of size 1 << C.
3197 m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3198 m_ConstantInt(C))) &&
3199 TyAllocSize == 1ULL << C)
3200 if (Value *R = PtrToIntOrZero(P))
3203 // getelementptr V, (sdiv (sub P, V), C) -> Q
3204 // if P points to a type of size C.
3206 m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3207 m_SpecificInt(TyAllocSize))))
3208 if (Value *R = PtrToIntOrZero(P))
3214 // Check to see if this is constant foldable.
3215 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3216 if (!isa<Constant>(Ops[i]))
3219 return ConstantExpr::getGetElementPtr(cast<Constant>(Ops[0]), Ops.slice(1));
3222 Value *llvm::SimplifyGEPInst(ArrayRef<Value *> Ops, const DataLayout *DL,
3223 const TargetLibraryInfo *TLI,
3224 const DominatorTree *DT, AssumptionTracker *AT,
3225 const Instruction *CxtI) {
3226 return ::SimplifyGEPInst(Ops, Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
3229 /// SimplifyInsertValueInst - Given operands for an InsertValueInst, see if we
3230 /// can fold the result. If not, this returns null.
3231 static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3232 ArrayRef<unsigned> Idxs, const Query &Q,
3234 if (Constant *CAgg = dyn_cast<Constant>(Agg))
3235 if (Constant *CVal = dyn_cast<Constant>(Val))
3236 return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3238 // insertvalue x, undef, n -> x
3239 if (match(Val, m_Undef()))
3242 // insertvalue x, (extractvalue y, n), n
3243 if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
3244 if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3245 EV->getIndices() == Idxs) {
3246 // insertvalue undef, (extractvalue y, n), n -> y
3247 if (match(Agg, m_Undef()))
3248 return EV->getAggregateOperand();
3250 // insertvalue y, (extractvalue y, n), n -> y
3251 if (Agg == EV->getAggregateOperand())
3258 Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3259 ArrayRef<unsigned> Idxs,
3260 const DataLayout *DL,
3261 const TargetLibraryInfo *TLI,
3262 const DominatorTree *DT,
3263 AssumptionTracker *AT,
3264 const Instruction *CxtI) {
3265 return ::SimplifyInsertValueInst(Agg, Val, Idxs,
3266 Query (DL, TLI, DT, AT, CxtI),
3270 /// SimplifyPHINode - See if we can fold the given phi. If not, returns null.
3271 static Value *SimplifyPHINode(PHINode *PN, const Query &Q) {
3272 // If all of the PHI's incoming values are the same then replace the PHI node
3273 // with the common value.
3274 Value *CommonValue = nullptr;
3275 bool HasUndefInput = false;
3276 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3277 Value *Incoming = PN->getIncomingValue(i);
3278 // If the incoming value is the phi node itself, it can safely be skipped.
3279 if (Incoming == PN) continue;
3280 if (isa<UndefValue>(Incoming)) {
3281 // Remember that we saw an undef value, but otherwise ignore them.
3282 HasUndefInput = true;
3285 if (CommonValue && Incoming != CommonValue)
3286 return nullptr; // Not the same, bail out.
3287 CommonValue = Incoming;
3290 // If CommonValue is null then all of the incoming values were either undef or
3291 // equal to the phi node itself.
3293 return UndefValue::get(PN->getType());
3295 // If we have a PHI node like phi(X, undef, X), where X is defined by some
3296 // instruction, we cannot return X as the result of the PHI node unless it
3297 // dominates the PHI block.
3299 return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
3304 static Value *SimplifyTruncInst(Value *Op, Type *Ty, const Query &Q, unsigned) {
3305 if (Constant *C = dyn_cast<Constant>(Op))
3306 return ConstantFoldInstOperands(Instruction::Trunc, Ty, C, Q.DL, Q.TLI);
3311 Value *llvm::SimplifyTruncInst(Value *Op, Type *Ty, const DataLayout *DL,
3312 const TargetLibraryInfo *TLI,
3313 const DominatorTree *DT,
3314 AssumptionTracker *AT,
3315 const Instruction *CxtI) {
3316 return ::SimplifyTruncInst(Op, Ty, Query (DL, TLI, DT, AT, CxtI),
3320 //=== Helper functions for higher up the class hierarchy.
3322 /// SimplifyBinOp - Given operands for a BinaryOperator, see if we can
3323 /// fold the result. If not, this returns null.
3324 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
3325 const Query &Q, unsigned MaxRecurse) {
3327 case Instruction::Add:
3328 return SimplifyAddInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3330 case Instruction::FAdd:
3331 return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3333 case Instruction::Sub:
3334 return SimplifySubInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3336 case Instruction::FSub:
3337 return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3339 case Instruction::Mul: return SimplifyMulInst (LHS, RHS, Q, MaxRecurse);
3340 case Instruction::FMul:
3341 return SimplifyFMulInst (LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3342 case Instruction::SDiv: return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
3343 case Instruction::UDiv: return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
3344 case Instruction::FDiv: return SimplifyFDivInst(LHS, RHS, Q, MaxRecurse);
3345 case Instruction::SRem: return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
3346 case Instruction::URem: return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
3347 case Instruction::FRem: return SimplifyFRemInst(LHS, RHS, Q, MaxRecurse);
3348 case Instruction::Shl:
3349 return SimplifyShlInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3351 case Instruction::LShr:
3352 return SimplifyLShrInst(LHS, RHS, /*isExact*/false, Q, MaxRecurse);
3353 case Instruction::AShr:
3354 return SimplifyAShrInst(LHS, RHS, /*isExact*/false, Q, MaxRecurse);
3355 case Instruction::And: return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
3356 case Instruction::Or: return SimplifyOrInst (LHS, RHS, Q, MaxRecurse);
3357 case Instruction::Xor: return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
3359 if (Constant *CLHS = dyn_cast<Constant>(LHS))
3360 if (Constant *CRHS = dyn_cast<Constant>(RHS)) {
3361 Constant *COps[] = {CLHS, CRHS};
3362 return ConstantFoldInstOperands(Opcode, LHS->getType(), COps, Q.DL,
3366 // If the operation is associative, try some generic simplifications.
3367 if (Instruction::isAssociative(Opcode))
3368 if (Value *V = SimplifyAssociativeBinOp(Opcode, LHS, RHS, Q, MaxRecurse))
3371 // If the operation is with the result of a select instruction check whether
3372 // operating on either branch of the select always yields the same value.
3373 if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3374 if (Value *V = ThreadBinOpOverSelect(Opcode, LHS, RHS, Q, MaxRecurse))
3377 // If the operation is with the result of a phi instruction, check whether
3378 // operating on all incoming values of the phi always yields the same value.
3379 if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3380 if (Value *V = ThreadBinOpOverPHI(Opcode, LHS, RHS, Q, MaxRecurse))
3387 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
3388 const DataLayout *DL, const TargetLibraryInfo *TLI,
3389 const DominatorTree *DT, AssumptionTracker *AT,
3390 const Instruction *CxtI) {
3391 return ::SimplifyBinOp(Opcode, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3395 /// SimplifyCmpInst - Given operands for a CmpInst, see if we can
3396 /// fold the result.
3397 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3398 const Query &Q, unsigned MaxRecurse) {
3399 if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
3400 return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
3401 return SimplifyFCmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
3404 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3405 const DataLayout *DL, const TargetLibraryInfo *TLI,
3406 const DominatorTree *DT, AssumptionTracker *AT,
3407 const Instruction *CxtI) {
3408 return ::SimplifyCmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3412 static bool IsIdempotent(Intrinsic::ID ID) {
3414 default: return false;
3416 // Unary idempotent: f(f(x)) = f(x)
3417 case Intrinsic::fabs:
3418 case Intrinsic::floor:
3419 case Intrinsic::ceil:
3420 case Intrinsic::trunc:
3421 case Intrinsic::rint:
3422 case Intrinsic::nearbyint:
3423 case Intrinsic::round:
3428 template <typename IterTy>
3429 static Value *SimplifyIntrinsic(Intrinsic::ID IID, IterTy ArgBegin, IterTy ArgEnd,
3430 const Query &Q, unsigned MaxRecurse) {
3431 // Perform idempotent optimizations
3432 if (!IsIdempotent(IID))
3436 if (std::distance(ArgBegin, ArgEnd) == 1)
3437 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin))
3438 if (II->getIntrinsicID() == IID)
3444 template <typename IterTy>
3445 static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
3446 const Query &Q, unsigned MaxRecurse) {
3447 Type *Ty = V->getType();
3448 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
3449 Ty = PTy->getElementType();
3450 FunctionType *FTy = cast<FunctionType>(Ty);
3452 // call undef -> undef
3453 if (isa<UndefValue>(V))
3454 return UndefValue::get(FTy->getReturnType());
3456 Function *F = dyn_cast<Function>(V);
3460 if (unsigned IID = F->getIntrinsicID())
3462 SimplifyIntrinsic((Intrinsic::ID) IID, ArgBegin, ArgEnd, Q, MaxRecurse))
3465 if (!canConstantFoldCallTo(F))
3468 SmallVector<Constant *, 4> ConstantArgs;
3469 ConstantArgs.reserve(ArgEnd - ArgBegin);
3470 for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
3471 Constant *C = dyn_cast<Constant>(*I);
3474 ConstantArgs.push_back(C);
3477 return ConstantFoldCall(F, ConstantArgs, Q.TLI);
3480 Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
3481 User::op_iterator ArgEnd, const DataLayout *DL,
3482 const TargetLibraryInfo *TLI,
3483 const DominatorTree *DT, AssumptionTracker *AT,
3484 const Instruction *CxtI) {
3485 return ::SimplifyCall(V, ArgBegin, ArgEnd, Query(DL, TLI, DT, AT, CxtI),
3489 Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
3490 const DataLayout *DL, const TargetLibraryInfo *TLI,
3491 const DominatorTree *DT, AssumptionTracker *AT,
3492 const Instruction *CxtI) {
3493 return ::SimplifyCall(V, Args.begin(), Args.end(),
3494 Query(DL, TLI, DT, AT, CxtI), RecursionLimit);
3497 /// SimplifyInstruction - See if we can compute a simplified version of this
3498 /// instruction. If not, this returns null.
3499 Value *llvm::SimplifyInstruction(Instruction *I, const DataLayout *DL,
3500 const TargetLibraryInfo *TLI,
3501 const DominatorTree *DT,
3502 AssumptionTracker *AT) {
3505 switch (I->getOpcode()) {
3507 Result = ConstantFoldInstruction(I, DL, TLI);
3509 case Instruction::FAdd:
3510 Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
3511 I->getFastMathFlags(), DL, TLI, DT, AT, I);
3513 case Instruction::Add:
3514 Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
3515 cast<BinaryOperator>(I)->hasNoSignedWrap(),
3516 cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3517 DL, TLI, DT, AT, I);
3519 case Instruction::FSub:
3520 Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
3521 I->getFastMathFlags(), DL, TLI, DT, AT, I);
3523 case Instruction::Sub:
3524 Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
3525 cast<BinaryOperator>(I)->hasNoSignedWrap(),
3526 cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3527 DL, TLI, DT, AT, I);
3529 case Instruction::FMul:
3530 Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
3531 I->getFastMathFlags(), DL, TLI, DT, AT, I);
3533 case Instruction::Mul:
3534 Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1),
3535 DL, TLI, DT, AT, I);
3537 case Instruction::SDiv:
3538 Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1),
3539 DL, TLI, DT, AT, I);
3541 case Instruction::UDiv:
3542 Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1),
3543 DL, TLI, DT, AT, I);
3545 case Instruction::FDiv:
3546 Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
3547 DL, TLI, DT, AT, I);
3549 case Instruction::SRem:
3550 Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1),
3551 DL, TLI, DT, AT, I);
3553 case Instruction::URem:
3554 Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1),
3555 DL, TLI, DT, AT, I);
3557 case Instruction::FRem:
3558 Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
3559 DL, TLI, DT, AT, I);
3561 case Instruction::Shl:
3562 Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
3563 cast<BinaryOperator>(I)->hasNoSignedWrap(),
3564 cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3565 DL, TLI, DT, AT, I);
3567 case Instruction::LShr:
3568 Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
3569 cast<BinaryOperator>(I)->isExact(),
3570 DL, TLI, DT, AT, I);
3572 case Instruction::AShr:
3573 Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
3574 cast<BinaryOperator>(I)->isExact(),
3575 DL, TLI, DT, AT, I);
3577 case Instruction::And:
3578 Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1),
3579 DL, TLI, DT, AT, I);
3581 case Instruction::Or:
3582 Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
3585 case Instruction::Xor:
3586 Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1),
3587 DL, TLI, DT, AT, I);
3589 case Instruction::ICmp:
3590 Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
3591 I->getOperand(0), I->getOperand(1),
3592 DL, TLI, DT, AT, I);
3594 case Instruction::FCmp:
3595 Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(),
3596 I->getOperand(0), I->getOperand(1),
3597 DL, TLI, DT, AT, I);
3599 case Instruction::Select:
3600 Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
3601 I->getOperand(2), DL, TLI, DT, AT, I);
3603 case Instruction::GetElementPtr: {
3604 SmallVector<Value*, 8> Ops(I->op_begin(), I->op_end());
3605 Result = SimplifyGEPInst(Ops, DL, TLI, DT, AT, I);
3608 case Instruction::InsertValue: {
3609 InsertValueInst *IV = cast<InsertValueInst>(I);
3610 Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
3611 IV->getInsertedValueOperand(),
3612 IV->getIndices(), DL, TLI, DT, AT, I);
3615 case Instruction::PHI:
3616 Result = SimplifyPHINode(cast<PHINode>(I), Query (DL, TLI, DT, AT, I));
3618 case Instruction::Call: {
3619 CallSite CS(cast<CallInst>(I));
3620 Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
3621 DL, TLI, DT, AT, I);
3624 case Instruction::Trunc:
3625 Result = SimplifyTruncInst(I->getOperand(0), I->getType(), DL, TLI, DT,
3630 /// If called on unreachable code, the above logic may report that the
3631 /// instruction simplified to itself. Make life easier for users by
3632 /// detecting that case here, returning a safe value instead.
3633 return Result == I ? UndefValue::get(I->getType()) : Result;
3636 /// \brief Implementation of recursive simplification through an instructions
3639 /// This is the common implementation of the recursive simplification routines.
3640 /// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
3641 /// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
3642 /// instructions to process and attempt to simplify it using
3643 /// InstructionSimplify.
3645 /// This routine returns 'true' only when *it* simplifies something. The passed
3646 /// in simplified value does not count toward this.
3647 static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
3648 const DataLayout *DL,
3649 const TargetLibraryInfo *TLI,
3650 const DominatorTree *DT,
3651 AssumptionTracker *AT) {
3652 bool Simplified = false;
3653 SmallSetVector<Instruction *, 8> Worklist;
3655 // If we have an explicit value to collapse to, do that round of the
3656 // simplification loop by hand initially.
3658 for (User *U : I->users())
3660 Worklist.insert(cast<Instruction>(U));
3662 // Replace the instruction with its simplified value.
3663 I->replaceAllUsesWith(SimpleV);
3665 // Gracefully handle edge cases where the instruction is not wired into any
3668 I->eraseFromParent();
3673 // Note that we must test the size on each iteration, the worklist can grow.
3674 for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
3677 // See if this instruction simplifies.
3678 SimpleV = SimplifyInstruction(I, DL, TLI, DT, AT);
3684 // Stash away all the uses of the old instruction so we can check them for
3685 // recursive simplifications after a RAUW. This is cheaper than checking all
3686 // uses of To on the recursive step in most cases.
3687 for (User *U : I->users())
3688 Worklist.insert(cast<Instruction>(U));
3690 // Replace the instruction with its simplified value.
3691 I->replaceAllUsesWith(SimpleV);
3693 // Gracefully handle edge cases where the instruction is not wired into any
3696 I->eraseFromParent();
3701 bool llvm::recursivelySimplifyInstruction(Instruction *I,
3702 const DataLayout *DL,
3703 const TargetLibraryInfo *TLI,
3704 const DominatorTree *DT,
3705 AssumptionTracker *AT) {
3706 return replaceAndRecursivelySimplifyImpl(I, nullptr, DL, TLI, DT, AT);
3709 bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
3710 const DataLayout *DL,
3711 const TargetLibraryInfo *TLI,
3712 const DominatorTree *DT,
3713 AssumptionTracker *AT) {
3714 assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
3715 assert(SimpleV && "Must provide a simplified value.");
3716 return replaceAndRecursivelySimplifyImpl(I, SimpleV, DL, TLI, DT, AT);