LLVM  17.0.0git
TypeBasedAliasAnalysis.h
Go to the documentation of this file.
1 //===- TypeBasedAliasAnalysis.h - Type-Based Alias Analysis -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// This is the interface for a metadata-based TBAA. See the source file for
11 /// details on the algorithm.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_ANALYSIS_TYPEBASEDALIASANALYSIS_H
16 #define LLVM_ANALYSIS_TYPEBASEDALIASANALYSIS_H
17 
19 #include "llvm/IR/PassManager.h"
20 #include "llvm/Pass.h"
21 #include <memory>
22 
23 namespace llvm {
24 
25 class CallBase;
26 class Function;
27 class MDNode;
28 class MemoryLocation;
29 
30 /// A simple AA result that uses TBAA metadata to answer queries.
32 public:
33  /// Handle invalidation events from the new pass manager.
34  ///
35  /// By definition, this result is stateless and so remains valid.
38  return false;
39  }
40 
41  AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB,
42  AAQueryInfo &AAQI, const Instruction *CtxI);
44  bool IgnoreLocals);
45 
48  ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc,
49  AAQueryInfo &AAQI);
50  ModRefInfo getModRefInfo(const CallBase *Call1, const CallBase *Call2,
51  AAQueryInfo &AAQI);
52 
53 private:
54  bool Aliases(const MDNode *A, const MDNode *B) const;
55 };
56 
57 /// Analysis pass providing a never-invalidated alias analysis result.
58 class TypeBasedAA : public AnalysisInfoMixin<TypeBasedAA> {
60 
61  static AnalysisKey Key;
62 
63 public:
65 
67 };
68 
69 /// Legacy wrapper pass to provide the TypeBasedAAResult object.
71  std::unique_ptr<TypeBasedAAResult> Result;
72 
73 public:
74  static char ID;
75 
77 
78  TypeBasedAAResult &getResult() { return *Result; }
79  const TypeBasedAAResult &getResult() const { return *Result; }
80 
81  bool doInitialization(Module &M) override;
82  bool doFinalization(Module &M) override;
83  void getAnalysisUsage(AnalysisUsage &AU) const override;
84 };
85 
86 //===--------------------------------------------------------------------===//
87 //
88 // createTypeBasedAAWrapperPass - This pass implements metadata-based
89 // type-based alias analysis.
90 //
91 ImmutablePass *createTypeBasedAAWrapperPass();
92 
93 } // end namespace llvm
94 
95 #endif // LLVM_ANALYSIS_TYPEBASEDALIASANALYSIS_H
llvm::PreservedAnalyses
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:152
llvm::TypeBasedAAResult::getModRefInfo
ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc, AAQueryInfo &AAQI)
Definition: TypeBasedAliasAnalysis.cpp:426
llvm::TypeBasedAAResult::getModRefInfoMask
ModRefInfo getModRefInfoMask(const MemoryLocation &Loc, AAQueryInfo &AAQI, bool IgnoreLocals)
Definition: TypeBasedAliasAnalysis.cpp:388
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::TypeBasedAAWrapperPass::doFinalization
bool doFinalization(Module &M) override
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes...
Definition: TypeBasedAliasAnalysis.cpp:730
llvm::ImmutablePass
ImmutablePass class - This class is used to provide information that does not need to be run.
Definition: Pass.h:279
llvm::TypeBasedAA::run
TypeBasedAAResult run(Function &F, FunctionAnalysisManager &AM)
Definition: TypeBasedAliasAnalysis.cpp:709
llvm::Function
Definition: Function.h:59
Pass.h
llvm::TypeBasedAAWrapperPass::TypeBasedAAWrapperPass
TypeBasedAAWrapperPass()
Definition: TypeBasedAliasAnalysis.cpp:721
llvm::TypeBasedAAResult
A simple AA result that uses TBAA metadata to answer queries.
Definition: TypeBasedAliasAnalysis.h:31
llvm::AliasResult
The possible results of an alias query.
Definition: AliasAnalysis.h:83
llvm::TypeBasedAAWrapperPass::doInitialization
bool doInitialization(Module &M) override
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before ...
Definition: TypeBasedAliasAnalysis.cpp:725
F
#define F(x, y, z)
Definition: MD5.cpp:55
llvm::TypeBasedAA
Analysis pass providing a never-invalidated alias analysis result.
Definition: TypeBasedAliasAnalysis.h:58
AliasAnalysis.h
llvm::MemoryEffects
Summary of how a function affects memory in the program.
Definition: ModRef.h:63
llvm::AAQueryInfo
This class stores info we want to provide to or retain within an alias query.
Definition: AliasAnalysis.h:233
llvm::TypeBasedAAResult::getMemoryEffects
MemoryEffects getMemoryEffects(const CallBase *Call, AAQueryInfo &AAQI)
Definition: TypeBasedAliasAnalysis.cpp:407
llvm::AnalysisUsage
Represent the analysis usage information of a pass.
Definition: PassAnalysisSupport.h:47
B
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
llvm::Instruction
Definition: Instruction.h:41
llvm::AnalysisManager::Invalidator
API to communicate dependencies between analyses during invalidation.
Definition: PassManager.h:661
llvm::TypeBasedAAWrapperPass
Legacy wrapper pass to provide the TypeBasedAAResult object.
Definition: TypeBasedAliasAnalysis.h:70
llvm::TypeBasedAAWrapperPass::getResult
TypeBasedAAResult & getResult()
Definition: TypeBasedAliasAnalysis.h:78
llvm::TypeBasedAAWrapperPass::ID
static char ID
Definition: TypeBasedAliasAnalysis.h:74
llvm::TypeBasedAAWrapperPass::getAnalysisUsage
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
Definition: TypeBasedAliasAnalysis.cpp:735
llvm::AnalysisKey
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:69
llvm::ModRefInfo
ModRefInfo
Flags indicating whether a memory access modifies or references memory.
Definition: ModRef.h:27
llvm::createTypeBasedAAWrapperPass
ImmutablePass * createTypeBasedAAWrapperPass()
llvm::Module
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
llvm::MDNode
Metadata node.
Definition: Metadata.h:943
llvm::AnalysisInfoMixin
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:394
llvm::TypeBasedAAResult::alias
AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB, AAQueryInfo &AAQI, const Instruction *CtxI)
Definition: TypeBasedAliasAnalysis.cpp:374
PassManager.h
llvm::TypeBasedAAWrapperPass::getResult
const TypeBasedAAResult & getResult() const
Definition: TypeBasedAliasAnalysis.h:79
llvm::TypeBasedAAResult::invalidate
bool invalidate(Function &, const PreservedAnalyses &, FunctionAnalysisManager::Invalidator &)
Handle invalidation events from the new pass manager.
Definition: TypeBasedAliasAnalysis.h:36
llvm::CallBase
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Definition: InstrTypes.h:1184
llvm::AnalysisManager
A container for analyses that lazily runs them and caches their results.
Definition: InstructionSimplify.h:42
llvm::AAResultBase
A base class to help implement the function alias analysis results concept.
Definition: AliasAnalysis.h:794
llvm::MemoryLocation
Representation for a specific memory location.
Definition: MemoryLocation.h:211
llvm::codeview::PublicSymFlags::Function
@ Function