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
23namespace llvm {
24
25class CallBase;
26class Function;
27class MDNode;
28class MemoryLocation;
29
30/// A simple AA result that uses TBAA metadata to answer queries.
32public:
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
53private:
54 bool Aliases(const MDNode *A, const MDNode *B) const;
55};
56
57/// Analysis pass providing a never-invalidated alias analysis result.
58class TypeBasedAA : public AnalysisInfoMixin<TypeBasedAA> {
60
61 static AnalysisKey Key;
62
63public:
65
67};
68
69/// Legacy wrapper pass to provide the TypeBasedAAResult object.
71 std::unique_ptr<TypeBasedAAResult> Result;
72
73public:
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//
92
93} // end namespace llvm
94
95#endif // LLVM_ANALYSIS_TYPEBASEDALIASANALYSIS_H
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
#define F(x, y, z)
Definition: MD5.cpp:55
This header defines various interfaces for pass management in LLVM.
This class stores info we want to provide to or retain within an alias query.
A base class to help implement the function alias analysis results concept.
The possible results of an alias query.
Definition: AliasAnalysis.h:83
API to communicate dependencies between analyses during invalidation.
Definition: PassManager.h:661
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:620
Represent the analysis usage information of a pass.
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Definition: InstrTypes.h:1184
ImmutablePass class - This class is used to provide information that does not need to be run.
Definition: Pass.h:279
Metadata node.
Definition: Metadata.h:943
Summary of how a function affects memory in the program.
Definition: ModRef.h:63
Representation for a specific memory location.
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:152
A simple AA result that uses TBAA metadata to answer queries.
bool invalidate(Function &, const PreservedAnalyses &, FunctionAnalysisManager::Invalidator &)
Handle invalidation events from the new pass manager.
AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB, AAQueryInfo &AAQI, const Instruction *CtxI)
ModRefInfo getModRefInfoMask(const MemoryLocation &Loc, AAQueryInfo &AAQI, bool IgnoreLocals)
ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc, AAQueryInfo &AAQI)
MemoryEffects getMemoryEffects(const CallBase *Call, AAQueryInfo &AAQI)
Legacy wrapper pass to provide the TypeBasedAAResult object.
bool doFinalization(Module &M) override
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes...
bool doInitialization(Module &M) override
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before ...
const TypeBasedAAResult & getResult() const
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
Analysis pass providing a never-invalidated alias analysis result.
TypeBasedAAResult run(Function &F, FunctionAnalysisManager &AM)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
ModRefInfo
Flags indicating whether a memory access modifies or references memory.
Definition: ModRef.h:27
ImmutablePass * createTypeBasedAAWrapperPass()
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:394
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:69