LLVM 17.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
17#include "llvm/IR/PassManager.h"
18#include "llvm/Pass.h"
19#include <functional>
20#include <optional>
21
22namespace llvm {
23
24class BlockFrequencyInfo;
25class Function;
26class Module;
27class ProfileSummaryInfo;
28class 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.
36ModuleSummaryIndex 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
50public:
52
54};
55
56/// Legacy wrapper pass to provide the ModuleSummaryIndex object.
58 std::optional<ModuleSummaryIndex> Index;
59
60public:
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
85public:
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//
99ImmutablePass *
100createImmutableModuleSummaryIndexWrapperPass(const ModuleSummaryIndex *Index);
101
102} // end namespace llvm
103
104#endif // LLVM_ANALYSIS_MODULESUMMARYANALYSIS_H
#define F(x, y, z)
Definition: MD5.cpp:55
Machine Check Debug Module
ModuleSummaryIndex.h This file contains the declarations the classes that hold the module index and s...
This header defines various interfaces for pass management in LLVM.
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:620
Represent the analysis usage information of a pass.
Legacy wrapper pass to provide the ModuleSummaryIndex object.
const ModuleSummaryIndex * getIndex() const
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
ImmutablePass class - This class is used to provide information that does not need to be run.
Definition: Pass.h:279
ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...
Definition: Pass.h:248
Analysis pass to provide the ModuleSummaryIndex object.
Result run(Module &M, ModuleAnalysisManager &AM)
Legacy wrapper pass to provide the ModuleSummaryIndex object.
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
bool doFinalization(Module &M) override
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes...
bool runOnModule(Module &M) override
runOnModule - Virtual method overriden by subclasses to process the module being operated on.
ModuleSummaryIndex & getIndex()
Get the index built by pass.
const ModuleSummaryIndex & getIndex() const
Class to hold module path string table and global value map, and encapsulate methods for operating on...
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
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.
ModulePass * createModuleSummaryIndexWrapperPass()
ImmutablePass * createImmutableModuleSummaryIndexWrapperPass(const ModuleSummaryIndex *Index)
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