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"
19#include "llvm/ADT/IntrusiveRefCntPtr.h"
20#include "llvm/IR/PassManager.h"
21#include "llvm/Support/CommandLine.h"
22#include "llvm/Support/Compiler.h"
23#include "llvm/Support/VirtualFileSystem.h"
24#include <cstdint>
25#include <string>
26
27namespace llvm {
28
29class Function;
30class Instruction;
31class Module;
32
33/// The instrumentation (profile-instr-gen) pass for IR based PGO.
34// We use this pass to create COMDAT profile variables for context
35// sensitive PGO (CSPGO). The reason to have a pass for this is CSPGO
36// can be run after LTO/ThinLTO linking. Lld linker needs to see
37// all the COMDAT variables before linking. So we have this pass
38// always run before linking for CSPGO.
39class PGOInstrumentationGenCreateVar
40 : public PassInfoMixin<PGOInstrumentationGenCreateVar> {
41public:
42 PGOInstrumentationGenCreateVar(std::string CSInstrName = "",
43 bool Sampling = false)
44 : CSInstrName(CSInstrName), ProfileSampling(Sampling) {}
45 LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
46
47private:
48 std::string CSInstrName;
49 bool ProfileSampling;
50};
51
52enum class PGOInstrumentationType { Invalid = 0, FDO, CSFDO, CTXPROF };
53/// The instrumentation (profile-instr-gen) pass for IR based PGO.
54class PGOInstrumentationGen : public PassInfoMixin<PGOInstrumentationGen> {
55public:
56 PGOInstrumentationGen(
57 PGOInstrumentationType InstrumentationType = PGOInstrumentationType ::FDO)
58 : InstrumentationType(InstrumentationType) {}
59 LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
60
61private:
62 // If this is a context sensitive instrumentation.
63 const PGOInstrumentationType InstrumentationType;
64};
65
66/// The profile annotation (profile-instr-use) pass for IR based PGO.
67class PGOInstrumentationUse : public PassInfoMixin<PGOInstrumentationUse> {
68public:
69 LLVM_ABI
70 PGOInstrumentationUse(std::string Filename = "",
71 std::string RemappingFilename = "", bool IsCS = false,
72 IntrusiveRefCntPtr<vfs::FileSystem> FS = nullptr);
73
74 LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
75
76private:
77 std::string ProfileFileName;
78 std::string ProfileRemappingFileName;
79 // If this is a context sensitive instrumentation.
80 bool IsCS;
81 IntrusiveRefCntPtr<vfs::FileSystem> FS;
82};
83
84/// The indirect function call promotion pass.
85class PGOIndirectCallPromotion : public PassInfoMixin<PGOIndirectCallPromotion> {
86public:
87 PGOIndirectCallPromotion(bool IsInLTO = false, bool SamplePGO = false)
88 : InLTO(IsInLTO), SamplePGO(SamplePGO) {}
89
90 LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
91
92private:
93 bool InLTO;
94 bool SamplePGO;
95};
96
97/// The profile size based optimization pass for memory intrinsics.
98class PGOMemOPSizeOpt : public PassInfoMixin<PGOMemOPSizeOpt> {
99public:
100 PGOMemOPSizeOpt() = default;
101
102 LLVM_ABI PreservedAnalyses run(Function &F, FunctionAnalysisManager &MAM);
103};
104
105LLVM_ABI void setProfMetadata(Instruction *TI, ArrayRef<uint64_t> EdgeCounts,
106 uint64_t MaxCount);
107
108LLVM_ABI void setIrrLoopHeaderMetadata(Module *M, Instruction *TI,
109 uint64_t Count);
110
111} // end namespace llvm
112
113#endif // LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
114