LLVM 19.0.0git
PGOInstrumentation.h
Go to the documentation of this file.
1//===- Transforms/Instrumentation/PGOInstrumentation.h ----------*- 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 file provides the interface for IR based instrumentation passes (
11/// (profile-gen, and profile-use).
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
16#define LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
17
18#include "llvm/ADT/ArrayRef.h"
20#include "llvm/IR/PassManager.h"
22#include <cstdint>
23#include <string>
24
25namespace llvm {
26
27extern cl::opt<bool> DebugInfoCorrelate;
28
29class Function;
30class Instruction;
31class Module;
32
33namespace vfs {
34class FileSystem;
35} // namespace vfs
36
37/// The instrumentation (profile-instr-gen) pass for IR based PGO.
38// We use this pass to create COMDAT profile variables for context
39// sensitive PGO (CSPGO). The reason to have a pass for this is CSPGO
40// can be run after LTO/ThinLTO linking. Lld linker needs to see
41// all the COMDAT variables before linking. So we have this pass
42// always run before linking for CSPGO.
44 : public PassInfoMixin<PGOInstrumentationGenCreateVar> {
45public:
46 PGOInstrumentationGenCreateVar(std::string CSInstrName = "")
47 : CSInstrName(CSInstrName) {}
49
50private:
51 std::string CSInstrName;
52};
53
54/// The instrumentation (profile-instr-gen) pass for IR based PGO.
55class PGOInstrumentationGen : public PassInfoMixin<PGOInstrumentationGen> {
56public:
57 PGOInstrumentationGen(bool IsCS = false) : IsCS(IsCS) {}
59
60private:
61 // If this is a context sensitive instrumentation.
62 bool IsCS;
63};
64
65/// The profile annotation (profile-instr-use) pass for IR based PGO.
66class PGOInstrumentationUse : public PassInfoMixin<PGOInstrumentationUse> {
67public:
68 PGOInstrumentationUse(std::string Filename = "",
69 std::string RemappingFilename = "", bool IsCS = false,
71
73
74private:
75 std::string ProfileFileName;
76 std::string ProfileRemappingFileName;
77 // If this is a context sensitive instrumentation.
78 bool IsCS;
80};
81
82/// The indirect function call promotion pass.
83class PGOIndirectCallPromotion : public PassInfoMixin<PGOIndirectCallPromotion> {
84public:
85 PGOIndirectCallPromotion(bool IsInLTO = false, bool SamplePGO = false)
86 : InLTO(IsInLTO), SamplePGO(SamplePGO) {}
87
89
90private:
91 bool InLTO;
92 bool SamplePGO;
93};
94
95/// The profile size based optimization pass for memory intrinsics.
96class PGOMemOPSizeOpt : public PassInfoMixin<PGOMemOPSizeOpt> {
97public:
98 PGOMemOPSizeOpt() = default;
99
101};
102
104 uint64_t MaxCount);
105
107
108} // end namespace llvm
109
110#endif // LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
This file defines the RefCountedBase, ThreadSafeRefCountedBase, and IntrusiveRefCntPtr classes.
#define F(x, y, z)
Definition: MD5.cpp:55
Machine Check Debug Module
ModuleAnalysisManager MAM
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:348
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
A smart pointer to a reference-counted object that inherits from RefCountedBase or ThreadSafeRefCount...
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
The indirect function call promotion pass.
PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM)
PGOIndirectCallPromotion(bool IsInLTO=false, bool SamplePGO=false)
The instrumentation (profile-instr-gen) pass for IR based PGO.
PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM)
PGOInstrumentationGenCreateVar(std::string CSInstrName="")
The instrumentation (profile-instr-gen) pass for IR based PGO.
PGOInstrumentationGen(bool IsCS=false)
PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM)
The profile annotation (profile-instr-use) pass for IR based PGO.
PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM)
The profile size based optimization pass for memory intrinsics.
PreservedAnalyses run(Function &F, FunctionAnalysisManager &MAM)
A set of analyses that are preserved following a run of a transformation pass.
Definition: Analysis.h:109
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
void setIrrLoopHeaderMetadata(Module *M, Instruction *TI, uint64_t Count)
cl::opt< bool > DebugInfoCorrelate
void setProfMetadata(Module *M, Instruction *TI, ArrayRef< uint64_t > EdgeCounts, uint64_t MaxCount)
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:91