1 //=-- SampleProf.h - Sampling profiling format support --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains common definitions used in the reading and writing of
11 // sample profile data.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_PROFILEDATA_SAMPLEPROF_H_
16 #define LLVM_PROFILEDATA_SAMPLEPROF_H_
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Support/ErrorOr.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include <system_error>
28 const std::error_category &sampleprof_category();
30 enum class sampleprof_error {
38 unsupported_writing_format,
43 inline std::error_code make_error_code(sampleprof_error E) {
44 return std::error_code(static_cast<int>(E), sampleprof_category());
47 } // end namespace llvm
51 struct is_error_code_enum<llvm::sampleprof_error> : std::true_type {};
56 namespace sampleprof {
58 static inline uint64_t SPMagic() {
59 return uint64_t('S') << (64 - 8) | uint64_t('P') << (64 - 16) |
60 uint64_t('R') << (64 - 24) | uint64_t('O') << (64 - 32) |
61 uint64_t('F') << (64 - 40) | uint64_t('4') << (64 - 48) |
62 uint64_t('2') << (64 - 56) | uint64_t(0xff);
65 static inline uint64_t SPVersion() { return 102; }
67 /// Represents the relative location of an instruction.
69 /// Instruction locations are specified by the line offset from the
70 /// beginning of the function (marked by the line where the function
71 /// header is) and the discriminator value within that line.
73 /// The discriminator value is useful to distinguish instructions
74 /// that are on the same line but belong to different basic blocks
75 /// (e.g., the two post-increment instructions in "if (p) x++; else y++;").
77 LineLocation(uint32_t L, uint32_t D) : LineOffset(L), Discriminator(D) {}
78 void print(raw_ostream &OS) const {
80 if (Discriminator > 0)
81 OS << "." << Discriminator;
83 void dump() const { print(dbgs()); }
86 uint32_t Discriminator;
89 inline raw_ostream &operator<<(raw_ostream &OS, const LineLocation &Loc) {
94 /// Represents the relative location of a callsite.
96 /// Callsite locations are specified by the line offset from the
97 /// beginning of the function (marked by the line where the function
98 /// head is), the discriminator value within that line, and the callee
100 struct CallsiteLocation : public LineLocation {
101 CallsiteLocation(uint32_t L, uint32_t D, StringRef N)
102 : LineLocation(L, D), CalleeName(N) {}
103 StringRef CalleeName;
105 void print(raw_ostream &OS) const {
106 LineLocation::print(OS);
107 OS << ": inlined callee: " << CalleeName;
109 void dump() const { print(dbgs()); }
112 inline raw_ostream &operator<<(raw_ostream &OS, const CallsiteLocation &Loc) {
117 } // End namespace sampleprof
119 template <> struct DenseMapInfo<sampleprof::LineLocation> {
120 typedef DenseMapInfo<uint32_t> OffsetInfo;
121 typedef DenseMapInfo<uint32_t> DiscriminatorInfo;
122 static inline sampleprof::LineLocation getEmptyKey() {
123 return sampleprof::LineLocation(OffsetInfo::getEmptyKey(),
124 DiscriminatorInfo::getEmptyKey());
126 static inline sampleprof::LineLocation getTombstoneKey() {
127 return sampleprof::LineLocation(OffsetInfo::getTombstoneKey(),
128 DiscriminatorInfo::getTombstoneKey());
130 static inline unsigned getHashValue(sampleprof::LineLocation Val) {
131 return DenseMapInfo<std::pair<uint32_t, uint32_t>>::getHashValue(
132 std::pair<uint32_t, uint32_t>(Val.LineOffset, Val.Discriminator));
134 static inline bool isEqual(sampleprof::LineLocation LHS,
135 sampleprof::LineLocation RHS) {
136 return LHS.LineOffset == RHS.LineOffset &&
137 LHS.Discriminator == RHS.Discriminator;
141 template <> struct DenseMapInfo<sampleprof::CallsiteLocation> {
142 typedef DenseMapInfo<uint32_t> OffsetInfo;
143 typedef DenseMapInfo<uint32_t> DiscriminatorInfo;
144 typedef DenseMapInfo<StringRef> CalleeNameInfo;
145 static inline sampleprof::CallsiteLocation getEmptyKey() {
146 return sampleprof::CallsiteLocation(OffsetInfo::getEmptyKey(),
147 DiscriminatorInfo::getEmptyKey(), "");
149 static inline sampleprof::CallsiteLocation getTombstoneKey() {
150 return sampleprof::CallsiteLocation(OffsetInfo::getTombstoneKey(),
151 DiscriminatorInfo::getTombstoneKey(),
154 static inline unsigned getHashValue(sampleprof::CallsiteLocation Val) {
155 return DenseMapInfo<std::pair<uint32_t, uint32_t>>::getHashValue(
156 std::pair<uint32_t, uint32_t>(Val.LineOffset, Val.Discriminator));
158 static inline bool isEqual(sampleprof::CallsiteLocation LHS,
159 sampleprof::CallsiteLocation RHS) {
160 return LHS.LineOffset == RHS.LineOffset &&
161 LHS.Discriminator == RHS.Discriminator &&
162 LHS.CalleeName.equals(RHS.CalleeName);
166 namespace sampleprof {
168 /// Representation of a single sample record.
170 /// A sample record is represented by a positive integer value, which
171 /// indicates how frequently was the associated line location executed.
173 /// Additionally, if the associated location contains a function call,
174 /// the record will hold a list of all the possible called targets. For
175 /// direct calls, this will be the exact function being invoked. For
176 /// indirect calls (function pointers, virtual table dispatch), this
177 /// will be a list of one or more functions.
180 typedef StringMap<uint64_t> CallTargetMap;
182 SampleRecord() : NumSamples(0), CallTargets() {}
184 /// Increment the number of samples for this record by \p S.
186 /// Sample counts accumulate using saturating arithmetic, to avoid wrapping
187 /// around unsigned integers.
188 void addSamples(uint64_t S) {
189 if (NumSamples <= std::numeric_limits<uint64_t>::max() - S)
192 NumSamples = std::numeric_limits<uint64_t>::max();
195 /// Add called function \p F with samples \p S.
197 /// Sample counts accumulate using saturating arithmetic, to avoid wrapping
198 /// around unsigned integers.
199 void addCalledTarget(StringRef F, uint64_t S) {
200 uint64_t &TargetSamples = CallTargets[F];
201 if (TargetSamples <= std::numeric_limits<uint64_t>::max() - S)
204 TargetSamples = std::numeric_limits<uint64_t>::max();
207 /// Return true if this sample record contains function calls.
208 bool hasCalls() const { return CallTargets.size() > 0; }
210 uint64_t getSamples() const { return NumSamples; }
211 const CallTargetMap &getCallTargets() const { return CallTargets; }
213 /// Merge the samples in \p Other into this record.
214 void merge(const SampleRecord &Other) {
215 addSamples(Other.getSamples());
216 for (const auto &I : Other.getCallTargets())
217 addCalledTarget(I.first(), I.second);
220 void print(raw_ostream &OS, unsigned Indent) const;
221 void dump() const { print(dbgs(), 0); }
225 CallTargetMap CallTargets;
228 inline raw_ostream &operator<<(raw_ostream &OS, const SampleRecord &Sample) {
233 typedef DenseMap<LineLocation, SampleRecord> BodySampleMap;
234 class FunctionSamples;
235 typedef DenseMap<CallsiteLocation, FunctionSamples> CallsiteSampleMap;
237 /// Representation of the samples collected for a function.
239 /// This data structure contains all the collected samples for the body
240 /// of a function. Each sample corresponds to a LineLocation instance
241 /// within the body of the function.
242 class FunctionSamples {
244 FunctionSamples() : TotalSamples(0), TotalHeadSamples(0) {}
245 void print(raw_ostream &OS = dbgs(), unsigned Indent = 0) const;
246 void dump(void) const { print(); }
247 void addTotalSamples(uint64_t Num) { TotalSamples += Num; }
248 void addHeadSamples(uint64_t Num) { TotalHeadSamples += Num; }
249 void addBodySamples(uint32_t LineOffset, uint32_t Discriminator,
251 BodySamples[LineLocation(LineOffset, Discriminator)].addSamples(Num);
253 void addCalledTargetSamples(uint32_t LineOffset, uint32_t Discriminator,
254 std::string FName, uint64_t Num) {
255 BodySamples[LineLocation(LineOffset, Discriminator)].addCalledTarget(FName,
259 /// Return the number of samples collected at the given location.
260 /// Each location is specified by \p LineOffset and \p Discriminator.
261 /// If the location is not found in profile, return error.
262 ErrorOr<uint64_t> findSamplesAt(uint32_t LineOffset,
263 uint32_t Discriminator) const {
264 const auto &ret = BodySamples.find(LineLocation(LineOffset, Discriminator));
265 if (ret == BodySamples.end())
266 return std::error_code();
268 return ret->second.getSamples();
271 /// Return the function samples at the given callsite location.
272 FunctionSamples &functionSamplesAt(const CallsiteLocation &Loc) {
273 return CallsiteSamples[Loc];
276 /// Return a pointer to function samples at the given callsite location.
277 const FunctionSamples *
278 findFunctionSamplesAt(const CallsiteLocation &Loc) const {
279 auto iter = CallsiteSamples.find(Loc);
280 if (iter == CallsiteSamples.end()) {
283 return &iter->second;
287 bool empty() const { return TotalSamples == 0; }
289 /// Return the total number of samples collected inside the function.
290 uint64_t getTotalSamples() const { return TotalSamples; }
292 /// Return the total number of samples collected at the head of the
294 uint64_t getHeadSamples() const { return TotalHeadSamples; }
296 /// Return all the samples collected in the body of the function.
297 const BodySampleMap &getBodySamples() const { return BodySamples; }
299 /// Return all the callsite samples collected in the body of the function.
300 const CallsiteSampleMap &getCallsiteSamples() const {
301 return CallsiteSamples;
304 /// Merge the samples in \p Other into this one.
305 void merge(const FunctionSamples &Other) {
306 addTotalSamples(Other.getTotalSamples());
307 addHeadSamples(Other.getHeadSamples());
308 for (const auto &I : Other.getBodySamples()) {
309 const LineLocation &Loc = I.first;
310 const SampleRecord &Rec = I.second;
311 BodySamples[Loc].merge(Rec);
313 for (const auto &I : Other.getCallsiteSamples()) {
314 const CallsiteLocation &Loc = I.first;
315 const FunctionSamples &Rec = I.second;
316 functionSamplesAt(Loc).merge(Rec);
321 /// Total number of samples collected inside this function.
323 /// Samples are cumulative, they include all the samples collected
324 /// inside this function and all its inlined callees.
325 uint64_t TotalSamples;
327 /// Total number of samples collected at the head of the function.
328 /// This is an approximation of the number of calls made to this function
330 uint64_t TotalHeadSamples;
332 /// Map instruction locations to collected samples.
334 /// Each entry in this map contains the number of samples
335 /// collected at the corresponding line offset. All line locations
336 /// are an offset from the start of the function.
337 BodySampleMap BodySamples;
339 /// Map call sites to collected samples for the called function.
341 /// Each entry in this map corresponds to all the samples
342 /// collected for the inlined function call at the given
343 /// location. For example, given:
351 /// If the bar() and baz() calls were inlined inside foo(), this
352 /// map will contain two entries. One for all the samples collected
353 /// in the call to bar() at line offset 1, the other for all the samples
354 /// collected in the call to baz() at line offset 8.
355 CallsiteSampleMap CallsiteSamples;
358 inline raw_ostream &operator<<(raw_ostream &OS, const FunctionSamples &FS) {
363 } // end namespace sampleprof
365 } // end namespace llvm
367 #endif // LLVM_PROFILEDATA_SAMPLEPROF_H_