1 //===- ScopedNoAliasAA.cpp - Scoped No-Alias Alias Analysis ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the ScopedNoAlias alias-analysis pass, which implements
11 // metadata-based scoped no-alias support.
13 // Alias-analysis scopes are defined by an id (which can be a string or some
14 // other metadata node), a domain node, and an optional descriptive string.
15 // A domain is defined by an id (which can be a string or some other metadata
16 // node), and an optional descriptive string.
18 // !dom0 = metadata !{ metadata !"domain of foo()" }
19 // !scope1 = metadata !{ metadata !scope1, metadata !dom0, metadata !"scope 1" }
20 // !scope2 = metadata !{ metadata !scope2, metadata !dom0, metadata !"scope 2" }
22 // Loads and stores can be tagged with an alias-analysis scope, and also, with
23 // a noalias tag for a specific scope:
25 // ... = load %ptr1, !alias.scope !{ !scope1 }
26 // ... = load %ptr2, !alias.scope !{ !scope1, !scope2 }, !noalias !{ !scope1 }
28 // When evaluating an aliasing query, if one of the instructions is associated
29 // has a set of noalias scopes in some domain that is superset of the alias
30 // scopes in that domain of some other instruction, then the two memory
31 // accesses are assumed not to alias.
33 //===----------------------------------------------------------------------===//
35 #include "llvm/ADT/SmallPtrSet.h"
36 #include "llvm/Analysis/Passes.h"
37 #include "llvm/Analysis/AliasAnalysis.h"
38 #include "llvm/IR/Constants.h"
39 #include "llvm/IR/LLVMContext.h"
40 #include "llvm/IR/Metadata.h"
41 #include "llvm/IR/Module.h"
42 #include "llvm/Pass.h"
43 #include "llvm/Support/CommandLine.h"
46 // A handy option for disabling scoped no-alias functionality. The same effect
47 // can also be achieved by stripping the associated metadata tags from IR, but
48 // this option is sometimes more convenient.
50 EnableScopedNoAlias("enable-scoped-noalias", cl::init(true));
53 /// AliasScopeNode - This is a simple wrapper around an MDNode which provides
54 /// a higher-level interface by hiding the details of how alias analysis
55 /// information is encoded in its operands.
56 class AliasScopeNode {
60 AliasScopeNode() : Node(0) {}
61 explicit AliasScopeNode(const MDNode *N) : Node(N) {}
63 /// getNode - Get the MDNode for this AliasScopeNode.
64 const MDNode *getNode() const { return Node; }
66 /// getDomain - Get the MDNode for this AliasScopeNode's domain.
67 const MDNode *getDomain() const {
68 if (Node->getNumOperands() < 2)
70 return dyn_cast_or_null<MDNode>(Node->getOperand(1));
74 /// ScopedNoAliasAA - This is a simple alias analysis
75 /// implementation that uses scoped-noalias metadata to answer queries.
76 class ScopedNoAliasAA : public ImmutablePass, public AliasAnalysis {
78 static char ID; // Class identification, replacement for typeinfo
79 ScopedNoAliasAA() : ImmutablePass(ID) {
80 initializeScopedNoAliasAAPass(*PassRegistry::getPassRegistry());
83 void initializePass() override { InitializeAliasAnalysis(this); }
85 /// getAdjustedAnalysisPointer - This method is used when a pass implements
86 /// an analysis interface through multiple inheritance. If needed, it
87 /// should override this to adjust the this pointer as needed for the
88 /// specified pass info.
89 void *getAdjustedAnalysisPointer(const void *PI) override {
90 if (PI == &AliasAnalysis::ID)
91 return (AliasAnalysis*)this;
96 bool mayAliasInScopes(const MDNode *Scopes, const MDNode *NoAlias) const;
97 void collectMDInDomain(const MDNode *List, const MDNode *Domain,
98 SmallPtrSetImpl<const MDNode *> &Nodes) const;
101 void getAnalysisUsage(AnalysisUsage &AU) const override;
102 AliasResult alias(const Location &LocA, const Location &LocB) override;
103 bool pointsToConstantMemory(const Location &Loc, bool OrLocal) override;
104 ModRefBehavior getModRefBehavior(ImmutableCallSite CS) override;
105 ModRefBehavior getModRefBehavior(const Function *F) override;
106 ModRefResult getModRefInfo(ImmutableCallSite CS,
107 const Location &Loc) override;
108 ModRefResult getModRefInfo(ImmutableCallSite CS1,
109 ImmutableCallSite CS2) override;
111 } // End of anonymous namespace
113 // Register this pass...
114 char ScopedNoAliasAA::ID = 0;
115 INITIALIZE_AG_PASS(ScopedNoAliasAA, AliasAnalysis, "scoped-noalias",
116 "Scoped NoAlias Alias Analysis", false, true, false)
118 ImmutablePass *llvm::createScopedNoAliasAAPass() {
119 return new ScopedNoAliasAA();
123 ScopedNoAliasAA::getAnalysisUsage(AnalysisUsage &AU) const {
124 AU.setPreservesAll();
125 AliasAnalysis::getAnalysisUsage(AU);
129 ScopedNoAliasAA::collectMDInDomain(const MDNode *List, const MDNode *Domain,
130 SmallPtrSetImpl<const MDNode *> &Nodes) const {
131 for (unsigned i = 0, ie = List->getNumOperands(); i != ie; ++i)
132 if (const MDNode *MD = dyn_cast<MDNode>(List->getOperand(i)))
133 if (AliasScopeNode(MD).getDomain() == Domain)
138 ScopedNoAliasAA::mayAliasInScopes(const MDNode *Scopes,
139 const MDNode *NoAlias) const {
140 if (!Scopes || !NoAlias)
143 // Collect the set of scope domains relevant to the noalias scopes.
144 SmallPtrSet<const MDNode *, 16> Domains;
145 for (unsigned i = 0, ie = NoAlias->getNumOperands(); i != ie; ++i)
146 if (const MDNode *NAMD = dyn_cast<MDNode>(NoAlias->getOperand(i)))
147 if (const MDNode *Domain = AliasScopeNode(NAMD).getDomain())
148 Domains.insert(Domain);
150 // We alias unless, for some domain, the set of noalias scopes in that domain
151 // is a superset of the set of alias scopes in that domain.
152 for (const MDNode *Domain : Domains) {
153 SmallPtrSet<const MDNode *, 16> NANodes, ScopeNodes;
154 collectMDInDomain(NoAlias, Domain, NANodes);
155 collectMDInDomain(Scopes, Domain, ScopeNodes);
156 if (!ScopeNodes.size())
159 // To not alias, all of the nodes in ScopeNodes must be in NANodes.
160 bool FoundAll = true;
161 for (const MDNode *SMD : ScopeNodes)
162 if (!NANodes.count(SMD)) {
174 AliasAnalysis::AliasResult
175 ScopedNoAliasAA::alias(const Location &LocA, const Location &LocB) {
176 if (!EnableScopedNoAlias)
177 return AliasAnalysis::alias(LocA, LocB);
179 // Get the attached MDNodes.
180 const MDNode *AScopes = LocA.AATags.Scope,
181 *BScopes = LocB.AATags.Scope;
183 const MDNode *ANoAlias = LocA.AATags.NoAlias,
184 *BNoAlias = LocB.AATags.NoAlias;
186 if (!mayAliasInScopes(AScopes, BNoAlias))
189 if (!mayAliasInScopes(BScopes, ANoAlias))
192 // If they may alias, chain to the next AliasAnalysis.
193 return AliasAnalysis::alias(LocA, LocB);
196 bool ScopedNoAliasAA::pointsToConstantMemory(const Location &Loc,
198 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
201 AliasAnalysis::ModRefBehavior
202 ScopedNoAliasAA::getModRefBehavior(ImmutableCallSite CS) {
203 return AliasAnalysis::getModRefBehavior(CS);
206 AliasAnalysis::ModRefBehavior
207 ScopedNoAliasAA::getModRefBehavior(const Function *F) {
208 return AliasAnalysis::getModRefBehavior(F);
211 AliasAnalysis::ModRefResult
212 ScopedNoAliasAA::getModRefInfo(ImmutableCallSite CS, const Location &Loc) {
213 if (!EnableScopedNoAlias)
214 return AliasAnalysis::getModRefInfo(CS, Loc);
216 if (!mayAliasInScopes(Loc.AATags.Scope,
217 CS.getInstruction()->getMetadata(LLVMContext::MD_noalias)))
220 if (!mayAliasInScopes(
221 CS.getInstruction()->getMetadata(LLVMContext::MD_alias_scope),
225 return AliasAnalysis::getModRefInfo(CS, Loc);
228 AliasAnalysis::ModRefResult
229 ScopedNoAliasAA::getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2) {
230 if (!EnableScopedNoAlias)
231 return AliasAnalysis::getModRefInfo(CS1, CS2);
233 if (!mayAliasInScopes(
234 CS1.getInstruction()->getMetadata(LLVMContext::MD_alias_scope),
235 CS2.getInstruction()->getMetadata(LLVMContext::MD_noalias)))
238 if (!mayAliasInScopes(
239 CS2.getInstruction()->getMetadata(LLVMContext::MD_alias_scope),
240 CS1.getInstruction()->getMetadata(LLVMContext::MD_noalias)))
243 return AliasAnalysis::getModRefInfo(CS1, CS2);