LLVM 19.0.0git
InstrProfCorrelator.h
Go to the documentation of this file.
1//===- InstrProfCorrelator.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// This file defines InstrProfCorrelator used to generate PGO/coverage profiles
9// from raw profile data and debug info/binary file.
10//===----------------------------------------------------------------------===//
11
12#ifndef LLVM_PROFILEDATA_INSTRPROFCORRELATOR_H
13#define LLVM_PROFILEDATA_INSTRPROFCORRELATOR_H
14
15#include "llvm/ADT/DenseSet.h"
17#include "llvm/Support/Error.h"
20#include <optional>
21#include <vector>
22
23namespace llvm {
24class DWARFContext;
25class DWARFDie;
26namespace object {
27class ObjectFile;
28}
29
30/// InstrProfCorrelator - A base class used to create raw instrumentation data
31/// to their functions.
33public:
34 /// Indicate if we should use the debug info or profile metadata sections to
35 /// correlate.
37
39 get(StringRef Filename, ProfCorrelatorKind FileKind);
40
41 /// Construct a ProfileData vector used to correlate raw instrumentation data
42 /// to their functions.
43 /// \param MaxWarnings the maximum number of warnings to emit (0 = no limit)
44 virtual Error correlateProfileData(int MaxWarnings) = 0;
45
46 /// Process debug info and dump the correlation data.
47 /// \param MaxWarnings the maximum number of warnings to emit (0 = no limit)
48 virtual Error dumpYaml(int MaxWarnings, raw_ostream &OS) = 0;
49
50 /// Return the number of ProfileData elements.
51 std::optional<size_t> getDataSize() const;
52
53 /// Return a pointer to the names string that this class constructs.
54 const char *getNamesPointer() const { return Names.c_str(); }
55
56 /// Return the number of bytes in the names string.
57 size_t getNamesSize() const { return Names.size(); }
58
59 /// Return the size of the counters section in bytes.
61 return Ctx->CountersSectionEnd - Ctx->CountersSectionStart;
62 }
63
64 static const char *FunctionNameAttributeName;
65 static const char *CFGHashAttributeName;
66 static const char *NumCountersAttributeName;
67
69 InstrProfCorrelatorKind getKind() const { return Kind; }
70 virtual ~InstrProfCorrelator() = default;
71
72protected:
73 struct Context {
75 get(std::unique_ptr<MemoryBuffer> Buffer, const object::ObjectFile &Obj,
76 ProfCorrelatorKind FileKind);
77 std::unique_ptr<MemoryBuffer> Buffer;
78 /// The address range of the __llvm_prf_cnts section.
81 /// The pointer points to start/end of profile data/name sections if
82 /// FileKind is Binary.
83 const char *DataStart;
84 const char *DataEnd;
85 const char *NameStart;
86 size_t NameSize;
87 /// True if target and host have different endian orders.
89 };
90 const std::unique_ptr<Context> Ctx;
91
92 InstrProfCorrelator(InstrProfCorrelatorKind K, std::unique_ptr<Context> Ctx)
93 : Ctx(std::move(Ctx)), Kind(K) {}
94
95 std::string Names;
96 std::vector<std::string> NamesVec;
97
98 struct Probe {
99 std::string FunctionName;
100 std::optional<std::string> LinkageName;
101 yaml::Hex64 CFGHash;
102 yaml::Hex64 CounterOffset;
104 std::optional<std::string> FilePath;
105 std::optional<int> LineNumber;
106 };
107
109 std::vector<Probe> Probes;
110 };
111
112 friend struct yaml::MappingTraits<Probe>;
113 friend struct yaml::SequenceElementTraits<Probe>;
115
116private:
118 get(std::unique_ptr<MemoryBuffer> Buffer, ProfCorrelatorKind FileKind);
119
120 const InstrProfCorrelatorKind Kind;
121};
122
123/// InstrProfCorrelatorImpl - A child of InstrProfCorrelator with a template
124/// pointer type so that the ProfileData vector can be materialized.
125template <class IntPtrT>
127public:
128 InstrProfCorrelatorImpl(std::unique_ptr<InstrProfCorrelator::Context> Ctx);
129 static bool classof(const InstrProfCorrelator *C);
130
131 /// Return a pointer to the underlying ProfileData vector that this class
132 /// constructs.
134 return Data.empty() ? nullptr : Data.data();
135 }
136
137 /// Return the number of ProfileData elements.
138 size_t getDataSize() const { return Data.size(); }
139
141 get(std::unique_ptr<InstrProfCorrelator::Context> Ctx,
142 const object::ObjectFile &Obj, ProfCorrelatorKind FileKind);
143
144protected:
145 std::vector<RawInstrProf::ProfileData<IntPtrT>> Data;
146
147 Error correlateProfileData(int MaxWarnings) override;
149 int MaxWarnings,
151
153
154 Error dumpYaml(int MaxWarnings, raw_ostream &OS) override;
155
156 void addDataProbe(uint64_t FunctionName, uint64_t CFGHash,
157 IntPtrT CounterOffset, IntPtrT FunctionPtr,
158 uint32_t NumCounters);
159
160 // Byte-swap the value if necessary.
161 template <class T> T maybeSwap(T Value) const {
162 return Ctx->ShouldSwapBytes ? llvm::byteswap(Value) : Value;
163 }
164
165private:
167 std::unique_ptr<InstrProfCorrelator::Context> Ctx)
168 : InstrProfCorrelator(Kind, std::move(Ctx)){};
169 llvm::DenseSet<IntPtrT> CounterOffsets;
170};
171
172/// DwarfInstrProfCorrelator - A child of InstrProfCorrelatorImpl that takes
173/// DWARF debug info as input to correlate profiles.
174template <class IntPtrT>
176public:
177 DwarfInstrProfCorrelator(std::unique_ptr<DWARFContext> DICtx,
178 std::unique_ptr<InstrProfCorrelator::Context> Ctx)
180 DICtx(std::move(DICtx)) {}
181
182private:
183 std::unique_ptr<DWARFContext> DICtx;
184
185 /// Return the address of the object that the provided DIE symbolizes.
186 std::optional<uint64_t> getLocation(const DWARFDie &Die) const;
187
188 /// Returns true if the provided DIE symbolizes an instrumentation probe
189 /// symbol.
190 static bool isDIEOfProbe(const DWARFDie &Die);
191
192 /// Iterate over DWARF DIEs to find those that symbolize instrumentation
193 /// probes and construct the ProfileData vector and Names string.
194 ///
195 /// Here is some example DWARF for an instrumentation probe we are looking
196 /// for:
197 /// \code
198 /// DW_TAG_subprogram
199 /// DW_AT_low_pc (0x0000000000000000)
200 /// DW_AT_high_pc (0x0000000000000014)
201 /// DW_AT_name ("foo")
202 /// DW_TAG_variable
203 /// DW_AT_name ("__profc_foo")
204 /// DW_AT_location (DW_OP_addr 0x0)
205 /// DW_TAG_LLVM_annotation
206 /// DW_AT_name ("Function Name")
207 /// DW_AT_const_value ("foo")
208 /// DW_TAG_LLVM_annotation
209 /// DW_AT_name ("CFG Hash")
210 /// DW_AT_const_value (12345678)
211 /// DW_TAG_LLVM_annotation
212 /// DW_AT_name ("Num Counters")
213 /// DW_AT_const_value (2)
214 /// NULL
215 /// NULL
216 /// \endcode
217 /// \param MaxWarnings the maximum number of warnings to emit (0 = no limit)
218 /// \param Data if provided, populate with the correlation data found
219 void correlateProfileDataImpl(
220 int MaxWarnings,
221 InstrProfCorrelator::CorrelationData *Data = nullptr) override;
222
223 Error correlateProfileNameImpl() override;
224};
225
226/// BinaryInstrProfCorrelator - A child of InstrProfCorrelatorImpl that
227/// takes an object file as input to correlate profiles.
228template <class IntPtrT>
230public:
231 BinaryInstrProfCorrelator(std::unique_ptr<InstrProfCorrelator::Context> Ctx)
233
234 /// Return a pointer to the names string that this class constructs.
235 const char *getNamesPointer() const { return this->Ctx.NameStart; }
236
237 /// Return the number of bytes in the names string.
238 size_t getNamesSize() const { return this->Ctx.NameSize; }
239
240private:
241 void correlateProfileDataImpl(
242 int MaxWarnings,
243 InstrProfCorrelator::CorrelationData *Data = nullptr) override;
244
245 Error correlateProfileNameImpl() override;
246};
247
248} // end namespace llvm
249
250#endif // LLVM_PROFILEDATA_INSTRPROFCORRELATOR_H
This file defines the DenseSet and SmallDenseSet classes.
raw_pwrite_stream & OS
BinaryInstrProfCorrelator - A child of InstrProfCorrelatorImpl that takes an object file as input to ...
size_t getNamesSize() const
Return the number of bytes in the names string.
const char * getNamesPointer() const
Return a pointer to the names string that this class constructs.
BinaryInstrProfCorrelator(std::unique_ptr< InstrProfCorrelator::Context > Ctx)
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
Definition: DWARFDie.h:42
Implements a dense probed hash-table based set.
Definition: DenseSet.h:271
DwarfInstrProfCorrelator - A child of InstrProfCorrelatorImpl that takes DWARF debug info as input to...
DwarfInstrProfCorrelator(std::unique_ptr< DWARFContext > DICtx, std::unique_ptr< InstrProfCorrelator::Context > Ctx)
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
Tagged union holding either a T or a Error.
Definition: Error.h:474
InstrProfCorrelatorImpl - A child of InstrProfCorrelator with a template pointer type so that the Pro...
static llvm::Expected< std::unique_ptr< InstrProfCorrelatorImpl< IntPtrT > > > get(std::unique_ptr< InstrProfCorrelator::Context > Ctx, const object::ObjectFile &Obj, ProfCorrelatorKind FileKind)
virtual Error correlateProfileNameImpl()=0
virtual void correlateProfileDataImpl(int MaxWarnings, InstrProfCorrelator::CorrelationData *Data=nullptr)=0
std::vector< RawInstrProf::ProfileData< IntPtrT > > Data
Error correlateProfileData(int MaxWarnings) override
Construct a ProfileData vector used to correlate raw instrumentation data to their functions.
static bool classof(const InstrProfCorrelator *C)
InstrProfCorrelatorImpl(std::unique_ptr< InstrProfCorrelator::Context > Ctx)
void addDataProbe(uint64_t FunctionName, uint64_t CFGHash, IntPtrT CounterOffset, IntPtrT FunctionPtr, uint32_t NumCounters)
const RawInstrProf::ProfileData< IntPtrT > * getDataPointer() const
Return a pointer to the underlying ProfileData vector that this class constructs.
Error dumpYaml(int MaxWarnings, raw_ostream &OS) override
Process debug info and dump the correlation data.
size_t getDataSize() const
Return the number of ProfileData elements.
InstrProfCorrelator - A base class used to create raw instrumentation data to their functions.
virtual Error correlateProfileData(int MaxWarnings)=0
Construct a ProfileData vector used to correlate raw instrumentation data to their functions.
static const char * FunctionNameAttributeName
static const char * CFGHashAttributeName
static llvm::Expected< std::unique_ptr< InstrProfCorrelator > > get(StringRef Filename, ProfCorrelatorKind FileKind)
InstrProfCorrelator(InstrProfCorrelatorKind K, std::unique_ptr< Context > Ctx)
uint64_t getCountersSectionSize() const
Return the size of the counters section in bytes.
std::vector< std::string > NamesVec
static const char * NumCountersAttributeName
virtual Error dumpYaml(int MaxWarnings, raw_ostream &OS)=0
Process debug info and dump the correlation data.
const char * getNamesPointer() const
Return a pointer to the names string that this class constructs.
ProfCorrelatorKind
Indicate if we should use the debug info or profile metadata sections to correlate.
virtual ~InstrProfCorrelator()=default
InstrProfCorrelatorKind getKind() const
const std::unique_ptr< Context > Ctx
std::optional< size_t > getDataSize() const
Return the number of ProfileData elements.
size_t getNamesSize() const
Return the number of bytes in the names string.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
LLVM Value Representation.
Definition: Value.h:74
This class is the base class for all object file types.
Definition: ObjectFile.h:229
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
constexpr T byteswap(T V) noexcept
Reverses the bytes in the given integer value V.
Definition: bit.h:101
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1858
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
bool ShouldSwapBytes
True if target and host have different endian orders.
std::unique_ptr< MemoryBuffer > Buffer
static llvm::Expected< std::unique_ptr< Context > > get(std::unique_ptr< MemoryBuffer > Buffer, const object::ObjectFile &Obj, ProfCorrelatorKind FileKind)
uint64_t CountersSectionStart
The address range of the __llvm_prf_cnts section.
const char * DataStart
The pointer points to start/end of profile data/name sections if FileKind is Binary.
std::optional< std::string > LinkageName
std::optional< std::string > FilePath