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 //===----------------------------------------------------------------------===//
11 /// This is the interface for a metadata-based scoped no-alias analysis.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_ANALYSIS_SCOPEDNOALIASAA_H
16 #define LLVM_ANALYSIS_SCOPEDNOALIASAA_H
18 #include "llvm/Analysis/AliasAnalysis.h"
19 #include "llvm/IR/CallSite.h"
20 #include "llvm/IR/PassManager.h"
21 #include "llvm/Pass.h"
30 /// A simple AA result which uses scoped-noalias metadata to answer queries.
31 class ScopedNoAliasAAResult : public AAResultBase<ScopedNoAliasAAResult> {
32 friend AAResultBase<ScopedNoAliasAAResult>;
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 &,
39 FunctionAnalysisManager::Invalidator &) {
43 AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB);
44 ModRefInfo getModRefInfo(ImmutableCallSite CS, const MemoryLocation &Loc);
45 ModRefInfo getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2);
48 bool mayAliasInScopes(const MDNode *Scopes, const MDNode *NoAlias) const;
51 /// Analysis pass providing a never-invalidated alias analysis result.
52 class ScopedNoAliasAA : public AnalysisInfoMixin<ScopedNoAliasAA> {
53 friend AnalysisInfoMixin<ScopedNoAliasAA>;
55 static AnalysisKey Key;
58 using Result = ScopedNoAliasAAResult;
60 ScopedNoAliasAAResult run(Function &F, FunctionAnalysisManager &AM);
63 /// Legacy wrapper pass to provide the ScopedNoAliasAAResult object.
64 class ScopedNoAliasAAWrapperPass : public ImmutablePass {
65 std::unique_ptr<ScopedNoAliasAAResult> Result;
70 ScopedNoAliasAAWrapperPass();
72 ScopedNoAliasAAResult &getResult() { return *Result; }
73 const ScopedNoAliasAAResult &getResult() const { return *Result; }
75 bool doInitialization(Module &M) override;
76 bool doFinalization(Module &M) override;
77 void getAnalysisUsage(AnalysisUsage &AU) const override;
80 //===--------------------------------------------------------------------===//
82 // createScopedNoAliasAAWrapperPass - This pass implements metadata-based
83 // scoped noalias analysis.
85 ImmutablePass *createScopedNoAliasAAWrapperPass();
87 } // end namespace llvm
89 #endif // LLVM_ANALYSIS_SCOPEDNOALIASAA_H