lib/Analysis/ScopedNoAliasAA.cpp

   1 //===- ScopedNoAliasAA.cpp - Scoped No-Alias Alias Analysis ---------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the ScopedNoAlias alias-analysis pass, which implements
  11 // metadata-based scoped no-alias support.
  12 //
  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.
  17 //
  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" }
  21 //
  22 // Loads and stores can be tagged with an alias-analysis scope, and also, with
  23 // a noalias tag for a specific scope:
  24 //
  25 // ... = load %ptr1, !alias.scope !{ !scope1 }
  26 // ... = load %ptr2, !alias.scope !{ !scope1, !scope2 }, !noalias !{ !scope1 }
  27 //
  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.
  32 //
  33 //===----------------------------------------------------------------------===//
  34
  35 #include "llvm/ADT/SmallPtrSet.h"
  36 #include "llvm/Analysis/AliasAnalysis.h"
  37 #include "llvm/Analysis/Passes.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"
  44 using namespace llvm;
  45
  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.
  49 static cl::opt<bool> EnableScopedNoAlias("enable-scoped-noalias",
  50                                          cl::init(true));
  51
  52 namespace {
  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 {
  57   const MDNode *Node;
  58
  59 public:
  60   AliasScopeNode() : Node(0) {}
  61   explicit AliasScopeNode(const MDNode *N) : Node(N) {}
  62
  63   /// getNode - Get the MDNode for this AliasScopeNode.
  64   const MDNode *getNode() const { return Node; }
  65
  66   /// getDomain - Get the MDNode for this AliasScopeNode's domain.
  67   const MDNode *getDomain() const {
  68     if (Node->getNumOperands() < 2)
  69       return nullptr;
  70     return dyn_cast_or_null<MDNode>(Node->getOperand(1));
  71   }
  72 };
  73
  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 {
  77 public:
  78   static char ID; // Class identification, replacement for typeinfo
  79   ScopedNoAliasAA() : ImmutablePass(ID) {
  80     initializeScopedNoAliasAAPass(*PassRegistry::getPassRegistry());
  81   }
  82
  83   bool doInitialization(Module &M) override;
  84
  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;
  92     return this;
  93   }
  94
  95 protected:
  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;
  99
 100 private:
 101   void getAnalysisUsage(AnalysisUsage &AU) const override;
 102   AliasResult alias(const MemoryLocation &LocA,
 103                     const MemoryLocation &LocB) override;
 104   bool pointsToConstantMemory(const MemoryLocation &Loc, bool OrLocal) override;
 105   FunctionModRefBehavior getModRefBehavior(ImmutableCallSite CS) override;
 106   FunctionModRefBehavior getModRefBehavior(const Function *F) override;
 107   ModRefInfo getModRefInfo(ImmutableCallSite CS,
 108                            const MemoryLocation &Loc) override;
 109   ModRefInfo getModRefInfo(ImmutableCallSite CS1,
 110                            ImmutableCallSite CS2) override;
 111 };
 112 } // End of anonymous namespace
 113
 114 // Register this pass...
 115 char ScopedNoAliasAA::ID = 0;
 116 INITIALIZE_AG_PASS(ScopedNoAliasAA, AliasAnalysis, "scoped-noalias",
 117                    "Scoped NoAlias Alias Analysis", false, true, false)
 118
 119 ImmutablePass *llvm::createScopedNoAliasAAPass() {
 120   return new ScopedNoAliasAA();
 121 }
 122
 123 bool ScopedNoAliasAA::doInitialization(Module &M) {
 124   InitializeAliasAnalysis(this, &M.getDataLayout());
 125   return true;
 126 }
 127
 128 void ScopedNoAliasAA::getAnalysisUsage(AnalysisUsage &AU) const {
 129   AU.setPreservesAll();
 130   AliasAnalysis::getAnalysisUsage(AU);
 131 }
 132
 133 void ScopedNoAliasAA::collectMDInDomain(
 134     const MDNode *List, const MDNode *Domain,
 135     SmallPtrSetImpl<const MDNode *> &Nodes) const {
 136   for (unsigned i = 0, ie = List->getNumOperands(); i != ie; ++i)
 137     if (const MDNode *MD = dyn_cast<MDNode>(List->getOperand(i)))
 138       if (AliasScopeNode(MD).getDomain() == Domain)
 139         Nodes.insert(MD);
 140 }
 141
 142 bool ScopedNoAliasAA::mayAliasInScopes(const MDNode *Scopes,
 143                                        const MDNode *NoAlias) const {
 144   if (!Scopes || !NoAlias)
 145     return true;
 146
 147   // Collect the set of scope domains relevant to the noalias scopes.
 148   SmallPtrSet<const MDNode *, 16> Domains;
 149   for (unsigned i = 0, ie = NoAlias->getNumOperands(); i != ie; ++i)
 150     if (const MDNode *NAMD = dyn_cast<MDNode>(NoAlias->getOperand(i)))
 151       if (const MDNode *Domain = AliasScopeNode(NAMD).getDomain())
 152         Domains.insert(Domain);
 153
 154   // We alias unless, for some domain, the set of noalias scopes in that domain
 155   // is a superset of the set of alias scopes in that domain.
 156   for (const MDNode *Domain : Domains) {
 157     SmallPtrSet<const MDNode *, 16> NANodes, ScopeNodes;
 158     collectMDInDomain(NoAlias, Domain, NANodes);
 159     collectMDInDomain(Scopes, Domain, ScopeNodes);
 160     if (!ScopeNodes.size())
 161       continue;
 162
 163     // To not alias, all of the nodes in ScopeNodes must be in NANodes.
 164     bool FoundAll = true;
 165     for (const MDNode *SMD : ScopeNodes)
 166       if (!NANodes.count(SMD)) {
 167         FoundAll = false;
 168         break;
 169       }
 170
 171     if (FoundAll)
 172       return false;
 173   }
 174
 175   return true;
 176 }
 177
 178 AliasResult ScopedNoAliasAA::alias(const MemoryLocation &LocA,
 179                                    const MemoryLocation &LocB) {
 180   if (!EnableScopedNoAlias)
 181     return AliasAnalysis::alias(LocA, LocB);
 182
 183   // Get the attached MDNodes.
 184   const MDNode *AScopes = LocA.AATags.Scope, *BScopes = LocB.AATags.Scope;
 185
 186   const MDNode *ANoAlias = LocA.AATags.NoAlias, *BNoAlias = LocB.AATags.NoAlias;
 187
 188   if (!mayAliasInScopes(AScopes, BNoAlias))
 189     return NoAlias;
 190
 191   if (!mayAliasInScopes(BScopes, ANoAlias))
 192     return NoAlias;
 193
 194   // If they may alias, chain to the next AliasAnalysis.
 195   return AliasAnalysis::alias(LocA, LocB);
 196 }
 197
 198 bool ScopedNoAliasAA::pointsToConstantMemory(const MemoryLocation &Loc,
 199                                              bool OrLocal) {
 200   return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
 201 }
 202
 203 FunctionModRefBehavior
 204 ScopedNoAliasAA::getModRefBehavior(ImmutableCallSite CS) {
 205   return AliasAnalysis::getModRefBehavior(CS);
 206 }
 207
 208 FunctionModRefBehavior ScopedNoAliasAA::getModRefBehavior(const Function *F) {
 209   return AliasAnalysis::getModRefBehavior(F);
 210 }
 211
 212 ModRefInfo ScopedNoAliasAA::getModRefInfo(ImmutableCallSite CS,
 213                                           const MemoryLocation &Loc) {
 214   if (!EnableScopedNoAlias)
 215     return AliasAnalysis::getModRefInfo(CS, Loc);
 216
 217   if (!mayAliasInScopes(Loc.AATags.Scope, CS.getInstruction()->getMetadata(
 218                                               LLVMContext::MD_noalias)))
 219     return MRI_NoModRef;
 220
 221   if (!mayAliasInScopes(
 222           CS.getInstruction()->getMetadata(LLVMContext::MD_alias_scope),
 223           Loc.AATags.NoAlias))
 224     return MRI_NoModRef;
 225
 226   return AliasAnalysis::getModRefInfo(CS, Loc);
 227 }
 228
 229 ModRefInfo ScopedNoAliasAA::getModRefInfo(ImmutableCallSite CS1,
 230                                           ImmutableCallSite CS2) {
 231   if (!EnableScopedNoAlias)
 232     return AliasAnalysis::getModRefInfo(CS1, CS2);
 233
 234   if (!mayAliasInScopes(
 235           CS1.getInstruction()->getMetadata(LLVMContext::MD_alias_scope),
 236           CS2.getInstruction()->getMetadata(LLVMContext::MD_noalias)))
 237     return MRI_NoModRef;
 238
 239   if (!mayAliasInScopes(
 240           CS2.getInstruction()->getMetadata(LLVMContext::MD_alias_scope),
 241           CS1.getInstruction()->getMetadata(LLVMContext::MD_noalias)))
 242     return MRI_NoModRef;
 243
 244   return AliasAnalysis::getModRefInfo(CS1, CS2);
 245 }
 246