SampleProf.cpp revision 309124 
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
19using namespace llvm::sampleprof;
20using namespace llvm;
21
22namespace {
23// FIXME: This class is only here to support the transition to llvm::Error. It
24// will be removed once this transition is complete. Clients should prefer to
25// deal with the Error value directly, rather than converting to error_code.
26class SampleProfErrorCategoryType : public std::error_category {
27  const char *name() const LLVM_NOEXCEPT override { return "llvm.sampleprof"; }
28  std::string message(int IE) const override {
29    sampleprof_error E = static_cast<sampleprof_error>(IE);
30    switch (E) {
31    case sampleprof_error::success:
32      return "Success";
33    case sampleprof_error::bad_magic:
34      return "Invalid sample profile data (bad magic)";
35    case sampleprof_error::unsupported_version:
36      return "Unsupported sample profile format version";
37    case sampleprof_error::too_large:
38      return "Too much profile data";
39    case sampleprof_error::truncated:
40      return "Truncated profile data";
41    case sampleprof_error::malformed:
42      return "Malformed sample profile data";
43    case sampleprof_error::unrecognized_format:
44      return "Unrecognized sample profile encoding format";
45    case sampleprof_error::unsupported_writing_format:
46      return "Profile encoding format unsupported for writing operations";
47    case sampleprof_error::truncated_name_table:
48      return "Truncated function name table";
49    case sampleprof_error::not_implemented:
50      return "Unimplemented feature";
51    case sampleprof_error::counter_overflow:
52      return "Counter overflow";
53    }
54    llvm_unreachable("A value of sampleprof_error has no message.");
55  }
56};
57}
58
59static ManagedStatic<SampleProfErrorCategoryType> ErrorCategory;
60
61const std::error_category &llvm::sampleprof_category() {
62  return *ErrorCategory;
63}
64
65void LineLocation::print(raw_ostream &OS) const {
66  OS << LineOffset;
67  if (Discriminator > 0)
68    OS << "." << Discriminator;
69}
70
71raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
72                                          const LineLocation &Loc) {
73  Loc.print(OS);
74  return OS;
75}
76
77LLVM_DUMP_METHOD void LineLocation::dump() const { print(dbgs()); }
78
79/// \brief Print the sample record to the stream \p OS indented by \p Indent.
80void SampleRecord::print(raw_ostream &OS, unsigned Indent) const {
81  OS << NumSamples;
82  if (hasCalls()) {
83    OS << ", calls:";
84    for (const auto &I : getCallTargets())
85      OS << " " << I.first() << ":" << I.second;
86  }
87  OS << "\n";
88}
89
90LLVM_DUMP_METHOD void SampleRecord::dump() const { print(dbgs(), 0); }
91
92raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
93                                          const SampleRecord &Sample) {
94  Sample.print(OS, 0);
95  return OS;
96}
97
98/// \brief Print the samples collected for a function on stream \p OS.
99void FunctionSamples::print(raw_ostream &OS, unsigned Indent) const {
100  OS << TotalSamples << ", " << TotalHeadSamples << ", " << BodySamples.size()
101     << " sampled lines\n";
102
103  OS.indent(Indent);
104  if (BodySamples.size() > 0) {
105    OS << "Samples collected in the function's body {\n";
106    SampleSorter<LineLocation, SampleRecord> SortedBodySamples(BodySamples);
107    for (const auto &SI : SortedBodySamples.get()) {
108      OS.indent(Indent + 2);
109      OS << SI->first << ": " << SI->second;
110    }
111    OS.indent(Indent);
112    OS << "}\n";
113  } else {
114    OS << "No samples collected in the function's body\n";
115  }
116
117  OS.indent(Indent);
118  if (CallsiteSamples.size() > 0) {
119    OS << "Samples collected in inlined callsites {\n";
120    SampleSorter<LineLocation, FunctionSamples> SortedCallsiteSamples(
121        CallsiteSamples);
122    for (const auto &CS : SortedCallsiteSamples.get()) {
123      OS.indent(Indent + 2);
124      OS << CS->first << ": inlined callee: " << CS->second.getName() << ": ";
125      CS->second.print(OS, Indent + 4);
126    }
127    OS << "}\n";
128  } else {
129    OS << "No inlined callsites in this function\n";
130  }
131}
132
133raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
134                                          const FunctionSamples &FS) {
135  FS.print(OS);
136  return OS;
137}
138
139void FunctionSamples::dump(void) const { print(dbgs(), 0); }
140