LLVM  11.0.0git
ModuleSummaryAnalysis.h
Go to the documentation of this file.
1 //===- ModuleSummaryAnalysis.h - Module summary index builder ---*- 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 /// \file
9 /// This is the interface to build a ModuleSummaryIndex for a module.
10 ///
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_ANALYSIS_MODULESUMMARYANALYSIS_H
14 #define LLVM_ANALYSIS_MODULESUMMARYANALYSIS_H
15 
16 #include "llvm/ADT/Optional.h"
18 #include "llvm/IR/PassManager.h"
19 #include "llvm/Pass.h"
20 #include <functional>
21 
22 namespace llvm {
23 
24 class BlockFrequencyInfo;
25 class Function;
26 class Module;
27 class ProfileSummaryInfo;
28 class StackSafetyInfo;
29 
30 /// Direct function to compute a \c ModuleSummaryIndex from a given module.
31 ///
32 /// If operating within a pass manager which has defined ways to compute the \c
33 /// BlockFrequencyInfo for a given function, that can be provided via
34 /// a std::function callback. Otherwise, this routine will manually construct
35 /// that information.
36 ModuleSummaryIndex buildModuleSummaryIndex(
37  const Module &M,
38  std::function<BlockFrequencyInfo *(const Function &F)> GetBFICallback,
39  ProfileSummaryInfo *PSI,
40  std::function<const StackSafetyInfo *(const Function &F)> GetSSICallback =
41  [](const Function &F) -> const StackSafetyInfo * { return nullptr; });
42 
43 /// Analysis pass to provide the ModuleSummaryIndex object.
45  : public AnalysisInfoMixin<ModuleSummaryIndexAnalysis> {
47 
48  static AnalysisKey Key;
49 
50 public:
52 
54 };
55 
56 /// Legacy wrapper pass to provide the ModuleSummaryIndex object.
59 
60 public:
61  static char ID;
62 
64 
65  /// Get the index built by pass
67  const ModuleSummaryIndex &getIndex() const { return *Index; }
68 
69  bool runOnModule(Module &M) override;
70  bool doFinalization(Module &M) override;
71  void getAnalysisUsage(AnalysisUsage &AU) const override;
72 };
73 
74 //===--------------------------------------------------------------------===//
75 //
76 // createModuleSummaryIndexWrapperPass - This pass builds a ModuleSummaryIndex
77 // object for the module, to be written to bitcode or LLVM assembly.
78 //
80 
81 /// Legacy wrapper pass to provide the ModuleSummaryIndex object.
84 
85 public:
86  static char ID;
87 
89  const ModuleSummaryIndex *Index = nullptr);
90  const ModuleSummaryIndex *getIndex() const { return Index; }
91  void getAnalysisUsage(AnalysisUsage &AU) const override;
92 };
93 
94 //===--------------------------------------------------------------------===//
95 //
96 // ImmutableModuleSummaryIndexWrapperPass - This pass wrap provided
97 // ModuleSummaryIndex object for the module, to be used by other passes.
98 //
101 
102 } // end namespace llvm
103 
104 #endif // LLVM_ANALYSIS_MODULESUMMARYANALYSIS_H
Legacy wrapper pass to provide the ModuleSummaryIndex object.
ModuleSummaryIndex buildModuleSummaryIndex(const Module &M, std::function< BlockFrequencyInfo *(const Function &F)> GetBFICallback, ProfileSummaryInfo *PSI, std::function< const StackSafetyInfo *(const Function &F)> GetSSICallback=[](const Function &F) -> const StackSafetyInfo *{ return nullptr;})
Direct function to compute a ModuleSummaryIndex from a given module.
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:67
Machine Debugify Module
F(f)
Analysis pass to provide the ModuleSummaryIndex object.
const ModuleSummaryIndex & getIndex() const
ModuleSummaryIndex & getIndex()
Get the index built by pass.
Class to hold module path string table and global value map, and encapsulate methods for operating on...
const ModuleSummaryIndex * getIndex() const
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:390
Represent the analysis usage information of a pass.
ImmutablePass class - This class is used to provide information that does not need to be run...
Definition: Pass.h:255
Result run(Module &M, ModuleAnalysisManager &AM)
ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...
Definition: Pass.h:224
ModuleSummaryIndex.h This file contains the declarations the classes that hold the module index and s...
ModulePass * createModuleSummaryIndexWrapperPass()
print Print MemDeps of function
A container for analyses that lazily runs them and caches their results.
This header defines various interfaces for pass management in LLVM.
ImmutablePass * createImmutableModuleSummaryIndexWrapperPass(const ModuleSummaryIndex *Index)
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:71
Legacy wrapper pass to provide the ModuleSummaryIndex object.