include/llvm/Analysis/ScopedNoAliasAA.h

   1 //===- ScopedNoAliasAA.h - Scoped No-Alias Alias Analysis -------*- C++ -*-===//
   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 /// \file
  10 /// This is the interface for a metadata-based scoped no-alias analysis.
  11 ///
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ANALYSIS_SCOPEDNOALIASAA_H
  15 #define LLVM_ANALYSIS_SCOPEDNOALIASAA_H
  16
  17 #include "llvm/Analysis/AliasAnalysis.h"
  18 #include "llvm/IR/Function.h"
  19 #include "llvm/IR/Metadata.h"
  20 #include "llvm/IR/Module.h"
  21 #include "llvm/Pass.h"
  22
  23 namespace llvm {
  24
  25 /// A simple AA result which uses scoped-noalias metadata to answer queries.
  26 class ScopedNoAliasAAResult : public AAResultBase<ScopedNoAliasAAResult> {
  27   friend AAResultBase<ScopedNoAliasAAResult>;
  28
  29 public:
  30   explicit ScopedNoAliasAAResult(const TargetLibraryInfo &TLI)
  31       : AAResultBase(TLI) {}
  32   ScopedNoAliasAAResult(ScopedNoAliasAAResult &&Arg)
  33       : AAResultBase(std::move(Arg)) {}
  34
  35   /// Handle invalidation events from the new pass manager.
  36   ///
  37   /// By definition, this result is stateless and so remains valid.
  38   bool invalidate(Function &, const PreservedAnalyses &) { return false; }
  39
  40   AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB);
  41   ModRefInfo getModRefInfo(ImmutableCallSite CS, const MemoryLocation &Loc);
  42   ModRefInfo getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2);
  43
  44 private:
  45   bool mayAliasInScopes(const MDNode *Scopes, const MDNode *NoAlias) const;
  46   void collectMDInDomain(const MDNode *List, const MDNode *Domain,
  47                          SmallPtrSetImpl<const MDNode *> &Nodes) const;
  48 };
  49
  50 /// Analysis pass providing a never-invalidated alias analysis result.
  51 class ScopedNoAliasAA {
  52 public:
  53   typedef ScopedNoAliasAAResult Result;
  54
  55   /// \brief Opaque, unique identifier for this analysis pass.
  56   static void *ID() { return (void *)&PassID; }
  57
  58   ScopedNoAliasAAResult run(Function &F, AnalysisManager<Function> *AM);
  59
  60   /// \brief Provide access to a name for this pass for debugging purposes.
  61   static StringRef name() { return "ScopedNoAliasAA"; }
  62
  63 private:
  64   static char PassID;
  65 };
  66
  67 /// Legacy wrapper pass to provide the ScopedNoAliasAAResult object.
  68 class ScopedNoAliasAAWrapperPass : public ImmutablePass {
  69   std::unique_ptr<ScopedNoAliasAAResult> Result;
  70
  71 public:
  72   static char ID;
  73
  74   ScopedNoAliasAAWrapperPass();
  75
  76   ScopedNoAliasAAResult &getResult() { return *Result; }
  77   const ScopedNoAliasAAResult &getResult() const { return *Result; }
  78
  79   bool doInitialization(Module &M) override;
  80   bool doFinalization(Module &M) override;
  81   void getAnalysisUsage(AnalysisUsage &AU) const override;
  82 };
  83
  84 //===--------------------------------------------------------------------===//
  85 //
  86 // createScopedNoAliasAAWrapperPass - This pass implements metadata-based
  87 // scoped noalias analysis.
  88 //
  89 ImmutablePass *createScopedNoAliasAAWrapperPass();
  90 }
  91
  92 #endif