LLVM  8.0.0svn
ProfileCommon.h
Go to the documentation of this file.
1 //===- ProfileCommon.h - Common profiling APIs. -----------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains data structures and functions common to both instrumented
11 // and sample profiling.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_PROFILEDATA_PROFILECOMMON_H
16 #define LLVM_PROFILEDATA_PROFILECOMMON_H
17 
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/IR/ProfileSummary.h"
21 #include "llvm/Support/Error.h"
22 #include <algorithm>
23 #include <cstdint>
24 #include <functional>
25 #include <map>
26 #include <memory>
27 #include <vector>
28 
29 namespace llvm {
30 
31 namespace sampleprof {
32 
33 class FunctionSamples;
34 
35 } // end namespace sampleprof
36 
37 inline const char *getHotSectionPrefix() { return ".hot"; }
38 inline const char *getUnlikelySectionPrefix() { return ".unlikely"; }
39 
41 private:
42  /// We keep track of the number of times a count (block count or samples)
43  /// appears in the profile. The map is kept sorted in the descending order of
44  /// counts.
45  std::map<uint64_t, uint32_t, std::greater<uint64_t>> CountFrequencies;
46  std::vector<uint32_t> DetailedSummaryCutoffs;
47 
48 protected:
50  uint64_t TotalCount = 0;
51  uint64_t MaxCount = 0;
52  uint64_t MaxFunctionCount = 0;
53  uint32_t NumCounts = 0;
54  uint32_t NumFunctions = 0;
55 
56  ProfileSummaryBuilder(std::vector<uint32_t> Cutoffs)
57  : DetailedSummaryCutoffs(std::move(Cutoffs)) {}
58  ~ProfileSummaryBuilder() = default;
59 
60  inline void addCount(uint64_t Count);
61  void computeDetailedSummary();
62 
63 public:
64  /// A vector of useful cutoff values for detailed summary.
66 };
67 
69  uint64_t MaxInternalBlockCount = 0;
70 
71  inline void addEntryCount(uint64_t Count);
72  inline void addInternalCount(uint64_t Count);
73 
74 public:
75  InstrProfSummaryBuilder(std::vector<uint32_t> Cutoffs)
76  : ProfileSummaryBuilder(std::move(Cutoffs)) {}
77 
78  void addRecord(const InstrProfRecord &);
79  std::unique_ptr<ProfileSummary> getSummary();
80 };
81 
83 public:
84  SampleProfileSummaryBuilder(std::vector<uint32_t> Cutoffs)
85  : ProfileSummaryBuilder(std::move(Cutoffs)) {}
86 
87  void addRecord(const sampleprof::FunctionSamples &FS);
88  std::unique_ptr<ProfileSummary> getSummary();
89 };
90 
91 /// This is called when a count is seen in the profile.
92 void ProfileSummaryBuilder::addCount(uint64_t Count) {
93  TotalCount += Count;
94  if (Count > MaxCount)
95  MaxCount = Count;
96  NumCounts++;
97  CountFrequencies[Count]++;
98 }
99 
100 } // end namespace llvm
101 
102 #endif // LLVM_PROFILEDATA_PROFILECOMMON_H
ProfileSummaryBuilder(std::vector< uint32_t > Cutoffs)
Definition: ProfileCommon.h:56
const char * getUnlikelySectionPrefix()
Definition: ProfileCommon.h:38
This class represents lattice values for constants.
Definition: AllocatorList.h:24
const char * getHotSectionPrefix()
Definition: ProfileCommon.h:37
static const ArrayRef< uint32_t > DefaultCutoffs
A vector of useful cutoff values for detailed summary.
Definition: ProfileCommon.h:65
void addCount(uint64_t Count)
This is called when a count is seen in the profile.
Definition: ProfileCommon.h:92
SampleProfileSummaryBuilder(std::vector< uint32_t > Cutoffs)
Definition: ProfileCommon.h:84
Representation of the samples collected for a function.
Definition: SampleProf.h:217
Definition: BitVector.h:938
InstrProfSummaryBuilder(std::vector< uint32_t > Cutoffs)
Definition: ProfileCommon.h:75
SummaryEntryVector DetailedSummary
Definition: ProfileCommon.h:49
Profiling information for a single function.
Definition: InstrProf.h:622
std::vector< ProfileSummaryEntry > SummaryEntryVector