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 // 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.
26 class SampleProfErrorCategoryType : public std::error_category {
27   const char *name() const 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 
59 static ManagedStatic<SampleProfErrorCategoryType> ErrorCategory;
60 
61 const std::error_category &llvm::sampleprof_category() {
62   return *ErrorCategory;
63 }
64 
65 void LineLocation::print(raw_ostream &OS) const {
66   OS << LineOffset;
67   if (Discriminator > 0)
68     OS << "." << Discriminator;
69 }
70 
71 raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
72                                           const LineLocation &Loc) {
73   Loc.print(OS);
74   return OS;
75 }
76 
77 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
78 LLVM_DUMP_METHOD void LineLocation::dump() const { print(dbgs()); }
79 #endif
80 
81 /// \brief Print the sample record to the stream \p OS indented by \p Indent.
82 void SampleRecord::print(raw_ostream &OS, unsigned Indent) const {
83   OS << NumSamples;
84   if (hasCalls()) {
85     OS << ", calls:";
86     for (const auto &I : getCallTargets())
87       OS << " " << I.first() << ":" << I.second;
88   }
89   OS << "\n";
90 }
91 
92 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
93 LLVM_DUMP_METHOD void SampleRecord::dump() const { print(dbgs(), 0); }
94 #endif
95 
96 raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
97                                           const SampleRecord &Sample) {
98   Sample.print(OS, 0);
99   return OS;
100 }
101 
102 /// \brief Print the samples collected for a function on stream \p OS.
103 void FunctionSamples::print(raw_ostream &OS, unsigned Indent) const {
104   OS << TotalSamples << ", " << TotalHeadSamples << ", " << BodySamples.size()
105      << " sampled lines\n";
106 
107   OS.indent(Indent);
108   if (BodySamples.size() > 0) {
109     OS << "Samples collected in the function's body {\n";
110     SampleSorter<LineLocation, SampleRecord> SortedBodySamples(BodySamples);
111     for (const auto &SI : SortedBodySamples.get()) {
112       OS.indent(Indent + 2);
113       OS << SI->first << ": " << SI->second;
114     }
115     OS.indent(Indent);
116     OS << "}\n";
117   } else {
118     OS << "No samples collected in the function's body\n";
119   }
120 
121   OS.indent(Indent);
122   if (CallsiteSamples.size() > 0) {
123     OS << "Samples collected in inlined callsites {\n";
124     SampleSorter<LineLocation, FunctionSamples> SortedCallsiteSamples(
125         CallsiteSamples);
126     for (const auto &CS : SortedCallsiteSamples.get()) {
127       OS.indent(Indent + 2);
128       OS << CS->first << ": inlined callee: " << CS->second.getName() << ": ";
129       CS->second.print(OS, Indent + 4);
130     }
131     OS << "}\n";
132   } else {
133     OS << "No inlined callsites in this function\n";
134   }
135 }
136 
137 raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
138                                           const FunctionSamples &FS) {
139   FS.print(OS);
140   return OS;
141 }
142 
143 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
144 LLVM_DUMP_METHOD void FunctionSamples::dump(void) const { print(dbgs(), 0); }
145 #endif
146