1 //=-- InstrProfWriter.cpp - Instrumented profiling writer -------------------=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing profiling data for clang's
11 // instrumentation based PGO and coverage.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/ProfileData/InstrProfWriter.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/Support/EndianStream.h"
18 #include "llvm/Support/OnDiskHashTable.h"
24 static support::endianness ValueProfDataEndianness = support::little;
26 class InstrProfRecordTrait {
28 typedef StringRef key_type;
29 typedef StringRef key_type_ref;
31 typedef const InstrProfWriter::ProfilingData *const data_type;
32 typedef const InstrProfWriter::ProfilingData *const data_type_ref;
34 typedef uint64_t hash_value_type;
35 typedef uint64_t offset_type;
37 static hash_value_type ComputeHash(key_type_ref K) {
38 return IndexedInstrProf::ComputeHash(K);
41 static std::pair<offset_type, offset_type>
42 EmitKeyDataLength(raw_ostream &Out, key_type_ref K, data_type_ref V) {
43 using namespace llvm::support;
44 endian::Writer<little> LE(Out);
46 offset_type N = K.size();
47 LE.write<offset_type>(N);
50 for (const auto &ProfileData : *V) {
51 const InstrProfRecord &ProfRecord = ProfileData.second;
52 M += sizeof(uint64_t); // The function hash
53 M += sizeof(uint64_t); // The size of the Counts vector
54 M += ProfRecord.Counts.size() * sizeof(uint64_t);
57 M += ValueProfData::getSize(ProfileData.second);
59 LE.write<offset_type>(M);
61 return std::make_pair(N, M);
64 static void EmitKey(raw_ostream &Out, key_type_ref K, offset_type N){
65 Out.write(K.data(), N);
68 static void EmitData(raw_ostream &Out, key_type_ref, data_type_ref V,
70 using namespace llvm::support;
71 endian::Writer<little> LE(Out);
72 for (const auto &ProfileData : *V) {
73 const InstrProfRecord &ProfRecord = ProfileData.second;
75 LE.write<uint64_t>(ProfileData.first); // Function hash
76 LE.write<uint64_t>(ProfRecord.Counts.size());
77 for (uint64_t I : ProfRecord.Counts)
78 LE.write<uint64_t>(I);
81 std::unique_ptr<ValueProfData> VDataPtr =
82 ValueProfData::serializeFrom(ProfileData.second);
83 uint32_t S = VDataPtr->getSize();
84 VDataPtr->swapBytesFromHost(ValueProfDataEndianness);
85 Out.write((const char *)VDataPtr.get(), S);
91 // Internal interface for testing purpose only.
92 void InstrProfWriter::setValueProfDataEndianness(
93 support::endianness Endianness) {
94 ValueProfDataEndianness = Endianness;
97 std::error_code InstrProfWriter::addRecord(InstrProfRecord &&I,
99 auto &ProfileDataMap = FunctionData[I.Name];
102 ProfilingData::iterator Where;
103 std::tie(Where, NewFunc) =
104 ProfileDataMap.insert(std::make_pair(I.Hash, InstrProfRecord()));
105 InstrProfRecord &Dest = Where->second;
107 instrprof_error Result = instrprof_error::success;
109 // We've never seen a function with this name and hash, add it.
111 // Fix up the name to avoid dangling reference.
112 Dest.Name = FunctionData.find(Dest.Name)->getKey();
114 Result = Dest.scale(Weight);
116 // We're updating a function we've seen before.
117 Result = Dest.merge(I, Weight);
120 Dest.sortValueData();
122 // We keep track of the max function count as we go for simplicity.
123 // Update this statistic no matter the result of the merge.
124 if (Dest.Counts[0] > MaxFunctionCount)
125 MaxFunctionCount = Dest.Counts[0];
130 std::pair<uint64_t, uint64_t> InstrProfWriter::writeImpl(raw_ostream &OS) {
131 OnDiskChainedHashTableGenerator<InstrProfRecordTrait> Generator;
133 // Populate the hash table generator.
134 for (const auto &I : FunctionData)
135 Generator.insert(I.getKey(), &I.getValue());
137 using namespace llvm::support;
138 endian::Writer<little> LE(OS);
141 IndexedInstrProf::Header Header;
142 Header.Magic = IndexedInstrProf::Magic;
143 Header.Version = IndexedInstrProf::Version;
144 Header.MaxFunctionCount = MaxFunctionCount;
145 Header.HashType = static_cast<uint64_t>(IndexedInstrProf::HashType);
146 Header.HashOffset = 0;
147 int N = sizeof(IndexedInstrProf::Header) / sizeof(uint64_t);
149 // Only write out all the fields execpt 'HashOffset'. We need
150 // to remember the offset of that field to allow back patching
152 for (int I = 0; I < N - 1; I++)
153 LE.write<uint64_t>(reinterpret_cast<uint64_t *>(&Header)[I]);
155 // Save a space to write the hash table start location.
156 uint64_t HashTableStartLoc = OS.tell();
157 // Reserve the space for HashOffset field.
158 LE.write<uint64_t>(0);
159 // Write the hash table.
160 uint64_t HashTableStart = Generator.Emit(OS);
162 return std::make_pair(HashTableStartLoc, HashTableStart);
165 void InstrProfWriter::write(raw_fd_ostream &OS) {
166 // Write the hash table.
167 auto TableStart = writeImpl(OS);
169 // Go back and fill in the hash table start.
170 using namespace support;
171 OS.seek(TableStart.first);
172 // Now patch the HashOffset field previously reserved.
173 endian::Writer<little>(OS).write<uint64_t>(TableStart.second);
176 static const char *ValueProfKindStr[] = {
177 #define VALUE_PROF_KIND(Enumerator, Value) #Enumerator,
178 #include "llvm/ProfileData/InstrProfData.inc"
181 void InstrProfWriter::writeRecordInText(const InstrProfRecord &Func,
182 InstrProfSymtab &Symtab,
183 raw_fd_ostream &OS) {
184 OS << Func.Name << "\n";
185 OS << "# Func Hash:\n" << Func.Hash << "\n";
186 OS << "# Num Counters:\n" << Func.Counts.size() << "\n";
187 OS << "# Counter Values:\n";
188 for (uint64_t Count : Func.Counts)
191 uint32_t NumValueKinds = Func.getNumValueKinds();
192 if (!NumValueKinds) {
197 OS << "# Num Value Kinds:\n" << Func.getNumValueKinds() << "\n";
198 for (uint32_t VK = 0; VK < IPVK_Last + 1; VK++) {
199 uint32_t NS = Func.getNumValueSites(VK);
202 OS << "# ValueKind = " << ValueProfKindStr[VK] << ":\n" << VK << "\n";
203 OS << "# NumValueSites:\n" << NS << "\n";
204 for (uint32_t S = 0; S < NS; S++) {
205 uint32_t ND = Func.getNumValueDataForSite(VK, S);
207 std::unique_ptr<InstrProfValueData[]> VD = Func.getValueForSite(VK, S);
208 for (uint32_t I = 0; I < ND; I++) {
209 if (VK == IPVK_IndirectCallTarget)
210 OS << Symtab.getFuncName(VD[I].Value) << ":" << VD[I].Count << "\n";
212 OS << VD[I].Value << ":" << VD[I].Count << "\n";
220 void InstrProfWriter::writeText(raw_fd_ostream &OS) {
221 InstrProfSymtab Symtab;
222 for (const auto &I : FunctionData)
223 Symtab.addFuncName(I.getKey());
224 Symtab.finalizeSymtab();
226 for (const auto &I : FunctionData)
227 for (const auto &Func : I.getValue())
228 writeRecordInText(Func.second, Symtab, OS);
231 std::unique_ptr<MemoryBuffer> InstrProfWriter::writeBuffer() {
233 llvm::raw_string_ostream OS(Data);
234 // Write the hash table.
235 auto TableStart = writeImpl(OS);
238 // Go back and fill in the hash table start.
239 using namespace support;
240 uint64_t Bytes = endian::byte_swap<uint64_t, little>(TableStart.second);
241 Data.replace(TableStart.first, sizeof(uint64_t), (const char *)&Bytes,
244 // Return this in an aligned memory buffer.
245 return MemoryBuffer::getMemBufferCopy(Data);