LLVM 17.0.0git
HotColdSplitting.h
Go to the documentation of this file.
1//===- HotColdSplitting.h ---- Outline Cold Regions -------------*- 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// This pass outlines cold regions to a separate function.
9//
10//===----------------------------------------------------------------------===//
11
12#ifndef LLVM_TRANSFORMS_IPO_HOTCOLDSPLITTING_H
13#define LLVM_TRANSFORMS_IPO_HOTCOLDSPLITTING_H
14
15#include "llvm/IR/PassManager.h"
16
17namespace llvm {
18
19class Module;
20class ProfileSummaryInfo;
21class BlockFrequencyInfo;
22class TargetTransformInfo;
23class OptimizationRemarkEmitter;
24class AssumptionCache;
25class DominatorTree;
26class CodeExtractorAnalysisCache;
27
28/// A sequence of basic blocks.
29///
30/// A 0-sized SmallVector is slightly cheaper to move than a std::vector.
32
34public:
38 std::function<OptimizationRemarkEmitter &(Function &)> *GORE,
40 : PSI(ProfSI), GetBFI(GBFI), GetTTI(GTTI), GetORE(GORE), LookupAC(LAC) {}
41 bool run(Module &M);
42
43private:
44 bool isFunctionCold(const Function &F) const;
45 bool shouldOutlineFrom(const Function &F) const;
46 bool outlineColdRegions(Function &F, bool HasProfileSummary);
47 Function *extractColdRegion(const BlockSequence &Region,
52 AssumptionCache *AC, unsigned Count);
56 std::function<OptimizationRemarkEmitter &(Function &)> *GetORE;
58};
59
60/// Pass to outline cold regions.
61class HotColdSplittingPass : public PassInfoMixin<HotColdSplittingPass> {
62public:
64};
65
66} // end namespace llvm
67
68#endif // LLVM_TRANSFORMS_IPO_HOTCOLDSPLITTING_H
69
#define F(x, y, z)
Definition: MD5.cpp:55
Machine Check Debug Module
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
A cache of @llvm.assume calls within a function.
BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequen...
A cache for the CodeExtractor analysis.
Definition: CodeExtractor.h:46
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition: Dominators.h:166
Pass to outline cold regions.
PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)
HotColdSplitting(ProfileSummaryInfo *ProfSI, function_ref< BlockFrequencyInfo *(Function &)> GBFI, function_ref< TargetTransformInfo &(Function &)> GTTI, std::function< OptimizationRemarkEmitter &(Function &)> *GORE, function_ref< AssumptionCache *(Function &)> LAC)
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
The optimization diagnostic interface.
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:152
Analysis providing profile information.
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1200
This pass provides access to the codegen interfaces that are needed for IR-level transformations.
An efficient, type-erasing, non-owning reference to a callable.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:371