blob: 059c4dc79c8656b9f915360d9ebb7a7c3ddc0d3e [file] [log] [blame]
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +00001//===- llvm-profdata.cpp - LLVM profile data tool -------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// llvm-profdata merges .profdata files.
11//
12//===----------------------------------------------------------------------===//
13
Nathan Slingerlandc21a44d2015-11-18 17:10:24 +000014#include "llvm/ADT/SmallSet.h"
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +000015#include "llvm/ADT/SmallVector.h"
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000016#include "llvm/ADT/StringRef.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000017#include "llvm/IR/LLVMContext.h"
Justin Bognerf8d79192014-03-21 17:24:48 +000018#include "llvm/ProfileData/InstrProfReader.h"
Justin Bognerb9bd7f82014-03-21 17:46:22 +000019#include "llvm/ProfileData/InstrProfWriter.h"
Easwaran Ramand68aae22016-02-04 23:34:31 +000020#include "llvm/ProfileData/ProfileCommon.h"
Diego Novillod5336ae2014-11-01 00:56:55 +000021#include "llvm/ProfileData/SampleProfReader.h"
22#include "llvm/ProfileData/SampleProfWriter.h"
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000023#include "llvm/Support/CommandLine.h"
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +000024#include "llvm/Support/Errc.h"
Benjamin Kramerd59664f2014-04-29 23:26:49 +000025#include "llvm/Support/FileSystem.h"
Justin Bogner423380f2014-03-23 20:43:50 +000026#include "llvm/Support/Format.h"
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000027#include "llvm/Support/ManagedStatic.h"
28#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramer16132e62015-03-23 18:07:13 +000029#include "llvm/Support/Path.h"
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000030#include "llvm/Support/PrettyStackTrace.h"
31#include "llvm/Support/Signals.h"
Vedant Kumare3a0bf52016-07-19 01:17:20 +000032#include "llvm/Support/ThreadPool.h"
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000033#include "llvm/Support/raw_ostream.h"
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +000034#include <algorithm>
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000035
36using namespace llvm;
37
Xinliang David Li6f7c19a2015-11-23 20:47:38 +000038enum ProfileFormat { PF_None = 0, PF_Text, PF_Binary, PF_GCC };
39
Diego Novillod3babdb2015-12-14 20:37:15 +000040static void exitWithError(const Twine &Message, StringRef Whence = "",
Nathan Slingerland4f823662015-11-13 03:47:58 +000041 StringRef Hint = "") {
Justin Bognerf8d79192014-03-21 17:24:48 +000042 errs() << "error: ";
43 if (!Whence.empty())
44 errs() << Whence << ": ";
45 errs() << Message << "\n";
Nathan Slingerland4f823662015-11-13 03:47:58 +000046 if (!Hint.empty())
47 errs() << Hint << "\n";
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000048 ::exit(1);
49}
50
Vedant Kumar9152fd12016-05-19 03:54:45 +000051static void exitWithError(Error E, StringRef Whence = "") {
52 if (E.isA<InstrProfError>()) {
53 handleAllErrors(std::move(E), [&](const InstrProfError &IPE) {
54 instrprof_error instrError = IPE.get();
55 StringRef Hint = "";
56 if (instrError == instrprof_error::unrecognized_format) {
57 // Hint for common error of forgetting -sample for sample profiles.
58 Hint = "Perhaps you forgot to use the -sample option?";
59 }
60 exitWithError(IPE.message(), Whence, Hint);
61 });
Nathan Slingerland4f823662015-11-13 03:47:58 +000062 }
Vedant Kumar9152fd12016-05-19 03:54:45 +000063
64 exitWithError(toString(std::move(E)), Whence);
65}
66
67static void exitWithErrorCode(std::error_code EC, StringRef Whence = "") {
68 exitWithError(EC.message(), Whence);
Nathan Slingerland4f823662015-11-13 03:47:58 +000069}
70
Duncan P. N. Exon Smith02b6fa92015-06-16 00:43:04 +000071namespace {
Diego Novillod3babdb2015-12-14 20:37:15 +000072enum ProfileKinds { instr, sample };
Duncan P. N. Exon Smith02b6fa92015-06-16 00:43:04 +000073}
Justin Bogner618bcea2014-03-19 02:20:46 +000074
Vedant Kumar9152fd12016-05-19 03:54:45 +000075static void handleMergeWriterError(Error E, StringRef WhenceFile = "",
Nathan Slingerlande6e30d52015-11-17 22:08:53 +000076 StringRef WhenceFunction = "",
Diego Novillod3babdb2015-12-14 20:37:15 +000077 bool ShowHint = true) {
Nathan Slingerlande6e30d52015-11-17 22:08:53 +000078 if (!WhenceFile.empty())
79 errs() << WhenceFile << ": ";
80 if (!WhenceFunction.empty())
81 errs() << WhenceFunction << ": ";
Vedant Kumar9152fd12016-05-19 03:54:45 +000082
83 auto IPE = instrprof_error::success;
84 E = handleErrors(std::move(E),
85 [&IPE](std::unique_ptr<InstrProfError> E) -> Error {
86 IPE = E->get();
87 return Error(std::move(E));
88 });
89 errs() << toString(std::move(E)) << "\n";
Nathan Slingerlande6e30d52015-11-17 22:08:53 +000090
91 if (ShowHint) {
92 StringRef Hint = "";
Vedant Kumar9152fd12016-05-19 03:54:45 +000093 if (IPE != instrprof_error::success) {
94 switch (IPE) {
Nathan Slingerland11c938d12015-11-17 23:37:09 +000095 case instrprof_error::hash_mismatch:
96 case instrprof_error::count_mismatch:
97 case instrprof_error::value_site_count_mismatch:
Diego Novillod3babdb2015-12-14 20:37:15 +000098 Hint = "Make sure that all profile data to be merged is generated "
Nathan Slingerlande6e30d52015-11-17 22:08:53 +000099 "from the same binary.";
Nathan Slingerland11c938d12015-11-17 23:37:09 +0000100 break;
Nathan Slingerlandb2d95f02015-11-18 00:52:45 +0000101 default:
102 break;
Nathan Slingerlande6e30d52015-11-17 22:08:53 +0000103 }
104 }
105
106 if (!Hint.empty())
107 errs() << Hint << "\n";
108 }
109}
110
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000111struct WeightedFile {
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000112 std::string Filename;
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000113 uint64_t Weight;
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000114};
115typedef SmallVector<WeightedFile, 5> WeightedFileVector;
116
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000117/// Keep track of merged data and reported errors.
118struct WriterContext {
119 std::mutex Lock;
120 InstrProfWriter Writer;
121 Error Err;
122 StringRef ErrWhence;
123 std::mutex &ErrLock;
124 SmallSet<instrprof_error, 4> &WriterErrorCodes;
125
126 WriterContext(bool IsSparse, std::mutex &ErrLock,
127 SmallSet<instrprof_error, 4> &WriterErrorCodes)
128 : Lock(), Writer(IsSparse), Err(Error::success()), ErrWhence(""),
129 ErrLock(ErrLock), WriterErrorCodes(WriterErrorCodes) {}
130};
131
132/// Load an input into a writer context.
133static void loadInput(const WeightedFile &Input, WriterContext *WC) {
134 std::unique_lock<std::mutex> CtxGuard{WC->Lock};
135
136 // If there's a pending hard error, don't do more work.
137 if (WC->Err)
138 return;
139
140 WC->ErrWhence = Input.Filename;
141
142 auto ReaderOrErr = InstrProfReader::create(Input.Filename);
143 if ((WC->Err = ReaderOrErr.takeError()))
144 return;
145
146 auto Reader = std::move(ReaderOrErr.get());
147 bool IsIRProfile = Reader->isIRLevelProfile();
148 if (WC->Writer.setIsIRLevelProfile(IsIRProfile)) {
149 WC->Err = make_error<StringError>(
150 "Merge IR generated profile with Clang generated profile.",
151 std::error_code());
152 return;
153 }
154
155 for (auto &I : *Reader) {
156 if (Error E = WC->Writer.addRecord(std::move(I), Input.Weight)) {
157 // Only show hint the first time an error occurs.
158 instrprof_error IPE = InstrProfError::take(std::move(E));
159 std::unique_lock<std::mutex> ErrGuard{WC->ErrLock};
160 bool firstTime = WC->WriterErrorCodes.insert(IPE).second;
161 handleMergeWriterError(make_error<InstrProfError>(IPE), Input.Filename,
162 I.Name, firstTime);
163 }
164 }
165 if (Reader->hasError())
166 WC->Err = Reader->getError();
167}
168
169/// Merge the \p Src writer context into \p Dst.
170static void mergeWriterContexts(WriterContext *Dst, WriterContext *Src) {
171 if (Error E = Dst->Writer.mergeRecordsFromWriter(std::move(Src->Writer)))
172 Dst->Err = std::move(E);
173}
174
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000175static void mergeInstrProfile(const WeightedFileVector &Inputs,
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000176 StringRef OutputFilename,
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000177 ProfileFormat OutputFormat, bool OutputSparse,
178 unsigned NumThreads) {
Justin Bognerb7aa2632014-04-18 21:48:40 +0000179 if (OutputFilename.compare("-") == 0)
180 exitWithError("Cannot write indexed profdata format to stdout.");
Justin Bognerec49f982014-03-12 22:00:57 +0000181
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000182 if (OutputFormat != PF_Binary && OutputFormat != PF_Text)
183 exitWithError("Unknown format is specified.");
184
Rafael Espindola3fd1e992014-08-25 18:16:47 +0000185 std::error_code EC;
186 raw_fd_ostream Output(OutputFilename.data(), EC, sys::fs::F_None);
187 if (EC)
Nathan Slingerland4f823662015-11-13 03:47:58 +0000188 exitWithErrorCode(EC, OutputFilename);
Justin Bognerec49f982014-03-12 22:00:57 +0000189
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000190 std::mutex ErrorLock;
Vedant Kumar9152fd12016-05-19 03:54:45 +0000191 SmallSet<instrprof_error, 4> WriterErrorCodes;
Justin Bognerf8d79192014-03-21 17:24:48 +0000192
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000193 // If NumThreads is not specified, auto-detect a good default.
194 if (NumThreads == 0)
195 NumThreads = std::max(1U, std::min(std::thread::hardware_concurrency(),
196 unsigned(Inputs.size() / 2)));
Rong Xu33c76c02016-02-10 17:18:30 +0000197
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000198 // Initialize the writer contexts.
199 SmallVector<std::unique_ptr<WriterContext>, 4> Contexts;
200 for (unsigned I = 0; I < NumThreads; ++I)
201 Contexts.emplace_back(llvm::make_unique<WriterContext>(
202 OutputSparse, ErrorLock, WriterErrorCodes));
203
204 if (NumThreads == 1) {
205 for (const auto &Input : Inputs)
206 loadInput(Input, Contexts[0].get());
207 } else {
208 ThreadPool Pool(NumThreads);
209
210 // Load the inputs in parallel (N/NumThreads serial steps).
211 unsigned Ctx = 0;
212 for (const auto &Input : Inputs) {
213 Pool.async(loadInput, Input, Contexts[Ctx].get());
214 Ctx = (Ctx + 1) % NumThreads;
Nathan Slingerlande6e30d52015-11-17 22:08:53 +0000215 }
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000216 Pool.wait();
217
218 // Merge the writer contexts together (~ lg(NumThreads) serial steps).
219 unsigned Mid = Contexts.size() / 2;
220 unsigned End = Contexts.size();
221 assert(Mid > 0 && "Expected more than one context");
222 do {
223 for (unsigned I = 0; I < Mid; ++I)
224 Pool.async(mergeWriterContexts, Contexts[I].get(),
225 Contexts[I + Mid].get());
226 Pool.wait();
227 if (End & 1) {
228 Pool.async(mergeWriterContexts, Contexts[0].get(),
229 Contexts[End - 1].get());
230 Pool.wait();
231 }
232 End = Mid;
233 Mid /= 2;
234 } while (Mid > 0);
Justin Bognerbfee8d42014-03-12 20:14:17 +0000235 }
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000236
237 // Handle deferred hard errors encountered during merging.
238 for (std::unique_ptr<WriterContext> &WC : Contexts)
239 if (WC->Err)
240 exitWithError(std::move(WC->Err), WC->ErrWhence);
241
242 InstrProfWriter &Writer = Contexts[0]->Writer;
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000243 if (OutputFormat == PF_Text)
244 Writer.writeText(Output);
245 else
246 Writer.write(Output);
Diego Novillod5336ae2014-11-01 00:56:55 +0000247}
248
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000249static sampleprof::SampleProfileFormat FormatMap[] = {
250 sampleprof::SPF_None, sampleprof::SPF_Text, sampleprof::SPF_Binary,
251 sampleprof::SPF_GCC};
252
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000253static void mergeSampleProfile(const WeightedFileVector &Inputs,
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000254 StringRef OutputFilename,
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000255 ProfileFormat OutputFormat) {
Diego Novillod5336ae2014-11-01 00:56:55 +0000256 using namespace sampleprof;
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000257 auto WriterOrErr =
258 SampleProfileWriter::create(OutputFilename, FormatMap[OutputFormat]);
Diego Novillofcd55602014-11-03 00:51:45 +0000259 if (std::error_code EC = WriterOrErr.getError())
Nathan Slingerland4f823662015-11-13 03:47:58 +0000260 exitWithErrorCode(EC, OutputFilename);
Diego Novillod5336ae2014-11-01 00:56:55 +0000261
Diego Novillofcd55602014-11-03 00:51:45 +0000262 auto Writer = std::move(WriterOrErr.get());
Diego Novillod5336ae2014-11-01 00:56:55 +0000263 StringMap<FunctionSamples> ProfileMap;
Diego Novilloaae1ed82015-10-08 19:40:37 +0000264 SmallVector<std::unique_ptr<sampleprof::SampleProfileReader>, 5> Readers;
Mehdi Amini03b42e42016-04-14 21:59:01 +0000265 LLVMContext Context;
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000266 for (const auto &Input : Inputs) {
Mehdi Amini03b42e42016-04-14 21:59:01 +0000267 auto ReaderOrErr = SampleProfileReader::create(Input.Filename, Context);
Diego Novillofcd55602014-11-03 00:51:45 +0000268 if (std::error_code EC = ReaderOrErr.getError())
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000269 exitWithErrorCode(EC, Input.Filename);
Diego Novillod5336ae2014-11-01 00:56:55 +0000270
Diego Novilloaae1ed82015-10-08 19:40:37 +0000271 // We need to keep the readers around until after all the files are
272 // read so that we do not lose the function names stored in each
273 // reader's memory. The function names are needed to write out the
274 // merged profile map.
275 Readers.push_back(std::move(ReaderOrErr.get()));
276 const auto Reader = Readers.back().get();
Diego Novillod5336ae2014-11-01 00:56:55 +0000277 if (std::error_code EC = Reader->read())
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000278 exitWithErrorCode(EC, Input.Filename);
Diego Novillod5336ae2014-11-01 00:56:55 +0000279
280 StringMap<FunctionSamples> &Profiles = Reader->getProfiles();
281 for (StringMap<FunctionSamples>::iterator I = Profiles.begin(),
282 E = Profiles.end();
283 I != E; ++I) {
284 StringRef FName = I->first();
285 FunctionSamples &Samples = I->second;
Nathan Slingerland48dd0802015-12-16 21:45:43 +0000286 sampleprof_error Result = ProfileMap[FName].merge(Samples, Input.Weight);
287 if (Result != sampleprof_error::success) {
288 std::error_code EC = make_error_code(Result);
Vedant Kumar9152fd12016-05-19 03:54:45 +0000289 handleMergeWriterError(errorCodeToError(EC), Input.Filename, FName);
Nathan Slingerland48dd0802015-12-16 21:45:43 +0000290 }
Diego Novillod5336ae2014-11-01 00:56:55 +0000291 }
292 }
293 Writer->write(ProfileMap);
294}
295
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000296static WeightedFile parseWeightedFile(const StringRef &WeightedFilename) {
Vedant Kumar8d0e8612016-06-06 23:43:56 +0000297 StringRef WeightStr, FileName;
298 std::tie(WeightStr, FileName) = WeightedFilename.split(',');
Diego Novillod5336ae2014-11-01 00:56:55 +0000299
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000300 uint64_t Weight;
301 if (WeightStr.getAsInteger(10, Weight) || Weight < 1)
302 exitWithError("Input weight must be a positive integer.");
303
Benjamin Kramer929e7db2016-07-21 14:29:11 +0000304 return {FileName, Weight};
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000305}
306
Vedant Kumarcef43602016-06-07 22:47:31 +0000307static std::unique_ptr<MemoryBuffer>
308getInputFilenamesFileBuf(const StringRef &InputFilenamesFile) {
309 if (InputFilenamesFile == "")
310 return {};
311
312 auto BufOrError = MemoryBuffer::getFileOrSTDIN(InputFilenamesFile);
313 if (!BufOrError)
314 exitWithErrorCode(BufOrError.getError(), InputFilenamesFile);
315
316 return std::move(*BufOrError);
317}
318
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000319static void addWeightedInput(WeightedFileVector &WNI, const WeightedFile &WF) {
320 StringRef Filename = WF.Filename;
321 uint64_t Weight = WF.Weight;
Benjamin Kramera81f4722016-07-22 12:39:55 +0000322
323 // If it's STDIN just pass it on.
324 if (Filename == "-") {
325 WNI.push_back({Filename, Weight});
326 return;
327 }
328
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000329 llvm::sys::fs::file_status Status;
330 llvm::sys::fs::status(Filename, Status);
331 if (!llvm::sys::fs::exists(Status))
332 exitWithErrorCode(make_error_code(errc::no_such_file_or_directory),
333 Filename);
334 // If it's a source file, collect it.
335 if (llvm::sys::fs::is_regular_file(Status)) {
Benjamin Kramer929e7db2016-07-21 14:29:11 +0000336 WNI.push_back({Filename, Weight});
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000337 return;
338 }
339
340 if (llvm::sys::fs::is_directory(Status)) {
341 std::error_code EC;
342 for (llvm::sys::fs::recursive_directory_iterator F(Filename, EC), E;
343 F != E && !EC; F.increment(EC)) {
344 if (llvm::sys::fs::is_regular_file(F->path())) {
345 addWeightedInput(WNI, {F->path(), Weight});
346 }
347 }
348 if (EC)
349 exitWithErrorCode(EC, Filename);
350 }
351}
352
Vedant Kumarcef43602016-06-07 22:47:31 +0000353static void parseInputFilenamesFile(MemoryBuffer *Buffer,
354 WeightedFileVector &WFV) {
355 if (!Buffer)
356 return;
357
358 SmallVector<StringRef, 8> Entries;
359 StringRef Data = Buffer->getBuffer();
360 Data.split(Entries, '\n', /*MaxSplit=*/-1, /*KeepEmpty=*/false);
361 for (const StringRef &FileWeightEntry : Entries) {
362 StringRef SanitizedEntry = FileWeightEntry.trim(" \t\v\f\r");
363 // Skip comments.
364 if (SanitizedEntry.startswith("#"))
365 continue;
366 // If there's no comma, it's an unweighted profile.
367 else if (SanitizedEntry.find(',') == StringRef::npos)
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000368 addWeightedInput(WFV, {SanitizedEntry, 1});
Vedant Kumarcef43602016-06-07 22:47:31 +0000369 else
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000370 addWeightedInput(WFV, parseWeightedFile(SanitizedEntry));
Vedant Kumarcef43602016-06-07 22:47:31 +0000371 }
372}
373
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000374static int merge_main(int argc, const char *argv[]) {
375 cl::list<std::string> InputFilenames(cl::Positional,
376 cl::desc("<filename...>"));
377 cl::list<std::string> WeightedInputFilenames("weighted-input",
378 cl::desc("<weight>,<filename>"));
Vedant Kumarcef43602016-06-07 22:47:31 +0000379 cl::opt<std::string> InputFilenamesFile(
380 "input-files", cl::init(""),
381 cl::desc("Path to file containing newline-separated "
382 "[<weight>,]<filename> entries"));
383 cl::alias InputFilenamesFileA("f", cl::desc("Alias for --input-files"),
384 cl::aliasopt(InputFilenamesFile));
385 cl::opt<bool> DumpInputFileList(
386 "dump-input-file-list", cl::init(false), cl::Hidden,
387 cl::desc("Dump the list of input files and their weights, then exit"));
Diego Novillod5336ae2014-11-01 00:56:55 +0000388 cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
389 cl::init("-"), cl::Required,
390 cl::desc("Output file"));
391 cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
392 cl::aliasopt(OutputFilename));
393 cl::opt<ProfileKinds> ProfileKind(
394 cl::desc("Profile kind:"), cl::init(instr),
395 cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
396 clEnumVal(sample, "Sample profile"), clEnumValEnd));
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000397 cl::opt<ProfileFormat> OutputFormat(
398 cl::desc("Format of output profile"), cl::init(PF_Binary),
399 cl::values(clEnumValN(PF_Binary, "binary", "Binary encoding (default)"),
400 clEnumValN(PF_Text, "text", "Text encoding"),
401 clEnumValN(PF_GCC, "gcc",
402 "GCC encoding (only meaningful for -sample)"),
Diego Novillod5336ae2014-11-01 00:56:55 +0000403 clEnumValEnd));
Vedant Kumar00dab222016-01-29 22:54:45 +0000404 cl::opt<bool> OutputSparse("sparse", cl::init(false),
405 cl::desc("Generate a sparse profile (only meaningful for -instr)"));
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000406 cl::opt<unsigned> NumThreads(
407 "num-threads", cl::init(0),
408 cl::desc("Number of merge threads to use (default: autodetect)"));
409 cl::alias NumThreadsA("j", cl::desc("Alias for --num-threads"),
410 cl::aliasopt(NumThreads));
Vedant Kumar00dab222016-01-29 22:54:45 +0000411
Diego Novillod5336ae2014-11-01 00:56:55 +0000412 cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
413
Vedant Kumarcef43602016-06-07 22:47:31 +0000414 WeightedFileVector WeightedInputs;
415 for (StringRef Filename : InputFilenames)
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000416 addWeightedInput(WeightedInputs, {Filename, 1});
Vedant Kumarcef43602016-06-07 22:47:31 +0000417 for (StringRef WeightedFilename : WeightedInputFilenames)
Xinliang David Li9a1bfcf2016-07-20 22:24:52 +0000418 addWeightedInput(WeightedInputs, parseWeightedFile(WeightedFilename));
Vedant Kumarcef43602016-06-07 22:47:31 +0000419
420 // Make sure that the file buffer stays alive for the duration of the
421 // weighted input vector's lifetime.
422 auto Buffer = getInputFilenamesFileBuf(InputFilenamesFile);
423 parseInputFilenamesFile(Buffer.get(), WeightedInputs);
424
425 if (WeightedInputs.empty())
Chandler Carruth0c30f892016-06-04 03:08:01 +0000426 exitWithError("No input files specified. See " +
427 sys::path::filename(argv[0]) + " -help");
428
Vedant Kumarcef43602016-06-07 22:47:31 +0000429 if (DumpInputFileList) {
430 for (auto &WF : WeightedInputs)
431 outs() << WF.Weight << "," << WF.Filename << "\n";
432 return 0;
433 }
Vedant Kumarf771a052016-06-04 00:36:28 +0000434
Diego Novillod5336ae2014-11-01 00:56:55 +0000435 if (ProfileKind == instr)
Vedant Kumar00dab222016-01-29 22:54:45 +0000436 mergeInstrProfile(WeightedInputs, OutputFilename, OutputFormat,
Vedant Kumare3a0bf52016-07-19 01:17:20 +0000437 OutputSparse, NumThreads);
Diego Novillod5336ae2014-11-01 00:56:55 +0000438 else
Nathan Slingerland7f5b47d2015-12-15 17:37:09 +0000439 mergeSampleProfile(WeightedInputs, OutputFilename, OutputFormat);
Justin Bognerbfee8d42014-03-12 20:14:17 +0000440
Justin Bognerec49f982014-03-12 22:00:57 +0000441 return 0;
Justin Bognerbfee8d42014-03-12 20:14:17 +0000442}
Justin Bogner618bcea2014-03-19 02:20:46 +0000443
Benjamin Kramer1afc1de2016-06-17 20:41:14 +0000444static int showInstrProfile(const std::string &Filename, bool ShowCounts,
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000445 bool ShowIndirectCallTargets,
446 bool ShowDetailedSummary,
447 std::vector<uint32_t> DetailedSummaryCutoffs,
Benjamin Kramer1afc1de2016-06-17 20:41:14 +0000448 bool ShowAllFunctions,
449 const std::string &ShowFunction, bool TextFormat,
450 raw_fd_ostream &OS) {
Diego Novillofcd55602014-11-03 00:51:45 +0000451 auto ReaderOrErr = InstrProfReader::create(Filename);
Benjamin Kramer1afc1de2016-06-17 20:41:14 +0000452 std::vector<uint32_t> Cutoffs = std::move(DetailedSummaryCutoffs);
453 if (ShowDetailedSummary && Cutoffs.empty()) {
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000454 Cutoffs = {800000, 900000, 950000, 990000, 999000, 999900, 999990};
455 }
Benjamin Kramer1afc1de2016-06-17 20:41:14 +0000456 InstrProfSummaryBuilder Builder(std::move(Cutoffs));
Vedant Kumar9152fd12016-05-19 03:54:45 +0000457 if (Error E = ReaderOrErr.takeError())
458 exitWithError(std::move(E), Filename);
Justin Bogner9af28ef2014-03-21 17:29:44 +0000459
Diego Novillofcd55602014-11-03 00:51:45 +0000460 auto Reader = std::move(ReaderOrErr.get());
Rong Xu33c76c02016-02-10 17:18:30 +0000461 bool IsIRInstr = Reader->isIRLevelProfile();
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000462 size_t ShownFunctions = 0;
Xinliang David Li872362c2016-05-23 16:36:11 +0000463 uint64_t TotalNumValueSites = 0;
464 uint64_t TotalNumValueSitesWithValueProfile = 0;
465 uint64_t TotalNumValues = 0;
Xinliang David Lideda33c2016-09-20 21:04:22 +0000466 std::vector<unsigned> ICHistogram;
Justin Bogner9af28ef2014-03-21 17:29:44 +0000467 for (const auto &Func : *Reader) {
Diego Novillod5336ae2014-11-01 00:56:55 +0000468 bool Show =
469 ShowAllFunctions || (!ShowFunction.empty() &&
470 Func.Name.find(ShowFunction) != Func.Name.npos);
Justin Bogner9af28ef2014-03-21 17:29:44 +0000471
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000472 bool doTextFormatDump = (Show && ShowCounts && TextFormat);
473
474 if (doTextFormatDump) {
Xinliang David Lia716cc52015-12-20 06:22:13 +0000475 InstrProfSymtab &Symtab = Reader->getSymtab();
476 InstrProfWriter::writeRecordInText(Func, Symtab, OS);
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000477 continue;
478 }
479
Justin Bognerb59d7c72014-04-25 02:45:33 +0000480 assert(Func.Counts.size() > 0 && "function missing entry counter");
Easwaran Ramane5a17e32016-05-19 21:07:12 +0000481 Builder.addRecord(Func);
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000482
Justin Bogner9af28ef2014-03-21 17:29:44 +0000483 if (Show) {
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000484
Justin Bogner9af28ef2014-03-21 17:29:44 +0000485 if (!ShownFunctions)
486 OS << "Counters:\n";
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000487
Justin Bogner9af28ef2014-03-21 17:29:44 +0000488 ++ShownFunctions;
489
490 OS << " " << Func.Name << ":\n"
Justin Bogner423380f2014-03-23 20:43:50 +0000491 << " Hash: " << format("0x%016" PRIx64, Func.Hash) << "\n"
Rong Xu33c76c02016-02-10 17:18:30 +0000492 << " Counters: " << Func.Counts.size() << "\n";
493 if (!IsIRInstr)
494 OS << " Function count: " << Func.Counts[0] << "\n";
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000495
Justin Bogner9e9a0572015-09-29 22:13:58 +0000496 if (ShowIndirectCallTargets)
Xinliang David Li2004f002015-11-02 05:08:23 +0000497 OS << " Indirect Call Site Count: "
498 << Func.getNumValueSites(IPVK_IndirectCallTarget) << "\n";
Justin Bogner9af28ef2014-03-21 17:29:44 +0000499
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000500 if (ShowCounts) {
501 OS << " Block counts: [";
Rong Xu33c76c02016-02-10 17:18:30 +0000502 size_t Start = (IsIRInstr ? 0 : 1);
503 for (size_t I = Start, E = Func.Counts.size(); I < E; ++I) {
504 OS << (I == Start ? "" : ", ") << Func.Counts[I];
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000505 }
506 OS << "]\n";
507 }
Justin Bogner9e9a0572015-09-29 22:13:58 +0000508
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000509 if (ShowIndirectCallTargets) {
Xinliang David Lia716cc52015-12-20 06:22:13 +0000510 InstrProfSymtab &Symtab = Reader->getSymtab();
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000511 uint32_t NS = Func.getNumValueSites(IPVK_IndirectCallTarget);
512 OS << " Indirect Target Results: \n";
Xinliang David Li872362c2016-05-23 16:36:11 +0000513 TotalNumValueSites += NS;
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000514 for (size_t I = 0; I < NS; ++I) {
515 uint32_t NV = Func.getNumValueDataForSite(IPVK_IndirectCallTarget, I);
516 std::unique_ptr<InstrProfValueData[]> VD =
517 Func.getValueForSite(IPVK_IndirectCallTarget, I);
Xinliang David Li872362c2016-05-23 16:36:11 +0000518 TotalNumValues += NV;
Xinliang David Lideda33c2016-09-20 21:04:22 +0000519 if (NV) {
Xinliang David Li872362c2016-05-23 16:36:11 +0000520 TotalNumValueSitesWithValueProfile++;
Xinliang David Lideda33c2016-09-20 21:04:22 +0000521 if (NV > ICHistogram.size())
522 ICHistogram.resize(NV, 0);
523 ICHistogram[NV - 1]++;
524 }
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000525 for (uint32_t V = 0; V < NV; V++) {
526 OS << "\t[ " << I << ", ";
Xinliang David Lia716cc52015-12-20 06:22:13 +0000527 OS << Symtab.getFuncName(VD[V].Value) << ", " << VD[V].Count
528 << " ]\n";
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000529 }
Justin Bogner9e9a0572015-09-29 22:13:58 +0000530 }
531 }
532 }
Justin Bogner9af28ef2014-03-21 17:29:44 +0000533 }
Justin Bognerdb1225d2014-03-23 20:55:53 +0000534 if (Reader->hasError())
Vedant Kumar9152fd12016-05-19 03:54:45 +0000535 exitWithError(Reader->getError(), Filename);
Justin Bogner9af28ef2014-03-21 17:29:44 +0000536
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000537 if (ShowCounts && TextFormat)
538 return 0;
Easwaran Raman7cefdb82016-05-19 21:53:28 +0000539 std::unique_ptr<ProfileSummary> PS(Builder.getSummary());
Justin Bogner9af28ef2014-03-21 17:29:44 +0000540 if (ShowAllFunctions || !ShowFunction.empty())
541 OS << "Functions shown: " << ShownFunctions << "\n";
Easwaran Ramane5a17e32016-05-19 21:07:12 +0000542 OS << "Total functions: " << PS->getNumFunctions() << "\n";
543 OS << "Maximum function count: " << PS->getMaxFunctionCount() << "\n";
Easwaran Raman7cefdb82016-05-19 21:53:28 +0000544 OS << "Maximum internal block count: " << PS->getMaxInternalCount() << "\n";
Xinliang David Li872362c2016-05-23 16:36:11 +0000545 if (ShownFunctions && ShowIndirectCallTargets) {
546 OS << "Total Number of Indirect Call Sites : " << TotalNumValueSites
547 << "\n";
548 OS << "Total Number of Sites With Values : "
549 << TotalNumValueSitesWithValueProfile << "\n";
550 OS << "Total Number of Profiled Values : " << TotalNumValues << "\n";
Xinliang David Lideda33c2016-09-20 21:04:22 +0000551
552 OS << "IC Value histogram : \n\tNumTargets, SiteCount\n";
553 for (unsigned I = 0; I < ICHistogram.size(); I++) {
554 OS << "\t" << I + 1 << ", " << ICHistogram[I] << "\n";
555 }
Xinliang David Li872362c2016-05-23 16:36:11 +0000556 }
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000557
558 if (ShowDetailedSummary) {
559 OS << "Detailed summary:\n";
Easwaran Raman7cefdb82016-05-19 21:53:28 +0000560 OS << "Total number of blocks: " << PS->getNumCounts() << "\n";
Easwaran Ramane5a17e32016-05-19 21:07:12 +0000561 OS << "Total count: " << PS->getTotalCount() << "\n";
562 for (auto Entry : PS->getDetailedSummary()) {
Easwaran Raman43095702016-02-17 18:18:47 +0000563 OS << Entry.NumCounts << " blocks with count >= " << Entry.MinCount
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000564 << " account for "
565 << format("%0.6g", (float)Entry.Cutoff / ProfileSummary::Scale * 100)
566 << " percentage of the total counts.\n";
567 }
568 }
Justin Bogner9af28ef2014-03-21 17:29:44 +0000569 return 0;
570}
571
Benjamin Kramer1afc1de2016-06-17 20:41:14 +0000572static int showSampleProfile(const std::string &Filename, bool ShowCounts,
573 bool ShowAllFunctions,
574 const std::string &ShowFunction,
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000575 raw_fd_ostream &OS) {
Diego Novillod5336ae2014-11-01 00:56:55 +0000576 using namespace sampleprof;
Mehdi Amini03b42e42016-04-14 21:59:01 +0000577 LLVMContext Context;
578 auto ReaderOrErr = SampleProfileReader::create(Filename, Context);
Diego Novillofcd55602014-11-03 00:51:45 +0000579 if (std::error_code EC = ReaderOrErr.getError())
Nathan Slingerland4f823662015-11-13 03:47:58 +0000580 exitWithErrorCode(EC, Filename);
Diego Novillod5336ae2014-11-01 00:56:55 +0000581
Diego Novillofcd55602014-11-03 00:51:45 +0000582 auto Reader = std::move(ReaderOrErr.get());
Diego Novilloc6d032a2015-09-17 00:17:21 +0000583 if (std::error_code EC = Reader->read())
Nathan Slingerland4f823662015-11-13 03:47:58 +0000584 exitWithErrorCode(EC, Filename);
Diego Novilloc6d032a2015-09-17 00:17:21 +0000585
Diego Novillod5336ae2014-11-01 00:56:55 +0000586 if (ShowAllFunctions || ShowFunction.empty())
587 Reader->dump(OS);
588 else
589 Reader->dumpFunctionProfile(ShowFunction, OS);
590
591 return 0;
592}
593
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000594static int show_main(int argc, const char *argv[]) {
Diego Novillod5336ae2014-11-01 00:56:55 +0000595 cl::opt<std::string> Filename(cl::Positional, cl::Required,
596 cl::desc("<profdata-file>"));
597
598 cl::opt<bool> ShowCounts("counts", cl::init(false),
599 cl::desc("Show counter values for shown functions"));
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000600 cl::opt<bool> TextFormat(
601 "text", cl::init(false),
602 cl::desc("Show instr profile data in text dump format"));
Justin Bogner9e9a0572015-09-29 22:13:58 +0000603 cl::opt<bool> ShowIndirectCallTargets(
604 "ic-targets", cl::init(false),
605 cl::desc("Show indirect call site target values for shown functions"));
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000606 cl::opt<bool> ShowDetailedSummary("detailed-summary", cl::init(false),
607 cl::desc("Show detailed profile summary"));
608 cl::list<uint32_t> DetailedSummaryCutoffs(
609 cl::CommaSeparated, "detailed-summary-cutoffs",
610 cl::desc(
611 "Cutoff percentages (times 10000) for generating detailed summary"),
612 cl::value_desc("800000,901000,999999"));
Diego Novillod5336ae2014-11-01 00:56:55 +0000613 cl::opt<bool> ShowAllFunctions("all-functions", cl::init(false),
614 cl::desc("Details for every function"));
615 cl::opt<std::string> ShowFunction("function",
616 cl::desc("Details for matching functions"));
617
618 cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
619 cl::init("-"), cl::desc("Output file"));
620 cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
621 cl::aliasopt(OutputFilename));
622 cl::opt<ProfileKinds> ProfileKind(
623 cl::desc("Profile kind:"), cl::init(instr),
624 cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
625 clEnumVal(sample, "Sample profile"), clEnumValEnd));
626
627 cl::ParseCommandLineOptions(argc, argv, "LLVM profile data summary\n");
628
629 if (OutputFilename.empty())
630 OutputFilename = "-";
631
632 std::error_code EC;
633 raw_fd_ostream OS(OutputFilename.data(), EC, sys::fs::F_Text);
634 if (EC)
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000635 exitWithErrorCode(EC, OutputFilename);
Diego Novillod5336ae2014-11-01 00:56:55 +0000636
637 if (ShowAllFunctions && !ShowFunction.empty())
638 errs() << "warning: -function argument ignored: showing all functions\n";
639
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000640 std::vector<uint32_t> Cutoffs(DetailedSummaryCutoffs.begin(),
641 DetailedSummaryCutoffs.end());
Diego Novillod5336ae2014-11-01 00:56:55 +0000642 if (ProfileKind == instr)
Justin Bogner9e9a0572015-09-29 22:13:58 +0000643 return showInstrProfile(Filename, ShowCounts, ShowIndirectCallTargets,
Easwaran Raman183ebbe2016-01-13 21:44:36 +0000644 ShowDetailedSummary, DetailedSummaryCutoffs,
Xinliang David Li6f7c19a2015-11-23 20:47:38 +0000645 ShowAllFunctions, ShowFunction, TextFormat, OS);
Diego Novillod5336ae2014-11-01 00:56:55 +0000646 else
647 return showSampleProfile(Filename, ShowCounts, ShowAllFunctions,
648 ShowFunction, OS);
649}
650
Justin Bogner618bcea2014-03-19 02:20:46 +0000651int main(int argc, const char *argv[]) {
652 // Print a stack trace if we signal out.
Richard Smith2ad6d482016-06-09 00:53:21 +0000653 sys::PrintStackTraceOnErrorSignal(argv[0]);
Justin Bogner618bcea2014-03-19 02:20:46 +0000654 PrettyStackTraceProgram X(argc, argv);
655 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
656
657 StringRef ProgName(sys::path::filename(argv[0]));
658 if (argc > 1) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000659 int (*func)(int, const char *[]) = nullptr;
Justin Bogner618bcea2014-03-19 02:20:46 +0000660
661 if (strcmp(argv[1], "merge") == 0)
662 func = merge_main;
Justin Bogner9af28ef2014-03-21 17:29:44 +0000663 else if (strcmp(argv[1], "show") == 0)
664 func = show_main;
Justin Bogner618bcea2014-03-19 02:20:46 +0000665
666 if (func) {
667 std::string Invocation(ProgName.str() + " " + argv[1]);
668 argv[1] = Invocation.c_str();
669 return func(argc - 1, argv + 1);
670 }
671
Diego Novillod3babdb2015-12-14 20:37:15 +0000672 if (strcmp(argv[1], "-h") == 0 || strcmp(argv[1], "-help") == 0 ||
Justin Bogner618bcea2014-03-19 02:20:46 +0000673 strcmp(argv[1], "--help") == 0) {
674
675 errs() << "OVERVIEW: LLVM profile data tools\n\n"
676 << "USAGE: " << ProgName << " <command> [args...]\n"
677 << "USAGE: " << ProgName << " <command> -help\n\n"
Justin Bogner253eb172016-08-03 23:10:51 +0000678 << "See each individual command --help for more details.\n"
Justin Bogner9af28ef2014-03-21 17:29:44 +0000679 << "Available commands: merge, show\n";
Justin Bogner618bcea2014-03-19 02:20:46 +0000680 return 0;
681 }
682 }
683
684 if (argc < 2)
685 errs() << ProgName << ": No command specified!\n";
686 else
687 errs() << ProgName << ": Unknown command!\n";
688
Justin Bogner9af28ef2014-03-21 17:29:44 +0000689 errs() << "USAGE: " << ProgName << " <merge|show> [args...]\n";
Justin Bogner618bcea2014-03-19 02:20:46 +0000690 return 1;
691}