LLVM 18.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"
21#include <cstdint>
22#include <string>
23
24namespace llvm {
25
26class Function;
27class Instruction;
28class Module;
29
30namespace vfs {
31class FileSystem;
32} // namespace vfs
33
34/// The instrumentation (profile-instr-gen) pass for IR based PGO.
35// We use this pass to create COMDAT profile variables for context
36// sensitive PGO (CSPGO). The reason to have a pass for this is CSPGO
37// can be run after LTO/ThinLTO linking. Lld linker needs to see
38// all the COMDAT variables before linking. So we have this pass
39// always run before linking for CSPGO.
41 : public PassInfoMixin<PGOInstrumentationGenCreateVar> {
42public:
43 PGOInstrumentationGenCreateVar(std::string CSInstrName = "")
44 : CSInstrName(CSInstrName) {}
46
47private:
48 std::string CSInstrName;
49};
50
51/// The instrumentation (profile-instr-gen) pass for IR based PGO.
52class PGOInstrumentationGen : public PassInfoMixin<PGOInstrumentationGen> {
53public:
54 PGOInstrumentationGen(bool IsCS = false) : IsCS(IsCS) {}
56
57private:
58 // If this is a context sensitive instrumentation.
59 bool IsCS;
60};
61
62/// The profile annotation (profile-instr-use) pass for IR based PGO.
63class PGOInstrumentationUse : public PassInfoMixin<PGOInstrumentationUse> {
64public:
65 PGOInstrumentationUse(std::string Filename = "",
66 std::string RemappingFilename = "", bool IsCS = false,
68
70
71private:
72 std::string ProfileFileName;
73 std::string ProfileRemappingFileName;
74 // If this is a context sensitive instrumentation.
75 bool IsCS;
77};
78
79/// The indirect function call promotion pass.
80class PGOIndirectCallPromotion : public PassInfoMixin<PGOIndirectCallPromotion> {
81public:
82 PGOIndirectCallPromotion(bool IsInLTO = false, bool SamplePGO = false)
83 : InLTO(IsInLTO), SamplePGO(SamplePGO) {}
84
86
87private:
88 bool InLTO;
89 bool SamplePGO;
90};
91
92/// The profile size based optimization pass for memory intrinsics.
93class PGOMemOPSizeOpt : public PassInfoMixin<PGOMemOPSizeOpt> {
94public:
95 PGOMemOPSizeOpt() = default;
96
98};
99
101 uint64_t MaxCount);
102
104
105} // end namespace llvm
106
107#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:620
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: PassManager.h:152
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
void setIrrLoopHeaderMetadata(Module *M, Instruction *TI, uint64_t Count)
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:371