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"
34 static void exitWithError(const Twine &Message,
35 StringRef Whence = "",
36 StringRef Hint = "") {
39 errs() << Whence << ": ";
40 errs() << Message << "\n";
42 errs() << Hint << "\n";
46 static void exitWithErrorCode(const std::error_code &Error,
47 StringRef Whence = "") {
48 if (Error.category() == instrprof_category()) {
49 instrprof_error instrError = static_cast<instrprof_error>(Error.value());
50 if (instrError == instrprof_error::unrecognized_format) {
51 // Hint for common error of forgetting -sample for sample profiles.
52 exitWithError(Error.message(), Whence,
53 "Perhaps you forgot to use the -sample option?");
56 exitWithError(Error.message(), Whence);
60 enum ProfileKinds { instr, sample };
63 static void handleMergeWriterError(std::error_code &Error,
64 StringRef WhenceFile = "",
65 StringRef WhenceFunction = "",
68 if (!WhenceFile.empty())
69 errs() << WhenceFile << ": ";
70 if (!WhenceFunction.empty())
71 errs() << WhenceFunction << ": ";
72 errs() << Error.message() << "\n";
76 if (Error.category() == instrprof_category()) {
77 instrprof_error instrError = static_cast<instrprof_error>(Error.value());
78 if (instrError == instrprof_error::count_mismatch) {
79 Hint = "Make sure that all profile data to be merged is generated " \
80 "from the same binary.";
85 errs() << Hint << "\n";
89 static void mergeInstrProfile(const cl::list<std::string> &Inputs,
90 StringRef OutputFilename) {
91 if (OutputFilename.compare("-") == 0)
92 exitWithError("Cannot write indexed profdata format to stdout.");
95 raw_fd_ostream Output(OutputFilename.data(), EC, sys::fs::F_None);
97 exitWithErrorCode(EC, OutputFilename);
99 InstrProfWriter Writer;
100 std::set<std::error_code> WriterErrorCodes;
101 for (const auto &Filename : Inputs) {
102 auto ReaderOrErr = InstrProfReader::create(Filename);
103 if (std::error_code ec = ReaderOrErr.getError())
104 exitWithErrorCode(ec, Filename);
106 auto Reader = std::move(ReaderOrErr.get());
107 for (auto &I : *Reader) {
108 if (std::error_code EC = Writer.addRecord(std::move(I))) {
109 // Only show hint the first time an error occurs.
110 bool firstTime = WriterErrorCodes.insert(EC).second;
111 handleMergeWriterError(EC, Filename, I.Name, firstTime);
114 if (Reader->hasError())
115 exitWithErrorCode(Reader->getError(), Filename);
117 Writer.write(Output);
120 static void mergeSampleProfile(const cl::list<std::string> &Inputs,
121 StringRef OutputFilename,
122 sampleprof::SampleProfileFormat OutputFormat) {
123 using namespace sampleprof;
124 auto WriterOrErr = SampleProfileWriter::create(OutputFilename, OutputFormat);
125 if (std::error_code EC = WriterOrErr.getError())
126 exitWithErrorCode(EC, OutputFilename);
128 auto Writer = std::move(WriterOrErr.get());
129 StringMap<FunctionSamples> ProfileMap;
130 SmallVector<std::unique_ptr<sampleprof::SampleProfileReader>, 5> Readers;
131 for (const auto &Filename : Inputs) {
133 SampleProfileReader::create(Filename, getGlobalContext());
134 if (std::error_code EC = ReaderOrErr.getError())
135 exitWithErrorCode(EC, Filename);
137 // We need to keep the readers around until after all the files are
138 // read so that we do not lose the function names stored in each
139 // reader's memory. The function names are needed to write out the
140 // merged profile map.
141 Readers.push_back(std::move(ReaderOrErr.get()));
142 const auto Reader = Readers.back().get();
143 if (std::error_code EC = Reader->read())
144 exitWithErrorCode(EC, Filename);
146 StringMap<FunctionSamples> &Profiles = Reader->getProfiles();
147 for (StringMap<FunctionSamples>::iterator I = Profiles.begin(),
150 StringRef FName = I->first();
151 FunctionSamples &Samples = I->second;
152 ProfileMap[FName].merge(Samples);
155 Writer->write(ProfileMap);
158 static int merge_main(int argc, const char *argv[]) {
159 cl::list<std::string> Inputs(cl::Positional, cl::Required, cl::OneOrMore,
160 cl::desc("<filenames...>"));
162 cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
163 cl::init("-"), cl::Required,
164 cl::desc("Output file"));
165 cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
166 cl::aliasopt(OutputFilename));
167 cl::opt<ProfileKinds> ProfileKind(
168 cl::desc("Profile kind:"), cl::init(instr),
169 cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
170 clEnumVal(sample, "Sample profile"), clEnumValEnd));
172 cl::opt<sampleprof::SampleProfileFormat> OutputFormat(
173 cl::desc("Format of output profile (only meaningful with --sample)"),
174 cl::init(sampleprof::SPF_Binary),
175 cl::values(clEnumValN(sampleprof::SPF_Binary, "binary",
176 "Binary encoding (default)"),
177 clEnumValN(sampleprof::SPF_Text, "text", "Text encoding"),
178 clEnumValN(sampleprof::SPF_GCC, "gcc", "GCC encoding"),
181 cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
183 if (ProfileKind == instr)
184 mergeInstrProfile(Inputs, OutputFilename);
186 mergeSampleProfile(Inputs, OutputFilename, OutputFormat);
191 static int showInstrProfile(std::string Filename, bool ShowCounts,
192 bool ShowIndirectCallTargets, bool ShowAllFunctions,
193 std::string ShowFunction, raw_fd_ostream &OS) {
194 auto ReaderOrErr = InstrProfReader::create(Filename);
195 if (std::error_code EC = ReaderOrErr.getError())
196 exitWithErrorCode(EC, Filename);
198 auto Reader = std::move(ReaderOrErr.get());
199 uint64_t MaxFunctionCount = 0, MaxBlockCount = 0;
200 size_t ShownFunctions = 0, TotalFunctions = 0;
201 for (const auto &Func : *Reader) {
203 ShowAllFunctions || (!ShowFunction.empty() &&
204 Func.Name.find(ShowFunction) != Func.Name.npos);
207 assert(Func.Counts.size() > 0 && "function missing entry counter");
208 if (Func.Counts[0] > MaxFunctionCount)
209 MaxFunctionCount = Func.Counts[0];
216 OS << " " << Func.Name << ":\n"
217 << " Hash: " << format("0x%016" PRIx64, Func.Hash) << "\n"
218 << " Counters: " << Func.Counts.size() << "\n"
219 << " Function count: " << Func.Counts[0] << "\n";
220 if (ShowIndirectCallTargets)
221 OS << " Indirect Call Site Count: "
222 << Func.getNumValueSites(IPVK_IndirectCallTarget) << "\n";
225 if (Show && ShowCounts)
226 OS << " Block counts: [";
227 for (size_t I = 1, E = Func.Counts.size(); I < E; ++I) {
228 if (Func.Counts[I] > MaxBlockCount)
229 MaxBlockCount = Func.Counts[I];
230 if (Show && ShowCounts)
231 OS << (I == 1 ? "" : ", ") << Func.Counts[I];
233 if (Show && ShowCounts)
236 if (Show && ShowIndirectCallTargets) {
237 uint32_t NS = Func.getNumValueSites(IPVK_IndirectCallTarget);
238 OS << " Indirect Target Results: \n";
239 for (size_t I = 0; I < NS; ++I) {
240 uint32_t NV = Func.getNumValueDataForSite(IPVK_IndirectCallTarget, I);
241 std::unique_ptr<InstrProfValueData[]> VD =
242 Func.getValueForSite(IPVK_IndirectCallTarget, I);
243 for (uint32_t V = 0; V < NV; V++) {
244 OS << "\t[ " << I << ", ";
245 OS << (const char *)VD[V].Value << ", " << VD[V].Count << " ]\n";
250 if (Reader->hasError())
251 exitWithErrorCode(Reader->getError(), Filename);
253 if (ShowAllFunctions || !ShowFunction.empty())
254 OS << "Functions shown: " << ShownFunctions << "\n";
255 OS << "Total functions: " << TotalFunctions << "\n";
256 OS << "Maximum function count: " << MaxFunctionCount << "\n";
257 OS << "Maximum internal block count: " << MaxBlockCount << "\n";
261 static int showSampleProfile(std::string Filename, bool ShowCounts,
262 bool ShowAllFunctions, std::string ShowFunction,
263 raw_fd_ostream &OS) {
264 using namespace sampleprof;
265 auto ReaderOrErr = SampleProfileReader::create(Filename, getGlobalContext());
266 if (std::error_code EC = ReaderOrErr.getError())
267 exitWithErrorCode(EC, Filename);
269 auto Reader = std::move(ReaderOrErr.get());
270 if (std::error_code EC = Reader->read())
271 exitWithErrorCode(EC, Filename);
273 if (ShowAllFunctions || ShowFunction.empty())
276 Reader->dumpFunctionProfile(ShowFunction, OS);
281 static int show_main(int argc, const char *argv[]) {
282 cl::opt<std::string> Filename(cl::Positional, cl::Required,
283 cl::desc("<profdata-file>"));
285 cl::opt<bool> ShowCounts("counts", cl::init(false),
286 cl::desc("Show counter values for shown functions"));
287 cl::opt<bool> ShowIndirectCallTargets(
288 "ic-targets", cl::init(false),
289 cl::desc("Show indirect call site target values for shown functions"));
290 cl::opt<bool> ShowAllFunctions("all-functions", cl::init(false),
291 cl::desc("Details for every function"));
292 cl::opt<std::string> ShowFunction("function",
293 cl::desc("Details for matching functions"));
295 cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
296 cl::init("-"), cl::desc("Output file"));
297 cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
298 cl::aliasopt(OutputFilename));
299 cl::opt<ProfileKinds> ProfileKind(
300 cl::desc("Profile kind:"), cl::init(instr),
301 cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
302 clEnumVal(sample, "Sample profile"), clEnumValEnd));
304 cl::ParseCommandLineOptions(argc, argv, "LLVM profile data summary\n");
306 if (OutputFilename.empty())
307 OutputFilename = "-";
310 raw_fd_ostream OS(OutputFilename.data(), EC, sys::fs::F_Text);
312 exitWithErrorCode(EC, OutputFilename);
314 if (ShowAllFunctions && !ShowFunction.empty())
315 errs() << "warning: -function argument ignored: showing all functions\n";
317 if (ProfileKind == instr)
318 return showInstrProfile(Filename, ShowCounts, ShowIndirectCallTargets,
319 ShowAllFunctions, ShowFunction, OS);
321 return showSampleProfile(Filename, ShowCounts, ShowAllFunctions,
325 int main(int argc, const char *argv[]) {
326 // Print a stack trace if we signal out.
327 sys::PrintStackTraceOnErrorSignal();
328 PrettyStackTraceProgram X(argc, argv);
329 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
331 StringRef ProgName(sys::path::filename(argv[0]));
333 int (*func)(int, const char *[]) = nullptr;
335 if (strcmp(argv[1], "merge") == 0)
337 else if (strcmp(argv[1], "show") == 0)
341 std::string Invocation(ProgName.str() + " " + argv[1]);
342 argv[1] = Invocation.c_str();
343 return func(argc - 1, argv + 1);
346 if (strcmp(argv[1], "-h") == 0 ||
347 strcmp(argv[1], "-help") == 0 ||
348 strcmp(argv[1], "--help") == 0) {
350 errs() << "OVERVIEW: LLVM profile data tools\n\n"
351 << "USAGE: " << ProgName << " <command> [args...]\n"
352 << "USAGE: " << ProgName << " <command> -help\n\n"
353 << "Available commands: merge, show\n";
359 errs() << ProgName << ": No command specified!\n";
361 errs() << ProgName << ": Unknown command!\n";
363 errs() << "USAGE: " << ProgName << " <merge|show> [args...]\n";