LLVM 18.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"
17
18namespace llvm {
19
20class Module;
21class ProfileSummaryInfo;
22class BlockFrequencyInfo;
23class TargetTransformInfo;
24class OptimizationRemarkEmitter;
25class AssumptionCache;
26class DominatorTree;
27class CodeExtractorAnalysisCache;
28
29/// A sequence of basic blocks.
30///
31/// A 0-sized SmallVector is slightly cheaper to move than a std::vector.
33
35public:
39 std::function<OptimizationRemarkEmitter &(Function &)> *GORE,
41 : PSI(ProfSI), GetBFI(GBFI), GetTTI(GTTI), GetORE(GORE), LookupAC(LAC) {}
42 bool run(Module &M);
43
44private:
45 bool isFunctionCold(const Function &F) const;
46 bool isBasicBlockCold(BasicBlock* BB,
47 BranchProbability ColdProbThresh,
49 SmallPtrSetImpl<BasicBlock *> &AnnotatedColdBlocks,
50 BlockFrequencyInfo *BFI) const;
51 bool shouldOutlineFrom(const Function &F) const;
52 bool outlineColdRegions(Function &F, bool HasProfileSummary);
53 Function *extractColdRegion(const BlockSequence &Region,
58 AssumptionCache *AC, unsigned Count);
62 std::function<OptimizationRemarkEmitter &(Function &)> *GetORE;
64};
65
66/// Pass to outline cold regions.
67class HotColdSplittingPass : public PassInfoMixin<HotColdSplittingPass> {
68public:
70};
71
72} // end namespace llvm
73
74#endif // LLVM_TRANSFORMS_IPO_HOTCOLDSPLITTING_H
75
#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:649
A cache of @llvm.assume calls within a function.
LLVM Basic Block Representation.
Definition: BasicBlock.h:60
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:165
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:172
Analysis providing profile information.
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:345
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:391