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