blob: f6e3886f652e02512f299b197f2b56beccbf483b [file] [log] [blame]
Chris Lattner965c7692008-06-02 01:18:21 +00001//===- ValueTracking.cpp - Walk computations to compute properties --------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattner965c7692008-06-02 01:18:21 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This file contains routines that help analyze properties that chains of
10// computations have.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Analysis/ValueTracking.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000015#include "llvm/ADT/APFloat.h"
16#include "llvm/ADT/APInt.h"
17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/None.h"
James Molloy493e57d2015-10-26 14:10:46 +000019#include "llvm/ADT/Optional.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000020#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000022#include "llvm/ADT/SmallSet.h"
23#include "llvm/ADT/SmallVector.h"
24#include "llvm/ADT/StringRef.h"
25#include "llvm/ADT/iterator_range.h"
26#include "llvm/Analysis/AliasAnalysis.h"
Daniel Jasperaec2fa32016-12-19 08:22:17 +000027#include "llvm/Analysis/AssumptionCache.h"
Max Kazantsev3c284bd2018-08-30 03:39:16 +000028#include "llvm/Analysis/GuardUtils.h"
Dan Gohman949ab782010-12-15 20:10:26 +000029#include "llvm/Analysis/InstructionSimplify.h"
Artur Pilipenko31bcca42016-02-24 12:49:04 +000030#include "llvm/Analysis/Loads.h"
Adam Nemete2b885c2015-04-23 20:09:20 +000031#include "llvm/Analysis/LoopInfo.h"
Adam Nemet0965da22017-10-09 23:19:02 +000032#include "llvm/Analysis/OptimizationRemarkEmitter.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000033#include "llvm/Analysis/TargetLibraryInfo.h"
34#include "llvm/IR/Argument.h"
35#include "llvm/IR/Attributes.h"
36#include "llvm/IR/BasicBlock.h"
Nick Lewyckyec373542014-05-20 05:13:21 +000037#include "llvm/IR/CallSite.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000038#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000039#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000040#include "llvm/IR/Constants.h"
41#include "llvm/IR/DataLayout.h"
Matthias Braun50ec0b52017-05-19 22:37:09 +000042#include "llvm/IR/DerivedTypes.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000043#include "llvm/IR/DiagnosticInfo.h"
Hal Finkel60db0582014-09-07 18:57:58 +000044#include "llvm/IR/Dominators.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000045#include "llvm/IR/Function.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000046#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000047#include "llvm/IR/GlobalAlias.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000048#include "llvm/IR/GlobalValue.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000049#include "llvm/IR/GlobalVariable.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000050#include "llvm/IR/InstrTypes.h"
51#include "llvm/IR/Instruction.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000052#include "llvm/IR/Instructions.h"
53#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000054#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000055#include "llvm/IR/LLVMContext.h"
56#include "llvm/IR/Metadata.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000057#include "llvm/IR/Module.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000058#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000059#include "llvm/IR/PatternMatch.h"
Eugene Zelenko75075ef2017-09-01 21:37:29 +000060#include "llvm/IR/Type.h"
61#include "llvm/IR/User.h"
62#include "llvm/IR/Value.h"
63#include "llvm/Support/Casting.h"
64#include "llvm/Support/CommandLine.h"
65#include "llvm/Support/Compiler.h"
66#include "llvm/Support/ErrorHandling.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000067#include "llvm/Support/KnownBits.h"
Chris Lattner965c7692008-06-02 01:18:21 +000068#include "llvm/Support/MathExtras.h"
Matthias Braun37e5d792016-01-28 06:29:33 +000069#include <algorithm>
70#include <array>
Eugene Zelenko75075ef2017-09-01 21:37:29 +000071#include <cassert>
72#include <cstdint>
73#include <iterator>
Fangrui Songf78650a2018-07-30 19:41:25 +000074#include <utility>
Eugene Zelenko75075ef2017-09-01 21:37:29 +000075
Chris Lattner965c7692008-06-02 01:18:21 +000076using namespace llvm;
Duncan Sandsd3951082011-01-25 09:38:29 +000077using namespace llvm::PatternMatch;
78
79const unsigned MaxDepth = 6;
80
Philip Reames1c292272015-03-10 22:43:20 +000081// Controls the number of uses of the value searched for possible
82// dominating comparisons.
83static cl::opt<unsigned> DomConditionsMaxUses("dom-conditions-max-uses",
Igor Laevskycea9ede2015-09-29 14:57:52 +000084 cl::Hidden, cl::init(20));
Philip Reames1c292272015-03-10 22:43:20 +000085
Craig Topper6b3940a2017-05-03 22:25:19 +000086/// Returns the bitwidth of the given scalar or pointer type. For vector types,
87/// returns the element type's bitwidth.
Mehdi Aminia28d91d2015-03-10 02:37:25 +000088static unsigned getBitWidth(Type *Ty, const DataLayout &DL) {
Duncan Sandsd3951082011-01-25 09:38:29 +000089 if (unsigned BitWidth = Ty->getScalarSizeInBits())
90 return BitWidth;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +000091
Elena Demikhovsky945b7e52018-02-14 06:58:08 +000092 return DL.getIndexTypeSizeInBits(Ty);
Duncan Sandsd3951082011-01-25 09:38:29 +000093}
Chris Lattner965c7692008-06-02 01:18:21 +000094
Benjamin Kramercfd8d902014-09-12 08:56:53 +000095namespace {
Eugene Zelenko75075ef2017-09-01 21:37:29 +000096
Hal Finkel60db0582014-09-07 18:57:58 +000097// Simplifying using an assume can only be done in a particular control-flow
98// context (the context instruction provides that context). If an assume and
99// the context instruction are not in the same block then the DT helps in
100// figuring out if we can use it.
101struct Query {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000102 const DataLayout &DL;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000103 AssumptionCache *AC;
Hal Finkel60db0582014-09-07 18:57:58 +0000104 const Instruction *CxtI;
105 const DominatorTree *DT;
Eugene Zelenko75075ef2017-09-01 21:37:29 +0000106
Sanjay Patel54656ca2017-02-06 18:26:06 +0000107 // Unlike the other analyses, this may be a nullptr because not all clients
108 // provide it currently.
109 OptimizationRemarkEmitter *ORE;
Hal Finkel60db0582014-09-07 18:57:58 +0000110
Matthias Braun37e5d792016-01-28 06:29:33 +0000111 /// Set of assumptions that should be excluded from further queries.
112 /// This is because of the potential for mutual recursion to cause
113 /// computeKnownBits to repeatedly visit the same assume intrinsic. The
114 /// classic case of this is assume(x = y), which will attempt to determine
115 /// bits in x from bits in y, which will attempt to determine bits in y from
116 /// bits in x, etc. Regarding the mutual recursion, computeKnownBits can call
Craig Topper6e11a052017-05-08 16:22:48 +0000117 /// isKnownNonZero, which calls computeKnownBits and isKnownToBeAPowerOfTwo
118 /// (all of which can call computeKnownBits), and so on.
Li Huang755f75f2016-10-15 19:00:04 +0000119 std::array<const Value *, MaxDepth> Excluded;
Eugene Zelenko75075ef2017-09-01 21:37:29 +0000120
Florian Hahn19f9e322018-08-17 14:39:04 +0000121 /// If true, it is safe to use metadata during simplification.
122 InstrInfoQuery IIQ;
123
Eugene Zelenko75075ef2017-09-01 21:37:29 +0000124 unsigned NumExcluded = 0;
Matthias Braun37e5d792016-01-28 06:29:33 +0000125
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000126 Query(const DataLayout &DL, AssumptionCache *AC, const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +0000127 const DominatorTree *DT, bool UseInstrInfo,
128 OptimizationRemarkEmitter *ORE = nullptr)
129 : DL(DL), AC(AC), CxtI(CxtI), DT(DT), ORE(ORE), IIQ(UseInstrInfo) {}
Hal Finkel60db0582014-09-07 18:57:58 +0000130
131 Query(const Query &Q, const Value *NewExcl)
Florian Hahn19f9e322018-08-17 14:39:04 +0000132 : DL(Q.DL), AC(Q.AC), CxtI(Q.CxtI), DT(Q.DT), ORE(Q.ORE), IIQ(Q.IIQ),
Sanjay Patel54656ca2017-02-06 18:26:06 +0000133 NumExcluded(Q.NumExcluded) {
Matthias Braun37e5d792016-01-28 06:29:33 +0000134 Excluded = Q.Excluded;
135 Excluded[NumExcluded++] = NewExcl;
136 assert(NumExcluded <= Excluded.size());
137 }
138
139 bool isExcluded(const Value *Value) const {
140 if (NumExcluded == 0)
141 return false;
142 auto End = Excluded.begin() + NumExcluded;
143 return std::find(Excluded.begin(), End, Value) != End;
Hal Finkel60db0582014-09-07 18:57:58 +0000144 }
145};
Eugene Zelenko75075ef2017-09-01 21:37:29 +0000146
Benjamin Kramercfd8d902014-09-12 08:56:53 +0000147} // end anonymous namespace
Hal Finkel60db0582014-09-07 18:57:58 +0000148
Sanjay Patel547e9752014-11-04 16:09:50 +0000149// Given the provided Value and, potentially, a context instruction, return
Hal Finkel60db0582014-09-07 18:57:58 +0000150// the preferred context instruction (if any).
151static const Instruction *safeCxtI(const Value *V, const Instruction *CxtI) {
152 // If we've been provided with a context instruction, then use that (provided
153 // it has been inserted).
154 if (CxtI && CxtI->getParent())
155 return CxtI;
156
157 // If the value is really an already-inserted instruction, then use that.
158 CxtI = dyn_cast<Instruction>(V);
159 if (CxtI && CxtI->getParent())
160 return CxtI;
161
162 return nullptr;
163}
164
Craig Topperb45eabc2017-04-26 16:39:58 +0000165static void computeKnownBits(const Value *V, KnownBits &Known,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000166 unsigned Depth, const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000167
Craig Topperb45eabc2017-04-26 16:39:58 +0000168void llvm::computeKnownBits(const Value *V, KnownBits &Known,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000169 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000170 AssumptionCache *AC, const Instruction *CxtI,
Sanjay Patel54656ca2017-02-06 18:26:06 +0000171 const DominatorTree *DT,
Florian Hahn19f9e322018-08-17 14:39:04 +0000172 OptimizationRemarkEmitter *ORE, bool UseInstrInfo) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000173 ::computeKnownBits(V, Known, Depth,
Florian Hahn19f9e322018-08-17 14:39:04 +0000174 Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo, ORE));
Hal Finkel60db0582014-09-07 18:57:58 +0000175}
176
Craig Topper6e11a052017-05-08 16:22:48 +0000177static KnownBits computeKnownBits(const Value *V, unsigned Depth,
178 const Query &Q);
179
180KnownBits llvm::computeKnownBits(const Value *V, const DataLayout &DL,
181 unsigned Depth, AssumptionCache *AC,
182 const Instruction *CxtI,
Craig Toppera2025ea2017-05-24 16:53:03 +0000183 const DominatorTree *DT,
Florian Hahn19f9e322018-08-17 14:39:04 +0000184 OptimizationRemarkEmitter *ORE,
185 bool UseInstrInfo) {
186 return ::computeKnownBits(
187 V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo, ORE));
Craig Topper6e11a052017-05-08 16:22:48 +0000188}
189
Pete Cooper35b00d52016-08-13 01:05:32 +0000190bool llvm::haveNoCommonBitsSet(const Value *LHS, const Value *RHS,
Florian Hahn19f9e322018-08-17 14:39:04 +0000191 const DataLayout &DL, AssumptionCache *AC,
192 const Instruction *CxtI, const DominatorTree *DT,
193 bool UseInstrInfo) {
Jingyue Wuca321902015-05-14 23:53:19 +0000194 assert(LHS->getType() == RHS->getType() &&
195 "LHS and RHS should have the same type");
196 assert(LHS->getType()->isIntOrIntVectorTy() &&
197 "LHS and RHS should be integers");
Roman Lebedev620b3da2018-04-15 18:59:33 +0000198 // Look for an inverted mask: (X & ~M) op (Y & M).
199 Value *M;
200 if (match(LHS, m_c_And(m_Not(m_Value(M)), m_Value())) &&
201 match(RHS, m_c_And(m_Specific(M), m_Value())))
202 return true;
203 if (match(RHS, m_c_And(m_Not(m_Value(M)), m_Value())) &&
204 match(LHS, m_c_And(m_Specific(M), m_Value())))
205 return true;
Jingyue Wuca321902015-05-14 23:53:19 +0000206 IntegerType *IT = cast<IntegerType>(LHS->getType()->getScalarType());
Craig Topperb45eabc2017-04-26 16:39:58 +0000207 KnownBits LHSKnown(IT->getBitWidth());
208 KnownBits RHSKnown(IT->getBitWidth());
Florian Hahn19f9e322018-08-17 14:39:04 +0000209 computeKnownBits(LHS, LHSKnown, DL, 0, AC, CxtI, DT, nullptr, UseInstrInfo);
210 computeKnownBits(RHS, RHSKnown, DL, 0, AC, CxtI, DT, nullptr, UseInstrInfo);
Craig Topperb45eabc2017-04-26 16:39:58 +0000211 return (LHSKnown.Zero | RHSKnown.Zero).isAllOnesValue();
Jingyue Wuca321902015-05-14 23:53:19 +0000212}
213
Zaara Syeda3a7578c2017-05-31 17:12:38 +0000214bool llvm::isOnlyUsedInZeroEqualityComparison(const Instruction *CxtI) {
215 for (const User *U : CxtI->users()) {
216 if (const ICmpInst *IC = dyn_cast<ICmpInst>(U))
217 if (IC->isEquality())
218 if (Constant *C = dyn_cast<Constant>(IC->getOperand(1)))
219 if (C->isNullValue())
220 continue;
221 return false;
222 }
223 return true;
224}
225
Pete Cooper35b00d52016-08-13 01:05:32 +0000226static bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000227 const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000228
Pete Cooper35b00d52016-08-13 01:05:32 +0000229bool llvm::isKnownToBeAPowerOfTwo(const Value *V, const DataLayout &DL,
Florian Hahn19f9e322018-08-17 14:39:04 +0000230 bool OrZero, unsigned Depth,
231 AssumptionCache *AC, const Instruction *CxtI,
232 const DominatorTree *DT, bool UseInstrInfo) {
233 return ::isKnownToBeAPowerOfTwo(
234 V, OrZero, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000235}
236
Pete Cooper35b00d52016-08-13 01:05:32 +0000237static bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000238
Pete Cooper35b00d52016-08-13 01:05:32 +0000239bool llvm::isKnownNonZero(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000240 AssumptionCache *AC, const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +0000241 const DominatorTree *DT, bool UseInstrInfo) {
242 return ::isKnownNonZero(V, Depth,
243 Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000244}
245
Pete Cooper35b00d52016-08-13 01:05:32 +0000246bool llvm::isKnownNonNegative(const Value *V, const DataLayout &DL,
Florian Hahn19f9e322018-08-17 14:39:04 +0000247 unsigned Depth, AssumptionCache *AC,
248 const Instruction *CxtI, const DominatorTree *DT,
249 bool UseInstrInfo) {
250 KnownBits Known =
251 computeKnownBits(V, DL, Depth, AC, CxtI, DT, nullptr, UseInstrInfo);
Craig Topper6e11a052017-05-08 16:22:48 +0000252 return Known.isNonNegative();
Jingyue Wu10fcea52015-08-20 18:27:04 +0000253}
254
Pete Cooper35b00d52016-08-13 01:05:32 +0000255bool llvm::isKnownPositive(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000256 AssumptionCache *AC, const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +0000257 const DominatorTree *DT, bool UseInstrInfo) {
Philip Reames8f12eba2016-03-09 21:31:47 +0000258 if (auto *CI = dyn_cast<ConstantInt>(V))
259 return CI->getValue().isStrictlyPositive();
Sanjoy Das6082c1a2016-05-07 02:08:15 +0000260
Philip Reames8f12eba2016-03-09 21:31:47 +0000261 // TODO: We'd doing two recursive queries here. We should factor this such
262 // that only a single query is needed.
Florian Hahn19f9e322018-08-17 14:39:04 +0000263 return isKnownNonNegative(V, DL, Depth, AC, CxtI, DT, UseInstrInfo) &&
264 isKnownNonZero(V, DL, Depth, AC, CxtI, DT, UseInstrInfo);
Philip Reames8f12eba2016-03-09 21:31:47 +0000265}
266
Pete Cooper35b00d52016-08-13 01:05:32 +0000267bool llvm::isKnownNegative(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000268 AssumptionCache *AC, const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +0000269 const DominatorTree *DT, bool UseInstrInfo) {
270 KnownBits Known =
271 computeKnownBits(V, DL, Depth, AC, CxtI, DT, nullptr, UseInstrInfo);
Craig Topper6e11a052017-05-08 16:22:48 +0000272 return Known.isNegative();
Nick Lewycky762f8a82016-04-21 00:53:14 +0000273}
274
Pete Cooper35b00d52016-08-13 01:05:32 +0000275static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q);
James Molloy1d88d6f2015-10-22 13:18:42 +0000276
Pete Cooper35b00d52016-08-13 01:05:32 +0000277bool llvm::isKnownNonEqual(const Value *V1, const Value *V2,
Florian Hahn19f9e322018-08-17 14:39:04 +0000278 const DataLayout &DL, AssumptionCache *AC,
279 const Instruction *CxtI, const DominatorTree *DT,
280 bool UseInstrInfo) {
281 return ::isKnownNonEqual(V1, V2,
282 Query(DL, AC, safeCxtI(V1, safeCxtI(V2, CxtI)), DT,
283 UseInstrInfo, /*ORE=*/nullptr));
James Molloy1d88d6f2015-10-22 13:18:42 +0000284}
285
Pete Cooper35b00d52016-08-13 01:05:32 +0000286static bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000287 const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000288
Pete Cooper35b00d52016-08-13 01:05:32 +0000289bool llvm::MaskedValueIsZero(const Value *V, const APInt &Mask,
Florian Hahn19f9e322018-08-17 14:39:04 +0000290 const DataLayout &DL, unsigned Depth,
291 AssumptionCache *AC, const Instruction *CxtI,
292 const DominatorTree *DT, bool UseInstrInfo) {
293 return ::MaskedValueIsZero(
294 V, Mask, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000295}
296
Pete Cooper35b00d52016-08-13 01:05:32 +0000297static unsigned ComputeNumSignBits(const Value *V, unsigned Depth,
298 const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000299
Pete Cooper35b00d52016-08-13 01:05:32 +0000300unsigned llvm::ComputeNumSignBits(const Value *V, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000301 unsigned Depth, AssumptionCache *AC,
302 const Instruction *CxtI,
Florian Hahn19f9e322018-08-17 14:39:04 +0000303 const DominatorTree *DT, bool UseInstrInfo) {
304 return ::ComputeNumSignBits(
305 V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
Hal Finkel60db0582014-09-07 18:57:58 +0000306}
307
Craig Topper8fbb74b2017-03-24 22:12:10 +0000308static void computeKnownBitsAddSub(bool Add, const Value *Op0, const Value *Op1,
309 bool NSW,
Craig Topperb45eabc2017-04-26 16:39:58 +0000310 KnownBits &KnownOut, KnownBits &Known2,
Craig Topper8fbb74b2017-03-24 22:12:10 +0000311 unsigned Depth, const Query &Q) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000312 unsigned BitWidth = KnownOut.getBitWidth();
Craig Topper8fbb74b2017-03-24 22:12:10 +0000313
314 // If an initial sequence of bits in the result is not needed, the
315 // corresponding bits in the operands are not needed.
Craig Topperb45eabc2017-04-26 16:39:58 +0000316 KnownBits LHSKnown(BitWidth);
317 computeKnownBits(Op0, LHSKnown, Depth + 1, Q);
318 computeKnownBits(Op1, Known2, Depth + 1, Q);
Craig Topper8fbb74b2017-03-24 22:12:10 +0000319
Craig Topperb498a232017-08-08 16:29:35 +0000320 KnownOut = KnownBits::computeForAddSub(Add, NSW, LHSKnown, Known2);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000321}
322
Pete Cooper35b00d52016-08-13 01:05:32 +0000323static void computeKnownBitsMul(const Value *Op0, const Value *Op1, bool NSW,
Craig Topperb45eabc2017-04-26 16:39:58 +0000324 KnownBits &Known, KnownBits &Known2,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000325 unsigned Depth, const Query &Q) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000326 unsigned BitWidth = Known.getBitWidth();
327 computeKnownBits(Op1, Known, Depth + 1, Q);
328 computeKnownBits(Op0, Known2, Depth + 1, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000329
330 bool isKnownNegative = false;
331 bool isKnownNonNegative = false;
332 // If the multiplication is known not to overflow, compute the sign bit.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000333 if (NSW) {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000334 if (Op0 == Op1) {
335 // The product of a number with itself is non-negative.
336 isKnownNonNegative = true;
337 } else {
Craig Topperca48af32017-04-29 16:43:11 +0000338 bool isKnownNonNegativeOp1 = Known.isNonNegative();
339 bool isKnownNonNegativeOp0 = Known2.isNonNegative();
340 bool isKnownNegativeOp1 = Known.isNegative();
341 bool isKnownNegativeOp0 = Known2.isNegative();
Nick Lewyckyfa306072012-03-18 23:28:48 +0000342 // The product of two numbers with the same sign is non-negative.
343 isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
344 (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
345 // The product of a negative number and a non-negative number is either
346 // negative or zero.
347 if (!isKnownNonNegative)
348 isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000349 isKnownNonZero(Op0, Depth, Q)) ||
Nick Lewyckyfa306072012-03-18 23:28:48 +0000350 (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000351 isKnownNonZero(Op1, Depth, Q));
Nick Lewyckyfa306072012-03-18 23:28:48 +0000352 }
353 }
354
Simon Dardis70dbd5f2017-12-09 23:25:57 +0000355 assert(!Known.hasConflict() && !Known2.hasConflict());
356 // Compute a conservative estimate for high known-0 bits.
Craig Topper8df66c62017-05-12 17:20:30 +0000357 unsigned LeadZ = std::max(Known.countMinLeadingZeros() +
358 Known2.countMinLeadingZeros(),
Nick Lewyckyfa306072012-03-18 23:28:48 +0000359 BitWidth) - BitWidth;
Nick Lewyckyfa306072012-03-18 23:28:48 +0000360 LeadZ = std::min(LeadZ, BitWidth);
Simon Dardis70dbd5f2017-12-09 23:25:57 +0000361
362 // The result of the bottom bits of an integer multiply can be
363 // inferred by looking at the bottom bits of both operands and
364 // multiplying them together.
365 // We can infer at least the minimum number of known trailing bits
366 // of both operands. Depending on number of trailing zeros, we can
367 // infer more bits, because (a*b) <=> ((a/m) * (b/n)) * (m*n) assuming
368 // a and b are divisible by m and n respectively.
369 // We then calculate how many of those bits are inferrable and set
370 // the output. For example, the i8 mul:
371 // a = XXXX1100 (12)
372 // b = XXXX1110 (14)
373 // We know the bottom 3 bits are zero since the first can be divided by
374 // 4 and the second by 2, thus having ((12/4) * (14/2)) * (2*4).
375 // Applying the multiplication to the trimmed arguments gets:
376 // XX11 (3)
377 // X111 (7)
378 // -------
379 // XX11
380 // XX11
381 // XX11
382 // XX11
383 // -------
384 // XXXXX01
385 // Which allows us to infer the 2 LSBs. Since we're multiplying the result
386 // by 8, the bottom 3 bits will be 0, so we can infer a total of 5 bits.
387 // The proof for this can be described as:
388 // Pre: (C1 >= 0) && (C1 < (1 << C5)) && (C2 >= 0) && (C2 < (1 << C6)) &&
389 // (C7 == (1 << (umin(countTrailingZeros(C1), C5) +
390 // umin(countTrailingZeros(C2), C6) +
391 // umin(C5 - umin(countTrailingZeros(C1), C5),
392 // C6 - umin(countTrailingZeros(C2), C6)))) - 1)
393 // %aa = shl i8 %a, C5
394 // %bb = shl i8 %b, C6
395 // %aaa = or i8 %aa, C1
396 // %bbb = or i8 %bb, C2
397 // %mul = mul i8 %aaa, %bbb
398 // %mask = and i8 %mul, C7
399 // =>
400 // %mask = i8 ((C1*C2)&C7)
401 // Where C5, C6 describe the known bits of %a, %b
402 // C1, C2 describe the known bottom bits of %a, %b.
403 // C7 describes the mask of the known bits of the result.
404 APInt Bottom0 = Known.One;
405 APInt Bottom1 = Known2.One;
406
407 // How many times we'd be able to divide each argument by 2 (shr by 1).
408 // This gives us the number of trailing zeros on the multiplication result.
409 unsigned TrailBitsKnown0 = (Known.Zero | Known.One).countTrailingOnes();
410 unsigned TrailBitsKnown1 = (Known2.Zero | Known2.One).countTrailingOnes();
411 unsigned TrailZero0 = Known.countMinTrailingZeros();
412 unsigned TrailZero1 = Known2.countMinTrailingZeros();
413 unsigned TrailZ = TrailZero0 + TrailZero1;
414
415 // Figure out the fewest known-bits operand.
416 unsigned SmallestOperand = std::min(TrailBitsKnown0 - TrailZero0,
417 TrailBitsKnown1 - TrailZero1);
418 unsigned ResultBitsKnown = std::min(SmallestOperand + TrailZ, BitWidth);
419
420 APInt BottomKnown = Bottom0.getLoBits(TrailBitsKnown0) *
421 Bottom1.getLoBits(TrailBitsKnown1);
422
Craig Topperf0aeee02017-05-05 17:36:09 +0000423 Known.resetAll();
Craig Topperb45eabc2017-04-26 16:39:58 +0000424 Known.Zero.setHighBits(LeadZ);
Simon Dardis70dbd5f2017-12-09 23:25:57 +0000425 Known.Zero |= (~BottomKnown).getLoBits(ResultBitsKnown);
426 Known.One |= BottomKnown.getLoBits(ResultBitsKnown);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000427
428 // Only make use of no-wrap flags if we failed to compute the sign bit
429 // directly. This matters if the multiplication always overflows, in
430 // which case we prefer to follow the result of the direct computation,
431 // though as the program is invoking undefined behaviour we can choose
432 // whatever we like here.
Craig Topperca48af32017-04-29 16:43:11 +0000433 if (isKnownNonNegative && !Known.isNegative())
434 Known.makeNonNegative();
435 else if (isKnownNegative && !Known.isNonNegative())
436 Known.makeNegative();
Nick Lewyckyfa306072012-03-18 23:28:48 +0000437}
438
Jingyue Wu37fcb592014-06-19 16:50:16 +0000439void llvm::computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
Craig Topperf42b23f2017-04-28 06:28:56 +0000440 KnownBits &Known) {
441 unsigned BitWidth = Known.getBitWidth();
Rafael Espindola53190532012-03-30 15:52:11 +0000442 unsigned NumRanges = Ranges.getNumOperands() / 2;
443 assert(NumRanges >= 1);
444
Craig Topperf42b23f2017-04-28 06:28:56 +0000445 Known.Zero.setAllBits();
446 Known.One.setAllBits();
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000447
Rafael Espindola53190532012-03-30 15:52:11 +0000448 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000449 ConstantInt *Lower =
450 mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 0));
451 ConstantInt *Upper =
452 mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 1));
Rafael Espindola53190532012-03-30 15:52:11 +0000453 ConstantRange Range(Lower->getValue(), Upper->getValue());
Rafael Espindola53190532012-03-30 15:52:11 +0000454
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000455 // The first CommonPrefixBits of all values in Range are equal.
456 unsigned CommonPrefixBits =
457 (Range.getUnsignedMax() ^ Range.getUnsignedMin()).countLeadingZeros();
458
459 APInt Mask = APInt::getHighBitsSet(BitWidth, CommonPrefixBits);
Craig Topperf42b23f2017-04-28 06:28:56 +0000460 Known.One &= Range.getUnsignedMax() & Mask;
461 Known.Zero &= ~Range.getUnsignedMax() & Mask;
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000462 }
Rafael Espindola53190532012-03-30 15:52:11 +0000463}
Jay Foad5a29c362014-05-15 12:12:55 +0000464
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000465static bool isEphemeralValueOf(const Instruction *I, const Value *E) {
Hal Finkel60db0582014-09-07 18:57:58 +0000466 SmallVector<const Value *, 16> WorkSet(1, I);
467 SmallPtrSet<const Value *, 32> Visited;
468 SmallPtrSet<const Value *, 16> EphValues;
469
Hal Finkelf2199b22015-10-23 20:37:08 +0000470 // The instruction defining an assumption's condition itself is always
471 // considered ephemeral to that assumption (even if it has other
472 // non-ephemeral users). See r246696's test case for an example.
David Majnemer0a16c222016-08-11 21:15:00 +0000473 if (is_contained(I->operands(), E))
Hal Finkelf2199b22015-10-23 20:37:08 +0000474 return true;
475
Hal Finkel60db0582014-09-07 18:57:58 +0000476 while (!WorkSet.empty()) {
477 const Value *V = WorkSet.pop_back_val();
David Blaikie70573dc2014-11-19 07:49:26 +0000478 if (!Visited.insert(V).second)
Hal Finkel60db0582014-09-07 18:57:58 +0000479 continue;
480
481 // If all uses of this value are ephemeral, then so is this value.
Eugene Zelenko75075ef2017-09-01 21:37:29 +0000482 if (llvm::all_of(V->users(), [&](const User *U) {
483 return EphValues.count(U);
484 })) {
Hal Finkel60db0582014-09-07 18:57:58 +0000485 if (V == E)
486 return true;
487
Hal Finkelb03dd4b2017-08-14 17:11:43 +0000488 if (V == I || isSafeToSpeculativelyExecute(V)) {
489 EphValues.insert(V);
490 if (const User *U = dyn_cast<User>(V))
491 for (User::const_op_iterator J = U->op_begin(), JE = U->op_end();
492 J != JE; ++J)
493 WorkSet.push_back(*J);
494 }
Hal Finkel60db0582014-09-07 18:57:58 +0000495 }
496 }
497
498 return false;
499}
500
501// Is this an intrinsic that cannot be speculated but also cannot trap?
Haicheng Wua4461512017-12-15 14:34:41 +0000502bool llvm::isAssumeLikeIntrinsic(const Instruction *I) {
Hal Finkel60db0582014-09-07 18:57:58 +0000503 if (const CallInst *CI = dyn_cast<CallInst>(I))
504 if (Function *F = CI->getCalledFunction())
505 switch (F->getIntrinsicID()) {
506 default: break;
507 // FIXME: This list is repeated from NoTTI::getIntrinsicCost.
508 case Intrinsic::assume:
Dan Gohman2c74fe92017-11-08 21:59:51 +0000509 case Intrinsic::sideeffect:
Hal Finkel60db0582014-09-07 18:57:58 +0000510 case Intrinsic::dbg_declare:
511 case Intrinsic::dbg_value:
Shiva Chen2c864552018-05-09 02:40:45 +0000512 case Intrinsic::dbg_label:
Hal Finkel60db0582014-09-07 18:57:58 +0000513 case Intrinsic::invariant_start:
514 case Intrinsic::invariant_end:
515 case Intrinsic::lifetime_start:
516 case Intrinsic::lifetime_end:
517 case Intrinsic::objectsize:
518 case Intrinsic::ptr_annotation:
519 case Intrinsic::var_annotation:
520 return true;
521 }
522
523 return false;
524}
525
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000526bool llvm::isValidAssumeForContext(const Instruction *Inv,
527 const Instruction *CxtI,
528 const DominatorTree *DT) {
Hal Finkel60db0582014-09-07 18:57:58 +0000529 // There are two restrictions on the use of an assume:
530 // 1. The assume must dominate the context (or the control flow must
531 // reach the assume whenever it reaches the context).
532 // 2. The context must not be in the assume's set of ephemeral values
533 // (otherwise we will use the assume to prove that the condition
534 // feeding the assume is trivially true, thus causing the removal of
535 // the assume).
536
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000537 if (DT) {
Pete Cooper54a02552016-08-12 01:00:15 +0000538 if (DT->dominates(Inv, CxtI))
Hal Finkel60db0582014-09-07 18:57:58 +0000539 return true;
Pete Cooper54a02552016-08-12 01:00:15 +0000540 } else if (Inv->getParent() == CxtI->getParent()->getSinglePredecessor()) {
541 // We don't have a DT, but this trivially dominates.
542 return true;
Hal Finkel60db0582014-09-07 18:57:58 +0000543 }
544
Pete Cooper54a02552016-08-12 01:00:15 +0000545 // With or without a DT, the only remaining case we will check is if the
546 // instructions are in the same BB. Give up if that is not the case.
547 if (Inv->getParent() != CxtI->getParent())
548 return false;
549
Vedant Kumard3196742018-02-28 19:08:52 +0000550 // If we have a dom tree, then we now know that the assume doesn't dominate
Pete Cooper54a02552016-08-12 01:00:15 +0000551 // the other instruction. If we don't have a dom tree then we can check if
552 // the assume is first in the BB.
553 if (!DT) {
Hal Finkel60db0582014-09-07 18:57:58 +0000554 // Search forward from the assume until we reach the context (or the end
555 // of the block); the common case is that the assume will come first.
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000556 for (auto I = std::next(BasicBlock::const_iterator(Inv)),
Hal Finkel60db0582014-09-07 18:57:58 +0000557 IE = Inv->getParent()->end(); I != IE; ++I)
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000558 if (&*I == CxtI)
Hal Finkel60db0582014-09-07 18:57:58 +0000559 return true;
Hal Finkel60db0582014-09-07 18:57:58 +0000560 }
561
Pete Cooper54a02552016-08-12 01:00:15 +0000562 // The context comes first, but they're both in the same block. Make sure
563 // there is nothing in between that might interrupt the control flow.
564 for (BasicBlock::const_iterator I =
565 std::next(BasicBlock::const_iterator(CxtI)), IE(Inv);
566 I != IE; ++I)
567 if (!isSafeToSpeculativelyExecute(&*I) && !isAssumeLikeIntrinsic(&*I))
568 return false;
569
570 return !isEphemeralValueOf(Inv, CxtI);
Hal Finkel60db0582014-09-07 18:57:58 +0000571}
572
Craig Topperb45eabc2017-04-26 16:39:58 +0000573static void computeKnownBitsFromAssume(const Value *V, KnownBits &Known,
574 unsigned Depth, const Query &Q) {
Hal Finkel60db0582014-09-07 18:57:58 +0000575 // Use of assumptions is context-sensitive. If we don't have a context, we
576 // cannot use them!
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000577 if (!Q.AC || !Q.CxtI)
Hal Finkel60db0582014-09-07 18:57:58 +0000578 return;
579
Craig Topperb45eabc2017-04-26 16:39:58 +0000580 unsigned BitWidth = Known.getBitWidth();
Hal Finkel60db0582014-09-07 18:57:58 +0000581
Hal Finkel8a9a7832017-01-11 13:24:24 +0000582 // Note that the patterns below need to be kept in sync with the code
583 // in AssumptionCache::updateAffectedValues.
584
585 for (auto &AssumeVH : Q.AC->assumptionsFor(V)) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000586 if (!AssumeVH)
Chandler Carruth66b31302015-01-04 12:03:27 +0000587 continue;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000588 CallInst *I = cast<CallInst>(AssumeVH);
589 assert(I->getParent()->getParent() == Q.CxtI->getParent()->getParent() &&
590 "Got assumption for the wrong function!");
591 if (Q.isExcluded(I))
Hal Finkel60db0582014-09-07 18:57:58 +0000592 continue;
593
Vedant Kumard3196742018-02-28 19:08:52 +0000594 // Warning: This loop can end up being somewhat performance sensitive.
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000595 // We're running this loop for once for each value queried resulting in a
596 // runtime of ~O(#assumes * #values).
Philip Reames00d3b272014-11-24 23:44:28 +0000597
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000598 assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
599 "must be an assume intrinsic");
600
601 Value *Arg = I->getArgOperand(0);
602
603 if (Arg == V && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000604 assert(BitWidth == 1 && "assume operand is not i1?");
Craig Topperf0aeee02017-05-05 17:36:09 +0000605 Known.setAllOnes();
Hal Finkel60db0582014-09-07 18:57:58 +0000606 return;
607 }
Sanjay Patel96669962017-01-17 18:15:49 +0000608 if (match(Arg, m_Not(m_Specific(V))) &&
609 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
610 assert(BitWidth == 1 && "assume operand is not i1?");
Craig Topperf0aeee02017-05-05 17:36:09 +0000611 Known.setAllZero();
Sanjay Patel96669962017-01-17 18:15:49 +0000612 return;
613 }
Hal Finkel60db0582014-09-07 18:57:58 +0000614
David Majnemer9b609752014-12-12 23:59:29 +0000615 // The remaining tests are all recursive, so bail out if we hit the limit.
616 if (Depth == MaxDepth)
617 continue;
618
Hal Finkel60db0582014-09-07 18:57:58 +0000619 Value *A, *B;
620 auto m_V = m_CombineOr(m_Specific(V),
621 m_CombineOr(m_PtrToInt(m_Specific(V)),
622 m_BitCast(m_Specific(V))));
623
624 CmpInst::Predicate Pred;
Igor Laevskycec8f472017-12-05 12:18:15 +0000625 uint64_t C;
Hal Finkel60db0582014-09-07 18:57:58 +0000626 // assume(v = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000627 if (match(Arg, m_c_ICmp(Pred, m_V, m_Value(A))) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000628 Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000629 KnownBits RHSKnown(BitWidth);
630 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
631 Known.Zero |= RHSKnown.Zero;
632 Known.One |= RHSKnown.One;
Hal Finkel60db0582014-09-07 18:57:58 +0000633 // assume(v & b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000634 } else if (match(Arg,
635 m_c_ICmp(Pred, m_c_And(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000636 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000637 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000638 KnownBits RHSKnown(BitWidth);
639 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
640 KnownBits MaskKnown(BitWidth);
641 computeKnownBits(B, MaskKnown, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000642
643 // For those bits in the mask that are known to be one, we can propagate
644 // known bits from the RHS to V.
Craig Topperb45eabc2017-04-26 16:39:58 +0000645 Known.Zero |= RHSKnown.Zero & MaskKnown.One;
646 Known.One |= RHSKnown.One & MaskKnown.One;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000647 // assume(~(v & b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000648 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_And(m_V, m_Value(B))),
649 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000650 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000651 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000652 KnownBits RHSKnown(BitWidth);
653 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
654 KnownBits MaskKnown(BitWidth);
655 computeKnownBits(B, MaskKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000656
657 // For those bits in the mask that are known to be one, we can propagate
658 // inverted known bits from the RHS to V.
Craig Topperb45eabc2017-04-26 16:39:58 +0000659 Known.Zero |= RHSKnown.One & MaskKnown.One;
660 Known.One |= RHSKnown.Zero & MaskKnown.One;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000661 // assume(v | b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000662 } else if (match(Arg,
663 m_c_ICmp(Pred, m_c_Or(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000664 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000665 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000666 KnownBits RHSKnown(BitWidth);
667 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
668 KnownBits BKnown(BitWidth);
669 computeKnownBits(B, BKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000670
671 // For those bits in B that are known to be zero, we can propagate known
672 // bits from the RHS to V.
Craig Topperb45eabc2017-04-26 16:39:58 +0000673 Known.Zero |= RHSKnown.Zero & BKnown.Zero;
674 Known.One |= RHSKnown.One & BKnown.Zero;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000675 // assume(~(v | b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000676 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Or(m_V, m_Value(B))),
677 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000678 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000679 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000680 KnownBits RHSKnown(BitWidth);
681 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
682 KnownBits BKnown(BitWidth);
683 computeKnownBits(B, BKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000684
685 // For those bits in B that are known to be zero, we can propagate
686 // inverted known bits from the RHS to V.
Craig Topperb45eabc2017-04-26 16:39:58 +0000687 Known.Zero |= RHSKnown.One & BKnown.Zero;
688 Known.One |= RHSKnown.Zero & BKnown.Zero;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000689 // assume(v ^ b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000690 } else if (match(Arg,
691 m_c_ICmp(Pred, m_c_Xor(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000692 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000693 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000694 KnownBits RHSKnown(BitWidth);
695 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
696 KnownBits BKnown(BitWidth);
697 computeKnownBits(B, BKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000698
699 // For those bits in B that are known to be zero, we can propagate known
700 // bits from the RHS to V. For those bits in B that are known to be one,
701 // we can propagate inverted known bits from the RHS to V.
Craig Topperb45eabc2017-04-26 16:39:58 +0000702 Known.Zero |= RHSKnown.Zero & BKnown.Zero;
703 Known.One |= RHSKnown.One & BKnown.Zero;
704 Known.Zero |= RHSKnown.One & BKnown.One;
705 Known.One |= RHSKnown.Zero & BKnown.One;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000706 // assume(~(v ^ b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000707 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Xor(m_V, m_Value(B))),
708 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000709 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000710 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000711 KnownBits RHSKnown(BitWidth);
712 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
713 KnownBits BKnown(BitWidth);
714 computeKnownBits(B, BKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000715
716 // For those bits in B that are known to be zero, we can propagate
717 // inverted known bits from the RHS to V. For those bits in B that are
718 // known to be one, we can propagate known bits from the RHS to V.
Craig Topperb45eabc2017-04-26 16:39:58 +0000719 Known.Zero |= RHSKnown.One & BKnown.Zero;
720 Known.One |= RHSKnown.Zero & BKnown.Zero;
721 Known.Zero |= RHSKnown.Zero & BKnown.One;
722 Known.One |= RHSKnown.One & BKnown.One;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000723 // assume(v << c = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000724 } else if (match(Arg, m_c_ICmp(Pred, m_Shl(m_V, m_ConstantInt(C)),
725 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000726 Pred == ICmpInst::ICMP_EQ &&
Igor Laevskycec8f472017-12-05 12:18:15 +0000727 isValidAssumeForContext(I, Q.CxtI, Q.DT) &&
728 C < BitWidth) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000729 KnownBits RHSKnown(BitWidth);
730 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000731 // For those bits in RHS that are known, we can propagate them to known
732 // bits in V shifted to the right by C.
Igor Laevskycec8f472017-12-05 12:18:15 +0000733 RHSKnown.Zero.lshrInPlace(C);
Craig Topperb45eabc2017-04-26 16:39:58 +0000734 Known.Zero |= RHSKnown.Zero;
Igor Laevskycec8f472017-12-05 12:18:15 +0000735 RHSKnown.One.lshrInPlace(C);
Craig Topperb45eabc2017-04-26 16:39:58 +0000736 Known.One |= RHSKnown.One;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000737 // assume(~(v << c) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000738 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_Shl(m_V, m_ConstantInt(C))),
739 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000740 Pred == ICmpInst::ICMP_EQ &&
Igor Laevskycec8f472017-12-05 12:18:15 +0000741 isValidAssumeForContext(I, Q.CxtI, Q.DT) &&
742 C < BitWidth) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000743 KnownBits RHSKnown(BitWidth);
744 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000745 // For those bits in RHS that are known, we can propagate them inverted
746 // to known bits in V shifted to the right by C.
Igor Laevskycec8f472017-12-05 12:18:15 +0000747 RHSKnown.One.lshrInPlace(C);
Craig Topperb45eabc2017-04-26 16:39:58 +0000748 Known.Zero |= RHSKnown.One;
Igor Laevskycec8f472017-12-05 12:18:15 +0000749 RHSKnown.Zero.lshrInPlace(C);
Craig Topperb45eabc2017-04-26 16:39:58 +0000750 Known.One |= RHSKnown.Zero;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000751 // assume(v >> c = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000752 } else if (match(Arg,
Craig Topper7b66ffe2017-06-24 06:24:04 +0000753 m_c_ICmp(Pred, m_Shr(m_V, m_ConstantInt(C)),
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000754 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000755 Pred == ICmpInst::ICMP_EQ &&
Igor Laevskycec8f472017-12-05 12:18:15 +0000756 isValidAssumeForContext(I, Q.CxtI, Q.DT) &&
757 C < BitWidth) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000758 KnownBits RHSKnown(BitWidth);
759 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000760 // For those bits in RHS that are known, we can propagate them to known
761 // bits in V shifted to the right by C.
Igor Laevskycec8f472017-12-05 12:18:15 +0000762 Known.Zero |= RHSKnown.Zero << C;
763 Known.One |= RHSKnown.One << C;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000764 // assume(~(v >> c) = a)
Craig Topper7b66ffe2017-06-24 06:24:04 +0000765 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_Shr(m_V, m_ConstantInt(C))),
Philip Reames00d3b272014-11-24 23:44:28 +0000766 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000767 Pred == ICmpInst::ICMP_EQ &&
Igor Laevskycec8f472017-12-05 12:18:15 +0000768 isValidAssumeForContext(I, Q.CxtI, Q.DT) &&
769 C < BitWidth) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000770 KnownBits RHSKnown(BitWidth);
771 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000772 // For those bits in RHS that are known, we can propagate them inverted
773 // to known bits in V shifted to the right by C.
Igor Laevskycec8f472017-12-05 12:18:15 +0000774 Known.Zero |= RHSKnown.One << C;
775 Known.One |= RHSKnown.Zero << C;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000776 // assume(v >=_s c) where c is non-negative
Philip Reames00d3b272014-11-24 23:44:28 +0000777 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000778 Pred == ICmpInst::ICMP_SGE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000779 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000780 KnownBits RHSKnown(BitWidth);
781 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000782
Craig Topperca48af32017-04-29 16:43:11 +0000783 if (RHSKnown.isNonNegative()) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000784 // We know that the sign bit is zero.
Craig Topperca48af32017-04-29 16:43:11 +0000785 Known.makeNonNegative();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000786 }
787 // assume(v >_s c) where c is at least -1.
Philip Reames00d3b272014-11-24 23:44:28 +0000788 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000789 Pred == ICmpInst::ICMP_SGT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000790 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000791 KnownBits RHSKnown(BitWidth);
792 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000793
Craig Topperf0aeee02017-05-05 17:36:09 +0000794 if (RHSKnown.isAllOnes() || RHSKnown.isNonNegative()) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000795 // We know that the sign bit is zero.
Craig Topperca48af32017-04-29 16:43:11 +0000796 Known.makeNonNegative();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000797 }
798 // assume(v <=_s c) where c is negative
Philip Reames00d3b272014-11-24 23:44:28 +0000799 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000800 Pred == ICmpInst::ICMP_SLE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000801 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000802 KnownBits RHSKnown(BitWidth);
803 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000804
Craig Topperca48af32017-04-29 16:43:11 +0000805 if (RHSKnown.isNegative()) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000806 // We know that the sign bit is one.
Craig Topperca48af32017-04-29 16:43:11 +0000807 Known.makeNegative();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000808 }
809 // assume(v <_s c) where c is non-positive
Philip Reames00d3b272014-11-24 23:44:28 +0000810 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000811 Pred == ICmpInst::ICMP_SLT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000812 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000813 KnownBits RHSKnown(BitWidth);
814 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000815
Craig Topperf0aeee02017-05-05 17:36:09 +0000816 if (RHSKnown.isZero() || RHSKnown.isNegative()) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000817 // We know that the sign bit is one.
Craig Topperca48af32017-04-29 16:43:11 +0000818 Known.makeNegative();
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000819 }
820 // assume(v <=_u c)
Philip Reames00d3b272014-11-24 23:44:28 +0000821 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000822 Pred == ICmpInst::ICMP_ULE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000823 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000824 KnownBits RHSKnown(BitWidth);
825 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000826
827 // Whatever high bits in c are zero are known to be zero.
Craig Topper8df66c62017-05-12 17:20:30 +0000828 Known.Zero.setHighBits(RHSKnown.countMinLeadingZeros());
829 // assume(v <_u c)
Philip Reames00d3b272014-11-24 23:44:28 +0000830 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000831 Pred == ICmpInst::ICMP_ULT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000832 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000833 KnownBits RHSKnown(BitWidth);
834 computeKnownBits(A, RHSKnown, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000835
Sanjay Patela60aec12018-02-08 14:52:40 +0000836 // If the RHS is known zero, then this assumption must be wrong (nothing
837 // is unsigned less than zero). Signal a conflict and get out of here.
838 if (RHSKnown.isZero()) {
839 Known.Zero.setAllBits();
840 Known.One.setAllBits();
841 break;
842 }
843
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000844 // Whatever high bits in c are zero are known to be zero (if c is a power
845 // of 2, then one more).
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000846 if (isKnownToBeAPowerOfTwo(A, false, Depth + 1, Query(Q, I)))
Craig Topper8df66c62017-05-12 17:20:30 +0000847 Known.Zero.setHighBits(RHSKnown.countMinLeadingZeros() + 1);
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000848 else
Craig Topper8df66c62017-05-12 17:20:30 +0000849 Known.Zero.setHighBits(RHSKnown.countMinLeadingZeros());
Hal Finkel60db0582014-09-07 18:57:58 +0000850 }
851 }
Sanjay Patel25f6d712017-02-01 15:41:32 +0000852
853 // If assumptions conflict with each other or previous known bits, then we
Sanjay Patel54656ca2017-02-06 18:26:06 +0000854 // have a logical fallacy. It's possible that the assumption is not reachable,
855 // so this isn't a real bug. On the other hand, the program may have undefined
856 // behavior, or we might have a bug in the compiler. We can't assert/crash, so
857 // clear out the known bits, try to warn the user, and hope for the best.
Craig Topperb45eabc2017-04-26 16:39:58 +0000858 if (Known.Zero.intersects(Known.One)) {
Craig Topperf0aeee02017-05-05 17:36:09 +0000859 Known.resetAll();
Sanjay Patel54656ca2017-02-06 18:26:06 +0000860
Vivek Pandya95906582017-10-11 17:12:59 +0000861 if (Q.ORE)
862 Q.ORE->emit([&]() {
863 auto *CxtI = const_cast<Instruction *>(Q.CxtI);
864 return OptimizationRemarkAnalysis("value-tracking", "BadAssumption",
865 CxtI)
866 << "Detected conflicting code assumptions. Program may "
867 "have undefined behavior, or compiler may have "
868 "internal error.";
869 });
Sanjay Patel25f6d712017-02-01 15:41:32 +0000870 }
Hal Finkel60db0582014-09-07 18:57:58 +0000871}
872
Sanjay Patelb7d12382017-10-16 14:46:37 +0000873/// Compute known bits from a shift operator, including those with a
874/// non-constant shift amount. Known is the output of this function. Known2 is a
875/// pre-allocated temporary with the same bit width as Known. KZF and KOF are
Vedant Kumard3196742018-02-28 19:08:52 +0000876/// operator-specific functions that, given the known-zero or known-one bits
Sanjay Patelb7d12382017-10-16 14:46:37 +0000877/// respectively, and a shift amount, compute the implied known-zero or
878/// known-one bits of the shift operator's result respectively for that shift
879/// amount. The results from calling KZF and KOF are conservatively combined for
880/// all permitted shift amounts.
David Majnemer54690dc2016-08-23 20:52:00 +0000881static void computeKnownBitsFromShiftOperator(
Craig Topperb45eabc2017-04-26 16:39:58 +0000882 const Operator *I, KnownBits &Known, KnownBits &Known2,
883 unsigned Depth, const Query &Q,
Sam McCalld0d43e62017-12-04 12:51:49 +0000884 function_ref<APInt(const APInt &, unsigned)> KZF,
885 function_ref<APInt(const APInt &, unsigned)> KOF) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000886 unsigned BitWidth = Known.getBitWidth();
Hal Finkelf2199b22015-10-23 20:37:08 +0000887
888 if (auto *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
889 unsigned ShiftAmt = SA->getLimitedValue(BitWidth-1);
890
Craig Topperb45eabc2017-04-26 16:39:58 +0000891 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
Sam McCalld0d43e62017-12-04 12:51:49 +0000892 Known.Zero = KZF(Known.Zero, ShiftAmt);
893 Known.One = KOF(Known.One, ShiftAmt);
Sanjay Patele272be72017-10-12 17:31:46 +0000894 // If the known bits conflict, this must be an overflowing left shift, so
895 // the shift result is poison. We can return anything we want. Choose 0 for
896 // the best folding opportunity.
897 if (Known.hasConflict())
898 Known.setAllZero();
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +0000899
Hal Finkelf2199b22015-10-23 20:37:08 +0000900 return;
901 }
902
Craig Topperb45eabc2017-04-26 16:39:58 +0000903 computeKnownBits(I->getOperand(1), Known, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000904
Sanjay Patele272be72017-10-12 17:31:46 +0000905 // If the shift amount could be greater than or equal to the bit-width of the
906 // LHS, the value could be poison, but bail out because the check below is
907 // expensive. TODO: Should we just carry on?
Craig Topperb45eabc2017-04-26 16:39:58 +0000908 if ((~Known.Zero).uge(BitWidth)) {
Craig Topperf0aeee02017-05-05 17:36:09 +0000909 Known.resetAll();
Oliver Stannard06204112017-03-14 10:13:17 +0000910 return;
911 }
912
Craig Topperb45eabc2017-04-26 16:39:58 +0000913 // Note: We cannot use Known.Zero.getLimitedValue() here, because if
Hal Finkelf2199b22015-10-23 20:37:08 +0000914 // BitWidth > 64 and any upper bits are known, we'll end up returning the
915 // limit value (which implies all bits are known).
Craig Topperb45eabc2017-04-26 16:39:58 +0000916 uint64_t ShiftAmtKZ = Known.Zero.zextOrTrunc(64).getZExtValue();
917 uint64_t ShiftAmtKO = Known.One.zextOrTrunc(64).getZExtValue();
Hal Finkelf2199b22015-10-23 20:37:08 +0000918
919 // It would be more-clearly correct to use the two temporaries for this
920 // calculation. Reusing the APInts here to prevent unnecessary allocations.
Craig Topperf0aeee02017-05-05 17:36:09 +0000921 Known.resetAll();
Hal Finkelf2199b22015-10-23 20:37:08 +0000922
James Molloy493e57d2015-10-26 14:10:46 +0000923 // If we know the shifter operand is nonzero, we can sometimes infer more
924 // known bits. However this is expensive to compute, so be lazy about it and
925 // only compute it when absolutely necessary.
926 Optional<bool> ShifterOperandIsNonZero;
927
Hal Finkelf2199b22015-10-23 20:37:08 +0000928 // Early exit if we can't constrain any well-defined shift amount.
Craig Topperf93b7b12017-06-14 17:04:59 +0000929 if (!(ShiftAmtKZ & (PowerOf2Ceil(BitWidth) - 1)) &&
930 !(ShiftAmtKO & (PowerOf2Ceil(BitWidth) - 1))) {
Sanjay Patelb7d12382017-10-16 14:46:37 +0000931 ShifterOperandIsNonZero = isKnownNonZero(I->getOperand(1), Depth + 1, Q);
James Molloy493e57d2015-10-26 14:10:46 +0000932 if (!*ShifterOperandIsNonZero)
933 return;
934 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000935
Craig Topperb45eabc2017-04-26 16:39:58 +0000936 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000937
Craig Topperb45eabc2017-04-26 16:39:58 +0000938 Known.Zero.setAllBits();
939 Known.One.setAllBits();
Hal Finkelf2199b22015-10-23 20:37:08 +0000940 for (unsigned ShiftAmt = 0; ShiftAmt < BitWidth; ++ShiftAmt) {
941 // Combine the shifted known input bits only for those shift amounts
942 // compatible with its known constraints.
943 if ((ShiftAmt & ~ShiftAmtKZ) != ShiftAmt)
944 continue;
945 if ((ShiftAmt | ShiftAmtKO) != ShiftAmt)
946 continue;
James Molloy493e57d2015-10-26 14:10:46 +0000947 // If we know the shifter is nonzero, we may be able to infer more known
948 // bits. This check is sunk down as far as possible to avoid the expensive
949 // call to isKnownNonZero if the cheaper checks above fail.
950 if (ShiftAmt == 0) {
951 if (!ShifterOperandIsNonZero.hasValue())
952 ShifterOperandIsNonZero =
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000953 isKnownNonZero(I->getOperand(1), Depth + 1, Q);
James Molloy493e57d2015-10-26 14:10:46 +0000954 if (*ShifterOperandIsNonZero)
955 continue;
956 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000957
Sam McCalld0d43e62017-12-04 12:51:49 +0000958 Known.Zero &= KZF(Known2.Zero, ShiftAmt);
959 Known.One &= KOF(Known2.One, ShiftAmt);
Hal Finkelf2199b22015-10-23 20:37:08 +0000960 }
961
Sanjay Patele272be72017-10-12 17:31:46 +0000962 // If the known bits conflict, the result is poison. Return a 0 and hope the
963 // caller can further optimize that.
964 if (Known.hasConflict())
965 Known.setAllZero();
Hal Finkelf2199b22015-10-23 20:37:08 +0000966}
967
Craig Topperb45eabc2017-04-26 16:39:58 +0000968static void computeKnownBitsFromOperator(const Operator *I, KnownBits &Known,
969 unsigned Depth, const Query &Q) {
970 unsigned BitWidth = Known.getBitWidth();
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000971
Craig Topperb45eabc2017-04-26 16:39:58 +0000972 KnownBits Known2(Known);
Dan Gohman80ca01c2009-07-17 20:47:02 +0000973 switch (I->getOpcode()) {
Chris Lattner965c7692008-06-02 01:18:21 +0000974 default: break;
Rafael Espindola53190532012-03-30 15:52:11 +0000975 case Instruction::Load:
Florian Hahn19f9e322018-08-17 14:39:04 +0000976 if (MDNode *MD =
977 Q.IIQ.getMetadata(cast<LoadInst>(I), LLVMContext::MD_range))
Craig Topperf42b23f2017-04-28 06:28:56 +0000978 computeKnownBitsFromRangeMetadata(*MD, Known);
Jay Foad5a29c362014-05-15 12:12:55 +0000979 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000980 case Instruction::And: {
981 // If either the LHS or the RHS are Zero, the result is zero.
Craig Topperb45eabc2017-04-26 16:39:58 +0000982 computeKnownBits(I->getOperand(1), Known, Depth + 1, Q);
983 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000984
Chris Lattner965c7692008-06-02 01:18:21 +0000985 // Output known-1 bits are only known if set in both the LHS & RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +0000986 Known.One &= Known2.One;
Chris Lattner965c7692008-06-02 01:18:21 +0000987 // Output known-0 are known to be clear if zero in either the LHS | RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +0000988 Known.Zero |= Known2.Zero;
Philip Reames2d858742015-11-10 18:46:14 +0000989
990 // and(x, add (x, -1)) is a common idiom that always clears the low bit;
991 // here we handle the more general case of adding any odd number by
992 // matching the form add(x, add(x, y)) where y is odd.
993 // TODO: This could be generalized to clearing any bit set in y where the
994 // following bit is known to be unset in y.
Roman Lebedev6959b8e2018-04-27 21:23:20 +0000995 Value *X = nullptr, *Y = nullptr;
Craig Topperb45eabc2017-04-26 16:39:58 +0000996 if (!Known.Zero[0] && !Known.One[0] &&
Roman Lebedev6959b8e2018-04-27 21:23:20 +0000997 match(I, m_c_BinOp(m_Value(X), m_Add(m_Deferred(X), m_Value(Y))))) {
Craig Topperf0aeee02017-05-05 17:36:09 +0000998 Known2.resetAll();
Craig Topperb45eabc2017-04-26 16:39:58 +0000999 computeKnownBits(Y, Known2, Depth + 1, Q);
Craig Topper8df66c62017-05-12 17:20:30 +00001000 if (Known2.countMinTrailingOnes() > 0)
Craig Topperb45eabc2017-04-26 16:39:58 +00001001 Known.Zero.setBit(0);
Philip Reames2d858742015-11-10 18:46:14 +00001002 }
Jay Foad5a29c362014-05-15 12:12:55 +00001003 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001004 }
Eugene Zelenko75075ef2017-09-01 21:37:29 +00001005 case Instruction::Or:
Craig Topperb45eabc2017-04-26 16:39:58 +00001006 computeKnownBits(I->getOperand(1), Known, Depth + 1, Q);
1007 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00001008
Chris Lattner965c7692008-06-02 01:18:21 +00001009 // Output known-0 bits are only known if clear in both the LHS & RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +00001010 Known.Zero &= Known2.Zero;
Chris Lattner965c7692008-06-02 01:18:21 +00001011 // Output known-1 are known to be set if set in either the LHS | RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +00001012 Known.One |= Known2.One;
Jay Foad5a29c362014-05-15 12:12:55 +00001013 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001014 case Instruction::Xor: {
Craig Topperb45eabc2017-04-26 16:39:58 +00001015 computeKnownBits(I->getOperand(1), Known, Depth + 1, Q);
1016 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00001017
Chris Lattner965c7692008-06-02 01:18:21 +00001018 // Output known-0 bits are known if clear or set in both the LHS & RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +00001019 APInt KnownZeroOut = (Known.Zero & Known2.Zero) | (Known.One & Known2.One);
Chris Lattner965c7692008-06-02 01:18:21 +00001020 // Output known-1 are known to be set if set in only one of the LHS, RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +00001021 Known.One = (Known.Zero & Known2.One) | (Known.One & Known2.Zero);
1022 Known.Zero = std::move(KnownZeroOut);
Jay Foad5a29c362014-05-15 12:12:55 +00001023 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001024 }
1025 case Instruction::Mul: {
Florian Hahn19f9e322018-08-17 14:39:04 +00001026 bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
Craig Topperb45eabc2017-04-26 16:39:58 +00001027 computeKnownBitsMul(I->getOperand(0), I->getOperand(1), NSW, Known,
1028 Known2, Depth, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +00001029 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001030 }
1031 case Instruction::UDiv: {
1032 // For the purposes of computing leading zeros we can conservatively
1033 // treat a udiv as a logical right shift by the power of 2 known to
1034 // be less than the denominator.
Craig Topperb45eabc2017-04-26 16:39:58 +00001035 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Craig Topper8df66c62017-05-12 17:20:30 +00001036 unsigned LeadZ = Known2.countMinLeadingZeros();
Chris Lattner965c7692008-06-02 01:18:21 +00001037
Craig Topperf0aeee02017-05-05 17:36:09 +00001038 Known2.resetAll();
Craig Topperb45eabc2017-04-26 16:39:58 +00001039 computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
Craig Topper8df66c62017-05-12 17:20:30 +00001040 unsigned RHSMaxLeadingZeros = Known2.countMaxLeadingZeros();
1041 if (RHSMaxLeadingZeros != BitWidth)
1042 LeadZ = std::min(BitWidth, LeadZ + BitWidth - RHSMaxLeadingZeros - 1);
Chris Lattner965c7692008-06-02 01:18:21 +00001043
Craig Topperb45eabc2017-04-26 16:39:58 +00001044 Known.Zero.setHighBits(LeadZ);
Jay Foad5a29c362014-05-15 12:12:55 +00001045 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001046 }
David Majnemera19d0f22016-08-06 08:16:00 +00001047 case Instruction::Select: {
Craig Toppere953dec2017-04-13 20:39:37 +00001048 const Value *LHS, *RHS;
David Majnemera19d0f22016-08-06 08:16:00 +00001049 SelectPatternFlavor SPF = matchSelectPattern(I, LHS, RHS).Flavor;
1050 if (SelectPatternResult::isMinOrMax(SPF)) {
Craig Topperb45eabc2017-04-26 16:39:58 +00001051 computeKnownBits(RHS, Known, Depth + 1, Q);
1052 computeKnownBits(LHS, Known2, Depth + 1, Q);
David Majnemera19d0f22016-08-06 08:16:00 +00001053 } else {
Craig Topperb45eabc2017-04-26 16:39:58 +00001054 computeKnownBits(I->getOperand(2), Known, Depth + 1, Q);
1055 computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
David Majnemera19d0f22016-08-06 08:16:00 +00001056 }
1057
1058 unsigned MaxHighOnes = 0;
1059 unsigned MaxHighZeros = 0;
1060 if (SPF == SPF_SMAX) {
1061 // If both sides are negative, the result is negative.
Craig Topperca48af32017-04-29 16:43:11 +00001062 if (Known.isNegative() && Known2.isNegative())
David Majnemera19d0f22016-08-06 08:16:00 +00001063 // We can derive a lower bound on the result by taking the max of the
1064 // leading one bits.
Craig Topper8df66c62017-05-12 17:20:30 +00001065 MaxHighOnes =
1066 std::max(Known.countMinLeadingOnes(), Known2.countMinLeadingOnes());
David Majnemera19d0f22016-08-06 08:16:00 +00001067 // If either side is non-negative, the result is non-negative.
Craig Topperca48af32017-04-29 16:43:11 +00001068 else if (Known.isNonNegative() || Known2.isNonNegative())
David Majnemera19d0f22016-08-06 08:16:00 +00001069 MaxHighZeros = 1;
1070 } else if (SPF == SPF_SMIN) {
1071 // If both sides are non-negative, the result is non-negative.
Craig Topperca48af32017-04-29 16:43:11 +00001072 if (Known.isNonNegative() && Known2.isNonNegative())
David Majnemera19d0f22016-08-06 08:16:00 +00001073 // We can derive an upper bound on the result by taking the max of the
1074 // leading zero bits.
Craig Topper8df66c62017-05-12 17:20:30 +00001075 MaxHighZeros = std::max(Known.countMinLeadingZeros(),
1076 Known2.countMinLeadingZeros());
David Majnemera19d0f22016-08-06 08:16:00 +00001077 // If either side is negative, the result is negative.
Craig Topperca48af32017-04-29 16:43:11 +00001078 else if (Known.isNegative() || Known2.isNegative())
David Majnemera19d0f22016-08-06 08:16:00 +00001079 MaxHighOnes = 1;
1080 } else if (SPF == SPF_UMAX) {
1081 // We can derive a lower bound on the result by taking the max of the
1082 // leading one bits.
1083 MaxHighOnes =
Craig Topper8df66c62017-05-12 17:20:30 +00001084 std::max(Known.countMinLeadingOnes(), Known2.countMinLeadingOnes());
David Majnemera19d0f22016-08-06 08:16:00 +00001085 } else if (SPF == SPF_UMIN) {
1086 // We can derive an upper bound on the result by taking the max of the
1087 // leading zero bits.
1088 MaxHighZeros =
Craig Topper8df66c62017-05-12 17:20:30 +00001089 std::max(Known.countMinLeadingZeros(), Known2.countMinLeadingZeros());
Craig Topper8f77dca2018-05-25 19:18:09 +00001090 } else if (SPF == SPF_ABS) {
1091 // RHS from matchSelectPattern returns the negation part of abs pattern.
1092 // If the negate has an NSW flag we can assume the sign bit of the result
1093 // will be 0 because that makes abs(INT_MIN) undefined.
Florian Hahn19f9e322018-08-17 14:39:04 +00001094 if (Q.IIQ.hasNoSignedWrap(cast<Instruction>(RHS)))
Craig Topper8f77dca2018-05-25 19:18:09 +00001095 MaxHighZeros = 1;
David Majnemera19d0f22016-08-06 08:16:00 +00001096 }
1097
Chris Lattner965c7692008-06-02 01:18:21 +00001098 // Only known if known in both the LHS and RHS.
Craig Topperb45eabc2017-04-26 16:39:58 +00001099 Known.One &= Known2.One;
1100 Known.Zero &= Known2.Zero;
David Majnemera19d0f22016-08-06 08:16:00 +00001101 if (MaxHighOnes > 0)
Craig Topperb45eabc2017-04-26 16:39:58 +00001102 Known.One.setHighBits(MaxHighOnes);
David Majnemera19d0f22016-08-06 08:16:00 +00001103 if (MaxHighZeros > 0)
Craig Topperb45eabc2017-04-26 16:39:58 +00001104 Known.Zero.setHighBits(MaxHighZeros);
Jay Foad5a29c362014-05-15 12:12:55 +00001105 break;
David Majnemera19d0f22016-08-06 08:16:00 +00001106 }
Chris Lattner965c7692008-06-02 01:18:21 +00001107 case Instruction::FPTrunc:
1108 case Instruction::FPExt:
1109 case Instruction::FPToUI:
1110 case Instruction::FPToSI:
1111 case Instruction::SIToFP:
1112 case Instruction::UIToFP:
Jay Foad5a29c362014-05-15 12:12:55 +00001113 break; // Can't work with floating point.
Chris Lattner965c7692008-06-02 01:18:21 +00001114 case Instruction::PtrToInt:
1115 case Instruction::IntToPtr:
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001116 // Fall through and handle them the same as zext/trunc.
1117 LLVM_FALLTHROUGH;
Chris Lattner965c7692008-06-02 01:18:21 +00001118 case Instruction::ZExt:
1119 case Instruction::Trunc: {
Chris Lattner229907c2011-07-18 04:54:35 +00001120 Type *SrcTy = I->getOperand(0)->getType();
Nadav Rotem15198e92012-10-26 17:17:05 +00001121
Chris Lattner0cdbc7a2009-09-08 00:13:52 +00001122 unsigned SrcBitWidth;
Chris Lattner965c7692008-06-02 01:18:21 +00001123 // Note that we handle pointer operands here because of inttoptr/ptrtoint
1124 // which fall through here.
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00001125 Type *ScalarTy = SrcTy->getScalarType();
1126 SrcBitWidth = ScalarTy->isPointerTy() ?
1127 Q.DL.getIndexTypeSizeInBits(ScalarTy) :
1128 Q.DL.getTypeSizeInBits(ScalarTy);
Nadav Rotem15198e92012-10-26 17:17:05 +00001129
1130 assert(SrcBitWidth && "SrcBitWidth can't be zero");
Bjorn Petterssond30f3082019-02-28 15:45:29 +00001131 Known = Known.zextOrTrunc(SrcBitWidth, false);
Craig Topperb45eabc2017-04-26 16:39:58 +00001132 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
Bjorn Petterssond30f3082019-02-28 15:45:29 +00001133 Known = Known.zextOrTrunc(BitWidth, true /* ExtendedBitsAreKnownZero */);
Jay Foad5a29c362014-05-15 12:12:55 +00001134 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001135 }
1136 case Instruction::BitCast: {
Chris Lattner229907c2011-07-18 04:54:35 +00001137 Type *SrcTy = I->getOperand(0)->getType();
Vedant Kumarb3091da2018-07-06 20:17:42 +00001138 if (SrcTy->isIntOrPtrTy() &&
Chris Lattneredb84072009-07-02 16:04:08 +00001139 // TODO: For now, not handling conversions like:
1140 // (bitcast i64 %x to <2 x i32>)
Duncan Sands19d0b472010-02-16 11:11:14 +00001141 !I->getType()->isVectorTy()) {
Craig Topperb45eabc2017-04-26 16:39:58 +00001142 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
Jay Foad5a29c362014-05-15 12:12:55 +00001143 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001144 }
1145 break;
1146 }
1147 case Instruction::SExt: {
1148 // Compute the bits in the result that are not present in the input.
Chris Lattner0cdbc7a2009-09-08 00:13:52 +00001149 unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
Craig Topper1bef2c82012-12-22 19:15:35 +00001150
Craig Topperd938fd12017-05-03 22:07:25 +00001151 Known = Known.trunc(SrcBitWidth);
Craig Topperb45eabc2017-04-26 16:39:58 +00001152 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001153 // If the sign bit of the input is known set or clear, then we know the
1154 // top bits of the result.
Craig Topperd938fd12017-05-03 22:07:25 +00001155 Known = Known.sext(BitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +00001156 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001157 }
Hal Finkelf2199b22015-10-23 20:37:08 +00001158 case Instruction::Shl: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001159 // (shl X, C1) & C2 == 0 iff (X & C2 >>u C1) == 0
Florian Hahn19f9e322018-08-17 14:39:04 +00001160 bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
Sam McCalld0d43e62017-12-04 12:51:49 +00001161 auto KZF = [NSW](const APInt &KnownZero, unsigned ShiftAmt) {
1162 APInt KZResult = KnownZero << ShiftAmt;
1163 KZResult.setLowBits(ShiftAmt); // Low bits known 0.
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001164 // If this shift has "nsw" keyword, then the result is either a poison
1165 // value or has the same sign bit as the first operand.
Sam McCalld0d43e62017-12-04 12:51:49 +00001166 if (NSW && KnownZero.isSignBitSet())
1167 KZResult.setSignBit();
1168 return KZResult;
Hal Finkelf2199b22015-10-23 20:37:08 +00001169 };
1170
Sam McCalld0d43e62017-12-04 12:51:49 +00001171 auto KOF = [NSW](const APInt &KnownOne, unsigned ShiftAmt) {
1172 APInt KOResult = KnownOne << ShiftAmt;
1173 if (NSW && KnownOne.isSignBitSet())
1174 KOResult.setSignBit();
1175 return KOResult;
1176 };
1177
1178 computeKnownBitsFromShiftOperator(I, Known, Known2, Depth, Q, KZF, KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001179 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001180 }
1181 case Instruction::LShr: {
Sanjay Patelb7d12382017-10-16 14:46:37 +00001182 // (lshr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Sam McCalld0d43e62017-12-04 12:51:49 +00001183 auto KZF = [](const APInt &KnownZero, unsigned ShiftAmt) {
1184 APInt KZResult = KnownZero.lshr(ShiftAmt);
1185 // High bits known zero.
1186 KZResult.setHighBits(ShiftAmt);
1187 return KZResult;
Hal Finkelf2199b22015-10-23 20:37:08 +00001188 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001189
Sam McCalld0d43e62017-12-04 12:51:49 +00001190 auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
1191 return KnownOne.lshr(ShiftAmt);
1192 };
1193
1194 computeKnownBitsFromShiftOperator(I, Known, Known2, Depth, Q, KZF, KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001195 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001196 }
1197 case Instruction::AShr: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001198 // (ashr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Sam McCalld0d43e62017-12-04 12:51:49 +00001199 auto KZF = [](const APInt &KnownZero, unsigned ShiftAmt) {
1200 return KnownZero.ashr(ShiftAmt);
Hal Finkelf2199b22015-10-23 20:37:08 +00001201 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001202
Sam McCalld0d43e62017-12-04 12:51:49 +00001203 auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
1204 return KnownOne.ashr(ShiftAmt);
1205 };
1206
1207 computeKnownBitsFromShiftOperator(I, Known, Known2, Depth, Q, KZF, KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001208 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001209 }
Chris Lattner965c7692008-06-02 01:18:21 +00001210 case Instruction::Sub: {
Florian Hahn19f9e322018-08-17 14:39:04 +00001211 bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
Jay Foada0653a32014-05-14 21:14:37 +00001212 computeKnownBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
Craig Topperb45eabc2017-04-26 16:39:58 +00001213 Known, Known2, Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001214 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001215 }
Chris Lattner965c7692008-06-02 01:18:21 +00001216 case Instruction::Add: {
Florian Hahn19f9e322018-08-17 14:39:04 +00001217 bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
Jay Foada0653a32014-05-14 21:14:37 +00001218 computeKnownBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
Craig Topperb45eabc2017-04-26 16:39:58 +00001219 Known, Known2, Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001220 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001221 }
1222 case Instruction::SRem:
1223 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001224 APInt RA = Rem->getValue().abs();
1225 if (RA.isPowerOf2()) {
1226 APInt LowBits = RA - 1;
Craig Topperb45eabc2017-04-26 16:39:58 +00001227 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001228
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001229 // The low bits of the first operand are unchanged by the srem.
Craig Topperb45eabc2017-04-26 16:39:58 +00001230 Known.Zero = Known2.Zero & LowBits;
1231 Known.One = Known2.One & LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +00001232
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001233 // If the first operand is non-negative or has all low bits zero, then
1234 // the upper bits are all zero.
Craig Topperca48af32017-04-29 16:43:11 +00001235 if (Known2.isNonNegative() || LowBits.isSubsetOf(Known2.Zero))
Craig Topperb45eabc2017-04-26 16:39:58 +00001236 Known.Zero |= ~LowBits;
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001237
1238 // If the first operand is negative and not all low bits are zero, then
1239 // the upper bits are all one.
Craig Topperca48af32017-04-29 16:43:11 +00001240 if (Known2.isNegative() && LowBits.intersects(Known2.One))
Craig Topperb45eabc2017-04-26 16:39:58 +00001241 Known.One |= ~LowBits;
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001242
Craig Topperb45eabc2017-04-26 16:39:58 +00001243 assert((Known.Zero & Known.One) == 0 && "Bits known to be one AND zero?");
Craig Topperda886c62017-04-16 21:46:12 +00001244 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001245 }
1246 }
Nick Lewyckye4679792011-03-07 01:50:10 +00001247
1248 // The sign bit is the LHS's sign bit, except when the result of the
1249 // remainder is zero.
Craig Topperb45eabc2017-04-26 16:39:58 +00001250 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Craig Topperda886c62017-04-16 21:46:12 +00001251 // If it's known zero, our sign bit is also zero.
Craig Topperca48af32017-04-29 16:43:11 +00001252 if (Known2.isNonNegative())
1253 Known.makeNonNegative();
Nick Lewyckye4679792011-03-07 01:50:10 +00001254
Chris Lattner965c7692008-06-02 01:18:21 +00001255 break;
1256 case Instruction::URem: {
1257 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00001258 const APInt &RA = Rem->getValue();
Chris Lattner965c7692008-06-02 01:18:21 +00001259 if (RA.isPowerOf2()) {
1260 APInt LowBits = (RA - 1);
Craig Topperb45eabc2017-04-26 16:39:58 +00001261 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1262 Known.Zero |= ~LowBits;
1263 Known.One &= LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +00001264 break;
1265 }
1266 }
1267
1268 // Since the result is less than or equal to either operand, any leading
1269 // zero bits in either operand must also exist in the result.
Craig Topperb45eabc2017-04-26 16:39:58 +00001270 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1271 computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001272
Craig Topper8df66c62017-05-12 17:20:30 +00001273 unsigned Leaders =
1274 std::max(Known.countMinLeadingZeros(), Known2.countMinLeadingZeros());
Craig Topperf0aeee02017-05-05 17:36:09 +00001275 Known.resetAll();
Craig Topperb45eabc2017-04-26 16:39:58 +00001276 Known.Zero.setHighBits(Leaders);
Chris Lattner965c7692008-06-02 01:18:21 +00001277 break;
1278 }
1279
Victor Hernandeza3aaf852009-10-17 01:18:07 +00001280 case Instruction::Alloca: {
Pete Cooper35b00d52016-08-13 01:05:32 +00001281 const AllocaInst *AI = cast<AllocaInst>(I);
Chris Lattner965c7692008-06-02 01:18:21 +00001282 unsigned Align = AI->getAlignment();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001283 if (Align == 0)
Eduard Burtescu90c44492016-01-18 00:10:01 +00001284 Align = Q.DL.getABITypeAlignment(AI->getAllocatedType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001285
Chris Lattner965c7692008-06-02 01:18:21 +00001286 if (Align > 0)
Craig Topperb45eabc2017-04-26 16:39:58 +00001287 Known.Zero.setLowBits(countTrailingZeros(Align));
Chris Lattner965c7692008-06-02 01:18:21 +00001288 break;
1289 }
1290 case Instruction::GetElementPtr: {
1291 // Analyze all of the subscripts of this getelementptr instruction
1292 // to determine if we can prove known low zero bits.
Craig Topperb45eabc2017-04-26 16:39:58 +00001293 KnownBits LocalKnown(BitWidth);
1294 computeKnownBits(I->getOperand(0), LocalKnown, Depth + 1, Q);
Craig Topper8df66c62017-05-12 17:20:30 +00001295 unsigned TrailZ = LocalKnown.countMinTrailingZeros();
Chris Lattner965c7692008-06-02 01:18:21 +00001296
1297 gep_type_iterator GTI = gep_type_begin(I);
1298 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
1299 Value *Index = I->getOperand(i);
Peter Collingbourneab85225b2016-12-02 02:24:42 +00001300 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chris Lattner965c7692008-06-02 01:18:21 +00001301 // Handle struct member offset arithmetic.
Matt Arsenault74742a12013-08-19 21:43:16 +00001302
1303 // Handle case when index is vector zeroinitializer
1304 Constant *CIndex = cast<Constant>(Index);
1305 if (CIndex->isZeroValue())
1306 continue;
1307
1308 if (CIndex->getType()->isVectorTy())
1309 Index = CIndex->getSplatValue();
1310
Chris Lattner965c7692008-06-02 01:18:21 +00001311 unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001312 const StructLayout *SL = Q.DL.getStructLayout(STy);
Chris Lattner965c7692008-06-02 01:18:21 +00001313 uint64_t Offset = SL->getElementOffset(Idx);
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001314 TrailZ = std::min<unsigned>(TrailZ,
1315 countTrailingZeros(Offset));
Chris Lattner965c7692008-06-02 01:18:21 +00001316 } else {
1317 // Handle array index arithmetic.
Chris Lattner229907c2011-07-18 04:54:35 +00001318 Type *IndexedTy = GTI.getIndexedType();
Jay Foad5a29c362014-05-15 12:12:55 +00001319 if (!IndexedTy->isSized()) {
1320 TrailZ = 0;
1321 break;
1322 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +00001323 unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001324 uint64_t TypeSize = Q.DL.getTypeAllocSize(IndexedTy);
Craig Topperb45eabc2017-04-26 16:39:58 +00001325 LocalKnown.Zero = LocalKnown.One = APInt(GEPOpiBits, 0);
1326 computeKnownBits(Index, LocalKnown, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001327 TrailZ = std::min(TrailZ,
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001328 unsigned(countTrailingZeros(TypeSize) +
Craig Topper8df66c62017-05-12 17:20:30 +00001329 LocalKnown.countMinTrailingZeros()));
Chris Lattner965c7692008-06-02 01:18:21 +00001330 }
1331 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001332
Craig Topperb45eabc2017-04-26 16:39:58 +00001333 Known.Zero.setLowBits(TrailZ);
Chris Lattner965c7692008-06-02 01:18:21 +00001334 break;
1335 }
1336 case Instruction::PHI: {
Pete Cooper35b00d52016-08-13 01:05:32 +00001337 const PHINode *P = cast<PHINode>(I);
Chris Lattner965c7692008-06-02 01:18:21 +00001338 // Handle the case of a simple two-predecessor recurrence PHI.
1339 // There's a lot more that could theoretically be done here, but
1340 // this is sufficient to catch some interesting cases.
1341 if (P->getNumIncomingValues() == 2) {
1342 for (unsigned i = 0; i != 2; ++i) {
1343 Value *L = P->getIncomingValue(i);
1344 Value *R = P->getIncomingValue(!i);
Dan Gohman80ca01c2009-07-17 20:47:02 +00001345 Operator *LU = dyn_cast<Operator>(L);
Chris Lattner965c7692008-06-02 01:18:21 +00001346 if (!LU)
1347 continue;
Dan Gohman80ca01c2009-07-17 20:47:02 +00001348 unsigned Opcode = LU->getOpcode();
Chris Lattner965c7692008-06-02 01:18:21 +00001349 // Check for operations that have the property that if
1350 // both their operands have low zero bits, the result
Artur Pilipenkobc76eca2016-08-22 13:14:07 +00001351 // will have low zero bits.
Chris Lattner965c7692008-06-02 01:18:21 +00001352 if (Opcode == Instruction::Add ||
1353 Opcode == Instruction::Sub ||
1354 Opcode == Instruction::And ||
1355 Opcode == Instruction::Or ||
1356 Opcode == Instruction::Mul) {
1357 Value *LL = LU->getOperand(0);
1358 Value *LR = LU->getOperand(1);
1359 // Find a recurrence.
1360 if (LL == I)
1361 L = LR;
1362 else if (LR == I)
1363 L = LL;
1364 else
1365 break;
1366 // Ok, we have a PHI of the form L op= R. Check for low
1367 // zero bits.
Craig Topperb45eabc2017-04-26 16:39:58 +00001368 computeKnownBits(R, Known2, Depth + 1, Q);
David Greeneaebd9e02008-10-27 23:24:03 +00001369
1370 // We need to take the minimum number of known bits
Craig Topperb45eabc2017-04-26 16:39:58 +00001371 KnownBits Known3(Known);
1372 computeKnownBits(L, Known3, Depth + 1, Q);
David Greeneaebd9e02008-10-27 23:24:03 +00001373
Craig Topper8df66c62017-05-12 17:20:30 +00001374 Known.Zero.setLowBits(std::min(Known2.countMinTrailingZeros(),
1375 Known3.countMinTrailingZeros()));
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001376
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001377 auto *OverflowOp = dyn_cast<OverflowingBinaryOperator>(LU);
Florian Hahn19f9e322018-08-17 14:39:04 +00001378 if (OverflowOp && Q.IIQ.hasNoSignedWrap(OverflowOp)) {
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001379 // If initial value of recurrence is nonnegative, and we are adding
1380 // a nonnegative number with nsw, the result can only be nonnegative
1381 // or poison value regardless of the number of times we execute the
1382 // add in phi recurrence. If initial value is negative and we are
1383 // adding a negative number with nsw, the result can only be
1384 // negative or poison value. Similar arguments apply to sub and mul.
1385 //
1386 // (add non-negative, non-negative) --> non-negative
1387 // (add negative, negative) --> negative
1388 if (Opcode == Instruction::Add) {
Craig Topperca48af32017-04-29 16:43:11 +00001389 if (Known2.isNonNegative() && Known3.isNonNegative())
1390 Known.makeNonNegative();
1391 else if (Known2.isNegative() && Known3.isNegative())
1392 Known.makeNegative();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001393 }
1394
1395 // (sub nsw non-negative, negative) --> non-negative
1396 // (sub nsw negative, non-negative) --> negative
1397 else if (Opcode == Instruction::Sub && LL == I) {
Craig Topperca48af32017-04-29 16:43:11 +00001398 if (Known2.isNonNegative() && Known3.isNegative())
1399 Known.makeNonNegative();
1400 else if (Known2.isNegative() && Known3.isNonNegative())
1401 Known.makeNegative();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001402 }
1403
1404 // (mul nsw non-negative, non-negative) --> non-negative
Craig Topperca48af32017-04-29 16:43:11 +00001405 else if (Opcode == Instruction::Mul && Known2.isNonNegative() &&
1406 Known3.isNonNegative())
1407 Known.makeNonNegative();
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001408 }
1409
Chris Lattner965c7692008-06-02 01:18:21 +00001410 break;
1411 }
1412 }
1413 }
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001414
Nick Lewyckyac0b62c2011-02-10 23:54:10 +00001415 // Unreachable blocks may have zero-operand PHI nodes.
1416 if (P->getNumIncomingValues() == 0)
Jay Foad5a29c362014-05-15 12:12:55 +00001417 break;
Nick Lewyckyac0b62c2011-02-10 23:54:10 +00001418
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001419 // Otherwise take the unions of the known bit sets of the operands,
1420 // taking conservative care to avoid excessive recursion.
Craig Topperb45eabc2017-04-26 16:39:58 +00001421 if (Depth < MaxDepth - 1 && !Known.Zero && !Known.One) {
Duncan Sands7dc3d472011-03-08 12:39:03 +00001422 // Skip if every incoming value references to ourself.
Nuno Lopes0d44a502012-07-03 21:15:40 +00001423 if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
Duncan Sands7dc3d472011-03-08 12:39:03 +00001424 break;
1425
Craig Topperb45eabc2017-04-26 16:39:58 +00001426 Known.Zero.setAllBits();
1427 Known.One.setAllBits();
Pete Cooper833f34d2015-05-12 20:05:31 +00001428 for (Value *IncValue : P->incoming_values()) {
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001429 // Skip direct self references.
Pete Cooper833f34d2015-05-12 20:05:31 +00001430 if (IncValue == P) continue;
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001431
Craig Topperb45eabc2017-04-26 16:39:58 +00001432 Known2 = KnownBits(BitWidth);
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001433 // Recurse, but cap the recursion to one level, because we don't
1434 // want to waste time spinning around in loops.
Craig Topperb45eabc2017-04-26 16:39:58 +00001435 computeKnownBits(IncValue, Known2, MaxDepth - 1, Q);
1436 Known.Zero &= Known2.Zero;
1437 Known.One &= Known2.One;
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001438 // If all bits have been ruled out, there's no need to check
1439 // more operands.
Craig Topperb45eabc2017-04-26 16:39:58 +00001440 if (!Known.Zero && !Known.One)
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001441 break;
1442 }
1443 }
Chris Lattner965c7692008-06-02 01:18:21 +00001444 break;
1445 }
1446 case Instruction::Call:
Jingyue Wu37fcb592014-06-19 16:50:16 +00001447 case Instruction::Invoke:
Hal Finkel6fd5e1f2016-07-11 02:25:14 +00001448 // If range metadata is attached to this call, set known bits from that,
1449 // and then intersect with known bits based on other properties of the
1450 // function.
Florian Hahn19f9e322018-08-17 14:39:04 +00001451 if (MDNode *MD =
1452 Q.IIQ.getMetadata(cast<Instruction>(I), LLVMContext::MD_range))
Craig Topperf42b23f2017-04-28 06:28:56 +00001453 computeKnownBitsFromRangeMetadata(*MD, Known);
Pete Cooper35b00d52016-08-13 01:05:32 +00001454 if (const Value *RV = ImmutableCallSite(I).getReturnedArgOperand()) {
Craig Topperb45eabc2017-04-26 16:39:58 +00001455 computeKnownBits(RV, Known2, Depth + 1, Q);
1456 Known.Zero |= Known2.Zero;
1457 Known.One |= Known2.One;
Hal Finkel6fd5e1f2016-07-11 02:25:14 +00001458 }
Pete Cooper35b00d52016-08-13 01:05:32 +00001459 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
Chris Lattner965c7692008-06-02 01:18:21 +00001460 switch (II->getIntrinsicID()) {
1461 default: break;
Chad Rosier85204292017-01-17 17:23:51 +00001462 case Intrinsic::bitreverse:
Craig Topperb45eabc2017-04-26 16:39:58 +00001463 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1464 Known.Zero |= Known2.Zero.reverseBits();
1465 Known.One |= Known2.One.reverseBits();
Chad Rosier85204292017-01-17 17:23:51 +00001466 break;
Philip Reames675418e2015-10-06 20:20:45 +00001467 case Intrinsic::bswap:
Craig Topperb45eabc2017-04-26 16:39:58 +00001468 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1469 Known.Zero |= Known2.Zero.byteSwap();
1470 Known.One |= Known2.One.byteSwap();
Philip Reames675418e2015-10-06 20:20:45 +00001471 break;
Craig Topper868813f2017-05-08 17:22:34 +00001472 case Intrinsic::ctlz: {
1473 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1474 // If we have a known 1, its position is our upper bound.
1475 unsigned PossibleLZ = Known2.One.countLeadingZeros();
Benjamin Kramer4ee57472011-12-24 17:31:46 +00001476 // If this call is undefined for 0, the result will be less than 2^n.
1477 if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
Craig Topper868813f2017-05-08 17:22:34 +00001478 PossibleLZ = std::min(PossibleLZ, BitWidth - 1);
1479 unsigned LowBits = Log2_32(PossibleLZ)+1;
1480 Known.Zero.setBitsFrom(LowBits);
1481 break;
1482 }
1483 case Intrinsic::cttz: {
1484 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1485 // If we have a known 1, its position is our upper bound.
1486 unsigned PossibleTZ = Known2.One.countTrailingZeros();
1487 // If this call is undefined for 0, the result will be less than 2^n.
1488 if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
1489 PossibleTZ = std::min(PossibleTZ, BitWidth - 1);
1490 unsigned LowBits = Log2_32(PossibleTZ)+1;
Craig Topperb45eabc2017-04-26 16:39:58 +00001491 Known.Zero.setBitsFrom(LowBits);
Benjamin Kramer4ee57472011-12-24 17:31:46 +00001492 break;
1493 }
1494 case Intrinsic::ctpop: {
Craig Topperb45eabc2017-04-26 16:39:58 +00001495 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
Philip Reamesddcf6b32015-10-14 22:42:12 +00001496 // We can bound the space the count needs. Also, bits known to be zero
1497 // can't contribute to the population.
Craig Topper8df66c62017-05-12 17:20:30 +00001498 unsigned BitsPossiblySet = Known2.countMaxPopulation();
Craig Topper66df10f2017-04-14 06:43:34 +00001499 unsigned LowBits = Log2_32(BitsPossiblySet)+1;
Craig Topperb45eabc2017-04-26 16:39:58 +00001500 Known.Zero.setBitsFrom(LowBits);
Philip Reamesddcf6b32015-10-14 22:42:12 +00001501 // TODO: we could bound KnownOne using the lower bound on the number
1502 // of bits which might be set provided by popcnt KnownOne2.
Chris Lattner965c7692008-06-02 01:18:21 +00001503 break;
1504 }
Nikita Popov687b92c2018-12-02 14:14:11 +00001505 case Intrinsic::fshr:
1506 case Intrinsic::fshl: {
1507 const APInt *SA;
1508 if (!match(I->getOperand(2), m_APInt(SA)))
1509 break;
1510
1511 // Normalize to funnel shift left.
1512 uint64_t ShiftAmt = SA->urem(BitWidth);
1513 if (II->getIntrinsicID() == Intrinsic::fshr)
1514 ShiftAmt = BitWidth - ShiftAmt;
1515
1516 KnownBits Known3(Known);
1517 computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1518 computeKnownBits(I->getOperand(1), Known3, Depth + 1, Q);
1519
1520 Known.Zero =
1521 Known2.Zero.shl(ShiftAmt) | Known3.Zero.lshr(BitWidth - ShiftAmt);
1522 Known.One =
1523 Known2.One.shl(ShiftAmt) | Known3.One.lshr(BitWidth - ShiftAmt);
1524 break;
1525 }
Chad Rosierb3628842011-05-26 23:13:19 +00001526 case Intrinsic::x86_sse42_crc32_64_64:
Craig Topperb45eabc2017-04-26 16:39:58 +00001527 Known.Zero.setBitsFrom(32);
Evan Cheng2a746bf2011-05-22 18:25:30 +00001528 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001529 }
1530 }
1531 break;
Bjorn Pettersson39616032016-10-06 09:56:21 +00001532 case Instruction::ExtractElement:
1533 // Look through extract element. At the moment we keep this simple and skip
1534 // tracking the specific element. But at least we might find information
1535 // valid for all elements of the vector (for example if vector is sign
1536 // extended, shifted, etc).
Craig Topperb45eabc2017-04-26 16:39:58 +00001537 computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
Bjorn Pettersson39616032016-10-06 09:56:21 +00001538 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001539 case Instruction::ExtractValue:
1540 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001541 const ExtractValueInst *EVI = cast<ExtractValueInst>(I);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001542 if (EVI->getNumIndices() != 1) break;
1543 if (EVI->getIndices()[0] == 0) {
1544 switch (II->getIntrinsicID()) {
1545 default: break;
1546 case Intrinsic::uadd_with_overflow:
1547 case Intrinsic::sadd_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +00001548 computeKnownBitsAddSub(true, II->getArgOperand(0),
Craig Topperb45eabc2017-04-26 16:39:58 +00001549 II->getArgOperand(1), false, Known, Known2,
1550 Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001551 break;
1552 case Intrinsic::usub_with_overflow:
1553 case Intrinsic::ssub_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +00001554 computeKnownBitsAddSub(false, II->getArgOperand(0),
Craig Topperb45eabc2017-04-26 16:39:58 +00001555 II->getArgOperand(1), false, Known, Known2,
1556 Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001557 break;
Nick Lewyckyfa306072012-03-18 23:28:48 +00001558 case Intrinsic::umul_with_overflow:
1559 case Intrinsic::smul_with_overflow:
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001560 computeKnownBitsMul(II->getArgOperand(0), II->getArgOperand(1), false,
Craig Topperb45eabc2017-04-26 16:39:58 +00001561 Known, Known2, Depth, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +00001562 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001563 }
1564 }
1565 }
Chris Lattner965c7692008-06-02 01:18:21 +00001566 }
Jingyue Wu12b0c282015-06-15 05:46:29 +00001567}
1568
1569/// Determine which bits of V are known to be either zero or one and return
Craig Topper6e11a052017-05-08 16:22:48 +00001570/// them.
1571KnownBits computeKnownBits(const Value *V, unsigned Depth, const Query &Q) {
1572 KnownBits Known(getBitWidth(V->getType(), Q.DL));
1573 computeKnownBits(V, Known, Depth, Q);
1574 return Known;
1575}
1576
1577/// Determine which bits of V are known to be either zero or one and return
Craig Topperb45eabc2017-04-26 16:39:58 +00001578/// them in the Known bit set.
Jingyue Wu12b0c282015-06-15 05:46:29 +00001579///
1580/// NOTE: we cannot consider 'undef' to be "IsZero" here. The problem is that
1581/// we cannot optimize based on the assumption that it is zero without changing
1582/// it to be an explicit zero. If we don't change it to zero, other code could
1583/// optimized based on the contradictory assumption that it is non-zero.
1584/// Because instcombine aggressively folds operations with undef args anyway,
1585/// this won't lose us code quality.
1586///
1587/// This function is defined on values with integer type, values with pointer
1588/// type, and vectors of integers. In the case
1589/// where V is a vector, known zero, and known one values are the
1590/// same width as the vector element, and the bit is set only if it is true
1591/// for all of the elements in the vector.
Craig Topperb45eabc2017-04-26 16:39:58 +00001592void computeKnownBits(const Value *V, KnownBits &Known, unsigned Depth,
1593 const Query &Q) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001594 assert(V && "No Value?");
1595 assert(Depth <= MaxDepth && "Limit Search Depth");
Craig Topperb45eabc2017-04-26 16:39:58 +00001596 unsigned BitWidth = Known.getBitWidth();
Jingyue Wu12b0c282015-06-15 05:46:29 +00001597
Craig Topperfde47232017-07-09 07:04:03 +00001598 assert((V->getType()->isIntOrIntVectorTy(BitWidth) ||
Craig Topper95d23472017-07-09 07:04:00 +00001599 V->getType()->isPtrOrPtrVectorTy()) &&
Sanjay Pateldba8b4c2016-06-02 20:01:37 +00001600 "Not integer or pointer type!");
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00001601
1602 Type *ScalarTy = V->getType()->getScalarType();
1603 unsigned ExpectedWidth = ScalarTy->isPointerTy() ?
1604 Q.DL.getIndexTypeSizeInBits(ScalarTy) : Q.DL.getTypeSizeInBits(ScalarTy);
1605 assert(ExpectedWidth == BitWidth && "V and Known should have same BitWidth");
Craig Topperd73c6b42017-03-23 07:06:39 +00001606 (void)BitWidth;
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00001607 (void)ExpectedWidth;
Jingyue Wu12b0c282015-06-15 05:46:29 +00001608
Sanjay Patelc96f6db2016-09-16 21:20:36 +00001609 const APInt *C;
1610 if (match(V, m_APInt(C))) {
1611 // We know all of the bits for a scalar constant or a splat vector constant!
Craig Topperb45eabc2017-04-26 16:39:58 +00001612 Known.One = *C;
1613 Known.Zero = ~Known.One;
Jingyue Wu12b0c282015-06-15 05:46:29 +00001614 return;
1615 }
1616 // Null and aggregate-zero are all-zeros.
Sanjay Patele8dc0902016-05-23 17:57:54 +00001617 if (isa<ConstantPointerNull>(V) || isa<ConstantAggregateZero>(V)) {
Craig Topperf0aeee02017-05-05 17:36:09 +00001618 Known.setAllZero();
Jingyue Wu12b0c282015-06-15 05:46:29 +00001619 return;
1620 }
1621 // Handle a constant vector by taking the intersection of the known bits of
David Majnemer3918cdd2016-05-04 06:13:33 +00001622 // each element.
Pete Cooper35b00d52016-08-13 01:05:32 +00001623 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001624 // We know that CDS must be a vector of integers. Take the intersection of
1625 // each element.
Craig Topperb45eabc2017-04-26 16:39:58 +00001626 Known.Zero.setAllBits(); Known.One.setAllBits();
Jingyue Wu12b0c282015-06-15 05:46:29 +00001627 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
Craig Topperb98ee582017-10-21 16:35:39 +00001628 APInt Elt = CDS->getElementAsAPInt(i);
Craig Topperb45eabc2017-04-26 16:39:58 +00001629 Known.Zero &= ~Elt;
1630 Known.One &= Elt;
Jingyue Wu12b0c282015-06-15 05:46:29 +00001631 }
1632 return;
1633 }
1634
Pete Cooper35b00d52016-08-13 01:05:32 +00001635 if (const auto *CV = dyn_cast<ConstantVector>(V)) {
David Majnemer3918cdd2016-05-04 06:13:33 +00001636 // We know that CV must be a vector of integers. Take the intersection of
1637 // each element.
Craig Topperb45eabc2017-04-26 16:39:58 +00001638 Known.Zero.setAllBits(); Known.One.setAllBits();
David Majnemer3918cdd2016-05-04 06:13:33 +00001639 for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i) {
1640 Constant *Element = CV->getAggregateElement(i);
1641 auto *ElementCI = dyn_cast_or_null<ConstantInt>(Element);
1642 if (!ElementCI) {
Craig Topperf0aeee02017-05-05 17:36:09 +00001643 Known.resetAll();
David Majnemer3918cdd2016-05-04 06:13:33 +00001644 return;
1645 }
Craig Topperb98ee582017-10-21 16:35:39 +00001646 const APInt &Elt = ElementCI->getValue();
Craig Topperb45eabc2017-04-26 16:39:58 +00001647 Known.Zero &= ~Elt;
1648 Known.One &= Elt;
David Majnemer3918cdd2016-05-04 06:13:33 +00001649 }
1650 return;
1651 }
1652
Jingyue Wu12b0c282015-06-15 05:46:29 +00001653 // Start out not knowing anything.
Craig Topperf0aeee02017-05-05 17:36:09 +00001654 Known.resetAll();
Jingyue Wu12b0c282015-06-15 05:46:29 +00001655
Duncan P. N. Exon Smithb1b208a2016-09-24 20:42:02 +00001656 // We can't imply anything about undefs.
1657 if (isa<UndefValue>(V))
1658 return;
1659
1660 // There's no point in looking through other users of ConstantData for
1661 // assumptions. Confirm that we've handled them all.
1662 assert(!isa<ConstantData>(V) && "Unhandled constant data!");
1663
Jingyue Wu12b0c282015-06-15 05:46:29 +00001664 // Limit search depth.
1665 // All recursive calls that increase depth must come after this.
1666 if (Depth == MaxDepth)
1667 return;
1668
1669 // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
1670 // the bits of its aliasee.
Pete Cooper35b00d52016-08-13 01:05:32 +00001671 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00001672 if (!GA->isInterposable())
Craig Topperb45eabc2017-04-26 16:39:58 +00001673 computeKnownBits(GA->getAliasee(), Known, Depth + 1, Q);
Jingyue Wu12b0c282015-06-15 05:46:29 +00001674 return;
1675 }
1676
Pete Cooper35b00d52016-08-13 01:05:32 +00001677 if (const Operator *I = dyn_cast<Operator>(V))
Craig Topperb45eabc2017-04-26 16:39:58 +00001678 computeKnownBitsFromOperator(I, Known, Depth, Q);
Sanjay Patela67559c2015-09-25 20:12:43 +00001679
Craig Topperb45eabc2017-04-26 16:39:58 +00001680 // Aligned pointers have trailing zeros - refine Known.Zero set
Artur Pilipenko029d8532015-09-30 11:55:45 +00001681 if (V->getType()->isPointerTy()) {
Artur Pilipenkoae51afc2016-02-24 12:25:10 +00001682 unsigned Align = V->getPointerAlignment(Q.DL);
Artur Pilipenko029d8532015-09-30 11:55:45 +00001683 if (Align)
Craig Topperb45eabc2017-04-26 16:39:58 +00001684 Known.Zero.setLowBits(countTrailingZeros(Align));
Artur Pilipenko029d8532015-09-30 11:55:45 +00001685 }
1686
Craig Topperb45eabc2017-04-26 16:39:58 +00001687 // computeKnownBitsFromAssume strictly refines Known.
1688 // Therefore, we run them after computeKnownBitsFromOperator.
Jingyue Wu12b0c282015-06-15 05:46:29 +00001689
1690 // Check whether a nearby assume intrinsic can determine some known bits.
Craig Topperb45eabc2017-04-26 16:39:58 +00001691 computeKnownBitsFromAssume(V, Known, Depth, Q);
Jingyue Wu12b0c282015-06-15 05:46:29 +00001692
Craig Topperb45eabc2017-04-26 16:39:58 +00001693 assert((Known.Zero & Known.One) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +00001694}
1695
Sanjay Patelaee84212014-11-04 16:27:42 +00001696/// Return true if the given value is known to have exactly one
Duncan Sandsd3951082011-01-25 09:38:29 +00001697/// bit set when defined. For vectors return true if every element is known to
Sanjay Patelaee84212014-11-04 16:27:42 +00001698/// be a power of two when defined. Supports values with integer or pointer
Duncan Sandsd3951082011-01-25 09:38:29 +00001699/// types and vectors of integers.
Pete Cooper35b00d52016-08-13 01:05:32 +00001700bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001701 const Query &Q) {
Craig Topper7227eba2017-08-21 22:56:12 +00001702 assert(Depth <= MaxDepth && "Limit Search Depth");
1703
Simon Pilgrim9f2ae7e2018-02-06 18:39:23 +00001704 // Attempt to match against constants.
1705 if (OrZero && match(V, m_Power2OrZero()))
1706 return true;
1707 if (match(V, m_Power2()))
1708 return true;
Duncan Sandsd3951082011-01-25 09:38:29 +00001709
1710 // 1 << X is clearly a power of two if the one is not shifted off the end. If
1711 // it is shifted off the end then the result is undefined.
1712 if (match(V, m_Shl(m_One(), m_Value())))
1713 return true;
1714
Craig Topperbcfd2d12017-04-20 16:56:25 +00001715 // (signmask) >>l X is clearly a power of two if the one is not shifted off
1716 // the bottom. If it is shifted off the bottom then the result is undefined.
1717 if (match(V, m_LShr(m_SignMask(), m_Value())))
Duncan Sandsd3951082011-01-25 09:38:29 +00001718 return true;
1719
1720 // The remaining tests are all recursive, so bail out if we hit the limit.
1721 if (Depth++ == MaxDepth)
1722 return false;
1723
Craig Topper9f008862014-04-15 04:59:12 +00001724 Value *X = nullptr, *Y = nullptr;
Sanjay Patel41160c22015-12-30 22:40:52 +00001725 // A shift left or a logical shift right of a power of two is a power of two
1726 // or zero.
Duncan Sands985ba632011-10-28 18:30:05 +00001727 if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
Sanjay Patel41160c22015-12-30 22:40:52 +00001728 match(V, m_LShr(m_Value(X), m_Value()))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001729 return isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q);
Duncan Sands985ba632011-10-28 18:30:05 +00001730
Pete Cooper35b00d52016-08-13 01:05:32 +00001731 if (const ZExtInst *ZI = dyn_cast<ZExtInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001732 return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001733
Pete Cooper35b00d52016-08-13 01:05:32 +00001734 if (const SelectInst *SI = dyn_cast<SelectInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001735 return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth, Q) &&
1736 isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth, Q);
Duncan Sandsba286d72011-10-26 20:55:21 +00001737
Duncan Sandsba286d72011-10-26 20:55:21 +00001738 if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
1739 // A power of two and'd with anything is a power of two or zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001740 if (isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q) ||
1741 isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, Depth, Q))
Duncan Sandsba286d72011-10-26 20:55:21 +00001742 return true;
1743 // X & (-X) is always a power of two or zero.
1744 if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
1745 return true;
1746 return false;
1747 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001748
David Majnemerb7d54092013-07-30 21:01:36 +00001749 // Adding a power-of-two or zero to the same power-of-two or zero yields
1750 // either the original power-of-two, a larger power-of-two or zero.
1751 if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001752 const OverflowingBinaryOperator *VOBO = cast<OverflowingBinaryOperator>(V);
Florian Hahn19f9e322018-08-17 14:39:04 +00001753 if (OrZero || Q.IIQ.hasNoUnsignedWrap(VOBO) ||
1754 Q.IIQ.hasNoSignedWrap(VOBO)) {
David Majnemerb7d54092013-07-30 21:01:36 +00001755 if (match(X, m_And(m_Specific(Y), m_Value())) ||
1756 match(X, m_And(m_Value(), m_Specific(Y))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001757 if (isKnownToBeAPowerOfTwo(Y, OrZero, Depth, Q))
David Majnemerb7d54092013-07-30 21:01:36 +00001758 return true;
1759 if (match(Y, m_And(m_Specific(X), m_Value())) ||
1760 match(Y, m_And(m_Value(), m_Specific(X))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001761 if (isKnownToBeAPowerOfTwo(X, OrZero, Depth, Q))
David Majnemerb7d54092013-07-30 21:01:36 +00001762 return true;
1763
1764 unsigned BitWidth = V->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +00001765 KnownBits LHSBits(BitWidth);
1766 computeKnownBits(X, LHSBits, Depth, Q);
David Majnemerb7d54092013-07-30 21:01:36 +00001767
Craig Topperb45eabc2017-04-26 16:39:58 +00001768 KnownBits RHSBits(BitWidth);
1769 computeKnownBits(Y, RHSBits, Depth, Q);
David Majnemerb7d54092013-07-30 21:01:36 +00001770 // If i8 V is a power of two or zero:
1771 // ZeroBits: 1 1 1 0 1 1 1 1
1772 // ~ZeroBits: 0 0 0 1 0 0 0 0
Craig Topperb45eabc2017-04-26 16:39:58 +00001773 if ((~(LHSBits.Zero & RHSBits.Zero)).isPowerOf2())
David Majnemerb7d54092013-07-30 21:01:36 +00001774 // If OrZero isn't set, we cannot give back a zero result.
1775 // Make sure either the LHS or RHS has a bit set.
Craig Topperb45eabc2017-04-26 16:39:58 +00001776 if (OrZero || RHSBits.One.getBoolValue() || LHSBits.One.getBoolValue())
David Majnemerb7d54092013-07-30 21:01:36 +00001777 return true;
1778 }
1779 }
David Majnemerbeab5672013-05-18 19:30:37 +00001780
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001781 // An exact divide or right shift can only shift off zero bits, so the result
Nick Lewyckyf0469af2011-03-21 21:40:32 +00001782 // is a power of two only if the first operand is a power of two and not
1783 // copying a sign bit (sdiv int_min, 2).
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001784 if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
1785 match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
Hal Finkel60db0582014-09-07 18:57:58 +00001786 return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001787 Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001788 }
1789
Duncan Sandsd3951082011-01-25 09:38:29 +00001790 return false;
1791}
1792
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001793/// Test whether a GEP's result is known to be non-null.
Chandler Carruth80d3e562012-12-07 02:08:58 +00001794///
1795/// Uses properties inherent in a GEP to try to determine whether it is known
1796/// to be non-null.
1797///
1798/// Currently this routine does not support vector GEPs.
Pete Cooper35b00d52016-08-13 01:05:32 +00001799static bool isGEPKnownNonNull(const GEPOperator *GEP, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001800 const Query &Q) {
Manoj Gupta77eeac32018-07-09 22:27:23 +00001801 const Function *F = nullptr;
1802 if (const Instruction *I = dyn_cast<Instruction>(GEP))
1803 F = I->getFunction();
1804
1805 if (!GEP->isInBounds() ||
1806 NullPointerIsDefined(F, GEP->getPointerAddressSpace()))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001807 return false;
1808
1809 // FIXME: Support vector-GEPs.
1810 assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
1811
1812 // If the base pointer is non-null, we cannot walk to a null address with an
1813 // inbounds GEP in address space zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001814 if (isKnownNonZero(GEP->getPointerOperand(), Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001815 return true;
1816
Chandler Carruth80d3e562012-12-07 02:08:58 +00001817 // Walk the GEP operands and see if any operand introduces a non-zero offset.
1818 // If so, then the GEP cannot produce a null pointer, as doing so would
1819 // inherently violate the inbounds contract within address space zero.
1820 for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
1821 GTI != GTE; ++GTI) {
1822 // Struct types are easy -- they must always be indexed by a constant.
Peter Collingbourneab85225b2016-12-02 02:24:42 +00001823 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chandler Carruth80d3e562012-12-07 02:08:58 +00001824 ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
1825 unsigned ElementIdx = OpC->getZExtValue();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001826 const StructLayout *SL = Q.DL.getStructLayout(STy);
Chandler Carruth80d3e562012-12-07 02:08:58 +00001827 uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
1828 if (ElementOffset > 0)
1829 return true;
1830 continue;
1831 }
1832
1833 // If we have a zero-sized type, the index doesn't matter. Keep looping.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001834 if (Q.DL.getTypeAllocSize(GTI.getIndexedType()) == 0)
Chandler Carruth80d3e562012-12-07 02:08:58 +00001835 continue;
1836
1837 // Fast path the constant operand case both for efficiency and so we don't
1838 // increment Depth when just zipping down an all-constant GEP.
1839 if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
1840 if (!OpC->isZero())
1841 return true;
1842 continue;
1843 }
1844
1845 // We post-increment Depth here because while isKnownNonZero increments it
1846 // as well, when we pop back up that increment won't persist. We don't want
1847 // to recurse 10k times just because we have 10k GEP operands. We don't
1848 // bail completely out because we want to handle constant GEPs regardless
1849 // of depth.
1850 if (Depth++ >= MaxDepth)
1851 continue;
1852
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001853 if (isKnownNonZero(GTI.getOperand(), Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001854 return true;
1855 }
1856
1857 return false;
1858}
1859
Nuno Lopes404f1062017-09-09 18:23:11 +00001860static bool isKnownNonNullFromDominatingCondition(const Value *V,
1861 const Instruction *CtxI,
1862 const DominatorTree *DT) {
1863 assert(V->getType()->isPointerTy() && "V must be pointer type");
1864 assert(!isa<ConstantData>(V) && "Did not expect ConstantPointerNull");
1865
1866 if (!CtxI || !DT)
1867 return false;
1868
1869 unsigned NumUsesExplored = 0;
1870 for (auto *U : V->users()) {
1871 // Avoid massive lists
1872 if (NumUsesExplored >= DomConditionsMaxUses)
1873 break;
1874 NumUsesExplored++;
1875
1876 // If the value is used as an argument to a call or invoke, then argument
1877 // attributes may provide an answer about null-ness.
1878 if (auto CS = ImmutableCallSite(U))
1879 if (auto *CalledFunc = CS.getCalledFunction())
1880 for (const Argument &Arg : CalledFunc->args())
1881 if (CS.getArgOperand(Arg.getArgNo()) == V &&
1882 Arg.hasNonNullAttr() && DT->dominates(CS.getInstruction(), CtxI))
1883 return true;
1884
1885 // Consider only compare instructions uniquely controlling a branch
1886 CmpInst::Predicate Pred;
1887 if (!match(const_cast<User *>(U),
1888 m_c_ICmp(Pred, m_Specific(V), m_Zero())) ||
1889 (Pred != ICmpInst::ICMP_EQ && Pred != ICmpInst::ICMP_NE))
1890 continue;
1891
Max Kazantsev2dbbd642018-08-06 11:14:18 +00001892 SmallVector<const User *, 4> WorkList;
1893 SmallPtrSet<const User *, 4> Visited;
Nuno Lopes404f1062017-09-09 18:23:11 +00001894 for (auto *CmpU : U->users()) {
Max Kazantsev2dbbd642018-08-06 11:14:18 +00001895 assert(WorkList.empty() && "Should be!");
1896 if (Visited.insert(CmpU).second)
1897 WorkList.push_back(CmpU);
Nuno Lopes404f1062017-09-09 18:23:11 +00001898
Max Kazantsev2dbbd642018-08-06 11:14:18 +00001899 while (!WorkList.empty()) {
1900 auto *Curr = WorkList.pop_back_val();
1901
1902 // If a user is an AND, add all its users to the work list. We only
1903 // propagate "pred != null" condition through AND because it is only
1904 // correct to assume that all conditions of AND are met in true branch.
1905 // TODO: Support similar logic of OR and EQ predicate?
1906 if (Pred == ICmpInst::ICMP_NE)
1907 if (auto *BO = dyn_cast<BinaryOperator>(Curr))
1908 if (BO->getOpcode() == Instruction::And) {
1909 for (auto *BOU : BO->users())
1910 if (Visited.insert(BOU).second)
1911 WorkList.push_back(BOU);
1912 continue;
1913 }
1914
1915 if (const BranchInst *BI = dyn_cast<BranchInst>(Curr)) {
1916 assert(BI->isConditional() && "uses a comparison!");
1917
1918 BasicBlock *NonNullSuccessor =
1919 BI->getSuccessor(Pred == ICmpInst::ICMP_EQ ? 1 : 0);
1920 BasicBlockEdge Edge(BI->getParent(), NonNullSuccessor);
1921 if (Edge.isSingleEdge() && DT->dominates(Edge, CtxI->getParent()))
1922 return true;
Max Kazantsev3c284bd2018-08-30 03:39:16 +00001923 } else if (Pred == ICmpInst::ICMP_NE && isGuard(Curr) &&
Max Kazantsev2dbbd642018-08-06 11:14:18 +00001924 DT->dominates(cast<Instruction>(Curr), CtxI)) {
Nuno Lopes404f1062017-09-09 18:23:11 +00001925 return true;
Max Kazantsev2dbbd642018-08-06 11:14:18 +00001926 }
Nuno Lopes404f1062017-09-09 18:23:11 +00001927 }
1928 }
1929 }
1930
1931 return false;
1932}
1933
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001934/// Does the 'Range' metadata (which must be a valid MD_range operand list)
1935/// ensure that the value it's attached to is never Value? 'RangeType' is
1936/// is the type of the value described by the range.
Pete Cooper35b00d52016-08-13 01:05:32 +00001937static bool rangeMetadataExcludesValue(const MDNode* Ranges, const APInt& Value) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001938 const unsigned NumRanges = Ranges->getNumOperands() / 2;
1939 assert(NumRanges >= 1);
1940 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001941 ConstantInt *Lower =
1942 mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 0));
1943 ConstantInt *Upper =
1944 mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 1));
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001945 ConstantRange Range(Lower->getValue(), Upper->getValue());
1946 if (Range.contains(Value))
1947 return false;
1948 }
1949 return true;
1950}
1951
Sanjay Patel97e4b9872017-02-12 15:35:34 +00001952/// Return true if the given value is known to be non-zero when defined. For
1953/// vectors, return true if every element is known to be non-zero when
1954/// defined. For pointers, if the context instruction and dominator tree are
1955/// specified, perform context-sensitive analysis and return true if the
1956/// pointer couldn't possibly be null at the specified instruction.
1957/// Supports values with integer or pointer type and vectors of integers.
Pete Cooper35b00d52016-08-13 01:05:32 +00001958bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q) {
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001959 if (auto *C = dyn_cast<Constant>(V)) {
Duncan Sandsd3951082011-01-25 09:38:29 +00001960 if (C->isNullValue())
1961 return false;
1962 if (isa<ConstantInt>(C))
1963 // Must be non-zero due to null test above.
1964 return true;
Sanjay Patel23019d12016-05-24 14:18:49 +00001965
1966 // For constant vectors, check that all elements are undefined or known
1967 // non-zero to determine that the whole vector is known non-zero.
1968 if (auto *VecTy = dyn_cast<VectorType>(C->getType())) {
1969 for (unsigned i = 0, e = VecTy->getNumElements(); i != e; ++i) {
1970 Constant *Elt = C->getAggregateElement(i);
1971 if (!Elt || Elt->isNullValue())
1972 return false;
1973 if (!isa<UndefValue>(Elt) && !isa<ConstantInt>(Elt))
1974 return false;
1975 }
1976 return true;
1977 }
1978
Nuno Lopes404f1062017-09-09 18:23:11 +00001979 // A global variable in address space 0 is non null unless extern weak
1980 // or an absolute symbol reference. Other address spaces may have null as a
1981 // valid address for a global, so we can't assume anything.
1982 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1983 if (!GV->isAbsoluteSymbolRef() && !GV->hasExternalWeakLinkage() &&
1984 GV->getType()->getAddressSpace() == 0)
1985 return true;
1986 } else
1987 return false;
Duncan Sandsd3951082011-01-25 09:38:29 +00001988 }
1989
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001990 if (auto *I = dyn_cast<Instruction>(V)) {
Florian Hahn19f9e322018-08-17 14:39:04 +00001991 if (MDNode *Ranges = Q.IIQ.getMetadata(I, LLVMContext::MD_range)) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001992 // If the possible ranges don't contain zero, then the value is
1993 // definitely non-zero.
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001994 if (auto *Ty = dyn_cast<IntegerType>(V->getType())) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001995 const APInt ZeroValue(Ty->getBitWidth(), 0);
1996 if (rangeMetadataExcludesValue(Ranges, ZeroValue))
1997 return true;
1998 }
1999 }
2000 }
2001
Karl-Johan Karlssonebaaa2d2018-05-30 15:56:46 +00002002 // Some of the tests below are recursive, so bail out if we hit the limit.
2003 if (Depth++ >= MaxDepth)
2004 return false;
2005
Nuno Lopes404f1062017-09-09 18:23:11 +00002006 // Check for pointer simplifications.
2007 if (V->getType()->isPointerTy()) {
2008 // Alloca never returns null, malloc might.
2009 if (isa<AllocaInst>(V) && Q.DL.getAllocaAddrSpace() == 0)
2010 return true;
2011
2012 // A byval, inalloca, or nonnull argument is never null.
2013 if (const Argument *A = dyn_cast<Argument>(V))
2014 if (A->hasByValOrInAllocaAttr() || A->hasNonNullAttr())
2015 return true;
2016
2017 // A Load tagged with nonnull metadata is never null.
2018 if (const LoadInst *LI = dyn_cast<LoadInst>(V))
Florian Hahn19f9e322018-08-17 14:39:04 +00002019 if (Q.IIQ.getMetadata(LI, LLVMContext::MD_nonnull))
Nuno Lopes404f1062017-09-09 18:23:11 +00002020 return true;
2021
Chandler Carruth363ac682019-01-07 05:42:51 +00002022 if (const auto *Call = dyn_cast<CallBase>(V)) {
2023 if (Call->isReturnNonNull())
Nuno Lopes404f1062017-09-09 18:23:11 +00002024 return true;
Chandler Carruth363ac682019-01-07 05:42:51 +00002025 if (const auto *RP = getArgumentAliasingToReturnedPointer(Call))
Karl-Johan Karlssonebaaa2d2018-05-30 15:56:46 +00002026 return isKnownNonZero(RP, Depth, Q);
Piotr Padlewski5642a422018-05-18 23:54:33 +00002027 }
Nuno Lopes404f1062017-09-09 18:23:11 +00002028 }
2029
Duncan Sandsd3951082011-01-25 09:38:29 +00002030
Nuno Lopes404f1062017-09-09 18:23:11 +00002031 // Check for recursive pointer simplifications.
Chandler Carruth80d3e562012-12-07 02:08:58 +00002032 if (V->getType()->isPointerTy()) {
Nuno Lopes404f1062017-09-09 18:23:11 +00002033 if (isKnownNonNullFromDominatingCondition(V, Q.CxtI, Q.DT))
Sanjoy Das6082c1a2016-05-07 02:08:15 +00002034 return true;
Nuno Lopes404f1062017-09-09 18:23:11 +00002035
Johannes Doerfert00102c72019-01-26 23:40:35 +00002036 // Look through bitcast operations, GEPs, and int2ptr instructions as they
2037 // do not alter the value, or at least not the nullness property of the
2038 // value, e.g., int2ptr is allowed to zero/sign extend the value.
2039 //
2040 // Note that we have to take special care to avoid looking through
2041 // truncating casts, e.g., int2ptr/ptr2int with appropriate sizes, as well
2042 // as casts that can alter the value, e.g., AddrSpaceCasts.
Pete Cooper35b00d52016-08-13 01:05:32 +00002043 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002044 if (isGEPKnownNonNull(GEP, Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00002045 return true;
Johannes Doerfert00102c72019-01-26 23:40:35 +00002046
2047 if (auto *BCO = dyn_cast<BitCastOperator>(V))
2048 return isKnownNonZero(BCO->getOperand(0), Depth, Q);
2049
2050 if (auto *I2P = dyn_cast<IntToPtrInst>(V))
2051 if (Q.DL.getTypeSizeInBits(I2P->getSrcTy()) <=
2052 Q.DL.getTypeSizeInBits(I2P->getDestTy()))
2053 return isKnownNonZero(I2P->getOperand(0), Depth, Q);
Chandler Carruth80d3e562012-12-07 02:08:58 +00002054 }
2055
Johannes Doerfert00102c72019-01-26 23:40:35 +00002056 // Similar to int2ptr above, we can look through ptr2int here if the cast
2057 // is a no-op or an extend and not a truncate.
2058 if (auto *P2I = dyn_cast<PtrToIntInst>(V))
2059 if (Q.DL.getTypeSizeInBits(P2I->getSrcTy()) <=
2060 Q.DL.getTypeSizeInBits(P2I->getDestTy()))
2061 return isKnownNonZero(P2I->getOperand(0), Depth, Q);
2062
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002063 unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), Q.DL);
Duncan Sandsd3951082011-01-25 09:38:29 +00002064
2065 // X | Y != 0 if X != 0 or Y != 0.
Craig Topper9f008862014-04-15 04:59:12 +00002066 Value *X = nullptr, *Y = nullptr;
Duncan Sandsd3951082011-01-25 09:38:29 +00002067 if (match(V, m_Or(m_Value(X), m_Value(Y))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002068 return isKnownNonZero(X, Depth, Q) || isKnownNonZero(Y, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00002069
2070 // ext X != 0 if X != 0.
2071 if (isa<SExtInst>(V) || isa<ZExtInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002072 return isKnownNonZero(cast<Instruction>(V)->getOperand(0), Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00002073
Duncan Sands2e9e4f12011-01-29 13:27:00 +00002074 // shl X, Y != 0 if X is odd. Note that the value of the shift is undefined
Duncan Sandsd3951082011-01-25 09:38:29 +00002075 // if the lowest bit is shifted off the end.
Craig Topper6b3940a2017-05-03 22:25:19 +00002076 if (match(V, m_Shl(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002077 // shl nuw can't remove any non-zero bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00002078 const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Florian Hahn19f9e322018-08-17 14:39:04 +00002079 if (Q.IIQ.hasNoUnsignedWrap(BO))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002080 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002081
Craig Topperb45eabc2017-04-26 16:39:58 +00002082 KnownBits Known(BitWidth);
2083 computeKnownBits(X, Known, Depth, Q);
2084 if (Known.One[0])
Duncan Sandsd3951082011-01-25 09:38:29 +00002085 return true;
2086 }
Duncan Sands2e9e4f12011-01-29 13:27:00 +00002087 // shr X, Y != 0 if X is negative. Note that the value of the shift is not
Duncan Sandsd3951082011-01-25 09:38:29 +00002088 // defined if the sign bit is shifted off the end.
2089 else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002090 // shr exact can only shift out zero bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00002091 const PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002092 if (BO->isExact())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002093 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002094
Craig Topper6e11a052017-05-08 16:22:48 +00002095 KnownBits Known = computeKnownBits(X, Depth, Q);
2096 if (Known.isNegative())
Duncan Sandsd3951082011-01-25 09:38:29 +00002097 return true;
James Molloyb6be1eb2015-09-24 16:06:32 +00002098
2099 // If the shifter operand is a constant, and all of the bits shifted
2100 // out are known to be zero, and X is known non-zero then at least one
2101 // non-zero bit must remain.
2102 if (ConstantInt *Shift = dyn_cast<ConstantInt>(Y)) {
James Molloyb6be1eb2015-09-24 16:06:32 +00002103 auto ShiftVal = Shift->getLimitedValue(BitWidth - 1);
2104 // Is there a known one in the portion not shifted out?
Craig Topper8df66c62017-05-12 17:20:30 +00002105 if (Known.countMaxLeadingZeros() < BitWidth - ShiftVal)
James Molloyb6be1eb2015-09-24 16:06:32 +00002106 return true;
2107 // Are all the bits to be shifted out known zero?
NAKAMURA Takumi76bab1f2017-07-11 02:31:51 +00002108 if (Known.countMinTrailingZeros() >= ShiftVal)
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002109 return isKnownNonZero(X, Depth, Q);
James Molloyb6be1eb2015-09-24 16:06:32 +00002110 }
Duncan Sandsd3951082011-01-25 09:38:29 +00002111 }
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002112 // div exact can only produce a zero if the dividend is zero.
Benjamin Kramer9442cd02012-01-01 17:55:30 +00002113 else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002114 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00002115 }
Duncan Sandsd3951082011-01-25 09:38:29 +00002116 // X + Y.
2117 else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
Craig Topper6e11a052017-05-08 16:22:48 +00002118 KnownBits XKnown = computeKnownBits(X, Depth, Q);
2119 KnownBits YKnown = computeKnownBits(Y, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00002120
2121 // If X and Y are both non-negative (as signed values) then their sum is not
Duncan Sands9e9d5b22011-01-25 15:14:15 +00002122 // zero unless both X and Y are zero.
Craig Topper6e11a052017-05-08 16:22:48 +00002123 if (XKnown.isNonNegative() && YKnown.isNonNegative())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002124 if (isKnownNonZero(X, Depth, Q) || isKnownNonZero(Y, Depth, Q))
Duncan Sands9e9d5b22011-01-25 15:14:15 +00002125 return true;
Duncan Sandsd3951082011-01-25 09:38:29 +00002126
2127 // If X and Y are both negative (as signed values) then their sum is not
2128 // zero unless both X and Y equal INT_MIN.
Craig Topper6e11a052017-05-08 16:22:48 +00002129 if (XKnown.isNegative() && YKnown.isNegative()) {
Duncan Sandsd3951082011-01-25 09:38:29 +00002130 APInt Mask = APInt::getSignedMaxValue(BitWidth);
2131 // The sign bit of X is set. If some other bit is set then X is not equal
2132 // to INT_MIN.
Craig Topper6e11a052017-05-08 16:22:48 +00002133 if (XKnown.One.intersects(Mask))
Duncan Sandsd3951082011-01-25 09:38:29 +00002134 return true;
2135 // The sign bit of Y is set. If some other bit is set then Y is not equal
2136 // to INT_MIN.
Craig Topper6e11a052017-05-08 16:22:48 +00002137 if (YKnown.One.intersects(Mask))
Duncan Sandsd3951082011-01-25 09:38:29 +00002138 return true;
2139 }
2140
2141 // The sum of a non-negative number and a power of two is not zero.
Craig Topper6e11a052017-05-08 16:22:48 +00002142 if (XKnown.isNonNegative() &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002143 isKnownToBeAPowerOfTwo(Y, /*OrZero*/ false, Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00002144 return true;
Craig Topper6e11a052017-05-08 16:22:48 +00002145 if (YKnown.isNonNegative() &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002146 isKnownToBeAPowerOfTwo(X, /*OrZero*/ false, Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00002147 return true;
2148 }
Duncan Sands7cb61e52011-10-27 19:16:21 +00002149 // X * Y.
2150 else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00002151 const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Duncan Sands7cb61e52011-10-27 19:16:21 +00002152 // If X and Y are non-zero then so is X * Y as long as the multiplication
2153 // does not overflow.
Florian Hahn19f9e322018-08-17 14:39:04 +00002154 if ((Q.IIQ.hasNoSignedWrap(BO) || Q.IIQ.hasNoUnsignedWrap(BO)) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002155 isKnownNonZero(X, Depth, Q) && isKnownNonZero(Y, Depth, Q))
Duncan Sands7cb61e52011-10-27 19:16:21 +00002156 return true;
2157 }
Duncan Sandsd3951082011-01-25 09:38:29 +00002158 // (C ? X : Y) != 0 if X != 0 and Y != 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00002159 else if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002160 if (isKnownNonZero(SI->getTrueValue(), Depth, Q) &&
2161 isKnownNonZero(SI->getFalseValue(), Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00002162 return true;
2163 }
James Molloy897048b2015-09-29 14:08:45 +00002164 // PHI
Pete Cooper35b00d52016-08-13 01:05:32 +00002165 else if (const PHINode *PN = dyn_cast<PHINode>(V)) {
James Molloy897048b2015-09-29 14:08:45 +00002166 // Try and detect a recurrence that monotonically increases from a
2167 // starting value, as these are common as induction variables.
2168 if (PN->getNumIncomingValues() == 2) {
2169 Value *Start = PN->getIncomingValue(0);
2170 Value *Induction = PN->getIncomingValue(1);
2171 if (isa<ConstantInt>(Induction) && !isa<ConstantInt>(Start))
2172 std::swap(Start, Induction);
2173 if (ConstantInt *C = dyn_cast<ConstantInt>(Start)) {
2174 if (!C->isZero() && !C->isNegative()) {
2175 ConstantInt *X;
Florian Hahn19f9e322018-08-17 14:39:04 +00002176 if (Q.IIQ.UseInstrInfo &&
2177 (match(Induction, m_NSWAdd(m_Specific(PN), m_ConstantInt(X))) ||
James Molloy897048b2015-09-29 14:08:45 +00002178 match(Induction, m_NUWAdd(m_Specific(PN), m_ConstantInt(X)))) &&
2179 !X->isNegative())
2180 return true;
2181 }
2182 }
2183 }
Jun Bum Limca832662016-02-01 17:03:07 +00002184 // Check if all incoming values are non-zero constant.
Eugene Zelenko75075ef2017-09-01 21:37:29 +00002185 bool AllNonZeroConstants = llvm::all_of(PN->operands(), [](Value *V) {
Craig Topper79ab6432017-07-06 18:39:47 +00002186 return isa<ConstantInt>(V) && !cast<ConstantInt>(V)->isZero();
Jun Bum Limca832662016-02-01 17:03:07 +00002187 });
2188 if (AllNonZeroConstants)
2189 return true;
James Molloy897048b2015-09-29 14:08:45 +00002190 }
Duncan Sandsd3951082011-01-25 09:38:29 +00002191
Craig Topperb45eabc2017-04-26 16:39:58 +00002192 KnownBits Known(BitWidth);
2193 computeKnownBits(V, Known, Depth, Q);
2194 return Known.One != 0;
Duncan Sandsd3951082011-01-25 09:38:29 +00002195}
2196
James Molloy1d88d6f2015-10-22 13:18:42 +00002197/// Return true if V2 == V1 + X, where X is known non-zero.
Pete Cooper35b00d52016-08-13 01:05:32 +00002198static bool isAddOfNonZero(const Value *V1, const Value *V2, const Query &Q) {
2199 const BinaryOperator *BO = dyn_cast<BinaryOperator>(V1);
James Molloy1d88d6f2015-10-22 13:18:42 +00002200 if (!BO || BO->getOpcode() != Instruction::Add)
2201 return false;
2202 Value *Op = nullptr;
2203 if (V2 == BO->getOperand(0))
2204 Op = BO->getOperand(1);
2205 else if (V2 == BO->getOperand(1))
2206 Op = BO->getOperand(0);
2207 else
2208 return false;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002209 return isKnownNonZero(Op, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002210}
2211
2212/// Return true if it is known that V1 != V2.
Pete Cooper35b00d52016-08-13 01:05:32 +00002213static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q) {
Craig Topper3002d5b2017-06-06 07:13:15 +00002214 if (V1 == V2)
James Molloy1d88d6f2015-10-22 13:18:42 +00002215 return false;
2216 if (V1->getType() != V2->getType())
2217 // We can't look through casts yet.
2218 return false;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002219 if (isAddOfNonZero(V1, V2, Q) || isAddOfNonZero(V2, V1, Q))
James Molloy1d88d6f2015-10-22 13:18:42 +00002220 return true;
2221
Craig Topper3002d5b2017-06-06 07:13:15 +00002222 if (V1->getType()->isIntOrIntVectorTy()) {
James Molloy1d88d6f2015-10-22 13:18:42 +00002223 // Are any known bits in V1 contradictory to known bits in V2? If V1
2224 // has a known zero where V2 has a known one, they must not be equal.
Craig Topper8e662f72017-06-06 07:13:11 +00002225 KnownBits Known1 = computeKnownBits(V1, 0, Q);
2226 KnownBits Known2 = computeKnownBits(V2, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002227
Craig Topper8365df82017-06-06 07:13:09 +00002228 if (Known1.Zero.intersects(Known2.One) ||
2229 Known2.Zero.intersects(Known1.One))
James Molloy1d88d6f2015-10-22 13:18:42 +00002230 return true;
2231 }
2232 return false;
2233}
2234
Sanjay Patelaee84212014-11-04 16:27:42 +00002235/// Return true if 'V & Mask' is known to be zero. We use this predicate to
2236/// simplify operations downstream. Mask is known to be zero for bits that V
2237/// cannot have.
Chris Lattner4bc28252009-09-08 00:06:16 +00002238///
2239/// This function is defined on values with integer type, values with pointer
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002240/// type, and vectors of integers. In the case
Chris Lattner4bc28252009-09-08 00:06:16 +00002241/// where V is a vector, the mask, known zero, and known one values are the
2242/// same width as the vector element, and the bit is set only if it is true
2243/// for all of the elements in the vector.
Pete Cooper35b00d52016-08-13 01:05:32 +00002244bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002245 const Query &Q) {
Craig Topperb45eabc2017-04-26 16:39:58 +00002246 KnownBits Known(Mask.getBitWidth());
2247 computeKnownBits(V, Known, Depth, Q);
2248 return Mask.isSubsetOf(Known.Zero);
Chris Lattner965c7692008-06-02 01:18:21 +00002249}
2250
Craig Topperbec15b62018-08-22 23:27:50 +00002251// Match a signed min+max clamp pattern like smax(smin(In, CHigh), CLow).
2252// Returns the input and lower/upper bounds.
2253static bool isSignedMinMaxClamp(const Value *Select, const Value *&In,
2254 const APInt *&CLow, const APInt *&CHigh) {
Craig Topper15f86922018-08-23 17:15:02 +00002255 assert(isa<Operator>(Select) &&
2256 cast<Operator>(Select)->getOpcode() == Instruction::Select &&
Craig Topperdfa176e2018-08-23 17:45:53 +00002257 "Input should be a Select!");
Craig Topperbec15b62018-08-22 23:27:50 +00002258
2259 const Value *LHS, *RHS, *LHS2, *RHS2;
2260 SelectPatternFlavor SPF = matchSelectPattern(Select, LHS, RHS).Flavor;
2261 if (SPF != SPF_SMAX && SPF != SPF_SMIN)
2262 return false;
2263
2264 if (!match(RHS, m_APInt(CLow)))
2265 return false;
2266
2267 SelectPatternFlavor SPF2 = matchSelectPattern(LHS, LHS2, RHS2).Flavor;
2268 if (getInverseMinMaxFlavor(SPF) != SPF2)
2269 return false;
2270
2271 if (!match(RHS2, m_APInt(CHigh)))
2272 return false;
2273
2274 if (SPF == SPF_SMIN)
2275 std::swap(CLow, CHigh);
2276
2277 In = LHS2;
2278 return CLow->sle(*CHigh);
2279}
2280
Sanjay Patela06d9892016-06-22 19:20:59 +00002281/// For vector constants, loop over the elements and find the constant with the
2282/// minimum number of sign bits. Return 0 if the value is not a vector constant
2283/// or if any element was not analyzed; otherwise, return the count for the
2284/// element with the minimum number of sign bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00002285static unsigned computeNumSignBitsVectorConstant(const Value *V,
2286 unsigned TyBits) {
2287 const auto *CV = dyn_cast<Constant>(V);
Sanjay Patela06d9892016-06-22 19:20:59 +00002288 if (!CV || !CV->getType()->isVectorTy())
2289 return 0;
Chris Lattner965c7692008-06-02 01:18:21 +00002290
Sanjay Patela06d9892016-06-22 19:20:59 +00002291 unsigned MinSignBits = TyBits;
2292 unsigned NumElts = CV->getType()->getVectorNumElements();
2293 for (unsigned i = 0; i != NumElts; ++i) {
2294 // If we find a non-ConstantInt, bail out.
2295 auto *Elt = dyn_cast_or_null<ConstantInt>(CV->getAggregateElement(i));
2296 if (!Elt)
2297 return 0;
2298
Craig Topper8e8b6ef2017-10-21 16:35:41 +00002299 MinSignBits = std::min(MinSignBits, Elt->getValue().getNumSignBits());
Sanjay Patela06d9892016-06-22 19:20:59 +00002300 }
2301
2302 return MinSignBits;
2303}
Chris Lattner965c7692008-06-02 01:18:21 +00002304
Sanjoy Das39a684d2017-02-25 20:30:45 +00002305static unsigned ComputeNumSignBitsImpl(const Value *V, unsigned Depth,
2306 const Query &Q);
2307
2308static unsigned ComputeNumSignBits(const Value *V, unsigned Depth,
2309 const Query &Q) {
2310 unsigned Result = ComputeNumSignBitsImpl(V, Depth, Q);
2311 assert(Result > 0 && "At least one sign bit needs to be present!");
2312 return Result;
2313}
2314
Sanjay Patelaee84212014-11-04 16:27:42 +00002315/// Return the number of times the sign bit of the register is replicated into
2316/// the other bits. We know that at least 1 bit is always equal to the sign bit
2317/// (itself), but other cases can give us information. For example, immediately
2318/// after an "ashr X, 2", we know that the top 3 bits are all equal to each
Sanjay Patela06d9892016-06-22 19:20:59 +00002319/// other, so we return 3. For vectors, return the number of sign bits for the
Vedant Kumard3196742018-02-28 19:08:52 +00002320/// vector element with the minimum number of known sign bits.
Sanjoy Das39a684d2017-02-25 20:30:45 +00002321static unsigned ComputeNumSignBitsImpl(const Value *V, unsigned Depth,
2322 const Query &Q) {
Craig Topper7227eba2017-08-21 22:56:12 +00002323 assert(Depth <= MaxDepth && "Limit Search Depth");
Sanjoy Das39a684d2017-02-25 20:30:45 +00002324
2325 // We return the minimum number of sign bits that are guaranteed to be present
2326 // in V, so for undef we have to conservatively return 1. We don't have the
2327 // same behavior for poison though -- that's a FIXME today.
2328
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00002329 Type *ScalarTy = V->getType()->getScalarType();
2330 unsigned TyBits = ScalarTy->isPointerTy() ?
2331 Q.DL.getIndexTypeSizeInBits(ScalarTy) :
2332 Q.DL.getTypeSizeInBits(ScalarTy);
2333
Chris Lattner965c7692008-06-02 01:18:21 +00002334 unsigned Tmp, Tmp2;
2335 unsigned FirstAnswer = 1;
2336
Jay Foada0653a32014-05-14 21:14:37 +00002337 // Note that ConstantInt is handled by the general computeKnownBits case
Chris Lattner2e01a692008-06-02 18:39:07 +00002338 // below.
2339
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002340 if (Depth == MaxDepth)
Chris Lattner965c7692008-06-02 01:18:21 +00002341 return 1; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00002342
Pete Cooper35b00d52016-08-13 01:05:32 +00002343 const Operator *U = dyn_cast<Operator>(V);
Dan Gohman80ca01c2009-07-17 20:47:02 +00002344 switch (Operator::getOpcode(V)) {
Chris Lattner965c7692008-06-02 01:18:21 +00002345 default: break;
2346 case Instruction::SExt:
Mon P Wangbb3eac92009-12-02 04:59:58 +00002347 Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002348 return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q) + Tmp;
Craig Topper1bef2c82012-12-22 19:15:35 +00002349
Nadav Rotemc99a3872015-03-06 00:23:58 +00002350 case Instruction::SDiv: {
Nadav Rotem029c5c72015-03-03 21:39:02 +00002351 const APInt *Denominator;
2352 // sdiv X, C -> adds log(C) sign bits.
2353 if (match(U->getOperand(1), m_APInt(Denominator))) {
2354
2355 // Ignore non-positive denominator.
2356 if (!Denominator->isStrictlyPositive())
2357 break;
2358
2359 // Calculate the incoming numerator bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002360 unsigned NumBits = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Nadav Rotem029c5c72015-03-03 21:39:02 +00002361
2362 // Add floor(log(C)) bits to the numerator bits.
2363 return std::min(TyBits, NumBits + Denominator->logBase2());
2364 }
2365 break;
Nadav Rotemc99a3872015-03-06 00:23:58 +00002366 }
2367
2368 case Instruction::SRem: {
2369 const APInt *Denominator;
Sanjoy Dase561fee2015-03-25 22:33:53 +00002370 // srem X, C -> we know that the result is within [-C+1,C) when C is a
2371 // positive constant. This let us put a lower bound on the number of sign
2372 // bits.
Nadav Rotemc99a3872015-03-06 00:23:58 +00002373 if (match(U->getOperand(1), m_APInt(Denominator))) {
2374
2375 // Ignore non-positive denominator.
2376 if (!Denominator->isStrictlyPositive())
2377 break;
2378
2379 // Calculate the incoming numerator bits. SRem by a positive constant
2380 // can't lower the number of sign bits.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002381 unsigned NumrBits =
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002382 ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Nadav Rotemc99a3872015-03-06 00:23:58 +00002383
2384 // Calculate the leading sign bit constraints by examining the
Sanjoy Dase561fee2015-03-25 22:33:53 +00002385 // denominator. Given that the denominator is positive, there are two
2386 // cases:
2387 //
2388 // 1. the numerator is positive. The result range is [0,C) and [0,C) u<
2389 // (1 << ceilLogBase2(C)).
2390 //
2391 // 2. the numerator is negative. Then the result range is (-C,0] and
2392 // integers in (-C,0] are either 0 or >u (-1 << ceilLogBase2(C)).
2393 //
2394 // Thus a lower bound on the number of sign bits is `TyBits -
2395 // ceilLogBase2(C)`.
Nadav Rotemc99a3872015-03-06 00:23:58 +00002396
Sanjoy Dase561fee2015-03-25 22:33:53 +00002397 unsigned ResBits = TyBits - Denominator->ceilLogBase2();
Nadav Rotemc99a3872015-03-06 00:23:58 +00002398 return std::max(NumrBits, ResBits);
2399 }
2400 break;
2401 }
Nadav Rotem029c5c72015-03-03 21:39:02 +00002402
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002403 case Instruction::AShr: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002404 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002405 // ashr X, C -> adds C sign bits. Vectors too.
2406 const APInt *ShAmt;
2407 if (match(U->getOperand(1), m_APInt(ShAmt))) {
Simon Pilgrim67207262018-01-01 22:44:59 +00002408 if (ShAmt->uge(TyBits))
Sanjoy Das39a684d2017-02-25 20:30:45 +00002409 break; // Bad shift.
Simon Pilgrim67207262018-01-01 22:44:59 +00002410 unsigned ShAmtLimited = ShAmt->getZExtValue();
Sanjoy Das39a684d2017-02-25 20:30:45 +00002411 Tmp += ShAmtLimited;
Chris Lattner965c7692008-06-02 01:18:21 +00002412 if (Tmp > TyBits) Tmp = TyBits;
2413 }
2414 return Tmp;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002415 }
2416 case Instruction::Shl: {
2417 const APInt *ShAmt;
2418 if (match(U->getOperand(1), m_APInt(ShAmt))) {
Chris Lattner965c7692008-06-02 01:18:21 +00002419 // shl destroys sign bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002420 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Simon Pilgrim67207262018-01-01 22:44:59 +00002421 if (ShAmt->uge(TyBits) || // Bad shift.
2422 ShAmt->uge(Tmp)) break; // Shifted all sign bits out.
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002423 Tmp2 = ShAmt->getZExtValue();
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002424 return Tmp - Tmp2;
Chris Lattner965c7692008-06-02 01:18:21 +00002425 }
2426 break;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002427 }
Chris Lattner965c7692008-06-02 01:18:21 +00002428 case Instruction::And:
2429 case Instruction::Or:
2430 case Instruction::Xor: // NOT is handled here.
2431 // Logical binary ops preserve the number of sign bits at the worst.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002432 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002433 if (Tmp != 1) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002434 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002435 FirstAnswer = std::min(Tmp, Tmp2);
2436 // We computed what we know about the sign bits as our first
2437 // answer. Now proceed to the generic code that uses
Jay Foada0653a32014-05-14 21:14:37 +00002438 // computeKnownBits, and pick whichever answer is better.
Chris Lattner965c7692008-06-02 01:18:21 +00002439 }
2440 break;
2441
Craig Topperbec15b62018-08-22 23:27:50 +00002442 case Instruction::Select: {
2443 // If we have a clamp pattern, we know that the number of sign bits will be
2444 // the minimum of the clamp min/max range.
2445 const Value *X;
2446 const APInt *CLow, *CHigh;
2447 if (isSignedMinMaxClamp(U, X, CLow, CHigh))
2448 return std::min(CLow->getNumSignBits(), CHigh->getNumSignBits());
2449
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002450 Tmp = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002451 if (Tmp == 1) break;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002452 Tmp2 = ComputeNumSignBits(U->getOperand(2), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002453 return std::min(Tmp, Tmp2);
Craig Topperbec15b62018-08-22 23:27:50 +00002454 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002455
Chris Lattner965c7692008-06-02 01:18:21 +00002456 case Instruction::Add:
2457 // Add can have at most one carry bit. Thus we know that the output
2458 // is, at worst, one more bit than the inputs.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002459 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002460 if (Tmp == 1) break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002461
Chris Lattner965c7692008-06-02 01:18:21 +00002462 // Special case decrementing a value (ADD X, -1):
David Majnemera55027f2014-12-26 09:20:17 +00002463 if (const auto *CRHS = dyn_cast<Constant>(U->getOperand(1)))
Chris Lattner965c7692008-06-02 01:18:21 +00002464 if (CRHS->isAllOnesValue()) {
Craig Topperb45eabc2017-04-26 16:39:58 +00002465 KnownBits Known(TyBits);
2466 computeKnownBits(U->getOperand(0), Known, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00002467
Chris Lattner965c7692008-06-02 01:18:21 +00002468 // If the input is known to be 0 or 1, the output is 0/-1, which is all
2469 // sign bits set.
Craig Topperb45eabc2017-04-26 16:39:58 +00002470 if ((Known.Zero | 1).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00002471 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00002472
Chris Lattner965c7692008-06-02 01:18:21 +00002473 // If we are subtracting one from a positive number, there is no carry
2474 // out of the result.
Craig Topperca48af32017-04-29 16:43:11 +00002475 if (Known.isNonNegative())
Chris Lattner965c7692008-06-02 01:18:21 +00002476 return Tmp;
2477 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002478
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002479 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002480 if (Tmp2 == 1) break;
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002481 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002482
Chris Lattner965c7692008-06-02 01:18:21 +00002483 case Instruction::Sub:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002484 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002485 if (Tmp2 == 1) break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002486
Chris Lattner965c7692008-06-02 01:18:21 +00002487 // Handle NEG.
David Majnemera55027f2014-12-26 09:20:17 +00002488 if (const auto *CLHS = dyn_cast<Constant>(U->getOperand(0)))
Chris Lattner965c7692008-06-02 01:18:21 +00002489 if (CLHS->isNullValue()) {
Craig Topperb45eabc2017-04-26 16:39:58 +00002490 KnownBits Known(TyBits);
2491 computeKnownBits(U->getOperand(1), Known, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002492 // If the input is known to be 0 or 1, the output is 0/-1, which is all
2493 // sign bits set.
Craig Topperb45eabc2017-04-26 16:39:58 +00002494 if ((Known.Zero | 1).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00002495 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00002496
Chris Lattner965c7692008-06-02 01:18:21 +00002497 // If the input is known to be positive (the sign bit is known clear),
2498 // the output of the NEG has the same number of sign bits as the input.
Craig Topperca48af32017-04-29 16:43:11 +00002499 if (Known.isNonNegative())
Chris Lattner965c7692008-06-02 01:18:21 +00002500 return Tmp2;
Craig Topper1bef2c82012-12-22 19:15:35 +00002501
Chris Lattner965c7692008-06-02 01:18:21 +00002502 // Otherwise, we treat this like a SUB.
2503 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002504
Chris Lattner965c7692008-06-02 01:18:21 +00002505 // Sub can have at most one carry bit. Thus we know that the output
2506 // is, at worst, one more bit than the inputs.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002507 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002508 if (Tmp == 1) break;
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002509 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002510
Amjad Aboud88ffa3a2017-08-18 22:56:55 +00002511 case Instruction::Mul: {
2512 // The output of the Mul can be at most twice the valid bits in the inputs.
2513 unsigned SignBitsOp0 = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002514 if (SignBitsOp0 == 1) break;
Amjad Aboud88ffa3a2017-08-18 22:56:55 +00002515 unsigned SignBitsOp1 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Stanislav Mekhanoshinb8269a92018-07-25 16:39:24 +00002516 if (SignBitsOp1 == 1) break;
Amjad Aboud88ffa3a2017-08-18 22:56:55 +00002517 unsigned OutValidBits =
2518 (TyBits - SignBitsOp0 + 1) + (TyBits - SignBitsOp1 + 1);
2519 return OutValidBits > TyBits ? 1 : TyBits - OutValidBits + 1;
2520 }
2521
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002522 case Instruction::PHI: {
Pete Cooper35b00d52016-08-13 01:05:32 +00002523 const PHINode *PN = cast<PHINode>(U);
David Majnemer6ee8d172015-01-04 07:06:53 +00002524 unsigned NumIncomingValues = PN->getNumIncomingValues();
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002525 // Don't analyze large in-degree PHIs.
David Majnemer6ee8d172015-01-04 07:06:53 +00002526 if (NumIncomingValues > 4) break;
2527 // Unreachable blocks may have zero-operand PHI nodes.
2528 if (NumIncomingValues == 0) break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002529
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002530 // Take the minimum of all incoming values. This can't infinitely loop
2531 // because of our depth threshold.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002532 Tmp = ComputeNumSignBits(PN->getIncomingValue(0), Depth + 1, Q);
David Majnemer6ee8d172015-01-04 07:06:53 +00002533 for (unsigned i = 1, e = NumIncomingValues; i != e; ++i) {
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002534 if (Tmp == 1) return Tmp;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002535 Tmp = std::min(
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002536 Tmp, ComputeNumSignBits(PN->getIncomingValue(i), Depth + 1, Q));
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002537 }
2538 return Tmp;
2539 }
2540
Chris Lattner965c7692008-06-02 01:18:21 +00002541 case Instruction::Trunc:
2542 // FIXME: it's tricky to do anything useful for this, but it is an important
2543 // case for targets like X86.
2544 break;
Bjorn Pettersson39616032016-10-06 09:56:21 +00002545
2546 case Instruction::ExtractElement:
2547 // Look through extract element. At the moment we keep this simple and skip
2548 // tracking the specific element. But at least we might find information
2549 // valid for all elements of the vector (for example if vector is sign
2550 // extended, shifted, etc).
2551 return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Sanjay Patelcc9e4012018-10-26 21:05:14 +00002552
Sanjay Patela68096c2018-11-02 15:51:47 +00002553 case Instruction::ShuffleVector: {
Sanjay Patelcac28b42018-11-03 13:18:55 +00002554 // TODO: This is copied almost directly from the SelectionDAG version of
2555 // ComputeNumSignBits. It would be better if we could share common
2556 // code. If not, make sure that changes are translated to the DAG.
2557
2558 // Collect the minimum number of sign bits that are shared by every vector
2559 // element referenced by the shuffle.
2560 auto *Shuf = cast<ShuffleVectorInst>(U);
2561 int NumElts = Shuf->getOperand(0)->getType()->getVectorNumElements();
2562 int NumMaskElts = Shuf->getMask()->getType()->getVectorNumElements();
2563 APInt DemandedLHS(NumElts, 0), DemandedRHS(NumElts, 0);
2564 for (int i = 0; i != NumMaskElts; ++i) {
2565 int M = Shuf->getMaskValue(i);
2566 assert(M < NumElts * 2 && "Invalid shuffle mask constant");
2567 // For undef elements, we don't know anything about the common state of
2568 // the shuffle result.
2569 if (M == -1)
2570 return 1;
2571 if (M < NumElts)
2572 DemandedLHS.setBit(M % NumElts);
2573 else
2574 DemandedRHS.setBit(M % NumElts);
2575 }
2576 Tmp = std::numeric_limits<unsigned>::max();
2577 if (!!DemandedLHS)
2578 Tmp = ComputeNumSignBits(Shuf->getOperand(0), Depth + 1, Q);
2579 if (!!DemandedRHS) {
2580 Tmp2 = ComputeNumSignBits(Shuf->getOperand(1), Depth + 1, Q);
2581 Tmp = std::min(Tmp, Tmp2);
2582 }
2583 // If we don't know anything, early out and try computeKnownBits fall-back.
2584 if (Tmp == 1)
Sanjay Patelcc9e4012018-10-26 21:05:14 +00002585 break;
Sanjay Patelcac28b42018-11-03 13:18:55 +00002586 assert(Tmp <= V->getType()->getScalarSizeInBits() &&
2587 "Failed to determine minimum sign bits");
2588 return Tmp;
Chris Lattner965c7692008-06-02 01:18:21 +00002589 }
Sanjay Patela68096c2018-11-02 15:51:47 +00002590 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002591
Chris Lattner965c7692008-06-02 01:18:21 +00002592 // Finally, if we can prove that the top bits of the result are 0's or 1's,
2593 // use this information.
Sanjay Patela06d9892016-06-22 19:20:59 +00002594
2595 // If we can examine all elements of a vector constant successfully, we're
2596 // done (we can't do any better than that). If not, keep trying.
2597 if (unsigned VecSignBits = computeNumSignBitsVectorConstant(V, TyBits))
2598 return VecSignBits;
2599
Craig Topperb45eabc2017-04-26 16:39:58 +00002600 KnownBits Known(TyBits);
2601 computeKnownBits(V, Known, Depth, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00002602
Sanjay Patele0536212016-06-23 17:41:59 +00002603 // If we know that the sign bit is either zero or one, determine the number of
2604 // identical bits in the top of the input value.
Craig Topper8df66c62017-05-12 17:20:30 +00002605 return std::max(FirstAnswer, Known.countMinSignBits());
Chris Lattner965c7692008-06-02 01:18:21 +00002606}
Chris Lattnera12a6de2008-06-02 01:29:46 +00002607
Sanjay Patelaee84212014-11-04 16:27:42 +00002608/// This function computes the integer multiple of Base that equals V.
2609/// If successful, it returns true and returns the multiple in
2610/// Multiple. If unsuccessful, it returns false. It looks
Victor Hernandez47444882009-11-10 08:28:35 +00002611/// through SExt instructions only if LookThroughSExt is true.
2612bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
Dan Gohman6a976bb2009-11-18 00:58:27 +00002613 bool LookThroughSExt, unsigned Depth) {
Victor Hernandez47444882009-11-10 08:28:35 +00002614 const unsigned MaxDepth = 6;
2615
Dan Gohman6a976bb2009-11-18 00:58:27 +00002616 assert(V && "No Value?");
Victor Hernandez47444882009-11-10 08:28:35 +00002617 assert(Depth <= MaxDepth && "Limit Search Depth");
Duncan Sands9dff9be2010-02-15 16:12:20 +00002618 assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
Victor Hernandez47444882009-11-10 08:28:35 +00002619
Chris Lattner229907c2011-07-18 04:54:35 +00002620 Type *T = V->getType();
Victor Hernandez47444882009-11-10 08:28:35 +00002621
Dan Gohman6a976bb2009-11-18 00:58:27 +00002622 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Victor Hernandez47444882009-11-10 08:28:35 +00002623
2624 if (Base == 0)
2625 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00002626
Victor Hernandez47444882009-11-10 08:28:35 +00002627 if (Base == 1) {
2628 Multiple = V;
2629 return true;
2630 }
2631
2632 ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
2633 Constant *BaseVal = ConstantInt::get(T, Base);
2634 if (CO && CO == BaseVal) {
2635 // Multiple is 1.
2636 Multiple = ConstantInt::get(T, 1);
2637 return true;
2638 }
2639
2640 if (CI && CI->getZExtValue() % Base == 0) {
2641 Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
Craig Topper1bef2c82012-12-22 19:15:35 +00002642 return true;
Victor Hernandez47444882009-11-10 08:28:35 +00002643 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002644
Victor Hernandez47444882009-11-10 08:28:35 +00002645 if (Depth == MaxDepth) return false; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00002646
Victor Hernandez47444882009-11-10 08:28:35 +00002647 Operator *I = dyn_cast<Operator>(V);
2648 if (!I) return false;
2649
2650 switch (I->getOpcode()) {
2651 default: break;
Chris Lattner4f0b47d2009-11-26 01:50:12 +00002652 case Instruction::SExt:
Victor Hernandez47444882009-11-10 08:28:35 +00002653 if (!LookThroughSExt) return false;
2654 // otherwise fall through to ZExt
Galina Kistanova244621f2017-05-31 22:16:24 +00002655 LLVM_FALLTHROUGH;
Chris Lattner4f0b47d2009-11-26 01:50:12 +00002656 case Instruction::ZExt:
Dan Gohman6a976bb2009-11-18 00:58:27 +00002657 return ComputeMultiple(I->getOperand(0), Base, Multiple,
2658 LookThroughSExt, Depth+1);
Victor Hernandez47444882009-11-10 08:28:35 +00002659 case Instruction::Shl:
2660 case Instruction::Mul: {
2661 Value *Op0 = I->getOperand(0);
2662 Value *Op1 = I->getOperand(1);
2663
2664 if (I->getOpcode() == Instruction::Shl) {
2665 ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
2666 if (!Op1CI) return false;
2667 // Turn Op0 << Op1 into Op0 * 2^Op1
2668 APInt Op1Int = Op1CI->getValue();
2669 uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
Jay Foad15084f02010-11-30 09:02:01 +00002670 APInt API(Op1Int.getBitWidth(), 0);
Jay Foad25a5e4c2010-12-01 08:53:58 +00002671 API.setBit(BitToSet);
Jay Foad15084f02010-11-30 09:02:01 +00002672 Op1 = ConstantInt::get(V->getContext(), API);
Victor Hernandez47444882009-11-10 08:28:35 +00002673 }
2674
Craig Topper9f008862014-04-15 04:59:12 +00002675 Value *Mul0 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00002676 if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
2677 if (Constant *Op1C = dyn_cast<Constant>(Op1))
2678 if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00002679 if (Op1C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00002680 MulC->getType()->getPrimitiveSizeInBits())
2681 Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002682 if (Op1C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00002683 MulC->getType()->getPrimitiveSizeInBits())
2684 MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002685
Chris Lattner72d283c2010-09-05 17:20:46 +00002686 // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
2687 Multiple = ConstantExpr::getMul(MulC, Op1C);
2688 return true;
2689 }
Victor Hernandez47444882009-11-10 08:28:35 +00002690
2691 if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
2692 if (Mul0CI->getValue() == 1) {
2693 // V == Base * Op1, so return Op1
2694 Multiple = Op1;
2695 return true;
2696 }
2697 }
2698
Craig Topper9f008862014-04-15 04:59:12 +00002699 Value *Mul1 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00002700 if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
2701 if (Constant *Op0C = dyn_cast<Constant>(Op0))
2702 if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00002703 if (Op0C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00002704 MulC->getType()->getPrimitiveSizeInBits())
2705 Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002706 if (Op0C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00002707 MulC->getType()->getPrimitiveSizeInBits())
2708 MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002709
Chris Lattner72d283c2010-09-05 17:20:46 +00002710 // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
2711 Multiple = ConstantExpr::getMul(MulC, Op0C);
2712 return true;
2713 }
Victor Hernandez47444882009-11-10 08:28:35 +00002714
2715 if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
2716 if (Mul1CI->getValue() == 1) {
2717 // V == Base * Op0, so return Op0
2718 Multiple = Op0;
2719 return true;
2720 }
2721 }
Victor Hernandez47444882009-11-10 08:28:35 +00002722 }
2723 }
2724
2725 // We could not determine if V is a multiple of Base.
2726 return false;
2727}
2728
David Majnemerb4b27232016-04-19 19:10:21 +00002729Intrinsic::ID llvm::getIntrinsicForCallSite(ImmutableCallSite ICS,
2730 const TargetLibraryInfo *TLI) {
2731 const Function *F = ICS.getCalledFunction();
2732 if (!F)
2733 return Intrinsic::not_intrinsic;
2734
2735 if (F->isIntrinsic())
2736 return F->getIntrinsicID();
2737
2738 if (!TLI)
2739 return Intrinsic::not_intrinsic;
2740
David L. Jonesd21529f2017-01-23 23:16:46 +00002741 LibFunc Func;
David Majnemerb4b27232016-04-19 19:10:21 +00002742 // We're going to make assumptions on the semantics of the functions, check
2743 // that the target knows that it's available in this environment and it does
2744 // not have local linkage.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002745 if (!F || F->hasLocalLinkage() || !TLI->getLibFunc(*F, Func))
2746 return Intrinsic::not_intrinsic;
2747
2748 if (!ICS.onlyReadsMemory())
David Majnemerb4b27232016-04-19 19:10:21 +00002749 return Intrinsic::not_intrinsic;
2750
2751 // Otherwise check if we have a call to a function that can be turned into a
2752 // vector intrinsic.
2753 switch (Func) {
2754 default:
2755 break;
David L. Jonesd21529f2017-01-23 23:16:46 +00002756 case LibFunc_sin:
2757 case LibFunc_sinf:
2758 case LibFunc_sinl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002759 return Intrinsic::sin;
David L. Jonesd21529f2017-01-23 23:16:46 +00002760 case LibFunc_cos:
2761 case LibFunc_cosf:
2762 case LibFunc_cosl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002763 return Intrinsic::cos;
David L. Jonesd21529f2017-01-23 23:16:46 +00002764 case LibFunc_exp:
2765 case LibFunc_expf:
2766 case LibFunc_expl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002767 return Intrinsic::exp;
David L. Jonesd21529f2017-01-23 23:16:46 +00002768 case LibFunc_exp2:
2769 case LibFunc_exp2f:
2770 case LibFunc_exp2l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002771 return Intrinsic::exp2;
David L. Jonesd21529f2017-01-23 23:16:46 +00002772 case LibFunc_log:
2773 case LibFunc_logf:
2774 case LibFunc_logl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002775 return Intrinsic::log;
David L. Jonesd21529f2017-01-23 23:16:46 +00002776 case LibFunc_log10:
2777 case LibFunc_log10f:
2778 case LibFunc_log10l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002779 return Intrinsic::log10;
David L. Jonesd21529f2017-01-23 23:16:46 +00002780 case LibFunc_log2:
2781 case LibFunc_log2f:
2782 case LibFunc_log2l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002783 return Intrinsic::log2;
David L. Jonesd21529f2017-01-23 23:16:46 +00002784 case LibFunc_fabs:
2785 case LibFunc_fabsf:
2786 case LibFunc_fabsl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002787 return Intrinsic::fabs;
David L. Jonesd21529f2017-01-23 23:16:46 +00002788 case LibFunc_fmin:
2789 case LibFunc_fminf:
2790 case LibFunc_fminl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002791 return Intrinsic::minnum;
David L. Jonesd21529f2017-01-23 23:16:46 +00002792 case LibFunc_fmax:
2793 case LibFunc_fmaxf:
2794 case LibFunc_fmaxl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002795 return Intrinsic::maxnum;
David L. Jonesd21529f2017-01-23 23:16:46 +00002796 case LibFunc_copysign:
2797 case LibFunc_copysignf:
2798 case LibFunc_copysignl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002799 return Intrinsic::copysign;
David L. Jonesd21529f2017-01-23 23:16:46 +00002800 case LibFunc_floor:
2801 case LibFunc_floorf:
2802 case LibFunc_floorl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002803 return Intrinsic::floor;
David L. Jonesd21529f2017-01-23 23:16:46 +00002804 case LibFunc_ceil:
2805 case LibFunc_ceilf:
2806 case LibFunc_ceill:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002807 return Intrinsic::ceil;
David L. Jonesd21529f2017-01-23 23:16:46 +00002808 case LibFunc_trunc:
2809 case LibFunc_truncf:
2810 case LibFunc_truncl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002811 return Intrinsic::trunc;
David L. Jonesd21529f2017-01-23 23:16:46 +00002812 case LibFunc_rint:
2813 case LibFunc_rintf:
2814 case LibFunc_rintl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002815 return Intrinsic::rint;
David L. Jonesd21529f2017-01-23 23:16:46 +00002816 case LibFunc_nearbyint:
2817 case LibFunc_nearbyintf:
2818 case LibFunc_nearbyintl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002819 return Intrinsic::nearbyint;
David L. Jonesd21529f2017-01-23 23:16:46 +00002820 case LibFunc_round:
2821 case LibFunc_roundf:
2822 case LibFunc_roundl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002823 return Intrinsic::round;
David L. Jonesd21529f2017-01-23 23:16:46 +00002824 case LibFunc_pow:
2825 case LibFunc_powf:
2826 case LibFunc_powl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002827 return Intrinsic::pow;
David L. Jonesd21529f2017-01-23 23:16:46 +00002828 case LibFunc_sqrt:
2829 case LibFunc_sqrtf:
2830 case LibFunc_sqrtl:
Sanjay Patel86d24f12017-11-06 22:40:09 +00002831 return Intrinsic::sqrt;
David Majnemerb4b27232016-04-19 19:10:21 +00002832 }
2833
2834 return Intrinsic::not_intrinsic;
2835}
2836
Sanjay Patelaee84212014-11-04 16:27:42 +00002837/// Return true if we can prove that the specified FP value is never equal to
2838/// -0.0.
Chris Lattnera12a6de2008-06-02 01:29:46 +00002839///
2840/// NOTE: this function will need to be revisited when we support non-default
2841/// rounding modes!
David Majnemer3ee5f342016-04-13 06:55:52 +00002842bool llvm::CannotBeNegativeZero(const Value *V, const TargetLibraryInfo *TLI,
2843 unsigned Depth) {
Sanjay Patel20df88a2017-11-13 17:56:23 +00002844 if (auto *CFP = dyn_cast<ConstantFP>(V))
Chris Lattnera12a6de2008-06-02 01:29:46 +00002845 return !CFP->getValueAPF().isNegZero();
Craig Topper1bef2c82012-12-22 19:15:35 +00002846
Sanjay Patel20df88a2017-11-13 17:56:23 +00002847 // Limit search depth.
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002848 if (Depth == MaxDepth)
Sanjay Patel20df88a2017-11-13 17:56:23 +00002849 return false;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002850
Sanjay Patel20df88a2017-11-13 17:56:23 +00002851 auto *Op = dyn_cast<Operator>(V);
2852 if (!Op)
2853 return false;
Michael Ilseman0f128372012-12-06 00:07:09 +00002854
Sanjay Patel20df88a2017-11-13 17:56:23 +00002855 // Check if the nsz fast-math flag is set.
2856 if (auto *FPO = dyn_cast<FPMathOperator>(Op))
Michael Ilseman0f128372012-12-06 00:07:09 +00002857 if (FPO->hasNoSignedZeros())
2858 return true;
2859
Sanjay Patel9e3d8f42017-11-13 17:40:47 +00002860 // (fadd x, 0.0) is guaranteed to return +0.0, not -0.0.
Sanjay Patel93e64dd2018-03-25 21:16:33 +00002861 if (match(Op, m_FAdd(m_Value(), m_PosZeroFP())))
Sanjay Patel9e3d8f42017-11-13 17:40:47 +00002862 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00002863
Chris Lattnera12a6de2008-06-02 01:29:46 +00002864 // sitofp and uitofp turn into +0.0 for zero.
Sanjay Patel20df88a2017-11-13 17:56:23 +00002865 if (isa<SIToFPInst>(Op) || isa<UIToFPInst>(Op))
Chris Lattnera12a6de2008-06-02 01:29:46 +00002866 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00002867
Sanjay Patel20df88a2017-11-13 17:56:23 +00002868 if (auto *Call = dyn_cast<CallInst>(Op)) {
2869 Intrinsic::ID IID = getIntrinsicForCallSite(Call, TLI);
David Majnemer3ee5f342016-04-13 06:55:52 +00002870 switch (IID) {
2871 default:
2872 break;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002873 // sqrt(-0.0) = -0.0, no other negative results are possible.
David Majnemer3ee5f342016-04-13 06:55:52 +00002874 case Intrinsic::sqrt:
Matt Arsenault56b31d82018-08-06 15:16:26 +00002875 case Intrinsic::canonicalize:
Sanjay Patel20df88a2017-11-13 17:56:23 +00002876 return CannotBeNegativeZero(Call->getArgOperand(0), TLI, Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002877 // fabs(x) != -0.0
2878 case Intrinsic::fabs:
2879 return true;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002880 }
David Majnemer3ee5f342016-04-13 06:55:52 +00002881 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002882
Chris Lattnera12a6de2008-06-02 01:29:46 +00002883 return false;
2884}
2885
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002886/// If \p SignBitOnly is true, test for a known 0 sign bit rather than a
2887/// standard ordered compare. e.g. make -0.0 olt 0.0 be true because of the sign
2888/// bit despite comparing equal.
2889static bool cannotBeOrderedLessThanZeroImpl(const Value *V,
2890 const TargetLibraryInfo *TLI,
2891 bool SignBitOnly,
2892 unsigned Depth) {
Justin Lebar322c1272017-01-27 00:58:34 +00002893 // TODO: This function does not do the right thing when SignBitOnly is true
2894 // and we're lowering to a hypothetical IEEE 754-compliant-but-evil platform
2895 // which flips the sign bits of NaNs. See
2896 // https://llvm.org/bugs/show_bug.cgi?id=31702.
2897
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002898 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2899 return !CFP->getValueAPF().isNegative() ||
2900 (!SignBitOnly && CFP->getValueAPF().isZero());
2901 }
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002902
Craig Topper69c89722018-02-26 22:33:17 +00002903 // Handle vector of constants.
2904 if (auto *CV = dyn_cast<Constant>(V)) {
2905 if (CV->getType()->isVectorTy()) {
2906 unsigned NumElts = CV->getType()->getVectorNumElements();
2907 for (unsigned i = 0; i != NumElts; ++i) {
2908 auto *CFP = dyn_cast_or_null<ConstantFP>(CV->getAggregateElement(i));
2909 if (!CFP)
2910 return false;
2911 if (CFP->getValueAPF().isNegative() &&
2912 (SignBitOnly || !CFP->getValueAPF().isZero()))
2913 return false;
2914 }
2915
2916 // All non-negative ConstantFPs.
2917 return true;
2918 }
2919 }
2920
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002921 if (Depth == MaxDepth)
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002922 return false; // Limit search depth.
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002923
2924 const Operator *I = dyn_cast<Operator>(V);
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002925 if (!I)
2926 return false;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002927
2928 switch (I->getOpcode()) {
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002929 default:
2930 break;
Fiona Glaserdb7824f2016-01-12 23:37:30 +00002931 // Unsigned integers are always nonnegative.
2932 case Instruction::UIToFP:
2933 return true;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002934 case Instruction::FMul:
2935 // x*x is always non-negative or a NaN.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002936 if (I->getOperand(0) == I->getOperand(1) &&
2937 (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()))
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002938 return true;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002939
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002940 LLVM_FALLTHROUGH;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002941 case Instruction::FAdd:
2942 case Instruction::FDiv:
2943 case Instruction::FRem:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002944 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2945 Depth + 1) &&
2946 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2947 Depth + 1);
Fiona Glaserdb7824f2016-01-12 23:37:30 +00002948 case Instruction::Select:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002949 return cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2950 Depth + 1) &&
2951 cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
2952 Depth + 1);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002953 case Instruction::FPExt:
2954 case Instruction::FPTrunc:
2955 // Widening/narrowing never change sign.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002956 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2957 Depth + 1);
Craig Topper30199102018-02-27 19:53:45 +00002958 case Instruction::ExtractElement:
2959 // Look through extract element. At the moment we keep this simple and skip
2960 // tracking the specific element. But at least we might find information
2961 // valid for all elements of the vector.
2962 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2963 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002964 case Instruction::Call:
Justin Lebar7e3184c2017-01-26 00:10:26 +00002965 const auto *CI = cast<CallInst>(I);
2966 Intrinsic::ID IID = getIntrinsicForCallSite(CI, TLI);
David Majnemer3ee5f342016-04-13 06:55:52 +00002967 switch (IID) {
2968 default:
2969 break;
2970 case Intrinsic::maxnum:
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00002971 return (isKnownNeverNaN(I->getOperand(0), TLI) &&
Sanjay Patelf9a0d592018-08-02 13:46:20 +00002972 cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI,
2973 SignBitOnly, Depth + 1)) ||
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00002974 (isKnownNeverNaN(I->getOperand(1), TLI) &&
Sanjay Patelf9a0d592018-08-02 13:46:20 +00002975 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI,
2976 SignBitOnly, Depth + 1));
2977
Thomas Livelyc3392502018-10-19 19:01:26 +00002978 case Intrinsic::maximum:
2979 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2980 Depth + 1) ||
2981 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2982 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002983 case Intrinsic::minnum:
Thomas Livelyc3392502018-10-19 19:01:26 +00002984 case Intrinsic::minimum:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002985 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2986 Depth + 1) &&
2987 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2988 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002989 case Intrinsic::exp:
2990 case Intrinsic::exp2:
2991 case Intrinsic::fabs:
David Majnemer3ee5f342016-04-13 06:55:52 +00002992 return true;
Justin Lebar7e3184c2017-01-26 00:10:26 +00002993
2994 case Intrinsic::sqrt:
2995 // sqrt(x) is always >= -0 or NaN. Moreover, sqrt(x) == -0 iff x == -0.
2996 if (!SignBitOnly)
2997 return true;
2998 return CI->hasNoNaNs() && (CI->hasNoSignedZeros() ||
2999 CannotBeNegativeZero(CI->getOperand(0), TLI));
3000
David Majnemer3ee5f342016-04-13 06:55:52 +00003001 case Intrinsic::powi:
Justin Lebar7e3184c2017-01-26 00:10:26 +00003002 if (ConstantInt *Exponent = dyn_cast<ConstantInt>(I->getOperand(1))) {
David Majnemer3ee5f342016-04-13 06:55:52 +00003003 // powi(x,n) is non-negative if n is even.
Justin Lebar7e3184c2017-01-26 00:10:26 +00003004 if (Exponent->getBitWidth() <= 64 && Exponent->getSExtValue() % 2u == 0)
David Majnemer3ee5f342016-04-13 06:55:52 +00003005 return true;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003006 }
Justin Lebar322c1272017-01-27 00:58:34 +00003007 // TODO: This is not correct. Given that exp is an integer, here are the
3008 // ways that pow can return a negative value:
3009 //
3010 // pow(x, exp) --> negative if exp is odd and x is negative.
3011 // pow(-0, exp) --> -inf if exp is negative odd.
3012 // pow(-0, exp) --> -0 if exp is positive odd.
3013 // pow(-inf, exp) --> -0 if exp is negative odd.
3014 // pow(-inf, exp) --> -inf if exp is positive odd.
3015 //
3016 // Therefore, if !SignBitOnly, we can return true if x >= +0 or x is NaN,
3017 // but we must return false if x == -0. Unfortunately we do not currently
3018 // have a way of expressing this constraint. See details in
3019 // https://llvm.org/bugs/show_bug.cgi?id=31702.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00003020 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3021 Depth + 1);
Justin Lebar322c1272017-01-27 00:58:34 +00003022
David Majnemer3ee5f342016-04-13 06:55:52 +00003023 case Intrinsic::fma:
3024 case Intrinsic::fmuladd:
3025 // x*x+y is non-negative if y is non-negative.
3026 return I->getOperand(0) == I->getOperand(1) &&
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00003027 (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()) &&
3028 cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
3029 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00003030 }
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003031 break;
3032 }
Sanjoy Das6082c1a2016-05-07 02:08:15 +00003033 return false;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00003034}
3035
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00003036bool llvm::CannotBeOrderedLessThanZero(const Value *V,
3037 const TargetLibraryInfo *TLI) {
3038 return cannotBeOrderedLessThanZeroImpl(V, TLI, false, 0);
3039}
3040
3041bool llvm::SignBitMustBeZero(const Value *V, const TargetLibraryInfo *TLI) {
3042 return cannotBeOrderedLessThanZeroImpl(V, TLI, true, 0);
3043}
3044
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00003045bool llvm::isKnownNeverNaN(const Value *V, const TargetLibraryInfo *TLI,
3046 unsigned Depth) {
Sanjay Patel6840c5f2017-09-05 23:13:13 +00003047 assert(V->getType()->isFPOrFPVectorTy() && "Querying for NaN on non-FP type");
3048
3049 // If we're told that NaNs won't happen, assume they won't.
3050 if (auto *FPMathOp = dyn_cast<FPMathOperator>(V))
3051 if (FPMathOp->hasNoNaNs())
3052 return true;
3053
Sanjay Patel6840c5f2017-09-05 23:13:13 +00003054 // Handle scalar constants.
3055 if (auto *CFP = dyn_cast<ConstantFP>(V))
3056 return !CFP->isNaN();
3057
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00003058 if (Depth == MaxDepth)
3059 return false;
3060
Matt Arsenault450fcc72018-08-20 16:51:00 +00003061 if (auto *Inst = dyn_cast<Instruction>(V)) {
3062 switch (Inst->getOpcode()) {
3063 case Instruction::FAdd:
3064 case Instruction::FMul:
3065 case Instruction::FSub:
3066 case Instruction::FDiv:
3067 case Instruction::FRem: {
3068 // TODO: Need isKnownNeverInfinity
3069 return false;
3070 }
3071 case Instruction::Select: {
3072 return isKnownNeverNaN(Inst->getOperand(1), TLI, Depth + 1) &&
3073 isKnownNeverNaN(Inst->getOperand(2), TLI, Depth + 1);
3074 }
3075 case Instruction::SIToFP:
3076 case Instruction::UIToFP:
3077 return true;
3078 case Instruction::FPTrunc:
3079 case Instruction::FPExt:
3080 return isKnownNeverNaN(Inst->getOperand(0), TLI, Depth + 1);
3081 default:
3082 break;
3083 }
3084 }
3085
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00003086 if (const auto *II = dyn_cast<IntrinsicInst>(V)) {
3087 switch (II->getIntrinsicID()) {
3088 case Intrinsic::canonicalize:
3089 case Intrinsic::fabs:
3090 case Intrinsic::copysign:
Matt Arsenault450fcc72018-08-20 16:51:00 +00003091 case Intrinsic::exp:
3092 case Intrinsic::exp2:
3093 case Intrinsic::floor:
3094 case Intrinsic::ceil:
3095 case Intrinsic::trunc:
3096 case Intrinsic::rint:
3097 case Intrinsic::nearbyint:
3098 case Intrinsic::round:
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00003099 return isKnownNeverNaN(II->getArgOperand(0), TLI, Depth + 1);
3100 case Intrinsic::sqrt:
3101 return isKnownNeverNaN(II->getArgOperand(0), TLI, Depth + 1) &&
3102 CannotBeOrderedLessThanZero(II->getArgOperand(0), TLI);
3103 default:
3104 return false;
3105 }
3106 }
3107
Sanjay Patel6840c5f2017-09-05 23:13:13 +00003108 // Bail out for constant expressions, but try to handle vector constants.
3109 if (!V->getType()->isVectorTy() || !isa<Constant>(V))
3110 return false;
3111
3112 // For vectors, verify that each element is not NaN.
3113 unsigned NumElts = V->getType()->getVectorNumElements();
3114 for (unsigned i = 0; i != NumElts; ++i) {
3115 Constant *Elt = cast<Constant>(V)->getAggregateElement(i);
3116 if (!Elt)
3117 return false;
3118 if (isa<UndefValue>(Elt))
3119 continue;
3120 auto *CElt = dyn_cast<ConstantFP>(Elt);
3121 if (!CElt || CElt->isNaN())
3122 return false;
3123 }
3124 // All elements were confirmed not-NaN or undefined.
3125 return true;
3126}
3127
Chris Lattner9cb10352010-12-26 20:15:01 +00003128Value *llvm::isBytewiseValue(Value *V) {
JF Bastien73d8e4e2018-09-21 05:17:42 +00003129
Chris Lattner9cb10352010-12-26 20:15:01 +00003130 // All byte-wide stores are splatable, even of arbitrary variables.
JF Bastien73d8e4e2018-09-21 05:17:42 +00003131 if (V->getType()->isIntegerTy(8))
3132 return V;
3133
3134 LLVMContext &Ctx = V->getContext();
3135
3136 // Undef don't care.
3137 auto *UndefInt8 = UndefValue::get(Type::getInt8Ty(Ctx));
3138 if (isa<UndefValue>(V))
3139 return UndefInt8;
3140
3141 Constant *C = dyn_cast<Constant>(V);
3142 if (!C) {
3143 // Conceptually, we could handle things like:
3144 // %a = zext i8 %X to i16
3145 // %b = shl i16 %a, 8
3146 // %c = or i16 %a, %b
3147 // but until there is an example that actually needs this, it doesn't seem
3148 // worth worrying about.
3149 return nullptr;
3150 }
Chris Lattneracf6b072011-02-19 19:35:49 +00003151
3152 // Handle 'null' ConstantArrayZero etc.
JF Bastien73d8e4e2018-09-21 05:17:42 +00003153 if (C->isNullValue())
3154 return Constant::getNullValue(Type::getInt8Ty(Ctx));
Craig Topper1bef2c82012-12-22 19:15:35 +00003155
JF Bastien73d8e4e2018-09-21 05:17:42 +00003156 // Constant floating-point values can be handled as integer values if the
Craig Topper1bef2c82012-12-22 19:15:35 +00003157 // corresponding integer value is "byteable". An important case is 0.0.
JF Bastien73d8e4e2018-09-21 05:17:42 +00003158 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
3159 Type *Ty = nullptr;
3160 if (CFP->getType()->isHalfTy())
3161 Ty = Type::getInt16Ty(Ctx);
3162 else if (CFP->getType()->isFloatTy())
3163 Ty = Type::getInt32Ty(Ctx);
3164 else if (CFP->getType()->isDoubleTy())
3165 Ty = Type::getInt64Ty(Ctx);
Chris Lattner9cb10352010-12-26 20:15:01 +00003166 // Don't handle long double formats, which have strange constraints.
JF Bastien73d8e4e2018-09-21 05:17:42 +00003167 return Ty ? isBytewiseValue(ConstantExpr::getBitCast(CFP, Ty)) : nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00003168 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003169
Benjamin Kramer17d90152015-02-07 19:29:02 +00003170 // We can handle constant integers that are multiple of 8 bits.
JF Bastien73d8e4e2018-09-21 05:17:42 +00003171 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
Benjamin Kramer17d90152015-02-07 19:29:02 +00003172 if (CI->getBitWidth() % 8 == 0) {
3173 assert(CI->getBitWidth() > 8 && "8 bits should be handled above!");
Benjamin Kramerb4b51502015-03-25 16:49:59 +00003174 if (!CI->getValue().isSplat(8))
Benjamin Kramer17d90152015-02-07 19:29:02 +00003175 return nullptr;
JF Bastien73d8e4e2018-09-21 05:17:42 +00003176 return ConstantInt::get(Ctx, CI->getValue().trunc(8));
Chris Lattner9cb10352010-12-26 20:15:01 +00003177 }
3178 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003179
JF Bastien73d8e4e2018-09-21 05:17:42 +00003180 auto Merge = [&](Value *LHS, Value *RHS) -> Value * {
3181 if (LHS == RHS)
3182 return LHS;
3183 if (!LHS || !RHS)
Craig Topper9f008862014-04-15 04:59:12 +00003184 return nullptr;
JF Bastien73d8e4e2018-09-21 05:17:42 +00003185 if (LHS == UndefInt8)
3186 return RHS;
3187 if (RHS == UndefInt8)
3188 return LHS;
3189 return nullptr;
3190 };
Craig Topper1bef2c82012-12-22 19:15:35 +00003191
JF Bastien73d8e4e2018-09-21 05:17:42 +00003192 if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(C)) {
3193 Value *Val = UndefInt8;
3194 for (unsigned I = 0, E = CA->getNumElements(); I != E; ++I)
3195 if (!(Val = Merge(Val, isBytewiseValue(CA->getElementAsConstant(I)))))
Craig Topper9f008862014-04-15 04:59:12 +00003196 return nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00003197 return Val;
3198 }
Chad Rosier8abf65a2011-12-06 00:19:08 +00003199
JF Bastien73d8e4e2018-09-21 05:17:42 +00003200 if (isa<ConstantVector>(C)) {
3201 Constant *Splat = cast<ConstantVector>(C)->getSplatValue();
3202 return Splat ? isBytewiseValue(Splat) : nullptr;
3203 }
3204
3205 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C)) {
3206 Value *Val = UndefInt8;
3207 for (unsigned I = 0, E = C->getNumOperands(); I != E; ++I)
3208 if (!(Val = Merge(Val, isBytewiseValue(C->getOperand(I)))))
3209 return nullptr;
3210 return Val;
3211 }
3212
3213 // Don't try to handle the handful of other constants.
Craig Topper9f008862014-04-15 04:59:12 +00003214 return nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00003215}
3216
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003217// This is the recursive version of BuildSubAggregate. It takes a few different
3218// arguments. Idxs is the index within the nested struct From that we are
3219// looking at now (which is of type IndexedType). IdxSkip is the number of
3220// indices from Idxs that should be left out when inserting into the resulting
3221// struct. To is the result struct built so far, new insertvalue instructions
3222// build on that.
Chris Lattner229907c2011-07-18 04:54:35 +00003223static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
Craig Topper2cd5ff82013-07-11 16:22:38 +00003224 SmallVectorImpl<unsigned> &Idxs,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00003225 unsigned IdxSkip,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00003226 Instruction *InsertBefore) {
Eugene Zelenko75075ef2017-09-01 21:37:29 +00003227 StructType *STy = dyn_cast<StructType>(IndexedType);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003228 if (STy) {
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003229 // Save the original To argument so we can modify it
3230 Value *OrigTo = To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003231 // General case, the type indexed by Idxs is a struct
3232 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
3233 // Process each struct element recursively
3234 Idxs.push_back(i);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003235 Value *PrevTo = To;
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00003236 To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00003237 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003238 Idxs.pop_back();
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003239 if (!To) {
3240 // Couldn't find any inserted value for this index? Cleanup
3241 while (PrevTo != OrigTo) {
3242 InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
3243 PrevTo = Del->getAggregateOperand();
3244 Del->eraseFromParent();
3245 }
3246 // Stop processing elements
3247 break;
3248 }
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003249 }
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00003250 // If we successfully found a value for each of our subaggregates
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003251 if (To)
3252 return To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003253 }
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003254 // Base case, the type indexed by SourceIdxs is not a struct, or not all of
3255 // the struct's elements had a value that was inserted directly. In the latter
3256 // case, perhaps we can't determine each of the subelements individually, but
3257 // we might be able to find the complete struct somewhere.
Craig Topper1bef2c82012-12-22 19:15:35 +00003258
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003259 // Find the value that is at that particular spot
Jay Foad57aa6362011-07-13 10:26:04 +00003260 Value *V = FindInsertedValue(From, Idxs);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003261
3262 if (!V)
Craig Topper9f008862014-04-15 04:59:12 +00003263 return nullptr;
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003264
Vedant Kumard3196742018-02-28 19:08:52 +00003265 // Insert the value in the new (sub) aggregate
Eugene Zelenko75075ef2017-09-01 21:37:29 +00003266 return InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
3267 "tmp", InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003268}
3269
3270// This helper takes a nested struct and extracts a part of it (which is again a
3271// struct) into a new value. For example, given the struct:
3272// { a, { b, { c, d }, e } }
3273// and the indices "1, 1" this returns
3274// { c, d }.
3275//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003276// It does this by inserting an insertvalue for each element in the resulting
3277// struct, as opposed to just inserting a single struct. This will only work if
3278// each of the elements of the substruct are known (ie, inserted into From by an
3279// insertvalue instruction somewhere).
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003280//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003281// All inserted insertvalue instructions are inserted before InsertBefore
Jay Foad57aa6362011-07-13 10:26:04 +00003282static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00003283 Instruction *InsertBefore) {
Matthijs Kooijman69801d42008-06-16 13:28:31 +00003284 assert(InsertBefore && "Must have someplace to insert!");
Chris Lattner229907c2011-07-18 04:54:35 +00003285 Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
Jay Foad57aa6362011-07-13 10:26:04 +00003286 idx_range);
Owen Andersonb292b8c2009-07-30 23:03:37 +00003287 Value *To = UndefValue::get(IndexedType);
Jay Foad57aa6362011-07-13 10:26:04 +00003288 SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003289 unsigned IdxSkip = Idxs.size();
3290
Nick Lewycky39dbfd32009-11-23 03:29:18 +00003291 return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003292}
3293
Vedant Kumard3196742018-02-28 19:08:52 +00003294/// Given an aggregate and a sequence of indices, see if the scalar value
3295/// indexed is already around as a register, for example if it was inserted
3296/// directly into the aggregate.
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00003297///
3298/// If InsertBefore is not null, this function will duplicate (modified)
3299/// insertvalues when a part of a nested struct is extracted.
Jay Foad57aa6362011-07-13 10:26:04 +00003300Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
3301 Instruction *InsertBefore) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003302 // Nothing to index? Just return V then (this is useful at the end of our
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003303 // recursion).
Jay Foad57aa6362011-07-13 10:26:04 +00003304 if (idx_range.empty())
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003305 return V;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003306 // We have indices, so V should have an indexable type.
3307 assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
3308 "Not looking at a struct or array?");
3309 assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
3310 "Invalid indices for type?");
Owen Andersonf1f17432009-07-06 22:37:39 +00003311
Chris Lattner67058832012-01-25 06:48:06 +00003312 if (Constant *C = dyn_cast<Constant>(V)) {
3313 C = C->getAggregateElement(idx_range[0]);
Craig Topper9f008862014-04-15 04:59:12 +00003314 if (!C) return nullptr;
Chris Lattner67058832012-01-25 06:48:06 +00003315 return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
3316 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003317
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003318 if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003319 // Loop the indices for the insertvalue instruction in parallel with the
3320 // requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00003321 const unsigned *req_idx = idx_range.begin();
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00003322 for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
3323 i != e; ++i, ++req_idx) {
Jay Foad57aa6362011-07-13 10:26:04 +00003324 if (req_idx == idx_range.end()) {
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003325 // We can't handle this without inserting insertvalues
3326 if (!InsertBefore)
Craig Topper9f008862014-04-15 04:59:12 +00003327 return nullptr;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003328
3329 // The requested index identifies a part of a nested aggregate. Handle
3330 // this specially. For example,
3331 // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
3332 // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
3333 // %C = extractvalue {i32, { i32, i32 } } %B, 1
3334 // This can be changed into
3335 // %A = insertvalue {i32, i32 } undef, i32 10, 0
3336 // %C = insertvalue {i32, i32 } %A, i32 11, 1
3337 // which allows the unused 0,0 element from the nested struct to be
3338 // removed.
3339 return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
3340 InsertBefore);
Duncan Sandsdb356ee2008-06-19 08:47:31 +00003341 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003342
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003343 // This insert value inserts something else than what we are looking for.
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00003344 // See if the (aggregate) value inserted into has the value we are
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003345 // looking for, then.
3346 if (*req_idx != *i)
Jay Foad57aa6362011-07-13 10:26:04 +00003347 return FindInsertedValue(I->getAggregateOperand(), idx_range,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00003348 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003349 }
3350 // If we end up here, the indices of the insertvalue match with those
3351 // requested (though possibly only partially). Now we recursively look at
3352 // the inserted value, passing any remaining indices.
Jay Foad57aa6362011-07-13 10:26:04 +00003353 return FindInsertedValue(I->getInsertedValueOperand(),
Frits van Bommel717d7ed2011-07-18 12:00:32 +00003354 makeArrayRef(req_idx, idx_range.end()),
Nick Lewycky39dbfd32009-11-23 03:29:18 +00003355 InsertBefore);
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003356 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003357
Chris Lattnerf7eb5432012-01-24 07:54:10 +00003358 if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00003359 // If we're extracting a value from an aggregate that was extracted from
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003360 // something else, we can extract from that something else directly instead.
3361 // However, we will need to chain I's indices with the requested indices.
Craig Topper1bef2c82012-12-22 19:15:35 +00003362
3363 // Calculate the number of indices required
Jay Foad57aa6362011-07-13 10:26:04 +00003364 unsigned size = I->getNumIndices() + idx_range.size();
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003365 // Allocate some space to put the new indices in
Matthijs Kooijman8369c672008-06-17 08:24:37 +00003366 SmallVector<unsigned, 5> Idxs;
3367 Idxs.reserve(size);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003368 // Add indices from the extract value instruction
Jay Foad57aa6362011-07-13 10:26:04 +00003369 Idxs.append(I->idx_begin(), I->idx_end());
Craig Topper1bef2c82012-12-22 19:15:35 +00003370
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003371 // Add requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00003372 Idxs.append(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003373
Craig Topper1bef2c82012-12-22 19:15:35 +00003374 assert(Idxs.size() == size
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00003375 && "Number of indices added not correct?");
Craig Topper1bef2c82012-12-22 19:15:35 +00003376
Jay Foad57aa6362011-07-13 10:26:04 +00003377 return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003378 }
3379 // Otherwise, we don't know (such as, extracting from a function return value
3380 // or load instruction)
Craig Topper9f008862014-04-15 04:59:12 +00003381 return nullptr;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00003382}
Evan Chengda3db112008-06-30 07:31:25 +00003383
Sanjay Patelaee84212014-11-04 16:27:42 +00003384/// Analyze the specified pointer to see if it can be expressed as a base
3385/// pointer plus a constant offset. Return the base and offset to the caller.
Chris Lattnere28618d2010-11-30 22:25:26 +00003386Value *llvm::GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003387 const DataLayout &DL) {
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003388 unsigned BitWidth = DL.getIndexTypeSizeInBits(Ptr->getType());
Nuno Lopes368c4d02012-12-31 20:48:35 +00003389 APInt ByteOffset(BitWidth, 0);
Chandler Carruth76641272016-01-04 07:23:12 +00003390
3391 // We walk up the defs but use a visited set to handle unreachable code. In
3392 // that case, we stop after accumulating the cycle once (not that it
3393 // matters).
3394 SmallPtrSet<Value *, 16> Visited;
3395 while (Visited.insert(Ptr).second) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00003396 if (Ptr->getType()->isVectorTy())
3397 break;
Craig Topper1bef2c82012-12-22 19:15:35 +00003398
Nuno Lopes368c4d02012-12-31 20:48:35 +00003399 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
Tom Stellard17eb3412016-10-07 14:23:29 +00003400 // If one of the values we have visited is an addrspacecast, then
3401 // the pointer type of this GEP may be different from the type
3402 // of the Ptr parameter which was passed to this function. This
3403 // means when we construct GEPOffset, we need to use the size
3404 // of GEP's pointer type rather than the size of the original
3405 // pointer type.
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00003406 APInt GEPOffset(DL.getIndexTypeSizeInBits(Ptr->getType()), 0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003407 if (!GEP->accumulateConstantOffset(DL, GEPOffset))
3408 break;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00003409
Florian Hahn79024052019-01-04 14:53:22 +00003410 APInt OrigByteOffset(ByteOffset);
3411 ByteOffset += GEPOffset.sextOrTrunc(ByteOffset.getBitWidth());
3412 if (ByteOffset.getMinSignedBits() > 64) {
3413 // Stop traversal if the pointer offset wouldn't fit into int64_t
3414 // (this should be removed if Offset is updated to an APInt)
3415 ByteOffset = OrigByteOffset;
3416 break;
3417 }
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00003418
Nuno Lopes368c4d02012-12-31 20:48:35 +00003419 Ptr = GEP->getPointerOperand();
Tom Stellard17eb3412016-10-07 14:23:29 +00003420 } else if (Operator::getOpcode(Ptr) == Instruction::BitCast ||
3421 Operator::getOpcode(Ptr) == Instruction::AddrSpaceCast) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00003422 Ptr = cast<Operator>(Ptr)->getOperand(0);
3423 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00003424 if (GA->isInterposable())
Nuno Lopes368c4d02012-12-31 20:48:35 +00003425 break;
3426 Ptr = GA->getAliasee();
Chris Lattnere28618d2010-11-30 22:25:26 +00003427 } else {
Nuno Lopes368c4d02012-12-31 20:48:35 +00003428 break;
Chris Lattnere28618d2010-11-30 22:25:26 +00003429 }
3430 }
Nuno Lopes368c4d02012-12-31 20:48:35 +00003431 Offset = ByteOffset.getSExtValue();
3432 return Ptr;
Chris Lattnere28618d2010-11-30 22:25:26 +00003433}
3434
Matthias Braun50ec0b52017-05-19 22:37:09 +00003435bool llvm::isGEPBasedOnPointerToString(const GEPOperator *GEP,
3436 unsigned CharSize) {
David L Kreitzer752c1442016-04-13 14:31:06 +00003437 // Make sure the GEP has exactly three arguments.
3438 if (GEP->getNumOperands() != 3)
3439 return false;
3440
Matthias Braun50ec0b52017-05-19 22:37:09 +00003441 // Make sure the index-ee is a pointer to array of \p CharSize integers.
3442 // CharSize.
David L Kreitzer752c1442016-04-13 14:31:06 +00003443 ArrayType *AT = dyn_cast<ArrayType>(GEP->getSourceElementType());
Matthias Braun50ec0b52017-05-19 22:37:09 +00003444 if (!AT || !AT->getElementType()->isIntegerTy(CharSize))
David L Kreitzer752c1442016-04-13 14:31:06 +00003445 return false;
3446
3447 // Check to make sure that the first operand of the GEP is an integer and
3448 // has value 0 so that we are sure we're indexing into the initializer.
3449 const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
3450 if (!FirstIdx || !FirstIdx->isZero())
3451 return false;
3452
3453 return true;
Sanjoy Das6082c1a2016-05-07 02:08:15 +00003454}
Chris Lattnere28618d2010-11-30 22:25:26 +00003455
Matthias Braun50ec0b52017-05-19 22:37:09 +00003456bool llvm::getConstantDataArrayInfo(const Value *V,
3457 ConstantDataArraySlice &Slice,
3458 unsigned ElementSize, uint64_t Offset) {
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003459 assert(V);
Evan Chengda3db112008-06-30 07:31:25 +00003460
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003461 // Look through bitcast instructions and geps.
3462 V = V->stripPointerCasts();
Craig Topper1bef2c82012-12-22 19:15:35 +00003463
Benjamin Kramer0248a3e2015-03-21 15:36:06 +00003464 // If the value is a GEP instruction or constant expression, treat it as an
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003465 // offset.
3466 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
David L Kreitzer752c1442016-04-13 14:31:06 +00003467 // The GEP operator should be based on a pointer to string constant, and is
3468 // indexing into the string constant.
Matthias Braun50ec0b52017-05-19 22:37:09 +00003469 if (!isGEPBasedOnPointerToString(GEP, ElementSize))
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003470 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003471
Evan Chengda3db112008-06-30 07:31:25 +00003472 // If the second index isn't a ConstantInt, then this is a variable index
3473 // into the array. If this occurs, we can't say anything meaningful about
3474 // the string.
3475 uint64_t StartIdx = 0;
Dan Gohman0b4df042010-04-14 22:20:45 +00003476 if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
Evan Chengda3db112008-06-30 07:31:25 +00003477 StartIdx = CI->getZExtValue();
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003478 else
3479 return false;
Matthias Braun50ec0b52017-05-19 22:37:09 +00003480 return getConstantDataArrayInfo(GEP->getOperand(0), Slice, ElementSize,
3481 StartIdx + Offset);
Evan Chengda3db112008-06-30 07:31:25 +00003482 }
Nick Lewycky46209882011-10-20 00:34:35 +00003483
Evan Chengda3db112008-06-30 07:31:25 +00003484 // The GEP instruction, constant or instruction, must reference a global
3485 // variable that is a constant and is initialized. The referenced constant
3486 // initializer is the array that we'll use for optimization.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003487 const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00003488 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003489 return false;
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003490
Matthias Braun50ec0b52017-05-19 22:37:09 +00003491 const ConstantDataArray *Array;
3492 ArrayType *ArrayTy;
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003493 if (GV->getInitializer()->isNullValue()) {
Matthias Braun50ec0b52017-05-19 22:37:09 +00003494 Type *GVTy = GV->getValueType();
3495 if ( (ArrayTy = dyn_cast<ArrayType>(GVTy)) ) {
Sanjay Patel2ad88f82017-06-12 22:34:37 +00003496 // A zeroinitializer for the array; there is no ConstantDataArray.
Matthias Braun50ec0b52017-05-19 22:37:09 +00003497 Array = nullptr;
3498 } else {
3499 const DataLayout &DL = GV->getParent()->getDataLayout();
3500 uint64_t SizeInBytes = DL.getTypeStoreSize(GVTy);
3501 uint64_t Length = SizeInBytes / (ElementSize / 8);
3502 if (Length <= Offset)
3503 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003504
Matthias Braun50ec0b52017-05-19 22:37:09 +00003505 Slice.Array = nullptr;
3506 Slice.Offset = 0;
3507 Slice.Length = Length - Offset;
3508 return true;
3509 }
3510 } else {
3511 // This must be a ConstantDataArray.
3512 Array = dyn_cast<ConstantDataArray>(GV->getInitializer());
3513 if (!Array)
3514 return false;
3515 ArrayTy = Array->getType();
3516 }
3517 if (!ArrayTy->getElementType()->isIntegerTy(ElementSize))
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003518 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003519
Matthias Braun50ec0b52017-05-19 22:37:09 +00003520 uint64_t NumElts = ArrayTy->getArrayNumElements();
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003521 if (Offset > NumElts)
3522 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003523
Matthias Braun50ec0b52017-05-19 22:37:09 +00003524 Slice.Array = Array;
3525 Slice.Offset = Offset;
3526 Slice.Length = NumElts - Offset;
3527 return true;
3528}
3529
3530/// This function computes the length of a null-terminated C string pointed to
3531/// by V. If successful, it returns true and returns the string in Str.
3532/// If unsuccessful, it returns false.
3533bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
3534 uint64_t Offset, bool TrimAtNul) {
3535 ConstantDataArraySlice Slice;
3536 if (!getConstantDataArrayInfo(V, Slice, 8, Offset))
3537 return false;
3538
3539 if (Slice.Array == nullptr) {
3540 if (TrimAtNul) {
3541 Str = StringRef();
3542 return true;
3543 }
3544 if (Slice.Length == 1) {
3545 Str = StringRef("", 1);
3546 return true;
3547 }
Sanjay Patelfef83e82017-06-09 14:21:18 +00003548 // We cannot instantiate a StringRef as we do not have an appropriate string
Matthias Braun50ec0b52017-05-19 22:37:09 +00003549 // of 0s at hand.
3550 return false;
3551 }
3552
3553 // Start out with the entire array in the StringRef.
3554 Str = Slice.Array->getAsString();
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003555 // Skip over 'offset' bytes.
Matthias Braun50ec0b52017-05-19 22:37:09 +00003556 Str = Str.substr(Slice.Offset);
Craig Topper1bef2c82012-12-22 19:15:35 +00003557
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003558 if (TrimAtNul) {
3559 // Trim off the \0 and anything after it. If the array is not nul
3560 // terminated, we just return the whole end of string. The client may know
3561 // some other way that the string is length-bound.
3562 Str = Str.substr(0, Str.find('\0'));
3563 }
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003564 return true;
Evan Chengda3db112008-06-30 07:31:25 +00003565}
Eric Christopher4899cbc2010-03-05 06:58:57 +00003566
3567// These next two are very similar to the above, but also look through PHI
3568// nodes.
3569// TODO: See if we can integrate these two together.
3570
Sanjay Patelaee84212014-11-04 16:27:42 +00003571/// If we can compute the length of the string pointed to by
Eric Christopher4899cbc2010-03-05 06:58:57 +00003572/// the specified pointer, return 'len+1'. If we can't, return 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00003573static uint64_t GetStringLengthH(const Value *V,
Matthias Braun50ec0b52017-05-19 22:37:09 +00003574 SmallPtrSetImpl<const PHINode*> &PHIs,
3575 unsigned CharSize) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003576 // Look through noop bitcast instructions.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003577 V = V->stripPointerCasts();
Eric Christopher4899cbc2010-03-05 06:58:57 +00003578
3579 // If this is a PHI node, there are two cases: either we have already seen it
3580 // or we haven't.
Pete Cooper35b00d52016-08-13 01:05:32 +00003581 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
David Blaikie70573dc2014-11-19 07:49:26 +00003582 if (!PHIs.insert(PN).second)
Eric Christopher4899cbc2010-03-05 06:58:57 +00003583 return ~0ULL; // already in the set.
3584
3585 // If it was new, see if all the input strings are the same length.
3586 uint64_t LenSoFar = ~0ULL;
Pete Cooper833f34d2015-05-12 20:05:31 +00003587 for (Value *IncValue : PN->incoming_values()) {
Matthias Braun50ec0b52017-05-19 22:37:09 +00003588 uint64_t Len = GetStringLengthH(IncValue, PHIs, CharSize);
Eric Christopher4899cbc2010-03-05 06:58:57 +00003589 if (Len == 0) return 0; // Unknown length -> unknown.
3590
3591 if (Len == ~0ULL) continue;
3592
3593 if (Len != LenSoFar && LenSoFar != ~0ULL)
3594 return 0; // Disagree -> unknown.
3595 LenSoFar = Len;
3596 }
3597
3598 // Success, all agree.
3599 return LenSoFar;
3600 }
3601
3602 // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
Pete Cooper35b00d52016-08-13 01:05:32 +00003603 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
Matthias Braun50ec0b52017-05-19 22:37:09 +00003604 uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs, CharSize);
Eric Christopher4899cbc2010-03-05 06:58:57 +00003605 if (Len1 == 0) return 0;
Matthias Braun50ec0b52017-05-19 22:37:09 +00003606 uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs, CharSize);
Eric Christopher4899cbc2010-03-05 06:58:57 +00003607 if (Len2 == 0) return 0;
3608 if (Len1 == ~0ULL) return Len2;
3609 if (Len2 == ~0ULL) return Len1;
3610 if (Len1 != Len2) return 0;
3611 return Len1;
3612 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003613
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003614 // Otherwise, see if we can read the string.
Matthias Braun50ec0b52017-05-19 22:37:09 +00003615 ConstantDataArraySlice Slice;
3616 if (!getConstantDataArrayInfo(V, Slice, CharSize))
Eric Christopher4899cbc2010-03-05 06:58:57 +00003617 return 0;
3618
Matthias Braun50ec0b52017-05-19 22:37:09 +00003619 if (Slice.Array == nullptr)
3620 return 1;
3621
3622 // Search for nul characters
3623 unsigned NullIndex = 0;
3624 for (unsigned E = Slice.Length; NullIndex < E; ++NullIndex) {
3625 if (Slice.Array->getElementAsInteger(Slice.Offset + NullIndex) == 0)
3626 break;
3627 }
3628
3629 return NullIndex + 1;
Eric Christopher4899cbc2010-03-05 06:58:57 +00003630}
3631
Sanjay Patelaee84212014-11-04 16:27:42 +00003632/// If we can compute the length of the string pointed to by
Eric Christopher4899cbc2010-03-05 06:58:57 +00003633/// the specified pointer, return 'len+1'. If we can't, return 0.
David Bolvansky1f343fa2018-05-22 20:27:36 +00003634uint64_t llvm::GetStringLength(const Value *V, unsigned CharSize) {
David Bolvansky41f4b642018-05-22 15:41:23 +00003635 if (!V->getType()->isPointerTy())
3636 return 0;
Eric Christopher4899cbc2010-03-05 06:58:57 +00003637
Pete Cooper35b00d52016-08-13 01:05:32 +00003638 SmallPtrSet<const PHINode*, 32> PHIs;
Matthias Braun50ec0b52017-05-19 22:37:09 +00003639 uint64_t Len = GetStringLengthH(V, PHIs, CharSize);
Eric Christopher4899cbc2010-03-05 06:58:57 +00003640 // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
3641 // an empty string as a length.
3642 return Len == ~0ULL ? 1 : Len;
3643}
Dan Gohmana4fcd242010-12-15 20:02:24 +00003644
Chandler Carruth363ac682019-01-07 05:42:51 +00003645const Value *llvm::getArgumentAliasingToReturnedPointer(const CallBase *Call) {
3646 assert(Call &&
3647 "getArgumentAliasingToReturnedPointer only works on nonnull calls");
3648 if (const Value *RV = Call->getReturnedArgOperand())
Piotr Padlewskid6f73462018-05-23 09:16:44 +00003649 return RV;
3650 // This can be used only as a aliasing property.
Chandler Carruth363ac682019-01-07 05:42:51 +00003651 if (isIntrinsicReturningPointerAliasingArgumentWithoutCapturing(Call))
3652 return Call->getArgOperand(0);
Piotr Padlewskid6f73462018-05-23 09:16:44 +00003653 return nullptr;
3654}
3655
3656bool llvm::isIntrinsicReturningPointerAliasingArgumentWithoutCapturing(
Chandler Carruth363ac682019-01-07 05:42:51 +00003657 const CallBase *Call) {
3658 return Call->getIntrinsicID() == Intrinsic::launder_invariant_group ||
3659 Call->getIntrinsicID() == Intrinsic::strip_invariant_group;
Piotr Padlewskid6f73462018-05-23 09:16:44 +00003660}
3661
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00003662/// \p PN defines a loop-variant pointer to an object. Check if the
Adam Nemete2b885c2015-04-23 20:09:20 +00003663/// previous iteration of the loop was referring to the same object as \p PN.
Pete Cooper35b00d52016-08-13 01:05:32 +00003664static bool isSameUnderlyingObjectInLoop(const PHINode *PN,
3665 const LoopInfo *LI) {
Adam Nemete2b885c2015-04-23 20:09:20 +00003666 // Find the loop-defined value.
3667 Loop *L = LI->getLoopFor(PN->getParent());
3668 if (PN->getNumIncomingValues() != 2)
3669 return true;
3670
3671 // Find the value from previous iteration.
3672 auto *PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(0));
3673 if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
3674 PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(1));
3675 if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
3676 return true;
3677
3678 // If a new pointer is loaded in the loop, the pointer references a different
3679 // object in every iteration. E.g.:
3680 // for (i)
3681 // int *p = a[i];
3682 // ...
3683 if (auto *Load = dyn_cast<LoadInst>(PrevValue))
3684 if (!L->isLoopInvariant(Load->getPointerOperand()))
3685 return false;
3686 return true;
3687}
3688
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003689Value *llvm::GetUnderlyingObject(Value *V, const DataLayout &DL,
3690 unsigned MaxLookup) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00003691 if (!V->getType()->isPointerTy())
3692 return V;
3693 for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
3694 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
3695 V = GEP->getPointerOperand();
Matt Arsenault70f4db882014-07-15 00:56:40 +00003696 } else if (Operator::getOpcode(V) == Instruction::BitCast ||
3697 Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00003698 V = cast<Operator>(V)->getOperand(0);
3699 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00003700 if (GA->isInterposable())
Dan Gohmana4fcd242010-12-15 20:02:24 +00003701 return V;
3702 V = GA->getAliasee();
Craig Topper85482412017-04-12 22:29:23 +00003703 } else if (isa<AllocaInst>(V)) {
3704 // An alloca can't be further simplified.
3705 return V;
Dan Gohmana4fcd242010-12-15 20:02:24 +00003706 } else {
Chandler Carruth363ac682019-01-07 05:42:51 +00003707 if (auto *Call = dyn_cast<CallBase>(V)) {
Piotr Padlewski5b3db452018-07-02 04:49:30 +00003708 // CaptureTracking can know about special capturing properties of some
3709 // intrinsics like launder.invariant.group, that can't be expressed with
3710 // the attributes, but have properties like returning aliasing pointer.
3711 // Because some analysis may assume that nocaptured pointer is not
3712 // returned from some special intrinsic (because function would have to
3713 // be marked with returns attribute), it is crucial to use this function
3714 // because it should be in sync with CaptureTracking. Not using it may
3715 // cause weird miscompilations where 2 aliasing pointers are assumed to
3716 // noalias.
Chandler Carruth363ac682019-01-07 05:42:51 +00003717 if (auto *RP = getArgumentAliasingToReturnedPointer(Call)) {
Piotr Padlewskid6f73462018-05-23 09:16:44 +00003718 V = RP;
Hal Finkel5c12d8f2016-07-11 01:32:20 +00003719 continue;
3720 }
Piotr Padlewskid6f73462018-05-23 09:16:44 +00003721 }
Hal Finkel5c12d8f2016-07-11 01:32:20 +00003722
Dan Gohman05b18f12010-12-15 20:49:55 +00003723 // See if InstructionSimplify knows any relevant tricks.
3724 if (Instruction *I = dyn_cast<Instruction>(V))
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003725 // TODO: Acquire a DominatorTree and AssumptionCache and use them.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00003726 if (Value *Simplified = SimplifyInstruction(I, {DL, I})) {
Dan Gohman05b18f12010-12-15 20:49:55 +00003727 V = Simplified;
3728 continue;
3729 }
3730
Dan Gohmana4fcd242010-12-15 20:02:24 +00003731 return V;
3732 }
3733 assert(V->getType()->isPointerTy() && "Unexpected operand type!");
3734 }
3735 return V;
3736}
Nick Lewycky3e334a42011-06-27 04:20:45 +00003737
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003738void llvm::GetUnderlyingObjects(Value *V, SmallVectorImpl<Value *> &Objects,
Adam Nemete2b885c2015-04-23 20:09:20 +00003739 const DataLayout &DL, LoopInfo *LI,
3740 unsigned MaxLookup) {
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003741 SmallPtrSet<Value *, 4> Visited;
3742 SmallVector<Value *, 4> Worklist;
3743 Worklist.push_back(V);
3744 do {
3745 Value *P = Worklist.pop_back_val();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003746 P = GetUnderlyingObject(P, DL, MaxLookup);
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003747
David Blaikie70573dc2014-11-19 07:49:26 +00003748 if (!Visited.insert(P).second)
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003749 continue;
3750
3751 if (SelectInst *SI = dyn_cast<SelectInst>(P)) {
3752 Worklist.push_back(SI->getTrueValue());
3753 Worklist.push_back(SI->getFalseValue());
3754 continue;
3755 }
3756
3757 if (PHINode *PN = dyn_cast<PHINode>(P)) {
Adam Nemete2b885c2015-04-23 20:09:20 +00003758 // If this PHI changes the underlying object in every iteration of the
3759 // loop, don't look through it. Consider:
3760 // int **A;
3761 // for (i) {
3762 // Prev = Curr; // Prev = PHI (Prev_0, Curr)
3763 // Curr = A[i];
3764 // *Prev, *Curr;
3765 //
3766 // Prev is tracking Curr one iteration behind so they refer to different
3767 // underlying objects.
3768 if (!LI || !LI->isLoopHeader(PN->getParent()) ||
3769 isSameUnderlyingObjectInLoop(PN, LI))
Pete Cooper833f34d2015-05-12 20:05:31 +00003770 for (Value *IncValue : PN->incoming_values())
3771 Worklist.push_back(IncValue);
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003772 continue;
3773 }
3774
3775 Objects.push_back(P);
3776 } while (!Worklist.empty());
3777}
3778
Hiroshi Inoueb9417db2017-08-01 03:32:15 +00003779/// This is the function that does the work of looking through basic
3780/// ptrtoint+arithmetic+inttoptr sequences.
3781static const Value *getUnderlyingObjectFromInt(const Value *V) {
3782 do {
3783 if (const Operator *U = dyn_cast<Operator>(V)) {
3784 // If we find a ptrtoint, we can transfer control back to the
3785 // regular getUnderlyingObjectFromInt.
3786 if (U->getOpcode() == Instruction::PtrToInt)
3787 return U->getOperand(0);
3788 // If we find an add of a constant, a multiplied value, or a phi, it's
3789 // likely that the other operand will lead us to the base
3790 // object. We don't have to worry about the case where the
3791 // object address is somehow being computed by the multiply,
3792 // because our callers only care when the result is an
3793 // identifiable object.
3794 if (U->getOpcode() != Instruction::Add ||
3795 (!isa<ConstantInt>(U->getOperand(1)) &&
3796 Operator::getOpcode(U->getOperand(1)) != Instruction::Mul &&
3797 !isa<PHINode>(U->getOperand(1))))
3798 return V;
3799 V = U->getOperand(0);
3800 } else {
3801 return V;
3802 }
3803 assert(V->getType()->isIntegerTy() && "Unexpected operand type!");
3804 } while (true);
3805}
3806
3807/// This is a wrapper around GetUnderlyingObjects and adds support for basic
3808/// ptrtoint+arithmetic+inttoptr sequences.
Hiroshi Inoueb49b0152017-10-12 06:26:04 +00003809/// It returns false if unidentified object is found in GetUnderlyingObjects.
3810bool llvm::getUnderlyingObjectsForCodeGen(const Value *V,
Hiroshi Inoueb9417db2017-08-01 03:32:15 +00003811 SmallVectorImpl<Value *> &Objects,
3812 const DataLayout &DL) {
3813 SmallPtrSet<const Value *, 16> Visited;
3814 SmallVector<const Value *, 4> Working(1, V);
3815 do {
3816 V = Working.pop_back_val();
3817
3818 SmallVector<Value *, 4> Objs;
3819 GetUnderlyingObjects(const_cast<Value *>(V), Objs, DL);
3820
3821 for (Value *V : Objs) {
Hiroshi Inoueb9417db2017-08-01 03:32:15 +00003822 if (!Visited.insert(V).second)
3823 continue;
3824 if (Operator::getOpcode(V) == Instruction::IntToPtr) {
3825 const Value *O =
3826 getUnderlyingObjectFromInt(cast<User>(V)->getOperand(0));
3827 if (O->getType()->isPointerTy()) {
3828 Working.push_back(O);
3829 continue;
3830 }
3831 }
Hiroshi Inoue0bd906e2017-08-02 18:16:32 +00003832 // If GetUnderlyingObjects fails to find an identifiable object,
3833 // getUnderlyingObjectsForCodeGen also fails for safety.
3834 if (!isIdentifiedObject(V)) {
3835 Objects.clear();
Hiroshi Inoueb49b0152017-10-12 06:26:04 +00003836 return false;
Hiroshi Inoue0bd906e2017-08-02 18:16:32 +00003837 }
Hiroshi Inoueb9417db2017-08-01 03:32:15 +00003838 Objects.push_back(const_cast<Value *>(V));
3839 }
3840 } while (!Working.empty());
Hiroshi Inoueb49b0152017-10-12 06:26:04 +00003841 return true;
Hiroshi Inoueb9417db2017-08-01 03:32:15 +00003842}
3843
Sanjay Patelaee84212014-11-04 16:27:42 +00003844/// Return true if the only users of this pointer are lifetime markers.
Nick Lewycky3e334a42011-06-27 04:20:45 +00003845bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003846 for (const User *U : V->users()) {
3847 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
Nick Lewycky3e334a42011-06-27 04:20:45 +00003848 if (!II) return false;
3849
Vedant Kumarb264d692018-12-21 21:49:40 +00003850 if (!II->isLifetimeStartOrEnd())
Nick Lewycky3e334a42011-06-27 04:20:45 +00003851 return false;
3852 }
3853 return true;
3854}
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003855
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003856bool llvm::isSafeToSpeculativelyExecute(const Value *V,
3857 const Instruction *CtxI,
Sean Silva45835e72016-07-02 23:47:27 +00003858 const DominatorTree *DT) {
Dan Gohman7ac046a2012-01-04 23:01:09 +00003859 const Operator *Inst = dyn_cast<Operator>(V);
3860 if (!Inst)
3861 return false;
3862
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003863 for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
3864 if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
3865 if (C->canTrap())
3866 return false;
3867
3868 switch (Inst->getOpcode()) {
3869 default:
3870 return true;
3871 case Instruction::UDiv:
David Majnemerf20d7c42014-11-04 23:49:08 +00003872 case Instruction::URem: {
3873 // x / y is undefined if y == 0.
3874 const APInt *V;
3875 if (match(Inst->getOperand(1), m_APInt(V)))
3876 return *V != 0;
3877 return false;
3878 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003879 case Instruction::SDiv:
3880 case Instruction::SRem: {
David Majnemerf20d7c42014-11-04 23:49:08 +00003881 // x / y is undefined if y == 0 or x == INT_MIN and y == -1
David Majnemer8a6578a2015-02-01 19:10:19 +00003882 const APInt *Numerator, *Denominator;
3883 if (!match(Inst->getOperand(1), m_APInt(Denominator)))
3884 return false;
3885 // We cannot hoist this division if the denominator is 0.
3886 if (*Denominator == 0)
3887 return false;
3888 // It's safe to hoist if the denominator is not 0 or -1.
3889 if (*Denominator != -1)
3890 return true;
3891 // At this point we know that the denominator is -1. It is safe to hoist as
3892 // long we know that the numerator is not INT_MIN.
3893 if (match(Inst->getOperand(0), m_APInt(Numerator)))
3894 return !Numerator->isMinSignedValue();
3895 // The numerator *might* be MinSignedValue.
David Majnemerf20d7c42014-11-04 23:49:08 +00003896 return false;
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003897 }
3898 case Instruction::Load: {
3899 const LoadInst *LI = cast<LoadInst>(Inst);
Kostya Serebryany0b458282013-11-21 07:29:28 +00003900 if (!LI->isUnordered() ||
3901 // Speculative load may create a race that did not exist in the source.
Sanjoy Dasb66374c2016-07-14 20:19:01 +00003902 LI->getFunction()->hasFnAttribute(Attribute::SanitizeThread) ||
Kostya Serebryany5cb86d52015-10-14 00:21:05 +00003903 // Speculative load may load data from dirty regions.
Evgeniy Stepanovc667c1f2017-12-09 00:21:41 +00003904 LI->getFunction()->hasFnAttribute(Attribute::SanitizeAddress) ||
3905 LI->getFunction()->hasFnAttribute(Attribute::SanitizeHWAddress))
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003906 return false;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003907 const DataLayout &DL = LI->getModule()->getDataLayout();
Sean Silva45835e72016-07-02 23:47:27 +00003908 return isDereferenceableAndAlignedPointer(LI->getPointerOperand(),
3909 LI->getAlignment(), DL, CtxI, DT);
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003910 }
Nick Lewyckyb4039f62011-12-21 05:52:02 +00003911 case Instruction::Call: {
Matt Arsenaultcf5e7fe2017-04-28 21:13:09 +00003912 auto *CI = cast<const CallInst>(Inst);
3913 const Function *Callee = CI->getCalledFunction();
David Majnemer0a92f862015-08-28 21:13:39 +00003914
Matt Arsenault6a288c12017-05-03 02:26:10 +00003915 // The called function could have undefined behavior or side-effects, even
3916 // if marked readnone nounwind.
3917 return Callee && Callee->isSpeculatable();
Nick Lewyckyb4039f62011-12-21 05:52:02 +00003918 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003919 case Instruction::VAArg:
3920 case Instruction::Alloca:
3921 case Instruction::Invoke:
Craig Topper784929d2019-02-08 20:48:56 +00003922 case Instruction::CallBr:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003923 case Instruction::PHI:
3924 case Instruction::Store:
3925 case Instruction::Ret:
3926 case Instruction::Br:
3927 case Instruction::IndirectBr:
3928 case Instruction::Switch:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003929 case Instruction::Unreachable:
3930 case Instruction::Fence:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003931 case Instruction::AtomicRMW:
3932 case Instruction::AtomicCmpXchg:
David Majnemer654e1302015-07-31 17:58:14 +00003933 case Instruction::LandingPad:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003934 case Instruction::Resume:
David Majnemer8a1c45d2015-12-12 05:38:55 +00003935 case Instruction::CatchSwitch:
David Majnemer654e1302015-07-31 17:58:14 +00003936 case Instruction::CatchPad:
David Majnemer654e1302015-07-31 17:58:14 +00003937 case Instruction::CatchRet:
3938 case Instruction::CleanupPad:
3939 case Instruction::CleanupRet:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003940 return false; // Misc instructions which have effects
3941 }
3942}
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003943
Quentin Colombet6443cce2015-08-06 18:44:34 +00003944bool llvm::mayBeMemoryDependent(const Instruction &I) {
3945 return I.mayReadOrWriteMemory() || !isSafeToSpeculativelyExecute(&I);
3946}
3947
Florian Hahn19f9e322018-08-17 14:39:04 +00003948OverflowResult llvm::computeOverflowForUnsignedMul(
3949 const Value *LHS, const Value *RHS, const DataLayout &DL,
3950 AssumptionCache *AC, const Instruction *CxtI, const DominatorTree *DT,
3951 bool UseInstrInfo) {
David Majnemer491331a2015-01-02 07:29:43 +00003952 // Multiplying n * m significant bits yields a result of n + m significant
3953 // bits. If the total number of significant bits does not exceed the
3954 // result bit width (minus 1), there is no overflow.
3955 // This means if we have enough leading zero bits in the operands
3956 // we can guarantee that the result does not overflow.
3957 // Ref: "Hacker's Delight" by Henry Warren
3958 unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
Craig Topperb45eabc2017-04-26 16:39:58 +00003959 KnownBits LHSKnown(BitWidth);
3960 KnownBits RHSKnown(BitWidth);
Florian Hahn19f9e322018-08-17 14:39:04 +00003961 computeKnownBits(LHS, LHSKnown, DL, /*Depth=*/0, AC, CxtI, DT, nullptr,
3962 UseInstrInfo);
3963 computeKnownBits(RHS, RHSKnown, DL, /*Depth=*/0, AC, CxtI, DT, nullptr,
3964 UseInstrInfo);
David Majnemer491331a2015-01-02 07:29:43 +00003965 // Note that underestimating the number of zero bits gives a more
3966 // conservative answer.
Craig Topper8df66c62017-05-12 17:20:30 +00003967 unsigned ZeroBits = LHSKnown.countMinLeadingZeros() +
3968 RHSKnown.countMinLeadingZeros();
David Majnemer491331a2015-01-02 07:29:43 +00003969 // First handle the easy case: if we have enough zero bits there's
3970 // definitely no overflow.
3971 if (ZeroBits >= BitWidth)
3972 return OverflowResult::NeverOverflows;
3973
3974 // Get the largest possible values for each operand.
Craig Topperb45eabc2017-04-26 16:39:58 +00003975 APInt LHSMax = ~LHSKnown.Zero;
3976 APInt RHSMax = ~RHSKnown.Zero;
David Majnemer491331a2015-01-02 07:29:43 +00003977
3978 // We know the multiply operation doesn't overflow if the maximum values for
3979 // each operand will not overflow after we multiply them together.
David Majnemerc8a576b2015-01-02 07:29:47 +00003980 bool MaxOverflow;
Craig Topper9b71a402017-04-19 21:09:45 +00003981 (void)LHSMax.umul_ov(RHSMax, MaxOverflow);
David Majnemerc8a576b2015-01-02 07:29:47 +00003982 if (!MaxOverflow)
3983 return OverflowResult::NeverOverflows;
David Majnemer491331a2015-01-02 07:29:43 +00003984
David Majnemerc8a576b2015-01-02 07:29:47 +00003985 // We know it always overflows if multiplying the smallest possible values for
3986 // the operands also results in overflow.
3987 bool MinOverflow;
Craig Topperb45eabc2017-04-26 16:39:58 +00003988 (void)LHSKnown.One.umul_ov(RHSKnown.One, MinOverflow);
David Majnemerc8a576b2015-01-02 07:29:47 +00003989 if (MinOverflow)
3990 return OverflowResult::AlwaysOverflows;
3991
3992 return OverflowResult::MayOverflow;
David Majnemer491331a2015-01-02 07:29:43 +00003993}
David Majnemer5310c1e2015-01-07 00:39:50 +00003994
Florian Hahn19f9e322018-08-17 14:39:04 +00003995OverflowResult
3996llvm::computeOverflowForSignedMul(const Value *LHS, const Value *RHS,
3997 const DataLayout &DL, AssumptionCache *AC,
3998 const Instruction *CxtI,
3999 const DominatorTree *DT, bool UseInstrInfo) {
Omer Paparo Bivasfbb83de2018-05-10 19:46:19 +00004000 // Multiplying n * m significant bits yields a result of n + m significant
4001 // bits. If the total number of significant bits does not exceed the
4002 // result bit width (minus 1), there is no overflow.
4003 // This means if we have enough leading sign bits in the operands
4004 // we can guarantee that the result does not overflow.
4005 // Ref: "Hacker's Delight" by Henry Warren
4006 unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
4007
4008 // Note that underestimating the number of sign bits gives a more
4009 // conservative answer.
4010 unsigned SignBits = ComputeNumSignBits(LHS, DL, 0, AC, CxtI, DT) +
4011 ComputeNumSignBits(RHS, DL, 0, AC, CxtI, DT);
4012
4013 // First handle the easy case: if we have enough sign bits there's
4014 // definitely no overflow.
4015 if (SignBits > BitWidth + 1)
4016 return OverflowResult::NeverOverflows;
4017
4018 // There are two ambiguous cases where there can be no overflow:
4019 // SignBits == BitWidth + 1 and
4020 // SignBits == BitWidth
4021 // The second case is difficult to check, therefore we only handle the
4022 // first case.
4023 if (SignBits == BitWidth + 1) {
4024 // It overflows only when both arguments are negative and the true
4025 // product is exactly the minimum negative number.
4026 // E.g. mul i16 with 17 sign bits: 0xff00 * 0xff80 = 0x8000
4027 // For simplicity we just check if at least one side is not negative.
Florian Hahn19f9e322018-08-17 14:39:04 +00004028 KnownBits LHSKnown = computeKnownBits(LHS, DL, /*Depth=*/0, AC, CxtI, DT,
4029 nullptr, UseInstrInfo);
4030 KnownBits RHSKnown = computeKnownBits(RHS, DL, /*Depth=*/0, AC, CxtI, DT,
4031 nullptr, UseInstrInfo);
Omer Paparo Bivasfbb83de2018-05-10 19:46:19 +00004032 if (LHSKnown.isNonNegative() || RHSKnown.isNonNegative())
4033 return OverflowResult::NeverOverflows;
4034 }
4035 return OverflowResult::MayOverflow;
4036}
4037
Florian Hahn19f9e322018-08-17 14:39:04 +00004038OverflowResult llvm::computeOverflowForUnsignedAdd(
4039 const Value *LHS, const Value *RHS, const DataLayout &DL,
4040 AssumptionCache *AC, const Instruction *CxtI, const DominatorTree *DT,
4041 bool UseInstrInfo) {
4042 KnownBits LHSKnown = computeKnownBits(LHS, DL, /*Depth=*/0, AC, CxtI, DT,
4043 nullptr, UseInstrInfo);
Nikita Popov6c573952019-02-28 08:11:20 +00004044 KnownBits RHSKnown = computeKnownBits(RHS, DL, /*Depth=*/0, AC, CxtI, DT,
4045 nullptr, UseInstrInfo);
David Majnemer5310c1e2015-01-07 00:39:50 +00004046
Nikita Popov6c573952019-02-28 08:11:20 +00004047 // a + b overflows iff a > ~b. Determine whether this is never/always true
4048 // based on the min/max values achievable under the known bits constraint.
4049 APInt MinLHS = LHSKnown.One, MaxLHS = ~LHSKnown.Zero;
4050 APInt MinInvRHS = RHSKnown.Zero, MaxInvRHS = ~RHSKnown.One;
4051 if (MaxLHS.ule(MinInvRHS))
4052 return OverflowResult::NeverOverflows;
4053 if (MinLHS.ugt(MaxInvRHS))
4054 return OverflowResult::AlwaysOverflows;
David Majnemer5310c1e2015-01-07 00:39:50 +00004055 return OverflowResult::MayOverflow;
4056}
James Molloy71b91c22015-05-11 14:42:20 +00004057
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00004058/// Return true if we can prove that adding the two values of the
Craig Topperbb973722017-05-15 02:44:08 +00004059/// knownbits will not overflow.
4060/// Otherwise return false.
4061static bool checkRippleForSignedAdd(const KnownBits &LHSKnown,
4062 const KnownBits &RHSKnown) {
4063 // Addition of two 2's complement numbers having opposite signs will never
4064 // overflow.
4065 if ((LHSKnown.isNegative() && RHSKnown.isNonNegative()) ||
4066 (LHSKnown.isNonNegative() && RHSKnown.isNegative()))
4067 return true;
4068
4069 // If either of the values is known to be non-negative, adding them can only
4070 // overflow if the second is also non-negative, so we can assume that.
Fangrui Songf78650a2018-07-30 19:41:25 +00004071 // Two non-negative numbers will only overflow if there is a carry to the
Craig Topperbb973722017-05-15 02:44:08 +00004072 // sign bit, so we can check if even when the values are as big as possible
4073 // there is no overflow to the sign bit.
4074 if (LHSKnown.isNonNegative() || RHSKnown.isNonNegative()) {
4075 APInt MaxLHS = ~LHSKnown.Zero;
4076 MaxLHS.clearSignBit();
4077 APInt MaxRHS = ~RHSKnown.Zero;
4078 MaxRHS.clearSignBit();
4079 APInt Result = std::move(MaxLHS) + std::move(MaxRHS);
4080 return Result.isSignBitClear();
4081 }
4082
4083 // If either of the values is known to be negative, adding them can only
4084 // overflow if the second is also negative, so we can assume that.
4085 // Two negative number will only overflow if there is no carry to the sign
4086 // bit, so we can check if even when the values are as small as possible
4087 // there is overflow to the sign bit.
4088 if (LHSKnown.isNegative() || RHSKnown.isNegative()) {
4089 APInt MinLHS = LHSKnown.One;
4090 MinLHS.clearSignBit();
4091 APInt MinRHS = RHSKnown.One;
4092 MinRHS.clearSignBit();
4093 APInt Result = std::move(MinLHS) + std::move(MinRHS);
4094 return Result.isSignBitSet();
4095 }
4096
4097 // If we reached here it means that we know nothing about the sign bits.
Fangrui Songf78650a2018-07-30 19:41:25 +00004098 // In this case we can't know if there will be an overflow, since by
Craig Topperbb973722017-05-15 02:44:08 +00004099 // changing the sign bits any two values can be made to overflow.
4100 return false;
4101}
4102
Pete Cooper35b00d52016-08-13 01:05:32 +00004103static OverflowResult computeOverflowForSignedAdd(const Value *LHS,
4104 const Value *RHS,
4105 const AddOperator *Add,
4106 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004107 AssumptionCache *AC,
Pete Cooper35b00d52016-08-13 01:05:32 +00004108 const Instruction *CxtI,
4109 const DominatorTree *DT) {
Jingyue Wu10fcea52015-08-20 18:27:04 +00004110 if (Add && Add->hasNoSignedWrap()) {
4111 return OverflowResult::NeverOverflows;
4112 }
4113
Craig Topperbb973722017-05-15 02:44:08 +00004114 // If LHS and RHS each have at least two sign bits, the addition will look
4115 // like
4116 //
4117 // XX..... +
4118 // YY.....
4119 //
4120 // If the carry into the most significant position is 0, X and Y can't both
4121 // be 1 and therefore the carry out of the addition is also 0.
4122 //
4123 // If the carry into the most significant position is 1, X and Y can't both
4124 // be 0 and therefore the carry out of the addition is also 1.
4125 //
4126 // Since the carry into the most significant position is always equal to
4127 // the carry out of the addition, there is no signed overflow.
4128 if (ComputeNumSignBits(LHS, DL, 0, AC, CxtI, DT) > 1 &&
4129 ComputeNumSignBits(RHS, DL, 0, AC, CxtI, DT) > 1)
4130 return OverflowResult::NeverOverflows;
4131
Craig Topper6e11a052017-05-08 16:22:48 +00004132 KnownBits LHSKnown = computeKnownBits(LHS, DL, /*Depth=*/0, AC, CxtI, DT);
4133 KnownBits RHSKnown = computeKnownBits(RHS, DL, /*Depth=*/0, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00004134
Craig Topperbb973722017-05-15 02:44:08 +00004135 if (checkRippleForSignedAdd(LHSKnown, RHSKnown))
Jingyue Wu10fcea52015-08-20 18:27:04 +00004136 return OverflowResult::NeverOverflows;
Jingyue Wu10fcea52015-08-20 18:27:04 +00004137
4138 // The remaining code needs Add to be available. Early returns if not so.
4139 if (!Add)
4140 return OverflowResult::MayOverflow;
4141
4142 // If the sign of Add is the same as at least one of the operands, this add
4143 // CANNOT overflow. This is particularly useful when the sum is
4144 // @llvm.assume'ed non-negative rather than proved so from analyzing its
4145 // operands.
4146 bool LHSOrRHSKnownNonNegative =
Craig Topper6e11a052017-05-08 16:22:48 +00004147 (LHSKnown.isNonNegative() || RHSKnown.isNonNegative());
Fangrui Songf78650a2018-07-30 19:41:25 +00004148 bool LHSOrRHSKnownNegative =
Craig Topperbb973722017-05-15 02:44:08 +00004149 (LHSKnown.isNegative() || RHSKnown.isNegative());
Jingyue Wu10fcea52015-08-20 18:27:04 +00004150 if (LHSOrRHSKnownNonNegative || LHSOrRHSKnownNegative) {
Craig Topper6e11a052017-05-08 16:22:48 +00004151 KnownBits AddKnown = computeKnownBits(Add, DL, /*Depth=*/0, AC, CxtI, DT);
4152 if ((AddKnown.isNonNegative() && LHSOrRHSKnownNonNegative) ||
4153 (AddKnown.isNegative() && LHSOrRHSKnownNegative)) {
Jingyue Wu10fcea52015-08-20 18:27:04 +00004154 return OverflowResult::NeverOverflows;
4155 }
4156 }
4157
4158 return OverflowResult::MayOverflow;
4159}
4160
Omer Paparo Bivasfbb83de2018-05-10 19:46:19 +00004161OverflowResult llvm::computeOverflowForUnsignedSub(const Value *LHS,
4162 const Value *RHS,
4163 const DataLayout &DL,
4164 AssumptionCache *AC,
4165 const Instruction *CxtI,
4166 const DominatorTree *DT) {
Omer Paparo Bivasfbb83de2018-05-10 19:46:19 +00004167 KnownBits LHSKnown = computeKnownBits(LHS, DL, /*Depth=*/0, AC, CxtI, DT);
Nikita Popovcf596a82018-11-28 16:37:04 +00004168 if (LHSKnown.isNonNegative() || LHSKnown.isNegative()) {
4169 KnownBits RHSKnown = computeKnownBits(RHS, DL, /*Depth=*/0, AC, CxtI, DT);
4170
4171 // If the LHS is negative and the RHS is non-negative, no unsigned wrap.
4172 if (LHSKnown.isNegative() && RHSKnown.isNonNegative())
4173 return OverflowResult::NeverOverflows;
4174
4175 // If the LHS is non-negative and the RHS negative, we always wrap.
4176 if (LHSKnown.isNonNegative() && RHSKnown.isNegative())
4177 return OverflowResult::AlwaysOverflows;
4178 }
Omer Paparo Bivasfbb83de2018-05-10 19:46:19 +00004179
4180 return OverflowResult::MayOverflow;
4181}
4182
4183OverflowResult llvm::computeOverflowForSignedSub(const Value *LHS,
4184 const Value *RHS,
4185 const DataLayout &DL,
4186 AssumptionCache *AC,
4187 const Instruction *CxtI,
4188 const DominatorTree *DT) {
4189 // If LHS and RHS each have at least two sign bits, the subtraction
4190 // cannot overflow.
4191 if (ComputeNumSignBits(LHS, DL, 0, AC, CxtI, DT) > 1 &&
4192 ComputeNumSignBits(RHS, DL, 0, AC, CxtI, DT) > 1)
4193 return OverflowResult::NeverOverflows;
4194
4195 KnownBits LHSKnown = computeKnownBits(LHS, DL, 0, AC, CxtI, DT);
4196
4197 KnownBits RHSKnown = computeKnownBits(RHS, DL, 0, AC, CxtI, DT);
4198
4199 // Subtraction of two 2's complement numbers having identical signs will
4200 // never overflow.
4201 if ((LHSKnown.isNegative() && RHSKnown.isNegative()) ||
4202 (LHSKnown.isNonNegative() && RHSKnown.isNonNegative()))
4203 return OverflowResult::NeverOverflows;
4204
4205 // TODO: implement logic similar to checkRippleForAdd
4206 return OverflowResult::MayOverflow;
4207}
4208
Pete Cooper35b00d52016-08-13 01:05:32 +00004209bool llvm::isOverflowIntrinsicNoWrap(const IntrinsicInst *II,
4210 const DominatorTree &DT) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004211#ifndef NDEBUG
4212 auto IID = II->getIntrinsicID();
4213 assert((IID == Intrinsic::sadd_with_overflow ||
4214 IID == Intrinsic::uadd_with_overflow ||
4215 IID == Intrinsic::ssub_with_overflow ||
4216 IID == Intrinsic::usub_with_overflow ||
4217 IID == Intrinsic::smul_with_overflow ||
4218 IID == Intrinsic::umul_with_overflow) &&
4219 "Not an overflow intrinsic!");
4220#endif
4221
Pete Cooper35b00d52016-08-13 01:05:32 +00004222 SmallVector<const BranchInst *, 2> GuardingBranches;
4223 SmallVector<const ExtractValueInst *, 2> Results;
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004224
Pete Cooper35b00d52016-08-13 01:05:32 +00004225 for (const User *U : II->users()) {
4226 if (const auto *EVI = dyn_cast<ExtractValueInst>(U)) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004227 assert(EVI->getNumIndices() == 1 && "Obvious from CI's type");
4228
4229 if (EVI->getIndices()[0] == 0)
4230 Results.push_back(EVI);
4231 else {
4232 assert(EVI->getIndices()[0] == 1 && "Obvious from CI's type");
4233
Pete Cooper35b00d52016-08-13 01:05:32 +00004234 for (const auto *U : EVI->users())
4235 if (const auto *B = dyn_cast<BranchInst>(U)) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004236 assert(B->isConditional() && "How else is it using an i1?");
4237 GuardingBranches.push_back(B);
4238 }
4239 }
4240 } else {
4241 // We are using the aggregate directly in a way we don't want to analyze
4242 // here (storing it to a global, say).
4243 return false;
4244 }
4245 }
4246
Pete Cooper35b00d52016-08-13 01:05:32 +00004247 auto AllUsesGuardedByBranch = [&](const BranchInst *BI) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004248 BasicBlockEdge NoWrapEdge(BI->getParent(), BI->getSuccessor(1));
4249 if (!NoWrapEdge.isSingleEdge())
4250 return false;
4251
4252 // Check if all users of the add are provably no-wrap.
Pete Cooper35b00d52016-08-13 01:05:32 +00004253 for (const auto *Result : Results) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004254 // If the extractvalue itself is not executed on overflow, the we don't
4255 // need to check each use separately, since domination is transitive.
4256 if (DT.dominates(NoWrapEdge, Result->getParent()))
4257 continue;
4258
4259 for (auto &RU : Result->uses())
4260 if (!DT.dominates(NoWrapEdge, RU))
4261 return false;
4262 }
4263
4264 return true;
4265 };
4266
Eugene Zelenko75075ef2017-09-01 21:37:29 +00004267 return llvm::any_of(GuardingBranches, AllUsesGuardedByBranch);
Sanjoy Dasf49ca522016-05-29 00:34:42 +00004268}
4269
4270
Pete Cooper35b00d52016-08-13 01:05:32 +00004271OverflowResult llvm::computeOverflowForSignedAdd(const AddOperator *Add,
Jingyue Wu10fcea52015-08-20 18:27:04 +00004272 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004273 AssumptionCache *AC,
Jingyue Wu10fcea52015-08-20 18:27:04 +00004274 const Instruction *CxtI,
4275 const DominatorTree *DT) {
4276 return ::computeOverflowForSignedAdd(Add->getOperand(0), Add->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004277 Add, DL, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00004278}
4279
Pete Cooper35b00d52016-08-13 01:05:32 +00004280OverflowResult llvm::computeOverflowForSignedAdd(const Value *LHS,
4281 const Value *RHS,
Jingyue Wu10fcea52015-08-20 18:27:04 +00004282 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004283 AssumptionCache *AC,
Jingyue Wu10fcea52015-08-20 18:27:04 +00004284 const Instruction *CxtI,
4285 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004286 return ::computeOverflowForSignedAdd(LHS, RHS, nullptr, DL, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00004287}
4288
Jingyue Wu42f1d672015-07-28 18:22:40 +00004289bool llvm::isGuaranteedToTransferExecutionToSuccessor(const Instruction *I) {
Eli Friedmanf1da33e2016-06-11 21:48:25 +00004290 // A memory operation returns normally if it isn't volatile. A volatile
4291 // operation is allowed to trap.
4292 //
4293 // An atomic operation isn't guaranteed to return in a reasonable amount of
4294 // time because it's possible for another thread to interfere with it for an
4295 // arbitrary length of time, but programs aren't allowed to rely on that.
4296 if (const LoadInst *LI = dyn_cast<LoadInst>(I))
4297 return !LI->isVolatile();
4298 if (const StoreInst *SI = dyn_cast<StoreInst>(I))
4299 return !SI->isVolatile();
4300 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(I))
4301 return !CXI->isVolatile();
4302 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(I))
4303 return !RMWI->isVolatile();
4304 if (const MemIntrinsic *MII = dyn_cast<MemIntrinsic>(I))
4305 return !MII->isVolatile();
Jingyue Wu42f1d672015-07-28 18:22:40 +00004306
Eli Friedmanf1da33e2016-06-11 21:48:25 +00004307 // If there is no successor, then execution can't transfer to it.
4308 if (const auto *CRI = dyn_cast<CleanupReturnInst>(I))
4309 return !CRI->unwindsToCaller();
4310 if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(I))
4311 return !CatchSwitch->unwindsToCaller();
4312 if (isa<ResumeInst>(I))
4313 return false;
4314 if (isa<ReturnInst>(I))
4315 return false;
Sebastian Pop4a4d2452017-03-08 01:54:50 +00004316 if (isa<UnreachableInst>(I))
4317 return false;
Sanjoy Das9a65cd22016-06-08 17:48:36 +00004318
Eli Friedmanf1da33e2016-06-11 21:48:25 +00004319 // Calls can throw, or contain an infinite loop, or kill the process.
Sanjoy Das09455302016-12-31 22:12:31 +00004320 if (auto CS = ImmutableCallSite(I)) {
Sanjoy Das3bb2dbd2016-12-31 22:12:34 +00004321 // Call sites that throw have implicit non-local control flow.
4322 if (!CS.doesNotThrow())
4323 return false;
4324
4325 // Non-throwing call sites can loop infinitely, call exit/pthread_exit
4326 // etc. and thus not return. However, LLVM already assumes that
4327 //
4328 // - Thread exiting actions are modeled as writes to memory invisible to
4329 // the program.
4330 //
4331 // - Loops that don't have side effects (side effects are volatile/atomic
4332 // stores and IO) always terminate (see http://llvm.org/PR965).
4333 // Furthermore IO itself is also modeled as writes to memory invisible to
4334 // the program.
4335 //
4336 // We rely on those assumptions here, and use the memory effects of the call
4337 // target as a proxy for checking that it always returns.
4338
4339 // FIXME: This isn't aggressive enough; a call which only writes to a global
4340 // is guaranteed to return.
Sanjoy Dasd7e82062016-06-14 20:23:16 +00004341 return CS.onlyReadsMemory() || CS.onlyAccessesArgMemory() ||
Dan Gohman2c74fe92017-11-08 21:59:51 +00004342 match(I, m_Intrinsic<Intrinsic::assume>()) ||
Max Kazantsevb3168a42019-02-14 11:10:21 +00004343 match(I, m_Intrinsic<Intrinsic::sideeffect>()) ||
4344 match(I, m_Intrinsic<Intrinsic::experimental_widenable_condition>());
Eli Friedmanf1da33e2016-06-11 21:48:25 +00004345 }
4346
4347 // Other instructions return normally.
4348 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00004349}
4350
Philip Reamesfbffd122018-03-08 21:25:30 +00004351bool llvm::isGuaranteedToTransferExecutionToSuccessor(const BasicBlock *BB) {
Hiroshi Inouec437f312019-01-30 05:26:31 +00004352 // TODO: This is slightly conservative for invoke instruction since exiting
Philip Reamesfbffd122018-03-08 21:25:30 +00004353 // via an exception *is* normal control for them.
4354 for (auto I = BB->begin(), E = BB->end(); I != E; ++I)
4355 if (!isGuaranteedToTransferExecutionToSuccessor(&*I))
4356 return false;
4357 return true;
4358}
4359
Jingyue Wu42f1d672015-07-28 18:22:40 +00004360bool llvm::isGuaranteedToExecuteForEveryIteration(const Instruction *I,
4361 const Loop *L) {
4362 // The loop header is guaranteed to be executed for every iteration.
4363 //
4364 // FIXME: Relax this constraint to cover all basic blocks that are
4365 // guaranteed to be executed at every iteration.
4366 if (I->getParent() != L->getHeader()) return false;
4367
4368 for (const Instruction &LI : *L->getHeader()) {
4369 if (&LI == I) return true;
4370 if (!isGuaranteedToTransferExecutionToSuccessor(&LI)) return false;
4371 }
4372 llvm_unreachable("Instruction not contained in its own parent basic block.");
4373}
4374
4375bool llvm::propagatesFullPoison(const Instruction *I) {
4376 switch (I->getOpcode()) {
Sanjoy Das7b0b4082017-02-21 02:42:42 +00004377 case Instruction::Add:
4378 case Instruction::Sub:
4379 case Instruction::Xor:
4380 case Instruction::Trunc:
4381 case Instruction::BitCast:
4382 case Instruction::AddrSpaceCast:
Sanjoy Das5cd6c5ca2017-02-22 06:52:32 +00004383 case Instruction::Mul:
4384 case Instruction::Shl:
4385 case Instruction::GetElementPtr:
Sanjoy Das7b0b4082017-02-21 02:42:42 +00004386 // These operations all propagate poison unconditionally. Note that poison
4387 // is not any particular value, so xor or subtraction of poison with
4388 // itself still yields poison, not zero.
4389 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00004390
Sanjoy Das7b0b4082017-02-21 02:42:42 +00004391 case Instruction::AShr:
4392 case Instruction::SExt:
4393 // For these operations, one bit of the input is replicated across
4394 // multiple output bits. A replicated poison bit is still poison.
4395 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00004396
Sanjoy Das7b0b4082017-02-21 02:42:42 +00004397 case Instruction::ICmp:
4398 // Comparing poison with any value yields poison. This is why, for
4399 // instance, x s< (x +nsw 1) can be folded to true.
4400 return true;
Sanjoy Das70c2bbd2016-05-29 00:31:18 +00004401
Sanjoy Das7b0b4082017-02-21 02:42:42 +00004402 default:
4403 return false;
Jingyue Wu42f1d672015-07-28 18:22:40 +00004404 }
4405}
4406
4407const Value *llvm::getGuaranteedNonFullPoisonOp(const Instruction *I) {
4408 switch (I->getOpcode()) {
4409 case Instruction::Store:
4410 return cast<StoreInst>(I)->getPointerOperand();
4411
4412 case Instruction::Load:
4413 return cast<LoadInst>(I)->getPointerOperand();
4414
4415 case Instruction::AtomicCmpXchg:
4416 return cast<AtomicCmpXchgInst>(I)->getPointerOperand();
4417
4418 case Instruction::AtomicRMW:
4419 return cast<AtomicRMWInst>(I)->getPointerOperand();
4420
4421 case Instruction::UDiv:
4422 case Instruction::SDiv:
4423 case Instruction::URem:
4424 case Instruction::SRem:
4425 return I->getOperand(1);
4426
4427 default:
4428 return nullptr;
4429 }
4430}
4431
Sanjoy Das08989c72017-04-30 19:41:19 +00004432bool llvm::programUndefinedIfFullPoison(const Instruction *PoisonI) {
Jingyue Wu42f1d672015-07-28 18:22:40 +00004433 // We currently only look for uses of poison values within the same basic
4434 // block, as that makes it easier to guarantee that the uses will be
4435 // executed given that PoisonI is executed.
4436 //
4437 // FIXME: Expand this to consider uses beyond the same basic block. To do
4438 // this, look out for the distinction between post-dominance and strong
4439 // post-dominance.
4440 const BasicBlock *BB = PoisonI->getParent();
4441
4442 // Set of instructions that we have proved will yield poison if PoisonI
4443 // does.
4444 SmallSet<const Value *, 16> YieldsPoison;
Sanjoy Dasa6155b62016-04-22 17:41:06 +00004445 SmallSet<const BasicBlock *, 4> Visited;
Jingyue Wu42f1d672015-07-28 18:22:40 +00004446 YieldsPoison.insert(PoisonI);
Sanjoy Dasa6155b62016-04-22 17:41:06 +00004447 Visited.insert(PoisonI->getParent());
Jingyue Wu42f1d672015-07-28 18:22:40 +00004448
Sanjoy Dasa6155b62016-04-22 17:41:06 +00004449 BasicBlock::const_iterator Begin = PoisonI->getIterator(), End = BB->end();
Jingyue Wu42f1d672015-07-28 18:22:40 +00004450
Sanjoy Dasa6155b62016-04-22 17:41:06 +00004451 unsigned Iter = 0;
4452 while (Iter++ < MaxDepth) {
4453 for (auto &I : make_range(Begin, End)) {
4454 if (&I != PoisonI) {
4455 const Value *NotPoison = getGuaranteedNonFullPoisonOp(&I);
4456 if (NotPoison != nullptr && YieldsPoison.count(NotPoison))
4457 return true;
4458 if (!isGuaranteedToTransferExecutionToSuccessor(&I))
4459 return false;
4460 }
4461
4462 // Mark poison that propagates from I through uses of I.
4463 if (YieldsPoison.count(&I)) {
4464 for (const User *User : I.users()) {
4465 const Instruction *UserI = cast<Instruction>(User);
4466 if (propagatesFullPoison(UserI))
4467 YieldsPoison.insert(User);
4468 }
Jingyue Wu42f1d672015-07-28 18:22:40 +00004469 }
4470 }
Sanjoy Dasa6155b62016-04-22 17:41:06 +00004471
4472 if (auto *NextBB = BB->getSingleSuccessor()) {
4473 if (Visited.insert(NextBB).second) {
4474 BB = NextBB;
4475 Begin = BB->getFirstNonPHI()->getIterator();
4476 End = BB->end();
4477 continue;
4478 }
4479 }
4480
4481 break;
Eugene Zelenko75075ef2017-09-01 21:37:29 +00004482 }
Jingyue Wu42f1d672015-07-28 18:22:40 +00004483 return false;
4484}
4485
Pete Cooper35b00d52016-08-13 01:05:32 +00004486static bool isKnownNonNaN(const Value *V, FastMathFlags FMF) {
James Molloy134bec22015-08-11 09:12:57 +00004487 if (FMF.noNaNs())
4488 return true;
4489
4490 if (auto *C = dyn_cast<ConstantFP>(V))
4491 return !C->isNaN();
Thomas Livelyd47b5c72018-09-28 21:36:43 +00004492
4493 if (auto *C = dyn_cast<ConstantDataVector>(V)) {
4494 if (!C->getElementType()->isFloatingPointTy())
4495 return false;
4496 for (unsigned I = 0, E = C->getNumElements(); I < E; ++I) {
4497 if (C->getElementAsAPFloat(I).isNaN())
4498 return false;
4499 }
4500 return true;
4501 }
4502
James Molloy134bec22015-08-11 09:12:57 +00004503 return false;
4504}
4505
Pete Cooper35b00d52016-08-13 01:05:32 +00004506static bool isKnownNonZero(const Value *V) {
James Molloy134bec22015-08-11 09:12:57 +00004507 if (auto *C = dyn_cast<ConstantFP>(V))
4508 return !C->isZero();
Thomas Livelyd47b5c72018-09-28 21:36:43 +00004509
4510 if (auto *C = dyn_cast<ConstantDataVector>(V)) {
4511 if (!C->getElementType()->isFloatingPointTy())
4512 return false;
4513 for (unsigned I = 0, E = C->getNumElements(); I < E; ++I) {
4514 if (C->getElementAsAPFloat(I).isZero())
4515 return false;
4516 }
4517 return true;
4518 }
4519
James Molloy134bec22015-08-11 09:12:57 +00004520 return false;
4521}
4522
Nikolai Bozhenov1545eb32017-08-04 12:22:17 +00004523/// Match clamp pattern for float types without care about NaNs or signed zeros.
4524/// Given non-min/max outer cmp/select from the clamp pattern this
4525/// function recognizes if it can be substitued by a "canonical" min/max
4526/// pattern.
4527static SelectPatternResult matchFastFloatClamp(CmpInst::Predicate Pred,
4528 Value *CmpLHS, Value *CmpRHS,
4529 Value *TrueVal, Value *FalseVal,
4530 Value *&LHS, Value *&RHS) {
4531 // Try to match
4532 // X < C1 ? C1 : Min(X, C2) --> Max(C1, Min(X, C2))
4533 // X > C1 ? C1 : Max(X, C2) --> Min(C1, Max(X, C2))
4534 // and return description of the outer Max/Min.
4535
4536 // First, check if select has inverse order:
4537 if (CmpRHS == FalseVal) {
4538 std::swap(TrueVal, FalseVal);
4539 Pred = CmpInst::getInversePredicate(Pred);
4540 }
4541
4542 // Assume success now. If there's no match, callers should not use these anyway.
4543 LHS = TrueVal;
4544 RHS = FalseVal;
4545
4546 const APFloat *FC1;
4547 if (CmpRHS != TrueVal || !match(CmpRHS, m_APFloat(FC1)) || !FC1->isFinite())
4548 return {SPF_UNKNOWN, SPNB_NA, false};
4549
4550 const APFloat *FC2;
4551 switch (Pred) {
4552 case CmpInst::FCMP_OLT:
4553 case CmpInst::FCMP_OLE:
4554 case CmpInst::FCMP_ULT:
4555 case CmpInst::FCMP_ULE:
4556 if (match(FalseVal,
4557 m_CombineOr(m_OrdFMin(m_Specific(CmpLHS), m_APFloat(FC2)),
4558 m_UnordFMin(m_Specific(CmpLHS), m_APFloat(FC2)))) &&
4559 FC1->compare(*FC2) == APFloat::cmpResult::cmpLessThan)
4560 return {SPF_FMAXNUM, SPNB_RETURNS_ANY, false};
4561 break;
4562 case CmpInst::FCMP_OGT:
4563 case CmpInst::FCMP_OGE:
4564 case CmpInst::FCMP_UGT:
4565 case CmpInst::FCMP_UGE:
4566 if (match(FalseVal,
4567 m_CombineOr(m_OrdFMax(m_Specific(CmpLHS), m_APFloat(FC2)),
4568 m_UnordFMax(m_Specific(CmpLHS), m_APFloat(FC2)))) &&
4569 FC1->compare(*FC2) == APFloat::cmpResult::cmpGreaterThan)
4570 return {SPF_FMINNUM, SPNB_RETURNS_ANY, false};
4571 break;
4572 default:
4573 break;
4574 }
4575
4576 return {SPF_UNKNOWN, SPNB_NA, false};
4577}
4578
Artur Gainullinaf7ba8f2017-10-27 20:53:41 +00004579/// Recognize variations of:
4580/// CLAMP(v,l,h) ==> ((v) < (l) ? (l) : ((v) > (h) ? (h) : (v)))
4581static SelectPatternResult matchClamp(CmpInst::Predicate Pred,
4582 Value *CmpLHS, Value *CmpRHS,
4583 Value *TrueVal, Value *FalseVal) {
4584 // Swap the select operands and predicate to match the patterns below.
4585 if (CmpRHS != TrueVal) {
4586 Pred = ICmpInst::getSwappedPredicate(Pred);
4587 std::swap(TrueVal, FalseVal);
4588 }
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004589 const APInt *C1;
4590 if (CmpRHS == TrueVal && match(CmpRHS, m_APInt(C1))) {
4591 const APInt *C2;
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004592 // (X <s C1) ? C1 : SMIN(X, C2) ==> SMAX(SMIN(X, C2), C1)
4593 if (match(FalseVal, m_SMin(m_Specific(CmpLHS), m_APInt(C2))) &&
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004594 C1->slt(*C2) && Pred == CmpInst::ICMP_SLT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004595 return {SPF_SMAX, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004596
4597 // (X >s C1) ? C1 : SMAX(X, C2) ==> SMIN(SMAX(X, C2), C1)
4598 if (match(FalseVal, m_SMax(m_Specific(CmpLHS), m_APInt(C2))) &&
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004599 C1->sgt(*C2) && Pred == CmpInst::ICMP_SGT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004600 return {SPF_SMIN, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004601
4602 // (X <u C1) ? C1 : UMIN(X, C2) ==> UMAX(UMIN(X, C2), C1)
4603 if (match(FalseVal, m_UMin(m_Specific(CmpLHS), m_APInt(C2))) &&
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004604 C1->ult(*C2) && Pred == CmpInst::ICMP_ULT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004605 return {SPF_UMAX, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004606
4607 // (X >u C1) ? C1 : UMAX(X, C2) ==> UMIN(UMAX(X, C2), C1)
4608 if (match(FalseVal, m_UMax(m_Specific(CmpLHS), m_APInt(C2))) &&
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004609 C1->ugt(*C2) && Pred == CmpInst::ICMP_UGT)
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004610 return {SPF_UMIN, SPNB_NA, false};
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004611 }
Artur Gainullinaf7ba8f2017-10-27 20:53:41 +00004612 return {SPF_UNKNOWN, SPNB_NA, false};
4613}
4614
Sanjay Patel78114302018-01-02 20:56:45 +00004615/// Recognize variations of:
4616/// a < c ? min(a,b) : min(b,c) ==> min(min(a,b),min(b,c))
4617static SelectPatternResult matchMinMaxOfMinMax(CmpInst::Predicate Pred,
4618 Value *CmpLHS, Value *CmpRHS,
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004619 Value *TVal, Value *FVal,
4620 unsigned Depth) {
Sanjay Patel78114302018-01-02 20:56:45 +00004621 // TODO: Allow FP min/max with nnan/nsz.
4622 assert(CmpInst::isIntPredicate(Pred) && "Expected integer comparison");
4623
4624 Value *A, *B;
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004625 SelectPatternResult L = matchSelectPattern(TVal, A, B, nullptr, Depth + 1);
Sanjay Patel78114302018-01-02 20:56:45 +00004626 if (!SelectPatternResult::isMinOrMax(L.Flavor))
4627 return {SPF_UNKNOWN, SPNB_NA, false};
4628
4629 Value *C, *D;
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004630 SelectPatternResult R = matchSelectPattern(FVal, C, D, nullptr, Depth + 1);
Sanjay Patel78114302018-01-02 20:56:45 +00004631 if (L.Flavor != R.Flavor)
4632 return {SPF_UNKNOWN, SPNB_NA, false};
4633
Sanjay Patele63d8dd2018-01-11 15:13:47 +00004634 // We have something like: x Pred y ? min(a, b) : min(c, d).
4635 // Try to match the compare to the min/max operations of the select operands.
4636 // First, make sure we have the right compare predicate.
Sanjay Patel78114302018-01-02 20:56:45 +00004637 switch (L.Flavor) {
4638 case SPF_SMIN:
4639 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE) {
4640 Pred = ICmpInst::getSwappedPredicate(Pred);
4641 std::swap(CmpLHS, CmpRHS);
4642 }
4643 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
4644 break;
4645 return {SPF_UNKNOWN, SPNB_NA, false};
4646 case SPF_SMAX:
4647 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) {
4648 Pred = ICmpInst::getSwappedPredicate(Pred);
4649 std::swap(CmpLHS, CmpRHS);
4650 }
4651 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
4652 break;
4653 return {SPF_UNKNOWN, SPNB_NA, false};
4654 case SPF_UMIN:
4655 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE) {
4656 Pred = ICmpInst::getSwappedPredicate(Pred);
4657 std::swap(CmpLHS, CmpRHS);
4658 }
4659 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE)
4660 break;
4661 return {SPF_UNKNOWN, SPNB_NA, false};
4662 case SPF_UMAX:
4663 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
4664 Pred = ICmpInst::getSwappedPredicate(Pred);
4665 std::swap(CmpLHS, CmpRHS);
4666 }
4667 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
4668 break;
4669 return {SPF_UNKNOWN, SPNB_NA, false};
4670 default:
Sanjay Patel7dfe96a2018-01-08 18:31:13 +00004671 return {SPF_UNKNOWN, SPNB_NA, false};
Sanjay Patel78114302018-01-02 20:56:45 +00004672 }
4673
Sanjay Patele63d8dd2018-01-11 15:13:47 +00004674 // If there is a common operand in the already matched min/max and the other
4675 // min/max operands match the compare operands (either directly or inverted),
4676 // then this is min/max of the same flavor.
4677
Sanjay Patel78114302018-01-02 20:56:45 +00004678 // a pred c ? m(a, b) : m(c, b) --> m(m(a, b), m(c, b))
Sanjay Patele63d8dd2018-01-11 15:13:47 +00004679 // ~c pred ~a ? m(a, b) : m(c, b) --> m(m(a, b), m(c, b))
4680 if (D == B) {
4681 if ((CmpLHS == A && CmpRHS == C) || (match(C, m_Not(m_Specific(CmpLHS))) &&
4682 match(A, m_Not(m_Specific(CmpRHS)))))
4683 return {L.Flavor, SPNB_NA, false};
4684 }
Sanjay Patel78114302018-01-02 20:56:45 +00004685 // a pred d ? m(a, b) : m(b, d) --> m(m(a, b), m(b, d))
Sanjay Patele63d8dd2018-01-11 15:13:47 +00004686 // ~d pred ~a ? m(a, b) : m(b, d) --> m(m(a, b), m(b, d))
4687 if (C == B) {
4688 if ((CmpLHS == A && CmpRHS == D) || (match(D, m_Not(m_Specific(CmpLHS))) &&
4689 match(A, m_Not(m_Specific(CmpRHS)))))
4690 return {L.Flavor, SPNB_NA, false};
4691 }
Sanjay Patel78114302018-01-02 20:56:45 +00004692 // b pred c ? m(a, b) : m(c, a) --> m(m(a, b), m(c, a))
Sanjay Patele63d8dd2018-01-11 15:13:47 +00004693 // ~c pred ~b ? m(a, b) : m(c, a) --> m(m(a, b), m(c, a))
4694 if (D == A) {
4695 if ((CmpLHS == B && CmpRHS == C) || (match(C, m_Not(m_Specific(CmpLHS))) &&
4696 match(B, m_Not(m_Specific(CmpRHS)))))
4697 return {L.Flavor, SPNB_NA, false};
4698 }
Sanjay Patel78114302018-01-02 20:56:45 +00004699 // b pred d ? m(a, b) : m(a, d) --> m(m(a, b), m(a, d))
Sanjay Patele63d8dd2018-01-11 15:13:47 +00004700 // ~d pred ~b ? m(a, b) : m(a, d) --> m(m(a, b), m(a, d))
4701 if (C == A) {
4702 if ((CmpLHS == B && CmpRHS == D) || (match(D, m_Not(m_Specific(CmpLHS))) &&
4703 match(B, m_Not(m_Specific(CmpRHS)))))
4704 return {L.Flavor, SPNB_NA, false};
4705 }
Sanjay Patel78114302018-01-02 20:56:45 +00004706
4707 return {SPF_UNKNOWN, SPNB_NA, false};
4708}
4709
Artur Gainullinaf7ba8f2017-10-27 20:53:41 +00004710/// Match non-obvious integer minimum and maximum sequences.
4711static SelectPatternResult matchMinMax(CmpInst::Predicate Pred,
4712 Value *CmpLHS, Value *CmpRHS,
4713 Value *TrueVal, Value *FalseVal,
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004714 Value *&LHS, Value *&RHS,
4715 unsigned Depth) {
Artur Gainullinaf7ba8f2017-10-27 20:53:41 +00004716 // Assume success. If there's no match, callers should not use these anyway.
4717 LHS = TrueVal;
4718 RHS = FalseVal;
4719
4720 SelectPatternResult SPR = matchClamp(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal);
4721 if (SPR.Flavor != SelectPatternFlavor::SPF_UNKNOWN)
4722 return SPR;
Sanjay Patel0c1c70a2017-01-20 22:18:47 +00004723
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004724 SPR = matchMinMaxOfMinMax(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, Depth);
Sanjay Patel78114302018-01-02 20:56:45 +00004725 if (SPR.Flavor != SelectPatternFlavor::SPF_UNKNOWN)
4726 return SPR;
Fangrui Songf78650a2018-07-30 19:41:25 +00004727
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004728 if (Pred != CmpInst::ICMP_SGT && Pred != CmpInst::ICMP_SLT)
Sanjay Patel819f0962016-11-13 19:30:19 +00004729 return {SPF_UNKNOWN, SPNB_NA, false};
4730
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00004731 // Z = X -nsw Y
4732 // (X >s Y) ? 0 : Z ==> (Z >s 0) ? 0 : Z ==> SMIN(Z, 0)
4733 // (X <s Y) ? 0 : Z ==> (Z <s 0) ? 0 : Z ==> SMAX(Z, 0)
4734 if (match(TrueVal, m_Zero()) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004735 match(FalseVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS))))
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004736 return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00004737
4738 // Z = X -nsw Y
4739 // (X >s Y) ? Z : 0 ==> (Z >s 0) ? Z : 0 ==> SMAX(Z, 0)
4740 // (X <s Y) ? Z : 0 ==> (Z <s 0) ? Z : 0 ==> SMIN(Z, 0)
4741 if (match(FalseVal, m_Zero()) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004742 match(TrueVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS))))
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004743 return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00004744
Artur Gainullinaf7ba8f2017-10-27 20:53:41 +00004745 const APInt *C1;
Sanjay Patel819f0962016-11-13 19:30:19 +00004746 if (!match(CmpRHS, m_APInt(C1)))
4747 return {SPF_UNKNOWN, SPNB_NA, false};
4748
4749 // An unsigned min/max can be written with a signed compare.
4750 const APInt *C2;
4751 if ((CmpLHS == TrueVal && match(FalseVal, m_APInt(C2))) ||
4752 (CmpLHS == FalseVal && match(TrueVal, m_APInt(C2)))) {
4753 // Is the sign bit set?
4754 // (X <s 0) ? X : MAXVAL ==> (X >u MAXVAL) ? X : MAXVAL ==> UMAX
4755 // (X <s 0) ? MAXVAL : X ==> (X >u MAXVAL) ? MAXVAL : X ==> UMIN
Craig Topper81d772c2017-11-08 19:38:45 +00004756 if (Pred == CmpInst::ICMP_SLT && C1->isNullValue() &&
4757 C2->isMaxSignedValue())
Sanjay Patel819f0962016-11-13 19:30:19 +00004758 return {CmpLHS == TrueVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004759
4760 // Is the sign bit clear?
4761 // (X >s -1) ? MINVAL : X ==> (X <u MINVAL) ? MINVAL : X ==> UMAX
4762 // (X >s -1) ? X : MINVAL ==> (X <u MINVAL) ? X : MINVAL ==> UMIN
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004763 if (Pred == CmpInst::ICMP_SGT && C1->isAllOnesValue() &&
4764 C2->isMinSignedValue())
Sanjay Patel819f0962016-11-13 19:30:19 +00004765 return {CmpLHS == FalseVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004766 }
4767
4768 // Look through 'not' ops to find disguised signed min/max.
4769 // (X >s C) ? ~X : ~C ==> (~X <s ~C) ? ~X : ~C ==> SMIN(~X, ~C)
4770 // (X <s C) ? ~X : ~C ==> (~X >s ~C) ? ~X : ~C ==> SMAX(~X, ~C)
4771 if (match(TrueVal, m_Not(m_Specific(CmpLHS))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004772 match(FalseVal, m_APInt(C2)) && ~(*C1) == *C2)
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004773 return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004774
4775 // (X >s C) ? ~C : ~X ==> (~X <s ~C) ? ~C : ~X ==> SMAX(~C, ~X)
4776 // (X <s C) ? ~C : ~X ==> (~X >s ~C) ? ~C : ~X ==> SMIN(~C, ~X)
4777 if (match(FalseVal, m_Not(m_Specific(CmpLHS))) &&
Sanjay Patel24c6f882017-01-21 17:51:25 +00004778 match(TrueVal, m_APInt(C2)) && ~(*C1) == *C2)
Nikolai Bozhenov8dcab542017-10-19 15:36:18 +00004779 return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
Sanjay Patel819f0962016-11-13 19:30:19 +00004780
4781 return {SPF_UNKNOWN, SPNB_NA, false};
4782}
4783
Chen Zheng69bb0642018-07-21 12:27:54 +00004784bool llvm::isKnownNegation(const Value *X, const Value *Y, bool NeedNSW) {
Chen Zhengfdf13ef2018-07-12 03:06:04 +00004785 assert(X && Y && "Invalid operand");
4786
Chen Zheng69bb0642018-07-21 12:27:54 +00004787 // X = sub (0, Y) || X = sub nsw (0, Y)
4788 if ((!NeedNSW && match(X, m_Sub(m_ZeroInt(), m_Specific(Y)))) ||
4789 (NeedNSW && match(X, m_NSWSub(m_ZeroInt(), m_Specific(Y)))))
Chen Zhengfdf13ef2018-07-12 03:06:04 +00004790 return true;
4791
Chen Zheng69bb0642018-07-21 12:27:54 +00004792 // Y = sub (0, X) || Y = sub nsw (0, X)
4793 if ((!NeedNSW && match(Y, m_Sub(m_ZeroInt(), m_Specific(X)))) ||
4794 (NeedNSW && match(Y, m_NSWSub(m_ZeroInt(), m_Specific(X)))))
Chen Zhengfdf13ef2018-07-12 03:06:04 +00004795 return true;
4796
Chen Zheng69bb0642018-07-21 12:27:54 +00004797 // X = sub (A, B), Y = sub (B, A) || X = sub nsw (A, B), Y = sub nsw (B, A)
Chen Zhengfdf13ef2018-07-12 03:06:04 +00004798 Value *A, *B;
Chen Zheng69bb0642018-07-21 12:27:54 +00004799 return (!NeedNSW && (match(X, m_Sub(m_Value(A), m_Value(B))) &&
4800 match(Y, m_Sub(m_Specific(B), m_Specific(A))))) ||
4801 (NeedNSW && (match(X, m_NSWSub(m_Value(A), m_Value(B))) &&
4802 match(Y, m_NSWSub(m_Specific(B), m_Specific(A)))));
Chen Zhengfdf13ef2018-07-12 03:06:04 +00004803}
4804
James Molloy134bec22015-08-11 09:12:57 +00004805static SelectPatternResult matchSelectPattern(CmpInst::Predicate Pred,
4806 FastMathFlags FMF,
James Molloy270ef8c2015-05-15 16:04:50 +00004807 Value *CmpLHS, Value *CmpRHS,
4808 Value *TrueVal, Value *FalseVal,
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004809 Value *&LHS, Value *&RHS,
4810 unsigned Depth) {
Sanjay Patele7c94ef2018-11-04 14:28:48 +00004811 if (CmpInst::isFPPredicate(Pred)) {
4812 // IEEE-754 ignores the sign of 0.0 in comparisons. So if the select has one
4813 // 0.0 operand, set the compare's 0.0 operands to that same value for the
4814 // purpose of identifying min/max. Disregard vector constants with undefined
4815 // elements because those can not be back-propagated for analysis.
4816 Value *OutputZeroVal = nullptr;
4817 if (match(TrueVal, m_AnyZeroFP()) && !match(FalseVal, m_AnyZeroFP()) &&
4818 !cast<Constant>(TrueVal)->containsUndefElement())
4819 OutputZeroVal = TrueVal;
4820 else if (match(FalseVal, m_AnyZeroFP()) && !match(TrueVal, m_AnyZeroFP()) &&
4821 !cast<Constant>(FalseVal)->containsUndefElement())
4822 OutputZeroVal = FalseVal;
4823
4824 if (OutputZeroVal) {
4825 if (match(CmpLHS, m_AnyZeroFP()))
4826 CmpLHS = OutputZeroVal;
4827 if (match(CmpRHS, m_AnyZeroFP()))
4828 CmpRHS = OutputZeroVal;
4829 }
4830 }
4831
James Molloy71b91c22015-05-11 14:42:20 +00004832 LHS = CmpLHS;
4833 RHS = CmpRHS;
4834
Sanjay Patel9a399792017-12-26 15:09:19 +00004835 // Signed zero may return inconsistent results between implementations.
4836 // (0.0 <= -0.0) ? 0.0 : -0.0 // Returns 0.0
4837 // minNum(0.0, -0.0) // May return -0.0 or 0.0 (IEEE 754-2008 5.3.1)
4838 // Therefore, we behave conservatively and only proceed if at least one of the
4839 // operands is known to not be zero or if we don't care about signed zero.
James Molloy134bec22015-08-11 09:12:57 +00004840 switch (Pred) {
4841 default: break;
Sanjay Patel9a399792017-12-26 15:09:19 +00004842 // FIXME: Include OGT/OLT/UGT/ULT.
James Molloy134bec22015-08-11 09:12:57 +00004843 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLE:
4844 case CmpInst::FCMP_UGE: case CmpInst::FCMP_ULE:
4845 if (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
4846 !isKnownNonZero(CmpRHS))
4847 return {SPF_UNKNOWN, SPNB_NA, false};
4848 }
4849
4850 SelectPatternNaNBehavior NaNBehavior = SPNB_NA;
4851 bool Ordered = false;
4852
4853 // When given one NaN and one non-NaN input:
4854 // - maxnum/minnum (C99 fmaxf()/fminf()) return the non-NaN input.
4855 // - A simple C99 (a < b ? a : b) construction will return 'b' (as the
4856 // ordered comparison fails), which could be NaN or non-NaN.
4857 // so here we discover exactly what NaN behavior is required/accepted.
4858 if (CmpInst::isFPPredicate(Pred)) {
4859 bool LHSSafe = isKnownNonNaN(CmpLHS, FMF);
4860 bool RHSSafe = isKnownNonNaN(CmpRHS, FMF);
4861
4862 if (LHSSafe && RHSSafe) {
4863 // Both operands are known non-NaN.
4864 NaNBehavior = SPNB_RETURNS_ANY;
4865 } else if (CmpInst::isOrdered(Pred)) {
4866 // An ordered comparison will return false when given a NaN, so it
4867 // returns the RHS.
4868 Ordered = true;
4869 if (LHSSafe)
James Molloy8990b062015-08-12 15:11:43 +00004870 // LHS is non-NaN, so if RHS is NaN then NaN will be returned.
James Molloy134bec22015-08-11 09:12:57 +00004871 NaNBehavior = SPNB_RETURNS_NAN;
4872 else if (RHSSafe)
4873 NaNBehavior = SPNB_RETURNS_OTHER;
4874 else
4875 // Completely unsafe.
4876 return {SPF_UNKNOWN, SPNB_NA, false};
4877 } else {
4878 Ordered = false;
4879 // An unordered comparison will return true when given a NaN, so it
4880 // returns the LHS.
4881 if (LHSSafe)
James Molloy8990b062015-08-12 15:11:43 +00004882 // LHS is non-NaN, so if RHS is NaN then non-NaN will be returned.
James Molloy134bec22015-08-11 09:12:57 +00004883 NaNBehavior = SPNB_RETURNS_OTHER;
4884 else if (RHSSafe)
4885 NaNBehavior = SPNB_RETURNS_NAN;
4886 else
4887 // Completely unsafe.
4888 return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004889 }
4890 }
4891
James Molloy71b91c22015-05-11 14:42:20 +00004892 if (TrueVal == CmpRHS && FalseVal == CmpLHS) {
James Molloy134bec22015-08-11 09:12:57 +00004893 std::swap(CmpLHS, CmpRHS);
4894 Pred = CmpInst::getSwappedPredicate(Pred);
4895 if (NaNBehavior == SPNB_RETURNS_NAN)
4896 NaNBehavior = SPNB_RETURNS_OTHER;
4897 else if (NaNBehavior == SPNB_RETURNS_OTHER)
4898 NaNBehavior = SPNB_RETURNS_NAN;
4899 Ordered = !Ordered;
4900 }
4901
4902 // ([if]cmp X, Y) ? X : Y
4903 if (TrueVal == CmpLHS && FalseVal == CmpRHS) {
James Molloy71b91c22015-05-11 14:42:20 +00004904 switch (Pred) {
James Molloy134bec22015-08-11 09:12:57 +00004905 default: return {SPF_UNKNOWN, SPNB_NA, false}; // Equality.
James Molloy71b91c22015-05-11 14:42:20 +00004906 case ICmpInst::ICMP_UGT:
James Molloy134bec22015-08-11 09:12:57 +00004907 case ICmpInst::ICMP_UGE: return {SPF_UMAX, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004908 case ICmpInst::ICMP_SGT:
James Molloy134bec22015-08-11 09:12:57 +00004909 case ICmpInst::ICMP_SGE: return {SPF_SMAX, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004910 case ICmpInst::ICMP_ULT:
James Molloy134bec22015-08-11 09:12:57 +00004911 case ICmpInst::ICMP_ULE: return {SPF_UMIN, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004912 case ICmpInst::ICMP_SLT:
James Molloy134bec22015-08-11 09:12:57 +00004913 case ICmpInst::ICMP_SLE: return {SPF_SMIN, SPNB_NA, false};
4914 case FCmpInst::FCMP_UGT:
4915 case FCmpInst::FCMP_UGE:
4916 case FCmpInst::FCMP_OGT:
4917 case FCmpInst::FCMP_OGE: return {SPF_FMAXNUM, NaNBehavior, Ordered};
4918 case FCmpInst::FCMP_ULT:
4919 case FCmpInst::FCMP_ULE:
4920 case FCmpInst::FCMP_OLT:
4921 case FCmpInst::FCMP_OLE: return {SPF_FMINNUM, NaNBehavior, Ordered};
James Molloy71b91c22015-05-11 14:42:20 +00004922 }
4923 }
Fangrui Songf78650a2018-07-30 19:41:25 +00004924
Chen Zhengccc84222018-07-16 02:23:00 +00004925 if (isKnownNegation(TrueVal, FalseVal)) {
4926 // Sign-extending LHS does not change its sign, so TrueVal/FalseVal can
4927 // match against either LHS or sext(LHS).
4928 auto MaybeSExtCmpLHS =
4929 m_CombineOr(m_Specific(CmpLHS), m_SExt(m_Specific(CmpLHS)));
4930 auto ZeroOrAllOnes = m_CombineOr(m_ZeroInt(), m_AllOnes());
4931 auto ZeroOrOne = m_CombineOr(m_ZeroInt(), m_One());
4932 if (match(TrueVal, MaybeSExtCmpLHS)) {
4933 // Set the return values. If the compare uses the negated value (-X >s 0),
4934 // swap the return values because the negated value is always 'RHS'.
Sanjay Patel284ba0c2018-07-02 14:43:40 +00004935 LHS = TrueVal;
4936 RHS = FalseVal;
Chen Zhengccc84222018-07-16 02:23:00 +00004937 if (match(CmpLHS, m_Neg(m_Specific(FalseVal))))
4938 std::swap(LHS, RHS);
4939
4940 // (X >s 0) ? X : -X or (X >s -1) ? X : -X --> ABS(X)
4941 // (-X >s 0) ? -X : X or (-X >s -1) ? -X : X --> ABS(X)
4942 if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, ZeroOrAllOnes))
4943 return {SPF_ABS, SPNB_NA, false};
4944
4945 // (X <s 0) ? X : -X or (X <s 1) ? X : -X --> NABS(X)
4946 // (-X <s 0) ? -X : X or (-X <s 1) ? -X : X --> NABS(X)
4947 if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, ZeroOrOne))
4948 return {SPF_NABS, SPNB_NA, false};
4949 }
4950 else if (match(FalseVal, MaybeSExtCmpLHS)) {
4951 // Set the return values. If the compare uses the negated value (-X >s 0),
4952 // swap the return values because the negated value is always 'RHS'.
Sanjay Patel284ba0c2018-07-02 14:43:40 +00004953 LHS = FalseVal;
4954 RHS = TrueVal;
Chen Zhengccc84222018-07-16 02:23:00 +00004955 if (match(CmpLHS, m_Neg(m_Specific(TrueVal))))
4956 std::swap(LHS, RHS);
4957
4958 // (X >s 0) ? -X : X or (X >s -1) ? -X : X --> NABS(X)
4959 // (-X >s 0) ? X : -X or (-X >s -1) ? X : -X --> NABS(X)
4960 if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, ZeroOrAllOnes))
4961 return {SPF_NABS, SPNB_NA, false};
4962
4963 // (X <s 0) ? -X : X or (X <s 1) ? -X : X --> ABS(X)
4964 // (-X <s 0) ? X : -X or (-X <s 1) ? X : -X --> ABS(X)
4965 if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, ZeroOrOne))
4966 return {SPF_ABS, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004967 }
James Molloy71b91c22015-05-11 14:42:20 +00004968 }
4969
Nikolai Bozhenov1545eb32017-08-04 12:22:17 +00004970 if (CmpInst::isIntPredicate(Pred))
Sanjay Patel1d91ec32018-01-24 15:20:37 +00004971 return matchMinMax(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, LHS, RHS, Depth);
Nikolai Bozhenov1545eb32017-08-04 12:22:17 +00004972
4973 // According to (IEEE 754-2008 5.3.1), minNum(0.0, -0.0) and similar
4974 // may return either -0.0 or 0.0, so fcmp/select pair has stricter
4975 // semantics than minNum. Be conservative in such case.
4976 if (NaNBehavior != SPNB_RETURNS_ANY ||
4977 (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
4978 !isKnownNonZero(CmpRHS)))
4979 return {SPF_UNKNOWN, SPNB_NA, false};
4980
4981 return matchFastFloatClamp(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, LHS, RHS);
James Molloy71b91c22015-05-11 14:42:20 +00004982}
James Molloy270ef8c2015-05-15 16:04:50 +00004983
Nikolai Bozhenov74c047e2017-10-18 09:28:09 +00004984/// Helps to match a select pattern in case of a type mismatch.
4985///
4986/// The function processes the case when type of true and false values of a
4987/// select instruction differs from type of the cmp instruction operands because
Vedant Kumar1a8456d2018-03-02 18:57:02 +00004988/// of a cast instruction. The function checks if it is legal to move the cast
Nikolai Bozhenov74c047e2017-10-18 09:28:09 +00004989/// operation after "select". If yes, it returns the new second value of
4990/// "select" (with the assumption that cast is moved):
4991/// 1. As operand of cast instruction when both values of "select" are same cast
4992/// instructions.
4993/// 2. As restored constant (by applying reverse cast operation) when the first
4994/// value of the "select" is a cast operation and the second value is a
4995/// constant.
4996/// NOTE: We return only the new second value because the first value could be
4997/// accessed as operand of cast instruction.
James Molloy569cea62015-09-02 17:25:25 +00004998static Value *lookThroughCast(CmpInst *CmpI, Value *V1, Value *V2,
4999 Instruction::CastOps *CastOp) {
Sanjay Patel14a4b812017-01-29 16:34:57 +00005000 auto *Cast1 = dyn_cast<CastInst>(V1);
5001 if (!Cast1)
James Molloy270ef8c2015-05-15 16:04:50 +00005002 return nullptr;
James Molloy270ef8c2015-05-15 16:04:50 +00005003
Sanjay Patel14a4b812017-01-29 16:34:57 +00005004 *CastOp = Cast1->getOpcode();
5005 Type *SrcTy = Cast1->getSrcTy();
5006 if (auto *Cast2 = dyn_cast<CastInst>(V2)) {
5007 // If V1 and V2 are both the same cast from the same type, look through V1.
5008 if (*CastOp == Cast2->getOpcode() && SrcTy == Cast2->getSrcTy())
5009 return Cast2->getOperand(0);
James Molloy569cea62015-09-02 17:25:25 +00005010 return nullptr;
5011 }
5012
Sanjay Patel14a4b812017-01-29 16:34:57 +00005013 auto *C = dyn_cast<Constant>(V2);
5014 if (!C)
5015 return nullptr;
5016
David Majnemerd2a074b2016-04-29 18:40:34 +00005017 Constant *CastedTo = nullptr;
Sanjay Patel14a4b812017-01-29 16:34:57 +00005018 switch (*CastOp) {
5019 case Instruction::ZExt:
5020 if (CmpI->isUnsigned())
5021 CastedTo = ConstantExpr::getTrunc(C, SrcTy);
5022 break;
5023 case Instruction::SExt:
5024 if (CmpI->isSigned())
5025 CastedTo = ConstantExpr::getTrunc(C, SrcTy, true);
5026 break;
5027 case Instruction::Trunc:
Nikolai Bozhenov74c047e2017-10-18 09:28:09 +00005028 Constant *CmpConst;
Nikolai Bozhenov9723f122017-10-18 14:24:50 +00005029 if (match(CmpI->getOperand(1), m_Constant(CmpConst)) &&
5030 CmpConst->getType() == SrcTy) {
Nikolai Bozhenov74c047e2017-10-18 09:28:09 +00005031 // Here we have the following case:
5032 //
5033 // %cond = cmp iN %x, CmpConst
5034 // %tr = trunc iN %x to iK
5035 // %narrowsel = select i1 %cond, iK %t, iK C
5036 //
5037 // We can always move trunc after select operation:
5038 //
5039 // %cond = cmp iN %x, CmpConst
5040 // %widesel = select i1 %cond, iN %x, iN CmpConst
5041 // %tr = trunc iN %widesel to iK
5042 //
5043 // Note that C could be extended in any way because we don't care about
5044 // upper bits after truncation. It can't be abs pattern, because it would
5045 // look like:
5046 //
5047 // select i1 %cond, x, -x.
5048 //
5049 // So only min/max pattern could be matched. Such match requires widened C
5050 // == CmpConst. That is why set widened C = CmpConst, condition trunc
5051 // CmpConst == C is checked below.
5052 CastedTo = CmpConst;
5053 } else {
5054 CastedTo = ConstantExpr::getIntegerCast(C, SrcTy, CmpI->isSigned());
5055 }
Sanjay Patel14a4b812017-01-29 16:34:57 +00005056 break;
5057 case Instruction::FPTrunc:
5058 CastedTo = ConstantExpr::getFPExtend(C, SrcTy, true);
5059 break;
5060 case Instruction::FPExt:
5061 CastedTo = ConstantExpr::getFPTrunc(C, SrcTy, true);
5062 break;
5063 case Instruction::FPToUI:
5064 CastedTo = ConstantExpr::getUIToFP(C, SrcTy, true);
5065 break;
5066 case Instruction::FPToSI:
5067 CastedTo = ConstantExpr::getSIToFP(C, SrcTy, true);
5068 break;
5069 case Instruction::UIToFP:
5070 CastedTo = ConstantExpr::getFPToUI(C, SrcTy, true);
5071 break;
5072 case Instruction::SIToFP:
5073 CastedTo = ConstantExpr::getFPToSI(C, SrcTy, true);
5074 break;
5075 default:
5076 break;
5077 }
David Majnemerd2a074b2016-04-29 18:40:34 +00005078
5079 if (!CastedTo)
5080 return nullptr;
5081
David Majnemerd2a074b2016-04-29 18:40:34 +00005082 // Make sure the cast doesn't lose any information.
Sanjay Patel14a4b812017-01-29 16:34:57 +00005083 Constant *CastedBack =
5084 ConstantExpr::getCast(*CastOp, CastedTo, C->getType(), true);
David Majnemerd2a074b2016-04-29 18:40:34 +00005085 if (CastedBack != C)
5086 return nullptr;
5087
5088 return CastedTo;
James Molloy270ef8c2015-05-15 16:04:50 +00005089}
5090
Sanjay Patele8dc0902016-05-23 17:57:54 +00005091SelectPatternResult llvm::matchSelectPattern(Value *V, Value *&LHS, Value *&RHS,
Sanjay Patel1d91ec32018-01-24 15:20:37 +00005092 Instruction::CastOps *CastOp,
5093 unsigned Depth) {
5094 if (Depth >= MaxDepth)
5095 return {SPF_UNKNOWN, SPNB_NA, false};
5096
James Molloy270ef8c2015-05-15 16:04:50 +00005097 SelectInst *SI = dyn_cast<SelectInst>(V);
James Molloy134bec22015-08-11 09:12:57 +00005098 if (!SI) return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00005099
James Molloy134bec22015-08-11 09:12:57 +00005100 CmpInst *CmpI = dyn_cast<CmpInst>(SI->getCondition());
5101 if (!CmpI) return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00005102
James Molloy134bec22015-08-11 09:12:57 +00005103 CmpInst::Predicate Pred = CmpI->getPredicate();
James Molloy270ef8c2015-05-15 16:04:50 +00005104 Value *CmpLHS = CmpI->getOperand(0);
5105 Value *CmpRHS = CmpI->getOperand(1);
5106 Value *TrueVal = SI->getTrueValue();
5107 Value *FalseVal = SI->getFalseValue();
James Molloy134bec22015-08-11 09:12:57 +00005108 FastMathFlags FMF;
5109 if (isa<FPMathOperator>(CmpI))
5110 FMF = CmpI->getFastMathFlags();
James Molloy270ef8c2015-05-15 16:04:50 +00005111
5112 // Bail out early.
5113 if (CmpI->isEquality())
James Molloy134bec22015-08-11 09:12:57 +00005114 return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00005115
5116 // Deal with type mismatches.
5117 if (CastOp && CmpLHS->getType() != TrueVal->getType()) {
Sanjay Patel9a399792017-12-26 15:09:19 +00005118 if (Value *C = lookThroughCast(CmpI, TrueVal, FalseVal, CastOp)) {
5119 // If this is a potential fmin/fmax with a cast to integer, then ignore
5120 // -0.0 because there is no corresponding integer value.
5121 if (*CastOp == Instruction::FPToSI || *CastOp == Instruction::FPToUI)
5122 FMF.setNoSignedZeros();
James Molloy134bec22015-08-11 09:12:57 +00005123 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
James Molloy270ef8c2015-05-15 16:04:50 +00005124 cast<CastInst>(TrueVal)->getOperand(0), C,
Sanjay Patel1d91ec32018-01-24 15:20:37 +00005125 LHS, RHS, Depth);
Sanjay Patel9a399792017-12-26 15:09:19 +00005126 }
5127 if (Value *C = lookThroughCast(CmpI, FalseVal, TrueVal, CastOp)) {
5128 // If this is a potential fmin/fmax with a cast to integer, then ignore
5129 // -0.0 because there is no corresponding integer value.
5130 if (*CastOp == Instruction::FPToSI || *CastOp == Instruction::FPToUI)
5131 FMF.setNoSignedZeros();
James Molloy134bec22015-08-11 09:12:57 +00005132 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
James Molloy270ef8c2015-05-15 16:04:50 +00005133 C, cast<CastInst>(FalseVal)->getOperand(0),
Sanjay Patel1d91ec32018-01-24 15:20:37 +00005134 LHS, RHS, Depth);
Sanjay Patel9a399792017-12-26 15:09:19 +00005135 }
James Molloy270ef8c2015-05-15 16:04:50 +00005136 }
James Molloy134bec22015-08-11 09:12:57 +00005137 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS, TrueVal, FalseVal,
Sanjay Patel1d91ec32018-01-24 15:20:37 +00005138 LHS, RHS, Depth);
James Molloy270ef8c2015-05-15 16:04:50 +00005139}
Sanjoy Dasa7e13782015-10-24 05:37:35 +00005140
Sanjay Patel7ed0bc22018-03-06 16:57:55 +00005141CmpInst::Predicate llvm::getMinMaxPred(SelectPatternFlavor SPF, bool Ordered) {
5142 if (SPF == SPF_SMIN) return ICmpInst::ICMP_SLT;
5143 if (SPF == SPF_UMIN) return ICmpInst::ICMP_ULT;
5144 if (SPF == SPF_SMAX) return ICmpInst::ICMP_SGT;
5145 if (SPF == SPF_UMAX) return ICmpInst::ICMP_UGT;
5146 if (SPF == SPF_FMINNUM)
5147 return Ordered ? FCmpInst::FCMP_OLT : FCmpInst::FCMP_ULT;
5148 if (SPF == SPF_FMAXNUM)
5149 return Ordered ? FCmpInst::FCMP_OGT : FCmpInst::FCMP_UGT;
5150 llvm_unreachable("unhandled!");
5151}
5152
5153SelectPatternFlavor llvm::getInverseMinMaxFlavor(SelectPatternFlavor SPF) {
5154 if (SPF == SPF_SMIN) return SPF_SMAX;
5155 if (SPF == SPF_UMIN) return SPF_UMAX;
5156 if (SPF == SPF_SMAX) return SPF_SMIN;
5157 if (SPF == SPF_UMAX) return SPF_UMIN;
5158 llvm_unreachable("unhandled!");
5159}
5160
5161CmpInst::Predicate llvm::getInverseMinMaxPred(SelectPatternFlavor SPF) {
5162 return getMinMaxPred(getInverseMinMaxFlavor(SPF));
5163}
5164
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005165/// Return true if "icmp Pred LHS RHS" is always true.
Chad Rosiere42b44b2017-07-28 14:39:06 +00005166static bool isTruePredicate(CmpInst::Predicate Pred, const Value *LHS,
5167 const Value *RHS, const DataLayout &DL,
5168 unsigned Depth) {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00005169 assert(!LHS->getType()->isVectorTy() && "TODO: extend to handle vectors!");
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005170 if (ICmpInst::isTrueWhenEqual(Pred) && LHS == RHS)
5171 return true;
5172
5173 switch (Pred) {
5174 default:
5175 return false;
5176
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005177 case CmpInst::ICMP_SLE: {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00005178 const APInt *C;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005179
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005180 // LHS s<= LHS +_{nsw} C if C >= 0
Sanjoy Dasdc26df42015-11-11 00:16:41 +00005181 if (match(RHS, m_NSWAdd(m_Specific(LHS), m_APInt(C))))
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00005182 return !C->isNegative();
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005183 return false;
5184 }
5185
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005186 case CmpInst::ICMP_ULE: {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00005187 const APInt *C;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005188
Sanjoy Dasdc26df42015-11-11 00:16:41 +00005189 // LHS u<= LHS +_{nuw} C for any C
5190 if (match(RHS, m_NUWAdd(m_Specific(LHS), m_APInt(C))))
Sanjoy Dasc01b4d22015-11-06 19:01:03 +00005191 return true;
Sanjoy Das92568102015-11-10 23:56:20 +00005192
5193 // Match A to (X +_{nuw} CA) and B to (X +_{nuw} CB)
Pete Cooper35b00d52016-08-13 01:05:32 +00005194 auto MatchNUWAddsToSameValue = [&](const Value *A, const Value *B,
5195 const Value *&X,
Sanjoy Das92568102015-11-10 23:56:20 +00005196 const APInt *&CA, const APInt *&CB) {
5197 if (match(A, m_NUWAdd(m_Value(X), m_APInt(CA))) &&
5198 match(B, m_NUWAdd(m_Specific(X), m_APInt(CB))))
5199 return true;
5200
5201 // If X & C == 0 then (X | C) == X +_{nuw} C
5202 if (match(A, m_Or(m_Value(X), m_APInt(CA))) &&
5203 match(B, m_Or(m_Specific(X), m_APInt(CB)))) {
Craig Topperb45eabc2017-04-26 16:39:58 +00005204 KnownBits Known(CA->getBitWidth());
Chad Rosiere42b44b2017-07-28 14:39:06 +00005205 computeKnownBits(X, Known, DL, Depth + 1, /*AC*/ nullptr,
5206 /*CxtI*/ nullptr, /*DT*/ nullptr);
Craig Topperb45eabc2017-04-26 16:39:58 +00005207 if (CA->isSubsetOf(Known.Zero) && CB->isSubsetOf(Known.Zero))
Sanjoy Das92568102015-11-10 23:56:20 +00005208 return true;
5209 }
5210
5211 return false;
5212 };
5213
Pete Cooper35b00d52016-08-13 01:05:32 +00005214 const Value *X;
Sanjoy Das92568102015-11-10 23:56:20 +00005215 const APInt *CLHS, *CRHS;
Sanjoy Dasdc26df42015-11-11 00:16:41 +00005216 if (MatchNUWAddsToSameValue(LHS, RHS, X, CLHS, CRHS))
5217 return CLHS->ule(*CRHS);
Sanjoy Das92568102015-11-10 23:56:20 +00005218
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005219 return false;
5220 }
5221 }
5222}
5223
5224/// Return true if "icmp Pred BLHS BRHS" is true whenever "icmp Pred
Chad Rosier41dd31f2016-04-20 19:15:26 +00005225/// ALHS ARHS" is true. Otherwise, return None.
5226static Optional<bool>
Pete Cooper35b00d52016-08-13 01:05:32 +00005227isImpliedCondOperands(CmpInst::Predicate Pred, const Value *ALHS,
Chad Rosiere42b44b2017-07-28 14:39:06 +00005228 const Value *ARHS, const Value *BLHS, const Value *BRHS,
5229 const DataLayout &DL, unsigned Depth) {
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005230 switch (Pred) {
5231 default:
Chad Rosier41dd31f2016-04-20 19:15:26 +00005232 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005233
5234 case CmpInst::ICMP_SLT:
5235 case CmpInst::ICMP_SLE:
Chad Rosiere42b44b2017-07-28 14:39:06 +00005236 if (isTruePredicate(CmpInst::ICMP_SLE, BLHS, ALHS, DL, Depth) &&
5237 isTruePredicate(CmpInst::ICMP_SLE, ARHS, BRHS, DL, Depth))
Chad Rosier41dd31f2016-04-20 19:15:26 +00005238 return true;
5239 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005240
5241 case CmpInst::ICMP_ULT:
5242 case CmpInst::ICMP_ULE:
Chad Rosiere42b44b2017-07-28 14:39:06 +00005243 if (isTruePredicate(CmpInst::ICMP_ULE, BLHS, ALHS, DL, Depth) &&
5244 isTruePredicate(CmpInst::ICMP_ULE, ARHS, BRHS, DL, Depth))
Chad Rosier41dd31f2016-04-20 19:15:26 +00005245 return true;
5246 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00005247 }
5248}
5249
Chad Rosier226a7342016-05-05 17:41:19 +00005250/// Return true if the operands of the two compares match. IsSwappedOps is true
5251/// when the operands match, but are swapped.
Pete Cooper35b00d52016-08-13 01:05:32 +00005252static bool isMatchingOps(const Value *ALHS, const Value *ARHS,
5253 const Value *BLHS, const Value *BRHS,
Chad Rosier226a7342016-05-05 17:41:19 +00005254 bool &IsSwappedOps) {
5255
5256 bool IsMatchingOps = (ALHS == BLHS && ARHS == BRHS);
5257 IsSwappedOps = (ALHS == BRHS && ARHS == BLHS);
5258 return IsMatchingOps || IsSwappedOps;
5259}
5260
Sanjay Patel798c5982018-12-19 16:49:18 +00005261/// Return true if "icmp1 APred X, Y" implies "icmp2 BPred X, Y" is true.
5262/// Return false if "icmp1 APred X, Y" implies "icmp2 BPred X, Y" is false.
5263/// Otherwise, return None if we can't infer anything.
Chad Rosier41dd31f2016-04-20 19:15:26 +00005264static Optional<bool> isImpliedCondMatchingOperands(CmpInst::Predicate APred,
Chad Rosier41dd31f2016-04-20 19:15:26 +00005265 CmpInst::Predicate BPred,
Sanjay Patel798c5982018-12-19 16:49:18 +00005266 bool AreSwappedOps) {
5267 // Canonicalize the predicate as if the operands were not commuted.
5268 if (AreSwappedOps)
Chad Rosierb7dfbb42016-04-19 17:19:14 +00005269 BPred = ICmpInst::getSwappedPredicate(BPred);
Sanjay Patel798c5982018-12-19 16:49:18 +00005270
Chad Rosier99bc4802016-04-21 16:18:02 +00005271 if (CmpInst::isImpliedTrueByMatchingCmp(APred, BPred))
Chad Rosierb7dfbb42016-04-19 17:19:14 +00005272 return true;
Chad Rosier99bc4802016-04-21 16:18:02 +00005273 if (CmpInst::isImpliedFalseByMatchingCmp(APred, BPred))
Chad Rosier41dd31f2016-04-20 19:15:26 +00005274 return false;
Chad Rosierb7dfbb42016-04-19 17:19:14 +00005275
Chad Rosier41dd31f2016-04-20 19:15:26 +00005276 return None;
Chad Rosierb7dfbb42016-04-19 17:19:14 +00005277}
5278
Sanjay Patel798c5982018-12-19 16:49:18 +00005279/// Return true if "icmp APred X, C1" implies "icmp BPred X, C2" is true.
5280/// Return false if "icmp APred X, C1" implies "icmp BPred X, C2" is false.
5281/// Otherwise, return None if we can't infer anything.
Chad Rosier25cfb7d2016-05-05 15:39:18 +00005282static Optional<bool>
Sanjay Patel798c5982018-12-19 16:49:18 +00005283isImpliedCondMatchingImmOperands(CmpInst::Predicate APred,
Pete Cooper35b00d52016-08-13 01:05:32 +00005284 const ConstantInt *C1,
5285 CmpInst::Predicate BPred,
Sanjay Patel798c5982018-12-19 16:49:18 +00005286 const ConstantInt *C2) {
Chad Rosier25cfb7d2016-05-05 15:39:18 +00005287 ConstantRange DomCR =
5288 ConstantRange::makeExactICmpRegion(APred, C1->getValue());
5289 ConstantRange CR =
5290 ConstantRange::makeAllowedICmpRegion(BPred, C2->getValue());
5291 ConstantRange Intersection = DomCR.intersectWith(CR);
5292 ConstantRange Difference = DomCR.difference(CR);
5293 if (Intersection.isEmptySet())
5294 return false;
5295 if (Difference.isEmptySet())
5296 return true;
5297 return None;
5298}
5299
Chad Rosier2f498032017-07-28 18:47:43 +00005300/// Return true if LHS implies RHS is true. Return false if LHS implies RHS is
5301/// false. Otherwise, return None if we can't infer anything.
5302static Optional<bool> isImpliedCondICmps(const ICmpInst *LHS,
5303 const ICmpInst *RHS,
Chad Rosierdfd1de62017-08-01 20:18:54 +00005304 const DataLayout &DL, bool LHSIsTrue,
Chad Rosier2f498032017-07-28 18:47:43 +00005305 unsigned Depth) {
5306 Value *ALHS = LHS->getOperand(0);
5307 Value *ARHS = LHS->getOperand(1);
Chad Rosiera72a9ff2017-07-06 20:00:25 +00005308 // The rest of the logic assumes the LHS condition is true. If that's not the
5309 // case, invert the predicate to make it so.
Chad Rosier2f498032017-07-28 18:47:43 +00005310 ICmpInst::Predicate APred =
Chad Rosierdfd1de62017-08-01 20:18:54 +00005311 LHSIsTrue ? LHS->getPredicate() : LHS->getInversePredicate();
Chad Rosier2f498032017-07-28 18:47:43 +00005312
5313 Value *BLHS = RHS->getOperand(0);
5314 Value *BRHS = RHS->getOperand(1);
5315 ICmpInst::Predicate BPred = RHS->getPredicate();
Chad Rosiere2cbd132016-04-25 17:23:36 +00005316
Chad Rosier226a7342016-05-05 17:41:19 +00005317 // Can we infer anything when the two compares have matching operands?
Sanjay Patel798c5982018-12-19 16:49:18 +00005318 bool AreSwappedOps;
5319 if (isMatchingOps(ALHS, ARHS, BLHS, BRHS, AreSwappedOps)) {
Chad Rosier226a7342016-05-05 17:41:19 +00005320 if (Optional<bool> Implication = isImpliedCondMatchingOperands(
Sanjay Patel798c5982018-12-19 16:49:18 +00005321 APred, BPred, AreSwappedOps))
Chad Rosier25cfb7d2016-05-05 15:39:18 +00005322 return Implication;
Chad Rosier226a7342016-05-05 17:41:19 +00005323 // No amount of additional analysis will infer the second condition, so
5324 // early exit.
5325 return None;
5326 }
5327
5328 // Can we infer anything when the LHS operands match and the RHS operands are
5329 // constants (not necessarily matching)?
5330 if (ALHS == BLHS && isa<ConstantInt>(ARHS) && isa<ConstantInt>(BRHS)) {
5331 if (Optional<bool> Implication = isImpliedCondMatchingImmOperands(
Sanjay Patel798c5982018-12-19 16:49:18 +00005332 APred, cast<ConstantInt>(ARHS), BPred, cast<ConstantInt>(BRHS)))
Chad Rosier226a7342016-05-05 17:41:19 +00005333 return Implication;
5334 // No amount of additional analysis will infer the second condition, so
5335 // early exit.
5336 return None;
Chad Rosier25cfb7d2016-05-05 15:39:18 +00005337 }
5338
Chad Rosier41dd31f2016-04-20 19:15:26 +00005339 if (APred == BPred)
Chad Rosiere42b44b2017-07-28 14:39:06 +00005340 return isImpliedCondOperands(APred, ALHS, ARHS, BLHS, BRHS, DL, Depth);
Chad Rosier41dd31f2016-04-20 19:15:26 +00005341 return None;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00005342}
Chad Rosier2f498032017-07-28 18:47:43 +00005343
Chad Rosierf73a10d2017-08-01 19:22:36 +00005344/// Return true if LHS implies RHS is true. Return false if LHS implies RHS is
5345/// false. Otherwise, return None if we can't infer anything. We expect the
5346/// RHS to be an icmp and the LHS to be an 'and' or an 'or' instruction.
5347static Optional<bool> isImpliedCondAndOr(const BinaryOperator *LHS,
5348 const ICmpInst *RHS,
Chad Rosierdfd1de62017-08-01 20:18:54 +00005349 const DataLayout &DL, bool LHSIsTrue,
Chad Rosierf73a10d2017-08-01 19:22:36 +00005350 unsigned Depth) {
5351 // The LHS must be an 'or' or an 'and' instruction.
5352 assert((LHS->getOpcode() == Instruction::And ||
5353 LHS->getOpcode() == Instruction::Or) &&
5354 "Expected LHS to be 'and' or 'or'.");
5355
Davide Italiano1a943a92017-08-09 16:06:54 +00005356 assert(Depth <= MaxDepth && "Hit recursion limit");
Chad Rosierf73a10d2017-08-01 19:22:36 +00005357
5358 // If the result of an 'or' is false, then we know both legs of the 'or' are
5359 // false. Similarly, if the result of an 'and' is true, then we know both
5360 // legs of the 'and' are true.
5361 Value *ALHS, *ARHS;
Chad Rosierdfd1de62017-08-01 20:18:54 +00005362 if ((!LHSIsTrue && match(LHS, m_Or(m_Value(ALHS), m_Value(ARHS)))) ||
5363 (LHSIsTrue && match(LHS, m_And(m_Value(ALHS), m_Value(ARHS))))) {
Chad Rosierf73a10d2017-08-01 19:22:36 +00005364 // FIXME: Make this non-recursion.
5365 if (Optional<bool> Implication =
Chad Rosierdfd1de62017-08-01 20:18:54 +00005366 isImpliedCondition(ALHS, RHS, DL, LHSIsTrue, Depth + 1))
Chad Rosierf73a10d2017-08-01 19:22:36 +00005367 return Implication;
5368 if (Optional<bool> Implication =
Chad Rosierdfd1de62017-08-01 20:18:54 +00005369 isImpliedCondition(ARHS, RHS, DL, LHSIsTrue, Depth + 1))
Chad Rosierf73a10d2017-08-01 19:22:36 +00005370 return Implication;
5371 return None;
5372 }
5373 return None;
5374}
5375
Chad Rosier2f498032017-07-28 18:47:43 +00005376Optional<bool> llvm::isImpliedCondition(const Value *LHS, const Value *RHS,
Chad Rosierdfd1de62017-08-01 20:18:54 +00005377 const DataLayout &DL, bool LHSIsTrue,
Chad Rosier2f498032017-07-28 18:47:43 +00005378 unsigned Depth) {
Davide Italiano30e51942017-08-09 15:13:50 +00005379 // Bail out when we hit the limit.
5380 if (Depth == MaxDepth)
5381 return None;
5382
Chad Rosierf73a10d2017-08-01 19:22:36 +00005383 // A mismatch occurs when we compare a scalar cmp to a vector cmp, for
5384 // example.
Chad Rosier2f498032017-07-28 18:47:43 +00005385 if (LHS->getType() != RHS->getType())
5386 return None;
5387
5388 Type *OpTy = LHS->getType();
Chad Rosierf73a10d2017-08-01 19:22:36 +00005389 assert(OpTy->isIntOrIntVectorTy(1) && "Expected integer type only!");
Chad Rosier2f498032017-07-28 18:47:43 +00005390
5391 // LHS ==> RHS by definition
5392 if (LHS == RHS)
Chad Rosierdfd1de62017-08-01 20:18:54 +00005393 return LHSIsTrue;
Chad Rosier2f498032017-07-28 18:47:43 +00005394
Chad Rosierf73a10d2017-08-01 19:22:36 +00005395 // FIXME: Extending the code below to handle vectors.
Chad Rosier2f498032017-07-28 18:47:43 +00005396 if (OpTy->isVectorTy())
Chad Rosier2f498032017-07-28 18:47:43 +00005397 return None;
Chad Rosierf73a10d2017-08-01 19:22:36 +00005398
Chad Rosier2f498032017-07-28 18:47:43 +00005399 assert(OpTy->isIntegerTy(1) && "implied by above");
5400
Chad Rosier2f498032017-07-28 18:47:43 +00005401 // Both LHS and RHS are icmps.
Chad Rosierf73a10d2017-08-01 19:22:36 +00005402 const ICmpInst *LHSCmp = dyn_cast<ICmpInst>(LHS);
5403 const ICmpInst *RHSCmp = dyn_cast<ICmpInst>(RHS);
5404 if (LHSCmp && RHSCmp)
Chad Rosierdfd1de62017-08-01 20:18:54 +00005405 return isImpliedCondICmps(LHSCmp, RHSCmp, DL, LHSIsTrue, Depth);
Chad Rosier2f498032017-07-28 18:47:43 +00005406
Chad Rosierf73a10d2017-08-01 19:22:36 +00005407 // The LHS should be an 'or' or an 'and' instruction. We expect the RHS to be
5408 // an icmp. FIXME: Add support for and/or on the RHS.
5409 const BinaryOperator *LHSBO = dyn_cast<BinaryOperator>(LHS);
5410 if (LHSBO && RHSCmp) {
5411 if ((LHSBO->getOpcode() == Instruction::And ||
5412 LHSBO->getOpcode() == Instruction::Or))
Chad Rosierdfd1de62017-08-01 20:18:54 +00005413 return isImpliedCondAndOr(LHSBO, RHSCmp, DL, LHSIsTrue, Depth);
Chad Rosier2f498032017-07-28 18:47:43 +00005414 }
Chad Rosierf73a10d2017-08-01 19:22:36 +00005415 return None;
Chad Rosier2f498032017-07-28 18:47:43 +00005416}
Sanjay Patel7d82d372018-12-02 13:26:03 +00005417
5418Optional<bool> llvm::isImpliedByDomCondition(const Value *Cond,
5419 const Instruction *ContextI,
5420 const DataLayout &DL) {
5421 assert(Cond->getType()->isIntOrIntVectorTy(1) && "Condition must be bool");
5422 if (!ContextI || !ContextI->getParent())
5423 return None;
5424
5425 // TODO: This is a poor/cheap way to determine dominance. Should we use a
5426 // dominator tree (eg, from a SimplifyQuery) instead?
5427 const BasicBlock *ContextBB = ContextI->getParent();
5428 const BasicBlock *PredBB = ContextBB->getSinglePredecessor();
5429 if (!PredBB)
5430 return None;
5431
5432 // We need a conditional branch in the predecessor.
5433 Value *PredCond;
5434 BasicBlock *TrueBB, *FalseBB;
5435 if (!match(PredBB->getTerminator(), m_Br(m_Value(PredCond), TrueBB, FalseBB)))
5436 return None;
5437
5438 // The branch should get simplified. Don't bother simplifying this condition.
5439 if (TrueBB == FalseBB)
5440 return None;
5441
5442 assert((TrueBB == ContextBB || FalseBB == ContextBB) &&
5443 "Predecessor block does not point to successor?");
5444
5445 // Is this condition implied by the predecessor condition?
5446 bool CondIsTrue = TrueBB == ContextBB;
5447 return isImpliedCondition(PredCond, Cond, DL, CondIsTrue);
5448}