[llvm-profdata] Add check for text profile formats and improve error reporting (2nd...
[oota-llvm.git] / lib / ProfileData / SampleProf.cpp
1 //=-- SampleProf.cpp - Sample profiling format support --------------------===//
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 // This file contains common definitions used in the reading and writing of
11 // sample profile data.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/ProfileData/SampleProf.h"
16 #include "llvm/Support/ErrorHandling.h"
17 #include "llvm/Support/ManagedStatic.h"
18
19 using namespace llvm::sampleprof;
20 using namespace llvm;
21
22 namespace {
23 class SampleProfErrorCategoryType : public std::error_category {
24   const char *name() const LLVM_NOEXCEPT override { return "llvm.sampleprof"; }
25   std::string message(int IE) const override {
26     sampleprof_error E = static_cast<sampleprof_error>(IE);
27     switch (E) {
28     case sampleprof_error::success:
29       return "Success";
30     case sampleprof_error::bad_magic:
31       return "Invalid sample profile data (bad magic)";
32     case sampleprof_error::unsupported_version:
33       return "Unsupported sample profile format version";
34     case sampleprof_error::too_large:
35       return "Too much profile data";
36     case sampleprof_error::truncated:
37       return "Truncated profile data";
38     case sampleprof_error::malformed:
39       return "Malformed sample profile data";
40     case sampleprof_error::unrecognized_format:
41       return "Unrecognized sample profile encoding format";
42     case sampleprof_error::unsupported_writing_format:
43       return "Profile encoding format unsupported for writing operations";
44     case sampleprof_error::truncated_name_table:
45       return "Truncated function name table";
46     case sampleprof_error::not_implemented:
47       return "Unimplemented feature";
48     }
49     llvm_unreachable("A value of sampleprof_error has no message.");
50   }
51 };
52 }
53
54 static ManagedStatic<SampleProfErrorCategoryType> ErrorCategory;
55
56 const std::error_category &llvm::sampleprof_category() {
57   return *ErrorCategory;
58 }
59
60 /// \brief Print the samples collected for a function on stream \p OS.
61 ///
62 /// \param OS Stream to emit the output to.
63 void FunctionSamples::print(raw_ostream &OS, unsigned Indent) const {
64   OS << TotalSamples << ", " << TotalHeadSamples << ", " << BodySamples.size()
65      << " sampled lines\n";
66   for (const auto &SI : BodySamples) {
67     LineLocation Loc = SI.first;
68     const SampleRecord &Sample = SI.second;
69     OS.indent(Indent);
70     OS << "line offset: " << Loc.LineOffset
71        << ", discriminator: " << Loc.Discriminator
72        << ", number of samples: " << Sample.getSamples();
73     if (Sample.hasCalls()) {
74       OS << ", calls:";
75       for (const auto &I : Sample.getCallTargets())
76         OS << " " << I.first() << ":" << I.second;
77     }
78     OS << "\n";
79   }
80   for (const auto &CS : CallsiteSamples) {
81     CallsiteLocation Loc = CS.first;
82     const FunctionSamples &CalleeSamples = CS.second;
83     OS.indent(Indent);
84     OS << "line offset: " << Loc.LineOffset
85        << ", discriminator: " << Loc.Discriminator
86        << ", inlined callee: " << Loc.CalleeName << ": ";
87     CalleeSamples.print(OS, Indent + 2);
88   }
89 }