LLVM 19.0.0git
InstrProfWriter.h
Go to the documentation of this file.
1//===- InstrProfWriter.h - Instrumented profiling writer --------*- 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// This file contains support for writing profiling data for instrumentation
10// based PGO and coverage.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_PROFILEDATA_INSTRPROFWRITER_H
15#define LLVM_PROFILEDATA_INSTRPROFWRITER_H
16
17#include "llvm/ADT/DenseMap.h"
18#include "llvm/ADT/MapVector.h"
19#include "llvm/ADT/StringMap.h"
20#include "llvm/IR/GlobalValue.h"
21#include "llvm/Object/BuildID.h"
24#include "llvm/Support/Error.h"
25#include <cstdint>
26#include <memory>
27#include <random>
28
29namespace llvm {
30
31/// Writer for instrumentation based profile data.
32class InstrProfRecordWriterTrait;
33class ProfOStream;
34class MemoryBuffer;
35class raw_fd_ostream;
36
38public:
40
41private:
42 bool Sparse;
43 StringMap<ProfilingData> FunctionData;
44 /// The maximum length of a single temporal profile trace.
45 uint64_t MaxTemporalProfTraceLength;
46 /// The maximum number of stored temporal profile traces.
47 uint64_t TemporalProfTraceReservoirSize;
48 /// The total number of temporal profile traces seen.
49 uint64_t TemporalProfTraceStreamSize = 0;
50 /// The list of temporal profile traces.
51 SmallVector<TemporalProfTraceTy> TemporalProfTraces;
52 std::mt19937 RNG;
53
54 // The MemProf data.
56
57 // List of binary ids.
58 std::vector<llvm::object::BuildID> BinaryIds;
59
60 // Read the vtable names from raw instr profile reader.
61 StringSet<> VTableNames;
62
63 // An enum describing the attributes of the profile.
65 // Use raw pointer here for the incomplete type object.
67
68 // Temporary support for writing the previous version of the format, to enable
69 // some forward compatibility. Currently this suppresses the writing of the
70 // new vtable names section and header fields.
71 // TODO: Consider enabling this with future version changes as well, to ease
72 // deployment of newer versions of llvm-profdata.
73 bool WritePrevVersion = false;
74
75 // The MemProf version we should write.
76 memprof::IndexedVersion MemProfVersionRequested;
77
78 // Whether to serialize the full schema.
79 bool MemProfFullSchema;
80
81public:
83 bool Sparse = false, uint64_t TemporalProfTraceReservoirSize = 0,
84 uint64_t MaxTemporalProfTraceLength = 0, bool WritePrevVersion = false,
85 memprof::IndexedVersion MemProfVersionRequested = memprof::Version0,
86 bool MemProfFullSchema = false);
88
89 StringMap<ProfilingData> &getProfileData() { return FunctionData; }
90
91 /// Add function counts for the given function. If there are already counts
92 /// for this function and the hash and number of counts match, each counter is
93 /// summed. Optionally scale counts by \p Weight.
95 function_ref<void(Error)> Warn);
97 addRecord(std::move(I), 1, Warn);
98 }
99 void addVTableName(StringRef VTableName) { VTableNames.insert(VTableName); }
100
101 /// Add \p SrcTraces using reservoir sampling where \p SrcStreamSize is the
102 /// total number of temporal profiling traces the source has seen.
104 uint64_t SrcStreamSize);
105
106 /// Add a memprof record for a function identified by its \p Id.
109
110 /// Add a memprof frame identified by the hash of the contents of the frame in
111 /// \p FrameId.
113 function_ref<void(Error)> Warn);
114
115 /// Add a call stack identified by the hash of the contents of the call stack
116 /// in \p CallStack.
119 function_ref<void(Error)> Warn);
120
121 // Add a binary id to the binary ids list.
123
124 /// Merge existing function counts from the given writer.
126 function_ref<void(Error)> Warn);
127
128 /// Write the profile to \c OS
130
131 /// Write the profile to a string output stream \c OS
133
134 /// Write the profile in text format to \c OS
136
137 /// Write temporal profile trace data to the header in text format to \c OS
139 InstrProfSymtab &Symtab);
140
142
143 /// Write \c Record in text format to \c OS
144 static void writeRecordInText(StringRef Name, uint64_t Hash,
147
148 /// Write the profile, returning the raw data. For testing.
149 std::unique_ptr<MemoryBuffer> writeBuffer();
150
151 /// Update the attributes of the current profile from the attributes
152 /// specified. An error is returned if IR and FE profiles are mixed.
154 // If the kind is unset, this is the first profile we are merging so just
155 // set it to the given type.
156 if (ProfileKind == InstrProfKind::Unknown) {
157 ProfileKind = Other;
158 return Error::success();
159 }
160
161 // Returns true if merging is should fail assuming A and B are incompatible.
162 auto testIncompatible = [&](InstrProfKind A, InstrProfKind B) {
163 return (static_cast<bool>(ProfileKind & A) &&
164 static_cast<bool>(Other & B)) ||
165 (static_cast<bool>(ProfileKind & B) &&
166 static_cast<bool>(Other & A));
167 };
168
169 // Check if the profiles are in-compatible. Clang frontend profiles can't be
170 // merged with other profile types.
171 if (static_cast<bool>(
174 return make_error<InstrProfError>(instrprof_error::unsupported_version);
175 }
176 if (testIncompatible(InstrProfKind::FunctionEntryOnly,
178 return make_error<InstrProfError>(
180 "cannot merge FunctionEntryOnly profiles and BB profiles together");
181 }
182
183 // Now we update the profile type with the bits that are set.
184 ProfileKind |= Other;
185 return Error::success();
186 }
187
188 InstrProfKind getProfileKind() const { return ProfileKind; }
189
191 return static_cast<bool>(ProfileKind & InstrProfKind::SingleByteCoverage);
192 }
193
194 // Internal interfaces for testing purpose only.
196 void setOutputSparse(bool Sparse);
198 MemProfVersionRequested = Version;
199 }
200 void setMemProfFullSchema(bool Full) { MemProfFullSchema = Full; }
201 // Compute the overlap b/w this object and Other. Program level result is
202 // stored in Overlap and function level result is stored in FuncLevelOverlap.
204 OverlapStats &FuncLevelOverlap,
205 const OverlapFuncFilters &FuncFilter);
206
207private:
209 uint64_t Weight, function_ref<void(Error)> Warn);
210 bool shouldEncodeData(const ProfilingData &PD);
211 /// Add \p Trace using reservoir sampling.
212 void addTemporalProfileTrace(TemporalProfTraceTy Trace);
213
214 Error writeImpl(ProfOStream &OS);
215
216 // Writes known header fields and reserves space for fields whose value are
217 // known only after payloads are written. Returns the start byte offset for
218 // back patching.
219 uint64_t writeHeader(const IndexedInstrProf::Header &header,
220 const bool WritePrevVersion, ProfOStream &OS);
221
222 // Writes compressed vtable names to profiles.
223 Error writeVTableNames(ProfOStream &OS);
224};
225
226} // end namespace llvm
227
228#endif // LLVM_PROFILEDATA_INSTRPROFWRITER_H
This file defines the StringMap class.
This file declares a library for handling Build IDs and using them to find debug info.
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
This file defines the DenseMap class.
std::string Name
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
This file implements a map that provides insertion order iteration.
raw_pwrite_stream & OS
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
static ErrorSuccess success()
Create a success value.
Definition: Error.h:334
A symbol table used for function [IR]PGO name look-up with keys (such as pointers,...
Definition: InstrProf.h:453
bool hasSingleByteCoverage() const
void addVTableName(StringRef VTableName)
Error write(raw_fd_ostream &OS)
Write the profile to OS.
void addTemporalProfileTraces(SmallVectorImpl< TemporalProfTraceTy > &SrcTraces, uint64_t SrcStreamSize)
Add SrcTraces using reservoir sampling where SrcStreamSize is the total number of temporal profiling ...
void overlapRecord(NamedInstrProfRecord &&Other, OverlapStats &Overlap, OverlapStats &FuncLevelOverlap, const OverlapFuncFilters &FuncFilter)
Error writeText(raw_fd_ostream &OS)
Write the profile in text format to OS.
InstrProfKind getProfileKind() const
void addRecord(NamedInstrProfRecord &&I, function_ref< void(Error)> Warn)
void addBinaryIds(ArrayRef< llvm::object::BuildID > BIs)
void addMemProfRecord(const GlobalValue::GUID Id, const memprof::IndexedMemProfRecord &Record)
Add a memprof record for a function identified by its Id.
void setMemProfVersionRequested(memprof::IndexedVersion Version)
static void writeRecordInText(StringRef Name, uint64_t Hash, const InstrProfRecord &Counters, InstrProfSymtab &Symtab, raw_fd_ostream &OS)
Write Record in text format to OS.
void setValueProfDataEndianness(llvm::endianness Endianness)
bool addMemProfCallStack(const memprof::CallStackId CSId, const llvm::SmallVector< memprof::FrameId > &CallStack, function_ref< void(Error)> Warn)
Add a call stack identified by the hash of the contents of the call stack in CallStack.
void addRecord(NamedInstrProfRecord &&I, uint64_t Weight, function_ref< void(Error)> Warn)
Add function counts for the given function.
void mergeRecordsFromWriter(InstrProfWriter &&IPW, function_ref< void(Error)> Warn)
Merge existing function counts from the given writer.
Error mergeProfileKind(const InstrProfKind Other)
Update the attributes of the current profile from the attributes specified.
void writeTextTemporalProfTraceData(raw_fd_ostream &OS, InstrProfSymtab &Symtab)
Write temporal profile trace data to the header in text format to OS.
SmallDenseMap< uint64_t, InstrProfRecord > ProfilingData
std::unique_ptr< MemoryBuffer > writeBuffer()
Write the profile, returning the raw data. For testing.
bool addMemProfFrame(const memprof::FrameId, const memprof::Frame &F, function_ref< void(Error)> Warn)
Add a memprof frame identified by the hash of the contents of the frame in FrameId.
void setOutputSparse(bool Sparse)
StringMap< ProfilingData > & getProfileData()
void setMemProfFullSchema(bool Full)
Error validateRecord(const InstrProfRecord &Func)
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:586
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition: StringMap.h:128
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
StringSet - A wrapper for StringMap that provides set-like functionality.
Definition: StringSet.h:23
std::pair< typename Base::iterator, bool > insert(StringRef key)
Definition: StringSet.h:38
An efficient, type-erasing, non-owning reference to a callable.
A raw_ostream that writes to a file descriptor.
Definition: raw_ostream.h:470
A raw_ostream that writes to an std::string.
Definition: raw_ostream.h:660
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Other
Any other memory.
endianness
Definition: bit.h:70
InstrProfKind
An enum describing the attributes of an instrumented profile.
Definition: InstrProf.h:324
Profiling information for a single function.
Definition: InstrProf.h:833
An ordered list of functions identified by their NameRef found in INSTR_PROF_DATA.
Definition: InstrProf.h:378