1 //===- ScopedNoAliasAA.h - Scoped No-Alias Alias Analysis -------*- C++ -*-===//
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 is the interface for a metadata-based scoped no-alias analysis.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ANALYSIS_SCOPEDNOALIASAA_H
15 #define LLVM_ANALYSIS_SCOPEDNOALIASAA_H
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"
25 /// A simple AA result which uses scoped-noalias metadata to answer queries.
26 class ScopedNoAliasAAResult : public AAResultBase<ScopedNoAliasAAResult> {
27 friend AAResultBase<ScopedNoAliasAAResult>;
30 explicit ScopedNoAliasAAResult(const TargetLibraryInfo &TLI)
31 : AAResultBase(TLI) {}
32 ScopedNoAliasAAResult(ScopedNoAliasAAResult &&Arg)
33 : AAResultBase(std::move(Arg)) {}
35 /// Handle invalidation events from the new pass manager.
37 /// By definition, this result is stateless and so remains valid.
38 bool invalidate(Function &, const PreservedAnalyses &) { return false; }
40 AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB);
41 ModRefInfo getModRefInfo(ImmutableCallSite CS, const MemoryLocation &Loc);
42 ModRefInfo getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2);
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;
50 /// Analysis pass providing a never-invalidated alias analysis result.
51 class ScopedNoAliasAA {
53 typedef ScopedNoAliasAAResult Result;
55 /// \brief Opaque, unique identifier for this analysis pass.
56 static void *ID() { return (void *)&PassID; }
58 ScopedNoAliasAAResult run(Function &F, AnalysisManager<Function> *AM);
60 /// \brief Provide access to a name for this pass for debugging purposes.
61 static StringRef name() { return "ScopedNoAliasAA"; }
67 /// Legacy wrapper pass to provide the ScopedNoAliasAAResult object.
68 class ScopedNoAliasAAWrapperPass : public ImmutablePass {
69 std::unique_ptr<ScopedNoAliasAAResult> Result;
74 ScopedNoAliasAAWrapperPass();
76 ScopedNoAliasAAResult &getResult() { return *Result; }
77 const ScopedNoAliasAAResult &getResult() const { return *Result; }
79 bool doInitialization(Module &M) override;
80 bool doFinalization(Module &M) override;
81 void getAnalysisUsage(AnalysisUsage &AU) const override;
84 //===--------------------------------------------------------------------===//
86 // createScopedNoAliasAAWrapperPass - This pass implements metadata-based
87 // scoped noalias analysis.
89 ImmutablePass *createScopedNoAliasAAWrapperPass();