LLVM  10.0.0svn
SampleProf.h
Go to the documentation of this file.
1 //===- SampleProf.h - Sampling profiling format support ---------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains common definitions used in the reading and writing of
10 // sample profile data.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_PROFILEDATA_SAMPLEPROF_H
15 #define LLVM_PROFILEDATA_SAMPLEPROF_H
16 
17 #include "llvm/ADT/DenseSet.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/ADT/StringSet.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/IR/GlobalValue.h"
24 #include "llvm/IR/Module.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/ErrorOr.h"
29 #include <algorithm>
30 #include <cstdint>
31 #include <map>
32 #include <set>
33 #include <string>
34 #include <system_error>
35 #include <utility>
36 
37 namespace llvm {
38 
39 class raw_ostream;
40 
42 
43 enum class sampleprof_error {
44  success = 0,
45  bad_magic,
47  too_large,
48  truncated,
49  malformed,
59 };
60 
61 inline std::error_code make_error_code(sampleprof_error E) {
62  return std::error_code(static_cast<int>(E), sampleprof_category());
63 }
64 
66  sampleprof_error Result) {
67  // Prefer first error encountered as later errors may be secondary effects of
68  // the initial problem.
69  if (Accumulator == sampleprof_error::success &&
70  Result != sampleprof_error::success)
71  Accumulator = Result;
72  return Accumulator;
73 }
74 
75 } // end namespace llvm
76 
77 namespace std {
78 
79 template <>
80 struct is_error_code_enum<llvm::sampleprof_error> : std::true_type {};
81 
82 } // end namespace std
83 
84 namespace llvm {
85 namespace sampleprof {
86 
88  SPF_None = 0,
89  SPF_Text = 0x1,
91  SPF_GCC = 0x3,
93  SPF_Binary = 0xff
94 };
95 
96 static inline uint64_t SPMagic(SampleProfileFormat Format = SPF_Binary) {
97  return uint64_t('S') << (64 - 8) | uint64_t('P') << (64 - 16) |
98  uint64_t('R') << (64 - 24) | uint64_t('O') << (64 - 32) |
99  uint64_t('F') << (64 - 40) | uint64_t('4') << (64 - 48) |
100  uint64_t('2') << (64 - 56) | uint64_t(Format);
101 }
102 
103 // Get the proper representation of a string in the input Format.
106  std::string &GUIDBuf) {
107  if (Name.empty())
108  return Name;
109  GUIDBuf = std::to_string(Function::getGUID(Name));
110  return (Format == SPF_Compact_Binary) ? StringRef(GUIDBuf) : Name;
111 }
112 
113 static inline uint64_t SPVersion() { return 103; }
114 
115 // Section Type used by SampleProfileExtBinaryBaseReader and
116 // SampleProfileExtBinaryBaseWriter. Never change the existing
117 // value of enum. Only append new ones.
118 enum SecType {
123  // marker for the first type of profile.
126 };
127 
128 // Entry type of section header table used by SampleProfileExtBinaryBaseReader
129 // and SampleProfileExtBinaryBaseWriter.
132  uint64_t Flag;
133  uint64_t Offset;
134  uint64_t Size;
135 };
136 
137 /// Represents the relative location of an instruction.
138 ///
139 /// Instruction locations are specified by the line offset from the
140 /// beginning of the function (marked by the line where the function
141 /// header is) and the discriminator value within that line.
142 ///
143 /// The discriminator value is useful to distinguish instructions
144 /// that are on the same line but belong to different basic blocks
145 /// (e.g., the two post-increment instructions in "if (p) x++; else y++;").
146 struct LineLocation {
147  LineLocation(uint32_t L, uint32_t D) : LineOffset(L), Discriminator(D) {}
148 
149  void print(raw_ostream &OS) const;
150  void dump() const;
151 
152  bool operator<(const LineLocation &O) const {
153  return LineOffset < O.LineOffset ||
154  (LineOffset == O.LineOffset && Discriminator < O.Discriminator);
155  }
156 
159 };
160 
162 
163 /// Representation of a single sample record.
164 ///
165 /// A sample record is represented by a positive integer value, which
166 /// indicates how frequently was the associated line location executed.
167 ///
168 /// Additionally, if the associated location contains a function call,
169 /// the record will hold a list of all the possible called targets. For
170 /// direct calls, this will be the exact function being invoked. For
171 /// indirect calls (function pointers, virtual table dispatch), this
172 /// will be a list of one or more functions.
174 public:
175  using CallTarget = std::pair<StringRef, uint64_t>;
177  bool operator()(const CallTarget &LHS, const CallTarget &RHS) const {
178  if (LHS.second != RHS.second)
179  return LHS.second > RHS.second;
180 
181  return LHS.first < RHS.first;
182  }
183  };
184 
185  using SortedCallTargetSet = std::set<CallTarget, CallTargetComparator>;
187  SampleRecord() = default;
188 
189  /// Increment the number of samples for this record by \p S.
190  /// Optionally scale sample count \p S by \p Weight.
191  ///
192  /// Sample counts accumulate using saturating arithmetic, to avoid wrapping
193  /// around unsigned integers.
194  sampleprof_error addSamples(uint64_t S, uint64_t Weight = 1) {
195  bool Overflowed;
196  NumSamples = SaturatingMultiplyAdd(S, Weight, NumSamples, &Overflowed);
197  return Overflowed ? sampleprof_error::counter_overflow
199  }
200 
201  /// Add called function \p F with samples \p S.
202  /// Optionally scale sample count \p S by \p Weight.
203  ///
204  /// Sample counts accumulate using saturating arithmetic, to avoid wrapping
205  /// around unsigned integers.
207  uint64_t Weight = 1) {
208  uint64_t &TargetSamples = CallTargets[F];
209  bool Overflowed;
210  TargetSamples =
211  SaturatingMultiplyAdd(S, Weight, TargetSamples, &Overflowed);
212  return Overflowed ? sampleprof_error::counter_overflow
214  }
215 
216  /// Return true if this sample record contains function calls.
217  bool hasCalls() const { return !CallTargets.empty(); }
218 
219  uint64_t getSamples() const { return NumSamples; }
220  const CallTargetMap &getCallTargets() const { return CallTargets; }
222  return SortCallTargets(CallTargets);
223  }
224 
225  /// Sort call targets in descending order of call frequency.
226  static const SortedCallTargetSet SortCallTargets(const CallTargetMap &Targets) {
227  SortedCallTargetSet SortedTargets;
228  for (const auto &I : Targets) {
229  SortedTargets.emplace(I.first(), I.second);
230  }
231  return SortedTargets;
232  }
233 
234  /// Merge the samples in \p Other into this record.
235  /// Optionally scale sample counts by \p Weight.
236  sampleprof_error merge(const SampleRecord &Other, uint64_t Weight = 1) {
237  sampleprof_error Result = addSamples(Other.getSamples(), Weight);
238  for (const auto &I : Other.getCallTargets()) {
239  MergeResult(Result, addCalledTarget(I.first(), I.second, Weight));
240  }
241  return Result;
242  }
243 
244  void print(raw_ostream &OS, unsigned Indent) const;
245  void dump() const;
246 
247 private:
248  uint64_t NumSamples = 0;
249  CallTargetMap CallTargets;
250 };
251 
252 raw_ostream &operator<<(raw_ostream &OS, const SampleRecord &Sample);
253 
254 class FunctionSamples;
255 
256 using BodySampleMap = std::map<LineLocation, SampleRecord>;
257 // NOTE: Using a StringMap here makes parsed profiles consume around 17% more
258 // memory, which is *very* significant for large profiles.
259 using FunctionSamplesMap = std::map<std::string, FunctionSamples, std::less<>>;
260 using CallsiteSampleMap = std::map<LineLocation, FunctionSamplesMap>;
261 
262 /// Representation of the samples collected for a function.
263 ///
264 /// This data structure contains all the collected samples for the body
265 /// of a function. Each sample corresponds to a LineLocation instance
266 /// within the body of the function.
268 public:
269  FunctionSamples() = default;
270 
271  void print(raw_ostream &OS = dbgs(), unsigned Indent = 0) const;
272  void dump() const;
273 
274  sampleprof_error addTotalSamples(uint64_t Num, uint64_t Weight = 1) {
275  bool Overflowed;
276  TotalSamples =
277  SaturatingMultiplyAdd(Num, Weight, TotalSamples, &Overflowed);
278  return Overflowed ? sampleprof_error::counter_overflow
280  }
281 
282  sampleprof_error addHeadSamples(uint64_t Num, uint64_t Weight = 1) {
283  bool Overflowed;
284  TotalHeadSamples =
285  SaturatingMultiplyAdd(Num, Weight, TotalHeadSamples, &Overflowed);
286  return Overflowed ? sampleprof_error::counter_overflow
288  }
289 
291  uint64_t Num, uint64_t Weight = 1) {
292  return BodySamples[LineLocation(LineOffset, Discriminator)].addSamples(
293  Num, Weight);
294  }
295 
297  uint32_t Discriminator,
298  StringRef FName, uint64_t Num,
299  uint64_t Weight = 1) {
300  return BodySamples[LineLocation(LineOffset, Discriminator)].addCalledTarget(
301  FName, Num, Weight);
302  }
303 
304  /// Return the number of samples collected at the given location.
305  /// Each location is specified by \p LineOffset and \p Discriminator.
306  /// If the location is not found in profile, return error.
308  uint32_t Discriminator) const {
309  const auto &ret = BodySamples.find(LineLocation(LineOffset, Discriminator));
310  if (ret == BodySamples.end())
311  return std::error_code();
312  else
313  return ret->second.getSamples();
314  }
315 
316  /// Returns the call target map collected at a given location.
317  /// Each location is specified by \p LineOffset and \p Discriminator.
318  /// If the location is not found in profile, return error.
320  findCallTargetMapAt(uint32_t LineOffset, uint32_t Discriminator) const {
321  const auto &ret = BodySamples.find(LineLocation(LineOffset, Discriminator));
322  if (ret == BodySamples.end())
323  return std::error_code();
324  return ret->second.getCallTargets();
325  }
326 
327  /// Return the function samples at the given callsite location.
329  return CallsiteSamples[Loc];
330  }
331 
332  /// Returns the FunctionSamplesMap at the given \p Loc.
333  const FunctionSamplesMap *
335  auto iter = CallsiteSamples.find(Loc);
336  if (iter == CallsiteSamples.end())
337  return nullptr;
338  return &iter->second;
339  }
340 
341  /// Returns a pointer to FunctionSamples at the given callsite location \p Loc
342  /// with callee \p CalleeName. If no callsite can be found, relax the
343  /// restriction to return the FunctionSamples at callsite location \p Loc
344  /// with the maximum total sample count.
346  StringRef CalleeName) const {
347  std::string CalleeGUID;
348  CalleeName = getRepInFormat(CalleeName, Format, CalleeGUID);
349 
350  auto iter = CallsiteSamples.find(Loc);
351  if (iter == CallsiteSamples.end())
352  return nullptr;
353  auto FS = iter->second.find(CalleeName);
354  if (FS != iter->second.end())
355  return &FS->second;
356  // If we cannot find exact match of the callee name, return the FS with
357  // the max total count.
358  uint64_t MaxTotalSamples = 0;
359  const FunctionSamples *R = nullptr;
360  for (const auto &NameFS : iter->second)
361  if (NameFS.second.getTotalSamples() >= MaxTotalSamples) {
362  MaxTotalSamples = NameFS.second.getTotalSamples();
363  R = &NameFS.second;
364  }
365  return R;
366  }
367 
368  bool empty() const { return TotalSamples == 0; }
369 
370  /// Return the total number of samples collected inside the function.
371  uint64_t getTotalSamples() const { return TotalSamples; }
372 
373  /// Return the total number of branch samples that have the function as the
374  /// branch target. This should be equivalent to the sample of the first
375  /// instruction of the symbol. But as we directly get this info for raw
376  /// profile without referring to potentially inaccurate debug info, this
377  /// gives more accurate profile data and is preferred for standalone symbols.
378  uint64_t getHeadSamples() const { return TotalHeadSamples; }
379 
380  /// Return the sample count of the first instruction of the function.
381  /// The function can be either a standalone symbol or an inlined function.
382  uint64_t getEntrySamples() const {
383  // Use either BodySamples or CallsiteSamples which ever has the smaller
384  // lineno.
385  if (!BodySamples.empty() &&
386  (CallsiteSamples.empty() ||
387  BodySamples.begin()->first < CallsiteSamples.begin()->first))
388  return BodySamples.begin()->second.getSamples();
389  if (!CallsiteSamples.empty()) {
390  uint64_t T = 0;
391  // An indirect callsite may be promoted to several inlined direct calls.
392  // We need to get the sum of them.
393  for (const auto &N_FS : CallsiteSamples.begin()->second)
394  T += N_FS.second.getEntrySamples();
395  return T;
396  }
397  return 0;
398  }
399 
400  /// Return all the samples collected in the body of the function.
401  const BodySampleMap &getBodySamples() const { return BodySamples; }
402 
403  /// Return all the callsite samples collected in the body of the function.
405  return CallsiteSamples;
406  }
407 
408  /// Merge the samples in \p Other into this one.
409  /// Optionally scale samples by \p Weight.
410  sampleprof_error merge(const FunctionSamples &Other, uint64_t Weight = 1) {
412  Name = Other.getName();
413  MergeResult(Result, addTotalSamples(Other.getTotalSamples(), Weight));
414  MergeResult(Result, addHeadSamples(Other.getHeadSamples(), Weight));
415  for (const auto &I : Other.getBodySamples()) {
416  const LineLocation &Loc = I.first;
417  const SampleRecord &Rec = I.second;
418  MergeResult(Result, BodySamples[Loc].merge(Rec, Weight));
419  }
420  for (const auto &I : Other.getCallsiteSamples()) {
421  const LineLocation &Loc = I.first;
422  FunctionSamplesMap &FSMap = functionSamplesAt(Loc);
423  for (const auto &Rec : I.second)
424  MergeResult(Result, FSMap[Rec.first].merge(Rec.second, Weight));
425  }
426  return Result;
427  }
428 
429  /// Recursively traverses all children, if the total sample count of the
430  /// corresponding function is no less than \p Threshold, add its corresponding
431  /// GUID to \p S. Also traverse the BodySamples to add hot CallTarget's GUID
432  /// to \p S.
434  uint64_t Threshold) const {
435  if (TotalSamples <= Threshold)
436  return;
437  S.insert(getGUID(Name));
438  // Import hot CallTargets, which may not be available in IR because full
439  // profile annotation cannot be done until backend compilation in ThinLTO.
440  for (const auto &BS : BodySamples)
441  for (const auto &TS : BS.second.getCallTargets())
442  if (TS.getValue() > Threshold) {
443  const Function *Callee =
444  M->getFunction(getNameInModule(TS.getKey(), M));
445  if (!Callee || !Callee->getSubprogram())
446  S.insert(getGUID(TS.getKey()));
447  }
448  for (const auto &CS : CallsiteSamples)
449  for (const auto &NameFS : CS.second)
450  NameFS.second.findInlinedFunctions(S, M, Threshold);
451  }
452 
453  /// Set the name of the function.
454  void setName(StringRef FunctionName) { Name = FunctionName; }
455 
456  /// Return the function name.
457  StringRef getName() const { return Name; }
458 
459  /// Return the original function name if it exists in Module \p M.
461  return getNameInModule(Name, M);
462  }
463 
464  /// Return the canonical name for a function, taking into account
465  /// suffix elision policy attributes.
467  static const char *knownSuffixes[] = { ".llvm.", ".part." };
468  auto AttrName = "sample-profile-suffix-elision-policy";
469  auto Attr = F.getFnAttribute(AttrName).getValueAsString();
470  if (Attr == "" || Attr == "all") {
471  return F.getName().split('.').first;
472  } else if (Attr == "selected") {
473  StringRef Cand(F.getName());
474  for (const auto &Suf : knownSuffixes) {
475  StringRef Suffix(Suf);
476  auto It = Cand.rfind(Suffix);
477  if (It == StringRef::npos)
478  return Cand;
479  auto Dit = Cand.rfind('.');
480  if (Dit == It + Suffix.size() - 1)
481  Cand = Cand.substr(0, It);
482  }
483  return Cand;
484  } else if (Attr == "none") {
485  return F.getName();
486  } else {
487  assert(false && "internal error: unknown suffix elision policy");
488  }
489  return F.getName();
490  }
491 
492  /// Translate \p Name into its original name in Module.
493  /// When the Format is not SPF_Compact_Binary, \p Name needs no translation.
494  /// When the Format is SPF_Compact_Binary, \p Name in current FunctionSamples
495  /// is actually GUID of the original function name. getNameInModule will
496  /// translate \p Name in current FunctionSamples into its original name.
497  /// If the original name doesn't exist in \p M, return empty StringRef.
499  if (Format != SPF_Compact_Binary)
500  return Name;
501 
502  assert(GUIDToFuncNameMap && "GUIDToFuncNameMap needs to be popluated first");
503  auto iter = GUIDToFuncNameMap->find(std::stoull(Name.data()));
504  if (iter == GUIDToFuncNameMap->end())
505  return StringRef();
506  return iter->second;
507  }
508 
509  /// Returns the line offset to the start line of the subprogram.
510  /// We assume that a single function will not exceed 65535 LOC.
511  static unsigned getOffset(const DILocation *DIL);
512 
513  /// Get the FunctionSamples of the inline instance where DIL originates
514  /// from.
515  ///
516  /// The FunctionSamples of the instruction (Machine or IR) associated to
517  /// \p DIL is the inlined instance in which that instruction is coming from.
518  /// We traverse the inline stack of that instruction, and match it with the
519  /// tree nodes in the profile.
520  ///
521  /// \returns the FunctionSamples pointer to the inlined instance.
522  const FunctionSamples *findFunctionSamples(const DILocation *DIL) const;
523 
525 
526  /// GUIDToFuncNameMap saves the mapping from GUID to the symbol name, for
527  /// all the function symbols defined or declared in current module.
528  DenseMap<uint64_t, StringRef> *GUIDToFuncNameMap = nullptr;
529 
530  // Assume the input \p Name is a name coming from FunctionSamples itself.
531  // If the format is SPF_Compact_Binary, the name is already a GUID and we
532  // don't want to return the GUID of GUID.
533  static uint64_t getGUID(StringRef Name) {
534  return (Format == SPF_Compact_Binary) ? std::stoull(Name.data())
535  : Function::getGUID(Name);
536  }
537 
538 private:
539  /// Mangled name of the function.
540  StringRef Name;
541 
542  /// Total number of samples collected inside this function.
543  ///
544  /// Samples are cumulative, they include all the samples collected
545  /// inside this function and all its inlined callees.
546  uint64_t TotalSamples = 0;
547 
548  /// Total number of samples collected at the head of the function.
549  /// This is an approximation of the number of calls made to this function
550  /// at runtime.
551  uint64_t TotalHeadSamples = 0;
552 
553  /// Map instruction locations to collected samples.
554  ///
555  /// Each entry in this map contains the number of samples
556  /// collected at the corresponding line offset. All line locations
557  /// are an offset from the start of the function.
558  BodySampleMap BodySamples;
559 
560  /// Map call sites to collected samples for the called function.
561  ///
562  /// Each entry in this map corresponds to all the samples
563  /// collected for the inlined function call at the given
564  /// location. For example, given:
565  ///
566  /// void foo() {
567  /// 1 bar();
568  /// ...
569  /// 8 baz();
570  /// }
571  ///
572  /// If the bar() and baz() calls were inlined inside foo(), this
573  /// map will contain two entries. One for all the samples collected
574  /// in the call to bar() at line offset 1, the other for all the samples
575  /// collected in the call to baz() at line offset 8.
576  CallsiteSampleMap CallsiteSamples;
577 };
578 
580 
581 /// Sort a LocationT->SampleT map by LocationT.
582 ///
583 /// It produces a sorted list of <LocationT, SampleT> records by ascending
584 /// order of LocationT.
585 template <class LocationT, class SampleT> class SampleSorter {
586 public:
587  using SamplesWithLoc = std::pair<const LocationT, SampleT>;
589 
590  SampleSorter(const std::map<LocationT, SampleT> &Samples) {
591  for (const auto &I : Samples)
592  V.push_back(&I);
593  llvm::stable_sort(V, [](const SamplesWithLoc *A, const SamplesWithLoc *B) {
594  return A->first < B->first;
595  });
596  }
597 
598  const SamplesWithLocList &get() const { return V; }
599 
600 private:
602 };
603 
604 /// ProfileSymbolList records the list of function symbols shown up
605 /// in the binary used to generate the profile. It is useful to
606 /// to discriminate a function being so cold as not to shown up
607 /// in the profile and a function newly added.
609 public:
610  /// copy indicates whether we need to copy the underlying memory
611  /// for the input Name.
612  void add(StringRef Name, bool copy = false) {
613  if (!copy) {
614  Syms.insert(Name);
615  return;
616  }
617  Syms.insert(Name.copy(Allocator));
618  }
619 
620  bool contains(StringRef Name) { return Syms.count(Name); }
621 
622  void merge(const ProfileSymbolList &List) {
623  for (auto Sym : List.Syms)
624  add(Sym, true);
625  }
626 
627  unsigned size() { return Syms.size(); }
628 
629  void setToCompress(bool TC) { ToCompress = TC; }
630 
631  std::error_code read(uint64_t CompressSize, uint64_t UncompressSize,
632  const uint8_t *Data);
633  std::error_code write(raw_ostream &OS);
634  void dump(raw_ostream &OS = dbgs()) const;
635 
636 private:
637  // Determine whether or not to compress the symbol list when
638  // writing it into profile. The variable is unused when the symbol
639  // list is read from an existing profile.
640  bool ToCompress = false;
641  DenseSet<StringRef> Syms;
643 };
644 
645 } // end namespace sampleprof
646 } // end namespace llvm
647 
648 #endif // LLVM_PROFILEDATA_SAMPLEPROF_H
const FunctionSamplesMap * findFunctionSamplesMapAt(const LineLocation &Loc) const
Returns the FunctionSamplesMap at the given Loc.
Definition: SampleProf.h:334
static uint64_t getGUID(StringRef Name)
Definition: SampleProf.h:533
Represents either an error or a value T.
Definition: ErrorOr.h:56
This class represents lattice values for constants.
Definition: AllocatorList.h:23
static StringRef getRepInFormat(StringRef Name, SampleProfileFormat Format, std::string &GUIDBuf)
Definition: SampleProf.h:104
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
Implements a dense probed hash-table based set.
Definition: DenseSet.h:249
sampleprof_error merge(const SampleRecord &Other, uint64_t Weight=1)
Merge the samples in Other into this record.
Definition: SampleProf.h:236
bool contains(StringRef Name)
Definition: SampleProf.h:620
LineLocation(uint32_t L, uint32_t D)
Definition: SampleProf.h:147
SampleSorter(const std::map< LocationT, SampleT > &Samples)
Definition: SampleProf.h:590
ErrorOr< uint64_t > findSamplesAt(uint32_t LineOffset, uint32_t Discriminator) const
Return the number of samples collected at the given location.
Definition: SampleProf.h:307
F(f)
std::pair< const LocationT, SampleT > SamplesWithLoc
Definition: SampleProf.h:587
void merge(const ProfileSymbolList &List)
Definition: SampleProf.h:622
void findInlinedFunctions(DenseSet< GlobalValue::GUID > &S, const Module *M, uint64_t Threshold) const
Recursively traverses all children, if the total sample count of the corresponding function is no les...
Definition: SampleProf.h:433
bool operator<(const LineLocation &O) const
Definition: SampleProf.h:152
static SampleProfileFormat Format
Definition: SampleProf.h:524
Representation of the samples collected for a function.
Definition: SampleProf.h:267
static const SortedCallTargetSet SortCallTargets(const CallTargetMap &Targets)
Sort call targets in descending order of call frequency.
Definition: SampleProf.h:226
Definition: BitVector.h:937
LLVM_NODISCARD StringRef copy(Allocator &A) const
Definition: StringRef.h:162
std::error_code make_error_code(BitcodeError E)
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:140
sampleprof_error addCalledTarget(StringRef F, uint64_t S, uint64_t Weight=1)
Add called function F with samples S.
Definition: SampleProf.h:206
Representation of a single sample record.
Definition: SampleProf.h:173
LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:144
void setName(StringRef FunctionName)
Set the name of the function.
Definition: SampleProf.h:454
static Error getOffset(const SymbolRef &Sym, SectionRef Sec, uint64_t &Result)
std::map< LineLocation, SampleRecord > BodySampleMap
Definition: SampleProf.h:256
Debug location.
static uint64_t SPVersion()
Definition: SampleProf.h:113
Sort a LocationT->SampleT map by LocationT.
Definition: SampleProf.h:585
uint64_t getHeadSamples() const
Return the total number of branch samples that have the function as the branch target.
Definition: SampleProf.h:378
uint64_t getSamples() const
Definition: SampleProf.h:219
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
void dump(const SparseBitVector< ElementSize > &LHS, raw_ostream &out)
sampleprof_error
Definition: SampleProf.h:43
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:140
DISubprogram * getSubprogram() const
Get the attached subprogram.
Definition: Metadata.cpp:1504
const BodySampleMap & getBodySamples() const
Return all the samples collected in the body of the function.
Definition: SampleProf.h:401
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
sampleprof_error addBodySamples(uint32_t LineOffset, uint32_t Discriminator, uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:290
sampleprof_error addSamples(uint64_t S, uint64_t Weight=1)
Increment the number of samples for this record by S.
Definition: SampleProf.h:194
static StringRef getCanonicalFnName(const Function &F)
Return the canonical name for a function, taking into account suffix elision policy attributes...
Definition: SampleProf.h:466
static ManagedStatic< _object_error_category > error_category
Definition: Error.cpp:74
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
static void write(bool isBE, void *P, T V)
std::map< std::string, FunctionSamples, std::less<> > FunctionSamplesMap
Definition: SampleProf.h:259
StringRef getFuncNameInModule(const Module *M) const
Return the original function name if it exists in Module M.
Definition: SampleProf.h:460
std::enable_if< std::is_unsigned< T >::value, T >::type SaturatingMultiplyAdd(T X, T Y, T A, bool *ResultOverflowed=nullptr)
Multiply two unsigned integers, X and Y, and add the unsigned integer, A to the product.
Definition: MathExtras.h:823
const FunctionSamples * findFunctionSamplesAt(const LineLocation &Loc, StringRef CalleeName) const
Returns a pointer to FunctionSamples at the given callsite location Loc with callee CalleeName...
Definition: SampleProf.h:345
Basic Register Allocator
sampleprof_error addTotalSamples(uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:274
static uint64_t add(uint64_t LeftOp, uint64_t RightOp)
Definition: FileCheck.cpp:214
Module.h This file contains the declarations for the Module class.
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:710
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
FunctionSamplesMap & functionSamplesAt(const LineLocation &Loc)
Return the function samples at the given callsite location.
Definition: SampleProf.h:328
ErrorOr< SampleRecord::CallTargetMap > findCallTargetMapAt(uint32_t LineOffset, uint32_t Discriminator) const
Returns the call target map collected at a given location.
Definition: SampleProf.h:320
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
Function * getFunction(StringRef Name) const
Look up the specified function in the module symbol table.
Definition: Module.cpp:174
const std::error_category & sampleprof_category()
Definition: SampleProf.cpp:87
amdgpu Simplify well known AMD library false FunctionCallee Callee
static cl::opt< unsigned > Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"), cl::init(100), cl::Hidden)
GUID getGUID() const
Return a 64-bit global unique ID constructed from global value name (i.e.
Definition: GlobalValue.h:510
bool hasCalls() const
Return true if this sample record contains function calls.
Definition: SampleProf.h:217
std::map< LineLocation, FunctionSamplesMap > CallsiteSampleMap
Definition: SampleProf.h:260
ProfileSymbolList records the list of function symbols shown up in the binary used to generate the pr...
Definition: SampleProf.h:608
static const size_t npos
Definition: StringRef.h:50
Represents the relative location of an instruction.
Definition: SampleProf.h:146
StringRef getNameInModule(StringRef Name, const Module *M) const
Translate Name into its original name in Module.
Definition: SampleProf.h:498
StringRef getValueAsString() const
Return the attribute&#39;s value as a string.
Definition: Attributes.cpp:223
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:214
value_type read(const void *memory, endianness endian)
Read a value of a particular endianness from memory.
Definition: Endian.h:65
const NodeList & List
Definition: RDFGraph.cpp:201
#define I(x, y, z)
Definition: MD5.cpp:58
StringRef getName() const
Return the function name.
Definition: SampleProf.h:457
const CallTargetMap & getCallTargets() const
Definition: SampleProf.h:220
std::set< CallTarget, CallTargetComparator > SortedCallTargetSet
Definition: SampleProf.h:185
raw_ostream & operator<<(raw_ostream &OS, const APInt &I)
Definition: APInt.h:2045
static GlobalValue::GUID getGUID(GlobalValue::GUID G)
static uint64_t SPMagic(SampleProfileFormat Format=SPF_Binary)
Definition: SampleProf.h:96
sampleprof_error addHeadSamples(uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:282
const std::string to_string(const T &Value)
Definition: ScopedPrinter.h:61
Provides ErrorOr<T> smart pointer.
LLVM_NODISCARD const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:136
std::pair< StringRef, uint64_t > CallTarget
Definition: SampleProf.h:175
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
void stable_sort(R &&Range)
Definition: STLExtras.h:1289
uint64_t getTotalSamples() const
Return the total number of samples collected inside the function.
Definition: SampleProf.h:371
const CallsiteSampleMap & getCallsiteSamples() const
Return all the callsite samples collected in the body of the function.
Definition: SampleProf.h:404
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
Definition: Function.h:333
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
uint64_t getEntrySamples() const
Return the sample count of the first instruction of the function.
Definition: SampleProf.h:382
const SortedCallTargetSet getSortedCallTargets() const
Definition: SampleProf.h:221
for(unsigned i=Desc.getNumOperands(), e=OldMI.getNumOperands();i !=e;++i)
bool operator()(const CallTarget &LHS, const CallTarget &RHS) const
Definition: SampleProf.h:177
OutputIt copy(R &&Range, OutputIt Out)
Definition: STLExtras.h:1217
sampleprof_error merge(const FunctionSamples &Other, uint64_t Weight=1)
Merge the samples in Other into this one.
Definition: SampleProf.h:410
sampleprof_error addCalledTargetSamples(uint32_t LineOffset, uint32_t Discriminator, StringRef FName, uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:296
sampleprof_error MergeResult(sampleprof_error &Accumulator, sampleprof_error Result)
Definition: SampleProf.h:65
void add(StringRef Name, bool copy=false)
copy indicates whether we need to copy the underlying memory for the input Name.
Definition: SampleProf.h:612