blob: 9f260b21ca8b639d35d01af576876ea4d4d5281c [file] [log] [blame]
Chris Lattner965c7692008-06-02 01:18:21 +00001//===- ValueTracking.cpp - Walk computations to compute properties --------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains routines that help analyze properties that chains of
11// computations have.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/Analysis/ValueTracking.h"
James Molloy493e57d2015-10-26 14:10:46 +000016#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000017#include "llvm/ADT/SmallPtrSet.h"
Daniel Jasperaec2fa32016-12-19 08:22:17 +000018#include "llvm/Analysis/AssumptionCache.h"
Dan Gohman949ab782010-12-15 20:10:26 +000019#include "llvm/Analysis/InstructionSimplify.h"
Benjamin Kramerfd4777c2013-09-24 16:37:51 +000020#include "llvm/Analysis/MemoryBuiltins.h"
Artur Pilipenko31bcca42016-02-24 12:49:04 +000021#include "llvm/Analysis/Loads.h"
Adam Nemete2b885c2015-04-23 20:09:20 +000022#include "llvm/Analysis/LoopInfo.h"
Sanjay Patel54656ca2017-02-06 18:26:06 +000023#include "llvm/Analysis/OptimizationDiagnosticInfo.h"
David Majnemer3ee5f342016-04-13 06:55:52 +000024#include "llvm/Analysis/VectorUtils.h"
Nick Lewyckyec373542014-05-20 05:13:21 +000025#include "llvm/IR/CallSite.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000026#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/Constants.h"
28#include "llvm/IR/DataLayout.h"
Hal Finkel60db0582014-09-07 18:57:58 +000029#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000030#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000031#include "llvm/IR/GlobalAlias.h"
32#include "llvm/IR/GlobalVariable.h"
33#include "llvm/IR/Instructions.h"
34#include "llvm/IR/IntrinsicInst.h"
35#include "llvm/IR/LLVMContext.h"
36#include "llvm/IR/Metadata.h"
37#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000038#include "llvm/IR/PatternMatch.h"
Philip Reames5461d452015-04-23 17:36:48 +000039#include "llvm/IR/Statepoint.h"
Matt Arsenaultf1a7e622014-07-15 01:55:03 +000040#include "llvm/Support/Debug.h"
Chris Lattner965c7692008-06-02 01:18:21 +000041#include "llvm/Support/MathExtras.h"
Matthias Braun37e5d792016-01-28 06:29:33 +000042#include <algorithm>
43#include <array>
Chris Lattner64496902008-06-04 04:46:14 +000044#include <cstring>
Chris Lattner965c7692008-06-02 01:18:21 +000045using namespace llvm;
Duncan Sandsd3951082011-01-25 09:38:29 +000046using namespace llvm::PatternMatch;
47
48const unsigned MaxDepth = 6;
49
Philip Reames1c292272015-03-10 22:43:20 +000050// Controls the number of uses of the value searched for possible
51// dominating comparisons.
52static cl::opt<unsigned> DomConditionsMaxUses("dom-conditions-max-uses",
Igor Laevskycea9ede2015-09-29 14:57:52 +000053 cl::Hidden, cl::init(20));
Philip Reames1c292272015-03-10 22:43:20 +000054
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +000055// This optimization is known to cause performance regressions is some cases,
56// keep it under a temporary flag for now.
57static cl::opt<bool>
58DontImproveNonNegativePhiBits("dont-improve-non-negative-phi-bits",
59 cl::Hidden, cl::init(true));
60
Sanjay Patelaee84212014-11-04 16:27:42 +000061/// Returns the bitwidth of the given scalar or pointer type (if unknown returns
62/// 0). For vector types, returns the element type's bitwidth.
Mehdi Aminia28d91d2015-03-10 02:37:25 +000063static unsigned getBitWidth(Type *Ty, const DataLayout &DL) {
Duncan Sandsd3951082011-01-25 09:38:29 +000064 if (unsigned BitWidth = Ty->getScalarSizeInBits())
65 return BitWidth;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +000066
Mehdi Aminia28d91d2015-03-10 02:37:25 +000067 return DL.getPointerTypeSizeInBits(Ty);
Duncan Sandsd3951082011-01-25 09:38:29 +000068}
Chris Lattner965c7692008-06-02 01:18:21 +000069
Benjamin Kramercfd8d902014-09-12 08:56:53 +000070namespace {
Hal Finkel60db0582014-09-07 18:57:58 +000071// Simplifying using an assume can only be done in a particular control-flow
72// context (the context instruction provides that context). If an assume and
73// the context instruction are not in the same block then the DT helps in
74// figuring out if we can use it.
75struct Query {
Matthias Braunfeb81bc2016-01-15 22:22:04 +000076 const DataLayout &DL;
Daniel Jasperaec2fa32016-12-19 08:22:17 +000077 AssumptionCache *AC;
Hal Finkel60db0582014-09-07 18:57:58 +000078 const Instruction *CxtI;
79 const DominatorTree *DT;
Sanjay Patel54656ca2017-02-06 18:26:06 +000080 // Unlike the other analyses, this may be a nullptr because not all clients
81 // provide it currently.
82 OptimizationRemarkEmitter *ORE;
Hal Finkel60db0582014-09-07 18:57:58 +000083
Matthias Braun37e5d792016-01-28 06:29:33 +000084 /// Set of assumptions that should be excluded from further queries.
85 /// This is because of the potential for mutual recursion to cause
86 /// computeKnownBits to repeatedly visit the same assume intrinsic. The
87 /// classic case of this is assume(x = y), which will attempt to determine
88 /// bits in x from bits in y, which will attempt to determine bits in y from
89 /// bits in x, etc. Regarding the mutual recursion, computeKnownBits can call
90 /// isKnownNonZero, which calls computeKnownBits and ComputeSignBit and
91 /// isKnownToBeAPowerOfTwo (all of which can call computeKnownBits), and so
92 /// on.
Li Huang755f75f2016-10-15 19:00:04 +000093 std::array<const Value *, MaxDepth> Excluded;
Matthias Braun37e5d792016-01-28 06:29:33 +000094 unsigned NumExcluded;
95
Daniel Jasperaec2fa32016-12-19 08:22:17 +000096 Query(const DataLayout &DL, AssumptionCache *AC, const Instruction *CxtI,
Sanjay Patel54656ca2017-02-06 18:26:06 +000097 const DominatorTree *DT, OptimizationRemarkEmitter *ORE = nullptr)
98 : DL(DL), AC(AC), CxtI(CxtI), DT(DT), ORE(ORE), NumExcluded(0) {}
Hal Finkel60db0582014-09-07 18:57:58 +000099
100 Query(const Query &Q, const Value *NewExcl)
Sanjay Patel54656ca2017-02-06 18:26:06 +0000101 : DL(Q.DL), AC(Q.AC), CxtI(Q.CxtI), DT(Q.DT), ORE(Q.ORE),
102 NumExcluded(Q.NumExcluded) {
Matthias Braun37e5d792016-01-28 06:29:33 +0000103 Excluded = Q.Excluded;
104 Excluded[NumExcluded++] = NewExcl;
105 assert(NumExcluded <= Excluded.size());
106 }
107
108 bool isExcluded(const Value *Value) const {
109 if (NumExcluded == 0)
110 return false;
111 auto End = Excluded.begin() + NumExcluded;
112 return std::find(Excluded.begin(), End, Value) != End;
Hal Finkel60db0582014-09-07 18:57:58 +0000113 }
114};
Benjamin Kramercfd8d902014-09-12 08:56:53 +0000115} // end anonymous namespace
Hal Finkel60db0582014-09-07 18:57:58 +0000116
Sanjay Patel547e9752014-11-04 16:09:50 +0000117// Given the provided Value and, potentially, a context instruction, return
Hal Finkel60db0582014-09-07 18:57:58 +0000118// the preferred context instruction (if any).
119static const Instruction *safeCxtI(const Value *V, const Instruction *CxtI) {
120 // If we've been provided with a context instruction, then use that (provided
121 // it has been inserted).
122 if (CxtI && CxtI->getParent())
123 return CxtI;
124
125 // If the value is really an already-inserted instruction, then use that.
126 CxtI = dyn_cast<Instruction>(V);
127 if (CxtI && CxtI->getParent())
128 return CxtI;
129
130 return nullptr;
131}
132
Pete Cooper35b00d52016-08-13 01:05:32 +0000133static void computeKnownBits(const Value *V, APInt &KnownZero, APInt &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000134 unsigned Depth, const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000135
Pete Cooper35b00d52016-08-13 01:05:32 +0000136void llvm::computeKnownBits(const Value *V, APInt &KnownZero, APInt &KnownOne,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000137 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000138 AssumptionCache *AC, const Instruction *CxtI,
Sanjay Patel54656ca2017-02-06 18:26:06 +0000139 const DominatorTree *DT,
140 OptimizationRemarkEmitter *ORE) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000141 ::computeKnownBits(V, KnownZero, KnownOne, Depth,
Sanjay Patel54656ca2017-02-06 18:26:06 +0000142 Query(DL, AC, safeCxtI(V, CxtI), DT, ORE));
Hal Finkel60db0582014-09-07 18:57:58 +0000143}
144
Pete Cooper35b00d52016-08-13 01:05:32 +0000145bool llvm::haveNoCommonBitsSet(const Value *LHS, const Value *RHS,
146 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000147 AssumptionCache *AC, const Instruction *CxtI,
Jingyue Wuca321902015-05-14 23:53:19 +0000148 const DominatorTree *DT) {
149 assert(LHS->getType() == RHS->getType() &&
150 "LHS and RHS should have the same type");
151 assert(LHS->getType()->isIntOrIntVectorTy() &&
152 "LHS and RHS should be integers");
153 IntegerType *IT = cast<IntegerType>(LHS->getType()->getScalarType());
154 APInt LHSKnownZero(IT->getBitWidth(), 0), LHSKnownOne(IT->getBitWidth(), 0);
155 APInt RHSKnownZero(IT->getBitWidth(), 0), RHSKnownOne(IT->getBitWidth(), 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000156 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, DL, 0, AC, CxtI, DT);
157 computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, DL, 0, AC, CxtI, DT);
Jingyue Wuca321902015-05-14 23:53:19 +0000158 return (LHSKnownZero | RHSKnownZero).isAllOnesValue();
159}
160
Pete Cooper35b00d52016-08-13 01:05:32 +0000161static void ComputeSignBit(const Value *V, bool &KnownZero, bool &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000162 unsigned Depth, const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000163
Pete Cooper35b00d52016-08-13 01:05:32 +0000164void llvm::ComputeSignBit(const Value *V, bool &KnownZero, bool &KnownOne,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000165 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000166 AssumptionCache *AC, const Instruction *CxtI,
Hal Finkel60db0582014-09-07 18:57:58 +0000167 const DominatorTree *DT) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000168 ::ComputeSignBit(V, KnownZero, KnownOne, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000169 Query(DL, AC, safeCxtI(V, CxtI), DT));
Hal Finkel60db0582014-09-07 18:57:58 +0000170}
171
Pete Cooper35b00d52016-08-13 01:05:32 +0000172static bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000173 const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000174
Pete Cooper35b00d52016-08-13 01:05:32 +0000175bool llvm::isKnownToBeAPowerOfTwo(const Value *V, const DataLayout &DL,
176 bool OrZero,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000177 unsigned Depth, AssumptionCache *AC,
178 const Instruction *CxtI,
Hal Finkel60db0582014-09-07 18:57:58 +0000179 const DominatorTree *DT) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000180 return ::isKnownToBeAPowerOfTwo(V, OrZero, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000181 Query(DL, AC, safeCxtI(V, CxtI), DT));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000182}
183
Pete Cooper35b00d52016-08-13 01:05:32 +0000184static bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000185
Pete Cooper35b00d52016-08-13 01:05:32 +0000186bool llvm::isKnownNonZero(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000187 AssumptionCache *AC, const Instruction *CxtI,
188 const DominatorTree *DT) {
189 return ::isKnownNonZero(V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000190}
191
Pete Cooper35b00d52016-08-13 01:05:32 +0000192bool llvm::isKnownNonNegative(const Value *V, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000193 unsigned Depth,
194 AssumptionCache *AC, const Instruction *CxtI,
Jingyue Wu10fcea52015-08-20 18:27:04 +0000195 const DominatorTree *DT) {
196 bool NonNegative, Negative;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000197 ComputeSignBit(V, NonNegative, Negative, DL, Depth, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +0000198 return NonNegative;
199}
200
Pete Cooper35b00d52016-08-13 01:05:32 +0000201bool llvm::isKnownPositive(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000202 AssumptionCache *AC, const Instruction *CxtI,
203 const DominatorTree *DT) {
Philip Reames8f12eba2016-03-09 21:31:47 +0000204 if (auto *CI = dyn_cast<ConstantInt>(V))
205 return CI->getValue().isStrictlyPositive();
Sanjoy Das6082c1a2016-05-07 02:08:15 +0000206
Philip Reames8f12eba2016-03-09 21:31:47 +0000207 // TODO: We'd doing two recursive queries here. We should factor this such
208 // that only a single query is needed.
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000209 return isKnownNonNegative(V, DL, Depth, AC, CxtI, DT) &&
210 isKnownNonZero(V, DL, Depth, AC, CxtI, DT);
Philip Reames8f12eba2016-03-09 21:31:47 +0000211}
212
Pete Cooper35b00d52016-08-13 01:05:32 +0000213bool llvm::isKnownNegative(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000214 AssumptionCache *AC, const Instruction *CxtI,
215 const DominatorTree *DT) {
Nick Lewycky762f8a82016-04-21 00:53:14 +0000216 bool NonNegative, Negative;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000217 ComputeSignBit(V, NonNegative, Negative, DL, Depth, AC, CxtI, DT);
Nick Lewycky762f8a82016-04-21 00:53:14 +0000218 return Negative;
219}
220
Pete Cooper35b00d52016-08-13 01:05:32 +0000221static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q);
James Molloy1d88d6f2015-10-22 13:18:42 +0000222
Pete Cooper35b00d52016-08-13 01:05:32 +0000223bool llvm::isKnownNonEqual(const Value *V1, const Value *V2,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000224 const DataLayout &DL,
225 AssumptionCache *AC, const Instruction *CxtI,
Pete Cooper35b00d52016-08-13 01:05:32 +0000226 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000227 return ::isKnownNonEqual(V1, V2, Query(DL, AC,
228 safeCxtI(V1, safeCxtI(V2, CxtI)),
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000229 DT));
James Molloy1d88d6f2015-10-22 13:18:42 +0000230}
231
Pete Cooper35b00d52016-08-13 01:05:32 +0000232static bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000233 const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000234
Pete Cooper35b00d52016-08-13 01:05:32 +0000235bool llvm::MaskedValueIsZero(const Value *V, const APInt &Mask,
236 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000237 unsigned Depth, AssumptionCache *AC,
238 const Instruction *CxtI, const DominatorTree *DT) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000239 return ::MaskedValueIsZero(V, Mask, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000240 Query(DL, AC, safeCxtI(V, CxtI), DT));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000241}
242
Pete Cooper35b00d52016-08-13 01:05:32 +0000243static unsigned ComputeNumSignBits(const Value *V, unsigned Depth,
244 const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000245
Pete Cooper35b00d52016-08-13 01:05:32 +0000246unsigned llvm::ComputeNumSignBits(const Value *V, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000247 unsigned Depth, AssumptionCache *AC,
248 const Instruction *CxtI,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000249 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000250 return ::ComputeNumSignBits(V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT));
Hal Finkel60db0582014-09-07 18:57:58 +0000251}
252
Pete Cooper35b00d52016-08-13 01:05:32 +0000253static void computeKnownBitsAddSub(bool Add, const Value *Op0, const Value *Op1,
254 bool NSW,
Jay Foada0653a32014-05-14 21:14:37 +0000255 APInt &KnownZero, APInt &KnownOne,
256 APInt &KnownZero2, APInt &KnownOne2,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000257 unsigned Depth, const Query &Q) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000258 unsigned BitWidth = KnownZero.getBitWidth();
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000259
David Majnemer97ddca32014-08-22 00:40:43 +0000260 // If an initial sequence of bits in the result is not needed, the
261 // corresponding bits in the operands are not needed.
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000262 APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000263 computeKnownBits(Op0, LHSKnownZero, LHSKnownOne, Depth + 1, Q);
264 computeKnownBits(Op1, KnownZero2, KnownOne2, Depth + 1, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000265
David Majnemer97ddca32014-08-22 00:40:43 +0000266 // Carry in a 1 for a subtract, rather than a 0.
267 APInt CarryIn(BitWidth, 0);
268 if (!Add) {
269 // Sum = LHS + ~RHS + 1
270 std::swap(KnownZero2, KnownOne2);
271 CarryIn.setBit(0);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000272 }
273
David Majnemer97ddca32014-08-22 00:40:43 +0000274 APInt PossibleSumZero = ~LHSKnownZero + ~KnownZero2 + CarryIn;
275 APInt PossibleSumOne = LHSKnownOne + KnownOne2 + CarryIn;
276
277 // Compute known bits of the carry.
278 APInt CarryKnownZero = ~(PossibleSumZero ^ LHSKnownZero ^ KnownZero2);
279 APInt CarryKnownOne = PossibleSumOne ^ LHSKnownOne ^ KnownOne2;
280
281 // Compute set of known bits (where all three relevant bits are known).
282 APInt LHSKnown = LHSKnownZero | LHSKnownOne;
283 APInt RHSKnown = KnownZero2 | KnownOne2;
284 APInt CarryKnown = CarryKnownZero | CarryKnownOne;
285 APInt Known = LHSKnown & RHSKnown & CarryKnown;
286
287 assert((PossibleSumZero & Known) == (PossibleSumOne & Known) &&
288 "known bits of sum differ");
289
290 // Compute known bits of the result.
291 KnownZero = ~PossibleSumOne & Known;
292 KnownOne = PossibleSumOne & Known;
293
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000294 // Are we still trying to solve for the sign bit?
David Majnemer97ddca32014-08-22 00:40:43 +0000295 if (!Known.isNegative()) {
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000296 if (NSW) {
David Majnemer97ddca32014-08-22 00:40:43 +0000297 // Adding two non-negative numbers, or subtracting a negative number from
298 // a non-negative one, can't wrap into negative.
299 if (LHSKnownZero.isNegative() && KnownZero2.isNegative())
Craig Topper3eb0d802017-03-18 04:01:29 +0000300 KnownZero.setSignBit();
David Majnemer97ddca32014-08-22 00:40:43 +0000301 // Adding two negative numbers, or subtracting a non-negative number from
302 // a negative one, can't wrap into non-negative.
303 else if (LHSKnownOne.isNegative() && KnownOne2.isNegative())
Craig Topper3eb0d802017-03-18 04:01:29 +0000304 KnownOne.setSignBit();
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000305 }
306 }
307}
308
Pete Cooper35b00d52016-08-13 01:05:32 +0000309static void computeKnownBitsMul(const Value *Op0, const Value *Op1, bool NSW,
Jay Foada0653a32014-05-14 21:14:37 +0000310 APInt &KnownZero, APInt &KnownOne,
311 APInt &KnownZero2, APInt &KnownOne2,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000312 unsigned Depth, const Query &Q) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000313 unsigned BitWidth = KnownZero.getBitWidth();
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000314 computeKnownBits(Op1, KnownZero, KnownOne, Depth + 1, Q);
315 computeKnownBits(Op0, KnownZero2, KnownOne2, Depth + 1, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000316
317 bool isKnownNegative = false;
318 bool isKnownNonNegative = false;
319 // If the multiplication is known not to overflow, compute the sign bit.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000320 if (NSW) {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000321 if (Op0 == Op1) {
322 // The product of a number with itself is non-negative.
323 isKnownNonNegative = true;
324 } else {
325 bool isKnownNonNegativeOp1 = KnownZero.isNegative();
326 bool isKnownNonNegativeOp0 = KnownZero2.isNegative();
327 bool isKnownNegativeOp1 = KnownOne.isNegative();
328 bool isKnownNegativeOp0 = KnownOne2.isNegative();
329 // The product of two numbers with the same sign is non-negative.
330 isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
331 (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
332 // The product of a negative number and a non-negative number is either
333 // negative or zero.
334 if (!isKnownNonNegative)
335 isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000336 isKnownNonZero(Op0, Depth, Q)) ||
Nick Lewyckyfa306072012-03-18 23:28:48 +0000337 (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000338 isKnownNonZero(Op1, Depth, Q));
Nick Lewyckyfa306072012-03-18 23:28:48 +0000339 }
340 }
341
342 // If low bits are zero in either operand, output low known-0 bits.
Sanjay Patel5dd66c32015-09-17 20:51:50 +0000343 // Also compute a conservative estimate for high known-0 bits.
Nick Lewyckyfa306072012-03-18 23:28:48 +0000344 // More trickiness is possible, but this is sufficient for the
345 // interesting case of alignment computation.
346 KnownOne.clearAllBits();
347 unsigned TrailZ = KnownZero.countTrailingOnes() +
348 KnownZero2.countTrailingOnes();
349 unsigned LeadZ = std::max(KnownZero.countLeadingOnes() +
350 KnownZero2.countLeadingOnes(),
351 BitWidth) - BitWidth;
352
353 TrailZ = std::min(TrailZ, BitWidth);
354 LeadZ = std::min(LeadZ, BitWidth);
Craig Topperd73c6b42017-03-23 07:06:39 +0000355 KnownZero.clearAllBits();
356 KnownZero.setLowBits(TrailZ);
357 KnownZero.setHighBits(LeadZ);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000358
359 // Only make use of no-wrap flags if we failed to compute the sign bit
360 // directly. This matters if the multiplication always overflows, in
361 // which case we prefer to follow the result of the direct computation,
362 // though as the program is invoking undefined behaviour we can choose
363 // whatever we like here.
364 if (isKnownNonNegative && !KnownOne.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +0000365 KnownZero.setSignBit();
Nick Lewyckyfa306072012-03-18 23:28:48 +0000366 else if (isKnownNegative && !KnownZero.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +0000367 KnownOne.setSignBit();
Nick Lewyckyfa306072012-03-18 23:28:48 +0000368}
369
Jingyue Wu37fcb592014-06-19 16:50:16 +0000370void llvm::computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000371 APInt &KnownZero,
372 APInt &KnownOne) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000373 unsigned BitWidth = KnownZero.getBitWidth();
Rafael Espindola53190532012-03-30 15:52:11 +0000374 unsigned NumRanges = Ranges.getNumOperands() / 2;
375 assert(NumRanges >= 1);
376
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000377 KnownZero.setAllBits();
378 KnownOne.setAllBits();
379
Rafael Espindola53190532012-03-30 15:52:11 +0000380 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000381 ConstantInt *Lower =
382 mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 0));
383 ConstantInt *Upper =
384 mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 1));
Rafael Espindola53190532012-03-30 15:52:11 +0000385 ConstantRange Range(Lower->getValue(), Upper->getValue());
Rafael Espindola53190532012-03-30 15:52:11 +0000386
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000387 // The first CommonPrefixBits of all values in Range are equal.
388 unsigned CommonPrefixBits =
389 (Range.getUnsignedMax() ^ Range.getUnsignedMin()).countLeadingZeros();
390
391 APInt Mask = APInt::getHighBitsSet(BitWidth, CommonPrefixBits);
392 KnownOne &= Range.getUnsignedMax() & Mask;
393 KnownZero &= ~Range.getUnsignedMax() & Mask;
394 }
Rafael Espindola53190532012-03-30 15:52:11 +0000395}
Jay Foad5a29c362014-05-15 12:12:55 +0000396
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000397static bool isEphemeralValueOf(const Instruction *I, const Value *E) {
Hal Finkel60db0582014-09-07 18:57:58 +0000398 SmallVector<const Value *, 16> WorkSet(1, I);
399 SmallPtrSet<const Value *, 32> Visited;
400 SmallPtrSet<const Value *, 16> EphValues;
401
Hal Finkelf2199b22015-10-23 20:37:08 +0000402 // The instruction defining an assumption's condition itself is always
403 // considered ephemeral to that assumption (even if it has other
404 // non-ephemeral users). See r246696's test case for an example.
David Majnemer0a16c222016-08-11 21:15:00 +0000405 if (is_contained(I->operands(), E))
Hal Finkelf2199b22015-10-23 20:37:08 +0000406 return true;
407
Hal Finkel60db0582014-09-07 18:57:58 +0000408 while (!WorkSet.empty()) {
409 const Value *V = WorkSet.pop_back_val();
David Blaikie70573dc2014-11-19 07:49:26 +0000410 if (!Visited.insert(V).second)
Hal Finkel60db0582014-09-07 18:57:58 +0000411 continue;
412
413 // If all uses of this value are ephemeral, then so is this value.
David Majnemer0a16c222016-08-11 21:15:00 +0000414 if (all_of(V->users(), [&](const User *U) { return EphValues.count(U); })) {
Hal Finkel60db0582014-09-07 18:57:58 +0000415 if (V == E)
416 return true;
417
418 EphValues.insert(V);
419 if (const User *U = dyn_cast<User>(V))
420 for (User::const_op_iterator J = U->op_begin(), JE = U->op_end();
421 J != JE; ++J) {
422 if (isSafeToSpeculativelyExecute(*J))
423 WorkSet.push_back(*J);
424 }
425 }
426 }
427
428 return false;
429}
430
431// Is this an intrinsic that cannot be speculated but also cannot trap?
432static bool isAssumeLikeIntrinsic(const Instruction *I) {
433 if (const CallInst *CI = dyn_cast<CallInst>(I))
434 if (Function *F = CI->getCalledFunction())
435 switch (F->getIntrinsicID()) {
436 default: break;
437 // FIXME: This list is repeated from NoTTI::getIntrinsicCost.
438 case Intrinsic::assume:
439 case Intrinsic::dbg_declare:
440 case Intrinsic::dbg_value:
441 case Intrinsic::invariant_start:
442 case Intrinsic::invariant_end:
443 case Intrinsic::lifetime_start:
444 case Intrinsic::lifetime_end:
445 case Intrinsic::objectsize:
446 case Intrinsic::ptr_annotation:
447 case Intrinsic::var_annotation:
448 return true;
449 }
450
451 return false;
452}
453
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000454bool llvm::isValidAssumeForContext(const Instruction *Inv,
455 const Instruction *CxtI,
456 const DominatorTree *DT) {
Hal Finkel60db0582014-09-07 18:57:58 +0000457
458 // There are two restrictions on the use of an assume:
459 // 1. The assume must dominate the context (or the control flow must
460 // reach the assume whenever it reaches the context).
461 // 2. The context must not be in the assume's set of ephemeral values
462 // (otherwise we will use the assume to prove that the condition
463 // feeding the assume is trivially true, thus causing the removal of
464 // the assume).
465
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000466 if (DT) {
Pete Cooper54a02552016-08-12 01:00:15 +0000467 if (DT->dominates(Inv, CxtI))
Hal Finkel60db0582014-09-07 18:57:58 +0000468 return true;
Pete Cooper54a02552016-08-12 01:00:15 +0000469 } else if (Inv->getParent() == CxtI->getParent()->getSinglePredecessor()) {
470 // We don't have a DT, but this trivially dominates.
471 return true;
Hal Finkel60db0582014-09-07 18:57:58 +0000472 }
473
Pete Cooper54a02552016-08-12 01:00:15 +0000474 // With or without a DT, the only remaining case we will check is if the
475 // instructions are in the same BB. Give up if that is not the case.
476 if (Inv->getParent() != CxtI->getParent())
477 return false;
478
479 // If we have a dom tree, then we now know that the assume doens't dominate
480 // the other instruction. If we don't have a dom tree then we can check if
481 // the assume is first in the BB.
482 if (!DT) {
Hal Finkel60db0582014-09-07 18:57:58 +0000483 // Search forward from the assume until we reach the context (or the end
484 // of the block); the common case is that the assume will come first.
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000485 for (auto I = std::next(BasicBlock::const_iterator(Inv)),
Hal Finkel60db0582014-09-07 18:57:58 +0000486 IE = Inv->getParent()->end(); I != IE; ++I)
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000487 if (&*I == CxtI)
Hal Finkel60db0582014-09-07 18:57:58 +0000488 return true;
Hal Finkel60db0582014-09-07 18:57:58 +0000489 }
490
Pete Cooper54a02552016-08-12 01:00:15 +0000491 // The context comes first, but they're both in the same block. Make sure
492 // there is nothing in between that might interrupt the control flow.
493 for (BasicBlock::const_iterator I =
494 std::next(BasicBlock::const_iterator(CxtI)), IE(Inv);
495 I != IE; ++I)
496 if (!isSafeToSpeculativelyExecute(&*I) && !isAssumeLikeIntrinsic(&*I))
497 return false;
498
499 return !isEphemeralValueOf(Inv, CxtI);
Hal Finkel60db0582014-09-07 18:57:58 +0000500}
501
Pete Cooper35b00d52016-08-13 01:05:32 +0000502static void computeKnownBitsFromAssume(const Value *V, APInt &KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000503 APInt &KnownOne, unsigned Depth,
504 const Query &Q) {
Hal Finkel60db0582014-09-07 18:57:58 +0000505 // Use of assumptions is context-sensitive. If we don't have a context, we
506 // cannot use them!
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000507 if (!Q.AC || !Q.CxtI)
Hal Finkel60db0582014-09-07 18:57:58 +0000508 return;
509
510 unsigned BitWidth = KnownZero.getBitWidth();
511
Hal Finkel8a9a7832017-01-11 13:24:24 +0000512 // Note that the patterns below need to be kept in sync with the code
513 // in AssumptionCache::updateAffectedValues.
514
515 for (auto &AssumeVH : Q.AC->assumptionsFor(V)) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000516 if (!AssumeVH)
Chandler Carruth66b31302015-01-04 12:03:27 +0000517 continue;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000518 CallInst *I = cast<CallInst>(AssumeVH);
519 assert(I->getParent()->getParent() == Q.CxtI->getParent()->getParent() &&
520 "Got assumption for the wrong function!");
521 if (Q.isExcluded(I))
Hal Finkel60db0582014-09-07 18:57:58 +0000522 continue;
523
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000524 // Warning: This loop can end up being somewhat performance sensetive.
525 // We're running this loop for once for each value queried resulting in a
526 // runtime of ~O(#assumes * #values).
Philip Reames00d3b272014-11-24 23:44:28 +0000527
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000528 assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
529 "must be an assume intrinsic");
530
531 Value *Arg = I->getArgOperand(0);
532
533 if (Arg == V && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000534 assert(BitWidth == 1 && "assume operand is not i1?");
535 KnownZero.clearAllBits();
536 KnownOne.setAllBits();
537 return;
538 }
Sanjay Patel96669962017-01-17 18:15:49 +0000539 if (match(Arg, m_Not(m_Specific(V))) &&
540 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
541 assert(BitWidth == 1 && "assume operand is not i1?");
542 KnownZero.setAllBits();
543 KnownOne.clearAllBits();
544 return;
545 }
Hal Finkel60db0582014-09-07 18:57:58 +0000546
David Majnemer9b609752014-12-12 23:59:29 +0000547 // The remaining tests are all recursive, so bail out if we hit the limit.
548 if (Depth == MaxDepth)
549 continue;
550
Hal Finkel60db0582014-09-07 18:57:58 +0000551 Value *A, *B;
552 auto m_V = m_CombineOr(m_Specific(V),
553 m_CombineOr(m_PtrToInt(m_Specific(V)),
554 m_BitCast(m_Specific(V))));
555
556 CmpInst::Predicate Pred;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000557 ConstantInt *C;
Hal Finkel60db0582014-09-07 18:57:58 +0000558 // assume(v = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000559 if (match(Arg, m_c_ICmp(Pred, m_V, m_Value(A))) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000560 Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000561 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000562 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000563 KnownZero |= RHSKnownZero;
564 KnownOne |= RHSKnownOne;
565 // assume(v & b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000566 } else if (match(Arg,
567 m_c_ICmp(Pred, m_c_And(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000568 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000569 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000570 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000571 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000572 APInt MaskKnownZero(BitWidth, 0), MaskKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000573 computeKnownBits(B, MaskKnownZero, MaskKnownOne, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000574
575 // For those bits in the mask that are known to be one, we can propagate
576 // known bits from the RHS to V.
577 KnownZero |= RHSKnownZero & MaskKnownOne;
578 KnownOne |= RHSKnownOne & MaskKnownOne;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000579 // assume(~(v & b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000580 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_And(m_V, m_Value(B))),
581 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000582 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000583 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000584 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000585 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000586 APInt MaskKnownZero(BitWidth, 0), MaskKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000587 computeKnownBits(B, MaskKnownZero, MaskKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000588
589 // For those bits in the mask that are known to be one, we can propagate
590 // inverted known bits from the RHS to V.
591 KnownZero |= RHSKnownOne & MaskKnownOne;
592 KnownOne |= RHSKnownZero & MaskKnownOne;
593 // assume(v | b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000594 } else if (match(Arg,
595 m_c_ICmp(Pred, m_c_Or(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000596 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000597 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000598 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000599 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000600 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000601 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000602
603 // For those bits in B that are known to be zero, we can propagate known
604 // bits from the RHS to V.
605 KnownZero |= RHSKnownZero & BKnownZero;
606 KnownOne |= RHSKnownOne & BKnownZero;
607 // assume(~(v | b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000608 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Or(m_V, m_Value(B))),
609 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000610 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000611 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000612 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000613 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000614 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000615 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000616
617 // For those bits in B that are known to be zero, we can propagate
618 // inverted known bits from the RHS to V.
619 KnownZero |= RHSKnownOne & BKnownZero;
620 KnownOne |= RHSKnownZero & BKnownZero;
621 // assume(v ^ b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000622 } else if (match(Arg,
623 m_c_ICmp(Pred, m_c_Xor(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000624 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000625 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000626 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000627 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000628 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000629 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000630
631 // For those bits in B that are known to be zero, we can propagate known
632 // bits from the RHS to V. For those bits in B that are known to be one,
633 // we can propagate inverted known bits from the RHS to V.
634 KnownZero |= RHSKnownZero & BKnownZero;
635 KnownOne |= RHSKnownOne & BKnownZero;
636 KnownZero |= RHSKnownOne & BKnownOne;
637 KnownOne |= RHSKnownZero & BKnownOne;
638 // assume(~(v ^ b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000639 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Xor(m_V, m_Value(B))),
640 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000641 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000642 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000643 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000644 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000645 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000646 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000647
648 // For those bits in B that are known to be zero, we can propagate
649 // inverted known bits from the RHS to V. For those bits in B that are
650 // known to be one, we can propagate known bits from the RHS to V.
651 KnownZero |= RHSKnownOne & BKnownZero;
652 KnownOne |= RHSKnownZero & BKnownZero;
653 KnownZero |= RHSKnownZero & BKnownOne;
654 KnownOne |= RHSKnownOne & BKnownOne;
655 // assume(v << c = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000656 } else if (match(Arg, m_c_ICmp(Pred, m_Shl(m_V, m_ConstantInt(C)),
657 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000658 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000659 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000660 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000661 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000662 // For those bits in RHS that are known, we can propagate them to known
663 // bits in V shifted to the right by C.
664 KnownZero |= RHSKnownZero.lshr(C->getZExtValue());
665 KnownOne |= RHSKnownOne.lshr(C->getZExtValue());
666 // assume(~(v << c) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000667 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_Shl(m_V, m_ConstantInt(C))),
668 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000669 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000670 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000671 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000672 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000673 // For those bits in RHS that are known, we can propagate them inverted
674 // to known bits in V shifted to the right by C.
675 KnownZero |= RHSKnownOne.lshr(C->getZExtValue());
676 KnownOne |= RHSKnownZero.lshr(C->getZExtValue());
677 // assume(v >> c = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000678 } else if (match(Arg,
679 m_c_ICmp(Pred, m_CombineOr(m_LShr(m_V, m_ConstantInt(C)),
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000680 m_AShr(m_V, m_ConstantInt(C))),
681 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000682 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000683 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000684 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000685 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000686 // For those bits in RHS that are known, we can propagate them to known
687 // bits in V shifted to the right by C.
688 KnownZero |= RHSKnownZero << C->getZExtValue();
689 KnownOne |= RHSKnownOne << C->getZExtValue();
690 // assume(~(v >> c) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000691 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_CombineOr(
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000692 m_LShr(m_V, m_ConstantInt(C)),
693 m_AShr(m_V, m_ConstantInt(C)))),
Philip Reames00d3b272014-11-24 23:44:28 +0000694 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000695 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000696 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000697 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000698 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000699 // For those bits in RHS that are known, we can propagate them inverted
700 // to known bits in V shifted to the right by C.
701 KnownZero |= RHSKnownOne << C->getZExtValue();
702 KnownOne |= RHSKnownZero << C->getZExtValue();
703 // assume(v >=_s c) where c is non-negative
Philip Reames00d3b272014-11-24 23:44:28 +0000704 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000705 Pred == ICmpInst::ICMP_SGE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000706 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000707 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000708 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000709
710 if (RHSKnownZero.isNegative()) {
711 // We know that the sign bit is zero.
Craig Topper3eb0d802017-03-18 04:01:29 +0000712 KnownZero.setSignBit();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000713 }
714 // assume(v >_s c) where c is at least -1.
Philip Reames00d3b272014-11-24 23:44:28 +0000715 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000716 Pred == ICmpInst::ICMP_SGT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000717 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000718 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000719 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000720
721 if (RHSKnownOne.isAllOnesValue() || RHSKnownZero.isNegative()) {
722 // We know that the sign bit is zero.
Craig Topper3eb0d802017-03-18 04:01:29 +0000723 KnownZero.setSignBit();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000724 }
725 // assume(v <=_s c) where c is negative
Philip Reames00d3b272014-11-24 23:44:28 +0000726 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000727 Pred == ICmpInst::ICMP_SLE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000728 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000729 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000730 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000731
732 if (RHSKnownOne.isNegative()) {
733 // We know that the sign bit is one.
Craig Topper3eb0d802017-03-18 04:01:29 +0000734 KnownOne.setSignBit();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000735 }
736 // assume(v <_s c) where c is non-positive
Philip Reames00d3b272014-11-24 23:44:28 +0000737 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000738 Pred == ICmpInst::ICMP_SLT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000739 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000740 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000741 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000742
743 if (RHSKnownZero.isAllOnesValue() || RHSKnownOne.isNegative()) {
744 // We know that the sign bit is one.
Craig Topper3eb0d802017-03-18 04:01:29 +0000745 KnownOne.setSignBit();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000746 }
747 // assume(v <=_u c)
Philip Reames00d3b272014-11-24 23:44:28 +0000748 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000749 Pred == ICmpInst::ICMP_ULE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000750 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000751 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000752 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000753
754 // Whatever high bits in c are zero are known to be zero.
Craig Topper57d8ca72017-03-22 06:19:37 +0000755 KnownZero.setHighBits(RHSKnownZero.countLeadingOnes());
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000756 // assume(v <_u c)
Philip Reames00d3b272014-11-24 23:44:28 +0000757 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000758 Pred == ICmpInst::ICMP_ULT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000759 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000760 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000761 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000762
763 // Whatever high bits in c are zero are known to be zero (if c is a power
764 // of 2, then one more).
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000765 if (isKnownToBeAPowerOfTwo(A, false, Depth + 1, Query(Q, I)))
Craig Topper57d8ca72017-03-22 06:19:37 +0000766 KnownZero.setHighBits(RHSKnownZero.countLeadingOnes()+1);
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000767 else
Craig Topper57d8ca72017-03-22 06:19:37 +0000768 KnownZero.setHighBits(RHSKnownZero.countLeadingOnes());
Hal Finkel60db0582014-09-07 18:57:58 +0000769 }
770 }
Sanjay Patel25f6d712017-02-01 15:41:32 +0000771
772 // If assumptions conflict with each other or previous known bits, then we
Sanjay Patel54656ca2017-02-06 18:26:06 +0000773 // have a logical fallacy. It's possible that the assumption is not reachable,
774 // so this isn't a real bug. On the other hand, the program may have undefined
775 // behavior, or we might have a bug in the compiler. We can't assert/crash, so
776 // clear out the known bits, try to warn the user, and hope for the best.
Sanjay Patel25f6d712017-02-01 15:41:32 +0000777 if ((KnownZero & KnownOne) != 0) {
778 KnownZero.clearAllBits();
779 KnownOne.clearAllBits();
Sanjay Patel54656ca2017-02-06 18:26:06 +0000780
781 if (Q.ORE) {
782 auto *CxtI = const_cast<Instruction *>(Q.CxtI);
783 OptimizationRemarkAnalysis ORA("value-tracking", "BadAssumption", CxtI);
784 Q.ORE->emit(ORA << "Detected conflicting code assumptions. Program may "
785 "have undefined behavior, or compiler may have "
786 "internal error.");
787 }
Sanjay Patel25f6d712017-02-01 15:41:32 +0000788 }
Hal Finkel60db0582014-09-07 18:57:58 +0000789}
790
Hal Finkelf2199b22015-10-23 20:37:08 +0000791// Compute known bits from a shift operator, including those with a
792// non-constant shift amount. KnownZero and KnownOne are the outputs of this
793// function. KnownZero2 and KnownOne2 are pre-allocated temporaries with the
794// same bit width as KnownZero and KnownOne. KZF and KOF are operator-specific
795// functors that, given the known-zero or known-one bits respectively, and a
796// shift amount, compute the implied known-zero or known-one bits of the shift
797// operator's result respectively for that shift amount. The results from calling
798// KZF and KOF are conservatively combined for all permitted shift amounts.
David Majnemer54690dc2016-08-23 20:52:00 +0000799static void computeKnownBitsFromShiftOperator(
800 const Operator *I, APInt &KnownZero, APInt &KnownOne, APInt &KnownZero2,
801 APInt &KnownOne2, unsigned Depth, const Query &Q,
802 function_ref<APInt(const APInt &, unsigned)> KZF,
803 function_ref<APInt(const APInt &, unsigned)> KOF) {
Hal Finkelf2199b22015-10-23 20:37:08 +0000804 unsigned BitWidth = KnownZero.getBitWidth();
805
806 if (auto *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
807 unsigned ShiftAmt = SA->getLimitedValue(BitWidth-1);
808
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000809 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000810 KnownZero = KZF(KnownZero, ShiftAmt);
811 KnownOne = KOF(KnownOne, ShiftAmt);
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +0000812 // If there is conflict between KnownZero and KnownOne, this must be an
813 // overflowing left shift, so the shift result is undefined. Clear KnownZero
814 // and KnownOne bits so that other code could propagate this undef.
815 if ((KnownZero & KnownOne) != 0) {
816 KnownZero.clearAllBits();
817 KnownOne.clearAllBits();
818 }
819
Hal Finkelf2199b22015-10-23 20:37:08 +0000820 return;
821 }
822
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000823 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000824
Oliver Stannard06204112017-03-14 10:13:17 +0000825 // If the shift amount could be greater than or equal to the bit-width of the LHS, the
826 // value could be undef, so we don't know anything about it.
827 if ((~KnownZero).uge(BitWidth)) {
828 KnownZero.clearAllBits();
829 KnownOne.clearAllBits();
830 return;
831 }
832
Hal Finkelf2199b22015-10-23 20:37:08 +0000833 // Note: We cannot use KnownZero.getLimitedValue() here, because if
834 // BitWidth > 64 and any upper bits are known, we'll end up returning the
835 // limit value (which implies all bits are known).
836 uint64_t ShiftAmtKZ = KnownZero.zextOrTrunc(64).getZExtValue();
837 uint64_t ShiftAmtKO = KnownOne.zextOrTrunc(64).getZExtValue();
838
839 // It would be more-clearly correct to use the two temporaries for this
840 // calculation. Reusing the APInts here to prevent unnecessary allocations.
Richard Trieu7a083812016-02-18 22:09:30 +0000841 KnownZero.clearAllBits();
842 KnownOne.clearAllBits();
Hal Finkelf2199b22015-10-23 20:37:08 +0000843
James Molloy493e57d2015-10-26 14:10:46 +0000844 // If we know the shifter operand is nonzero, we can sometimes infer more
845 // known bits. However this is expensive to compute, so be lazy about it and
846 // only compute it when absolutely necessary.
847 Optional<bool> ShifterOperandIsNonZero;
848
Hal Finkelf2199b22015-10-23 20:37:08 +0000849 // Early exit if we can't constrain any well-defined shift amount.
James Molloy493e57d2015-10-26 14:10:46 +0000850 if (!(ShiftAmtKZ & (BitWidth - 1)) && !(ShiftAmtKO & (BitWidth - 1))) {
851 ShifterOperandIsNonZero =
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000852 isKnownNonZero(I->getOperand(1), Depth + 1, Q);
James Molloy493e57d2015-10-26 14:10:46 +0000853 if (!*ShifterOperandIsNonZero)
854 return;
855 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000856
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000857 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000858
859 KnownZero = KnownOne = APInt::getAllOnesValue(BitWidth);
860 for (unsigned ShiftAmt = 0; ShiftAmt < BitWidth; ++ShiftAmt) {
861 // Combine the shifted known input bits only for those shift amounts
862 // compatible with its known constraints.
863 if ((ShiftAmt & ~ShiftAmtKZ) != ShiftAmt)
864 continue;
865 if ((ShiftAmt | ShiftAmtKO) != ShiftAmt)
866 continue;
James Molloy493e57d2015-10-26 14:10:46 +0000867 // If we know the shifter is nonzero, we may be able to infer more known
868 // bits. This check is sunk down as far as possible to avoid the expensive
869 // call to isKnownNonZero if the cheaper checks above fail.
870 if (ShiftAmt == 0) {
871 if (!ShifterOperandIsNonZero.hasValue())
872 ShifterOperandIsNonZero =
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000873 isKnownNonZero(I->getOperand(1), Depth + 1, Q);
James Molloy493e57d2015-10-26 14:10:46 +0000874 if (*ShifterOperandIsNonZero)
875 continue;
876 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000877
878 KnownZero &= KZF(KnownZero2, ShiftAmt);
879 KnownOne &= KOF(KnownOne2, ShiftAmt);
880 }
881
882 // If there are no compatible shift amounts, then we've proven that the shift
883 // amount must be >= the BitWidth, and the result is undefined. We could
884 // return anything we'd like, but we need to make sure the sets of known bits
885 // stay disjoint (it should be better for some other code to actually
886 // propagate the undef than to pick a value here using known bits).
Richard Trieu7a083812016-02-18 22:09:30 +0000887 if ((KnownZero & KnownOne) != 0) {
888 KnownZero.clearAllBits();
889 KnownOne.clearAllBits();
890 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000891}
892
Pete Cooper35b00d52016-08-13 01:05:32 +0000893static void computeKnownBitsFromOperator(const Operator *I, APInt &KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000894 APInt &KnownOne, unsigned Depth,
895 const Query &Q) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000896 unsigned BitWidth = KnownZero.getBitWidth();
897
Chris Lattner965c7692008-06-02 01:18:21 +0000898 APInt KnownZero2(KnownZero), KnownOne2(KnownOne);
Dan Gohman80ca01c2009-07-17 20:47:02 +0000899 switch (I->getOpcode()) {
Chris Lattner965c7692008-06-02 01:18:21 +0000900 default: break;
Rafael Espindola53190532012-03-30 15:52:11 +0000901 case Instruction::Load:
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000902 if (MDNode *MD = cast<LoadInst>(I)->getMetadata(LLVMContext::MD_range))
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000903 computeKnownBitsFromRangeMetadata(*MD, KnownZero, KnownOne);
Jay Foad5a29c362014-05-15 12:12:55 +0000904 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000905 case Instruction::And: {
906 // If either the LHS or the RHS are Zero, the result is zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000907 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
908 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000909
Chris Lattner965c7692008-06-02 01:18:21 +0000910 // Output known-1 bits are only known if set in both the LHS & RHS.
911 KnownOne &= KnownOne2;
912 // Output known-0 are known to be clear if zero in either the LHS | RHS.
913 KnownZero |= KnownZero2;
Philip Reames2d858742015-11-10 18:46:14 +0000914
915 // and(x, add (x, -1)) is a common idiom that always clears the low bit;
916 // here we handle the more general case of adding any odd number by
917 // matching the form add(x, add(x, y)) where y is odd.
918 // TODO: This could be generalized to clearing any bit set in y where the
919 // following bit is known to be unset in y.
920 Value *Y = nullptr;
921 if (match(I->getOperand(0), m_Add(m_Specific(I->getOperand(1)),
922 m_Value(Y))) ||
923 match(I->getOperand(1), m_Add(m_Specific(I->getOperand(0)),
924 m_Value(Y)))) {
925 APInt KnownZero3(BitWidth, 0), KnownOne3(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000926 computeKnownBits(Y, KnownZero3, KnownOne3, Depth + 1, Q);
Philip Reames2d858742015-11-10 18:46:14 +0000927 if (KnownOne3.countTrailingOnes() > 0)
Craig Topper57d8ca72017-03-22 06:19:37 +0000928 KnownZero.setBit(0);
Philip Reames2d858742015-11-10 18:46:14 +0000929 }
Jay Foad5a29c362014-05-15 12:12:55 +0000930 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000931 }
932 case Instruction::Or: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000933 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
934 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000935
Chris Lattner965c7692008-06-02 01:18:21 +0000936 // Output known-0 bits are only known if clear in both the LHS & RHS.
937 KnownZero &= KnownZero2;
938 // Output known-1 are known to be set if set in either the LHS | RHS.
939 KnownOne |= KnownOne2;
Jay Foad5a29c362014-05-15 12:12:55 +0000940 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000941 }
942 case Instruction::Xor: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000943 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
944 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000945
Chris Lattner965c7692008-06-02 01:18:21 +0000946 // Output known-0 bits are known if clear or set in both the LHS & RHS.
947 APInt KnownZeroOut = (KnownZero & KnownZero2) | (KnownOne & KnownOne2);
948 // Output known-1 are known to be set if set in only one of the LHS, RHS.
949 KnownOne = (KnownZero & KnownOne2) | (KnownOne & KnownZero2);
950 KnownZero = KnownZeroOut;
Jay Foad5a29c362014-05-15 12:12:55 +0000951 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000952 }
953 case Instruction::Mul: {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000954 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000955 computeKnownBitsMul(I->getOperand(0), I->getOperand(1), NSW, KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000956 KnownOne, KnownZero2, KnownOne2, Depth, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000957 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000958 }
959 case Instruction::UDiv: {
960 // For the purposes of computing leading zeros we can conservatively
961 // treat a udiv as a logical right shift by the power of 2 known to
962 // be less than the denominator.
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000963 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +0000964 unsigned LeadZ = KnownZero2.countLeadingOnes();
965
Jay Foad25a5e4c2010-12-01 08:53:58 +0000966 KnownOne2.clearAllBits();
967 KnownZero2.clearAllBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000968 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +0000969 unsigned RHSUnknownLeadingOnes = KnownOne2.countLeadingZeros();
970 if (RHSUnknownLeadingOnes != BitWidth)
971 LeadZ = std::min(BitWidth,
972 LeadZ + BitWidth - RHSUnknownLeadingOnes - 1);
973
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000974 KnownZero = APInt::getHighBitsSet(BitWidth, LeadZ);
Jay Foad5a29c362014-05-15 12:12:55 +0000975 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000976 }
David Majnemera19d0f22016-08-06 08:16:00 +0000977 case Instruction::Select: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000978 computeKnownBits(I->getOperand(2), KnownZero, KnownOne, Depth + 1, Q);
979 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +0000980
Pete Cooper35b00d52016-08-13 01:05:32 +0000981 const Value *LHS;
982 const Value *RHS;
David Majnemera19d0f22016-08-06 08:16:00 +0000983 SelectPatternFlavor SPF = matchSelectPattern(I, LHS, RHS).Flavor;
984 if (SelectPatternResult::isMinOrMax(SPF)) {
985 computeKnownBits(RHS, KnownZero, KnownOne, Depth + 1, Q);
986 computeKnownBits(LHS, KnownZero2, KnownOne2, Depth + 1, Q);
987 } else {
988 computeKnownBits(I->getOperand(2), KnownZero, KnownOne, Depth + 1, Q);
989 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
990 }
991
992 unsigned MaxHighOnes = 0;
993 unsigned MaxHighZeros = 0;
994 if (SPF == SPF_SMAX) {
995 // If both sides are negative, the result is negative.
Craig Topper93683b62017-03-23 07:06:42 +0000996 if (KnownOne.isNegative() && KnownOne2.isNegative())
David Majnemera19d0f22016-08-06 08:16:00 +0000997 // We can derive a lower bound on the result by taking the max of the
998 // leading one bits.
999 MaxHighOnes =
1000 std::max(KnownOne.countLeadingOnes(), KnownOne2.countLeadingOnes());
1001 // If either side is non-negative, the result is non-negative.
Craig Topper93683b62017-03-23 07:06:42 +00001002 else if (KnownZero.isNegative() || KnownZero2.isNegative())
David Majnemera19d0f22016-08-06 08:16:00 +00001003 MaxHighZeros = 1;
1004 } else if (SPF == SPF_SMIN) {
1005 // If both sides are non-negative, the result is non-negative.
Craig Topper93683b62017-03-23 07:06:42 +00001006 if (KnownZero.isNegative() && KnownZero2.isNegative())
David Majnemera19d0f22016-08-06 08:16:00 +00001007 // We can derive an upper bound on the result by taking the max of the
1008 // leading zero bits.
1009 MaxHighZeros = std::max(KnownZero.countLeadingOnes(),
1010 KnownZero2.countLeadingOnes());
1011 // If either side is negative, the result is negative.
1012 else if (KnownOne[BitWidth - 1] || KnownOne2[BitWidth - 1])
1013 MaxHighOnes = 1;
1014 } else if (SPF == SPF_UMAX) {
1015 // We can derive a lower bound on the result by taking the max of the
1016 // leading one bits.
1017 MaxHighOnes =
1018 std::max(KnownOne.countLeadingOnes(), KnownOne2.countLeadingOnes());
1019 } else if (SPF == SPF_UMIN) {
1020 // We can derive an upper bound on the result by taking the max of the
1021 // leading zero bits.
1022 MaxHighZeros =
1023 std::max(KnownZero.countLeadingOnes(), KnownZero2.countLeadingOnes());
1024 }
1025
Chris Lattner965c7692008-06-02 01:18:21 +00001026 // Only known if known in both the LHS and RHS.
1027 KnownOne &= KnownOne2;
1028 KnownZero &= KnownZero2;
David Majnemera19d0f22016-08-06 08:16:00 +00001029 if (MaxHighOnes > 0)
Craig Topper57d8ca72017-03-22 06:19:37 +00001030 KnownOne.setHighBits(MaxHighOnes);
David Majnemera19d0f22016-08-06 08:16:00 +00001031 if (MaxHighZeros > 0)
Craig Topper57d8ca72017-03-22 06:19:37 +00001032 KnownZero.setHighBits(MaxHighZeros);
Jay Foad5a29c362014-05-15 12:12:55 +00001033 break;
David Majnemera19d0f22016-08-06 08:16:00 +00001034 }
Chris Lattner965c7692008-06-02 01:18:21 +00001035 case Instruction::FPTrunc:
1036 case Instruction::FPExt:
1037 case Instruction::FPToUI:
1038 case Instruction::FPToSI:
1039 case Instruction::SIToFP:
1040 case Instruction::UIToFP:
Jay Foad5a29c362014-05-15 12:12:55 +00001041 break; // Can't work with floating point.
Chris Lattner965c7692008-06-02 01:18:21 +00001042 case Instruction::PtrToInt:
1043 case Instruction::IntToPtr:
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001044 // Fall through and handle them the same as zext/trunc.
1045 LLVM_FALLTHROUGH;
Chris Lattner965c7692008-06-02 01:18:21 +00001046 case Instruction::ZExt:
1047 case Instruction::Trunc: {
Chris Lattner229907c2011-07-18 04:54:35 +00001048 Type *SrcTy = I->getOperand(0)->getType();
Nadav Rotem15198e92012-10-26 17:17:05 +00001049
Chris Lattner0cdbc7a2009-09-08 00:13:52 +00001050 unsigned SrcBitWidth;
Chris Lattner965c7692008-06-02 01:18:21 +00001051 // Note that we handle pointer operands here because of inttoptr/ptrtoint
1052 // which fall through here.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001053 SrcBitWidth = Q.DL.getTypeSizeInBits(SrcTy->getScalarType());
Nadav Rotem15198e92012-10-26 17:17:05 +00001054
1055 assert(SrcBitWidth && "SrcBitWidth can't be zero");
Jay Foad583abbc2010-12-07 08:25:19 +00001056 KnownZero = KnownZero.zextOrTrunc(SrcBitWidth);
1057 KnownOne = KnownOne.zextOrTrunc(SrcBitWidth);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001058 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Jay Foad583abbc2010-12-07 08:25:19 +00001059 KnownZero = KnownZero.zextOrTrunc(BitWidth);
1060 KnownOne = KnownOne.zextOrTrunc(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +00001061 // Any top bits are known to be zero.
1062 if (BitWidth > SrcBitWidth)
Craig Topper57d8ca72017-03-22 06:19:37 +00001063 KnownZero.setBitsFrom(SrcBitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +00001064 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001065 }
1066 case Instruction::BitCast: {
Chris Lattner229907c2011-07-18 04:54:35 +00001067 Type *SrcTy = I->getOperand(0)->getType();
Sanjay Pateldba8b4c2016-06-02 20:01:37 +00001068 if ((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
Chris Lattneredb84072009-07-02 16:04:08 +00001069 // TODO: For now, not handling conversions like:
1070 // (bitcast i64 %x to <2 x i32>)
Duncan Sands19d0b472010-02-16 11:11:14 +00001071 !I->getType()->isVectorTy()) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001072 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Jay Foad5a29c362014-05-15 12:12:55 +00001073 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001074 }
1075 break;
1076 }
1077 case Instruction::SExt: {
1078 // Compute the bits in the result that are not present in the input.
Chris Lattner0cdbc7a2009-09-08 00:13:52 +00001079 unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
Craig Topper1bef2c82012-12-22 19:15:35 +00001080
Jay Foad583abbc2010-12-07 08:25:19 +00001081 KnownZero = KnownZero.trunc(SrcBitWidth);
1082 KnownOne = KnownOne.trunc(SrcBitWidth);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001083 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Jay Foad583abbc2010-12-07 08:25:19 +00001084 KnownZero = KnownZero.zext(BitWidth);
1085 KnownOne = KnownOne.zext(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +00001086
1087 // If the sign bit of the input is known set or clear, then we know the
1088 // top bits of the result.
1089 if (KnownZero[SrcBitWidth-1]) // Input sign bit known zero
Craig Topper57d8ca72017-03-22 06:19:37 +00001090 KnownZero.setBitsFrom(SrcBitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +00001091 else if (KnownOne[SrcBitWidth-1]) // Input sign bit known set
Craig Topper57d8ca72017-03-22 06:19:37 +00001092 KnownOne.setBitsFrom(SrcBitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +00001093 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001094 }
Hal Finkelf2199b22015-10-23 20:37:08 +00001095 case Instruction::Shl: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001096 // (shl X, C1) & C2 == 0 iff (X & C2 >>u C1) == 0
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001097 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Craig Topperd73c6b42017-03-23 07:06:39 +00001098 auto KZF = [NSW](const APInt &KnownZero, unsigned ShiftAmt) {
1099 APInt KZResult = KnownZero << ShiftAmt;
1100 KZResult.setLowBits(ShiftAmt); // Low bits known 0.
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001101 // If this shift has "nsw" keyword, then the result is either a poison
1102 // value or has the same sign bit as the first operand.
1103 if (NSW && KnownZero.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001104 KZResult.setSignBit();
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001105 return KZResult;
Hal Finkelf2199b22015-10-23 20:37:08 +00001106 };
1107
Craig Topperd73c6b42017-03-23 07:06:39 +00001108 auto KOF = [NSW](const APInt &KnownOne, unsigned ShiftAmt) {
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001109 APInt KOResult = KnownOne << ShiftAmt;
1110 if (NSW && KnownOne.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001111 KOResult.setSignBit();
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001112 return KOResult;
Hal Finkelf2199b22015-10-23 20:37:08 +00001113 };
1114
1115 computeKnownBitsFromShiftOperator(I, KnownZero, KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001116 KnownZero2, KnownOne2, Depth, Q, KZF,
1117 KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001118 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001119 }
1120 case Instruction::LShr: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001121 // (ushr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Hal Finkelf2199b22015-10-23 20:37:08 +00001122 auto KZF = [BitWidth](const APInt &KnownZero, unsigned ShiftAmt) {
1123 return APIntOps::lshr(KnownZero, ShiftAmt) |
1124 // High bits known zero.
1125 APInt::getHighBitsSet(BitWidth, ShiftAmt);
1126 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001127
Malcolm Parsons17d266b2017-01-13 17:12:16 +00001128 auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
Hal Finkelf2199b22015-10-23 20:37:08 +00001129 return APIntOps::lshr(KnownOne, ShiftAmt);
1130 };
1131
1132 computeKnownBitsFromShiftOperator(I, KnownZero, KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001133 KnownZero2, KnownOne2, Depth, Q, KZF,
1134 KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001135 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001136 }
1137 case Instruction::AShr: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001138 // (ashr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Malcolm Parsons17d266b2017-01-13 17:12:16 +00001139 auto KZF = [](const APInt &KnownZero, unsigned ShiftAmt) {
Hal Finkelf2199b22015-10-23 20:37:08 +00001140 return APIntOps::ashr(KnownZero, ShiftAmt);
1141 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001142
Malcolm Parsons17d266b2017-01-13 17:12:16 +00001143 auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
Hal Finkelf2199b22015-10-23 20:37:08 +00001144 return APIntOps::ashr(KnownOne, ShiftAmt);
1145 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001146
Hal Finkelf2199b22015-10-23 20:37:08 +00001147 computeKnownBitsFromShiftOperator(I, KnownZero, KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001148 KnownZero2, KnownOne2, Depth, Q, KZF,
1149 KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001150 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001151 }
Chris Lattner965c7692008-06-02 01:18:21 +00001152 case Instruction::Sub: {
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001153 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +00001154 computeKnownBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001155 KnownZero, KnownOne, KnownZero2, KnownOne2, Depth,
1156 Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001157 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001158 }
Chris Lattner965c7692008-06-02 01:18:21 +00001159 case Instruction::Add: {
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001160 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +00001161 computeKnownBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001162 KnownZero, KnownOne, KnownZero2, KnownOne2, Depth,
1163 Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001164 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001165 }
1166 case Instruction::SRem:
1167 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001168 APInt RA = Rem->getValue().abs();
1169 if (RA.isPowerOf2()) {
1170 APInt LowBits = RA - 1;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001171 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001172 Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001173
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001174 // The low bits of the first operand are unchanged by the srem.
1175 KnownZero = KnownZero2 & LowBits;
1176 KnownOne = KnownOne2 & LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +00001177
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001178 // If the first operand is non-negative or has all low bits zero, then
1179 // the upper bits are all zero.
Craig Topper93683b62017-03-23 07:06:42 +00001180 if (KnownZero2.isNegative() || ((KnownZero2 & LowBits) == LowBits))
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001181 KnownZero |= ~LowBits;
1182
1183 // If the first operand is negative and not all low bits are zero, then
1184 // the upper bits are all one.
Craig Topper93683b62017-03-23 07:06:42 +00001185 if (KnownOne2.isNegative() && ((KnownOne2 & LowBits) != 0))
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001186 KnownOne |= ~LowBits;
1187
Craig Topper1bef2c82012-12-22 19:15:35 +00001188 assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +00001189 }
1190 }
Nick Lewyckye4679792011-03-07 01:50:10 +00001191
1192 // The sign bit is the LHS's sign bit, except when the result of the
1193 // remainder is zero.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001194 if (KnownZero.isNonNegative()) {
Nick Lewyckye4679792011-03-07 01:50:10 +00001195 APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001196 computeKnownBits(I->getOperand(0), LHSKnownZero, LHSKnownOne, Depth + 1,
1197 Q);
Nick Lewyckye4679792011-03-07 01:50:10 +00001198 // If it's known zero, our sign bit is also zero.
1199 if (LHSKnownZero.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001200 KnownZero.setSignBit();
Nick Lewyckye4679792011-03-07 01:50:10 +00001201 }
1202
Chris Lattner965c7692008-06-02 01:18:21 +00001203 break;
1204 case Instruction::URem: {
1205 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00001206 const APInt &RA = Rem->getValue();
Chris Lattner965c7692008-06-02 01:18:21 +00001207 if (RA.isPowerOf2()) {
1208 APInt LowBits = (RA - 1);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001209 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001210 KnownZero |= ~LowBits;
1211 KnownOne &= LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +00001212 break;
1213 }
1214 }
1215
1216 // Since the result is less than or equal to either operand, any leading
1217 // zero bits in either operand must also exist in the result.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001218 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
1219 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001220
Chris Lattner4612ae12009-01-20 18:22:57 +00001221 unsigned Leaders = std::max(KnownZero.countLeadingOnes(),
Chris Lattner965c7692008-06-02 01:18:21 +00001222 KnownZero2.countLeadingOnes());
Jay Foad25a5e4c2010-12-01 08:53:58 +00001223 KnownOne.clearAllBits();
Craig Topperd73c6b42017-03-23 07:06:39 +00001224 KnownZero.clearAllBits();
1225 KnownZero.setHighBits(Leaders);
Chris Lattner965c7692008-06-02 01:18:21 +00001226 break;
1227 }
1228
Victor Hernandeza3aaf852009-10-17 01:18:07 +00001229 case Instruction::Alloca: {
Pete Cooper35b00d52016-08-13 01:05:32 +00001230 const AllocaInst *AI = cast<AllocaInst>(I);
Chris Lattner965c7692008-06-02 01:18:21 +00001231 unsigned Align = AI->getAlignment();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001232 if (Align == 0)
Eduard Burtescu90c44492016-01-18 00:10:01 +00001233 Align = Q.DL.getABITypeAlignment(AI->getAllocatedType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001234
Chris Lattner965c7692008-06-02 01:18:21 +00001235 if (Align > 0)
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001236 KnownZero = APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
Chris Lattner965c7692008-06-02 01:18:21 +00001237 break;
1238 }
1239 case Instruction::GetElementPtr: {
1240 // Analyze all of the subscripts of this getelementptr instruction
1241 // to determine if we can prove known low zero bits.
Chris Lattner965c7692008-06-02 01:18:21 +00001242 APInt LocalKnownZero(BitWidth, 0), LocalKnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001243 computeKnownBits(I->getOperand(0), LocalKnownZero, LocalKnownOne, Depth + 1,
1244 Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001245 unsigned TrailZ = LocalKnownZero.countTrailingOnes();
1246
1247 gep_type_iterator GTI = gep_type_begin(I);
1248 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
1249 Value *Index = I->getOperand(i);
Peter Collingbourneab85225b2016-12-02 02:24:42 +00001250 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chris Lattner965c7692008-06-02 01:18:21 +00001251 // Handle struct member offset arithmetic.
Matt Arsenault74742a12013-08-19 21:43:16 +00001252
1253 // Handle case when index is vector zeroinitializer
1254 Constant *CIndex = cast<Constant>(Index);
1255 if (CIndex->isZeroValue())
1256 continue;
1257
1258 if (CIndex->getType()->isVectorTy())
1259 Index = CIndex->getSplatValue();
1260
Chris Lattner965c7692008-06-02 01:18:21 +00001261 unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001262 const StructLayout *SL = Q.DL.getStructLayout(STy);
Chris Lattner965c7692008-06-02 01:18:21 +00001263 uint64_t Offset = SL->getElementOffset(Idx);
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001264 TrailZ = std::min<unsigned>(TrailZ,
1265 countTrailingZeros(Offset));
Chris Lattner965c7692008-06-02 01:18:21 +00001266 } else {
1267 // Handle array index arithmetic.
Chris Lattner229907c2011-07-18 04:54:35 +00001268 Type *IndexedTy = GTI.getIndexedType();
Jay Foad5a29c362014-05-15 12:12:55 +00001269 if (!IndexedTy->isSized()) {
1270 TrailZ = 0;
1271 break;
1272 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +00001273 unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001274 uint64_t TypeSize = Q.DL.getTypeAllocSize(IndexedTy);
Chris Lattner965c7692008-06-02 01:18:21 +00001275 LocalKnownZero = LocalKnownOne = APInt(GEPOpiBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001276 computeKnownBits(Index, LocalKnownZero, LocalKnownOne, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001277 TrailZ = std::min(TrailZ,
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001278 unsigned(countTrailingZeros(TypeSize) +
Chris Lattner4612ae12009-01-20 18:22:57 +00001279 LocalKnownZero.countTrailingOnes()));
Chris Lattner965c7692008-06-02 01:18:21 +00001280 }
1281 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001282
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001283 KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ);
Chris Lattner965c7692008-06-02 01:18:21 +00001284 break;
1285 }
1286 case Instruction::PHI: {
Pete Cooper35b00d52016-08-13 01:05:32 +00001287 const PHINode *P = cast<PHINode>(I);
Chris Lattner965c7692008-06-02 01:18:21 +00001288 // Handle the case of a simple two-predecessor recurrence PHI.
1289 // There's a lot more that could theoretically be done here, but
1290 // this is sufficient to catch some interesting cases.
1291 if (P->getNumIncomingValues() == 2) {
1292 for (unsigned i = 0; i != 2; ++i) {
1293 Value *L = P->getIncomingValue(i);
1294 Value *R = P->getIncomingValue(!i);
Dan Gohman80ca01c2009-07-17 20:47:02 +00001295 Operator *LU = dyn_cast<Operator>(L);
Chris Lattner965c7692008-06-02 01:18:21 +00001296 if (!LU)
1297 continue;
Dan Gohman80ca01c2009-07-17 20:47:02 +00001298 unsigned Opcode = LU->getOpcode();
Chris Lattner965c7692008-06-02 01:18:21 +00001299 // Check for operations that have the property that if
1300 // both their operands have low zero bits, the result
Artur Pilipenkobc76eca2016-08-22 13:14:07 +00001301 // will have low zero bits.
Chris Lattner965c7692008-06-02 01:18:21 +00001302 if (Opcode == Instruction::Add ||
1303 Opcode == Instruction::Sub ||
1304 Opcode == Instruction::And ||
1305 Opcode == Instruction::Or ||
1306 Opcode == Instruction::Mul) {
1307 Value *LL = LU->getOperand(0);
1308 Value *LR = LU->getOperand(1);
1309 // Find a recurrence.
1310 if (LL == I)
1311 L = LR;
1312 else if (LR == I)
1313 L = LL;
1314 else
1315 break;
1316 // Ok, we have a PHI of the form L op= R. Check for low
1317 // zero bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001318 computeKnownBits(R, KnownZero2, KnownOne2, Depth + 1, Q);
David Greeneaebd9e02008-10-27 23:24:03 +00001319
1320 // We need to take the minimum number of known bits
1321 APInt KnownZero3(KnownZero), KnownOne3(KnownOne);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001322 computeKnownBits(L, KnownZero3, KnownOne3, Depth + 1, Q);
David Greeneaebd9e02008-10-27 23:24:03 +00001323
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001324 KnownZero = APInt::getLowBitsSet(
1325 BitWidth, std::min(KnownZero2.countTrailingOnes(),
1326 KnownZero3.countTrailingOnes()));
1327
1328 if (DontImproveNonNegativePhiBits)
1329 break;
1330
1331 auto *OverflowOp = dyn_cast<OverflowingBinaryOperator>(LU);
1332 if (OverflowOp && OverflowOp->hasNoSignedWrap()) {
1333 // If initial value of recurrence is nonnegative, and we are adding
1334 // a nonnegative number with nsw, the result can only be nonnegative
1335 // or poison value regardless of the number of times we execute the
1336 // add in phi recurrence. If initial value is negative and we are
1337 // adding a negative number with nsw, the result can only be
1338 // negative or poison value. Similar arguments apply to sub and mul.
1339 //
1340 // (add non-negative, non-negative) --> non-negative
1341 // (add negative, negative) --> negative
1342 if (Opcode == Instruction::Add) {
1343 if (KnownZero2.isNegative() && KnownZero3.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001344 KnownZero.setSignBit();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001345 else if (KnownOne2.isNegative() && KnownOne3.isNegative())
1346 KnownOne.setBit(BitWidth - 1);
1347 }
1348
1349 // (sub nsw non-negative, negative) --> non-negative
1350 // (sub nsw negative, non-negative) --> negative
1351 else if (Opcode == Instruction::Sub && LL == I) {
1352 if (KnownZero2.isNegative() && KnownOne3.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001353 KnownZero.setSignBit();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001354 else if (KnownOne2.isNegative() && KnownZero3.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001355 KnownOne.setSignBit();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001356 }
1357
1358 // (mul nsw non-negative, non-negative) --> non-negative
1359 else if (Opcode == Instruction::Mul && KnownZero2.isNegative() &&
1360 KnownZero3.isNegative())
Craig Topperd73c6b42017-03-23 07:06:39 +00001361 KnownZero.setSignBit();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001362 }
1363
Chris Lattner965c7692008-06-02 01:18:21 +00001364 break;
1365 }
1366 }
1367 }
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001368
Nick Lewyckyac0b62c2011-02-10 23:54:10 +00001369 // Unreachable blocks may have zero-operand PHI nodes.
1370 if (P->getNumIncomingValues() == 0)
Jay Foad5a29c362014-05-15 12:12:55 +00001371 break;
Nick Lewyckyac0b62c2011-02-10 23:54:10 +00001372
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001373 // Otherwise take the unions of the known bit sets of the operands,
1374 // taking conservative care to avoid excessive recursion.
1375 if (Depth < MaxDepth - 1 && !KnownZero && !KnownOne) {
Duncan Sands7dc3d472011-03-08 12:39:03 +00001376 // Skip if every incoming value references to ourself.
Nuno Lopes0d44a502012-07-03 21:15:40 +00001377 if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
Duncan Sands7dc3d472011-03-08 12:39:03 +00001378 break;
1379
Craig Topperd73c6b42017-03-23 07:06:39 +00001380 KnownZero.setAllBits();
1381 KnownOne.setAllBits();
Pete Cooper833f34d2015-05-12 20:05:31 +00001382 for (Value *IncValue : P->incoming_values()) {
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001383 // Skip direct self references.
Pete Cooper833f34d2015-05-12 20:05:31 +00001384 if (IncValue == P) continue;
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001385
1386 KnownZero2 = APInt(BitWidth, 0);
1387 KnownOne2 = APInt(BitWidth, 0);
1388 // Recurse, but cap the recursion to one level, because we don't
1389 // want to waste time spinning around in loops.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001390 computeKnownBits(IncValue, KnownZero2, KnownOne2, MaxDepth - 1, Q);
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001391 KnownZero &= KnownZero2;
1392 KnownOne &= KnownOne2;
1393 // If all bits have been ruled out, there's no need to check
1394 // more operands.
1395 if (!KnownZero && !KnownOne)
1396 break;
1397 }
1398 }
Chris Lattner965c7692008-06-02 01:18:21 +00001399 break;
1400 }
1401 case Instruction::Call:
Jingyue Wu37fcb592014-06-19 16:50:16 +00001402 case Instruction::Invoke:
Hal Finkel6fd5e1f2016-07-11 02:25:14 +00001403 // If range metadata is attached to this call, set known bits from that,
1404 // and then intersect with known bits based on other properties of the
1405 // function.
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001406 if (MDNode *MD = cast<Instruction>(I)->getMetadata(LLVMContext::MD_range))
Sanjoy Das1d1929a2015-10-28 03:20:15 +00001407 computeKnownBitsFromRangeMetadata(*MD, KnownZero, KnownOne);
Pete Cooper35b00d52016-08-13 01:05:32 +00001408 if (const Value *RV = ImmutableCallSite(I).getReturnedArgOperand()) {
Hal Finkel6fd5e1f2016-07-11 02:25:14 +00001409 computeKnownBits(RV, KnownZero2, KnownOne2, Depth + 1, Q);
1410 KnownZero |= KnownZero2;
1411 KnownOne |= KnownOne2;
1412 }
Pete Cooper35b00d52016-08-13 01:05:32 +00001413 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
Chris Lattner965c7692008-06-02 01:18:21 +00001414 switch (II->getIntrinsicID()) {
1415 default: break;
Chad Rosier85204292017-01-17 17:23:51 +00001416 case Intrinsic::bitreverse:
1417 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topperad5c2d02017-03-22 07:22:49 +00001418 KnownZero |= KnownZero2.reverseBits();
1419 KnownOne |= KnownOne2.reverseBits();
Chad Rosier85204292017-01-17 17:23:51 +00001420 break;
Philip Reames675418e2015-10-06 20:20:45 +00001421 case Intrinsic::bswap:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001422 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Philip Reames675418e2015-10-06 20:20:45 +00001423 KnownZero |= KnownZero2.byteSwap();
1424 KnownOne |= KnownOne2.byteSwap();
1425 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001426 case Intrinsic::ctlz:
1427 case Intrinsic::cttz: {
1428 unsigned LowBits = Log2_32(BitWidth)+1;
Benjamin Kramer4ee57472011-12-24 17:31:46 +00001429 // If this call is undefined for 0, the result will be less than 2^n.
1430 if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
1431 LowBits -= 1;
Craig Topper57d8ca72017-03-22 06:19:37 +00001432 KnownZero.setBitsFrom(LowBits);
Benjamin Kramer4ee57472011-12-24 17:31:46 +00001433 break;
1434 }
1435 case Intrinsic::ctpop: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001436 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Philip Reamesddcf6b32015-10-14 22:42:12 +00001437 // We can bound the space the count needs. Also, bits known to be zero
1438 // can't contribute to the population.
1439 unsigned BitsPossiblySet = BitWidth - KnownZero2.countPopulation();
1440 unsigned LeadingZeros =
1441 APInt(BitWidth, BitsPossiblySet).countLeadingZeros();
Aaron Ballman58f413c2015-10-15 13:55:43 +00001442 assert(LeadingZeros <= BitWidth);
Craig Topper57d8ca72017-03-22 06:19:37 +00001443 KnownZero.setHighBits(LeadingZeros);
Philip Reamesddcf6b32015-10-14 22:42:12 +00001444 KnownOne &= ~KnownZero;
1445 // TODO: we could bound KnownOne using the lower bound on the number
1446 // of bits which might be set provided by popcnt KnownOne2.
Chris Lattner965c7692008-06-02 01:18:21 +00001447 break;
1448 }
Chad Rosierb3628842011-05-26 23:13:19 +00001449 case Intrinsic::x86_sse42_crc32_64_64:
Craig Topper57d8ca72017-03-22 06:19:37 +00001450 KnownZero.setBitsFrom(32);
Evan Cheng2a746bf2011-05-22 18:25:30 +00001451 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001452 }
1453 }
1454 break;
Bjorn Pettersson39616032016-10-06 09:56:21 +00001455 case Instruction::ExtractElement:
1456 // Look through extract element. At the moment we keep this simple and skip
1457 // tracking the specific element. But at least we might find information
1458 // valid for all elements of the vector (for example if vector is sign
1459 // extended, shifted, etc).
1460 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
1461 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001462 case Instruction::ExtractValue:
1463 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001464 const ExtractValueInst *EVI = cast<ExtractValueInst>(I);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001465 if (EVI->getNumIndices() != 1) break;
1466 if (EVI->getIndices()[0] == 0) {
1467 switch (II->getIntrinsicID()) {
1468 default: break;
1469 case Intrinsic::uadd_with_overflow:
1470 case Intrinsic::sadd_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +00001471 computeKnownBitsAddSub(true, II->getArgOperand(0),
1472 II->getArgOperand(1), false, KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001473 KnownOne, KnownZero2, KnownOne2, Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001474 break;
1475 case Intrinsic::usub_with_overflow:
1476 case Intrinsic::ssub_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +00001477 computeKnownBitsAddSub(false, II->getArgOperand(0),
1478 II->getArgOperand(1), false, KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001479 KnownOne, KnownZero2, KnownOne2, Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001480 break;
Nick Lewyckyfa306072012-03-18 23:28:48 +00001481 case Intrinsic::umul_with_overflow:
1482 case Intrinsic::smul_with_overflow:
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001483 computeKnownBitsMul(II->getArgOperand(0), II->getArgOperand(1), false,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001484 KnownZero, KnownOne, KnownZero2, KnownOne2, Depth,
1485 Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +00001486 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001487 }
1488 }
1489 }
Chris Lattner965c7692008-06-02 01:18:21 +00001490 }
Jingyue Wu12b0c282015-06-15 05:46:29 +00001491}
1492
1493/// Determine which bits of V are known to be either zero or one and return
1494/// them in the KnownZero/KnownOne bit sets.
1495///
1496/// NOTE: we cannot consider 'undef' to be "IsZero" here. The problem is that
1497/// we cannot optimize based on the assumption that it is zero without changing
1498/// it to be an explicit zero. If we don't change it to zero, other code could
1499/// optimized based on the contradictory assumption that it is non-zero.
1500/// Because instcombine aggressively folds operations with undef args anyway,
1501/// this won't lose us code quality.
1502///
1503/// This function is defined on values with integer type, values with pointer
1504/// type, and vectors of integers. In the case
1505/// where V is a vector, known zero, and known one values are the
1506/// same width as the vector element, and the bit is set only if it is true
1507/// for all of the elements in the vector.
Pete Cooper35b00d52016-08-13 01:05:32 +00001508void computeKnownBits(const Value *V, APInt &KnownZero, APInt &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001509 unsigned Depth, const Query &Q) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001510 assert(V && "No Value?");
1511 assert(Depth <= MaxDepth && "Limit Search Depth");
1512 unsigned BitWidth = KnownZero.getBitWidth();
1513
1514 assert((V->getType()->isIntOrIntVectorTy() ||
1515 V->getType()->getScalarType()->isPointerTy()) &&
Sanjay Pateldba8b4c2016-06-02 20:01:37 +00001516 "Not integer or pointer type!");
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001517 assert((Q.DL.getTypeSizeInBits(V->getType()->getScalarType()) == BitWidth) &&
Jingyue Wu12b0c282015-06-15 05:46:29 +00001518 (!V->getType()->isIntOrIntVectorTy() ||
1519 V->getType()->getScalarSizeInBits() == BitWidth) &&
1520 KnownZero.getBitWidth() == BitWidth &&
1521 KnownOne.getBitWidth() == BitWidth &&
1522 "V, KnownOne and KnownZero should have same BitWidth");
Craig Topperd73c6b42017-03-23 07:06:39 +00001523 (void)BitWidth;
Jingyue Wu12b0c282015-06-15 05:46:29 +00001524
Sanjay Patelc96f6db2016-09-16 21:20:36 +00001525 const APInt *C;
1526 if (match(V, m_APInt(C))) {
1527 // We know all of the bits for a scalar constant or a splat vector constant!
1528 KnownOne = *C;
Jingyue Wu12b0c282015-06-15 05:46:29 +00001529 KnownZero = ~KnownOne;
1530 return;
1531 }
1532 // Null and aggregate-zero are all-zeros.
Sanjay Patele8dc0902016-05-23 17:57:54 +00001533 if (isa<ConstantPointerNull>(V) || isa<ConstantAggregateZero>(V)) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001534 KnownOne.clearAllBits();
Craig Topperd73c6b42017-03-23 07:06:39 +00001535 KnownZero.setAllBits();
Jingyue Wu12b0c282015-06-15 05:46:29 +00001536 return;
1537 }
1538 // Handle a constant vector by taking the intersection of the known bits of
David Majnemer3918cdd2016-05-04 06:13:33 +00001539 // each element.
Pete Cooper35b00d52016-08-13 01:05:32 +00001540 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001541 // We know that CDS must be a vector of integers. Take the intersection of
1542 // each element.
1543 KnownZero.setAllBits(); KnownOne.setAllBits();
1544 APInt Elt(KnownZero.getBitWidth(), 0);
1545 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1546 Elt = CDS->getElementAsInteger(i);
1547 KnownZero &= ~Elt;
1548 KnownOne &= Elt;
1549 }
1550 return;
1551 }
1552
Pete Cooper35b00d52016-08-13 01:05:32 +00001553 if (const auto *CV = dyn_cast<ConstantVector>(V)) {
David Majnemer3918cdd2016-05-04 06:13:33 +00001554 // We know that CV must be a vector of integers. Take the intersection of
1555 // each element.
1556 KnownZero.setAllBits(); KnownOne.setAllBits();
1557 APInt Elt(KnownZero.getBitWidth(), 0);
1558 for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i) {
1559 Constant *Element = CV->getAggregateElement(i);
1560 auto *ElementCI = dyn_cast_or_null<ConstantInt>(Element);
1561 if (!ElementCI) {
1562 KnownZero.clearAllBits();
1563 KnownOne.clearAllBits();
1564 return;
1565 }
1566 Elt = ElementCI->getValue();
1567 KnownZero &= ~Elt;
1568 KnownOne &= Elt;
1569 }
1570 return;
1571 }
1572
Jingyue Wu12b0c282015-06-15 05:46:29 +00001573 // Start out not knowing anything.
1574 KnownZero.clearAllBits(); KnownOne.clearAllBits();
1575
Duncan P. N. Exon Smithb1b208a2016-09-24 20:42:02 +00001576 // We can't imply anything about undefs.
1577 if (isa<UndefValue>(V))
1578 return;
1579
1580 // There's no point in looking through other users of ConstantData for
1581 // assumptions. Confirm that we've handled them all.
1582 assert(!isa<ConstantData>(V) && "Unhandled constant data!");
1583
Jingyue Wu12b0c282015-06-15 05:46:29 +00001584 // Limit search depth.
1585 // All recursive calls that increase depth must come after this.
1586 if (Depth == MaxDepth)
1587 return;
1588
1589 // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
1590 // the bits of its aliasee.
Pete Cooper35b00d52016-08-13 01:05:32 +00001591 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00001592 if (!GA->isInterposable())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001593 computeKnownBits(GA->getAliasee(), KnownZero, KnownOne, Depth + 1, Q);
Jingyue Wu12b0c282015-06-15 05:46:29 +00001594 return;
1595 }
1596
Pete Cooper35b00d52016-08-13 01:05:32 +00001597 if (const Operator *I = dyn_cast<Operator>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001598 computeKnownBitsFromOperator(I, KnownZero, KnownOne, Depth, Q);
Sanjay Patela67559c2015-09-25 20:12:43 +00001599
Artur Pilipenko029d8532015-09-30 11:55:45 +00001600 // Aligned pointers have trailing zeros - refine KnownZero set
1601 if (V->getType()->isPointerTy()) {
Artur Pilipenkoae51afc2016-02-24 12:25:10 +00001602 unsigned Align = V->getPointerAlignment(Q.DL);
Artur Pilipenko029d8532015-09-30 11:55:45 +00001603 if (Align)
Craig Topper57d8ca72017-03-22 06:19:37 +00001604 KnownZero.setLowBits(countTrailingZeros(Align));
Artur Pilipenko029d8532015-09-30 11:55:45 +00001605 }
1606
Philip Reames146307e2016-03-03 19:44:06 +00001607 // computeKnownBitsFromAssume strictly refines KnownZero and
1608 // KnownOne. Therefore, we run them after computeKnownBitsFromOperator.
Jingyue Wu12b0c282015-06-15 05:46:29 +00001609
1610 // Check whether a nearby assume intrinsic can determine some known bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001611 computeKnownBitsFromAssume(V, KnownZero, KnownOne, Depth, Q);
Jingyue Wu12b0c282015-06-15 05:46:29 +00001612
Jay Foad5a29c362014-05-15 12:12:55 +00001613 assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +00001614}
1615
Sanjay Patelaee84212014-11-04 16:27:42 +00001616/// Determine whether the sign bit is known to be zero or one.
1617/// Convenience wrapper around computeKnownBits.
Pete Cooper35b00d52016-08-13 01:05:32 +00001618void ComputeSignBit(const Value *V, bool &KnownZero, bool &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001619 unsigned Depth, const Query &Q) {
1620 unsigned BitWidth = getBitWidth(V->getType(), Q.DL);
Duncan Sandsd3951082011-01-25 09:38:29 +00001621 if (!BitWidth) {
1622 KnownZero = false;
1623 KnownOne = false;
1624 return;
1625 }
1626 APInt ZeroBits(BitWidth, 0);
1627 APInt OneBits(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001628 computeKnownBits(V, ZeroBits, OneBits, Depth, Q);
Craig Topper93683b62017-03-23 07:06:42 +00001629 KnownOne = OneBits.isNegative();
1630 KnownZero = ZeroBits.isNegative();
Duncan Sandsd3951082011-01-25 09:38:29 +00001631}
1632
Sanjay Patelaee84212014-11-04 16:27:42 +00001633/// Return true if the given value is known to have exactly one
Duncan Sandsd3951082011-01-25 09:38:29 +00001634/// bit set when defined. For vectors return true if every element is known to
Sanjay Patelaee84212014-11-04 16:27:42 +00001635/// be a power of two when defined. Supports values with integer or pointer
Duncan Sandsd3951082011-01-25 09:38:29 +00001636/// types and vectors of integers.
Pete Cooper35b00d52016-08-13 01:05:32 +00001637bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001638 const Query &Q) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001639 if (const Constant *C = dyn_cast<Constant>(V)) {
Duncan Sandsba286d72011-10-26 20:55:21 +00001640 if (C->isNullValue())
1641 return OrZero;
Sanjay Patele2e89ef2016-05-22 15:41:53 +00001642
1643 const APInt *ConstIntOrConstSplatInt;
1644 if (match(C, m_APInt(ConstIntOrConstSplatInt)))
1645 return ConstIntOrConstSplatInt->isPowerOf2();
Duncan Sandsba286d72011-10-26 20:55:21 +00001646 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001647
1648 // 1 << X is clearly a power of two if the one is not shifted off the end. If
1649 // it is shifted off the end then the result is undefined.
1650 if (match(V, m_Shl(m_One(), m_Value())))
1651 return true;
1652
1653 // (signbit) >>l X is clearly a power of two if the one is not shifted off the
1654 // bottom. If it is shifted off the bottom then the result is undefined.
Duncan Sands4b397fc2011-02-01 08:50:33 +00001655 if (match(V, m_LShr(m_SignBit(), m_Value())))
Duncan Sandsd3951082011-01-25 09:38:29 +00001656 return true;
1657
1658 // The remaining tests are all recursive, so bail out if we hit the limit.
1659 if (Depth++ == MaxDepth)
1660 return false;
1661
Craig Topper9f008862014-04-15 04:59:12 +00001662 Value *X = nullptr, *Y = nullptr;
Sanjay Patel41160c22015-12-30 22:40:52 +00001663 // A shift left or a logical shift right of a power of two is a power of two
1664 // or zero.
Duncan Sands985ba632011-10-28 18:30:05 +00001665 if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
Sanjay Patel41160c22015-12-30 22:40:52 +00001666 match(V, m_LShr(m_Value(X), m_Value()))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001667 return isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q);
Duncan Sands985ba632011-10-28 18:30:05 +00001668
Pete Cooper35b00d52016-08-13 01:05:32 +00001669 if (const ZExtInst *ZI = dyn_cast<ZExtInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001670 return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001671
Pete Cooper35b00d52016-08-13 01:05:32 +00001672 if (const SelectInst *SI = dyn_cast<SelectInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001673 return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth, Q) &&
1674 isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth, Q);
Duncan Sandsba286d72011-10-26 20:55:21 +00001675
Duncan Sandsba286d72011-10-26 20:55:21 +00001676 if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
1677 // A power of two and'd with anything is a power of two or zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001678 if (isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q) ||
1679 isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, Depth, Q))
Duncan Sandsba286d72011-10-26 20:55:21 +00001680 return true;
1681 // X & (-X) is always a power of two or zero.
1682 if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
1683 return true;
1684 return false;
1685 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001686
David Majnemerb7d54092013-07-30 21:01:36 +00001687 // Adding a power-of-two or zero to the same power-of-two or zero yields
1688 // either the original power-of-two, a larger power-of-two or zero.
1689 if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001690 const OverflowingBinaryOperator *VOBO = cast<OverflowingBinaryOperator>(V);
David Majnemerb7d54092013-07-30 21:01:36 +00001691 if (OrZero || VOBO->hasNoUnsignedWrap() || VOBO->hasNoSignedWrap()) {
1692 if (match(X, m_And(m_Specific(Y), m_Value())) ||
1693 match(X, m_And(m_Value(), m_Specific(Y))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001694 if (isKnownToBeAPowerOfTwo(Y, OrZero, Depth, Q))
David Majnemerb7d54092013-07-30 21:01:36 +00001695 return true;
1696 if (match(Y, m_And(m_Specific(X), m_Value())) ||
1697 match(Y, m_And(m_Value(), m_Specific(X))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001698 if (isKnownToBeAPowerOfTwo(X, OrZero, Depth, Q))
David Majnemerb7d54092013-07-30 21:01:36 +00001699 return true;
1700
1701 unsigned BitWidth = V->getType()->getScalarSizeInBits();
1702 APInt LHSZeroBits(BitWidth, 0), LHSOneBits(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001703 computeKnownBits(X, LHSZeroBits, LHSOneBits, Depth, Q);
David Majnemerb7d54092013-07-30 21:01:36 +00001704
1705 APInt RHSZeroBits(BitWidth, 0), RHSOneBits(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001706 computeKnownBits(Y, RHSZeroBits, RHSOneBits, Depth, Q);
David Majnemerb7d54092013-07-30 21:01:36 +00001707 // If i8 V is a power of two or zero:
1708 // ZeroBits: 1 1 1 0 1 1 1 1
1709 // ~ZeroBits: 0 0 0 1 0 0 0 0
1710 if ((~(LHSZeroBits & RHSZeroBits)).isPowerOf2())
1711 // If OrZero isn't set, we cannot give back a zero result.
1712 // Make sure either the LHS or RHS has a bit set.
1713 if (OrZero || RHSOneBits.getBoolValue() || LHSOneBits.getBoolValue())
1714 return true;
1715 }
1716 }
David Majnemerbeab5672013-05-18 19:30:37 +00001717
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001718 // An exact divide or right shift can only shift off zero bits, so the result
Nick Lewyckyf0469af2011-03-21 21:40:32 +00001719 // is a power of two only if the first operand is a power of two and not
1720 // copying a sign bit (sdiv int_min, 2).
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001721 if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
1722 match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
Hal Finkel60db0582014-09-07 18:57:58 +00001723 return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001724 Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001725 }
1726
Duncan Sandsd3951082011-01-25 09:38:29 +00001727 return false;
1728}
1729
Chandler Carruth80d3e562012-12-07 02:08:58 +00001730/// \brief Test whether a GEP's result is known to be non-null.
1731///
1732/// Uses properties inherent in a GEP to try to determine whether it is known
1733/// to be non-null.
1734///
1735/// Currently this routine does not support vector GEPs.
Pete Cooper35b00d52016-08-13 01:05:32 +00001736static bool isGEPKnownNonNull(const GEPOperator *GEP, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001737 const Query &Q) {
Chandler Carruth80d3e562012-12-07 02:08:58 +00001738 if (!GEP->isInBounds() || GEP->getPointerAddressSpace() != 0)
1739 return false;
1740
1741 // FIXME: Support vector-GEPs.
1742 assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
1743
1744 // If the base pointer is non-null, we cannot walk to a null address with an
1745 // inbounds GEP in address space zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001746 if (isKnownNonZero(GEP->getPointerOperand(), Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001747 return true;
1748
Chandler Carruth80d3e562012-12-07 02:08:58 +00001749 // Walk the GEP operands and see if any operand introduces a non-zero offset.
1750 // If so, then the GEP cannot produce a null pointer, as doing so would
1751 // inherently violate the inbounds contract within address space zero.
1752 for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
1753 GTI != GTE; ++GTI) {
1754 // Struct types are easy -- they must always be indexed by a constant.
Peter Collingbourneab85225b2016-12-02 02:24:42 +00001755 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chandler Carruth80d3e562012-12-07 02:08:58 +00001756 ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
1757 unsigned ElementIdx = OpC->getZExtValue();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001758 const StructLayout *SL = Q.DL.getStructLayout(STy);
Chandler Carruth80d3e562012-12-07 02:08:58 +00001759 uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
1760 if (ElementOffset > 0)
1761 return true;
1762 continue;
1763 }
1764
1765 // If we have a zero-sized type, the index doesn't matter. Keep looping.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001766 if (Q.DL.getTypeAllocSize(GTI.getIndexedType()) == 0)
Chandler Carruth80d3e562012-12-07 02:08:58 +00001767 continue;
1768
1769 // Fast path the constant operand case both for efficiency and so we don't
1770 // increment Depth when just zipping down an all-constant GEP.
1771 if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
1772 if (!OpC->isZero())
1773 return true;
1774 continue;
1775 }
1776
1777 // We post-increment Depth here because while isKnownNonZero increments it
1778 // as well, when we pop back up that increment won't persist. We don't want
1779 // to recurse 10k times just because we have 10k GEP operands. We don't
1780 // bail completely out because we want to handle constant GEPs regardless
1781 // of depth.
1782 if (Depth++ >= MaxDepth)
1783 continue;
1784
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001785 if (isKnownNonZero(GTI.getOperand(), Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001786 return true;
1787 }
1788
1789 return false;
1790}
1791
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001792/// Does the 'Range' metadata (which must be a valid MD_range operand list)
1793/// ensure that the value it's attached to is never Value? 'RangeType' is
1794/// is the type of the value described by the range.
Pete Cooper35b00d52016-08-13 01:05:32 +00001795static bool rangeMetadataExcludesValue(const MDNode* Ranges, const APInt& Value) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001796 const unsigned NumRanges = Ranges->getNumOperands() / 2;
1797 assert(NumRanges >= 1);
1798 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001799 ConstantInt *Lower =
1800 mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 0));
1801 ConstantInt *Upper =
1802 mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 1));
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001803 ConstantRange Range(Lower->getValue(), Upper->getValue());
1804 if (Range.contains(Value))
1805 return false;
1806 }
1807 return true;
1808}
1809
Sanjay Patel97e4b9872017-02-12 15:35:34 +00001810/// Return true if the given value is known to be non-zero when defined. For
1811/// vectors, return true if every element is known to be non-zero when
1812/// defined. For pointers, if the context instruction and dominator tree are
1813/// specified, perform context-sensitive analysis and return true if the
1814/// pointer couldn't possibly be null at the specified instruction.
1815/// Supports values with integer or pointer type and vectors of integers.
Pete Cooper35b00d52016-08-13 01:05:32 +00001816bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q) {
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001817 if (auto *C = dyn_cast<Constant>(V)) {
Duncan Sandsd3951082011-01-25 09:38:29 +00001818 if (C->isNullValue())
1819 return false;
1820 if (isa<ConstantInt>(C))
1821 // Must be non-zero due to null test above.
1822 return true;
Sanjay Patel23019d12016-05-24 14:18:49 +00001823
1824 // For constant vectors, check that all elements are undefined or known
1825 // non-zero to determine that the whole vector is known non-zero.
1826 if (auto *VecTy = dyn_cast<VectorType>(C->getType())) {
1827 for (unsigned i = 0, e = VecTy->getNumElements(); i != e; ++i) {
1828 Constant *Elt = C->getAggregateElement(i);
1829 if (!Elt || Elt->isNullValue())
1830 return false;
1831 if (!isa<UndefValue>(Elt) && !isa<ConstantInt>(Elt))
1832 return false;
1833 }
1834 return true;
1835 }
1836
Duncan Sandsd3951082011-01-25 09:38:29 +00001837 return false;
1838 }
1839
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001840 if (auto *I = dyn_cast<Instruction>(V)) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001841 if (MDNode *Ranges = I->getMetadata(LLVMContext::MD_range)) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001842 // If the possible ranges don't contain zero, then the value is
1843 // definitely non-zero.
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001844 if (auto *Ty = dyn_cast<IntegerType>(V->getType())) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001845 const APInt ZeroValue(Ty->getBitWidth(), 0);
1846 if (rangeMetadataExcludesValue(Ranges, ZeroValue))
1847 return true;
1848 }
1849 }
1850 }
1851
Duncan Sandsd3951082011-01-25 09:38:29 +00001852 // The remaining tests are all recursive, so bail out if we hit the limit.
Duncan Sands7cb61e52011-10-27 19:16:21 +00001853 if (Depth++ >= MaxDepth)
Duncan Sandsd3951082011-01-25 09:38:29 +00001854 return false;
1855
Chandler Carruth80d3e562012-12-07 02:08:58 +00001856 // Check for pointer simplifications.
1857 if (V->getType()->isPointerTy()) {
Sanjay Patel97e4b9872017-02-12 15:35:34 +00001858 if (isKnownNonNullAt(V, Q.CxtI, Q.DT))
Sanjoy Das6082c1a2016-05-07 02:08:15 +00001859 return true;
Pete Cooper35b00d52016-08-13 01:05:32 +00001860 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001861 if (isGEPKnownNonNull(GEP, Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001862 return true;
1863 }
1864
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001865 unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), Q.DL);
Duncan Sandsd3951082011-01-25 09:38:29 +00001866
1867 // X | Y != 0 if X != 0 or Y != 0.
Craig Topper9f008862014-04-15 04:59:12 +00001868 Value *X = nullptr, *Y = nullptr;
Duncan Sandsd3951082011-01-25 09:38:29 +00001869 if (match(V, m_Or(m_Value(X), m_Value(Y))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001870 return isKnownNonZero(X, Depth, Q) || isKnownNonZero(Y, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001871
1872 // ext X != 0 if X != 0.
1873 if (isa<SExtInst>(V) || isa<ZExtInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001874 return isKnownNonZero(cast<Instruction>(V)->getOperand(0), Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001875
Duncan Sands2e9e4f12011-01-29 13:27:00 +00001876 // shl X, Y != 0 if X is odd. Note that the value of the shift is undefined
Duncan Sandsd3951082011-01-25 09:38:29 +00001877 // if the lowest bit is shifted off the end.
1878 if (BitWidth && match(V, m_Shl(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001879 // shl nuw can't remove any non-zero bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00001880 const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001881 if (BO->hasNoUnsignedWrap())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001882 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001883
Duncan Sandsd3951082011-01-25 09:38:29 +00001884 APInt KnownZero(BitWidth, 0);
1885 APInt KnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001886 computeKnownBits(X, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001887 if (KnownOne[0])
1888 return true;
1889 }
Duncan Sands2e9e4f12011-01-29 13:27:00 +00001890 // shr X, Y != 0 if X is negative. Note that the value of the shift is not
Duncan Sandsd3951082011-01-25 09:38:29 +00001891 // defined if the sign bit is shifted off the end.
1892 else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001893 // shr exact can only shift out zero bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00001894 const PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001895 if (BO->isExact())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001896 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001897
Duncan Sandsd3951082011-01-25 09:38:29 +00001898 bool XKnownNonNegative, XKnownNegative;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001899 ComputeSignBit(X, XKnownNonNegative, XKnownNegative, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001900 if (XKnownNegative)
1901 return true;
James Molloyb6be1eb2015-09-24 16:06:32 +00001902
1903 // If the shifter operand is a constant, and all of the bits shifted
1904 // out are known to be zero, and X is known non-zero then at least one
1905 // non-zero bit must remain.
1906 if (ConstantInt *Shift = dyn_cast<ConstantInt>(Y)) {
1907 APInt KnownZero(BitWidth, 0);
1908 APInt KnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001909 computeKnownBits(X, KnownZero, KnownOne, Depth, Q);
Sanjoy Das6082c1a2016-05-07 02:08:15 +00001910
James Molloyb6be1eb2015-09-24 16:06:32 +00001911 auto ShiftVal = Shift->getLimitedValue(BitWidth - 1);
1912 // Is there a known one in the portion not shifted out?
1913 if (KnownOne.countLeadingZeros() < BitWidth - ShiftVal)
1914 return true;
1915 // Are all the bits to be shifted out known zero?
1916 if (KnownZero.countTrailingOnes() >= ShiftVal)
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001917 return isKnownNonZero(X, Depth, Q);
James Molloyb6be1eb2015-09-24 16:06:32 +00001918 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001919 }
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001920 // div exact can only produce a zero if the dividend is zero.
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001921 else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001922 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001923 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001924 // X + Y.
1925 else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
1926 bool XKnownNonNegative, XKnownNegative;
1927 bool YKnownNonNegative, YKnownNegative;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001928 ComputeSignBit(X, XKnownNonNegative, XKnownNegative, Depth, Q);
1929 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001930
1931 // If X and Y are both non-negative (as signed values) then their sum is not
Duncan Sands9e9d5b22011-01-25 15:14:15 +00001932 // zero unless both X and Y are zero.
Duncan Sandsd3951082011-01-25 09:38:29 +00001933 if (XKnownNonNegative && YKnownNonNegative)
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001934 if (isKnownNonZero(X, Depth, Q) || isKnownNonZero(Y, Depth, Q))
Duncan Sands9e9d5b22011-01-25 15:14:15 +00001935 return true;
Duncan Sandsd3951082011-01-25 09:38:29 +00001936
1937 // If X and Y are both negative (as signed values) then their sum is not
1938 // zero unless both X and Y equal INT_MIN.
1939 if (BitWidth && XKnownNegative && YKnownNegative) {
1940 APInt KnownZero(BitWidth, 0);
1941 APInt KnownOne(BitWidth, 0);
1942 APInt Mask = APInt::getSignedMaxValue(BitWidth);
1943 // The sign bit of X is set. If some other bit is set then X is not equal
1944 // to INT_MIN.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001945 computeKnownBits(X, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001946 if ((KnownOne & Mask) != 0)
1947 return true;
1948 // The sign bit of Y is set. If some other bit is set then Y is not equal
1949 // to INT_MIN.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001950 computeKnownBits(Y, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001951 if ((KnownOne & Mask) != 0)
1952 return true;
1953 }
1954
1955 // The sum of a non-negative number and a power of two is not zero.
Hal Finkel60db0582014-09-07 18:57:58 +00001956 if (XKnownNonNegative &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001957 isKnownToBeAPowerOfTwo(Y, /*OrZero*/ false, Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00001958 return true;
Hal Finkel60db0582014-09-07 18:57:58 +00001959 if (YKnownNonNegative &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001960 isKnownToBeAPowerOfTwo(X, /*OrZero*/ false, Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00001961 return true;
1962 }
Duncan Sands7cb61e52011-10-27 19:16:21 +00001963 // X * Y.
1964 else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001965 const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Duncan Sands7cb61e52011-10-27 19:16:21 +00001966 // If X and Y are non-zero then so is X * Y as long as the multiplication
1967 // does not overflow.
1968 if ((BO->hasNoSignedWrap() || BO->hasNoUnsignedWrap()) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001969 isKnownNonZero(X, Depth, Q) && isKnownNonZero(Y, Depth, Q))
Duncan Sands7cb61e52011-10-27 19:16:21 +00001970 return true;
1971 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001972 // (C ? X : Y) != 0 if X != 0 and Y != 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00001973 else if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001974 if (isKnownNonZero(SI->getTrueValue(), Depth, Q) &&
1975 isKnownNonZero(SI->getFalseValue(), Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00001976 return true;
1977 }
James Molloy897048b2015-09-29 14:08:45 +00001978 // PHI
Pete Cooper35b00d52016-08-13 01:05:32 +00001979 else if (const PHINode *PN = dyn_cast<PHINode>(V)) {
James Molloy897048b2015-09-29 14:08:45 +00001980 // Try and detect a recurrence that monotonically increases from a
1981 // starting value, as these are common as induction variables.
1982 if (PN->getNumIncomingValues() == 2) {
1983 Value *Start = PN->getIncomingValue(0);
1984 Value *Induction = PN->getIncomingValue(1);
1985 if (isa<ConstantInt>(Induction) && !isa<ConstantInt>(Start))
1986 std::swap(Start, Induction);
1987 if (ConstantInt *C = dyn_cast<ConstantInt>(Start)) {
1988 if (!C->isZero() && !C->isNegative()) {
1989 ConstantInt *X;
1990 if ((match(Induction, m_NSWAdd(m_Specific(PN), m_ConstantInt(X))) ||
1991 match(Induction, m_NUWAdd(m_Specific(PN), m_ConstantInt(X)))) &&
1992 !X->isNegative())
1993 return true;
1994 }
1995 }
1996 }
Jun Bum Limca832662016-02-01 17:03:07 +00001997 // Check if all incoming values are non-zero constant.
1998 bool AllNonZeroConstants = all_of(PN->operands(), [](Value *V) {
1999 return isa<ConstantInt>(V) && !cast<ConstantInt>(V)->isZeroValue();
2000 });
2001 if (AllNonZeroConstants)
2002 return true;
James Molloy897048b2015-09-29 14:08:45 +00002003 }
Duncan Sandsd3951082011-01-25 09:38:29 +00002004
2005 if (!BitWidth) return false;
2006 APInt KnownZero(BitWidth, 0);
2007 APInt KnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002008 computeKnownBits(V, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00002009 return KnownOne != 0;
2010}
2011
James Molloy1d88d6f2015-10-22 13:18:42 +00002012/// Return true if V2 == V1 + X, where X is known non-zero.
Pete Cooper35b00d52016-08-13 01:05:32 +00002013static bool isAddOfNonZero(const Value *V1, const Value *V2, const Query &Q) {
2014 const BinaryOperator *BO = dyn_cast<BinaryOperator>(V1);
James Molloy1d88d6f2015-10-22 13:18:42 +00002015 if (!BO || BO->getOpcode() != Instruction::Add)
2016 return false;
2017 Value *Op = nullptr;
2018 if (V2 == BO->getOperand(0))
2019 Op = BO->getOperand(1);
2020 else if (V2 == BO->getOperand(1))
2021 Op = BO->getOperand(0);
2022 else
2023 return false;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002024 return isKnownNonZero(Op, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002025}
2026
2027/// Return true if it is known that V1 != V2.
Pete Cooper35b00d52016-08-13 01:05:32 +00002028static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q) {
James Molloy1d88d6f2015-10-22 13:18:42 +00002029 if (V1->getType()->isVectorTy() || V1 == V2)
2030 return false;
2031 if (V1->getType() != V2->getType())
2032 // We can't look through casts yet.
2033 return false;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002034 if (isAddOfNonZero(V1, V2, Q) || isAddOfNonZero(V2, V1, Q))
James Molloy1d88d6f2015-10-22 13:18:42 +00002035 return true;
2036
2037 if (IntegerType *Ty = dyn_cast<IntegerType>(V1->getType())) {
2038 // Are any known bits in V1 contradictory to known bits in V2? If V1
2039 // has a known zero where V2 has a known one, they must not be equal.
2040 auto BitWidth = Ty->getBitWidth();
2041 APInt KnownZero1(BitWidth, 0);
2042 APInt KnownOne1(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002043 computeKnownBits(V1, KnownZero1, KnownOne1, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002044 APInt KnownZero2(BitWidth, 0);
2045 APInt KnownOne2(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002046 computeKnownBits(V2, KnownZero2, KnownOne2, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002047
2048 auto OppositeBits = (KnownZero1 & KnownOne2) | (KnownZero2 & KnownOne1);
2049 if (OppositeBits.getBoolValue())
2050 return true;
2051 }
2052 return false;
2053}
2054
Sanjay Patelaee84212014-11-04 16:27:42 +00002055/// Return true if 'V & Mask' is known to be zero. We use this predicate to
2056/// simplify operations downstream. Mask is known to be zero for bits that V
2057/// cannot have.
Chris Lattner4bc28252009-09-08 00:06:16 +00002058///
2059/// This function is defined on values with integer type, values with pointer
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002060/// type, and vectors of integers. In the case
Chris Lattner4bc28252009-09-08 00:06:16 +00002061/// where V is a vector, the mask, known zero, and known one values are the
2062/// same width as the vector element, and the bit is set only if it is true
2063/// for all of the elements in the vector.
Pete Cooper35b00d52016-08-13 01:05:32 +00002064bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002065 const Query &Q) {
Chris Lattner965c7692008-06-02 01:18:21 +00002066 APInt KnownZero(Mask.getBitWidth(), 0), KnownOne(Mask.getBitWidth(), 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002067 computeKnownBits(V, KnownZero, KnownOne, Depth, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002068 return (KnownZero & Mask) == Mask;
2069}
2070
Sanjay Patela06d9892016-06-22 19:20:59 +00002071/// For vector constants, loop over the elements and find the constant with the
2072/// minimum number of sign bits. Return 0 if the value is not a vector constant
2073/// or if any element was not analyzed; otherwise, return the count for the
2074/// element with the minimum number of sign bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00002075static unsigned computeNumSignBitsVectorConstant(const Value *V,
2076 unsigned TyBits) {
2077 const auto *CV = dyn_cast<Constant>(V);
Sanjay Patela06d9892016-06-22 19:20:59 +00002078 if (!CV || !CV->getType()->isVectorTy())
2079 return 0;
Chris Lattner965c7692008-06-02 01:18:21 +00002080
Sanjay Patela06d9892016-06-22 19:20:59 +00002081 unsigned MinSignBits = TyBits;
2082 unsigned NumElts = CV->getType()->getVectorNumElements();
2083 for (unsigned i = 0; i != NumElts; ++i) {
2084 // If we find a non-ConstantInt, bail out.
2085 auto *Elt = dyn_cast_or_null<ConstantInt>(CV->getAggregateElement(i));
2086 if (!Elt)
2087 return 0;
2088
2089 // If the sign bit is 1, flip the bits, so we always count leading zeros.
2090 APInt EltVal = Elt->getValue();
2091 if (EltVal.isNegative())
2092 EltVal = ~EltVal;
2093 MinSignBits = std::min(MinSignBits, EltVal.countLeadingZeros());
2094 }
2095
2096 return MinSignBits;
2097}
Chris Lattner965c7692008-06-02 01:18:21 +00002098
Sanjoy Das39a684d2017-02-25 20:30:45 +00002099static unsigned ComputeNumSignBitsImpl(const Value *V, unsigned Depth,
2100 const Query &Q);
2101
2102static unsigned ComputeNumSignBits(const Value *V, unsigned Depth,
2103 const Query &Q) {
2104 unsigned Result = ComputeNumSignBitsImpl(V, Depth, Q);
2105 assert(Result > 0 && "At least one sign bit needs to be present!");
2106 return Result;
2107}
2108
Sanjay Patelaee84212014-11-04 16:27:42 +00002109/// Return the number of times the sign bit of the register is replicated into
2110/// the other bits. We know that at least 1 bit is always equal to the sign bit
2111/// (itself), but other cases can give us information. For example, immediately
2112/// after an "ashr X, 2", we know that the top 3 bits are all equal to each
Sanjay Patela06d9892016-06-22 19:20:59 +00002113/// other, so we return 3. For vectors, return the number of sign bits for the
2114/// vector element with the mininum number of known sign bits.
Sanjoy Das39a684d2017-02-25 20:30:45 +00002115static unsigned ComputeNumSignBitsImpl(const Value *V, unsigned Depth,
2116 const Query &Q) {
2117
2118 // We return the minimum number of sign bits that are guaranteed to be present
2119 // in V, so for undef we have to conservatively return 1. We don't have the
2120 // same behavior for poison though -- that's a FIXME today.
2121
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002122 unsigned TyBits = Q.DL.getTypeSizeInBits(V->getType()->getScalarType());
Chris Lattner965c7692008-06-02 01:18:21 +00002123 unsigned Tmp, Tmp2;
2124 unsigned FirstAnswer = 1;
2125
Jay Foada0653a32014-05-14 21:14:37 +00002126 // Note that ConstantInt is handled by the general computeKnownBits case
Chris Lattner2e01a692008-06-02 18:39:07 +00002127 // below.
2128
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002129 if (Depth == MaxDepth)
Chris Lattner965c7692008-06-02 01:18:21 +00002130 return 1; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00002131
Pete Cooper35b00d52016-08-13 01:05:32 +00002132 const Operator *U = dyn_cast<Operator>(V);
Dan Gohman80ca01c2009-07-17 20:47:02 +00002133 switch (Operator::getOpcode(V)) {
Chris Lattner965c7692008-06-02 01:18:21 +00002134 default: break;
2135 case Instruction::SExt:
Mon P Wangbb3eac92009-12-02 04:59:58 +00002136 Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002137 return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q) + Tmp;
Craig Topper1bef2c82012-12-22 19:15:35 +00002138
Nadav Rotemc99a3872015-03-06 00:23:58 +00002139 case Instruction::SDiv: {
Nadav Rotem029c5c72015-03-03 21:39:02 +00002140 const APInt *Denominator;
2141 // sdiv X, C -> adds log(C) sign bits.
2142 if (match(U->getOperand(1), m_APInt(Denominator))) {
2143
2144 // Ignore non-positive denominator.
2145 if (!Denominator->isStrictlyPositive())
2146 break;
2147
2148 // Calculate the incoming numerator bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002149 unsigned NumBits = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Nadav Rotem029c5c72015-03-03 21:39:02 +00002150
2151 // Add floor(log(C)) bits to the numerator bits.
2152 return std::min(TyBits, NumBits + Denominator->logBase2());
2153 }
2154 break;
Nadav Rotemc99a3872015-03-06 00:23:58 +00002155 }
2156
2157 case Instruction::SRem: {
2158 const APInt *Denominator;
Sanjoy Dase561fee2015-03-25 22:33:53 +00002159 // srem X, C -> we know that the result is within [-C+1,C) when C is a
2160 // positive constant. This let us put a lower bound on the number of sign
2161 // bits.
Nadav Rotemc99a3872015-03-06 00:23:58 +00002162 if (match(U->getOperand(1), m_APInt(Denominator))) {
2163
2164 // Ignore non-positive denominator.
2165 if (!Denominator->isStrictlyPositive())
2166 break;
2167
2168 // Calculate the incoming numerator bits. SRem by a positive constant
2169 // can't lower the number of sign bits.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002170 unsigned NumrBits =
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002171 ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Nadav Rotemc99a3872015-03-06 00:23:58 +00002172
2173 // Calculate the leading sign bit constraints by examining the
Sanjoy Dase561fee2015-03-25 22:33:53 +00002174 // denominator. Given that the denominator is positive, there are two
2175 // cases:
2176 //
2177 // 1. the numerator is positive. The result range is [0,C) and [0,C) u<
2178 // (1 << ceilLogBase2(C)).
2179 //
2180 // 2. the numerator is negative. Then the result range is (-C,0] and
2181 // integers in (-C,0] are either 0 or >u (-1 << ceilLogBase2(C)).
2182 //
2183 // Thus a lower bound on the number of sign bits is `TyBits -
2184 // ceilLogBase2(C)`.
Nadav Rotemc99a3872015-03-06 00:23:58 +00002185
Sanjoy Dase561fee2015-03-25 22:33:53 +00002186 unsigned ResBits = TyBits - Denominator->ceilLogBase2();
Nadav Rotemc99a3872015-03-06 00:23:58 +00002187 return std::max(NumrBits, ResBits);
2188 }
2189 break;
2190 }
Nadav Rotem029c5c72015-03-03 21:39:02 +00002191
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002192 case Instruction::AShr: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002193 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002194 // ashr X, C -> adds C sign bits. Vectors too.
2195 const APInt *ShAmt;
2196 if (match(U->getOperand(1), m_APInt(ShAmt))) {
Sanjoy Das39a684d2017-02-25 20:30:45 +00002197 unsigned ShAmtLimited = ShAmt->getZExtValue();
2198 if (ShAmtLimited >= TyBits)
2199 break; // Bad shift.
2200 Tmp += ShAmtLimited;
Chris Lattner965c7692008-06-02 01:18:21 +00002201 if (Tmp > TyBits) Tmp = TyBits;
2202 }
2203 return Tmp;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002204 }
2205 case Instruction::Shl: {
2206 const APInt *ShAmt;
2207 if (match(U->getOperand(1), m_APInt(ShAmt))) {
Chris Lattner965c7692008-06-02 01:18:21 +00002208 // shl destroys sign bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002209 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002210 Tmp2 = ShAmt->getZExtValue();
2211 if (Tmp2 >= TyBits || // Bad shift.
2212 Tmp2 >= Tmp) break; // Shifted all sign bits out.
2213 return Tmp - Tmp2;
Chris Lattner965c7692008-06-02 01:18:21 +00002214 }
2215 break;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002216 }
Chris Lattner965c7692008-06-02 01:18:21 +00002217 case Instruction::And:
2218 case Instruction::Or:
2219 case Instruction::Xor: // NOT is handled here.
2220 // Logical binary ops preserve the number of sign bits at the worst.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002221 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002222 if (Tmp != 1) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002223 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002224 FirstAnswer = std::min(Tmp, Tmp2);
2225 // We computed what we know about the sign bits as our first
2226 // answer. Now proceed to the generic code that uses
Jay Foada0653a32014-05-14 21:14:37 +00002227 // computeKnownBits, and pick whichever answer is better.
Chris Lattner965c7692008-06-02 01:18:21 +00002228 }
2229 break;
2230
2231 case Instruction::Select:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002232 Tmp = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002233 if (Tmp == 1) return 1; // Early out.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002234 Tmp2 = ComputeNumSignBits(U->getOperand(2), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002235 return std::min(Tmp, Tmp2);
Craig Topper1bef2c82012-12-22 19:15:35 +00002236
Chris Lattner965c7692008-06-02 01:18:21 +00002237 case Instruction::Add:
2238 // Add can have at most one carry bit. Thus we know that the output
2239 // is, at worst, one more bit than the inputs.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002240 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002241 if (Tmp == 1) return 1; // Early out.
Craig Topper1bef2c82012-12-22 19:15:35 +00002242
Chris Lattner965c7692008-06-02 01:18:21 +00002243 // Special case decrementing a value (ADD X, -1):
David Majnemera55027f2014-12-26 09:20:17 +00002244 if (const auto *CRHS = dyn_cast<Constant>(U->getOperand(1)))
Chris Lattner965c7692008-06-02 01:18:21 +00002245 if (CRHS->isAllOnesValue()) {
2246 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002247 computeKnownBits(U->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00002248
Chris Lattner965c7692008-06-02 01:18:21 +00002249 // If the input is known to be 0 or 1, the output is 0/-1, which is all
2250 // sign bits set.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00002251 if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00002252 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00002253
Chris Lattner965c7692008-06-02 01:18:21 +00002254 // If we are subtracting one from a positive number, there is no carry
2255 // out of the result.
2256 if (KnownZero.isNegative())
2257 return Tmp;
2258 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002259
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002260 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002261 if (Tmp2 == 1) return 1;
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002262 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002263
Chris Lattner965c7692008-06-02 01:18:21 +00002264 case Instruction::Sub:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002265 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002266 if (Tmp2 == 1) return 1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002267
Chris Lattner965c7692008-06-02 01:18:21 +00002268 // Handle NEG.
David Majnemera55027f2014-12-26 09:20:17 +00002269 if (const auto *CLHS = dyn_cast<Constant>(U->getOperand(0)))
Chris Lattner965c7692008-06-02 01:18:21 +00002270 if (CLHS->isNullValue()) {
2271 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002272 computeKnownBits(U->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002273 // If the input is known to be 0 or 1, the output is 0/-1, which is all
2274 // sign bits set.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00002275 if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00002276 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00002277
Chris Lattner965c7692008-06-02 01:18:21 +00002278 // If the input is known to be positive (the sign bit is known clear),
2279 // the output of the NEG has the same number of sign bits as the input.
2280 if (KnownZero.isNegative())
2281 return Tmp2;
Craig Topper1bef2c82012-12-22 19:15:35 +00002282
Chris Lattner965c7692008-06-02 01:18:21 +00002283 // Otherwise, we treat this like a SUB.
2284 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002285
Chris Lattner965c7692008-06-02 01:18:21 +00002286 // Sub can have at most one carry bit. Thus we know that the output
2287 // is, at worst, one more bit than the inputs.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002288 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002289 if (Tmp == 1) return 1; // Early out.
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002290 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002291
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002292 case Instruction::PHI: {
Pete Cooper35b00d52016-08-13 01:05:32 +00002293 const PHINode *PN = cast<PHINode>(U);
David Majnemer6ee8d172015-01-04 07:06:53 +00002294 unsigned NumIncomingValues = PN->getNumIncomingValues();
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002295 // Don't analyze large in-degree PHIs.
David Majnemer6ee8d172015-01-04 07:06:53 +00002296 if (NumIncomingValues > 4) break;
2297 // Unreachable blocks may have zero-operand PHI nodes.
2298 if (NumIncomingValues == 0) break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002299
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002300 // Take the minimum of all incoming values. This can't infinitely loop
2301 // because of our depth threshold.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002302 Tmp = ComputeNumSignBits(PN->getIncomingValue(0), Depth + 1, Q);
David Majnemer6ee8d172015-01-04 07:06:53 +00002303 for (unsigned i = 1, e = NumIncomingValues; i != e; ++i) {
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002304 if (Tmp == 1) return Tmp;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002305 Tmp = std::min(
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002306 Tmp, ComputeNumSignBits(PN->getIncomingValue(i), Depth + 1, Q));
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002307 }
2308 return Tmp;
2309 }
2310
Chris Lattner965c7692008-06-02 01:18:21 +00002311 case Instruction::Trunc:
2312 // FIXME: it's tricky to do anything useful for this, but it is an important
2313 // case for targets like X86.
2314 break;
Bjorn Pettersson39616032016-10-06 09:56:21 +00002315
2316 case Instruction::ExtractElement:
2317 // Look through extract element. At the moment we keep this simple and skip
2318 // tracking the specific element. But at least we might find information
2319 // valid for all elements of the vector (for example if vector is sign
2320 // extended, shifted, etc).
2321 return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002322 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002323
Chris Lattner965c7692008-06-02 01:18:21 +00002324 // Finally, if we can prove that the top bits of the result are 0's or 1's,
2325 // use this information.
Sanjay Patela06d9892016-06-22 19:20:59 +00002326
2327 // If we can examine all elements of a vector constant successfully, we're
2328 // done (we can't do any better than that). If not, keep trying.
2329 if (unsigned VecSignBits = computeNumSignBitsVectorConstant(V, TyBits))
2330 return VecSignBits;
2331
Chris Lattner965c7692008-06-02 01:18:21 +00002332 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002333 computeKnownBits(V, KnownZero, KnownOne, Depth, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00002334
Sanjay Patele0536212016-06-23 17:41:59 +00002335 // If we know that the sign bit is either zero or one, determine the number of
2336 // identical bits in the top of the input value.
2337 if (KnownZero.isNegative())
2338 return std::max(FirstAnswer, KnownZero.countLeadingOnes());
Craig Topper1bef2c82012-12-22 19:15:35 +00002339
Sanjay Patele0536212016-06-23 17:41:59 +00002340 if (KnownOne.isNegative())
2341 return std::max(FirstAnswer, KnownOne.countLeadingOnes());
2342
2343 // computeKnownBits gave us no extra information about the top bits.
2344 return FirstAnswer;
Chris Lattner965c7692008-06-02 01:18:21 +00002345}
Chris Lattnera12a6de2008-06-02 01:29:46 +00002346
Sanjay Patelaee84212014-11-04 16:27:42 +00002347/// This function computes the integer multiple of Base that equals V.
2348/// If successful, it returns true and returns the multiple in
2349/// Multiple. If unsuccessful, it returns false. It looks
Victor Hernandez47444882009-11-10 08:28:35 +00002350/// through SExt instructions only if LookThroughSExt is true.
2351bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
Dan Gohman6a976bb2009-11-18 00:58:27 +00002352 bool LookThroughSExt, unsigned Depth) {
Victor Hernandez47444882009-11-10 08:28:35 +00002353 const unsigned MaxDepth = 6;
2354
Dan Gohman6a976bb2009-11-18 00:58:27 +00002355 assert(V && "No Value?");
Victor Hernandez47444882009-11-10 08:28:35 +00002356 assert(Depth <= MaxDepth && "Limit Search Depth");
Duncan Sands9dff9be2010-02-15 16:12:20 +00002357 assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
Victor Hernandez47444882009-11-10 08:28:35 +00002358
Chris Lattner229907c2011-07-18 04:54:35 +00002359 Type *T = V->getType();
Victor Hernandez47444882009-11-10 08:28:35 +00002360
Dan Gohman6a976bb2009-11-18 00:58:27 +00002361 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Victor Hernandez47444882009-11-10 08:28:35 +00002362
2363 if (Base == 0)
2364 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00002365
Victor Hernandez47444882009-11-10 08:28:35 +00002366 if (Base == 1) {
2367 Multiple = V;
2368 return true;
2369 }
2370
2371 ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
2372 Constant *BaseVal = ConstantInt::get(T, Base);
2373 if (CO && CO == BaseVal) {
2374 // Multiple is 1.
2375 Multiple = ConstantInt::get(T, 1);
2376 return true;
2377 }
2378
2379 if (CI && CI->getZExtValue() % Base == 0) {
2380 Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
Craig Topper1bef2c82012-12-22 19:15:35 +00002381 return true;
Victor Hernandez47444882009-11-10 08:28:35 +00002382 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002383
Victor Hernandez47444882009-11-10 08:28:35 +00002384 if (Depth == MaxDepth) return false; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00002385
Victor Hernandez47444882009-11-10 08:28:35 +00002386 Operator *I = dyn_cast<Operator>(V);
2387 if (!I) return false;
2388
2389 switch (I->getOpcode()) {
2390 default: break;
Chris Lattner4f0b47d2009-11-26 01:50:12 +00002391 case Instruction::SExt:
Victor Hernandez47444882009-11-10 08:28:35 +00002392 if (!LookThroughSExt) return false;
2393 // otherwise fall through to ZExt
Chris Lattner4f0b47d2009-11-26 01:50:12 +00002394 case Instruction::ZExt:
Dan Gohman6a976bb2009-11-18 00:58:27 +00002395 return ComputeMultiple(I->getOperand(0), Base, Multiple,
2396 LookThroughSExt, Depth+1);
Victor Hernandez47444882009-11-10 08:28:35 +00002397 case Instruction::Shl:
2398 case Instruction::Mul: {
2399 Value *Op0 = I->getOperand(0);
2400 Value *Op1 = I->getOperand(1);
2401
2402 if (I->getOpcode() == Instruction::Shl) {
2403 ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
2404 if (!Op1CI) return false;
2405 // Turn Op0 << Op1 into Op0 * 2^Op1
2406 APInt Op1Int = Op1CI->getValue();
2407 uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
Jay Foad15084f02010-11-30 09:02:01 +00002408 APInt API(Op1Int.getBitWidth(), 0);
Jay Foad25a5e4c2010-12-01 08:53:58 +00002409 API.setBit(BitToSet);
Jay Foad15084f02010-11-30 09:02:01 +00002410 Op1 = ConstantInt::get(V->getContext(), API);
Victor Hernandez47444882009-11-10 08:28:35 +00002411 }
2412
Craig Topper9f008862014-04-15 04:59:12 +00002413 Value *Mul0 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00002414 if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
2415 if (Constant *Op1C = dyn_cast<Constant>(Op1))
2416 if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00002417 if (Op1C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00002418 MulC->getType()->getPrimitiveSizeInBits())
2419 Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002420 if (Op1C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00002421 MulC->getType()->getPrimitiveSizeInBits())
2422 MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002423
Chris Lattner72d283c2010-09-05 17:20:46 +00002424 // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
2425 Multiple = ConstantExpr::getMul(MulC, Op1C);
2426 return true;
2427 }
Victor Hernandez47444882009-11-10 08:28:35 +00002428
2429 if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
2430 if (Mul0CI->getValue() == 1) {
2431 // V == Base * Op1, so return Op1
2432 Multiple = Op1;
2433 return true;
2434 }
2435 }
2436
Craig Topper9f008862014-04-15 04:59:12 +00002437 Value *Mul1 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00002438 if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
2439 if (Constant *Op0C = dyn_cast<Constant>(Op0))
2440 if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00002441 if (Op0C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00002442 MulC->getType()->getPrimitiveSizeInBits())
2443 Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002444 if (Op0C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00002445 MulC->getType()->getPrimitiveSizeInBits())
2446 MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002447
Chris Lattner72d283c2010-09-05 17:20:46 +00002448 // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
2449 Multiple = ConstantExpr::getMul(MulC, Op0C);
2450 return true;
2451 }
Victor Hernandez47444882009-11-10 08:28:35 +00002452
2453 if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
2454 if (Mul1CI->getValue() == 1) {
2455 // V == Base * Op0, so return Op0
2456 Multiple = Op0;
2457 return true;
2458 }
2459 }
Victor Hernandez47444882009-11-10 08:28:35 +00002460 }
2461 }
2462
2463 // We could not determine if V is a multiple of Base.
2464 return false;
2465}
2466
David Majnemerb4b27232016-04-19 19:10:21 +00002467Intrinsic::ID llvm::getIntrinsicForCallSite(ImmutableCallSite ICS,
2468 const TargetLibraryInfo *TLI) {
2469 const Function *F = ICS.getCalledFunction();
2470 if (!F)
2471 return Intrinsic::not_intrinsic;
2472
2473 if (F->isIntrinsic())
2474 return F->getIntrinsicID();
2475
2476 if (!TLI)
2477 return Intrinsic::not_intrinsic;
2478
David L. Jonesd21529f2017-01-23 23:16:46 +00002479 LibFunc Func;
David Majnemerb4b27232016-04-19 19:10:21 +00002480 // We're going to make assumptions on the semantics of the functions, check
2481 // that the target knows that it's available in this environment and it does
2482 // not have local linkage.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002483 if (!F || F->hasLocalLinkage() || !TLI->getLibFunc(*F, Func))
2484 return Intrinsic::not_intrinsic;
2485
2486 if (!ICS.onlyReadsMemory())
David Majnemerb4b27232016-04-19 19:10:21 +00002487 return Intrinsic::not_intrinsic;
2488
2489 // Otherwise check if we have a call to a function that can be turned into a
2490 // vector intrinsic.
2491 switch (Func) {
2492 default:
2493 break;
David L. Jonesd21529f2017-01-23 23:16:46 +00002494 case LibFunc_sin:
2495 case LibFunc_sinf:
2496 case LibFunc_sinl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002497 return Intrinsic::sin;
David L. Jonesd21529f2017-01-23 23:16:46 +00002498 case LibFunc_cos:
2499 case LibFunc_cosf:
2500 case LibFunc_cosl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002501 return Intrinsic::cos;
David L. Jonesd21529f2017-01-23 23:16:46 +00002502 case LibFunc_exp:
2503 case LibFunc_expf:
2504 case LibFunc_expl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002505 return Intrinsic::exp;
David L. Jonesd21529f2017-01-23 23:16:46 +00002506 case LibFunc_exp2:
2507 case LibFunc_exp2f:
2508 case LibFunc_exp2l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002509 return Intrinsic::exp2;
David L. Jonesd21529f2017-01-23 23:16:46 +00002510 case LibFunc_log:
2511 case LibFunc_logf:
2512 case LibFunc_logl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002513 return Intrinsic::log;
David L. Jonesd21529f2017-01-23 23:16:46 +00002514 case LibFunc_log10:
2515 case LibFunc_log10f:
2516 case LibFunc_log10l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002517 return Intrinsic::log10;
David L. Jonesd21529f2017-01-23 23:16:46 +00002518 case LibFunc_log2:
2519 case LibFunc_log2f:
2520 case LibFunc_log2l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002521 return Intrinsic::log2;
David L. Jonesd21529f2017-01-23 23:16:46 +00002522 case LibFunc_fabs:
2523 case LibFunc_fabsf:
2524 case LibFunc_fabsl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002525 return Intrinsic::fabs;
David L. Jonesd21529f2017-01-23 23:16:46 +00002526 case LibFunc_fmin:
2527 case LibFunc_fminf:
2528 case LibFunc_fminl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002529 return Intrinsic::minnum;
David L. Jonesd21529f2017-01-23 23:16:46 +00002530 case LibFunc_fmax:
2531 case LibFunc_fmaxf:
2532 case LibFunc_fmaxl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002533 return Intrinsic::maxnum;
David L. Jonesd21529f2017-01-23 23:16:46 +00002534 case LibFunc_copysign:
2535 case LibFunc_copysignf:
2536 case LibFunc_copysignl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002537 return Intrinsic::copysign;
David L. Jonesd21529f2017-01-23 23:16:46 +00002538 case LibFunc_floor:
2539 case LibFunc_floorf:
2540 case LibFunc_floorl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002541 return Intrinsic::floor;
David L. Jonesd21529f2017-01-23 23:16:46 +00002542 case LibFunc_ceil:
2543 case LibFunc_ceilf:
2544 case LibFunc_ceill:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002545 return Intrinsic::ceil;
David L. Jonesd21529f2017-01-23 23:16:46 +00002546 case LibFunc_trunc:
2547 case LibFunc_truncf:
2548 case LibFunc_truncl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002549 return Intrinsic::trunc;
David L. Jonesd21529f2017-01-23 23:16:46 +00002550 case LibFunc_rint:
2551 case LibFunc_rintf:
2552 case LibFunc_rintl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002553 return Intrinsic::rint;
David L. Jonesd21529f2017-01-23 23:16:46 +00002554 case LibFunc_nearbyint:
2555 case LibFunc_nearbyintf:
2556 case LibFunc_nearbyintl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002557 return Intrinsic::nearbyint;
David L. Jonesd21529f2017-01-23 23:16:46 +00002558 case LibFunc_round:
2559 case LibFunc_roundf:
2560 case LibFunc_roundl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002561 return Intrinsic::round;
David L. Jonesd21529f2017-01-23 23:16:46 +00002562 case LibFunc_pow:
2563 case LibFunc_powf:
2564 case LibFunc_powl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002565 return Intrinsic::pow;
David L. Jonesd21529f2017-01-23 23:16:46 +00002566 case LibFunc_sqrt:
2567 case LibFunc_sqrtf:
2568 case LibFunc_sqrtl:
David Majnemerb4b27232016-04-19 19:10:21 +00002569 if (ICS->hasNoNaNs())
Ahmed Bougachad765a822016-04-27 19:04:35 +00002570 return Intrinsic::sqrt;
David Majnemerb4b27232016-04-19 19:10:21 +00002571 return Intrinsic::not_intrinsic;
2572 }
2573
2574 return Intrinsic::not_intrinsic;
2575}
2576
Sanjay Patelaee84212014-11-04 16:27:42 +00002577/// Return true if we can prove that the specified FP value is never equal to
2578/// -0.0.
Chris Lattnera12a6de2008-06-02 01:29:46 +00002579///
2580/// NOTE: this function will need to be revisited when we support non-default
2581/// rounding modes!
2582///
David Majnemer3ee5f342016-04-13 06:55:52 +00002583bool llvm::CannotBeNegativeZero(const Value *V, const TargetLibraryInfo *TLI,
2584 unsigned Depth) {
Chris Lattnera12a6de2008-06-02 01:29:46 +00002585 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V))
2586 return !CFP->getValueAPF().isNegZero();
Craig Topper1bef2c82012-12-22 19:15:35 +00002587
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002588 if (Depth == MaxDepth)
Sanjay Patel40eaa8d2015-02-25 18:00:15 +00002589 return false; // Limit search depth.
Chris Lattnera12a6de2008-06-02 01:29:46 +00002590
Dan Gohman80ca01c2009-07-17 20:47:02 +00002591 const Operator *I = dyn_cast<Operator>(V);
Craig Topper9f008862014-04-15 04:59:12 +00002592 if (!I) return false;
Michael Ilseman0f128372012-12-06 00:07:09 +00002593
2594 // Check if the nsz fast-math flag is set
2595 if (const FPMathOperator *FPO = dyn_cast<FPMathOperator>(I))
2596 if (FPO->hasNoSignedZeros())
2597 return true;
2598
Chris Lattnera12a6de2008-06-02 01:29:46 +00002599 // (add x, 0.0) is guaranteed to return +0.0, not -0.0.
Jakub Staszakb7129f22013-03-06 00:16:16 +00002600 if (I->getOpcode() == Instruction::FAdd)
2601 if (ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(1)))
2602 if (CFP->isNullValue())
2603 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00002604
Chris Lattnera12a6de2008-06-02 01:29:46 +00002605 // sitofp and uitofp turn into +0.0 for zero.
2606 if (isa<SIToFPInst>(I) || isa<UIToFPInst>(I))
2607 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00002608
David Majnemer3ee5f342016-04-13 06:55:52 +00002609 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
David Majnemerb4b27232016-04-19 19:10:21 +00002610 Intrinsic::ID IID = getIntrinsicForCallSite(CI, TLI);
David Majnemer3ee5f342016-04-13 06:55:52 +00002611 switch (IID) {
2612 default:
2613 break;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002614 // sqrt(-0.0) = -0.0, no other negative results are possible.
David Majnemer3ee5f342016-04-13 06:55:52 +00002615 case Intrinsic::sqrt:
2616 return CannotBeNegativeZero(CI->getArgOperand(0), TLI, Depth + 1);
2617 // fabs(x) != -0.0
2618 case Intrinsic::fabs:
2619 return true;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002620 }
David Majnemer3ee5f342016-04-13 06:55:52 +00002621 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002622
Chris Lattnera12a6de2008-06-02 01:29:46 +00002623 return false;
2624}
2625
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002626/// If \p SignBitOnly is true, test for a known 0 sign bit rather than a
2627/// standard ordered compare. e.g. make -0.0 olt 0.0 be true because of the sign
2628/// bit despite comparing equal.
2629static bool cannotBeOrderedLessThanZeroImpl(const Value *V,
2630 const TargetLibraryInfo *TLI,
2631 bool SignBitOnly,
2632 unsigned Depth) {
Justin Lebar322c1272017-01-27 00:58:34 +00002633 // TODO: This function does not do the right thing when SignBitOnly is true
2634 // and we're lowering to a hypothetical IEEE 754-compliant-but-evil platform
2635 // which flips the sign bits of NaNs. See
2636 // https://llvm.org/bugs/show_bug.cgi?id=31702.
2637
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002638 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2639 return !CFP->getValueAPF().isNegative() ||
2640 (!SignBitOnly && CFP->getValueAPF().isZero());
2641 }
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002642
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002643 if (Depth == MaxDepth)
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002644 return false; // Limit search depth.
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002645
2646 const Operator *I = dyn_cast<Operator>(V);
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002647 if (!I)
2648 return false;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002649
2650 switch (I->getOpcode()) {
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002651 default:
2652 break;
Fiona Glaserdb7824f2016-01-12 23:37:30 +00002653 // Unsigned integers are always nonnegative.
2654 case Instruction::UIToFP:
2655 return true;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002656 case Instruction::FMul:
2657 // x*x is always non-negative or a NaN.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002658 if (I->getOperand(0) == I->getOperand(1) &&
2659 (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()))
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002660 return true;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002661
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002662 LLVM_FALLTHROUGH;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002663 case Instruction::FAdd:
2664 case Instruction::FDiv:
2665 case Instruction::FRem:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002666 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2667 Depth + 1) &&
2668 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2669 Depth + 1);
Fiona Glaserdb7824f2016-01-12 23:37:30 +00002670 case Instruction::Select:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002671 return cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2672 Depth + 1) &&
2673 cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
2674 Depth + 1);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002675 case Instruction::FPExt:
2676 case Instruction::FPTrunc:
2677 // Widening/narrowing never change sign.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002678 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2679 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002680 case Instruction::Call:
Justin Lebar7e3184c2017-01-26 00:10:26 +00002681 const auto *CI = cast<CallInst>(I);
2682 Intrinsic::ID IID = getIntrinsicForCallSite(CI, TLI);
David Majnemer3ee5f342016-04-13 06:55:52 +00002683 switch (IID) {
2684 default:
2685 break;
2686 case Intrinsic::maxnum:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002687 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2688 Depth + 1) ||
2689 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2690 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002691 case Intrinsic::minnum:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002692 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2693 Depth + 1) &&
2694 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2695 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002696 case Intrinsic::exp:
2697 case Intrinsic::exp2:
2698 case Intrinsic::fabs:
David Majnemer3ee5f342016-04-13 06:55:52 +00002699 return true;
Justin Lebar7e3184c2017-01-26 00:10:26 +00002700
2701 case Intrinsic::sqrt:
2702 // sqrt(x) is always >= -0 or NaN. Moreover, sqrt(x) == -0 iff x == -0.
2703 if (!SignBitOnly)
2704 return true;
2705 return CI->hasNoNaNs() && (CI->hasNoSignedZeros() ||
2706 CannotBeNegativeZero(CI->getOperand(0), TLI));
2707
David Majnemer3ee5f342016-04-13 06:55:52 +00002708 case Intrinsic::powi:
Justin Lebar7e3184c2017-01-26 00:10:26 +00002709 if (ConstantInt *Exponent = dyn_cast<ConstantInt>(I->getOperand(1))) {
David Majnemer3ee5f342016-04-13 06:55:52 +00002710 // powi(x,n) is non-negative if n is even.
Justin Lebar7e3184c2017-01-26 00:10:26 +00002711 if (Exponent->getBitWidth() <= 64 && Exponent->getSExtValue() % 2u == 0)
David Majnemer3ee5f342016-04-13 06:55:52 +00002712 return true;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002713 }
Justin Lebar322c1272017-01-27 00:58:34 +00002714 // TODO: This is not correct. Given that exp is an integer, here are the
2715 // ways that pow can return a negative value:
2716 //
2717 // pow(x, exp) --> negative if exp is odd and x is negative.
2718 // pow(-0, exp) --> -inf if exp is negative odd.
2719 // pow(-0, exp) --> -0 if exp is positive odd.
2720 // pow(-inf, exp) --> -0 if exp is negative odd.
2721 // pow(-inf, exp) --> -inf if exp is positive odd.
2722 //
2723 // Therefore, if !SignBitOnly, we can return true if x >= +0 or x is NaN,
2724 // but we must return false if x == -0. Unfortunately we do not currently
2725 // have a way of expressing this constraint. See details in
2726 // https://llvm.org/bugs/show_bug.cgi?id=31702.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002727 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2728 Depth + 1);
Justin Lebar322c1272017-01-27 00:58:34 +00002729
David Majnemer3ee5f342016-04-13 06:55:52 +00002730 case Intrinsic::fma:
2731 case Intrinsic::fmuladd:
2732 // x*x+y is non-negative if y is non-negative.
2733 return I->getOperand(0) == I->getOperand(1) &&
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002734 (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()) &&
2735 cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
2736 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002737 }
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002738 break;
2739 }
Sanjoy Das6082c1a2016-05-07 02:08:15 +00002740 return false;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002741}
2742
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002743bool llvm::CannotBeOrderedLessThanZero(const Value *V,
2744 const TargetLibraryInfo *TLI) {
2745 return cannotBeOrderedLessThanZeroImpl(V, TLI, false, 0);
2746}
2747
2748bool llvm::SignBitMustBeZero(const Value *V, const TargetLibraryInfo *TLI) {
2749 return cannotBeOrderedLessThanZeroImpl(V, TLI, true, 0);
2750}
2751
Sanjay Patelaee84212014-11-04 16:27:42 +00002752/// If the specified value can be set by repeating the same byte in memory,
2753/// return the i8 value that it is represented with. This is
Chris Lattner9cb10352010-12-26 20:15:01 +00002754/// true for all i8 values obviously, but is also true for i32 0, i32 -1,
2755/// i16 0xF0F0, double 0.0 etc. If the value can't be handled with a repeated
2756/// byte store (e.g. i16 0x1234), return null.
2757Value *llvm::isBytewiseValue(Value *V) {
2758 // All byte-wide stores are splatable, even of arbitrary variables.
2759 if (V->getType()->isIntegerTy(8)) return V;
Chris Lattneracf6b072011-02-19 19:35:49 +00002760
2761 // Handle 'null' ConstantArrayZero etc.
2762 if (Constant *C = dyn_cast<Constant>(V))
2763 if (C->isNullValue())
2764 return Constant::getNullValue(Type::getInt8Ty(V->getContext()));
Craig Topper1bef2c82012-12-22 19:15:35 +00002765
Chris Lattner9cb10352010-12-26 20:15:01 +00002766 // Constant float and double values can be handled as integer values if the
Craig Topper1bef2c82012-12-22 19:15:35 +00002767 // corresponding integer value is "byteable". An important case is 0.0.
Chris Lattner9cb10352010-12-26 20:15:01 +00002768 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2769 if (CFP->getType()->isFloatTy())
2770 V = ConstantExpr::getBitCast(CFP, Type::getInt32Ty(V->getContext()));
2771 if (CFP->getType()->isDoubleTy())
2772 V = ConstantExpr::getBitCast(CFP, Type::getInt64Ty(V->getContext()));
2773 // Don't handle long double formats, which have strange constraints.
2774 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002775
Benjamin Kramer17d90152015-02-07 19:29:02 +00002776 // We can handle constant integers that are multiple of 8 bits.
Chris Lattner9cb10352010-12-26 20:15:01 +00002777 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Benjamin Kramer17d90152015-02-07 19:29:02 +00002778 if (CI->getBitWidth() % 8 == 0) {
2779 assert(CI->getBitWidth() > 8 && "8 bits should be handled above!");
Craig Topper1bef2c82012-12-22 19:15:35 +00002780
Benjamin Kramerb4b51502015-03-25 16:49:59 +00002781 if (!CI->getValue().isSplat(8))
Benjamin Kramer17d90152015-02-07 19:29:02 +00002782 return nullptr;
2783 return ConstantInt::get(V->getContext(), CI->getValue().trunc(8));
Chris Lattner9cb10352010-12-26 20:15:01 +00002784 }
2785 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002786
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002787 // A ConstantDataArray/Vector is splatable if all its members are equal and
2788 // also splatable.
2789 if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(V)) {
2790 Value *Elt = CA->getElementAsConstant(0);
2791 Value *Val = isBytewiseValue(Elt);
Chris Lattner9cb10352010-12-26 20:15:01 +00002792 if (!Val)
Craig Topper9f008862014-04-15 04:59:12 +00002793 return nullptr;
Craig Topper1bef2c82012-12-22 19:15:35 +00002794
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002795 for (unsigned I = 1, E = CA->getNumElements(); I != E; ++I)
2796 if (CA->getElementAsConstant(I) != Elt)
Craig Topper9f008862014-04-15 04:59:12 +00002797 return nullptr;
Craig Topper1bef2c82012-12-22 19:15:35 +00002798
Chris Lattner9cb10352010-12-26 20:15:01 +00002799 return Val;
2800 }
Chad Rosier8abf65a2011-12-06 00:19:08 +00002801
Chris Lattner9cb10352010-12-26 20:15:01 +00002802 // Conceptually, we could handle things like:
2803 // %a = zext i8 %X to i16
2804 // %b = shl i16 %a, 8
2805 // %c = or i16 %a, %b
2806 // but until there is an example that actually needs this, it doesn't seem
2807 // worth worrying about.
Craig Topper9f008862014-04-15 04:59:12 +00002808 return nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00002809}
2810
2811
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002812// This is the recursive version of BuildSubAggregate. It takes a few different
2813// arguments. Idxs is the index within the nested struct From that we are
2814// looking at now (which is of type IndexedType). IdxSkip is the number of
2815// indices from Idxs that should be left out when inserting into the resulting
2816// struct. To is the result struct built so far, new insertvalue instructions
2817// build on that.
Chris Lattner229907c2011-07-18 04:54:35 +00002818static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
Craig Topper2cd5ff82013-07-11 16:22:38 +00002819 SmallVectorImpl<unsigned> &Idxs,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00002820 unsigned IdxSkip,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00002821 Instruction *InsertBefore) {
Dmitri Gribenko226fea52013-01-13 16:01:15 +00002822 llvm::StructType *STy = dyn_cast<llvm::StructType>(IndexedType);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002823 if (STy) {
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002824 // Save the original To argument so we can modify it
2825 Value *OrigTo = To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002826 // General case, the type indexed by Idxs is a struct
2827 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2828 // Process each struct element recursively
2829 Idxs.push_back(i);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002830 Value *PrevTo = To;
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002831 To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002832 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002833 Idxs.pop_back();
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002834 if (!To) {
2835 // Couldn't find any inserted value for this index? Cleanup
2836 while (PrevTo != OrigTo) {
2837 InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
2838 PrevTo = Del->getAggregateOperand();
2839 Del->eraseFromParent();
2840 }
2841 // Stop processing elements
2842 break;
2843 }
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002844 }
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00002845 // If we successfully found a value for each of our subaggregates
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002846 if (To)
2847 return To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002848 }
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002849 // Base case, the type indexed by SourceIdxs is not a struct, or not all of
2850 // the struct's elements had a value that was inserted directly. In the latter
2851 // case, perhaps we can't determine each of the subelements individually, but
2852 // we might be able to find the complete struct somewhere.
Craig Topper1bef2c82012-12-22 19:15:35 +00002853
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002854 // Find the value that is at that particular spot
Jay Foad57aa6362011-07-13 10:26:04 +00002855 Value *V = FindInsertedValue(From, Idxs);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002856
2857 if (!V)
Craig Topper9f008862014-04-15 04:59:12 +00002858 return nullptr;
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002859
2860 // Insert the value in the new (sub) aggregrate
Frits van Bommel717d7ed2011-07-18 12:00:32 +00002861 return llvm::InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
Jay Foad57aa6362011-07-13 10:26:04 +00002862 "tmp", InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002863}
2864
2865// This helper takes a nested struct and extracts a part of it (which is again a
2866// struct) into a new value. For example, given the struct:
2867// { a, { b, { c, d }, e } }
2868// and the indices "1, 1" this returns
2869// { c, d }.
2870//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002871// It does this by inserting an insertvalue for each element in the resulting
2872// struct, as opposed to just inserting a single struct. This will only work if
2873// each of the elements of the substruct are known (ie, inserted into From by an
2874// insertvalue instruction somewhere).
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002875//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002876// All inserted insertvalue instructions are inserted before InsertBefore
Jay Foad57aa6362011-07-13 10:26:04 +00002877static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00002878 Instruction *InsertBefore) {
Matthijs Kooijman69801d42008-06-16 13:28:31 +00002879 assert(InsertBefore && "Must have someplace to insert!");
Chris Lattner229907c2011-07-18 04:54:35 +00002880 Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
Jay Foad57aa6362011-07-13 10:26:04 +00002881 idx_range);
Owen Andersonb292b8c2009-07-30 23:03:37 +00002882 Value *To = UndefValue::get(IndexedType);
Jay Foad57aa6362011-07-13 10:26:04 +00002883 SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002884 unsigned IdxSkip = Idxs.size();
2885
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002886 return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002887}
2888
Sanjay Patelaee84212014-11-04 16:27:42 +00002889/// Given an aggregrate and an sequence of indices, see if
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002890/// the scalar value indexed is already around as a register, for example if it
2891/// were inserted directly into the aggregrate.
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002892///
2893/// If InsertBefore is not null, this function will duplicate (modified)
2894/// insertvalues when a part of a nested struct is extracted.
Jay Foad57aa6362011-07-13 10:26:04 +00002895Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
2896 Instruction *InsertBefore) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002897 // Nothing to index? Just return V then (this is useful at the end of our
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002898 // recursion).
Jay Foad57aa6362011-07-13 10:26:04 +00002899 if (idx_range.empty())
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002900 return V;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002901 // We have indices, so V should have an indexable type.
2902 assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
2903 "Not looking at a struct or array?");
2904 assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
2905 "Invalid indices for type?");
Owen Andersonf1f17432009-07-06 22:37:39 +00002906
Chris Lattner67058832012-01-25 06:48:06 +00002907 if (Constant *C = dyn_cast<Constant>(V)) {
2908 C = C->getAggregateElement(idx_range[0]);
Craig Topper9f008862014-04-15 04:59:12 +00002909 if (!C) return nullptr;
Chris Lattner67058832012-01-25 06:48:06 +00002910 return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
2911 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002912
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002913 if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002914 // Loop the indices for the insertvalue instruction in parallel with the
2915 // requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00002916 const unsigned *req_idx = idx_range.begin();
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002917 for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
2918 i != e; ++i, ++req_idx) {
Jay Foad57aa6362011-07-13 10:26:04 +00002919 if (req_idx == idx_range.end()) {
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002920 // We can't handle this without inserting insertvalues
2921 if (!InsertBefore)
Craig Topper9f008862014-04-15 04:59:12 +00002922 return nullptr;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002923
2924 // The requested index identifies a part of a nested aggregate. Handle
2925 // this specially. For example,
2926 // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
2927 // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
2928 // %C = extractvalue {i32, { i32, i32 } } %B, 1
2929 // This can be changed into
2930 // %A = insertvalue {i32, i32 } undef, i32 10, 0
2931 // %C = insertvalue {i32, i32 } %A, i32 11, 1
2932 // which allows the unused 0,0 element from the nested struct to be
2933 // removed.
2934 return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
2935 InsertBefore);
Duncan Sandsdb356ee2008-06-19 08:47:31 +00002936 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002937
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002938 // This insert value inserts something else than what we are looking for.
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00002939 // See if the (aggregate) value inserted into has the value we are
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002940 // looking for, then.
2941 if (*req_idx != *i)
Jay Foad57aa6362011-07-13 10:26:04 +00002942 return FindInsertedValue(I->getAggregateOperand(), idx_range,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002943 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002944 }
2945 // If we end up here, the indices of the insertvalue match with those
2946 // requested (though possibly only partially). Now we recursively look at
2947 // the inserted value, passing any remaining indices.
Jay Foad57aa6362011-07-13 10:26:04 +00002948 return FindInsertedValue(I->getInsertedValueOperand(),
Frits van Bommel717d7ed2011-07-18 12:00:32 +00002949 makeArrayRef(req_idx, idx_range.end()),
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002950 InsertBefore);
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002951 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002952
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002953 if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00002954 // If we're extracting a value from an aggregate that was extracted from
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002955 // something else, we can extract from that something else directly instead.
2956 // However, we will need to chain I's indices with the requested indices.
Craig Topper1bef2c82012-12-22 19:15:35 +00002957
2958 // Calculate the number of indices required
Jay Foad57aa6362011-07-13 10:26:04 +00002959 unsigned size = I->getNumIndices() + idx_range.size();
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002960 // Allocate some space to put the new indices in
Matthijs Kooijman8369c672008-06-17 08:24:37 +00002961 SmallVector<unsigned, 5> Idxs;
2962 Idxs.reserve(size);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002963 // Add indices from the extract value instruction
Jay Foad57aa6362011-07-13 10:26:04 +00002964 Idxs.append(I->idx_begin(), I->idx_end());
Craig Topper1bef2c82012-12-22 19:15:35 +00002965
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002966 // Add requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00002967 Idxs.append(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002968
Craig Topper1bef2c82012-12-22 19:15:35 +00002969 assert(Idxs.size() == size
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002970 && "Number of indices added not correct?");
Craig Topper1bef2c82012-12-22 19:15:35 +00002971
Jay Foad57aa6362011-07-13 10:26:04 +00002972 return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002973 }
2974 // Otherwise, we don't know (such as, extracting from a function return value
2975 // or load instruction)
Craig Topper9f008862014-04-15 04:59:12 +00002976 return nullptr;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002977}
Evan Chengda3db112008-06-30 07:31:25 +00002978
Sanjay Patelaee84212014-11-04 16:27:42 +00002979/// Analyze the specified pointer to see if it can be expressed as a base
2980/// pointer plus a constant offset. Return the base and offset to the caller.
Chris Lattnere28618d2010-11-30 22:25:26 +00002981Value *llvm::GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002982 const DataLayout &DL) {
2983 unsigned BitWidth = DL.getPointerTypeSizeInBits(Ptr->getType());
Nuno Lopes368c4d02012-12-31 20:48:35 +00002984 APInt ByteOffset(BitWidth, 0);
Chandler Carruth76641272016-01-04 07:23:12 +00002985
2986 // We walk up the defs but use a visited set to handle unreachable code. In
2987 // that case, we stop after accumulating the cycle once (not that it
2988 // matters).
2989 SmallPtrSet<Value *, 16> Visited;
2990 while (Visited.insert(Ptr).second) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00002991 if (Ptr->getType()->isVectorTy())
2992 break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002993
Nuno Lopes368c4d02012-12-31 20:48:35 +00002994 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
Tom Stellard17eb3412016-10-07 14:23:29 +00002995 // If one of the values we have visited is an addrspacecast, then
2996 // the pointer type of this GEP may be different from the type
2997 // of the Ptr parameter which was passed to this function. This
2998 // means when we construct GEPOffset, we need to use the size
2999 // of GEP's pointer type rather than the size of the original
3000 // pointer type.
3001 APInt GEPOffset(DL.getPointerTypeSizeInBits(Ptr->getType()), 0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003002 if (!GEP->accumulateConstantOffset(DL, GEPOffset))
3003 break;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00003004
Tom Stellard17eb3412016-10-07 14:23:29 +00003005 ByteOffset += GEPOffset.getSExtValue();
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00003006
Nuno Lopes368c4d02012-12-31 20:48:35 +00003007 Ptr = GEP->getPointerOperand();
Tom Stellard17eb3412016-10-07 14:23:29 +00003008 } else if (Operator::getOpcode(Ptr) == Instruction::BitCast ||
3009 Operator::getOpcode(Ptr) == Instruction::AddrSpaceCast) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00003010 Ptr = cast<Operator>(Ptr)->getOperand(0);
3011 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00003012 if (GA->isInterposable())
Nuno Lopes368c4d02012-12-31 20:48:35 +00003013 break;
3014 Ptr = GA->getAliasee();
Chris Lattnere28618d2010-11-30 22:25:26 +00003015 } else {
Nuno Lopes368c4d02012-12-31 20:48:35 +00003016 break;
Chris Lattnere28618d2010-11-30 22:25:26 +00003017 }
3018 }
Nuno Lopes368c4d02012-12-31 20:48:35 +00003019 Offset = ByteOffset.getSExtValue();
3020 return Ptr;
Chris Lattnere28618d2010-11-30 22:25:26 +00003021}
3022
David L Kreitzer752c1442016-04-13 14:31:06 +00003023bool llvm::isGEPBasedOnPointerToString(const GEPOperator *GEP) {
3024 // Make sure the GEP has exactly three arguments.
3025 if (GEP->getNumOperands() != 3)
3026 return false;
3027
3028 // Make sure the index-ee is a pointer to array of i8.
3029 ArrayType *AT = dyn_cast<ArrayType>(GEP->getSourceElementType());
3030 if (!AT || !AT->getElementType()->isIntegerTy(8))
3031 return false;
3032
3033 // Check to make sure that the first operand of the GEP is an integer and
3034 // has value 0 so that we are sure we're indexing into the initializer.
3035 const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
3036 if (!FirstIdx || !FirstIdx->isZero())
3037 return false;
3038
3039 return true;
Sanjoy Das6082c1a2016-05-07 02:08:15 +00003040}
Chris Lattnere28618d2010-11-30 22:25:26 +00003041
Sanjay Patelaee84212014-11-04 16:27:42 +00003042/// This function computes the length of a null-terminated C string pointed to
3043/// by V. If successful, it returns true and returns the string in Str.
3044/// If unsuccessful, it returns false.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003045bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
3046 uint64_t Offset, bool TrimAtNul) {
3047 assert(V);
Evan Chengda3db112008-06-30 07:31:25 +00003048
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003049 // Look through bitcast instructions and geps.
3050 V = V->stripPointerCasts();
Craig Topper1bef2c82012-12-22 19:15:35 +00003051
Benjamin Kramer0248a3e2015-03-21 15:36:06 +00003052 // If the value is a GEP instruction or constant expression, treat it as an
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003053 // offset.
3054 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
David L Kreitzer752c1442016-04-13 14:31:06 +00003055 // The GEP operator should be based on a pointer to string constant, and is
3056 // indexing into the string constant.
3057 if (!isGEPBasedOnPointerToString(GEP))
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003058 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003059
Evan Chengda3db112008-06-30 07:31:25 +00003060 // If the second index isn't a ConstantInt, then this is a variable index
3061 // into the array. If this occurs, we can't say anything meaningful about
3062 // the string.
3063 uint64_t StartIdx = 0;
Dan Gohman0b4df042010-04-14 22:20:45 +00003064 if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
Evan Chengda3db112008-06-30 07:31:25 +00003065 StartIdx = CI->getZExtValue();
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003066 else
3067 return false;
Benjamin Kramer0248a3e2015-03-21 15:36:06 +00003068 return getConstantStringInfo(GEP->getOperand(0), Str, StartIdx + Offset,
3069 TrimAtNul);
Evan Chengda3db112008-06-30 07:31:25 +00003070 }
Nick Lewycky46209882011-10-20 00:34:35 +00003071
Evan Chengda3db112008-06-30 07:31:25 +00003072 // The GEP instruction, constant or instruction, must reference a global
3073 // variable that is a constant and is initialized. The referenced constant
3074 // initializer is the array that we'll use for optimization.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003075 const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00003076 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003077 return false;
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003078
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00003079 // Handle the all-zeros case.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003080 if (GV->getInitializer()->isNullValue()) {
Evan Chengda3db112008-06-30 07:31:25 +00003081 // This is a degenerate case. The initializer is constant zero so the
3082 // length of the string must be zero.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003083 Str = "";
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003084 return true;
3085 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003086
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00003087 // This must be a ConstantDataArray.
3088 const auto *Array = dyn_cast<ConstantDataArray>(GV->getInitializer());
Craig Topper9f008862014-04-15 04:59:12 +00003089 if (!Array || !Array->isString())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003090 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003091
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00003092 // Get the number of elements in the array.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003093 uint64_t NumElts = Array->getType()->getArrayNumElements();
3094
3095 // Start out with the entire array in the StringRef.
3096 Str = Array->getAsString();
3097
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003098 if (Offset > NumElts)
3099 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003100
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003101 // Skip over 'offset' bytes.
3102 Str = Str.substr(Offset);
Craig Topper1bef2c82012-12-22 19:15:35 +00003103
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003104 if (TrimAtNul) {
3105 // Trim off the \0 and anything after it. If the array is not nul
3106 // terminated, we just return the whole end of string. The client may know
3107 // some other way that the string is length-bound.
3108 Str = Str.substr(0, Str.find('\0'));
3109 }
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003110 return true;
Evan Chengda3db112008-06-30 07:31:25 +00003111}
Eric Christopher4899cbc2010-03-05 06:58:57 +00003112
3113// These next two are very similar to the above, but also look through PHI
3114// nodes.
3115// TODO: See if we can integrate these two together.
3116
Sanjay Patelaee84212014-11-04 16:27:42 +00003117/// If we can compute the length of the string pointed to by
Eric Christopher4899cbc2010-03-05 06:58:57 +00003118/// the specified pointer, return 'len+1'. If we can't, return 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00003119static uint64_t GetStringLengthH(const Value *V,
3120 SmallPtrSetImpl<const PHINode*> &PHIs) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003121 // Look through noop bitcast instructions.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003122 V = V->stripPointerCasts();
Eric Christopher4899cbc2010-03-05 06:58:57 +00003123
3124 // If this is a PHI node, there are two cases: either we have already seen it
3125 // or we haven't.
Pete Cooper35b00d52016-08-13 01:05:32 +00003126 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
David Blaikie70573dc2014-11-19 07:49:26 +00003127 if (!PHIs.insert(PN).second)
Eric Christopher4899cbc2010-03-05 06:58:57 +00003128 return ~0ULL; // already in the set.
3129
3130 // If it was new, see if all the input strings are the same length.
3131 uint64_t LenSoFar = ~0ULL;
Pete Cooper833f34d2015-05-12 20:05:31 +00003132 for (Value *IncValue : PN->incoming_values()) {
3133 uint64_t Len = GetStringLengthH(IncValue, PHIs);
Eric Christopher4899cbc2010-03-05 06:58:57 +00003134 if (Len == 0) return 0; // Unknown length -> unknown.
3135
3136 if (Len == ~0ULL) continue;
3137
3138 if (Len != LenSoFar && LenSoFar != ~0ULL)
3139 return 0; // Disagree -> unknown.
3140 LenSoFar = Len;
3141 }
3142
3143 // Success, all agree.
3144 return LenSoFar;
3145 }
3146
3147 // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
Pete Cooper35b00d52016-08-13 01:05:32 +00003148 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003149 uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs);
3150 if (Len1 == 0) return 0;
3151 uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs);
3152 if (Len2 == 0) return 0;
3153 if (Len1 == ~0ULL) return Len2;
3154 if (Len2 == ~0ULL) return Len1;
3155 if (Len1 != Len2) return 0;
3156 return Len1;
3157 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003158
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003159 // Otherwise, see if we can read the string.
3160 StringRef StrData;
3161 if (!getConstantStringInfo(V, StrData))
Eric Christopher4899cbc2010-03-05 06:58:57 +00003162 return 0;
3163
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003164 return StrData.size()+1;
Eric Christopher4899cbc2010-03-05 06:58:57 +00003165}
3166
Sanjay Patelaee84212014-11-04 16:27:42 +00003167/// If we can compute the length of the string pointed to by
Eric Christopher4899cbc2010-03-05 06:58:57 +00003168/// the specified pointer, return 'len+1'. If we can't, return 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00003169uint64_t llvm::GetStringLength(const Value *V) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003170 if (!V->getType()->isPointerTy()) return 0;
3171
Pete Cooper35b00d52016-08-13 01:05:32 +00003172 SmallPtrSet<const PHINode*, 32> PHIs;
Eric Christopher4899cbc2010-03-05 06:58:57 +00003173 uint64_t Len = GetStringLengthH(V, PHIs);
3174 // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
3175 // an empty string as a length.
3176 return Len == ~0ULL ? 1 : Len;
3177}
Dan Gohmana4fcd242010-12-15 20:02:24 +00003178
Adam Nemete2b885c2015-04-23 20:09:20 +00003179/// \brief \p PN defines a loop-variant pointer to an object. Check if the
3180/// previous iteration of the loop was referring to the same object as \p PN.
Pete Cooper35b00d52016-08-13 01:05:32 +00003181static bool isSameUnderlyingObjectInLoop(const PHINode *PN,
3182 const LoopInfo *LI) {
Adam Nemete2b885c2015-04-23 20:09:20 +00003183 // Find the loop-defined value.
3184 Loop *L = LI->getLoopFor(PN->getParent());
3185 if (PN->getNumIncomingValues() != 2)
3186 return true;
3187
3188 // Find the value from previous iteration.
3189 auto *PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(0));
3190 if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
3191 PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(1));
3192 if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
3193 return true;
3194
3195 // If a new pointer is loaded in the loop, the pointer references a different
3196 // object in every iteration. E.g.:
3197 // for (i)
3198 // int *p = a[i];
3199 // ...
3200 if (auto *Load = dyn_cast<LoadInst>(PrevValue))
3201 if (!L->isLoopInvariant(Load->getPointerOperand()))
3202 return false;
3203 return true;
3204}
3205
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003206Value *llvm::GetUnderlyingObject(Value *V, const DataLayout &DL,
3207 unsigned MaxLookup) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00003208 if (!V->getType()->isPointerTy())
3209 return V;
3210 for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
3211 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
3212 V = GEP->getPointerOperand();
Matt Arsenault70f4db882014-07-15 00:56:40 +00003213 } else if (Operator::getOpcode(V) == Instruction::BitCast ||
3214 Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00003215 V = cast<Operator>(V)->getOperand(0);
3216 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00003217 if (GA->isInterposable())
Dan Gohmana4fcd242010-12-15 20:02:24 +00003218 return V;
3219 V = GA->getAliasee();
3220 } else {
Hal Finkel5c12d8f2016-07-11 01:32:20 +00003221 if (auto CS = CallSite(V))
3222 if (Value *RV = CS.getReturnedArgOperand()) {
3223 V = RV;
3224 continue;
3225 }
3226
Dan Gohman05b18f12010-12-15 20:49:55 +00003227 // See if InstructionSimplify knows any relevant tricks.
3228 if (Instruction *I = dyn_cast<Instruction>(V))
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003229 // TODO: Acquire a DominatorTree and AssumptionCache and use them.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003230 if (Value *Simplified = SimplifyInstruction(I, DL, nullptr)) {
Dan Gohman05b18f12010-12-15 20:49:55 +00003231 V = Simplified;
3232 continue;
3233 }
3234
Dan Gohmana4fcd242010-12-15 20:02:24 +00003235 return V;
3236 }
3237 assert(V->getType()->isPointerTy() && "Unexpected operand type!");
3238 }
3239 return V;
3240}
Nick Lewycky3e334a42011-06-27 04:20:45 +00003241
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003242void llvm::GetUnderlyingObjects(Value *V, SmallVectorImpl<Value *> &Objects,
Adam Nemete2b885c2015-04-23 20:09:20 +00003243 const DataLayout &DL, LoopInfo *LI,
3244 unsigned MaxLookup) {
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003245 SmallPtrSet<Value *, 4> Visited;
3246 SmallVector<Value *, 4> Worklist;
3247 Worklist.push_back(V);
3248 do {
3249 Value *P = Worklist.pop_back_val();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003250 P = GetUnderlyingObject(P, DL, MaxLookup);
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003251
David Blaikie70573dc2014-11-19 07:49:26 +00003252 if (!Visited.insert(P).second)
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003253 continue;
3254
3255 if (SelectInst *SI = dyn_cast<SelectInst>(P)) {
3256 Worklist.push_back(SI->getTrueValue());
3257 Worklist.push_back(SI->getFalseValue());
3258 continue;
3259 }
3260
3261 if (PHINode *PN = dyn_cast<PHINode>(P)) {
Adam Nemete2b885c2015-04-23 20:09:20 +00003262 // If this PHI changes the underlying object in every iteration of the
3263 // loop, don't look through it. Consider:
3264 // int **A;
3265 // for (i) {
3266 // Prev = Curr; // Prev = PHI (Prev_0, Curr)
3267 // Curr = A[i];
3268 // *Prev, *Curr;
3269 //
3270 // Prev is tracking Curr one iteration behind so they refer to different
3271 // underlying objects.
3272 if (!LI || !LI->isLoopHeader(PN->getParent()) ||
3273 isSameUnderlyingObjectInLoop(PN, LI))
Pete Cooper833f34d2015-05-12 20:05:31 +00003274 for (Value *IncValue : PN->incoming_values())
3275 Worklist.push_back(IncValue);
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003276 continue;
3277 }
3278
3279 Objects.push_back(P);
3280 } while (!Worklist.empty());
3281}
3282
Sanjay Patelaee84212014-11-04 16:27:42 +00003283/// Return true if the only users of this pointer are lifetime markers.
Nick Lewycky3e334a42011-06-27 04:20:45 +00003284bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003285 for (const User *U : V->users()) {
3286 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
Nick Lewycky3e334a42011-06-27 04:20:45 +00003287 if (!II) return false;
3288
3289 if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
3290 II->getIntrinsicID() != Intrinsic::lifetime_end)
3291 return false;
3292 }
3293 return true;
3294}
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003295
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003296bool llvm::isSafeToSpeculativelyExecute(const Value *V,
3297 const Instruction *CtxI,
Sean Silva45835e72016-07-02 23:47:27 +00003298 const DominatorTree *DT) {
Dan Gohman7ac046a2012-01-04 23:01:09 +00003299 const Operator *Inst = dyn_cast<Operator>(V);
3300 if (!Inst)
3301 return false;
3302
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003303 for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
3304 if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
3305 if (C->canTrap())
3306 return false;
3307
3308 switch (Inst->getOpcode()) {
3309 default:
3310 return true;
3311 case Instruction::UDiv:
David Majnemerf20d7c42014-11-04 23:49:08 +00003312 case Instruction::URem: {
3313 // x / y is undefined if y == 0.
3314 const APInt *V;
3315 if (match(Inst->getOperand(1), m_APInt(V)))
3316 return *V != 0;
3317 return false;
3318 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003319 case Instruction::SDiv:
3320 case Instruction::SRem: {
David Majnemerf20d7c42014-11-04 23:49:08 +00003321 // x / y is undefined if y == 0 or x == INT_MIN and y == -1
David Majnemer8a6578a2015-02-01 19:10:19 +00003322 const APInt *Numerator, *Denominator;
3323 if (!match(Inst->getOperand(1), m_APInt(Denominator)))
3324 return false;
3325 // We cannot hoist this division if the denominator is 0.
3326 if (*Denominator == 0)
3327 return false;
3328 // It's safe to hoist if the denominator is not 0 or -1.
3329 if (*Denominator != -1)
3330 return true;
3331 // At this point we know that the denominator is -1. It is safe to hoist as
3332 // long we know that the numerator is not INT_MIN.
3333 if (match(Inst->getOperand(0), m_APInt(Numerator)))
3334 return !Numerator->isMinSignedValue();
3335 // The numerator *might* be MinSignedValue.
David Majnemerf20d7c42014-11-04 23:49:08 +00003336 return false;
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003337 }
3338 case Instruction::Load: {
3339 const LoadInst *LI = cast<LoadInst>(Inst);
Kostya Serebryany0b458282013-11-21 07:29:28 +00003340 if (!LI->isUnordered() ||
3341 // Speculative load may create a race that did not exist in the source.
Sanjoy Dasb66374c2016-07-14 20:19:01 +00003342 LI->getFunction()->hasFnAttribute(Attribute::SanitizeThread) ||
Kostya Serebryany5cb86d52015-10-14 00:21:05 +00003343 // Speculative load may load data from dirty regions.
Sanjoy Dasb66374c2016-07-14 20:19:01 +00003344 LI->getFunction()->hasFnAttribute(Attribute::SanitizeAddress))
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003345 return false;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003346 const DataLayout &DL = LI->getModule()->getDataLayout();
Sean Silva45835e72016-07-02 23:47:27 +00003347 return isDereferenceableAndAlignedPointer(LI->getPointerOperand(),
3348 LI->getAlignment(), DL, CtxI, DT);
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003349 }
Nick Lewyckyb4039f62011-12-21 05:52:02 +00003350 case Instruction::Call: {
David Majnemer0a92f862015-08-28 21:13:39 +00003351 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
3352 switch (II->getIntrinsicID()) {
3353 // These synthetic intrinsics have no side-effects and just mark
3354 // information about their operands.
3355 // FIXME: There are other no-op synthetic instructions that potentially
3356 // should be considered at least *safe* to speculate...
3357 case Intrinsic::dbg_declare:
3358 case Intrinsic::dbg_value:
3359 return true;
3360
Xin Tongc13a8e82017-01-09 17:57:08 +00003361 case Intrinsic::bitreverse:
David Majnemer0a92f862015-08-28 21:13:39 +00003362 case Intrinsic::bswap:
3363 case Intrinsic::ctlz:
3364 case Intrinsic::ctpop:
3365 case Intrinsic::cttz:
3366 case Intrinsic::objectsize:
3367 case Intrinsic::sadd_with_overflow:
3368 case Intrinsic::smul_with_overflow:
3369 case Intrinsic::ssub_with_overflow:
3370 case Intrinsic::uadd_with_overflow:
3371 case Intrinsic::umul_with_overflow:
3372 case Intrinsic::usub_with_overflow:
3373 return true;
Peter Zotov0218d0f2016-04-03 12:30:46 +00003374 // These intrinsics are defined to have the same behavior as libm
3375 // functions except for setting errno.
David Majnemer0a92f862015-08-28 21:13:39 +00003376 case Intrinsic::sqrt:
3377 case Intrinsic::fma:
3378 case Intrinsic::fmuladd:
Peter Zotov0218d0f2016-04-03 12:30:46 +00003379 return true;
3380 // These intrinsics are defined to have the same behavior as libm
3381 // functions, and the corresponding libm functions never set errno.
3382 case Intrinsic::trunc:
3383 case Intrinsic::copysign:
David Majnemer0a92f862015-08-28 21:13:39 +00003384 case Intrinsic::fabs:
3385 case Intrinsic::minnum:
3386 case Intrinsic::maxnum:
3387 return true;
Peter Zotov0218d0f2016-04-03 12:30:46 +00003388 // These intrinsics are defined to have the same behavior as libm
3389 // functions, which never overflow when operating on the IEEE754 types
3390 // that we support, and never set errno otherwise.
3391 case Intrinsic::ceil:
3392 case Intrinsic::floor:
3393 case Intrinsic::nearbyint:
3394 case Intrinsic::rint:
3395 case Intrinsic::round:
3396 return true;
whitequark16f1e5f2017-01-25 09:32:30 +00003397 // These intrinsics do not correspond to any libm function, and
3398 // do not set errno.
3399 case Intrinsic::powi:
3400 return true;
David Majnemer0a92f862015-08-28 21:13:39 +00003401 // TODO: are convert_{from,to}_fp16 safe?
3402 // TODO: can we list target-specific intrinsics here?
3403 default: break;
3404 }
3405 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003406 return false; // The called function could have undefined behavior or
David Majnemer0a92f862015-08-28 21:13:39 +00003407 // side-effects, even if marked readnone nounwind.
Nick Lewyckyb4039f62011-12-21 05:52:02 +00003408 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003409 case Instruction::VAArg:
3410 case Instruction::Alloca:
3411 case Instruction::Invoke:
3412 case Instruction::PHI:
3413 case Instruction::Store:
3414 case Instruction::Ret:
3415 case Instruction::Br:
3416 case Instruction::IndirectBr:
3417 case Instruction::Switch:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003418 case Instruction::Unreachable:
3419 case Instruction::Fence:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003420 case Instruction::AtomicRMW:
3421 case Instruction::AtomicCmpXchg:
David Majnemer654e1302015-07-31 17:58:14 +00003422 case Instruction::LandingPad:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003423 case Instruction::Resume:
David Majnemer8a1c45d2015-12-12 05:38:55 +00003424 case Instruction::CatchSwitch:
David Majnemer654e1302015-07-31 17:58:14 +00003425 case Instruction::CatchPad:
David Majnemer654e1302015-07-31 17:58:14 +00003426 case Instruction::CatchRet:
3427 case Instruction::CleanupPad:
3428 case Instruction::CleanupRet:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003429 return false; // Misc instructions which have effects
3430 }
3431}
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003432
Quentin Colombet6443cce2015-08-06 18:44:34 +00003433bool llvm::mayBeMemoryDependent(const Instruction &I) {
3434 return I.mayReadOrWriteMemory() || !isSafeToSpeculativelyExecute(&I);
3435}
3436
Sanjay Patelaee84212014-11-04 16:27:42 +00003437/// Return true if we know that the specified value is never null.
Sean Silva45835e72016-07-02 23:47:27 +00003438bool llvm::isKnownNonNull(const Value *V) {
Chen Li0d043b52015-09-14 18:10:43 +00003439 assert(V->getType()->isPointerTy() && "V must be pointer type");
3440
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003441 // Alloca never returns null, malloc might.
3442 if (isa<AllocaInst>(V)) return true;
3443
Nick Lewyckyd52b1522014-05-20 01:23:40 +00003444 // A byval, inalloca, or nonnull argument is never null.
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003445 if (const Argument *A = dyn_cast<Argument>(V))
Nick Lewyckyd52b1522014-05-20 01:23:40 +00003446 return A->hasByValOrInAllocaAttr() || A->hasNonNullAttr();
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003447
Peter Collingbourne235c2752016-12-08 19:01:00 +00003448 // A global variable in address space 0 is non null unless extern weak
3449 // or an absolute symbol reference. Other address spaces may have null as a
3450 // valid address for a global, so we can't assume anything.
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003451 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
Peter Collingbourne235c2752016-12-08 19:01:00 +00003452 return !GV->isAbsoluteSymbolRef() && !GV->hasExternalWeakLinkage() &&
Pete Cooper6b716212015-08-27 03:16:29 +00003453 GV->getType()->getAddressSpace() == 0;
Benjamin Kramerfd4777c2013-09-24 16:37:51 +00003454
Sanjoy Das5056e192016-05-07 02:08:22 +00003455 // A Load tagged with nonnull metadata is never null.
Philip Reamescdb72f32014-10-20 22:40:55 +00003456 if (const LoadInst *LI = dyn_cast<LoadInst>(V))
Philip Reames5a3f5f72014-10-21 00:13:20 +00003457 return LI->getMetadata(LLVMContext::MD_nonnull);
Philip Reamescdb72f32014-10-20 22:40:55 +00003458
Benjamin Kramer3a09ef62015-04-10 14:50:08 +00003459 if (auto CS = ImmutableCallSite(V))
Hal Finkelb0407ba2014-07-18 15:51:28 +00003460 if (CS.isReturnNonNull())
Nick Lewyckyec373542014-05-20 05:13:21 +00003461 return true;
3462
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003463 return false;
3464}
David Majnemer491331a2015-01-02 07:29:43 +00003465
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003466static bool isKnownNonNullFromDominatingCondition(const Value *V,
3467 const Instruction *CtxI,
3468 const DominatorTree *DT) {
Chen Li0d043b52015-09-14 18:10:43 +00003469 assert(V->getType()->isPointerTy() && "V must be pointer type");
Duncan P. N. Exon Smithb4798732016-09-24 19:39:47 +00003470 assert(!isa<ConstantData>(V) && "Did not expect ConstantPointerNull");
Sanjay Patel7fd779f2016-12-31 17:37:01 +00003471 assert(CtxI && "Context instruction required for analysis");
3472 assert(DT && "Dominator tree required for analysis");
Chen Li0d043b52015-09-14 18:10:43 +00003473
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003474 unsigned NumUsesExplored = 0;
Sanjoy Das987aaa12016-05-07 02:08:24 +00003475 for (auto *U : V->users()) {
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003476 // Avoid massive lists
3477 if (NumUsesExplored >= DomConditionsMaxUses)
3478 break;
3479 NumUsesExplored++;
Sanjay Patel97e4b9872017-02-12 15:35:34 +00003480
3481 // If the value is used as an argument to a call or invoke, then argument
3482 // attributes may provide an answer about null-ness.
3483 if (auto CS = ImmutableCallSite(U))
3484 if (auto *CalledFunc = CS.getCalledFunction())
3485 for (const Argument &Arg : CalledFunc->args())
3486 if (CS.getArgOperand(Arg.getArgNo()) == V &&
3487 Arg.hasNonNullAttr() && DT->dominates(CS.getInstruction(), CtxI))
3488 return true;
3489
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003490 // Consider only compare instructions uniquely controlling a branch
Sanjoy Das987aaa12016-05-07 02:08:24 +00003491 CmpInst::Predicate Pred;
3492 if (!match(const_cast<User *>(U),
3493 m_c_ICmp(Pred, m_Specific(V), m_Zero())) ||
3494 (Pred != ICmpInst::ICMP_EQ && Pred != ICmpInst::ICMP_NE))
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003495 continue;
3496
Sanjoy Das987aaa12016-05-07 02:08:24 +00003497 for (auto *CmpU : U->users()) {
Sanjoy Das12c91dc2016-05-10 02:35:44 +00003498 if (const BranchInst *BI = dyn_cast<BranchInst>(CmpU)) {
3499 assert(BI->isConditional() && "uses a comparison!");
Sanjoy Das6082c1a2016-05-07 02:08:15 +00003500
Sanjoy Das12c91dc2016-05-10 02:35:44 +00003501 BasicBlock *NonNullSuccessor =
3502 BI->getSuccessor(Pred == ICmpInst::ICMP_EQ ? 1 : 0);
3503 BasicBlockEdge Edge(BI->getParent(), NonNullSuccessor);
3504 if (Edge.isSingleEdge() && DT->dominates(Edge, CtxI->getParent()))
3505 return true;
3506 } else if (Pred == ICmpInst::ICMP_NE &&
3507 match(CmpU, m_Intrinsic<Intrinsic::experimental_guard>()) &&
3508 DT->dominates(cast<Instruction>(CmpU), CtxI)) {
Sanjoy Das987aaa12016-05-07 02:08:24 +00003509 return true;
Sanjoy Das12c91dc2016-05-10 02:35:44 +00003510 }
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003511 }
3512 }
3513
3514 return false;
3515}
3516
3517bool llvm::isKnownNonNullAt(const Value *V, const Instruction *CtxI,
Sean Silva45835e72016-07-02 23:47:27 +00003518 const DominatorTree *DT) {
Duncan P. N. Exon Smithb4798732016-09-24 19:39:47 +00003519 if (isa<ConstantPointerNull>(V) || isa<UndefValue>(V))
3520 return false;
3521
Sean Silva45835e72016-07-02 23:47:27 +00003522 if (isKnownNonNull(V))
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003523 return true;
3524
Sanjay Patel7fd779f2016-12-31 17:37:01 +00003525 if (!CtxI || !DT)
3526 return false;
3527
3528 return ::isKnownNonNullFromDominatingCondition(V, CtxI, DT);
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003529}
3530
Pete Cooper35b00d52016-08-13 01:05:32 +00003531OverflowResult llvm::computeOverflowForUnsignedMul(const Value *LHS,
3532 const Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003533 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003534 AssumptionCache *AC,
David Majnemer491331a2015-01-02 07:29:43 +00003535 const Instruction *CxtI,
3536 const DominatorTree *DT) {
3537 // Multiplying n * m significant bits yields a result of n + m significant
3538 // bits. If the total number of significant bits does not exceed the
3539 // result bit width (minus 1), there is no overflow.
3540 // This means if we have enough leading zero bits in the operands
3541 // we can guarantee that the result does not overflow.
3542 // Ref: "Hacker's Delight" by Henry Warren
3543 unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
3544 APInt LHSKnownZero(BitWidth, 0);
David Majnemerc8a576b2015-01-02 07:29:47 +00003545 APInt LHSKnownOne(BitWidth, 0);
David Majnemer491331a2015-01-02 07:29:43 +00003546 APInt RHSKnownZero(BitWidth, 0);
David Majnemerc8a576b2015-01-02 07:29:47 +00003547 APInt RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003548 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, DL, /*Depth=*/0, AC, CxtI,
3549 DT);
3550 computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, DL, /*Depth=*/0, AC, CxtI,
3551 DT);
David Majnemer491331a2015-01-02 07:29:43 +00003552 // Note that underestimating the number of zero bits gives a more
3553 // conservative answer.
3554 unsigned ZeroBits = LHSKnownZero.countLeadingOnes() +
3555 RHSKnownZero.countLeadingOnes();
3556 // First handle the easy case: if we have enough zero bits there's
3557 // definitely no overflow.
3558 if (ZeroBits >= BitWidth)
3559 return OverflowResult::NeverOverflows;
3560
3561 // Get the largest possible values for each operand.
3562 APInt LHSMax = ~LHSKnownZero;
3563 APInt RHSMax = ~RHSKnownZero;
3564
3565 // We know the multiply operation doesn't overflow if the maximum values for
3566 // each operand will not overflow after we multiply them together.
David Majnemerc8a576b2015-01-02 07:29:47 +00003567 bool MaxOverflow;
3568 LHSMax.umul_ov(RHSMax, MaxOverflow);
3569 if (!MaxOverflow)
3570 return OverflowResult::NeverOverflows;
David Majnemer491331a2015-01-02 07:29:43 +00003571
David Majnemerc8a576b2015-01-02 07:29:47 +00003572 // We know it always overflows if multiplying the smallest possible values for
3573 // the operands also results in overflow.
3574 bool MinOverflow;
3575 LHSKnownOne.umul_ov(RHSKnownOne, MinOverflow);
3576 if (MinOverflow)
3577 return OverflowResult::AlwaysOverflows;
3578
3579 return OverflowResult::MayOverflow;
David Majnemer491331a2015-01-02 07:29:43 +00003580}
David Majnemer5310c1e2015-01-07 00:39:50 +00003581
Pete Cooper35b00d52016-08-13 01:05:32 +00003582OverflowResult llvm::computeOverflowForUnsignedAdd(const Value *LHS,
3583 const Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003584 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003585 AssumptionCache *AC,
David Majnemer5310c1e2015-01-07 00:39:50 +00003586 const Instruction *CxtI,
3587 const DominatorTree *DT) {
3588 bool LHSKnownNonNegative, LHSKnownNegative;
3589 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003590 AC, CxtI, DT);
David Majnemer5310c1e2015-01-07 00:39:50 +00003591 if (LHSKnownNonNegative || LHSKnownNegative) {
3592 bool RHSKnownNonNegative, RHSKnownNegative;
3593 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003594 AC, CxtI, DT);
David Majnemer5310c1e2015-01-07 00:39:50 +00003595
3596 if (LHSKnownNegative && RHSKnownNegative) {
3597 // The sign bit is set in both cases: this MUST overflow.
3598 // Create a simple add instruction, and insert it into the struct.
3599 return OverflowResult::AlwaysOverflows;
3600 }
3601
3602 if (LHSKnownNonNegative && RHSKnownNonNegative) {
3603 // The sign bit is clear in both cases: this CANNOT overflow.
3604 // Create a simple add instruction, and insert it into the struct.
3605 return OverflowResult::NeverOverflows;
3606 }
3607 }
3608
3609 return OverflowResult::MayOverflow;
3610}
James Molloy71b91c22015-05-11 14:42:20 +00003611
Pete Cooper35b00d52016-08-13 01:05:32 +00003612static OverflowResult computeOverflowForSignedAdd(const Value *LHS,
3613 const Value *RHS,
3614 const AddOperator *Add,
3615 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003616 AssumptionCache *AC,
Pete Cooper35b00d52016-08-13 01:05:32 +00003617 const Instruction *CxtI,
3618 const DominatorTree *DT) {
Jingyue Wu10fcea52015-08-20 18:27:04 +00003619 if (Add && Add->hasNoSignedWrap()) {
3620 return OverflowResult::NeverOverflows;
3621 }
3622
3623 bool LHSKnownNonNegative, LHSKnownNegative;
3624 bool RHSKnownNonNegative, RHSKnownNegative;
3625 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003626 AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003627 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003628 AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003629
3630 if ((LHSKnownNonNegative && RHSKnownNegative) ||
3631 (LHSKnownNegative && RHSKnownNonNegative)) {
3632 // The sign bits are opposite: this CANNOT overflow.
3633 return OverflowResult::NeverOverflows;
3634 }
3635
3636 // The remaining code needs Add to be available. Early returns if not so.
3637 if (!Add)
3638 return OverflowResult::MayOverflow;
3639
3640 // If the sign of Add is the same as at least one of the operands, this add
3641 // CANNOT overflow. This is particularly useful when the sum is
3642 // @llvm.assume'ed non-negative rather than proved so from analyzing its
3643 // operands.
3644 bool LHSOrRHSKnownNonNegative =
3645 (LHSKnownNonNegative || RHSKnownNonNegative);
3646 bool LHSOrRHSKnownNegative = (LHSKnownNegative || RHSKnownNegative);
3647 if (LHSOrRHSKnownNonNegative || LHSOrRHSKnownNegative) {
3648 bool AddKnownNonNegative, AddKnownNegative;
3649 ComputeSignBit(Add, AddKnownNonNegative, AddKnownNegative, DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003650 /*Depth=*/0, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003651 if ((AddKnownNonNegative && LHSOrRHSKnownNonNegative) ||
3652 (AddKnownNegative && LHSOrRHSKnownNegative)) {
3653 return OverflowResult::NeverOverflows;
3654 }
3655 }
3656
3657 return OverflowResult::MayOverflow;
3658}
3659
Pete Cooper35b00d52016-08-13 01:05:32 +00003660bool llvm::isOverflowIntrinsicNoWrap(const IntrinsicInst *II,
3661 const DominatorTree &DT) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003662#ifndef NDEBUG
3663 auto IID = II->getIntrinsicID();
3664 assert((IID == Intrinsic::sadd_with_overflow ||
3665 IID == Intrinsic::uadd_with_overflow ||
3666 IID == Intrinsic::ssub_with_overflow ||
3667 IID == Intrinsic::usub_with_overflow ||
3668 IID == Intrinsic::smul_with_overflow ||
3669 IID == Intrinsic::umul_with_overflow) &&
3670 "Not an overflow intrinsic!");
3671#endif
3672
Pete Cooper35b00d52016-08-13 01:05:32 +00003673 SmallVector<const BranchInst *, 2> GuardingBranches;
3674 SmallVector<const ExtractValueInst *, 2> Results;
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003675
Pete Cooper35b00d52016-08-13 01:05:32 +00003676 for (const User *U : II->users()) {
3677 if (const auto *EVI = dyn_cast<ExtractValueInst>(U)) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003678 assert(EVI->getNumIndices() == 1 && "Obvious from CI's type");
3679
3680 if (EVI->getIndices()[0] == 0)
3681 Results.push_back(EVI);
3682 else {
3683 assert(EVI->getIndices()[0] == 1 && "Obvious from CI's type");
3684
Pete Cooper35b00d52016-08-13 01:05:32 +00003685 for (const auto *U : EVI->users())
3686 if (const auto *B = dyn_cast<BranchInst>(U)) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003687 assert(B->isConditional() && "How else is it using an i1?");
3688 GuardingBranches.push_back(B);
3689 }
3690 }
3691 } else {
3692 // We are using the aggregate directly in a way we don't want to analyze
3693 // here (storing it to a global, say).
3694 return false;
3695 }
3696 }
3697
Pete Cooper35b00d52016-08-13 01:05:32 +00003698 auto AllUsesGuardedByBranch = [&](const BranchInst *BI) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003699 BasicBlockEdge NoWrapEdge(BI->getParent(), BI->getSuccessor(1));
3700 if (!NoWrapEdge.isSingleEdge())
3701 return false;
3702
3703 // Check if all users of the add are provably no-wrap.
Pete Cooper35b00d52016-08-13 01:05:32 +00003704 for (const auto *Result : Results) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003705 // If the extractvalue itself is not executed on overflow, the we don't
3706 // need to check each use separately, since domination is transitive.
3707 if (DT.dominates(NoWrapEdge, Result->getParent()))
3708 continue;
3709
3710 for (auto &RU : Result->uses())
3711 if (!DT.dominates(NoWrapEdge, RU))
3712 return false;
3713 }
3714
3715 return true;
3716 };
3717
3718 return any_of(GuardingBranches, AllUsesGuardedByBranch);
3719}
3720
3721
Pete Cooper35b00d52016-08-13 01:05:32 +00003722OverflowResult llvm::computeOverflowForSignedAdd(const AddOperator *Add,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003723 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003724 AssumptionCache *AC,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003725 const Instruction *CxtI,
3726 const DominatorTree *DT) {
3727 return ::computeOverflowForSignedAdd(Add->getOperand(0), Add->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003728 Add, DL, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003729}
3730
Pete Cooper35b00d52016-08-13 01:05:32 +00003731OverflowResult llvm::computeOverflowForSignedAdd(const Value *LHS,
3732 const Value *RHS,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003733 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003734 AssumptionCache *AC,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003735 const Instruction *CxtI,
3736 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003737 return ::computeOverflowForSignedAdd(LHS, RHS, nullptr, DL, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003738}
3739
Jingyue Wu42f1d672015-07-28 18:22:40 +00003740bool llvm::isGuaranteedToTransferExecutionToSuccessor(const Instruction *I) {
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003741 // A memory operation returns normally if it isn't volatile. A volatile
3742 // operation is allowed to trap.
3743 //
3744 // An atomic operation isn't guaranteed to return in a reasonable amount of
3745 // time because it's possible for another thread to interfere with it for an
3746 // arbitrary length of time, but programs aren't allowed to rely on that.
3747 if (const LoadInst *LI = dyn_cast<LoadInst>(I))
3748 return !LI->isVolatile();
3749 if (const StoreInst *SI = dyn_cast<StoreInst>(I))
3750 return !SI->isVolatile();
3751 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(I))
3752 return !CXI->isVolatile();
3753 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(I))
3754 return !RMWI->isVolatile();
3755 if (const MemIntrinsic *MII = dyn_cast<MemIntrinsic>(I))
3756 return !MII->isVolatile();
Jingyue Wu42f1d672015-07-28 18:22:40 +00003757
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003758 // If there is no successor, then execution can't transfer to it.
3759 if (const auto *CRI = dyn_cast<CleanupReturnInst>(I))
3760 return !CRI->unwindsToCaller();
3761 if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(I))
3762 return !CatchSwitch->unwindsToCaller();
3763 if (isa<ResumeInst>(I))
3764 return false;
3765 if (isa<ReturnInst>(I))
3766 return false;
Sebastian Pop4a4d2452017-03-08 01:54:50 +00003767 if (isa<UnreachableInst>(I))
3768 return false;
Sanjoy Das9a65cd22016-06-08 17:48:36 +00003769
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003770 // Calls can throw, or contain an infinite loop, or kill the process.
Sanjoy Das09455302016-12-31 22:12:31 +00003771 if (auto CS = ImmutableCallSite(I)) {
Sanjoy Das3bb2dbd2016-12-31 22:12:34 +00003772 // Call sites that throw have implicit non-local control flow.
3773 if (!CS.doesNotThrow())
3774 return false;
3775
3776 // Non-throwing call sites can loop infinitely, call exit/pthread_exit
3777 // etc. and thus not return. However, LLVM already assumes that
3778 //
3779 // - Thread exiting actions are modeled as writes to memory invisible to
3780 // the program.
3781 //
3782 // - Loops that don't have side effects (side effects are volatile/atomic
3783 // stores and IO) always terminate (see http://llvm.org/PR965).
3784 // Furthermore IO itself is also modeled as writes to memory invisible to
3785 // the program.
3786 //
3787 // We rely on those assumptions here, and use the memory effects of the call
3788 // target as a proxy for checking that it always returns.
3789
3790 // FIXME: This isn't aggressive enough; a call which only writes to a global
3791 // is guaranteed to return.
Sanjoy Dasd7e82062016-06-14 20:23:16 +00003792 return CS.onlyReadsMemory() || CS.onlyAccessesArgMemory() ||
3793 match(I, m_Intrinsic<Intrinsic::assume>());
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003794 }
3795
3796 // Other instructions return normally.
3797 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003798}
3799
3800bool llvm::isGuaranteedToExecuteForEveryIteration(const Instruction *I,
3801 const Loop *L) {
3802 // The loop header is guaranteed to be executed for every iteration.
3803 //
3804 // FIXME: Relax this constraint to cover all basic blocks that are
3805 // guaranteed to be executed at every iteration.
3806 if (I->getParent() != L->getHeader()) return false;
3807
3808 for (const Instruction &LI : *L->getHeader()) {
3809 if (&LI == I) return true;
3810 if (!isGuaranteedToTransferExecutionToSuccessor(&LI)) return false;
3811 }
3812 llvm_unreachable("Instruction not contained in its own parent basic block.");
3813}
3814
3815bool llvm::propagatesFullPoison(const Instruction *I) {
3816 switch (I->getOpcode()) {
Sanjoy Das7b0b4082017-02-21 02:42:42 +00003817 case Instruction::Add:
3818 case Instruction::Sub:
3819 case Instruction::Xor:
3820 case Instruction::Trunc:
3821 case Instruction::BitCast:
3822 case Instruction::AddrSpaceCast:
Sanjoy Das5cd6c5ca2017-02-22 06:52:32 +00003823 case Instruction::Mul:
3824 case Instruction::Shl:
3825 case Instruction::GetElementPtr:
Sanjoy Das7b0b4082017-02-21 02:42:42 +00003826 // These operations all propagate poison unconditionally. Note that poison
3827 // is not any particular value, so xor or subtraction of poison with
3828 // itself still yields poison, not zero.
3829 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003830
Sanjoy Das7b0b4082017-02-21 02:42:42 +00003831 case Instruction::AShr:
3832 case Instruction::SExt:
3833 // For these operations, one bit of the input is replicated across
3834 // multiple output bits. A replicated poison bit is still poison.
3835 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003836
Sanjoy Das7b0b4082017-02-21 02:42:42 +00003837 case Instruction::ICmp:
3838 // Comparing poison with any value yields poison. This is why, for
3839 // instance, x s< (x +nsw 1) can be folded to true.
3840 return true;
Sanjoy Das70c2bbd2016-05-29 00:31:18 +00003841
Sanjoy Das7b0b4082017-02-21 02:42:42 +00003842 default:
3843 return false;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003844 }
3845}
3846
3847const Value *llvm::getGuaranteedNonFullPoisonOp(const Instruction *I) {
3848 switch (I->getOpcode()) {
3849 case Instruction::Store:
3850 return cast<StoreInst>(I)->getPointerOperand();
3851
3852 case Instruction::Load:
3853 return cast<LoadInst>(I)->getPointerOperand();
3854
3855 case Instruction::AtomicCmpXchg:
3856 return cast<AtomicCmpXchgInst>(I)->getPointerOperand();
3857
3858 case Instruction::AtomicRMW:
3859 return cast<AtomicRMWInst>(I)->getPointerOperand();
3860
3861 case Instruction::UDiv:
3862 case Instruction::SDiv:
3863 case Instruction::URem:
3864 case Instruction::SRem:
3865 return I->getOperand(1);
3866
3867 default:
3868 return nullptr;
3869 }
3870}
3871
3872bool llvm::isKnownNotFullPoison(const Instruction *PoisonI) {
3873 // We currently only look for uses of poison values within the same basic
3874 // block, as that makes it easier to guarantee that the uses will be
3875 // executed given that PoisonI is executed.
3876 //
3877 // FIXME: Expand this to consider uses beyond the same basic block. To do
3878 // this, look out for the distinction between post-dominance and strong
3879 // post-dominance.
3880 const BasicBlock *BB = PoisonI->getParent();
3881
3882 // Set of instructions that we have proved will yield poison if PoisonI
3883 // does.
3884 SmallSet<const Value *, 16> YieldsPoison;
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003885 SmallSet<const BasicBlock *, 4> Visited;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003886 YieldsPoison.insert(PoisonI);
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003887 Visited.insert(PoisonI->getParent());
Jingyue Wu42f1d672015-07-28 18:22:40 +00003888
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003889 BasicBlock::const_iterator Begin = PoisonI->getIterator(), End = BB->end();
Jingyue Wu42f1d672015-07-28 18:22:40 +00003890
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003891 unsigned Iter = 0;
3892 while (Iter++ < MaxDepth) {
3893 for (auto &I : make_range(Begin, End)) {
3894 if (&I != PoisonI) {
3895 const Value *NotPoison = getGuaranteedNonFullPoisonOp(&I);
3896 if (NotPoison != nullptr && YieldsPoison.count(NotPoison))
3897 return true;
3898 if (!isGuaranteedToTransferExecutionToSuccessor(&I))
3899 return false;
3900 }
3901
3902 // Mark poison that propagates from I through uses of I.
3903 if (YieldsPoison.count(&I)) {
3904 for (const User *User : I.users()) {
3905 const Instruction *UserI = cast<Instruction>(User);
3906 if (propagatesFullPoison(UserI))
3907 YieldsPoison.insert(User);
3908 }
Jingyue Wu42f1d672015-07-28 18:22:40 +00003909 }
3910 }
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003911
3912 if (auto *NextBB = BB->getSingleSuccessor()) {
3913 if (Visited.insert(NextBB).second) {
3914 BB = NextBB;
3915 Begin = BB->getFirstNonPHI()->getIterator();
3916 End = BB->end();
3917 continue;
3918 }
3919 }
3920
3921 break;
3922 };
Jingyue Wu42f1d672015-07-28 18:22:40 +00003923 return false;
3924}
3925
Pete Cooper35b00d52016-08-13 01:05:32 +00003926static bool isKnownNonNaN(const Value *V, FastMathFlags FMF) {
James Molloy134bec22015-08-11 09:12:57 +00003927 if (FMF.noNaNs())
3928 return true;
3929
3930 if (auto *C = dyn_cast<ConstantFP>(V))
3931 return !C->isNaN();
3932 return false;
3933}
3934
Pete Cooper35b00d52016-08-13 01:05:32 +00003935static bool isKnownNonZero(const Value *V) {
James Molloy134bec22015-08-11 09:12:57 +00003936 if (auto *C = dyn_cast<ConstantFP>(V))
3937 return !C->isZero();
3938 return false;
3939}
3940
Sanjay Patel819f0962016-11-13 19:30:19 +00003941/// Match non-obvious integer minimum and maximum sequences.
3942static SelectPatternResult matchMinMax(CmpInst::Predicate Pred,
3943 Value *CmpLHS, Value *CmpRHS,
3944 Value *TrueVal, Value *FalseVal,
3945 Value *&LHS, Value *&RHS) {
Sanjay Patel24c6f882017-01-21 17:51:25 +00003946 // Assume success. If there's no match, callers should not use these anyway.
3947 LHS = TrueVal;
3948 RHS = FalseVal;
3949
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003950 // Recognize variations of:
3951 // CLAMP(v,l,h) ==> ((v) < (l) ? (l) : ((v) > (h) ? (h) : (v)))
3952 const APInt *C1;
3953 if (CmpRHS == TrueVal && match(CmpRHS, m_APInt(C1))) {
3954 const APInt *C2;
3955
3956 // (X <s C1) ? C1 : SMIN(X, C2) ==> SMAX(SMIN(X, C2), C1)
3957 if (match(FalseVal, m_SMin(m_Specific(CmpLHS), m_APInt(C2))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00003958 C1->slt(*C2) && Pred == CmpInst::ICMP_SLT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003959 return {SPF_SMAX, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003960
3961 // (X >s C1) ? C1 : SMAX(X, C2) ==> SMIN(SMAX(X, C2), C1)
3962 if (match(FalseVal, m_SMax(m_Specific(CmpLHS), m_APInt(C2))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00003963 C1->sgt(*C2) && Pred == CmpInst::ICMP_SGT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003964 return {SPF_SMIN, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003965
3966 // (X <u C1) ? C1 : UMIN(X, C2) ==> UMAX(UMIN(X, C2), C1)
3967 if (match(FalseVal, m_UMin(m_Specific(CmpLHS), m_APInt(C2))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00003968 C1->ult(*C2) && Pred == CmpInst::ICMP_ULT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003969 return {SPF_UMAX, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003970
3971 // (X >u C1) ? C1 : UMAX(X, C2) ==> UMIN(UMAX(X, C2), C1)
3972 if (match(FalseVal, m_UMax(m_Specific(CmpLHS), m_APInt(C2))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00003973 C1->ugt(*C2) && Pred == CmpInst::ICMP_UGT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003974 return {SPF_UMIN, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00003975 }
3976
Sanjay Patel819f0962016-11-13 19:30:19 +00003977 if (Pred != CmpInst::ICMP_SGT && Pred != CmpInst::ICMP_SLT)
3978 return {SPF_UNKNOWN, SPNB_NA, false};
3979
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00003980 // Z = X -nsw Y
3981 // (X >s Y) ? 0 : Z ==> (Z >s 0) ? 0 : Z ==> SMIN(Z, 0)
3982 // (X <s Y) ? 0 : Z ==> (Z <s 0) ? 0 : Z ==> SMAX(Z, 0)
3983 if (match(TrueVal, m_Zero()) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00003984 match(FalseVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS))))
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00003985 return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00003986
3987 // Z = X -nsw Y
3988 // (X >s Y) ? Z : 0 ==> (Z >s 0) ? Z : 0 ==> SMAX(Z, 0)
3989 // (X <s Y) ? Z : 0 ==> (Z <s 0) ? Z : 0 ==> SMIN(Z, 0)
3990 if (match(FalseVal, m_Zero()) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00003991 match(TrueVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS))))
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00003992 return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00003993
Sanjay Patel819f0962016-11-13 19:30:19 +00003994 if (!match(CmpRHS, m_APInt(C1)))
3995 return {SPF_UNKNOWN, SPNB_NA, false};
3996
3997 // An unsigned min/max can be written with a signed compare.
3998 const APInt *C2;
3999 if ((CmpLHS == TrueVal && match(FalseVal, m_APInt(C2))) ||
4000 (CmpLHS == FalseVal && match(TrueVal, m_APInt(C2)))) {
4001 // Is the sign bit set?
4002 // (X <s 0) ? X : MAXVAL ==> (X >u MAXVAL) ? X : MAXVAL ==> UMAX
4003 // (X <s 0) ? MAXVAL : X ==> (X >u MAXVAL) ? MAXVAL : X ==> UMIN
Sanjay Patel24c6f882017-01-21 17:51:25 +00004004 if (Pred == CmpInst::ICMP_SLT && *C1 == 0 && C2->isMaxSignedValue())
Sanjay Patel819f0962016-11-13 19:30:19 +00004005 return {CmpLHS == TrueVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004006
4007 // Is the sign bit clear?
4008 // (X >s -1) ? MINVAL : X ==> (X <u MINVAL) ? MINVAL : X ==> UMAX
4009 // (X >s -1) ? X : MINVAL ==> (X <u MINVAL) ? X : MINVAL ==> UMIN
4010 if (Pred == CmpInst::ICMP_SGT && C1->isAllOnesValue() &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004011 C2->isMinSignedValue())
Sanjay Patel819f0962016-11-13 19:30:19 +00004012 return {CmpLHS == FalseVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004013 }
4014
4015 // Look through 'not' ops to find disguised signed min/max.
4016 // (X >s C) ? ~X : ~C ==> (~X <s ~C) ? ~X : ~C ==> SMIN(~X, ~C)
4017 // (X <s C) ? ~X : ~C ==> (~X >s ~C) ? ~X : ~C ==> SMAX(~X, ~C)
4018 if (match(TrueVal, m_Not(m_Specific(CmpLHS))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004019 match(FalseVal, m_APInt(C2)) && ~(*C1) == *C2)
Sanjay Patel819f0962016-11-13 19:30:19 +00004020 return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004021
4022 // (X >s C) ? ~C : ~X ==> (~X <s ~C) ? ~C : ~X ==> SMAX(~C, ~X)
4023 // (X <s C) ? ~C : ~X ==> (~X >s ~C) ? ~C : ~X ==> SMIN(~C, ~X)
4024 if (match(FalseVal, m_Not(m_Specific(CmpLHS))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004025 match(TrueVal, m_APInt(C2)) && ~(*C1) == *C2)
Sanjay Patel819f0962016-11-13 19:30:19 +00004026 return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004027
4028 return {SPF_UNKNOWN, SPNB_NA, false};
4029}
4030
James Molloy134bec22015-08-11 09:12:57 +00004031static SelectPatternResult matchSelectPattern(CmpInst::Predicate Pred,
4032 FastMathFlags FMF,
James Molloy270ef8c2015-05-15 16:04:50 +00004033 Value *CmpLHS, Value *CmpRHS,
4034 Value *TrueVal, Value *FalseVal,
4035 Value *&LHS, Value *&RHS) {
James Molloy71b91c22015-05-11 14:42:20 +00004036 LHS = CmpLHS;
4037 RHS = CmpRHS;
4038
James Molloy134bec22015-08-11 09:12:57 +00004039 // If the predicate is an "or-equal" (FP) predicate, then signed zeroes may
4040 // return inconsistent results between implementations.
4041 // (0.0 <= -0.0) ? 0.0 : -0.0 // Returns 0.0
4042 // minNum(0.0, -0.0) // May return -0.0 or 0.0 (IEEE 754-2008 5.3.1)
4043 // Therefore we behave conservatively and only proceed if at least one of the
4044 // operands is known to not be zero, or if we don't care about signed zeroes.
4045 switch (Pred) {
4046 default: break;
4047 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLE:
4048 case CmpInst::FCMP_UGE: case CmpInst::FCMP_ULE:
4049 if (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
4050 !isKnownNonZero(CmpRHS))
4051 return {SPF_UNKNOWN, SPNB_NA, false};
4052 }
4053
4054 SelectPatternNaNBehavior NaNBehavior = SPNB_NA;
4055 bool Ordered = false;
4056
4057 // When given one NaN and one non-NaN input:
4058 // - maxnum/minnum (C99 fmaxf()/fminf()) return the non-NaN input.
4059 // - A simple C99 (a < b ? a : b) construction will return 'b' (as the
4060 // ordered comparison fails), which could be NaN or non-NaN.
4061 // so here we discover exactly what NaN behavior is required/accepted.
4062 if (CmpInst::isFPPredicate(Pred)) {
4063 bool LHSSafe = isKnownNonNaN(CmpLHS, FMF);
4064 bool RHSSafe = isKnownNonNaN(CmpRHS, FMF);
4065
4066 if (LHSSafe && RHSSafe) {
4067 // Both operands are known non-NaN.
4068 NaNBehavior = SPNB_RETURNS_ANY;
4069 } else if (CmpInst::isOrdered(Pred)) {
4070 // An ordered comparison will return false when given a NaN, so it
4071 // returns the RHS.
4072 Ordered = true;
4073 if (LHSSafe)
James Molloy8990b062015-08-12 15:11:43 +00004074 // LHS is non-NaN, so if RHS is NaN then NaN will be returned.
James Molloy134bec22015-08-11 09:12:57 +00004075 NaNBehavior = SPNB_RETURNS_NAN;
4076 else if (RHSSafe)
4077 NaNBehavior = SPNB_RETURNS_OTHER;
4078 else
4079 // Completely unsafe.
4080 return {SPF_UNKNOWN, SPNB_NA, false};
4081 } else {
4082 Ordered = false;
4083 // An unordered comparison will return true when given a NaN, so it
4084 // returns the LHS.
4085 if (LHSSafe)
James Molloy8990b062015-08-12 15:11:43 +00004086 // LHS is non-NaN, so if RHS is NaN then non-NaN will be returned.
James Molloy134bec22015-08-11 09:12:57 +00004087 NaNBehavior = SPNB_RETURNS_OTHER;
4088 else if (RHSSafe)
4089 NaNBehavior = SPNB_RETURNS_NAN;
4090 else
4091 // Completely unsafe.
4092 return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004093 }
4094 }
4095
James Molloy71b91c22015-05-11 14:42:20 +00004096 if (TrueVal == CmpRHS && FalseVal == CmpLHS) {
James Molloy134bec22015-08-11 09:12:57 +00004097 std::swap(CmpLHS, CmpRHS);
4098 Pred = CmpInst::getSwappedPredicate(Pred);
4099 if (NaNBehavior == SPNB_RETURNS_NAN)
4100 NaNBehavior = SPNB_RETURNS_OTHER;
4101 else if (NaNBehavior == SPNB_RETURNS_OTHER)
4102 NaNBehavior = SPNB_RETURNS_NAN;
4103 Ordered = !Ordered;
4104 }
4105
4106 // ([if]cmp X, Y) ? X : Y
4107 if (TrueVal == CmpLHS && FalseVal == CmpRHS) {
James Molloy71b91c22015-05-11 14:42:20 +00004108 switch (Pred) {
James Molloy134bec22015-08-11 09:12:57 +00004109 default: return {SPF_UNKNOWN, SPNB_NA, false}; // Equality.
James Molloy71b91c22015-05-11 14:42:20 +00004110 case ICmpInst::ICMP_UGT:
James Molloy134bec22015-08-11 09:12:57 +00004111 case ICmpInst::ICMP_UGE: return {SPF_UMAX, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004112 case ICmpInst::ICMP_SGT:
James Molloy134bec22015-08-11 09:12:57 +00004113 case ICmpInst::ICMP_SGE: return {SPF_SMAX, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004114 case ICmpInst::ICMP_ULT:
James Molloy134bec22015-08-11 09:12:57 +00004115 case ICmpInst::ICMP_ULE: return {SPF_UMIN, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004116 case ICmpInst::ICMP_SLT:
James Molloy134bec22015-08-11 09:12:57 +00004117 case ICmpInst::ICMP_SLE: return {SPF_SMIN, SPNB_NA, false};
4118 case FCmpInst::FCMP_UGT:
4119 case FCmpInst::FCMP_UGE:
4120 case FCmpInst::FCMP_OGT:
4121 case FCmpInst::FCMP_OGE: return {SPF_FMAXNUM, NaNBehavior, Ordered};
4122 case FCmpInst::FCMP_ULT:
4123 case FCmpInst::FCMP_ULE:
4124 case FCmpInst::FCMP_OLT:
4125 case FCmpInst::FCMP_OLE: return {SPF_FMINNUM, NaNBehavior, Ordered};
James Molloy71b91c22015-05-11 14:42:20 +00004126 }
4127 }
4128
Sanjay Patele372aec2016-10-27 15:26:10 +00004129 const APInt *C1;
4130 if (match(CmpRHS, m_APInt(C1))) {
James Molloy71b91c22015-05-11 14:42:20 +00004131 if ((CmpLHS == TrueVal && match(FalseVal, m_Neg(m_Specific(CmpLHS)))) ||
4132 (CmpLHS == FalseVal && match(TrueVal, m_Neg(m_Specific(CmpLHS))))) {
4133
4134 // ABS(X) ==> (X >s 0) ? X : -X and (X >s -1) ? X : -X
4135 // NABS(X) ==> (X >s 0) ? -X : X and (X >s -1) ? -X : X
Sanjay Patele372aec2016-10-27 15:26:10 +00004136 if (Pred == ICmpInst::ICMP_SGT && (*C1 == 0 || C1->isAllOnesValue())) {
James Molloy134bec22015-08-11 09:12:57 +00004137 return {(CmpLHS == TrueVal) ? SPF_ABS : SPF_NABS, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004138 }
4139
4140 // ABS(X) ==> (X <s 0) ? -X : X and (X <s 1) ? -X : X
4141 // NABS(X) ==> (X <s 0) ? X : -X and (X <s 1) ? X : -X
Sanjay Patele372aec2016-10-27 15:26:10 +00004142 if (Pred == ICmpInst::ICMP_SLT && (*C1 == 0 || *C1 == 1)) {
James Molloy134bec22015-08-11 09:12:57 +00004143 return {(CmpLHS == FalseVal) ? SPF_ABS : SPF_NABS, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004144 }
4145 }
James Molloy71b91c22015-05-11 14:42:20 +00004146 }
4147
Sanjay Patel819f0962016-11-13 19:30:19 +00004148 return matchMinMax(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, LHS, RHS);
James Molloy71b91c22015-05-11 14:42:20 +00004149}
James Molloy270ef8c2015-05-15 16:04:50 +00004150
James Molloy569cea62015-09-02 17:25:25 +00004151static Value *lookThroughCast(CmpInst *CmpI, Value *V1, Value *V2,
4152 Instruction::CastOps *CastOp) {
Sanjay Patel14a4b812017-01-29 16:34:57 +00004153 auto *Cast1 = dyn_cast<CastInst>(V1);
4154 if (!Cast1)
James Molloy270ef8c2015-05-15 16:04:50 +00004155 return nullptr;
James Molloy270ef8c2015-05-15 16:04:50 +00004156
Sanjay Patel14a4b812017-01-29 16:34:57 +00004157 *CastOp = Cast1->getOpcode();
4158 Type *SrcTy = Cast1->getSrcTy();
4159 if (auto *Cast2 = dyn_cast<CastInst>(V2)) {
4160 // If V1 and V2 are both the same cast from the same type, look through V1.
4161 if (*CastOp == Cast2->getOpcode() && SrcTy == Cast2->getSrcTy())
4162 return Cast2->getOperand(0);
James Molloy569cea62015-09-02 17:25:25 +00004163 return nullptr;
4164 }
4165
Sanjay Patel14a4b812017-01-29 16:34:57 +00004166 auto *C = dyn_cast<Constant>(V2);
4167 if (!C)
4168 return nullptr;
4169
David Majnemerd2a074b2016-04-29 18:40:34 +00004170 Constant *CastedTo = nullptr;
Sanjay Patel14a4b812017-01-29 16:34:57 +00004171 switch (*CastOp) {
4172 case Instruction::ZExt:
4173 if (CmpI->isUnsigned())
4174 CastedTo = ConstantExpr::getTrunc(C, SrcTy);
4175 break;
4176 case Instruction::SExt:
4177 if (CmpI->isSigned())
4178 CastedTo = ConstantExpr::getTrunc(C, SrcTy, true);
4179 break;
4180 case Instruction::Trunc:
4181 CastedTo = ConstantExpr::getIntegerCast(C, SrcTy, CmpI->isSigned());
4182 break;
4183 case Instruction::FPTrunc:
4184 CastedTo = ConstantExpr::getFPExtend(C, SrcTy, true);
4185 break;
4186 case Instruction::FPExt:
4187 CastedTo = ConstantExpr::getFPTrunc(C, SrcTy, true);
4188 break;
4189 case Instruction::FPToUI:
4190 CastedTo = ConstantExpr::getUIToFP(C, SrcTy, true);
4191 break;
4192 case Instruction::FPToSI:
4193 CastedTo = ConstantExpr::getSIToFP(C, SrcTy, true);
4194 break;
4195 case Instruction::UIToFP:
4196 CastedTo = ConstantExpr::getFPToUI(C, SrcTy, true);
4197 break;
4198 case Instruction::SIToFP:
4199 CastedTo = ConstantExpr::getFPToSI(C, SrcTy, true);
4200 break;
4201 default:
4202 break;
4203 }
David Majnemerd2a074b2016-04-29 18:40:34 +00004204
4205 if (!CastedTo)
4206 return nullptr;
4207
David Majnemerd2a074b2016-04-29 18:40:34 +00004208 // Make sure the cast doesn't lose any information.
Sanjay Patel14a4b812017-01-29 16:34:57 +00004209 Constant *CastedBack =
4210 ConstantExpr::getCast(*CastOp, CastedTo, C->getType(), true);
David Majnemerd2a074b2016-04-29 18:40:34 +00004211 if (CastedBack != C)
4212 return nullptr;
4213
4214 return CastedTo;
James Molloy270ef8c2015-05-15 16:04:50 +00004215}
4216
Sanjay Patele8dc0902016-05-23 17:57:54 +00004217SelectPatternResult llvm::matchSelectPattern(Value *V, Value *&LHS, Value *&RHS,
James Molloy270ef8c2015-05-15 16:04:50 +00004218 Instruction::CastOps *CastOp) {
4219 SelectInst *SI = dyn_cast<SelectInst>(V);
James Molloy134bec22015-08-11 09:12:57 +00004220 if (!SI) return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00004221
James Molloy134bec22015-08-11 09:12:57 +00004222 CmpInst *CmpI = dyn_cast<CmpInst>(SI->getCondition());
4223 if (!CmpI) return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00004224
James Molloy134bec22015-08-11 09:12:57 +00004225 CmpInst::Predicate Pred = CmpI->getPredicate();
James Molloy270ef8c2015-05-15 16:04:50 +00004226 Value *CmpLHS = CmpI->getOperand(0);
4227 Value *CmpRHS = CmpI->getOperand(1);
4228 Value *TrueVal = SI->getTrueValue();
4229 Value *FalseVal = SI->getFalseValue();
James Molloy134bec22015-08-11 09:12:57 +00004230 FastMathFlags FMF;
4231 if (isa<FPMathOperator>(CmpI))
4232 FMF = CmpI->getFastMathFlags();
James Molloy270ef8c2015-05-15 16:04:50 +00004233
4234 // Bail out early.
4235 if (CmpI->isEquality())
James Molloy134bec22015-08-11 09:12:57 +00004236 return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00004237
4238 // Deal with type mismatches.
4239 if (CastOp && CmpLHS->getType() != TrueVal->getType()) {
James Molloy569cea62015-09-02 17:25:25 +00004240 if (Value *C = lookThroughCast(CmpI, TrueVal, FalseVal, CastOp))
James Molloy134bec22015-08-11 09:12:57 +00004241 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
James Molloy270ef8c2015-05-15 16:04:50 +00004242 cast<CastInst>(TrueVal)->getOperand(0), C,
4243 LHS, RHS);
James Molloy569cea62015-09-02 17:25:25 +00004244 if (Value *C = lookThroughCast(CmpI, FalseVal, TrueVal, CastOp))
James Molloy134bec22015-08-11 09:12:57 +00004245 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
James Molloy270ef8c2015-05-15 16:04:50 +00004246 C, cast<CastInst>(FalseVal)->getOperand(0),
4247 LHS, RHS);
4248 }
James Molloy134bec22015-08-11 09:12:57 +00004249 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS, TrueVal, FalseVal,
James Molloy270ef8c2015-05-15 16:04:50 +00004250 LHS, RHS);
4251}
Sanjoy Dasa7e13782015-10-24 05:37:35 +00004252
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004253/// Return true if "icmp Pred LHS RHS" is always true.
Pete Cooper35b00d52016-08-13 01:05:32 +00004254static bool isTruePredicate(CmpInst::Predicate Pred,
4255 const Value *LHS, const Value *RHS,
Sanjoy Das55ea67c2015-11-06 19:01:08 +00004256 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004257 AssumptionCache *AC, const Instruction *CxtI,
4258 const DominatorTree *DT) {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004259 assert(!LHS->getType()->isVectorTy() && "TODO: extend to handle vectors!");
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004260 if (ICmpInst::isTrueWhenEqual(Pred) && LHS == RHS)
4261 return true;
4262
4263 switch (Pred) {
4264 default:
4265 return false;
4266
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004267 case CmpInst::ICMP_SLE: {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004268 const APInt *C;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004269
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004270 // LHS s<= LHS +_{nsw} C if C >= 0
Sanjoy Dasdc26df42015-11-11 00:16:41 +00004271 if (match(RHS, m_NSWAdd(m_Specific(LHS), m_APInt(C))))
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004272 return !C->isNegative();
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004273 return false;
4274 }
4275
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004276 case CmpInst::ICMP_ULE: {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004277 const APInt *C;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004278
Sanjoy Dasdc26df42015-11-11 00:16:41 +00004279 // LHS u<= LHS +_{nuw} C for any C
4280 if (match(RHS, m_NUWAdd(m_Specific(LHS), m_APInt(C))))
Sanjoy Dasc01b4d22015-11-06 19:01:03 +00004281 return true;
Sanjoy Das92568102015-11-10 23:56:20 +00004282
4283 // Match A to (X +_{nuw} CA) and B to (X +_{nuw} CB)
Pete Cooper35b00d52016-08-13 01:05:32 +00004284 auto MatchNUWAddsToSameValue = [&](const Value *A, const Value *B,
4285 const Value *&X,
Sanjoy Das92568102015-11-10 23:56:20 +00004286 const APInt *&CA, const APInt *&CB) {
4287 if (match(A, m_NUWAdd(m_Value(X), m_APInt(CA))) &&
4288 match(B, m_NUWAdd(m_Specific(X), m_APInt(CB))))
4289 return true;
4290
4291 // If X & C == 0 then (X | C) == X +_{nuw} C
4292 if (match(A, m_Or(m_Value(X), m_APInt(CA))) &&
4293 match(B, m_Or(m_Specific(X), m_APInt(CB)))) {
4294 unsigned BitWidth = CA->getBitWidth();
4295 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004296 computeKnownBits(X, KnownZero, KnownOne, DL, Depth + 1, AC, CxtI, DT);
Sanjoy Das92568102015-11-10 23:56:20 +00004297
4298 if ((KnownZero & *CA) == *CA && (KnownZero & *CB) == *CB)
4299 return true;
4300 }
4301
4302 return false;
4303 };
4304
Pete Cooper35b00d52016-08-13 01:05:32 +00004305 const Value *X;
Sanjoy Das92568102015-11-10 23:56:20 +00004306 const APInt *CLHS, *CRHS;
Sanjoy Dasdc26df42015-11-11 00:16:41 +00004307 if (MatchNUWAddsToSameValue(LHS, RHS, X, CLHS, CRHS))
4308 return CLHS->ule(*CRHS);
Sanjoy Das92568102015-11-10 23:56:20 +00004309
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004310 return false;
4311 }
4312 }
4313}
4314
4315/// Return true if "icmp Pred BLHS BRHS" is true whenever "icmp Pred
Chad Rosier41dd31f2016-04-20 19:15:26 +00004316/// ALHS ARHS" is true. Otherwise, return None.
4317static Optional<bool>
Pete Cooper35b00d52016-08-13 01:05:32 +00004318isImpliedCondOperands(CmpInst::Predicate Pred, const Value *ALHS,
4319 const Value *ARHS, const Value *BLHS,
4320 const Value *BRHS, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004321 unsigned Depth, AssumptionCache *AC,
4322 const Instruction *CxtI, const DominatorTree *DT) {
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004323 switch (Pred) {
4324 default:
Chad Rosier41dd31f2016-04-20 19:15:26 +00004325 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004326
4327 case CmpInst::ICMP_SLT:
4328 case CmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004329 if (isTruePredicate(CmpInst::ICMP_SLE, BLHS, ALHS, DL, Depth, AC, CxtI,
Chad Rosier41dd31f2016-04-20 19:15:26 +00004330 DT) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004331 isTruePredicate(CmpInst::ICMP_SLE, ARHS, BRHS, DL, Depth, AC, CxtI, DT))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004332 return true;
4333 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004334
4335 case CmpInst::ICMP_ULT:
4336 case CmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004337 if (isTruePredicate(CmpInst::ICMP_ULE, BLHS, ALHS, DL, Depth, AC, CxtI,
4338 DT) &&
4339 isTruePredicate(CmpInst::ICMP_ULE, ARHS, BRHS, DL, Depth, AC, CxtI, DT))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004340 return true;
4341 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004342 }
4343}
4344
Chad Rosier226a7342016-05-05 17:41:19 +00004345/// Return true if the operands of the two compares match. IsSwappedOps is true
4346/// when the operands match, but are swapped.
Pete Cooper35b00d52016-08-13 01:05:32 +00004347static bool isMatchingOps(const Value *ALHS, const Value *ARHS,
4348 const Value *BLHS, const Value *BRHS,
Chad Rosier226a7342016-05-05 17:41:19 +00004349 bool &IsSwappedOps) {
4350
4351 bool IsMatchingOps = (ALHS == BLHS && ARHS == BRHS);
4352 IsSwappedOps = (ALHS == BRHS && ARHS == BLHS);
4353 return IsMatchingOps || IsSwappedOps;
4354}
4355
Chad Rosier41dd31f2016-04-20 19:15:26 +00004356/// Return true if "icmp1 APred ALHS ARHS" implies "icmp2 BPred BLHS BRHS" is
4357/// true. Return false if "icmp1 APred ALHS ARHS" implies "icmp2 BPred BLHS
4358/// BRHS" is false. Otherwise, return None if we can't infer anything.
4359static Optional<bool> isImpliedCondMatchingOperands(CmpInst::Predicate APred,
Pete Cooper35b00d52016-08-13 01:05:32 +00004360 const Value *ALHS,
4361 const Value *ARHS,
Chad Rosier41dd31f2016-04-20 19:15:26 +00004362 CmpInst::Predicate BPred,
Pete Cooper35b00d52016-08-13 01:05:32 +00004363 const Value *BLHS,
4364 const Value *BRHS,
Chad Rosier226a7342016-05-05 17:41:19 +00004365 bool IsSwappedOps) {
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004366 // Canonicalize the operands so they're matching.
4367 if (IsSwappedOps) {
4368 std::swap(BLHS, BRHS);
4369 BPred = ICmpInst::getSwappedPredicate(BPred);
4370 }
Chad Rosier99bc4802016-04-21 16:18:02 +00004371 if (CmpInst::isImpliedTrueByMatchingCmp(APred, BPred))
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004372 return true;
Chad Rosier99bc4802016-04-21 16:18:02 +00004373 if (CmpInst::isImpliedFalseByMatchingCmp(APred, BPred))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004374 return false;
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004375
Chad Rosier41dd31f2016-04-20 19:15:26 +00004376 return None;
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004377}
4378
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004379/// Return true if "icmp1 APred ALHS C1" implies "icmp2 BPred BLHS C2" is
4380/// true. Return false if "icmp1 APred ALHS C1" implies "icmp2 BPred BLHS
4381/// C2" is false. Otherwise, return None if we can't infer anything.
4382static Optional<bool>
Pete Cooper35b00d52016-08-13 01:05:32 +00004383isImpliedCondMatchingImmOperands(CmpInst::Predicate APred, const Value *ALHS,
4384 const ConstantInt *C1,
4385 CmpInst::Predicate BPred,
4386 const Value *BLHS, const ConstantInt *C2) {
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004387 assert(ALHS == BLHS && "LHS operands must match.");
4388 ConstantRange DomCR =
4389 ConstantRange::makeExactICmpRegion(APred, C1->getValue());
4390 ConstantRange CR =
4391 ConstantRange::makeAllowedICmpRegion(BPred, C2->getValue());
4392 ConstantRange Intersection = DomCR.intersectWith(CR);
4393 ConstantRange Difference = DomCR.difference(CR);
4394 if (Intersection.isEmptySet())
4395 return false;
4396 if (Difference.isEmptySet())
4397 return true;
4398 return None;
4399}
4400
Pete Cooper35b00d52016-08-13 01:05:32 +00004401Optional<bool> llvm::isImpliedCondition(const Value *LHS, const Value *RHS,
Chad Rosiere2cbd132016-04-25 17:23:36 +00004402 const DataLayout &DL, bool InvertAPred,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004403 unsigned Depth, AssumptionCache *AC,
4404 const Instruction *CxtI,
Chad Rosier41dd31f2016-04-20 19:15:26 +00004405 const DominatorTree *DT) {
Chad Rosiercd62bf52016-04-29 21:12:31 +00004406 // A mismatch occurs when we compare a scalar cmp to a vector cmp, for example.
4407 if (LHS->getType() != RHS->getType())
4408 return None;
4409
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004410 Type *OpTy = LHS->getType();
4411 assert(OpTy->getScalarType()->isIntegerTy(1));
4412
4413 // LHS ==> RHS by definition
Chad Rosiere2cbd132016-04-25 17:23:36 +00004414 if (!InvertAPred && LHS == RHS)
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004415 return true;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004416
4417 if (OpTy->isVectorTy())
4418 // TODO: extending the code below to handle vectors
Chad Rosier41dd31f2016-04-20 19:15:26 +00004419 return None;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004420 assert(OpTy->isIntegerTy(1) && "implied by above");
4421
4422 ICmpInst::Predicate APred, BPred;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004423 Value *ALHS, *ARHS;
4424 Value *BLHS, *BRHS;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004425
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004426 if (!match(LHS, m_ICmp(APred, m_Value(ALHS), m_Value(ARHS))) ||
4427 !match(RHS, m_ICmp(BPred, m_Value(BLHS), m_Value(BRHS))))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004428 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004429
Chad Rosiere2cbd132016-04-25 17:23:36 +00004430 if (InvertAPred)
4431 APred = CmpInst::getInversePredicate(APred);
4432
Chad Rosier226a7342016-05-05 17:41:19 +00004433 // Can we infer anything when the two compares have matching operands?
4434 bool IsSwappedOps;
4435 if (isMatchingOps(ALHS, ARHS, BLHS, BRHS, IsSwappedOps)) {
4436 if (Optional<bool> Implication = isImpliedCondMatchingOperands(
4437 APred, ALHS, ARHS, BPred, BLHS, BRHS, IsSwappedOps))
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004438 return Implication;
Chad Rosier226a7342016-05-05 17:41:19 +00004439 // No amount of additional analysis will infer the second condition, so
4440 // early exit.
4441 return None;
4442 }
4443
4444 // Can we infer anything when the LHS operands match and the RHS operands are
4445 // constants (not necessarily matching)?
4446 if (ALHS == BLHS && isa<ConstantInt>(ARHS) && isa<ConstantInt>(BRHS)) {
4447 if (Optional<bool> Implication = isImpliedCondMatchingImmOperands(
4448 APred, ALHS, cast<ConstantInt>(ARHS), BPred, BLHS,
4449 cast<ConstantInt>(BRHS)))
4450 return Implication;
4451 // No amount of additional analysis will infer the second condition, so
4452 // early exit.
4453 return None;
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004454 }
4455
Chad Rosier41dd31f2016-04-20 19:15:26 +00004456 if (APred == BPred)
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004457 return isImpliedCondOperands(APred, ALHS, ARHS, BLHS, BRHS, DL, Depth, AC,
4458 CxtI, DT);
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004459
Chad Rosier41dd31f2016-04-20 19:15:26 +00004460 return None;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004461}