LLVM  12.0.0git
HeatUtils.cpp
Go to the documentation of this file.
1 //===-- HeatUtils.cpp - Utility for printing heat colors --------*- 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 // Utility for printing heat colors based on heuristics or profiling
11 // information.
12 //
13 //===----------------------------------------------------------------------===//
14 
17 #include "llvm/IR/Instructions.h"
18 
19 namespace llvm {
20 
21 static const unsigned heatSize = 100;
22 static const char heatPalette[heatSize][8] = {
23  "#3d50c3", "#4055c8", "#4358cb", "#465ecf", "#4961d2", "#4c66d6", "#4f69d9",
24  "#536edd", "#5572df", "#5977e3", "#5b7ae5", "#5f7fe8", "#6282ea", "#6687ed",
25  "#6a8bef", "#6c8ff1", "#7093f3", "#7396f5", "#779af7", "#7a9df8", "#7ea1fa",
26  "#81a4fb", "#85a8fc", "#88abfd", "#8caffe", "#8fb1fe", "#93b5fe", "#96b7ff",
27  "#9abbff", "#9ebeff", "#a1c0ff", "#a5c3fe", "#a7c5fe", "#abc8fd", "#aec9fc",
28  "#b2ccfb", "#b5cdfa", "#b9d0f9", "#bbd1f8", "#bfd3f6", "#c1d4f4", "#c5d6f2",
29  "#c7d7f0", "#cbd8ee", "#cedaeb", "#d1dae9", "#d4dbe6", "#d6dce4", "#d9dce1",
30  "#dbdcde", "#dedcdb", "#e0dbd8", "#e3d9d3", "#e5d8d1", "#e8d6cc", "#ead5c9",
31  "#ecd3c5", "#eed0c0", "#efcebd", "#f1ccb8", "#f2cab5", "#f3c7b1", "#f4c5ad",
32  "#f5c1a9", "#f6bfa6", "#f7bca1", "#f7b99e", "#f7b599", "#f7b396", "#f7af91",
33  "#f7ac8e", "#f7a889", "#f6a385", "#f5a081", "#f59c7d", "#f4987a", "#f39475",
34  "#f29072", "#f08b6e", "#ef886b", "#ed8366", "#ec7f63", "#e97a5f", "#e8765c",
35  "#e57058", "#e36c55", "#e16751", "#de614d", "#dc5d4a", "#d85646", "#d65244",
36  "#d24b40", "#d0473d", "#cc403a", "#ca3b37", "#c53334", "#c32e31", "#be242e",
37  "#bb1b2c", "#b70d28"};
38 
39 uint64_t
40 getNumOfCalls(Function &callerFunction, Function &calledFunction) {
41  uint64_t counter = 0;
42  for (User *U : calledFunction.users()) {
43  if (auto CI = dyn_cast<CallInst>(U)) {
44  if (CI->getCaller() == (&callerFunction)) {
45  counter += 1;
46  }
47  }
48  }
49  return counter;
50 }
51 
52 uint64_t getMaxFreq(const Function &F, const BlockFrequencyInfo *BFI) {
53  uint64_t maxFreq = 0;
54  for (const BasicBlock &BB : F) {
55  uint64_t freqVal = BFI->getBlockFreq(&BB).getFrequency();
56  if (freqVal >= maxFreq)
57  maxFreq = freqVal;
58  }
59  return maxFreq;
60 }
61 
62 std::string getHeatColor(uint64_t freq, uint64_t maxFreq) {
63  if (freq > maxFreq)
64  freq = maxFreq;
65  double percent = (freq > 0) ? log2(double(freq)) / log2(maxFreq) : 0;
66  return getHeatColor(percent);
67 }
68 
69 std::string getHeatColor(double percent) {
70  if (percent > 1.0)
71  percent = 1.0;
72  if (percent < 0.0)
73  percent = 0.0;
74  unsigned colorId = unsigned(round(percent * (heatSize - 1.0)));
75  return heatPalette[colorId];
76 }
77 
78 } // namespace llvm
This class represents lattice values for constants.
Definition: AllocatorList.h:23
static uint64_t round(uint64_t Acc, uint64_t Input)
Definition: xxhash.cpp:57
F(f)
static const unsigned heatSize
Definition: HeatUtils.cpp:21
static const char heatPalette[heatSize][8]
Definition: HeatUtils.cpp:22
BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequen...
LLVM Basic Block Representation.
Definition: BasicBlock.h:58
block freq
uint64_t getMaxFreq(const Function &F, const BlockFrequencyInfo *BFI)
Definition: HeatUtils.cpp:52
uint64_t getNumOfCalls(Function &callerFunction, Function &calledFunction)
Definition: HeatUtils.cpp:40
static double log2(double V)
iterator_range< user_iterator > users()
Definition: Value.h:424
std::string getHeatColor(uint64_t freq, uint64_t maxFreq)
Definition: HeatUtils.cpp:62