LLVM  9.0.0svn
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/InstrTypes.h"
20 #include "llvm/IR/PassManager.h"
21 #include "llvm/Pass.h"
22 #include <memory>
23 
24 namespace llvm {
25 
26 class Function;
27 class MDNode;
28 class MemoryLocation;
29 
30 /// A simple AA result that uses TBAA metadata to answer queries.
31 class TypeBasedAAResult : public AAResultBase<TypeBasedAAResult> {
33 
34 public:
35  /// Handle invalidation events from the new pass manager.
36  ///
37  /// By definition, this result is stateless and so remains valid.
40  return false;
41  }
42 
43  AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB);
44  bool pointsToConstantMemory(const MemoryLocation &Loc, bool OrLocal);
47  ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc);
48  ModRefInfo getModRefInfo(const CallBase *Call1, const CallBase *Call2);
49 
50 private:
51  bool Aliases(const MDNode *A, const MDNode *B) const;
52  bool PathAliases(const MDNode *A, const MDNode *B) const;
53 };
54 
55 /// Analysis pass providing a never-invalidated alias analysis result.
56 class TypeBasedAA : public AnalysisInfoMixin<TypeBasedAA> {
58 
59  static AnalysisKey Key;
60 
61 public:
63 
65 };
66 
67 /// Legacy wrapper pass to provide the TypeBasedAAResult object.
69  std::unique_ptr<TypeBasedAAResult> Result;
70 
71 public:
72  static char ID;
73 
75 
76  TypeBasedAAResult &getResult() { return *Result; }
77  const TypeBasedAAResult &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 // createTypeBasedAAWrapperPass - This pass implements metadata-based
87 // type-based alias analysis.
88 //
90 
91 } // end namespace llvm
92 
93 #endif // LLVM_ANALYSIS_TYPEBASEDALIASANALYSIS_H
Analysis pass providing a never-invalidated alias analysis result.
This class represents lattice values for constants.
Definition: AllocatorList.h:23
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:64
const TypeBasedAAResult & getResult() const
Metadata node.
Definition: Metadata.h:863
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Definition: InstrTypes.h:1014
F(f)
AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB)
Legacy wrapper pass to provide the TypeBasedAAResult object.
bool invalidate(Function &, const PreservedAnalyses &, FunctionAnalysisManager::Invalidator &)
Handle invalidation events from the new pass manager.
FunctionModRefBehavior getModRefBehavior(const CallBase *Call)
A CRTP-driven "mixin" base class to help implement the function alias analysis results concept...
Key
PAL metadata keys.
FunctionModRefBehavior
Summary of how a function affects memory in the program.
AliasResult
The possible results of an alias query.
Definition: AliasAnalysis.h:77
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:153
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:382
Represent the analysis usage information of a pass.
A simple AA result that uses TBAA metadata to answer queries.
Representation for a specific memory location.
ImmutablePass class - This class is used to provide information that does not need to be run...
Definition: Pass.h:255
ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc)
ImmutablePass * createTypeBasedAAWrapperPass()
API to communicate dependencies between analyses during invalidation.
Definition: PassManager.h:641
ModRefInfo
Flags indicating whether a memory access modifies or references memory.
A container for analyses that lazily runs them and caches their results.
This header defines various interfaces for pass management in LLVM.
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:70
bool pointsToConstantMemory(const MemoryLocation &Loc, bool OrLocal)