1 //===- llvm-profdata.cpp - LLVM profile data tool -------------------------===//
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 // llvm-profdata merges .profdata files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/IR/LLVMContext.h"
16 #include "llvm/ProfileData/InstrProfReader.h"
17 #include "llvm/ProfileData/InstrProfWriter.h"
18 #include "llvm/ProfileData/SampleProfReader.h"
19 #include "llvm/ProfileData/SampleProfWriter.h"
20 #include "llvm/Support/CommandLine.h"
21 #include "llvm/Support/FileSystem.h"
22 #include "llvm/Support/Format.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/Support/Path.h"
26 #include "llvm/Support/PrettyStackTrace.h"
27 #include "llvm/Support/Signals.h"
28 #include "llvm/Support/raw_ostream.h"
32 static void exitWithError(const Twine &Message, StringRef Whence = "") {
35 errs() << Whence << ": ";
36 errs() << Message << "\n";
41 enum ProfileKinds { instr, sample };
44 static void mergeInstrProfile(const cl::list<std::string> &Inputs,
45 StringRef OutputFilename) {
46 if (OutputFilename.compare("-") == 0)
47 exitWithError("Cannot write indexed profdata format to stdout.");
50 raw_fd_ostream Output(OutputFilename.data(), EC, sys::fs::F_None);
52 exitWithError(EC.message(), OutputFilename);
54 InstrProfWriter Writer;
55 for (const auto &Filename : Inputs) {
56 auto ReaderOrErr = InstrProfReader::create(Filename);
57 if (std::error_code ec = ReaderOrErr.getError())
58 exitWithError(ec.message(), Filename);
60 auto Reader = std::move(ReaderOrErr.get());
61 for (auto &I : *Reader)
62 if (std::error_code EC = Writer.addRecord(std::move(I)))
63 errs() << Filename << ": " << I.Name << ": " << EC.message() << "\n";
64 if (Reader->hasError())
65 exitWithError(Reader->getError().message(), Filename);
70 static void mergeSampleProfile(const cl::list<std::string> &Inputs,
71 StringRef OutputFilename,
72 sampleprof::SampleProfileFormat OutputFormat) {
73 using namespace sampleprof;
74 auto WriterOrErr = SampleProfileWriter::create(OutputFilename, OutputFormat);
75 if (std::error_code EC = WriterOrErr.getError())
76 exitWithError(EC.message(), OutputFilename);
78 auto Writer = std::move(WriterOrErr.get());
79 StringMap<FunctionSamples> ProfileMap;
80 SmallVector<std::unique_ptr<sampleprof::SampleProfileReader>, 5> Readers;
81 for (const auto &Filename : Inputs) {
83 SampleProfileReader::create(Filename, getGlobalContext());
84 if (std::error_code EC = ReaderOrErr.getError())
85 exitWithError(EC.message(), Filename);
87 // We need to keep the readers around until after all the files are
88 // read so that we do not lose the function names stored in each
89 // reader's memory. The function names are needed to write out the
90 // merged profile map.
91 Readers.push_back(std::move(ReaderOrErr.get()));
92 const auto Reader = Readers.back().get();
93 if (std::error_code EC = Reader->read())
94 exitWithError(EC.message(), Filename);
96 StringMap<FunctionSamples> &Profiles = Reader->getProfiles();
97 for (StringMap<FunctionSamples>::iterator I = Profiles.begin(),
100 StringRef FName = I->first();
101 FunctionSamples &Samples = I->second;
102 ProfileMap[FName].merge(Samples);
105 Writer->write(ProfileMap);
108 static int merge_main(int argc, const char *argv[]) {
109 cl::list<std::string> Inputs(cl::Positional, cl::Required, cl::OneOrMore,
110 cl::desc("<filenames...>"));
112 cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
113 cl::init("-"), cl::Required,
114 cl::desc("Output file"));
115 cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
116 cl::aliasopt(OutputFilename));
117 cl::opt<ProfileKinds> ProfileKind(
118 cl::desc("Profile kind:"), cl::init(instr),
119 cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
120 clEnumVal(sample, "Sample profile"), clEnumValEnd));
122 cl::opt<sampleprof::SampleProfileFormat> OutputFormat(
123 cl::desc("Format of output profile (only meaningful with --sample)"),
124 cl::init(sampleprof::SPF_Binary),
125 cl::values(clEnumValN(sampleprof::SPF_Binary, "binary",
126 "Binary encoding (default)"),
127 clEnumValN(sampleprof::SPF_Text, "text", "Text encoding"),
128 clEnumValN(sampleprof::SPF_GCC, "gcc", "GCC encoding"),
131 cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
133 if (ProfileKind == instr)
134 mergeInstrProfile(Inputs, OutputFilename);
136 mergeSampleProfile(Inputs, OutputFilename, OutputFormat);
141 static int showInstrProfile(std::string Filename, bool ShowCounts,
142 bool ShowIndirectCallTargets, bool ShowAllFunctions,
143 std::string ShowFunction, raw_fd_ostream &OS) {
144 auto ReaderOrErr = InstrProfReader::create(Filename);
145 if (std::error_code EC = ReaderOrErr.getError())
146 exitWithError(EC.message(), Filename);
148 auto Reader = std::move(ReaderOrErr.get());
149 uint64_t MaxFunctionCount = 0, MaxBlockCount = 0;
150 size_t ShownFunctions = 0, TotalFunctions = 0;
151 for (const auto &Func : *Reader) {
153 ShowAllFunctions || (!ShowFunction.empty() &&
154 Func.Name.find(ShowFunction) != Func.Name.npos);
157 assert(Func.Counts.size() > 0 && "function missing entry counter");
158 if (Func.Counts[0] > MaxFunctionCount)
159 MaxFunctionCount = Func.Counts[0];
166 OS << " " << Func.Name << ":\n"
167 << " Hash: " << format("0x%016" PRIx64, Func.Hash) << "\n"
168 << " Counters: " << Func.Counts.size() << "\n"
169 << " Function count: " << Func.Counts[0] << "\n";
170 if (ShowIndirectCallTargets)
171 OS << " Indirect Call Site Count: "
172 << Func.getNumValueSites(IPVK_IndirectCallTarget) << "\n";
175 if (Show && ShowCounts)
176 OS << " Block counts: [";
177 for (size_t I = 1, E = Func.Counts.size(); I < E; ++I) {
178 if (Func.Counts[I] > MaxBlockCount)
179 MaxBlockCount = Func.Counts[I];
180 if (Show && ShowCounts)
181 OS << (I == 1 ? "" : ", ") << Func.Counts[I];
183 if (Show && ShowCounts)
186 if (Show && ShowIndirectCallTargets) {
187 uint32_t NS = Func.getNumValueSites(IPVK_IndirectCallTarget);
188 OS << " Indirect Target Results: \n";
189 for (size_t I = 0; I < NS; ++I) {
190 uint32_t NV = Func.getNumValueDataForSite(IPVK_IndirectCallTarget, I);
191 std::unique_ptr<InstrProfValueData[]> VD =
192 Func.getValueForSite(IPVK_IndirectCallTarget, I);
193 for (uint32_t V = 0; V < NV; V++) {
194 OS << "\t[ " << I << ", ";
195 OS << (const char *)VD[V].Value << ", " << VD[V].Count << " ]\n";
200 if (Reader->hasError())
201 exitWithError(Reader->getError().message(), Filename);
203 if (ShowAllFunctions || !ShowFunction.empty())
204 OS << "Functions shown: " << ShownFunctions << "\n";
205 OS << "Total functions: " << TotalFunctions << "\n";
206 OS << "Maximum function count: " << MaxFunctionCount << "\n";
207 OS << "Maximum internal block count: " << MaxBlockCount << "\n";
211 static int showSampleProfile(std::string Filename, bool ShowCounts,
212 bool ShowAllFunctions, std::string ShowFunction,
213 raw_fd_ostream &OS) {
214 using namespace sampleprof;
215 auto ReaderOrErr = SampleProfileReader::create(Filename, getGlobalContext());
216 if (std::error_code EC = ReaderOrErr.getError())
217 exitWithError(EC.message(), Filename);
219 auto Reader = std::move(ReaderOrErr.get());
220 if (std::error_code EC = Reader->read())
221 exitWithError(EC.message(), Filename);
223 if (ShowAllFunctions || ShowFunction.empty())
226 Reader->dumpFunctionProfile(ShowFunction, OS);
231 static int show_main(int argc, const char *argv[]) {
232 cl::opt<std::string> Filename(cl::Positional, cl::Required,
233 cl::desc("<profdata-file>"));
235 cl::opt<bool> ShowCounts("counts", cl::init(false),
236 cl::desc("Show counter values for shown functions"));
237 cl::opt<bool> ShowIndirectCallTargets(
238 "ic-targets", cl::init(false),
239 cl::desc("Show indirect call site target values for shown functions"));
240 cl::opt<bool> ShowAllFunctions("all-functions", cl::init(false),
241 cl::desc("Details for every function"));
242 cl::opt<std::string> ShowFunction("function",
243 cl::desc("Details for matching functions"));
245 cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
246 cl::init("-"), cl::desc("Output file"));
247 cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
248 cl::aliasopt(OutputFilename));
249 cl::opt<ProfileKinds> ProfileKind(
250 cl::desc("Profile kind:"), cl::init(instr),
251 cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
252 clEnumVal(sample, "Sample profile"), clEnumValEnd));
254 cl::ParseCommandLineOptions(argc, argv, "LLVM profile data summary\n");
256 if (OutputFilename.empty())
257 OutputFilename = "-";
260 raw_fd_ostream OS(OutputFilename.data(), EC, sys::fs::F_Text);
262 exitWithError(EC.message(), OutputFilename);
264 if (ShowAllFunctions && !ShowFunction.empty())
265 errs() << "warning: -function argument ignored: showing all functions\n";
267 if (ProfileKind == instr)
268 return showInstrProfile(Filename, ShowCounts, ShowIndirectCallTargets,
269 ShowAllFunctions, ShowFunction, OS);
271 return showSampleProfile(Filename, ShowCounts, ShowAllFunctions,
275 int main(int argc, const char *argv[]) {
276 // Print a stack trace if we signal out.
277 sys::PrintStackTraceOnErrorSignal();
278 PrettyStackTraceProgram X(argc, argv);
279 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
281 StringRef ProgName(sys::path::filename(argv[0]));
283 int (*func)(int, const char *[]) = nullptr;
285 if (strcmp(argv[1], "merge") == 0)
287 else if (strcmp(argv[1], "show") == 0)
291 std::string Invocation(ProgName.str() + " " + argv[1]);
292 argv[1] = Invocation.c_str();
293 return func(argc - 1, argv + 1);
296 if (strcmp(argv[1], "-h") == 0 ||
297 strcmp(argv[1], "-help") == 0 ||
298 strcmp(argv[1], "--help") == 0) {
300 errs() << "OVERVIEW: LLVM profile data tools\n\n"
301 << "USAGE: " << ProgName << " <command> [args...]\n"
302 << "USAGE: " << ProgName << " <command> -help\n\n"
303 << "Available commands: merge, show\n";
309 errs() << ProgName << ": No command specified!\n";
311 errs() << ProgName << ": Unknown command!\n";
313 errs() << "USAGE: " << ProgName << " <merge|show> [args...]\n";