blob: feae53c54ecbf68f1facbbfd06c6acde91097df1 [file] [log] [blame]
Nick Lewycky7ed1dbf2013-06-10 23:10:59 +00001//===- MemoryDependenceAnalysis.cpp - Mem Deps Implementation -------------===//
Owen Andersonc0daf5f2007-07-06 23:14:35 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Owen Andersonc0daf5f2007-07-06 23:14:35 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements an analysis that determines, for a given memory
Jakub Staszakb0a7eed2013-03-20 21:47:51 +000011// operation, what preceding memory operations it depends on. It builds on
Owen Andersonfa788352007-08-08 22:01:54 +000012// alias analysis information, and tries to provide a lazy, caching interface to
Owen Andersonc0daf5f2007-07-06 23:14:35 +000013// a common kind of alias information query.
14//
15//===----------------------------------------------------------------------===//
16
17#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000018#include "llvm/ADT/DenseMap.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000019#include "llvm/ADT/STLExtras.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000020#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000021#include "llvm/ADT/SmallVector.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000022#include "llvm/ADT/Statistic.h"
Owen Andersonc0daf5f2007-07-06 23:14:35 +000023#include "llvm/Analysis/AliasAnalysis.h"
Daniel Jasperaec2fa32016-12-19 08:22:17 +000024#include "llvm/Analysis/AssumptionCache.h"
Victor Hernandezf390e042009-10-27 20:05:49 +000025#include "llvm/Analysis/MemoryBuiltins.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000026#include "llvm/Analysis/MemoryLocation.h"
Bruno Cardoso Lopesdfc1d962015-07-31 14:31:35 +000027#include "llvm/Analysis/OrderedBasicBlock.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000028#include "llvm/Analysis/PHITransAddr.h"
John Brawncd5f37f2018-07-31 14:19:29 +000029#include "llvm/Analysis/PhiValues.h"
Chandler Carruthd06034d2015-08-12 17:47:44 +000030#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000031#include "llvm/Analysis/ValueTracking.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000032#include "llvm/IR/Attributes.h"
33#include "llvm/IR/BasicBlock.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000034#include "llvm/IR/CallSite.h"
35#include "llvm/IR/Constants.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000036#include "llvm/IR/DataLayout.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000037#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000038#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000039#include "llvm/IR/Function.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000040#include "llvm/IR/InstrTypes.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000041#include "llvm/IR/Instruction.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000042#include "llvm/IR/Instructions.h"
43#include "llvm/IR/IntrinsicInst.h"
44#include "llvm/IR/LLVMContext.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000045#include "llvm/IR/Metadata.h"
46#include "llvm/IR/Module.h"
Chandler Carruthaa0ab632014-03-04 12:09:19 +000047#include "llvm/IR/PredIteratorCache.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000048#include "llvm/IR/Type.h"
49#include "llvm/IR/Use.h"
50#include "llvm/IR/User.h"
51#include "llvm/IR/Value.h"
52#include "llvm/Pass.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000053#include "llvm/Support/AtomicOrdering.h"
54#include "llvm/Support/Casting.h"
55#include "llvm/Support/CommandLine.h"
56#include "llvm/Support/Compiler.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000057#include "llvm/Support/Debug.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000058#include "llvm/Support/MathExtras.h"
59#include <algorithm>
60#include <cassert>
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000061#include <cstdint>
Eugene Zelenko1804a772016-08-25 00:45:04 +000062#include <iterator>
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000063#include <utility>
Eugene Zelenko1804a772016-08-25 00:45:04 +000064
Owen Andersonc0daf5f2007-07-06 23:14:35 +000065using namespace llvm;
66
Chandler Carruthf1221bd2014-04-22 02:48:03 +000067#define DEBUG_TYPE "memdep"
68
Chris Lattner7e61daf2008-12-01 01:15:42 +000069STATISTIC(NumCacheNonLocal, "Number of fully cached non-local responses");
70STATISTIC(NumCacheDirtyNonLocal, "Number of dirty cached non-local responses");
Chris Lattnere7d7e132008-11-29 22:02:15 +000071STATISTIC(NumUncacheNonLocal, "Number of uncached non-local responses");
Chris Lattnera28355d2008-12-07 08:50:20 +000072
73STATISTIC(NumCacheNonLocalPtr,
74 "Number of fully cached non-local ptr responses");
75STATISTIC(NumCacheDirtyNonLocalPtr,
76 "Number of cached, but dirty, non-local ptr responses");
Chandler Carruth60fb1b42016-03-07 10:19:30 +000077STATISTIC(NumUncacheNonLocalPtr, "Number of uncached non-local ptr responses");
Chris Lattner5ed409e2008-12-08 07:31:50 +000078STATISTIC(NumCacheCompleteNonLocalPtr,
79 "Number of block queries that were completely cached");
Chris Lattnera28355d2008-12-07 08:50:20 +000080
Eli Friedman8b098b02011-06-15 23:59:25 +000081// Limit for the number of instructions to scan in a block.
Jingyue Wud058ea92015-07-21 21:50:39 +000082
83static cl::opt<unsigned> BlockScanLimit(
84 "memdep-block-scan-limit", cl::Hidden, cl::init(100),
85 cl::desc("The number of instructions to scan in a block in memory "
86 "dependency analysis (default = 100)"));
Eli Friedman8b098b02011-06-15 23:59:25 +000087
Chandler Carruth60fb1b42016-03-07 10:19:30 +000088static cl::opt<unsigned>
89 BlockNumberLimit("memdep-block-number-limit", cl::Hidden, cl::init(1000),
90 cl::desc("The number of blocks to scan during memory "
91 "dependency analysis (default = 1000)"));
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +000092
Bruno Cardoso Lopese3c513a2014-10-01 20:07:13 +000093// Limit on the number of memdep results to process.
Aaron Ballman254dd7e2014-10-02 13:17:11 +000094static const unsigned int NumResultsLimit = 100;
Bruno Cardoso Lopese3c513a2014-10-01 20:07:13 +000095
Chandler Carruth40e21f22016-03-07 12:30:06 +000096/// This is a helper function that removes Val from 'Inst's set in ReverseMap.
97///
98/// If the set becomes empty, remove Inst's entry.
Chris Lattnerde4440c2008-12-07 18:39:13 +000099template <typename KeyTy>
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000100static void
101RemoveFromReverseMap(DenseMap<Instruction *, SmallPtrSet<KeyTy, 4>> &ReverseMap,
102 Instruction *Inst, KeyTy Val) {
103 typename DenseMap<Instruction *, SmallPtrSet<KeyTy, 4>>::iterator InstIt =
104 ReverseMap.find(Inst);
Chris Lattnerde4440c2008-12-07 18:39:13 +0000105 assert(InstIt != ReverseMap.end() && "Reverse map out of sync?");
106 bool Found = InstIt->second.erase(Val);
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000107 assert(Found && "Invalid reverse map!");
108 (void)Found;
Chris Lattnerde4440c2008-12-07 18:39:13 +0000109 if (InstIt->second.empty())
110 ReverseMap.erase(InstIt);
111}
112
Chandler Carruth40e21f22016-03-07 12:30:06 +0000113/// If the given instruction references a specific memory location, fill in Loc
114/// with the details, otherwise set Loc.Ptr to null.
115///
116/// Returns a ModRefInfo value describing the general behavior of the
Dan Gohman1d760ce2010-11-10 21:51:35 +0000117/// instruction.
Chandler Carruth194f59c2015-07-22 23:15:57 +0000118static ModRefInfo GetLocation(const Instruction *Inst, MemoryLocation &Loc,
Chandler Carruthd06034d2015-08-12 17:47:44 +0000119 const TargetLibraryInfo &TLI) {
Dan Gohman1d760ce2010-11-10 21:51:35 +0000120 if (const LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
Eli Friedman5494ada2011-08-15 20:54:19 +0000121 if (LI->isUnordered()) {
Chandler Carruth70c61c12015-06-04 02:03:15 +0000122 Loc = MemoryLocation::get(LI);
Alina Sbirlea193429f2017-12-07 22:41:34 +0000123 return ModRefInfo::Ref;
Jakub Staszakfa41def2013-03-20 23:53:45 +0000124 }
JF Bastien800f87a2016-04-06 21:19:33 +0000125 if (LI->getOrdering() == AtomicOrdering::Monotonic) {
Chandler Carruth70c61c12015-06-04 02:03:15 +0000126 Loc = MemoryLocation::get(LI);
Alina Sbirlea193429f2017-12-07 22:41:34 +0000127 return ModRefInfo::ModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000128 }
Chandler Carruthac80dc72015-06-17 07:18:54 +0000129 Loc = MemoryLocation();
Alina Sbirlea193429f2017-12-07 22:41:34 +0000130 return ModRefInfo::ModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000131 }
132
133 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Eli Friedman5494ada2011-08-15 20:54:19 +0000134 if (SI->isUnordered()) {
Chandler Carruth70c61c12015-06-04 02:03:15 +0000135 Loc = MemoryLocation::get(SI);
Alina Sbirlea193429f2017-12-07 22:41:34 +0000136 return ModRefInfo::Mod;
Jakub Staszakfa41def2013-03-20 23:53:45 +0000137 }
JF Bastien800f87a2016-04-06 21:19:33 +0000138 if (SI->getOrdering() == AtomicOrdering::Monotonic) {
Chandler Carruth70c61c12015-06-04 02:03:15 +0000139 Loc = MemoryLocation::get(SI);
Alina Sbirlea193429f2017-12-07 22:41:34 +0000140 return ModRefInfo::ModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000141 }
Chandler Carruthac80dc72015-06-17 07:18:54 +0000142 Loc = MemoryLocation();
Alina Sbirlea193429f2017-12-07 22:41:34 +0000143 return ModRefInfo::ModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000144 }
145
146 if (const VAArgInst *V = dyn_cast<VAArgInst>(Inst)) {
Chandler Carruth70c61c12015-06-04 02:03:15 +0000147 Loc = MemoryLocation::get(V);
Alina Sbirlea193429f2017-12-07 22:41:34 +0000148 return ModRefInfo::ModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000149 }
150
Chandler Carruthd06034d2015-08-12 17:47:44 +0000151 if (const CallInst *CI = isFreeCall(Inst, &TLI)) {
Dan Gohman1d760ce2010-11-10 21:51:35 +0000152 // calls to free() deallocate the entire structure
Chandler Carruthac80dc72015-06-17 07:18:54 +0000153 Loc = MemoryLocation(CI->getArgOperand(0));
Alina Sbirlea193429f2017-12-07 22:41:34 +0000154 return ModRefInfo::Mod;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000155 }
156
Hal Finkelcc39b672014-07-24 12:16:19 +0000157 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
Dan Gohman1d760ce2010-11-10 21:51:35 +0000158 switch (II->getIntrinsicID()) {
159 case Intrinsic::lifetime_start:
160 case Intrinsic::lifetime_end:
161 case Intrinsic::invariant_start:
Philip Reamesf5ff5d52018-01-17 19:57:19 +0000162 Loc = MemoryLocation::getForArgument(II, 1, TLI);
Dan Gohman1d760ce2010-11-10 21:51:35 +0000163 // These intrinsics don't really modify the memory, but returning Mod
164 // will allow them to be handled conservatively.
Alina Sbirlea193429f2017-12-07 22:41:34 +0000165 return ModRefInfo::Mod;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000166 case Intrinsic::invariant_end:
Philip Reamesf5ff5d52018-01-17 19:57:19 +0000167 Loc = MemoryLocation::getForArgument(II, 2, TLI);
Dan Gohman1d760ce2010-11-10 21:51:35 +0000168 // These intrinsics don't really modify the memory, but returning Mod
169 // will allow them to be handled conservatively.
Alina Sbirlea193429f2017-12-07 22:41:34 +0000170 return ModRefInfo::Mod;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000171 default:
172 break;
173 }
Hal Finkelcc39b672014-07-24 12:16:19 +0000174 }
Dan Gohman1d760ce2010-11-10 21:51:35 +0000175
176 // Otherwise, just do the coarse-grained thing that always works.
177 if (Inst->mayWriteToMemory())
Alina Sbirlea193429f2017-12-07 22:41:34 +0000178 return ModRefInfo::ModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000179 if (Inst->mayReadFromMemory())
Alina Sbirlea193429f2017-12-07 22:41:34 +0000180 return ModRefInfo::Ref;
181 return ModRefInfo::NoModRef;
Dan Gohman1d760ce2010-11-10 21:51:35 +0000182}
Chris Lattner7e61daf2008-12-01 01:15:42 +0000183
Chandler Carruth40e21f22016-03-07 12:30:06 +0000184/// Private helper for finding the local dependencies of a call site.
Chandler Carruth61440d22016-03-10 00:55:30 +0000185MemDepResult MemoryDependenceResults::getCallSiteDependencyFrom(
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000186 CallSite CS, bool isReadOnlyCall, BasicBlock::iterator ScanIt,
187 BasicBlock *BB) {
Eli Friedman8b098b02011-06-15 23:59:25 +0000188 unsigned Limit = BlockScanLimit;
189
Henric Karlsson54a53bd2016-10-06 10:58:41 +0000190 // Walk backwards through the block, looking for dependencies.
Chris Lattner51ba8d02008-11-29 03:47:00 +0000191 while (ScanIt != BB->begin()) {
Mikael Holmen279790b2017-10-25 06:15:32 +0000192 Instruction *Inst = &*--ScanIt;
193 // Debug intrinsics don't cause dependences and should not affect Limit
194 if (isa<DbgInfoIntrinsic>(Inst))
195 continue;
196
Eli Friedman8b098b02011-06-15 23:59:25 +0000197 // Limit the amount of scanning we do so we don't end up with quadratic
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000198 // running time on extreme testcases.
Eli Friedman8b098b02011-06-15 23:59:25 +0000199 --Limit;
200 if (!Limit)
201 return MemDepResult::getUnknown();
202
Owen Anderson9c884572007-07-10 17:59:22 +0000203 // If this inst is a memory op, get the pointer it accessed
Chandler Carruthac80dc72015-06-17 07:18:54 +0000204 MemoryLocation Loc;
Chandler Carruth61440d22016-03-10 00:55:30 +0000205 ModRefInfo MR = GetLocation(Inst, Loc, TLI);
Dan Gohman1d760ce2010-11-10 21:51:35 +0000206 if (Loc.Ptr) {
207 // A simple instruction.
Alina Sbirlea63d22502017-12-05 20:12:23 +0000208 if (isModOrRefSet(AA.getModRefInfo(CS, Loc)))
Dan Gohman1d760ce2010-11-10 21:51:35 +0000209 return MemDepResult::getClobber(Inst);
210 continue;
211 }
212
Benjamin Kramer3a09ef62015-04-10 14:50:08 +0000213 if (auto InstCS = CallSite(Inst)) {
Chris Lattner0e3d6332008-12-05 21:04:20 +0000214 // If these two calls do not interfere, look past it.
Alina Sbirlea63d22502017-12-05 20:12:23 +0000215 if (isNoModRef(AA.getModRefInfo(CS, InstCS))) {
Dan Gohman26ef7c72010-08-05 22:09:15 +0000216 // If the two calls are the same, return InstCS as a Def, so that
217 // CS can be found redundant and eliminated.
Alina Sbirlea63d22502017-12-05 20:12:23 +0000218 if (isReadOnlyCall && !isModSet(MR) &&
Dan Gohman26ef7c72010-08-05 22:09:15 +0000219 CS.getInstruction()->isIdenticalToWhenDefined(Inst))
220 return MemDepResult::getDef(Inst);
221
222 // Otherwise if the two calls don't interact (e.g. InstCS is readnone)
223 // keep scanning.
Nadav Rotem5d4e2052012-08-13 23:03:43 +0000224 continue;
Alina Sbirlea63d22502017-12-05 20:12:23 +0000225 } else
Chris Lattner0e3d6332008-12-05 21:04:20 +0000226 return MemDepResult::getClobber(Inst);
Chris Lattnerff862c42008-11-30 01:44:00 +0000227 }
Nadav Rotem5d4e2052012-08-13 23:03:43 +0000228
229 // If we could not obtain a pointer for the instruction and the instruction
230 // touches memory then assume that this is a dependency.
Alina Sbirlea63d22502017-12-05 20:12:23 +0000231 if (isModOrRefSet(MR))
Nadav Rotem5d4e2052012-08-13 23:03:43 +0000232 return MemDepResult::getClobber(Inst);
Owen Anderson9c884572007-07-10 17:59:22 +0000233 }
Nadav Rotem5d4e2052012-08-13 23:03:43 +0000234
Eli Friedman7d58bc72011-06-15 00:47:34 +0000235 // No dependence found. If this is the entry block of the function, it is
236 // unknown, otherwise it is non-local.
Chris Lattner2faa2c72008-12-07 02:15:47 +0000237 if (BB != &BB->getParent()->getEntryBlock())
238 return MemDepResult::getNonLocal();
Eli Friedmanc1702c82011-10-13 22:14:57 +0000239 return MemDepResult::getNonFuncLocal();
Owen Anderson9c884572007-07-10 17:59:22 +0000240}
241
Chandler Carruth61440d22016-03-10 00:55:30 +0000242unsigned MemoryDependenceResults::getLoadLoadClobberFullWidthSize(
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000243 const Value *MemLocBase, int64_t MemLocOffs, unsigned MemLocSize,
244 const LoadInst *LI) {
Eli Friedman5494ada2011-08-15 20:54:19 +0000245 // We can only extend simple integer loads.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000246 if (!isa<IntegerType>(LI->getType()) || !LI->isSimple())
247 return 0;
Kostya Serebryany3838f272013-02-13 05:59:45 +0000248
249 // Load widening is hostile to ThreadSanitizer: it may cause false positives
250 // or make the reports more cryptic (access sizes are wrong).
Duncan P. N. Exon Smithb3fc83c2015-02-14 00:12:15 +0000251 if (LI->getParent()->getParent()->hasFnAttribute(Attribute::SanitizeThread))
Kostya Serebryany3838f272013-02-13 05:59:45 +0000252 return 0;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000253
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000254 const DataLayout &DL = LI->getModule()->getDataLayout();
255
Chris Lattner7aab2792011-04-26 22:42:01 +0000256 // Get the base of this load.
257 int64_t LIOffs = 0;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000258 const Value *LIBase =
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000259 GetPointerBaseWithConstantOffset(LI->getPointerOperand(), LIOffs, DL);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000260
Chris Lattner7aab2792011-04-26 22:42:01 +0000261 // If the two pointers are not based on the same pointer, we can't tell that
262 // they are related.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000263 if (LIBase != MemLocBase)
264 return 0;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000265
Chris Lattner7aab2792011-04-26 22:42:01 +0000266 // Okay, the two values are based on the same pointer, but returned as
267 // no-alias. This happens when we have things like two byte loads at "P+1"
268 // and "P+3". Check to see if increasing the size of the "LI" load up to its
269 // alignment (or the largest native integer type) will allow us to load all
270 // the bits required by MemLoc.
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000271
Chris Lattner7aab2792011-04-26 22:42:01 +0000272 // If MemLoc is before LI, then no widening of LI will help us out.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000273 if (MemLocOffs < LIOffs)
274 return 0;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000275
Chris Lattner7aab2792011-04-26 22:42:01 +0000276 // Get the alignment of the load in bytes. We assume that it is safe to load
277 // any legal integer up to this size without a problem. For example, if we're
278 // looking at an i8 load on x86-32 that is known 1024 byte aligned, we can
279 // widen it up to an i32 load. If it is known 2-byte aligned, we can widen it
280 // to i16.
281 unsigned LoadAlign = LI->getAlignment();
282
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000283 int64_t MemLocEnd = MemLocOffs + MemLocSize;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000284
Chris Lattner7aab2792011-04-26 22:42:01 +0000285 // If no amount of rounding up will let MemLoc fit into LI, then bail out.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000286 if (LIOffs + LoadAlign < MemLocEnd)
287 return 0;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000288
Chris Lattner7aab2792011-04-26 22:42:01 +0000289 // This is the size of the load to try. Start with the next larger power of
290 // two.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000291 unsigned NewLoadByteSize = LI->getType()->getPrimitiveSizeInBits() / 8U;
Chris Lattner7aab2792011-04-26 22:42:01 +0000292 NewLoadByteSize = NextPowerOf2(NewLoadByteSize);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000293
Eugene Zelenko1804a772016-08-25 00:45:04 +0000294 while (true) {
Chris Lattner7aab2792011-04-26 22:42:01 +0000295 // If this load size is bigger than our known alignment or would not fit
296 // into a native integer register, then we fail.
297 if (NewLoadByteSize > LoadAlign ||
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000298 !DL.fitsInLegalInteger(NewLoadByteSize * 8))
Chris Lattner827a2702011-04-28 07:29:08 +0000299 return 0;
Chris Lattner7aab2792011-04-26 22:42:01 +0000300
Duncan P. N. Exon Smithb3fc83c2015-02-14 00:12:15 +0000301 if (LIOffs + NewLoadByteSize > MemLocEnd &&
Evgeniy Stepanovc667c1f2017-12-09 00:21:41 +0000302 (LI->getParent()->getParent()->hasFnAttribute(
303 Attribute::SanitizeAddress) ||
304 LI->getParent()->getParent()->hasFnAttribute(
305 Attribute::SanitizeHWAddress)))
Kostya Serebryany9e0d3772012-02-06 22:48:56 +0000306 // We will be reading past the location accessed by the original program.
307 // While this is safe in a regular build, Address Safety analysis tools
308 // may start reporting false warnings. So, don't do widening.
309 return 0;
Kostya Serebryany9e0d3772012-02-06 22:48:56 +0000310
Chris Lattner7aab2792011-04-26 22:42:01 +0000311 // If a load of this width would include all of MemLoc, then we succeed.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000312 if (LIOffs + NewLoadByteSize >= MemLocEnd)
Chris Lattner827a2702011-04-28 07:29:08 +0000313 return NewLoadByteSize;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000314
Chris Lattner7aab2792011-04-26 22:42:01 +0000315 NewLoadByteSize <<= 1;
316 }
Chris Lattner7aab2792011-04-26 22:42:01 +0000317}
318
Philip Reamesa7ad6a52015-01-26 18:54:27 +0000319static bool isVolatile(Instruction *Inst) {
Davide Italianof15fb362017-06-25 22:12:59 +0000320 if (auto *LI = dyn_cast<LoadInst>(Inst))
Philip Reamesa7ad6a52015-01-26 18:54:27 +0000321 return LI->isVolatile();
Davide Italianof15fb362017-06-25 22:12:59 +0000322 if (auto *SI = dyn_cast<StoreInst>(Inst))
Philip Reamesa7ad6a52015-01-26 18:54:27 +0000323 return SI->isVolatile();
Davide Italianof15fb362017-06-25 22:12:59 +0000324 if (auto *AI = dyn_cast<AtomicCmpXchgInst>(Inst))
Philip Reamesa7ad6a52015-01-26 18:54:27 +0000325 return AI->isVolatile();
326 return false;
327}
328
Chandler Carruth61440d22016-03-10 00:55:30 +0000329MemDepResult MemoryDependenceResults::getPointerDependencyFrom(
Chandler Carruthac80dc72015-06-17 07:18:54 +0000330 const MemoryLocation &MemLoc, bool isLoad, BasicBlock::iterator ScanIt,
Bob Haarman3db17642016-08-26 16:34:27 +0000331 BasicBlock *BB, Instruction *QueryInst, unsigned *Limit) {
Piotr Padlewski95308832017-01-12 11:33:58 +0000332 MemDepResult InvariantGroupDependency = MemDepResult::getUnknown();
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000333 if (QueryInst != nullptr) {
334 if (auto *LI = dyn_cast<LoadInst>(QueryInst)) {
Piotr Padlewski95308832017-01-12 11:33:58 +0000335 InvariantGroupDependency = getInvariantGroupPointerDependency(LI, BB);
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000336
Piotr Padlewskie41beed2017-01-11 16:23:54 +0000337 if (InvariantGroupDependency.isDef())
338 return InvariantGroupDependency;
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000339 }
340 }
Piotr Padlewski95308832017-01-12 11:33:58 +0000341 MemDepResult SimpleDep = getSimplePointerDependencyFrom(
342 MemLoc, isLoad, ScanIt, BB, QueryInst, Limit);
343 if (SimpleDep.isDef())
344 return SimpleDep;
345 // Non-local invariant group dependency indicates there is non local Def
346 // (it only returns nonLocal if it finds nonLocal def), which is better than
347 // local clobber and everything else.
348 if (InvariantGroupDependency.isNonLocal())
349 return InvariantGroupDependency;
350
351 assert(InvariantGroupDependency.isUnknown() &&
352 "InvariantGroupDependency should be only unknown at this point");
353 return SimpleDep;
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000354}
355
356MemDepResult
Chandler Carruth61440d22016-03-10 00:55:30 +0000357MemoryDependenceResults::getInvariantGroupPointerDependency(LoadInst *LI,
Piotr Padlewski01659cb2016-11-08 18:20:51 +0000358 BasicBlock *BB) {
Piotr Padlewskice358262018-05-18 23:53:46 +0000359
360 if (!LI->getMetadata(LLVMContext::MD_invariant_group))
Piotr Padlewskida362152016-12-30 18:45:07 +0000361 return MemDepResult::getUnknown();
362
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000363 // Take the ptr operand after all casts and geps 0. This way we can search
364 // cast graph down only.
365 Value *LoadOperand = LI->getPointerOperand()->stripPointerCasts();
366
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000367 // It's is not safe to walk the use list of global value, because function
368 // passes aren't allowed to look outside their functions.
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000369 // FIXME: this could be fixed by filtering instructions from outside
370 // of current function.
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000371 if (isa<GlobalValue>(LoadOperand))
372 return MemDepResult::getUnknown();
373
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000374 // Queue to process all pointers that are equivalent to load operand.
Piotr Padlewskida362152016-12-30 18:45:07 +0000375 SmallVector<const Value *, 8> LoadOperandsQueue;
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000376 LoadOperandsQueue.push_back(LoadOperand);
Piotr Padlewski95308832017-01-12 11:33:58 +0000377
378 Instruction *ClosestDependency = nullptr;
379 // Order of instructions in uses list is unpredictible. In order to always
380 // get the same result, we will look for the closest dominance.
381 auto GetClosestDependency = [this](Instruction *Best, Instruction *Other) {
382 assert(Other && "Must call it with not null instruction");
383 if (Best == nullptr || DT.dominates(Best, Other))
384 return Other;
385 return Best;
386 };
387
Piotr Padlewski95308832017-01-12 11:33:58 +0000388 // FIXME: This loop is O(N^2) because dominates can be O(n) and in worst case
389 // we will see all the instructions. This should be fixed in MSSA.
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000390 while (!LoadOperandsQueue.empty()) {
Piotr Padlewskida362152016-12-30 18:45:07 +0000391 const Value *Ptr = LoadOperandsQueue.pop_back_val();
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000392 assert(Ptr && !isa<GlobalValue>(Ptr) &&
393 "Null or GlobalValue should not be inserted");
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000394
Piotr Padlewskida362152016-12-30 18:45:07 +0000395 for (const Use &Us : Ptr->uses()) {
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000396 auto *U = dyn_cast<Instruction>(Us.getUser());
Chandler Carruthaef32bd2016-03-11 13:46:00 +0000397 if (!U || U == LI || !DT.dominates(U, LI))
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000398 continue;
399
Piotr Padlewskida362152016-12-30 18:45:07 +0000400 // Bitcast or gep with zeros are using Ptr. Add to queue to check it's
401 // users. U = bitcast Ptr
402 if (isa<BitCastInst>(U)) {
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000403 LoadOperandsQueue.push_back(U);
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000404 continue;
405 }
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000406 // Gep with zeros is equivalent to bitcast.
407 // FIXME: we are not sure if some bitcast should be canonicalized to gep 0
408 // or gep 0 to bitcast because of SROA, so there are 2 forms. When
409 // typeless pointers will be ready then both cases will be gone
410 // (and this BFS also won't be needed).
Piotr Padlewskida362152016-12-30 18:45:07 +0000411 if (auto *GEP = dyn_cast<GetElementPtrInst>(U))
412 if (GEP->hasAllZeroIndices()) {
Piotr Padlewski09ad6782017-01-08 22:26:06 +0000413 LoadOperandsQueue.push_back(U);
Piotr Padlewskida362152016-12-30 18:45:07 +0000414 continue;
415 }
416
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000417 // If we hit load/store with the same invariant.group metadata (and the
418 // same pointer operand) we can assume that value pointed by pointer
419 // operand didn't change.
Piotr Padlewski95308832017-01-12 11:33:58 +0000420 if ((isa<LoadInst>(U) || isa<StoreInst>(U)) &&
Piotr Padlewskice358262018-05-18 23:53:46 +0000421 U->getMetadata(LLVMContext::MD_invariant_group) != nullptr)
Piotr Padlewski95308832017-01-12 11:33:58 +0000422 ClosestDependency = GetClosestDependency(ClosestDependency, U);
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000423 }
424 }
Piotr Padlewski95308832017-01-12 11:33:58 +0000425
426 if (!ClosestDependency)
427 return MemDepResult::getUnknown();
428 if (ClosestDependency->getParent() == BB)
429 return MemDepResult::getDef(ClosestDependency);
430 // Def(U) can't be returned here because it is non-local. If local
431 // dependency won't be found then return nonLocal counting that the
432 // user will call getNonLocalPointerDependency, which will return cached
433 // result.
434 NonLocalDefsCache.try_emplace(
435 LI, NonLocalDepResult(ClosestDependency->getParent(),
436 MemDepResult::getDef(ClosestDependency), nullptr));
Piotr Padlewski153fe602018-05-18 22:40:34 +0000437 ReverseNonLocalDefsCache[ClosestDependency].insert(LI);
Piotr Padlewski95308832017-01-12 11:33:58 +0000438 return MemDepResult::getNonLocal();
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000439}
440
Chandler Carruth61440d22016-03-10 00:55:30 +0000441MemDepResult MemoryDependenceResults::getSimplePointerDependencyFrom(
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +0000442 const MemoryLocation &MemLoc, bool isLoad, BasicBlock::iterator ScanIt,
Bob Haarman3db17642016-08-26 16:34:27 +0000443 BasicBlock *BB, Instruction *QueryInst, unsigned *Limit) {
Shuxin Yang408bdad2013-03-06 17:48:48 +0000444 bool isInvariantLoad = false;
Robin Morisset163ef042014-08-29 20:32:58 +0000445
Bob Haarman3db17642016-08-26 16:34:27 +0000446 if (!Limit) {
447 unsigned DefaultLimit = BlockScanLimit;
448 return getSimplePointerDependencyFrom(MemLoc, isLoad, ScanIt, BB, QueryInst,
449 &DefaultLimit);
450 }
451
Robin Morisset163ef042014-08-29 20:32:58 +0000452 // We must be careful with atomic accesses, as they may allow another thread
Chad Rosier02e831c2016-06-28 17:19:10 +0000453 // to touch this location, clobbering it. We are conservative: if the
Robin Morisset163ef042014-08-29 20:32:58 +0000454 // QueryInst is not a simple (non-atomic) memory access, we automatically
455 // return getClobber.
456 // If it is simple, we know based on the results of
457 // "Compiler testing via a theory of sound optimisations in the C11/C++11
458 // memory model" in PLDI 2013, that a non-atomic location can only be
459 // clobbered between a pair of a release and an acquire action, with no
460 // access to the location in between.
461 // Here is an example for giving the general intuition behind this rule.
462 // In the following code:
463 // store x 0;
464 // release action; [1]
465 // acquire action; [4]
466 // %val = load x;
467 // It is unsafe to replace %val by 0 because another thread may be running:
468 // acquire action; [2]
469 // store x 42;
470 // release action; [3]
471 // with synchronization from 1 to 2 and from 3 to 4, resulting in %val
472 // being 42. A key property of this program however is that if either
473 // 1 or 4 were missing, there would be a race between the store of 42
Chad Rosier02e831c2016-06-28 17:19:10 +0000474 // either the store of 0 or the load (making the whole program racy).
Nick Lewycky947ca8a2016-01-04 16:44:44 +0000475 // The paper mentioned above shows that the same property is respected
Chad Rosier02e831c2016-06-28 17:19:10 +0000476 // by every program that can detect any optimization of that kind: either
Robin Morisset163ef042014-08-29 20:32:58 +0000477 // it is racy (undefined) or there is a release followed by an acquire
478 // between the pair of accesses under consideration.
Robin Morisset163ef042014-08-29 20:32:58 +0000479
Philip Reames4dbd88f2015-03-24 23:54:54 +0000480 // If the load is invariant, we "know" that it doesn't alias *any* write. We
481 // do want to respect mustalias results since defs are useful for value
482 // forwarding, but any mayalias write can be assumed to be noalias.
483 // Arguably, this logic should be pushed inside AliasAnalysis itself.
Shuxin Yang408bdad2013-03-06 17:48:48 +0000484 if (isLoad && QueryInst) {
485 LoadInst *LI = dyn_cast<LoadInst>(QueryInst);
Craig Topper9f008862014-04-15 04:59:12 +0000486 if (LI && LI->getMetadata(LLVMContext::MD_invariant_load) != nullptr)
Shuxin Yang408bdad2013-03-06 17:48:48 +0000487 isInvariantLoad = true;
488 }
Eli Friedman8b098b02011-06-15 23:59:25 +0000489
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000490 const DataLayout &DL = BB->getModule()->getDataLayout();
491
Bruno Cardoso Lopesdfc1d962015-07-31 14:31:35 +0000492 // Create a numbered basic block to lazily compute and cache instruction
493 // positions inside a BB. This is used to provide fast queries for relative
494 // position between two instructions in a BB and can be used by
495 // AliasAnalysis::callCapturesBefore.
496 OrderedBasicBlock OBB(BB);
497
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000498 // Return "true" if and only if the instruction I is either a non-simple
499 // load or a non-simple store.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000500 auto isNonSimpleLoadOrStore = [](Instruction *I) -> bool {
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000501 if (auto *LI = dyn_cast<LoadInst>(I))
502 return !LI->isSimple();
503 if (auto *SI = dyn_cast<StoreInst>(I))
504 return !SI->isSimple();
505 return false;
506 };
507
508 // Return "true" if I is not a load and not a store, but it does access
509 // memory.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000510 auto isOtherMemAccess = [](Instruction *I) -> bool {
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000511 return !isa<LoadInst>(I) && !isa<StoreInst>(I) && I->mayReadOrWriteMemory();
512 };
513
Chris Lattnera28355d2008-12-07 08:50:20 +0000514 // Walk backwards through the basic block, looking for dependencies.
Philip Reames090a8242015-02-15 19:07:31 +0000515 while (ScanIt != BB->begin()) {
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +0000516 Instruction *Inst = &*--ScanIt;
Yunzhong Gao5cbcf562013-11-14 01:10:52 +0000517
518 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst))
519 // Debug intrinsics don't (and can't) cause dependencies.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000520 if (isa<DbgInfoIntrinsic>(II))
521 continue;
Yunzhong Gao5cbcf562013-11-14 01:10:52 +0000522
Eli Friedman8b098b02011-06-15 23:59:25 +0000523 // Limit the amount of scanning we do so we don't end up with quadratic
524 // running time on extreme testcases.
Bob Haarman3db17642016-08-26 16:34:27 +0000525 --*Limit;
526 if (!*Limit)
Eli Friedman8b098b02011-06-15 23:59:25 +0000527 return MemDepResult::getUnknown();
528
Chris Lattner506b8582009-12-01 21:15:15 +0000529 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
Owen Anderson2b2bd282009-10-28 07:05:35 +0000530 // If we reach a lifetime begin or end marker, then the query ends here
531 // because the value is undefined.
Chris Lattnera58edd12010-09-06 03:58:04 +0000532 if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
Owen Andersonb9878ee2009-12-02 07:35:19 +0000533 // FIXME: This only considers queries directly on the invariant-tagged
534 // pointer, not on query pointers that are indexed off of them. It'd
Chris Lattner7aab2792011-04-26 22:42:01 +0000535 // be nice to handle that at some point (the right approach is to use
536 // GetPointerBaseWithConstantOffset).
Chandler Carruth61440d22016-03-10 00:55:30 +0000537 if (AA.isMustAlias(MemoryLocation(II->getArgOperand(1)), MemLoc))
Owen Anderson2b2bd282009-10-28 07:05:35 +0000538 return MemDepResult::getDef(II);
Chris Lattnera58edd12010-09-06 03:58:04 +0000539 continue;
Owen Andersond0e86d52009-10-28 06:18:42 +0000540 }
541 }
542
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000543 // Values depend on loads if the pointers are must aliased. This means
544 // that a load depends on another must aliased load from the same value.
545 // One exception is atomic loads: a value can depend on an atomic load that
546 // it does not alias with when this atomic load indicates that another
547 // thread may be accessing the location.
Chris Lattner0e3d6332008-12-05 21:04:20 +0000548 if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
Philip Reamesa7ad6a52015-01-26 18:54:27 +0000549 // While volatile access cannot be eliminated, they do not have to clobber
550 // non-aliasing locations, as normal accesses, for example, can be safely
551 // reordered with volatile accesses.
552 if (LI->isVolatile()) {
553 if (!QueryInst)
554 // Original QueryInst *may* be volatile
555 return MemDepResult::getClobber(LI);
556 if (isVolatile(QueryInst))
557 // Ordering required if QueryInst is itself volatile
558 return MemDepResult::getClobber(LI);
559 // Otherwise, volatile doesn't imply any special ordering
560 }
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000561
Eli Friedman5494ada2011-08-15 20:54:19 +0000562 // Atomic loads have complications involved.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000563 // A Monotonic (or higher) load is OK if the query inst is itself not
564 // atomic.
Eli Friedman5494ada2011-08-15 20:54:19 +0000565 // FIXME: This is overly conservative.
JF Bastien800f87a2016-04-06 21:19:33 +0000566 if (LI->isAtomic() && isStrongerThanUnordered(LI->getOrdering())) {
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000567 if (!QueryInst || isNonSimpleLoadOrStore(QueryInst) ||
568 isOtherMemAccess(QueryInst))
Robin Morisset9e98e7f2014-08-18 22:18:14 +0000569 return MemDepResult::getClobber(LI);
JF Bastien800f87a2016-04-06 21:19:33 +0000570 if (LI->getOrdering() != AtomicOrdering::Monotonic)
David Majnemere1655022015-03-21 06:19:17 +0000571 return MemDepResult::getClobber(LI);
Robin Morisset4ffe8aa2014-08-18 22:18:11 +0000572 }
Eli Friedman5494ada2011-08-15 20:54:19 +0000573
Chandler Carruthac80dc72015-06-17 07:18:54 +0000574 MemoryLocation LoadLoc = MemoryLocation::get(LI);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000575
Chris Lattner0e3d6332008-12-05 21:04:20 +0000576 // If we found a pointer, check if it could be the same as our pointer.
Chandler Carruth61440d22016-03-10 00:55:30 +0000577 AliasResult R = AA.alias(LoadLoc, MemLoc);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000578
Chris Lattner6f83d062011-04-26 01:21:15 +0000579 if (isLoad) {
Dehao Chen22ce5eb2016-09-09 18:42:35 +0000580 if (R == NoAlias)
Chris Lattner7aab2792011-04-26 22:42:01 +0000581 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000582
Chris Lattner6f83d062011-04-26 01:21:15 +0000583 // Must aliased loads are defs of each other.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000584 if (R == MustAlias)
Chris Lattner6f83d062011-04-26 01:21:15 +0000585 return MemDepResult::getDef(Inst);
586
Dan Gohmana4717512011-06-04 06:48:50 +0000587#if 0 // FIXME: Temporarily disabled. GVN is cleverly rewriting loads
588 // in terms of clobbering loads, but since it does this by looking
589 // at the clobbering load directly, it doesn't know about any
590 // phi translation that may have happened along the way.
591
Chris Lattner6f83d062011-04-26 01:21:15 +0000592 // If we have a partial alias, then return this as a clobber for the
593 // client to handle.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000594 if (R == PartialAlias)
Chris Lattner6f83d062011-04-26 01:21:15 +0000595 return MemDepResult::getClobber(Inst);
Dan Gohmana4717512011-06-04 06:48:50 +0000596#endif
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000597
Chris Lattner6f83d062011-04-26 01:21:15 +0000598 // Random may-alias loads don't depend on each other without a
599 // dependence.
Chris Lattner80c08182008-11-29 09:09:48 +0000600 continue;
Chris Lattner6f83d062011-04-26 01:21:15 +0000601 }
Dan Gohman15a43962010-10-29 01:14:04 +0000602
Chris Lattner7aab2792011-04-26 22:42:01 +0000603 // Stores don't depend on other no-aliased accesses.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000604 if (R == NoAlias)
Chris Lattner7aab2792011-04-26 22:42:01 +0000605 continue;
606
Dan Gohman15a43962010-10-29 01:14:04 +0000607 // Stores don't alias loads from read-only memory.
Chandler Carruth61440d22016-03-10 00:55:30 +0000608 if (AA.pointsToConstantMemory(LoadLoc))
Dan Gohman15a43962010-10-29 01:14:04 +0000609 continue;
610
Chris Lattner6f83d062011-04-26 01:21:15 +0000611 // Stores depend on may/must aliased loads.
Chris Lattner0e3d6332008-12-05 21:04:20 +0000612 return MemDepResult::getDef(Inst);
613 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000614
Chris Lattner0e3d6332008-12-05 21:04:20 +0000615 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Eli Friedman5494ada2011-08-15 20:54:19 +0000616 // Atomic stores have complications involved.
Robin Morisset163ef042014-08-29 20:32:58 +0000617 // A Monotonic store is OK if the query inst is itself not atomic.
Eli Friedman5494ada2011-08-15 20:54:19 +0000618 // FIXME: This is overly conservative.
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000619 if (!SI->isUnordered() && SI->isAtomic()) {
620 if (!QueryInst || isNonSimpleLoadOrStore(QueryInst) ||
621 isOtherMemAccess(QueryInst))
Robin Morisset9e98e7f2014-08-18 22:18:14 +0000622 return MemDepResult::getClobber(SI);
JF Bastien800f87a2016-04-06 21:19:33 +0000623 if (SI->getOrdering() != AtomicOrdering::Monotonic)
David Majnemere1655022015-03-21 06:19:17 +0000624 return MemDepResult::getClobber(SI);
Robin Morisset4ffe8aa2014-08-18 22:18:11 +0000625 }
Eli Friedman5494ada2011-08-15 20:54:19 +0000626
Robin Morisset9e98e7f2014-08-18 22:18:14 +0000627 // FIXME: this is overly conservative.
628 // While volatile access cannot be eliminated, they do not have to clobber
629 // non-aliasing locations, as normal accesses can for example be reordered
630 // with volatile accesses.
631 if (SI->isVolatile())
Krzysztof Parzyszeke261e5a2016-02-22 23:07:43 +0000632 if (!QueryInst || isNonSimpleLoadOrStore(QueryInst) ||
633 isOtherMemAccess(QueryInst))
634 return MemDepResult::getClobber(SI);
Robin Morisset9e98e7f2014-08-18 22:18:14 +0000635
Chris Lattner02274a72009-05-25 21:28:56 +0000636 // If alias analysis can tell that this store is guaranteed to not modify
637 // the query pointer, ignore it. Use getModRefInfo to handle cases where
638 // the query pointer points to constant memory etc.
Alina Sbirlea63d22502017-12-05 20:12:23 +0000639 if (!isModOrRefSet(AA.getModRefInfo(SI, MemLoc)))
Chris Lattner02274a72009-05-25 21:28:56 +0000640 continue;
641
642 // Ok, this store might clobber the query pointer. Check to see if it is
643 // a must alias: in this case, we want to return this as a def.
Alina Sbirlea50db8a22017-12-21 21:41:53 +0000644 // FIXME: Use ModRefInfo::Must bit from getModRefInfo call above.
Chandler Carruthac80dc72015-06-17 07:18:54 +0000645 MemoryLocation StoreLoc = MemoryLocation::get(SI);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000646
Chris Lattner0e3d6332008-12-05 21:04:20 +0000647 // If we found a pointer, check if it could be the same as our pointer.
Chandler Carruth61440d22016-03-10 00:55:30 +0000648 AliasResult R = AA.alias(StoreLoc, MemLoc);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000649
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000650 if (R == NoAlias)
Chris Lattner0e3d6332008-12-05 21:04:20 +0000651 continue;
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000652 if (R == MustAlias)
Dan Gohmanba5d0ab2010-12-13 22:47:57 +0000653 return MemDepResult::getDef(Inst);
Shuxin Yang408bdad2013-03-06 17:48:48 +0000654 if (isInvariantLoad)
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000655 continue;
Dan Gohmanba5d0ab2010-12-13 22:47:57 +0000656 return MemDepResult::getClobber(Inst);
Owen Andersonc0daf5f2007-07-06 23:14:35 +0000657 }
Chris Lattner3ff6d012008-11-30 01:39:32 +0000658
659 // If this is an allocation, and if we know that the accessed pointer is to
Chris Lattner0e3d6332008-12-05 21:04:20 +0000660 // the allocation, return Def. This means that there is no dependence and
Chris Lattner3ff6d012008-11-30 01:39:32 +0000661 // the access can be optimized based on that. For example, a load could
Philip Reamesd9f4a3d2016-03-09 23:19:56 +0000662 // turn into undef. Note that we can bypass the allocation itself when
663 // looking for a clobber in many cases; that's an alias property and is
664 // handled by BasicAA.
Chandler Carruth61440d22016-03-10 00:55:30 +0000665 if (isa<AllocaInst>(Inst) || isNoAliasFn(Inst, &TLI)) {
Rafael Espindola7c68beb2014-02-18 15:33:12 +0000666 const Value *AccessPtr = GetUnderlyingObject(MemLoc.Ptr, DL);
Chandler Carruth61440d22016-03-10 00:55:30 +0000667 if (AccessPtr == Inst || AA.isMustAlias(Inst, AccessPtr))
Victor Hernandez537d8d92009-09-18 21:34:51 +0000668 return MemDepResult::getDef(Inst);
Victor Hernandez537d8d92009-09-18 21:34:51 +0000669 }
670
Philip Reames4dbd88f2015-03-24 23:54:54 +0000671 if (isInvariantLoad)
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000672 continue;
Philip Reames4dbd88f2015-03-24 23:54:54 +0000673
Philip Reamesb5681132016-03-25 22:40:35 +0000674 // A release fence requires that all stores complete before it, but does
675 // not prevent the reordering of following loads or stores 'before' the
676 // fence. As a result, we look past it when finding a dependency for
677 // loads. DSE uses this to find preceeding stores to delete and thus we
678 // can't bypass the fence if the query instruction is a store.
679 if (FenceInst *FI = dyn_cast<FenceInst>(Inst))
JF Bastien800f87a2016-04-06 21:19:33 +0000680 if (isLoad && FI->getOrdering() == AtomicOrdering::Release)
Philip Reamesb5681132016-03-25 22:40:35 +0000681 continue;
JF Bastien800f87a2016-04-06 21:19:33 +0000682
Chris Lattner0e3d6332008-12-05 21:04:20 +0000683 // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
Chandler Carruth61440d22016-03-10 00:55:30 +0000684 ModRefInfo MR = AA.getModRefInfo(Inst, MemLoc);
Chad Rosiera968caf2012-05-14 20:35:04 +0000685 // If necessary, perform additional analysis.
Alina Sbirlea63d22502017-12-05 20:12:23 +0000686 if (isModAndRefSet(MR))
Chandler Carruthaef32bd2016-03-11 13:46:00 +0000687 MR = AA.callCapturesBefore(Inst, MemLoc, &DT, &OBB);
Alina Sbirlea50db8a22017-12-21 21:41:53 +0000688 switch (clearMust(MR)) {
Alina Sbirlea193429f2017-12-07 22:41:34 +0000689 case ModRefInfo::NoModRef:
Chris Lattner41efb682008-12-09 19:47:40 +0000690 // If the call has no effect on the queried pointer, just ignore it.
Chris Lattner81f19e92008-11-29 08:51:16 +0000691 continue;
Alina Sbirlea193429f2017-12-07 22:41:34 +0000692 case ModRefInfo::Mod:
Owen Andersonfc16e5a2009-10-28 06:30:52 +0000693 return MemDepResult::getClobber(Inst);
Alina Sbirlea193429f2017-12-07 22:41:34 +0000694 case ModRefInfo::Ref:
Chris Lattner41efb682008-12-09 19:47:40 +0000695 // If the call is known to never store to the pointer, and if this is a
696 // load query, we can safely ignore it (scan past it).
697 if (isLoad)
698 continue;
Galina Kistanova0b69e362017-05-31 22:02:05 +0000699 LLVM_FALLTHROUGH;
Chris Lattner41efb682008-12-09 19:47:40 +0000700 default:
701 // Otherwise, there is a potential dependence. Return a clobber.
702 return MemDepResult::getClobber(Inst);
703 }
Owen Andersonc0daf5f2007-07-06 23:14:35 +0000704 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000705
Eli Friedman7d58bc72011-06-15 00:47:34 +0000706 // No dependence found. If this is the entry block of the function, it is
707 // unknown, otherwise it is non-local.
Chris Lattner2faa2c72008-12-07 02:15:47 +0000708 if (BB != &BB->getParent()->getEntryBlock())
709 return MemDepResult::getNonLocal();
Eli Friedmanc1702c82011-10-13 22:14:57 +0000710 return MemDepResult::getNonFuncLocal();
Owen Andersonc0daf5f2007-07-06 23:14:35 +0000711}
712
Chandler Carruth61440d22016-03-10 00:55:30 +0000713MemDepResult MemoryDependenceResults::getDependency(Instruction *QueryInst) {
Chris Lattner51ba8d02008-11-29 03:47:00 +0000714 Instruction *ScanPos = QueryInst;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000715
Chris Lattner51ba8d02008-11-29 03:47:00 +0000716 // Check for a cached result
Chris Lattner47e81d02008-11-30 23:17:19 +0000717 MemDepResult &LocalCache = LocalDeps[QueryInst];
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000718
Chris Lattnere7d7e132008-11-29 22:02:15 +0000719 // If the cached entry is non-dirty, just return it. Note that this depends
Chris Lattner47e81d02008-11-30 23:17:19 +0000720 // on MemDepResult's default constructing to 'dirty'.
721 if (!LocalCache.isDirty())
722 return LocalCache;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000723
Chris Lattner51ba8d02008-11-29 03:47:00 +0000724 // Otherwise, if we have a dirty entry, we know we can start the scan at that
725 // instruction, which may save us some work.
Chris Lattner47e81d02008-11-30 23:17:19 +0000726 if (Instruction *Inst = LocalCache.getInst()) {
Chris Lattner51ba8d02008-11-29 03:47:00 +0000727 ScanPos = Inst;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000728
Chris Lattnerde4440c2008-12-07 18:39:13 +0000729 RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
Chris Lattner44104272008-11-30 02:52:26 +0000730 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000731
Chris Lattner5a786042008-12-07 01:50:16 +0000732 BasicBlock *QueryParent = QueryInst->getParent();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000733
Chris Lattner51ba8d02008-11-29 03:47:00 +0000734 // Do the scan.
Chris Lattner5a786042008-12-07 01:50:16 +0000735 if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
Piotr Padlewski01659cb2016-11-08 18:20:51 +0000736 // No dependence found. If this is the entry block of the function, it is
Eli Friedman7d58bc72011-06-15 00:47:34 +0000737 // unknown, otherwise it is non-local.
Chris Lattner2faa2c72008-12-07 02:15:47 +0000738 if (QueryParent != &QueryParent->getParent()->getEntryBlock())
739 LocalCache = MemDepResult::getNonLocal();
740 else
Eli Friedmanc1702c82011-10-13 22:14:57 +0000741 LocalCache = MemDepResult::getNonFuncLocal();
Dan Gohman1d760ce2010-11-10 21:51:35 +0000742 } else {
Chandler Carruthac80dc72015-06-17 07:18:54 +0000743 MemoryLocation MemLoc;
Chandler Carruth61440d22016-03-10 00:55:30 +0000744 ModRefInfo MR = GetLocation(QueryInst, MemLoc, TLI);
Dan Gohman1d760ce2010-11-10 21:51:35 +0000745 if (MemLoc.Ptr) {
746 // If we can do a pointer scan, make it happen.
Alina Sbirlead6037eb2017-12-07 00:43:19 +0000747 bool isLoad = !isModSet(MR);
Piotr Padlewski01659cb2016-11-08 18:20:51 +0000748 if (auto *II = dyn_cast<IntrinsicInst>(QueryInst))
Owen Anderson97f0cf32011-05-17 00:05:49 +0000749 isLoad |= II->getIntrinsicID() == Intrinsic::lifetime_start;
Chris Lattnere48c31c2010-11-21 07:34:32 +0000750
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +0000751 LocalCache = getPointerDependencyFrom(
752 MemLoc, isLoad, ScanPos->getIterator(), QueryParent, QueryInst);
Dan Gohman1d760ce2010-11-10 21:51:35 +0000753 } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
Gabor Greifef1ca242010-07-27 22:02:00 +0000754 CallSite QueryCS(QueryInst);
Chandler Carruth61440d22016-03-10 00:55:30 +0000755 bool isReadOnly = AA.onlyReadsMemory(QueryCS);
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +0000756 LocalCache = getCallSiteDependencyFrom(
757 QueryCS, isReadOnly, ScanPos->getIterator(), QueryParent);
Dan Gohman1d760ce2010-11-10 21:51:35 +0000758 } else
759 // Non-memory instruction.
Eli Friedman7d58bc72011-06-15 00:47:34 +0000760 LocalCache = MemDepResult::getUnknown();
Nick Lewycky218a3392009-11-28 21:27:49 +0000761 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000762
Chris Lattner51ba8d02008-11-29 03:47:00 +0000763 // Remember the result!
Chris Lattner47e81d02008-11-30 23:17:19 +0000764 if (Instruction *I = LocalCache.getInst())
Chris Lattner9f1988ab2008-11-29 09:20:15 +0000765 ReverseLocalDeps[I].insert(QueryInst);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000766
Chris Lattner47e81d02008-11-30 23:17:19 +0000767 return LocalCache;
Chris Lattner51ba8d02008-11-29 03:47:00 +0000768}
769
Chris Lattnerf09619d2009-01-22 07:04:01 +0000770#ifndef NDEBUG
Chandler Carruth40e21f22016-03-07 12:30:06 +0000771/// This method is used when -debug is specified to verify that cache arrays
772/// are properly kept sorted.
Chandler Carruth61440d22016-03-10 00:55:30 +0000773static void AssertSorted(MemoryDependenceResults::NonLocalDepInfo &Cache,
Chris Lattnerf09619d2009-01-22 07:04:01 +0000774 int Count = -1) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000775 if (Count == -1)
776 Count = Cache.size();
Craig Toppere30b8ca2016-01-03 19:43:40 +0000777 assert(std::is_sorted(Cache.begin(), Cache.begin() + Count) &&
778 "Cache isn't sorted!");
Chris Lattnerf09619d2009-01-22 07:04:01 +0000779}
780#endif
781
Chandler Carruth61440d22016-03-10 00:55:30 +0000782const MemoryDependenceResults::NonLocalDepInfo &
783MemoryDependenceResults::getNonLocalCallDependency(CallSite QueryCS) {
Chris Lattner254314e2008-12-09 19:38:05 +0000784 assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000785 "getNonLocalCallDependency should only be used on calls with "
786 "non-local deps!");
Chris Lattner254314e2008-12-09 19:38:05 +0000787 PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
Chris Lattner7e61daf2008-12-01 01:15:42 +0000788 NonLocalDepInfo &Cache = CacheP.first;
Chris Lattner20597532008-11-30 01:18:27 +0000789
Chandler Carruth40e21f22016-03-07 12:30:06 +0000790 // This is the set of blocks that need to be recomputed. In the cached case,
791 // this can happen due to instructions being deleted etc. In the uncached
792 // case, this starts out as the set of predecessors we care about.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000793 SmallVector<BasicBlock *, 32> DirtyBlocks;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000794
Chris Lattner20597532008-11-30 01:18:27 +0000795 if (!Cache.empty()) {
Chris Lattner7e61daf2008-12-01 01:15:42 +0000796 // Okay, we have a cache entry. If we know it is not dirty, just return it
797 // with no computation.
798 if (!CacheP.second) {
Dan Gohmand2d1ae12010-06-22 15:08:57 +0000799 ++NumCacheNonLocal;
Chris Lattner7e61daf2008-12-01 01:15:42 +0000800 return Cache;
801 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000802
Chris Lattner20597532008-11-30 01:18:27 +0000803 // If we already have a partially computed set of results, scan them to
Chris Lattner7e61daf2008-12-01 01:15:42 +0000804 // determine what is dirty, seeding our initial DirtyBlocks worklist.
Chandler Carruthaf8321e2016-03-07 15:12:57 +0000805 for (auto &Entry : Cache)
806 if (Entry.getResult().isDirty())
807 DirtyBlocks.push_back(Entry.getBB());
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000808
Chris Lattner7e61daf2008-12-01 01:15:42 +0000809 // Sort the cache so that we can do fast binary search lookups below.
Mandeep Singh Grang97bcade2018-04-01 01:46:51 +0000810 llvm::sort(Cache.begin(), Cache.end());
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000811
Chris Lattner7e61daf2008-12-01 01:15:42 +0000812 ++NumCacheDirtyNonLocal;
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000813 // cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
Chris Lattner20597532008-11-30 01:18:27 +0000814 // << Cache.size() << " cached: " << *QueryInst;
815 } else {
816 // Seed DirtyBlocks with each of the preds of QueryInst's block.
Chris Lattner254314e2008-12-09 19:38:05 +0000817 BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
Daniel Berlinb4e7a4a2015-04-21 21:11:50 +0000818 for (BasicBlock *Pred : PredCache.get(QueryBB))
819 DirtyBlocks.push_back(Pred);
Dan Gohmand2d1ae12010-06-22 15:08:57 +0000820 ++NumUncacheNonLocal;
Chris Lattner20597532008-11-30 01:18:27 +0000821 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000822
Chris Lattner702e46e2008-12-09 21:19:42 +0000823 // isReadonlyCall - If this is a read-only call, we can be more aggressive.
Chandler Carruth61440d22016-03-10 00:55:30 +0000824 bool isReadonlyCall = AA.onlyReadsMemory(QueryCS);
Chris Lattnerff9f3db2008-12-15 03:35:32 +0000825
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000826 SmallPtrSet<BasicBlock *, 32> Visited;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000827
Chris Lattner7e61daf2008-12-01 01:15:42 +0000828 unsigned NumSortedEntries = Cache.size();
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000829 LLVM_DEBUG(AssertSorted(Cache));
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000830
Chris Lattner20597532008-11-30 01:18:27 +0000831 // Iterate while we still have blocks to update.
832 while (!DirtyBlocks.empty()) {
833 BasicBlock *DirtyBB = DirtyBlocks.back();
834 DirtyBlocks.pop_back();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000835
Chris Lattner7e61daf2008-12-01 01:15:42 +0000836 // Already processed this block?
David Blaikie70573dc2014-11-19 07:49:26 +0000837 if (!Visited.insert(DirtyBB).second)
Chris Lattner7e61daf2008-12-01 01:15:42 +0000838 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000839
Chris Lattner7e61daf2008-12-01 01:15:42 +0000840 // Do a binary search to see if we already have an entry for this block in
841 // the cache set. If so, find it.
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000842 LLVM_DEBUG(AssertSorted(Cache, NumSortedEntries));
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000843 NonLocalDepInfo::iterator Entry =
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000844 std::upper_bound(Cache.begin(), Cache.begin() + NumSortedEntries,
845 NonLocalDepEntry(DirtyBB));
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000846 if (Entry != Cache.begin() && std::prev(Entry)->getBB() == DirtyBB)
Chris Lattner7e61daf2008-12-01 01:15:42 +0000847 --Entry;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000848
Craig Topper9f008862014-04-15 04:59:12 +0000849 NonLocalDepEntry *ExistingResult = nullptr;
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000850 if (Entry != Cache.begin() + NumSortedEntries &&
Chris Lattner0c315472009-12-09 07:08:01 +0000851 Entry->getBB() == DirtyBB) {
Chris Lattner7e61daf2008-12-01 01:15:42 +0000852 // If we already have an entry, and if it isn't already dirty, the block
853 // is done.
Chris Lattner0c315472009-12-09 07:08:01 +0000854 if (!Entry->getResult().isDirty())
Chris Lattner7e61daf2008-12-01 01:15:42 +0000855 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000856
Chris Lattner7e61daf2008-12-01 01:15:42 +0000857 // Otherwise, remember this slot so we can update the value.
Chris Lattner0c315472009-12-09 07:08:01 +0000858 ExistingResult = &*Entry;
Chris Lattner7e61daf2008-12-01 01:15:42 +0000859 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000860
Chris Lattner20597532008-11-30 01:18:27 +0000861 // If the dirty entry has a pointer, start scanning from it so we don't have
862 // to rescan the entire block.
863 BasicBlock::iterator ScanPos = DirtyBB->end();
Chris Lattner7e61daf2008-12-01 01:15:42 +0000864 if (ExistingResult) {
Chris Lattner0c315472009-12-09 07:08:01 +0000865 if (Instruction *Inst = ExistingResult->getResult().getInst()) {
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +0000866 ScanPos = Inst->getIterator();
Chris Lattner7e61daf2008-12-01 01:15:42 +0000867 // We're removing QueryInst's use of Inst.
Chris Lattner254314e2008-12-09 19:38:05 +0000868 RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
869 QueryCS.getInstruction());
Chris Lattner7e61daf2008-12-01 01:15:42 +0000870 }
Chris Lattner1b810bd2008-11-30 02:28:25 +0000871 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000872
Chris Lattner60444f82008-11-30 01:26:32 +0000873 // Find out if this block has a local dependency for QueryInst.
Chris Lattnered494f72008-12-07 01:21:14 +0000874 MemDepResult Dep;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000875
Chris Lattner254314e2008-12-09 19:38:05 +0000876 if (ScanPos != DirtyBB->begin()) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000877 Dep =
878 getCallSiteDependencyFrom(QueryCS, isReadonlyCall, ScanPos, DirtyBB);
Chris Lattner254314e2008-12-09 19:38:05 +0000879 } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
880 // No dependence found. If this is the entry block of the function, it is
Eli Friedman7d58bc72011-06-15 00:47:34 +0000881 // a clobber, otherwise it is unknown.
Chris Lattner254314e2008-12-09 19:38:05 +0000882 Dep = MemDepResult::getNonLocal();
Chris Lattner5a786042008-12-07 01:50:16 +0000883 } else {
Eli Friedmanc1702c82011-10-13 22:14:57 +0000884 Dep = MemDepResult::getNonFuncLocal();
Chris Lattner5a786042008-12-07 01:50:16 +0000885 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000886
Chris Lattner7e61daf2008-12-01 01:15:42 +0000887 // If we had a dirty entry for the block, update it. Otherwise, just add
888 // a new entry.
889 if (ExistingResult)
Chris Lattner9b7d99e2009-12-22 04:25:02 +0000890 ExistingResult->setResult(Dep);
Chris Lattner7e61daf2008-12-01 01:15:42 +0000891 else
Chris Lattner9b7d99e2009-12-22 04:25:02 +0000892 Cache.push_back(NonLocalDepEntry(DirtyBB, Dep));
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000893
Chris Lattner20597532008-11-30 01:18:27 +0000894 // If the block has a dependency (i.e. it isn't completely transparent to
Chris Lattner7e61daf2008-12-01 01:15:42 +0000895 // the value), remember the association!
896 if (!Dep.isNonLocal()) {
Chris Lattner20597532008-11-30 01:18:27 +0000897 // Keep the ReverseNonLocalDeps map up to date so we can efficiently
898 // update this when we remove instructions.
Chris Lattner7e61daf2008-12-01 01:15:42 +0000899 if (Instruction *Inst = Dep.getInst())
Chris Lattner254314e2008-12-09 19:38:05 +0000900 ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
Chris Lattner7e61daf2008-12-01 01:15:42 +0000901 } else {
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000902
Chris Lattner7e61daf2008-12-01 01:15:42 +0000903 // If the block *is* completely transparent to the load, we need to check
904 // the predecessors of this block. Add them to our worklist.
Daniel Berlinb4e7a4a2015-04-21 21:11:50 +0000905 for (BasicBlock *Pred : PredCache.get(DirtyBB))
906 DirtyBlocks.push_back(Pred);
Chris Lattner7e61daf2008-12-01 01:15:42 +0000907 }
Chris Lattner20597532008-11-30 01:18:27 +0000908 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000909
Chris Lattner7e61daf2008-12-01 01:15:42 +0000910 return Cache;
Chris Lattner20597532008-11-30 01:18:27 +0000911}
912
Chandler Carruth61440d22016-03-10 00:55:30 +0000913void MemoryDependenceResults::getNonLocalPointerDependency(
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000914 Instruction *QueryInst, SmallVectorImpl<NonLocalDepResult> &Result) {
Chandler Carruthac80dc72015-06-17 07:18:54 +0000915 const MemoryLocation Loc = MemoryLocation::get(QueryInst);
Philip Reames567feb92015-01-09 00:04:22 +0000916 bool isLoad = isa<LoadInst>(QueryInst);
917 BasicBlock *FromBB = QueryInst->getParent();
918 assert(FromBB);
Philip Reames33d7f9d2015-01-09 00:26:45 +0000919
920 assert(Loc.Ptr->getType()->isPointerTy() &&
921 "Can't get pointer deps of a non-pointer!");
922 Result.clear();
Piotr Padlewski95308832017-01-12 11:33:58 +0000923 {
Piotr Padlewski153fe602018-05-18 22:40:34 +0000924 // Check if there is cached Def with invariant.group.
Piotr Padlewski95308832017-01-12 11:33:58 +0000925 auto NonLocalDefIt = NonLocalDefsCache.find(QueryInst);
926 if (NonLocalDefIt != NonLocalDefsCache.end()) {
Piotr Padlewski153fe602018-05-18 22:40:34 +0000927 Result.push_back(NonLocalDefIt->second);
928 ReverseNonLocalDefsCache[NonLocalDefIt->second.getResult().getInst()]
929 .erase(QueryInst);
Piotr Padlewski95308832017-01-12 11:33:58 +0000930 NonLocalDefsCache.erase(NonLocalDefIt);
931 return;
932 }
933 }
Philip Reames33d7f9d2015-01-09 00:26:45 +0000934 // This routine does not expect to deal with volatile instructions.
935 // Doing so would require piping through the QueryInst all the way through.
Philip Reames567feb92015-01-09 00:04:22 +0000936 // TODO: volatiles can't be elided, but they can be reordered with other
Philip Reames33d7f9d2015-01-09 00:26:45 +0000937 // non-volatile accesses.
Philip Reamesa7ad6a52015-01-26 18:54:27 +0000938
Philip Reames567feb92015-01-09 00:04:22 +0000939 // We currently give up on any instruction which is ordered, but we do handle
940 // atomic instructions which are unordered.
941 // TODO: Handle ordered instructions
942 auto isOrdered = [](Instruction *Inst) {
943 if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
944 return !LI->isUnordered();
945 } else if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
946 return !SI->isUnordered();
947 }
948 return false;
949 };
Philip Reames33d7f9d2015-01-09 00:26:45 +0000950 if (isVolatile(QueryInst) || isOrdered(QueryInst)) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000951 Result.push_back(NonLocalDepResult(FromBB, MemDepResult::getUnknown(),
Philip Reames33d7f9d2015-01-09 00:26:45 +0000952 const_cast<Value *>(Loc.Ptr)));
953 return;
954 }
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000955 const DataLayout &DL = FromBB->getModule()->getDataLayout();
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000956 PHITransAddr Address(const_cast<Value *>(Loc.Ptr), DL, &AC);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000957
Chris Lattnerff9f3db2008-12-15 03:35:32 +0000958 // This is the set of blocks we've inspected, and the pointer we consider in
959 // each block. Because of critical edges, we currently bail out if querying
960 // a block with multiple different pointers. This can happen during PHI
961 // translation.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000962 DenseMap<BasicBlock *, Value *> Visited;
Chandler Carruthb32febe2016-03-07 12:45:07 +0000963 if (getNonLocalPointerDepFromBB(QueryInst, Address, Loc, isLoad, FromBB,
Chris Lattnerff9f3db2008-12-15 03:35:32 +0000964 Result, Visited, true))
965 return;
Chris Lattner7ed5ccc2008-12-15 04:58:29 +0000966 Result.clear();
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000967 Result.push_back(NonLocalDepResult(FromBB, MemDepResult::getUnknown(),
Dan Gohman23483932010-09-22 21:41:02 +0000968 const_cast<Value *>(Loc.Ptr)));
Chris Lattner7564a3b2008-12-07 02:56:57 +0000969}
970
Chandler Carruth40e21f22016-03-07 12:30:06 +0000971/// Compute the memdep value for BB with Pointer/PointeeSize using either
972/// cached information in Cache or by doing a lookup (which may use dirty cache
973/// info if available).
974///
975/// If we do a lookup, add the result to the cache.
Chandler Carruth61440d22016-03-10 00:55:30 +0000976MemDepResult MemoryDependenceResults::GetNonLocalInfoForBlock(
Chandler Carruthac80dc72015-06-17 07:18:54 +0000977 Instruction *QueryInst, const MemoryLocation &Loc, bool isLoad,
978 BasicBlock *BB, NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000979
Chris Lattnerf903fe12008-12-09 07:47:11 +0000980 // Do a binary search to see if we already have an entry for this block in
981 // the cache set. If so, find it.
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000982 NonLocalDepInfo::iterator Entry = std::upper_bound(
983 Cache->begin(), Cache->begin() + NumSortedEntries, NonLocalDepEntry(BB));
984 if (Entry != Cache->begin() && (Entry - 1)->getBB() == BB)
Chris Lattnerf903fe12008-12-09 07:47:11 +0000985 --Entry;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000986
Craig Topper9f008862014-04-15 04:59:12 +0000987 NonLocalDepEntry *ExistingResult = nullptr;
Chandler Carruth60fb1b42016-03-07 10:19:30 +0000988 if (Entry != Cache->begin() + NumSortedEntries && Entry->getBB() == BB)
Chris Lattner0c315472009-12-09 07:08:01 +0000989 ExistingResult = &*Entry;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000990
Chris Lattnerf903fe12008-12-09 07:47:11 +0000991 // If we have a cached entry, and it is non-dirty, use it as the value for
992 // this dependency.
Chris Lattner0c315472009-12-09 07:08:01 +0000993 if (ExistingResult && !ExistingResult->getResult().isDirty()) {
Chris Lattnerf903fe12008-12-09 07:47:11 +0000994 ++NumCacheNonLocalPtr;
Chris Lattner0c315472009-12-09 07:08:01 +0000995 return ExistingResult->getResult();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +0000996 }
997
Chris Lattnerf903fe12008-12-09 07:47:11 +0000998 // Otherwise, we have to scan for the value. If we have a dirty cache
999 // entry, start scanning from its position, otherwise we scan from the end
1000 // of the block.
1001 BasicBlock::iterator ScanPos = BB->end();
Chris Lattner0c315472009-12-09 07:08:01 +00001002 if (ExistingResult && ExistingResult->getResult().getInst()) {
1003 assert(ExistingResult->getResult().getInst()->getParent() == BB &&
Chris Lattnerf903fe12008-12-09 07:47:11 +00001004 "Instruction invalidated?");
1005 ++NumCacheDirtyNonLocalPtr;
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +00001006 ScanPos = ExistingResult->getResult().getInst()->getIterator();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001007
Chris Lattnerf903fe12008-12-09 07:47:11 +00001008 // Eliminating the dirty entry from 'Cache', so update the reverse info.
Dan Gohman23483932010-09-22 21:41:02 +00001009 ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +00001010 RemoveFromReverseMap(ReverseNonLocalPtrDeps, &*ScanPos, CacheKey);
Chris Lattnerf903fe12008-12-09 07:47:11 +00001011 } else {
1012 ++NumUncacheNonLocalPtr;
1013 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001014
Chris Lattnerf903fe12008-12-09 07:47:11 +00001015 // Scan the block for the dependency.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001016 MemDepResult Dep =
1017 getPointerDependencyFrom(Loc, isLoad, ScanPos, BB, QueryInst);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001018
Chris Lattnerf903fe12008-12-09 07:47:11 +00001019 // If we had a dirty entry for the block, update it. Otherwise, just add
1020 // a new entry.
1021 if (ExistingResult)
Chris Lattner9b7d99e2009-12-22 04:25:02 +00001022 ExistingResult->setResult(Dep);
Chris Lattnerf903fe12008-12-09 07:47:11 +00001023 else
Chris Lattner9b7d99e2009-12-22 04:25:02 +00001024 Cache->push_back(NonLocalDepEntry(BB, Dep));
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001025
Chris Lattnerf903fe12008-12-09 07:47:11 +00001026 // If the block has a dependency (i.e. it isn't completely transparent to
1027 // the value), remember the reverse association because we just added it
1028 // to Cache!
Eli Friedmanc1702c82011-10-13 22:14:57 +00001029 if (!Dep.isDef() && !Dep.isClobber())
Chris Lattnerf903fe12008-12-09 07:47:11 +00001030 return Dep;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001031
Chris Lattnerf903fe12008-12-09 07:47:11 +00001032 // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
1033 // update MemDep when we remove instructions.
1034 Instruction *Inst = Dep.getInst();
1035 assert(Inst && "Didn't depend on anything?");
Dan Gohman23483932010-09-22 21:41:02 +00001036 ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
Chris Lattner8eda11b2009-03-29 00:24:04 +00001037 ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
Chris Lattnerf903fe12008-12-09 07:47:11 +00001038 return Dep;
1039}
1040
Chandler Carruth40e21f22016-03-07 12:30:06 +00001041/// Sort the NonLocalDepInfo cache, given a certain number of elements in the
1042/// array that are already properly ordered.
1043///
1044/// This is optimized for the case when only a few entries are added.
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001045static void
Chandler Carruth61440d22016-03-10 00:55:30 +00001046SortNonLocalDepInfoCache(MemoryDependenceResults::NonLocalDepInfo &Cache,
Chris Lattner370aada2009-07-13 17:20:05 +00001047 unsigned NumSortedEntries) {
1048 switch (Cache.size() - NumSortedEntries) {
1049 case 0:
1050 // done, no new entries.
1051 break;
1052 case 2: {
1053 // Two new entries, insert the last one into place.
Chris Lattner0c315472009-12-09 07:08:01 +00001054 NonLocalDepEntry Val = Cache.back();
Chris Lattner370aada2009-07-13 17:20:05 +00001055 Cache.pop_back();
Chandler Carruth61440d22016-03-10 00:55:30 +00001056 MemoryDependenceResults::NonLocalDepInfo::iterator Entry =
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001057 std::upper_bound(Cache.begin(), Cache.end() - 1, Val);
Chris Lattner370aada2009-07-13 17:20:05 +00001058 Cache.insert(Entry, Val);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001059 LLVM_FALLTHROUGH;
Chris Lattner370aada2009-07-13 17:20:05 +00001060 }
1061 case 1:
1062 // One new entry, Just insert the new value at the appropriate position.
1063 if (Cache.size() != 1) {
Chris Lattner0c315472009-12-09 07:08:01 +00001064 NonLocalDepEntry Val = Cache.back();
Chris Lattner370aada2009-07-13 17:20:05 +00001065 Cache.pop_back();
Chandler Carruth61440d22016-03-10 00:55:30 +00001066 MemoryDependenceResults::NonLocalDepInfo::iterator Entry =
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001067 std::upper_bound(Cache.begin(), Cache.end(), Val);
Chris Lattner370aada2009-07-13 17:20:05 +00001068 Cache.insert(Entry, Val);
1069 }
1070 break;
1071 default:
1072 // Added many values, do a full scale sort.
Mandeep Singh Grang97bcade2018-04-01 01:46:51 +00001073 llvm::sort(Cache.begin(), Cache.end());
Chris Lattner370aada2009-07-13 17:20:05 +00001074 break;
1075 }
1076}
1077
Chandler Carruth40e21f22016-03-07 12:30:06 +00001078/// Perform a dependency query based on pointer/pointeesize starting at the end
1079/// of StartBB.
1080///
1081/// Add any clobber/def results to the results vector and keep track of which
1082/// blocks are visited in 'Visited'.
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001083///
1084/// This has special behavior for the first block queries (when SkipFirstBlock
1085/// is true). In this special case, it ignores the contents of the specified
1086/// block and starts returning dependence info for its predecessors.
1087///
Chandler Carruthb32febe2016-03-07 12:45:07 +00001088/// This function returns true on success, or false to indicate that it could
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001089/// not compute dependence information for some reason. This should be treated
1090/// as a clobber dependence on the first instruction in the predecessor block.
Chandler Carruth61440d22016-03-10 00:55:30 +00001091bool MemoryDependenceResults::getNonLocalPointerDepFromBB(
Chandler Carruthac80dc72015-06-17 07:18:54 +00001092 Instruction *QueryInst, const PHITransAddr &Pointer,
1093 const MemoryLocation &Loc, bool isLoad, BasicBlock *StartBB,
1094 SmallVectorImpl<NonLocalDepResult> &Result,
1095 DenseMap<BasicBlock *, Value *> &Visited, bool SkipFirstBlock) {
Chris Lattnera28355d2008-12-07 08:50:20 +00001096 // Look up the cached info for Pointer.
Chris Lattner972e6d82009-12-09 01:59:31 +00001097 ValueIsLoadPair CacheKey(Pointer.getAddr(), isLoad);
Dan Gohman23483932010-09-22 21:41:02 +00001098
Dan Gohman0a6021a2010-11-10 20:37:15 +00001099 // Set up a temporary NLPI value. If the map doesn't yet have an entry for
1100 // CacheKey, this value will be inserted as the associated value. Otherwise,
1101 // it'll be ignored, and we'll have to check to see if the cached size and
Hal Finkelcc39b672014-07-24 12:16:19 +00001102 // aa tags are consistent with the current query.
Dan Gohman0a6021a2010-11-10 20:37:15 +00001103 NonLocalPointerInfo InitialNLPI;
1104 InitialNLPI.Size = Loc.Size;
Hal Finkelcc39b672014-07-24 12:16:19 +00001105 InitialNLPI.AATags = Loc.AATags;
Dan Gohman0a6021a2010-11-10 20:37:15 +00001106
1107 // Get the NLPI for CacheKey, inserting one into the map if it doesn't
1108 // already have one.
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001109 std::pair<CachedNonLocalPointerInfo::iterator, bool> Pair =
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001110 NonLocalPointerDeps.insert(std::make_pair(CacheKey, InitialNLPI));
Dan Gohman0a6021a2010-11-10 20:37:15 +00001111 NonLocalPointerInfo *CacheInfo = &Pair.first->second;
1112
Dan Gohman2e8ca442010-11-10 21:45:11 +00001113 // If we already have a cache entry for this CacheKey, we may need to do some
1114 // work to reconcile the cache entry and the current query.
Dan Gohman0a6021a2010-11-10 20:37:15 +00001115 if (!Pair.second) {
Reid Kleckner6d310012017-12-28 05:10:33 +00001116 if (CacheInfo->Size < Loc.Size) {
1117 // The query's Size is greater than the cached one. Throw out the
1118 // cached data and proceed with the query at the greater size.
Dan Gohman2e8ca442010-11-10 21:45:11 +00001119 CacheInfo->Pair = BBSkipFirstBlockPair();
1120 CacheInfo->Size = Loc.Size;
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001121 for (auto &Entry : CacheInfo->NonLocalDeps)
1122 if (Instruction *Inst = Entry.getResult().getInst())
Dan Gohman67919362010-11-10 22:35:02 +00001123 RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
Dan Gohman2e8ca442010-11-10 21:45:11 +00001124 CacheInfo->NonLocalDeps.clear();
Reid Kleckner6d310012017-12-28 05:10:33 +00001125 } else if (CacheInfo->Size > Loc.Size) {
1126 // This query's Size is less than the cached one. Conservatively restart
1127 // the query using the greater size.
1128 return getNonLocalPointerDepFromBB(
1129 QueryInst, Pointer, Loc.getWithNewSize(CacheInfo->Size), isLoad,
1130 StartBB, Result, Visited, SkipFirstBlock);
Dan Gohman0a6021a2010-11-10 20:37:15 +00001131 }
1132
Hal Finkelcc39b672014-07-24 12:16:19 +00001133 // If the query's AATags are inconsistent with the cached one,
Dan Gohman2e8ca442010-11-10 21:45:11 +00001134 // conservatively throw out the cached data and restart the query with
1135 // no tag if needed.
Hal Finkelcc39b672014-07-24 12:16:19 +00001136 if (CacheInfo->AATags != Loc.AATags) {
1137 if (CacheInfo->AATags) {
Dan Gohman2e8ca442010-11-10 21:45:11 +00001138 CacheInfo->Pair = BBSkipFirstBlockPair();
Hal Finkelcc39b672014-07-24 12:16:19 +00001139 CacheInfo->AATags = AAMDNodes();
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001140 for (auto &Entry : CacheInfo->NonLocalDeps)
1141 if (Instruction *Inst = Entry.getResult().getInst())
Dan Gohman67919362010-11-10 22:35:02 +00001142 RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
Dan Gohman2e8ca442010-11-10 21:45:11 +00001143 CacheInfo->NonLocalDeps.clear();
1144 }
Hal Finkelcc39b672014-07-24 12:16:19 +00001145 if (Loc.AATags)
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001146 return getNonLocalPointerDepFromBB(
1147 QueryInst, Pointer, Loc.getWithoutAATags(), isLoad, StartBB, Result,
1148 Visited, SkipFirstBlock);
Dan Gohman0a6021a2010-11-10 20:37:15 +00001149 }
Dan Gohman23483932010-09-22 21:41:02 +00001150 }
1151
1152 NonLocalDepInfo *Cache = &CacheInfo->NonLocalDeps;
Chris Lattner5ed409e2008-12-08 07:31:50 +00001153
1154 // If we have valid cached information for exactly the block we are
1155 // investigating, just return it with no recomputation.
Dan Gohman23483932010-09-22 21:41:02 +00001156 if (CacheInfo->Pair == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
Chris Lattner8b4be372008-12-16 07:10:09 +00001157 // We have a fully cached result for this query then we can just return the
1158 // cached results and populate the visited set. However, we have to verify
1159 // that we don't already have conflicting results for these blocks. Check
1160 // to ensure that if a block in the results set is in the visited set that
1161 // it was for the same pointer query.
1162 if (!Visited.empty()) {
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001163 for (auto &Entry : *Cache) {
1164 DenseMap<BasicBlock *, Value *>::iterator VI =
1165 Visited.find(Entry.getBB());
Chris Lattner972e6d82009-12-09 01:59:31 +00001166 if (VI == Visited.end() || VI->second == Pointer.getAddr())
1167 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001168
Chandler Carruthb32febe2016-03-07 12:45:07 +00001169 // We have a pointer mismatch in a block. Just return false, saying
Chris Lattner8b4be372008-12-16 07:10:09 +00001170 // that something was clobbered in this result. We could also do a
1171 // non-fully cached query, but there is little point in doing this.
Chandler Carruthb32febe2016-03-07 12:45:07 +00001172 return false;
Chris Lattner8b4be372008-12-16 07:10:09 +00001173 }
1174 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001175
Chris Lattner9b7d99e2009-12-22 04:25:02 +00001176 Value *Addr = Pointer.getAddr();
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001177 for (auto &Entry : *Cache) {
1178 Visited.insert(std::make_pair(Entry.getBB(), Addr));
1179 if (Entry.getResult().isNonLocal()) {
Matt Arsenaultc23753a2013-05-06 02:07:24 +00001180 continue;
1181 }
1182
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001183 if (DT.isReachableFromEntry(Entry.getBB())) {
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001184 Result.push_back(
1185 NonLocalDepResult(Entry.getBB(), Entry.getResult(), Addr));
Matt Arsenaultc23753a2013-05-06 02:07:24 +00001186 }
Chris Lattner8b4be372008-12-16 07:10:09 +00001187 }
Chris Lattner5ed409e2008-12-08 07:31:50 +00001188 ++NumCacheCompleteNonLocalPtr;
Chandler Carruthb32febe2016-03-07 12:45:07 +00001189 return true;
Chris Lattner5ed409e2008-12-08 07:31:50 +00001190 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001191
Chris Lattner5ed409e2008-12-08 07:31:50 +00001192 // Otherwise, either this is a new block, a block with an invalid cache
1193 // pointer or one that we're about to invalidate by putting more info into it
1194 // than its valid cache info. If empty, the result will be valid cache info,
1195 // otherwise it isn't.
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001196 if (Cache->empty())
Dan Gohman23483932010-09-22 21:41:02 +00001197 CacheInfo->Pair = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
Dan Gohmanc87c8432010-11-11 00:42:22 +00001198 else
Dan Gohman23483932010-09-22 21:41:02 +00001199 CacheInfo->Pair = BBSkipFirstBlockPair();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001200
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001201 SmallVector<BasicBlock *, 32> Worklist;
Chris Lattner5ed409e2008-12-08 07:31:50 +00001202 Worklist.push_back(StartBB);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001203
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001204 // PredList used inside loop.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001205 SmallVector<std::pair<BasicBlock *, PHITransAddr>, 16> PredList;
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001206
Chris Lattnera28355d2008-12-07 08:50:20 +00001207 // Keep track of the entries that we know are sorted. Previously cached
1208 // entries will all be sorted. The entries we add we only sort on demand (we
1209 // don't insert every element into its sorted position). We know that we
1210 // won't get any reuse from currently inserted values, because we don't
1211 // revisit blocks after we insert info for them.
1212 unsigned NumSortedEntries = Cache->size();
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +00001213 unsigned WorklistEntries = BlockNumberLimit;
1214 bool GotWorklistLimit = false;
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001215 LLVM_DEBUG(AssertSorted(*Cache));
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001216
Chris Lattner2faa2c72008-12-07 02:15:47 +00001217 while (!Worklist.empty()) {
Chris Lattner7564a3b2008-12-07 02:56:57 +00001218 BasicBlock *BB = Worklist.pop_back_val();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001219
Bruno Cardoso Lopese3c513a2014-10-01 20:07:13 +00001220 // If we do process a large number of blocks it becomes very expensive and
1221 // likely it isn't worth worrying about
1222 if (Result.size() > NumResultsLimit) {
1223 Worklist.clear();
1224 // Sort it now (if needed) so that recursive invocations of
1225 // getNonLocalPointerDepFromBB and other routines that could reuse the
1226 // cache value will only see properly sorted cache arrays.
1227 if (Cache && NumSortedEntries != Cache->size()) {
1228 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Bruno Cardoso Lopese3c513a2014-10-01 20:07:13 +00001229 }
1230 // Since we bail out, the "Cache" set won't contain all of the
1231 // results for the query. This is ok (we can still use it to accelerate
1232 // specific block queries) but we can't do the fastpath "return all
1233 // results from the set". Clear out the indicator for this.
1234 CacheInfo->Pair = BBSkipFirstBlockPair();
Chandler Carruthb32febe2016-03-07 12:45:07 +00001235 return false;
Bruno Cardoso Lopese3c513a2014-10-01 20:07:13 +00001236 }
1237
Chris Lattner75510d82008-12-09 07:52:59 +00001238 // Skip the first block if we have it.
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001239 if (!SkipFirstBlock) {
Chris Lattner75510d82008-12-09 07:52:59 +00001240 // Analyze the dependency of *Pointer in FromBB. See if we already have
1241 // been here.
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001242 assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
Chris Lattnera28355d2008-12-07 08:50:20 +00001243
Chris Lattner75510d82008-12-09 07:52:59 +00001244 // Get the dependency info for Pointer in BB. If we have cached
1245 // information, we will use it, otherwise we compute it.
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001246 LLVM_DEBUG(AssertSorted(*Cache, NumSortedEntries));
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001247 MemDepResult Dep = GetNonLocalInfoForBlock(QueryInst, Loc, isLoad, BB,
1248 Cache, NumSortedEntries);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001249
Chris Lattner75510d82008-12-09 07:52:59 +00001250 // If we got a Def or Clobber, add this to the list of results.
Matt Arsenaultc23753a2013-05-06 02:07:24 +00001251 if (!Dep.isNonLocal()) {
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001252 if (DT.isReachableFromEntry(BB)) {
Matt Arsenaultc23753a2013-05-06 02:07:24 +00001253 Result.push_back(NonLocalDepResult(BB, Dep, Pointer.getAddr()));
1254 continue;
1255 }
Chris Lattner75510d82008-12-09 07:52:59 +00001256 }
Chris Lattner2faa2c72008-12-07 02:15:47 +00001257 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001258
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001259 // If 'Pointer' is an instruction defined in this block, then we need to do
1260 // phi translation to change it into a value live in the predecessor block.
Chris Lattner972e6d82009-12-09 01:59:31 +00001261 // If not, we just add the predecessors to the worklist and scan them with
1262 // the same Pointer.
1263 if (!Pointer.NeedsPHITranslationFromBlock(BB)) {
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001264 SkipFirstBlock = false;
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001265 SmallVector<BasicBlock *, 16> NewBlocks;
Daniel Berlinb4e7a4a2015-04-21 21:11:50 +00001266 for (BasicBlock *Pred : PredCache.get(BB)) {
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001267 // Verify that we haven't looked at this block yet.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001268 std::pair<DenseMap<BasicBlock *, Value *>::iterator, bool> InsertRes =
1269 Visited.insert(std::make_pair(Pred, Pointer.getAddr()));
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001270 if (InsertRes.second) {
1271 // First time we've looked at *PI.
Daniel Berlinb4e7a4a2015-04-21 21:11:50 +00001272 NewBlocks.push_back(Pred);
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001273 continue;
1274 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001275
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001276 // If we have seen this block before, but it was with a different
1277 // pointer then we have a phi translation failure and we have to treat
1278 // this as a clobber.
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001279 if (InsertRes.first->second != Pointer.getAddr()) {
1280 // Make sure to clean up the Visited map before continuing on to
1281 // PredTranslationFailure.
1282 for (unsigned i = 0; i < NewBlocks.size(); i++)
1283 Visited.erase(NewBlocks[i]);
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001284 goto PredTranslationFailure;
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001285 }
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001286 }
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +00001287 if (NewBlocks.size() > WorklistEntries) {
1288 // Make sure to clean up the Visited map before continuing on to
1289 // PredTranslationFailure.
1290 for (unsigned i = 0; i < NewBlocks.size(); i++)
1291 Visited.erase(NewBlocks[i]);
1292 GotWorklistLimit = true;
1293 goto PredTranslationFailure;
1294 }
1295 WorklistEntries -= NewBlocks.size();
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001296 Worklist.append(NewBlocks.begin(), NewBlocks.end());
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001297 continue;
1298 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001299
Chris Lattner972e6d82009-12-09 01:59:31 +00001300 // We do need to do phi translation, if we know ahead of time we can't phi
1301 // translate this value, don't even try.
1302 if (!Pointer.IsPotentiallyPHITranslatable())
1303 goto PredTranslationFailure;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001304
Chris Lattner2f0c1c42009-07-13 17:14:23 +00001305 // We may have added values to the cache list before this PHI translation.
1306 // If so, we haven't done anything to ensure that the cache remains sorted.
1307 // Sort it now (if needed) so that recursive invocations of
1308 // getNonLocalPointerDepFromBB and other routines that could reuse the cache
1309 // value will only see properly sorted cache arrays.
1310 if (Cache && NumSortedEntries != Cache->size()) {
Chris Lattner370aada2009-07-13 17:20:05 +00001311 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Chris Lattner2f0c1c42009-07-13 17:14:23 +00001312 NumSortedEntries = Cache->size();
1313 }
Craig Topper9f008862014-04-15 04:59:12 +00001314 Cache = nullptr;
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001315
1316 PredList.clear();
Daniel Berlinb4e7a4a2015-04-21 21:11:50 +00001317 for (BasicBlock *Pred : PredCache.get(BB)) {
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001318 PredList.push_back(std::make_pair(Pred, Pointer));
1319
Chris Lattner972e6d82009-12-09 01:59:31 +00001320 // Get the PHI translated pointer in this predecessor. This can fail if
1321 // not translatable, in which case the getAddr() returns null.
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001322 PHITransAddr &PredPointer = PredList.back().second;
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001323 PredPointer.PHITranslateValue(BB, Pred, &DT, /*MustDominate=*/false);
Chris Lattner972e6d82009-12-09 01:59:31 +00001324 Value *PredPtrVal = PredPointer.getAddr();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001325
Chris Lattnerac323292009-11-27 08:37:22 +00001326 // Check to see if we have already visited this pred block with another
1327 // pointer. If so, we can't do this lookup. This failure can occur
1328 // with PHI translation when a critical edge exists and the PHI node in
1329 // the successor translates to a pointer value different than the
1330 // pointer the block was first analyzed with.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001331 std::pair<DenseMap<BasicBlock *, Value *>::iterator, bool> InsertRes =
1332 Visited.insert(std::make_pair(Pred, PredPtrVal));
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001333
Chris Lattnerac323292009-11-27 08:37:22 +00001334 if (!InsertRes.second) {
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001335 // We found the pred; take it off the list of preds to visit.
1336 PredList.pop_back();
1337
Chris Lattnerac323292009-11-27 08:37:22 +00001338 // If the predecessor was visited with PredPtr, then we already did
1339 // the analysis and can ignore it.
Chris Lattner972e6d82009-12-09 01:59:31 +00001340 if (InsertRes.first->second == PredPtrVal)
Chris Lattnerac323292009-11-27 08:37:22 +00001341 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001342
Chris Lattnerac323292009-11-27 08:37:22 +00001343 // Otherwise, the block was previously analyzed with a different
1344 // pointer. We can't represent the result of this case, so we just
1345 // treat this as a phi translation failure.
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001346
1347 // Make sure to clean up the Visited map before continuing on to
1348 // PredTranslationFailure.
Matt Arsenault2080ecd2013-03-29 18:48:42 +00001349 for (unsigned i = 0, n = PredList.size(); i < n; ++i)
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001350 Visited.erase(PredList[i].first);
1351
Chris Lattnerac323292009-11-27 08:37:22 +00001352 goto PredTranslationFailure;
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001353 }
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001354 }
1355
1356 // Actually process results here; this need to be a separate loop to avoid
1357 // calling getNonLocalPointerDepFromBB for blocks we don't want to return
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001358 // any results for. (getNonLocalPointerDepFromBB will modify our
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001359 // datastructures in ways the code after the PredTranslationFailure label
1360 // doesn't expect.)
Matt Arsenault2080ecd2013-03-29 18:48:42 +00001361 for (unsigned i = 0, n = PredList.size(); i < n; ++i) {
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001362 BasicBlock *Pred = PredList[i].first;
1363 PHITransAddr &PredPointer = PredList[i].second;
1364 Value *PredPtrVal = PredPointer.getAddr();
1365
1366 bool CanTranslate = true;
Chris Lattner2be52e72009-11-27 22:05:15 +00001367 // If PHI translation was unable to find an available pointer in this
1368 // predecessor, then we have to assume that the pointer is clobbered in
1369 // that predecessor. We can still do PRE of the load, which would insert
1370 // a computation of the pointer in this predecessor.
Craig Topper9f008862014-04-15 04:59:12 +00001371 if (!PredPtrVal)
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001372 CanTranslate = false;
1373
1374 // FIXME: it is entirely possible that PHI translating will end up with
1375 // the same value. Consider PHI translating something like:
1376 // X = phi [x, bb1], [y, bb2]. PHI translating for bb1 doesn't *need*
1377 // to recurse here, pedantically speaking.
1378
1379 // If getNonLocalPointerDepFromBB fails here, that means the cached
1380 // result conflicted with the Visited list; we have to conservatively
Eli Friedman7d58bc72011-06-15 00:47:34 +00001381 // assume it is unknown, but this also does not block PRE of the load.
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001382 if (!CanTranslate ||
Chandler Carruthb32febe2016-03-07 12:45:07 +00001383 !getNonLocalPointerDepFromBB(QueryInst, PredPointer,
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001384 Loc.getWithNewPtr(PredPtrVal), isLoad,
1385 Pred, Result, Visited)) {
Chris Lattner9c2053b2009-12-01 07:33:32 +00001386 // Add the entry to the Result list.
Eli Friedman7d58bc72011-06-15 00:47:34 +00001387 NonLocalDepResult Entry(Pred, MemDepResult::getUnknown(), PredPtrVal);
Chris Lattner9c2053b2009-12-01 07:33:32 +00001388 Result.push_back(Entry);
1389
Chris Lattner25bf6f82009-12-19 21:29:22 +00001390 // Since we had a phi translation failure, the cache for CacheKey won't
1391 // include all of the entries that we need to immediately satisfy future
1392 // queries. Mark this in NonLocalPointerDeps by setting the
1393 // BBSkipFirstBlockPair pointer to null. This requires reuse of the
1394 // cached value to do more work but not miss the phi trans failure.
Dan Gohman23483932010-09-22 21:41:02 +00001395 NonLocalPointerInfo &NLPI = NonLocalPointerDeps[CacheKey];
1396 NLPI.Pair = BBSkipFirstBlockPair();
Chris Lattner2be52e72009-11-27 22:05:15 +00001397 continue;
Chris Lattner2be52e72009-11-27 22:05:15 +00001398 }
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001399 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001400
Chris Lattnerac323292009-11-27 08:37:22 +00001401 // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
1402 CacheInfo = &NonLocalPointerDeps[CacheKey];
Dan Gohman23483932010-09-22 21:41:02 +00001403 Cache = &CacheInfo->NonLocalDeps;
Chris Lattnerac323292009-11-27 08:37:22 +00001404 NumSortedEntries = Cache->size();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001405
Chris Lattnerac323292009-11-27 08:37:22 +00001406 // Since we did phi translation, the "Cache" set won't contain all of the
1407 // results for the query. This is ok (we can still use it to accelerate
1408 // specific block queries) but we can't do the fastpath "return all
1409 // results from the set" Clear out the indicator for this.
Dan Gohman23483932010-09-22 21:41:02 +00001410 CacheInfo->Pair = BBSkipFirstBlockPair();
Chris Lattnerac323292009-11-27 08:37:22 +00001411 SkipFirstBlock = false;
1412 continue;
Chris Lattnerc49f5ac2009-11-26 23:18:49 +00001413
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001414 PredTranslationFailure:
Eli Friedman4b6eeb92011-06-01 23:16:53 +00001415 // The following code is "failure"; we can't produce a sane translation
1416 // for the given block. It assumes that we haven't modified any of
1417 // our datastructures while processing the current block.
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001418
Craig Topper9f008862014-04-15 04:59:12 +00001419 if (!Cache) {
Chris Lattner3f4591c2009-01-23 07:12:16 +00001420 // Refresh the CacheInfo/Cache pointer if it got invalidated.
1421 CacheInfo = &NonLocalPointerDeps[CacheKey];
Dan Gohman23483932010-09-22 21:41:02 +00001422 Cache = &CacheInfo->NonLocalDeps;
Chris Lattner3f4591c2009-01-23 07:12:16 +00001423 NumSortedEntries = Cache->size();
Chris Lattner3f4591c2009-01-23 07:12:16 +00001424 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001425
Chris Lattner25bf6f82009-12-19 21:29:22 +00001426 // Since we failed phi translation, the "Cache" set won't contain all of the
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001427 // results for the query. This is ok (we can still use it to accelerate
1428 // specific block queries) but we can't do the fastpath "return all
Chris Lattner25bf6f82009-12-19 21:29:22 +00001429 // results from the set". Clear out the indicator for this.
Dan Gohman23483932010-09-22 21:41:02 +00001430 CacheInfo->Pair = BBSkipFirstBlockPair();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001431
Eli Friedman7d58bc72011-06-15 00:47:34 +00001432 // If *nothing* works, mark the pointer as unknown.
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001433 //
1434 // If this is the magic first block, return this as a clobber of the whole
1435 // incoming value. Since we can't phi translate to one of the predecessors,
1436 // we have to bail out.
1437 if (SkipFirstBlock)
Chandler Carruthb32febe2016-03-07 12:45:07 +00001438 return false;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001439
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +00001440 bool foundBlock = false;
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001441 for (NonLocalDepEntry &I : llvm::reverse(*Cache)) {
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +00001442 if (I.getBB() != BB)
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001443 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001444
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001445 assert((GotWorklistLimit || I.getResult().isNonLocal() ||
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001446 !DT.isReachableFromEntry(BB)) &&
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001447 "Should only be here with transparent block");
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +00001448 foundBlock = true;
1449 I.setResult(MemDepResult::getUnknown());
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001450 Result.push_back(
1451 NonLocalDepResult(I.getBB(), I.getResult(), Pointer.getAddr()));
Chris Lattnerff9f3db2008-12-15 03:35:32 +00001452 break;
Chris Lattner7564a3b2008-12-07 02:56:57 +00001453 }
Mehdi Amini89038a12016-04-02 05:34:19 +00001454 (void)foundBlock; (void)GotWorklistLimit;
Joerg Sonnenberger36894dc2016-02-20 11:24:44 +00001455 assert((foundBlock || GotWorklistLimit) && "Current block not in cache?");
Chris Lattner2faa2c72008-12-07 02:15:47 +00001456 }
Chris Lattner3f4591c2009-01-23 07:12:16 +00001457
Chris Lattnerf903fe12008-12-09 07:47:11 +00001458 // Okay, we're done now. If we added new values to the cache, re-sort it.
Chris Lattner370aada2009-07-13 17:20:05 +00001459 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001460 LLVM_DEBUG(AssertSorted(*Cache));
Chandler Carruthb32febe2016-03-07 12:45:07 +00001461 return true;
Chris Lattnera28355d2008-12-07 08:50:20 +00001462}
1463
Piotr Padlewski153fe602018-05-18 22:40:34 +00001464/// If P exists in CachedNonLocalPointerInfo or NonLocalDefsCache, remove it.
Chandler Carruth61440d22016-03-10 00:55:30 +00001465void MemoryDependenceResults::RemoveCachedNonLocalPointerDependencies(
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001466 ValueIsLoadPair P) {
Piotr Padlewski153fe602018-05-18 22:40:34 +00001467
1468 // Most of the time this cache is empty.
1469 if (!NonLocalDefsCache.empty()) {
1470 auto it = NonLocalDefsCache.find(P.getPointer());
1471 if (it != NonLocalDefsCache.end()) {
1472 RemoveFromReverseMap(ReverseNonLocalDefsCache,
1473 it->second.getResult().getInst(), P.getPointer());
1474 NonLocalDefsCache.erase(it);
1475 }
1476
1477 if (auto *I = dyn_cast<Instruction>(P.getPointer())) {
1478 auto toRemoveIt = ReverseNonLocalDefsCache.find(I);
1479 if (toRemoveIt != ReverseNonLocalDefsCache.end()) {
1480 for (const auto &entry : toRemoveIt->second)
1481 NonLocalDefsCache.erase(entry);
1482 ReverseNonLocalDefsCache.erase(toRemoveIt);
1483 }
1484 }
1485 }
1486
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001487 CachedNonLocalPointerInfo::iterator It = NonLocalPointerDeps.find(P);
1488 if (It == NonLocalPointerDeps.end())
1489 return;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001490
Chris Lattnera28355d2008-12-07 08:50:20 +00001491 // Remove all of the entries in the BB->val map. This involves removing
1492 // instructions from the reverse map.
Dan Gohman23483932010-09-22 21:41:02 +00001493 NonLocalDepInfo &PInfo = It->second.NonLocalDeps;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001494
Chris Lattnera28355d2008-12-07 08:50:20 +00001495 for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
Chris Lattner0c315472009-12-09 07:08:01 +00001496 Instruction *Target = PInfo[i].getResult().getInst();
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001497 if (!Target)
1498 continue; // Ignore non-local dep results.
Chris Lattner0c315472009-12-09 07:08:01 +00001499 assert(Target->getParent() == PInfo[i].getBB());
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001500
Chris Lattnera28355d2008-12-07 08:50:20 +00001501 // Eliminating the dirty entry from 'Cache', so update the reverse info.
Chris Lattner8eda11b2009-03-29 00:24:04 +00001502 RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
Chris Lattnera28355d2008-12-07 08:50:20 +00001503 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001504
Chris Lattnera28355d2008-12-07 08:50:20 +00001505 // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
1506 NonLocalPointerDeps.erase(It);
Chris Lattner2faa2c72008-12-07 02:15:47 +00001507}
1508
Chandler Carruth61440d22016-03-10 00:55:30 +00001509void MemoryDependenceResults::invalidateCachedPointerInfo(Value *Ptr) {
Chris Lattnerfa9f99a2008-12-09 22:06:23 +00001510 // If Ptr isn't really a pointer, just ignore it.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001511 if (!Ptr->getType()->isPointerTy())
1512 return;
Chris Lattnerfa9f99a2008-12-09 22:06:23 +00001513 // Flush store info for the pointer.
1514 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
1515 // Flush load info for the pointer.
1516 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
John Brawncd5f37f2018-07-31 14:19:29 +00001517 // Invalidate phis that use the pointer.
1518 PV.invalidateValue(Ptr);
Chris Lattnerfa9f99a2008-12-09 22:06:23 +00001519}
1520
Chandler Carruth61440d22016-03-10 00:55:30 +00001521void MemoryDependenceResults::invalidateCachedPredecessors() {
Daniel Berlinb4e7a4a2015-04-21 21:11:50 +00001522 PredCache.clear();
Bob Wilson92cdb6e2010-02-16 19:51:59 +00001523}
1524
Chandler Carruth61440d22016-03-10 00:55:30 +00001525void MemoryDependenceResults::removeInstruction(Instruction *RemInst) {
Chris Lattnera25d39522008-11-28 22:04:47 +00001526 // Walk through the Non-local dependencies, removing this one as the value
1527 // for any cached queries.
Chris Lattner1b810bd2008-11-30 02:28:25 +00001528 NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
1529 if (NLDI != NonLocalDeps.end()) {
Chris Lattner7e61daf2008-12-01 01:15:42 +00001530 NonLocalDepInfo &BlockMap = NLDI->second.first;
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001531 for (auto &Entry : BlockMap)
1532 if (Instruction *Inst = Entry.getResult().getInst())
Chris Lattnerde4440c2008-12-07 18:39:13 +00001533 RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
Chris Lattner1b810bd2008-11-30 02:28:25 +00001534 NonLocalDeps.erase(NLDI);
1535 }
Owen Anderson086b2c42007-12-08 01:37:09 +00001536
Chris Lattnera25d39522008-11-28 22:04:47 +00001537 // If we have a cached local dependence query for this instruction, remove it.
Chris Lattnerde04e112008-11-29 01:43:36 +00001538 LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
1539 if (LocalDepEntry != LocalDeps.end()) {
Chris Lattnerada1f872008-11-30 01:09:30 +00001540 // Remove us from DepInst's reverse set now that the local dep info is gone.
Chris Lattnerde4440c2008-12-07 18:39:13 +00001541 if (Instruction *Inst = LocalDepEntry->second.getInst())
1542 RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
Chris Lattnerada1f872008-11-30 01:09:30 +00001543
Chris Lattner73c25452008-11-28 22:28:27 +00001544 // Remove this local dependency info.
Chris Lattnerde04e112008-11-29 01:43:36 +00001545 LocalDeps.erase(LocalDepEntry);
Chris Lattnera28355d2008-12-07 08:50:20 +00001546 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001547
Chris Lattnera28355d2008-12-07 08:50:20 +00001548 // If we have any cached pointer dependencies on this instruction, remove
1549 // them. If the instruction has non-pointer type, then it can't be a pointer
1550 // base.
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001551
Chris Lattnera28355d2008-12-07 08:50:20 +00001552 // Remove it from both the load info and the store info. The instruction
1553 // can't be in either of these maps if it is non-pointer.
Duncan Sands19d0b472010-02-16 11:11:14 +00001554 if (RemInst->getType()->isPointerTy()) {
Chris Lattnera28355d2008-12-07 08:50:20 +00001555 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1556 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1557 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001558
Chris Lattnerd3d91112008-11-28 22:51:08 +00001559 // Loop over all of the things that depend on the instruction we're removing.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001560 SmallVector<std::pair<Instruction *, Instruction *>, 8> ReverseDepsToAdd;
Chris Lattner82b70342008-12-07 18:42:51 +00001561
1562 // If we find RemInst as a clobber or Def in any of the maps for other values,
1563 // we need to replace its entry with a dirty version of the instruction after
1564 // it. If RemInst is a terminator, we use a null dirty value.
1565 //
1566 // Using a dirty version of the instruction after RemInst saves having to scan
1567 // the entire block to get to this point.
1568 MemDepResult NewDirtyVal;
1569 if (!RemInst->isTerminator())
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +00001570 NewDirtyVal = MemDepResult::getDirty(&*++RemInst->getIterator());
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001571
Chris Lattner9f1988ab2008-11-29 09:20:15 +00001572 ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1573 if (ReverseDepIt != ReverseLocalDeps.end()) {
Chris Lattnera28355d2008-12-07 08:50:20 +00001574 // RemInst can't be the terminator if it has local stuff depending on it.
Craig Topper46276792014-08-24 23:23:06 +00001575 assert(!ReverseDepIt->second.empty() && !isa<TerminatorInst>(RemInst) &&
Chris Lattnerada1f872008-11-30 01:09:30 +00001576 "Nothing can locally depend on a terminator");
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001577
Craig Topper46276792014-08-24 23:23:06 +00001578 for (Instruction *InstDependingOnRemInst : ReverseDepIt->second) {
Chris Lattner1b810bd2008-11-30 02:28:25 +00001579 assert(InstDependingOnRemInst != RemInst &&
1580 "Already removed our local dep info");
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001581
Chris Lattner82b70342008-12-07 18:42:51 +00001582 LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001583
Chris Lattnerada1f872008-11-30 01:09:30 +00001584 // Make sure to remember that new things depend on NewDepInst.
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001585 assert(NewDirtyVal.getInst() &&
1586 "There is no way something else can have "
Chris Lattner82b70342008-12-07 18:42:51 +00001587 "a local dep on this if it is a terminator!");
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001588 ReverseDepsToAdd.push_back(
1589 std::make_pair(NewDirtyVal.getInst(), InstDependingOnRemInst));
Chris Lattnerd3d91112008-11-28 22:51:08 +00001590 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001591
Chris Lattner63bd5862008-11-29 23:30:39 +00001592 ReverseLocalDeps.erase(ReverseDepIt);
1593
1594 // Add new reverse deps after scanning the set, to avoid invalidating the
1595 // 'ReverseDeps' reference.
1596 while (!ReverseDepsToAdd.empty()) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001597 ReverseLocalDeps[ReverseDepsToAdd.back().first].insert(
1598 ReverseDepsToAdd.back().second);
Chris Lattner63bd5862008-11-29 23:30:39 +00001599 ReverseDepsToAdd.pop_back();
1600 }
Owen Andersonc0daf5f2007-07-06 23:14:35 +00001601 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001602
Chris Lattner9f1988ab2008-11-29 09:20:15 +00001603 ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1604 if (ReverseDepIt != ReverseNonLocalDeps.end()) {
Craig Topper46276792014-08-24 23:23:06 +00001605 for (Instruction *I : ReverseDepIt->second) {
1606 assert(I != RemInst && "Already removed NonLocalDep info for RemInst");
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001607
Craig Topper46276792014-08-24 23:23:06 +00001608 PerInstNLInfo &INLD = NonLocalDeps[I];
Chris Lattner44104272008-11-30 02:52:26 +00001609 // The information is now dirty!
Chris Lattner7e61daf2008-12-01 01:15:42 +00001610 INLD.second = true;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001611
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001612 for (auto &Entry : INLD.first) {
1613 if (Entry.getResult().getInst() != RemInst)
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001614 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001615
Chris Lattner1b810bd2008-11-30 02:28:25 +00001616 // Convert to a dirty entry for the subsequent instruction.
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001617 Entry.setResult(NewDirtyVal);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001618
Chris Lattner82b70342008-12-07 18:42:51 +00001619 if (Instruction *NextI = NewDirtyVal.getInst())
Craig Topper46276792014-08-24 23:23:06 +00001620 ReverseDepsToAdd.push_back(std::make_pair(NextI, I));
Chris Lattner1b810bd2008-11-30 02:28:25 +00001621 }
1622 }
Chris Lattner63bd5862008-11-29 23:30:39 +00001623
1624 ReverseNonLocalDeps.erase(ReverseDepIt);
1625
Chris Lattnere7d7e132008-11-29 22:02:15 +00001626 // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1627 while (!ReverseDepsToAdd.empty()) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001628 ReverseNonLocalDeps[ReverseDepsToAdd.back().first].insert(
1629 ReverseDepsToAdd.back().second);
Chris Lattnere7d7e132008-11-29 22:02:15 +00001630 ReverseDepsToAdd.pop_back();
1631 }
Owen Anderson5f208be2007-08-16 21:27:05 +00001632 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001633
Chris Lattnera28355d2008-12-07 08:50:20 +00001634 // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1635 // value in the NonLocalPointerDeps info.
1636 ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001637 ReverseNonLocalPtrDeps.find(RemInst);
Chris Lattnera28355d2008-12-07 08:50:20 +00001638 if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001639 SmallVector<std::pair<Instruction *, ValueIsLoadPair>, 8>
1640 ReversePtrDepsToAdd;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001641
Craig Topper46276792014-08-24 23:23:06 +00001642 for (ValueIsLoadPair P : ReversePtrDepIt->second) {
Chris Lattnera28355d2008-12-07 08:50:20 +00001643 assert(P.getPointer() != RemInst &&
1644 "Already removed NonLocalPointerDeps info for RemInst");
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001645
Dan Gohman23483932010-09-22 21:41:02 +00001646 NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].NonLocalDeps;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001647
Chris Lattner5ed409e2008-12-08 07:31:50 +00001648 // The cache is not valid for any specific block anymore.
Dan Gohman23483932010-09-22 21:41:02 +00001649 NonLocalPointerDeps[P].Pair = BBSkipFirstBlockPair();
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001650
Chris Lattnera28355d2008-12-07 08:50:20 +00001651 // Update any entries for RemInst to use the instruction after it.
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001652 for (auto &Entry : NLPDI) {
1653 if (Entry.getResult().getInst() != RemInst)
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001654 continue;
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001655
Chris Lattnera28355d2008-12-07 08:50:20 +00001656 // Convert to a dirty entry for the subsequent instruction.
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001657 Entry.setResult(NewDirtyVal);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001658
Chris Lattnera28355d2008-12-07 08:50:20 +00001659 if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1660 ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1661 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001662
Chris Lattner3f4591c2009-01-23 07:12:16 +00001663 // Re-sort the NonLocalDepInfo. Changing the dirty entry to its
1664 // subsequent value may invalidate the sortedness.
Mandeep Singh Grang97bcade2018-04-01 01:46:51 +00001665 llvm::sort(NLPDI.begin(), NLPDI.end());
Chris Lattnera28355d2008-12-07 08:50:20 +00001666 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001667
Chris Lattnera28355d2008-12-07 08:50:20 +00001668 ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001669
Chris Lattnera28355d2008-12-07 08:50:20 +00001670 while (!ReversePtrDepsToAdd.empty()) {
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001671 ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first].insert(
1672 ReversePtrDepsToAdd.back().second);
Chris Lattnera28355d2008-12-07 08:50:20 +00001673 ReversePtrDepsToAdd.pop_back();
1674 }
1675 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001676
John Brawncd5f37f2018-07-31 14:19:29 +00001677 // Invalidate phis that use the removed instruction.
1678 PV.invalidateValue(RemInst);
1679
Chris Lattner1b810bd2008-11-30 02:28:25 +00001680 assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001681 LLVM_DEBUG(verifyRemoved(RemInst));
Owen Andersonc0daf5f2007-07-06 23:14:35 +00001682}
Chandler Carruth40e21f22016-03-07 12:30:06 +00001683
1684/// Verify that the specified instruction does not occur in our internal data
1685/// structures.
1686///
1687/// This function verifies by asserting in debug builds.
Chandler Carruth61440d22016-03-10 00:55:30 +00001688void MemoryDependenceResults::verifyRemoved(Instruction *D) const {
Craig Topper46276792014-08-24 23:23:06 +00001689#ifndef NDEBUG
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001690 for (const auto &DepKV : LocalDeps) {
1691 assert(DepKV.first != D && "Inst occurs in data structures");
1692 assert(DepKV.second.getInst() != D && "Inst occurs in data structures");
Chris Lattnerb8ec75b2008-11-29 21:25:10 +00001693 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001694
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001695 for (const auto &DepKV : NonLocalPointerDeps) {
1696 assert(DepKV.first.getPointer() != D && "Inst occurs in NLPD map key");
1697 for (const auto &Entry : DepKV.second.NonLocalDeps)
1698 assert(Entry.getResult().getInst() != D && "Inst occurs as NLPD value");
Chris Lattnera28355d2008-12-07 08:50:20 +00001699 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001700
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001701 for (const auto &DepKV : NonLocalDeps) {
1702 assert(DepKV.first != D && "Inst occurs in data structures");
1703 const PerInstNLInfo &INLD = DepKV.second;
1704 for (const auto &Entry : INLD.first)
1705 assert(Entry.getResult().getInst() != D &&
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001706 "Inst occurs in data structures");
Chris Lattnerb8ec75b2008-11-29 21:25:10 +00001707 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001708
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001709 for (const auto &DepKV : ReverseLocalDeps) {
1710 assert(DepKV.first != D && "Inst occurs in data structures");
1711 for (Instruction *Inst : DepKV.second)
Craig Topper46276792014-08-24 23:23:06 +00001712 assert(Inst != D && "Inst occurs in data structures");
Chris Lattner1b810bd2008-11-30 02:28:25 +00001713 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001714
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001715 for (const auto &DepKV : ReverseNonLocalDeps) {
1716 assert(DepKV.first != D && "Inst occurs in data structures");
1717 for (Instruction *Inst : DepKV.second)
Craig Topper46276792014-08-24 23:23:06 +00001718 assert(Inst != D && "Inst occurs in data structures");
Chris Lattner1b810bd2008-11-30 02:28:25 +00001719 }
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001720
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001721 for (const auto &DepKV : ReverseNonLocalPtrDeps) {
1722 assert(DepKV.first != D && "Inst occurs in rev NLPD map");
Jakub Staszakb0a7eed2013-03-20 21:47:51 +00001723
Chandler Carruthaf8321e2016-03-07 15:12:57 +00001724 for (ValueIsLoadPair P : DepKV.second)
Chandler Carruth60fb1b42016-03-07 10:19:30 +00001725 assert(P != ValueIsLoadPair(D, false) && P != ValueIsLoadPair(D, true) &&
Chris Lattnera28355d2008-12-07 08:50:20 +00001726 "Inst occurs in ReverseNonLocalPtrDeps map");
1727 }
Craig Topper46276792014-08-24 23:23:06 +00001728#endif
Chris Lattnerb8ec75b2008-11-29 21:25:10 +00001729}
Chandler Carruth61440d22016-03-10 00:55:30 +00001730
Chandler Carruthdab4eae2016-11-23 17:53:26 +00001731AnalysisKey MemoryDependenceAnalysis::Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +00001732
Chandler Carruth61440d22016-03-10 00:55:30 +00001733MemoryDependenceResults
Sean Silva36e0d012016-08-09 00:28:15 +00001734MemoryDependenceAnalysis::run(Function &F, FunctionAnalysisManager &AM) {
Chandler Carruthb47f8012016-03-11 11:05:24 +00001735 auto &AA = AM.getResult<AAManager>(F);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001736 auto &AC = AM.getResult<AssumptionAnalysis>(F);
Chandler Carruthb47f8012016-03-11 11:05:24 +00001737 auto &TLI = AM.getResult<TargetLibraryAnalysis>(F);
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001738 auto &DT = AM.getResult<DominatorTreeAnalysis>(F);
John Brawncd5f37f2018-07-31 14:19:29 +00001739 auto &PV = AM.getResult<PhiValuesAnalysis>(F);
1740 return MemoryDependenceResults(AA, AC, TLI, DT, PV);
Chandler Carruth61440d22016-03-10 00:55:30 +00001741}
1742
1743char MemoryDependenceWrapperPass::ID = 0;
1744
1745INITIALIZE_PASS_BEGIN(MemoryDependenceWrapperPass, "memdep",
1746 "Memory Dependence Analysis", false, true)
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001747INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
Chandler Carruth61440d22016-03-10 00:55:30 +00001748INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001749INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Chandler Carruth61440d22016-03-10 00:55:30 +00001750INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
John Brawncd5f37f2018-07-31 14:19:29 +00001751INITIALIZE_PASS_DEPENDENCY(PhiValuesWrapperPass)
Chandler Carruth61440d22016-03-10 00:55:30 +00001752INITIALIZE_PASS_END(MemoryDependenceWrapperPass, "memdep",
1753 "Memory Dependence Analysis", false, true)
1754
1755MemoryDependenceWrapperPass::MemoryDependenceWrapperPass() : FunctionPass(ID) {
1756 initializeMemoryDependenceWrapperPassPass(*PassRegistry::getPassRegistry());
1757}
Eugene Zelenko1804a772016-08-25 00:45:04 +00001758
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +00001759MemoryDependenceWrapperPass::~MemoryDependenceWrapperPass() = default;
Chandler Carruth61440d22016-03-10 00:55:30 +00001760
1761void MemoryDependenceWrapperPass::releaseMemory() {
1762 MemDep.reset();
1763}
1764
1765void MemoryDependenceWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
1766 AU.setPreservesAll();
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001767 AU.addRequired<AssumptionCacheTracker>();
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001768 AU.addRequired<DominatorTreeWrapperPass>();
John Brawncd5f37f2018-07-31 14:19:29 +00001769 AU.addRequired<PhiValuesWrapperPass>();
Chandler Carruth61440d22016-03-10 00:55:30 +00001770 AU.addRequiredTransitive<AAResultsWrapperPass>();
1771 AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>();
1772}
1773
Chandler Carruthe14524c2016-12-27 19:33:04 +00001774bool MemoryDependenceResults::invalidate(Function &F, const PreservedAnalyses &PA,
1775 FunctionAnalysisManager::Invalidator &Inv) {
1776 // Check whether our analysis is preserved.
1777 auto PAC = PA.getChecker<MemoryDependenceAnalysis>();
1778 if (!PAC.preserved() && !PAC.preservedSet<AllAnalysesOn<Function>>())
1779 // If not, give up now.
1780 return true;
1781
1782 // Check whether the analyses we depend on became invalid for any reason.
1783 if (Inv.invalidate<AAManager>(F, PA) ||
1784 Inv.invalidate<AssumptionAnalysis>(F, PA) ||
John Brawncd5f37f2018-07-31 14:19:29 +00001785 Inv.invalidate<DominatorTreeAnalysis>(F, PA) ||
1786 Inv.invalidate<PhiValuesAnalysis>(F, PA))
Chandler Carruthe14524c2016-12-27 19:33:04 +00001787 return true;
1788
1789 // Otherwise this analysis result remains valid.
1790 return false;
1791}
1792
Bob Haarman3db17642016-08-26 16:34:27 +00001793unsigned MemoryDependenceResults::getDefaultBlockScanLimit() const {
1794 return BlockScanLimit;
1795}
1796
Chandler Carruth61440d22016-03-10 00:55:30 +00001797bool MemoryDependenceWrapperPass::runOnFunction(Function &F) {
1798 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001799 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Chandler Carruth61440d22016-03-10 00:55:30 +00001800 auto &TLI = getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Chandler Carruthaef32bd2016-03-11 13:46:00 +00001801 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
John Brawncd5f37f2018-07-31 14:19:29 +00001802 auto &PV = getAnalysis<PhiValuesWrapperPass>().getResult();
1803 MemDep.emplace(AA, AC, TLI, DT, PV);
Chandler Carruth61440d22016-03-10 00:55:30 +00001804 return false;
1805}