LLVM  14.0.0git
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/Allocator.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/ErrorOr.h"
30 #include <algorithm>
31 #include <cstdint>
32 #include <list>
33 #include <map>
34 #include <set>
35 #include <sstream>
36 #include <string>
37 #include <system_error>
38 #include <unordered_map>
39 #include <utility>
40 
41 namespace llvm {
42 
44 
45 enum class sampleprof_error {
46  success = 0,
47  bad_magic,
49  too_large,
50  truncated,
51  malformed,
62 };
63 
64 inline std::error_code make_error_code(sampleprof_error E) {
65  return std::error_code(static_cast<int>(E), sampleprof_category());
66 }
67 
69  sampleprof_error Result) {
70  // Prefer first error encountered as later errors may be secondary effects of
71  // the initial problem.
73  Result != sampleprof_error::success)
74  Accumulator = Result;
75  return Accumulator;
76 }
77 
78 } // end namespace llvm
79 
80 namespace std {
81 
82 template <>
83 struct is_error_code_enum<llvm::sampleprof_error> : std::true_type {};
84 
85 } // end namespace std
86 
87 namespace llvm {
88 namespace sampleprof {
89 
91  SPF_None = 0,
92  SPF_Text = 0x1,
94  SPF_GCC = 0x3,
96  SPF_Binary = 0xff
97 };
98 
100  return uint64_t('S') << (64 - 8) | uint64_t('P') << (64 - 16) |
101  uint64_t('R') << (64 - 24) | uint64_t('O') << (64 - 32) |
102  uint64_t('F') << (64 - 40) | uint64_t('4') << (64 - 48) |
103  uint64_t('2') << (64 - 56) | uint64_t(Format);
104 }
105 
106 /// Get the proper representation of a string according to whether the
107 /// current Format uses MD5 to represent the string.
108 static inline StringRef getRepInFormat(StringRef Name, bool UseMD5,
109  std::string &GUIDBuf) {
110  if (Name.empty() || !UseMD5)
111  return Name;
113  return GUIDBuf;
114 }
115 
116 static inline uint64_t SPVersion() { return 103; }
117 
118 // Section Type used by SampleProfileExtBinaryBaseReader and
119 // SampleProfileExtBinaryBaseWriter. Never change the existing
120 // value of enum. Only append new ones.
121 enum SecType {
129  // marker for the first type of profile.
132 };
133 
134 static inline std::string getSecName(SecType Type) {
135  switch ((int)Type) { // Avoid -Wcovered-switch-default
136  case SecInValid:
137  return "InvalidSection";
138  case SecProfSummary:
139  return "ProfileSummarySection";
140  case SecNameTable:
141  return "NameTableSection";
143  return "ProfileSymbolListSection";
144  case SecFuncOffsetTable:
145  return "FuncOffsetTableSection";
146  case SecFuncMetadata:
147  return "FunctionMetadata";
148  case SecCSNameTable:
149  return "CSNameTableSection";
150  case SecLBRProfile:
151  return "LBRProfileSection";
152  default:
153  return "UnknownSection";
154  }
155 }
156 
157 // Entry type of section header table used by SampleProfileExtBinaryBaseReader
158 // and SampleProfileExtBinaryBaseWriter.
164  // The index indicating the location of the current entry in
165  // SectionHdrLayout table.
167 };
168 
169 // Flags common for all sections are defined here. In SecHdrTableEntry::Flags,
170 // common flags will be saved in the lower 32bits and section specific flags
171 // will be saved in the higher 32 bits.
172 enum class SecCommonFlags : uint32_t {
173  SecFlagInValid = 0,
174  SecFlagCompress = (1 << 0),
175  // Indicate the section contains only profile without context.
176  SecFlagFlat = (1 << 1)
177 };
178 
179 // Section specific flags are defined here.
180 // !!!Note: Everytime a new enum class is created here, please add
181 // a new check in verifySecFlag.
183  SecFlagInValid = 0,
184  SecFlagMD5Name = (1 << 0),
185  // Store MD5 in fixed length instead of ULEB128 so NameTable can be
186  // accessed like an array.
187  SecFlagFixedLengthMD5 = (1 << 1),
188  // Profile contains ".__uniq." suffix name. Compiler shouldn't strip
189  // the suffix when doing profile matching when seeing the flag.
190  SecFlagUniqSuffix = (1 << 2)
191 };
193  SecFlagInValid = 0,
194  /// SecFlagPartial means the profile is for common/shared code.
195  /// The common profile is usually merged from profiles collected
196  /// from running other targets.
197  SecFlagPartial = (1 << 0),
198  /// SecFlagContext means this is context-sensitive flat profile for
199  /// CSSPGO
200  SecFlagFullContext = (1 << 1),
201  /// SecFlagFSDiscriminator means this profile uses flow-sensitive
202  /// discriminators.
203  SecFlagFSDiscriminator = (1 << 2),
204  /// SecFlagIsCSNested means this is context-sensitive nested profile for
205  /// CSSPGO
206  SecFlagIsCSNested = (1 << 4),
207 };
208 
210  SecFlagInvalid = 0,
211  SecFlagIsProbeBased = (1 << 0),
212  SecFlagHasAttribute = (1 << 1),
213 };
214 
216  SecFlagInvalid = 0,
217  // Store function offsets in an order of contexts. The order ensures that
218  // callee contexts of a given context laid out next to it.
219  SecFlagOrdered = (1 << 0),
220 };
221 
222 // Verify section specific flag is used for the correct section.
223 template <class SecFlagType>
224 static inline void verifySecFlag(SecType Type, SecFlagType Flag) {
225  // No verification is needed for common flags.
226  if (std::is_same<SecCommonFlags, SecFlagType>())
227  return;
228 
229  // Verification starts here for section specific flag.
230  bool IsFlagLegal = false;
231  switch (Type) {
232  case SecNameTable:
233  IsFlagLegal = std::is_same<SecNameTableFlags, SecFlagType>();
234  break;
235  case SecProfSummary:
236  IsFlagLegal = std::is_same<SecProfSummaryFlags, SecFlagType>();
237  break;
238  case SecFuncMetadata:
239  IsFlagLegal = std::is_same<SecFuncMetadataFlags, SecFlagType>();
240  break;
241  default:
242  case SecFuncOffsetTable:
243  IsFlagLegal = std::is_same<SecFuncOffsetFlags, SecFlagType>();
244  break;
245  }
246  if (!IsFlagLegal)
247  llvm_unreachable("Misuse of a flag in an incompatible section");
248 }
249 
250 template <class SecFlagType>
251 static inline void addSecFlag(SecHdrTableEntry &Entry, SecFlagType Flag) {
252  verifySecFlag(Entry.Type, Flag);
253  auto FVal = static_cast<uint64_t>(Flag);
254  bool IsCommon = std::is_same<SecCommonFlags, SecFlagType>();
255  Entry.Flags |= IsCommon ? FVal : (FVal << 32);
256 }
257 
258 template <class SecFlagType>
259 static inline void removeSecFlag(SecHdrTableEntry &Entry, SecFlagType Flag) {
260  verifySecFlag(Entry.Type, Flag);
261  auto FVal = static_cast<uint64_t>(Flag);
262  bool IsCommon = std::is_same<SecCommonFlags, SecFlagType>();
263  Entry.Flags &= ~(IsCommon ? FVal : (FVal << 32));
264 }
265 
266 template <class SecFlagType>
267 static inline bool hasSecFlag(const SecHdrTableEntry &Entry, SecFlagType Flag) {
268  verifySecFlag(Entry.Type, Flag);
269  auto FVal = static_cast<uint64_t>(Flag);
270  bool IsCommon = std::is_same<SecCommonFlags, SecFlagType>();
271  return Entry.Flags & (IsCommon ? FVal : (FVal << 32));
272 }
273 
274 /// Represents the relative location of an instruction.
275 ///
276 /// Instruction locations are specified by the line offset from the
277 /// beginning of the function (marked by the line where the function
278 /// header is) and the discriminator value within that line.
279 ///
280 /// The discriminator value is useful to distinguish instructions
281 /// that are on the same line but belong to different basic blocks
282 /// (e.g., the two post-increment instructions in "if (p) x++; else y++;").
283 struct LineLocation {
285 
286  void print(raw_ostream &OS) const;
287  void dump() const;
288 
289  bool operator<(const LineLocation &O) const {
290  return LineOffset < O.LineOffset ||
291  (LineOffset == O.LineOffset && Discriminator < O.Discriminator);
292  }
293 
294  bool operator==(const LineLocation &O) const {
295  return LineOffset == O.LineOffset && Discriminator == O.Discriminator;
296  }
297 
298  bool operator!=(const LineLocation &O) const {
299  return LineOffset != O.LineOffset || Discriminator != O.Discriminator;
300  }
301 
304 };
305 
307 
308 /// Representation of a single sample record.
309 ///
310 /// A sample record is represented by a positive integer value, which
311 /// indicates how frequently was the associated line location executed.
312 ///
313 /// Additionally, if the associated location contains a function call,
314 /// the record will hold a list of all the possible called targets. For
315 /// direct calls, this will be the exact function being invoked. For
316 /// indirect calls (function pointers, virtual table dispatch), this
317 /// will be a list of one or more functions.
319 public:
320  using CallTarget = std::pair<StringRef, uint64_t>;
322  bool operator()(const CallTarget &LHS, const CallTarget &RHS) const {
323  if (LHS.second != RHS.second)
324  return LHS.second > RHS.second;
325 
326  return LHS.first < RHS.first;
327  }
328  };
329 
330  using SortedCallTargetSet = std::set<CallTarget, CallTargetComparator>;
332  SampleRecord() = default;
333 
334  /// Increment the number of samples for this record by \p S.
335  /// Optionally scale sample count \p S by \p Weight.
336  ///
337  /// Sample counts accumulate using saturating arithmetic, to avoid wrapping
338  /// around unsigned integers.
340  bool Overflowed;
341  NumSamples = SaturatingMultiplyAdd(S, Weight, NumSamples, &Overflowed);
342  return Overflowed ? sampleprof_error::counter_overflow
344  }
345 
346  /// Add called function \p F with samples \p S.
347  /// Optionally scale sample count \p S by \p Weight.
348  ///
349  /// Sample counts accumulate using saturating arithmetic, to avoid wrapping
350  /// around unsigned integers.
352  uint64_t Weight = 1) {
353  uint64_t &TargetSamples = CallTargets[F];
354  bool Overflowed;
355  TargetSamples =
356  SaturatingMultiplyAdd(S, Weight, TargetSamples, &Overflowed);
357  return Overflowed ? sampleprof_error::counter_overflow
359  }
360 
361  /// Return true if this sample record contains function calls.
362  bool hasCalls() const { return !CallTargets.empty(); }
363 
364  uint64_t getSamples() const { return NumSamples; }
365  const CallTargetMap &getCallTargets() const { return CallTargets; }
367  return SortCallTargets(CallTargets);
368  }
369 
370  /// Sort call targets in descending order of call frequency.
371  static const SortedCallTargetSet SortCallTargets(const CallTargetMap &Targets) {
372  SortedCallTargetSet SortedTargets;
373  for (const auto &I : Targets) {
374  SortedTargets.emplace(I.first(), I.second);
375  }
376  return SortedTargets;
377  }
378 
379  /// Prorate call targets by a distribution factor.
380  static const CallTargetMap adjustCallTargets(const CallTargetMap &Targets,
381  float DistributionFactor) {
382  CallTargetMap AdjustedTargets;
383  for (const auto &I : Targets) {
384  AdjustedTargets[I.first()] = I.second * DistributionFactor;
385  }
386  return AdjustedTargets;
387  }
388 
389  /// Merge the samples in \p Other into this record.
390  /// Optionally scale sample counts by \p Weight.
391  sampleprof_error merge(const SampleRecord &Other, uint64_t Weight = 1);
392  void print(raw_ostream &OS, unsigned Indent) const;
393  void dump() const;
394 
395 private:
396  uint64_t NumSamples = 0;
397  CallTargetMap CallTargets;
398 };
399 
400 raw_ostream &operator<<(raw_ostream &OS, const SampleRecord &Sample);
401 
402 // State of context associated with FunctionSamples
404  UnknownContext = 0x0, // Profile without context
405  RawContext = 0x1, // Full context profile from input profile
406  SyntheticContext = 0x2, // Synthetic context created for context promotion
407  InlinedContext = 0x4, // Profile for context that is inlined into caller
408  MergedContext = 0x8 // Profile for context merged into base profile
409 };
410 
411 // Attribute of context associated with FunctionSamples
413  ContextNone = 0x0,
414  ContextWasInlined = 0x1, // Leaf of context was inlined in previous build
415  ContextShouldBeInlined = 0x2, // Leaf of context should be inlined
416 };
417 
418 // Represents a context frame with function name and line location
422 
424 
427 
428  bool operator==(const SampleContextFrame &That) const {
429  return Location == That.Location && FuncName == That.FuncName;
430  }
431 
432  bool operator!=(const SampleContextFrame &That) const {
433  return !(*this == That);
434  }
435 
436  std::string toString(bool OutputLineLocation) const {
437  std::ostringstream OContextStr;
438  OContextStr << FuncName.str();
439  if (OutputLineLocation) {
440  OContextStr << ":" << Location.LineOffset;
442  OContextStr << "." << Location.Discriminator;
443  }
444  return OContextStr.str();
445  }
446 };
447 
448 static inline hash_code hash_value(const SampleContextFrame &arg) {
449  return hash_combine(arg.FuncName, arg.Location.LineOffset,
450  arg.Location.Discriminator);
451 }
452 
455 
458  return hash_combine_range(S.begin(), S.end());
459  }
460 };
461 
462 // Sample context for FunctionSamples. It consists of the calling context,
463 // the function name and context state. Internally sample context is represented
464 // using ArrayRef, which is also the input for constructing a `SampleContext`.
465 // It can accept and represent both full context string as well as context-less
466 // function name.
467 // For a CS profile, a full context vector can look like:
468 // `main:3 _Z5funcAi:1 _Z8funcLeafi`
469 // For a base CS profile without calling context, the context vector should only
470 // contain the leaf frame name.
471 // For a non-CS profile, the context vector should be empty.
473 public:
474  SampleContext() : State(UnknownContext), Attributes(ContextNone) {}
475 
477  : Name(Name), State(UnknownContext), Attributes(ContextNone) {}
478 
480  ContextStateMask CState = RawContext)
481  : Attributes(ContextNone) {
482  assert(!Context.empty() && "Context is empty");
483  setContext(Context, CState);
484  }
485 
486  // Give a context string, decode and populate internal states like
487  // Function name, Calling context and context state. Example of input
488  // `ContextStr`: `[main:3 @ _Z5funcAi:1 @ _Z8funcLeafi]`
490  std::list<SampleContextFrameVector> &CSNameTable,
491  ContextStateMask CState = RawContext)
492  : Attributes(ContextNone) {
493  assert(!ContextStr.empty());
494  // Note that `[]` wrapped input indicates a full context string, otherwise
495  // it's treated as context-less function name only.
496  bool HasContext = ContextStr.startswith("[");
497  if (!HasContext) {
498  State = UnknownContext;
499  Name = ContextStr;
500  } else {
501  CSNameTable.emplace_back();
502  SampleContextFrameVector &Context = CSNameTable.back();
503  createCtxVectorFromStr(ContextStr, Context);
504  setContext(Context, CState);
505  }
506  }
507 
508  /// Create a context vector from a given context string and save it in
509  /// `Context`.
510  static void createCtxVectorFromStr(StringRef ContextStr,
512  // Remove encapsulating '[' and ']' if any
513  ContextStr = ContextStr.substr(1, ContextStr.size() - 2);
514  StringRef ContextRemain = ContextStr;
515  StringRef ChildContext;
516  StringRef CalleeName;
517  while (!ContextRemain.empty()) {
518  auto ContextSplit = ContextRemain.split(" @ ");
519  ChildContext = ContextSplit.first;
520  ContextRemain = ContextSplit.second;
521  LineLocation CallSiteLoc(0, 0);
522  decodeContextString(ChildContext, CalleeName, CallSiteLoc);
523  Context.emplace_back(CalleeName, CallSiteLoc);
524  }
525  }
526 
527  // Promote context by removing top frames with the length of
528  // `ContextFramesToRemove`. Note that with array representation of context,
529  // the promotion is effectively a slice operation with first
530  // `ContextFramesToRemove` elements removed from left.
531  void promoteOnPath(uint32_t ContextFramesToRemove) {
532  assert(ContextFramesToRemove <= FullContext.size() &&
533  "Cannot remove more than the whole context");
534  FullContext = FullContext.drop_front(ContextFramesToRemove);
535  }
536 
537  // Decode context string for a frame to get function name and location.
538  // `ContextStr` is in the form of `FuncName:StartLine.Discriminator`.
539  static void decodeContextString(StringRef ContextStr, StringRef &FName,
540  LineLocation &LineLoc) {
541  // Get function name
542  auto EntrySplit = ContextStr.split(':');
543  FName = EntrySplit.first;
544 
545  LineLoc = {0, 0};
546  if (!EntrySplit.second.empty()) {
547  // Get line offset, use signed int for getAsInteger so string will
548  // be parsed as signed.
549  int LineOffset = 0;
550  auto LocSplit = EntrySplit.second.split('.');
551  LocSplit.first.getAsInteger(10, LineOffset);
552  LineLoc.LineOffset = LineOffset;
553 
554  // Get discriminator
555  if (!LocSplit.second.empty())
556  LocSplit.second.getAsInteger(10, LineLoc.Discriminator);
557  }
558  }
559 
560  operator SampleContextFrames() const { return FullContext; }
561  bool hasAttribute(ContextAttributeMask A) { return Attributes & (uint32_t)A; }
562  void setAttribute(ContextAttributeMask A) { Attributes |= (uint32_t)A; }
563  uint32_t getAllAttributes() { return Attributes; }
564  void setAllAttributes(uint32_t A) { Attributes = A; }
565  bool hasState(ContextStateMask S) { return State & (uint32_t)S; }
566  void setState(ContextStateMask S) { State |= (uint32_t)S; }
567  void clearState(ContextStateMask S) { State &= (uint32_t)~S; }
568  bool hasContext() const { return State != UnknownContext; }
569  bool isBaseContext() const { return FullContext.size() == 1; }
570  StringRef getName() const { return Name; }
571  SampleContextFrames getContextFrames() const { return FullContext; }
572 
574  bool IncludeLeafLineLocation = false) {
575  std::ostringstream OContextStr;
576  for (uint32_t I = 0; I < Context.size(); I++) {
577  if (OContextStr.str().size()) {
578  OContextStr << " @ ";
579  }
580  OContextStr << Context[I].toString(I != Context.size() - 1 ||
581  IncludeLeafLineLocation);
582  }
583  return OContextStr.str();
584  }
585 
586  std::string toString() const {
587  if (!hasContext())
588  return Name.str();
589  return getContextString(FullContext, false);
590  }
591 
594  : hash_value(getName());
595  }
596 
597  /// Set the name of the function and clear the current context.
598  void setName(StringRef FunctionName) {
599  Name = FunctionName;
600  FullContext = SampleContextFrames();
601  State = UnknownContext;
602  }
603 
605  ContextStateMask CState = RawContext) {
606  assert(CState != UnknownContext);
607  FullContext = Context;
608  Name = Context.back().FuncName;
609  State = CState;
610  }
611 
612  bool operator==(const SampleContext &That) const {
613  return State == That.State && Name == That.Name &&
614  FullContext == That.FullContext;
615  }
616 
617  bool operator!=(const SampleContext &That) const { return !(*this == That); }
618 
619  bool operator<(const SampleContext &That) const {
620  if (State != That.State)
621  return State < That.State;
622 
623  if (!hasContext()) {
624  return (Name.compare(That.Name)) == -1;
625  }
626 
627  uint64_t I = 0;
628  while (I < std::min(FullContext.size(), That.FullContext.size())) {
629  auto &Context1 = FullContext[I];
630  auto &Context2 = That.FullContext[I];
631  auto V = Context1.FuncName.compare(Context2.FuncName);
632  if (V)
633  return V == -1;
634  if (Context1.Location != Context2.Location)
635  return Context1.Location < Context2.Location;
636  I++;
637  }
638 
639  return FullContext.size() < That.FullContext.size();
640  }
641 
642  struct Hash {
644  return Context.getHashCode();
645  }
646  };
647 
648  bool IsPrefixOf(const SampleContext &That) const {
649  auto ThisContext = FullContext;
650  auto ThatContext = That.FullContext;
651  if (ThatContext.size() < ThisContext.size())
652  return false;
653  ThatContext = ThatContext.take_front(ThisContext.size());
654  // Compare Leaf frame first
655  if (ThisContext.back().FuncName != ThatContext.back().FuncName)
656  return false;
657  // Compare leading context
658  return ThisContext.drop_back() == ThatContext.drop_back();
659  }
660 
661 private:
662  /// Mangled name of the function.
663  StringRef Name;
664  // Full context including calling context and leaf function name
665  SampleContextFrames FullContext;
666  // State of the associated sample profile
667  uint32_t State;
668  // Attribute of the associated sample profile
669  uint32_t Attributes;
670 };
671 
672 static inline hash_code hash_value(const SampleContext &arg) {
673  return arg.hasContext() ? hash_value(arg.getContextFrames())
674  : hash_value(arg.getName());
675 }
676 
677 class FunctionSamples;
679 
680 using BodySampleMap = std::map<LineLocation, SampleRecord>;
681 // NOTE: Using a StringMap here makes parsed profiles consume around 17% more
682 // memory, which is *very* significant for large profiles.
683 using FunctionSamplesMap = std::map<std::string, FunctionSamples, std::less<>>;
684 using CallsiteSampleMap = std::map<LineLocation, FunctionSamplesMap>;
685 
686 /// Representation of the samples collected for a function.
687 ///
688 /// This data structure contains all the collected samples for the body
689 /// of a function. Each sample corresponds to a LineLocation instance
690 /// within the body of the function.
692 public:
693  FunctionSamples() = default;
694 
695  void print(raw_ostream &OS = dbgs(), unsigned Indent = 0) const;
696  void dump() const;
697 
699  bool Overflowed;
700  TotalSamples =
701  SaturatingMultiplyAdd(Num, Weight, TotalSamples, &Overflowed);
702  return Overflowed ? sampleprof_error::counter_overflow
704  }
705 
706  void setTotalSamples(uint64_t Num) { TotalSamples = Num; }
707 
709  bool Overflowed;
710  TotalHeadSamples =
711  SaturatingMultiplyAdd(Num, Weight, TotalHeadSamples, &Overflowed);
712  return Overflowed ? sampleprof_error::counter_overflow
714  }
715 
717  uint64_t Num, uint64_t Weight = 1) {
718  return BodySamples[LineLocation(LineOffset, Discriminator)].addSamples(
719  Num, Weight);
720  }
721 
723  uint32_t Discriminator,
724  StringRef FName, uint64_t Num,
725  uint64_t Weight = 1) {
726  return BodySamples[LineLocation(LineOffset, Discriminator)].addCalledTarget(
727  FName, Num, Weight);
728  }
729 
731  uint64_t Weight = 1) {
732  SampleRecord S;
733  S.addSamples(Num, Weight);
734  return BodySamples[LineLocation(Index, 0)].merge(S, Weight);
735  }
736 
737  // Accumulate all body samples to set total samples.
739  setTotalSamples(0);
740  for (const auto &I : BodySamples)
741  addTotalSamples(I.second.getSamples());
742 
743  for (auto &I : CallsiteSamples) {
744  for (auto &CS : I.second) {
745  CS.second.updateTotalSamples();
746  addTotalSamples(CS.second.getTotalSamples());
747  }
748  }
749  }
750 
751  // Set current context and all callee contexts to be synthetic.
753  Context.setState(SyntheticContext);
754  for (auto &I : CallsiteSamples) {
755  for (auto &CS : I.second) {
756  CS.second.SetContextSynthetic();
757  }
758  }
759  }
760 
761  /// Return the number of samples collected at the given location.
762  /// Each location is specified by \p LineOffset and \p Discriminator.
763  /// If the location is not found in profile, return error.
765  uint32_t Discriminator) const {
766  const auto &ret = BodySamples.find(LineLocation(LineOffset, Discriminator));
767  if (ret == BodySamples.end())
768  return std::error_code();
769  return ret->second.getSamples();
770  }
771 
772  /// Returns the call target map collected at a given location.
773  /// Each location is specified by \p LineOffset and \p Discriminator.
774  /// If the location is not found in profile, return error.
776  findCallTargetMapAt(uint32_t LineOffset, uint32_t Discriminator) const {
777  const auto &ret = BodySamples.find(LineLocation(LineOffset, Discriminator));
778  if (ret == BodySamples.end())
779  return std::error_code();
780  return ret->second.getCallTargets();
781  }
782 
783  /// Returns the call target map collected at a given location specified by \p
784  /// CallSite. If the location is not found in profile, return error.
786  findCallTargetMapAt(const LineLocation &CallSite) const {
787  const auto &Ret = BodySamples.find(CallSite);
788  if (Ret == BodySamples.end())
789  return std::error_code();
790  return Ret->second.getCallTargets();
791  }
792 
793  /// Return the function samples at the given callsite location.
795  return CallsiteSamples[Loc];
796  }
797 
798  /// Returns the FunctionSamplesMap at the given \p Loc.
799  const FunctionSamplesMap *
801  auto iter = CallsiteSamples.find(Loc);
802  if (iter == CallsiteSamples.end())
803  return nullptr;
804  return &iter->second;
805  }
806 
807  /// Returns a pointer to FunctionSamples at the given callsite location
808  /// \p Loc with callee \p CalleeName. If no callsite can be found, relax
809  /// the restriction to return the FunctionSamples at callsite location
810  /// \p Loc with the maximum total sample count. If \p Remapper is not
811  /// nullptr, use \p Remapper to find FunctionSamples with equivalent name
812  /// as \p CalleeName.
813  const FunctionSamples *
814  findFunctionSamplesAt(const LineLocation &Loc, StringRef CalleeName,
815  SampleProfileReaderItaniumRemapper *Remapper) const;
816 
817  bool empty() const { return TotalSamples == 0; }
818 
819  /// Return the total number of samples collected inside the function.
820  uint64_t getTotalSamples() const { return TotalSamples; }
821 
822  /// Return the total number of branch samples that have the function as the
823  /// branch target. This should be equivalent to the sample of the first
824  /// instruction of the symbol. But as we directly get this info for raw
825  /// profile without referring to potentially inaccurate debug info, this
826  /// gives more accurate profile data and is preferred for standalone symbols.
827  uint64_t getHeadSamples() const { return TotalHeadSamples; }
828 
829  /// Return the sample count of the first instruction of the function.
830  /// The function can be either a standalone symbol or an inlined function.
833  // For CS profile, if we already have more accurate head samples
834  // counted by branch sample from caller, use them as entry samples.
835  return getHeadSamples();
836  }
837  uint64_t Count = 0;
838  // Use either BodySamples or CallsiteSamples which ever has the smaller
839  // lineno.
840  if (!BodySamples.empty() &&
841  (CallsiteSamples.empty() ||
842  BodySamples.begin()->first < CallsiteSamples.begin()->first))
843  Count = BodySamples.begin()->second.getSamples();
844  else if (!CallsiteSamples.empty()) {
845  // An indirect callsite may be promoted to several inlined direct calls.
846  // We need to get the sum of them.
847  for (const auto &N_FS : CallsiteSamples.begin()->second)
848  Count += N_FS.second.getEntrySamples();
849  }
850  // Return at least 1 if total sample is not 0.
851  return Count ? Count : TotalSamples > 0;
852  }
853 
854  /// Return all the samples collected in the body of the function.
855  const BodySampleMap &getBodySamples() const { return BodySamples; }
856 
857  /// Return all the callsite samples collected in the body of the function.
859  return CallsiteSamples;
860  }
861 
862  /// Return the maximum of sample counts in a function body including functions
863  /// inlined in it.
865  uint64_t MaxCount = 0;
866  for (const auto &L : getBodySamples())
867  MaxCount = std::max(MaxCount, L.second.getSamples());
868  for (const auto &C : getCallsiteSamples())
869  for (const FunctionSamplesMap::value_type &F : C.second)
870  MaxCount = std::max(MaxCount, F.second.getMaxCountInside());
871  return MaxCount;
872  }
873 
874  /// Merge the samples in \p Other into this one.
875  /// Optionally scale samples by \p Weight.
876  sampleprof_error merge(const FunctionSamples &Other, uint64_t Weight = 1) {
878  if (!GUIDToFuncNameMap)
879  GUIDToFuncNameMap = Other.GUIDToFuncNameMap;
880  if (Context.getName().empty())
881  Context = Other.getContext();
882  if (FunctionHash == 0) {
883  // Set the function hash code for the target profile.
884  FunctionHash = Other.getFunctionHash();
885  } else if (FunctionHash != Other.getFunctionHash()) {
886  // The two profiles coming with different valid hash codes indicates
887  // either:
888  // 1. They are same-named static functions from different compilation
889  // units (without using -unique-internal-linkage-names), or
890  // 2. They are really the same function but from different compilations.
891  // Let's bail out in either case for now, which means one profile is
892  // dropped.
894  }
895 
896  MergeResult(Result, addTotalSamples(Other.getTotalSamples(), Weight));
897  MergeResult(Result, addHeadSamples(Other.getHeadSamples(), Weight));
898  for (const auto &I : Other.getBodySamples()) {
899  const LineLocation &Loc = I.first;
900  const SampleRecord &Rec = I.second;
901  MergeResult(Result, BodySamples[Loc].merge(Rec, Weight));
902  }
903  for (const auto &I : Other.getCallsiteSamples()) {
904  const LineLocation &Loc = I.first;
906  for (const auto &Rec : I.second)
907  MergeResult(Result, FSMap[Rec.first].merge(Rec.second, Weight));
908  }
909  return Result;
910  }
911 
912  /// Recursively traverses all children, if the total sample count of the
913  /// corresponding function is no less than \p Threshold, add its corresponding
914  /// GUID to \p S. Also traverse the BodySamples to add hot CallTarget's GUID
915  /// to \p S.
918  uint64_t Threshold) const {
919  if (TotalSamples <= Threshold)
920  return;
921  auto isDeclaration = [](const Function *F) {
922  return !F || F->isDeclaration();
923  };
924  if (isDeclaration(SymbolMap.lookup(getFuncName()))) {
925  // Add to the import list only when it's defined out of module.
926  S.insert(getGUID(getName()));
927  }
928  // Import hot CallTargets, which may not be available in IR because full
929  // profile annotation cannot be done until backend compilation in ThinLTO.
930  for (const auto &BS : BodySamples)
931  for (const auto &TS : BS.second.getCallTargets())
932  if (TS.getValue() > Threshold) {
933  const Function *Callee = SymbolMap.lookup(getFuncName(TS.getKey()));
934  if (isDeclaration(Callee))
935  S.insert(getGUID(TS.getKey()));
936  }
937  for (const auto &CS : CallsiteSamples)
938  for (const auto &NameFS : CS.second)
939  NameFS.second.findInlinedFunctions(S, SymbolMap, Threshold);
940  }
941 
942  /// Set the name of the function.
943  void setName(StringRef FunctionName) { Context.setName(FunctionName); }
944 
945  /// Return the function name.
946  StringRef getName() const { return Context.getName(); }
947 
948  /// Return the original function name.
949  StringRef getFuncName() const { return getFuncName(getName()); }
950 
951  void setFunctionHash(uint64_t Hash) { FunctionHash = Hash; }
952 
953  uint64_t getFunctionHash() const { return FunctionHash; }
954 
955  /// Return the canonical name for a function, taking into account
956  /// suffix elision policy attributes.
958  auto AttrName = "sample-profile-suffix-elision-policy";
959  auto Attr = F.getFnAttribute(AttrName).getValueAsString();
960  return getCanonicalFnName(F.getName(), Attr);
961  }
962 
963  /// Name suffixes which canonicalization should handle to avoid
964  /// profile mismatch.
965  static constexpr const char *LLVMSuffix = ".llvm.";
966  static constexpr const char *PartSuffix = ".part.";
967  static constexpr const char *UniqSuffix = ".__uniq.";
968 
970  StringRef Attr = "selected") {
971  // Note the sequence of the suffixes in the knownSuffixes array matters.
972  // If suffix "A" is appended after the suffix "B", "A" should be in front
973  // of "B" in knownSuffixes.
974  const char *knownSuffixes[] = {LLVMSuffix, PartSuffix, UniqSuffix};
975  if (Attr == "" || Attr == "all") {
976  return FnName.split('.').first;
977  } else if (Attr == "selected") {
978  StringRef Cand(FnName);
979  for (const auto &Suf : knownSuffixes) {
980  StringRef Suffix(Suf);
981  // If the profile contains ".__uniq." suffix, don't strip the
982  // suffix for names in the IR.
984  continue;
985  auto It = Cand.rfind(Suffix);
986  if (It == StringRef::npos)
987  continue;
988  auto Dit = Cand.rfind('.');
989  if (Dit == It + Suffix.size() - 1)
990  Cand = Cand.substr(0, It);
991  }
992  return Cand;
993  } else if (Attr == "none") {
994  return FnName;
995  } else {
996  assert(false && "internal error: unknown suffix elision policy");
997  }
998  return FnName;
999  }
1000 
1001  /// Translate \p Name into its original name.
1002  /// When profile doesn't use MD5, \p Name needs no translation.
1003  /// When profile uses MD5, \p Name in current FunctionSamples
1004  /// is actually GUID of the original function name. getFuncName will
1005  /// translate \p Name in current FunctionSamples into its original name
1006  /// by looking up in the function map GUIDToFuncNameMap.
1007  /// If the original name doesn't exist in the map, return empty StringRef.
1009  if (!UseMD5)
1010  return Name;
1011 
1012  assert(GUIDToFuncNameMap && "GUIDToFuncNameMap needs to be populated first");
1013  return GUIDToFuncNameMap->lookup(std::stoull(Name.data()));
1014  }
1015 
1016  /// Returns the line offset to the start line of the subprogram.
1017  /// We assume that a single function will not exceed 65535 LOC.
1018  static unsigned getOffset(const DILocation *DIL);
1019 
1020  /// Returns a unique call site identifier for a given debug location of a call
1021  /// instruction. This is wrapper of two scenarios, the probe-based profile and
1022  /// regular profile, to hide implementation details from the sample loader and
1023  /// the context tracker.
1024  static LineLocation getCallSiteIdentifier(const DILocation *DIL,
1025  bool ProfileIsFS = false);
1026 
1027  /// Returns a unique hash code for a combination of a callsite location and
1028  /// the callee function name.
1029  static uint64_t getCallSiteHash(StringRef CalleeName,
1030  const LineLocation &Callsite);
1031 
1032  /// Get the FunctionSamples of the inline instance where DIL originates
1033  /// from.
1034  ///
1035  /// The FunctionSamples of the instruction (Machine or IR) associated to
1036  /// \p DIL is the inlined instance in which that instruction is coming from.
1037  /// We traverse the inline stack of that instruction, and match it with the
1038  /// tree nodes in the profile.
1039  ///
1040  /// \returns the FunctionSamples pointer to the inlined instance.
1041  /// If \p Remapper is not nullptr, it will be used to find matching
1042  /// FunctionSamples with not exactly the same but equivalent name.
1044  const DILocation *DIL,
1045  SampleProfileReaderItaniumRemapper *Remapper = nullptr) const;
1046 
1047  static bool ProfileIsProbeBased;
1048 
1049  static bool ProfileIsCSFlat;
1050 
1051  static bool ProfileIsCSNested;
1052 
1053  SampleContext &getContext() const { return Context; }
1054 
1055  void setContext(const SampleContext &FContext) { Context = FContext; }
1056 
1058 
1059  /// Whether the profile uses MD5 to represent string.
1060  static bool UseMD5;
1061 
1062  /// Whether the profile contains any ".__uniq." suffix in a name.
1063  static bool HasUniqSuffix;
1064 
1065  /// If this profile uses flow sensitive discriminators.
1066  static bool ProfileIsFS;
1067 
1068  /// GUIDToFuncNameMap saves the mapping from GUID to the symbol name, for
1069  /// all the function symbols defined or declared in current module.
1071 
1072  // Assume the input \p Name is a name coming from FunctionSamples itself.
1073  // If UseMD5 is true, the name is already a GUID and we
1074  // don't want to return the GUID of GUID.
1076  return UseMD5 ? std::stoull(Name.data()) : Function::getGUID(Name);
1077  }
1078 
1079  // Find all the names in the current FunctionSamples including names in
1080  // all the inline instances and names of call targets.
1081  void findAllNames(DenseSet<StringRef> &NameSet) const;
1082 
1083 private:
1084  /// CFG hash value for the function.
1085  uint64_t FunctionHash = 0;
1086 
1087  /// Calling context for function profile
1088  mutable SampleContext Context;
1089 
1090  /// Total number of samples collected inside this function.
1091  ///
1092  /// Samples are cumulative, they include all the samples collected
1093  /// inside this function and all its inlined callees.
1094  uint64_t TotalSamples = 0;
1095 
1096  /// Total number of samples collected at the head of the function.
1097  /// This is an approximation of the number of calls made to this function
1098  /// at runtime.
1099  uint64_t TotalHeadSamples = 0;
1100 
1101  /// Map instruction locations to collected samples.
1102  ///
1103  /// Each entry in this map contains the number of samples
1104  /// collected at the corresponding line offset. All line locations
1105  /// are an offset from the start of the function.
1106  BodySampleMap BodySamples;
1107 
1108  /// Map call sites to collected samples for the called function.
1109  ///
1110  /// Each entry in this map corresponds to all the samples
1111  /// collected for the inlined function call at the given
1112  /// location. For example, given:
1113  ///
1114  /// void foo() {
1115  /// 1 bar();
1116  /// ...
1117  /// 8 baz();
1118  /// }
1119  ///
1120  /// If the bar() and baz() calls were inlined inside foo(), this
1121  /// map will contain two entries. One for all the samples collected
1122  /// in the call to bar() at line offset 1, the other for all the samples
1123  /// collected in the call to baz() at line offset 8.
1124  CallsiteSampleMap CallsiteSamples;
1125 };
1126 
1128 
1129 using SampleProfileMap =
1130  std::unordered_map<SampleContext, FunctionSamples, SampleContext::Hash>;
1131 
1132 using NameFunctionSamples = std::pair<SampleContext, const FunctionSamples *>;
1133 
1134 void sortFuncProfiles(const SampleProfileMap &ProfileMap,
1135  std::vector<NameFunctionSamples> &SortedProfiles);
1136 
1137 /// Sort a LocationT->SampleT map by LocationT.
1138 ///
1139 /// It produces a sorted list of <LocationT, SampleT> records by ascending
1140 /// order of LocationT.
1141 template <class LocationT, class SampleT> class SampleSorter {
1142 public:
1143  using SamplesWithLoc = std::pair<const LocationT, SampleT>;
1145 
1146  SampleSorter(const std::map<LocationT, SampleT> &Samples) {
1147  for (const auto &I : Samples)
1148  V.push_back(&I);
1149  llvm::stable_sort(V, [](const SamplesWithLoc *A, const SamplesWithLoc *B) {
1150  return A->first < B->first;
1151  });
1152  }
1153 
1154  const SamplesWithLocList &get() const { return V; }
1155 
1156 private:
1158 };
1159 
1160 /// SampleContextTrimmer impelements helper functions to trim, merge cold
1161 /// context profiles. It also supports context profile canonicalization to make
1162 /// sure ProfileMap's key is consistent with FunctionSample's name/context.
1164 public:
1165  SampleContextTrimmer(SampleProfileMap &Profiles) : ProfileMap(Profiles){};
1166  // Trim and merge cold context profile when requested. TrimBaseProfileOnly
1167  // should only be effective when TrimColdContext is true. On top of
1168  // TrimColdContext, TrimBaseProfileOnly can be used to specify to trim all
1169  // cold profiles or only cold base profiles. Trimming base profiles only is
1170  // mainly to honor the preinliner decsion. Note that when MergeColdContext is
1171  // true, preinliner decsion is not honored anyway so TrimBaseProfileOnly will
1172  // be ignored.
1174  bool TrimColdContext,
1175  bool MergeColdContext,
1176  uint32_t ColdContextFrameLength,
1177  bool TrimBaseProfileOnly);
1178  // Canonicalize context profile name and attributes.
1180 
1181 private:
1182  SampleProfileMap &ProfileMap;
1183 };
1184 
1185 // CSProfileConverter converts a full context-sensitive flat sample profile into
1186 // a nested context-sensitive sample profile.
1188 public:
1190  void convertProfiles();
1191  struct FrameNode {
1193  FunctionSamples *FSamples = nullptr,
1194  LineLocation CallLoc = {0, 0})
1195  : FuncName(FName), FuncSamples(FSamples), CallSiteLoc(CallLoc){};
1196 
1197  // Map line+discriminator location to child frame
1198  std::map<uint64_t, FrameNode> AllChildFrames;
1199  // Function name for current frame
1201  // Function Samples for current frame
1203  // Callsite location in parent context
1205 
1206  FrameNode *getOrCreateChildFrame(const LineLocation &CallSite,
1207  StringRef CalleeName);
1208  };
1209 
1210 private:
1211  // Nest all children profiles into the profile of Node.
1213  FrameNode *getOrCreateContextPath(const SampleContext &Context);
1214 
1215  SampleProfileMap &ProfileMap;
1216  FrameNode RootFrame;
1217 };
1218 
1219 /// ProfileSymbolList records the list of function symbols shown up
1220 /// in the binary used to generate the profile. It is useful to
1221 /// to discriminate a function being so cold as not to shown up
1222 /// in the profile and a function newly added.
1224 public:
1225  /// copy indicates whether we need to copy the underlying memory
1226  /// for the input Name.
1227  void add(StringRef Name, bool copy = false) {
1228  if (!copy) {
1229  Syms.insert(Name);
1230  return;
1231  }
1232  Syms.insert(Name.copy(Allocator));
1233  }
1234 
1235  bool contains(StringRef Name) { return Syms.count(Name); }
1236 
1237  void merge(const ProfileSymbolList &List) {
1238  for (auto Sym : List.Syms)
1239  add(Sym, true);
1240  }
1241 
1242  unsigned size() { return Syms.size(); }
1243 
1244  void setToCompress(bool TC) { ToCompress = TC; }
1245  bool toCompress() { return ToCompress; }
1246 
1247  std::error_code read(const uint8_t *Data, uint64_t ListSize);
1248  std::error_code write(raw_ostream &OS);
1249  void dump(raw_ostream &OS = dbgs()) const;
1250 
1251 private:
1252  // Determine whether or not to compress the symbol list when
1253  // writing it into profile. The variable is unused when the symbol
1254  // list is read from an existing profile.
1255  bool ToCompress = false;
1256  DenseSet<StringRef> Syms;
1257  BumpPtrAllocator Allocator;
1258 };
1259 
1260 } // end namespace sampleprof
1261 
1262 using namespace sampleprof;
1263 // Provide DenseMapInfo for SampleContext.
1264 template <> struct DenseMapInfo<SampleContext> {
1265  static inline SampleContext getEmptyKey() { return SampleContext(); }
1266 
1267  static inline SampleContext getTombstoneKey() { return SampleContext("@"); }
1268 
1269  static unsigned getHashValue(const SampleContext &Val) {
1270  return Val.getHashCode();
1271  }
1272 
1273  static bool isEqual(const SampleContext &LHS, const SampleContext &RHS) {
1274  return LHS == RHS;
1275  }
1276 };
1277 } // end namespace llvm
1278 
1279 #endif // LLVM_PROFILEDATA_SAMPLEPROF_H
llvm::sampleprof::CSProfileConverter
Definition: SampleProf.h:1187
llvm::sampleprof::SampleRecord::getSamples
uint64_t getSamples() const
Definition: SampleProf.h:364
llvm::sampleprof_error::uncompress_failed
@ uncompress_failed
llvm::sampleprof::FunctionSamples::getBodySamples
const BodySampleMap & getBodySamples() const
Return all the samples collected in the body of the function.
Definition: SampleProf.h:855
llvm::StringRef::startswith
LLVM_NODISCARD bool startswith(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition: StringRef.h:285
llvm::ArrayRef::drop_back
ArrayRef< T > drop_back(size_t N=1) const
Drop the last N elements of the array.
Definition: ArrayRef.h:208
llvm::sampleprof::SecHdrTableEntry::Offset
uint64_t Offset
Definition: SampleProf.h:162
MathExtras.h
llvm::sampleprof::CSProfileConverter::FrameNode::FuncSamples
FunctionSamples * FuncSamples
Definition: SampleProf.h:1202
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AllocatorList.h:23
llvm::sampleprof::SecFuncMetadataFlags::SecFlagHasAttribute
@ SecFlagHasAttribute
llvm::sampleprof::BodySampleMap
std::map< LineLocation, SampleRecord > BodySampleMap
Definition: SampleProf.h:680
llvm::sampleprof::SecProfSummaryFlags::SecFlagFSDiscriminator
@ SecFlagFSDiscriminator
SecFlagFSDiscriminator means this profile uses flow-sensitive discriminators.
llvm::sampleprof::SampleSorter::get
const SamplesWithLocList & get() const
Definition: SampleProf.h:1154
llvm::sampleprof::SampleContext::decodeContextString
static void decodeContextString(StringRef ContextStr, StringRef &FName, LineLocation &LineLoc)
Definition: SampleProf.h:539
llvm::sampleprof::SampleContext::operator!=
bool operator!=(const SampleContext &That) const
Definition: SampleProf.h:617
llvm::sampleprof::FunctionSamples::ProfileIsProbeBased
static bool ProfileIsProbeBased
Definition: SampleProf.h:1047
llvm::sampleprof::hash_value
static hash_code hash_value(const SampleContextFrame &arg)
Definition: SampleProf.h:448
llvm::sampleprof::FunctionSamples::dump
void dump() const
Definition: SampleProf.cpp:330
llvm::sampleprof::RawContext
@ RawContext
Definition: SampleProf.h:405
llvm::sampleprof::LineLocation::dump
void dump() const
Definition: SampleProf.cpp:137
llvm::sampleprof::SampleRecord::CallTargetComparator::operator()
bool operator()(const CallTarget &LHS, const CallTarget &RHS) const
Definition: SampleProf.h:322
llvm::sampleprof::SampleContext::hasAttribute
bool hasAttribute(ContextAttributeMask A)
Definition: SampleProf.h:561
llvm::StringRef::rfind
LLVM_NODISCARD size_t rfind(char C, size_t From=npos) const
Search for the last character C in the string.
Definition: StringRef.h:374
llvm::Function
Definition: Function.h:62
llvm::DenseMapBase::lookup
ValueT lookup(const_arg_type_t< KeyT > Val) const
lookup - Return the entry for the specified key, or a default constructed value if no such entry exis...
Definition: DenseMap.h:197
StringRef.h
llvm::sampleprof::SecHdrTableEntry
Definition: SampleProf.h:159
llvm::sampleprof::CallsiteSampleMap
std::map< LineLocation, FunctionSamplesMap > CallsiteSampleMap
Definition: SampleProf.h:684
llvm::sampleprof::LineLocation::LineLocation
LineLocation(uint32_t L, uint32_t D)
Definition: SampleProf.h:284
llvm::sampleprof::SampleSorter::SamplesWithLocList
SmallVector< const SamplesWithLoc *, 20 > SamplesWithLocList
Definition: SampleProf.h:1144
llvm::sampleprof::SampleRecord::hasCalls
bool hasCalls() const
Return true if this sample record contains function calls.
Definition: SampleProf.h:362
llvm::sampleprof_error::hash_mismatch
@ hash_mismatch
llvm::sampleprof::SecNameTableFlags::SecFlagFixedLengthMD5
@ SecFlagFixedLengthMD5
llvm::StringRef::npos
static constexpr size_t npos
Definition: StringRef.h:59
llvm::sampleprof::FunctionSamples::getFuncName
StringRef getFuncName(StringRef Name) const
Translate Name into its original name.
Definition: SampleProf.h:1008
llvm::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1177
llvm::sampleprof::NameFunctionSamples
std::pair< SampleContext, const FunctionSamples * > NameFunctionSamples
Definition: SampleProf.h:1132
llvm::sampleprof::ProfileSymbolList::size
unsigned size()
Definition: SampleProf.h:1242
llvm::sampleprof::SampleContext::setContext
void setContext(SampleContextFrames Context, ContextStateMask CState=RawContext)
Definition: SampleProf.h:604
llvm::sampleprof::SampleContext::SampleContext
SampleContext(SampleContextFrames Context, ContextStateMask CState=RawContext)
Definition: SampleProf.h:479
llvm::sampleprof::SampleContextFrame::toString
std::string toString(bool OutputLineLocation) const
Definition: SampleProf.h:436
llvm::sampleprof::SecProfSummaryFlags::SecFlagFullContext
@ SecFlagFullContext
SecFlagContext means this is context-sensitive flat profile for CSSPGO.
Allocator.h
llvm::sampleprof::SampleContext::toString
std::string toString() const
Definition: SampleProf.h:586
llvm::sampleprof_error::unsupported_version
@ unsupported_version
llvm::sampleprof::SampleProfileMap
std::unordered_map< SampleContext, FunctionSamples, SampleContext::Hash > SampleProfileMap
Definition: SampleProf.h:1130
llvm::sampleprof::SampleContext::operator==
bool operator==(const SampleContext &That) const
Definition: SampleProf.h:612
llvm::sampleprof::hasSecFlag
static bool hasSecFlag(const SecHdrTableEntry &Entry, SecFlagType Flag)
Definition: SampleProf.h:267
llvm::DILocation
Debug location.
Definition: DebugInfoMetadata.h:1580
llvm::sampleprof::LineLocation::operator<
bool operator<(const LineLocation &O) const
Definition: SampleProf.h:289
llvm::sampleprof::SPF_GCC
@ SPF_GCC
Definition: SampleProf.h:94
llvm::sampleprof::ContextShouldBeInlined
@ ContextShouldBeInlined
Definition: SampleProf.h:415
llvm::Type
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
Module.h
llvm::sampleprof::SecFuncOffsetTable
@ SecFuncOffsetTable
Definition: SampleProf.h:126
llvm::sampleprof::addSecFlag
static void addSecFlag(SecHdrTableEntry &Entry, SecFlagType Flag)
Definition: SampleProf.h:251
llvm::copy
OutputIt copy(R &&Range, OutputIt Out)
Definition: STLExtras.h:1700
llvm::sampleprof_error::not_implemented
@ not_implemented
FMAInstKind::Accumulator
@ Accumulator
llvm::sampleprof::SecCommonFlags::SecFlagCompress
@ SecFlagCompress
ret
to esp esp setne al movzbw ax esp setg cl movzbw cx cmove cx cl jne LBB1_2 esp ret(also really horrible code on ppc). This is due to the expand code for 64-bit compares. GCC produces multiple branches
llvm::sampleprof::SampleContext::getAllAttributes
uint32_t getAllAttributes()
Definition: SampleProf.h:563
llvm::sampleprof::SecNameTableFlags::SecFlagMD5Name
@ SecFlagMD5Name
llvm::sampleprof::FunctionSamples::findInlinedFunctions
void findInlinedFunctions(DenseSet< GlobalValue::GUID > &S, const StringMap< Function * > &SymbolMap, uint64_t Threshold) const
Recursively traverses all children, if the total sample count of the corresponding function is no les...
Definition: SampleProf.h:916
llvm::MipsISD::Ret
@ Ret
Definition: MipsISelLowering.h:116
llvm::sampleprof::SampleRecord::SampleRecord
SampleRecord()=default
llvm::sampleprof::FunctionSamples::findAllNames
void findAllNames(DenseSet< StringRef > &NameSet) const
Definition: SampleProf.cpp:279
llvm::sampleprof::FunctionSamples::getName
StringRef getName() const
Return the function name.
Definition: SampleProf.h:946
llvm::sampleprof::FunctionSamplesMap
std::map< std::string, FunctionSamples, std::less<> > FunctionSamplesMap
Definition: SampleProf.h:683
RHS
Value * RHS
Definition: X86PartialReduction.cpp:74
llvm::sampleprof::MergedContext
@ MergedContext
Definition: SampleProf.h:408
llvm::sampleprof::SPF_None
@ SPF_None
Definition: SampleProf.h:91
llvm::sampleprof::CSProfileConverter::FrameNode::getOrCreateChildFrame
FrameNode * getOrCreateChildFrame(const LineLocation &CallSite, StringRef CalleeName)
Definition: SampleProf.cpp:472
llvm::sampleprof::FunctionSamples::getCanonicalFnName
static StringRef getCanonicalFnName(StringRef FnName, StringRef Attr="selected")
Definition: SampleProf.h:969
llvm::sampleprof::SecHdrTableEntry::Size
uint64_t Size
Definition: SampleProf.h:163
llvm::sampleprof::SPF_Binary
@ SPF_Binary
Definition: SampleProf.h:96
llvm::sampleprof::LineLocation::Discriminator
uint32_t Discriminator
Definition: SampleProf.h:303
F
#define F(x, y, z)
Definition: MD5.cpp:55
llvm::sampleprof_error::counter_overflow
@ counter_overflow
llvm::sampleprof::LineLocation::LineOffset
uint32_t LineOffset
Definition: SampleProf.h:302
Context
ManagedStatic< detail::RecordContext > Context
Definition: Record.cpp:96
llvm::sampleprof::FunctionSamples::SetContextSynthetic
void SetContextSynthetic()
Definition: SampleProf.h:752
llvm::dbgs
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:163
llvm::DenseMapInfo< SampleContext >::isEqual
static bool isEqual(const SampleContext &LHS, const SampleContext &RHS)
Definition: SampleProf.h:1273
llvm::StringRef::substr
LLVM_NODISCARD StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:610
llvm::sampleprof::FunctionSamples::HasUniqSuffix
static bool HasUniqSuffix
Whether the profile contains any ".__uniq." suffix in a name.
Definition: SampleProf.h:1063
llvm::sampleprof::removeSecFlag
static void removeSecFlag(SecHdrTableEntry &Entry, SecFlagType Flag)
Definition: SampleProf.h:259
llvm::sampleprof::ProfileSymbolList::setToCompress
void setToCompress(bool TC)
Definition: SampleProf.h:1244
LHS
Value * LHS
Definition: X86PartialReduction.cpp:73
llvm::sampleprof::SecFuncMetadataFlags::SecFlagIsProbeBased
@ SecFlagIsProbeBased
llvm::DenseMapInfo
An information struct used to provide DenseMap with the various necessary components for a given valu...
Definition: APInt.h:34
llvm::sampleprof::FunctionSamples::getFuncName
StringRef getFuncName() const
Return the original function name.
Definition: SampleProf.h:949
GlobalValue.h
llvm::sampleprof_error::unsupported_writing_format
@ unsupported_writing_format
llvm::sampleprof::SampleProfileFormat
SampleProfileFormat
Definition: SampleProf.h:90
llvm::sampleprof::getRepInFormat
static StringRef getRepInFormat(StringRef Name, bool UseMD5, std::string &GUIDBuf)
Get the proper representation of a string according to whether the current Format uses MD5 to represe...
Definition: SampleProf.h:108
llvm::sampleprof::FunctionSamples::PartSuffix
static constexpr const char * PartSuffix
Definition: SampleProf.h:966
llvm::sampleprof::FunctionSamples::setTotalSamples
void setTotalSamples(uint64_t Num)
Definition: SampleProf.h:706
llvm::sampleprof::FunctionSamples::getTotalSamples
uint64_t getTotalSamples() const
Return the total number of samples collected inside the function.
Definition: SampleProf.h:820
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::sampleprof::SampleContextFrameHash
Definition: SampleProf.h:456
llvm::sampleprof::FunctionSamples::updateTotalSamples
void updateTotalSamples()
Definition: SampleProf.h:738
llvm::sampleprof::SampleContext::hasState
bool hasState(ContextStateMask S)
Definition: SampleProf.h:565
llvm::sampleprof::FunctionSamples::ProfileIsCSFlat
static bool ProfileIsCSFlat
Definition: SampleProf.h:1049
llvm::StringRef::split
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:748
llvm::sampleprof::SampleRecord::CallTarget
std::pair< StringRef, uint64_t > CallTarget
Definition: SampleProf.h:320
C
(vector float) vec_cmpeq(*A, *B) C
Definition: README_ALTIVEC.txt:86
llvm::sampleprof::SampleContext::Hash
Definition: SampleProf.h:642
llvm::sampleprof::CSProfileConverter::FrameNode
Definition: SampleProf.h:1191
llvm::sampleprof::SampleContext::getHashCode
uint64_t getHashCode() const
Definition: SampleProf.h:592
llvm::sampleprof::FunctionSamples::FunctionSamples
FunctionSamples()=default
llvm::sampleprof::SyntheticContext
@ SyntheticContext
Definition: SampleProf.h:406
llvm::sampleprof::SampleContextFrame::SampleContextFrame
SampleContextFrame()
Definition: SampleProf.h:423
llvm::sampleprof::SecProfSummaryFlags::SecFlagPartial
@ SecFlagPartial
SecFlagPartial means the profile is for common/shared code.
llvm::sampleprof::FunctionSamples::findCallTargetMapAt
ErrorOr< SampleRecord::CallTargetMap > findCallTargetMapAt(uint32_t LineOffset, uint32_t Discriminator) const
Returns the call target map collected at a given location.
Definition: SampleProf.h:776
llvm::sampleprof::SampleContext::createCtxVectorFromStr
static void createCtxVectorFromStr(StringRef ContextStr, SampleContextFrameVector &Context)
Create a context vector from a given context string and save it in Context.
Definition: SampleProf.h:510
DenseSet.h
llvm::orc::SymbolMap
DenseMap< SymbolStringPtr, JITEvaluatedSymbol > SymbolMap
A map from symbol names (as SymbolStringPtrs) to JITSymbols (address/flags pairs).
Definition: Core.h:113
llvm::sampleprof::FunctionSamples::getGUID
static uint64_t getGUID(StringRef Name)
Definition: SampleProf.h:1075
llvm::sampleprof::SampleContext::operator<
bool operator<(const SampleContext &That) const
Definition: SampleProf.h:619
B
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
llvm::sampleprof_category
const std::error_category & sampleprof_category()
Definition: SampleProf.cpp:108
llvm::DenseMapInfo< SampleContext >::getHashValue
static unsigned getHashValue(const SampleContext &Val)
Definition: SampleProf.h:1269
llvm::sampleprof::FunctionSamples::Format
static SampleProfileFormat Format
Definition: SampleProf.h:1057
llvm::MCID::Flag
Flag
These should be considered private to the implementation of the MCInstrDesc class.
Definition: MCInstrDesc.h:146
ColdCountThreshold
static cl::opt< unsigned > ColdCountThreshold("mfs-count-threshold", cl::desc("Minimum number of times a block must be executed to be retained."), cl::init(1), cl::Hidden)
llvm::sampleprof::SampleSorter::SampleSorter
SampleSorter(const std::map< LocationT, SampleT > &Samples)
Definition: SampleProf.h:1146
llvm::sampleprof::SPMagic
static uint64_t SPMagic(SampleProfileFormat Format=SPF_Binary)
Definition: SampleProf.h:99
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:53
llvm::sampleprof::SecNameTableFlags::SecFlagInValid
@ SecFlagInValid
llvm::sampleprof::ContextStateMask
ContextStateMask
Definition: SampleProf.h:403
StringMap.h
llvm::sampleprof::ProfileSymbolList::read
std::error_code read(const uint8_t *Data, uint64_t ListSize)
Definition: SampleProf.cpp:333
llvm::sampleprof::SampleContextFrames
ArrayRef< SampleContextFrame > SampleContextFrames
Definition: SampleProf.h:454
llvm::StringRef::str
LLVM_NODISCARD std::string str() const
str - Get the contents as an std::string.
Definition: StringRef.h:244
llvm::sampleprof::CSProfileConverter::FrameNode::AllChildFrames
std::map< uint64_t, FrameNode > AllChildFrames
Definition: SampleProf.h:1195
llvm::sampleprof::SampleContext
Definition: SampleProf.h:472
llvm::sampleprof::SecProfSummaryFlags::SecFlagInValid
@ SecFlagInValid
llvm::sampleprof::FunctionSamples::getHeadSamples
uint64_t getHeadSamples() const
Return the total number of branch samples that have the function as the branch target.
Definition: SampleProf.h:827
llvm::sampleprof::SampleContext::isBaseContext
bool isBaseContext() const
Definition: SampleProf.h:569
llvm::sampleprof::sortFuncProfiles
void sortFuncProfiles(const SampleProfileMap &ProfileMap, std::vector< NameFunctionSamples > &SortedProfiles)
Definition: SampleProf.cpp:208
llvm::StringMap< uint64_t >
llvm::sampleprof::FunctionSamples::ProfileIsFS
static bool ProfileIsFS
If this profile uses flow sensitive discriminators.
Definition: SampleProf.h:1066
llvm::X86AS::FS
@ FS
Definition: X86.h:188
llvm::sampleprof::FunctionSamples::empty
bool empty() const
Definition: SampleProf.h:817
llvm::sampleprof::SecHdrTableEntry::Type
SecType Type
Definition: SampleProf.h:160
llvm::sampleprof::LineLocation::operator!=
bool operator!=(const LineLocation &O) const
Definition: SampleProf.h:298
llvm::sampleprof::SampleRecord::getCallTargets
const CallTargetMap & getCallTargets() const
Definition: SampleProf.h:365
llvm::sampleprof::SampleRecord::SortedCallTargetSet
std::set< CallTarget, CallTargetComparator > SortedCallTargetSet
Definition: SampleProf.h:330
llvm::DenseSet
Implements a dense probed hash-table based set.
Definition: DenseSet.h:268
llvm::sampleprof::SampleContext::SampleContext
SampleContext(StringRef ContextStr, std::list< SampleContextFrameVector > &CSNameTable, ContextStateMask CState=RawContext)
Definition: SampleProf.h:489
llvm::sampleprof::ProfileSymbolList::contains
bool contains(StringRef Name)
Definition: SampleProf.h:1235
llvm::sampleprof::SampleContext::getContextFrames
SampleContextFrames getContextFrames() const
Definition: SampleProf.h:571
llvm::sampleprof::FunctionSamples::getCallsiteSamples
const CallsiteSampleMap & getCallsiteSamples() const
Return all the callsite samples collected in the body of the function.
Definition: SampleProf.h:858
llvm::sampleprof::SampleContext::setName
void setName(StringRef FunctionName)
Set the name of the function and clear the current context.
Definition: SampleProf.h:598
llvm::sampleprof::SecHdrTableEntry::Flags
uint64_t Flags
Definition: SampleProf.h:161
llvm::sampleprof::SampleRecord::CallTargetComparator
Definition: SampleProf.h:321
llvm::sampleprof::UnknownContext
@ UnknownContext
Definition: SampleProf.h:404
llvm::RISCVFenceField::O
@ O
Definition: RISCVBaseInfo.h:206
llvm::sampleprof::SecProfSummary
@ SecProfSummary
Definition: SampleProf.h:123
llvm::sampleprof::SPF_Compact_Binary
@ SPF_Compact_Binary
Definition: SampleProf.h:93
llvm::sampleprof::ProfileSymbolList
ProfileSymbolList records the list of function symbols shown up in the binary used to generate the pr...
Definition: SampleProf.h:1223
llvm::ArrayRef::drop_front
ArrayRef< T > drop_front(size_t N=1) const
Drop the first N elements of the array.
Definition: ArrayRef.h:202
llvm::StringRef::empty
constexpr LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:152
Index
uint32_t Index
Definition: ELFObjHandler.cpp:83
llvm::sampleprof::SampleContext::setAttribute
void setAttribute(ContextAttributeMask A)
Definition: SampleProf.h:562
llvm::sampleprof::FunctionSamples::addHeadSamples
sampleprof_error addHeadSamples(uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:708
uint64_t
D
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
llvm::sampleprof::SampleContext::SampleContext
SampleContext()
Definition: SampleProf.h:474
llvm::sampleprof::FunctionSamples::getEntrySamples
uint64_t getEntrySamples() const
Return the sample count of the first instruction of the function.
Definition: SampleProf.h:831
llvm::sampleprof::FunctionSamples::GUIDToFuncNameMap
DenseMap< uint64_t, StringRef > * GUIDToFuncNameMap
GUIDToFuncNameMap saves the mapping from GUID to the symbol name, for all the function symbols define...
Definition: SampleProf.h:1070
llvm::sampleprof::LineLocation::operator==
bool operator==(const LineLocation &O) const
Definition: SampleProf.h:294
llvm::sampleprof::SecFuncOffsetFlags
SecFuncOffsetFlags
Definition: SampleProf.h:215
llvm::sampleprof::FunctionSamples
Representation of the samples collected for a function.
Definition: SampleProf.h:691
llvm::BumpPtrAllocatorImpl
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:67
llvm::sampleprof::SampleContextFrame::Location
LineLocation Location
Definition: SampleProf.h:421
llvm::sampleprof::SecFuncMetadataFlags::SecFlagInvalid
@ SecFlagInvalid
llvm::sampleprof::SPF_Ext_Binary
@ SPF_Ext_Binary
Definition: SampleProf.h:95
llvm::sampleprof::SecProfSummaryFlags::SecFlagIsCSNested
@ SecFlagIsCSNested
SecFlagIsCSNested means this is context-sensitive nested profile for CSSPGO.
llvm::DenseMap
Definition: DenseMap.h:714
llvm::sampleprof::FunctionSamples::functionSamplesAt
FunctionSamplesMap & functionSamplesAt(const LineLocation &Loc)
Return the function samples at the given callsite location.
Definition: SampleProf.h:794
ErrorOr.h
llvm::DenseMapInfo< SampleContext >::getTombstoneKey
static SampleContext getTombstoneKey()
Definition: SampleProf.h:1267
llvm::sampleprof::SampleContext::clearState
void clearState(ContextStateMask S)
Definition: SampleProf.h:567
llvm::sampleprof::SecLBRProfile
@ SecLBRProfile
Definition: SampleProf.h:131
llvm::sampleprof::FunctionSamples::ProfileIsCSNested
static bool ProfileIsCSNested
Definition: SampleProf.h:1051
I
#define I(x, y, z)
Definition: MD5.cpp:58
llvm::sampleprof::FunctionSamples::getCallSiteHash
static uint64_t getCallSiteHash(StringRef CalleeName, const LineLocation &Callsite)
Returns a unique hash code for a combination of a callsite location and the callee function name.
Definition: SampleProf.cpp:245
llvm::sampleprof::SampleContext::promoteOnPath
void promoteOnPath(uint32_t ContextFramesToRemove)
Definition: SampleProf.h:531
llvm::SaturatingMultiplyAdd
std::enable_if_t< std::is_unsigned< T >::value, T > 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:866
llvm::sampleprof::FunctionSamples::setContext
void setContext(const SampleContext &FContext)
Definition: SampleProf.h:1055
llvm::sampleprof::FunctionSamples::getFunctionHash
uint64_t getFunctionHash() const
Definition: SampleProf.h:953
llvm::sampleprof::FunctionSamples::addCalledTargetSamples
sampleprof_error addCalledTargetSamples(uint32_t LineOffset, uint32_t Discriminator, StringRef FName, uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:722
llvm::sampleprof::SampleContextFrame::FuncName
StringRef FuncName
Definition: SampleProf.h:420
llvm::sampleprof::SampleRecord::adjustCallTargets
static const CallTargetMap adjustCallTargets(const CallTargetMap &Targets, float DistributionFactor)
Prorate call targets by a distribution factor.
Definition: SampleProf.h:380
llvm::sampleprof::SampleRecord::getSortedCallTargets
const SortedCallTargetSet getSortedCallTargets() const
Definition: SampleProf.h:366
llvm::sampleprof::SampleContext::setAllAttributes
void setAllAttributes(uint32_t A)
Definition: SampleProf.h:564
llvm::sampleprof_error::malformed
@ malformed
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::sampleprof::SecCommonFlags::SecFlagInValid
@ SecFlagInValid
llvm::sampleprof::SampleContext::getName
StringRef getName() const
Definition: SampleProf.h:570
llvm::sampleprof::SampleContext::setState
void setState(ContextStateMask S)
Definition: SampleProf.h:566
llvm::sampleprof::operator<<
raw_ostream & operator<<(raw_ostream &OS, const LineLocation &Loc)
Definition: SampleProf.cpp:118
llvm::sampleprof::FunctionSamples::UseMD5
static bool UseMD5
Whether the profile uses MD5 to represent string.
Definition: SampleProf.h:1060
llvm::sampleprof::CSProfileConverter::FrameNode::FuncName
StringRef FuncName
Definition: SampleProf.h:1200
llvm::sampleprof::SecHdrTableEntry::LayoutIndex
uint32_t LayoutIndex
Definition: SampleProf.h:166
llvm::sampleprof::ProfileSymbolList::merge
void merge(const ProfileSymbolList &List)
Definition: SampleProf.h:1237
llvm::sampleprof::CSProfileConverter::FrameNode::CallSiteLoc
LineLocation CallSiteLoc
Definition: SampleProf.h:1204
llvm::sampleprof::FunctionSamples::getOffset
static unsigned getOffset(const DILocation *DIL)
Returns the line offset to the start line of the subprogram.
Definition: SampleProf.cpp:223
llvm::sampleprof::LineLocation
Represents the relative location of an instruction.
Definition: SampleProf.h:283
llvm::MergeResult
sampleprof_error MergeResult(sampleprof_error &Accumulator, sampleprof_error Result)
Definition: SampleProf.h:68
llvm::ArrayRef< SampleContextFrame >
llvm::sampleprof::SampleContext::IsPrefixOf
bool IsPrefixOf(const SampleContext &That) const
Definition: SampleProf.h:648
llvm::sampleprof::SampleContext::SampleContext
SampleContext(StringRef Name)
Definition: SampleProf.h:476
llvm::min
Expected< ExpressionValue > min(const ExpressionValue &Lhs, const ExpressionValue &Rhs)
Definition: FileCheck.cpp:357
llvm::sampleprof::SecProfSummaryFlags
SecProfSummaryFlags
Definition: SampleProf.h:192
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57
llvm::sampleprof::SampleSorter
Sort a LocationT->SampleT map by LocationT.
Definition: SampleProf.h:1141
llvm_unreachable
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Definition: ErrorHandling.h:134
llvm::sampleprof_error::unrecognized_format
@ unrecognized_format
llvm::sampleprof::SecInValid
@ SecInValid
Definition: SampleProf.h:122
uint32_t
llvm::sampleprof::FunctionSamples::addBodySamples
sampleprof_error addBodySamples(uint32_t LineOffset, uint32_t Discriminator, uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:716
llvm::sampleprof::SampleContextFrame::operator==
bool operator==(const SampleContextFrame &That) const
Definition: SampleProf.h:428
llvm::sampleprof::ProfileSymbolList::add
void add(StringRef Name, bool copy=false)
copy indicates whether we need to copy the underlying memory for the input Name.
Definition: SampleProf.h:1227
llvm::sampleprof::FunctionSamples::print
void print(raw_ostream &OS=dbgs(), unsigned Indent=0) const
Print the samples collected for a function on stream OS.
Definition: SampleProf.cpp:162
llvm::sampleprof::FunctionSamples::findFunctionSamplesMapAt
const FunctionSamplesMap * findFunctionSamplesMapAt(const LineLocation &Loc) const
Returns the FunctionSamplesMap at the given Loc.
Definition: SampleProf.h:800
S
add sub stmia L5 ldr r0 bl L_printf $stub Instead of a and a wouldn t it be better to do three moves *Return an aggregate type is even return S
Definition: README.txt:210
llvm::sampleprof::FunctionSamples::findSamplesAt
ErrorOr< uint64_t > findSamplesAt(uint32_t LineOffset, uint32_t Discriminator) const
Return the number of samples collected at the given location.
Definition: SampleProf.h:764
llvm::sampleprof::SampleRecord::CallTargetMap
StringMap< uint64_t > CallTargetMap
Definition: SampleProf.h:331
Node
Definition: ItaniumDemangle.h:235
llvm::sampleprof::SPF_Text
@ SPF_Text
Definition: SampleProf.h:92
llvm::sampleprof::SecFuncOffsetFlags::SecFlagOrdered
@ SecFlagOrdered
llvm::sampleprof::getSecName
static std::string getSecName(SecType Type)
Definition: SampleProf.h:134
llvm::sampleprof::FunctionSamples::findFunctionSamplesAt
const FunctionSamples * findFunctionSamplesAt(const LineLocation &Loc, StringRef CalleeName, SampleProfileReaderItaniumRemapper *Remapper) const
Returns a pointer to FunctionSamples at the given callsite location Loc with callee CalleeName.
Definition: SampleProf.cpp:293
llvm::sampleprof::ProfileSymbolList::toCompress
bool toCompress()
Definition: SampleProf.h:1245
llvm::make_error_code
std::error_code make_error_code(BitcodeError E)
Definition: BitcodeReader.h:270
llvm::sampleprof::InlinedContext
@ InlinedContext
Definition: SampleProf.h:407
Callee
amdgpu Simplify well known AMD library false FunctionCallee Callee
Definition: AMDGPULibCalls.cpp:185
llvm::sampleprof_error::ostream_seek_unsupported
@ ostream_seek_unsupported
llvm::sampleprof::CSProfileConverter::convertProfiles
void convertProfiles()
Definition: SampleProf.cpp:547
StringSet.h
llvm::StringRef::size
constexpr LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:156
llvm::stable_sort
void stable_sort(R &&Range)
Definition: STLExtras.h:1784
llvm::sampleprof::ProfileSymbolList::write
std::error_code write(raw_ostream &OS)
Definition: SampleProf.cpp:446
llvm::GraphProgram::Name
Name
Definition: GraphWriter.h:52
std
Definition: BitVector.h:838
llvm::sampleprof::LineLocation::print
void print(raw_ostream &OS) const
Definition: SampleProf.cpp:112
llvm::sampleprof::SampleRecord::print
void print(raw_ostream &OS, unsigned Indent) const
Print the sample record to the stream OS indented by Indent.
Definition: SampleProf.cpp:141
llvm::sampleprof::SPVersion
static uint64_t SPVersion()
Definition: SampleProf.h:116
llvm::ArrayRef::take_front
ArrayRef< T > take_front(size_t N=1) const
Return a copy of *this with only the first N elements.
Definition: ArrayRef.h:226
llvm::sampleprof::verifySecFlag
static void verifySecFlag(SecType Type, SecFlagType Flag)
Definition: SampleProf.h:224
llvm::GlobalValue::getGUID
GUID getGUID() const
Return a 64-bit global unique ID constructed from global value name (i.e.
Definition: GlobalValue.h:517
llvm::sampleprof::SecProfileSymbolList
@ SecProfileSymbolList
Definition: SampleProf.h:125
Function.h
llvm::sampleprof::FunctionSamples::findCallTargetMapAt
ErrorOr< SampleRecord::CallTargetMap > findCallTargetMapAt(const LineLocation &CallSite) const
Returns the call target map collected at a given location specified by CallSite.
Definition: SampleProf.h:786
llvm::sampleprof::FunctionSamples::addTotalSamples
sampleprof_error addTotalSamples(uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:698
llvm::sampleprof::SecType
SecType
Definition: SampleProf.h:121
llvm::sampleprof::SampleRecord
Representation of a single sample record.
Definition: SampleProf.h:318
llvm::sampleprof::CSProfileConverter::FrameNode::FrameNode
FrameNode(StringRef FName=StringRef(), FunctionSamples *FSamples=nullptr, LineLocation CallLoc={0, 0})
Definition: SampleProf.h:1192
llvm::sampleprof_error::compress_failed
@ compress_failed
llvm::sampleprof_error
sampleprof_error
Definition: SampleProf.h:45
llvm::sampleprof::FunctionSamples::merge
sampleprof_error merge(const FunctionSamples &Other, uint64_t Weight=1)
Merge the samples in Other into this one.
Definition: SampleProf.h:876
llvm::sampleprof::FunctionSamples::LLVMSuffix
static constexpr const char * LLVMSuffix
Name suffixes which canonicalization should handle to avoid profile mismatch.
Definition: SampleProf.h:965
llvm::sampleprof::ContextNone
@ ContextNone
Definition: SampleProf.h:413
llvm::sampleprof_error::zlib_unavailable
@ zlib_unavailable
llvm::sampleprof::SampleContext::hasContext
bool hasContext() const
Definition: SampleProf.h:568
llvm::sampleprof::SecFuncProfileFirst
@ SecFuncProfileFirst
Definition: SampleProf.h:130
llvm::sampleprof_error::too_large
@ too_large
llvm::sampleprof::SampleContextTrimmer::trimAndMergeColdContextProfiles
void trimAndMergeColdContextProfiles(uint64_t ColdCountThreshold, bool TrimColdContext, bool MergeColdContext, uint32_t ColdContextFrameLength, bool TrimBaseProfileOnly)
Definition: SampleProf.cpp:349
llvm::sampleprof::SampleRecord::addCalledTarget
sampleprof_error addCalledTarget(StringRef F, uint64_t S, uint64_t Weight=1)
Add called function F with samples S.
Definition: SampleProf.h:351
llvm::sampleprof::FunctionSamples::getContext
SampleContext & getContext() const
Definition: SampleProf.h:1053
llvm::sampleprof_error::success
@ success
llvm::sampleprof::SecNameTableFlags::SecFlagUniqSuffix
@ SecFlagUniqSuffix
llvm::sampleprof::FunctionSamples::getMaxCountInside
uint64_t getMaxCountInside() const
Return the maximum of sample counts in a function body including functions inlined in it.
Definition: SampleProf.h:864
llvm::sampleprof::ContextAttributeMask
ContextAttributeMask
Definition: SampleProf.h:412
llvm::sampleprof::SampleContextFrame::SampleContextFrame
SampleContextFrame(StringRef FuncName, LineLocation Location)
Definition: SampleProf.h:425
llvm::sampleprof::SampleContextTrimmer::SampleContextTrimmer
SampleContextTrimmer(SampleProfileMap &Profiles)
Definition: SampleProf.h:1165
llvm::sampleprof::SecNameTableFlags
SecNameTableFlags
Definition: SampleProf.h:182
llvm::sampleprof::ContextWasInlined
@ ContextWasInlined
Definition: SampleProf.h:414
llvm::sampleprof::FunctionSamples::getCanonicalFnName
static StringRef getCanonicalFnName(const Function &F)
Return the canonical name for a function, taking into account suffix elision policy attributes.
Definition: SampleProf.h:957
llvm::sampleprof::SampleContextTrimmer::canonicalizeContextProfiles
void canonicalizeContextProfiles()
Definition: SampleProf.cpp:410
llvm::StringMapImpl::empty
bool empty() const
Definition: StringMap.h:92
SmallVector.h
llvm::sampleprof::SampleRecord::dump
void dump() const
Definition: SampleProf.cpp:152
llvm::DenseMapInfo< SampleContext >::getEmptyKey
static SampleContext getEmptyKey()
Definition: SampleProf.h:1265
llvm::sampleprof::SampleRecord::SortCallTargets
static const SortedCallTargetSet SortCallTargets(const CallTargetMap &Targets)
Sort call targets in descending order of call frequency.
Definition: SampleProf.h:371
llvm::hash_combine
hash_code hash_combine(const Ts &...args)
Combine values into a single hash_code.
Definition: Hashing.h:605
llvm::sampleprof::SampleContextFrame::operator!=
bool operator!=(const SampleContextFrame &That) const
Definition: SampleProf.h:432
llvm::sampleprof::SecCommonFlags::SecFlagFlat
@ SecFlagFlat
llvm::sampleprof::SecCommonFlags
SecCommonFlags
Definition: SampleProf.h:172
List
const NodeList & List
Definition: RDFGraph.cpp:201
llvm::sampleprof::FunctionSamples::UniqSuffix
static constexpr const char * UniqSuffix
Definition: SampleProf.h:967
llvm::sampleprof::SampleRecord::merge
sampleprof_error merge(const SampleRecord &Other, uint64_t Weight=1)
Merge the samples in Other into this record.
Definition: SampleProf.cpp:126
llvm::sampleprof::SecCSNameTable
@ SecCSNameTable
Definition: SampleProf.h:128
llvm::hash_combine_range
hash_code hash_combine_range(InputIteratorT first, InputIteratorT last)
Compute a hash_code for a sequence of values.
Definition: Hashing.h:483
llvm::ErrorOr
Represents either an error or a value T.
Definition: ErrorOr.h:56
llvm::to_string
std::string to_string(const T &Value)
Definition: ScopedPrinter.h:87
llvm::ArrayRef::size
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:163
llvm::max
Align max(MaybeAlign Lhs, Align Rhs)
Definition: Alignment.h:340
Threshold
static cl::opt< unsigned > Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"), cl::init(100), cl::Hidden)
llvm::sampleprof::SampleContext::getContextString
static std::string getContextString(SampleContextFrames Context, bool IncludeLeafLineLocation=false)
Definition: SampleProf.h:573
llvm::sampleprof::SecNameTable
@ SecNameTable
Definition: SampleProf.h:124
llvm::sampleprof::FunctionSamples::addBodySamplesForProbe
sampleprof_error addBodySamplesForProbe(uint32_t Index, uint64_t Num, uint64_t Weight=1)
Definition: SampleProf.h:730
llvm::sampleprof::SampleProfileReaderItaniumRemapper
SampleProfileReaderItaniumRemapper remaps the profile data from a sample profile data reader,...
Definition: SampleProfReader.h:264
llvm::sampleprof::SecFuncMetadata
@ SecFuncMetadata
Definition: SampleProf.h:127
llvm::sampleprof::SampleContextFrame
Definition: SampleProf.h:419
llvm::sampleprof_error::truncated_name_table
@ truncated_name_table
llvm::sampleprof::SampleSorter::SamplesWithLoc
std::pair< const LocationT, SampleT > SamplesWithLoc
Definition: SampleProf.h:1143
llvm::sampleprof::SampleContextTrimmer
SampleContextTrimmer impelements helper functions to trim, merge cold context profiles.
Definition: SampleProf.h:1163
llvm::sampleprof::ProfileSymbolList::dump
void dump(raw_ostream &OS=dbgs()) const
Definition: SampleProf.cpp:462
raw_ostream.h
error_category
static ManagedStatic< _object_error_category > error_category
Definition: Error.cpp:76
llvm::sampleprof::SecFuncOffsetFlags::SecFlagInvalid
@ SecFlagInvalid
llvm::sampleprof_error::truncated
@ truncated
llvm::StringRef::compare
LLVM_NODISCARD int compare(StringRef RHS) const
compare - Compare two strings; the result is -1, 0, or 1 if this string is lexicographically less tha...
Definition: StringRef.h:200
Debug.h
llvm::sampleprof::SampleRecord::addSamples
sampleprof_error addSamples(uint64_t S, uint64_t Weight=1)
Increment the number of samples for this record by S.
Definition: SampleProf.h:339
llvm::sampleprof::SampleContextFrameHash::operator()
uint64_t operator()(const SampleContextFrameVector &S) const
Definition: SampleProf.h:457
llvm::sampleprof::SecFuncMetadataFlags
SecFuncMetadataFlags
Definition: SampleProf.h:209
llvm::sampleprof_error::bad_magic
@ bad_magic
llvm::sampleprof::CSProfileConverter::CSProfileConverter
CSProfileConverter(SampleProfileMap &Profiles)
Definition: SampleProf.cpp:486
llvm::sampleprof::FunctionSamples::setFunctionHash
void setFunctionHash(uint64_t Hash)
Definition: SampleProf.h:951
Other
Optional< std::vector< StOtherPiece > > Other
Definition: ELFYAML.cpp:1198
llvm::sampleprof::FunctionSamples::getCallSiteIdentifier
static LineLocation getCallSiteIdentifier(const DILocation *DIL, bool ProfileIsFS=false)
Returns a unique call site identifier for a given debug location of a call instruction.
Definition: SampleProf.cpp:228
llvm::sampleprof::FunctionSamples::findFunctionSamples
const FunctionSamples * findFunctionSamples(const DILocation *DIL, SampleProfileReaderItaniumRemapper *Remapper=nullptr) const
Get the FunctionSamples of the inline instance where DIL originates from.
Definition: SampleProf.cpp:253
llvm::hash_code
An opaque object representing a hash code.
Definition: Hashing.h:73
llvm::sampleprof::SampleContext::Hash::operator()
uint64_t operator()(const SampleContext &Context) const
Definition: SampleProf.h:643
llvm::sampleprof::FunctionSamples::setName
void setName(StringRef FunctionName)
Set the name of the function.
Definition: SampleProf.h:943