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/Config/llvm-config.h"
17 #include "llvm/IR/DebugInfoMetadata.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/ManagedStatic.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include <string>
24 #include <system_error>
25 
26 using namespace llvm;
27 using namespace sampleprof;
28 
29 namespace llvm {
30 namespace sampleprof {
31 SampleProfileFormat FunctionSamples::Format;
32 DenseMap<uint64_t, StringRef> FunctionSamples::GUIDToFuncNameMap;
33 Module *FunctionSamples::CurrentModule;
34 } // namespace sampleprof
35 } // namespace llvm
36 
37 namespace {
38 
39 // FIXME: This class is only here to support the transition to llvm::Error. It
40 // will be removed once this transition is complete. Clients should prefer to
41 // deal with the Error value directly, rather than converting to error_code.
42 class SampleProfErrorCategoryType : public std::error_category {
43   const char *name() const noexcept override { return "llvm.sampleprof"; }
44 
45   std::string message(int IE) const override {
46     sampleprof_error E = static_cast<sampleprof_error>(IE);
47     switch (E) {
48     case sampleprof_error::success:
49       return "Success";
50     case sampleprof_error::bad_magic:
51       return "Invalid sample profile data (bad magic)";
52     case sampleprof_error::unsupported_version:
53       return "Unsupported sample profile format version";
54     case sampleprof_error::too_large:
55       return "Too much profile data";
56     case sampleprof_error::truncated:
57       return "Truncated profile data";
58     case sampleprof_error::malformed:
59       return "Malformed sample profile data";
60     case sampleprof_error::unrecognized_format:
61       return "Unrecognized sample profile encoding format";
62     case sampleprof_error::unsupported_writing_format:
63       return "Profile encoding format unsupported for writing operations";
64     case sampleprof_error::truncated_name_table:
65       return "Truncated function name table";
66     case sampleprof_error::not_implemented:
67       return "Unimplemented feature";
68     case sampleprof_error::counter_overflow:
69       return "Counter overflow";
70     case sampleprof_error::ostream_seek_unsupported:
71       return "Ostream does not support seek";
72     }
73     llvm_unreachable("A value of sampleprof_error has no message.");
74   }
75 };
76 
77 } // end anonymous namespace
78 
79 static ManagedStatic<SampleProfErrorCategoryType> ErrorCategory;
80 
81 const std::error_category &llvm::sampleprof_category() {
82   return *ErrorCategory;
83 }
84 
85 void LineLocation::print(raw_ostream &OS) const {
86   OS << LineOffset;
87   if (Discriminator > 0)
88     OS << "." << Discriminator;
89 }
90 
91 raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
92                                           const LineLocation &Loc) {
93   Loc.print(OS);
94   return OS;
95 }
96 
97 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
98 LLVM_DUMP_METHOD void LineLocation::dump() const { print(dbgs()); }
99 #endif
100 
101 /// Print the sample record to the stream \p OS indented by \p Indent.
102 void SampleRecord::print(raw_ostream &OS, unsigned Indent) const {
103   OS << NumSamples;
104   if (hasCalls()) {
105     OS << ", calls:";
106     for (const auto &I : getCallTargets())
107       OS << " " << I.first() << ":" << I.second;
108   }
109   OS << "\n";
110 }
111 
112 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
113 LLVM_DUMP_METHOD void SampleRecord::dump() const { print(dbgs(), 0); }
114 #endif
115 
116 raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
117                                           const SampleRecord &Sample) {
118   Sample.print(OS, 0);
119   return OS;
120 }
121 
122 /// Print the samples collected for a function on stream \p OS.
123 void FunctionSamples::print(raw_ostream &OS, unsigned Indent) const {
124   OS << TotalSamples << ", " << TotalHeadSamples << ", " << BodySamples.size()
125      << " sampled lines\n";
126 
127   OS.indent(Indent);
128   if (!BodySamples.empty()) {
129     OS << "Samples collected in the function's body {\n";
130     SampleSorter<LineLocation, SampleRecord> SortedBodySamples(BodySamples);
131     for (const auto &SI : SortedBodySamples.get()) {
132       OS.indent(Indent + 2);
133       OS << SI->first << ": " << SI->second;
134     }
135     OS.indent(Indent);
136     OS << "}\n";
137   } else {
138     OS << "No samples collected in the function's body\n";
139   }
140 
141   OS.indent(Indent);
142   if (!CallsiteSamples.empty()) {
143     OS << "Samples collected in inlined callsites {\n";
144     SampleSorter<LineLocation, FunctionSamplesMap> SortedCallsiteSamples(
145         CallsiteSamples);
146     for (const auto &CS : SortedCallsiteSamples.get()) {
147       for (const auto &FS : CS->second) {
148         OS.indent(Indent + 2);
149         OS << CS->first << ": inlined callee: " << FS.second.getName() << ": ";
150         FS.second.print(OS, Indent + 4);
151       }
152     }
153     OS << "}\n";
154   } else {
155     OS << "No inlined callsites in this function\n";
156   }
157 }
158 
159 raw_ostream &llvm::sampleprof::operator<<(raw_ostream &OS,
160                                           const FunctionSamples &FS) {
161   FS.print(OS);
162   return OS;
163 }
164 
165 unsigned FunctionSamples::getOffset(const DILocation *DIL) {
166   return (DIL->getLine() - DIL->getScope()->getSubprogram()->getLine()) &
167       0xffff;
168 }
169 
170 const FunctionSamples *
171 FunctionSamples::findFunctionSamples(const DILocation *DIL) const {
172   assert(DIL);
173   SmallVector<std::pair<LineLocation, StringRef>, 10> S;
174 
175   const DILocation *PrevDIL = DIL;
176   for (DIL = DIL->getInlinedAt(); DIL; DIL = DIL->getInlinedAt()) {
177     S.push_back(std::make_pair(
178         LineLocation(getOffset(DIL), DIL->getBaseDiscriminator()),
179         PrevDIL->getScope()->getSubprogram()->getLinkageName()));
180     PrevDIL = DIL;
181   }
182   if (S.size() == 0)
183     return this;
184   const FunctionSamples *FS = this;
185   for (int i = S.size() - 1; i >= 0 && FS != nullptr; i--) {
186     FS = FS->findFunctionSamplesAt(S[i].first, S[i].second);
187   }
188   return FS;
189 }
190 
191 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
192 LLVM_DUMP_METHOD void FunctionSamples::dump() const { print(dbgs(), 0); }
193 #endif
194